| blob | 6bd0091c80a80306f8b576247b154211c9141240 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2018 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 <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; See <https://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 in a link description. Also ignore
298 ;; radio-targets and line breaks.
300 italic latex-fragment macro statistics-cookie strike-through
301 subscript superscript underline verbatim)
303 ;; Remove any variable object from radio target as it would
304 ;; prevent it from being properly recognized.
306 subscript superscript underline superscript)
310 ;; Ignore inline babel call and inline src block as formulas are
311 ;; possible. Also ignore line breaks and statistics cookies.
313 latex-fragment link macro radio-target strike-through
314 subscript superscript target timestamp underline verbatim)
318 "Alist of objects restrictions.
320 key is an element or object type containing objects and value is
321 a list of types that can be contained within an element or object
322 of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, latex-fragments, subscript, superscript and text
326 markup.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
344 "Table used internally to pair only round brackets.
353 "Table used internally to pair only square brackets.
362 "Table used internally to pair only curly brackets.
366 "Parse paired brackets at point.
367 CHAR is the opening bracket to consider, as a character. Return
368 contents between brackets, as a string, or nil. Also move point
369 past the brackets."
384 \f
385 ;;; Accessors and Setters
386 ;;
387 ;; Provide four accessors: `org-element-type', `org-element-property'
388 ;; `org-element-contents' and `org-element-restriction'.
389 ;;
390 ;; Setter functions allow modification of elements by side effect.
391 ;; There is `org-element-put-property', `org-element-set-contents'.
392 ;; These low-level functions are useful to build a parse tree.
393 ;;
394 ;; `org-element-adopt-elements', `org-element-set-element',
395 ;; `org-element-extract-element' and `org-element-insert-before' are
396 ;; high-level functions useful to modify a parse tree.
397 ;;
398 ;; `org-element-secondary-p' is a predicate used to know if a given
399 ;; object belongs to a secondary string. `org-element-class' tells if
400 ;; some parsed data is an element or an object, handling pseudo
401 ;; elements and objects. `org-element-copy' returns an element or
402 ;; object, stripping its parent property in the process.
405 "Return type of ELEMENT.
407 The function returns the type of the element or object provided.
408 It can also return the following special value:
409 `plain-text' for a string
410 `org-data' for a complete document
411 nil in any other case."
417 "Extract the value from the PROPERTY of an ELEMENT."
422 "Extract contents from an ELEMENT."
428 "Return restriction associated to ELEMENT.
429 ELEMENT can be an element, an object or a symbol representing an
430 element or object type."
432 org-element-object-restrictions)))
435 "In ELEMENT set PROPERTY to VALUE.
436 Return modified element."
439 element))
442 "Set ELEMENT's contents to CONTENTS.
443 Return ELEMENT."
450 "Non-nil when OBJECT directly belongs to a secondary string.
451 Return value is the property name, as a keyword, or nil."
454 org-element-secondary-value-alist))))
461 "Return class for ELEMENT, as a symbol.
462 Class is either `element' or `object'. Optional argument PARENT
463 is the element or object containing DATUM. It defaults to the
464 value of DATUM `:parent' property."
468 ;; Trivial cases.
471 ;; Special cases.
475 ;; Pseudo object or elements. Make a guess about its class.
476 ;; Basically a pseudo object is contained within another object,
477 ;; a secondary string or a container element.
487 "Append elements to the contents of another element.
489 PARENT is an element or object. CHILDREN can be elements,
490 objects, or a strings.
492 The function takes care of setting `:parent' property for CHILD.
493 Return parent element."
495 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
496 ;; string: parent is the list itself.
499 ;; Add CHILDREN at the end of PARENT contents.
502 parent
504 ;; Return modified PARENT element.
508 "Extract ELEMENT from parse tree.
509 Remove element from the parse tree by side-effect, and return it
510 with its `:parent' property stripped out."
515 parent secondary
518 parent
520 ;; Return ELEMENT with its :parent removed.
524 "Insert ELEMENT before LOCATION in parse tree.
525 LOCATION is an element, object or string within the parse tree.
526 Parse tree is modified by side effect."
531 ;; Special case: LOCATION is the first element of an
532 ;; independent secondary string (e.g. :title property). Add
533 ;; ELEMENT in-place.
537 ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires tweaking `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret a center-block element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
806 "Parse a footnote definition.
808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
809 the buffer position at the beginning of the first affiliated
810 keyword and CDR is a plist of affiliated keywords along with
811 their value.
813 Return a list whose CAR is `footnote-definition' and CDR is
814 a plist containing `:label', `:begin' `:end', `:contents-begin',
815 `:contents-end', `:pre-blank',`:post-blank' and
816 `: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.
859 :begin begin
860 :end end
861 :contents-begin contents-begin
863 :pre-blank pre-blank
869 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
870 CONTENTS is the contents of the footnote-definition."
873 ;; 0 is specific to paragraphs at the beginning of
874 ;; the footnote definition, so we use 1 as
875 ;; a fall-back value, which is more universal.
877 ;; Footnote ends after more than two consecutive empty
878 ;; lines: limit ourselves to 2 newline characters.
885 ;;;; Headline
888 "Return node properties associated to headline at point.
889 Upcase property names. It avoids confusion between properties
890 obtained through property drawer and default properties from the
891 parser (e.g. `:end' and :END:). Return value is a plist."
903 properties))))
906 "Return time properties associated to headline at point.
907 Return value is a plist."
921 plist))))
924 "Parse a headline.
926 Return a list whose CAR is `headline' and CDR is a plist
927 containing `:raw-value', `:title', `:begin', `:end',
928 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
929 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
930 `:deadline', `:closed', `:archivedp', `:commentedp'
931 `:footnote-section-p', `:post-blank' and `:post-affiliated'
932 keywords.
934 The plist also contains any property set in the property drawer,
935 with its name in upper cases and colons added at the
936 beginning (e.g., `:CUSTOM_ID').
938 LIMIT is a buffer position bounding the search.
940 When RAW-SECONDARY-P is non-nil, headline's title will not be
941 parsed as a secondary string, but as a plain string instead.
943 Assume point is at beginning of the headline."
989 :begin begin
990 :end end
991 :pre-blank
994 :contents-begin contents-begin
995 :contents-end contents-end
996 :level level
997 :priority priority
998 :tags tags
999 :todo-keyword todo
1000 :todo-type todo-type
1001 :post-blank
1005 :footnote-section-p footnote-section-p
1006 :archivedp archivedp
1007 :commentedp commentedp
1009 time-props
1010 standard-props))))
1012 headline :title
1021 nil
1023 headline)))))))
1026 "Interpret HEADLINE element as Org syntax.
1027 CONTENTS is the contents of the element."
1040 ?*)
1044 " "
1047 org-footnote-section
1048 title))))
1050 heading
1051 ;; Align tags.
1059 ?\s)
1060 tags))
1064 tags))))
1066 contents)))
1069 ;;;; Inlinetask
1072 "Parse an inline task.
1074 Return a list whose CAR is `inlinetask' and CDR is a plist
1075 containing `:title', `:begin', `:end', `:pre-blank',
1076 `:contents-begin' and `:contents-end', `:level', `:priority',
1077 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1078 `:scheduled', `:deadline', `:closed', `:post-blank' and
1079 `:post-affiliated' keywords.
1081 The plist also contains any property set in the property drawer,
1082 with its name in upper cases and colons added at the
1083 beginning (e.g., `:CUSTOM_ID').
1085 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1086 title will not be parsed as a secondary string, but as a plain
1087 string instead.
1089 Assume point is at beginning of the inline task."
1136 :begin begin
1137 :end end
1138 :pre-blank
1141 :contents-begin contents-begin
1142 :contents-end contents-end
1143 :level level
1144 :priority priority
1145 :tags tags
1146 :todo-keyword todo
1147 :todo-type todo-type
1150 time-props
1151 standard-props))))
1153 inlinetask :title
1162 nil
1164 inlinetask))))))
1167 "Interpret INLINETASK element as Org syntax.
1168 CONTENTS is the contents of inlinetask."
1182 ;; Align tags.
1190 ?\s)
1191 tags))
1195 tags))))
1196 ;; Prefer degenerate inlinetasks when there are no
1197 ;; contents.
1200 contents
1204 ;;;; Item
1207 "Parse an item.
1209 STRUCT is the structure of the plain list.
1211 Return a list whose CAR is `item' and CDR is a plist containing
1212 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1213 `:checkbox', `:counter', `:tag', `:structure', `:pre-blank',
1214 `:post-blank' and `:post-affiliated' keywords.
1216 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1217 any, will not be parsed as a secondary string, but as a plain
1218 string instead.
1220 Assume point is at the beginning of the item."
1245 ;; Ignore tags in un-ordered lists: they are just
1246 ;; a part of item's body.
1253 ;; If first line isn't empty, contents really
1254 ;; start at the text after item's meta-data.
1267 :begin begin
1268 :end end
1269 :contents-begin contents-begin
1270 :contents-end contents-end
1271 :checkbox checkbox
1272 :counter counter
1273 :structure struct
1274 :pre-blank pre-blank
1278 item :tag
1285 item))))))))
1288 "Interpret ITEM element as Org syntax.
1289 CONTENTS is the contents of the element."
1301 bullet
1310 tag
1315 ;; 0 is specific to paragraphs at the
1316 ;; beginning of the item, so we use 1 as
1317 ;; a fall-back value, which is more universal.
1319 ;; Lists ends after more than two consecutive
1320 ;; empty lines: limit ourselves to 2 newline
1321 ;; characters.
1329 ;;;; Plain List
1332 ;; Return structure of list at point. Internal function. See
1333 ;; `org-list-struct' for details.
1338 items struct)
1343 ;; At limit: end all items.
1349 ;; At list end: end all items.
1353 ;; At a new item: end previous sibling.
1365 ind
1366 bullet
1369 ;; Description tag.
1373 ;; Ending position, unknown so far.
1374 nil)))
1375 items))
1377 ;; Skip empty lines.
1379 ;; Skip inline tasks and blank lines along the way.
1386 ;; At some text line. Check if it ends any previous item.
1400 ;; Skip blocks (any type) and drawers contents.
1405 limit t)))
1411 "Parse a plain list.
1413 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1414 the buffer position at the beginning of the first affiliated
1415 keyword and CDR is a plist of affiliated keywords along with
1416 their value. STRUCTURE is the structure of the plain list being
1417 parsed.
1419 Return a list whose CAR is `plain-list' and CDR is a plist
1420 containing `:type', `:begin', `:end', `:contents-begin' and
1421 `:contents-end', `:structure', `:post-blank' and
1422 `:post-affiliated' keywords.
1424 Assume point is at the beginning of the list."
1438 pos))
1442 ;; Return value.
1446 :begin begin
1447 :end end
1448 :contents-begin contents-begin
1449 :contents-end contents-end
1450 :structure struct
1456 "Interpret plain-list element as Org syntax.
1457 CONTENTS is the contents of the element."
1465 ;;;; Property Drawer
1468 "Parse a property drawer.
1470 LIMIT bounds the search.
1472 Return a list whose car is `property-drawer' and cdr is a plist
1473 containing `:begin', `:end', `:contents-begin', `:contents-end',
1474 `:post-blank' and `:post-affiliated' keywords.
1476 Assume point is at the beginning of the property drawer."
1489 :end end
1491 :contents-end contents-end
1496 "Interpret property-drawer element as Org syntax.
1497 CONTENTS is the properties within the drawer."
1501 ;;;; Quote Block
1504 "Parse a quote block.
1506 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1507 the buffer position at the beginning of the first affiliated
1508 keyword and CDR is a plist of affiliated keywords along with
1509 their value.
1511 Return a list whose CAR is `quote-block' and CDR is a plist
1512 containing `:begin', `:end', `:contents-begin', `:contents-end',
1513 `:post-blank' and `:post-affiliated' keywords.
1515 Assume point is at the beginning of the block."
1519 ;; Incomplete block: parse it as a paragraph.
1525 ;; Empty blocks have no contents.
1538 :end end
1539 :contents-begin contents-begin
1540 :contents-end contents-end
1546 "Interpret quote-block element as Org syntax.
1547 CONTENTS is the contents of the element."
1551 ;;;; Section
1554 "Parse a section.
1556 Return a list whose CAR is `section' and CDR is a plist
1557 containing `:begin', `:end', `:contents-begin', `contents-end',
1558 `:post-blank' and `:post-affiliated' keywords."
1560 ;; Beginning of section is the beginning of the first non-blank
1561 ;; line after previous headline.
1569 :end end
1570 :contents-begin begin
1571 :contents-end pos-before-blank
1576 "Interpret section element as Org syntax.
1577 CONTENTS is the contents of the element."
1578 contents)
1581 ;;;; Special Block
1584 "Parse a special block.
1586 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1587 the buffer position at the beginning of the first affiliated
1588 keyword and CDR is a plist of affiliated keywords along with
1589 their value.
1591 Return a list whose CAR is `special-block' and CDR is a plist
1592 containing `:type', `:begin', `:end', `:contents-begin',
1593 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1595 Assume point is at the beginning of the block."
1602 limit t)))
1603 ;; Incomplete block: parse it as a paragraph.
1609 ;; Empty blocks have no contents.
1622 :begin begin
1623 :end end
1624 :contents-begin contents-begin
1625 :contents-end contents-end
1631 "Interpret SPECIAL-BLOCK element as Org syntax.
1632 CONTENTS is the contents of the element."
1637 \f
1638 ;;; Elements
1639 ;;
1640 ;; For each element, a parser and an interpreter are also defined.
1641 ;; Both follow the same naming convention used for greater elements.
1642 ;;
1643 ;; Also, as for greater elements, adding a new element type is done
1644 ;; through the following steps: implement a parser and an interpreter,
1645 ;; tweak `org-element--current-element' so that it recognizes the new
1646 ;; type and add that new type to `org-element-all-elements'.
1649 ;;;; Babel Call
1652 "Parse a babel call.
1654 LIMIT bounds the search. AFFILIATED is a list of which car is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and cdr is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose car is `babel-call' and cdr is a plist
1660 containing `:call', `:inside-header', `:arguments',
1661 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1662 `:post-affiliated' as keywords."
1690 :inside-header inside-header
1691 :arguments arguments
1692 :end-header end-header
1693 :begin begin
1694 :end end
1695 :value value
1701 "Interpret BABEL-CALL element as Org syntax."
1711 ;;;; Clock
1714 "Parse a clock.
1716 LIMIT bounds the search.
1718 Return a list whose CAR is `clock' and CDR is a plist containing
1719 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1720 `:post-affiliated' as keywords."
1740 :value value
1741 :duration duration
1742 :begin begin
1743 :end end
1744 :post-blank post-blank
1748 "Interpret CLOCK element as Org syntax."
1756 "%2s:%02s"
1760 ;;;; Comment
1763 "Parse a comment.
1765 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1766 the buffer position at the beginning of the first affiliated
1767 keyword and CDR is a plist of affiliated keywords along with
1768 their value.
1770 Return a list whose CAR is `comment' and CDR is a plist
1771 containing `:begin', `:end', `:value', `:post-blank',
1772 `:post-affiliated' keywords.
1774 Assume point is at comment beginning."
1783 ;; Get comments ending.
1786 ;; Accumulate lines without leading hash and first
1787 ;; whitespace.
1801 :end end
1802 :value value
1808 "Interpret COMMENT element as Org syntax.
1809 CONTENTS is nil."
1813 ;;;; Comment Block
1816 "Parse an export block.
1818 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1819 the buffer position at the beginning of the first affiliated
1820 keyword and CDR is a plist of affiliated keywords along with
1821 their value.
1823 Return a list whose CAR is `comment-block' and CDR is a plist
1824 containing `:begin', `:end', `:value', `:post-blank' and
1825 `:post-affiliated' keywords.
1827 Assume point is at comment block beginning."
1831 ;; Incomplete block: parse it as a paragraph.
1844 contents-begin contents-end)))
1848 :end end
1849 :value value
1855 "Interpret COMMENT-BLOCK element as Org syntax."
1862 ;;;; Diary Sexp
1865 "Parse a diary sexp.
1867 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1868 the buffer position at the beginning of the first affiliated
1869 keyword and CDR is a plist of affiliated keywords along with
1870 their value.
1872 Return a list whose CAR is `diary-sexp' and CDR is a plist
1873 containing `:begin', `:end', `:value', `:post-blank' and
1874 `:post-affiliated' keywords."
1886 :begin begin
1887 :end end
1893 "Interpret DIARY-SEXP as Org syntax."
1897 ;;;; Example Block
1900 "Parse an example block.
1902 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1903 the buffer position at the beginning of the first affiliated
1904 keyword and CDR is a plist of affiliated keywords along with
1905 their value.
1907 Return a list whose CAR is `example-block' and CDR is a plist
1908 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1909 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1910 `:value', `:post-blank' and `:post-affiliated' keywords."
1914 ;; Incomplete block: parse it as a paragraph.
1922 ;; Switches analysis.
1926 switches)
1929 'new
1932 ;; Subtract 1 to give number of lines before
1933 ;; first line.
1937 ;; Should labels be retained in (or stripped from) example
1938 ;; blocks?
1943 ;; What should code-references use - labels or
1944 ;; line-numbers?
1953 ;; Standard block parsing.
1959 contents-begin contents-end)))
1968 :end end
1969 :value value
1970 :switches switches
1971 :number-lines number-lines
1972 :preserve-indent preserve-indent
1973 :retain-labels retain-labels
1974 :use-labels use-labels
1975 :label-fmt label-fmt
1981 "Interpret EXAMPLE-BLOCK element as Org syntax."
1989 value
1994 ;;;; Export Block
1997 "Parse an export block.
1999 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2000 the buffer position at the beginning of the first affiliated
2001 keyword and CDR is a plist of affiliated keywords along with
2002 their value.
2004 Return a list whose CAR is `export-block' and CDR is a plist
2005 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2006 `:post-affiliated' keywords.
2008 Assume point is at export-block beginning."
2012 ;; Incomplete block: parse it as a paragraph.
2031 contents-end))))
2035 :begin begin
2036 :end end
2037 :value value
2043 "Interpret EXPORT-BLOCK element as Org syntax."
2049 ;;;; Fixed-width
2052 "Parse a fixed-width section.
2054 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2055 the buffer position at the beginning of the first affiliated
2056 keyword and CDR is a plist of affiliated keywords along with
2057 their value.
2059 Return a list whose CAR is `fixed-width' and CDR is a plist
2060 containing `:begin', `:end', `:value', `:post-blank' and
2061 `:post-affiliated' keywords.
2063 Assume point is at the beginning of the fixed-width area."
2067 value
2072 ;; Accumulate text without starting colons.
2085 :end end
2086 :value value
2092 "Interpret FIXED-WIDTH element as Org syntax."
2100 ;;;; Horizontal Rule
2103 "Parse an horizontal rule.
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 `horizontal-rule' and CDR is a plist
2111 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2112 keywords."
2122 :end end
2128 "Interpret HORIZONTAL-RULE element as Org syntax."
2132 ;;;; Keyword
2135 "Parse a keyword at point.
2137 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2138 the buffer position at the beginning of the first affiliated
2139 keyword and CDR is a plist of affiliated keywords along with
2140 their value.
2142 Return a list whose CAR is `keyword' and CDR is a plist
2143 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2144 `:post-affiliated' keywords."
2146 ;; An orphaned affiliated keyword is considered as a regular
2147 ;; keyword. In this case AFFILIATED is nil, so we take care of
2148 ;; this corner case.
2161 :value value
2162 :begin begin
2163 :end end
2169 "Interpret KEYWORD element as Org syntax."
2175 ;;;; Latex Environment
2179 "Regexp matching the beginning of a LaTeX environment.
2180 The environment is captured by the first group.
2186 "Format string matching the ending of a LaTeX environment.
2190 "Parse a LaTeX environment.
2192 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2193 the buffer position at the beginning of the first affiliated
2194 keyword and CDR is a plist of affiliated keywords along with
2195 their value.
2197 Return a list whose CAR is `latex-environment' and CDR is a plist
2198 containing `:begin', `:end', `:value', `:post-blank' and
2199 `:post-affiliated' keywords.
2201 Assume point is at the beginning of the latex environment."
2208 limit t))
2209 ;; Incomplete latex environment: parse it as a paragraph.
2219 :end end
2220 :value value
2226 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2230 ;;;; Node Property
2233 "Parse a node-property at point.
2235 LIMIT bounds the search.
2237 Return a list whose CAR is `node-property' and CDR is a plist
2238 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2239 `:post-affiliated' keywords."
2249 limit))))
2252 :value value
2253 :begin begin
2254 :end end
2259 "Interpret NODE-PROPERTY element as Org syntax."
2265 ;;;; Paragraph
2268 "Parse a paragraph.
2270 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2271 the buffer position at the beginning of the first affiliated
2272 keyword and CDR is a plist of affiliated keywords along with
2273 their value.
2275 Return a list whose CAR is `paragraph' and CDR is a plist
2276 containing `:begin', `:end', `:contents-begin' and
2277 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2279 Assume point is at the beginning of the paragraph."
2286 ;; A matching `org-element-paragraph-separate' is not
2287 ;; necessarily the end of the paragraph. In particular,
2288 ;; drawers, blocks or LaTeX environments opening lines
2289 ;; must be closed. Moreover keywords with a secondary
2290 ;; value must belong to "dual keywords".
2304 limit t)))
2310 limit t)))
2313 org-element-dual-keywords))
2314 ;; Everything else is unambiguous.
2327 :end end
2328 :contents-begin contents-begin
2329 :contents-end contents-end
2335 "Interpret paragraph element as Org syntax.
2336 CONTENTS is the contents of the element."
2337 contents)
2340 ;;;; Planning
2343 "Parse a planning.
2345 LIMIT bounds the search.
2347 Return a list whose CAR is `planning' and CDR is a plist
2348 containing `:closed', `:deadline', `:scheduled', `:begin',
2349 `:end', `:post-blank' and `:post-affiliated' keywords."
2359 closed deadline scheduled)
2371 :deadline deadline
2372 :scheduled scheduled
2373 :begin begin
2374 :end end
2375 :post-blank post-blank
2379 "Interpret PLANNING element as Org syntax."
2381 #'identity
2398 ;;;; Src Block
2401 "Parse a src block.
2403 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2404 the buffer position at the beginning of the first affiliated
2405 keyword and CDR is a plist of affiliated keywords along with
2406 their value.
2408 Return a list whose CAR is `src-block' and CDR is a plist
2409 containing `:language', `:switches', `:parameters', `:begin',
2410 `:end', `:number-lines', `:retain-labels', `:use-labels',
2411 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2412 `:post-affiliated' keywords.
2414 Assume point is at the beginning of the block."
2417 limit t)))
2418 ;; Incomplete block: parse it as a paragraph.
2424 ;; Get language as a string.
2433 ;; Get switches.
2435 ;; Get parameters.
2437 ;; Switches analysis.
2441 switches)
2444 'new
2447 ;; Subtract 1 to give number of lines before
2448 ;; first line.
2456 ;; Should labels be retained in (or stripped from)
2457 ;; src blocks?
2462 ;; What should code-references use - labels or
2463 ;; line-numbers?
2468 ;; Retrieve code.
2475 ;; Get position after ending blank lines.
2485 :begin begin
2486 :end end
2487 :number-lines number-lines
2488 :preserve-indent preserve-indent
2489 :retain-labels retain-labels
2490 :use-labels use-labels
2491 :label-fmt label-fmt
2492 :value value
2498 "Interpret SRC-BLOCK element as Org syntax."
2507 val)
2522 ;;;; Table
2525 "Parse a table at point.
2527 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2528 the buffer position at the beginning of the first affiliated
2529 keyword and CDR is a plist of affiliated keywords along with
2530 their value.
2532 Return a list whose CAR is `table' and CDR is a plist containing
2533 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2534 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2535 keywords.
2537 Assume point is at the beginning of the table."
2553 acc))
2560 :end end
2561 :type type
2562 :tblfm tblfm
2563 ;; Only `org' tables have contents. `table.el' tables
2564 ;; use a `:value' property to store raw table as
2565 ;; a string.
2570 table-begin table-end))
2576 "Interpret TABLE element as Org syntax.
2577 CONTENTS is a string, if table's type is `org', or nil."
2588 ;;;; Table Row
2591 "Parse table row at point.
2593 Return a list whose CAR is `table-row' and CDR is a plist
2594 containing `:begin', `:end', `:contents-begin', `:contents-end',
2595 `:type', `:post-blank' and `:post-affiliated' keywords."
2599 ;; A table rule has no contents. In that case, ensure
2600 ;; CONTENTS-BEGIN matches CONTENTS-END.
2610 :begin begin
2611 :end end
2612 :contents-begin contents-begin
2613 :contents-end contents-end
2618 "Interpret TABLE-ROW element as Org syntax.
2619 CONTENTS is the contents of the table row."
2624 ;;;; Verse Block
2627 "Parse a verse block.
2629 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2630 the buffer position at the beginning of the first affiliated
2631 keyword and CDR is a plist of affiliated keywords along with
2632 their value.
2634 Return a list whose CAR is `verse-block' and CDR is a plist
2635 containing `:begin', `:end', `:contents-begin', `:contents-end',
2636 `:post-blank' and `:post-affiliated' keywords.
2638 Assume point is at beginning of the block."
2642 ;; Incomplete block: parse it as a paragraph.
2657 :end end
2658 :contents-begin contents-begin
2659 :contents-end contents-end
2665 "Interpret verse-block element as Org syntax.
2666 CONTENTS is verse block contents."
2670 \f
2671 ;;; Objects
2672 ;;
2673 ;; Unlike to elements, raw text can be found between objects. Hence,
2674 ;; `org-element--object-lex' is provided to find the next object in
2675 ;; buffer.
2676 ;;
2677 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2678 ;; object types they can contain will be specified in
2679 ;; `org-element-object-restrictions'.
2680 ;;
2681 ;; Creating a new type of object requires to alter
2682 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2683 ;; new type in `org-element-all-objects', and possibly add
2684 ;; restrictions in `org-element-object-restrictions'.
2686 ;;;; Bold
2689 "Parse bold object at point, if any.
2691 When at a bold object, return a list whose car is `bold' and cdr
2692 is a plist with `:begin', `:end', `:contents-begin' and
2693 `:contents-end' and `:post-blank' keywords. Otherwise, return
2694 nil.
2696 Assume point is at the first star marker."
2708 :end end
2709 :contents-begin contents-begin
2710 :contents-end contents-end
2714 "Interpret bold object as Org syntax.
2715 CONTENTS is the contents of the object."
2719 ;;;; Code
2722 "Parse code object at point, if any.
2724 When at a code object, return a list whose car is `code' and cdr
2725 is a plist with `:value', `:begin', `:end' and `:post-blank'
2726 keywords. Otherwise, return nil.
2728 Assume point is at the first tilde marker."
2739 :begin begin
2740 :end end
2744 "Interpret CODE object as Org syntax."
2748 ;;;; Entity
2751 "Parse entity at point, if any.
2753 When at an entity, return a list whose car is `entity' and cdr
2754 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2755 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2756 `:post-blank' as keywords. Otherwise, return nil.
2758 Assume point is at the beginning of the entity."
2760 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2778 :begin begin
2779 :end end
2780 :use-brackets-p bracketsp
2784 "Interpret ENTITY object as Org syntax."
2790 ;;;; Export Snippet
2793 "Parse export snippet at point.
2795 When at an export snippet, return a list whose car is
2796 `export-snippet' and cdr a plist with `:begin', `:end',
2797 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2798 return nil.
2800 Assume point is at the beginning of the snippet."
2816 :value value
2817 :begin begin
2818 :end end
2822 "Interpret EXPORT-SNIPPET object as Org syntax."
2828 ;;;; Footnote Reference
2831 "Parse footnote reference at point, if any.
2833 When at a footnote reference, return a list whose car is
2834 `footnote-reference' and cdr a plist with `:label', `:type',
2835 `:begin', `:end', `:content-begin', `:contents-end' and
2836 `:post-blank' as keywords. Otherwise, return nil."
2852 :type type
2853 :begin begin
2854 :end end
2860 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2861 CONTENTS is its definition, when inline, or nil."
2867 ;;;; Inline Babel Call
2870 "Parse inline babel call at point, if any.
2872 When at an inline babel call, return a list whose car is
2873 `inline-babel-call' and cdr a plist with `:call',
2874 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2875 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2877 Assume point is at the beginning of the babel call."
2891 ;; Parenthesis are mandatory.
2902 :inside-header inside-header
2903 :arguments arguments
2904 :end-header end-header
2905 :begin begin
2906 :end end
2907 :value value
2911 "Interpret INLINE-BABEL-CALL object as Org syntax."
2921 ;;;; Inline Src Block
2924 "Parse inline source block at point, if any.
2926 When at an inline source block, return a list whose car is
2927 `inline-src-block' and cdr a plist with `:begin', `:end',
2928 `:language', `:value', `:parameters' and `:post-blank' as
2929 keywords. Otherwise, return nil.
2931 Assume point is at the beginning of the inline src block."
2948 :value value
2949 :parameters parameters
2950 :begin begin
2955 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2960 language
2962 body)))
2964 ;;;; Italic
2967 "Parse italic object at point, if any.
2969 When at an italic object, return a list whose car is `italic' and
2970 cdr is a plist with `:begin', `:end', `:contents-begin' and
2971 `:contents-end' and `:post-blank' keywords. Otherwise, return
2972 nil.
2974 Assume point is at the first slash marker."
2986 :end end
2987 :contents-begin contents-begin
2988 :contents-end contents-end
2992 "Interpret italic object as Org syntax.
2993 CONTENTS is the contents of the object."
2997 ;;;; Latex Fragment
3000 "Parse LaTeX fragment at point, if any.
3002 When at a LaTeX fragment, return a list whose car is
3003 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3004 and `:post-blank' as keywords. Otherwise, return nil.
3006 Assume point is at the beginning of the LaTeX fragment."
3017 ;; Macro.
3040 :begin begin
3041 :end end
3045 "Interpret LATEX-FRAGMENT object as Org syntax."
3048 ;;;; Line Break
3051 "Parse line break at point, if any.
3053 When at a line break, return a list whose car is `line-break',
3054 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3055 Otherwise, return nil.
3057 Assume point is at the beginning of the line break."
3066 "Interpret LINE-BREAK object as Org syntax."
3070 ;;;; Link
3073 "Parse link at point, if any.
3075 When at a link, return a list whose car is `link' and cdr a plist
3076 with `:type', `:path', `:format', `:raw-link', `:application',
3077 `:search-option', `:begin', `:end', `:contents-begin',
3078 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3079 nil.
3081 Assume point is at the beginning of the link."
3084 end contents-begin contents-end link-end post-blank path type format
3085 raw-link search-option application)
3087 ;; Type 1: Text targeted from a radio target.
3097 ;; Type 2: Standard link, i.e. [[https://orgmode.org][homepage]]
3103 ;; RAW-LINK is the original link. Expand any
3104 ;; abbreviation in it.
3105 ;;
3106 ;; Also treat any newline character and associated
3107 ;; indentation as a single space character. This is not
3108 ;; compatible with RFC 3986, which requires to ignore
3109 ;; them altogether. However, doing so would require
3110 ;; users to encode spaces on the fly when writing links
3111 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3112 ;; [[shell:ls *.org]], which defeats Org's focus on
3113 ;; simplicity.
3118 ;; Determine TYPE of link and set PATH accordingly. According
3119 ;; to RFC 3986, remove whitespaces from URI in external links.
3120 ;; In internal ones, treat indentation as a single space.
3122 ;; File type.
3127 ;; Explicit type (http, irc, bbdb...).
3131 ;; Code-ref type: PATH is the name of the reference.
3136 ;; Custom-id type: PATH is the name of the custom id.
3140 ;; Fuzzy type: Internal link either matches a target, an
3141 ;; headline name or nothing. PATH is the target or
3142 ;; headline's name.
3146 ;; Type 3: Plain link, e.g., https://orgmode.org
3153 ;; Type 4: Angular link, e.g., <https://orgmode.org>. Unlike to
3154 ;; bracket links, follow RFC 3986 and remove any extra
3155 ;; whitespace in URI.
3166 ;; In any case, deduce end point after trailing white space from
3167 ;; LINK-END variable.
3172 ;; Special "file" type link processing. Extract opening
3173 ;; application and search option, if any. Also normalize URI.
3180 ;; Translate link, if `org-link-translation-function' is set.
3188 :path path
3189 :format format
3191 :application application
3192 :search-option search-option
3193 :begin begin
3194 :end end
3195 :contents-begin contents-begin
3196 :contents-end contents-end
3200 "Interpret LINK object as Org syntax.
3201 CONTENTS is the contents of the object, or nil."
3206 ;; Links with contents and internal links have to
3207 ;; use bracket syntax. Ignore `:format' in these
3208 ;; cases. This is also the default syntax when the
3209 ;; property is not defined, e.g., when the object
3210 ;; was crafted by the user.
3213 ;; Since this is going to be used as
3214 ;; a format string, escape percent signs
3215 ;; in description.
3218 `nil
3221 ;; Otherwise, just obey to `:format'.
3233 path
3239 ;;;; Macro
3242 "Parse macro at point, if any.
3244 When at a macro, return a list whose car is `macro' and cdr
3245 a plist with `:key', `:args', `:begin', `:end', `:value' and
3246 `:post-blank' as keywords. Otherwise, return nil.
3248 Assume point is at the macro."
3264 :value value
3265 :args args
3266 :begin begin
3267 :end end
3271 "Interpret MACRO object as Org syntax."
3279 ;;;; Radio-target
3282 "Parse radio target at point, if any.
3284 When at a radio target, return a list whose car is `radio-target'
3285 and cdr a plist with `:begin', `:end', `:contents-begin',
3286 `:contents-end', `:value' and `:post-blank' as keywords.
3287 Otherwise, return nil.
3289 Assume point is at the radio target."
3301 :end end
3302 :contents-begin contents-begin
3303 :contents-end contents-end
3304 :post-blank post-blank
3308 "Interpret target object as Org syntax.
3309 CONTENTS is the contents of the object."
3313 ;;;; Statistics Cookie
3316 "Parse statistics cookie at point, if any.
3318 When at a statistics cookie, return a list whose car is
3319 `statistics-cookie', and cdr a plist with `:begin', `:end',
3320 `:value' and `:post-blank' keywords. Otherwise, return nil.
3322 Assume point is at the beginning of the statistics-cookie."
3333 :end end
3334 :value value
3338 "Interpret STATISTICS-COOKIE object as Org syntax."
3342 ;;;; Strike-Through
3345 "Parse strike-through object at point, if any.
3347 When at a strike-through object, return a list whose car is
3348 `strike-through' and cdr is a plist with `:begin', `:end',
3349 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3350 Otherwise, return nil.
3352 Assume point is at the first plus sign marker."
3364 :end end
3365 :contents-begin contents-begin
3366 :contents-end contents-end
3370 "Interpret strike-through object as Org syntax.
3371 CONTENTS is the contents of the object."
3375 ;;;; Subscript
3378 "Parse subscript at point, if any.
3380 When at a subscript object, return a list whose car is
3381 `subscript' and cdr a plist with `:begin', `:end',
3382 `:contents-begin', `:contents-end', `:use-brackets-p' and
3383 `:post-blank' as keywords. Otherwise, return nil.
3385 Assume point is at the underscore."
3399 :end end
3400 :use-brackets-p bracketsp
3401 :contents-begin contents-begin
3402 :contents-end contents-end
3406 "Interpret SUBSCRIPT object as Org syntax.
3407 CONTENTS is the contents of the object."
3410 contents))
3413 ;;;; Superscript
3416 "Parse superscript at point, if any.
3418 When at a superscript object, return a list whose car is
3419 `superscript' and cdr a plist with `:begin', `:end',
3420 `:contents-begin', `:contents-end', `:use-brackets-p' and
3421 `:post-blank' as keywords. Otherwise, return nil.
3423 Assume point is at the caret."
3437 :end end
3438 :use-brackets-p bracketsp
3439 :contents-begin contents-begin
3440 :contents-end contents-end
3444 "Interpret SUPERSCRIPT object as Org syntax.
3445 CONTENTS is the contents of the object."
3448 contents))
3451 ;;;; Table Cell
3454 "Parse table cell at point.
3455 Return a list whose car is `table-cell' and cdr is a plist
3456 containing `:begin', `:end', `:contents-begin', `:contents-end'
3457 and `:post-blank' keywords."
3465 :end end
3466 :contents-begin contents-begin
3467 :contents-end contents-end
3471 "Interpret table-cell element as Org syntax.
3472 CONTENTS is the contents of the cell, or nil."
3476 ;;;; Target
3479 "Parse target at point, if any.
3481 When at a target, return a list whose car is `target' and cdr
3482 a plist with `:begin', `:end', `:value' and `:post-blank' as
3483 keywords. Otherwise, return nil.
3485 Assume point is at the target."
3495 :end end
3496 :value value
3500 "Interpret TARGET object as Org syntax."
3504 ;;;; Timestamp
3515 "Parse time stamp at point, if any.
3517 When at a time stamp, return a list whose car is `timestamp', and
3518 cdr a plist with `:type', `:raw-value', `:year-start',
3519 `:month-start', `:day-start', `:hour-start', `:minute-start',
3520 `:year-end', `:month-end', `:day-end', `:hour-end',
3521 `:minute-end', `:repeater-type', `:repeater-value',
3522 `:repeater-unit', `:warning-type', `:warning-value',
3523 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3524 Otherwise, return nil.
3526 Assume point is at the beginning of the timestamp."
3545 date-start)
3556 raw-value)
3558 :repeater-type
3564 :repeater-unit
3573 :warning-unit
3576 year-start month-start day-start hour-start minute-start year-end
3577 month-end day-end hour-end minute-end)
3578 ;; Parse date-start.
3586 ;; Compute date-end. It can be provided directly in time-stamp,
3587 ;; or extracted from time range. Otherwise, it defaults to the
3588 ;; same values as date-start.
3598 :raw-value raw-value
3599 :year-start year-start
3600 :month-start month-start
3601 :day-start day-start
3602 :hour-start hour-start
3603 :minute-start minute-start
3604 :year-end year-end
3605 :month-end month-end
3606 :day-end day-end
3607 :hour-end hour-end
3608 :minute-end minute-end
3609 :begin begin
3610 :end end
3612 repeater-props
3613 warning-props))))))
3616 "Interpret TIMESTAMP object as Org syntax."
3634 ;; Build an Org timestamp string from TIME. ACTIVEP is
3635 ;; non-nil when time stamp is active. If WITH-TIME-P is
3636 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3637 ;; specify a time range in the timestamp. REPEAT-STRING is
3638 ;; the repeater string, if any.
3642 org-time-stamp-formats)
3643 time)))
3649 nil nil ts)))
3654 " "
3655 s
3657 ;; Return value.
3658 ts)))
3670 build-ts-string
3689 0
3697 "--"
3710 ;;;; Underline
3713 "Parse underline object at point, if any.
3715 When at an underline object, return a list whose car is
3716 `underline' and cdr is a plist with `:begin', `:end',
3717 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3718 Otherwise, return nil.
3720 Assume point is at the first underscore marker."
3732 :end end
3733 :contents-begin contents-begin
3734 :contents-end contents-end
3738 "Interpret underline object as Org syntax.
3739 CONTENTS is the contents of the object."
3743 ;;;; Verbatim
3746 "Parse verbatim object at point, if any.
3748 When at a verbatim object, return a list whose car is `verbatim'
3749 and cdr is a plist with `:value', `:begin', `:end' and
3750 `:post-blank' keywords. Otherwise, return nil.
3752 Assume point is at the first equal sign marker."
3763 :begin begin
3764 :end end
3768 "Interpret VERBATIM object as Org syntax."
3772 \f
3773 ;;; Parsing Element Starting At Point
3774 ;;
3775 ;; `org-element--current-element' is the core function of this section.
3776 ;; It returns the Lisp representation of the element starting at
3777 ;; point.
3778 ;;
3779 ;; `org-element--current-element' makes use of special modes. They
3780 ;; are activated for fixed element chaining (e.g., `plain-list' >
3781 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3782 ;; `section'). Special modes are: `first-section', `item',
3783 ;; `node-property', `section' and `table-row'.
3786 "Parse the element starting at point.
3788 Return value is a list like (TYPE PROPS) where TYPE is the type
3789 of the element and PROPS a plist of properties associated to the
3790 element.
3792 Possible types are defined in `org-element-all-elements'.
3794 LIMIT bounds the search.
3796 Optional argument GRANULARITY determines the depth of the
3797 recursion. Allowed values are `headline', `greater-element',
3798 `element', `object' or nil. When it is broader than `object' (or
3799 nil), secondary values will not be parsed, since they only
3800 contain objects.
3802 Optional argument MODE, when non-nil, can be either
3803 `first-section', `section', `planning', `item', `node-property'
3804 and `table-row'.
3806 If STRUCTURE isn't provided but MODE is set to `item', it will be
3807 computed.
3809 This function assumes point is always at the beginning of the
3810 element it has to parse."
3813 ;; Determine if parsing depth allows for secondary strings
3814 ;; parsing. It only applies to elements referenced in
3815 ;; `org-element-secondary-value-alist'.
3818 ;; Item.
3821 ;; Table Row.
3823 ;; Node Property.
3825 ;; Headline.
3828 ;; Sections (must be checked after headline).
3833 limit)))
3834 ;; Planning.
3839 ;; Property drawer.
3845 ;; When not at bol, point is at the beginning of an item or
3846 ;; a footnote definition: next item is always a paragraph.
3848 ;; Clock.
3850 ;; Inlinetask.
3853 ;; From there, elements can have affiliated keywords.
3856 ;; Jumping over affiliated keywords put point off-limits.
3857 ;; Parse them as regular keywords.
3861 ;; LaTeX Environment.
3864 ;; Drawer and Property Drawer.
3867 ;; Fixed Width
3870 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3871 ;; Keywords.
3889 limit
3890 affiliated))
3903 ;; Footnote Definition.
3906 ;; Horizontal Rule.
3909 ;; Diary Sexp.
3912 ;; Table.
3915 ;; List.
3918 limit affiliated
3920 ;; Default element: Paragraph.
3924 ;; Most elements can have affiliated keywords. When looking for an
3925 ;; element beginning, we want to move before them, as they belong to
3926 ;; that element, and, in the meantime, collect information they give
3927 ;; into appropriate properties. Hence the following function.
3930 "Collect affiliated keywords from point down to LIMIT.
3932 Return a list whose CAR is the position at the first of them and
3933 CDR a plist of keywords and values and move point to the
3934 beginning of the first line after them.
3936 As a special case, if element doesn't start at the beginning of
3937 the line (e.g., a paragraph starting an item), CAR is current
3938 position of point and CDR is nil."
3942 ;; RESTRICT is the list of objects allowed in parsed
3943 ;; keywords value.
3945 output)
3948 ;; Apply translation to RAW-KWD. From there, KWD is
3949 ;; the official keyword.
3951 org-element-keyword-translation-alist))
3952 raw-kwd))
3953 ;; Find main value for any keyword.
3959 ;; PARSEDP is non-nil when keyword should have its
3960 ;; value parsed.
3962 ;; If KWD is a dual keyword, find its secondary
3963 ;; value. Maybe parse it.
3972 ;; Attribute a property name to KWD.
3974 ;; Now set final shape for VALUE.
3980 nil restrict)))
3984 ;; Attributes can always appear on multiple lines.
3987 ;; Eventually store the new value in OUTPUT.
3989 ;; Move to next keyword.
3991 ;; If affiliated keywords are orphaned: move back to first one.
3992 ;; They will be parsed as a paragraph.
3994 ;; Return value.
3998 \f
3999 ;;; The Org Parser
4000 ;;
4001 ;; The two major functions here are `org-element-parse-buffer', which
4002 ;; parses Org syntax inside the current buffer, taking into account
4003 ;; region, narrowing, or even visibility if specified, and
4004 ;; `org-element-parse-secondary-string', which parses objects within
4005 ;; a given string.
4006 ;;
4007 ;; The (almost) almighty `org-element-map' allows applying a function
4008 ;; on elements or objects matching some type, and accumulating the
4009 ;; resulting values. In an export situation, it also skips unneeded
4010 ;; parts of the parse tree.
4013 "Recursively parse the buffer and return structure.
4014 If narrowing is in effect, only parse the visible part of the
4015 buffer.
4017 Optional argument GRANULARITY determines the depth of the
4018 recursion. It can be set to the following symbols:
4020 `headline' Only parse headlines.
4021 `greater-element' Don't recurse into greater elements except
4022 headlines and sections. Thus, elements
4023 parsed are the top-level ones.
4024 `element' Parse everything but objects and plain text.
4025 `object' Parse the complete buffer (default).
4027 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4028 elements.
4030 An element or object is represented as a list with the
4031 pattern (TYPE PROPERTIES CONTENTS), where :
4033 TYPE is a symbol describing the element or object. See
4034 `org-element-all-elements' and `org-element-all-objects' for an
4035 exhaustive list of such symbols. One can retrieve it with
4036 `org-element-type' function.
4038 PROPERTIES is the list of attributes attached to the element or
4039 object, as a plist. Although most of them are specific to the
4040 element or object type, all types share `:begin', `:end',
4041 `:post-blank' and `:parent' properties, which respectively
4042 refer to buffer position where the element or object starts,
4043 ends, the number of white spaces or blank lines after it, and
4044 the element or object containing it. Properties values can be
4045 obtained by using `org-element-property' function.
4047 CONTENTS is a list of elements, objects or raw strings
4048 contained in the current element or object, when applicable.
4049 One can access them with `org-element-contents' function.
4051 The Org buffer has `org-data' as type and nil as properties.
4052 `org-element-map' function can be used to find specific elements
4053 or objects within the parse tree.
4055 This function assumes that current major mode is `org-mode'."
4061 ;; Start in `first-section' mode so text before the first
4062 ;; headline belongs to a section.
4066 "Recursively parse objects in STRING and return structure.
4068 RESTRICTION is a symbol limiting the object types that will be
4069 looked after.
4071 Optional argument PARENT, when non-nil, is the element or object
4072 containing the secondary string. It is used to set correctly
4073 `:parent' property within the string.
4075 If STRING is the empty string or nil, return nil."
4092 "Map a function on selected elements or objects.
4094 DATA is a parse tree, an element, an object, a string, or a list
4095 of such constructs. TYPES is a symbol or list of symbols of
4096 elements or objects types (see `org-element-all-elements' and
4097 `org-element-all-objects' for a complete list of types). FUN is
4098 the function called on the matching element or object. It has to
4099 accept one argument: the element or object itself.
4101 When optional argument INFO is non-nil, it should be a plist
4102 holding export options. In that case, parts of the parse tree
4103 not exportable according to that property list will be skipped.
4105 When optional argument FIRST-MATCH is non-nil, stop at the first
4106 match for which FUN doesn't return nil, and return that value.
4108 Optional argument NO-RECURSION is a symbol or a list of symbols
4109 representing elements or objects types. `org-element-map' won't
4110 enter any recursive element or object whose type belongs to that
4111 list. Though, FUN can still be applied on them.
4113 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4114 apply to matching objects within parsed affiliated keywords (see
4115 `org-element-parsed-keywords').
4117 Nil values returned from FUN do not appear in the results.
4120 Examples:
4121 ---------
4123 Assuming TREE is a variable containing an Org buffer parse tree,
4124 the following example will return a flat list of all `src-block'
4125 and `example-block' elements in it:
4129 The following snippet will find the first headline with a level
4133 (lambda (hl)
4134 (and (= (org-element-property :level hl) 1)
4136 (org-element-property :begin hl)))
4137 nil t)
4139 The next example will return a flat list of all `plain-list' type
4140 elements in TREE that are not a sub-list themselves:
4144 Eventually, this example will return a flat list of all `bold'
4145 type objects containing a `latex-snippet' type object, even
4146 looking into captions:
4149 (lambda (b)
4151 nil nil nil t)"
4152 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4156 ;; Recursion depth is determined by --CATEGORY.
4163 ;; If one object is found, the function has
4164 ;; to recurse into every object.
4167 ;; If one regular element is found, the
4168 ;; function has to recurse, at least, into
4169 ;; every element it encounters.
4172 --acc)
4175 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4176 ;; holding contextual information.
4180 ;; Ignored element in an export context.
4182 ;; List of elements or objects.
4184 ;; Unconditionally enter parse trees.
4188 ;; Check if TYPE is matching among TYPES. If so,
4189 ;; apply FUN to --DATA and accumulate return value
4190 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4196 ;; If --DATA has a secondary string that can contain
4197 ;; objects with their type among TYPES, look inside.
4200 org-element-secondary-value-alist)))
4202 ;; If --DATA has any parsed affiliated keywords and
4203 ;; WITH-AFFILIATED is non-nil, look for objects in
4204 ;; them.
4211 ;; Pay attention to the type of parsed
4212 ;; keyword. In particular, preserve order for
4213 ;; multiple keywords.
4226 ;; Determine if a recursion into --DATA is possible.
4228 ;; --TYPE is explicitly removed from recursion.
4230 ;; --DATA has no contents.
4232 ;; Looking for greater elements but --DATA is
4233 ;; simply an element or an object.
4236 ;; Looking for elements but --DATA is an object.
4239 ;; In any other case, map contents.
4243 ;; Return value in a proper order.
4247 ;; The following functions are internal parts of the parser.
4248 ;;
4249 ;; The first one, `org-element--parse-elements' acts at the element's
4250 ;; level.
4251 ;;
4252 ;; The second one, `org-element--parse-objects' applies on all objects
4253 ;; of a paragraph or a secondary string. It calls
4254 ;; `org-element--object-lex' to find the next object in the current
4255 ;; container.
4258 "Return next special mode according to TYPE, or nil.
4259 TYPE is a symbol representing the type of an element or object
4260 containing next element if PARENTP is non-nil, or before it
4261 otherwise. Modes can be either `first-section', `item',
4262 `node-property', `planning', `property-drawer', `section',
4263 `table-row' or nil."
4280 "Parse elements between BEG and END positions.
4282 MODE prioritizes some elements over the others. It can be set to
4283 `first-section', `section', `planning', `item', `node-property'
4284 or `table-row'.
4286 When value is `item', STRUCTURE will be used as the current list
4287 structure.
4289 GRANULARITY determines the depth of the recursion. See
4290 `org-element-parse-buffer' for more information.
4292 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4293 elements.
4295 Elements are accumulated into ACC."
4298 ;; Visible only: skip invisible parts at the beginning of the
4299 ;; element.
4302 ;; When parsing only headlines, skip any text before first one.
4307 ;; Find current element's type and parse it accordingly to
4308 ;; its category.
4310 end granularity mode structure))
4314 ;; Visible only: skip invisible parts between siblings.
4317 ;; Fill ELEMENT contents by side-effect.
4319 ;; If element has no contents, don't modify it.
4321 ;; Greater element: parse it between `contents-begin' and
4322 ;; `contents-end'. Make sure GRANULARITY allows the
4323 ;; recursion, or ELEMENT is a headline, in which case going
4324 ;; inside is mandatory, in order to get sub-level headings.
4332 ;; Possibly switch to a special mode.
4336 granularity visible-only element))
4337 ;; ELEMENT has contents. Parse objects inside, if
4338 ;; GRANULARITY allows it.
4344 ;; Update mode.
4346 ;; Return result.
4350 "Return next object in current buffer or nil.
4351 RESTRICTION is a list of object types, as symbols, that should be
4352 looked after. This function assumes that the buffer is narrowed
4353 to an appropriate container (e.g., a paragraph)."
4357 ;; Object regexp sometimes needs to have a peek at
4358 ;; a character ahead. Therefore, when there is a hard
4359 ;; limit, make it one more than the true beginning of the
4360 ;; radio target.
4367 nil)
4368 ;; Since we moved backward, we do not want to
4369 ;; match again an hypothetical 1-character long
4370 ;; radio link before us. Realizing that this can
4371 ;; only happen if such a radio link starts at
4372 ;; beginning of line, we prevent this here.
4378 found)
4444 ;; This is probably a plain link.
4454 "Parse objects between BEG and END and return recursive structure.
4456 Objects are accumulated in ACC. RESTRICTION is a list of object
4457 successors which are allowed in the current object.
4459 ACC becomes the parent for all parsed objects. However, if ACC
4460 is nil (i.e., a secondary string is being parsed) and optional
4461 argument PARENT is non-nil, use it as the parent for all objects.
4462 Eventually, if both ACC and PARENT are nil, the common parent is
4463 the list of objects itself."
4471 ;; Text before any object.
4476 contents))))
4477 ;; Object...
4482 ;; Fill contents of NEXT-OBJECT if possible.
4484 cont-beg
4486 next-object
4488 next-object)
4489 contents)
4491 ;; Text after last object.
4495 contents)))
4496 ;; Result. Set appropriate parent.
4504 \f
4505 ;;; Towards A Bijective Process
4506 ;;
4507 ;; The parse tree obtained with `org-element-parse-buffer' is really
4508 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4509 ;; interpreted and expanded into a string with canonical Org syntax.
4510 ;; Hence `org-element-interpret-data'.
4511 ;;
4512 ;; The function relies internally on
4513 ;; `org-element--interpret-affiliated-keywords'.
4515 ;;;###autoload
4517 "Interpret DATA as Org syntax.
4518 DATA is a parse tree, an element, an object or a secondary string
4519 to interpret. Return Org syntax as a string."
4523 ;; Find interpreter for current object or
4524 ;; element. If it doesn't exist (e.g. this is
4525 ;; a pseudo object or element), return contents,
4526 ;; if any.
4533 ;; Secondary string.
4536 data
4538 ;; Full Org document.
4543 ;; Plain text: return it.
4545 ;; Element or object without contents.
4548 ;; Element or object with contents.
4551 interpret
4552 data
4553 ;; Recursively interpret contents.
4558 data
4559 ;; Fix indentation of elements containing
4560 ;; objects. We ignore `table-row'
4561 ;; elements as they are one line long
4562 ;; anyway.
4564 data
4565 ;; When normalizing first paragraph of
4566 ;; an item or a footnote-definition,
4567 ;; ignore first line's indentation.
4576 ;; Build white spaces. If no `:post-blank' property
4577 ;; is specified, assume its value is 0.
4587 "Return ELEMENT's affiliated keywords as Org syntax.
4588 If there is no affiliated keyword, return the empty string."
4598 ": "
4601 value)
4609 ;; All attribute keywords can have multiple lines.
4615 ;; List all ELEMENT's properties matching an attribute line or an
4616 ;; affiliated keyword, but ignore translated keywords since they
4617 ;; cannot belong to the property list.
4624 org-element-keyword-translation-alist)))))
4625 collect prop)
4628 ;; Because interpretation of the parse tree must return the same
4629 ;; number of blank lines between elements and the same number of white
4630 ;; space after objects, some special care must be given to white
4631 ;; spaces.
4632 ;;
4633 ;; The first function, `org-element-normalize-string', ensures any
4634 ;; string different from the empty string will end with a single
4635 ;; newline character.
4636 ;;
4637 ;; The second function, `org-element-normalize-contents', removes
4638 ;; global indentation from the contents of the current element.
4641 "Ensure string S ends with a single newline character.
4643 If S isn't a string return it unchanged. If S is the empty
4644 string, return it. Otherwise, return a new string with a single
4645 newline character at its end."
4653 "Normalize plain text in ELEMENT's contents.
4655 ELEMENT must only contain plain text and objects.
4657 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4658 indentation to compute maximal common indentation.
4660 Return the normalized element that is element with global
4661 indentation removed from its contents."
4663 ;; Return minimal common indentation within BLOB. This is
4664 ;; done by walking recursively BLOB and updating MIN-IND
4665 ;; along the way. FIRST-FLAG is non-nil when the next
4666 ;; object is expected to be a string that doesn't start
4667 ;; with a newline character. It happens for strings at
4668 ;; the beginnings of the contents or right after a line
4669 ;; break.
4675 ;; Objects cannot start with spaces: in this
4676 ;; case, indentation is 0.
4717 ;; Build ELEMENT back, replacing each string with the same
4718 ;; string minus common indentation.
4721 ;; Return DATUM with all its strings indentation
4722 ;; shortened from MIN-IND white spaces.
4742 org-element-recursive-objects)
4746 datum)))
4750 \f
4751 ;;; Cache
4752 ;;
4753 ;; Implement a caching mechanism for `org-element-at-point' and
4754 ;; `org-element-context', which see.
4755 ;;
4756 ;; A single public function is provided: `org-element-cache-reset'.
4757 ;;
4758 ;; Cache is enabled by default, but can be disabled globally with
4759 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4760 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4761 ;; can be tweaked to control caching behaviour.
4762 ;;
4763 ;; Internally, parsed elements are stored in an AVL tree,
4764 ;; `org-element--cache'. This tree is updated lazily: whenever
4765 ;; a change happens to the buffer, a synchronization request is
4766 ;; registered in `org-element--cache-sync-requests' (see
4767 ;; `org-element--cache-submit-request'). During idle time, requests
4768 ;; are processed by `org-element--cache-sync'. Synchronization also
4769 ;; happens when an element is required from the cache. In this case,
4770 ;; the process stops as soon as the needed element is up-to-date.
4771 ;;
4772 ;; A synchronization request can only apply on a synchronized part of
4773 ;; the cache. Therefore, the cache is updated at least to the
4774 ;; location where the new request applies. Thus, requests are ordered
4775 ;; from left to right and all elements starting before the first
4776 ;; request are correct. This property is used by functions like
4777 ;; `org-element--cache-find' to retrieve elements in the part of the
4778 ;; cache that can be trusted.
4779 ;;
4780 ;; A request applies to every element, starting from its original
4781 ;; location (or key, see below). When a request is processed, it
4782 ;; moves forward and may collide the next one. In this case, both
4783 ;; requests are merged into a new one that starts from that element.
4784 ;; As a consequence, the whole synchronization complexity does not
4785 ;; depend on the number of pending requests, but on the number of
4786 ;; elements the very first request will be applied on.
4787 ;;
4788 ;; Elements cannot be accessed through their beginning position, which
4789 ;; may or may not be up-to-date. Instead, each element in the tree is
4790 ;; associated to a key, obtained with `org-element--cache-key'. This
4791 ;; mechanism is robust enough to preserve total order among elements
4792 ;; even when the tree is only partially synchronized.
4796 "Non-nil when Org parser should cache its results.
4798 WARNING: for the time being, using cache sometimes triggers
4799 freezes. Therefore, it is disabled by default. Activate it if
4806 "Maximum duration, as a time value, for a cache synchronization.
4807 If the synchronization is not over after this delay, the process
4808 pauses and resumes after `org-element-cache-sync-break'
4812 "Duration, as a time value, of the pause between synchronizations.
4816 ;;;; Data Structure
4819 "AVL tree used to cache elements.
4820 Each node of the tree contains an element. Comparison is done
4821 with `org-element--cache-compare'. This cache is used in
4825 "List of pending synchronization requests.
4827 A request is a vector with the following pattern:
4829 \[NEXT BEG END OFFSET PARENT PHASE]
4831 Processing a synchronization request consists of three phases:
4833 0. Delete modified elements,
4834 1. Fill missing area in cache,
4835 2. Shift positions and re-parent elements after the changes.
4837 During phase 0, NEXT is the key of the first element to be
4838 removed, BEG and END is buffer position delimiting the
4839 modifications. Elements starting between them (inclusive) are
4840 removed. So are elements whose parent is removed. PARENT, when
4841 non-nil, is the parent of the first element to be removed.
4843 During phase 1, NEXT is the key of the next known element in
4844 cache and BEG its beginning position. Parse buffer between that
4845 element and the one before it in order to determine the parent of
4846 the next element. Set PARENT to the element containing NEXT.
4848 During phase 2, NEXT is the key of the next element to shift in
4849 the parse tree. All elements starting from this one have their
4850 properties relatives to buffer positions shifted by integer
4851 OFFSET and, if they belong to element PARENT, are adopted by it.
4859 "Hash table used to store keys during synchronization.
4863 "Return a unique key for ELEMENT in cache tree.
4865 Keys are used to keep a total order among elements in the cache.
4866 Comparison is done with `org-element--cache-key-less-p'.
4868 When no synchronization is taking place, a key is simply the
4869 beginning position of the element, or that position plus one in
4870 the case of an first item (respectively row) in
4871 a list (respectively a table).
4873 During a synchronization, the key is the one the element had when
4874 the cache was synchronized for the last time. Elements added to
4875 cache during the synchronization get a new key generated with
4876 `org-element--cache-generate-key'.
4878 Such keys are stored in `org-element--cache-sync-keys'. The hash
4879 table is cleared once the synchronization is complete."
4882 ;; Increase beginning position of items (respectively
4883 ;; table rows) by one, so the first item can get
4884 ;; a different key from its parent list (respectively
4885 ;; table).
4888 begin)))
4891 key))))
4894 "Generate a key between LOWER and UPPER.
4896 LOWER and UPPER are integers or lists, possibly empty.
4898 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4899 a unique key, as an integer or a list of integers, according to
4900 the following rules:
4902 - LOWER and UPPER are compared level-wise until values differ.
4904 - If, at a given level, LOWER and UPPER differ from more than
4905 2, the new key shares all the levels above with LOWER and
4906 gets a new level. Its value is the mean between LOWER and
4907 UPPER:
4909 (1 2) + (1 4) --> (1 3)
4911 - If LOWER has no value to compare with, it is assumed that its
4912 value is `most-negative-fixnum'. E.g.,
4914 (1 1) + (1 1 2)
4916 is equivalent to
4918 (1 1 m) + (1 1 2)
4920 where m is `most-negative-fixnum'. Likewise, if UPPER is
4921 short of levels, the current value is `most-positive-fixnum'.
4923 - If they differ from only one, the new key inherits from
4924 current LOWER level and fork it at the next level. E.g.,
4926 (2 1) + (3 3)
4928 is equivalent to
4930 (2 1) + (2 M)
4932 where M is `most-positive-fixnum'.
4934 - If the key is only one level long, it is returned as an
4935 integer:
4937 (1 2) + (3 2) --> 2
4939 When they are not equals, the function assumes that LOWER is
4940 lesser than UPPER, per `org-element--cache-key-less-p'."
4944 skip-upper key)
4955 ;; When at a given level, LOWER and UPPER differ from
4956 ;; 1, ignore UPPER altogether. Instead create a key
4957 ;; between LOWER and the greatest key with the same
4958 ;; prefix as LOWER so far.
4964 "Non-nil if key A is less than key B.
4965 A and B are either integers or lists of integers, as returned by
4966 `org-element--cache-key'."
4974 ;; If A is empty, either keys are equal (B is also empty) and
4975 ;; we return nil, or A is lesser than B (B is longer) and we
4976 ;; return a non-nil value.
4977 ;;
4978 ;; If A is not empty, B is necessarily empty and A is greater
4979 ;; than B (A is longer). Therefore, return nil.
4983 "Non-nil when element A is located before element B."
4988 "Return root value in cache.
4989 This function assumes `org-element--cache' is a valid AVL tree."
4993 ;;;; Tools
4996 "Non-nil when cache is active in current buffer."
4998 org-element--cache
5002 "Find element in cache starting at POS or before.
5004 POS refers to a buffer position.
5006 When optional argument SIDE is non-nil, the function checks for
5007 elements starting at or past POS instead. If SIDE is `both', the
5008 function returns a cons cell where car is the first element
5009 starting at or before POS and cdr the first element starting
5010 after POS.
5012 The function can only find elements in the synchronized part of
5013 the cache."
5017 lower upper)
5032 ;; We found an element in cache starting at POS. If `side'
5033 ;; is `both' we also want the next one in order to generate
5034 ;; a key in-between.
5035 ;;
5036 ;; If the element is the first row or item in a table or
5037 ;; a plain list, we always return the table or the plain
5038 ;; list.
5039 ;;
5040 ;; In any other case, we return the element found.
5049 lower parent
5050 upper parent)))))
5053 lower element
5054 upper element)))))
5061 "Store ELEMENT in current buffer's cache, if allowed."
5064 ;; During synchronization, first build an appropriate key for
5065 ;; the new element so `avl-tree-enter' can insert it at the
5066 ;; right spot in the cache.
5075 org-element--cache-sync-keys)))
5079 "Remove ELEMENT from cache.
5080 Assume ELEMENT belongs to cache and that a cache is active."
5084 ;;;; Synchronization
5087 "Set idle timer for cache synchronization in BUFFER."
5094 org-element-cache-sync-idle-time))
5095 nil
5096 #'org-element--cache-sync
5097 buffer)))
5100 "Non-nil when synchronization process should be interrupted.
5101 TIME-LIMIT is a time value or nil."
5107 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5109 Properties containing buffer positions are `:begin', `:end',
5110 `:contents-begin', `:contents-end' and `:structure'. When
5111 optional argument PROPS is a list of keywords, only shift
5112 properties provided in that list.
5114 Properties are modified by side-effect."
5116 ;; Shift `:structure' property for the first plain list only: it
5117 ;; is the only one that really matters and it prevents from
5118 ;; shifting it more than once.
5132 "Synchronize cache with recent modification in BUFFER.
5134 When optional argument THRESHOLD is non-nil, do the
5135 synchronization for all elements starting before or at threshold,
5136 then exit. Otherwise, synchronize cache for as long as
5137 `org-element-cache-sync-duration' or until Emacs leaves idle
5138 state.
5140 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5141 not registered yet in the cache are going to happen. It is used
5142 in `org-element--cache-submit-request', where cache is partially
5143 updated before current modification are actually submitted."
5154 request
5156 threshold
5159 org-element-cache-sync-duration))
5160 future-change)
5161 ;; Request processed. Merge current and next offsets and
5162 ;; transfer ending position.
5168 ;; If more requests are awaiting, set idle timer accordingly.
5169 ;; Otherwise, reset keys.
5176 "Process synchronization REQUEST for all entries before NEXT.
5178 REQUEST is a vector, built by `org-element--cache-submit-request'.
5180 NEXT is a cache key, as returned by `org-element--cache-key'.
5182 When non-nil, THRESHOLD is a buffer position. Synchronization
5183 stops as soon as a shifted element begins after it.
5185 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5186 after this time or when Emacs exits idle state.
5188 When non-nil, FUTURE-CHANGE is a buffer position where changes
5189 not registered yet in the cache are going to happen. See
5190 `org-element--cache-submit-request' for more information.
5192 Throw `interrupt' if the process stops before completing the
5193 request."
5196 ;; Phase 0.
5197 ;;
5198 ;; Delete all elements starting after BEG, but not after buffer
5199 ;; position END or past element with key NEXT. Also delete
5200 ;; elements contained within a previously removed element
5201 ;; (stored in `last-container').
5202 ;;
5203 ;; At each iteration, we start again at tree root since
5204 ;; a deletion modifies structure of the balanced tree.
5209 ;; Find first element in cache with key BEG or after it.
5213 data data-key last-container)
5222 data-key key
5225 data-key key
5226 node nil)))))
5236 up)))
5239 end))
5246 ;; No element starting after modifications left in
5247 ;; cache: further processing is futile.
5250 ;; Phase 1.
5251 ;;
5252 ;; Phase 0 left a hole in the cache. Some elements after it
5253 ;; could have parents within. For example, in the following
5254 ;; buffer:
5255 ;;
5256 ;; - item
5257 ;;
5258 ;;
5259 ;; Paragraph1
5260 ;;
5261 ;; Paragraph2
5262 ;;
5263 ;; if we remove a blank line between "item" and "Paragraph1",
5264 ;; everything down to "Paragraph2" is removed from cache. But
5265 ;; the paragraph now belongs to the list, and its `:parent'
5266 ;; property no longer is accurate.
5267 ;;
5268 ;; Therefore we need to parse again elements in the hole, or at
5269 ;; least in its last section, so that we can re-parent
5270 ;; subsequent elements, during phase 2.
5271 ;;
5272 ;; Note that we only need to get the parent from the first
5273 ;; element in cache after the hole.
5274 ;;
5275 ;; When next key is lesser or equal to the current one, delegate
5276 ;; phase 1 processing to next request in order to preserve key
5277 ;; order among requests.
5285 ;; Next element will start at its beginning position plus
5286 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5287 ;; contains the real beginning position of the first element to
5288 ;; shift and re-parent.
5292 ;; Changes are going to happen around this element and
5293 ;; they will trigger another phase 1 request. Skip the
5294 ;; current one.
5300 ;; Phase 2.
5301 ;;
5302 ;; Shift all elements starting from key START, but before NEXT, by
5303 ;; OFFSET, and re-parent them when appropriate.
5304 ;;
5305 ;; Elements are modified by side-effect so the tree structure
5306 ;; remains intact.
5307 ;;
5308 ;; Once THRESHOLD, if any, is reached, or once there is an input
5309 ;; pending, exit. Before leaving, the current synchronization
5310 ;; request is updated.
5317 exit-flag)
5318 ;; No re-parenting nor shifting planned: request is over.
5328 ;; We reached NEXT. Request is complete.
5330 ;; Handle interruption request. Update current request.
5335 ;; Shift element.
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."
5713 ;;;###autoload
5715 "Refresh cache at position POS."
5722 \f
5723 ;;; The Toolbox
5724 ;;
5725 ;; The first move is to implement a way to obtain the smallest element
5726 ;; containing point. This is the job of `org-element-at-point'. It
5727 ;; basically jumps back to the beginning of section containing point
5728 ;; and proceed, one element after the other, with
5729 ;; `org-element--current-element' until the container is found. Note:
5730 ;; When using `org-element-at-point', secondary values are never
5731 ;; parsed since the function focuses on elements, not on objects.
5732 ;;
5733 ;; At a deeper level, `org-element-context' lists all elements and
5734 ;; objects containing point.
5735 ;;
5736 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5737 ;; internally by navigation and manipulation tools.
5740 ;;;###autoload
5742 "Determine closest element around point.
5744 Return value is a list like (TYPE PROPS) where TYPE is the type
5745 of the element and PROPS a plist of properties associated to the
5746 element.
5748 Possible types are defined in `org-element-all-elements'.
5749 Properties depend on element or object type, but always include
5750 `:begin', `:end', `:parent' and `:post-blank' properties.
5752 As a special case, if point is at the very beginning of the first
5753 item in a list or sub-list, returned element will be that list
5754 instead of the item. Likewise, if point is at the beginning of
5755 the first row of a table, returned element will be the table
5756 instead of the first row.
5758 When point is at the end of the buffer, return the innermost
5759 element ending there."
5765 ;; Within blank lines at the beginning of buffer, return nil.
5767 ;; Within blank lines right after a headline, return that
5768 ;; headline.
5772 ;; Otherwise parse until we find element containing ORIGIN.
5779 ;;;###autoload
5781 "Return smallest element or object around point.
5783 Return value is a list like (TYPE PROPS) where TYPE is the type
5784 of the element or object and PROPS a plist of properties
5785 associated to it.
5787 Possible types are defined in `org-element-all-elements' and
5788 `org-element-all-objects'. Properties depend on element or
5789 object type, but always include `:begin', `:end', `:parent' and
5790 `:post-blank'.
5792 As a special case, if point is right after an object and not at
5793 the beginning of any other object, return that object.
5795 Optional argument ELEMENT, when non-nil, is the closest element
5796 containing point, as returned by `org-element-at-point'.
5797 Providing it allows for quicker computation."
5804 ;; If point is inside an element containing objects or
5805 ;; a secondary string, narrow buffer to the container and
5806 ;; proceed with parsing. Otherwise, return ELEMENT.
5808 ;; At a parsed affiliated keyword, check if we're inside main
5809 ;; or dual value.
5815 org-element-parsed-keywords))
5824 ;; Also change type to retrieve correct restrictions.
5826 ;; At an item, objects can only be located within tag, if any.
5837 ;; At an headline or inlinetask, objects are in title.
5849 ;; At a paragraph, a table-row or a verse block, objects are
5850 ;; located within their contents.
5854 ;; CBEG is nil for table rules.
5863 last)
5868 ;; Process NEXT, if any, in order to know if we need to
5869 ;; skip it, return it or move into it.
5876 ;; Skip objects ending before point. Also skip
5877 ;; objects ending at point unless it is also the
5878 ;; end of buffer, since we want to return the
5879 ;; innermost object.
5882 ;; For convenience, when object ends at POS,
5883 ;; without any space, store it in LAST, as we
5884 ;; will return it if no object starts here.
5888 ;; If POS is within a container object, move into
5889 ;; that object.
5893 ;; At contents' end, if there is no
5894 ;; space before point, also move into
5895 ;; object, for consistency with
5896 ;; convenience feature above.
5905 ;; Otherwise, return NEXT.
5909 "List all ancestors of a given element or object.
5911 DATUM is an object or element.
5913 Return ancestors from the closest to the farthest. When optional
5914 argument TYPES is a list of symbols, return the first element or
5915 object in the lineage whose type belongs to that list instead.
5917 When optional argument WITH-SELF is non-nil, lineage includes
5918 DATUM itself as the first element, and TYPES, if provided, also
5919 apply to it.
5921 When DATUM is obtained through `org-element-context' or
5922 `org-element-at-point', only ancestors from its section can be
5923 found. There is no such limitation when DATUM belongs to a full
5924 parse tree."
5926 ancestors)
5933 "Non-nil when elements ELEM-A and ELEM-B are nested."
5942 "Swap elements ELEM-A and ELEM-B.
5943 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5944 end of ELEM-A."
5946 ;; There are two special cases when an element doesn't start at bol:
5947 ;; the first paragraph in an item or in a footnote definition.
5949 ;; Only a paragraph without any affiliated keyword can be moved at
5950 ;; ELEM-A position in such a situation. Note that the case of
5951 ;; a footnote definition is impossible: it cannot contain two
5952 ;; paragraphs in a row because it cannot contain a blank line.
5958 ;; In a special situation, ELEM-A will have no indentation. We'll
5959 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5973 ;; Store inner overlays responsible for visibility status.
5974 ;; We also need to store their boundaries as they will be
5975 ;; removed from buffer.
5990 ;; Get contents.
5998 ;; Restore ex ELEM-A overlays.
6005 ;; Restore ex ELEM-B overlays.
6013 ;; Local variables:
6014 ;; generated-autoload-file: "org-loaddefs.el"
6015 ;; End:
6017 ;;; org-element.el ends here