This is the cl-org-mode Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:37:52 2020 GMT+0.
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The cl-org-mode system |
cl-org-mode.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The cl-org-mode/src module |
cl-org-mode (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The cl-org-mode/src/packages․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-org-mode.asd
cl-org-mode (system)
Next: The cl-org-mode/src/utils․lisp file, Previous: The cl-org-mode․asd file, Up: Lisp files [Contents][Index]
src (module)
src/packages.lisp
Next: The cl-org-mode/src/protocol․lisp file, Previous: The cl-org-mode/src/packages․lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
src (module)
src/utils.lisp
Next: The cl-org-mode/src/parser․lisp file, Previous: The cl-org-mode/src/utils․lisp file, Up: Lisp files [Contents][Index]
utils.lisp (file)
src (module)
src/protocol.lisp
Next: The cl-org-mode/src/cl-org-mode․lisp file, Previous: The cl-org-mode/src/protocol․lisp file, Up: Lisp files [Contents][Index]
protocol.lisp (file)
src (module)
src/parser.lisp
Previous: The cl-org-mode/src/parser․lisp file, Up: Lisp files [Contents][Index]
parser.lisp (file)
src (module)
src/cl-org-mode.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-org-mode package |
packages.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Internal definitions |
Previous: Definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
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
protocol.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
utils.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Called when the node has finished reading.
This is usually either because node-end returned true or implicitly
because another node has started
protocol.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
If there is something on the stack, and a new node has started, then stick it in the default node
cl-org-mode.lisp (file)
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.
protocol.lisp (file)
parser.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
Anything not in another node ends up here
cl-org-mode.lisp (file)
Called by the reader in order to set the dynamic dispatch environment before reading the next node
protocol.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
return true if stack of characters indicate this node has finished reading
protocol.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
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.
protocol.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
protocol.lisp (file)
automatically generated writer method
protocol.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
automatically generated reader method
cl-org-mode.lisp (file)
automatically generated writer method
cl-org-mode.lisp (file)
read the next node in stream and return it.
This is the main entry point for specializing node types.
protocol.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
cl-org-mode.lisp (file)
parser.lisp (file)
When we know what the node is already, just return it
parser.lisp (file)
This method is called when we don’t yet know what the next node is
parser.lisp (file)
return the next node after reading it from the stream
The default method simply calls READ-NEXT-NODE.
protocol.lisp (file)
cl-org-mode.lisp (file)
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
utils.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
cl-org-mode.lisp (file)
org-node (class)
:opening-delimiter-node
node.opening-delimiter-node (generic function)
(setf node.opening-delimiter-node) (generic function)
cl-org-mode.lisp (file)
org-parent-node (class)
:opening-delimiter
node.opening-delimiter (generic function)
(setf node.opening-delimiter) (generic function)
:closing-delimiter
node.closing-delimiter (generic function)
(setf node.closing-delimiter) (generic function)
node.closing-delimiter-node (generic function)
(setf node.closing-delimiter-node) (generic function)
node.closed-p (generic function)
(setf node.closed-p) (generic function)
Initarg | Value |
---|---|
:include-end-node | t |
Base class for all nodes
protocol.lisp (file)
standard-object (class)
org-node (class)
:next-node
node.next-node (generic function)
(setf node.next-node) (generic function)
cl-org-mode.lisp (file)
org-parent-node (class)
:pathname
node.pathname (generic function)
(setf node.pathname) (generic function)
cl-org-mode.lisp (file)
node (class)
Some node contain other nodes
cl-org-mode.lisp (file)
org-node (class)
:children
node.children (generic function)
(setf node.children) (generic function)
:include-end-node
include-end-node-p (generic function)
cl-org-mode.lisp (file)
org-parent-node (class)
:heading
node.heading (generic function)
(setf node.heading) (generic function)
:indicator
node.heading-level-indicator (generic function)
(setf node.heading-level-indicator) (generic function)
cl-org-mode.lisp (file)
delimited-node (class)
Initarg | Value |
---|---|
:opening-delimiter | ":properties: " |
:closing-delimiter | ":end:" |
cl-org-mode.lisp (file)
delimited-node (class)
:property
property-node.property (generic function)
(setf property-node.property) (generic function)
:value
property-node.value (generic function)
(setf property-node.value) (generic function)
Initarg | Value |
---|---|
:closing-delimiter | (format nil "~%") |
cl-org-mode.lisp (file)
:emacs-mode
node.emacs-mode (generic function)
(setf node.emacs-mode) (generic function)
Initarg | Value |
---|---|
:opening-delimiter | "#+begin_src" |
:closing-delimiter | (format nil "~%#+end_src") |
:text | nil |
:include-end-node | nil |
cl-org-mode.lisp (file)
org-node (class)
src-node (class)
:text
node.text (generic function)
(setf node.text) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L M |
---|
Jump to: | C F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A F G I M N P R S |
---|
Jump to: | (
A F G I M N P R S |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
C E H I N O P S T V |
---|
Jump to: | *
C E H I N O P S T V |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C D N O P S T |
---|
Jump to: | C D N O P S T |
---|