| blob | 02852a6e503d04f215e0d37b1b36d8c136e47ae1 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 "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.
545 "Append elements to the contents of another element.
547 PARENT is an element or object. CHILDREN can be elements,
548 objects, or a strings.
550 The function takes care of setting `:parent' property for CHILD.
551 Return parent element."
553 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
554 ;; string: parent is the list itself.
557 ;; Add CHILDREN at the end of PARENT contents.
560 parent
562 ;; Return modified PARENT element.
566 "Extract ELEMENT from parse tree.
567 Remove element from the parse tree by side-effect, and return it
568 with its `:parent' property stripped out."
573 parent secondary
576 parent
578 ;; Return ELEMENT with its :parent removed.
582 "Insert ELEMENT before LOCATION in parse tree.
583 LOCATION is an element, object or string within the parse tree.
584 Parse tree is modified by side effect."
589 ;; Special case: LOCATION is the first element of an
590 ;; independent secondary string (e.g. :title property). Add
591 ;; ELEMENT in-place.
595 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
605 ;; Store SIBLINGS at appropriate place in parse tree.
610 ;; Set appropriate :parent property.
614 "Replace element or object OLD with element or object NEW.
615 The function takes care of setting `:parent' property for NEW."
616 ;; Ensure OLD and NEW have the same parent.
620 ;; We cannot replace OLD with NEW since one of them is not an
621 ;; object or element. We take the long path.
624 ;; Since OLD is going to be changed into NEW by side-effect, first
625 ;; make sure that every element or object within NEW has OLD as
626 ;; parent.
629 ;; Transfer contents.
631 ;; Overwrite OLD's properties with NEW's.
633 ;; Transfer type.
637 "Create a new element of type TYPE.
638 Optional argument PROPS, when non-nil, is a plist defining the
639 properties of the element. CHILDREN can be elements, objects or
640 strings."
644 "Return a copy of DATUM.
645 DATUM is an element, object, string or nil. `:parent' property
646 is cleared and contents are removed in the process."
657 \f
658 ;;; Greater elements
659 ;;
660 ;; For each greater element type, we define a parser and an
661 ;; interpreter.
662 ;;
663 ;; A parser returns the element or object as the list described above.
664 ;; Most of them accepts no argument. Though, exceptions exist. Hence
665 ;; every element containing a secondary string (see
666 ;; `org-element-secondary-value-alist') will accept an optional
667 ;; argument to toggle parsing of these secondary strings. Moreover,
668 ;; `item' parser requires current list's structure as its first
669 ;; element.
670 ;;
671 ;; An interpreter accepts two arguments: the list representation of
672 ;; the element or object, and its contents. The latter may be nil,
673 ;; depending on the element or object considered. It returns the
674 ;; appropriate Org syntax, as a string.
675 ;;
676 ;; Parsing functions must follow the naming convention:
677 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
678 ;; defined in `org-element-greater-elements'.
679 ;;
680 ;; Similarly, interpreting functions must follow the naming
681 ;; convention: org-element-TYPE-interpreter.
682 ;;
683 ;; With the exception of `headline' and `item' types, greater elements
684 ;; cannot contain other greater elements of their own type.
685 ;;
686 ;; Beside implementing a parser and an interpreter, adding a new
687 ;; greater element requires tweaking `org-element--current-element'.
688 ;; Moreover, the newly defined type must be added to both
689 ;; `org-element-all-elements' and `org-element-greater-elements'.
692 ;;;; Center Block
695 "Parse a center block.
697 LIMIT bounds the search. AFFILIATED is a list of which CAR is
698 the buffer position at the beginning of the first affiliated
699 keyword and CDR is a plist of affiliated keywords along with
700 their value.
702 Return a list whose CAR is `center-block' and CDR is a plist
703 containing `:begin', `:end', `:contents-begin', `:contents-end',
704 `:post-blank' and `:post-affiliated' keywords.
706 Assume point is at the beginning of the block."
710 ;; Incomplete block: parse it as a paragraph.
715 ;; Empty blocks have no contents.
729 :end end
730 :contents-begin contents-begin
731 :contents-end contents-end
737 "Interpret a center-block element as Org syntax.
738 CONTENTS is the contents of the element."
742 ;;;; Drawer
745 "Parse a drawer.
747 LIMIT bounds the search. AFFILIATED is a list of which CAR is
748 the buffer position at the beginning of the first affiliated
749 keyword and CDR is a plist of affiliated keywords along with
750 their value.
752 Return a list whose CAR is `drawer' and CDR is a plist containing
753 `:drawer-name', `:begin', `:end', `:contents-begin',
754 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
756 Assume point is at beginning of drawer."
759 ;; Incomplete drawer: parse it as a paragraph.
767 ;; Empty drawers have no contents.
780 :end end
781 :drawer-name name
782 :contents-begin contents-begin
783 :contents-end contents-end
789 "Interpret DRAWER element as Org syntax.
790 CONTENTS is the contents of the element."
793 contents))
796 ;;;; Dynamic Block
799 "Parse a dynamic block.
801 LIMIT bounds the search. AFFILIATED is a list of which CAR is
802 the buffer position at the beginning of the first affiliated
803 keyword and CDR is a plist of affiliated keywords along with
804 their value.
806 Return a list whose CAR is `dynamic-block' and CDR is a plist
807 containing `:block-name', `:begin', `:end', `:contents-begin',
808 `:contents-end', `:arguments', `:post-blank' and
809 `:post-affiliated' keywords.
811 Assume point is at beginning of dynamic block."
815 ;; Incomplete block: parse it as a paragraph.
824 ;; Empty blocks have no contents.
837 :end end
838 :block-name name
839 :arguments arguments
840 :contents-begin contents-begin
841 :contents-end contents-end
847 "Interpret DYNAMIC-BLOCK element as Org syntax.
848 CONTENTS is the contents of the element."
853 contents))
856 ;;;; Footnote Definition
865 "Parse a footnote definition.
867 LIMIT bounds the search. AFFILIATED is a list of which CAR is
868 the buffer position at the beginning of the first affiliated
869 keyword and CDR is a plist of affiliated keywords along with
870 their value.
872 Return a list whose CAR is `footnote-definition' and CDR is
873 a plist containing `:label', `:begin' `:end', `:contents-begin',
874 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
876 Assume point is at the beginning of the footnote definition."
888 limit)
890 ;; At a new footnote definition, make sure we end
891 ;; before any affiliated keyword above.
912 :begin begin
913 :end end
914 :contents-begin contents-begin
915 :contents-end contents-end
921 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
922 CONTENTS is the contents of the footnote-definition."
924 " "
925 contents))
928 ;;;; Headline
931 "Return node properties associated to headline at point.
932 Upcase property names. It avoids confusion between properties
933 obtained through property drawer and default properties from the
934 parser (e.g. `:end' and :END:). Return value is a plist."
946 properties))))
949 "Return time properties associated to headline at point.
950 Return value is a plist."
964 plist))))
967 "Parse a headline.
969 Return a list whose CAR is `headline' and CDR is a plist
970 containing `:raw-value', `:title', `:begin', `:end',
971 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
972 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
973 `:deadline', `:closed', `:archivedp', `:commentedp'
974 `:footnote-section-p', `:post-blank' and `:post-affiliated'
975 keywords.
977 The plist also contains any property set in the property drawer,
978 with its name in upper cases and colons added at the
979 beginning (e.g., `:CUSTOM_ID').
981 LIMIT is a buffer position bounding the search.
983 When RAW-SECONDARY-P is non-nil, headline's title will not be
984 parsed as a secondary string, but as a plain string instead.
986 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
1047 end)
1048 :footnote-section-p footnote-section-p
1049 :archivedp archivedp
1050 :commentedp commentedp
1052 time-props
1053 standard-props))))
1055 headline :title
1064 nil
1066 headline)))))))
1069 "Interpret HEADLINE element as Org syntax.
1070 CONTENTS is the contents of the element."
1083 ?*)
1087 " "
1090 org-footnote-section
1091 title))))
1093 heading
1094 ;; Align tags.
1102 ?\s)
1103 tags))
1107 tags))))
1109 contents)))
1112 ;;;; Inlinetask
1115 "Parse an inline task.
1117 Return a list whose CAR is `inlinetask' and CDR is a plist
1118 containing `:title', `:begin', `:end', `:contents-begin' and
1119 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1120 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1121 `:closed', `:post-blank' and `:post-affiliated' keywords.
1123 The plist also contains any property set in the property drawer,
1124 with its name in upper cases and colons added at the
1125 beginning (e.g., `:CUSTOM_ID').
1127 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1128 title will not be parsed as a secondary string, but as a plain
1129 string instead.
1131 Assume point is at beginning of the inline task."
1176 :begin begin
1177 :end end
1178 :contents-begin contents-begin
1179 :contents-end contents-end
1180 :level level
1181 :priority priority
1182 :tags tags
1183 :todo-keyword todo
1184 :todo-type todo-type
1187 time-props
1188 standard-props))))
1190 inlinetask :title
1199 nil
1201 inlinetask))))))
1204 "Interpret INLINETASK element as Org syntax.
1205 CONTENTS is the contents of inlinetask."
1219 ;; Align tags.
1227 ? )
1228 tags))
1232 tags))))
1233 ;; Prefer degenerate inlinetasks when there are no
1234 ;; contents.
1237 contents
1241 ;;;; Item
1244 "Parse an item.
1246 STRUCT is the structure of the plain list.
1248 Return a list whose CAR is `item' and CDR is a plist containing
1249 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1250 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1251 `:post-affiliated' keywords.
1253 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1254 any, will not be parsed as a secondary string, but as a plain
1255 string instead.
1257 Assume point is at the beginning of the item."
1280 ;; Ignore tags in un-ordered lists: they are just
1281 ;; a part of item's body.
1288 ;; If first line isn't empty, contents really
1289 ;; start at the text after item's meta-data.
1299 :begin begin
1300 :end end
1301 :contents-begin contents-begin
1302 :contents-end contents-end
1303 :checkbox checkbox
1304 :counter counter
1305 :structure struct
1309 item :tag
1316 item))))))))
1319 "Interpret ITEM element as Org syntax.
1320 CONTENTS is the contents of the element."
1330 ;; Compute indentation.
1335 ;; Indent contents.
1337 bullet
1352 ;;;; Plain List
1355 ;; Return structure of list at point. Internal function. See
1356 ;; `org-list-struct' for details.
1361 items struct)
1366 ;; At limit: end all items.
1375 ;; At list end: end all items.
1380 ;; At a new item: end previous sibling.
1392 ind
1393 bullet
1396 ;; Description tag.
1400 ;; Ending position, unknown so far.
1401 nil)))
1402 items))
1404 ;; Skip empty lines.
1406 ;; Skip inline tasks and blank lines along the way.
1413 ;; At some text line. Check if it ends any previous item.
1426 ;; Skip blocks (any type) and drawers contents.
1431 limit t)))
1437 "Parse a plain list.
1439 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1440 the buffer position at the beginning of the first affiliated
1441 keyword and CDR is a plist of affiliated keywords along with
1442 their value. STRUCTURE is the structure of the plain list being
1443 parsed.
1445 Return a list whose CAR is `plain-list' and CDR is a plist
1446 containing `:type', `:begin', `:end', `:contents-begin' and
1447 `:contents-end', `:structure', `:post-blank' and
1448 `:post-affiliated' keywords.
1450 Assume point is at the beginning of the list."
1464 pos))
1468 ;; Return value.
1472 :begin begin
1473 :end end
1474 :contents-begin contents-begin
1475 :contents-end contents-end
1476 :structure struct
1482 "Interpret plain-list element as Org syntax.
1483 CONTENTS is the contents of the element."
1491 ;;;; Property Drawer
1494 "Parse a property drawer.
1496 LIMIT bounds the search.
1498 Return a list whose car is `property-drawer' and cdr is a plist
1499 containing `:begin', `:end', `:contents-begin', `:contents-end',
1500 `:post-blank' and `:post-affiliated' keywords.
1502 Assume point is at the beginning of the property drawer."
1515 :end end
1517 :contents-end contents-end
1522 "Interpret property-drawer element as Org syntax.
1523 CONTENTS is the properties within the drawer."
1527 ;;;; Quote Block
1530 "Parse a quote block.
1532 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1533 the buffer position at the beginning of the first affiliated
1534 keyword and CDR is a plist of affiliated keywords along with
1535 their value.
1537 Return a list whose CAR is `quote-block' and CDR is a plist
1538 containing `:begin', `:end', `:contents-begin', `:contents-end',
1539 `:post-blank' and `:post-affiliated' keywords.
1541 Assume point is at the beginning of the block."
1545 ;; Incomplete block: parse it as a paragraph.
1551 ;; Empty blocks have no contents.
1564 :end end
1565 :contents-begin contents-begin
1566 :contents-end contents-end
1572 "Interpret quote-block element as Org syntax.
1573 CONTENTS is the contents of the element."
1577 ;;;; Section
1580 "Parse a section.
1582 Return a list whose CAR is `section' and CDR is a plist
1583 containing `:begin', `:end', `:contents-begin', `contents-end',
1584 `:post-blank' and `:post-affiliated' keywords."
1586 ;; Beginning of section is the beginning of the first non-blank
1587 ;; line after previous headline.
1595 :end end
1596 :contents-begin begin
1597 :contents-end pos-before-blank
1602 "Interpret section element as Org syntax.
1603 CONTENTS is the contents of the element."
1604 contents)
1607 ;;;; Special Block
1610 "Parse a special block.
1612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1613 the buffer position at the beginning of the first affiliated
1614 keyword and CDR is a plist of affiliated keywords along with
1615 their value.
1617 Return a list whose CAR is `special-block' and CDR is a plist
1618 containing `:type', `:begin', `:end', `:contents-begin',
1619 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1621 Assume point is at the beginning of the block."
1628 limit t)))
1629 ;; Incomplete block: parse it as a paragraph.
1635 ;; Empty blocks have no contents.
1648 :begin begin
1649 :end end
1650 :contents-begin contents-begin
1651 :contents-end contents-end
1657 "Interpret SPECIAL-BLOCK element as Org syntax.
1658 CONTENTS is the contents of the element."
1663 \f
1664 ;;; Elements
1665 ;;
1666 ;; For each element, a parser and an interpreter are also defined.
1667 ;; Both follow the same naming convention used for greater elements.
1668 ;;
1669 ;; Also, as for greater elements, adding a new element type is done
1670 ;; through the following steps: implement a parser and an interpreter,
1671 ;; tweak `org-element--current-element' so that it recognizes the new
1672 ;; type and add that new type to `org-element-all-elements'.
1675 ;;;; Babel Call
1678 "Parse a babel call.
1680 LIMIT bounds the search. AFFILIATED is a list of which car is
1681 the buffer position at the beginning of the first affiliated
1682 keyword and cdr is a plist of affiliated keywords along with
1683 their value.
1685 Return a list whose car is `babel-call' and cdr is a plist
1686 containing `:call', `:inside-header', `:arguments',
1687 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1688 `:post-affiliated' as keywords."
1702 value)))
1712 :begin begin
1713 :end end
1714 :value value
1720 "Interpret BABEL-CALL element as Org syntax."
1730 ;;;; Clock
1733 "Parse a clock.
1735 LIMIT bounds the search.
1737 Return a list whose CAR is `clock' and CDR is a plist containing
1738 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1739 `:post-affiliated' as keywords."
1759 :value value
1760 :duration duration
1761 :begin begin
1762 :end end
1763 :post-blank post-blank
1767 "Interpret CLOCK element as Org syntax."
1775 "%2s:%02s"
1779 ;;;; Comment
1782 "Parse a comment.
1784 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1785 the buffer position at the beginning of the first affiliated
1786 keyword and CDR is a plist of affiliated keywords along with
1787 their value.
1789 Return a list whose CAR is `comment' and CDR is a plist
1790 containing `:begin', `:end', `:value', `:post-blank',
1791 `:post-affiliated' keywords.
1793 Assume point is at comment beginning."
1802 ;; Get comments ending.
1805 ;; Accumulate lines without leading hash and first
1806 ;; whitespace.
1820 :end end
1821 :value value
1827 "Interpret COMMENT element as Org syntax.
1828 CONTENTS is nil."
1832 ;;;; Comment Block
1835 "Parse an export block.
1837 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1838 the buffer position at the beginning of the first affiliated
1839 keyword and CDR is a plist of affiliated keywords along with
1840 their value.
1842 Return a list whose CAR is `comment-block' and CDR is a plist
1843 containing `:begin', `:end', `:value', `:post-blank' and
1844 `:post-affiliated' keywords.
1846 Assume point is at comment block beginning."
1850 ;; Incomplete block: parse it as a paragraph.
1863 contents-begin contents-end)))
1867 :end end
1868 :value value
1874 "Interpret COMMENT-BLOCK element as Org syntax."
1881 ;;;; Diary Sexp
1884 "Parse a diary sexp.
1886 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1887 the buffer position at the beginning of the first affiliated
1888 keyword and CDR is a plist of affiliated keywords along with
1889 their value.
1891 Return a list whose CAR is `diary-sexp' and CDR is a plist
1892 containing `:begin', `:end', `:value', `:post-blank' and
1893 `:post-affiliated' keywords."
1905 :begin begin
1906 :end end
1912 "Interpret DIARY-SEXP as Org syntax."
1916 ;;;; Example Block
1919 "Parse an example block.
1921 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1922 the buffer position at the beginning of the first affiliated
1923 keyword and CDR is a plist of affiliated keywords along with
1924 their value.
1926 Return a list whose CAR is `example-block' and CDR is a plist
1927 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1928 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1929 `:value', `:post-blank' and `:post-affiliated' keywords."
1933 ;; Incomplete block: parse it as a paragraph.
1941 ;; Switches analysis.
1945 switches)
1948 'new
1951 ;; Subtract 1 to give number of lines before
1952 ;; first line.
1956 ;; Should labels be retained in (or stripped from) example
1957 ;; blocks?
1962 ;; What should code-references use - labels or
1963 ;; line-numbers?
1972 ;; Standard block parsing.
1978 contents-begin contents-end)))
1987 :end end
1988 :value value
1989 :switches switches
1990 :number-lines number-lines
1991 :preserve-indent preserve-indent
1992 :retain-labels retain-labels
1993 :use-labels use-labels
1994 :label-fmt label-fmt
2000 "Interpret EXAMPLE-BLOCK element as Org syntax."
2008 value
2013 ;;;; Export Block
2016 "Parse an export block.
2018 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2019 the buffer position at the beginning of the first affiliated
2020 keyword and CDR is a plist of affiliated keywords along with
2021 their value.
2023 Return a list whose CAR is `export-block' and CDR is a plist
2024 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2025 `:post-affiliated' keywords.
2027 Assume point is at export-block beginning."
2031 ;; Incomplete block: parse it as a paragraph.
2050 contents-end))))
2054 :begin begin
2055 :end end
2056 :value value
2062 "Interpret EXPORT-BLOCK element as Org syntax."
2068 ;;;; Fixed-width
2071 "Parse a fixed-width section.
2073 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2074 the buffer position at the beginning of the first affiliated
2075 keyword and CDR is a plist of affiliated keywords along with
2076 their value.
2078 Return a list whose CAR is `fixed-width' and CDR is a plist
2079 containing `:begin', `:end', `:value', `:post-blank' and
2080 `:post-affiliated' keywords.
2082 Assume point is at the beginning of the fixed-width area."
2086 value
2091 ;; Accumulate text without starting colons.
2104 :end end
2105 :value value
2111 "Interpret FIXED-WIDTH element as Org syntax."
2119 ;;;; Horizontal Rule
2122 "Parse an horizontal rule.
2124 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2125 the buffer position at the beginning of the first affiliated
2126 keyword and CDR is a plist of affiliated keywords along with
2127 their value.
2129 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2130 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2131 keywords."
2141 :end end
2147 "Interpret HORIZONTAL-RULE element as Org syntax."
2151 ;;;; Keyword
2154 "Parse a keyword at point.
2156 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2157 the buffer position at the beginning of the first affiliated
2158 keyword and CDR is a plist of affiliated keywords along with
2159 their value.
2161 Return a list whose CAR is `keyword' and CDR is a plist
2162 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2163 `:post-affiliated' keywords."
2165 ;; An orphaned affiliated keyword is considered as a regular
2166 ;; keyword. In this case AFFILIATED is nil, so we take care of
2167 ;; this corner case.
2180 :value value
2181 :begin begin
2182 :end end
2188 "Interpret KEYWORD element as Org syntax."
2194 ;;;; Latex Environment
2198 "Regexp matching the beginning of a LaTeX environment.
2199 The environment is captured by the first group.
2205 "Format string matching the ending of a LaTeX environment.
2209 "Parse a LaTeX environment.
2211 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2212 the buffer position at the beginning of the first affiliated
2213 keyword and CDR is a plist of affiliated keywords along with
2214 their value.
2216 Return a list whose CAR is `latex-environment' and CDR is a plist
2217 containing `:begin', `:end', `:value', `:post-blank' and
2218 `:post-affiliated' keywords.
2220 Assume point is at the beginning of the latex environment."
2227 limit t))
2228 ;; Incomplete latex environment: parse it as a paragraph.
2238 :end end
2239 :value value
2245 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2249 ;;;; Node Property
2252 "Parse a node-property at point.
2254 LIMIT bounds the search.
2256 Return a list whose CAR is `node-property' and CDR is a plist
2257 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2258 `:post-affiliated' keywords."
2268 limit))))
2271 :value value
2272 :begin begin
2273 :end end
2278 "Interpret NODE-PROPERTY element as Org syntax."
2284 ;;;; Paragraph
2287 "Parse a paragraph.
2289 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2290 the buffer position at the beginning of the first affiliated
2291 keyword and CDR is a plist of affiliated keywords along with
2292 their value.
2294 Return a list whose CAR is `paragraph' and CDR is a plist
2295 containing `:begin', `:end', `:contents-begin' and
2296 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2298 Assume point is at the beginning of the paragraph."
2305 ;; A matching `org-element-paragraph-separate' is not
2306 ;; necessarily the end of the paragraph. In particular,
2307 ;; drawers, blocks or LaTeX environments opening lines
2308 ;; must be closed. Moreover keywords with a secondary
2309 ;; value must belong to "dual keywords".
2323 limit t)))
2329 limit t)))
2332 org-element-dual-keywords))
2333 ;; Everything else is unambiguous.
2346 :end end
2347 :contents-begin contents-begin
2348 :contents-end contents-end
2354 "Interpret paragraph element as Org syntax.
2355 CONTENTS is the contents of the element."
2356 contents)
2359 ;;;; Planning
2362 "Parse a planning.
2364 LIMIT bounds the search.
2366 Return a list whose CAR is `planning' and CDR is a plist
2367 containing `:closed', `:deadline', `:scheduled', `:begin',
2368 `:end', `:post-blank' and `:post-affiliated' keywords."
2378 closed deadline scheduled)
2390 :deadline deadline
2391 :scheduled scheduled
2392 :begin begin
2393 :end end
2394 :post-blank post-blank
2398 "Interpret PLANNING element as Org syntax."
2400 #'identity
2417 ;;;; Src Block
2420 "Parse a src block.
2422 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2423 the buffer position at the beginning of the first affiliated
2424 keyword and CDR is a plist of affiliated keywords along with
2425 their value.
2427 Return a list whose CAR is `src-block' and CDR is a plist
2428 containing `:language', `:switches', `:parameters', `:begin',
2429 `:end', `:number-lines', `:retain-labels', `:use-labels',
2430 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2431 `:post-affiliated' keywords.
2433 Assume point is at the beginning of the block."
2436 limit t)))
2437 ;; Incomplete block: parse it as a paragraph.
2443 ;; Get language as a string.
2452 ;; Get switches.
2454 ;; Get parameters.
2456 ;; Switches analysis.
2460 switches)
2463 'new
2466 ;; Subtract 1 to give number of lines before
2467 ;; first line.
2475 ;; Should labels be retained in (or stripped from)
2476 ;; src blocks?
2481 ;; What should code-references use - labels or
2482 ;; line-numbers?
2487 ;; Retrieve code.
2494 ;; Get position after ending blank lines.
2504 :begin begin
2505 :end end
2506 :number-lines number-lines
2507 :preserve-indent preserve-indent
2508 :retain-labels retain-labels
2509 :use-labels use-labels
2510 :label-fmt label-fmt
2511 :value value
2517 "Interpret SRC-BLOCK element as Org syntax."
2526 val)
2541 ;;;; Table
2544 "Parse a table at point.
2546 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2547 the buffer position at the beginning of the first affiliated
2548 keyword and CDR is a plist of affiliated keywords along with
2549 their value.
2551 Return a list whose CAR is `table' and CDR is a plist containing
2552 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2553 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2554 keywords.
2556 Assume point is at the beginning of the table."
2572 acc))
2579 :end end
2580 :type type
2581 :tblfm tblfm
2582 ;; Only `org' tables have contents. `table.el' tables
2583 ;; use a `:value' property to store raw table as
2584 ;; a string.
2589 table-begin table-end))
2595 "Interpret TABLE element as Org syntax.
2596 CONTENTS is a string, if table's type is `org', or nil."
2607 ;;;; Table Row
2610 "Parse table row at point.
2612 Return a list whose CAR is `table-row' and CDR is a plist
2613 containing `:begin', `:end', `:contents-begin', `:contents-end',
2614 `:type', `:post-blank' and `:post-affiliated' keywords."
2618 ;; A table rule has no contents. In that case, ensure
2619 ;; CONTENTS-BEGIN matches CONTENTS-END.
2629 :begin begin
2630 :end end
2631 :contents-begin contents-begin
2632 :contents-end contents-end
2637 "Interpret TABLE-ROW element as Org syntax.
2638 CONTENTS is the contents of the table row."
2643 ;;;; Verse Block
2646 "Parse a verse block.
2648 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2649 the buffer position at the beginning of the first affiliated
2650 keyword and CDR is a plist of affiliated keywords along with
2651 their value.
2653 Return a list whose CAR is `verse-block' and CDR is a plist
2654 containing `:begin', `:end', `:contents-begin', `:contents-end',
2655 `:post-blank' and `:post-affiliated' keywords.
2657 Assume point is at beginning of the block."
2661 ;; Incomplete block: parse it as a paragraph.
2676 :end end
2677 :contents-begin contents-begin
2678 :contents-end contents-end
2684 "Interpret verse-block element as Org syntax.
2685 CONTENTS is verse block contents."
2689 \f
2690 ;;; Objects
2691 ;;
2692 ;; Unlike to elements, raw text can be found between objects. Hence,
2693 ;; `org-element--object-lex' is provided to find the next object in
2694 ;; buffer.
2695 ;;
2696 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2697 ;; object types they can contain will be specified in
2698 ;; `org-element-object-restrictions'.
2699 ;;
2700 ;; Creating a new type of object requires to alter
2701 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2702 ;; new type in `org-element-all-objects', and possibly add
2703 ;; restrictions in `org-element-object-restrictions'.
2705 ;;;; Bold
2708 "Parse bold object at point, if any.
2710 When at a bold object, return a list whose car is `bold' and cdr
2711 is a plist with `:begin', `:end', `:contents-begin' and
2712 `:contents-end' and `:post-blank' keywords. Otherwise, return
2713 nil.
2715 Assume point is at the first star marker."
2727 :end end
2728 :contents-begin contents-begin
2729 :contents-end contents-end
2733 "Interpret bold object as Org syntax.
2734 CONTENTS is the contents of the object."
2738 ;;;; Code
2741 "Parse code object at point, if any.
2743 When at a code object, return a list whose car is `code' and cdr
2744 is a plist with `:value', `:begin', `:end' and `:post-blank'
2745 keywords. Otherwise, return nil.
2747 Assume point is at the first tilde marker."
2758 :begin begin
2759 :end end
2763 "Interpret CODE object as Org syntax."
2767 ;;;; Entity
2770 "Parse entity at point, if any.
2772 When at an entity, return a list whose car is `entity' and cdr
2773 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2774 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2775 `:post-blank' as keywords. Otherwise, return nil.
2777 Assume point is at the beginning of the entity."
2779 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2797 :begin begin
2798 :end end
2799 :use-brackets-p bracketsp
2803 "Interpret ENTITY object as Org syntax."
2809 ;;;; Export Snippet
2812 "Parse export snippet at point.
2814 When at an export snippet, return a list whose car is
2815 `export-snippet' and cdr a plist with `:begin', `:end',
2816 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2817 return nil.
2819 Assume point is at the beginning of the snippet."
2835 :value value
2836 :begin begin
2837 :end end
2841 "Interpret EXPORT-SNIPPET object as Org syntax."
2847 ;;;; Footnote Reference
2850 "Parse footnote reference at point, if any.
2852 When at a footnote reference, return a list whose car is
2853 `footnote-reference' and cdr a plist with `:label', `:type',
2854 `:begin', `:end', `:content-begin', `:contents-end' and
2855 `:post-blank' as keywords. Otherwise, return nil."
2871 :type type
2872 :begin begin
2873 :end end
2879 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2880 CONTENTS is its definition, when inline, or nil."
2886 ;;;; Inline Babel Call
2889 "Parse inline babel call at point, if any.
2891 When at an inline babel call, return a list whose car is
2892 `inline-babel-call' and cdr a plist with `:call',
2893 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2894 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2896 Assume point is at the beginning of the babel call."
2910 ;; Parenthesis are mandatory.
2921 :inside-header inside-header
2922 :arguments arguments
2923 :end-header end-header
2924 :begin begin
2925 :end end
2926 :value value
2930 "Interpret INLINE-BABEL-CALL object as Org syntax."
2940 ;;;; Inline Src Block
2943 "Parse inline source block at point, if any.
2945 When at an inline source block, return a list whose car is
2946 `inline-src-block' and cdr a plist with `:begin', `:end',
2947 `:language', `:value', `:parameters' and `:post-blank' as
2948 keywords. Otherwise, return nil.
2950 Assume point is at the beginning of the inline src block."
2967 :value value
2968 :parameters parameters
2969 :begin begin
2974 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2979 language
2981 body)))
2983 ;;;; Italic
2986 "Parse italic object at point, if any.
2988 When at an italic object, return a list whose car is `italic' and
2989 cdr is a plist with `:begin', `:end', `:contents-begin' and
2990 `:contents-end' and `:post-blank' keywords. Otherwise, return
2991 nil.
2993 Assume point is at the first slash marker."
3005 :end end
3006 :contents-begin contents-begin
3007 :contents-end contents-end
3011 "Interpret italic object as Org syntax.
3012 CONTENTS is the contents of the object."
3016 ;;;; Latex Fragment
3019 "Parse LaTeX fragment at point, if any.
3021 When at a LaTeX fragment, return a list whose car is
3022 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3023 and `:post-blank' as keywords. Otherwise, return nil.
3025 Assume point is at the beginning of the LaTeX fragment."
3043 ;; Macro.
3053 :begin begin
3054 :end end
3058 "Interpret LATEX-FRAGMENT object as Org syntax."
3061 ;;;; Line Break
3064 "Parse line break at point, if any.
3066 When at a line break, return a list whose car is `line-break',
3067 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3068 Otherwise, return nil.
3070 Assume point is at the beginning of the line break."
3079 "Interpret LINE-BREAK object as Org syntax."
3083 ;;;; Link
3086 "Parse link at point, if any.
3088 When at a link, return a list whose car is `link' and cdr a plist
3089 with `:type', `:path', `:format', `:raw-link', `:application',
3090 `:search-option', `:begin', `:end', `:contents-begin',
3091 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3092 nil.
3094 Assume point is at the beginning of the link."
3097 end contents-begin contents-end link-end post-blank path type format
3098 raw-link search-option application)
3100 ;; Type 1: Text targeted from a radio target.
3110 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3116 ;; RAW-LINK is the original link. Expand any
3117 ;; abbreviation in it.
3118 ;;
3119 ;; Also treat any newline character and associated
3120 ;; indentation as a single space character. This is not
3121 ;; compatible with RFC 3986, which requires to ignore
3122 ;; them altogether. However, doing so would require
3123 ;; users to encode spaces on the fly when writing links
3124 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3125 ;; [[shell:ls *.org]], which defeats Org's focus on
3126 ;; simplicity.
3131 ;; Determine TYPE of link and set PATH accordingly. According
3132 ;; to RFC 3986, remove whitespaces from URI in external links.
3133 ;; In internal ones, treat indentation as a single space.
3135 ;; File type.
3140 ;; Explicit type (http, irc, bbdb...).
3144 ;; Code-ref type: PATH is the name of the reference.
3149 ;; Custom-id type: PATH is the name of the custom id.
3153 ;; Fuzzy type: Internal link either matches a target, an
3154 ;; headline name or nothing. PATH is the target or
3155 ;; headline's name.
3159 ;; Type 3: Plain link, e.g., http://orgmode.org
3166 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3167 ;; bracket links, follow RFC 3986 and remove any extra
3168 ;; whitespace in URI.
3179 ;; In any case, deduce end point after trailing white space from
3180 ;; LINK-END variable.
3185 ;; Special "file" type link processing. Extract opening
3186 ;; application and search option, if any. Also normalize URI.
3193 ;; Translate link, if `org-link-translation-function' is set.
3201 :path path
3202 :format format
3204 :application application
3205 :search-option search-option
3206 :begin begin
3207 :end end
3208 :contents-begin contents-begin
3209 :contents-end contents-end
3213 "Interpret LINK object as Org syntax.
3214 CONTENTS is the contents of the object, or nil."
3219 ;; Links with contents and internal links have to
3220 ;; use bracket syntax. Ignore `:format' in these
3221 ;; cases. This is also the default syntax when the
3222 ;; property is not defined, e.g., when the object
3223 ;; was crafted by the user.
3226 ;; Since this is going to be used as
3227 ;; a format string, escape percent signs
3228 ;; in description.
3231 `nil
3234 ;; Otherwise, just obey to `:format'.
3246 path
3252 ;;;; Macro
3255 "Parse macro at point, if any.
3257 When at a macro, return a list whose car is `macro' and cdr
3258 a plist with `:key', `:args', `:begin', `:end', `:value' and
3259 `:post-blank' as keywords. Otherwise, return nil.
3261 Assume point is at the macro."
3274 :value value
3275 :args args
3276 :begin begin
3277 :end end
3281 "Interpret MACRO object as Org syntax."
3285 ;;;; Radio-target
3288 "Parse radio target at point, if any.
3290 When at a radio target, return a list whose car is `radio-target'
3291 and cdr a plist with `:begin', `:end', `:contents-begin',
3292 `:contents-end', `:value' and `:post-blank' as keywords.
3293 Otherwise, return nil.
3295 Assume point is at the radio target."
3307 :end end
3308 :contents-begin contents-begin
3309 :contents-end contents-end
3310 :post-blank post-blank
3314 "Interpret target object as Org syntax.
3315 CONTENTS is the contents of the object."
3319 ;;;; Statistics Cookie
3322 "Parse statistics cookie at point, if any.
3324 When at a statistics cookie, return a list whose car is
3325 `statistics-cookie', and cdr a plist with `:begin', `:end',
3326 `:value' and `:post-blank' keywords. Otherwise, return nil.
3328 Assume point is at the beginning of the statistics-cookie."
3339 :end end
3340 :value value
3344 "Interpret STATISTICS-COOKIE object as Org syntax."
3348 ;;;; Strike-Through
3351 "Parse strike-through object at point, if any.
3353 When at a strike-through object, return a list whose car is
3354 `strike-through' and cdr is a plist with `:begin', `:end',
3355 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3356 Otherwise, return nil.
3358 Assume point is at the first plus sign marker."
3370 :end end
3371 :contents-begin contents-begin
3372 :contents-end contents-end
3376 "Interpret strike-through object as Org syntax.
3377 CONTENTS is the contents of the object."
3381 ;;;; Subscript
3384 "Parse subscript at point, if any.
3386 When at a subscript object, return a list whose car is
3387 `subscript' and cdr a plist with `:begin', `:end',
3388 `:contents-begin', `:contents-end', `:use-brackets-p' and
3389 `:post-blank' as keywords. Otherwise, return nil.
3391 Assume point is at the underscore."
3405 :end end
3406 :use-brackets-p bracketsp
3407 :contents-begin contents-begin
3408 :contents-end contents-end
3412 "Interpret SUBSCRIPT object as Org syntax.
3413 CONTENTS is the contents of the object."
3416 contents))
3419 ;;;; Superscript
3422 "Parse superscript at point, if any.
3424 When at a superscript object, return a list whose car is
3425 `superscript' and cdr a plist with `:begin', `:end',
3426 `:contents-begin', `:contents-end', `:use-brackets-p' and
3427 `:post-blank' as keywords. Otherwise, return nil.
3429 Assume point is at the caret."
3443 :end end
3444 :use-brackets-p bracketsp
3445 :contents-begin contents-begin
3446 :contents-end contents-end
3450 "Interpret SUPERSCRIPT object as Org syntax.
3451 CONTENTS is the contents of the object."
3454 contents))
3457 ;;;; Table Cell
3460 "Parse table cell at point.
3461 Return a list whose car is `table-cell' and cdr is a plist
3462 containing `:begin', `:end', `:contents-begin', `:contents-end'
3463 and `:post-blank' keywords."
3471 :end end
3472 :contents-begin contents-begin
3473 :contents-end contents-end
3477 "Interpret table-cell element as Org syntax.
3478 CONTENTS is the contents of the cell, or nil."
3482 ;;;; Target
3485 "Parse target at point, if any.
3487 When at a target, return a list whose car is `target' and cdr
3488 a plist with `:begin', `:end', `:value' and `:post-blank' as
3489 keywords. Otherwise, return nil.
3491 Assume point is at the target."
3501 :end end
3502 :value value
3506 "Interpret TARGET object as Org syntax."
3510 ;;;; Timestamp
3521 "Parse time stamp at point, if any.
3523 When at a time stamp, return a list whose car is `timestamp', and
3524 cdr a plist with `:type', `:raw-value', `:year-start',
3525 `:month-start', `:day-start', `:hour-start', `:minute-start',
3526 `:year-end', `:month-end', `:day-end', `:hour-end',
3527 `:minute-end', `:repeater-type', `:repeater-value',
3528 `:repeater-unit', `:warning-type', `:warning-value',
3529 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3530 Otherwise, return nil.
3532 Assume point is at the beginning of the timestamp."
3551 date-start)
3562 raw-value)
3564 :repeater-type
3570 :repeater-unit
3579 :warning-unit
3582 year-start month-start day-start hour-start minute-start year-end
3583 month-end day-end hour-end minute-end)
3584 ;; Parse date-start.
3592 ;; Compute date-end. It can be provided directly in time-stamp,
3593 ;; or extracted from time range. Otherwise, it defaults to the
3594 ;; same values as date-start.
3604 :raw-value raw-value
3605 :year-start year-start
3606 :month-start month-start
3607 :day-start day-start
3608 :hour-start hour-start
3609 :minute-start minute-start
3610 :year-end year-end
3611 :month-end month-end
3612 :day-end day-end
3613 :hour-end hour-end
3614 :minute-end minute-end
3615 :begin begin
3616 :end end
3618 repeater-props
3619 warning-props))))))
3622 "Interpret TIMESTAMP object as Org syntax."
3640 ;; Build an Org timestamp string from TIME. ACTIVEP is
3641 ;; non-nil when time stamp is active. If WITH-TIME-P is
3642 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3643 ;; specify a time range in the timestamp. REPEAT-STRING is
3644 ;; the repeater string, if any.
3648 org-time-stamp-formats)
3649 time)))
3655 nil nil ts)))
3660 " "
3661 s
3663 ;; Return value.
3664 ts)))
3676 build-ts-string
3695 0
3703 "--"
3716 ;;;; Underline
3719 "Parse underline object at point, if any.
3721 When at an underline object, return a list whose car is
3722 `underline' and cdr is a plist with `:begin', `:end',
3723 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3724 Otherwise, return nil.
3726 Assume point is at the first underscore marker."
3738 :end end
3739 :contents-begin contents-begin
3740 :contents-end contents-end
3744 "Interpret underline object as Org syntax.
3745 CONTENTS is the contents of the object."
3749 ;;;; Verbatim
3752 "Parse verbatim object at point, if any.
3754 When at a verbatim object, return a list whose car is `verbatim'
3755 and cdr is a plist with `:value', `:begin', `:end' and
3756 `:post-blank' keywords. Otherwise, return nil.
3758 Assume point is at the first equal sign marker."
3769 :begin begin
3770 :end end
3774 "Interpret VERBATIM object as Org syntax."
3778 \f
3779 ;;; Parsing Element Starting At Point
3780 ;;
3781 ;; `org-element--current-element' is the core function of this section.
3782 ;; It returns the Lisp representation of the element starting at
3783 ;; point.
3784 ;;
3785 ;; `org-element--current-element' makes use of special modes. They
3786 ;; are activated for fixed element chaining (e.g., `plain-list' >
3787 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3788 ;; `section'). Special modes are: `first-section', `item',
3789 ;; `node-property', `section' and `table-row'.
3792 "Parse the element starting at point.
3794 Return value is a list like (TYPE PROPS) where TYPE is the type
3795 of the element and PROPS a plist of properties associated to the
3796 element.
3798 Possible types are defined in `org-element-all-elements'.
3800 LIMIT bounds the search.
3802 Optional argument GRANULARITY determines the depth of the
3803 recursion. Allowed values are `headline', `greater-element',
3804 `element', `object' or nil. When it is broader than `object' (or
3805 nil), secondary values will not be parsed, since they only
3806 contain objects.
3808 Optional argument MODE, when non-nil, can be either
3809 `first-section', `section', `planning', `item', `node-property'
3810 and `table-row'.
3812 If STRUCTURE isn't provided but MODE is set to `item', it will be
3813 computed.
3815 This function assumes point is always at the beginning of the
3816 element it has to parse."
3819 ;; Determine if parsing depth allows for secondary strings
3820 ;; parsing. It only applies to elements referenced in
3821 ;; `org-element-secondary-value-alist'.
3824 ;; Item.
3827 ;; Table Row.
3829 ;; Node Property.
3831 ;; Headline.
3834 ;; Sections (must be checked after headline).
3839 limit)))
3840 ;; Planning.
3843 ;; Property drawer.
3847 ;; When not at bol, point is at the beginning of an item or
3848 ;; a footnote definition: next item is always a paragraph.
3850 ;; Clock.
3852 ;; Inlinetask.
3855 ;; From there, elements can have affiliated keywords.
3858 ;; Jumping over affiliated keywords put point off-limits.
3859 ;; Parse them as regular keywords.
3863 ;; LaTeX Environment.
3866 ;; Drawer and Property Drawer.
3869 ;; Fixed Width
3872 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3873 ;; Keywords.
3891 limit
3892 affiliated))
3905 ;; Footnote Definition.
3908 ;; Horizontal Rule.
3911 ;; Diary Sexp.
3914 ;; Table.
3917 ;; List.
3920 limit affiliated
3922 ;; Default element: Paragraph.
3926 ;; Most elements can have affiliated keywords. When looking for an
3927 ;; element beginning, we want to move before them, as they belong to
3928 ;; that element, and, in the meantime, collect information they give
3929 ;; into appropriate properties. Hence the following function.
3932 "Collect affiliated keywords from point down to LIMIT.
3934 Return a list whose CAR is the position at the first of them and
3935 CDR a plist of keywords and values and move point to the
3936 beginning of the first line after them.
3938 As a special case, if element doesn't start at the beginning of
3939 the line (e.g., a paragraph starting an item), CAR is current
3940 position of point and CDR is nil."
3944 ;; RESTRICT is the list of objects allowed in parsed
3945 ;; keywords value.
3947 output)
3950 ;; Apply translation to RAW-KWD. From there, KWD is
3951 ;; the official keyword.
3953 org-element-keyword-translation-alist))
3954 raw-kwd))
3955 ;; Find main value for any keyword.
3961 ;; PARSEDP is non-nil when keyword should have its
3962 ;; value parsed.
3964 ;; If KWD is a dual keyword, find its secondary
3965 ;; value. Maybe parse it.
3974 ;; Attribute a property name to KWD.
3976 ;; Now set final shape for VALUE.
3982 nil restrict)))
3986 ;; Attributes can always appear on multiple lines.
3989 ;; Eventually store the new value in OUTPUT.
3991 ;; Move to next keyword.
3993 ;; If affiliated keywords are orphaned: move back to first one.
3994 ;; They will be parsed as a paragraph.
3996 ;; Return value.
4000 \f
4001 ;;; The Org Parser
4002 ;;
4003 ;; The two major functions here are `org-element-parse-buffer', which
4004 ;; parses Org syntax inside the current buffer, taking into account
4005 ;; region, narrowing, or even visibility if specified, and
4006 ;; `org-element-parse-secondary-string', which parses objects within
4007 ;; a given string.
4008 ;;
4009 ;; The (almost) almighty `org-element-map' allows applying a function
4010 ;; on elements or objects matching some type, and accumulating the
4011 ;; resulting values. In an export situation, it also skips unneeded
4012 ;; parts of the parse tree.
4015 "Recursively parse the buffer and return structure.
4016 If narrowing is in effect, only parse the visible part of the
4017 buffer.
4019 Optional argument GRANULARITY determines the depth of the
4020 recursion. It can be set to the following symbols:
4022 `headline' Only parse headlines.
4023 `greater-element' Don't recurse into greater elements excepted
4024 headlines and sections. Thus, elements
4025 parsed are the top-level ones.
4026 `element' Parse everything but objects and plain text.
4027 `object' Parse the complete buffer (default).
4029 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4030 elements.
4032 An element or an objects is represented as a list with the
4033 pattern (TYPE PROPERTIES CONTENTS), where :
4035 TYPE is a symbol describing the element or object. See
4036 `org-element-all-elements' and `org-element-all-objects' for an
4037 exhaustive list of such symbols. One can retrieve it with
4038 `org-element-type' function.
4040 PROPERTIES is the list of attributes attached to the element or
4041 object, as a plist. Although most of them are specific to the
4042 element or object type, all types share `:begin', `:end',
4043 `:post-blank' and `:parent' properties, which respectively
4044 refer to buffer position where the element or object starts,
4045 ends, the number of white spaces or blank lines after it, and
4046 the element or object containing it. Properties values can be
4047 obtained by using `org-element-property' function.
4049 CONTENTS is a list of elements, objects or raw strings
4050 contained in the current element or object, when applicable.
4051 One can access them with `org-element-contents' function.
4053 The Org buffer has `org-data' as type and nil as properties.
4054 `org-element-map' function can be used to find specific elements
4055 or objects within the parse tree.
4057 This function assumes that current major mode is `org-mode'."
4063 ;; Start in `first-section' mode so text before the first
4064 ;; headline belongs to a section.
4068 "Recursively parse objects in STRING and return structure.
4070 RESTRICTION is a symbol limiting the object types that will be
4071 looked after.
4073 Optional argument PARENT, when non-nil, is the element or object
4074 containing the secondary string. It is used to set correctly
4075 `:parent' property within the string.
4077 If STRING is the empty string or nil, return nil."
4094 "Map a function on selected elements or objects.
4096 DATA is a parse tree, an element, an object, a string, or a list
4097 of such constructs. TYPES is a symbol or list of symbols of
4098 elements or objects types (see `org-element-all-elements' and
4099 `org-element-all-objects' for a complete list of types). FUN is
4100 the function called on the matching element or object. It has to
4101 accept one argument: the element or object itself.
4103 When optional argument INFO is non-nil, it should be a plist
4104 holding export options. In that case, parts of the parse tree
4105 not exportable according to that property list will be skipped.
4107 When optional argument FIRST-MATCH is non-nil, stop at the first
4108 match for which FUN doesn't return nil, and return that value.
4110 Optional argument NO-RECURSION is a symbol or a list of symbols
4111 representing elements or objects types. `org-element-map' won't
4112 enter any recursive element or object whose type belongs to that
4113 list. Though, FUN can still be applied on them.
4115 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4116 apply to matching objects within parsed affiliated keywords (see
4117 `org-element-parsed-keywords').
4119 Nil values returned from FUN do not appear in the results.
4122 Examples:
4123 ---------
4125 Assuming TREE is a variable containing an Org buffer parse tree,
4126 the following example will return a flat list of all `src-block'
4127 and `example-block' elements in it:
4131 The following snippet will find the first headline with a level
4135 (lambda (hl)
4136 (and (= (org-element-property :level hl) 1)
4138 (org-element-property :begin hl)))
4139 nil t)
4141 The next example will return a flat list of all `plain-list' type
4142 elements in TREE that are not a sub-list themselves:
4146 Eventually, this example will return a flat list of all `bold'
4147 type objects containing a `latex-snippet' type object, even
4148 looking into captions:
4151 (lambda (b)
4153 nil nil nil t)"
4154 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4158 ;; Recursion depth is determined by --CATEGORY.
4165 ;; If one object is found, the function has
4166 ;; to recurse into every object.
4169 ;; If one regular element is found, the
4170 ;; function has to recurse, at least, into
4171 ;; every element it encounters.
4174 --acc)
4177 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4178 ;; holding contextual information.
4182 ;; Ignored element in an export context.
4184 ;; List of elements or objects.
4186 ;; Unconditionally enter parse trees.
4190 ;; Check if TYPE is matching among TYPES. If so,
4191 ;; apply FUN to --DATA and accumulate return value
4192 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4198 ;; If --DATA has a secondary string that can contain
4199 ;; objects with their type among TYPES, look inside.
4202 org-element-secondary-value-alist)))
4204 ;; If --DATA has any parsed affiliated keywords and
4205 ;; WITH-AFFILIATED is non-nil, look for objects in
4206 ;; them.
4213 ;; Pay attention to the type of parsed
4214 ;; keyword. In particular, preserve order for
4215 ;; multiple keywords.
4228 ;; Determine if a recursion into --DATA is possible.
4230 ;; --TYPE is explicitly removed from recursion.
4232 ;; --DATA has no contents.
4234 ;; Looking for greater elements but --DATA is
4235 ;; simply an element or an object.
4238 ;; Looking for elements but --DATA is an object.
4241 ;; In any other case, map contents.
4245 ;; Return value in a proper order.
4249 ;; The following functions are internal parts of the parser.
4250 ;;
4251 ;; The first one, `org-element--parse-elements' acts at the element's
4252 ;; level.
4253 ;;
4254 ;; The second one, `org-element--parse-objects' applies on all objects
4255 ;; of a paragraph or a secondary string. It calls
4256 ;; `org-element--object-lex' to find the next object in the current
4257 ;; container.
4260 "Return next special mode according to TYPE, or nil.
4261 TYPE is a symbol representing the type of an element or object
4262 containing next element if PARENTP is non-nil, or before it
4263 otherwise. Modes can be either `first-section', `item',
4264 `node-property', `planning', `property-drawer', `section',
4265 `table-row' or nil."
4282 "Parse elements between BEG and END positions.
4284 MODE prioritizes some elements over the others. It can be set to
4285 `first-section', `section', `planning', `item', `node-property'
4286 or `table-row'.
4288 When value is `item', STRUCTURE will be used as the current list
4289 structure.
4291 GRANULARITY determines the depth of the recursion. See
4292 `org-element-parse-buffer' for more information.
4294 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4295 elements.
4297 Elements are accumulated into ACC."
4300 ;; Visible only: skip invisible parts at the beginning of the
4301 ;; element.
4304 ;; When parsing only headlines, skip any text before first one.
4309 ;; Find current element's type and parse it accordingly to
4310 ;; its category.
4312 end granularity mode structure))
4316 ;; Visible only: skip invisible parts between siblings.
4319 ;; Fill ELEMENT contents by side-effect.
4321 ;; If element has no contents, don't modify it.
4323 ;; Greater element: parse it between `contents-begin' and
4324 ;; `contents-end'. Make sure GRANULARITY allows the
4325 ;; recursion, or ELEMENT is a headline, in which case going
4326 ;; inside is mandatory, in order to get sub-level headings.
4334 ;; Possibly switch to a special mode.
4338 granularity visible-only element))
4339 ;; ELEMENT has contents. Parse objects inside, if
4340 ;; GRANULARITY allows it.
4346 ;; Update mode.
4348 ;; Return result.
4352 "Return next object in current buffer or nil.
4353 RESTRICTION is a list of object types, as symbols, that should be
4354 looked after. This function assumes that the buffer is narrowed
4355 to an appropriate container (e.g., a paragraph)."
4364 nil)
4365 ;; Since we moved backward, we do not want to
4366 ;; match again an hypothetical 1-character long
4367 ;; radio link before us. Realizing that this can
4368 ;; only happen if such a radio link starts at
4369 ;; beginning of line, we prevent this here.
4375 found)
4442 ;; This is probably a plain link.
4448 ;; Radio link.
4453 "Parse objects between BEG and END and return recursive structure.
4455 Objects are accumulated in ACC. RESTRICTION is a list of object
4456 successors which are allowed in the current object.
4458 ACC becomes the parent for all parsed objects. However, if ACC
4459 is nil (i.e., a secondary string is being parsed) and optional
4460 argument PARENT is non-nil, use it as the parent for all objects.
4461 Eventually, if both ACC and PARENT are nil, the common parent is
4462 the list of objects itself."
4470 ;; Text before any object. Untabify it.
4475 contents))))
4476 ;; Object...
4481 ;; Fill contents of NEXT-OBJECT if possible.
4483 cont-beg
4485 next-object
4487 next-object)
4488 contents)
4490 ;; Text after last object. Untabify it.
4494 contents)))
4495 ;; Result. Set appropriate parent.
4503 \f
4504 ;;; Towards A Bijective Process
4505 ;;
4506 ;; The parse tree obtained with `org-element-parse-buffer' is really
4507 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4508 ;; interpreted and expanded into a string with canonical Org syntax.
4509 ;; Hence `org-element-interpret-data'.
4510 ;;
4511 ;; The function relies internally on
4512 ;; `org-element--interpret-affiliated-keywords'.
4514 ;;;###autoload
4516 "Interpret DATA as Org syntax.
4517 DATA is a parse tree, an element, an object or a secondary string
4518 to interpret. Return Org syntax as a string."
4522 ;; Find interpreter for current object or
4523 ;; element. If it doesn't exist (e.g. this is
4524 ;; a pseudo object or element), return contents,
4525 ;; if any.
4532 ;; Secondary string.
4535 data
4537 ;; Full Org document.
4542 ;; Plain text: return it.
4544 ;; Element or object without contents.
4547 ;; Element or object with contents.
4550 interpret
4551 data
4552 ;; Recursively interpret contents.
4557 data
4558 ;; Fix indentation of elements containing
4559 ;; objects. We ignore `table-row'
4560 ;; elements as they are one line long
4561 ;; anyway.
4563 data
4564 ;; When normalizing first paragraph of
4565 ;; an item or a footnote-definition,
4566 ;; ignore first line's indentation.
4574 ;; Build white spaces. If no `:post-blank' property
4575 ;; is specified, assume its value is 0.
4585 "Return ELEMENT's affiliated keywords as Org syntax.
4586 If there is no affiliated keyword, return the empty string."
4596 ": "
4599 value)
4607 ;; All attribute keywords can have multiple lines.
4613 ;; List all ELEMENT's properties matching an attribute line or an
4614 ;; affiliated keyword, but ignore translated keywords since they
4615 ;; cannot belong to the property list.
4622 org-element-keyword-translation-alist)))))
4623 collect prop)
4626 ;; Because interpretation of the parse tree must return the same
4627 ;; number of blank lines between elements and the same number of white
4628 ;; space after objects, some special care must be given to white
4629 ;; spaces.
4630 ;;
4631 ;; The first function, `org-element-normalize-string', ensures any
4632 ;; string different from the empty string will end with a single
4633 ;; newline character.
4634 ;;
4635 ;; The second function, `org-element-normalize-contents', removes
4636 ;; global indentation from the contents of the current element.
4639 "Ensure string S ends with a single newline character.
4641 If S isn't a string return it unchanged. If S is the empty
4642 string, return it. Otherwise, return a new string with a single
4643 newline character at its end."
4651 "Normalize plain text in ELEMENT's contents.
4653 ELEMENT must only contain plain text and objects.
4655 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4656 indentation to compute maximal common indentation.
4658 Return the normalized element that is element with global
4659 indentation removed from its contents."
4661 ;; Return minimal common indentation within BLOB. This is
4662 ;; done by walking recursively BLOB and updating MIN-IND
4663 ;; along the way. FIRST-FLAG is non-nil when the next
4664 ;; object is expected to be a string that doesn't start
4665 ;; with a newline character. It happens for strings at
4666 ;; the beginnings of the contents or right after a line
4667 ;; break.
4674 ;; Objects cannot start with spaces: in this
4675 ;; case, indentation is 0.
4698 datum)
4711 ;; Build ELEMENT back, replacing each string with the same
4712 ;; string minus common indentation.
4715 ;; Return DATUM with all its strings indentation
4716 ;; shortened from MIN-IND white spaces.
4736 org-element-recursive-objects)
4740 datum)))
4744 \f
4745 ;;; Cache
4746 ;;
4747 ;; Implement a caching mechanism for `org-element-at-point' and
4748 ;; `org-element-context', which see.
4749 ;;
4750 ;; A single public function is provided: `org-element-cache-reset'.
4751 ;;
4752 ;; Cache is enabled by default, but can be disabled globally with
4753 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4754 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4755 ;; can be tweaked to control caching behaviour.
4756 ;;
4757 ;; Internally, parsed elements are stored in an AVL tree,
4758 ;; `org-element--cache'. This tree is updated lazily: whenever
4759 ;; a change happens to the buffer, a synchronization request is
4760 ;; registered in `org-element--cache-sync-requests' (see
4761 ;; `org-element--cache-submit-request'). During idle time, requests
4762 ;; are processed by `org-element--cache-sync'. Synchronization also
4763 ;; happens when an element is required from the cache. In this case,
4764 ;; the process stops as soon as the needed element is up-to-date.
4765 ;;
4766 ;; A synchronization request can only apply on a synchronized part of
4767 ;; the cache. Therefore, the cache is updated at least to the
4768 ;; location where the new request applies. Thus, requests are ordered
4769 ;; from left to right and all elements starting before the first
4770 ;; request are correct. This property is used by functions like
4771 ;; `org-element--cache-find' to retrieve elements in the part of the
4772 ;; cache that can be trusted.
4773 ;;
4774 ;; A request applies to every element, starting from its original
4775 ;; location (or key, see below). When a request is processed, it
4776 ;; moves forward and may collide the next one. In this case, both
4777 ;; requests are merged into a new one that starts from that element.
4778 ;; As a consequence, the whole synchronization complexity does not
4779 ;; depend on the number of pending requests, but on the number of
4780 ;; elements the very first request will be applied on.
4781 ;;
4782 ;; Elements cannot be accessed through their beginning position, which
4783 ;; may or may not be up-to-date. Instead, each element in the tree is
4784 ;; associated to a key, obtained with `org-element--cache-key'. This
4785 ;; mechanism is robust enough to preserve total order among elements
4786 ;; even when the tree is only partially synchronized.
4787 ;;
4788 ;; Objects contained in an element are stored in a hash table,
4789 ;; `org-element--cache-objects'.
4793 "Non nil when Org parser should cache its results.
4800 "Maximum duration, as a time value, for a cache synchronization.
4801 If the synchronization is not over after this delay, the process
4802 pauses and resumes after `org-element-cache-sync-break'
4806 "Duration, as a time value, of the pause between synchronizations.
4810 ;;;; Data Structure
4813 "AVL tree used to cache elements.
4814 Each node of the tree contains an element. Comparison is done
4815 with `org-element--cache-compare'. This cache is used in
4819 "Hash table used as to cache objects.
4820 Key is an element, as returned by `org-element-at-point', and
4821 value is an alist where each association is:
4823 \(PARENT COMPLETEP . OBJECTS)
4825 where PARENT is an element or object, COMPLETEP is a boolean,
4826 non-nil when all direct children of parent are already cached and
4827 OBJECTS is a list of such children, as objects, from farthest to
4828 closest.
4831 contained within a paragraph
4835 If the paragraph is completely parsed, OBJECTS-DATA will be
4837 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4838 \(BOLD-OBJECT t ENTITY-OBJECT))
4840 whereas in a partially parsed paragraph, it could be
4842 \((PARAGRAPH nil ENTITY-OBJECT))
4847 "List of pending synchronization requests.
4849 A request is a vector with the following pattern:
4851 \[NEXT BEG END OFFSET PARENT PHASE]
4853 Processing a synchronization request consists of three phases:
4855 0. Delete modified elements,
4856 1. Fill missing area in cache,
4857 2. Shift positions and re-parent elements after the changes.
4859 During phase 0, NEXT is the key of the first element to be
4860 removed, BEG and END is buffer position delimiting the
4861 modifications. Elements starting between them (inclusive) are
4862 removed. So are elements whose parent is removed. PARENT, when
4863 non-nil, is the parent of the first element to be removed.
4865 During phase 1, NEXT is the key of the next known element in
4866 cache and BEG its beginning position. Parse buffer between that
4867 element and the one before it in order to determine the parent of
4868 the next element. Set PARENT to the element containing NEXT.
4870 During phase 2, NEXT is the key of the next element to shift in
4871 the parse tree. All elements starting from this one have their
4872 properties relatives to buffer positions shifted by integer
4873 OFFSET and, if they belong to element PARENT, are adopted by it.
4881 "Hash table used to store keys during synchronization.
4885 "Return a unique key for ELEMENT in cache tree.
4887 Keys are used to keep a total order among elements in the cache.
4888 Comparison is done with `org-element--cache-key-less-p'.
4890 When no synchronization is taking place, a key is simply the
4891 beginning position of the element, or that position plus one in
4892 the case of an first item (respectively row) in
4893 a list (respectively a table).
4895 During a synchronization, the key is the one the element had when
4896 the cache was synchronized for the last time. Elements added to
4897 cache during the synchronization get a new key generated with
4898 `org-element--cache-generate-key'.
4900 Such keys are stored in `org-element--cache-sync-keys'. The hash
4901 table is cleared once the synchronization is complete."
4904 ;; Increase beginning position of items (respectively
4905 ;; table rows) by one, so the first item can get
4906 ;; a different key from its parent list (respectively
4907 ;; table).
4910 begin)))
4913 key))))
4916 "Generate a key between LOWER and UPPER.
4918 LOWER and UPPER are integers or lists, possibly empty.
4920 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4921 a unique key, as an integer or a list of integers, according to
4922 the following rules:
4924 - LOWER and UPPER are compared level-wise until values differ.
4926 - If, at a given level, LOWER and UPPER differ from more than
4927 2, the new key shares all the levels above with LOWER and
4928 gets a new level. Its value is the mean between LOWER and
4929 UPPER:
4931 \(1 2) + (1 4) --> (1 3)
4933 - If LOWER has no value to compare with, it is assumed that its
4934 value is `most-negative-fixnum'. E.g.,
4936 \(1 1) + (1 1 2)
4938 is equivalent to
4940 \(1 1 m) + (1 1 2)
4942 where m is `most-negative-fixnum'. Likewise, if UPPER is
4943 short of levels, the current value is `most-positive-fixnum'.
4945 - If they differ from only one, the new key inherits from
4946 current LOWER level and fork it at the next level. E.g.,
4948 \(2 1) + (3 3)
4950 is equivalent to
4952 \(2 1) + (2 M)
4954 where M is `most-positive-fixnum'.
4956 - If the key is only one level long, it is returned as an
4957 integer:
4959 \(1 2) + (3 2) --> 2
4961 When they are not equals, the function assumes that LOWER is
4962 lesser than UPPER, per `org-element--cache-key-less-p'."
4966 skip-upper key)
4977 ;; When at a given level, LOWER and UPPER differ from
4978 ;; 1, ignore UPPER altogether. Instead create a key
4979 ;; between LOWER and the greatest key with the same
4980 ;; prefix as LOWER so far.
4986 "Non-nil if key A is less than key B.
4987 A and B are either integers or lists of integers, as returned by
4988 `org-element--cache-key'."
4996 ;; If A is empty, either keys are equal (B is also empty) and
4997 ;; we return nil, or A is lesser than B (B is longer) and we
4998 ;; return a non-nil value.
4999 ;;
5000 ;; If A is not empty, B is necessarily empty and A is greater
5001 ;; than B (A is longer). Therefore, return nil.
5005 "Non-nil when element A is located before element B."
5010 "Return root value in cache.
5011 This function assumes `org-element--cache' is a valid AVL tree."
5015 ;;;; Tools
5018 "Non-nil when cache is active in current buffer."
5020 org-element--cache
5024 "Find element in cache starting at POS or before.
5026 POS refers to a buffer position.
5028 When optional argument SIDE is non-nil, the function checks for
5029 elements starting at or past POS instead. If SIDE is `both', the
5030 function returns a cons cell where car is the first element
5031 starting at or before POS and cdr the first element starting
5032 after POS.
5034 The function can only find elements in the synchronized part of
5035 the cache."
5039 lower upper)
5054 ;; We found an element in cache starting at POS. If `side'
5055 ;; is `both' we also want the next one in order to generate
5056 ;; a key in-between.
5057 ;;
5058 ;; If the element is the first row or item in a table or
5059 ;; a plain list, we always return the table or the plain
5060 ;; list.
5061 ;;
5062 ;; In any other case, we return the element found.
5071 lower parent
5072 upper parent)))))
5075 lower element
5076 upper element)))))
5083 "Store ELEMENT in current buffer's cache, if allowed.
5084 When optional argument DATA is non-nil, assume is it object data
5085 relative to ELEMENT and store it in the objects cache."
5089 ;; During synchronization, first build an appropriate key
5090 ;; for the new element so `avl-tree-enter' can insert it at
5091 ;; the right spot in the cache.
5100 org-element--cache-sync-keys)))
5102 ;; Headlines are not stored in cache, so objects in titles are
5103 ;; not stored either.
5108 "Remove ELEMENT from cache.
5109 Assume ELEMENT belongs to cache and that a cache is active."
5114 ;;;; Synchronization
5117 "Set idle timer for cache synchronization in BUFFER."
5124 org-element-cache-sync-idle-time))
5125 nil
5126 #'org-element--cache-sync
5127 buffer)))
5130 "Non-nil when synchronization process should be interrupted.
5131 TIME-LIMIT is a time value or nil."
5137 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5139 Properties containing buffer positions are `:begin', `:end',
5140 `:contents-begin', `:contents-end' and `:structure'. When
5141 optional argument PROPS is a list of keywords, only shift
5142 properties provided in that list.
5144 Properties are modified by side-effect."
5146 ;; Shift `:structure' property for the first plain list only: it
5147 ;; is the only one that really matters and it prevents from
5148 ;; shifting it more than once.
5162 "Synchronize cache with recent modification in BUFFER.
5164 When optional argument THRESHOLD is non-nil, do the
5165 synchronization for all elements starting before or at threshold,
5166 then exit. Otherwise, synchronize cache for as long as
5167 `org-element-cache-sync-duration' or until Emacs leaves idle
5168 state.
5170 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5171 not registered yet in the cache are going to happen. It is used
5172 in `org-element--cache-submit-request', where cache is partially
5173 updated before current modification are actually submitted."
5184 request
5186 threshold
5189 org-element-cache-sync-duration))
5190 future-change)
5191 ;; Request processed. Merge current and next offsets and
5192 ;; transfer ending position.
5198 ;; If more requests are awaiting, set idle timer accordingly.
5199 ;; Otherwise, reset keys.
5206 "Process synchronization REQUEST for all entries before NEXT.
5208 REQUEST is a vector, built by `org-element--cache-submit-request'.
5210 NEXT is a cache key, as returned by `org-element--cache-key'.
5212 When non-nil, THRESHOLD is a buffer position. Synchronization
5213 stops as soon as a shifted element begins after it.
5215 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5216 after this time or when Emacs exits idle state.
5218 When non-nil, FUTURE-CHANGE is a buffer position where changes
5219 not registered yet in the cache are going to happen. See
5220 `org-element--cache-submit-request' for more information.
5222 Throw `interrupt' if the process stops before completing the
5223 request."
5226 ;; Phase 0.
5227 ;;
5228 ;; Delete all elements starting after BEG, but not after buffer
5229 ;; position END or past element with key NEXT. Also delete
5230 ;; elements contained within a previously removed element
5231 ;; (stored in `last-container').
5232 ;;
5233 ;; At each iteration, we start again at tree root since
5234 ;; a deletion modifies structure of the balanced tree.
5239 ;; Find first element in cache with key BEG or after it.
5243 data data-key last-container)
5252 data-key key
5255 data-key key
5256 node nil)))))
5266 up)))
5269 end))
5276 ;; No element starting after modifications left in
5277 ;; cache: further processing is futile.
5280 ;; Phase 1.
5281 ;;
5282 ;; Phase 0 left a hole in the cache. Some elements after it
5283 ;; could have parents within. For example, in the following
5284 ;; buffer:
5285 ;;
5286 ;; - item
5287 ;;
5288 ;;
5289 ;; Paragraph1
5290 ;;
5291 ;; Paragraph2
5292 ;;
5293 ;; if we remove a blank line between "item" and "Paragraph1",
5294 ;; everything down to "Paragraph2" is removed from cache. But
5295 ;; the paragraph now belongs to the list, and its `:parent'
5296 ;; property no longer is accurate.
5297 ;;
5298 ;; Therefore we need to parse again elements in the hole, or at
5299 ;; least in its last section, so that we can re-parent
5300 ;; subsequent elements, during phase 2.
5301 ;;
5302 ;; Note that we only need to get the parent from the first
5303 ;; element in cache after the hole.
5304 ;;
5305 ;; When next key is lesser or equal to the current one, delegate
5306 ;; phase 1 processing to next request in order to preserve key
5307 ;; order among requests.
5315 ;; Next element will start at its beginning position plus
5316 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5317 ;; contains the real beginning position of the first element to
5318 ;; shift and re-parent.
5322 ;; Changes are going to happen around this element and
5323 ;; they will trigger another phase 1 request. Skip the
5324 ;; current one.
5330 ;; Phase 2.
5331 ;;
5332 ;; Shift all elements starting from key START, but before NEXT, by
5333 ;; OFFSET, and re-parent them when appropriate.
5334 ;;
5335 ;; Elements are modified by side-effect so the tree structure
5336 ;; remains intact.
5337 ;;
5338 ;; Once THRESHOLD, if any, is reached, or once there is an input
5339 ;; pending, exit. Before leaving, the current synchronization
5340 ;; request is updated.
5347 exit-flag)
5348 ;; No re-parenting nor shifting planned: request is over.
5358 ;; We reached NEXT. Request is complete.
5360 ;; Handle interruption request. Update current request.
5365 ;; Shift element.
5368 ;; Shift associated objects data, if any.
5373 ;; Update PARENT and re-parent DATA, only when
5374 ;; necessary. Propagate new structures for lists.
5388 ;; Cache is up-to-date past THRESHOLD. Request
5389 ;; interruption.
5394 ;; We reached end of tree: synchronization complete.
5395 t)))
5398 "Parse elements in current section, down to POS.
5400 Start parsing from the closest between the last known element in
5401 cache or headline above. Return the smallest element containing
5402 POS.
5404 When optional argument SYNCP is non-nil, return the parent of the
5405 element containing POS instead. In that case, it is also
5406 possible to provide TIME-LIMIT, which is a time value specifying
5407 when the parsing should stop. The function throws `interrupt' if
5408 the process stopped before finding the expected result."
5415 element next mode)
5417 ;; Nothing in cache before point: start parsing from first
5418 ;; element following headline above, or first element in
5419 ;; buffer.
5426 ;; Cache returned exact match: return it.
5429 ;; There's a headline between cached value and POS: cached
5430 ;; value is invalid. Start parsing from first element
5431 ;; following the headline.
5438 ;; Check if CACHED or any of its ancestors contain point.
5439 ;;
5440 ;; If there is such an element, we inspect it in order to know
5441 ;; if we return it or if we need to parse its contents.
5442 ;; Otherwise, we just start parsing from current location,
5443 ;; which is right after the top-most element containing
5444 ;; CACHED.
5445 ;;
5446 ;; As a special case, if POS is at the end of the buffer, we
5447 ;; want to return the innermost element ending there.
5448 ;;
5449 ;; Also, if we find an ancestor and discover that we need to
5450 ;; parse its contents, make sure we don't start from
5451 ;; `:contents-begin', as we would otherwise go past CACHED
5452 ;; again. Instead, in that situation, we will resume parsing
5453 ;; from NEXT, which is located after CACHED or its higher
5454 ;; ancestor not containing point.
5466 ;; Parse successively each element until we reach POS.
5479 end 'element mode
5486 ;; Skip any element ending before point. Also skip
5487 ;; element ending at point (unless it is also the end of
5488 ;; buffer) since we're sure that another element begins
5489 ;; after it.
5493 ;; A non-greater element contains point: return it.
5496 ;; Otherwise, we have to decide if ELEMENT really
5497 ;; contains POS. In that case we start parsing from
5498 ;; contents' beginning.
5499 ;;
5500 ;; If POS is at contents' beginning but it is also at
5501 ;; the beginning of the first item in a list or a table.
5502 ;; In that case, we need to create an anchor for that
5503 ;; list or table, so return it.
5504 ;;
5505 ;; Also, if POS is at the end of the buffer, no element
5506 ;; can start after it, but more than one may end there.
5507 ;; Arbitrarily, we choose to return the innermost of
5508 ;; such elements.
5521 parent element
5522 end cend))))
5523 ;; Otherwise, return ELEMENT as it is the smallest
5524 ;; element containing POS.
5529 ;;;; Staging Buffer Changes
5540 "Regexp matching a sensitive line, structure wise.
5541 A sensitive line is a headline, inlinetask, block, drawer, or
5542 latex-environment boundary. When such a line is modified,
5543 structure changes in the document may propagate in the whole
5547 "Non-nil when a sensitive line is about to be changed.
5551 "Request extension of area going to be modified if needed.
5552 BEG and END are the beginning and end of the range of changed
5553 text. See `before-change-functions' for more information."
5563 'headline
5566 org-element--cache-sensitive-re bottom t)))))))))
5569 "Update buffer modifications for current buffer.
5570 BEG and END are the beginning and end of the range of changed
5571 text, and the length in bytes of the pre-change text replaced by
5572 that range. See `after-change-functions' for more information."
5580 ;; Determine if modified area needs to be extended, according
5581 ;; to both previous and current state. We make a special
5582 ;; case for headline editing: if a headline is modified but
5583 ;; not removed, do not extend.
5586 (`headline
5592 org-element--cache-sensitive-re bottom t))))
5593 ;; Effectively extend modified area.
5601 ;; Store synchronization request.
5604 ;; Activate a timer to process the request during idle time.
5608 "Return first element to remove from cache.
5610 BEG and END are buffer positions delimiting buffer modifications.
5611 OFFSET is the size of the changes.
5613 Returned element is usually the first element in cache containing
5614 any position between BEG and END. As an exception, greater
5615 elements around the changes that are robust to contents
5616 modifications are preserved and updated according to the
5617 changes."
5627 special-block))
5628 ;; Drawers named "PROPERTIES" are probably
5629 ;; a properties drawer being edited. Force
5630 ;; parsing to check if editing is over.
5639 ;; UP is a robust greater element containing changes.
5640 ;; We only need to extend its ending boundaries.
5646 ;; We're at top level element containing ELEMENT: if it's
5647 ;; altered by buffer modifications, it is first element in
5648 ;; cache to be removed. Otherwise, that first element is the
5649 ;; following one.
5650 ;;
5651 ;; As a special case, do not remove BEFORE if it is a robust
5652 ;; container for current changes.
5654 before)))))
5657 "Submit a new cache synchronization request for current buffer.
5658 BEG and END are buffer positions delimiting the minimal area
5659 where cache data should be removed. OFFSET is the size of the
5660 change, as an integer."
5662 delete-to delete-from)
5667 ;; Current changes can be merged with first sync request: we
5668 ;; can save a partial cache synchronization.
5671 ;; If last change happened within area to be removed, extend
5672 ;; boundaries of robust parents, if any. Otherwise, find
5673 ;; first element to remove and update request accordingly.
5685 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5686 ;; if any, is no longer a 0-phase request, thus ensuring that
5687 ;; phases are properly ordered. We need to provide OFFSET as
5688 ;; optional parameter since current modifications are not known
5689 ;; yet to the otherwise correct part of the cache (i.e, before
5690 ;; the first request).
5697 ;; When changes happen before the first known
5698 ;; element, re-parent and shift the rest of the
5699 ;; cache.
5701 ;; Otherwise, we find the first non robust
5702 ;; element containing END. All elements between
5703 ;; FIRST and this one are to be removed.
5714 element up))
5716 org-element--cache-sync-requests)
5717 ;; No element to remove. No need to re-parent either.
5718 ;; Simply shift additional elements, if any, by OFFSET.
5721 offset)))))))
5724 ;;;; Public Functions
5726 ;;;###autoload
5728 "Reset cache in current buffer.
5729 When optional argument ALL is non-nil, reset cache in all Org
5730 buffers."
5748 ;;;###autoload
5750 "Refresh cache at position POS."
5757 \f
5758 ;;; The Toolbox
5759 ;;
5760 ;; The first move is to implement a way to obtain the smallest element
5761 ;; containing point. This is the job of `org-element-at-point'. It
5762 ;; basically jumps back to the beginning of section containing point
5763 ;; and proceed, one element after the other, with
5764 ;; `org-element--current-element' until the container is found. Note:
5765 ;; When using `org-element-at-point', secondary values are never
5766 ;; parsed since the function focuses on elements, not on objects.
5767 ;;
5768 ;; At a deeper level, `org-element-context' lists all elements and
5769 ;; objects containing point.
5770 ;;
5771 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5772 ;; internally by navigation and manipulation tools.
5775 ;;;###autoload
5777 "Determine closest element around point.
5779 Return value is a list like (TYPE PROPS) where TYPE is the type
5780 of the element and PROPS a plist of properties associated to the
5781 element.
5783 Possible types are defined in `org-element-all-elements'.
5784 Properties depend on element or object type, but always include
5785 `:begin', `:end', `:parent' and `:post-blank' properties.
5787 As a special case, if point is at the very beginning of the first
5788 item in a list or sub-list, returned element will be that list
5789 instead of the item. Likewise, if point is at the beginning of
5790 the first row of a table, returned element will be the table
5791 instead of the first row.
5793 When point is at the end of the buffer, return the innermost
5794 element ending there."
5800 ;; Within blank lines at the beginning of buffer, return nil.
5802 ;; Within blank lines right after a headline, return that
5803 ;; headline.
5807 ;; Otherwise parse until we find element containing ORIGIN.
5814 ;;;###autoload
5816 "Return smallest element or object around point.
5818 Return value is a list like (TYPE PROPS) where TYPE is the type
5819 of the element or object and PROPS a plist of properties
5820 associated to it.
5822 Possible types are defined in `org-element-all-elements' and
5823 `org-element-all-objects'. Properties depend on element or
5824 object type, but always include `:begin', `:end', `:parent' and
5825 `:post-blank'.
5827 As a special case, if point is right after an object and not at
5828 the beginning of any other object, return that object.
5830 Optional argument ELEMENT, when non-nil, is the closest element
5831 containing point, as returned by `org-element-at-point'.
5832 Providing it allows for quicker computation."
5839 ;; If point is inside an element containing objects or
5840 ;; a secondary string, narrow buffer to the container and
5841 ;; proceed with parsing. Otherwise, return ELEMENT.
5843 ;; At a parsed affiliated keyword, check if we're inside main
5844 ;; or dual value.
5850 org-element-parsed-keywords))
5859 ;; Also change type to retrieve correct restrictions.
5861 ;; At an item, objects can only be located within tag, if any.
5872 ;; At an headline or inlinetask, objects are in title.
5883 ;; At a paragraph, a table-row or a verse block, objects are
5884 ;; located within their contents.
5888 ;; CBEG is nil for table rules.
5893 ;; At a planning line, if point is at a timestamp, return it,
5894 ;; otherwise, return element.
5902 ;; All other locations cannot contain objects: bail out.
5912 next object-data last)
5916 ;; When entering PARENT for the first time, get list
5917 ;; of objects within known so far. Store it in
5918 ;; OBJECT-DATA.
5923 ;; Find NEXT object for analysis.
5925 ;; If NEXT is non-nil, we already exhausted the
5926 ;; cache so we can parse buffer to find the object
5927 ;; after it.
5929 ;; Otherwise, check if cache can help us.
5940 ;; Cache contains the information needed.
5943 pos)
5945 pos)
5951 ;; If we have a new object to analyze, store it in
5952 ;; cache. Otherwise record that there is nothing
5953 ;; more to parse in this element at this depth.
5958 ;; Process NEXT, if any, in order to know if we need
5959 ;; to skip it, return it or move into it.
5966 ;; Skip objects ending before point. Also skip
5967 ;; objects ending at point unless it is also the
5968 ;; end of buffer, since we want to return the
5969 ;; innermost object.
5972 ;; For convenience, when object ends at POS,
5973 ;; without any space, store it in LAST, as we
5974 ;; will return it if no object starts here.
5978 ;; If POS is within a container object, move
5979 ;; into that object.
5983 ;; At contents' end, if there is no
5984 ;; space before point, also move into
5985 ;; object, for consistency with
5986 ;; convenience feature above.
5995 next nil
5996 object-data nil))
5997 ;; Otherwise, return NEXT.
5999 ;; Store results in cache, if applicable.
6003 "List all ancestors of a given element or object.
6005 BLOB is an object or element.
6007 When optional argument TYPES is a list of symbols, return the
6008 first element or object in the lineage whose type belongs to that
6009 list.
6011 When optional argument WITH-SELF is non-nil, lineage includes
6012 BLOB itself as the first element, and TYPES, if provided, also
6013 apply to it.
6015 When BLOB is obtained through `org-element-context' or
6016 `org-element-at-point', only ancestors from its section can be
6017 found. There is no such limitation when BLOB belongs to a full
6018 parse tree."
6020 ancestors)
6027 "Non-nil when elements ELEM-A and ELEM-B are nested."
6036 "Swap elements ELEM-A and ELEM-B.
6037 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6038 end of ELEM-A."
6040 ;; There are two special cases when an element doesn't start at bol:
6041 ;; the first paragraph in an item or in a footnote definition.
6043 ;; Only a paragraph without any affiliated keyword can be moved at
6044 ;; ELEM-A position in such a situation. Note that the case of
6045 ;; a footnote definition is impossible: it cannot contain two
6046 ;; paragraphs in a row because it cannot contain a blank line.
6052 ;; In a special situation, ELEM-A will have no indentation. We'll
6053 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6067 ;; Store inner overlays responsible for visibility status.
6068 ;; We also need to store their boundaries as they will be
6069 ;; removed from buffer.
6084 ;; Get contents.
6092 ;; Restore ex ELEM-A overlays.
6099 ;; Restore ex ELEM-B overlays.
6107 ;; Local variables:
6108 ;; generated-autoload-file: "org-loaddefs.el"
6109 ;; End:
6111 ;;; org-element.el ends here