| blob | 12a4bc67c9a11487170519639ae0b1a0fbdf2036 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 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 in a link description. Also ignore
356 ;; radio-targets and line breaks.
358 italic latex-fragment macro statistics-cookie strike-through
359 subscript superscript underline verbatim)
361 ;; Remove any variable object from radio target as it would
362 ;; prevent it from being properly recognized.
364 subscript superscript underline superscript)
368 ;; Ignore inline babel call and inline src block as formulas are
369 ;; possible. Also ignore line breaks and statistics cookies.
371 latex-fragment link macro radio-target strike-through
372 subscript superscript target timestamp underline verbatim)
376 "Alist of objects restrictions.
378 key is an element or object type containing objects and value is
379 a list of types that can be contained within an element or object
380 of such type.
382 For example, in a `radio-target' object, one can only find
383 entities, latex-fragments, subscript, superscript and text
384 markup.
386 This alist also applies to secondary string. For example, an
387 `headline' type element doesn't directly contain objects, but
402 "Table used internally to pair only round brackets.
411 "Table used internally to pair only square brackets.
420 "Table used internally to pair only curly brackets.
424 "Parse paired brackets at point.
425 CHAR is the opening bracket to consider, as a character. Return
426 contents between brackets, as a string, or nil. Also move point
427 past the brackets."
442 \f
443 ;;; Accessors and Setters
444 ;;
445 ;; Provide four accessors: `org-element-type', `org-element-property'
446 ;; `org-element-contents' and `org-element-restriction'.
447 ;;
448 ;; Setter functions allow modification of elements by side effect.
449 ;; There is `org-element-put-property', `org-element-set-contents'.
450 ;; These low-level functions are useful to build a parse tree.
451 ;;
452 ;; `org-element-adopt-elements', `org-element-set-element',
453 ;; `org-element-extract-element' and `org-element-insert-before' are
454 ;; high-level functions useful to modify a parse tree.
455 ;;
456 ;; `org-element-secondary-p' is a predicate used to know if a given
457 ;; object belongs to a secondary string. `org-element-class' tells if
458 ;; some parsed data is an element or an object, handling pseudo
459 ;; elements and objects. `org-element-copy' returns an element or
460 ;; object, stripping its parent property in the process.
463 "Return type of ELEMENT.
465 The function returns the type of the element or object provided.
466 It can also return the following special value:
467 `plain-text' for a string
468 `org-data' for a complete document
469 nil in any other case."
475 "Extract the value from the PROPERTY of an ELEMENT."
480 "Extract contents from an ELEMENT."
486 "Return restriction associated to ELEMENT.
487 ELEMENT can be an element, an object or a symbol representing an
488 element or object type."
490 org-element-object-restrictions)))
493 "In ELEMENT set PROPERTY to VALUE.
494 Return modified element."
497 element))
500 "Set ELEMENT's contents to CONTENTS.
501 Return ELEMENT."
508 "Non-nil when OBJECT directly belongs to a secondary string.
509 Return value is the property name, as a keyword, or nil."
512 org-element-secondary-value-alist))))
519 "Return class for ELEMENT, as a symbol.
520 Class is either `element' or `object'. Optional argument PARENT
521 is the element or object containing DATUM. It defaults to the
522 value of DATUM `:parent' property."
526 ;; Trivial cases.
529 ;; Special cases.
533 ;; Pseudo object or elements. Make a guess about its class.
534 ;; Basically a pseudo object is contained within another object,
535 ;; a secondary string or a container element.
545 "Append elements to the contents of another element.
547 PARENT is an element or object. CHILDREN can be elements,
548 objects, or a strings.
550 The function takes care of setting `:parent' property for CHILD.
551 Return parent element."
553 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
554 ;; string: parent is the list itself.
557 ;; Add CHILDREN at the end of PARENT contents.
560 parent
562 ;; Return modified PARENT element.
566 "Extract ELEMENT from parse tree.
567 Remove element from the parse tree by side-effect, and return it
568 with its `:parent' property stripped out."
573 parent secondary
576 parent
578 ;; Return ELEMENT with its :parent removed.
582 "Insert ELEMENT before LOCATION in parse tree.
583 LOCATION is an element, object or string within the parse tree.
584 Parse tree is modified by side effect."
589 ;; Special case: LOCATION is the first element of an
590 ;; independent secondary string (e.g. :title property). Add
591 ;; ELEMENT in-place.
595 ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
604 ;; Store SIBLINGS at appropriate place in parse tree.
609 ;; Set appropriate :parent property.
613 "Replace element or object OLD with element or object NEW.
614 The function takes care of setting `:parent' property for NEW."
615 ;; Ensure OLD and NEW have the same parent.
619 ;; We cannot replace OLD with NEW since one of them is not an
620 ;; object or element. We take the long path.
623 ;; Since OLD is going to be changed into NEW by side-effect, first
624 ;; make sure that every element or object within NEW has OLD as
625 ;; parent.
628 ;; Transfer contents.
630 ;; Overwrite OLD's properties with NEW's.
632 ;; Transfer type.
636 "Create a new element of type TYPE.
637 Optional argument PROPS, when non-nil, is a plist defining the
638 properties of the element. CHILDREN can be elements, objects or
639 strings."
643 "Return a copy of DATUM.
644 DATUM is an element, object, string or nil. `:parent' property
645 is cleared and contents are removed in the process."
656 \f
657 ;;; Greater elements
658 ;;
659 ;; For each greater element type, we define a parser and an
660 ;; interpreter.
661 ;;
662 ;; A parser returns the element or object as the list described above.
663 ;; Most of them accepts no argument. Though, exceptions exist. Hence
664 ;; every element containing a secondary string (see
665 ;; `org-element-secondary-value-alist') will accept an optional
666 ;; argument to toggle parsing of these secondary strings. Moreover,
667 ;; `item' parser requires current list's structure as its first
668 ;; element.
669 ;;
670 ;; An interpreter accepts two arguments: the list representation of
671 ;; the element or object, and its contents. The latter may be nil,
672 ;; depending on the element or object considered. It returns the
673 ;; appropriate Org syntax, as a string.
674 ;;
675 ;; Parsing functions must follow the naming convention:
676 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
677 ;; defined in `org-element-greater-elements'.
678 ;;
679 ;; Similarly, interpreting functions must follow the naming
680 ;; convention: org-element-TYPE-interpreter.
681 ;;
682 ;; With the exception of `headline' and `item' types, greater elements
683 ;; cannot contain other greater elements of their own type.
684 ;;
685 ;; Beside implementing a parser and an interpreter, adding a new
686 ;; greater element requires tweaking `org-element--current-element'.
687 ;; Moreover, the newly defined type must be added to both
688 ;; `org-element-all-elements' and `org-element-greater-elements'.
691 ;;;; Center Block
694 "Parse a center block.
696 LIMIT bounds the search. AFFILIATED is a list of which CAR is
697 the buffer position at the beginning of the first affiliated
698 keyword and CDR is a plist of affiliated keywords along with
699 their value.
701 Return a list whose CAR is `center-block' and CDR is a plist
702 containing `:begin', `:end', `:contents-begin', `:contents-end',
703 `:post-blank' and `:post-affiliated' keywords.
705 Assume point is at the beginning of the block."
709 ;; Incomplete block: parse it as a paragraph.
714 ;; Empty blocks have no contents.
728 :end end
729 :contents-begin contents-begin
730 :contents-end contents-end
736 "Interpret a center-block element as Org syntax.
737 CONTENTS is the contents of the element."
741 ;;;; Drawer
744 "Parse a drawer.
746 LIMIT bounds the search. AFFILIATED is a list of which CAR is
747 the buffer position at the beginning of the first affiliated
748 keyword and CDR is a plist of affiliated keywords along with
749 their value.
751 Return a list whose CAR is `drawer' and CDR is a plist containing
752 `:drawer-name', `:begin', `:end', `:contents-begin',
753 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
755 Assume point is at beginning of drawer."
758 ;; Incomplete drawer: parse it as a paragraph.
766 ;; Empty drawers have no contents.
779 :end end
780 :drawer-name name
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DRAWER element as Org syntax.
789 CONTENTS is the contents of the element."
792 contents))
795 ;;;; Dynamic Block
798 "Parse a dynamic block.
800 LIMIT bounds the search. AFFILIATED is a list of which CAR is
801 the buffer position at the beginning of the first affiliated
802 keyword and CDR is a plist of affiliated keywords along with
803 their value.
805 Return a list whose CAR is `dynamic-block' and CDR is a plist
806 containing `:block-name', `:begin', `:end', `:contents-begin',
807 `:contents-end', `:arguments', `:post-blank' and
808 `:post-affiliated' keywords.
810 Assume point is at beginning of dynamic block."
814 ;; Incomplete block: parse it as a paragraph.
823 ;; Empty blocks have no contents.
836 :end end
837 :block-name name
838 :arguments arguments
839 :contents-begin contents-begin
840 :contents-end contents-end
846 "Interpret DYNAMIC-BLOCK element as Org syntax.
847 CONTENTS is the contents of the element."
852 contents))
855 ;;;; Footnote Definition
864 "Parse a footnote definition.
866 LIMIT bounds the search. AFFILIATED is a list of which CAR is
867 the buffer position at the beginning of the first affiliated
868 keyword and CDR is a plist of affiliated keywords along with
869 their value.
871 Return a list whose CAR is `footnote-definition' and CDR is
872 a plist containing `:label', `:begin' `:end', `:contents-begin',
873 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
875 Assume point is at the beginning of the footnote definition."
887 limit)
889 ;; At a new footnote definition, make sure we end
890 ;; before any affiliated keyword above.
911 :begin begin
912 :end end
913 :contents-begin contents-begin
914 :contents-end contents-end
920 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
921 CONTENTS is the contents of the footnote-definition."
923 " "
924 contents))
927 ;;;; Headline
930 "Return node properties associated to headline at point.
931 Upcase property names. It avoids confusion between properties
932 obtained through property drawer and default properties from the
933 parser (e.g. `:end' and :END:). Return value is a plist."
945 properties))))
948 "Return time properties associated to headline at point.
949 Return value is a plist."
963 plist))))
966 "Parse a headline.
968 Return a list whose CAR is `headline' and CDR is a plist
969 containing `:raw-value', `:title', `:begin', `:end',
970 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
971 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
972 `:deadline', `:closed', `:archivedp', `:commentedp'
973 `:footnote-section-p', `:post-blank' and `:post-affiliated'
974 keywords.
976 The plist also contains any property set in the property drawer,
977 with its name in upper cases and colons added at the
978 beginning (e.g., `:CUSTOM_ID').
980 LIMIT is a buffer position bounding the search.
982 When RAW-SECONDARY-P is non-nil, headline's title will not be
983 parsed as a secondary string, but as a plain string instead.
985 Assume point is at beginning of the headline."
1031 :begin begin
1032 :end end
1033 :pre-blank
1036 :contents-begin contents-begin
1037 :contents-end contents-end
1038 :level level
1039 :priority priority
1040 :tags tags
1041 :todo-keyword todo
1042 :todo-type todo-type
1043 :post-blank
1047 :footnote-section-p footnote-section-p
1048 :archivedp archivedp
1049 :commentedp commentedp
1051 time-props
1052 standard-props))))
1054 headline :title
1063 nil
1065 headline)))))))
1068 "Interpret HEADLINE element as Org syntax.
1069 CONTENTS is the contents of the element."
1082 ?*)
1086 " "
1089 org-footnote-section
1090 title))))
1092 heading
1093 ;; Align tags.
1101 ?\s)
1102 tags))
1106 tags))))
1108 contents)))
1111 ;;;; Inlinetask
1114 "Parse an inline task.
1116 Return a list whose CAR is `inlinetask' and CDR is a plist
1117 containing `:title', `:begin', `:end', `:pre-blank',
1118 `:contents-begin' and `:contents-end', `:level', `:priority',
1119 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1120 `:scheduled', `:deadline', `:closed', `:post-blank' and
1121 `:post-affiliated' keywords.
1123 The plist also contains any property set in the property drawer,
1124 with its name in upper cases and colons added at the
1125 beginning (e.g., `:CUSTOM_ID').
1127 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1128 title will not be parsed as a secondary string, but as a plain
1129 string instead.
1131 Assume point is at beginning of the inline task."
1178 :begin begin
1179 :end end
1180 :pre-blank
1183 :contents-begin contents-begin
1184 :contents-end contents-end
1185 :level level
1186 :priority priority
1187 :tags tags
1188 :todo-keyword todo
1189 :todo-type todo-type
1192 time-props
1193 standard-props))))
1195 inlinetask :title
1204 nil
1206 inlinetask))))))
1209 "Interpret INLINETASK element as Org syntax.
1210 CONTENTS is the contents of inlinetask."
1224 ;; Align tags.
1232 ? )
1233 tags))
1237 tags))))
1238 ;; Prefer degenerate inlinetasks when there are no
1239 ;; contents.
1242 contents
1246 ;;;; Item
1249 "Parse an item.
1251 STRUCT is the structure of the plain list.
1253 Return a list whose CAR is `item' and CDR is a plist containing
1254 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1255 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1256 `:post-affiliated' keywords.
1258 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1259 any, will not be parsed as a secondary string, but as a plain
1260 string instead.
1262 Assume point is at the beginning of the item."
1285 ;; Ignore tags in un-ordered lists: they are just
1286 ;; a part of item's body.
1293 ;; If first line isn't empty, contents really
1294 ;; start at the text after item's meta-data.
1304 :begin begin
1305 :end end
1306 :contents-begin contents-begin
1307 :contents-end contents-end
1308 :checkbox checkbox
1309 :counter counter
1310 :structure struct
1314 item :tag
1321 item))))))))
1324 "Interpret ITEM element as Org syntax.
1325 CONTENTS is the contents of the element."
1335 ;; Compute indentation.
1340 ;; Indent contents.
1342 bullet
1357 ;;;; Plain List
1360 ;; Return structure of list at point. Internal function. See
1361 ;; `org-list-struct' for details.
1366 items struct)
1371 ;; At limit: end all items.
1380 ;; At list end: end all items.
1385 ;; At a new item: end previous sibling.
1397 ind
1398 bullet
1401 ;; Description tag.
1405 ;; Ending position, unknown so far.
1406 nil)))
1407 items))
1409 ;; Skip empty lines.
1411 ;; Skip inline tasks and blank lines along the way.
1418 ;; At some text line. Check if it ends any previous item.
1431 ;; Skip blocks (any type) and drawers contents.
1436 limit t)))
1442 "Parse a plain list.
1444 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1445 the buffer position at the beginning of the first affiliated
1446 keyword and CDR is a plist of affiliated keywords along with
1447 their value. STRUCTURE is the structure of the plain list being
1448 parsed.
1450 Return a list whose CAR is `plain-list' and CDR is a plist
1451 containing `:type', `:begin', `:end', `:contents-begin' and
1452 `:contents-end', `:structure', `:post-blank' and
1453 `:post-affiliated' keywords.
1455 Assume point is at the beginning of the list."
1469 pos))
1473 ;; Return value.
1477 :begin begin
1478 :end end
1479 :contents-begin contents-begin
1480 :contents-end contents-end
1481 :structure struct
1487 "Interpret plain-list element as Org syntax.
1488 CONTENTS is the contents of the element."
1496 ;;;; Property Drawer
1499 "Parse a property drawer.
1501 LIMIT bounds the search.
1503 Return a list whose car is `property-drawer' and cdr is a plist
1504 containing `:begin', `:end', `:contents-begin', `:contents-end',
1505 `:post-blank' and `:post-affiliated' keywords.
1507 Assume point is at the beginning of the property drawer."
1520 :end end
1522 :contents-end contents-end
1527 "Interpret property-drawer element as Org syntax.
1528 CONTENTS is the properties within the drawer."
1532 ;;;; Quote Block
1535 "Parse a quote block.
1537 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1538 the buffer position at the beginning of the first affiliated
1539 keyword and CDR is a plist of affiliated keywords along with
1540 their value.
1542 Return a list whose CAR is `quote-block' and CDR is a plist
1543 containing `:begin', `:end', `:contents-begin', `:contents-end',
1544 `:post-blank' and `:post-affiliated' keywords.
1546 Assume point is at the beginning of the block."
1550 ;; Incomplete block: parse it as a paragraph.
1556 ;; Empty blocks have no contents.
1569 :end end
1570 :contents-begin contents-begin
1571 :contents-end contents-end
1577 "Interpret quote-block element as Org syntax.
1578 CONTENTS is the contents of the element."
1582 ;;;; Section
1585 "Parse a section.
1587 Return a list whose CAR is `section' and CDR is a plist
1588 containing `:begin', `:end', `:contents-begin', `contents-end',
1589 `:post-blank' and `:post-affiliated' keywords."
1591 ;; Beginning of section is the beginning of the first non-blank
1592 ;; line after previous headline.
1600 :end end
1601 :contents-begin begin
1602 :contents-end pos-before-blank
1607 "Interpret section element as Org syntax.
1608 CONTENTS is the contents of the element."
1609 contents)
1612 ;;;; Special Block
1615 "Parse a special block.
1617 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1618 the buffer position at the beginning of the first affiliated
1619 keyword and CDR is a plist of affiliated keywords along with
1620 their value.
1622 Return a list whose CAR is `special-block' and CDR is a plist
1623 containing `:type', `:begin', `:end', `:contents-begin',
1624 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1626 Assume point is at the beginning of the block."
1633 limit t)))
1634 ;; Incomplete block: parse it as a paragraph.
1640 ;; Empty blocks have no contents.
1653 :begin begin
1654 :end end
1655 :contents-begin contents-begin
1656 :contents-end contents-end
1662 "Interpret SPECIAL-BLOCK element as Org syntax.
1663 CONTENTS is the contents of the element."
1668 \f
1669 ;;; Elements
1670 ;;
1671 ;; For each element, a parser and an interpreter are also defined.
1672 ;; Both follow the same naming convention used for greater elements.
1673 ;;
1674 ;; Also, as for greater elements, adding a new element type is done
1675 ;; through the following steps: implement a parser and an interpreter,
1676 ;; tweak `org-element--current-element' so that it recognizes the new
1677 ;; type and add that new type to `org-element-all-elements'.
1680 ;;;; Babel Call
1683 "Parse a babel call.
1685 LIMIT bounds the search. AFFILIATED is a list of which car is
1686 the buffer position at the beginning of the first affiliated
1687 keyword and cdr is a plist of affiliated keywords along with
1688 their value.
1690 Return a list whose car is `babel-call' and cdr is a plist
1691 containing `:call', `:inside-header', `:arguments',
1692 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1693 `:post-affiliated' as keywords."
1707 value)))
1717 :begin begin
1718 :end end
1719 :value value
1725 "Interpret BABEL-CALL element as Org syntax."
1735 ;;;; Clock
1738 "Parse a clock.
1740 LIMIT bounds the search.
1742 Return a list whose CAR is `clock' and CDR is a plist containing
1743 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1744 `:post-affiliated' as keywords."
1764 :value value
1765 :duration duration
1766 :begin begin
1767 :end end
1768 :post-blank post-blank
1772 "Interpret CLOCK element as Org syntax."
1780 "%2s:%02s"
1784 ;;;; Comment
1787 "Parse a comment.
1789 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1790 the buffer position at the beginning of the first affiliated
1791 keyword and CDR is a plist of affiliated keywords along with
1792 their value.
1794 Return a list whose CAR is `comment' and CDR is a plist
1795 containing `:begin', `:end', `:value', `:post-blank',
1796 `:post-affiliated' keywords.
1798 Assume point is at comment beginning."
1807 ;; Get comments ending.
1810 ;; Accumulate lines without leading hash and first
1811 ;; whitespace.
1825 :end end
1826 :value value
1832 "Interpret COMMENT element as Org syntax.
1833 CONTENTS is nil."
1837 ;;;; Comment Block
1840 "Parse an export block.
1842 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1843 the buffer position at the beginning of the first affiliated
1844 keyword and CDR is a plist of affiliated keywords along with
1845 their value.
1847 Return a list whose CAR is `comment-block' and CDR is a plist
1848 containing `:begin', `:end', `:value', `:post-blank' and
1849 `:post-affiliated' keywords.
1851 Assume point is at comment block beginning."
1855 ;; Incomplete block: parse it as a paragraph.
1868 contents-begin contents-end)))
1872 :end end
1873 :value value
1879 "Interpret COMMENT-BLOCK element as Org syntax."
1886 ;;;; Diary Sexp
1889 "Parse a diary sexp.
1891 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1892 the buffer position at the beginning of the first affiliated
1893 keyword and CDR is a plist of affiliated keywords along with
1894 their value.
1896 Return a list whose CAR is `diary-sexp' and CDR is a plist
1897 containing `:begin', `:end', `:value', `:post-blank' and
1898 `:post-affiliated' keywords."
1910 :begin begin
1911 :end end
1917 "Interpret DIARY-SEXP as Org syntax."
1921 ;;;; Example Block
1924 "Parse an example block.
1926 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1927 the buffer position at the beginning of the first affiliated
1928 keyword and CDR is a plist of affiliated keywords along with
1929 their value.
1931 Return a list whose CAR is `example-block' and CDR is a plist
1932 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1933 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1934 `:value', `:post-blank' and `:post-affiliated' keywords."
1938 ;; Incomplete block: parse it as a paragraph.
1946 ;; Switches analysis.
1950 switches)
1953 'new
1956 ;; Subtract 1 to give number of lines before
1957 ;; first line.
1961 ;; Should labels be retained in (or stripped from) example
1962 ;; blocks?
1967 ;; What should code-references use - labels or
1968 ;; line-numbers?
1977 ;; Standard block parsing.
1983 contents-begin contents-end)))
1992 :end end
1993 :value value
1994 :switches switches
1995 :number-lines number-lines
1996 :preserve-indent preserve-indent
1997 :retain-labels retain-labels
1998 :use-labels use-labels
1999 :label-fmt label-fmt
2005 "Interpret EXAMPLE-BLOCK element as Org syntax."
2013 value
2018 ;;;; Export Block
2021 "Parse an export block.
2023 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2024 the buffer position at the beginning of the first affiliated
2025 keyword and CDR is a plist of affiliated keywords along with
2026 their value.
2028 Return a list whose CAR is `export-block' and CDR is a plist
2029 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2030 `:post-affiliated' keywords.
2032 Assume point is at export-block beginning."
2036 ;; Incomplete block: parse it as a paragraph.
2055 contents-end))))
2059 :begin begin
2060 :end end
2061 :value value
2067 "Interpret EXPORT-BLOCK element as Org syntax."
2073 ;;;; Fixed-width
2076 "Parse a fixed-width section.
2078 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2079 the buffer position at the beginning of the first affiliated
2080 keyword and CDR is a plist of affiliated keywords along with
2081 their value.
2083 Return a list whose CAR is `fixed-width' and CDR is a plist
2084 containing `:begin', `:end', `:value', `:post-blank' and
2085 `:post-affiliated' keywords.
2087 Assume point is at the beginning of the fixed-width area."
2091 value
2096 ;; Accumulate text without starting colons.
2109 :end end
2110 :value value
2116 "Interpret FIXED-WIDTH element as Org syntax."
2124 ;;;; Horizontal Rule
2127 "Parse an horizontal rule.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2132 their value.
2134 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2135 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2136 keywords."
2146 :end end
2152 "Interpret HORIZONTAL-RULE element as Org syntax."
2156 ;;;; Keyword
2159 "Parse a keyword at point.
2161 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2162 the buffer position at the beginning of the first affiliated
2163 keyword and CDR is a plist of affiliated keywords along with
2164 their value.
2166 Return a list whose CAR is `keyword' and CDR is a plist
2167 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2168 `:post-affiliated' keywords."
2170 ;; An orphaned affiliated keyword is considered as a regular
2171 ;; keyword. In this case AFFILIATED is nil, so we take care of
2172 ;; this corner case.
2185 :value value
2186 :begin begin
2187 :end end
2193 "Interpret KEYWORD element as Org syntax."
2199 ;;;; Latex Environment
2203 "Regexp matching the beginning of a LaTeX environment.
2204 The environment is captured by the first group.
2210 "Format string matching the ending of a LaTeX environment.
2214 "Parse a LaTeX environment.
2216 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2217 the buffer position at the beginning of the first affiliated
2218 keyword and CDR is a plist of affiliated keywords along with
2219 their value.
2221 Return a list whose CAR is `latex-environment' and CDR is a plist
2222 containing `:begin', `:end', `:value', `:post-blank' and
2223 `:post-affiliated' keywords.
2225 Assume point is at the beginning of the latex environment."
2232 limit t))
2233 ;; Incomplete latex environment: parse it as a paragraph.
2243 :end end
2244 :value value
2250 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2254 ;;;; Node Property
2257 "Parse a node-property at point.
2259 LIMIT bounds the search.
2261 Return a list whose CAR is `node-property' and CDR is a plist
2262 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2263 `:post-affiliated' keywords."
2273 limit))))
2276 :value value
2277 :begin begin
2278 :end end
2283 "Interpret NODE-PROPERTY element as Org syntax."
2289 ;;;; Paragraph
2292 "Parse a paragraph.
2294 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2295 the buffer position at the beginning of the first affiliated
2296 keyword and CDR is a plist of affiliated keywords along with
2297 their value.
2299 Return a list whose CAR is `paragraph' and CDR is a plist
2300 containing `:begin', `:end', `:contents-begin' and
2301 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2303 Assume point is at the beginning of the paragraph."
2310 ;; A matching `org-element-paragraph-separate' is not
2311 ;; necessarily the end of the paragraph. In particular,
2312 ;; drawers, blocks or LaTeX environments opening lines
2313 ;; must be closed. Moreover keywords with a secondary
2314 ;; value must belong to "dual keywords".
2328 limit t)))
2334 limit t)))
2337 org-element-dual-keywords))
2338 ;; Everything else is unambiguous.
2351 :end end
2352 :contents-begin contents-begin
2353 :contents-end contents-end
2359 "Interpret paragraph element as Org syntax.
2360 CONTENTS is the contents of the element."
2361 contents)
2364 ;;;; Planning
2367 "Parse a planning.
2369 LIMIT bounds the search.
2371 Return a list whose CAR is `planning' and CDR is a plist
2372 containing `:closed', `:deadline', `:scheduled', `:begin',
2373 `:end', `:post-blank' and `:post-affiliated' keywords."
2383 closed deadline scheduled)
2395 :deadline deadline
2396 :scheduled scheduled
2397 :begin begin
2398 :end end
2399 :post-blank post-blank
2403 "Interpret PLANNING element as Org syntax."
2405 #'identity
2422 ;;;; Src Block
2425 "Parse a src block.
2427 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2428 the buffer position at the beginning of the first affiliated
2429 keyword and CDR is a plist of affiliated keywords along with
2430 their value.
2432 Return a list whose CAR is `src-block' and CDR is a plist
2433 containing `:language', `:switches', `:parameters', `:begin',
2434 `:end', `:number-lines', `:retain-labels', `:use-labels',
2435 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2436 `:post-affiliated' keywords.
2438 Assume point is at the beginning of the block."
2441 limit t)))
2442 ;; Incomplete block: parse it as a paragraph.
2448 ;; Get language as a string.
2457 ;; Get switches.
2459 ;; Get parameters.
2461 ;; Switches analysis.
2465 switches)
2468 'new
2471 ;; Subtract 1 to give number of lines before
2472 ;; first line.
2480 ;; Should labels be retained in (or stripped from)
2481 ;; src blocks?
2486 ;; What should code-references use - labels or
2487 ;; line-numbers?
2492 ;; Retrieve code.
2499 ;; Get position after ending blank lines.
2509 :begin begin
2510 :end end
2511 :number-lines number-lines
2512 :preserve-indent preserve-indent
2513 :retain-labels retain-labels
2514 :use-labels use-labels
2515 :label-fmt label-fmt
2516 :value value
2522 "Interpret SRC-BLOCK element as Org syntax."
2531 val)
2546 ;;;; Table
2549 "Parse a table at point.
2551 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2552 the buffer position at the beginning of the first affiliated
2553 keyword and CDR is a plist of affiliated keywords along with
2554 their value.
2556 Return a list whose CAR is `table' and CDR is a plist containing
2557 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2558 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2559 keywords.
2561 Assume point is at the beginning of the table."
2577 acc))
2584 :end end
2585 :type type
2586 :tblfm tblfm
2587 ;; Only `org' tables have contents. `table.el' tables
2588 ;; use a `:value' property to store raw table as
2589 ;; a string.
2594 table-begin table-end))
2600 "Interpret TABLE element as Org syntax.
2601 CONTENTS is a string, if table's type is `org', or nil."
2612 ;;;; Table Row
2615 "Parse table row at point.
2617 Return a list whose CAR is `table-row' and CDR is a plist
2618 containing `:begin', `:end', `:contents-begin', `:contents-end',
2619 `:type', `:post-blank' and `:post-affiliated' keywords."
2623 ;; A table rule has no contents. In that case, ensure
2624 ;; CONTENTS-BEGIN matches CONTENTS-END.
2634 :begin begin
2635 :end end
2636 :contents-begin contents-begin
2637 :contents-end contents-end
2642 "Interpret TABLE-ROW element as Org syntax.
2643 CONTENTS is the contents of the table row."
2648 ;;;; Verse Block
2651 "Parse a verse block.
2653 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2654 the buffer position at the beginning of the first affiliated
2655 keyword and CDR is a plist of affiliated keywords along with
2656 their value.
2658 Return a list whose CAR is `verse-block' and CDR is a plist
2659 containing `:begin', `:end', `:contents-begin', `:contents-end',
2660 `:post-blank' and `:post-affiliated' keywords.
2662 Assume point is at beginning of the block."
2666 ;; Incomplete block: parse it as a paragraph.
2681 :end end
2682 :contents-begin contents-begin
2683 :contents-end contents-end
2689 "Interpret verse-block element as Org syntax.
2690 CONTENTS is verse block contents."
2694 \f
2695 ;;; Objects
2696 ;;
2697 ;; Unlike to elements, raw text can be found between objects. Hence,
2698 ;; `org-element--object-lex' is provided to find the next object in
2699 ;; buffer.
2700 ;;
2701 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2702 ;; object types they can contain will be specified in
2703 ;; `org-element-object-restrictions'.
2704 ;;
2705 ;; Creating a new type of object requires to alter
2706 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2707 ;; new type in `org-element-all-objects', and possibly add
2708 ;; restrictions in `org-element-object-restrictions'.
2710 ;;;; Bold
2713 "Parse bold object at point, if any.
2715 When at a bold object, return a list whose car is `bold' and cdr
2716 is a plist with `:begin', `:end', `:contents-begin' and
2717 `:contents-end' and `:post-blank' keywords. Otherwise, return
2718 nil.
2720 Assume point is at the first star marker."
2732 :end end
2733 :contents-begin contents-begin
2734 :contents-end contents-end
2738 "Interpret bold object as Org syntax.
2739 CONTENTS is the contents of the object."
2743 ;;;; Code
2746 "Parse code object at point, if any.
2748 When at a code object, return a list whose car is `code' and cdr
2749 is a plist with `:value', `:begin', `:end' and `:post-blank'
2750 keywords. Otherwise, return nil.
2752 Assume point is at the first tilde marker."
2763 :begin begin
2764 :end end
2768 "Interpret CODE object as Org syntax."
2772 ;;;; Entity
2775 "Parse entity at point, if any.
2777 When at an entity, return a list whose car is `entity' and cdr
2778 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2779 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2780 `:post-blank' as keywords. Otherwise, return nil.
2782 Assume point is at the beginning of the entity."
2784 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2802 :begin begin
2803 :end end
2804 :use-brackets-p bracketsp
2808 "Interpret ENTITY object as Org syntax."
2814 ;;;; Export Snippet
2817 "Parse export snippet at point.
2819 When at an export snippet, return a list whose car is
2820 `export-snippet' and cdr a plist with `:begin', `:end',
2821 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2822 return nil.
2824 Assume point is at the beginning of the snippet."
2840 :value value
2841 :begin begin
2842 :end end
2846 "Interpret EXPORT-SNIPPET object as Org syntax."
2852 ;;;; Footnote Reference
2855 "Parse footnote reference at point, if any.
2857 When at a footnote reference, return a list whose car is
2858 `footnote-reference' and cdr a plist with `:label', `:type',
2859 `:begin', `:end', `:content-begin', `:contents-end' and
2860 `:post-blank' as keywords. Otherwise, return nil."
2876 :type type
2877 :begin begin
2878 :end end
2884 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2885 CONTENTS is its definition, when inline, or nil."
2891 ;;;; Inline Babel Call
2894 "Parse inline babel call at point, if any.
2896 When at an inline babel call, return a list whose car is
2897 `inline-babel-call' and cdr a plist with `:call',
2898 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2899 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2901 Assume point is at the beginning of the babel call."
2915 ;; Parenthesis are mandatory.
2926 :inside-header inside-header
2927 :arguments arguments
2928 :end-header end-header
2929 :begin begin
2930 :end end
2931 :value value
2935 "Interpret INLINE-BABEL-CALL object as Org syntax."
2945 ;;;; Inline Src Block
2948 "Parse inline source block at point, if any.
2950 When at an inline source block, return a list whose car is
2951 `inline-src-block' and cdr a plist with `:begin', `:end',
2952 `:language', `:value', `:parameters' and `:post-blank' as
2953 keywords. Otherwise, return nil.
2955 Assume point is at the beginning of the inline src block."
2972 :value value
2973 :parameters parameters
2974 :begin begin
2979 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2984 language
2986 body)))
2988 ;;;; Italic
2991 "Parse italic object at point, if any.
2993 When at an italic object, return a list whose car is `italic' and
2994 cdr is a plist with `:begin', `:end', `:contents-begin' and
2995 `:contents-end' and `:post-blank' keywords. Otherwise, return
2996 nil.
2998 Assume point is at the first slash marker."
3010 :end end
3011 :contents-begin contents-begin
3012 :contents-end contents-end
3016 "Interpret italic object as Org syntax.
3017 CONTENTS is the contents of the object."
3021 ;;;; Latex Fragment
3024 "Parse LaTeX fragment at point, if any.
3026 When at a LaTeX fragment, return a list whose car is
3027 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3028 and `:post-blank' as keywords. Otherwise, return nil.
3030 Assume point is at the beginning of the LaTeX fragment."
3049 ;; Macro.
3059 :begin begin
3060 :end end
3064 "Interpret LATEX-FRAGMENT object as Org syntax."
3067 ;;;; Line Break
3070 "Parse line break at point, if any.
3072 When at a line break, return a list whose car is `line-break',
3073 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3074 Otherwise, return nil.
3076 Assume point is at the beginning of the line break."
3085 "Interpret LINE-BREAK object as Org syntax."
3089 ;;;; Link
3092 "Parse link at point, if any.
3094 When at a link, return a list whose car is `link' and cdr a plist
3095 with `:type', `:path', `:format', `:raw-link', `:application',
3096 `:search-option', `:begin', `:end', `:contents-begin',
3097 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3098 nil.
3100 Assume point is at the beginning of the link."
3103 end contents-begin contents-end link-end post-blank path type format
3104 raw-link search-option application)
3106 ;; Type 1: Text targeted from a radio target.
3116 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3122 ;; RAW-LINK is the original link. Expand any
3123 ;; abbreviation in it.
3124 ;;
3125 ;; Also treat any newline character and associated
3126 ;; indentation as a single space character. This is not
3127 ;; compatible with RFC 3986, which requires to ignore
3128 ;; them altogether. However, doing so would require
3129 ;; users to encode spaces on the fly when writing links
3130 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3131 ;; [[shell:ls *.org]], which defeats Org's focus on
3132 ;; simplicity.
3137 ;; Determine TYPE of link and set PATH accordingly. According
3138 ;; to RFC 3986, remove whitespaces from URI in external links.
3139 ;; In internal ones, treat indentation as a single space.
3141 ;; File type.
3146 ;; Explicit type (http, irc, bbdb...).
3150 ;; Code-ref type: PATH is the name of the reference.
3155 ;; Custom-id type: PATH is the name of the custom id.
3159 ;; Fuzzy type: Internal link either matches a target, an
3160 ;; headline name or nothing. PATH is the target or
3161 ;; headline's name.
3165 ;; Type 3: Plain link, e.g., http://orgmode.org
3172 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3173 ;; bracket links, follow RFC 3986 and remove any extra
3174 ;; whitespace in URI.
3185 ;; In any case, deduce end point after trailing white space from
3186 ;; LINK-END variable.
3191 ;; Special "file" type link processing. Extract opening
3192 ;; application and search option, if any. Also normalize URI.
3199 ;; Translate link, if `org-link-translation-function' is set.
3207 :path path
3208 :format format
3210 :application application
3211 :search-option search-option
3212 :begin begin
3213 :end end
3214 :contents-begin contents-begin
3215 :contents-end contents-end
3219 "Interpret LINK object as Org syntax.
3220 CONTENTS is the contents of the object, or nil."
3225 ;; Links with contents and internal links have to
3226 ;; use bracket syntax. Ignore `:format' in these
3227 ;; cases. This is also the default syntax when the
3228 ;; property is not defined, e.g., when the object
3229 ;; was crafted by the user.
3232 ;; Since this is going to be used as
3233 ;; a format string, escape percent signs
3234 ;; in description.
3237 `nil
3240 ;; Otherwise, just obey to `:format'.
3252 path
3258 ;;;; Macro
3261 "Parse macro at point, if any.
3263 When at a macro, return a list whose car is `macro' and cdr
3264 a plist with `:key', `:args', `:begin', `:end', `:value' and
3265 `:post-blank' as keywords. Otherwise, return nil.
3267 Assume point is at the macro."
3280 :value value
3281 :args args
3282 :begin begin
3283 :end end
3287 "Interpret MACRO object as Org syntax."
3291 ;;;; Radio-target
3294 "Parse radio target at point, if any.
3296 When at a radio target, return a list whose car is `radio-target'
3297 and cdr a plist with `:begin', `:end', `:contents-begin',
3298 `:contents-end', `:value' and `:post-blank' as keywords.
3299 Otherwise, return nil.
3301 Assume point is at the radio target."
3313 :end end
3314 :contents-begin contents-begin
3315 :contents-end contents-end
3316 :post-blank post-blank
3320 "Interpret target object as Org syntax.
3321 CONTENTS is the contents of the object."
3325 ;;;; Statistics Cookie
3328 "Parse statistics cookie at point, if any.
3330 When at a statistics cookie, return a list whose car is
3331 `statistics-cookie', and cdr a plist with `:begin', `:end',
3332 `:value' and `:post-blank' keywords. Otherwise, return nil.
3334 Assume point is at the beginning of the statistics-cookie."
3345 :end end
3346 :value value
3350 "Interpret STATISTICS-COOKIE object as Org syntax."
3354 ;;;; Strike-Through
3357 "Parse strike-through object at point, if any.
3359 When at a strike-through object, return a list whose car is
3360 `strike-through' and cdr is a plist with `:begin', `:end',
3361 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3362 Otherwise, return nil.
3364 Assume point is at the first plus sign marker."
3376 :end end
3377 :contents-begin contents-begin
3378 :contents-end contents-end
3382 "Interpret strike-through object as Org syntax.
3383 CONTENTS is the contents of the object."
3387 ;;;; Subscript
3390 "Parse subscript at point, if any.
3392 When at a subscript object, return a list whose car is
3393 `subscript' and cdr a plist with `:begin', `:end',
3394 `:contents-begin', `:contents-end', `:use-brackets-p' and
3395 `:post-blank' as keywords. Otherwise, return nil.
3397 Assume point is at the underscore."
3411 :end end
3412 :use-brackets-p bracketsp
3413 :contents-begin contents-begin
3414 :contents-end contents-end
3418 "Interpret SUBSCRIPT object as Org syntax.
3419 CONTENTS is the contents of the object."
3422 contents))
3425 ;;;; Superscript
3428 "Parse superscript at point, if any.
3430 When at a superscript object, return a list whose car is
3431 `superscript' and cdr a plist with `:begin', `:end',
3432 `:contents-begin', `:contents-end', `:use-brackets-p' and
3433 `:post-blank' as keywords. Otherwise, return nil.
3435 Assume point is at the caret."
3449 :end end
3450 :use-brackets-p bracketsp
3451 :contents-begin contents-begin
3452 :contents-end contents-end
3456 "Interpret SUPERSCRIPT object as Org syntax.
3457 CONTENTS is the contents of the object."
3460 contents))
3463 ;;;; Table Cell
3466 "Parse table cell at point.
3467 Return a list whose car is `table-cell' and cdr is a plist
3468 containing `:begin', `:end', `:contents-begin', `:contents-end'
3469 and `:post-blank' keywords."
3477 :end end
3478 :contents-begin contents-begin
3479 :contents-end contents-end
3483 "Interpret table-cell element as Org syntax.
3484 CONTENTS is the contents of the cell, or nil."
3488 ;;;; Target
3491 "Parse target at point, if any.
3493 When at a target, return a list whose car is `target' and cdr
3494 a plist with `:begin', `:end', `:value' and `:post-blank' as
3495 keywords. Otherwise, return nil.
3497 Assume point is at the target."
3507 :end end
3508 :value value
3512 "Interpret TARGET object as Org syntax."
3516 ;;;; Timestamp
3527 "Parse time stamp at point, if any.
3529 When at a time stamp, return a list whose car is `timestamp', and
3530 cdr a plist with `:type', `:raw-value', `:year-start',
3531 `:month-start', `:day-start', `:hour-start', `:minute-start',
3532 `:year-end', `:month-end', `:day-end', `:hour-end',
3533 `:minute-end', `:repeater-type', `:repeater-value',
3534 `:repeater-unit', `:warning-type', `:warning-value',
3535 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3536 Otherwise, return nil.
3538 Assume point is at the beginning of the timestamp."
3557 date-start)
3568 raw-value)
3570 :repeater-type
3576 :repeater-unit
3585 :warning-unit
3588 year-start month-start day-start hour-start minute-start year-end
3589 month-end day-end hour-end minute-end)
3590 ;; Parse date-start.
3598 ;; Compute date-end. It can be provided directly in time-stamp,
3599 ;; or extracted from time range. Otherwise, it defaults to the
3600 ;; same values as date-start.
3610 :raw-value raw-value
3611 :year-start year-start
3612 :month-start month-start
3613 :day-start day-start
3614 :hour-start hour-start
3615 :minute-start minute-start
3616 :year-end year-end
3617 :month-end month-end
3618 :day-end day-end
3619 :hour-end hour-end
3620 :minute-end minute-end
3621 :begin begin
3622 :end end
3624 repeater-props
3625 warning-props))))))
3628 "Interpret TIMESTAMP object as Org syntax."
3646 ;; Build an Org timestamp string from TIME. ACTIVEP is
3647 ;; non-nil when time stamp is active. If WITH-TIME-P is
3648 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3649 ;; specify a time range in the timestamp. REPEAT-STRING is
3650 ;; the repeater string, if any.
3654 org-time-stamp-formats)
3655 time)))
3661 nil nil ts)))
3666 " "
3667 s
3669 ;; Return value.
3670 ts)))
3682 build-ts-string
3701 0
3709 "--"
3722 ;;;; Underline
3725 "Parse underline object at point, if any.
3727 When at an underline object, return a list whose car is
3728 `underline' and cdr is a plist with `:begin', `:end',
3729 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3730 Otherwise, return nil.
3732 Assume point is at the first underscore marker."
3744 :end end
3745 :contents-begin contents-begin
3746 :contents-end contents-end
3750 "Interpret underline object as Org syntax.
3751 CONTENTS is the contents of the object."
3755 ;;;; Verbatim
3758 "Parse verbatim object at point, if any.
3760 When at a verbatim object, return a list whose car is `verbatim'
3761 and cdr is a plist with `:value', `:begin', `:end' and
3762 `:post-blank' keywords. Otherwise, return nil.
3764 Assume point is at the first equal sign marker."
3775 :begin begin
3776 :end end
3780 "Interpret VERBATIM object as Org syntax."
3784 \f
3785 ;;; Parsing Element Starting At Point
3786 ;;
3787 ;; `org-element--current-element' is the core function of this section.
3788 ;; It returns the Lisp representation of the element starting at
3789 ;; point.
3790 ;;
3791 ;; `org-element--current-element' makes use of special modes. They
3792 ;; are activated for fixed element chaining (e.g., `plain-list' >
3793 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3794 ;; `section'). Special modes are: `first-section', `item',
3795 ;; `node-property', `section' and `table-row'.
3798 "Parse the element starting at point.
3800 Return value is a list like (TYPE PROPS) where TYPE is the type
3801 of the element and PROPS a plist of properties associated to the
3802 element.
3804 Possible types are defined in `org-element-all-elements'.
3806 LIMIT bounds the search.
3808 Optional argument GRANULARITY determines the depth of the
3809 recursion. Allowed values are `headline', `greater-element',
3810 `element', `object' or nil. When it is broader than `object' (or
3811 nil), secondary values will not be parsed, since they only
3812 contain objects.
3814 Optional argument MODE, when non-nil, can be either
3815 `first-section', `section', `planning', `item', `node-property'
3816 and `table-row'.
3818 If STRUCTURE isn't provided but MODE is set to `item', it will be
3819 computed.
3821 This function assumes point is always at the beginning of the
3822 element it has to parse."
3825 ;; Determine if parsing depth allows for secondary strings
3826 ;; parsing. It only applies to elements referenced in
3827 ;; `org-element-secondary-value-alist'.
3830 ;; Item.
3833 ;; Table Row.
3835 ;; Node Property.
3837 ;; Headline.
3840 ;; Sections (must be checked after headline).
3845 limit)))
3846 ;; Planning.
3851 ;; Property drawer.
3857 ;; When not at bol, point is at the beginning of an item or
3858 ;; a footnote definition: next item is always a paragraph.
3860 ;; Clock.
3862 ;; Inlinetask.
3865 ;; From there, elements can have affiliated keywords.
3868 ;; Jumping over affiliated keywords put point off-limits.
3869 ;; Parse them as regular keywords.
3873 ;; LaTeX Environment.
3876 ;; Drawer and Property Drawer.
3879 ;; Fixed Width
3882 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3883 ;; Keywords.
3901 limit
3902 affiliated))
3915 ;; Footnote Definition.
3918 ;; Horizontal Rule.
3921 ;; Diary Sexp.
3924 ;; Table.
3927 ;; List.
3930 limit affiliated
3932 ;; Default element: Paragraph.
3936 ;; Most elements can have affiliated keywords. When looking for an
3937 ;; element beginning, we want to move before them, as they belong to
3938 ;; that element, and, in the meantime, collect information they give
3939 ;; into appropriate properties. Hence the following function.
3942 "Collect affiliated keywords from point down to LIMIT.
3944 Return a list whose CAR is the position at the first of them and
3945 CDR a plist of keywords and values and move point to the
3946 beginning of the first line after them.
3948 As a special case, if element doesn't start at the beginning of
3949 the line (e.g., a paragraph starting an item), CAR is current
3950 position of point and CDR is nil."
3954 ;; RESTRICT is the list of objects allowed in parsed
3955 ;; keywords value.
3957 output)
3960 ;; Apply translation to RAW-KWD. From there, KWD is
3961 ;; the official keyword.
3963 org-element-keyword-translation-alist))
3964 raw-kwd))
3965 ;; Find main value for any keyword.
3971 ;; PARSEDP is non-nil when keyword should have its
3972 ;; value parsed.
3974 ;; If KWD is a dual keyword, find its secondary
3975 ;; value. Maybe parse it.
3984 ;; Attribute a property name to KWD.
3986 ;; Now set final shape for VALUE.
3992 nil restrict)))
3996 ;; Attributes can always appear on multiple lines.
3999 ;; Eventually store the new value in OUTPUT.
4001 ;; Move to next keyword.
4003 ;; If affiliated keywords are orphaned: move back to first one.
4004 ;; They will be parsed as a paragraph.
4006 ;; Return value.
4010 \f
4011 ;;; The Org Parser
4012 ;;
4013 ;; The two major functions here are `org-element-parse-buffer', which
4014 ;; parses Org syntax inside the current buffer, taking into account
4015 ;; region, narrowing, or even visibility if specified, and
4016 ;; `org-element-parse-secondary-string', which parses objects within
4017 ;; a given string.
4018 ;;
4019 ;; The (almost) almighty `org-element-map' allows applying a function
4020 ;; on elements or objects matching some type, and accumulating the
4021 ;; resulting values. In an export situation, it also skips unneeded
4022 ;; parts of the parse tree.
4025 "Recursively parse the buffer and return structure.
4026 If narrowing is in effect, only parse the visible part of the
4027 buffer.
4029 Optional argument GRANULARITY determines the depth of the
4030 recursion. It can be set to the following symbols:
4032 `headline' Only parse headlines.
4033 `greater-element' Don't recurse into greater elements except
4034 headlines and sections. Thus, elements
4035 parsed are the top-level ones.
4036 `element' Parse everything but objects and plain text.
4037 `object' Parse the complete buffer (default).
4039 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4040 elements.
4042 An element or object is represented as a list with the
4043 pattern (TYPE PROPERTIES CONTENTS), where :
4045 TYPE is a symbol describing the element or object. See
4046 `org-element-all-elements' and `org-element-all-objects' for an
4047 exhaustive list of such symbols. One can retrieve it with
4048 `org-element-type' function.
4050 PROPERTIES is the list of attributes attached to the element or
4051 object, as a plist. Although most of them are specific to the
4052 element or object type, all types share `:begin', `:end',
4053 `:post-blank' and `:parent' properties, which respectively
4054 refer to buffer position where the element or object starts,
4055 ends, the number of white spaces or blank lines after it, and
4056 the element or object containing it. Properties values can be
4057 obtained by using `org-element-property' function.
4059 CONTENTS is a list of elements, objects or raw strings
4060 contained in the current element or object, when applicable.
4061 One can access them with `org-element-contents' function.
4063 The Org buffer has `org-data' as type and nil as properties.
4064 `org-element-map' function can be used to find specific elements
4065 or objects within the parse tree.
4067 This function assumes that current major mode is `org-mode'."
4073 ;; Start in `first-section' mode so text before the first
4074 ;; headline belongs to a section.
4078 "Recursively parse objects in STRING and return structure.
4080 RESTRICTION is a symbol limiting the object types that will be
4081 looked after.
4083 Optional argument PARENT, when non-nil, is the element or object
4084 containing the secondary string. It is used to set correctly
4085 `:parent' property within the string.
4087 If STRING is the empty string or nil, return nil."
4104 "Map a function on selected elements or objects.
4106 DATA is a parse tree, an element, an object, a string, or a list
4107 of such constructs. TYPES is a symbol or list of symbols of
4108 elements or objects types (see `org-element-all-elements' and
4109 `org-element-all-objects' for a complete list of types). FUN is
4110 the function called on the matching element or object. It has to
4111 accept one argument: the element or object itself.
4113 When optional argument INFO is non-nil, it should be a plist
4114 holding export options. In that case, parts of the parse tree
4115 not exportable according to that property list will be skipped.
4117 When optional argument FIRST-MATCH is non-nil, stop at the first
4118 match for which FUN doesn't return nil, and return that value.
4120 Optional argument NO-RECURSION is a symbol or a list of symbols
4121 representing elements or objects types. `org-element-map' won't
4122 enter any recursive element or object whose type belongs to that
4123 list. Though, FUN can still be applied on them.
4125 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4126 apply to matching objects within parsed affiliated keywords (see
4127 `org-element-parsed-keywords').
4129 Nil values returned from FUN do not appear in the results.
4132 Examples:
4133 ---------
4135 Assuming TREE is a variable containing an Org buffer parse tree,
4136 the following example will return a flat list of all `src-block'
4137 and `example-block' elements in it:
4141 The following snippet will find the first headline with a level
4145 (lambda (hl)
4146 (and (= (org-element-property :level hl) 1)
4148 (org-element-property :begin hl)))
4149 nil t)
4151 The next example will return a flat list of all `plain-list' type
4152 elements in TREE that are not a sub-list themselves:
4156 Eventually, this example will return a flat list of all `bold'
4157 type objects containing a `latex-snippet' type object, even
4158 looking into captions:
4161 (lambda (b)
4163 nil nil nil t)"
4164 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4168 ;; Recursion depth is determined by --CATEGORY.
4175 ;; If one object is found, the function has
4176 ;; to recurse into every object.
4179 ;; If one regular element is found, the
4180 ;; function has to recurse, at least, into
4181 ;; every element it encounters.
4184 --acc)
4187 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4188 ;; holding contextual information.
4192 ;; Ignored element in an export context.
4194 ;; List of elements or objects.
4196 ;; Unconditionally enter parse trees.
4200 ;; Check if TYPE is matching among TYPES. If so,
4201 ;; apply FUN to --DATA and accumulate return value
4202 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4208 ;; If --DATA has a secondary string that can contain
4209 ;; objects with their type among TYPES, look inside.
4212 org-element-secondary-value-alist)))
4214 ;; If --DATA has any parsed affiliated keywords and
4215 ;; WITH-AFFILIATED is non-nil, look for objects in
4216 ;; them.
4223 ;; Pay attention to the type of parsed
4224 ;; keyword. In particular, preserve order for
4225 ;; multiple keywords.
4238 ;; Determine if a recursion into --DATA is possible.
4240 ;; --TYPE is explicitly removed from recursion.
4242 ;; --DATA has no contents.
4244 ;; Looking for greater elements but --DATA is
4245 ;; simply an element or an object.
4248 ;; Looking for elements but --DATA is an object.
4251 ;; In any other case, map contents.
4255 ;; Return value in a proper order.
4259 ;; The following functions are internal parts of the parser.
4260 ;;
4261 ;; The first one, `org-element--parse-elements' acts at the element's
4262 ;; level.
4263 ;;
4264 ;; The second one, `org-element--parse-objects' applies on all objects
4265 ;; of a paragraph or a secondary string. It calls
4266 ;; `org-element--object-lex' to find the next object in the current
4267 ;; container.
4270 "Return next special mode according to TYPE, or nil.
4271 TYPE is a symbol representing the type of an element or object
4272 containing next element if PARENTP is non-nil, or before it
4273 otherwise. Modes can be either `first-section', `item',
4274 `node-property', `planning', `property-drawer', `section',
4275 `table-row' or nil."
4292 "Parse elements between BEG and END positions.
4294 MODE prioritizes some elements over the others. It can be set to
4295 `first-section', `section', `planning', `item', `node-property'
4296 or `table-row'.
4298 When value is `item', STRUCTURE will be used as the current list
4299 structure.
4301 GRANULARITY determines the depth of the recursion. See
4302 `org-element-parse-buffer' for more information.
4304 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4305 elements.
4307 Elements are accumulated into ACC."
4310 ;; Visible only: skip invisible parts at the beginning of the
4311 ;; element.
4314 ;; When parsing only headlines, skip any text before first one.
4319 ;; Find current element's type and parse it accordingly to
4320 ;; its category.
4322 end granularity mode structure))
4326 ;; Visible only: skip invisible parts between siblings.
4329 ;; Fill ELEMENT contents by side-effect.
4331 ;; If element has no contents, don't modify it.
4333 ;; Greater element: parse it between `contents-begin' and
4334 ;; `contents-end'. Make sure GRANULARITY allows the
4335 ;; recursion, or ELEMENT is a headline, in which case going
4336 ;; inside is mandatory, in order to get sub-level headings.
4344 ;; Possibly switch to a special mode.
4348 granularity visible-only element))
4349 ;; ELEMENT has contents. Parse objects inside, if
4350 ;; GRANULARITY allows it.
4356 ;; Update mode.
4358 ;; Return result.
4362 "Return next object in current buffer or nil.
4363 RESTRICTION is a list of object types, as symbols, that should be
4364 looked after. This function assumes that the buffer is narrowed
4365 to an appropriate container (e.g., a paragraph)."
4369 ;; Object regexp sometimes needs to have a peek at
4370 ;; a character ahead. Therefore, when there is a hard
4371 ;; limit, make it one more than the true beginning of the
4372 ;; radio target.
4379 nil)
4380 ;; Since we moved backward, we do not want to
4381 ;; match again an hypothetical 1-character long
4382 ;; radio link before us. Realizing that this can
4383 ;; only happen if such a radio link starts at
4384 ;; beginning of line, we prevent this here.
4390 found)
4456 ;; This is probably a plain link.
4466 "Parse objects between BEG and END and return recursive structure.
4468 Objects are accumulated in ACC. RESTRICTION is a list of object
4469 successors which are allowed in the current object.
4471 ACC becomes the parent for all parsed objects. However, if ACC
4472 is nil (i.e., a secondary string is being parsed) and optional
4473 argument PARENT is non-nil, use it as the parent for all objects.
4474 Eventually, if both ACC and PARENT are nil, the common parent is
4475 the list of objects itself."
4483 ;; Text before any object.
4488 contents))))
4489 ;; Object...
4494 ;; Fill contents of NEXT-OBJECT if possible.
4496 cont-beg
4498 next-object
4500 next-object)
4501 contents)
4503 ;; Text after last object.
4507 contents)))
4508 ;; Result. Set appropriate parent.
4516 \f
4517 ;;; Towards A Bijective Process
4518 ;;
4519 ;; The parse tree obtained with `org-element-parse-buffer' is really
4520 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4521 ;; interpreted and expanded into a string with canonical Org syntax.
4522 ;; Hence `org-element-interpret-data'.
4523 ;;
4524 ;; The function relies internally on
4525 ;; `org-element--interpret-affiliated-keywords'.
4527 ;;;###autoload
4529 "Interpret DATA as Org syntax.
4530 DATA is a parse tree, an element, an object or a secondary string
4531 to interpret. Return Org syntax as a string."
4535 ;; Find interpreter for current object or
4536 ;; element. If it doesn't exist (e.g. this is
4537 ;; a pseudo object or element), return contents,
4538 ;; if any.
4545 ;; Secondary string.
4548 data
4550 ;; Full Org document.
4555 ;; Plain text: return it.
4557 ;; Element or object without contents.
4560 ;; Element or object with contents.
4563 interpret
4564 data
4565 ;; Recursively interpret contents.
4570 data
4571 ;; Fix indentation of elements containing
4572 ;; objects. We ignore `table-row'
4573 ;; elements as they are one line long
4574 ;; anyway.
4576 data
4577 ;; When normalizing first paragraph of
4578 ;; an item or a footnote-definition,
4579 ;; ignore first line's indentation.
4587 ;; Build white spaces. If no `:post-blank' property
4588 ;; is specified, assume its value is 0.
4598 "Return ELEMENT's affiliated keywords as Org syntax.
4599 If there is no affiliated keyword, return the empty string."
4609 ": "
4612 value)
4620 ;; All attribute keywords can have multiple lines.
4626 ;; List all ELEMENT's properties matching an attribute line or an
4627 ;; affiliated keyword, but ignore translated keywords since they
4628 ;; cannot belong to the property list.
4635 org-element-keyword-translation-alist)))))
4636 collect prop)
4639 ;; Because interpretation of the parse tree must return the same
4640 ;; number of blank lines between elements and the same number of white
4641 ;; space after objects, some special care must be given to white
4642 ;; spaces.
4643 ;;
4644 ;; The first function, `org-element-normalize-string', ensures any
4645 ;; string different from the empty string will end with a single
4646 ;; newline character.
4647 ;;
4648 ;; The second function, `org-element-normalize-contents', removes
4649 ;; global indentation from the contents of the current element.
4652 "Ensure string S ends with a single newline character.
4654 If S isn't a string return it unchanged. If S is the empty
4655 string, return it. Otherwise, return a new string with a single
4656 newline character at its end."
4664 "Normalize plain text in ELEMENT's contents.
4666 ELEMENT must only contain plain text and objects.
4668 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4669 indentation to compute maximal common indentation.
4671 Return the normalized element that is element with global
4672 indentation removed from its contents."
4674 ;; Return minimal common indentation within BLOB. This is
4675 ;; done by walking recursively BLOB and updating MIN-IND
4676 ;; along the way. FIRST-FLAG is non-nil when the next
4677 ;; object is expected to be a string that doesn't start
4678 ;; with a newline character. It happens for strings at
4679 ;; the beginnings of the contents or right after a line
4680 ;; break.
4686 ;; Objects cannot start with spaces: in this
4687 ;; case, indentation is 0.
4728 ;; Build ELEMENT back, replacing each string with the same
4729 ;; string minus common indentation.
4732 ;; Return DATUM with all its strings indentation
4733 ;; shortened from MIN-IND white spaces.
4753 org-element-recursive-objects)
4757 datum)))
4761 \f
4762 ;;; Cache
4763 ;;
4764 ;; Implement a caching mechanism for `org-element-at-point' and
4765 ;; `org-element-context', which see.
4766 ;;
4767 ;; A single public function is provided: `org-element-cache-reset'.
4768 ;;
4769 ;; Cache is enabled by default, but can be disabled globally with
4770 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4771 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4772 ;; can be tweaked to control caching behaviour.
4773 ;;
4774 ;; Internally, parsed elements are stored in an AVL tree,
4775 ;; `org-element--cache'. This tree is updated lazily: whenever
4776 ;; a change happens to the buffer, a synchronization request is
4777 ;; registered in `org-element--cache-sync-requests' (see
4778 ;; `org-element--cache-submit-request'). During idle time, requests
4779 ;; are processed by `org-element--cache-sync'. Synchronization also
4780 ;; happens when an element is required from the cache. In this case,
4781 ;; the process stops as soon as the needed element is up-to-date.
4782 ;;
4783 ;; A synchronization request can only apply on a synchronized part of
4784 ;; the cache. Therefore, the cache is updated at least to the
4785 ;; location where the new request applies. Thus, requests are ordered
4786 ;; from left to right and all elements starting before the first
4787 ;; request are correct. This property is used by functions like
4788 ;; `org-element--cache-find' to retrieve elements in the part of the
4789 ;; cache that can be trusted.
4790 ;;
4791 ;; A request applies to every element, starting from its original
4792 ;; location (or key, see below). When a request is processed, it
4793 ;; moves forward and may collide the next one. In this case, both
4794 ;; requests are merged into a new one that starts from that element.
4795 ;; As a consequence, the whole synchronization complexity does not
4796 ;; depend on the number of pending requests, but on the number of
4797 ;; elements the very first request will be applied on.
4798 ;;
4799 ;; Elements cannot be accessed through their beginning position, which
4800 ;; may or may not be up-to-date. Instead, each element in the tree is
4801 ;; associated to a key, obtained with `org-element--cache-key'. This
4802 ;; mechanism is robust enough to preserve total order among elements
4803 ;; even when the tree is only partially synchronized.
4807 "Non-nil when Org parser should cache its results.
4809 WARNING: for the time being, using cache sometimes triggers
4810 freezes. Therefore, it is disabled by default. Activate it if
4817 "Maximum duration, as a time value, for a cache synchronization.
4818 If the synchronization is not over after this delay, the process
4819 pauses and resumes after `org-element-cache-sync-break'
4823 "Duration, as a time value, of the pause between synchronizations.
4827 ;;;; Data Structure
4830 "AVL tree used to cache elements.
4831 Each node of the tree contains an element. Comparison is done
4832 with `org-element--cache-compare'. This cache is used in
4836 "List of pending synchronization requests.
4838 A request is a vector with the following pattern:
4840 \[NEXT BEG END OFFSET PARENT PHASE]
4842 Processing a synchronization request consists of three phases:
4844 0. Delete modified elements,
4845 1. Fill missing area in cache,
4846 2. Shift positions and re-parent elements after the changes.
4848 During phase 0, NEXT is the key of the first element to be
4849 removed, BEG and END is buffer position delimiting the
4850 modifications. Elements starting between them (inclusive) are
4851 removed. So are elements whose parent is removed. PARENT, when
4852 non-nil, is the parent of the first element to be removed.
4854 During phase 1, NEXT is the key of the next known element in
4855 cache and BEG its beginning position. Parse buffer between that
4856 element and the one before it in order to determine the parent of
4857 the next element. Set PARENT to the element containing NEXT.
4859 During phase 2, NEXT is the key of the next element to shift in
4860 the parse tree. All elements starting from this one have their
4861 properties relatives to buffer positions shifted by integer
4862 OFFSET and, if they belong to element PARENT, are adopted by it.
4870 "Hash table used to store keys during synchronization.
4874 "Return a unique key for ELEMENT in cache tree.
4876 Keys are used to keep a total order among elements in the cache.
4877 Comparison is done with `org-element--cache-key-less-p'.
4879 When no synchronization is taking place, a key is simply the
4880 beginning position of the element, or that position plus one in
4881 the case of an first item (respectively row) in
4882 a list (respectively a table).
4884 During a synchronization, the key is the one the element had when
4885 the cache was synchronized for the last time. Elements added to
4886 cache during the synchronization get a new key generated with
4887 `org-element--cache-generate-key'.
4889 Such keys are stored in `org-element--cache-sync-keys'. The hash
4890 table is cleared once the synchronization is complete."
4893 ;; Increase beginning position of items (respectively
4894 ;; table rows) by one, so the first item can get
4895 ;; a different key from its parent list (respectively
4896 ;; table).
4899 begin)))
4902 key))))
4905 "Generate a key between LOWER and UPPER.
4907 LOWER and UPPER are integers or lists, possibly empty.
4909 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4910 a unique key, as an integer or a list of integers, according to
4911 the following rules:
4913 - LOWER and UPPER are compared level-wise until values differ.
4915 - If, at a given level, LOWER and UPPER differ from more than
4916 2, the new key shares all the levels above with LOWER and
4917 gets a new level. Its value is the mean between LOWER and
4918 UPPER:
4920 (1 2) + (1 4) --> (1 3)
4922 - If LOWER has no value to compare with, it is assumed that its
4923 value is `most-negative-fixnum'. E.g.,
4925 (1 1) + (1 1 2)
4927 is equivalent to
4929 (1 1 m) + (1 1 2)
4931 where m is `most-negative-fixnum'. Likewise, if UPPER is
4932 short of levels, the current value is `most-positive-fixnum'.
4934 - If they differ from only one, the new key inherits from
4935 current LOWER level and fork it at the next level. E.g.,
4937 (2 1) + (3 3)
4939 is equivalent to
4941 (2 1) + (2 M)
4943 where M is `most-positive-fixnum'.
4945 - If the key is only one level long, it is returned as an
4946 integer:
4948 (1 2) + (3 2) --> 2
4950 When they are not equals, the function assumes that LOWER is
4951 lesser than UPPER, per `org-element--cache-key-less-p'."
4955 skip-upper key)
4966 ;; When at a given level, LOWER and UPPER differ from
4967 ;; 1, ignore UPPER altogether. Instead create a key
4968 ;; between LOWER and the greatest key with the same
4969 ;; prefix as LOWER so far.
4975 "Non-nil if key A is less than key B.
4976 A and B are either integers or lists of integers, as returned by
4977 `org-element--cache-key'."
4985 ;; If A is empty, either keys are equal (B is also empty) and
4986 ;; we return nil, or A is lesser than B (B is longer) and we
4987 ;; return a non-nil value.
4988 ;;
4989 ;; If A is not empty, B is necessarily empty and A is greater
4990 ;; than B (A is longer). Therefore, return nil.
4994 "Non-nil when element A is located before element B."
4999 "Return root value in cache.
5000 This function assumes `org-element--cache' is a valid AVL tree."
5004 ;;;; Tools
5007 "Non-nil when cache is active in current buffer."
5009 org-element--cache
5013 "Find element in cache starting at POS or before.
5015 POS refers to a buffer position.
5017 When optional argument SIDE is non-nil, the function checks for
5018 elements starting at or past POS instead. If SIDE is `both', the
5019 function returns a cons cell where car is the first element
5020 starting at or before POS and cdr the first element starting
5021 after POS.
5023 The function can only find elements in the synchronized part of
5024 the cache."
5028 lower upper)
5043 ;; We found an element in cache starting at POS. If `side'
5044 ;; is `both' we also want the next one in order to generate
5045 ;; a key in-between.
5046 ;;
5047 ;; If the element is the first row or item in a table or
5048 ;; a plain list, we always return the table or the plain
5049 ;; list.
5050 ;;
5051 ;; In any other case, we return the element found.
5060 lower parent
5061 upper parent)))))
5064 lower element
5065 upper element)))))
5072 "Store ELEMENT in current buffer's cache, if allowed."
5075 ;; During synchronization, first build an appropriate key for
5076 ;; the new element so `avl-tree-enter' can insert it at the
5077 ;; right spot in the cache.
5086 org-element--cache-sync-keys)))
5090 "Remove ELEMENT from cache.
5091 Assume ELEMENT belongs to cache and that a cache is active."
5095 ;;;; Synchronization
5098 "Set idle timer for cache synchronization in BUFFER."
5105 org-element-cache-sync-idle-time))
5106 nil
5107 #'org-element--cache-sync
5108 buffer)))
5111 "Non-nil when synchronization process should be interrupted.
5112 TIME-LIMIT is a time value or nil."
5118 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5120 Properties containing buffer positions are `:begin', `:end',
5121 `:contents-begin', `:contents-end' and `:structure'. When
5122 optional argument PROPS is a list of keywords, only shift
5123 properties provided in that list.
5125 Properties are modified by side-effect."
5127 ;; Shift `:structure' property for the first plain list only: it
5128 ;; is the only one that really matters and it prevents from
5129 ;; shifting it more than once.
5143 "Synchronize cache with recent modification in BUFFER.
5145 When optional argument THRESHOLD is non-nil, do the
5146 synchronization for all elements starting before or at threshold,
5147 then exit. Otherwise, synchronize cache for as long as
5148 `org-element-cache-sync-duration' or until Emacs leaves idle
5149 state.
5151 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5152 not registered yet in the cache are going to happen. It is used
5153 in `org-element--cache-submit-request', where cache is partially
5154 updated before current modification are actually submitted."
5165 request
5167 threshold
5170 org-element-cache-sync-duration))
5171 future-change)
5172 ;; Request processed. Merge current and next offsets and
5173 ;; transfer ending position.
5179 ;; If more requests are awaiting, set idle timer accordingly.
5180 ;; Otherwise, reset keys.
5187 "Process synchronization REQUEST for all entries before NEXT.
5189 REQUEST is a vector, built by `org-element--cache-submit-request'.
5191 NEXT is a cache key, as returned by `org-element--cache-key'.
5193 When non-nil, THRESHOLD is a buffer position. Synchronization
5194 stops as soon as a shifted element begins after it.
5196 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5197 after this time or when Emacs exits idle state.
5199 When non-nil, FUTURE-CHANGE is a buffer position where changes
5200 not registered yet in the cache are going to happen. See
5201 `org-element--cache-submit-request' for more information.
5203 Throw `interrupt' if the process stops before completing the
5204 request."
5207 ;; Phase 0.
5208 ;;
5209 ;; Delete all elements starting after BEG, but not after buffer
5210 ;; position END or past element with key NEXT. Also delete
5211 ;; elements contained within a previously removed element
5212 ;; (stored in `last-container').
5213 ;;
5214 ;; At each iteration, we start again at tree root since
5215 ;; a deletion modifies structure of the balanced tree.
5220 ;; Find first element in cache with key BEG or after it.
5224 data data-key last-container)
5233 data-key key
5236 data-key key
5237 node nil)))))
5247 up)))
5250 end))
5257 ;; No element starting after modifications left in
5258 ;; cache: further processing is futile.
5261 ;; Phase 1.
5262 ;;
5263 ;; Phase 0 left a hole in the cache. Some elements after it
5264 ;; could have parents within. For example, in the following
5265 ;; buffer:
5266 ;;
5267 ;; - item
5268 ;;
5269 ;;
5270 ;; Paragraph1
5271 ;;
5272 ;; Paragraph2
5273 ;;
5274 ;; if we remove a blank line between "item" and "Paragraph1",
5275 ;; everything down to "Paragraph2" is removed from cache. But
5276 ;; the paragraph now belongs to the list, and its `:parent'
5277 ;; property no longer is accurate.
5278 ;;
5279 ;; Therefore we need to parse again elements in the hole, or at
5280 ;; least in its last section, so that we can re-parent
5281 ;; subsequent elements, during phase 2.
5282 ;;
5283 ;; Note that we only need to get the parent from the first
5284 ;; element in cache after the hole.
5285 ;;
5286 ;; When next key is lesser or equal to the current one, delegate
5287 ;; phase 1 processing to next request in order to preserve key
5288 ;; order among requests.
5296 ;; Next element will start at its beginning position plus
5297 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5298 ;; contains the real beginning position of the first element to
5299 ;; shift and re-parent.
5303 ;; Changes are going to happen around this element and
5304 ;; they will trigger another phase 1 request. Skip the
5305 ;; current one.
5311 ;; Phase 2.
5312 ;;
5313 ;; Shift all elements starting from key START, but before NEXT, by
5314 ;; OFFSET, and re-parent them when appropriate.
5315 ;;
5316 ;; Elements are modified by side-effect so the tree structure
5317 ;; remains intact.
5318 ;;
5319 ;; Once THRESHOLD, if any, is reached, or once there is an input
5320 ;; pending, exit. Before leaving, the current synchronization
5321 ;; request is updated.
5328 exit-flag)
5329 ;; No re-parenting nor shifting planned: request is over.
5339 ;; We reached NEXT. Request is complete.
5341 ;; Handle interruption request. Update current request.
5346 ;; Shift element.
5350 ;; Update PARENT and re-parent DATA, only when
5351 ;; necessary. Propagate new structures for lists.
5365 ;; Cache is up-to-date past THRESHOLD. Request
5366 ;; interruption.
5371 ;; We reached end of tree: synchronization complete.
5372 t)))
5375 "Parse elements in current section, down to POS.
5377 Start parsing from the closest between the last known element in
5378 cache or headline above. Return the smallest element containing
5379 POS.
5381 When optional argument SYNCP is non-nil, return the parent of the
5382 element containing POS instead. In that case, it is also
5383 possible to provide TIME-LIMIT, which is a time value specifying
5384 when the parsing should stop. The function throws `interrupt' if
5385 the process stopped before finding the expected result."
5392 element next mode)
5394 ;; Nothing in cache before point: start parsing from first
5395 ;; element following headline above, or first element in
5396 ;; buffer.
5403 ;; Cache returned exact match: return it.
5406 ;; There's a headline between cached value and POS: cached
5407 ;; value is invalid. Start parsing from first element
5408 ;; following the headline.
5415 ;; Check if CACHED or any of its ancestors contain point.
5416 ;;
5417 ;; If there is such an element, we inspect it in order to know
5418 ;; if we return it or if we need to parse its contents.
5419 ;; Otherwise, we just start parsing from current location,
5420 ;; which is right after the top-most element containing
5421 ;; CACHED.
5422 ;;
5423 ;; As a special case, if POS is at the end of the buffer, we
5424 ;; want to return the innermost element ending there.
5425 ;;
5426 ;; Also, if we find an ancestor and discover that we need to
5427 ;; parse its contents, make sure we don't start from
5428 ;; `:contents-begin', as we would otherwise go past CACHED
5429 ;; again. Instead, in that situation, we will resume parsing
5430 ;; from NEXT, which is located after CACHED or its higher
5431 ;; ancestor not containing point.
5443 ;; Parse successively each element until we reach POS.
5456 end 'element mode
5463 ;; Skip any element ending before point. Also skip
5464 ;; element ending at point (unless it is also the end of
5465 ;; buffer) since we're sure that another element begins
5466 ;; after it.
5470 ;; A non-greater element contains point: return it.
5473 ;; Otherwise, we have to decide if ELEMENT really
5474 ;; contains POS. In that case we start parsing from
5475 ;; contents' beginning.
5476 ;;
5477 ;; If POS is at contents' beginning but it is also at
5478 ;; the beginning of the first item in a list or a table.
5479 ;; In that case, we need to create an anchor for that
5480 ;; list or table, so return it.
5481 ;;
5482 ;; Also, if POS is at the end of the buffer, no element
5483 ;; can start after it, but more than one may end there.
5484 ;; Arbitrarily, we choose to return the innermost of
5485 ;; such elements.
5498 parent element
5499 end cend))))
5500 ;; Otherwise, return ELEMENT as it is the smallest
5501 ;; element containing POS.
5506 ;;;; Staging Buffer Changes
5517 "Regexp matching a sensitive line, structure wise.
5518 A sensitive line is a headline, inlinetask, block, drawer, or
5519 latex-environment boundary. When such a line is modified,
5520 structure changes in the document may propagate in the whole
5524 "Non-nil when a sensitive line is about to be changed.
5528 "Request extension of area going to be modified if needed.
5529 BEG and END are the beginning and end of the range of changed
5530 text. See `before-change-functions' for more information."
5540 'headline
5543 org-element--cache-sensitive-re bottom t)))))))))
5546 "Update buffer modifications for current buffer.
5547 BEG and END are the beginning and end of the range of changed
5548 text, and the length in bytes of the pre-change text replaced by
5549 that range. See `after-change-functions' for more information."
5557 ;; Determine if modified area needs to be extended, according
5558 ;; to both previous and current state. We make a special
5559 ;; case for headline editing: if a headline is modified but
5560 ;; not removed, do not extend.
5563 (`headline
5569 org-element--cache-sensitive-re bottom t))))
5570 ;; Effectively extend modified area.
5578 ;; Store synchronization request.
5581 ;; Activate a timer to process the request during idle time.
5585 "Return first element to remove from cache.
5587 BEG and END are buffer positions delimiting buffer modifications.
5588 OFFSET is the size of the changes.
5590 Returned element is usually the first element in cache containing
5591 any position between BEG and END. As an exception, greater
5592 elements around the changes that are robust to contents
5593 modifications are preserved and updated according to the
5594 changes."
5604 special-block))
5605 ;; Drawers named "PROPERTIES" are probably
5606 ;; a properties drawer being edited. Force
5607 ;; parsing to check if editing is over.
5616 ;; UP is a robust greater element containing changes.
5617 ;; We only need to extend its ending boundaries.
5623 ;; We're at top level element containing ELEMENT: if it's
5624 ;; altered by buffer modifications, it is first element in
5625 ;; cache to be removed. Otherwise, that first element is the
5626 ;; following one.
5627 ;;
5628 ;; As a special case, do not remove BEFORE if it is a robust
5629 ;; container for current changes.
5631 before)))))
5634 "Submit a new cache synchronization request for current buffer.
5635 BEG and END are buffer positions delimiting the minimal area
5636 where cache data should be removed. OFFSET is the size of the
5637 change, as an integer."
5639 delete-to delete-from)
5644 ;; Current changes can be merged with first sync request: we
5645 ;; can save a partial cache synchronization.
5648 ;; If last change happened within area to be removed, extend
5649 ;; boundaries of robust parents, if any. Otherwise, find
5650 ;; first element to remove and update request accordingly.
5662 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5663 ;; if any, is no longer a 0-phase request, thus ensuring that
5664 ;; phases are properly ordered. We need to provide OFFSET as
5665 ;; optional parameter since current modifications are not known
5666 ;; yet to the otherwise correct part of the cache (i.e, before
5667 ;; the first request).
5674 ;; When changes happen before the first known
5675 ;; element, re-parent and shift the rest of the
5676 ;; cache.
5678 ;; Otherwise, we find the first non robust
5679 ;; element containing END. All elements between
5680 ;; FIRST and this one are to be removed.
5691 element up))
5693 org-element--cache-sync-requests)
5694 ;; No element to remove. No need to re-parent either.
5695 ;; Simply shift additional elements, if any, by OFFSET.
5698 offset)))))))
5701 ;;;; Public Functions
5703 ;;;###autoload
5705 "Reset cache in current buffer.
5706 When optional argument ALL is non-nil, reset cache in all Org
5707 buffers."
5724 ;;;###autoload
5726 "Refresh cache at position POS."
5733 \f
5734 ;;; The Toolbox
5735 ;;
5736 ;; The first move is to implement a way to obtain the smallest element
5737 ;; containing point. This is the job of `org-element-at-point'. It
5738 ;; basically jumps back to the beginning of section containing point
5739 ;; and proceed, one element after the other, with
5740 ;; `org-element--current-element' until the container is found. Note:
5741 ;; When using `org-element-at-point', secondary values are never
5742 ;; parsed since the function focuses on elements, not on objects.
5743 ;;
5744 ;; At a deeper level, `org-element-context' lists all elements and
5745 ;; objects containing point.
5746 ;;
5747 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5748 ;; internally by navigation and manipulation tools.
5751 ;;;###autoload
5753 "Determine closest element around point.
5755 Return value is a list like (TYPE PROPS) where TYPE is the type
5756 of the element and PROPS a plist of properties associated to the
5757 element.
5759 Possible types are defined in `org-element-all-elements'.
5760 Properties depend on element or object type, but always include
5761 `:begin', `:end', `:parent' and `:post-blank' properties.
5763 As a special case, if point is at the very beginning of the first
5764 item in a list or sub-list, returned element will be that list
5765 instead of the item. Likewise, if point is at the beginning of
5766 the first row of a table, returned element will be the table
5767 instead of the first row.
5769 When point is at the end of the buffer, return the innermost
5770 element ending there."
5776 ;; Within blank lines at the beginning of buffer, return nil.
5778 ;; Within blank lines right after a headline, return that
5779 ;; headline.
5783 ;; Otherwise parse until we find element containing ORIGIN.
5790 ;;;###autoload
5792 "Return smallest element or object around point.
5794 Return value is a list like (TYPE PROPS) where TYPE is the type
5795 of the element or object and PROPS a plist of properties
5796 associated to it.
5798 Possible types are defined in `org-element-all-elements' and
5799 `org-element-all-objects'. Properties depend on element or
5800 object type, but always include `:begin', `:end', `:parent' and
5801 `:post-blank'.
5803 As a special case, if point is right after an object and not at
5804 the beginning of any other object, return that object.
5806 Optional argument ELEMENT, when non-nil, is the closest element
5807 containing point, as returned by `org-element-at-point'.
5808 Providing it allows for quicker computation."
5815 ;; If point is inside an element containing objects or
5816 ;; a secondary string, narrow buffer to the container and
5817 ;; proceed with parsing. Otherwise, return ELEMENT.
5819 ;; At a parsed affiliated keyword, check if we're inside main
5820 ;; or dual value.
5826 org-element-parsed-keywords))
5835 ;; Also change type to retrieve correct restrictions.
5837 ;; At an item, objects can only be located within tag, if any.
5848 ;; At an headline or inlinetask, objects are in title.
5860 ;; At a paragraph, a table-row or a verse block, objects are
5861 ;; located within their contents.
5865 ;; CBEG is nil for table rules.
5870 ;; At a planning line, if point is at a timestamp, return it,
5871 ;; otherwise, return element.
5879 ;; All other locations cannot contain objects: bail out.
5885 last)
5890 ;; Process NEXT, if any, in order to know if we need to
5891 ;; skip it, return it or move into it.
5898 ;; Skip objects ending before point. Also skip
5899 ;; objects ending at point unless it is also the
5900 ;; end of buffer, since we want to return the
5901 ;; innermost object.
5904 ;; For convenience, when object ends at POS,
5905 ;; without any space, store it in LAST, as we
5906 ;; will return it if no object starts here.
5910 ;; If POS is within a container object, move into
5911 ;; that object.
5915 ;; At contents' end, if there is no
5916 ;; space before point, also move into
5917 ;; object, for consistency with
5918 ;; convenience feature above.
5927 ;; Otherwise, return NEXT.
5931 "List all ancestors of a given element or object.
5933 BLOB is an object or element.
5935 When optional argument TYPES is a list of symbols, return the
5936 first element or object in the lineage whose type belongs to that
5937 list.
5939 When optional argument WITH-SELF is non-nil, lineage includes
5940 BLOB itself as the first element, and TYPES, if provided, also
5941 apply to it.
5943 When BLOB is obtained through `org-element-context' or
5944 `org-element-at-point', only ancestors from its section can be
5945 found. There is no such limitation when BLOB belongs to a full
5946 parse tree."
5948 ancestors)
5955 "Non-nil when elements ELEM-A and ELEM-B are nested."
5964 "Swap elements ELEM-A and ELEM-B.
5965 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5966 end of ELEM-A."
5968 ;; There are two special cases when an element doesn't start at bol:
5969 ;; the first paragraph in an item or in a footnote definition.
5971 ;; Only a paragraph without any affiliated keyword can be moved at
5972 ;; ELEM-A position in such a situation. Note that the case of
5973 ;; a footnote definition is impossible: it cannot contain two
5974 ;; paragraphs in a row because it cannot contain a blank line.
5980 ;; In a special situation, ELEM-A will have no indentation. We'll
5981 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5995 ;; Store inner overlays responsible for visibility status.
5996 ;; We also need to store their boundaries as they will be
5997 ;; removed from buffer.
6012 ;; Get contents.
6020 ;; Restore ex ELEM-A overlays.
6027 ;; Restore ex ELEM-B overlays.
6035 ;; Local variables:
6036 ;; generated-autoload-file: "org-loaddefs.el"
6037 ;; End:
6039 ;;; org-element.el ends here