File: org-element.el.html
See <https://orgmode.org/worg/dev/org-syntax.html> for details about Org syntax.
Lisp-wise, a syntax object can be represented as a list.
It follows the pattern (TYPE PROPERTIES CONTENTS), where:
TYPE is a symbol describing the object.
PROPERTIES is the property list attached to it. See docstring of
appropriate parsing function to get an exhaustive list.
CONTENTS is a list of syntax objects or raw strings contained
in the current object, when applicable.
For the whole document, TYPE is org-data and PROPERTIES is nil.
The first part of this file defines constants for the Org syntax, while the second one provide accessors and setters functions.
The next part implements a parser and an interpreter for each element and object type in Org syntax.
The following part creates a fully recursive buffer parser. It
also provides a tool to map a function to elements or objects
matching some criteria in the parse tree. Functions of interest
are org-element-parse-buffer, org-element-map and, to a lesser
extent, org-element-parse-secondary-string.
The penultimate part is the cradle of an interpreter for the
obtained parse tree: org-element-interpret-data.
The library ends by furnishing org-element-at-point function, and
a way to give information about document structure around point
with org-element-context. A cache mechanism is also provided for
these functions.
Defined variables (73)
org-element--affiliated-re | Regexp matching any affiliated keyword. |
org-element--cache | AVL tree used to cache elements. |
org-element--cache-avoid-synchronous-headline-re-parsing | This variable controls how buffer changes are handled by the cache. |
org-element--cache-change-tic | Last ‘buffer-chars-modified-tick’ for registered changes. |
org-element--cache-change-warning | Non-nil when a sensitive line is about to be changed. |
org-element--cache-diagnostics | Print detailed diagnostics of cache processing. |
org-element--cache-diagnostics-level | Detail level of the diagnostics. |
org-element--cache-diagnostics-ring | Ring containing last ‘org-element--cache-diagnostics-ring-size’ |
org-element--cache-diagnostics-ring-size | Size of ‘org-element--cache-diagnostics-ring’. |
org-element--cache-element-properties | List of element properties used internally by cache. |
org-element--cache-gapless | An alist containing (granularity . ‘org-element--cache-change-tic’) elements. |
org-element--cache-hash-left | Cached elements from ‘org-element--cache’ for fast O(1) lookup. |
org-element--cache-hash-nocache | Number of calls to ‘org-element--cache-has’ with ‘both’ SIDE argument. |
org-element--cache-hash-right | Cached elements from ‘org-element--cache’ for fast O(1) lookup. |
org-element--cache-hash-size | Cache size for recent cached calls to ‘org-element--cache-find’. |
org-element--cache-hash-statistics | Cons cell storing how Org makes use of ‘org-element--cache-find’ caching. |
org-element--cache-interrupt-C-g | When non-nil, allow the user to abort ‘org-element--cache-sync’. |
org-element--cache-interrupt-C-g-count | Current number of ‘org-element--cache-sync’ calls. |
org-element--cache-interrupt-C-g-max-count | ‘C-g’ count to interrupt ‘org-element--cache-sync’. |
org-element--cache-last-buffer-size | Last value of ‘buffer-size’ for registered changes. |
org-element--cache-map-statistics | Print statistics for ‘org-element-cache-map’. |
org-element--cache-map-statistics-threshold | Time threshold in seconds to log statistics for ‘org-element-cache-map’. |
org-element--cache-non-modifying-commands | List of commands that are not expected to change the cache state. |
org-element--cache-self-verify | Activate extra consistency checks for the cache. |
org-element--cache-self-verify-frequency | Frequency of cache element verification. |
org-element--cache-sensitive-re | Regexp matching a sensitive line, structure wise. |
org-element--cache-size | Size of the ‘org-element--cache’. |
org-element--cache-sync-keys-value | Id value used to identify keys during synchronization. |
org-element--cache-sync-requests | List of pending synchronization requests. |
org-element--cache-sync-timer | Timer used for cache synchronization. |
org-element--footnote-separator | Regexp used as a footnote definition separator. |
org-element--headline-cache | AVL tree used to cache headline and inlinetask elements. |
org-element--headline-cache-size | Size of the ‘org-element--headline-cache’. |
org-element--latex-begin-environment | Regexp matching the beginning of a LaTeX environment. |
org-element--latex-end-environment | Format string matching the ending of a LaTeX environment. |
org-element--object-regexp | Regexp possibly matching the beginning of an object. |
org-element--pair-curly-table | Table used internally to pair only curly brackets. |
org-element--pair-round-table | Table used internally to pair only round brackets. |
org-element--pair-square-table | Table used internally to pair only square brackets. |
org-element--parsed-properties-alist | Alist of parsed keywords and associated properties. |
org-element--timestamp-regexp | Regexp matching any timestamp type object. |
org-element-affiliated-keywords | List of affiliated keywords as strings. |
org-element-all-elements | Complete list of element types. |
org-element-all-objects | Complete list of object types. |
org-element-archive-tag | Tag marking a substree as archived. |
org-element-cache-map-continue-from | Position from where mapping should continue. |
org-element-cache-persistent | Non-nil when cache should persist between Emacs sessions. |
org-element-cache-sync-break | Duration, as a time value, of the pause between synchronizations. |
org-element-cache-sync-duration | Maximum duration, as a time value, for a cache synchronization. |
org-element-cache-sync-idle-time | Length, in seconds, of idle time before syncing cache. |
org-element-citation-key-re | Regexp matching a citation key. |
org-element-citation-prefix-re | Regexp matching a citation prefix. |
org-element-clock-line-re | Regexp matching a clock line. |
org-element-closed-keyword | Keyword used to close TODO entries. |
org-element-comment-string | String marker for commented headlines. |
org-element-deadline-keyword | Keyword used to mark deadline entries. |
org-element-drawer-re | Regexp matching opening or closing line of a drawer. |
org-element-dual-keywords | List of affiliated keywords which can have a secondary value. |
org-element-dynamic-block-open-re | Regexp matching the opening line of a dynamic block. |
org-element-greater-elements | List of recursive element types aka Greater Elements. |
org-element-headline-re | Regexp matching a headline. |
org-element-keyword-translation-alist | Alist of usual translations for keywords. |
org-element-multiple-keywords | List of affiliated keywords that can occur more than once in an element. |
org-element-object-containers | List of object or element types that can directly contain objects. |
org-element-object-restrictions | Alist of objects restrictions. |
org-element-paragraph-separate | Regexp to separate paragraphs in an Org buffer. |
org-element-parsed-keywords | List of affiliated keywords whose value can be parsed. |
org-element-planning-keywords-re | Regexp matching any planning line keyword. |
org-element-planning-line-re | Regexp matching a planning line. |
org-element-recursive-objects | List of recursive object types. |
org-element-scheduled-keyword | Keyword used to mark scheduled entries. |
org-element-secondary-value-alist | Alist between element types and locations of secondary values. |
org-element-use-cache | Non-nil when Org parser should cache its results. |