| blob | 6eabf7661b60f5464b342468eb2b806c35c4a680 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links in a link description.
356 ;; Also ignore radio-targets and line breaks.
358 italic latex-fragment macro plain-link statistics-cookie
359 strike-through subscript superscript underline verbatim)
361 ;; Remove any variable object from radio target as it would
362 ;; prevent it from being properly recognized.
364 subscript superscript underline superscript)
368 ;; Ignore inline babel call and inline src block as formulas are
369 ;; possible. Also ignore line breaks and statistics cookies.
371 latex-fragment link macro radio-target strike-through
372 subscript superscript target timestamp underline verbatim)
376 "Alist of objects restrictions.
378 key is an element or object type containing objects and value is
379 a list of types that can be contained within an element or object
380 of such type.
382 For example, in a `radio-target' object, one can only find
383 entities, latex-fragments, subscript, superscript and text
384 markup.
386 This alist also applies to secondary string. For example, an
387 `headline' type element doesn't directly contain objects, but
402 "Table used internally to pair only round brackets.
411 "Table used internally to pair only square brackets.
420 "Table used internally to pair only curly brackets.
424 \f
425 ;;; Accessors and Setters
426 ;;
427 ;; Provide four accessors: `org-element-type', `org-element-property'
428 ;; `org-element-contents' and `org-element-restriction'.
429 ;;
430 ;; Setter functions allow modification of elements by side effect.
431 ;; There is `org-element-put-property', `org-element-set-contents'.
432 ;; These low-level functions are useful to build a parse tree.
433 ;;
434 ;; `org-element-adopt-element', `org-element-set-element',
435 ;; `org-element-extract-element' and `org-element-insert-before' are
436 ;; high-level functions useful to modify a parse tree.
437 ;;
438 ;; `org-element-secondary-p' is a predicate used to know if a given
439 ;; object belongs to a secondary string. `org-element-copy' returns
440 ;; an element or object, stripping its parent property in the process.
443 "Return type of ELEMENT.
445 The function returns the type of the element or object provided.
446 It can also return the following special value:
447 `plain-text' for a string
448 `org-data' for a complete document
449 nil in any other case."
455 "Extract the value from the PROPERTY of an ELEMENT."
460 "Extract contents from an ELEMENT."
466 "Return restriction associated to ELEMENT.
467 ELEMENT can be an element, an object or a symbol representing an
468 element or object type."
470 org-element-object-restrictions)))
473 "In ELEMENT set PROPERTY to VALUE.
474 Return modified element."
477 element))
480 "Set ELEMENT's contents to CONTENTS.
481 Return ELEMENT."
488 "Non-nil when OBJECT directly belongs to a secondary string.
489 Return value is the property name, as a keyword, or nil."
492 org-element-secondary-value-alist))))
499 "Append elements to the contents of another element.
501 PARENT is an element or object. CHILDREN can be elements,
502 objects, or a strings.
504 The function takes care of setting `:parent' property for CHILD.
505 Return parent element."
507 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
508 ;; string: parent is the list itself.
511 ;; Add CHILDREN at the end of PARENT contents.
514 parent
516 ;; Return modified PARENT element.
520 "Extract ELEMENT from parse tree.
521 Remove element from the parse tree by side-effect, and return it
522 with its `:parent' property stripped out."
527 parent secondary
530 parent
532 ;; Return ELEMENT with its :parent removed.
536 "Insert ELEMENT before LOCATION in parse tree.
537 LOCATION is an element, object or string within the parse tree.
538 Parse tree is modified by side effect."
543 ;; Special case: LOCATION is the first element of an
544 ;; independent secondary string (e.g. :title property). Add
545 ;; ELEMENT in-place.
549 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
559 ;; Store SIBLINGS at appropriate place in parse tree.
564 ;; Set appropriate :parent property.
568 "Replace element or object OLD with element or object NEW.
569 The function takes care of setting `:parent' property for NEW."
570 ;; Ensure OLD and NEW have the same parent.
574 ;; We cannot replace OLD with NEW since one of them is not an
575 ;; object or element. We take the long path.
578 ;; Since OLD is going to be changed into NEW by side-effect, first
579 ;; make sure that every element or object within NEW has OLD as
580 ;; parent.
583 ;; Transfer contents.
585 ;; Overwrite OLD's properties with NEW's.
587 ;; Transfer type.
591 "Create a new element of type TYPE.
592 Optional argument PROPS, when non-nil, is a plist defining the
593 properties of the element. CHILDREN can be elements, objects or
594 strings."
598 "Return a copy of DATUM.
599 DATUM is an element, object, string or nil. `:parent' property
600 is cleared and contents are removed in the process."
611 \f
612 ;;; Greater elements
613 ;;
614 ;; For each greater element type, we define a parser and an
615 ;; interpreter.
616 ;;
617 ;; A parser returns the element or object as the list described above.
618 ;; Most of them accepts no argument. Though, exceptions exist. Hence
619 ;; every element containing a secondary string (see
620 ;; `org-element-secondary-value-alist') will accept an optional
621 ;; argument to toggle parsing of these secondary strings. Moreover,
622 ;; `item' parser requires current list's structure as its first
623 ;; element.
624 ;;
625 ;; An interpreter accepts two arguments: the list representation of
626 ;; the element or object, and its contents. The latter may be nil,
627 ;; depending on the element or object considered. It returns the
628 ;; appropriate Org syntax, as a string.
629 ;;
630 ;; Parsing functions must follow the naming convention:
631 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
632 ;; defined in `org-element-greater-elements'.
633 ;;
634 ;; Similarly, interpreting functions must follow the naming
635 ;; convention: org-element-TYPE-interpreter.
636 ;;
637 ;; With the exception of `headline' and `item' types, greater elements
638 ;; cannot contain other greater elements of their own type.
639 ;;
640 ;; Beside implementing a parser and an interpreter, adding a new
641 ;; greater element requires tweaking `org-element--current-element'.
642 ;; Moreover, the newly defined type must be added to both
643 ;; `org-element-all-elements' and `org-element-greater-elements'.
646 ;;;; Center Block
649 "Parse a center block.
651 LIMIT bounds the search. AFFILIATED is a list of which CAR is
652 the buffer position at the beginning of the first affiliated
653 keyword and CDR is a plist of affiliated keywords along with
654 their value.
656 Return a list whose CAR is `center-block' and CDR is a plist
657 containing `:begin', `:end', `:contents-begin', `:contents-end',
658 `:post-blank' and `:post-affiliated' keywords.
660 Assume point is at the beginning of the block."
664 ;; Incomplete block: parse it as a paragraph.
669 ;; Empty blocks have no contents.
683 :end end
684 :contents-begin contents-begin
685 :contents-end contents-end
691 "Interpret a center-block element as Org syntax.
692 CONTENTS is the contents of the element."
696 ;;;; Drawer
699 "Parse a drawer.
701 LIMIT bounds the search. AFFILIATED is a list of which CAR is
702 the buffer position at the beginning of the first affiliated
703 keyword and CDR is a plist of affiliated keywords along with
704 their value.
706 Return a list whose CAR is `drawer' and CDR is a plist containing
707 `:drawer-name', `:begin', `:end', `:contents-begin',
708 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
710 Assume point is at beginning of drawer."
713 ;; Incomplete drawer: parse it as a paragraph.
721 ;; Empty drawers have no contents.
734 :end end
735 :drawer-name name
736 :contents-begin contents-begin
737 :contents-end contents-end
743 "Interpret DRAWER element as Org syntax.
744 CONTENTS is the contents of the element."
747 contents))
750 ;;;; Dynamic Block
753 "Parse a dynamic block.
755 LIMIT bounds the search. AFFILIATED is a list of which CAR is
756 the buffer position at the beginning of the first affiliated
757 keyword and CDR is a plist of affiliated keywords along with
758 their value.
760 Return a list whose CAR is `dynamic-block' and CDR is a plist
761 containing `:block-name', `:begin', `:end', `:contents-begin',
762 `:contents-end', `:arguments', `:post-blank' and
763 `:post-affiliated' keywords.
765 Assume point is at beginning of dynamic block."
769 ;; Incomplete block: parse it as a paragraph.
778 ;; Empty blocks have no contents.
791 :end end
792 :block-name name
793 :arguments arguments
794 :contents-begin contents-begin
795 :contents-end contents-end
801 "Interpret DYNAMIC-BLOCK element as Org syntax.
802 CONTENTS is the contents of the element."
807 contents))
810 ;;;; Footnote Definition
819 "Parse a footnote definition.
821 LIMIT bounds the search. AFFILIATED is a list of which CAR is
822 the buffer position at the beginning of the first affiliated
823 keyword and CDR is a plist of affiliated keywords along with
824 their value.
826 Return a list whose CAR is `footnote-definition' and CDR is
827 a plist containing `:label', `:begin' `:end', `:contents-begin',
828 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
830 Assume point is at the beginning of the footnote definition."
842 limit)
844 ;; At a new footnote definition, make sure we end
845 ;; before any affiliated keyword above.
866 :begin begin
867 :end end
868 :contents-begin contents-begin
869 :contents-end contents-end
875 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
876 CONTENTS is the contents of the footnote-definition."
878 " "
879 contents))
882 ;;;; Headline
885 "Return node properties associated to headline at point.
886 Upcase property names. It avoids confusion between properties
887 obtained through property drawer and default properties from the
888 parser (e.g. `:end' and :END:). Return value is a plist."
900 properties))))
903 "Return time properties associated to headline at point.
904 Return value is a plist."
918 plist))))
921 "Parse a headline.
923 Return a list whose CAR is `headline' and CDR is a plist
924 containing `:raw-value', `:title', `:begin', `:end',
925 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
926 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
927 `:deadline', `:closed', `:archivedp', `:commentedp'
928 `:footnote-section-p', `:post-blank' and `:post-affiliated'
929 keywords.
931 The plist also contains any property set in the property drawer,
932 with its name in upper cases and colons added at the
933 beginning (e.g., `:CUSTOM_ID').
935 LIMIT is a buffer position bounding the search.
937 When RAW-SECONDARY-P is non-nil, headline's title will not be
938 parsed as a secondary string, but as a plain string instead.
940 Assume point is at beginning of the headline."
987 :begin begin
988 :end end
989 :pre-blank
992 :contents-begin contents-begin
993 :contents-end contents-end
994 :level level
995 :priority priority
996 :tags tags
997 :todo-keyword todo
998 :todo-type todo-type
1001 end)
1002 :footnote-section-p footnote-section-p
1003 :archivedp archivedp
1004 :commentedp commentedp
1006 time-props
1007 standard-props))))
1009 headline :title
1018 nil
1020 headline)))))))
1023 "Interpret HEADLINE element as Org syntax.
1024 CONTENTS is the contents of the element."
1037 ?*)
1041 " "
1044 org-footnote-section
1045 title))))
1047 heading
1048 ;; Align tags.
1056 ?\s)
1057 tags))
1061 tags))))
1063 contents)))
1066 ;;;; Inlinetask
1069 "Parse an inline task.
1071 Return a list whose CAR is `inlinetask' and CDR is a plist
1072 containing `:title', `:begin', `:end', `:contents-begin' and
1073 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1074 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1075 `:closed', `:post-blank' and `:post-affiliated' keywords.
1077 The plist also contains any property set in the property drawer,
1078 with its name in upper cases and colons added at the
1079 beginning (e.g., `:CUSTOM_ID').
1081 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1082 title will not be parsed as a secondary string, but as a plain
1083 string instead.
1085 Assume point is at beginning of the inline task."
1130 :begin begin
1131 :end end
1132 :contents-begin contents-begin
1133 :contents-end contents-end
1134 :level level
1135 :priority priority
1136 :tags tags
1137 :todo-keyword todo
1138 :todo-type todo-type
1141 time-props
1142 standard-props))))
1144 inlinetask :title
1153 nil
1155 inlinetask))))))
1158 "Interpret INLINETASK element as Org syntax.
1159 CONTENTS is the contents of inlinetask."
1173 ;; Align tags.
1181 ? )
1182 tags))
1186 tags))))
1187 ;; Prefer degenerate inlinetasks when there are no
1188 ;; contents.
1191 contents
1195 ;;;; Item
1198 "Parse an item.
1200 STRUCT is the structure of the plain list.
1202 Return a list whose CAR is `item' and CDR is a plist containing
1203 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1204 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1205 `:post-affiliated' keywords.
1207 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1208 any, will not be parsed as a secondary string, but as a plain
1209 string instead.
1211 Assume point is at the beginning of the item."
1234 ;; Ignore tags in un-ordered lists: they are just
1235 ;; a part of item's body.
1242 ;; If first line isn't empty, contents really
1243 ;; start at the text after item's meta-data.
1253 :begin begin
1254 :end end
1255 :contents-begin contents-begin
1256 :contents-end contents-end
1257 :checkbox checkbox
1258 :counter counter
1259 :structure struct
1263 item :tag
1270 item))))))))
1273 "Interpret ITEM element as Org syntax.
1274 CONTENTS is the contents of the element."
1284 ;; Compute indentation.
1289 ;; Indent contents.
1291 bullet
1306 ;;;; Plain List
1309 ;; Return structure of list at point. Internal function. See
1310 ;; `org-list-struct' for details.
1315 items struct)
1320 ;; At limit: end all items.
1329 ;; At list end: end all items.
1334 ;; At a new item: end previous sibling.
1346 ind
1347 bullet
1350 ;; Description tag.
1354 ;; Ending position, unknown so far.
1355 nil)))
1356 items))
1358 ;; Skip empty lines.
1360 ;; Skip inline tasks and blank lines along the way.
1367 ;; At some text line. Check if it ends any previous item.
1380 ;; Skip blocks (any type) and drawers contents.
1385 limit t)))
1391 "Parse a plain list.
1393 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1394 the buffer position at the beginning of the first affiliated
1395 keyword and CDR is a plist of affiliated keywords along with
1396 their value. STRUCTURE is the structure of the plain list being
1397 parsed.
1399 Return a list whose CAR is `plain-list' and CDR is a plist
1400 containing `:type', `:begin', `:end', `:contents-begin' and
1401 `:contents-end', `:structure', `:post-blank' and
1402 `:post-affiliated' keywords.
1404 Assume point is at the beginning of the list."
1418 pos))
1422 ;; Return value.
1426 :begin begin
1427 :end end
1428 :contents-begin contents-begin
1429 :contents-end contents-end
1430 :structure struct
1436 "Interpret plain-list element as Org syntax.
1437 CONTENTS is the contents of the element."
1445 ;;;; Property Drawer
1448 "Parse a property drawer.
1450 LIMIT bounds the search.
1452 Return a list whose car is `property-drawer' and cdr is a plist
1453 containing `:begin', `:end', `:contents-begin', `:contents-end',
1454 `:post-blank' and `:post-affiliated' keywords.
1456 Assume point is at the beginning of the property drawer."
1469 :end end
1471 :contents-end contents-end
1476 "Interpret property-drawer element as Org syntax.
1477 CONTENTS is the properties within the drawer."
1481 ;;;; Quote Block
1484 "Parse a quote block.
1486 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1487 the buffer position at the beginning of the first affiliated
1488 keyword and CDR is a plist of affiliated keywords along with
1489 their value.
1491 Return a list whose CAR is `quote-block' and CDR is a plist
1492 containing `:begin', `:end', `:contents-begin', `:contents-end',
1493 `:post-blank' and `:post-affiliated' keywords.
1495 Assume point is at the beginning of the block."
1499 ;; Incomplete block: parse it as a paragraph.
1505 ;; Empty blocks have no contents.
1518 :end end
1519 :contents-begin contents-begin
1520 :contents-end contents-end
1526 "Interpret quote-block element as Org syntax.
1527 CONTENTS is the contents of the element."
1531 ;;;; Section
1534 "Parse a section.
1536 Return a list whose CAR is `section' and CDR is a plist
1537 containing `:begin', `:end', `:contents-begin', `contents-end',
1538 `:post-blank' and `:post-affiliated' keywords."
1540 ;; Beginning of section is the beginning of the first non-blank
1541 ;; line after previous headline.
1549 :end end
1550 :contents-begin begin
1551 :contents-end pos-before-blank
1556 "Interpret section element as Org syntax.
1557 CONTENTS is the contents of the element."
1558 contents)
1561 ;;;; Special Block
1564 "Parse a special block.
1566 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1567 the buffer position at the beginning of the first affiliated
1568 keyword and CDR is a plist of affiliated keywords along with
1569 their value.
1571 Return a list whose CAR is `special-block' and CDR is a plist
1572 containing `:type', `:begin', `:end', `:contents-begin',
1573 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1575 Assume point is at the beginning of the block."
1582 limit t)))
1583 ;; Incomplete block: parse it as a paragraph.
1589 ;; Empty blocks have no contents.
1602 :begin begin
1603 :end end
1604 :contents-begin contents-begin
1605 :contents-end contents-end
1611 "Interpret SPECIAL-BLOCK element as Org syntax.
1612 CONTENTS is the contents of the element."
1617 \f
1618 ;;; Elements
1619 ;;
1620 ;; For each element, a parser and an interpreter are also defined.
1621 ;; Both follow the same naming convention used for greater elements.
1622 ;;
1623 ;; Also, as for greater elements, adding a new element type is done
1624 ;; through the following steps: implement a parser and an interpreter,
1625 ;; tweak `org-element--current-element' so that it recognizes the new
1626 ;; type and add that new type to `org-element-all-elements'.
1629 ;;;; Babel Call
1632 "Parse a babel call.
1634 LIMIT bounds the search. AFFILIATED is a list of which car is
1635 the buffer position at the beginning of the first affiliated
1636 keyword and cdr is a plist of affiliated keywords along with
1637 their value.
1639 Return a list whose car is `babel-call' and cdr is a plist
1640 containing `:call', `:inside-header', `:arguments',
1641 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1642 `:post-affiliated' as keywords."
1656 value)))
1666 :begin begin
1667 :end end
1668 :value value
1674 "Interpret BABEL-CALL element as Org syntax."
1684 ;;;; Clock
1687 "Parse a clock.
1689 LIMIT bounds the search.
1691 Return a list whose CAR is `clock' and CDR is a plist containing
1692 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1693 `:post-affiliated' as keywords."
1713 :value value
1714 :duration duration
1715 :begin begin
1716 :end end
1717 :post-blank post-blank
1721 "Interpret CLOCK element as Org syntax."
1729 "%2s:%02s"
1733 ;;;; Comment
1736 "Parse a comment.
1738 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1739 the buffer position at the beginning of the first affiliated
1740 keyword and CDR is a plist of affiliated keywords along with
1741 their value.
1743 Return a list whose CAR is `comment' and CDR is a plist
1744 containing `:begin', `:end', `:value', `:post-blank',
1745 `:post-affiliated' keywords.
1747 Assume point is at comment beginning."
1756 ;; Get comments ending.
1759 ;; Accumulate lines without leading hash and first
1760 ;; whitespace.
1774 :end end
1775 :value value
1781 "Interpret COMMENT element as Org syntax.
1782 CONTENTS is nil."
1786 ;;;; Comment Block
1789 "Parse an export block.
1791 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1792 the buffer position at the beginning of the first affiliated
1793 keyword and CDR is a plist of affiliated keywords along with
1794 their value.
1796 Return a list whose CAR is `comment-block' and CDR is a plist
1797 containing `:begin', `:end', `:value', `:post-blank' and
1798 `:post-affiliated' keywords.
1800 Assume point is at comment block beginning."
1804 ;; Incomplete block: parse it as a paragraph.
1817 contents-begin contents-end)))
1821 :end end
1822 :value value
1828 "Interpret COMMENT-BLOCK element as Org syntax."
1835 ;;;; Diary Sexp
1838 "Parse a diary sexp.
1840 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1841 the buffer position at the beginning of the first affiliated
1842 keyword and CDR is a plist of affiliated keywords along with
1843 their value.
1845 Return a list whose CAR is `diary-sexp' and CDR is a plist
1846 containing `:begin', `:end', `:value', `:post-blank' and
1847 `:post-affiliated' keywords."
1859 :begin begin
1860 :end end
1866 "Interpret DIARY-SEXP as Org syntax."
1870 ;;;; Example Block
1873 "Parse an example block.
1875 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1876 the buffer position at the beginning of the first affiliated
1877 keyword and CDR is a plist of affiliated keywords along with
1878 their value.
1880 Return a list whose CAR is `example-block' and CDR is a plist
1881 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1882 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1883 `:value', `:post-blank' and `:post-affiliated' keywords."
1887 ;; Incomplete block: parse it as a paragraph.
1895 ;; Switches analysis
1902 ;; Should labels be retained in (or stripped from) example
1903 ;; blocks?
1908 ;; What should code-references use - labels or
1909 ;; line-numbers?
1918 ;; Standard block parsing.
1924 contents-begin contents-end)))
1933 :end end
1934 :value value
1935 :switches switches
1936 :number-lines number-lines
1937 :preserve-indent preserve-indent
1938 :retain-labels retain-labels
1939 :use-labels use-labels
1940 :label-fmt label-fmt
1946 "Interpret EXAMPLE-BLOCK element as Org syntax."
1954 value
1959 ;;;; Export Block
1962 "Parse an export block.
1964 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1965 the buffer position at the beginning of the first affiliated
1966 keyword and CDR is a plist of affiliated keywords along with
1967 their value.
1969 Return a list whose CAR is `export-block' and CDR is a plist
1970 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1971 `:post-affiliated' keywords.
1973 Assume point is at export-block beginning."
1977 ;; Incomplete block: parse it as a paragraph.
1995 contents-end)))
1999 :begin begin
2000 :end end
2001 :value value
2007 "Interpret EXPORT-BLOCK element as Org syntax."
2013 ;;;; Fixed-width
2016 "Parse a fixed-width section.
2018 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2019 the buffer position at the beginning of the first affiliated
2020 keyword and CDR is a plist of affiliated keywords along with
2021 their value.
2023 Return a list whose CAR is `fixed-width' and CDR is a plist
2024 containing `:begin', `:end', `:value', `:post-blank' and
2025 `:post-affiliated' keywords.
2027 Assume point is at the beginning of the fixed-width area."
2031 value
2036 ;; Accumulate text without starting colons.
2049 :end end
2050 :value value
2056 "Interpret FIXED-WIDTH element as Org syntax."
2064 ;;;; Horizontal Rule
2067 "Parse an horizontal rule.
2069 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2070 the buffer position at the beginning of the first affiliated
2071 keyword and CDR is a plist of affiliated keywords along with
2072 their value.
2074 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2075 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2076 keywords."
2086 :end end
2092 "Interpret HORIZONTAL-RULE element as Org syntax."
2096 ;;;; Keyword
2099 "Parse a keyword at point.
2101 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2102 the buffer position at the beginning of the first affiliated
2103 keyword and CDR is a plist of affiliated keywords along with
2104 their value.
2106 Return a list whose CAR is `keyword' and CDR is a plist
2107 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2108 `:post-affiliated' keywords."
2110 ;; An orphaned affiliated keyword is considered as a regular
2111 ;; keyword. In this case AFFILIATED is nil, so we take care of
2112 ;; this corner case.
2125 :value value
2126 :begin begin
2127 :end end
2133 "Interpret KEYWORD element as Org syntax."
2139 ;;;; Latex Environment
2143 "Regexp matching the beginning of a LaTeX environment.
2144 The environment is captured by the first group.
2150 "Format string matching the ending of a LaTeX environment.
2154 "Parse a LaTeX environment.
2156 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2157 the buffer position at the beginning of the first affiliated
2158 keyword and CDR is a plist of affiliated keywords along with
2159 their value.
2161 Return a list whose CAR is `latex-environment' and CDR is a plist
2162 containing `:begin', `:end', `:value', `:post-blank' and
2163 `:post-affiliated' keywords.
2165 Assume point is at the beginning of the latex environment."
2172 limit t))
2173 ;; Incomplete latex environment: parse it as a paragraph.
2183 :end end
2184 :value value
2190 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2194 ;;;; Node Property
2197 "Parse a node-property at point.
2199 LIMIT bounds the search.
2201 Return a list whose CAR is `node-property' and CDR is a plist
2202 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2203 `:post-affiliated' keywords."
2213 limit))))
2216 :value value
2217 :begin begin
2218 :end end
2223 "Interpret NODE-PROPERTY element as Org syntax."
2229 ;;;; Paragraph
2232 "Parse a paragraph.
2234 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2235 the buffer position at the beginning of the first affiliated
2236 keyword and CDR is a plist of affiliated keywords along with
2237 their value.
2239 Return a list whose CAR is `paragraph' and CDR is a plist
2240 containing `:begin', `:end', `:contents-begin' and
2241 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2243 Assume point is at the beginning of the paragraph."
2250 ;; A matching `org-element-paragraph-separate' is not
2251 ;; necessarily the end of the paragraph. In particular,
2252 ;; drawers, blocks or LaTeX environments opening lines
2253 ;; must be closed. Moreover keywords with a secondary
2254 ;; value must belong to "dual keywords".
2268 limit t)))
2274 limit t)))
2277 org-element-dual-keywords))
2278 ;; Everything else is unambiguous.
2291 :end end
2292 :contents-begin contents-begin
2293 :contents-end contents-end
2299 "Interpret paragraph element as Org syntax.
2300 CONTENTS is the contents of the element."
2301 contents)
2304 ;;;; Planning
2307 "Parse a planning.
2309 LIMIT bounds the search.
2311 Return a list whose CAR is `planning' and CDR is a plist
2312 containing `:closed', `:deadline', `:scheduled', `:begin',
2313 `:end', `:post-blank' and `:post-affiliated' keywords."
2323 closed deadline scheduled)
2335 :deadline deadline
2336 :scheduled scheduled
2337 :begin begin
2338 :end end
2339 :post-blank post-blank
2343 "Interpret PLANNING element as Org syntax."
2345 #'identity
2362 ;;;; Src Block
2365 "Parse a src block.
2367 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2368 the buffer position at the beginning of the first affiliated
2369 keyword and CDR is a plist of affiliated keywords along with
2370 their value.
2372 Return a list whose CAR is `src-block' and CDR is a plist
2373 containing `:language', `:switches', `:parameters', `:begin',
2374 `:end', `:number-lines', `:retain-labels', `:use-labels',
2375 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2376 `:post-affiliated' keywords.
2378 Assume point is at the beginning of the block."
2381 limit t)))
2382 ;; Incomplete block: parse it as a paragraph.
2388 ;; Get language as a string.
2397 ;; Get switches.
2399 ;; Get parameters.
2401 ;; Switches analysis
2412 ;; Should labels be retained in (or stripped from)
2413 ;; src blocks?
2418 ;; What should code-references use - labels or
2419 ;; line-numbers?
2424 ;; Retrieve code.
2431 ;; Get position after ending blank lines.
2441 :begin begin
2442 :end end
2443 :number-lines number-lines
2444 :preserve-indent preserve-indent
2445 :retain-labels retain-labels
2446 :use-labels use-labels
2447 :label-fmt label-fmt
2448 :value value
2454 "Interpret SRC-BLOCK element as Org syntax."
2463 val)
2478 ;;;; Table
2481 "Parse a table at point.
2483 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2484 the buffer position at the beginning of the first affiliated
2485 keyword and CDR is a plist of affiliated keywords along with
2486 their value.
2488 Return a list whose CAR is `table' and CDR is a plist containing
2489 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2490 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2491 keywords.
2493 Assume point is at the beginning of the table."
2509 acc))
2516 :end end
2517 :type type
2518 :tblfm tblfm
2519 ;; Only `org' tables have contents. `table.el' tables
2520 ;; use a `:value' property to store raw table as
2521 ;; a string.
2526 table-begin table-end))
2532 "Interpret TABLE element as Org syntax.
2533 CONTENTS is a string, if table's type is `org', or nil."
2544 ;;;; Table Row
2547 "Parse table row at point.
2549 Return a list whose CAR is `table-row' and CDR is a plist
2550 containing `:begin', `:end', `:contents-begin', `:contents-end',
2551 `:type', `:post-blank' and `:post-affiliated' keywords."
2555 ;; A table rule has no contents. In that case, ensure
2556 ;; CONTENTS-BEGIN matches CONTENTS-END.
2566 :begin begin
2567 :end end
2568 :contents-begin contents-begin
2569 :contents-end contents-end
2574 "Interpret TABLE-ROW element as Org syntax.
2575 CONTENTS is the contents of the table row."
2580 ;;;; Verse Block
2583 "Parse a verse block.
2585 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2586 the buffer position at the beginning of the first affiliated
2587 keyword and CDR is a plist of affiliated keywords along with
2588 their value.
2590 Return a list whose CAR is `verse-block' and CDR is a plist
2591 containing `:begin', `:end', `:contents-begin', `:contents-end',
2592 `:post-blank' and `:post-affiliated' keywords.
2594 Assume point is at beginning of the block."
2598 ;; Incomplete block: parse it as a paragraph.
2613 :end end
2614 :contents-begin contents-begin
2615 :contents-end contents-end
2621 "Interpret verse-block element as Org syntax.
2622 CONTENTS is verse block contents."
2626 \f
2627 ;;; Objects
2628 ;;
2629 ;; Unlike to elements, raw text can be found between objects. Hence,
2630 ;; `org-element--object-lex' is provided to find the next object in
2631 ;; buffer.
2632 ;;
2633 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2634 ;; object types they can contain will be specified in
2635 ;; `org-element-object-restrictions'.
2636 ;;
2637 ;; Creating a new type of object requires to alter
2638 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2639 ;; new type in `org-element-all-objects', and possibly add
2640 ;; restrictions in `org-element-object-restrictions'.
2642 ;;;; Bold
2645 "Parse bold object at point, if any.
2647 When at a bold object, return a list whose car is `bold' and cdr
2648 is a plist with `:begin', `:end', `:contents-begin' and
2649 `:contents-end' and `:post-blank' keywords. Otherwise, return
2650 nil.
2652 Assume point is at the first star marker."
2664 :end end
2665 :contents-begin contents-begin
2666 :contents-end contents-end
2670 "Interpret bold object as Org syntax.
2671 CONTENTS is the contents of the object."
2675 ;;;; Code
2678 "Parse code object at point, if any.
2680 When at a code object, return a list whose car is `code' and cdr
2681 is a plist with `:value', `:begin', `:end' and `:post-blank'
2682 keywords. Otherwise, return nil.
2684 Assume point is at the first tilde marker."
2695 :begin begin
2696 :end end
2700 "Interpret CODE object as Org syntax."
2704 ;;;; Entity
2707 "Parse entity at point, if any.
2709 When at an entity, return a list whose car is `entity' and cdr
2710 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2711 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2712 `:post-blank' as keywords. Otherwise, return nil.
2714 Assume point is at the beginning of the entity."
2716 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2734 :begin begin
2735 :end end
2736 :use-brackets-p bracketsp
2740 "Interpret ENTITY object as Org syntax."
2746 ;;;; Export Snippet
2749 "Parse export snippet at point.
2751 When at an export snippet, return a list whose car is
2752 `export-snippet' and cdr a plist with `:begin', `:end',
2753 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2754 return nil.
2756 Assume point is at the beginning of the snippet."
2772 :value value
2773 :begin begin
2774 :end end
2778 "Interpret EXPORT-SNIPPET object as Org syntax."
2784 ;;;; Footnote Reference
2787 "Parse footnote reference at point, if any.
2789 When at a footnote reference, return a list whose car is
2790 `footnote-reference' and cdr a plist with `:label', `:type',
2791 `:begin', `:end', `:content-begin', `:contents-end' and
2792 `:post-blank' as keywords. Otherwise, return nil."
2808 :type type
2809 :begin begin
2810 :end end
2816 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2817 CONTENTS is its definition, when inline, or nil."
2823 ;;;; Inline Babel Call
2826 "Parse inline babel call at point, if any.
2828 When at an inline babel call, return a list whose car is
2829 `inline-babel-call' and cdr a plist with `:call',
2830 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2831 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2833 Assume point is at the beginning of the babel call."
2849 ;; Invalid inline source block.
2867 :inside-header inside-header
2868 :arguments arguments
2869 :end-header end-header
2870 :begin begin
2871 :end end
2872 :value value
2876 "Interpret INLINE-BABEL-CALL object as Org syntax."
2886 ;;;; Inline Src Block
2889 "Parse inline source block at point, if any.
2891 When at an inline source block, return a list whose car is
2892 `inline-src-block' and cdr a plist with `:begin', `:end',
2893 `:language', `:value', `:parameters' and `:post-blank' as
2894 keywords. Otherwise, return nil.
2896 Assume point is at the beginning of the inline src block."
2912 ;; Invalid inline source block.
2920 :value value
2921 :parameters parameters
2922 :begin begin
2927 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2932 language
2934 body)))
2936 ;;;; Italic
2939 "Parse italic object at point, if any.
2941 When at an italic object, return a list whose car is `italic' and
2942 cdr is a plist with `:begin', `:end', `:contents-begin' and
2943 `:contents-end' and `:post-blank' keywords. Otherwise, return
2944 nil.
2946 Assume point is at the first slash marker."
2958 :end end
2959 :contents-begin contents-begin
2960 :contents-end contents-end
2964 "Interpret italic object as Org syntax.
2965 CONTENTS is the contents of the object."
2969 ;;;; Latex Fragment
2972 "Parse LaTeX fragment at point, if any.
2974 When at a LaTeX fragment, return a list whose car is
2975 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2976 and `:post-blank' as keywords. Otherwise, return nil.
2978 Assume point is at the beginning of the LaTeX fragment."
2996 ;; Macro.
3006 :begin begin
3007 :end end
3011 "Interpret LATEX-FRAGMENT object as Org syntax."
3014 ;;;; Line Break
3017 "Parse line break at point, if any.
3019 When at a line break, return a list whose car is `line-break',
3020 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3021 Otherwise, return nil.
3023 Assume point is at the beginning of the line break."
3032 "Interpret LINE-BREAK object as Org syntax."
3036 ;;;; Link
3039 "Parse link at point, if any.
3041 When at a link, return a list whose car is `link' and cdr a plist
3042 with `:type', `:path', `:raw-link', `:application',
3043 `:search-option', `:begin', `:end', `:contents-begin',
3044 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3045 nil.
3047 Assume point is at the beginning of the link."
3050 end contents-begin contents-end link-end post-blank path type
3051 raw-link search-option application)
3053 ;; Type 1: Text targeted from a radio target.
3062 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3067 ;; RAW-LINK is the original link. Expand any
3068 ;; abbreviation in it.
3069 ;;
3070 ;; Also treat any newline character and associated
3071 ;; indentation as a single space character. This is not
3072 ;; compatible with RFC 3986, which requires to ignore
3073 ;; them altogether. However, doing so would require
3074 ;; users to encode spaces on the fly when writing links
3075 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3076 ;; [[shell:ls *.org]], which defeats Org's focus on
3077 ;; simplicity.
3082 ;; Determine TYPE of link and set PATH accordingly. According
3083 ;; to RFC 3986, remove whitespaces from URI in external links.
3084 ;; In internal ones, treat indentation as a single space.
3086 ;; File type.
3091 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3095 ;; Id type: PATH is the id.
3098 ;; Code-ref type: PATH is the name of the reference.
3103 ;; Custom-id type: PATH is the name of the custom id.
3107 ;; Fuzzy type: Internal link either matches a target, an
3108 ;; headline name or nothing. PATH is the target or
3109 ;; headline's name.
3113 ;; Type 3: Plain link, e.g., http://orgmode.org
3119 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3120 ;; bracket links, follow RFC 3986 and remove any extra
3121 ;; whitespace in URI.
3131 ;; In any case, deduce end point after trailing white space from
3132 ;; LINK-END variable.
3137 ;; Special "file" type link processing. Extract opening
3138 ;; application and search option, if any. Also normalize URI.
3145 ;; Translate link, if `org-link-translation-function' is set.
3153 :path path
3155 :application application
3156 :search-option search-option
3157 :begin begin
3158 :end end
3159 :contents-begin contents-begin
3160 :contents-end contents-end
3164 "Interpret LINK object as Org syntax.
3165 CONTENTS is the contents of the object, or nil."
3176 path
3183 ;;;; Macro
3186 "Parse macro at point, if any.
3188 When at a macro, return a list whose car is `macro' and cdr
3189 a plist with `:key', `:args', `:begin', `:end', `:value' and
3190 `:post-blank' as keywords. Otherwise, return nil.
3192 Assume point is at the macro."
3205 :value value
3206 :args args
3207 :begin begin
3208 :end end
3212 "Interpret MACRO object as Org syntax."
3216 ;;;; Radio-target
3219 "Parse radio target at point, if any.
3221 When at a radio target, return a list whose car is `radio-target'
3222 and cdr a plist with `:begin', `:end', `:contents-begin',
3223 `:contents-end', `:value' and `:post-blank' as keywords.
3224 Otherwise, return nil.
3226 Assume point is at the radio target."
3238 :end end
3239 :contents-begin contents-begin
3240 :contents-end contents-end
3241 :post-blank post-blank
3245 "Interpret target object as Org syntax.
3246 CONTENTS is the contents of the object."
3250 ;;;; Statistics Cookie
3253 "Parse statistics cookie at point, if any.
3255 When at a statistics cookie, return a list whose car is
3256 `statistics-cookie', and cdr a plist with `:begin', `:end',
3257 `:value' and `:post-blank' keywords. Otherwise, return nil.
3259 Assume point is at the beginning of the statistics-cookie."
3270 :end end
3271 :value value
3275 "Interpret STATISTICS-COOKIE object as Org syntax."
3279 ;;;; Strike-Through
3282 "Parse strike-through object at point, if any.
3284 When at a strike-through object, return a list whose car is
3285 `strike-through' and cdr is a plist with `:begin', `:end',
3286 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3287 Otherwise, return nil.
3289 Assume point is at the first plus sign marker."
3301 :end end
3302 :contents-begin contents-begin
3303 :contents-end contents-end
3307 "Interpret strike-through object as Org syntax.
3308 CONTENTS is the contents of the object."
3312 ;;;; Subscript
3315 "Parse subscript at point, if any.
3317 When at a subscript object, return a list whose car is
3318 `subscript' and cdr a plist with `:begin', `:end',
3319 `:contents-begin', `:contents-end', `:use-brackets-p' and
3320 `:post-blank' as keywords. Otherwise, return nil.
3322 Assume point is at the underscore."
3336 :end end
3337 :use-brackets-p bracketsp
3338 :contents-begin contents-begin
3339 :contents-end contents-end
3343 "Interpret SUBSCRIPT object as Org syntax.
3344 CONTENTS is the contents of the object."
3347 contents))
3350 ;;;; Superscript
3353 "Parse superscript at point, if any.
3355 When at a superscript object, return a list whose car is
3356 `superscript' and cdr a plist with `:begin', `:end',
3357 `:contents-begin', `:contents-end', `:use-brackets-p' and
3358 `:post-blank' as keywords. Otherwise, return nil.
3360 Assume point is at the caret."
3374 :end end
3375 :use-brackets-p bracketsp
3376 :contents-begin contents-begin
3377 :contents-end contents-end
3381 "Interpret SUPERSCRIPT object as Org syntax.
3382 CONTENTS is the contents of the object."
3385 contents))
3388 ;;;; Table Cell
3391 "Parse table cell at point.
3392 Return a list whose car is `table-cell' and cdr is a plist
3393 containing `:begin', `:end', `:contents-begin', `:contents-end'
3394 and `:post-blank' keywords."
3402 :end end
3403 :contents-begin contents-begin
3404 :contents-end contents-end
3408 "Interpret table-cell element as Org syntax.
3409 CONTENTS is the contents of the cell, or nil."
3413 ;;;; Target
3416 "Parse target at point, if any.
3418 When at a target, return a list whose car is `target' and cdr
3419 a plist with `:begin', `:end', `:value' and `:post-blank' as
3420 keywords. Otherwise, return nil.
3422 Assume point is at the target."
3432 :end end
3433 :value value
3437 "Interpret TARGET object as Org syntax."
3441 ;;;; Timestamp
3452 "Parse time stamp at point, if any.
3454 When at a time stamp, return a list whose car is `timestamp', and
3455 cdr a plist with `:type', `:raw-value', `:year-start',
3456 `:month-start', `:day-start', `:hour-start', `:minute-start',
3457 `:year-end', `:month-end', `:day-end', `:hour-end',
3458 `:minute-end', `:repeater-type', `:repeater-value',
3459 `:repeater-unit', `:warning-type', `:warning-value',
3460 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3461 Otherwise, return nil.
3463 Assume point is at the beginning of the timestamp."
3482 date-start)
3493 raw-value)
3495 :repeater-type
3501 :repeater-unit
3510 :warning-unit
3513 year-start month-start day-start hour-start minute-start year-end
3514 month-end day-end hour-end minute-end)
3515 ;; Parse date-start.
3523 ;; Compute date-end. It can be provided directly in time-stamp,
3524 ;; or extracted from time range. Otherwise, it defaults to the
3525 ;; same values as date-start.
3535 :raw-value raw-value
3536 :year-start year-start
3537 :month-start month-start
3538 :day-start day-start
3539 :hour-start hour-start
3540 :minute-start minute-start
3541 :year-end year-end
3542 :month-end month-end
3543 :day-end day-end
3544 :hour-end hour-end
3545 :minute-end minute-end
3546 :begin begin
3547 :end end
3549 repeater-props
3550 warning-props))))))
3553 "Interpret TIMESTAMP object as Org syntax."
3571 ;; Build an Org timestamp string from TIME. ACTIVEP is
3572 ;; non-nil when time stamp is active. If WITH-TIME-P is
3573 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3574 ;; specify a time range in the timestamp. REPEAT-STRING is
3575 ;; the repeater string, if any.
3579 org-time-stamp-formats)
3580 time)))
3586 nil nil ts)))
3591 " "
3592 s
3594 ;; Return value.
3595 ts)))
3607 build-ts-string
3626 0
3634 "--"
3647 ;;;; Underline
3650 "Parse underline object at point, if any.
3652 When at an underline object, return a list whose car is
3653 `underline' and cdr is a plist with `:begin', `:end',
3654 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3655 Otherwise, return nil.
3657 Assume point is at the first underscore marker."
3669 :end end
3670 :contents-begin contents-begin
3671 :contents-end contents-end
3675 "Interpret underline object as Org syntax.
3676 CONTENTS is the contents of the object."
3680 ;;;; Verbatim
3683 "Parse verbatim object at point, if any.
3685 When at a verbatim object, return a list whose car is `verbatim'
3686 and cdr is a plist with `:value', `:begin', `:end' and
3687 `:post-blank' keywords. Otherwise, return nil.
3689 Assume point is at the first equal sign marker."
3700 :begin begin
3701 :end end
3705 "Interpret VERBATIM object as Org syntax."
3709 \f
3710 ;;; Parsing Element Starting At Point
3711 ;;
3712 ;; `org-element--current-element' is the core function of this section.
3713 ;; It returns the Lisp representation of the element starting at
3714 ;; point.
3715 ;;
3716 ;; `org-element--current-element' makes use of special modes. They
3717 ;; are activated for fixed element chaining (e.g., `plain-list' >
3718 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3719 ;; `section'). Special modes are: `first-section', `item',
3720 ;; `node-property', `section' and `table-row'.
3723 "Parse the element starting at point.
3725 Return value is a list like (TYPE PROPS) where TYPE is the type
3726 of the element and PROPS a plist of properties associated to the
3727 element.
3729 Possible types are defined in `org-element-all-elements'.
3731 LIMIT bounds the search.
3733 Optional argument GRANULARITY determines the depth of the
3734 recursion. Allowed values are `headline', `greater-element',
3735 `element', `object' or nil. When it is broader than `object' (or
3736 nil), secondary values will not be parsed, since they only
3737 contain objects.
3739 Optional argument MODE, when non-nil, can be either
3740 `first-section', `section', `planning', `item', `node-property'
3741 and `table-row'.
3743 If STRUCTURE isn't provided but MODE is set to `item', it will be
3744 computed.
3746 This function assumes point is always at the beginning of the
3747 element it has to parse."
3750 ;; Determine if parsing depth allows for secondary strings
3751 ;; parsing. It only applies to elements referenced in
3752 ;; `org-element-secondary-value-alist'.
3755 ;; Item.
3758 ;; Table Row.
3760 ;; Node Property.
3762 ;; Headline.
3765 ;; Sections (must be checked after headline).
3770 limit)))
3771 ;; Planning.
3774 ;; Property drawer.
3778 ;; When not at bol, point is at the beginning of an item or
3779 ;; a footnote definition: next item is always a paragraph.
3781 ;; Clock.
3783 ;; Inlinetask.
3786 ;; From there, elements can have affiliated keywords.
3789 ;; Jumping over affiliated keywords put point off-limits.
3790 ;; Parse them as regular keywords.
3794 ;; LaTeX Environment.
3797 ;; Drawer and Property Drawer.
3800 ;; Fixed Width
3803 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3804 ;; Keywords.
3822 limit
3823 affiliated))
3836 ;; Footnote Definition.
3839 ;; Horizontal Rule.
3842 ;; Diary Sexp.
3845 ;; Table.
3848 ;; List.
3851 limit affiliated
3853 ;; Default element: Paragraph.
3857 ;; Most elements can have affiliated keywords. When looking for an
3858 ;; element beginning, we want to move before them, as they belong to
3859 ;; that element, and, in the meantime, collect information they give
3860 ;; into appropriate properties. Hence the following function.
3863 "Collect affiliated keywords from point down to LIMIT.
3865 Return a list whose CAR is the position at the first of them and
3866 CDR a plist of keywords and values and move point to the
3867 beginning of the first line after them.
3869 As a special case, if element doesn't start at the beginning of
3870 the line (e.g., a paragraph starting an item), CAR is current
3871 position of point and CDR is nil."
3875 ;; RESTRICT is the list of objects allowed in parsed
3876 ;; keywords value.
3878 output)
3881 ;; Apply translation to RAW-KWD. From there, KWD is
3882 ;; the official keyword.
3884 org-element-keyword-translation-alist))
3885 raw-kwd))
3886 ;; Find main value for any keyword.
3892 ;; PARSEDP is non-nil when keyword should have its
3893 ;; value parsed.
3895 ;; If KWD is a dual keyword, find its secondary
3896 ;; value. Maybe parse it.
3905 ;; Attribute a property name to KWD.
3907 ;; Now set final shape for VALUE.
3913 nil restrict)))
3917 ;; Attributes can always appear on multiple lines.
3920 ;; Eventually store the new value in OUTPUT.
3922 ;; Move to next keyword.
3924 ;; If affiliated keywords are orphaned: move back to first one.
3925 ;; They will be parsed as a paragraph.
3927 ;; Return value.
3931 \f
3932 ;;; The Org Parser
3933 ;;
3934 ;; The two major functions here are `org-element-parse-buffer', which
3935 ;; parses Org syntax inside the current buffer, taking into account
3936 ;; region, narrowing, or even visibility if specified, and
3937 ;; `org-element-parse-secondary-string', which parses objects within
3938 ;; a given string.
3939 ;;
3940 ;; The (almost) almighty `org-element-map' allows applying a function
3941 ;; on elements or objects matching some type, and accumulating the
3942 ;; resulting values. In an export situation, it also skips unneeded
3943 ;; parts of the parse tree.
3946 "Recursively parse the buffer and return structure.
3947 If narrowing is in effect, only parse the visible part of the
3948 buffer.
3950 Optional argument GRANULARITY determines the depth of the
3951 recursion. It can be set to the following symbols:
3953 `headline' Only parse headlines.
3954 `greater-element' Don't recurse into greater elements excepted
3955 headlines and sections. Thus, elements
3956 parsed are the top-level ones.
3957 `element' Parse everything but objects and plain text.
3958 `object' Parse the complete buffer (default).
3960 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3961 elements.
3963 An element or an objects is represented as a list with the
3964 pattern (TYPE PROPERTIES CONTENTS), where :
3966 TYPE is a symbol describing the element or object. See
3967 `org-element-all-elements' and `org-element-all-objects' for an
3968 exhaustive list of such symbols. One can retrieve it with
3969 `org-element-type' function.
3971 PROPERTIES is the list of attributes attached to the element or
3972 object, as a plist. Although most of them are specific to the
3973 element or object type, all types share `:begin', `:end',
3974 `:post-blank' and `:parent' properties, which respectively
3975 refer to buffer position where the element or object starts,
3976 ends, the number of white spaces or blank lines after it, and
3977 the element or object containing it. Properties values can be
3978 obtained by using `org-element-property' function.
3980 CONTENTS is a list of elements, objects or raw strings
3981 contained in the current element or object, when applicable.
3982 One can access them with `org-element-contents' function.
3984 The Org buffer has `org-data' as type and nil as properties.
3985 `org-element-map' function can be used to find specific elements
3986 or objects within the parse tree.
3988 This function assumes that current major mode is `org-mode'."
3994 ;; Start in `first-section' mode so text before the first
3995 ;; headline belongs to a section.
3999 "Recursively parse objects in STRING and return structure.
4001 RESTRICTION is a symbol limiting the object types that will be
4002 looked after.
4004 Optional argument PARENT, when non-nil, is the element or object
4005 containing the secondary string. It is used to set correctly
4006 `:parent' property within the string.
4008 If STRING is the empty string or nil, return nil."
4025 "Map a function on selected elements or objects.
4027 DATA is a parse tree, an element, an object, a string, or a list
4028 of such constructs. TYPES is a symbol or list of symbols of
4029 elements or objects types (see `org-element-all-elements' and
4030 `org-element-all-objects' for a complete list of types). FUN is
4031 the function called on the matching element or object. It has to
4032 accept one argument: the element or object itself.
4034 When optional argument INFO is non-nil, it should be a plist
4035 holding export options. In that case, parts of the parse tree
4036 not exportable according to that property list will be skipped.
4038 When optional argument FIRST-MATCH is non-nil, stop at the first
4039 match for which FUN doesn't return nil, and return that value.
4041 Optional argument NO-RECURSION is a symbol or a list of symbols
4042 representing elements or objects types. `org-element-map' won't
4043 enter any recursive element or object whose type belongs to that
4044 list. Though, FUN can still be applied on them.
4046 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4047 apply to matching objects within parsed affiliated keywords (see
4048 `org-element-parsed-keywords').
4050 Nil values returned from FUN do not appear in the results.
4053 Examples:
4054 ---------
4056 Assuming TREE is a variable containing an Org buffer parse tree,
4057 the following example will return a flat list of all `src-block'
4058 and `example-block' elements in it:
4062 The following snippet will find the first headline with a level
4066 (lambda (hl)
4067 (and (= (org-element-property :level hl) 1)
4069 (org-element-property :begin hl)))
4070 nil t)
4072 The next example will return a flat list of all `plain-list' type
4073 elements in TREE that are not a sub-list themselves:
4077 Eventually, this example will return a flat list of all `bold'
4078 type objects containing a `latex-snippet' type object, even
4079 looking into captions:
4082 (lambda (b)
4084 nil nil nil t)"
4085 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4089 ;; Recursion depth is determined by --CATEGORY.
4096 ;; If one object is found, the function has
4097 ;; to recurse into every object.
4100 ;; If one regular element is found, the
4101 ;; function has to recurse, at least, into
4102 ;; every element it encounters.
4105 --acc)
4108 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4109 ;; holding contextual information.
4113 ;; Ignored element in an export context.
4115 ;; List of elements or objects.
4117 ;; Unconditionally enter parse trees.
4121 ;; Check if TYPE is matching among TYPES. If so,
4122 ;; apply FUN to --DATA and accumulate return value
4123 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4129 ;; If --DATA has a secondary string that can contain
4130 ;; objects with their type among TYPES, look inside.
4133 org-element-secondary-value-alist)))
4135 ;; If --DATA has any parsed affiliated keywords and
4136 ;; WITH-AFFILIATED is non-nil, look for objects in
4137 ;; them.
4144 ;; Pay attention to the type of parsed
4145 ;; keyword. In particular, preserve order for
4146 ;; multiple keywords.
4159 ;; Determine if a recursion into --DATA is possible.
4161 ;; --TYPE is explicitly removed from recursion.
4163 ;; --DATA has no contents.
4165 ;; Looking for greater elements but --DATA is
4166 ;; simply an element or an object.
4169 ;; Looking for elements but --DATA is an object.
4172 ;; In any other case, map contents.
4176 ;; Return value in a proper order.
4180 ;; The following functions are internal parts of the parser.
4181 ;;
4182 ;; The first one, `org-element--parse-elements' acts at the element's
4183 ;; level.
4184 ;;
4185 ;; The second one, `org-element--parse-objects' applies on all objects
4186 ;; of a paragraph or a secondary string. It calls
4187 ;; `org-element--object-lex' to find the next object in the current
4188 ;; container.
4191 "Return next special mode according to TYPE, or nil.
4192 TYPE is a symbol representing the type of an element or object
4193 containing next element if PARENTP is non-nil, or before it
4194 otherwise. Modes can be either `first-section', `item',
4195 `node-property', `planning', `property-drawer', `section',
4196 `table-row' or nil."
4213 "Parse elements between BEG and END positions.
4215 MODE prioritizes some elements over the others. It can be set to
4216 `first-section', `section', `planning', `item', `node-property'
4217 or `table-row'.
4219 When value is `item', STRUCTURE will be used as the current list
4220 structure.
4222 GRANULARITY determines the depth of the recursion. See
4223 `org-element-parse-buffer' for more information.
4225 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4226 elements.
4228 Elements are accumulated into ACC."
4231 ;; Visible only: skip invisible parts at the beginning of the
4232 ;; element.
4235 ;; When parsing only headlines, skip any text before first one.
4240 ;; Find current element's type and parse it accordingly to
4241 ;; its category.
4243 end granularity mode structure))
4247 ;; Visible only: skip invisible parts between siblings.
4250 ;; Fill ELEMENT contents by side-effect.
4252 ;; If element has no contents, don't modify it.
4254 ;; Greater element: parse it between `contents-begin' and
4255 ;; `contents-end'. Make sure GRANULARITY allows the
4256 ;; recursion, or ELEMENT is a headline, in which case going
4257 ;; inside is mandatory, in order to get sub-level headings.
4265 ;; Possibly switch to a special mode.
4269 granularity visible-only element))
4270 ;; ELEMENT has contents. Parse objects inside, if
4271 ;; GRANULARITY allows it.
4277 ;; Update mode.
4279 ;; Return result.
4283 "Return next object in current buffer or nil.
4284 RESTRICTION is a list of object types, as symbols, that should be
4285 looked after. This function assumes that the buffer is narrowed
4286 to an appropriate container (e.g., a paragraph)."
4294 found)
4359 ;; This is probably a plain link.
4365 ;; Radio link.
4370 "Parse objects between BEG and END and return recursive structure.
4372 Objects are accumulated in ACC. RESTRICTION is a list of object
4373 successors which are allowed in the current object.
4375 ACC becomes the parent for all parsed objects. However, if ACC
4376 is nil (i.e., a secondary string is being parsed) and optional
4377 argument PARENT is non-nil, use it as the parent for all objects.
4378 Eventually, if both ACC and PARENT are nil, the common parent is
4379 the list of objects itself."
4387 ;; Text before any object. Untabify it.
4392 contents))))
4393 ;; Object...
4398 ;; Fill contents of NEXT-OBJECT if possible.
4400 cont-beg
4402 next-object
4404 next-object)
4405 contents)
4407 ;; Text after last object. Untabify it.
4411 contents)))
4412 ;; Result. Set appropriate parent.
4420 \f
4421 ;;; Towards A Bijective Process
4422 ;;
4423 ;; The parse tree obtained with `org-element-parse-buffer' is really
4424 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4425 ;; interpreted and expanded into a string with canonical Org syntax.
4426 ;; Hence `org-element-interpret-data'.
4427 ;;
4428 ;; The function relies internally on
4429 ;; `org-element--interpret-affiliated-keywords'.
4431 ;;;###autoload
4433 "Interpret DATA as Org syntax.
4434 DATA is a parse tree, an element, an object or a secondary string
4435 to interpret. Return Org syntax as a string."
4439 ;; Find interpreter for current object or
4440 ;; element. If it doesn't exist (e.g. this is
4441 ;; a pseudo object or element), return contents,
4442 ;; if any.
4449 ;; Secondary string.
4453 ;; Full Org document.
4457 ;; Plain text: return it.
4459 ;; Element or object without contents.
4462 ;; Element or object with contents.
4465 interpret
4466 --data
4467 ;; Recursively interpret contents.
4472 --data
4473 ;; Fix indentation of elements containing
4474 ;; objects. We ignore `table-row'
4475 ;; elements as they are one line long
4476 ;; anyway.
4478 --data
4479 ;; When normalizing first paragraph of
4480 ;; an item or a footnote-definition,
4481 ;; ignore first line's indentation.
4489 ;; Build white spaces. If no `:post-blank' property
4490 ;; is specified, assume its value is 0.
4505 "Return ELEMENT's affiliated keywords as Org syntax.
4506 If there is no affiliated keyword, return the empty string."
4516 ": "
4519 value)
4527 ;; All attribute keywords can have multiple lines.
4533 ;; List all ELEMENT's properties matching an attribute line or an
4534 ;; affiliated keyword, but ignore translated keywords since they
4535 ;; cannot belong to the property list.
4542 org-element-keyword-translation-alist)))))
4543 collect prop)
4546 ;; Because interpretation of the parse tree must return the same
4547 ;; number of blank lines between elements and the same number of white
4548 ;; space after objects, some special care must be given to white
4549 ;; spaces.
4550 ;;
4551 ;; The first function, `org-element-normalize-string', ensures any
4552 ;; string different from the empty string will end with a single
4553 ;; newline character.
4554 ;;
4555 ;; The second function, `org-element-normalize-contents', removes
4556 ;; global indentation from the contents of the current element.
4559 "Ensure string S ends with a single newline character.
4561 If S isn't a string return it unchanged. If S is the empty
4562 string, return it. Otherwise, return a new string with a single
4563 newline character at its end."
4571 "Normalize plain text in ELEMENT's contents.
4573 ELEMENT must only contain plain text and objects.
4575 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4576 indentation to compute maximal common indentation.
4578 Return the normalized element that is element with global
4579 indentation removed from its contents."
4581 ;; Return minimal common indentation within BLOB. This is
4582 ;; done by walking recursively BLOB and updating MIN-IND
4583 ;; along the way. FIRST-FLAG is non-nil when the next
4584 ;; object is expected to be a string that doesn't start
4585 ;; with a newline character. It happens for strings at
4586 ;; the beginnings of the contents or right after a line
4587 ;; break.
4594 ;; Objects cannot start with spaces: in this
4595 ;; case, indentation is 0.
4618 datum)
4631 ;; Build ELEMENT back, replacing each string with the same
4632 ;; string minus common indentation.
4635 ;; Return DATUM with all its strings indentation
4636 ;; shortened from MIN-IND white spaces.
4656 org-element-recursive-objects)
4660 datum)))
4664 \f
4665 ;;; Cache
4666 ;;
4667 ;; Implement a caching mechanism for `org-element-at-point' and
4668 ;; `org-element-context', which see.
4669 ;;
4670 ;; A single public function is provided: `org-element-cache-reset'.
4671 ;;
4672 ;; Cache is enabled by default, but can be disabled globally with
4673 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4674 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4675 ;; can be tweaked to control caching behaviour.
4676 ;;
4677 ;; Internally, parsed elements are stored in an AVL tree,
4678 ;; `org-element--cache'. This tree is updated lazily: whenever
4679 ;; a change happens to the buffer, a synchronization request is
4680 ;; registered in `org-element--cache-sync-requests' (see
4681 ;; `org-element--cache-submit-request'). During idle time, requests
4682 ;; are processed by `org-element--cache-sync'. Synchronization also
4683 ;; happens when an element is required from the cache. In this case,
4684 ;; the process stops as soon as the needed element is up-to-date.
4685 ;;
4686 ;; A synchronization request can only apply on a synchronized part of
4687 ;; the cache. Therefore, the cache is updated at least to the
4688 ;; location where the new request applies. Thus, requests are ordered
4689 ;; from left to right and all elements starting before the first
4690 ;; request are correct. This property is used by functions like
4691 ;; `org-element--cache-find' to retrieve elements in the part of the
4692 ;; cache that can be trusted.
4693 ;;
4694 ;; A request applies to every element, starting from its original
4695 ;; location (or key, see below). When a request is processed, it
4696 ;; moves forward and may collide the next one. In this case, both
4697 ;; requests are merged into a new one that starts from that element.
4698 ;; As a consequence, the whole synchronization complexity does not
4699 ;; depend on the number of pending requests, but on the number of
4700 ;; elements the very first request will be applied on.
4701 ;;
4702 ;; Elements cannot be accessed through their beginning position, which
4703 ;; may or may not be up-to-date. Instead, each element in the tree is
4704 ;; associated to a key, obtained with `org-element--cache-key'. This
4705 ;; mechanism is robust enough to preserve total order among elements
4706 ;; even when the tree is only partially synchronized.
4707 ;;
4708 ;; Objects contained in an element are stored in a hash table,
4709 ;; `org-element--cache-objects'.
4713 "Non nil when Org parser should cache its results.
4720 "Maximum duration, as a time value, for a cache synchronization.
4721 If the synchronization is not over after this delay, the process
4722 pauses and resumes after `org-element-cache-sync-break'
4726 "Duration, as a time value, of the pause between synchronizations.
4730 ;;;; Data Structure
4733 "AVL tree used to cache elements.
4734 Each node of the tree contains an element. Comparison is done
4735 with `org-element--cache-compare'. This cache is used in
4739 "Hash table used as to cache objects.
4740 Key is an element, as returned by `org-element-at-point', and
4741 value is an alist where each association is:
4743 \(PARENT COMPLETEP . OBJECTS)
4745 where PARENT is an element or object, COMPLETEP is a boolean,
4746 non-nil when all direct children of parent are already cached and
4747 OBJECTS is a list of such children, as objects, from farthest to
4748 closest.
4751 contained within a paragraph
4755 If the paragraph is completely parsed, OBJECTS-DATA will be
4757 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4758 \(BOLD-OBJECT t ENTITY-OBJECT))
4760 whereas in a partially parsed paragraph, it could be
4762 \((PARAGRAPH nil ENTITY-OBJECT))
4767 "List of pending synchronization requests.
4769 A request is a vector with the following pattern:
4771 \[NEXT BEG END OFFSET PARENT PHASE]
4773 Processing a synchronization request consists of three phases:
4775 0. Delete modified elements,
4776 1. Fill missing area in cache,
4777 2. Shift positions and re-parent elements after the changes.
4779 During phase 0, NEXT is the key of the first element to be
4780 removed, BEG and END is buffer position delimiting the
4781 modifications. Elements starting between them (inclusive) are
4782 removed. So are elements whose parent is removed. PARENT, when
4783 non-nil, is the parent of the first element to be removed.
4785 During phase 1, NEXT is the key of the next known element in
4786 cache and BEG its beginning position. Parse buffer between that
4787 element and the one before it in order to determine the parent of
4788 the next element. Set PARENT to the element containing NEXT.
4790 During phase 2, NEXT is the key of the next element to shift in
4791 the parse tree. All elements starting from this one have their
4792 properties relatives to buffer positions shifted by integer
4793 OFFSET and, if they belong to element PARENT, are adopted by it.
4801 "Hash table used to store keys during synchronization.
4805 "Return a unique key for ELEMENT in cache tree.
4807 Keys are used to keep a total order among elements in the cache.
4808 Comparison is done with `org-element--cache-key-less-p'.
4810 When no synchronization is taking place, a key is simply the
4811 beginning position of the element, or that position plus one in
4812 the case of an first item (respectively row) in
4813 a list (respectively a table).
4815 During a synchronization, the key is the one the element had when
4816 the cache was synchronized for the last time. Elements added to
4817 cache during the synchronization get a new key generated with
4818 `org-element--cache-generate-key'.
4820 Such keys are stored in `org-element--cache-sync-keys'. The hash
4821 table is cleared once the synchronization is complete."
4824 ;; Increase beginning position of items (respectively
4825 ;; table rows) by one, so the first item can get
4826 ;; a different key from its parent list (respectively
4827 ;; table).
4830 begin)))
4833 key))))
4836 "Generate a key between LOWER and UPPER.
4838 LOWER and UPPER are integers or lists, possibly empty.
4840 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4841 a unique key, as an integer or a list of integers, according to
4842 the following rules:
4844 - LOWER and UPPER are compared level-wise until values differ.
4846 - If, at a given level, LOWER and UPPER differ from more than
4847 2, the new key shares all the levels above with LOWER and
4848 gets a new level. Its value is the mean between LOWER and
4849 UPPER:
4851 \(1 2) + (1 4) --> (1 3)
4853 - If LOWER has no value to compare with, it is assumed that its
4854 value is `most-negative-fixnum'. E.g.,
4856 \(1 1) + (1 1 2)
4858 is equivalent to
4860 \(1 1 m) + (1 1 2)
4862 where m is `most-negative-fixnum'. Likewise, if UPPER is
4863 short of levels, the current value is `most-positive-fixnum'.
4865 - If they differ from only one, the new key inherits from
4866 current LOWER level and fork it at the next level. E.g.,
4868 \(2 1) + (3 3)
4870 is equivalent to
4872 \(2 1) + (2 M)
4874 where M is `most-positive-fixnum'.
4876 - If the key is only one level long, it is returned as an
4877 integer:
4879 \(1 2) + (3 2) --> 2
4881 When they are not equals, the function assumes that LOWER is
4882 lesser than UPPER, per `org-element--cache-key-less-p'."
4886 skip-upper key)
4897 ;; When at a given level, LOWER and UPPER differ from
4898 ;; 1, ignore UPPER altogether. Instead create a key
4899 ;; between LOWER and the greatest key with the same
4900 ;; prefix as LOWER so far.
4906 "Non-nil if key A is less than key B.
4907 A and B are either integers or lists of integers, as returned by
4908 `org-element--cache-key'."
4916 ;; If A is empty, either keys are equal (B is also empty) and
4917 ;; we return nil, or A is lesser than B (B is longer) and we
4918 ;; return a non-nil value.
4919 ;;
4920 ;; If A is not empty, B is necessarily empty and A is greater
4921 ;; than B (A is longer). Therefore, return nil.
4925 "Non-nil when element A is located before element B."
4930 "Return root value in cache.
4931 This function assumes `org-element--cache' is a valid AVL tree."
4935 ;;;; Tools
4938 "Non-nil when cache is active in current buffer."
4940 org-element--cache
4944 "Find element in cache starting at POS or before.
4946 POS refers to a buffer position.
4948 When optional argument SIDE is non-nil, the function checks for
4949 elements starting at or past POS instead. If SIDE is `both', the
4950 function returns a cons cell where car is the first element
4951 starting at or before POS and cdr the first element starting
4952 after POS.
4954 The function can only find elements in the synchronized part of
4955 the cache."
4959 lower upper)
4974 ;; We found an element in cache starting at POS. If `side'
4975 ;; is `both' we also want the next one in order to generate
4976 ;; a key in-between.
4977 ;;
4978 ;; If the element is the first row or item in a table or
4979 ;; a plain list, we always return the table or the plain
4980 ;; list.
4981 ;;
4982 ;; In any other case, we return the element found.
4991 lower parent
4992 upper parent)))))
4995 lower element
4996 upper element)))))
5003 "Store ELEMENT in current buffer's cache, if allowed.
5004 When optional argument DATA is non-nil, assume is it object data
5005 relative to ELEMENT and store it in the objects cache."
5009 ;; During synchronization, first build an appropriate key
5010 ;; for the new element so `avl-tree-enter' can insert it at
5011 ;; the right spot in the cache.
5020 org-element--cache-sync-keys)))
5022 ;; Headlines are not stored in cache, so objects in titles are
5023 ;; not stored either.
5028 "Remove ELEMENT from cache.
5029 Assume ELEMENT belongs to cache and that a cache is active."
5034 ;;;; Synchronization
5037 "Set idle timer for cache synchronization in BUFFER."
5044 org-element-cache-sync-idle-time))
5045 nil
5046 #'org-element--cache-sync
5047 buffer)))
5050 "Non-nil when synchronization process should be interrupted.
5051 TIME-LIMIT is a time value or nil."
5057 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5059 Properties containing buffer positions are `:begin', `:end',
5060 `:contents-begin', `:contents-end' and `:structure'. When
5061 optional argument PROPS is a list of keywords, only shift
5062 properties provided in that list.
5064 Properties are modified by side-effect."
5066 ;; Shift `:structure' property for the first plain list only: it
5067 ;; is the only one that really matters and it prevents from
5068 ;; shifting it more than once.
5082 "Synchronize cache with recent modification in BUFFER.
5084 When optional argument THRESHOLD is non-nil, do the
5085 synchronization for all elements starting before or at threshold,
5086 then exit. Otherwise, synchronize cache for as long as
5087 `org-element-cache-sync-duration' or until Emacs leaves idle
5088 state.
5090 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5091 not registered yet in the cache are going to happen. It is used
5092 in `org-element--cache-submit-request', where cache is partially
5093 updated before current modification are actually submitted."
5104 request
5106 threshold
5109 org-element-cache-sync-duration))
5110 future-change)
5111 ;; Request processed. Merge current and next offsets and
5112 ;; transfer ending position.
5118 ;; If more requests are awaiting, set idle timer accordingly.
5119 ;; Otherwise, reset keys.
5126 "Process synchronization REQUEST for all entries before NEXT.
5128 REQUEST is a vector, built by `org-element--cache-submit-request'.
5130 NEXT is a cache key, as returned by `org-element--cache-key'.
5132 When non-nil, THRESHOLD is a buffer position. Synchronization
5133 stops as soon as a shifted element begins after it.
5135 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5136 after this time or when Emacs exits idle state.
5138 When non-nil, FUTURE-CHANGE is a buffer position where changes
5139 not registered yet in the cache are going to happen. See
5140 `org-element--cache-submit-request' for more information.
5142 Throw `interrupt' if the process stops before completing the
5143 request."
5146 ;; Phase 0.
5147 ;;
5148 ;; Delete all elements starting after BEG, but not after buffer
5149 ;; position END or past element with key NEXT. Also delete
5150 ;; elements contained within a previously removed element
5151 ;; (stored in `last-container').
5152 ;;
5153 ;; At each iteration, we start again at tree root since
5154 ;; a deletion modifies structure of the balanced tree.
5159 ;; Find first element in cache with key BEG or after it.
5163 data data-key last-container)
5172 data-key key
5175 data-key key
5176 node nil)))))
5186 up)))
5189 end))
5196 ;; No element starting after modifications left in
5197 ;; cache: further processing is futile.
5200 ;; Phase 1.
5201 ;;
5202 ;; Phase 0 left a hole in the cache. Some elements after it
5203 ;; could have parents within. For example, in the following
5204 ;; buffer:
5205 ;;
5206 ;; - item
5207 ;;
5208 ;;
5209 ;; Paragraph1
5210 ;;
5211 ;; Paragraph2
5212 ;;
5213 ;; if we remove a blank line between "item" and "Paragraph1",
5214 ;; everything down to "Paragraph2" is removed from cache. But
5215 ;; the paragraph now belongs to the list, and its `:parent'
5216 ;; property no longer is accurate.
5217 ;;
5218 ;; Therefore we need to parse again elements in the hole, or at
5219 ;; least in its last section, so that we can re-parent
5220 ;; subsequent elements, during phase 2.
5221 ;;
5222 ;; Note that we only need to get the parent from the first
5223 ;; element in cache after the hole.
5224 ;;
5225 ;; When next key is lesser or equal to the current one, delegate
5226 ;; phase 1 processing to next request in order to preserve key
5227 ;; order among requests.
5235 ;; Next element will start at its beginning position plus
5236 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5237 ;; contains the real beginning position of the first element to
5238 ;; shift and re-parent.
5242 ;; Changes are going to happen around this element and
5243 ;; they will trigger another phase 1 request. Skip the
5244 ;; current one.
5250 ;; Phase 2.
5251 ;;
5252 ;; Shift all elements starting from key START, but before NEXT, by
5253 ;; OFFSET, and re-parent them when appropriate.
5254 ;;
5255 ;; Elements are modified by side-effect so the tree structure
5256 ;; remains intact.
5257 ;;
5258 ;; Once THRESHOLD, if any, is reached, or once there is an input
5259 ;; pending, exit. Before leaving, the current synchronization
5260 ;; request is updated.
5267 exit-flag)
5268 ;; No re-parenting nor shifting planned: request is over.
5278 ;; We reached NEXT. Request is complete.
5280 ;; Handle interruption request. Update current request.
5285 ;; Shift element.
5288 ;; Shift associated objects data, if any.
5293 ;; Update PARENT and re-parent DATA, only when
5294 ;; necessary. Propagate new structures for lists.
5308 ;; Cache is up-to-date past THRESHOLD. Request
5309 ;; interruption.
5314 ;; We reached end of tree: synchronization complete.
5315 t)))
5318 "Parse elements in current section, down to POS.
5320 Start parsing from the closest between the last known element in
5321 cache or headline above. Return the smallest element containing
5322 POS.
5324 When optional argument SYNCP is non-nil, return the parent of the
5325 element containing POS instead. In that case, it is also
5326 possible to provide TIME-LIMIT, which is a time value specifying
5327 when the parsing should stop. The function throws `interrupt' if
5328 the process stopped before finding the expected result."
5335 element next mode)
5337 ;; Nothing in cache before point: start parsing from first
5338 ;; element following headline above, or first element in
5339 ;; buffer.
5346 ;; Cache returned exact match: return it.
5349 ;; There's a headline between cached value and POS: cached
5350 ;; value is invalid. Start parsing from first element
5351 ;; following the headline.
5358 ;; Check if CACHED or any of its ancestors contain point.
5359 ;;
5360 ;; If there is such an element, we inspect it in order to know
5361 ;; if we return it or if we need to parse its contents.
5362 ;; Otherwise, we just start parsing from current location,
5363 ;; which is right after the top-most element containing
5364 ;; CACHED.
5365 ;;
5366 ;; As a special case, if POS is at the end of the buffer, we
5367 ;; want to return the innermost element ending there.
5368 ;;
5369 ;; Also, if we find an ancestor and discover that we need to
5370 ;; parse its contents, make sure we don't start from
5371 ;; `:contents-begin', as we would otherwise go past CACHED
5372 ;; again. Instead, in that situation, we will resume parsing
5373 ;; from NEXT, which is located after CACHED or its higher
5374 ;; ancestor not containing point.
5386 ;; Parse successively each element until we reach POS.
5399 end 'element mode
5406 ;; Skip any element ending before point. Also skip
5407 ;; element ending at point (unless it is also the end of
5408 ;; buffer) since we're sure that another element begins
5409 ;; after it.
5413 ;; A non-greater element contains point: return it.
5416 ;; Otherwise, we have to decide if ELEMENT really
5417 ;; contains POS. In that case we start parsing from
5418 ;; contents' beginning.
5419 ;;
5420 ;; If POS is at contents' beginning but it is also at
5421 ;; the beginning of the first item in a list or a table.
5422 ;; In that case, we need to create an anchor for that
5423 ;; list or table, so return it.
5424 ;;
5425 ;; Also, if POS is at the end of the buffer, no element
5426 ;; can start after it, but more than one may end there.
5427 ;; Arbitrarily, we choose to return the innermost of
5428 ;; such elements.
5441 parent element
5442 end cend))))
5443 ;; Otherwise, return ELEMENT as it is the smallest
5444 ;; element containing POS.
5449 ;;;; Staging Buffer Changes
5460 "Regexp matching a sensitive line, structure wise.
5461 A sensitive line is a headline, inlinetask, block, drawer, or
5462 latex-environment boundary. When such a line is modified,
5463 structure changes in the document may propagate in the whole
5467 "Non-nil when a sensitive line is about to be changed.
5471 "Request extension of area going to be modified if needed.
5472 BEG and END are the beginning and end of the range of changed
5473 text. See `before-change-functions' for more information."
5483 'headline
5486 org-element--cache-sensitive-re bottom t)))))))))
5489 "Update buffer modifications for current buffer.
5490 BEG and END are the beginning and end of the range of changed
5491 text, and the length in bytes of the pre-change text replaced by
5492 that range. See `after-change-functions' for more information."
5500 ;; Determine if modified area needs to be extended, according
5501 ;; to both previous and current state. We make a special
5502 ;; case for headline editing: if a headline is modified but
5503 ;; not removed, do not extend.
5506 (`headline
5512 org-element--cache-sensitive-re bottom t))))
5513 ;; Effectively extend modified area.
5521 ;; Store synchronization request.
5524 ;; Activate a timer to process the request during idle time.
5528 "Return first element to remove from cache.
5530 BEG and END are buffer positions delimiting buffer modifications.
5531 OFFSET is the size of the changes.
5533 Returned element is usually the first element in cache containing
5534 any position between BEG and END. As an exception, greater
5535 elements around the changes that are robust to contents
5536 modifications are preserved and updated according to the
5537 changes."
5547 special-block))
5548 ;; Drawers named "PROPERTIES" are probably
5549 ;; a properties drawer being edited. Force
5550 ;; parsing to check if editing is over.
5559 ;; UP is a robust greater element containing changes.
5560 ;; We only need to extend its ending boundaries.
5566 ;; We're at top level element containing ELEMENT: if it's
5567 ;; altered by buffer modifications, it is first element in
5568 ;; cache to be removed. Otherwise, that first element is the
5569 ;; following one.
5570 ;;
5571 ;; As a special case, do not remove BEFORE if it is a robust
5572 ;; container for current changes.
5574 before)))))
5577 "Submit a new cache synchronization request for current buffer.
5578 BEG and END are buffer positions delimiting the minimal area
5579 where cache data should be removed. OFFSET is the size of the
5580 change, as an integer."
5582 delete-to delete-from)
5587 ;; Current changes can be merged with first sync request: we
5588 ;; can save a partial cache synchronization.
5591 ;; If last change happened within area to be removed, extend
5592 ;; boundaries of robust parents, if any. Otherwise, find
5593 ;; first element to remove and update request accordingly.
5605 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5606 ;; if any, is no longer a 0-phase request, thus ensuring that
5607 ;; phases are properly ordered. We need to provide OFFSET as
5608 ;; optional parameter since current modifications are not known
5609 ;; yet to the otherwise correct part of the cache (i.e, before
5610 ;; the first request).
5617 ;; When changes happen before the first known
5618 ;; element, re-parent and shift the rest of the
5619 ;; cache.
5621 ;; Otherwise, we find the first non robust
5622 ;; element containing END. All elements between
5623 ;; FIRST and this one are to be removed.
5634 element up))
5636 org-element--cache-sync-requests)
5637 ;; No element to remove. No need to re-parent either.
5638 ;; Simply shift additional elements, if any, by OFFSET.
5643 ;;;; Public Functions
5645 ;;;###autoload
5647 "Reset cache in current buffer.
5648 When optional argument ALL is non-nil, reset cache in all Org
5649 buffers."
5667 ;;;###autoload
5669 "Refresh cache at position POS."
5676 \f
5677 ;;; The Toolbox
5678 ;;
5679 ;; The first move is to implement a way to obtain the smallest element
5680 ;; containing point. This is the job of `org-element-at-point'. It
5681 ;; basically jumps back to the beginning of section containing point
5682 ;; and proceed, one element after the other, with
5683 ;; `org-element--current-element' until the container is found. Note:
5684 ;; When using `org-element-at-point', secondary values are never
5685 ;; parsed since the function focuses on elements, not on objects.
5686 ;;
5687 ;; At a deeper level, `org-element-context' lists all elements and
5688 ;; objects containing point.
5689 ;;
5690 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5691 ;; internally by navigation and manipulation tools.
5694 ;;;###autoload
5696 "Determine closest element around point.
5698 Return value is a list like (TYPE PROPS) where TYPE is the type
5699 of the element and PROPS a plist of properties associated to the
5700 element.
5702 Possible types are defined in `org-element-all-elements'.
5703 Properties depend on element or object type, but always include
5704 `:begin', `:end', `:parent' and `:post-blank' properties.
5706 As a special case, if point is at the very beginning of the first
5707 item in a list or sub-list, returned element will be that list
5708 instead of the item. Likewise, if point is at the beginning of
5709 the first row of a table, returned element will be the table
5710 instead of the first row.
5712 When point is at the end of the buffer, return the innermost
5713 element ending there."
5719 ;; Within blank lines at the beginning of buffer, return nil.
5721 ;; Within blank lines right after a headline, return that
5722 ;; headline.
5726 ;; Otherwise parse until we find element containing ORIGIN.
5733 ;;;###autoload
5735 "Return smallest element or object around point.
5737 Return value is a list like (TYPE PROPS) where TYPE is the type
5738 of the element or object and PROPS a plist of properties
5739 associated to it.
5741 Possible types are defined in `org-element-all-elements' and
5742 `org-element-all-objects'. Properties depend on element or
5743 object type, but always include `:begin', `:end', `:parent' and
5744 `:post-blank'.
5746 As a special case, if point is right after an object and not at
5747 the beginning of any other object, return that object.
5749 Optional argument ELEMENT, when non-nil, is the closest element
5750 containing point, as returned by `org-element-at-point'.
5751 Providing it allows for quicker computation."
5758 ;; If point is inside an element containing objects or
5759 ;; a secondary string, narrow buffer to the container and
5760 ;; proceed with parsing. Otherwise, return ELEMENT.
5762 ;; At a parsed affiliated keyword, check if we're inside main
5763 ;; or dual value.
5769 org-element-parsed-keywords))
5778 ;; Also change type to retrieve correct restrictions.
5780 ;; At an item, objects can only be located within tag, if any.
5791 ;; At an headline or inlinetask, objects are in title.
5802 ;; At a paragraph, a table-row or a verse block, objects are
5803 ;; located within their contents.
5807 ;; CBEG is nil for table rules.
5812 ;; At a planning line, if point is at a timestamp, return it,
5813 ;; otherwise, return element.
5821 ;; All other locations cannot contain objects: bail out.
5831 next object-data last)
5835 ;; When entering PARENT for the first time, get list
5836 ;; of objects within known so far. Store it in
5837 ;; OBJECT-DATA.
5842 ;; Find NEXT object for analysis.
5844 ;; If NEXT is non-nil, we already exhausted the
5845 ;; cache so we can parse buffer to find the object
5846 ;; after it.
5848 ;; Otherwise, check if cache can help us.
5859 ;; Cache contains the information needed.
5862 pos)
5864 pos)
5870 ;; If we have a new object to analyze, store it in
5871 ;; cache. Otherwise record that there is nothing
5872 ;; more to parse in this element at this depth.
5877 ;; Process NEXT, if any, in order to know if we need
5878 ;; to skip it, return it or move into it.
5885 ;; Skip objects ending before point. Also skip
5886 ;; objects ending at point unless it is also the
5887 ;; end of buffer, since we want to return the
5888 ;; innermost object.
5891 ;; For convenience, when object ends at POS,
5892 ;; without any space, store it in LAST, as we
5893 ;; will return it if no object starts here.
5897 ;; If POS is within a container object, move
5898 ;; into that object.
5902 ;; At contents' end, if there is no
5903 ;; space before point, also move into
5904 ;; object, for consistency with
5905 ;; convenience feature above.
5914 next nil
5915 object-data nil))
5916 ;; Otherwise, return NEXT.
5918 ;; Store results in cache, if applicable.
5922 "List all ancestors of a given element or object.
5924 BLOB is an object or element.
5926 When optional argument TYPES is a list of symbols, return the
5927 first element or object in the lineage whose type belongs to that
5928 list.
5930 When optional argument WITH-SELF is non-nil, lineage includes
5931 BLOB itself as the first element, and TYPES, if provided, also
5932 apply to it.
5934 When BLOB is obtained through `org-element-context' or
5935 `org-element-at-point', only ancestors from its section can be
5936 found. There is no such limitation when BLOB belongs to a full
5937 parse tree."
5939 ancestors)
5946 "Non-nil when elements ELEM-A and ELEM-B are nested."
5955 "Swap elements ELEM-A and ELEM-B.
5956 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5957 end of ELEM-A."
5959 ;; There are two special cases when an element doesn't start at bol:
5960 ;; the first paragraph in an item or in a footnote definition.
5962 ;; Only a paragraph without any affiliated keyword can be moved at
5963 ;; ELEM-A position in such a situation. Note that the case of
5964 ;; a footnote definition is impossible: it cannot contain two
5965 ;; paragraphs in a row because it cannot contain a blank line.
5971 ;; In a special situation, ELEM-A will have no indentation. We'll
5972 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5986 ;; Store inner overlays responsible for visibility status.
5987 ;; We also need to store their boundaries as they will be
5988 ;; removed from buffer.
6003 ;; Get contents.
6011 ;; Restore ex ELEM-A overlays.
6018 ;; Restore ex ELEM-B overlays.
6023 ;; For backward-compatibility with Org <= 8.3
6030 ;; Local variables:
6031 ;; generated-autoload-file: "org-loaddefs.el"
6032 ;; End:
6034 ;;; org-element.el ends here