| blob | f4075780ceea0e271ad0c6826d19c60260cebccb |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links in a link description.
356 ;; Also ignore radio-targets and line breaks.
358 italic latex-fragment macro plain-link statistics-cookie
359 strike-through 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 square brackets.
406 \f
407 ;;; Accessors and Setters
408 ;;
409 ;; Provide four accessors: `org-element-type', `org-element-property'
410 ;; `org-element-contents' and `org-element-restriction'.
411 ;;
412 ;; Setter functions allow to modify elements by side effect. There is
413 ;; `org-element-put-property', `org-element-set-contents'. These
414 ;; low-level functions are useful to build a parse tree.
415 ;;
416 ;; `org-element-adopt-element', `org-element-set-element',
417 ;; `org-element-extract-element' and `org-element-insert-before' are
418 ;; high-level functions useful to modify a parse tree.
419 ;;
420 ;; `org-element-secondary-p' is a predicate used to know if a given
421 ;; object belongs to a secondary string. `org-element-copy' returns
422 ;; an element or object, stripping its parent property in the process.
425 "Return type of ELEMENT.
427 The function returns the type of the element or object provided.
428 It can also return the following special value:
429 `plain-text' for a string
430 `org-data' for a complete document
431 nil in any other case."
437 "Extract the value from the PROPERTY of an ELEMENT."
442 "Extract contents from an ELEMENT."
448 "Return restriction associated to ELEMENT.
449 ELEMENT can be an element, an object or a symbol representing an
450 element or object type."
452 org-element-object-restrictions)))
455 "In ELEMENT set PROPERTY to VALUE.
456 Return modified element."
459 element))
462 "Set ELEMENT contents to CONTENTS."
469 "Non-nil when OBJECT directly belongs to a secondary string.
470 Return value is the property name, as a keyword, or nil."
473 org-element-secondary-value-alist))))
480 "Append elements to the contents of another element.
482 PARENT is an element or object. CHILDREN can be elements,
483 objects, or a strings.
485 The function takes care of setting `:parent' property for CHILD.
486 Return parent element."
488 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
489 ;; string: parent is the list itself.
492 ;; Add CHILDREN at the end of PARENT contents.
495 parent
497 ;; Return modified PARENT element.
501 "Extract ELEMENT from parse tree.
502 Remove element from the parse tree by side-effect, and return it
503 with its `:parent' property stripped out."
508 parent secondary
511 parent
513 ;; Return ELEMENT with its :parent removed.
517 "Insert ELEMENT before LOCATION in parse tree.
518 LOCATION is an element, object or string within the parse tree.
519 Parse tree is modified by side effect."
524 ;; Special case: LOCATION is the first element of an
525 ;; independent secondary string (e.g. :title property). Add
526 ;; ELEMENT in-place.
530 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
540 ;; Store SIBLINGS at appropriate place in parse tree.
545 ;; Set appropriate :parent property.
549 "Replace element or object OLD with element or object NEW.
550 The function takes care of setting `:parent' property for NEW."
551 ;; Ensure OLD and NEW have the same parent.
555 ;; We cannot replace OLD with NEW since one of them is not an
556 ;; object or element. We take the long path.
559 ;; Since OLD is going to be changed into NEW by side-effect, first
560 ;; make sure that every element or object within NEW has OLD as
561 ;; parent.
564 ;; Transfer contents.
566 ;; Overwrite OLD's properties with NEW's.
568 ;; Transfer type.
572 "Create a new element of type TYPE.
573 Optional argument PROPS, when non-nil, is a plist defining the
574 properties of the element. CHILDREN can be elements, objects or
575 strings."
579 "Return a copy of DATUM.
580 DATUM is an element, object, string or nil. `:parent' property
581 is cleared and contents are removed in the process."
592 \f
593 ;;; Greater elements
594 ;;
595 ;; For each greater element type, we define a parser and an
596 ;; interpreter.
597 ;;
598 ;; A parser returns the element or object as the list described above.
599 ;; Most of them accepts no argument. Though, exceptions exist. Hence
600 ;; every element containing a secondary string (see
601 ;; `org-element-secondary-value-alist') will accept an optional
602 ;; argument to toggle parsing of these secondary strings. Moreover,
603 ;; `item' parser requires current list's structure as its first
604 ;; element.
605 ;;
606 ;; An interpreter accepts two arguments: the list representation of
607 ;; the element or object, and its contents. The latter may be nil,
608 ;; depending on the element or object considered. It returns the
609 ;; appropriate Org syntax, as a string.
610 ;;
611 ;; Parsing functions must follow the naming convention:
612 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
613 ;; defined in `org-element-greater-elements'.
614 ;;
615 ;; Similarly, interpreting functions must follow the naming
616 ;; convention: org-element-TYPE-interpreter.
617 ;;
618 ;; With the exception of `headline' and `item' types, greater elements
619 ;; cannot contain other greater elements of their own type.
620 ;;
621 ;; Beside implementing a parser and an interpreter, adding a new
622 ;; greater element requires to tweak `org-element--current-element'.
623 ;; Moreover, the newly defined type must be added to both
624 ;; `org-element-all-elements' and `org-element-greater-elements'.
627 ;;;; Center Block
630 "Parse a center block.
632 LIMIT bounds the search. AFFILIATED is a list of which CAR is
633 the buffer position at the beginning of the first affiliated
634 keyword and CDR is a plist of affiliated keywords along with
635 their value.
637 Return a list whose CAR is `center-block' and CDR is a plist
638 containing `:begin', `:end', `:contents-begin', `:contents-end',
639 `:post-blank' and `:post-affiliated' keywords.
641 Assume point is at the beginning of the block."
645 ;; Incomplete block: parse it as a paragraph.
650 ;; Empty blocks have no contents.
664 :end end
665 :contents-begin contents-begin
666 :contents-end contents-end
672 "Interpret a center-block element as Org syntax.
673 CONTENTS is the contents of the element."
677 ;;;; Drawer
680 "Parse a drawer.
682 LIMIT bounds the search. AFFILIATED is a list of which CAR is
683 the buffer position at the beginning of the first affiliated
684 keyword and CDR is a plist of affiliated keywords along with
685 their value.
687 Return a list whose CAR is `drawer' and CDR is a plist containing
688 `:drawer-name', `:begin', `:end', `:contents-begin',
689 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
691 Assume point is at beginning of drawer."
694 ;; Incomplete drawer: parse it as a paragraph.
702 ;; Empty drawers have no contents.
715 :end end
716 :drawer-name name
717 :contents-begin contents-begin
718 :contents-end contents-end
724 "Interpret DRAWER element as Org syntax.
725 CONTENTS is the contents of the element."
728 contents))
731 ;;;; Dynamic Block
734 "Parse a dynamic block.
736 LIMIT bounds the search. AFFILIATED is a list of which CAR is
737 the buffer position at the beginning of the first affiliated
738 keyword and CDR is a plist of affiliated keywords along with
739 their value.
741 Return a list whose CAR is `dynamic-block' and CDR is a plist
742 containing `:block-name', `:begin', `:end', `:contents-begin',
743 `:contents-end', `:arguments', `:post-blank' and
744 `:post-affiliated' keywords.
746 Assume point is at beginning of dynamic block."
750 ;; Incomplete block: parse it as a paragraph.
759 ;; Empty blocks have no contents.
772 :end end
773 :block-name name
774 :arguments arguments
775 :contents-begin contents-begin
776 :contents-end contents-end
782 "Interpret DYNAMIC-BLOCK element as Org syntax.
783 CONTENTS is the contents of the element."
788 contents))
791 ;;;; Footnote Definition
794 "Parse a footnote definition.
796 LIMIT bounds the search. AFFILIATED is a list of which CAR is
797 the buffer position at the beginning of the first affiliated
798 keyword and CDR is a plist of affiliated keywords along with
799 their value.
801 Return a list whose CAR is `footnote-definition' and CDR is
802 a plist containing `:label', `:begin' `:end', `:contents-begin',
803 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
805 Assume point is at the beginning of the footnote definition."
833 :begin begin
834 :end end
835 :contents-begin contents-begin
836 :contents-end contents-end
842 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
843 CONTENTS is the contents of the footnote-definition."
845 " "
846 contents))
849 ;;;; Headline
852 "Return node properties associated to headline at point.
853 Upcase property names. It avoids confusion between properties
854 obtained through property drawer and default properties from the
855 parser (e.g. `:end' and :END:). Return value is a plist."
867 properties))))
870 "Return time properties associated to headline at point.
871 Return value is a plist."
885 plist))))
888 "Parse a headline.
890 Return a list whose CAR is `headline' and CDR is a plist
891 containing `:raw-value', `:title', `:begin', `:end',
892 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
893 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
894 `:deadline', `:closed', `:archivedp', `:commentedp'
895 `:footnote-section-p', `:post-blank' and `:post-affiliated'
896 keywords.
898 The plist also contains any property set in the property drawer,
899 with its name in upper cases and colons added at the
900 beginning (e.g., `:CUSTOM_ID').
902 LIMIT is a buffer position bounding the search.
904 When RAW-SECONDARY-P is non-nil, headline's title will not be
905 parsed as a secondary string, but as a plain string instead.
907 Assume point is at beginning of the headline."
954 :begin begin
955 :end end
956 :pre-blank
959 :contents-begin contents-begin
960 :contents-end contents-end
961 :level level
962 :priority priority
963 :tags tags
964 :todo-keyword todo
965 :todo-type todo-type
968 end)
969 :footnote-section-p footnote-section-p
970 :archivedp archivedp
971 :commentedp commentedp
973 time-props
974 standard-props))))
976 headline :title
985 nil
991 "Interpret HEADLINE element as Org syntax.
992 CONTENTS is the contents of the element."
1005 ?*)
1009 " "
1012 org-footnote-section
1013 title))))
1015 heading
1016 ;; Align tags.
1024 ?\s)
1025 tags))
1029 tags))))
1031 contents)))
1034 ;;;; Inlinetask
1037 "Parse an inline task.
1039 Return a list whose CAR is `inlinetask' and CDR is a plist
1040 containing `:title', `:begin', `:end', `:contents-begin' and
1041 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1042 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1043 `:closed', `:post-blank' and `:post-affiliated' keywords.
1045 The plist also contains any property set in the property drawer,
1046 with its name in upper cases and colons added at the
1047 beginning (e.g., `:CUSTOM_ID').
1049 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1050 title will not be parsed as a secondary string, but as a plain
1051 string instead.
1053 Assume point is at beginning of the inline task."
1098 :begin begin
1099 :end end
1100 :contents-begin contents-begin
1101 :contents-end contents-end
1102 :level level
1103 :priority priority
1104 :tags tags
1105 :todo-keyword todo
1106 :todo-type todo-type
1109 time-props
1110 standard-props))))
1112 inlinetask :title
1121 nil
1127 "Interpret INLINETASK element as Org syntax.
1128 CONTENTS is the contents of inlinetask."
1142 ;; Align tags.
1150 ? )
1151 tags))
1155 tags))))
1156 ;; Prefer degenerate inlinetasks when there are no
1157 ;; contents.
1160 contents
1164 ;;;; Item
1167 "Parse an item.
1169 STRUCT is the structure of the plain list.
1171 Return a list whose CAR is `item' and CDR is a plist containing
1172 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1173 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1174 `:post-affiliated' keywords.
1176 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1177 any, will not be parsed as a secondary string, but as a plain
1178 string instead.
1180 Assume point is at the beginning of the item."
1203 ;; Ignore tags in un-ordered lists: they are just
1204 ;; a part of item's body.
1211 ;; If first line isn't empty, contents really
1212 ;; start at the text after item's meta-data.
1222 :begin begin
1223 :end end
1224 :contents-begin contents-begin
1225 :contents-end contents-end
1226 :checkbox checkbox
1227 :counter counter
1228 :structure struct
1232 item :tag
1243 "Interpret ITEM element as Org syntax.
1244 CONTENTS is the contents of the element."
1254 ;; Compute indentation.
1259 ;; Indent contents.
1261 bullet
1276 ;;;; Plain List
1279 ;; Return structure of list at point. Internal function. See
1280 ;; `org-list-struct' for details.
1285 items struct)
1290 ;; At limit: end all items.
1299 ;; At list end: end all items.
1304 ;; At a new item: end previous sibling.
1316 ind
1317 bullet
1320 ;; Description tag.
1324 ;; Ending position, unknown so far.
1325 nil)))
1326 items))
1328 ;; Skip empty lines.
1330 ;; Skip inline tasks and blank lines along the way.
1337 ;; At some text line. Check if it ends any previous item.
1350 ;; Skip blocks (any type) and drawers contents.
1355 limit t)))
1361 "Parse a plain list.
1363 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1364 the buffer position at the beginning of the first affiliated
1365 keyword and CDR is a plist of affiliated keywords along with
1366 their value. STRUCTURE is the structure of the plain list being
1367 parsed.
1369 Return a list whose CAR is `plain-list' and CDR is a plist
1370 containing `:type', `:begin', `:end', `:contents-begin' and
1371 `:contents-end', `:structure', `:post-blank' and
1372 `:post-affiliated' keywords.
1374 Assume point is at the beginning of the list."
1388 pos))
1392 ;; Return value.
1396 :begin begin
1397 :end end
1398 :contents-begin contents-begin
1399 :contents-end contents-end
1400 :structure struct
1406 "Interpret plain-list element as Org syntax.
1407 CONTENTS is the contents of the element."
1415 ;;;; Property Drawer
1418 "Parse a property drawer.
1420 LIMIT bounds the search.
1422 Return a list whose car is `property-drawer' and cdr is a plist
1423 containing `:begin', `:end', `:contents-begin', `:contents-end',
1424 `:post-blank' and `:post-affiliated' keywords.
1426 Assume point is at the beginning of the property drawer."
1439 :end end
1441 :contents-end contents-end
1446 "Interpret property-drawer element as Org syntax.
1447 CONTENTS is the properties within the drawer."
1451 ;;;; Quote Block
1454 "Parse a quote block.
1456 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1457 the buffer position at the beginning of the first affiliated
1458 keyword and CDR is a plist of affiliated keywords along with
1459 their value.
1461 Return a list whose CAR is `quote-block' and CDR is a plist
1462 containing `:begin', `:end', `:contents-begin', `:contents-end',
1463 `:post-blank' and `:post-affiliated' keywords.
1465 Assume point is at the beginning of the block."
1469 ;; Incomplete block: parse it as a paragraph.
1475 ;; Empty blocks have no contents.
1488 :end end
1489 :contents-begin contents-begin
1490 :contents-end contents-end
1496 "Interpret quote-block element as Org syntax.
1497 CONTENTS is the contents of the element."
1501 ;;;; Section
1504 "Parse a section.
1506 Return a list whose CAR is `section' and CDR is a plist
1507 containing `:begin', `:end', `:contents-begin', `contents-end',
1508 `:post-blank' and `:post-affiliated' keywords."
1510 ;; Beginning of section is the beginning of the first non-blank
1511 ;; line after previous headline.
1519 :end end
1520 :contents-begin begin
1521 :contents-end pos-before-blank
1526 "Interpret section element as Org syntax.
1527 CONTENTS is the contents of the element."
1528 contents)
1531 ;;;; Special Block
1534 "Parse a special block.
1536 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1537 the buffer position at the beginning of the first affiliated
1538 keyword and CDR is a plist of affiliated keywords along with
1539 their value.
1541 Return a list whose CAR is `special-block' and CDR is a plist
1542 containing `:type', `:begin', `:end', `:contents-begin',
1543 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1545 Assume point is at the beginning of the block."
1552 limit t)))
1553 ;; Incomplete block: parse it as a paragraph.
1559 ;; Empty blocks have no contents.
1572 :begin begin
1573 :end end
1574 :contents-begin contents-begin
1575 :contents-end contents-end
1581 "Interpret SPECIAL-BLOCK element as Org syntax.
1582 CONTENTS is the contents of the element."
1587 \f
1588 ;;; Elements
1589 ;;
1590 ;; For each element, a parser and an interpreter are also defined.
1591 ;; Both follow the same naming convention used for greater elements.
1592 ;;
1593 ;; Also, as for greater elements, adding a new element type is done
1594 ;; through the following steps: implement a parser and an interpreter,
1595 ;; tweak `org-element--current-element' so that it recognizes the new
1596 ;; type and add that new type to `org-element-all-elements'.
1599 ;;;; Babel Call
1602 "Parse a babel call.
1604 LIMIT bounds the search. AFFILIATED is a list of which car is
1605 the buffer position at the beginning of the first affiliated
1606 keyword and cdr is a plist of affiliated keywords along with
1607 their value.
1609 Return a list whose car is `babel-call' and cdr is a plist
1610 containing `:call', `:inside-header', `:arguments',
1611 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1612 `:post-affiliated' as keywords."
1626 value)))
1636 :begin begin
1637 :end end
1638 :value value
1644 "Interpret BABEL-CALL element as Org syntax."
1654 ;;;; Clock
1657 "Parse a clock.
1659 LIMIT bounds the search.
1661 Return a list whose CAR is `clock' and CDR is a plist containing
1662 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1663 `:post-affiliated' as keywords."
1683 :value value
1684 :duration duration
1685 :begin begin
1686 :end end
1687 :post-blank post-blank
1691 "Interpret CLOCK element as Org syntax."
1699 "%2s:%02s"
1703 ;;;; Comment
1706 "Parse a comment.
1708 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1709 the buffer position at the beginning of the first affiliated
1710 keyword and CDR is a plist of affiliated keywords along with
1711 their value.
1713 Return a list whose CAR is `comment' and CDR is a plist
1714 containing `:begin', `:end', `:value', `:post-blank',
1715 `:post-affiliated' keywords.
1717 Assume point is at comment beginning."
1726 ;; Get comments ending.
1729 ;; Accumulate lines without leading hash and first
1730 ;; whitespace.
1744 :end end
1745 :value value
1751 "Interpret COMMENT element as Org syntax.
1752 CONTENTS is nil."
1756 ;;;; Comment Block
1759 "Parse an export block.
1761 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1762 the buffer position at the beginning of the first affiliated
1763 keyword and CDR is a plist of affiliated keywords along with
1764 their value.
1766 Return a list whose CAR is `comment-block' and CDR is a plist
1767 containing `:begin', `:end', `:value', `:post-blank' and
1768 `:post-affiliated' keywords.
1770 Assume point is at comment block beginning."
1774 ;; Incomplete block: parse it as a paragraph.
1787 contents-begin contents-end)))
1791 :end end
1792 :value value
1798 "Interpret COMMENT-BLOCK element as Org syntax."
1805 ;;;; Diary Sexp
1808 "Parse a diary sexp.
1810 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1811 the buffer position at the beginning of the first affiliated
1812 keyword and CDR is a plist of affiliated keywords along with
1813 their value.
1815 Return a list whose CAR is `diary-sexp' and CDR is a plist
1816 containing `:begin', `:end', `:value', `:post-blank' and
1817 `:post-affiliated' keywords."
1829 :begin begin
1830 :end end
1836 "Interpret DIARY-SEXP as Org syntax."
1840 ;;;; Example Block
1843 "Parse an example block.
1845 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1846 the buffer position at the beginning of the first affiliated
1847 keyword and CDR is a plist of affiliated keywords along with
1848 their value.
1850 Return a list whose CAR is `example-block' and CDR is a plist
1851 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1852 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1853 `:value', `:post-blank' and `:post-affiliated' keywords."
1857 ;; Incomplete block: parse it as a paragraph.
1865 ;; Switches analysis
1872 ;; Should labels be retained in (or stripped from) example
1873 ;; blocks?
1878 ;; What should code-references use - labels or
1879 ;; line-numbers?
1888 ;; Standard block parsing.
1896 contents-begin contents-end))
1897 block-ind))
1906 :end end
1907 :value value
1908 :switches switches
1909 :number-lines number-lines
1910 :preserve-indent preserve-indent
1911 :retain-labels retain-labels
1912 :use-labels use-labels
1913 :label-fmt label-fmt
1919 "Interpret EXAMPLE-BLOCK element as Org syntax."
1927 value
1932 ;;;; Export Block
1935 "Parse an export block.
1937 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1938 the buffer position at the beginning of the first affiliated
1939 keyword and CDR is a plist of affiliated keywords along with
1940 their value.
1942 Return a list whose CAR is `export-block' and CDR is a plist
1943 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1944 `:post-affiliated' keywords.
1946 Assume point is at export-block beginning."
1950 ;; Incomplete block: parse it as a paragraph.
1968 contents-end)))
1972 :begin begin
1973 :end end
1974 :value value
1980 "Interpret EXPORT-BLOCK element as Org syntax."
1986 ;;;; Fixed-width
1989 "Parse a fixed-width section.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `fixed-width' and CDR is a plist
1997 containing `:begin', `:end', `:value', `:post-blank' and
1998 `:post-affiliated' keywords.
2000 Assume point is at the beginning of the fixed-width area."
2004 value
2009 ;; Accumulate text without starting colons.
2022 :end end
2023 :value value
2029 "Interpret FIXED-WIDTH element as Org syntax."
2037 ;;;; Horizontal Rule
2040 "Parse an horizontal rule.
2042 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2043 the buffer position at the beginning of the first affiliated
2044 keyword and CDR is a plist of affiliated keywords along with
2045 their value.
2047 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2048 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2049 keywords."
2059 :end end
2065 "Interpret HORIZONTAL-RULE element as Org syntax."
2069 ;;;; Keyword
2072 "Parse a keyword at point.
2074 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2075 the buffer position at the beginning of the first affiliated
2076 keyword and CDR is a plist of affiliated keywords along with
2077 their value.
2079 Return a list whose CAR is `keyword' and CDR is a plist
2080 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2081 `:post-affiliated' keywords."
2083 ;; An orphaned affiliated keyword is considered as a regular
2084 ;; keyword. In this case AFFILIATED is nil, so we take care of
2085 ;; this corner case.
2098 :value value
2099 :begin begin
2100 :end end
2106 "Interpret KEYWORD element as Org syntax."
2112 ;;;; Latex Environment
2116 "Regexp matching the beginning of a LaTeX environment.
2117 The environment is captured by the first group.
2123 "Format string matching the ending of a LaTeX environment.
2127 "Parse a LaTeX environment.
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 `latex-environment' and CDR is a plist
2135 containing `:begin', `:end', `:value', `:post-blank' and
2136 `:post-affiliated' keywords.
2138 Assume point is at the beginning of the latex environment."
2145 limit t))
2146 ;; Incomplete latex environment: parse it as a paragraph.
2156 :end end
2157 :value value
2163 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2167 ;;;; Node Property
2170 "Parse a node-property at point.
2172 LIMIT bounds the search.
2174 Return a list whose CAR is `node-property' and CDR is a plist
2175 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2176 `:post-affiliated' keywords."
2186 limit))))
2189 :value value
2190 :begin begin
2191 :end end
2196 "Interpret NODE-PROPERTY element as Org syntax."
2202 ;;;; Paragraph
2205 "Parse a paragraph.
2207 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2208 the buffer position at the beginning of the first affiliated
2209 keyword and CDR is a plist of affiliated keywords along with
2210 their value.
2212 Return a list whose CAR is `paragraph' and CDR is a plist
2213 containing `:begin', `:end', `:contents-begin' and
2214 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2216 Assume point is at the beginning of the paragraph."
2223 ;; A matching `org-element-paragraph-separate' is not
2224 ;; necessarily the end of the paragraph. In particular,
2225 ;; drawers, blocks or LaTeX environments opening lines
2226 ;; must be closed. Moreover keywords with a secondary
2227 ;; value must belong to "dual keywords".
2241 limit t)))
2247 limit t)))
2250 org-element-dual-keywords))
2251 ;; Everything else is unambiguous.
2264 :end end
2265 :contents-begin contents-begin
2266 :contents-end contents-end
2272 "Interpret paragraph element as Org syntax.
2273 CONTENTS is the contents of the element."
2274 contents)
2277 ;;;; Planning
2280 "Parse a planning.
2282 LIMIT bounds the search.
2284 Return a list whose CAR is `planning' and CDR is a plist
2285 containing `:closed', `:deadline', `:scheduled', `:begin',
2286 `:end', `:post-blank' and `:post-affiliated' keywords."
2296 closed deadline scheduled)
2308 :deadline deadline
2309 :scheduled scheduled
2310 :begin begin
2311 :end end
2312 :post-blank post-blank
2316 "Interpret PLANNING element as Org syntax."
2318 #'identity
2335 ;;;; Src Block
2338 "Parse a src block.
2340 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2341 the buffer position at the beginning of the first affiliated
2342 keyword and CDR is a plist of affiliated keywords along with
2343 their value.
2345 Return a list whose CAR is `src-block' and CDR is a plist
2346 containing `:language', `:switches', `:parameters', `:begin',
2347 `:end', `:number-lines', `:retain-labels', `:use-labels',
2348 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2349 `:post-affiliated' keywords.
2351 Assume point is at the beginning of the block."
2354 limit t)))
2355 ;; Incomplete block: parse it as a paragraph.
2361 ;; Get language as a string.
2370 ;; Get switches.
2372 ;; Get parameters.
2374 ;; Switches analysis
2385 ;; Should labels be retained in (or stripped from)
2386 ;; src blocks?
2391 ;; What should code-references use - labels or
2392 ;; line-numbers?
2397 ;; Indentation.
2399 ;; Retrieve code.
2404 block-ind))
2408 ;; Get position after ending blank lines.
2418 :begin begin
2419 :end end
2420 :number-lines number-lines
2421 :preserve-indent preserve-indent
2422 :retain-labels retain-labels
2423 :use-labels use-labels
2424 :label-fmt label-fmt
2425 :value value
2431 "Interpret SRC-BLOCK element as Org syntax."
2440 val)
2454 ;;;; Table
2457 "Parse a table at point.
2459 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2460 the buffer position at the beginning of the first affiliated
2461 keyword and CDR is a plist of affiliated keywords along with
2462 their value.
2464 Return a list whose CAR is `table' and CDR is a plist containing
2465 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2466 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2467 keywords.
2469 Assume point is at the beginning of the table."
2485 acc))
2492 :end end
2493 :type type
2494 :tblfm tblfm
2495 ;; Only `org' tables have contents. `table.el' tables
2496 ;; use a `:value' property to store raw table as
2497 ;; a string.
2502 table-begin table-end))
2508 "Interpret TABLE element as Org syntax.
2509 CONTENTS is a string, if table's type is `org', or nil."
2520 ;;;; Table Row
2523 "Parse table row at point.
2525 Return a list whose CAR is `table-row' and CDR is a plist
2526 containing `:begin', `:end', `:contents-begin', `:contents-end',
2527 `:type', `:post-blank' and `:post-affiliated' keywords."
2531 ;; A table rule has no contents. In that case, ensure
2532 ;; CONTENTS-BEGIN matches CONTENTS-END.
2542 :begin begin
2543 :end end
2544 :contents-begin contents-begin
2545 :contents-end contents-end
2550 "Interpret TABLE-ROW element as Org syntax.
2551 CONTENTS is the contents of the table row."
2556 ;;;; Verse Block
2559 "Parse a verse block.
2561 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2562 the buffer position at the beginning of the first affiliated
2563 keyword and CDR is a plist of affiliated keywords along with
2564 their value.
2566 Return a list whose CAR is `verse-block' and CDR is a plist
2567 containing `:begin', `:end', `:contents-begin', `:contents-end',
2568 `:post-blank' and `:post-affiliated' keywords.
2570 Assume point is at beginning of the block."
2574 ;; Incomplete block: parse it as a paragraph.
2589 :end end
2590 :contents-begin contents-begin
2591 :contents-end contents-end
2597 "Interpret verse-block element as Org syntax.
2598 CONTENTS is verse block contents."
2602 \f
2603 ;;; Objects
2604 ;;
2605 ;; Unlike to elements, raw text can be found between objects. Hence,
2606 ;; `org-element--object-lex' is provided to find the next object in
2607 ;; buffer.
2608 ;;
2609 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2610 ;; object types they can contain will be specified in
2611 ;; `org-element-object-restrictions'.
2612 ;;
2613 ;; Creating a new type of object requires to alter
2614 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2615 ;; new type in `org-element-all-objects', and possibly add
2616 ;; restrictions in `org-element-object-restrictions'.
2618 ;;;; Bold
2621 "Parse bold object at point, if any.
2623 When at a bold object, return a list whose car is `bold' and cdr
2624 is a plist with `:begin', `:end', `:contents-begin' and
2625 `:contents-end' and `:post-blank' keywords. Otherwise, return
2626 nil.
2628 Assume point is at the first star marker."
2640 :end end
2641 :contents-begin contents-begin
2642 :contents-end contents-end
2646 "Interpret bold object as Org syntax.
2647 CONTENTS is the contents of the object."
2651 ;;;; Code
2654 "Parse code object at point, if any.
2656 When at a code object, return a list whose car is `code' and cdr
2657 is a plist with `:value', `:begin', `:end' and `:post-blank'
2658 keywords. Otherwise, return nil.
2660 Assume point is at the first tilde marker."
2671 :begin begin
2672 :end end
2676 "Interpret CODE object as Org syntax."
2680 ;;;; Entity
2683 "Parse entity at point, if any.
2685 When at an entity, return a list whose car is `entity' and cdr
2686 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2687 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2688 `:post-blank' as keywords. Otherwise, return nil.
2690 Assume point is at the beginning of the entity."
2692 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2710 :begin begin
2711 :end end
2712 :use-brackets-p bracketsp
2716 "Interpret ENTITY object as Org syntax."
2722 ;;;; Export Snippet
2725 "Parse export snippet at point.
2727 When at an export snippet, return a list whose car is
2728 `export-snippet' and cdr a plist with `:begin', `:end',
2729 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2730 return nil.
2732 Assume point is at the beginning of the snippet."
2748 :value value
2749 :begin begin
2750 :end end
2754 "Interpret EXPORT-SNIPPET object as Org syntax."
2760 ;;;; Footnote Reference
2763 "Parse footnote reference at point, if any.
2765 When at a footnote reference, return a list whose car is
2766 `footnote-reference' and cdr a plist with `:label', `:type',
2767 `:begin', `:end', `:content-begin', `:contents-end' and
2768 `:post-blank' as keywords. Otherwise, return nil."
2784 :type type
2785 :begin begin
2786 :end end
2792 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2793 CONTENTS is its definition, when inline, or nil."
2799 ;;;; Inline Babel Call
2802 "Parse inline babel call at point, if any.
2804 When at an inline babel call, return a list whose car is
2805 `inline-babel-call' and cdr a plist with `:call',
2806 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2807 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2809 Assume point is at the beginning of the babel call."
2825 :inside-header inside-header
2826 :arguments arguments
2827 :end-header end-header
2828 :begin begin
2829 :end end
2830 :value value
2834 "Interpret INLINE-BABEL-CALL object as Org syntax."
2844 ;;;; Inline Src Block
2847 "Parse inline source block at point, if any.
2849 When at an inline source block, return a list whose car is
2850 `inline-src-block' and cdr a plist with `:begin', `:end',
2851 `:language', `:value', `:parameters' and `:post-blank' as
2852 keywords. Otherwise, return nil.
2854 Assume point is at the beginning of the inline src block."
2867 :value value
2868 :parameters parameters
2869 :begin begin
2870 :end end
2874 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2879 language
2881 body)))
2883 ;;;; Italic
2886 "Parse italic object at point, if any.
2888 When at an italic object, return a list whose car is `italic' and
2889 cdr is a plist with `:begin', `:end', `:contents-begin' and
2890 `:contents-end' and `:post-blank' keywords. Otherwise, return
2891 nil.
2893 Assume point is at the first slash marker."
2905 :end end
2906 :contents-begin contents-begin
2907 :contents-end contents-end
2911 "Interpret italic object as Org syntax.
2912 CONTENTS is the contents of the object."
2916 ;;;; Latex Fragment
2919 "Parse LaTeX fragment at point, if any.
2921 When at a LaTeX fragment, return a list whose car is
2922 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2923 and `:post-blank' as keywords. Otherwise, return nil.
2925 Assume point is at the beginning of the LaTeX fragment."
2943 ;; Macro.
2953 :begin begin
2954 :end end
2958 "Interpret LATEX-FRAGMENT object as Org syntax."
2961 ;;;; Line Break
2964 "Parse line break at point, if any.
2966 When at a line break, return a list whose car is `line-break',
2967 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2968 Otherwise, return nil.
2970 Assume point is at the beginning of the line break."
2979 "Interpret LINE-BREAK object as Org syntax."
2983 ;;;; Link
2986 "Parse link at point, if any.
2988 When at a link, return a list whose car is `link' and cdr a plist
2989 with `:type', `:path', `:raw-link', `:application',
2990 `:search-option', `:begin', `:end', `:contents-begin',
2991 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2992 nil.
2994 Assume point is at the beginning of the link."
2997 end contents-begin contents-end link-end post-blank path type
2998 raw-link search-option application)
3000 ;; Type 1: Text targeted from a radio target.
3009 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3014 ;; RAW-LINK is the original link. Expand any
3015 ;; abbreviation in it.
3016 ;;
3017 ;; Also treat any newline character and associated
3018 ;; indentation as a single space character. This is not
3019 ;; compatible with RFC 3986, which requires to ignore
3020 ;; them altogether. However, doing so would require
3021 ;; users to encode spaces on the fly when writing links
3022 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3023 ;; [[shell:ls *.org]], which defeats Org's focus on
3024 ;; simplicity.
3029 ;; Determine TYPE of link and set PATH accordingly. According
3030 ;; to RFC 3986, remove whitespaces from URI in external links.
3031 ;; In internal ones, treat indentation as a single space.
3033 ;; File type.
3038 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3042 ;; Id type: PATH is the id.
3045 ;; Code-ref type: PATH is the name of the reference.
3050 ;; Custom-id type: PATH is the name of the custom id.
3054 ;; Fuzzy type: Internal link either matches a target, an
3055 ;; headline name or nothing. PATH is the target or
3056 ;; headline's name.
3060 ;; Type 3: Plain link, e.g., http://orgmode.org
3066 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3067 ;; bracket links, follow RFC 3986 and remove any extra
3068 ;; whitespace in URI.
3078 ;; In any case, deduce end point after trailing white space from
3079 ;; LINK-END variable.
3084 ;; Special "file" type link processing. Extract opening
3085 ;; application and search option, if any. Also normalize URI.
3092 ;; Translate link, if `org-link-translation-function' is set.
3100 :path path
3102 :application application
3103 :search-option search-option
3104 :begin begin
3105 :end end
3106 :contents-begin contents-begin
3107 :contents-end contents-end
3111 "Interpret LINK object as Org syntax.
3112 CONTENTS is the contents of the object, or nil."
3123 path
3130 ;;;; Macro
3133 "Parse macro at point, if any.
3135 When at a macro, return a list whose car is `macro' and cdr
3136 a plist with `:key', `:args', `:begin', `:end', `:value' and
3137 `:post-blank' as keywords. Otherwise, return nil.
3139 Assume point is at the macro."
3152 :value value
3153 :args args
3154 :begin begin
3155 :end end
3159 "Interpret MACRO object as Org syntax."
3163 ;;;; Radio-target
3166 "Parse radio target at point, if any.
3168 When at a radio target, return a list whose car is `radio-target'
3169 and cdr a plist with `:begin', `:end', `:contents-begin',
3170 `:contents-end', `:value' and `:post-blank' as keywords.
3171 Otherwise, return nil.
3173 Assume point is at the radio target."
3185 :end end
3186 :contents-begin contents-begin
3187 :contents-end contents-end
3188 :post-blank post-blank
3192 "Interpret target object as Org syntax.
3193 CONTENTS is the contents of the object."
3197 ;;;; Statistics Cookie
3200 "Parse statistics cookie at point, if any.
3202 When at a statistics cookie, return a list whose car is
3203 `statistics-cookie', and cdr a plist with `:begin', `:end',
3204 `:value' and `:post-blank' keywords. Otherwise, return nil.
3206 Assume point is at the beginning of the statistics-cookie."
3217 :end end
3218 :value value
3222 "Interpret STATISTICS-COOKIE object as Org syntax."
3226 ;;;; Strike-Through
3229 "Parse strike-through object at point, if any.
3231 When at a strike-through object, return a list whose car is
3232 `strike-through' and cdr is a plist with `:begin', `:end',
3233 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3234 Otherwise, return nil.
3236 Assume point is at the first plus sign marker."
3248 :end end
3249 :contents-begin contents-begin
3250 :contents-end contents-end
3254 "Interpret strike-through object as Org syntax.
3255 CONTENTS is the contents of the object."
3259 ;;;; Subscript
3262 "Parse subscript at point, if any.
3264 When at a subscript object, return a list whose car is
3265 `subscript' and cdr a plist with `:begin', `:end',
3266 `:contents-begin', `:contents-end', `:use-brackets-p' and
3267 `:post-blank' as keywords. Otherwise, return nil.
3269 Assume point is at the underscore."
3283 :end end
3284 :use-brackets-p bracketsp
3285 :contents-begin contents-begin
3286 :contents-end contents-end
3290 "Interpret SUBSCRIPT object as Org syntax.
3291 CONTENTS is the contents of the object."
3294 contents))
3297 ;;;; Superscript
3300 "Parse superscript at point, if any.
3302 When at a superscript object, return a list whose car is
3303 `superscript' and cdr a plist with `:begin', `:end',
3304 `:contents-begin', `:contents-end', `:use-brackets-p' and
3305 `:post-blank' as keywords. Otherwise, return nil.
3307 Assume point is at the caret."
3321 :end end
3322 :use-brackets-p bracketsp
3323 :contents-begin contents-begin
3324 :contents-end contents-end
3328 "Interpret SUPERSCRIPT object as Org syntax.
3329 CONTENTS is the contents of the object."
3332 contents))
3335 ;;;; Table Cell
3338 "Parse table cell at point.
3339 Return a list whose car is `table-cell' and cdr is a plist
3340 containing `:begin', `:end', `:contents-begin', `:contents-end'
3341 and `:post-blank' keywords."
3349 :end end
3350 :contents-begin contents-begin
3351 :contents-end contents-end
3355 "Interpret table-cell element as Org syntax.
3356 CONTENTS is the contents of the cell, or nil."
3360 ;;;; Target
3363 "Parse target at point, if any.
3365 When at a target, return a list whose car is `target' and cdr
3366 a plist with `:begin', `:end', `:value' and `:post-blank' as
3367 keywords. Otherwise, return nil.
3369 Assume point is at the target."
3379 :end end
3380 :value value
3384 "Interpret TARGET object as Org syntax."
3388 ;;;; Timestamp
3399 "Parse time stamp at point, if any.
3401 When at a time stamp, return a list whose car is `timestamp', and
3402 cdr a plist with `:type', `:raw-value', `:year-start',
3403 `:month-start', `:day-start', `:hour-start', `:minute-start',
3404 `:year-end', `:month-end', `:day-end', `:hour-end',
3405 `:minute-end', `:repeater-type', `:repeater-value',
3406 `:repeater-unit', `:warning-type', `:warning-value',
3407 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3408 Otherwise, return nil.
3410 Assume point is at the beginning of the timestamp."
3429 date-start)
3440 raw-value)
3442 :repeater-type
3448 :repeater-unit
3457 :warning-unit
3460 year-start month-start day-start hour-start minute-start year-end
3461 month-end day-end hour-end minute-end)
3462 ;; Parse date-start.
3470 ;; Compute date-end. It can be provided directly in time-stamp,
3471 ;; or extracted from time range. Otherwise, it defaults to the
3472 ;; same values as date-start.
3482 :raw-value raw-value
3483 :year-start year-start
3484 :month-start month-start
3485 :day-start day-start
3486 :hour-start hour-start
3487 :minute-start minute-start
3488 :year-end year-end
3489 :month-end month-end
3490 :day-end day-end
3491 :hour-end hour-end
3492 :minute-end minute-end
3493 :begin begin
3494 :end end
3496 repeater-props
3497 warning-props))))))
3500 "Interpret TIMESTAMP object as Org syntax."
3518 ;; Build an Org timestamp string from TIME. ACTIVEP is
3519 ;; non-nil when time stamp is active. If WITH-TIME-P is
3520 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3521 ;; specify a time range in the timestamp. REPEAT-STRING is
3522 ;; the repeater string, if any.
3526 org-time-stamp-formats)
3527 time)))
3533 nil nil ts)))
3538 " "
3539 s
3541 ;; Return value.
3542 ts)))
3554 build-ts-string
3573 0
3581 "--"
3594 ;;;; Underline
3597 "Parse underline object at point, if any.
3599 When at an underline object, return a list whose car is
3600 `underline' and cdr is a plist with `:begin', `:end',
3601 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3602 Otherwise, return nil.
3604 Assume point is at the first underscore marker."
3616 :end end
3617 :contents-begin contents-begin
3618 :contents-end contents-end
3622 "Interpret underline object as Org syntax.
3623 CONTENTS is the contents of the object."
3627 ;;;; Verbatim
3630 "Parse verbatim object at point, if any.
3632 When at a verbatim object, return a list whose car is `verbatim'
3633 and cdr is a plist with `:value', `:begin', `:end' and
3634 `:post-blank' keywords. Otherwise, return nil.
3636 Assume point is at the first equal sign marker."
3647 :begin begin
3648 :end end
3652 "Interpret VERBATIM object as Org syntax."
3656 \f
3657 ;;; Parsing Element Starting At Point
3658 ;;
3659 ;; `org-element--current-element' is the core function of this section.
3660 ;; It returns the Lisp representation of the element starting at
3661 ;; point.
3662 ;;
3663 ;; `org-element--current-element' makes use of special modes. They
3664 ;; are activated for fixed element chaining (e.g., `plain-list' >
3665 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3666 ;; `section'). Special modes are: `first-section', `item',
3667 ;; `node-property', `section' and `table-row'.
3670 "Parse the element starting at point.
3672 Return value is a list like (TYPE PROPS) where TYPE is the type
3673 of the element and PROPS a plist of properties associated to the
3674 element.
3676 Possible types are defined in `org-element-all-elements'.
3678 LIMIT bounds the search.
3680 Optional argument GRANULARITY determines the depth of the
3681 recursion. Allowed values are `headline', `greater-element',
3682 `element', `object' or nil. When it is broader than `object' (or
3683 nil), secondary values will not be parsed, since they only
3684 contain objects.
3686 Optional argument MODE, when non-nil, can be either
3687 `first-section', `section', `planning', `item', `node-property'
3688 and `table-row'.
3690 If STRUCTURE isn't provided but MODE is set to `item', it will be
3691 computed.
3693 This function assumes point is always at the beginning of the
3694 element it has to parse."
3697 ;; Determine if parsing depth allows for secondary strings
3698 ;; parsing. It only applies to elements referenced in
3699 ;; `org-element-secondary-value-alist'.
3702 ;; Item.
3705 ;; Table Row.
3707 ;; Node Property.
3709 ;; Headline.
3712 ;; Sections (must be checked after headline).
3717 limit)))
3718 ;; Planning.
3721 ;; Property drawer.
3725 ;; When not at bol, point is at the beginning of an item or
3726 ;; a footnote definition: next item is always a paragraph.
3728 ;; Clock.
3730 ;; Inlinetask.
3733 ;; From there, elements can have affiliated keywords.
3736 ;; Jumping over affiliated keywords put point off-limits.
3737 ;; Parse them as regular keywords.
3741 ;; LaTeX Environment.
3744 ;; Drawer and Property Drawer.
3747 ;; Fixed Width
3750 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3751 ;; Keywords.
3769 limit
3770 affiliated))
3783 ;; Footnote Definition.
3786 ;; Horizontal Rule.
3789 ;; Diary Sexp.
3792 ;; Table.
3795 ;; List.
3798 limit affiliated
3800 ;; Default element: Paragraph.
3804 ;; Most elements can have affiliated keywords. When looking for an
3805 ;; element beginning, we want to move before them, as they belong to
3806 ;; that element, and, in the meantime, collect information they give
3807 ;; into appropriate properties. Hence the following function.
3810 "Collect affiliated keywords from point down to LIMIT.
3812 Return a list whose CAR is the position at the first of them and
3813 CDR a plist of keywords and values and move point to the
3814 beginning of the first line after them.
3816 As a special case, if element doesn't start at the beginning of
3817 the line (e.g., a paragraph starting an item), CAR is current
3818 position of point and CDR is nil."
3822 ;; RESTRICT is the list of objects allowed in parsed
3823 ;; keywords value.
3825 output)
3828 ;; Apply translation to RAW-KWD. From there, KWD is
3829 ;; the official keyword.
3831 org-element-keyword-translation-alist))
3832 raw-kwd))
3833 ;; Find main value for any keyword.
3839 ;; PARSEDP is non-nil when keyword should have its
3840 ;; value parsed.
3842 ;; If KWD is a dual keyword, find its secondary
3843 ;; value. Maybe parse it.
3852 ;; Attribute a property name to KWD.
3854 ;; Now set final shape for VALUE.
3860 nil restrict)))
3864 ;; Attributes can always appear on multiple lines.
3867 ;; Eventually store the new value in OUTPUT.
3869 ;; Move to next keyword.
3871 ;; If affiliated keywords are orphaned: move back to first one.
3872 ;; They will be parsed as a paragraph.
3874 ;; Return value.
3878 \f
3879 ;;; The Org Parser
3880 ;;
3881 ;; The two major functions here are `org-element-parse-buffer', which
3882 ;; parses Org syntax inside the current buffer, taking into account
3883 ;; region, narrowing, or even visibility if specified, and
3884 ;; `org-element-parse-secondary-string', which parses objects within
3885 ;; a given string.
3886 ;;
3887 ;; The (almost) almighty `org-element-map' allows to apply a function
3888 ;; on elements or objects matching some type, and accumulate the
3889 ;; resulting values. In an export situation, it also skips unneeded
3890 ;; parts of the parse tree.
3893 "Recursively parse the buffer and return structure.
3894 If narrowing is in effect, only parse the visible part of the
3895 buffer.
3897 Optional argument GRANULARITY determines the depth of the
3898 recursion. It can be set to the following symbols:
3900 `headline' Only parse headlines.
3901 `greater-element' Don't recurse into greater elements excepted
3902 headlines and sections. Thus, elements
3903 parsed are the top-level ones.
3904 `element' Parse everything but objects and plain text.
3905 `object' Parse the complete buffer (default).
3907 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3908 elements.
3910 An element or an objects is represented as a list with the
3911 pattern (TYPE PROPERTIES CONTENTS), where :
3913 TYPE is a symbol describing the element or object. See
3914 `org-element-all-elements' and `org-element-all-objects' for an
3915 exhaustive list of such symbols. One can retrieve it with
3916 `org-element-type' function.
3918 PROPERTIES is the list of attributes attached to the element or
3919 object, as a plist. Although most of them are specific to the
3920 element or object type, all types share `:begin', `:end',
3921 `:post-blank' and `:parent' properties, which respectively
3922 refer to buffer position where the element or object starts,
3923 ends, the number of white spaces or blank lines after it, and
3924 the element or object containing it. Properties values can be
3925 obtained by using `org-element-property' function.
3927 CONTENTS is a list of elements, objects or raw strings
3928 contained in the current element or object, when applicable.
3929 One can access them with `org-element-contents' function.
3931 The Org buffer has `org-data' as type and nil as properties.
3932 `org-element-map' function can be used to find specific elements
3933 or objects within the parse tree.
3935 This function assumes that current major mode is `org-mode'."
3941 ;; Start in `first-section' mode so text before the first
3942 ;; headline belongs to a section.
3946 "Recursively parse objects in STRING and return structure.
3948 RESTRICTION is a symbol limiting the object types that will be
3949 looked after.
3951 Optional argument PARENT, when non-nil, is the element or object
3952 containing the secondary string. It is used to set correctly
3953 `:parent' property within the string.
3955 If STRING is the empty string or nil, return nil."
3971 data))))))
3975 "Map a function on selected elements or objects.
3977 DATA is a parse tree, an element, an object, a string, or a list
3978 of such constructs. TYPES is a symbol or list of symbols of
3979 elements or objects types (see `org-element-all-elements' and
3980 `org-element-all-objects' for a complete list of types). FUN is
3981 the function called on the matching element or object. It has to
3982 accept one argument: the element or object itself.
3984 When optional argument INFO is non-nil, it should be a plist
3985 holding export options. In that case, parts of the parse tree
3986 not exportable according to that property list will be skipped.
3988 When optional argument FIRST-MATCH is non-nil, stop at the first
3989 match for which FUN doesn't return nil, and return that value.
3991 Optional argument NO-RECURSION is a symbol or a list of symbols
3992 representing elements or objects types. `org-element-map' won't
3993 enter any recursive element or object whose type belongs to that
3994 list. Though, FUN can still be applied on them.
3996 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3997 apply to matching objects within parsed affiliated keywords (see
3998 `org-element-parsed-keywords').
4000 Nil values returned from FUN do not appear in the results.
4003 Examples:
4004 ---------
4006 Assuming TREE is a variable containing an Org buffer parse tree,
4007 the following example will return a flat list of all `src-block'
4008 and `example-block' elements in it:
4012 The following snippet will find the first headline with a level
4016 (lambda (hl)
4017 (and (= (org-element-property :level hl) 1)
4019 (org-element-property :begin hl)))
4020 nil t)
4022 The next example will return a flat list of all `plain-list' type
4023 elements in TREE that are not a sub-list themselves:
4027 Eventually, this example will return a flat list of all `bold'
4028 type objects containing a `latex-snippet' type object, even
4029 looking into captions:
4032 (lambda (b)
4034 nil nil nil t)"
4035 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4039 ;; Recursion depth is determined by --CATEGORY.
4046 ;; If one object is found, the function has
4047 ;; to recurse into every object.
4050 ;; If one regular element is found, the
4051 ;; function has to recurse, at least, into
4052 ;; every element it encounters.
4055 --acc)
4058 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4059 ;; holding contextual information.
4063 ;; Ignored element in an export context.
4065 ;; List of elements or objects.
4067 ;; Unconditionally enter parse trees.
4071 ;; Check if TYPE is matching among TYPES. If so,
4072 ;; apply FUN to --DATA and accumulate return value
4073 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4079 ;; If --DATA has a secondary string that can contain
4080 ;; objects with their type among TYPES, look inside.
4083 org-element-secondary-value-alist)))
4085 ;; If --DATA has any parsed affiliated keywords and
4086 ;; WITH-AFFILIATED is non-nil, look for objects in
4087 ;; them.
4094 ;; Pay attention to the type of parsed
4095 ;; keyword. In particular, preserve order for
4096 ;; multiple keywords.
4109 ;; Determine if a recursion into --DATA is possible.
4111 ;; --TYPE is explicitly removed from recursion.
4113 ;; --DATA has no contents.
4115 ;; Looking for greater elements but --DATA is
4116 ;; simply an element or an object.
4119 ;; Looking for elements but --DATA is an object.
4122 ;; In any other case, map contents.
4126 ;; Return value in a proper order.
4130 ;; The following functions are internal parts of the parser.
4131 ;;
4132 ;; The first one, `org-element--parse-elements' acts at the element's
4133 ;; level.
4134 ;;
4135 ;; The second one, `org-element--parse-objects' applies on all objects
4136 ;; of a paragraph or a secondary string. It calls
4137 ;; `org-element--object-lex' to find the next object in the current
4138 ;; container.
4141 "Return next special mode according to TYPE, or nil.
4142 TYPE is a symbol representing the type of an element or object
4143 containing next element if PARENTP is non-nil, or before it
4144 otherwise. Modes can be either `first-section', `item',
4145 `node-property', `planning', `property-drawer', `section',
4146 `table-row' or nil."
4163 "Parse elements between BEG and END positions.
4165 MODE prioritizes some elements over the others. It can be set to
4166 `first-section', `section', `planning', `item', `node-property'
4167 or `table-row'.
4169 When value is `item', STRUCTURE will be used as the current list
4170 structure.
4172 GRANULARITY determines the depth of the recursion. See
4173 `org-element-parse-buffer' for more information.
4175 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4176 elements.
4178 Elements are accumulated into ACC."
4181 ;; Visible only: skip invisible parts at the beginning of the
4182 ;; element.
4185 ;; When parsing only headlines, skip any text before first one.
4188 ;; Main loop start.
4190 ;; Find current element's type and parse it accordingly to
4191 ;; its category.
4193 end granularity mode structure))
4197 ;; Visible only: skip invisible parts between siblings.
4200 ;; Fill ELEMENT contents by side-effect.
4202 ;; If element has no contents, don't modify it.
4204 ;; Greater element: parse it between `contents-begin' and
4205 ;; `contents-end'. Make sure GRANULARITY allows the
4206 ;; recursion, or ELEMENT is a headline, in which case going
4207 ;; inside is mandatory, in order to get sub-level headings.
4215 ;; Possibly switch to a special mode.
4219 granularity visible-only element))
4220 ;; ELEMENT has contents. Parse objects inside, if
4221 ;; GRANULARITY allows it.
4227 ;; Update mode.
4229 ;; Return result.
4230 acc))
4233 "Return next object in current buffer or nil.
4234 RESTRICTION is a list of object types, as symbols, that should be
4235 looked after. This function assumes that the buffer is narrowed
4236 to an appropriate container (e.g., a paragraph)."
4244 found)
4309 ;; This is probably a plain link.
4315 ;; Radio link.
4320 "Parse objects between BEG and END and return recursive structure.
4322 Objects are accumulated in ACC.
4324 RESTRICTION is a list of object successors which are allowed in
4325 the current object."
4333 ;; 1. Text before any object. Untabify it.
4338 acc
4342 ;; 2. Object...
4345 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4346 ;; a recursive type.
4354 ;; 3. Text after last object. Untabify it.
4358 acc
4362 ;; Result.
4363 acc)))
4366 \f
4367 ;;; Towards A Bijective Process
4368 ;;
4369 ;; The parse tree obtained with `org-element-parse-buffer' is really
4370 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4371 ;; interpreted and expanded into a string with canonical Org syntax.
4372 ;; Hence `org-element-interpret-data'.
4373 ;;
4374 ;; The function relies internally on
4375 ;; `org-element--interpret-affiliated-keywords'.
4377 ;;;###autoload
4379 "Interpret DATA as Org syntax.
4380 DATA is a parse tree, an element, an object or a secondary string
4381 to interpret. Return Org syntax as a string."
4385 ;; Find interpreter for current object or
4386 ;; element. If it doesn't exist (e.g. this is
4387 ;; a pseudo object or element), return contents,
4388 ;; if any.
4395 ;; Secondary string.
4399 ;; Full Org document.
4403 ;; Plain text: return it.
4405 ;; Element or object without contents.
4408 ;; Element or object with contents.
4411 interpret
4412 --data
4413 ;; Recursively interpret contents.
4418 --data
4419 ;; Fix indentation of elements containing
4420 ;; objects. We ignore `table-row'
4421 ;; elements as they are one line long
4422 ;; anyway.
4424 --data
4425 ;; When normalizing first paragraph of
4426 ;; an item or a footnote-definition,
4427 ;; ignore first line's indentation.
4435 ;; Build white spaces. If no `:post-blank' property
4436 ;; is specified, assume its value is 0.
4451 "Return ELEMENT's affiliated keywords as Org syntax.
4452 If there is no affiliated keyword, return the empty string."
4462 ": "
4465 value)
4473 ;; All attribute keywords can have multiple lines.
4479 ;; List all ELEMENT's properties matching an attribute line or an
4480 ;; affiliated keyword, but ignore translated keywords since they
4481 ;; cannot belong to the property list.
4488 org-element-keyword-translation-alist)))))
4489 collect prop)
4492 ;; Because interpretation of the parse tree must return the same
4493 ;; number of blank lines between elements and the same number of white
4494 ;; space after objects, some special care must be given to white
4495 ;; spaces.
4496 ;;
4497 ;; The first function, `org-element-normalize-string', ensures any
4498 ;; string different from the empty string will end with a single
4499 ;; newline character.
4500 ;;
4501 ;; The second function, `org-element-normalize-contents', removes
4502 ;; global indentation from the contents of the current element.
4505 "Ensure string S ends with a single newline character.
4507 If S isn't a string return it unchanged. If S is the empty
4508 string, return it. Otherwise, return a new string with a single
4509 newline character at its end."
4517 "Normalize plain text in ELEMENT's contents.
4519 ELEMENT must only contain plain text and objects.
4521 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4522 indentation to compute maximal common indentation.
4524 Return the normalized element that is element with global
4525 indentation removed from its contents. The function assumes that
4526 indentation is not done with TAB characters."
4528 ;; Return minimal common indentation within BLOB. This is
4529 ;; done by walking recursively BLOB and updating MIN-IND
4530 ;; along the way. FIRST-FLAG is non-nil when the next
4531 ;; object is expected to be a string that doesn't start
4532 ;; with a newline character. It happens for strings at
4533 ;; the beginnings of the contents or right after a line
4534 ;; break.
4540 ;; Objects cannot start with spaces: in this case,
4541 ;; indentation is 0.
4545 ;; An indentation of zero means no string will
4546 ;; be modified. Quit the process.
4558 org-element-recursive-objects)
4561 object first-flag min-ind))))))))
4565 ;; Build ELEMENT back, replacing each string with the same
4566 ;; string minus common indentation.
4569 ;; Return DATUM with all its strings indentation
4570 ;; shortened from MIN-IND white spaces.
4571 ;; FIRST-FLAG is non-nil when the next object is
4572 ;; expected to be a string that doesn't start with
4573 ;; a newline character.
4589 org-element-recursive-objects)
4593 object)
4596 datum)))
4600 \f
4601 ;;; Cache
4602 ;;
4603 ;; Implement a caching mechanism for `org-element-at-point' and
4604 ;; `org-element-context', which see.
4605 ;;
4606 ;; A single public function is provided: `org-element-cache-reset'.
4607 ;;
4608 ;; Cache is enabled by default, but can be disabled globally with
4609 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4610 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4611 ;; can be tweaked to control caching behaviour.
4612 ;;
4613 ;; Internally, parsed elements are stored in an AVL tree,
4614 ;; `org-element--cache'. This tree is updated lazily: whenever
4615 ;; a change happens to the buffer, a synchronization request is
4616 ;; registered in `org-element--cache-sync-requests' (see
4617 ;; `org-element--cache-submit-request'). During idle time, requests
4618 ;; are processed by `org-element--cache-sync'. Synchronization also
4619 ;; happens when an element is required from the cache. In this case,
4620 ;; the process stops as soon as the needed element is up-to-date.
4621 ;;
4622 ;; A synchronization request can only apply on a synchronized part of
4623 ;; the cache. Therefore, the cache is updated at least to the
4624 ;; location where the new request applies. Thus, requests are ordered
4625 ;; from left to right and all elements starting before the first
4626 ;; request are correct. This property is used by functions like
4627 ;; `org-element--cache-find' to retrieve elements in the part of the
4628 ;; cache that can be trusted.
4629 ;;
4630 ;; A request applies to every element, starting from its original
4631 ;; location (or key, see below). When a request is processed, it
4632 ;; moves forward and may collide the next one. In this case, both
4633 ;; requests are merged into a new one that starts from that element.
4634 ;; As a consequence, the whole synchronization complexity does not
4635 ;; depend on the number of pending requests, but on the number of
4636 ;; elements the very first request will be applied on.
4637 ;;
4638 ;; Elements cannot be accessed through their beginning position, which
4639 ;; may or may not be up-to-date. Instead, each element in the tree is
4640 ;; associated to a key, obtained with `org-element--cache-key'. This
4641 ;; mechanism is robust enough to preserve total order among elements
4642 ;; even when the tree is only partially synchronized.
4643 ;;
4644 ;; Objects contained in an element are stored in a hash table,
4645 ;; `org-element--cache-objects'.
4649 "Non nil when Org parser should cache its results.
4656 "Maximum duration, as a time value, for a cache synchronization.
4657 If the synchronization is not over after this delay, the process
4658 pauses and resumes after `org-element-cache-sync-break'
4662 "Duration, as a time value, of the pause between synchronizations.
4666 ;;;; Data Structure
4669 "AVL tree used to cache elements.
4670 Each node of the tree contains an element. Comparison is done
4671 with `org-element--cache-compare'. This cache is used in
4675 "Hash table used as to cache objects.
4676 Key is an element, as returned by `org-element-at-point', and
4677 value is an alist where each association is:
4679 \(PARENT COMPLETEP . OBJECTS)
4681 where PARENT is an element or object, COMPLETEP is a boolean,
4682 non-nil when all direct children of parent are already cached and
4683 OBJECTS is a list of such children, as objects, from farthest to
4684 closest.
4687 contained within a paragraph
4691 If the paragraph is completely parsed, OBJECTS-DATA will be
4693 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4694 \(BOLD-OBJECT t ENTITY-OBJECT))
4696 whereas in a partially parsed paragraph, it could be
4698 \((PARAGRAPH nil ENTITY-OBJECT))
4703 "List of pending synchronization requests.
4705 A request is a vector with the following pattern:
4707 \[NEXT BEG END OFFSET PARENT PHASE]
4709 Processing a synchronization request consists of three phases:
4711 0. Delete modified elements,
4712 1. Fill missing area in cache,
4713 2. Shift positions and re-parent elements after the changes.
4715 During phase 0, NEXT is the key of the first element to be
4716 removed, BEG and END is buffer position delimiting the
4717 modifications. Elements starting between them (inclusive) are
4718 removed. So are elements whose parent is removed. PARENT, when
4719 non-nil, is the parent of the first element to be removed.
4721 During phase 1, NEXT is the key of the next known element in
4722 cache and BEG its beginning position. Parse buffer between that
4723 element and the one before it in order to determine the parent of
4724 the next element. Set PARENT to the element containing NEXT.
4726 During phase 2, NEXT is the key of the next element to shift in
4727 the parse tree. All elements starting from this one have their
4728 properties relatives to buffer positions shifted by integer
4729 OFFSET and, if they belong to element PARENT, are adopted by it.
4737 "Hash table used to store keys during synchronization.
4741 "Return a unique key for ELEMENT in cache tree.
4743 Keys are used to keep a total order among elements in the cache.
4744 Comparison is done with `org-element--cache-key-less-p'.
4746 When no synchronization is taking place, a key is simply the
4747 beginning position of the element, or that position plus one in
4748 the case of an first item (respectively row) in
4749 a list (respectively a table).
4751 During a synchronization, the key is the one the element had when
4752 the cache was synchronized for the last time. Elements added to
4753 cache during the synchronization get a new key generated with
4754 `org-element--cache-generate-key'.
4756 Such keys are stored in `org-element--cache-sync-keys'. The hash
4757 table is cleared once the synchronization is complete."
4760 ;; Increase beginning position of items (respectively
4761 ;; table rows) by one, so the first item can get
4762 ;; a different key from its parent list (respectively
4763 ;; table).
4766 begin)))
4769 key))))
4772 "Generate a key between LOWER and UPPER.
4774 LOWER and UPPER are integers or lists, possibly empty.
4776 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4777 a unique key, as an integer or a list of integers, according to
4778 the following rules:
4780 - LOWER and UPPER are compared level-wise until values differ.
4782 - If, at a given level, LOWER and UPPER differ from more than
4783 2, the new key shares all the levels above with LOWER and
4784 gets a new level. Its value is the mean between LOWER and
4785 UPPER:
4787 \(1 2) + (1 4) --> (1 3)
4789 - If LOWER has no value to compare with, it is assumed that its
4790 value is `most-negative-fixnum'. E.g.,
4792 \(1 1) + (1 1 2)
4794 is equivalent to
4796 \(1 1 m) + (1 1 2)
4798 where m is `most-negative-fixnum'. Likewise, if UPPER is
4799 short of levels, the current value is `most-positive-fixnum'.
4801 - If they differ from only one, the new key inherits from
4802 current LOWER level and fork it at the next level. E.g.,
4804 \(2 1) + (3 3)
4806 is equivalent to
4808 \(2 1) + (2 M)
4810 where M is `most-positive-fixnum'.
4812 - If the key is only one level long, it is returned as an
4813 integer:
4815 \(1 2) + (3 2) --> 2
4817 When they are not equals, the function assumes that LOWER is
4818 lesser than UPPER, per `org-element--cache-key-less-p'."
4822 skip-upper key)
4833 ;; When at a given level, LOWER and UPPER differ from
4834 ;; 1, ignore UPPER altogether. Instead create a key
4835 ;; between LOWER and the greatest key with the same
4836 ;; prefix as LOWER so far.
4842 "Non-nil if key A is less than key B.
4843 A and B are either integers or lists of integers, as returned by
4844 `org-element--cache-key'."
4852 ;; If A is empty, either keys are equal (B is also empty) and
4853 ;; we return nil, or A is lesser than B (B is longer) and we
4854 ;; return a non-nil value.
4855 ;;
4856 ;; If A is not empty, B is necessarily empty and A is greater
4857 ;; than B (A is longer). Therefore, return nil.
4861 "Non-nil when element A is located before element B."
4866 "Return root value in cache.
4867 This function assumes `org-element--cache' is a valid AVL tree."
4871 ;;;; Tools
4874 "Non-nil when cache is active in current buffer."
4876 org-element--cache
4880 "Find element in cache starting at POS or before.
4882 POS refers to a buffer position.
4884 When optional argument SIDE is non-nil, the function checks for
4885 elements starting at or past POS instead. If SIDE is `both', the
4886 function returns a cons cell where car is the first element
4887 starting at or before POS and cdr the first element starting
4888 after POS.
4890 The function can only find elements in the synchronized part of
4891 the cache."
4895 lower upper)
4910 ;; We found an element in cache starting at POS. If `side'
4911 ;; is `both' we also want the next one in order to generate
4912 ;; a key in-between.
4913 ;;
4914 ;; If the element is the first row or item in a table or
4915 ;; a plain list, we always return the table or the plain
4916 ;; list.
4917 ;;
4918 ;; In any other case, we return the element found.
4927 lower parent
4928 upper parent)))))
4931 lower element
4932 upper element)))))
4939 "Store ELEMENT in current buffer's cache, if allowed.
4940 When optional argument DATA is non-nil, assume is it object data
4941 relative to ELEMENT and store it in the objects cache."
4945 ;; During synchronization, first build an appropriate key
4946 ;; for the new element so `avl-tree-enter' can insert it at
4947 ;; the right spot in the cache.
4956 org-element--cache-sync-keys)))
4958 ;; Headlines are not stored in cache, so objects in titles are
4959 ;; not stored either.
4964 "Remove ELEMENT from cache.
4965 Assume ELEMENT belongs to cache and that a cache is active."
4970 ;;;; Synchronization
4973 "Set idle timer for cache synchronization in BUFFER."
4980 org-element-cache-sync-idle-time))
4981 nil
4982 #'org-element--cache-sync
4983 buffer)))
4986 "Non-nil when synchronization process should be interrupted.
4987 TIME-LIMIT is a time value or nil."
4993 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4995 Properties containing buffer positions are `:begin', `:end',
4996 `:contents-begin', `:contents-end' and `:structure'. When
4997 optional argument PROPS is a list of keywords, only shift
4998 properties provided in that list.
5000 Properties are modified by side-effect."
5002 ;; Shift `:structure' property for the first plain list only: it
5003 ;; is the only one that really matters and it prevents from
5004 ;; shifting it more than once.
5018 "Synchronize cache with recent modification in BUFFER.
5020 When optional argument THRESHOLD is non-nil, do the
5021 synchronization for all elements starting before or at threshold,
5022 then exit. Otherwise, synchronize cache for as long as
5023 `org-element-cache-sync-duration' or until Emacs leaves idle
5024 state.
5026 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5027 not registered yet in the cache are going to happen. It is used
5028 in `org-element--cache-submit-request', where cache is partially
5029 updated before current modification are actually submitted."
5040 request
5042 threshold
5045 org-element-cache-sync-duration))
5046 future-change)
5047 ;; Request processed. Merge current and next offsets and
5048 ;; transfer ending position.
5054 ;; If more requests are awaiting, set idle timer accordingly.
5055 ;; Otherwise, reset keys.
5062 "Process synchronization REQUEST for all entries before NEXT.
5064 REQUEST is a vector, built by `org-element--cache-submit-request'.
5066 NEXT is a cache key, as returned by `org-element--cache-key'.
5068 When non-nil, THRESHOLD is a buffer position. Synchronization
5069 stops as soon as a shifted element begins after it.
5071 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5072 after this time or when Emacs exits idle state.
5074 When non-nil, FUTURE-CHANGE is a buffer position where changes
5075 not registered yet in the cache are going to happen. See
5076 `org-element--cache-submit-request' for more information.
5078 Throw `interrupt' if the process stops before completing the
5079 request."
5082 ;; Phase 0.
5083 ;;
5084 ;; Delete all elements starting after BEG, but not after buffer
5085 ;; position END or past element with key NEXT. Also delete
5086 ;; elements contained within a previously removed element
5087 ;; (stored in `last-container').
5088 ;;
5089 ;; At each iteration, we start again at tree root since
5090 ;; a deletion modifies structure of the balanced tree.
5095 ;; Find first element in cache with key BEG or after it.
5099 data data-key last-container)
5108 data-key key
5111 data-key key
5112 node nil)))))
5122 up)))
5125 end))
5132 ;; No element starting after modifications left in
5133 ;; cache: further processing is futile.
5136 ;; Phase 1.
5137 ;;
5138 ;; Phase 0 left a hole in the cache. Some elements after it
5139 ;; could have parents within. For example, in the following
5140 ;; buffer:
5141 ;;
5142 ;; - item
5143 ;;
5144 ;;
5145 ;; Paragraph1
5146 ;;
5147 ;; Paragraph2
5148 ;;
5149 ;; if we remove a blank line between "item" and "Paragraph1",
5150 ;; everything down to "Paragraph2" is removed from cache. But
5151 ;; the paragraph now belongs to the list, and its `:parent'
5152 ;; property no longer is accurate.
5153 ;;
5154 ;; Therefore we need to parse again elements in the hole, or at
5155 ;; least in its last section, so that we can re-parent
5156 ;; subsequent elements, during phase 2.
5157 ;;
5158 ;; Note that we only need to get the parent from the first
5159 ;; element in cache after the hole.
5160 ;;
5161 ;; When next key is lesser or equal to the current one, delegate
5162 ;; phase 1 processing to next request in order to preserve key
5163 ;; order among requests.
5171 ;; Next element will start at its beginning position plus
5172 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5173 ;; contains the real beginning position of the first element to
5174 ;; shift and re-parent.
5178 ;; Changes are going to happen around this element and
5179 ;; they will trigger another phase 1 request. Skip the
5180 ;; current one.
5186 ;; Phase 2.
5187 ;;
5188 ;; Shift all elements starting from key START, but before NEXT, by
5189 ;; OFFSET, and re-parent them when appropriate.
5190 ;;
5191 ;; Elements are modified by side-effect so the tree structure
5192 ;; remains intact.
5193 ;;
5194 ;; Once THRESHOLD, if any, is reached, or once there is an input
5195 ;; pending, exit. Before leaving, the current synchronization
5196 ;; request is updated.
5203 exit-flag)
5204 ;; No re-parenting nor shifting planned: request is over.
5214 ;; We reached NEXT. Request is complete.
5216 ;; Handle interruption request. Update current request.
5221 ;; Shift element.
5224 ;; Shift associated objects data, if any.
5229 ;; Update PARENT and re-parent DATA, only when
5230 ;; necessary. Propagate new structures for lists.
5244 ;; Cache is up-to-date past THRESHOLD. Request
5245 ;; interruption.
5250 ;; We reached end of tree: synchronization complete.
5251 t)))
5254 "Parse elements in current section, down to POS.
5256 Start parsing from the closest between the last known element in
5257 cache or headline above. Return the smallest element containing
5258 POS.
5260 When optional argument SYNCP is non-nil, return the parent of the
5261 element containing POS instead. In that case, it is also
5262 possible to provide TIME-LIMIT, which is a time value specifying
5263 when the parsing should stop. The function throws `interrupt' if
5264 the process stopped before finding the expected result."
5271 element next mode)
5273 ;; Nothing in cache before point: start parsing from first
5274 ;; element following headline above, or first element in
5275 ;; buffer.
5282 ;; Cache returned exact match: return it.
5285 ;; There's a headline between cached value and POS: cached
5286 ;; value is invalid. Start parsing from first element
5287 ;; following the headline.
5294 ;; Check if CACHED or any of its ancestors contain point.
5295 ;;
5296 ;; If there is such an element, we inspect it in order to know
5297 ;; if we return it or if we need to parse its contents.
5298 ;; Otherwise, we just start parsing from current location,
5299 ;; which is right after the top-most element containing
5300 ;; CACHED.
5301 ;;
5302 ;; As a special case, if POS is at the end of the buffer, we
5303 ;; want to return the innermost element ending there.
5304 ;;
5305 ;; Also, if we find an ancestor and discover that we need to
5306 ;; parse its contents, make sure we don't start from
5307 ;; `:contents-begin', as we would otherwise go past CACHED
5308 ;; again. Instead, in that situation, we will resume parsing
5309 ;; from NEXT, which is located after CACHED or its higher
5310 ;; ancestor not containing point.
5322 ;; Parse successively each element until we reach POS.
5335 end 'element mode
5342 ;; Skip any element ending before point. Also skip
5343 ;; element ending at point (unless it is also the end of
5344 ;; buffer) since we're sure that another element begins
5345 ;; after it.
5349 ;; A non-greater element contains point: return it.
5352 ;; Otherwise, we have to decide if ELEMENT really
5353 ;; contains POS. In that case we start parsing from
5354 ;; contents' beginning.
5355 ;;
5356 ;; If POS is at contents' beginning but it is also at
5357 ;; the beginning of the first item in a list or a table.
5358 ;; In that case, we need to create an anchor for that
5359 ;; list or table, so return it.
5360 ;;
5361 ;; Also, if POS is at the end of the buffer, no element
5362 ;; can start after it, but more than one may end there.
5363 ;; Arbitrarily, we choose to return the innermost of
5364 ;; such elements.
5377 parent element
5378 end cend))))
5379 ;; Otherwise, return ELEMENT as it is the smallest
5380 ;; element containing POS.
5385 ;;;; Staging Buffer Changes
5396 "Regexp matching a sensitive line, structure wise.
5397 A sensitive line is a headline, inlinetask, block, drawer, or
5398 latex-environment boundary. When such a line is modified,
5399 structure changes in the document may propagate in the whole
5403 "Non-nil when a sensitive line is about to be changed.
5407 "Request extension of area going to be modified if needed.
5408 BEG and END are the beginning and end of the range of changed
5409 text. See `before-change-functions' for more information."
5419 'headline
5422 org-element--cache-sensitive-re bottom t)))))))))
5425 "Update buffer modifications for current buffer.
5426 BEG and END are the beginning and end of the range of changed
5427 text, and the length in bytes of the pre-change text replaced by
5428 that range. See `after-change-functions' for more information."
5436 ;; Determine if modified area needs to be extended, according
5437 ;; to both previous and current state. We make a special
5438 ;; case for headline editing: if a headline is modified but
5439 ;; not removed, do not extend.
5442 (`headline
5448 org-element--cache-sensitive-re bottom t))))
5449 ;; Effectively extend modified area.
5457 ;; Store synchronization request.
5460 ;; Activate a timer to process the request during idle time.
5464 "Return first element to remove from cache.
5466 BEG and END are buffer positions delimiting buffer modifications.
5467 OFFSET is the size of the changes.
5469 Returned element is usually the first element in cache containing
5470 any position between BEG and END. As an exception, greater
5471 elements around the changes that are robust to contents
5472 modifications are preserved and updated according to the
5473 changes."
5483 special-block))
5484 ;; Drawers named "PROPERTIES" are probably
5485 ;; a properties drawer being edited. Force
5486 ;; parsing to check if editing is over.
5495 ;; UP is a robust greater element containing changes.
5496 ;; We only need to extend its ending boundaries.
5502 ;; We're at top level element containing ELEMENT: if it's
5503 ;; altered by buffer modifications, it is first element in
5504 ;; cache to be removed. Otherwise, that first element is the
5505 ;; following one.
5506 ;;
5507 ;; As a special case, do not remove BEFORE if it is a robust
5508 ;; container for current changes.
5510 before)))))
5513 "Submit a new cache synchronization request for current buffer.
5514 BEG and END are buffer positions delimiting the minimal area
5515 where cache data should be removed. OFFSET is the size of the
5516 change, as an integer."
5518 delete-to delete-from)
5523 ;; Current changes can be merged with first sync request: we
5524 ;; can save a partial cache synchronization.
5527 ;; If last change happened within area to be removed, extend
5528 ;; boundaries of robust parents, if any. Otherwise, find
5529 ;; first element to remove and update request accordingly.
5541 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5542 ;; if any, is no longer a 0-phase request, thus ensuring that
5543 ;; phases are properly ordered. We need to provide OFFSET as
5544 ;; optional parameter since current modifications are not known
5545 ;; yet to the otherwise correct part of the cache (i.e, before
5546 ;; the first request).
5553 ;; When changes happen before the first known
5554 ;; element, re-parent and shift the rest of the
5555 ;; cache.
5557 ;; Otherwise, we find the first non robust
5558 ;; element containing END. All elements between
5559 ;; FIRST and this one are to be removed.
5570 element up))
5572 org-element--cache-sync-requests)
5573 ;; No element to remove. No need to re-parent either.
5574 ;; Simply shift additional elements, if any, by OFFSET.
5579 ;;;; Public Functions
5581 ;;;###autoload
5583 "Reset cache in current buffer.
5584 When optional argument ALL is non-nil, reset cache in all Org
5585 buffers."
5604 ;;;###autoload
5606 "Refresh cache at position POS."
5613 \f
5614 ;;; The Toolbox
5615 ;;
5616 ;; The first move is to implement a way to obtain the smallest element
5617 ;; containing point. This is the job of `org-element-at-point'. It
5618 ;; basically jumps back to the beginning of section containing point
5619 ;; and proceed, one element after the other, with
5620 ;; `org-element--current-element' until the container is found. Note:
5621 ;; When using `org-element-at-point', secondary values are never
5622 ;; parsed since the function focuses on elements, not on objects.
5623 ;;
5624 ;; At a deeper level, `org-element-context' lists all elements and
5625 ;; objects containing point.
5626 ;;
5627 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5628 ;; internally by navigation and manipulation tools.
5631 ;;;###autoload
5633 "Determine closest element around point.
5635 Return value is a list like (TYPE PROPS) where TYPE is the type
5636 of the element and PROPS a plist of properties associated to the
5637 element.
5639 Possible types are defined in `org-element-all-elements'.
5640 Properties depend on element or object type, but always include
5641 `:begin', `:end', `:parent' and `:post-blank' properties.
5643 As a special case, if point is at the very beginning of the first
5644 item in a list or sub-list, returned element will be that list
5645 instead of the item. Likewise, if point is at the beginning of
5646 the first row of a table, returned element will be the table
5647 instead of the first row.
5649 When point is at the end of the buffer, return the innermost
5650 element ending there."
5656 ;; Within blank lines at the beginning of buffer, return nil.
5658 ;; Within blank lines right after a headline, return that
5659 ;; headline.
5663 ;; Otherwise parse until we find element containing ORIGIN.
5670 ;;;###autoload
5672 "Return smallest element or object around point.
5674 Return value is a list like (TYPE PROPS) where TYPE is the type
5675 of the element or object and PROPS a plist of properties
5676 associated to it.
5678 Possible types are defined in `org-element-all-elements' and
5679 `org-element-all-objects'. Properties depend on element or
5680 object type, but always include `:begin', `:end', `:parent' and
5681 `:post-blank'.
5683 As a special case, if point is right after an object and not at
5684 the beginning of any other object, return that object.
5686 Optional argument ELEMENT, when non-nil, is the closest element
5687 containing point, as returned by `org-element-at-point'.
5688 Providing it allows for quicker computation."
5694 ;; If point is inside an element containing objects or
5695 ;; a secondary string, narrow buffer to the container and
5696 ;; proceed with parsing. Otherwise, return ELEMENT.
5698 ;; At a parsed affiliated keyword, check if we're inside main
5699 ;; or dual value.
5706 org-element-parsed-keywords))
5715 ;; Also change type to retrieve correct restrictions.
5717 ;; At an item, objects can only be located within tag, if any.
5727 ;; At an headline or inlinetask, objects are in title.
5734 ;; At a paragraph, a table-row or a verse block, objects are
5735 ;; located within their contents.
5739 ;; CBEG is nil for table rules.
5744 ;; At a planning line, if point is at a timestamp, return it,
5745 ;; otherwise, return element.
5753 ;; All other locations cannot contain objects: bail out.
5763 next object-data last)
5767 ;; When entering PARENT for the first time, get list
5768 ;; of objects within known so far. Store it in
5769 ;; OBJECT-DATA.
5774 ;; Find NEXT object for analysis.
5776 ;; If NEXT is non-nil, we already exhausted the
5777 ;; cache so we can parse buffer to find the object
5778 ;; after it.
5780 ;; Otherwise, check if cache can help us.
5791 ;; Cache contains the information needed.
5794 pos)
5796 pos)
5802 ;; If we have a new object to analyze, store it in
5803 ;; cache. Otherwise record that there is nothing
5804 ;; more to parse in this element at this depth.
5809 ;; Process NEXT, if any, in order to know if we need
5810 ;; to skip it, return it or move into it.
5817 ;; Skip objects ending before point. Also skip
5818 ;; objects ending at point unless it is also the
5819 ;; end of buffer, since we want to return the
5820 ;; innermost object.
5823 ;; For convenience, when object ends at POS,
5824 ;; without any space, store it in LAST, as we
5825 ;; will return it if no object starts here.
5829 ;; If POS is within a container object, move
5830 ;; into that object.
5834 ;; At contents' end, if there is no
5835 ;; space before point, also move into
5836 ;; object, for consistency with
5837 ;; convenience feature above.
5846 next nil
5847 object-data nil))
5848 ;; Otherwise, return NEXT.
5850 ;; Store results in cache, if applicable.
5854 "List all ancestors of a given element or object.
5856 BLOB is an object or element.
5858 When optional argument TYPES is a list of symbols, return the
5859 first element or object in the lineage whose type belongs to that
5860 list.
5862 When optional argument WITH-SELF is non-nil, lineage includes
5863 BLOB itself as the first element, and TYPES, if provided, also
5864 apply to it.
5866 When BLOB is obtained through `org-element-context' or
5867 `org-element-at-point', only ancestors from its section can be
5868 found. There is no such limitation when BLOB belongs to a full
5869 parse tree."
5871 ancestors)
5878 "Non-nil when elements ELEM-A and ELEM-B are nested."
5887 "Swap elements ELEM-A and ELEM-B.
5888 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5889 end of ELEM-A."
5891 ;; There are two special cases when an element doesn't start at bol:
5892 ;; the first paragraph in an item or in a footnote definition.
5894 ;; Only a paragraph without any affiliated keyword can be moved at
5895 ;; ELEM-A position in such a situation. Note that the case of
5896 ;; a footnote definition is impossible: it cannot contain two
5897 ;; paragraphs in a row because it cannot contain a blank line.
5903 ;; In a special situation, ELEM-A will have no indentation. We'll
5904 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5918 ;; Store inner overlays responsible for visibility status.
5919 ;; We also need to store their boundaries as they will be
5920 ;; removed from buffer.
5935 ;; Get contents.
5943 ;; Restore ex ELEM-A overlays.
5950 ;; Restore ex ELEM-B overlays.
5955 ;; For backward-compatibility with Org <= 8.3
5962 ;; Local variables:
5963 ;; generated-autoload-file: "org-loaddefs.el"
5964 ;; End:
5966 ;;; org-element.el ends here