The changed-stream Reference Manual

This is the changed-stream Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:45:51 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 changed-stream

A library for non-destructive changes to character streams.

Author

Warren Wilkinson <>

License

lgpl2

Long Description

A library for non-destructive ’changes’ to character streams. Specify 1) position of ’point’, 2) # characters deleted at, 3) new string inserted at point.

Version

1.0.0

Source

changed-stream.asd.

Child Component

changed-stream.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 changed-stream/changed-stream.asd

Source

changed-stream.asd.

Parent Component

changed-stream (system).

ASDF Systems

changed-stream.


3.1.2 changed-stream/changed-stream.lisp

Source

changed-stream.asd.

Parent Component

changed-stream (system).

Packages

changed-stream.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 changed-stream

Source

changed-stream.lisp.

Use List
  • common-lisp.
  • sb-gray.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: change-stream (stream &key at insert delete)
Package

changed-stream.

Source

changed-stream.lisp.


5.1.2 Standalone methods

Method: stream-file-position ((stream changed-stream) &optional newval)
Package

sb-gray.

Source

changed-stream.lisp.

Method: stream-peek-char ((stream changed-stream))
Package

sb-gray.

Source

changed-stream.lisp.

Method: stream-read-char ((stream changed-stream))
Package

sb-gray.

Source

changed-stream.lisp.

Method: stream-read-sequence ((stream changed-stream) seq &optional start end)
Package

sb-gray.

Source

changed-stream.lisp.


5.1.3 Classes

Class: changed-stream
Package

changed-stream.

Source

changed-stream.lisp.

Direct superclasses

fundamental-character-input-stream.

Direct methods
Direct slots
Slot: stream
Package

common-lisp.

Initargs

:stream

Readers

stream-of.

Writers

This slot is read-only.

Slot: virtual-position
Initform

0

Readers

virtual-position.

Writers

(setf virtual-position).

Slot: last-unchanged-position
Initargs

:last-unchanged-position

Readers

last-unchanged-position.

Writers

This slot is read-only.

Slot: last-replacement-position
Initargs

:last-replacement-position

Readers

last-replacement-position.

Writers

This slot is read-only.

Slot: last-modified-position
Initargs

:last-modified-position

Readers

last-modified-position.

Writers

This slot is read-only.

Slot: removed-characters
Initargs

:removed-characters

Readers

removed-characters.

Writers

This slot is read-only.

Slot: insert-string
Initargs

:string

Readers

insert-string.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Macros

Macro: diffcase ((position stream) (before &rest before-case-code) (replace &rest replace-case-code) (delete &rest delete-case-code) (insert &rest insert-case-code) (after &rest after-case-code))
Package

changed-stream.

Source

changed-stream.lisp.


5.2.2 Ordinary functions

Function: mod-is-delete-p (stream)
Package

changed-stream.

Source

changed-stream.lisp.


5.2.3 Generic functions

Generic Reader: insert-string (object)
Package

changed-stream.

Methods
Reader Method: insert-string ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

insert-string.

Generic Reader: last-modified-position (object)
Package

changed-stream.

Methods
Reader Method: last-modified-position ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

last-modified-position.

Generic Reader: last-replacement-position (object)
Package

changed-stream.

Methods
Reader Method: last-replacement-position ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

last-replacement-position.

Generic Reader: last-unchanged-position (object)
Package

changed-stream.

Methods
Reader Method: last-unchanged-position ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

last-unchanged-position.

Generic Reader: removed-characters (object)
Package

changed-stream.

Methods
Reader Method: removed-characters ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

removed-characters.

Generic Reader: stream-of (object)
Package

changed-stream.

Methods
Reader Method: stream-of ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

stream.

Generic Reader: virtual-position (object)
Package

changed-stream.

Methods
Reader Method: virtual-position ((changed-stream changed-stream))

automatically generated reader method

Source

changed-stream.lisp.

Target Slot

virtual-position.

Generic Writer: (setf virtual-position) (object)
Package

changed-stream.

Methods
Writer Method: (setf virtual-position) ((changed-stream changed-stream))

automatically generated writer method

Source

changed-stream.lisp.

Target Slot

virtual-position.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   F   G   I   L   M   R   S   V  
Index Entry  Section

(
(setf virtual-position): Private generic functions
(setf virtual-position): Private generic functions

C
change-stream: Public ordinary functions

D
diffcase: Private macros

F
Function, change-stream: Public ordinary functions
Function, mod-is-delete-p: Private ordinary functions

G
Generic Function, (setf virtual-position): Private generic functions
Generic Function, insert-string: Private generic functions
Generic Function, last-modified-position: Private generic functions
Generic Function, last-replacement-position: Private generic functions
Generic Function, last-unchanged-position: Private generic functions
Generic Function, removed-characters: Private generic functions
Generic Function, stream-of: Private generic functions
Generic Function, virtual-position: Private generic functions

I
insert-string: Private generic functions
insert-string: Private generic functions

L
last-modified-position: Private generic functions
last-modified-position: Private generic functions
last-replacement-position: Private generic functions
last-replacement-position: Private generic functions
last-unchanged-position: Private generic functions
last-unchanged-position: Private generic functions

M
Macro, diffcase: Private macros
Method, (setf virtual-position): Private generic functions
Method, insert-string: Private generic functions
Method, last-modified-position: Private generic functions
Method, last-replacement-position: Private generic functions
Method, last-unchanged-position: Private generic functions
Method, removed-characters: Private generic functions
Method, stream-file-position: Public standalone methods
Method, stream-of: Private generic functions
Method, stream-peek-char: Public standalone methods
Method, stream-read-char: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, virtual-position: Private generic functions
mod-is-delete-p: Private ordinary functions

R
removed-characters: Private generic functions
removed-characters: Private generic functions

S
stream-file-position: Public standalone methods
stream-of: Private generic functions
stream-of: Private generic functions
stream-peek-char: Public standalone methods
stream-read-char: Public standalone methods
stream-read-sequence: Public standalone methods

V
virtual-position: Private generic functions
virtual-position: Private generic functions