| blob | 847e7989d9bf610aff9ee4e58020838d3a942d13 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; See <http://orgmode.org/worg/dev/org-syntax.html> for details about
26 ;; Org syntax.
27 ;;
28 ;; Lisp-wise, a syntax object can be represented as a list.
29 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
30 ;; TYPE is a symbol describing the object.
31 ;; PROPERTIES is the property list attached to it. See docstring of
32 ;; appropriate parsing function to get an exhaustive list.
33 ;; CONTENTS is a list of syntax objects or raw strings contained
34 ;; in the current object, when applicable.
35 ;;
36 ;; For the whole document, TYPE is `org-data' and PROPERTIES is nil.
37 ;;
38 ;; The first part of this file defines constants for the Org syntax,
39 ;; while the second one provide accessors and setters functions.
40 ;;
41 ;; The next part implements a parser and an interpreter for each
42 ;; element and object type in Org syntax.
43 ;;
44 ;; The following part creates a fully recursive buffer parser. It
45 ;; also provides a tool to map a function to elements or objects
46 ;; matching some criteria in the parse tree. Functions of interest
47 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
48 ;; extent, `org-element-parse-secondary-string'.
49 ;;
50 ;; The penultimate part is the cradle of an interpreter for the
51 ;; obtained parse tree: `org-element-interpret-data'.
52 ;;
53 ;; The library ends by furnishing `org-element-at-point' function, and
54 ;; a way to give information about document structure around point
55 ;; with `org-element-context'. A cache mechanism is also provided for
56 ;; these functions.
59 ;;; Code:
66 \f
67 ;;; Definitions And Rules
68 ;;
69 ;; Define elements, greater elements and specify recursive objects,
70 ;; along with the affiliated keywords recognized. Also set up
71 ;; restrictions on recursive objects combinations.
72 ;;
73 ;; `org-element-update-syntax' builds proper syntax regexps according
74 ;; to current setup.
77 "Regexp to separate paragraphs in an Org buffer.
79 is not sufficient to know if point is at a paragraph ending. See
83 "Regexp possibly matching the beginning of an object.
84 This regexp allows false positives. Dedicated parser (e.g.,
85 `org-export-bold-parser') will take care of further filtering.
86 Radio links are not matched by this regexp, as they are treated
90 "Build variable syntax regexps."
93 ;; Headlines, inlinetasks.
95 ;; Footnote definitions.
97 ;; Diary sexps.
100 ;; Empty lines.
102 ;; Tables (any type).
105 ;; Comments, keyword-like or block-like constructs.
106 ;; Blocks and keywords with dual values need to be
107 ;; double-checked.
112 ;; Drawers (any type) and fixed-width areas. Drawers
113 ;; need to be double-checked.
115 ;; Horizontal rules.
117 ;; LaTeX environments.
119 ;; Clock lines.
121 ;; Lists.
128 org-element--object-regexp
132 ;; Sub/superscript.
134 ;; Bold, code, italic, strike-through, underline
135 ;; and verbatim.
139 ;; Plain links.
141 ;; Objects starting with "[": regular link,
142 ;; footnote reference, statistics cookie,
143 ;; timestamp (inactive).
150 ;; Objects starting with "@": export snippets.
151 "@@"
152 ;; Objects starting with "{": macro.
153 "{{{"
154 ;; Objects starting with "<" : timestamp
155 ;; (active, diary), target, radio target and
156 ;; angular links.
158 ;; Objects starting with "$": latex fragment.
160 ;; Objects starting with "\": line break,
161 ;; entity, latex fragment.
163 ;; Objects starting with raw text: inline Babel
164 ;; source block, inline Babel call.
170 ;;;###autoload
172 "Update parser internals."
179 dynamic-block example-block export-block fixed-width
180 footnote-definition headline horizontal-rule inlinetask item
181 keyword latex-environment node-property paragraph plain-list
182 planning property-drawer quote-block section
183 special-block src-block table table-row verse-block)
188 item plain-list property-drawer quote-block section
189 special-block table)
194 inline-src-block italic line-break latex-fragment link macro
195 radio-target statistics-cookie strike-through subscript superscript
196 table-cell target timestamp underline verbatim)
201 superscript table-cell underline)
211 "List of affiliated keywords as strings.
219 "Alist of usual translations for keywords.
220 The key is the old name and the value the new one. The property
224 "List of affiliated keywords that can occur more than once in an element.
226 Their value will be consed into a list of strings, which will be
227 returned as the value of the property.
229 This list is checked after translations have been applied. See
230 `org-element-keyword-translation-alist'.
236 "List of affiliated keywords whose value can be parsed.
238 Their value will be stored as a secondary string: a list of
239 strings and objects.
241 This list is checked after translations have been applied. See
246 org-element-parsed-keywords)
247 "Alist of parsed keywords and associated properties.
248 This is generated from `org-element-parsed-keywords', which
252 "List of affiliated keywords which can have a secondary value.
254 In Org syntax, they can be written with optional square brackets
255 before the colons. For example, RESULTS keyword can be
256 associated to a hash value with the following:
258 #+RESULTS[hash-string]: some-source
260 This list is checked after translations have been applied. See
266 ;; Dual affiliated keywords.
270 ;; Regular affiliated keywords.
275 org-element-affiliated-keywords)))
277 ;; Export attributes.
279 "Regexp matching any affiliated keyword.
281 Keyword name is put in match group 1. Moreover, if keyword
282 belongs to `org-element-dual-keywords', put the dual value in
283 match group 2.
297 ;; Ignore all links excepted plain links and angular links in
298 ;; a link description. Also ignore radio-targets and line
299 ;; breaks.
301 italic latex-fragment macro simple-link statistics-cookie
302 strike-through subscript superscript underline verbatim)
304 ;; Remove any variable object from radio target as it would
305 ;; prevent it from being properly recognized.
307 subscript superscript underline superscript)
311 ;; Ignore inline babel call and inline src block as formulas are
312 ;; possible. Also ignore line breaks and statistics cookies.
314 latex-fragment link macro radio-target strike-through
315 subscript superscript target timestamp underline verbatim)
319 "Alist of objects restrictions.
321 key is an element or object type containing objects and value is
322 a list of types that can be contained within an element or object
323 of such type.
325 For example, in a `radio-target' object, one can only find
326 entities, latex-fragments, subscript, superscript and text
327 markup.
329 This alist also applies to secondary string. For example, an
330 `headline' type element doesn't directly contain objects, but
345 "Table used internally to pair only round brackets.
354 "Table used internally to pair only square brackets.
363 "Table used internally to pair only curly brackets.
367 "Parse paired brackets at point.
368 CHAR is the opening bracket to consider, as a character. Return
369 contents between brackets, as a string, or nil. Also move point
370 past the brackets."
385 \f
386 ;;; Accessors and Setters
387 ;;
388 ;; Provide four accessors: `org-element-type', `org-element-property'
389 ;; `org-element-contents' and `org-element-restriction'.
390 ;;
391 ;; Setter functions allow modification of elements by side effect.
392 ;; There is `org-element-put-property', `org-element-set-contents'.
393 ;; These low-level functions are useful to build a parse tree.
394 ;;
395 ;; `org-element-adopt-elements', `org-element-set-element',
396 ;; `org-element-extract-element' and `org-element-insert-before' are
397 ;; high-level functions useful to modify a parse tree.
398 ;;
399 ;; `org-element-secondary-p' is a predicate used to know if a given
400 ;; object belongs to a secondary string. `org-element-class' tells if
401 ;; some parsed data is an element or an object, handling pseudo
402 ;; elements and objects. `org-element-copy' returns an element or
403 ;; object, stripping its parent property in the process.
406 "Return type of ELEMENT.
408 The function returns the type of the element or object provided.
409 It can also return the following special value:
410 `plain-text' for a string
411 `org-data' for a complete document
412 nil in any other case."
418 "Extract the value from the PROPERTY of an ELEMENT."
423 "Extract contents from an ELEMENT."
429 "Return restriction associated to ELEMENT.
430 ELEMENT can be an element, an object or a symbol representing an
431 element or object type."
433 org-element-object-restrictions)))
436 "In ELEMENT set PROPERTY to VALUE.
437 Return modified element."
440 element))
443 "Set ELEMENT's contents to CONTENTS.
444 Return ELEMENT."
451 "Non-nil when OBJECT directly belongs to a secondary string.
452 Return value is the property name, as a keyword, or nil."
455 org-element-secondary-value-alist))))
462 "Return class for ELEMENT, as a symbol.
463 Class is either `element' or `object'. Optional argument PARENT
464 is the element or object containing DATUM. It defaults to the
465 value of DATUM `:parent' property."
469 ;; Trivial cases.
472 ;; Special cases.
476 ;; Pseudo object or elements. Make a guess about its class.
477 ;; Basically a pseudo object is contained within another object,
478 ;; a secondary string or a container element.
488 "Append elements to the contents of another element.
490 PARENT is an element or object. CHILDREN can be elements,
491 objects, or a strings.
493 The function takes care of setting `:parent' property for CHILD.
494 Return parent element."
496 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
497 ;; string: parent is the list itself.
500 ;; Add CHILDREN at the end of PARENT contents.
503 parent
505 ;; Return modified PARENT element.
509 "Extract ELEMENT from parse tree.
510 Remove element from the parse tree by side-effect, and return it
511 with its `:parent' property stripped out."
516 parent secondary
519 parent
521 ;; Return ELEMENT with its :parent removed.
525 "Insert ELEMENT before LOCATION in parse tree.
526 LOCATION is an element, object or string within the parse tree.
527 Parse tree is modified by side effect."
532 ;; Special case: LOCATION is the first element of an
533 ;; independent secondary string (e.g. :title property). Add
534 ;; ELEMENT in-place.
538 ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
547 ;; Store SIBLINGS at appropriate place in parse tree.
552 ;; Set appropriate :parent property.
556 "Replace element or object OLD with element or object NEW.
557 The function takes care of setting `:parent' property for NEW."
558 ;; Ensure OLD and NEW have the same parent.
562 ;; We cannot replace OLD with NEW since one of them is not an
563 ;; object or element. We take the long path.
566 ;; Since OLD is going to be changed into NEW by side-effect, first
567 ;; make sure that every element or object within NEW has OLD as
568 ;; parent.
571 ;; Transfer contents.
573 ;; Overwrite OLD's properties with NEW's.
575 ;; Transfer type.
579 "Create a new element of type TYPE.
580 Optional argument PROPS, when non-nil, is a plist defining the
581 properties of the element. CHILDREN can be elements, objects or
582 strings."
586 "Return a copy of DATUM.
587 DATUM is an element, object, string or nil. `:parent' property
588 is cleared and contents are removed in the process."
599 \f
600 ;;; Greater elements
601 ;;
602 ;; For each greater element type, we define a parser and an
603 ;; interpreter.
604 ;;
605 ;; A parser returns the element or object as the list described above.
606 ;; Most of them accepts no argument. Though, exceptions exist. Hence
607 ;; every element containing a secondary string (see
608 ;; `org-element-secondary-value-alist') will accept an optional
609 ;; argument to toggle parsing of these secondary strings. Moreover,
610 ;; `item' parser requires current list's structure as its first
611 ;; element.
612 ;;
613 ;; An interpreter accepts two arguments: the list representation of
614 ;; the element or object, and its contents. The latter may be nil,
615 ;; depending on the element or object considered. It returns the
616 ;; appropriate Org syntax, as a string.
617 ;;
618 ;; Parsing functions must follow the naming convention:
619 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
620 ;; defined in `org-element-greater-elements'.
621 ;;
622 ;; Similarly, interpreting functions must follow the naming
623 ;; convention: org-element-TYPE-interpreter.
624 ;;
625 ;; With the exception of `headline' and `item' types, greater elements
626 ;; cannot contain other greater elements of their own type.
627 ;;
628 ;; Beside implementing a parser and an interpreter, adding a new
629 ;; greater element requires tweaking `org-element--current-element'.
630 ;; Moreover, the newly defined type must be added to both
631 ;; `org-element-all-elements' and `org-element-greater-elements'.
634 ;;;; Center Block
637 "Parse a center block.
639 LIMIT bounds the search. AFFILIATED is a list of which CAR is
640 the buffer position at the beginning of the first affiliated
641 keyword and CDR is a plist of affiliated keywords along with
642 their value.
644 Return a list whose CAR is `center-block' and CDR is a plist
645 containing `:begin', `:end', `:contents-begin', `:contents-end',
646 `:post-blank' and `:post-affiliated' keywords.
648 Assume point is at the beginning of the block."
652 ;; Incomplete block: parse it as a paragraph.
657 ;; Empty blocks have no contents.
671 :end end
672 :contents-begin contents-begin
673 :contents-end contents-end
679 "Interpret a center-block element as Org syntax.
680 CONTENTS is the contents of the element."
684 ;;;; Drawer
687 "Parse a drawer.
689 LIMIT bounds the search. AFFILIATED is a list of which CAR is
690 the buffer position at the beginning of the first affiliated
691 keyword and CDR is a plist of affiliated keywords along with
692 their value.
694 Return a list whose CAR is `drawer' and CDR is a plist containing
695 `:drawer-name', `:begin', `:end', `:contents-begin',
696 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
698 Assume point is at beginning of drawer."
701 ;; Incomplete drawer: parse it as a paragraph.
709 ;; Empty drawers have no contents.
722 :end end
723 :drawer-name name
724 :contents-begin contents-begin
725 :contents-end contents-end
731 "Interpret DRAWER element as Org syntax.
732 CONTENTS is the contents of the element."
735 contents))
738 ;;;; Dynamic Block
741 "Parse a dynamic block.
743 LIMIT bounds the search. AFFILIATED is a list of which CAR is
744 the buffer position at the beginning of the first affiliated
745 keyword and CDR is a plist of affiliated keywords along with
746 their value.
748 Return a list whose CAR is `dynamic-block' and CDR is a plist
749 containing `:block-name', `:begin', `:end', `:contents-begin',
750 `:contents-end', `:arguments', `:post-blank' and
751 `:post-affiliated' keywords.
753 Assume point is at beginning of dynamic block."
757 ;; Incomplete block: parse it as a paragraph.
766 ;; Empty blocks have no contents.
779 :end end
780 :block-name name
781 :arguments arguments
782 :contents-begin contents-begin
783 :contents-end contents-end
789 "Interpret DYNAMIC-BLOCK element as Org syntax.
790 CONTENTS is the contents of the element."
795 contents))
798 ;;;; Footnote Definition
807 "Parse a footnote definition.
809 LIMIT bounds the search. AFFILIATED is a list of which CAR is
810 the buffer position at the beginning of the first affiliated
811 keyword and CDR is a plist of affiliated keywords along with
812 their value.
814 Return a list whose CAR is `footnote-definition' and CDR is
815 a plist containing `:label', `:begin' `:end', `:contents-begin',
816 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
818 Assume point is at the beginning of the footnote definition."
830 limit)
832 ;; At a new footnote definition, make sure we end
833 ;; before any affiliated keyword above.
855 :begin begin
856 :end end
857 :contents-begin contents-begin
864 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
865 CONTENTS is the contents of the footnote-definition."
867 " "
868 contents))
871 ;;;; Headline
874 "Return node properties associated to headline at point.
875 Upcase property names. It avoids confusion between properties
876 obtained through property drawer and default properties from the
877 parser (e.g. `:end' and :END:). Return value is a plist."
889 properties))))
892 "Return time properties associated to headline at point.
893 Return value is a plist."
907 plist))))
910 "Parse a headline.
912 Return a list whose CAR is `headline' and CDR is a plist
913 containing `:raw-value', `:title', `:begin', `:end',
914 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
915 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
916 `:deadline', `:closed', `:archivedp', `:commentedp'
917 `:footnote-section-p', `:post-blank' and `:post-affiliated'
918 keywords.
920 The plist also contains any property set in the property drawer,
921 with its name in upper cases and colons added at the
922 beginning (e.g., `:CUSTOM_ID').
924 LIMIT is a buffer position bounding the search.
926 When RAW-SECONDARY-P is non-nil, headline's title will not be
927 parsed as a secondary string, but as a plain string instead.
929 Assume point is at beginning of the headline."
975 :begin begin
976 :end end
977 :pre-blank
980 :contents-begin contents-begin
981 :contents-end contents-end
982 :level level
983 :priority priority
984 :tags tags
985 :todo-keyword todo
986 :todo-type todo-type
987 :post-blank
991 :footnote-section-p footnote-section-p
992 :archivedp archivedp
993 :commentedp commentedp
995 time-props
996 standard-props))))
998 headline :title
1007 nil
1009 headline)))))))
1012 "Interpret HEADLINE element as Org syntax.
1013 CONTENTS is the contents of the element."
1026 ?*)
1030 " "
1033 org-footnote-section
1034 title))))
1036 heading
1037 ;; Align tags.
1045 ?\s)
1046 tags))
1050 tags))))
1052 contents)))
1055 ;;;; Inlinetask
1058 "Parse an inline task.
1060 Return a list whose CAR is `inlinetask' and CDR is a plist
1061 containing `:title', `:begin', `:end', `:pre-blank',
1062 `:contents-begin' and `:contents-end', `:level', `:priority',
1063 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1064 `:scheduled', `:deadline', `:closed', `:post-blank' and
1065 `:post-affiliated' keywords.
1067 The plist also contains any property set in the property drawer,
1068 with its name in upper cases and colons added at the
1069 beginning (e.g., `:CUSTOM_ID').
1071 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1072 title will not be parsed as a secondary string, but as a plain
1073 string instead.
1075 Assume point is at beginning of the inline task."
1122 :begin begin
1123 :end end
1124 :pre-blank
1127 :contents-begin contents-begin
1128 :contents-end contents-end
1129 :level level
1130 :priority priority
1131 :tags tags
1132 :todo-keyword todo
1133 :todo-type todo-type
1136 time-props
1137 standard-props))))
1139 inlinetask :title
1148 nil
1150 inlinetask))))))
1153 "Interpret INLINETASK element as Org syntax.
1154 CONTENTS is the contents of inlinetask."
1168 ;; Align tags.
1176 ? )
1177 tags))
1181 tags))))
1182 ;; Prefer degenerate inlinetasks when there are no
1183 ;; contents.
1186 contents
1190 ;;;; Item
1193 "Parse an item.
1195 STRUCT is the structure of the plain list.
1197 Return a list whose CAR is `item' and CDR is a plist containing
1198 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1199 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1200 `:post-affiliated' keywords.
1202 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1203 any, will not be parsed as a secondary string, but as a plain
1204 string instead.
1206 Assume point is at the beginning of the item."
1229 ;; Ignore tags in un-ordered lists: they are just
1230 ;; a part of item's body.
1237 ;; If first line isn't empty, contents really
1238 ;; start at the text after item's meta-data.
1248 :begin begin
1249 :end end
1250 :contents-begin contents-begin
1251 :contents-end contents-end
1252 :checkbox checkbox
1253 :counter counter
1254 :structure struct
1258 item :tag
1265 item))))))))
1268 "Interpret ITEM element as Org syntax.
1269 CONTENTS is the contents of the element."
1279 ;; Compute indentation.
1284 ;; Indent contents.
1286 bullet
1301 ;;;; Plain List
1304 ;; Return structure of list at point. Internal function. See
1305 ;; `org-list-struct' for details.
1310 items struct)
1315 ;; At limit: end all items.
1324 ;; At list end: end all items.
1329 ;; At a new item: end previous sibling.
1341 ind
1342 bullet
1345 ;; Description tag.
1349 ;; Ending position, unknown so far.
1350 nil)))
1351 items))
1353 ;; Skip empty lines.
1355 ;; Skip inline tasks and blank lines along the way.
1362 ;; At some text line. Check if it ends any previous item.
1375 ;; Skip blocks (any type) and drawers contents.
1380 limit t)))
1386 "Parse a plain list.
1388 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1389 the buffer position at the beginning of the first affiliated
1390 keyword and CDR is a plist of affiliated keywords along with
1391 their value. STRUCTURE is the structure of the plain list being
1392 parsed.
1394 Return a list whose CAR is `plain-list' and CDR is a plist
1395 containing `:type', `:begin', `:end', `:contents-begin' and
1396 `:contents-end', `:structure', `:post-blank' and
1397 `:post-affiliated' keywords.
1399 Assume point is at the beginning of the list."
1413 pos))
1417 ;; Return value.
1421 :begin begin
1422 :end end
1423 :contents-begin contents-begin
1424 :contents-end contents-end
1425 :structure struct
1431 "Interpret plain-list element as Org syntax.
1432 CONTENTS is the contents of the element."
1440 ;;;; Property Drawer
1443 "Parse a property drawer.
1445 LIMIT bounds the search.
1447 Return a list whose car is `property-drawer' and cdr is a plist
1448 containing `:begin', `:end', `:contents-begin', `:contents-end',
1449 `:post-blank' and `:post-affiliated' keywords.
1451 Assume point is at the beginning of the property drawer."
1464 :end end
1466 :contents-end contents-end
1471 "Interpret property-drawer element as Org syntax.
1472 CONTENTS is the properties within the drawer."
1476 ;;;; Quote Block
1479 "Parse a quote block.
1481 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1482 the buffer position at the beginning of the first affiliated
1483 keyword and CDR is a plist of affiliated keywords along with
1484 their value.
1486 Return a list whose CAR is `quote-block' and CDR is a plist
1487 containing `:begin', `:end', `:contents-begin', `:contents-end',
1488 `:post-blank' and `:post-affiliated' keywords.
1490 Assume point is at the beginning of the block."
1494 ;; Incomplete block: parse it as a paragraph.
1500 ;; Empty blocks have no contents.
1513 :end end
1514 :contents-begin contents-begin
1515 :contents-end contents-end
1521 "Interpret quote-block element as Org syntax.
1522 CONTENTS is the contents of the element."
1526 ;;;; Section
1529 "Parse a section.
1531 Return a list whose CAR is `section' and CDR is a plist
1532 containing `:begin', `:end', `:contents-begin', `contents-end',
1533 `:post-blank' and `:post-affiliated' keywords."
1535 ;; Beginning of section is the beginning of the first non-blank
1536 ;; line after previous headline.
1544 :end end
1545 :contents-begin begin
1546 :contents-end pos-before-blank
1551 "Interpret section element as Org syntax.
1552 CONTENTS is the contents of the element."
1553 contents)
1556 ;;;; Special Block
1559 "Parse a special block.
1561 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1562 the buffer position at the beginning of the first affiliated
1563 keyword and CDR is a plist of affiliated keywords along with
1564 their value.
1566 Return a list whose CAR is `special-block' and CDR is a plist
1567 containing `:type', `:begin', `:end', `:contents-begin',
1568 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1570 Assume point is at the beginning of the block."
1577 limit t)))
1578 ;; Incomplete block: parse it as a paragraph.
1584 ;; Empty blocks have no contents.
1597 :begin begin
1598 :end end
1599 :contents-begin contents-begin
1600 :contents-end contents-end
1606 "Interpret SPECIAL-BLOCK element as Org syntax.
1607 CONTENTS is the contents of the element."
1612 \f
1613 ;;; Elements
1614 ;;
1615 ;; For each element, a parser and an interpreter are also defined.
1616 ;; Both follow the same naming convention used for greater elements.
1617 ;;
1618 ;; Also, as for greater elements, adding a new element type is done
1619 ;; through the following steps: implement a parser and an interpreter,
1620 ;; tweak `org-element--current-element' so that it recognizes the new
1621 ;; type and add that new type to `org-element-all-elements'.
1624 ;;;; Babel Call
1627 "Parse a babel call.
1629 LIMIT bounds the search. AFFILIATED is a list of which car is
1630 the buffer position at the beginning of the first affiliated
1631 keyword and cdr is a plist of affiliated keywords along with
1632 their value.
1634 Return a list whose car is `babel-call' and cdr is a plist
1635 containing `:call', `:inside-header', `:arguments',
1636 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1637 `:post-affiliated' as keywords."
1651 value)))
1661 :begin begin
1662 :end end
1663 :value value
1669 "Interpret BABEL-CALL element as Org syntax."
1679 ;;;; Clock
1682 "Parse a clock.
1684 LIMIT bounds the search.
1686 Return a list whose CAR is `clock' and CDR is a plist containing
1687 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1688 `:post-affiliated' as keywords."
1708 :value value
1709 :duration duration
1710 :begin begin
1711 :end end
1712 :post-blank post-blank
1716 "Interpret CLOCK element as Org syntax."
1724 "%2s:%02s"
1728 ;;;; Comment
1731 "Parse a comment.
1733 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1734 the buffer position at the beginning of the first affiliated
1735 keyword and CDR is a plist of affiliated keywords along with
1736 their value.
1738 Return a list whose CAR is `comment' and CDR is a plist
1739 containing `:begin', `:end', `:value', `:post-blank',
1740 `:post-affiliated' keywords.
1742 Assume point is at comment beginning."
1751 ;; Get comments ending.
1754 ;; Accumulate lines without leading hash and first
1755 ;; whitespace.
1769 :end end
1770 :value value
1776 "Interpret COMMENT element as Org syntax.
1777 CONTENTS is nil."
1781 ;;;; Comment Block
1784 "Parse an export block.
1786 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1787 the buffer position at the beginning of the first affiliated
1788 keyword and CDR is a plist of affiliated keywords along with
1789 their value.
1791 Return a list whose CAR is `comment-block' and CDR is a plist
1792 containing `:begin', `:end', `:value', `:post-blank' and
1793 `:post-affiliated' keywords.
1795 Assume point is at comment block beginning."
1799 ;; Incomplete block: parse it as a paragraph.
1812 contents-begin contents-end)))
1816 :end end
1817 :value value
1823 "Interpret COMMENT-BLOCK element as Org syntax."
1830 ;;;; Diary Sexp
1833 "Parse a diary sexp.
1835 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1836 the buffer position at the beginning of the first affiliated
1837 keyword and CDR is a plist of affiliated keywords along with
1838 their value.
1840 Return a list whose CAR is `diary-sexp' and CDR is a plist
1841 containing `:begin', `:end', `:value', `:post-blank' and
1842 `:post-affiliated' keywords."
1854 :begin begin
1855 :end end
1861 "Interpret DIARY-SEXP as Org syntax."
1865 ;;;; Example Block
1868 "Parse an example block.
1870 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1871 the buffer position at the beginning of the first affiliated
1872 keyword and CDR is a plist of affiliated keywords along with
1873 their value.
1875 Return a list whose CAR is `example-block' and CDR is a plist
1876 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1877 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1878 `:value', `:post-blank' and `:post-affiliated' keywords."
1882 ;; Incomplete block: parse it as a paragraph.
1890 ;; Switches analysis.
1894 switches)
1897 'new
1900 ;; Subtract 1 to give number of lines before
1901 ;; first line.
1905 ;; Should labels be retained in (or stripped from) example
1906 ;; blocks?
1911 ;; What should code-references use - labels or
1912 ;; line-numbers?
1921 ;; Standard block parsing.
1927 contents-begin contents-end)))
1936 :end end
1937 :value value
1938 :switches switches
1939 :number-lines number-lines
1940 :preserve-indent preserve-indent
1941 :retain-labels retain-labels
1942 :use-labels use-labels
1943 :label-fmt label-fmt
1949 "Interpret EXAMPLE-BLOCK element as Org syntax."
1957 value
1962 ;;;; Export Block
1965 "Parse an export block.
1967 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1968 the buffer position at the beginning of the first affiliated
1969 keyword and CDR is a plist of affiliated keywords along with
1970 their value.
1972 Return a list whose CAR is `export-block' and CDR is a plist
1973 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1974 `:post-affiliated' keywords.
1976 Assume point is at export-block beginning."
1980 ;; Incomplete block: parse it as a paragraph.
1999 contents-end))))
2003 :begin begin
2004 :end end
2005 :value value
2011 "Interpret EXPORT-BLOCK element as Org syntax."
2017 ;;;; Fixed-width
2020 "Parse a fixed-width section.
2022 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2023 the buffer position at the beginning of the first affiliated
2024 keyword and CDR is a plist of affiliated keywords along with
2025 their value.
2027 Return a list whose CAR is `fixed-width' and CDR is a plist
2028 containing `:begin', `:end', `:value', `:post-blank' and
2029 `:post-affiliated' keywords.
2031 Assume point is at the beginning of the fixed-width area."
2035 value
2040 ;; Accumulate text without starting colons.
2053 :end end
2054 :value value
2060 "Interpret FIXED-WIDTH element as Org syntax."
2068 ;;;; Horizontal Rule
2071 "Parse an horizontal rule.
2073 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2074 the buffer position at the beginning of the first affiliated
2075 keyword and CDR is a plist of affiliated keywords along with
2076 their value.
2078 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2079 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2080 keywords."
2090 :end end
2096 "Interpret HORIZONTAL-RULE element as Org syntax."
2100 ;;;; Keyword
2103 "Parse a keyword at point.
2105 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2106 the buffer position at the beginning of the first affiliated
2107 keyword and CDR is a plist of affiliated keywords along with
2108 their value.
2110 Return a list whose CAR is `keyword' and CDR is a plist
2111 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2112 `:post-affiliated' keywords."
2114 ;; An orphaned affiliated keyword is considered as a regular
2115 ;; keyword. In this case AFFILIATED is nil, so we take care of
2116 ;; this corner case.
2129 :value value
2130 :begin begin
2131 :end end
2137 "Interpret KEYWORD element as Org syntax."
2143 ;;;; Latex Environment
2147 "Regexp matching the beginning of a LaTeX environment.
2148 The environment is captured by the first group.
2154 "Format string matching the ending of a LaTeX environment.
2158 "Parse a LaTeX environment.
2160 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2161 the buffer position at the beginning of the first affiliated
2162 keyword and CDR is a plist of affiliated keywords along with
2163 their value.
2165 Return a list whose CAR is `latex-environment' and CDR is a plist
2166 containing `:begin', `:end', `:value', `:post-blank' and
2167 `:post-affiliated' keywords.
2169 Assume point is at the beginning of the latex environment."
2176 limit t))
2177 ;; Incomplete latex environment: parse it as a paragraph.
2187 :end end
2188 :value value
2194 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2198 ;;;; Node Property
2201 "Parse a node-property at point.
2203 LIMIT bounds the search.
2205 Return a list whose CAR is `node-property' and CDR is a plist
2206 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2207 `:post-affiliated' keywords."
2217 limit))))
2220 :value value
2221 :begin begin
2222 :end end
2227 "Interpret NODE-PROPERTY element as Org syntax."
2233 ;;;; Paragraph
2236 "Parse a paragraph.
2238 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2239 the buffer position at the beginning of the first affiliated
2240 keyword and CDR is a plist of affiliated keywords along with
2241 their value.
2243 Return a list whose CAR is `paragraph' and CDR is a plist
2244 containing `:begin', `:end', `:contents-begin' and
2245 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2247 Assume point is at the beginning of the paragraph."
2254 ;; A matching `org-element-paragraph-separate' is not
2255 ;; necessarily the end of the paragraph. In particular,
2256 ;; drawers, blocks or LaTeX environments opening lines
2257 ;; must be closed. Moreover keywords with a secondary
2258 ;; value must belong to "dual keywords".
2272 limit t)))
2278 limit t)))
2281 org-element-dual-keywords))
2282 ;; Everything else is unambiguous.
2295 :end end
2296 :contents-begin contents-begin
2297 :contents-end contents-end
2303 "Interpret paragraph element as Org syntax.
2304 CONTENTS is the contents of the element."
2305 contents)
2308 ;;;; Planning
2311 "Parse a planning.
2313 LIMIT bounds the search.
2315 Return a list whose CAR is `planning' and CDR is a plist
2316 containing `:closed', `:deadline', `:scheduled', `:begin',
2317 `:end', `:post-blank' and `:post-affiliated' keywords."
2327 closed deadline scheduled)
2339 :deadline deadline
2340 :scheduled scheduled
2341 :begin begin
2342 :end end
2343 :post-blank post-blank
2347 "Interpret PLANNING element as Org syntax."
2349 #'identity
2366 ;;;; Src Block
2369 "Parse a src block.
2371 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2372 the buffer position at the beginning of the first affiliated
2373 keyword and CDR is a plist of affiliated keywords along with
2374 their value.
2376 Return a list whose CAR is `src-block' and CDR is a plist
2377 containing `:language', `:switches', `:parameters', `:begin',
2378 `:end', `:number-lines', `:retain-labels', `:use-labels',
2379 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2380 `:post-affiliated' keywords.
2382 Assume point is at the beginning of the block."
2385 limit t)))
2386 ;; Incomplete block: parse it as a paragraph.
2392 ;; Get language as a string.
2401 ;; Get switches.
2403 ;; Get parameters.
2405 ;; Switches analysis.
2409 switches)
2412 'new
2415 ;; Subtract 1 to give number of lines before
2416 ;; first line.
2424 ;; Should labels be retained in (or stripped from)
2425 ;; src blocks?
2430 ;; What should code-references use - labels or
2431 ;; line-numbers?
2436 ;; Retrieve code.
2443 ;; Get position after ending blank lines.
2453 :begin begin
2454 :end end
2455 :number-lines number-lines
2456 :preserve-indent preserve-indent
2457 :retain-labels retain-labels
2458 :use-labels use-labels
2459 :label-fmt label-fmt
2460 :value value
2466 "Interpret SRC-BLOCK element as Org syntax."
2475 val)
2490 ;;;; Table
2493 "Parse a table at point.
2495 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2496 the buffer position at the beginning of the first affiliated
2497 keyword and CDR is a plist of affiliated keywords along with
2498 their value.
2500 Return a list whose CAR is `table' and CDR is a plist containing
2501 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2502 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2503 keywords.
2505 Assume point is at the beginning of the table."
2521 acc))
2528 :end end
2529 :type type
2530 :tblfm tblfm
2531 ;; Only `org' tables have contents. `table.el' tables
2532 ;; use a `:value' property to store raw table as
2533 ;; a string.
2538 table-begin table-end))
2544 "Interpret TABLE element as Org syntax.
2545 CONTENTS is a string, if table's type is `org', or nil."
2556 ;;;; Table Row
2559 "Parse table row at point.
2561 Return a list whose CAR is `table-row' and CDR is a plist
2562 containing `:begin', `:end', `:contents-begin', `:contents-end',
2563 `:type', `:post-blank' and `:post-affiliated' keywords."
2567 ;; A table rule has no contents. In that case, ensure
2568 ;; CONTENTS-BEGIN matches CONTENTS-END.
2578 :begin begin
2579 :end end
2580 :contents-begin contents-begin
2581 :contents-end contents-end
2586 "Interpret TABLE-ROW element as Org syntax.
2587 CONTENTS is the contents of the table row."
2592 ;;;; Verse Block
2595 "Parse a verse block.
2597 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2598 the buffer position at the beginning of the first affiliated
2599 keyword and CDR is a plist of affiliated keywords along with
2600 their value.
2602 Return a list whose CAR is `verse-block' and CDR is a plist
2603 containing `:begin', `:end', `:contents-begin', `:contents-end',
2604 `:post-blank' and `:post-affiliated' keywords.
2606 Assume point is at beginning of the block."
2610 ;; Incomplete block: parse it as a paragraph.
2625 :end end
2626 :contents-begin contents-begin
2627 :contents-end contents-end
2633 "Interpret verse-block element as Org syntax.
2634 CONTENTS is verse block contents."
2638 \f
2639 ;;; Objects
2640 ;;
2641 ;; Unlike to elements, raw text can be found between objects. Hence,
2642 ;; `org-element--object-lex' is provided to find the next object in
2643 ;; buffer.
2644 ;;
2645 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2646 ;; object types they can contain will be specified in
2647 ;; `org-element-object-restrictions'.
2648 ;;
2649 ;; Creating a new type of object requires to alter
2650 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2651 ;; new type in `org-element-all-objects', and possibly add
2652 ;; restrictions in `org-element-object-restrictions'.
2654 ;;;; Bold
2657 "Parse bold object at point, if any.
2659 When at a bold object, return a list whose car is `bold' and cdr
2660 is a plist with `:begin', `:end', `:contents-begin' and
2661 `:contents-end' and `:post-blank' keywords. Otherwise, return
2662 nil.
2664 Assume point is at the first star marker."
2676 :end end
2677 :contents-begin contents-begin
2678 :contents-end contents-end
2682 "Interpret bold object as Org syntax.
2683 CONTENTS is the contents of the object."
2687 ;;;; Code
2690 "Parse code object at point, if any.
2692 When at a code object, return a list whose car is `code' and cdr
2693 is a plist with `:value', `:begin', `:end' and `:post-blank'
2694 keywords. Otherwise, return nil.
2696 Assume point is at the first tilde marker."
2707 :begin begin
2708 :end end
2712 "Interpret CODE object as Org syntax."
2716 ;;;; Entity
2719 "Parse entity at point, if any.
2721 When at an entity, return a list whose car is `entity' and cdr
2722 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2723 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2724 `:post-blank' as keywords. Otherwise, return nil.
2726 Assume point is at the beginning of the entity."
2728 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2746 :begin begin
2747 :end end
2748 :use-brackets-p bracketsp
2752 "Interpret ENTITY object as Org syntax."
2758 ;;;; Export Snippet
2761 "Parse export snippet at point.
2763 When at an export snippet, return a list whose car is
2764 `export-snippet' and cdr a plist with `:begin', `:end',
2765 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2766 return nil.
2768 Assume point is at the beginning of the snippet."
2784 :value value
2785 :begin begin
2786 :end end
2790 "Interpret EXPORT-SNIPPET object as Org syntax."
2796 ;;;; Footnote Reference
2799 "Parse footnote reference at point, if any.
2801 When at a footnote reference, return a list whose car is
2802 `footnote-reference' and cdr a plist with `:label', `:type',
2803 `:begin', `:end', `:content-begin', `:contents-end' and
2804 `:post-blank' as keywords. Otherwise, return nil."
2820 :type type
2821 :begin begin
2822 :end end
2828 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2829 CONTENTS is its definition, when inline, or nil."
2835 ;;;; Inline Babel Call
2838 "Parse inline babel call at point, if any.
2840 When at an inline babel call, return a list whose car is
2841 `inline-babel-call' and cdr a plist with `:call',
2842 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2843 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2845 Assume point is at the beginning of the babel call."
2859 ;; Parenthesis are mandatory.
2870 :inside-header inside-header
2871 :arguments arguments
2872 :end-header end-header
2873 :begin begin
2874 :end end
2875 :value value
2879 "Interpret INLINE-BABEL-CALL object as Org syntax."
2889 ;;;; Inline Src Block
2892 "Parse inline source block at point, if any.
2894 When at an inline source block, return a list whose car is
2895 `inline-src-block' and cdr a plist with `:begin', `:end',
2896 `:language', `:value', `:parameters' and `:post-blank' as
2897 keywords. Otherwise, return nil.
2899 Assume point is at the beginning of the inline src block."
2916 :value value
2917 :parameters parameters
2918 :begin begin
2923 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2928 language
2930 body)))
2932 ;;;; Italic
2935 "Parse italic object at point, if any.
2937 When at an italic object, return a list whose car is `italic' and
2938 cdr is a plist with `:begin', `:end', `:contents-begin' and
2939 `:contents-end' and `:post-blank' keywords. Otherwise, return
2940 nil.
2942 Assume point is at the first slash marker."
2954 :end end
2955 :contents-begin contents-begin
2956 :contents-end contents-end
2960 "Interpret italic object as Org syntax.
2961 CONTENTS is the contents of the object."
2965 ;;;; Latex Fragment
2968 "Parse LaTeX fragment at point, if any.
2970 When at a LaTeX fragment, return a list whose car is
2971 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2972 and `:post-blank' as keywords. Otherwise, return nil.
2974 Assume point is at the beginning of the LaTeX fragment."
2993 ;; Macro.
3003 :begin begin
3004 :end end
3008 "Interpret LATEX-FRAGMENT object as Org syntax."
3011 ;;;; Line Break
3014 "Parse line break at point, if any.
3016 When at a line break, return a list whose car is `line-break',
3017 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3018 Otherwise, return nil.
3020 Assume point is at the beginning of the line break."
3029 "Interpret LINE-BREAK object as Org syntax."
3033 ;;;; Link
3036 "Parse link at point, if any.
3038 When at a link, return a list whose car is `link' and cdr a plist
3039 with `:type', `:path', `:format', `:raw-link', `:application',
3040 `:search-option', `:begin', `:end', `:contents-begin',
3041 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3042 nil.
3044 Assume point is at the beginning of the link."
3047 end contents-begin contents-end link-end post-blank path type format
3048 raw-link search-option application)
3050 ;; Type 1: Text targeted from a radio target.
3060 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3066 ;; RAW-LINK is the original link. Expand any
3067 ;; abbreviation in it.
3068 ;;
3069 ;; Also treat any newline character and associated
3070 ;; indentation as a single space character. This is not
3071 ;; compatible with RFC 3986, which requires to ignore
3072 ;; them altogether. However, doing so would require
3073 ;; users to encode spaces on the fly when writing links
3074 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3075 ;; [[shell:ls *.org]], which defeats Org's focus on
3076 ;; simplicity.
3081 ;; Determine TYPE of link and set PATH accordingly. According
3082 ;; to RFC 3986, remove whitespaces from URI in external links.
3083 ;; In internal ones, treat indentation as a single space.
3085 ;; File type.
3090 ;; Explicit type (http, irc, bbdb...).
3094 ;; Code-ref type: PATH is the name of the reference.
3099 ;; Custom-id type: PATH is the name of the custom id.
3103 ;; Fuzzy type: Internal link either matches a target, an
3104 ;; headline name or nothing. PATH is the target or
3105 ;; headline's name.
3109 ;; Type 3: Plain link, e.g., http://orgmode.org
3116 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3117 ;; bracket links, follow RFC 3986 and remove any extra
3118 ;; whitespace in URI.
3129 ;; In any case, deduce end point after trailing white space from
3130 ;; LINK-END variable.
3135 ;; Special "file" type link processing. Extract opening
3136 ;; application and search option, if any. Also normalize URI.
3143 ;; Translate link, if `org-link-translation-function' is set.
3151 :path path
3152 :format format
3154 :application application
3155 :search-option search-option
3156 :begin begin
3157 :end end
3158 :contents-begin contents-begin
3159 :contents-end contents-end
3163 "Interpret LINK object as Org syntax.
3164 CONTENTS is the contents of the object, or nil."
3169 ;; Links with contents and internal links have to
3170 ;; use bracket syntax. Ignore `:format' in these
3171 ;; cases. This is also the default syntax when the
3172 ;; property is not defined, e.g., when the object
3173 ;; was crafted by the user.
3176 ;; Since this is going to be used as
3177 ;; a format string, escape percent signs
3178 ;; in description.
3181 `nil
3184 ;; Otherwise, just obey to `:format'.
3196 path
3202 ;;;; Macro
3205 "Parse macro at point, if any.
3207 When at a macro, return a list whose car is `macro' and cdr
3208 a plist with `:key', `:args', `:begin', `:end', `:value' and
3209 `:post-blank' as keywords. Otherwise, return nil.
3211 Assume point is at the macro."
3224 :value value
3225 :args args
3226 :begin begin
3227 :end end
3231 "Interpret MACRO object as Org syntax."
3235 ;;;; Radio-target
3238 "Parse radio target at point, if any.
3240 When at a radio target, return a list whose car is `radio-target'
3241 and cdr a plist with `:begin', `:end', `:contents-begin',
3242 `:contents-end', `:value' and `:post-blank' as keywords.
3243 Otherwise, return nil.
3245 Assume point is at the radio target."
3257 :end end
3258 :contents-begin contents-begin
3259 :contents-end contents-end
3260 :post-blank post-blank
3264 "Interpret target object as Org syntax.
3265 CONTENTS is the contents of the object."
3269 ;;;; Statistics Cookie
3272 "Parse statistics cookie at point, if any.
3274 When at a statistics cookie, return a list whose car is
3275 `statistics-cookie', and cdr a plist with `:begin', `:end',
3276 `:value' and `:post-blank' keywords. Otherwise, return nil.
3278 Assume point is at the beginning of the statistics-cookie."
3289 :end end
3290 :value value
3294 "Interpret STATISTICS-COOKIE object as Org syntax."
3298 ;;;; Strike-Through
3301 "Parse strike-through object at point, if any.
3303 When at a strike-through object, return a list whose car is
3304 `strike-through' and cdr is a plist with `:begin', `:end',
3305 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3306 Otherwise, return nil.
3308 Assume point is at the first plus sign marker."
3320 :end end
3321 :contents-begin contents-begin
3322 :contents-end contents-end
3326 "Interpret strike-through object as Org syntax.
3327 CONTENTS is the contents of the object."
3331 ;;;; Subscript
3334 "Parse subscript at point, if any.
3336 When at a subscript object, return a list whose car is
3337 `subscript' and cdr a plist with `:begin', `:end',
3338 `:contents-begin', `:contents-end', `:use-brackets-p' and
3339 `:post-blank' as keywords. Otherwise, return nil.
3341 Assume point is at the underscore."
3355 :end end
3356 :use-brackets-p bracketsp
3357 :contents-begin contents-begin
3358 :contents-end contents-end
3362 "Interpret SUBSCRIPT object as Org syntax.
3363 CONTENTS is the contents of the object."
3366 contents))
3369 ;;;; Superscript
3372 "Parse superscript at point, if any.
3374 When at a superscript object, return a list whose car is
3375 `superscript' and cdr a plist with `:begin', `:end',
3376 `:contents-begin', `:contents-end', `:use-brackets-p' and
3377 `:post-blank' as keywords. Otherwise, return nil.
3379 Assume point is at the caret."
3393 :end end
3394 :use-brackets-p bracketsp
3395 :contents-begin contents-begin
3396 :contents-end contents-end
3400 "Interpret SUPERSCRIPT object as Org syntax.
3401 CONTENTS is the contents of the object."
3404 contents))
3407 ;;;; Table Cell
3410 "Parse table cell at point.
3411 Return a list whose car is `table-cell' and cdr is a plist
3412 containing `:begin', `:end', `:contents-begin', `:contents-end'
3413 and `:post-blank' keywords."
3421 :end end
3422 :contents-begin contents-begin
3423 :contents-end contents-end
3427 "Interpret table-cell element as Org syntax.
3428 CONTENTS is the contents of the cell, or nil."
3432 ;;;; Target
3435 "Parse target at point, if any.
3437 When at a target, return a list whose car is `target' and cdr
3438 a plist with `:begin', `:end', `:value' and `:post-blank' as
3439 keywords. Otherwise, return nil.
3441 Assume point is at the target."
3451 :end end
3452 :value value
3456 "Interpret TARGET object as Org syntax."
3460 ;;;; Timestamp
3471 "Parse time stamp at point, if any.
3473 When at a time stamp, return a list whose car is `timestamp', and
3474 cdr a plist with `:type', `:raw-value', `:year-start',
3475 `:month-start', `:day-start', `:hour-start', `:minute-start',
3476 `:year-end', `:month-end', `:day-end', `:hour-end',
3477 `:minute-end', `:repeater-type', `:repeater-value',
3478 `:repeater-unit', `:warning-type', `:warning-value',
3479 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3480 Otherwise, return nil.
3482 Assume point is at the beginning of the timestamp."
3501 date-start)
3512 raw-value)
3514 :repeater-type
3520 :repeater-unit
3529 :warning-unit
3532 year-start month-start day-start hour-start minute-start year-end
3533 month-end day-end hour-end minute-end)
3534 ;; Parse date-start.
3542 ;; Compute date-end. It can be provided directly in time-stamp,
3543 ;; or extracted from time range. Otherwise, it defaults to the
3544 ;; same values as date-start.
3554 :raw-value raw-value
3555 :year-start year-start
3556 :month-start month-start
3557 :day-start day-start
3558 :hour-start hour-start
3559 :minute-start minute-start
3560 :year-end year-end
3561 :month-end month-end
3562 :day-end day-end
3563 :hour-end hour-end
3564 :minute-end minute-end
3565 :begin begin
3566 :end end
3568 repeater-props
3569 warning-props))))))
3572 "Interpret TIMESTAMP object as Org syntax."
3590 ;; Build an Org timestamp string from TIME. ACTIVEP is
3591 ;; non-nil when time stamp is active. If WITH-TIME-P is
3592 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3593 ;; specify a time range in the timestamp. REPEAT-STRING is
3594 ;; the repeater string, if any.
3598 org-time-stamp-formats)
3599 time)))
3605 nil nil ts)))
3610 " "
3611 s
3613 ;; Return value.
3614 ts)))
3626 build-ts-string
3645 0
3653 "--"
3666 ;;;; Underline
3669 "Parse underline object at point, if any.
3671 When at an underline object, return a list whose car is
3672 `underline' and cdr is a plist with `:begin', `:end',
3673 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3674 Otherwise, return nil.
3676 Assume point is at the first underscore marker."
3688 :end end
3689 :contents-begin contents-begin
3690 :contents-end contents-end
3694 "Interpret underline object as Org syntax.
3695 CONTENTS is the contents of the object."
3699 ;;;; Verbatim
3702 "Parse verbatim object at point, if any.
3704 When at a verbatim object, return a list whose car is `verbatim'
3705 and cdr is a plist with `:value', `:begin', `:end' and
3706 `:post-blank' keywords. Otherwise, return nil.
3708 Assume point is at the first equal sign marker."
3719 :begin begin
3720 :end end
3724 "Interpret VERBATIM object as Org syntax."
3728 \f
3729 ;;; Parsing Element Starting At Point
3730 ;;
3731 ;; `org-element--current-element' is the core function of this section.
3732 ;; It returns the Lisp representation of the element starting at
3733 ;; point.
3734 ;;
3735 ;; `org-element--current-element' makes use of special modes. They
3736 ;; are activated for fixed element chaining (e.g., `plain-list' >
3737 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3738 ;; `section'). Special modes are: `first-section', `item',
3739 ;; `node-property', `section' and `table-row'.
3742 "Parse the element starting at point.
3744 Return value is a list like (TYPE PROPS) where TYPE is the type
3745 of the element and PROPS a plist of properties associated to the
3746 element.
3748 Possible types are defined in `org-element-all-elements'.
3750 LIMIT bounds the search.
3752 Optional argument GRANULARITY determines the depth of the
3753 recursion. Allowed values are `headline', `greater-element',
3754 `element', `object' or nil. When it is broader than `object' (or
3755 nil), secondary values will not be parsed, since they only
3756 contain objects.
3758 Optional argument MODE, when non-nil, can be either
3759 `first-section', `section', `planning', `item', `node-property'
3760 and `table-row'.
3762 If STRUCTURE isn't provided but MODE is set to `item', it will be
3763 computed.
3765 This function assumes point is always at the beginning of the
3766 element it has to parse."
3769 ;; Determine if parsing depth allows for secondary strings
3770 ;; parsing. It only applies to elements referenced in
3771 ;; `org-element-secondary-value-alist'.
3774 ;; Item.
3777 ;; Table Row.
3779 ;; Node Property.
3781 ;; Headline.
3784 ;; Sections (must be checked after headline).
3789 limit)))
3790 ;; Planning.
3795 ;; Property drawer.
3801 ;; When not at bol, point is at the beginning of an item or
3802 ;; a footnote definition: next item is always a paragraph.
3804 ;; Clock.
3806 ;; Inlinetask.
3809 ;; From there, elements can have affiliated keywords.
3812 ;; Jumping over affiliated keywords put point off-limits.
3813 ;; Parse them as regular keywords.
3817 ;; LaTeX Environment.
3820 ;; Drawer and Property Drawer.
3823 ;; Fixed Width
3826 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3827 ;; Keywords.
3845 limit
3846 affiliated))
3859 ;; Footnote Definition.
3862 ;; Horizontal Rule.
3865 ;; Diary Sexp.
3868 ;; Table.
3871 ;; List.
3874 limit affiliated
3876 ;; Default element: Paragraph.
3880 ;; Most elements can have affiliated keywords. When looking for an
3881 ;; element beginning, we want to move before them, as they belong to
3882 ;; that element, and, in the meantime, collect information they give
3883 ;; into appropriate properties. Hence the following function.
3886 "Collect affiliated keywords from point down to LIMIT.
3888 Return a list whose CAR is the position at the first of them and
3889 CDR a plist of keywords and values and move point to the
3890 beginning of the first line after them.
3892 As a special case, if element doesn't start at the beginning of
3893 the line (e.g., a paragraph starting an item), CAR is current
3894 position of point and CDR is nil."
3898 ;; RESTRICT is the list of objects allowed in parsed
3899 ;; keywords value.
3901 output)
3904 ;; Apply translation to RAW-KWD. From there, KWD is
3905 ;; the official keyword.
3907 org-element-keyword-translation-alist))
3908 raw-kwd))
3909 ;; Find main value for any keyword.
3915 ;; PARSEDP is non-nil when keyword should have its
3916 ;; value parsed.
3918 ;; If KWD is a dual keyword, find its secondary
3919 ;; value. Maybe parse it.
3928 ;; Attribute a property name to KWD.
3930 ;; Now set final shape for VALUE.
3936 nil restrict)))
3940 ;; Attributes can always appear on multiple lines.
3943 ;; Eventually store the new value in OUTPUT.
3945 ;; Move to next keyword.
3947 ;; If affiliated keywords are orphaned: move back to first one.
3948 ;; They will be parsed as a paragraph.
3950 ;; Return value.
3954 \f
3955 ;;; The Org Parser
3956 ;;
3957 ;; The two major functions here are `org-element-parse-buffer', which
3958 ;; parses Org syntax inside the current buffer, taking into account
3959 ;; region, narrowing, or even visibility if specified, and
3960 ;; `org-element-parse-secondary-string', which parses objects within
3961 ;; a given string.
3962 ;;
3963 ;; The (almost) almighty `org-element-map' allows applying a function
3964 ;; on elements or objects matching some type, and accumulating the
3965 ;; resulting values. In an export situation, it also skips unneeded
3966 ;; parts of the parse tree.
3969 "Recursively parse the buffer and return structure.
3970 If narrowing is in effect, only parse the visible part of the
3971 buffer.
3973 Optional argument GRANULARITY determines the depth of the
3974 recursion. It can be set to the following symbols:
3976 `headline' Only parse headlines.
3977 `greater-element' Don't recurse into greater elements except
3978 headlines and sections. Thus, elements
3979 parsed are the top-level ones.
3980 `element' Parse everything but objects and plain text.
3981 `object' Parse the complete buffer (default).
3983 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3984 elements.
3986 An element or object is represented as a list with the
3987 pattern (TYPE PROPERTIES CONTENTS), where :
3989 TYPE is a symbol describing the element or object. See
3990 `org-element-all-elements' and `org-element-all-objects' for an
3991 exhaustive list of such symbols. One can retrieve it with
3992 `org-element-type' function.
3994 PROPERTIES is the list of attributes attached to the element or
3995 object, as a plist. Although most of them are specific to the
3996 element or object type, all types share `:begin', `:end',
3997 `:post-blank' and `:parent' properties, which respectively
3998 refer to buffer position where the element or object starts,
3999 ends, the number of white spaces or blank lines after it, and
4000 the element or object containing it. Properties values can be
4001 obtained by using `org-element-property' function.
4003 CONTENTS is a list of elements, objects or raw strings
4004 contained in the current element or object, when applicable.
4005 One can access them with `org-element-contents' function.
4007 The Org buffer has `org-data' as type and nil as properties.
4008 `org-element-map' function can be used to find specific elements
4009 or objects within the parse tree.
4011 This function assumes that current major mode is `org-mode'."
4017 ;; Start in `first-section' mode so text before the first
4018 ;; headline belongs to a section.
4022 "Recursively parse objects in STRING and return structure.
4024 RESTRICTION is a symbol limiting the object types that will be
4025 looked after.
4027 Optional argument PARENT, when non-nil, is the element or object
4028 containing the secondary string. It is used to set correctly
4029 `:parent' property within the string.
4031 If STRING is the empty string or nil, return nil."
4048 "Map a function on selected elements or objects.
4050 DATA is a parse tree, an element, an object, a string, or a list
4051 of such constructs. TYPES is a symbol or list of symbols of
4052 elements or objects types (see `org-element-all-elements' and
4053 `org-element-all-objects' for a complete list of types). FUN is
4054 the function called on the matching element or object. It has to
4055 accept one argument: the element or object itself.
4057 When optional argument INFO is non-nil, it should be a plist
4058 holding export options. In that case, parts of the parse tree
4059 not exportable according to that property list will be skipped.
4061 When optional argument FIRST-MATCH is non-nil, stop at the first
4062 match for which FUN doesn't return nil, and return that value.
4064 Optional argument NO-RECURSION is a symbol or a list of symbols
4065 representing elements or objects types. `org-element-map' won't
4066 enter any recursive element or object whose type belongs to that
4067 list. Though, FUN can still be applied on them.
4069 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4070 apply to matching objects within parsed affiliated keywords (see
4071 `org-element-parsed-keywords').
4073 Nil values returned from FUN do not appear in the results.
4076 Examples:
4077 ---------
4079 Assuming TREE is a variable containing an Org buffer parse tree,
4080 the following example will return a flat list of all `src-block'
4081 and `example-block' elements in it:
4085 The following snippet will find the first headline with a level
4089 (lambda (hl)
4090 (and (= (org-element-property :level hl) 1)
4092 (org-element-property :begin hl)))
4093 nil t)
4095 The next example will return a flat list of all `plain-list' type
4096 elements in TREE that are not a sub-list themselves:
4100 Eventually, this example will return a flat list of all `bold'
4101 type objects containing a `latex-snippet' type object, even
4102 looking into captions:
4105 (lambda (b)
4107 nil nil nil t)"
4108 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4112 ;; Recursion depth is determined by --CATEGORY.
4119 ;; If one object is found, the function has
4120 ;; to recurse into every object.
4123 ;; If one regular element is found, the
4124 ;; function has to recurse, at least, into
4125 ;; every element it encounters.
4128 --acc)
4131 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4132 ;; holding contextual information.
4136 ;; Ignored element in an export context.
4138 ;; List of elements or objects.
4140 ;; Unconditionally enter parse trees.
4144 ;; Check if TYPE is matching among TYPES. If so,
4145 ;; apply FUN to --DATA and accumulate return value
4146 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4152 ;; If --DATA has a secondary string that can contain
4153 ;; objects with their type among TYPES, look inside.
4156 org-element-secondary-value-alist)))
4158 ;; If --DATA has any parsed affiliated keywords and
4159 ;; WITH-AFFILIATED is non-nil, look for objects in
4160 ;; them.
4167 ;; Pay attention to the type of parsed
4168 ;; keyword. In particular, preserve order for
4169 ;; multiple keywords.
4182 ;; Determine if a recursion into --DATA is possible.
4184 ;; --TYPE is explicitly removed from recursion.
4186 ;; --DATA has no contents.
4188 ;; Looking for greater elements but --DATA is
4189 ;; simply an element or an object.
4192 ;; Looking for elements but --DATA is an object.
4195 ;; In any other case, map contents.
4199 ;; Return value in a proper order.
4203 ;; The following functions are internal parts of the parser.
4204 ;;
4205 ;; The first one, `org-element--parse-elements' acts at the element's
4206 ;; level.
4207 ;;
4208 ;; The second one, `org-element--parse-objects' applies on all objects
4209 ;; of a paragraph or a secondary string. It calls
4210 ;; `org-element--object-lex' to find the next object in the current
4211 ;; container.
4214 "Return next special mode according to TYPE, or nil.
4215 TYPE is a symbol representing the type of an element or object
4216 containing next element if PARENTP is non-nil, or before it
4217 otherwise. Modes can be either `first-section', `item',
4218 `node-property', `planning', `property-drawer', `section',
4219 `table-row' or nil."
4236 "Parse elements between BEG and END positions.
4238 MODE prioritizes some elements over the others. It can be set to
4239 `first-section', `section', `planning', `item', `node-property'
4240 or `table-row'.
4242 When value is `item', STRUCTURE will be used as the current list
4243 structure.
4245 GRANULARITY determines the depth of the recursion. See
4246 `org-element-parse-buffer' for more information.
4248 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4249 elements.
4251 Elements are accumulated into ACC."
4254 ;; Visible only: skip invisible parts at the beginning of the
4255 ;; element.
4258 ;; When parsing only headlines, skip any text before first one.
4263 ;; Find current element's type and parse it accordingly to
4264 ;; its category.
4266 end granularity mode structure))
4270 ;; Visible only: skip invisible parts between siblings.
4273 ;; Fill ELEMENT contents by side-effect.
4275 ;; If element has no contents, don't modify it.
4277 ;; Greater element: parse it between `contents-begin' and
4278 ;; `contents-end'. Make sure GRANULARITY allows the
4279 ;; recursion, or ELEMENT is a headline, in which case going
4280 ;; inside is mandatory, in order to get sub-level headings.
4288 ;; Possibly switch to a special mode.
4292 granularity visible-only element))
4293 ;; ELEMENT has contents. Parse objects inside, if
4294 ;; GRANULARITY allows it.
4300 ;; Update mode.
4302 ;; Return result.
4306 "Return next object in current buffer or nil.
4307 RESTRICTION is a list of object types, as symbols, that should be
4308 looked after. This function assumes that the buffer is narrowed
4309 to an appropriate container (e.g., a paragraph)."
4313 ;; Object regexp sometimes needs to have a peek at
4314 ;; a character ahead. Therefore, when there is a hard
4315 ;; limit, make it one more than the true beginning of the
4316 ;; radio target.
4323 nil)
4324 ;; Since we moved backward, we do not want to
4325 ;; match again an hypothetical 1-character long
4326 ;; radio link before us. Realizing that this can
4327 ;; only happen if such a radio link starts at
4328 ;; beginning of line, we prevent this here.
4334 found)
4401 ;; This is probably a plain link.
4412 "Parse objects between BEG and END and return recursive structure.
4414 Objects are accumulated in ACC. RESTRICTION is a list of object
4415 successors which are allowed in the current object.
4417 ACC becomes the parent for all parsed objects. However, if ACC
4418 is nil (i.e., a secondary string is being parsed) and optional
4419 argument PARENT is non-nil, use it as the parent for all objects.
4420 Eventually, if both ACC and PARENT are nil, the common parent is
4421 the list of objects itself."
4429 ;; Text before any object.
4434 contents))))
4435 ;; Object...
4440 ;; Fill contents of NEXT-OBJECT if possible.
4442 cont-beg
4444 next-object
4446 next-object)
4447 contents)
4449 ;; Text after last object.
4453 contents)))
4454 ;; Result. Set appropriate parent.
4462 \f
4463 ;;; Towards A Bijective Process
4464 ;;
4465 ;; The parse tree obtained with `org-element-parse-buffer' is really
4466 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4467 ;; interpreted and expanded into a string with canonical Org syntax.
4468 ;; Hence `org-element-interpret-data'.
4469 ;;
4470 ;; The function relies internally on
4471 ;; `org-element--interpret-affiliated-keywords'.
4473 ;;;###autoload
4475 "Interpret DATA as Org syntax.
4476 DATA is a parse tree, an element, an object or a secondary string
4477 to interpret. Return Org syntax as a string."
4481 ;; Find interpreter for current object or
4482 ;; element. If it doesn't exist (e.g. this is
4483 ;; a pseudo object or element), return contents,
4484 ;; if any.
4491 ;; Secondary string.
4494 data
4496 ;; Full Org document.
4501 ;; Plain text: return it.
4503 ;; Element or object without contents.
4506 ;; Element or object with contents.
4509 interpret
4510 data
4511 ;; Recursively interpret contents.
4516 data
4517 ;; Fix indentation of elements containing
4518 ;; objects. We ignore `table-row'
4519 ;; elements as they are one line long
4520 ;; anyway.
4522 data
4523 ;; When normalizing first paragraph of
4524 ;; an item or a footnote-definition,
4525 ;; ignore first line's indentation.
4533 ;; Build white spaces. If no `:post-blank' property
4534 ;; is specified, assume its value is 0.
4544 "Return ELEMENT's affiliated keywords as Org syntax.
4545 If there is no affiliated keyword, return the empty string."
4555 ": "
4558 value)
4566 ;; All attribute keywords can have multiple lines.
4572 ;; List all ELEMENT's properties matching an attribute line or an
4573 ;; affiliated keyword, but ignore translated keywords since they
4574 ;; cannot belong to the property list.
4581 org-element-keyword-translation-alist)))))
4582 collect prop)
4585 ;; Because interpretation of the parse tree must return the same
4586 ;; number of blank lines between elements and the same number of white
4587 ;; space after objects, some special care must be given to white
4588 ;; spaces.
4589 ;;
4590 ;; The first function, `org-element-normalize-string', ensures any
4591 ;; string different from the empty string will end with a single
4592 ;; newline character.
4593 ;;
4594 ;; The second function, `org-element-normalize-contents', removes
4595 ;; global indentation from the contents of the current element.
4598 "Ensure string S ends with a single newline character.
4600 If S isn't a string return it unchanged. If S is the empty
4601 string, return it. Otherwise, return a new string with a single
4602 newline character at its end."
4610 "Normalize plain text in ELEMENT's contents.
4612 ELEMENT must only contain plain text and objects.
4614 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4615 indentation to compute maximal common indentation.
4617 Return the normalized element that is element with global
4618 indentation removed from its contents."
4620 ;; Return minimal common indentation within BLOB. This is
4621 ;; done by walking recursively BLOB and updating MIN-IND
4622 ;; along the way. FIRST-FLAG is non-nil when the next
4623 ;; object is expected to be a string that doesn't start
4624 ;; with a newline character. It happens for strings at
4625 ;; the beginnings of the contents or right after a line
4626 ;; break.
4632 ;; Objects cannot start with spaces: in this
4633 ;; case, indentation is 0.
4674 ;; Build ELEMENT back, replacing each string with the same
4675 ;; string minus common indentation.
4678 ;; Return DATUM with all its strings indentation
4679 ;; shortened from MIN-IND white spaces.
4699 org-element-recursive-objects)
4703 datum)))
4707 \f
4708 ;;; Cache
4709 ;;
4710 ;; Implement a caching mechanism for `org-element-at-point' and
4711 ;; `org-element-context', which see.
4712 ;;
4713 ;; A single public function is provided: `org-element-cache-reset'.
4714 ;;
4715 ;; Cache is enabled by default, but can be disabled globally with
4716 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4717 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4718 ;; can be tweaked to control caching behaviour.
4719 ;;
4720 ;; Internally, parsed elements are stored in an AVL tree,
4721 ;; `org-element--cache'. This tree is updated lazily: whenever
4722 ;; a change happens to the buffer, a synchronization request is
4723 ;; registered in `org-element--cache-sync-requests' (see
4724 ;; `org-element--cache-submit-request'). During idle time, requests
4725 ;; are processed by `org-element--cache-sync'. Synchronization also
4726 ;; happens when an element is required from the cache. In this case,
4727 ;; the process stops as soon as the needed element is up-to-date.
4728 ;;
4729 ;; A synchronization request can only apply on a synchronized part of
4730 ;; the cache. Therefore, the cache is updated at least to the
4731 ;; location where the new request applies. Thus, requests are ordered
4732 ;; from left to right and all elements starting before the first
4733 ;; request are correct. This property is used by functions like
4734 ;; `org-element--cache-find' to retrieve elements in the part of the
4735 ;; cache that can be trusted.
4736 ;;
4737 ;; A request applies to every element, starting from its original
4738 ;; location (or key, see below). When a request is processed, it
4739 ;; moves forward and may collide the next one. In this case, both
4740 ;; requests are merged into a new one that starts from that element.
4741 ;; As a consequence, the whole synchronization complexity does not
4742 ;; depend on the number of pending requests, but on the number of
4743 ;; elements the very first request will be applied on.
4744 ;;
4745 ;; Elements cannot be accessed through their beginning position, which
4746 ;; may or may not be up-to-date. Instead, each element in the tree is
4747 ;; associated to a key, obtained with `org-element--cache-key'. This
4748 ;; mechanism is robust enough to preserve total order among elements
4749 ;; even when the tree is only partially synchronized.
4750 ;;
4751 ;; Objects contained in an element are stored in a hash table,
4752 ;; `org-element--cache-objects'.
4756 "Non-nil when Org parser should cache its results.
4758 WARNING: for the time being, using cache sometimes triggers
4759 freezes. Therefore, it is disabled by default. Activate it if
4766 "Maximum duration, as a time value, for a cache synchronization.
4767 If the synchronization is not over after this delay, the process
4768 pauses and resumes after `org-element-cache-sync-break'
4772 "Duration, as a time value, of the pause between synchronizations.
4776 ;;;; Data Structure
4779 "AVL tree used to cache elements.
4780 Each node of the tree contains an element. Comparison is done
4781 with `org-element--cache-compare'. This cache is used in
4785 "Hash table used as to cache objects.
4786 Key is an element, as returned by `org-element-at-point', and
4787 value is an alist where each association is:
4789 (PARENT COMPLETEP . OBJECTS)
4791 where PARENT is an element or object, COMPLETEP is a boolean,
4792 non-nil when all direct children of parent are already cached and
4793 OBJECTS is a list of such children, as objects, from farthest to
4794 closest.
4797 contained within a paragraph
4801 If the paragraph is completely parsed, OBJECTS-DATA will be
4803 ((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4804 (BOLD-OBJECT t ENTITY-OBJECT))
4806 whereas in a partially parsed paragraph, it could be
4808 ((PARAGRAPH nil ENTITY-OBJECT))
4813 "List of pending synchronization requests.
4815 A request is a vector with the following pattern:
4817 \[NEXT BEG END OFFSET PARENT PHASE]
4819 Processing a synchronization request consists of three phases:
4821 0. Delete modified elements,
4822 1. Fill missing area in cache,
4823 2. Shift positions and re-parent elements after the changes.
4825 During phase 0, NEXT is the key of the first element to be
4826 removed, BEG and END is buffer position delimiting the
4827 modifications. Elements starting between them (inclusive) are
4828 removed. So are elements whose parent is removed. PARENT, when
4829 non-nil, is the parent of the first element to be removed.
4831 During phase 1, NEXT is the key of the next known element in
4832 cache and BEG its beginning position. Parse buffer between that
4833 element and the one before it in order to determine the parent of
4834 the next element. Set PARENT to the element containing NEXT.
4836 During phase 2, NEXT is the key of the next element to shift in
4837 the parse tree. All elements starting from this one have their
4838 properties relatives to buffer positions shifted by integer
4839 OFFSET and, if they belong to element PARENT, are adopted by it.
4847 "Hash table used to store keys during synchronization.
4851 "Return a unique key for ELEMENT in cache tree.
4853 Keys are used to keep a total order among elements in the cache.
4854 Comparison is done with `org-element--cache-key-less-p'.
4856 When no synchronization is taking place, a key is simply the
4857 beginning position of the element, or that position plus one in
4858 the case of an first item (respectively row) in
4859 a list (respectively a table).
4861 During a synchronization, the key is the one the element had when
4862 the cache was synchronized for the last time. Elements added to
4863 cache during the synchronization get a new key generated with
4864 `org-element--cache-generate-key'.
4866 Such keys are stored in `org-element--cache-sync-keys'. The hash
4867 table is cleared once the synchronization is complete."
4870 ;; Increase beginning position of items (respectively
4871 ;; table rows) by one, so the first item can get
4872 ;; a different key from its parent list (respectively
4873 ;; table).
4876 begin)))
4879 key))))
4882 "Generate a key between LOWER and UPPER.
4884 LOWER and UPPER are integers or lists, possibly empty.
4886 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4887 a unique key, as an integer or a list of integers, according to
4888 the following rules:
4890 - LOWER and UPPER are compared level-wise until values differ.
4892 - If, at a given level, LOWER and UPPER differ from more than
4893 2, the new key shares all the levels above with LOWER and
4894 gets a new level. Its value is the mean between LOWER and
4895 UPPER:
4897 (1 2) + (1 4) --> (1 3)
4899 - If LOWER has no value to compare with, it is assumed that its
4900 value is `most-negative-fixnum'. E.g.,
4902 (1 1) + (1 1 2)
4904 is equivalent to
4906 (1 1 m) + (1 1 2)
4908 where m is `most-negative-fixnum'. Likewise, if UPPER is
4909 short of levels, the current value is `most-positive-fixnum'.
4911 - If they differ from only one, the new key inherits from
4912 current LOWER level and fork it at the next level. E.g.,
4914 (2 1) + (3 3)
4916 is equivalent to
4918 (2 1) + (2 M)
4920 where M is `most-positive-fixnum'.
4922 - If the key is only one level long, it is returned as an
4923 integer:
4925 (1 2) + (3 2) --> 2
4927 When they are not equals, the function assumes that LOWER is
4928 lesser than UPPER, per `org-element--cache-key-less-p'."
4932 skip-upper key)
4943 ;; When at a given level, LOWER and UPPER differ from
4944 ;; 1, ignore UPPER altogether. Instead create a key
4945 ;; between LOWER and the greatest key with the same
4946 ;; prefix as LOWER so far.
4952 "Non-nil if key A is less than key B.
4953 A and B are either integers or lists of integers, as returned by
4954 `org-element--cache-key'."
4962 ;; If A is empty, either keys are equal (B is also empty) and
4963 ;; we return nil, or A is lesser than B (B is longer) and we
4964 ;; return a non-nil value.
4965 ;;
4966 ;; If A is not empty, B is necessarily empty and A is greater
4967 ;; than B (A is longer). Therefore, return nil.
4971 "Non-nil when element A is located before element B."
4976 "Return root value in cache.
4977 This function assumes `org-element--cache' is a valid AVL tree."
4981 ;;;; Tools
4984 "Non-nil when cache is active in current buffer."
4986 org-element--cache
4990 "Find element in cache starting at POS or before.
4992 POS refers to a buffer position.
4994 When optional argument SIDE is non-nil, the function checks for
4995 elements starting at or past POS instead. If SIDE is `both', the
4996 function returns a cons cell where car is the first element
4997 starting at or before POS and cdr the first element starting
4998 after POS.
5000 The function can only find elements in the synchronized part of
5001 the cache."
5005 lower upper)
5020 ;; We found an element in cache starting at POS. If `side'
5021 ;; is `both' we also want the next one in order to generate
5022 ;; a key in-between.
5023 ;;
5024 ;; If the element is the first row or item in a table or
5025 ;; a plain list, we always return the table or the plain
5026 ;; list.
5027 ;;
5028 ;; In any other case, we return the element found.
5037 lower parent
5038 upper parent)))))
5041 lower element
5042 upper element)))))
5049 "Store ELEMENT in current buffer's cache, if allowed.
5050 When optional argument DATA is non-nil, assume is it object data
5051 relative to ELEMENT and store it in the objects cache."
5055 ;; During synchronization, first build an appropriate key
5056 ;; for the new element so `avl-tree-enter' can insert it at
5057 ;; the right spot in the cache.
5066 org-element--cache-sync-keys)))
5068 ;; Headlines are not stored in cache, so objects in titles are
5069 ;; not stored either.
5074 "Remove ELEMENT from cache.
5075 Assume ELEMENT belongs to cache and that a cache is active."
5080 ;;;; Synchronization
5083 "Set idle timer for cache synchronization in BUFFER."
5090 org-element-cache-sync-idle-time))
5091 nil
5092 #'org-element--cache-sync
5093 buffer)))
5096 "Non-nil when synchronization process should be interrupted.
5097 TIME-LIMIT is a time value or nil."
5103 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5105 Properties containing buffer positions are `:begin', `:end',
5106 `:contents-begin', `:contents-end' and `:structure'. When
5107 optional argument PROPS is a list of keywords, only shift
5108 properties provided in that list.
5110 Properties are modified by side-effect."
5112 ;; Shift `:structure' property for the first plain list only: it
5113 ;; is the only one that really matters and it prevents from
5114 ;; shifting it more than once.
5128 "Synchronize cache with recent modification in BUFFER.
5130 When optional argument THRESHOLD is non-nil, do the
5131 synchronization for all elements starting before or at threshold,
5132 then exit. Otherwise, synchronize cache for as long as
5133 `org-element-cache-sync-duration' or until Emacs leaves idle
5134 state.
5136 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5137 not registered yet in the cache are going to happen. It is used
5138 in `org-element--cache-submit-request', where cache is partially
5139 updated before current modification are actually submitted."
5150 request
5152 threshold
5155 org-element-cache-sync-duration))
5156 future-change)
5157 ;; Request processed. Merge current and next offsets and
5158 ;; transfer ending position.
5164 ;; If more requests are awaiting, set idle timer accordingly.
5165 ;; Otherwise, reset keys.
5172 "Process synchronization REQUEST for all entries before NEXT.
5174 REQUEST is a vector, built by `org-element--cache-submit-request'.
5176 NEXT is a cache key, as returned by `org-element--cache-key'.
5178 When non-nil, THRESHOLD is a buffer position. Synchronization
5179 stops as soon as a shifted element begins after it.
5181 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5182 after this time or when Emacs exits idle state.
5184 When non-nil, FUTURE-CHANGE is a buffer position where changes
5185 not registered yet in the cache are going to happen. See
5186 `org-element--cache-submit-request' for more information.
5188 Throw `interrupt' if the process stops before completing the
5189 request."
5192 ;; Phase 0.
5193 ;;
5194 ;; Delete all elements starting after BEG, but not after buffer
5195 ;; position END or past element with key NEXT. Also delete
5196 ;; elements contained within a previously removed element
5197 ;; (stored in `last-container').
5198 ;;
5199 ;; At each iteration, we start again at tree root since
5200 ;; a deletion modifies structure of the balanced tree.
5205 ;; Find first element in cache with key BEG or after it.
5209 data data-key last-container)
5218 data-key key
5221 data-key key
5222 node nil)))))
5232 up)))
5235 end))
5242 ;; No element starting after modifications left in
5243 ;; cache: further processing is futile.
5246 ;; Phase 1.
5247 ;;
5248 ;; Phase 0 left a hole in the cache. Some elements after it
5249 ;; could have parents within. For example, in the following
5250 ;; buffer:
5251 ;;
5252 ;; - item
5253 ;;
5254 ;;
5255 ;; Paragraph1
5256 ;;
5257 ;; Paragraph2
5258 ;;
5259 ;; if we remove a blank line between "item" and "Paragraph1",
5260 ;; everything down to "Paragraph2" is removed from cache. But
5261 ;; the paragraph now belongs to the list, and its `:parent'
5262 ;; property no longer is accurate.
5263 ;;
5264 ;; Therefore we need to parse again elements in the hole, or at
5265 ;; least in its last section, so that we can re-parent
5266 ;; subsequent elements, during phase 2.
5267 ;;
5268 ;; Note that we only need to get the parent from the first
5269 ;; element in cache after the hole.
5270 ;;
5271 ;; When next key is lesser or equal to the current one, delegate
5272 ;; phase 1 processing to next request in order to preserve key
5273 ;; order among requests.
5281 ;; Next element will start at its beginning position plus
5282 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5283 ;; contains the real beginning position of the first element to
5284 ;; shift and re-parent.
5288 ;; Changes are going to happen around this element and
5289 ;; they will trigger another phase 1 request. Skip the
5290 ;; current one.
5296 ;; Phase 2.
5297 ;;
5298 ;; Shift all elements starting from key START, but before NEXT, by
5299 ;; OFFSET, and re-parent them when appropriate.
5300 ;;
5301 ;; Elements are modified by side-effect so the tree structure
5302 ;; remains intact.
5303 ;;
5304 ;; Once THRESHOLD, if any, is reached, or once there is an input
5305 ;; pending, exit. Before leaving, the current synchronization
5306 ;; request is updated.
5313 exit-flag)
5314 ;; No re-parenting nor shifting planned: request is over.
5324 ;; We reached NEXT. Request is complete.
5326 ;; Handle interruption request. Update current request.
5331 ;; Shift element.
5334 ;; Shift associated objects data, if any.
5339 ;; Update PARENT and re-parent DATA, only when
5340 ;; necessary. Propagate new structures for lists.
5354 ;; Cache is up-to-date past THRESHOLD. Request
5355 ;; interruption.
5360 ;; We reached end of tree: synchronization complete.
5361 t)))
5364 "Parse elements in current section, down to POS.
5366 Start parsing from the closest between the last known element in
5367 cache or headline above. Return the smallest element containing
5368 POS.
5370 When optional argument SYNCP is non-nil, return the parent of the
5371 element containing POS instead. In that case, it is also
5372 possible to provide TIME-LIMIT, which is a time value specifying
5373 when the parsing should stop. The function throws `interrupt' if
5374 the process stopped before finding the expected result."
5381 element next mode)
5383 ;; Nothing in cache before point: start parsing from first
5384 ;; element following headline above, or first element in
5385 ;; buffer.
5392 ;; Cache returned exact match: return it.
5395 ;; There's a headline between cached value and POS: cached
5396 ;; value is invalid. Start parsing from first element
5397 ;; following the headline.
5404 ;; Check if CACHED or any of its ancestors contain point.
5405 ;;
5406 ;; If there is such an element, we inspect it in order to know
5407 ;; if we return it or if we need to parse its contents.
5408 ;; Otherwise, we just start parsing from current location,
5409 ;; which is right after the top-most element containing
5410 ;; CACHED.
5411 ;;
5412 ;; As a special case, if POS is at the end of the buffer, we
5413 ;; want to return the innermost element ending there.
5414 ;;
5415 ;; Also, if we find an ancestor and discover that we need to
5416 ;; parse its contents, make sure we don't start from
5417 ;; `:contents-begin', as we would otherwise go past CACHED
5418 ;; again. Instead, in that situation, we will resume parsing
5419 ;; from NEXT, which is located after CACHED or its higher
5420 ;; ancestor not containing point.
5432 ;; Parse successively each element until we reach POS.
5445 end 'element mode
5452 ;; Skip any element ending before point. Also skip
5453 ;; element ending at point (unless it is also the end of
5454 ;; buffer) since we're sure that another element begins
5455 ;; after it.
5459 ;; A non-greater element contains point: return it.
5462 ;; Otherwise, we have to decide if ELEMENT really
5463 ;; contains POS. In that case we start parsing from
5464 ;; contents' beginning.
5465 ;;
5466 ;; If POS is at contents' beginning but it is also at
5467 ;; the beginning of the first item in a list or a table.
5468 ;; In that case, we need to create an anchor for that
5469 ;; list or table, so return it.
5470 ;;
5471 ;; Also, if POS is at the end of the buffer, no element
5472 ;; can start after it, but more than one may end there.
5473 ;; Arbitrarily, we choose to return the innermost of
5474 ;; such elements.
5487 parent element
5488 end cend))))
5489 ;; Otherwise, return ELEMENT as it is the smallest
5490 ;; element containing POS.
5495 ;;;; Staging Buffer Changes
5506 "Regexp matching a sensitive line, structure wise.
5507 A sensitive line is a headline, inlinetask, block, drawer, or
5508 latex-environment boundary. When such a line is modified,
5509 structure changes in the document may propagate in the whole
5513 "Non-nil when a sensitive line is about to be changed.
5517 "Request extension of area going to be modified if needed.
5518 BEG and END are the beginning and end of the range of changed
5519 text. See `before-change-functions' for more information."
5529 'headline
5532 org-element--cache-sensitive-re bottom t)))))))))
5535 "Update buffer modifications for current buffer.
5536 BEG and END are the beginning and end of the range of changed
5537 text, and the length in bytes of the pre-change text replaced by
5538 that range. See `after-change-functions' for more information."
5546 ;; Determine if modified area needs to be extended, according
5547 ;; to both previous and current state. We make a special
5548 ;; case for headline editing: if a headline is modified but
5549 ;; not removed, do not extend.
5552 (`headline
5558 org-element--cache-sensitive-re bottom t))))
5559 ;; Effectively extend modified area.
5567 ;; Store synchronization request.
5570 ;; Activate a timer to process the request during idle time.
5574 "Return first element to remove from cache.
5576 BEG and END are buffer positions delimiting buffer modifications.
5577 OFFSET is the size of the changes.
5579 Returned element is usually the first element in cache containing
5580 any position between BEG and END. As an exception, greater
5581 elements around the changes that are robust to contents
5582 modifications are preserved and updated according to the
5583 changes."
5593 special-block))
5594 ;; Drawers named "PROPERTIES" are probably
5595 ;; a properties drawer being edited. Force
5596 ;; parsing to check if editing is over.
5605 ;; UP is a robust greater element containing changes.
5606 ;; We only need to extend its ending boundaries.
5612 ;; We're at top level element containing ELEMENT: if it's
5613 ;; altered by buffer modifications, it is first element in
5614 ;; cache to be removed. Otherwise, that first element is the
5615 ;; following one.
5616 ;;
5617 ;; As a special case, do not remove BEFORE if it is a robust
5618 ;; container for current changes.
5620 before)))))
5623 "Submit a new cache synchronization request for current buffer.
5624 BEG and END are buffer positions delimiting the minimal area
5625 where cache data should be removed. OFFSET is the size of the
5626 change, as an integer."
5628 delete-to delete-from)
5633 ;; Current changes can be merged with first sync request: we
5634 ;; can save a partial cache synchronization.
5637 ;; If last change happened within area to be removed, extend
5638 ;; boundaries of robust parents, if any. Otherwise, find
5639 ;; first element to remove and update request accordingly.
5651 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5652 ;; if any, is no longer a 0-phase request, thus ensuring that
5653 ;; phases are properly ordered. We need to provide OFFSET as
5654 ;; optional parameter since current modifications are not known
5655 ;; yet to the otherwise correct part of the cache (i.e, before
5656 ;; the first request).
5663 ;; When changes happen before the first known
5664 ;; element, re-parent and shift the rest of the
5665 ;; cache.
5667 ;; Otherwise, we find the first non robust
5668 ;; element containing END. All elements between
5669 ;; FIRST and this one are to be removed.
5680 element up))
5682 org-element--cache-sync-requests)
5683 ;; No element to remove. No need to re-parent either.
5684 ;; Simply shift additional elements, if any, by OFFSET.
5687 offset)))))))
5690 ;;;; Public Functions
5692 ;;;###autoload
5694 "Reset cache in current buffer.
5695 When optional argument ALL is non-nil, reset cache in all Org
5696 buffers."
5714 ;;;###autoload
5716 "Refresh cache at position POS."
5723 \f
5724 ;;; The Toolbox
5725 ;;
5726 ;; The first move is to implement a way to obtain the smallest element
5727 ;; containing point. This is the job of `org-element-at-point'. It
5728 ;; basically jumps back to the beginning of section containing point
5729 ;; and proceed, one element after the other, with
5730 ;; `org-element--current-element' until the container is found. Note:
5731 ;; When using `org-element-at-point', secondary values are never
5732 ;; parsed since the function focuses on elements, not on objects.
5733 ;;
5734 ;; At a deeper level, `org-element-context' lists all elements and
5735 ;; objects containing point.
5736 ;;
5737 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5738 ;; internally by navigation and manipulation tools.
5741 ;;;###autoload
5743 "Determine closest element around point.
5745 Return value is a list like (TYPE PROPS) where TYPE is the type
5746 of the element and PROPS a plist of properties associated to the
5747 element.
5749 Possible types are defined in `org-element-all-elements'.
5750 Properties depend on element or object type, but always include
5751 `:begin', `:end', `:parent' and `:post-blank' properties.
5753 As a special case, if point is at the very beginning of the first
5754 item in a list or sub-list, returned element will be that list
5755 instead of the item. Likewise, if point is at the beginning of
5756 the first row of a table, returned element will be the table
5757 instead of the first row.
5759 When point is at the end of the buffer, return the innermost
5760 element ending there."
5766 ;; Within blank lines at the beginning of buffer, return nil.
5768 ;; Within blank lines right after a headline, return that
5769 ;; headline.
5773 ;; Otherwise parse until we find element containing ORIGIN.
5780 ;;;###autoload
5782 "Return smallest element or object around point.
5784 Return value is a list like (TYPE PROPS) where TYPE is the type
5785 of the element or object and PROPS a plist of properties
5786 associated to it.
5788 Possible types are defined in `org-element-all-elements' and
5789 `org-element-all-objects'. Properties depend on element or
5790 object type, but always include `:begin', `:end', `:parent' and
5791 `:post-blank'.
5793 As a special case, if point is right after an object and not at
5794 the beginning of any other object, return that object.
5796 Optional argument ELEMENT, when non-nil, is the closest element
5797 containing point, as returned by `org-element-at-point'.
5798 Providing it allows for quicker computation."
5805 ;; If point is inside an element containing objects or
5806 ;; a secondary string, narrow buffer to the container and
5807 ;; proceed with parsing. Otherwise, return ELEMENT.
5809 ;; At a parsed affiliated keyword, check if we're inside main
5810 ;; or dual value.
5816 org-element-parsed-keywords))
5825 ;; Also change type to retrieve correct restrictions.
5827 ;; At an item, objects can only be located within tag, if any.
5838 ;; At an headline or inlinetask, objects are in title.
5850 ;; At a paragraph, a table-row or a verse block, objects are
5851 ;; located within their contents.
5855 ;; CBEG is nil for table rules.
5860 ;; At a planning line, if point is at a timestamp, return it,
5861 ;; otherwise, return element.
5869 ;; All other locations cannot contain objects: bail out.
5879 next object-data last)
5883 ;; When entering PARENT for the first time, get list
5884 ;; of objects within known so far. Store it in
5885 ;; OBJECT-DATA.
5890 ;; Find NEXT object for analysis.
5892 ;; If NEXT is non-nil, we already exhausted the
5893 ;; cache so we can parse buffer to find the object
5894 ;; after it.
5896 ;; Otherwise, check if cache can help us.
5907 ;; Cache contains the information needed.
5910 pos)
5912 pos)
5918 ;; If we have a new object to analyze, store it in
5919 ;; cache. Otherwise record that there is nothing
5920 ;; more to parse in this element at this depth.
5925 ;; Process NEXT, if any, in order to know if we need
5926 ;; to skip it, return it or move into it.
5933 ;; Skip objects ending before point. Also skip
5934 ;; objects ending at point unless it is also the
5935 ;; end of buffer, since we want to return the
5936 ;; innermost object.
5939 ;; For convenience, when object ends at POS,
5940 ;; without any space, store it in LAST, as we
5941 ;; will return it if no object starts here.
5945 ;; If POS is within a container object, move
5946 ;; into that object.
5950 ;; At contents' end, if there is no
5951 ;; space before point, also move into
5952 ;; object, for consistency with
5953 ;; convenience feature above.
5962 next nil
5963 object-data nil))
5964 ;; Otherwise, return NEXT.
5966 ;; Store results in cache, if applicable.
5970 "List all ancestors of a given element or object.
5972 BLOB is an object or element.
5974 When optional argument TYPES is a list of symbols, return the
5975 first element or object in the lineage whose type belongs to that
5976 list.
5978 When optional argument WITH-SELF is non-nil, lineage includes
5979 BLOB itself as the first element, and TYPES, if provided, also
5980 apply to it.
5982 When BLOB is obtained through `org-element-context' or
5983 `org-element-at-point', only ancestors from its section can be
5984 found. There is no such limitation when BLOB belongs to a full
5985 parse tree."
5987 ancestors)
5994 "Non-nil when elements ELEM-A and ELEM-B are nested."
6003 "Swap elements ELEM-A and ELEM-B.
6004 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6005 end of ELEM-A."
6007 ;; There are two special cases when an element doesn't start at bol:
6008 ;; the first paragraph in an item or in a footnote definition.
6010 ;; Only a paragraph without any affiliated keyword can be moved at
6011 ;; ELEM-A position in such a situation. Note that the case of
6012 ;; a footnote definition is impossible: it cannot contain two
6013 ;; paragraphs in a row because it cannot contain a blank line.
6019 ;; In a special situation, ELEM-A will have no indentation. We'll
6020 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6034 ;; Store inner overlays responsible for visibility status.
6035 ;; We also need to store their boundaries as they will be
6036 ;; removed from buffer.
6051 ;; Get contents.
6059 ;; Restore ex ELEM-A overlays.
6066 ;; Restore ex ELEM-B overlays.
6074 ;; Local variables:
6075 ;; generated-autoload-file: "org-loaddefs.el"
6076 ;; End:
6078 ;;; org-element.el ends here