| blob | 027eea4488ec358024c64f9fd2248bda48e1017b |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
208 ;; Objects starting with "@": export snippets.
209 "@@"
210 ;; Objects starting with "{": macro.
211 "{{{"
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
214 ;; angular links.
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
228 ;;;###autoload
230 "Update parser internals."
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block)
246 item plain-list property-drawer quote-block section
247 special-block table)
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim)
259 superscript table-cell underline)
269 "List of affiliated keywords as strings.
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
297 strings and objects.
299 This list is checked after translations have been applied. See
304 org-element-parsed-keywords)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
324 ;; Dual affiliated keywords.
328 ;; Regular affiliated keywords.
333 org-element-affiliated-keywords)))
335 ;; Export attributes.
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
341 match group 2.
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
357 ;; breaks.
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
365 subscript superscript underline superscript)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim)
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
381 of such type.
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
385 markup.
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
403 "Table used internally to pair only round brackets.
412 "Table used internally to pair only square brackets.
421 "Table used internally to pair only curly brackets.
425 "Parse paired brackets at point.
426 CHAR is the opening bracket to consider, as a character. Return
427 contents between brackets, as a string, or nil. Also move point
428 past the brackets."
443 \f
444 ;;; Accessors and Setters
445 ;;
446 ;; Provide four accessors: `org-element-type', `org-element-property'
447 ;; `org-element-contents' and `org-element-restriction'.
448 ;;
449 ;; Setter functions allow modification of elements by side effect.
450 ;; There is `org-element-put-property', `org-element-set-contents'.
451 ;; These low-level functions are useful to build a parse tree.
452 ;;
453 ;; `org-element-adopt-element', `org-element-set-element',
454 ;; `org-element-extract-element' and `org-element-insert-before' are
455 ;; high-level functions useful to modify a parse tree.
456 ;;
457 ;; `org-element-secondary-p' is a predicate used to know if a given
458 ;; object belongs to a secondary string. `org-element-class' tells if
459 ;; some parsed data is an element or an object, handling pseudo
460 ;; elements and objects. `org-element-copy' returns an element or
461 ;; object, stripping its parent property in the process.
464 "Return type of ELEMENT.
466 The function returns the type of the element or object provided.
467 It can also return the following special value:
468 `plain-text' for a string
469 `org-data' for a complete document
470 nil in any other case."
476 "Extract the value from the PROPERTY of an ELEMENT."
481 "Extract contents from an ELEMENT."
487 "Return restriction associated to ELEMENT.
488 ELEMENT can be an element, an object or a symbol representing an
489 element or object type."
491 org-element-object-restrictions)))
494 "In ELEMENT set PROPERTY to VALUE.
495 Return modified element."
498 element))
501 "Set ELEMENT's contents to CONTENTS.
502 Return ELEMENT."
509 "Non-nil when OBJECT directly belongs to a secondary string.
510 Return value is the property name, as a keyword, or nil."
513 org-element-secondary-value-alist))))
520 "Return class for ELEMENT, as a symbol.
521 Class is either `element' or `object'. Optional argument PARENT
522 is the element or object containing DATUM. It defaults to the
523 value of DATUM `:parent' property."
527 ;; Trivial cases.
530 ;; Special cases.
534 ;; Pseudo object or elements. Make a guess about its class.
535 ;; Basically a pseudo object is contained within another object,
536 ;; a secondary string or a container element.
546 "Append elements to the contents of another element.
548 PARENT is an element or object. CHILDREN can be elements,
549 objects, or a strings.
551 The function takes care of setting `:parent' property for CHILD.
552 Return parent element."
554 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
555 ;; string: parent is the list itself.
558 ;; Add CHILDREN at the end of PARENT contents.
561 parent
563 ;; Return modified PARENT element.
567 "Extract ELEMENT from parse tree.
568 Remove element from the parse tree by side-effect, and return it
569 with its `:parent' property stripped out."
574 parent secondary
577 parent
579 ;; Return ELEMENT with its :parent removed.
583 "Insert ELEMENT before LOCATION in parse tree.
584 LOCATION is an element, object or string within the parse tree.
585 Parse tree is modified by side effect."
590 ;; Special case: LOCATION is the first element of an
591 ;; independent secondary string (e.g. :title property). Add
592 ;; ELEMENT in-place.
596 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
606 ;; Store SIBLINGS at appropriate place in parse tree.
611 ;; Set appropriate :parent property.
615 "Replace element or object OLD with element or object NEW.
616 The function takes care of setting `:parent' property for NEW."
617 ;; Ensure OLD and NEW have the same parent.
621 ;; We cannot replace OLD with NEW since one of them is not an
622 ;; object or element. We take the long path.
625 ;; Since OLD is going to be changed into NEW by side-effect, first
626 ;; make sure that every element or object within NEW has OLD as
627 ;; parent.
630 ;; Transfer contents.
632 ;; Overwrite OLD's properties with NEW's.
634 ;; Transfer type.
638 "Create a new element of type TYPE.
639 Optional argument PROPS, when non-nil, is a plist defining the
640 properties of the element. CHILDREN can be elements, objects or
641 strings."
645 "Return a copy of DATUM.
646 DATUM is an element, object, string or nil. `:parent' property
647 is cleared and contents are removed in the process."
658 \f
659 ;;; Greater elements
660 ;;
661 ;; For each greater element type, we define a parser and an
662 ;; interpreter.
663 ;;
664 ;; A parser returns the element or object as the list described above.
665 ;; Most of them accepts no argument. Though, exceptions exist. Hence
666 ;; every element containing a secondary string (see
667 ;; `org-element-secondary-value-alist') will accept an optional
668 ;; argument to toggle parsing of these secondary strings. Moreover,
669 ;; `item' parser requires current list's structure as its first
670 ;; element.
671 ;;
672 ;; An interpreter accepts two arguments: the list representation of
673 ;; the element or object, and its contents. The latter may be nil,
674 ;; depending on the element or object considered. It returns the
675 ;; appropriate Org syntax, as a string.
676 ;;
677 ;; Parsing functions must follow the naming convention:
678 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
679 ;; defined in `org-element-greater-elements'.
680 ;;
681 ;; Similarly, interpreting functions must follow the naming
682 ;; convention: org-element-TYPE-interpreter.
683 ;;
684 ;; With the exception of `headline' and `item' types, greater elements
685 ;; cannot contain other greater elements of their own type.
686 ;;
687 ;; Beside implementing a parser and an interpreter, adding a new
688 ;; greater element requires tweaking `org-element--current-element'.
689 ;; Moreover, the newly defined type must be added to both
690 ;; `org-element-all-elements' and `org-element-greater-elements'.
693 ;;;; Center Block
696 "Parse a center block.
698 LIMIT bounds the search. AFFILIATED is a list of which CAR is
699 the buffer position at the beginning of the first affiliated
700 keyword and CDR is a plist of affiliated keywords along with
701 their value.
703 Return a list whose CAR is `center-block' and CDR is a plist
704 containing `:begin', `:end', `:contents-begin', `:contents-end',
705 `:post-blank' and `:post-affiliated' keywords.
707 Assume point is at the beginning of the block."
711 ;; Incomplete block: parse it as a paragraph.
716 ;; Empty blocks have no contents.
730 :end end
731 :contents-begin contents-begin
732 :contents-end contents-end
738 "Interpret a center-block element as Org syntax.
739 CONTENTS is the contents of the element."
743 ;;;; Drawer
746 "Parse a drawer.
748 LIMIT bounds the search. AFFILIATED is a list of which CAR is
749 the buffer position at the beginning of the first affiliated
750 keyword and CDR is a plist of affiliated keywords along with
751 their value.
753 Return a list whose CAR is `drawer' and CDR is a plist containing
754 `:drawer-name', `:begin', `:end', `:contents-begin',
755 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
757 Assume point is at beginning of drawer."
760 ;; Incomplete drawer: parse it as a paragraph.
768 ;; Empty drawers have no contents.
781 :end end
782 :drawer-name name
783 :contents-begin contents-begin
784 :contents-end contents-end
790 "Interpret DRAWER element as Org syntax.
791 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Dynamic Block
800 "Parse a dynamic block.
802 LIMIT bounds the search. AFFILIATED is a list of which CAR is
803 the buffer position at the beginning of the first affiliated
804 keyword and CDR is a plist of affiliated keywords along with
805 their value.
807 Return a list whose CAR is `dynamic-block' and CDR is a plist
808 containing `:block-name', `:begin', `:end', `:contents-begin',
809 `:contents-end', `:arguments', `:post-blank' and
810 `:post-affiliated' keywords.
812 Assume point is at beginning of dynamic block."
816 ;; Incomplete block: parse it as a paragraph.
825 ;; Empty blocks have no contents.
838 :end end
839 :block-name name
840 :arguments arguments
841 :contents-begin contents-begin
842 :contents-end contents-end
848 "Interpret DYNAMIC-BLOCK element as Org syntax.
849 CONTENTS is the contents of the element."
854 contents))
857 ;;;; Footnote Definition
866 "Parse a footnote definition.
868 LIMIT bounds the search. AFFILIATED is a list of which CAR is
869 the buffer position at the beginning of the first affiliated
870 keyword and CDR is a plist of affiliated keywords along with
871 their value.
873 Return a list whose CAR is `footnote-definition' and CDR is
874 a plist containing `:label', `:begin' `:end', `:contents-begin',
875 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
877 Assume point is at the beginning of the footnote definition."
889 limit)
891 ;; At a new footnote definition, make sure we end
892 ;; before any affiliated keyword above.
913 :begin begin
914 :end end
915 :contents-begin contents-begin
916 :contents-end contents-end
922 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
923 CONTENTS is the contents of the footnote-definition."
925 " "
926 contents))
929 ;;;; Headline
932 "Return node properties associated to headline at point.
933 Upcase property names. It avoids confusion between properties
934 obtained through property drawer and default properties from the
935 parser (e.g. `:end' and :END:). Return value is a plist."
947 properties))))
950 "Return time properties associated to headline at point.
951 Return value is a plist."
965 plist))))
968 "Parse a headline.
970 Return a list whose CAR is `headline' and CDR is a plist
971 containing `:raw-value', `:title', `:begin', `:end',
972 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
973 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
974 `:deadline', `:closed', `:archivedp', `:commentedp'
975 `:footnote-section-p', `:post-blank' and `:post-affiliated'
976 keywords.
978 The plist also contains any property set in the property drawer,
979 with its name in upper cases and colons added at the
980 beginning (e.g., `:CUSTOM_ID').
982 LIMIT is a buffer position bounding the search.
984 When RAW-SECONDARY-P is non-nil, headline's title will not be
985 parsed as a secondary string, but as a plain string instead.
987 Assume point is at beginning of the headline."
1034 :begin begin
1035 :end end
1036 :pre-blank
1039 :contents-begin contents-begin
1040 :contents-end contents-end
1041 :level level
1042 :priority priority
1043 :tags tags
1044 :todo-keyword todo
1045 :todo-type todo-type
1048 end)
1049 :footnote-section-p footnote-section-p
1050 :archivedp archivedp
1051 :commentedp commentedp
1053 time-props
1054 standard-props))))
1056 headline :title
1065 nil
1067 headline)))))))
1070 "Interpret HEADLINE element as Org syntax.
1071 CONTENTS is the contents of the element."
1084 ?*)
1088 " "
1091 org-footnote-section
1092 title))))
1094 heading
1095 ;; Align tags.
1103 ?\s)
1104 tags))
1108 tags))))
1110 contents)))
1113 ;;;; Inlinetask
1116 "Parse an inline task.
1118 Return a list whose CAR is `inlinetask' and CDR is a plist
1119 containing `:title', `:begin', `:end', `:contents-begin' and
1120 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1121 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1122 `:closed', `:post-blank' and `: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."
1177 :begin begin
1178 :end end
1179 :contents-begin contents-begin
1180 :contents-end contents-end
1181 :level level
1182 :priority priority
1183 :tags tags
1184 :todo-keyword todo
1185 :todo-type todo-type
1188 time-props
1189 standard-props))))
1191 inlinetask :title
1200 nil
1202 inlinetask))))))
1205 "Interpret INLINETASK element as Org syntax.
1206 CONTENTS is the contents of inlinetask."
1220 ;; Align tags.
1228 ? )
1229 tags))
1233 tags))))
1234 ;; Prefer degenerate inlinetasks when there are no
1235 ;; contents.
1238 contents
1242 ;;;; Item
1245 "Parse an item.
1247 STRUCT is the structure of the plain list.
1249 Return a list whose CAR is `item' and CDR is a plist containing
1250 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1251 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1252 `:post-affiliated' keywords.
1254 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1255 any, will not be parsed as a secondary string, but as a plain
1256 string instead.
1258 Assume point is at the beginning of the item."
1281 ;; Ignore tags in un-ordered lists: they are just
1282 ;; a part of item's body.
1289 ;; If first line isn't empty, contents really
1290 ;; start at the text after item's meta-data.
1300 :begin begin
1301 :end end
1302 :contents-begin contents-begin
1303 :contents-end contents-end
1304 :checkbox checkbox
1305 :counter counter
1306 :structure struct
1310 item :tag
1317 item))))))))
1320 "Interpret ITEM element as Org syntax.
1321 CONTENTS is the contents of the element."
1331 ;; Compute indentation.
1336 ;; Indent contents.
1338 bullet
1353 ;;;; Plain List
1356 ;; Return structure of list at point. Internal function. See
1357 ;; `org-list-struct' for details.
1362 items struct)
1367 ;; At limit: end all items.
1376 ;; At list end: end all items.
1381 ;; At a new item: end previous sibling.
1393 ind
1394 bullet
1397 ;; Description tag.
1401 ;; Ending position, unknown so far.
1402 nil)))
1403 items))
1405 ;; Skip empty lines.
1407 ;; Skip inline tasks and blank lines along the way.
1414 ;; At some text line. Check if it ends any previous item.
1427 ;; Skip blocks (any type) and drawers contents.
1432 limit t)))
1438 "Parse a plain list.
1440 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1441 the buffer position at the beginning of the first affiliated
1442 keyword and CDR is a plist of affiliated keywords along with
1443 their value. STRUCTURE is the structure of the plain list being
1444 parsed.
1446 Return a list whose CAR is `plain-list' and CDR is a plist
1447 containing `:type', `:begin', `:end', `:contents-begin' and
1448 `:contents-end', `:structure', `:post-blank' and
1449 `:post-affiliated' keywords.
1451 Assume point is at the beginning of the list."
1465 pos))
1469 ;; Return value.
1473 :begin begin
1474 :end end
1475 :contents-begin contents-begin
1476 :contents-end contents-end
1477 :structure struct
1483 "Interpret plain-list element as Org syntax.
1484 CONTENTS is the contents of the element."
1492 ;;;; Property Drawer
1495 "Parse a property drawer.
1497 LIMIT bounds the search.
1499 Return a list whose car is `property-drawer' and cdr is a plist
1500 containing `:begin', `:end', `:contents-begin', `:contents-end',
1501 `:post-blank' and `:post-affiliated' keywords.
1503 Assume point is at the beginning of the property drawer."
1516 :end end
1518 :contents-end contents-end
1523 "Interpret property-drawer element as Org syntax.
1524 CONTENTS is the properties within the drawer."
1528 ;;;; Quote Block
1531 "Parse a quote block.
1533 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1534 the buffer position at the beginning of the first affiliated
1535 keyword and CDR is a plist of affiliated keywords along with
1536 their value.
1538 Return a list whose CAR is `quote-block' and CDR is a plist
1539 containing `:begin', `:end', `:contents-begin', `:contents-end',
1540 `:post-blank' and `:post-affiliated' keywords.
1542 Assume point is at the beginning of the block."
1546 ;; Incomplete block: parse it as a paragraph.
1552 ;; Empty blocks have no contents.
1565 :end end
1566 :contents-begin contents-begin
1567 :contents-end contents-end
1573 "Interpret quote-block element as Org syntax.
1574 CONTENTS is the contents of the element."
1578 ;;;; Section
1581 "Parse a section.
1583 Return a list whose CAR is `section' and CDR is a plist
1584 containing `:begin', `:end', `:contents-begin', `contents-end',
1585 `:post-blank' and `:post-affiliated' keywords."
1587 ;; Beginning of section is the beginning of the first non-blank
1588 ;; line after previous headline.
1596 :end end
1597 :contents-begin begin
1598 :contents-end pos-before-blank
1603 "Interpret section element as Org syntax.
1604 CONTENTS is the contents of the element."
1605 contents)
1608 ;;;; Special Block
1611 "Parse a special block.
1613 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1614 the buffer position at the beginning of the first affiliated
1615 keyword and CDR is a plist of affiliated keywords along with
1616 their value.
1618 Return a list whose CAR is `special-block' and CDR is a plist
1619 containing `:type', `:begin', `:end', `:contents-begin',
1620 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1622 Assume point is at the beginning of the block."
1629 limit t)))
1630 ;; Incomplete block: parse it as a paragraph.
1636 ;; Empty blocks have no contents.
1649 :begin begin
1650 :end end
1651 :contents-begin contents-begin
1652 :contents-end contents-end
1658 "Interpret SPECIAL-BLOCK element as Org syntax.
1659 CONTENTS is the contents of the element."
1664 \f
1665 ;;; Elements
1666 ;;
1667 ;; For each element, a parser and an interpreter are also defined.
1668 ;; Both follow the same naming convention used for greater elements.
1669 ;;
1670 ;; Also, as for greater elements, adding a new element type is done
1671 ;; through the following steps: implement a parser and an interpreter,
1672 ;; tweak `org-element--current-element' so that it recognizes the new
1673 ;; type and add that new type to `org-element-all-elements'.
1676 ;;;; Babel Call
1679 "Parse a babel call.
1681 LIMIT bounds the search. AFFILIATED is a list of which car is
1682 the buffer position at the beginning of the first affiliated
1683 keyword and cdr is a plist of affiliated keywords along with
1684 their value.
1686 Return a list whose car is `babel-call' and cdr is a plist
1687 containing `:call', `:inside-header', `:arguments',
1688 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1689 `:post-affiliated' as keywords."
1703 value)))
1713 :begin begin
1714 :end end
1715 :value value
1721 "Interpret BABEL-CALL element as Org syntax."
1731 ;;;; Clock
1734 "Parse a clock.
1736 LIMIT bounds the search.
1738 Return a list whose CAR is `clock' and CDR is a plist containing
1739 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1740 `:post-affiliated' as keywords."
1760 :value value
1761 :duration duration
1762 :begin begin
1763 :end end
1764 :post-blank post-blank
1768 "Interpret CLOCK element as Org syntax."
1776 "%2s:%02s"
1780 ;;;; Comment
1783 "Parse a comment.
1785 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1786 the buffer position at the beginning of the first affiliated
1787 keyword and CDR is a plist of affiliated keywords along with
1788 their value.
1790 Return a list whose CAR is `comment' and CDR is a plist
1791 containing `:begin', `:end', `:value', `:post-blank',
1792 `:post-affiliated' keywords.
1794 Assume point is at comment beginning."
1803 ;; Get comments ending.
1806 ;; Accumulate lines without leading hash and first
1807 ;; whitespace.
1821 :end end
1822 :value value
1828 "Interpret COMMENT element as Org syntax.
1829 CONTENTS is nil."
1833 ;;;; Comment Block
1836 "Parse an export block.
1838 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1839 the buffer position at the beginning of the first affiliated
1840 keyword and CDR is a plist of affiliated keywords along with
1841 their value.
1843 Return a list whose CAR is `comment-block' and CDR is a plist
1844 containing `:begin', `:end', `:value', `:post-blank' and
1845 `:post-affiliated' keywords.
1847 Assume point is at comment block beginning."
1851 ;; Incomplete block: parse it as a paragraph.
1864 contents-begin contents-end)))
1868 :end end
1869 :value value
1875 "Interpret COMMENT-BLOCK element as Org syntax."
1882 ;;;; Diary Sexp
1885 "Parse a diary sexp.
1887 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1888 the buffer position at the beginning of the first affiliated
1889 keyword and CDR is a plist of affiliated keywords along with
1890 their value.
1892 Return a list whose CAR is `diary-sexp' and CDR is a plist
1893 containing `:begin', `:end', `:value', `:post-blank' and
1894 `:post-affiliated' keywords."
1906 :begin begin
1907 :end end
1913 "Interpret DIARY-SEXP as Org syntax."
1917 ;;;; Example Block
1920 "Parse an example block.
1922 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1923 the buffer position at the beginning of the first affiliated
1924 keyword and CDR is a plist of affiliated keywords along with
1925 their value.
1927 Return a list whose CAR is `example-block' and CDR is a plist
1928 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1929 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1930 `:value', `:post-blank' and `:post-affiliated' keywords."
1934 ;; Incomplete block: parse it as a paragraph.
1942 ;; Switches analysis.
1946 switches)
1949 'new
1952 ;; Subtract 1 to give number of lines before
1953 ;; first line.
1957 ;; Should labels be retained in (or stripped from) example
1958 ;; blocks?
1963 ;; What should code-references use - labels or
1964 ;; line-numbers?
1973 ;; Standard block parsing.
1979 contents-begin contents-end)))
1988 :end end
1989 :value value
1990 :switches switches
1991 :number-lines number-lines
1992 :preserve-indent preserve-indent
1993 :retain-labels retain-labels
1994 :use-labels use-labels
1995 :label-fmt label-fmt
2001 "Interpret EXAMPLE-BLOCK element as Org syntax."
2009 value
2014 ;;;; Export Block
2017 "Parse an export block.
2019 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2020 the buffer position at the beginning of the first affiliated
2021 keyword and CDR is a plist of affiliated keywords along with
2022 their value.
2024 Return a list whose CAR is `export-block' and CDR is a plist
2025 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2026 `:post-affiliated' keywords.
2028 Assume point is at export-block beginning."
2032 ;; Incomplete block: parse it as a paragraph.
2051 contents-end))))
2055 :begin begin
2056 :end end
2057 :value value
2063 "Interpret EXPORT-BLOCK element as Org syntax."
2069 ;;;; Fixed-width
2072 "Parse a fixed-width section.
2074 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2075 the buffer position at the beginning of the first affiliated
2076 keyword and CDR is a plist of affiliated keywords along with
2077 their value.
2079 Return a list whose CAR is `fixed-width' and CDR is a plist
2080 containing `:begin', `:end', `:value', `:post-blank' and
2081 `:post-affiliated' keywords.
2083 Assume point is at the beginning of the fixed-width area."
2087 value
2092 ;; Accumulate text without starting colons.
2105 :end end
2106 :value value
2112 "Interpret FIXED-WIDTH element as Org syntax."
2120 ;;;; Horizontal Rule
2123 "Parse an horizontal rule.
2125 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2126 the buffer position at the beginning of the first affiliated
2127 keyword and CDR is a plist of affiliated keywords along with
2128 their value.
2130 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2131 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2132 keywords."
2142 :end end
2148 "Interpret HORIZONTAL-RULE element as Org syntax."
2152 ;;;; Keyword
2155 "Parse a keyword at point.
2157 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2158 the buffer position at the beginning of the first affiliated
2159 keyword and CDR is a plist of affiliated keywords along with
2160 their value.
2162 Return a list whose CAR is `keyword' and CDR is a plist
2163 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2164 `:post-affiliated' keywords."
2166 ;; An orphaned affiliated keyword is considered as a regular
2167 ;; keyword. In this case AFFILIATED is nil, so we take care of
2168 ;; this corner case.
2181 :value value
2182 :begin begin
2183 :end end
2189 "Interpret KEYWORD element as Org syntax."
2195 ;;;; Latex Environment
2199 "Regexp matching the beginning of a LaTeX environment.
2200 The environment is captured by the first group.
2206 "Format string matching the ending of a LaTeX environment.
2210 "Parse a LaTeX environment.
2212 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2213 the buffer position at the beginning of the first affiliated
2214 keyword and CDR is a plist of affiliated keywords along with
2215 their value.
2217 Return a list whose CAR is `latex-environment' and CDR is a plist
2218 containing `:begin', `:end', `:value', `:post-blank' and
2219 `:post-affiliated' keywords.
2221 Assume point is at the beginning of the latex environment."
2228 limit t))
2229 ;; Incomplete latex environment: parse it as a paragraph.
2239 :end end
2240 :value value
2246 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2250 ;;;; Node Property
2253 "Parse a node-property at point.
2255 LIMIT bounds the search.
2257 Return a list whose CAR is `node-property' and CDR is a plist
2258 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2259 `:post-affiliated' keywords."
2269 limit))))
2272 :value value
2273 :begin begin
2274 :end end
2279 "Interpret NODE-PROPERTY element as Org syntax."
2285 ;;;; Paragraph
2288 "Parse a paragraph.
2290 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2291 the buffer position at the beginning of the first affiliated
2292 keyword and CDR is a plist of affiliated keywords along with
2293 their value.
2295 Return a list whose CAR is `paragraph' and CDR is a plist
2296 containing `:begin', `:end', `:contents-begin' and
2297 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2299 Assume point is at the beginning of the paragraph."
2306 ;; A matching `org-element-paragraph-separate' is not
2307 ;; necessarily the end of the paragraph. In particular,
2308 ;; drawers, blocks or LaTeX environments opening lines
2309 ;; must be closed. Moreover keywords with a secondary
2310 ;; value must belong to "dual keywords".
2324 limit t)))
2330 limit t)))
2333 org-element-dual-keywords))
2334 ;; Everything else is unambiguous.
2347 :end end
2348 :contents-begin contents-begin
2349 :contents-end contents-end
2355 "Interpret paragraph element as Org syntax.
2356 CONTENTS is the contents of the element."
2357 contents)
2360 ;;;; Planning
2363 "Parse a planning.
2365 LIMIT bounds the search.
2367 Return a list whose CAR is `planning' and CDR is a plist
2368 containing `:closed', `:deadline', `:scheduled', `:begin',
2369 `:end', `:post-blank' and `:post-affiliated' keywords."
2379 closed deadline scheduled)
2391 :deadline deadline
2392 :scheduled scheduled
2393 :begin begin
2394 :end end
2395 :post-blank post-blank
2399 "Interpret PLANNING element as Org syntax."
2401 #'identity
2418 ;;;; Src Block
2421 "Parse a src block.
2423 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2424 the buffer position at the beginning of the first affiliated
2425 keyword and CDR is a plist of affiliated keywords along with
2426 their value.
2428 Return a list whose CAR is `src-block' and CDR is a plist
2429 containing `:language', `:switches', `:parameters', `:begin',
2430 `:end', `:number-lines', `:retain-labels', `:use-labels',
2431 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2432 `:post-affiliated' keywords.
2434 Assume point is at the beginning of the block."
2437 limit t)))
2438 ;; Incomplete block: parse it as a paragraph.
2444 ;; Get language as a string.
2453 ;; Get switches.
2455 ;; Get parameters.
2457 ;; Switches analysis.
2461 switches)
2464 'new
2467 ;; Subtract 1 to give number of lines before
2468 ;; first line.
2476 ;; Should labels be retained in (or stripped from)
2477 ;; src blocks?
2482 ;; What should code-references use - labels or
2483 ;; line-numbers?
2488 ;; Retrieve code.
2495 ;; Get position after ending blank lines.
2505 :begin begin
2506 :end end
2507 :number-lines number-lines
2508 :preserve-indent preserve-indent
2509 :retain-labels retain-labels
2510 :use-labels use-labels
2511 :label-fmt label-fmt
2512 :value value
2518 "Interpret SRC-BLOCK element as Org syntax."
2527 val)
2542 ;;;; Table
2545 "Parse a table at point.
2547 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2548 the buffer position at the beginning of the first affiliated
2549 keyword and CDR is a plist of affiliated keywords along with
2550 their value.
2552 Return a list whose CAR is `table' and CDR is a plist containing
2553 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2554 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2555 keywords.
2557 Assume point is at the beginning of the table."
2573 acc))
2580 :end end
2581 :type type
2582 :tblfm tblfm
2583 ;; Only `org' tables have contents. `table.el' tables
2584 ;; use a `:value' property to store raw table as
2585 ;; a string.
2590 table-begin table-end))
2596 "Interpret TABLE element as Org syntax.
2597 CONTENTS is a string, if table's type is `org', or nil."
2608 ;;;; Table Row
2611 "Parse table row at point.
2613 Return a list whose CAR is `table-row' and CDR is a plist
2614 containing `:begin', `:end', `:contents-begin', `:contents-end',
2615 `:type', `:post-blank' and `:post-affiliated' keywords."
2619 ;; A table rule has no contents. In that case, ensure
2620 ;; CONTENTS-BEGIN matches CONTENTS-END.
2630 :begin begin
2631 :end end
2632 :contents-begin contents-begin
2633 :contents-end contents-end
2638 "Interpret TABLE-ROW element as Org syntax.
2639 CONTENTS is the contents of the table row."
2644 ;;;; Verse Block
2647 "Parse a verse block.
2649 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2650 the buffer position at the beginning of the first affiliated
2651 keyword and CDR is a plist of affiliated keywords along with
2652 their value.
2654 Return a list whose CAR is `verse-block' and CDR is a plist
2655 containing `:begin', `:end', `:contents-begin', `:contents-end',
2656 `:post-blank' and `:post-affiliated' keywords.
2658 Assume point is at beginning of the block."
2662 ;; Incomplete block: parse it as a paragraph.
2677 :end end
2678 :contents-begin contents-begin
2679 :contents-end contents-end
2685 "Interpret verse-block element as Org syntax.
2686 CONTENTS is verse block contents."
2690 \f
2691 ;;; Objects
2692 ;;
2693 ;; Unlike to elements, raw text can be found between objects. Hence,
2694 ;; `org-element--object-lex' is provided to find the next object in
2695 ;; buffer.
2696 ;;
2697 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2698 ;; object types they can contain will be specified in
2699 ;; `org-element-object-restrictions'.
2700 ;;
2701 ;; Creating a new type of object requires to alter
2702 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2703 ;; new type in `org-element-all-objects', and possibly add
2704 ;; restrictions in `org-element-object-restrictions'.
2706 ;;;; Bold
2709 "Parse bold object at point, if any.
2711 When at a bold object, return a list whose car is `bold' and cdr
2712 is a plist with `:begin', `:end', `:contents-begin' and
2713 `:contents-end' and `:post-blank' keywords. Otherwise, return
2714 nil.
2716 Assume point is at the first star marker."
2728 :end end
2729 :contents-begin contents-begin
2730 :contents-end contents-end
2734 "Interpret bold object as Org syntax.
2735 CONTENTS is the contents of the object."
2739 ;;;; Code
2742 "Parse code object at point, if any.
2744 When at a code object, return a list whose car is `code' and cdr
2745 is a plist with `:value', `:begin', `:end' and `:post-blank'
2746 keywords. Otherwise, return nil.
2748 Assume point is at the first tilde marker."
2759 :begin begin
2760 :end end
2764 "Interpret CODE object as Org syntax."
2768 ;;;; Entity
2771 "Parse entity at point, if any.
2773 When at an entity, return a list whose car is `entity' and cdr
2774 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2775 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2776 `:post-blank' as keywords. Otherwise, return nil.
2778 Assume point is at the beginning of the entity."
2780 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2798 :begin begin
2799 :end end
2800 :use-brackets-p bracketsp
2804 "Interpret ENTITY object as Org syntax."
2810 ;;;; Export Snippet
2813 "Parse export snippet at point.
2815 When at an export snippet, return a list whose car is
2816 `export-snippet' and cdr a plist with `:begin', `:end',
2817 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2818 return nil.
2820 Assume point is at the beginning of the snippet."
2836 :value value
2837 :begin begin
2838 :end end
2842 "Interpret EXPORT-SNIPPET object as Org syntax."
2848 ;;;; Footnote Reference
2851 "Parse footnote reference at point, if any.
2853 When at a footnote reference, return a list whose car is
2854 `footnote-reference' and cdr a plist with `:label', `:type',
2855 `:begin', `:end', `:content-begin', `:contents-end' and
2856 `:post-blank' as keywords. Otherwise, return nil."
2872 :type type
2873 :begin begin
2874 :end end
2880 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2881 CONTENTS is its definition, when inline, or nil."
2887 ;;;; Inline Babel Call
2890 "Parse inline babel call at point, if any.
2892 When at an inline babel call, return a list whose car is
2893 `inline-babel-call' and cdr a plist with `:call',
2894 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2895 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2897 Assume point is at the beginning of the babel call."
2911 ;; Parenthesis are mandatory.
2922 :inside-header inside-header
2923 :arguments arguments
2924 :end-header end-header
2925 :begin begin
2926 :end end
2927 :value value
2931 "Interpret INLINE-BABEL-CALL object as Org syntax."
2941 ;;;; Inline Src Block
2944 "Parse inline source block at point, if any.
2946 When at an inline source block, return a list whose car is
2947 `inline-src-block' and cdr a plist with `:begin', `:end',
2948 `:language', `:value', `:parameters' and `:post-blank' as
2949 keywords. Otherwise, return nil.
2951 Assume point is at the beginning of the inline src block."
2968 :value value
2969 :parameters parameters
2970 :begin begin
2975 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2980 language
2982 body)))
2984 ;;;; Italic
2987 "Parse italic object at point, if any.
2989 When at an italic object, return a list whose car is `italic' and
2990 cdr is a plist with `:begin', `:end', `:contents-begin' and
2991 `:contents-end' and `:post-blank' keywords. Otherwise, return
2992 nil.
2994 Assume point is at the first slash marker."
3006 :end end
3007 :contents-begin contents-begin
3008 :contents-end contents-end
3012 "Interpret italic object as Org syntax.
3013 CONTENTS is the contents of the object."
3017 ;;;; Latex Fragment
3020 "Parse LaTeX fragment at point, if any.
3022 When at a LaTeX fragment, return a list whose car is
3023 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3024 and `:post-blank' as keywords. Otherwise, return nil.
3026 Assume point is at the beginning of the LaTeX fragment."
3044 ;; Macro.
3054 :begin begin
3055 :end end
3059 "Interpret LATEX-FRAGMENT object as Org syntax."
3062 ;;;; Line Break
3065 "Parse line break at point, if any.
3067 When at a line break, return a list whose car is `line-break',
3068 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3069 Otherwise, return nil.
3071 Assume point is at the beginning of the line break."
3080 "Interpret LINE-BREAK object as Org syntax."
3084 ;;;; Link
3087 "Parse link at point, if any.
3089 When at a link, return a list whose car is `link' and cdr a plist
3090 with `:type', `:path', `:format', `:raw-link', `:application',
3091 `:search-option', `:begin', `:end', `:contents-begin',
3092 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3093 nil.
3095 Assume point is at the beginning of the link."
3098 end contents-begin contents-end link-end post-blank path type format
3099 raw-link search-option application)
3101 ;; Type 1: Text targeted from a radio target.
3111 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3117 ;; RAW-LINK is the original link. Expand any
3118 ;; abbreviation in it.
3119 ;;
3120 ;; Also treat any newline character and associated
3121 ;; indentation as a single space character. This is not
3122 ;; compatible with RFC 3986, which requires to ignore
3123 ;; them altogether. However, doing so would require
3124 ;; users to encode spaces on the fly when writing links
3125 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3126 ;; [[shell:ls *.org]], which defeats Org's focus on
3127 ;; simplicity.
3132 ;; Determine TYPE of link and set PATH accordingly. According
3133 ;; to RFC 3986, remove whitespaces from URI in external links.
3134 ;; In internal ones, treat indentation as a single space.
3136 ;; File type.
3141 ;; Explicit type (http, irc, bbdb...).
3145 ;; Code-ref type: PATH is the name of the reference.
3150 ;; Custom-id type: PATH is the name of the custom id.
3154 ;; Fuzzy type: Internal link either matches a target, an
3155 ;; headline name or nothing. PATH is the target or
3156 ;; headline's name.
3160 ;; Type 3: Plain link, e.g., http://orgmode.org
3167 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3168 ;; bracket links, follow RFC 3986 and remove any extra
3169 ;; whitespace in URI.
3180 ;; In any case, deduce end point after trailing white space from
3181 ;; LINK-END variable.
3186 ;; Special "file" type link processing. Extract opening
3187 ;; application and search option, if any. Also normalize URI.
3194 ;; Translate link, if `org-link-translation-function' is set.
3202 :path path
3203 :format format
3205 :application application
3206 :search-option search-option
3207 :begin begin
3208 :end end
3209 :contents-begin contents-begin
3210 :contents-end contents-end
3214 "Interpret LINK object as Org syntax.
3215 CONTENTS is the contents of the object, or nil."
3220 ;; Links with contents and internal links have to
3221 ;; use bracket syntax. Ignore `:format' in these
3222 ;; cases. This is also the default syntax when the
3223 ;; property is not defined, e.g., when the object
3224 ;; was crafted by the user.
3227 ;; Since this is going to be used as
3228 ;; a format string, escape percent signs
3229 ;; in description.
3232 `nil
3235 ;; Otherwise, just obey to `:format'.
3247 path
3253 ;;;; Macro
3256 "Parse macro at point, if any.
3258 When at a macro, return a list whose car is `macro' and cdr
3259 a plist with `:key', `:args', `:begin', `:end', `:value' and
3260 `:post-blank' as keywords. Otherwise, return nil.
3262 Assume point is at the macro."
3275 :value value
3276 :args args
3277 :begin begin
3278 :end end
3282 "Interpret MACRO object as Org syntax."
3286 ;;;; Radio-target
3289 "Parse radio target at point, if any.
3291 When at a radio target, return a list whose car is `radio-target'
3292 and cdr a plist with `:begin', `:end', `:contents-begin',
3293 `:contents-end', `:value' and `:post-blank' as keywords.
3294 Otherwise, return nil.
3296 Assume point is at the radio target."
3308 :end end
3309 :contents-begin contents-begin
3310 :contents-end contents-end
3311 :post-blank post-blank
3315 "Interpret target object as Org syntax.
3316 CONTENTS is the contents of the object."
3320 ;;;; Statistics Cookie
3323 "Parse statistics cookie at point, if any.
3325 When at a statistics cookie, return a list whose car is
3326 `statistics-cookie', and cdr a plist with `:begin', `:end',
3327 `:value' and `:post-blank' keywords. Otherwise, return nil.
3329 Assume point is at the beginning of the statistics-cookie."
3340 :end end
3341 :value value
3345 "Interpret STATISTICS-COOKIE object as Org syntax."
3349 ;;;; Strike-Through
3352 "Parse strike-through object at point, if any.
3354 When at a strike-through object, return a list whose car is
3355 `strike-through' and cdr is a plist with `:begin', `:end',
3356 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3357 Otherwise, return nil.
3359 Assume point is at the first plus sign marker."
3371 :end end
3372 :contents-begin contents-begin
3373 :contents-end contents-end
3377 "Interpret strike-through object as Org syntax.
3378 CONTENTS is the contents of the object."
3382 ;;;; Subscript
3385 "Parse subscript at point, if any.
3387 When at a subscript object, return a list whose car is
3388 `subscript' and cdr a plist with `:begin', `:end',
3389 `:contents-begin', `:contents-end', `:use-brackets-p' and
3390 `:post-blank' as keywords. Otherwise, return nil.
3392 Assume point is at the underscore."
3406 :end end
3407 :use-brackets-p bracketsp
3408 :contents-begin contents-begin
3409 :contents-end contents-end
3413 "Interpret SUBSCRIPT object as Org syntax.
3414 CONTENTS is the contents of the object."
3417 contents))
3420 ;;;; Superscript
3423 "Parse superscript at point, if any.
3425 When at a superscript object, return a list whose car is
3426 `superscript' and cdr a plist with `:begin', `:end',
3427 `:contents-begin', `:contents-end', `:use-brackets-p' and
3428 `:post-blank' as keywords. Otherwise, return nil.
3430 Assume point is at the caret."
3444 :end end
3445 :use-brackets-p bracketsp
3446 :contents-begin contents-begin
3447 :contents-end contents-end
3451 "Interpret SUPERSCRIPT object as Org syntax.
3452 CONTENTS is the contents of the object."
3455 contents))
3458 ;;;; Table Cell
3461 "Parse table cell at point.
3462 Return a list whose car is `table-cell' and cdr is a plist
3463 containing `:begin', `:end', `:contents-begin', `:contents-end'
3464 and `:post-blank' keywords."
3472 :end end
3473 :contents-begin contents-begin
3474 :contents-end contents-end
3478 "Interpret table-cell element as Org syntax.
3479 CONTENTS is the contents of the cell, or nil."
3483 ;;;; Target
3486 "Parse target at point, if any.
3488 When at a target, return a list whose car is `target' and cdr
3489 a plist with `:begin', `:end', `:value' and `:post-blank' as
3490 keywords. Otherwise, return nil.
3492 Assume point is at the target."
3502 :end end
3503 :value value
3507 "Interpret TARGET object as Org syntax."
3511 ;;;; Timestamp
3522 "Parse time stamp at point, if any.
3524 When at a time stamp, return a list whose car is `timestamp', and
3525 cdr a plist with `:type', `:raw-value', `:year-start',
3526 `:month-start', `:day-start', `:hour-start', `:minute-start',
3527 `:year-end', `:month-end', `:day-end', `:hour-end',
3528 `:minute-end', `:repeater-type', `:repeater-value',
3529 `:repeater-unit', `:warning-type', `:warning-value',
3530 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3531 Otherwise, return nil.
3533 Assume point is at the beginning of the timestamp."
3552 date-start)
3563 raw-value)
3565 :repeater-type
3571 :repeater-unit
3580 :warning-unit
3583 year-start month-start day-start hour-start minute-start year-end
3584 month-end day-end hour-end minute-end)
3585 ;; Parse date-start.
3593 ;; Compute date-end. It can be provided directly in time-stamp,
3594 ;; or extracted from time range. Otherwise, it defaults to the
3595 ;; same values as date-start.
3605 :raw-value raw-value
3606 :year-start year-start
3607 :month-start month-start
3608 :day-start day-start
3609 :hour-start hour-start
3610 :minute-start minute-start
3611 :year-end year-end
3612 :month-end month-end
3613 :day-end day-end
3614 :hour-end hour-end
3615 :minute-end minute-end
3616 :begin begin
3617 :end end
3619 repeater-props
3620 warning-props))))))
3623 "Interpret TIMESTAMP object as Org syntax."
3641 ;; Build an Org timestamp string from TIME. ACTIVEP is
3642 ;; non-nil when time stamp is active. If WITH-TIME-P is
3643 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3644 ;; specify a time range in the timestamp. REPEAT-STRING is
3645 ;; the repeater string, if any.
3649 org-time-stamp-formats)
3650 time)))
3656 nil nil ts)))
3661 " "
3662 s
3664 ;; Return value.
3665 ts)))
3677 build-ts-string
3696 0
3704 "--"
3717 ;;;; Underline
3720 "Parse underline object at point, if any.
3722 When at an underline object, return a list whose car is
3723 `underline' and cdr is a plist with `:begin', `:end',
3724 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3725 Otherwise, return nil.
3727 Assume point is at the first underscore marker."
3739 :end end
3740 :contents-begin contents-begin
3741 :contents-end contents-end
3745 "Interpret underline object as Org syntax.
3746 CONTENTS is the contents of the object."
3750 ;;;; Verbatim
3753 "Parse verbatim object at point, if any.
3755 When at a verbatim object, return a list whose car is `verbatim'
3756 and cdr is a plist with `:value', `:begin', `:end' and
3757 `:post-blank' keywords. Otherwise, return nil.
3759 Assume point is at the first equal sign marker."
3770 :begin begin
3771 :end end
3775 "Interpret VERBATIM object as Org syntax."
3779 \f
3780 ;;; Parsing Element Starting At Point
3781 ;;
3782 ;; `org-element--current-element' is the core function of this section.
3783 ;; It returns the Lisp representation of the element starting at
3784 ;; point.
3785 ;;
3786 ;; `org-element--current-element' makes use of special modes. They
3787 ;; are activated for fixed element chaining (e.g., `plain-list' >
3788 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3789 ;; `section'). Special modes are: `first-section', `item',
3790 ;; `node-property', `section' and `table-row'.
3793 "Parse the element starting at point.
3795 Return value is a list like (TYPE PROPS) where TYPE is the type
3796 of the element and PROPS a plist of properties associated to the
3797 element.
3799 Possible types are defined in `org-element-all-elements'.
3801 LIMIT bounds the search.
3803 Optional argument GRANULARITY determines the depth of the
3804 recursion. Allowed values are `headline', `greater-element',
3805 `element', `object' or nil. When it is broader than `object' (or
3806 nil), secondary values will not be parsed, since they only
3807 contain objects.
3809 Optional argument MODE, when non-nil, can be either
3810 `first-section', `section', `planning', `item', `node-property'
3811 and `table-row'.
3813 If STRUCTURE isn't provided but MODE is set to `item', it will be
3814 computed.
3816 This function assumes point is always at the beginning of the
3817 element it has to parse."
3820 ;; Determine if parsing depth allows for secondary strings
3821 ;; parsing. It only applies to elements referenced in
3822 ;; `org-element-secondary-value-alist'.
3825 ;; Item.
3828 ;; Table Row.
3830 ;; Node Property.
3832 ;; Headline.
3835 ;; Sections (must be checked after headline).
3840 limit)))
3841 ;; Planning.
3844 ;; Property drawer.
3848 ;; When not at bol, point is at the beginning of an item or
3849 ;; a footnote definition: next item is always a paragraph.
3851 ;; Clock.
3853 ;; Inlinetask.
3856 ;; From there, elements can have affiliated keywords.
3859 ;; Jumping over affiliated keywords put point off-limits.
3860 ;; Parse them as regular keywords.
3864 ;; LaTeX Environment.
3867 ;; Drawer and Property Drawer.
3870 ;; Fixed Width
3873 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3874 ;; Keywords.
3892 limit
3893 affiliated))
3906 ;; Footnote Definition.
3909 ;; Horizontal Rule.
3912 ;; Diary Sexp.
3915 ;; Table.
3918 ;; List.
3921 limit affiliated
3923 ;; Default element: Paragraph.
3927 ;; Most elements can have affiliated keywords. When looking for an
3928 ;; element beginning, we want to move before them, as they belong to
3929 ;; that element, and, in the meantime, collect information they give
3930 ;; into appropriate properties. Hence the following function.
3933 "Collect affiliated keywords from point down to LIMIT.
3935 Return a list whose CAR is the position at the first of them and
3936 CDR a plist of keywords and values and move point to the
3937 beginning of the first line after them.
3939 As a special case, if element doesn't start at the beginning of
3940 the line (e.g., a paragraph starting an item), CAR is current
3941 position of point and CDR is nil."
3945 ;; RESTRICT is the list of objects allowed in parsed
3946 ;; keywords value.
3948 output)
3951 ;; Apply translation to RAW-KWD. From there, KWD is
3952 ;; the official keyword.
3954 org-element-keyword-translation-alist))
3955 raw-kwd))
3956 ;; Find main value for any keyword.
3962 ;; PARSEDP is non-nil when keyword should have its
3963 ;; value parsed.
3965 ;; If KWD is a dual keyword, find its secondary
3966 ;; value. Maybe parse it.
3975 ;; Attribute a property name to KWD.
3977 ;; Now set final shape for VALUE.
3983 nil restrict)))
3987 ;; Attributes can always appear on multiple lines.
3990 ;; Eventually store the new value in OUTPUT.
3992 ;; Move to next keyword.
3994 ;; If affiliated keywords are orphaned: move back to first one.
3995 ;; They will be parsed as a paragraph.
3997 ;; Return value.
4001 \f
4002 ;;; The Org Parser
4003 ;;
4004 ;; The two major functions here are `org-element-parse-buffer', which
4005 ;; parses Org syntax inside the current buffer, taking into account
4006 ;; region, narrowing, or even visibility if specified, and
4007 ;; `org-element-parse-secondary-string', which parses objects within
4008 ;; a given string.
4009 ;;
4010 ;; The (almost) almighty `org-element-map' allows applying a function
4011 ;; on elements or objects matching some type, and accumulating the
4012 ;; resulting values. In an export situation, it also skips unneeded
4013 ;; parts of the parse tree.
4016 "Recursively parse the buffer and return structure.
4017 If narrowing is in effect, only parse the visible part of the
4018 buffer.
4020 Optional argument GRANULARITY determines the depth of the
4021 recursion. It can be set to the following symbols:
4023 `headline' Only parse headlines.
4024 `greater-element' Don't recurse into greater elements excepted
4025 headlines and sections. Thus, elements
4026 parsed are the top-level ones.
4027 `element' Parse everything but objects and plain text.
4028 `object' Parse the complete buffer (default).
4030 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4031 elements.
4033 An element or an objects is represented as a list with the
4034 pattern (TYPE PROPERTIES CONTENTS), where :
4036 TYPE is a symbol describing the element or object. See
4037 `org-element-all-elements' and `org-element-all-objects' for an
4038 exhaustive list of such symbols. One can retrieve it with
4039 `org-element-type' function.
4041 PROPERTIES is the list of attributes attached to the element or
4042 object, as a plist. Although most of them are specific to the
4043 element or object type, all types share `:begin', `:end',
4044 `:post-blank' and `:parent' properties, which respectively
4045 refer to buffer position where the element or object starts,
4046 ends, the number of white spaces or blank lines after it, and
4047 the element or object containing it. Properties values can be
4048 obtained by using `org-element-property' function.
4050 CONTENTS is a list of elements, objects or raw strings
4051 contained in the current element or object, when applicable.
4052 One can access them with `org-element-contents' function.
4054 The Org buffer has `org-data' as type and nil as properties.
4055 `org-element-map' function can be used to find specific elements
4056 or objects within the parse tree.
4058 This function assumes that current major mode is `org-mode'."
4064 ;; Start in `first-section' mode so text before the first
4065 ;; headline belongs to a section.
4069 "Recursively parse objects in STRING and return structure.
4071 RESTRICTION is a symbol limiting the object types that will be
4072 looked after.
4074 Optional argument PARENT, when non-nil, is the element or object
4075 containing the secondary string. It is used to set correctly
4076 `:parent' property within the string.
4078 If STRING is the empty string or nil, return nil."
4095 "Map a function on selected elements or objects.
4097 DATA is a parse tree, an element, an object, a string, or a list
4098 of such constructs. TYPES is a symbol or list of symbols of
4099 elements or objects types (see `org-element-all-elements' and
4100 `org-element-all-objects' for a complete list of types). FUN is
4101 the function called on the matching element or object. It has to
4102 accept one argument: the element or object itself.
4104 When optional argument INFO is non-nil, it should be a plist
4105 holding export options. In that case, parts of the parse tree
4106 not exportable according to that property list will be skipped.
4108 When optional argument FIRST-MATCH is non-nil, stop at the first
4109 match for which FUN doesn't return nil, and return that value.
4111 Optional argument NO-RECURSION is a symbol or a list of symbols
4112 representing elements or objects types. `org-element-map' won't
4113 enter any recursive element or object whose type belongs to that
4114 list. Though, FUN can still be applied on them.
4116 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4117 apply to matching objects within parsed affiliated keywords (see
4118 `org-element-parsed-keywords').
4120 Nil values returned from FUN do not appear in the results.
4123 Examples:
4124 ---------
4126 Assuming TREE is a variable containing an Org buffer parse tree,
4127 the following example will return a flat list of all `src-block'
4128 and `example-block' elements in it:
4132 The following snippet will find the first headline with a level
4136 (lambda (hl)
4137 (and (= (org-element-property :level hl) 1)
4139 (org-element-property :begin hl)))
4140 nil t)
4142 The next example will return a flat list of all `plain-list' type
4143 elements in TREE that are not a sub-list themselves:
4147 Eventually, this example will return a flat list of all `bold'
4148 type objects containing a `latex-snippet' type object, even
4149 looking into captions:
4152 (lambda (b)
4154 nil nil nil t)"
4155 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4159 ;; Recursion depth is determined by --CATEGORY.
4166 ;; If one object is found, the function has
4167 ;; to recurse into every object.
4170 ;; If one regular element is found, the
4171 ;; function has to recurse, at least, into
4172 ;; every element it encounters.
4175 --acc)
4178 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4179 ;; holding contextual information.
4183 ;; Ignored element in an export context.
4185 ;; List of elements or objects.
4187 ;; Unconditionally enter parse trees.
4191 ;; Check if TYPE is matching among TYPES. If so,
4192 ;; apply FUN to --DATA and accumulate return value
4193 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4199 ;; If --DATA has a secondary string that can contain
4200 ;; objects with their type among TYPES, look inside.
4203 org-element-secondary-value-alist)))
4205 ;; If --DATA has any parsed affiliated keywords and
4206 ;; WITH-AFFILIATED is non-nil, look for objects in
4207 ;; them.
4214 ;; Pay attention to the type of parsed
4215 ;; keyword. In particular, preserve order for
4216 ;; multiple keywords.
4229 ;; Determine if a recursion into --DATA is possible.
4231 ;; --TYPE is explicitly removed from recursion.
4233 ;; --DATA has no contents.
4235 ;; Looking for greater elements but --DATA is
4236 ;; simply an element or an object.
4239 ;; Looking for elements but --DATA is an object.
4242 ;; In any other case, map contents.
4246 ;; Return value in a proper order.
4250 ;; The following functions are internal parts of the parser.
4251 ;;
4252 ;; The first one, `org-element--parse-elements' acts at the element's
4253 ;; level.
4254 ;;
4255 ;; The second one, `org-element--parse-objects' applies on all objects
4256 ;; of a paragraph or a secondary string. It calls
4257 ;; `org-element--object-lex' to find the next object in the current
4258 ;; container.
4261 "Return next special mode according to TYPE, or nil.
4262 TYPE is a symbol representing the type of an element or object
4263 containing next element if PARENTP is non-nil, or before it
4264 otherwise. Modes can be either `first-section', `item',
4265 `node-property', `planning', `property-drawer', `section',
4266 `table-row' or nil."
4283 "Parse elements between BEG and END positions.
4285 MODE prioritizes some elements over the others. It can be set to
4286 `first-section', `section', `planning', `item', `node-property'
4287 or `table-row'.
4289 When value is `item', STRUCTURE will be used as the current list
4290 structure.
4292 GRANULARITY determines the depth of the recursion. See
4293 `org-element-parse-buffer' for more information.
4295 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4296 elements.
4298 Elements are accumulated into ACC."
4301 ;; Visible only: skip invisible parts at the beginning of the
4302 ;; element.
4305 ;; When parsing only headlines, skip any text before first one.
4310 ;; Find current element's type and parse it accordingly to
4311 ;; its category.
4313 end granularity mode structure))
4317 ;; Visible only: skip invisible parts between siblings.
4320 ;; Fill ELEMENT contents by side-effect.
4322 ;; If element has no contents, don't modify it.
4324 ;; Greater element: parse it between `contents-begin' and
4325 ;; `contents-end'. Make sure GRANULARITY allows the
4326 ;; recursion, or ELEMENT is a headline, in which case going
4327 ;; inside is mandatory, in order to get sub-level headings.
4335 ;; Possibly switch to a special mode.
4339 granularity visible-only element))
4340 ;; ELEMENT has contents. Parse objects inside, if
4341 ;; GRANULARITY allows it.
4347 ;; Update mode.
4349 ;; Return result.
4353 "Return next object in current buffer or nil.
4354 RESTRICTION is a list of object types, as symbols, that should be
4355 looked after. This function assumes that the buffer is narrowed
4356 to an appropriate container (e.g., a paragraph)."
4366 nil)
4367 ;; Since we moved backward, we do not want to
4368 ;; match again an hypothetical 1-character long
4369 ;; radio link before us. Realizing that this can
4370 ;; only happen if such a radio link starts at
4371 ;; beginning of line, we prevent this here.
4377 found)
4444 ;; This is probably a plain link.
4454 "Parse objects between BEG and END and return recursive structure.
4456 Objects are accumulated in ACC. RESTRICTION is a list of object
4457 successors which are allowed in the current object.
4459 ACC becomes the parent for all parsed objects. However, if ACC
4460 is nil (i.e., a secondary string is being parsed) and optional
4461 argument PARENT is non-nil, use it as the parent for all objects.
4462 Eventually, if both ACC and PARENT are nil, the common parent is
4463 the list of objects itself."
4471 ;; Text before any object.
4476 contents))))
4477 ;; Object...
4482 ;; Fill contents of NEXT-OBJECT if possible.
4484 cont-beg
4486 next-object
4488 next-object)
4489 contents)
4491 ;; Text after last object.
4495 contents)))
4496 ;; Result. Set appropriate parent.
4504 \f
4505 ;;; Towards A Bijective Process
4506 ;;
4507 ;; The parse tree obtained with `org-element-parse-buffer' is really
4508 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4509 ;; interpreted and expanded into a string with canonical Org syntax.
4510 ;; Hence `org-element-interpret-data'.
4511 ;;
4512 ;; The function relies internally on
4513 ;; `org-element--interpret-affiliated-keywords'.
4515 ;;;###autoload
4517 "Interpret DATA as Org syntax.
4518 DATA is a parse tree, an element, an object or a secondary string
4519 to interpret. Return Org syntax as a string."
4523 ;; Find interpreter for current object or
4524 ;; element. If it doesn't exist (e.g. this is
4525 ;; a pseudo object or element), return contents,
4526 ;; if any.
4533 ;; Secondary string.
4536 data
4538 ;; Full Org document.
4543 ;; Plain text: return it.
4545 ;; Element or object without contents.
4548 ;; Element or object with contents.
4551 interpret
4552 data
4553 ;; Recursively interpret contents.
4558 data
4559 ;; Fix indentation of elements containing
4560 ;; objects. We ignore `table-row'
4561 ;; elements as they are one line long
4562 ;; anyway.
4564 data
4565 ;; When normalizing first paragraph of
4566 ;; an item or a footnote-definition,
4567 ;; ignore first line's indentation.
4575 ;; Build white spaces. If no `:post-blank' property
4576 ;; is specified, assume its value is 0.
4586 "Return ELEMENT's affiliated keywords as Org syntax.
4587 If there is no affiliated keyword, return the empty string."
4597 ": "
4600 value)
4608 ;; All attribute keywords can have multiple lines.
4614 ;; List all ELEMENT's properties matching an attribute line or an
4615 ;; affiliated keyword, but ignore translated keywords since they
4616 ;; cannot belong to the property list.
4623 org-element-keyword-translation-alist)))))
4624 collect prop)
4627 ;; Because interpretation of the parse tree must return the same
4628 ;; number of blank lines between elements and the same number of white
4629 ;; space after objects, some special care must be given to white
4630 ;; spaces.
4631 ;;
4632 ;; The first function, `org-element-normalize-string', ensures any
4633 ;; string different from the empty string will end with a single
4634 ;; newline character.
4635 ;;
4636 ;; The second function, `org-element-normalize-contents', removes
4637 ;; global indentation from the contents of the current element.
4640 "Ensure string S ends with a single newline character.
4642 If S isn't a string return it unchanged. If S is the empty
4643 string, return it. Otherwise, return a new string with a single
4644 newline character at its end."
4652 "Normalize plain text in ELEMENT's contents.
4654 ELEMENT must only contain plain text and objects.
4656 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4657 indentation to compute maximal common indentation.
4659 Return the normalized element that is element with global
4660 indentation removed from its contents."
4662 ;; Return minimal common indentation within BLOB. This is
4663 ;; done by walking recursively BLOB and updating MIN-IND
4664 ;; along the way. FIRST-FLAG is non-nil when the next
4665 ;; object is expected to be a string that doesn't start
4666 ;; with a newline character. It happens for strings at
4667 ;; the beginnings of the contents or right after a line
4668 ;; break.
4675 ;; Objects cannot start with spaces: in this
4676 ;; case, indentation is 0.
4699 datum)
4712 ;; Build ELEMENT back, replacing each string with the same
4713 ;; string minus common indentation.
4716 ;; Return DATUM with all its strings indentation
4717 ;; shortened from MIN-IND white spaces.
4737 org-element-recursive-objects)
4741 datum)))
4745 \f
4746 ;;; Cache
4747 ;;
4748 ;; Implement a caching mechanism for `org-element-at-point' and
4749 ;; `org-element-context', which see.
4750 ;;
4751 ;; A single public function is provided: `org-element-cache-reset'.
4752 ;;
4753 ;; Cache is enabled by default, but can be disabled globally with
4754 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4755 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4756 ;; can be tweaked to control caching behaviour.
4757 ;;
4758 ;; Internally, parsed elements are stored in an AVL tree,
4759 ;; `org-element--cache'. This tree is updated lazily: whenever
4760 ;; a change happens to the buffer, a synchronization request is
4761 ;; registered in `org-element--cache-sync-requests' (see
4762 ;; `org-element--cache-submit-request'). During idle time, requests
4763 ;; are processed by `org-element--cache-sync'. Synchronization also
4764 ;; happens when an element is required from the cache. In this case,
4765 ;; the process stops as soon as the needed element is up-to-date.
4766 ;;
4767 ;; A synchronization request can only apply on a synchronized part of
4768 ;; the cache. Therefore, the cache is updated at least to the
4769 ;; location where the new request applies. Thus, requests are ordered
4770 ;; from left to right and all elements starting before the first
4771 ;; request are correct. This property is used by functions like
4772 ;; `org-element--cache-find' to retrieve elements in the part of the
4773 ;; cache that can be trusted.
4774 ;;
4775 ;; A request applies to every element, starting from its original
4776 ;; location (or key, see below). When a request is processed, it
4777 ;; moves forward and may collide the next one. In this case, both
4778 ;; requests are merged into a new one that starts from that element.
4779 ;; As a consequence, the whole synchronization complexity does not
4780 ;; depend on the number of pending requests, but on the number of
4781 ;; elements the very first request will be applied on.
4782 ;;
4783 ;; Elements cannot be accessed through their beginning position, which
4784 ;; may or may not be up-to-date. Instead, each element in the tree is
4785 ;; associated to a key, obtained with `org-element--cache-key'. This
4786 ;; mechanism is robust enough to preserve total order among elements
4787 ;; even when the tree is only partially synchronized.
4788 ;;
4789 ;; Objects contained in an element are stored in a hash table,
4790 ;; `org-element--cache-objects'.
4794 "Non nil when Org parser should cache its results.
4801 "Maximum duration, as a time value, for a cache synchronization.
4802 If the synchronization is not over after this delay, the process
4803 pauses and resumes after `org-element-cache-sync-break'
4807 "Duration, as a time value, of the pause between synchronizations.
4811 ;;;; Data Structure
4814 "AVL tree used to cache elements.
4815 Each node of the tree contains an element. Comparison is done
4816 with `org-element--cache-compare'. This cache is used in
4820 "Hash table used as to cache objects.
4821 Key is an element, as returned by `org-element-at-point', and
4822 value is an alist where each association is:
4824 (PARENT COMPLETEP . OBJECTS)
4826 where PARENT is an element or object, COMPLETEP is a boolean,
4827 non-nil when all direct children of parent are already cached and
4828 OBJECTS is a list of such children, as objects, from farthest to
4829 closest.
4832 contained within a paragraph
4836 If the paragraph is completely parsed, OBJECTS-DATA will be
4838 ((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4839 (BOLD-OBJECT t ENTITY-OBJECT))
4841 whereas in a partially parsed paragraph, it could be
4843 ((PARAGRAPH nil ENTITY-OBJECT))
4848 "List of pending synchronization requests.
4850 A request is a vector with the following pattern:
4852 \[NEXT BEG END OFFSET PARENT PHASE]
4854 Processing a synchronization request consists of three phases:
4856 0. Delete modified elements,
4857 1. Fill missing area in cache,
4858 2. Shift positions and re-parent elements after the changes.
4860 During phase 0, NEXT is the key of the first element to be
4861 removed, BEG and END is buffer position delimiting the
4862 modifications. Elements starting between them (inclusive) are
4863 removed. So are elements whose parent is removed. PARENT, when
4864 non-nil, is the parent of the first element to be removed.
4866 During phase 1, NEXT is the key of the next known element in
4867 cache and BEG its beginning position. Parse buffer between that
4868 element and the one before it in order to determine the parent of
4869 the next element. Set PARENT to the element containing NEXT.
4871 During phase 2, NEXT is the key of the next element to shift in
4872 the parse tree. All elements starting from this one have their
4873 properties relatives to buffer positions shifted by integer
4874 OFFSET and, if they belong to element PARENT, are adopted by it.
4882 "Hash table used to store keys during synchronization.
4886 "Return a unique key for ELEMENT in cache tree.
4888 Keys are used to keep a total order among elements in the cache.
4889 Comparison is done with `org-element--cache-key-less-p'.
4891 When no synchronization is taking place, a key is simply the
4892 beginning position of the element, or that position plus one in
4893 the case of an first item (respectively row) in
4894 a list (respectively a table).
4896 During a synchronization, the key is the one the element had when
4897 the cache was synchronized for the last time. Elements added to
4898 cache during the synchronization get a new key generated with
4899 `org-element--cache-generate-key'.
4901 Such keys are stored in `org-element--cache-sync-keys'. The hash
4902 table is cleared once the synchronization is complete."
4905 ;; Increase beginning position of items (respectively
4906 ;; table rows) by one, so the first item can get
4907 ;; a different key from its parent list (respectively
4908 ;; table).
4911 begin)))
4914 key))))
4917 "Generate a key between LOWER and UPPER.
4919 LOWER and UPPER are integers or lists, possibly empty.
4921 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4922 a unique key, as an integer or a list of integers, according to
4923 the following rules:
4925 - LOWER and UPPER are compared level-wise until values differ.
4927 - If, at a given level, LOWER and UPPER differ from more than
4928 2, the new key shares all the levels above with LOWER and
4929 gets a new level. Its value is the mean between LOWER and
4930 UPPER:
4932 (1 2) + (1 4) --> (1 3)
4934 - If LOWER has no value to compare with, it is assumed that its
4935 value is `most-negative-fixnum'. E.g.,
4937 (1 1) + (1 1 2)
4939 is equivalent to
4941 (1 1 m) + (1 1 2)
4943 where m is `most-negative-fixnum'. Likewise, if UPPER is
4944 short of levels, the current value is `most-positive-fixnum'.
4946 - If they differ from only one, the new key inherits from
4947 current LOWER level and fork it at the next level. E.g.,
4949 (2 1) + (3 3)
4951 is equivalent to
4953 (2 1) + (2 M)
4955 where M is `most-positive-fixnum'.
4957 - If the key is only one level long, it is returned as an
4958 integer:
4960 (1 2) + (3 2) --> 2
4962 When they are not equals, the function assumes that LOWER is
4963 lesser than UPPER, per `org-element--cache-key-less-p'."
4967 skip-upper key)
4978 ;; When at a given level, LOWER and UPPER differ from
4979 ;; 1, ignore UPPER altogether. Instead create a key
4980 ;; between LOWER and the greatest key with the same
4981 ;; prefix as LOWER so far.
4987 "Non-nil if key A is less than key B.
4988 A and B are either integers or lists of integers, as returned by
4989 `org-element--cache-key'."
4997 ;; If A is empty, either keys are equal (B is also empty) and
4998 ;; we return nil, or A is lesser than B (B is longer) and we
4999 ;; return a non-nil value.
5000 ;;
5001 ;; If A is not empty, B is necessarily empty and A is greater
5002 ;; than B (A is longer). Therefore, return nil.
5006 "Non-nil when element A is located before element B."
5011 "Return root value in cache.
5012 This function assumes `org-element--cache' is a valid AVL tree."
5016 ;;;; Tools
5019 "Non-nil when cache is active in current buffer."
5021 org-element--cache
5025 "Find element in cache starting at POS or before.
5027 POS refers to a buffer position.
5029 When optional argument SIDE is non-nil, the function checks for
5030 elements starting at or past POS instead. If SIDE is `both', the
5031 function returns a cons cell where car is the first element
5032 starting at or before POS and cdr the first element starting
5033 after POS.
5035 The function can only find elements in the synchronized part of
5036 the cache."
5040 lower upper)
5055 ;; We found an element in cache starting at POS. If `side'
5056 ;; is `both' we also want the next one in order to generate
5057 ;; a key in-between.
5058 ;;
5059 ;; If the element is the first row or item in a table or
5060 ;; a plain list, we always return the table or the plain
5061 ;; list.
5062 ;;
5063 ;; In any other case, we return the element found.
5072 lower parent
5073 upper parent)))))
5076 lower element
5077 upper element)))))
5084 "Store ELEMENT in current buffer's cache, if allowed.
5085 When optional argument DATA is non-nil, assume is it object data
5086 relative to ELEMENT and store it in the objects cache."
5090 ;; During synchronization, first build an appropriate key
5091 ;; for the new element so `avl-tree-enter' can insert it at
5092 ;; the right spot in the cache.
5101 org-element--cache-sync-keys)))
5103 ;; Headlines are not stored in cache, so objects in titles are
5104 ;; not stored either.
5109 "Remove ELEMENT from cache.
5110 Assume ELEMENT belongs to cache and that a cache is active."
5115 ;;;; Synchronization
5118 "Set idle timer for cache synchronization in BUFFER."
5125 org-element-cache-sync-idle-time))
5126 nil
5127 #'org-element--cache-sync
5128 buffer)))
5131 "Non-nil when synchronization process should be interrupted.
5132 TIME-LIMIT is a time value or nil."
5138 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5140 Properties containing buffer positions are `:begin', `:end',
5141 `:contents-begin', `:contents-end' and `:structure'. When
5142 optional argument PROPS is a list of keywords, only shift
5143 properties provided in that list.
5145 Properties are modified by side-effect."
5147 ;; Shift `:structure' property for the first plain list only: it
5148 ;; is the only one that really matters and it prevents from
5149 ;; shifting it more than once.
5163 "Synchronize cache with recent modification in BUFFER.
5165 When optional argument THRESHOLD is non-nil, do the
5166 synchronization for all elements starting before or at threshold,
5167 then exit. Otherwise, synchronize cache for as long as
5168 `org-element-cache-sync-duration' or until Emacs leaves idle
5169 state.
5171 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5172 not registered yet in the cache are going to happen. It is used
5173 in `org-element--cache-submit-request', where cache is partially
5174 updated before current modification are actually submitted."
5185 request
5187 threshold
5190 org-element-cache-sync-duration))
5191 future-change)
5192 ;; Request processed. Merge current and next offsets and
5193 ;; transfer ending position.
5199 ;; If more requests are awaiting, set idle timer accordingly.
5200 ;; Otherwise, reset keys.
5207 "Process synchronization REQUEST for all entries before NEXT.
5209 REQUEST is a vector, built by `org-element--cache-submit-request'.
5211 NEXT is a cache key, as returned by `org-element--cache-key'.
5213 When non-nil, THRESHOLD is a buffer position. Synchronization
5214 stops as soon as a shifted element begins after it.
5216 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5217 after this time or when Emacs exits idle state.
5219 When non-nil, FUTURE-CHANGE is a buffer position where changes
5220 not registered yet in the cache are going to happen. See
5221 `org-element--cache-submit-request' for more information.
5223 Throw `interrupt' if the process stops before completing the
5224 request."
5227 ;; Phase 0.
5228 ;;
5229 ;; Delete all elements starting after BEG, but not after buffer
5230 ;; position END or past element with key NEXT. Also delete
5231 ;; elements contained within a previously removed element
5232 ;; (stored in `last-container').
5233 ;;
5234 ;; At each iteration, we start again at tree root since
5235 ;; a deletion modifies structure of the balanced tree.
5240 ;; Find first element in cache with key BEG or after it.
5244 data data-key last-container)
5253 data-key key
5256 data-key key
5257 node nil)))))
5267 up)))
5270 end))
5277 ;; No element starting after modifications left in
5278 ;; cache: further processing is futile.
5281 ;; Phase 1.
5282 ;;
5283 ;; Phase 0 left a hole in the cache. Some elements after it
5284 ;; could have parents within. For example, in the following
5285 ;; buffer:
5286 ;;
5287 ;; - item
5288 ;;
5289 ;;
5290 ;; Paragraph1
5291 ;;
5292 ;; Paragraph2
5293 ;;
5294 ;; if we remove a blank line between "item" and "Paragraph1",
5295 ;; everything down to "Paragraph2" is removed from cache. But
5296 ;; the paragraph now belongs to the list, and its `:parent'
5297 ;; property no longer is accurate.
5298 ;;
5299 ;; Therefore we need to parse again elements in the hole, or at
5300 ;; least in its last section, so that we can re-parent
5301 ;; subsequent elements, during phase 2.
5302 ;;
5303 ;; Note that we only need to get the parent from the first
5304 ;; element in cache after the hole.
5305 ;;
5306 ;; When next key is lesser or equal to the current one, delegate
5307 ;; phase 1 processing to next request in order to preserve key
5308 ;; order among requests.
5316 ;; Next element will start at its beginning position plus
5317 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5318 ;; contains the real beginning position of the first element to
5319 ;; shift and re-parent.
5323 ;; Changes are going to happen around this element and
5324 ;; they will trigger another phase 1 request. Skip the
5325 ;; current one.
5331 ;; Phase 2.
5332 ;;
5333 ;; Shift all elements starting from key START, but before NEXT, by
5334 ;; OFFSET, and re-parent them when appropriate.
5335 ;;
5336 ;; Elements are modified by side-effect so the tree structure
5337 ;; remains intact.
5338 ;;
5339 ;; Once THRESHOLD, if any, is reached, or once there is an input
5340 ;; pending, exit. Before leaving, the current synchronization
5341 ;; request is updated.
5348 exit-flag)
5349 ;; No re-parenting nor shifting planned: request is over.
5359 ;; We reached NEXT. Request is complete.
5361 ;; Handle interruption request. Update current request.
5366 ;; Shift element.
5369 ;; Shift associated objects data, if any.
5374 ;; Update PARENT and re-parent DATA, only when
5375 ;; necessary. Propagate new structures for lists.
5389 ;; Cache is up-to-date past THRESHOLD. Request
5390 ;; interruption.
5395 ;; We reached end of tree: synchronization complete.
5396 t)))
5399 "Parse elements in current section, down to POS.
5401 Start parsing from the closest between the last known element in
5402 cache or headline above. Return the smallest element containing
5403 POS.
5405 When optional argument SYNCP is non-nil, return the parent of the
5406 element containing POS instead. In that case, it is also
5407 possible to provide TIME-LIMIT, which is a time value specifying
5408 when the parsing should stop. The function throws `interrupt' if
5409 the process stopped before finding the expected result."
5416 element next mode)
5418 ;; Nothing in cache before point: start parsing from first
5419 ;; element following headline above, or first element in
5420 ;; buffer.
5427 ;; Cache returned exact match: return it.
5430 ;; There's a headline between cached value and POS: cached
5431 ;; value is invalid. Start parsing from first element
5432 ;; following the headline.
5439 ;; Check if CACHED or any of its ancestors contain point.
5440 ;;
5441 ;; If there is such an element, we inspect it in order to know
5442 ;; if we return it or if we need to parse its contents.
5443 ;; Otherwise, we just start parsing from current location,
5444 ;; which is right after the top-most element containing
5445 ;; CACHED.
5446 ;;
5447 ;; As a special case, if POS is at the end of the buffer, we
5448 ;; want to return the innermost element ending there.
5449 ;;
5450 ;; Also, if we find an ancestor and discover that we need to
5451 ;; parse its contents, make sure we don't start from
5452 ;; `:contents-begin', as we would otherwise go past CACHED
5453 ;; again. Instead, in that situation, we will resume parsing
5454 ;; from NEXT, which is located after CACHED or its higher
5455 ;; ancestor not containing point.
5467 ;; Parse successively each element until we reach POS.
5480 end 'element mode
5487 ;; Skip any element ending before point. Also skip
5488 ;; element ending at point (unless it is also the end of
5489 ;; buffer) since we're sure that another element begins
5490 ;; after it.
5494 ;; A non-greater element contains point: return it.
5497 ;; Otherwise, we have to decide if ELEMENT really
5498 ;; contains POS. In that case we start parsing from
5499 ;; contents' beginning.
5500 ;;
5501 ;; If POS is at contents' beginning but it is also at
5502 ;; the beginning of the first item in a list or a table.
5503 ;; In that case, we need to create an anchor for that
5504 ;; list or table, so return it.
5505 ;;
5506 ;; Also, if POS is at the end of the buffer, no element
5507 ;; can start after it, but more than one may end there.
5508 ;; Arbitrarily, we choose to return the innermost of
5509 ;; such elements.
5522 parent element
5523 end cend))))
5524 ;; Otherwise, return ELEMENT as it is the smallest
5525 ;; element containing POS.
5530 ;;;; Staging Buffer Changes
5541 "Regexp matching a sensitive line, structure wise.
5542 A sensitive line is a headline, inlinetask, block, drawer, or
5543 latex-environment boundary. When such a line is modified,
5544 structure changes in the document may propagate in the whole
5548 "Non-nil when a sensitive line is about to be changed.
5552 "Request extension of area going to be modified if needed.
5553 BEG and END are the beginning and end of the range of changed
5554 text. See `before-change-functions' for more information."
5564 'headline
5567 org-element--cache-sensitive-re bottom t)))))))))
5570 "Update buffer modifications for current buffer.
5571 BEG and END are the beginning and end of the range of changed
5572 text, and the length in bytes of the pre-change text replaced by
5573 that range. See `after-change-functions' for more information."
5581 ;; Determine if modified area needs to be extended, according
5582 ;; to both previous and current state. We make a special
5583 ;; case for headline editing: if a headline is modified but
5584 ;; not removed, do not extend.
5587 (`headline
5593 org-element--cache-sensitive-re bottom t))))
5594 ;; Effectively extend modified area.
5602 ;; Store synchronization request.
5605 ;; Activate a timer to process the request during idle time.
5609 "Return first element to remove from cache.
5611 BEG and END are buffer positions delimiting buffer modifications.
5612 OFFSET is the size of the changes.
5614 Returned element is usually the first element in cache containing
5615 any position between BEG and END. As an exception, greater
5616 elements around the changes that are robust to contents
5617 modifications are preserved and updated according to the
5618 changes."
5628 special-block))
5629 ;; Drawers named "PROPERTIES" are probably
5630 ;; a properties drawer being edited. Force
5631 ;; parsing to check if editing is over.
5640 ;; UP is a robust greater element containing changes.
5641 ;; We only need to extend its ending boundaries.
5647 ;; We're at top level element containing ELEMENT: if it's
5648 ;; altered by buffer modifications, it is first element in
5649 ;; cache to be removed. Otherwise, that first element is the
5650 ;; following one.
5651 ;;
5652 ;; As a special case, do not remove BEFORE if it is a robust
5653 ;; container for current changes.
5655 before)))))
5658 "Submit a new cache synchronization request for current buffer.
5659 BEG and END are buffer positions delimiting the minimal area
5660 where cache data should be removed. OFFSET is the size of the
5661 change, as an integer."
5663 delete-to delete-from)
5668 ;; Current changes can be merged with first sync request: we
5669 ;; can save a partial cache synchronization.
5672 ;; If last change happened within area to be removed, extend
5673 ;; boundaries of robust parents, if any. Otherwise, find
5674 ;; first element to remove and update request accordingly.
5686 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5687 ;; if any, is no longer a 0-phase request, thus ensuring that
5688 ;; phases are properly ordered. We need to provide OFFSET as
5689 ;; optional parameter since current modifications are not known
5690 ;; yet to the otherwise correct part of the cache (i.e, before
5691 ;; the first request).
5698 ;; When changes happen before the first known
5699 ;; element, re-parent and shift the rest of the
5700 ;; cache.
5702 ;; Otherwise, we find the first non robust
5703 ;; element containing END. All elements between
5704 ;; FIRST and this one are to be removed.
5715 element up))
5717 org-element--cache-sync-requests)
5718 ;; No element to remove. No need to re-parent either.
5719 ;; Simply shift additional elements, if any, by OFFSET.
5722 offset)))))))
5725 ;;;; Public Functions
5727 ;;;###autoload
5729 "Reset cache in current buffer.
5730 When optional argument ALL is non-nil, reset cache in all Org
5731 buffers."
5749 ;;;###autoload
5751 "Refresh cache at position POS."
5758 \f
5759 ;;; The Toolbox
5760 ;;
5761 ;; The first move is to implement a way to obtain the smallest element
5762 ;; containing point. This is the job of `org-element-at-point'. It
5763 ;; basically jumps back to the beginning of section containing point
5764 ;; and proceed, one element after the other, with
5765 ;; `org-element--current-element' until the container is found. Note:
5766 ;; When using `org-element-at-point', secondary values are never
5767 ;; parsed since the function focuses on elements, not on objects.
5768 ;;
5769 ;; At a deeper level, `org-element-context' lists all elements and
5770 ;; objects containing point.
5771 ;;
5772 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5773 ;; internally by navigation and manipulation tools.
5776 ;;;###autoload
5778 "Determine closest element around point.
5780 Return value is a list like (TYPE PROPS) where TYPE is the type
5781 of the element and PROPS a plist of properties associated to the
5782 element.
5784 Possible types are defined in `org-element-all-elements'.
5785 Properties depend on element or object type, but always include
5786 `:begin', `:end', `:parent' and `:post-blank' properties.
5788 As a special case, if point is at the very beginning of the first
5789 item in a list or sub-list, returned element will be that list
5790 instead of the item. Likewise, if point is at the beginning of
5791 the first row of a table, returned element will be the table
5792 instead of the first row.
5794 When point is at the end of the buffer, return the innermost
5795 element ending there."
5801 ;; Within blank lines at the beginning of buffer, return nil.
5803 ;; Within blank lines right after a headline, return that
5804 ;; headline.
5808 ;; Otherwise parse until we find element containing ORIGIN.
5815 ;;;###autoload
5817 "Return smallest element or object around point.
5819 Return value is a list like (TYPE PROPS) where TYPE is the type
5820 of the element or object and PROPS a plist of properties
5821 associated to it.
5823 Possible types are defined in `org-element-all-elements' and
5824 `org-element-all-objects'. Properties depend on element or
5825 object type, but always include `:begin', `:end', `:parent' and
5826 `:post-blank'.
5828 As a special case, if point is right after an object and not at
5829 the beginning of any other object, return that object.
5831 Optional argument ELEMENT, when non-nil, is the closest element
5832 containing point, as returned by `org-element-at-point'.
5833 Providing it allows for quicker computation."
5840 ;; If point is inside an element containing objects or
5841 ;; a secondary string, narrow buffer to the container and
5842 ;; proceed with parsing. Otherwise, return ELEMENT.
5844 ;; At a parsed affiliated keyword, check if we're inside main
5845 ;; or dual value.
5851 org-element-parsed-keywords))
5860 ;; Also change type to retrieve correct restrictions.
5862 ;; At an item, objects can only be located within tag, if any.
5873 ;; At an headline or inlinetask, objects are in title.
5885 ;; At a paragraph, a table-row or a verse block, objects are
5886 ;; located within their contents.
5890 ;; CBEG is nil for table rules.
5895 ;; At a planning line, if point is at a timestamp, return it,
5896 ;; otherwise, return element.
5904 ;; All other locations cannot contain objects: bail out.
5914 next object-data last)
5918 ;; When entering PARENT for the first time, get list
5919 ;; of objects within known so far. Store it in
5920 ;; OBJECT-DATA.
5925 ;; Find NEXT object for analysis.
5927 ;; If NEXT is non-nil, we already exhausted the
5928 ;; cache so we can parse buffer to find the object
5929 ;; after it.
5931 ;; Otherwise, check if cache can help us.
5942 ;; Cache contains the information needed.
5945 pos)
5947 pos)
5953 ;; If we have a new object to analyze, store it in
5954 ;; cache. Otherwise record that there is nothing
5955 ;; more to parse in this element at this depth.
5960 ;; Process NEXT, if any, in order to know if we need
5961 ;; to skip it, return it or move into it.
5968 ;; Skip objects ending before point. Also skip
5969 ;; objects ending at point unless it is also the
5970 ;; end of buffer, since we want to return the
5971 ;; innermost object.
5974 ;; For convenience, when object ends at POS,
5975 ;; without any space, store it in LAST, as we
5976 ;; will return it if no object starts here.
5980 ;; If POS is within a container object, move
5981 ;; into that object.
5985 ;; At contents' end, if there is no
5986 ;; space before point, also move into
5987 ;; object, for consistency with
5988 ;; convenience feature above.
5997 next nil
5998 object-data nil))
5999 ;; Otherwise, return NEXT.
6001 ;; Store results in cache, if applicable.
6005 "List all ancestors of a given element or object.
6007 BLOB is an object or element.
6009 When optional argument TYPES is a list of symbols, return the
6010 first element or object in the lineage whose type belongs to that
6011 list.
6013 When optional argument WITH-SELF is non-nil, lineage includes
6014 BLOB itself as the first element, and TYPES, if provided, also
6015 apply to it.
6017 When BLOB is obtained through `org-element-context' or
6018 `org-element-at-point', only ancestors from its section can be
6019 found. There is no such limitation when BLOB belongs to a full
6020 parse tree."
6022 ancestors)
6029 "Non-nil when elements ELEM-A and ELEM-B are nested."
6038 "Swap elements ELEM-A and ELEM-B.
6039 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6040 end of ELEM-A."
6042 ;; There are two special cases when an element doesn't start at bol:
6043 ;; the first paragraph in an item or in a footnote definition.
6045 ;; Only a paragraph without any affiliated keyword can be moved at
6046 ;; ELEM-A position in such a situation. Note that the case of
6047 ;; a footnote definition is impossible: it cannot contain two
6048 ;; paragraphs in a row because it cannot contain a blank line.
6054 ;; In a special situation, ELEM-A will have no indentation. We'll
6055 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6069 ;; Store inner overlays responsible for visibility status.
6070 ;; We also need to store their boundaries as they will be
6071 ;; removed from buffer.
6086 ;; Get contents.
6094 ;; Restore ex ELEM-A overlays.
6101 ;; Restore ex ELEM-B overlays.
6109 ;; Local variables:
6110 ;; generated-autoload-file: "org-loaddefs.el"
6111 ;; End:
6113 ;;; org-element.el ends here