This is the cl-org-mode Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 04:11:28 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-org-modealexandria (system).
closer-mop (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-org-mode/srccl-org-mode (system).
packages.lisp (file).
utils.lisp (file).
protocol.lisp (file).
parser.lisp (file).
cl-org-mode.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-org-mode/cl-org-mode.asdcl-org-mode/src/packages.lispcl-org-mode/src/utils.lispcl-org-mode/src/protocol.lispcl-org-mode/src/parser.lispcl-org-mode/src/cl-org-mode.lispcl-org-mode/src/utils.lisppackages.lisp (file).
src (module).
stack->string (function).
stack-starts-with (generic function).
cl-org-mode/src/protocol.lisputils.lisp (file).
src (module).
*dispatchers* (special variable).
finalize-node (generic function).
find-next-node (generic function).
node (class).
node-dispatchers (generic function).
node-end (generic function).
node-start (generic function).
node.next-node (reader method).
(setf node.next-node) (writer method).
read-next-node (generic function).
read-node (generic function).
cl-org-mode/src/parser.lispprotocol.lisp (file).
src (module).
find-next-node (method).
read-next-node (method).
read-next-node (method).
read-next-node (method).
cl-org-mode/src/cl-org-mode.lispparser.lisp (file).
src (module).
shared-initialize (method).
at-outline-node-p (function).
closing-delimiter-node (class).
delimited-node (class).
finalize-node (method).
finalize-node (method).
finalize-node (method).
finalize-node (method).
get-property-value (function).
include-end-node-p (reader method).
make-default-node (generic function).
node-dispatchers (method).
node-dispatchers (method).
node-dispatchers (method).
node-dispatchers (method).
node-end (method).
node-end (method).
node-end (method).
node-end (method).
node-end (method).
node-prototypes (method).
node-start (method).
node-start (method).
node-start (method).
node-start (method).
node-start (method).
node.children (reader method).
(setf node.children) (writer method).
node.closed-p (reader method).
(setf node.closed-p) (writer method).
node.closing-delimiter (reader method).
(setf node.closing-delimiter) (writer method).
node.closing-delimiter-node (reader method).
(setf node.closing-delimiter-node) (writer method).
node.emacs-mode (reader method).
(setf node.emacs-mode) (writer method).
node.heading (reader method).
(setf node.heading) (writer method).
node.heading-level-indicator (reader method).
(setf node.heading-level-indicator) (writer method).
node.opening-delimiter (reader method).
(setf node.opening-delimiter) (writer method).
node.opening-delimiter-node (reader method).
(setf node.opening-delimiter-node) (writer method).
node.pathname (reader method).
(setf node.pathname) (writer method).
node.text (reader method).
(setf node.text) (writer method).
org-file (class).
org-node (class).
org-parent-node (class).
outline-node (class).
properties-node (class).
property-node (class).
property-node.property (reader method).
(setf property-node.property) (writer method).
property-node.value (reader method).
(setf property-node.value) (writer method).
read-child-nodes (function).
read-next-node (method).
read-next-node (method).
read-next-node (method).
read-next-node (method).
read-node (method).
read-org-file (function).
read-parent-node (function).
src-node (class).
text-node (class).
Packages are listed by definition order.
cl-org-modecommon-lisp.
*dispatchers* (special variable).
at-outline-node-p (function).
closing-delimiter-node (class).
delimited-node (class).
finalize-node (generic function).
find-next-node (generic function).
get-property-value (function).
include-end-node-p (generic reader).
make-default-node (generic function).
node (class).
node-dispatchers (generic function).
node-end (generic function).
node-prototypes (generic function).
node-start (generic function).
node.children (generic reader).
(setf node.children) (generic writer).
node.closed-p (generic reader).
(setf node.closed-p) (generic writer).
node.closing-delimiter (generic reader).
(setf node.closing-delimiter) (generic writer).
node.closing-delimiter-node (generic reader).
(setf node.closing-delimiter-node) (generic writer).
node.emacs-mode (generic reader).
(setf node.emacs-mode) (generic writer).
node.heading (generic reader).
(setf node.heading) (generic writer).
node.heading-level-indicator (generic reader).
(setf node.heading-level-indicator) (generic writer).
node.next-node (generic reader).
(setf node.next-node) (generic writer).
node.opening-delimiter (generic reader).
(setf node.opening-delimiter) (generic writer).
node.opening-delimiter-node (generic reader).
(setf node.opening-delimiter-node) (generic writer).
node.pathname (generic reader).
(setf node.pathname) (generic writer).
node.text (generic reader).
(setf node.text) (generic writer).
org-file (class).
org-node (class).
org-parent-node (class).
outline-node (class).
properties-node (class).
property-node (class).
property-node.property (generic reader).
(setf property-node.property) (generic writer).
property-node.value (generic reader).
(setf property-node.value) (generic writer).
read-child-nodes (function).
read-next-node (generic function).
read-node (generic function).
read-org-file (function).
read-parent-node (function).
src-node (class).
stack->string (function).
stack-starts-with (generic function).
text-node (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A dynamic variable to hold a list of nodes to use as dispatchers. The default method for FIND-NEXT-NODE will call NODE-START on these nodes
Called when the node has finished reading.
This is usually either because node-end returned true or implicitly
because another node has started
property-node) next-node stack) ¶properties-node) next-node stack) ¶If there is something on the stack, and a new node has started, then stick it in the default node
Find the next node that starts in STREAM, implicitly ending NODE.
All methods must return the multiple values (VALUES NEW-NODE OLD-STACK) as if from NODE-START.
org-parent-node)) ¶automatically generated reader method
Anything not in another node ends up here
Called by the reader in order to set the dynamic dispatch environment before reading the next node
properties-node)) ¶delimited-node)) ¶return true if stack of characters indicate this node has finished reading
outline-node) (next-node null) stack) ¶outline-node) (next-node outline-node) stack) ¶delimited-node) (next-node closing-delimiter-node) stack) ¶Indicate a new node should begin at this point in the stack.
The parser will pass a class prototype instance via NODE, so it
shouldn’t be mutated.
All methods _must_ return (VALUES NEW-NODE OLD-STACK) where NEW-NODE created NODE object and any remaining stack which likely belongs to the previous node.
property-node) stack) ¶outline-node) stack) ¶closing-delimiter-node) stack) ¶delimited-node) stack) ¶org-parent-node)) ¶automatically generated reader method
org-parent-node)) ¶automatically generated writer method
delimited-node)) ¶automatically generated reader method
delimited-node)) ¶automatically generated writer method
delimited-node)) ¶automatically generated reader method
delimited-node)) ¶automatically generated writer method
delimited-node)) ¶automatically generated reader method
delimited-node)) ¶automatically generated writer method
outline-node)) ¶automatically generated reader method
outline-node)) ¶automatically generated writer method
outline-node)) ¶automatically generated reader method
outline-node)) ¶automatically generated writer method
delimited-node)) ¶automatically generated reader method
delimited-node)) ¶automatically generated writer method
closing-delimiter-node)) ¶automatically generated reader method
closing-delimiter-node)) ¶automatically generated writer method
property-node)) ¶automatically generated reader method
property-node)) ¶automatically generated writer method
property-node)) ¶automatically generated reader method
property-node)) ¶automatically generated writer method
read the next node in stream and return it.
This is the main entry point for specializing node types.
outline-node) (next-node null) stream) ¶delimited-node) next-node stream) ¶org-parent-node) (next-node null) stream) ¶node) stream) ¶When we know what the node is already, just return it
null) stream) ¶This method is called when we don’t yet know what the next node is
return the next node after reading it from the stream
The default method simply calls READ-NEXT-NODE.
org-parent-node) stream) ¶return (values start-of-stack rest-of-stack) if stack starts with maybe-starts-with. If maybe-starts-with is a string. reverse it before testing against stack
:opening-delimiter-node
| Initarg | Value |
|---|---|
:include-end-node | t |
:opening-delimiter
:closing-delimiter
Base class for all nodes
:next-node
common-lisp.
:pathname
Some node contain other nodes
| Initarg | Value |
|---|---|
:opening-delimiter | :properties:
|
:closing-delimiter | :end: |
| Initarg | Value |
|---|---|
:opening-delimiter | #+begin_src |
:closing-delimiter | (format nil ~%#+end_src) |
:text | nil |
:include-end-node | nil |
:emacs-mode
:text
| Jump to: | (
A F G I M N P R S |
|---|
| Jump to: | (
A F G I M N P R S |
|---|
| Jump to: | *
C E H I N O P S T V |
|---|
| Jump to: | *
C E H I N O P S T V |
|---|
| Jump to: | C D F M N O P S T U |
|---|
| Jump to: | C D F M N O P S T U |
|---|