The cmark Reference Manual

4.1.1 cmark/cmark.asd

Source

cmark.asd.

Parent Component

cmark (system).

ASDF Systems

cmark.

---

4.1.2 libcmark/libcmark.asd

Source

libcmark.asd.

Parent Component

libcmark (system).

ASDF Systems

libcmark.

---

4.1.3 cmark/src/cmark/package.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Packages

cmark.

---

4.1.4 cmark/src/cmark/conditions.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• parser-exhausted (condition).
• unexpected-orphan (condition).
• unexpected-parent (condition).

---

4.1.5 cmark/src/cmark/node.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• block-node-p (generic function).
• block-quote-node (class).
• child-node (class).
• childlessp (function).
• code-block-node (class).
• code-node (class).
• custom-block-node (class).
• custom-inline-node (class).
• document-node (class).
• emph-node (class).
• heading-node (class).
• html-block-node (class).
• html-inline-node (class).
• image-node (class).
• inline-node-p (generic function).
• item-node (class).
• leaf-node-p (generic function).
• linebreak-node (class).
• link-node (class).
• list-node (class).
• node (class).
• node-children (generic function).
• node-heading-level (reader method).
• (setf node-heading-level) (writer method).
• node-list-delim (reader method).
• (setf node-list-delim) (writer method).
• node-list-start (reader method).
• (setf node-list-start) (writer method).
• node-list-type (reader method).
• (setf node-list-type) (writer method).
• node-literal (reader method).
• node-literal (reader method).
• node-literal (reader method).
• node-literal (reader method).
• node-literal (reader method).
• (setf node-literal) (writer method).
• (setf node-literal) (writer method).
• (setf node-literal) (writer method).
• (setf node-literal) (writer method).
• (setf node-literal) (writer method).
• node-parent (generic function).
• node-title (reader method).
• node-title (reader method).
• (setf node-title) (writer method).
• (setf node-title) (writer method).
• node-url (reader method).
• node-url (reader method).
• (setf node-url) (writer method).
• (setf node-url) (writer method).
• orphanp (function).
• paragraph-node (class).
• parent-node (class).
• softbreak-node (class).
• strong-node (class).
• text-node (class).
• thematic-break-node (class).

Internals

• block-node (class).
• inline-node (class).
• node-end-column (reader method).
• node-end-line (reader method).
• node-fence-info (reader method).
• (setf node-fence-info) (writer method).
• node-list-tight-p (reader method).
• (setf node-list-tight-p) (writer method).
• node-on-enter (reader method).
• node-on-enter (reader method).
• (setf node-on-enter) (writer method).
• (setf node-on-enter) (writer method).
• node-on-exit (reader method).
• node-on-exit (reader method).
• (setf node-on-exit) (writer method).
• (setf node-on-exit) (writer method).
• node-start-column (reader method).
• node-start-line (reader method).
• node-user-data (reader method).
• (setf node-user-data) (writer method).

---

4.1.6 cmark/src/cmark/iteration.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• iterator-advance (function).
• iterator-reset (function).
• make-iterator (function).
• walk-tree (function).

Internals

• *non-exit-nodes* (special variable).
• copy-iterator (function).
• iterator (structure).
• iterator-event (reader).
• (setf iterator-event) (writer).
• iterator-node (reader).
• (setf iterator-node) (writer).
• iterator-p (function).
• iterator-root (reader).
• (setf iterator-root) (writer).
• node-event (type).

---

4.1.7 cmark/src/cmark/tree-manipulation.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• append-child-node (function).
• consolidate-text-nodes (function).
• insert-node-after (function).
• insert-node-before (function).
• prepend-child-node (function).
• replace-node (function).
• unlink-node (function).

Internals

• insert-after (function).
• insert-before (function).
• insert-node (function).

---

4.1.8 cmark/src/cmark/tree-traversal.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• node-first-child (function).
• node-last-child (function).
• node-next (function).
• node-next-sibling (function).
• node-previous (function).
• node-previous-sibling (function).
• which-child (function).

---

4.1.9 cmark/src/cmark/from-foreign.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Internals

• *foreign/native-nodes* (special variable).
• *node-common-fields* (special variable).
• *node-type-to-class* (special variable).
• define-node-parser-method (macro).
• node-from-foreign (function).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-node (method).
• parse-tree (function).
• thing-to-gensym (function).
• zip (function).

---

4.1.10 cmark/src/cmark/parsing.lisp

Source

cmark.asd.

Parent Component

cmark (module).

Public Interface

• close-streaming-parser (function).
• feed-streaming-parser (function).
• finish-streaming-parser (function).
• make-streaming-parser (function).
• parse-document (function).
• parse-stream (function).
• with-streaming-parser (macro).

Internals

• copy-streaming-parser (function).
• dump-tree (function).
• streaming-parser (structure).
• streaming-parser-exhausted-p (reader).
• (setf streaming-parser-exhausted-p) (writer).
• streaming-parser-foreign-parser (reader).
• (setf streaming-parser-foreign-parser) (writer).
• streaming-parser-p (function).
• string-octet-length (function).

---

4.1.11 libcmark/src/libcmark/package.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Packages

libcmark.

---

4.1.12 libcmark/src/libcmark/main.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

markdown-to-html (function).

---

4.1.13 libcmark/src/libcmark/option.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• +cmark-opt-default+ (constant).
• +cmark-opt-hardbreaks+ (constant).
• +cmark-opt-nobreaks+ (constant).
• +cmark-opt-normalize+ (constant).
• +cmark-opt-safe+ (constant).
• +cmark-opt-smart+ (constant).
• +cmark-opt-sourcepos+ (constant).
• +cmark-opt-unsafe+ (constant).
• +cmark-opt-validate-utf8+ (constant).

---

4.1.14 libcmark/src/libcmark/memory-allocator.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

default-mem-allocator (function).

Internals

cmark-mem-tclass (class).

---

4.1.15 libcmark/src/libcmark/node-constructor.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• free-node (function).
• make-node (function).
• make-node-with-mem (function).

---

4.1.16 libcmark/src/libcmark/tree-traversal.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• node-first-child (function).
• node-last-child (function).
• node-next (function).
• node-parent (function).
• node-previous (function).

---

4.1.17 libcmark/src/libcmark/node-accessor.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• node-get-end-column (function).
• node-get-end-line (function).
• node-get-fence-info (function).
• node-get-heading-level (function).
• node-get-list-delim (function).
• node-get-list-start (function).
• node-get-list-tight (function).
• node-get-list-type (function).
• node-get-literal (function).
• node-get-on-enter (function).
• node-get-on-exit (function).
• node-get-start-column (function).
• node-get-start-line (function).
• node-get-title (function).
• node-get-type (function).
• node-get-type-string (function).
• node-get-url (function).
• node-get-user-data (function).
• node-set-fence-info (function).
• node-set-heading-level (function).
• node-set-list-delim (function).
• node-set-list-start (function).
• node-set-list-tight (function).
• node-set-list-type (function).
• node-set-literal (function).
• node-set-on-enter (function).
• node-set-on-exit (function).
• node-set-title (function).
• node-set-url (function).
• node-set-user-data (function).

---

4.1.18 libcmark/src/libcmark/iterator.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• free-iterator (function).
• iterator-get-event-type (function).
• iterator-get-node (function).
• iterator-get-root (function).
• iterator-next (function).
• iterator-reset (function).
• make-iterator (function).

---

4.1.19 libcmark/src/libcmark/tree-manipulation.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• consolidate-text-nodes (function).
• node-append-child (function).
• node-insert-after (function).
• node-insert-before (function).
• node-prepend-child (function).
• node-replace (function).
• node-unlink (function).

---

4.1.20 libcmark/src/libcmark/parsing.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• free-parser (function).
• make-parser (function).
• make-parser-with-mem (function).
• parse-document (function).
• parse-file (function).
• parser-feed (function).
• parser-finish (function).

---

4.1.21 libcmark/src/libcmark/rendering.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• render-commonmark (function).
• render-html (function).
• render-latex (function).
• render-man (function).
• render-xml (function).

---

4.1.22 libcmark/src/libcmark/version.lisp

Source

libcmark.asd.

Parent Component

libcmark (module).

Public Interface

• version (function).
• version-string (function).

---

6.1.1 Constants

Constant: +cmark-opt-default+ ¶

Default options.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-hardbreaks+ ¶

Render softbreak elements as hard line breaks.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-nobreaks+ ¶

Render softbreak elements as spaces.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-normalize+ ¶

Legacy option (no effect).

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-safe+ ¶

+CMARK-OPT-SAFE+ is defined here for API compatibility, but it no longer has any effect. "Safe" mode is now the default: set +CMARK-OPT-UNSAFE+ to disable it.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-smart+ ¶

Convert straight quotes to curly, — to em dashes, – to en dashes.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-sourcepos+ ¶

Include a data-sourcepos attribute on all block elements.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-unsafe+ ¶

Render raw HTML and unsafe links (javascript:, vbscript:, file:, and data:, except for image/png, image/gif, image/jpeg, or image/webp mime types). By default, raw HTML is replaced by a placeholder HTML comment. Unsafe links are replaced by empty strings.

Package

libcmark.

Source

option.lisp.

Constant: +cmark-opt-validate-utf8+ ¶

Validate UTF-8 in the input before parsing, replacing illegal sequences with the replacement character U+FFFD.

Package

libcmark.

Source

option.lisp.

---

6.1.2 Macros

Macro: with-streaming-parser ((parser &key smart) &body body) ¶

Evaluate the BODY forms with PARSER bound to a new streaming parser instance. The parser will be safely closed and disposed of when the form terminates. Evaluates to the last BODY expression.

Package

cmark.

Source

parsing.lisp.

---

6.1.3 Ordinary functions

Function: append-child-node (node child) ¶

Append CHILD as the last child node of NODE. It is an error to append a node which is already a child of a node, signals UNEXPECTED-PARENT The following restarts are provided:
- DETACH-FROM-PARENT:
Detaches CHILD from its parent and thus from its original tree, then resumes the function.

Package

cmark.

Source

tree-manipulation.lisp.

Function: childlessp (node) ¶

Whether NODE has no children

Package

cmark.

Source

node.lisp.

Function: close-streaming-parser (parser) ¶

Closes the streaming PARSER, rendering it exhausted. Any internal state of the parser will be discarded. This function is idempotent: if the parser is already closed nothing will happen.

Package

cmark.

Source

parsing.lisp.

Function: consolidate-text-nodes (root) ¶

Consolidates adjacent text nodes.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: consolidate-text-nodes (root) ¶

Consolidates adjacent text nodes in the tree starting at ROOT. Adjacent nodes of type TEXT-NODE will be merged into one by concatenating their literal text. Only one node will remain in the tree, the other nodes will become orphaned. It is undefined which node will remain in the tree.

Package

cmark.

Source

tree-manipulation.lisp.

Function: default-mem-allocator () ¶

Returns a pointer to the default memory allocator.

Package

libcmark.

Source

memory-allocator.lisp.

Function: feed-streaming-parser (parser string) ¶

Feed a STRING into the streaming PARSER. It is an error to feed a closed parser, signals PARSER-EXHAUSTED.

Package

cmark.

Source

parsing.lisp.

Function: finish-streaming-parser (parser) ¶

Returns the parsed node tree. Does not exhaust the parser, feeding the parser or finishing it again is not an error. It is an error to finish a closed parser, signals PARSER-EXHAUSTED.

Package

cmark.

Source

parsing.lisp.

Function: free-iterator (iter) ¶

Frees the memory allocated for an iterator.

Package

libcmark.

Source

iterator.lisp.

Function: free-node (node) ¶

Frees the memory allocated for a node and any children.

Package

libcmark.

Source

node-constructor.lisp.

Function: free-parser (parser) ¶

Frees memory allocated for a parser object.

Package

libcmark.

Source

parsing.lisp.

Function: insert-node-after (node sibling) ¶

Inserts SIBLING into the tree in front of NODE. It is an error to insert
after an orphan (signals UNEXPECTED-ORPHAN), or to insert a node which is already a child (signals UNEXPECTED-PARENT).

Package

cmark.

Source

tree-manipulation.lisp.

Function: insert-node-before (node sibling) ¶

Inserts SIBLING into the tree in front of NODE. It is an error to insert
before an orphan (signals UNEXPECTED-ORPHAN), or to insert a node which is already a child (signals UNEXPECTED-PARENT).

Package

cmark.

Source

tree-manipulation.lisp.

Function: iterator-advance (iterator) ¶

Advances the ITERATOR to the next node/event combination. If the iterator is exhausted nothing will happen. Returns the new node and event.

Package

cmark.

Source

iteration.lisp.

Function: iterator-get-event-type (iterator) ¶

Returns the current event type.

Package

libcmark.

Source

iterator.lisp.

Function: iterator-get-node (iterator) ¶

Returns the current node.

Package

libcmark.

Source

iterator.lisp.

Function: iterator-get-root (iterator) ¶

Returns the root node.

Package

libcmark.

Source

iterator.lisp.

Function: iterator-next (iterator) ¶

Advances to the next node and returns the event type (CMARK_EVENT_ENTER, CMARK_EVENT_EXIT or CMARK_EVENT_DONE).

Package

libcmark.

Source

iterator.lisp.

Function: iterator-reset (iterator current-node event-type) ¶

Resets the ITERATOR so that the current node is CURRENT-NODE and the event type is EVENT-TYPE. The new current node must be a descendant of the root node or the root node itself.

Package

libcmark.

Source

iterator.lisp.

Function: iterator-reset (iterator current event-type) ¶

Reset the ITERATOR so that the current node node is CURRENT and the event type is EVENT-TYPE. The new current node must be a descendant of the root node or the root node itself.

Package

cmark.

Source

iteration.lisp.

Function: make-iterator (root) ¶

Creates a new iterator starting at ROOT. The current node and event type are undefined until ITER-NEXT is called for the first time. The memory allocated for the iterator should be released using FREE-ITERATOR when it is no longer needed.

Package

libcmark.

Source

iterator.lisp.

Function: make-iterator (root) ¶

Package

cmark.

Source

iteration.lisp.

Function: make-node (type) ¶

Creates a new node of type TYPE. Note that the node may have other required properties, which it is the caller’s responsibility to assign.

Package

libcmark.

Source

node-constructor.lisp.

Function: make-node-with-mem (type mem) ¶

Same as MAKE-NODE, but explicitly listing the memory allocator used to allocate the node. Note: be sure to use the same allocator for every node in a tree, or bad things can happen.

Package

libcmark.

Source

node-constructor.lisp.

Function: make-parser (options) ¶

Creates a new parser object.

Package

libcmark.

Source

parsing.lisp.

Function: make-parser-with-mem (options mem) ¶

Creates a new parser object with the given MEMory allocator

Package

libcmark.

Source

parsing.lisp.

Function: make-streaming-parser (&key smart) ¶

Creates a new streaming parser object. A streaming parser can be fed the CommonMark document piecewise, then once the entire document has been fed to it the parser can be finished, which produces the document node tree. It is the caller’s responsibility to close the stream.

Package

cmark.

Source

parsing.lisp.

Function: markdown-to-html (text len options) ¶

Convert TEXT (assumed to be a UTF-8 encoded string with length LEN) from CommonMark Markdown to HTML, returning a null-terminated, UTF-8-encoded string. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

main.lisp.

Function: node-append-child (node child) ¶

Adds CHILD to the end of the children of NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: node-first-child (node) ¶

Returns the first child of node, or NULL if node has no children.

Package

libcmark.

Source

tree-traversal.lisp.

Function: node-first-child (node) ¶

Returns the first child of NODE, or NIL if NODE has no children.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-get-end-column (node) ¶

Returns the column at which NODE ends.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-end-line (node) ¶

Returns the line on which NODE ends.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-fence-info (node) ¶

Returns the info string from a fenced code block.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-heading-level (node) ¶

Returns the heading level of NODE, or 0 if node is not a heading.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-list-delim (node) ¶

Returns the list delimiter type of NODE, or CMARK-NO-DELIM if node is not a list.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-list-start (node) ¶

Returns starting number of NODE, if it is an ordered list, otherwise 0.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-list-tight (node) ¶

Returns 1 if NODE is a tight list, 0 otherwise.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-list-type (node) ¶

Returns the list type of NODE, or :CMARK_NO_LIST if node is not a list.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-literal (node) ¶

Returns the string contents of NODE, or an empty string if none is set. Returns NULL if called on a node that does not have string content.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-on-enter (node) ¶

Returns the literal "on enter" text for a custom NODE, or an empty string if no on_enter is set. Returns NULL if called on a non-custom node.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-on-exit (node) ¶

Returns the literal "on exit" text for a custom node, or an empty string if no on_exit is set. Returns NULL if called on a non-custom node.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-start-column (node) ¶

Returns the column at which NODE begins.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-start-line (node) ¶

Returns the line on which NODE begins.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-title (node) ¶

Returns the title of a link or image NODE, or an empty string if no title is set. Returns NULL if called on a node that is not a link or image.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-type (node) ¶

Returns the type of node, or CMARK_NODE_NONE on error.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-type-string (node) ¶

Like NODE-GET-TYPE, but returns a string representation of the type, or "<unknown>".

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-url (node) ¶

Returns the URL of a link or image NODE, or an empty string if no URL is set. Returns NULL if called on a node that is not a link or image.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-get-user-data (node) ¶

Returns the user data of node.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-insert-after (node sibling) ¶

Inserts sibling after NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: node-insert-before (node sibling) ¶

Inserts sibling before NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: node-last-child (node) ¶

Returns the last child of node, or NULL if node has no children.

Package

libcmark.

Source

tree-traversal.lisp.

Function: node-last-child (node) ¶

Returns the last child of NODE, or NIL if NODE has no children.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-next (node) ¶

Returns the next node in the sequence after node, or NULL if there is none.

Package

libcmark.

Source

tree-traversal.lisp.

Function: node-next (node &optional child) ¶

Returns the next NODE in the tree, or NIL if there is none. The nodes are traversed in a depth-first manner. The CHILD parameter determines into which child node to descend.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-next-sibling (node) ¶

Returns the next sibling NODE, or NIL if NODE is the last child.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-parent (node) ¶

Returns the parent of node, or NULL if there is none.

Package

libcmark.

Source

tree-traversal.lisp.

Function: node-prepend-child (node child) ¶

Adds CHILD to the beginning of the children of NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: node-previous (node) ¶

Returns the previous node in the sequence after node, or NULL if there is none.

Package

libcmark.

Source

tree-traversal.lisp.

Function: node-previous (node) ¶

Returns the previous NODE in the sequence after NODE, or NIL if there is none.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-previous-sibling (node) ¶

Returns the next sibling NODE, or NIL if NODE is the last child.

Package

cmark.

Source

tree-traversal.lisp.

Function: node-replace (old-node new-node) ¶

Replaces OLD-NODE with NEW-NODE and unlinks oldnode (but does not free its memory). Returns 1 on success, 0 on failure.

Package

libcmark.

Source

tree-manipulation.lisp.

Function: node-set-fence-info (node info) ¶

Sets the info string in a fenced code block, returning 1 on success and ; 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-heading-level (node level) ¶

Sets the heading LEVEL of NODE, returning 1 on success and 0 on error.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-list-delim (node delim) ¶

Sets the list delimiter TYPE of NODE, returning 1 on success and 0 on error.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-list-start (node start) ¶

Sets STARTing number of NODE, if it is an ordered list. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-list-tight (node tight) ¶

Sets the "TIGHTness" of a list. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-list-type (node type) ¶

Sets the list type of node, returning 1 on success and 0 on error.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-literal (node content) ¶

Sets the string CONTENTS of NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-on-enter (node on-enter) ¶

Sets the literal text to render ON-ENTER for a custom NODE. Any children of the node will be rendered after this text. Returns 1 on success 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-on-exit (node on-exit) ¶

Sets the literal text to render ON-EXIT for a custom NODE. Any children of the node will be rendered before this text. Returns 1 on success 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-title (node title) ¶

Sets the TITLE of a link or image NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-url (node url) ¶

Sets the URL of a link or image NODE. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-set-user-data (node user-data) ¶

Sets arbitrary user data for node. Returns 1 on success, 0 on failure.

Package

libcmark.

Source

node-accessor.lisp.

Function: node-unlink (node) ¶

Unlinks a NODE, removing it from the tree, but not freeing its memory. (Use FREE-NODE for that.)

Package

libcmark.

Source

tree-manipulation.lisp.

Function: orphanp (node) ¶

Whether NODE is an orphan, meaning it has no parent node.

Package

cmark.

Source

node.lisp.

Function: parse-document (buffer len options) ¶

Parse a CommonMark document in BUFFER of length LEN. Returns a pointer to a tree of nodes. The memory allocated for the node tree should be released using cmark_node_free when it is no longer needed.

Package

libcmark.

Source

parsing.lisp.

Function: parse-document (document &key smart) ¶

Parses a CommonMark DOOCUMENT string and returns the root node of the parsed document tree.

Package

cmark.

Source

parsing.lisp.

Function: parse-file (file options) ¶

Parse a CommonMark document in file FILE, returning a pointer to a tree of nodes. The memory allocated for the node tree should be released using cmark_node_free when it is no longer needed.

Package

libcmark.

Source

parsing.lisp.

Function: parse-stream (input &key smart buffer-size) ¶

Parses an input stream stream until the end of the stream is encountered, returns the root node of the parsed document tree. The optional :BUFFER-SIZE parameter determines how many characters are read at a time.

Package

cmark.

Source

parsing.lisp.

Function: parser-feed (parser buffer len) ¶

Feeds a STRING of length LEN to parser.

Package

libcmark.

Source

parsing.lisp.

Function: parser-finish (parser) ¶

Finish parsing and return a pointer to a tree of nodes.

Package

libcmark.

Source

parsing.lisp.

Function: prepend-child-node (node child) ¶

Insert CHILD as the first child node of NODE. It is an error to prepend a node which is already a child of a node, signals UNEXPECTED-PARENT The following restarts are provided:
- DETACH-FROM-PARENT:
Detaches CHILD from its parent and thus from its original tree, then resumes the function.

Package

cmark.

Source

tree-manipulation.lisp.

Function: render-commonmark (root options width) ¶

Render a node tree as a commonmark document. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

rendering.lisp.

Function: render-html (root options) ¶

Render a node tree as an HTML fragment. It is up to the user to add an appropriate header and footer. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

rendering.lisp.

Function: render-latex (root options width) ¶

Render a node tree as a LaTeX document. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

rendering.lisp.

Function: render-man (root options width) ¶

Render a node tree as a groff man page, without the header. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

rendering.lisp.

Function: render-xml (root options) ¶

Render a node tree as XML. It is the caller’s responsibility to free the returned buffer.

Package

libcmark.

Source

rendering.lisp.

Function: replace-node (old-node new-node) ¶

Replaces OLD-NODE with NEW-NODE and unlinks OLD-NODE from the tree.

Package

cmark.

Source

tree-manipulation.lisp.

Function: unlink-node (node) ¶

Unlinks a NODE from its parent, removing it from the node tree. Returns the node. The function is idempotent, i.e. unlinking a node without parent does nothing.

Package

cmark.

Source

tree-manipulation.lisp.

Function: version () ¶

The library version as integer for runtime checks.

• Bits 16-23 contain the major version.
• Bits 8-15 contain the minor version.
• Bits 0-7 contain the patchlevel.

In hexadecimal format, the number 0x010203 represents version 1.2.3.

Package

libcmark.

Source

version.lisp.

Function: version-string () ¶

The library version string for runtime checks.

Package

libcmark.

Source

version.lisp.

Function: walk-tree (node callback) ¶

Iterate through the (sub)tree at NODE, calling CALLBACK at every event. The callback is a function which takes two arguments, the current node and the event type. Its return value is ignored.

Usually the callback would be a generic function that can dispatch on the class of node and type of event, but this is just a suggestion, not a requirement.

Package

cmark.

Source

iteration.lisp.

Function: which-child (node) ¶

Position of NODE among its siblings, or NIL if NODE is an orphan.

Package

cmark.

Source

tree-traversal.lisp.

---

6.1.4 Generic functions

Generic Function: block-node-p (node) ¶

Whether a node is a block-level node (as opposed to an inline node).

Package

cmark.

Source

node.lisp.

Methods

Method: block-node-p ((node node)) ¶

Method: block-node-p ((node block-node)) ¶

Generic Function: inline-node-p (node) ¶

Whether a node is an inline node (as opposed to a block-level node).

Package

cmark.

Source

node.lisp.

Methods

Method: inline-node-p ((node node)) ¶

Method: inline-node-p ((node inline-node)) ¶

Generic Function: leaf-node-p (node) ¶

Whether a node is a leaf-type node or not.

Package

cmark.

Source

node.lisp.

Methods

Method: leaf-node-p ((node node)) ¶

Method: leaf-node-p ((node parent-node)) ¶

Generic Function: node-children (node) ¶

List of children of a NODE.

Package

cmark.

Source

node.lisp.

Methods

Method: node-children ((node parent-node)) ¶

Method: node-children ((node node)) ¶

Generic Reader: node-heading-level (object) ¶

Generic Writer: (setf node-heading-level) (object) ¶

Package

cmark.

Methods

Reader Method: node-heading-level ((heading-node heading-node)) ¶

Writer Method: (setf node-heading-level) ((heading-node heading-node)) ¶

Level of the heading

Source

node.lisp.

Target Slot

level.

Generic Reader: node-list-delim (object) ¶

Generic Writer: (setf node-list-delim) (object) ¶

Package

cmark.

Methods

Reader Method: node-list-delim ((list-node list-node)) ¶

Writer Method: (setf node-list-delim) ((list-node list-node)) ¶

The delimiter type of the list

Source

node.lisp.

Target Slot

delim.

Generic Reader: node-list-start (object) ¶

Generic Writer: (setf node-list-start) (object) ¶

Package

cmark.

Methods

Reader Method: node-list-start ((list-node list-node)) ¶

Writer Method: (setf node-list-start) ((list-node list-node)) ¶

Starting number of the node (zero for unordered lists)

Source

node.lisp.

Target Slot

start.

Generic Reader: node-list-type (object) ¶

Generic Writer: (setf node-list-type) (object) ¶

Package

cmark.

Methods

Reader Method: node-list-type ((list-node list-node)) ¶

Writer Method: (setf node-list-type) ((list-node list-node)) ¶

The type of list

Source

node.lisp.

Target Slot

type.

Generic Reader: node-literal (object) ¶

Generic Writer: (setf node-literal) (object) ¶

Package

cmark.

Methods

Reader Method: node-literal ((html-inline-node html-inline-node)) ¶

Writer Method: (setf node-literal) ((html-inline-node html-inline-node)) ¶

Text of the node (might be empty).

Source

node.lisp.

Target Slot

literal.

Reader Method: node-literal ((code-node code-node)) ¶

Writer Method: (setf node-literal) ((code-node code-node)) ¶

Text of the node (might be empty).

Source

node.lisp.

Target Slot

literal.

Reader Method: node-literal ((text-node text-node)) ¶

Writer Method: (setf node-literal) ((text-node text-node)) ¶

Text of the node (might be empty).

Source

node.lisp.

Target Slot

literal.

Reader Method: node-literal ((html-block-node html-block-node)) ¶

Writer Method: (setf node-literal) ((html-block-node html-block-node)) ¶

Text of the node (might be empty).

Source

node.lisp.

Target Slot

literal.

Reader Method: node-literal ((code-block-node code-block-node)) ¶

Writer Method: (setf node-literal) ((code-block-node code-block-node)) ¶

Text of the node (might be empty).

Source

node.lisp.

Target Slot

literal.

Generic Function: node-parent (node) ¶

Parent node of NODE, or NIL if there is none.

Package

cmark.

Source

node.lisp.

Methods

Method: node-parent ((node child-node)) ¶

Method: node-parent ((node node)) ¶

Generic Reader: node-title (object) ¶

Generic Writer: (setf node-title) (object) ¶

Package

cmark.

Methods

Reader Method: node-title ((image-node image-node)) ¶

Writer Method: (setf node-title) ((image-node image-node)) ¶

Title of the node (empty if there is no title)

Source

node.lisp.

Target Slot

title.

Reader Method: node-title ((link-node link-node)) ¶

Writer Method: (setf node-title) ((link-node link-node)) ¶

Title of the node (empty if there is no title)

Source

node.lisp.

Target Slot

title.

Generic Reader: node-url (object) ¶

Generic Writer: (setf node-url) (object) ¶

Package

cmark.

Methods

Reader Method: node-url ((image-node image-node)) ¶

Writer Method: (setf node-url) ((image-node image-node)) ¶

URL of an image node

Source

node.lisp.

Target Slot

url.

Reader Method: node-url ((link-node link-node)) ¶

Writer Method: (setf node-url) ((link-node link-node)) ¶

URL of a link node

Source

node.lisp.

Target Slot

url.

---

6.1.5 Conditions

Condition: parser-exhausted ¶

Trying to manipulate an exhausted streaming parser.

Package

cmark.

Source

conditions.lisp.

Direct superclasses

simple-error.

Direct slots

Slot: parser ¶

The parser instance

Initargs

:parser

Slot: string ¶

String to parse

Package

common-lisp.

Initform

(quote nil)

Initargs

:string

Condition: unexpected-orphan ¶

Orphan node in a context where a child node is expected.

Package

cmark.

Source

conditions.lisp.

Direct superclasses

simple-error.

Direct slots

Slot: node ¶

The node in question

Initargs

:node

Condition: unexpected-parent ¶

Child node in a context where a orphan node is expected.

Package

cmark.

Source

conditions.lisp.

Direct superclasses

simple-error.

Direct slots

Slot: node ¶

The node in question

Initargs

:node

---

6.1.6 Classes

Class: block-quote-node ¶

Represents a block quotation.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Class: child-node ¶

A node which can have a parent node.

Package

cmark.

Source

node.lisp.

Direct superclasses

node.

Direct subclasses

• block-quote-node.
• code-block-node.
• code-node.
• custom-block-node.
• custom-inline-node.
• emph-node.
• heading-node.
• html-block-node.
• html-inline-node.
• image-node.
• item-node.
• linebreak-node.
• link-node.
• list-node.
• paragraph-node.
• softbreak-node.
• strong-node.
• text-node.
• thematic-break-node.

Direct methods

node-parent.

Direct slots

Slot: parent ¶

Parent node of this node, or NIL if this is a root node

Type

(or cmark:node null)

Initargs

:parent

Class: code-block-node ¶

A block of code to present verbatim.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.

Direct methods

• (setf node-fence-info).
• node-fence-info.
• (setf node-literal).
• node-literal.

Direct slots

Slot: fence-info ¶

Info string from a fenced code block

Type

string

Initargs

:fence-info

Readers

node-fence-info.

Writers

(setf node-fence-info).

Slot: literal ¶

Text of the node (might be empty).

Type

(or string null)

Initargs

:literal

Readers

node-literal.

Writers

(setf node-literal).

Class: code-node ¶

Inline verbatim code.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.

Direct methods

• (setf node-literal).
• node-literal.

Direct slots

Slot: literal ¶

Text of the node (might be empty).

Type

(or string null)

Initargs

:literal

Readers

node-literal.

Writers

(setf node-literal).

Class: custom-block-node ¶

A user-defined node which produces custom text.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Direct methods

• (setf node-on-enter).
• node-on-enter.
• (setf node-on-exit).
• node-on-exit.

Direct slots

Slot: on-enter ¶

Literal text to render on entering a custom node

Type

string

Initargs

:on-enter

Readers

node-on-enter.

Writers

(setf node-on-enter).

Slot: on-exit ¶

Literal text to render on exiting a custom node

Type

string

Initargs

:on-exit

Readers

node-on-exit.

Writers

(setf node-on-exit).

Class: custom-inline-node ¶

A user-defined node which produces custom text.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.
• parent-node.

Direct methods

• (setf node-on-enter).
• node-on-enter.
• (setf node-on-exit).
• node-on-exit.

Direct slots

Slot: on-enter ¶

Literal text to render on entering a custom node

Type

string

Initargs

:on-enter

Readers

node-on-enter.

Writers

(setf node-on-enter).

Slot: on-exit ¶

Literal text to render on exiting a custom node

Type

string

Initargs

:on-exit

Readers

node-on-exit.

Writers

(setf node-on-exit).

Class: document-node ¶

Root node of the entire document.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• parent-node.

Class: emph-node ¶

Container for emphatic text.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.
• parent-node.

Class: heading-node ¶

A heading with variable level.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Direct methods

• (setf node-heading-level).
• node-heading-level.

Direct slots

Slot: level ¶

Level of the heading

Type

(integer 1 6)

Initargs

:level

Readers

node-heading-level.

Writers

(setf node-heading-level).

Class: html-block-node ¶

Block-level embedded HTML code.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.

Direct methods

• (setf node-literal).
• node-literal.

Direct slots

Slot: literal ¶

Text of the node (might be empty).

Type

(or string null)

Initargs

:literal

Readers

node-literal.

Writers

(setf node-literal).

Class: html-inline-node ¶

Inline embedded HTML code.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.

Direct methods

• (setf node-literal).
• node-literal.

Direct slots

Slot: literal ¶

Text of the node (might be empty).

Type

(or string null)

Initargs

:literal

Readers

node-literal.

Writers

(setf node-literal).

Class: image-node ¶

Hyperlink with target URL and alt-text.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.
• parent-node.

Direct methods

• (setf node-title).
• node-title.
• (setf node-url).
• node-url.

Direct slots

Slot: url ¶

URL of an image node

Type

string

Initargs

:url

Readers

node-url.

Writers

(setf node-url).

Slot: title ¶

Title of the node (empty if there is no title)

Type

string

Initargs

:title

Readers

node-title.

Writers

(setf node-title).

Class: item-node ¶

Represents an item inside a list (bullet or unordered).

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Class: linebreak-node ¶

A hard line break which does not terminate the current block level element.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.

Class: link-node ¶

Hyperlink with target URL and title.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.
• parent-node.

Direct methods

• (setf node-title).
• node-title.
• (setf node-url).
• node-url.

Direct slots

Slot: url ¶

URL of a link node

Type

string

Initargs

:url

Readers

node-url.

Writers

(setf node-url).

Slot: title ¶

Title of the node (empty if there is no title)

Type

string

Initargs

:title

Readers

node-title.

Writers

(setf node-title).

Class: list-node ¶

A list node, it can be either an unordered list (:BULLET-LIST) or an :ORDERED-LIST.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Direct methods

• (setf node-list-delim).
• node-list-delim.
• (setf node-list-start).
• node-list-start.
• (setf node-list-tight-p).
• node-list-tight-p.
• (setf node-list-type).
• node-list-type.

Direct slots

Slot: type ¶

The type of list

Package

common-lisp.

Type

(member :cmark-bullet-list :cmark-ordered-list)

Initargs

:type

Readers

node-list-type.

Writers

(setf node-list-type).

Slot: delim ¶

The delimiter type of the list

Type

(member :period :paren)

Initargs

:delim

Readers

node-list-delim.

Writers

(setf node-list-delim).

Slot: start ¶

Starting number of the node (zero for unordered lists)

Type

(integer 0 *)

Initargs

:start

Readers

node-list-start.

Writers

(setf node-list-start).

Slot: tightp ¶

Whether the node is a tight list

Type

boolean

Initargs

:tightp

Readers

node-list-tight-p.

Writers

(setf node-list-tight-p).

Class: node ¶

Base class of all cmark nodes.

Package

cmark.

Source

node.lisp.

Direct subclasses

• child-node.
• parent-node.

Direct methods

• block-node-p.
• inline-node-p.
• leaf-node-p.
• node-children.
• node-end-column.
• node-end-line.
• node-parent.
• node-start-column.
• node-start-line.
• (setf node-user-data).
• node-user-data.

Direct slots

Slot: user-data ¶

User data of the node

Type

integer

Initargs

:user-data

Readers

node-user-data.

Writers

(setf node-user-data).

Slot: start-line ¶

Line at which the node begins

Type

(integer 0 *)

Initargs

:start-line

Readers

node-start-line.

Writers

This slot is read-only.

Slot: start-column ¶

Column at which the node begins

Type

(integer 0 *)

Initargs

:start-column

Readers

node-start-column.

Writers

This slot is read-only.

Slot: end-line ¶

Line at which the node ends

Type

(integer 0 *)

Initargs

:end-line

Readers

node-end-line.

Writers

This slot is read-only.

Slot: end-column ¶

Column at which the node ends

Type

(integer 0 *)

Initargs

:end-column

Readers

node-end-column.

Writers

This slot is read-only.

Class: paragraph-node ¶

A paragraph of the document.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.
• parent-node.

Class: parent-node ¶

A node which can have child nodes.

Package

cmark.

Source

node.lisp.

Direct superclasses

node.

Direct subclasses

• block-quote-node.
• custom-block-node.
• custom-inline-node.
• document-node.
• emph-node.
• heading-node.
• image-node.
• item-node.
• link-node.
• list-node.
• paragraph-node.
• strong-node.

Direct methods

• leaf-node-p.
• node-children.

Direct slots

Slot: children ¶

All child nodes of this node

Type

list

Initargs

:children

Class: softbreak-node ¶

A line break which may be rendered differently depending on the rendering options.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.

Class: strong-node ¶

Container for strong text.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.
• parent-node.

Class: text-node ¶

Plain text content.

Package

cmark.

Source

node.lisp.

Direct superclasses

• child-node.
• inline-node.

Direct methods

• (setf node-literal).
• node-literal.

Direct slots

Slot: literal ¶

Text of the node (might be empty).

Type

(or string null)

Initargs

:literal

Readers

node-literal.

Writers

(setf node-literal).

Class: thematic-break-node ¶

Represents a thematic break within the content of the document.

Package

cmark.

Source

node.lisp.

Direct superclasses

• block-node.
• child-node.

---