| blob | d9c6522e2f0c15360f1a4c83dce865b60f5a90ae |
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', `:post-blank' and `:post-affiliated' keywords.
817 Assume point is at the beginning of the footnote definition."
829 limit)
831 ;; At a new footnote definition, make sure we end
832 ;; before any affiliated keyword above.
854 :begin begin
855 :end end
856 :contents-begin contents-begin
863 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
864 CONTENTS is the contents of the footnote-definition."
866 " "
867 contents))
870 ;;;; Headline
873 "Return node properties associated to headline at point.
874 Upcase property names. It avoids confusion between properties
875 obtained through property drawer and default properties from the
876 parser (e.g. `:end' and :END:). Return value is a plist."
888 properties))))
891 "Return time properties associated to headline at point.
892 Return value is a plist."
906 plist))))
909 "Parse a headline.
911 Return a list whose CAR is `headline' and CDR is a plist
912 containing `:raw-value', `:title', `:begin', `:end',
913 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
914 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
915 `:deadline', `:closed', `:archivedp', `:commentedp'
916 `:footnote-section-p', `:post-blank' and `:post-affiliated'
917 keywords.
919 The plist also contains any property set in the property drawer,
920 with its name in upper cases and colons added at the
921 beginning (e.g., `:CUSTOM_ID').
923 LIMIT is a buffer position bounding the search.
925 When RAW-SECONDARY-P is non-nil, headline's title will not be
926 parsed as a secondary string, but as a plain string instead.
928 Assume point is at beginning of the headline."
974 :begin begin
975 :end end
976 :pre-blank
979 :contents-begin contents-begin
980 :contents-end contents-end
981 :level level
982 :priority priority
983 :tags tags
984 :todo-keyword todo
985 :todo-type todo-type
986 :post-blank
990 :footnote-section-p footnote-section-p
991 :archivedp archivedp
992 :commentedp commentedp
994 time-props
995 standard-props))))
997 headline :title
1006 nil
1008 headline)))))))
1011 "Interpret HEADLINE element as Org syntax.
1012 CONTENTS is the contents of the element."
1025 ?*)
1029 " "
1032 org-footnote-section
1033 title))))
1035 heading
1036 ;; Align tags.
1044 ?\s)
1045 tags))
1049 tags))))
1051 contents)))
1054 ;;;; Inlinetask
1057 "Parse an inline task.
1059 Return a list whose CAR is `inlinetask' and CDR is a plist
1060 containing `:title', `:begin', `:end', `:pre-blank',
1061 `:contents-begin' and `:contents-end', `:level', `:priority',
1062 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1063 `:scheduled', `:deadline', `:closed', `:post-blank' and
1064 `:post-affiliated' keywords.
1066 The plist also contains any property set in the property drawer,
1067 with its name in upper cases and colons added at the
1068 beginning (e.g., `:CUSTOM_ID').
1070 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1071 title will not be parsed as a secondary string, but as a plain
1072 string instead.
1074 Assume point is at beginning of the inline task."
1121 :begin begin
1122 :end end
1123 :pre-blank
1126 :contents-begin contents-begin
1127 :contents-end contents-end
1128 :level level
1129 :priority priority
1130 :tags tags
1131 :todo-keyword todo
1132 :todo-type todo-type
1135 time-props
1136 standard-props))))
1138 inlinetask :title
1147 nil
1149 inlinetask))))))
1152 "Interpret INLINETASK element as Org syntax.
1153 CONTENTS is the contents of inlinetask."
1167 ;; Align tags.
1175 ? )
1176 tags))
1180 tags))))
1181 ;; Prefer degenerate inlinetasks when there are no
1182 ;; contents.
1185 contents
1189 ;;;; Item
1192 "Parse an item.
1194 STRUCT is the structure of the plain list.
1196 Return a list whose CAR is `item' and CDR is a plist containing
1197 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1198 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1199 `:post-affiliated' keywords.
1201 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1202 any, will not be parsed as a secondary string, but as a plain
1203 string instead.
1205 Assume point is at the beginning of the item."
1228 ;; Ignore tags in un-ordered lists: they are just
1229 ;; a part of item's body.
1236 ;; If first line isn't empty, contents really
1237 ;; start at the text after item's meta-data.
1247 :begin begin
1248 :end end
1249 :contents-begin contents-begin
1250 :contents-end contents-end
1251 :checkbox checkbox
1252 :counter counter
1253 :structure struct
1257 item :tag
1264 item))))))))
1267 "Interpret ITEM element as Org syntax.
1268 CONTENTS is the contents of the element."
1278 ;; Compute indentation.
1283 ;; Indent contents.
1285 bullet
1300 ;;;; Plain List
1303 ;; Return structure of list at point. Internal function. See
1304 ;; `org-list-struct' for details.
1309 items struct)
1314 ;; At limit: end all items.
1320 ;; At list end: end all items.
1324 ;; At a new item: end previous sibling.
1336 ind
1337 bullet
1340 ;; Description tag.
1344 ;; Ending position, unknown so far.
1345 nil)))
1346 items))
1348 ;; Skip empty lines.
1350 ;; Skip inline tasks and blank lines along the way.
1357 ;; At some text line. Check if it ends any previous item.
1371 ;; Skip blocks (any type) and drawers contents.
1376 limit t)))
1382 "Parse a plain list.
1384 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1385 the buffer position at the beginning of the first affiliated
1386 keyword and CDR is a plist of affiliated keywords along with
1387 their value. STRUCTURE is the structure of the plain list being
1388 parsed.
1390 Return a list whose CAR is `plain-list' and CDR is a plist
1391 containing `:type', `:begin', `:end', `:contents-begin' and
1392 `:contents-end', `:structure', `:post-blank' and
1393 `:post-affiliated' keywords.
1395 Assume point is at the beginning of the list."
1409 pos))
1413 ;; Return value.
1417 :begin begin
1418 :end end
1419 :contents-begin contents-begin
1420 :contents-end contents-end
1421 :structure struct
1427 "Interpret plain-list element as Org syntax.
1428 CONTENTS is the contents of the element."
1436 ;;;; Property Drawer
1439 "Parse a property drawer.
1441 LIMIT bounds the search.
1443 Return a list whose car is `property-drawer' and cdr is a plist
1444 containing `:begin', `:end', `:contents-begin', `:contents-end',
1445 `:post-blank' and `:post-affiliated' keywords.
1447 Assume point is at the beginning of the property drawer."
1460 :end end
1462 :contents-end contents-end
1467 "Interpret property-drawer element as Org syntax.
1468 CONTENTS is the properties within the drawer."
1472 ;;;; Quote Block
1475 "Parse a quote block.
1477 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1478 the buffer position at the beginning of the first affiliated
1479 keyword and CDR is a plist of affiliated keywords along with
1480 their value.
1482 Return a list whose CAR is `quote-block' and CDR is a plist
1483 containing `:begin', `:end', `:contents-begin', `:contents-end',
1484 `:post-blank' and `:post-affiliated' keywords.
1486 Assume point is at the beginning of the block."
1490 ;; Incomplete block: parse it as a paragraph.
1496 ;; Empty blocks have no contents.
1509 :end end
1510 :contents-begin contents-begin
1511 :contents-end contents-end
1517 "Interpret quote-block element as Org syntax.
1518 CONTENTS is the contents of the element."
1522 ;;;; Section
1525 "Parse a section.
1527 Return a list whose CAR is `section' and CDR is a plist
1528 containing `:begin', `:end', `:contents-begin', `contents-end',
1529 `:post-blank' and `:post-affiliated' keywords."
1531 ;; Beginning of section is the beginning of the first non-blank
1532 ;; line after previous headline.
1540 :end end
1541 :contents-begin begin
1542 :contents-end pos-before-blank
1547 "Interpret section element as Org syntax.
1548 CONTENTS is the contents of the element."
1549 contents)
1552 ;;;; Special Block
1555 "Parse a special block.
1557 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1558 the buffer position at the beginning of the first affiliated
1559 keyword and CDR is a plist of affiliated keywords along with
1560 their value.
1562 Return a list whose CAR is `special-block' and CDR is a plist
1563 containing `:type', `:begin', `:end', `:contents-begin',
1564 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1566 Assume point is at the beginning of the block."
1573 limit t)))
1574 ;; Incomplete block: parse it as a paragraph.
1580 ;; Empty blocks have no contents.
1593 :begin begin
1594 :end end
1595 :contents-begin contents-begin
1596 :contents-end contents-end
1602 "Interpret SPECIAL-BLOCK element as Org syntax.
1603 CONTENTS is the contents of the element."
1608 \f
1609 ;;; Elements
1610 ;;
1611 ;; For each element, a parser and an interpreter are also defined.
1612 ;; Both follow the same naming convention used for greater elements.
1613 ;;
1614 ;; Also, as for greater elements, adding a new element type is done
1615 ;; through the following steps: implement a parser and an interpreter,
1616 ;; tweak `org-element--current-element' so that it recognizes the new
1617 ;; type and add that new type to `org-element-all-elements'.
1620 ;;;; Babel Call
1623 "Parse a babel call.
1625 LIMIT bounds the search. AFFILIATED is a list of which car is
1626 the buffer position at the beginning of the first affiliated
1627 keyword and cdr is a plist of affiliated keywords along with
1628 their value.
1630 Return a list whose car is `babel-call' and cdr is a plist
1631 containing `:call', `:inside-header', `:arguments',
1632 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1633 `:post-affiliated' as keywords."
1661 :inside-header inside-header
1662 :arguments arguments
1663 :end-header end-header
1664 :begin begin
1665 :end end
1666 :value value
1672 "Interpret BABEL-CALL element as Org syntax."
1682 ;;;; Clock
1685 "Parse a clock.
1687 LIMIT bounds the search.
1689 Return a list whose CAR is `clock' and CDR is a plist containing
1690 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1691 `:post-affiliated' as keywords."
1711 :value value
1712 :duration duration
1713 :begin begin
1714 :end end
1715 :post-blank post-blank
1719 "Interpret CLOCK element as Org syntax."
1727 "%2s:%02s"
1731 ;;;; Comment
1734 "Parse a comment.
1736 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1737 the buffer position at the beginning of the first affiliated
1738 keyword and CDR is a plist of affiliated keywords along with
1739 their value.
1741 Return a list whose CAR is `comment' and CDR is a plist
1742 containing `:begin', `:end', `:value', `:post-blank',
1743 `:post-affiliated' keywords.
1745 Assume point is at comment beginning."
1754 ;; Get comments ending.
1757 ;; Accumulate lines without leading hash and first
1758 ;; whitespace.
1772 :end end
1773 :value value
1779 "Interpret COMMENT element as Org syntax.
1780 CONTENTS is nil."
1784 ;;;; Comment Block
1787 "Parse an export block.
1789 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1790 the buffer position at the beginning of the first affiliated
1791 keyword and CDR is a plist of affiliated keywords along with
1792 their value.
1794 Return a list whose CAR is `comment-block' and CDR is a plist
1795 containing `:begin', `:end', `:value', `:post-blank' and
1796 `:post-affiliated' keywords.
1798 Assume point is at comment block beginning."
1802 ;; Incomplete block: parse it as a paragraph.
1815 contents-begin contents-end)))
1819 :end end
1820 :value value
1826 "Interpret COMMENT-BLOCK element as Org syntax."
1833 ;;;; Diary Sexp
1836 "Parse a diary sexp.
1838 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1839 the buffer position at the beginning of the first affiliated
1840 keyword and CDR is a plist of affiliated keywords along with
1841 their value.
1843 Return a list whose CAR is `diary-sexp' and CDR is a plist
1844 containing `:begin', `:end', `:value', `:post-blank' and
1845 `:post-affiliated' keywords."
1857 :begin begin
1858 :end end
1864 "Interpret DIARY-SEXP as Org syntax."
1868 ;;;; Example Block
1871 "Parse an example block.
1873 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1874 the buffer position at the beginning of the first affiliated
1875 keyword and CDR is a plist of affiliated keywords along with
1876 their value.
1878 Return a list whose CAR is `example-block' and CDR is a plist
1879 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1880 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1881 `:value', `:post-blank' and `:post-affiliated' keywords."
1885 ;; Incomplete block: parse it as a paragraph.
1893 ;; Switches analysis.
1897 switches)
1900 'new
1903 ;; Subtract 1 to give number of lines before
1904 ;; first line.
1908 ;; Should labels be retained in (or stripped from) example
1909 ;; blocks?
1914 ;; What should code-references use - labels or
1915 ;; line-numbers?
1924 ;; Standard block parsing.
1930 contents-begin contents-end)))
1939 :end end
1940 :value value
1941 :switches switches
1942 :number-lines number-lines
1943 :preserve-indent preserve-indent
1944 :retain-labels retain-labels
1945 :use-labels use-labels
1946 :label-fmt label-fmt
1952 "Interpret EXAMPLE-BLOCK element as Org syntax."
1960 value
1965 ;;;; Export Block
1968 "Parse an export block.
1970 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1971 the buffer position at the beginning of the first affiliated
1972 keyword and CDR is a plist of affiliated keywords along with
1973 their value.
1975 Return a list whose CAR is `export-block' and CDR is a plist
1976 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1977 `:post-affiliated' keywords.
1979 Assume point is at export-block beginning."
1983 ;; Incomplete block: parse it as a paragraph.
2002 contents-end))))
2006 :begin begin
2007 :end end
2008 :value value
2014 "Interpret EXPORT-BLOCK element as Org syntax."
2020 ;;;; Fixed-width
2023 "Parse a fixed-width section.
2025 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2026 the buffer position at the beginning of the first affiliated
2027 keyword and CDR is a plist of affiliated keywords along with
2028 their value.
2030 Return a list whose CAR is `fixed-width' and CDR is a plist
2031 containing `:begin', `:end', `:value', `:post-blank' and
2032 `:post-affiliated' keywords.
2034 Assume point is at the beginning of the fixed-width area."
2038 value
2043 ;; Accumulate text without starting colons.
2056 :end end
2057 :value value
2063 "Interpret FIXED-WIDTH element as Org syntax."
2071 ;;;; Horizontal Rule
2074 "Parse an horizontal rule.
2076 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2077 the buffer position at the beginning of the first affiliated
2078 keyword and CDR is a plist of affiliated keywords along with
2079 their value.
2081 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2082 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2083 keywords."
2093 :end end
2099 "Interpret HORIZONTAL-RULE element as Org syntax."
2103 ;;;; Keyword
2106 "Parse a keyword at point.
2108 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2109 the buffer position at the beginning of the first affiliated
2110 keyword and CDR is a plist of affiliated keywords along with
2111 their value.
2113 Return a list whose CAR is `keyword' and CDR is a plist
2114 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2115 `:post-affiliated' keywords."
2117 ;; An orphaned affiliated keyword is considered as a regular
2118 ;; keyword. In this case AFFILIATED is nil, so we take care of
2119 ;; this corner case.
2132 :value value
2133 :begin begin
2134 :end end
2140 "Interpret KEYWORD element as Org syntax."
2146 ;;;; Latex Environment
2150 "Regexp matching the beginning of a LaTeX environment.
2151 The environment is captured by the first group.
2157 "Format string matching the ending of a LaTeX environment.
2161 "Parse a LaTeX environment.
2163 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2164 the buffer position at the beginning of the first affiliated
2165 keyword and CDR is a plist of affiliated keywords along with
2166 their value.
2168 Return a list whose CAR is `latex-environment' and CDR is a plist
2169 containing `:begin', `:end', `:value', `:post-blank' and
2170 `:post-affiliated' keywords.
2172 Assume point is at the beginning of the latex environment."
2179 limit t))
2180 ;; Incomplete latex environment: parse it as a paragraph.
2190 :end end
2191 :value value
2197 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2201 ;;;; Node Property
2204 "Parse a node-property at point.
2206 LIMIT bounds the search.
2208 Return a list whose CAR is `node-property' and CDR is a plist
2209 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2210 `:post-affiliated' keywords."
2220 limit))))
2223 :value value
2224 :begin begin
2225 :end end
2230 "Interpret NODE-PROPERTY element as Org syntax."
2236 ;;;; Paragraph
2239 "Parse a paragraph.
2241 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2242 the buffer position at the beginning of the first affiliated
2243 keyword and CDR is a plist of affiliated keywords along with
2244 their value.
2246 Return a list whose CAR is `paragraph' and CDR is a plist
2247 containing `:begin', `:end', `:contents-begin' and
2248 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2250 Assume point is at the beginning of the paragraph."
2257 ;; A matching `org-element-paragraph-separate' is not
2258 ;; necessarily the end of the paragraph. In particular,
2259 ;; drawers, blocks or LaTeX environments opening lines
2260 ;; must be closed. Moreover keywords with a secondary
2261 ;; value must belong to "dual keywords".
2275 limit t)))
2281 limit t)))
2284 org-element-dual-keywords))
2285 ;; Everything else is unambiguous.
2298 :end end
2299 :contents-begin contents-begin
2300 :contents-end contents-end
2306 "Interpret paragraph element as Org syntax.
2307 CONTENTS is the contents of the element."
2308 contents)
2311 ;;;; Planning
2314 "Parse a planning.
2316 LIMIT bounds the search.
2318 Return a list whose CAR is `planning' and CDR is a plist
2319 containing `:closed', `:deadline', `:scheduled', `:begin',
2320 `:end', `:post-blank' and `:post-affiliated' keywords."
2330 closed deadline scheduled)
2342 :deadline deadline
2343 :scheduled scheduled
2344 :begin begin
2345 :end end
2346 :post-blank post-blank
2350 "Interpret PLANNING element as Org syntax."
2352 #'identity
2369 ;;;; Src Block
2372 "Parse a src block.
2374 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2375 the buffer position at the beginning of the first affiliated
2376 keyword and CDR is a plist of affiliated keywords along with
2377 their value.
2379 Return a list whose CAR is `src-block' and CDR is a plist
2380 containing `:language', `:switches', `:parameters', `:begin',
2381 `:end', `:number-lines', `:retain-labels', `:use-labels',
2382 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2383 `:post-affiliated' keywords.
2385 Assume point is at the beginning of the block."
2388 limit t)))
2389 ;; Incomplete block: parse it as a paragraph.
2395 ;; Get language as a string.
2404 ;; Get switches.
2406 ;; Get parameters.
2408 ;; Switches analysis.
2412 switches)
2415 'new
2418 ;; Subtract 1 to give number of lines before
2419 ;; first line.
2427 ;; Should labels be retained in (or stripped from)
2428 ;; src blocks?
2433 ;; What should code-references use - labels or
2434 ;; line-numbers?
2439 ;; Retrieve code.
2446 ;; Get position after ending blank lines.
2456 :begin begin
2457 :end end
2458 :number-lines number-lines
2459 :preserve-indent preserve-indent
2460 :retain-labels retain-labels
2461 :use-labels use-labels
2462 :label-fmt label-fmt
2463 :value value
2469 "Interpret SRC-BLOCK element as Org syntax."
2478 val)
2493 ;;;; Table
2496 "Parse a table at point.
2498 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2499 the buffer position at the beginning of the first affiliated
2500 keyword and CDR is a plist of affiliated keywords along with
2501 their value.
2503 Return a list whose CAR is `table' and CDR is a plist containing
2504 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2505 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2506 keywords.
2508 Assume point is at the beginning of the table."
2524 acc))
2531 :end end
2532 :type type
2533 :tblfm tblfm
2534 ;; Only `org' tables have contents. `table.el' tables
2535 ;; use a `:value' property to store raw table as
2536 ;; a string.
2541 table-begin table-end))
2547 "Interpret TABLE element as Org syntax.
2548 CONTENTS is a string, if table's type is `org', or nil."
2559 ;;;; Table Row
2562 "Parse table row at point.
2564 Return a list whose CAR is `table-row' and CDR is a plist
2565 containing `:begin', `:end', `:contents-begin', `:contents-end',
2566 `:type', `:post-blank' and `:post-affiliated' keywords."
2570 ;; A table rule has no contents. In that case, ensure
2571 ;; CONTENTS-BEGIN matches CONTENTS-END.
2581 :begin begin
2582 :end end
2583 :contents-begin contents-begin
2584 :contents-end contents-end
2589 "Interpret TABLE-ROW element as Org syntax.
2590 CONTENTS is the contents of the table row."
2595 ;;;; Verse Block
2598 "Parse a verse block.
2600 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2601 the buffer position at the beginning of the first affiliated
2602 keyword and CDR is a plist of affiliated keywords along with
2603 their value.
2605 Return a list whose CAR is `verse-block' and CDR is a plist
2606 containing `:begin', `:end', `:contents-begin', `:contents-end',
2607 `:post-blank' and `:post-affiliated' keywords.
2609 Assume point is at beginning of the block."
2613 ;; Incomplete block: parse it as a paragraph.
2628 :end end
2629 :contents-begin contents-begin
2630 :contents-end contents-end
2636 "Interpret verse-block element as Org syntax.
2637 CONTENTS is verse block contents."
2641 \f
2642 ;;; Objects
2643 ;;
2644 ;; Unlike to elements, raw text can be found between objects. Hence,
2645 ;; `org-element--object-lex' is provided to find the next object in
2646 ;; buffer.
2647 ;;
2648 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2649 ;; object types they can contain will be specified in
2650 ;; `org-element-object-restrictions'.
2651 ;;
2652 ;; Creating a new type of object requires to alter
2653 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2654 ;; new type in `org-element-all-objects', and possibly add
2655 ;; restrictions in `org-element-object-restrictions'.
2657 ;;;; Bold
2660 "Parse bold object at point, if any.
2662 When at a bold object, return a list whose car is `bold' and cdr
2663 is a plist with `:begin', `:end', `:contents-begin' and
2664 `:contents-end' and `:post-blank' keywords. Otherwise, return
2665 nil.
2667 Assume point is at the first star marker."
2679 :end end
2680 :contents-begin contents-begin
2681 :contents-end contents-end
2685 "Interpret bold object as Org syntax.
2686 CONTENTS is the contents of the object."
2690 ;;;; Code
2693 "Parse code object at point, if any.
2695 When at a code object, return a list whose car is `code' and cdr
2696 is a plist with `:value', `:begin', `:end' and `:post-blank'
2697 keywords. Otherwise, return nil.
2699 Assume point is at the first tilde marker."
2710 :begin begin
2711 :end end
2715 "Interpret CODE object as Org syntax."
2719 ;;;; Entity
2722 "Parse entity at point, if any.
2724 When at an entity, return a list whose car is `entity' and cdr
2725 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2726 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2727 `:post-blank' as keywords. Otherwise, return nil.
2729 Assume point is at the beginning of the entity."
2731 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2749 :begin begin
2750 :end end
2751 :use-brackets-p bracketsp
2755 "Interpret ENTITY object as Org syntax."
2761 ;;;; Export Snippet
2764 "Parse export snippet at point.
2766 When at an export snippet, return a list whose car is
2767 `export-snippet' and cdr a plist with `:begin', `:end',
2768 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2769 return nil.
2771 Assume point is at the beginning of the snippet."
2787 :value value
2788 :begin begin
2789 :end end
2793 "Interpret EXPORT-SNIPPET object as Org syntax."
2799 ;;;; Footnote Reference
2802 "Parse footnote reference at point, if any.
2804 When at a footnote reference, return a list whose car is
2805 `footnote-reference' and cdr a plist with `:label', `:type',
2806 `:begin', `:end', `:content-begin', `:contents-end' and
2807 `:post-blank' as keywords. Otherwise, return nil."
2823 :type type
2824 :begin begin
2825 :end end
2831 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2832 CONTENTS is its definition, when inline, or nil."
2838 ;;;; Inline Babel Call
2841 "Parse inline babel call at point, if any.
2843 When at an inline babel call, return a list whose car is
2844 `inline-babel-call' and cdr a plist with `:call',
2845 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2846 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2848 Assume point is at the beginning of the babel call."
2862 ;; Parenthesis are mandatory.
2873 :inside-header inside-header
2874 :arguments arguments
2875 :end-header end-header
2876 :begin begin
2877 :end end
2878 :value value
2882 "Interpret INLINE-BABEL-CALL object as Org syntax."
2892 ;;;; Inline Src Block
2895 "Parse inline source block at point, if any.
2897 When at an inline source block, return a list whose car is
2898 `inline-src-block' and cdr a plist with `:begin', `:end',
2899 `:language', `:value', `:parameters' and `:post-blank' as
2900 keywords. Otherwise, return nil.
2902 Assume point is at the beginning of the inline src block."
2919 :value value
2920 :parameters parameters
2921 :begin begin
2926 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2931 language
2933 body)))
2935 ;;;; Italic
2938 "Parse italic object at point, if any.
2940 When at an italic object, return a list whose car is `italic' and
2941 cdr is a plist with `:begin', `:end', `:contents-begin' and
2942 `:contents-end' and `:post-blank' keywords. Otherwise, return
2943 nil.
2945 Assume point is at the first slash marker."
2957 :end end
2958 :contents-begin contents-begin
2959 :contents-end contents-end
2963 "Interpret italic object as Org syntax.
2964 CONTENTS is the contents of the object."
2968 ;;;; Latex Fragment
2971 "Parse LaTeX fragment at point, if any.
2973 When at a LaTeX fragment, return a list whose car is
2974 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2975 and `:post-blank' as keywords. Otherwise, return nil.
2977 Assume point is at the beginning of the LaTeX fragment."
2988 ;; Macro.
3011 :begin begin
3012 :end end
3016 "Interpret LATEX-FRAGMENT object as Org syntax."
3019 ;;;; Line Break
3022 "Parse line break at point, if any.
3024 When at a line break, return a list whose car is `line-break',
3025 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3026 Otherwise, return nil.
3028 Assume point is at the beginning of the line break."
3037 "Interpret LINE-BREAK object as Org syntax."
3041 ;;;; Link
3044 "Parse link at point, if any.
3046 When at a link, return a list whose car is `link' and cdr a plist
3047 with `:type', `:path', `:format', `:raw-link', `:application',
3048 `:search-option', `:begin', `:end', `:contents-begin',
3049 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3050 nil.
3052 Assume point is at the beginning of the link."
3055 end contents-begin contents-end link-end post-blank path type format
3056 raw-link search-option application)
3058 ;; Type 1: Text targeted from a radio target.
3068 ;; Type 2: Standard link, i.e. [[https://orgmode.org][homepage]]
3074 ;; RAW-LINK is the original link. Expand any
3075 ;; abbreviation in it.
3076 ;;
3077 ;; Also treat any newline character and associated
3078 ;; indentation as a single space character. This is not
3079 ;; compatible with RFC 3986, which requires to ignore
3080 ;; them altogether. However, doing so would require
3081 ;; users to encode spaces on the fly when writing links
3082 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3083 ;; [[shell:ls *.org]], which defeats Org's focus on
3084 ;; simplicity.
3089 ;; Determine TYPE of link and set PATH accordingly. According
3090 ;; to RFC 3986, remove whitespaces from URI in external links.
3091 ;; In internal ones, treat indentation as a single space.
3093 ;; File type.
3098 ;; Explicit type (http, irc, bbdb...).
3102 ;; Code-ref type: PATH is the name of the reference.
3107 ;; Custom-id type: PATH is the name of the custom id.
3111 ;; Fuzzy type: Internal link either matches a target, an
3112 ;; headline name or nothing. PATH is the target or
3113 ;; headline's name.
3117 ;; Type 3: Plain link, e.g., https://orgmode.org
3124 ;; Type 4: Angular link, e.g., <https://orgmode.org>. Unlike to
3125 ;; bracket links, follow RFC 3986 and remove any extra
3126 ;; whitespace in URI.
3137 ;; In any case, deduce end point after trailing white space from
3138 ;; LINK-END variable.
3143 ;; Special "file" type link processing. Extract opening
3144 ;; application and search option, if any. Also normalize URI.
3151 ;; Translate link, if `org-link-translation-function' is set.
3159 :path path
3160 :format format
3162 :application application
3163 :search-option search-option
3164 :begin begin
3165 :end end
3166 :contents-begin contents-begin
3167 :contents-end contents-end
3171 "Interpret LINK object as Org syntax.
3172 CONTENTS is the contents of the object, or nil."
3177 ;; Links with contents and internal links have to
3178 ;; use bracket syntax. Ignore `:format' in these
3179 ;; cases. This is also the default syntax when the
3180 ;; property is not defined, e.g., when the object
3181 ;; was crafted by the user.
3184 ;; Since this is going to be used as
3185 ;; a format string, escape percent signs
3186 ;; in description.
3189 `nil
3192 ;; Otherwise, just obey to `:format'.
3204 path
3210 ;;;; Macro
3213 "Parse macro at point, if any.
3215 When at a macro, return a list whose car is `macro' and cdr
3216 a plist with `:key', `:args', `:begin', `:end', `:value' and
3217 `:post-blank' as keywords. Otherwise, return nil.
3219 Assume point is at the macro."
3232 :value value
3233 :args args
3234 :begin begin
3235 :end end
3239 "Interpret MACRO object as Org syntax."
3243 ;;;; Radio-target
3246 "Parse radio target at point, if any.
3248 When at a radio target, return a list whose car is `radio-target'
3249 and cdr a plist with `:begin', `:end', `:contents-begin',
3250 `:contents-end', `:value' and `:post-blank' as keywords.
3251 Otherwise, return nil.
3253 Assume point is at the radio target."
3265 :end end
3266 :contents-begin contents-begin
3267 :contents-end contents-end
3268 :post-blank post-blank
3272 "Interpret target object as Org syntax.
3273 CONTENTS is the contents of the object."
3277 ;;;; Statistics Cookie
3280 "Parse statistics cookie at point, if any.
3282 When at a statistics cookie, return a list whose car is
3283 `statistics-cookie', and cdr a plist with `:begin', `:end',
3284 `:value' and `:post-blank' keywords. Otherwise, return nil.
3286 Assume point is at the beginning of the statistics-cookie."
3297 :end end
3298 :value value
3302 "Interpret STATISTICS-COOKIE object as Org syntax."
3306 ;;;; Strike-Through
3309 "Parse strike-through object at point, if any.
3311 When at a strike-through object, return a list whose car is
3312 `strike-through' and cdr is a plist with `:begin', `:end',
3313 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3314 Otherwise, return nil.
3316 Assume point is at the first plus sign marker."
3328 :end end
3329 :contents-begin contents-begin
3330 :contents-end contents-end
3334 "Interpret strike-through object as Org syntax.
3335 CONTENTS is the contents of the object."
3339 ;;;; Subscript
3342 "Parse subscript at point, if any.
3344 When at a subscript object, return a list whose car is
3345 `subscript' and cdr a plist with `:begin', `:end',
3346 `:contents-begin', `:contents-end', `:use-brackets-p' and
3347 `:post-blank' as keywords. Otherwise, return nil.
3349 Assume point is at the underscore."
3363 :end end
3364 :use-brackets-p bracketsp
3365 :contents-begin contents-begin
3366 :contents-end contents-end
3370 "Interpret SUBSCRIPT object as Org syntax.
3371 CONTENTS is the contents of the object."
3374 contents))
3377 ;;;; Superscript
3380 "Parse superscript at point, if any.
3382 When at a superscript object, return a list whose car is
3383 `superscript' and cdr a plist with `:begin', `:end',
3384 `:contents-begin', `:contents-end', `:use-brackets-p' and
3385 `:post-blank' as keywords. Otherwise, return nil.
3387 Assume point is at the caret."
3401 :end end
3402 :use-brackets-p bracketsp
3403 :contents-begin contents-begin
3404 :contents-end contents-end
3408 "Interpret SUPERSCRIPT object as Org syntax.
3409 CONTENTS is the contents of the object."
3412 contents))
3415 ;;;; Table Cell
3418 "Parse table cell at point.
3419 Return a list whose car is `table-cell' and cdr is a plist
3420 containing `:begin', `:end', `:contents-begin', `:contents-end'
3421 and `:post-blank' keywords."
3429 :end end
3430 :contents-begin contents-begin
3431 :contents-end contents-end
3435 "Interpret table-cell element as Org syntax.
3436 CONTENTS is the contents of the cell, or nil."
3440 ;;;; Target
3443 "Parse target at point, if any.
3445 When at a target, return a list whose car is `target' and cdr
3446 a plist with `:begin', `:end', `:value' and `:post-blank' as
3447 keywords. Otherwise, return nil.
3449 Assume point is at the target."
3459 :end end
3460 :value value
3464 "Interpret TARGET object as Org syntax."
3468 ;;;; Timestamp
3479 "Parse time stamp at point, if any.
3481 When at a time stamp, return a list whose car is `timestamp', and
3482 cdr a plist with `:type', `:raw-value', `:year-start',
3483 `:month-start', `:day-start', `:hour-start', `:minute-start',
3484 `:year-end', `:month-end', `:day-end', `:hour-end',
3485 `:minute-end', `:repeater-type', `:repeater-value',
3486 `:repeater-unit', `:warning-type', `:warning-value',
3487 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3488 Otherwise, return nil.
3490 Assume point is at the beginning of the timestamp."
3509 date-start)
3520 raw-value)
3522 :repeater-type
3528 :repeater-unit
3537 :warning-unit
3540 year-start month-start day-start hour-start minute-start year-end
3541 month-end day-end hour-end minute-end)
3542 ;; Parse date-start.
3550 ;; Compute date-end. It can be provided directly in time-stamp,
3551 ;; or extracted from time range. Otherwise, it defaults to the
3552 ;; same values as date-start.
3562 :raw-value raw-value
3563 :year-start year-start
3564 :month-start month-start
3565 :day-start day-start
3566 :hour-start hour-start
3567 :minute-start minute-start
3568 :year-end year-end
3569 :month-end month-end
3570 :day-end day-end
3571 :hour-end hour-end
3572 :minute-end minute-end
3573 :begin begin
3574 :end end
3576 repeater-props
3577 warning-props))))))
3580 "Interpret TIMESTAMP object as Org syntax."
3598 ;; Build an Org timestamp string from TIME. ACTIVEP is
3599 ;; non-nil when time stamp is active. If WITH-TIME-P is
3600 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3601 ;; specify a time range in the timestamp. REPEAT-STRING is
3602 ;; the repeater string, if any.
3606 org-time-stamp-formats)
3607 time)))
3613 nil nil ts)))
3618 " "
3619 s
3621 ;; Return value.
3622 ts)))
3634 build-ts-string
3653 0
3661 "--"
3674 ;;;; Underline
3677 "Parse underline object at point, if any.
3679 When at an underline object, return a list whose car is
3680 `underline' and cdr is a plist with `:begin', `:end',
3681 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3682 Otherwise, return nil.
3684 Assume point is at the first underscore marker."
3696 :end end
3697 :contents-begin contents-begin
3698 :contents-end contents-end
3702 "Interpret underline object as Org syntax.
3703 CONTENTS is the contents of the object."
3707 ;;;; Verbatim
3710 "Parse verbatim object at point, if any.
3712 When at a verbatim object, return a list whose car is `verbatim'
3713 and cdr is a plist with `:value', `:begin', `:end' and
3714 `:post-blank' keywords. Otherwise, return nil.
3716 Assume point is at the first equal sign marker."
3727 :begin begin
3728 :end end
3732 "Interpret VERBATIM object as Org syntax."
3736 \f
3737 ;;; Parsing Element Starting At Point
3738 ;;
3739 ;; `org-element--current-element' is the core function of this section.
3740 ;; It returns the Lisp representation of the element starting at
3741 ;; point.
3742 ;;
3743 ;; `org-element--current-element' makes use of special modes. They
3744 ;; are activated for fixed element chaining (e.g., `plain-list' >
3745 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3746 ;; `section'). Special modes are: `first-section', `item',
3747 ;; `node-property', `section' and `table-row'.
3750 "Parse the element starting at point.
3752 Return value is a list like (TYPE PROPS) where TYPE is the type
3753 of the element and PROPS a plist of properties associated to the
3754 element.
3756 Possible types are defined in `org-element-all-elements'.
3758 LIMIT bounds the search.
3760 Optional argument GRANULARITY determines the depth of the
3761 recursion. Allowed values are `headline', `greater-element',
3762 `element', `object' or nil. When it is broader than `object' (or
3763 nil), secondary values will not be parsed, since they only
3764 contain objects.
3766 Optional argument MODE, when non-nil, can be either
3767 `first-section', `section', `planning', `item', `node-property'
3768 and `table-row'.
3770 If STRUCTURE isn't provided but MODE is set to `item', it will be
3771 computed.
3773 This function assumes point is always at the beginning of the
3774 element it has to parse."
3777 ;; Determine if parsing depth allows for secondary strings
3778 ;; parsing. It only applies to elements referenced in
3779 ;; `org-element-secondary-value-alist'.
3782 ;; Item.
3785 ;; Table Row.
3787 ;; Node Property.
3789 ;; Headline.
3792 ;; Sections (must be checked after headline).
3797 limit)))
3798 ;; Planning.
3803 ;; Property drawer.
3809 ;; When not at bol, point is at the beginning of an item or
3810 ;; a footnote definition: next item is always a paragraph.
3812 ;; Clock.
3814 ;; Inlinetask.
3817 ;; From there, elements can have affiliated keywords.
3820 ;; Jumping over affiliated keywords put point off-limits.
3821 ;; Parse them as regular keywords.
3825 ;; LaTeX Environment.
3828 ;; Drawer and Property Drawer.
3831 ;; Fixed Width
3834 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3835 ;; Keywords.
3853 limit
3854 affiliated))
3867 ;; Footnote Definition.
3870 ;; Horizontal Rule.
3873 ;; Diary Sexp.
3876 ;; Table.
3879 ;; List.
3882 limit affiliated
3884 ;; Default element: Paragraph.
3888 ;; Most elements can have affiliated keywords. When looking for an
3889 ;; element beginning, we want to move before them, as they belong to
3890 ;; that element, and, in the meantime, collect information they give
3891 ;; into appropriate properties. Hence the following function.
3894 "Collect affiliated keywords from point down to LIMIT.
3896 Return a list whose CAR is the position at the first of them and
3897 CDR a plist of keywords and values and move point to the
3898 beginning of the first line after them.
3900 As a special case, if element doesn't start at the beginning of
3901 the line (e.g., a paragraph starting an item), CAR is current
3902 position of point and CDR is nil."
3906 ;; RESTRICT is the list of objects allowed in parsed
3907 ;; keywords value.
3909 output)
3912 ;; Apply translation to RAW-KWD. From there, KWD is
3913 ;; the official keyword.
3915 org-element-keyword-translation-alist))
3916 raw-kwd))
3917 ;; Find main value for any keyword.
3923 ;; PARSEDP is non-nil when keyword should have its
3924 ;; value parsed.
3926 ;; If KWD is a dual keyword, find its secondary
3927 ;; value. Maybe parse it.
3936 ;; Attribute a property name to KWD.
3938 ;; Now set final shape for VALUE.
3944 nil restrict)))
3948 ;; Attributes can always appear on multiple lines.
3951 ;; Eventually store the new value in OUTPUT.
3953 ;; Move to next keyword.
3955 ;; If affiliated keywords are orphaned: move back to first one.
3956 ;; They will be parsed as a paragraph.
3958 ;; Return value.
3962 \f
3963 ;;; The Org Parser
3964 ;;
3965 ;; The two major functions here are `org-element-parse-buffer', which
3966 ;; parses Org syntax inside the current buffer, taking into account
3967 ;; region, narrowing, or even visibility if specified, and
3968 ;; `org-element-parse-secondary-string', which parses objects within
3969 ;; a given string.
3970 ;;
3971 ;; The (almost) almighty `org-element-map' allows applying a function
3972 ;; on elements or objects matching some type, and accumulating the
3973 ;; resulting values. In an export situation, it also skips unneeded
3974 ;; parts of the parse tree.
3977 "Recursively parse the buffer and return structure.
3978 If narrowing is in effect, only parse the visible part of the
3979 buffer.
3981 Optional argument GRANULARITY determines the depth of the
3982 recursion. It can be set to the following symbols:
3984 `headline' Only parse headlines.
3985 `greater-element' Don't recurse into greater elements except
3986 headlines and sections. Thus, elements
3987 parsed are the top-level ones.
3988 `element' Parse everything but objects and plain text.
3989 `object' Parse the complete buffer (default).
3991 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3992 elements.
3994 An element or object is represented as a list with the
3995 pattern (TYPE PROPERTIES CONTENTS), where :
3997 TYPE is a symbol describing the element or object. See
3998 `org-element-all-elements' and `org-element-all-objects' for an
3999 exhaustive list of such symbols. One can retrieve it with
4000 `org-element-type' function.
4002 PROPERTIES is the list of attributes attached to the element or
4003 object, as a plist. Although most of them are specific to the
4004 element or object type, all types share `:begin', `:end',
4005 `:post-blank' and `:parent' properties, which respectively
4006 refer to buffer position where the element or object starts,
4007 ends, the number of white spaces or blank lines after it, and
4008 the element or object containing it. Properties values can be
4009 obtained by using `org-element-property' function.
4011 CONTENTS is a list of elements, objects or raw strings
4012 contained in the current element or object, when applicable.
4013 One can access them with `org-element-contents' function.
4015 The Org buffer has `org-data' as type and nil as properties.
4016 `org-element-map' function can be used to find specific elements
4017 or objects within the parse tree.
4019 This function assumes that current major mode is `org-mode'."
4025 ;; Start in `first-section' mode so text before the first
4026 ;; headline belongs to a section.
4030 "Recursively parse objects in STRING and return structure.
4032 RESTRICTION is a symbol limiting the object types that will be
4033 looked after.
4035 Optional argument PARENT, when non-nil, is the element or object
4036 containing the secondary string. It is used to set correctly
4037 `:parent' property within the string.
4039 If STRING is the empty string or nil, return nil."
4056 "Map a function on selected elements or objects.
4058 DATA is a parse tree, an element, an object, a string, or a list
4059 of such constructs. TYPES is a symbol or list of symbols of
4060 elements or objects types (see `org-element-all-elements' and
4061 `org-element-all-objects' for a complete list of types). FUN is
4062 the function called on the matching element or object. It has to
4063 accept one argument: the element or object itself.
4065 When optional argument INFO is non-nil, it should be a plist
4066 holding export options. In that case, parts of the parse tree
4067 not exportable according to that property list will be skipped.
4069 When optional argument FIRST-MATCH is non-nil, stop at the first
4070 match for which FUN doesn't return nil, and return that value.
4072 Optional argument NO-RECURSION is a symbol or a list of symbols
4073 representing elements or objects types. `org-element-map' won't
4074 enter any recursive element or object whose type belongs to that
4075 list. Though, FUN can still be applied on them.
4077 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4078 apply to matching objects within parsed affiliated keywords (see
4079 `org-element-parsed-keywords').
4081 Nil values returned from FUN do not appear in the results.
4084 Examples:
4085 ---------
4087 Assuming TREE is a variable containing an Org buffer parse tree,
4088 the following example will return a flat list of all `src-block'
4089 and `example-block' elements in it:
4093 The following snippet will find the first headline with a level
4097 (lambda (hl)
4098 (and (= (org-element-property :level hl) 1)
4100 (org-element-property :begin hl)))
4101 nil t)
4103 The next example will return a flat list of all `plain-list' type
4104 elements in TREE that are not a sub-list themselves:
4108 Eventually, this example will return a flat list of all `bold'
4109 type objects containing a `latex-snippet' type object, even
4110 looking into captions:
4113 (lambda (b)
4115 nil nil nil t)"
4116 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4120 ;; Recursion depth is determined by --CATEGORY.
4127 ;; If one object is found, the function has
4128 ;; to recurse into every object.
4131 ;; If one regular element is found, the
4132 ;; function has to recurse, at least, into
4133 ;; every element it encounters.
4136 --acc)
4139 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4140 ;; holding contextual information.
4144 ;; Ignored element in an export context.
4146 ;; List of elements or objects.
4148 ;; Unconditionally enter parse trees.
4152 ;; Check if TYPE is matching among TYPES. If so,
4153 ;; apply FUN to --DATA and accumulate return value
4154 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4160 ;; If --DATA has a secondary string that can contain
4161 ;; objects with their type among TYPES, look inside.
4164 org-element-secondary-value-alist)))
4166 ;; If --DATA has any parsed affiliated keywords and
4167 ;; WITH-AFFILIATED is non-nil, look for objects in
4168 ;; them.
4175 ;; Pay attention to the type of parsed
4176 ;; keyword. In particular, preserve order for
4177 ;; multiple keywords.
4190 ;; Determine if a recursion into --DATA is possible.
4192 ;; --TYPE is explicitly removed from recursion.
4194 ;; --DATA has no contents.
4196 ;; Looking for greater elements but --DATA is
4197 ;; simply an element or an object.
4200 ;; Looking for elements but --DATA is an object.
4203 ;; In any other case, map contents.
4207 ;; Return value in a proper order.
4211 ;; The following functions are internal parts of the parser.
4212 ;;
4213 ;; The first one, `org-element--parse-elements' acts at the element's
4214 ;; level.
4215 ;;
4216 ;; The second one, `org-element--parse-objects' applies on all objects
4217 ;; of a paragraph or a secondary string. It calls
4218 ;; `org-element--object-lex' to find the next object in the current
4219 ;; container.
4222 "Return next special mode according to TYPE, or nil.
4223 TYPE is a symbol representing the type of an element or object
4224 containing next element if PARENTP is non-nil, or before it
4225 otherwise. Modes can be either `first-section', `item',
4226 `node-property', `planning', `property-drawer', `section',
4227 `table-row' or nil."
4244 "Parse elements between BEG and END positions.
4246 MODE prioritizes some elements over the others. It can be set to
4247 `first-section', `section', `planning', `item', `node-property'
4248 or `table-row'.
4250 When value is `item', STRUCTURE will be used as the current list
4251 structure.
4253 GRANULARITY determines the depth of the recursion. See
4254 `org-element-parse-buffer' for more information.
4256 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4257 elements.
4259 Elements are accumulated into ACC."
4262 ;; Visible only: skip invisible parts at the beginning of the
4263 ;; element.
4266 ;; When parsing only headlines, skip any text before first one.
4271 ;; Find current element's type and parse it accordingly to
4272 ;; its category.
4274 end granularity mode structure))
4278 ;; Visible only: skip invisible parts between siblings.
4281 ;; Fill ELEMENT contents by side-effect.
4283 ;; If element has no contents, don't modify it.
4285 ;; Greater element: parse it between `contents-begin' and
4286 ;; `contents-end'. Make sure GRANULARITY allows the
4287 ;; recursion, or ELEMENT is a headline, in which case going
4288 ;; inside is mandatory, in order to get sub-level headings.
4296 ;; Possibly switch to a special mode.
4300 granularity visible-only element))
4301 ;; ELEMENT has contents. Parse objects inside, if
4302 ;; GRANULARITY allows it.
4308 ;; Update mode.
4310 ;; Return result.
4314 "Return next object in current buffer or nil.
4315 RESTRICTION is a list of object types, as symbols, that should be
4316 looked after. This function assumes that the buffer is narrowed
4317 to an appropriate container (e.g., a paragraph)."
4321 ;; Object regexp sometimes needs to have a peek at
4322 ;; a character ahead. Therefore, when there is a hard
4323 ;; limit, make it one more than the true beginning of the
4324 ;; radio target.
4331 nil)
4332 ;; Since we moved backward, we do not want to
4333 ;; match again an hypothetical 1-character long
4334 ;; radio link before us. Realizing that this can
4335 ;; only happen if such a radio link starts at
4336 ;; beginning of line, we prevent this here.
4342 found)
4408 ;; This is probably a plain link.
4418 "Parse objects between BEG and END and return recursive structure.
4420 Objects are accumulated in ACC. RESTRICTION is a list of object
4421 successors which are allowed in the current object.
4423 ACC becomes the parent for all parsed objects. However, if ACC
4424 is nil (i.e., a secondary string is being parsed) and optional
4425 argument PARENT is non-nil, use it as the parent for all objects.
4426 Eventually, if both ACC and PARENT are nil, the common parent is
4427 the list of objects itself."
4435 ;; Text before any object.
4440 contents))))
4441 ;; Object...
4446 ;; Fill contents of NEXT-OBJECT if possible.
4448 cont-beg
4450 next-object
4452 next-object)
4453 contents)
4455 ;; Text after last object.
4459 contents)))
4460 ;; Result. Set appropriate parent.
4468 \f
4469 ;;; Towards A Bijective Process
4470 ;;
4471 ;; The parse tree obtained with `org-element-parse-buffer' is really
4472 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4473 ;; interpreted and expanded into a string with canonical Org syntax.
4474 ;; Hence `org-element-interpret-data'.
4475 ;;
4476 ;; The function relies internally on
4477 ;; `org-element--interpret-affiliated-keywords'.
4479 ;;;###autoload
4481 "Interpret DATA as Org syntax.
4482 DATA is a parse tree, an element, an object or a secondary string
4483 to interpret. Return Org syntax as a string."
4487 ;; Find interpreter for current object or
4488 ;; element. If it doesn't exist (e.g. this is
4489 ;; a pseudo object or element), return contents,
4490 ;; if any.
4497 ;; Secondary string.
4500 data
4502 ;; Full Org document.
4507 ;; Plain text: return it.
4509 ;; Element or object without contents.
4512 ;; Element or object with contents.
4515 interpret
4516 data
4517 ;; Recursively interpret contents.
4522 data
4523 ;; Fix indentation of elements containing
4524 ;; objects. We ignore `table-row'
4525 ;; elements as they are one line long
4526 ;; anyway.
4528 data
4529 ;; When normalizing first paragraph of
4530 ;; an item or a footnote-definition,
4531 ;; ignore first line's indentation.
4539 ;; Build white spaces. If no `:post-blank' property
4540 ;; is specified, assume its value is 0.
4550 "Return ELEMENT's affiliated keywords as Org syntax.
4551 If there is no affiliated keyword, return the empty string."
4561 ": "
4564 value)
4572 ;; All attribute keywords can have multiple lines.
4578 ;; List all ELEMENT's properties matching an attribute line or an
4579 ;; affiliated keyword, but ignore translated keywords since they
4580 ;; cannot belong to the property list.
4587 org-element-keyword-translation-alist)))))
4588 collect prop)
4591 ;; Because interpretation of the parse tree must return the same
4592 ;; number of blank lines between elements and the same number of white
4593 ;; space after objects, some special care must be given to white
4594 ;; spaces.
4595 ;;
4596 ;; The first function, `org-element-normalize-string', ensures any
4597 ;; string different from the empty string will end with a single
4598 ;; newline character.
4599 ;;
4600 ;; The second function, `org-element-normalize-contents', removes
4601 ;; global indentation from the contents of the current element.
4604 "Ensure string S ends with a single newline character.
4606 If S isn't a string return it unchanged. If S is the empty
4607 string, return it. Otherwise, return a new string with a single
4608 newline character at its end."
4616 "Normalize plain text in ELEMENT's contents.
4618 ELEMENT must only contain plain text and objects.
4620 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4621 indentation to compute maximal common indentation.
4623 Return the normalized element that is element with global
4624 indentation removed from its contents."
4626 ;; Return minimal common indentation within BLOB. This is
4627 ;; done by walking recursively BLOB and updating MIN-IND
4628 ;; along the way. FIRST-FLAG is non-nil when the next
4629 ;; object is expected to be a string that doesn't start
4630 ;; with a newline character. It happens for strings at
4631 ;; the beginnings of the contents or right after a line
4632 ;; break.
4638 ;; Objects cannot start with spaces: in this
4639 ;; case, indentation is 0.
4680 ;; Build ELEMENT back, replacing each string with the same
4681 ;; string minus common indentation.
4684 ;; Return DATUM with all its strings indentation
4685 ;; shortened from MIN-IND white spaces.
4705 org-element-recursive-objects)
4709 datum)))
4713 \f
4714 ;;; Cache
4715 ;;
4716 ;; Implement a caching mechanism for `org-element-at-point' and
4717 ;; `org-element-context', which see.
4718 ;;
4719 ;; A single public function is provided: `org-element-cache-reset'.
4720 ;;
4721 ;; Cache is enabled by default, but can be disabled globally with
4722 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4723 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4724 ;; can be tweaked to control caching behavior.
4725 ;;
4726 ;; Internally, parsed elements are stored in an AVL tree,
4727 ;; `org-element--cache'. This tree is updated lazily: whenever
4728 ;; a change happens to the buffer, a synchronization request is
4729 ;; registered in `org-element--cache-sync-requests' (see
4730 ;; `org-element--cache-submit-request'). During idle time, requests
4731 ;; are processed by `org-element--cache-sync'. Synchronization also
4732 ;; happens when an element is required from the cache. In this case,
4733 ;; the process stops as soon as the needed element is up-to-date.
4734 ;;
4735 ;; A synchronization request can only apply on a synchronized part of
4736 ;; the cache. Therefore, the cache is updated at least to the
4737 ;; location where the new request applies. Thus, requests are ordered
4738 ;; from left to right and all elements starting before the first
4739 ;; request are correct. This property is used by functions like
4740 ;; `org-element--cache-find' to retrieve elements in the part of the
4741 ;; cache that can be trusted.
4742 ;;
4743 ;; A request applies to every element, starting from its original
4744 ;; location (or key, see below). When a request is processed, it
4745 ;; moves forward and may collide the next one. In this case, both
4746 ;; requests are merged into a new one that starts from that element.
4747 ;; As a consequence, the whole synchronization complexity does not
4748 ;; depend on the number of pending requests, but on the number of
4749 ;; elements the very first request will be applied on.
4750 ;;
4751 ;; Elements cannot be accessed through their beginning position, which
4752 ;; may or may not be up-to-date. Instead, each element in the tree is
4753 ;; associated to a key, obtained with `org-element--cache-key'. This
4754 ;; mechanism is robust enough to preserve total order among elements
4755 ;; even when the tree is only partially synchronized.
4759 "Non-nil when Org parser should cache its results.
4761 WARNING: for the time being, using cache sometimes triggers
4762 freezes. Therefore, it is disabled by default. Activate it if
4769 "Maximum duration, as a time value, for a cache synchronization.
4770 If the synchronization is not over after this delay, the process
4771 pauses and resumes after `org-element-cache-sync-break'
4775 "Duration, as a time value, of the pause between synchronizations.
4779 ;;;; Data Structure
4782 "AVL tree used to cache elements.
4783 Each node of the tree contains an element. Comparison is done
4784 with `org-element--cache-compare'. This cache is used in
4788 "List of pending synchronization requests.
4790 A request is a vector with the following pattern:
4792 \[NEXT BEG END OFFSET PARENT PHASE]
4794 Processing a synchronization request consists of three phases:
4796 0. Delete modified elements,
4797 1. Fill missing area in cache,
4798 2. Shift positions and re-parent elements after the changes.
4800 During phase 0, NEXT is the key of the first element to be
4801 removed, BEG and END is buffer position delimiting the
4802 modifications. Elements starting between them (inclusive) are
4803 removed. So are elements whose parent is removed. PARENT, when
4804 non-nil, is the parent of the first element to be removed.
4806 During phase 1, NEXT is the key of the next known element in
4807 cache and BEG its beginning position. Parse buffer between that
4808 element and the one before it in order to determine the parent of
4809 the next element. Set PARENT to the element containing NEXT.
4811 During phase 2, NEXT is the key of the next element to shift in
4812 the parse tree. All elements starting from this one have their
4813 properties relatives to buffer positions shifted by integer
4814 OFFSET and, if they belong to element PARENT, are adopted by it.
4822 "Hash table used to store keys during synchronization.
4826 "Return a unique key for ELEMENT in cache tree.
4828 Keys are used to keep a total order among elements in the cache.
4829 Comparison is done with `org-element--cache-key-less-p'.
4831 When no synchronization is taking place, a key is simply the
4832 beginning position of the element, or that position plus one in
4833 the case of an first item (respectively row) in
4834 a list (respectively a table).
4836 During a synchronization, the key is the one the element had when
4837 the cache was synchronized for the last time. Elements added to
4838 cache during the synchronization get a new key generated with
4839 `org-element--cache-generate-key'.
4841 Such keys are stored in `org-element--cache-sync-keys'. The hash
4842 table is cleared once the synchronization is complete."
4845 ;; Increase beginning position of items (respectively
4846 ;; table rows) by one, so the first item can get
4847 ;; a different key from its parent list (respectively
4848 ;; table).
4851 begin)))
4854 key))))
4857 "Generate a key between LOWER and UPPER.
4859 LOWER and UPPER are integers or lists, possibly empty.
4861 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4862 a unique key, as an integer or a list of integers, according to
4863 the following rules:
4865 - LOWER and UPPER are compared level-wise until values differ.
4867 - If, at a given level, LOWER and UPPER differ from more than
4868 2, the new key shares all the levels above with LOWER and
4869 gets a new level. Its value is the mean between LOWER and
4870 UPPER:
4872 (1 2) + (1 4) --> (1 3)
4874 - If LOWER has no value to compare with, it is assumed that its
4875 value is `most-negative-fixnum'. E.g.,
4877 (1 1) + (1 1 2)
4879 is equivalent to
4881 (1 1 m) + (1 1 2)
4883 where m is `most-negative-fixnum'. Likewise, if UPPER is
4884 short of levels, the current value is `most-positive-fixnum'.
4886 - If they differ from only one, the new key inherits from
4887 current LOWER level and fork it at the next level. E.g.,
4889 (2 1) + (3 3)
4891 is equivalent to
4893 (2 1) + (2 M)
4895 where M is `most-positive-fixnum'.
4897 - If the key is only one level long, it is returned as an
4898 integer:
4900 (1 2) + (3 2) --> 2
4902 When they are not equals, the function assumes that LOWER is
4903 lesser than UPPER, per `org-element--cache-key-less-p'."
4907 skip-upper key)
4918 ;; When at a given level, LOWER and UPPER differ from
4919 ;; 1, ignore UPPER altogether. Instead create a key
4920 ;; between LOWER and the greatest key with the same
4921 ;; prefix as LOWER so far.
4927 "Non-nil if key A is less than key B.
4928 A and B are either integers or lists of integers, as returned by
4929 `org-element--cache-key'."
4937 ;; If A is empty, either keys are equal (B is also empty) and
4938 ;; we return nil, or A is lesser than B (B is longer) and we
4939 ;; return a non-nil value.
4940 ;;
4941 ;; If A is not empty, B is necessarily empty and A is greater
4942 ;; than B (A is longer). Therefore, return nil.
4946 "Non-nil when element A is located before element B."
4951 "Return root value in cache.
4952 This function assumes `org-element--cache' is a valid AVL tree."
4956 ;;;; Tools
4959 "Non-nil when cache is active in current buffer."
4961 org-element--cache
4965 "Find element in cache starting at POS or before.
4967 POS refers to a buffer position.
4969 When optional argument SIDE is non-nil, the function checks for
4970 elements starting at or past POS instead. If SIDE is `both', the
4971 function returns a cons cell where car is the first element
4972 starting at or before POS and cdr the first element starting
4973 after POS.
4975 The function can only find elements in the synchronized part of
4976 the cache."
4980 lower upper)
4995 ;; We found an element in cache starting at POS. If `side'
4996 ;; is `both' we also want the next one in order to generate
4997 ;; a key in-between.
4998 ;;
4999 ;; If the element is the first row or item in a table or
5000 ;; a plain list, we always return the table or the plain
5001 ;; list.
5002 ;;
5003 ;; In any other case, we return the element found.
5012 lower parent
5013 upper parent)))))
5016 lower element
5017 upper element)))))
5024 "Store ELEMENT in current buffer's cache, if allowed."
5027 ;; During synchronization, first build an appropriate key for
5028 ;; the new element so `avl-tree-enter' can insert it at the
5029 ;; right spot in the cache.
5038 org-element--cache-sync-keys)))
5042 "Remove ELEMENT from cache.
5043 Assume ELEMENT belongs to cache and that a cache is active."
5047 ;;;; Synchronization
5050 "Set idle timer for cache synchronization in BUFFER."
5057 org-element-cache-sync-idle-time))
5058 nil
5059 #'org-element--cache-sync
5060 buffer)))
5063 "Non-nil when synchronization process should be interrupted.
5064 TIME-LIMIT is a time value or nil."
5070 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5072 Properties containing buffer positions are `:begin', `:end',
5073 `:contents-begin', `:contents-end' and `:structure'. When
5074 optional argument PROPS is a list of keywords, only shift
5075 properties provided in that list.
5077 Properties are modified by side-effect."
5079 ;; Shift `:structure' property for the first plain list only: it
5080 ;; is the only one that really matters and it prevents from
5081 ;; shifting it more than once.
5095 "Synchronize cache with recent modification in BUFFER.
5097 When optional argument THRESHOLD is non-nil, do the
5098 synchronization for all elements starting before or at threshold,
5099 then exit. Otherwise, synchronize cache for as long as
5100 `org-element-cache-sync-duration' or until Emacs leaves idle
5101 state.
5103 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5104 not registered yet in the cache are going to happen. It is used
5105 in `org-element--cache-submit-request', where cache is partially
5106 updated before current modification are actually submitted."
5117 request
5119 threshold
5122 org-element-cache-sync-duration))
5123 future-change)
5124 ;; Request processed. Merge current and next offsets and
5125 ;; transfer ending position.
5131 ;; If more requests are awaiting, set idle timer accordingly.
5132 ;; Otherwise, reset keys.
5139 "Process synchronization REQUEST for all entries before NEXT.
5141 REQUEST is a vector, built by `org-element--cache-submit-request'.
5143 NEXT is a cache key, as returned by `org-element--cache-key'.
5145 When non-nil, THRESHOLD is a buffer position. Synchronization
5146 stops as soon as a shifted element begins after it.
5148 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5149 after this time or when Emacs exits idle state.
5151 When non-nil, FUTURE-CHANGE is a buffer position where changes
5152 not registered yet in the cache are going to happen. See
5153 `org-element--cache-submit-request' for more information.
5155 Throw `interrupt' if the process stops before completing the
5156 request."
5159 ;; Phase 0.
5160 ;;
5161 ;; Delete all elements starting after BEG, but not after buffer
5162 ;; position END or past element with key NEXT. Also delete
5163 ;; elements contained within a previously removed element
5164 ;; (stored in `last-container').
5165 ;;
5166 ;; At each iteration, we start again at tree root since
5167 ;; a deletion modifies structure of the balanced tree.
5172 ;; Find first element in cache with key BEG or after it.
5176 data data-key last-container)
5185 data-key key
5188 data-key key
5189 node nil)))))
5199 up)))
5202 end))
5209 ;; No element starting after modifications left in
5210 ;; cache: further processing is futile.
5213 ;; Phase 1.
5214 ;;
5215 ;; Phase 0 left a hole in the cache. Some elements after it
5216 ;; could have parents within. For example, in the following
5217 ;; buffer:
5218 ;;
5219 ;; - item
5220 ;;
5221 ;;
5222 ;; Paragraph1
5223 ;;
5224 ;; Paragraph2
5225 ;;
5226 ;; if we remove a blank line between "item" and "Paragraph1",
5227 ;; everything down to "Paragraph2" is removed from cache. But
5228 ;; the paragraph now belongs to the list, and its `:parent'
5229 ;; property no longer is accurate.
5230 ;;
5231 ;; Therefore we need to parse again elements in the hole, or at
5232 ;; least in its last section, so that we can re-parent
5233 ;; subsequent elements, during phase 2.
5234 ;;
5235 ;; Note that we only need to get the parent from the first
5236 ;; element in cache after the hole.
5237 ;;
5238 ;; When next key is lesser or equal to the current one, delegate
5239 ;; phase 1 processing to next request in order to preserve key
5240 ;; order among requests.
5248 ;; Next element will start at its beginning position plus
5249 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5250 ;; contains the real beginning position of the first element to
5251 ;; shift and re-parent.
5255 ;; Changes are going to happen around this element and
5256 ;; they will trigger another phase 1 request. Skip the
5257 ;; current one.
5263 ;; Phase 2.
5264 ;;
5265 ;; Shift all elements starting from key START, but before NEXT, by
5266 ;; OFFSET, and re-parent them when appropriate.
5267 ;;
5268 ;; Elements are modified by side-effect so the tree structure
5269 ;; remains intact.
5270 ;;
5271 ;; Once THRESHOLD, if any, is reached, or once there is an input
5272 ;; pending, exit. Before leaving, the current synchronization
5273 ;; request is updated.
5280 exit-flag)
5281 ;; No re-parenting nor shifting planned: request is over.
5291 ;; We reached NEXT. Request is complete.
5293 ;; Handle interruption request. Update current request.
5298 ;; Shift element.
5302 ;; Update PARENT and re-parent DATA, only when
5303 ;; necessary. Propagate new structures for lists.
5317 ;; Cache is up-to-date past THRESHOLD. Request
5318 ;; interruption.
5323 ;; We reached end of tree: synchronization complete.
5324 t)))
5327 "Parse elements in current section, down to POS.
5329 Start parsing from the closest between the last known element in
5330 cache or headline above. Return the smallest element containing
5331 POS.
5333 When optional argument SYNCP is non-nil, return the parent of the
5334 element containing POS instead. In that case, it is also
5335 possible to provide TIME-LIMIT, which is a time value specifying
5336 when the parsing should stop. The function throws `interrupt' if
5337 the process stopped before finding the expected result."
5344 element next mode)
5346 ;; Nothing in cache before point: start parsing from first
5347 ;; element following headline above, or first element in
5348 ;; buffer.
5355 ;; Cache returned exact match: return it.
5358 ;; There's a headline between cached value and POS: cached
5359 ;; value is invalid. Start parsing from first element
5360 ;; following the headline.
5367 ;; Check if CACHED or any of its ancestors contain point.
5368 ;;
5369 ;; If there is such an element, we inspect it in order to know
5370 ;; if we return it or if we need to parse its contents.
5371 ;; Otherwise, we just start parsing from current location,
5372 ;; which is right after the top-most element containing
5373 ;; CACHED.
5374 ;;
5375 ;; As a special case, if POS is at the end of the buffer, we
5376 ;; want to return the innermost element ending there.
5377 ;;
5378 ;; Also, if we find an ancestor and discover that we need to
5379 ;; parse its contents, make sure we don't start from
5380 ;; `:contents-begin', as we would otherwise go past CACHED
5381 ;; again. Instead, in that situation, we will resume parsing
5382 ;; from NEXT, which is located after CACHED or its higher
5383 ;; ancestor not containing point.
5395 ;; Parse successively each element until we reach POS.
5408 end 'element mode
5415 ;; Skip any element ending before point. Also skip
5416 ;; element ending at point (unless it is also the end of
5417 ;; buffer) since we're sure that another element begins
5418 ;; after it.
5422 ;; A non-greater element contains point: return it.
5425 ;; Otherwise, we have to decide if ELEMENT really
5426 ;; contains POS. In that case we start parsing from
5427 ;; contents' beginning.
5428 ;;
5429 ;; If POS is at contents' beginning but it is also at
5430 ;; the beginning of the first item in a list or a table.
5431 ;; In that case, we need to create an anchor for that
5432 ;; list or table, so return it.
5433 ;;
5434 ;; Also, if POS is at the end of the buffer, no element
5435 ;; can start after it, but more than one may end there.
5436 ;; Arbitrarily, we choose to return the innermost of
5437 ;; such elements.
5450 parent element
5451 end cend))))
5452 ;; Otherwise, return ELEMENT as it is the smallest
5453 ;; element containing POS.
5458 ;;;; Staging Buffer Changes
5469 "Regexp matching a sensitive line, structure wise.
5470 A sensitive line is a headline, inlinetask, block, drawer, or
5471 latex-environment boundary. When such a line is modified,
5472 structure changes in the document may propagate in the whole
5476 "Non-nil when a sensitive line is about to be changed.
5480 "Request extension of area going to be modified if needed.
5481 BEG and END are the beginning and end of the range of changed
5482 text. See `before-change-functions' for more information."
5492 'headline
5495 org-element--cache-sensitive-re bottom t)))))))))
5498 "Update buffer modifications for current buffer.
5499 BEG and END are the beginning and end of the range of changed
5500 text, and the length in bytes of the pre-change text replaced by
5501 that range. See `after-change-functions' for more information."
5509 ;; Determine if modified area needs to be extended, according
5510 ;; to both previous and current state. We make a special
5511 ;; case for headline editing: if a headline is modified but
5512 ;; not removed, do not extend.
5515 (`headline
5521 org-element--cache-sensitive-re bottom t))))
5522 ;; Effectively extend modified area.
5530 ;; Store synchronization request.
5533 ;; Activate a timer to process the request during idle time.
5537 "Return first element to remove from cache.
5539 BEG and END are buffer positions delimiting buffer modifications.
5540 OFFSET is the size of the changes.
5542 Returned element is usually the first element in cache containing
5543 any position between BEG and END. As an exception, greater
5544 elements around the changes that are robust to contents
5545 modifications are preserved and updated according to the
5546 changes."
5556 special-block))
5557 ;; Drawers named "PROPERTIES" are probably
5558 ;; a properties drawer being edited. Force
5559 ;; parsing to check if editing is over.
5568 ;; UP is a robust greater element containing changes.
5569 ;; We only need to extend its ending boundaries.
5575 ;; We're at top level element containing ELEMENT: if it's
5576 ;; altered by buffer modifications, it is first element in
5577 ;; cache to be removed. Otherwise, that first element is the
5578 ;; following one.
5579 ;;
5580 ;; As a special case, do not remove BEFORE if it is a robust
5581 ;; container for current changes.
5583 before)))))
5586 "Submit a new cache synchronization request for current buffer.
5587 BEG and END are buffer positions delimiting the minimal area
5588 where cache data should be removed. OFFSET is the size of the
5589 change, as an integer."
5591 delete-to delete-from)
5596 ;; Current changes can be merged with first sync request: we
5597 ;; can save a partial cache synchronization.
5600 ;; If last change happened within area to be removed, extend
5601 ;; boundaries of robust parents, if any. Otherwise, find
5602 ;; first element to remove and update request accordingly.
5614 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5615 ;; if any, is no longer a 0-phase request, thus ensuring that
5616 ;; phases are properly ordered. We need to provide OFFSET as
5617 ;; optional parameter since current modifications are not known
5618 ;; yet to the otherwise correct part of the cache (i.e, before
5619 ;; the first request).
5626 ;; When changes happen before the first known
5627 ;; element, re-parent and shift the rest of the
5628 ;; cache.
5630 ;; Otherwise, we find the first non robust
5631 ;; element containing END. All elements between
5632 ;; FIRST and this one are to be removed.
5643 element up))
5645 org-element--cache-sync-requests)
5646 ;; No element to remove. No need to re-parent either.
5647 ;; Simply shift additional elements, if any, by OFFSET.
5650 offset)))))))
5653 ;;;; Public Functions
5655 ;;;###autoload
5657 "Reset cache in current buffer.
5658 When optional argument ALL is non-nil, reset cache in all Org
5659 buffers."
5676 ;;;###autoload
5678 "Refresh cache at position POS."
5685 \f
5686 ;;; The Toolbox
5687 ;;
5688 ;; The first move is to implement a way to obtain the smallest element
5689 ;; containing point. This is the job of `org-element-at-point'. It
5690 ;; basically jumps back to the beginning of section containing point
5691 ;; and proceed, one element after the other, with
5692 ;; `org-element--current-element' until the container is found. Note:
5693 ;; When using `org-element-at-point', secondary values are never
5694 ;; parsed since the function focuses on elements, not on objects.
5695 ;;
5696 ;; At a deeper level, `org-element-context' lists all elements and
5697 ;; objects containing point.
5698 ;;
5699 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5700 ;; internally by navigation and manipulation tools.
5703 ;;;###autoload
5705 "Determine closest element around point.
5707 Return value is a list like (TYPE PROPS) where TYPE is the type
5708 of the element and PROPS a plist of properties associated to the
5709 element.
5711 Possible types are defined in `org-element-all-elements'.
5712 Properties depend on element or object type, but always include
5713 `:begin', `:end', `:parent' and `:post-blank' properties.
5715 As a special case, if point is at the very beginning of the first
5716 item in a list or sub-list, returned element will be that list
5717 instead of the item. Likewise, if point is at the beginning of
5718 the first row of a table, returned element will be the table
5719 instead of the first row.
5721 When point is at the end of the buffer, return the innermost
5722 element ending there."
5728 ;; Within blank lines at the beginning of buffer, return nil.
5730 ;; Within blank lines right after a headline, return that
5731 ;; headline.
5735 ;; Otherwise parse until we find element containing ORIGIN.
5742 ;;;###autoload
5744 "Return smallest element or object around point.
5746 Return value is a list like (TYPE PROPS) where TYPE is the type
5747 of the element or object and PROPS a plist of properties
5748 associated to it.
5750 Possible types are defined in `org-element-all-elements' and
5751 `org-element-all-objects'. Properties depend on element or
5752 object type, but always include `:begin', `:end', `:parent' and
5753 `:post-blank'.
5755 As a special case, if point is right after an object and not at
5756 the beginning of any other object, return that object.
5758 Optional argument ELEMENT, when non-nil, is the closest element
5759 containing point, as returned by `org-element-at-point'.
5760 Providing it allows for quicker computation."
5767 ;; If point is inside an element containing objects or
5768 ;; a secondary string, narrow buffer to the container and
5769 ;; proceed with parsing. Otherwise, return ELEMENT.
5771 ;; At a parsed affiliated keyword, check if we're inside main
5772 ;; or dual value.
5778 org-element-parsed-keywords))
5787 ;; Also change type to retrieve correct restrictions.
5789 ;; At an item, objects can only be located within tag, if any.
5800 ;; At an headline or inlinetask, objects are in title.
5812 ;; At a paragraph, a table-row or a verse block, objects are
5813 ;; located within their contents.
5817 ;; CBEG is nil for table rules.
5826 last)
5831 ;; Process NEXT, if any, in order to know if we need to
5832 ;; skip it, return it or move into it.
5839 ;; Skip objects ending before point. Also skip
5840 ;; objects ending at point unless it is also the
5841 ;; end of buffer, since we want to return the
5842 ;; innermost object.
5845 ;; For convenience, when object ends at POS,
5846 ;; without any space, store it in LAST, as we
5847 ;; will return it if no object starts here.
5851 ;; If POS is within a container object, move into
5852 ;; that object.
5856 ;; At contents' end, if there is no
5857 ;; space before point, also move into
5858 ;; object, for consistency with
5859 ;; convenience feature above.
5868 ;; Otherwise, return NEXT.
5872 "List all ancestors of a given element or object.
5874 BLOB is an object or element.
5876 When optional argument TYPES is a list of symbols, return the
5877 first element or object in the lineage whose type belongs to that
5878 list.
5880 When optional argument WITH-SELF is non-nil, lineage includes
5881 BLOB itself as the first element, and TYPES, if provided, also
5882 apply to it.
5884 When BLOB is obtained through `org-element-context' or
5885 `org-element-at-point', only ancestors from its section can be
5886 found. There is no such limitation when BLOB belongs to a full
5887 parse tree."
5889 ancestors)
5896 "Non-nil when elements ELEM-A and ELEM-B are nested."
5905 "Swap elements ELEM-A and ELEM-B.
5906 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5907 end of ELEM-A."
5909 ;; There are two special cases when an element doesn't start at bol:
5910 ;; the first paragraph in an item or in a footnote definition.
5912 ;; Only a paragraph without any affiliated keyword can be moved at
5913 ;; ELEM-A position in such a situation. Note that the case of
5914 ;; a footnote definition is impossible: it cannot contain two
5915 ;; paragraphs in a row because it cannot contain a blank line.
5921 ;; In a special situation, ELEM-A will have no indentation. We'll
5922 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5936 ;; Store inner overlays responsible for visibility status.
5937 ;; We also need to store their boundaries as they will be
5938 ;; removed from buffer.
5953 ;; Get contents.
5961 ;; Restore ex ELEM-A overlays.
5968 ;; Restore ex ELEM-B overlays.
5976 ;; Local variables:
5977 ;; generated-autoload-file: "org-loaddefs.el"
5978 ;; End:
5980 ;;; org-element.el ends here