| blob | 368da607fe35a16100efd368bddef8fbb6ebff51 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 \f
426 ;;; Accessors and Setters
427 ;;
428 ;; Provide four accessors: `org-element-type', `org-element-property'
429 ;; `org-element-contents' and `org-element-restriction'.
430 ;;
431 ;; Setter functions allow modification of elements by side effect.
432 ;; There is `org-element-put-property', `org-element-set-contents'.
433 ;; These low-level functions are useful to build a parse tree.
434 ;;
435 ;; `org-element-adopt-element', `org-element-set-element',
436 ;; `org-element-extract-element' and `org-element-insert-before' are
437 ;; high-level functions useful to modify a parse tree.
438 ;;
439 ;; `org-element-secondary-p' is a predicate used to know if a given
440 ;; object belongs to a secondary string. `org-element-copy' returns
441 ;; an element or object, stripping its parent property in the process.
444 "Return type of ELEMENT.
446 The function returns the type of the element or object provided.
447 It can also return the following special value:
448 `plain-text' for a string
449 `org-data' for a complete document
450 nil in any other case."
456 "Extract the value from the PROPERTY of an ELEMENT."
461 "Extract contents from an ELEMENT."
467 "Return restriction associated to ELEMENT.
468 ELEMENT can be an element, an object or a symbol representing an
469 element or object type."
471 org-element-object-restrictions)))
474 "In ELEMENT set PROPERTY to VALUE.
475 Return modified element."
478 element))
481 "Set ELEMENT's contents to CONTENTS.
482 Return ELEMENT."
489 "Non-nil when OBJECT directly belongs to a secondary string.
490 Return value is the property name, as a keyword, or nil."
493 org-element-secondary-value-alist))))
500 "Append elements to the contents of another element.
502 PARENT is an element or object. CHILDREN can be elements,
503 objects, or a strings.
505 The function takes care of setting `:parent' property for CHILD.
506 Return parent element."
508 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
509 ;; string: parent is the list itself.
512 ;; Add CHILDREN at the end of PARENT contents.
515 parent
517 ;; Return modified PARENT element.
521 "Extract ELEMENT from parse tree.
522 Remove element from the parse tree by side-effect, and return it
523 with its `:parent' property stripped out."
528 parent secondary
531 parent
533 ;; Return ELEMENT with its :parent removed.
537 "Insert ELEMENT before LOCATION in parse tree.
538 LOCATION is an element, object or string within the parse tree.
539 Parse tree is modified by side effect."
544 ;; Special case: LOCATION is the first element of an
545 ;; independent secondary string (e.g. :title property). Add
546 ;; ELEMENT in-place.
550 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
560 ;; Store SIBLINGS at appropriate place in parse tree.
565 ;; Set appropriate :parent property.
569 "Replace element or object OLD with element or object NEW.
570 The function takes care of setting `:parent' property for NEW."
571 ;; Ensure OLD and NEW have the same parent.
575 ;; We cannot replace OLD with NEW since one of them is not an
576 ;; object or element. We take the long path.
579 ;; Since OLD is going to be changed into NEW by side-effect, first
580 ;; make sure that every element or object within NEW has OLD as
581 ;; parent.
584 ;; Transfer contents.
586 ;; Overwrite OLD's properties with NEW's.
588 ;; Transfer type.
592 "Create a new element of type TYPE.
593 Optional argument PROPS, when non-nil, is a plist defining the
594 properties of the element. CHILDREN can be elements, objects or
595 strings."
599 "Return a copy of DATUM.
600 DATUM is an element, object, string or nil. `:parent' property
601 is cleared and contents are removed in the process."
612 \f
613 ;;; Greater elements
614 ;;
615 ;; For each greater element type, we define a parser and an
616 ;; interpreter.
617 ;;
618 ;; A parser returns the element or object as the list described above.
619 ;; Most of them accepts no argument. Though, exceptions exist. Hence
620 ;; every element containing a secondary string (see
621 ;; `org-element-secondary-value-alist') will accept an optional
622 ;; argument to toggle parsing of these secondary strings. Moreover,
623 ;; `item' parser requires current list's structure as its first
624 ;; element.
625 ;;
626 ;; An interpreter accepts two arguments: the list representation of
627 ;; the element or object, and its contents. The latter may be nil,
628 ;; depending on the element or object considered. It returns the
629 ;; appropriate Org syntax, as a string.
630 ;;
631 ;; Parsing functions must follow the naming convention:
632 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
633 ;; defined in `org-element-greater-elements'.
634 ;;
635 ;; Similarly, interpreting functions must follow the naming
636 ;; convention: org-element-TYPE-interpreter.
637 ;;
638 ;; With the exception of `headline' and `item' types, greater elements
639 ;; cannot contain other greater elements of their own type.
640 ;;
641 ;; Beside implementing a parser and an interpreter, adding a new
642 ;; greater element requires tweaking `org-element--current-element'.
643 ;; Moreover, the newly defined type must be added to both
644 ;; `org-element-all-elements' and `org-element-greater-elements'.
647 ;;;; Center Block
650 "Parse a center block.
652 LIMIT bounds the search. AFFILIATED is a list of which CAR is
653 the buffer position at the beginning of the first affiliated
654 keyword and CDR is a plist of affiliated keywords along with
655 their value.
657 Return a list whose CAR is `center-block' and CDR is a plist
658 containing `:begin', `:end', `:contents-begin', `:contents-end',
659 `:post-blank' and `:post-affiliated' keywords.
661 Assume point is at the beginning of the block."
665 ;; Incomplete block: parse it as a paragraph.
670 ;; Empty blocks have no contents.
684 :end end
685 :contents-begin contents-begin
686 :contents-end contents-end
692 "Interpret a center-block element as Org syntax.
693 CONTENTS is the contents of the element."
697 ;;;; Drawer
700 "Parse a drawer.
702 LIMIT bounds the search. AFFILIATED is a list of which CAR is
703 the buffer position at the beginning of the first affiliated
704 keyword and CDR is a plist of affiliated keywords along with
705 their value.
707 Return a list whose CAR is `drawer' and CDR is a plist containing
708 `:drawer-name', `:begin', `:end', `:contents-begin',
709 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
711 Assume point is at beginning of drawer."
714 ;; Incomplete drawer: parse it as a paragraph.
722 ;; Empty drawers have no contents.
735 :end end
736 :drawer-name name
737 :contents-begin contents-begin
738 :contents-end contents-end
744 "Interpret DRAWER element as Org syntax.
745 CONTENTS is the contents of the element."
748 contents))
751 ;;;; Dynamic Block
754 "Parse a dynamic block.
756 LIMIT bounds the search. AFFILIATED is a list of which CAR is
757 the buffer position at the beginning of the first affiliated
758 keyword and CDR is a plist of affiliated keywords along with
759 their value.
761 Return a list whose CAR is `dynamic-block' and CDR is a plist
762 containing `:block-name', `:begin', `:end', `:contents-begin',
763 `:contents-end', `:arguments', `:post-blank' and
764 `:post-affiliated' keywords.
766 Assume point is at beginning of dynamic block."
770 ;; Incomplete block: parse it as a paragraph.
779 ;; Empty blocks have no contents.
792 :end end
793 :block-name name
794 :arguments arguments
795 :contents-begin contents-begin
796 :contents-end contents-end
802 "Interpret DYNAMIC-BLOCK element as Org syntax.
803 CONTENTS is the contents of the element."
808 contents))
811 ;;;; Footnote Definition
820 "Parse a footnote definition.
822 LIMIT bounds the search. AFFILIATED is a list of which CAR is
823 the buffer position at the beginning of the first affiliated
824 keyword and CDR is a plist of affiliated keywords along with
825 their value.
827 Return a list whose CAR is `footnote-definition' and CDR is
828 a plist containing `:label', `:begin' `:end', `:contents-begin',
829 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
831 Assume point is at the beginning of the footnote definition."
843 limit)
845 ;; At a new footnote definition, make sure we end
846 ;; before any affiliated keyword above.
867 :begin begin
868 :end end
869 :contents-begin contents-begin
870 :contents-end contents-end
876 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
877 CONTENTS is the contents of the footnote-definition."
879 " "
880 contents))
883 ;;;; Headline
886 "Return node properties associated to headline at point.
887 Upcase property names. It avoids confusion between properties
888 obtained through property drawer and default properties from the
889 parser (e.g. `:end' and :END:). Return value is a plist."
901 properties))))
904 "Return time properties associated to headline at point.
905 Return value is a plist."
919 plist))))
922 "Parse a headline.
924 Return a list whose CAR is `headline' and CDR is a plist
925 containing `:raw-value', `:title', `:begin', `:end',
926 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
927 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
928 `:deadline', `:closed', `:archivedp', `:commentedp'
929 `:footnote-section-p', `:post-blank' and `:post-affiliated'
930 keywords.
932 The plist also contains any property set in the property drawer,
933 with its name in upper cases and colons added at the
934 beginning (e.g., `:CUSTOM_ID').
936 LIMIT is a buffer position bounding the search.
938 When RAW-SECONDARY-P is non-nil, headline's title will not be
939 parsed as a secondary string, but as a plain string instead.
941 Assume point is at beginning of the headline."
988 :begin begin
989 :end end
990 :pre-blank
993 :contents-begin contents-begin
994 :contents-end contents-end
995 :level level
996 :priority priority
997 :tags tags
998 :todo-keyword todo
999 :todo-type todo-type
1002 end)
1003 :footnote-section-p footnote-section-p
1004 :archivedp archivedp
1005 :commentedp commentedp
1007 time-props
1008 standard-props))))
1010 headline :title
1019 nil
1021 headline)))))))
1024 "Interpret HEADLINE element as Org syntax.
1025 CONTENTS is the contents of the element."
1038 ?*)
1042 " "
1045 org-footnote-section
1046 title))))
1048 heading
1049 ;; Align tags.
1057 ?\s)
1058 tags))
1062 tags))))
1064 contents)))
1067 ;;;; Inlinetask
1070 "Parse an inline task.
1072 Return a list whose CAR is `inlinetask' and CDR is a plist
1073 containing `:title', `:begin', `:end', `:contents-begin' and
1074 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1075 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1076 `:closed', `:post-blank' and `:post-affiliated' keywords.
1078 The plist also contains any property set in the property drawer,
1079 with its name in upper cases and colons added at the
1080 beginning (e.g., `:CUSTOM_ID').
1082 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1083 title will not be parsed as a secondary string, but as a plain
1084 string instead.
1086 Assume point is at beginning of the inline task."
1131 :begin begin
1132 :end end
1133 :contents-begin contents-begin
1134 :contents-end contents-end
1135 :level level
1136 :priority priority
1137 :tags tags
1138 :todo-keyword todo
1139 :todo-type todo-type
1142 time-props
1143 standard-props))))
1145 inlinetask :title
1154 nil
1156 inlinetask))))))
1159 "Interpret INLINETASK element as Org syntax.
1160 CONTENTS is the contents of inlinetask."
1174 ;; Align tags.
1182 ? )
1183 tags))
1187 tags))))
1188 ;; Prefer degenerate inlinetasks when there are no
1189 ;; contents.
1192 contents
1196 ;;;; Item
1199 "Parse an item.
1201 STRUCT is the structure of the plain list.
1203 Return a list whose CAR is `item' and CDR is a plist containing
1204 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1205 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1206 `:post-affiliated' keywords.
1208 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1209 any, will not be parsed as a secondary string, but as a plain
1210 string instead.
1212 Assume point is at the beginning of the item."
1235 ;; Ignore tags in un-ordered lists: they are just
1236 ;; a part of item's body.
1243 ;; If first line isn't empty, contents really
1244 ;; start at the text after item's meta-data.
1254 :begin begin
1255 :end end
1256 :contents-begin contents-begin
1257 :contents-end contents-end
1258 :checkbox checkbox
1259 :counter counter
1260 :structure struct
1264 item :tag
1271 item))))))))
1274 "Interpret ITEM element as Org syntax.
1275 CONTENTS is the contents of the element."
1285 ;; Compute indentation.
1290 ;; Indent contents.
1292 bullet
1307 ;;;; Plain List
1310 ;; Return structure of list at point. Internal function. See
1311 ;; `org-list-struct' for details.
1316 items struct)
1321 ;; At limit: end all items.
1330 ;; At list end: end all items.
1335 ;; At a new item: end previous sibling.
1347 ind
1348 bullet
1351 ;; Description tag.
1355 ;; Ending position, unknown so far.
1356 nil)))
1357 items))
1359 ;; Skip empty lines.
1361 ;; Skip inline tasks and blank lines along the way.
1368 ;; At some text line. Check if it ends any previous item.
1381 ;; Skip blocks (any type) and drawers contents.
1386 limit t)))
1392 "Parse a plain list.
1394 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1395 the buffer position at the beginning of the first affiliated
1396 keyword and CDR is a plist of affiliated keywords along with
1397 their value. STRUCTURE is the structure of the plain list being
1398 parsed.
1400 Return a list whose CAR is `plain-list' and CDR is a plist
1401 containing `:type', `:begin', `:end', `:contents-begin' and
1402 `:contents-end', `:structure', `:post-blank' and
1403 `:post-affiliated' keywords.
1405 Assume point is at the beginning of the list."
1419 pos))
1423 ;; Return value.
1427 :begin begin
1428 :end end
1429 :contents-begin contents-begin
1430 :contents-end contents-end
1431 :structure struct
1437 "Interpret plain-list element as Org syntax.
1438 CONTENTS is the contents of the element."
1446 ;;;; Property Drawer
1449 "Parse a property drawer.
1451 LIMIT bounds the search.
1453 Return a list whose car is `property-drawer' and cdr is a plist
1454 containing `:begin', `:end', `:contents-begin', `:contents-end',
1455 `:post-blank' and `:post-affiliated' keywords.
1457 Assume point is at the beginning of the property drawer."
1470 :end end
1472 :contents-end contents-end
1477 "Interpret property-drawer element as Org syntax.
1478 CONTENTS is the properties within the drawer."
1482 ;;;; Quote Block
1485 "Parse a quote block.
1487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1488 the buffer position at the beginning of the first affiliated
1489 keyword and CDR is a plist of affiliated keywords along with
1490 their value.
1492 Return a list whose CAR is `quote-block' and CDR is a plist
1493 containing `:begin', `:end', `:contents-begin', `:contents-end',
1494 `:post-blank' and `:post-affiliated' keywords.
1496 Assume point is at the beginning of the block."
1500 ;; Incomplete block: parse it as a paragraph.
1506 ;; Empty blocks have no contents.
1519 :end end
1520 :contents-begin contents-begin
1521 :contents-end contents-end
1527 "Interpret quote-block element as Org syntax.
1528 CONTENTS is the contents of the element."
1532 ;;;; Section
1535 "Parse a section.
1537 Return a list whose CAR is `section' and CDR is a plist
1538 containing `:begin', `:end', `:contents-begin', `contents-end',
1539 `:post-blank' and `:post-affiliated' keywords."
1541 ;; Beginning of section is the beginning of the first non-blank
1542 ;; line after previous headline.
1550 :end end
1551 :contents-begin begin
1552 :contents-end pos-before-blank
1557 "Interpret section element as Org syntax.
1558 CONTENTS is the contents of the element."
1559 contents)
1562 ;;;; Special Block
1565 "Parse a special block.
1567 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1568 the buffer position at the beginning of the first affiliated
1569 keyword and CDR is a plist of affiliated keywords along with
1570 their value.
1572 Return a list whose CAR is `special-block' and CDR is a plist
1573 containing `:type', `:begin', `:end', `:contents-begin',
1574 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1576 Assume point is at the beginning of the block."
1583 limit t)))
1584 ;; Incomplete block: parse it as a paragraph.
1590 ;; Empty blocks have no contents.
1603 :begin begin
1604 :end end
1605 :contents-begin contents-begin
1606 :contents-end contents-end
1612 "Interpret SPECIAL-BLOCK element as Org syntax.
1613 CONTENTS is the contents of the element."
1618 \f
1619 ;;; Elements
1620 ;;
1621 ;; For each element, a parser and an interpreter are also defined.
1622 ;; Both follow the same naming convention used for greater elements.
1623 ;;
1624 ;; Also, as for greater elements, adding a new element type is done
1625 ;; through the following steps: implement a parser and an interpreter,
1626 ;; tweak `org-element--current-element' so that it recognizes the new
1627 ;; type and add that new type to `org-element-all-elements'.
1630 ;;;; Babel Call
1633 "Parse a babel call.
1635 LIMIT bounds the search. AFFILIATED is a list of which car is
1636 the buffer position at the beginning of the first affiliated
1637 keyword and cdr is a plist of affiliated keywords along with
1638 their value.
1640 Return a list whose car is `babel-call' and cdr is a plist
1641 containing `:call', `:inside-header', `:arguments',
1642 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1643 `:post-affiliated' as keywords."
1657 value)))
1667 :begin begin
1668 :end end
1669 :value value
1675 "Interpret BABEL-CALL element as Org syntax."
1685 ;;;; Clock
1688 "Parse a clock.
1690 LIMIT bounds the search.
1692 Return a list whose CAR is `clock' and CDR is a plist containing
1693 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1694 `:post-affiliated' as keywords."
1714 :value value
1715 :duration duration
1716 :begin begin
1717 :end end
1718 :post-blank post-blank
1722 "Interpret CLOCK element as Org syntax."
1730 "%2s:%02s"
1734 ;;;; Comment
1737 "Parse a comment.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `comment' and CDR is a plist
1745 containing `:begin', `:end', `:value', `:post-blank',
1746 `:post-affiliated' keywords.
1748 Assume point is at comment beginning."
1757 ;; Get comments ending.
1760 ;; Accumulate lines without leading hash and first
1761 ;; whitespace.
1775 :end end
1776 :value value
1782 "Interpret COMMENT element as Org syntax.
1783 CONTENTS is nil."
1787 ;;;; Comment Block
1790 "Parse an export block.
1792 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1793 the buffer position at the beginning of the first affiliated
1794 keyword and CDR is a plist of affiliated keywords along with
1795 their value.
1797 Return a list whose CAR is `comment-block' and CDR is a plist
1798 containing `:begin', `:end', `:value', `:post-blank' and
1799 `:post-affiliated' keywords.
1801 Assume point is at comment block beginning."
1805 ;; Incomplete block: parse it as a paragraph.
1818 contents-begin contents-end)))
1822 :end end
1823 :value value
1829 "Interpret COMMENT-BLOCK element as Org syntax."
1836 ;;;; Diary Sexp
1839 "Parse a diary sexp.
1841 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1842 the buffer position at the beginning of the first affiliated
1843 keyword and CDR is a plist of affiliated keywords along with
1844 their value.
1846 Return a list whose CAR is `diary-sexp' and CDR is a plist
1847 containing `:begin', `:end', `:value', `:post-blank' and
1848 `:post-affiliated' keywords."
1860 :begin begin
1861 :end end
1867 "Interpret DIARY-SEXP as Org syntax."
1871 ;;;; Example Block
1874 "Parse an example block.
1876 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1877 the buffer position at the beginning of the first affiliated
1878 keyword and CDR is a plist of affiliated keywords along with
1879 their value.
1881 Return a list whose CAR is `example-block' and CDR is a plist
1882 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1883 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1884 `:value', `:post-blank' and `:post-affiliated' keywords."
1888 ;; Incomplete block: parse it as a paragraph.
1896 ;; Switches analysis
1903 ;; Should labels be retained in (or stripped from) example
1904 ;; blocks?
1909 ;; What should code-references use - labels or
1910 ;; line-numbers?
1919 ;; Standard block parsing.
1925 contents-begin contents-end)))
1934 :end end
1935 :value value
1936 :switches switches
1937 :number-lines number-lines
1938 :preserve-indent preserve-indent
1939 :retain-labels retain-labels
1940 :use-labels use-labels
1941 :label-fmt label-fmt
1947 "Interpret EXAMPLE-BLOCK element as Org syntax."
1955 value
1960 ;;;; Export Block
1963 "Parse an export block.
1965 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1966 the buffer position at the beginning of the first affiliated
1967 keyword and CDR is a plist of affiliated keywords along with
1968 their value.
1970 Return a list whose CAR is `export-block' and CDR is a plist
1971 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1972 `:post-affiliated' keywords.
1974 Assume point is at export-block beginning."
1978 ;; Incomplete block: parse it as a paragraph.
1997 contents-end))))
2001 :begin begin
2002 :end end
2003 :value value
2009 "Interpret EXPORT-BLOCK element as Org syntax."
2015 ;;;; Fixed-width
2018 "Parse a fixed-width section.
2020 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2021 the buffer position at the beginning of the first affiliated
2022 keyword and CDR is a plist of affiliated keywords along with
2023 their value.
2025 Return a list whose CAR is `fixed-width' and CDR is a plist
2026 containing `:begin', `:end', `:value', `:post-blank' and
2027 `:post-affiliated' keywords.
2029 Assume point is at the beginning of the fixed-width area."
2033 value
2038 ;; Accumulate text without starting colons.
2051 :end end
2052 :value value
2058 "Interpret FIXED-WIDTH element as Org syntax."
2066 ;;;; Horizontal Rule
2069 "Parse an horizontal rule.
2071 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2072 the buffer position at the beginning of the first affiliated
2073 keyword and CDR is a plist of affiliated keywords along with
2074 their value.
2076 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2077 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2078 keywords."
2088 :end end
2094 "Interpret HORIZONTAL-RULE element as Org syntax."
2098 ;;;; Keyword
2101 "Parse a keyword at point.
2103 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2104 the buffer position at the beginning of the first affiliated
2105 keyword and CDR is a plist of affiliated keywords along with
2106 their value.
2108 Return a list whose CAR is `keyword' and CDR is a plist
2109 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2110 `:post-affiliated' keywords."
2112 ;; An orphaned affiliated keyword is considered as a regular
2113 ;; keyword. In this case AFFILIATED is nil, so we take care of
2114 ;; this corner case.
2127 :value value
2128 :begin begin
2129 :end end
2135 "Interpret KEYWORD element as Org syntax."
2141 ;;;; Latex Environment
2145 "Regexp matching the beginning of a LaTeX environment.
2146 The environment is captured by the first group.
2152 "Format string matching the ending of a LaTeX environment.
2156 "Parse a LaTeX environment.
2158 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2159 the buffer position at the beginning of the first affiliated
2160 keyword and CDR is a plist of affiliated keywords along with
2161 their value.
2163 Return a list whose CAR is `latex-environment' and CDR is a plist
2164 containing `:begin', `:end', `:value', `:post-blank' and
2165 `:post-affiliated' keywords.
2167 Assume point is at the beginning of the latex environment."
2174 limit t))
2175 ;; Incomplete latex environment: parse it as a paragraph.
2185 :end end
2186 :value value
2192 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2196 ;;;; Node Property
2199 "Parse a node-property at point.
2201 LIMIT bounds the search.
2203 Return a list whose CAR is `node-property' and CDR is a plist
2204 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2205 `:post-affiliated' keywords."
2215 limit))))
2218 :value value
2219 :begin begin
2220 :end end
2225 "Interpret NODE-PROPERTY element as Org syntax."
2231 ;;;; Paragraph
2234 "Parse a paragraph.
2236 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2237 the buffer position at the beginning of the first affiliated
2238 keyword and CDR is a plist of affiliated keywords along with
2239 their value.
2241 Return a list whose CAR is `paragraph' and CDR is a plist
2242 containing `:begin', `:end', `:contents-begin' and
2243 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2245 Assume point is at the beginning of the paragraph."
2252 ;; A matching `org-element-paragraph-separate' is not
2253 ;; necessarily the end of the paragraph. In particular,
2254 ;; drawers, blocks or LaTeX environments opening lines
2255 ;; must be closed. Moreover keywords with a secondary
2256 ;; value must belong to "dual keywords".
2270 limit t)))
2276 limit t)))
2279 org-element-dual-keywords))
2280 ;; Everything else is unambiguous.
2293 :end end
2294 :contents-begin contents-begin
2295 :contents-end contents-end
2301 "Interpret paragraph element as Org syntax.
2302 CONTENTS is the contents of the element."
2303 contents)
2306 ;;;; Planning
2309 "Parse a planning.
2311 LIMIT bounds the search.
2313 Return a list whose CAR is `planning' and CDR is a plist
2314 containing `:closed', `:deadline', `:scheduled', `:begin',
2315 `:end', `:post-blank' and `:post-affiliated' keywords."
2325 closed deadline scheduled)
2337 :deadline deadline
2338 :scheduled scheduled
2339 :begin begin
2340 :end end
2341 :post-blank post-blank
2345 "Interpret PLANNING element as Org syntax."
2347 #'identity
2364 ;;;; Src Block
2367 "Parse a src block.
2369 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2370 the buffer position at the beginning of the first affiliated
2371 keyword and CDR is a plist of affiliated keywords along with
2372 their value.
2374 Return a list whose CAR is `src-block' and CDR is a plist
2375 containing `:language', `:switches', `:parameters', `:begin',
2376 `:end', `:number-lines', `:retain-labels', `:use-labels',
2377 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2378 `:post-affiliated' keywords.
2380 Assume point is at the beginning of the block."
2383 limit t)))
2384 ;; Incomplete block: parse it as a paragraph.
2390 ;; Get language as a string.
2399 ;; Get switches.
2401 ;; Get parameters.
2403 ;; Switches analysis
2414 ;; Should labels be retained in (or stripped from)
2415 ;; src blocks?
2420 ;; What should code-references use - labels or
2421 ;; line-numbers?
2426 ;; Retrieve code.
2433 ;; Get position after ending blank lines.
2443 :begin begin
2444 :end end
2445 :number-lines number-lines
2446 :preserve-indent preserve-indent
2447 :retain-labels retain-labels
2448 :use-labels use-labels
2449 :label-fmt label-fmt
2450 :value value
2456 "Interpret SRC-BLOCK element as Org syntax."
2465 val)
2480 ;;;; Table
2483 "Parse a table at point.
2485 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2486 the buffer position at the beginning of the first affiliated
2487 keyword and CDR is a plist of affiliated keywords along with
2488 their value.
2490 Return a list whose CAR is `table' and CDR is a plist containing
2491 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2492 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2493 keywords.
2495 Assume point is at the beginning of the table."
2511 acc))
2518 :end end
2519 :type type
2520 :tblfm tblfm
2521 ;; Only `org' tables have contents. `table.el' tables
2522 ;; use a `:value' property to store raw table as
2523 ;; a string.
2528 table-begin table-end))
2534 "Interpret TABLE element as Org syntax.
2535 CONTENTS is a string, if table's type is `org', or nil."
2546 ;;;; Table Row
2549 "Parse table row at point.
2551 Return a list whose CAR is `table-row' and CDR is a plist
2552 containing `:begin', `:end', `:contents-begin', `:contents-end',
2553 `:type', `:post-blank' and `:post-affiliated' keywords."
2557 ;; A table rule has no contents. In that case, ensure
2558 ;; CONTENTS-BEGIN matches CONTENTS-END.
2568 :begin begin
2569 :end end
2570 :contents-begin contents-begin
2571 :contents-end contents-end
2576 "Interpret TABLE-ROW element as Org syntax.
2577 CONTENTS is the contents of the table row."
2582 ;;;; Verse Block
2585 "Parse a verse block.
2587 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2588 the buffer position at the beginning of the first affiliated
2589 keyword and CDR is a plist of affiliated keywords along with
2590 their value.
2592 Return a list whose CAR is `verse-block' and CDR is a plist
2593 containing `:begin', `:end', `:contents-begin', `:contents-end',
2594 `:post-blank' and `:post-affiliated' keywords.
2596 Assume point is at beginning of the block."
2600 ;; Incomplete block: parse it as a paragraph.
2615 :end end
2616 :contents-begin contents-begin
2617 :contents-end contents-end
2623 "Interpret verse-block element as Org syntax.
2624 CONTENTS is verse block contents."
2628 \f
2629 ;;; Objects
2630 ;;
2631 ;; Unlike to elements, raw text can be found between objects. Hence,
2632 ;; `org-element--object-lex' is provided to find the next object in
2633 ;; buffer.
2634 ;;
2635 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2636 ;; object types they can contain will be specified in
2637 ;; `org-element-object-restrictions'.
2638 ;;
2639 ;; Creating a new type of object requires to alter
2640 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2641 ;; new type in `org-element-all-objects', and possibly add
2642 ;; restrictions in `org-element-object-restrictions'.
2644 ;;;; Bold
2647 "Parse bold object at point, if any.
2649 When at a bold object, return a list whose car is `bold' and cdr
2650 is a plist with `:begin', `:end', `:contents-begin' and
2651 `:contents-end' and `:post-blank' keywords. Otherwise, return
2652 nil.
2654 Assume point is at the first star marker."
2666 :end end
2667 :contents-begin contents-begin
2668 :contents-end contents-end
2672 "Interpret bold object as Org syntax.
2673 CONTENTS is the contents of the object."
2677 ;;;; Code
2680 "Parse code object at point, if any.
2682 When at a code object, return a list whose car is `code' and cdr
2683 is a plist with `:value', `:begin', `:end' and `:post-blank'
2684 keywords. Otherwise, return nil.
2686 Assume point is at the first tilde marker."
2697 :begin begin
2698 :end end
2702 "Interpret CODE object as Org syntax."
2706 ;;;; Entity
2709 "Parse entity at point, if any.
2711 When at an entity, return a list whose car is `entity' and cdr
2712 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2713 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2714 `:post-blank' as keywords. Otherwise, return nil.
2716 Assume point is at the beginning of the entity."
2718 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2736 :begin begin
2737 :end end
2738 :use-brackets-p bracketsp
2742 "Interpret ENTITY object as Org syntax."
2748 ;;;; Export Snippet
2751 "Parse export snippet at point.
2753 When at an export snippet, return a list whose car is
2754 `export-snippet' and cdr a plist with `:begin', `:end',
2755 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2756 return nil.
2758 Assume point is at the beginning of the snippet."
2774 :value value
2775 :begin begin
2776 :end end
2780 "Interpret EXPORT-SNIPPET object as Org syntax."
2786 ;;;; Footnote Reference
2789 "Parse footnote reference at point, if any.
2791 When at a footnote reference, return a list whose car is
2792 `footnote-reference' and cdr a plist with `:label', `:type',
2793 `:begin', `:end', `:content-begin', `:contents-end' and
2794 `:post-blank' as keywords. Otherwise, return nil."
2810 :type type
2811 :begin begin
2812 :end end
2818 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2819 CONTENTS is its definition, when inline, or nil."
2825 ;;;; Inline Babel Call
2828 "Parse inline babel call at point, if any.
2830 When at an inline babel call, return a list whose car is
2831 `inline-babel-call' and cdr a plist with `:call',
2832 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2833 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2835 Assume point is at the beginning of the babel call."
2851 ;; Invalid inline source block.
2869 :inside-header inside-header
2870 :arguments arguments
2871 :end-header end-header
2872 :begin begin
2873 :end end
2874 :value value
2878 "Interpret INLINE-BABEL-CALL object as Org syntax."
2888 ;;;; Inline Src Block
2891 "Parse inline source block at point, if any.
2893 When at an inline source block, return a list whose car is
2894 `inline-src-block' and cdr a plist with `:begin', `:end',
2895 `:language', `:value', `:parameters' and `:post-blank' as
2896 keywords. Otherwise, return nil.
2898 Assume point is at the beginning of the inline src block."
2914 ;; Invalid inline source block.
2922 :value value
2923 :parameters parameters
2924 :begin begin
2929 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2934 language
2936 body)))
2938 ;;;; Italic
2941 "Parse italic object at point, if any.
2943 When at an italic object, return a list whose car is `italic' and
2944 cdr is a plist with `:begin', `:end', `:contents-begin' and
2945 `:contents-end' and `:post-blank' keywords. Otherwise, return
2946 nil.
2948 Assume point is at the first slash marker."
2960 :end end
2961 :contents-begin contents-begin
2962 :contents-end contents-end
2966 "Interpret italic object as Org syntax.
2967 CONTENTS is the contents of the object."
2971 ;;;; Latex Fragment
2974 "Parse LaTeX fragment at point, if any.
2976 When at a LaTeX fragment, return a list whose car is
2977 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2978 and `:post-blank' as keywords. Otherwise, return nil.
2980 Assume point is at the beginning of the LaTeX fragment."
2998 ;; Macro.
3008 :begin begin
3009 :end end
3013 "Interpret LATEX-FRAGMENT object as Org syntax."
3016 ;;;; Line Break
3019 "Parse line break at point, if any.
3021 When at a line break, return a list whose car is `line-break',
3022 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3023 Otherwise, return nil.
3025 Assume point is at the beginning of the line break."
3034 "Interpret LINE-BREAK object as Org syntax."
3038 ;;;; Link
3041 "Parse link at point, if any.
3043 When at a link, return a list whose car is `link' and cdr a plist
3044 with `:type', `:path', `:raw-link', `:application',
3045 `:search-option', `:begin', `:end', `:contents-begin',
3046 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3047 nil.
3049 Assume point is at the beginning of the link."
3052 end contents-begin contents-end link-end post-blank path type
3053 raw-link search-option application)
3055 ;; Type 1: Text targeted from a radio target.
3064 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3069 ;; RAW-LINK is the original link. Expand any
3070 ;; abbreviation in it.
3071 ;;
3072 ;; Also treat any newline character and associated
3073 ;; indentation as a single space character. This is not
3074 ;; compatible with RFC 3986, which requires to ignore
3075 ;; them altogether. However, doing so would require
3076 ;; users to encode spaces on the fly when writing links
3077 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3078 ;; [[shell:ls *.org]], which defeats Org's focus on
3079 ;; simplicity.
3084 ;; Determine TYPE of link and set PATH accordingly. According
3085 ;; to RFC 3986, remove whitespaces from URI in external links.
3086 ;; In internal ones, treat indentation as a single space.
3088 ;; File type.
3093 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3097 ;; Id type: PATH is the id.
3100 ;; Code-ref type: PATH is the name of the reference.
3105 ;; Custom-id type: PATH is the name of the custom id.
3109 ;; Fuzzy type: Internal link either matches a target, an
3110 ;; headline name or nothing. PATH is the target or
3111 ;; headline's name.
3115 ;; Type 3: Plain link, e.g., http://orgmode.org
3121 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3122 ;; bracket links, follow RFC 3986 and remove any extra
3123 ;; whitespace in URI.
3133 ;; In any case, deduce end point after trailing white space from
3134 ;; LINK-END variable.
3139 ;; Special "file" type link processing. Extract opening
3140 ;; application and search option, if any. Also normalize URI.
3147 ;; Translate link, if `org-link-translation-function' is set.
3155 :path path
3157 :application application
3158 :search-option search-option
3159 :begin begin
3160 :end end
3161 :contents-begin contents-begin
3162 :contents-end contents-end
3166 "Interpret LINK object as Org syntax.
3167 CONTENTS is the contents of the object, or nil."
3178 path
3185 ;;;; Macro
3188 "Parse macro at point, if any.
3190 When at a macro, return a list whose car is `macro' and cdr
3191 a plist with `:key', `:args', `:begin', `:end', `:value' and
3192 `:post-blank' as keywords. Otherwise, return nil.
3194 Assume point is at the macro."
3207 :value value
3208 :args args
3209 :begin begin
3210 :end end
3214 "Interpret MACRO object as Org syntax."
3218 ;;;; Radio-target
3221 "Parse radio target at point, if any.
3223 When at a radio target, return a list whose car is `radio-target'
3224 and cdr a plist with `:begin', `:end', `:contents-begin',
3225 `:contents-end', `:value' and `:post-blank' as keywords.
3226 Otherwise, return nil.
3228 Assume point is at the radio target."
3240 :end end
3241 :contents-begin contents-begin
3242 :contents-end contents-end
3243 :post-blank post-blank
3247 "Interpret target object as Org syntax.
3248 CONTENTS is the contents of the object."
3252 ;;;; Statistics Cookie
3255 "Parse statistics cookie at point, if any.
3257 When at a statistics cookie, return a list whose car is
3258 `statistics-cookie', and cdr a plist with `:begin', `:end',
3259 `:value' and `:post-blank' keywords. Otherwise, return nil.
3261 Assume point is at the beginning of the statistics-cookie."
3272 :end end
3273 :value value
3277 "Interpret STATISTICS-COOKIE object as Org syntax."
3281 ;;;; Strike-Through
3284 "Parse strike-through object at point, if any.
3286 When at a strike-through object, return a list whose car is
3287 `strike-through' and cdr is a plist with `:begin', `:end',
3288 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3289 Otherwise, return nil.
3291 Assume point is at the first plus sign marker."
3303 :end end
3304 :contents-begin contents-begin
3305 :contents-end contents-end
3309 "Interpret strike-through object as Org syntax.
3310 CONTENTS is the contents of the object."
3314 ;;;; Subscript
3317 "Parse subscript at point, if any.
3319 When at a subscript object, return a list whose car is
3320 `subscript' and cdr a plist with `:begin', `:end',
3321 `:contents-begin', `:contents-end', `:use-brackets-p' and
3322 `:post-blank' as keywords. Otherwise, return nil.
3324 Assume point is at the underscore."
3338 :end end
3339 :use-brackets-p bracketsp
3340 :contents-begin contents-begin
3341 :contents-end contents-end
3345 "Interpret SUBSCRIPT object as Org syntax.
3346 CONTENTS is the contents of the object."
3349 contents))
3352 ;;;; Superscript
3355 "Parse superscript at point, if any.
3357 When at a superscript object, return a list whose car is
3358 `superscript' and cdr a plist with `:begin', `:end',
3359 `:contents-begin', `:contents-end', `:use-brackets-p' and
3360 `:post-blank' as keywords. Otherwise, return nil.
3362 Assume point is at the caret."
3376 :end end
3377 :use-brackets-p bracketsp
3378 :contents-begin contents-begin
3379 :contents-end contents-end
3383 "Interpret SUPERSCRIPT object as Org syntax.
3384 CONTENTS is the contents of the object."
3387 contents))
3390 ;;;; Table Cell
3393 "Parse table cell at point.
3394 Return a list whose car is `table-cell' and cdr is a plist
3395 containing `:begin', `:end', `:contents-begin', `:contents-end'
3396 and `:post-blank' keywords."
3404 :end end
3405 :contents-begin contents-begin
3406 :contents-end contents-end
3410 "Interpret table-cell element as Org syntax.
3411 CONTENTS is the contents of the cell, or nil."
3415 ;;;; Target
3418 "Parse target at point, if any.
3420 When at a target, return a list whose car is `target' and cdr
3421 a plist with `:begin', `:end', `:value' and `:post-blank' as
3422 keywords. Otherwise, return nil.
3424 Assume point is at the target."
3434 :end end
3435 :value value
3439 "Interpret TARGET object as Org syntax."
3443 ;;;; Timestamp
3454 "Parse time stamp at point, if any.
3456 When at a time stamp, return a list whose car is `timestamp', and
3457 cdr a plist with `:type', `:raw-value', `:year-start',
3458 `:month-start', `:day-start', `:hour-start', `:minute-start',
3459 `:year-end', `:month-end', `:day-end', `:hour-end',
3460 `:minute-end', `:repeater-type', `:repeater-value',
3461 `:repeater-unit', `:warning-type', `:warning-value',
3462 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3463 Otherwise, return nil.
3465 Assume point is at the beginning of the timestamp."
3484 date-start)
3495 raw-value)
3497 :repeater-type
3503 :repeater-unit
3512 :warning-unit
3515 year-start month-start day-start hour-start minute-start year-end
3516 month-end day-end hour-end minute-end)
3517 ;; Parse date-start.
3525 ;; Compute date-end. It can be provided directly in time-stamp,
3526 ;; or extracted from time range. Otherwise, it defaults to the
3527 ;; same values as date-start.
3537 :raw-value raw-value
3538 :year-start year-start
3539 :month-start month-start
3540 :day-start day-start
3541 :hour-start hour-start
3542 :minute-start minute-start
3543 :year-end year-end
3544 :month-end month-end
3545 :day-end day-end
3546 :hour-end hour-end
3547 :minute-end minute-end
3548 :begin begin
3549 :end end
3551 repeater-props
3552 warning-props))))))
3555 "Interpret TIMESTAMP object as Org syntax."
3573 ;; Build an Org timestamp string from TIME. ACTIVEP is
3574 ;; non-nil when time stamp is active. If WITH-TIME-P is
3575 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3576 ;; specify a time range in the timestamp. REPEAT-STRING is
3577 ;; the repeater string, if any.
3581 org-time-stamp-formats)
3582 time)))
3588 nil nil ts)))
3593 " "
3594 s
3596 ;; Return value.
3597 ts)))
3609 build-ts-string
3628 0
3636 "--"
3649 ;;;; Underline
3652 "Parse underline object at point, if any.
3654 When at an underline object, return a list whose car is
3655 `underline' and cdr is a plist with `:begin', `:end',
3656 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3657 Otherwise, return nil.
3659 Assume point is at the first underscore marker."
3671 :end end
3672 :contents-begin contents-begin
3673 :contents-end contents-end
3677 "Interpret underline object as Org syntax.
3678 CONTENTS is the contents of the object."
3682 ;;;; Verbatim
3685 "Parse verbatim object at point, if any.
3687 When at a verbatim object, return a list whose car is `verbatim'
3688 and cdr is a plist with `:value', `:begin', `:end' and
3689 `:post-blank' keywords. Otherwise, return nil.
3691 Assume point is at the first equal sign marker."
3702 :begin begin
3703 :end end
3707 "Interpret VERBATIM object as Org syntax."
3711 \f
3712 ;;; Parsing Element Starting At Point
3713 ;;
3714 ;; `org-element--current-element' is the core function of this section.
3715 ;; It returns the Lisp representation of the element starting at
3716 ;; point.
3717 ;;
3718 ;; `org-element--current-element' makes use of special modes. They
3719 ;; are activated for fixed element chaining (e.g., `plain-list' >
3720 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3721 ;; `section'). Special modes are: `first-section', `item',
3722 ;; `node-property', `section' and `table-row'.
3725 "Parse the element starting at point.
3727 Return value is a list like (TYPE PROPS) where TYPE is the type
3728 of the element and PROPS a plist of properties associated to the
3729 element.
3731 Possible types are defined in `org-element-all-elements'.
3733 LIMIT bounds the search.
3735 Optional argument GRANULARITY determines the depth of the
3736 recursion. Allowed values are `headline', `greater-element',
3737 `element', `object' or nil. When it is broader than `object' (or
3738 nil), secondary values will not be parsed, since they only
3739 contain objects.
3741 Optional argument MODE, when non-nil, can be either
3742 `first-section', `section', `planning', `item', `node-property'
3743 and `table-row'.
3745 If STRUCTURE isn't provided but MODE is set to `item', it will be
3746 computed.
3748 This function assumes point is always at the beginning of the
3749 element it has to parse."
3752 ;; Determine if parsing depth allows for secondary strings
3753 ;; parsing. It only applies to elements referenced in
3754 ;; `org-element-secondary-value-alist'.
3757 ;; Item.
3760 ;; Table Row.
3762 ;; Node Property.
3764 ;; Headline.
3767 ;; Sections (must be checked after headline).
3772 limit)))
3773 ;; Planning.
3776 ;; Property drawer.
3780 ;; When not at bol, point is at the beginning of an item or
3781 ;; a footnote definition: next item is always a paragraph.
3783 ;; Clock.
3785 ;; Inlinetask.
3788 ;; From there, elements can have affiliated keywords.
3791 ;; Jumping over affiliated keywords put point off-limits.
3792 ;; Parse them as regular keywords.
3796 ;; LaTeX Environment.
3799 ;; Drawer and Property Drawer.
3802 ;; Fixed Width
3805 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3806 ;; Keywords.
3824 limit
3825 affiliated))
3838 ;; Footnote Definition.
3841 ;; Horizontal Rule.
3844 ;; Diary Sexp.
3847 ;; Table.
3850 ;; List.
3853 limit affiliated
3855 ;; Default element: Paragraph.
3859 ;; Most elements can have affiliated keywords. When looking for an
3860 ;; element beginning, we want to move before them, as they belong to
3861 ;; that element, and, in the meantime, collect information they give
3862 ;; into appropriate properties. Hence the following function.
3865 "Collect affiliated keywords from point down to LIMIT.
3867 Return a list whose CAR is the position at the first of them and
3868 CDR a plist of keywords and values and move point to the
3869 beginning of the first line after them.
3871 As a special case, if element doesn't start at the beginning of
3872 the line (e.g., a paragraph starting an item), CAR is current
3873 position of point and CDR is nil."
3877 ;; RESTRICT is the list of objects allowed in parsed
3878 ;; keywords value.
3880 output)
3883 ;; Apply translation to RAW-KWD. From there, KWD is
3884 ;; the official keyword.
3886 org-element-keyword-translation-alist))
3887 raw-kwd))
3888 ;; Find main value for any keyword.
3894 ;; PARSEDP is non-nil when keyword should have its
3895 ;; value parsed.
3897 ;; If KWD is a dual keyword, find its secondary
3898 ;; value. Maybe parse it.
3907 ;; Attribute a property name to KWD.
3909 ;; Now set final shape for VALUE.
3915 nil restrict)))
3919 ;; Attributes can always appear on multiple lines.
3922 ;; Eventually store the new value in OUTPUT.
3924 ;; Move to next keyword.
3926 ;; If affiliated keywords are orphaned: move back to first one.
3927 ;; They will be parsed as a paragraph.
3929 ;; Return value.
3933 \f
3934 ;;; The Org Parser
3935 ;;
3936 ;; The two major functions here are `org-element-parse-buffer', which
3937 ;; parses Org syntax inside the current buffer, taking into account
3938 ;; region, narrowing, or even visibility if specified, and
3939 ;; `org-element-parse-secondary-string', which parses objects within
3940 ;; a given string.
3941 ;;
3942 ;; The (almost) almighty `org-element-map' allows applying a function
3943 ;; on elements or objects matching some type, and accumulating the
3944 ;; resulting values. In an export situation, it also skips unneeded
3945 ;; parts of the parse tree.
3948 "Recursively parse the buffer and return structure.
3949 If narrowing is in effect, only parse the visible part of the
3950 buffer.
3952 Optional argument GRANULARITY determines the depth of the
3953 recursion. It can be set to the following symbols:
3955 `headline' Only parse headlines.
3956 `greater-element' Don't recurse into greater elements excepted
3957 headlines and sections. Thus, elements
3958 parsed are the top-level ones.
3959 `element' Parse everything but objects and plain text.
3960 `object' Parse the complete buffer (default).
3962 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3963 elements.
3965 An element or an objects is represented as a list with the
3966 pattern (TYPE PROPERTIES CONTENTS), where :
3968 TYPE is a symbol describing the element or object. See
3969 `org-element-all-elements' and `org-element-all-objects' for an
3970 exhaustive list of such symbols. One can retrieve it with
3971 `org-element-type' function.
3973 PROPERTIES is the list of attributes attached to the element or
3974 object, as a plist. Although most of them are specific to the
3975 element or object type, all types share `:begin', `:end',
3976 `:post-blank' and `:parent' properties, which respectively
3977 refer to buffer position where the element or object starts,
3978 ends, the number of white spaces or blank lines after it, and
3979 the element or object containing it. Properties values can be
3980 obtained by using `org-element-property' function.
3982 CONTENTS is a list of elements, objects or raw strings
3983 contained in the current element or object, when applicable.
3984 One can access them with `org-element-contents' function.
3986 The Org buffer has `org-data' as type and nil as properties.
3987 `org-element-map' function can be used to find specific elements
3988 or objects within the parse tree.
3990 This function assumes that current major mode is `org-mode'."
3996 ;; Start in `first-section' mode so text before the first
3997 ;; headline belongs to a section.
4001 "Recursively parse objects in STRING and return structure.
4003 RESTRICTION is a symbol limiting the object types that will be
4004 looked after.
4006 Optional argument PARENT, when non-nil, is the element or object
4007 containing the secondary string. It is used to set correctly
4008 `:parent' property within the string.
4010 If STRING is the empty string or nil, return nil."
4027 "Map a function on selected elements or objects.
4029 DATA is a parse tree, an element, an object, a string, or a list
4030 of such constructs. TYPES is a symbol or list of symbols of
4031 elements or objects types (see `org-element-all-elements' and
4032 `org-element-all-objects' for a complete list of types). FUN is
4033 the function called on the matching element or object. It has to
4034 accept one argument: the element or object itself.
4036 When optional argument INFO is non-nil, it should be a plist
4037 holding export options. In that case, parts of the parse tree
4038 not exportable according to that property list will be skipped.
4040 When optional argument FIRST-MATCH is non-nil, stop at the first
4041 match for which FUN doesn't return nil, and return that value.
4043 Optional argument NO-RECURSION is a symbol or a list of symbols
4044 representing elements or objects types. `org-element-map' won't
4045 enter any recursive element or object whose type belongs to that
4046 list. Though, FUN can still be applied on them.
4048 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4049 apply to matching objects within parsed affiliated keywords (see
4050 `org-element-parsed-keywords').
4052 Nil values returned from FUN do not appear in the results.
4055 Examples:
4056 ---------
4058 Assuming TREE is a variable containing an Org buffer parse tree,
4059 the following example will return a flat list of all `src-block'
4060 and `example-block' elements in it:
4064 The following snippet will find the first headline with a level
4068 (lambda (hl)
4069 (and (= (org-element-property :level hl) 1)
4071 (org-element-property :begin hl)))
4072 nil t)
4074 The next example will return a flat list of all `plain-list' type
4075 elements in TREE that are not a sub-list themselves:
4079 Eventually, this example will return a flat list of all `bold'
4080 type objects containing a `latex-snippet' type object, even
4081 looking into captions:
4084 (lambda (b)
4086 nil nil nil t)"
4087 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4091 ;; Recursion depth is determined by --CATEGORY.
4098 ;; If one object is found, the function has
4099 ;; to recurse into every object.
4102 ;; If one regular element is found, the
4103 ;; function has to recurse, at least, into
4104 ;; every element it encounters.
4107 --acc)
4110 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4111 ;; holding contextual information.
4115 ;; Ignored element in an export context.
4117 ;; List of elements or objects.
4119 ;; Unconditionally enter parse trees.
4123 ;; Check if TYPE is matching among TYPES. If so,
4124 ;; apply FUN to --DATA and accumulate return value
4125 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4131 ;; If --DATA has a secondary string that can contain
4132 ;; objects with their type among TYPES, look inside.
4135 org-element-secondary-value-alist)))
4137 ;; If --DATA has any parsed affiliated keywords and
4138 ;; WITH-AFFILIATED is non-nil, look for objects in
4139 ;; them.
4146 ;; Pay attention to the type of parsed
4147 ;; keyword. In particular, preserve order for
4148 ;; multiple keywords.
4161 ;; Determine if a recursion into --DATA is possible.
4163 ;; --TYPE is explicitly removed from recursion.
4165 ;; --DATA has no contents.
4167 ;; Looking for greater elements but --DATA is
4168 ;; simply an element or an object.
4171 ;; Looking for elements but --DATA is an object.
4174 ;; In any other case, map contents.
4178 ;; Return value in a proper order.
4182 ;; The following functions are internal parts of the parser.
4183 ;;
4184 ;; The first one, `org-element--parse-elements' acts at the element's
4185 ;; level.
4186 ;;
4187 ;; The second one, `org-element--parse-objects' applies on all objects
4188 ;; of a paragraph or a secondary string. It calls
4189 ;; `org-element--object-lex' to find the next object in the current
4190 ;; container.
4193 "Return next special mode according to TYPE, or nil.
4194 TYPE is a symbol representing the type of an element or object
4195 containing next element if PARENTP is non-nil, or before it
4196 otherwise. Modes can be either `first-section', `item',
4197 `node-property', `planning', `property-drawer', `section',
4198 `table-row' or nil."
4215 "Parse elements between BEG and END positions.
4217 MODE prioritizes some elements over the others. It can be set to
4218 `first-section', `section', `planning', `item', `node-property'
4219 or `table-row'.
4221 When value is `item', STRUCTURE will be used as the current list
4222 structure.
4224 GRANULARITY determines the depth of the recursion. See
4225 `org-element-parse-buffer' for more information.
4227 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4228 elements.
4230 Elements are accumulated into ACC."
4233 ;; Visible only: skip invisible parts at the beginning of the
4234 ;; element.
4237 ;; When parsing only headlines, skip any text before first one.
4242 ;; Find current element's type and parse it accordingly to
4243 ;; its category.
4245 end granularity mode structure))
4249 ;; Visible only: skip invisible parts between siblings.
4252 ;; Fill ELEMENT contents by side-effect.
4254 ;; If element has no contents, don't modify it.
4256 ;; Greater element: parse it between `contents-begin' and
4257 ;; `contents-end'. Make sure GRANULARITY allows the
4258 ;; recursion, or ELEMENT is a headline, in which case going
4259 ;; inside is mandatory, in order to get sub-level headings.
4267 ;; Possibly switch to a special mode.
4271 granularity visible-only element))
4272 ;; ELEMENT has contents. Parse objects inside, if
4273 ;; GRANULARITY allows it.
4279 ;; Update mode.
4281 ;; Return result.
4285 "Return next object in current buffer or nil.
4286 RESTRICTION is a list of object types, as symbols, that should be
4287 looked after. This function assumes that the buffer is narrowed
4288 to an appropriate container (e.g., a paragraph)."
4296 found)
4362 ;; This is probably a plain link.
4368 ;; Radio link.
4373 "Parse objects between BEG and END and return recursive structure.
4375 Objects are accumulated in ACC. RESTRICTION is a list of object
4376 successors which are allowed in the current object.
4378 ACC becomes the parent for all parsed objects. However, if ACC
4379 is nil (i.e., a secondary string is being parsed) and optional
4380 argument PARENT is non-nil, use it as the parent for all objects.
4381 Eventually, if both ACC and PARENT are nil, the common parent is
4382 the list of objects itself."
4390 ;; Text before any object. Untabify it.
4395 contents))))
4396 ;; Object...
4401 ;; Fill contents of NEXT-OBJECT if possible.
4403 cont-beg
4405 next-object
4407 next-object)
4408 contents)
4410 ;; Text after last object. Untabify it.
4414 contents)))
4415 ;; Result. Set appropriate parent.
4423 \f
4424 ;;; Towards A Bijective Process
4425 ;;
4426 ;; The parse tree obtained with `org-element-parse-buffer' is really
4427 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4428 ;; interpreted and expanded into a string with canonical Org syntax.
4429 ;; Hence `org-element-interpret-data'.
4430 ;;
4431 ;; The function relies internally on
4432 ;; `org-element--interpret-affiliated-keywords'.
4434 ;;;###autoload
4436 "Interpret DATA as Org syntax.
4437 DATA is a parse tree, an element, an object or a secondary string
4438 to interpret. Return Org syntax as a string."
4442 ;; Find interpreter for current object or
4443 ;; element. If it doesn't exist (e.g. this is
4444 ;; a pseudo object or element), return contents,
4445 ;; if any.
4452 ;; Secondary string.
4456 ;; Full Org document.
4460 ;; Plain text: return it.
4462 ;; Element or object without contents.
4465 ;; Element or object with contents.
4468 interpret
4469 --data
4470 ;; Recursively interpret contents.
4475 --data
4476 ;; Fix indentation of elements containing
4477 ;; objects. We ignore `table-row'
4478 ;; elements as they are one line long
4479 ;; anyway.
4481 --data
4482 ;; When normalizing first paragraph of
4483 ;; an item or a footnote-definition,
4484 ;; ignore first line's indentation.
4492 ;; Build white spaces. If no `:post-blank' property
4493 ;; is specified, assume its value is 0.
4508 "Return ELEMENT's affiliated keywords as Org syntax.
4509 If there is no affiliated keyword, return the empty string."
4519 ": "
4522 value)
4530 ;; All attribute keywords can have multiple lines.
4536 ;; List all ELEMENT's properties matching an attribute line or an
4537 ;; affiliated keyword, but ignore translated keywords since they
4538 ;; cannot belong to the property list.
4545 org-element-keyword-translation-alist)))))
4546 collect prop)
4549 ;; Because interpretation of the parse tree must return the same
4550 ;; number of blank lines between elements and the same number of white
4551 ;; space after objects, some special care must be given to white
4552 ;; spaces.
4553 ;;
4554 ;; The first function, `org-element-normalize-string', ensures any
4555 ;; string different from the empty string will end with a single
4556 ;; newline character.
4557 ;;
4558 ;; The second function, `org-element-normalize-contents', removes
4559 ;; global indentation from the contents of the current element.
4562 "Ensure string S ends with a single newline character.
4564 If S isn't a string return it unchanged. If S is the empty
4565 string, return it. Otherwise, return a new string with a single
4566 newline character at its end."
4574 "Normalize plain text in ELEMENT's contents.
4576 ELEMENT must only contain plain text and objects.
4578 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4579 indentation to compute maximal common indentation.
4581 Return the normalized element that is element with global
4582 indentation removed from its contents."
4584 ;; Return minimal common indentation within BLOB. This is
4585 ;; done by walking recursively BLOB and updating MIN-IND
4586 ;; along the way. FIRST-FLAG is non-nil when the next
4587 ;; object is expected to be a string that doesn't start
4588 ;; with a newline character. It happens for strings at
4589 ;; the beginnings of the contents or right after a line
4590 ;; break.
4597 ;; Objects cannot start with spaces: in this
4598 ;; case, indentation is 0.
4621 datum)
4634 ;; Build ELEMENT back, replacing each string with the same
4635 ;; string minus common indentation.
4638 ;; Return DATUM with all its strings indentation
4639 ;; shortened from MIN-IND white spaces.
4659 org-element-recursive-objects)
4663 datum)))
4667 \f
4668 ;;; Cache
4669 ;;
4670 ;; Implement a caching mechanism for `org-element-at-point' and
4671 ;; `org-element-context', which see.
4672 ;;
4673 ;; A single public function is provided: `org-element-cache-reset'.
4674 ;;
4675 ;; Cache is enabled by default, but can be disabled globally with
4676 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4677 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4678 ;; can be tweaked to control caching behaviour.
4679 ;;
4680 ;; Internally, parsed elements are stored in an AVL tree,
4681 ;; `org-element--cache'. This tree is updated lazily: whenever
4682 ;; a change happens to the buffer, a synchronization request is
4683 ;; registered in `org-element--cache-sync-requests' (see
4684 ;; `org-element--cache-submit-request'). During idle time, requests
4685 ;; are processed by `org-element--cache-sync'. Synchronization also
4686 ;; happens when an element is required from the cache. In this case,
4687 ;; the process stops as soon as the needed element is up-to-date.
4688 ;;
4689 ;; A synchronization request can only apply on a synchronized part of
4690 ;; the cache. Therefore, the cache is updated at least to the
4691 ;; location where the new request applies. Thus, requests are ordered
4692 ;; from left to right and all elements starting before the first
4693 ;; request are correct. This property is used by functions like
4694 ;; `org-element--cache-find' to retrieve elements in the part of the
4695 ;; cache that can be trusted.
4696 ;;
4697 ;; A request applies to every element, starting from its original
4698 ;; location (or key, see below). When a request is processed, it
4699 ;; moves forward and may collide the next one. In this case, both
4700 ;; requests are merged into a new one that starts from that element.
4701 ;; As a consequence, the whole synchronization complexity does not
4702 ;; depend on the number of pending requests, but on the number of
4703 ;; elements the very first request will be applied on.
4704 ;;
4705 ;; Elements cannot be accessed through their beginning position, which
4706 ;; may or may not be up-to-date. Instead, each element in the tree is
4707 ;; associated to a key, obtained with `org-element--cache-key'. This
4708 ;; mechanism is robust enough to preserve total order among elements
4709 ;; even when the tree is only partially synchronized.
4710 ;;
4711 ;; Objects contained in an element are stored in a hash table,
4712 ;; `org-element--cache-objects'.
4716 "Non nil when Org parser should cache its results.
4723 "Maximum duration, as a time value, for a cache synchronization.
4724 If the synchronization is not over after this delay, the process
4725 pauses and resumes after `org-element-cache-sync-break'
4729 "Duration, as a time value, of the pause between synchronizations.
4733 ;;;; Data Structure
4736 "AVL tree used to cache elements.
4737 Each node of the tree contains an element. Comparison is done
4738 with `org-element--cache-compare'. This cache is used in
4742 "Hash table used as to cache objects.
4743 Key is an element, as returned by `org-element-at-point', and
4744 value is an alist where each association is:
4746 \(PARENT COMPLETEP . OBJECTS)
4748 where PARENT is an element or object, COMPLETEP is a boolean,
4749 non-nil when all direct children of parent are already cached and
4750 OBJECTS is a list of such children, as objects, from farthest to
4751 closest.
4754 contained within a paragraph
4758 If the paragraph is completely parsed, OBJECTS-DATA will be
4760 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4761 \(BOLD-OBJECT t ENTITY-OBJECT))
4763 whereas in a partially parsed paragraph, it could be
4765 \((PARAGRAPH nil ENTITY-OBJECT))
4770 "List of pending synchronization requests.
4772 A request is a vector with the following pattern:
4774 \[NEXT BEG END OFFSET PARENT PHASE]
4776 Processing a synchronization request consists of three phases:
4778 0. Delete modified elements,
4779 1. Fill missing area in cache,
4780 2. Shift positions and re-parent elements after the changes.
4782 During phase 0, NEXT is the key of the first element to be
4783 removed, BEG and END is buffer position delimiting the
4784 modifications. Elements starting between them (inclusive) are
4785 removed. So are elements whose parent is removed. PARENT, when
4786 non-nil, is the parent of the first element to be removed.
4788 During phase 1, NEXT is the key of the next known element in
4789 cache and BEG its beginning position. Parse buffer between that
4790 element and the one before it in order to determine the parent of
4791 the next element. Set PARENT to the element containing NEXT.
4793 During phase 2, NEXT is the key of the next element to shift in
4794 the parse tree. All elements starting from this one have their
4795 properties relatives to buffer positions shifted by integer
4796 OFFSET and, if they belong to element PARENT, are adopted by it.
4804 "Hash table used to store keys during synchronization.
4808 "Return a unique key for ELEMENT in cache tree.
4810 Keys are used to keep a total order among elements in the cache.
4811 Comparison is done with `org-element--cache-key-less-p'.
4813 When no synchronization is taking place, a key is simply the
4814 beginning position of the element, or that position plus one in
4815 the case of an first item (respectively row) in
4816 a list (respectively a table).
4818 During a synchronization, the key is the one the element had when
4819 the cache was synchronized for the last time. Elements added to
4820 cache during the synchronization get a new key generated with
4821 `org-element--cache-generate-key'.
4823 Such keys are stored in `org-element--cache-sync-keys'. The hash
4824 table is cleared once the synchronization is complete."
4827 ;; Increase beginning position of items (respectively
4828 ;; table rows) by one, so the first item can get
4829 ;; a different key from its parent list (respectively
4830 ;; table).
4833 begin)))
4836 key))))
4839 "Generate a key between LOWER and UPPER.
4841 LOWER and UPPER are integers or lists, possibly empty.
4843 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4844 a unique key, as an integer or a list of integers, according to
4845 the following rules:
4847 - LOWER and UPPER are compared level-wise until values differ.
4849 - If, at a given level, LOWER and UPPER differ from more than
4850 2, the new key shares all the levels above with LOWER and
4851 gets a new level. Its value is the mean between LOWER and
4852 UPPER:
4854 \(1 2) + (1 4) --> (1 3)
4856 - If LOWER has no value to compare with, it is assumed that its
4857 value is `most-negative-fixnum'. E.g.,
4859 \(1 1) + (1 1 2)
4861 is equivalent to
4863 \(1 1 m) + (1 1 2)
4865 where m is `most-negative-fixnum'. Likewise, if UPPER is
4866 short of levels, the current value is `most-positive-fixnum'.
4868 - If they differ from only one, the new key inherits from
4869 current LOWER level and fork it at the next level. E.g.,
4871 \(2 1) + (3 3)
4873 is equivalent to
4875 \(2 1) + (2 M)
4877 where M is `most-positive-fixnum'.
4879 - If the key is only one level long, it is returned as an
4880 integer:
4882 \(1 2) + (3 2) --> 2
4884 When they are not equals, the function assumes that LOWER is
4885 lesser than UPPER, per `org-element--cache-key-less-p'."
4889 skip-upper key)
4900 ;; When at a given level, LOWER and UPPER differ from
4901 ;; 1, ignore UPPER altogether. Instead create a key
4902 ;; between LOWER and the greatest key with the same
4903 ;; prefix as LOWER so far.
4909 "Non-nil if key A is less than key B.
4910 A and B are either integers or lists of integers, as returned by
4911 `org-element--cache-key'."
4919 ;; If A is empty, either keys are equal (B is also empty) and
4920 ;; we return nil, or A is lesser than B (B is longer) and we
4921 ;; return a non-nil value.
4922 ;;
4923 ;; If A is not empty, B is necessarily empty and A is greater
4924 ;; than B (A is longer). Therefore, return nil.
4928 "Non-nil when element A is located before element B."
4933 "Return root value in cache.
4934 This function assumes `org-element--cache' is a valid AVL tree."
4938 ;;;; Tools
4941 "Non-nil when cache is active in current buffer."
4943 org-element--cache
4947 "Find element in cache starting at POS or before.
4949 POS refers to a buffer position.
4951 When optional argument SIDE is non-nil, the function checks for
4952 elements starting at or past POS instead. If SIDE is `both', the
4953 function returns a cons cell where car is the first element
4954 starting at or before POS and cdr the first element starting
4955 after POS.
4957 The function can only find elements in the synchronized part of
4958 the cache."
4962 lower upper)
4977 ;; We found an element in cache starting at POS. If `side'
4978 ;; is `both' we also want the next one in order to generate
4979 ;; a key in-between.
4980 ;;
4981 ;; If the element is the first row or item in a table or
4982 ;; a plain list, we always return the table or the plain
4983 ;; list.
4984 ;;
4985 ;; In any other case, we return the element found.
4994 lower parent
4995 upper parent)))))
4998 lower element
4999 upper element)))))
5006 "Store ELEMENT in current buffer's cache, if allowed.
5007 When optional argument DATA is non-nil, assume is it object data
5008 relative to ELEMENT and store it in the objects cache."
5012 ;; During synchronization, first build an appropriate key
5013 ;; for the new element so `avl-tree-enter' can insert it at
5014 ;; the right spot in the cache.
5023 org-element--cache-sync-keys)))
5025 ;; Headlines are not stored in cache, so objects in titles are
5026 ;; not stored either.
5031 "Remove ELEMENT from cache.
5032 Assume ELEMENT belongs to cache and that a cache is active."
5037 ;;;; Synchronization
5040 "Set idle timer for cache synchronization in BUFFER."
5047 org-element-cache-sync-idle-time))
5048 nil
5049 #'org-element--cache-sync
5050 buffer)))
5053 "Non-nil when synchronization process should be interrupted.
5054 TIME-LIMIT is a time value or nil."
5060 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5062 Properties containing buffer positions are `:begin', `:end',
5063 `:contents-begin', `:contents-end' and `:structure'. When
5064 optional argument PROPS is a list of keywords, only shift
5065 properties provided in that list.
5067 Properties are modified by side-effect."
5069 ;; Shift `:structure' property for the first plain list only: it
5070 ;; is the only one that really matters and it prevents from
5071 ;; shifting it more than once.
5085 "Synchronize cache with recent modification in BUFFER.
5087 When optional argument THRESHOLD is non-nil, do the
5088 synchronization for all elements starting before or at threshold,
5089 then exit. Otherwise, synchronize cache for as long as
5090 `org-element-cache-sync-duration' or until Emacs leaves idle
5091 state.
5093 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5094 not registered yet in the cache are going to happen. It is used
5095 in `org-element--cache-submit-request', where cache is partially
5096 updated before current modification are actually submitted."
5107 request
5109 threshold
5112 org-element-cache-sync-duration))
5113 future-change)
5114 ;; Request processed. Merge current and next offsets and
5115 ;; transfer ending position.
5121 ;; If more requests are awaiting, set idle timer accordingly.
5122 ;; Otherwise, reset keys.
5129 "Process synchronization REQUEST for all entries before NEXT.
5131 REQUEST is a vector, built by `org-element--cache-submit-request'.
5133 NEXT is a cache key, as returned by `org-element--cache-key'.
5135 When non-nil, THRESHOLD is a buffer position. Synchronization
5136 stops as soon as a shifted element begins after it.
5138 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5139 after this time or when Emacs exits idle state.
5141 When non-nil, FUTURE-CHANGE is a buffer position where changes
5142 not registered yet in the cache are going to happen. See
5143 `org-element--cache-submit-request' for more information.
5145 Throw `interrupt' if the process stops before completing the
5146 request."
5149 ;; Phase 0.
5150 ;;
5151 ;; Delete all elements starting after BEG, but not after buffer
5152 ;; position END or past element with key NEXT. Also delete
5153 ;; elements contained within a previously removed element
5154 ;; (stored in `last-container').
5155 ;;
5156 ;; At each iteration, we start again at tree root since
5157 ;; a deletion modifies structure of the balanced tree.
5162 ;; Find first element in cache with key BEG or after it.
5166 data data-key last-container)
5175 data-key key
5178 data-key key
5179 node nil)))))
5189 up)))
5192 end))
5199 ;; No element starting after modifications left in
5200 ;; cache: further processing is futile.
5203 ;; Phase 1.
5204 ;;
5205 ;; Phase 0 left a hole in the cache. Some elements after it
5206 ;; could have parents within. For example, in the following
5207 ;; buffer:
5208 ;;
5209 ;; - item
5210 ;;
5211 ;;
5212 ;; Paragraph1
5213 ;;
5214 ;; Paragraph2
5215 ;;
5216 ;; if we remove a blank line between "item" and "Paragraph1",
5217 ;; everything down to "Paragraph2" is removed from cache. But
5218 ;; the paragraph now belongs to the list, and its `:parent'
5219 ;; property no longer is accurate.
5220 ;;
5221 ;; Therefore we need to parse again elements in the hole, or at
5222 ;; least in its last section, so that we can re-parent
5223 ;; subsequent elements, during phase 2.
5224 ;;
5225 ;; Note that we only need to get the parent from the first
5226 ;; element in cache after the hole.
5227 ;;
5228 ;; When next key is lesser or equal to the current one, delegate
5229 ;; phase 1 processing to next request in order to preserve key
5230 ;; order among requests.
5238 ;; Next element will start at its beginning position plus
5239 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5240 ;; contains the real beginning position of the first element to
5241 ;; shift and re-parent.
5245 ;; Changes are going to happen around this element and
5246 ;; they will trigger another phase 1 request. Skip the
5247 ;; current one.
5253 ;; Phase 2.
5254 ;;
5255 ;; Shift all elements starting from key START, but before NEXT, by
5256 ;; OFFSET, and re-parent them when appropriate.
5257 ;;
5258 ;; Elements are modified by side-effect so the tree structure
5259 ;; remains intact.
5260 ;;
5261 ;; Once THRESHOLD, if any, is reached, or once there is an input
5262 ;; pending, exit. Before leaving, the current synchronization
5263 ;; request is updated.
5270 exit-flag)
5271 ;; No re-parenting nor shifting planned: request is over.
5281 ;; We reached NEXT. Request is complete.
5283 ;; Handle interruption request. Update current request.
5288 ;; Shift element.
5291 ;; Shift associated objects data, if any.
5296 ;; Update PARENT and re-parent DATA, only when
5297 ;; necessary. Propagate new structures for lists.
5311 ;; Cache is up-to-date past THRESHOLD. Request
5312 ;; interruption.
5317 ;; We reached end of tree: synchronization complete.
5318 t)))
5321 "Parse elements in current section, down to POS.
5323 Start parsing from the closest between the last known element in
5324 cache or headline above. Return the smallest element containing
5325 POS.
5327 When optional argument SYNCP is non-nil, return the parent of the
5328 element containing POS instead. In that case, it is also
5329 possible to provide TIME-LIMIT, which is a time value specifying
5330 when the parsing should stop. The function throws `interrupt' if
5331 the process stopped before finding the expected result."
5338 element next mode)
5340 ;; Nothing in cache before point: start parsing from first
5341 ;; element following headline above, or first element in
5342 ;; buffer.
5349 ;; Cache returned exact match: return it.
5352 ;; There's a headline between cached value and POS: cached
5353 ;; value is invalid. Start parsing from first element
5354 ;; following the headline.
5361 ;; Check if CACHED or any of its ancestors contain point.
5362 ;;
5363 ;; If there is such an element, we inspect it in order to know
5364 ;; if we return it or if we need to parse its contents.
5365 ;; Otherwise, we just start parsing from current location,
5366 ;; which is right after the top-most element containing
5367 ;; CACHED.
5368 ;;
5369 ;; As a special case, if POS is at the end of the buffer, we
5370 ;; want to return the innermost element ending there.
5371 ;;
5372 ;; Also, if we find an ancestor and discover that we need to
5373 ;; parse its contents, make sure we don't start from
5374 ;; `:contents-begin', as we would otherwise go past CACHED
5375 ;; again. Instead, in that situation, we will resume parsing
5376 ;; from NEXT, which is located after CACHED or its higher
5377 ;; ancestor not containing point.
5389 ;; Parse successively each element until we reach POS.
5402 end 'element mode
5409 ;; Skip any element ending before point. Also skip
5410 ;; element ending at point (unless it is also the end of
5411 ;; buffer) since we're sure that another element begins
5412 ;; after it.
5416 ;; A non-greater element contains point: return it.
5419 ;; Otherwise, we have to decide if ELEMENT really
5420 ;; contains POS. In that case we start parsing from
5421 ;; contents' beginning.
5422 ;;
5423 ;; If POS is at contents' beginning but it is also at
5424 ;; the beginning of the first item in a list or a table.
5425 ;; In that case, we need to create an anchor for that
5426 ;; list or table, so return it.
5427 ;;
5428 ;; Also, if POS is at the end of the buffer, no element
5429 ;; can start after it, but more than one may end there.
5430 ;; Arbitrarily, we choose to return the innermost of
5431 ;; such elements.
5444 parent element
5445 end cend))))
5446 ;; Otherwise, return ELEMENT as it is the smallest
5447 ;; element containing POS.
5452 ;;;; Staging Buffer Changes
5463 "Regexp matching a sensitive line, structure wise.
5464 A sensitive line is a headline, inlinetask, block, drawer, or
5465 latex-environment boundary. When such a line is modified,
5466 structure changes in the document may propagate in the whole
5470 "Non-nil when a sensitive line is about to be changed.
5474 "Request extension of area going to be modified if needed.
5475 BEG and END are the beginning and end of the range of changed
5476 text. See `before-change-functions' for more information."
5486 'headline
5489 org-element--cache-sensitive-re bottom t)))))))))
5492 "Update buffer modifications for current buffer.
5493 BEG and END are the beginning and end of the range of changed
5494 text, and the length in bytes of the pre-change text replaced by
5495 that range. See `after-change-functions' for more information."
5503 ;; Determine if modified area needs to be extended, according
5504 ;; to both previous and current state. We make a special
5505 ;; case for headline editing: if a headline is modified but
5506 ;; not removed, do not extend.
5509 (`headline
5515 org-element--cache-sensitive-re bottom t))))
5516 ;; Effectively extend modified area.
5524 ;; Store synchronization request.
5527 ;; Activate a timer to process the request during idle time.
5531 "Return first element to remove from cache.
5533 BEG and END are buffer positions delimiting buffer modifications.
5534 OFFSET is the size of the changes.
5536 Returned element is usually the first element in cache containing
5537 any position between BEG and END. As an exception, greater
5538 elements around the changes that are robust to contents
5539 modifications are preserved and updated according to the
5540 changes."
5550 special-block))
5551 ;; Drawers named "PROPERTIES" are probably
5552 ;; a properties drawer being edited. Force
5553 ;; parsing to check if editing is over.
5562 ;; UP is a robust greater element containing changes.
5563 ;; We only need to extend its ending boundaries.
5569 ;; We're at top level element containing ELEMENT: if it's
5570 ;; altered by buffer modifications, it is first element in
5571 ;; cache to be removed. Otherwise, that first element is the
5572 ;; following one.
5573 ;;
5574 ;; As a special case, do not remove BEFORE if it is a robust
5575 ;; container for current changes.
5577 before)))))
5580 "Submit a new cache synchronization request for current buffer.
5581 BEG and END are buffer positions delimiting the minimal area
5582 where cache data should be removed. OFFSET is the size of the
5583 change, as an integer."
5585 delete-to delete-from)
5590 ;; Current changes can be merged with first sync request: we
5591 ;; can save a partial cache synchronization.
5594 ;; If last change happened within area to be removed, extend
5595 ;; boundaries of robust parents, if any. Otherwise, find
5596 ;; first element to remove and update request accordingly.
5608 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5609 ;; if any, is no longer a 0-phase request, thus ensuring that
5610 ;; phases are properly ordered. We need to provide OFFSET as
5611 ;; optional parameter since current modifications are not known
5612 ;; yet to the otherwise correct part of the cache (i.e, before
5613 ;; the first request).
5620 ;; When changes happen before the first known
5621 ;; element, re-parent and shift the rest of the
5622 ;; cache.
5624 ;; Otherwise, we find the first non robust
5625 ;; element containing END. All elements between
5626 ;; FIRST and this one are to be removed.
5637 element up))
5639 org-element--cache-sync-requests)
5640 ;; No element to remove. No need to re-parent either.
5641 ;; Simply shift additional elements, if any, by OFFSET.
5646 ;;;; Public Functions
5648 ;;;###autoload
5650 "Reset cache in current buffer.
5651 When optional argument ALL is non-nil, reset cache in all Org
5652 buffers."
5670 ;;;###autoload
5672 "Refresh cache at position POS."
5679 \f
5680 ;;; The Toolbox
5681 ;;
5682 ;; The first move is to implement a way to obtain the smallest element
5683 ;; containing point. This is the job of `org-element-at-point'. It
5684 ;; basically jumps back to the beginning of section containing point
5685 ;; and proceed, one element after the other, with
5686 ;; `org-element--current-element' until the container is found. Note:
5687 ;; When using `org-element-at-point', secondary values are never
5688 ;; parsed since the function focuses on elements, not on objects.
5689 ;;
5690 ;; At a deeper level, `org-element-context' lists all elements and
5691 ;; objects containing point.
5692 ;;
5693 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5694 ;; internally by navigation and manipulation tools.
5697 ;;;###autoload
5699 "Determine closest element around point.
5701 Return value is a list like (TYPE PROPS) where TYPE is the type
5702 of the element and PROPS a plist of properties associated to the
5703 element.
5705 Possible types are defined in `org-element-all-elements'.
5706 Properties depend on element or object type, but always include
5707 `:begin', `:end', `:parent' and `:post-blank' properties.
5709 As a special case, if point is at the very beginning of the first
5710 item in a list or sub-list, returned element will be that list
5711 instead of the item. Likewise, if point is at the beginning of
5712 the first row of a table, returned element will be the table
5713 instead of the first row.
5715 When point is at the end of the buffer, return the innermost
5716 element ending there."
5722 ;; Within blank lines at the beginning of buffer, return nil.
5724 ;; Within blank lines right after a headline, return that
5725 ;; headline.
5729 ;; Otherwise parse until we find element containing ORIGIN.
5736 ;;;###autoload
5738 "Return smallest element or object around point.
5740 Return value is a list like (TYPE PROPS) where TYPE is the type
5741 of the element or object and PROPS a plist of properties
5742 associated to it.
5744 Possible types are defined in `org-element-all-elements' and
5745 `org-element-all-objects'. Properties depend on element or
5746 object type, but always include `:begin', `:end', `:parent' and
5747 `:post-blank'.
5749 As a special case, if point is right after an object and not at
5750 the beginning of any other object, return that object.
5752 Optional argument ELEMENT, when non-nil, is the closest element
5753 containing point, as returned by `org-element-at-point'.
5754 Providing it allows for quicker computation."
5761 ;; If point is inside an element containing objects or
5762 ;; a secondary string, narrow buffer to the container and
5763 ;; proceed with parsing. Otherwise, return ELEMENT.
5765 ;; At a parsed affiliated keyword, check if we're inside main
5766 ;; or dual value.
5772 org-element-parsed-keywords))
5781 ;; Also change type to retrieve correct restrictions.
5783 ;; At an item, objects can only be located within tag, if any.
5794 ;; At an headline or inlinetask, objects are in title.
5805 ;; At a paragraph, a table-row or a verse block, objects are
5806 ;; located within their contents.
5810 ;; CBEG is nil for table rules.
5815 ;; At a planning line, if point is at a timestamp, return it,
5816 ;; otherwise, return element.
5824 ;; All other locations cannot contain objects: bail out.
5834 next object-data last)
5838 ;; When entering PARENT for the first time, get list
5839 ;; of objects within known so far. Store it in
5840 ;; OBJECT-DATA.
5845 ;; Find NEXT object for analysis.
5847 ;; If NEXT is non-nil, we already exhausted the
5848 ;; cache so we can parse buffer to find the object
5849 ;; after it.
5851 ;; Otherwise, check if cache can help us.
5862 ;; Cache contains the information needed.
5865 pos)
5867 pos)
5873 ;; If we have a new object to analyze, store it in
5874 ;; cache. Otherwise record that there is nothing
5875 ;; more to parse in this element at this depth.
5880 ;; Process NEXT, if any, in order to know if we need
5881 ;; to skip it, return it or move into it.
5888 ;; Skip objects ending before point. Also skip
5889 ;; objects ending at point unless it is also the
5890 ;; end of buffer, since we want to return the
5891 ;; innermost object.
5894 ;; For convenience, when object ends at POS,
5895 ;; without any space, store it in LAST, as we
5896 ;; will return it if no object starts here.
5900 ;; If POS is within a container object, move
5901 ;; into that object.
5905 ;; At contents' end, if there is no
5906 ;; space before point, also move into
5907 ;; object, for consistency with
5908 ;; convenience feature above.
5917 next nil
5918 object-data nil))
5919 ;; Otherwise, return NEXT.
5921 ;; Store results in cache, if applicable.
5925 "List all ancestors of a given element or object.
5927 BLOB is an object or element.
5929 When optional argument TYPES is a list of symbols, return the
5930 first element or object in the lineage whose type belongs to that
5931 list.
5933 When optional argument WITH-SELF is non-nil, lineage includes
5934 BLOB itself as the first element, and TYPES, if provided, also
5935 apply to it.
5937 When BLOB is obtained through `org-element-context' or
5938 `org-element-at-point', only ancestors from its section can be
5939 found. There is no such limitation when BLOB belongs to a full
5940 parse tree."
5942 ancestors)
5949 "Non-nil when elements ELEM-A and ELEM-B are nested."
5958 "Swap elements ELEM-A and ELEM-B.
5959 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5960 end of ELEM-A."
5962 ;; There are two special cases when an element doesn't start at bol:
5963 ;; the first paragraph in an item or in a footnote definition.
5965 ;; Only a paragraph without any affiliated keyword can be moved at
5966 ;; ELEM-A position in such a situation. Note that the case of
5967 ;; a footnote definition is impossible: it cannot contain two
5968 ;; paragraphs in a row because it cannot contain a blank line.
5974 ;; In a special situation, ELEM-A will have no indentation. We'll
5975 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5989 ;; Store inner overlays responsible for visibility status.
5990 ;; We also need to store their boundaries as they will be
5991 ;; removed from buffer.
6006 ;; Get contents.
6014 ;; Restore ex ELEM-A overlays.
6021 ;; Restore ex ELEM-B overlays.
6026 ;; For backward-compatibility with Org <= 8.3
6033 ;; Local variables:
6034 ;; generated-autoload-file: "org-loaddefs.el"
6035 ;; End:
6037 ;;; org-element.el ends here