| blob | 9d7e43591f7d5463fee12319549f68e57958cd35 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 "Parse paired brackets at point.
426 CHAR is the opening bracket to consider, as a character. Return
427 contents between brackets, as a string, or nil. Also move point
428 past the brackets."
443 \f
444 ;;; Accessors and Setters
445 ;;
446 ;; Provide four accessors: `org-element-type', `org-element-property'
447 ;; `org-element-contents' and `org-element-restriction'.
448 ;;
449 ;; Setter functions allow modification of elements by side effect.
450 ;; There is `org-element-put-property', `org-element-set-contents'.
451 ;; These low-level functions are useful to build a parse tree.
452 ;;
453 ;; `org-element-adopt-element', `org-element-set-element',
454 ;; `org-element-extract-element' and `org-element-insert-before' are
455 ;; high-level functions useful to modify a parse tree.
456 ;;
457 ;; `org-element-secondary-p' is a predicate used to know if a given
458 ;; object belongs to a secondary string. `org-element-class' tells if
459 ;; some parsed data is an element or an object, handling pseudo
460 ;; elements and objects. `org-element-copy' returns an element or
461 ;; object, stripping its parent property in the process.
464 "Return type of ELEMENT.
466 The function returns the type of the element or object provided.
467 It can also return the following special value:
468 `plain-text' for a string
469 `org-data' for a complete document
470 nil in any other case."
476 "Extract the value from the PROPERTY of an ELEMENT."
481 "Extract contents from an ELEMENT."
487 "Return restriction associated to ELEMENT.
488 ELEMENT can be an element, an object or a symbol representing an
489 element or object type."
491 org-element-object-restrictions)))
494 "In ELEMENT set PROPERTY to VALUE.
495 Return modified element."
498 element))
501 "Set ELEMENT's contents to CONTENTS.
502 Return ELEMENT."
509 "Non-nil when OBJECT directly belongs to a secondary string.
510 Return value is the property name, as a keyword, or nil."
513 org-element-secondary-value-alist))))
520 "Return class for ELEMENT, as a symbol.
521 Class is either `element' or `object'. Optional argument PARENT
522 is the element or object containing DATUM. It defaults to the
523 value of DATUM `:parent' property."
527 ;; Trivial cases.
530 ;; Special cases.
534 ;; Pseudo object or elements. Make a guess about its class.
535 ;; Basically a pseudo object is contained within another object,
536 ;; a secondary string or a container element.
546 "Append elements to the contents of another element.
548 PARENT is an element or object. CHILDREN can be elements,
549 objects, or a strings.
551 The function takes care of setting `:parent' property for CHILD.
552 Return parent element."
554 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
555 ;; string: parent is the list itself.
558 ;; Add CHILDREN at the end of PARENT contents.
561 parent
563 ;; Return modified PARENT element.
567 "Extract ELEMENT from parse tree.
568 Remove element from the parse tree by side-effect, and return it
569 with its `:parent' property stripped out."
574 parent secondary
577 parent
579 ;; Return ELEMENT with its :parent removed.
583 "Insert ELEMENT before LOCATION in parse tree.
584 LOCATION is an element, object or string within the parse tree.
585 Parse tree is modified by side effect."
590 ;; Special case: LOCATION is the first element of an
591 ;; independent secondary string (e.g. :title property). Add
592 ;; ELEMENT in-place.
596 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
606 ;; Store SIBLINGS at appropriate place in parse tree.
611 ;; Set appropriate :parent property.
615 "Replace element or object OLD with element or object NEW.
616 The function takes care of setting `:parent' property for NEW."
617 ;; Ensure OLD and NEW have the same parent.
621 ;; We cannot replace OLD with NEW since one of them is not an
622 ;; object or element. We take the long path.
625 ;; Since OLD is going to be changed into NEW by side-effect, first
626 ;; make sure that every element or object within NEW has OLD as
627 ;; parent.
630 ;; Transfer contents.
632 ;; Overwrite OLD's properties with NEW's.
634 ;; Transfer type.
638 "Create a new element of type TYPE.
639 Optional argument PROPS, when non-nil, is a plist defining the
640 properties of the element. CHILDREN can be elements, objects or
641 strings."
645 "Return a copy of DATUM.
646 DATUM is an element, object, string or nil. `:parent' property
647 is cleared and contents are removed in the process."
658 \f
659 ;;; Greater elements
660 ;;
661 ;; For each greater element type, we define a parser and an
662 ;; interpreter.
663 ;;
664 ;; A parser returns the element or object as the list described above.
665 ;; Most of them accepts no argument. Though, exceptions exist. Hence
666 ;; every element containing a secondary string (see
667 ;; `org-element-secondary-value-alist') will accept an optional
668 ;; argument to toggle parsing of these secondary strings. Moreover,
669 ;; `item' parser requires current list's structure as its first
670 ;; element.
671 ;;
672 ;; An interpreter accepts two arguments: the list representation of
673 ;; the element or object, and its contents. The latter may be nil,
674 ;; depending on the element or object considered. It returns the
675 ;; appropriate Org syntax, as a string.
676 ;;
677 ;; Parsing functions must follow the naming convention:
678 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
679 ;; defined in `org-element-greater-elements'.
680 ;;
681 ;; Similarly, interpreting functions must follow the naming
682 ;; convention: org-element-TYPE-interpreter.
683 ;;
684 ;; With the exception of `headline' and `item' types, greater elements
685 ;; cannot contain other greater elements of their own type.
686 ;;
687 ;; Beside implementing a parser and an interpreter, adding a new
688 ;; greater element requires tweaking `org-element--current-element'.
689 ;; Moreover, the newly defined type must be added to both
690 ;; `org-element-all-elements' and `org-element-greater-elements'.
693 ;;;; Center Block
696 "Parse a center block.
698 LIMIT bounds the search. AFFILIATED is a list of which CAR is
699 the buffer position at the beginning of the first affiliated
700 keyword and CDR is a plist of affiliated keywords along with
701 their value.
703 Return a list whose CAR is `center-block' and CDR is a plist
704 containing `:begin', `:end', `:contents-begin', `:contents-end',
705 `:post-blank' and `:post-affiliated' keywords.
707 Assume point is at the beginning of the block."
711 ;; Incomplete block: parse it as a paragraph.
716 ;; Empty blocks have no contents.
730 :end end
731 :contents-begin contents-begin
732 :contents-end contents-end
738 "Interpret a center-block element as Org syntax.
739 CONTENTS is the contents of the element."
743 ;;;; Drawer
746 "Parse a drawer.
748 LIMIT bounds the search. AFFILIATED is a list of which CAR is
749 the buffer position at the beginning of the first affiliated
750 keyword and CDR is a plist of affiliated keywords along with
751 their value.
753 Return a list whose CAR is `drawer' and CDR is a plist containing
754 `:drawer-name', `:begin', `:end', `:contents-begin',
755 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
757 Assume point is at beginning of drawer."
760 ;; Incomplete drawer: parse it as a paragraph.
768 ;; Empty drawers have no contents.
781 :end end
782 :drawer-name name
783 :contents-begin contents-begin
784 :contents-end contents-end
790 "Interpret DRAWER element as Org syntax.
791 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Dynamic Block
800 "Parse a dynamic block.
802 LIMIT bounds the search. AFFILIATED is a list of which CAR is
803 the buffer position at the beginning of the first affiliated
804 keyword and CDR is a plist of affiliated keywords along with
805 their value.
807 Return a list whose CAR is `dynamic-block' and CDR is a plist
808 containing `:block-name', `:begin', `:end', `:contents-begin',
809 `:contents-end', `:arguments', `:post-blank' and
810 `:post-affiliated' keywords.
812 Assume point is at beginning of dynamic block."
816 ;; Incomplete block: parse it as a paragraph.
825 ;; Empty blocks have no contents.
838 :end end
839 :block-name name
840 :arguments arguments
841 :contents-begin contents-begin
842 :contents-end contents-end
848 "Interpret DYNAMIC-BLOCK element as Org syntax.
849 CONTENTS is the contents of the element."
854 contents))
857 ;;;; Footnote Definition
866 "Parse a footnote definition.
868 LIMIT bounds the search. AFFILIATED is a list of which CAR is
869 the buffer position at the beginning of the first affiliated
870 keyword and CDR is a plist of affiliated keywords along with
871 their value.
873 Return a list whose CAR is `footnote-definition' and CDR is
874 a plist containing `:label', `:begin' `:end', `:contents-begin',
875 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
877 Assume point is at the beginning of the footnote definition."
889 limit)
891 ;; At a new footnote definition, make sure we end
892 ;; before any affiliated keyword above.
913 :begin begin
914 :end end
915 :contents-begin contents-begin
916 :contents-end contents-end
922 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
923 CONTENTS is the contents of the footnote-definition."
925 " "
926 contents))
929 ;;;; Headline
932 "Return node properties associated to headline at point.
933 Upcase property names. It avoids confusion between properties
934 obtained through property drawer and default properties from the
935 parser (e.g. `:end' and :END:). Return value is a plist."
947 properties))))
950 "Return time properties associated to headline at point.
951 Return value is a plist."
965 plist))))
968 "Parse a headline.
970 Return a list whose CAR is `headline' and CDR is a plist
971 containing `:raw-value', `:title', `:begin', `:end',
972 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
973 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
974 `:deadline', `:closed', `:archivedp', `:commentedp'
975 `:footnote-section-p', `:post-blank' and `:post-affiliated'
976 keywords.
978 The plist also contains any property set in the property drawer,
979 with its name in upper cases and colons added at the
980 beginning (e.g., `:CUSTOM_ID').
982 LIMIT is a buffer position bounding the search.
984 When RAW-SECONDARY-P is non-nil, headline's title will not be
985 parsed as a secondary string, but as a plain string instead.
987 Assume point is at beginning of the headline."
1033 :begin begin
1034 :end end
1035 :pre-blank
1038 :contents-begin contents-begin
1039 :contents-end contents-end
1040 :level level
1041 :priority priority
1042 :tags tags
1043 :todo-keyword todo
1044 :todo-type todo-type
1045 :post-blank
1049 :footnote-section-p footnote-section-p
1050 :archivedp archivedp
1051 :commentedp commentedp
1053 time-props
1054 standard-props))))
1056 headline :title
1065 nil
1067 headline)))))))
1070 "Interpret HEADLINE element as Org syntax.
1071 CONTENTS is the contents of the element."
1084 ?*)
1088 " "
1091 org-footnote-section
1092 title))))
1094 heading
1095 ;; Align tags.
1103 ?\s)
1104 tags))
1108 tags))))
1110 contents)))
1113 ;;;; Inlinetask
1116 "Parse an inline task.
1118 Return a list whose CAR is `inlinetask' and CDR is a plist
1119 containing `:title', `:begin', `:end', `:pre-blank',
1120 `:contents-begin' and `:contents-end', `:level', `:priority',
1121 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1122 `:scheduled', `:deadline', `:closed', `:post-blank' and
1123 `:post-affiliated' keywords.
1125 The plist also contains any property set in the property drawer,
1126 with its name in upper cases and colons added at the
1127 beginning (e.g., `:CUSTOM_ID').
1129 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1130 title will not be parsed as a secondary string, but as a plain
1131 string instead.
1133 Assume point is at beginning of the inline task."
1180 :begin begin
1181 :end end
1182 :pre-blank
1185 :contents-begin contents-begin
1186 :contents-end contents-end
1187 :level level
1188 :priority priority
1189 :tags tags
1190 :todo-keyword todo
1191 :todo-type todo-type
1194 time-props
1195 standard-props))))
1197 inlinetask :title
1206 nil
1208 inlinetask))))))
1211 "Interpret INLINETASK element as Org syntax.
1212 CONTENTS is the contents of inlinetask."
1226 ;; Align tags.
1234 ? )
1235 tags))
1239 tags))))
1240 ;; Prefer degenerate inlinetasks when there are no
1241 ;; contents.
1244 contents
1248 ;;;; Item
1251 "Parse an item.
1253 STRUCT is the structure of the plain list.
1255 Return a list whose CAR is `item' and CDR is a plist containing
1256 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1257 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1258 `:post-affiliated' keywords.
1260 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1261 any, will not be parsed as a secondary string, but as a plain
1262 string instead.
1264 Assume point is at the beginning of the item."
1287 ;; Ignore tags in un-ordered lists: they are just
1288 ;; a part of item's body.
1295 ;; If first line isn't empty, contents really
1296 ;; start at the text after item's meta-data.
1306 :begin begin
1307 :end end
1308 :contents-begin contents-begin
1309 :contents-end contents-end
1310 :checkbox checkbox
1311 :counter counter
1312 :structure struct
1316 item :tag
1323 item))))))))
1326 "Interpret ITEM element as Org syntax.
1327 CONTENTS is the contents of the element."
1337 ;; Compute indentation.
1342 ;; Indent contents.
1344 bullet
1359 ;;;; Plain List
1362 ;; Return structure of list at point. Internal function. See
1363 ;; `org-list-struct' for details.
1368 items struct)
1373 ;; At limit: end all items.
1382 ;; At list end: end all items.
1387 ;; At a new item: end previous sibling.
1399 ind
1400 bullet
1403 ;; Description tag.
1407 ;; Ending position, unknown so far.
1408 nil)))
1409 items))
1411 ;; Skip empty lines.
1413 ;; Skip inline tasks and blank lines along the way.
1420 ;; At some text line. Check if it ends any previous item.
1433 ;; Skip blocks (any type) and drawers contents.
1438 limit t)))
1444 "Parse a plain list.
1446 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1447 the buffer position at the beginning of the first affiliated
1448 keyword and CDR is a plist of affiliated keywords along with
1449 their value. STRUCTURE is the structure of the plain list being
1450 parsed.
1452 Return a list whose CAR is `plain-list' and CDR is a plist
1453 containing `:type', `:begin', `:end', `:contents-begin' and
1454 `:contents-end', `:structure', `:post-blank' and
1455 `:post-affiliated' keywords.
1457 Assume point is at the beginning of the list."
1471 pos))
1475 ;; Return value.
1479 :begin begin
1480 :end end
1481 :contents-begin contents-begin
1482 :contents-end contents-end
1483 :structure struct
1489 "Interpret plain-list element as Org syntax.
1490 CONTENTS is the contents of the element."
1498 ;;;; Property Drawer
1501 "Parse a property drawer.
1503 LIMIT bounds the search.
1505 Return a list whose car is `property-drawer' and cdr is a plist
1506 containing `:begin', `:end', `:contents-begin', `:contents-end',
1507 `:post-blank' and `:post-affiliated' keywords.
1509 Assume point is at the beginning of the property drawer."
1522 :end end
1524 :contents-end contents-end
1529 "Interpret property-drawer element as Org syntax.
1530 CONTENTS is the properties within the drawer."
1534 ;;;; Quote Block
1537 "Parse a quote block.
1539 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1540 the buffer position at the beginning of the first affiliated
1541 keyword and CDR is a plist of affiliated keywords along with
1542 their value.
1544 Return a list whose CAR is `quote-block' and CDR is a plist
1545 containing `:begin', `:end', `:contents-begin', `:contents-end',
1546 `:post-blank' and `:post-affiliated' keywords.
1548 Assume point is at the beginning of the block."
1552 ;; Incomplete block: parse it as a paragraph.
1558 ;; Empty blocks have no contents.
1571 :end end
1572 :contents-begin contents-begin
1573 :contents-end contents-end
1579 "Interpret quote-block element as Org syntax.
1580 CONTENTS is the contents of the element."
1584 ;;;; Section
1587 "Parse a section.
1589 Return a list whose CAR is `section' and CDR is a plist
1590 containing `:begin', `:end', `:contents-begin', `contents-end',
1591 `:post-blank' and `:post-affiliated' keywords."
1593 ;; Beginning of section is the beginning of the first non-blank
1594 ;; line after previous headline.
1602 :end end
1603 :contents-begin begin
1604 :contents-end pos-before-blank
1609 "Interpret section element as Org syntax.
1610 CONTENTS is the contents of the element."
1611 contents)
1614 ;;;; Special Block
1617 "Parse a special block.
1619 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1620 the buffer position at the beginning of the first affiliated
1621 keyword and CDR is a plist of affiliated keywords along with
1622 their value.
1624 Return a list whose CAR is `special-block' and CDR is a plist
1625 containing `:type', `:begin', `:end', `:contents-begin',
1626 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1628 Assume point is at the beginning of the block."
1635 limit t)))
1636 ;; Incomplete block: parse it as a paragraph.
1642 ;; Empty blocks have no contents.
1655 :begin begin
1656 :end end
1657 :contents-begin contents-begin
1658 :contents-end contents-end
1664 "Interpret SPECIAL-BLOCK element as Org syntax.
1665 CONTENTS is the contents of the element."
1670 \f
1671 ;;; Elements
1672 ;;
1673 ;; For each element, a parser and an interpreter are also defined.
1674 ;; Both follow the same naming convention used for greater elements.
1675 ;;
1676 ;; Also, as for greater elements, adding a new element type is done
1677 ;; through the following steps: implement a parser and an interpreter,
1678 ;; tweak `org-element--current-element' so that it recognizes the new
1679 ;; type and add that new type to `org-element-all-elements'.
1682 ;;;; Babel Call
1685 "Parse a babel call.
1687 LIMIT bounds the search. AFFILIATED is a list of which car is
1688 the buffer position at the beginning of the first affiliated
1689 keyword and cdr is a plist of affiliated keywords along with
1690 their value.
1692 Return a list whose car is `babel-call' and cdr is a plist
1693 containing `:call', `:inside-header', `:arguments',
1694 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1695 `:post-affiliated' as keywords."
1709 value)))
1719 :begin begin
1720 :end end
1721 :value value
1727 "Interpret BABEL-CALL element as Org syntax."
1737 ;;;; Clock
1740 "Parse a clock.
1742 LIMIT bounds the search.
1744 Return a list whose CAR is `clock' and CDR is a plist containing
1745 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1746 `:post-affiliated' as keywords."
1766 :value value
1767 :duration duration
1768 :begin begin
1769 :end end
1770 :post-blank post-blank
1774 "Interpret CLOCK element as Org syntax."
1782 "%2s:%02s"
1786 ;;;; Comment
1789 "Parse a comment.
1791 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1792 the buffer position at the beginning of the first affiliated
1793 keyword and CDR is a plist of affiliated keywords along with
1794 their value.
1796 Return a list whose CAR is `comment' and CDR is a plist
1797 containing `:begin', `:end', `:value', `:post-blank',
1798 `:post-affiliated' keywords.
1800 Assume point is at comment beginning."
1809 ;; Get comments ending.
1812 ;; Accumulate lines without leading hash and first
1813 ;; whitespace.
1827 :end end
1828 :value value
1834 "Interpret COMMENT element as Org syntax.
1835 CONTENTS is nil."
1839 ;;;; Comment Block
1842 "Parse an export block.
1844 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1845 the buffer position at the beginning of the first affiliated
1846 keyword and CDR is a plist of affiliated keywords along with
1847 their value.
1849 Return a list whose CAR is `comment-block' and CDR is a plist
1850 containing `:begin', `:end', `:value', `:post-blank' and
1851 `:post-affiliated' keywords.
1853 Assume point is at comment block beginning."
1857 ;; Incomplete block: parse it as a paragraph.
1870 contents-begin contents-end)))
1874 :end end
1875 :value value
1881 "Interpret COMMENT-BLOCK element as Org syntax."
1888 ;;;; Diary Sexp
1891 "Parse a diary sexp.
1893 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1894 the buffer position at the beginning of the first affiliated
1895 keyword and CDR is a plist of affiliated keywords along with
1896 their value.
1898 Return a list whose CAR is `diary-sexp' and CDR is a plist
1899 containing `:begin', `:end', `:value', `:post-blank' and
1900 `:post-affiliated' keywords."
1912 :begin begin
1913 :end end
1919 "Interpret DIARY-SEXP as Org syntax."
1923 ;;;; Example Block
1926 "Parse an example block.
1928 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1929 the buffer position at the beginning of the first affiliated
1930 keyword and CDR is a plist of affiliated keywords along with
1931 their value.
1933 Return a list whose CAR is `example-block' and CDR is a plist
1934 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1935 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1936 `:value', `:post-blank' and `:post-affiliated' keywords."
1940 ;; Incomplete block: parse it as a paragraph.
1948 ;; Switches analysis.
1952 switches)
1955 'new
1958 ;; Subtract 1 to give number of lines before
1959 ;; first line.
1963 ;; Should labels be retained in (or stripped from) example
1964 ;; blocks?
1969 ;; What should code-references use - labels or
1970 ;; line-numbers?
1979 ;; Standard block parsing.
1985 contents-begin contents-end)))
1994 :end end
1995 :value value
1996 :switches switches
1997 :number-lines number-lines
1998 :preserve-indent preserve-indent
1999 :retain-labels retain-labels
2000 :use-labels use-labels
2001 :label-fmt label-fmt
2007 "Interpret EXAMPLE-BLOCK element as Org syntax."
2015 value
2020 ;;;; Export Block
2023 "Parse an export block.
2025 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2026 the buffer position at the beginning of the first affiliated
2027 keyword and CDR is a plist of affiliated keywords along with
2028 their value.
2030 Return a list whose CAR is `export-block' and CDR is a plist
2031 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2032 `:post-affiliated' keywords.
2034 Assume point is at export-block beginning."
2038 ;; Incomplete block: parse it as a paragraph.
2057 contents-end))))
2061 :begin begin
2062 :end end
2063 :value value
2069 "Interpret EXPORT-BLOCK element as Org syntax."
2075 ;;;; Fixed-width
2078 "Parse a fixed-width section.
2080 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2081 the buffer position at the beginning of the first affiliated
2082 keyword and CDR is a plist of affiliated keywords along with
2083 their value.
2085 Return a list whose CAR is `fixed-width' and CDR is a plist
2086 containing `:begin', `:end', `:value', `:post-blank' and
2087 `:post-affiliated' keywords.
2089 Assume point is at the beginning of the fixed-width area."
2093 value
2098 ;; Accumulate text without starting colons.
2111 :end end
2112 :value value
2118 "Interpret FIXED-WIDTH element as Org syntax."
2126 ;;;; Horizontal Rule
2129 "Parse an horizontal rule.
2131 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2132 the buffer position at the beginning of the first affiliated
2133 keyword and CDR is a plist of affiliated keywords along with
2134 their value.
2136 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2137 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2138 keywords."
2148 :end end
2154 "Interpret HORIZONTAL-RULE element as Org syntax."
2158 ;;;; Keyword
2161 "Parse a keyword at point.
2163 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2164 the buffer position at the beginning of the first affiliated
2165 keyword and CDR is a plist of affiliated keywords along with
2166 their value.
2168 Return a list whose CAR is `keyword' and CDR is a plist
2169 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2170 `:post-affiliated' keywords."
2172 ;; An orphaned affiliated keyword is considered as a regular
2173 ;; keyword. In this case AFFILIATED is nil, so we take care of
2174 ;; this corner case.
2187 :value value
2188 :begin begin
2189 :end end
2195 "Interpret KEYWORD element as Org syntax."
2201 ;;;; Latex Environment
2205 "Regexp matching the beginning of a LaTeX environment.
2206 The environment is captured by the first group.
2212 "Format string matching the ending of a LaTeX environment.
2216 "Parse a LaTeX environment.
2218 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2219 the buffer position at the beginning of the first affiliated
2220 keyword and CDR is a plist of affiliated keywords along with
2221 their value.
2223 Return a list whose CAR is `latex-environment' and CDR is a plist
2224 containing `:begin', `:end', `:value', `:post-blank' and
2225 `:post-affiliated' keywords.
2227 Assume point is at the beginning of the latex environment."
2234 limit t))
2235 ;; Incomplete latex environment: parse it as a paragraph.
2245 :end end
2246 :value value
2252 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2256 ;;;; Node Property
2259 "Parse a node-property at point.
2261 LIMIT bounds the search.
2263 Return a list whose CAR is `node-property' and CDR is a plist
2264 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2265 `:post-affiliated' keywords."
2275 limit))))
2278 :value value
2279 :begin begin
2280 :end end
2285 "Interpret NODE-PROPERTY element as Org syntax."
2291 ;;;; Paragraph
2294 "Parse a paragraph.
2296 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2297 the buffer position at the beginning of the first affiliated
2298 keyword and CDR is a plist of affiliated keywords along with
2299 their value.
2301 Return a list whose CAR is `paragraph' and CDR is a plist
2302 containing `:begin', `:end', `:contents-begin' and
2303 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2305 Assume point is at the beginning of the paragraph."
2312 ;; A matching `org-element-paragraph-separate' is not
2313 ;; necessarily the end of the paragraph. In particular,
2314 ;; drawers, blocks or LaTeX environments opening lines
2315 ;; must be closed. Moreover keywords with a secondary
2316 ;; value must belong to "dual keywords".
2330 limit t)))
2336 limit t)))
2339 org-element-dual-keywords))
2340 ;; Everything else is unambiguous.
2353 :end end
2354 :contents-begin contents-begin
2355 :contents-end contents-end
2361 "Interpret paragraph element as Org syntax.
2362 CONTENTS is the contents of the element."
2363 contents)
2366 ;;;; Planning
2369 "Parse a planning.
2371 LIMIT bounds the search.
2373 Return a list whose CAR is `planning' and CDR is a plist
2374 containing `:closed', `:deadline', `:scheduled', `:begin',
2375 `:end', `:post-blank' and `:post-affiliated' keywords."
2385 closed deadline scheduled)
2397 :deadline deadline
2398 :scheduled scheduled
2399 :begin begin
2400 :end end
2401 :post-blank post-blank
2405 "Interpret PLANNING element as Org syntax."
2407 #'identity
2424 ;;;; Src Block
2427 "Parse a src block.
2429 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2430 the buffer position at the beginning of the first affiliated
2431 keyword and CDR is a plist of affiliated keywords along with
2432 their value.
2434 Return a list whose CAR is `src-block' and CDR is a plist
2435 containing `:language', `:switches', `:parameters', `:begin',
2436 `:end', `:number-lines', `:retain-labels', `:use-labels',
2437 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2438 `:post-affiliated' keywords.
2440 Assume point is at the beginning of the block."
2443 limit t)))
2444 ;; Incomplete block: parse it as a paragraph.
2450 ;; Get language as a string.
2459 ;; Get switches.
2461 ;; Get parameters.
2463 ;; Switches analysis.
2467 switches)
2470 'new
2473 ;; Subtract 1 to give number of lines before
2474 ;; first line.
2482 ;; Should labels be retained in (or stripped from)
2483 ;; src blocks?
2488 ;; What should code-references use - labels or
2489 ;; line-numbers?
2494 ;; Retrieve code.
2501 ;; Get position after ending blank lines.
2511 :begin begin
2512 :end end
2513 :number-lines number-lines
2514 :preserve-indent preserve-indent
2515 :retain-labels retain-labels
2516 :use-labels use-labels
2517 :label-fmt label-fmt
2518 :value value
2524 "Interpret SRC-BLOCK element as Org syntax."
2533 val)
2548 ;;;; Table
2551 "Parse a table at point.
2553 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2554 the buffer position at the beginning of the first affiliated
2555 keyword and CDR is a plist of affiliated keywords along with
2556 their value.
2558 Return a list whose CAR is `table' and CDR is a plist containing
2559 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2560 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2561 keywords.
2563 Assume point is at the beginning of the table."
2579 acc))
2586 :end end
2587 :type type
2588 :tblfm tblfm
2589 ;; Only `org' tables have contents. `table.el' tables
2590 ;; use a `:value' property to store raw table as
2591 ;; a string.
2596 table-begin table-end))
2602 "Interpret TABLE element as Org syntax.
2603 CONTENTS is a string, if table's type is `org', or nil."
2614 ;;;; Table Row
2617 "Parse table row at point.
2619 Return a list whose CAR is `table-row' and CDR is a plist
2620 containing `:begin', `:end', `:contents-begin', `:contents-end',
2621 `:type', `:post-blank' and `:post-affiliated' keywords."
2625 ;; A table rule has no contents. In that case, ensure
2626 ;; CONTENTS-BEGIN matches CONTENTS-END.
2636 :begin begin
2637 :end end
2638 :contents-begin contents-begin
2639 :contents-end contents-end
2644 "Interpret TABLE-ROW element as Org syntax.
2645 CONTENTS is the contents of the table row."
2650 ;;;; Verse Block
2653 "Parse a verse block.
2655 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2656 the buffer position at the beginning of the first affiliated
2657 keyword and CDR is a plist of affiliated keywords along with
2658 their value.
2660 Return a list whose CAR is `verse-block' and CDR is a plist
2661 containing `:begin', `:end', `:contents-begin', `:contents-end',
2662 `:post-blank' and `:post-affiliated' keywords.
2664 Assume point is at beginning of the block."
2668 ;; Incomplete block: parse it as a paragraph.
2683 :end end
2684 :contents-begin contents-begin
2685 :contents-end contents-end
2691 "Interpret verse-block element as Org syntax.
2692 CONTENTS is verse block contents."
2696 \f
2697 ;;; Objects
2698 ;;
2699 ;; Unlike to elements, raw text can be found between objects. Hence,
2700 ;; `org-element--object-lex' is provided to find the next object in
2701 ;; buffer.
2702 ;;
2703 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2704 ;; object types they can contain will be specified in
2705 ;; `org-element-object-restrictions'.
2706 ;;
2707 ;; Creating a new type of object requires to alter
2708 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2709 ;; new type in `org-element-all-objects', and possibly add
2710 ;; restrictions in `org-element-object-restrictions'.
2712 ;;;; Bold
2715 "Parse bold object at point, if any.
2717 When at a bold object, return a list whose car is `bold' and cdr
2718 is a plist with `:begin', `:end', `:contents-begin' and
2719 `:contents-end' and `:post-blank' keywords. Otherwise, return
2720 nil.
2722 Assume point is at the first star marker."
2734 :end end
2735 :contents-begin contents-begin
2736 :contents-end contents-end
2740 "Interpret bold object as Org syntax.
2741 CONTENTS is the contents of the object."
2745 ;;;; Code
2748 "Parse code object at point, if any.
2750 When at a code object, return a list whose car is `code' and cdr
2751 is a plist with `:value', `:begin', `:end' and `:post-blank'
2752 keywords. Otherwise, return nil.
2754 Assume point is at the first tilde marker."
2765 :begin begin
2766 :end end
2770 "Interpret CODE object as Org syntax."
2774 ;;;; Entity
2777 "Parse entity at point, if any.
2779 When at an entity, return a list whose car is `entity' and cdr
2780 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2781 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2782 `:post-blank' as keywords. Otherwise, return nil.
2784 Assume point is at the beginning of the entity."
2786 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2804 :begin begin
2805 :end end
2806 :use-brackets-p bracketsp
2810 "Interpret ENTITY object as Org syntax."
2816 ;;;; Export Snippet
2819 "Parse export snippet at point.
2821 When at an export snippet, return a list whose car is
2822 `export-snippet' and cdr a plist with `:begin', `:end',
2823 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2824 return nil.
2826 Assume point is at the beginning of the snippet."
2842 :value value
2843 :begin begin
2844 :end end
2848 "Interpret EXPORT-SNIPPET object as Org syntax."
2854 ;;;; Footnote Reference
2857 "Parse footnote reference at point, if any.
2859 When at a footnote reference, return a list whose car is
2860 `footnote-reference' and cdr a plist with `:label', `:type',
2861 `:begin', `:end', `:content-begin', `:contents-end' and
2862 `:post-blank' as keywords. Otherwise, return nil."
2878 :type type
2879 :begin begin
2880 :end end
2886 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2887 CONTENTS is its definition, when inline, or nil."
2893 ;;;; Inline Babel Call
2896 "Parse inline babel call at point, if any.
2898 When at an inline babel call, return a list whose car is
2899 `inline-babel-call' and cdr a plist with `:call',
2900 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2901 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2903 Assume point is at the beginning of the babel call."
2917 ;; Parenthesis are mandatory.
2928 :inside-header inside-header
2929 :arguments arguments
2930 :end-header end-header
2931 :begin begin
2932 :end end
2933 :value value
2937 "Interpret INLINE-BABEL-CALL object as Org syntax."
2947 ;;;; Inline Src Block
2950 "Parse inline source block at point, if any.
2952 When at an inline source block, return a list whose car is
2953 `inline-src-block' and cdr a plist with `:begin', `:end',
2954 `:language', `:value', `:parameters' and `:post-blank' as
2955 keywords. Otherwise, return nil.
2957 Assume point is at the beginning of the inline src block."
2974 :value value
2975 :parameters parameters
2976 :begin begin
2981 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2986 language
2988 body)))
2990 ;;;; Italic
2993 "Parse italic object at point, if any.
2995 When at an italic object, return a list whose car is `italic' and
2996 cdr is a plist with `:begin', `:end', `:contents-begin' and
2997 `:contents-end' and `:post-blank' keywords. Otherwise, return
2998 nil.
3000 Assume point is at the first slash marker."
3012 :end end
3013 :contents-begin contents-begin
3014 :contents-end contents-end
3018 "Interpret italic object as Org syntax.
3019 CONTENTS is the contents of the object."
3023 ;;;; Latex Fragment
3026 "Parse LaTeX fragment at point, if any.
3028 When at a LaTeX fragment, return a list whose car is
3029 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3030 and `:post-blank' as keywords. Otherwise, return nil.
3032 Assume point is at the beginning of the LaTeX fragment."
3050 ;; Macro.
3060 :begin begin
3061 :end end
3065 "Interpret LATEX-FRAGMENT object as Org syntax."
3068 ;;;; Line Break
3071 "Parse line break at point, if any.
3073 When at a line break, return a list whose car is `line-break',
3074 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3075 Otherwise, return nil.
3077 Assume point is at the beginning of the line break."
3086 "Interpret LINE-BREAK object as Org syntax."
3090 ;;;; Link
3093 "Parse link at point, if any.
3095 When at a link, return a list whose car is `link' and cdr a plist
3096 with `:type', `:path', `:format', `:raw-link', `:application',
3097 `:search-option', `:begin', `:end', `:contents-begin',
3098 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3099 nil.
3101 Assume point is at the beginning of the link."
3104 end contents-begin contents-end link-end post-blank path type format
3105 raw-link search-option application)
3107 ;; Type 1: Text targeted from a radio target.
3117 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3123 ;; RAW-LINK is the original link. Expand any
3124 ;; abbreviation in it.
3125 ;;
3126 ;; Also treat any newline character and associated
3127 ;; indentation as a single space character. This is not
3128 ;; compatible with RFC 3986, which requires to ignore
3129 ;; them altogether. However, doing so would require
3130 ;; users to encode spaces on the fly when writing links
3131 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3132 ;; [[shell:ls *.org]], which defeats Org's focus on
3133 ;; simplicity.
3138 ;; Determine TYPE of link and set PATH accordingly. According
3139 ;; to RFC 3986, remove whitespaces from URI in external links.
3140 ;; In internal ones, treat indentation as a single space.
3142 ;; File type.
3147 ;; Explicit type (http, irc, bbdb...).
3151 ;; Code-ref type: PATH is the name of the reference.
3156 ;; Custom-id type: PATH is the name of the custom id.
3160 ;; Fuzzy type: Internal link either matches a target, an
3161 ;; headline name or nothing. PATH is the target or
3162 ;; headline's name.
3166 ;; Type 3: Plain link, e.g., http://orgmode.org
3173 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3174 ;; bracket links, follow RFC 3986 and remove any extra
3175 ;; whitespace in URI.
3186 ;; In any case, deduce end point after trailing white space from
3187 ;; LINK-END variable.
3192 ;; Special "file" type link processing. Extract opening
3193 ;; application and search option, if any. Also normalize URI.
3200 ;; Translate link, if `org-link-translation-function' is set.
3208 :path path
3209 :format format
3211 :application application
3212 :search-option search-option
3213 :begin begin
3214 :end end
3215 :contents-begin contents-begin
3216 :contents-end contents-end
3220 "Interpret LINK object as Org syntax.
3221 CONTENTS is the contents of the object, or nil."
3226 ;; Links with contents and internal links have to
3227 ;; use bracket syntax. Ignore `:format' in these
3228 ;; cases. This is also the default syntax when the
3229 ;; property is not defined, e.g., when the object
3230 ;; was crafted by the user.
3233 ;; Since this is going to be used as
3234 ;; a format string, escape percent signs
3235 ;; in description.
3238 `nil
3241 ;; Otherwise, just obey to `:format'.
3253 path
3259 ;;;; Macro
3262 "Parse macro at point, if any.
3264 When at a macro, return a list whose car is `macro' and cdr
3265 a plist with `:key', `:args', `:begin', `:end', `:value' and
3266 `:post-blank' as keywords. Otherwise, return nil.
3268 Assume point is at the macro."
3281 :value value
3282 :args args
3283 :begin begin
3284 :end end
3288 "Interpret MACRO object as Org syntax."
3292 ;;;; Radio-target
3295 "Parse radio target at point, if any.
3297 When at a radio target, return a list whose car is `radio-target'
3298 and cdr a plist with `:begin', `:end', `:contents-begin',
3299 `:contents-end', `:value' and `:post-blank' as keywords.
3300 Otherwise, return nil.
3302 Assume point is at the radio target."
3314 :end end
3315 :contents-begin contents-begin
3316 :contents-end contents-end
3317 :post-blank post-blank
3321 "Interpret target object as Org syntax.
3322 CONTENTS is the contents of the object."
3326 ;;;; Statistics Cookie
3329 "Parse statistics cookie at point, if any.
3331 When at a statistics cookie, return a list whose car is
3332 `statistics-cookie', and cdr a plist with `:begin', `:end',
3333 `:value' and `:post-blank' keywords. Otherwise, return nil.
3335 Assume point is at the beginning of the statistics-cookie."
3346 :end end
3347 :value value
3351 "Interpret STATISTICS-COOKIE object as Org syntax."
3355 ;;;; Strike-Through
3358 "Parse strike-through object at point, if any.
3360 When at a strike-through object, return a list whose car is
3361 `strike-through' and cdr is a plist with `:begin', `:end',
3362 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3363 Otherwise, return nil.
3365 Assume point is at the first plus sign marker."
3377 :end end
3378 :contents-begin contents-begin
3379 :contents-end contents-end
3383 "Interpret strike-through object as Org syntax.
3384 CONTENTS is the contents of the object."
3388 ;;;; Subscript
3391 "Parse subscript at point, if any.
3393 When at a subscript object, return a list whose car is
3394 `subscript' and cdr a plist with `:begin', `:end',
3395 `:contents-begin', `:contents-end', `:use-brackets-p' and
3396 `:post-blank' as keywords. Otherwise, return nil.
3398 Assume point is at the underscore."
3412 :end end
3413 :use-brackets-p bracketsp
3414 :contents-begin contents-begin
3415 :contents-end contents-end
3419 "Interpret SUBSCRIPT object as Org syntax.
3420 CONTENTS is the contents of the object."
3423 contents))
3426 ;;;; Superscript
3429 "Parse superscript at point, if any.
3431 When at a superscript object, return a list whose car is
3432 `superscript' and cdr a plist with `:begin', `:end',
3433 `:contents-begin', `:contents-end', `:use-brackets-p' and
3434 `:post-blank' as keywords. Otherwise, return nil.
3436 Assume point is at the caret."
3450 :end end
3451 :use-brackets-p bracketsp
3452 :contents-begin contents-begin
3453 :contents-end contents-end
3457 "Interpret SUPERSCRIPT object as Org syntax.
3458 CONTENTS is the contents of the object."
3461 contents))
3464 ;;;; Table Cell
3467 "Parse table cell at point.
3468 Return a list whose car is `table-cell' and cdr is a plist
3469 containing `:begin', `:end', `:contents-begin', `:contents-end'
3470 and `:post-blank' keywords."
3478 :end end
3479 :contents-begin contents-begin
3480 :contents-end contents-end
3484 "Interpret table-cell element as Org syntax.
3485 CONTENTS is the contents of the cell, or nil."
3489 ;;;; Target
3492 "Parse target at point, if any.
3494 When at a target, return a list whose car is `target' and cdr
3495 a plist with `:begin', `:end', `:value' and `:post-blank' as
3496 keywords. Otherwise, return nil.
3498 Assume point is at the target."
3508 :end end
3509 :value value
3513 "Interpret TARGET object as Org syntax."
3517 ;;;; Timestamp
3528 "Parse time stamp at point, if any.
3530 When at a time stamp, return a list whose car is `timestamp', and
3531 cdr a plist with `:type', `:raw-value', `:year-start',
3532 `:month-start', `:day-start', `:hour-start', `:minute-start',
3533 `:year-end', `:month-end', `:day-end', `:hour-end',
3534 `:minute-end', `:repeater-type', `:repeater-value',
3535 `:repeater-unit', `:warning-type', `:warning-value',
3536 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3537 Otherwise, return nil.
3539 Assume point is at the beginning of the timestamp."
3558 date-start)
3569 raw-value)
3571 :repeater-type
3577 :repeater-unit
3586 :warning-unit
3589 year-start month-start day-start hour-start minute-start year-end
3590 month-end day-end hour-end minute-end)
3591 ;; Parse date-start.
3599 ;; Compute date-end. It can be provided directly in time-stamp,
3600 ;; or extracted from time range. Otherwise, it defaults to the
3601 ;; same values as date-start.
3611 :raw-value raw-value
3612 :year-start year-start
3613 :month-start month-start
3614 :day-start day-start
3615 :hour-start hour-start
3616 :minute-start minute-start
3617 :year-end year-end
3618 :month-end month-end
3619 :day-end day-end
3620 :hour-end hour-end
3621 :minute-end minute-end
3622 :begin begin
3623 :end end
3625 repeater-props
3626 warning-props))))))
3629 "Interpret TIMESTAMP object as Org syntax."
3647 ;; Build an Org timestamp string from TIME. ACTIVEP is
3648 ;; non-nil when time stamp is active. If WITH-TIME-P is
3649 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3650 ;; specify a time range in the timestamp. REPEAT-STRING is
3651 ;; the repeater string, if any.
3655 org-time-stamp-formats)
3656 time)))
3662 nil nil ts)))
3667 " "
3668 s
3670 ;; Return value.
3671 ts)))
3683 build-ts-string
3702 0
3710 "--"
3723 ;;;; Underline
3726 "Parse underline object at point, if any.
3728 When at an underline object, return a list whose car is
3729 `underline' and cdr is a plist with `:begin', `:end',
3730 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3731 Otherwise, return nil.
3733 Assume point is at the first underscore marker."
3745 :end end
3746 :contents-begin contents-begin
3747 :contents-end contents-end
3751 "Interpret underline object as Org syntax.
3752 CONTENTS is the contents of the object."
3756 ;;;; Verbatim
3759 "Parse verbatim object at point, if any.
3761 When at a verbatim object, return a list whose car is `verbatim'
3762 and cdr is a plist with `:value', `:begin', `:end' and
3763 `:post-blank' keywords. Otherwise, return nil.
3765 Assume point is at the first equal sign marker."
3776 :begin begin
3777 :end end
3781 "Interpret VERBATIM object as Org syntax."
3785 \f
3786 ;;; Parsing Element Starting At Point
3787 ;;
3788 ;; `org-element--current-element' is the core function of this section.
3789 ;; It returns the Lisp representation of the element starting at
3790 ;; point.
3791 ;;
3792 ;; `org-element--current-element' makes use of special modes. They
3793 ;; are activated for fixed element chaining (e.g., `plain-list' >
3794 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3795 ;; `section'). Special modes are: `first-section', `item',
3796 ;; `node-property', `section' and `table-row'.
3799 "Parse the element starting at point.
3801 Return value is a list like (TYPE PROPS) where TYPE is the type
3802 of the element and PROPS a plist of properties associated to the
3803 element.
3805 Possible types are defined in `org-element-all-elements'.
3807 LIMIT bounds the search.
3809 Optional argument GRANULARITY determines the depth of the
3810 recursion. Allowed values are `headline', `greater-element',
3811 `element', `object' or nil. When it is broader than `object' (or
3812 nil), secondary values will not be parsed, since they only
3813 contain objects.
3815 Optional argument MODE, when non-nil, can be either
3816 `first-section', `section', `planning', `item', `node-property'
3817 and `table-row'.
3819 If STRUCTURE isn't provided but MODE is set to `item', it will be
3820 computed.
3822 This function assumes point is always at the beginning of the
3823 element it has to parse."
3826 ;; Determine if parsing depth allows for secondary strings
3827 ;; parsing. It only applies to elements referenced in
3828 ;; `org-element-secondary-value-alist'.
3831 ;; Item.
3834 ;; Table Row.
3836 ;; Node Property.
3838 ;; Headline.
3841 ;; Sections (must be checked after headline).
3846 limit)))
3847 ;; Planning.
3852 ;; Property drawer.
3858 ;; When not at bol, point is at the beginning of an item or
3859 ;; a footnote definition: next item is always a paragraph.
3861 ;; Clock.
3863 ;; Inlinetask.
3866 ;; From there, elements can have affiliated keywords.
3869 ;; Jumping over affiliated keywords put point off-limits.
3870 ;; Parse them as regular keywords.
3874 ;; LaTeX Environment.
3877 ;; Drawer and Property Drawer.
3880 ;; Fixed Width
3883 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3884 ;; Keywords.
3902 limit
3903 affiliated))
3916 ;; Footnote Definition.
3919 ;; Horizontal Rule.
3922 ;; Diary Sexp.
3925 ;; Table.
3928 ;; List.
3931 limit affiliated
3933 ;; Default element: Paragraph.
3937 ;; Most elements can have affiliated keywords. When looking for an
3938 ;; element beginning, we want to move before them, as they belong to
3939 ;; that element, and, in the meantime, collect information they give
3940 ;; into appropriate properties. Hence the following function.
3943 "Collect affiliated keywords from point down to LIMIT.
3945 Return a list whose CAR is the position at the first of them and
3946 CDR a plist of keywords and values and move point to the
3947 beginning of the first line after them.
3949 As a special case, if element doesn't start at the beginning of
3950 the line (e.g., a paragraph starting an item), CAR is current
3951 position of point and CDR is nil."
3955 ;; RESTRICT is the list of objects allowed in parsed
3956 ;; keywords value.
3958 output)
3961 ;; Apply translation to RAW-KWD. From there, KWD is
3962 ;; the official keyword.
3964 org-element-keyword-translation-alist))
3965 raw-kwd))
3966 ;; Find main value for any keyword.
3972 ;; PARSEDP is non-nil when keyword should have its
3973 ;; value parsed.
3975 ;; If KWD is a dual keyword, find its secondary
3976 ;; value. Maybe parse it.
3985 ;; Attribute a property name to KWD.
3987 ;; Now set final shape for VALUE.
3993 nil restrict)))
3997 ;; Attributes can always appear on multiple lines.
4000 ;; Eventually store the new value in OUTPUT.
4002 ;; Move to next keyword.
4004 ;; If affiliated keywords are orphaned: move back to first one.
4005 ;; They will be parsed as a paragraph.
4007 ;; Return value.
4011 \f
4012 ;;; The Org Parser
4013 ;;
4014 ;; The two major functions here are `org-element-parse-buffer', which
4015 ;; parses Org syntax inside the current buffer, taking into account
4016 ;; region, narrowing, or even visibility if specified, and
4017 ;; `org-element-parse-secondary-string', which parses objects within
4018 ;; a given string.
4019 ;;
4020 ;; The (almost) almighty `org-element-map' allows applying a function
4021 ;; on elements or objects matching some type, and accumulating the
4022 ;; resulting values. In an export situation, it also skips unneeded
4023 ;; parts of the parse tree.
4026 "Recursively parse the buffer and return structure.
4027 If narrowing is in effect, only parse the visible part of the
4028 buffer.
4030 Optional argument GRANULARITY determines the depth of the
4031 recursion. It can be set to the following symbols:
4033 `headline' Only parse headlines.
4034 `greater-element' Don't recurse into greater elements excepted
4035 headlines and sections. Thus, elements
4036 parsed are the top-level ones.
4037 `element' Parse everything but objects and plain text.
4038 `object' Parse the complete buffer (default).
4040 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4041 elements.
4043 An element or an objects is represented as a list with the
4044 pattern (TYPE PROPERTIES CONTENTS), where :
4046 TYPE is a symbol describing the element or object. See
4047 `org-element-all-elements' and `org-element-all-objects' for an
4048 exhaustive list of such symbols. One can retrieve it with
4049 `org-element-type' function.
4051 PROPERTIES is the list of attributes attached to the element or
4052 object, as a plist. Although most of them are specific to the
4053 element or object type, all types share `:begin', `:end',
4054 `:post-blank' and `:parent' properties, which respectively
4055 refer to buffer position where the element or object starts,
4056 ends, the number of white spaces or blank lines after it, and
4057 the element or object containing it. Properties values can be
4058 obtained by using `org-element-property' function.
4060 CONTENTS is a list of elements, objects or raw strings
4061 contained in the current element or object, when applicable.
4062 One can access them with `org-element-contents' function.
4064 The Org buffer has `org-data' as type and nil as properties.
4065 `org-element-map' function can be used to find specific elements
4066 or objects within the parse tree.
4068 This function assumes that current major mode is `org-mode'."
4074 ;; Start in `first-section' mode so text before the first
4075 ;; headline belongs to a section.
4079 "Recursively parse objects in STRING and return structure.
4081 RESTRICTION is a symbol limiting the object types that will be
4082 looked after.
4084 Optional argument PARENT, when non-nil, is the element or object
4085 containing the secondary string. It is used to set correctly
4086 `:parent' property within the string.
4088 If STRING is the empty string or nil, return nil."
4105 "Map a function on selected elements or objects.
4107 DATA is a parse tree, an element, an object, a string, or a list
4108 of such constructs. TYPES is a symbol or list of symbols of
4109 elements or objects types (see `org-element-all-elements' and
4110 `org-element-all-objects' for a complete list of types). FUN is
4111 the function called on the matching element or object. It has to
4112 accept one argument: the element or object itself.
4114 When optional argument INFO is non-nil, it should be a plist
4115 holding export options. In that case, parts of the parse tree
4116 not exportable according to that property list will be skipped.
4118 When optional argument FIRST-MATCH is non-nil, stop at the first
4119 match for which FUN doesn't return nil, and return that value.
4121 Optional argument NO-RECURSION is a symbol or a list of symbols
4122 representing elements or objects types. `org-element-map' won't
4123 enter any recursive element or object whose type belongs to that
4124 list. Though, FUN can still be applied on them.
4126 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4127 apply to matching objects within parsed affiliated keywords (see
4128 `org-element-parsed-keywords').
4130 Nil values returned from FUN do not appear in the results.
4133 Examples:
4134 ---------
4136 Assuming TREE is a variable containing an Org buffer parse tree,
4137 the following example will return a flat list of all `src-block'
4138 and `example-block' elements in it:
4142 The following snippet will find the first headline with a level
4146 (lambda (hl)
4147 (and (= (org-element-property :level hl) 1)
4149 (org-element-property :begin hl)))
4150 nil t)
4152 The next example will return a flat list of all `plain-list' type
4153 elements in TREE that are not a sub-list themselves:
4157 Eventually, this example will return a flat list of all `bold'
4158 type objects containing a `latex-snippet' type object, even
4159 looking into captions:
4162 (lambda (b)
4164 nil nil nil t)"
4165 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4169 ;; Recursion depth is determined by --CATEGORY.
4176 ;; If one object is found, the function has
4177 ;; to recurse into every object.
4180 ;; If one regular element is found, the
4181 ;; function has to recurse, at least, into
4182 ;; every element it encounters.
4185 --acc)
4188 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4189 ;; holding contextual information.
4193 ;; Ignored element in an export context.
4195 ;; List of elements or objects.
4197 ;; Unconditionally enter parse trees.
4201 ;; Check if TYPE is matching among TYPES. If so,
4202 ;; apply FUN to --DATA and accumulate return value
4203 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4209 ;; If --DATA has a secondary string that can contain
4210 ;; objects with their type among TYPES, look inside.
4213 org-element-secondary-value-alist)))
4215 ;; If --DATA has any parsed affiliated keywords and
4216 ;; WITH-AFFILIATED is non-nil, look for objects in
4217 ;; them.
4224 ;; Pay attention to the type of parsed
4225 ;; keyword. In particular, preserve order for
4226 ;; multiple keywords.
4239 ;; Determine if a recursion into --DATA is possible.
4241 ;; --TYPE is explicitly removed from recursion.
4243 ;; --DATA has no contents.
4245 ;; Looking for greater elements but --DATA is
4246 ;; simply an element or an object.
4249 ;; Looking for elements but --DATA is an object.
4252 ;; In any other case, map contents.
4256 ;; Return value in a proper order.
4260 ;; The following functions are internal parts of the parser.
4261 ;;
4262 ;; The first one, `org-element--parse-elements' acts at the element's
4263 ;; level.
4264 ;;
4265 ;; The second one, `org-element--parse-objects' applies on all objects
4266 ;; of a paragraph or a secondary string. It calls
4267 ;; `org-element--object-lex' to find the next object in the current
4268 ;; container.
4271 "Return next special mode according to TYPE, or nil.
4272 TYPE is a symbol representing the type of an element or object
4273 containing next element if PARENTP is non-nil, or before it
4274 otherwise. Modes can be either `first-section', `item',
4275 `node-property', `planning', `property-drawer', `section',
4276 `table-row' or nil."
4293 "Parse elements between BEG and END positions.
4295 MODE prioritizes some elements over the others. It can be set to
4296 `first-section', `section', `planning', `item', `node-property'
4297 or `table-row'.
4299 When value is `item', STRUCTURE will be used as the current list
4300 structure.
4302 GRANULARITY determines the depth of the recursion. See
4303 `org-element-parse-buffer' for more information.
4305 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4306 elements.
4308 Elements are accumulated into ACC."
4311 ;; Visible only: skip invisible parts at the beginning of the
4312 ;; element.
4315 ;; When parsing only headlines, skip any text before first one.
4320 ;; Find current element's type and parse it accordingly to
4321 ;; its category.
4323 end granularity mode structure))
4327 ;; Visible only: skip invisible parts between siblings.
4330 ;; Fill ELEMENT contents by side-effect.
4332 ;; If element has no contents, don't modify it.
4334 ;; Greater element: parse it between `contents-begin' and
4335 ;; `contents-end'. Make sure GRANULARITY allows the
4336 ;; recursion, or ELEMENT is a headline, in which case going
4337 ;; inside is mandatory, in order to get sub-level headings.
4345 ;; Possibly switch to a special mode.
4349 granularity visible-only element))
4350 ;; ELEMENT has contents. Parse objects inside, if
4351 ;; GRANULARITY allows it.
4357 ;; Update mode.
4359 ;; Return result.
4363 "Return next object in current buffer or nil.
4364 RESTRICTION is a list of object types, as symbols, that should be
4365 looked after. This function assumes that the buffer is narrowed
4366 to an appropriate container (e.g., a paragraph)."
4376 nil)
4377 ;; Since we moved backward, we do not want to
4378 ;; match again an hypothetical 1-character long
4379 ;; radio link before us. Realizing that this can
4380 ;; only happen if such a radio link starts at
4381 ;; beginning of line, we prevent this here.
4387 found)
4454 ;; This is probably a plain link.
4464 "Parse objects between BEG and END and return recursive structure.
4466 Objects are accumulated in ACC. RESTRICTION is a list of object
4467 successors which are allowed in the current object.
4469 ACC becomes the parent for all parsed objects. However, if ACC
4470 is nil (i.e., a secondary string is being parsed) and optional
4471 argument PARENT is non-nil, use it as the parent for all objects.
4472 Eventually, if both ACC and PARENT are nil, the common parent is
4473 the list of objects itself."
4481 ;; Text before any object.
4486 contents))))
4487 ;; Object...
4492 ;; Fill contents of NEXT-OBJECT if possible.
4494 cont-beg
4496 next-object
4498 next-object)
4499 contents)
4501 ;; Text after last object.
4505 contents)))
4506 ;; Result. Set appropriate parent.
4514 \f
4515 ;;; Towards A Bijective Process
4516 ;;
4517 ;; The parse tree obtained with `org-element-parse-buffer' is really
4518 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4519 ;; interpreted and expanded into a string with canonical Org syntax.
4520 ;; Hence `org-element-interpret-data'.
4521 ;;
4522 ;; The function relies internally on
4523 ;; `org-element--interpret-affiliated-keywords'.
4525 ;;;###autoload
4527 "Interpret DATA as Org syntax.
4528 DATA is a parse tree, an element, an object or a secondary string
4529 to interpret. Return Org syntax as a string."
4533 ;; Find interpreter for current object or
4534 ;; element. If it doesn't exist (e.g. this is
4535 ;; a pseudo object or element), return contents,
4536 ;; if any.
4543 ;; Secondary string.
4546 data
4548 ;; Full Org document.
4553 ;; Plain text: return it.
4555 ;; Element or object without contents.
4558 ;; Element or object with contents.
4561 interpret
4562 data
4563 ;; Recursively interpret contents.
4568 data
4569 ;; Fix indentation of elements containing
4570 ;; objects. We ignore `table-row'
4571 ;; elements as they are one line long
4572 ;; anyway.
4574 data
4575 ;; When normalizing first paragraph of
4576 ;; an item or a footnote-definition,
4577 ;; ignore first line's indentation.
4585 ;; Build white spaces. If no `:post-blank' property
4586 ;; is specified, assume its value is 0.
4596 "Return ELEMENT's affiliated keywords as Org syntax.
4597 If there is no affiliated keyword, return the empty string."
4607 ": "
4610 value)
4618 ;; All attribute keywords can have multiple lines.
4624 ;; List all ELEMENT's properties matching an attribute line or an
4625 ;; affiliated keyword, but ignore translated keywords since they
4626 ;; cannot belong to the property list.
4633 org-element-keyword-translation-alist)))))
4634 collect prop)
4637 ;; Because interpretation of the parse tree must return the same
4638 ;; number of blank lines between elements and the same number of white
4639 ;; space after objects, some special care must be given to white
4640 ;; spaces.
4641 ;;
4642 ;; The first function, `org-element-normalize-string', ensures any
4643 ;; string different from the empty string will end with a single
4644 ;; newline character.
4645 ;;
4646 ;; The second function, `org-element-normalize-contents', removes
4647 ;; global indentation from the contents of the current element.
4650 "Ensure string S ends with a single newline character.
4652 If S isn't a string return it unchanged. If S is the empty
4653 string, return it. Otherwise, return a new string with a single
4654 newline character at its end."
4662 "Normalize plain text in ELEMENT's contents.
4664 ELEMENT must only contain plain text and objects.
4666 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4667 indentation to compute maximal common indentation.
4669 Return the normalized element that is element with global
4670 indentation removed from its contents."
4672 ;; Return minimal common indentation within BLOB. This is
4673 ;; done by walking recursively BLOB and updating MIN-IND
4674 ;; along the way. FIRST-FLAG is non-nil when the next
4675 ;; object is expected to be a string that doesn't start
4676 ;; with a newline character. It happens for strings at
4677 ;; the beginnings of the contents or right after a line
4678 ;; break.
4684 ;; Objects cannot start with spaces: in this
4685 ;; case, indentation is 0.
4726 ;; Build ELEMENT back, replacing each string with the same
4727 ;; string minus common indentation.
4730 ;; Return DATUM with all its strings indentation
4731 ;; shortened from MIN-IND white spaces.
4751 org-element-recursive-objects)
4755 datum)))
4759 \f
4760 ;;; Cache
4761 ;;
4762 ;; Implement a caching mechanism for `org-element-at-point' and
4763 ;; `org-element-context', which see.
4764 ;;
4765 ;; A single public function is provided: `org-element-cache-reset'.
4766 ;;
4767 ;; Cache is enabled by default, but can be disabled globally with
4768 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4769 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4770 ;; can be tweaked to control caching behaviour.
4771 ;;
4772 ;; Internally, parsed elements are stored in an AVL tree,
4773 ;; `org-element--cache'. This tree is updated lazily: whenever
4774 ;; a change happens to the buffer, a synchronization request is
4775 ;; registered in `org-element--cache-sync-requests' (see
4776 ;; `org-element--cache-submit-request'). During idle time, requests
4777 ;; are processed by `org-element--cache-sync'. Synchronization also
4778 ;; happens when an element is required from the cache. In this case,
4779 ;; the process stops as soon as the needed element is up-to-date.
4780 ;;
4781 ;; A synchronization request can only apply on a synchronized part of
4782 ;; the cache. Therefore, the cache is updated at least to the
4783 ;; location where the new request applies. Thus, requests are ordered
4784 ;; from left to right and all elements starting before the first
4785 ;; request are correct. This property is used by functions like
4786 ;; `org-element--cache-find' to retrieve elements in the part of the
4787 ;; cache that can be trusted.
4788 ;;
4789 ;; A request applies to every element, starting from its original
4790 ;; location (or key, see below). When a request is processed, it
4791 ;; moves forward and may collide the next one. In this case, both
4792 ;; requests are merged into a new one that starts from that element.
4793 ;; As a consequence, the whole synchronization complexity does not
4794 ;; depend on the number of pending requests, but on the number of
4795 ;; elements the very first request will be applied on.
4796 ;;
4797 ;; Elements cannot be accessed through their beginning position, which
4798 ;; may or may not be up-to-date. Instead, each element in the tree is
4799 ;; associated to a key, obtained with `org-element--cache-key'. This
4800 ;; mechanism is robust enough to preserve total order among elements
4801 ;; even when the tree is only partially synchronized.
4802 ;;
4803 ;; Objects contained in an element are stored in a hash table,
4804 ;; `org-element--cache-objects'.
4808 "Non-nil when Org parser should cache its results.
4810 WARNING: for the time being, using cache sometimes triggers
4811 freezes. Therefore, it is disabled by default. Activate it if
4818 "Maximum duration, as a time value, for a cache synchronization.
4819 If the synchronization is not over after this delay, the process
4820 pauses and resumes after `org-element-cache-sync-break'
4824 "Duration, as a time value, of the pause between synchronizations.
4828 ;;;; Data Structure
4831 "AVL tree used to cache elements.
4832 Each node of the tree contains an element. Comparison is done
4833 with `org-element--cache-compare'. This cache is used in
4837 "Hash table used as to cache objects.
4838 Key is an element, as returned by `org-element-at-point', and
4839 value is an alist where each association is:
4841 (PARENT COMPLETEP . OBJECTS)
4843 where PARENT is an element or object, COMPLETEP is a boolean,
4844 non-nil when all direct children of parent are already cached and
4845 OBJECTS is a list of such children, as objects, from farthest to
4846 closest.
4849 contained within a paragraph
4853 If the paragraph is completely parsed, OBJECTS-DATA will be
4855 ((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4856 (BOLD-OBJECT t ENTITY-OBJECT))
4858 whereas in a partially parsed paragraph, it could be
4860 ((PARAGRAPH nil ENTITY-OBJECT))
4865 "List of pending synchronization requests.
4867 A request is a vector with the following pattern:
4869 \[NEXT BEG END OFFSET PARENT PHASE]
4871 Processing a synchronization request consists of three phases:
4873 0. Delete modified elements,
4874 1. Fill missing area in cache,
4875 2. Shift positions and re-parent elements after the changes.
4877 During phase 0, NEXT is the key of the first element to be
4878 removed, BEG and END is buffer position delimiting the
4879 modifications. Elements starting between them (inclusive) are
4880 removed. So are elements whose parent is removed. PARENT, when
4881 non-nil, is the parent of the first element to be removed.
4883 During phase 1, NEXT is the key of the next known element in
4884 cache and BEG its beginning position. Parse buffer between that
4885 element and the one before it in order to determine the parent of
4886 the next element. Set PARENT to the element containing NEXT.
4888 During phase 2, NEXT is the key of the next element to shift in
4889 the parse tree. All elements starting from this one have their
4890 properties relatives to buffer positions shifted by integer
4891 OFFSET and, if they belong to element PARENT, are adopted by it.
4899 "Hash table used to store keys during synchronization.
4903 "Return a unique key for ELEMENT in cache tree.
4905 Keys are used to keep a total order among elements in the cache.
4906 Comparison is done with `org-element--cache-key-less-p'.
4908 When no synchronization is taking place, a key is simply the
4909 beginning position of the element, or that position plus one in
4910 the case of an first item (respectively row) in
4911 a list (respectively a table).
4913 During a synchronization, the key is the one the element had when
4914 the cache was synchronized for the last time. Elements added to
4915 cache during the synchronization get a new key generated with
4916 `org-element--cache-generate-key'.
4918 Such keys are stored in `org-element--cache-sync-keys'. The hash
4919 table is cleared once the synchronization is complete."
4922 ;; Increase beginning position of items (respectively
4923 ;; table rows) by one, so the first item can get
4924 ;; a different key from its parent list (respectively
4925 ;; table).
4928 begin)))
4931 key))))
4934 "Generate a key between LOWER and UPPER.
4936 LOWER and UPPER are integers or lists, possibly empty.
4938 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4939 a unique key, as an integer or a list of integers, according to
4940 the following rules:
4942 - LOWER and UPPER are compared level-wise until values differ.
4944 - If, at a given level, LOWER and UPPER differ from more than
4945 2, the new key shares all the levels above with LOWER and
4946 gets a new level. Its value is the mean between LOWER and
4947 UPPER:
4949 (1 2) + (1 4) --> (1 3)
4951 - If LOWER has no value to compare with, it is assumed that its
4952 value is `most-negative-fixnum'. E.g.,
4954 (1 1) + (1 1 2)
4956 is equivalent to
4958 (1 1 m) + (1 1 2)
4960 where m is `most-negative-fixnum'. Likewise, if UPPER is
4961 short of levels, the current value is `most-positive-fixnum'.
4963 - If they differ from only one, the new key inherits from
4964 current LOWER level and fork it at the next level. E.g.,
4966 (2 1) + (3 3)
4968 is equivalent to
4970 (2 1) + (2 M)
4972 where M is `most-positive-fixnum'.
4974 - If the key is only one level long, it is returned as an
4975 integer:
4977 (1 2) + (3 2) --> 2
4979 When they are not equals, the function assumes that LOWER is
4980 lesser than UPPER, per `org-element--cache-key-less-p'."
4984 skip-upper key)
4995 ;; When at a given level, LOWER and UPPER differ from
4996 ;; 1, ignore UPPER altogether. Instead create a key
4997 ;; between LOWER and the greatest key with the same
4998 ;; prefix as LOWER so far.
5004 "Non-nil if key A is less than key B.
5005 A and B are either integers or lists of integers, as returned by
5006 `org-element--cache-key'."
5014 ;; If A is empty, either keys are equal (B is also empty) and
5015 ;; we return nil, or A is lesser than B (B is longer) and we
5016 ;; return a non-nil value.
5017 ;;
5018 ;; If A is not empty, B is necessarily empty and A is greater
5019 ;; than B (A is longer). Therefore, return nil.
5023 "Non-nil when element A is located before element B."
5028 "Return root value in cache.
5029 This function assumes `org-element--cache' is a valid AVL tree."
5033 ;;;; Tools
5036 "Non-nil when cache is active in current buffer."
5038 org-element--cache
5042 "Find element in cache starting at POS or before.
5044 POS refers to a buffer position.
5046 When optional argument SIDE is non-nil, the function checks for
5047 elements starting at or past POS instead. If SIDE is `both', the
5048 function returns a cons cell where car is the first element
5049 starting at or before POS and cdr the first element starting
5050 after POS.
5052 The function can only find elements in the synchronized part of
5053 the cache."
5057 lower upper)
5072 ;; We found an element in cache starting at POS. If `side'
5073 ;; is `both' we also want the next one in order to generate
5074 ;; a key in-between.
5075 ;;
5076 ;; If the element is the first row or item in a table or
5077 ;; a plain list, we always return the table or the plain
5078 ;; list.
5079 ;;
5080 ;; In any other case, we return the element found.
5089 lower parent
5090 upper parent)))))
5093 lower element
5094 upper element)))))
5101 "Store ELEMENT in current buffer's cache, if allowed.
5102 When optional argument DATA is non-nil, assume is it object data
5103 relative to ELEMENT and store it in the objects cache."
5107 ;; During synchronization, first build an appropriate key
5108 ;; for the new element so `avl-tree-enter' can insert it at
5109 ;; the right spot in the cache.
5118 org-element--cache-sync-keys)))
5120 ;; Headlines are not stored in cache, so objects in titles are
5121 ;; not stored either.
5126 "Remove ELEMENT from cache.
5127 Assume ELEMENT belongs to cache and that a cache is active."
5132 ;;;; Synchronization
5135 "Set idle timer for cache synchronization in BUFFER."
5142 org-element-cache-sync-idle-time))
5143 nil
5144 #'org-element--cache-sync
5145 buffer)))
5148 "Non-nil when synchronization process should be interrupted.
5149 TIME-LIMIT is a time value or nil."
5155 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5157 Properties containing buffer positions are `:begin', `:end',
5158 `:contents-begin', `:contents-end' and `:structure'. When
5159 optional argument PROPS is a list of keywords, only shift
5160 properties provided in that list.
5162 Properties are modified by side-effect."
5164 ;; Shift `:structure' property for the first plain list only: it
5165 ;; is the only one that really matters and it prevents from
5166 ;; shifting it more than once.
5180 "Synchronize cache with recent modification in BUFFER.
5182 When optional argument THRESHOLD is non-nil, do the
5183 synchronization for all elements starting before or at threshold,
5184 then exit. Otherwise, synchronize cache for as long as
5185 `org-element-cache-sync-duration' or until Emacs leaves idle
5186 state.
5188 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5189 not registered yet in the cache are going to happen. It is used
5190 in `org-element--cache-submit-request', where cache is partially
5191 updated before current modification are actually submitted."
5202 request
5204 threshold
5207 org-element-cache-sync-duration))
5208 future-change)
5209 ;; Request processed. Merge current and next offsets and
5210 ;; transfer ending position.
5216 ;; If more requests are awaiting, set idle timer accordingly.
5217 ;; Otherwise, reset keys.
5224 "Process synchronization REQUEST for all entries before NEXT.
5226 REQUEST is a vector, built by `org-element--cache-submit-request'.
5228 NEXT is a cache key, as returned by `org-element--cache-key'.
5230 When non-nil, THRESHOLD is a buffer position. Synchronization
5231 stops as soon as a shifted element begins after it.
5233 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5234 after this time or when Emacs exits idle state.
5236 When non-nil, FUTURE-CHANGE is a buffer position where changes
5237 not registered yet in the cache are going to happen. See
5238 `org-element--cache-submit-request' for more information.
5240 Throw `interrupt' if the process stops before completing the
5241 request."
5244 ;; Phase 0.
5245 ;;
5246 ;; Delete all elements starting after BEG, but not after buffer
5247 ;; position END or past element with key NEXT. Also delete
5248 ;; elements contained within a previously removed element
5249 ;; (stored in `last-container').
5250 ;;
5251 ;; At each iteration, we start again at tree root since
5252 ;; a deletion modifies structure of the balanced tree.
5257 ;; Find first element in cache with key BEG or after it.
5261 data data-key last-container)
5270 data-key key
5273 data-key key
5274 node nil)))))
5284 up)))
5287 end))
5294 ;; No element starting after modifications left in
5295 ;; cache: further processing is futile.
5298 ;; Phase 1.
5299 ;;
5300 ;; Phase 0 left a hole in the cache. Some elements after it
5301 ;; could have parents within. For example, in the following
5302 ;; buffer:
5303 ;;
5304 ;; - item
5305 ;;
5306 ;;
5307 ;; Paragraph1
5308 ;;
5309 ;; Paragraph2
5310 ;;
5311 ;; if we remove a blank line between "item" and "Paragraph1",
5312 ;; everything down to "Paragraph2" is removed from cache. But
5313 ;; the paragraph now belongs to the list, and its `:parent'
5314 ;; property no longer is accurate.
5315 ;;
5316 ;; Therefore we need to parse again elements in the hole, or at
5317 ;; least in its last section, so that we can re-parent
5318 ;; subsequent elements, during phase 2.
5319 ;;
5320 ;; Note that we only need to get the parent from the first
5321 ;; element in cache after the hole.
5322 ;;
5323 ;; When next key is lesser or equal to the current one, delegate
5324 ;; phase 1 processing to next request in order to preserve key
5325 ;; order among requests.
5333 ;; Next element will start at its beginning position plus
5334 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5335 ;; contains the real beginning position of the first element to
5336 ;; shift and re-parent.
5340 ;; Changes are going to happen around this element and
5341 ;; they will trigger another phase 1 request. Skip the
5342 ;; current one.
5348 ;; Phase 2.
5349 ;;
5350 ;; Shift all elements starting from key START, but before NEXT, by
5351 ;; OFFSET, and re-parent them when appropriate.
5352 ;;
5353 ;; Elements are modified by side-effect so the tree structure
5354 ;; remains intact.
5355 ;;
5356 ;; Once THRESHOLD, if any, is reached, or once there is an input
5357 ;; pending, exit. Before leaving, the current synchronization
5358 ;; request is updated.
5365 exit-flag)
5366 ;; No re-parenting nor shifting planned: request is over.
5376 ;; We reached NEXT. Request is complete.
5378 ;; Handle interruption request. Update current request.
5383 ;; Shift element.
5386 ;; Shift associated objects data, if any.
5391 ;; Update PARENT and re-parent DATA, only when
5392 ;; necessary. Propagate new structures for lists.
5406 ;; Cache is up-to-date past THRESHOLD. Request
5407 ;; interruption.
5412 ;; We reached end of tree: synchronization complete.
5413 t)))
5416 "Parse elements in current section, down to POS.
5418 Start parsing from the closest between the last known element in
5419 cache or headline above. Return the smallest element containing
5420 POS.
5422 When optional argument SYNCP is non-nil, return the parent of the
5423 element containing POS instead. In that case, it is also
5424 possible to provide TIME-LIMIT, which is a time value specifying
5425 when the parsing should stop. The function throws `interrupt' if
5426 the process stopped before finding the expected result."
5433 element next mode)
5435 ;; Nothing in cache before point: start parsing from first
5436 ;; element following headline above, or first element in
5437 ;; buffer.
5444 ;; Cache returned exact match: return it.
5447 ;; There's a headline between cached value and POS: cached
5448 ;; value is invalid. Start parsing from first element
5449 ;; following the headline.
5456 ;; Check if CACHED or any of its ancestors contain point.
5457 ;;
5458 ;; If there is such an element, we inspect it in order to know
5459 ;; if we return it or if we need to parse its contents.
5460 ;; Otherwise, we just start parsing from current location,
5461 ;; which is right after the top-most element containing
5462 ;; CACHED.
5463 ;;
5464 ;; As a special case, if POS is at the end of the buffer, we
5465 ;; want to return the innermost element ending there.
5466 ;;
5467 ;; Also, if we find an ancestor and discover that we need to
5468 ;; parse its contents, make sure we don't start from
5469 ;; `:contents-begin', as we would otherwise go past CACHED
5470 ;; again. Instead, in that situation, we will resume parsing
5471 ;; from NEXT, which is located after CACHED or its higher
5472 ;; ancestor not containing point.
5484 ;; Parse successively each element until we reach POS.
5497 end 'element mode
5504 ;; Skip any element ending before point. Also skip
5505 ;; element ending at point (unless it is also the end of
5506 ;; buffer) since we're sure that another element begins
5507 ;; after it.
5511 ;; A non-greater element contains point: return it.
5514 ;; Otherwise, we have to decide if ELEMENT really
5515 ;; contains POS. In that case we start parsing from
5516 ;; contents' beginning.
5517 ;;
5518 ;; If POS is at contents' beginning but it is also at
5519 ;; the beginning of the first item in a list or a table.
5520 ;; In that case, we need to create an anchor for that
5521 ;; list or table, so return it.
5522 ;;
5523 ;; Also, if POS is at the end of the buffer, no element
5524 ;; can start after it, but more than one may end there.
5525 ;; Arbitrarily, we choose to return the innermost of
5526 ;; such elements.
5539 parent element
5540 end cend))))
5541 ;; Otherwise, return ELEMENT as it is the smallest
5542 ;; element containing POS.
5547 ;;;; Staging Buffer Changes
5558 "Regexp matching a sensitive line, structure wise.
5559 A sensitive line is a headline, inlinetask, block, drawer, or
5560 latex-environment boundary. When such a line is modified,
5561 structure changes in the document may propagate in the whole
5565 "Non-nil when a sensitive line is about to be changed.
5569 "Request extension of area going to be modified if needed.
5570 BEG and END are the beginning and end of the range of changed
5571 text. See `before-change-functions' for more information."
5581 'headline
5584 org-element--cache-sensitive-re bottom t)))))))))
5587 "Update buffer modifications for current buffer.
5588 BEG and END are the beginning and end of the range of changed
5589 text, and the length in bytes of the pre-change text replaced by
5590 that range. See `after-change-functions' for more information."
5598 ;; Determine if modified area needs to be extended, according
5599 ;; to both previous and current state. We make a special
5600 ;; case for headline editing: if a headline is modified but
5601 ;; not removed, do not extend.
5604 (`headline
5610 org-element--cache-sensitive-re bottom t))))
5611 ;; Effectively extend modified area.
5619 ;; Store synchronization request.
5622 ;; Activate a timer to process the request during idle time.
5626 "Return first element to remove from cache.
5628 BEG and END are buffer positions delimiting buffer modifications.
5629 OFFSET is the size of the changes.
5631 Returned element is usually the first element in cache containing
5632 any position between BEG and END. As an exception, greater
5633 elements around the changes that are robust to contents
5634 modifications are preserved and updated according to the
5635 changes."
5645 special-block))
5646 ;; Drawers named "PROPERTIES" are probably
5647 ;; a properties drawer being edited. Force
5648 ;; parsing to check if editing is over.
5657 ;; UP is a robust greater element containing changes.
5658 ;; We only need to extend its ending boundaries.
5664 ;; We're at top level element containing ELEMENT: if it's
5665 ;; altered by buffer modifications, it is first element in
5666 ;; cache to be removed. Otherwise, that first element is the
5667 ;; following one.
5668 ;;
5669 ;; As a special case, do not remove BEFORE if it is a robust
5670 ;; container for current changes.
5672 before)))))
5675 "Submit a new cache synchronization request for current buffer.
5676 BEG and END are buffer positions delimiting the minimal area
5677 where cache data should be removed. OFFSET is the size of the
5678 change, as an integer."
5680 delete-to delete-from)
5685 ;; Current changes can be merged with first sync request: we
5686 ;; can save a partial cache synchronization.
5689 ;; If last change happened within area to be removed, extend
5690 ;; boundaries of robust parents, if any. Otherwise, find
5691 ;; first element to remove and update request accordingly.
5703 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5704 ;; if any, is no longer a 0-phase request, thus ensuring that
5705 ;; phases are properly ordered. We need to provide OFFSET as
5706 ;; optional parameter since current modifications are not known
5707 ;; yet to the otherwise correct part of the cache (i.e, before
5708 ;; the first request).
5715 ;; When changes happen before the first known
5716 ;; element, re-parent and shift the rest of the
5717 ;; cache.
5719 ;; Otherwise, we find the first non robust
5720 ;; element containing END. All elements between
5721 ;; FIRST and this one are to be removed.
5732 element up))
5734 org-element--cache-sync-requests)
5735 ;; No element to remove. No need to re-parent either.
5736 ;; Simply shift additional elements, if any, by OFFSET.
5739 offset)))))))
5742 ;;;; Public Functions
5744 ;;;###autoload
5746 "Reset cache in current buffer.
5747 When optional argument ALL is non-nil, reset cache in all Org
5748 buffers."
5766 ;;;###autoload
5768 "Refresh cache at position POS."
5775 \f
5776 ;;; The Toolbox
5777 ;;
5778 ;; The first move is to implement a way to obtain the smallest element
5779 ;; containing point. This is the job of `org-element-at-point'. It
5780 ;; basically jumps back to the beginning of section containing point
5781 ;; and proceed, one element after the other, with
5782 ;; `org-element--current-element' until the container is found. Note:
5783 ;; When using `org-element-at-point', secondary values are never
5784 ;; parsed since the function focuses on elements, not on objects.
5785 ;;
5786 ;; At a deeper level, `org-element-context' lists all elements and
5787 ;; objects containing point.
5788 ;;
5789 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5790 ;; internally by navigation and manipulation tools.
5793 ;;;###autoload
5795 "Determine closest element around point.
5797 Return value is a list like (TYPE PROPS) where TYPE is the type
5798 of the element and PROPS a plist of properties associated to the
5799 element.
5801 Possible types are defined in `org-element-all-elements'.
5802 Properties depend on element or object type, but always include
5803 `:begin', `:end', `:parent' and `:post-blank' properties.
5805 As a special case, if point is at the very beginning of the first
5806 item in a list or sub-list, returned element will be that list
5807 instead of the item. Likewise, if point is at the beginning of
5808 the first row of a table, returned element will be the table
5809 instead of the first row.
5811 When point is at the end of the buffer, return the innermost
5812 element ending there."
5818 ;; Within blank lines at the beginning of buffer, return nil.
5820 ;; Within blank lines right after a headline, return that
5821 ;; headline.
5825 ;; Otherwise parse until we find element containing ORIGIN.
5832 ;;;###autoload
5834 "Return smallest element or object around point.
5836 Return value is a list like (TYPE PROPS) where TYPE is the type
5837 of the element or object and PROPS a plist of properties
5838 associated to it.
5840 Possible types are defined in `org-element-all-elements' and
5841 `org-element-all-objects'. Properties depend on element or
5842 object type, but always include `:begin', `:end', `:parent' and
5843 `:post-blank'.
5845 As a special case, if point is right after an object and not at
5846 the beginning of any other object, return that object.
5848 Optional argument ELEMENT, when non-nil, is the closest element
5849 containing point, as returned by `org-element-at-point'.
5850 Providing it allows for quicker computation."
5857 ;; If point is inside an element containing objects or
5858 ;; a secondary string, narrow buffer to the container and
5859 ;; proceed with parsing. Otherwise, return ELEMENT.
5861 ;; At a parsed affiliated keyword, check if we're inside main
5862 ;; or dual value.
5868 org-element-parsed-keywords))
5877 ;; Also change type to retrieve correct restrictions.
5879 ;; At an item, objects can only be located within tag, if any.
5890 ;; At an headline or inlinetask, objects are in title.
5902 ;; At a paragraph, a table-row or a verse block, objects are
5903 ;; located within their contents.
5907 ;; CBEG is nil for table rules.
5912 ;; At a planning line, if point is at a timestamp, return it,
5913 ;; otherwise, return element.
5921 ;; All other locations cannot contain objects: bail out.
5931 next object-data last)
5935 ;; When entering PARENT for the first time, get list
5936 ;; of objects within known so far. Store it in
5937 ;; OBJECT-DATA.
5942 ;; Find NEXT object for analysis.
5944 ;; If NEXT is non-nil, we already exhausted the
5945 ;; cache so we can parse buffer to find the object
5946 ;; after it.
5948 ;; Otherwise, check if cache can help us.
5959 ;; Cache contains the information needed.
5962 pos)
5964 pos)
5970 ;; If we have a new object to analyze, store it in
5971 ;; cache. Otherwise record that there is nothing
5972 ;; more to parse in this element at this depth.
5977 ;; Process NEXT, if any, in order to know if we need
5978 ;; to skip it, return it or move into it.
5985 ;; Skip objects ending before point. Also skip
5986 ;; objects ending at point unless it is also the
5987 ;; end of buffer, since we want to return the
5988 ;; innermost object.
5991 ;; For convenience, when object ends at POS,
5992 ;; without any space, store it in LAST, as we
5993 ;; will return it if no object starts here.
5997 ;; If POS is within a container object, move
5998 ;; into that object.
6002 ;; At contents' end, if there is no
6003 ;; space before point, also move into
6004 ;; object, for consistency with
6005 ;; convenience feature above.
6014 next nil
6015 object-data nil))
6016 ;; Otherwise, return NEXT.
6018 ;; Store results in cache, if applicable.
6022 "List all ancestors of a given element or object.
6024 BLOB is an object or element.
6026 When optional argument TYPES is a list of symbols, return the
6027 first element or object in the lineage whose type belongs to that
6028 list.
6030 When optional argument WITH-SELF is non-nil, lineage includes
6031 BLOB itself as the first element, and TYPES, if provided, also
6032 apply to it.
6034 When BLOB is obtained through `org-element-context' or
6035 `org-element-at-point', only ancestors from its section can be
6036 found. There is no such limitation when BLOB belongs to a full
6037 parse tree."
6039 ancestors)
6046 "Non-nil when elements ELEM-A and ELEM-B are nested."
6055 "Swap elements ELEM-A and ELEM-B.
6056 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6057 end of ELEM-A."
6059 ;; There are two special cases when an element doesn't start at bol:
6060 ;; the first paragraph in an item or in a footnote definition.
6062 ;; Only a paragraph without any affiliated keyword can be moved at
6063 ;; ELEM-A position in such a situation. Note that the case of
6064 ;; a footnote definition is impossible: it cannot contain two
6065 ;; paragraphs in a row because it cannot contain a blank line.
6071 ;; In a special situation, ELEM-A will have no indentation. We'll
6072 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6086 ;; Store inner overlays responsible for visibility status.
6087 ;; We also need to store their boundaries as they will be
6088 ;; removed from buffer.
6103 ;; Get contents.
6111 ;; Restore ex ELEM-A overlays.
6118 ;; Restore ex ELEM-B overlays.
6126 ;; Local variables:
6127 ;; generated-autoload-file: "org-loaddefs.el"
6128 ;; End:
6130 ;;; org-element.el ends here