| blob | 4760e09fbda87eac41606c225abb563b840521d2 |
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
1280 ;;;; Plain List
1283 ;; Return structure of list at point. Internal function. See
1284 ;; `org-list-struct' for details.
1289 items struct)
1294 ;; At limit: end all items.
1303 ;; At list end: end all items.
1308 ;; At a new item: end previous sibling.
1320 ind
1321 bullet
1324 ;; Description tag.
1328 ;; Ending position, unknown so far.
1329 nil)))
1330 items))
1332 ;; Skip empty lines.
1334 ;; Skip inline tasks and blank lines along the way.
1341 ;; At some text line. Check if it ends any previous item.
1354 ;; Skip blocks (any type) and drawers contents.
1359 limit t)))
1365 "Parse a plain list.
1367 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1368 the buffer position at the beginning of the first affiliated
1369 keyword and CDR is a plist of affiliated keywords along with
1370 their value. STRUCTURE is the structure of the plain list being
1371 parsed.
1373 Return a list whose CAR is `plain-list' and CDR is a plist
1374 containing `:type', `:begin', `:end', `:contents-begin' and
1375 `:contents-end', `:structure', `:post-blank' and
1376 `:post-affiliated' keywords.
1378 Assume point is at the beginning of the list."
1392 pos))
1396 ;; Return value.
1400 :begin begin
1401 :end end
1402 :contents-begin contents-begin
1403 :contents-end contents-end
1404 :structure struct
1410 "Interpret plain-list element as Org syntax.
1411 CONTENTS is the contents of the element."
1419 ;;;; Property Drawer
1422 "Parse a property drawer.
1424 LIMIT bounds the search.
1426 Return a list whose car is `property-drawer' and cdr is a plist
1427 containing `:begin', `:end', `:contents-begin', `:contents-end',
1428 `:post-blank' and `:post-affiliated' keywords.
1430 Assume point is at the beginning of the property drawer."
1443 :end end
1445 :contents-end contents-end
1450 "Interpret property-drawer element as Org syntax.
1451 CONTENTS is the properties within the drawer."
1455 ;;;; Quote Block
1458 "Parse a quote block.
1460 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1461 the buffer position at the beginning of the first affiliated
1462 keyword and CDR is a plist of affiliated keywords along with
1463 their value.
1465 Return a list whose CAR is `quote-block' and CDR is a plist
1466 containing `:begin', `:end', `:contents-begin', `:contents-end',
1467 `:post-blank' and `:post-affiliated' keywords.
1469 Assume point is at the beginning of the block."
1473 ;; Incomplete block: parse it as a paragraph.
1479 ;; Empty blocks have no contents.
1492 :end end
1493 :contents-begin contents-begin
1494 :contents-end contents-end
1500 "Interpret quote-block element as Org syntax.
1501 CONTENTS is the contents of the element."
1505 ;;;; Section
1508 "Parse a section.
1510 Return a list whose CAR is `section' and CDR is a plist
1511 containing `:begin', `:end', `:contents-begin', `contents-end',
1512 `:post-blank' and `:post-affiliated' keywords."
1514 ;; Beginning of section is the beginning of the first non-blank
1515 ;; line after previous headline.
1523 :end end
1524 :contents-begin begin
1525 :contents-end pos-before-blank
1530 "Interpret section element as Org syntax.
1531 CONTENTS is the contents of the element."
1532 contents)
1535 ;;;; Special Block
1538 "Parse a special block.
1540 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1541 the buffer position at the beginning of the first affiliated
1542 keyword and CDR is a plist of affiliated keywords along with
1543 their value.
1545 Return a list whose CAR is `special-block' and CDR is a plist
1546 containing `:type', `:begin', `:end', `:contents-begin',
1547 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1549 Assume point is at the beginning of the block."
1556 limit t)))
1557 ;; Incomplete block: parse it as a paragraph.
1563 ;; Empty blocks have no contents.
1576 :begin begin
1577 :end end
1578 :contents-begin contents-begin
1579 :contents-end contents-end
1585 "Interpret SPECIAL-BLOCK element as Org syntax.
1586 CONTENTS is the contents of the element."
1591 \f
1592 ;;; Elements
1593 ;;
1594 ;; For each element, a parser and an interpreter are also defined.
1595 ;; Both follow the same naming convention used for greater elements.
1596 ;;
1597 ;; Also, as for greater elements, adding a new element type is done
1598 ;; through the following steps: implement a parser and an interpreter,
1599 ;; tweak `org-element--current-element' so that it recognizes the new
1600 ;; type and add that new type to `org-element-all-elements'.
1601 ;;
1602 ;; As a special case, when the newly defined type is a block type,
1603 ;; `org-element-block-name-alist' has to be modified accordingly.
1606 ;;;; Babel Call
1609 "Parse a babel call.
1611 LIMIT bounds the search. AFFILIATED is a list of which car is
1612 the buffer position at the beginning of the first affiliated
1613 keyword and cdr is a plist of affiliated keywords along with
1614 their value.
1616 Return a list whose car is `babel-call' and cdr is a plist
1617 containing `:call', `:inside-header', `:arguments',
1618 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1619 `:post-affiliated' as keywords."
1633 value)))
1643 :begin begin
1644 :end end
1645 :value value
1651 "Interpret BABEL-CALL element as Org syntax."
1661 ;;;; Clock
1664 "Parse a clock.
1666 LIMIT bounds the search.
1668 Return a list whose CAR is `clock' and CDR is a plist containing
1669 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1670 `:post-affiliated' as keywords."
1690 :value value
1691 :duration duration
1692 :begin begin
1693 :end end
1694 :post-blank post-blank
1698 "Interpret CLOCK element as Org syntax."
1706 "%2s:%02s"
1710 ;;;; Comment
1713 "Parse a comment.
1715 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1716 the buffer position at the beginning of the first affiliated
1717 keyword and CDR is a plist of affiliated keywords along with
1718 their value.
1720 Return a list whose CAR is `comment' and CDR is a plist
1721 containing `:begin', `:end', `:value', `:post-blank',
1722 `:post-affiliated' keywords.
1724 Assume point is at comment beginning."
1733 ;; Get comments ending.
1736 ;; Accumulate lines without leading hash and first
1737 ;; whitespace.
1751 :end end
1752 :value value
1758 "Interpret COMMENT element as Org syntax.
1759 CONTENTS is nil."
1763 ;;;; Comment Block
1766 "Parse an export block.
1768 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1769 the buffer position at the beginning of the first affiliated
1770 keyword and CDR is a plist of affiliated keywords along with
1771 their value.
1773 Return a list whose CAR is `comment-block' and CDR is a plist
1774 containing `:begin', `:end', `:value', `:post-blank' and
1775 `:post-affiliated' keywords.
1777 Assume point is at comment block beginning."
1781 ;; Incomplete block: parse it as a paragraph.
1794 contents-begin contents-end)))
1798 :end end
1799 :value value
1805 "Interpret COMMENT-BLOCK element as Org syntax."
1812 ;;;; Diary Sexp
1815 "Parse a diary sexp.
1817 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1818 the buffer position at the beginning of the first affiliated
1819 keyword and CDR is a plist of affiliated keywords along with
1820 their value.
1822 Return a list whose CAR is `diary-sexp' and CDR is a plist
1823 containing `:begin', `:end', `:value', `:post-blank' and
1824 `:post-affiliated' keywords."
1836 :begin begin
1837 :end end
1843 "Interpret DIARY-SEXP as Org syntax."
1847 ;;;; Example Block
1850 "Parse an example block.
1852 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1853 the buffer position at the beginning of the first affiliated
1854 keyword and CDR is a plist of affiliated keywords along with
1855 their value.
1857 Return a list whose CAR is `example-block' and CDR is a plist
1858 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1859 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1860 `:value', `:post-blank' and `:post-affiliated' keywords."
1864 ;; Incomplete block: parse it as a paragraph.
1872 ;; Switches analysis
1879 ;; Should labels be retained in (or stripped from) example
1880 ;; blocks?
1885 ;; What should code-references use - labels or
1886 ;; line-numbers?
1895 ;; Standard block parsing.
1903 contents-begin contents-end))
1904 block-ind))
1913 :end end
1914 :value value
1915 :switches switches
1916 :number-lines number-lines
1917 :preserve-indent preserve-indent
1918 :retain-labels retain-labels
1919 :use-labels use-labels
1920 :label-fmt label-fmt
1926 "Interpret EXAMPLE-BLOCK element as Org syntax."
1934 value
1939 ;;;; Export Block
1942 "Parse an export block.
1944 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1945 the buffer position at the beginning of the first affiliated
1946 keyword and CDR is a plist of affiliated keywords along with
1947 their value.
1949 Return a list whose CAR is `export-block' and CDR is a plist
1950 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1951 `:post-affiliated' keywords.
1953 Assume point is at export-block beginning."
1960 ;; Incomplete block: parse it as a paragraph.
1973 contents-end)))
1977 :end end
1978 :type type
1979 :value value
1985 "Interpret EXPORT-BLOCK element as Org syntax."
1992 ;;;; Fixed-width
1995 "Parse a fixed-width section.
1997 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1998 the buffer position at the beginning of the first affiliated
1999 keyword and CDR is a plist of affiliated keywords along with
2000 their value.
2002 Return a list whose CAR is `fixed-width' and CDR is a plist
2003 containing `:begin', `:end', `:value', `:post-blank' and
2004 `:post-affiliated' keywords.
2006 Assume point is at the beginning of the fixed-width area."
2010 value
2015 ;; Accumulate text without starting colons.
2028 :end end
2029 :value value
2035 "Interpret FIXED-WIDTH element as Org syntax."
2043 ;;;; Horizontal Rule
2046 "Parse an horizontal rule.
2048 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2049 the buffer position at the beginning of the first affiliated
2050 keyword and CDR is a plist of affiliated keywords along with
2051 their value.
2053 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2054 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2055 keywords."
2065 :end end
2071 "Interpret HORIZONTAL-RULE element as Org syntax."
2075 ;;;; Keyword
2078 "Parse a keyword at point.
2080 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2081 the buffer position at the beginning of the first affiliated
2082 keyword and CDR is a plist of affiliated keywords along with
2083 their value.
2085 Return a list whose CAR is `keyword' and CDR is a plist
2086 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2087 `:post-affiliated' keywords."
2089 ;; An orphaned affiliated keyword is considered as a regular
2090 ;; keyword. In this case AFFILIATED is nil, so we take care of
2091 ;; this corner case.
2104 :value value
2105 :begin begin
2106 :end end
2112 "Interpret KEYWORD element as Org syntax."
2118 ;;;; Latex Environment
2122 "Regexp matching the beginning of a LaTeX environment.
2123 The environment is captured by the first group.
2129 "Format string matching the ending of a LaTeX environment.
2133 "Parse a LaTeX environment.
2135 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2136 the buffer position at the beginning of the first affiliated
2137 keyword and CDR is a plist of affiliated keywords along with
2138 their value.
2140 Return a list whose CAR is `latex-environment' and CDR is a plist
2141 containing `:begin', `:end', `:value', `:post-blank' and
2142 `:post-affiliated' keywords.
2144 Assume point is at the beginning of the latex environment."
2151 limit t))
2152 ;; Incomplete latex environment: parse it as a paragraph.
2162 :end end
2163 :value value
2169 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2173 ;;;; Node Property
2176 "Parse a node-property at point.
2178 LIMIT bounds the search.
2180 Return a list whose CAR is `node-property' and CDR is a plist
2181 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2182 `:post-affiliated' keywords."
2192 limit))))
2195 :value value
2196 :begin begin
2197 :end end
2202 "Interpret NODE-PROPERTY element as Org syntax."
2208 ;;;; Paragraph
2211 "Parse a paragraph.
2213 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2214 the buffer position at the beginning of the first affiliated
2215 keyword and CDR is a plist of affiliated keywords along with
2216 their value.
2218 Return a list whose CAR is `paragraph' and CDR is a plist
2219 containing `:begin', `:end', `:contents-begin' and
2220 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2222 Assume point is at the beginning of the paragraph."
2229 ;; A matching `org-element-paragraph-separate' is not
2230 ;; necessarily the end of the paragraph. In particular,
2231 ;; drawers, blocks or LaTeX environments opening lines
2232 ;; must be closed. Moreover keywords with a secondary
2233 ;; value must belong to "dual keywords".
2247 limit t)))
2253 limit t)))
2256 org-element-dual-keywords))
2257 ;; Everything else is unambiguous.
2270 :end end
2271 :contents-begin contents-begin
2272 :contents-end contents-end
2278 "Interpret paragraph element as Org syntax.
2279 CONTENTS is the contents of the element."
2280 contents)
2283 ;;;; Planning
2286 "Parse a planning.
2288 LIMIT bounds the search.
2290 Return a list whose CAR is `planning' and CDR is a plist
2291 containing `:closed', `:deadline', `:scheduled', `:begin',
2292 `:end', `:post-blank' and `:post-affiliated' keywords."
2302 closed deadline scheduled)
2314 :deadline deadline
2315 :scheduled scheduled
2316 :begin begin
2317 :end end
2318 :post-blank post-blank
2322 "Interpret PLANNING element as Org syntax."
2324 #'identity
2341 ;;;; Src Block
2344 "Parse a src block.
2346 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2347 the buffer position at the beginning of the first affiliated
2348 keyword and CDR is a plist of affiliated keywords along with
2349 their value.
2351 Return a list whose CAR is `src-block' and CDR is a plist
2352 containing `:language', `:switches', `:parameters', `:begin',
2353 `:end', `:number-lines', `:retain-labels', `:use-labels',
2354 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2355 `:post-affiliated' keywords.
2357 Assume point is at the beginning of the block."
2360 limit t)))
2361 ;; Incomplete block: parse it as a paragraph.
2367 ;; Get language as a string.
2376 ;; Get switches.
2378 ;; Get parameters.
2380 ;; Switches analysis
2391 ;; Should labels be retained in (or stripped from)
2392 ;; src blocks?
2397 ;; What should code-references use - labels or
2398 ;; line-numbers?
2403 ;; Indentation.
2405 ;; Retrieve code.
2410 block-ind))
2414 ;; Get position after ending blank lines.
2424 :begin begin
2425 :end end
2426 :number-lines number-lines
2427 :preserve-indent preserve-indent
2428 :retain-labels retain-labels
2429 :use-labels use-labels
2430 :label-fmt label-fmt
2431 :value value
2437 "Interpret SRC-BLOCK element as Org syntax."
2446 val)
2460 ;;;; Table
2463 "Parse a table at point.
2465 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2466 the buffer position at the beginning of the first affiliated
2467 keyword and CDR is a plist of affiliated keywords along with
2468 their value.
2470 Return a list whose CAR is `table' and CDR is a plist containing
2471 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2472 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2473 keywords.
2475 Assume point is at the beginning of the table."
2491 acc))
2498 :end end
2499 :type type
2500 :tblfm tblfm
2501 ;; Only `org' tables have contents. `table.el' tables
2502 ;; use a `:value' property to store raw table as
2503 ;; a string.
2508 table-begin table-end))
2514 "Interpret TABLE element as Org syntax.
2515 CONTENTS is a string, if table's type is `org', or nil."
2526 ;;;; Table Row
2529 "Parse table row at point.
2531 Return a list whose CAR is `table-row' and CDR is a plist
2532 containing `:begin', `:end', `:contents-begin', `:contents-end',
2533 `:type', `:post-blank' and `:post-affiliated' keywords."
2537 ;; A table rule has no contents. In that case, ensure
2538 ;; CONTENTS-BEGIN matches CONTENTS-END.
2548 :begin begin
2549 :end end
2550 :contents-begin contents-begin
2551 :contents-end contents-end
2556 "Interpret TABLE-ROW element as Org syntax.
2557 CONTENTS is the contents of the table row."
2562 ;;;; Verse Block
2565 "Parse a verse block.
2567 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2568 the buffer position at the beginning of the first affiliated
2569 keyword and CDR is a plist of affiliated keywords along with
2570 their value.
2572 Return a list whose CAR is `verse-block' and CDR is a plist
2573 containing `:begin', `:end', `:contents-begin', `:contents-end',
2574 `:post-blank' and `:post-affiliated' keywords.
2576 Assume point is at beginning of the block."
2580 ;; Incomplete block: parse it as a paragraph.
2595 :end end
2596 :contents-begin contents-begin
2597 :contents-end contents-end
2603 "Interpret verse-block element as Org syntax.
2604 CONTENTS is verse block contents."
2608 \f
2609 ;;; Objects
2610 ;;
2611 ;; Unlike to elements, raw text can be found between objects. Hence,
2612 ;; `org-element--object-lex' is provided to find the next object in
2613 ;; buffer.
2614 ;;
2615 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2616 ;; object types they can contain will be specified in
2617 ;; `org-element-object-restrictions'.
2618 ;;
2619 ;; Creating a new type of object requires to alter
2620 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2621 ;; new type in `org-element-all-objects', and possibly add
2622 ;; restrictions in `org-element-object-restrictions'.
2624 ;;;; Bold
2627 "Parse bold object at point, if any.
2629 When at a bold object, return a list whose car is `bold' and cdr
2630 is a plist with `:begin', `:end', `:contents-begin' and
2631 `:contents-end' and `:post-blank' keywords. Otherwise, return
2632 nil.
2634 Assume point is at the first star marker."
2646 :end end
2647 :contents-begin contents-begin
2648 :contents-end contents-end
2652 "Interpret bold object as Org syntax.
2653 CONTENTS is the contents of the object."
2657 ;;;; Code
2660 "Parse code object at point, if any.
2662 When at a code object, return a list whose car is `code' and cdr
2663 is a plist with `:value', `:begin', `:end' and `:post-blank'
2664 keywords. Otherwise, return nil.
2666 Assume point is at the first tilde marker."
2677 :begin begin
2678 :end end
2682 "Interpret CODE object as Org syntax."
2686 ;;;; Entity
2689 "Parse entity at point, if any.
2691 When at an entity, return a list whose car is `entity' and cdr
2692 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2693 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2694 `:post-blank' as keywords. Otherwise, return nil.
2696 Assume point is at the beginning of the entity."
2698 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2716 :begin begin
2717 :end end
2718 :use-brackets-p bracketsp
2722 "Interpret ENTITY object as Org syntax."
2728 ;;;; Export Snippet
2731 "Parse export snippet at point.
2733 When at an export snippet, return a list whose car is
2734 `export-snippet' and cdr a plist with `:begin', `:end',
2735 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2736 return nil.
2738 Assume point is at the beginning of the snippet."
2754 :value value
2755 :begin begin
2756 :end end
2760 "Interpret EXPORT-SNIPPET object as Org syntax."
2766 ;;;; Footnote Reference
2769 "Parse footnote reference at point, if any.
2771 When at a footnote reference, return a list whose car is
2772 `footnote-reference' and cdr a plist with `:label', `:type',
2773 `:begin', `:end', `:content-begin', `:contents-end' and
2774 `:post-blank' as keywords. Otherwise, return nil."
2794 :type type
2795 :begin begin
2796 :end end
2802 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2803 CONTENTS is its definition, when inline, or nil."
2809 ;;;; Inline Babel Call
2812 "Parse inline babel call at point, if any.
2814 When at an inline babel call, return a list whose car is
2815 `inline-babel-call' and cdr a plist with `:call',
2816 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2817 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2819 Assume point is at the beginning of the babel call."
2835 :inside-header inside-header
2836 :arguments arguments
2837 :end-header end-header
2838 :begin begin
2839 :end end
2840 :value value
2844 "Interpret INLINE-BABEL-CALL object as Org syntax."
2854 ;;;; Inline Src Block
2857 "Parse inline source block at point, if any.
2859 When at an inline source block, return a list whose car is
2860 `inline-src-block' and cdr a plist with `:begin', `:end',
2861 `:language', `:value', `:parameters' and `:post-blank' as
2862 keywords. Otherwise, return nil.
2864 Assume point is at the beginning of the inline src block."
2877 :value value
2878 :parameters parameters
2879 :begin begin
2880 :end end
2884 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2889 language
2891 body)))
2893 ;;;; Italic
2896 "Parse italic object at point, if any.
2898 When at an italic object, return a list whose car is `italic' and
2899 cdr is a plist with `:begin', `:end', `:contents-begin' and
2900 `:contents-end' and `:post-blank' keywords. Otherwise, return
2901 nil.
2903 Assume point is at the first slash marker."
2915 :end end
2916 :contents-begin contents-begin
2917 :contents-end contents-end
2921 "Interpret italic object as Org syntax.
2922 CONTENTS is the contents of the object."
2926 ;;;; Latex Fragment
2929 "Parse LaTeX fragment at point, if any.
2931 When at a LaTeX fragment, return a list whose car is
2932 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2933 and `:post-blank' as keywords. Otherwise, return nil.
2935 Assume point is at the beginning of the LaTeX fragment."
2953 ;; Macro.
2962 :begin begin
2963 :end end
2967 "Interpret LATEX-FRAGMENT object as Org syntax."
2970 ;;;; Line Break
2973 "Parse line break at point, if any.
2975 When at a line break, return a list whose car is `line-break',
2976 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2977 Otherwise, return nil.
2979 Assume point is at the beginning of the line break."
2988 "Interpret LINE-BREAK object as Org syntax."
2992 ;;;; Link
2995 "Parse link at point, if any.
2997 When at a link, return a list whose car is `link' and cdr a plist
2998 with `:type', `:path', `:raw-link', `:application',
2999 `:search-option', `:begin', `:end', `:contents-begin',
3000 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3001 nil.
3003 Assume point is at the beginning of the link."
3006 end contents-begin contents-end link-end post-blank path type
3007 raw-link search-option application)
3009 ;; Type 1: Text targeted from a radio target.
3018 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3023 ;; RAW-LINK is the original link. Expand any
3024 ;; abbreviation in it.
3025 ;;
3026 ;; Also treat any newline character and associated
3027 ;; indentation as a single space character. This is not
3028 ;; compatible with RFC 3986, which requires to ignore
3029 ;; them altogether. However, doing so would require
3030 ;; users to encode spaces on the fly when writing links
3031 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3032 ;; [[shell:ls *.org]], which defeats Org's focus on
3033 ;; simplicity.
3039 ;; Determine TYPE of link and set PATH accordingly. According
3040 ;; to RFC 3986, remove whitespaces from URI in external links.
3041 ;; In internal ones, treat indentation as a single space.
3043 ;; File type.
3048 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3052 ;; Id type: PATH is the id.
3055 ;; Code-ref type: PATH is the name of the reference.
3060 ;; Custom-id type: PATH is the name of the custom id.
3064 ;; Fuzzy type: Internal link either matches a target, an
3065 ;; headline name or nothing. PATH is the target or
3066 ;; headline's name.
3070 ;; Type 3: Plain link, e.g., http://orgmode.org
3076 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3077 ;; bracket links, follow RFC 3986 and remove any extra
3078 ;; whitespace in URI.
3088 ;; In any case, deduce end point after trailing white space from
3089 ;; LINK-END variable.
3093 ;; Special "file" type link processing. Extract opening
3094 ;; application and search option, if any. Also normalize URI.
3103 :path path
3105 :application application
3106 :search-option search-option
3107 :begin begin
3108 :end end
3109 :contents-begin contents-begin
3110 :contents-end contents-end
3114 "Interpret LINK object as Org syntax.
3115 CONTENTS is the contents of the object, or nil."
3120 raw-link
3124 ;;;; Macro
3127 "Parse macro at point, if any.
3129 When at a macro, return a list whose car is `macro' and cdr
3130 a plist with `:key', `:args', `:begin', `:end', `:value' and
3131 `:post-blank' as keywords. Otherwise, return nil.
3133 Assume point is at the macro."
3146 :value value
3147 :args args
3148 :begin begin
3149 :end end
3153 "Interpret MACRO object as Org syntax."
3157 ;;;; Radio-target
3160 "Parse radio target at point, if any.
3162 When at a radio target, return a list whose car is `radio-target'
3163 and cdr a plist with `:begin', `:end', `:contents-begin',
3164 `:contents-end', `:value' and `:post-blank' as keywords.
3165 Otherwise, return nil.
3167 Assume point is at the radio target."
3179 :end end
3180 :contents-begin contents-begin
3181 :contents-end contents-end
3182 :post-blank post-blank
3186 "Interpret target object as Org syntax.
3187 CONTENTS is the contents of the object."
3191 ;;;; Statistics Cookie
3194 "Parse statistics cookie at point, if any.
3196 When at a statistics cookie, return a list whose car is
3197 `statistics-cookie', and cdr a plist with `:begin', `:end',
3198 `:value' and `:post-blank' keywords. Otherwise, return nil.
3200 Assume point is at the beginning of the statistics-cookie."
3211 :end end
3212 :value value
3216 "Interpret STATISTICS-COOKIE object as Org syntax."
3220 ;;;; Strike-Through
3223 "Parse strike-through object at point, if any.
3225 When at a strike-through object, return a list whose car is
3226 `strike-through' and cdr is a plist with `:begin', `:end',
3227 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3228 Otherwise, return nil.
3230 Assume point is at the first plus sign marker."
3242 :end end
3243 :contents-begin contents-begin
3244 :contents-end contents-end
3248 "Interpret strike-through object as Org syntax.
3249 CONTENTS is the contents of the object."
3253 ;;;; Subscript
3256 "Parse subscript at point, if any.
3258 When at a subscript object, return a list whose car is
3259 `subscript' and cdr a plist with `:begin', `:end',
3260 `:contents-begin', `:contents-end', `:use-brackets-p' and
3261 `:post-blank' as keywords. Otherwise, return nil.
3263 Assume point is at the underscore."
3277 :end end
3278 :use-brackets-p bracketsp
3279 :contents-begin contents-begin
3280 :contents-end contents-end
3284 "Interpret SUBSCRIPT object as Org syntax.
3285 CONTENTS is the contents of the object."
3288 contents))
3291 ;;;; Superscript
3294 "Parse superscript at point, if any.
3296 When at a superscript object, return a list whose car is
3297 `superscript' and cdr a plist with `:begin', `:end',
3298 `:contents-begin', `:contents-end', `:use-brackets-p' and
3299 `:post-blank' as keywords. Otherwise, return nil.
3301 Assume point is at the caret."
3315 :end end
3316 :use-brackets-p bracketsp
3317 :contents-begin contents-begin
3318 :contents-end contents-end
3322 "Interpret SUPERSCRIPT object as Org syntax.
3323 CONTENTS is the contents of the object."
3326 contents))
3329 ;;;; Table Cell
3332 "Parse table cell at point.
3333 Return a list whose car is `table-cell' and cdr is a plist
3334 containing `:begin', `:end', `:contents-begin', `:contents-end'
3335 and `:post-blank' keywords."
3343 :end end
3344 :contents-begin contents-begin
3345 :contents-end contents-end
3349 "Interpret table-cell element as Org syntax.
3350 CONTENTS is the contents of the cell, or nil."
3354 ;;;; Target
3357 "Parse target at point, if any.
3359 When at a target, return a list whose car is `target' and cdr
3360 a plist with `:begin', `:end', `:value' and `:post-blank' as
3361 keywords. Otherwise, return nil.
3363 Assume point is at the target."
3373 :end end
3374 :value value
3378 "Interpret TARGET object as Org syntax."
3382 ;;;; Timestamp
3393 "Parse time stamp at point, if any.
3395 When at a time stamp, return a list whose car is `timestamp', and
3396 cdr a plist with `:type', `:raw-value', `:year-start',
3397 `:month-start', `:day-start', `:hour-start', `:minute-start',
3398 `:year-end', `:month-end', `:day-end', `:hour-end',
3399 `:minute-end', `:repeater-type', `:repeater-value',
3400 `:repeater-unit', `:warning-type', `:warning-value',
3401 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3402 Otherwise, return nil.
3404 Assume point is at the beginning of the timestamp."
3423 date-start)
3434 raw-value)
3436 :repeater-type
3442 :repeater-unit
3451 :warning-unit
3454 year-start month-start day-start hour-start minute-start year-end
3455 month-end day-end hour-end minute-end)
3456 ;; Parse date-start.
3464 ;; Compute date-end. It can be provided directly in time-stamp,
3465 ;; or extracted from time range. Otherwise, it defaults to the
3466 ;; same values as date-start.
3476 :raw-value raw-value
3477 :year-start year-start
3478 :month-start month-start
3479 :day-start day-start
3480 :hour-start hour-start
3481 :minute-start minute-start
3482 :year-end year-end
3483 :month-end month-end
3484 :day-end day-end
3485 :hour-end hour-end
3486 :minute-end minute-end
3487 :begin begin
3488 :end end
3490 repeater-props
3491 warning-props))))))
3494 "Interpret TIMESTAMP object as Org syntax."
3513 ;; Build an Org timestamp string from TIME. ACTIVEP is
3514 ;; non-nil when time stamp is active. If WITH-TIME-P is
3515 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3516 ;; specify a time range in the timestamp. REPEAT-STRING is
3517 ;; the repeater string, if any.
3521 org-time-stamp-formats)
3522 time)))
3528 nil nil ts)))
3533 " "
3534 s
3536 ;; Return value.
3537 ts)))
3549 build-ts-string
3568 0
3576 "--"
3589 ;;;; Underline
3592 "Parse underline object at point, if any.
3594 When at an underline object, return a list whose car is
3595 `underline' and cdr is a plist with `:begin', `:end',
3596 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3597 Otherwise, return nil.
3599 Assume point is at the first underscore marker."
3611 :end end
3612 :contents-begin contents-begin
3613 :contents-end contents-end
3617 "Interpret underline object as Org syntax.
3618 CONTENTS is the contents of the object."
3622 ;;;; Verbatim
3625 "Parse verbatim object at point, if any.
3627 When at a verbatim object, return a list whose car is `verbatim'
3628 and cdr is a plist with `:value', `:begin', `:end' and
3629 `:post-blank' keywords. Otherwise, return nil.
3631 Assume point is at the first equal sign marker."
3642 :begin begin
3643 :end end
3647 "Interpret VERBATIM object as Org syntax."
3651 \f
3652 ;;; Parsing Element Starting At Point
3653 ;;
3654 ;; `org-element--current-element' is the core function of this section.
3655 ;; It returns the Lisp representation of the element starting at
3656 ;; point.
3657 ;;
3658 ;; `org-element--current-element' makes use of special modes. They
3659 ;; are activated for fixed element chaining (e.g., `plain-list' >
3660 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3661 ;; `section'). Special modes are: `first-section', `item',
3662 ;; `node-property', `section' and `table-row'.
3665 "Parse the element starting at point.
3667 Return value is a list like (TYPE PROPS) where TYPE is the type
3668 of the element and PROPS a plist of properties associated to the
3669 element.
3671 Possible types are defined in `org-element-all-elements'.
3673 LIMIT bounds the search.
3675 Optional argument GRANULARITY determines the depth of the
3676 recursion. Allowed values are `headline', `greater-element',
3677 `element', `object' or nil. When it is broader than `object' (or
3678 nil), secondary values will not be parsed, since they only
3679 contain objects.
3681 Optional argument MODE, when non-nil, can be either
3682 `first-section', `section', `planning', `item', `node-property'
3683 and `table-row'.
3685 If STRUCTURE isn't provided but MODE is set to `item', it will be
3686 computed.
3688 This function assumes point is always at the beginning of the
3689 element it has to parse."
3692 ;; Determine if parsing depth allows for secondary strings
3693 ;; parsing. It only applies to elements referenced in
3694 ;; `org-element-secondary-value-alist'.
3697 ;; Item.
3700 ;; Table Row.
3702 ;; Node Property.
3704 ;; Headline.
3707 ;; Sections (must be checked after headline).
3712 limit)))
3713 ;; Planning.
3716 ;; Property drawer.
3720 ;; When not at bol, point is at the beginning of an item or
3721 ;; a footnote definition: next item is always a paragraph.
3723 ;; Clock.
3725 ;; Inlinetask.
3728 ;; From there, elements can have affiliated keywords.
3731 ;; Jumping over affiliated keywords put point off-limits.
3732 ;; Parse them as regular keywords.
3736 ;; LaTeX Environment.
3739 ;; Drawer and Property Drawer.
3742 ;; Fixed Width
3745 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3746 ;; Keywords.
3755 org-element-block-name-alist)))
3770 ;; Footnote Definition.
3773 ;; Horizontal Rule.
3776 ;; Diary Sexp.
3779 ;; Table.
3782 ;; List.
3785 limit affiliated
3787 ;; Default element: Paragraph.
3791 ;; Most elements can have affiliated keywords. When looking for an
3792 ;; element beginning, we want to move before them, as they belong to
3793 ;; that element, and, in the meantime, collect information they give
3794 ;; into appropriate properties. Hence the following function.
3797 "Collect affiliated keywords from point down to LIMIT.
3799 Return a list whose CAR is the position at the first of them and
3800 CDR a plist of keywords and values and move point to the
3801 beginning of the first line after them.
3803 As a special case, if element doesn't start at the beginning of
3804 the line (e.g., a paragraph starting an item), CAR is current
3805 position of point and CDR is nil."
3809 ;; RESTRICT is the list of objects allowed in parsed
3810 ;; keywords value.
3812 output)
3815 ;; Apply translation to RAW-KWD. From there, KWD is
3816 ;; the official keyword.
3818 org-element-keyword-translation-alist))
3819 raw-kwd))
3820 ;; Find main value for any keyword.
3826 ;; PARSEDP is non-nil when keyword should have its
3827 ;; value parsed.
3829 ;; If KWD is a dual keyword, find its secondary
3830 ;; value. Maybe parse it.
3838 ;; Attribute a property name to KWD.
3840 ;; Now set final shape for VALUE.
3846 nil restrict)))
3850 ;; Attributes can always appear on multiple lines.
3853 ;; Eventually store the new value in OUTPUT.
3855 ;; Move to next keyword.
3857 ;; If affiliated keywords are orphaned: move back to first one.
3858 ;; They will be parsed as a paragraph.
3860 ;; Return value.
3864 \f
3865 ;;; The Org Parser
3866 ;;
3867 ;; The two major functions here are `org-element-parse-buffer', which
3868 ;; parses Org syntax inside the current buffer, taking into account
3869 ;; region, narrowing, or even visibility if specified, and
3870 ;; `org-element-parse-secondary-string', which parses objects within
3871 ;; a given string.
3872 ;;
3873 ;; The (almost) almighty `org-element-map' allows to apply a function
3874 ;; on elements or objects matching some type, and accumulate the
3875 ;; resulting values. In an export situation, it also skips unneeded
3876 ;; parts of the parse tree.
3879 "Recursively parse the buffer and return structure.
3880 If narrowing is in effect, only parse the visible part of the
3881 buffer.
3883 Optional argument GRANULARITY determines the depth of the
3884 recursion. It can be set to the following symbols:
3886 `headline' Only parse headlines.
3887 `greater-element' Don't recurse into greater elements excepted
3888 headlines and sections. Thus, elements
3889 parsed are the top-level ones.
3890 `element' Parse everything but objects and plain text.
3891 `object' Parse the complete buffer (default).
3893 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3894 elements.
3896 An element or an objects is represented as a list with the
3897 pattern (TYPE PROPERTIES CONTENTS), where :
3899 TYPE is a symbol describing the element or object. See
3900 `org-element-all-elements' and `org-element-all-objects' for an
3901 exhaustive list of such symbols. One can retrieve it with
3902 `org-element-type' function.
3904 PROPERTIES is the list of attributes attached to the element or
3905 object, as a plist. Although most of them are specific to the
3906 element or object type, all types share `:begin', `:end',
3907 `:post-blank' and `:parent' properties, which respectively
3908 refer to buffer position where the element or object starts,
3909 ends, the number of white spaces or blank lines after it, and
3910 the element or object containing it. Properties values can be
3911 obtained by using `org-element-property' function.
3913 CONTENTS is a list of elements, objects or raw strings
3914 contained in the current element or object, when applicable.
3915 One can access them with `org-element-contents' function.
3917 The Org buffer has `org-data' as type and nil as properties.
3918 `org-element-map' function can be used to find specific elements
3919 or objects within the parse tree.
3921 This function assumes that current major mode is `org-mode'."
3927 ;; Start in `first-section' mode so text before the first
3928 ;; headline belongs to a section.
3932 "Recursively parse objects in STRING and return structure.
3934 RESTRICTION is a symbol limiting the object types that will be
3935 looked after.
3937 Optional argument PARENT, when non-nil, is the element or object
3938 containing the secondary string. It is used to set correctly
3939 `:parent' property within the string.
3941 If STRING is the empty string or nil, return nil."
3957 data))))))
3961 "Map a function on selected elements or objects.
3963 DATA is a parse tree, an element, an object, a string, or a list
3964 of such constructs. TYPES is a symbol or list of symbols of
3965 elements or objects types (see `org-element-all-elements' and
3966 `org-element-all-objects' for a complete list of types). FUN is
3967 the function called on the matching element or object. It has to
3968 accept one argument: the element or object itself.
3970 When optional argument INFO is non-nil, it should be a plist
3971 holding export options. In that case, parts of the parse tree
3972 not exportable according to that property list will be skipped.
3974 When optional argument FIRST-MATCH is non-nil, stop at the first
3975 match for which FUN doesn't return nil, and return that value.
3977 Optional argument NO-RECURSION is a symbol or a list of symbols
3978 representing elements or objects types. `org-element-map' won't
3979 enter any recursive element or object whose type belongs to that
3980 list. Though, FUN can still be applied on them.
3982 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3983 apply to matching objects within parsed affiliated keywords (see
3984 `org-element-parsed-keywords').
3986 Nil values returned from FUN do not appear in the results.
3989 Examples:
3990 ---------
3992 Assuming TREE is a variable containing an Org buffer parse tree,
3993 the following example will return a flat list of all `src-block'
3994 and `example-block' elements in it:
3996 \(org-element-map tree '(example-block src-block) #'identity)
3998 The following snippet will find the first headline with a level
4001 \(org-element-map tree 'headline
4002 \(lambda (hl)
4003 \(and (= (org-element-property :level hl) 1)
4005 \(org-element-property :begin hl)))
4006 nil t)
4008 The next example will return a flat list of all `plain-list' type
4009 elements in TREE that are not a sub-list themselves:
4011 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4013 Eventually, this example will return a flat list of all `bold'
4014 type objects containing a `latex-snippet' type object, even
4015 looking into captions:
4017 \(org-element-map tree 'bold
4018 \(lambda (b)
4019 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4020 nil nil nil t)"
4021 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4025 ;; Recursion depth is determined by --CATEGORY.
4032 ;; If one object is found, the function has
4033 ;; to recurse into every object.
4036 ;; If one regular element is found, the
4037 ;; function has to recurse, at least, into
4038 ;; every element it encounters.
4041 --acc)
4044 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4045 ;; holding contextual information.
4049 ;; Ignored element in an export context.
4051 ;; List of elements or objects.
4053 ;; Unconditionally enter parse trees.
4057 ;; Check if TYPE is matching among TYPES. If so,
4058 ;; apply FUN to --DATA and accumulate return value
4059 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4065 ;; If --DATA has a secondary string that can contain
4066 ;; objects with their type among TYPES, look inside.
4069 org-element-secondary-value-alist)))
4071 ;; If --DATA has any parsed affiliated keywords and
4072 ;; WITH-AFFILIATED is non-nil, look for objects in
4073 ;; them.
4080 ;; Pay attention to the type of parsed
4081 ;; keyword. In particular, preserve order for
4082 ;; multiple keywords.
4095 ;; Determine if a recursion into --DATA is possible.
4097 ;; --TYPE is explicitly removed from recursion.
4099 ;; --DATA has no contents.
4101 ;; Looking for greater elements but --DATA is
4102 ;; simply an element or an object.
4105 ;; Looking for elements but --DATA is an object.
4108 ;; In any other case, map contents.
4112 ;; Return value in a proper order.
4116 ;; The following functions are internal parts of the parser.
4117 ;;
4118 ;; The first one, `org-element--parse-elements' acts at the element's
4119 ;; level.
4120 ;;
4121 ;; The second one, `org-element--parse-objects' applies on all objects
4122 ;; of a paragraph or a secondary string. It calls
4123 ;; `org-element--object-lex' to find the next object in the current
4124 ;; container.
4127 "Return next special mode according to TYPE, or nil.
4128 TYPE is a symbol representing the type of an element or object
4129 containing next element if PARENTP is non-nil, or before it
4130 otherwise. Modes can be either `first-section', `item',
4131 `node-property', `planning', `property-drawer', `section',
4132 `table-row' or nil."
4148 "Parse elements between BEG and END positions.
4150 MODE prioritizes some elements over the others. It can be set to
4151 `first-section', `section', `planning', `item', `node-property'
4152 or `table-row'.
4154 When value is `item', STRUCTURE will be used as the current list
4155 structure.
4157 GRANULARITY determines the depth of the recursion. See
4158 `org-element-parse-buffer' for more information.
4160 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4161 elements.
4163 Elements are accumulated into ACC."
4166 ;; Visible only: skip invisible parts at the beginning of the
4167 ;; element.
4170 ;; When parsing only headlines, skip any text before first one.
4173 ;; Main loop start.
4175 ;; Find current element's type and parse it accordingly to
4176 ;; its category.
4178 end granularity mode structure))
4182 ;; Visible only: skip invisible parts between siblings.
4185 ;; Fill ELEMENT contents by side-effect.
4187 ;; If element has no contents, don't modify it.
4189 ;; Greater element: parse it between `contents-begin' and
4190 ;; `contents-end'. Make sure GRANULARITY allows the
4191 ;; recursion, or ELEMENT is a headline, in which case going
4192 ;; inside is mandatory, in order to get sub-level headings.
4200 ;; Possibly switch to a special mode.
4204 granularity visible-only element))
4205 ;; ELEMENT has contents. Parse objects inside, if
4206 ;; GRANULARITY allows it.
4212 ;; Update mode.
4214 ;; Return result.
4215 acc))
4218 "Return next object in current buffer or nil.
4219 RESTRICTION is a list of object types, as symbols, that should be
4220 looked after. This function assumes that the buffer is narrowed
4221 to an appropriate container (e.g., a paragraph)."
4229 found)
4294 ;; This is probably a plain link.
4300 ;; Radio link.
4305 "Parse objects between BEG and END and return recursive structure.
4307 Objects are accumulated in ACC.
4309 RESTRICTION is a list of object successors which are allowed in
4310 the current object."
4318 ;; 1. Text before any object. Untabify it.
4323 acc
4327 ;; 2. Object...
4330 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4331 ;; a recursive type.
4339 ;; 3. Text after last object. Untabify it.
4343 acc
4347 ;; Result.
4348 acc)))
4351 \f
4352 ;;; Towards A Bijective Process
4353 ;;
4354 ;; The parse tree obtained with `org-element-parse-buffer' is really
4355 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4356 ;; interpreted and expanded into a string with canonical Org syntax.
4357 ;; Hence `org-element-interpret-data'.
4358 ;;
4359 ;; The function relies internally on
4360 ;; `org-element--interpret-affiliated-keywords'.
4362 ;;;###autoload
4364 "Interpret DATA as Org syntax.
4365 DATA is a parse tree, an element, an object or a secondary string
4366 to interpret. Return Org syntax as a string."
4370 ;; Find interpreter for current object or
4371 ;; element. If it doesn't exist (e.g. this is
4372 ;; a pseudo object or element), return contents,
4373 ;; if any.
4380 ;; Secondary string.
4384 ;; Full Org document.
4388 ;; Plain text: return it.
4390 ;; Element or object without contents.
4393 ;; Element or object with contents.
4396 interpret
4397 --data
4398 ;; Recursively interpret contents.
4403 --data
4404 ;; Fix indentation of elements containing
4405 ;; objects. We ignore `table-row'
4406 ;; elements as they are one line long
4407 ;; anyway.
4409 --data
4410 ;; When normalizing first paragraph of
4411 ;; an item or a footnote-definition,
4412 ;; ignore first line's indentation.
4420 ;; Build white spaces. If no `:post-blank' property
4421 ;; is specified, assume its value is 0.
4436 "Return ELEMENT's affiliated keywords as Org syntax.
4437 If there is no affiliated keyword, return the empty string."
4447 ": "
4450 value)
4458 ;; All attribute keywords can have multiple lines.
4464 ;; List all ELEMENT's properties matching an attribute line or an
4465 ;; affiliated keyword, but ignore translated keywords since they
4466 ;; cannot belong to the property list.
4473 org-element-keyword-translation-alist)))))
4474 collect prop)
4477 ;; Because interpretation of the parse tree must return the same
4478 ;; number of blank lines between elements and the same number of white
4479 ;; space after objects, some special care must be given to white
4480 ;; spaces.
4481 ;;
4482 ;; The first function, `org-element-normalize-string', ensures any
4483 ;; string different from the empty string will end with a single
4484 ;; newline character.
4485 ;;
4486 ;; The second function, `org-element-normalize-contents', removes
4487 ;; global indentation from the contents of the current element.
4490 "Ensure string S ends with a single newline character.
4492 If S isn't a string return it unchanged. If S is the empty
4493 string, return it. Otherwise, return a new string with a single
4494 newline character at its end."
4502 "Normalize plain text in ELEMENT's contents.
4504 ELEMENT must only contain plain text and objects.
4506 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4507 indentation to compute maximal common indentation.
4509 Return the normalized element that is element with global
4510 indentation removed from its contents. The function assumes that
4511 indentation is not done with TAB characters."
4513 ;; Return minimal common indentation within BLOB. This is
4514 ;; done by walking recursively BLOB and updating MIN-IND
4515 ;; along the way. FIRST-FLAG is non-nil when the next
4516 ;; object is expected to be a string that doesn't start
4517 ;; with a newline character. It happens for strings at
4518 ;; the beginnings of the contents or right after a line
4519 ;; break.
4525 ;; Objects cannot start with spaces: in this case,
4526 ;; indentation is 0.
4530 ;; An indentation of zero means no string will
4531 ;; be modified. Quit the process.
4543 org-element-recursive-objects)
4546 object first-flag min-ind))))))))
4550 ;; Build ELEMENT back, replacing each string with the same
4551 ;; string minus common indentation.
4554 ;; Return DATUM with all its strings indentation
4555 ;; shortened from MIN-IND white spaces.
4556 ;; FIRST-FLAG is non-nil when the next object is
4557 ;; expected to be a string that doesn't start with
4558 ;; a newline character.
4574 org-element-recursive-objects)
4578 object)
4581 datum)))
4585 \f
4586 ;;; Cache
4587 ;;
4588 ;; Implement a caching mechanism for `org-element-at-point' and
4589 ;; `org-element-context', which see.
4590 ;;
4591 ;; A single public function is provided: `org-element-cache-reset'.
4592 ;;
4593 ;; Cache is enabled by default, but can be disabled globally with
4594 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4595 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4596 ;; can be tweaked to control caching behaviour.
4597 ;;
4598 ;; Internally, parsed elements are stored in an AVL tree,
4599 ;; `org-element--cache'. This tree is updated lazily: whenever
4600 ;; a change happens to the buffer, a synchronization request is
4601 ;; registered in `org-element--cache-sync-requests' (see
4602 ;; `org-element--cache-submit-request'). During idle time, requests
4603 ;; are processed by `org-element--cache-sync'. Synchronization also
4604 ;; happens when an element is required from the cache. In this case,
4605 ;; the process stops as soon as the needed element is up-to-date.
4606 ;;
4607 ;; A synchronization request can only apply on a synchronized part of
4608 ;; the cache. Therefore, the cache is updated at least to the
4609 ;; location where the new request applies. Thus, requests are ordered
4610 ;; from left to right and all elements starting before the first
4611 ;; request are correct. This property is used by functions like
4612 ;; `org-element--cache-find' to retrieve elements in the part of the
4613 ;; cache that can be trusted.
4614 ;;
4615 ;; A request applies to every element, starting from its original
4616 ;; location (or key, see below). When a request is processed, it
4617 ;; moves forward and may collide the next one. In this case, both
4618 ;; requests are merged into a new one that starts from that element.
4619 ;; As a consequence, the whole synchronization complexity does not
4620 ;; depend on the number of pending requests, but on the number of
4621 ;; elements the very first request will be applied on.
4622 ;;
4623 ;; Elements cannot be accessed through their beginning position, which
4624 ;; may or may not be up-to-date. Instead, each element in the tree is
4625 ;; associated to a key, obtained with `org-element--cache-key'. This
4626 ;; mechanism is robust enough to preserve total order among elements
4627 ;; even when the tree is only partially synchronized.
4628 ;;
4629 ;; Objects contained in an element are stored in a hash table,
4630 ;; `org-element--cache-objects'.
4634 "Non nil when Org parser should cache its results.
4641 "Maximum duration, as a time value, for a cache synchronization.
4642 If the synchronization is not over after this delay, the process
4643 pauses and resumes after `org-element-cache-sync-break'
4647 "Duration, as a time value, of the pause between synchronizations.
4651 ;;;; Data Structure
4654 "AVL tree used to cache elements.
4655 Each node of the tree contains an element. Comparison is done
4656 with `org-element--cache-compare'. This cache is used in
4660 "Hash table used as to cache objects.
4661 Key is an element, as returned by `org-element-at-point', and
4662 value is an alist where each association is:
4664 \(PARENT COMPLETEP . OBJECTS)
4666 where PARENT is an element or object, COMPLETEP is a boolean,
4667 non-nil when all direct children of parent are already cached and
4668 OBJECTS is a list of such children, as objects, from farthest to
4669 closest.
4672 contained within a paragraph
4676 If the paragraph is completely parsed, OBJECTS-DATA will be
4678 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4679 \(BOLD-OBJECT t ENTITY-OBJECT))
4681 whereas in a partially parsed paragraph, it could be
4683 \((PARAGRAPH nil ENTITY-OBJECT))
4688 "List of pending synchronization requests.
4690 A request is a vector with the following pattern:
4692 \[NEXT BEG END OFFSET PARENT PHASE]
4694 Processing a synchronization request consists of three phases:
4696 0. Delete modified elements,
4697 1. Fill missing area in cache,
4698 2. Shift positions and re-parent elements after the changes.
4700 During phase 0, NEXT is the key of the first element to be
4701 removed, BEG and END is buffer position delimiting the
4702 modifications. Elements starting between them (inclusive) are
4703 removed. So are elements whose parent is removed. PARENT, when
4704 non-nil, is the parent of the first element to be removed.
4706 During phase 1, NEXT is the key of the next known element in
4707 cache and BEG its beginning position. Parse buffer between that
4708 element and the one before it in order to determine the parent of
4709 the next element. Set PARENT to the element containing NEXT.
4711 During phase 2, NEXT is the key of the next element to shift in
4712 the parse tree. All elements starting from this one have their
4713 properties relatives to buffer positions shifted by integer
4714 OFFSET and, if they belong to element PARENT, are adopted by it.
4722 "Hash table used to store keys during synchronization.
4726 "Return a unique key for ELEMENT in cache tree.
4728 Keys are used to keep a total order among elements in the cache.
4729 Comparison is done with `org-element--cache-key-less-p'.
4731 When no synchronization is taking place, a key is simply the
4732 beginning position of the element, or that position plus one in
4733 the case of an first item (respectively row) in
4734 a list (respectively a table).
4736 During a synchronization, the key is the one the element had when
4737 the cache was synchronized for the last time. Elements added to
4738 cache during the synchronization get a new key generated with
4739 `org-element--cache-generate-key'.
4741 Such keys are stored in `org-element--cache-sync-keys'. The hash
4742 table is cleared once the synchronization is complete."
4745 ;; Increase beginning position of items (respectively
4746 ;; table rows) by one, so the first item can get
4747 ;; a different key from its parent list (respectively
4748 ;; table).
4751 begin)))
4754 key))))
4757 "Generate a key between LOWER and UPPER.
4759 LOWER and UPPER are integers or lists, possibly empty.
4761 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4762 a unique key, as an integer or a list of integers, according to
4763 the following rules:
4765 - LOWER and UPPER are compared level-wise until values differ.
4767 - If, at a given level, LOWER and UPPER differ from more than
4768 2, the new key shares all the levels above with LOWER and
4769 gets a new level. Its value is the mean between LOWER and
4770 UPPER:
4772 \(1 2) + (1 4) --> (1 3)
4774 - If LOWER has no value to compare with, it is assumed that its
4775 value is `most-negative-fixnum'. E.g.,
4777 \(1 1) + (1 1 2)
4779 is equivalent to
4781 \(1 1 m) + (1 1 2)
4783 where m is `most-negative-fixnum'. Likewise, if UPPER is
4784 short of levels, the current value is `most-positive-fixnum'.
4786 - If they differ from only one, the new key inherits from
4787 current LOWER level and fork it at the next level. E.g.,
4789 \(2 1) + (3 3)
4791 is equivalent to
4793 \(2 1) + (2 M)
4795 where M is `most-positive-fixnum'.
4797 - If the key is only one level long, it is returned as an
4798 integer:
4800 \(1 2) + (3 2) --> 2
4802 When they are not equals, the function assumes that LOWER is
4803 lesser than UPPER, per `org-element--cache-key-less-p'."
4807 skip-upper key)
4818 ;; When at a given level, LOWER and UPPER differ from
4819 ;; 1, ignore UPPER altogether. Instead create a key
4820 ;; between LOWER and the greatest key with the same
4821 ;; prefix as LOWER so far.
4827 "Non-nil if key A is less than key B.
4828 A and B are either integers or lists of integers, as returned by
4829 `org-element--cache-key'."
4837 ;; If A is empty, either keys are equal (B is also empty) and
4838 ;; we return nil, or A is lesser than B (B is longer) and we
4839 ;; return a non-nil value.
4840 ;;
4841 ;; If A is not empty, B is necessarily empty and A is greater
4842 ;; than B (A is longer). Therefore, return nil.
4846 "Non-nil when element A is located before element B."
4851 "Return root value in cache.
4852 This function assumes `org-element--cache' is a valid AVL tree."
4856 ;;;; Tools
4859 "Non-nil when cache is active in current buffer."
4864 "Find element in cache starting at POS or before.
4866 POS refers to a buffer position.
4868 When optional argument SIDE is non-nil, the function checks for
4869 elements starting at or past POS instead. If SIDE is `both', the
4870 function returns a cons cell where car is the first element
4871 starting at or before POS and cdr the first element starting
4872 after POS.
4874 The function can only find elements in the synchronized part of
4875 the cache."
4879 lower upper)
4894 ;; We found an element in cache starting at POS. If `side'
4895 ;; is `both' we also want the next one in order to generate
4896 ;; a key in-between.
4897 ;;
4898 ;; If the element is the first row or item in a table or
4899 ;; a plain list, we always return the table or the plain
4900 ;; list.
4901 ;;
4902 ;; In any other case, we return the element found.
4911 lower parent
4912 upper parent)))))
4915 lower element
4916 upper element)))))
4923 "Store ELEMENT in current buffer's cache, if allowed.
4924 When optional argument DATA is non-nil, assume is it object data
4925 relative to ELEMENT and store it in the objects cache."
4929 ;; During synchronization, first build an appropriate key
4930 ;; for the new element so `avl-tree-enter' can insert it at
4931 ;; the right spot in the cache.
4940 org-element--cache-sync-keys)))
4942 ;; Headlines are not stored in cache, so objects in titles are
4943 ;; not stored either.
4948 "Remove ELEMENT from cache.
4949 Assume ELEMENT belongs to cache and that a cache is active."
4954 ;;;; Synchronization
4957 "Set idle timer for cache synchronization in BUFFER."
4964 org-element-cache-sync-idle-time))
4965 nil
4966 #'org-element--cache-sync
4967 buffer)))
4970 "Non-nil when synchronization process should be interrupted.
4971 TIME-LIMIT is a time value or nil."
4977 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4979 Properties containing buffer positions are `:begin', `:end',
4980 `:contents-begin', `:contents-end' and `:structure'. When
4981 optional argument PROPS is a list of keywords, only shift
4982 properties provided in that list.
4984 Properties are modified by side-effect."
4986 ;; Shift `:structure' property for the first plain list only: it
4987 ;; is the only one that really matters and it prevents from
4988 ;; shifting it more than once.
5002 "Synchronize cache with recent modification in BUFFER.
5004 When optional argument THRESHOLD is non-nil, do the
5005 synchronization for all elements starting before or at threshold,
5006 then exit. Otherwise, synchronize cache for as long as
5007 `org-element-cache-sync-duration' or until Emacs leaves idle
5008 state.
5010 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5011 not registered yet in the cache are going to happen. It is used
5012 in `org-element--cache-submit-request', where cache is partially
5013 updated before current modification are actually submitted."
5024 request
5026 threshold
5029 org-element-cache-sync-duration))
5030 future-change)
5031 ;; Request processed. Merge current and next offsets and
5032 ;; transfer ending position.
5038 ;; If more requests are awaiting, set idle timer accordingly.
5039 ;; Otherwise, reset keys.
5046 "Process synchronization REQUEST for all entries before NEXT.
5048 REQUEST is a vector, built by `org-element--cache-submit-request'.
5050 NEXT is a cache key, as returned by `org-element--cache-key'.
5052 When non-nil, THRESHOLD is a buffer position. Synchronization
5053 stops as soon as a shifted element begins after it.
5055 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5056 after this time or when Emacs exits idle state.
5058 When non-nil, FUTURE-CHANGE is a buffer position where changes
5059 not registered yet in the cache are going to happen. See
5060 `org-element--cache-submit-request' for more information.
5062 Throw `interrupt' if the process stops before completing the
5063 request."
5066 ;; Phase 0.
5067 ;;
5068 ;; Delete all elements starting after BEG, but not after buffer
5069 ;; position END or past element with key NEXT. Also delete
5070 ;; elements contained within a previously removed element
5071 ;; (stored in `last-container').
5072 ;;
5073 ;; At each iteration, we start again at tree root since
5074 ;; a deletion modifies structure of the balanced tree.
5079 ;; Find first element in cache with key BEG or after it.
5083 data data-key last-container)
5092 data-key key
5095 data-key key
5096 node nil)))))
5106 up)))
5109 end))
5116 ;; No element starting after modifications left in
5117 ;; cache: further processing is futile.
5120 ;; Phase 1.
5121 ;;
5122 ;; Phase 0 left a hole in the cache. Some elements after it
5123 ;; could have parents within. For example, in the following
5124 ;; buffer:
5125 ;;
5126 ;; - item
5127 ;;
5128 ;;
5129 ;; Paragraph1
5130 ;;
5131 ;; Paragraph2
5132 ;;
5133 ;; if we remove a blank line between "item" and "Paragraph1",
5134 ;; everything down to "Paragraph2" is removed from cache. But
5135 ;; the paragraph now belongs to the list, and its `:parent'
5136 ;; property no longer is accurate.
5137 ;;
5138 ;; Therefore we need to parse again elements in the hole, or at
5139 ;; least in its last section, so that we can re-parent
5140 ;; subsequent elements, during phase 2.
5141 ;;
5142 ;; Note that we only need to get the parent from the first
5143 ;; element in cache after the hole.
5144 ;;
5145 ;; When next key is lesser or equal to the current one, delegate
5146 ;; phase 1 processing to next request in order to preserve key
5147 ;; order among requests.
5155 ;; Next element will start at its beginning position plus
5156 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5157 ;; contains the real beginning position of the first element to
5158 ;; shift and re-parent.
5162 ;; Changes are going to happen around this element and
5163 ;; they will trigger another phase 1 request. Skip the
5164 ;; current one.
5170 ;; Phase 2.
5171 ;;
5172 ;; Shift all elements starting from key START, but before NEXT, by
5173 ;; OFFSET, and re-parent them when appropriate.
5174 ;;
5175 ;; Elements are modified by side-effect so the tree structure
5176 ;; remains intact.
5177 ;;
5178 ;; Once THRESHOLD, if any, is reached, or once there is an input
5179 ;; pending, exit. Before leaving, the current synchronization
5180 ;; request is updated.
5187 exit-flag)
5188 ;; No re-parenting nor shifting planned: request is over.
5198 ;; We reached NEXT. Request is complete.
5200 ;; Handle interruption request. Update current request.
5205 ;; Shift element.
5208 ;; Shift associated objects data, if any.
5213 ;; Update PARENT and re-parent DATA, only when
5214 ;; necessary. Propagate new structures for lists.
5228 ;; Cache is up-to-date past THRESHOLD. Request
5229 ;; interruption.
5234 ;; We reached end of tree: synchronization complete.
5235 t)))
5238 "Parse elements in current section, down to POS.
5240 Start parsing from the closest between the last known element in
5241 cache or headline above. Return the smallest element containing
5242 POS.
5244 When optional argument SYNCP is non-nil, return the parent of the
5245 element containing POS instead. In that case, it is also
5246 possible to provide TIME-LIMIT, which is a time value specifying
5247 when the parsing should stop. The function throws `interrupt' if
5248 the process stopped before finding the expected result."
5255 element next mode)
5257 ;; Nothing in cache before point: start parsing from first
5258 ;; element following headline above, or first element in
5259 ;; buffer.
5266 ;; Cache returned exact match: return it.
5269 ;; There's a headline between cached value and POS: cached
5270 ;; value is invalid. Start parsing from first element
5271 ;; following the headline.
5278 ;; Check if CACHED or any of its ancestors contain point.
5279 ;;
5280 ;; If there is such an element, we inspect it in order to know
5281 ;; if we return it or if we need to parse its contents.
5282 ;; Otherwise, we just start parsing from current location,
5283 ;; which is right after the top-most element containing
5284 ;; CACHED.
5285 ;;
5286 ;; As a special case, if POS is at the end of the buffer, we
5287 ;; want to return the innermost element ending there.
5288 ;;
5289 ;; Also, if we find an ancestor and discover that we need to
5290 ;; parse its contents, make sure we don't start from
5291 ;; `:contents-begin', as we would otherwise go past CACHED
5292 ;; again. Instead, in that situation, we will resume parsing
5293 ;; from NEXT, which is located after CACHED or its higher
5294 ;; ancestor not containing point.
5306 ;; Parse successively each element until we reach POS.
5319 end 'element mode
5326 ;; Skip any element ending before point. Also skip
5327 ;; element ending at point (unless it is also the end of
5328 ;; buffer) since we're sure that another element begins
5329 ;; after it.
5333 ;; A non-greater element contains point: return it.
5336 ;; Otherwise, we have to decide if ELEMENT really
5337 ;; contains POS. In that case we start parsing from
5338 ;; contents' beginning.
5339 ;;
5340 ;; If POS is at contents' beginning but it is also at
5341 ;; the beginning of the first item in a list or a table.
5342 ;; In that case, we need to create an anchor for that
5343 ;; list or table, so return it.
5344 ;;
5345 ;; Also, if POS is at the end of the buffer, no element
5346 ;; can start after it, but more than one may end there.
5347 ;; Arbitrarily, we choose to return the innermost of
5348 ;; such elements.
5361 parent element
5362 end cend))))
5363 ;; Otherwise, return ELEMENT as it is the smallest
5364 ;; element containing POS.
5369 ;;;; Staging Buffer Changes
5380 "Regexp matching a sensitive line, structure wise.
5381 A sensitive line is a headline, inlinetask, block, drawer, or
5382 latex-environment boundary. When such a line is modified,
5383 structure changes in the document may propagate in the whole
5387 "Non-nil when a sensitive line is about to be changed.
5391 "Request extension of area going to be modified if needed.
5392 BEG and END are the beginning and end of the range of changed
5393 text. See `before-change-functions' for more information."
5403 'headline
5406 org-element--cache-sensitive-re bottom t)))))))))
5409 "Update buffer modifications for current buffer.
5410 BEG and END are the beginning and end of the range of changed
5411 text, and the length in bytes of the pre-change text replaced by
5412 that range. See `after-change-functions' for more information."
5420 ;; Determine if modified area needs to be extended, according
5421 ;; to both previous and current state. We make a special
5422 ;; case for headline editing: if a headline is modified but
5423 ;; not removed, do not extend.
5432 org-element--cache-sensitive-re bottom t))))
5433 ;; Effectively extend modified area.
5441 ;; Store synchronization request.
5444 ;; Activate a timer to process the request during idle time.
5448 "Return first element to remove from cache.
5450 BEG and END are buffer positions delimiting buffer modifications.
5451 OFFSET is the size of the changes.
5453 Returned element is usually the first element in cache containing
5454 any position between BEG and END. As an exception, greater
5455 elements around the changes that are robust to contents
5456 modifications are preserved and updated according to the
5457 changes."
5467 special-block))
5468 ;; Drawers named "PROPERTIES" are probably
5469 ;; a properties drawer being edited. Force
5470 ;; parsing to check if editing is over.
5479 ;; UP is a robust greater element containing changes.
5480 ;; We only need to extend its ending boundaries.
5486 ;; We're at top level element containing ELEMENT: if it's
5487 ;; altered by buffer modifications, it is first element in
5488 ;; cache to be removed. Otherwise, that first element is the
5489 ;; following one.
5490 ;;
5491 ;; As a special case, do not remove BEFORE if it is a robust
5492 ;; container for current changes.
5494 before)))))
5497 "Submit a new cache synchronization request for current buffer.
5498 BEG and END are buffer positions delimiting the minimal area
5499 where cache data should be removed. OFFSET is the size of the
5500 change, as an integer."
5502 delete-to delete-from)
5507 ;; Current changes can be merged with first sync request: we
5508 ;; can save a partial cache synchronization.
5511 ;; If last change happened within area to be removed, extend
5512 ;; boundaries of robust parents, if any. Otherwise, find
5513 ;; first element to remove and update request accordingly.
5525 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5526 ;; if any, is no longer a 0-phase request, thus ensuring that
5527 ;; phases are properly ordered. We need to provide OFFSET as
5528 ;; optional parameter since current modifications are not known
5529 ;; yet to the otherwise correct part of the cache (i.e, before
5530 ;; the first request).
5537 ;; When changes happen before the first known
5538 ;; element, re-parent and shift the rest of the
5539 ;; cache.
5541 ;; Otherwise, we find the first non robust
5542 ;; element containing END. All elements between
5543 ;; FIRST and this one are to be removed.
5554 element up))
5556 org-element--cache-sync-requests)
5557 ;; No element to remove. No need to re-parent either.
5558 ;; Simply shift additional elements, if any, by OFFSET.
5563 ;;;; Public Functions
5565 ;;;###autoload
5567 "Reset cache in current buffer.
5568 When optional argument ALL is non-nil, reset cache in all Org
5569 buffers."
5587 ;;;###autoload
5589 "Refresh cache at position POS."
5596 \f
5597 ;;; The Toolbox
5598 ;;
5599 ;; The first move is to implement a way to obtain the smallest element
5600 ;; containing point. This is the job of `org-element-at-point'. It
5601 ;; basically jumps back to the beginning of section containing point
5602 ;; and proceed, one element after the other, with
5603 ;; `org-element--current-element' until the container is found. Note:
5604 ;; When using `org-element-at-point', secondary values are never
5605 ;; parsed since the function focuses on elements, not on objects.
5606 ;;
5607 ;; At a deeper level, `org-element-context' lists all elements and
5608 ;; objects containing point.
5609 ;;
5610 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5611 ;; internally by navigation and manipulation tools.
5614 ;;;###autoload
5616 "Determine closest element around point.
5618 Return value is a list like (TYPE PROPS) where TYPE is the type
5619 of the element and PROPS a plist of properties associated to the
5620 element.
5622 Possible types are defined in `org-element-all-elements'.
5623 Properties depend on element or object type, but always include
5624 `:begin', `:end', `:parent' and `:post-blank' properties.
5626 As a special case, if point is at the very beginning of the first
5627 item in a list or sub-list, returned element will be that list
5628 instead of the item. Likewise, if point is at the beginning of
5629 the first row of a table, returned element will be the table
5630 instead of the first row.
5632 When point is at the end of the buffer, return the innermost
5633 element ending there."
5639 ;; Within blank lines at the beginning of buffer, return nil.
5641 ;; Within blank lines right after a headline, return that
5642 ;; headline.
5646 ;; Otherwise parse until we find element containing ORIGIN.
5653 ;;;###autoload
5655 "Return smallest element or object around point.
5657 Return value is a list like (TYPE PROPS) where TYPE is the type
5658 of the element or object and PROPS a plist of properties
5659 associated to it.
5661 Possible types are defined in `org-element-all-elements' and
5662 `org-element-all-objects'. Properties depend on element or
5663 object type, but always include `:begin', `:end', `:parent' and
5664 `:post-blank'.
5666 As a special case, if point is right after an object and not at
5667 the beginning of any other object, return that object.
5669 Optional argument ELEMENT, when non-nil, is the closest element
5670 containing point, as returned by `org-element-at-point'.
5671 Providing it allows for quicker computation."
5677 ;; If point is inside an element containing objects or
5678 ;; a secondary string, narrow buffer to the container and
5679 ;; proceed with parsing. Otherwise, return ELEMENT.
5681 ;; At a parsed affiliated keyword, check if we're inside main
5682 ;; or dual value.
5689 org-element-parsed-keywords))
5698 ;; Also change type to retrieve correct restrictions.
5700 ;; At an item, objects can only be located within tag, if any.
5710 ;; At an headline or inlinetask, objects are in title.
5717 ;; At a paragraph, a table-row or a verse block, objects are
5718 ;; located within their contents.
5722 ;; CBEG is nil for table rules.
5727 ;; At a planning line, if point is at a timestamp, return it,
5728 ;; otherwise, return element.
5736 ;; All other locations cannot contain objects: bail out.
5746 next object-data last)
5750 ;; When entering PARENT for the first time, get list
5751 ;; of objects within known so far. Store it in
5752 ;; OBJECT-DATA.
5757 ;; Find NEXT object for analysis.
5759 ;; If NEXT is non-nil, we already exhausted the
5760 ;; cache so we can parse buffer to find the object
5761 ;; after it.
5763 ;; Otherwise, check if cache can help us.
5774 ;; Cache contains the information needed.
5777 pos)
5779 pos)
5785 ;; If we have a new object to analyze, store it in
5786 ;; cache. Otherwise record that there is nothing
5787 ;; more to parse in this element at this depth.
5792 ;; Process NEXT, if any, in order to know if we need
5793 ;; to skip it, return it or move into it.
5800 ;; Skip objects ending before point. Also skip
5801 ;; objects ending at point unless it is also the
5802 ;; end of buffer, since we want to return the
5803 ;; innermost object.
5806 ;; For convenience, when object ends at POS,
5807 ;; without any space, store it in LAST, as we
5808 ;; will return it if no object starts here.
5812 ;; If POS is within a container object, move
5813 ;; into that object.
5817 ;; At contents' end, if there is no
5818 ;; space before point, also move into
5819 ;; object, for consistency with
5820 ;; convenience feature above.
5829 next nil
5830 object-data nil))
5831 ;; Otherwise, return NEXT.
5833 ;; Store results in cache, if applicable.
5837 "List all ancestors of a given element or object.
5839 BLOB is an object or element.
5841 When optional argument TYPES is a list of symbols, return the
5842 first element or object in the lineage whose type belongs to that
5843 list.
5845 When optional argument WITH-SELF is non-nil, lineage includes
5846 BLOB itself as the first element, and TYPES, if provided, also
5847 apply to it.
5849 When BLOB is obtained through `org-element-context' or
5850 `org-element-at-point', only ancestors from its section can be
5851 found. There is no such limitation when BLOB belongs to a full
5852 parse tree."
5854 ancestors)
5861 "Non-nil when elements ELEM-A and ELEM-B are nested."
5870 "Swap elements ELEM-A and ELEM-B.
5871 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5872 end of ELEM-A."
5874 ;; There are two special cases when an element doesn't start at bol:
5875 ;; the first paragraph in an item or in a footnote definition.
5877 ;; Only a paragraph without any affiliated keyword can be moved at
5878 ;; ELEM-A position in such a situation. Note that the case of
5879 ;; a footnote definition is impossible: it cannot contain two
5880 ;; paragraphs in a row because it cannot contain a blank line.
5886 ;; In a special situation, ELEM-A will have no indentation. We'll
5887 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5901 ;; Store inner overlays responsible for visibility status.
5902 ;; We also need to store their boundaries as they will be
5903 ;; removed from buffer.
5918 ;; Get contents.
5926 ;; Restore ex ELEM-A overlays.
5933 ;; Restore ex ELEM-B overlays.
5939 "Remove maximum common indentation in string S and return it.
5940 When optional argument N is a positive integer, remove exactly
5941 that much characters from indentation, if possible, or return
5942 S as-is otherwise. Unlike to `org-remove-indentation', this
5943 function doesn't call `untabify' on S."
5948 ;; Find maximum common indentation, if not specified.
5956 min-ind)))
5958 ;; Remove exactly N indentation, but give up if not possible.
5971 ;; Local variables:
5972 ;; generated-autoload-file: "org-loaddefs.el"
5973 ;; End:
5975 ;;; org-element.el ends here