| blob | f2b3002f1fd575805b23fd8054026516d0782cb2 |
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 <https://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."
2991 ;; Macro.
3014 :begin begin
3015 :end end
3019 "Interpret LATEX-FRAGMENT object as Org syntax."
3022 ;;;; Line Break
3025 "Parse line break at point, if any.
3027 When at a line break, return a list whose car is `line-break',
3028 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3029 Otherwise, return nil.
3031 Assume point is at the beginning of the line break."
3040 "Interpret LINE-BREAK object as Org syntax."
3044 ;;;; Link
3047 "Parse link at point, if any.
3049 When at a link, return a list whose car is `link' and cdr a plist
3050 with `:type', `:path', `:format', `:raw-link', `:application',
3051 `:search-option', `:begin', `:end', `:contents-begin',
3052 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3053 nil.
3055 Assume point is at the beginning of the link."
3058 end contents-begin contents-end link-end post-blank path type format
3059 raw-link search-option application)
3061 ;; Type 1: Text targeted from a radio target.
3071 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3077 ;; RAW-LINK is the original link. Expand any
3078 ;; abbreviation in it.
3079 ;;
3080 ;; Also treat any newline character and associated
3081 ;; indentation as a single space character. This is not
3082 ;; compatible with RFC 3986, which requires to ignore
3083 ;; them altogether. However, doing so would require
3084 ;; users to encode spaces on the fly when writing links
3085 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3086 ;; [[shell:ls *.org]], which defeats Org's focus on
3087 ;; simplicity.
3092 ;; Determine TYPE of link and set PATH accordingly. According
3093 ;; to RFC 3986, remove whitespaces from URI in external links.
3094 ;; In internal ones, treat indentation as a single space.
3096 ;; File type.
3101 ;; Explicit type (http, irc, bbdb...).
3105 ;; Code-ref type: PATH is the name of the reference.
3110 ;; Custom-id type: PATH is the name of the custom id.
3114 ;; Fuzzy type: Internal link either matches a target, an
3115 ;; headline name or nothing. PATH is the target or
3116 ;; headline's name.
3120 ;; Type 3: Plain link, e.g., http://orgmode.org
3127 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3128 ;; bracket links, follow RFC 3986 and remove any extra
3129 ;; whitespace in URI.
3140 ;; In any case, deduce end point after trailing white space from
3141 ;; LINK-END variable.
3146 ;; Special "file" type link processing. Extract opening
3147 ;; application and search option, if any. Also normalize URI.
3154 ;; Translate link, if `org-link-translation-function' is set.
3162 :path path
3163 :format format
3165 :application application
3166 :search-option search-option
3167 :begin begin
3168 :end end
3169 :contents-begin contents-begin
3170 :contents-end contents-end
3174 "Interpret LINK object as Org syntax.
3175 CONTENTS is the contents of the object, or nil."
3180 ;; Links with contents and internal links have to
3181 ;; use bracket syntax. Ignore `:format' in these
3182 ;; cases. This is also the default syntax when the
3183 ;; property is not defined, e.g., when the object
3184 ;; was crafted by the user.
3187 ;; Since this is going to be used as
3188 ;; a format string, escape percent signs
3189 ;; in description.
3192 `nil
3195 ;; Otherwise, just obey to `:format'.
3207 path
3213 ;;;; Macro
3216 "Parse macro at point, if any.
3218 When at a macro, return a list whose car is `macro' and cdr
3219 a plist with `:key', `:args', `:begin', `:end', `:value' and
3220 `:post-blank' as keywords. Otherwise, return nil.
3222 Assume point is at the macro."
3235 :value value
3236 :args args
3237 :begin begin
3238 :end end
3242 "Interpret MACRO object as Org syntax."
3246 ;;;; Radio-target
3249 "Parse radio target at point, if any.
3251 When at a radio target, return a list whose car is `radio-target'
3252 and cdr a plist with `:begin', `:end', `:contents-begin',
3253 `:contents-end', `:value' and `:post-blank' as keywords.
3254 Otherwise, return nil.
3256 Assume point is at the radio target."
3268 :end end
3269 :contents-begin contents-begin
3270 :contents-end contents-end
3271 :post-blank post-blank
3275 "Interpret target object as Org syntax.
3276 CONTENTS is the contents of the object."
3280 ;;;; Statistics Cookie
3283 "Parse statistics cookie at point, if any.
3285 When at a statistics cookie, return a list whose car is
3286 `statistics-cookie', and cdr a plist with `:begin', `:end',
3287 `:value' and `:post-blank' keywords. Otherwise, return nil.
3289 Assume point is at the beginning of the statistics-cookie."
3300 :end end
3301 :value value
3305 "Interpret STATISTICS-COOKIE object as Org syntax."
3309 ;;;; Strike-Through
3312 "Parse strike-through object at point, if any.
3314 When at a strike-through object, return a list whose car is
3315 `strike-through' and cdr is a plist with `:begin', `:end',
3316 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3317 Otherwise, return nil.
3319 Assume point is at the first plus sign marker."
3331 :end end
3332 :contents-begin contents-begin
3333 :contents-end contents-end
3337 "Interpret strike-through object as Org syntax.
3338 CONTENTS is the contents of the object."
3342 ;;;; Subscript
3345 "Parse subscript at point, if any.
3347 When at a subscript object, return a list whose car is
3348 `subscript' and cdr a plist with `:begin', `:end',
3349 `:contents-begin', `:contents-end', `:use-brackets-p' and
3350 `:post-blank' as keywords. Otherwise, return nil.
3352 Assume point is at the underscore."
3366 :end end
3367 :use-brackets-p bracketsp
3368 :contents-begin contents-begin
3369 :contents-end contents-end
3373 "Interpret SUBSCRIPT object as Org syntax.
3374 CONTENTS is the contents of the object."
3377 contents))
3380 ;;;; Superscript
3383 "Parse superscript at point, if any.
3385 When at a superscript object, return a list whose car is
3386 `superscript' and cdr a plist with `:begin', `:end',
3387 `:contents-begin', `:contents-end', `:use-brackets-p' and
3388 `:post-blank' as keywords. Otherwise, return nil.
3390 Assume point is at the caret."
3404 :end end
3405 :use-brackets-p bracketsp
3406 :contents-begin contents-begin
3407 :contents-end contents-end
3411 "Interpret SUPERSCRIPT object as Org syntax.
3412 CONTENTS is the contents of the object."
3415 contents))
3418 ;;;; Table Cell
3421 "Parse table cell at point.
3422 Return a list whose car is `table-cell' and cdr is a plist
3423 containing `:begin', `:end', `:contents-begin', `:contents-end'
3424 and `:post-blank' keywords."
3432 :end end
3433 :contents-begin contents-begin
3434 :contents-end contents-end
3438 "Interpret table-cell element as Org syntax.
3439 CONTENTS is the contents of the cell, or nil."
3443 ;;;; Target
3446 "Parse target at point, if any.
3448 When at a target, return a list whose car is `target' and cdr
3449 a plist with `:begin', `:end', `:value' and `:post-blank' as
3450 keywords. Otherwise, return nil.
3452 Assume point is at the target."
3462 :end end
3463 :value value
3467 "Interpret TARGET object as Org syntax."
3471 ;;;; Timestamp
3482 "Parse time stamp at point, if any.
3484 When at a time stamp, return a list whose car is `timestamp', and
3485 cdr a plist with `:type', `:raw-value', `:year-start',
3486 `:month-start', `:day-start', `:hour-start', `:minute-start',
3487 `:year-end', `:month-end', `:day-end', `:hour-end',
3488 `:minute-end', `:repeater-type', `:repeater-value',
3489 `:repeater-unit', `:warning-type', `:warning-value',
3490 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3491 Otherwise, return nil.
3493 Assume point is at the beginning of the timestamp."
3512 date-start)
3523 raw-value)
3525 :repeater-type
3531 :repeater-unit
3540 :warning-unit
3543 year-start month-start day-start hour-start minute-start year-end
3544 month-end day-end hour-end minute-end)
3545 ;; Parse date-start.
3553 ;; Compute date-end. It can be provided directly in time-stamp,
3554 ;; or extracted from time range. Otherwise, it defaults to the
3555 ;; same values as date-start.
3565 :raw-value raw-value
3566 :year-start year-start
3567 :month-start month-start
3568 :day-start day-start
3569 :hour-start hour-start
3570 :minute-start minute-start
3571 :year-end year-end
3572 :month-end month-end
3573 :day-end day-end
3574 :hour-end hour-end
3575 :minute-end minute-end
3576 :begin begin
3577 :end end
3579 repeater-props
3580 warning-props))))))
3583 "Interpret TIMESTAMP object as Org syntax."
3601 ;; Build an Org timestamp string from TIME. ACTIVEP is
3602 ;; non-nil when time stamp is active. If WITH-TIME-P is
3603 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3604 ;; specify a time range in the timestamp. REPEAT-STRING is
3605 ;; the repeater string, if any.
3609 org-time-stamp-formats)
3610 time)))
3616 nil nil ts)))
3621 " "
3622 s
3624 ;; Return value.
3625 ts)))
3637 build-ts-string
3656 0
3664 "--"
3677 ;;;; Underline
3680 "Parse underline object at point, if any.
3682 When at an underline object, return a list whose car is
3683 `underline' and cdr is a plist with `:begin', `:end',
3684 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3685 Otherwise, return nil.
3687 Assume point is at the first underscore marker."
3699 :end end
3700 :contents-begin contents-begin
3701 :contents-end contents-end
3705 "Interpret underline object as Org syntax.
3706 CONTENTS is the contents of the object."
3710 ;;;; Verbatim
3713 "Parse verbatim object at point, if any.
3715 When at a verbatim object, return a list whose car is `verbatim'
3716 and cdr is a plist with `:value', `:begin', `:end' and
3717 `:post-blank' keywords. Otherwise, return nil.
3719 Assume point is at the first equal sign marker."
3730 :begin begin
3731 :end end
3735 "Interpret VERBATIM object as Org syntax."
3739 \f
3740 ;;; Parsing Element Starting At Point
3741 ;;
3742 ;; `org-element--current-element' is the core function of this section.
3743 ;; It returns the Lisp representation of the element starting at
3744 ;; point.
3745 ;;
3746 ;; `org-element--current-element' makes use of special modes. They
3747 ;; are activated for fixed element chaining (e.g., `plain-list' >
3748 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3749 ;; `section'). Special modes are: `first-section', `item',
3750 ;; `node-property', `section' and `table-row'.
3753 "Parse the element starting at point.
3755 Return value is a list like (TYPE PROPS) where TYPE is the type
3756 of the element and PROPS a plist of properties associated to the
3757 element.
3759 Possible types are defined in `org-element-all-elements'.
3761 LIMIT bounds the search.
3763 Optional argument GRANULARITY determines the depth of the
3764 recursion. Allowed values are `headline', `greater-element',
3765 `element', `object' or nil. When it is broader than `object' (or
3766 nil), secondary values will not be parsed, since they only
3767 contain objects.
3769 Optional argument MODE, when non-nil, can be either
3770 `first-section', `section', `planning', `item', `node-property'
3771 and `table-row'.
3773 If STRUCTURE isn't provided but MODE is set to `item', it will be
3774 computed.
3776 This function assumes point is always at the beginning of the
3777 element it has to parse."
3780 ;; Determine if parsing depth allows for secondary strings
3781 ;; parsing. It only applies to elements referenced in
3782 ;; `org-element-secondary-value-alist'.
3785 ;; Item.
3788 ;; Table Row.
3790 ;; Node Property.
3792 ;; Headline.
3795 ;; Sections (must be checked after headline).
3800 limit)))
3801 ;; Planning.
3806 ;; Property drawer.
3812 ;; When not at bol, point is at the beginning of an item or
3813 ;; a footnote definition: next item is always a paragraph.
3815 ;; Clock.
3817 ;; Inlinetask.
3820 ;; From there, elements can have affiliated keywords.
3823 ;; Jumping over affiliated keywords put point off-limits.
3824 ;; Parse them as regular keywords.
3828 ;; LaTeX Environment.
3831 ;; Drawer and Property Drawer.
3834 ;; Fixed Width
3837 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3838 ;; Keywords.
3856 limit
3857 affiliated))
3870 ;; Footnote Definition.
3873 ;; Horizontal Rule.
3876 ;; Diary Sexp.
3879 ;; Table.
3882 ;; List.
3885 limit affiliated
3887 ;; Default element: Paragraph.
3891 ;; Most elements can have affiliated keywords. When looking for an
3892 ;; element beginning, we want to move before them, as they belong to
3893 ;; that element, and, in the meantime, collect information they give
3894 ;; into appropriate properties. Hence the following function.
3897 "Collect affiliated keywords from point down to LIMIT.
3899 Return a list whose CAR is the position at the first of them and
3900 CDR a plist of keywords and values and move point to the
3901 beginning of the first line after them.
3903 As a special case, if element doesn't start at the beginning of
3904 the line (e.g., a paragraph starting an item), CAR is current
3905 position of point and CDR is nil."
3909 ;; RESTRICT is the list of objects allowed in parsed
3910 ;; keywords value.
3912 output)
3915 ;; Apply translation to RAW-KWD. From there, KWD is
3916 ;; the official keyword.
3918 org-element-keyword-translation-alist))
3919 raw-kwd))
3920 ;; Find main value for any keyword.
3926 ;; PARSEDP is non-nil when keyword should have its
3927 ;; value parsed.
3929 ;; If KWD is a dual keyword, find its secondary
3930 ;; value. Maybe parse it.
3939 ;; Attribute a property name to KWD.
3941 ;; Now set final shape for VALUE.
3947 nil restrict)))
3951 ;; Attributes can always appear on multiple lines.
3954 ;; Eventually store the new value in OUTPUT.
3956 ;; Move to next keyword.
3958 ;; If affiliated keywords are orphaned: move back to first one.
3959 ;; They will be parsed as a paragraph.
3961 ;; Return value.
3965 \f
3966 ;;; The Org Parser
3967 ;;
3968 ;; The two major functions here are `org-element-parse-buffer', which
3969 ;; parses Org syntax inside the current buffer, taking into account
3970 ;; region, narrowing, or even visibility if specified, and
3971 ;; `org-element-parse-secondary-string', which parses objects within
3972 ;; a given string.
3973 ;;
3974 ;; The (almost) almighty `org-element-map' allows applying a function
3975 ;; on elements or objects matching some type, and accumulating the
3976 ;; resulting values. In an export situation, it also skips unneeded
3977 ;; parts of the parse tree.
3980 "Recursively parse the buffer and return structure.
3981 If narrowing is in effect, only parse the visible part of the
3982 buffer.
3984 Optional argument GRANULARITY determines the depth of the
3985 recursion. It can be set to the following symbols:
3987 `headline' Only parse headlines.
3988 `greater-element' Don't recurse into greater elements except
3989 headlines and sections. Thus, elements
3990 parsed are the top-level ones.
3991 `element' Parse everything but objects and plain text.
3992 `object' Parse the complete buffer (default).
3994 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3995 elements.
3997 An element or object is represented as a list with the
3998 pattern (TYPE PROPERTIES CONTENTS), where :
4000 TYPE is a symbol describing the element or object. See
4001 `org-element-all-elements' and `org-element-all-objects' for an
4002 exhaustive list of such symbols. One can retrieve it with
4003 `org-element-type' function.
4005 PROPERTIES is the list of attributes attached to the element or
4006 object, as a plist. Although most of them are specific to the
4007 element or object type, all types share `:begin', `:end',
4008 `:post-blank' and `:parent' properties, which respectively
4009 refer to buffer position where the element or object starts,
4010 ends, the number of white spaces or blank lines after it, and
4011 the element or object containing it. Properties values can be
4012 obtained by using `org-element-property' function.
4014 CONTENTS is a list of elements, objects or raw strings
4015 contained in the current element or object, when applicable.
4016 One can access them with `org-element-contents' function.
4018 The Org buffer has `org-data' as type and nil as properties.
4019 `org-element-map' function can be used to find specific elements
4020 or objects within the parse tree.
4022 This function assumes that current major mode is `org-mode'."
4028 ;; Start in `first-section' mode so text before the first
4029 ;; headline belongs to a section.
4033 "Recursively parse objects in STRING and return structure.
4035 RESTRICTION is a symbol limiting the object types that will be
4036 looked after.
4038 Optional argument PARENT, when non-nil, is the element or object
4039 containing the secondary string. It is used to set correctly
4040 `:parent' property within the string.
4042 If STRING is the empty string or nil, return nil."
4059 "Map a function on selected elements or objects.
4061 DATA is a parse tree, an element, an object, a string, or a list
4062 of such constructs. TYPES is a symbol or list of symbols of
4063 elements or objects types (see `org-element-all-elements' and
4064 `org-element-all-objects' for a complete list of types). FUN is
4065 the function called on the matching element or object. It has to
4066 accept one argument: the element or object itself.
4068 When optional argument INFO is non-nil, it should be a plist
4069 holding export options. In that case, parts of the parse tree
4070 not exportable according to that property list will be skipped.
4072 When optional argument FIRST-MATCH is non-nil, stop at the first
4073 match for which FUN doesn't return nil, and return that value.
4075 Optional argument NO-RECURSION is a symbol or a list of symbols
4076 representing elements or objects types. `org-element-map' won't
4077 enter any recursive element or object whose type belongs to that
4078 list. Though, FUN can still be applied on them.
4080 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4081 apply to matching objects within parsed affiliated keywords (see
4082 `org-element-parsed-keywords').
4084 Nil values returned from FUN do not appear in the results.
4087 Examples:
4088 ---------
4090 Assuming TREE is a variable containing an Org buffer parse tree,
4091 the following example will return a flat list of all `src-block'
4092 and `example-block' elements in it:
4096 The following snippet will find the first headline with a level
4100 (lambda (hl)
4101 (and (= (org-element-property :level hl) 1)
4103 (org-element-property :begin hl)))
4104 nil t)
4106 The next example will return a flat list of all `plain-list' type
4107 elements in TREE that are not a sub-list themselves:
4111 Eventually, this example will return a flat list of all `bold'
4112 type objects containing a `latex-snippet' type object, even
4113 looking into captions:
4116 (lambda (b)
4118 nil nil nil t)"
4119 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4123 ;; Recursion depth is determined by --CATEGORY.
4130 ;; If one object is found, the function has
4131 ;; to recurse into every object.
4134 ;; If one regular element is found, the
4135 ;; function has to recurse, at least, into
4136 ;; every element it encounters.
4139 --acc)
4142 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4143 ;; holding contextual information.
4147 ;; Ignored element in an export context.
4149 ;; List of elements or objects.
4151 ;; Unconditionally enter parse trees.
4155 ;; Check if TYPE is matching among TYPES. If so,
4156 ;; apply FUN to --DATA and accumulate return value
4157 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4163 ;; If --DATA has a secondary string that can contain
4164 ;; objects with their type among TYPES, look inside.
4167 org-element-secondary-value-alist)))
4169 ;; If --DATA has any parsed affiliated keywords and
4170 ;; WITH-AFFILIATED is non-nil, look for objects in
4171 ;; them.
4178 ;; Pay attention to the type of parsed
4179 ;; keyword. In particular, preserve order for
4180 ;; multiple keywords.
4193 ;; Determine if a recursion into --DATA is possible.
4195 ;; --TYPE is explicitly removed from recursion.
4197 ;; --DATA has no contents.
4199 ;; Looking for greater elements but --DATA is
4200 ;; simply an element or an object.
4203 ;; Looking for elements but --DATA is an object.
4206 ;; In any other case, map contents.
4210 ;; Return value in a proper order.
4214 ;; The following functions are internal parts of the parser.
4215 ;;
4216 ;; The first one, `org-element--parse-elements' acts at the element's
4217 ;; level.
4218 ;;
4219 ;; The second one, `org-element--parse-objects' applies on all objects
4220 ;; of a paragraph or a secondary string. It calls
4221 ;; `org-element--object-lex' to find the next object in the current
4222 ;; container.
4225 "Return next special mode according to TYPE, or nil.
4226 TYPE is a symbol representing the type of an element or object
4227 containing next element if PARENTP is non-nil, or before it
4228 otherwise. Modes can be either `first-section', `item',
4229 `node-property', `planning', `property-drawer', `section',
4230 `table-row' or nil."
4247 "Parse elements between BEG and END positions.
4249 MODE prioritizes some elements over the others. It can be set to
4250 `first-section', `section', `planning', `item', `node-property'
4251 or `table-row'.
4253 When value is `item', STRUCTURE will be used as the current list
4254 structure.
4256 GRANULARITY determines the depth of the recursion. See
4257 `org-element-parse-buffer' for more information.
4259 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4260 elements.
4262 Elements are accumulated into ACC."
4265 ;; Visible only: skip invisible parts at the beginning of the
4266 ;; element.
4269 ;; When parsing only headlines, skip any text before first one.
4274 ;; Find current element's type and parse it accordingly to
4275 ;; its category.
4277 end granularity mode structure))
4281 ;; Visible only: skip invisible parts between siblings.
4284 ;; Fill ELEMENT contents by side-effect.
4286 ;; If element has no contents, don't modify it.
4288 ;; Greater element: parse it between `contents-begin' and
4289 ;; `contents-end'. Make sure GRANULARITY allows the
4290 ;; recursion, or ELEMENT is a headline, in which case going
4291 ;; inside is mandatory, in order to get sub-level headings.
4299 ;; Possibly switch to a special mode.
4303 granularity visible-only element))
4304 ;; ELEMENT has contents. Parse objects inside, if
4305 ;; GRANULARITY allows it.
4311 ;; Update mode.
4313 ;; Return result.
4317 "Return next object in current buffer or nil.
4318 RESTRICTION is a list of object types, as symbols, that should be
4319 looked after. This function assumes that the buffer is narrowed
4320 to an appropriate container (e.g., a paragraph)."
4324 ;; Object regexp sometimes needs to have a peek at
4325 ;; a character ahead. Therefore, when there is a hard
4326 ;; limit, make it one more than the true beginning of the
4327 ;; radio target.
4334 nil)
4335 ;; Since we moved backward, we do not want to
4336 ;; match again an hypothetical 1-character long
4337 ;; radio link before us. Realizing that this can
4338 ;; only happen if such a radio link starts at
4339 ;; beginning of line, we prevent this here.
4345 found)
4411 ;; This is probably a plain link.
4421 "Parse objects between BEG and END and return recursive structure.
4423 Objects are accumulated in ACC. RESTRICTION is a list of object
4424 successors which are allowed in the current object.
4426 ACC becomes the parent for all parsed objects. However, if ACC
4427 is nil (i.e., a secondary string is being parsed) and optional
4428 argument PARENT is non-nil, use it as the parent for all objects.
4429 Eventually, if both ACC and PARENT are nil, the common parent is
4430 the list of objects itself."
4438 ;; Text before any object.
4443 contents))))
4444 ;; Object...
4449 ;; Fill contents of NEXT-OBJECT if possible.
4451 cont-beg
4453 next-object
4455 next-object)
4456 contents)
4458 ;; Text after last object.
4462 contents)))
4463 ;; Result. Set appropriate parent.
4471 \f
4472 ;;; Towards A Bijective Process
4473 ;;
4474 ;; The parse tree obtained with `org-element-parse-buffer' is really
4475 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4476 ;; interpreted and expanded into a string with canonical Org syntax.
4477 ;; Hence `org-element-interpret-data'.
4478 ;;
4479 ;; The function relies internally on
4480 ;; `org-element--interpret-affiliated-keywords'.
4482 ;;;###autoload
4484 "Interpret DATA as Org syntax.
4485 DATA is a parse tree, an element, an object or a secondary string
4486 to interpret. Return Org syntax as a string."
4490 ;; Find interpreter for current object or
4491 ;; element. If it doesn't exist (e.g. this is
4492 ;; a pseudo object or element), return contents,
4493 ;; if any.
4500 ;; Secondary string.
4503 data
4505 ;; Full Org document.
4510 ;; Plain text: return it.
4512 ;; Element or object without contents.
4515 ;; Element or object with contents.
4518 interpret
4519 data
4520 ;; Recursively interpret contents.
4525 data
4526 ;; Fix indentation of elements containing
4527 ;; objects. We ignore `table-row'
4528 ;; elements as they are one line long
4529 ;; anyway.
4531 data
4532 ;; When normalizing first paragraph of
4533 ;; an item or a footnote-definition,
4534 ;; ignore first line's indentation.
4542 ;; Build white spaces. If no `:post-blank' property
4543 ;; is specified, assume its value is 0.
4553 "Return ELEMENT's affiliated keywords as Org syntax.
4554 If there is no affiliated keyword, return the empty string."
4564 ": "
4567 value)
4575 ;; All attribute keywords can have multiple lines.
4581 ;; List all ELEMENT's properties matching an attribute line or an
4582 ;; affiliated keyword, but ignore translated keywords since they
4583 ;; cannot belong to the property list.
4590 org-element-keyword-translation-alist)))))
4591 collect prop)
4594 ;; Because interpretation of the parse tree must return the same
4595 ;; number of blank lines between elements and the same number of white
4596 ;; space after objects, some special care must be given to white
4597 ;; spaces.
4598 ;;
4599 ;; The first function, `org-element-normalize-string', ensures any
4600 ;; string different from the empty string will end with a single
4601 ;; newline character.
4602 ;;
4603 ;; The second function, `org-element-normalize-contents', removes
4604 ;; global indentation from the contents of the current element.
4607 "Ensure string S ends with a single newline character.
4609 If S isn't a string return it unchanged. If S is the empty
4610 string, return it. Otherwise, return a new string with a single
4611 newline character at its end."
4619 "Normalize plain text in ELEMENT's contents.
4621 ELEMENT must only contain plain text and objects.
4623 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4624 indentation to compute maximal common indentation.
4626 Return the normalized element that is element with global
4627 indentation removed from its contents."
4629 ;; Return minimal common indentation within BLOB. This is
4630 ;; done by walking recursively BLOB and updating MIN-IND
4631 ;; along the way. FIRST-FLAG is non-nil when the next
4632 ;; object is expected to be a string that doesn't start
4633 ;; with a newline character. It happens for strings at
4634 ;; the beginnings of the contents or right after a line
4635 ;; break.
4641 ;; Objects cannot start with spaces: in this
4642 ;; case, indentation is 0.
4683 ;; Build ELEMENT back, replacing each string with the same
4684 ;; string minus common indentation.
4687 ;; Return DATUM with all its strings indentation
4688 ;; shortened from MIN-IND white spaces.
4708 org-element-recursive-objects)
4712 datum)))
4716 \f
4717 ;;; Cache
4718 ;;
4719 ;; Implement a caching mechanism for `org-element-at-point' and
4720 ;; `org-element-context', which see.
4721 ;;
4722 ;; A single public function is provided: `org-element-cache-reset'.
4723 ;;
4724 ;; Cache is enabled by default, but can be disabled globally with
4725 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4726 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4727 ;; can be tweaked to control caching behaviour.
4728 ;;
4729 ;; Internally, parsed elements are stored in an AVL tree,
4730 ;; `org-element--cache'. This tree is updated lazily: whenever
4731 ;; a change happens to the buffer, a synchronization request is
4732 ;; registered in `org-element--cache-sync-requests' (see
4733 ;; `org-element--cache-submit-request'). During idle time, requests
4734 ;; are processed by `org-element--cache-sync'. Synchronization also
4735 ;; happens when an element is required from the cache. In this case,
4736 ;; the process stops as soon as the needed element is up-to-date.
4737 ;;
4738 ;; A synchronization request can only apply on a synchronized part of
4739 ;; the cache. Therefore, the cache is updated at least to the
4740 ;; location where the new request applies. Thus, requests are ordered
4741 ;; from left to right and all elements starting before the first
4742 ;; request are correct. This property is used by functions like
4743 ;; `org-element--cache-find' to retrieve elements in the part of the
4744 ;; cache that can be trusted.
4745 ;;
4746 ;; A request applies to every element, starting from its original
4747 ;; location (or key, see below). When a request is processed, it
4748 ;; moves forward and may collide the next one. In this case, both
4749 ;; requests are merged into a new one that starts from that element.
4750 ;; As a consequence, the whole synchronization complexity does not
4751 ;; depend on the number of pending requests, but on the number of
4752 ;; elements the very first request will be applied on.
4753 ;;
4754 ;; Elements cannot be accessed through their beginning position, which
4755 ;; may or may not be up-to-date. Instead, each element in the tree is
4756 ;; associated to a key, obtained with `org-element--cache-key'. This
4757 ;; mechanism is robust enough to preserve total order among elements
4758 ;; even when the tree is only partially synchronized.
4762 "Non-nil when Org parser should cache its results.
4764 WARNING: for the time being, using cache sometimes triggers
4765 freezes. Therefore, it is disabled by default. Activate it if
4772 "Maximum duration, as a time value, for a cache synchronization.
4773 If the synchronization is not over after this delay, the process
4774 pauses and resumes after `org-element-cache-sync-break'
4778 "Duration, as a time value, of the pause between synchronizations.
4782 ;;;; Data Structure
4785 "AVL tree used to cache elements.
4786 Each node of the tree contains an element. Comparison is done
4787 with `org-element--cache-compare'. This cache is used in
4791 "List of pending synchronization requests.
4793 A request is a vector with the following pattern:
4795 \[NEXT BEG END OFFSET PARENT PHASE]
4797 Processing a synchronization request consists of three phases:
4799 0. Delete modified elements,
4800 1. Fill missing area in cache,
4801 2. Shift positions and re-parent elements after the changes.
4803 During phase 0, NEXT is the key of the first element to be
4804 removed, BEG and END is buffer position delimiting the
4805 modifications. Elements starting between them (inclusive) are
4806 removed. So are elements whose parent is removed. PARENT, when
4807 non-nil, is the parent of the first element to be removed.
4809 During phase 1, NEXT is the key of the next known element in
4810 cache and BEG its beginning position. Parse buffer between that
4811 element and the one before it in order to determine the parent of
4812 the next element. Set PARENT to the element containing NEXT.
4814 During phase 2, NEXT is the key of the next element to shift in
4815 the parse tree. All elements starting from this one have their
4816 properties relatives to buffer positions shifted by integer
4817 OFFSET and, if they belong to element PARENT, are adopted by it.
4825 "Hash table used to store keys during synchronization.
4829 "Return a unique key for ELEMENT in cache tree.
4831 Keys are used to keep a total order among elements in the cache.
4832 Comparison is done with `org-element--cache-key-less-p'.
4834 When no synchronization is taking place, a key is simply the
4835 beginning position of the element, or that position plus one in
4836 the case of an first item (respectively row) in
4837 a list (respectively a table).
4839 During a synchronization, the key is the one the element had when
4840 the cache was synchronized for the last time. Elements added to
4841 cache during the synchronization get a new key generated with
4842 `org-element--cache-generate-key'.
4844 Such keys are stored in `org-element--cache-sync-keys'. The hash
4845 table is cleared once the synchronization is complete."
4848 ;; Increase beginning position of items (respectively
4849 ;; table rows) by one, so the first item can get
4850 ;; a different key from its parent list (respectively
4851 ;; table).
4854 begin)))
4857 key))))
4860 "Generate a key between LOWER and UPPER.
4862 LOWER and UPPER are integers or lists, possibly empty.
4864 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4865 a unique key, as an integer or a list of integers, according to
4866 the following rules:
4868 - LOWER and UPPER are compared level-wise until values differ.
4870 - If, at a given level, LOWER and UPPER differ from more than
4871 2, the new key shares all the levels above with LOWER and
4872 gets a new level. Its value is the mean between LOWER and
4873 UPPER:
4875 (1 2) + (1 4) --> (1 3)
4877 - If LOWER has no value to compare with, it is assumed that its
4878 value is `most-negative-fixnum'. E.g.,
4880 (1 1) + (1 1 2)
4882 is equivalent to
4884 (1 1 m) + (1 1 2)
4886 where m is `most-negative-fixnum'. Likewise, if UPPER is
4887 short of levels, the current value is `most-positive-fixnum'.
4889 - If they differ from only one, the new key inherits from
4890 current LOWER level and fork it at the next level. E.g.,
4892 (2 1) + (3 3)
4894 is equivalent to
4896 (2 1) + (2 M)
4898 where M is `most-positive-fixnum'.
4900 - If the key is only one level long, it is returned as an
4901 integer:
4903 (1 2) + (3 2) --> 2
4905 When they are not equals, the function assumes that LOWER is
4906 lesser than UPPER, per `org-element--cache-key-less-p'."
4910 skip-upper key)
4921 ;; When at a given level, LOWER and UPPER differ from
4922 ;; 1, ignore UPPER altogether. Instead create a key
4923 ;; between LOWER and the greatest key with the same
4924 ;; prefix as LOWER so far.
4930 "Non-nil if key A is less than key B.
4931 A and B are either integers or lists of integers, as returned by
4932 `org-element--cache-key'."
4940 ;; If A is empty, either keys are equal (B is also empty) and
4941 ;; we return nil, or A is lesser than B (B is longer) and we
4942 ;; return a non-nil value.
4943 ;;
4944 ;; If A is not empty, B is necessarily empty and A is greater
4945 ;; than B (A is longer). Therefore, return nil.
4949 "Non-nil when element A is located before element B."
4954 "Return root value in cache.
4955 This function assumes `org-element--cache' is a valid AVL tree."
4959 ;;;; Tools
4962 "Non-nil when cache is active in current buffer."
4964 org-element--cache
4968 "Find element in cache starting at POS or before.
4970 POS refers to a buffer position.
4972 When optional argument SIDE is non-nil, the function checks for
4973 elements starting at or past POS instead. If SIDE is `both', the
4974 function returns a cons cell where car is the first element
4975 starting at or before POS and cdr the first element starting
4976 after POS.
4978 The function can only find elements in the synchronized part of
4979 the cache."
4983 lower upper)
4998 ;; We found an element in cache starting at POS. If `side'
4999 ;; is `both' we also want the next one in order to generate
5000 ;; a key in-between.
5001 ;;
5002 ;; If the element is the first row or item in a table or
5003 ;; a plain list, we always return the table or the plain
5004 ;; list.
5005 ;;
5006 ;; In any other case, we return the element found.
5015 lower parent
5016 upper parent)))))
5019 lower element
5020 upper element)))))
5027 "Store ELEMENT in current buffer's cache, if allowed."
5030 ;; During synchronization, first build an appropriate key for
5031 ;; the new element so `avl-tree-enter' can insert it at the
5032 ;; right spot in the cache.
5041 org-element--cache-sync-keys)))
5045 "Remove ELEMENT from cache.
5046 Assume ELEMENT belongs to cache and that a cache is active."
5050 ;;;; Synchronization
5053 "Set idle timer for cache synchronization in BUFFER."
5060 org-element-cache-sync-idle-time))
5061 nil
5062 #'org-element--cache-sync
5063 buffer)))
5066 "Non-nil when synchronization process should be interrupted.
5067 TIME-LIMIT is a time value or nil."
5073 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5075 Properties containing buffer positions are `:begin', `:end',
5076 `:contents-begin', `:contents-end' and `:structure'. When
5077 optional argument PROPS is a list of keywords, only shift
5078 properties provided in that list.
5080 Properties are modified by side-effect."
5082 ;; Shift `:structure' property for the first plain list only: it
5083 ;; is the only one that really matters and it prevents from
5084 ;; shifting it more than once.
5098 "Synchronize cache with recent modification in BUFFER.
5100 When optional argument THRESHOLD is non-nil, do the
5101 synchronization for all elements starting before or at threshold,
5102 then exit. Otherwise, synchronize cache for as long as
5103 `org-element-cache-sync-duration' or until Emacs leaves idle
5104 state.
5106 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5107 not registered yet in the cache are going to happen. It is used
5108 in `org-element--cache-submit-request', where cache is partially
5109 updated before current modification are actually submitted."
5120 request
5122 threshold
5125 org-element-cache-sync-duration))
5126 future-change)
5127 ;; Request processed. Merge current and next offsets and
5128 ;; transfer ending position.
5134 ;; If more requests are awaiting, set idle timer accordingly.
5135 ;; Otherwise, reset keys.
5142 "Process synchronization REQUEST for all entries before NEXT.
5144 REQUEST is a vector, built by `org-element--cache-submit-request'.
5146 NEXT is a cache key, as returned by `org-element--cache-key'.
5148 When non-nil, THRESHOLD is a buffer position. Synchronization
5149 stops as soon as a shifted element begins after it.
5151 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5152 after this time or when Emacs exits idle state.
5154 When non-nil, FUTURE-CHANGE is a buffer position where changes
5155 not registered yet in the cache are going to happen. See
5156 `org-element--cache-submit-request' for more information.
5158 Throw `interrupt' if the process stops before completing the
5159 request."
5162 ;; Phase 0.
5163 ;;
5164 ;; Delete all elements starting after BEG, but not after buffer
5165 ;; position END or past element with key NEXT. Also delete
5166 ;; elements contained within a previously removed element
5167 ;; (stored in `last-container').
5168 ;;
5169 ;; At each iteration, we start again at tree root since
5170 ;; a deletion modifies structure of the balanced tree.
5175 ;; Find first element in cache with key BEG or after it.
5179 data data-key last-container)
5188 data-key key
5191 data-key key
5192 node nil)))))
5202 up)))
5205 end))
5212 ;; No element starting after modifications left in
5213 ;; cache: further processing is futile.
5216 ;; Phase 1.
5217 ;;
5218 ;; Phase 0 left a hole in the cache. Some elements after it
5219 ;; could have parents within. For example, in the following
5220 ;; buffer:
5221 ;;
5222 ;; - item
5223 ;;
5224 ;;
5225 ;; Paragraph1
5226 ;;
5227 ;; Paragraph2
5228 ;;
5229 ;; if we remove a blank line between "item" and "Paragraph1",
5230 ;; everything down to "Paragraph2" is removed from cache. But
5231 ;; the paragraph now belongs to the list, and its `:parent'
5232 ;; property no longer is accurate.
5233 ;;
5234 ;; Therefore we need to parse again elements in the hole, or at
5235 ;; least in its last section, so that we can re-parent
5236 ;; subsequent elements, during phase 2.
5237 ;;
5238 ;; Note that we only need to get the parent from the first
5239 ;; element in cache after the hole.
5240 ;;
5241 ;; When next key is lesser or equal to the current one, delegate
5242 ;; phase 1 processing to next request in order to preserve key
5243 ;; order among requests.
5251 ;; Next element will start at its beginning position plus
5252 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5253 ;; contains the real beginning position of the first element to
5254 ;; shift and re-parent.
5258 ;; Changes are going to happen around this element and
5259 ;; they will trigger another phase 1 request. Skip the
5260 ;; current one.
5266 ;; Phase 2.
5267 ;;
5268 ;; Shift all elements starting from key START, but before NEXT, by
5269 ;; OFFSET, and re-parent them when appropriate.
5270 ;;
5271 ;; Elements are modified by side-effect so the tree structure
5272 ;; remains intact.
5273 ;;
5274 ;; Once THRESHOLD, if any, is reached, or once there is an input
5275 ;; pending, exit. Before leaving, the current synchronization
5276 ;; request is updated.
5283 exit-flag)
5284 ;; No re-parenting nor shifting planned: request is over.
5294 ;; We reached NEXT. Request is complete.
5296 ;; Handle interruption request. Update current request.
5301 ;; Shift element.
5305 ;; Update PARENT and re-parent DATA, only when
5306 ;; necessary. Propagate new structures for lists.
5320 ;; Cache is up-to-date past THRESHOLD. Request
5321 ;; interruption.
5326 ;; We reached end of tree: synchronization complete.
5327 t)))
5330 "Parse elements in current section, down to POS.
5332 Start parsing from the closest between the last known element in
5333 cache or headline above. Return the smallest element containing
5334 POS.
5336 When optional argument SYNCP is non-nil, return the parent of the
5337 element containing POS instead. In that case, it is also
5338 possible to provide TIME-LIMIT, which is a time value specifying
5339 when the parsing should stop. The function throws `interrupt' if
5340 the process stopped before finding the expected result."
5347 element next mode)
5349 ;; Nothing in cache before point: start parsing from first
5350 ;; element following headline above, or first element in
5351 ;; buffer.
5358 ;; Cache returned exact match: return it.
5361 ;; There's a headline between cached value and POS: cached
5362 ;; value is invalid. Start parsing from first element
5363 ;; following the headline.
5370 ;; Check if CACHED or any of its ancestors contain point.
5371 ;;
5372 ;; If there is such an element, we inspect it in order to know
5373 ;; if we return it or if we need to parse its contents.
5374 ;; Otherwise, we just start parsing from current location,
5375 ;; which is right after the top-most element containing
5376 ;; CACHED.
5377 ;;
5378 ;; As a special case, if POS is at the end of the buffer, we
5379 ;; want to return the innermost element ending there.
5380 ;;
5381 ;; Also, if we find an ancestor and discover that we need to
5382 ;; parse its contents, make sure we don't start from
5383 ;; `:contents-begin', as we would otherwise go past CACHED
5384 ;; again. Instead, in that situation, we will resume parsing
5385 ;; from NEXT, which is located after CACHED or its higher
5386 ;; ancestor not containing point.
5398 ;; Parse successively each element until we reach POS.
5411 end 'element mode
5418 ;; Skip any element ending before point. Also skip
5419 ;; element ending at point (unless it is also the end of
5420 ;; buffer) since we're sure that another element begins
5421 ;; after it.
5425 ;; A non-greater element contains point: return it.
5428 ;; Otherwise, we have to decide if ELEMENT really
5429 ;; contains POS. In that case we start parsing from
5430 ;; contents' beginning.
5431 ;;
5432 ;; If POS is at contents' beginning but it is also at
5433 ;; the beginning of the first item in a list or a table.
5434 ;; In that case, we need to create an anchor for that
5435 ;; list or table, so return it.
5436 ;;
5437 ;; Also, if POS is at the end of the buffer, no element
5438 ;; can start after it, but more than one may end there.
5439 ;; Arbitrarily, we choose to return the innermost of
5440 ;; such elements.
5453 parent element
5454 end cend))))
5455 ;; Otherwise, return ELEMENT as it is the smallest
5456 ;; element containing POS.
5461 ;;;; Staging Buffer Changes
5472 "Regexp matching a sensitive line, structure wise.
5473 A sensitive line is a headline, inlinetask, block, drawer, or
5474 latex-environment boundary. When such a line is modified,
5475 structure changes in the document may propagate in the whole
5479 "Non-nil when a sensitive line is about to be changed.
5483 "Request extension of area going to be modified if needed.
5484 BEG and END are the beginning and end of the range of changed
5485 text. See `before-change-functions' for more information."
5495 'headline
5498 org-element--cache-sensitive-re bottom t)))))))))
5501 "Update buffer modifications for current buffer.
5502 BEG and END are the beginning and end of the range of changed
5503 text, and the length in bytes of the pre-change text replaced by
5504 that range. See `after-change-functions' for more information."
5512 ;; Determine if modified area needs to be extended, according
5513 ;; to both previous and current state. We make a special
5514 ;; case for headline editing: if a headline is modified but
5515 ;; not removed, do not extend.
5518 (`headline
5524 org-element--cache-sensitive-re bottom t))))
5525 ;; Effectively extend modified area.
5533 ;; Store synchronization request.
5536 ;; Activate a timer to process the request during idle time.
5540 "Return first element to remove from cache.
5542 BEG and END are buffer positions delimiting buffer modifications.
5543 OFFSET is the size of the changes.
5545 Returned element is usually the first element in cache containing
5546 any position between BEG and END. As an exception, greater
5547 elements around the changes that are robust to contents
5548 modifications are preserved and updated according to the
5549 changes."
5559 special-block))
5560 ;; Drawers named "PROPERTIES" are probably
5561 ;; a properties drawer being edited. Force
5562 ;; parsing to check if editing is over.
5571 ;; UP is a robust greater element containing changes.
5572 ;; We only need to extend its ending boundaries.
5578 ;; We're at top level element containing ELEMENT: if it's
5579 ;; altered by buffer modifications, it is first element in
5580 ;; cache to be removed. Otherwise, that first element is the
5581 ;; following one.
5582 ;;
5583 ;; As a special case, do not remove BEFORE if it is a robust
5584 ;; container for current changes.
5586 before)))))
5589 "Submit a new cache synchronization request for current buffer.
5590 BEG and END are buffer positions delimiting the minimal area
5591 where cache data should be removed. OFFSET is the size of the
5592 change, as an integer."
5594 delete-to delete-from)
5599 ;; Current changes can be merged with first sync request: we
5600 ;; can save a partial cache synchronization.
5603 ;; If last change happened within area to be removed, extend
5604 ;; boundaries of robust parents, if any. Otherwise, find
5605 ;; first element to remove and update request accordingly.
5617 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5618 ;; if any, is no longer a 0-phase request, thus ensuring that
5619 ;; phases are properly ordered. We need to provide OFFSET as
5620 ;; optional parameter since current modifications are not known
5621 ;; yet to the otherwise correct part of the cache (i.e, before
5622 ;; the first request).
5629 ;; When changes happen before the first known
5630 ;; element, re-parent and shift the rest of the
5631 ;; cache.
5633 ;; Otherwise, we find the first non robust
5634 ;; element containing END. All elements between
5635 ;; FIRST and this one are to be removed.
5646 element up))
5648 org-element--cache-sync-requests)
5649 ;; No element to remove. No need to re-parent either.
5650 ;; Simply shift additional elements, if any, by OFFSET.
5653 offset)))))))
5656 ;;;; Public Functions
5658 ;;;###autoload
5660 "Reset cache in current buffer.
5661 When optional argument ALL is non-nil, reset cache in all Org
5662 buffers."
5679 ;;;###autoload
5681 "Refresh cache at position POS."
5688 \f
5689 ;;; The Toolbox
5690 ;;
5691 ;; The first move is to implement a way to obtain the smallest element
5692 ;; containing point. This is the job of `org-element-at-point'. It
5693 ;; basically jumps back to the beginning of section containing point
5694 ;; and proceed, one element after the other, with
5695 ;; `org-element--current-element' until the container is found. Note:
5696 ;; When using `org-element-at-point', secondary values are never
5697 ;; parsed since the function focuses on elements, not on objects.
5698 ;;
5699 ;; At a deeper level, `org-element-context' lists all elements and
5700 ;; objects containing point.
5701 ;;
5702 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5703 ;; internally by navigation and manipulation tools.
5706 ;;;###autoload
5708 "Determine closest element around point.
5710 Return value is a list like (TYPE PROPS) where TYPE is the type
5711 of the element and PROPS a plist of properties associated to the
5712 element.
5714 Possible types are defined in `org-element-all-elements'.
5715 Properties depend on element or object type, but always include
5716 `:begin', `:end', `:parent' and `:post-blank' properties.
5718 As a special case, if point is at the very beginning of the first
5719 item in a list or sub-list, returned element will be that list
5720 instead of the item. Likewise, if point is at the beginning of
5721 the first row of a table, returned element will be the table
5722 instead of the first row.
5724 When point is at the end of the buffer, return the innermost
5725 element ending there."
5731 ;; Within blank lines at the beginning of buffer, return nil.
5733 ;; Within blank lines right after a headline, return that
5734 ;; headline.
5738 ;; Otherwise parse until we find element containing ORIGIN.
5745 ;;;###autoload
5747 "Return smallest element or object around point.
5749 Return value is a list like (TYPE PROPS) where TYPE is the type
5750 of the element or object and PROPS a plist of properties
5751 associated to it.
5753 Possible types are defined in `org-element-all-elements' and
5754 `org-element-all-objects'. Properties depend on element or
5755 object type, but always include `:begin', `:end', `:parent' and
5756 `:post-blank'.
5758 As a special case, if point is right after an object and not at
5759 the beginning of any other object, return that object.
5761 Optional argument ELEMENT, when non-nil, is the closest element
5762 containing point, as returned by `org-element-at-point'.
5763 Providing it allows for quicker computation."
5770 ;; If point is inside an element containing objects or
5771 ;; a secondary string, narrow buffer to the container and
5772 ;; proceed with parsing. Otherwise, return ELEMENT.
5774 ;; At a parsed affiliated keyword, check if we're inside main
5775 ;; or dual value.
5781 org-element-parsed-keywords))
5790 ;; Also change type to retrieve correct restrictions.
5792 ;; At an item, objects can only be located within tag, if any.
5803 ;; At an headline or inlinetask, objects are in title.
5815 ;; At a paragraph, a table-row or a verse block, objects are
5816 ;; located within their contents.
5820 ;; CBEG is nil for table rules.
5829 last)
5834 ;; Process NEXT, if any, in order to know if we need to
5835 ;; skip it, return it or move into it.
5842 ;; Skip objects ending before point. Also skip
5843 ;; objects ending at point unless it is also the
5844 ;; end of buffer, since we want to return the
5845 ;; innermost object.
5848 ;; For convenience, when object ends at POS,
5849 ;; without any space, store it in LAST, as we
5850 ;; will return it if no object starts here.
5854 ;; If POS is within a container object, move into
5855 ;; that object.
5859 ;; At contents' end, if there is no
5860 ;; space before point, also move into
5861 ;; object, for consistency with
5862 ;; convenience feature above.
5871 ;; Otherwise, return NEXT.
5875 "List all ancestors of a given element or object.
5877 BLOB is an object or element.
5879 When optional argument TYPES is a list of symbols, return the
5880 first element or object in the lineage whose type belongs to that
5881 list.
5883 When optional argument WITH-SELF is non-nil, lineage includes
5884 BLOB itself as the first element, and TYPES, if provided, also
5885 apply to it.
5887 When BLOB is obtained through `org-element-context' or
5888 `org-element-at-point', only ancestors from its section can be
5889 found. There is no such limitation when BLOB belongs to a full
5890 parse tree."
5892 ancestors)
5899 "Non-nil when elements ELEM-A and ELEM-B are nested."
5908 "Swap elements ELEM-A and ELEM-B.
5909 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5910 end of ELEM-A."
5912 ;; There are two special cases when an element doesn't start at bol:
5913 ;; the first paragraph in an item or in a footnote definition.
5915 ;; Only a paragraph without any affiliated keyword can be moved at
5916 ;; ELEM-A position in such a situation. Note that the case of
5917 ;; a footnote definition is impossible: it cannot contain two
5918 ;; paragraphs in a row because it cannot contain a blank line.
5924 ;; In a special situation, ELEM-A will have no indentation. We'll
5925 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5939 ;; Store inner overlays responsible for visibility status.
5940 ;; We also need to store their boundaries as they will be
5941 ;; removed from buffer.
5956 ;; Get contents.
5964 ;; Restore ex ELEM-A overlays.
5971 ;; Restore ex ELEM-B overlays.
5979 ;; Local variables:
5980 ;; generated-autoload-file: "org-loaddefs.el"
5981 ;; End:
5983 ;;; org-element.el ends here