| blob | deeb51b011e8c40bf355fbb17749452b753fe96d |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 "Parse paired brackets at point.
426 CHAR is the opening bracket to consider, as a character. Return
427 contents between brackets, as a string, or nil. Also move point
428 past the brackets."
443 \f
444 ;;; Accessors and Setters
445 ;;
446 ;; Provide four accessors: `org-element-type', `org-element-property'
447 ;; `org-element-contents' and `org-element-restriction'.
448 ;;
449 ;; Setter functions allow modification of elements by side effect.
450 ;; There is `org-element-put-property', `org-element-set-contents'.
451 ;; These low-level functions are useful to build a parse tree.
452 ;;
453 ;; `org-element-adopt-element', `org-element-set-element',
454 ;; `org-element-extract-element' and `org-element-insert-before' are
455 ;; high-level functions useful to modify a parse tree.
456 ;;
457 ;; `org-element-secondary-p' is a predicate used to know if a given
458 ;; object belongs to a secondary string. `org-element-class' tells if
459 ;; some parsed data is an element or an object, handling pseudo
460 ;; elements and objects. `org-element-copy' returns an element or
461 ;; object, stripping its parent property in the process.
464 "Return type of ELEMENT.
466 The function returns the type of the element or object provided.
467 It can also return the following special value:
468 `plain-text' for a string
469 `org-data' for a complete document
470 nil in any other case."
476 "Extract the value from the PROPERTY of an ELEMENT."
481 "Extract contents from an ELEMENT."
487 "Return restriction associated to ELEMENT.
488 ELEMENT can be an element, an object or a symbol representing an
489 element or object type."
491 org-element-object-restrictions)))
494 "In ELEMENT set PROPERTY to VALUE.
495 Return modified element."
498 element))
501 "Set ELEMENT's contents to CONTENTS.
502 Return ELEMENT."
509 "Non-nil when OBJECT directly belongs to a secondary string.
510 Return value is the property name, as a keyword, or nil."
513 org-element-secondary-value-alist))))
520 "Return class for ELEMENT, as a symbol.
521 Class is either `element' or `object'. Optional argument PARENT
522 is the element or object containing DATUM. It defaults to the
523 value of DATUM `:parent' property."
527 ;; Trivial cases.
530 ;; Special cases.
534 ;; Pseudo object or elements. Make a guess about its class.
535 ;; Basically a pseudo object is contained within another object,
536 ;; a secondary string or a container element.
546 "Append elements to the contents of another element.
548 PARENT is an element or object. CHILDREN can be elements,
549 objects, or a strings.
551 The function takes care of setting `:parent' property for CHILD.
552 Return parent element."
554 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
555 ;; string: parent is the list itself.
558 ;; Add CHILDREN at the end of PARENT contents.
561 parent
563 ;; Return modified PARENT element.
567 "Extract ELEMENT from parse tree.
568 Remove element from the parse tree by side-effect, and return it
569 with its `:parent' property stripped out."
574 parent secondary
577 parent
579 ;; Return ELEMENT with its :parent removed.
583 "Insert ELEMENT before LOCATION in parse tree.
584 LOCATION is an element, object or string within the parse tree.
585 Parse tree is modified by side effect."
590 ;; Special case: LOCATION is the first element of an
591 ;; independent secondary string (e.g. :title property). Add
592 ;; ELEMENT in-place.
596 ;; Install ELEMENT at the appropriate LOCATION 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."
1032 :begin begin
1033 :end end
1034 :pre-blank
1037 :contents-begin contents-begin
1038 :contents-end contents-end
1039 :level level
1040 :priority priority
1041 :tags tags
1042 :todo-keyword todo
1043 :todo-type todo-type
1044 :post-blank
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', `:pre-blank',
1119 `:contents-begin' and `:contents-end', `:level', `:priority',
1120 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1121 `:scheduled', `:deadline', `:closed', `:post-blank' and
1122 `:post-affiliated' keywords.
1124 The plist also contains any property set in the property drawer,
1125 with its name in upper cases and colons added at the
1126 beginning (e.g., `:CUSTOM_ID').
1128 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1129 title will not be parsed as a secondary string, but as a plain
1130 string instead.
1132 Assume point is at beginning of the inline task."
1179 :begin begin
1180 :end end
1181 :pre-blank
1184 :contents-begin contents-begin
1185 :contents-end contents-end
1186 :level level
1187 :priority priority
1188 :tags tags
1189 :todo-keyword todo
1190 :todo-type todo-type
1193 time-props
1194 standard-props))))
1196 inlinetask :title
1205 nil
1207 inlinetask))))))
1210 "Interpret INLINETASK element as Org syntax.
1211 CONTENTS is the contents of inlinetask."
1225 ;; Align tags.
1233 ? )
1234 tags))
1238 tags))))
1239 ;; Prefer degenerate inlinetasks when there are no
1240 ;; contents.
1243 contents
1247 ;;;; Item
1250 "Parse an item.
1252 STRUCT is the structure of the plain list.
1254 Return a list whose CAR is `item' and CDR is a plist containing
1255 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1256 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1257 `:post-affiliated' keywords.
1259 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1260 any, will not be parsed as a secondary string, but as a plain
1261 string instead.
1263 Assume point is at the beginning of the item."
1286 ;; Ignore tags in un-ordered lists: they are just
1287 ;; a part of item's body.
1294 ;; If first line isn't empty, contents really
1295 ;; start at the text after item's meta-data.
1305 :begin begin
1306 :end end
1307 :contents-begin contents-begin
1308 :contents-end contents-end
1309 :checkbox checkbox
1310 :counter counter
1311 :structure struct
1315 item :tag
1322 item))))))))
1325 "Interpret ITEM element as Org syntax.
1326 CONTENTS is the contents of the element."
1336 ;; Compute indentation.
1341 ;; Indent contents.
1343 bullet
1358 ;;;; Plain List
1361 ;; Return structure of list at point. Internal function. See
1362 ;; `org-list-struct' for details.
1367 items struct)
1372 ;; At limit: end all items.
1381 ;; At list end: end all items.
1386 ;; At a new item: end previous sibling.
1398 ind
1399 bullet
1402 ;; Description tag.
1406 ;; Ending position, unknown so far.
1407 nil)))
1408 items))
1410 ;; Skip empty lines.
1412 ;; Skip inline tasks and blank lines along the way.
1419 ;; At some text line. Check if it ends any previous item.
1432 ;; Skip blocks (any type) and drawers contents.
1437 limit t)))
1443 "Parse a plain list.
1445 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1446 the buffer position at the beginning of the first affiliated
1447 keyword and CDR is a plist of affiliated keywords along with
1448 their value. STRUCTURE is the structure of the plain list being
1449 parsed.
1451 Return a list whose CAR is `plain-list' and CDR is a plist
1452 containing `:type', `:begin', `:end', `:contents-begin' and
1453 `:contents-end', `:structure', `:post-blank' and
1454 `:post-affiliated' keywords.
1456 Assume point is at the beginning of the list."
1470 pos))
1474 ;; Return value.
1478 :begin begin
1479 :end end
1480 :contents-begin contents-begin
1481 :contents-end contents-end
1482 :structure struct
1488 "Interpret plain-list element as Org syntax.
1489 CONTENTS is the contents of the element."
1497 ;;;; Property Drawer
1500 "Parse a property drawer.
1502 LIMIT bounds the search.
1504 Return a list whose car is `property-drawer' and cdr is a plist
1505 containing `:begin', `:end', `:contents-begin', `:contents-end',
1506 `:post-blank' and `:post-affiliated' keywords.
1508 Assume point is at the beginning of the property drawer."
1521 :end end
1523 :contents-end contents-end
1528 "Interpret property-drawer element as Org syntax.
1529 CONTENTS is the properties within the drawer."
1533 ;;;; Quote Block
1536 "Parse a quote block.
1538 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1539 the buffer position at the beginning of the first affiliated
1540 keyword and CDR is a plist of affiliated keywords along with
1541 their value.
1543 Return a list whose CAR is `quote-block' and CDR is a plist
1544 containing `:begin', `:end', `:contents-begin', `:contents-end',
1545 `:post-blank' and `:post-affiliated' keywords.
1547 Assume point is at the beginning of the block."
1551 ;; Incomplete block: parse it as a paragraph.
1557 ;; Empty blocks have no contents.
1570 :end end
1571 :contents-begin contents-begin
1572 :contents-end contents-end
1578 "Interpret quote-block element as Org syntax.
1579 CONTENTS is the contents of the element."
1583 ;;;; Section
1586 "Parse a section.
1588 Return a list whose CAR is `section' and CDR is a plist
1589 containing `:begin', `:end', `:contents-begin', `contents-end',
1590 `:post-blank' and `:post-affiliated' keywords."
1592 ;; Beginning of section is the beginning of the first non-blank
1593 ;; line after previous headline.
1601 :end end
1602 :contents-begin begin
1603 :contents-end pos-before-blank
1608 "Interpret section element as Org syntax.
1609 CONTENTS is the contents of the element."
1610 contents)
1613 ;;;; Special Block
1616 "Parse a special block.
1618 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1619 the buffer position at the beginning of the first affiliated
1620 keyword and CDR is a plist of affiliated keywords along with
1621 their value.
1623 Return a list whose CAR is `special-block' and CDR is a plist
1624 containing `:type', `:begin', `:end', `:contents-begin',
1625 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1627 Assume point is at the beginning of the block."
1634 limit t)))
1635 ;; Incomplete block: parse it as a paragraph.
1641 ;; Empty blocks have no contents.
1654 :begin begin
1655 :end end
1656 :contents-begin contents-begin
1657 :contents-end contents-end
1663 "Interpret SPECIAL-BLOCK element as Org syntax.
1664 CONTENTS is the contents of the element."
1669 \f
1670 ;;; Elements
1671 ;;
1672 ;; For each element, a parser and an interpreter are also defined.
1673 ;; Both follow the same naming convention used for greater elements.
1674 ;;
1675 ;; Also, as for greater elements, adding a new element type is done
1676 ;; through the following steps: implement a parser and an interpreter,
1677 ;; tweak `org-element--current-element' so that it recognizes the new
1678 ;; type and add that new type to `org-element-all-elements'.
1681 ;;;; Babel Call
1684 "Parse a babel call.
1686 LIMIT bounds the search. AFFILIATED is a list of which car is
1687 the buffer position at the beginning of the first affiliated
1688 keyword and cdr is a plist of affiliated keywords along with
1689 their value.
1691 Return a list whose car is `babel-call' and cdr is a plist
1692 containing `:call', `:inside-header', `:arguments',
1693 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1694 `:post-affiliated' as keywords."
1708 value)))
1718 :begin begin
1719 :end end
1720 :value value
1726 "Interpret BABEL-CALL element as Org syntax."
1736 ;;;; Clock
1739 "Parse a clock.
1741 LIMIT bounds the search.
1743 Return a list whose CAR is `clock' and CDR is a plist containing
1744 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1745 `:post-affiliated' as keywords."
1765 :value value
1766 :duration duration
1767 :begin begin
1768 :end end
1769 :post-blank post-blank
1773 "Interpret CLOCK element as Org syntax."
1781 "%2s:%02s"
1785 ;;;; Comment
1788 "Parse a comment.
1790 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1791 the buffer position at the beginning of the first affiliated
1792 keyword and CDR is a plist of affiliated keywords along with
1793 their value.
1795 Return a list whose CAR is `comment' and CDR is a plist
1796 containing `:begin', `:end', `:value', `:post-blank',
1797 `:post-affiliated' keywords.
1799 Assume point is at comment beginning."
1808 ;; Get comments ending.
1811 ;; Accumulate lines without leading hash and first
1812 ;; whitespace.
1826 :end end
1827 :value value
1833 "Interpret COMMENT element as Org syntax.
1834 CONTENTS is nil."
1838 ;;;; Comment Block
1841 "Parse an export block.
1843 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1844 the buffer position at the beginning of the first affiliated
1845 keyword and CDR is a plist of affiliated keywords along with
1846 their value.
1848 Return a list whose CAR is `comment-block' and CDR is a plist
1849 containing `:begin', `:end', `:value', `:post-blank' and
1850 `:post-affiliated' keywords.
1852 Assume point is at comment block beginning."
1856 ;; Incomplete block: parse it as a paragraph.
1869 contents-begin contents-end)))
1873 :end end
1874 :value value
1880 "Interpret COMMENT-BLOCK element as Org syntax."
1887 ;;;; Diary Sexp
1890 "Parse a diary sexp.
1892 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1893 the buffer position at the beginning of the first affiliated
1894 keyword and CDR is a plist of affiliated keywords along with
1895 their value.
1897 Return a list whose CAR is `diary-sexp' and CDR is a plist
1898 containing `:begin', `:end', `:value', `:post-blank' and
1899 `:post-affiliated' keywords."
1911 :begin begin
1912 :end end
1918 "Interpret DIARY-SEXP as Org syntax."
1922 ;;;; Example Block
1925 "Parse an example block.
1927 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1928 the buffer position at the beginning of the first affiliated
1929 keyword and CDR is a plist of affiliated keywords along with
1930 their value.
1932 Return a list whose CAR is `example-block' and CDR is a plist
1933 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1934 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1935 `:value', `:post-blank' and `:post-affiliated' keywords."
1939 ;; Incomplete block: parse it as a paragraph.
1947 ;; Switches analysis.
1951 switches)
1954 'new
1957 ;; Subtract 1 to give number of lines before
1958 ;; first line.
1962 ;; Should labels be retained in (or stripped from) example
1963 ;; blocks?
1968 ;; What should code-references use - labels or
1969 ;; line-numbers?
1978 ;; Standard block parsing.
1984 contents-begin contents-end)))
1993 :end end
1994 :value value
1995 :switches switches
1996 :number-lines number-lines
1997 :preserve-indent preserve-indent
1998 :retain-labels retain-labels
1999 :use-labels use-labels
2000 :label-fmt label-fmt
2006 "Interpret EXAMPLE-BLOCK element as Org syntax."
2014 value
2019 ;;;; Export Block
2022 "Parse an export block.
2024 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2025 the buffer position at the beginning of the first affiliated
2026 keyword and CDR is a plist of affiliated keywords along with
2027 their value.
2029 Return a list whose CAR is `export-block' and CDR is a plist
2030 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2031 `:post-affiliated' keywords.
2033 Assume point is at export-block beginning."
2037 ;; Incomplete block: parse it as a paragraph.
2056 contents-end))))
2060 :begin begin
2061 :end end
2062 :value value
2068 "Interpret EXPORT-BLOCK element as Org syntax."
2074 ;;;; Fixed-width
2077 "Parse a fixed-width section.
2079 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2080 the buffer position at the beginning of the first affiliated
2081 keyword and CDR is a plist of affiliated keywords along with
2082 their value.
2084 Return a list whose CAR is `fixed-width' and CDR is a plist
2085 containing `:begin', `:end', `:value', `:post-blank' and
2086 `:post-affiliated' keywords.
2088 Assume point is at the beginning of the fixed-width area."
2092 value
2097 ;; Accumulate text without starting colons.
2110 :end end
2111 :value value
2117 "Interpret FIXED-WIDTH element as Org syntax."
2125 ;;;; Horizontal Rule
2128 "Parse an horizontal rule.
2130 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2131 the buffer position at the beginning of the first affiliated
2132 keyword and CDR is a plist of affiliated keywords along with
2133 their value.
2135 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2136 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2137 keywords."
2147 :end end
2153 "Interpret HORIZONTAL-RULE element as Org syntax."
2157 ;;;; Keyword
2160 "Parse a keyword at point.
2162 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2163 the buffer position at the beginning of the first affiliated
2164 keyword and CDR is a plist of affiliated keywords along with
2165 their value.
2167 Return a list whose CAR is `keyword' and CDR is a plist
2168 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2169 `:post-affiliated' keywords."
2171 ;; An orphaned affiliated keyword is considered as a regular
2172 ;; keyword. In this case AFFILIATED is nil, so we take care of
2173 ;; this corner case.
2186 :value value
2187 :begin begin
2188 :end end
2194 "Interpret KEYWORD element as Org syntax."
2200 ;;;; Latex Environment
2204 "Regexp matching the beginning of a LaTeX environment.
2205 The environment is captured by the first group.
2211 "Format string matching the ending of a LaTeX environment.
2215 "Parse a LaTeX environment.
2217 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2218 the buffer position at the beginning of the first affiliated
2219 keyword and CDR is a plist of affiliated keywords along with
2220 their value.
2222 Return a list whose CAR is `latex-environment' and CDR is a plist
2223 containing `:begin', `:end', `:value', `:post-blank' and
2224 `:post-affiliated' keywords.
2226 Assume point is at the beginning of the latex environment."
2233 limit t))
2234 ;; Incomplete latex environment: parse it as a paragraph.
2244 :end end
2245 :value value
2251 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2255 ;;;; Node Property
2258 "Parse a node-property at point.
2260 LIMIT bounds the search.
2262 Return a list whose CAR is `node-property' and CDR is a plist
2263 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2264 `:post-affiliated' keywords."
2274 limit))))
2277 :value value
2278 :begin begin
2279 :end end
2284 "Interpret NODE-PROPERTY element as Org syntax."
2290 ;;;; Paragraph
2293 "Parse a paragraph.
2295 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2296 the buffer position at the beginning of the first affiliated
2297 keyword and CDR is a plist of affiliated keywords along with
2298 their value.
2300 Return a list whose CAR is `paragraph' and CDR is a plist
2301 containing `:begin', `:end', `:contents-begin' and
2302 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2304 Assume point is at the beginning of the paragraph."
2311 ;; A matching `org-element-paragraph-separate' is not
2312 ;; necessarily the end of the paragraph. In particular,
2313 ;; drawers, blocks or LaTeX environments opening lines
2314 ;; must be closed. Moreover keywords with a secondary
2315 ;; value must belong to "dual keywords".
2329 limit t)))
2335 limit t)))
2338 org-element-dual-keywords))
2339 ;; Everything else is unambiguous.
2352 :end end
2353 :contents-begin contents-begin
2354 :contents-end contents-end
2360 "Interpret paragraph element as Org syntax.
2361 CONTENTS is the contents of the element."
2362 contents)
2365 ;;;; Planning
2368 "Parse a planning.
2370 LIMIT bounds the search.
2372 Return a list whose CAR is `planning' and CDR is a plist
2373 containing `:closed', `:deadline', `:scheduled', `:begin',
2374 `:end', `:post-blank' and `:post-affiliated' keywords."
2384 closed deadline scheduled)
2396 :deadline deadline
2397 :scheduled scheduled
2398 :begin begin
2399 :end end
2400 :post-blank post-blank
2404 "Interpret PLANNING element as Org syntax."
2406 #'identity
2423 ;;;; Src Block
2426 "Parse a src block.
2428 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2429 the buffer position at the beginning of the first affiliated
2430 keyword and CDR is a plist of affiliated keywords along with
2431 their value.
2433 Return a list whose CAR is `src-block' and CDR is a plist
2434 containing `:language', `:switches', `:parameters', `:begin',
2435 `:end', `:number-lines', `:retain-labels', `:use-labels',
2436 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2437 `:post-affiliated' keywords.
2439 Assume point is at the beginning of the block."
2442 limit t)))
2443 ;; Incomplete block: parse it as a paragraph.
2449 ;; Get language as a string.
2458 ;; Get switches.
2460 ;; Get parameters.
2462 ;; Switches analysis.
2466 switches)
2469 'new
2472 ;; Subtract 1 to give number of lines before
2473 ;; first line.
2481 ;; Should labels be retained in (or stripped from)
2482 ;; src blocks?
2487 ;; What should code-references use - labels or
2488 ;; line-numbers?
2493 ;; Retrieve code.
2500 ;; Get position after ending blank lines.
2510 :begin begin
2511 :end end
2512 :number-lines number-lines
2513 :preserve-indent preserve-indent
2514 :retain-labels retain-labels
2515 :use-labels use-labels
2516 :label-fmt label-fmt
2517 :value value
2523 "Interpret SRC-BLOCK element as Org syntax."
2532 val)
2547 ;;;; Table
2550 "Parse a table at point.
2552 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2553 the buffer position at the beginning of the first affiliated
2554 keyword and CDR is a plist of affiliated keywords along with
2555 their value.
2557 Return a list whose CAR is `table' and CDR is a plist containing
2558 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2559 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2560 keywords.
2562 Assume point is at the beginning of the table."
2578 acc))
2585 :end end
2586 :type type
2587 :tblfm tblfm
2588 ;; Only `org' tables have contents. `table.el' tables
2589 ;; use a `:value' property to store raw table as
2590 ;; a string.
2595 table-begin table-end))
2601 "Interpret TABLE element as Org syntax.
2602 CONTENTS is a string, if table's type is `org', or nil."
2613 ;;;; Table Row
2616 "Parse table row at point.
2618 Return a list whose CAR is `table-row' and CDR is a plist
2619 containing `:begin', `:end', `:contents-begin', `:contents-end',
2620 `:type', `:post-blank' and `:post-affiliated' keywords."
2624 ;; A table rule has no contents. In that case, ensure
2625 ;; CONTENTS-BEGIN matches CONTENTS-END.
2635 :begin begin
2636 :end end
2637 :contents-begin contents-begin
2638 :contents-end contents-end
2643 "Interpret TABLE-ROW element as Org syntax.
2644 CONTENTS is the contents of the table row."
2649 ;;;; Verse Block
2652 "Parse a verse block.
2654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2655 the buffer position at the beginning of the first affiliated
2656 keyword and CDR is a plist of affiliated keywords along with
2657 their value.
2659 Return a list whose CAR is `verse-block' and CDR is a plist
2660 containing `:begin', `:end', `:contents-begin', `:contents-end',
2661 `:post-blank' and `:post-affiliated' keywords.
2663 Assume point is at beginning of the block."
2667 ;; Incomplete block: parse it as a paragraph.
2682 :end end
2683 :contents-begin contents-begin
2684 :contents-end contents-end
2690 "Interpret verse-block element as Org syntax.
2691 CONTENTS is verse block contents."
2695 \f
2696 ;;; Objects
2697 ;;
2698 ;; Unlike to elements, raw text can be found between objects. Hence,
2699 ;; `org-element--object-lex' is provided to find the next object in
2700 ;; buffer.
2701 ;;
2702 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2703 ;; object types they can contain will be specified in
2704 ;; `org-element-object-restrictions'.
2705 ;;
2706 ;; Creating a new type of object requires to alter
2707 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2708 ;; new type in `org-element-all-objects', and possibly add
2709 ;; restrictions in `org-element-object-restrictions'.
2711 ;;;; Bold
2714 "Parse bold object at point, if any.
2716 When at a bold object, return a list whose car is `bold' and cdr
2717 is a plist with `:begin', `:end', `:contents-begin' and
2718 `:contents-end' and `:post-blank' keywords. Otherwise, return
2719 nil.
2721 Assume point is at the first star marker."
2733 :end end
2734 :contents-begin contents-begin
2735 :contents-end contents-end
2739 "Interpret bold object as Org syntax.
2740 CONTENTS is the contents of the object."
2744 ;;;; Code
2747 "Parse code object at point, if any.
2749 When at a code object, return a list whose car is `code' and cdr
2750 is a plist with `:value', `:begin', `:end' and `:post-blank'
2751 keywords. Otherwise, return nil.
2753 Assume point is at the first tilde marker."
2764 :begin begin
2765 :end end
2769 "Interpret CODE object as Org syntax."
2773 ;;;; Entity
2776 "Parse entity at point, if any.
2778 When at an entity, return a list whose car is `entity' and cdr
2779 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2780 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2781 `:post-blank' as keywords. Otherwise, return nil.
2783 Assume point is at the beginning of the entity."
2785 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2803 :begin begin
2804 :end end
2805 :use-brackets-p bracketsp
2809 "Interpret ENTITY object as Org syntax."
2815 ;;;; Export Snippet
2818 "Parse export snippet at point.
2820 When at an export snippet, return a list whose car is
2821 `export-snippet' and cdr a plist with `:begin', `:end',
2822 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2823 return nil.
2825 Assume point is at the beginning of the snippet."
2841 :value value
2842 :begin begin
2843 :end end
2847 "Interpret EXPORT-SNIPPET object as Org syntax."
2853 ;;;; Footnote Reference
2856 "Parse footnote reference at point, if any.
2858 When at a footnote reference, return a list whose car is
2859 `footnote-reference' and cdr a plist with `:label', `:type',
2860 `:begin', `:end', `:content-begin', `:contents-end' and
2861 `:post-blank' as keywords. Otherwise, return nil."
2877 :type type
2878 :begin begin
2879 :end end
2885 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2886 CONTENTS is its definition, when inline, or nil."
2892 ;;;; Inline Babel Call
2895 "Parse inline babel call at point, if any.
2897 When at an inline babel call, return a list whose car is
2898 `inline-babel-call' and cdr a plist with `:call',
2899 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2900 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2902 Assume point is at the beginning of the babel call."
2916 ;; Parenthesis are mandatory.
2927 :inside-header inside-header
2928 :arguments arguments
2929 :end-header end-header
2930 :begin begin
2931 :end end
2932 :value value
2936 "Interpret INLINE-BABEL-CALL object as Org syntax."
2946 ;;;; Inline Src Block
2949 "Parse inline source block at point, if any.
2951 When at an inline source block, return a list whose car is
2952 `inline-src-block' and cdr a plist with `:begin', `:end',
2953 `:language', `:value', `:parameters' and `:post-blank' as
2954 keywords. Otherwise, return nil.
2956 Assume point is at the beginning of the inline src block."
2973 :value value
2974 :parameters parameters
2975 :begin begin
2980 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2985 language
2987 body)))
2989 ;;;; Italic
2992 "Parse italic object at point, if any.
2994 When at an italic object, return a list whose car is `italic' and
2995 cdr is a plist with `:begin', `:end', `:contents-begin' and
2996 `:contents-end' and `:post-blank' keywords. Otherwise, return
2997 nil.
2999 Assume point is at the first slash marker."
3011 :end end
3012 :contents-begin contents-begin
3013 :contents-end contents-end
3017 "Interpret italic object as Org syntax.
3018 CONTENTS is the contents of the object."
3022 ;;;; Latex Fragment
3025 "Parse LaTeX fragment at point, if any.
3027 When at a LaTeX fragment, return a list whose car is
3028 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3029 and `:post-blank' as keywords. Otherwise, return nil.
3031 Assume point is at the beginning of the LaTeX fragment."
3049 ;; Macro.
3059 :begin begin
3060 :end end
3064 "Interpret LATEX-FRAGMENT object as Org syntax."
3067 ;;;; Line Break
3070 "Parse line break at point, if any.
3072 When at a line break, return a list whose car is `line-break',
3073 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3074 Otherwise, return nil.
3076 Assume point is at the beginning of the line break."
3085 "Interpret LINE-BREAK object as Org syntax."
3089 ;;;; Link
3092 "Parse link at point, if any.
3094 When at a link, return a list whose car is `link' and cdr a plist
3095 with `:type', `:path', `:format', `:raw-link', `:application',
3096 `:search-option', `:begin', `:end', `:contents-begin',
3097 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3098 nil.
3100 Assume point is at the beginning of the link."
3103 end contents-begin contents-end link-end post-blank path type format
3104 raw-link search-option application)
3106 ;; Type 1: Text targeted from a radio target.
3116 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3122 ;; RAW-LINK is the original link. Expand any
3123 ;; abbreviation in it.
3124 ;;
3125 ;; Also treat any newline character and associated
3126 ;; indentation as a single space character. This is not
3127 ;; compatible with RFC 3986, which requires to ignore
3128 ;; them altogether. However, doing so would require
3129 ;; users to encode spaces on the fly when writing links
3130 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3131 ;; [[shell:ls *.org]], which defeats Org's focus on
3132 ;; simplicity.
3137 ;; Determine TYPE of link and set PATH accordingly. According
3138 ;; to RFC 3986, remove whitespaces from URI in external links.
3139 ;; In internal ones, treat indentation as a single space.
3141 ;; File type.
3146 ;; Explicit type (http, irc, bbdb...).
3150 ;; Code-ref type: PATH is the name of the reference.
3155 ;; Custom-id type: PATH is the name of the custom id.
3159 ;; Fuzzy type: Internal link either matches a target, an
3160 ;; headline name or nothing. PATH is the target or
3161 ;; headline's name.
3165 ;; Type 3: Plain link, e.g., http://orgmode.org
3172 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3173 ;; bracket links, follow RFC 3986 and remove any extra
3174 ;; whitespace in URI.
3185 ;; In any case, deduce end point after trailing white space from
3186 ;; LINK-END variable.
3191 ;; Special "file" type link processing. Extract opening
3192 ;; application and search option, if any. Also normalize URI.
3199 ;; Translate link, if `org-link-translation-function' is set.
3207 :path path
3208 :format format
3210 :application application
3211 :search-option search-option
3212 :begin begin
3213 :end end
3214 :contents-begin contents-begin
3215 :contents-end contents-end
3219 "Interpret LINK object as Org syntax.
3220 CONTENTS is the contents of the object, or nil."
3225 ;; Links with contents and internal links have to
3226 ;; use bracket syntax. Ignore `:format' in these
3227 ;; cases. This is also the default syntax when the
3228 ;; property is not defined, e.g., when the object
3229 ;; was crafted by the user.
3232 ;; Since this is going to be used as
3233 ;; a format string, escape percent signs
3234 ;; in description.
3237 `nil
3240 ;; Otherwise, just obey to `:format'.
3252 path
3258 ;;;; Macro
3261 "Parse macro at point, if any.
3263 When at a macro, return a list whose car is `macro' and cdr
3264 a plist with `:key', `:args', `:begin', `:end', `:value' and
3265 `:post-blank' as keywords. Otherwise, return nil.
3267 Assume point is at the macro."
3280 :value value
3281 :args args
3282 :begin begin
3283 :end end
3287 "Interpret MACRO object as Org syntax."
3291 ;;;; Radio-target
3294 "Parse radio target at point, if any.
3296 When at a radio target, return a list whose car is `radio-target'
3297 and cdr a plist with `:begin', `:end', `:contents-begin',
3298 `:contents-end', `:value' and `:post-blank' as keywords.
3299 Otherwise, return nil.
3301 Assume point is at the radio target."
3313 :end end
3314 :contents-begin contents-begin
3315 :contents-end contents-end
3316 :post-blank post-blank
3320 "Interpret target object as Org syntax.
3321 CONTENTS is the contents of the object."
3325 ;;;; Statistics Cookie
3328 "Parse statistics cookie at point, if any.
3330 When at a statistics cookie, return a list whose car is
3331 `statistics-cookie', and cdr a plist with `:begin', `:end',
3332 `:value' and `:post-blank' keywords. Otherwise, return nil.
3334 Assume point is at the beginning of the statistics-cookie."
3345 :end end
3346 :value value
3350 "Interpret STATISTICS-COOKIE object as Org syntax."
3354 ;;;; Strike-Through
3357 "Parse strike-through object at point, if any.
3359 When at a strike-through object, return a list whose car is
3360 `strike-through' and cdr is a plist with `:begin', `:end',
3361 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3362 Otherwise, return nil.
3364 Assume point is at the first plus sign marker."
3376 :end end
3377 :contents-begin contents-begin
3378 :contents-end contents-end
3382 "Interpret strike-through object as Org syntax.
3383 CONTENTS is the contents of the object."
3387 ;;;; Subscript
3390 "Parse subscript at point, if any.
3392 When at a subscript object, return a list whose car is
3393 `subscript' and cdr a plist with `:begin', `:end',
3394 `:contents-begin', `:contents-end', `:use-brackets-p' and
3395 `:post-blank' as keywords. Otherwise, return nil.
3397 Assume point is at the underscore."
3411 :end end
3412 :use-brackets-p bracketsp
3413 :contents-begin contents-begin
3414 :contents-end contents-end
3418 "Interpret SUBSCRIPT object as Org syntax.
3419 CONTENTS is the contents of the object."
3422 contents))
3425 ;;;; Superscript
3428 "Parse superscript at point, if any.
3430 When at a superscript object, return a list whose car is
3431 `superscript' and cdr a plist with `:begin', `:end',
3432 `:contents-begin', `:contents-end', `:use-brackets-p' and
3433 `:post-blank' as keywords. Otherwise, return nil.
3435 Assume point is at the caret."
3449 :end end
3450 :use-brackets-p bracketsp
3451 :contents-begin contents-begin
3452 :contents-end contents-end
3456 "Interpret SUPERSCRIPT object as Org syntax.
3457 CONTENTS is the contents of the object."
3460 contents))
3463 ;;;; Table Cell
3466 "Parse table cell at point.
3467 Return a list whose car is `table-cell' and cdr is a plist
3468 containing `:begin', `:end', `:contents-begin', `:contents-end'
3469 and `:post-blank' keywords."
3477 :end end
3478 :contents-begin contents-begin
3479 :contents-end contents-end
3483 "Interpret table-cell element as Org syntax.
3484 CONTENTS is the contents of the cell, or nil."
3488 ;;;; Target
3491 "Parse target at point, if any.
3493 When at a target, return a list whose car is `target' and cdr
3494 a plist with `:begin', `:end', `:value' and `:post-blank' as
3495 keywords. Otherwise, return nil.
3497 Assume point is at the target."
3507 :end end
3508 :value value
3512 "Interpret TARGET object as Org syntax."
3516 ;;;; Timestamp
3527 "Parse time stamp at point, if any.
3529 When at a time stamp, return a list whose car is `timestamp', and
3530 cdr a plist with `:type', `:raw-value', `:year-start',
3531 `:month-start', `:day-start', `:hour-start', `:minute-start',
3532 `:year-end', `:month-end', `:day-end', `:hour-end',
3533 `:minute-end', `:repeater-type', `:repeater-value',
3534 `:repeater-unit', `:warning-type', `:warning-value',
3535 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3536 Otherwise, return nil.
3538 Assume point is at the beginning of the timestamp."
3557 date-start)
3568 raw-value)
3570 :repeater-type
3576 :repeater-unit
3585 :warning-unit
3588 year-start month-start day-start hour-start minute-start year-end
3589 month-end day-end hour-end minute-end)
3590 ;; Parse date-start.
3598 ;; Compute date-end. It can be provided directly in time-stamp,
3599 ;; or extracted from time range. Otherwise, it defaults to the
3600 ;; same values as date-start.
3610 :raw-value raw-value
3611 :year-start year-start
3612 :month-start month-start
3613 :day-start day-start
3614 :hour-start hour-start
3615 :minute-start minute-start
3616 :year-end year-end
3617 :month-end month-end
3618 :day-end day-end
3619 :hour-end hour-end
3620 :minute-end minute-end
3621 :begin begin
3622 :end end
3624 repeater-props
3625 warning-props))))))
3628 "Interpret TIMESTAMP object as Org syntax."
3646 ;; Build an Org timestamp string from TIME. ACTIVEP is
3647 ;; non-nil when time stamp is active. If WITH-TIME-P is
3648 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3649 ;; specify a time range in the timestamp. REPEAT-STRING is
3650 ;; the repeater string, if any.
3654 org-time-stamp-formats)
3655 time)))
3661 nil nil ts)))
3666 " "
3667 s
3669 ;; Return value.
3670 ts)))
3682 build-ts-string
3701 0
3709 "--"
3722 ;;;; Underline
3725 "Parse underline object at point, if any.
3727 When at an underline object, return a list whose car is
3728 `underline' and cdr is a plist with `:begin', `:end',
3729 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3730 Otherwise, return nil.
3732 Assume point is at the first underscore marker."
3744 :end end
3745 :contents-begin contents-begin
3746 :contents-end contents-end
3750 "Interpret underline object as Org syntax.
3751 CONTENTS is the contents of the object."
3755 ;;;; Verbatim
3758 "Parse verbatim object at point, if any.
3760 When at a verbatim object, return a list whose car is `verbatim'
3761 and cdr is a plist with `:value', `:begin', `:end' and
3762 `:post-blank' keywords. Otherwise, return nil.
3764 Assume point is at the first equal sign marker."
3775 :begin begin
3776 :end end
3780 "Interpret VERBATIM object as Org syntax."
3784 \f
3785 ;;; Parsing Element Starting At Point
3786 ;;
3787 ;; `org-element--current-element' is the core function of this section.
3788 ;; It returns the Lisp representation of the element starting at
3789 ;; point.
3790 ;;
3791 ;; `org-element--current-element' makes use of special modes. They
3792 ;; are activated for fixed element chaining (e.g., `plain-list' >
3793 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3794 ;; `section'). Special modes are: `first-section', `item',
3795 ;; `node-property', `section' and `table-row'.
3798 "Parse the element starting at point.
3800 Return value is a list like (TYPE PROPS) where TYPE is the type
3801 of the element and PROPS a plist of properties associated to the
3802 element.
3804 Possible types are defined in `org-element-all-elements'.
3806 LIMIT bounds the search.
3808 Optional argument GRANULARITY determines the depth of the
3809 recursion. Allowed values are `headline', `greater-element',
3810 `element', `object' or nil. When it is broader than `object' (or
3811 nil), secondary values will not be parsed, since they only
3812 contain objects.
3814 Optional argument MODE, when non-nil, can be either
3815 `first-section', `section', `planning', `item', `node-property'
3816 and `table-row'.
3818 If STRUCTURE isn't provided but MODE is set to `item', it will be
3819 computed.
3821 This function assumes point is always at the beginning of the
3822 element it has to parse."
3825 ;; Determine if parsing depth allows for secondary strings
3826 ;; parsing. It only applies to elements referenced in
3827 ;; `org-element-secondary-value-alist'.
3830 ;; Item.
3833 ;; Table Row.
3835 ;; Node Property.
3837 ;; Headline.
3840 ;; Sections (must be checked after headline).
3845 limit)))
3846 ;; Planning.
3851 ;; Property drawer.
3857 ;; When not at bol, point is at the beginning of an item or
3858 ;; a footnote definition: next item is always a paragraph.
3860 ;; Clock.
3862 ;; Inlinetask.
3865 ;; From there, elements can have affiliated keywords.
3868 ;; Jumping over affiliated keywords put point off-limits.
3869 ;; Parse them as regular keywords.
3873 ;; LaTeX Environment.
3876 ;; Drawer and Property Drawer.
3879 ;; Fixed Width
3882 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3883 ;; Keywords.
3901 limit
3902 affiliated))
3915 ;; Footnote Definition.
3918 ;; Horizontal Rule.
3921 ;; Diary Sexp.
3924 ;; Table.
3927 ;; List.
3930 limit affiliated
3932 ;; Default element: Paragraph.
3936 ;; Most elements can have affiliated keywords. When looking for an
3937 ;; element beginning, we want to move before them, as they belong to
3938 ;; that element, and, in the meantime, collect information they give
3939 ;; into appropriate properties. Hence the following function.
3942 "Collect affiliated keywords from point down to LIMIT.
3944 Return a list whose CAR is the position at the first of them and
3945 CDR a plist of keywords and values and move point to the
3946 beginning of the first line after them.
3948 As a special case, if element doesn't start at the beginning of
3949 the line (e.g., a paragraph starting an item), CAR is current
3950 position of point and CDR is nil."
3954 ;; RESTRICT is the list of objects allowed in parsed
3955 ;; keywords value.
3957 output)
3960 ;; Apply translation to RAW-KWD. From there, KWD is
3961 ;; the official keyword.
3963 org-element-keyword-translation-alist))
3964 raw-kwd))
3965 ;; Find main value for any keyword.
3971 ;; PARSEDP is non-nil when keyword should have its
3972 ;; value parsed.
3974 ;; If KWD is a dual keyword, find its secondary
3975 ;; value. Maybe parse it.
3984 ;; Attribute a property name to KWD.
3986 ;; Now set final shape for VALUE.
3992 nil restrict)))
3996 ;; Attributes can always appear on multiple lines.
3999 ;; Eventually store the new value in OUTPUT.
4001 ;; Move to next keyword.
4003 ;; If affiliated keywords are orphaned: move back to first one.
4004 ;; They will be parsed as a paragraph.
4006 ;; Return value.
4010 \f
4011 ;;; The Org Parser
4012 ;;
4013 ;; The two major functions here are `org-element-parse-buffer', which
4014 ;; parses Org syntax inside the current buffer, taking into account
4015 ;; region, narrowing, or even visibility if specified, and
4016 ;; `org-element-parse-secondary-string', which parses objects within
4017 ;; a given string.
4018 ;;
4019 ;; The (almost) almighty `org-element-map' allows applying a function
4020 ;; on elements or objects matching some type, and accumulating the
4021 ;; resulting values. In an export situation, it also skips unneeded
4022 ;; parts of the parse tree.
4025 "Recursively parse the buffer and return structure.
4026 If narrowing is in effect, only parse the visible part of the
4027 buffer.
4029 Optional argument GRANULARITY determines the depth of the
4030 recursion. It can be set to the following symbols:
4032 `headline' Only parse headlines.
4033 `greater-element' Don't recurse into greater elements excepted
4034 headlines and sections. Thus, elements
4035 parsed are the top-level ones.
4036 `element' Parse everything but objects and plain text.
4037 `object' Parse the complete buffer (default).
4039 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4040 elements.
4042 An element or an objects is represented as a list with the
4043 pattern (TYPE PROPERTIES CONTENTS), where :
4045 TYPE is a symbol describing the element or object. See
4046 `org-element-all-elements' and `org-element-all-objects' for an
4047 exhaustive list of such symbols. One can retrieve it with
4048 `org-element-type' function.
4050 PROPERTIES is the list of attributes attached to the element or
4051 object, as a plist. Although most of them are specific to the
4052 element or object type, all types share `:begin', `:end',
4053 `:post-blank' and `:parent' properties, which respectively
4054 refer to buffer position where the element or object starts,
4055 ends, the number of white spaces or blank lines after it, and
4056 the element or object containing it. Properties values can be
4057 obtained by using `org-element-property' function.
4059 CONTENTS is a list of elements, objects or raw strings
4060 contained in the current element or object, when applicable.
4061 One can access them with `org-element-contents' function.
4063 The Org buffer has `org-data' as type and nil as properties.
4064 `org-element-map' function can be used to find specific elements
4065 or objects within the parse tree.
4067 This function assumes that current major mode is `org-mode'."
4073 ;; Start in `first-section' mode so text before the first
4074 ;; headline belongs to a section.
4078 "Recursively parse objects in STRING and return structure.
4080 RESTRICTION is a symbol limiting the object types that will be
4081 looked after.
4083 Optional argument PARENT, when non-nil, is the element or object
4084 containing the secondary string. It is used to set correctly
4085 `:parent' property within the string.
4087 If STRING is the empty string or nil, return nil."
4104 "Map a function on selected elements or objects.
4106 DATA is a parse tree, an element, an object, a string, or a list
4107 of such constructs. TYPES is a symbol or list of symbols of
4108 elements or objects types (see `org-element-all-elements' and
4109 `org-element-all-objects' for a complete list of types). FUN is
4110 the function called on the matching element or object. It has to
4111 accept one argument: the element or object itself.
4113 When optional argument INFO is non-nil, it should be a plist
4114 holding export options. In that case, parts of the parse tree
4115 not exportable according to that property list will be skipped.
4117 When optional argument FIRST-MATCH is non-nil, stop at the first
4118 match for which FUN doesn't return nil, and return that value.
4120 Optional argument NO-RECURSION is a symbol or a list of symbols
4121 representing elements or objects types. `org-element-map' won't
4122 enter any recursive element or object whose type belongs to that
4123 list. Though, FUN can still be applied on them.
4125 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4126 apply to matching objects within parsed affiliated keywords (see
4127 `org-element-parsed-keywords').
4129 Nil values returned from FUN do not appear in the results.
4132 Examples:
4133 ---------
4135 Assuming TREE is a variable containing an Org buffer parse tree,
4136 the following example will return a flat list of all `src-block'
4137 and `example-block' elements in it:
4141 The following snippet will find the first headline with a level
4145 (lambda (hl)
4146 (and (= (org-element-property :level hl) 1)
4148 (org-element-property :begin hl)))
4149 nil t)
4151 The next example will return a flat list of all `plain-list' type
4152 elements in TREE that are not a sub-list themselves:
4156 Eventually, this example will return a flat list of all `bold'
4157 type objects containing a `latex-snippet' type object, even
4158 looking into captions:
4161 (lambda (b)
4163 nil nil nil t)"
4164 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4168 ;; Recursion depth is determined by --CATEGORY.
4175 ;; If one object is found, the function has
4176 ;; to recurse into every object.
4179 ;; If one regular element is found, the
4180 ;; function has to recurse, at least, into
4181 ;; every element it encounters.
4184 --acc)
4187 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4188 ;; holding contextual information.
4192 ;; Ignored element in an export context.
4194 ;; List of elements or objects.
4196 ;; Unconditionally enter parse trees.
4200 ;; Check if TYPE is matching among TYPES. If so,
4201 ;; apply FUN to --DATA and accumulate return value
4202 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4208 ;; If --DATA has a secondary string that can contain
4209 ;; objects with their type among TYPES, look inside.
4212 org-element-secondary-value-alist)))
4214 ;; If --DATA has any parsed affiliated keywords and
4215 ;; WITH-AFFILIATED is non-nil, look for objects in
4216 ;; them.
4223 ;; Pay attention to the type of parsed
4224 ;; keyword. In particular, preserve order for
4225 ;; multiple keywords.
4238 ;; Determine if a recursion into --DATA is possible.
4240 ;; --TYPE is explicitly removed from recursion.
4242 ;; --DATA has no contents.
4244 ;; Looking for greater elements but --DATA is
4245 ;; simply an element or an object.
4248 ;; Looking for elements but --DATA is an object.
4251 ;; In any other case, map contents.
4255 ;; Return value in a proper order.
4259 ;; The following functions are internal parts of the parser.
4260 ;;
4261 ;; The first one, `org-element--parse-elements' acts at the element's
4262 ;; level.
4263 ;;
4264 ;; The second one, `org-element--parse-objects' applies on all objects
4265 ;; of a paragraph or a secondary string. It calls
4266 ;; `org-element--object-lex' to find the next object in the current
4267 ;; container.
4270 "Return next special mode according to TYPE, or nil.
4271 TYPE is a symbol representing the type of an element or object
4272 containing next element if PARENTP is non-nil, or before it
4273 otherwise. Modes can be either `first-section', `item',
4274 `node-property', `planning', `property-drawer', `section',
4275 `table-row' or nil."
4292 "Parse elements between BEG and END positions.
4294 MODE prioritizes some elements over the others. It can be set to
4295 `first-section', `section', `planning', `item', `node-property'
4296 or `table-row'.
4298 When value is `item', STRUCTURE will be used as the current list
4299 structure.
4301 GRANULARITY determines the depth of the recursion. See
4302 `org-element-parse-buffer' for more information.
4304 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4305 elements.
4307 Elements are accumulated into ACC."
4310 ;; Visible only: skip invisible parts at the beginning of the
4311 ;; element.
4314 ;; When parsing only headlines, skip any text before first one.
4319 ;; Find current element's type and parse it accordingly to
4320 ;; its category.
4322 end granularity mode structure))
4326 ;; Visible only: skip invisible parts between siblings.
4329 ;; Fill ELEMENT contents by side-effect.
4331 ;; If element has no contents, don't modify it.
4333 ;; Greater element: parse it between `contents-begin' and
4334 ;; `contents-end'. Make sure GRANULARITY allows the
4335 ;; recursion, or ELEMENT is a headline, in which case going
4336 ;; inside is mandatory, in order to get sub-level headings.
4344 ;; Possibly switch to a special mode.
4348 granularity visible-only element))
4349 ;; ELEMENT has contents. Parse objects inside, if
4350 ;; GRANULARITY allows it.
4356 ;; Update mode.
4358 ;; Return result.
4362 "Return next object in current buffer or nil.
4363 RESTRICTION is a list of object types, as symbols, that should be
4364 looked after. This function assumes that the buffer is narrowed
4365 to an appropriate container (e.g., a paragraph)."
4369 ;; Object regexp sometimes needs to have a peek at
4370 ;; a character ahead. Therefore, when there is a hard
4371 ;; limit, make it one more than the true beginning of the
4372 ;; radio target.
4379 nil)
4380 ;; Since we moved backward, we do not want to
4381 ;; match again an hypothetical 1-character long
4382 ;; radio link before us. Realizing that this can
4383 ;; only happen if such a radio link starts at
4384 ;; beginning of line, we prevent this here.
4390 found)
4457 ;; This is probably a plain link.
4468 "Parse objects between BEG and END and return recursive structure.
4470 Objects are accumulated in ACC. RESTRICTION is a list of object
4471 successors which are allowed in the current object.
4473 ACC becomes the parent for all parsed objects. However, if ACC
4474 is nil (i.e., a secondary string is being parsed) and optional
4475 argument PARENT is non-nil, use it as the parent for all objects.
4476 Eventually, if both ACC and PARENT are nil, the common parent is
4477 the list of objects itself."
4485 ;; Text before any object.
4490 contents))))
4491 ;; Object...
4496 ;; Fill contents of NEXT-OBJECT if possible.
4498 cont-beg
4500 next-object
4502 next-object)
4503 contents)
4505 ;; Text after last object.
4509 contents)))
4510 ;; Result. Set appropriate parent.
4518 \f
4519 ;;; Towards A Bijective Process
4520 ;;
4521 ;; The parse tree obtained with `org-element-parse-buffer' is really
4522 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4523 ;; interpreted and expanded into a string with canonical Org syntax.
4524 ;; Hence `org-element-interpret-data'.
4525 ;;
4526 ;; The function relies internally on
4527 ;; `org-element--interpret-affiliated-keywords'.
4529 ;;;###autoload
4531 "Interpret DATA as Org syntax.
4532 DATA is a parse tree, an element, an object or a secondary string
4533 to interpret. Return Org syntax as a string."
4537 ;; Find interpreter for current object or
4538 ;; element. If it doesn't exist (e.g. this is
4539 ;; a pseudo object or element), return contents,
4540 ;; if any.
4547 ;; Secondary string.
4550 data
4552 ;; Full Org document.
4557 ;; Plain text: return it.
4559 ;; Element or object without contents.
4562 ;; Element or object with contents.
4565 interpret
4566 data
4567 ;; Recursively interpret contents.
4572 data
4573 ;; Fix indentation of elements containing
4574 ;; objects. We ignore `table-row'
4575 ;; elements as they are one line long
4576 ;; anyway.
4578 data
4579 ;; When normalizing first paragraph of
4580 ;; an item or a footnote-definition,
4581 ;; ignore first line's indentation.
4589 ;; Build white spaces. If no `:post-blank' property
4590 ;; is specified, assume its value is 0.
4600 "Return ELEMENT's affiliated keywords as Org syntax.
4601 If there is no affiliated keyword, return the empty string."
4611 ": "
4614 value)
4622 ;; All attribute keywords can have multiple lines.
4628 ;; List all ELEMENT's properties matching an attribute line or an
4629 ;; affiliated keyword, but ignore translated keywords since they
4630 ;; cannot belong to the property list.
4637 org-element-keyword-translation-alist)))))
4638 collect prop)
4641 ;; Because interpretation of the parse tree must return the same
4642 ;; number of blank lines between elements and the same number of white
4643 ;; space after objects, some special care must be given to white
4644 ;; spaces.
4645 ;;
4646 ;; The first function, `org-element-normalize-string', ensures any
4647 ;; string different from the empty string will end with a single
4648 ;; newline character.
4649 ;;
4650 ;; The second function, `org-element-normalize-contents', removes
4651 ;; global indentation from the contents of the current element.
4654 "Ensure string S ends with a single newline character.
4656 If S isn't a string return it unchanged. If S is the empty
4657 string, return it. Otherwise, return a new string with a single
4658 newline character at its end."
4666 "Normalize plain text in ELEMENT's contents.
4668 ELEMENT must only contain plain text and objects.
4670 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4671 indentation to compute maximal common indentation.
4673 Return the normalized element that is element with global
4674 indentation removed from its contents."
4676 ;; Return minimal common indentation within BLOB. This is
4677 ;; done by walking recursively BLOB and updating MIN-IND
4678 ;; along the way. FIRST-FLAG is non-nil when the next
4679 ;; object is expected to be a string that doesn't start
4680 ;; with a newline character. It happens for strings at
4681 ;; the beginnings of the contents or right after a line
4682 ;; break.
4688 ;; Objects cannot start with spaces: in this
4689 ;; case, indentation is 0.
4730 ;; Build ELEMENT back, replacing each string with the same
4731 ;; string minus common indentation.
4734 ;; Return DATUM with all its strings indentation
4735 ;; shortened from MIN-IND white spaces.
4755 org-element-recursive-objects)
4759 datum)))
4763 \f
4764 ;;; Cache
4765 ;;
4766 ;; Implement a caching mechanism for `org-element-at-point' and
4767 ;; `org-element-context', which see.
4768 ;;
4769 ;; A single public function is provided: `org-element-cache-reset'.
4770 ;;
4771 ;; Cache is enabled by default, but can be disabled globally with
4772 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4773 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4774 ;; can be tweaked to control caching behaviour.
4775 ;;
4776 ;; Internally, parsed elements are stored in an AVL tree,
4777 ;; `org-element--cache'. This tree is updated lazily: whenever
4778 ;; a change happens to the buffer, a synchronization request is
4779 ;; registered in `org-element--cache-sync-requests' (see
4780 ;; `org-element--cache-submit-request'). During idle time, requests
4781 ;; are processed by `org-element--cache-sync'. Synchronization also
4782 ;; happens when an element is required from the cache. In this case,
4783 ;; the process stops as soon as the needed element is up-to-date.
4784 ;;
4785 ;; A synchronization request can only apply on a synchronized part of
4786 ;; the cache. Therefore, the cache is updated at least to the
4787 ;; location where the new request applies. Thus, requests are ordered
4788 ;; from left to right and all elements starting before the first
4789 ;; request are correct. This property is used by functions like
4790 ;; `org-element--cache-find' to retrieve elements in the part of the
4791 ;; cache that can be trusted.
4792 ;;
4793 ;; A request applies to every element, starting from its original
4794 ;; location (or key, see below). When a request is processed, it
4795 ;; moves forward and may collide the next one. In this case, both
4796 ;; requests are merged into a new one that starts from that element.
4797 ;; As a consequence, the whole synchronization complexity does not
4798 ;; depend on the number of pending requests, but on the number of
4799 ;; elements the very first request will be applied on.
4800 ;;
4801 ;; Elements cannot be accessed through their beginning position, which
4802 ;; may or may not be up-to-date. Instead, each element in the tree is
4803 ;; associated to a key, obtained with `org-element--cache-key'. This
4804 ;; mechanism is robust enough to preserve total order among elements
4805 ;; even when the tree is only partially synchronized.
4806 ;;
4807 ;; Objects contained in an element are stored in a hash table,
4808 ;; `org-element--cache-objects'.
4812 "Non-nil when Org parser should cache its results.
4814 WARNING: for the time being, using cache sometimes triggers
4815 freezes. Therefore, it is disabled by default. Activate it if
4822 "Maximum duration, as a time value, for a cache synchronization.
4823 If the synchronization is not over after this delay, the process
4824 pauses and resumes after `org-element-cache-sync-break'
4828 "Duration, as a time value, of the pause between synchronizations.
4832 ;;;; Data Structure
4835 "AVL tree used to cache elements.
4836 Each node of the tree contains an element. Comparison is done
4837 with `org-element--cache-compare'. This cache is used in
4841 "Hash table used as to cache objects.
4842 Key is an element, as returned by `org-element-at-point', and
4843 value is an alist where each association is:
4845 (PARENT COMPLETEP . OBJECTS)
4847 where PARENT is an element or object, COMPLETEP is a boolean,
4848 non-nil when all direct children of parent are already cached and
4849 OBJECTS is a list of such children, as objects, from farthest to
4850 closest.
4853 contained within a paragraph
4857 If the paragraph is completely parsed, OBJECTS-DATA will be
4859 ((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4860 (BOLD-OBJECT t ENTITY-OBJECT))
4862 whereas in a partially parsed paragraph, it could be
4864 ((PARAGRAPH nil ENTITY-OBJECT))
4869 "List of pending synchronization requests.
4871 A request is a vector with the following pattern:
4873 \[NEXT BEG END OFFSET PARENT PHASE]
4875 Processing a synchronization request consists of three phases:
4877 0. Delete modified elements,
4878 1. Fill missing area in cache,
4879 2. Shift positions and re-parent elements after the changes.
4881 During phase 0, NEXT is the key of the first element to be
4882 removed, BEG and END is buffer position delimiting the
4883 modifications. Elements starting between them (inclusive) are
4884 removed. So are elements whose parent is removed. PARENT, when
4885 non-nil, is the parent of the first element to be removed.
4887 During phase 1, NEXT is the key of the next known element in
4888 cache and BEG its beginning position. Parse buffer between that
4889 element and the one before it in order to determine the parent of
4890 the next element. Set PARENT to the element containing NEXT.
4892 During phase 2, NEXT is the key of the next element to shift in
4893 the parse tree. All elements starting from this one have their
4894 properties relatives to buffer positions shifted by integer
4895 OFFSET and, if they belong to element PARENT, are adopted by it.
4903 "Hash table used to store keys during synchronization.
4907 "Return a unique key for ELEMENT in cache tree.
4909 Keys are used to keep a total order among elements in the cache.
4910 Comparison is done with `org-element--cache-key-less-p'.
4912 When no synchronization is taking place, a key is simply the
4913 beginning position of the element, or that position plus one in
4914 the case of an first item (respectively row) in
4915 a list (respectively a table).
4917 During a synchronization, the key is the one the element had when
4918 the cache was synchronized for the last time. Elements added to
4919 cache during the synchronization get a new key generated with
4920 `org-element--cache-generate-key'.
4922 Such keys are stored in `org-element--cache-sync-keys'. The hash
4923 table is cleared once the synchronization is complete."
4926 ;; Increase beginning position of items (respectively
4927 ;; table rows) by one, so the first item can get
4928 ;; a different key from its parent list (respectively
4929 ;; table).
4932 begin)))
4935 key))))
4938 "Generate a key between LOWER and UPPER.
4940 LOWER and UPPER are integers or lists, possibly empty.
4942 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4943 a unique key, as an integer or a list of integers, according to
4944 the following rules:
4946 - LOWER and UPPER are compared level-wise until values differ.
4948 - If, at a given level, LOWER and UPPER differ from more than
4949 2, the new key shares all the levels above with LOWER and
4950 gets a new level. Its value is the mean between LOWER and
4951 UPPER:
4953 (1 2) + (1 4) --> (1 3)
4955 - If LOWER has no value to compare with, it is assumed that its
4956 value is `most-negative-fixnum'. E.g.,
4958 (1 1) + (1 1 2)
4960 is equivalent to
4962 (1 1 m) + (1 1 2)
4964 where m is `most-negative-fixnum'. Likewise, if UPPER is
4965 short of levels, the current value is `most-positive-fixnum'.
4967 - If they differ from only one, the new key inherits from
4968 current LOWER level and fork it at the next level. E.g.,
4970 (2 1) + (3 3)
4972 is equivalent to
4974 (2 1) + (2 M)
4976 where M is `most-positive-fixnum'.
4978 - If the key is only one level long, it is returned as an
4979 integer:
4981 (1 2) + (3 2) --> 2
4983 When they are not equals, the function assumes that LOWER is
4984 lesser than UPPER, per `org-element--cache-key-less-p'."
4988 skip-upper key)
4999 ;; When at a given level, LOWER and UPPER differ from
5000 ;; 1, ignore UPPER altogether. Instead create a key
5001 ;; between LOWER and the greatest key with the same
5002 ;; prefix as LOWER so far.
5008 "Non-nil if key A is less than key B.
5009 A and B are either integers or lists of integers, as returned by
5010 `org-element--cache-key'."
5018 ;; If A is empty, either keys are equal (B is also empty) and
5019 ;; we return nil, or A is lesser than B (B is longer) and we
5020 ;; return a non-nil value.
5021 ;;
5022 ;; If A is not empty, B is necessarily empty and A is greater
5023 ;; than B (A is longer). Therefore, return nil.
5027 "Non-nil when element A is located before element B."
5032 "Return root value in cache.
5033 This function assumes `org-element--cache' is a valid AVL tree."
5037 ;;;; Tools
5040 "Non-nil when cache is active in current buffer."
5042 org-element--cache
5046 "Find element in cache starting at POS or before.
5048 POS refers to a buffer position.
5050 When optional argument SIDE is non-nil, the function checks for
5051 elements starting at or past POS instead. If SIDE is `both', the
5052 function returns a cons cell where car is the first element
5053 starting at or before POS and cdr the first element starting
5054 after POS.
5056 The function can only find elements in the synchronized part of
5057 the cache."
5061 lower upper)
5076 ;; We found an element in cache starting at POS. If `side'
5077 ;; is `both' we also want the next one in order to generate
5078 ;; a key in-between.
5079 ;;
5080 ;; If the element is the first row or item in a table or
5081 ;; a plain list, we always return the table or the plain
5082 ;; list.
5083 ;;
5084 ;; In any other case, we return the element found.
5093 lower parent
5094 upper parent)))))
5097 lower element
5098 upper element)))))
5105 "Store ELEMENT in current buffer's cache, if allowed.
5106 When optional argument DATA is non-nil, assume is it object data
5107 relative to ELEMENT and store it in the objects cache."
5111 ;; During synchronization, first build an appropriate key
5112 ;; for the new element so `avl-tree-enter' can insert it at
5113 ;; the right spot in the cache.
5122 org-element--cache-sync-keys)))
5124 ;; Headlines are not stored in cache, so objects in titles are
5125 ;; not stored either.
5130 "Remove ELEMENT from cache.
5131 Assume ELEMENT belongs to cache and that a cache is active."
5136 ;;;; Synchronization
5139 "Set idle timer for cache synchronization in BUFFER."
5146 org-element-cache-sync-idle-time))
5147 nil
5148 #'org-element--cache-sync
5149 buffer)))
5152 "Non-nil when synchronization process should be interrupted.
5153 TIME-LIMIT is a time value or nil."
5159 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5161 Properties containing buffer positions are `:begin', `:end',
5162 `:contents-begin', `:contents-end' and `:structure'. When
5163 optional argument PROPS is a list of keywords, only shift
5164 properties provided in that list.
5166 Properties are modified by side-effect."
5168 ;; Shift `:structure' property for the first plain list only: it
5169 ;; is the only one that really matters and it prevents from
5170 ;; shifting it more than once.
5184 "Synchronize cache with recent modification in BUFFER.
5186 When optional argument THRESHOLD is non-nil, do the
5187 synchronization for all elements starting before or at threshold,
5188 then exit. Otherwise, synchronize cache for as long as
5189 `org-element-cache-sync-duration' or until Emacs leaves idle
5190 state.
5192 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5193 not registered yet in the cache are going to happen. It is used
5194 in `org-element--cache-submit-request', where cache is partially
5195 updated before current modification are actually submitted."
5206 request
5208 threshold
5211 org-element-cache-sync-duration))
5212 future-change)
5213 ;; Request processed. Merge current and next offsets and
5214 ;; transfer ending position.
5220 ;; If more requests are awaiting, set idle timer accordingly.
5221 ;; Otherwise, reset keys.
5228 "Process synchronization REQUEST for all entries before NEXT.
5230 REQUEST is a vector, built by `org-element--cache-submit-request'.
5232 NEXT is a cache key, as returned by `org-element--cache-key'.
5234 When non-nil, THRESHOLD is a buffer position. Synchronization
5235 stops as soon as a shifted element begins after it.
5237 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5238 after this time or when Emacs exits idle state.
5240 When non-nil, FUTURE-CHANGE is a buffer position where changes
5241 not registered yet in the cache are going to happen. See
5242 `org-element--cache-submit-request' for more information.
5244 Throw `interrupt' if the process stops before completing the
5245 request."
5248 ;; Phase 0.
5249 ;;
5250 ;; Delete all elements starting after BEG, but not after buffer
5251 ;; position END or past element with key NEXT. Also delete
5252 ;; elements contained within a previously removed element
5253 ;; (stored in `last-container').
5254 ;;
5255 ;; At each iteration, we start again at tree root since
5256 ;; a deletion modifies structure of the balanced tree.
5261 ;; Find first element in cache with key BEG or after it.
5265 data data-key last-container)
5274 data-key key
5277 data-key key
5278 node nil)))))
5288 up)))
5291 end))
5298 ;; No element starting after modifications left in
5299 ;; cache: further processing is futile.
5302 ;; Phase 1.
5303 ;;
5304 ;; Phase 0 left a hole in the cache. Some elements after it
5305 ;; could have parents within. For example, in the following
5306 ;; buffer:
5307 ;;
5308 ;; - item
5309 ;;
5310 ;;
5311 ;; Paragraph1
5312 ;;
5313 ;; Paragraph2
5314 ;;
5315 ;; if we remove a blank line between "item" and "Paragraph1",
5316 ;; everything down to "Paragraph2" is removed from cache. But
5317 ;; the paragraph now belongs to the list, and its `:parent'
5318 ;; property no longer is accurate.
5319 ;;
5320 ;; Therefore we need to parse again elements in the hole, or at
5321 ;; least in its last section, so that we can re-parent
5322 ;; subsequent elements, during phase 2.
5323 ;;
5324 ;; Note that we only need to get the parent from the first
5325 ;; element in cache after the hole.
5326 ;;
5327 ;; When next key is lesser or equal to the current one, delegate
5328 ;; phase 1 processing to next request in order to preserve key
5329 ;; order among requests.
5337 ;; Next element will start at its beginning position plus
5338 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5339 ;; contains the real beginning position of the first element to
5340 ;; shift and re-parent.
5344 ;; Changes are going to happen around this element and
5345 ;; they will trigger another phase 1 request. Skip the
5346 ;; current one.
5352 ;; Phase 2.
5353 ;;
5354 ;; Shift all elements starting from key START, but before NEXT, by
5355 ;; OFFSET, and re-parent them when appropriate.
5356 ;;
5357 ;; Elements are modified by side-effect so the tree structure
5358 ;; remains intact.
5359 ;;
5360 ;; Once THRESHOLD, if any, is reached, or once there is an input
5361 ;; pending, exit. Before leaving, the current synchronization
5362 ;; request is updated.
5369 exit-flag)
5370 ;; No re-parenting nor shifting planned: request is over.
5380 ;; We reached NEXT. Request is complete.
5382 ;; Handle interruption request. Update current request.
5387 ;; Shift element.
5390 ;; Shift associated objects data, if any.
5395 ;; Update PARENT and re-parent DATA, only when
5396 ;; necessary. Propagate new structures for lists.
5410 ;; Cache is up-to-date past THRESHOLD. Request
5411 ;; interruption.
5416 ;; We reached end of tree: synchronization complete.
5417 t)))
5420 "Parse elements in current section, down to POS.
5422 Start parsing from the closest between the last known element in
5423 cache or headline above. Return the smallest element containing
5424 POS.
5426 When optional argument SYNCP is non-nil, return the parent of the
5427 element containing POS instead. In that case, it is also
5428 possible to provide TIME-LIMIT, which is a time value specifying
5429 when the parsing should stop. The function throws `interrupt' if
5430 the process stopped before finding the expected result."
5437 element next mode)
5439 ;; Nothing in cache before point: start parsing from first
5440 ;; element following headline above, or first element in
5441 ;; buffer.
5448 ;; Cache returned exact match: return it.
5451 ;; There's a headline between cached value and POS: cached
5452 ;; value is invalid. Start parsing from first element
5453 ;; following the headline.
5460 ;; Check if CACHED or any of its ancestors contain point.
5461 ;;
5462 ;; If there is such an element, we inspect it in order to know
5463 ;; if we return it or if we need to parse its contents.
5464 ;; Otherwise, we just start parsing from current location,
5465 ;; which is right after the top-most element containing
5466 ;; CACHED.
5467 ;;
5468 ;; As a special case, if POS is at the end of the buffer, we
5469 ;; want to return the innermost element ending there.
5470 ;;
5471 ;; Also, if we find an ancestor and discover that we need to
5472 ;; parse its contents, make sure we don't start from
5473 ;; `:contents-begin', as we would otherwise go past CACHED
5474 ;; again. Instead, in that situation, we will resume parsing
5475 ;; from NEXT, which is located after CACHED or its higher
5476 ;; ancestor not containing point.
5488 ;; Parse successively each element until we reach POS.
5501 end 'element mode
5508 ;; Skip any element ending before point. Also skip
5509 ;; element ending at point (unless it is also the end of
5510 ;; buffer) since we're sure that another element begins
5511 ;; after it.
5515 ;; A non-greater element contains point: return it.
5518 ;; Otherwise, we have to decide if ELEMENT really
5519 ;; contains POS. In that case we start parsing from
5520 ;; contents' beginning.
5521 ;;
5522 ;; If POS is at contents' beginning but it is also at
5523 ;; the beginning of the first item in a list or a table.
5524 ;; In that case, we need to create an anchor for that
5525 ;; list or table, so return it.
5526 ;;
5527 ;; Also, if POS is at the end of the buffer, no element
5528 ;; can start after it, but more than one may end there.
5529 ;; Arbitrarily, we choose to return the innermost of
5530 ;; such elements.
5543 parent element
5544 end cend))))
5545 ;; Otherwise, return ELEMENT as it is the smallest
5546 ;; element containing POS.
5551 ;;;; Staging Buffer Changes
5562 "Regexp matching a sensitive line, structure wise.
5563 A sensitive line is a headline, inlinetask, block, drawer, or
5564 latex-environment boundary. When such a line is modified,
5565 structure changes in the document may propagate in the whole
5569 "Non-nil when a sensitive line is about to be changed.
5573 "Request extension of area going to be modified if needed.
5574 BEG and END are the beginning and end of the range of changed
5575 text. See `before-change-functions' for more information."
5585 'headline
5588 org-element--cache-sensitive-re bottom t)))))))))
5591 "Update buffer modifications for current buffer.
5592 BEG and END are the beginning and end of the range of changed
5593 text, and the length in bytes of the pre-change text replaced by
5594 that range. See `after-change-functions' for more information."
5602 ;; Determine if modified area needs to be extended, according
5603 ;; to both previous and current state. We make a special
5604 ;; case for headline editing: if a headline is modified but
5605 ;; not removed, do not extend.
5608 (`headline
5614 org-element--cache-sensitive-re bottom t))))
5615 ;; Effectively extend modified area.
5623 ;; Store synchronization request.
5626 ;; Activate a timer to process the request during idle time.
5630 "Return first element to remove from cache.
5632 BEG and END are buffer positions delimiting buffer modifications.
5633 OFFSET is the size of the changes.
5635 Returned element is usually the first element in cache containing
5636 any position between BEG and END. As an exception, greater
5637 elements around the changes that are robust to contents
5638 modifications are preserved and updated according to the
5639 changes."
5649 special-block))
5650 ;; Drawers named "PROPERTIES" are probably
5651 ;; a properties drawer being edited. Force
5652 ;; parsing to check if editing is over.
5661 ;; UP is a robust greater element containing changes.
5662 ;; We only need to extend its ending boundaries.
5668 ;; We're at top level element containing ELEMENT: if it's
5669 ;; altered by buffer modifications, it is first element in
5670 ;; cache to be removed. Otherwise, that first element is the
5671 ;; following one.
5672 ;;
5673 ;; As a special case, do not remove BEFORE if it is a robust
5674 ;; container for current changes.
5676 before)))))
5679 "Submit a new cache synchronization request for current buffer.
5680 BEG and END are buffer positions delimiting the minimal area
5681 where cache data should be removed. OFFSET is the size of the
5682 change, as an integer."
5684 delete-to delete-from)
5689 ;; Current changes can be merged with first sync request: we
5690 ;; can save a partial cache synchronization.
5693 ;; If last change happened within area to be removed, extend
5694 ;; boundaries of robust parents, if any. Otherwise, find
5695 ;; first element to remove and update request accordingly.
5707 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5708 ;; if any, is no longer a 0-phase request, thus ensuring that
5709 ;; phases are properly ordered. We need to provide OFFSET as
5710 ;; optional parameter since current modifications are not known
5711 ;; yet to the otherwise correct part of the cache (i.e, before
5712 ;; the first request).
5719 ;; When changes happen before the first known
5720 ;; element, re-parent and shift the rest of the
5721 ;; cache.
5723 ;; Otherwise, we find the first non robust
5724 ;; element containing END. All elements between
5725 ;; FIRST and this one are to be removed.
5736 element up))
5738 org-element--cache-sync-requests)
5739 ;; No element to remove. No need to re-parent either.
5740 ;; Simply shift additional elements, if any, by OFFSET.
5743 offset)))))))
5746 ;;;; Public Functions
5748 ;;;###autoload
5750 "Reset cache in current buffer.
5751 When optional argument ALL is non-nil, reset cache in all Org
5752 buffers."
5770 ;;;###autoload
5772 "Refresh cache at position POS."
5779 \f
5780 ;;; The Toolbox
5781 ;;
5782 ;; The first move is to implement a way to obtain the smallest element
5783 ;; containing point. This is the job of `org-element-at-point'. It
5784 ;; basically jumps back to the beginning of section containing point
5785 ;; and proceed, one element after the other, with
5786 ;; `org-element--current-element' until the container is found. Note:
5787 ;; When using `org-element-at-point', secondary values are never
5788 ;; parsed since the function focuses on elements, not on objects.
5789 ;;
5790 ;; At a deeper level, `org-element-context' lists all elements and
5791 ;; objects containing point.
5792 ;;
5793 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5794 ;; internally by navigation and manipulation tools.
5797 ;;;###autoload
5799 "Determine closest element around point.
5801 Return value is a list like (TYPE PROPS) where TYPE is the type
5802 of the element and PROPS a plist of properties associated to the
5803 element.
5805 Possible types are defined in `org-element-all-elements'.
5806 Properties depend on element or object type, but always include
5807 `:begin', `:end', `:parent' and `:post-blank' properties.
5809 As a special case, if point is at the very beginning of the first
5810 item in a list or sub-list, returned element will be that list
5811 instead of the item. Likewise, if point is at the beginning of
5812 the first row of a table, returned element will be the table
5813 instead of the first row.
5815 When point is at the end of the buffer, return the innermost
5816 element ending there."
5822 ;; Within blank lines at the beginning of buffer, return nil.
5824 ;; Within blank lines right after a headline, return that
5825 ;; headline.
5829 ;; Otherwise parse until we find element containing ORIGIN.
5836 ;;;###autoload
5838 "Return smallest element or object around point.
5840 Return value is a list like (TYPE PROPS) where TYPE is the type
5841 of the element or object and PROPS a plist of properties
5842 associated to it.
5844 Possible types are defined in `org-element-all-elements' and
5845 `org-element-all-objects'. Properties depend on element or
5846 object type, but always include `:begin', `:end', `:parent' and
5847 `:post-blank'.
5849 As a special case, if point is right after an object and not at
5850 the beginning of any other object, return that object.
5852 Optional argument ELEMENT, when non-nil, is the closest element
5853 containing point, as returned by `org-element-at-point'.
5854 Providing it allows for quicker computation."
5861 ;; If point is inside an element containing objects or
5862 ;; a secondary string, narrow buffer to the container and
5863 ;; proceed with parsing. Otherwise, return ELEMENT.
5865 ;; At a parsed affiliated keyword, check if we're inside main
5866 ;; or dual value.
5872 org-element-parsed-keywords))
5881 ;; Also change type to retrieve correct restrictions.
5883 ;; At an item, objects can only be located within tag, if any.
5894 ;; At an headline or inlinetask, objects are in title.
5906 ;; At a paragraph, a table-row or a verse block, objects are
5907 ;; located within their contents.
5911 ;; CBEG is nil for table rules.
5916 ;; At a planning line, if point is at a timestamp, return it,
5917 ;; otherwise, return element.
5925 ;; All other locations cannot contain objects: bail out.
5935 next object-data last)
5939 ;; When entering PARENT for the first time, get list
5940 ;; of objects within known so far. Store it in
5941 ;; OBJECT-DATA.
5946 ;; Find NEXT object for analysis.
5948 ;; If NEXT is non-nil, we already exhausted the
5949 ;; cache so we can parse buffer to find the object
5950 ;; after it.
5952 ;; Otherwise, check if cache can help us.
5963 ;; Cache contains the information needed.
5966 pos)
5968 pos)
5974 ;; If we have a new object to analyze, store it in
5975 ;; cache. Otherwise record that there is nothing
5976 ;; more to parse in this element at this depth.
5981 ;; Process NEXT, if any, in order to know if we need
5982 ;; to skip it, return it or move into it.
5989 ;; Skip objects ending before point. Also skip
5990 ;; objects ending at point unless it is also the
5991 ;; end of buffer, since we want to return the
5992 ;; innermost object.
5995 ;; For convenience, when object ends at POS,
5996 ;; without any space, store it in LAST, as we
5997 ;; will return it if no object starts here.
6001 ;; If POS is within a container object, move
6002 ;; into that object.
6006 ;; At contents' end, if there is no
6007 ;; space before point, also move into
6008 ;; object, for consistency with
6009 ;; convenience feature above.
6018 next nil
6019 object-data nil))
6020 ;; Otherwise, return NEXT.
6022 ;; Store results in cache, if applicable.
6026 "List all ancestors of a given element or object.
6028 BLOB is an object or element.
6030 When optional argument TYPES is a list of symbols, return the
6031 first element or object in the lineage whose type belongs to that
6032 list.
6034 When optional argument WITH-SELF is non-nil, lineage includes
6035 BLOB itself as the first element, and TYPES, if provided, also
6036 apply to it.
6038 When BLOB is obtained through `org-element-context' or
6039 `org-element-at-point', only ancestors from its section can be
6040 found. There is no such limitation when BLOB belongs to a full
6041 parse tree."
6043 ancestors)
6050 "Non-nil when elements ELEM-A and ELEM-B are nested."
6059 "Swap elements ELEM-A and ELEM-B.
6060 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6061 end of ELEM-A."
6063 ;; There are two special cases when an element doesn't start at bol:
6064 ;; the first paragraph in an item or in a footnote definition.
6066 ;; Only a paragraph without any affiliated keyword can be moved at
6067 ;; ELEM-A position in such a situation. Note that the case of
6068 ;; a footnote definition is impossible: it cannot contain two
6069 ;; paragraphs in a row because it cannot contain a blank line.
6075 ;; In a special situation, ELEM-A will have no indentation. We'll
6076 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6090 ;; Store inner overlays responsible for visibility status.
6091 ;; We also need to store their boundaries as they will be
6092 ;; removed from buffer.
6107 ;; Get contents.
6115 ;; Restore ex ELEM-A overlays.
6122 ;; Restore ex ELEM-B overlays.
6130 ;; Local variables:
6131 ;; generated-autoload-file: "org-loaddefs.el"
6132 ;; End:
6134 ;;; org-element.el ends here