| blob | db74441f2b4d11c6650ae31f2e81f4bbb31298ca |
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."
3048 ;; Macro.
3058 :begin begin
3059 :end end
3063 "Interpret LATEX-FRAGMENT object as Org syntax."
3066 ;;;; Line Break
3069 "Parse line break at point, if any.
3071 When at a line break, return a list whose car is `line-break',
3072 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3073 Otherwise, return nil.
3075 Assume point is at the beginning of the line break."
3084 "Interpret LINE-BREAK object as Org syntax."
3088 ;;;; Link
3091 "Parse link at point, if any.
3093 When at a link, return a list whose car is `link' and cdr a plist
3094 with `:type', `:path', `:format', `:raw-link', `:application',
3095 `:search-option', `:begin', `:end', `:contents-begin',
3096 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3097 nil.
3099 Assume point is at the beginning of the link."
3102 end contents-begin contents-end link-end post-blank path type format
3103 raw-link search-option application)
3105 ;; Type 1: Text targeted from a radio target.
3115 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3121 ;; RAW-LINK is the original link. Expand any
3122 ;; abbreviation in it.
3123 ;;
3124 ;; Also treat any newline character and associated
3125 ;; indentation as a single space character. This is not
3126 ;; compatible with RFC 3986, which requires to ignore
3127 ;; them altogether. However, doing so would require
3128 ;; users to encode spaces on the fly when writing links
3129 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3130 ;; [[shell:ls *.org]], which defeats Org's focus on
3131 ;; simplicity.
3136 ;; Determine TYPE of link and set PATH accordingly. According
3137 ;; to RFC 3986, remove whitespaces from URI in external links.
3138 ;; In internal ones, treat indentation as a single space.
3140 ;; File type.
3145 ;; Explicit type (http, irc, bbdb...).
3149 ;; Code-ref type: PATH is the name of the reference.
3154 ;; Custom-id type: PATH is the name of the custom id.
3158 ;; Fuzzy type: Internal link either matches a target, an
3159 ;; headline name or nothing. PATH is the target or
3160 ;; headline's name.
3164 ;; Type 3: Plain link, e.g., http://orgmode.org
3171 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3172 ;; bracket links, follow RFC 3986 and remove any extra
3173 ;; whitespace in URI.
3184 ;; In any case, deduce end point after trailing white space from
3185 ;; LINK-END variable.
3190 ;; Special "file" type link processing. Extract opening
3191 ;; application and search option, if any. Also normalize URI.
3198 ;; Translate link, if `org-link-translation-function' is set.
3206 :path path
3207 :format format
3209 :application application
3210 :search-option search-option
3211 :begin begin
3212 :end end
3213 :contents-begin contents-begin
3214 :contents-end contents-end
3218 "Interpret LINK object as Org syntax.
3219 CONTENTS is the contents of the object, or nil."
3224 ;; Links with contents and internal links have to
3225 ;; use bracket syntax. Ignore `:format' in these
3226 ;; cases. This is also the default syntax when the
3227 ;; property is not defined, e.g., when the object
3228 ;; was crafted by the user.
3231 ;; Since this is going to be used as
3232 ;; a format string, escape percent signs
3233 ;; in description.
3236 `nil
3239 ;; Otherwise, just obey to `:format'.
3251 path
3257 ;;;; Macro
3260 "Parse macro at point, if any.
3262 When at a macro, return a list whose car is `macro' and cdr
3263 a plist with `:key', `:args', `:begin', `:end', `:value' and
3264 `:post-blank' as keywords. Otherwise, return nil.
3266 Assume point is at the macro."
3279 :value value
3280 :args args
3281 :begin begin
3282 :end end
3286 "Interpret MACRO object as Org syntax."
3290 ;;;; Radio-target
3293 "Parse radio target at point, if any.
3295 When at a radio target, return a list whose car is `radio-target'
3296 and cdr a plist with `:begin', `:end', `:contents-begin',
3297 `:contents-end', `:value' and `:post-blank' as keywords.
3298 Otherwise, return nil.
3300 Assume point is at the radio target."
3312 :end end
3313 :contents-begin contents-begin
3314 :contents-end contents-end
3315 :post-blank post-blank
3319 "Interpret target object as Org syntax.
3320 CONTENTS is the contents of the object."
3324 ;;;; Statistics Cookie
3327 "Parse statistics cookie at point, if any.
3329 When at a statistics cookie, return a list whose car is
3330 `statistics-cookie', and cdr a plist with `:begin', `:end',
3331 `:value' and `:post-blank' keywords. Otherwise, return nil.
3333 Assume point is at the beginning of the statistics-cookie."
3344 :end end
3345 :value value
3349 "Interpret STATISTICS-COOKIE object as Org syntax."
3353 ;;;; Strike-Through
3356 "Parse strike-through object at point, if any.
3358 When at a strike-through object, return a list whose car is
3359 `strike-through' and cdr is a plist with `:begin', `:end',
3360 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3361 Otherwise, return nil.
3363 Assume point is at the first plus sign marker."
3375 :end end
3376 :contents-begin contents-begin
3377 :contents-end contents-end
3381 "Interpret strike-through object as Org syntax.
3382 CONTENTS is the contents of the object."
3386 ;;;; Subscript
3389 "Parse subscript at point, if any.
3391 When at a subscript object, return a list whose car is
3392 `subscript' and cdr a plist with `:begin', `:end',
3393 `:contents-begin', `:contents-end', `:use-brackets-p' and
3394 `:post-blank' as keywords. Otherwise, return nil.
3396 Assume point is at the underscore."
3410 :end end
3411 :use-brackets-p bracketsp
3412 :contents-begin contents-begin
3413 :contents-end contents-end
3417 "Interpret SUBSCRIPT object as Org syntax.
3418 CONTENTS is the contents of the object."
3421 contents))
3424 ;;;; Superscript
3427 "Parse superscript at point, if any.
3429 When at a superscript object, return a list whose car is
3430 `superscript' and cdr a plist with `:begin', `:end',
3431 `:contents-begin', `:contents-end', `:use-brackets-p' and
3432 `:post-blank' as keywords. Otherwise, return nil.
3434 Assume point is at the caret."
3448 :end end
3449 :use-brackets-p bracketsp
3450 :contents-begin contents-begin
3451 :contents-end contents-end
3455 "Interpret SUPERSCRIPT object as Org syntax.
3456 CONTENTS is the contents of the object."
3459 contents))
3462 ;;;; Table Cell
3465 "Parse table cell at point.
3466 Return a list whose car is `table-cell' and cdr is a plist
3467 containing `:begin', `:end', `:contents-begin', `:contents-end'
3468 and `:post-blank' keywords."
3476 :end end
3477 :contents-begin contents-begin
3478 :contents-end contents-end
3482 "Interpret table-cell element as Org syntax.
3483 CONTENTS is the contents of the cell, or nil."
3487 ;;;; Target
3490 "Parse target at point, if any.
3492 When at a target, return a list whose car is `target' and cdr
3493 a plist with `:begin', `:end', `:value' and `:post-blank' as
3494 keywords. Otherwise, return nil.
3496 Assume point is at the target."
3506 :end end
3507 :value value
3511 "Interpret TARGET object as Org syntax."
3515 ;;;; Timestamp
3526 "Parse time stamp at point, if any.
3528 When at a time stamp, return a list whose car is `timestamp', and
3529 cdr a plist with `:type', `:raw-value', `:year-start',
3530 `:month-start', `:day-start', `:hour-start', `:minute-start',
3531 `:year-end', `:month-end', `:day-end', `:hour-end',
3532 `:minute-end', `:repeater-type', `:repeater-value',
3533 `:repeater-unit', `:warning-type', `:warning-value',
3534 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3535 Otherwise, return nil.
3537 Assume point is at the beginning of the timestamp."
3556 date-start)
3567 raw-value)
3569 :repeater-type
3575 :repeater-unit
3584 :warning-unit
3587 year-start month-start day-start hour-start minute-start year-end
3588 month-end day-end hour-end minute-end)
3589 ;; Parse date-start.
3597 ;; Compute date-end. It can be provided directly in time-stamp,
3598 ;; or extracted from time range. Otherwise, it defaults to the
3599 ;; same values as date-start.
3609 :raw-value raw-value
3610 :year-start year-start
3611 :month-start month-start
3612 :day-start day-start
3613 :hour-start hour-start
3614 :minute-start minute-start
3615 :year-end year-end
3616 :month-end month-end
3617 :day-end day-end
3618 :hour-end hour-end
3619 :minute-end minute-end
3620 :begin begin
3621 :end end
3623 repeater-props
3624 warning-props))))))
3627 "Interpret TIMESTAMP object as Org syntax."
3645 ;; Build an Org timestamp string from TIME. ACTIVEP is
3646 ;; non-nil when time stamp is active. If WITH-TIME-P is
3647 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3648 ;; specify a time range in the timestamp. REPEAT-STRING is
3649 ;; the repeater string, if any.
3653 org-time-stamp-formats)
3654 time)))
3660 nil nil ts)))
3665 " "
3666 s
3668 ;; Return value.
3669 ts)))
3681 build-ts-string
3700 0
3708 "--"
3721 ;;;; Underline
3724 "Parse underline object at point, if any.
3726 When at an underline object, return a list whose car is
3727 `underline' and cdr is a plist with `:begin', `:end',
3728 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3729 Otherwise, return nil.
3731 Assume point is at the first underscore marker."
3743 :end end
3744 :contents-begin contents-begin
3745 :contents-end contents-end
3749 "Interpret underline object as Org syntax.
3750 CONTENTS is the contents of the object."
3754 ;;;; Verbatim
3757 "Parse verbatim object at point, if any.
3759 When at a verbatim object, return a list whose car is `verbatim'
3760 and cdr is a plist with `:value', `:begin', `:end' and
3761 `:post-blank' keywords. Otherwise, return nil.
3763 Assume point is at the first equal sign marker."
3774 :begin begin
3775 :end end
3779 "Interpret VERBATIM object as Org syntax."
3783 \f
3784 ;;; Parsing Element Starting At Point
3785 ;;
3786 ;; `org-element--current-element' is the core function of this section.
3787 ;; It returns the Lisp representation of the element starting at
3788 ;; point.
3789 ;;
3790 ;; `org-element--current-element' makes use of special modes. They
3791 ;; are activated for fixed element chaining (e.g., `plain-list' >
3792 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3793 ;; `section'). Special modes are: `first-section', `item',
3794 ;; `node-property', `section' and `table-row'.
3797 "Parse the element starting at point.
3799 Return value is a list like (TYPE PROPS) where TYPE is the type
3800 of the element and PROPS a plist of properties associated to the
3801 element.
3803 Possible types are defined in `org-element-all-elements'.
3805 LIMIT bounds the search.
3807 Optional argument GRANULARITY determines the depth of the
3808 recursion. Allowed values are `headline', `greater-element',
3809 `element', `object' or nil. When it is broader than `object' (or
3810 nil), secondary values will not be parsed, since they only
3811 contain objects.
3813 Optional argument MODE, when non-nil, can be either
3814 `first-section', `section', `planning', `item', `node-property'
3815 and `table-row'.
3817 If STRUCTURE isn't provided but MODE is set to `item', it will be
3818 computed.
3820 This function assumes point is always at the beginning of the
3821 element it has to parse."
3824 ;; Determine if parsing depth allows for secondary strings
3825 ;; parsing. It only applies to elements referenced in
3826 ;; `org-element-secondary-value-alist'.
3829 ;; Item.
3832 ;; Table Row.
3834 ;; Node Property.
3836 ;; Headline.
3839 ;; Sections (must be checked after headline).
3844 limit)))
3845 ;; Planning.
3850 ;; Property drawer.
3856 ;; When not at bol, point is at the beginning of an item or
3857 ;; a footnote definition: next item is always a paragraph.
3859 ;; Clock.
3861 ;; Inlinetask.
3864 ;; From there, elements can have affiliated keywords.
3867 ;; Jumping over affiliated keywords put point off-limits.
3868 ;; Parse them as regular keywords.
3872 ;; LaTeX Environment.
3875 ;; Drawer and Property Drawer.
3878 ;; Fixed Width
3881 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3882 ;; Keywords.
3900 limit
3901 affiliated))
3914 ;; Footnote Definition.
3917 ;; Horizontal Rule.
3920 ;; Diary Sexp.
3923 ;; Table.
3926 ;; List.
3929 limit affiliated
3931 ;; Default element: Paragraph.
3935 ;; Most elements can have affiliated keywords. When looking for an
3936 ;; element beginning, we want to move before them, as they belong to
3937 ;; that element, and, in the meantime, collect information they give
3938 ;; into appropriate properties. Hence the following function.
3941 "Collect affiliated keywords from point down to LIMIT.
3943 Return a list whose CAR is the position at the first of them and
3944 CDR a plist of keywords and values and move point to the
3945 beginning of the first line after them.
3947 As a special case, if element doesn't start at the beginning of
3948 the line (e.g., a paragraph starting an item), CAR is current
3949 position of point and CDR is nil."
3953 ;; RESTRICT is the list of objects allowed in parsed
3954 ;; keywords value.
3956 output)
3959 ;; Apply translation to RAW-KWD. From there, KWD is
3960 ;; the official keyword.
3962 org-element-keyword-translation-alist))
3963 raw-kwd))
3964 ;; Find main value for any keyword.
3970 ;; PARSEDP is non-nil when keyword should have its
3971 ;; value parsed.
3973 ;; If KWD is a dual keyword, find its secondary
3974 ;; value. Maybe parse it.
3983 ;; Attribute a property name to KWD.
3985 ;; Now set final shape for VALUE.
3991 nil restrict)))
3995 ;; Attributes can always appear on multiple lines.
3998 ;; Eventually store the new value in OUTPUT.
4000 ;; Move to next keyword.
4002 ;; If affiliated keywords are orphaned: move back to first one.
4003 ;; They will be parsed as a paragraph.
4005 ;; Return value.
4009 \f
4010 ;;; The Org Parser
4011 ;;
4012 ;; The two major functions here are `org-element-parse-buffer', which
4013 ;; parses Org syntax inside the current buffer, taking into account
4014 ;; region, narrowing, or even visibility if specified, and
4015 ;; `org-element-parse-secondary-string', which parses objects within
4016 ;; a given string.
4017 ;;
4018 ;; The (almost) almighty `org-element-map' allows applying a function
4019 ;; on elements or objects matching some type, and accumulating the
4020 ;; resulting values. In an export situation, it also skips unneeded
4021 ;; parts of the parse tree.
4024 "Recursively parse the buffer and return structure.
4025 If narrowing is in effect, only parse the visible part of the
4026 buffer.
4028 Optional argument GRANULARITY determines the depth of the
4029 recursion. It can be set to the following symbols:
4031 `headline' Only parse headlines.
4032 `greater-element' Don't recurse into greater elements except
4033 headlines and sections. Thus, elements
4034 parsed are the top-level ones.
4035 `element' Parse everything but objects and plain text.
4036 `object' Parse the complete buffer (default).
4038 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4039 elements.
4041 An element or object is represented as a list with the
4042 pattern (TYPE PROPERTIES CONTENTS), where :
4044 TYPE is a symbol describing the element or object. See
4045 `org-element-all-elements' and `org-element-all-objects' for an
4046 exhaustive list of such symbols. One can retrieve it with
4047 `org-element-type' function.
4049 PROPERTIES is the list of attributes attached to the element or
4050 object, as a plist. Although most of them are specific to the
4051 element or object type, all types share `:begin', `:end',
4052 `:post-blank' and `:parent' properties, which respectively
4053 refer to buffer position where the element or object starts,
4054 ends, the number of white spaces or blank lines after it, and
4055 the element or object containing it. Properties values can be
4056 obtained by using `org-element-property' function.
4058 CONTENTS is a list of elements, objects or raw strings
4059 contained in the current element or object, when applicable.
4060 One can access them with `org-element-contents' function.
4062 The Org buffer has `org-data' as type and nil as properties.
4063 `org-element-map' function can be used to find specific elements
4064 or objects within the parse tree.
4066 This function assumes that current major mode is `org-mode'."
4072 ;; Start in `first-section' mode so text before the first
4073 ;; headline belongs to a section.
4077 "Recursively parse objects in STRING and return structure.
4079 RESTRICTION is a symbol limiting the object types that will be
4080 looked after.
4082 Optional argument PARENT, when non-nil, is the element or object
4083 containing the secondary string. It is used to set correctly
4084 `:parent' property within the string.
4086 If STRING is the empty string or nil, return nil."
4103 "Map a function on selected elements or objects.
4105 DATA is a parse tree, an element, an object, a string, or a list
4106 of such constructs. TYPES is a symbol or list of symbols of
4107 elements or objects types (see `org-element-all-elements' and
4108 `org-element-all-objects' for a complete list of types). FUN is
4109 the function called on the matching element or object. It has to
4110 accept one argument: the element or object itself.
4112 When optional argument INFO is non-nil, it should be a plist
4113 holding export options. In that case, parts of the parse tree
4114 not exportable according to that property list will be skipped.
4116 When optional argument FIRST-MATCH is non-nil, stop at the first
4117 match for which FUN doesn't return nil, and return that value.
4119 Optional argument NO-RECURSION is a symbol or a list of symbols
4120 representing elements or objects types. `org-element-map' won't
4121 enter any recursive element or object whose type belongs to that
4122 list. Though, FUN can still be applied on them.
4124 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4125 apply to matching objects within parsed affiliated keywords (see
4126 `org-element-parsed-keywords').
4128 Nil values returned from FUN do not appear in the results.
4131 Examples:
4132 ---------
4134 Assuming TREE is a variable containing an Org buffer parse tree,
4135 the following example will return a flat list of all `src-block'
4136 and `example-block' elements in it:
4140 The following snippet will find the first headline with a level
4144 (lambda (hl)
4145 (and (= (org-element-property :level hl) 1)
4147 (org-element-property :begin hl)))
4148 nil t)
4150 The next example will return a flat list of all `plain-list' type
4151 elements in TREE that are not a sub-list themselves:
4155 Eventually, this example will return a flat list of all `bold'
4156 type objects containing a `latex-snippet' type object, even
4157 looking into captions:
4160 (lambda (b)
4162 nil nil nil t)"
4163 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4167 ;; Recursion depth is determined by --CATEGORY.
4174 ;; If one object is found, the function has
4175 ;; to recurse into every object.
4178 ;; If one regular element is found, the
4179 ;; function has to recurse, at least, into
4180 ;; every element it encounters.
4183 --acc)
4186 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4187 ;; holding contextual information.
4191 ;; Ignored element in an export context.
4193 ;; List of elements or objects.
4195 ;; Unconditionally enter parse trees.
4199 ;; Check if TYPE is matching among TYPES. If so,
4200 ;; apply FUN to --DATA and accumulate return value
4201 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4207 ;; If --DATA has a secondary string that can contain
4208 ;; objects with their type among TYPES, look inside.
4211 org-element-secondary-value-alist)))
4213 ;; If --DATA has any parsed affiliated keywords and
4214 ;; WITH-AFFILIATED is non-nil, look for objects in
4215 ;; them.
4222 ;; Pay attention to the type of parsed
4223 ;; keyword. In particular, preserve order for
4224 ;; multiple keywords.
4237 ;; Determine if a recursion into --DATA is possible.
4239 ;; --TYPE is explicitly removed from recursion.
4241 ;; --DATA has no contents.
4243 ;; Looking for greater elements but --DATA is
4244 ;; simply an element or an object.
4247 ;; Looking for elements but --DATA is an object.
4250 ;; In any other case, map contents.
4254 ;; Return value in a proper order.
4258 ;; The following functions are internal parts of the parser.
4259 ;;
4260 ;; The first one, `org-element--parse-elements' acts at the element's
4261 ;; level.
4262 ;;
4263 ;; The second one, `org-element--parse-objects' applies on all objects
4264 ;; of a paragraph or a secondary string. It calls
4265 ;; `org-element--object-lex' to find the next object in the current
4266 ;; container.
4269 "Return next special mode according to TYPE, or nil.
4270 TYPE is a symbol representing the type of an element or object
4271 containing next element if PARENTP is non-nil, or before it
4272 otherwise. Modes can be either `first-section', `item',
4273 `node-property', `planning', `property-drawer', `section',
4274 `table-row' or nil."
4291 "Parse elements between BEG and END positions.
4293 MODE prioritizes some elements over the others. It can be set to
4294 `first-section', `section', `planning', `item', `node-property'
4295 or `table-row'.
4297 When value is `item', STRUCTURE will be used as the current list
4298 structure.
4300 GRANULARITY determines the depth of the recursion. See
4301 `org-element-parse-buffer' for more information.
4303 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4304 elements.
4306 Elements are accumulated into ACC."
4309 ;; Visible only: skip invisible parts at the beginning of the
4310 ;; element.
4313 ;; When parsing only headlines, skip any text before first one.
4318 ;; Find current element's type and parse it accordingly to
4319 ;; its category.
4321 end granularity mode structure))
4325 ;; Visible only: skip invisible parts between siblings.
4328 ;; Fill ELEMENT contents by side-effect.
4330 ;; If element has no contents, don't modify it.
4332 ;; Greater element: parse it between `contents-begin' and
4333 ;; `contents-end'. Make sure GRANULARITY allows the
4334 ;; recursion, or ELEMENT is a headline, in which case going
4335 ;; inside is mandatory, in order to get sub-level headings.
4343 ;; Possibly switch to a special mode.
4347 granularity visible-only element))
4348 ;; ELEMENT has contents. Parse objects inside, if
4349 ;; GRANULARITY allows it.
4355 ;; Update mode.
4357 ;; Return result.
4361 "Return next object in current buffer or nil.
4362 RESTRICTION is a list of object types, as symbols, that should be
4363 looked after. This function assumes that the buffer is narrowed
4364 to an appropriate container (e.g., a paragraph)."
4368 ;; Object regexp sometimes needs to have a peek at
4369 ;; a character ahead. Therefore, when there is a hard
4370 ;; limit, make it one more than the true beginning of the
4371 ;; radio target.
4378 nil)
4379 ;; Since we moved backward, we do not want to
4380 ;; match again an hypothetical 1-character long
4381 ;; radio link before us. Realizing that this can
4382 ;; only happen if such a radio link starts at
4383 ;; beginning of line, we prevent this here.
4389 found)
4455 ;; This is probably a plain link.
4465 "Parse objects between BEG and END and return recursive structure.
4467 Objects are accumulated in ACC. RESTRICTION is a list of object
4468 successors which are allowed in the current object.
4470 ACC becomes the parent for all parsed objects. However, if ACC
4471 is nil (i.e., a secondary string is being parsed) and optional
4472 argument PARENT is non-nil, use it as the parent for all objects.
4473 Eventually, if both ACC and PARENT are nil, the common parent is
4474 the list of objects itself."
4482 ;; Text before any object.
4487 contents))))
4488 ;; Object...
4493 ;; Fill contents of NEXT-OBJECT if possible.
4495 cont-beg
4497 next-object
4499 next-object)
4500 contents)
4502 ;; Text after last object.
4506 contents)))
4507 ;; Result. Set appropriate parent.
4515 \f
4516 ;;; Towards A Bijective Process
4517 ;;
4518 ;; The parse tree obtained with `org-element-parse-buffer' is really
4519 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4520 ;; interpreted and expanded into a string with canonical Org syntax.
4521 ;; Hence `org-element-interpret-data'.
4522 ;;
4523 ;; The function relies internally on
4524 ;; `org-element--interpret-affiliated-keywords'.
4526 ;;;###autoload
4528 "Interpret DATA as Org syntax.
4529 DATA is a parse tree, an element, an object or a secondary string
4530 to interpret. Return Org syntax as a string."
4534 ;; Find interpreter for current object or
4535 ;; element. If it doesn't exist (e.g. this is
4536 ;; a pseudo object or element), return contents,
4537 ;; if any.
4544 ;; Secondary string.
4547 data
4549 ;; Full Org document.
4554 ;; Plain text: return it.
4556 ;; Element or object without contents.
4559 ;; Element or object with contents.
4562 interpret
4563 data
4564 ;; Recursively interpret contents.
4569 data
4570 ;; Fix indentation of elements containing
4571 ;; objects. We ignore `table-row'
4572 ;; elements as they are one line long
4573 ;; anyway.
4575 data
4576 ;; When normalizing first paragraph of
4577 ;; an item or a footnote-definition,
4578 ;; ignore first line's indentation.
4586 ;; Build white spaces. If no `:post-blank' property
4587 ;; is specified, assume its value is 0.
4597 "Return ELEMENT's affiliated keywords as Org syntax.
4598 If there is no affiliated keyword, return the empty string."
4608 ": "
4611 value)
4619 ;; All attribute keywords can have multiple lines.
4625 ;; List all ELEMENT's properties matching an attribute line or an
4626 ;; affiliated keyword, but ignore translated keywords since they
4627 ;; cannot belong to the property list.
4634 org-element-keyword-translation-alist)))))
4635 collect prop)
4638 ;; Because interpretation of the parse tree must return the same
4639 ;; number of blank lines between elements and the same number of white
4640 ;; space after objects, some special care must be given to white
4641 ;; spaces.
4642 ;;
4643 ;; The first function, `org-element-normalize-string', ensures any
4644 ;; string different from the empty string will end with a single
4645 ;; newline character.
4646 ;;
4647 ;; The second function, `org-element-normalize-contents', removes
4648 ;; global indentation from the contents of the current element.
4651 "Ensure string S ends with a single newline character.
4653 If S isn't a string return it unchanged. If S is the empty
4654 string, return it. Otherwise, return a new string with a single
4655 newline character at its end."
4663 "Normalize plain text in ELEMENT's contents.
4665 ELEMENT must only contain plain text and objects.
4667 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4668 indentation to compute maximal common indentation.
4670 Return the normalized element that is element with global
4671 indentation removed from its contents."
4673 ;; Return minimal common indentation within BLOB. This is
4674 ;; done by walking recursively BLOB and updating MIN-IND
4675 ;; along the way. FIRST-FLAG is non-nil when the next
4676 ;; object is expected to be a string that doesn't start
4677 ;; with a newline character. It happens for strings at
4678 ;; the beginnings of the contents or right after a line
4679 ;; break.
4685 ;; Objects cannot start with spaces: in this
4686 ;; case, indentation is 0.
4727 ;; Build ELEMENT back, replacing each string with the same
4728 ;; string minus common indentation.
4731 ;; Return DATUM with all its strings indentation
4732 ;; shortened from MIN-IND white spaces.
4752 org-element-recursive-objects)
4756 datum)))
4760 \f
4761 ;;; Cache
4762 ;;
4763 ;; Implement a caching mechanism for `org-element-at-point' and
4764 ;; `org-element-context', which see.
4765 ;;
4766 ;; A single public function is provided: `org-element-cache-reset'.
4767 ;;
4768 ;; Cache is enabled by default, but can be disabled globally with
4769 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4770 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4771 ;; can be tweaked to control caching behaviour.
4772 ;;
4773 ;; Internally, parsed elements are stored in an AVL tree,
4774 ;; `org-element--cache'. This tree is updated lazily: whenever
4775 ;; a change happens to the buffer, a synchronization request is
4776 ;; registered in `org-element--cache-sync-requests' (see
4777 ;; `org-element--cache-submit-request'). During idle time, requests
4778 ;; are processed by `org-element--cache-sync'. Synchronization also
4779 ;; happens when an element is required from the cache. In this case,
4780 ;; the process stops as soon as the needed element is up-to-date.
4781 ;;
4782 ;; A synchronization request can only apply on a synchronized part of
4783 ;; the cache. Therefore, the cache is updated at least to the
4784 ;; location where the new request applies. Thus, requests are ordered
4785 ;; from left to right and all elements starting before the first
4786 ;; request are correct. This property is used by functions like
4787 ;; `org-element--cache-find' to retrieve elements in the part of the
4788 ;; cache that can be trusted.
4789 ;;
4790 ;; A request applies to every element, starting from its original
4791 ;; location (or key, see below). When a request is processed, it
4792 ;; moves forward and may collide the next one. In this case, both
4793 ;; requests are merged into a new one that starts from that element.
4794 ;; As a consequence, the whole synchronization complexity does not
4795 ;; depend on the number of pending requests, but on the number of
4796 ;; elements the very first request will be applied on.
4797 ;;
4798 ;; Elements cannot be accessed through their beginning position, which
4799 ;; may or may not be up-to-date. Instead, each element in the tree is
4800 ;; associated to a key, obtained with `org-element--cache-key'. This
4801 ;; mechanism is robust enough to preserve total order among elements
4802 ;; even when the tree is only partially synchronized.
4806 "Non-nil when Org parser should cache its results.
4808 WARNING: for the time being, using cache sometimes triggers
4809 freezes. Therefore, it is disabled by default. Activate it if
4816 "Maximum duration, as a time value, for a cache synchronization.
4817 If the synchronization is not over after this delay, the process
4818 pauses and resumes after `org-element-cache-sync-break'
4822 "Duration, as a time value, of the pause between synchronizations.
4826 ;;;; Data Structure
4829 "AVL tree used to cache elements.
4830 Each node of the tree contains an element. Comparison is done
4831 with `org-element--cache-compare'. This cache is used in
4835 "List of pending synchronization requests.
4837 A request is a vector with the following pattern:
4839 \[NEXT BEG END OFFSET PARENT PHASE]
4841 Processing a synchronization request consists of three phases:
4843 0. Delete modified elements,
4844 1. Fill missing area in cache,
4845 2. Shift positions and re-parent elements after the changes.
4847 During phase 0, NEXT is the key of the first element to be
4848 removed, BEG and END is buffer position delimiting the
4849 modifications. Elements starting between them (inclusive) are
4850 removed. So are elements whose parent is removed. PARENT, when
4851 non-nil, is the parent of the first element to be removed.
4853 During phase 1, NEXT is the key of the next known element in
4854 cache and BEG its beginning position. Parse buffer between that
4855 element and the one before it in order to determine the parent of
4856 the next element. Set PARENT to the element containing NEXT.
4858 During phase 2, NEXT is the key of the next element to shift in
4859 the parse tree. All elements starting from this one have their
4860 properties relatives to buffer positions shifted by integer
4861 OFFSET and, if they belong to element PARENT, are adopted by it.
4869 "Hash table used to store keys during synchronization.
4873 "Return a unique key for ELEMENT in cache tree.
4875 Keys are used to keep a total order among elements in the cache.
4876 Comparison is done with `org-element--cache-key-less-p'.
4878 When no synchronization is taking place, a key is simply the
4879 beginning position of the element, or that position plus one in
4880 the case of an first item (respectively row) in
4881 a list (respectively a table).
4883 During a synchronization, the key is the one the element had when
4884 the cache was synchronized for the last time. Elements added to
4885 cache during the synchronization get a new key generated with
4886 `org-element--cache-generate-key'.
4888 Such keys are stored in `org-element--cache-sync-keys'. The hash
4889 table is cleared once the synchronization is complete."
4892 ;; Increase beginning position of items (respectively
4893 ;; table rows) by one, so the first item can get
4894 ;; a different key from its parent list (respectively
4895 ;; table).
4898 begin)))
4901 key))))
4904 "Generate a key between LOWER and UPPER.
4906 LOWER and UPPER are integers or lists, possibly empty.
4908 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4909 a unique key, as an integer or a list of integers, according to
4910 the following rules:
4912 - LOWER and UPPER are compared level-wise until values differ.
4914 - If, at a given level, LOWER and UPPER differ from more than
4915 2, the new key shares all the levels above with LOWER and
4916 gets a new level. Its value is the mean between LOWER and
4917 UPPER:
4919 (1 2) + (1 4) --> (1 3)
4921 - If LOWER has no value to compare with, it is assumed that its
4922 value is `most-negative-fixnum'. E.g.,
4924 (1 1) + (1 1 2)
4926 is equivalent to
4928 (1 1 m) + (1 1 2)
4930 where m is `most-negative-fixnum'. Likewise, if UPPER is
4931 short of levels, the current value is `most-positive-fixnum'.
4933 - If they differ from only one, the new key inherits from
4934 current LOWER level and fork it at the next level. E.g.,
4936 (2 1) + (3 3)
4938 is equivalent to
4940 (2 1) + (2 M)
4942 where M is `most-positive-fixnum'.
4944 - If the key is only one level long, it is returned as an
4945 integer:
4947 (1 2) + (3 2) --> 2
4949 When they are not equals, the function assumes that LOWER is
4950 lesser than UPPER, per `org-element--cache-key-less-p'."
4954 skip-upper key)
4965 ;; When at a given level, LOWER and UPPER differ from
4966 ;; 1, ignore UPPER altogether. Instead create a key
4967 ;; between LOWER and the greatest key with the same
4968 ;; prefix as LOWER so far.
4974 "Non-nil if key A is less than key B.
4975 A and B are either integers or lists of integers, as returned by
4976 `org-element--cache-key'."
4984 ;; If A is empty, either keys are equal (B is also empty) and
4985 ;; we return nil, or A is lesser than B (B is longer) and we
4986 ;; return a non-nil value.
4987 ;;
4988 ;; If A is not empty, B is necessarily empty and A is greater
4989 ;; than B (A is longer). Therefore, return nil.
4993 "Non-nil when element A is located before element B."
4998 "Return root value in cache.
4999 This function assumes `org-element--cache' is a valid AVL tree."
5003 ;;;; Tools
5006 "Non-nil when cache is active in current buffer."
5008 org-element--cache
5012 "Find element in cache starting at POS or before.
5014 POS refers to a buffer position.
5016 When optional argument SIDE is non-nil, the function checks for
5017 elements starting at or past POS instead. If SIDE is `both', the
5018 function returns a cons cell where car is the first element
5019 starting at or before POS and cdr the first element starting
5020 after POS.
5022 The function can only find elements in the synchronized part of
5023 the cache."
5027 lower upper)
5042 ;; We found an element in cache starting at POS. If `side'
5043 ;; is `both' we also want the next one in order to generate
5044 ;; a key in-between.
5045 ;;
5046 ;; If the element is the first row or item in a table or
5047 ;; a plain list, we always return the table or the plain
5048 ;; list.
5049 ;;
5050 ;; In any other case, we return the element found.
5059 lower parent
5060 upper parent)))))
5063 lower element
5064 upper element)))))
5071 "Store ELEMENT in current buffer's cache, if allowed."
5074 ;; During synchronization, first build an appropriate key for
5075 ;; the new element so `avl-tree-enter' can insert it at the
5076 ;; right spot in the cache.
5085 org-element--cache-sync-keys)))
5089 "Remove ELEMENT from cache.
5090 Assume ELEMENT belongs to cache and that a cache is active."
5094 ;;;; Synchronization
5097 "Set idle timer for cache synchronization in BUFFER."
5104 org-element-cache-sync-idle-time))
5105 nil
5106 #'org-element--cache-sync
5107 buffer)))
5110 "Non-nil when synchronization process should be interrupted.
5111 TIME-LIMIT is a time value or nil."
5117 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5119 Properties containing buffer positions are `:begin', `:end',
5120 `:contents-begin', `:contents-end' and `:structure'. When
5121 optional argument PROPS is a list of keywords, only shift
5122 properties provided in that list.
5124 Properties are modified by side-effect."
5126 ;; Shift `:structure' property for the first plain list only: it
5127 ;; is the only one that really matters and it prevents from
5128 ;; shifting it more than once.
5142 "Synchronize cache with recent modification in BUFFER.
5144 When optional argument THRESHOLD is non-nil, do the
5145 synchronization for all elements starting before or at threshold,
5146 then exit. Otherwise, synchronize cache for as long as
5147 `org-element-cache-sync-duration' or until Emacs leaves idle
5148 state.
5150 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5151 not registered yet in the cache are going to happen. It is used
5152 in `org-element--cache-submit-request', where cache is partially
5153 updated before current modification are actually submitted."
5164 request
5166 threshold
5169 org-element-cache-sync-duration))
5170 future-change)
5171 ;; Request processed. Merge current and next offsets and
5172 ;; transfer ending position.
5178 ;; If more requests are awaiting, set idle timer accordingly.
5179 ;; Otherwise, reset keys.
5186 "Process synchronization REQUEST for all entries before NEXT.
5188 REQUEST is a vector, built by `org-element--cache-submit-request'.
5190 NEXT is a cache key, as returned by `org-element--cache-key'.
5192 When non-nil, THRESHOLD is a buffer position. Synchronization
5193 stops as soon as a shifted element begins after it.
5195 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5196 after this time or when Emacs exits idle state.
5198 When non-nil, FUTURE-CHANGE is a buffer position where changes
5199 not registered yet in the cache are going to happen. See
5200 `org-element--cache-submit-request' for more information.
5202 Throw `interrupt' if the process stops before completing the
5203 request."
5206 ;; Phase 0.
5207 ;;
5208 ;; Delete all elements starting after BEG, but not after buffer
5209 ;; position END or past element with key NEXT. Also delete
5210 ;; elements contained within a previously removed element
5211 ;; (stored in `last-container').
5212 ;;
5213 ;; At each iteration, we start again at tree root since
5214 ;; a deletion modifies structure of the balanced tree.
5219 ;; Find first element in cache with key BEG or after it.
5223 data data-key last-container)
5232 data-key key
5235 data-key key
5236 node nil)))))
5246 up)))
5249 end))
5256 ;; No element starting after modifications left in
5257 ;; cache: further processing is futile.
5260 ;; Phase 1.
5261 ;;
5262 ;; Phase 0 left a hole in the cache. Some elements after it
5263 ;; could have parents within. For example, in the following
5264 ;; buffer:
5265 ;;
5266 ;; - item
5267 ;;
5268 ;;
5269 ;; Paragraph1
5270 ;;
5271 ;; Paragraph2
5272 ;;
5273 ;; if we remove a blank line between "item" and "Paragraph1",
5274 ;; everything down to "Paragraph2" is removed from cache. But
5275 ;; the paragraph now belongs to the list, and its `:parent'
5276 ;; property no longer is accurate.
5277 ;;
5278 ;; Therefore we need to parse again elements in the hole, or at
5279 ;; least in its last section, so that we can re-parent
5280 ;; subsequent elements, during phase 2.
5281 ;;
5282 ;; Note that we only need to get the parent from the first
5283 ;; element in cache after the hole.
5284 ;;
5285 ;; When next key is lesser or equal to the current one, delegate
5286 ;; phase 1 processing to next request in order to preserve key
5287 ;; order among requests.
5295 ;; Next element will start at its beginning position plus
5296 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5297 ;; contains the real beginning position of the first element to
5298 ;; shift and re-parent.
5302 ;; Changes are going to happen around this element and
5303 ;; they will trigger another phase 1 request. Skip the
5304 ;; current one.
5310 ;; Phase 2.
5311 ;;
5312 ;; Shift all elements starting from key START, but before NEXT, by
5313 ;; OFFSET, and re-parent them when appropriate.
5314 ;;
5315 ;; Elements are modified by side-effect so the tree structure
5316 ;; remains intact.
5317 ;;
5318 ;; Once THRESHOLD, if any, is reached, or once there is an input
5319 ;; pending, exit. Before leaving, the current synchronization
5320 ;; request is updated.
5327 exit-flag)
5328 ;; No re-parenting nor shifting planned: request is over.
5338 ;; We reached NEXT. Request is complete.
5340 ;; Handle interruption request. Update current request.
5345 ;; Shift element.
5349 ;; Update PARENT and re-parent DATA, only when
5350 ;; necessary. Propagate new structures for lists.
5364 ;; Cache is up-to-date past THRESHOLD. Request
5365 ;; interruption.
5370 ;; We reached end of tree: synchronization complete.
5371 t)))
5374 "Parse elements in current section, down to POS.
5376 Start parsing from the closest between the last known element in
5377 cache or headline above. Return the smallest element containing
5378 POS.
5380 When optional argument SYNCP is non-nil, return the parent of the
5381 element containing POS instead. In that case, it is also
5382 possible to provide TIME-LIMIT, which is a time value specifying
5383 when the parsing should stop. The function throws `interrupt' if
5384 the process stopped before finding the expected result."
5391 element next mode)
5393 ;; Nothing in cache before point: start parsing from first
5394 ;; element following headline above, or first element in
5395 ;; buffer.
5402 ;; Cache returned exact match: return it.
5405 ;; There's a headline between cached value and POS: cached
5406 ;; value is invalid. Start parsing from first element
5407 ;; following the headline.
5414 ;; Check if CACHED or any of its ancestors contain point.
5415 ;;
5416 ;; If there is such an element, we inspect it in order to know
5417 ;; if we return it or if we need to parse its contents.
5418 ;; Otherwise, we just start parsing from current location,
5419 ;; which is right after the top-most element containing
5420 ;; CACHED.
5421 ;;
5422 ;; As a special case, if POS is at the end of the buffer, we
5423 ;; want to return the innermost element ending there.
5424 ;;
5425 ;; Also, if we find an ancestor and discover that we need to
5426 ;; parse its contents, make sure we don't start from
5427 ;; `:contents-begin', as we would otherwise go past CACHED
5428 ;; again. Instead, in that situation, we will resume parsing
5429 ;; from NEXT, which is located after CACHED or its higher
5430 ;; ancestor not containing point.
5442 ;; Parse successively each element until we reach POS.
5455 end 'element mode
5462 ;; Skip any element ending before point. Also skip
5463 ;; element ending at point (unless it is also the end of
5464 ;; buffer) since we're sure that another element begins
5465 ;; after it.
5469 ;; A non-greater element contains point: return it.
5472 ;; Otherwise, we have to decide if ELEMENT really
5473 ;; contains POS. In that case we start parsing from
5474 ;; contents' beginning.
5475 ;;
5476 ;; If POS is at contents' beginning but it is also at
5477 ;; the beginning of the first item in a list or a table.
5478 ;; In that case, we need to create an anchor for that
5479 ;; list or table, so return it.
5480 ;;
5481 ;; Also, if POS is at the end of the buffer, no element
5482 ;; can start after it, but more than one may end there.
5483 ;; Arbitrarily, we choose to return the innermost of
5484 ;; such elements.
5497 parent element
5498 end cend))))
5499 ;; Otherwise, return ELEMENT as it is the smallest
5500 ;; element containing POS.
5505 ;;;; Staging Buffer Changes
5516 "Regexp matching a sensitive line, structure wise.
5517 A sensitive line is a headline, inlinetask, block, drawer, or
5518 latex-environment boundary. When such a line is modified,
5519 structure changes in the document may propagate in the whole
5523 "Non-nil when a sensitive line is about to be changed.
5527 "Request extension of area going to be modified if needed.
5528 BEG and END are the beginning and end of the range of changed
5529 text. See `before-change-functions' for more information."
5539 'headline
5542 org-element--cache-sensitive-re bottom t)))))))))
5545 "Update buffer modifications for current buffer.
5546 BEG and END are the beginning and end of the range of changed
5547 text, and the length in bytes of the pre-change text replaced by
5548 that range. See `after-change-functions' for more information."
5556 ;; Determine if modified area needs to be extended, according
5557 ;; to both previous and current state. We make a special
5558 ;; case for headline editing: if a headline is modified but
5559 ;; not removed, do not extend.
5562 (`headline
5568 org-element--cache-sensitive-re bottom t))))
5569 ;; Effectively extend modified area.
5577 ;; Store synchronization request.
5580 ;; Activate a timer to process the request during idle time.
5584 "Return first element to remove from cache.
5586 BEG and END are buffer positions delimiting buffer modifications.
5587 OFFSET is the size of the changes.
5589 Returned element is usually the first element in cache containing
5590 any position between BEG and END. As an exception, greater
5591 elements around the changes that are robust to contents
5592 modifications are preserved and updated according to the
5593 changes."
5603 special-block))
5604 ;; Drawers named "PROPERTIES" are probably
5605 ;; a properties drawer being edited. Force
5606 ;; parsing to check if editing is over.
5615 ;; UP is a robust greater element containing changes.
5616 ;; We only need to extend its ending boundaries.
5622 ;; We're at top level element containing ELEMENT: if it's
5623 ;; altered by buffer modifications, it is first element in
5624 ;; cache to be removed. Otherwise, that first element is the
5625 ;; following one.
5626 ;;
5627 ;; As a special case, do not remove BEFORE if it is a robust
5628 ;; container for current changes.
5630 before)))))
5633 "Submit a new cache synchronization request for current buffer.
5634 BEG and END are buffer positions delimiting the minimal area
5635 where cache data should be removed. OFFSET is the size of the
5636 change, as an integer."
5638 delete-to delete-from)
5643 ;; Current changes can be merged with first sync request: we
5644 ;; can save a partial cache synchronization.
5647 ;; If last change happened within area to be removed, extend
5648 ;; boundaries of robust parents, if any. Otherwise, find
5649 ;; first element to remove and update request accordingly.
5661 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5662 ;; if any, is no longer a 0-phase request, thus ensuring that
5663 ;; phases are properly ordered. We need to provide OFFSET as
5664 ;; optional parameter since current modifications are not known
5665 ;; yet to the otherwise correct part of the cache (i.e, before
5666 ;; the first request).
5673 ;; When changes happen before the first known
5674 ;; element, re-parent and shift the rest of the
5675 ;; cache.
5677 ;; Otherwise, we find the first non robust
5678 ;; element containing END. All elements between
5679 ;; FIRST and this one are to be removed.
5690 element up))
5692 org-element--cache-sync-requests)
5693 ;; No element to remove. No need to re-parent either.
5694 ;; Simply shift additional elements, if any, by OFFSET.
5697 offset)))))))
5700 ;;;; Public Functions
5702 ;;;###autoload
5704 "Reset cache in current buffer.
5705 When optional argument ALL is non-nil, reset cache in all Org
5706 buffers."
5723 ;;;###autoload
5725 "Refresh cache at position POS."
5732 \f
5733 ;;; The Toolbox
5734 ;;
5735 ;; The first move is to implement a way to obtain the smallest element
5736 ;; containing point. This is the job of `org-element-at-point'. It
5737 ;; basically jumps back to the beginning of section containing point
5738 ;; and proceed, one element after the other, with
5739 ;; `org-element--current-element' until the container is found. Note:
5740 ;; When using `org-element-at-point', secondary values are never
5741 ;; parsed since the function focuses on elements, not on objects.
5742 ;;
5743 ;; At a deeper level, `org-element-context' lists all elements and
5744 ;; objects containing point.
5745 ;;
5746 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5747 ;; internally by navigation and manipulation tools.
5750 ;;;###autoload
5752 "Determine closest element around point.
5754 Return value is a list like (TYPE PROPS) where TYPE is the type
5755 of the element and PROPS a plist of properties associated to the
5756 element.
5758 Possible types are defined in `org-element-all-elements'.
5759 Properties depend on element or object type, but always include
5760 `:begin', `:end', `:parent' and `:post-blank' properties.
5762 As a special case, if point is at the very beginning of the first
5763 item in a list or sub-list, returned element will be that list
5764 instead of the item. Likewise, if point is at the beginning of
5765 the first row of a table, returned element will be the table
5766 instead of the first row.
5768 When point is at the end of the buffer, return the innermost
5769 element ending there."
5775 ;; Within blank lines at the beginning of buffer, return nil.
5777 ;; Within blank lines right after a headline, return that
5778 ;; headline.
5782 ;; Otherwise parse until we find element containing ORIGIN.
5789 ;;;###autoload
5791 "Return smallest element or object around point.
5793 Return value is a list like (TYPE PROPS) where TYPE is the type
5794 of the element or object and PROPS a plist of properties
5795 associated to it.
5797 Possible types are defined in `org-element-all-elements' and
5798 `org-element-all-objects'. Properties depend on element or
5799 object type, but always include `:begin', `:end', `:parent' and
5800 `:post-blank'.
5802 As a special case, if point is right after an object and not at
5803 the beginning of any other object, return that object.
5805 Optional argument ELEMENT, when non-nil, is the closest element
5806 containing point, as returned by `org-element-at-point'.
5807 Providing it allows for quicker computation."
5814 ;; If point is inside an element containing objects or
5815 ;; a secondary string, narrow buffer to the container and
5816 ;; proceed with parsing. Otherwise, return ELEMENT.
5818 ;; At a parsed affiliated keyword, check if we're inside main
5819 ;; or dual value.
5825 org-element-parsed-keywords))
5834 ;; Also change type to retrieve correct restrictions.
5836 ;; At an item, objects can only be located within tag, if any.
5847 ;; At an headline or inlinetask, objects are in title.
5859 ;; At a paragraph, a table-row or a verse block, objects are
5860 ;; located within their contents.
5864 ;; CBEG is nil for table rules.
5869 ;; At a planning line, if point is at a timestamp, return it,
5870 ;; otherwise, return element.
5878 ;; All other locations cannot contain objects: bail out.
5884 last)
5889 ;; Process NEXT, if any, in order to know if we need to
5890 ;; skip it, return it or move into it.
5897 ;; Skip objects ending before point. Also skip
5898 ;; objects ending at point unless it is also the
5899 ;; end of buffer, since we want to return the
5900 ;; innermost object.
5903 ;; For convenience, when object ends at POS,
5904 ;; without any space, store it in LAST, as we
5905 ;; will return it if no object starts here.
5909 ;; If POS is within a container object, move into
5910 ;; that object.
5914 ;; At contents' end, if there is no
5915 ;; space before point, also move into
5916 ;; object, for consistency with
5917 ;; convenience feature above.
5926 ;; Otherwise, return NEXT.
5930 "List all ancestors of a given element or object.
5932 BLOB is an object or element.
5934 When optional argument TYPES is a list of symbols, return the
5935 first element or object in the lineage whose type belongs to that
5936 list.
5938 When optional argument WITH-SELF is non-nil, lineage includes
5939 BLOB itself as the first element, and TYPES, if provided, also
5940 apply to it.
5942 When BLOB is obtained through `org-element-context' or
5943 `org-element-at-point', only ancestors from its section can be
5944 found. There is no such limitation when BLOB belongs to a full
5945 parse tree."
5947 ancestors)
5954 "Non-nil when elements ELEM-A and ELEM-B are nested."
5963 "Swap elements ELEM-A and ELEM-B.
5964 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5965 end of ELEM-A."
5967 ;; There are two special cases when an element doesn't start at bol:
5968 ;; the first paragraph in an item or in a footnote definition.
5970 ;; Only a paragraph without any affiliated keyword can be moved at
5971 ;; ELEM-A position in such a situation. Note that the case of
5972 ;; a footnote definition is impossible: it cannot contain two
5973 ;; paragraphs in a row because it cannot contain a blank line.
5979 ;; In a special situation, ELEM-A will have no indentation. We'll
5980 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5994 ;; Store inner overlays responsible for visibility status.
5995 ;; We also need to store their boundaries as they will be
5996 ;; removed from buffer.
6011 ;; Get contents.
6019 ;; Restore ex ELEM-A overlays.
6026 ;; Restore ex ELEM-B overlays.
6034 ;; Local variables:
6035 ;; generated-autoload-file: "org-loaddefs.el"
6036 ;; End:
6038 ;;; org-element.el ends here