| blob | cab647f4bebe288267d8fb2e91d8a7a0ad9d68d8 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2018 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; See <https://orgmode.org/worg/dev/org-syntax.html> for details about
26 ;; Org syntax.
27 ;;
28 ;; Lisp-wise, a syntax object can be represented as a list.
29 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
30 ;; TYPE is a symbol describing the object.
31 ;; PROPERTIES is the property list attached to it. See docstring of
32 ;; appropriate parsing function to get an exhaustive list.
33 ;; CONTENTS is a list of syntax objects or raw strings contained
34 ;; in the current object, when applicable.
35 ;;
36 ;; For the whole document, TYPE is `org-data' and PROPERTIES is nil.
37 ;;
38 ;; The first part of this file defines constants for the Org syntax,
39 ;; while the second one provide accessors and setters functions.
40 ;;
41 ;; The next part implements a parser and an interpreter for each
42 ;; element and object type in Org syntax.
43 ;;
44 ;; The following part creates a fully recursive buffer parser. It
45 ;; also provides a tool to map a function to elements or objects
46 ;; matching some criteria in the parse tree. Functions of interest
47 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
48 ;; extent, `org-element-parse-secondary-string'.
49 ;;
50 ;; The penultimate part is the cradle of an interpreter for the
51 ;; obtained parse tree: `org-element-interpret-data'.
52 ;;
53 ;; The library ends by furnishing `org-element-at-point' function, and
54 ;; a way to give information about document structure around point
55 ;; with `org-element-context'. A cache mechanism is also provided for
56 ;; these functions.
59 ;;; Code:
66 \f
67 ;;; Definitions And Rules
68 ;;
69 ;; Define elements, greater elements and specify recursive objects,
70 ;; along with the affiliated keywords recognized. Also set up
71 ;; restrictions on recursive objects combinations.
72 ;;
73 ;; `org-element-update-syntax' builds proper syntax regexps according
74 ;; to current setup.
77 "Regexp to separate paragraphs in an Org buffer.
79 is not sufficient to know if point is at a paragraph ending. See
83 "Regexp possibly matching the beginning of an object.
84 This regexp allows false positives. Dedicated parser (e.g.,
85 `org-export-bold-parser') will take care of further filtering.
86 Radio links are not matched by this regexp, as they are treated
90 "Build variable syntax regexps."
93 ;; Headlines, inlinetasks.
95 ;; Footnote definitions.
97 ;; Diary sexps.
100 ;; Empty lines.
102 ;; Tables (any type).
105 ;; Comments, keyword-like or block-like constructs.
106 ;; Blocks and keywords with dual values need to be
107 ;; double-checked.
112 ;; Drawers (any type) and fixed-width areas. Drawers
113 ;; need to be double-checked.
115 ;; Horizontal rules.
117 ;; LaTeX environments.
119 ;; Clock lines.
121 ;; Lists.
128 org-element--object-regexp
132 ;; Sub/superscript.
134 ;; Bold, code, italic, strike-through, underline
135 ;; and verbatim.
139 ;; Plain links.
141 ;; Objects starting with "[": regular link,
142 ;; footnote reference, statistics cookie,
143 ;; timestamp (inactive).
150 ;; Objects starting with "@": export snippets.
151 "@@"
152 ;; Objects starting with "{": macro.
153 "{{{"
154 ;; Objects starting with "<" : timestamp
155 ;; (active, diary), target, radio target and
156 ;; angular links.
158 ;; Objects starting with "$": latex fragment.
160 ;; Objects starting with "\": line break,
161 ;; entity, latex fragment.
163 ;; Objects starting with raw text: inline Babel
164 ;; source block, inline Babel call.
170 ;;;###autoload
172 "Update parser internals."
179 dynamic-block example-block export-block fixed-width
180 footnote-definition headline horizontal-rule inlinetask item
181 keyword latex-environment node-property paragraph plain-list
182 planning property-drawer quote-block section
183 special-block src-block table table-row verse-block)
188 item plain-list property-drawer quote-block section
189 special-block table)
194 inline-src-block italic line-break latex-fragment link macro
195 radio-target statistics-cookie strike-through subscript superscript
196 table-cell target timestamp underline verbatim)
201 superscript table-cell underline)
211 "List of affiliated keywords as strings.
219 "Alist of usual translations for keywords.
220 The key is the old name and the value the new one. The property
224 "List of affiliated keywords that can occur more than once in an element.
226 Their value will be consed into a list of strings, which will be
227 returned as the value of the property.
229 This list is checked after translations have been applied. See
230 `org-element-keyword-translation-alist'.
236 "List of affiliated keywords whose value can be parsed.
238 Their value will be stored as a secondary string: a list of
239 strings and objects.
241 This list is checked after translations have been applied. See
246 org-element-parsed-keywords)
247 "Alist of parsed keywords and associated properties.
248 This is generated from `org-element-parsed-keywords', which
252 "List of affiliated keywords which can have a secondary value.
254 In Org syntax, they can be written with optional square brackets
255 before the colons. For example, RESULTS keyword can be
256 associated to a hash value with the following:
258 #+RESULTS[hash-string]: some-source
260 This list is checked after translations have been applied. See
266 ;; Dual affiliated keywords.
270 ;; Regular affiliated keywords.
275 org-element-affiliated-keywords)))
277 ;; Export attributes.
279 "Regexp matching any affiliated keyword.
281 Keyword name is put in match group 1. Moreover, if keyword
282 belongs to `org-element-dual-keywords', put the dual value in
283 match group 2.
297 ;; Ignore all links in a link description. Also ignore
298 ;; radio-targets and line breaks.
300 italic latex-fragment macro statistics-cookie strike-through
301 subscript superscript underline verbatim)
303 ;; Remove any variable object from radio target as it would
304 ;; prevent it from being properly recognized.
306 subscript superscript underline superscript)
310 ;; Ignore inline babel call and inline src block as formulas are
311 ;; possible. Also ignore line breaks and statistics cookies.
313 latex-fragment link macro radio-target strike-through
314 subscript superscript target timestamp underline verbatim)
318 "Alist of objects restrictions.
320 key is an element or object type containing objects and value is
321 a list of types that can be contained within an element or object
322 of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, latex-fragments, subscript, superscript and text
326 markup.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
344 "Table used internally to pair only round brackets.
353 "Table used internally to pair only square brackets.
362 "Table used internally to pair only curly brackets.
366 "Parse paired brackets at point.
367 CHAR is the opening bracket to consider, as a character. Return
368 contents between brackets, as a string, or nil. Also move point
369 past the brackets."
384 \f
385 ;;; Accessors and Setters
386 ;;
387 ;; Provide four accessors: `org-element-type', `org-element-property'
388 ;; `org-element-contents' and `org-element-restriction'.
389 ;;
390 ;; Setter functions allow modification of elements by side effect.
391 ;; There is `org-element-put-property', `org-element-set-contents'.
392 ;; These low-level functions are useful to build a parse tree.
393 ;;
394 ;; `org-element-adopt-elements', `org-element-set-element',
395 ;; `org-element-extract-element' and `org-element-insert-before' are
396 ;; high-level functions useful to modify a parse tree.
397 ;;
398 ;; `org-element-secondary-p' is a predicate used to know if a given
399 ;; object belongs to a secondary string. `org-element-class' tells if
400 ;; some parsed data is an element or an object, handling pseudo
401 ;; elements and objects. `org-element-copy' returns an element or
402 ;; object, stripping its parent property in the process.
405 "Return type of ELEMENT.
407 The function returns the type of the element or object provided.
408 It can also return the following special value:
409 `plain-text' for a string
410 `org-data' for a complete document
411 nil in any other case."
417 "Extract the value from the PROPERTY of an ELEMENT."
422 "Extract contents from an ELEMENT."
428 "Return restriction associated to ELEMENT.
429 ELEMENT can be an element, an object or a symbol representing an
430 element or object type."
432 org-element-object-restrictions)))
435 "In ELEMENT set PROPERTY to VALUE.
436 Return modified element."
439 element))
442 "Set ELEMENT's contents to CONTENTS.
443 Return ELEMENT."
450 "Non-nil when OBJECT directly belongs to a secondary string.
451 Return value is the property name, as a keyword, or nil."
454 org-element-secondary-value-alist))))
461 "Return class for ELEMENT, as a symbol.
462 Class is either `element' or `object'. Optional argument PARENT
463 is the element or object containing DATUM. It defaults to the
464 value of DATUM `:parent' property."
468 ;; Trivial cases.
471 ;; Special cases.
475 ;; Pseudo object or elements. Make a guess about its class.
476 ;; Basically a pseudo object is contained within another object,
477 ;; a secondary string or a container element.
487 "Append elements to the contents of another element.
489 PARENT is an element or object. CHILDREN can be elements,
490 objects, or a strings.
492 The function takes care of setting `:parent' property for CHILD.
493 Return parent element."
495 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
496 ;; string: parent is the list itself.
499 ;; Add CHILDREN at the end of PARENT contents.
502 parent
504 ;; Return modified PARENT element.
508 "Extract ELEMENT from parse tree.
509 Remove element from the parse tree by side-effect, and return it
510 with its `:parent' property stripped out."
515 parent secondary
518 parent
520 ;; Return ELEMENT with its :parent removed.
524 "Insert ELEMENT before LOCATION in parse tree.
525 LOCATION is an element, object or string within the parse tree.
526 Parse tree is modified by side effect."
531 ;; Special case: LOCATION is the first element of an
532 ;; independent secondary string (e.g. :title property). Add
533 ;; ELEMENT in-place.
537 ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires tweaking `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret a center-block element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
806 "Parse a footnote definition.
808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
809 the buffer position at the beginning of the first affiliated
810 keyword and CDR is a plist of affiliated keywords along with
811 their value.
813 Return a list whose CAR is `footnote-definition' and CDR is
814 a plist containing `:label', `:begin' `:end', `:contents-begin',
815 `:contents-end', `:pre-blank',`:post-blank' and
816 `:post-affiliated' keywords.
818 Assume point is at the beginning of the footnote definition."
830 limit)
832 ;; At a new footnote definition, make sure we end
833 ;; before any affiliated keyword above.
859 :begin begin
860 :end end
861 :contents-begin contents-begin
863 :pre-blank pre-blank
869 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
870 CONTENTS is the contents of the footnote-definition."
873 ;; 0 is specific to paragraphs at the beginning of
874 ;; the footnote definition, so we use 1 as
875 ;; a fall-back value, which is more universal.
877 ;; Footnote ends after more than two consecutive empty
878 ;; lines: limit ourselves to 2 newline characters.
885 ;;;; Headline
888 "Return node properties associated to headline at point.
889 Upcase property names. It avoids confusion between properties
890 obtained through property drawer and default properties from the
891 parser (e.g. `:end' and :END:). Return value is a plist."
903 properties))))
906 "Return time properties associated to headline at point.
907 Return value is a plist."
921 plist))))
924 "Parse a headline.
926 Return a list whose CAR is `headline' and CDR is a plist
927 containing `:raw-value', `:title', `:begin', `:end',
928 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
929 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
930 `:deadline', `:closed', `:archivedp', `:commentedp'
931 `:footnote-section-p', `:post-blank' and `:post-affiliated'
932 keywords.
934 The plist also contains any property set in the property drawer,
935 with its name in upper cases and colons added at the
936 beginning (e.g., `:CUSTOM_ID').
938 LIMIT is a buffer position bounding the search.
940 When RAW-SECONDARY-P is non-nil, headline's title will not be
941 parsed as a secondary string, but as a plain string instead.
943 Assume point is at beginning of the headline."
989 :begin begin
990 :end end
991 :pre-blank
994 :contents-begin contents-begin
995 :contents-end contents-end
996 :level level
997 :priority priority
998 :tags tags
999 :todo-keyword todo
1000 :todo-type todo-type
1001 :post-blank
1005 :footnote-section-p footnote-section-p
1006 :archivedp archivedp
1007 :commentedp commentedp
1009 time-props
1010 standard-props))))
1012 headline :title
1021 nil
1023 headline)))))))
1026 "Interpret HEADLINE element as Org syntax.
1027 CONTENTS is the contents of the element."
1040 ?*)
1044 " "
1047 org-footnote-section
1048 title))))
1050 heading
1051 ;; Align tags.
1059 ?\s)
1060 tags))
1064 tags))))
1066 contents)))
1069 ;;;; Inlinetask
1072 "Parse an inline task.
1074 Return a list whose CAR is `inlinetask' and CDR is a plist
1075 containing `:title', `:begin', `:end', `:pre-blank',
1076 `:contents-begin' and `:contents-end', `:level', `:priority',
1077 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1078 `:scheduled', `:deadline', `:closed', `:post-blank' and
1079 `:post-affiliated' keywords.
1081 The plist also contains any property set in the property drawer,
1082 with its name in upper cases and colons added at the
1083 beginning (e.g., `:CUSTOM_ID').
1085 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1086 title will not be parsed as a secondary string, but as a plain
1087 string instead.
1089 Assume point is at beginning of the inline task."
1136 :begin begin
1137 :end end
1138 :pre-blank
1141 :contents-begin contents-begin
1142 :contents-end contents-end
1143 :level level
1144 :priority priority
1145 :tags tags
1146 :todo-keyword todo
1147 :todo-type todo-type
1150 time-props
1151 standard-props))))
1153 inlinetask :title
1162 nil
1164 inlinetask))))))
1167 "Interpret INLINETASK element as Org syntax.
1168 CONTENTS is the contents of inlinetask."
1182 ;; Align tags.
1190 ?\s)
1191 tags))
1195 tags))))
1196 ;; Prefer degenerate inlinetasks when there are no
1197 ;; contents.
1200 contents
1204 ;;;; Item
1207 "Parse an item.
1209 STRUCT is the structure of the plain list.
1211 Return a list whose CAR is `item' and CDR is a plist containing
1212 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1213 `:checkbox', `:counter', `:tag', `:structure', `:pre-blank',
1214 `:post-blank' and `:post-affiliated' keywords.
1216 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1217 any, will not be parsed as a secondary string, but as a plain
1218 string instead.
1220 Assume point is at the beginning of the item."
1245 ;; Ignore tags in un-ordered lists: they are just
1246 ;; a part of item's body.
1253 ;; If first line isn't empty, contents really
1254 ;; start at the text after item's meta-data.
1267 :begin begin
1268 :end end
1269 :contents-begin contents-begin
1270 :contents-end contents-end
1271 :checkbox checkbox
1272 :counter counter
1273 :structure struct
1274 :pre-blank pre-blank
1278 item :tag
1285 item))))))))
1288 "Interpret ITEM element as Org syntax.
1289 CONTENTS is the contents of the element."
1301 bullet
1310 tag
1315 ;; 0 is specific to paragraphs at the
1316 ;; beginning of the item, so we use 1 as
1317 ;; a fall-back value, which is more universal.
1319 ;; Lists ends after more than two consecutive
1320 ;; empty lines: limit ourselves to 2 newline
1321 ;; characters.
1329 ;;;; Plain List
1332 ;; Return structure of list at point. Internal function. See
1333 ;; `org-list-struct' for details.
1338 items struct)
1343 ;; At limit: end all items.
1349 ;; At list end: end all items.
1353 ;; At a new item: end previous sibling.
1365 ind
1366 bullet
1369 ;; Description tag.
1373 ;; Ending position, unknown so far.
1374 nil)))
1375 items))
1377 ;; Skip empty lines.
1379 ;; Skip inline tasks and blank lines along the way.
1386 ;; At some text line. Check if it ends any previous item.
1400 ;; Skip blocks (any type) and drawers contents.
1405 limit t)))
1411 "Parse a plain list.
1413 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1414 the buffer position at the beginning of the first affiliated
1415 keyword and CDR is a plist of affiliated keywords along with
1416 their value. STRUCTURE is the structure of the plain list being
1417 parsed.
1419 Return a list whose CAR is `plain-list' and CDR is a plist
1420 containing `:type', `:begin', `:end', `:contents-begin' and
1421 `:contents-end', `:structure', `:post-blank' and
1422 `:post-affiliated' keywords.
1424 Assume point is at the beginning of the list."
1438 pos))
1442 ;; Return value.
1446 :begin begin
1447 :end end
1448 :contents-begin contents-begin
1449 :contents-end contents-end
1450 :structure struct
1456 "Interpret plain-list element as Org syntax.
1457 CONTENTS is the contents of the element."
1465 ;;;; Property Drawer
1468 "Parse a property drawer.
1470 LIMIT bounds the search.
1472 Return a list whose car is `property-drawer' and cdr is a plist
1473 containing `:begin', `:end', `:contents-begin', `:contents-end',
1474 `:post-blank' and `:post-affiliated' keywords.
1476 Assume point is at the beginning of the property drawer."
1489 :end end
1491 :contents-end contents-end
1496 "Interpret property-drawer element as Org syntax.
1497 CONTENTS is the properties within the drawer."
1501 ;;;; Quote Block
1504 "Parse a quote block.
1506 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1507 the buffer position at the beginning of the first affiliated
1508 keyword and CDR is a plist of affiliated keywords along with
1509 their value.
1511 Return a list whose CAR is `quote-block' and CDR is a plist
1512 containing `:begin', `:end', `:contents-begin', `:contents-end',
1513 `:post-blank' and `:post-affiliated' keywords.
1515 Assume point is at the beginning of the block."
1519 ;; Incomplete block: parse it as a paragraph.
1525 ;; Empty blocks have no contents.
1538 :end end
1539 :contents-begin contents-begin
1540 :contents-end contents-end
1546 "Interpret quote-block element as Org syntax.
1547 CONTENTS is the contents of the element."
1551 ;;;; Section
1554 "Parse a section.
1556 Return a list whose CAR is `section' and CDR is a plist
1557 containing `:begin', `:end', `:contents-begin', `contents-end',
1558 `:post-blank' and `:post-affiliated' keywords."
1560 ;; Beginning of section is the beginning of the first non-blank
1561 ;; line after previous headline.
1569 :end end
1570 :contents-begin begin
1571 :contents-end pos-before-blank
1576 "Interpret section element as Org syntax.
1577 CONTENTS is the contents of the element."
1578 contents)
1581 ;;;; Special Block
1584 "Parse a special block.
1586 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1587 the buffer position at the beginning of the first affiliated
1588 keyword and CDR is a plist of affiliated keywords along with
1589 their value.
1591 Return a list whose CAR is `special-block' and CDR is a plist
1592 containing `:type', `:begin', `:end', `:contents-begin',
1593 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1595 Assume point is at the beginning of the block."
1602 limit t)))
1603 ;; Incomplete block: parse it as a paragraph.
1609 ;; Empty blocks have no contents.
1622 :begin begin
1623 :end end
1624 :contents-begin contents-begin
1625 :contents-end contents-end
1631 "Interpret SPECIAL-BLOCK element as Org syntax.
1632 CONTENTS is the contents of the element."
1637 \f
1638 ;;; Elements
1639 ;;
1640 ;; For each element, a parser and an interpreter are also defined.
1641 ;; Both follow the same naming convention used for greater elements.
1642 ;;
1643 ;; Also, as for greater elements, adding a new element type is done
1644 ;; through the following steps: implement a parser and an interpreter,
1645 ;; tweak `org-element--current-element' so that it recognizes the new
1646 ;; type and add that new type to `org-element-all-elements'.
1649 ;;;; Babel Call
1652 "Parse a babel call.
1654 LIMIT bounds the search. AFFILIATED is a list of which car is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and cdr is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose car is `babel-call' and cdr is a plist
1660 containing `:call', `:inside-header', `:arguments',
1661 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1662 `:post-affiliated' as keywords."
1690 :inside-header inside-header
1691 :arguments arguments
1692 :end-header end-header
1693 :begin begin
1694 :end end
1695 :value value
1701 "Interpret BABEL-CALL element as Org syntax."
1711 ;;;; Clock
1714 "Parse a clock.
1716 LIMIT bounds the search.
1718 Return a list whose CAR is `clock' and CDR is a plist containing
1719 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1720 `:post-affiliated' as keywords."
1740 :value value
1741 :duration duration
1742 :begin begin
1743 :end end
1744 :post-blank post-blank
1748 "Interpret CLOCK element as Org syntax."
1756 "%2s:%02s"
1760 ;;;; Comment
1763 "Parse a comment.
1765 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1766 the buffer position at the beginning of the first affiliated
1767 keyword and CDR is a plist of affiliated keywords along with
1768 their value.
1770 Return a list whose CAR is `comment' and CDR is a plist
1771 containing `:begin', `:end', `:value', `:post-blank',
1772 `:post-affiliated' keywords.
1774 Assume point is at comment beginning."
1783 ;; Get comments ending.
1786 ;; Accumulate lines without leading hash and first
1787 ;; whitespace.
1801 :end end
1802 :value value
1808 "Interpret COMMENT element as Org syntax.
1809 CONTENTS is nil."
1813 ;;;; Comment Block
1816 "Parse an export block.
1818 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1819 the buffer position at the beginning of the first affiliated
1820 keyword and CDR is a plist of affiliated keywords along with
1821 their value.
1823 Return a list whose CAR is `comment-block' and CDR is a plist
1824 containing `:begin', `:end', `:value', `:post-blank' and
1825 `:post-affiliated' keywords.
1827 Assume point is at comment block beginning."
1831 ;; Incomplete block: parse it as a paragraph.
1844 contents-begin contents-end)))
1848 :end end
1849 :value value
1855 "Interpret COMMENT-BLOCK element as Org syntax."
1862 ;;;; Diary Sexp
1865 "Parse a diary sexp.
1867 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1868 the buffer position at the beginning of the first affiliated
1869 keyword and CDR is a plist of affiliated keywords along with
1870 their value.
1872 Return a list whose CAR is `diary-sexp' and CDR is a plist
1873 containing `:begin', `:end', `:value', `:post-blank' and
1874 `:post-affiliated' keywords."
1886 :begin begin
1887 :end end
1893 "Interpret DIARY-SEXP as Org syntax."
1897 ;;;; Example Block
1900 "Parse an example block.
1902 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1903 the buffer position at the beginning of the first affiliated
1904 keyword and CDR is a plist of affiliated keywords along with
1905 their value.
1907 Return a list whose CAR is `example-block' and CDR is a plist
1908 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1909 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1910 `:value', `:post-blank' and `:post-affiliated' keywords."
1914 ;; Incomplete block: parse it as a paragraph.
1922 ;; Switches analysis.
1926 switches)
1929 'new
1932 ;; Subtract 1 to give number of lines before
1933 ;; first line.
1937 ;; Should labels be retained in (or stripped from) example
1938 ;; blocks?
1943 ;; What should code-references use - labels or
1944 ;; line-numbers?
1953 ;; Standard block parsing.
1959 contents-begin contents-end)))
1968 :end end
1969 :value value
1970 :switches switches
1971 :number-lines number-lines
1972 :preserve-indent preserve-indent
1973 :retain-labels retain-labels
1974 :use-labels use-labels
1975 :label-fmt label-fmt
1981 "Interpret EXAMPLE-BLOCK element as Org syntax."
1988 val)
2001 ;;;; Export Block
2004 "Parse an export block.
2006 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2007 the buffer position at the beginning of the first affiliated
2008 keyword and CDR is a plist of affiliated keywords along with
2009 their value.
2011 Return a list whose CAR is `export-block' and CDR is a plist
2012 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2013 `:post-affiliated' keywords.
2015 Assume point is at export-block beginning."
2019 ;; Incomplete block: parse it as a paragraph.
2038 contents-end))))
2042 :begin begin
2043 :end end
2044 :value value
2050 "Interpret EXPORT-BLOCK element as Org syntax."
2056 ;;;; Fixed-width
2059 "Parse a fixed-width section.
2061 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2062 the buffer position at the beginning of the first affiliated
2063 keyword and CDR is a plist of affiliated keywords along with
2064 their value.
2066 Return a list whose CAR is `fixed-width' and CDR is a plist
2067 containing `:begin', `:end', `:value', `:post-blank' and
2068 `:post-affiliated' keywords.
2070 Assume point is at the beginning of the fixed-width area."
2074 value
2079 ;; Accumulate text without starting colons.
2092 :end end
2093 :value value
2099 "Interpret FIXED-WIDTH element as Org syntax."
2107 ;;;; Horizontal Rule
2110 "Parse an horizontal rule.
2112 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2113 the buffer position at the beginning of the first affiliated
2114 keyword and CDR is a plist of affiliated keywords along with
2115 their value.
2117 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2118 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2119 keywords."
2129 :end end
2135 "Interpret HORIZONTAL-RULE element as Org syntax."
2139 ;;;; Keyword
2142 "Parse a keyword at point.
2144 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2145 the buffer position at the beginning of the first affiliated
2146 keyword and CDR is a plist of affiliated keywords along with
2147 their value.
2149 Return a list whose CAR is `keyword' and CDR is a plist
2150 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2151 `:post-affiliated' keywords."
2153 ;; An orphaned affiliated keyword is considered as a regular
2154 ;; keyword. In this case AFFILIATED is nil, so we take care of
2155 ;; this corner case.
2168 :value value
2169 :begin begin
2170 :end end
2176 "Interpret KEYWORD element as Org syntax."
2182 ;;;; Latex Environment
2186 "Regexp matching the beginning of a LaTeX environment.
2187 The environment is captured by the first group.
2193 "Format string matching the ending of a LaTeX environment.
2197 "Parse a LaTeX environment.
2199 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2200 the buffer position at the beginning of the first affiliated
2201 keyword and CDR is a plist of affiliated keywords along with
2202 their value.
2204 Return a list whose CAR is `latex-environment' and CDR is a plist
2205 containing `:begin', `:end', `:value', `:post-blank' and
2206 `:post-affiliated' keywords.
2208 Assume point is at the beginning of the latex environment."
2215 limit t))
2216 ;; Incomplete latex environment: parse it as a paragraph.
2226 :end end
2227 :value value
2233 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2237 ;;;; Node Property
2240 "Parse a node-property at point.
2242 LIMIT bounds the search.
2244 Return a list whose CAR is `node-property' and CDR is a plist
2245 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2246 `:post-affiliated' keywords."
2256 limit))))
2259 :value value
2260 :begin begin
2261 :end end
2266 "Interpret NODE-PROPERTY element as Org syntax."
2272 ;;;; Paragraph
2275 "Parse a paragraph.
2277 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2278 the buffer position at the beginning of the first affiliated
2279 keyword and CDR is a plist of affiliated keywords along with
2280 their value.
2282 Return a list whose CAR is `paragraph' and CDR is a plist
2283 containing `:begin', `:end', `:contents-begin' and
2284 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2286 Assume point is at the beginning of the paragraph."
2293 ;; A matching `org-element-paragraph-separate' is not
2294 ;; necessarily the end of the paragraph. In particular,
2295 ;; drawers, blocks or LaTeX environments opening lines
2296 ;; must be closed. Moreover keywords with a secondary
2297 ;; value must belong to "dual keywords".
2311 limit t)))
2317 limit t)))
2320 org-element-dual-keywords))
2321 ;; Everything else is unambiguous.
2334 :end end
2335 :contents-begin contents-begin
2336 :contents-end contents-end
2342 "Interpret paragraph element as Org syntax.
2343 CONTENTS is the contents of the element."
2344 contents)
2347 ;;;; Planning
2350 "Parse a planning.
2352 LIMIT bounds the search.
2354 Return a list whose CAR is `planning' and CDR is a plist
2355 containing `:closed', `:deadline', `:scheduled', `:begin',
2356 `:end', `:post-blank' and `:post-affiliated' keywords."
2366 closed deadline scheduled)
2378 :deadline deadline
2379 :scheduled scheduled
2380 :begin begin
2381 :end end
2382 :post-blank post-blank
2386 "Interpret PLANNING element as Org syntax."
2388 #'identity
2405 ;;;; Src Block
2408 "Parse a src block.
2410 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2411 the buffer position at the beginning of the first affiliated
2412 keyword and CDR is a plist of affiliated keywords along with
2413 their value.
2415 Return a list whose CAR is `src-block' and CDR is a plist
2416 containing `:language', `:switches', `:parameters', `:begin',
2417 `:end', `:number-lines', `:retain-labels', `:use-labels',
2418 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2419 `:post-affiliated' keywords.
2421 Assume point is at the beginning of the block."
2424 limit t)))
2425 ;; Incomplete block: parse it as a paragraph.
2431 ;; Get language as a string.
2440 ;; Get switches.
2442 ;; Get parameters.
2444 ;; Switches analysis.
2448 switches)
2451 'new
2454 ;; Subtract 1 to give number of lines before
2455 ;; first line.
2463 ;; Should labels be retained in (or stripped from)
2464 ;; src blocks?
2469 ;; What should code-references use - labels or
2470 ;; line-numbers?
2475 ;; Retrieve code.
2482 ;; Get position after ending blank lines.
2492 :begin begin
2493 :end end
2494 :number-lines number-lines
2495 :preserve-indent preserve-indent
2496 :retain-labels retain-labels
2497 :use-labels use-labels
2498 :label-fmt label-fmt
2499 :value value
2505 "Interpret SRC-BLOCK element as Org syntax."
2514 val)
2529 ;;;; Table
2532 "Parse a table at point.
2534 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2535 the buffer position at the beginning of the first affiliated
2536 keyword and CDR is a plist of affiliated keywords along with
2537 their value.
2539 Return a list whose CAR is `table' and CDR is a plist containing
2540 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2541 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2542 keywords.
2544 Assume point is at the beginning of the table."
2560 acc))
2567 :end end
2568 :type type
2569 :tblfm tblfm
2570 ;; Only `org' tables have contents. `table.el' tables
2571 ;; use a `:value' property to store raw table as
2572 ;; a string.
2577 table-begin table-end))
2583 "Interpret TABLE element as Org syntax.
2584 CONTENTS is a string, if table's type is `org', or nil."
2595 ;;;; Table Row
2598 "Parse table row at point.
2600 Return a list whose CAR is `table-row' and CDR is a plist
2601 containing `:begin', `:end', `:contents-begin', `:contents-end',
2602 `:type', `:post-blank' and `:post-affiliated' keywords."
2606 ;; A table rule has no contents. In that case, ensure
2607 ;; CONTENTS-BEGIN matches CONTENTS-END.
2617 :begin begin
2618 :end end
2619 :contents-begin contents-begin
2620 :contents-end contents-end
2625 "Interpret TABLE-ROW element as Org syntax.
2626 CONTENTS is the contents of the table row."
2631 ;;;; Verse Block
2634 "Parse a verse block.
2636 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2637 the buffer position at the beginning of the first affiliated
2638 keyword and CDR is a plist of affiliated keywords along with
2639 their value.
2641 Return a list whose CAR is `verse-block' and CDR is a plist
2642 containing `:begin', `:end', `:contents-begin', `:contents-end',
2643 `:post-blank' and `:post-affiliated' keywords.
2645 Assume point is at beginning of the block."
2649 ;; Incomplete block: parse it as a paragraph.
2664 :end end
2665 :contents-begin contents-begin
2666 :contents-end contents-end
2672 "Interpret verse-block element as Org syntax.
2673 CONTENTS is verse block contents."
2677 \f
2678 ;;; Objects
2679 ;;
2680 ;; Unlike to elements, raw text can be found between objects. Hence,
2681 ;; `org-element--object-lex' is provided to find the next object in
2682 ;; buffer.
2683 ;;
2684 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2685 ;; object types they can contain will be specified in
2686 ;; `org-element-object-restrictions'.
2687 ;;
2688 ;; Creating a new type of object requires to alter
2689 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2690 ;; new type in `org-element-all-objects', and possibly add
2691 ;; restrictions in `org-element-object-restrictions'.
2693 ;;;; Bold
2696 "Parse bold object at point, if any.
2698 When at a bold object, return a list whose car is `bold' and cdr
2699 is a plist with `:begin', `:end', `:contents-begin' and
2700 `:contents-end' and `:post-blank' keywords. Otherwise, return
2701 nil.
2703 Assume point is at the first star marker."
2715 :end end
2716 :contents-begin contents-begin
2717 :contents-end contents-end
2721 "Interpret bold object as Org syntax.
2722 CONTENTS is the contents of the object."
2726 ;;;; Code
2729 "Parse code object at point, if any.
2731 When at a code object, return a list whose car is `code' and cdr
2732 is a plist with `:value', `:begin', `:end' and `:post-blank'
2733 keywords. Otherwise, return nil.
2735 Assume point is at the first tilde marker."
2746 :begin begin
2747 :end end
2751 "Interpret CODE object as Org syntax."
2755 ;;;; Entity
2758 "Parse entity at point, if any.
2760 When at an entity, return a list whose car is `entity' and cdr
2761 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2762 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2763 `:post-blank' as keywords. Otherwise, return nil.
2765 Assume point is at the beginning of the entity."
2767 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2785 :begin begin
2786 :end end
2787 :use-brackets-p bracketsp
2791 "Interpret ENTITY object as Org syntax."
2797 ;;;; Export Snippet
2800 "Parse export snippet at point.
2802 When at an export snippet, return a list whose car is
2803 `export-snippet' and cdr a plist with `:begin', `:end',
2804 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2805 return nil.
2807 Assume point is at the beginning of the snippet."
2823 :value value
2824 :begin begin
2825 :end end
2829 "Interpret EXPORT-SNIPPET object as Org syntax."
2835 ;;;; Footnote Reference
2838 "Parse footnote reference at point, if any.
2840 When at a footnote reference, return a list whose car is
2841 `footnote-reference' and cdr a plist with `:label', `:type',
2842 `:begin', `:end', `:content-begin', `:contents-end' and
2843 `:post-blank' as keywords. Otherwise, return nil."
2859 :type type
2860 :begin begin
2861 :end end
2867 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2868 CONTENTS is its definition, when inline, or nil."
2874 ;;;; Inline Babel Call
2877 "Parse inline babel call at point, if any.
2879 When at an inline babel call, return a list whose car is
2880 `inline-babel-call' and cdr a plist with `:call',
2881 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2882 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2884 Assume point is at the beginning of the babel call."
2898 ;; Parenthesis are mandatory.
2909 :inside-header inside-header
2910 :arguments arguments
2911 :end-header end-header
2912 :begin begin
2913 :end end
2914 :value value
2918 "Interpret INLINE-BABEL-CALL object as Org syntax."
2928 ;;;; Inline Src Block
2931 "Parse inline source block at point, if any.
2933 When at an inline source block, return a list whose car is
2934 `inline-src-block' and cdr a plist with `:begin', `:end',
2935 `:language', `:value', `:parameters' and `:post-blank' as
2936 keywords. Otherwise, return nil.
2938 Assume point is at the beginning of the inline src block."
2955 :value value
2956 :parameters parameters
2957 :begin begin
2962 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2967 language
2969 body)))
2971 ;;;; Italic
2974 "Parse italic object at point, if any.
2976 When at an italic object, return a list whose car is `italic' and
2977 cdr is a plist with `:begin', `:end', `:contents-begin' and
2978 `:contents-end' and `:post-blank' keywords. Otherwise, return
2979 nil.
2981 Assume point is at the first slash marker."
2993 :end end
2994 :contents-begin contents-begin
2995 :contents-end contents-end
2999 "Interpret italic object as Org syntax.
3000 CONTENTS is the contents of the object."
3004 ;;;; Latex Fragment
3007 "Parse LaTeX fragment at point, if any.
3009 When at a LaTeX fragment, return a list whose car is
3010 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3011 and `:post-blank' as keywords. Otherwise, return nil.
3013 Assume point is at the beginning of the LaTeX fragment."
3024 ;; Macro.
3047 :begin begin
3048 :end end
3052 "Interpret LATEX-FRAGMENT object as Org syntax."
3055 ;;;; Line Break
3058 "Parse line break at point, if any.
3060 When at a line break, return a list whose car is `line-break',
3061 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3062 Otherwise, return nil.
3064 Assume point is at the beginning of the line break."
3073 "Interpret LINE-BREAK object as Org syntax."
3077 ;;;; Link
3080 "Parse link at point, if any.
3082 When at a link, return a list whose car is `link' and cdr a plist
3083 with `:type', `:path', `:format', `:raw-link', `:application',
3084 `:search-option', `:begin', `:end', `:contents-begin',
3085 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3086 nil.
3088 Assume point is at the beginning of the link."
3091 end contents-begin contents-end link-end post-blank path type format
3092 raw-link search-option application)
3094 ;; Type 1: Text targeted from a radio target.
3104 ;; Type 2: Standard link, i.e. [[https://orgmode.org][homepage]]
3110 ;; RAW-LINK is the original link. Expand any
3111 ;; abbreviation in it.
3112 ;;
3113 ;; Also treat any newline character and associated
3114 ;; indentation as a single space character. This is not
3115 ;; compatible with RFC 3986, which requires to ignore
3116 ;; them altogether. However, doing so would require
3117 ;; users to encode spaces on the fly when writing links
3118 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3119 ;; [[shell:ls *.org]], which defeats Org's focus on
3120 ;; simplicity.
3125 ;; Determine TYPE of link and set PATH accordingly. According
3126 ;; to RFC 3986, remove whitespaces from URI in external links.
3127 ;; In internal ones, treat indentation as a single space.
3129 ;; File type.
3134 ;; Explicit type (http, irc, bbdb...).
3138 ;; Code-ref type: PATH is the name of the reference.
3143 ;; Custom-id type: PATH is the name of the custom id.
3147 ;; Fuzzy type: Internal link either matches a target, an
3148 ;; headline name or nothing. PATH is the target or
3149 ;; headline's name.
3153 ;; Type 3: Plain link, e.g., https://orgmode.org
3160 ;; Type 4: Angular link, e.g., <https://orgmode.org>. Unlike to
3161 ;; bracket links, follow RFC 3986 and remove any extra
3162 ;; whitespace in URI.
3173 ;; In any case, deduce end point after trailing white space from
3174 ;; LINK-END variable.
3179 ;; Special "file" type link processing. Extract opening
3180 ;; application and search option, if any. Also normalize URI.
3187 ;; Translate link, if `org-link-translation-function' is set.
3195 :path path
3196 :format format
3198 :application application
3199 :search-option search-option
3200 :begin begin
3201 :end end
3202 :contents-begin contents-begin
3203 :contents-end contents-end
3207 "Interpret LINK object as Org syntax.
3208 CONTENTS is the contents of the object, or nil."
3213 ;; Links with contents and internal links have to
3214 ;; use bracket syntax. Ignore `:format' in these
3215 ;; cases. This is also the default syntax when the
3216 ;; property is not defined, e.g., when the object
3217 ;; was crafted by the user.
3220 ;; Since this is going to be used as
3221 ;; a format string, escape percent signs
3222 ;; in description.
3225 `nil
3228 ;; Otherwise, just obey to `:format'.
3240 path
3246 ;;;; Macro
3249 "Parse macro at point, if any.
3251 When at a macro, return a list whose car is `macro' and cdr
3252 a plist with `:key', `:args', `:begin', `:end', `:value' and
3253 `:post-blank' as keywords. Otherwise, return nil.
3255 Assume point is at the macro."
3271 :value value
3272 :args args
3273 :begin begin
3274 :end end
3278 "Interpret MACRO object as Org syntax."
3286 ;;;; Radio-target
3289 "Parse radio target at point, if any.
3291 When at a radio target, return a list whose car is `radio-target'
3292 and cdr a plist with `:begin', `:end', `:contents-begin',
3293 `:contents-end', `:value' and `:post-blank' as keywords.
3294 Otherwise, return nil.
3296 Assume point is at the radio target."
3308 :end end
3309 :contents-begin contents-begin
3310 :contents-end contents-end
3311 :post-blank post-blank
3315 "Interpret target object as Org syntax.
3316 CONTENTS is the contents of the object."
3320 ;;;; Statistics Cookie
3323 "Parse statistics cookie at point, if any.
3325 When at a statistics cookie, return a list whose car is
3326 `statistics-cookie', and cdr a plist with `:begin', `:end',
3327 `:value' and `:post-blank' keywords. Otherwise, return nil.
3329 Assume point is at the beginning of the statistics-cookie."
3340 :end end
3341 :value value
3345 "Interpret STATISTICS-COOKIE object as Org syntax."
3349 ;;;; Strike-Through
3352 "Parse strike-through object at point, if any.
3354 When at a strike-through object, return a list whose car is
3355 `strike-through' and cdr is a plist with `:begin', `:end',
3356 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3357 Otherwise, return nil.
3359 Assume point is at the first plus sign marker."
3371 :end end
3372 :contents-begin contents-begin
3373 :contents-end contents-end
3377 "Interpret strike-through object as Org syntax.
3378 CONTENTS is the contents of the object."
3382 ;;;; Subscript
3385 "Parse subscript at point, if any.
3387 When at a subscript object, return a list whose car is
3388 `subscript' and cdr a plist with `:begin', `:end',
3389 `:contents-begin', `:contents-end', `:use-brackets-p' and
3390 `:post-blank' as keywords. Otherwise, return nil.
3392 Assume point is at the underscore."
3406 :end end
3407 :use-brackets-p bracketsp
3408 :contents-begin contents-begin
3409 :contents-end contents-end
3413 "Interpret SUBSCRIPT object as Org syntax.
3414 CONTENTS is the contents of the object."
3417 contents))
3420 ;;;; Superscript
3423 "Parse superscript at point, if any.
3425 When at a superscript object, return a list whose car is
3426 `superscript' and cdr a plist with `:begin', `:end',
3427 `:contents-begin', `:contents-end', `:use-brackets-p' and
3428 `:post-blank' as keywords. Otherwise, return nil.
3430 Assume point is at the caret."
3444 :end end
3445 :use-brackets-p bracketsp
3446 :contents-begin contents-begin
3447 :contents-end contents-end
3451 "Interpret SUPERSCRIPT object as Org syntax.
3452 CONTENTS is the contents of the object."
3455 contents))
3458 ;;;; Table Cell
3461 "Parse table cell at point.
3462 Return a list whose car is `table-cell' and cdr is a plist
3463 containing `:begin', `:end', `:contents-begin', `:contents-end'
3464 and `:post-blank' keywords."
3472 :end end
3473 :contents-begin contents-begin
3474 :contents-end contents-end
3478 "Interpret table-cell element as Org syntax.
3479 CONTENTS is the contents of the cell, or nil."
3483 ;;;; Target
3486 "Parse target at point, if any.
3488 When at a target, return a list whose car is `target' and cdr
3489 a plist with `:begin', `:end', `:value' and `:post-blank' as
3490 keywords. Otherwise, return nil.
3492 Assume point is at the target."
3502 :end end
3503 :value value
3507 "Interpret TARGET object as Org syntax."
3511 ;;;; Timestamp
3522 "Parse time stamp at point, if any.
3524 When at a time stamp, return a list whose car is `timestamp', and
3525 cdr a plist with `:type', `:raw-value', `:year-start',
3526 `:month-start', `:day-start', `:hour-start', `:minute-start',
3527 `:year-end', `:month-end', `:day-end', `:hour-end',
3528 `:minute-end', `:repeater-type', `:repeater-value',
3529 `:repeater-unit', `:warning-type', `:warning-value',
3530 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3531 Otherwise, return nil.
3533 Assume point is at the beginning of the timestamp."
3552 date-start)
3563 raw-value)
3565 :repeater-type
3571 :repeater-unit
3580 :warning-unit
3583 year-start month-start day-start hour-start minute-start year-end
3584 month-end day-end hour-end minute-end)
3585 ;; Parse date-start.
3593 ;; Compute date-end. It can be provided directly in time-stamp,
3594 ;; or extracted from time range. Otherwise, it defaults to the
3595 ;; same values as date-start.
3605 :raw-value raw-value
3606 :year-start year-start
3607 :month-start month-start
3608 :day-start day-start
3609 :hour-start hour-start
3610 :minute-start minute-start
3611 :year-end year-end
3612 :month-end month-end
3613 :day-end day-end
3614 :hour-end hour-end
3615 :minute-end minute-end
3616 :begin begin
3617 :end end
3619 repeater-props
3620 warning-props))))))
3623 "Interpret TIMESTAMP object as Org syntax."
3641 ;; Build an Org timestamp string from TIME. ACTIVEP is
3642 ;; non-nil when time stamp is active. If WITH-TIME-P is
3643 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3644 ;; specify a time range in the timestamp. REPEAT-STRING is
3645 ;; the repeater string, if any.
3649 org-time-stamp-formats)
3650 time)))
3656 nil nil ts)))
3661 " "
3662 s
3664 ;; Return value.
3665 ts)))
3677 build-ts-string
3696 0
3704 "--"
3717 ;;;; Underline
3720 "Parse underline object at point, if any.
3722 When at an underline object, return a list whose car is
3723 `underline' and cdr is a plist with `:begin', `:end',
3724 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3725 Otherwise, return nil.
3727 Assume point is at the first underscore marker."
3739 :end end
3740 :contents-begin contents-begin
3741 :contents-end contents-end
3745 "Interpret underline object as Org syntax.
3746 CONTENTS is the contents of the object."
3750 ;;;; Verbatim
3753 "Parse verbatim object at point, if any.
3755 When at a verbatim object, return a list whose car is `verbatim'
3756 and cdr is a plist with `:value', `:begin', `:end' and
3757 `:post-blank' keywords. Otherwise, return nil.
3759 Assume point is at the first equal sign marker."
3770 :begin begin
3771 :end end
3775 "Interpret VERBATIM object as Org syntax."
3779 \f
3780 ;;; Parsing Element Starting At Point
3781 ;;
3782 ;; `org-element--current-element' is the core function of this section.
3783 ;; It returns the Lisp representation of the element starting at
3784 ;; point.
3785 ;;
3786 ;; `org-element--current-element' makes use of special modes. They
3787 ;; are activated for fixed element chaining (e.g., `plain-list' >
3788 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3789 ;; `section'). Special modes are: `first-section', `item',
3790 ;; `node-property', `section' and `table-row'.
3793 "Parse the element starting at point.
3795 Return value is a list like (TYPE PROPS) where TYPE is the type
3796 of the element and PROPS a plist of properties associated to the
3797 element.
3799 Possible types are defined in `org-element-all-elements'.
3801 LIMIT bounds the search.
3803 Optional argument GRANULARITY determines the depth of the
3804 recursion. Allowed values are `headline', `greater-element',
3805 `element', `object' or nil. When it is broader than `object' (or
3806 nil), secondary values will not be parsed, since they only
3807 contain objects.
3809 Optional argument MODE, when non-nil, can be either
3810 `first-section', `section', `planning', `item', `node-property'
3811 and `table-row'.
3813 If STRUCTURE isn't provided but MODE is set to `item', it will be
3814 computed.
3816 This function assumes point is always at the beginning of the
3817 element it has to parse."
3820 ;; Determine if parsing depth allows for secondary strings
3821 ;; parsing. It only applies to elements referenced in
3822 ;; `org-element-secondary-value-alist'.
3825 ;; Item.
3828 ;; Table Row.
3830 ;; Node Property.
3832 ;; Headline.
3835 ;; Sections (must be checked after headline).
3840 limit)))
3841 ;; Planning.
3846 ;; Property drawer.
3852 ;; When not at bol, point is at the beginning of an item or
3853 ;; a footnote definition: next item is always a paragraph.
3855 ;; Clock.
3857 ;; Inlinetask.
3860 ;; From there, elements can have affiliated keywords.
3863 ;; Jumping over affiliated keywords put point off-limits.
3864 ;; Parse them as regular keywords.
3868 ;; LaTeX Environment.
3871 ;; Drawer and Property Drawer.
3874 ;; Fixed Width
3877 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3878 ;; Keywords.
3896 limit
3897 affiliated))
3910 ;; Footnote Definition.
3913 ;; Horizontal Rule.
3916 ;; Diary Sexp.
3919 ;; Table.
3922 ;; List.
3925 limit affiliated
3927 ;; Default element: Paragraph.
3931 ;; Most elements can have affiliated keywords. When looking for an
3932 ;; element beginning, we want to move before them, as they belong to
3933 ;; that element, and, in the meantime, collect information they give
3934 ;; into appropriate properties. Hence the following function.
3937 "Collect affiliated keywords from point down to LIMIT.
3939 Return a list whose CAR is the position at the first of them and
3940 CDR a plist of keywords and values and move point to the
3941 beginning of the first line after them.
3943 As a special case, if element doesn't start at the beginning of
3944 the line (e.g., a paragraph starting an item), CAR is current
3945 position of point and CDR is nil."
3949 ;; RESTRICT is the list of objects allowed in parsed
3950 ;; keywords value.
3952 output)
3955 ;; Apply translation to RAW-KWD. From there, KWD is
3956 ;; the official keyword.
3958 org-element-keyword-translation-alist))
3959 raw-kwd))
3960 ;; Find main value for any keyword.
3966 ;; PARSEDP is non-nil when keyword should have its
3967 ;; value parsed.
3969 ;; If KWD is a dual keyword, find its secondary
3970 ;; value. Maybe parse it.
3979 ;; Attribute a property name to KWD.
3981 ;; Now set final shape for VALUE.
3987 nil restrict)))
3991 ;; Attributes can always appear on multiple lines.
3994 ;; Eventually store the new value in OUTPUT.
3996 ;; Move to next keyword.
3998 ;; If affiliated keywords are orphaned: move back to first one.
3999 ;; They will be parsed as a paragraph.
4001 ;; Return value.
4005 \f
4006 ;;; The Org Parser
4007 ;;
4008 ;; The two major functions here are `org-element-parse-buffer', which
4009 ;; parses Org syntax inside the current buffer, taking into account
4010 ;; region, narrowing, or even visibility if specified, and
4011 ;; `org-element-parse-secondary-string', which parses objects within
4012 ;; a given string.
4013 ;;
4014 ;; The (almost) almighty `org-element-map' allows applying a function
4015 ;; on elements or objects matching some type, and accumulating the
4016 ;; resulting values. In an export situation, it also skips unneeded
4017 ;; parts of the parse tree.
4020 "Recursively parse the buffer and return structure.
4021 If narrowing is in effect, only parse the visible part of the
4022 buffer.
4024 Optional argument GRANULARITY determines the depth of the
4025 recursion. It can be set to the following symbols:
4027 `headline' Only parse headlines.
4028 `greater-element' Don't recurse into greater elements except
4029 headlines and sections. Thus, elements
4030 parsed are the top-level ones.
4031 `element' Parse everything but objects and plain text.
4032 `object' Parse the complete buffer (default).
4034 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4035 elements.
4037 An element or object is represented as a list with the
4038 pattern (TYPE PROPERTIES CONTENTS), where :
4040 TYPE is a symbol describing the element or object. See
4041 `org-element-all-elements' and `org-element-all-objects' for an
4042 exhaustive list of such symbols. One can retrieve it with
4043 `org-element-type' function.
4045 PROPERTIES is the list of attributes attached to the element or
4046 object, as a plist. Although most of them are specific to the
4047 element or object type, all types share `:begin', `:end',
4048 `:post-blank' and `:parent' properties, which respectively
4049 refer to buffer position where the element or object starts,
4050 ends, the number of white spaces or blank lines after it, and
4051 the element or object containing it. Properties values can be
4052 obtained by using `org-element-property' function.
4054 CONTENTS is a list of elements, objects or raw strings
4055 contained in the current element or object, when applicable.
4056 One can access them with `org-element-contents' function.
4058 The Org buffer has `org-data' as type and nil as properties.
4059 `org-element-map' function can be used to find specific elements
4060 or objects within the parse tree.
4062 This function assumes that current major mode is `org-mode'."
4068 ;; Start in `first-section' mode so text before the first
4069 ;; headline belongs to a section.
4073 "Recursively parse objects in STRING and return structure.
4075 RESTRICTION is a symbol limiting the object types that will be
4076 looked after.
4078 Optional argument PARENT, when non-nil, is the element or object
4079 containing the secondary string. It is used to set correctly
4080 `:parent' property within the string.
4082 If STRING is the empty string or nil, return nil."
4099 "Map a function on selected elements or objects.
4101 DATA is a parse tree, an element, an object, a string, or a list
4102 of such constructs. TYPES is a symbol or list of symbols of
4103 elements or objects types (see `org-element-all-elements' and
4104 `org-element-all-objects' for a complete list of types). FUN is
4105 the function called on the matching element or object. It has to
4106 accept one argument: the element or object itself.
4108 When optional argument INFO is non-nil, it should be a plist
4109 holding export options. In that case, parts of the parse tree
4110 not exportable according to that property list will be skipped.
4112 When optional argument FIRST-MATCH is non-nil, stop at the first
4113 match for which FUN doesn't return nil, and return that value.
4115 Optional argument NO-RECURSION is a symbol or a list of symbols
4116 representing elements or objects types. `org-element-map' won't
4117 enter any recursive element or object whose type belongs to that
4118 list. Though, FUN can still be applied on them.
4120 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4121 apply to matching objects within parsed affiliated keywords (see
4122 `org-element-parsed-keywords').
4124 Nil values returned from FUN do not appear in the results.
4127 Examples:
4128 ---------
4130 Assuming TREE is a variable containing an Org buffer parse tree,
4131 the following example will return a flat list of all `src-block'
4132 and `example-block' elements in it:
4136 The following snippet will find the first headline with a level
4140 (lambda (hl)
4141 (and (= (org-element-property :level hl) 1)
4143 (org-element-property :begin hl)))
4144 nil t)
4146 The next example will return a flat list of all `plain-list' type
4147 elements in TREE that are not a sub-list themselves:
4151 Eventually, this example will return a flat list of all `bold'
4152 type objects containing a `latex-snippet' type object, even
4153 looking into captions:
4156 (lambda (b)
4158 nil nil nil t)"
4159 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4163 ;; Recursion depth is determined by --CATEGORY.
4170 ;; If one object is found, the function has
4171 ;; to recurse into every object.
4174 ;; If one regular element is found, the
4175 ;; function has to recurse, at least, into
4176 ;; every element it encounters.
4179 --acc)
4182 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4183 ;; holding contextual information.
4187 ;; Ignored element in an export context.
4189 ;; List of elements or objects.
4191 ;; Unconditionally enter parse trees.
4195 ;; Check if TYPE is matching among TYPES. If so,
4196 ;; apply FUN to --DATA and accumulate return value
4197 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4203 ;; If --DATA has a secondary string that can contain
4204 ;; objects with their type among TYPES, look inside.
4207 org-element-secondary-value-alist)))
4209 ;; If --DATA has any parsed affiliated keywords and
4210 ;; WITH-AFFILIATED is non-nil, look for objects in
4211 ;; them.
4218 ;; Pay attention to the type of parsed
4219 ;; keyword. In particular, preserve order for
4220 ;; multiple keywords.
4233 ;; Determine if a recursion into --DATA is possible.
4235 ;; --TYPE is explicitly removed from recursion.
4237 ;; --DATA has no contents.
4239 ;; Looking for greater elements but --DATA is
4240 ;; simply an element or an object.
4243 ;; Looking for elements but --DATA is an object.
4246 ;; In any other case, map contents.
4250 ;; Return value in a proper order.
4254 ;; The following functions are internal parts of the parser.
4255 ;;
4256 ;; The first one, `org-element--parse-elements' acts at the element's
4257 ;; level.
4258 ;;
4259 ;; The second one, `org-element--parse-objects' applies on all objects
4260 ;; of a paragraph or a secondary string. It calls
4261 ;; `org-element--object-lex' to find the next object in the current
4262 ;; container.
4265 "Return next special mode according to TYPE, or nil.
4266 TYPE is a symbol representing the type of an element or object
4267 containing next element if PARENTP is non-nil, or before it
4268 otherwise. Modes can be either `first-section', `item',
4269 `node-property', `planning', `property-drawer', `section',
4270 `table-row' or nil."
4287 "Parse elements between BEG and END positions.
4289 MODE prioritizes some elements over the others. It can be set to
4290 `first-section', `section', `planning', `item', `node-property'
4291 or `table-row'.
4293 When value is `item', STRUCTURE will be used as the current list
4294 structure.
4296 GRANULARITY determines the depth of the recursion. See
4297 `org-element-parse-buffer' for more information.
4299 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4300 elements.
4302 Elements are accumulated into ACC."
4305 ;; Visible only: skip invisible parts at the beginning of the
4306 ;; element.
4309 ;; When parsing only headlines, skip any text before first one.
4314 ;; Find current element's type and parse it accordingly to
4315 ;; its category.
4317 end granularity mode structure))
4321 ;; Visible only: skip invisible parts between siblings.
4324 ;; Fill ELEMENT contents by side-effect.
4326 ;; If element has no contents, don't modify it.
4328 ;; Greater element: parse it between `contents-begin' and
4329 ;; `contents-end'. Make sure GRANULARITY allows the
4330 ;; recursion, or ELEMENT is a headline, in which case going
4331 ;; inside is mandatory, in order to get sub-level headings.
4339 ;; Possibly switch to a special mode.
4343 granularity visible-only element))
4344 ;; ELEMENT has contents. Parse objects inside, if
4345 ;; GRANULARITY allows it.
4351 ;; Update mode.
4353 ;; Return result.
4357 "Return next object in current buffer or nil.
4358 RESTRICTION is a list of object types, as symbols, that should be
4359 looked after. This function assumes that the buffer is narrowed
4360 to an appropriate container (e.g., a paragraph)."
4364 ;; Object regexp sometimes needs to have a peek at
4365 ;; a character ahead. Therefore, when there is a hard
4366 ;; limit, make it one more than the true beginning of the
4367 ;; radio target.
4374 nil)
4375 ;; Since we moved backward, we do not want to
4376 ;; match again an hypothetical 1-character long
4377 ;; radio link before us. Realizing that this can
4378 ;; only happen if such a radio link starts at
4379 ;; beginning of line, we prevent this here.
4385 found)
4451 ;; This is probably a plain link.
4461 "Parse objects between BEG and END and return recursive structure.
4463 Objects are accumulated in ACC. RESTRICTION is a list of object
4464 successors which are allowed in the current object.
4466 ACC becomes the parent for all parsed objects. However, if ACC
4467 is nil (i.e., a secondary string is being parsed) and optional
4468 argument PARENT is non-nil, use it as the parent for all objects.
4469 Eventually, if both ACC and PARENT are nil, the common parent is
4470 the list of objects itself."
4478 ;; Text before any object.
4483 contents))))
4484 ;; Object...
4489 ;; Fill contents of NEXT-OBJECT if possible.
4491 cont-beg
4493 next-object
4495 next-object)
4496 contents)
4498 ;; Text after last object.
4502 contents)))
4503 ;; Result. Set appropriate parent.
4511 \f
4512 ;;; Towards A Bijective Process
4513 ;;
4514 ;; The parse tree obtained with `org-element-parse-buffer' is really
4515 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4516 ;; interpreted and expanded into a string with canonical Org syntax.
4517 ;; Hence `org-element-interpret-data'.
4518 ;;
4519 ;; The function relies internally on
4520 ;; `org-element--interpret-affiliated-keywords'.
4522 ;;;###autoload
4524 "Interpret DATA as Org syntax.
4525 DATA is a parse tree, an element, an object or a secondary string
4526 to interpret. Return Org syntax as a string."
4530 ;; Find interpreter for current object or
4531 ;; element. If it doesn't exist (e.g. this is
4532 ;; a pseudo object or element), return contents,
4533 ;; if any.
4540 ;; Secondary string.
4543 data
4545 ;; Full Org document.
4550 ;; Plain text: return it.
4552 ;; Element or object without contents.
4555 ;; Element or object with contents.
4558 interpret
4559 data
4560 ;; Recursively interpret contents.
4565 data
4566 ;; Fix indentation of elements containing
4567 ;; objects. We ignore `table-row'
4568 ;; elements as they are one line long
4569 ;; anyway.
4571 data
4572 ;; When normalizing first paragraph of
4573 ;; an item or a footnote-definition,
4574 ;; ignore first line's indentation.
4583 ;; Build white spaces. If no `:post-blank' property
4584 ;; is specified, assume its value is 0.
4594 "Return ELEMENT's affiliated keywords as Org syntax.
4595 If there is no affiliated keyword, return the empty string."
4605 ": "
4608 value)
4616 ;; All attribute keywords can have multiple lines.
4622 ;; List all ELEMENT's properties matching an attribute line or an
4623 ;; affiliated keyword, but ignore translated keywords since they
4624 ;; cannot belong to the property list.
4631 org-element-keyword-translation-alist)))))
4632 collect prop)
4635 ;; Because interpretation of the parse tree must return the same
4636 ;; number of blank lines between elements and the same number of white
4637 ;; space after objects, some special care must be given to white
4638 ;; spaces.
4639 ;;
4640 ;; The first function, `org-element-normalize-string', ensures any
4641 ;; string different from the empty string will end with a single
4642 ;; newline character.
4643 ;;
4644 ;; The second function, `org-element-normalize-contents', removes
4645 ;; global indentation from the contents of the current element.
4648 "Ensure string S ends with a single newline character.
4650 If S isn't a string return it unchanged. If S is the empty
4651 string, return it. Otherwise, return a new string with a single
4652 newline character at its end."
4660 "Normalize plain text in ELEMENT's contents.
4662 ELEMENT must only contain plain text and objects.
4664 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4665 indentation to compute maximal common indentation.
4667 Return the normalized element that is element with global
4668 indentation removed from its contents."
4670 ;; Return minimal common indentation within BLOB. This is
4671 ;; done by walking recursively BLOB and updating MIN-IND
4672 ;; along the way. FIRST-FLAG is non-nil when the next
4673 ;; object is expected to be a string that doesn't start
4674 ;; with a newline character. It happens for strings at
4675 ;; the beginnings of the contents or right after a line
4676 ;; break.
4682 ;; Objects cannot start with spaces: in this
4683 ;; case, indentation is 0.
4724 ;; Build ELEMENT back, replacing each string with the same
4725 ;; string minus common indentation.
4728 ;; Return DATUM with all its strings indentation
4729 ;; shortened from MIN-IND white spaces.
4749 org-element-recursive-objects)
4753 datum)))
4757 \f
4758 ;;; Cache
4759 ;;
4760 ;; Implement a caching mechanism for `org-element-at-point' and
4761 ;; `org-element-context', which see.
4762 ;;
4763 ;; A single public function is provided: `org-element-cache-reset'.
4764 ;;
4765 ;; Cache is enabled by default, but can be disabled globally with
4766 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4767 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4768 ;; can be tweaked to control caching behaviour.
4769 ;;
4770 ;; Internally, parsed elements are stored in an AVL tree,
4771 ;; `org-element--cache'. This tree is updated lazily: whenever
4772 ;; a change happens to the buffer, a synchronization request is
4773 ;; registered in `org-element--cache-sync-requests' (see
4774 ;; `org-element--cache-submit-request'). During idle time, requests
4775 ;; are processed by `org-element--cache-sync'. Synchronization also
4776 ;; happens when an element is required from the cache. In this case,
4777 ;; the process stops as soon as the needed element is up-to-date.
4778 ;;
4779 ;; A synchronization request can only apply on a synchronized part of
4780 ;; the cache. Therefore, the cache is updated at least to the
4781 ;; location where the new request applies. Thus, requests are ordered
4782 ;; from left to right and all elements starting before the first
4783 ;; request are correct. This property is used by functions like
4784 ;; `org-element--cache-find' to retrieve elements in the part of the
4785 ;; cache that can be trusted.
4786 ;;
4787 ;; A request applies to every element, starting from its original
4788 ;; location (or key, see below). When a request is processed, it
4789 ;; moves forward and may collide the next one. In this case, both
4790 ;; requests are merged into a new one that starts from that element.
4791 ;; As a consequence, the whole synchronization complexity does not
4792 ;; depend on the number of pending requests, but on the number of
4793 ;; elements the very first request will be applied on.
4794 ;;
4795 ;; Elements cannot be accessed through their beginning position, which
4796 ;; may or may not be up-to-date. Instead, each element in the tree is
4797 ;; associated to a key, obtained with `org-element--cache-key'. This
4798 ;; mechanism is robust enough to preserve total order among elements
4799 ;; even when the tree is only partially synchronized.
4803 "Non-nil when Org parser should cache its results.
4805 WARNING: for the time being, using cache sometimes triggers
4806 freezes. Therefore, it is disabled by default. Activate it if
4813 "Maximum duration, as a time value, for a cache synchronization.
4814 If the synchronization is not over after this delay, the process
4815 pauses and resumes after `org-element-cache-sync-break'
4819 "Duration, as a time value, of the pause between synchronizations.
4823 ;;;; Data Structure
4826 "AVL tree used to cache elements.
4827 Each node of the tree contains an element. Comparison is done
4828 with `org-element--cache-compare'. This cache is used in
4832 "List of pending synchronization requests.
4834 A request is a vector with the following pattern:
4836 \[NEXT BEG END OFFSET PARENT PHASE]
4838 Processing a synchronization request consists of three phases:
4840 0. Delete modified elements,
4841 1. Fill missing area in cache,
4842 2. Shift positions and re-parent elements after the changes.
4844 During phase 0, NEXT is the key of the first element to be
4845 removed, BEG and END is buffer position delimiting the
4846 modifications. Elements starting between them (inclusive) are
4847 removed. So are elements whose parent is removed. PARENT, when
4848 non-nil, is the parent of the first element to be removed.
4850 During phase 1, NEXT is the key of the next known element in
4851 cache and BEG its beginning position. Parse buffer between that
4852 element and the one before it in order to determine the parent of
4853 the next element. Set PARENT to the element containing NEXT.
4855 During phase 2, NEXT is the key of the next element to shift in
4856 the parse tree. All elements starting from this one have their
4857 properties relatives to buffer positions shifted by integer
4858 OFFSET and, if they belong to element PARENT, are adopted by it.
4866 "Hash table used to store keys during synchronization.
4870 "Return a unique key for ELEMENT in cache tree.
4872 Keys are used to keep a total order among elements in the cache.
4873 Comparison is done with `org-element--cache-key-less-p'.
4875 When no synchronization is taking place, a key is simply the
4876 beginning position of the element, or that position plus one in
4877 the case of an first item (respectively row) in
4878 a list (respectively a table).
4880 During a synchronization, the key is the one the element had when
4881 the cache was synchronized for the last time. Elements added to
4882 cache during the synchronization get a new key generated with
4883 `org-element--cache-generate-key'.
4885 Such keys are stored in `org-element--cache-sync-keys'. The hash
4886 table is cleared once the synchronization is complete."
4889 ;; Increase beginning position of items (respectively
4890 ;; table rows) by one, so the first item can get
4891 ;; a different key from its parent list (respectively
4892 ;; table).
4895 begin)))
4898 key))))
4901 "Generate a key between LOWER and UPPER.
4903 LOWER and UPPER are integers or lists, possibly empty.
4905 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4906 a unique key, as an integer or a list of integers, according to
4907 the following rules:
4909 - LOWER and UPPER are compared level-wise until values differ.
4911 - If, at a given level, LOWER and UPPER differ from more than
4912 2, the new key shares all the levels above with LOWER and
4913 gets a new level. Its value is the mean between LOWER and
4914 UPPER:
4916 (1 2) + (1 4) --> (1 3)
4918 - If LOWER has no value to compare with, it is assumed that its
4919 value is `most-negative-fixnum'. E.g.,
4921 (1 1) + (1 1 2)
4923 is equivalent to
4925 (1 1 m) + (1 1 2)
4927 where m is `most-negative-fixnum'. Likewise, if UPPER is
4928 short of levels, the current value is `most-positive-fixnum'.
4930 - If they differ from only one, the new key inherits from
4931 current LOWER level and fork it at the next level. E.g.,
4933 (2 1) + (3 3)
4935 is equivalent to
4937 (2 1) + (2 M)
4939 where M is `most-positive-fixnum'.
4941 - If the key is only one level long, it is returned as an
4942 integer:
4944 (1 2) + (3 2) --> 2
4946 When they are not equals, the function assumes that LOWER is
4947 lesser than UPPER, per `org-element--cache-key-less-p'."
4951 skip-upper key)
4962 ;; When at a given level, LOWER and UPPER differ from
4963 ;; 1, ignore UPPER altogether. Instead create a key
4964 ;; between LOWER and the greatest key with the same
4965 ;; prefix as LOWER so far.
4971 "Non-nil if key A is less than key B.
4972 A and B are either integers or lists of integers, as returned by
4973 `org-element--cache-key'."
4981 ;; If A is empty, either keys are equal (B is also empty) and
4982 ;; we return nil, or A is lesser than B (B is longer) and we
4983 ;; return a non-nil value.
4984 ;;
4985 ;; If A is not empty, B is necessarily empty and A is greater
4986 ;; than B (A is longer). Therefore, return nil.
4990 "Non-nil when element A is located before element B."
4995 "Return root value in cache.
4996 This function assumes `org-element--cache' is a valid AVL tree."
5000 ;;;; Tools
5003 "Non-nil when cache is active in current buffer."
5005 org-element--cache
5009 "Find element in cache starting at POS or before.
5011 POS refers to a buffer position.
5013 When optional argument SIDE is non-nil, the function checks for
5014 elements starting at or past POS instead. If SIDE is `both', the
5015 function returns a cons cell where car is the first element
5016 starting at or before POS and cdr the first element starting
5017 after POS.
5019 The function can only find elements in the synchronized part of
5020 the cache."
5024 lower upper)
5039 ;; We found an element in cache starting at POS. If `side'
5040 ;; is `both' we also want the next one in order to generate
5041 ;; a key in-between.
5042 ;;
5043 ;; If the element is the first row or item in a table or
5044 ;; a plain list, we always return the table or the plain
5045 ;; list.
5046 ;;
5047 ;; In any other case, we return the element found.
5056 lower parent
5057 upper parent)))))
5060 lower element
5061 upper element)))))
5068 "Store ELEMENT in current buffer's cache, if allowed."
5071 ;; During synchronization, first build an appropriate key for
5072 ;; the new element so `avl-tree-enter' can insert it at the
5073 ;; right spot in the cache.
5082 org-element--cache-sync-keys)))
5086 "Remove ELEMENT from cache.
5087 Assume ELEMENT belongs to cache and that a cache is active."
5091 ;;;; Synchronization
5094 "Set idle timer for cache synchronization in BUFFER."
5101 org-element-cache-sync-idle-time))
5102 nil
5103 #'org-element--cache-sync
5104 buffer)))
5107 "Non-nil when synchronization process should be interrupted.
5108 TIME-LIMIT is a time value or nil."
5114 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5116 Properties containing buffer positions are `:begin', `:end',
5117 `:contents-begin', `:contents-end' and `:structure'. When
5118 optional argument PROPS is a list of keywords, only shift
5119 properties provided in that list.
5121 Properties are modified by side-effect."
5123 ;; Shift `:structure' property for the first plain list only: it
5124 ;; is the only one that really matters and it prevents from
5125 ;; shifting it more than once.
5139 "Synchronize cache with recent modification in BUFFER.
5141 When optional argument THRESHOLD is non-nil, do the
5142 synchronization for all elements starting before or at threshold,
5143 then exit. Otherwise, synchronize cache for as long as
5144 `org-element-cache-sync-duration' or until Emacs leaves idle
5145 state.
5147 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5148 not registered yet in the cache are going to happen. It is used
5149 in `org-element--cache-submit-request', where cache is partially
5150 updated before current modification are actually submitted."
5161 request
5163 threshold
5166 org-element-cache-sync-duration))
5167 future-change)
5168 ;; Request processed. Merge current and next offsets and
5169 ;; transfer ending position.
5175 ;; If more requests are awaiting, set idle timer accordingly.
5176 ;; Otherwise, reset keys.
5183 "Process synchronization REQUEST for all entries before NEXT.
5185 REQUEST is a vector, built by `org-element--cache-submit-request'.
5187 NEXT is a cache key, as returned by `org-element--cache-key'.
5189 When non-nil, THRESHOLD is a buffer position. Synchronization
5190 stops as soon as a shifted element begins after it.
5192 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5193 after this time or when Emacs exits idle state.
5195 When non-nil, FUTURE-CHANGE is a buffer position where changes
5196 not registered yet in the cache are going to happen. See
5197 `org-element--cache-submit-request' for more information.
5199 Throw `interrupt' if the process stops before completing the
5200 request."
5203 ;; Phase 0.
5204 ;;
5205 ;; Delete all elements starting after BEG, but not after buffer
5206 ;; position END or past element with key NEXT. Also delete
5207 ;; elements contained within a previously removed element
5208 ;; (stored in `last-container').
5209 ;;
5210 ;; At each iteration, we start again at tree root since
5211 ;; a deletion modifies structure of the balanced tree.
5216 ;; Find first element in cache with key BEG or after it.
5220 data data-key last-container)
5229 data-key key
5232 data-key key
5233 node nil)))))
5243 up)))
5246 end))
5253 ;; No element starting after modifications left in
5254 ;; cache: further processing is futile.
5257 ;; Phase 1.
5258 ;;
5259 ;; Phase 0 left a hole in the cache. Some elements after it
5260 ;; could have parents within. For example, in the following
5261 ;; buffer:
5262 ;;
5263 ;; - item
5264 ;;
5265 ;;
5266 ;; Paragraph1
5267 ;;
5268 ;; Paragraph2
5269 ;;
5270 ;; if we remove a blank line between "item" and "Paragraph1",
5271 ;; everything down to "Paragraph2" is removed from cache. But
5272 ;; the paragraph now belongs to the list, and its `:parent'
5273 ;; property no longer is accurate.
5274 ;;
5275 ;; Therefore we need to parse again elements in the hole, or at
5276 ;; least in its last section, so that we can re-parent
5277 ;; subsequent elements, during phase 2.
5278 ;;
5279 ;; Note that we only need to get the parent from the first
5280 ;; element in cache after the hole.
5281 ;;
5282 ;; When next key is lesser or equal to the current one, delegate
5283 ;; phase 1 processing to next request in order to preserve key
5284 ;; order among requests.
5292 ;; Next element will start at its beginning position plus
5293 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5294 ;; contains the real beginning position of the first element to
5295 ;; shift and re-parent.
5299 ;; Changes are going to happen around this element and
5300 ;; they will trigger another phase 1 request. Skip the
5301 ;; current one.
5307 ;; Phase 2.
5308 ;;
5309 ;; Shift all elements starting from key START, but before NEXT, by
5310 ;; OFFSET, and re-parent them when appropriate.
5311 ;;
5312 ;; Elements are modified by side-effect so the tree structure
5313 ;; remains intact.
5314 ;;
5315 ;; Once THRESHOLD, if any, is reached, or once there is an input
5316 ;; pending, exit. Before leaving, the current synchronization
5317 ;; request is updated.
5324 exit-flag)
5325 ;; No re-parenting nor shifting planned: request is over.
5335 ;; We reached NEXT. Request is complete.
5337 ;; Handle interruption request. Update current request.
5342 ;; Shift element.
5346 ;; Update PARENT and re-parent DATA, only when
5347 ;; necessary. Propagate new structures for lists.
5361 ;; Cache is up-to-date past THRESHOLD. Request
5362 ;; interruption.
5367 ;; We reached end of tree: synchronization complete.
5368 t)))
5371 "Parse elements in current section, down to POS.
5373 Start parsing from the closest between the last known element in
5374 cache or headline above. Return the smallest element containing
5375 POS.
5377 When optional argument SYNCP is non-nil, return the parent of the
5378 element containing POS instead. In that case, it is also
5379 possible to provide TIME-LIMIT, which is a time value specifying
5380 when the parsing should stop. The function throws `interrupt' if
5381 the process stopped before finding the expected result."
5388 element next mode)
5390 ;; Nothing in cache before point: start parsing from first
5391 ;; element following headline above, or first element in
5392 ;; buffer.
5399 ;; Cache returned exact match: return it.
5402 ;; There's a headline between cached value and POS: cached
5403 ;; value is invalid. Start parsing from first element
5404 ;; following the headline.
5411 ;; Check if CACHED or any of its ancestors contain point.
5412 ;;
5413 ;; If there is such an element, we inspect it in order to know
5414 ;; if we return it or if we need to parse its contents.
5415 ;; Otherwise, we just start parsing from current location,
5416 ;; which is right after the top-most element containing
5417 ;; CACHED.
5418 ;;
5419 ;; As a special case, if POS is at the end of the buffer, we
5420 ;; want to return the innermost element ending there.
5421 ;;
5422 ;; Also, if we find an ancestor and discover that we need to
5423 ;; parse its contents, make sure we don't start from
5424 ;; `:contents-begin', as we would otherwise go past CACHED
5425 ;; again. Instead, in that situation, we will resume parsing
5426 ;; from NEXT, which is located after CACHED or its higher
5427 ;; ancestor not containing point.
5439 ;; Parse successively each element until we reach POS.
5452 end 'element mode
5459 ;; Skip any element ending before point. Also skip
5460 ;; element ending at point (unless it is also the end of
5461 ;; buffer) since we're sure that another element begins
5462 ;; after it.
5466 ;; A non-greater element contains point: return it.
5469 ;; Otherwise, we have to decide if ELEMENT really
5470 ;; contains POS. In that case we start parsing from
5471 ;; contents' beginning.
5472 ;;
5473 ;; If POS is at contents' beginning but it is also at
5474 ;; the beginning of the first item in a list or a table.
5475 ;; In that case, we need to create an anchor for that
5476 ;; list or table, so return it.
5477 ;;
5478 ;; Also, if POS is at the end of the buffer, no element
5479 ;; can start after it, but more than one may end there.
5480 ;; Arbitrarily, we choose to return the innermost of
5481 ;; such elements.
5494 parent element
5495 end cend))))
5496 ;; Otherwise, return ELEMENT as it is the smallest
5497 ;; element containing POS.
5502 ;;;; Staging Buffer Changes
5513 "Regexp matching a sensitive line, structure wise.
5514 A sensitive line is a headline, inlinetask, block, drawer, or
5515 latex-environment boundary. When such a line is modified,
5516 structure changes in the document may propagate in the whole
5520 "Non-nil when a sensitive line is about to be changed.
5524 "Request extension of area going to be modified if needed.
5525 BEG and END are the beginning and end of the range of changed
5526 text. See `before-change-functions' for more information."
5536 'headline
5539 org-element--cache-sensitive-re bottom t)))))))))
5542 "Update buffer modifications for current buffer.
5543 BEG and END are the beginning and end of the range of changed
5544 text, and the length in bytes of the pre-change text replaced by
5545 that range. See `after-change-functions' for more information."
5553 ;; Determine if modified area needs to be extended, according
5554 ;; to both previous and current state. We make a special
5555 ;; case for headline editing: if a headline is modified but
5556 ;; not removed, do not extend.
5559 (`headline
5565 org-element--cache-sensitive-re bottom t))))
5566 ;; Effectively extend modified area.
5574 ;; Store synchronization request.
5577 ;; Activate a timer to process the request during idle time.
5581 "Return first element to remove from cache.
5583 BEG and END are buffer positions delimiting buffer modifications.
5584 OFFSET is the size of the changes.
5586 Returned element is usually the first element in cache containing
5587 any position between BEG and END. As an exception, greater
5588 elements around the changes that are robust to contents
5589 modifications are preserved and updated according to the
5590 changes."
5600 special-block))
5601 ;; Drawers named "PROPERTIES" are probably
5602 ;; a properties drawer being edited. Force
5603 ;; parsing to check if editing is over.
5612 ;; UP is a robust greater element containing changes.
5613 ;; We only need to extend its ending boundaries.
5619 ;; We're at top level element containing ELEMENT: if it's
5620 ;; altered by buffer modifications, it is first element in
5621 ;; cache to be removed. Otherwise, that first element is the
5622 ;; following one.
5623 ;;
5624 ;; As a special case, do not remove BEFORE if it is a robust
5625 ;; container for current changes.
5627 before)))))
5630 "Submit a new cache synchronization request for current buffer.
5631 BEG and END are buffer positions delimiting the minimal area
5632 where cache data should be removed. OFFSET is the size of the
5633 change, as an integer."
5635 delete-to delete-from)
5640 ;; Current changes can be merged with first sync request: we
5641 ;; can save a partial cache synchronization.
5644 ;; If last change happened within area to be removed, extend
5645 ;; boundaries of robust parents, if any. Otherwise, find
5646 ;; first element to remove and update request accordingly.
5658 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5659 ;; if any, is no longer a 0-phase request, thus ensuring that
5660 ;; phases are properly ordered. We need to provide OFFSET as
5661 ;; optional parameter since current modifications are not known
5662 ;; yet to the otherwise correct part of the cache (i.e, before
5663 ;; the first request).
5670 ;; When changes happen before the first known
5671 ;; element, re-parent and shift the rest of the
5672 ;; cache.
5674 ;; Otherwise, we find the first non robust
5675 ;; element containing END. All elements between
5676 ;; FIRST and this one are to be removed.
5687 element up))
5689 org-element--cache-sync-requests)
5690 ;; No element to remove. No need to re-parent either.
5691 ;; Simply shift additional elements, if any, by OFFSET.
5694 offset)))))))
5697 ;;;; Public Functions
5699 ;;;###autoload
5701 "Reset cache in current buffer.
5702 When optional argument ALL is non-nil, reset cache in all Org
5703 buffers."
5720 ;;;###autoload
5722 "Refresh cache at position POS."
5729 \f
5730 ;;; The Toolbox
5731 ;;
5732 ;; The first move is to implement a way to obtain the smallest element
5733 ;; containing point. This is the job of `org-element-at-point'. It
5734 ;; basically jumps back to the beginning of section containing point
5735 ;; and proceed, one element after the other, with
5736 ;; `org-element--current-element' until the container is found. Note:
5737 ;; When using `org-element-at-point', secondary values are never
5738 ;; parsed since the function focuses on elements, not on objects.
5739 ;;
5740 ;; At a deeper level, `org-element-context' lists all elements and
5741 ;; objects containing point.
5742 ;;
5743 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5744 ;; internally by navigation and manipulation tools.
5747 ;;;###autoload
5749 "Determine closest element around point.
5751 Return value is a list like (TYPE PROPS) where TYPE is the type
5752 of the element and PROPS a plist of properties associated to the
5753 element.
5755 Possible types are defined in `org-element-all-elements'.
5756 Properties depend on element or object type, but always include
5757 `:begin', `:end', `:parent' and `:post-blank' properties.
5759 As a special case, if point is at the very beginning of the first
5760 item in a list or sub-list, returned element will be that list
5761 instead of the item. Likewise, if point is at the beginning of
5762 the first row of a table, returned element will be the table
5763 instead of the first row.
5765 When point is at the end of the buffer, return the innermost
5766 element ending there."
5772 ;; Within blank lines at the beginning of buffer, return nil.
5774 ;; Within blank lines right after a headline, return that
5775 ;; headline.
5779 ;; Otherwise parse until we find element containing ORIGIN.
5786 ;;;###autoload
5788 "Return smallest element or object around point.
5790 Return value is a list like (TYPE PROPS) where TYPE is the type
5791 of the element or object and PROPS a plist of properties
5792 associated to it.
5794 Possible types are defined in `org-element-all-elements' and
5795 `org-element-all-objects'. Properties depend on element or
5796 object type, but always include `:begin', `:end', `:parent' and
5797 `:post-blank'.
5799 As a special case, if point is right after an object and not at
5800 the beginning of any other object, return that object.
5802 Optional argument ELEMENT, when non-nil, is the closest element
5803 containing point, as returned by `org-element-at-point'.
5804 Providing it allows for quicker computation."
5811 ;; If point is inside an element containing objects or
5812 ;; a secondary string, narrow buffer to the container and
5813 ;; proceed with parsing. Otherwise, return ELEMENT.
5815 ;; At a parsed affiliated keyword, check if we're inside main
5816 ;; or dual value.
5822 org-element-parsed-keywords))
5831 ;; Also change type to retrieve correct restrictions.
5833 ;; At an item, objects can only be located within tag, if any.
5844 ;; At an headline or inlinetask, objects are in title.
5856 ;; At a paragraph, a table-row or a verse block, objects are
5857 ;; located within their contents.
5861 ;; CBEG is nil for table rules.
5870 last)
5875 ;; Process NEXT, if any, in order to know if we need to
5876 ;; skip it, return it or move into it.
5883 ;; Skip objects ending before point. Also skip
5884 ;; objects ending at point unless it is also the
5885 ;; end of buffer, since we want to return the
5886 ;; innermost object.
5889 ;; For convenience, when object ends at POS,
5890 ;; without any space, store it in LAST, as we
5891 ;; will return it if no object starts here.
5895 ;; If POS is within a container object, move into
5896 ;; that object.
5900 ;; At contents' end, if there is no
5901 ;; space before point, also move into
5902 ;; object, for consistency with
5903 ;; convenience feature above.
5912 ;; Otherwise, return NEXT.
5916 "List all ancestors of a given element or object.
5918 DATUM is an object or element.
5920 Return ancestors from the closest to the farthest. When optional
5921 argument TYPES is a list of symbols, return the first element or
5922 object in the lineage whose type belongs to that list instead.
5924 When optional argument WITH-SELF is non-nil, lineage includes
5925 DATUM itself as the first element, and TYPES, if provided, also
5926 apply to it.
5928 When DATUM is obtained through `org-element-context' or
5929 `org-element-at-point', only ancestors from its section can be
5930 found. There is no such limitation when DATUM belongs to a full
5931 parse tree."
5933 ancestors)
5940 "Non-nil when elements ELEM-A and ELEM-B are nested."
5949 "Swap elements ELEM-A and ELEM-B.
5950 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5951 end of ELEM-A."
5953 ;; There are two special cases when an element doesn't start at bol:
5954 ;; the first paragraph in an item or in a footnote definition.
5956 ;; Only a paragraph without any affiliated keyword can be moved at
5957 ;; ELEM-A position in such a situation. Note that the case of
5958 ;; a footnote definition is impossible: it cannot contain two
5959 ;; paragraphs in a row because it cannot contain a blank line.
5965 ;; In a special situation, ELEM-A will have no indentation. We'll
5966 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5980 ;; Store inner overlays responsible for visibility status.
5981 ;; We also need to store their boundaries as they will be
5982 ;; removed from buffer.
5997 ;; Get contents.
6005 ;; Restore ex ELEM-A overlays.
6012 ;; Restore ex ELEM-B overlays.
6020 ;; Local variables:
6021 ;; generated-autoload-file: "org-loaddefs.el"
6022 ;; End:
6024 ;;; org-element.el ends here