| blob | eace06708282232ea4983e90ea09844945526539 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2015 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:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; `org-element-update-syntax' builds proper syntax regexps according
131 ;; to current setup.
134 "Regexp to separate paragraphs in an Org buffer.
136 is not sufficient to know if point is at a paragraph ending. See
140 "Regexp possibly matching the beginning of an object.
141 This regexp allows false positives. Dedicated parser (e.g.,
142 `org-export-bold-parser') will take care of further filtering.
143 Radio links are not matched by this regexp, as they are treated
147 "Build variable syntax regexps."
150 ;; Headlines, inlinetasks.
152 ;; Footnote definitions.
154 ;; Diary sexps.
157 ;; Empty lines.
159 ;; Tables (any type).
162 ;; Comments, keyword-like or block-like constructs.
163 ;; Blocks and keywords with dual values need to be
164 ;; double-checked.
169 ;; Drawers (any type) and fixed-width areas. Drawers
170 ;; need to be double-checked.
172 ;; Horizontal rules.
174 ;; LaTeX environments.
176 ;; Clock lines.
178 ;; Lists.
185 org-element--object-regexp
189 ;; Sub/superscript.
191 ;; Bold, code, italic, strike-through, underline
192 ;; and verbatim.
196 ;; Plain links.
198 ;; Objects starting with "[": regular link,
199 ;; footnote reference, statistics cookie,
200 ;; timestamp (inactive).
202 ;; Objects starting with "@": export snippets.
203 "@@"
204 ;; Objects starting with "{": macro.
205 "{{{"
206 ;; Objects starting with "<" : timestamp
207 ;; (active, diary), target, radio target and
208 ;; angular links.
210 ;; Objects starting with "$": latex fragment.
212 ;; Objects starting with "\": line break,
213 ;; entity, latex fragment.
215 ;; Objects starting with raw text: inline Babel
216 ;; source block, inline Babel call.
222 ;;;###autoload
224 "Update parser internals."
231 dynamic-block example-block export-block fixed-width
232 footnote-definition headline horizontal-rule inlinetask item
233 keyword latex-environment node-property paragraph plain-list
234 planning property-drawer quote-block section
235 special-block src-block table table-row verse-block)
240 item plain-list property-drawer quote-block section
241 special-block table)
246 inline-src-block italic line-break latex-fragment link macro
247 radio-target statistics-cookie strike-through subscript superscript
248 table-cell target timestamp underline verbatim)
253 superscript table-cell underline)
267 "Alist between block names and the associated parsing function.
268 Names must be uppercase. Any block whose name has no association
274 "List of affiliated keywords as strings.
282 "Alist of usual translations for keywords.
283 The key is the old name and the value the new one. The property
287 "List of affiliated keywords that can occur more than once in an element.
289 Their value will be consed into a list of strings, which will be
290 returned as the value of the property.
292 This list is checked after translations have been applied. See
293 `org-element-keyword-translation-alist'.
299 "List of affiliated keywords whose value can be parsed.
301 Their value will be stored as a secondary string: a list of
302 strings and objects.
304 This list is checked after translations have been applied. See
309 org-element-parsed-keywords)
310 "Alist of parsed keywords and associated properties.
311 This is generated from `org-element-parsed-keywords', which
315 "List of affiliated keywords which can have a secondary value.
317 In Org syntax, they can be written with optional square brackets
318 before the colons. For example, RESULTS keyword can be
319 associated to a hash value with the following:
321 #+RESULTS[hash-string]: some-source
323 This list is checked after translations have been applied. See
329 ;; Dual affiliated keywords.
333 ;; Regular affiliated keywords.
338 org-element-affiliated-keywords)))
340 ;; Export attributes.
342 "Regexp matching any affiliated keyword.
344 Keyword name is put in match group 1. Moreover, if keyword
345 belongs to `org-element-dual-keywords', put the dual value in
346 match group 2.
360 ;; Ignore all links excepted plain links in a link description.
361 ;; Also ignore radio-targets and line breaks.
363 italic latex-fragment macro plain-link statistics-cookie
364 strike-through subscript superscript underline verbatim)
366 ;; Remove any variable object from radio target as it would
367 ;; prevent it from being properly recognized.
369 subscript superscript underline superscript)
373 ;; Ignore inline babel call and inline src block as formulas are
374 ;; possible. Also ignore line breaks and statistics cookies.
376 latex-fragment link macro radio-target strike-through
377 subscript superscript target timestamp underline verbatim)
381 "Alist of objects restrictions.
383 key is an element or object type containing objects and value is
384 a list of types that can be contained within an element or object
385 of such type.
387 For example, in a `radio-target' object, one can only find
388 entities, latex-fragments, subscript, superscript and text
389 markup.
391 This alist also applies to secondary string. For example, an
392 `headline' type element doesn't directly contain objects, but
407 "Table used internally to pair only square brackets.
411 \f
412 ;;; Accessors and Setters
413 ;;
414 ;; Provide four accessors: `org-element-type', `org-element-property'
415 ;; `org-element-contents' and `org-element-restriction'.
416 ;;
417 ;; Setter functions allow to modify elements by side effect. There is
418 ;; `org-element-put-property', `org-element-set-contents'. These
419 ;; low-level functions are useful to build a parse tree.
420 ;;
421 ;; `org-element-adopt-element', `org-element-set-element',
422 ;; `org-element-extract-element' and `org-element-insert-before' are
423 ;; high-level functions useful to modify a parse tree.
424 ;;
425 ;; `org-element-secondary-p' is a predicate used to know if a given
426 ;; object belongs to a secondary string. `org-element-copy' returns
427 ;; an element or object, stripping its parent property in the process.
430 "Return type of ELEMENT.
432 The function returns the type of the element or object provided.
433 It can also return the following special value:
434 `plain-text' for a string
435 `org-data' for a complete document
436 nil in any other case."
442 "Extract the value from the PROPERTY of an ELEMENT."
447 "Extract contents from an ELEMENT."
453 "Return restriction associated to ELEMENT.
454 ELEMENT can be an element, an object or a symbol representing an
455 element or object type."
457 org-element-object-restrictions)))
460 "In ELEMENT set PROPERTY to VALUE.
461 Return modified element."
464 element))
467 "Set ELEMENT contents to CONTENTS."
474 "Non-nil when OBJECT directly belongs to a secondary string.
475 Return value is the property name, as a keyword, or nil."
478 org-element-secondary-value-alist))))
485 "Append elements to the contents of another element.
487 PARENT is an element or object. CHILDREN can be elements,
488 objects, or a strings.
490 The function takes care of setting `:parent' property for CHILD.
491 Return parent element."
493 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
494 ;; string: parent is the list itself.
497 ;; Add CHILDREN at the end of PARENT contents.
500 parent
502 ;; Return modified PARENT element.
506 "Extract ELEMENT from parse tree.
507 Remove element from the parse tree by side-effect, and return it
508 with its `:parent' property stripped out."
513 parent secondary
516 parent
518 ;; Return ELEMENT with its :parent removed.
522 "Insert ELEMENT before LOCATION in parse tree.
523 LOCATION is an element, object or string within the parse tree.
524 Parse tree is modified by side effect."
529 ;; Special case: LOCATION is the first element of an
530 ;; independent secondary string (e.g. :title property). Add
531 ;; ELEMENT in-place.
535 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
545 ;; Store SIBLINGS at appropriate place in parse tree.
550 ;; Set appropriate :parent property.
554 "Replace element or object OLD with element or object NEW.
555 The function takes care of setting `:parent' property for NEW."
556 ;; Ensure OLD and NEW have the same parent.
560 ;; We cannot replace OLD with NEW since one of them is not an
561 ;; object or element. We take the long path.
564 ;; Since OLD is going to be changed into NEW by side-effect, first
565 ;; make sure that every element or object within NEW has OLD as
566 ;; parent.
569 ;; Transfer contents.
571 ;; Overwrite OLD's properties with NEW's.
573 ;; Transfer type.
577 "Create a new element of type TYPE.
578 Optional argument PROPS, when non-nil, is a plist defining the
579 properties of the element. CHILDREN can be elements, objects or
580 strings."
584 "Return a copy of DATUM.
585 DATUM is an element, object, string or nil. `:parent' property
586 is cleared and contents are removed in the process."
597 \f
598 ;;; Greater elements
599 ;;
600 ;; For each greater element type, we define a parser and an
601 ;; interpreter.
602 ;;
603 ;; A parser returns the element or object as the list described above.
604 ;; Most of them accepts no argument. Though, exceptions exist. Hence
605 ;; every element containing a secondary string (see
606 ;; `org-element-secondary-value-alist') will accept an optional
607 ;; argument to toggle parsing of these secondary strings. Moreover,
608 ;; `item' parser requires current list's structure as its first
609 ;; element.
610 ;;
611 ;; An interpreter accepts two arguments: the list representation of
612 ;; the element or object, and its contents. The latter may be nil,
613 ;; depending on the element or object considered. It returns the
614 ;; appropriate Org syntax, as a string.
615 ;;
616 ;; Parsing functions must follow the naming convention:
617 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
618 ;; defined in `org-element-greater-elements'.
619 ;;
620 ;; Similarly, interpreting functions must follow the naming
621 ;; convention: org-element-TYPE-interpreter.
622 ;;
623 ;; With the exception of `headline' and `item' types, greater elements
624 ;; cannot contain other greater elements of their own type.
625 ;;
626 ;; Beside implementing a parser and an interpreter, adding a new
627 ;; greater element requires to tweak `org-element--current-element'.
628 ;; Moreover, the newly defined type must be added to both
629 ;; `org-element-all-elements' and `org-element-greater-elements'.
632 ;;;; Center Block
635 "Parse a center block.
637 LIMIT bounds the search. AFFILIATED is a list of which CAR is
638 the buffer position at the beginning of the first affiliated
639 keyword and CDR is a plist of affiliated keywords along with
640 their value.
642 Return a list whose CAR is `center-block' and CDR is a plist
643 containing `:begin', `:end', `:contents-begin', `:contents-end',
644 `:post-blank' and `:post-affiliated' keywords.
646 Assume point is at the beginning of the block."
650 ;; Incomplete block: parse it as a paragraph.
655 ;; Empty blocks have no contents.
669 :end end
670 :contents-begin contents-begin
671 :contents-end contents-end
677 "Interpret a center-block element as Org syntax.
678 CONTENTS is the contents of the element."
682 ;;;; Drawer
685 "Parse a drawer.
687 LIMIT bounds the search. AFFILIATED is a list of which CAR is
688 the buffer position at the beginning of the first affiliated
689 keyword and CDR is a plist of affiliated keywords along with
690 their value.
692 Return a list whose CAR is `drawer' and CDR is a plist containing
693 `:drawer-name', `:begin', `:end', `:contents-begin',
694 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
696 Assume point is at beginning of drawer."
699 ;; Incomplete drawer: parse it as a paragraph.
707 ;; Empty drawers have no contents.
720 :end end
721 :drawer-name name
722 :contents-begin contents-begin
723 :contents-end contents-end
729 "Interpret DRAWER element as Org syntax.
730 CONTENTS is the contents of the element."
733 contents))
736 ;;;; Dynamic Block
739 "Parse a dynamic block.
741 LIMIT bounds the search. AFFILIATED is a list of which CAR is
742 the buffer position at the beginning of the first affiliated
743 keyword and CDR is a plist of affiliated keywords along with
744 their value.
746 Return a list whose CAR is `dynamic-block' and CDR is a plist
747 containing `:block-name', `:begin', `:end', `:contents-begin',
748 `:contents-end', `:arguments', `:post-blank' and
749 `:post-affiliated' keywords.
751 Assume point is at beginning of dynamic block."
755 ;; Incomplete block: parse it as a paragraph.
764 ;; Empty blocks have no contents.
777 :end end
778 :block-name name
779 :arguments arguments
780 :contents-begin contents-begin
781 :contents-end contents-end
787 "Interpret DYNAMIC-BLOCK element as Org syntax.
788 CONTENTS is the contents of the element."
793 contents))
796 ;;;; Footnote Definition
799 "Parse a footnote definition.
801 LIMIT bounds the search. AFFILIATED is a list of which CAR is
802 the buffer position at the beginning of the first affiliated
803 keyword and CDR is a plist of affiliated keywords along with
804 their value.
806 Return a list whose CAR is `footnote-definition' and CDR is
807 a plist containing `:label', `:begin' `:end', `:contents-begin',
808 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
810 Assume point is at the beginning of the footnote definition."
838 :begin begin
839 :end end
840 :contents-begin contents-begin
841 :contents-end contents-end
847 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
848 CONTENTS is the contents of the footnote-definition."
850 " "
851 contents))
854 ;;;; Headline
857 "Return node properties associated to headline at point.
858 Upcase property names. It avoids confusion between properties
859 obtained through property drawer and default properties from the
860 parser (e.g. `:end' and :END:). Return value is a plist."
872 properties))))
875 "Return time properties associated to headline at point.
876 Return value is a plist."
890 plist))))
893 "Parse a headline.
895 Return a list whose CAR is `headline' and CDR is a plist
896 containing `:raw-value', `:title', `:begin', `:end',
897 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
898 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
899 `:deadline', `:closed', `:archivedp', `:commentedp'
900 `:footnote-section-p', `:post-blank' and `:post-affiliated'
901 keywords.
903 The plist also contains any property set in the property drawer,
904 with its name in upper cases and colons added at the
905 beginning (e.g., `:CUSTOM_ID').
907 LIMIT is a buffer position bounding the search.
909 When RAW-SECONDARY-P is non-nil, headline's title will not be
910 parsed as a secondary string, but as a plain string instead.
912 Assume point is at beginning of the headline."
959 :begin begin
960 :end end
961 :pre-blank
964 :contents-begin contents-begin
965 :contents-end contents-end
966 :level level
967 :priority priority
968 :tags tags
969 :todo-keyword todo
970 :todo-type todo-type
973 end)
974 :footnote-section-p footnote-section-p
975 :archivedp archivedp
976 :commentedp commentedp
978 time-props
979 standard-props))))
981 headline :title
990 nil
996 "Interpret HEADLINE element as Org syntax.
997 CONTENTS is the contents of the element."
1010 ?*)
1014 " "
1017 org-footnote-section
1018 title))))
1020 heading
1021 ;; Align tags.
1029 ?\s)
1030 tags))
1034 tags))))
1036 contents)))
1039 ;;;; Inlinetask
1042 "Parse an inline task.
1044 Return a list whose CAR is `inlinetask' and CDR is a plist
1045 containing `:title', `:begin', `:end', `:contents-begin' and
1046 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1047 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1048 `:closed', `:post-blank' and `:post-affiliated' keywords.
1050 The plist also contains any property set in the property drawer,
1051 with its name in upper cases and colons added at the
1052 beginning (e.g., `:CUSTOM_ID').
1054 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1055 title will not be parsed as a secondary string, but as a plain
1056 string instead.
1058 Assume point is at beginning of the inline task."
1103 :begin begin
1104 :end end
1105 :contents-begin contents-begin
1106 :contents-end contents-end
1107 :level level
1108 :priority priority
1109 :tags tags
1110 :todo-keyword todo
1111 :todo-type todo-type
1114 time-props
1115 standard-props))))
1117 inlinetask :title
1126 nil
1132 "Interpret INLINETASK element as Org syntax.
1133 CONTENTS is the contents of inlinetask."
1147 ;; Align tags.
1155 ? )
1156 tags))
1160 tags))))
1161 ;; Prefer degenerate inlinetasks when there are no
1162 ;; contents.
1165 contents
1169 ;;;; Item
1172 "Parse an item.
1174 STRUCT is the structure of the plain list.
1176 Return a list whose CAR is `item' and CDR is a plist containing
1177 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1178 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1179 `:post-affiliated' keywords.
1181 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1182 any, will not be parsed as a secondary string, but as a plain
1183 string instead.
1185 Assume point is at the beginning of the item."
1208 ;; Ignore tags in un-ordered lists: they are just
1209 ;; a part of item's body.
1216 ;; If first line isn't empty, contents really
1217 ;; start at the text after item's meta-data.
1227 :begin begin
1228 :end end
1229 :contents-begin contents-begin
1230 :contents-end contents-end
1231 :checkbox checkbox
1232 :counter counter
1233 :structure struct
1237 item :tag
1248 "Interpret ITEM element as Org syntax.
1249 CONTENTS is the contents of the element."
1259 ;; Compute indentation.
1264 ;; Indent contents.
1266 bullet
1281 ;;;; Plain List
1284 ;; Return structure of list at point. Internal function. See
1285 ;; `org-list-struct' for details.
1290 items struct)
1295 ;; At limit: end all items.
1304 ;; At list end: end all items.
1309 ;; At a new item: end previous sibling.
1321 ind
1322 bullet
1325 ;; Description tag.
1329 ;; Ending position, unknown so far.
1330 nil)))
1331 items))
1333 ;; Skip empty lines.
1335 ;; Skip inline tasks and blank lines along the way.
1342 ;; At some text line. Check if it ends any previous item.
1355 ;; Skip blocks (any type) and drawers contents.
1360 limit t)))
1366 "Parse a plain list.
1368 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1369 the buffer position at the beginning of the first affiliated
1370 keyword and CDR is a plist of affiliated keywords along with
1371 their value. STRUCTURE is the structure of the plain list being
1372 parsed.
1374 Return a list whose CAR is `plain-list' and CDR is a plist
1375 containing `:type', `:begin', `:end', `:contents-begin' and
1376 `:contents-end', `:structure', `:post-blank' and
1377 `:post-affiliated' keywords.
1379 Assume point is at the beginning of the list."
1393 pos))
1397 ;; Return value.
1401 :begin begin
1402 :end end
1403 :contents-begin contents-begin
1404 :contents-end contents-end
1405 :structure struct
1411 "Interpret plain-list element as Org syntax.
1412 CONTENTS is the contents of the element."
1420 ;;;; Property Drawer
1423 "Parse a property drawer.
1425 LIMIT bounds the search.
1427 Return a list whose car is `property-drawer' and cdr is a plist
1428 containing `:begin', `:end', `:contents-begin', `:contents-end',
1429 `:post-blank' and `:post-affiliated' keywords.
1431 Assume point is at the beginning of the property drawer."
1444 :end end
1446 :contents-end contents-end
1451 "Interpret property-drawer element as Org syntax.
1452 CONTENTS is the properties within the drawer."
1456 ;;;; Quote Block
1459 "Parse a quote block.
1461 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1462 the buffer position at the beginning of the first affiliated
1463 keyword and CDR is a plist of affiliated keywords along with
1464 their value.
1466 Return a list whose CAR is `quote-block' and CDR is a plist
1467 containing `:begin', `:end', `:contents-begin', `:contents-end',
1468 `:post-blank' and `:post-affiliated' keywords.
1470 Assume point is at the beginning of the block."
1474 ;; Incomplete block: parse it as a paragraph.
1480 ;; Empty blocks have no contents.
1493 :end end
1494 :contents-begin contents-begin
1495 :contents-end contents-end
1501 "Interpret quote-block element as Org syntax.
1502 CONTENTS is the contents of the element."
1506 ;;;; Section
1509 "Parse a section.
1511 Return a list whose CAR is `section' and CDR is a plist
1512 containing `:begin', `:end', `:contents-begin', `contents-end',
1513 `:post-blank' and `:post-affiliated' keywords."
1515 ;; Beginning of section is the beginning of the first non-blank
1516 ;; line after previous headline.
1524 :end end
1525 :contents-begin begin
1526 :contents-end pos-before-blank
1531 "Interpret section element as Org syntax.
1532 CONTENTS is the contents of the element."
1533 contents)
1536 ;;;; Special Block
1539 "Parse a special block.
1541 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1542 the buffer position at the beginning of the first affiliated
1543 keyword and CDR is a plist of affiliated keywords along with
1544 their value.
1546 Return a list whose CAR is `special-block' and CDR is a plist
1547 containing `:type', `:begin', `:end', `:contents-begin',
1548 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1550 Assume point is at the beginning of the block."
1557 limit t)))
1558 ;; Incomplete block: parse it as a paragraph.
1564 ;; Empty blocks have no contents.
1577 :begin begin
1578 :end end
1579 :contents-begin contents-begin
1580 :contents-end contents-end
1586 "Interpret SPECIAL-BLOCK element as Org syntax.
1587 CONTENTS is the contents of the element."
1592 \f
1593 ;;; Elements
1594 ;;
1595 ;; For each element, a parser and an interpreter are also defined.
1596 ;; Both follow the same naming convention used for greater elements.
1597 ;;
1598 ;; Also, as for greater elements, adding a new element type is done
1599 ;; through the following steps: implement a parser and an interpreter,
1600 ;; tweak `org-element--current-element' so that it recognizes the new
1601 ;; type and add that new type to `org-element-all-elements'.
1602 ;;
1603 ;; As a special case, when the newly defined type is a block type,
1604 ;; `org-element-block-name-alist' has to be modified accordingly.
1607 ;;;; Babel Call
1610 "Parse a babel call.
1612 LIMIT bounds the search. AFFILIATED is a list of which car is
1613 the buffer position at the beginning of the first affiliated
1614 keyword and cdr is a plist of affiliated keywords along with
1615 their value.
1617 Return a list whose car is `babel-call' and cdr is a plist
1618 containing `:call', `:inside-header', `:arguments',
1619 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1620 `:post-affiliated' as keywords."
1634 value)))
1644 :begin begin
1645 :end end
1646 :value value
1652 "Interpret BABEL-CALL element as Org syntax."
1662 ;;;; Clock
1665 "Parse a clock.
1667 LIMIT bounds the search.
1669 Return a list whose CAR is `clock' and CDR is a plist containing
1670 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1671 `:post-affiliated' as keywords."
1691 :value value
1692 :duration duration
1693 :begin begin
1694 :end end
1695 :post-blank post-blank
1699 "Interpret CLOCK element as Org syntax."
1707 "%2s:%02s"
1711 ;;;; Comment
1714 "Parse a comment.
1716 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1717 the buffer position at the beginning of the first affiliated
1718 keyword and CDR is a plist of affiliated keywords along with
1719 their value.
1721 Return a list whose CAR is `comment' and CDR is a plist
1722 containing `:begin', `:end', `:value', `:post-blank',
1723 `:post-affiliated' keywords.
1725 Assume point is at comment beginning."
1734 ;; Get comments ending.
1737 ;; Accumulate lines without leading hash and first
1738 ;; whitespace.
1752 :end end
1753 :value value
1759 "Interpret COMMENT element as Org syntax.
1760 CONTENTS is nil."
1764 ;;;; Comment Block
1767 "Parse an export block.
1769 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1770 the buffer position at the beginning of the first affiliated
1771 keyword and CDR is a plist of affiliated keywords along with
1772 their value.
1774 Return a list whose CAR is `comment-block' and CDR is a plist
1775 containing `:begin', `:end', `:value', `:post-blank' and
1776 `:post-affiliated' keywords.
1778 Assume point is at comment block beginning."
1782 ;; Incomplete block: parse it as a paragraph.
1795 contents-begin contents-end)))
1799 :end end
1800 :value value
1806 "Interpret COMMENT-BLOCK element as Org syntax."
1813 ;;;; Diary Sexp
1816 "Parse a diary sexp.
1818 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1819 the buffer position at the beginning of the first affiliated
1820 keyword and CDR is a plist of affiliated keywords along with
1821 their value.
1823 Return a list whose CAR is `diary-sexp' and CDR is a plist
1824 containing `:begin', `:end', `:value', `:post-blank' and
1825 `:post-affiliated' keywords."
1837 :begin begin
1838 :end end
1844 "Interpret DIARY-SEXP as Org syntax."
1848 ;;;; Example Block
1851 "Parse an example block.
1853 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1854 the buffer position at the beginning of the first affiliated
1855 keyword and CDR is a plist of affiliated keywords along with
1856 their value.
1858 Return a list whose CAR is `example-block' and CDR is a plist
1859 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1860 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1861 `:value', `:post-blank' and `:post-affiliated' keywords."
1865 ;; Incomplete block: parse it as a paragraph.
1873 ;; Switches analysis
1880 ;; Should labels be retained in (or stripped from) example
1881 ;; blocks?
1886 ;; What should code-references use - labels or
1887 ;; line-numbers?
1896 ;; Standard block parsing.
1904 contents-begin contents-end))
1905 block-ind))
1914 :end end
1915 :value value
1916 :switches switches
1917 :number-lines number-lines
1918 :preserve-indent preserve-indent
1919 :retain-labels retain-labels
1920 :use-labels use-labels
1921 :label-fmt label-fmt
1927 "Interpret EXAMPLE-BLOCK element as Org syntax."
1935 value
1940 ;;;; Export Block
1943 "Parse an export block.
1945 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1946 the buffer position at the beginning of the first affiliated
1947 keyword and CDR is a plist of affiliated keywords along with
1948 their value.
1950 Return a list whose CAR is `export-block' and CDR is a plist
1951 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1952 `:post-affiliated' keywords.
1954 Assume point is at export-block beginning."
1961 ;; Incomplete block: parse it as a paragraph.
1974 contents-end)))
1978 :end end
1979 :type type
1980 :value value
1986 "Interpret EXPORT-BLOCK element as Org syntax."
1993 ;;;; Fixed-width
1996 "Parse a fixed-width section.
1998 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1999 the buffer position at the beginning of the first affiliated
2000 keyword and CDR is a plist of affiliated keywords along with
2001 their value.
2003 Return a list whose CAR is `fixed-width' and CDR is a plist
2004 containing `:begin', `:end', `:value', `:post-blank' and
2005 `:post-affiliated' keywords.
2007 Assume point is at the beginning of the fixed-width area."
2011 value
2016 ;; Accumulate text without starting colons.
2029 :end end
2030 :value value
2036 "Interpret FIXED-WIDTH element as Org syntax."
2044 ;;;; Horizontal Rule
2047 "Parse an horizontal rule.
2049 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2050 the buffer position at the beginning of the first affiliated
2051 keyword and CDR is a plist of affiliated keywords along with
2052 their value.
2054 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2055 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2056 keywords."
2066 :end end
2072 "Interpret HORIZONTAL-RULE element as Org syntax."
2076 ;;;; Keyword
2079 "Parse a keyword at point.
2081 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2082 the buffer position at the beginning of the first affiliated
2083 keyword and CDR is a plist of affiliated keywords along with
2084 their value.
2086 Return a list whose CAR is `keyword' and CDR is a plist
2087 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2088 `:post-affiliated' keywords."
2090 ;; An orphaned affiliated keyword is considered as a regular
2091 ;; keyword. In this case AFFILIATED is nil, so we take care of
2092 ;; this corner case.
2105 :value value
2106 :begin begin
2107 :end end
2113 "Interpret KEYWORD element as Org syntax."
2119 ;;;; Latex Environment
2123 "Regexp matching the beginning of a LaTeX environment.
2124 The environment is captured by the first group.
2130 "Format string matching the ending of a LaTeX environment.
2134 "Parse a LaTeX environment.
2136 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2137 the buffer position at the beginning of the first affiliated
2138 keyword and CDR is a plist of affiliated keywords along with
2139 their value.
2141 Return a list whose CAR is `latex-environment' and CDR is a plist
2142 containing `:begin', `:end', `:value', `:post-blank' and
2143 `:post-affiliated' keywords.
2145 Assume point is at the beginning of the latex environment."
2152 limit t))
2153 ;; Incomplete latex environment: parse it as a paragraph.
2163 :end end
2164 :value value
2170 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2174 ;;;; Node Property
2177 "Parse a node-property at point.
2179 LIMIT bounds the search.
2181 Return a list whose CAR is `node-property' and CDR is a plist
2182 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2183 `:post-affiliated' keywords."
2193 limit))))
2196 :value value
2197 :begin begin
2198 :end end
2203 "Interpret NODE-PROPERTY element as Org syntax."
2209 ;;;; Paragraph
2212 "Parse a paragraph.
2214 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2215 the buffer position at the beginning of the first affiliated
2216 keyword and CDR is a plist of affiliated keywords along with
2217 their value.
2219 Return a list whose CAR is `paragraph' and CDR is a plist
2220 containing `:begin', `:end', `:contents-begin' and
2221 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2223 Assume point is at the beginning of the paragraph."
2230 ;; A matching `org-element-paragraph-separate' is not
2231 ;; necessarily the end of the paragraph. In particular,
2232 ;; drawers, blocks or LaTeX environments opening lines
2233 ;; must be closed. Moreover keywords with a secondary
2234 ;; value must belong to "dual keywords".
2248 limit t)))
2254 limit t)))
2257 org-element-dual-keywords))
2258 ;; Everything else is unambiguous.
2271 :end end
2272 :contents-begin contents-begin
2273 :contents-end contents-end
2279 "Interpret paragraph element as Org syntax.
2280 CONTENTS is the contents of the element."
2281 contents)
2284 ;;;; Planning
2287 "Parse a planning.
2289 LIMIT bounds the search.
2291 Return a list whose CAR is `planning' and CDR is a plist
2292 containing `:closed', `:deadline', `:scheduled', `:begin',
2293 `:end', `:post-blank' and `:post-affiliated' keywords."
2303 closed deadline scheduled)
2315 :deadline deadline
2316 :scheduled scheduled
2317 :begin begin
2318 :end end
2319 :post-blank post-blank
2323 "Interpret PLANNING element as Org syntax."
2325 #'identity
2342 ;;;; Src Block
2345 "Parse a src block.
2347 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2348 the buffer position at the beginning of the first affiliated
2349 keyword and CDR is a plist of affiliated keywords along with
2350 their value.
2352 Return a list whose CAR is `src-block' and CDR is a plist
2353 containing `:language', `:switches', `:parameters', `:begin',
2354 `:end', `:number-lines', `:retain-labels', `:use-labels',
2355 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2356 `:post-affiliated' keywords.
2358 Assume point is at the beginning of the block."
2361 limit t)))
2362 ;; Incomplete block: parse it as a paragraph.
2368 ;; Get language as a string.
2377 ;; Get switches.
2379 ;; Get parameters.
2381 ;; Switches analysis
2392 ;; Should labels be retained in (or stripped from)
2393 ;; src blocks?
2398 ;; What should code-references use - labels or
2399 ;; line-numbers?
2404 ;; Indentation.
2406 ;; Retrieve code.
2411 block-ind))
2415 ;; Get position after ending blank lines.
2425 :begin begin
2426 :end end
2427 :number-lines number-lines
2428 :preserve-indent preserve-indent
2429 :retain-labels retain-labels
2430 :use-labels use-labels
2431 :label-fmt label-fmt
2432 :value value
2438 "Interpret SRC-BLOCK element as Org syntax."
2447 val)
2461 ;;;; Table
2464 "Parse a table at point.
2466 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2467 the buffer position at the beginning of the first affiliated
2468 keyword and CDR is a plist of affiliated keywords along with
2469 their value.
2471 Return a list whose CAR is `table' and CDR is a plist containing
2472 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2473 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2474 keywords.
2476 Assume point is at the beginning of the table."
2492 acc))
2499 :end end
2500 :type type
2501 :tblfm tblfm
2502 ;; Only `org' tables have contents. `table.el' tables
2503 ;; use a `:value' property to store raw table as
2504 ;; a string.
2509 table-begin table-end))
2515 "Interpret TABLE element as Org syntax.
2516 CONTENTS is a string, if table's type is `org', or nil."
2527 ;;;; Table Row
2530 "Parse table row at point.
2532 Return a list whose CAR is `table-row' and CDR is a plist
2533 containing `:begin', `:end', `:contents-begin', `:contents-end',
2534 `:type', `:post-blank' and `:post-affiliated' keywords."
2538 ;; A table rule has no contents. In that case, ensure
2539 ;; CONTENTS-BEGIN matches CONTENTS-END.
2549 :begin begin
2550 :end end
2551 :contents-begin contents-begin
2552 :contents-end contents-end
2557 "Interpret TABLE-ROW element as Org syntax.
2558 CONTENTS is the contents of the table row."
2563 ;;;; Verse Block
2566 "Parse a verse block.
2568 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2569 the buffer position at the beginning of the first affiliated
2570 keyword and CDR is a plist of affiliated keywords along with
2571 their value.
2573 Return a list whose CAR is `verse-block' and CDR is a plist
2574 containing `:begin', `:end', `:contents-begin', `:contents-end',
2575 `:post-blank' and `:post-affiliated' keywords.
2577 Assume point is at beginning of the block."
2581 ;; Incomplete block: parse it as a paragraph.
2596 :end end
2597 :contents-begin contents-begin
2598 :contents-end contents-end
2604 "Interpret verse-block element as Org syntax.
2605 CONTENTS is verse block contents."
2609 \f
2610 ;;; Objects
2611 ;;
2612 ;; Unlike to elements, raw text can be found between objects. Hence,
2613 ;; `org-element--object-lex' is provided to find the next object in
2614 ;; buffer.
2615 ;;
2616 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2617 ;; object types they can contain will be specified in
2618 ;; `org-element-object-restrictions'.
2619 ;;
2620 ;; Creating a new type of object requires to alter
2621 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2622 ;; new type in `org-element-all-objects', and possibly add
2623 ;; restrictions in `org-element-object-restrictions'.
2625 ;;;; Bold
2628 "Parse bold object at point, if any.
2630 When at a bold object, return a list whose car is `bold' and cdr
2631 is a plist with `:begin', `:end', `:contents-begin' and
2632 `:contents-end' and `:post-blank' keywords. Otherwise, return
2633 nil.
2635 Assume point is at the first star marker."
2647 :end end
2648 :contents-begin contents-begin
2649 :contents-end contents-end
2653 "Interpret bold object as Org syntax.
2654 CONTENTS is the contents of the object."
2658 ;;;; Code
2661 "Parse code object at point, if any.
2663 When at a code object, return a list whose car is `code' and cdr
2664 is a plist with `:value', `:begin', `:end' and `:post-blank'
2665 keywords. Otherwise, return nil.
2667 Assume point is at the first tilde marker."
2678 :begin begin
2679 :end end
2683 "Interpret CODE object as Org syntax."
2687 ;;;; Entity
2690 "Parse entity at point, if any.
2692 When at an entity, return a list whose car is `entity' and cdr
2693 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2694 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2695 `:post-blank' as keywords. Otherwise, return nil.
2697 Assume point is at the beginning of the entity."
2699 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2717 :begin begin
2718 :end end
2719 :use-brackets-p bracketsp
2723 "Interpret ENTITY object as Org syntax."
2729 ;;;; Export Snippet
2732 "Parse export snippet at point.
2734 When at an export snippet, return a list whose car is
2735 `export-snippet' and cdr a plist with `:begin', `:end',
2736 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2737 return nil.
2739 Assume point is at the beginning of the snippet."
2755 :value value
2756 :begin begin
2757 :end end
2761 "Interpret EXPORT-SNIPPET object as Org syntax."
2767 ;;;; Footnote Reference
2770 "Parse footnote reference at point, if any.
2772 When at a footnote reference, return a list whose car is
2773 `footnote-reference' and cdr a plist with `:label', `:type',
2774 `:begin', `:end', `:content-begin', `:contents-end' and
2775 `:post-blank' as keywords. Otherwise, return nil."
2795 :type type
2796 :begin begin
2797 :end end
2803 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2804 CONTENTS is its definition, when inline, or nil."
2810 ;;;; Inline Babel Call
2813 "Parse inline babel call at point, if any.
2815 When at an inline babel call, return a list whose car is
2816 `inline-babel-call' and cdr a plist with `:call',
2817 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2818 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2820 Assume point is at the beginning of the babel call."
2836 :inside-header inside-header
2837 :arguments arguments
2838 :end-header end-header
2839 :begin begin
2840 :end end
2841 :value value
2845 "Interpret INLINE-BABEL-CALL object as Org syntax."
2855 ;;;; Inline Src Block
2858 "Parse inline source block at point, if any.
2860 When at an inline source block, return a list whose car is
2861 `inline-src-block' and cdr a plist with `:begin', `:end',
2862 `:language', `:value', `:parameters' and `:post-blank' as
2863 keywords. Otherwise, return nil.
2865 Assume point is at the beginning of the inline src block."
2878 :value value
2879 :parameters parameters
2880 :begin begin
2881 :end end
2885 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2890 language
2892 body)))
2894 ;;;; Italic
2897 "Parse italic object at point, if any.
2899 When at an italic object, return a list whose car is `italic' and
2900 cdr is a plist with `:begin', `:end', `:contents-begin' and
2901 `:contents-end' and `:post-blank' keywords. Otherwise, return
2902 nil.
2904 Assume point is at the first slash marker."
2916 :end end
2917 :contents-begin contents-begin
2918 :contents-end contents-end
2922 "Interpret italic object as Org syntax.
2923 CONTENTS is the contents of the object."
2927 ;;;; Latex Fragment
2930 "Parse LaTeX fragment at point, if any.
2932 When at a LaTeX fragment, return a list whose car is
2933 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2934 and `:post-blank' as keywords. Otherwise, return nil.
2936 Assume point is at the beginning of the LaTeX fragment."
2954 ;; Macro.
2964 :begin begin
2965 :end end
2969 "Interpret LATEX-FRAGMENT object as Org syntax."
2972 ;;;; Line Break
2975 "Parse line break at point, if any.
2977 When at a line break, return a list whose car is `line-break',
2978 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2979 Otherwise, return nil.
2981 Assume point is at the beginning of the line break."
2990 "Interpret LINE-BREAK object as Org syntax."
2994 ;;;; Link
2997 "Parse link at point, if any.
2999 When at a link, return a list whose car is `link' and cdr a plist
3000 with `:type', `:path', `:raw-link', `:application',
3001 `:search-option', `:begin', `:end', `:contents-begin',
3002 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3003 nil.
3005 Assume point is at the beginning of the link."
3008 end contents-begin contents-end link-end post-blank path type
3009 raw-link search-option application)
3011 ;; Type 1: Text targeted from a radio target.
3020 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3025 ;; RAW-LINK is the original link. Expand any
3026 ;; abbreviation in it.
3027 ;;
3028 ;; Also treat any newline character and associated
3029 ;; indentation as a single space character. This is not
3030 ;; compatible with RFC 3986, which requires to ignore
3031 ;; them altogether. However, doing so would require
3032 ;; users to encode spaces on the fly when writing links
3033 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3034 ;; [[shell:ls *.org]], which defeats Org's focus on
3035 ;; simplicity.
3041 ;; Determine TYPE of link and set PATH accordingly. According
3042 ;; to RFC 3986, remove whitespaces from URI in external links.
3043 ;; In internal ones, treat indentation as a single space.
3045 ;; File type.
3050 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3054 ;; Id type: PATH is the id.
3057 ;; Code-ref type: PATH is the name of the reference.
3062 ;; Custom-id type: PATH is the name of the custom id.
3066 ;; Fuzzy type: Internal link either matches a target, an
3067 ;; headline name or nothing. PATH is the target or
3068 ;; headline's name.
3072 ;; Type 3: Plain link, e.g., http://orgmode.org
3078 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3079 ;; bracket links, follow RFC 3986 and remove any extra
3080 ;; whitespace in URI.
3090 ;; In any case, deduce end point after trailing white space from
3091 ;; LINK-END variable.
3095 ;; Special "file" type link processing. Extract opening
3096 ;; application and search option, if any. Also normalize URI.
3105 :path path
3107 :application application
3108 :search-option search-option
3109 :begin begin
3110 :end end
3111 :contents-begin contents-begin
3112 :contents-end contents-end
3116 "Interpret LINK object as Org syntax.
3117 CONTENTS is the contents of the object, or nil."
3122 raw-link
3126 ;;;; Macro
3129 "Parse macro at point, if any.
3131 When at a macro, return a list whose car is `macro' and cdr
3132 a plist with `:key', `:args', `:begin', `:end', `:value' and
3133 `:post-blank' as keywords. Otherwise, return nil.
3135 Assume point is at the macro."
3148 :value value
3149 :args args
3150 :begin begin
3151 :end end
3155 "Interpret MACRO object as Org syntax."
3159 ;;;; Radio-target
3162 "Parse radio target at point, if any.
3164 When at a radio target, return a list whose car is `radio-target'
3165 and cdr a plist with `:begin', `:end', `:contents-begin',
3166 `:contents-end', `:value' and `:post-blank' as keywords.
3167 Otherwise, return nil.
3169 Assume point is at the radio target."
3181 :end end
3182 :contents-begin contents-begin
3183 :contents-end contents-end
3184 :post-blank post-blank
3188 "Interpret target object as Org syntax.
3189 CONTENTS is the contents of the object."
3193 ;;;; Statistics Cookie
3196 "Parse statistics cookie at point, if any.
3198 When at a statistics cookie, return a list whose car is
3199 `statistics-cookie', and cdr a plist with `:begin', `:end',
3200 `:value' and `:post-blank' keywords. Otherwise, return nil.
3202 Assume point is at the beginning of the statistics-cookie."
3213 :end end
3214 :value value
3218 "Interpret STATISTICS-COOKIE object as Org syntax."
3222 ;;;; Strike-Through
3225 "Parse strike-through object at point, if any.
3227 When at a strike-through object, return a list whose car is
3228 `strike-through' and cdr is a plist with `:begin', `:end',
3229 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3230 Otherwise, return nil.
3232 Assume point is at the first plus sign marker."
3244 :end end
3245 :contents-begin contents-begin
3246 :contents-end contents-end
3250 "Interpret strike-through object as Org syntax.
3251 CONTENTS is the contents of the object."
3255 ;;;; Subscript
3258 "Parse subscript at point, if any.
3260 When at a subscript object, return a list whose car is
3261 `subscript' and cdr a plist with `:begin', `:end',
3262 `:contents-begin', `:contents-end', `:use-brackets-p' and
3263 `:post-blank' as keywords. Otherwise, return nil.
3265 Assume point is at the underscore."
3279 :end end
3280 :use-brackets-p bracketsp
3281 :contents-begin contents-begin
3282 :contents-end contents-end
3286 "Interpret SUBSCRIPT object as Org syntax.
3287 CONTENTS is the contents of the object."
3290 contents))
3293 ;;;; Superscript
3296 "Parse superscript at point, if any.
3298 When at a superscript object, return a list whose car is
3299 `superscript' and cdr a plist with `:begin', `:end',
3300 `:contents-begin', `:contents-end', `:use-brackets-p' and
3301 `:post-blank' as keywords. Otherwise, return nil.
3303 Assume point is at the caret."
3317 :end end
3318 :use-brackets-p bracketsp
3319 :contents-begin contents-begin
3320 :contents-end contents-end
3324 "Interpret SUPERSCRIPT object as Org syntax.
3325 CONTENTS is the contents of the object."
3328 contents))
3331 ;;;; Table Cell
3334 "Parse table cell at point.
3335 Return a list whose car is `table-cell' and cdr is a plist
3336 containing `:begin', `:end', `:contents-begin', `:contents-end'
3337 and `:post-blank' keywords."
3345 :end end
3346 :contents-begin contents-begin
3347 :contents-end contents-end
3351 "Interpret table-cell element as Org syntax.
3352 CONTENTS is the contents of the cell, or nil."
3356 ;;;; Target
3359 "Parse target at point, if any.
3361 When at a target, return a list whose car is `target' and cdr
3362 a plist with `:begin', `:end', `:value' and `:post-blank' as
3363 keywords. Otherwise, return nil.
3365 Assume point is at the target."
3375 :end end
3376 :value value
3380 "Interpret TARGET object as Org syntax."
3384 ;;;; Timestamp
3395 "Parse time stamp at point, if any.
3397 When at a time stamp, return a list whose car is `timestamp', and
3398 cdr a plist with `:type', `:raw-value', `:year-start',
3399 `:month-start', `:day-start', `:hour-start', `:minute-start',
3400 `:year-end', `:month-end', `:day-end', `:hour-end',
3401 `:minute-end', `:repeater-type', `:repeater-value',
3402 `:repeater-unit', `:warning-type', `:warning-value',
3403 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3404 Otherwise, return nil.
3406 Assume point is at the beginning of the timestamp."
3425 date-start)
3436 raw-value)
3438 :repeater-type
3444 :repeater-unit
3453 :warning-unit
3456 year-start month-start day-start hour-start minute-start year-end
3457 month-end day-end hour-end minute-end)
3458 ;; Parse date-start.
3466 ;; Compute date-end. It can be provided directly in time-stamp,
3467 ;; or extracted from time range. Otherwise, it defaults to the
3468 ;; same values as date-start.
3478 :raw-value raw-value
3479 :year-start year-start
3480 :month-start month-start
3481 :day-start day-start
3482 :hour-start hour-start
3483 :minute-start minute-start
3484 :year-end year-end
3485 :month-end month-end
3486 :day-end day-end
3487 :hour-end hour-end
3488 :minute-end minute-end
3489 :begin begin
3490 :end end
3492 repeater-props
3493 warning-props))))))
3496 "Interpret TIMESTAMP object as Org syntax."
3514 ;; Build an Org timestamp string from TIME. ACTIVEP is
3515 ;; non-nil when time stamp is active. If WITH-TIME-P is
3516 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3517 ;; specify a time range in the timestamp. REPEAT-STRING is
3518 ;; the repeater string, if any.
3522 org-time-stamp-formats)
3523 time)))
3529 nil nil ts)))
3534 " "
3535 s
3537 ;; Return value.
3538 ts)))
3550 build-ts-string
3569 0
3577 "--"
3590 ;;;; Underline
3593 "Parse underline object at point, if any.
3595 When at an underline object, return a list whose car is
3596 `underline' and cdr is a plist with `:begin', `:end',
3597 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3598 Otherwise, return nil.
3600 Assume point is at the first underscore marker."
3612 :end end
3613 :contents-begin contents-begin
3614 :contents-end contents-end
3618 "Interpret underline object as Org syntax.
3619 CONTENTS is the contents of the object."
3623 ;;;; Verbatim
3626 "Parse verbatim object at point, if any.
3628 When at a verbatim object, return a list whose car is `verbatim'
3629 and cdr is a plist with `:value', `:begin', `:end' and
3630 `:post-blank' keywords. Otherwise, return nil.
3632 Assume point is at the first equal sign marker."
3643 :begin begin
3644 :end end
3648 "Interpret VERBATIM object as Org syntax."
3652 \f
3653 ;;; Parsing Element Starting At Point
3654 ;;
3655 ;; `org-element--current-element' is the core function of this section.
3656 ;; It returns the Lisp representation of the element starting at
3657 ;; point.
3658 ;;
3659 ;; `org-element--current-element' makes use of special modes. They
3660 ;; are activated for fixed element chaining (e.g., `plain-list' >
3661 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3662 ;; `section'). Special modes are: `first-section', `item',
3663 ;; `node-property', `section' and `table-row'.
3666 "Parse the element starting at point.
3668 Return value is a list like (TYPE PROPS) where TYPE is the type
3669 of the element and PROPS a plist of properties associated to the
3670 element.
3672 Possible types are defined in `org-element-all-elements'.
3674 LIMIT bounds the search.
3676 Optional argument GRANULARITY determines the depth of the
3677 recursion. Allowed values are `headline', `greater-element',
3678 `element', `object' or nil. When it is broader than `object' (or
3679 nil), secondary values will not be parsed, since they only
3680 contain objects.
3682 Optional argument MODE, when non-nil, can be either
3683 `first-section', `section', `planning', `item', `node-property'
3684 and `table-row'.
3686 If STRUCTURE isn't provided but MODE is set to `item', it will be
3687 computed.
3689 This function assumes point is always at the beginning of the
3690 element it has to parse."
3693 ;; Determine if parsing depth allows for secondary strings
3694 ;; parsing. It only applies to elements referenced in
3695 ;; `org-element-secondary-value-alist'.
3698 ;; Item.
3701 ;; Table Row.
3703 ;; Node Property.
3705 ;; Headline.
3708 ;; Sections (must be checked after headline).
3713 limit)))
3714 ;; Planning.
3717 ;; Property drawer.
3721 ;; When not at bol, point is at the beginning of an item or
3722 ;; a footnote definition: next item is always a paragraph.
3724 ;; Clock.
3726 ;; Inlinetask.
3729 ;; From there, elements can have affiliated keywords.
3732 ;; Jumping over affiliated keywords put point off-limits.
3733 ;; Parse them as regular keywords.
3737 ;; LaTeX Environment.
3740 ;; Drawer and Property Drawer.
3743 ;; Fixed Width
3746 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3747 ;; Keywords.
3756 org-element-block-name-alist)))
3771 ;; Footnote Definition.
3774 ;; Horizontal Rule.
3777 ;; Diary Sexp.
3780 ;; Table.
3783 ;; List.
3786 limit affiliated
3788 ;; Default element: Paragraph.
3792 ;; Most elements can have affiliated keywords. When looking for an
3793 ;; element beginning, we want to move before them, as they belong to
3794 ;; that element, and, in the meantime, collect information they give
3795 ;; into appropriate properties. Hence the following function.
3798 "Collect affiliated keywords from point down to LIMIT.
3800 Return a list whose CAR is the position at the first of them and
3801 CDR a plist of keywords and values and move point to the
3802 beginning of the first line after them.
3804 As a special case, if element doesn't start at the beginning of
3805 the line (e.g., a paragraph starting an item), CAR is current
3806 position of point and CDR is nil."
3810 ;; RESTRICT is the list of objects allowed in parsed
3811 ;; keywords value.
3813 output)
3816 ;; Apply translation to RAW-KWD. From there, KWD is
3817 ;; the official keyword.
3819 org-element-keyword-translation-alist))
3820 raw-kwd))
3821 ;; Find main value for any keyword.
3827 ;; PARSEDP is non-nil when keyword should have its
3828 ;; value parsed.
3830 ;; If KWD is a dual keyword, find its secondary
3831 ;; value. Maybe parse it.
3839 ;; Attribute a property name to KWD.
3841 ;; Now set final shape for VALUE.
3847 nil restrict)))
3851 ;; Attributes can always appear on multiple lines.
3854 ;; Eventually store the new value in OUTPUT.
3856 ;; Move to next keyword.
3858 ;; If affiliated keywords are orphaned: move back to first one.
3859 ;; They will be parsed as a paragraph.
3861 ;; Return value.
3865 \f
3866 ;;; The Org Parser
3867 ;;
3868 ;; The two major functions here are `org-element-parse-buffer', which
3869 ;; parses Org syntax inside the current buffer, taking into account
3870 ;; region, narrowing, or even visibility if specified, and
3871 ;; `org-element-parse-secondary-string', which parses objects within
3872 ;; a given string.
3873 ;;
3874 ;; The (almost) almighty `org-element-map' allows to apply a function
3875 ;; on elements or objects matching some type, and accumulate the
3876 ;; resulting values. In an export situation, it also skips unneeded
3877 ;; parts of the parse tree.
3880 "Recursively parse the buffer and return structure.
3881 If narrowing is in effect, only parse the visible part of the
3882 buffer.
3884 Optional argument GRANULARITY determines the depth of the
3885 recursion. It can be set to the following symbols:
3887 `headline' Only parse headlines.
3888 `greater-element' Don't recurse into greater elements excepted
3889 headlines and sections. Thus, elements
3890 parsed are the top-level ones.
3891 `element' Parse everything but objects and plain text.
3892 `object' Parse the complete buffer (default).
3894 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3895 elements.
3897 An element or an objects is represented as a list with the
3898 pattern (TYPE PROPERTIES CONTENTS), where :
3900 TYPE is a symbol describing the element or object. See
3901 `org-element-all-elements' and `org-element-all-objects' for an
3902 exhaustive list of such symbols. One can retrieve it with
3903 `org-element-type' function.
3905 PROPERTIES is the list of attributes attached to the element or
3906 object, as a plist. Although most of them are specific to the
3907 element or object type, all types share `:begin', `:end',
3908 `:post-blank' and `:parent' properties, which respectively
3909 refer to buffer position where the element or object starts,
3910 ends, the number of white spaces or blank lines after it, and
3911 the element or object containing it. Properties values can be
3912 obtained by using `org-element-property' function.
3914 CONTENTS is a list of elements, objects or raw strings
3915 contained in the current element or object, when applicable.
3916 One can access them with `org-element-contents' function.
3918 The Org buffer has `org-data' as type and nil as properties.
3919 `org-element-map' function can be used to find specific elements
3920 or objects within the parse tree.
3922 This function assumes that current major mode is `org-mode'."
3928 ;; Start in `first-section' mode so text before the first
3929 ;; headline belongs to a section.
3933 "Recursively parse objects in STRING and return structure.
3935 RESTRICTION is a symbol limiting the object types that will be
3936 looked after.
3938 Optional argument PARENT, when non-nil, is the element or object
3939 containing the secondary string. It is used to set correctly
3940 `:parent' property within the string.
3942 If STRING is the empty string or nil, return nil."
3958 data))))))
3962 "Map a function on selected elements or objects.
3964 DATA is a parse tree, an element, an object, a string, or a list
3965 of such constructs. TYPES is a symbol or list of symbols of
3966 elements or objects types (see `org-element-all-elements' and
3967 `org-element-all-objects' for a complete list of types). FUN is
3968 the function called on the matching element or object. It has to
3969 accept one argument: the element or object itself.
3971 When optional argument INFO is non-nil, it should be a plist
3972 holding export options. In that case, parts of the parse tree
3973 not exportable according to that property list will be skipped.
3975 When optional argument FIRST-MATCH is non-nil, stop at the first
3976 match for which FUN doesn't return nil, and return that value.
3978 Optional argument NO-RECURSION is a symbol or a list of symbols
3979 representing elements or objects types. `org-element-map' won't
3980 enter any recursive element or object whose type belongs to that
3981 list. Though, FUN can still be applied on them.
3983 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3984 apply to matching objects within parsed affiliated keywords (see
3985 `org-element-parsed-keywords').
3987 Nil values returned from FUN do not appear in the results.
3990 Examples:
3991 ---------
3993 Assuming TREE is a variable containing an Org buffer parse tree,
3994 the following example will return a flat list of all `src-block'
3995 and `example-block' elements in it:
3997 \(org-element-map tree '(example-block src-block) #'identity)
3999 The following snippet will find the first headline with a level
4002 \(org-element-map tree 'headline
4003 \(lambda (hl)
4004 \(and (= (org-element-property :level hl) 1)
4006 \(org-element-property :begin hl)))
4007 nil t)
4009 The next example will return a flat list of all `plain-list' type
4010 elements in TREE that are not a sub-list themselves:
4012 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4014 Eventually, this example will return a flat list of all `bold'
4015 type objects containing a `latex-snippet' type object, even
4016 looking into captions:
4018 \(org-element-map tree 'bold
4019 \(lambda (b)
4020 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4021 nil nil nil t)"
4022 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4026 ;; Recursion depth is determined by --CATEGORY.
4033 ;; If one object is found, the function has
4034 ;; to recurse into every object.
4037 ;; If one regular element is found, the
4038 ;; function has to recurse, at least, into
4039 ;; every element it encounters.
4042 --acc)
4045 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4046 ;; holding contextual information.
4050 ;; Ignored element in an export context.
4052 ;; List of elements or objects.
4054 ;; Unconditionally enter parse trees.
4058 ;; Check if TYPE is matching among TYPES. If so,
4059 ;; apply FUN to --DATA and accumulate return value
4060 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4066 ;; If --DATA has a secondary string that can contain
4067 ;; objects with their type among TYPES, look inside.
4070 org-element-secondary-value-alist)))
4072 ;; If --DATA has any parsed affiliated keywords and
4073 ;; WITH-AFFILIATED is non-nil, look for objects in
4074 ;; them.
4081 ;; Pay attention to the type of parsed
4082 ;; keyword. In particular, preserve order for
4083 ;; multiple keywords.
4096 ;; Determine if a recursion into --DATA is possible.
4098 ;; --TYPE is explicitly removed from recursion.
4100 ;; --DATA has no contents.
4102 ;; Looking for greater elements but --DATA is
4103 ;; simply an element or an object.
4106 ;; Looking for elements but --DATA is an object.
4109 ;; In any other case, map contents.
4113 ;; Return value in a proper order.
4117 ;; The following functions are internal parts of the parser.
4118 ;;
4119 ;; The first one, `org-element--parse-elements' acts at the element's
4120 ;; level.
4121 ;;
4122 ;; The second one, `org-element--parse-objects' applies on all objects
4123 ;; of a paragraph or a secondary string. It calls
4124 ;; `org-element--object-lex' to find the next object in the current
4125 ;; container.
4128 "Return next special mode according to TYPE, or nil.
4129 TYPE is a symbol representing the type of an element or object
4130 containing next element if PARENTP is non-nil, or before it
4131 otherwise. Modes can be either `first-section', `item',
4132 `node-property', `planning', `property-drawer', `section',
4133 `table-row' or nil."
4149 "Parse elements between BEG and END positions.
4151 MODE prioritizes some elements over the others. It can be set to
4152 `first-section', `section', `planning', `item', `node-property'
4153 or `table-row'.
4155 When value is `item', STRUCTURE will be used as the current list
4156 structure.
4158 GRANULARITY determines the depth of the recursion. See
4159 `org-element-parse-buffer' for more information.
4161 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4162 elements.
4164 Elements are accumulated into ACC."
4167 ;; Visible only: skip invisible parts at the beginning of the
4168 ;; element.
4171 ;; When parsing only headlines, skip any text before first one.
4174 ;; Main loop start.
4176 ;; Find current element's type and parse it accordingly to
4177 ;; its category.
4179 end granularity mode structure))
4183 ;; Visible only: skip invisible parts between siblings.
4186 ;; Fill ELEMENT contents by side-effect.
4188 ;; If element has no contents, don't modify it.
4190 ;; Greater element: parse it between `contents-begin' and
4191 ;; `contents-end'. Make sure GRANULARITY allows the
4192 ;; recursion, or ELEMENT is a headline, in which case going
4193 ;; inside is mandatory, in order to get sub-level headings.
4201 ;; Possibly switch to a special mode.
4205 granularity visible-only element))
4206 ;; ELEMENT has contents. Parse objects inside, if
4207 ;; GRANULARITY allows it.
4213 ;; Update mode.
4215 ;; Return result.
4216 acc))
4219 "Return next object in current buffer or nil.
4220 RESTRICTION is a list of object types, as symbols, that should be
4221 looked after. This function assumes that the buffer is narrowed
4222 to an appropriate container (e.g., a paragraph)."
4230 found)
4295 ;; This is probably a plain link.
4301 ;; Radio link.
4306 "Parse objects between BEG and END and return recursive structure.
4308 Objects are accumulated in ACC.
4310 RESTRICTION is a list of object successors which are allowed in
4311 the current object."
4319 ;; 1. Text before any object. Untabify it.
4324 acc
4328 ;; 2. Object...
4331 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4332 ;; a recursive type.
4340 ;; 3. Text after last object. Untabify it.
4344 acc
4348 ;; Result.
4349 acc)))
4352 \f
4353 ;;; Towards A Bijective Process
4354 ;;
4355 ;; The parse tree obtained with `org-element-parse-buffer' is really
4356 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4357 ;; interpreted and expanded into a string with canonical Org syntax.
4358 ;; Hence `org-element-interpret-data'.
4359 ;;
4360 ;; The function relies internally on
4361 ;; `org-element--interpret-affiliated-keywords'.
4363 ;;;###autoload
4365 "Interpret DATA as Org syntax.
4366 DATA is a parse tree, an element, an object or a secondary string
4367 to interpret. Return Org syntax as a string."
4371 ;; Find interpreter for current object or
4372 ;; element. If it doesn't exist (e.g. this is
4373 ;; a pseudo object or element), return contents,
4374 ;; if any.
4381 ;; Secondary string.
4385 ;; Full Org document.
4389 ;; Plain text: return it.
4391 ;; Element or object without contents.
4394 ;; Element or object with contents.
4397 interpret
4398 --data
4399 ;; Recursively interpret contents.
4404 --data
4405 ;; Fix indentation of elements containing
4406 ;; objects. We ignore `table-row'
4407 ;; elements as they are one line long
4408 ;; anyway.
4410 --data
4411 ;; When normalizing first paragraph of
4412 ;; an item or a footnote-definition,
4413 ;; ignore first line's indentation.
4421 ;; Build white spaces. If no `:post-blank' property
4422 ;; is specified, assume its value is 0.
4437 "Return ELEMENT's affiliated keywords as Org syntax.
4438 If there is no affiliated keyword, return the empty string."
4448 ": "
4451 value)
4459 ;; All attribute keywords can have multiple lines.
4465 ;; List all ELEMENT's properties matching an attribute line or an
4466 ;; affiliated keyword, but ignore translated keywords since they
4467 ;; cannot belong to the property list.
4474 org-element-keyword-translation-alist)))))
4475 collect prop)
4478 ;; Because interpretation of the parse tree must return the same
4479 ;; number of blank lines between elements and the same number of white
4480 ;; space after objects, some special care must be given to white
4481 ;; spaces.
4482 ;;
4483 ;; The first function, `org-element-normalize-string', ensures any
4484 ;; string different from the empty string will end with a single
4485 ;; newline character.
4486 ;;
4487 ;; The second function, `org-element-normalize-contents', removes
4488 ;; global indentation from the contents of the current element.
4491 "Ensure string S ends with a single newline character.
4493 If S isn't a string return it unchanged. If S is the empty
4494 string, return it. Otherwise, return a new string with a single
4495 newline character at its end."
4503 "Normalize plain text in ELEMENT's contents.
4505 ELEMENT must only contain plain text and objects.
4507 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4508 indentation to compute maximal common indentation.
4510 Return the normalized element that is element with global
4511 indentation removed from its contents. The function assumes that
4512 indentation is not done with TAB characters."
4514 ;; Return minimal common indentation within BLOB. This is
4515 ;; done by walking recursively BLOB and updating MIN-IND
4516 ;; along the way. FIRST-FLAG is non-nil when the next
4517 ;; object is expected to be a string that doesn't start
4518 ;; with a newline character. It happens for strings at
4519 ;; the beginnings of the contents or right after a line
4520 ;; break.
4526 ;; Objects cannot start with spaces: in this case,
4527 ;; indentation is 0.
4531 ;; An indentation of zero means no string will
4532 ;; be modified. Quit the process.
4544 org-element-recursive-objects)
4547 object first-flag min-ind))))))))
4551 ;; Build ELEMENT back, replacing each string with the same
4552 ;; string minus common indentation.
4555 ;; Return DATUM with all its strings indentation
4556 ;; shortened from MIN-IND white spaces.
4557 ;; FIRST-FLAG is non-nil when the next object is
4558 ;; expected to be a string that doesn't start with
4559 ;; a newline character.
4575 org-element-recursive-objects)
4579 object)
4582 datum)))
4586 \f
4587 ;;; Cache
4588 ;;
4589 ;; Implement a caching mechanism for `org-element-at-point' and
4590 ;; `org-element-context', which see.
4591 ;;
4592 ;; A single public function is provided: `org-element-cache-reset'.
4593 ;;
4594 ;; Cache is enabled by default, but can be disabled globally with
4595 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4596 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4597 ;; can be tweaked to control caching behaviour.
4598 ;;
4599 ;; Internally, parsed elements are stored in an AVL tree,
4600 ;; `org-element--cache'. This tree is updated lazily: whenever
4601 ;; a change happens to the buffer, a synchronization request is
4602 ;; registered in `org-element--cache-sync-requests' (see
4603 ;; `org-element--cache-submit-request'). During idle time, requests
4604 ;; are processed by `org-element--cache-sync'. Synchronization also
4605 ;; happens when an element is required from the cache. In this case,
4606 ;; the process stops as soon as the needed element is up-to-date.
4607 ;;
4608 ;; A synchronization request can only apply on a synchronized part of
4609 ;; the cache. Therefore, the cache is updated at least to the
4610 ;; location where the new request applies. Thus, requests are ordered
4611 ;; from left to right and all elements starting before the first
4612 ;; request are correct. This property is used by functions like
4613 ;; `org-element--cache-find' to retrieve elements in the part of the
4614 ;; cache that can be trusted.
4615 ;;
4616 ;; A request applies to every element, starting from its original
4617 ;; location (or key, see below). When a request is processed, it
4618 ;; moves forward and may collide the next one. In this case, both
4619 ;; requests are merged into a new one that starts from that element.
4620 ;; As a consequence, the whole synchronization complexity does not
4621 ;; depend on the number of pending requests, but on the number of
4622 ;; elements the very first request will be applied on.
4623 ;;
4624 ;; Elements cannot be accessed through their beginning position, which
4625 ;; may or may not be up-to-date. Instead, each element in the tree is
4626 ;; associated to a key, obtained with `org-element--cache-key'. This
4627 ;; mechanism is robust enough to preserve total order among elements
4628 ;; even when the tree is only partially synchronized.
4629 ;;
4630 ;; Objects contained in an element are stored in a hash table,
4631 ;; `org-element--cache-objects'.
4635 "Non nil when Org parser should cache its results.
4642 "Maximum duration, as a time value, for a cache synchronization.
4643 If the synchronization is not over after this delay, the process
4644 pauses and resumes after `org-element-cache-sync-break'
4648 "Duration, as a time value, of the pause between synchronizations.
4652 ;;;; Data Structure
4655 "AVL tree used to cache elements.
4656 Each node of the tree contains an element. Comparison is done
4657 with `org-element--cache-compare'. This cache is used in
4661 "Hash table used as to cache objects.
4662 Key is an element, as returned by `org-element-at-point', and
4663 value is an alist where each association is:
4665 \(PARENT COMPLETEP . OBJECTS)
4667 where PARENT is an element or object, COMPLETEP is a boolean,
4668 non-nil when all direct children of parent are already cached and
4669 OBJECTS is a list of such children, as objects, from farthest to
4670 closest.
4673 contained within a paragraph
4677 If the paragraph is completely parsed, OBJECTS-DATA will be
4679 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4680 \(BOLD-OBJECT t ENTITY-OBJECT))
4682 whereas in a partially parsed paragraph, it could be
4684 \((PARAGRAPH nil ENTITY-OBJECT))
4689 "List of pending synchronization requests.
4691 A request is a vector with the following pattern:
4693 \[NEXT BEG END OFFSET PARENT PHASE]
4695 Processing a synchronization request consists of three phases:
4697 0. Delete modified elements,
4698 1. Fill missing area in cache,
4699 2. Shift positions and re-parent elements after the changes.
4701 During phase 0, NEXT is the key of the first element to be
4702 removed, BEG and END is buffer position delimiting the
4703 modifications. Elements starting between them (inclusive) are
4704 removed. So are elements whose parent is removed. PARENT, when
4705 non-nil, is the parent of the first element to be removed.
4707 During phase 1, NEXT is the key of the next known element in
4708 cache and BEG its beginning position. Parse buffer between that
4709 element and the one before it in order to determine the parent of
4710 the next element. Set PARENT to the element containing NEXT.
4712 During phase 2, NEXT is the key of the next element to shift in
4713 the parse tree. All elements starting from this one have their
4714 properties relatives to buffer positions shifted by integer
4715 OFFSET and, if they belong to element PARENT, are adopted by it.
4723 "Hash table used to store keys during synchronization.
4727 "Return a unique key for ELEMENT in cache tree.
4729 Keys are used to keep a total order among elements in the cache.
4730 Comparison is done with `org-element--cache-key-less-p'.
4732 When no synchronization is taking place, a key is simply the
4733 beginning position of the element, or that position plus one in
4734 the case of an first item (respectively row) in
4735 a list (respectively a table).
4737 During a synchronization, the key is the one the element had when
4738 the cache was synchronized for the last time. Elements added to
4739 cache during the synchronization get a new key generated with
4740 `org-element--cache-generate-key'.
4742 Such keys are stored in `org-element--cache-sync-keys'. The hash
4743 table is cleared once the synchronization is complete."
4746 ;; Increase beginning position of items (respectively
4747 ;; table rows) by one, so the first item can get
4748 ;; a different key from its parent list (respectively
4749 ;; table).
4752 begin)))
4755 key))))
4758 "Generate a key between LOWER and UPPER.
4760 LOWER and UPPER are integers or lists, possibly empty.
4762 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4763 a unique key, as an integer or a list of integers, according to
4764 the following rules:
4766 - LOWER and UPPER are compared level-wise until values differ.
4768 - If, at a given level, LOWER and UPPER differ from more than
4769 2, the new key shares all the levels above with LOWER and
4770 gets a new level. Its value is the mean between LOWER and
4771 UPPER:
4773 \(1 2) + (1 4) --> (1 3)
4775 - If LOWER has no value to compare with, it is assumed that its
4776 value is `most-negative-fixnum'. E.g.,
4778 \(1 1) + (1 1 2)
4780 is equivalent to
4782 \(1 1 m) + (1 1 2)
4784 where m is `most-negative-fixnum'. Likewise, if UPPER is
4785 short of levels, the current value is `most-positive-fixnum'.
4787 - If they differ from only one, the new key inherits from
4788 current LOWER level and fork it at the next level. E.g.,
4790 \(2 1) + (3 3)
4792 is equivalent to
4794 \(2 1) + (2 M)
4796 where M is `most-positive-fixnum'.
4798 - If the key is only one level long, it is returned as an
4799 integer:
4801 \(1 2) + (3 2) --> 2
4803 When they are not equals, the function assumes that LOWER is
4804 lesser than UPPER, per `org-element--cache-key-less-p'."
4808 skip-upper key)
4819 ;; When at a given level, LOWER and UPPER differ from
4820 ;; 1, ignore UPPER altogether. Instead create a key
4821 ;; between LOWER and the greatest key with the same
4822 ;; prefix as LOWER so far.
4828 "Non-nil if key A is less than key B.
4829 A and B are either integers or lists of integers, as returned by
4830 `org-element--cache-key'."
4838 ;; If A is empty, either keys are equal (B is also empty) and
4839 ;; we return nil, or A is lesser than B (B is longer) and we
4840 ;; return a non-nil value.
4841 ;;
4842 ;; If A is not empty, B is necessarily empty and A is greater
4843 ;; than B (A is longer). Therefore, return nil.
4847 "Non-nil when element A is located before element B."
4852 "Return root value in cache.
4853 This function assumes `org-element--cache' is a valid AVL tree."
4857 ;;;; Tools
4860 "Non-nil when cache is active in current buffer."
4865 "Find element in cache starting at POS or before.
4867 POS refers to a buffer position.
4869 When optional argument SIDE is non-nil, the function checks for
4870 elements starting at or past POS instead. If SIDE is `both', the
4871 function returns a cons cell where car is the first element
4872 starting at or before POS and cdr the first element starting
4873 after POS.
4875 The function can only find elements in the synchronized part of
4876 the cache."
4880 lower upper)
4895 ;; We found an element in cache starting at POS. If `side'
4896 ;; is `both' we also want the next one in order to generate
4897 ;; a key in-between.
4898 ;;
4899 ;; If the element is the first row or item in a table or
4900 ;; a plain list, we always return the table or the plain
4901 ;; list.
4902 ;;
4903 ;; In any other case, we return the element found.
4912 lower parent
4913 upper parent)))))
4916 lower element
4917 upper element)))))
4924 "Store ELEMENT in current buffer's cache, if allowed.
4925 When optional argument DATA is non-nil, assume is it object data
4926 relative to ELEMENT and store it in the objects cache."
4930 ;; During synchronization, first build an appropriate key
4931 ;; for the new element so `avl-tree-enter' can insert it at
4932 ;; the right spot in the cache.
4941 org-element--cache-sync-keys)))
4943 ;; Headlines are not stored in cache, so objects in titles are
4944 ;; not stored either.
4949 "Remove ELEMENT from cache.
4950 Assume ELEMENT belongs to cache and that a cache is active."
4955 ;;;; Synchronization
4958 "Set idle timer for cache synchronization in BUFFER."
4965 org-element-cache-sync-idle-time))
4966 nil
4967 #'org-element--cache-sync
4968 buffer)))
4971 "Non-nil when synchronization process should be interrupted.
4972 TIME-LIMIT is a time value or nil."
4978 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4980 Properties containing buffer positions are `:begin', `:end',
4981 `:contents-begin', `:contents-end' and `:structure'. When
4982 optional argument PROPS is a list of keywords, only shift
4983 properties provided in that list.
4985 Properties are modified by side-effect."
4987 ;; Shift `:structure' property for the first plain list only: it
4988 ;; is the only one that really matters and it prevents from
4989 ;; shifting it more than once.
5003 "Synchronize cache with recent modification in BUFFER.
5005 When optional argument THRESHOLD is non-nil, do the
5006 synchronization for all elements starting before or at threshold,
5007 then exit. Otherwise, synchronize cache for as long as
5008 `org-element-cache-sync-duration' or until Emacs leaves idle
5009 state.
5011 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5012 not registered yet in the cache are going to happen. It is used
5013 in `org-element--cache-submit-request', where cache is partially
5014 updated before current modification are actually submitted."
5025 request
5027 threshold
5030 org-element-cache-sync-duration))
5031 future-change)
5032 ;; Request processed. Merge current and next offsets and
5033 ;; transfer ending position.
5039 ;; If more requests are awaiting, set idle timer accordingly.
5040 ;; Otherwise, reset keys.
5047 "Process synchronization REQUEST for all entries before NEXT.
5049 REQUEST is a vector, built by `org-element--cache-submit-request'.
5051 NEXT is a cache key, as returned by `org-element--cache-key'.
5053 When non-nil, THRESHOLD is a buffer position. Synchronization
5054 stops as soon as a shifted element begins after it.
5056 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5057 after this time or when Emacs exits idle state.
5059 When non-nil, FUTURE-CHANGE is a buffer position where changes
5060 not registered yet in the cache are going to happen. See
5061 `org-element--cache-submit-request' for more information.
5063 Throw `interrupt' if the process stops before completing the
5064 request."
5067 ;; Phase 0.
5068 ;;
5069 ;; Delete all elements starting after BEG, but not after buffer
5070 ;; position END or past element with key NEXT. Also delete
5071 ;; elements contained within a previously removed element
5072 ;; (stored in `last-container').
5073 ;;
5074 ;; At each iteration, we start again at tree root since
5075 ;; a deletion modifies structure of the balanced tree.
5080 ;; Find first element in cache with key BEG or after it.
5084 data data-key last-container)
5093 data-key key
5096 data-key key
5097 node nil)))))
5107 up)))
5110 end))
5117 ;; No element starting after modifications left in
5118 ;; cache: further processing is futile.
5121 ;; Phase 1.
5122 ;;
5123 ;; Phase 0 left a hole in the cache. Some elements after it
5124 ;; could have parents within. For example, in the following
5125 ;; buffer:
5126 ;;
5127 ;; - item
5128 ;;
5129 ;;
5130 ;; Paragraph1
5131 ;;
5132 ;; Paragraph2
5133 ;;
5134 ;; if we remove a blank line between "item" and "Paragraph1",
5135 ;; everything down to "Paragraph2" is removed from cache. But
5136 ;; the paragraph now belongs to the list, and its `:parent'
5137 ;; property no longer is accurate.
5138 ;;
5139 ;; Therefore we need to parse again elements in the hole, or at
5140 ;; least in its last section, so that we can re-parent
5141 ;; subsequent elements, during phase 2.
5142 ;;
5143 ;; Note that we only need to get the parent from the first
5144 ;; element in cache after the hole.
5145 ;;
5146 ;; When next key is lesser or equal to the current one, delegate
5147 ;; phase 1 processing to next request in order to preserve key
5148 ;; order among requests.
5156 ;; Next element will start at its beginning position plus
5157 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5158 ;; contains the real beginning position of the first element to
5159 ;; shift and re-parent.
5163 ;; Changes are going to happen around this element and
5164 ;; they will trigger another phase 1 request. Skip the
5165 ;; current one.
5171 ;; Phase 2.
5172 ;;
5173 ;; Shift all elements starting from key START, but before NEXT, by
5174 ;; OFFSET, and re-parent them when appropriate.
5175 ;;
5176 ;; Elements are modified by side-effect so the tree structure
5177 ;; remains intact.
5178 ;;
5179 ;; Once THRESHOLD, if any, is reached, or once there is an input
5180 ;; pending, exit. Before leaving, the current synchronization
5181 ;; request is updated.
5188 exit-flag)
5189 ;; No re-parenting nor shifting planned: request is over.
5199 ;; We reached NEXT. Request is complete.
5201 ;; Handle interruption request. Update current request.
5206 ;; Shift element.
5209 ;; Shift associated objects data, if any.
5214 ;; Update PARENT and re-parent DATA, only when
5215 ;; necessary. Propagate new structures for lists.
5229 ;; Cache is up-to-date past THRESHOLD. Request
5230 ;; interruption.
5235 ;; We reached end of tree: synchronization complete.
5236 t)))
5239 "Parse elements in current section, down to POS.
5241 Start parsing from the closest between the last known element in
5242 cache or headline above. Return the smallest element containing
5243 POS.
5245 When optional argument SYNCP is non-nil, return the parent of the
5246 element containing POS instead. In that case, it is also
5247 possible to provide TIME-LIMIT, which is a time value specifying
5248 when the parsing should stop. The function throws `interrupt' if
5249 the process stopped before finding the expected result."
5256 element next mode)
5258 ;; Nothing in cache before point: start parsing from first
5259 ;; element following headline above, or first element in
5260 ;; buffer.
5267 ;; Cache returned exact match: return it.
5270 ;; There's a headline between cached value and POS: cached
5271 ;; value is invalid. Start parsing from first element
5272 ;; following the headline.
5279 ;; Check if CACHED or any of its ancestors contain point.
5280 ;;
5281 ;; If there is such an element, we inspect it in order to know
5282 ;; if we return it or if we need to parse its contents.
5283 ;; Otherwise, we just start parsing from current location,
5284 ;; which is right after the top-most element containing
5285 ;; CACHED.
5286 ;;
5287 ;; As a special case, if POS is at the end of the buffer, we
5288 ;; want to return the innermost element ending there.
5289 ;;
5290 ;; Also, if we find an ancestor and discover that we need to
5291 ;; parse its contents, make sure we don't start from
5292 ;; `:contents-begin', as we would otherwise go past CACHED
5293 ;; again. Instead, in that situation, we will resume parsing
5294 ;; from NEXT, which is located after CACHED or its higher
5295 ;; ancestor not containing point.
5307 ;; Parse successively each element until we reach POS.
5320 end 'element mode
5327 ;; Skip any element ending before point. Also skip
5328 ;; element ending at point (unless it is also the end of
5329 ;; buffer) since we're sure that another element begins
5330 ;; after it.
5334 ;; A non-greater element contains point: return it.
5337 ;; Otherwise, we have to decide if ELEMENT really
5338 ;; contains POS. In that case we start parsing from
5339 ;; contents' beginning.
5340 ;;
5341 ;; If POS is at contents' beginning but it is also at
5342 ;; the beginning of the first item in a list or a table.
5343 ;; In that case, we need to create an anchor for that
5344 ;; list or table, so return it.
5345 ;;
5346 ;; Also, if POS is at the end of the buffer, no element
5347 ;; can start after it, but more than one may end there.
5348 ;; Arbitrarily, we choose to return the innermost of
5349 ;; such elements.
5362 parent element
5363 end cend))))
5364 ;; Otherwise, return ELEMENT as it is the smallest
5365 ;; element containing POS.
5370 ;;;; Staging Buffer Changes
5381 "Regexp matching a sensitive line, structure wise.
5382 A sensitive line is a headline, inlinetask, block, drawer, or
5383 latex-environment boundary. When such a line is modified,
5384 structure changes in the document may propagate in the whole
5388 "Non-nil when a sensitive line is about to be changed.
5392 "Request extension of area going to be modified if needed.
5393 BEG and END are the beginning and end of the range of changed
5394 text. See `before-change-functions' for more information."
5404 'headline
5407 org-element--cache-sensitive-re bottom t)))))))))
5410 "Update buffer modifications for current buffer.
5411 BEG and END are the beginning and end of the range of changed
5412 text, and the length in bytes of the pre-change text replaced by
5413 that range. See `after-change-functions' for more information."
5421 ;; Determine if modified area needs to be extended, according
5422 ;; to both previous and current state. We make a special
5423 ;; case for headline editing: if a headline is modified but
5424 ;; not removed, do not extend.
5427 (`headline
5433 org-element--cache-sensitive-re bottom t))))
5434 ;; Effectively extend modified area.
5442 ;; Store synchronization request.
5445 ;; Activate a timer to process the request during idle time.
5449 "Return first element to remove from cache.
5451 BEG and END are buffer positions delimiting buffer modifications.
5452 OFFSET is the size of the changes.
5454 Returned element is usually the first element in cache containing
5455 any position between BEG and END. As an exception, greater
5456 elements around the changes that are robust to contents
5457 modifications are preserved and updated according to the
5458 changes."
5468 special-block))
5469 ;; Drawers named "PROPERTIES" are probably
5470 ;; a properties drawer being edited. Force
5471 ;; parsing to check if editing is over.
5480 ;; UP is a robust greater element containing changes.
5481 ;; We only need to extend its ending boundaries.
5487 ;; We're at top level element containing ELEMENT: if it's
5488 ;; altered by buffer modifications, it is first element in
5489 ;; cache to be removed. Otherwise, that first element is the
5490 ;; following one.
5491 ;;
5492 ;; As a special case, do not remove BEFORE if it is a robust
5493 ;; container for current changes.
5495 before)))))
5498 "Submit a new cache synchronization request for current buffer.
5499 BEG and END are buffer positions delimiting the minimal area
5500 where cache data should be removed. OFFSET is the size of the
5501 change, as an integer."
5503 delete-to delete-from)
5508 ;; Current changes can be merged with first sync request: we
5509 ;; can save a partial cache synchronization.
5512 ;; If last change happened within area to be removed, extend
5513 ;; boundaries of robust parents, if any. Otherwise, find
5514 ;; first element to remove and update request accordingly.
5526 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5527 ;; if any, is no longer a 0-phase request, thus ensuring that
5528 ;; phases are properly ordered. We need to provide OFFSET as
5529 ;; optional parameter since current modifications are not known
5530 ;; yet to the otherwise correct part of the cache (i.e, before
5531 ;; the first request).
5538 ;; When changes happen before the first known
5539 ;; element, re-parent and shift the rest of the
5540 ;; cache.
5542 ;; Otherwise, we find the first non robust
5543 ;; element containing END. All elements between
5544 ;; FIRST and this one are to be removed.
5555 element up))
5557 org-element--cache-sync-requests)
5558 ;; No element to remove. No need to re-parent either.
5559 ;; Simply shift additional elements, if any, by OFFSET.
5564 ;;;; Public Functions
5566 ;;;###autoload
5568 "Reset cache in current buffer.
5569 When optional argument ALL is non-nil, reset cache in all Org
5570 buffers."
5588 ;;;###autoload
5590 "Refresh cache at position POS."
5597 \f
5598 ;;; The Toolbox
5599 ;;
5600 ;; The first move is to implement a way to obtain the smallest element
5601 ;; containing point. This is the job of `org-element-at-point'. It
5602 ;; basically jumps back to the beginning of section containing point
5603 ;; and proceed, one element after the other, with
5604 ;; `org-element--current-element' until the container is found. Note:
5605 ;; When using `org-element-at-point', secondary values are never
5606 ;; parsed since the function focuses on elements, not on objects.
5607 ;;
5608 ;; At a deeper level, `org-element-context' lists all elements and
5609 ;; objects containing point.
5610 ;;
5611 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5612 ;; internally by navigation and manipulation tools.
5615 ;;;###autoload
5617 "Determine closest element around point.
5619 Return value is a list like (TYPE PROPS) where TYPE is the type
5620 of the element and PROPS a plist of properties associated to the
5621 element.
5623 Possible types are defined in `org-element-all-elements'.
5624 Properties depend on element or object type, but always include
5625 `:begin', `:end', `:parent' and `:post-blank' properties.
5627 As a special case, if point is at the very beginning of the first
5628 item in a list or sub-list, returned element will be that list
5629 instead of the item. Likewise, if point is at the beginning of
5630 the first row of a table, returned element will be the table
5631 instead of the first row.
5633 When point is at the end of the buffer, return the innermost
5634 element ending there."
5640 ;; Within blank lines at the beginning of buffer, return nil.
5642 ;; Within blank lines right after a headline, return that
5643 ;; headline.
5647 ;; Otherwise parse until we find element containing ORIGIN.
5654 ;;;###autoload
5656 "Return smallest element or object around point.
5658 Return value is a list like (TYPE PROPS) where TYPE is the type
5659 of the element or object and PROPS a plist of properties
5660 associated to it.
5662 Possible types are defined in `org-element-all-elements' and
5663 `org-element-all-objects'. Properties depend on element or
5664 object type, but always include `:begin', `:end', `:parent' and
5665 `:post-blank'.
5667 As a special case, if point is right after an object and not at
5668 the beginning of any other object, return that object.
5670 Optional argument ELEMENT, when non-nil, is the closest element
5671 containing point, as returned by `org-element-at-point'.
5672 Providing it allows for quicker computation."
5678 ;; If point is inside an element containing objects or
5679 ;; a secondary string, narrow buffer to the container and
5680 ;; proceed with parsing. Otherwise, return ELEMENT.
5682 ;; At a parsed affiliated keyword, check if we're inside main
5683 ;; or dual value.
5690 org-element-parsed-keywords))
5699 ;; Also change type to retrieve correct restrictions.
5701 ;; At an item, objects can only be located within tag, if any.
5711 ;; At an headline or inlinetask, objects are in title.
5718 ;; At a paragraph, a table-row or a verse block, objects are
5719 ;; located within their contents.
5723 ;; CBEG is nil for table rules.
5728 ;; At a planning line, if point is at a timestamp, return it,
5729 ;; otherwise, return element.
5737 ;; All other locations cannot contain objects: bail out.
5747 next object-data last)
5751 ;; When entering PARENT for the first time, get list
5752 ;; of objects within known so far. Store it in
5753 ;; OBJECT-DATA.
5758 ;; Find NEXT object for analysis.
5760 ;; If NEXT is non-nil, we already exhausted the
5761 ;; cache so we can parse buffer to find the object
5762 ;; after it.
5764 ;; Otherwise, check if cache can help us.
5775 ;; Cache contains the information needed.
5778 pos)
5780 pos)
5786 ;; If we have a new object to analyze, store it in
5787 ;; cache. Otherwise record that there is nothing
5788 ;; more to parse in this element at this depth.
5793 ;; Process NEXT, if any, in order to know if we need
5794 ;; to skip it, return it or move into it.
5801 ;; Skip objects ending before point. Also skip
5802 ;; objects ending at point unless it is also the
5803 ;; end of buffer, since we want to return the
5804 ;; innermost object.
5807 ;; For convenience, when object ends at POS,
5808 ;; without any space, store it in LAST, as we
5809 ;; will return it if no object starts here.
5813 ;; If POS is within a container object, move
5814 ;; into that object.
5818 ;; At contents' end, if there is no
5819 ;; space before point, also move into
5820 ;; object, for consistency with
5821 ;; convenience feature above.
5830 next nil
5831 object-data nil))
5832 ;; Otherwise, return NEXT.
5834 ;; Store results in cache, if applicable.
5838 "List all ancestors of a given element or object.
5840 BLOB is an object or element.
5842 When optional argument TYPES is a list of symbols, return the
5843 first element or object in the lineage whose type belongs to that
5844 list.
5846 When optional argument WITH-SELF is non-nil, lineage includes
5847 BLOB itself as the first element, and TYPES, if provided, also
5848 apply to it.
5850 When BLOB is obtained through `org-element-context' or
5851 `org-element-at-point', only ancestors from its section can be
5852 found. There is no such limitation when BLOB belongs to a full
5853 parse tree."
5855 ancestors)
5862 "Non-nil when elements ELEM-A and ELEM-B are nested."
5871 "Swap elements ELEM-A and ELEM-B.
5872 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5873 end of ELEM-A."
5875 ;; There are two special cases when an element doesn't start at bol:
5876 ;; the first paragraph in an item or in a footnote definition.
5878 ;; Only a paragraph without any affiliated keyword can be moved at
5879 ;; ELEM-A position in such a situation. Note that the case of
5880 ;; a footnote definition is impossible: it cannot contain two
5881 ;; paragraphs in a row because it cannot contain a blank line.
5887 ;; In a special situation, ELEM-A will have no indentation. We'll
5888 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5902 ;; Store inner overlays responsible for visibility status.
5903 ;; We also need to store their boundaries as they will be
5904 ;; removed from buffer.
5919 ;; Get contents.
5927 ;; Restore ex ELEM-A overlays.
5934 ;; Restore ex ELEM-B overlays.
5940 "Remove maximum common indentation in string S and return it.
5941 When optional argument N is a positive integer, remove exactly
5942 that much characters from indentation, if possible, or return
5943 S as-is otherwise. Unlike to `org-remove-indentation', this
5944 function doesn't call `untabify' on S."
5949 ;; Find maximum common indentation, if not specified.
5957 min-ind)))
5959 ;; Remove exactly N indentation, but give up if not possible.
5972 ;; Local variables:
5973 ;; generated-autoload-file: "org-loaddefs.el"
5974 ;; End:
5976 ;;; org-element.el ends here