The cl-org-mode Reference Manual

Table of Contents

The cl-org-mode Reference Manual

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.

1 Systems

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

1.1 cl-org-mode

Dependencies

• alexandria
• closer-mop

Source

cl-org-mode.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 cl-org-mode/src

Parent

cl-org-mode (system)

Location

src/

Components

• packages.lisp (file)
• utils.lisp (file)
• protocol.lisp (file)
• parser.lisp (file)
• cl-org-mode.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 cl-org-mode.asd

Location

cl-org-mode.asd

Systems

cl-org-mode (system)

3.1.2 cl-org-mode/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

cl-org-mode

3.1.3 cl-org-mode/src/utils.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

• stack->string (function)
• stack-starts-with (generic function)
• stack-starts-with (method)
• stack-starts-with (method)

3.1.4 cl-org-mode/src/protocol.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/protocol.lisp

Internal Definitions

• *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 (method)
• (setf node.next-node) (method)
• read-next-node (generic function)
• read-node (generic function)
• read-node (method)

3.1.5 cl-org-mode/src/parser.lisp

Dependency

protocol.lisp (file)

Parent

src (module)

Location

src/parser.lisp

Internal Definitions

• find-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)

3.1.6 cl-org-mode/src/cl-org-mode.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/cl-org-mode.lisp

Internal Definitions

• 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 (method)
• make-default-node (generic function)
• make-default-node (method)
• 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 (method)
• (setf node.children) (method)
• node.closed-p (method)
• (setf node.closed-p) (method)
• node.closing-delimiter (method)
• (setf node.closing-delimiter) (method)
• node.closing-delimiter-node (method)
• (setf node.closing-delimiter-node) (method)
• node.emacs-mode (method)
• (setf node.emacs-mode) (method)
• node.heading (method)
• (setf node.heading) (method)
• node.heading-level-indicator (method)
• (setf node.heading-level-indicator) (method)
• node.opening-delimiter (method)
• (setf node.opening-delimiter) (method)
• node.opening-delimiter-node (method)
• (setf node.opening-delimiter-node) (method)
• node.pathname (method)
• (setf node.pathname) (method)
• node.text (method)
• (setf node.text) (method)
• org-file (class)
• org-node (class)
• org-parent-node (class)
• outline-node (class)
• properties-node (class)
• property-node (class)
• property-node.property (method)
• (setf property-node.property) (method)
• property-node.value (method)
• (setf property-node.value) (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)

4 Packages

Packages are listed by definition order.

4.1 cl-org-mode

Source

packages.lisp (file)

Use List

common-lisp

Internal Definitions

• *dispatchers* (special variable)
• at-outline-node-p (function)
• closing-delimiter-node (class)
• delimited-node (class)
• finalize-node (generic function)
• finalize-node (method)
• finalize-node (method)
• finalize-node (method)
• finalize-node (method)
• find-next-node (generic function)
• find-next-node (method)
• get-property-value (function)
• include-end-node-p (generic function)
• include-end-node-p (method)
• make-default-node (generic function)
• make-default-node (method)
• node (class)
• node-dispatchers (generic function)
• node-dispatchers (method)
• node-dispatchers (method)
• node-dispatchers (method)
• node-dispatchers (method)
• node-end (generic function)
• node-end (method)
• node-end (method)
• node-end (method)
• node-end (method)
• node-end (method)
• node-prototypes (generic function)
• node-prototypes (method)
• node-start (generic function)
• node-start (method)
• node-start (method)
• node-start (method)
• node-start (method)
• node-start (method)
• node.children (generic function)
• node.children (method)
• (setf node.children) (method)
• (setf node.children) (generic function)
• node.closed-p (generic function)
• node.closed-p (method)
• (setf node.closed-p) (method)
• (setf node.closed-p) (generic function)
• node.closing-delimiter (generic function)
• node.closing-delimiter (method)
• (setf node.closing-delimiter) (method)
• (setf node.closing-delimiter) (generic function)
• node.closing-delimiter-node (generic function)
• node.closing-delimiter-node (method)
• (setf node.closing-delimiter-node) (method)
• (setf node.closing-delimiter-node) (generic function)
• node.emacs-mode (generic function)
• node.emacs-mode (method)
• (setf node.emacs-mode) (method)
• (setf node.emacs-mode) (generic function)
• node.heading (generic function)
• node.heading (method)
• (setf node.heading) (method)
• (setf node.heading) (generic function)
• node.heading-level-indicator (generic function)
• node.heading-level-indicator (method)
• (setf node.heading-level-indicator) (method)
• (setf node.heading-level-indicator) (generic function)
• node.next-node (generic function)
• node.next-node (method)
• (setf node.next-node) (method)
• (setf node.next-node) (generic function)
• node.opening-delimiter (generic function)
• node.opening-delimiter (method)
• (setf node.opening-delimiter) (method)
• (setf node.opening-delimiter) (generic function)
• node.opening-delimiter-node (generic function)
• node.opening-delimiter-node (method)
• (setf node.opening-delimiter-node) (method)
• (setf node.opening-delimiter-node) (generic function)
• node.pathname (generic function)
• node.pathname (method)
• (setf node.pathname) (method)
• (setf node.pathname) (generic function)
• node.text (generic function)
• node.text (method)
• (setf node.text) (method)
• (setf node.text) (generic function)
• org-file (class)
• org-node (class)
• org-parent-node (class)
• outline-node (class)
• properties-node (class)
• property-node (class)
• property-node.property (generic function)
• property-node.property (method)
• (setf property-node.property) (method)
• (setf property-node.property) (generic function)
• property-node.value (generic function)
• property-node.value (method)
• (setf property-node.value) (method)
• (setf property-node.value) (generic function)
• read-child-nodes (function)
• read-next-node (generic function)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-next-node (method)
• read-node (generic function)
• read-node (method)
• read-node (method)
• read-org-file (function)
• read-parent-node (function)
• src-node (class)
• stack->string (function)
• stack-starts-with (generic function)
• stack-starts-with (method)
• stack-starts-with (method)
• text-node (class)

5 Definitions

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

5.1 Internal definitions

5.1.1 Special variables

Special Variable: *dispatchers*

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

Package

cl-org-mode

Source

protocol.lisp (file)

5.1.2 Functions

Function: at-outline-node-p STACK

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Function: get-property-value NODE KEY

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Function: read-child-nodes ROOT-NODE STACK STREAM

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Function: read-org-file PATHNAME

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Function: read-parent-node PARENT-NODE STREAM

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Function: stack->string STACK

Package

cl-org-mode

Source

utils.lisp (file)

5.1.3 Generic functions

Generic Function: finalize-node NODE NEXT-NODE STACK

Called when the node has finished reading.

This is usually either because node-end returned true or implicitly because another node has started

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: finalize-node (NODE property-node) NEXT-NODE STACK

Source

cl-org-mode.lisp (file)

Method: finalize-node (NODE properties-node) NEXT-NODE STACK

Source

cl-org-mode.lisp (file)

Method: finalize-node (NODE src-node) NEXT-NODE STACK

Source

cl-org-mode.lisp (file)

Method: finalize-node NODE NEXT-NODE STACK

If there is something on the stack, and a new node has started, then stick it in the default node

Source

cl-org-mode.lisp (file)

Generic Function: find-next-node NODE NEXT-NODE STACK

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.

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: find-next-node NODE NEXT-NODE STACK

Source

parser.lisp (file)

Generic Function: include-end-node-p OBJECT

Package

cl-org-mode

Methods

Method: include-end-node-p (ORG-PARENT-NODE org-parent-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Generic Function: make-default-node NODE NEXT-NODE STACK

Anything not in another node ends up here

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Methods

Method: make-default-node (NODE org-node) NEXT-NODE STACK

Generic Function: node-dispatchers NODE

Called by the reader in order to set the dynamic dispatch environment before reading the next node

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: node-dispatchers (NODE properties-node)

Source

cl-org-mode.lisp (file)

Method: node-dispatchers (NODE src-node)

Source

cl-org-mode.lisp (file)

Method: node-dispatchers (NODE delimited-node)

Source

cl-org-mode.lisp (file)

Method: node-dispatchers (NODE org-node)

Source

cl-org-mode.lisp (file)

Generic Function: node-end NODE NEXT-NODE STACK

return true if stack of characters indicate this node has finished reading

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: node-end (NODE outline-node) (NEXT-NODE null) STACK

Source

cl-org-mode.lisp (file)

Method: node-end (NODE outline-node) (NEXT-NODE outline-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-end (NODE delimited-node) (NEXT-NODE closing-delimiter-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-end (NODE org-node) (NEXT-NODE null) STACK

Source

cl-org-mode.lisp (file)

Method: node-end (NODE org-node) NEXT-NODE STREAM

Source

cl-org-mode.lisp (file)

Generic Function: node-prototypes NODE

Package

cl-org-mode

Methods

Method: node-prototypes NODE

Source

cl-org-mode.lisp (file)

Generic Function: node-start 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.

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: node-start (NODE property-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-start (NODE outline-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-start (NODE closing-delimiter-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-start (NODE delimited-node) STACK

Source

cl-org-mode.lisp (file)

Method: node-start (NODE org-node) STREAM

Source

cl-org-mode.lisp (file)

Generic Function: node.children OBJECT

Generic Function: (setf node.children) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.children (ORG-PARENT-NODE org-parent-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.children) NEW-VALUE (ORG-PARENT-NODE org-parent-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.closed-p OBJECT

Generic Function: (setf node.closed-p) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.closed-p (DELIMITED-NODE delimited-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.closed-p) NEW-VALUE (DELIMITED-NODE delimited-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.closing-delimiter OBJECT

Generic Function: (setf node.closing-delimiter) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.closing-delimiter (DELIMITED-NODE delimited-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.closing-delimiter) NEW-VALUE (DELIMITED-NODE delimited-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.closing-delimiter-node OBJECT

Generic Function: (setf node.closing-delimiter-node) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.closing-delimiter-node (DELIMITED-NODE delimited-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.closing-delimiter-node) NEW-VALUE (DELIMITED-NODE delimited-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.emacs-mode OBJECT

Generic Function: (setf node.emacs-mode) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.emacs-mode (SRC-NODE src-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.emacs-mode) NEW-VALUE (SRC-NODE src-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.heading OBJECT

Generic Function: (setf node.heading) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.heading (OUTLINE-NODE outline-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.heading) NEW-VALUE (OUTLINE-NODE outline-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.heading-level-indicator OBJECT

Generic Function: (setf node.heading-level-indicator) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.heading-level-indicator (OUTLINE-NODE outline-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.heading-level-indicator) NEW-VALUE (OUTLINE-NODE outline-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.next-node OBJECT

Generic Function: (setf node.next-node) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.next-node (NODE node)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf node.next-node) NEW-VALUE (NODE node)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: node.opening-delimiter OBJECT

Generic Function: (setf node.opening-delimiter) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.opening-delimiter (DELIMITED-NODE delimited-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.opening-delimiter) NEW-VALUE (DELIMITED-NODE delimited-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.opening-delimiter-node OBJECT

Generic Function: (setf node.opening-delimiter-node) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.opening-delimiter-node (CLOSING-DELIMITER-NODE closing-delimiter-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.opening-delimiter-node) NEW-VALUE (CLOSING-DELIMITER-NODE closing-delimiter-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.pathname OBJECT

Generic Function: (setf node.pathname) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.pathname (ORG-FILE org-file)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.pathname) NEW-VALUE (ORG-FILE org-file)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: node.text OBJECT

Generic Function: (setf node.text) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: node.text (TEXT-NODE text-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf node.text) NEW-VALUE (TEXT-NODE text-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: property-node.property OBJECT

Generic Function: (setf property-node.property) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: property-node.property (PROPERTY-NODE property-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf property-node.property) NEW-VALUE (PROPERTY-NODE property-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: property-node.value OBJECT

Generic Function: (setf property-node.value) NEW-VALUE OBJECT

Package

cl-org-mode

Methods

Method: property-node.value (PROPERTY-NODE property-node)

automatically generated reader method

Source

cl-org-mode.lisp (file)

Method: (setf property-node.value) NEW-VALUE (PROPERTY-NODE property-node)

automatically generated writer method

Source

cl-org-mode.lisp (file)

Generic Function: read-next-node NODE NEXT-NODE STREAM

read the next node in stream and return it.

This is the main entry point for specializing node types.

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: read-next-node (NODE src-node) (NEXT-NODE null) STREAM

Source

cl-org-mode.lisp (file)

Method: read-next-node (NODE outline-node) (NEXT-NODE null) STREAM

Source

cl-org-mode.lisp (file)

Method: read-next-node (NODE delimited-node) NEXT-NODE STREAM around

Source

cl-org-mode.lisp (file)

Method: read-next-node (NODE org-parent-node) (NEXT-NODE null) STREAM

Source

cl-org-mode.lisp (file)

Method: read-next-node NODE NEXT-NODE STREAM around

Source

parser.lisp (file)

Method: read-next-node NODE (NEXT-NODE node) STREAM

When we know what the node is already, just return it

Source

parser.lisp (file)

Method: read-next-node NODE (NEXT-NODE null) STREAM

This method is called when we don’t yet know what the next node is

Source

parser.lisp (file)

Generic Function: read-node STARTING-NODE STREAM

return the next node after reading it from the stream

The default method simply calls READ-NEXT-NODE.

Package

cl-org-mode

Source

protocol.lisp (file)

Methods

Method: read-node (NODE org-parent-node) STREAM around

Source

cl-org-mode.lisp (file)

Method: read-node STARTING-NODE STREAM

Generic Function: stack-starts-with STACK MAYBE-STARTS-WITH

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

Package

cl-org-mode

Source

utils.lisp (file)

Methods

Method: stack-starts-with STACK LIST

Method: stack-starts-with STACK (STRING string)

5.1.4 Classes

Class: closing-delimiter-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-node (class)

Direct methods

• node-end (method)
• node-start (method)
• node.opening-delimiter-node (method)
• node.opening-delimiter-node (method)

Direct slots

Slot: opening-delimiter-node

Initargs

:opening-delimiter-node

Readers

node.opening-delimiter-node (generic function)

Writers

(setf node.opening-delimiter-node) (generic function)

Class: delimited-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-parent-node (class)

Direct subclasses

• src-node (class)
• properties-node (class)
• property-node (class)

Direct methods

• read-next-node (method)
• node-end (method)
• node-start (method)
• node-dispatchers (method)
• shared-initialize (method)
• node.closed-p (method)
• node.closed-p (method)
• node.closing-delimiter-node (method)
• node.closing-delimiter-node (method)
• node.closing-delimiter (method)
• node.closing-delimiter (method)
• node.opening-delimiter (method)
• node.opening-delimiter (method)

Direct slots

Slot: opening-delimiter

Initargs

:opening-delimiter

Readers

node.opening-delimiter (generic function)

Writers

(setf node.opening-delimiter) (generic function)

Slot: closing-delimiter

Initargs

:closing-delimiter

Readers

node.closing-delimiter (generic function)

Writers

(setf node.closing-delimiter) (generic function)

Slot: closing-delimiter-node

Readers

node.closing-delimiter-node (generic function)

Writers

(setf node.closing-delimiter-node) (generic function)

Slot: node-closed

Readers

node.closed-p (generic function)

Writers

(setf node.closed-p) (generic function)

Direct Default Initargs

Initarg	Value
:include-end-node	t

Class: node ()

Base class for all nodes

Package

cl-org-mode

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

org-node (class)

Direct methods

• read-next-node (method)
• node.next-node (method)
• node.next-node (method)

Direct slots

Slot: next-node

Initargs

:next-node

Readers

node.next-node (generic function)

Writers

(setf node.next-node) (generic function)

Class: org-file ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-parent-node (class)

Direct methods

• node.pathname (method)
• node.pathname (method)

Direct slots

Slot: pathname

Initargs

:pathname

Readers

node.pathname (generic function)

Writers

(setf node.pathname) (generic function)

Class: org-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

node (class)

Direct subclasses

• text-node (class)
• org-parent-node (class)
• closing-delimiter-node (class)

Direct methods

• make-default-node (method)
• node-dispatchers (method)
• node-end (method)
• node-end (method)
• node-start (method)

Class: org-parent-node ()

Some node contain other nodes

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-node (class)

Direct subclasses

• org-file (class)
• delimited-node (class)
• outline-node (class)

Direct methods

• read-node (method)
• read-next-node (method)
• include-end-node-p (method)
• node.children (method)
• node.children (method)

Direct slots

Slot: child-nodes

Initargs

:children

Readers

node.children (generic function)

Writers

(setf node.children) (generic function)

Slot: include-end-node

Initargs

:include-end-node

Readers

include-end-node-p (generic function)

Class: outline-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-parent-node (class)

Direct methods

• read-next-node (method)
• node-end (method)
• node-end (method)
• node-start (method)
• node.heading-level-indicator (method)
• node.heading-level-indicator (method)
• node.heading (method)
• node.heading (method)

Direct slots

Slot: heading

Initargs

:heading

Readers

node.heading (generic function)

Writers

(setf node.heading) (generic function)

Slot: heading-level-indicator

Initargs

:indicator

Readers

node.heading-level-indicator (generic function)

Writers

(setf node.heading-level-indicator) (generic function)

Class: properties-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

delimited-node (class)

Direct methods

• node-dispatchers (method)
• finalize-node (method)

Direct Default Initargs

Initarg	Value
:opening-delimiter	":properties: "
:closing-delimiter	":end:"

Class: property-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

delimited-node (class)

Direct methods

• finalize-node (method)
• node-start (method)
• property-node.value (method)
• property-node.value (method)
• property-node.property (method)
• property-node.property (method)

Direct slots

Slot: property

Initargs

:property

Readers

property-node.property (generic function)

Writers

(setf property-node.property) (generic function)

Slot: value

Initargs

:value

Readers

property-node.value (generic function)

Writers

(setf property-node.value) (generic function)

Direct Default Initargs

Initarg	Value
:closing-delimiter	(format nil "~%")

Class: src-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

• text-node (class)
• delimited-node (class)

Direct methods

• finalize-node (method)
• read-next-node (method)
• node-dispatchers (method)
• node.emacs-mode (method)
• node.emacs-mode (method)

Direct slots

Slot: emacs-mode

Initargs

:emacs-mode

Readers

node.emacs-mode (generic function)

Writers

(setf node.emacs-mode) (generic function)

Direct Default Initargs

Initarg	Value
:opening-delimiter	"#+begin_src"
:closing-delimiter	(format nil "~%#+end_src")
:text	nil
:include-end-node	nil

Class: text-node ()

Package

cl-org-mode

Source

cl-org-mode.lisp (file)

Direct superclasses

org-node (class)

Direct subclasses

src-node (class)

Direct methods

• node.text (method)
• node.text (method)

Direct slots

Slot: text

Initargs

:text

Readers

node.text (generic function)

Writers

(setf node.text) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types