| blob | 8745ef37b4cc22c92c42c0431b8bccf08c00eea0 |
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 \f
426 ;;; Accessors and Setters
427 ;;
428 ;; Provide four accessors: `org-element-type', `org-element-property'
429 ;; `org-element-contents' and `org-element-restriction'.
430 ;;
431 ;; Setter functions allow modification of elements by side effect.
432 ;; There is `org-element-put-property', `org-element-set-contents'.
433 ;; These low-level functions are useful to build a parse tree.
434 ;;
435 ;; `org-element-adopt-element', `org-element-set-element',
436 ;; `org-element-extract-element' and `org-element-insert-before' are
437 ;; high-level functions useful to modify a parse tree.
438 ;;
439 ;; `org-element-secondary-p' is a predicate used to know if a given
440 ;; object belongs to a secondary string. `org-element-copy' returns
441 ;; an element or object, stripping its parent property in the process.
444 "Return type of ELEMENT.
446 The function returns the type of the element or object provided.
447 It can also return the following special value:
448 `plain-text' for a string
449 `org-data' for a complete document
450 nil in any other case."
456 "Extract the value from the PROPERTY of an ELEMENT."
461 "Extract contents from an ELEMENT."
467 "Return restriction associated to ELEMENT.
468 ELEMENT can be an element, an object or a symbol representing an
469 element or object type."
471 org-element-object-restrictions)))
474 "In ELEMENT set PROPERTY to VALUE.
475 Return modified element."
478 element))
481 "Set ELEMENT's contents to CONTENTS.
482 Return ELEMENT."
489 "Non-nil when OBJECT directly belongs to a secondary string.
490 Return value is the property name, as a keyword, or nil."
493 org-element-secondary-value-alist))))
500 "Append elements to the contents of another element.
502 PARENT is an element or object. CHILDREN can be elements,
503 objects, or a strings.
505 The function takes care of setting `:parent' property for CHILD.
506 Return parent element."
508 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
509 ;; string: parent is the list itself.
512 ;; Add CHILDREN at the end of PARENT contents.
515 parent
517 ;; Return modified PARENT element.
521 "Extract ELEMENT from parse tree.
522 Remove element from the parse tree by side-effect, and return it
523 with its `:parent' property stripped out."
528 parent secondary
531 parent
533 ;; Return ELEMENT with its :parent removed.
537 "Insert ELEMENT before LOCATION in parse tree.
538 LOCATION is an element, object or string within the parse tree.
539 Parse tree is modified by side effect."
544 ;; Special case: LOCATION is the first element of an
545 ;; independent secondary string (e.g. :title property). Add
546 ;; ELEMENT in-place.
550 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
560 ;; Store SIBLINGS at appropriate place in parse tree.
565 ;; Set appropriate :parent property.
569 "Replace element or object OLD with element or object NEW.
570 The function takes care of setting `:parent' property for NEW."
571 ;; Ensure OLD and NEW have the same parent.
575 ;; We cannot replace OLD with NEW since one of them is not an
576 ;; object or element. We take the long path.
579 ;; Since OLD is going to be changed into NEW by side-effect, first
580 ;; make sure that every element or object within NEW has OLD as
581 ;; parent.
584 ;; Transfer contents.
586 ;; Overwrite OLD's properties with NEW's.
588 ;; Transfer type.
592 "Create a new element of type TYPE.
593 Optional argument PROPS, when non-nil, is a plist defining the
594 properties of the element. CHILDREN can be elements, objects or
595 strings."
599 "Return a copy of DATUM.
600 DATUM is an element, object, string or nil. `:parent' property
601 is cleared and contents are removed in the process."
612 \f
613 ;;; Greater elements
614 ;;
615 ;; For each greater element type, we define a parser and an
616 ;; interpreter.
617 ;;
618 ;; A parser returns the element or object as the list described above.
619 ;; Most of them accepts no argument. Though, exceptions exist. Hence
620 ;; every element containing a secondary string (see
621 ;; `org-element-secondary-value-alist') will accept an optional
622 ;; argument to toggle parsing of these secondary strings. Moreover,
623 ;; `item' parser requires current list's structure as its first
624 ;; element.
625 ;;
626 ;; An interpreter accepts two arguments: the list representation of
627 ;; the element or object, and its contents. The latter may be nil,
628 ;; depending on the element or object considered. It returns the
629 ;; appropriate Org syntax, as a string.
630 ;;
631 ;; Parsing functions must follow the naming convention:
632 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
633 ;; defined in `org-element-greater-elements'.
634 ;;
635 ;; Similarly, interpreting functions must follow the naming
636 ;; convention: org-element-TYPE-interpreter.
637 ;;
638 ;; With the exception of `headline' and `item' types, greater elements
639 ;; cannot contain other greater elements of their own type.
640 ;;
641 ;; Beside implementing a parser and an interpreter, adding a new
642 ;; greater element requires tweaking `org-element--current-element'.
643 ;; Moreover, the newly defined type must be added to both
644 ;; `org-element-all-elements' and `org-element-greater-elements'.
647 ;;;; Center Block
650 "Parse a center block.
652 LIMIT bounds the search. AFFILIATED is a list of which CAR is
653 the buffer position at the beginning of the first affiliated
654 keyword and CDR is a plist of affiliated keywords along with
655 their value.
657 Return a list whose CAR is `center-block' and CDR is a plist
658 containing `:begin', `:end', `:contents-begin', `:contents-end',
659 `:post-blank' and `:post-affiliated' keywords.
661 Assume point is at the beginning of the block."
665 ;; Incomplete block: parse it as a paragraph.
670 ;; Empty blocks have no contents.
684 :end end
685 :contents-begin contents-begin
686 :contents-end contents-end
692 "Interpret a center-block element as Org syntax.
693 CONTENTS is the contents of the element."
697 ;;;; Drawer
700 "Parse a drawer.
702 LIMIT bounds the search. AFFILIATED is a list of which CAR is
703 the buffer position at the beginning of the first affiliated
704 keyword and CDR is a plist of affiliated keywords along with
705 their value.
707 Return a list whose CAR is `drawer' and CDR is a plist containing
708 `:drawer-name', `:begin', `:end', `:contents-begin',
709 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
711 Assume point is at beginning of drawer."
714 ;; Incomplete drawer: parse it as a paragraph.
722 ;; Empty drawers have no contents.
735 :end end
736 :drawer-name name
737 :contents-begin contents-begin
738 :contents-end contents-end
744 "Interpret DRAWER element as Org syntax.
745 CONTENTS is the contents of the element."
748 contents))
751 ;;;; Dynamic Block
754 "Parse a dynamic block.
756 LIMIT bounds the search. AFFILIATED is a list of which CAR is
757 the buffer position at the beginning of the first affiliated
758 keyword and CDR is a plist of affiliated keywords along with
759 their value.
761 Return a list whose CAR is `dynamic-block' and CDR is a plist
762 containing `:block-name', `:begin', `:end', `:contents-begin',
763 `:contents-end', `:arguments', `:post-blank' and
764 `:post-affiliated' keywords.
766 Assume point is at beginning of dynamic block."
770 ;; Incomplete block: parse it as a paragraph.
779 ;; Empty blocks have no contents.
792 :end end
793 :block-name name
794 :arguments arguments
795 :contents-begin contents-begin
796 :contents-end contents-end
802 "Interpret DYNAMIC-BLOCK element as Org syntax.
803 CONTENTS is the contents of the element."
808 contents))
811 ;;;; Footnote Definition
820 "Parse a footnote definition.
822 LIMIT bounds the search. AFFILIATED is a list of which CAR is
823 the buffer position at the beginning of the first affiliated
824 keyword and CDR is a plist of affiliated keywords along with
825 their value.
827 Return a list whose CAR is `footnote-definition' and CDR is
828 a plist containing `:label', `:begin' `:end', `:contents-begin',
829 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
831 Assume point is at the beginning of the footnote definition."
843 limit)
845 ;; At a new footnote definition, make sure we end
846 ;; before any affiliated keyword above.
867 :begin begin
868 :end end
869 :contents-begin contents-begin
870 :contents-end contents-end
876 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
877 CONTENTS is the contents of the footnote-definition."
879 " "
880 contents))
883 ;;;; Headline
886 "Return node properties associated to headline at point.
887 Upcase property names. It avoids confusion between properties
888 obtained through property drawer and default properties from the
889 parser (e.g. `:end' and :END:). Return value is a plist."
901 properties))))
904 "Return time properties associated to headline at point.
905 Return value is a plist."
919 plist))))
922 "Parse a headline.
924 Return a list whose CAR is `headline' and CDR is a plist
925 containing `:raw-value', `:title', `:begin', `:end',
926 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
927 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
928 `:deadline', `:closed', `:archivedp', `:commentedp'
929 `:footnote-section-p', `:post-blank' and `:post-affiliated'
930 keywords.
932 The plist also contains any property set in the property drawer,
933 with its name in upper cases and colons added at the
934 beginning (e.g., `:CUSTOM_ID').
936 LIMIT is a buffer position bounding the search.
938 When RAW-SECONDARY-P is non-nil, headline's title will not be
939 parsed as a secondary string, but as a plain string instead.
941 Assume point is at beginning of the headline."
988 :begin begin
989 :end end
990 :pre-blank
993 :contents-begin contents-begin
994 :contents-end contents-end
995 :level level
996 :priority priority
997 :tags tags
998 :todo-keyword todo
999 :todo-type todo-type
1002 end)
1003 :footnote-section-p footnote-section-p
1004 :archivedp archivedp
1005 :commentedp commentedp
1007 time-props
1008 standard-props))))
1010 headline :title
1019 nil
1021 headline)))))))
1024 "Interpret HEADLINE element as Org syntax.
1025 CONTENTS is the contents of the element."
1038 ?*)
1042 " "
1045 org-footnote-section
1046 title))))
1048 heading
1049 ;; Align tags.
1057 ?\s)
1058 tags))
1062 tags))))
1064 contents)))
1067 ;;;; Inlinetask
1070 "Parse an inline task.
1072 Return a list whose CAR is `inlinetask' and CDR is a plist
1073 containing `:title', `:begin', `:end', `:contents-begin' and
1074 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1075 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1076 `:closed', `:post-blank' and `:post-affiliated' keywords.
1078 The plist also contains any property set in the property drawer,
1079 with its name in upper cases and colons added at the
1080 beginning (e.g., `:CUSTOM_ID').
1082 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1083 title will not be parsed as a secondary string, but as a plain
1084 string instead.
1086 Assume point is at beginning of the inline task."
1131 :begin begin
1132 :end end
1133 :contents-begin contents-begin
1134 :contents-end contents-end
1135 :level level
1136 :priority priority
1137 :tags tags
1138 :todo-keyword todo
1139 :todo-type todo-type
1142 time-props
1143 standard-props))))
1145 inlinetask :title
1154 nil
1156 inlinetask))))))
1159 "Interpret INLINETASK element as Org syntax.
1160 CONTENTS is the contents of inlinetask."
1174 ;; Align tags.
1182 ? )
1183 tags))
1187 tags))))
1188 ;; Prefer degenerate inlinetasks when there are no
1189 ;; contents.
1192 contents
1196 ;;;; Item
1199 "Parse an item.
1201 STRUCT is the structure of the plain list.
1203 Return a list whose CAR is `item' and CDR is a plist containing
1204 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1205 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1206 `:post-affiliated' keywords.
1208 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1209 any, will not be parsed as a secondary string, but as a plain
1210 string instead.
1212 Assume point is at the beginning of the item."
1235 ;; Ignore tags in un-ordered lists: they are just
1236 ;; a part of item's body.
1243 ;; If first line isn't empty, contents really
1244 ;; start at the text after item's meta-data.
1254 :begin begin
1255 :end end
1256 :contents-begin contents-begin
1257 :contents-end contents-end
1258 :checkbox checkbox
1259 :counter counter
1260 :structure struct
1264 item :tag
1271 item))))))))
1274 "Interpret ITEM element as Org syntax.
1275 CONTENTS is the contents of the element."
1285 ;; Compute indentation.
1290 ;; Indent contents.
1292 bullet
1307 ;;;; Plain List
1310 ;; Return structure of list at point. Internal function. See
1311 ;; `org-list-struct' for details.
1316 items struct)
1321 ;; At limit: end all items.
1330 ;; At list end: end all items.
1335 ;; At a new item: end previous sibling.
1347 ind
1348 bullet
1351 ;; Description tag.
1355 ;; Ending position, unknown so far.
1356 nil)))
1357 items))
1359 ;; Skip empty lines.
1361 ;; Skip inline tasks and blank lines along the way.
1368 ;; At some text line. Check if it ends any previous item.
1381 ;; Skip blocks (any type) and drawers contents.
1386 limit t)))
1392 "Parse a plain list.
1394 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1395 the buffer position at the beginning of the first affiliated
1396 keyword and CDR is a plist of affiliated keywords along with
1397 their value. STRUCTURE is the structure of the plain list being
1398 parsed.
1400 Return a list whose CAR is `plain-list' and CDR is a plist
1401 containing `:type', `:begin', `:end', `:contents-begin' and
1402 `:contents-end', `:structure', `:post-blank' and
1403 `:post-affiliated' keywords.
1405 Assume point is at the beginning of the list."
1419 pos))
1423 ;; Return value.
1427 :begin begin
1428 :end end
1429 :contents-begin contents-begin
1430 :contents-end contents-end
1431 :structure struct
1437 "Interpret plain-list element as Org syntax.
1438 CONTENTS is the contents of the element."
1446 ;;;; Property Drawer
1449 "Parse a property drawer.
1451 LIMIT bounds the search.
1453 Return a list whose car is `property-drawer' and cdr is a plist
1454 containing `:begin', `:end', `:contents-begin', `:contents-end',
1455 `:post-blank' and `:post-affiliated' keywords.
1457 Assume point is at the beginning of the property drawer."
1470 :end end
1472 :contents-end contents-end
1477 "Interpret property-drawer element as Org syntax.
1478 CONTENTS is the properties within the drawer."
1482 ;;;; Quote Block
1485 "Parse a quote block.
1487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1488 the buffer position at the beginning of the first affiliated
1489 keyword and CDR is a plist of affiliated keywords along with
1490 their value.
1492 Return a list whose CAR is `quote-block' and CDR is a plist
1493 containing `:begin', `:end', `:contents-begin', `:contents-end',
1494 `:post-blank' and `:post-affiliated' keywords.
1496 Assume point is at the beginning of the block."
1500 ;; Incomplete block: parse it as a paragraph.
1506 ;; Empty blocks have no contents.
1519 :end end
1520 :contents-begin contents-begin
1521 :contents-end contents-end
1527 "Interpret quote-block element as Org syntax.
1528 CONTENTS is the contents of the element."
1532 ;;;; Section
1535 "Parse a section.
1537 Return a list whose CAR is `section' and CDR is a plist
1538 containing `:begin', `:end', `:contents-begin', `contents-end',
1539 `:post-blank' and `:post-affiliated' keywords."
1541 ;; Beginning of section is the beginning of the first non-blank
1542 ;; line after previous headline.
1550 :end end
1551 :contents-begin begin
1552 :contents-end pos-before-blank
1557 "Interpret section element as Org syntax.
1558 CONTENTS is the contents of the element."
1559 contents)
1562 ;;;; Special Block
1565 "Parse a special block.
1567 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1568 the buffer position at the beginning of the first affiliated
1569 keyword and CDR is a plist of affiliated keywords along with
1570 their value.
1572 Return a list whose CAR is `special-block' and CDR is a plist
1573 containing `:type', `:begin', `:end', `:contents-begin',
1574 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1576 Assume point is at the beginning of the block."
1583 limit t)))
1584 ;; Incomplete block: parse it as a paragraph.
1590 ;; Empty blocks have no contents.
1603 :begin begin
1604 :end end
1605 :contents-begin contents-begin
1606 :contents-end contents-end
1612 "Interpret SPECIAL-BLOCK element as Org syntax.
1613 CONTENTS is the contents of the element."
1618 \f
1619 ;;; Elements
1620 ;;
1621 ;; For each element, a parser and an interpreter are also defined.
1622 ;; Both follow the same naming convention used for greater elements.
1623 ;;
1624 ;; Also, as for greater elements, adding a new element type is done
1625 ;; through the following steps: implement a parser and an interpreter,
1626 ;; tweak `org-element--current-element' so that it recognizes the new
1627 ;; type and add that new type to `org-element-all-elements'.
1630 ;;;; Babel Call
1633 "Parse a babel call.
1635 LIMIT bounds the search. AFFILIATED is a list of which car is
1636 the buffer position at the beginning of the first affiliated
1637 keyword and cdr is a plist of affiliated keywords along with
1638 their value.
1640 Return a list whose car is `babel-call' and cdr is a plist
1641 containing `:call', `:inside-header', `:arguments',
1642 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1643 `:post-affiliated' as keywords."
1657 value)))
1667 :begin begin
1668 :end end
1669 :value value
1675 "Interpret BABEL-CALL element as Org syntax."
1685 ;;;; Clock
1688 "Parse a clock.
1690 LIMIT bounds the search.
1692 Return a list whose CAR is `clock' and CDR is a plist containing
1693 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1694 `:post-affiliated' as keywords."
1714 :value value
1715 :duration duration
1716 :begin begin
1717 :end end
1718 :post-blank post-blank
1722 "Interpret CLOCK element as Org syntax."
1730 "%2s:%02s"
1734 ;;;; Comment
1737 "Parse a comment.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `comment' and CDR is a plist
1745 containing `:begin', `:end', `:value', `:post-blank',
1746 `:post-affiliated' keywords.
1748 Assume point is at comment beginning."
1757 ;; Get comments ending.
1760 ;; Accumulate lines without leading hash and first
1761 ;; whitespace.
1775 :end end
1776 :value value
1782 "Interpret COMMENT element as Org syntax.
1783 CONTENTS is nil."
1787 ;;;; Comment Block
1790 "Parse an export block.
1792 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1793 the buffer position at the beginning of the first affiliated
1794 keyword and CDR is a plist of affiliated keywords along with
1795 their value.
1797 Return a list whose CAR is `comment-block' and CDR is a plist
1798 containing `:begin', `:end', `:value', `:post-blank' and
1799 `:post-affiliated' keywords.
1801 Assume point is at comment block beginning."
1805 ;; Incomplete block: parse it as a paragraph.
1818 contents-begin contents-end)))
1822 :end end
1823 :value value
1829 "Interpret COMMENT-BLOCK element as Org syntax."
1836 ;;;; Diary Sexp
1839 "Parse a diary sexp.
1841 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1842 the buffer position at the beginning of the first affiliated
1843 keyword and CDR is a plist of affiliated keywords along with
1844 their value.
1846 Return a list whose CAR is `diary-sexp' and CDR is a plist
1847 containing `:begin', `:end', `:value', `:post-blank' and
1848 `:post-affiliated' keywords."
1860 :begin begin
1861 :end end
1867 "Interpret DIARY-SEXP as Org syntax."
1871 ;;;; Example Block
1874 "Parse an example block.
1876 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1877 the buffer position at the beginning of the first affiliated
1878 keyword and CDR is a plist of affiliated keywords along with
1879 their value.
1881 Return a list whose CAR is `example-block' and CDR is a plist
1882 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1883 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1884 `:value', `:post-blank' and `:post-affiliated' keywords."
1888 ;; Incomplete block: parse it as a paragraph.
1896 ;; Switches analysis.
1900 switches)
1903 'new
1906 ;; Subtract 1 to give number of lines before
1907 ;; first line.
1911 ;; Should labels be retained in (or stripped from) example
1912 ;; blocks?
1917 ;; What should code-references use - labels or
1918 ;; line-numbers?
1927 ;; Standard block parsing.
1933 contents-begin contents-end)))
1942 :end end
1943 :value value
1944 :switches switches
1945 :number-lines number-lines
1946 :preserve-indent preserve-indent
1947 :retain-labels retain-labels
1948 :use-labels use-labels
1949 :label-fmt label-fmt
1955 "Interpret EXAMPLE-BLOCK element as Org syntax."
1963 value
1968 ;;;; Export Block
1971 "Parse an export block.
1973 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1974 the buffer position at the beginning of the first affiliated
1975 keyword and CDR is a plist of affiliated keywords along with
1976 their value.
1978 Return a list whose CAR is `export-block' and CDR is a plist
1979 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1980 `:post-affiliated' keywords.
1982 Assume point is at export-block beginning."
1986 ;; Incomplete block: parse it as a paragraph.
2005 contents-end))))
2009 :begin begin
2010 :end end
2011 :value value
2017 "Interpret EXPORT-BLOCK element as Org syntax."
2023 ;;;; Fixed-width
2026 "Parse a fixed-width section.
2028 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2029 the buffer position at the beginning of the first affiliated
2030 keyword and CDR is a plist of affiliated keywords along with
2031 their value.
2033 Return a list whose CAR is `fixed-width' and CDR is a plist
2034 containing `:begin', `:end', `:value', `:post-blank' and
2035 `:post-affiliated' keywords.
2037 Assume point is at the beginning of the fixed-width area."
2041 value
2046 ;; Accumulate text without starting colons.
2059 :end end
2060 :value value
2066 "Interpret FIXED-WIDTH element as Org syntax."
2074 ;;;; Horizontal Rule
2077 "Parse an horizontal rule.
2079 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2080 the buffer position at the beginning of the first affiliated
2081 keyword and CDR is a plist of affiliated keywords along with
2082 their value.
2084 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2085 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2086 keywords."
2096 :end end
2102 "Interpret HORIZONTAL-RULE element as Org syntax."
2106 ;;;; Keyword
2109 "Parse a keyword at point.
2111 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2112 the buffer position at the beginning of the first affiliated
2113 keyword and CDR is a plist of affiliated keywords along with
2114 their value.
2116 Return a list whose CAR is `keyword' and CDR is a plist
2117 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2118 `:post-affiliated' keywords."
2120 ;; An orphaned affiliated keyword is considered as a regular
2121 ;; keyword. In this case AFFILIATED is nil, so we take care of
2122 ;; this corner case.
2135 :value value
2136 :begin begin
2137 :end end
2143 "Interpret KEYWORD element as Org syntax."
2149 ;;;; Latex Environment
2153 "Regexp matching the beginning of a LaTeX environment.
2154 The environment is captured by the first group.
2160 "Format string matching the ending of a LaTeX environment.
2164 "Parse a LaTeX environment.
2166 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2167 the buffer position at the beginning of the first affiliated
2168 keyword and CDR is a plist of affiliated keywords along with
2169 their value.
2171 Return a list whose CAR is `latex-environment' and CDR is a plist
2172 containing `:begin', `:end', `:value', `:post-blank' and
2173 `:post-affiliated' keywords.
2175 Assume point is at the beginning of the latex environment."
2182 limit t))
2183 ;; Incomplete latex environment: parse it as a paragraph.
2193 :end end
2194 :value value
2200 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2204 ;;;; Node Property
2207 "Parse a node-property at point.
2209 LIMIT bounds the search.
2211 Return a list whose CAR is `node-property' and CDR is a plist
2212 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2213 `:post-affiliated' keywords."
2223 limit))))
2226 :value value
2227 :begin begin
2228 :end end
2233 "Interpret NODE-PROPERTY element as Org syntax."
2239 ;;;; Paragraph
2242 "Parse a paragraph.
2244 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2245 the buffer position at the beginning of the first affiliated
2246 keyword and CDR is a plist of affiliated keywords along with
2247 their value.
2249 Return a list whose CAR is `paragraph' and CDR is a plist
2250 containing `:begin', `:end', `:contents-begin' and
2251 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2253 Assume point is at the beginning of the paragraph."
2260 ;; A matching `org-element-paragraph-separate' is not
2261 ;; necessarily the end of the paragraph. In particular,
2262 ;; drawers, blocks or LaTeX environments opening lines
2263 ;; must be closed. Moreover keywords with a secondary
2264 ;; value must belong to "dual keywords".
2278 limit t)))
2284 limit t)))
2287 org-element-dual-keywords))
2288 ;; Everything else is unambiguous.
2301 :end end
2302 :contents-begin contents-begin
2303 :contents-end contents-end
2309 "Interpret paragraph element as Org syntax.
2310 CONTENTS is the contents of the element."
2311 contents)
2314 ;;;; Planning
2317 "Parse a planning.
2319 LIMIT bounds the search.
2321 Return a list whose CAR is `planning' and CDR is a plist
2322 containing `:closed', `:deadline', `:scheduled', `:begin',
2323 `:end', `:post-blank' and `:post-affiliated' keywords."
2333 closed deadline scheduled)
2345 :deadline deadline
2346 :scheduled scheduled
2347 :begin begin
2348 :end end
2349 :post-blank post-blank
2353 "Interpret PLANNING element as Org syntax."
2355 #'identity
2372 ;;;; Src Block
2375 "Parse a src block.
2377 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2378 the buffer position at the beginning of the first affiliated
2379 keyword and CDR is a plist of affiliated keywords along with
2380 their value.
2382 Return a list whose CAR is `src-block' and CDR is a plist
2383 containing `:language', `:switches', `:parameters', `:begin',
2384 `:end', `:number-lines', `:retain-labels', `:use-labels',
2385 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2386 `:post-affiliated' keywords.
2388 Assume point is at the beginning of the block."
2391 limit t)))
2392 ;; Incomplete block: parse it as a paragraph.
2398 ;; Get language as a string.
2407 ;; Get switches.
2409 ;; Get parameters.
2411 ;; Switches analysis.
2415 switches)
2418 'new
2421 ;; Subtract 1 to give number of lines before
2422 ;; first line.
2430 ;; Should labels be retained in (or stripped from)
2431 ;; src blocks?
2436 ;; What should code-references use - labels or
2437 ;; line-numbers?
2442 ;; Retrieve code.
2449 ;; Get position after ending blank lines.
2459 :begin begin
2460 :end end
2461 :number-lines number-lines
2462 :preserve-indent preserve-indent
2463 :retain-labels retain-labels
2464 :use-labels use-labels
2465 :label-fmt label-fmt
2466 :value value
2472 "Interpret SRC-BLOCK element as Org syntax."
2481 val)
2496 ;;;; Table
2499 "Parse a table at point.
2501 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2502 the buffer position at the beginning of the first affiliated
2503 keyword and CDR is a plist of affiliated keywords along with
2504 their value.
2506 Return a list whose CAR is `table' and CDR is a plist containing
2507 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2508 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2509 keywords.
2511 Assume point is at the beginning of the table."
2527 acc))
2534 :end end
2535 :type type
2536 :tblfm tblfm
2537 ;; Only `org' tables have contents. `table.el' tables
2538 ;; use a `:value' property to store raw table as
2539 ;; a string.
2544 table-begin table-end))
2550 "Interpret TABLE element as Org syntax.
2551 CONTENTS is a string, if table's type is `org', or nil."
2562 ;;;; Table Row
2565 "Parse table row at point.
2567 Return a list whose CAR is `table-row' and CDR is a plist
2568 containing `:begin', `:end', `:contents-begin', `:contents-end',
2569 `:type', `:post-blank' and `:post-affiliated' keywords."
2573 ;; A table rule has no contents. In that case, ensure
2574 ;; CONTENTS-BEGIN matches CONTENTS-END.
2584 :begin begin
2585 :end end
2586 :contents-begin contents-begin
2587 :contents-end contents-end
2592 "Interpret TABLE-ROW element as Org syntax.
2593 CONTENTS is the contents of the table row."
2598 ;;;; Verse Block
2601 "Parse a verse block.
2603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2604 the buffer position at the beginning of the first affiliated
2605 keyword and CDR is a plist of affiliated keywords along with
2606 their value.
2608 Return a list whose CAR is `verse-block' and CDR is a plist
2609 containing `:begin', `:end', `:contents-begin', `:contents-end',
2610 `:post-blank' and `:post-affiliated' keywords.
2612 Assume point is at beginning of the block."
2616 ;; Incomplete block: parse it as a paragraph.
2631 :end end
2632 :contents-begin contents-begin
2633 :contents-end contents-end
2639 "Interpret verse-block element as Org syntax.
2640 CONTENTS is verse block contents."
2644 \f
2645 ;;; Objects
2646 ;;
2647 ;; Unlike to elements, raw text can be found between objects. Hence,
2648 ;; `org-element--object-lex' is provided to find the next object in
2649 ;; buffer.
2650 ;;
2651 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2652 ;; object types they can contain will be specified in
2653 ;; `org-element-object-restrictions'.
2654 ;;
2655 ;; Creating a new type of object requires to alter
2656 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2657 ;; new type in `org-element-all-objects', and possibly add
2658 ;; restrictions in `org-element-object-restrictions'.
2660 ;;;; Bold
2663 "Parse bold object at point, if any.
2665 When at a bold object, return a list whose car is `bold' and cdr
2666 is a plist with `:begin', `:end', `:contents-begin' and
2667 `:contents-end' and `:post-blank' keywords. Otherwise, return
2668 nil.
2670 Assume point is at the first star marker."
2682 :end end
2683 :contents-begin contents-begin
2684 :contents-end contents-end
2688 "Interpret bold object as Org syntax.
2689 CONTENTS is the contents of the object."
2693 ;;;; Code
2696 "Parse code object at point, if any.
2698 When at a code object, return a list whose car is `code' and cdr
2699 is a plist with `:value', `:begin', `:end' and `:post-blank'
2700 keywords. Otherwise, return nil.
2702 Assume point is at the first tilde marker."
2713 :begin begin
2714 :end end
2718 "Interpret CODE object as Org syntax."
2722 ;;;; Entity
2725 "Parse entity at point, if any.
2727 When at an entity, return a list whose car is `entity' and cdr
2728 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2729 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2730 `:post-blank' as keywords. Otherwise, return nil.
2732 Assume point is at the beginning of the entity."
2734 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2752 :begin begin
2753 :end end
2754 :use-brackets-p bracketsp
2758 "Interpret ENTITY object as Org syntax."
2764 ;;;; Export Snippet
2767 "Parse export snippet at point.
2769 When at an export snippet, return a list whose car is
2770 `export-snippet' and cdr a plist with `:begin', `:end',
2771 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2772 return nil.
2774 Assume point is at the beginning of the snippet."
2790 :value value
2791 :begin begin
2792 :end end
2796 "Interpret EXPORT-SNIPPET object as Org syntax."
2802 ;;;; Footnote Reference
2805 "Parse footnote reference at point, if any.
2807 When at a footnote reference, return a list whose car is
2808 `footnote-reference' and cdr a plist with `:label', `:type',
2809 `:begin', `:end', `:content-begin', `:contents-end' and
2810 `:post-blank' as keywords. Otherwise, return nil."
2826 :type type
2827 :begin begin
2828 :end end
2834 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2835 CONTENTS is its definition, when inline, or nil."
2841 ;;;; Inline Babel Call
2844 "Parse inline babel call at point, if any.
2846 When at an inline babel call, return a list whose car is
2847 `inline-babel-call' and cdr a plist with `:call',
2848 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2849 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2851 Assume point is at the beginning of the babel call."
2867 ;; Invalid inline source block.
2885 :inside-header inside-header
2886 :arguments arguments
2887 :end-header end-header
2888 :begin begin
2889 :end end
2890 :value value
2894 "Interpret INLINE-BABEL-CALL object as Org syntax."
2904 ;;;; Inline Src Block
2907 "Parse inline source block at point, if any.
2909 When at an inline source block, return a list whose car is
2910 `inline-src-block' and cdr a plist with `:begin', `:end',
2911 `:language', `:value', `:parameters' and `:post-blank' as
2912 keywords. Otherwise, return nil.
2914 Assume point is at the beginning of the inline src block."
2930 ;; Invalid inline source block.
2938 :value value
2939 :parameters parameters
2940 :begin begin
2945 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2950 language
2952 body)))
2954 ;;;; Italic
2957 "Parse italic object at point, if any.
2959 When at an italic object, return a list whose car is `italic' and
2960 cdr is a plist with `:begin', `:end', `:contents-begin' and
2961 `:contents-end' and `:post-blank' keywords. Otherwise, return
2962 nil.
2964 Assume point is at the first slash marker."
2976 :end end
2977 :contents-begin contents-begin
2978 :contents-end contents-end
2982 "Interpret italic object as Org syntax.
2983 CONTENTS is the contents of the object."
2987 ;;;; Latex Fragment
2990 "Parse LaTeX fragment at point, if any.
2992 When at a LaTeX fragment, return a list whose car is
2993 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2994 and `:post-blank' as keywords. Otherwise, return nil.
2996 Assume point is at the beginning of the LaTeX fragment."
3014 ;; Macro.
3024 :begin begin
3025 :end end
3029 "Interpret LATEX-FRAGMENT object as Org syntax."
3032 ;;;; Line Break
3035 "Parse line break at point, if any.
3037 When at a line break, return a list whose car is `line-break',
3038 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3039 Otherwise, return nil.
3041 Assume point is at the beginning of the line break."
3050 "Interpret LINE-BREAK object as Org syntax."
3054 ;;;; Link
3057 "Parse link at point, if any.
3059 When at a link, return a list whose car is `link' and cdr a plist
3060 with `:type', `:path', `:raw-link', `:application',
3061 `:search-option', `:begin', `:end', `:contents-begin',
3062 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3063 nil.
3065 Assume point is at the beginning of the link."
3068 end contents-begin contents-end link-end post-blank path type
3069 raw-link search-option application)
3071 ;; Type 1: Text targeted from a radio target.
3080 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3085 ;; RAW-LINK is the original link. Expand any
3086 ;; abbreviation in it.
3087 ;;
3088 ;; Also treat any newline character and associated
3089 ;; indentation as a single space character. This is not
3090 ;; compatible with RFC 3986, which requires to ignore
3091 ;; them altogether. However, doing so would require
3092 ;; users to encode spaces on the fly when writing links
3093 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3094 ;; [[shell:ls *.org]], which defeats Org's focus on
3095 ;; simplicity.
3100 ;; Determine TYPE of link and set PATH accordingly. According
3101 ;; to RFC 3986, remove whitespaces from URI in external links.
3102 ;; In internal ones, treat indentation as a single space.
3104 ;; File type.
3109 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3113 ;; Id type: PATH is the id.
3116 ;; Code-ref type: PATH is the name of the reference.
3121 ;; Custom-id type: PATH is the name of the custom id.
3125 ;; Fuzzy type: Internal link either matches a target, an
3126 ;; headline name or nothing. PATH is the target or
3127 ;; headline's name.
3131 ;; Type 3: Plain link, e.g., http://orgmode.org
3137 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3138 ;; bracket links, follow RFC 3986 and remove any extra
3139 ;; whitespace in URI.
3149 ;; In any case, deduce end point after trailing white space from
3150 ;; LINK-END variable.
3155 ;; Special "file" type link processing. Extract opening
3156 ;; application and search option, if any. Also normalize URI.
3163 ;; Translate link, if `org-link-translation-function' is set.
3171 :path path
3173 :application application
3174 :search-option search-option
3175 :begin begin
3176 :end end
3177 :contents-begin contents-begin
3178 :contents-end contents-end
3182 "Interpret LINK object as Org syntax.
3183 CONTENTS is the contents of the object, or nil."
3194 path
3201 ;;;; Macro
3204 "Parse macro at point, if any.
3206 When at a macro, return a list whose car is `macro' and cdr
3207 a plist with `:key', `:args', `:begin', `:end', `:value' and
3208 `:post-blank' as keywords. Otherwise, return nil.
3210 Assume point is at the macro."
3223 :value value
3224 :args args
3225 :begin begin
3226 :end end
3230 "Interpret MACRO object as Org syntax."
3234 ;;;; Radio-target
3237 "Parse radio target at point, if any.
3239 When at a radio target, return a list whose car is `radio-target'
3240 and cdr a plist with `:begin', `:end', `:contents-begin',
3241 `:contents-end', `:value' and `:post-blank' as keywords.
3242 Otherwise, return nil.
3244 Assume point is at the radio target."
3256 :end end
3257 :contents-begin contents-begin
3258 :contents-end contents-end
3259 :post-blank post-blank
3263 "Interpret target object as Org syntax.
3264 CONTENTS is the contents of the object."
3268 ;;;; Statistics Cookie
3271 "Parse statistics cookie at point, if any.
3273 When at a statistics cookie, return a list whose car is
3274 `statistics-cookie', and cdr a plist with `:begin', `:end',
3275 `:value' and `:post-blank' keywords. Otherwise, return nil.
3277 Assume point is at the beginning of the statistics-cookie."
3288 :end end
3289 :value value
3293 "Interpret STATISTICS-COOKIE object as Org syntax."
3297 ;;;; Strike-Through
3300 "Parse strike-through object at point, if any.
3302 When at a strike-through object, return a list whose car is
3303 `strike-through' and cdr is a plist with `:begin', `:end',
3304 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3305 Otherwise, return nil.
3307 Assume point is at the first plus sign marker."
3319 :end end
3320 :contents-begin contents-begin
3321 :contents-end contents-end
3325 "Interpret strike-through object as Org syntax.
3326 CONTENTS is the contents of the object."
3330 ;;;; Subscript
3333 "Parse subscript at point, if any.
3335 When at a subscript object, return a list whose car is
3336 `subscript' and cdr a plist with `:begin', `:end',
3337 `:contents-begin', `:contents-end', `:use-brackets-p' and
3338 `:post-blank' as keywords. Otherwise, return nil.
3340 Assume point is at the underscore."
3354 :end end
3355 :use-brackets-p bracketsp
3356 :contents-begin contents-begin
3357 :contents-end contents-end
3361 "Interpret SUBSCRIPT object as Org syntax.
3362 CONTENTS is the contents of the object."
3365 contents))
3368 ;;;; Superscript
3371 "Parse superscript at point, if any.
3373 When at a superscript object, return a list whose car is
3374 `superscript' and cdr a plist with `:begin', `:end',
3375 `:contents-begin', `:contents-end', `:use-brackets-p' and
3376 `:post-blank' as keywords. Otherwise, return nil.
3378 Assume point is at the caret."
3392 :end end
3393 :use-brackets-p bracketsp
3394 :contents-begin contents-begin
3395 :contents-end contents-end
3399 "Interpret SUPERSCRIPT object as Org syntax.
3400 CONTENTS is the contents of the object."
3403 contents))
3406 ;;;; Table Cell
3409 "Parse table cell at point.
3410 Return a list whose car is `table-cell' and cdr is a plist
3411 containing `:begin', `:end', `:contents-begin', `:contents-end'
3412 and `:post-blank' keywords."
3420 :end end
3421 :contents-begin contents-begin
3422 :contents-end contents-end
3426 "Interpret table-cell element as Org syntax.
3427 CONTENTS is the contents of the cell, or nil."
3431 ;;;; Target
3434 "Parse target at point, if any.
3436 When at a target, return a list whose car is `target' and cdr
3437 a plist with `:begin', `:end', `:value' and `:post-blank' as
3438 keywords. Otherwise, return nil.
3440 Assume point is at the target."
3450 :end end
3451 :value value
3455 "Interpret TARGET object as Org syntax."
3459 ;;;; Timestamp
3470 "Parse time stamp at point, if any.
3472 When at a time stamp, return a list whose car is `timestamp', and
3473 cdr a plist with `:type', `:raw-value', `:year-start',
3474 `:month-start', `:day-start', `:hour-start', `:minute-start',
3475 `:year-end', `:month-end', `:day-end', `:hour-end',
3476 `:minute-end', `:repeater-type', `:repeater-value',
3477 `:repeater-unit', `:warning-type', `:warning-value',
3478 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3479 Otherwise, return nil.
3481 Assume point is at the beginning of the timestamp."
3500 date-start)
3511 raw-value)
3513 :repeater-type
3519 :repeater-unit
3528 :warning-unit
3531 year-start month-start day-start hour-start minute-start year-end
3532 month-end day-end hour-end minute-end)
3533 ;; Parse date-start.
3541 ;; Compute date-end. It can be provided directly in time-stamp,
3542 ;; or extracted from time range. Otherwise, it defaults to the
3543 ;; same values as date-start.
3553 :raw-value raw-value
3554 :year-start year-start
3555 :month-start month-start
3556 :day-start day-start
3557 :hour-start hour-start
3558 :minute-start minute-start
3559 :year-end year-end
3560 :month-end month-end
3561 :day-end day-end
3562 :hour-end hour-end
3563 :minute-end minute-end
3564 :begin begin
3565 :end end
3567 repeater-props
3568 warning-props))))))
3571 "Interpret TIMESTAMP object as Org syntax."
3589 ;; Build an Org timestamp string from TIME. ACTIVEP is
3590 ;; non-nil when time stamp is active. If WITH-TIME-P is
3591 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3592 ;; specify a time range in the timestamp. REPEAT-STRING is
3593 ;; the repeater string, if any.
3597 org-time-stamp-formats)
3598 time)))
3604 nil nil ts)))
3609 " "
3610 s
3612 ;; Return value.
3613 ts)))
3625 build-ts-string
3644 0
3652 "--"
3665 ;;;; Underline
3668 "Parse underline object at point, if any.
3670 When at an underline object, return a list whose car is
3671 `underline' and cdr is a plist with `:begin', `:end',
3672 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3673 Otherwise, return nil.
3675 Assume point is at the first underscore marker."
3687 :end end
3688 :contents-begin contents-begin
3689 :contents-end contents-end
3693 "Interpret underline object as Org syntax.
3694 CONTENTS is the contents of the object."
3698 ;;;; Verbatim
3701 "Parse verbatim object at point, if any.
3703 When at a verbatim object, return a list whose car is `verbatim'
3704 and cdr is a plist with `:value', `:begin', `:end' and
3705 `:post-blank' keywords. Otherwise, return nil.
3707 Assume point is at the first equal sign marker."
3718 :begin begin
3719 :end end
3723 "Interpret VERBATIM object as Org syntax."
3727 \f
3728 ;;; Parsing Element Starting At Point
3729 ;;
3730 ;; `org-element--current-element' is the core function of this section.
3731 ;; It returns the Lisp representation of the element starting at
3732 ;; point.
3733 ;;
3734 ;; `org-element--current-element' makes use of special modes. They
3735 ;; are activated for fixed element chaining (e.g., `plain-list' >
3736 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3737 ;; `section'). Special modes are: `first-section', `item',
3738 ;; `node-property', `section' and `table-row'.
3741 "Parse the element starting at point.
3743 Return value is a list like (TYPE PROPS) where TYPE is the type
3744 of the element and PROPS a plist of properties associated to the
3745 element.
3747 Possible types are defined in `org-element-all-elements'.
3749 LIMIT bounds the search.
3751 Optional argument GRANULARITY determines the depth of the
3752 recursion. Allowed values are `headline', `greater-element',
3753 `element', `object' or nil. When it is broader than `object' (or
3754 nil), secondary values will not be parsed, since they only
3755 contain objects.
3757 Optional argument MODE, when non-nil, can be either
3758 `first-section', `section', `planning', `item', `node-property'
3759 and `table-row'.
3761 If STRUCTURE isn't provided but MODE is set to `item', it will be
3762 computed.
3764 This function assumes point is always at the beginning of the
3765 element it has to parse."
3768 ;; Determine if parsing depth allows for secondary strings
3769 ;; parsing. It only applies to elements referenced in
3770 ;; `org-element-secondary-value-alist'.
3773 ;; Item.
3776 ;; Table Row.
3778 ;; Node Property.
3780 ;; Headline.
3783 ;; Sections (must be checked after headline).
3788 limit)))
3789 ;; Planning.
3792 ;; Property drawer.
3796 ;; When not at bol, point is at the beginning of an item or
3797 ;; a footnote definition: next item is always a paragraph.
3799 ;; Clock.
3801 ;; Inlinetask.
3804 ;; From there, elements can have affiliated keywords.
3807 ;; Jumping over affiliated keywords put point off-limits.
3808 ;; Parse them as regular keywords.
3812 ;; LaTeX Environment.
3815 ;; Drawer and Property Drawer.
3818 ;; Fixed Width
3821 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3822 ;; Keywords.
3840 limit
3841 affiliated))
3854 ;; Footnote Definition.
3857 ;; Horizontal Rule.
3860 ;; Diary Sexp.
3863 ;; Table.
3866 ;; List.
3869 limit affiliated
3871 ;; Default element: Paragraph.
3875 ;; Most elements can have affiliated keywords. When looking for an
3876 ;; element beginning, we want to move before them, as they belong to
3877 ;; that element, and, in the meantime, collect information they give
3878 ;; into appropriate properties. Hence the following function.
3881 "Collect affiliated keywords from point down to LIMIT.
3883 Return a list whose CAR is the position at the first of them and
3884 CDR a plist of keywords and values and move point to the
3885 beginning of the first line after them.
3887 As a special case, if element doesn't start at the beginning of
3888 the line (e.g., a paragraph starting an item), CAR is current
3889 position of point and CDR is nil."
3893 ;; RESTRICT is the list of objects allowed in parsed
3894 ;; keywords value.
3896 output)
3899 ;; Apply translation to RAW-KWD. From there, KWD is
3900 ;; the official keyword.
3902 org-element-keyword-translation-alist))
3903 raw-kwd))
3904 ;; Find main value for any keyword.
3910 ;; PARSEDP is non-nil when keyword should have its
3911 ;; value parsed.
3913 ;; If KWD is a dual keyword, find its secondary
3914 ;; value. Maybe parse it.
3923 ;; Attribute a property name to KWD.
3925 ;; Now set final shape for VALUE.
3931 nil restrict)))
3935 ;; Attributes can always appear on multiple lines.
3938 ;; Eventually store the new value in OUTPUT.
3940 ;; Move to next keyword.
3942 ;; If affiliated keywords are orphaned: move back to first one.
3943 ;; They will be parsed as a paragraph.
3945 ;; Return value.
3949 \f
3950 ;;; The Org Parser
3951 ;;
3952 ;; The two major functions here are `org-element-parse-buffer', which
3953 ;; parses Org syntax inside the current buffer, taking into account
3954 ;; region, narrowing, or even visibility if specified, and
3955 ;; `org-element-parse-secondary-string', which parses objects within
3956 ;; a given string.
3957 ;;
3958 ;; The (almost) almighty `org-element-map' allows applying a function
3959 ;; on elements or objects matching some type, and accumulating the
3960 ;; resulting values. In an export situation, it also skips unneeded
3961 ;; parts of the parse tree.
3964 "Recursively parse the buffer and return structure.
3965 If narrowing is in effect, only parse the visible part of the
3966 buffer.
3968 Optional argument GRANULARITY determines the depth of the
3969 recursion. It can be set to the following symbols:
3971 `headline' Only parse headlines.
3972 `greater-element' Don't recurse into greater elements excepted
3973 headlines and sections. Thus, elements
3974 parsed are the top-level ones.
3975 `element' Parse everything but objects and plain text.
3976 `object' Parse the complete buffer (default).
3978 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3979 elements.
3981 An element or an objects is represented as a list with the
3982 pattern (TYPE PROPERTIES CONTENTS), where :
3984 TYPE is a symbol describing the element or object. See
3985 `org-element-all-elements' and `org-element-all-objects' for an
3986 exhaustive list of such symbols. One can retrieve it with
3987 `org-element-type' function.
3989 PROPERTIES is the list of attributes attached to the element or
3990 object, as a plist. Although most of them are specific to the
3991 element or object type, all types share `:begin', `:end',
3992 `:post-blank' and `:parent' properties, which respectively
3993 refer to buffer position where the element or object starts,
3994 ends, the number of white spaces or blank lines after it, and
3995 the element or object containing it. Properties values can be
3996 obtained by using `org-element-property' function.
3998 CONTENTS is a list of elements, objects or raw strings
3999 contained in the current element or object, when applicable.
4000 One can access them with `org-element-contents' function.
4002 The Org buffer has `org-data' as type and nil as properties.
4003 `org-element-map' function can be used to find specific elements
4004 or objects within the parse tree.
4006 This function assumes that current major mode is `org-mode'."
4012 ;; Start in `first-section' mode so text before the first
4013 ;; headline belongs to a section.
4017 "Recursively parse objects in STRING and return structure.
4019 RESTRICTION is a symbol limiting the object types that will be
4020 looked after.
4022 Optional argument PARENT, when non-nil, is the element or object
4023 containing the secondary string. It is used to set correctly
4024 `:parent' property within the string.
4026 If STRING is the empty string or nil, return nil."
4043 "Map a function on selected elements or objects.
4045 DATA is a parse tree, an element, an object, a string, or a list
4046 of such constructs. TYPES is a symbol or list of symbols of
4047 elements or objects types (see `org-element-all-elements' and
4048 `org-element-all-objects' for a complete list of types). FUN is
4049 the function called on the matching element or object. It has to
4050 accept one argument: the element or object itself.
4052 When optional argument INFO is non-nil, it should be a plist
4053 holding export options. In that case, parts of the parse tree
4054 not exportable according to that property list will be skipped.
4056 When optional argument FIRST-MATCH is non-nil, stop at the first
4057 match for which FUN doesn't return nil, and return that value.
4059 Optional argument NO-RECURSION is a symbol or a list of symbols
4060 representing elements or objects types. `org-element-map' won't
4061 enter any recursive element or object whose type belongs to that
4062 list. Though, FUN can still be applied on them.
4064 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4065 apply to matching objects within parsed affiliated keywords (see
4066 `org-element-parsed-keywords').
4068 Nil values returned from FUN do not appear in the results.
4071 Examples:
4072 ---------
4074 Assuming TREE is a variable containing an Org buffer parse tree,
4075 the following example will return a flat list of all `src-block'
4076 and `example-block' elements in it:
4080 The following snippet will find the first headline with a level
4084 (lambda (hl)
4085 (and (= (org-element-property :level hl) 1)
4087 (org-element-property :begin hl)))
4088 nil t)
4090 The next example will return a flat list of all `plain-list' type
4091 elements in TREE that are not a sub-list themselves:
4095 Eventually, this example will return a flat list of all `bold'
4096 type objects containing a `latex-snippet' type object, even
4097 looking into captions:
4100 (lambda (b)
4102 nil nil nil t)"
4103 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4107 ;; Recursion depth is determined by --CATEGORY.
4114 ;; If one object is found, the function has
4115 ;; to recurse into every object.
4118 ;; If one regular element is found, the
4119 ;; function has to recurse, at least, into
4120 ;; every element it encounters.
4123 --acc)
4126 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4127 ;; holding contextual information.
4131 ;; Ignored element in an export context.
4133 ;; List of elements or objects.
4135 ;; Unconditionally enter parse trees.
4139 ;; Check if TYPE is matching among TYPES. If so,
4140 ;; apply FUN to --DATA and accumulate return value
4141 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4147 ;; If --DATA has a secondary string that can contain
4148 ;; objects with their type among TYPES, look inside.
4151 org-element-secondary-value-alist)))
4153 ;; If --DATA has any parsed affiliated keywords and
4154 ;; WITH-AFFILIATED is non-nil, look for objects in
4155 ;; them.
4162 ;; Pay attention to the type of parsed
4163 ;; keyword. In particular, preserve order for
4164 ;; multiple keywords.
4177 ;; Determine if a recursion into --DATA is possible.
4179 ;; --TYPE is explicitly removed from recursion.
4181 ;; --DATA has no contents.
4183 ;; Looking for greater elements but --DATA is
4184 ;; simply an element or an object.
4187 ;; Looking for elements but --DATA is an object.
4190 ;; In any other case, map contents.
4194 ;; Return value in a proper order.
4198 ;; The following functions are internal parts of the parser.
4199 ;;
4200 ;; The first one, `org-element--parse-elements' acts at the element's
4201 ;; level.
4202 ;;
4203 ;; The second one, `org-element--parse-objects' applies on all objects
4204 ;; of a paragraph or a secondary string. It calls
4205 ;; `org-element--object-lex' to find the next object in the current
4206 ;; container.
4209 "Return next special mode according to TYPE, or nil.
4210 TYPE is a symbol representing the type of an element or object
4211 containing next element if PARENTP is non-nil, or before it
4212 otherwise. Modes can be either `first-section', `item',
4213 `node-property', `planning', `property-drawer', `section',
4214 `table-row' or nil."
4231 "Parse elements between BEG and END positions.
4233 MODE prioritizes some elements over the others. It can be set to
4234 `first-section', `section', `planning', `item', `node-property'
4235 or `table-row'.
4237 When value is `item', STRUCTURE will be used as the current list
4238 structure.
4240 GRANULARITY determines the depth of the recursion. See
4241 `org-element-parse-buffer' for more information.
4243 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4244 elements.
4246 Elements are accumulated into ACC."
4249 ;; Visible only: skip invisible parts at the beginning of the
4250 ;; element.
4253 ;; When parsing only headlines, skip any text before first one.
4258 ;; Find current element's type and parse it accordingly to
4259 ;; its category.
4261 end granularity mode structure))
4265 ;; Visible only: skip invisible parts between siblings.
4268 ;; Fill ELEMENT contents by side-effect.
4270 ;; If element has no contents, don't modify it.
4272 ;; Greater element: parse it between `contents-begin' and
4273 ;; `contents-end'. Make sure GRANULARITY allows the
4274 ;; recursion, or ELEMENT is a headline, in which case going
4275 ;; inside is mandatory, in order to get sub-level headings.
4283 ;; Possibly switch to a special mode.
4287 granularity visible-only element))
4288 ;; ELEMENT has contents. Parse objects inside, if
4289 ;; GRANULARITY allows it.
4295 ;; Update mode.
4297 ;; Return result.
4301 "Return next object in current buffer or nil.
4302 RESTRICTION is a list of object types, as symbols, that should be
4303 looked after. This function assumes that the buffer is narrowed
4304 to an appropriate container (e.g., a paragraph)."
4312 found)
4378 ;; This is probably a plain link.
4384 ;; Radio link.
4389 "Parse objects between BEG and END and return recursive structure.
4391 Objects are accumulated in ACC. RESTRICTION is a list of object
4392 successors which are allowed in the current object.
4394 ACC becomes the parent for all parsed objects. However, if ACC
4395 is nil (i.e., a secondary string is being parsed) and optional
4396 argument PARENT is non-nil, use it as the parent for all objects.
4397 Eventually, if both ACC and PARENT are nil, the common parent is
4398 the list of objects itself."
4406 ;; Text before any object. Untabify it.
4411 contents))))
4412 ;; Object...
4417 ;; Fill contents of NEXT-OBJECT if possible.
4419 cont-beg
4421 next-object
4423 next-object)
4424 contents)
4426 ;; Text after last object. Untabify it.
4430 contents)))
4431 ;; Result. Set appropriate parent.
4439 \f
4440 ;;; Towards A Bijective Process
4441 ;;
4442 ;; The parse tree obtained with `org-element-parse-buffer' is really
4443 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4444 ;; interpreted and expanded into a string with canonical Org syntax.
4445 ;; Hence `org-element-interpret-data'.
4446 ;;
4447 ;; The function relies internally on
4448 ;; `org-element--interpret-affiliated-keywords'.
4450 ;;;###autoload
4452 "Interpret DATA as Org syntax.
4453 DATA is a parse tree, an element, an object or a secondary string
4454 to interpret. Return Org syntax as a string."
4458 ;; Find interpreter for current object or
4459 ;; element. If it doesn't exist (e.g. this is
4460 ;; a pseudo object or element), return contents,
4461 ;; if any.
4468 ;; Secondary string.
4472 ;; Full Org document.
4476 ;; Plain text: return it.
4478 ;; Element or object without contents.
4481 ;; Element or object with contents.
4484 interpret
4485 --data
4486 ;; Recursively interpret contents.
4491 --data
4492 ;; Fix indentation of elements containing
4493 ;; objects. We ignore `table-row'
4494 ;; elements as they are one line long
4495 ;; anyway.
4497 --data
4498 ;; When normalizing first paragraph of
4499 ;; an item or a footnote-definition,
4500 ;; ignore first line's indentation.
4508 ;; Build white spaces. If no `:post-blank' property
4509 ;; is specified, assume its value is 0.
4524 "Return ELEMENT's affiliated keywords as Org syntax.
4525 If there is no affiliated keyword, return the empty string."
4535 ": "
4538 value)
4546 ;; All attribute keywords can have multiple lines.
4552 ;; List all ELEMENT's properties matching an attribute line or an
4553 ;; affiliated keyword, but ignore translated keywords since they
4554 ;; cannot belong to the property list.
4561 org-element-keyword-translation-alist)))))
4562 collect prop)
4565 ;; Because interpretation of the parse tree must return the same
4566 ;; number of blank lines between elements and the same number of white
4567 ;; space after objects, some special care must be given to white
4568 ;; spaces.
4569 ;;
4570 ;; The first function, `org-element-normalize-string', ensures any
4571 ;; string different from the empty string will end with a single
4572 ;; newline character.
4573 ;;
4574 ;; The second function, `org-element-normalize-contents', removes
4575 ;; global indentation from the contents of the current element.
4578 "Ensure string S ends with a single newline character.
4580 If S isn't a string return it unchanged. If S is the empty
4581 string, return it. Otherwise, return a new string with a single
4582 newline character at its end."
4590 "Normalize plain text in ELEMENT's contents.
4592 ELEMENT must only contain plain text and objects.
4594 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4595 indentation to compute maximal common indentation.
4597 Return the normalized element that is element with global
4598 indentation removed from its contents."
4600 ;; Return minimal common indentation within BLOB. This is
4601 ;; done by walking recursively BLOB and updating MIN-IND
4602 ;; along the way. FIRST-FLAG is non-nil when the next
4603 ;; object is expected to be a string that doesn't start
4604 ;; with a newline character. It happens for strings at
4605 ;; the beginnings of the contents or right after a line
4606 ;; break.
4613 ;; Objects cannot start with spaces: in this
4614 ;; case, indentation is 0.
4637 datum)
4650 ;; Build ELEMENT back, replacing each string with the same
4651 ;; string minus common indentation.
4654 ;; Return DATUM with all its strings indentation
4655 ;; shortened from MIN-IND white spaces.
4675 org-element-recursive-objects)
4679 datum)))
4683 \f
4684 ;;; Cache
4685 ;;
4686 ;; Implement a caching mechanism for `org-element-at-point' and
4687 ;; `org-element-context', which see.
4688 ;;
4689 ;; A single public function is provided: `org-element-cache-reset'.
4690 ;;
4691 ;; Cache is enabled by default, but can be disabled globally with
4692 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4693 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4694 ;; can be tweaked to control caching behaviour.
4695 ;;
4696 ;; Internally, parsed elements are stored in an AVL tree,
4697 ;; `org-element--cache'. This tree is updated lazily: whenever
4698 ;; a change happens to the buffer, a synchronization request is
4699 ;; registered in `org-element--cache-sync-requests' (see
4700 ;; `org-element--cache-submit-request'). During idle time, requests
4701 ;; are processed by `org-element--cache-sync'. Synchronization also
4702 ;; happens when an element is required from the cache. In this case,
4703 ;; the process stops as soon as the needed element is up-to-date.
4704 ;;
4705 ;; A synchronization request can only apply on a synchronized part of
4706 ;; the cache. Therefore, the cache is updated at least to the
4707 ;; location where the new request applies. Thus, requests are ordered
4708 ;; from left to right and all elements starting before the first
4709 ;; request are correct. This property is used by functions like
4710 ;; `org-element--cache-find' to retrieve elements in the part of the
4711 ;; cache that can be trusted.
4712 ;;
4713 ;; A request applies to every element, starting from its original
4714 ;; location (or key, see below). When a request is processed, it
4715 ;; moves forward and may collide the next one. In this case, both
4716 ;; requests are merged into a new one that starts from that element.
4717 ;; As a consequence, the whole synchronization complexity does not
4718 ;; depend on the number of pending requests, but on the number of
4719 ;; elements the very first request will be applied on.
4720 ;;
4721 ;; Elements cannot be accessed through their beginning position, which
4722 ;; may or may not be up-to-date. Instead, each element in the tree is
4723 ;; associated to a key, obtained with `org-element--cache-key'. This
4724 ;; mechanism is robust enough to preserve total order among elements
4725 ;; even when the tree is only partially synchronized.
4726 ;;
4727 ;; Objects contained in an element are stored in a hash table,
4728 ;; `org-element--cache-objects'.
4732 "Non nil when Org parser should cache its results.
4739 "Maximum duration, as a time value, for a cache synchronization.
4740 If the synchronization is not over after this delay, the process
4741 pauses and resumes after `org-element-cache-sync-break'
4745 "Duration, as a time value, of the pause between synchronizations.
4749 ;;;; Data Structure
4752 "AVL tree used to cache elements.
4753 Each node of the tree contains an element. Comparison is done
4754 with `org-element--cache-compare'. This cache is used in
4758 "Hash table used as to cache objects.
4759 Key is an element, as returned by `org-element-at-point', and
4760 value is an alist where each association is:
4762 \(PARENT COMPLETEP . OBJECTS)
4764 where PARENT is an element or object, COMPLETEP is a boolean,
4765 non-nil when all direct children of parent are already cached and
4766 OBJECTS is a list of such children, as objects, from farthest to
4767 closest.
4770 contained within a paragraph
4774 If the paragraph is completely parsed, OBJECTS-DATA will be
4776 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4777 \(BOLD-OBJECT t ENTITY-OBJECT))
4779 whereas in a partially parsed paragraph, it could be
4781 \((PARAGRAPH nil ENTITY-OBJECT))
4786 "List of pending synchronization requests.
4788 A request is a vector with the following pattern:
4790 \[NEXT BEG END OFFSET PARENT PHASE]
4792 Processing a synchronization request consists of three phases:
4794 0. Delete modified elements,
4795 1. Fill missing area in cache,
4796 2. Shift positions and re-parent elements after the changes.
4798 During phase 0, NEXT is the key of the first element to be
4799 removed, BEG and END is buffer position delimiting the
4800 modifications. Elements starting between them (inclusive) are
4801 removed. So are elements whose parent is removed. PARENT, when
4802 non-nil, is the parent of the first element to be removed.
4804 During phase 1, NEXT is the key of the next known element in
4805 cache and BEG its beginning position. Parse buffer between that
4806 element and the one before it in order to determine the parent of
4807 the next element. Set PARENT to the element containing NEXT.
4809 During phase 2, NEXT is the key of the next element to shift in
4810 the parse tree. All elements starting from this one have their
4811 properties relatives to buffer positions shifted by integer
4812 OFFSET and, if they belong to element PARENT, are adopted by it.
4820 "Hash table used to store keys during synchronization.
4824 "Return a unique key for ELEMENT in cache tree.
4826 Keys are used to keep a total order among elements in the cache.
4827 Comparison is done with `org-element--cache-key-less-p'.
4829 When no synchronization is taking place, a key is simply the
4830 beginning position of the element, or that position plus one in
4831 the case of an first item (respectively row) in
4832 a list (respectively a table).
4834 During a synchronization, the key is the one the element had when
4835 the cache was synchronized for the last time. Elements added to
4836 cache during the synchronization get a new key generated with
4837 `org-element--cache-generate-key'.
4839 Such keys are stored in `org-element--cache-sync-keys'. The hash
4840 table is cleared once the synchronization is complete."
4843 ;; Increase beginning position of items (respectively
4844 ;; table rows) by one, so the first item can get
4845 ;; a different key from its parent list (respectively
4846 ;; table).
4849 begin)))
4852 key))))
4855 "Generate a key between LOWER and UPPER.
4857 LOWER and UPPER are integers or lists, possibly empty.
4859 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4860 a unique key, as an integer or a list of integers, according to
4861 the following rules:
4863 - LOWER and UPPER are compared level-wise until values differ.
4865 - If, at a given level, LOWER and UPPER differ from more than
4866 2, the new key shares all the levels above with LOWER and
4867 gets a new level. Its value is the mean between LOWER and
4868 UPPER:
4870 \(1 2) + (1 4) --> (1 3)
4872 - If LOWER has no value to compare with, it is assumed that its
4873 value is `most-negative-fixnum'. E.g.,
4875 \(1 1) + (1 1 2)
4877 is equivalent to
4879 \(1 1 m) + (1 1 2)
4881 where m is `most-negative-fixnum'. Likewise, if UPPER is
4882 short of levels, the current value is `most-positive-fixnum'.
4884 - If they differ from only one, the new key inherits from
4885 current LOWER level and fork it at the next level. E.g.,
4887 \(2 1) + (3 3)
4889 is equivalent to
4891 \(2 1) + (2 M)
4893 where M is `most-positive-fixnum'.
4895 - If the key is only one level long, it is returned as an
4896 integer:
4898 \(1 2) + (3 2) --> 2
4900 When they are not equals, the function assumes that LOWER is
4901 lesser than UPPER, per `org-element--cache-key-less-p'."
4905 skip-upper key)
4916 ;; When at a given level, LOWER and UPPER differ from
4917 ;; 1, ignore UPPER altogether. Instead create a key
4918 ;; between LOWER and the greatest key with the same
4919 ;; prefix as LOWER so far.
4925 "Non-nil if key A is less than key B.
4926 A and B are either integers or lists of integers, as returned by
4927 `org-element--cache-key'."
4935 ;; If A is empty, either keys are equal (B is also empty) and
4936 ;; we return nil, or A is lesser than B (B is longer) and we
4937 ;; return a non-nil value.
4938 ;;
4939 ;; If A is not empty, B is necessarily empty and A is greater
4940 ;; than B (A is longer). Therefore, return nil.
4944 "Non-nil when element A is located before element B."
4949 "Return root value in cache.
4950 This function assumes `org-element--cache' is a valid AVL tree."
4954 ;;;; Tools
4957 "Non-nil when cache is active in current buffer."
4959 org-element--cache
4963 "Find element in cache starting at POS or before.
4965 POS refers to a buffer position.
4967 When optional argument SIDE is non-nil, the function checks for
4968 elements starting at or past POS instead. If SIDE is `both', the
4969 function returns a cons cell where car is the first element
4970 starting at or before POS and cdr the first element starting
4971 after POS.
4973 The function can only find elements in the synchronized part of
4974 the cache."
4978 lower upper)
4993 ;; We found an element in cache starting at POS. If `side'
4994 ;; is `both' we also want the next one in order to generate
4995 ;; a key in-between.
4996 ;;
4997 ;; If the element is the first row or item in a table or
4998 ;; a plain list, we always return the table or the plain
4999 ;; list.
5000 ;;
5001 ;; In any other case, we return the element found.
5010 lower parent
5011 upper parent)))))
5014 lower element
5015 upper element)))))
5022 "Store ELEMENT in current buffer's cache, if allowed.
5023 When optional argument DATA is non-nil, assume is it object data
5024 relative to ELEMENT and store it in the objects cache."
5028 ;; During synchronization, first build an appropriate key
5029 ;; for the new element so `avl-tree-enter' can insert it at
5030 ;; the right spot in the cache.
5039 org-element--cache-sync-keys)))
5041 ;; Headlines are not stored in cache, so objects in titles are
5042 ;; not stored either.
5047 "Remove ELEMENT from cache.
5048 Assume ELEMENT belongs to cache and that a cache is active."
5053 ;;;; Synchronization
5056 "Set idle timer for cache synchronization in BUFFER."
5063 org-element-cache-sync-idle-time))
5064 nil
5065 #'org-element--cache-sync
5066 buffer)))
5069 "Non-nil when synchronization process should be interrupted.
5070 TIME-LIMIT is a time value or nil."
5076 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5078 Properties containing buffer positions are `:begin', `:end',
5079 `:contents-begin', `:contents-end' and `:structure'. When
5080 optional argument PROPS is a list of keywords, only shift
5081 properties provided in that list.
5083 Properties are modified by side-effect."
5085 ;; Shift `:structure' property for the first plain list only: it
5086 ;; is the only one that really matters and it prevents from
5087 ;; shifting it more than once.
5101 "Synchronize cache with recent modification in BUFFER.
5103 When optional argument THRESHOLD is non-nil, do the
5104 synchronization for all elements starting before or at threshold,
5105 then exit. Otherwise, synchronize cache for as long as
5106 `org-element-cache-sync-duration' or until Emacs leaves idle
5107 state.
5109 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5110 not registered yet in the cache are going to happen. It is used
5111 in `org-element--cache-submit-request', where cache is partially
5112 updated before current modification are actually submitted."
5123 request
5125 threshold
5128 org-element-cache-sync-duration))
5129 future-change)
5130 ;; Request processed. Merge current and next offsets and
5131 ;; transfer ending position.
5137 ;; If more requests are awaiting, set idle timer accordingly.
5138 ;; Otherwise, reset keys.
5145 "Process synchronization REQUEST for all entries before NEXT.
5147 REQUEST is a vector, built by `org-element--cache-submit-request'.
5149 NEXT is a cache key, as returned by `org-element--cache-key'.
5151 When non-nil, THRESHOLD is a buffer position. Synchronization
5152 stops as soon as a shifted element begins after it.
5154 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5155 after this time or when Emacs exits idle state.
5157 When non-nil, FUTURE-CHANGE is a buffer position where changes
5158 not registered yet in the cache are going to happen. See
5159 `org-element--cache-submit-request' for more information.
5161 Throw `interrupt' if the process stops before completing the
5162 request."
5165 ;; Phase 0.
5166 ;;
5167 ;; Delete all elements starting after BEG, but not after buffer
5168 ;; position END or past element with key NEXT. Also delete
5169 ;; elements contained within a previously removed element
5170 ;; (stored in `last-container').
5171 ;;
5172 ;; At each iteration, we start again at tree root since
5173 ;; a deletion modifies structure of the balanced tree.
5178 ;; Find first element in cache with key BEG or after it.
5182 data data-key last-container)
5191 data-key key
5194 data-key key
5195 node nil)))))
5205 up)))
5208 end))
5215 ;; No element starting after modifications left in
5216 ;; cache: further processing is futile.
5219 ;; Phase 1.
5220 ;;
5221 ;; Phase 0 left a hole in the cache. Some elements after it
5222 ;; could have parents within. For example, in the following
5223 ;; buffer:
5224 ;;
5225 ;; - item
5226 ;;
5227 ;;
5228 ;; Paragraph1
5229 ;;
5230 ;; Paragraph2
5231 ;;
5232 ;; if we remove a blank line between "item" and "Paragraph1",
5233 ;; everything down to "Paragraph2" is removed from cache. But
5234 ;; the paragraph now belongs to the list, and its `:parent'
5235 ;; property no longer is accurate.
5236 ;;
5237 ;; Therefore we need to parse again elements in the hole, or at
5238 ;; least in its last section, so that we can re-parent
5239 ;; subsequent elements, during phase 2.
5240 ;;
5241 ;; Note that we only need to get the parent from the first
5242 ;; element in cache after the hole.
5243 ;;
5244 ;; When next key is lesser or equal to the current one, delegate
5245 ;; phase 1 processing to next request in order to preserve key
5246 ;; order among requests.
5254 ;; Next element will start at its beginning position plus
5255 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5256 ;; contains the real beginning position of the first element to
5257 ;; shift and re-parent.
5261 ;; Changes are going to happen around this element and
5262 ;; they will trigger another phase 1 request. Skip the
5263 ;; current one.
5269 ;; Phase 2.
5270 ;;
5271 ;; Shift all elements starting from key START, but before NEXT, by
5272 ;; OFFSET, and re-parent them when appropriate.
5273 ;;
5274 ;; Elements are modified by side-effect so the tree structure
5275 ;; remains intact.
5276 ;;
5277 ;; Once THRESHOLD, if any, is reached, or once there is an input
5278 ;; pending, exit. Before leaving, the current synchronization
5279 ;; request is updated.
5286 exit-flag)
5287 ;; No re-parenting nor shifting planned: request is over.
5297 ;; We reached NEXT. Request is complete.
5299 ;; Handle interruption request. Update current request.
5304 ;; Shift element.
5307 ;; Shift associated objects data, if any.
5312 ;; Update PARENT and re-parent DATA, only when
5313 ;; necessary. Propagate new structures for lists.
5327 ;; Cache is up-to-date past THRESHOLD. Request
5328 ;; interruption.
5333 ;; We reached end of tree: synchronization complete.
5334 t)))
5337 "Parse elements in current section, down to POS.
5339 Start parsing from the closest between the last known element in
5340 cache or headline above. Return the smallest element containing
5341 POS.
5343 When optional argument SYNCP is non-nil, return the parent of the
5344 element containing POS instead. In that case, it is also
5345 possible to provide TIME-LIMIT, which is a time value specifying
5346 when the parsing should stop. The function throws `interrupt' if
5347 the process stopped before finding the expected result."
5354 element next mode)
5356 ;; Nothing in cache before point: start parsing from first
5357 ;; element following headline above, or first element in
5358 ;; buffer.
5365 ;; Cache returned exact match: return it.
5368 ;; There's a headline between cached value and POS: cached
5369 ;; value is invalid. Start parsing from first element
5370 ;; following the headline.
5377 ;; Check if CACHED or any of its ancestors contain point.
5378 ;;
5379 ;; If there is such an element, we inspect it in order to know
5380 ;; if we return it or if we need to parse its contents.
5381 ;; Otherwise, we just start parsing from current location,
5382 ;; which is right after the top-most element containing
5383 ;; CACHED.
5384 ;;
5385 ;; As a special case, if POS is at the end of the buffer, we
5386 ;; want to return the innermost element ending there.
5387 ;;
5388 ;; Also, if we find an ancestor and discover that we need to
5389 ;; parse its contents, make sure we don't start from
5390 ;; `:contents-begin', as we would otherwise go past CACHED
5391 ;; again. Instead, in that situation, we will resume parsing
5392 ;; from NEXT, which is located after CACHED or its higher
5393 ;; ancestor not containing point.
5405 ;; Parse successively each element until we reach POS.
5418 end 'element mode
5425 ;; Skip any element ending before point. Also skip
5426 ;; element ending at point (unless it is also the end of
5427 ;; buffer) since we're sure that another element begins
5428 ;; after it.
5432 ;; A non-greater element contains point: return it.
5435 ;; Otherwise, we have to decide if ELEMENT really
5436 ;; contains POS. In that case we start parsing from
5437 ;; contents' beginning.
5438 ;;
5439 ;; If POS is at contents' beginning but it is also at
5440 ;; the beginning of the first item in a list or a table.
5441 ;; In that case, we need to create an anchor for that
5442 ;; list or table, so return it.
5443 ;;
5444 ;; Also, if POS is at the end of the buffer, no element
5445 ;; can start after it, but more than one may end there.
5446 ;; Arbitrarily, we choose to return the innermost of
5447 ;; such elements.
5460 parent element
5461 end cend))))
5462 ;; Otherwise, return ELEMENT as it is the smallest
5463 ;; element containing POS.
5468 ;;;; Staging Buffer Changes
5479 "Regexp matching a sensitive line, structure wise.
5480 A sensitive line is a headline, inlinetask, block, drawer, or
5481 latex-environment boundary. When such a line is modified,
5482 structure changes in the document may propagate in the whole
5486 "Non-nil when a sensitive line is about to be changed.
5490 "Request extension of area going to be modified if needed.
5491 BEG and END are the beginning and end of the range of changed
5492 text. See `before-change-functions' for more information."
5502 'headline
5505 org-element--cache-sensitive-re bottom t)))))))))
5508 "Update buffer modifications for current buffer.
5509 BEG and END are the beginning and end of the range of changed
5510 text, and the length in bytes of the pre-change text replaced by
5511 that range. See `after-change-functions' for more information."
5519 ;; Determine if modified area needs to be extended, according
5520 ;; to both previous and current state. We make a special
5521 ;; case for headline editing: if a headline is modified but
5522 ;; not removed, do not extend.
5525 (`headline
5531 org-element--cache-sensitive-re bottom t))))
5532 ;; Effectively extend modified area.
5540 ;; Store synchronization request.
5543 ;; Activate a timer to process the request during idle time.
5547 "Return first element to remove from cache.
5549 BEG and END are buffer positions delimiting buffer modifications.
5550 OFFSET is the size of the changes.
5552 Returned element is usually the first element in cache containing
5553 any position between BEG and END. As an exception, greater
5554 elements around the changes that are robust to contents
5555 modifications are preserved and updated according to the
5556 changes."
5566 special-block))
5567 ;; Drawers named "PROPERTIES" are probably
5568 ;; a properties drawer being edited. Force
5569 ;; parsing to check if editing is over.
5578 ;; UP is a robust greater element containing changes.
5579 ;; We only need to extend its ending boundaries.
5585 ;; We're at top level element containing ELEMENT: if it's
5586 ;; altered by buffer modifications, it is first element in
5587 ;; cache to be removed. Otherwise, that first element is the
5588 ;; following one.
5589 ;;
5590 ;; As a special case, do not remove BEFORE if it is a robust
5591 ;; container for current changes.
5593 before)))))
5596 "Submit a new cache synchronization request for current buffer.
5597 BEG and END are buffer positions delimiting the minimal area
5598 where cache data should be removed. OFFSET is the size of the
5599 change, as an integer."
5601 delete-to delete-from)
5606 ;; Current changes can be merged with first sync request: we
5607 ;; can save a partial cache synchronization.
5610 ;; If last change happened within area to be removed, extend
5611 ;; boundaries of robust parents, if any. Otherwise, find
5612 ;; first element to remove and update request accordingly.
5624 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5625 ;; if any, is no longer a 0-phase request, thus ensuring that
5626 ;; phases are properly ordered. We need to provide OFFSET as
5627 ;; optional parameter since current modifications are not known
5628 ;; yet to the otherwise correct part of the cache (i.e, before
5629 ;; the first request).
5636 ;; When changes happen before the first known
5637 ;; element, re-parent and shift the rest of the
5638 ;; cache.
5640 ;; Otherwise, we find the first non robust
5641 ;; element containing END. All elements between
5642 ;; FIRST and this one are to be removed.
5653 element up))
5655 org-element--cache-sync-requests)
5656 ;; No element to remove. No need to re-parent either.
5657 ;; Simply shift additional elements, if any, by OFFSET.
5662 ;;;; Public Functions
5664 ;;;###autoload
5666 "Reset cache in current buffer.
5667 When optional argument ALL is non-nil, reset cache in all Org
5668 buffers."
5686 ;;;###autoload
5688 "Refresh cache at position POS."
5695 \f
5696 ;;; The Toolbox
5697 ;;
5698 ;; The first move is to implement a way to obtain the smallest element
5699 ;; containing point. This is the job of `org-element-at-point'. It
5700 ;; basically jumps back to the beginning of section containing point
5701 ;; and proceed, one element after the other, with
5702 ;; `org-element--current-element' until the container is found. Note:
5703 ;; When using `org-element-at-point', secondary values are never
5704 ;; parsed since the function focuses on elements, not on objects.
5705 ;;
5706 ;; At a deeper level, `org-element-context' lists all elements and
5707 ;; objects containing point.
5708 ;;
5709 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5710 ;; internally by navigation and manipulation tools.
5713 ;;;###autoload
5715 "Determine closest element around point.
5717 Return value is a list like (TYPE PROPS) where TYPE is the type
5718 of the element and PROPS a plist of properties associated to the
5719 element.
5721 Possible types are defined in `org-element-all-elements'.
5722 Properties depend on element or object type, but always include
5723 `:begin', `:end', `:parent' and `:post-blank' properties.
5725 As a special case, if point is at the very beginning of the first
5726 item in a list or sub-list, returned element will be that list
5727 instead of the item. Likewise, if point is at the beginning of
5728 the first row of a table, returned element will be the table
5729 instead of the first row.
5731 When point is at the end of the buffer, return the innermost
5732 element ending there."
5738 ;; Within blank lines at the beginning of buffer, return nil.
5740 ;; Within blank lines right after a headline, return that
5741 ;; headline.
5745 ;; Otherwise parse until we find element containing ORIGIN.
5752 ;;;###autoload
5754 "Return smallest element or object around point.
5756 Return value is a list like (TYPE PROPS) where TYPE is the type
5757 of the element or object and PROPS a plist of properties
5758 associated to it.
5760 Possible types are defined in `org-element-all-elements' and
5761 `org-element-all-objects'. Properties depend on element or
5762 object type, but always include `:begin', `:end', `:parent' and
5763 `:post-blank'.
5765 As a special case, if point is right after an object and not at
5766 the beginning of any other object, return that object.
5768 Optional argument ELEMENT, when non-nil, is the closest element
5769 containing point, as returned by `org-element-at-point'.
5770 Providing it allows for quicker computation."
5777 ;; If point is inside an element containing objects or
5778 ;; a secondary string, narrow buffer to the container and
5779 ;; proceed with parsing. Otherwise, return ELEMENT.
5781 ;; At a parsed affiliated keyword, check if we're inside main
5782 ;; or dual value.
5788 org-element-parsed-keywords))
5797 ;; Also change type to retrieve correct restrictions.
5799 ;; At an item, objects can only be located within tag, if any.
5810 ;; At an headline or inlinetask, objects are in title.
5821 ;; At a paragraph, a table-row or a verse block, objects are
5822 ;; located within their contents.
5826 ;; CBEG is nil for table rules.
5831 ;; At a planning line, if point is at a timestamp, return it,
5832 ;; otherwise, return element.
5840 ;; All other locations cannot contain objects: bail out.
5850 next object-data last)
5854 ;; When entering PARENT for the first time, get list
5855 ;; of objects within known so far. Store it in
5856 ;; OBJECT-DATA.
5861 ;; Find NEXT object for analysis.
5863 ;; If NEXT is non-nil, we already exhausted the
5864 ;; cache so we can parse buffer to find the object
5865 ;; after it.
5867 ;; Otherwise, check if cache can help us.
5878 ;; Cache contains the information needed.
5881 pos)
5883 pos)
5889 ;; If we have a new object to analyze, store it in
5890 ;; cache. Otherwise record that there is nothing
5891 ;; more to parse in this element at this depth.
5896 ;; Process NEXT, if any, in order to know if we need
5897 ;; to skip it, return it or move into it.
5904 ;; Skip objects ending before point. Also skip
5905 ;; objects ending at point unless it is also the
5906 ;; end of buffer, since we want to return the
5907 ;; innermost object.
5910 ;; For convenience, when object ends at POS,
5911 ;; without any space, store it in LAST, as we
5912 ;; will return it if no object starts here.
5916 ;; If POS is within a container object, move
5917 ;; into that object.
5921 ;; At contents' end, if there is no
5922 ;; space before point, also move into
5923 ;; object, for consistency with
5924 ;; convenience feature above.
5933 next nil
5934 object-data nil))
5935 ;; Otherwise, return NEXT.
5937 ;; Store results in cache, if applicable.
5941 "List all ancestors of a given element or object.
5943 BLOB is an object or element.
5945 When optional argument TYPES is a list of symbols, return the
5946 first element or object in the lineage whose type belongs to that
5947 list.
5949 When optional argument WITH-SELF is non-nil, lineage includes
5950 BLOB itself as the first element, and TYPES, if provided, also
5951 apply to it.
5953 When BLOB is obtained through `org-element-context' or
5954 `org-element-at-point', only ancestors from its section can be
5955 found. There is no such limitation when BLOB belongs to a full
5956 parse tree."
5958 ancestors)
5965 "Non-nil when elements ELEM-A and ELEM-B are nested."
5974 "Swap elements ELEM-A and ELEM-B.
5975 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5976 end of ELEM-A."
5978 ;; There are two special cases when an element doesn't start at bol:
5979 ;; the first paragraph in an item or in a footnote definition.
5981 ;; Only a paragraph without any affiliated keyword can be moved at
5982 ;; ELEM-A position in such a situation. Note that the case of
5983 ;; a footnote definition is impossible: it cannot contain two
5984 ;; paragraphs in a row because it cannot contain a blank line.
5990 ;; In a special situation, ELEM-A will have no indentation. We'll
5991 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6005 ;; Store inner overlays responsible for visibility status.
6006 ;; We also need to store their boundaries as they will be
6007 ;; removed from buffer.
6022 ;; Get contents.
6030 ;; Restore ex ELEM-A overlays.
6037 ;; Restore ex ELEM-B overlays.
6042 ;; For backward-compatibility with Org <= 8.3
6049 ;; Local variables:
6050 ;; generated-autoload-file: "org-loaddefs.el"
6051 ;; End:
6053 ;;; org-element.el ends here