This is the cl-heredoc Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:19:22 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-heredocCommon Lisp reader heredoc dispatcher
Alexander Kahl <e-user@fsfe.org>
GPLv3+
0.1.0
src (module).
Modules are listed depth-first from the system components tree.
cl-heredoc/srccl-heredoc (system).
package.lisp (file).
ring-buffer.lisp (file).
heredoc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-heredoc/cl-heredoc.asdcl-heredoc/src/package.lispcl-heredoc/src/ring-buffer.lispcl-heredoc/src/heredoc.lispcl-heredoc/src/ring-buffer.lisppackage.lisp (file).
src (module).
copy-ring-buffer (function).
make-ring-buffer (function).
new-ring-buffer (function).
rbref (function).
(setf rbref) (function).
ring-buffer (structure).
ring-buffer-clear (function).
ring-buffer-end (reader).
(setf ring-buffer-end) (writer).
ring-buffer-flush (function).
ring-buffer-insert (function).
ring-buffer-new (reader).
(setf ring-buffer-new) (writer).
ring-buffer-next (function).
ring-buffer-p (function).
ring-buffer-pop (function).
ring-buffer-reset (function).
ring-buffer-start (reader).
(setf ring-buffer-start) (writer).
ring-buffer-used (reader).
(setf ring-buffer-used) (writer).
ring-buffer-vector (reader).
(setf ring-buffer-vector) (writer).
cl-heredoc/src/heredoc.lispring-buffer.lisp (file).
src (module).
read-heredoc (function).
read-until-match (function).
Packages are listed by definition order.
cl-heredoccommon-lisp.
read-heredoc (function).
read-until-match (function).
copy-ring-buffer (function).
make-ring-buffer (function).
new-ring-buffer (function).
rbref (function).
(setf rbref) (function).
ring-buffer (structure).
ring-buffer-clear (function).
ring-buffer-end (reader).
(setf ring-buffer-end) (writer).
ring-buffer-flush (function).
ring-buffer-insert (function).
ring-buffer-new (reader).
(setf ring-buffer-new) (writer).
ring-buffer-next (function).
ring-buffer-p (function).
ring-buffer-pop (function).
ring-buffer-reset (function).
ring-buffer-start (reader).
(setf ring-buffer-start) (writer).
ring-buffer-used (reader).
(setf ring-buffer-used) (writer).
ring-buffer-vector (reader).
(setf ring-buffer-vector) (writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
read-heredoc stream char arg => string
Return string from STREAM up to the point where the string read first until CHAR
is encountered. All evaluation is completely turned off so no quoting is
required at all.
Example:
CL-USER> (set-dispatch-macro-character ## #> #’cl-heredoc:read-heredoc)
CL-USER> #>eof>Write whatever (you) "want"!eof => Write whatever (you) "want"!
read-until-match stream terminal => string
Read characters from STREAM until a sequence equal to string TERMINAL is read. Return all characters read as string omitting TERMINAL itself. Signal error upon EOF.
new-ring-buffer length => ring-buffer
Create a new RING-BUFFER containing a simple character vector of fixed size LENGTH.
rbref buffer index => character or #Nul
Return character stored at INDEX in ring BUFFER.
setf (rbref buffer index) value => value
SETF for RBREF. If INDEX > LENGTH of BUFFER, start over at the beginning.
ring-buffer-clear buffer => -1
Reset all indices of BUFFER to their initial state.
end.
ring-buffer-flush buffer => string
Flush all unused characters in BUFFER.
ring-buffer-insert buffer value => value
Increment END of BUFFER inserting VALUE at the new index.
new.
ring-buffer-next buffer => character or nil
Return next match character incrementing USED in BUFFER or simply NIL if none are left.
ring-buffer-pop buffer => character
Increment START of BUFFER returning VALUE at the new index. Additionally, reset the BUFFER match indices.
ring-buffer-reset buffer => end-index
Reset match beginning/end indices USED and NEW in BUFFER to START and END.
used.
Structure defining ring buffers utilizing a simple VECTOR of fixed size and
four indices:
START: Index of first live value
END: Index of last live value
USED: Beginning of current match
NEW: End of current match
| Jump to: | (
C F M N R |
|---|
| Jump to: | (
C F M N R |
|---|
| Jump to: | E N S U V |
|---|
| Jump to: | E N S U V |
|---|
| Jump to: | C F H M P R S |
|---|
| Jump to: | C F H M P R S |
|---|