| blob | 269bc7d8057c8669550593aedf3e4ecdfc758cc3 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 "Parse paired brackets at point.
426 CHAR is the opening bracket to consider, as a character. Return
427 contents between brackets, as a string, or nil. Also move point
428 past the brackets."
443 \f
444 ;;; Accessors and Setters
445 ;;
446 ;; Provide four accessors: `org-element-type', `org-element-property'
447 ;; `org-element-contents' and `org-element-restriction'.
448 ;;
449 ;; Setter functions allow modification of elements by side effect.
450 ;; There is `org-element-put-property', `org-element-set-contents'.
451 ;; These low-level functions are useful to build a parse tree.
452 ;;
453 ;; `org-element-adopt-element', `org-element-set-element',
454 ;; `org-element-extract-element' and `org-element-insert-before' are
455 ;; high-level functions useful to modify a parse tree.
456 ;;
457 ;; `org-element-secondary-p' is a predicate used to know if a given
458 ;; object belongs to a secondary string. `org-element-copy' returns
459 ;; an element or object, stripping its parent property in the process.
462 "Return type of ELEMENT.
464 The function returns the type of the element or object provided.
465 It can also return the following special value:
466 `plain-text' for a string
467 `org-data' for a complete document
468 nil in any other case."
474 "Extract the value from the PROPERTY of an ELEMENT."
479 "Extract contents from an ELEMENT."
485 "Return restriction associated to ELEMENT.
486 ELEMENT can be an element, an object or a symbol representing an
487 element or object type."
489 org-element-object-restrictions)))
492 "In ELEMENT set PROPERTY to VALUE.
493 Return modified element."
496 element))
499 "Set ELEMENT's contents to CONTENTS.
500 Return ELEMENT."
507 "Non-nil when OBJECT directly belongs to a secondary string.
508 Return value is the property name, as a keyword, or nil."
511 org-element-secondary-value-alist))))
518 "Append elements to the contents of another element.
520 PARENT is an element or object. CHILDREN can be elements,
521 objects, or a strings.
523 The function takes care of setting `:parent' property for CHILD.
524 Return parent element."
526 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
527 ;; string: parent is the list itself.
530 ;; Add CHILDREN at the end of PARENT contents.
533 parent
535 ;; Return modified PARENT element.
539 "Extract ELEMENT from parse tree.
540 Remove element from the parse tree by side-effect, and return it
541 with its `:parent' property stripped out."
546 parent secondary
549 parent
551 ;; Return ELEMENT with its :parent removed.
555 "Insert ELEMENT before LOCATION in parse tree.
556 LOCATION is an element, object or string within the parse tree.
557 Parse tree is modified by side effect."
562 ;; Special case: LOCATION is the first element of an
563 ;; independent secondary string (e.g. :title property). Add
564 ;; ELEMENT in-place.
568 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
578 ;; Store SIBLINGS at appropriate place in parse tree.
583 ;; Set appropriate :parent property.
587 "Replace element or object OLD with element or object NEW.
588 The function takes care of setting `:parent' property for NEW."
589 ;; Ensure OLD and NEW have the same parent.
593 ;; We cannot replace OLD with NEW since one of them is not an
594 ;; object or element. We take the long path.
597 ;; Since OLD is going to be changed into NEW by side-effect, first
598 ;; make sure that every element or object within NEW has OLD as
599 ;; parent.
602 ;; Transfer contents.
604 ;; Overwrite OLD's properties with NEW's.
606 ;; Transfer type.
610 "Create a new element of type TYPE.
611 Optional argument PROPS, when non-nil, is a plist defining the
612 properties of the element. CHILDREN can be elements, objects or
613 strings."
617 "Return a copy of DATUM.
618 DATUM is an element, object, string or nil. `:parent' property
619 is cleared and contents are removed in the process."
630 \f
631 ;;; Greater elements
632 ;;
633 ;; For each greater element type, we define a parser and an
634 ;; interpreter.
635 ;;
636 ;; A parser returns the element or object as the list described above.
637 ;; Most of them accepts no argument. Though, exceptions exist. Hence
638 ;; every element containing a secondary string (see
639 ;; `org-element-secondary-value-alist') will accept an optional
640 ;; argument to toggle parsing of these secondary strings. Moreover,
641 ;; `item' parser requires current list's structure as its first
642 ;; element.
643 ;;
644 ;; An interpreter accepts two arguments: the list representation of
645 ;; the element or object, and its contents. The latter may be nil,
646 ;; depending on the element or object considered. It returns the
647 ;; appropriate Org syntax, as a string.
648 ;;
649 ;; Parsing functions must follow the naming convention:
650 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
651 ;; defined in `org-element-greater-elements'.
652 ;;
653 ;; Similarly, interpreting functions must follow the naming
654 ;; convention: org-element-TYPE-interpreter.
655 ;;
656 ;; With the exception of `headline' and `item' types, greater elements
657 ;; cannot contain other greater elements of their own type.
658 ;;
659 ;; Beside implementing a parser and an interpreter, adding a new
660 ;; greater element requires tweaking `org-element--current-element'.
661 ;; Moreover, the newly defined type must be added to both
662 ;; `org-element-all-elements' and `org-element-greater-elements'.
665 ;;;; Center Block
668 "Parse a center block.
670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
671 the buffer position at the beginning of the first affiliated
672 keyword and CDR is a plist of affiliated keywords along with
673 their value.
675 Return a list whose CAR is `center-block' and CDR is a plist
676 containing `:begin', `:end', `:contents-begin', `:contents-end',
677 `:post-blank' and `:post-affiliated' keywords.
679 Assume point is at the beginning of the block."
683 ;; Incomplete block: parse it as a paragraph.
688 ;; Empty blocks have no contents.
702 :end end
703 :contents-begin contents-begin
704 :contents-end contents-end
710 "Interpret a center-block element as Org syntax.
711 CONTENTS is the contents of the element."
715 ;;;; Drawer
718 "Parse a drawer.
720 LIMIT bounds the search. AFFILIATED is a list of which CAR is
721 the buffer position at the beginning of the first affiliated
722 keyword and CDR is a plist of affiliated keywords along with
723 their value.
725 Return a list whose CAR is `drawer' and CDR is a plist containing
726 `:drawer-name', `:begin', `:end', `:contents-begin',
727 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
729 Assume point is at beginning of drawer."
732 ;; Incomplete drawer: parse it as a paragraph.
740 ;; Empty drawers have no contents.
753 :end end
754 :drawer-name name
755 :contents-begin contents-begin
756 :contents-end contents-end
762 "Interpret DRAWER element as Org syntax.
763 CONTENTS is the contents of the element."
766 contents))
769 ;;;; Dynamic Block
772 "Parse a dynamic block.
774 LIMIT bounds the search. AFFILIATED is a list of which CAR is
775 the buffer position at the beginning of the first affiliated
776 keyword and CDR is a plist of affiliated keywords along with
777 their value.
779 Return a list whose CAR is `dynamic-block' and CDR is a plist
780 containing `:block-name', `:begin', `:end', `:contents-begin',
781 `:contents-end', `:arguments', `:post-blank' and
782 `:post-affiliated' keywords.
784 Assume point is at beginning of dynamic block."
788 ;; Incomplete block: parse it as a paragraph.
797 ;; Empty blocks have no contents.
810 :end end
811 :block-name name
812 :arguments arguments
813 :contents-begin contents-begin
814 :contents-end contents-end
820 "Interpret DYNAMIC-BLOCK element as Org syntax.
821 CONTENTS is the contents of the element."
826 contents))
829 ;;;; Footnote Definition
838 "Parse a footnote definition.
840 LIMIT bounds the search. AFFILIATED is a list of which CAR is
841 the buffer position at the beginning of the first affiliated
842 keyword and CDR is a plist of affiliated keywords along with
843 their value.
845 Return a list whose CAR is `footnote-definition' and CDR is
846 a plist containing `:label', `:begin' `:end', `:contents-begin',
847 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
849 Assume point is at the beginning of the footnote definition."
861 limit)
863 ;; At a new footnote definition, make sure we end
864 ;; before any affiliated keyword above.
885 :begin begin
886 :end end
887 :contents-begin contents-begin
888 :contents-end contents-end
894 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
895 CONTENTS is the contents of the footnote-definition."
897 " "
898 contents))
901 ;;;; Headline
904 "Return node properties associated to headline at point.
905 Upcase property names. It avoids confusion between properties
906 obtained through property drawer and default properties from the
907 parser (e.g. `:end' and :END:). Return value is a plist."
919 properties))))
922 "Return time properties associated to headline at point.
923 Return value is a plist."
937 plist))))
940 "Parse a headline.
942 Return a list whose CAR is `headline' and CDR is a plist
943 containing `:raw-value', `:title', `:begin', `:end',
944 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
945 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
946 `:deadline', `:closed', `:archivedp', `:commentedp'
947 `:footnote-section-p', `:post-blank' and `:post-affiliated'
948 keywords.
950 The plist also contains any property set in the property drawer,
951 with its name in upper cases and colons added at the
952 beginning (e.g., `:CUSTOM_ID').
954 LIMIT is a buffer position bounding the search.
956 When RAW-SECONDARY-P is non-nil, headline's title will not be
957 parsed as a secondary string, but as a plain string instead.
959 Assume point is at beginning of the headline."
1006 :begin begin
1007 :end end
1008 :pre-blank
1011 :contents-begin contents-begin
1012 :contents-end contents-end
1013 :level level
1014 :priority priority
1015 :tags tags
1016 :todo-keyword todo
1017 :todo-type todo-type
1020 end)
1021 :footnote-section-p footnote-section-p
1022 :archivedp archivedp
1023 :commentedp commentedp
1025 time-props
1026 standard-props))))
1028 headline :title
1037 nil
1039 headline)))))))
1042 "Interpret HEADLINE element as Org syntax.
1043 CONTENTS is the contents of the element."
1056 ?*)
1060 " "
1063 org-footnote-section
1064 title))))
1066 heading
1067 ;; Align tags.
1075 ?\s)
1076 tags))
1080 tags))))
1082 contents)))
1085 ;;;; Inlinetask
1088 "Parse an inline task.
1090 Return a list whose CAR is `inlinetask' and CDR is a plist
1091 containing `:title', `:begin', `:end', `:contents-begin' and
1092 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1093 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1094 `:closed', `:post-blank' and `:post-affiliated' keywords.
1096 The plist also contains any property set in the property drawer,
1097 with its name in upper cases and colons added at the
1098 beginning (e.g., `:CUSTOM_ID').
1100 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1101 title will not be parsed as a secondary string, but as a plain
1102 string instead.
1104 Assume point is at beginning of the inline task."
1149 :begin begin
1150 :end end
1151 :contents-begin contents-begin
1152 :contents-end contents-end
1153 :level level
1154 :priority priority
1155 :tags tags
1156 :todo-keyword todo
1157 :todo-type todo-type
1160 time-props
1161 standard-props))))
1163 inlinetask :title
1172 nil
1174 inlinetask))))))
1177 "Interpret INLINETASK element as Org syntax.
1178 CONTENTS is the contents of inlinetask."
1192 ;; Align tags.
1200 ? )
1201 tags))
1205 tags))))
1206 ;; Prefer degenerate inlinetasks when there are no
1207 ;; contents.
1210 contents
1214 ;;;; Item
1217 "Parse an item.
1219 STRUCT is the structure of the plain list.
1221 Return a list whose CAR is `item' and CDR is a plist containing
1222 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1223 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1224 `:post-affiliated' keywords.
1226 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1227 any, will not be parsed as a secondary string, but as a plain
1228 string instead.
1230 Assume point is at the beginning of the item."
1253 ;; Ignore tags in un-ordered lists: they are just
1254 ;; a part of item's body.
1261 ;; If first line isn't empty, contents really
1262 ;; start at the text after item's meta-data.
1272 :begin begin
1273 :end end
1274 :contents-begin contents-begin
1275 :contents-end contents-end
1276 :checkbox checkbox
1277 :counter counter
1278 :structure struct
1282 item :tag
1289 item))))))))
1292 "Interpret ITEM element as Org syntax.
1293 CONTENTS is the contents of the element."
1303 ;; Compute indentation.
1308 ;; Indent contents.
1310 bullet
1325 ;;;; Plain List
1328 ;; Return structure of list at point. Internal function. See
1329 ;; `org-list-struct' for details.
1334 items struct)
1339 ;; At limit: end all items.
1348 ;; At list end: end all items.
1353 ;; At a new item: end previous sibling.
1365 ind
1366 bullet
1369 ;; Description tag.
1373 ;; Ending position, unknown so far.
1374 nil)))
1375 items))
1377 ;; Skip empty lines.
1379 ;; Skip inline tasks and blank lines along the way.
1386 ;; At some text line. Check if it ends any previous item.
1399 ;; Skip blocks (any type) and drawers contents.
1404 limit t)))
1410 "Parse a plain list.
1412 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1413 the buffer position at the beginning of the first affiliated
1414 keyword and CDR is a plist of affiliated keywords along with
1415 their value. STRUCTURE is the structure of the plain list being
1416 parsed.
1418 Return a list whose CAR is `plain-list' and CDR is a plist
1419 containing `:type', `:begin', `:end', `:contents-begin' and
1420 `:contents-end', `:structure', `:post-blank' and
1421 `:post-affiliated' keywords.
1423 Assume point is at the beginning of the list."
1437 pos))
1441 ;; Return value.
1445 :begin begin
1446 :end end
1447 :contents-begin contents-begin
1448 :contents-end contents-end
1449 :structure struct
1455 "Interpret plain-list element as Org syntax.
1456 CONTENTS is the contents of the element."
1464 ;;;; Property Drawer
1467 "Parse a property drawer.
1469 LIMIT bounds the search.
1471 Return a list whose car is `property-drawer' and cdr is a plist
1472 containing `:begin', `:end', `:contents-begin', `:contents-end',
1473 `:post-blank' and `:post-affiliated' keywords.
1475 Assume point is at the beginning of the property drawer."
1488 :end end
1490 :contents-end contents-end
1495 "Interpret property-drawer element as Org syntax.
1496 CONTENTS is the properties within the drawer."
1500 ;;;; Quote Block
1503 "Parse a quote block.
1505 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1506 the buffer position at the beginning of the first affiliated
1507 keyword and CDR is a plist of affiliated keywords along with
1508 their value.
1510 Return a list whose CAR is `quote-block' and CDR is a plist
1511 containing `:begin', `:end', `:contents-begin', `:contents-end',
1512 `:post-blank' and `:post-affiliated' keywords.
1514 Assume point is at the beginning of the block."
1518 ;; Incomplete block: parse it as a paragraph.
1524 ;; Empty blocks have no contents.
1537 :end end
1538 :contents-begin contents-begin
1539 :contents-end contents-end
1545 "Interpret quote-block element as Org syntax.
1546 CONTENTS is the contents of the element."
1550 ;;;; Section
1553 "Parse a section.
1555 Return a list whose CAR is `section' and CDR is a plist
1556 containing `:begin', `:end', `:contents-begin', `contents-end',
1557 `:post-blank' and `:post-affiliated' keywords."
1559 ;; Beginning of section is the beginning of the first non-blank
1560 ;; line after previous headline.
1568 :end end
1569 :contents-begin begin
1570 :contents-end pos-before-blank
1575 "Interpret section element as Org syntax.
1576 CONTENTS is the contents of the element."
1577 contents)
1580 ;;;; Special Block
1583 "Parse a special block.
1585 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1586 the buffer position at the beginning of the first affiliated
1587 keyword and CDR is a plist of affiliated keywords along with
1588 their value.
1590 Return a list whose CAR is `special-block' and CDR is a plist
1591 containing `:type', `:begin', `:end', `:contents-begin',
1592 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1594 Assume point is at the beginning of the block."
1601 limit t)))
1602 ;; Incomplete block: parse it as a paragraph.
1608 ;; Empty blocks have no contents.
1621 :begin begin
1622 :end end
1623 :contents-begin contents-begin
1624 :contents-end contents-end
1630 "Interpret SPECIAL-BLOCK element as Org syntax.
1631 CONTENTS is the contents of the element."
1636 \f
1637 ;;; Elements
1638 ;;
1639 ;; For each element, a parser and an interpreter are also defined.
1640 ;; Both follow the same naming convention used for greater elements.
1641 ;;
1642 ;; Also, as for greater elements, adding a new element type is done
1643 ;; through the following steps: implement a parser and an interpreter,
1644 ;; tweak `org-element--current-element' so that it recognizes the new
1645 ;; type and add that new type to `org-element-all-elements'.
1648 ;;;; Babel Call
1651 "Parse a babel call.
1653 LIMIT bounds the search. AFFILIATED is a list of which car is
1654 the buffer position at the beginning of the first affiliated
1655 keyword and cdr is a plist of affiliated keywords along with
1656 their value.
1658 Return a list whose car is `babel-call' and cdr is a plist
1659 containing `:call', `:inside-header', `:arguments',
1660 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1661 `:post-affiliated' as keywords."
1675 value)))
1685 :begin begin
1686 :end end
1687 :value value
1693 "Interpret BABEL-CALL element as Org syntax."
1703 ;;;; Clock
1706 "Parse a clock.
1708 LIMIT bounds the search.
1710 Return a list whose CAR is `clock' and CDR is a plist containing
1711 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1712 `:post-affiliated' as keywords."
1732 :value value
1733 :duration duration
1734 :begin begin
1735 :end end
1736 :post-blank post-blank
1740 "Interpret CLOCK element as Org syntax."
1748 "%2s:%02s"
1752 ;;;; Comment
1755 "Parse a comment.
1757 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1758 the buffer position at the beginning of the first affiliated
1759 keyword and CDR is a plist of affiliated keywords along with
1760 their value.
1762 Return a list whose CAR is `comment' and CDR is a plist
1763 containing `:begin', `:end', `:value', `:post-blank',
1764 `:post-affiliated' keywords.
1766 Assume point is at comment beginning."
1775 ;; Get comments ending.
1778 ;; Accumulate lines without leading hash and first
1779 ;; whitespace.
1793 :end end
1794 :value value
1800 "Interpret COMMENT element as Org syntax.
1801 CONTENTS is nil."
1805 ;;;; Comment Block
1808 "Parse an export block.
1810 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1811 the buffer position at the beginning of the first affiliated
1812 keyword and CDR is a plist of affiliated keywords along with
1813 their value.
1815 Return a list whose CAR is `comment-block' and CDR is a plist
1816 containing `:begin', `:end', `:value', `:post-blank' and
1817 `:post-affiliated' keywords.
1819 Assume point is at comment block beginning."
1823 ;; Incomplete block: parse it as a paragraph.
1836 contents-begin contents-end)))
1840 :end end
1841 :value value
1847 "Interpret COMMENT-BLOCK element as Org syntax."
1854 ;;;; Diary Sexp
1857 "Parse a diary sexp.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1862 their value.
1864 Return a list whose CAR is `diary-sexp' and CDR is a plist
1865 containing `:begin', `:end', `:value', `:post-blank' and
1866 `:post-affiliated' keywords."
1878 :begin begin
1879 :end end
1885 "Interpret DIARY-SEXP as Org syntax."
1889 ;;;; Example Block
1892 "Parse an example block.
1894 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1895 the buffer position at the beginning of the first affiliated
1896 keyword and CDR is a plist of affiliated keywords along with
1897 their value.
1899 Return a list whose CAR is `example-block' and CDR is a plist
1900 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1901 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1902 `:value', `:post-blank' and `:post-affiliated' keywords."
1906 ;; Incomplete block: parse it as a paragraph.
1914 ;; Switches analysis.
1918 switches)
1921 'new
1924 ;; Subtract 1 to give number of lines before
1925 ;; first line.
1929 ;; Should labels be retained in (or stripped from) example
1930 ;; blocks?
1935 ;; What should code-references use - labels or
1936 ;; line-numbers?
1945 ;; Standard block parsing.
1951 contents-begin contents-end)))
1960 :end end
1961 :value value
1962 :switches switches
1963 :number-lines number-lines
1964 :preserve-indent preserve-indent
1965 :retain-labels retain-labels
1966 :use-labels use-labels
1967 :label-fmt label-fmt
1973 "Interpret EXAMPLE-BLOCK element as Org syntax."
1981 value
1986 ;;;; Export Block
1989 "Parse an export block.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `export-block' and CDR is a plist
1997 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1998 `:post-affiliated' keywords.
2000 Assume point is at export-block beginning."
2004 ;; Incomplete block: parse it as a paragraph.
2023 contents-end))))
2027 :begin begin
2028 :end end
2029 :value value
2035 "Interpret EXPORT-BLOCK element as Org syntax."
2041 ;;;; Fixed-width
2044 "Parse a fixed-width section.
2046 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2047 the buffer position at the beginning of the first affiliated
2048 keyword and CDR is a plist of affiliated keywords along with
2049 their value.
2051 Return a list whose CAR is `fixed-width' and CDR is a plist
2052 containing `:begin', `:end', `:value', `:post-blank' and
2053 `:post-affiliated' keywords.
2055 Assume point is at the beginning of the fixed-width area."
2059 value
2064 ;; Accumulate text without starting colons.
2077 :end end
2078 :value value
2084 "Interpret FIXED-WIDTH element as Org syntax."
2092 ;;;; Horizontal Rule
2095 "Parse an horizontal rule.
2097 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2098 the buffer position at the beginning of the first affiliated
2099 keyword and CDR is a plist of affiliated keywords along with
2100 their value.
2102 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2103 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2104 keywords."
2114 :end end
2120 "Interpret HORIZONTAL-RULE element as Org syntax."
2124 ;;;; Keyword
2127 "Parse a keyword at point.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2132 their value.
2134 Return a list whose CAR is `keyword' and CDR is a plist
2135 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2136 `:post-affiliated' keywords."
2138 ;; An orphaned affiliated keyword is considered as a regular
2139 ;; keyword. In this case AFFILIATED is nil, so we take care of
2140 ;; this corner case.
2153 :value value
2154 :begin begin
2155 :end end
2161 "Interpret KEYWORD element as Org syntax."
2167 ;;;; Latex Environment
2171 "Regexp matching the beginning of a LaTeX environment.
2172 The environment is captured by the first group.
2178 "Format string matching the ending of a LaTeX environment.
2182 "Parse a LaTeX environment.
2184 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2185 the buffer position at the beginning of the first affiliated
2186 keyword and CDR is a plist of affiliated keywords along with
2187 their value.
2189 Return a list whose CAR is `latex-environment' and CDR is a plist
2190 containing `:begin', `:end', `:value', `:post-blank' and
2191 `:post-affiliated' keywords.
2193 Assume point is at the beginning of the latex environment."
2200 limit t))
2201 ;; Incomplete latex environment: parse it as a paragraph.
2211 :end end
2212 :value value
2218 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2222 ;;;; Node Property
2225 "Parse a node-property at point.
2227 LIMIT bounds the search.
2229 Return a list whose CAR is `node-property' and CDR is a plist
2230 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2231 `:post-affiliated' keywords."
2241 limit))))
2244 :value value
2245 :begin begin
2246 :end end
2251 "Interpret NODE-PROPERTY element as Org syntax."
2257 ;;;; Paragraph
2260 "Parse a paragraph.
2262 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2263 the buffer position at the beginning of the first affiliated
2264 keyword and CDR is a plist of affiliated keywords along with
2265 their value.
2267 Return a list whose CAR is `paragraph' and CDR is a plist
2268 containing `:begin', `:end', `:contents-begin' and
2269 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2271 Assume point is at the beginning of the paragraph."
2278 ;; A matching `org-element-paragraph-separate' is not
2279 ;; necessarily the end of the paragraph. In particular,
2280 ;; drawers, blocks or LaTeX environments opening lines
2281 ;; must be closed. Moreover keywords with a secondary
2282 ;; value must belong to "dual keywords".
2296 limit t)))
2302 limit t)))
2305 org-element-dual-keywords))
2306 ;; Everything else is unambiguous.
2319 :end end
2320 :contents-begin contents-begin
2321 :contents-end contents-end
2327 "Interpret paragraph element as Org syntax.
2328 CONTENTS is the contents of the element."
2329 contents)
2332 ;;;; Planning
2335 "Parse a planning.
2337 LIMIT bounds the search.
2339 Return a list whose CAR is `planning' and CDR is a plist
2340 containing `:closed', `:deadline', `:scheduled', `:begin',
2341 `:end', `:post-blank' and `:post-affiliated' keywords."
2351 closed deadline scheduled)
2363 :deadline deadline
2364 :scheduled scheduled
2365 :begin begin
2366 :end end
2367 :post-blank post-blank
2371 "Interpret PLANNING element as Org syntax."
2373 #'identity
2390 ;;;; Src Block
2393 "Parse a src block.
2395 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2396 the buffer position at the beginning of the first affiliated
2397 keyword and CDR is a plist of affiliated keywords along with
2398 their value.
2400 Return a list whose CAR is `src-block' and CDR is a plist
2401 containing `:language', `:switches', `:parameters', `:begin',
2402 `:end', `:number-lines', `:retain-labels', `:use-labels',
2403 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2404 `:post-affiliated' keywords.
2406 Assume point is at the beginning of the block."
2409 limit t)))
2410 ;; Incomplete block: parse it as a paragraph.
2416 ;; Get language as a string.
2425 ;; Get switches.
2427 ;; Get parameters.
2429 ;; Switches analysis.
2433 switches)
2436 'new
2439 ;; Subtract 1 to give number of lines before
2440 ;; first line.
2448 ;; Should labels be retained in (or stripped from)
2449 ;; src blocks?
2454 ;; What should code-references use - labels or
2455 ;; line-numbers?
2460 ;; Retrieve code.
2467 ;; Get position after ending blank lines.
2477 :begin begin
2478 :end end
2479 :number-lines number-lines
2480 :preserve-indent preserve-indent
2481 :retain-labels retain-labels
2482 :use-labels use-labels
2483 :label-fmt label-fmt
2484 :value value
2490 "Interpret SRC-BLOCK element as Org syntax."
2499 val)
2514 ;;;; Table
2517 "Parse a table at point.
2519 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2520 the buffer position at the beginning of the first affiliated
2521 keyword and CDR is a plist of affiliated keywords along with
2522 their value.
2524 Return a list whose CAR is `table' and CDR is a plist containing
2525 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2526 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2527 keywords.
2529 Assume point is at the beginning of the table."
2545 acc))
2552 :end end
2553 :type type
2554 :tblfm tblfm
2555 ;; Only `org' tables have contents. `table.el' tables
2556 ;; use a `:value' property to store raw table as
2557 ;; a string.
2562 table-begin table-end))
2568 "Interpret TABLE element as Org syntax.
2569 CONTENTS is a string, if table's type is `org', or nil."
2580 ;;;; Table Row
2583 "Parse table row at point.
2585 Return a list whose CAR is `table-row' and CDR is a plist
2586 containing `:begin', `:end', `:contents-begin', `:contents-end',
2587 `:type', `:post-blank' and `:post-affiliated' keywords."
2591 ;; A table rule has no contents. In that case, ensure
2592 ;; CONTENTS-BEGIN matches CONTENTS-END.
2602 :begin begin
2603 :end end
2604 :contents-begin contents-begin
2605 :contents-end contents-end
2610 "Interpret TABLE-ROW element as Org syntax.
2611 CONTENTS is the contents of the table row."
2616 ;;;; Verse Block
2619 "Parse a verse block.
2621 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2622 the buffer position at the beginning of the first affiliated
2623 keyword and CDR is a plist of affiliated keywords along with
2624 their value.
2626 Return a list whose CAR is `verse-block' and CDR is a plist
2627 containing `:begin', `:end', `:contents-begin', `:contents-end',
2628 `:post-blank' and `:post-affiliated' keywords.
2630 Assume point is at beginning of the block."
2634 ;; Incomplete block: parse it as a paragraph.
2649 :end end
2650 :contents-begin contents-begin
2651 :contents-end contents-end
2657 "Interpret verse-block element as Org syntax.
2658 CONTENTS is verse block contents."
2662 \f
2663 ;;; Objects
2664 ;;
2665 ;; Unlike to elements, raw text can be found between objects. Hence,
2666 ;; `org-element--object-lex' is provided to find the next object in
2667 ;; buffer.
2668 ;;
2669 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2670 ;; object types they can contain will be specified in
2671 ;; `org-element-object-restrictions'.
2672 ;;
2673 ;; Creating a new type of object requires to alter
2674 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2675 ;; new type in `org-element-all-objects', and possibly add
2676 ;; restrictions in `org-element-object-restrictions'.
2678 ;;;; Bold
2681 "Parse bold object at point, if any.
2683 When at a bold object, return a list whose car is `bold' and cdr
2684 is a plist with `:begin', `:end', `:contents-begin' and
2685 `:contents-end' and `:post-blank' keywords. Otherwise, return
2686 nil.
2688 Assume point is at the first star marker."
2700 :end end
2701 :contents-begin contents-begin
2702 :contents-end contents-end
2706 "Interpret bold object as Org syntax.
2707 CONTENTS is the contents of the object."
2711 ;;;; Code
2714 "Parse code object at point, if any.
2716 When at a code object, return a list whose car is `code' and cdr
2717 is a plist with `:value', `:begin', `:end' and `:post-blank'
2718 keywords. Otherwise, return nil.
2720 Assume point is at the first tilde marker."
2731 :begin begin
2732 :end end
2736 "Interpret CODE object as Org syntax."
2740 ;;;; Entity
2743 "Parse entity at point, if any.
2745 When at an entity, return a list whose car is `entity' and cdr
2746 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2747 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2748 `:post-blank' as keywords. Otherwise, return nil.
2750 Assume point is at the beginning of the entity."
2752 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2770 :begin begin
2771 :end end
2772 :use-brackets-p bracketsp
2776 "Interpret ENTITY object as Org syntax."
2782 ;;;; Export Snippet
2785 "Parse export snippet at point.
2787 When at an export snippet, return a list whose car is
2788 `export-snippet' and cdr a plist with `:begin', `:end',
2789 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2790 return nil.
2792 Assume point is at the beginning of the snippet."
2808 :value value
2809 :begin begin
2810 :end end
2814 "Interpret EXPORT-SNIPPET object as Org syntax."
2820 ;;;; Footnote Reference
2823 "Parse footnote reference at point, if any.
2825 When at a footnote reference, return a list whose car is
2826 `footnote-reference' and cdr a plist with `:label', `:type',
2827 `:begin', `:end', `:content-begin', `:contents-end' and
2828 `:post-blank' as keywords. Otherwise, return nil."
2844 :type type
2845 :begin begin
2846 :end end
2852 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2853 CONTENTS is its definition, when inline, or nil."
2859 ;;;; Inline Babel Call
2862 "Parse inline babel call at point, if any.
2864 When at an inline babel call, return a list whose car is
2865 `inline-babel-call' and cdr a plist with `:call',
2866 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2867 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2869 Assume point is at the beginning of the babel call."
2883 ;; Parenthesis are mandatory.
2894 :inside-header inside-header
2895 :arguments arguments
2896 :end-header end-header
2897 :begin begin
2898 :end end
2899 :value value
2903 "Interpret INLINE-BABEL-CALL object as Org syntax."
2913 ;;;; Inline Src Block
2916 "Parse inline source block at point, if any.
2918 When at an inline source block, return a list whose car is
2919 `inline-src-block' and cdr a plist with `:begin', `:end',
2920 `:language', `:value', `:parameters' and `:post-blank' as
2921 keywords. Otherwise, return nil.
2923 Assume point is at the beginning of the inline src block."
2940 :value value
2941 :parameters parameters
2942 :begin begin
2947 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2952 language
2954 body)))
2956 ;;;; Italic
2959 "Parse italic object at point, if any.
2961 When at an italic object, return a list whose car is `italic' and
2962 cdr is a plist with `:begin', `:end', `:contents-begin' and
2963 `:contents-end' and `:post-blank' keywords. Otherwise, return
2964 nil.
2966 Assume point is at the first slash marker."
2978 :end end
2979 :contents-begin contents-begin
2980 :contents-end contents-end
2984 "Interpret italic object as Org syntax.
2985 CONTENTS is the contents of the object."
2989 ;;;; Latex Fragment
2992 "Parse LaTeX fragment at point, if any.
2994 When at a LaTeX fragment, return a list whose car is
2995 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2996 and `:post-blank' as keywords. Otherwise, return nil.
2998 Assume point is at the beginning of the LaTeX fragment."
3016 ;; Macro.
3026 :begin begin
3027 :end end
3031 "Interpret LATEX-FRAGMENT object as Org syntax."
3034 ;;;; Line Break
3037 "Parse line break at point, if any.
3039 When at a line break, return a list whose car is `line-break',
3040 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3041 Otherwise, return nil.
3043 Assume point is at the beginning of the line break."
3052 "Interpret LINE-BREAK object as Org syntax."
3056 ;;;; Link
3059 "Parse link at point, if any.
3061 When at a link, return a list whose car is `link' and cdr a plist
3062 with `:type', `:path', `:raw-link', `:application',
3063 `:search-option', `:begin', `:end', `:contents-begin',
3064 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3065 nil.
3067 Assume point is at the beginning of the link."
3070 end contents-begin contents-end link-end post-blank path type
3071 raw-link search-option application)
3073 ;; Type 1: Text targeted from a radio target.
3082 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3087 ;; RAW-LINK is the original link. Expand any
3088 ;; abbreviation in it.
3089 ;;
3090 ;; Also treat any newline character and associated
3091 ;; indentation as a single space character. This is not
3092 ;; compatible with RFC 3986, which requires to ignore
3093 ;; them altogether. However, doing so would require
3094 ;; users to encode spaces on the fly when writing links
3095 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3096 ;; [[shell:ls *.org]], which defeats Org's focus on
3097 ;; simplicity.
3102 ;; Determine TYPE of link and set PATH accordingly. According
3103 ;; to RFC 3986, remove whitespaces from URI in external links.
3104 ;; In internal ones, treat indentation as a single space.
3106 ;; File type.
3111 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3115 ;; Id type: PATH is the id.
3118 ;; Code-ref type: PATH is the name of the reference.
3123 ;; Custom-id type: PATH is the name of the custom id.
3127 ;; Fuzzy type: Internal link either matches a target, an
3128 ;; headline name or nothing. PATH is the target or
3129 ;; headline's name.
3133 ;; Type 3: Plain link, e.g., http://orgmode.org
3139 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3140 ;; bracket links, follow RFC 3986 and remove any extra
3141 ;; whitespace in URI.
3151 ;; In any case, deduce end point after trailing white space from
3152 ;; LINK-END variable.
3157 ;; Special "file" type link processing. Extract opening
3158 ;; application and search option, if any. Also normalize URI.
3165 ;; Translate link, if `org-link-translation-function' is set.
3173 :path path
3175 :application application
3176 :search-option search-option
3177 :begin begin
3178 :end end
3179 :contents-begin contents-begin
3180 :contents-end contents-end
3184 "Interpret LINK object as Org syntax.
3185 CONTENTS is the contents of the object, or nil."
3196 path
3203 ;;;; Macro
3206 "Parse macro at point, if any.
3208 When at a macro, return a list whose car is `macro' and cdr
3209 a plist with `:key', `:args', `:begin', `:end', `:value' and
3210 `:post-blank' as keywords. Otherwise, return nil.
3212 Assume point is at the macro."
3225 :value value
3226 :args args
3227 :begin begin
3228 :end end
3232 "Interpret MACRO object as Org syntax."
3236 ;;;; Radio-target
3239 "Parse radio target at point, if any.
3241 When at a radio target, return a list whose car is `radio-target'
3242 and cdr a plist with `:begin', `:end', `:contents-begin',
3243 `:contents-end', `:value' and `:post-blank' as keywords.
3244 Otherwise, return nil.
3246 Assume point is at the radio target."
3258 :end end
3259 :contents-begin contents-begin
3260 :contents-end contents-end
3261 :post-blank post-blank
3265 "Interpret target object as Org syntax.
3266 CONTENTS is the contents of the object."
3270 ;;;; Statistics Cookie
3273 "Parse statistics cookie at point, if any.
3275 When at a statistics cookie, return a list whose car is
3276 `statistics-cookie', and cdr a plist with `:begin', `:end',
3277 `:value' and `:post-blank' keywords. Otherwise, return nil.
3279 Assume point is at the beginning of the statistics-cookie."
3290 :end end
3291 :value value
3295 "Interpret STATISTICS-COOKIE object as Org syntax."
3299 ;;;; Strike-Through
3302 "Parse strike-through object at point, if any.
3304 When at a strike-through object, return a list whose car is
3305 `strike-through' and cdr is a plist with `:begin', `:end',
3306 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3307 Otherwise, return nil.
3309 Assume point is at the first plus sign marker."
3321 :end end
3322 :contents-begin contents-begin
3323 :contents-end contents-end
3327 "Interpret strike-through object as Org syntax.
3328 CONTENTS is the contents of the object."
3332 ;;;; Subscript
3335 "Parse subscript at point, if any.
3337 When at a subscript object, return a list whose car is
3338 `subscript' and cdr a plist with `:begin', `:end',
3339 `:contents-begin', `:contents-end', `:use-brackets-p' and
3340 `:post-blank' as keywords. Otherwise, return nil.
3342 Assume point is at the underscore."
3356 :end end
3357 :use-brackets-p bracketsp
3358 :contents-begin contents-begin
3359 :contents-end contents-end
3363 "Interpret SUBSCRIPT object as Org syntax.
3364 CONTENTS is the contents of the object."
3367 contents))
3370 ;;;; Superscript
3373 "Parse superscript at point, if any.
3375 When at a superscript object, return a list whose car is
3376 `superscript' and cdr a plist with `:begin', `:end',
3377 `:contents-begin', `:contents-end', `:use-brackets-p' and
3378 `:post-blank' as keywords. Otherwise, return nil.
3380 Assume point is at the caret."
3394 :end end
3395 :use-brackets-p bracketsp
3396 :contents-begin contents-begin
3397 :contents-end contents-end
3401 "Interpret SUPERSCRIPT object as Org syntax.
3402 CONTENTS is the contents of the object."
3405 contents))
3408 ;;;; Table Cell
3411 "Parse table cell at point.
3412 Return a list whose car is `table-cell' and cdr is a plist
3413 containing `:begin', `:end', `:contents-begin', `:contents-end'
3414 and `:post-blank' keywords."
3422 :end end
3423 :contents-begin contents-begin
3424 :contents-end contents-end
3428 "Interpret table-cell element as Org syntax.
3429 CONTENTS is the contents of the cell, or nil."
3433 ;;;; Target
3436 "Parse target at point, if any.
3438 When at a target, return a list whose car is `target' and cdr
3439 a plist with `:begin', `:end', `:value' and `:post-blank' as
3440 keywords. Otherwise, return nil.
3442 Assume point is at the target."
3452 :end end
3453 :value value
3457 "Interpret TARGET object as Org syntax."
3461 ;;;; Timestamp
3472 "Parse time stamp at point, if any.
3474 When at a time stamp, return a list whose car is `timestamp', and
3475 cdr a plist with `:type', `:raw-value', `:year-start',
3476 `:month-start', `:day-start', `:hour-start', `:minute-start',
3477 `:year-end', `:month-end', `:day-end', `:hour-end',
3478 `:minute-end', `:repeater-type', `:repeater-value',
3479 `:repeater-unit', `:warning-type', `:warning-value',
3480 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3481 Otherwise, return nil.
3483 Assume point is at the beginning of the timestamp."
3502 date-start)
3513 raw-value)
3515 :repeater-type
3521 :repeater-unit
3530 :warning-unit
3533 year-start month-start day-start hour-start minute-start year-end
3534 month-end day-end hour-end minute-end)
3535 ;; Parse date-start.
3543 ;; Compute date-end. It can be provided directly in time-stamp,
3544 ;; or extracted from time range. Otherwise, it defaults to the
3545 ;; same values as date-start.
3555 :raw-value raw-value
3556 :year-start year-start
3557 :month-start month-start
3558 :day-start day-start
3559 :hour-start hour-start
3560 :minute-start minute-start
3561 :year-end year-end
3562 :month-end month-end
3563 :day-end day-end
3564 :hour-end hour-end
3565 :minute-end minute-end
3566 :begin begin
3567 :end end
3569 repeater-props
3570 warning-props))))))
3573 "Interpret TIMESTAMP object as Org syntax."
3591 ;; Build an Org timestamp string from TIME. ACTIVEP is
3592 ;; non-nil when time stamp is active. If WITH-TIME-P is
3593 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3594 ;; specify a time range in the timestamp. REPEAT-STRING is
3595 ;; the repeater string, if any.
3599 org-time-stamp-formats)
3600 time)))
3606 nil nil ts)))
3611 " "
3612 s
3614 ;; Return value.
3615 ts)))
3627 build-ts-string
3646 0
3654 "--"
3667 ;;;; Underline
3670 "Parse underline object at point, if any.
3672 When at an underline object, return a list whose car is
3673 `underline' and cdr is a plist with `:begin', `:end',
3674 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3675 Otherwise, return nil.
3677 Assume point is at the first underscore marker."
3689 :end end
3690 :contents-begin contents-begin
3691 :contents-end contents-end
3695 "Interpret underline object as Org syntax.
3696 CONTENTS is the contents of the object."
3700 ;;;; Verbatim
3703 "Parse verbatim object at point, if any.
3705 When at a verbatim object, return a list whose car is `verbatim'
3706 and cdr is a plist with `:value', `:begin', `:end' and
3707 `:post-blank' keywords. Otherwise, return nil.
3709 Assume point is at the first equal sign marker."
3720 :begin begin
3721 :end end
3725 "Interpret VERBATIM object as Org syntax."
3729 \f
3730 ;;; Parsing Element Starting At Point
3731 ;;
3732 ;; `org-element--current-element' is the core function of this section.
3733 ;; It returns the Lisp representation of the element starting at
3734 ;; point.
3735 ;;
3736 ;; `org-element--current-element' makes use of special modes. They
3737 ;; are activated for fixed element chaining (e.g., `plain-list' >
3738 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3739 ;; `section'). Special modes are: `first-section', `item',
3740 ;; `node-property', `section' and `table-row'.
3743 "Parse the element starting at point.
3745 Return value is a list like (TYPE PROPS) where TYPE is the type
3746 of the element and PROPS a plist of properties associated to the
3747 element.
3749 Possible types are defined in `org-element-all-elements'.
3751 LIMIT bounds the search.
3753 Optional argument GRANULARITY determines the depth of the
3754 recursion. Allowed values are `headline', `greater-element',
3755 `element', `object' or nil. When it is broader than `object' (or
3756 nil), secondary values will not be parsed, since they only
3757 contain objects.
3759 Optional argument MODE, when non-nil, can be either
3760 `first-section', `section', `planning', `item', `node-property'
3761 and `table-row'.
3763 If STRUCTURE isn't provided but MODE is set to `item', it will be
3764 computed.
3766 This function assumes point is always at the beginning of the
3767 element it has to parse."
3770 ;; Determine if parsing depth allows for secondary strings
3771 ;; parsing. It only applies to elements referenced in
3772 ;; `org-element-secondary-value-alist'.
3775 ;; Item.
3778 ;; Table Row.
3780 ;; Node Property.
3782 ;; Headline.
3785 ;; Sections (must be checked after headline).
3790 limit)))
3791 ;; Planning.
3794 ;; Property drawer.
3798 ;; When not at bol, point is at the beginning of an item or
3799 ;; a footnote definition: next item is always a paragraph.
3801 ;; Clock.
3803 ;; Inlinetask.
3806 ;; From there, elements can have affiliated keywords.
3809 ;; Jumping over affiliated keywords put point off-limits.
3810 ;; Parse them as regular keywords.
3814 ;; LaTeX Environment.
3817 ;; Drawer and Property Drawer.
3820 ;; Fixed Width
3823 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3824 ;; Keywords.
3842 limit
3843 affiliated))
3856 ;; Footnote Definition.
3859 ;; Horizontal Rule.
3862 ;; Diary Sexp.
3865 ;; Table.
3868 ;; List.
3871 limit affiliated
3873 ;; Default element: Paragraph.
3877 ;; Most elements can have affiliated keywords. When looking for an
3878 ;; element beginning, we want to move before them, as they belong to
3879 ;; that element, and, in the meantime, collect information they give
3880 ;; into appropriate properties. Hence the following function.
3883 "Collect affiliated keywords from point down to LIMIT.
3885 Return a list whose CAR is the position at the first of them and
3886 CDR a plist of keywords and values and move point to the
3887 beginning of the first line after them.
3889 As a special case, if element doesn't start at the beginning of
3890 the line (e.g., a paragraph starting an item), CAR is current
3891 position of point and CDR is nil."
3895 ;; RESTRICT is the list of objects allowed in parsed
3896 ;; keywords value.
3898 output)
3901 ;; Apply translation to RAW-KWD. From there, KWD is
3902 ;; the official keyword.
3904 org-element-keyword-translation-alist))
3905 raw-kwd))
3906 ;; Find main value for any keyword.
3912 ;; PARSEDP is non-nil when keyword should have its
3913 ;; value parsed.
3915 ;; If KWD is a dual keyword, find its secondary
3916 ;; value. Maybe parse it.
3925 ;; Attribute a property name to KWD.
3927 ;; Now set final shape for VALUE.
3933 nil restrict)))
3937 ;; Attributes can always appear on multiple lines.
3940 ;; Eventually store the new value in OUTPUT.
3942 ;; Move to next keyword.
3944 ;; If affiliated keywords are orphaned: move back to first one.
3945 ;; They will be parsed as a paragraph.
3947 ;; Return value.
3951 \f
3952 ;;; The Org Parser
3953 ;;
3954 ;; The two major functions here are `org-element-parse-buffer', which
3955 ;; parses Org syntax inside the current buffer, taking into account
3956 ;; region, narrowing, or even visibility if specified, and
3957 ;; `org-element-parse-secondary-string', which parses objects within
3958 ;; a given string.
3959 ;;
3960 ;; The (almost) almighty `org-element-map' allows applying a function
3961 ;; on elements or objects matching some type, and accumulating the
3962 ;; resulting values. In an export situation, it also skips unneeded
3963 ;; parts of the parse tree.
3966 "Recursively parse the buffer and return structure.
3967 If narrowing is in effect, only parse the visible part of the
3968 buffer.
3970 Optional argument GRANULARITY determines the depth of the
3971 recursion. It can be set to the following symbols:
3973 `headline' Only parse headlines.
3974 `greater-element' Don't recurse into greater elements excepted
3975 headlines and sections. Thus, elements
3976 parsed are the top-level ones.
3977 `element' Parse everything but objects and plain text.
3978 `object' Parse the complete buffer (default).
3980 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3981 elements.
3983 An element or an objects is represented as a list with the
3984 pattern (TYPE PROPERTIES CONTENTS), where :
3986 TYPE is a symbol describing the element or object. See
3987 `org-element-all-elements' and `org-element-all-objects' for an
3988 exhaustive list of such symbols. One can retrieve it with
3989 `org-element-type' function.
3991 PROPERTIES is the list of attributes attached to the element or
3992 object, as a plist. Although most of them are specific to the
3993 element or object type, all types share `:begin', `:end',
3994 `:post-blank' and `:parent' properties, which respectively
3995 refer to buffer position where the element or object starts,
3996 ends, the number of white spaces or blank lines after it, and
3997 the element or object containing it. Properties values can be
3998 obtained by using `org-element-property' function.
4000 CONTENTS is a list of elements, objects or raw strings
4001 contained in the current element or object, when applicable.
4002 One can access them with `org-element-contents' function.
4004 The Org buffer has `org-data' as type and nil as properties.
4005 `org-element-map' function can be used to find specific elements
4006 or objects within the parse tree.
4008 This function assumes that current major mode is `org-mode'."
4014 ;; Start in `first-section' mode so text before the first
4015 ;; headline belongs to a section.
4019 "Recursively parse objects in STRING and return structure.
4021 RESTRICTION is a symbol limiting the object types that will be
4022 looked after.
4024 Optional argument PARENT, when non-nil, is the element or object
4025 containing the secondary string. It is used to set correctly
4026 `:parent' property within the string.
4028 If STRING is the empty string or nil, return nil."
4045 "Map a function on selected elements or objects.
4047 DATA is a parse tree, an element, an object, a string, or a list
4048 of such constructs. TYPES is a symbol or list of symbols of
4049 elements or objects types (see `org-element-all-elements' and
4050 `org-element-all-objects' for a complete list of types). FUN is
4051 the function called on the matching element or object. It has to
4052 accept one argument: the element or object itself.
4054 When optional argument INFO is non-nil, it should be a plist
4055 holding export options. In that case, parts of the parse tree
4056 not exportable according to that property list will be skipped.
4058 When optional argument FIRST-MATCH is non-nil, stop at the first
4059 match for which FUN doesn't return nil, and return that value.
4061 Optional argument NO-RECURSION is a symbol or a list of symbols
4062 representing elements or objects types. `org-element-map' won't
4063 enter any recursive element or object whose type belongs to that
4064 list. Though, FUN can still be applied on them.
4066 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4067 apply to matching objects within parsed affiliated keywords (see
4068 `org-element-parsed-keywords').
4070 Nil values returned from FUN do not appear in the results.
4073 Examples:
4074 ---------
4076 Assuming TREE is a variable containing an Org buffer parse tree,
4077 the following example will return a flat list of all `src-block'
4078 and `example-block' elements in it:
4082 The following snippet will find the first headline with a level
4086 (lambda (hl)
4087 (and (= (org-element-property :level hl) 1)
4089 (org-element-property :begin hl)))
4090 nil t)
4092 The next example will return a flat list of all `plain-list' type
4093 elements in TREE that are not a sub-list themselves:
4097 Eventually, this example will return a flat list of all `bold'
4098 type objects containing a `latex-snippet' type object, even
4099 looking into captions:
4102 (lambda (b)
4104 nil nil nil t)"
4105 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4109 ;; Recursion depth is determined by --CATEGORY.
4116 ;; If one object is found, the function has
4117 ;; to recurse into every object.
4120 ;; If one regular element is found, the
4121 ;; function has to recurse, at least, into
4122 ;; every element it encounters.
4125 --acc)
4128 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4129 ;; holding contextual information.
4133 ;; Ignored element in an export context.
4135 ;; List of elements or objects.
4137 ;; Unconditionally enter parse trees.
4141 ;; Check if TYPE is matching among TYPES. If so,
4142 ;; apply FUN to --DATA and accumulate return value
4143 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4149 ;; If --DATA has a secondary string that can contain
4150 ;; objects with their type among TYPES, look inside.
4153 org-element-secondary-value-alist)))
4155 ;; If --DATA has any parsed affiliated keywords and
4156 ;; WITH-AFFILIATED is non-nil, look for objects in
4157 ;; them.
4164 ;; Pay attention to the type of parsed
4165 ;; keyword. In particular, preserve order for
4166 ;; multiple keywords.
4179 ;; Determine if a recursion into --DATA is possible.
4181 ;; --TYPE is explicitly removed from recursion.
4183 ;; --DATA has no contents.
4185 ;; Looking for greater elements but --DATA is
4186 ;; simply an element or an object.
4189 ;; Looking for elements but --DATA is an object.
4192 ;; In any other case, map contents.
4196 ;; Return value in a proper order.
4200 ;; The following functions are internal parts of the parser.
4201 ;;
4202 ;; The first one, `org-element--parse-elements' acts at the element's
4203 ;; level.
4204 ;;
4205 ;; The second one, `org-element--parse-objects' applies on all objects
4206 ;; of a paragraph or a secondary string. It calls
4207 ;; `org-element--object-lex' to find the next object in the current
4208 ;; container.
4211 "Return next special mode according to TYPE, or nil.
4212 TYPE is a symbol representing the type of an element or object
4213 containing next element if PARENTP is non-nil, or before it
4214 otherwise. Modes can be either `first-section', `item',
4215 `node-property', `planning', `property-drawer', `section',
4216 `table-row' or nil."
4233 "Parse elements between BEG and END positions.
4235 MODE prioritizes some elements over the others. It can be set to
4236 `first-section', `section', `planning', `item', `node-property'
4237 or `table-row'.
4239 When value is `item', STRUCTURE will be used as the current list
4240 structure.
4242 GRANULARITY determines the depth of the recursion. See
4243 `org-element-parse-buffer' for more information.
4245 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4246 elements.
4248 Elements are accumulated into ACC."
4251 ;; Visible only: skip invisible parts at the beginning of the
4252 ;; element.
4255 ;; When parsing only headlines, skip any text before first one.
4260 ;; Find current element's type and parse it accordingly to
4261 ;; its category.
4263 end granularity mode structure))
4267 ;; Visible only: skip invisible parts between siblings.
4270 ;; Fill ELEMENT contents by side-effect.
4272 ;; If element has no contents, don't modify it.
4274 ;; Greater element: parse it between `contents-begin' and
4275 ;; `contents-end'. Make sure GRANULARITY allows the
4276 ;; recursion, or ELEMENT is a headline, in which case going
4277 ;; inside is mandatory, in order to get sub-level headings.
4285 ;; Possibly switch to a special mode.
4289 granularity visible-only element))
4290 ;; ELEMENT has contents. Parse objects inside, if
4291 ;; GRANULARITY allows it.
4297 ;; Update mode.
4299 ;; Return result.
4303 "Return next object in current buffer or nil.
4304 RESTRICTION is a list of object types, as symbols, that should be
4305 looked after. This function assumes that the buffer is narrowed
4306 to an appropriate container (e.g., a paragraph)."
4314 found)
4380 ;; This is probably a plain link.
4386 ;; Radio link.
4391 "Parse objects between BEG and END and return recursive structure.
4393 Objects are accumulated in ACC. RESTRICTION is a list of object
4394 successors which are allowed in the current object.
4396 ACC becomes the parent for all parsed objects. However, if ACC
4397 is nil (i.e., a secondary string is being parsed) and optional
4398 argument PARENT is non-nil, use it as the parent for all objects.
4399 Eventually, if both ACC and PARENT are nil, the common parent is
4400 the list of objects itself."
4408 ;; Text before any object. Untabify it.
4413 contents))))
4414 ;; Object...
4419 ;; Fill contents of NEXT-OBJECT if possible.
4421 cont-beg
4423 next-object
4425 next-object)
4426 contents)
4428 ;; Text after last object. Untabify it.
4432 contents)))
4433 ;; Result. Set appropriate parent.
4441 \f
4442 ;;; Towards A Bijective Process
4443 ;;
4444 ;; The parse tree obtained with `org-element-parse-buffer' is really
4445 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4446 ;; interpreted and expanded into a string with canonical Org syntax.
4447 ;; Hence `org-element-interpret-data'.
4448 ;;
4449 ;; The function relies internally on
4450 ;; `org-element--interpret-affiliated-keywords'.
4452 ;;;###autoload
4454 "Interpret DATA as Org syntax.
4455 DATA is a parse tree, an element, an object or a secondary string
4456 to interpret. Return Org syntax as a string."
4460 ;; Find interpreter for current object or
4461 ;; element. If it doesn't exist (e.g. this is
4462 ;; a pseudo object or element), return contents,
4463 ;; if any.
4470 ;; Secondary string.
4474 ;; Full Org document.
4478 ;; Plain text: return it.
4480 ;; Element or object without contents.
4483 ;; Element or object with contents.
4486 interpret
4487 --data
4488 ;; Recursively interpret contents.
4493 --data
4494 ;; Fix indentation of elements containing
4495 ;; objects. We ignore `table-row'
4496 ;; elements as they are one line long
4497 ;; anyway.
4499 --data
4500 ;; When normalizing first paragraph of
4501 ;; an item or a footnote-definition,
4502 ;; ignore first line's indentation.
4510 ;; Build white spaces. If no `:post-blank' property
4511 ;; is specified, assume its value is 0.
4526 "Return ELEMENT's affiliated keywords as Org syntax.
4527 If there is no affiliated keyword, return the empty string."
4537 ": "
4540 value)
4548 ;; All attribute keywords can have multiple lines.
4554 ;; List all ELEMENT's properties matching an attribute line or an
4555 ;; affiliated keyword, but ignore translated keywords since they
4556 ;; cannot belong to the property list.
4563 org-element-keyword-translation-alist)))))
4564 collect prop)
4567 ;; Because interpretation of the parse tree must return the same
4568 ;; number of blank lines between elements and the same number of white
4569 ;; space after objects, some special care must be given to white
4570 ;; spaces.
4571 ;;
4572 ;; The first function, `org-element-normalize-string', ensures any
4573 ;; string different from the empty string will end with a single
4574 ;; newline character.
4575 ;;
4576 ;; The second function, `org-element-normalize-contents', removes
4577 ;; global indentation from the contents of the current element.
4580 "Ensure string S ends with a single newline character.
4582 If S isn't a string return it unchanged. If S is the empty
4583 string, return it. Otherwise, return a new string with a single
4584 newline character at its end."
4592 "Normalize plain text in ELEMENT's contents.
4594 ELEMENT must only contain plain text and objects.
4596 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4597 indentation to compute maximal common indentation.
4599 Return the normalized element that is element with global
4600 indentation removed from its contents."
4602 ;; Return minimal common indentation within BLOB. This is
4603 ;; done by walking recursively BLOB and updating MIN-IND
4604 ;; along the way. FIRST-FLAG is non-nil when the next
4605 ;; object is expected to be a string that doesn't start
4606 ;; with a newline character. It happens for strings at
4607 ;; the beginnings of the contents or right after a line
4608 ;; break.
4615 ;; Objects cannot start with spaces: in this
4616 ;; case, indentation is 0.
4639 datum)
4652 ;; Build ELEMENT back, replacing each string with the same
4653 ;; string minus common indentation.
4656 ;; Return DATUM with all its strings indentation
4657 ;; shortened from MIN-IND white spaces.
4677 org-element-recursive-objects)
4681 datum)))
4685 \f
4686 ;;; Cache
4687 ;;
4688 ;; Implement a caching mechanism for `org-element-at-point' and
4689 ;; `org-element-context', which see.
4690 ;;
4691 ;; A single public function is provided: `org-element-cache-reset'.
4692 ;;
4693 ;; Cache is enabled by default, but can be disabled globally with
4694 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4695 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4696 ;; can be tweaked to control caching behaviour.
4697 ;;
4698 ;; Internally, parsed elements are stored in an AVL tree,
4699 ;; `org-element--cache'. This tree is updated lazily: whenever
4700 ;; a change happens to the buffer, a synchronization request is
4701 ;; registered in `org-element--cache-sync-requests' (see
4702 ;; `org-element--cache-submit-request'). During idle time, requests
4703 ;; are processed by `org-element--cache-sync'. Synchronization also
4704 ;; happens when an element is required from the cache. In this case,
4705 ;; the process stops as soon as the needed element is up-to-date.
4706 ;;
4707 ;; A synchronization request can only apply on a synchronized part of
4708 ;; the cache. Therefore, the cache is updated at least to the
4709 ;; location where the new request applies. Thus, requests are ordered
4710 ;; from left to right and all elements starting before the first
4711 ;; request are correct. This property is used by functions like
4712 ;; `org-element--cache-find' to retrieve elements in the part of the
4713 ;; cache that can be trusted.
4714 ;;
4715 ;; A request applies to every element, starting from its original
4716 ;; location (or key, see below). When a request is processed, it
4717 ;; moves forward and may collide the next one. In this case, both
4718 ;; requests are merged into a new one that starts from that element.
4719 ;; As a consequence, the whole synchronization complexity does not
4720 ;; depend on the number of pending requests, but on the number of
4721 ;; elements the very first request will be applied on.
4722 ;;
4723 ;; Elements cannot be accessed through their beginning position, which
4724 ;; may or may not be up-to-date. Instead, each element in the tree is
4725 ;; associated to a key, obtained with `org-element--cache-key'. This
4726 ;; mechanism is robust enough to preserve total order among elements
4727 ;; even when the tree is only partially synchronized.
4728 ;;
4729 ;; Objects contained in an element are stored in a hash table,
4730 ;; `org-element--cache-objects'.
4734 "Non nil when Org parser should cache its results.
4741 "Maximum duration, as a time value, for a cache synchronization.
4742 If the synchronization is not over after this delay, the process
4743 pauses and resumes after `org-element-cache-sync-break'
4747 "Duration, as a time value, of the pause between synchronizations.
4751 ;;;; Data Structure
4754 "AVL tree used to cache elements.
4755 Each node of the tree contains an element. Comparison is done
4756 with `org-element--cache-compare'. This cache is used in
4760 "Hash table used as to cache objects.
4761 Key is an element, as returned by `org-element-at-point', and
4762 value is an alist where each association is:
4764 \(PARENT COMPLETEP . OBJECTS)
4766 where PARENT is an element or object, COMPLETEP is a boolean,
4767 non-nil when all direct children of parent are already cached and
4768 OBJECTS is a list of such children, as objects, from farthest to
4769 closest.
4772 contained within a paragraph
4776 If the paragraph is completely parsed, OBJECTS-DATA will be
4778 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4779 \(BOLD-OBJECT t ENTITY-OBJECT))
4781 whereas in a partially parsed paragraph, it could be
4783 \((PARAGRAPH nil ENTITY-OBJECT))
4788 "List of pending synchronization requests.
4790 A request is a vector with the following pattern:
4792 \[NEXT BEG END OFFSET PARENT PHASE]
4794 Processing a synchronization request consists of three phases:
4796 0. Delete modified elements,
4797 1. Fill missing area in cache,
4798 2. Shift positions and re-parent elements after the changes.
4800 During phase 0, NEXT is the key of the first element to be
4801 removed, BEG and END is buffer position delimiting the
4802 modifications. Elements starting between them (inclusive) are
4803 removed. So are elements whose parent is removed. PARENT, when
4804 non-nil, is the parent of the first element to be removed.
4806 During phase 1, NEXT is the key of the next known element in
4807 cache and BEG its beginning position. Parse buffer between that
4808 element and the one before it in order to determine the parent of
4809 the next element. Set PARENT to the element containing NEXT.
4811 During phase 2, NEXT is the key of the next element to shift in
4812 the parse tree. All elements starting from this one have their
4813 properties relatives to buffer positions shifted by integer
4814 OFFSET and, if they belong to element PARENT, are adopted by it.
4822 "Hash table used to store keys during synchronization.
4826 "Return a unique key for ELEMENT in cache tree.
4828 Keys are used to keep a total order among elements in the cache.
4829 Comparison is done with `org-element--cache-key-less-p'.
4831 When no synchronization is taking place, a key is simply the
4832 beginning position of the element, or that position plus one in
4833 the case of an first item (respectively row) in
4834 a list (respectively a table).
4836 During a synchronization, the key is the one the element had when
4837 the cache was synchronized for the last time. Elements added to
4838 cache during the synchronization get a new key generated with
4839 `org-element--cache-generate-key'.
4841 Such keys are stored in `org-element--cache-sync-keys'. The hash
4842 table is cleared once the synchronization is complete."
4845 ;; Increase beginning position of items (respectively
4846 ;; table rows) by one, so the first item can get
4847 ;; a different key from its parent list (respectively
4848 ;; table).
4851 begin)))
4854 key))))
4857 "Generate a key between LOWER and UPPER.
4859 LOWER and UPPER are integers or lists, possibly empty.
4861 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4862 a unique key, as an integer or a list of integers, according to
4863 the following rules:
4865 - LOWER and UPPER are compared level-wise until values differ.
4867 - If, at a given level, LOWER and UPPER differ from more than
4868 2, the new key shares all the levels above with LOWER and
4869 gets a new level. Its value is the mean between LOWER and
4870 UPPER:
4872 \(1 2) + (1 4) --> (1 3)
4874 - If LOWER has no value to compare with, it is assumed that its
4875 value is `most-negative-fixnum'. E.g.,
4877 \(1 1) + (1 1 2)
4879 is equivalent to
4881 \(1 1 m) + (1 1 2)
4883 where m is `most-negative-fixnum'. Likewise, if UPPER is
4884 short of levels, the current value is `most-positive-fixnum'.
4886 - If they differ from only one, the new key inherits from
4887 current LOWER level and fork it at the next level. E.g.,
4889 \(2 1) + (3 3)
4891 is equivalent to
4893 \(2 1) + (2 M)
4895 where M is `most-positive-fixnum'.
4897 - If the key is only one level long, it is returned as an
4898 integer:
4900 \(1 2) + (3 2) --> 2
4902 When they are not equals, the function assumes that LOWER is
4903 lesser than UPPER, per `org-element--cache-key-less-p'."
4907 skip-upper key)
4918 ;; When at a given level, LOWER and UPPER differ from
4919 ;; 1, ignore UPPER altogether. Instead create a key
4920 ;; between LOWER and the greatest key with the same
4921 ;; prefix as LOWER so far.
4927 "Non-nil if key A is less than key B.
4928 A and B are either integers or lists of integers, as returned by
4929 `org-element--cache-key'."
4937 ;; If A is empty, either keys are equal (B is also empty) and
4938 ;; we return nil, or A is lesser than B (B is longer) and we
4939 ;; return a non-nil value.
4940 ;;
4941 ;; If A is not empty, B is necessarily empty and A is greater
4942 ;; than B (A is longer). Therefore, return nil.
4946 "Non-nil when element A is located before element B."
4951 "Return root value in cache.
4952 This function assumes `org-element--cache' is a valid AVL tree."
4956 ;;;; Tools
4959 "Non-nil when cache is active in current buffer."
4961 org-element--cache
4965 "Find element in cache starting at POS or before.
4967 POS refers to a buffer position.
4969 When optional argument SIDE is non-nil, the function checks for
4970 elements starting at or past POS instead. If SIDE is `both', the
4971 function returns a cons cell where car is the first element
4972 starting at or before POS and cdr the first element starting
4973 after POS.
4975 The function can only find elements in the synchronized part of
4976 the cache."
4980 lower upper)
4995 ;; We found an element in cache starting at POS. If `side'
4996 ;; is `both' we also want the next one in order to generate
4997 ;; a key in-between.
4998 ;;
4999 ;; If the element is the first row or item in a table or
5000 ;; a plain list, we always return the table or the plain
5001 ;; list.
5002 ;;
5003 ;; In any other case, we return the element found.
5012 lower parent
5013 upper parent)))))
5016 lower element
5017 upper element)))))
5024 "Store ELEMENT in current buffer's cache, if allowed.
5025 When optional argument DATA is non-nil, assume is it object data
5026 relative to ELEMENT and store it in the objects cache."
5030 ;; During synchronization, first build an appropriate key
5031 ;; for the new element so `avl-tree-enter' can insert it at
5032 ;; the right spot in the cache.
5041 org-element--cache-sync-keys)))
5043 ;; Headlines are not stored in cache, so objects in titles are
5044 ;; not stored either.
5049 "Remove ELEMENT from cache.
5050 Assume ELEMENT belongs to cache and that a cache is active."
5055 ;;;; Synchronization
5058 "Set idle timer for cache synchronization in BUFFER."
5065 org-element-cache-sync-idle-time))
5066 nil
5067 #'org-element--cache-sync
5068 buffer)))
5071 "Non-nil when synchronization process should be interrupted.
5072 TIME-LIMIT is a time value or nil."
5078 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5080 Properties containing buffer positions are `:begin', `:end',
5081 `:contents-begin', `:contents-end' and `:structure'. When
5082 optional argument PROPS is a list of keywords, only shift
5083 properties provided in that list.
5085 Properties are modified by side-effect."
5087 ;; Shift `:structure' property for the first plain list only: it
5088 ;; is the only one that really matters and it prevents from
5089 ;; shifting it more than once.
5103 "Synchronize cache with recent modification in BUFFER.
5105 When optional argument THRESHOLD is non-nil, do the
5106 synchronization for all elements starting before or at threshold,
5107 then exit. Otherwise, synchronize cache for as long as
5108 `org-element-cache-sync-duration' or until Emacs leaves idle
5109 state.
5111 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5112 not registered yet in the cache are going to happen. It is used
5113 in `org-element--cache-submit-request', where cache is partially
5114 updated before current modification are actually submitted."
5125 request
5127 threshold
5130 org-element-cache-sync-duration))
5131 future-change)
5132 ;; Request processed. Merge current and next offsets and
5133 ;; transfer ending position.
5139 ;; If more requests are awaiting, set idle timer accordingly.
5140 ;; Otherwise, reset keys.
5147 "Process synchronization REQUEST for all entries before NEXT.
5149 REQUEST is a vector, built by `org-element--cache-submit-request'.
5151 NEXT is a cache key, as returned by `org-element--cache-key'.
5153 When non-nil, THRESHOLD is a buffer position. Synchronization
5154 stops as soon as a shifted element begins after it.
5156 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5157 after this time or when Emacs exits idle state.
5159 When non-nil, FUTURE-CHANGE is a buffer position where changes
5160 not registered yet in the cache are going to happen. See
5161 `org-element--cache-submit-request' for more information.
5163 Throw `interrupt' if the process stops before completing the
5164 request."
5167 ;; Phase 0.
5168 ;;
5169 ;; Delete all elements starting after BEG, but not after buffer
5170 ;; position END or past element with key NEXT. Also delete
5171 ;; elements contained within a previously removed element
5172 ;; (stored in `last-container').
5173 ;;
5174 ;; At each iteration, we start again at tree root since
5175 ;; a deletion modifies structure of the balanced tree.
5180 ;; Find first element in cache with key BEG or after it.
5184 data data-key last-container)
5193 data-key key
5196 data-key key
5197 node nil)))))
5207 up)))
5210 end))
5217 ;; No element starting after modifications left in
5218 ;; cache: further processing is futile.
5221 ;; Phase 1.
5222 ;;
5223 ;; Phase 0 left a hole in the cache. Some elements after it
5224 ;; could have parents within. For example, in the following
5225 ;; buffer:
5226 ;;
5227 ;; - item
5228 ;;
5229 ;;
5230 ;; Paragraph1
5231 ;;
5232 ;; Paragraph2
5233 ;;
5234 ;; if we remove a blank line between "item" and "Paragraph1",
5235 ;; everything down to "Paragraph2" is removed from cache. But
5236 ;; the paragraph now belongs to the list, and its `:parent'
5237 ;; property no longer is accurate.
5238 ;;
5239 ;; Therefore we need to parse again elements in the hole, or at
5240 ;; least in its last section, so that we can re-parent
5241 ;; subsequent elements, during phase 2.
5242 ;;
5243 ;; Note that we only need to get the parent from the first
5244 ;; element in cache after the hole.
5245 ;;
5246 ;; When next key is lesser or equal to the current one, delegate
5247 ;; phase 1 processing to next request in order to preserve key
5248 ;; order among requests.
5256 ;; Next element will start at its beginning position plus
5257 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5258 ;; contains the real beginning position of the first element to
5259 ;; shift and re-parent.
5263 ;; Changes are going to happen around this element and
5264 ;; they will trigger another phase 1 request. Skip the
5265 ;; current one.
5271 ;; Phase 2.
5272 ;;
5273 ;; Shift all elements starting from key START, but before NEXT, by
5274 ;; OFFSET, and re-parent them when appropriate.
5275 ;;
5276 ;; Elements are modified by side-effect so the tree structure
5277 ;; remains intact.
5278 ;;
5279 ;; Once THRESHOLD, if any, is reached, or once there is an input
5280 ;; pending, exit. Before leaving, the current synchronization
5281 ;; request is updated.
5288 exit-flag)
5289 ;; No re-parenting nor shifting planned: request is over.
5299 ;; We reached NEXT. Request is complete.
5301 ;; Handle interruption request. Update current request.
5306 ;; Shift element.
5309 ;; Shift associated objects data, if any.
5314 ;; Update PARENT and re-parent DATA, only when
5315 ;; necessary. Propagate new structures for lists.
5329 ;; Cache is up-to-date past THRESHOLD. Request
5330 ;; interruption.
5335 ;; We reached end of tree: synchronization complete.
5336 t)))
5339 "Parse elements in current section, down to POS.
5341 Start parsing from the closest between the last known element in
5342 cache or headline above. Return the smallest element containing
5343 POS.
5345 When optional argument SYNCP is non-nil, return the parent of the
5346 element containing POS instead. In that case, it is also
5347 possible to provide TIME-LIMIT, which is a time value specifying
5348 when the parsing should stop. The function throws `interrupt' if
5349 the process stopped before finding the expected result."
5356 element next mode)
5358 ;; Nothing in cache before point: start parsing from first
5359 ;; element following headline above, or first element in
5360 ;; buffer.
5367 ;; Cache returned exact match: return it.
5370 ;; There's a headline between cached value and POS: cached
5371 ;; value is invalid. Start parsing from first element
5372 ;; following the headline.
5379 ;; Check if CACHED or any of its ancestors contain point.
5380 ;;
5381 ;; If there is such an element, we inspect it in order to know
5382 ;; if we return it or if we need to parse its contents.
5383 ;; Otherwise, we just start parsing from current location,
5384 ;; which is right after the top-most element containing
5385 ;; CACHED.
5386 ;;
5387 ;; As a special case, if POS is at the end of the buffer, we
5388 ;; want to return the innermost element ending there.
5389 ;;
5390 ;; Also, if we find an ancestor and discover that we need to
5391 ;; parse its contents, make sure we don't start from
5392 ;; `:contents-begin', as we would otherwise go past CACHED
5393 ;; again. Instead, in that situation, we will resume parsing
5394 ;; from NEXT, which is located after CACHED or its higher
5395 ;; ancestor not containing point.
5407 ;; Parse successively each element until we reach POS.
5420 end 'element mode
5427 ;; Skip any element ending before point. Also skip
5428 ;; element ending at point (unless it is also the end of
5429 ;; buffer) since we're sure that another element begins
5430 ;; after it.
5434 ;; A non-greater element contains point: return it.
5437 ;; Otherwise, we have to decide if ELEMENT really
5438 ;; contains POS. In that case we start parsing from
5439 ;; contents' beginning.
5440 ;;
5441 ;; If POS is at contents' beginning but it is also at
5442 ;; the beginning of the first item in a list or a table.
5443 ;; In that case, we need to create an anchor for that
5444 ;; list or table, so return it.
5445 ;;
5446 ;; Also, if POS is at the end of the buffer, no element
5447 ;; can start after it, but more than one may end there.
5448 ;; Arbitrarily, we choose to return the innermost of
5449 ;; such elements.
5462 parent element
5463 end cend))))
5464 ;; Otherwise, return ELEMENT as it is the smallest
5465 ;; element containing POS.
5470 ;;;; Staging Buffer Changes
5481 "Regexp matching a sensitive line, structure wise.
5482 A sensitive line is a headline, inlinetask, block, drawer, or
5483 latex-environment boundary. When such a line is modified,
5484 structure changes in the document may propagate in the whole
5488 "Non-nil when a sensitive line is about to be changed.
5492 "Request extension of area going to be modified if needed.
5493 BEG and END are the beginning and end of the range of changed
5494 text. See `before-change-functions' for more information."
5504 'headline
5507 org-element--cache-sensitive-re bottom t)))))))))
5510 "Update buffer modifications for current buffer.
5511 BEG and END are the beginning and end of the range of changed
5512 text, and the length in bytes of the pre-change text replaced by
5513 that range. See `after-change-functions' for more information."
5521 ;; Determine if modified area needs to be extended, according
5522 ;; to both previous and current state. We make a special
5523 ;; case for headline editing: if a headline is modified but
5524 ;; not removed, do not extend.
5527 (`headline
5533 org-element--cache-sensitive-re bottom t))))
5534 ;; Effectively extend modified area.
5542 ;; Store synchronization request.
5545 ;; Activate a timer to process the request during idle time.
5549 "Return first element to remove from cache.
5551 BEG and END are buffer positions delimiting buffer modifications.
5552 OFFSET is the size of the changes.
5554 Returned element is usually the first element in cache containing
5555 any position between BEG and END. As an exception, greater
5556 elements around the changes that are robust to contents
5557 modifications are preserved and updated according to the
5558 changes."
5568 special-block))
5569 ;; Drawers named "PROPERTIES" are probably
5570 ;; a properties drawer being edited. Force
5571 ;; parsing to check if editing is over.
5580 ;; UP is a robust greater element containing changes.
5581 ;; We only need to extend its ending boundaries.
5587 ;; We're at top level element containing ELEMENT: if it's
5588 ;; altered by buffer modifications, it is first element in
5589 ;; cache to be removed. Otherwise, that first element is the
5590 ;; following one.
5591 ;;
5592 ;; As a special case, do not remove BEFORE if it is a robust
5593 ;; container for current changes.
5595 before)))))
5598 "Submit a new cache synchronization request for current buffer.
5599 BEG and END are buffer positions delimiting the minimal area
5600 where cache data should be removed. OFFSET is the size of the
5601 change, as an integer."
5603 delete-to delete-from)
5608 ;; Current changes can be merged with first sync request: we
5609 ;; can save a partial cache synchronization.
5612 ;; If last change happened within area to be removed, extend
5613 ;; boundaries of robust parents, if any. Otherwise, find
5614 ;; first element to remove and update request accordingly.
5626 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5627 ;; if any, is no longer a 0-phase request, thus ensuring that
5628 ;; phases are properly ordered. We need to provide OFFSET as
5629 ;; optional parameter since current modifications are not known
5630 ;; yet to the otherwise correct part of the cache (i.e, before
5631 ;; the first request).
5638 ;; When changes happen before the first known
5639 ;; element, re-parent and shift the rest of the
5640 ;; cache.
5642 ;; Otherwise, we find the first non robust
5643 ;; element containing END. All elements between
5644 ;; FIRST and this one are to be removed.
5655 element up))
5657 org-element--cache-sync-requests)
5658 ;; No element to remove. No need to re-parent either.
5659 ;; Simply shift additional elements, if any, by OFFSET.
5664 ;;;; Public Functions
5666 ;;;###autoload
5668 "Reset cache in current buffer.
5669 When optional argument ALL is non-nil, reset cache in all Org
5670 buffers."
5688 ;;;###autoload
5690 "Refresh cache at position POS."
5697 \f
5698 ;;; The Toolbox
5699 ;;
5700 ;; The first move is to implement a way to obtain the smallest element
5701 ;; containing point. This is the job of `org-element-at-point'. It
5702 ;; basically jumps back to the beginning of section containing point
5703 ;; and proceed, one element after the other, with
5704 ;; `org-element--current-element' until the container is found. Note:
5705 ;; When using `org-element-at-point', secondary values are never
5706 ;; parsed since the function focuses on elements, not on objects.
5707 ;;
5708 ;; At a deeper level, `org-element-context' lists all elements and
5709 ;; objects containing point.
5710 ;;
5711 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5712 ;; internally by navigation and manipulation tools.
5715 ;;;###autoload
5717 "Determine closest element around point.
5719 Return value is a list like (TYPE PROPS) where TYPE is the type
5720 of the element and PROPS a plist of properties associated to the
5721 element.
5723 Possible types are defined in `org-element-all-elements'.
5724 Properties depend on element or object type, but always include
5725 `:begin', `:end', `:parent' and `:post-blank' properties.
5727 As a special case, if point is at the very beginning of the first
5728 item in a list or sub-list, returned element will be that list
5729 instead of the item. Likewise, if point is at the beginning of
5730 the first row of a table, returned element will be the table
5731 instead of the first row.
5733 When point is at the end of the buffer, return the innermost
5734 element ending there."
5740 ;; Within blank lines at the beginning of buffer, return nil.
5742 ;; Within blank lines right after a headline, return that
5743 ;; headline.
5747 ;; Otherwise parse until we find element containing ORIGIN.
5754 ;;;###autoload
5756 "Return smallest element or object around point.
5758 Return value is a list like (TYPE PROPS) where TYPE is the type
5759 of the element or object and PROPS a plist of properties
5760 associated to it.
5762 Possible types are defined in `org-element-all-elements' and
5763 `org-element-all-objects'. Properties depend on element or
5764 object type, but always include `:begin', `:end', `:parent' and
5765 `:post-blank'.
5767 As a special case, if point is right after an object and not at
5768 the beginning of any other object, return that object.
5770 Optional argument ELEMENT, when non-nil, is the closest element
5771 containing point, as returned by `org-element-at-point'.
5772 Providing it allows for quicker computation."
5779 ;; If point is inside an element containing objects or
5780 ;; a secondary string, narrow buffer to the container and
5781 ;; proceed with parsing. Otherwise, return ELEMENT.
5783 ;; At a parsed affiliated keyword, check if we're inside main
5784 ;; or dual value.
5790 org-element-parsed-keywords))
5799 ;; Also change type to retrieve correct restrictions.
5801 ;; At an item, objects can only be located within tag, if any.
5812 ;; At an headline or inlinetask, objects are in title.
5823 ;; At a paragraph, a table-row or a verse block, objects are
5824 ;; located within their contents.
5828 ;; CBEG is nil for table rules.
5833 ;; At a planning line, if point is at a timestamp, return it,
5834 ;; otherwise, return element.
5842 ;; All other locations cannot contain objects: bail out.
5852 next object-data last)
5856 ;; When entering PARENT for the first time, get list
5857 ;; of objects within known so far. Store it in
5858 ;; OBJECT-DATA.
5863 ;; Find NEXT object for analysis.
5865 ;; If NEXT is non-nil, we already exhausted the
5866 ;; cache so we can parse buffer to find the object
5867 ;; after it.
5869 ;; Otherwise, check if cache can help us.
5880 ;; Cache contains the information needed.
5883 pos)
5885 pos)
5891 ;; If we have a new object to analyze, store it in
5892 ;; cache. Otherwise record that there is nothing
5893 ;; more to parse in this element at this depth.
5898 ;; Process NEXT, if any, in order to know if we need
5899 ;; to skip it, return it or move into it.
5906 ;; Skip objects ending before point. Also skip
5907 ;; objects ending at point unless it is also the
5908 ;; end of buffer, since we want to return the
5909 ;; innermost object.
5912 ;; For convenience, when object ends at POS,
5913 ;; without any space, store it in LAST, as we
5914 ;; will return it if no object starts here.
5918 ;; If POS is within a container object, move
5919 ;; into that object.
5923 ;; At contents' end, if there is no
5924 ;; space before point, also move into
5925 ;; object, for consistency with
5926 ;; convenience feature above.
5935 next nil
5936 object-data nil))
5937 ;; Otherwise, return NEXT.
5939 ;; Store results in cache, if applicable.
5943 "List all ancestors of a given element or object.
5945 BLOB is an object or element.
5947 When optional argument TYPES is a list of symbols, return the
5948 first element or object in the lineage whose type belongs to that
5949 list.
5951 When optional argument WITH-SELF is non-nil, lineage includes
5952 BLOB itself as the first element, and TYPES, if provided, also
5953 apply to it.
5955 When BLOB is obtained through `org-element-context' or
5956 `org-element-at-point', only ancestors from its section can be
5957 found. There is no such limitation when BLOB belongs to a full
5958 parse tree."
5960 ancestors)
5967 "Non-nil when elements ELEM-A and ELEM-B are nested."
5976 "Swap elements ELEM-A and ELEM-B.
5977 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5978 end of ELEM-A."
5980 ;; There are two special cases when an element doesn't start at bol:
5981 ;; the first paragraph in an item or in a footnote definition.
5983 ;; Only a paragraph without any affiliated keyword can be moved at
5984 ;; ELEM-A position in such a situation. Note that the case of
5985 ;; a footnote definition is impossible: it cannot contain two
5986 ;; paragraphs in a row because it cannot contain a blank line.
5992 ;; In a special situation, ELEM-A will have no indentation. We'll
5993 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6007 ;; Store inner overlays responsible for visibility status.
6008 ;; We also need to store their boundaries as they will be
6009 ;; removed from buffer.
6024 ;; Get contents.
6032 ;; Restore ex ELEM-A overlays.
6039 ;; Restore ex ELEM-B overlays.
6047 ;; Local variables:
6048 ;; generated-autoload-file: "org-loaddefs.el"
6049 ;; End:
6051 ;;; org-element.el ends here