| blob | c1c2e9bf90d0f4d8ba11bfa7bc2ca2c553fdc1d9 |
1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; See <http://orgmode.org/worg/dev/org-syntax.html> for details about
26 ;; Org syntax.
27 ;;
28 ;; Lisp-wise, a syntax object can be represented as a list.
29 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
30 ;; TYPE is a symbol describing the object.
31 ;; PROPERTIES is the property list attached to it. See docstring of
32 ;; appropriate parsing function to get an exhaustive list.
33 ;; CONTENTS is a list of syntax objects or raw strings contained
34 ;; in the current object, when applicable.
35 ;;
36 ;; For the whole document, TYPE is `org-data' and PROPERTIES is nil.
37 ;;
38 ;; The first part of this file defines constants for the Org syntax,
39 ;; while the second one provide accessors and setters functions.
40 ;;
41 ;; The next part implements a parser and an interpreter for each
42 ;; element and object type in Org syntax.
43 ;;
44 ;; The following part creates a fully recursive buffer parser. It
45 ;; also provides a tool to map a function to elements or objects
46 ;; matching some criteria in the parse tree. Functions of interest
47 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
48 ;; extent, `org-element-parse-secondary-string'.
49 ;;
50 ;; The penultimate part is the cradle of an interpreter for the
51 ;; obtained parse tree: `org-element-interpret-data'.
52 ;;
53 ;; The library ends by furnishing `org-element-at-point' function, and
54 ;; a way to give information about document structure around point
55 ;; with `org-element-context'. A cache mechanism is also provided for
56 ;; these functions.
59 ;;; Code:
66 \f
67 ;;; Definitions And Rules
68 ;;
69 ;; Define elements, greater elements and specify recursive objects,
70 ;; along with the affiliated keywords recognized. Also set up
71 ;; restrictions on recursive objects combinations.
72 ;;
73 ;; `org-element-update-syntax' builds proper syntax regexps according
74 ;; to current setup.
77 "Regexp to separate paragraphs in an Org buffer.
79 is not sufficient to know if point is at a paragraph ending. See
83 "Regexp possibly matching the beginning of an object.
84 This regexp allows false positives. Dedicated parser (e.g.,
85 `org-export-bold-parser') will take care of further filtering.
86 Radio links are not matched by this regexp, as they are treated
90 "Build variable syntax regexps."
93 ;; Headlines, inlinetasks.
95 ;; Footnote definitions.
97 ;; Diary sexps.
100 ;; Empty lines.
102 ;; Tables (any type).
105 ;; Comments, keyword-like or block-like constructs.
106 ;; Blocks and keywords with dual values need to be
107 ;; double-checked.
112 ;; Drawers (any type) and fixed-width areas. Drawers
113 ;; need to be double-checked.
115 ;; Horizontal rules.
117 ;; LaTeX environments.
119 ;; Clock lines.
121 ;; Lists.
128 org-element--object-regexp
132 ;; Sub/superscript.
134 ;; Bold, code, italic, strike-through, underline
135 ;; and verbatim.
139 ;; Plain links.
141 ;; Objects starting with "[": regular link,
142 ;; footnote reference, statistics cookie,
143 ;; timestamp (inactive).
150 ;; Objects starting with "@": export snippets.
151 "@@"
152 ;; Objects starting with "{": macro.
153 "{{{"
154 ;; Objects starting with "<" : timestamp
155 ;; (active, diary), target, radio target and
156 ;; angular links.
158 ;; Objects starting with "$": latex fragment.
160 ;; Objects starting with "\": line break,
161 ;; entity, latex fragment.
163 ;; Objects starting with raw text: inline Babel
164 ;; source block, inline Babel call.
170 ;;;###autoload
172 "Update parser internals."
179 dynamic-block example-block export-block fixed-width
180 footnote-definition headline horizontal-rule inlinetask item
181 keyword latex-environment node-property paragraph plain-list
182 planning property-drawer quote-block section
183 special-block src-block table table-row verse-block)
188 item plain-list property-drawer quote-block section
189 special-block table)
194 inline-src-block italic line-break latex-fragment link macro
195 radio-target statistics-cookie strike-through subscript superscript
196 table-cell target timestamp underline verbatim)
201 superscript table-cell underline)
211 "List of affiliated keywords as strings.
219 "Alist of usual translations for keywords.
220 The key is the old name and the value the new one. The property
224 "List of affiliated keywords that can occur more than once in an element.
226 Their value will be consed into a list of strings, which will be
227 returned as the value of the property.
229 This list is checked after translations have been applied. See
230 `org-element-keyword-translation-alist'.
236 "List of affiliated keywords whose value can be parsed.
238 Their value will be stored as a secondary string: a list of
239 strings and objects.
241 This list is checked after translations have been applied. See
246 org-element-parsed-keywords)
247 "Alist of parsed keywords and associated properties.
248 This is generated from `org-element-parsed-keywords', which
252 "List of affiliated keywords which can have a secondary value.
254 In Org syntax, they can be written with optional square brackets
255 before the colons. For example, RESULTS keyword can be
256 associated to a hash value with the following:
258 #+RESULTS[hash-string]: some-source
260 This list is checked after translations have been applied. See
266 ;; Dual affiliated keywords.
270 ;; Regular affiliated keywords.
275 org-element-affiliated-keywords)))
277 ;; Export attributes.
279 "Regexp matching any affiliated keyword.
281 Keyword name is put in match group 1. Moreover, if keyword
282 belongs to `org-element-dual-keywords', put the dual value in
283 match group 2.
297 ;; Ignore all links in a link description. Also ignore
298 ;; radio-targets and line breaks.
300 italic latex-fragment macro statistics-cookie strike-through
301 subscript superscript underline verbatim)
303 ;; Remove any variable object from radio target as it would
304 ;; prevent it from being properly recognized.
306 subscript superscript underline superscript)
310 ;; Ignore inline babel call and inline src block as formulas are
311 ;; possible. Also ignore line breaks and statistics cookies.
313 latex-fragment link macro radio-target strike-through
314 subscript superscript target timestamp underline verbatim)
318 "Alist of objects restrictions.
320 key is an element or object type containing objects and value is
321 a list of types that can be contained within an element or object
322 of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, latex-fragments, subscript, superscript and text
326 markup.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
344 "Table used internally to pair only round brackets.
353 "Table used internally to pair only square brackets.
362 "Table used internally to pair only curly brackets.
366 "Parse paired brackets at point.
367 CHAR is the opening bracket to consider, as a character. Return
368 contents between brackets, as a string, or nil. Also move point
369 past the brackets."
384 \f
385 ;;; Accessors and Setters
386 ;;
387 ;; Provide four accessors: `org-element-type', `org-element-property'
388 ;; `org-element-contents' and `org-element-restriction'.
389 ;;
390 ;; Setter functions allow modification of elements by side effect.
391 ;; There is `org-element-put-property', `org-element-set-contents'.
392 ;; These low-level functions are useful to build a parse tree.
393 ;;
394 ;; `org-element-adopt-elements', `org-element-set-element',
395 ;; `org-element-extract-element' and `org-element-insert-before' are
396 ;; high-level functions useful to modify a parse tree.
397 ;;
398 ;; `org-element-secondary-p' is a predicate used to know if a given
399 ;; object belongs to a secondary string. `org-element-class' tells if
400 ;; some parsed data is an element or an object, handling pseudo
401 ;; elements and objects. `org-element-copy' returns an element or
402 ;; object, stripping its parent property in the process.
405 "Return type of ELEMENT.
407 The function returns the type of the element or object provided.
408 It can also return the following special value:
409 `plain-text' for a string
410 `org-data' for a complete document
411 nil in any other case."
417 "Extract the value from the PROPERTY of an ELEMENT."
422 "Extract contents from an ELEMENT."
428 "Return restriction associated to ELEMENT.
429 ELEMENT can be an element, an object or a symbol representing an
430 element or object type."
432 org-element-object-restrictions)))
435 "In ELEMENT set PROPERTY to VALUE.
436 Return modified element."
439 element))
442 "Set ELEMENT's contents to CONTENTS.
443 Return ELEMENT."
450 "Non-nil when OBJECT directly belongs to a secondary string.
451 Return value is the property name, as a keyword, or nil."
454 org-element-secondary-value-alist))))
461 "Return class for ELEMENT, as a symbol.
462 Class is either `element' or `object'. Optional argument PARENT
463 is the element or object containing DATUM. It defaults to the
464 value of DATUM `:parent' property."
468 ;; Trivial cases.
471 ;; Special cases.
475 ;; Pseudo object or elements. Make a guess about its class.
476 ;; Basically a pseudo object is contained within another object,
477 ;; a secondary string or a container element.
487 "Append elements to the contents of another element.
489 PARENT is an element or object. CHILDREN can be elements,
490 objects, or a strings.
492 The function takes care of setting `:parent' property for CHILD.
493 Return parent element."
495 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
496 ;; string: parent is the list itself.
499 ;; Add CHILDREN at the end of PARENT contents.
502 parent
504 ;; Return modified PARENT element.
508 "Extract ELEMENT from parse tree.
509 Remove element from the parse tree by side-effect, and return it
510 with its `:parent' property stripped out."
515 parent secondary
518 parent
520 ;; Return ELEMENT with its :parent removed.
524 "Insert ELEMENT before LOCATION in parse tree.
525 LOCATION is an element, object or string within the parse tree.
526 Parse tree is modified by side effect."
531 ;; Special case: LOCATION is the first element of an
532 ;; independent secondary string (e.g. :title property). Add
533 ;; ELEMENT in-place.
537 ;; Install ELEMENT at the appropriate LOCATION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires tweaking `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret a center-block element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
806 "Parse a footnote definition.
808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
809 the buffer position at the beginning of the first affiliated
810 keyword and CDR is a plist of affiliated keywords along with
811 their value.
813 Return a list whose CAR is `footnote-definition' and CDR is
814 a plist containing `:label', `:begin' `:end', `:contents-begin',
815 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
817 Assume point is at the beginning of the footnote definition."
829 limit)
831 ;; At a new footnote definition, make sure we end
832 ;; before any affiliated keyword above.
854 :begin begin
855 :end end
856 :contents-begin contents-begin
863 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
864 CONTENTS is the contents of the footnote-definition."
866 " "
867 contents))
870 ;;;; Headline
873 "Return node properties associated to headline at point.
874 Upcase property names. It avoids confusion between properties
875 obtained through property drawer and default properties from the
876 parser (e.g. `:end' and :END:). Return value is a plist."
888 properties))))
891 "Return time properties associated to headline at point.
892 Return value is a plist."
906 plist))))
909 "Parse a headline.
911 Return a list whose CAR is `headline' and CDR is a plist
912 containing `:raw-value', `:title', `:begin', `:end',
913 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
914 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
915 `:deadline', `:closed', `:archivedp', `:commentedp'
916 `:footnote-section-p', `:post-blank' and `:post-affiliated'
917 keywords.
919 The plist also contains any property set in the property drawer,
920 with its name in upper cases and colons added at the
921 beginning (e.g., `:CUSTOM_ID').
923 LIMIT is a buffer position bounding the search.
925 When RAW-SECONDARY-P is non-nil, headline's title will not be
926 parsed as a secondary string, but as a plain string instead.
928 Assume point is at beginning of the headline."
974 :begin begin
975 :end end
976 :pre-blank
979 :contents-begin contents-begin
980 :contents-end contents-end
981 :level level
982 :priority priority
983 :tags tags
984 :todo-keyword todo
985 :todo-type todo-type
986 :post-blank
990 :footnote-section-p footnote-section-p
991 :archivedp archivedp
992 :commentedp commentedp
994 time-props
995 standard-props))))
997 headline :title
1006 nil
1008 headline)))))))
1011 "Interpret HEADLINE element as Org syntax.
1012 CONTENTS is the contents of the element."
1025 ?*)
1029 " "
1032 org-footnote-section
1033 title))))
1035 heading
1036 ;; Align tags.
1044 ?\s)
1045 tags))
1049 tags))))
1051 contents)))
1054 ;;;; Inlinetask
1057 "Parse an inline task.
1059 Return a list whose CAR is `inlinetask' and CDR is a plist
1060 containing `:title', `:begin', `:end', `:pre-blank',
1061 `:contents-begin' and `:contents-end', `:level', `:priority',
1062 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1063 `:scheduled', `:deadline', `:closed', `:post-blank' and
1064 `:post-affiliated' keywords.
1066 The plist also contains any property set in the property drawer,
1067 with its name in upper cases and colons added at the
1068 beginning (e.g., `:CUSTOM_ID').
1070 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1071 title will not be parsed as a secondary string, but as a plain
1072 string instead.
1074 Assume point is at beginning of the inline task."
1121 :begin begin
1122 :end end
1123 :pre-blank
1126 :contents-begin contents-begin
1127 :contents-end contents-end
1128 :level level
1129 :priority priority
1130 :tags tags
1131 :todo-keyword todo
1132 :todo-type todo-type
1135 time-props
1136 standard-props))))
1138 inlinetask :title
1147 nil
1149 inlinetask))))))
1152 "Interpret INLINETASK element as Org syntax.
1153 CONTENTS is the contents of inlinetask."
1167 ;; Align tags.
1175 ? )
1176 tags))
1180 tags))))
1181 ;; Prefer degenerate inlinetasks when there are no
1182 ;; contents.
1185 contents
1189 ;;;; Item
1192 "Parse an item.
1194 STRUCT is the structure of the plain list.
1196 Return a list whose CAR is `item' and CDR is a plist containing
1197 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1198 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1199 `:post-affiliated' keywords.
1201 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1202 any, will not be parsed as a secondary string, but as a plain
1203 string instead.
1205 Assume point is at the beginning of the item."
1228 ;; Ignore tags in un-ordered lists: they are just
1229 ;; a part of item's body.
1236 ;; If first line isn't empty, contents really
1237 ;; start at the text after item's meta-data.
1247 :begin begin
1248 :end end
1249 :contents-begin contents-begin
1250 :contents-end contents-end
1251 :checkbox checkbox
1252 :counter counter
1253 :structure struct
1257 item :tag
1264 item))))))))
1267 "Interpret ITEM element as Org syntax.
1268 CONTENTS is the contents of the element."
1278 ;; Compute indentation.
1283 ;; Indent contents.
1285 bullet
1300 ;;;; Plain List
1303 ;; Return structure of list at point. Internal function. See
1304 ;; `org-list-struct' for details.
1309 items struct)
1314 ;; At limit: end all items.
1323 ;; At list end: end all items.
1328 ;; At a new item: end previous sibling.
1340 ind
1341 bullet
1344 ;; Description tag.
1348 ;; Ending position, unknown so far.
1349 nil)))
1350 items))
1352 ;; Skip empty lines.
1354 ;; Skip inline tasks and blank lines along the way.
1361 ;; At some text line. Check if it ends any previous item.
1374 ;; Skip blocks (any type) and drawers contents.
1379 limit t)))
1385 "Parse a plain list.
1387 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1388 the buffer position at the beginning of the first affiliated
1389 keyword and CDR is a plist of affiliated keywords along with
1390 their value. STRUCTURE is the structure of the plain list being
1391 parsed.
1393 Return a list whose CAR is `plain-list' and CDR is a plist
1394 containing `:type', `:begin', `:end', `:contents-begin' and
1395 `:contents-end', `:structure', `:post-blank' and
1396 `:post-affiliated' keywords.
1398 Assume point is at the beginning of the list."
1412 pos))
1416 ;; Return value.
1420 :begin begin
1421 :end end
1422 :contents-begin contents-begin
1423 :contents-end contents-end
1424 :structure struct
1430 "Interpret plain-list element as Org syntax.
1431 CONTENTS is the contents of the element."
1439 ;;;; Property Drawer
1442 "Parse a property drawer.
1444 LIMIT bounds the search.
1446 Return a list whose car is `property-drawer' and cdr is a plist
1447 containing `:begin', `:end', `:contents-begin', `:contents-end',
1448 `:post-blank' and `:post-affiliated' keywords.
1450 Assume point is at the beginning of the property drawer."
1463 :end end
1465 :contents-end contents-end
1470 "Interpret property-drawer element as Org syntax.
1471 CONTENTS is the properties within the drawer."
1475 ;;;; Quote Block
1478 "Parse a quote block.
1480 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1481 the buffer position at the beginning of the first affiliated
1482 keyword and CDR is a plist of affiliated keywords along with
1483 their value.
1485 Return a list whose CAR is `quote-block' and CDR is a plist
1486 containing `:begin', `:end', `:contents-begin', `:contents-end',
1487 `:post-blank' and `:post-affiliated' keywords.
1489 Assume point is at the beginning of the block."
1493 ;; Incomplete block: parse it as a paragraph.
1499 ;; Empty blocks have no contents.
1512 :end end
1513 :contents-begin contents-begin
1514 :contents-end contents-end
1520 "Interpret quote-block element as Org syntax.
1521 CONTENTS is the contents of the element."
1525 ;;;; Section
1528 "Parse a section.
1530 Return a list whose CAR is `section' and CDR is a plist
1531 containing `:begin', `:end', `:contents-begin', `contents-end',
1532 `:post-blank' and `:post-affiliated' keywords."
1534 ;; Beginning of section is the beginning of the first non-blank
1535 ;; line after previous headline.
1543 :end end
1544 :contents-begin begin
1545 :contents-end pos-before-blank
1550 "Interpret section element as Org syntax.
1551 CONTENTS is the contents of the element."
1552 contents)
1555 ;;;; Special Block
1558 "Parse a special block.
1560 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1561 the buffer position at the beginning of the first affiliated
1562 keyword and CDR is a plist of affiliated keywords along with
1563 their value.
1565 Return a list whose CAR is `special-block' and CDR is a plist
1566 containing `:type', `:begin', `:end', `:contents-begin',
1567 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1569 Assume point is at the beginning of the block."
1576 limit t)))
1577 ;; Incomplete block: parse it as a paragraph.
1583 ;; Empty blocks have no contents.
1596 :begin begin
1597 :end end
1598 :contents-begin contents-begin
1599 :contents-end contents-end
1605 "Interpret SPECIAL-BLOCK element as Org syntax.
1606 CONTENTS is the contents of the element."
1611 \f
1612 ;;; Elements
1613 ;;
1614 ;; For each element, a parser and an interpreter are also defined.
1615 ;; Both follow the same naming convention used for greater elements.
1616 ;;
1617 ;; Also, as for greater elements, adding a new element type is done
1618 ;; through the following steps: implement a parser and an interpreter,
1619 ;; tweak `org-element--current-element' so that it recognizes the new
1620 ;; type and add that new type to `org-element-all-elements'.
1623 ;;;; Babel Call
1626 "Parse a babel call.
1628 LIMIT bounds the search. AFFILIATED is a list of which car is
1629 the buffer position at the beginning of the first affiliated
1630 keyword and cdr is a plist of affiliated keywords along with
1631 their value.
1633 Return a list whose car is `babel-call' and cdr is a plist
1634 containing `:call', `:inside-header', `:arguments',
1635 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1636 `:post-affiliated' as keywords."
1664 :inside-header inside-header
1665 :arguments arguments
1666 :end-header end-header
1667 :begin begin
1668 :end end
1669 :value value
1675 "Interpret BABEL-CALL element as Org syntax."
1685 ;;;; Clock
1688 "Parse a clock.
1690 LIMIT bounds the search.
1692 Return a list whose CAR is `clock' and CDR is a plist containing
1693 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1694 `:post-affiliated' as keywords."
1714 :value value
1715 :duration duration
1716 :begin begin
1717 :end end
1718 :post-blank post-blank
1722 "Interpret CLOCK element as Org syntax."
1730 "%2s:%02s"
1734 ;;;; Comment
1737 "Parse a comment.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `comment' and CDR is a plist
1745 containing `:begin', `:end', `:value', `:post-blank',
1746 `:post-affiliated' keywords.
1748 Assume point is at comment beginning."
1757 ;; Get comments ending.
1760 ;; Accumulate lines without leading hash and first
1761 ;; whitespace.
1775 :end end
1776 :value value
1782 "Interpret COMMENT element as Org syntax.
1783 CONTENTS is nil."
1787 ;;;; Comment Block
1790 "Parse an export block.
1792 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1793 the buffer position at the beginning of the first affiliated
1794 keyword and CDR is a plist of affiliated keywords along with
1795 their value.
1797 Return a list whose CAR is `comment-block' and CDR is a plist
1798 containing `:begin', `:end', `:value', `:post-blank' and
1799 `:post-affiliated' keywords.
1801 Assume point is at comment block beginning."
1805 ;; Incomplete block: parse it as a paragraph.
1818 contents-begin contents-end)))
1822 :end end
1823 :value value
1829 "Interpret COMMENT-BLOCK element as Org syntax."
1836 ;;;; Diary Sexp
1839 "Parse a diary sexp.
1841 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1842 the buffer position at the beginning of the first affiliated
1843 keyword and CDR is a plist of affiliated keywords along with
1844 their value.
1846 Return a list whose CAR is `diary-sexp' and CDR is a plist
1847 containing `:begin', `:end', `:value', `:post-blank' and
1848 `:post-affiliated' keywords."
1860 :begin begin
1861 :end end
1867 "Interpret DIARY-SEXP as Org syntax."
1871 ;;;; Example Block
1874 "Parse an example block.
1876 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1877 the buffer position at the beginning of the first affiliated
1878 keyword and CDR is a plist of affiliated keywords along with
1879 their value.
1881 Return a list whose CAR is `example-block' and CDR is a plist
1882 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1883 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1884 `:value', `:post-blank' and `:post-affiliated' keywords."
1888 ;; Incomplete block: parse it as a paragraph.
1896 ;; Switches analysis.
1900 switches)
1903 'new
1906 ;; Subtract 1 to give number of lines before
1907 ;; first line.
1911 ;; Should labels be retained in (or stripped from) example
1912 ;; blocks?
1917 ;; What should code-references use - labels or
1918 ;; line-numbers?
1927 ;; Standard block parsing.
1933 contents-begin contents-end)))
1942 :end end
1943 :value value
1944 :switches switches
1945 :number-lines number-lines
1946 :preserve-indent preserve-indent
1947 :retain-labels retain-labels
1948 :use-labels use-labels
1949 :label-fmt label-fmt
1955 "Interpret EXAMPLE-BLOCK element as Org syntax."
1963 value
1968 ;;;; Export Block
1971 "Parse an export block.
1973 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1974 the buffer position at the beginning of the first affiliated
1975 keyword and CDR is a plist of affiliated keywords along with
1976 their value.
1978 Return a list whose CAR is `export-block' and CDR is a plist
1979 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1980 `:post-affiliated' keywords.
1982 Assume point is at export-block beginning."
1986 ;; Incomplete block: parse it as a paragraph.
2005 contents-end))))
2009 :begin begin
2010 :end end
2011 :value value
2017 "Interpret EXPORT-BLOCK element as Org syntax."
2023 ;;;; Fixed-width
2026 "Parse a fixed-width section.
2028 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2029 the buffer position at the beginning of the first affiliated
2030 keyword and CDR is a plist of affiliated keywords along with
2031 their value.
2033 Return a list whose CAR is `fixed-width' and CDR is a plist
2034 containing `:begin', `:end', `:value', `:post-blank' and
2035 `:post-affiliated' keywords.
2037 Assume point is at the beginning of the fixed-width area."
2041 value
2046 ;; Accumulate text without starting colons.
2059 :end end
2060 :value value
2066 "Interpret FIXED-WIDTH element as Org syntax."
2074 ;;;; Horizontal Rule
2077 "Parse an horizontal rule.
2079 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2080 the buffer position at the beginning of the first affiliated
2081 keyword and CDR is a plist of affiliated keywords along with
2082 their value.
2084 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2085 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2086 keywords."
2096 :end end
2102 "Interpret HORIZONTAL-RULE element as Org syntax."
2106 ;;;; Keyword
2109 "Parse a keyword at point.
2111 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2112 the buffer position at the beginning of the first affiliated
2113 keyword and CDR is a plist of affiliated keywords along with
2114 their value.
2116 Return a list whose CAR is `keyword' and CDR is a plist
2117 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2118 `:post-affiliated' keywords."
2120 ;; An orphaned affiliated keyword is considered as a regular
2121 ;; keyword. In this case AFFILIATED is nil, so we take care of
2122 ;; this corner case.
2135 :value value
2136 :begin begin
2137 :end end
2143 "Interpret KEYWORD element as Org syntax."
2149 ;;;; Latex Environment
2153 "Regexp matching the beginning of a LaTeX environment.
2154 The environment is captured by the first group.
2160 "Format string matching the ending of a LaTeX environment.
2164 "Parse a LaTeX environment.
2166 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2167 the buffer position at the beginning of the first affiliated
2168 keyword and CDR is a plist of affiliated keywords along with
2169 their value.
2171 Return a list whose CAR is `latex-environment' and CDR is a plist
2172 containing `:begin', `:end', `:value', `:post-blank' and
2173 `:post-affiliated' keywords.
2175 Assume point is at the beginning of the latex environment."
2182 limit t))
2183 ;; Incomplete latex environment: parse it as a paragraph.
2193 :end end
2194 :value value
2200 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2204 ;;;; Node Property
2207 "Parse a node-property at point.
2209 LIMIT bounds the search.
2211 Return a list whose CAR is `node-property' and CDR is a plist
2212 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2213 `:post-affiliated' keywords."
2223 limit))))
2226 :value value
2227 :begin begin
2228 :end end
2233 "Interpret NODE-PROPERTY element as Org syntax."
2239 ;;;; Paragraph
2242 "Parse a paragraph.
2244 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2245 the buffer position at the beginning of the first affiliated
2246 keyword and CDR is a plist of affiliated keywords along with
2247 their value.
2249 Return a list whose CAR is `paragraph' and CDR is a plist
2250 containing `:begin', `:end', `:contents-begin' and
2251 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2253 Assume point is at the beginning of the paragraph."
2260 ;; A matching `org-element-paragraph-separate' is not
2261 ;; necessarily the end of the paragraph. In particular,
2262 ;; drawers, blocks or LaTeX environments opening lines
2263 ;; must be closed. Moreover keywords with a secondary
2264 ;; value must belong to "dual keywords".
2278 limit t)))
2284 limit t)))
2287 org-element-dual-keywords))
2288 ;; Everything else is unambiguous.
2301 :end end
2302 :contents-begin contents-begin
2303 :contents-end contents-end
2309 "Interpret paragraph element as Org syntax.
2310 CONTENTS is the contents of the element."
2311 contents)
2314 ;;;; Planning
2317 "Parse a planning.
2319 LIMIT bounds the search.
2321 Return a list whose CAR is `planning' and CDR is a plist
2322 containing `:closed', `:deadline', `:scheduled', `:begin',
2323 `:end', `:post-blank' and `:post-affiliated' keywords."
2333 closed deadline scheduled)
2345 :deadline deadline
2346 :scheduled scheduled
2347 :begin begin
2348 :end end
2349 :post-blank post-blank
2353 "Interpret PLANNING element as Org syntax."
2355 #'identity
2372 ;;;; Src Block
2375 "Parse a src block.
2377 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2378 the buffer position at the beginning of the first affiliated
2379 keyword and CDR is a plist of affiliated keywords along with
2380 their value.
2382 Return a list whose CAR is `src-block' and CDR is a plist
2383 containing `:language', `:switches', `:parameters', `:begin',
2384 `:end', `:number-lines', `:retain-labels', `:use-labels',
2385 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2386 `:post-affiliated' keywords.
2388 Assume point is at the beginning of the block."
2391 limit t)))
2392 ;; Incomplete block: parse it as a paragraph.
2398 ;; Get language as a string.
2407 ;; Get switches.
2409 ;; Get parameters.
2411 ;; Switches analysis.
2415 switches)
2418 'new
2421 ;; Subtract 1 to give number of lines before
2422 ;; first line.
2430 ;; Should labels be retained in (or stripped from)
2431 ;; src blocks?
2436 ;; What should code-references use - labels or
2437 ;; line-numbers?
2442 ;; Retrieve code.
2449 ;; Get position after ending blank lines.
2459 :begin begin
2460 :end end
2461 :number-lines number-lines
2462 :preserve-indent preserve-indent
2463 :retain-labels retain-labels
2464 :use-labels use-labels
2465 :label-fmt label-fmt
2466 :value value
2472 "Interpret SRC-BLOCK element as Org syntax."
2481 val)
2496 ;;;; Table
2499 "Parse a table at point.
2501 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2502 the buffer position at the beginning of the first affiliated
2503 keyword and CDR is a plist of affiliated keywords along with
2504 their value.
2506 Return a list whose CAR is `table' and CDR is a plist containing
2507 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2508 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2509 keywords.
2511 Assume point is at the beginning of the table."
2527 acc))
2534 :end end
2535 :type type
2536 :tblfm tblfm
2537 ;; Only `org' tables have contents. `table.el' tables
2538 ;; use a `:value' property to store raw table as
2539 ;; a string.
2544 table-begin table-end))
2550 "Interpret TABLE element as Org syntax.
2551 CONTENTS is a string, if table's type is `org', or nil."
2562 ;;;; Table Row
2565 "Parse table row at point.
2567 Return a list whose CAR is `table-row' and CDR is a plist
2568 containing `:begin', `:end', `:contents-begin', `:contents-end',
2569 `:type', `:post-blank' and `:post-affiliated' keywords."
2573 ;; A table rule has no contents. In that case, ensure
2574 ;; CONTENTS-BEGIN matches CONTENTS-END.
2584 :begin begin
2585 :end end
2586 :contents-begin contents-begin
2587 :contents-end contents-end
2592 "Interpret TABLE-ROW element as Org syntax.
2593 CONTENTS is the contents of the table row."
2598 ;;;; Verse Block
2601 "Parse a verse block.
2603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2604 the buffer position at the beginning of the first affiliated
2605 keyword and CDR is a plist of affiliated keywords along with
2606 their value.
2608 Return a list whose CAR is `verse-block' and CDR is a plist
2609 containing `:begin', `:end', `:contents-begin', `:contents-end',
2610 `:post-blank' and `:post-affiliated' keywords.
2612 Assume point is at beginning of the block."
2616 ;; Incomplete block: parse it as a paragraph.
2631 :end end
2632 :contents-begin contents-begin
2633 :contents-end contents-end
2639 "Interpret verse-block element as Org syntax.
2640 CONTENTS is verse block contents."
2644 \f
2645 ;;; Objects
2646 ;;
2647 ;; Unlike to elements, raw text can be found between objects. Hence,
2648 ;; `org-element--object-lex' is provided to find the next object in
2649 ;; buffer.
2650 ;;
2651 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2652 ;; object types they can contain will be specified in
2653 ;; `org-element-object-restrictions'.
2654 ;;
2655 ;; Creating a new type of object requires to alter
2656 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2657 ;; new type in `org-element-all-objects', and possibly add
2658 ;; restrictions in `org-element-object-restrictions'.
2660 ;;;; Bold
2663 "Parse bold object at point, if any.
2665 When at a bold object, return a list whose car is `bold' and cdr
2666 is a plist with `:begin', `:end', `:contents-begin' and
2667 `:contents-end' and `:post-blank' keywords. Otherwise, return
2668 nil.
2670 Assume point is at the first star marker."
2682 :end end
2683 :contents-begin contents-begin
2684 :contents-end contents-end
2688 "Interpret bold object as Org syntax.
2689 CONTENTS is the contents of the object."
2693 ;;;; Code
2696 "Parse code object at point, if any.
2698 When at a code object, return a list whose car is `code' and cdr
2699 is a plist with `:value', `:begin', `:end' and `:post-blank'
2700 keywords. Otherwise, return nil.
2702 Assume point is at the first tilde marker."
2713 :begin begin
2714 :end end
2718 "Interpret CODE object as Org syntax."
2722 ;;;; Entity
2725 "Parse entity at point, if any.
2727 When at an entity, return a list whose car is `entity' and cdr
2728 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2729 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2730 `:post-blank' as keywords. Otherwise, return nil.
2732 Assume point is at the beginning of the entity."
2734 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2752 :begin begin
2753 :end end
2754 :use-brackets-p bracketsp
2758 "Interpret ENTITY object as Org syntax."
2764 ;;;; Export Snippet
2767 "Parse export snippet at point.
2769 When at an export snippet, return a list whose car is
2770 `export-snippet' and cdr a plist with `:begin', `:end',
2771 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2772 return nil.
2774 Assume point is at the beginning of the snippet."
2790 :value value
2791 :begin begin
2792 :end end
2796 "Interpret EXPORT-SNIPPET object as Org syntax."
2802 ;;;; Footnote Reference
2805 "Parse footnote reference at point, if any.
2807 When at a footnote reference, return a list whose car is
2808 `footnote-reference' and cdr a plist with `:label', `:type',
2809 `:begin', `:end', `:content-begin', `:contents-end' and
2810 `:post-blank' as keywords. Otherwise, return nil."
2826 :type type
2827 :begin begin
2828 :end end
2834 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2835 CONTENTS is its definition, when inline, or nil."
2841 ;;;; Inline Babel Call
2844 "Parse inline babel call at point, if any.
2846 When at an inline babel call, return a list whose car is
2847 `inline-babel-call' and cdr a plist with `:call',
2848 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2849 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2851 Assume point is at the beginning of the babel call."
2865 ;; Parenthesis are mandatory.
2876 :inside-header inside-header
2877 :arguments arguments
2878 :end-header end-header
2879 :begin begin
2880 :end end
2881 :value value
2885 "Interpret INLINE-BABEL-CALL object as Org syntax."
2895 ;;;; Inline Src Block
2898 "Parse inline source block at point, if any.
2900 When at an inline source block, return a list whose car is
2901 `inline-src-block' and cdr a plist with `:begin', `:end',
2902 `:language', `:value', `:parameters' and `:post-blank' as
2903 keywords. Otherwise, return nil.
2905 Assume point is at the beginning of the inline src block."
2922 :value value
2923 :parameters parameters
2924 :begin begin
2929 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2934 language
2936 body)))
2938 ;;;; Italic
2941 "Parse italic object at point, if any.
2943 When at an italic object, return a list whose car is `italic' and
2944 cdr is a plist with `:begin', `:end', `:contents-begin' and
2945 `:contents-end' and `:post-blank' keywords. Otherwise, return
2946 nil.
2948 Assume point is at the first slash marker."
2960 :end end
2961 :contents-begin contents-begin
2962 :contents-end contents-end
2966 "Interpret italic object as Org syntax.
2967 CONTENTS is the contents of the object."
2971 ;;;; Latex Fragment
2974 "Parse LaTeX fragment at point, if any.
2976 When at a LaTeX fragment, return a list whose car is
2977 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2978 and `:post-blank' as keywords. Otherwise, return nil.
2980 Assume point is at the beginning of the LaTeX fragment."
2999 ;; Macro.
3009 :begin begin
3010 :end end
3014 "Interpret LATEX-FRAGMENT object as Org syntax."
3017 ;;;; Line Break
3020 "Parse line break at point, if any.
3022 When at a line break, return a list whose car is `line-break',
3023 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3024 Otherwise, return nil.
3026 Assume point is at the beginning of the line break."
3035 "Interpret LINE-BREAK object as Org syntax."
3039 ;;;; Link
3042 "Parse link at point, if any.
3044 When at a link, return a list whose car is `link' and cdr a plist
3045 with `:type', `:path', `:format', `:raw-link', `:application',
3046 `:search-option', `:begin', `:end', `:contents-begin',
3047 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3048 nil.
3050 Assume point is at the beginning of the link."
3053 end contents-begin contents-end link-end post-blank path type format
3054 raw-link search-option application)
3056 ;; Type 1: Text targeted from a radio target.
3066 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3072 ;; RAW-LINK is the original link. Expand any
3073 ;; abbreviation in it.
3074 ;;
3075 ;; Also treat any newline character and associated
3076 ;; indentation as a single space character. This is not
3077 ;; compatible with RFC 3986, which requires to ignore
3078 ;; them altogether. However, doing so would require
3079 ;; users to encode spaces on the fly when writing links
3080 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3081 ;; [[shell:ls *.org]], which defeats Org's focus on
3082 ;; simplicity.
3087 ;; Determine TYPE of link and set PATH accordingly. According
3088 ;; to RFC 3986, remove whitespaces from URI in external links.
3089 ;; In internal ones, treat indentation as a single space.
3091 ;; File type.
3096 ;; Explicit type (http, irc, bbdb...).
3100 ;; Code-ref type: PATH is the name of the reference.
3105 ;; Custom-id type: PATH is the name of the custom id.
3109 ;; Fuzzy type: Internal link either matches a target, an
3110 ;; headline name or nothing. PATH is the target or
3111 ;; headline's name.
3115 ;; Type 3: Plain link, e.g., http://orgmode.org
3122 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3123 ;; bracket links, follow RFC 3986 and remove any extra
3124 ;; whitespace in URI.
3135 ;; In any case, deduce end point after trailing white space from
3136 ;; LINK-END variable.
3141 ;; Special "file" type link processing. Extract opening
3142 ;; application and search option, if any. Also normalize URI.
3149 ;; Translate link, if `org-link-translation-function' is set.
3157 :path path
3158 :format format
3160 :application application
3161 :search-option search-option
3162 :begin begin
3163 :end end
3164 :contents-begin contents-begin
3165 :contents-end contents-end
3169 "Interpret LINK object as Org syntax.
3170 CONTENTS is the contents of the object, or nil."
3175 ;; Links with contents and internal links have to
3176 ;; use bracket syntax. Ignore `:format' in these
3177 ;; cases. This is also the default syntax when the
3178 ;; property is not defined, e.g., when the object
3179 ;; was crafted by the user.
3182 ;; Since this is going to be used as
3183 ;; a format string, escape percent signs
3184 ;; in description.
3187 `nil
3190 ;; Otherwise, just obey to `:format'.
3202 path
3208 ;;;; Macro
3211 "Parse macro at point, if any.
3213 When at a macro, return a list whose car is `macro' and cdr
3214 a plist with `:key', `:args', `:begin', `:end', `:value' and
3215 `:post-blank' as keywords. Otherwise, return nil.
3217 Assume point is at the macro."
3230 :value value
3231 :args args
3232 :begin begin
3233 :end end
3237 "Interpret MACRO object as Org syntax."
3241 ;;;; Radio-target
3244 "Parse radio target at point, if any.
3246 When at a radio target, return a list whose car is `radio-target'
3247 and cdr a plist with `:begin', `:end', `:contents-begin',
3248 `:contents-end', `:value' and `:post-blank' as keywords.
3249 Otherwise, return nil.
3251 Assume point is at the radio target."
3263 :end end
3264 :contents-begin contents-begin
3265 :contents-end contents-end
3266 :post-blank post-blank
3270 "Interpret target object as Org syntax.
3271 CONTENTS is the contents of the object."
3275 ;;;; Statistics Cookie
3278 "Parse statistics cookie at point, if any.
3280 When at a statistics cookie, return a list whose car is
3281 `statistics-cookie', and cdr a plist with `:begin', `:end',
3282 `:value' and `:post-blank' keywords. Otherwise, return nil.
3284 Assume point is at the beginning of the statistics-cookie."
3295 :end end
3296 :value value
3300 "Interpret STATISTICS-COOKIE object as Org syntax."
3304 ;;;; Strike-Through
3307 "Parse strike-through object at point, if any.
3309 When at a strike-through object, return a list whose car is
3310 `strike-through' and cdr is a plist with `:begin', `:end',
3311 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3312 Otherwise, return nil.
3314 Assume point is at the first plus sign marker."
3326 :end end
3327 :contents-begin contents-begin
3328 :contents-end contents-end
3332 "Interpret strike-through object as Org syntax.
3333 CONTENTS is the contents of the object."
3337 ;;;; Subscript
3340 "Parse subscript at point, if any.
3342 When at a subscript object, return a list whose car is
3343 `subscript' and cdr a plist with `:begin', `:end',
3344 `:contents-begin', `:contents-end', `:use-brackets-p' and
3345 `:post-blank' as keywords. Otherwise, return nil.
3347 Assume point is at the underscore."
3361 :end end
3362 :use-brackets-p bracketsp
3363 :contents-begin contents-begin
3364 :contents-end contents-end
3368 "Interpret SUBSCRIPT object as Org syntax.
3369 CONTENTS is the contents of the object."
3372 contents))
3375 ;;;; Superscript
3378 "Parse superscript at point, if any.
3380 When at a superscript object, return a list whose car is
3381 `superscript' and cdr a plist with `:begin', `:end',
3382 `:contents-begin', `:contents-end', `:use-brackets-p' and
3383 `:post-blank' as keywords. Otherwise, return nil.
3385 Assume point is at the caret."
3399 :end end
3400 :use-brackets-p bracketsp
3401 :contents-begin contents-begin
3402 :contents-end contents-end
3406 "Interpret SUPERSCRIPT object as Org syntax.
3407 CONTENTS is the contents of the object."
3410 contents))
3413 ;;;; Table Cell
3416 "Parse table cell at point.
3417 Return a list whose car is `table-cell' and cdr is a plist
3418 containing `:begin', `:end', `:contents-begin', `:contents-end'
3419 and `:post-blank' keywords."
3427 :end end
3428 :contents-begin contents-begin
3429 :contents-end contents-end
3433 "Interpret table-cell element as Org syntax.
3434 CONTENTS is the contents of the cell, or nil."
3438 ;;;; Target
3441 "Parse target at point, if any.
3443 When at a target, return a list whose car is `target' and cdr
3444 a plist with `:begin', `:end', `:value' and `:post-blank' as
3445 keywords. Otherwise, return nil.
3447 Assume point is at the target."
3457 :end end
3458 :value value
3462 "Interpret TARGET object as Org syntax."
3466 ;;;; Timestamp
3477 "Parse time stamp at point, if any.
3479 When at a time stamp, return a list whose car is `timestamp', and
3480 cdr a plist with `:type', `:raw-value', `:year-start',
3481 `:month-start', `:day-start', `:hour-start', `:minute-start',
3482 `:year-end', `:month-end', `:day-end', `:hour-end',
3483 `:minute-end', `:repeater-type', `:repeater-value',
3484 `:repeater-unit', `:warning-type', `:warning-value',
3485 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3486 Otherwise, return nil.
3488 Assume point is at the beginning of the timestamp."
3507 date-start)
3518 raw-value)
3520 :repeater-type
3526 :repeater-unit
3535 :warning-unit
3538 year-start month-start day-start hour-start minute-start year-end
3539 month-end day-end hour-end minute-end)
3540 ;; Parse date-start.
3548 ;; Compute date-end. It can be provided directly in time-stamp,
3549 ;; or extracted from time range. Otherwise, it defaults to the
3550 ;; same values as date-start.
3560 :raw-value raw-value
3561 :year-start year-start
3562 :month-start month-start
3563 :day-start day-start
3564 :hour-start hour-start
3565 :minute-start minute-start
3566 :year-end year-end
3567 :month-end month-end
3568 :day-end day-end
3569 :hour-end hour-end
3570 :minute-end minute-end
3571 :begin begin
3572 :end end
3574 repeater-props
3575 warning-props))))))
3578 "Interpret TIMESTAMP object as Org syntax."
3596 ;; Build an Org timestamp string from TIME. ACTIVEP is
3597 ;; non-nil when time stamp is active. If WITH-TIME-P is
3598 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3599 ;; specify a time range in the timestamp. REPEAT-STRING is
3600 ;; the repeater string, if any.
3604 org-time-stamp-formats)
3605 time)))
3611 nil nil ts)))
3616 " "
3617 s
3619 ;; Return value.
3620 ts)))
3632 build-ts-string
3651 0
3659 "--"
3672 ;;;; Underline
3675 "Parse underline object at point, if any.
3677 When at an underline object, return a list whose car is
3678 `underline' and cdr is a plist with `:begin', `:end',
3679 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3680 Otherwise, return nil.
3682 Assume point is at the first underscore marker."
3694 :end end
3695 :contents-begin contents-begin
3696 :contents-end contents-end
3700 "Interpret underline object as Org syntax.
3701 CONTENTS is the contents of the object."
3705 ;;;; Verbatim
3708 "Parse verbatim object at point, if any.
3710 When at a verbatim object, return a list whose car is `verbatim'
3711 and cdr is a plist with `:value', `:begin', `:end' and
3712 `:post-blank' keywords. Otherwise, return nil.
3714 Assume point is at the first equal sign marker."
3725 :begin begin
3726 :end end
3730 "Interpret VERBATIM object as Org syntax."
3734 \f
3735 ;;; Parsing Element Starting At Point
3736 ;;
3737 ;; `org-element--current-element' is the core function of this section.
3738 ;; It returns the Lisp representation of the element starting at
3739 ;; point.
3740 ;;
3741 ;; `org-element--current-element' makes use of special modes. They
3742 ;; are activated for fixed element chaining (e.g., `plain-list' >
3743 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3744 ;; `section'). Special modes are: `first-section', `item',
3745 ;; `node-property', `section' and `table-row'.
3748 "Parse the element starting at point.
3750 Return value is a list like (TYPE PROPS) where TYPE is the type
3751 of the element and PROPS a plist of properties associated to the
3752 element.
3754 Possible types are defined in `org-element-all-elements'.
3756 LIMIT bounds the search.
3758 Optional argument GRANULARITY determines the depth of the
3759 recursion. Allowed values are `headline', `greater-element',
3760 `element', `object' or nil. When it is broader than `object' (or
3761 nil), secondary values will not be parsed, since they only
3762 contain objects.
3764 Optional argument MODE, when non-nil, can be either
3765 `first-section', `section', `planning', `item', `node-property'
3766 and `table-row'.
3768 If STRUCTURE isn't provided but MODE is set to `item', it will be
3769 computed.
3771 This function assumes point is always at the beginning of the
3772 element it has to parse."
3775 ;; Determine if parsing depth allows for secondary strings
3776 ;; parsing. It only applies to elements referenced in
3777 ;; `org-element-secondary-value-alist'.
3780 ;; Item.
3783 ;; Table Row.
3785 ;; Node Property.
3787 ;; Headline.
3790 ;; Sections (must be checked after headline).
3795 limit)))
3796 ;; Planning.
3801 ;; Property drawer.
3807 ;; When not at bol, point is at the beginning of an item or
3808 ;; a footnote definition: next item is always a paragraph.
3810 ;; Clock.
3812 ;; Inlinetask.
3815 ;; From there, elements can have affiliated keywords.
3818 ;; Jumping over affiliated keywords put point off-limits.
3819 ;; Parse them as regular keywords.
3823 ;; LaTeX Environment.
3826 ;; Drawer and Property Drawer.
3829 ;; Fixed Width
3832 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3833 ;; Keywords.
3851 limit
3852 affiliated))
3865 ;; Footnote Definition.
3868 ;; Horizontal Rule.
3871 ;; Diary Sexp.
3874 ;; Table.
3877 ;; List.
3880 limit affiliated
3882 ;; Default element: Paragraph.
3886 ;; Most elements can have affiliated keywords. When looking for an
3887 ;; element beginning, we want to move before them, as they belong to
3888 ;; that element, and, in the meantime, collect information they give
3889 ;; into appropriate properties. Hence the following function.
3892 "Collect affiliated keywords from point down to LIMIT.
3894 Return a list whose CAR is the position at the first of them and
3895 CDR a plist of keywords and values and move point to the
3896 beginning of the first line after them.
3898 As a special case, if element doesn't start at the beginning of
3899 the line (e.g., a paragraph starting an item), CAR is current
3900 position of point and CDR is nil."
3904 ;; RESTRICT is the list of objects allowed in parsed
3905 ;; keywords value.
3907 output)
3910 ;; Apply translation to RAW-KWD. From there, KWD is
3911 ;; the official keyword.
3913 org-element-keyword-translation-alist))
3914 raw-kwd))
3915 ;; Find main value for any keyword.
3921 ;; PARSEDP is non-nil when keyword should have its
3922 ;; value parsed.
3924 ;; If KWD is a dual keyword, find its secondary
3925 ;; value. Maybe parse it.
3934 ;; Attribute a property name to KWD.
3936 ;; Now set final shape for VALUE.
3942 nil restrict)))
3946 ;; Attributes can always appear on multiple lines.
3949 ;; Eventually store the new value in OUTPUT.
3951 ;; Move to next keyword.
3953 ;; If affiliated keywords are orphaned: move back to first one.
3954 ;; They will be parsed as a paragraph.
3956 ;; Return value.
3960 \f
3961 ;;; The Org Parser
3962 ;;
3963 ;; The two major functions here are `org-element-parse-buffer', which
3964 ;; parses Org syntax inside the current buffer, taking into account
3965 ;; region, narrowing, or even visibility if specified, and
3966 ;; `org-element-parse-secondary-string', which parses objects within
3967 ;; a given string.
3968 ;;
3969 ;; The (almost) almighty `org-element-map' allows applying a function
3970 ;; on elements or objects matching some type, and accumulating the
3971 ;; resulting values. In an export situation, it also skips unneeded
3972 ;; parts of the parse tree.
3975 "Recursively parse the buffer and return structure.
3976 If narrowing is in effect, only parse the visible part of the
3977 buffer.
3979 Optional argument GRANULARITY determines the depth of the
3980 recursion. It can be set to the following symbols:
3982 `headline' Only parse headlines.
3983 `greater-element' Don't recurse into greater elements except
3984 headlines and sections. Thus, elements
3985 parsed are the top-level ones.
3986 `element' Parse everything but objects and plain text.
3987 `object' Parse the complete buffer (default).
3989 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3990 elements.
3992 An element or object is represented as a list with the
3993 pattern (TYPE PROPERTIES CONTENTS), where :
3995 TYPE is a symbol describing the element or object. See
3996 `org-element-all-elements' and `org-element-all-objects' for an
3997 exhaustive list of such symbols. One can retrieve it with
3998 `org-element-type' function.
4000 PROPERTIES is the list of attributes attached to the element or
4001 object, as a plist. Although most of them are specific to the
4002 element or object type, all types share `:begin', `:end',
4003 `:post-blank' and `:parent' properties, which respectively
4004 refer to buffer position where the element or object starts,
4005 ends, the number of white spaces or blank lines after it, and
4006 the element or object containing it. Properties values can be
4007 obtained by using `org-element-property' function.
4009 CONTENTS is a list of elements, objects or raw strings
4010 contained in the current element or object, when applicable.
4011 One can access them with `org-element-contents' function.
4013 The Org buffer has `org-data' as type and nil as properties.
4014 `org-element-map' function can be used to find specific elements
4015 or objects within the parse tree.
4017 This function assumes that current major mode is `org-mode'."
4023 ;; Start in `first-section' mode so text before the first
4024 ;; headline belongs to a section.
4028 "Recursively parse objects in STRING and return structure.
4030 RESTRICTION is a symbol limiting the object types that will be
4031 looked after.
4033 Optional argument PARENT, when non-nil, is the element or object
4034 containing the secondary string. It is used to set correctly
4035 `:parent' property within the string.
4037 If STRING is the empty string or nil, return nil."
4054 "Map a function on selected elements or objects.
4056 DATA is a parse tree, an element, an object, a string, or a list
4057 of such constructs. TYPES is a symbol or list of symbols of
4058 elements or objects types (see `org-element-all-elements' and
4059 `org-element-all-objects' for a complete list of types). FUN is
4060 the function called on the matching element or object. It has to
4061 accept one argument: the element or object itself.
4063 When optional argument INFO is non-nil, it should be a plist
4064 holding export options. In that case, parts of the parse tree
4065 not exportable according to that property list will be skipped.
4067 When optional argument FIRST-MATCH is non-nil, stop at the first
4068 match for which FUN doesn't return nil, and return that value.
4070 Optional argument NO-RECURSION is a symbol or a list of symbols
4071 representing elements or objects types. `org-element-map' won't
4072 enter any recursive element or object whose type belongs to that
4073 list. Though, FUN can still be applied on them.
4075 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4076 apply to matching objects within parsed affiliated keywords (see
4077 `org-element-parsed-keywords').
4079 Nil values returned from FUN do not appear in the results.
4082 Examples:
4083 ---------
4085 Assuming TREE is a variable containing an Org buffer parse tree,
4086 the following example will return a flat list of all `src-block'
4087 and `example-block' elements in it:
4091 The following snippet will find the first headline with a level
4095 (lambda (hl)
4096 (and (= (org-element-property :level hl) 1)
4098 (org-element-property :begin hl)))
4099 nil t)
4101 The next example will return a flat list of all `plain-list' type
4102 elements in TREE that are not a sub-list themselves:
4106 Eventually, this example will return a flat list of all `bold'
4107 type objects containing a `latex-snippet' type object, even
4108 looking into captions:
4111 (lambda (b)
4113 nil nil nil t)"
4114 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4118 ;; Recursion depth is determined by --CATEGORY.
4125 ;; If one object is found, the function has
4126 ;; to recurse into every object.
4129 ;; If one regular element is found, the
4130 ;; function has to recurse, at least, into
4131 ;; every element it encounters.
4134 --acc)
4137 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4138 ;; holding contextual information.
4142 ;; Ignored element in an export context.
4144 ;; List of elements or objects.
4146 ;; Unconditionally enter parse trees.
4150 ;; Check if TYPE is matching among TYPES. If so,
4151 ;; apply FUN to --DATA and accumulate return value
4152 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4158 ;; If --DATA has a secondary string that can contain
4159 ;; objects with their type among TYPES, look inside.
4162 org-element-secondary-value-alist)))
4164 ;; If --DATA has any parsed affiliated keywords and
4165 ;; WITH-AFFILIATED is non-nil, look for objects in
4166 ;; them.
4173 ;; Pay attention to the type of parsed
4174 ;; keyword. In particular, preserve order for
4175 ;; multiple keywords.
4188 ;; Determine if a recursion into --DATA is possible.
4190 ;; --TYPE is explicitly removed from recursion.
4192 ;; --DATA has no contents.
4194 ;; Looking for greater elements but --DATA is
4195 ;; simply an element or an object.
4198 ;; Looking for elements but --DATA is an object.
4201 ;; In any other case, map contents.
4205 ;; Return value in a proper order.
4209 ;; The following functions are internal parts of the parser.
4210 ;;
4211 ;; The first one, `org-element--parse-elements' acts at the element's
4212 ;; level.
4213 ;;
4214 ;; The second one, `org-element--parse-objects' applies on all objects
4215 ;; of a paragraph or a secondary string. It calls
4216 ;; `org-element--object-lex' to find the next object in the current
4217 ;; container.
4220 "Return next special mode according to TYPE, or nil.
4221 TYPE is a symbol representing the type of an element or object
4222 containing next element if PARENTP is non-nil, or before it
4223 otherwise. Modes can be either `first-section', `item',
4224 `node-property', `planning', `property-drawer', `section',
4225 `table-row' or nil."
4242 "Parse elements between BEG and END positions.
4244 MODE prioritizes some elements over the others. It can be set to
4245 `first-section', `section', `planning', `item', `node-property'
4246 or `table-row'.
4248 When value is `item', STRUCTURE will be used as the current list
4249 structure.
4251 GRANULARITY determines the depth of the recursion. See
4252 `org-element-parse-buffer' for more information.
4254 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4255 elements.
4257 Elements are accumulated into ACC."
4260 ;; Visible only: skip invisible parts at the beginning of the
4261 ;; element.
4264 ;; When parsing only headlines, skip any text before first one.
4269 ;; Find current element's type and parse it accordingly to
4270 ;; its category.
4272 end granularity mode structure))
4276 ;; Visible only: skip invisible parts between siblings.
4279 ;; Fill ELEMENT contents by side-effect.
4281 ;; If element has no contents, don't modify it.
4283 ;; Greater element: parse it between `contents-begin' and
4284 ;; `contents-end'. Make sure GRANULARITY allows the
4285 ;; recursion, or ELEMENT is a headline, in which case going
4286 ;; inside is mandatory, in order to get sub-level headings.
4294 ;; Possibly switch to a special mode.
4298 granularity visible-only element))
4299 ;; ELEMENT has contents. Parse objects inside, if
4300 ;; GRANULARITY allows it.
4306 ;; Update mode.
4308 ;; Return result.
4312 "Return next object in current buffer or nil.
4313 RESTRICTION is a list of object types, as symbols, that should be
4314 looked after. This function assumes that the buffer is narrowed
4315 to an appropriate container (e.g., a paragraph)."
4319 ;; Object regexp sometimes needs to have a peek at
4320 ;; a character ahead. Therefore, when there is a hard
4321 ;; limit, make it one more than the true beginning of the
4322 ;; radio target.
4329 nil)
4330 ;; Since we moved backward, we do not want to
4331 ;; match again an hypothetical 1-character long
4332 ;; radio link before us. Realizing that this can
4333 ;; only happen if such a radio link starts at
4334 ;; beginning of line, we prevent this here.
4340 found)
4406 ;; This is probably a plain link.
4416 "Parse objects between BEG and END and return recursive structure.
4418 Objects are accumulated in ACC. RESTRICTION is a list of object
4419 successors which are allowed in the current object.
4421 ACC becomes the parent for all parsed objects. However, if ACC
4422 is nil (i.e., a secondary string is being parsed) and optional
4423 argument PARENT is non-nil, use it as the parent for all objects.
4424 Eventually, if both ACC and PARENT are nil, the common parent is
4425 the list of objects itself."
4433 ;; Text before any object.
4438 contents))))
4439 ;; Object...
4444 ;; Fill contents of NEXT-OBJECT if possible.
4446 cont-beg
4448 next-object
4450 next-object)
4451 contents)
4453 ;; Text after last object.
4457 contents)))
4458 ;; Result. Set appropriate parent.
4466 \f
4467 ;;; Towards A Bijective Process
4468 ;;
4469 ;; The parse tree obtained with `org-element-parse-buffer' is really
4470 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4471 ;; interpreted and expanded into a string with canonical Org syntax.
4472 ;; Hence `org-element-interpret-data'.
4473 ;;
4474 ;; The function relies internally on
4475 ;; `org-element--interpret-affiliated-keywords'.
4477 ;;;###autoload
4479 "Interpret DATA as Org syntax.
4480 DATA is a parse tree, an element, an object or a secondary string
4481 to interpret. Return Org syntax as a string."
4485 ;; Find interpreter for current object or
4486 ;; element. If it doesn't exist (e.g. this is
4487 ;; a pseudo object or element), return contents,
4488 ;; if any.
4495 ;; Secondary string.
4498 data
4500 ;; Full Org document.
4505 ;; Plain text: return it.
4507 ;; Element or object without contents.
4510 ;; Element or object with contents.
4513 interpret
4514 data
4515 ;; Recursively interpret contents.
4520 data
4521 ;; Fix indentation of elements containing
4522 ;; objects. We ignore `table-row'
4523 ;; elements as they are one line long
4524 ;; anyway.
4526 data
4527 ;; When normalizing first paragraph of
4528 ;; an item or a footnote-definition,
4529 ;; ignore first line's indentation.
4537 ;; Build white spaces. If no `:post-blank' property
4538 ;; is specified, assume its value is 0.
4548 "Return ELEMENT's affiliated keywords as Org syntax.
4549 If there is no affiliated keyword, return the empty string."
4559 ": "
4562 value)
4570 ;; All attribute keywords can have multiple lines.
4576 ;; List all ELEMENT's properties matching an attribute line or an
4577 ;; affiliated keyword, but ignore translated keywords since they
4578 ;; cannot belong to the property list.
4585 org-element-keyword-translation-alist)))))
4586 collect prop)
4589 ;; Because interpretation of the parse tree must return the same
4590 ;; number of blank lines between elements and the same number of white
4591 ;; space after objects, some special care must be given to white
4592 ;; spaces.
4593 ;;
4594 ;; The first function, `org-element-normalize-string', ensures any
4595 ;; string different from the empty string will end with a single
4596 ;; newline character.
4597 ;;
4598 ;; The second function, `org-element-normalize-contents', removes
4599 ;; global indentation from the contents of the current element.
4602 "Ensure string S ends with a single newline character.
4604 If S isn't a string return it unchanged. If S is the empty
4605 string, return it. Otherwise, return a new string with a single
4606 newline character at its end."
4614 "Normalize plain text in ELEMENT's contents.
4616 ELEMENT must only contain plain text and objects.
4618 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4619 indentation to compute maximal common indentation.
4621 Return the normalized element that is element with global
4622 indentation removed from its contents."
4624 ;; Return minimal common indentation within BLOB. This is
4625 ;; done by walking recursively BLOB and updating MIN-IND
4626 ;; along the way. FIRST-FLAG is non-nil when the next
4627 ;; object is expected to be a string that doesn't start
4628 ;; with a newline character. It happens for strings at
4629 ;; the beginnings of the contents or right after a line
4630 ;; break.
4636 ;; Objects cannot start with spaces: in this
4637 ;; case, indentation is 0.
4678 ;; Build ELEMENT back, replacing each string with the same
4679 ;; string minus common indentation.
4682 ;; Return DATUM with all its strings indentation
4683 ;; shortened from MIN-IND white spaces.
4703 org-element-recursive-objects)
4707 datum)))
4711 \f
4712 ;;; Cache
4713 ;;
4714 ;; Implement a caching mechanism for `org-element-at-point' and
4715 ;; `org-element-context', which see.
4716 ;;
4717 ;; A single public function is provided: `org-element-cache-reset'.
4718 ;;
4719 ;; Cache is enabled by default, but can be disabled globally with
4720 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4721 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4722 ;; can be tweaked to control caching behaviour.
4723 ;;
4724 ;; Internally, parsed elements are stored in an AVL tree,
4725 ;; `org-element--cache'. This tree is updated lazily: whenever
4726 ;; a change happens to the buffer, a synchronization request is
4727 ;; registered in `org-element--cache-sync-requests' (see
4728 ;; `org-element--cache-submit-request'). During idle time, requests
4729 ;; are processed by `org-element--cache-sync'. Synchronization also
4730 ;; happens when an element is required from the cache. In this case,
4731 ;; the process stops as soon as the needed element is up-to-date.
4732 ;;
4733 ;; A synchronization request can only apply on a synchronized part of
4734 ;; the cache. Therefore, the cache is updated at least to the
4735 ;; location where the new request applies. Thus, requests are ordered
4736 ;; from left to right and all elements starting before the first
4737 ;; request are correct. This property is used by functions like
4738 ;; `org-element--cache-find' to retrieve elements in the part of the
4739 ;; cache that can be trusted.
4740 ;;
4741 ;; A request applies to every element, starting from its original
4742 ;; location (or key, see below). When a request is processed, it
4743 ;; moves forward and may collide the next one. In this case, both
4744 ;; requests are merged into a new one that starts from that element.
4745 ;; As a consequence, the whole synchronization complexity does not
4746 ;; depend on the number of pending requests, but on the number of
4747 ;; elements the very first request will be applied on.
4748 ;;
4749 ;; Elements cannot be accessed through their beginning position, which
4750 ;; may or may not be up-to-date. Instead, each element in the tree is
4751 ;; associated to a key, obtained with `org-element--cache-key'. This
4752 ;; mechanism is robust enough to preserve total order among elements
4753 ;; even when the tree is only partially synchronized.
4757 "Non-nil when Org parser should cache its results.
4759 WARNING: for the time being, using cache sometimes triggers
4760 freezes. Therefore, it is disabled by default. Activate it if
4767 "Maximum duration, as a time value, for a cache synchronization.
4768 If the synchronization is not over after this delay, the process
4769 pauses and resumes after `org-element-cache-sync-break'
4773 "Duration, as a time value, of the pause between synchronizations.
4777 ;;;; Data Structure
4780 "AVL tree used to cache elements.
4781 Each node of the tree contains an element. Comparison is done
4782 with `org-element--cache-compare'. This cache is used in
4786 "List of pending synchronization requests.
4788 A request is a vector with the following pattern:
4790 \[NEXT BEG END OFFSET PARENT PHASE]
4792 Processing a synchronization request consists of three phases:
4794 0. Delete modified elements,
4795 1. Fill missing area in cache,
4796 2. Shift positions and re-parent elements after the changes.
4798 During phase 0, NEXT is the key of the first element to be
4799 removed, BEG and END is buffer position delimiting the
4800 modifications. Elements starting between them (inclusive) are
4801 removed. So are elements whose parent is removed. PARENT, when
4802 non-nil, is the parent of the first element to be removed.
4804 During phase 1, NEXT is the key of the next known element in
4805 cache and BEG its beginning position. Parse buffer between that
4806 element and the one before it in order to determine the parent of
4807 the next element. Set PARENT to the element containing NEXT.
4809 During phase 2, NEXT is the key of the next element to shift in
4810 the parse tree. All elements starting from this one have their
4811 properties relatives to buffer positions shifted by integer
4812 OFFSET and, if they belong to element PARENT, are adopted by it.
4820 "Hash table used to store keys during synchronization.
4824 "Return a unique key for ELEMENT in cache tree.
4826 Keys are used to keep a total order among elements in the cache.
4827 Comparison is done with `org-element--cache-key-less-p'.
4829 When no synchronization is taking place, a key is simply the
4830 beginning position of the element, or that position plus one in
4831 the case of an first item (respectively row) in
4832 a list (respectively a table).
4834 During a synchronization, the key is the one the element had when
4835 the cache was synchronized for the last time. Elements added to
4836 cache during the synchronization get a new key generated with
4837 `org-element--cache-generate-key'.
4839 Such keys are stored in `org-element--cache-sync-keys'. The hash
4840 table is cleared once the synchronization is complete."
4843 ;; Increase beginning position of items (respectively
4844 ;; table rows) by one, so the first item can get
4845 ;; a different key from its parent list (respectively
4846 ;; table).
4849 begin)))
4852 key))))
4855 "Generate a key between LOWER and UPPER.
4857 LOWER and UPPER are integers or lists, possibly empty.
4859 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4860 a unique key, as an integer or a list of integers, according to
4861 the following rules:
4863 - LOWER and UPPER are compared level-wise until values differ.
4865 - If, at a given level, LOWER and UPPER differ from more than
4866 2, the new key shares all the levels above with LOWER and
4867 gets a new level. Its value is the mean between LOWER and
4868 UPPER:
4870 (1 2) + (1 4) --> (1 3)
4872 - If LOWER has no value to compare with, it is assumed that its
4873 value is `most-negative-fixnum'. E.g.,
4875 (1 1) + (1 1 2)
4877 is equivalent to
4879 (1 1 m) + (1 1 2)
4881 where m is `most-negative-fixnum'. Likewise, if UPPER is
4882 short of levels, the current value is `most-positive-fixnum'.
4884 - If they differ from only one, the new key inherits from
4885 current LOWER level and fork it at the next level. E.g.,
4887 (2 1) + (3 3)
4889 is equivalent to
4891 (2 1) + (2 M)
4893 where M is `most-positive-fixnum'.
4895 - If the key is only one level long, it is returned as an
4896 integer:
4898 (1 2) + (3 2) --> 2
4900 When they are not equals, the function assumes that LOWER is
4901 lesser than UPPER, per `org-element--cache-key-less-p'."
4905 skip-upper key)
4916 ;; When at a given level, LOWER and UPPER differ from
4917 ;; 1, ignore UPPER altogether. Instead create a key
4918 ;; between LOWER and the greatest key with the same
4919 ;; prefix as LOWER so far.
4925 "Non-nil if key A is less than key B.
4926 A and B are either integers or lists of integers, as returned by
4927 `org-element--cache-key'."
4935 ;; If A is empty, either keys are equal (B is also empty) and
4936 ;; we return nil, or A is lesser than B (B is longer) and we
4937 ;; return a non-nil value.
4938 ;;
4939 ;; If A is not empty, B is necessarily empty and A is greater
4940 ;; than B (A is longer). Therefore, return nil.
4944 "Non-nil when element A is located before element B."
4949 "Return root value in cache.
4950 This function assumes `org-element--cache' is a valid AVL tree."
4954 ;;;; Tools
4957 "Non-nil when cache is active in current buffer."
4959 org-element--cache
4963 "Find element in cache starting at POS or before.
4965 POS refers to a buffer position.
4967 When optional argument SIDE is non-nil, the function checks for
4968 elements starting at or past POS instead. If SIDE is `both', the
4969 function returns a cons cell where car is the first element
4970 starting at or before POS and cdr the first element starting
4971 after POS.
4973 The function can only find elements in the synchronized part of
4974 the cache."
4978 lower upper)
4993 ;; We found an element in cache starting at POS. If `side'
4994 ;; is `both' we also want the next one in order to generate
4995 ;; a key in-between.
4996 ;;
4997 ;; If the element is the first row or item in a table or
4998 ;; a plain list, we always return the table or the plain
4999 ;; list.
5000 ;;
5001 ;; In any other case, we return the element found.
5010 lower parent
5011 upper parent)))))
5014 lower element
5015 upper element)))))
5022 "Store ELEMENT in current buffer's cache, if allowed."
5025 ;; During synchronization, first build an appropriate key for
5026 ;; the new element so `avl-tree-enter' can insert it at the
5027 ;; right spot in the cache.
5036 org-element--cache-sync-keys)))
5040 "Remove ELEMENT from cache.
5041 Assume ELEMENT belongs to cache and that a cache is active."
5045 ;;;; Synchronization
5048 "Set idle timer for cache synchronization in BUFFER."
5055 org-element-cache-sync-idle-time))
5056 nil
5057 #'org-element--cache-sync
5058 buffer)))
5061 "Non-nil when synchronization process should be interrupted.
5062 TIME-LIMIT is a time value or nil."
5068 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5070 Properties containing buffer positions are `:begin', `:end',
5071 `:contents-begin', `:contents-end' and `:structure'. When
5072 optional argument PROPS is a list of keywords, only shift
5073 properties provided in that list.
5075 Properties are modified by side-effect."
5077 ;; Shift `:structure' property for the first plain list only: it
5078 ;; is the only one that really matters and it prevents from
5079 ;; shifting it more than once.
5093 "Synchronize cache with recent modification in BUFFER.
5095 When optional argument THRESHOLD is non-nil, do the
5096 synchronization for all elements starting before or at threshold,
5097 then exit. Otherwise, synchronize cache for as long as
5098 `org-element-cache-sync-duration' or until Emacs leaves idle
5099 state.
5101 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5102 not registered yet in the cache are going to happen. It is used
5103 in `org-element--cache-submit-request', where cache is partially
5104 updated before current modification are actually submitted."
5115 request
5117 threshold
5120 org-element-cache-sync-duration))
5121 future-change)
5122 ;; Request processed. Merge current and next offsets and
5123 ;; transfer ending position.
5129 ;; If more requests are awaiting, set idle timer accordingly.
5130 ;; Otherwise, reset keys.
5137 "Process synchronization REQUEST for all entries before NEXT.
5139 REQUEST is a vector, built by `org-element--cache-submit-request'.
5141 NEXT is a cache key, as returned by `org-element--cache-key'.
5143 When non-nil, THRESHOLD is a buffer position. Synchronization
5144 stops as soon as a shifted element begins after it.
5146 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5147 after this time or when Emacs exits idle state.
5149 When non-nil, FUTURE-CHANGE is a buffer position where changes
5150 not registered yet in the cache are going to happen. See
5151 `org-element--cache-submit-request' for more information.
5153 Throw `interrupt' if the process stops before completing the
5154 request."
5157 ;; Phase 0.
5158 ;;
5159 ;; Delete all elements starting after BEG, but not after buffer
5160 ;; position END or past element with key NEXT. Also delete
5161 ;; elements contained within a previously removed element
5162 ;; (stored in `last-container').
5163 ;;
5164 ;; At each iteration, we start again at tree root since
5165 ;; a deletion modifies structure of the balanced tree.
5170 ;; Find first element in cache with key BEG or after it.
5174 data data-key last-container)
5183 data-key key
5186 data-key key
5187 node nil)))))
5197 up)))
5200 end))
5207 ;; No element starting after modifications left in
5208 ;; cache: further processing is futile.
5211 ;; Phase 1.
5212 ;;
5213 ;; Phase 0 left a hole in the cache. Some elements after it
5214 ;; could have parents within. For example, in the following
5215 ;; buffer:
5216 ;;
5217 ;; - item
5218 ;;
5219 ;;
5220 ;; Paragraph1
5221 ;;
5222 ;; Paragraph2
5223 ;;
5224 ;; if we remove a blank line between "item" and "Paragraph1",
5225 ;; everything down to "Paragraph2" is removed from cache. But
5226 ;; the paragraph now belongs to the list, and its `:parent'
5227 ;; property no longer is accurate.
5228 ;;
5229 ;; Therefore we need to parse again elements in the hole, or at
5230 ;; least in its last section, so that we can re-parent
5231 ;; subsequent elements, during phase 2.
5232 ;;
5233 ;; Note that we only need to get the parent from the first
5234 ;; element in cache after the hole.
5235 ;;
5236 ;; When next key is lesser or equal to the current one, delegate
5237 ;; phase 1 processing to next request in order to preserve key
5238 ;; order among requests.
5246 ;; Next element will start at its beginning position plus
5247 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5248 ;; contains the real beginning position of the first element to
5249 ;; shift and re-parent.
5253 ;; Changes are going to happen around this element and
5254 ;; they will trigger another phase 1 request. Skip the
5255 ;; current one.
5261 ;; Phase 2.
5262 ;;
5263 ;; Shift all elements starting from key START, but before NEXT, by
5264 ;; OFFSET, and re-parent them when appropriate.
5265 ;;
5266 ;; Elements are modified by side-effect so the tree structure
5267 ;; remains intact.
5268 ;;
5269 ;; Once THRESHOLD, if any, is reached, or once there is an input
5270 ;; pending, exit. Before leaving, the current synchronization
5271 ;; request is updated.
5278 exit-flag)
5279 ;; No re-parenting nor shifting planned: request is over.
5289 ;; We reached NEXT. Request is complete.
5291 ;; Handle interruption request. Update current request.
5296 ;; Shift element.
5300 ;; Update PARENT and re-parent DATA, only when
5301 ;; necessary. Propagate new structures for lists.
5315 ;; Cache is up-to-date past THRESHOLD. Request
5316 ;; interruption.
5321 ;; We reached end of tree: synchronization complete.
5322 t)))
5325 "Parse elements in current section, down to POS.
5327 Start parsing from the closest between the last known element in
5328 cache or headline above. Return the smallest element containing
5329 POS.
5331 When optional argument SYNCP is non-nil, return the parent of the
5332 element containing POS instead. In that case, it is also
5333 possible to provide TIME-LIMIT, which is a time value specifying
5334 when the parsing should stop. The function throws `interrupt' if
5335 the process stopped before finding the expected result."
5342 element next mode)
5344 ;; Nothing in cache before point: start parsing from first
5345 ;; element following headline above, or first element in
5346 ;; buffer.
5353 ;; Cache returned exact match: return it.
5356 ;; There's a headline between cached value and POS: cached
5357 ;; value is invalid. Start parsing from first element
5358 ;; following the headline.
5365 ;; Check if CACHED or any of its ancestors contain point.
5366 ;;
5367 ;; If there is such an element, we inspect it in order to know
5368 ;; if we return it or if we need to parse its contents.
5369 ;; Otherwise, we just start parsing from current location,
5370 ;; which is right after the top-most element containing
5371 ;; CACHED.
5372 ;;
5373 ;; As a special case, if POS is at the end of the buffer, we
5374 ;; want to return the innermost element ending there.
5375 ;;
5376 ;; Also, if we find an ancestor and discover that we need to
5377 ;; parse its contents, make sure we don't start from
5378 ;; `:contents-begin', as we would otherwise go past CACHED
5379 ;; again. Instead, in that situation, we will resume parsing
5380 ;; from NEXT, which is located after CACHED or its higher
5381 ;; ancestor not containing point.
5393 ;; Parse successively each element until we reach POS.
5406 end 'element mode
5413 ;; Skip any element ending before point. Also skip
5414 ;; element ending at point (unless it is also the end of
5415 ;; buffer) since we're sure that another element begins
5416 ;; after it.
5420 ;; A non-greater element contains point: return it.
5423 ;; Otherwise, we have to decide if ELEMENT really
5424 ;; contains POS. In that case we start parsing from
5425 ;; contents' beginning.
5426 ;;
5427 ;; If POS is at contents' beginning but it is also at
5428 ;; the beginning of the first item in a list or a table.
5429 ;; In that case, we need to create an anchor for that
5430 ;; list or table, so return it.
5431 ;;
5432 ;; Also, if POS is at the end of the buffer, no element
5433 ;; can start after it, but more than one may end there.
5434 ;; Arbitrarily, we choose to return the innermost of
5435 ;; such elements.
5448 parent element
5449 end cend))))
5450 ;; Otherwise, return ELEMENT as it is the smallest
5451 ;; element containing POS.
5456 ;;;; Staging Buffer Changes
5467 "Regexp matching a sensitive line, structure wise.
5468 A sensitive line is a headline, inlinetask, block, drawer, or
5469 latex-environment boundary. When such a line is modified,
5470 structure changes in the document may propagate in the whole
5474 "Non-nil when a sensitive line is about to be changed.
5478 "Request extension of area going to be modified if needed.
5479 BEG and END are the beginning and end of the range of changed
5480 text. See `before-change-functions' for more information."
5490 'headline
5493 org-element--cache-sensitive-re bottom t)))))))))
5496 "Update buffer modifications for current buffer.
5497 BEG and END are the beginning and end of the range of changed
5498 text, and the length in bytes of the pre-change text replaced by
5499 that range. See `after-change-functions' for more information."
5507 ;; Determine if modified area needs to be extended, according
5508 ;; to both previous and current state. We make a special
5509 ;; case for headline editing: if a headline is modified but
5510 ;; not removed, do not extend.
5513 (`headline
5519 org-element--cache-sensitive-re bottom t))))
5520 ;; Effectively extend modified area.
5528 ;; Store synchronization request.
5531 ;; Activate a timer to process the request during idle time.
5535 "Return first element to remove from cache.
5537 BEG and END are buffer positions delimiting buffer modifications.
5538 OFFSET is the size of the changes.
5540 Returned element is usually the first element in cache containing
5541 any position between BEG and END. As an exception, greater
5542 elements around the changes that are robust to contents
5543 modifications are preserved and updated according to the
5544 changes."
5554 special-block))
5555 ;; Drawers named "PROPERTIES" are probably
5556 ;; a properties drawer being edited. Force
5557 ;; parsing to check if editing is over.
5566 ;; UP is a robust greater element containing changes.
5567 ;; We only need to extend its ending boundaries.
5573 ;; We're at top level element containing ELEMENT: if it's
5574 ;; altered by buffer modifications, it is first element in
5575 ;; cache to be removed. Otherwise, that first element is the
5576 ;; following one.
5577 ;;
5578 ;; As a special case, do not remove BEFORE if it is a robust
5579 ;; container for current changes.
5581 before)))))
5584 "Submit a new cache synchronization request for current buffer.
5585 BEG and END are buffer positions delimiting the minimal area
5586 where cache data should be removed. OFFSET is the size of the
5587 change, as an integer."
5589 delete-to delete-from)
5594 ;; Current changes can be merged with first sync request: we
5595 ;; can save a partial cache synchronization.
5598 ;; If last change happened within area to be removed, extend
5599 ;; boundaries of robust parents, if any. Otherwise, find
5600 ;; first element to remove and update request accordingly.
5612 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5613 ;; if any, is no longer a 0-phase request, thus ensuring that
5614 ;; phases are properly ordered. We need to provide OFFSET as
5615 ;; optional parameter since current modifications are not known
5616 ;; yet to the otherwise correct part of the cache (i.e, before
5617 ;; the first request).
5624 ;; When changes happen before the first known
5625 ;; element, re-parent and shift the rest of the
5626 ;; cache.
5628 ;; Otherwise, we find the first non robust
5629 ;; element containing END. All elements between
5630 ;; FIRST and this one are to be removed.
5641 element up))
5643 org-element--cache-sync-requests)
5644 ;; No element to remove. No need to re-parent either.
5645 ;; Simply shift additional elements, if any, by OFFSET.
5648 offset)))))))
5651 ;;;; Public Functions
5653 ;;;###autoload
5655 "Reset cache in current buffer.
5656 When optional argument ALL is non-nil, reset cache in all Org
5657 buffers."
5674 ;;;###autoload
5676 "Refresh cache at position POS."
5683 \f
5684 ;;; The Toolbox
5685 ;;
5686 ;; The first move is to implement a way to obtain the smallest element
5687 ;; containing point. This is the job of `org-element-at-point'. It
5688 ;; basically jumps back to the beginning of section containing point
5689 ;; and proceed, one element after the other, with
5690 ;; `org-element--current-element' until the container is found. Note:
5691 ;; When using `org-element-at-point', secondary values are never
5692 ;; parsed since the function focuses on elements, not on objects.
5693 ;;
5694 ;; At a deeper level, `org-element-context' lists all elements and
5695 ;; objects containing point.
5696 ;;
5697 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5698 ;; internally by navigation and manipulation tools.
5701 ;;;###autoload
5703 "Determine closest element around point.
5705 Return value is a list like (TYPE PROPS) where TYPE is the type
5706 of the element and PROPS a plist of properties associated to the
5707 element.
5709 Possible types are defined in `org-element-all-elements'.
5710 Properties depend on element or object type, but always include
5711 `:begin', `:end', `:parent' and `:post-blank' properties.
5713 As a special case, if point is at the very beginning of the first
5714 item in a list or sub-list, returned element will be that list
5715 instead of the item. Likewise, if point is at the beginning of
5716 the first row of a table, returned element will be the table
5717 instead of the first row.
5719 When point is at the end of the buffer, return the innermost
5720 element ending there."
5726 ;; Within blank lines at the beginning of buffer, return nil.
5728 ;; Within blank lines right after a headline, return that
5729 ;; headline.
5733 ;; Otherwise parse until we find element containing ORIGIN.
5740 ;;;###autoload
5742 "Return smallest element or object around point.
5744 Return value is a list like (TYPE PROPS) where TYPE is the type
5745 of the element or object and PROPS a plist of properties
5746 associated to it.
5748 Possible types are defined in `org-element-all-elements' and
5749 `org-element-all-objects'. Properties depend on element or
5750 object type, but always include `:begin', `:end', `:parent' and
5751 `:post-blank'.
5753 As a special case, if point is right after an object and not at
5754 the beginning of any other object, return that object.
5756 Optional argument ELEMENT, when non-nil, is the closest element
5757 containing point, as returned by `org-element-at-point'.
5758 Providing it allows for quicker computation."
5765 ;; If point is inside an element containing objects or
5766 ;; a secondary string, narrow buffer to the container and
5767 ;; proceed with parsing. Otherwise, return ELEMENT.
5769 ;; At a parsed affiliated keyword, check if we're inside main
5770 ;; or dual value.
5776 org-element-parsed-keywords))
5785 ;; Also change type to retrieve correct restrictions.
5787 ;; At an item, objects can only be located within tag, if any.
5798 ;; At an headline or inlinetask, objects are in title.
5810 ;; At a paragraph, a table-row or a verse block, objects are
5811 ;; located within their contents.
5815 ;; CBEG is nil for table rules.
5824 last)
5829 ;; Process NEXT, if any, in order to know if we need to
5830 ;; skip it, return it or move into it.
5837 ;; Skip objects ending before point. Also skip
5838 ;; objects ending at point unless it is also the
5839 ;; end of buffer, since we want to return the
5840 ;; innermost object.
5843 ;; For convenience, when object ends at POS,
5844 ;; without any space, store it in LAST, as we
5845 ;; will return it if no object starts here.
5849 ;; If POS is within a container object, move into
5850 ;; that object.
5854 ;; At contents' end, if there is no
5855 ;; space before point, also move into
5856 ;; object, for consistency with
5857 ;; convenience feature above.
5866 ;; Otherwise, return NEXT.
5870 "List all ancestors of a given element or object.
5872 BLOB is an object or element.
5874 When optional argument TYPES is a list of symbols, return the
5875 first element or object in the lineage whose type belongs to that
5876 list.
5878 When optional argument WITH-SELF is non-nil, lineage includes
5879 BLOB itself as the first element, and TYPES, if provided, also
5880 apply to it.
5882 When BLOB is obtained through `org-element-context' or
5883 `org-element-at-point', only ancestors from its section can be
5884 found. There is no such limitation when BLOB belongs to a full
5885 parse tree."
5887 ancestors)
5894 "Non-nil when elements ELEM-A and ELEM-B are nested."
5903 "Swap elements ELEM-A and ELEM-B.
5904 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5905 end of ELEM-A."
5907 ;; There are two special cases when an element doesn't start at bol:
5908 ;; the first paragraph in an item or in a footnote definition.
5910 ;; Only a paragraph without any affiliated keyword can be moved at
5911 ;; ELEM-A position in such a situation. Note that the case of
5912 ;; a footnote definition is impossible: it cannot contain two
5913 ;; paragraphs in a row because it cannot contain a blank line.
5919 ;; In a special situation, ELEM-A will have no indentation. We'll
5920 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5934 ;; Store inner overlays responsible for visibility status.
5935 ;; We also need to store their boundaries as they will be
5936 ;; removed from buffer.
5951 ;; Get contents.
5959 ;; Restore ex ELEM-A overlays.
5966 ;; Restore ex ELEM-B overlays.
5974 ;; Local variables:
5975 ;; generated-autoload-file: "org-loaddefs.el"
5976 ;; End:
5978 ;;; org-element.el ends here