| blob | 1d8f23ea6d56963d94755046fcb084c0b0575bd3 |
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:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
203 ;; Objects starting with "@": export snippets.
204 "@@"
205 ;; Objects starting with "{": macro.
206 "{{{"
207 ;; Objects starting with "<" : timestamp
208 ;; (active, diary), target, radio target and
209 ;; angular links.
211 ;; Objects starting with "$": latex fragment.
213 ;; Objects starting with "\": line break,
214 ;; entity, latex fragment.
216 ;; Objects starting with raw text: inline Babel
217 ;; source block, inline Babel call.
223 ;;;###autoload
225 "Update parser internals."
232 dynamic-block example-block export-block fixed-width
233 footnote-definition headline horizontal-rule inlinetask item
234 keyword latex-environment node-property paragraph plain-list
235 planning property-drawer quote-block section
236 special-block src-block table table-row verse-block)
241 item plain-list property-drawer quote-block section
242 special-block table)
247 inline-src-block italic line-break latex-fragment link macro
248 radio-target statistics-cookie strike-through subscript superscript
249 table-cell target timestamp underline verbatim)
254 superscript table-cell underline)
268 "Alist between block names and the associated parsing function.
269 Names must be uppercase. Any block whose name has no association
275 "List of affiliated keywords as strings.
283 "Alist of usual translations for keywords.
284 The key is the old name and the value the new one. The property
288 "List of affiliated keywords that can occur more than once in an element.
290 Their value will be consed into a list of strings, which will be
291 returned as the value of the property.
293 This list is checked after translations have been applied. See
294 `org-element-keyword-translation-alist'.
300 "List of affiliated keywords whose value can be parsed.
302 Their value will be stored as a secondary string: a list of
303 strings and objects.
305 This list is checked after translations have been applied. See
310 org-element-parsed-keywords)
311 "Alist of parsed keywords and associated properties.
312 This is generated from `org-element-parsed-keywords', which
316 "List of affiliated keywords which can have a secondary value.
318 In Org syntax, they can be written with optional square brackets
319 before the colons. For example, RESULTS keyword can be
320 associated to a hash value with the following:
322 #+RESULTS[hash-string]: some-source
324 This list is checked after translations have been applied. See
330 ;; Dual affiliated keywords.
334 ;; Regular affiliated keywords.
339 org-element-affiliated-keywords)))
341 ;; Export attributes.
343 "Regexp matching any affiliated keyword.
345 Keyword name is put in match group 1. Moreover, if keyword
346 belongs to `org-element-dual-keywords', put the dual value in
347 match group 2.
361 ;; Ignore all links excepted plain links in a link description.
362 ;; Also ignore radio-targets and line breaks.
364 italic latex-fragment macro plain-link statistics-cookie
365 strike-through subscript superscript underline verbatim)
367 ;; Remove any variable object from radio target as it would
368 ;; prevent it from being properly recognized.
370 subscript superscript underline superscript)
374 ;; Ignore inline babel call and inline src block as formulas are
375 ;; possible. Also ignore line breaks and statistics cookies.
377 latex-fragment link macro radio-target strike-through
378 subscript superscript target timestamp underline verbatim)
382 "Alist of objects restrictions.
384 key is an element or object type containing objects and value is
385 a list of types that can be contained within an element or object
386 of such type.
388 For example, in a `radio-target' object, one can only find
389 entities, latex-fragments, subscript, superscript and text
390 markup.
392 This alist also applies to secondary string. For example, an
393 `headline' type element doesn't directly contain objects, but
408 "Table used internally to pair only square brackets.
412 \f
413 ;;; Accessors and Setters
414 ;;
415 ;; Provide four accessors: `org-element-type', `org-element-property'
416 ;; `org-element-contents' and `org-element-restriction'.
417 ;;
418 ;; Setter functions allow to modify elements by side effect. There is
419 ;; `org-element-put-property', `org-element-set-contents'. These
420 ;; low-level functions are useful to build a parse tree.
421 ;;
422 ;; `org-element-adopt-element', `org-element-set-element',
423 ;; `org-element-extract-element' and `org-element-insert-before' are
424 ;; high-level functions useful to modify a parse tree.
425 ;;
426 ;; `org-element-secondary-p' is a predicate used to know if a given
427 ;; object belongs to a secondary string. `org-element-copy' returns
428 ;; an element or object, stripping its parent property in the process.
431 "Return type of ELEMENT.
433 The function returns the type of the element or object provided.
434 It can also return the following special value:
435 `plain-text' for a string
436 `org-data' for a complete document
437 nil in any other case."
443 "Extract the value from the PROPERTY of an ELEMENT."
448 "Extract contents from an ELEMENT."
454 "Return restriction associated to ELEMENT.
455 ELEMENT can be an element, an object or a symbol representing an
456 element or object type."
458 org-element-object-restrictions)))
461 "In ELEMENT set PROPERTY to VALUE.
462 Return modified element."
465 element))
468 "Set ELEMENT contents to CONTENTS."
475 "Non-nil when OBJECT directly belongs to a secondary string.
476 Return value is the property name, as a keyword, or nil."
479 org-element-secondary-value-alist))))
486 "Append elements to the contents of another element.
488 PARENT is an element or object. CHILDREN can be elements,
489 objects, or a strings.
491 The function takes care of setting `:parent' property for CHILD.
492 Return parent element."
494 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
495 ;; string: parent is the list itself.
498 ;; Add CHILDREN at the end of PARENT contents.
501 parent
503 ;; Return modified PARENT element.
507 "Extract ELEMENT from parse tree.
508 Remove element from the parse tree by side-effect, and return it
509 with its `:parent' property stripped out."
514 parent secondary
517 parent
519 ;; Return ELEMENT with its :parent removed.
523 "Insert ELEMENT before LOCATION in parse tree.
524 LOCATION is an element, object or string within the parse tree.
525 Parse tree is modified by side effect."
530 ;; Special case: LOCATION is the first element of an
531 ;; independent secondary string (e.g. :title property). Add
532 ;; ELEMENT in-place.
536 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires to tweak `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret a center-block element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
800 "Parse a footnote definition.
802 LIMIT bounds the search. AFFILIATED is a list of which CAR is
803 the buffer position at the beginning of the first affiliated
804 keyword and CDR is a plist of affiliated keywords along with
805 their value.
807 Return a list whose CAR is `footnote-definition' and CDR is
808 a plist containing `:label', `:begin' `:end', `:contents-begin',
809 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
811 Assume point is at the beginning of the footnote definition."
839 :begin begin
840 :end end
841 :contents-begin contents-begin
842 :contents-end contents-end
848 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
849 CONTENTS is the contents of the footnote-definition."
851 " "
852 contents))
855 ;;;; Headline
858 "Return node properties associated to headline at point.
859 Upcase property names. It avoids confusion between properties
860 obtained through property drawer and default properties from the
861 parser (e.g. `:end' and :END:). Return value is a plist."
873 properties))))
876 "Return time properties associated to headline at point.
877 Return value is a plist."
891 plist))))
894 "Parse a headline.
896 Return a list whose CAR is `headline' and CDR is a plist
897 containing `:raw-value', `:title', `:begin', `:end',
898 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
899 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
900 `:deadline', `:closed', `:archivedp', `:commentedp'
901 `:footnote-section-p', `:post-blank' and `:post-affiliated'
902 keywords.
904 The plist also contains any property set in the property drawer,
905 with its name in upper cases and colons added at the
906 beginning (e.g., `:CUSTOM_ID').
908 LIMIT is a buffer position bounding the search.
910 When RAW-SECONDARY-P is non-nil, headline's title will not be
911 parsed as a secondary string, but as a plain string instead.
913 Assume point is at beginning of the headline."
960 :begin begin
961 :end end
962 :pre-blank
965 :contents-begin contents-begin
966 :contents-end contents-end
967 :level level
968 :priority priority
969 :tags tags
970 :todo-keyword todo
971 :todo-type todo-type
974 end)
975 :footnote-section-p footnote-section-p
976 :archivedp archivedp
977 :commentedp commentedp
979 time-props
980 standard-props))))
982 headline :title
991 nil
997 "Interpret HEADLINE element as Org syntax.
998 CONTENTS is the contents of the element."
1011 ?*)
1015 " "
1018 org-footnote-section
1019 title))))
1021 heading
1022 ;; Align tags.
1030 ?\s)
1031 tags))
1035 tags))))
1037 contents)))
1040 ;;;; Inlinetask
1043 "Parse an inline task.
1045 Return a list whose CAR is `inlinetask' and CDR is a plist
1046 containing `:title', `:begin', `:end', `:contents-begin' and
1047 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1048 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1049 `:closed', `:post-blank' and `:post-affiliated' keywords.
1051 The plist also contains any property set in the property drawer,
1052 with its name in upper cases and colons added at the
1053 beginning (e.g., `:CUSTOM_ID').
1055 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1056 title will not be parsed as a secondary string, but as a plain
1057 string instead.
1059 Assume point is at beginning of the inline task."
1104 :begin begin
1105 :end end
1106 :contents-begin contents-begin
1107 :contents-end contents-end
1108 :level level
1109 :priority priority
1110 :tags tags
1111 :todo-keyword todo
1112 :todo-type todo-type
1115 time-props
1116 standard-props))))
1118 inlinetask :title
1127 nil
1133 "Interpret INLINETASK element as Org syntax.
1134 CONTENTS is the contents of inlinetask."
1148 ;; Align tags.
1156 ? )
1157 tags))
1161 tags))))
1162 ;; Prefer degenerate inlinetasks when there are no
1163 ;; contents.
1166 contents
1170 ;;;; Item
1173 "Parse an item.
1175 STRUCT is the structure of the plain list.
1177 Return a list whose CAR is `item' and CDR is a plist containing
1178 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1179 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1180 `:post-affiliated' keywords.
1182 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1183 any, will not be parsed as a secondary string, but as a plain
1184 string instead.
1186 Assume point is at the beginning of the item."
1209 ;; Ignore tags in un-ordered lists: they are just
1210 ;; a part of item's body.
1217 ;; If first line isn't empty, contents really
1218 ;; start at the text after item's meta-data.
1228 :begin begin
1229 :end end
1230 :contents-begin contents-begin
1231 :contents-end contents-end
1232 :checkbox checkbox
1233 :counter counter
1234 :structure struct
1238 item :tag
1249 "Interpret ITEM element as Org syntax.
1250 CONTENTS is the contents of the element."
1260 ;; Compute indentation.
1265 ;; Indent contents.
1267 bullet
1282 ;;;; Plain List
1285 ;; Return structure of list at point. Internal function. See
1286 ;; `org-list-struct' for details.
1291 items struct)
1296 ;; At limit: end all items.
1305 ;; At list end: end all items.
1310 ;; At a new item: end previous sibling.
1322 ind
1323 bullet
1326 ;; Description tag.
1330 ;; Ending position, unknown so far.
1331 nil)))
1332 items))
1334 ;; Skip empty lines.
1336 ;; Skip inline tasks and blank lines along the way.
1343 ;; At some text line. Check if it ends any previous item.
1356 ;; Skip blocks (any type) and drawers contents.
1361 limit t)))
1367 "Parse a plain list.
1369 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1370 the buffer position at the beginning of the first affiliated
1371 keyword and CDR is a plist of affiliated keywords along with
1372 their value. STRUCTURE is the structure of the plain list being
1373 parsed.
1375 Return a list whose CAR is `plain-list' and CDR is a plist
1376 containing `:type', `:begin', `:end', `:contents-begin' and
1377 `:contents-end', `:structure', `:post-blank' and
1378 `:post-affiliated' keywords.
1380 Assume point is at the beginning of the list."
1394 pos))
1398 ;; Return value.
1402 :begin begin
1403 :end end
1404 :contents-begin contents-begin
1405 :contents-end contents-end
1406 :structure struct
1412 "Interpret plain-list element as Org syntax.
1413 CONTENTS is the contents of the element."
1421 ;;;; Property Drawer
1424 "Parse a property drawer.
1426 LIMIT bounds the search.
1428 Return a list whose car is `property-drawer' and cdr is a plist
1429 containing `:begin', `:end', `:contents-begin', `:contents-end',
1430 `:post-blank' and `:post-affiliated' keywords.
1432 Assume point is at the beginning of the property drawer."
1445 :end end
1447 :contents-end contents-end
1452 "Interpret property-drawer element as Org syntax.
1453 CONTENTS is the properties within the drawer."
1457 ;;;; Quote Block
1460 "Parse a quote block.
1462 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1463 the buffer position at the beginning of the first affiliated
1464 keyword and CDR is a plist of affiliated keywords along with
1465 their value.
1467 Return a list whose CAR is `quote-block' and CDR is a plist
1468 containing `:begin', `:end', `:contents-begin', `:contents-end',
1469 `:post-blank' and `:post-affiliated' keywords.
1471 Assume point is at the beginning of the block."
1475 ;; Incomplete block: parse it as a paragraph.
1481 ;; Empty blocks have no contents.
1494 :end end
1495 :contents-begin contents-begin
1496 :contents-end contents-end
1502 "Interpret quote-block element as Org syntax.
1503 CONTENTS is the contents of the element."
1507 ;;;; Section
1510 "Parse a section.
1512 Return a list whose CAR is `section' and CDR is a plist
1513 containing `:begin', `:end', `:contents-begin', `contents-end',
1514 `:post-blank' and `:post-affiliated' keywords."
1516 ;; Beginning of section is the beginning of the first non-blank
1517 ;; line after previous headline.
1525 :end end
1526 :contents-begin begin
1527 :contents-end pos-before-blank
1532 "Interpret section element as Org syntax.
1533 CONTENTS is the contents of the element."
1534 contents)
1537 ;;;; Special Block
1540 "Parse a special block.
1542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1543 the buffer position at the beginning of the first affiliated
1544 keyword and CDR is a plist of affiliated keywords along with
1545 their value.
1547 Return a list whose CAR is `special-block' and CDR is a plist
1548 containing `:type', `:begin', `:end', `:contents-begin',
1549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1551 Assume point is at the beginning of the block."
1558 limit t)))
1559 ;; Incomplete block: parse it as a paragraph.
1565 ;; Empty blocks have no contents.
1578 :begin begin
1579 :end end
1580 :contents-begin contents-begin
1581 :contents-end contents-end
1587 "Interpret SPECIAL-BLOCK element as Org syntax.
1588 CONTENTS is the contents of the element."
1593 \f
1594 ;;; Elements
1595 ;;
1596 ;; For each element, a parser and an interpreter are also defined.
1597 ;; Both follow the same naming convention used for greater elements.
1598 ;;
1599 ;; Also, as for greater elements, adding a new element type is done
1600 ;; through the following steps: implement a parser and an interpreter,
1601 ;; tweak `org-element--current-element' so that it recognizes the new
1602 ;; type and add that new type to `org-element-all-elements'.
1603 ;;
1604 ;; As a special case, when the newly defined type is a block type,
1605 ;; `org-element-block-name-alist' has to be modified accordingly.
1608 ;;;; Babel Call
1611 "Parse a babel call.
1613 LIMIT bounds the search. AFFILIATED is a list of which car is
1614 the buffer position at the beginning of the first affiliated
1615 keyword and cdr is a plist of affiliated keywords along with
1616 their value.
1618 Return a list whose car is `babel-call' and cdr is a plist
1619 containing `:call', `:inside-header', `:arguments',
1620 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1621 `:post-affiliated' as keywords."
1635 value)))
1645 :begin begin
1646 :end end
1647 :value value
1653 "Interpret BABEL-CALL element as Org syntax."
1663 ;;;; Clock
1666 "Parse a clock.
1668 LIMIT bounds the search.
1670 Return a list whose CAR is `clock' and CDR is a plist containing
1671 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1672 `:post-affiliated' as keywords."
1692 :value value
1693 :duration duration
1694 :begin begin
1695 :end end
1696 :post-blank post-blank
1700 "Interpret CLOCK element as Org syntax."
1708 "%2s:%02s"
1712 ;;;; Comment
1715 "Parse a comment.
1717 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1718 the buffer position at the beginning of the first affiliated
1719 keyword and CDR is a plist of affiliated keywords along with
1720 their value.
1722 Return a list whose CAR is `comment' and CDR is a plist
1723 containing `:begin', `:end', `:value', `:post-blank',
1724 `:post-affiliated' keywords.
1726 Assume point is at comment beginning."
1735 ;; Get comments ending.
1738 ;; Accumulate lines without leading hash and first
1739 ;; whitespace.
1753 :end end
1754 :value value
1760 "Interpret COMMENT element as Org syntax.
1761 CONTENTS is nil."
1765 ;;;; Comment Block
1768 "Parse an export block.
1770 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1771 the buffer position at the beginning of the first affiliated
1772 keyword and CDR is a plist of affiliated keywords along with
1773 their value.
1775 Return a list whose CAR is `comment-block' and CDR is a plist
1776 containing `:begin', `:end', `:value', `:post-blank' and
1777 `:post-affiliated' keywords.
1779 Assume point is at comment block beginning."
1783 ;; Incomplete block: parse it as a paragraph.
1796 contents-begin contents-end)))
1800 :end end
1801 :value value
1807 "Interpret COMMENT-BLOCK element as Org syntax."
1814 ;;;; Diary Sexp
1817 "Parse a diary sexp.
1819 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1820 the buffer position at the beginning of the first affiliated
1821 keyword and CDR is a plist of affiliated keywords along with
1822 their value.
1824 Return a list whose CAR is `diary-sexp' and CDR is a plist
1825 containing `:begin', `:end', `:value', `:post-blank' and
1826 `:post-affiliated' keywords."
1838 :begin begin
1839 :end end
1845 "Interpret DIARY-SEXP as Org syntax."
1849 ;;;; Example Block
1852 "Parse an example block.
1854 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1855 the buffer position at the beginning of the first affiliated
1856 keyword and CDR is a plist of affiliated keywords along with
1857 their value.
1859 Return a list whose CAR is `example-block' and CDR is a plist
1860 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1861 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1862 `:value', `:post-blank' and `:post-affiliated' keywords."
1866 ;; Incomplete block: parse it as a paragraph.
1874 ;; Switches analysis
1881 ;; Should labels be retained in (or stripped from) example
1882 ;; blocks?
1887 ;; What should code-references use - labels or
1888 ;; line-numbers?
1897 ;; Standard block parsing.
1905 contents-begin contents-end))
1906 block-ind))
1915 :end end
1916 :value value
1917 :switches switches
1918 :number-lines number-lines
1919 :preserve-indent preserve-indent
1920 :retain-labels retain-labels
1921 :use-labels use-labels
1922 :label-fmt label-fmt
1928 "Interpret EXAMPLE-BLOCK element as Org syntax."
1936 value
1941 ;;;; Export Block
1944 "Parse an export block.
1946 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1947 the buffer position at the beginning of the first affiliated
1948 keyword and CDR is a plist of affiliated keywords along with
1949 their value.
1951 Return a list whose CAR is `export-block' and CDR is a plist
1952 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1953 `:post-affiliated' keywords.
1955 Assume point is at export-block beginning."
1962 ;; Incomplete block: parse it as a paragraph.
1975 contents-end)))
1979 :end end
1980 :type type
1981 :value value
1987 "Interpret EXPORT-BLOCK element as Org syntax."
1994 ;;;; Fixed-width
1997 "Parse a fixed-width section.
1999 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2000 the buffer position at the beginning of the first affiliated
2001 keyword and CDR is a plist of affiliated keywords along with
2002 their value.
2004 Return a list whose CAR is `fixed-width' and CDR is a plist
2005 containing `:begin', `:end', `:value', `:post-blank' and
2006 `:post-affiliated' keywords.
2008 Assume point is at the beginning of the fixed-width area."
2012 value
2017 ;; Accumulate text without starting colons.
2030 :end end
2031 :value value
2037 "Interpret FIXED-WIDTH element as Org syntax."
2045 ;;;; Horizontal Rule
2048 "Parse an horizontal rule.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2056 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2057 keywords."
2067 :end end
2073 "Interpret HORIZONTAL-RULE element as Org syntax."
2077 ;;;; Keyword
2080 "Parse a keyword at point.
2082 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2083 the buffer position at the beginning of the first affiliated
2084 keyword and CDR is a plist of affiliated keywords along with
2085 their value.
2087 Return a list whose CAR is `keyword' and CDR is a plist
2088 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2089 `:post-affiliated' keywords."
2091 ;; An orphaned affiliated keyword is considered as a regular
2092 ;; keyword. In this case AFFILIATED is nil, so we take care of
2093 ;; this corner case.
2106 :value value
2107 :begin begin
2108 :end end
2114 "Interpret KEYWORD element as Org syntax."
2120 ;;;; Latex Environment
2124 "Regexp matching the beginning of a LaTeX environment.
2125 The environment is captured by the first group.
2131 "Format string matching the ending of a LaTeX environment.
2135 "Parse a LaTeX environment.
2137 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2138 the buffer position at the beginning of the first affiliated
2139 keyword and CDR is a plist of affiliated keywords along with
2140 their value.
2142 Return a list whose CAR is `latex-environment' and CDR is a plist
2143 containing `:begin', `:end', `:value', `:post-blank' and
2144 `:post-affiliated' keywords.
2146 Assume point is at the beginning of the latex environment."
2153 limit t))
2154 ;; Incomplete latex environment: parse it as a paragraph.
2164 :end end
2165 :value value
2171 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2175 ;;;; Node Property
2178 "Parse a node-property at point.
2180 LIMIT bounds the search.
2182 Return a list whose CAR is `node-property' and CDR is a plist
2183 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2184 `:post-affiliated' keywords."
2194 limit))))
2197 :value value
2198 :begin begin
2199 :end end
2204 "Interpret NODE-PROPERTY element as Org syntax."
2210 ;;;; Paragraph
2213 "Parse a paragraph.
2215 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2216 the buffer position at the beginning of the first affiliated
2217 keyword and CDR is a plist of affiliated keywords along with
2218 their value.
2220 Return a list whose CAR is `paragraph' and CDR is a plist
2221 containing `:begin', `:end', `:contents-begin' and
2222 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2224 Assume point is at the beginning of the paragraph."
2231 ;; A matching `org-element-paragraph-separate' is not
2232 ;; necessarily the end of the paragraph. In particular,
2233 ;; drawers, blocks or LaTeX environments opening lines
2234 ;; must be closed. Moreover keywords with a secondary
2235 ;; value must belong to "dual keywords".
2249 limit t)))
2255 limit t)))
2258 org-element-dual-keywords))
2259 ;; Everything else is unambiguous.
2272 :end end
2273 :contents-begin contents-begin
2274 :contents-end contents-end
2280 "Interpret paragraph element as Org syntax.
2281 CONTENTS is the contents of the element."
2282 contents)
2285 ;;;; Planning
2288 "Parse a planning.
2290 LIMIT bounds the search.
2292 Return a list whose CAR is `planning' and CDR is a plist
2293 containing `:closed', `:deadline', `:scheduled', `:begin',
2294 `:end', `:post-blank' and `:post-affiliated' keywords."
2304 closed deadline scheduled)
2316 :deadline deadline
2317 :scheduled scheduled
2318 :begin begin
2319 :end end
2320 :post-blank post-blank
2324 "Interpret PLANNING element as Org syntax."
2326 #'identity
2343 ;;;; Src Block
2346 "Parse a src block.
2348 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2349 the buffer position at the beginning of the first affiliated
2350 keyword and CDR is a plist of affiliated keywords along with
2351 their value.
2353 Return a list whose CAR is `src-block' and CDR is a plist
2354 containing `:language', `:switches', `:parameters', `:begin',
2355 `:end', `:number-lines', `:retain-labels', `:use-labels',
2356 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2357 `:post-affiliated' keywords.
2359 Assume point is at the beginning of the block."
2362 limit t)))
2363 ;; Incomplete block: parse it as a paragraph.
2369 ;; Get language as a string.
2378 ;; Get switches.
2380 ;; Get parameters.
2382 ;; Switches analysis
2393 ;; Should labels be retained in (or stripped from)
2394 ;; src blocks?
2399 ;; What should code-references use - labels or
2400 ;; line-numbers?
2405 ;; Indentation.
2407 ;; Retrieve code.
2412 block-ind))
2416 ;; Get position after ending blank lines.
2426 :begin begin
2427 :end end
2428 :number-lines number-lines
2429 :preserve-indent preserve-indent
2430 :retain-labels retain-labels
2431 :use-labels use-labels
2432 :label-fmt label-fmt
2433 :value value
2439 "Interpret SRC-BLOCK element as Org syntax."
2448 val)
2462 ;;;; Table
2465 "Parse a table at point.
2467 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2468 the buffer position at the beginning of the first affiliated
2469 keyword and CDR is a plist of affiliated keywords along with
2470 their value.
2472 Return a list whose CAR is `table' and CDR is a plist containing
2473 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2474 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2475 keywords.
2477 Assume point is at the beginning of the table."
2493 acc))
2500 :end end
2501 :type type
2502 :tblfm tblfm
2503 ;; Only `org' tables have contents. `table.el' tables
2504 ;; use a `:value' property to store raw table as
2505 ;; a string.
2510 table-begin table-end))
2516 "Interpret TABLE element as Org syntax.
2517 CONTENTS is a string, if table's type is `org', or nil."
2528 ;;;; Table Row
2531 "Parse table row at point.
2533 Return a list whose CAR is `table-row' and CDR is a plist
2534 containing `:begin', `:end', `:contents-begin', `:contents-end',
2535 `:type', `:post-blank' and `:post-affiliated' keywords."
2539 ;; A table rule has no contents. In that case, ensure
2540 ;; CONTENTS-BEGIN matches CONTENTS-END.
2550 :begin begin
2551 :end end
2552 :contents-begin contents-begin
2553 :contents-end contents-end
2558 "Interpret TABLE-ROW element as Org syntax.
2559 CONTENTS is the contents of the table row."
2564 ;;;; Verse Block
2567 "Parse a verse block.
2569 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2570 the buffer position at the beginning of the first affiliated
2571 keyword and CDR is a plist of affiliated keywords along with
2572 their value.
2574 Return a list whose CAR is `verse-block' and CDR is a plist
2575 containing `:begin', `:end', `:contents-begin', `:contents-end',
2576 `:post-blank' and `:post-affiliated' keywords.
2578 Assume point is at beginning of the block."
2582 ;; Incomplete block: parse it as a paragraph.
2597 :end end
2598 :contents-begin contents-begin
2599 :contents-end contents-end
2605 "Interpret verse-block element as Org syntax.
2606 CONTENTS is verse block contents."
2610 \f
2611 ;;; Objects
2612 ;;
2613 ;; Unlike to elements, raw text can be found between objects. Hence,
2614 ;; `org-element--object-lex' is provided to find the next object in
2615 ;; buffer.
2616 ;;
2617 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2618 ;; object types they can contain will be specified in
2619 ;; `org-element-object-restrictions'.
2620 ;;
2621 ;; Creating a new type of object requires to alter
2622 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2623 ;; new type in `org-element-all-objects', and possibly add
2624 ;; restrictions in `org-element-object-restrictions'.
2626 ;;;; Bold
2629 "Parse bold object at point, if any.
2631 When at a bold object, return a list whose car is `bold' and cdr
2632 is a plist with `:begin', `:end', `:contents-begin' and
2633 `:contents-end' and `:post-blank' keywords. Otherwise, return
2634 nil.
2636 Assume point is at the first star marker."
2648 :end end
2649 :contents-begin contents-begin
2650 :contents-end contents-end
2654 "Interpret bold object as Org syntax.
2655 CONTENTS is the contents of the object."
2659 ;;;; Code
2662 "Parse code object at point, if any.
2664 When at a code object, return a list whose car is `code' and cdr
2665 is a plist with `:value', `:begin', `:end' and `:post-blank'
2666 keywords. Otherwise, return nil.
2668 Assume point is at the first tilde marker."
2679 :begin begin
2680 :end end
2684 "Interpret CODE object as Org syntax."
2688 ;;;; Entity
2691 "Parse entity at point, if any.
2693 When at an entity, return a list whose car is `entity' and cdr
2694 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2695 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2696 `:post-blank' as keywords. Otherwise, return nil.
2698 Assume point is at the beginning of the entity."
2700 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2718 :begin begin
2719 :end end
2720 :use-brackets-p bracketsp
2724 "Interpret ENTITY object as Org syntax."
2730 ;;;; Export Snippet
2733 "Parse export snippet at point.
2735 When at an export snippet, return a list whose car is
2736 `export-snippet' and cdr a plist with `:begin', `:end',
2737 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2738 return nil.
2740 Assume point is at the beginning of the snippet."
2756 :value value
2757 :begin begin
2758 :end end
2762 "Interpret EXPORT-SNIPPET object as Org syntax."
2768 ;;;; Footnote Reference
2771 "Parse footnote reference at point, if any.
2773 When at a footnote reference, return a list whose car is
2774 `footnote-reference' and cdr a plist with `:label', `:type',
2775 `:begin', `:end', `:content-begin', `:contents-end' and
2776 `:post-blank' as keywords. Otherwise, return nil."
2796 :type type
2797 :begin begin
2798 :end end
2804 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2805 CONTENTS is its definition, when inline, or nil."
2811 ;;;; Inline Babel Call
2814 "Parse inline babel call at point, if any.
2816 When at an inline babel call, return a list whose car is
2817 `inline-babel-call' and cdr a plist with `:call',
2818 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2819 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2821 Assume point is at the beginning of the babel call."
2837 :inside-header inside-header
2838 :arguments arguments
2839 :end-header end-header
2840 :begin begin
2841 :end end
2842 :value value
2846 "Interpret INLINE-BABEL-CALL object as Org syntax."
2856 ;;;; Inline Src Block
2859 "Parse inline source block at point, if any.
2861 When at an inline source block, return a list whose car is
2862 `inline-src-block' and cdr a plist with `:begin', `:end',
2863 `:language', `:value', `:parameters' and `:post-blank' as
2864 keywords. Otherwise, return nil.
2866 Assume point is at the beginning of the inline src block."
2879 :value value
2880 :parameters parameters
2881 :begin begin
2882 :end end
2886 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2891 language
2893 body)))
2895 ;;;; Italic
2898 "Parse italic object at point, if any.
2900 When at an italic object, return a list whose car is `italic' and
2901 cdr is a plist with `:begin', `:end', `:contents-begin' and
2902 `:contents-end' and `:post-blank' keywords. Otherwise, return
2903 nil.
2905 Assume point is at the first slash marker."
2917 :end end
2918 :contents-begin contents-begin
2919 :contents-end contents-end
2923 "Interpret italic object as Org syntax.
2924 CONTENTS is the contents of the object."
2928 ;;;; Latex Fragment
2931 "Parse LaTeX fragment at point, if any.
2933 When at a LaTeX fragment, return a list whose car is
2934 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2935 and `:post-blank' as keywords. Otherwise, return nil.
2937 Assume point is at the beginning of the LaTeX fragment."
2955 ;; Macro.
2965 :begin begin
2966 :end end
2970 "Interpret LATEX-FRAGMENT object as Org syntax."
2973 ;;;; Line Break
2976 "Parse line break at point, if any.
2978 When at a line break, return a list whose car is `line-break',
2979 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2980 Otherwise, return nil.
2982 Assume point is at the beginning of the line break."
2991 "Interpret LINE-BREAK object as Org syntax."
2995 ;;;; Link
2998 "Parse link at point, if any.
3000 When at a link, return a list whose car is `link' and cdr a plist
3001 with `:type', `:path', `:raw-link', `:application',
3002 `:search-option', `:begin', `:end', `:contents-begin',
3003 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3004 nil.
3006 Assume point is at the beginning of the link."
3009 end contents-begin contents-end link-end post-blank path type
3010 raw-link search-option application)
3012 ;; Type 1: Text targeted from a radio target.
3021 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3026 ;; RAW-LINK is the original link. Expand any
3027 ;; abbreviation in it.
3028 ;;
3029 ;; Also treat any newline character and associated
3030 ;; indentation as a single space character. This is not
3031 ;; compatible with RFC 3986, which requires to ignore
3032 ;; them altogether. However, doing so would require
3033 ;; users to encode spaces on the fly when writing links
3034 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3035 ;; [[shell:ls *.org]], which defeats Org's focus on
3036 ;; simplicity.
3041 ;; Determine TYPE of link and set PATH accordingly. According
3042 ;; to RFC 3986, remove whitespaces from URI in external links.
3043 ;; In internal ones, treat indentation as a single space.
3045 ;; File type.
3050 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3054 ;; Id type: PATH is the id.
3057 ;; Code-ref type: PATH is the name of the reference.
3062 ;; Custom-id type: PATH is the name of the custom id.
3066 ;; Fuzzy type: Internal link either matches a target, an
3067 ;; headline name or nothing. PATH is the target or
3068 ;; headline's name.
3072 ;; Type 3: Plain link, e.g., http://orgmode.org
3078 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3079 ;; bracket links, follow RFC 3986 and remove any extra
3080 ;; whitespace in URI.
3090 ;; In any case, deduce end point after trailing white space from
3091 ;; LINK-END variable.
3096 ;; Special "file" type link processing. Extract opening
3097 ;; application and search option, if any. Also normalize URI.
3104 ;; Translate link, if `org-link-translation-function' is set.
3112 :path path
3114 :application application
3115 :search-option search-option
3116 :begin begin
3117 :end end
3118 :contents-begin contents-begin
3119 :contents-end contents-end
3123 "Interpret LINK object as Org syntax.
3124 CONTENTS is the contents of the object, or nil."
3135 path
3142 ;;;; Macro
3145 "Parse macro at point, if any.
3147 When at a macro, return a list whose car is `macro' and cdr
3148 a plist with `:key', `:args', `:begin', `:end', `:value' and
3149 `:post-blank' as keywords. Otherwise, return nil.
3151 Assume point is at the macro."
3164 :value value
3165 :args args
3166 :begin begin
3167 :end end
3171 "Interpret MACRO object as Org syntax."
3175 ;;;; Radio-target
3178 "Parse radio target at point, if any.
3180 When at a radio target, return a list whose car is `radio-target'
3181 and cdr a plist with `:begin', `:end', `:contents-begin',
3182 `:contents-end', `:value' and `:post-blank' as keywords.
3183 Otherwise, return nil.
3185 Assume point is at the radio target."
3197 :end end
3198 :contents-begin contents-begin
3199 :contents-end contents-end
3200 :post-blank post-blank
3204 "Interpret target object as Org syntax.
3205 CONTENTS is the contents of the object."
3209 ;;;; Statistics Cookie
3212 "Parse statistics cookie at point, if any.
3214 When at a statistics cookie, return a list whose car is
3215 `statistics-cookie', and cdr a plist with `:begin', `:end',
3216 `:value' and `:post-blank' keywords. Otherwise, return nil.
3218 Assume point is at the beginning of the statistics-cookie."
3229 :end end
3230 :value value
3234 "Interpret STATISTICS-COOKIE object as Org syntax."
3238 ;;;; Strike-Through
3241 "Parse strike-through object at point, if any.
3243 When at a strike-through object, return a list whose car is
3244 `strike-through' and cdr is a plist with `:begin', `:end',
3245 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3246 Otherwise, return nil.
3248 Assume point is at the first plus sign marker."
3260 :end end
3261 :contents-begin contents-begin
3262 :contents-end contents-end
3266 "Interpret strike-through object as Org syntax.
3267 CONTENTS is the contents of the object."
3271 ;;;; Subscript
3274 "Parse subscript at point, if any.
3276 When at a subscript object, return a list whose car is
3277 `subscript' and cdr a plist with `:begin', `:end',
3278 `:contents-begin', `:contents-end', `:use-brackets-p' and
3279 `:post-blank' as keywords. Otherwise, return nil.
3281 Assume point is at the underscore."
3295 :end end
3296 :use-brackets-p bracketsp
3297 :contents-begin contents-begin
3298 :contents-end contents-end
3302 "Interpret SUBSCRIPT object as Org syntax.
3303 CONTENTS is the contents of the object."
3306 contents))
3309 ;;;; Superscript
3312 "Parse superscript at point, if any.
3314 When at a superscript object, return a list whose car is
3315 `superscript' and cdr a plist with `:begin', `:end',
3316 `:contents-begin', `:contents-end', `:use-brackets-p' and
3317 `:post-blank' as keywords. Otherwise, return nil.
3319 Assume point is at the caret."
3333 :end end
3334 :use-brackets-p bracketsp
3335 :contents-begin contents-begin
3336 :contents-end contents-end
3340 "Interpret SUPERSCRIPT object as Org syntax.
3341 CONTENTS is the contents of the object."
3344 contents))
3347 ;;;; Table Cell
3350 "Parse table cell at point.
3351 Return a list whose car is `table-cell' and cdr is a plist
3352 containing `:begin', `:end', `:contents-begin', `:contents-end'
3353 and `:post-blank' keywords."
3361 :end end
3362 :contents-begin contents-begin
3363 :contents-end contents-end
3367 "Interpret table-cell element as Org syntax.
3368 CONTENTS is the contents of the cell, or nil."
3372 ;;;; Target
3375 "Parse target at point, if any.
3377 When at a target, return a list whose car is `target' and cdr
3378 a plist with `:begin', `:end', `:value' and `:post-blank' as
3379 keywords. Otherwise, return nil.
3381 Assume point is at the target."
3391 :end end
3392 :value value
3396 "Interpret TARGET object as Org syntax."
3400 ;;;; Timestamp
3411 "Parse time stamp at point, if any.
3413 When at a time stamp, return a list whose car is `timestamp', and
3414 cdr a plist with `:type', `:raw-value', `:year-start',
3415 `:month-start', `:day-start', `:hour-start', `:minute-start',
3416 `:year-end', `:month-end', `:day-end', `:hour-end',
3417 `:minute-end', `:repeater-type', `:repeater-value',
3418 `:repeater-unit', `:warning-type', `:warning-value',
3419 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3420 Otherwise, return nil.
3422 Assume point is at the beginning of the timestamp."
3441 date-start)
3452 raw-value)
3454 :repeater-type
3460 :repeater-unit
3469 :warning-unit
3472 year-start month-start day-start hour-start minute-start year-end
3473 month-end day-end hour-end minute-end)
3474 ;; Parse date-start.
3482 ;; Compute date-end. It can be provided directly in time-stamp,
3483 ;; or extracted from time range. Otherwise, it defaults to the
3484 ;; same values as date-start.
3494 :raw-value raw-value
3495 :year-start year-start
3496 :month-start month-start
3497 :day-start day-start
3498 :hour-start hour-start
3499 :minute-start minute-start
3500 :year-end year-end
3501 :month-end month-end
3502 :day-end day-end
3503 :hour-end hour-end
3504 :minute-end minute-end
3505 :begin begin
3506 :end end
3508 repeater-props
3509 warning-props))))))
3512 "Interpret TIMESTAMP object as Org syntax."
3530 ;; Build an Org timestamp string from TIME. ACTIVEP is
3531 ;; non-nil when time stamp is active. If WITH-TIME-P is
3532 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3533 ;; specify a time range in the timestamp. REPEAT-STRING is
3534 ;; the repeater string, if any.
3538 org-time-stamp-formats)
3539 time)))
3545 nil nil ts)))
3550 " "
3551 s
3553 ;; Return value.
3554 ts)))
3566 build-ts-string
3585 0
3593 "--"
3606 ;;;; Underline
3609 "Parse underline object at point, if any.
3611 When at an underline object, return a list whose car is
3612 `underline' and cdr is a plist with `:begin', `:end',
3613 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3614 Otherwise, return nil.
3616 Assume point is at the first underscore marker."
3628 :end end
3629 :contents-begin contents-begin
3630 :contents-end contents-end
3634 "Interpret underline object as Org syntax.
3635 CONTENTS is the contents of the object."
3639 ;;;; Verbatim
3642 "Parse verbatim object at point, if any.
3644 When at a verbatim object, return a list whose car is `verbatim'
3645 and cdr is a plist with `:value', `:begin', `:end' and
3646 `:post-blank' keywords. Otherwise, return nil.
3648 Assume point is at the first equal sign marker."
3659 :begin begin
3660 :end end
3664 "Interpret VERBATIM object as Org syntax."
3668 \f
3669 ;;; Parsing Element Starting At Point
3670 ;;
3671 ;; `org-element--current-element' is the core function of this section.
3672 ;; It returns the Lisp representation of the element starting at
3673 ;; point.
3674 ;;
3675 ;; `org-element--current-element' makes use of special modes. They
3676 ;; are activated for fixed element chaining (e.g., `plain-list' >
3677 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3678 ;; `section'). Special modes are: `first-section', `item',
3679 ;; `node-property', `section' and `table-row'.
3682 "Parse the element starting at point.
3684 Return value is a list like (TYPE PROPS) where TYPE is the type
3685 of the element and PROPS a plist of properties associated to the
3686 element.
3688 Possible types are defined in `org-element-all-elements'.
3690 LIMIT bounds the search.
3692 Optional argument GRANULARITY determines the depth of the
3693 recursion. Allowed values are `headline', `greater-element',
3694 `element', `object' or nil. When it is broader than `object' (or
3695 nil), secondary values will not be parsed, since they only
3696 contain objects.
3698 Optional argument MODE, when non-nil, can be either
3699 `first-section', `section', `planning', `item', `node-property'
3700 and `table-row'.
3702 If STRUCTURE isn't provided but MODE is set to `item', it will be
3703 computed.
3705 This function assumes point is always at the beginning of the
3706 element it has to parse."
3709 ;; Determine if parsing depth allows for secondary strings
3710 ;; parsing. It only applies to elements referenced in
3711 ;; `org-element-secondary-value-alist'.
3714 ;; Item.
3717 ;; Table Row.
3719 ;; Node Property.
3721 ;; Headline.
3724 ;; Sections (must be checked after headline).
3729 limit)))
3730 ;; Planning.
3733 ;; Property drawer.
3737 ;; When not at bol, point is at the beginning of an item or
3738 ;; a footnote definition: next item is always a paragraph.
3740 ;; Clock.
3742 ;; Inlinetask.
3745 ;; From there, elements can have affiliated keywords.
3748 ;; Jumping over affiliated keywords put point off-limits.
3749 ;; Parse them as regular keywords.
3753 ;; LaTeX Environment.
3756 ;; Drawer and Property Drawer.
3759 ;; Fixed Width
3762 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3763 ;; Keywords.
3772 org-element-block-name-alist)))
3787 ;; Footnote Definition.
3790 ;; Horizontal Rule.
3793 ;; Diary Sexp.
3796 ;; Table.
3799 ;; List.
3802 limit affiliated
3804 ;; Default element: Paragraph.
3808 ;; Most elements can have affiliated keywords. When looking for an
3809 ;; element beginning, we want to move before them, as they belong to
3810 ;; that element, and, in the meantime, collect information they give
3811 ;; into appropriate properties. Hence the following function.
3814 "Collect affiliated keywords from point down to LIMIT.
3816 Return a list whose CAR is the position at the first of them and
3817 CDR a plist of keywords and values and move point to the
3818 beginning of the first line after them.
3820 As a special case, if element doesn't start at the beginning of
3821 the line (e.g., a paragraph starting an item), CAR is current
3822 position of point and CDR is nil."
3826 ;; RESTRICT is the list of objects allowed in parsed
3827 ;; keywords value.
3829 output)
3832 ;; Apply translation to RAW-KWD. From there, KWD is
3833 ;; the official keyword.
3835 org-element-keyword-translation-alist))
3836 raw-kwd))
3837 ;; Find main value for any keyword.
3843 ;; PARSEDP is non-nil when keyword should have its
3844 ;; value parsed.
3846 ;; If KWD is a dual keyword, find its secondary
3847 ;; value. Maybe parse it.
3856 ;; Attribute a property name to KWD.
3858 ;; Now set final shape for VALUE.
3864 nil restrict)))
3868 ;; Attributes can always appear on multiple lines.
3871 ;; Eventually store the new value in OUTPUT.
3873 ;; Move to next keyword.
3875 ;; If affiliated keywords are orphaned: move back to first one.
3876 ;; They will be parsed as a paragraph.
3878 ;; Return value.
3882 \f
3883 ;;; The Org Parser
3884 ;;
3885 ;; The two major functions here are `org-element-parse-buffer', which
3886 ;; parses Org syntax inside the current buffer, taking into account
3887 ;; region, narrowing, or even visibility if specified, and
3888 ;; `org-element-parse-secondary-string', which parses objects within
3889 ;; a given string.
3890 ;;
3891 ;; The (almost) almighty `org-element-map' allows to apply a function
3892 ;; on elements or objects matching some type, and accumulate the
3893 ;; resulting values. In an export situation, it also skips unneeded
3894 ;; parts of the parse tree.
3897 "Recursively parse the buffer and return structure.
3898 If narrowing is in effect, only parse the visible part of the
3899 buffer.
3901 Optional argument GRANULARITY determines the depth of the
3902 recursion. It can be set to the following symbols:
3904 `headline' Only parse headlines.
3905 `greater-element' Don't recurse into greater elements excepted
3906 headlines and sections. Thus, elements
3907 parsed are the top-level ones.
3908 `element' Parse everything but objects and plain text.
3909 `object' Parse the complete buffer (default).
3911 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3912 elements.
3914 An element or an objects is represented as a list with the
3915 pattern (TYPE PROPERTIES CONTENTS), where :
3917 TYPE is a symbol describing the element or object. See
3918 `org-element-all-elements' and `org-element-all-objects' for an
3919 exhaustive list of such symbols. One can retrieve it with
3920 `org-element-type' function.
3922 PROPERTIES is the list of attributes attached to the element or
3923 object, as a plist. Although most of them are specific to the
3924 element or object type, all types share `:begin', `:end',
3925 `:post-blank' and `:parent' properties, which respectively
3926 refer to buffer position where the element or object starts,
3927 ends, the number of white spaces or blank lines after it, and
3928 the element or object containing it. Properties values can be
3929 obtained by using `org-element-property' function.
3931 CONTENTS is a list of elements, objects or raw strings
3932 contained in the current element or object, when applicable.
3933 One can access them with `org-element-contents' function.
3935 The Org buffer has `org-data' as type and nil as properties.
3936 `org-element-map' function can be used to find specific elements
3937 or objects within the parse tree.
3939 This function assumes that current major mode is `org-mode'."
3945 ;; Start in `first-section' mode so text before the first
3946 ;; headline belongs to a section.
3950 "Recursively parse objects in STRING and return structure.
3952 RESTRICTION is a symbol limiting the object types that will be
3953 looked after.
3955 Optional argument PARENT, when non-nil, is the element or object
3956 containing the secondary string. It is used to set correctly
3957 `:parent' property within the string.
3959 If STRING is the empty string or nil, return nil."
3975 data))))))
3979 "Map a function on selected elements or objects.
3981 DATA is a parse tree, an element, an object, a string, or a list
3982 of such constructs. TYPES is a symbol or list of symbols of
3983 elements or objects types (see `org-element-all-elements' and
3984 `org-element-all-objects' for a complete list of types). FUN is
3985 the function called on the matching element or object. It has to
3986 accept one argument: the element or object itself.
3988 When optional argument INFO is non-nil, it should be a plist
3989 holding export options. In that case, parts of the parse tree
3990 not exportable according to that property list will be skipped.
3992 When optional argument FIRST-MATCH is non-nil, stop at the first
3993 match for which FUN doesn't return nil, and return that value.
3995 Optional argument NO-RECURSION is a symbol or a list of symbols
3996 representing elements or objects types. `org-element-map' won't
3997 enter any recursive element or object whose type belongs to that
3998 list. Though, FUN can still be applied on them.
4000 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4001 apply to matching objects within parsed affiliated keywords (see
4002 `org-element-parsed-keywords').
4004 Nil values returned from FUN do not appear in the results.
4007 Examples:
4008 ---------
4010 Assuming TREE is a variable containing an Org buffer parse tree,
4011 the following example will return a flat list of all `src-block'
4012 and `example-block' elements in it:
4016 The following snippet will find the first headline with a level
4020 (lambda (hl)
4021 (and (= (org-element-property :level hl) 1)
4023 (org-element-property :begin hl)))
4024 nil t)
4026 The next example will return a flat list of all `plain-list' type
4027 elements in TREE that are not a sub-list themselves:
4031 Eventually, this example will return a flat list of all `bold'
4032 type objects containing a `latex-snippet' type object, even
4033 looking into captions:
4036 (lambda (b)
4038 nil nil nil t)"
4039 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4043 ;; Recursion depth is determined by --CATEGORY.
4050 ;; If one object is found, the function has
4051 ;; to recurse into every object.
4054 ;; If one regular element is found, the
4055 ;; function has to recurse, at least, into
4056 ;; every element it encounters.
4059 --acc)
4062 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4063 ;; holding contextual information.
4067 ;; Ignored element in an export context.
4069 ;; List of elements or objects.
4071 ;; Unconditionally enter parse trees.
4075 ;; Check if TYPE is matching among TYPES. If so,
4076 ;; apply FUN to --DATA and accumulate return value
4077 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4083 ;; If --DATA has a secondary string that can contain
4084 ;; objects with their type among TYPES, look inside.
4087 org-element-secondary-value-alist)))
4089 ;; If --DATA has any parsed affiliated keywords and
4090 ;; WITH-AFFILIATED is non-nil, look for objects in
4091 ;; them.
4098 ;; Pay attention to the type of parsed
4099 ;; keyword. In particular, preserve order for
4100 ;; multiple keywords.
4113 ;; Determine if a recursion into --DATA is possible.
4115 ;; --TYPE is explicitly removed from recursion.
4117 ;; --DATA has no contents.
4119 ;; Looking for greater elements but --DATA is
4120 ;; simply an element or an object.
4123 ;; Looking for elements but --DATA is an object.
4126 ;; In any other case, map contents.
4130 ;; Return value in a proper order.
4134 ;; The following functions are internal parts of the parser.
4135 ;;
4136 ;; The first one, `org-element--parse-elements' acts at the element's
4137 ;; level.
4138 ;;
4139 ;; The second one, `org-element--parse-objects' applies on all objects
4140 ;; of a paragraph or a secondary string. It calls
4141 ;; `org-element--object-lex' to find the next object in the current
4142 ;; container.
4145 "Return next special mode according to TYPE, or nil.
4146 TYPE is a symbol representing the type of an element or object
4147 containing next element if PARENTP is non-nil, or before it
4148 otherwise. Modes can be either `first-section', `item',
4149 `node-property', `planning', `property-drawer', `section',
4150 `table-row' or nil."
4167 "Parse elements between BEG and END positions.
4169 MODE prioritizes some elements over the others. It can be set to
4170 `first-section', `section', `planning', `item', `node-property'
4171 or `table-row'.
4173 When value is `item', STRUCTURE will be used as the current list
4174 structure.
4176 GRANULARITY determines the depth of the recursion. See
4177 `org-element-parse-buffer' for more information.
4179 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4180 elements.
4182 Elements are accumulated into ACC."
4185 ;; Visible only: skip invisible parts at the beginning of the
4186 ;; element.
4189 ;; When parsing only headlines, skip any text before first one.
4192 ;; Main loop start.
4194 ;; Find current element's type and parse it accordingly to
4195 ;; its category.
4197 end granularity mode structure))
4201 ;; Visible only: skip invisible parts between siblings.
4204 ;; Fill ELEMENT contents by side-effect.
4206 ;; If element has no contents, don't modify it.
4208 ;; Greater element: parse it between `contents-begin' and
4209 ;; `contents-end'. Make sure GRANULARITY allows the
4210 ;; recursion, or ELEMENT is a headline, in which case going
4211 ;; inside is mandatory, in order to get sub-level headings.
4219 ;; Possibly switch to a special mode.
4223 granularity visible-only element))
4224 ;; ELEMENT has contents. Parse objects inside, if
4225 ;; GRANULARITY allows it.
4231 ;; Update mode.
4233 ;; Return result.
4234 acc))
4237 "Return next object in current buffer or nil.
4238 RESTRICTION is a list of object types, as symbols, that should be
4239 looked after. This function assumes that the buffer is narrowed
4240 to an appropriate container (e.g., a paragraph)."
4248 found)
4313 ;; This is probably a plain link.
4319 ;; Radio link.
4324 "Parse objects between BEG and END and return recursive structure.
4326 Objects are accumulated in ACC.
4328 RESTRICTION is a list of object successors which are allowed in
4329 the current object."
4337 ;; 1. Text before any object. Untabify it.
4342 acc
4346 ;; 2. Object...
4349 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4350 ;; a recursive type.
4358 ;; 3. Text after last object. Untabify it.
4362 acc
4366 ;; Result.
4367 acc)))
4370 \f
4371 ;;; Towards A Bijective Process
4372 ;;
4373 ;; The parse tree obtained with `org-element-parse-buffer' is really
4374 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4375 ;; interpreted and expanded into a string with canonical Org syntax.
4376 ;; Hence `org-element-interpret-data'.
4377 ;;
4378 ;; The function relies internally on
4379 ;; `org-element--interpret-affiliated-keywords'.
4381 ;;;###autoload
4383 "Interpret DATA as Org syntax.
4384 DATA is a parse tree, an element, an object or a secondary string
4385 to interpret. Return Org syntax as a string."
4389 ;; Find interpreter for current object or
4390 ;; element. If it doesn't exist (e.g. this is
4391 ;; a pseudo object or element), return contents,
4392 ;; if any.
4399 ;; Secondary string.
4403 ;; Full Org document.
4407 ;; Plain text: return it.
4409 ;; Element or object without contents.
4412 ;; Element or object with contents.
4415 interpret
4416 --data
4417 ;; Recursively interpret contents.
4422 --data
4423 ;; Fix indentation of elements containing
4424 ;; objects. We ignore `table-row'
4425 ;; elements as they are one line long
4426 ;; anyway.
4428 --data
4429 ;; When normalizing first paragraph of
4430 ;; an item or a footnote-definition,
4431 ;; ignore first line's indentation.
4439 ;; Build white spaces. If no `:post-blank' property
4440 ;; is specified, assume its value is 0.
4455 "Return ELEMENT's affiliated keywords as Org syntax.
4456 If there is no affiliated keyword, return the empty string."
4466 ": "
4469 value)
4477 ;; All attribute keywords can have multiple lines.
4483 ;; List all ELEMENT's properties matching an attribute line or an
4484 ;; affiliated keyword, but ignore translated keywords since they
4485 ;; cannot belong to the property list.
4492 org-element-keyword-translation-alist)))))
4493 collect prop)
4496 ;; Because interpretation of the parse tree must return the same
4497 ;; number of blank lines between elements and the same number of white
4498 ;; space after objects, some special care must be given to white
4499 ;; spaces.
4500 ;;
4501 ;; The first function, `org-element-normalize-string', ensures any
4502 ;; string different from the empty string will end with a single
4503 ;; newline character.
4504 ;;
4505 ;; The second function, `org-element-normalize-contents', removes
4506 ;; global indentation from the contents of the current element.
4509 "Ensure string S ends with a single newline character.
4511 If S isn't a string return it unchanged. If S is the empty
4512 string, return it. Otherwise, return a new string with a single
4513 newline character at its end."
4521 "Normalize plain text in ELEMENT's contents.
4523 ELEMENT must only contain plain text and objects.
4525 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4526 indentation to compute maximal common indentation.
4528 Return the normalized element that is element with global
4529 indentation removed from its contents. The function assumes that
4530 indentation is not done with TAB characters."
4532 ;; Return minimal common indentation within BLOB. This is
4533 ;; done by walking recursively BLOB and updating MIN-IND
4534 ;; along the way. FIRST-FLAG is non-nil when the next
4535 ;; object is expected to be a string that doesn't start
4536 ;; with a newline character. It happens for strings at
4537 ;; the beginnings of the contents or right after a line
4538 ;; break.
4544 ;; Objects cannot start with spaces: in this case,
4545 ;; indentation is 0.
4549 ;; An indentation of zero means no string will
4550 ;; be modified. Quit the process.
4562 org-element-recursive-objects)
4565 object first-flag min-ind))))))))
4569 ;; Build ELEMENT back, replacing each string with the same
4570 ;; string minus common indentation.
4573 ;; Return DATUM with all its strings indentation
4574 ;; shortened from MIN-IND white spaces.
4575 ;; FIRST-FLAG is non-nil when the next object is
4576 ;; expected to be a string that doesn't start with
4577 ;; a newline character.
4593 org-element-recursive-objects)
4597 object)
4600 datum)))
4604 \f
4605 ;;; Cache
4606 ;;
4607 ;; Implement a caching mechanism for `org-element-at-point' and
4608 ;; `org-element-context', which see.
4609 ;;
4610 ;; A single public function is provided: `org-element-cache-reset'.
4611 ;;
4612 ;; Cache is enabled by default, but can be disabled globally with
4613 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4614 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4615 ;; can be tweaked to control caching behaviour.
4616 ;;
4617 ;; Internally, parsed elements are stored in an AVL tree,
4618 ;; `org-element--cache'. This tree is updated lazily: whenever
4619 ;; a change happens to the buffer, a synchronization request is
4620 ;; registered in `org-element--cache-sync-requests' (see
4621 ;; `org-element--cache-submit-request'). During idle time, requests
4622 ;; are processed by `org-element--cache-sync'. Synchronization also
4623 ;; happens when an element is required from the cache. In this case,
4624 ;; the process stops as soon as the needed element is up-to-date.
4625 ;;
4626 ;; A synchronization request can only apply on a synchronized part of
4627 ;; the cache. Therefore, the cache is updated at least to the
4628 ;; location where the new request applies. Thus, requests are ordered
4629 ;; from left to right and all elements starting before the first
4630 ;; request are correct. This property is used by functions like
4631 ;; `org-element--cache-find' to retrieve elements in the part of the
4632 ;; cache that can be trusted.
4633 ;;
4634 ;; A request applies to every element, starting from its original
4635 ;; location (or key, see below). When a request is processed, it
4636 ;; moves forward and may collide the next one. In this case, both
4637 ;; requests are merged into a new one that starts from that element.
4638 ;; As a consequence, the whole synchronization complexity does not
4639 ;; depend on the number of pending requests, but on the number of
4640 ;; elements the very first request will be applied on.
4641 ;;
4642 ;; Elements cannot be accessed through their beginning position, which
4643 ;; may or may not be up-to-date. Instead, each element in the tree is
4644 ;; associated to a key, obtained with `org-element--cache-key'. This
4645 ;; mechanism is robust enough to preserve total order among elements
4646 ;; even when the tree is only partially synchronized.
4647 ;;
4648 ;; Objects contained in an element are stored in a hash table,
4649 ;; `org-element--cache-objects'.
4653 "Non nil when Org parser should cache its results.
4660 "Maximum duration, as a time value, for a cache synchronization.
4661 If the synchronization is not over after this delay, the process
4662 pauses and resumes after `org-element-cache-sync-break'
4666 "Duration, as a time value, of the pause between synchronizations.
4670 ;;;; Data Structure
4673 "AVL tree used to cache elements.
4674 Each node of the tree contains an element. Comparison is done
4675 with `org-element--cache-compare'. This cache is used in
4679 "Hash table used as to cache objects.
4680 Key is an element, as returned by `org-element-at-point', and
4681 value is an alist where each association is:
4683 \(PARENT COMPLETEP . OBJECTS)
4685 where PARENT is an element or object, COMPLETEP is a boolean,
4686 non-nil when all direct children of parent are already cached and
4687 OBJECTS is a list of such children, as objects, from farthest to
4688 closest.
4691 contained within a paragraph
4695 If the paragraph is completely parsed, OBJECTS-DATA will be
4697 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4698 \(BOLD-OBJECT t ENTITY-OBJECT))
4700 whereas in a partially parsed paragraph, it could be
4702 \((PARAGRAPH nil ENTITY-OBJECT))
4707 "List of pending synchronization requests.
4709 A request is a vector with the following pattern:
4711 \[NEXT BEG END OFFSET PARENT PHASE]
4713 Processing a synchronization request consists of three phases:
4715 0. Delete modified elements,
4716 1. Fill missing area in cache,
4717 2. Shift positions and re-parent elements after the changes.
4719 During phase 0, NEXT is the key of the first element to be
4720 removed, BEG and END is buffer position delimiting the
4721 modifications. Elements starting between them (inclusive) are
4722 removed. So are elements whose parent is removed. PARENT, when
4723 non-nil, is the parent of the first element to be removed.
4725 During phase 1, NEXT is the key of the next known element in
4726 cache and BEG its beginning position. Parse buffer between that
4727 element and the one before it in order to determine the parent of
4728 the next element. Set PARENT to the element containing NEXT.
4730 During phase 2, NEXT is the key of the next element to shift in
4731 the parse tree. All elements starting from this one have their
4732 properties relatives to buffer positions shifted by integer
4733 OFFSET and, if they belong to element PARENT, are adopted by it.
4741 "Hash table used to store keys during synchronization.
4745 "Return a unique key for ELEMENT in cache tree.
4747 Keys are used to keep a total order among elements in the cache.
4748 Comparison is done with `org-element--cache-key-less-p'.
4750 When no synchronization is taking place, a key is simply the
4751 beginning position of the element, or that position plus one in
4752 the case of an first item (respectively row) in
4753 a list (respectively a table).
4755 During a synchronization, the key is the one the element had when
4756 the cache was synchronized for the last time. Elements added to
4757 cache during the synchronization get a new key generated with
4758 `org-element--cache-generate-key'.
4760 Such keys are stored in `org-element--cache-sync-keys'. The hash
4761 table is cleared once the synchronization is complete."
4764 ;; Increase beginning position of items (respectively
4765 ;; table rows) by one, so the first item can get
4766 ;; a different key from its parent list (respectively
4767 ;; table).
4770 begin)))
4773 key))))
4776 "Generate a key between LOWER and UPPER.
4778 LOWER and UPPER are integers or lists, possibly empty.
4780 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4781 a unique key, as an integer or a list of integers, according to
4782 the following rules:
4784 - LOWER and UPPER are compared level-wise until values differ.
4786 - If, at a given level, LOWER and UPPER differ from more than
4787 2, the new key shares all the levels above with LOWER and
4788 gets a new level. Its value is the mean between LOWER and
4789 UPPER:
4791 \(1 2) + (1 4) --> (1 3)
4793 - If LOWER has no value to compare with, it is assumed that its
4794 value is `most-negative-fixnum'. E.g.,
4796 \(1 1) + (1 1 2)
4798 is equivalent to
4800 \(1 1 m) + (1 1 2)
4802 where m is `most-negative-fixnum'. Likewise, if UPPER is
4803 short of levels, the current value is `most-positive-fixnum'.
4805 - If they differ from only one, the new key inherits from
4806 current LOWER level and fork it at the next level. E.g.,
4808 \(2 1) + (3 3)
4810 is equivalent to
4812 \(2 1) + (2 M)
4814 where M is `most-positive-fixnum'.
4816 - If the key is only one level long, it is returned as an
4817 integer:
4819 \(1 2) + (3 2) --> 2
4821 When they are not equals, the function assumes that LOWER is
4822 lesser than UPPER, per `org-element--cache-key-less-p'."
4826 skip-upper key)
4837 ;; When at a given level, LOWER and UPPER differ from
4838 ;; 1, ignore UPPER altogether. Instead create a key
4839 ;; between LOWER and the greatest key with the same
4840 ;; prefix as LOWER so far.
4846 "Non-nil if key A is less than key B.
4847 A and B are either integers or lists of integers, as returned by
4848 `org-element--cache-key'."
4856 ;; If A is empty, either keys are equal (B is also empty) and
4857 ;; we return nil, or A is lesser than B (B is longer) and we
4858 ;; return a non-nil value.
4859 ;;
4860 ;; If A is not empty, B is necessarily empty and A is greater
4861 ;; than B (A is longer). Therefore, return nil.
4865 "Non-nil when element A is located before element B."
4870 "Return root value in cache.
4871 This function assumes `org-element--cache' is a valid AVL tree."
4875 ;;;; Tools
4878 "Non-nil when cache is active in current buffer."
4880 org-element--cache
4884 "Find element in cache starting at POS or before.
4886 POS refers to a buffer position.
4888 When optional argument SIDE is non-nil, the function checks for
4889 elements starting at or past POS instead. If SIDE is `both', the
4890 function returns a cons cell where car is the first element
4891 starting at or before POS and cdr the first element starting
4892 after POS.
4894 The function can only find elements in the synchronized part of
4895 the cache."
4899 lower upper)
4914 ;; We found an element in cache starting at POS. If `side'
4915 ;; is `both' we also want the next one in order to generate
4916 ;; a key in-between.
4917 ;;
4918 ;; If the element is the first row or item in a table or
4919 ;; a plain list, we always return the table or the plain
4920 ;; list.
4921 ;;
4922 ;; In any other case, we return the element found.
4931 lower parent
4932 upper parent)))))
4935 lower element
4936 upper element)))))
4943 "Store ELEMENT in current buffer's cache, if allowed.
4944 When optional argument DATA is non-nil, assume is it object data
4945 relative to ELEMENT and store it in the objects cache."
4949 ;; During synchronization, first build an appropriate key
4950 ;; for the new element so `avl-tree-enter' can insert it at
4951 ;; the right spot in the cache.
4960 org-element--cache-sync-keys)))
4962 ;; Headlines are not stored in cache, so objects in titles are
4963 ;; not stored either.
4968 "Remove ELEMENT from cache.
4969 Assume ELEMENT belongs to cache and that a cache is active."
4974 ;;;; Synchronization
4977 "Set idle timer for cache synchronization in BUFFER."
4984 org-element-cache-sync-idle-time))
4985 nil
4986 #'org-element--cache-sync
4987 buffer)))
4990 "Non-nil when synchronization process should be interrupted.
4991 TIME-LIMIT is a time value or nil."
4997 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4999 Properties containing buffer positions are `:begin', `:end',
5000 `:contents-begin', `:contents-end' and `:structure'. When
5001 optional argument PROPS is a list of keywords, only shift
5002 properties provided in that list.
5004 Properties are modified by side-effect."
5006 ;; Shift `:structure' property for the first plain list only: it
5007 ;; is the only one that really matters and it prevents from
5008 ;; shifting it more than once.
5022 "Synchronize cache with recent modification in BUFFER.
5024 When optional argument THRESHOLD is non-nil, do the
5025 synchronization for all elements starting before or at threshold,
5026 then exit. Otherwise, synchronize cache for as long as
5027 `org-element-cache-sync-duration' or until Emacs leaves idle
5028 state.
5030 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5031 not registered yet in the cache are going to happen. It is used
5032 in `org-element--cache-submit-request', where cache is partially
5033 updated before current modification are actually submitted."
5044 request
5046 threshold
5049 org-element-cache-sync-duration))
5050 future-change)
5051 ;; Request processed. Merge current and next offsets and
5052 ;; transfer ending position.
5058 ;; If more requests are awaiting, set idle timer accordingly.
5059 ;; Otherwise, reset keys.
5066 "Process synchronization REQUEST for all entries before NEXT.
5068 REQUEST is a vector, built by `org-element--cache-submit-request'.
5070 NEXT is a cache key, as returned by `org-element--cache-key'.
5072 When non-nil, THRESHOLD is a buffer position. Synchronization
5073 stops as soon as a shifted element begins after it.
5075 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5076 after this time or when Emacs exits idle state.
5078 When non-nil, FUTURE-CHANGE is a buffer position where changes
5079 not registered yet in the cache are going to happen. See
5080 `org-element--cache-submit-request' for more information.
5082 Throw `interrupt' if the process stops before completing the
5083 request."
5086 ;; Phase 0.
5087 ;;
5088 ;; Delete all elements starting after BEG, but not after buffer
5089 ;; position END or past element with key NEXT. Also delete
5090 ;; elements contained within a previously removed element
5091 ;; (stored in `last-container').
5092 ;;
5093 ;; At each iteration, we start again at tree root since
5094 ;; a deletion modifies structure of the balanced tree.
5099 ;; Find first element in cache with key BEG or after it.
5103 data data-key last-container)
5112 data-key key
5115 data-key key
5116 node nil)))))
5126 up)))
5129 end))
5136 ;; No element starting after modifications left in
5137 ;; cache: further processing is futile.
5140 ;; Phase 1.
5141 ;;
5142 ;; Phase 0 left a hole in the cache. Some elements after it
5143 ;; could have parents within. For example, in the following
5144 ;; buffer:
5145 ;;
5146 ;; - item
5147 ;;
5148 ;;
5149 ;; Paragraph1
5150 ;;
5151 ;; Paragraph2
5152 ;;
5153 ;; if we remove a blank line between "item" and "Paragraph1",
5154 ;; everything down to "Paragraph2" is removed from cache. But
5155 ;; the paragraph now belongs to the list, and its `:parent'
5156 ;; property no longer is accurate.
5157 ;;
5158 ;; Therefore we need to parse again elements in the hole, or at
5159 ;; least in its last section, so that we can re-parent
5160 ;; subsequent elements, during phase 2.
5161 ;;
5162 ;; Note that we only need to get the parent from the first
5163 ;; element in cache after the hole.
5164 ;;
5165 ;; When next key is lesser or equal to the current one, delegate
5166 ;; phase 1 processing to next request in order to preserve key
5167 ;; order among requests.
5175 ;; Next element will start at its beginning position plus
5176 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5177 ;; contains the real beginning position of the first element to
5178 ;; shift and re-parent.
5182 ;; Changes are going to happen around this element and
5183 ;; they will trigger another phase 1 request. Skip the
5184 ;; current one.
5190 ;; Phase 2.
5191 ;;
5192 ;; Shift all elements starting from key START, but before NEXT, by
5193 ;; OFFSET, and re-parent them when appropriate.
5194 ;;
5195 ;; Elements are modified by side-effect so the tree structure
5196 ;; remains intact.
5197 ;;
5198 ;; Once THRESHOLD, if any, is reached, or once there is an input
5199 ;; pending, exit. Before leaving, the current synchronization
5200 ;; request is updated.
5207 exit-flag)
5208 ;; No re-parenting nor shifting planned: request is over.
5218 ;; We reached NEXT. Request is complete.
5220 ;; Handle interruption request. Update current request.
5225 ;; Shift element.
5228 ;; Shift associated objects data, if any.
5233 ;; Update PARENT and re-parent DATA, only when
5234 ;; necessary. Propagate new structures for lists.
5248 ;; Cache is up-to-date past THRESHOLD. Request
5249 ;; interruption.
5254 ;; We reached end of tree: synchronization complete.
5255 t)))
5258 "Parse elements in current section, down to POS.
5260 Start parsing from the closest between the last known element in
5261 cache or headline above. Return the smallest element containing
5262 POS.
5264 When optional argument SYNCP is non-nil, return the parent of the
5265 element containing POS instead. In that case, it is also
5266 possible to provide TIME-LIMIT, which is a time value specifying
5267 when the parsing should stop. The function throws `interrupt' if
5268 the process stopped before finding the expected result."
5275 element next mode)
5277 ;; Nothing in cache before point: start parsing from first
5278 ;; element following headline above, or first element in
5279 ;; buffer.
5286 ;; Cache returned exact match: return it.
5289 ;; There's a headline between cached value and POS: cached
5290 ;; value is invalid. Start parsing from first element
5291 ;; following the headline.
5298 ;; Check if CACHED or any of its ancestors contain point.
5299 ;;
5300 ;; If there is such an element, we inspect it in order to know
5301 ;; if we return it or if we need to parse its contents.
5302 ;; Otherwise, we just start parsing from current location,
5303 ;; which is right after the top-most element containing
5304 ;; CACHED.
5305 ;;
5306 ;; As a special case, if POS is at the end of the buffer, we
5307 ;; want to return the innermost element ending there.
5308 ;;
5309 ;; Also, if we find an ancestor and discover that we need to
5310 ;; parse its contents, make sure we don't start from
5311 ;; `:contents-begin', as we would otherwise go past CACHED
5312 ;; again. Instead, in that situation, we will resume parsing
5313 ;; from NEXT, which is located after CACHED or its higher
5314 ;; ancestor not containing point.
5326 ;; Parse successively each element until we reach POS.
5339 end 'element mode
5346 ;; Skip any element ending before point. Also skip
5347 ;; element ending at point (unless it is also the end of
5348 ;; buffer) since we're sure that another element begins
5349 ;; after it.
5353 ;; A non-greater element contains point: return it.
5356 ;; Otherwise, we have to decide if ELEMENT really
5357 ;; contains POS. In that case we start parsing from
5358 ;; contents' beginning.
5359 ;;
5360 ;; If POS is at contents' beginning but it is also at
5361 ;; the beginning of the first item in a list or a table.
5362 ;; In that case, we need to create an anchor for that
5363 ;; list or table, so return it.
5364 ;;
5365 ;; Also, if POS is at the end of the buffer, no element
5366 ;; can start after it, but more than one may end there.
5367 ;; Arbitrarily, we choose to return the innermost of
5368 ;; such elements.
5381 parent element
5382 end cend))))
5383 ;; Otherwise, return ELEMENT as it is the smallest
5384 ;; element containing POS.
5389 ;;;; Staging Buffer Changes
5400 "Regexp matching a sensitive line, structure wise.
5401 A sensitive line is a headline, inlinetask, block, drawer, or
5402 latex-environment boundary. When such a line is modified,
5403 structure changes in the document may propagate in the whole
5407 "Non-nil when a sensitive line is about to be changed.
5411 "Request extension of area going to be modified if needed.
5412 BEG and END are the beginning and end of the range of changed
5413 text. See `before-change-functions' for more information."
5423 'headline
5426 org-element--cache-sensitive-re bottom t)))))))))
5429 "Update buffer modifications for current buffer.
5430 BEG and END are the beginning and end of the range of changed
5431 text, and the length in bytes of the pre-change text replaced by
5432 that range. See `after-change-functions' for more information."
5440 ;; Determine if modified area needs to be extended, according
5441 ;; to both previous and current state. We make a special
5442 ;; case for headline editing: if a headline is modified but
5443 ;; not removed, do not extend.
5446 (`headline
5452 org-element--cache-sensitive-re bottom t))))
5453 ;; Effectively extend modified area.
5461 ;; Store synchronization request.
5464 ;; Activate a timer to process the request during idle time.
5468 "Return first element to remove from cache.
5470 BEG and END are buffer positions delimiting buffer modifications.
5471 OFFSET is the size of the changes.
5473 Returned element is usually the first element in cache containing
5474 any position between BEG and END. As an exception, greater
5475 elements around the changes that are robust to contents
5476 modifications are preserved and updated according to the
5477 changes."
5487 special-block))
5488 ;; Drawers named "PROPERTIES" are probably
5489 ;; a properties drawer being edited. Force
5490 ;; parsing to check if editing is over.
5499 ;; UP is a robust greater element containing changes.
5500 ;; We only need to extend its ending boundaries.
5506 ;; We're at top level element containing ELEMENT: if it's
5507 ;; altered by buffer modifications, it is first element in
5508 ;; cache to be removed. Otherwise, that first element is the
5509 ;; following one.
5510 ;;
5511 ;; As a special case, do not remove BEFORE if it is a robust
5512 ;; container for current changes.
5514 before)))))
5517 "Submit a new cache synchronization request for current buffer.
5518 BEG and END are buffer positions delimiting the minimal area
5519 where cache data should be removed. OFFSET is the size of the
5520 change, as an integer."
5522 delete-to delete-from)
5527 ;; Current changes can be merged with first sync request: we
5528 ;; can save a partial cache synchronization.
5531 ;; If last change happened within area to be removed, extend
5532 ;; boundaries of robust parents, if any. Otherwise, find
5533 ;; first element to remove and update request accordingly.
5545 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5546 ;; if any, is no longer a 0-phase request, thus ensuring that
5547 ;; phases are properly ordered. We need to provide OFFSET as
5548 ;; optional parameter since current modifications are not known
5549 ;; yet to the otherwise correct part of the cache (i.e, before
5550 ;; the first request).
5557 ;; When changes happen before the first known
5558 ;; element, re-parent and shift the rest of the
5559 ;; cache.
5561 ;; Otherwise, we find the first non robust
5562 ;; element containing END. All elements between
5563 ;; FIRST and this one are to be removed.
5574 element up))
5576 org-element--cache-sync-requests)
5577 ;; No element to remove. No need to re-parent either.
5578 ;; Simply shift additional elements, if any, by OFFSET.
5583 ;;;; Public Functions
5585 ;;;###autoload
5587 "Reset cache in current buffer.
5588 When optional argument ALL is non-nil, reset cache in all Org
5589 buffers."
5608 ;;;###autoload
5610 "Refresh cache at position POS."
5617 \f
5618 ;;; The Toolbox
5619 ;;
5620 ;; The first move is to implement a way to obtain the smallest element
5621 ;; containing point. This is the job of `org-element-at-point'. It
5622 ;; basically jumps back to the beginning of section containing point
5623 ;; and proceed, one element after the other, with
5624 ;; `org-element--current-element' until the container is found. Note:
5625 ;; When using `org-element-at-point', secondary values are never
5626 ;; parsed since the function focuses on elements, not on objects.
5627 ;;
5628 ;; At a deeper level, `org-element-context' lists all elements and
5629 ;; objects containing point.
5630 ;;
5631 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5632 ;; internally by navigation and manipulation tools.
5635 ;;;###autoload
5637 "Determine closest element around point.
5639 Return value is a list like (TYPE PROPS) where TYPE is the type
5640 of the element and PROPS a plist of properties associated to the
5641 element.
5643 Possible types are defined in `org-element-all-elements'.
5644 Properties depend on element or object type, but always include
5645 `:begin', `:end', `:parent' and `:post-blank' properties.
5647 As a special case, if point is at the very beginning of the first
5648 item in a list or sub-list, returned element will be that list
5649 instead of the item. Likewise, if point is at the beginning of
5650 the first row of a table, returned element will be the table
5651 instead of the first row.
5653 When point is at the end of the buffer, return the innermost
5654 element ending there."
5660 ;; Within blank lines at the beginning of buffer, return nil.
5662 ;; Within blank lines right after a headline, return that
5663 ;; headline.
5667 ;; Otherwise parse until we find element containing ORIGIN.
5674 ;;;###autoload
5676 "Return smallest element or object around point.
5678 Return value is a list like (TYPE PROPS) where TYPE is the type
5679 of the element or object and PROPS a plist of properties
5680 associated to it.
5682 Possible types are defined in `org-element-all-elements' and
5683 `org-element-all-objects'. Properties depend on element or
5684 object type, but always include `:begin', `:end', `:parent' and
5685 `:post-blank'.
5687 As a special case, if point is right after an object and not at
5688 the beginning of any other object, return that object.
5690 Optional argument ELEMENT, when non-nil, is the closest element
5691 containing point, as returned by `org-element-at-point'.
5692 Providing it allows for quicker computation."
5698 ;; If point is inside an element containing objects or
5699 ;; a secondary string, narrow buffer to the container and
5700 ;; proceed with parsing. Otherwise, return ELEMENT.
5702 ;; At a parsed affiliated keyword, check if we're inside main
5703 ;; or dual value.
5710 org-element-parsed-keywords))
5719 ;; Also change type to retrieve correct restrictions.
5721 ;; At an item, objects can only be located within tag, if any.
5731 ;; At an headline or inlinetask, objects are in title.
5738 ;; At a paragraph, a table-row or a verse block, objects are
5739 ;; located within their contents.
5743 ;; CBEG is nil for table rules.
5748 ;; At a planning line, if point is at a timestamp, return it,
5749 ;; otherwise, return element.
5757 ;; All other locations cannot contain objects: bail out.
5767 next object-data last)
5771 ;; When entering PARENT for the first time, get list
5772 ;; of objects within known so far. Store it in
5773 ;; OBJECT-DATA.
5778 ;; Find NEXT object for analysis.
5780 ;; If NEXT is non-nil, we already exhausted the
5781 ;; cache so we can parse buffer to find the object
5782 ;; after it.
5784 ;; Otherwise, check if cache can help us.
5795 ;; Cache contains the information needed.
5798 pos)
5800 pos)
5806 ;; If we have a new object to analyze, store it in
5807 ;; cache. Otherwise record that there is nothing
5808 ;; more to parse in this element at this depth.
5813 ;; Process NEXT, if any, in order to know if we need
5814 ;; to skip it, return it or move into it.
5821 ;; Skip objects ending before point. Also skip
5822 ;; objects ending at point unless it is also the
5823 ;; end of buffer, since we want to return the
5824 ;; innermost object.
5827 ;; For convenience, when object ends at POS,
5828 ;; without any space, store it in LAST, as we
5829 ;; will return it if no object starts here.
5833 ;; If POS is within a container object, move
5834 ;; into that object.
5838 ;; At contents' end, if there is no
5839 ;; space before point, also move into
5840 ;; object, for consistency with
5841 ;; convenience feature above.
5850 next nil
5851 object-data nil))
5852 ;; Otherwise, return NEXT.
5854 ;; Store results in cache, if applicable.
5858 "List all ancestors of a given element or object.
5860 BLOB is an object or element.
5862 When optional argument TYPES is a list of symbols, return the
5863 first element or object in the lineage whose type belongs to that
5864 list.
5866 When optional argument WITH-SELF is non-nil, lineage includes
5867 BLOB itself as the first element, and TYPES, if provided, also
5868 apply to it.
5870 When BLOB is obtained through `org-element-context' or
5871 `org-element-at-point', only ancestors from its section can be
5872 found. There is no such limitation when BLOB belongs to a full
5873 parse tree."
5875 ancestors)
5882 "Non-nil when elements ELEM-A and ELEM-B are nested."
5891 "Swap elements ELEM-A and ELEM-B.
5892 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5893 end of ELEM-A."
5895 ;; There are two special cases when an element doesn't start at bol:
5896 ;; the first paragraph in an item or in a footnote definition.
5898 ;; Only a paragraph without any affiliated keyword can be moved at
5899 ;; ELEM-A position in such a situation. Note that the case of
5900 ;; a footnote definition is impossible: it cannot contain two
5901 ;; paragraphs in a row because it cannot contain a blank line.
5907 ;; In a special situation, ELEM-A will have no indentation. We'll
5908 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5922 ;; Store inner overlays responsible for visibility status.
5923 ;; We also need to store their boundaries as they will be
5924 ;; removed from buffer.
5939 ;; Get contents.
5947 ;; Restore ex ELEM-A overlays.
5954 ;; Restore ex ELEM-B overlays.
5959 ;; For backward-compatibility with Org <= 8.3
5966 ;; Local variables:
5967 ;; generated-autoload-file: "org-loaddefs.el"
5968 ;; End:
5970 ;;; org-element.el ends here