This is the flexichain Reference Manual, version 1.5.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:25:54 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
flexichain1.5.1
trivial-garbage (system).
version (file).
flexichain-package.lisp (file).
utilities.lisp (file).
flexichain.lisp (file).
flexicursor.lisp (file).
flexirank.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
flexichain/flexichain.asdflexichain/flexichain-package.lispflexichain/utilities.lispflexichain/flexichain.lispflexichain/flexicursor.lispflexichain/flexirank.lispflexichain/utilities.lispflexichain-package.lisp (file).
flexichain (system).
+can-make-weak-pointer+ (constant).
find-if-2 (function).
make-weak-pointer (function).
square (function).
weak-pointer-value (function).
flexichain/flexichain.lisputilities.lisp (file).
flexichain-package.lisp (file).
flexichain (system).
delete* (generic function).
delete-elements* (generic function).
element* (generic function).
(setf element*) (generic function).
flexi-empty-p (generic function).
flexi-error (condition).
flexi-incompatible-type-error (condition).
flexi-initialization-error (condition).
flexi-position-error (condition).
flexichain (class).
initialize-instance (method).
initialize-instance (method).
insert* (generic function).
insert-vector* (generic function).
nb-elements (generic function).
pop-end (generic function).
pop-start (generic function).
push-end (generic function).
push-start (generic function).
rotate (generic function).
standard-flexichain (class).
decrease-buffer-size (function).
ensure-gap-position (function).
ensure-room (function).
fill-gap (generic function).
flexi-incompatible-type-error-chain (reader method).
flexi-incompatible-type-error-element (reader method).
flexi-initialization-error-cause (reader method).
flexi-position-error-chain (reader method).
flexi-position-error-position (reader method).
gap-location (function).
hop-elements-left (function).
hop-elements-right (function).
increase-buffer-size (function).
index-position (function).
move-elements (generic function).
move-empty-gap (function).
move-gap (function).
move-left-gap (function).
move-middle-gap (function).
move-non-contiguous-gap (function).
move-right-gap (function).
normalize-indices (function).
position-index (function).
push-elements-left (function).
push-elements-right (function).
required-space (function).
resize-buffer (generic function).
with-virtual-gap (macro).
flexichain/flexicursor.lispflexichain.lisp (file).
flexichain (system).
at-beginning-error (condition).
at-beginning-p (generic function).
at-end-error (condition).
at-end-p (generic function).
chain (reader method).
clone-cursor (generic function).
cursor-pos (generic function).
(setf cursor-pos) (generic function).
cursorchain (class).
delete* (method).
delete-elements* (method).
delete< (generic function).
delete> (generic function).
element< (generic function).
(setf element<) (generic function).
element> (generic function).
(setf element>) (generic function).
flexicursor (class).
initialize-instance (method).
initialize-instance (method).
insert (generic function).
insert-sequence (generic function).
left-sticky-flexicursor (class).
move< (generic function).
move> (generic function).
right-sticky-flexicursor (class).
standard-cursorchain (class).
standard-flexicursor (class).
adjust-cursors (function).
at-beginning-error-cursor (reader method).
at-end-error-cursor (reader method).
flexicursor-index (reader method).
(setf flexicursor-index) (writer method).
move-elements (method).
flexichain/flexirank.lispflexichain.lisp (file).
flexichain (system).
chain (reader method).
(setf chain) (writer method).
(setf element*) (method).
element-rank-mixin (class).
flexi-first-p (generic function).
flexi-last-p (generic function).
flexi-next (generic function).
flexi-prev (generic function).
flexirank-mixin (class).
insert* (method).
insert-vector* (method).
rank (generic function).
index (reader method).
(setf index) (writer method).
move-elements (method).
Packages are listed by definition order.
flexichaincommon-lisp.
at-beginning-error (condition).
at-beginning-p (generic function).
at-end-error (condition).
at-end-p (generic function).
chain (generic reader).
(setf chain) (generic writer).
clone-cursor (generic function).
cursor-pos (generic function).
(setf cursor-pos) (generic function).
cursorchain (class).
delete* (generic function).
delete-elements* (generic function).
delete< (generic function).
delete> (generic function).
element* (generic function).
(setf element*) (generic function).
element-rank-mixin (class).
element< (generic function).
(setf element<) (generic function).
element> (generic function).
(setf element>) (generic function).
flexi-empty-p (generic function).
flexi-error (condition).
flexi-first-p (generic function).
flexi-incompatible-type-error (condition).
flexi-initialization-error (condition).
flexi-last-p (generic function).
flexi-next (generic function).
flexi-position-error (condition).
flexi-prev (generic function).
flexichain (class).
flexicursor (class).
flexirank-mixin (class).
insert (generic function).
insert* (generic function).
insert-sequence (generic function).
insert-vector* (generic function).
left-sticky-flexicursor (class).
move< (generic function).
move> (generic function).
nb-elements (generic function).
pop-end (generic function).
pop-start (generic function).
push-end (generic function).
push-start (generic function).
rank (generic function).
right-sticky-flexicursor (class).
rotate (generic function).
standard-cursorchain (class).
standard-flexichain (class).
standard-flexicursor (class).
+can-make-weak-pointer+ (constant).
adjust-cursors (function).
at-beginning-error-cursor (generic reader).
at-end-error-cursor (generic reader).
decrease-buffer-size (function).
ensure-gap-position (function).
ensure-room (function).
fill-gap (generic function).
find-if-2 (function).
flexi-incompatible-type-error-chain (generic reader).
flexi-incompatible-type-error-element (generic reader).
flexi-initialization-error-cause (generic reader).
flexi-position-error-chain (generic reader).
flexi-position-error-position (generic reader).
flexicursor-index (generic reader).
(setf flexicursor-index) (generic writer).
gap-location (function).
hop-elements-left (function).
hop-elements-right (function).
increase-buffer-size (function).
index (generic reader).
(setf index) (generic writer).
index-position (function).
make-weak-pointer (function).
move-elements (generic function).
move-empty-gap (function).
move-gap (function).
move-left-gap (function).
move-middle-gap (function).
move-non-contiguous-gap (function).
move-right-gap (function).
normalize-indices (function).
position-index (function).
push-elements-left (function).
push-elements-right (function).
required-space (function).
resize-buffer (generic function).
square (function).
weak-pointer-value (function).
with-virtual-gap (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns true if the cursor is at the beginning of the chain.
standard-flexicursor)) ¶Returns true if the cursor is at the beginning of the chain.
standard-flexicursor)) ¶element-rank-mixin)) ¶automatically generated reader method
standard-flexicursor)) ¶automatically generated reader method
element-rank-mixin)) ¶automatically generated writer method
Creates a cursor that is initially at the same location as the one given as argument.
standard-flexicursor)) ¶Returns the position of the cursor.
right-sticky-flexicursor)) ¶left-sticky-flexicursor)) ¶Set the position of the cursor.
right-sticky-flexicursor)) ¶left-sticky-flexicursor)) ¶Deletes an element at POSITION of the chain.
If POSITION is out of range (less than 0 or greater than or equal
to the length of CHAIN, the FLEXI-POSITION-ERROR condition
will be signaled.
standard-cursorchain) position) ¶standard-flexichain) position) ¶Delete N elements at POSITION of the chain. If
POSITION+N is out of range (less than 0 or greater than or equal
to the length of CHAIN, the FLEXI-POSITION-ERROR condition will
be signaled. N can be negative, in which case elements will be
deleted before POSITION.
standard-cursorchain) position n) ¶standard-flexichain) position n) ¶Deletes N objects before the cursor.
standard-flexicursor) &optional n) ¶Deletes N objects after the cursor.
standard-flexicursor) &optional n) ¶Returns the element at POSITION of the chain.
If POSITION is out of range (less than 0 or greater than or equal
to the length of CHAIN, the FLEXI-POSITION-ERROR condition
will be signaled.
standard-flexichain) position) ¶Replaces the element at POSITION of CHAIN by OBJECT.
If POSITION if out of range (less than 0 or greater than or equal to
the length of CHAIN, the FLEXI-POSITION-ERROR condition will be signaled.
flexirank-mixin) position) ¶standard-flexichain) position) ¶Returns the element immediately before the cursor.
standard-flexicursor)) ¶Replaces the element immediately before the cursor.
standard-flexicursor)) ¶Returns the element immediately after the cursor.
standard-flexicursor)) ¶Replaces the element immediately after the cursor.
standard-flexicursor)) ¶Checks whether CHAIN is empty or not.
standard-flexichain)) ¶element-rank-mixin)) ¶element-rank-mixin)) ¶element-rank-mixin)) ¶element-rank-mixin)) ¶Inserts an object at the cursor.
standard-flexicursor) object) ¶Inserts an object before the element at POSITION
in the chain. If POSITION is out of range (less than 0 or greater
than the length of CHAIN, the FLEXI-POSITION-ERROR condition will be
signaled.
flexirank-mixin) position (object element-rank-mixin)) ¶standard-flexichain) position object) ¶The effect is the same as if each element of the sequence was inserted using INSERT.
standard-flexicursor) sequence) ¶Inserts the elements of VECTOR before the
element at POSITION in the chain. If POSITION is out of
range (less than 0 or greater than the length of CHAIN, the
FLEXI-POSITION-ERROR condition will be signaled.
flexirank-mixin) position vector) ¶standard-flexichain) position vector) ¶Moves the cursor backward N positions.
standard-flexicursor) &optional n) ¶Moves the cursor forward N positions.
standard-flexicursor) &optional n) ¶Returns the number of elements in the flexichain.
standard-flexichain)) ¶Pops and returns the element at the end of CHAIN.
standard-flexichain)) ¶Pops and returns the element at the beginning of CHAIN.
standard-flexichain)) ¶Inserts an object at the end of CHAIN.
standard-flexichain) object) ¶Inserts an object at the beginning of CHAIN.
standard-flexichain) object) ¶element-rank-mixin)) ¶Rotates the elements of CHAIN so that the element
that used to be at position N is now at position 0. With a negative
value of N, rotates the elements so that the element that used to be
at position 0 is now at position N.
standard-flexichain) &optional n) ¶flexichain) &rest initargs &key initial-contents) ¶standard-flexichain) &rest initargs &key initial-contents initial-nb-elements initial-element) ¶right-sticky-flexicursor) &rest initargs &key position) ¶left-sticky-flexicursor) &rest initargs &key position) ¶(quote nil)
:cursor
This slot is read-only.
(quote nil)
:cursor
This slot is read-only.
simple-error.
(quote "")
:cause
This slot is read-only.
The protocol class for cursor chains.
The protocol class for flexichains.
The protocol class for flexicursors.
The standard instantiable subclass of CURSORCHAIN
(quote nil)
The standard instantiable subclass of FLEXICHAIN.
The standard instantiable subclass of FLEXICURSOR
Searches the sequence for an element that satisfies PREDICATE. Returns the element found or NIL of none was found, and a boolean indicating whether an element was found or not.
Returns a keyword indicating the general location of the gap.
Moves the COUNT rightmost elements to the end of the gap,
on the left of the data. Example:
HOP-ELEMENTS-LEFT —abcdefghijklm— 2 => -lmabcdefghijk—–
Moves the COUNT leftmost elements to the beginning of the gap,
on the right of the data. Example:
HOP-ELEMENTS-RIGHT —abcdefghijklm— 2 => —–cdefghijklmab-
Returns the position corresponding to the INDEX in the CHAIN. Note: the result is undefined if INDEX is not the index of a valid element of the CHAIN.
Creates a new weak pointer which points to OBJECT. For portability reasons, OBJECT most not be NIL.
Moves the gap. Handles the case where the gap is empty.
Moves the elements and gap inside the buffer so that
the element currently at HOT-SPOT becomes the first element following
the gap, or does nothing if there are no elements.
Moves the gap. Handles the case where the gap is on the left of the buffer.
Moves the gap. Handles the case where the gap is in the middle of the buffer.
Moves the gap. Handles the case where the gap is in 2 parts, on both ends of the buffer.
Moves the gap. Handles the case where the gap is on the right of the buffer.
Sets gap limits to 0 if they are at the end of the buffer.
Returns the (0 indexed) index of the POSITION-th element of the CHAIN in the buffer.
Pushes the COUNT elements of CHAIN at the right of the gap, to the beginning of the gap. The gap must be continuous. Example: PUSH-ELEMENTS-LEFT abcd—–efghijklm 2 => abcdef—–ghijklm
Pushes the COUNT elements of CHAIN at the left of the gap, to the end of the gap. The gap must be continuous. Example: PUSH-ELEMENTS-RIGHT abcd—–efghijklm 2 => ab—–cdefghijklm
Returns the square of the number X.
at-beginning-error)) ¶at-end-error)) ¶fill part of gap with the fill element
standard-flexichain) start end) ¶flexi-incompatible-type-error)) ¶flexi-incompatible-type-error)) ¶flexi-initialization-error)) ¶flexi-position-error)) ¶flexi-position-error)) ¶standard-flexicursor)) ¶automatically generated reader method
standard-flexicursor)) ¶automatically generated writer method
element-rank-mixin)) ¶automatically generated reader method
element-rank-mixin)) ¶automatically generated writer method
move elements of a flexichain and adjust data-start
flexirank-mixin) to from start1 start2 end2) ¶standard-cursorchain) to from start1 start2 end2) ¶standard-flexichain) to from start1 start2 end2) ¶allocate a new buffer with the size indicated
standard-flexichain) new-buffer-size) ¶| Jump to: | (
A C D E F G H I M N P R S W |
|---|
| Jump to: | (
A C D E F G H I M N P R S W |
|---|
| Jump to: | +
B C D E F G I M P S |
|---|
| Jump to: | +
B C D E F G I M P S |
|---|
| Jump to: | A C E F L P R S U V |
|---|
| Jump to: | A C E F L P R S U V |
|---|