| blob | 9b209fe648bffa830898cec9910531e6d82c7521 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links in a link description.
356 ;; Also ignore radio-targets and line breaks.
358 italic latex-fragment macro plain-link statistics-cookie
359 strike-through subscript superscript underline verbatim)
361 ;; Remove any variable object from radio target as it would
362 ;; prevent it from being properly recognized.
364 subscript superscript underline superscript)
368 ;; Ignore inline babel call and inline src block as formulas are
369 ;; possible. Also ignore line breaks and statistics cookies.
371 latex-fragment link macro radio-target strike-through
372 subscript superscript target timestamp underline verbatim)
376 "Alist of objects restrictions.
378 key is an element or object type containing objects and value is
379 a list of types that can be contained within an element or object
380 of such type.
382 For example, in a `radio-target' object, one can only find
383 entities, latex-fragments, subscript, superscript and text
384 markup.
386 This alist also applies to secondary string. For example, an
387 `headline' type element doesn't directly contain objects, but
402 "Table used internally to pair only square brackets.
406 \f
407 ;;; Accessors and Setters
408 ;;
409 ;; Provide four accessors: `org-element-type', `org-element-property'
410 ;; `org-element-contents' and `org-element-restriction'.
411 ;;
412 ;; Setter functions allow modification of elements by side effect.
413 ;; There is `org-element-put-property', `org-element-set-contents'.
414 ;; These low-level functions are useful to build a parse tree.
415 ;;
416 ;; `org-element-adopt-element', `org-element-set-element',
417 ;; `org-element-extract-element' and `org-element-insert-before' are
418 ;; high-level functions useful to modify a parse tree.
419 ;;
420 ;; `org-element-secondary-p' is a predicate used to know if a given
421 ;; object belongs to a secondary string. `org-element-copy' returns
422 ;; an element or object, stripping its parent property in the process.
425 "Return type of ELEMENT.
427 The function returns the type of the element or object provided.
428 It can also return the following special value:
429 `plain-text' for a string
430 `org-data' for a complete document
431 nil in any other case."
437 "Extract the value from the PROPERTY of an ELEMENT."
442 "Extract contents from an ELEMENT."
448 "Return restriction associated to ELEMENT.
449 ELEMENT can be an element, an object or a symbol representing an
450 element or object type."
452 org-element-object-restrictions)))
455 "In ELEMENT set PROPERTY to VALUE.
456 Return modified element."
459 element))
462 "Set ELEMENT's contents to CONTENTS.
463 Return ELEMENT."
470 "Non-nil when OBJECT directly belongs to a secondary string.
471 Return value is the property name, as a keyword, or nil."
474 org-element-secondary-value-alist))))
481 "Append elements to the contents of another element.
483 PARENT is an element or object. CHILDREN can be elements,
484 objects, or a strings.
486 The function takes care of setting `:parent' property for CHILD.
487 Return parent element."
489 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
490 ;; string: parent is the list itself.
493 ;; Add CHILDREN at the end of PARENT contents.
496 parent
498 ;; Return modified PARENT element.
502 "Extract ELEMENT from parse tree.
503 Remove element from the parse tree by side-effect, and return it
504 with its `:parent' property stripped out."
509 parent secondary
512 parent
514 ;; Return ELEMENT with its :parent removed.
518 "Insert ELEMENT before LOCATION in parse tree.
519 LOCATION is an element, object or string within the parse tree.
520 Parse tree is modified by side effect."
525 ;; Special case: LOCATION is the first element of an
526 ;; independent secondary string (e.g. :title property). Add
527 ;; ELEMENT in-place.
531 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
541 ;; Store SIBLINGS at appropriate place in parse tree.
546 ;; Set appropriate :parent property.
550 "Replace element or object OLD with element or object NEW.
551 The function takes care of setting `:parent' property for NEW."
552 ;; Ensure OLD and NEW have the same parent.
556 ;; We cannot replace OLD with NEW since one of them is not an
557 ;; object or element. We take the long path.
560 ;; Since OLD is going to be changed into NEW by side-effect, first
561 ;; make sure that every element or object within NEW has OLD as
562 ;; parent.
565 ;; Transfer contents.
567 ;; Overwrite OLD's properties with NEW's.
569 ;; Transfer type.
573 "Create a new element of type TYPE.
574 Optional argument PROPS, when non-nil, is a plist defining the
575 properties of the element. CHILDREN can be elements, objects or
576 strings."
580 "Return a copy of DATUM.
581 DATUM is an element, object, string or nil. `:parent' property
582 is cleared and contents are removed in the process."
593 \f
594 ;;; Greater elements
595 ;;
596 ;; For each greater element type, we define a parser and an
597 ;; interpreter.
598 ;;
599 ;; A parser returns the element or object as the list described above.
600 ;; Most of them accepts no argument. Though, exceptions exist. Hence
601 ;; every element containing a secondary string (see
602 ;; `org-element-secondary-value-alist') will accept an optional
603 ;; argument to toggle parsing of these secondary strings. Moreover,
604 ;; `item' parser requires current list's structure as its first
605 ;; element.
606 ;;
607 ;; An interpreter accepts two arguments: the list representation of
608 ;; the element or object, and its contents. The latter may be nil,
609 ;; depending on the element or object considered. It returns the
610 ;; appropriate Org syntax, as a string.
611 ;;
612 ;; Parsing functions must follow the naming convention:
613 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
614 ;; defined in `org-element-greater-elements'.
615 ;;
616 ;; Similarly, interpreting functions must follow the naming
617 ;; convention: org-element-TYPE-interpreter.
618 ;;
619 ;; With the exception of `headline' and `item' types, greater elements
620 ;; cannot contain other greater elements of their own type.
621 ;;
622 ;; Beside implementing a parser and an interpreter, adding a new
623 ;; greater element requires to tweak `org-element--current-element'.
624 ;; Moreover, the newly defined type must be added to both
625 ;; `org-element-all-elements' and `org-element-greater-elements'.
628 ;;;; Center Block
631 "Parse a center block.
633 LIMIT bounds the search. AFFILIATED is a list of which CAR is
634 the buffer position at the beginning of the first affiliated
635 keyword and CDR is a plist of affiliated keywords along with
636 their value.
638 Return a list whose CAR is `center-block' and CDR is a plist
639 containing `:begin', `:end', `:contents-begin', `:contents-end',
640 `:post-blank' and `:post-affiliated' keywords.
642 Assume point is at the beginning of the block."
646 ;; Incomplete block: parse it as a paragraph.
651 ;; Empty blocks have no contents.
665 :end end
666 :contents-begin contents-begin
667 :contents-end contents-end
673 "Interpret a center-block element as Org syntax.
674 CONTENTS is the contents of the element."
678 ;;;; Drawer
681 "Parse a drawer.
683 LIMIT bounds the search. AFFILIATED is a list of which CAR is
684 the buffer position at the beginning of the first affiliated
685 keyword and CDR is a plist of affiliated keywords along with
686 their value.
688 Return a list whose CAR is `drawer' and CDR is a plist containing
689 `:drawer-name', `:begin', `:end', `:contents-begin',
690 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
692 Assume point is at beginning of drawer."
695 ;; Incomplete drawer: parse it as a paragraph.
703 ;; Empty drawers have no contents.
716 :end end
717 :drawer-name name
718 :contents-begin contents-begin
719 :contents-end contents-end
725 "Interpret DRAWER element as Org syntax.
726 CONTENTS is the contents of the element."
729 contents))
732 ;;;; Dynamic Block
735 "Parse a dynamic block.
737 LIMIT bounds the search. AFFILIATED is a list of which CAR is
738 the buffer position at the beginning of the first affiliated
739 keyword and CDR is a plist of affiliated keywords along with
740 their value.
742 Return a list whose CAR is `dynamic-block' and CDR is a plist
743 containing `:block-name', `:begin', `:end', `:contents-begin',
744 `:contents-end', `:arguments', `:post-blank' and
745 `:post-affiliated' keywords.
747 Assume point is at beginning of dynamic block."
751 ;; Incomplete block: parse it as a paragraph.
760 ;; Empty blocks have no contents.
773 :end end
774 :block-name name
775 :arguments arguments
776 :contents-begin contents-begin
777 :contents-end contents-end
783 "Interpret DYNAMIC-BLOCK element as Org syntax.
784 CONTENTS is the contents of the element."
789 contents))
792 ;;;; Footnote Definition
801 "Parse a footnote definition.
803 LIMIT bounds the search. AFFILIATED is a list of which CAR is
804 the buffer position at the beginning of the first affiliated
805 keyword and CDR is a plist of affiliated keywords along with
806 their value.
808 Return a list whose CAR is `footnote-definition' and CDR is
809 a plist containing `:label', `:begin' `:end', `:contents-begin',
810 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
812 Assume point is at the beginning of the footnote definition."
824 limit)
826 ;; At a new footnote definition, make sure we end
827 ;; before any affiliated keyword above.
848 :begin begin
849 :end end
850 :contents-begin contents-begin
851 :contents-end contents-end
857 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
858 CONTENTS is the contents of the footnote-definition."
860 " "
861 contents))
864 ;;;; Headline
867 "Return node properties associated to headline at point.
868 Upcase property names. It avoids confusion between properties
869 obtained through property drawer and default properties from the
870 parser (e.g. `:end' and :END:). Return value is a plist."
882 properties))))
885 "Return time properties associated to headline at point.
886 Return value is a plist."
900 plist))))
903 "Parse a headline.
905 Return a list whose CAR is `headline' and CDR is a plist
906 containing `:raw-value', `:title', `:begin', `:end',
907 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
908 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
909 `:deadline', `:closed', `:archivedp', `:commentedp'
910 `:footnote-section-p', `:post-blank' and `:post-affiliated'
911 keywords.
913 The plist also contains any property set in the property drawer,
914 with its name in upper cases and colons added at the
915 beginning (e.g., `:CUSTOM_ID').
917 LIMIT is a buffer position bounding the search.
919 When RAW-SECONDARY-P is non-nil, headline's title will not be
920 parsed as a secondary string, but as a plain string instead.
922 Assume point is at beginning of the headline."
969 :begin begin
970 :end end
971 :pre-blank
974 :contents-begin contents-begin
975 :contents-end contents-end
976 :level level
977 :priority priority
978 :tags tags
979 :todo-keyword todo
980 :todo-type todo-type
983 end)
984 :footnote-section-p footnote-section-p
985 :archivedp archivedp
986 :commentedp commentedp
988 time-props
989 standard-props))))
991 headline :title
1000 nil
1002 headline)))))))
1005 "Interpret HEADLINE element as Org syntax.
1006 CONTENTS is the contents of the element."
1019 ?*)
1023 " "
1026 org-footnote-section
1027 title))))
1029 heading
1030 ;; Align tags.
1038 ?\s)
1039 tags))
1043 tags))))
1045 contents)))
1048 ;;;; Inlinetask
1051 "Parse an inline task.
1053 Return a list whose CAR is `inlinetask' and CDR is a plist
1054 containing `:title', `:begin', `:end', `:contents-begin' and
1055 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1056 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1057 `:closed', `:post-blank' and `:post-affiliated' keywords.
1059 The plist also contains any property set in the property drawer,
1060 with its name in upper cases and colons added at the
1061 beginning (e.g., `:CUSTOM_ID').
1063 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1064 title will not be parsed as a secondary string, but as a plain
1065 string instead.
1067 Assume point is at beginning of the inline task."
1112 :begin begin
1113 :end end
1114 :contents-begin contents-begin
1115 :contents-end contents-end
1116 :level level
1117 :priority priority
1118 :tags tags
1119 :todo-keyword todo
1120 :todo-type todo-type
1123 time-props
1124 standard-props))))
1126 inlinetask :title
1135 nil
1137 inlinetask))))))
1140 "Interpret INLINETASK element as Org syntax.
1141 CONTENTS is the contents of inlinetask."
1155 ;; Align tags.
1163 ? )
1164 tags))
1168 tags))))
1169 ;; Prefer degenerate inlinetasks when there are no
1170 ;; contents.
1173 contents
1177 ;;;; Item
1180 "Parse an item.
1182 STRUCT is the structure of the plain list.
1184 Return a list whose CAR is `item' and CDR is a plist containing
1185 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1186 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1187 `:post-affiliated' keywords.
1189 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1190 any, will not be parsed as a secondary string, but as a plain
1191 string instead.
1193 Assume point is at the beginning of the item."
1216 ;; Ignore tags in un-ordered lists: they are just
1217 ;; a part of item's body.
1224 ;; If first line isn't empty, contents really
1225 ;; start at the text after item's meta-data.
1235 :begin begin
1236 :end end
1237 :contents-begin contents-begin
1238 :contents-end contents-end
1239 :checkbox checkbox
1240 :counter counter
1241 :structure struct
1245 item :tag
1252 item))))))))
1255 "Interpret ITEM element as Org syntax.
1256 CONTENTS is the contents of the element."
1266 ;; Compute indentation.
1271 ;; Indent contents.
1273 bullet
1288 ;;;; Plain List
1291 ;; Return structure of list at point. Internal function. See
1292 ;; `org-list-struct' for details.
1297 items struct)
1302 ;; At limit: end all items.
1311 ;; At list end: end all items.
1316 ;; At a new item: end previous sibling.
1328 ind
1329 bullet
1332 ;; Description tag.
1336 ;; Ending position, unknown so far.
1337 nil)))
1338 items))
1340 ;; Skip empty lines.
1342 ;; Skip inline tasks and blank lines along the way.
1349 ;; At some text line. Check if it ends any previous item.
1362 ;; Skip blocks (any type) and drawers contents.
1367 limit t)))
1373 "Parse a plain list.
1375 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1376 the buffer position at the beginning of the first affiliated
1377 keyword and CDR is a plist of affiliated keywords along with
1378 their value. STRUCTURE is the structure of the plain list being
1379 parsed.
1381 Return a list whose CAR is `plain-list' and CDR is a plist
1382 containing `:type', `:begin', `:end', `:contents-begin' and
1383 `:contents-end', `:structure', `:post-blank' and
1384 `:post-affiliated' keywords.
1386 Assume point is at the beginning of the list."
1400 pos))
1404 ;; Return value.
1408 :begin begin
1409 :end end
1410 :contents-begin contents-begin
1411 :contents-end contents-end
1412 :structure struct
1418 "Interpret plain-list element as Org syntax.
1419 CONTENTS is the contents of the element."
1427 ;;;; Property Drawer
1430 "Parse a property drawer.
1432 LIMIT bounds the search.
1434 Return a list whose car is `property-drawer' and cdr is a plist
1435 containing `:begin', `:end', `:contents-begin', `:contents-end',
1436 `:post-blank' and `:post-affiliated' keywords.
1438 Assume point is at the beginning of the property drawer."
1451 :end end
1453 :contents-end contents-end
1458 "Interpret property-drawer element as Org syntax.
1459 CONTENTS is the properties within the drawer."
1463 ;;;; Quote Block
1466 "Parse a quote block.
1468 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1469 the buffer position at the beginning of the first affiliated
1470 keyword and CDR is a plist of affiliated keywords along with
1471 their value.
1473 Return a list whose CAR is `quote-block' and CDR is a plist
1474 containing `:begin', `:end', `:contents-begin', `:contents-end',
1475 `:post-blank' and `:post-affiliated' keywords.
1477 Assume point is at the beginning of the block."
1481 ;; Incomplete block: parse it as a paragraph.
1487 ;; Empty blocks have no contents.
1500 :end end
1501 :contents-begin contents-begin
1502 :contents-end contents-end
1508 "Interpret quote-block element as Org syntax.
1509 CONTENTS is the contents of the element."
1513 ;;;; Section
1516 "Parse a section.
1518 Return a list whose CAR is `section' and CDR is a plist
1519 containing `:begin', `:end', `:contents-begin', `contents-end',
1520 `:post-blank' and `:post-affiliated' keywords."
1522 ;; Beginning of section is the beginning of the first non-blank
1523 ;; line after previous headline.
1531 :end end
1532 :contents-begin begin
1533 :contents-end pos-before-blank
1538 "Interpret section element as Org syntax.
1539 CONTENTS is the contents of the element."
1540 contents)
1543 ;;;; Special Block
1546 "Parse a special block.
1548 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1549 the buffer position at the beginning of the first affiliated
1550 keyword and CDR is a plist of affiliated keywords along with
1551 their value.
1553 Return a list whose CAR is `special-block' and CDR is a plist
1554 containing `:type', `:begin', `:end', `:contents-begin',
1555 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1557 Assume point is at the beginning of the block."
1564 limit t)))
1565 ;; Incomplete block: parse it as a paragraph.
1571 ;; Empty blocks have no contents.
1584 :begin begin
1585 :end end
1586 :contents-begin contents-begin
1587 :contents-end contents-end
1593 "Interpret SPECIAL-BLOCK element as Org syntax.
1594 CONTENTS is the contents of the element."
1599 \f
1600 ;;; Elements
1601 ;;
1602 ;; For each element, a parser and an interpreter are also defined.
1603 ;; Both follow the same naming convention used for greater elements.
1604 ;;
1605 ;; Also, as for greater elements, adding a new element type is done
1606 ;; through the following steps: implement a parser and an interpreter,
1607 ;; tweak `org-element--current-element' so that it recognizes the new
1608 ;; type and add that new type to `org-element-all-elements'.
1611 ;;;; Babel Call
1614 "Parse a babel call.
1616 LIMIT bounds the search. AFFILIATED is a list of which car is
1617 the buffer position at the beginning of the first affiliated
1618 keyword and cdr is a plist of affiliated keywords along with
1619 their value.
1621 Return a list whose car is `babel-call' and cdr is a plist
1622 containing `:call', `:inside-header', `:arguments',
1623 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1624 `:post-affiliated' as keywords."
1638 value)))
1648 :begin begin
1649 :end end
1650 :value value
1656 "Interpret BABEL-CALL element as Org syntax."
1666 ;;;; Clock
1669 "Parse a clock.
1671 LIMIT bounds the search.
1673 Return a list whose CAR is `clock' and CDR is a plist containing
1674 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1675 `:post-affiliated' as keywords."
1695 :value value
1696 :duration duration
1697 :begin begin
1698 :end end
1699 :post-blank post-blank
1703 "Interpret CLOCK element as Org syntax."
1711 "%2s:%02s"
1715 ;;;; Comment
1718 "Parse a comment.
1720 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1721 the buffer position at the beginning of the first affiliated
1722 keyword and CDR is a plist of affiliated keywords along with
1723 their value.
1725 Return a list whose CAR is `comment' and CDR is a plist
1726 containing `:begin', `:end', `:value', `:post-blank',
1727 `:post-affiliated' keywords.
1729 Assume point is at comment beginning."
1738 ;; Get comments ending.
1741 ;; Accumulate lines without leading hash and first
1742 ;; whitespace.
1756 :end end
1757 :value value
1763 "Interpret COMMENT element as Org syntax.
1764 CONTENTS is nil."
1768 ;;;; Comment Block
1771 "Parse an export block.
1773 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1774 the buffer position at the beginning of the first affiliated
1775 keyword and CDR is a plist of affiliated keywords along with
1776 their value.
1778 Return a list whose CAR is `comment-block' and CDR is a plist
1779 containing `:begin', `:end', `:value', `:post-blank' and
1780 `:post-affiliated' keywords.
1782 Assume point is at comment block beginning."
1786 ;; Incomplete block: parse it as a paragraph.
1799 contents-begin contents-end)))
1803 :end end
1804 :value value
1810 "Interpret COMMENT-BLOCK element as Org syntax."
1817 ;;;; Diary Sexp
1820 "Parse a diary sexp.
1822 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1823 the buffer position at the beginning of the first affiliated
1824 keyword and CDR is a plist of affiliated keywords along with
1825 their value.
1827 Return a list whose CAR is `diary-sexp' and CDR is a plist
1828 containing `:begin', `:end', `:value', `:post-blank' and
1829 `:post-affiliated' keywords."
1841 :begin begin
1842 :end end
1848 "Interpret DIARY-SEXP as Org syntax."
1852 ;;;; Example Block
1855 "Parse an example block.
1857 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1858 the buffer position at the beginning of the first affiliated
1859 keyword and CDR is a plist of affiliated keywords along with
1860 their value.
1862 Return a list whose CAR is `example-block' and CDR is a plist
1863 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1864 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1865 `:value', `:post-blank' and `:post-affiliated' keywords."
1869 ;; Incomplete block: parse it as a paragraph.
1877 ;; Switches analysis
1884 ;; Should labels be retained in (or stripped from) example
1885 ;; blocks?
1890 ;; What should code-references use - labels or
1891 ;; line-numbers?
1900 ;; Standard block parsing.
1908 contents-begin contents-end))
1909 block-ind))
1918 :end end
1919 :value value
1920 :switches switches
1921 :number-lines number-lines
1922 :preserve-indent preserve-indent
1923 :retain-labels retain-labels
1924 :use-labels use-labels
1925 :label-fmt label-fmt
1931 "Interpret EXAMPLE-BLOCK element as Org syntax."
1939 value
1944 ;;;; Export Block
1947 "Parse an export block.
1949 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1950 the buffer position at the beginning of the first affiliated
1951 keyword and CDR is a plist of affiliated keywords along with
1952 their value.
1954 Return a list whose CAR is `export-block' and CDR is a plist
1955 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1956 `:post-affiliated' keywords.
1958 Assume point is at export-block beginning."
1962 ;; Incomplete block: parse it as a paragraph.
1980 contents-end)))
1984 :begin begin
1985 :end end
1986 :value value
1992 "Interpret EXPORT-BLOCK element as Org syntax."
1998 ;;;; Fixed-width
2001 "Parse a fixed-width section.
2003 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2004 the buffer position at the beginning of the first affiliated
2005 keyword and CDR is a plist of affiliated keywords along with
2006 their value.
2008 Return a list whose CAR is `fixed-width' and CDR is a plist
2009 containing `:begin', `:end', `:value', `:post-blank' and
2010 `:post-affiliated' keywords.
2012 Assume point is at the beginning of the fixed-width area."
2016 value
2021 ;; Accumulate text without starting colons.
2034 :end end
2035 :value value
2041 "Interpret FIXED-WIDTH element as Org syntax."
2049 ;;;; Horizontal Rule
2052 "Parse an horizontal rule.
2054 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2055 the buffer position at the beginning of the first affiliated
2056 keyword and CDR is a plist of affiliated keywords along with
2057 their value.
2059 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2060 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2061 keywords."
2071 :end end
2077 "Interpret HORIZONTAL-RULE element as Org syntax."
2081 ;;;; Keyword
2084 "Parse a keyword at point.
2086 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2087 the buffer position at the beginning of the first affiliated
2088 keyword and CDR is a plist of affiliated keywords along with
2089 their value.
2091 Return a list whose CAR is `keyword' and CDR is a plist
2092 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2093 `:post-affiliated' keywords."
2095 ;; An orphaned affiliated keyword is considered as a regular
2096 ;; keyword. In this case AFFILIATED is nil, so we take care of
2097 ;; this corner case.
2110 :value value
2111 :begin begin
2112 :end end
2118 "Interpret KEYWORD element as Org syntax."
2124 ;;;; Latex Environment
2128 "Regexp matching the beginning of a LaTeX environment.
2129 The environment is captured by the first group.
2135 "Format string matching the ending of a LaTeX environment.
2139 "Parse a LaTeX environment.
2141 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2142 the buffer position at the beginning of the first affiliated
2143 keyword and CDR is a plist of affiliated keywords along with
2144 their value.
2146 Return a list whose CAR is `latex-environment' and CDR is a plist
2147 containing `:begin', `:end', `:value', `:post-blank' and
2148 `:post-affiliated' keywords.
2150 Assume point is at the beginning of the latex environment."
2157 limit t))
2158 ;; Incomplete latex environment: parse it as a paragraph.
2168 :end end
2169 :value value
2175 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2179 ;;;; Node Property
2182 "Parse a node-property at point.
2184 LIMIT bounds the search.
2186 Return a list whose CAR is `node-property' and CDR is a plist
2187 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2188 `:post-affiliated' keywords."
2198 limit))))
2201 :value value
2202 :begin begin
2203 :end end
2208 "Interpret NODE-PROPERTY element as Org syntax."
2214 ;;;; Paragraph
2217 "Parse a paragraph.
2219 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2220 the buffer position at the beginning of the first affiliated
2221 keyword and CDR is a plist of affiliated keywords along with
2222 their value.
2224 Return a list whose CAR is `paragraph' and CDR is a plist
2225 containing `:begin', `:end', `:contents-begin' and
2226 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2228 Assume point is at the beginning of the paragraph."
2235 ;; A matching `org-element-paragraph-separate' is not
2236 ;; necessarily the end of the paragraph. In particular,
2237 ;; drawers, blocks or LaTeX environments opening lines
2238 ;; must be closed. Moreover keywords with a secondary
2239 ;; value must belong to "dual keywords".
2253 limit t)))
2259 limit t)))
2262 org-element-dual-keywords))
2263 ;; Everything else is unambiguous.
2276 :end end
2277 :contents-begin contents-begin
2278 :contents-end contents-end
2284 "Interpret paragraph element as Org syntax.
2285 CONTENTS is the contents of the element."
2286 contents)
2289 ;;;; Planning
2292 "Parse a planning.
2294 LIMIT bounds the search.
2296 Return a list whose CAR is `planning' and CDR is a plist
2297 containing `:closed', `:deadline', `:scheduled', `:begin',
2298 `:end', `:post-blank' and `:post-affiliated' keywords."
2308 closed deadline scheduled)
2320 :deadline deadline
2321 :scheduled scheduled
2322 :begin begin
2323 :end end
2324 :post-blank post-blank
2328 "Interpret PLANNING element as Org syntax."
2330 #'identity
2347 ;;;; Src Block
2350 "Parse a src block.
2352 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2353 the buffer position at the beginning of the first affiliated
2354 keyword and CDR is a plist of affiliated keywords along with
2355 their value.
2357 Return a list whose CAR is `src-block' and CDR is a plist
2358 containing `:language', `:switches', `:parameters', `:begin',
2359 `:end', `:number-lines', `:retain-labels', `:use-labels',
2360 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2361 `:post-affiliated' keywords.
2363 Assume point is at the beginning of the block."
2366 limit t)))
2367 ;; Incomplete block: parse it as a paragraph.
2373 ;; Get language as a string.
2382 ;; Get switches.
2384 ;; Get parameters.
2386 ;; Switches analysis
2397 ;; Should labels be retained in (or stripped from)
2398 ;; src blocks?
2403 ;; What should code-references use - labels or
2404 ;; line-numbers?
2409 ;; Indentation.
2411 ;; Retrieve code.
2416 block-ind))
2420 ;; Get position after ending blank lines.
2430 :begin begin
2431 :end end
2432 :number-lines number-lines
2433 :preserve-indent preserve-indent
2434 :retain-labels retain-labels
2435 :use-labels use-labels
2436 :label-fmt label-fmt
2437 :value value
2443 "Interpret SRC-BLOCK element as Org syntax."
2452 val)
2466 ;;;; Table
2469 "Parse a table at point.
2471 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2472 the buffer position at the beginning of the first affiliated
2473 keyword and CDR is a plist of affiliated keywords along with
2474 their value.
2476 Return a list whose CAR is `table' and CDR is a plist containing
2477 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2478 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2479 keywords.
2481 Assume point is at the beginning of the table."
2497 acc))
2504 :end end
2505 :type type
2506 :tblfm tblfm
2507 ;; Only `org' tables have contents. `table.el' tables
2508 ;; use a `:value' property to store raw table as
2509 ;; a string.
2514 table-begin table-end))
2520 "Interpret TABLE element as Org syntax.
2521 CONTENTS is a string, if table's type is `org', or nil."
2532 ;;;; Table Row
2535 "Parse table row at point.
2537 Return a list whose CAR is `table-row' and CDR is a plist
2538 containing `:begin', `:end', `:contents-begin', `:contents-end',
2539 `:type', `:post-blank' and `:post-affiliated' keywords."
2543 ;; A table rule has no contents. In that case, ensure
2544 ;; CONTENTS-BEGIN matches CONTENTS-END.
2554 :begin begin
2555 :end end
2556 :contents-begin contents-begin
2557 :contents-end contents-end
2562 "Interpret TABLE-ROW element as Org syntax.
2563 CONTENTS is the contents of the table row."
2568 ;;;; Verse Block
2571 "Parse a verse block.
2573 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2574 the buffer position at the beginning of the first affiliated
2575 keyword and CDR is a plist of affiliated keywords along with
2576 their value.
2578 Return a list whose CAR is `verse-block' and CDR is a plist
2579 containing `:begin', `:end', `:contents-begin', `:contents-end',
2580 `:post-blank' and `:post-affiliated' keywords.
2582 Assume point is at beginning of the block."
2586 ;; Incomplete block: parse it as a paragraph.
2601 :end end
2602 :contents-begin contents-begin
2603 :contents-end contents-end
2609 "Interpret verse-block element as Org syntax.
2610 CONTENTS is verse block contents."
2614 \f
2615 ;;; Objects
2616 ;;
2617 ;; Unlike to elements, raw text can be found between objects. Hence,
2618 ;; `org-element--object-lex' is provided to find the next object in
2619 ;; buffer.
2620 ;;
2621 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2622 ;; object types they can contain will be specified in
2623 ;; `org-element-object-restrictions'.
2624 ;;
2625 ;; Creating a new type of object requires to alter
2626 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2627 ;; new type in `org-element-all-objects', and possibly add
2628 ;; restrictions in `org-element-object-restrictions'.
2630 ;;;; Bold
2633 "Parse bold object at point, if any.
2635 When at a bold object, return a list whose car is `bold' and cdr
2636 is a plist with `:begin', `:end', `:contents-begin' and
2637 `:contents-end' and `:post-blank' keywords. Otherwise, return
2638 nil.
2640 Assume point is at the first star marker."
2652 :end end
2653 :contents-begin contents-begin
2654 :contents-end contents-end
2658 "Interpret bold object as Org syntax.
2659 CONTENTS is the contents of the object."
2663 ;;;; Code
2666 "Parse code object at point, if any.
2668 When at a code object, return a list whose car is `code' and cdr
2669 is a plist with `:value', `:begin', `:end' and `:post-blank'
2670 keywords. Otherwise, return nil.
2672 Assume point is at the first tilde marker."
2683 :begin begin
2684 :end end
2688 "Interpret CODE object as Org syntax."
2692 ;;;; Entity
2695 "Parse entity at point, if any.
2697 When at an entity, return a list whose car is `entity' and cdr
2698 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2699 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2700 `:post-blank' as keywords. Otherwise, return nil.
2702 Assume point is at the beginning of the entity."
2704 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2722 :begin begin
2723 :end end
2724 :use-brackets-p bracketsp
2728 "Interpret ENTITY object as Org syntax."
2734 ;;;; Export Snippet
2737 "Parse export snippet at point.
2739 When at an export snippet, return a list whose car is
2740 `export-snippet' and cdr a plist with `:begin', `:end',
2741 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2742 return nil.
2744 Assume point is at the beginning of the snippet."
2760 :value value
2761 :begin begin
2762 :end end
2766 "Interpret EXPORT-SNIPPET object as Org syntax."
2772 ;;;; Footnote Reference
2775 "Parse footnote reference at point, if any.
2777 When at a footnote reference, return a list whose car is
2778 `footnote-reference' and cdr a plist with `:label', `:type',
2779 `:begin', `:end', `:content-begin', `:contents-end' and
2780 `:post-blank' as keywords. Otherwise, return nil."
2796 :type type
2797 :begin begin
2798 :end end
2804 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2805 CONTENTS is its definition, when inline, or nil."
2811 ;;;; Inline Babel Call
2814 "Parse inline babel call at point, if any.
2816 When at an inline babel call, return a list whose car is
2817 `inline-babel-call' and cdr a plist with `:call',
2818 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2819 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2821 Assume point is at the beginning of the babel call."
2837 :inside-header inside-header
2838 :arguments arguments
2839 :end-header end-header
2840 :begin begin
2841 :end end
2842 :value value
2846 "Interpret INLINE-BABEL-CALL object as Org syntax."
2856 ;;;; Inline Src Block
2859 "Parse inline source block at point, if any.
2861 When at an inline source block, return a list whose car is
2862 `inline-src-block' and cdr a plist with `:begin', `:end',
2863 `:language', `:value', `:parameters' and `:post-blank' as
2864 keywords. Otherwise, return nil.
2866 Assume point is at the beginning of the inline src block."
2879 :value value
2880 :parameters parameters
2881 :begin begin
2882 :end end
2886 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2891 language
2893 body)))
2895 ;;;; Italic
2898 "Parse italic object at point, if any.
2900 When at an italic object, return a list whose car is `italic' and
2901 cdr is a plist with `:begin', `:end', `:contents-begin' and
2902 `:contents-end' and `:post-blank' keywords. Otherwise, return
2903 nil.
2905 Assume point is at the first slash marker."
2917 :end end
2918 :contents-begin contents-begin
2919 :contents-end contents-end
2923 "Interpret italic object as Org syntax.
2924 CONTENTS is the contents of the object."
2928 ;;;; Latex Fragment
2931 "Parse LaTeX fragment at point, if any.
2933 When at a LaTeX fragment, return a list whose car is
2934 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2935 and `:post-blank' as keywords. Otherwise, return nil.
2937 Assume point is at the beginning of the LaTeX fragment."
2955 ;; Macro.
2965 :begin begin
2966 :end end
2970 "Interpret LATEX-FRAGMENT object as Org syntax."
2973 ;;;; Line Break
2976 "Parse line break at point, if any.
2978 When at a line break, return a list whose car is `line-break',
2979 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2980 Otherwise, return nil.
2982 Assume point is at the beginning of the line break."
2991 "Interpret LINE-BREAK object as Org syntax."
2995 ;;;; Link
2998 "Parse link at point, if any.
3000 When at a link, return a list whose car is `link' and cdr a plist
3001 with `:type', `:path', `:raw-link', `:application',
3002 `:search-option', `:begin', `:end', `:contents-begin',
3003 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3004 nil.
3006 Assume point is at the beginning of the link."
3009 end contents-begin contents-end link-end post-blank path type
3010 raw-link search-option application)
3012 ;; Type 1: Text targeted from a radio target.
3021 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3026 ;; RAW-LINK is the original link. Expand any
3027 ;; abbreviation in it.
3028 ;;
3029 ;; Also treat any newline character and associated
3030 ;; indentation as a single space character. This is not
3031 ;; compatible with RFC 3986, which requires to ignore
3032 ;; them altogether. However, doing so would require
3033 ;; users to encode spaces on the fly when writing links
3034 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3035 ;; [[shell:ls *.org]], which defeats Org's focus on
3036 ;; simplicity.
3041 ;; Determine TYPE of link and set PATH accordingly. According
3042 ;; to RFC 3986, remove whitespaces from URI in external links.
3043 ;; In internal ones, treat indentation as a single space.
3045 ;; File type.
3050 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3054 ;; Id type: PATH is the id.
3057 ;; Code-ref type: PATH is the name of the reference.
3062 ;; Custom-id type: PATH is the name of the custom id.
3066 ;; Fuzzy type: Internal link either matches a target, an
3067 ;; headline name or nothing. PATH is the target or
3068 ;; headline's name.
3072 ;; Type 3: Plain link, e.g., http://orgmode.org
3078 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3079 ;; bracket links, follow RFC 3986 and remove any extra
3080 ;; whitespace in URI.
3090 ;; In any case, deduce end point after trailing white space from
3091 ;; LINK-END variable.
3096 ;; Special "file" type link processing. Extract opening
3097 ;; application and search option, if any. Also normalize URI.
3104 ;; Translate link, if `org-link-translation-function' is set.
3112 :path path
3114 :application application
3115 :search-option search-option
3116 :begin begin
3117 :end end
3118 :contents-begin contents-begin
3119 :contents-end contents-end
3123 "Interpret LINK object as Org syntax.
3124 CONTENTS is the contents of the object, or nil."
3135 path
3142 ;;;; Macro
3145 "Parse macro at point, if any.
3147 When at a macro, return a list whose car is `macro' and cdr
3148 a plist with `:key', `:args', `:begin', `:end', `:value' and
3149 `:post-blank' as keywords. Otherwise, return nil.
3151 Assume point is at the macro."
3164 :value value
3165 :args args
3166 :begin begin
3167 :end end
3171 "Interpret MACRO object as Org syntax."
3175 ;;;; Radio-target
3178 "Parse radio target at point, if any.
3180 When at a radio target, return a list whose car is `radio-target'
3181 and cdr a plist with `:begin', `:end', `:contents-begin',
3182 `:contents-end', `:value' and `:post-blank' as keywords.
3183 Otherwise, return nil.
3185 Assume point is at the radio target."
3197 :end end
3198 :contents-begin contents-begin
3199 :contents-end contents-end
3200 :post-blank post-blank
3204 "Interpret target object as Org syntax.
3205 CONTENTS is the contents of the object."
3209 ;;;; Statistics Cookie
3212 "Parse statistics cookie at point, if any.
3214 When at a statistics cookie, return a list whose car is
3215 `statistics-cookie', and cdr a plist with `:begin', `:end',
3216 `:value' and `:post-blank' keywords. Otherwise, return nil.
3218 Assume point is at the beginning of the statistics-cookie."
3229 :end end
3230 :value value
3234 "Interpret STATISTICS-COOKIE object as Org syntax."
3238 ;;;; Strike-Through
3241 "Parse strike-through object at point, if any.
3243 When at a strike-through object, return a list whose car is
3244 `strike-through' and cdr is a plist with `:begin', `:end',
3245 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3246 Otherwise, return nil.
3248 Assume point is at the first plus sign marker."
3260 :end end
3261 :contents-begin contents-begin
3262 :contents-end contents-end
3266 "Interpret strike-through object as Org syntax.
3267 CONTENTS is the contents of the object."
3271 ;;;; Subscript
3274 "Parse subscript at point, if any.
3276 When at a subscript object, return a list whose car is
3277 `subscript' and cdr a plist with `:begin', `:end',
3278 `:contents-begin', `:contents-end', `:use-brackets-p' and
3279 `:post-blank' as keywords. Otherwise, return nil.
3281 Assume point is at the underscore."
3295 :end end
3296 :use-brackets-p bracketsp
3297 :contents-begin contents-begin
3298 :contents-end contents-end
3302 "Interpret SUBSCRIPT object as Org syntax.
3303 CONTENTS is the contents of the object."
3306 contents))
3309 ;;;; Superscript
3312 "Parse superscript at point, if any.
3314 When at a superscript object, return a list whose car is
3315 `superscript' and cdr a plist with `:begin', `:end',
3316 `:contents-begin', `:contents-end', `:use-brackets-p' and
3317 `:post-blank' as keywords. Otherwise, return nil.
3319 Assume point is at the caret."
3333 :end end
3334 :use-brackets-p bracketsp
3335 :contents-begin contents-begin
3336 :contents-end contents-end
3340 "Interpret SUPERSCRIPT object as Org syntax.
3341 CONTENTS is the contents of the object."
3344 contents))
3347 ;;;; Table Cell
3350 "Parse table cell at point.
3351 Return a list whose car is `table-cell' and cdr is a plist
3352 containing `:begin', `:end', `:contents-begin', `:contents-end'
3353 and `:post-blank' keywords."
3361 :end end
3362 :contents-begin contents-begin
3363 :contents-end contents-end
3367 "Interpret table-cell element as Org syntax.
3368 CONTENTS is the contents of the cell, or nil."
3372 ;;;; Target
3375 "Parse target at point, if any.
3377 When at a target, return a list whose car is `target' and cdr
3378 a plist with `:begin', `:end', `:value' and `:post-blank' as
3379 keywords. Otherwise, return nil.
3381 Assume point is at the target."
3391 :end end
3392 :value value
3396 "Interpret TARGET object as Org syntax."
3400 ;;;; Timestamp
3411 "Parse time stamp at point, if any.
3413 When at a time stamp, return a list whose car is `timestamp', and
3414 cdr a plist with `:type', `:raw-value', `:year-start',
3415 `:month-start', `:day-start', `:hour-start', `:minute-start',
3416 `:year-end', `:month-end', `:day-end', `:hour-end',
3417 `:minute-end', `:repeater-type', `:repeater-value',
3418 `:repeater-unit', `:warning-type', `:warning-value',
3419 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3420 Otherwise, return nil.
3422 Assume point is at the beginning of the timestamp."
3441 date-start)
3452 raw-value)
3454 :repeater-type
3460 :repeater-unit
3469 :warning-unit
3472 year-start month-start day-start hour-start minute-start year-end
3473 month-end day-end hour-end minute-end)
3474 ;; Parse date-start.
3482 ;; Compute date-end. It can be provided directly in time-stamp,
3483 ;; or extracted from time range. Otherwise, it defaults to the
3484 ;; same values as date-start.
3494 :raw-value raw-value
3495 :year-start year-start
3496 :month-start month-start
3497 :day-start day-start
3498 :hour-start hour-start
3499 :minute-start minute-start
3500 :year-end year-end
3501 :month-end month-end
3502 :day-end day-end
3503 :hour-end hour-end
3504 :minute-end minute-end
3505 :begin begin
3506 :end end
3508 repeater-props
3509 warning-props))))))
3512 "Interpret TIMESTAMP object as Org syntax."
3530 ;; Build an Org timestamp string from TIME. ACTIVEP is
3531 ;; non-nil when time stamp is active. If WITH-TIME-P is
3532 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3533 ;; specify a time range in the timestamp. REPEAT-STRING is
3534 ;; the repeater string, if any.
3538 org-time-stamp-formats)
3539 time)))
3545 nil nil ts)))
3550 " "
3551 s
3553 ;; Return value.
3554 ts)))
3566 build-ts-string
3585 0
3593 "--"
3606 ;;;; Underline
3609 "Parse underline object at point, if any.
3611 When at an underline object, return a list whose car is
3612 `underline' and cdr is a plist with `:begin', `:end',
3613 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3614 Otherwise, return nil.
3616 Assume point is at the first underscore marker."
3628 :end end
3629 :contents-begin contents-begin
3630 :contents-end contents-end
3634 "Interpret underline object as Org syntax.
3635 CONTENTS is the contents of the object."
3639 ;;;; Verbatim
3642 "Parse verbatim object at point, if any.
3644 When at a verbatim object, return a list whose car is `verbatim'
3645 and cdr is a plist with `:value', `:begin', `:end' and
3646 `:post-blank' keywords. Otherwise, return nil.
3648 Assume point is at the first equal sign marker."
3659 :begin begin
3660 :end end
3664 "Interpret VERBATIM object as Org syntax."
3668 \f
3669 ;;; Parsing Element Starting At Point
3670 ;;
3671 ;; `org-element--current-element' is the core function of this section.
3672 ;; It returns the Lisp representation of the element starting at
3673 ;; point.
3674 ;;
3675 ;; `org-element--current-element' makes use of special modes. They
3676 ;; are activated for fixed element chaining (e.g., `plain-list' >
3677 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3678 ;; `section'). Special modes are: `first-section', `item',
3679 ;; `node-property', `section' and `table-row'.
3682 "Parse the element starting at point.
3684 Return value is a list like (TYPE PROPS) where TYPE is the type
3685 of the element and PROPS a plist of properties associated to the
3686 element.
3688 Possible types are defined in `org-element-all-elements'.
3690 LIMIT bounds the search.
3692 Optional argument GRANULARITY determines the depth of the
3693 recursion. Allowed values are `headline', `greater-element',
3694 `element', `object' or nil. When it is broader than `object' (or
3695 nil), secondary values will not be parsed, since they only
3696 contain objects.
3698 Optional argument MODE, when non-nil, can be either
3699 `first-section', `section', `planning', `item', `node-property'
3700 and `table-row'.
3702 If STRUCTURE isn't provided but MODE is set to `item', it will be
3703 computed.
3705 This function assumes point is always at the beginning of the
3706 element it has to parse."
3709 ;; Determine if parsing depth allows for secondary strings
3710 ;; parsing. It only applies to elements referenced in
3711 ;; `org-element-secondary-value-alist'.
3714 ;; Item.
3717 ;; Table Row.
3719 ;; Node Property.
3721 ;; Headline.
3724 ;; Sections (must be checked after headline).
3729 limit)))
3730 ;; Planning.
3733 ;; Property drawer.
3737 ;; When not at bol, point is at the beginning of an item or
3738 ;; a footnote definition: next item is always a paragraph.
3740 ;; Clock.
3742 ;; Inlinetask.
3745 ;; From there, elements can have affiliated keywords.
3748 ;; Jumping over affiliated keywords put point off-limits.
3749 ;; Parse them as regular keywords.
3753 ;; LaTeX Environment.
3756 ;; Drawer and Property Drawer.
3759 ;; Fixed Width
3762 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3763 ;; Keywords.
3781 limit
3782 affiliated))
3795 ;; Footnote Definition.
3798 ;; Horizontal Rule.
3801 ;; Diary Sexp.
3804 ;; Table.
3807 ;; List.
3810 limit affiliated
3812 ;; Default element: Paragraph.
3816 ;; Most elements can have affiliated keywords. When looking for an
3817 ;; element beginning, we want to move before them, as they belong to
3818 ;; that element, and, in the meantime, collect information they give
3819 ;; into appropriate properties. Hence the following function.
3822 "Collect affiliated keywords from point down to LIMIT.
3824 Return a list whose CAR is the position at the first of them and
3825 CDR a plist of keywords and values and move point to the
3826 beginning of the first line after them.
3828 As a special case, if element doesn't start at the beginning of
3829 the line (e.g., a paragraph starting an item), CAR is current
3830 position of point and CDR is nil."
3834 ;; RESTRICT is the list of objects allowed in parsed
3835 ;; keywords value.
3837 output)
3840 ;; Apply translation to RAW-KWD. From there, KWD is
3841 ;; the official keyword.
3843 org-element-keyword-translation-alist))
3844 raw-kwd))
3845 ;; Find main value for any keyword.
3851 ;; PARSEDP is non-nil when keyword should have its
3852 ;; value parsed.
3854 ;; If KWD is a dual keyword, find its secondary
3855 ;; value. Maybe parse it.
3864 ;; Attribute a property name to KWD.
3866 ;; Now set final shape for VALUE.
3872 nil restrict)))
3876 ;; Attributes can always appear on multiple lines.
3879 ;; Eventually store the new value in OUTPUT.
3881 ;; Move to next keyword.
3883 ;; If affiliated keywords are orphaned: move back to first one.
3884 ;; They will be parsed as a paragraph.
3886 ;; Return value.
3890 \f
3891 ;;; The Org Parser
3892 ;;
3893 ;; The two major functions here are `org-element-parse-buffer', which
3894 ;; parses Org syntax inside the current buffer, taking into account
3895 ;; region, narrowing, or even visibility if specified, and
3896 ;; `org-element-parse-secondary-string', which parses objects within
3897 ;; a given string.
3898 ;;
3899 ;; The (almost) almighty `org-element-map' allows applying a function
3900 ;; on elements or objects matching some type, and accumulating the
3901 ;; resulting values. In an export situation, it also skips unneeded
3902 ;; parts of the parse tree.
3905 "Recursively parse the buffer and return structure.
3906 If narrowing is in effect, only parse the visible part of the
3907 buffer.
3909 Optional argument GRANULARITY determines the depth of the
3910 recursion. It can be set to the following symbols:
3912 `headline' Only parse headlines.
3913 `greater-element' Don't recurse into greater elements excepted
3914 headlines and sections. Thus, elements
3915 parsed are the top-level ones.
3916 `element' Parse everything but objects and plain text.
3917 `object' Parse the complete buffer (default).
3919 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3920 elements.
3922 An element or an objects is represented as a list with the
3923 pattern (TYPE PROPERTIES CONTENTS), where :
3925 TYPE is a symbol describing the element or object. See
3926 `org-element-all-elements' and `org-element-all-objects' for an
3927 exhaustive list of such symbols. One can retrieve it with
3928 `org-element-type' function.
3930 PROPERTIES is the list of attributes attached to the element or
3931 object, as a plist. Although most of them are specific to the
3932 element or object type, all types share `:begin', `:end',
3933 `:post-blank' and `:parent' properties, which respectively
3934 refer to buffer position where the element or object starts,
3935 ends, the number of white spaces or blank lines after it, and
3936 the element or object containing it. Properties values can be
3937 obtained by using `org-element-property' function.
3939 CONTENTS is a list of elements, objects or raw strings
3940 contained in the current element or object, when applicable.
3941 One can access them with `org-element-contents' function.
3943 The Org buffer has `org-data' as type and nil as properties.
3944 `org-element-map' function can be used to find specific elements
3945 or objects within the parse tree.
3947 This function assumes that current major mode is `org-mode'."
3953 ;; Start in `first-section' mode so text before the first
3954 ;; headline belongs to a section.
3958 "Recursively parse objects in STRING and return structure.
3960 RESTRICTION is a symbol limiting the object types that will be
3961 looked after.
3963 Optional argument PARENT, when non-nil, is the element or object
3964 containing the secondary string. It is used to set correctly
3965 `:parent' property within the string.
3967 If STRING is the empty string or nil, return nil."
3984 "Map a function on selected elements or objects.
3986 DATA is a parse tree, an element, an object, a string, or a list
3987 of such constructs. TYPES is a symbol or list of symbols of
3988 elements or objects types (see `org-element-all-elements' and
3989 `org-element-all-objects' for a complete list of types). FUN is
3990 the function called on the matching element or object. It has to
3991 accept one argument: the element or object itself.
3993 When optional argument INFO is non-nil, it should be a plist
3994 holding export options. In that case, parts of the parse tree
3995 not exportable according to that property list will be skipped.
3997 When optional argument FIRST-MATCH is non-nil, stop at the first
3998 match for which FUN doesn't return nil, and return that value.
4000 Optional argument NO-RECURSION is a symbol or a list of symbols
4001 representing elements or objects types. `org-element-map' won't
4002 enter any recursive element or object whose type belongs to that
4003 list. Though, FUN can still be applied on them.
4005 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4006 apply to matching objects within parsed affiliated keywords (see
4007 `org-element-parsed-keywords').
4009 Nil values returned from FUN do not appear in the results.
4012 Examples:
4013 ---------
4015 Assuming TREE is a variable containing an Org buffer parse tree,
4016 the following example will return a flat list of all `src-block'
4017 and `example-block' elements in it:
4021 The following snippet will find the first headline with a level
4025 (lambda (hl)
4026 (and (= (org-element-property :level hl) 1)
4028 (org-element-property :begin hl)))
4029 nil t)
4031 The next example will return a flat list of all `plain-list' type
4032 elements in TREE that are not a sub-list themselves:
4036 Eventually, this example will return a flat list of all `bold'
4037 type objects containing a `latex-snippet' type object, even
4038 looking into captions:
4041 (lambda (b)
4043 nil nil nil t)"
4044 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4048 ;; Recursion depth is determined by --CATEGORY.
4055 ;; If one object is found, the function has
4056 ;; to recurse into every object.
4059 ;; If one regular element is found, the
4060 ;; function has to recurse, at least, into
4061 ;; every element it encounters.
4064 --acc)
4067 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4068 ;; holding contextual information.
4072 ;; Ignored element in an export context.
4074 ;; List of elements or objects.
4076 ;; Unconditionally enter parse trees.
4080 ;; Check if TYPE is matching among TYPES. If so,
4081 ;; apply FUN to --DATA and accumulate return value
4082 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4088 ;; If --DATA has a secondary string that can contain
4089 ;; objects with their type among TYPES, look inside.
4092 org-element-secondary-value-alist)))
4094 ;; If --DATA has any parsed affiliated keywords and
4095 ;; WITH-AFFILIATED is non-nil, look for objects in
4096 ;; them.
4103 ;; Pay attention to the type of parsed
4104 ;; keyword. In particular, preserve order for
4105 ;; multiple keywords.
4118 ;; Determine if a recursion into --DATA is possible.
4120 ;; --TYPE is explicitly removed from recursion.
4122 ;; --DATA has no contents.
4124 ;; Looking for greater elements but --DATA is
4125 ;; simply an element or an object.
4128 ;; Looking for elements but --DATA is an object.
4131 ;; In any other case, map contents.
4135 ;; Return value in a proper order.
4139 ;; The following functions are internal parts of the parser.
4140 ;;
4141 ;; The first one, `org-element--parse-elements' acts at the element's
4142 ;; level.
4143 ;;
4144 ;; The second one, `org-element--parse-objects' applies on all objects
4145 ;; of a paragraph or a secondary string. It calls
4146 ;; `org-element--object-lex' to find the next object in the current
4147 ;; container.
4150 "Return next special mode according to TYPE, or nil.
4151 TYPE is a symbol representing the type of an element or object
4152 containing next element if PARENTP is non-nil, or before it
4153 otherwise. Modes can be either `first-section', `item',
4154 `node-property', `planning', `property-drawer', `section',
4155 `table-row' or nil."
4172 "Parse elements between BEG and END positions.
4174 MODE prioritizes some elements over the others. It can be set to
4175 `first-section', `section', `planning', `item', `node-property'
4176 or `table-row'.
4178 When value is `item', STRUCTURE will be used as the current list
4179 structure.
4181 GRANULARITY determines the depth of the recursion. See
4182 `org-element-parse-buffer' for more information.
4184 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4185 elements.
4187 Elements are accumulated into ACC."
4190 ;; Visible only: skip invisible parts at the beginning of the
4191 ;; element.
4194 ;; When parsing only headlines, skip any text before first one.
4199 ;; Find current element's type and parse it accordingly to
4200 ;; its category.
4202 end granularity mode structure))
4206 ;; Visible only: skip invisible parts between siblings.
4209 ;; Fill ELEMENT contents by side-effect.
4211 ;; If element has no contents, don't modify it.
4213 ;; Greater element: parse it between `contents-begin' and
4214 ;; `contents-end'. Make sure GRANULARITY allows the
4215 ;; recursion, or ELEMENT is a headline, in which case going
4216 ;; inside is mandatory, in order to get sub-level headings.
4224 ;; Possibly switch to a special mode.
4228 granularity visible-only element))
4229 ;; ELEMENT has contents. Parse objects inside, if
4230 ;; GRANULARITY allows it.
4236 ;; Update mode.
4238 ;; Return result.
4242 "Return next object in current buffer or nil.
4243 RESTRICTION is a list of object types, as symbols, that should be
4244 looked after. This function assumes that the buffer is narrowed
4245 to an appropriate container (e.g., a paragraph)."
4253 found)
4318 ;; This is probably a plain link.
4324 ;; Radio link.
4329 "Parse objects between BEG and END and return recursive structure.
4331 Objects are accumulated in ACC. RESTRICTION is a list of object
4332 successors which are allowed in the current object.
4334 ACC becomes the parent for all parsed objects. However, if ACC
4335 is nil (i.e., a secondary string is being parsed) and optional
4336 argument PARENT is non-nil, use it as the parent for all objects.
4337 Eventually, if both ACC and PARENT are nil, the common parent is
4338 the list of objects itself."
4346 ;; Text before any object. Untabify it.
4351 contents))))
4352 ;; Object...
4357 ;; Fill contents of NEXT-OBJECT if possible.
4359 cont-beg
4361 next-object
4363 next-object)
4364 contents)
4366 ;; Text after last object. Untabify it.
4370 contents)))
4371 ;; Result. Set appropriate parent.
4379 \f
4380 ;;; Towards A Bijective Process
4381 ;;
4382 ;; The parse tree obtained with `org-element-parse-buffer' is really
4383 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4384 ;; interpreted and expanded into a string with canonical Org syntax.
4385 ;; Hence `org-element-interpret-data'.
4386 ;;
4387 ;; The function relies internally on
4388 ;; `org-element--interpret-affiliated-keywords'.
4390 ;;;###autoload
4392 "Interpret DATA as Org syntax.
4393 DATA is a parse tree, an element, an object or a secondary string
4394 to interpret. Return Org syntax as a string."
4398 ;; Find interpreter for current object or
4399 ;; element. If it doesn't exist (e.g. this is
4400 ;; a pseudo object or element), return contents,
4401 ;; if any.
4408 ;; Secondary string.
4412 ;; Full Org document.
4416 ;; Plain text: return it.
4418 ;; Element or object without contents.
4421 ;; Element or object with contents.
4424 interpret
4425 --data
4426 ;; Recursively interpret contents.
4431 --data
4432 ;; Fix indentation of elements containing
4433 ;; objects. We ignore `table-row'
4434 ;; elements as they are one line long
4435 ;; anyway.
4437 --data
4438 ;; When normalizing first paragraph of
4439 ;; an item or a footnote-definition,
4440 ;; ignore first line's indentation.
4448 ;; Build white spaces. If no `:post-blank' property
4449 ;; is specified, assume its value is 0.
4464 "Return ELEMENT's affiliated keywords as Org syntax.
4465 If there is no affiliated keyword, return the empty string."
4475 ": "
4478 value)
4486 ;; All attribute keywords can have multiple lines.
4492 ;; List all ELEMENT's properties matching an attribute line or an
4493 ;; affiliated keyword, but ignore translated keywords since they
4494 ;; cannot belong to the property list.
4501 org-element-keyword-translation-alist)))))
4502 collect prop)
4505 ;; Because interpretation of the parse tree must return the same
4506 ;; number of blank lines between elements and the same number of white
4507 ;; space after objects, some special care must be given to white
4508 ;; spaces.
4509 ;;
4510 ;; The first function, `org-element-normalize-string', ensures any
4511 ;; string different from the empty string will end with a single
4512 ;; newline character.
4513 ;;
4514 ;; The second function, `org-element-normalize-contents', removes
4515 ;; global indentation from the contents of the current element.
4518 "Ensure string S ends with a single newline character.
4520 If S isn't a string return it unchanged. If S is the empty
4521 string, return it. Otherwise, return a new string with a single
4522 newline character at its end."
4530 "Normalize plain text in ELEMENT's contents.
4532 ELEMENT must only contain plain text and objects.
4534 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4535 indentation to compute maximal common indentation.
4537 Return the normalized element that is element with global
4538 indentation removed from its contents."
4540 ;; Return minimal common indentation within BLOB. This is
4541 ;; done by walking recursively BLOB and updating MIN-IND
4542 ;; along the way. FIRST-FLAG is non-nil when the next
4543 ;; object is expected to be a string that doesn't start
4544 ;; with a newline character. It happens for strings at
4545 ;; the beginnings of the contents or right after a line
4546 ;; break.
4553 ;; Objects cannot start with spaces: in this
4554 ;; case, indentation is 0.
4577 datum)
4590 ;; Build ELEMENT back, replacing each string with the same
4591 ;; string minus common indentation.
4594 ;; Return DATUM with all its strings indentation
4595 ;; shortened from MIN-IND white spaces.
4615 org-element-recursive-objects)
4619 datum)))
4623 \f
4624 ;;; Cache
4625 ;;
4626 ;; Implement a caching mechanism for `org-element-at-point' and
4627 ;; `org-element-context', which see.
4628 ;;
4629 ;; A single public function is provided: `org-element-cache-reset'.
4630 ;;
4631 ;; Cache is enabled by default, but can be disabled globally with
4632 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4633 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4634 ;; can be tweaked to control caching behaviour.
4635 ;;
4636 ;; Internally, parsed elements are stored in an AVL tree,
4637 ;; `org-element--cache'. This tree is updated lazily: whenever
4638 ;; a change happens to the buffer, a synchronization request is
4639 ;; registered in `org-element--cache-sync-requests' (see
4640 ;; `org-element--cache-submit-request'). During idle time, requests
4641 ;; are processed by `org-element--cache-sync'. Synchronization also
4642 ;; happens when an element is required from the cache. In this case,
4643 ;; the process stops as soon as the needed element is up-to-date.
4644 ;;
4645 ;; A synchronization request can only apply on a synchronized part of
4646 ;; the cache. Therefore, the cache is updated at least to the
4647 ;; location where the new request applies. Thus, requests are ordered
4648 ;; from left to right and all elements starting before the first
4649 ;; request are correct. This property is used by functions like
4650 ;; `org-element--cache-find' to retrieve elements in the part of the
4651 ;; cache that can be trusted.
4652 ;;
4653 ;; A request applies to every element, starting from its original
4654 ;; location (or key, see below). When a request is processed, it
4655 ;; moves forward and may collide the next one. In this case, both
4656 ;; requests are merged into a new one that starts from that element.
4657 ;; As a consequence, the whole synchronization complexity does not
4658 ;; depend on the number of pending requests, but on the number of
4659 ;; elements the very first request will be applied on.
4660 ;;
4661 ;; Elements cannot be accessed through their beginning position, which
4662 ;; may or may not be up-to-date. Instead, each element in the tree is
4663 ;; associated to a key, obtained with `org-element--cache-key'. This
4664 ;; mechanism is robust enough to preserve total order among elements
4665 ;; even when the tree is only partially synchronized.
4666 ;;
4667 ;; Objects contained in an element are stored in a hash table,
4668 ;; `org-element--cache-objects'.
4672 "Non nil when Org parser should cache its results.
4679 "Maximum duration, as a time value, for a cache synchronization.
4680 If the synchronization is not over after this delay, the process
4681 pauses and resumes after `org-element-cache-sync-break'
4685 "Duration, as a time value, of the pause between synchronizations.
4689 ;;;; Data Structure
4692 "AVL tree used to cache elements.
4693 Each node of the tree contains an element. Comparison is done
4694 with `org-element--cache-compare'. This cache is used in
4698 "Hash table used as to cache objects.
4699 Key is an element, as returned by `org-element-at-point', and
4700 value is an alist where each association is:
4702 \(PARENT COMPLETEP . OBJECTS)
4704 where PARENT is an element or object, COMPLETEP is a boolean,
4705 non-nil when all direct children of parent are already cached and
4706 OBJECTS is a list of such children, as objects, from farthest to
4707 closest.
4710 contained within a paragraph
4714 If the paragraph is completely parsed, OBJECTS-DATA will be
4716 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4717 \(BOLD-OBJECT t ENTITY-OBJECT))
4719 whereas in a partially parsed paragraph, it could be
4721 \((PARAGRAPH nil ENTITY-OBJECT))
4726 "List of pending synchronization requests.
4728 A request is a vector with the following pattern:
4730 \[NEXT BEG END OFFSET PARENT PHASE]
4732 Processing a synchronization request consists of three phases:
4734 0. Delete modified elements,
4735 1. Fill missing area in cache,
4736 2. Shift positions and re-parent elements after the changes.
4738 During phase 0, NEXT is the key of the first element to be
4739 removed, BEG and END is buffer position delimiting the
4740 modifications. Elements starting between them (inclusive) are
4741 removed. So are elements whose parent is removed. PARENT, when
4742 non-nil, is the parent of the first element to be removed.
4744 During phase 1, NEXT is the key of the next known element in
4745 cache and BEG its beginning position. Parse buffer between that
4746 element and the one before it in order to determine the parent of
4747 the next element. Set PARENT to the element containing NEXT.
4749 During phase 2, NEXT is the key of the next element to shift in
4750 the parse tree. All elements starting from this one have their
4751 properties relatives to buffer positions shifted by integer
4752 OFFSET and, if they belong to element PARENT, are adopted by it.
4760 "Hash table used to store keys during synchronization.
4764 "Return a unique key for ELEMENT in cache tree.
4766 Keys are used to keep a total order among elements in the cache.
4767 Comparison is done with `org-element--cache-key-less-p'.
4769 When no synchronization is taking place, a key is simply the
4770 beginning position of the element, or that position plus one in
4771 the case of an first item (respectively row) in
4772 a list (respectively a table).
4774 During a synchronization, the key is the one the element had when
4775 the cache was synchronized for the last time. Elements added to
4776 cache during the synchronization get a new key generated with
4777 `org-element--cache-generate-key'.
4779 Such keys are stored in `org-element--cache-sync-keys'. The hash
4780 table is cleared once the synchronization is complete."
4783 ;; Increase beginning position of items (respectively
4784 ;; table rows) by one, so the first item can get
4785 ;; a different key from its parent list (respectively
4786 ;; table).
4789 begin)))
4792 key))))
4795 "Generate a key between LOWER and UPPER.
4797 LOWER and UPPER are integers or lists, possibly empty.
4799 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4800 a unique key, as an integer or a list of integers, according to
4801 the following rules:
4803 - LOWER and UPPER are compared level-wise until values differ.
4805 - If, at a given level, LOWER and UPPER differ from more than
4806 2, the new key shares all the levels above with LOWER and
4807 gets a new level. Its value is the mean between LOWER and
4808 UPPER:
4810 \(1 2) + (1 4) --> (1 3)
4812 - If LOWER has no value to compare with, it is assumed that its
4813 value is `most-negative-fixnum'. E.g.,
4815 \(1 1) + (1 1 2)
4817 is equivalent to
4819 \(1 1 m) + (1 1 2)
4821 where m is `most-negative-fixnum'. Likewise, if UPPER is
4822 short of levels, the current value is `most-positive-fixnum'.
4824 - If they differ from only one, the new key inherits from
4825 current LOWER level and fork it at the next level. E.g.,
4827 \(2 1) + (3 3)
4829 is equivalent to
4831 \(2 1) + (2 M)
4833 where M is `most-positive-fixnum'.
4835 - If the key is only one level long, it is returned as an
4836 integer:
4838 \(1 2) + (3 2) --> 2
4840 When they are not equals, the function assumes that LOWER is
4841 lesser than UPPER, per `org-element--cache-key-less-p'."
4845 skip-upper key)
4856 ;; When at a given level, LOWER and UPPER differ from
4857 ;; 1, ignore UPPER altogether. Instead create a key
4858 ;; between LOWER and the greatest key with the same
4859 ;; prefix as LOWER so far.
4865 "Non-nil if key A is less than key B.
4866 A and B are either integers or lists of integers, as returned by
4867 `org-element--cache-key'."
4875 ;; If A is empty, either keys are equal (B is also empty) and
4876 ;; we return nil, or A is lesser than B (B is longer) and we
4877 ;; return a non-nil value.
4878 ;;
4879 ;; If A is not empty, B is necessarily empty and A is greater
4880 ;; than B (A is longer). Therefore, return nil.
4884 "Non-nil when element A is located before element B."
4889 "Return root value in cache.
4890 This function assumes `org-element--cache' is a valid AVL tree."
4894 ;;;; Tools
4897 "Non-nil when cache is active in current buffer."
4899 org-element--cache
4903 "Find element in cache starting at POS or before.
4905 POS refers to a buffer position.
4907 When optional argument SIDE is non-nil, the function checks for
4908 elements starting at or past POS instead. If SIDE is `both', the
4909 function returns a cons cell where car is the first element
4910 starting at or before POS and cdr the first element starting
4911 after POS.
4913 The function can only find elements in the synchronized part of
4914 the cache."
4918 lower upper)
4933 ;; We found an element in cache starting at POS. If `side'
4934 ;; is `both' we also want the next one in order to generate
4935 ;; a key in-between.
4936 ;;
4937 ;; If the element is the first row or item in a table or
4938 ;; a plain list, we always return the table or the plain
4939 ;; list.
4940 ;;
4941 ;; In any other case, we return the element found.
4950 lower parent
4951 upper parent)))))
4954 lower element
4955 upper element)))))
4962 "Store ELEMENT in current buffer's cache, if allowed.
4963 When optional argument DATA is non-nil, assume is it object data
4964 relative to ELEMENT and store it in the objects cache."
4968 ;; During synchronization, first build an appropriate key
4969 ;; for the new element so `avl-tree-enter' can insert it at
4970 ;; the right spot in the cache.
4979 org-element--cache-sync-keys)))
4981 ;; Headlines are not stored in cache, so objects in titles are
4982 ;; not stored either.
4987 "Remove ELEMENT from cache.
4988 Assume ELEMENT belongs to cache and that a cache is active."
4993 ;;;; Synchronization
4996 "Set idle timer for cache synchronization in BUFFER."
5003 org-element-cache-sync-idle-time))
5004 nil
5005 #'org-element--cache-sync
5006 buffer)))
5009 "Non-nil when synchronization process should be interrupted.
5010 TIME-LIMIT is a time value or nil."
5016 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5018 Properties containing buffer positions are `:begin', `:end',
5019 `:contents-begin', `:contents-end' and `:structure'. When
5020 optional argument PROPS is a list of keywords, only shift
5021 properties provided in that list.
5023 Properties are modified by side-effect."
5025 ;; Shift `:structure' property for the first plain list only: it
5026 ;; is the only one that really matters and it prevents from
5027 ;; shifting it more than once.
5041 "Synchronize cache with recent modification in BUFFER.
5043 When optional argument THRESHOLD is non-nil, do the
5044 synchronization for all elements starting before or at threshold,
5045 then exit. Otherwise, synchronize cache for as long as
5046 `org-element-cache-sync-duration' or until Emacs leaves idle
5047 state.
5049 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5050 not registered yet in the cache are going to happen. It is used
5051 in `org-element--cache-submit-request', where cache is partially
5052 updated before current modification are actually submitted."
5063 request
5065 threshold
5068 org-element-cache-sync-duration))
5069 future-change)
5070 ;; Request processed. Merge current and next offsets and
5071 ;; transfer ending position.
5077 ;; If more requests are awaiting, set idle timer accordingly.
5078 ;; Otherwise, reset keys.
5085 "Process synchronization REQUEST for all entries before NEXT.
5087 REQUEST is a vector, built by `org-element--cache-submit-request'.
5089 NEXT is a cache key, as returned by `org-element--cache-key'.
5091 When non-nil, THRESHOLD is a buffer position. Synchronization
5092 stops as soon as a shifted element begins after it.
5094 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5095 after this time or when Emacs exits idle state.
5097 When non-nil, FUTURE-CHANGE is a buffer position where changes
5098 not registered yet in the cache are going to happen. See
5099 `org-element--cache-submit-request' for more information.
5101 Throw `interrupt' if the process stops before completing the
5102 request."
5105 ;; Phase 0.
5106 ;;
5107 ;; Delete all elements starting after BEG, but not after buffer
5108 ;; position END or past element with key NEXT. Also delete
5109 ;; elements contained within a previously removed element
5110 ;; (stored in `last-container').
5111 ;;
5112 ;; At each iteration, we start again at tree root since
5113 ;; a deletion modifies structure of the balanced tree.
5118 ;; Find first element in cache with key BEG or after it.
5122 data data-key last-container)
5131 data-key key
5134 data-key key
5135 node nil)))))
5145 up)))
5148 end))
5155 ;; No element starting after modifications left in
5156 ;; cache: further processing is futile.
5159 ;; Phase 1.
5160 ;;
5161 ;; Phase 0 left a hole in the cache. Some elements after it
5162 ;; could have parents within. For example, in the following
5163 ;; buffer:
5164 ;;
5165 ;; - item
5166 ;;
5167 ;;
5168 ;; Paragraph1
5169 ;;
5170 ;; Paragraph2
5171 ;;
5172 ;; if we remove a blank line between "item" and "Paragraph1",
5173 ;; everything down to "Paragraph2" is removed from cache. But
5174 ;; the paragraph now belongs to the list, and its `:parent'
5175 ;; property no longer is accurate.
5176 ;;
5177 ;; Therefore we need to parse again elements in the hole, or at
5178 ;; least in its last section, so that we can re-parent
5179 ;; subsequent elements, during phase 2.
5180 ;;
5181 ;; Note that we only need to get the parent from the first
5182 ;; element in cache after the hole.
5183 ;;
5184 ;; When next key is lesser or equal to the current one, delegate
5185 ;; phase 1 processing to next request in order to preserve key
5186 ;; order among requests.
5194 ;; Next element will start at its beginning position plus
5195 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5196 ;; contains the real beginning position of the first element to
5197 ;; shift and re-parent.
5201 ;; Changes are going to happen around this element and
5202 ;; they will trigger another phase 1 request. Skip the
5203 ;; current one.
5209 ;; Phase 2.
5210 ;;
5211 ;; Shift all elements starting from key START, but before NEXT, by
5212 ;; OFFSET, and re-parent them when appropriate.
5213 ;;
5214 ;; Elements are modified by side-effect so the tree structure
5215 ;; remains intact.
5216 ;;
5217 ;; Once THRESHOLD, if any, is reached, or once there is an input
5218 ;; pending, exit. Before leaving, the current synchronization
5219 ;; request is updated.
5226 exit-flag)
5227 ;; No re-parenting nor shifting planned: request is over.
5237 ;; We reached NEXT. Request is complete.
5239 ;; Handle interruption request. Update current request.
5244 ;; Shift element.
5247 ;; Shift associated objects data, if any.
5252 ;; Update PARENT and re-parent DATA, only when
5253 ;; necessary. Propagate new structures for lists.
5267 ;; Cache is up-to-date past THRESHOLD. Request
5268 ;; interruption.
5273 ;; We reached end of tree: synchronization complete.
5274 t)))
5277 "Parse elements in current section, down to POS.
5279 Start parsing from the closest between the last known element in
5280 cache or headline above. Return the smallest element containing
5281 POS.
5283 When optional argument SYNCP is non-nil, return the parent of the
5284 element containing POS instead. In that case, it is also
5285 possible to provide TIME-LIMIT, which is a time value specifying
5286 when the parsing should stop. The function throws `interrupt' if
5287 the process stopped before finding the expected result."
5294 element next mode)
5296 ;; Nothing in cache before point: start parsing from first
5297 ;; element following headline above, or first element in
5298 ;; buffer.
5305 ;; Cache returned exact match: return it.
5308 ;; There's a headline between cached value and POS: cached
5309 ;; value is invalid. Start parsing from first element
5310 ;; following the headline.
5317 ;; Check if CACHED or any of its ancestors contain point.
5318 ;;
5319 ;; If there is such an element, we inspect it in order to know
5320 ;; if we return it or if we need to parse its contents.
5321 ;; Otherwise, we just start parsing from current location,
5322 ;; which is right after the top-most element containing
5323 ;; CACHED.
5324 ;;
5325 ;; As a special case, if POS is at the end of the buffer, we
5326 ;; want to return the innermost element ending there.
5327 ;;
5328 ;; Also, if we find an ancestor and discover that we need to
5329 ;; parse its contents, make sure we don't start from
5330 ;; `:contents-begin', as we would otherwise go past CACHED
5331 ;; again. Instead, in that situation, we will resume parsing
5332 ;; from NEXT, which is located after CACHED or its higher
5333 ;; ancestor not containing point.
5345 ;; Parse successively each element until we reach POS.
5358 end 'element mode
5365 ;; Skip any element ending before point. Also skip
5366 ;; element ending at point (unless it is also the end of
5367 ;; buffer) since we're sure that another element begins
5368 ;; after it.
5372 ;; A non-greater element contains point: return it.
5375 ;; Otherwise, we have to decide if ELEMENT really
5376 ;; contains POS. In that case we start parsing from
5377 ;; contents' beginning.
5378 ;;
5379 ;; If POS is at contents' beginning but it is also at
5380 ;; the beginning of the first item in a list or a table.
5381 ;; In that case, we need to create an anchor for that
5382 ;; list or table, so return it.
5383 ;;
5384 ;; Also, if POS is at the end of the buffer, no element
5385 ;; can start after it, but more than one may end there.
5386 ;; Arbitrarily, we choose to return the innermost of
5387 ;; such elements.
5400 parent element
5401 end cend))))
5402 ;; Otherwise, return ELEMENT as it is the smallest
5403 ;; element containing POS.
5408 ;;;; Staging Buffer Changes
5419 "Regexp matching a sensitive line, structure wise.
5420 A sensitive line is a headline, inlinetask, block, drawer, or
5421 latex-environment boundary. When such a line is modified,
5422 structure changes in the document may propagate in the whole
5426 "Non-nil when a sensitive line is about to be changed.
5430 "Request extension of area going to be modified if needed.
5431 BEG and END are the beginning and end of the range of changed
5432 text. See `before-change-functions' for more information."
5442 'headline
5445 org-element--cache-sensitive-re bottom t)))))))))
5448 "Update buffer modifications for current buffer.
5449 BEG and END are the beginning and end of the range of changed
5450 text, and the length in bytes of the pre-change text replaced by
5451 that range. See `after-change-functions' for more information."
5459 ;; Determine if modified area needs to be extended, according
5460 ;; to both previous and current state. We make a special
5461 ;; case for headline editing: if a headline is modified but
5462 ;; not removed, do not extend.
5465 (`headline
5471 org-element--cache-sensitive-re bottom t))))
5472 ;; Effectively extend modified area.
5480 ;; Store synchronization request.
5483 ;; Activate a timer to process the request during idle time.
5487 "Return first element to remove from cache.
5489 BEG and END are buffer positions delimiting buffer modifications.
5490 OFFSET is the size of the changes.
5492 Returned element is usually the first element in cache containing
5493 any position between BEG and END. As an exception, greater
5494 elements around the changes that are robust to contents
5495 modifications are preserved and updated according to the
5496 changes."
5506 special-block))
5507 ;; Drawers named "PROPERTIES" are probably
5508 ;; a properties drawer being edited. Force
5509 ;; parsing to check if editing is over.
5518 ;; UP is a robust greater element containing changes.
5519 ;; We only need to extend its ending boundaries.
5525 ;; We're at top level element containing ELEMENT: if it's
5526 ;; altered by buffer modifications, it is first element in
5527 ;; cache to be removed. Otherwise, that first element is the
5528 ;; following one.
5529 ;;
5530 ;; As a special case, do not remove BEFORE if it is a robust
5531 ;; container for current changes.
5533 before)))))
5536 "Submit a new cache synchronization request for current buffer.
5537 BEG and END are buffer positions delimiting the minimal area
5538 where cache data should be removed. OFFSET is the size of the
5539 change, as an integer."
5541 delete-to delete-from)
5546 ;; Current changes can be merged with first sync request: we
5547 ;; can save a partial cache synchronization.
5550 ;; If last change happened within area to be removed, extend
5551 ;; boundaries of robust parents, if any. Otherwise, find
5552 ;; first element to remove and update request accordingly.
5564 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5565 ;; if any, is no longer a 0-phase request, thus ensuring that
5566 ;; phases are properly ordered. We need to provide OFFSET as
5567 ;; optional parameter since current modifications are not known
5568 ;; yet to the otherwise correct part of the cache (i.e, before
5569 ;; the first request).
5576 ;; When changes happen before the first known
5577 ;; element, re-parent and shift the rest of the
5578 ;; cache.
5580 ;; Otherwise, we find the first non robust
5581 ;; element containing END. All elements between
5582 ;; FIRST and this one are to be removed.
5593 element up))
5595 org-element--cache-sync-requests)
5596 ;; No element to remove. No need to re-parent either.
5597 ;; Simply shift additional elements, if any, by OFFSET.
5602 ;;;; Public Functions
5604 ;;;###autoload
5606 "Reset cache in current buffer.
5607 When optional argument ALL is non-nil, reset cache in all Org
5608 buffers."
5626 ;;;###autoload
5628 "Refresh cache at position POS."
5635 \f
5636 ;;; The Toolbox
5637 ;;
5638 ;; The first move is to implement a way to obtain the smallest element
5639 ;; containing point. This is the job of `org-element-at-point'. It
5640 ;; basically jumps back to the beginning of section containing point
5641 ;; and proceed, one element after the other, with
5642 ;; `org-element--current-element' until the container is found. Note:
5643 ;; When using `org-element-at-point', secondary values are never
5644 ;; parsed since the function focuses on elements, not on objects.
5645 ;;
5646 ;; At a deeper level, `org-element-context' lists all elements and
5647 ;; objects containing point.
5648 ;;
5649 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5650 ;; internally by navigation and manipulation tools.
5653 ;;;###autoload
5655 "Determine closest element around point.
5657 Return value is a list like (TYPE PROPS) where TYPE is the type
5658 of the element and PROPS a plist of properties associated to the
5659 element.
5661 Possible types are defined in `org-element-all-elements'.
5662 Properties depend on element or object type, but always include
5663 `:begin', `:end', `:parent' and `:post-blank' properties.
5665 As a special case, if point is at the very beginning of the first
5666 item in a list or sub-list, returned element will be that list
5667 instead of the item. Likewise, if point is at the beginning of
5668 the first row of a table, returned element will be the table
5669 instead of the first row.
5671 When point is at the end of the buffer, return the innermost
5672 element ending there."
5678 ;; Within blank lines at the beginning of buffer, return nil.
5680 ;; Within blank lines right after a headline, return that
5681 ;; headline.
5685 ;; Otherwise parse until we find element containing ORIGIN.
5692 ;;;###autoload
5694 "Return smallest element or object around point.
5696 Return value is a list like (TYPE PROPS) where TYPE is the type
5697 of the element or object and PROPS a plist of properties
5698 associated to it.
5700 Possible types are defined in `org-element-all-elements' and
5701 `org-element-all-objects'. Properties depend on element or
5702 object type, but always include `:begin', `:end', `:parent' and
5703 `:post-blank'.
5705 As a special case, if point is right after an object and not at
5706 the beginning of any other object, return that object.
5708 Optional argument ELEMENT, when non-nil, is the closest element
5709 containing point, as returned by `org-element-at-point'.
5710 Providing it allows for quicker computation."
5716 ;; If point is inside an element containing objects or
5717 ;; a secondary string, narrow buffer to the container and
5718 ;; proceed with parsing. Otherwise, return ELEMENT.
5720 ;; At a parsed affiliated keyword, check if we're inside main
5721 ;; or dual value.
5728 org-element-parsed-keywords))
5737 ;; Also change type to retrieve correct restrictions.
5739 ;; At an item, objects can only be located within tag, if any.
5749 ;; At an headline or inlinetask, objects are in title.
5760 ;; At a paragraph, a table-row or a verse block, objects are
5761 ;; located within their contents.
5765 ;; CBEG is nil for table rules.
5770 ;; At a planning line, if point is at a timestamp, return it,
5771 ;; otherwise, return element.
5779 ;; All other locations cannot contain objects: bail out.
5789 next object-data last)
5793 ;; When entering PARENT for the first time, get list
5794 ;; of objects within known so far. Store it in
5795 ;; OBJECT-DATA.
5800 ;; Find NEXT object for analysis.
5802 ;; If NEXT is non-nil, we already exhausted the
5803 ;; cache so we can parse buffer to find the object
5804 ;; after it.
5806 ;; Otherwise, check if cache can help us.
5817 ;; Cache contains the information needed.
5820 pos)
5822 pos)
5828 ;; If we have a new object to analyze, store it in
5829 ;; cache. Otherwise record that there is nothing
5830 ;; more to parse in this element at this depth.
5835 ;; Process NEXT, if any, in order to know if we need
5836 ;; to skip it, return it or move into it.
5843 ;; Skip objects ending before point. Also skip
5844 ;; objects ending at point unless it is also the
5845 ;; end of buffer, since we want to return the
5846 ;; innermost object.
5849 ;; For convenience, when object ends at POS,
5850 ;; without any space, store it in LAST, as we
5851 ;; will return it if no object starts here.
5855 ;; If POS is within a container object, move
5856 ;; into that object.
5860 ;; At contents' end, if there is no
5861 ;; space before point, also move into
5862 ;; object, for consistency with
5863 ;; convenience feature above.
5872 next nil
5873 object-data nil))
5874 ;; Otherwise, return NEXT.
5876 ;; Store results in cache, if applicable.
5880 "List all ancestors of a given element or object.
5882 BLOB is an object or element.
5884 When optional argument TYPES is a list of symbols, return the
5885 first element or object in the lineage whose type belongs to that
5886 list.
5888 When optional argument WITH-SELF is non-nil, lineage includes
5889 BLOB itself as the first element, and TYPES, if provided, also
5890 apply to it.
5892 When BLOB is obtained through `org-element-context' or
5893 `org-element-at-point', only ancestors from its section can be
5894 found. There is no such limitation when BLOB belongs to a full
5895 parse tree."
5897 ancestors)
5904 "Non-nil when elements ELEM-A and ELEM-B are nested."
5913 "Swap elements ELEM-A and ELEM-B.
5914 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5915 end of ELEM-A."
5917 ;; There are two special cases when an element doesn't start at bol:
5918 ;; the first paragraph in an item or in a footnote definition.
5920 ;; Only a paragraph without any affiliated keyword can be moved at
5921 ;; ELEM-A position in such a situation. Note that the case of
5922 ;; a footnote definition is impossible: it cannot contain two
5923 ;; paragraphs in a row because it cannot contain a blank line.
5929 ;; In a special situation, ELEM-A will have no indentation. We'll
5930 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5944 ;; Store inner overlays responsible for visibility status.
5945 ;; We also need to store their boundaries as they will be
5946 ;; removed from buffer.
5961 ;; Get contents.
5969 ;; Restore ex ELEM-A overlays.
5976 ;; Restore ex ELEM-B overlays.
5981 ;; For backward-compatibility with Org <= 8.3
5988 ;; Local variables:
5989 ;; generated-autoload-file: "org-loaddefs.el"
5990 ;; End:
5992 ;;; org-element.el ends here