| blob | 3c8d7a737702f66aae684ca6092d335c136e01c7 |
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', `:pre-blank',`:post-blank' and
816 `:post-affiliated' keywords.
818 Assume point is at the beginning of the footnote definition."
830 limit)
832 ;; At a new footnote definition, make sure we end
833 ;; before any affiliated keyword above.
859 :begin begin
860 :end end
861 :contents-begin contents-begin
863 :pre-blank pre-blank
869 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
870 CONTENTS is the contents of the footnote-definition."
873 ;; 0 is specific to paragraphs at the beginning of
874 ;; the footnote definition, so we use 1 as
875 ;; a fall-back value, which is more universal.
877 ;; Footnote ends after more than two consecutive empty
878 ;; lines: limit ourselves to 2 newline characters.
885 ;;;; Headline
888 "Return node properties associated to headline at point.
889 Upcase property names. It avoids confusion between properties
890 obtained through property drawer and default properties from the
891 parser (e.g. `:end' and :END:). Return value is a plist."
903 properties))))
906 "Return time properties associated to headline at point.
907 Return value is a plist."
921 plist))))
924 "Parse a headline.
926 Return a list whose CAR is `headline' and CDR is a plist
927 containing `:raw-value', `:title', `:begin', `:end',
928 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
929 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
930 `:deadline', `:closed', `:archivedp', `:commentedp'
931 `:footnote-section-p', `:post-blank' and `:post-affiliated'
932 keywords.
934 The plist also contains any property set in the property drawer,
935 with its name in upper cases and colons added at the
936 beginning (e.g., `:CUSTOM_ID').
938 LIMIT is a buffer position bounding the search.
940 When RAW-SECONDARY-P is non-nil, headline's title will not be
941 parsed as a secondary string, but as a plain string instead.
943 Assume point is at beginning of the headline."
989 :begin begin
990 :end end
991 :pre-blank
994 :contents-begin contents-begin
995 :contents-end contents-end
996 :level level
997 :priority priority
998 :tags tags
999 :todo-keyword todo
1000 :todo-type todo-type
1001 :post-blank
1005 :footnote-section-p footnote-section-p
1006 :archivedp archivedp
1007 :commentedp commentedp
1009 time-props
1010 standard-props))))
1012 headline :title
1021 nil
1023 headline)))))))
1026 "Interpret HEADLINE element as Org syntax.
1027 CONTENTS is the contents of the element."
1040 ?*)
1044 " "
1047 org-footnote-section
1048 title))))
1050 heading
1051 ;; Align tags.
1059 ?\s)
1060 tags))
1064 tags))))
1066 contents)))
1069 ;;;; Inlinetask
1072 "Parse an inline task.
1074 Return a list whose CAR is `inlinetask' and CDR is a plist
1075 containing `:title', `:begin', `:end', `:pre-blank',
1076 `:contents-begin' and `:contents-end', `:level', `:priority',
1077 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
1078 `:scheduled', `:deadline', `:closed', `:post-blank' and
1079 `:post-affiliated' keywords.
1081 The plist also contains any property set in the property drawer,
1082 with its name in upper cases and colons added at the
1083 beginning (e.g., `:CUSTOM_ID').
1085 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1086 title will not be parsed as a secondary string, but as a plain
1087 string instead.
1089 Assume point is at beginning of the inline task."
1136 :begin begin
1137 :end end
1138 :pre-blank
1141 :contents-begin contents-begin
1142 :contents-end contents-end
1143 :level level
1144 :priority priority
1145 :tags tags
1146 :todo-keyword todo
1147 :todo-type todo-type
1150 time-props
1151 standard-props))))
1153 inlinetask :title
1162 nil
1164 inlinetask))))))
1167 "Interpret INLINETASK element as Org syntax.
1168 CONTENTS is the contents of inlinetask."
1182 ;; Align tags.
1190 ? )
1191 tags))
1195 tags))))
1196 ;; Prefer degenerate inlinetasks when there are no
1197 ;; contents.
1200 contents
1204 ;;;; Item
1207 "Parse an item.
1209 STRUCT is the structure of the plain list.
1211 Return a list whose CAR is `item' and CDR is a plist containing
1212 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1213 `:checkbox', `:counter', `:tag', `:structure', `:pre-blank',
1214 `:post-blank' and `:post-affiliated' keywords.
1216 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1217 any, will not be parsed as a secondary string, but as a plain
1218 string instead.
1220 Assume point is at the beginning of the item."
1245 ;; Ignore tags in un-ordered lists: they are just
1246 ;; a part of item's body.
1253 ;; If first line isn't empty, contents really
1254 ;; start at the text after item's meta-data.
1267 :begin begin
1268 :end end
1269 :contents-begin contents-begin
1270 :contents-end contents-end
1271 :checkbox checkbox
1272 :counter counter
1273 :structure struct
1274 :pre-blank pre-blank
1278 item :tag
1285 item))))))))
1288 "Interpret ITEM element as Org syntax.
1289 CONTENTS is the contents of the element."
1301 ;; 0 is specific to paragraphs at the beginning of
1302 ;; the item, so we use 1 as a fall-back value,
1303 ;; which is more universal.
1305 ;; Lists ends after more than two consecutive empty
1306 ;; lines: limit ourselves to 2 newline characters.
1309 ;; Indent contents.
1325 ;;;; Plain List
1328 ;; Return structure of list at point. Internal function. See
1329 ;; `org-list-struct' for details.
1334 items struct)
1339 ;; At limit: end all items.
1345 ;; At list end: end all items.
1349 ;; At a new item: end previous sibling.
1361 ind
1362 bullet
1365 ;; Description tag.
1369 ;; Ending position, unknown so far.
1370 nil)))
1371 items))
1373 ;; Skip empty lines.
1375 ;; Skip inline tasks and blank lines along the way.
1382 ;; At some text line. Check if it ends any previous item.
1396 ;; Skip blocks (any type) and drawers contents.
1401 limit t)))
1407 "Parse a plain list.
1409 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1410 the buffer position at the beginning of the first affiliated
1411 keyword and CDR is a plist of affiliated keywords along with
1412 their value. STRUCTURE is the structure of the plain list being
1413 parsed.
1415 Return a list whose CAR is `plain-list' and CDR is a plist
1416 containing `:type', `:begin', `:end', `:contents-begin' and
1417 `:contents-end', `:structure', `:post-blank' and
1418 `:post-affiliated' keywords.
1420 Assume point is at the beginning of the list."
1434 pos))
1438 ;; Return value.
1442 :begin begin
1443 :end end
1444 :contents-begin contents-begin
1445 :contents-end contents-end
1446 :structure struct
1452 "Interpret plain-list element as Org syntax.
1453 CONTENTS is the contents of the element."
1461 ;;;; Property Drawer
1464 "Parse a property drawer.
1466 LIMIT bounds the search.
1468 Return a list whose car is `property-drawer' and cdr is a plist
1469 containing `:begin', `:end', `:contents-begin', `:contents-end',
1470 `:post-blank' and `:post-affiliated' keywords.
1472 Assume point is at the beginning of the property drawer."
1485 :end end
1487 :contents-end contents-end
1492 "Interpret property-drawer element as Org syntax.
1493 CONTENTS is the properties within the drawer."
1497 ;;;; Quote Block
1500 "Parse a quote block.
1502 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1503 the buffer position at the beginning of the first affiliated
1504 keyword and CDR is a plist of affiliated keywords along with
1505 their value.
1507 Return a list whose CAR is `quote-block' and CDR is a plist
1508 containing `:begin', `:end', `:contents-begin', `:contents-end',
1509 `:post-blank' and `:post-affiliated' keywords.
1511 Assume point is at the beginning of the block."
1515 ;; Incomplete block: parse it as a paragraph.
1521 ;; Empty blocks have no contents.
1534 :end end
1535 :contents-begin contents-begin
1536 :contents-end contents-end
1542 "Interpret quote-block element as Org syntax.
1543 CONTENTS is the contents of the element."
1547 ;;;; Section
1550 "Parse a section.
1552 Return a list whose CAR is `section' and CDR is a plist
1553 containing `:begin', `:end', `:contents-begin', `contents-end',
1554 `:post-blank' and `:post-affiliated' keywords."
1556 ;; Beginning of section is the beginning of the first non-blank
1557 ;; line after previous headline.
1565 :end end
1566 :contents-begin begin
1567 :contents-end pos-before-blank
1572 "Interpret section element as Org syntax.
1573 CONTENTS is the contents of the element."
1574 contents)
1577 ;;;; Special Block
1580 "Parse a special block.
1582 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1583 the buffer position at the beginning of the first affiliated
1584 keyword and CDR is a plist of affiliated keywords along with
1585 their value.
1587 Return a list whose CAR is `special-block' and CDR is a plist
1588 containing `:type', `:begin', `:end', `:contents-begin',
1589 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1591 Assume point is at the beginning of the block."
1598 limit t)))
1599 ;; Incomplete block: parse it as a paragraph.
1605 ;; Empty blocks have no contents.
1618 :begin begin
1619 :end end
1620 :contents-begin contents-begin
1621 :contents-end contents-end
1627 "Interpret SPECIAL-BLOCK element as Org syntax.
1628 CONTENTS is the contents of the element."
1633 \f
1634 ;;; Elements
1635 ;;
1636 ;; For each element, a parser and an interpreter are also defined.
1637 ;; Both follow the same naming convention used for greater elements.
1638 ;;
1639 ;; Also, as for greater elements, adding a new element type is done
1640 ;; through the following steps: implement a parser and an interpreter,
1641 ;; tweak `org-element--current-element' so that it recognizes the new
1642 ;; type and add that new type to `org-element-all-elements'.
1645 ;;;; Babel Call
1648 "Parse a babel call.
1650 LIMIT bounds the search. AFFILIATED is a list of which car is
1651 the buffer position at the beginning of the first affiliated
1652 keyword and cdr is a plist of affiliated keywords along with
1653 their value.
1655 Return a list whose car is `babel-call' and cdr is a plist
1656 containing `:call', `:inside-header', `:arguments',
1657 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1658 `:post-affiliated' as keywords."
1686 :inside-header inside-header
1687 :arguments arguments
1688 :end-header end-header
1689 :begin begin
1690 :end end
1691 :value value
1697 "Interpret BABEL-CALL element as Org syntax."
1707 ;;;; Clock
1710 "Parse a clock.
1712 LIMIT bounds the search.
1714 Return a list whose CAR is `clock' and CDR is a plist containing
1715 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1716 `:post-affiliated' as keywords."
1736 :value value
1737 :duration duration
1738 :begin begin
1739 :end end
1740 :post-blank post-blank
1744 "Interpret CLOCK element as Org syntax."
1752 "%2s:%02s"
1756 ;;;; Comment
1759 "Parse a comment.
1761 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1762 the buffer position at the beginning of the first affiliated
1763 keyword and CDR is a plist of affiliated keywords along with
1764 their value.
1766 Return a list whose CAR is `comment' and CDR is a plist
1767 containing `:begin', `:end', `:value', `:post-blank',
1768 `:post-affiliated' keywords.
1770 Assume point is at comment beginning."
1779 ;; Get comments ending.
1782 ;; Accumulate lines without leading hash and first
1783 ;; whitespace.
1797 :end end
1798 :value value
1804 "Interpret COMMENT element as Org syntax.
1805 CONTENTS is nil."
1809 ;;;; Comment Block
1812 "Parse an export block.
1814 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1815 the buffer position at the beginning of the first affiliated
1816 keyword and CDR is a plist of affiliated keywords along with
1817 their value.
1819 Return a list whose CAR is `comment-block' and CDR is a plist
1820 containing `:begin', `:end', `:value', `:post-blank' and
1821 `:post-affiliated' keywords.
1823 Assume point is at comment block beginning."
1827 ;; Incomplete block: parse it as a paragraph.
1840 contents-begin contents-end)))
1844 :end end
1845 :value value
1851 "Interpret COMMENT-BLOCK element as Org syntax."
1858 ;;;; Diary Sexp
1861 "Parse a diary sexp.
1863 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1864 the buffer position at the beginning of the first affiliated
1865 keyword and CDR is a plist of affiliated keywords along with
1866 their value.
1868 Return a list whose CAR is `diary-sexp' and CDR is a plist
1869 containing `:begin', `:end', `:value', `:post-blank' and
1870 `:post-affiliated' keywords."
1882 :begin begin
1883 :end end
1889 "Interpret DIARY-SEXP as Org syntax."
1893 ;;;; Example Block
1896 "Parse an example block.
1898 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1899 the buffer position at the beginning of the first affiliated
1900 keyword and CDR is a plist of affiliated keywords along with
1901 their value.
1903 Return a list whose CAR is `example-block' and CDR is a plist
1904 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1905 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1906 `:value', `:post-blank' and `:post-affiliated' keywords."
1910 ;; Incomplete block: parse it as a paragraph.
1918 ;; Switches analysis.
1922 switches)
1925 'new
1928 ;; Subtract 1 to give number of lines before
1929 ;; first line.
1933 ;; Should labels be retained in (or stripped from) example
1934 ;; blocks?
1939 ;; What should code-references use - labels or
1940 ;; line-numbers?
1949 ;; Standard block parsing.
1955 contents-begin contents-end)))
1964 :end end
1965 :value value
1966 :switches switches
1967 :number-lines number-lines
1968 :preserve-indent preserve-indent
1969 :retain-labels retain-labels
1970 :use-labels use-labels
1971 :label-fmt label-fmt
1977 "Interpret EXAMPLE-BLOCK element as Org syntax."
1985 value
1990 ;;;; Export Block
1993 "Parse an export block.
1995 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1996 the buffer position at the beginning of the first affiliated
1997 keyword and CDR is a plist of affiliated keywords along with
1998 their value.
2000 Return a list whose CAR is `export-block' and CDR is a plist
2001 containing `:begin', `:end', `:type', `:value', `:post-blank' and
2002 `:post-affiliated' keywords.
2004 Assume point is at export-block beginning."
2008 ;; Incomplete block: parse it as a paragraph.
2027 contents-end))))
2031 :begin begin
2032 :end end
2033 :value value
2039 "Interpret EXPORT-BLOCK element as Org syntax."
2045 ;;;; Fixed-width
2048 "Parse a fixed-width section.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `fixed-width' and CDR is a plist
2056 containing `:begin', `:end', `:value', `:post-blank' and
2057 `:post-affiliated' keywords.
2059 Assume point is at the beginning of the fixed-width area."
2063 value
2068 ;; Accumulate text without starting colons.
2081 :end end
2082 :value value
2088 "Interpret FIXED-WIDTH element as Org syntax."
2096 ;;;; Horizontal Rule
2099 "Parse an horizontal rule.
2101 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2102 the buffer position at the beginning of the first affiliated
2103 keyword and CDR is a plist of affiliated keywords along with
2104 their value.
2106 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2107 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2108 keywords."
2118 :end end
2124 "Interpret HORIZONTAL-RULE element as Org syntax."
2128 ;;;; Keyword
2131 "Parse a keyword at point.
2133 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2134 the buffer position at the beginning of the first affiliated
2135 keyword and CDR is a plist of affiliated keywords along with
2136 their value.
2138 Return a list whose CAR is `keyword' and CDR is a plist
2139 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2140 `:post-affiliated' keywords."
2142 ;; An orphaned affiliated keyword is considered as a regular
2143 ;; keyword. In this case AFFILIATED is nil, so we take care of
2144 ;; this corner case.
2157 :value value
2158 :begin begin
2159 :end end
2165 "Interpret KEYWORD element as Org syntax."
2171 ;;;; Latex Environment
2175 "Regexp matching the beginning of a LaTeX environment.
2176 The environment is captured by the first group.
2182 "Format string matching the ending of a LaTeX environment.
2186 "Parse a LaTeX environment.
2188 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2189 the buffer position at the beginning of the first affiliated
2190 keyword and CDR is a plist of affiliated keywords along with
2191 their value.
2193 Return a list whose CAR is `latex-environment' and CDR is a plist
2194 containing `:begin', `:end', `:value', `:post-blank' and
2195 `:post-affiliated' keywords.
2197 Assume point is at the beginning of the latex environment."
2204 limit t))
2205 ;; Incomplete latex environment: parse it as a paragraph.
2215 :end end
2216 :value value
2222 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2226 ;;;; Node Property
2229 "Parse a node-property at point.
2231 LIMIT bounds the search.
2233 Return a list whose CAR is `node-property' and CDR is a plist
2234 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2235 `:post-affiliated' keywords."
2245 limit))))
2248 :value value
2249 :begin begin
2250 :end end
2255 "Interpret NODE-PROPERTY element as Org syntax."
2261 ;;;; Paragraph
2264 "Parse a paragraph.
2266 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2267 the buffer position at the beginning of the first affiliated
2268 keyword and CDR is a plist of affiliated keywords along with
2269 their value.
2271 Return a list whose CAR is `paragraph' and CDR is a plist
2272 containing `:begin', `:end', `:contents-begin' and
2273 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2275 Assume point is at the beginning of the paragraph."
2282 ;; A matching `org-element-paragraph-separate' is not
2283 ;; necessarily the end of the paragraph. In particular,
2284 ;; drawers, blocks or LaTeX environments opening lines
2285 ;; must be closed. Moreover keywords with a secondary
2286 ;; value must belong to "dual keywords".
2300 limit t)))
2306 limit t)))
2309 org-element-dual-keywords))
2310 ;; Everything else is unambiguous.
2323 :end end
2324 :contents-begin contents-begin
2325 :contents-end contents-end
2331 "Interpret paragraph element as Org syntax.
2332 CONTENTS is the contents of the element."
2333 contents)
2336 ;;;; Planning
2339 "Parse a planning.
2341 LIMIT bounds the search.
2343 Return a list whose CAR is `planning' and CDR is a plist
2344 containing `:closed', `:deadline', `:scheduled', `:begin',
2345 `:end', `:post-blank' and `:post-affiliated' keywords."
2355 closed deadline scheduled)
2367 :deadline deadline
2368 :scheduled scheduled
2369 :begin begin
2370 :end end
2371 :post-blank post-blank
2375 "Interpret PLANNING element as Org syntax."
2377 #'identity
2394 ;;;; Src Block
2397 "Parse a src block.
2399 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2400 the buffer position at the beginning of the first affiliated
2401 keyword and CDR is a plist of affiliated keywords along with
2402 their value.
2404 Return a list whose CAR is `src-block' and CDR is a plist
2405 containing `:language', `:switches', `:parameters', `:begin',
2406 `:end', `:number-lines', `:retain-labels', `:use-labels',
2407 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2408 `:post-affiliated' keywords.
2410 Assume point is at the beginning of the block."
2413 limit t)))
2414 ;; Incomplete block: parse it as a paragraph.
2420 ;; Get language as a string.
2429 ;; Get switches.
2431 ;; Get parameters.
2433 ;; Switches analysis.
2437 switches)
2440 'new
2443 ;; Subtract 1 to give number of lines before
2444 ;; first line.
2452 ;; Should labels be retained in (or stripped from)
2453 ;; src blocks?
2458 ;; What should code-references use - labels or
2459 ;; line-numbers?
2464 ;; Retrieve code.
2471 ;; Get position after ending blank lines.
2481 :begin begin
2482 :end end
2483 :number-lines number-lines
2484 :preserve-indent preserve-indent
2485 :retain-labels retain-labels
2486 :use-labels use-labels
2487 :label-fmt label-fmt
2488 :value value
2494 "Interpret SRC-BLOCK element as Org syntax."
2503 val)
2518 ;;;; Table
2521 "Parse a table at point.
2523 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2524 the buffer position at the beginning of the first affiliated
2525 keyword and CDR is a plist of affiliated keywords along with
2526 their value.
2528 Return a list whose CAR is `table' and CDR is a plist containing
2529 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2530 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2531 keywords.
2533 Assume point is at the beginning of the table."
2549 acc))
2556 :end end
2557 :type type
2558 :tblfm tblfm
2559 ;; Only `org' tables have contents. `table.el' tables
2560 ;; use a `:value' property to store raw table as
2561 ;; a string.
2566 table-begin table-end))
2572 "Interpret TABLE element as Org syntax.
2573 CONTENTS is a string, if table's type is `org', or nil."
2584 ;;;; Table Row
2587 "Parse table row at point.
2589 Return a list whose CAR is `table-row' and CDR is a plist
2590 containing `:begin', `:end', `:contents-begin', `:contents-end',
2591 `:type', `:post-blank' and `:post-affiliated' keywords."
2595 ;; A table rule has no contents. In that case, ensure
2596 ;; CONTENTS-BEGIN matches CONTENTS-END.
2606 :begin begin
2607 :end end
2608 :contents-begin contents-begin
2609 :contents-end contents-end
2614 "Interpret TABLE-ROW element as Org syntax.
2615 CONTENTS is the contents of the table row."
2620 ;;;; Verse Block
2623 "Parse a verse block.
2625 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2626 the buffer position at the beginning of the first affiliated
2627 keyword and CDR is a plist of affiliated keywords along with
2628 their value.
2630 Return a list whose CAR is `verse-block' and CDR is a plist
2631 containing `:begin', `:end', `:contents-begin', `:contents-end',
2632 `:post-blank' and `:post-affiliated' keywords.
2634 Assume point is at beginning of the block."
2638 ;; Incomplete block: parse it as a paragraph.
2653 :end end
2654 :contents-begin contents-begin
2655 :contents-end contents-end
2661 "Interpret verse-block element as Org syntax.
2662 CONTENTS is verse block contents."
2666 \f
2667 ;;; Objects
2668 ;;
2669 ;; Unlike to elements, raw text can be found between objects. Hence,
2670 ;; `org-element--object-lex' is provided to find the next object in
2671 ;; buffer.
2672 ;;
2673 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2674 ;; object types they can contain will be specified in
2675 ;; `org-element-object-restrictions'.
2676 ;;
2677 ;; Creating a new type of object requires to alter
2678 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2679 ;; new type in `org-element-all-objects', and possibly add
2680 ;; restrictions in `org-element-object-restrictions'.
2682 ;;;; Bold
2685 "Parse bold object at point, if any.
2687 When at a bold object, return a list whose car is `bold' and cdr
2688 is a plist with `:begin', `:end', `:contents-begin' and
2689 `:contents-end' and `:post-blank' keywords. Otherwise, return
2690 nil.
2692 Assume point is at the first star marker."
2704 :end end
2705 :contents-begin contents-begin
2706 :contents-end contents-end
2710 "Interpret bold object as Org syntax.
2711 CONTENTS is the contents of the object."
2715 ;;;; Code
2718 "Parse code object at point, if any.
2720 When at a code object, return a list whose car is `code' and cdr
2721 is a plist with `:value', `:begin', `:end' and `:post-blank'
2722 keywords. Otherwise, return nil.
2724 Assume point is at the first tilde marker."
2735 :begin begin
2736 :end end
2740 "Interpret CODE object as Org syntax."
2744 ;;;; Entity
2747 "Parse entity at point, if any.
2749 When at an entity, return a list whose car is `entity' and cdr
2750 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2751 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2752 `:post-blank' as keywords. Otherwise, return nil.
2754 Assume point is at the beginning of the entity."
2756 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2774 :begin begin
2775 :end end
2776 :use-brackets-p bracketsp
2780 "Interpret ENTITY object as Org syntax."
2786 ;;;; Export Snippet
2789 "Parse export snippet at point.
2791 When at an export snippet, return a list whose car is
2792 `export-snippet' and cdr a plist with `:begin', `:end',
2793 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2794 return nil.
2796 Assume point is at the beginning of the snippet."
2812 :value value
2813 :begin begin
2814 :end end
2818 "Interpret EXPORT-SNIPPET object as Org syntax."
2824 ;;;; Footnote Reference
2827 "Parse footnote reference at point, if any.
2829 When at a footnote reference, return a list whose car is
2830 `footnote-reference' and cdr a plist with `:label', `:type',
2831 `:begin', `:end', `:content-begin', `:contents-end' and
2832 `:post-blank' as keywords. Otherwise, return nil."
2848 :type type
2849 :begin begin
2850 :end end
2856 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2857 CONTENTS is its definition, when inline, or nil."
2863 ;;;; Inline Babel Call
2866 "Parse inline babel call at point, if any.
2868 When at an inline babel call, return a list whose car is
2869 `inline-babel-call' and cdr a plist with `:call',
2870 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2871 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2873 Assume point is at the beginning of the babel call."
2887 ;; Parenthesis are mandatory.
2898 :inside-header inside-header
2899 :arguments arguments
2900 :end-header end-header
2901 :begin begin
2902 :end end
2903 :value value
2907 "Interpret INLINE-BABEL-CALL object as Org syntax."
2917 ;;;; Inline Src Block
2920 "Parse inline source block at point, if any.
2922 When at an inline source block, return a list whose car is
2923 `inline-src-block' and cdr a plist with `:begin', `:end',
2924 `:language', `:value', `:parameters' and `:post-blank' as
2925 keywords. Otherwise, return nil.
2927 Assume point is at the beginning of the inline src block."
2944 :value value
2945 :parameters parameters
2946 :begin begin
2951 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2956 language
2958 body)))
2960 ;;;; Italic
2963 "Parse italic object at point, if any.
2965 When at an italic object, return a list whose car is `italic' and
2966 cdr is a plist with `:begin', `:end', `:contents-begin' and
2967 `:contents-end' and `:post-blank' keywords. Otherwise, return
2968 nil.
2970 Assume point is at the first slash marker."
2982 :end end
2983 :contents-begin contents-begin
2984 :contents-end contents-end
2988 "Interpret italic object as Org syntax.
2989 CONTENTS is the contents of the object."
2993 ;;;; Latex Fragment
2996 "Parse LaTeX fragment at point, if any.
2998 When at a LaTeX fragment, return a list whose car is
2999 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
3000 and `:post-blank' as keywords. Otherwise, return nil.
3002 Assume point is at the beginning of the LaTeX fragment."
3013 ;; Macro.
3036 :begin begin
3037 :end end
3041 "Interpret LATEX-FRAGMENT object as Org syntax."
3044 ;;;; Line Break
3047 "Parse line break at point, if any.
3049 When at a line break, return a list whose car is `line-break',
3050 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3051 Otherwise, return nil.
3053 Assume point is at the beginning of the line break."
3062 "Interpret LINE-BREAK object as Org syntax."
3066 ;;;; Link
3069 "Parse link at point, if any.
3071 When at a link, return a list whose car is `link' and cdr a plist
3072 with `:type', `:path', `:format', `:raw-link', `:application',
3073 `:search-option', `:begin', `:end', `:contents-begin',
3074 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3075 nil.
3077 Assume point is at the beginning of the link."
3080 end contents-begin contents-end link-end post-blank path type format
3081 raw-link search-option application)
3083 ;; Type 1: Text targeted from a radio target.
3093 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3099 ;; RAW-LINK is the original link. Expand any
3100 ;; abbreviation in it.
3101 ;;
3102 ;; Also treat any newline character and associated
3103 ;; indentation as a single space character. This is not
3104 ;; compatible with RFC 3986, which requires to ignore
3105 ;; them altogether. However, doing so would require
3106 ;; users to encode spaces on the fly when writing links
3107 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3108 ;; [[shell:ls *.org]], which defeats Org's focus on
3109 ;; simplicity.
3114 ;; Determine TYPE of link and set PATH accordingly. According
3115 ;; to RFC 3986, remove whitespaces from URI in external links.
3116 ;; In internal ones, treat indentation as a single space.
3118 ;; File type.
3123 ;; Explicit type (http, irc, bbdb...).
3127 ;; Code-ref type: PATH is the name of the reference.
3132 ;; Custom-id type: PATH is the name of the custom id.
3136 ;; Fuzzy type: Internal link either matches a target, an
3137 ;; headline name or nothing. PATH is the target or
3138 ;; headline's name.
3142 ;; Type 3: Plain link, e.g., http://orgmode.org
3149 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3150 ;; bracket links, follow RFC 3986 and remove any extra
3151 ;; whitespace in URI.
3162 ;; In any case, deduce end point after trailing white space from
3163 ;; LINK-END variable.
3168 ;; Special "file" type link processing. Extract opening
3169 ;; application and search option, if any. Also normalize URI.
3176 ;; Translate link, if `org-link-translation-function' is set.
3184 :path path
3185 :format format
3187 :application application
3188 :search-option search-option
3189 :begin begin
3190 :end end
3191 :contents-begin contents-begin
3192 :contents-end contents-end
3196 "Interpret LINK object as Org syntax.
3197 CONTENTS is the contents of the object, or nil."
3202 ;; Links with contents and internal links have to
3203 ;; use bracket syntax. Ignore `:format' in these
3204 ;; cases. This is also the default syntax when the
3205 ;; property is not defined, e.g., when the object
3206 ;; was crafted by the user.
3209 ;; Since this is going to be used as
3210 ;; a format string, escape percent signs
3211 ;; in description.
3214 `nil
3217 ;; Otherwise, just obey to `:format'.
3229 path
3235 ;;;; Macro
3238 "Parse macro at point, if any.
3240 When at a macro, return a list whose car is `macro' and cdr
3241 a plist with `:key', `:args', `:begin', `:end', `:value' and
3242 `:post-blank' as keywords. Otherwise, return nil.
3244 Assume point is at the macro."
3257 :value value
3258 :args args
3259 :begin begin
3260 :end end
3264 "Interpret MACRO object as Org syntax."
3268 ;;;; Radio-target
3271 "Parse radio target at point, if any.
3273 When at a radio target, return a list whose car is `radio-target'
3274 and cdr a plist with `:begin', `:end', `:contents-begin',
3275 `:contents-end', `:value' and `:post-blank' as keywords.
3276 Otherwise, return nil.
3278 Assume point is at the radio target."
3290 :end end
3291 :contents-begin contents-begin
3292 :contents-end contents-end
3293 :post-blank post-blank
3297 "Interpret target object as Org syntax.
3298 CONTENTS is the contents of the object."
3302 ;;;; Statistics Cookie
3305 "Parse statistics cookie at point, if any.
3307 When at a statistics cookie, return a list whose car is
3308 `statistics-cookie', and cdr a plist with `:begin', `:end',
3309 `:value' and `:post-blank' keywords. Otherwise, return nil.
3311 Assume point is at the beginning of the statistics-cookie."
3322 :end end
3323 :value value
3327 "Interpret STATISTICS-COOKIE object as Org syntax."
3331 ;;;; Strike-Through
3334 "Parse strike-through object at point, if any.
3336 When at a strike-through object, return a list whose car is
3337 `strike-through' and cdr is a plist with `:begin', `:end',
3338 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3339 Otherwise, return nil.
3341 Assume point is at the first plus sign marker."
3353 :end end
3354 :contents-begin contents-begin
3355 :contents-end contents-end
3359 "Interpret strike-through object as Org syntax.
3360 CONTENTS is the contents of the object."
3364 ;;;; Subscript
3367 "Parse subscript at point, if any.
3369 When at a subscript object, return a list whose car is
3370 `subscript' and cdr a plist with `:begin', `:end',
3371 `:contents-begin', `:contents-end', `:use-brackets-p' and
3372 `:post-blank' as keywords. Otherwise, return nil.
3374 Assume point is at the underscore."
3388 :end end
3389 :use-brackets-p bracketsp
3390 :contents-begin contents-begin
3391 :contents-end contents-end
3395 "Interpret SUBSCRIPT object as Org syntax.
3396 CONTENTS is the contents of the object."
3399 contents))
3402 ;;;; Superscript
3405 "Parse superscript at point, if any.
3407 When at a superscript object, return a list whose car is
3408 `superscript' and cdr a plist with `:begin', `:end',
3409 `:contents-begin', `:contents-end', `:use-brackets-p' and
3410 `:post-blank' as keywords. Otherwise, return nil.
3412 Assume point is at the caret."
3426 :end end
3427 :use-brackets-p bracketsp
3428 :contents-begin contents-begin
3429 :contents-end contents-end
3433 "Interpret SUPERSCRIPT object as Org syntax.
3434 CONTENTS is the contents of the object."
3437 contents))
3440 ;;;; Table Cell
3443 "Parse table cell at point.
3444 Return a list whose car is `table-cell' and cdr is a plist
3445 containing `:begin', `:end', `:contents-begin', `:contents-end'
3446 and `:post-blank' keywords."
3454 :end end
3455 :contents-begin contents-begin
3456 :contents-end contents-end
3460 "Interpret table-cell element as Org syntax.
3461 CONTENTS is the contents of the cell, or nil."
3465 ;;;; Target
3468 "Parse target at point, if any.
3470 When at a target, return a list whose car is `target' and cdr
3471 a plist with `:begin', `:end', `:value' and `:post-blank' as
3472 keywords. Otherwise, return nil.
3474 Assume point is at the target."
3484 :end end
3485 :value value
3489 "Interpret TARGET object as Org syntax."
3493 ;;;; Timestamp
3504 "Parse time stamp at point, if any.
3506 When at a time stamp, return a list whose car is `timestamp', and
3507 cdr a plist with `:type', `:raw-value', `:year-start',
3508 `:month-start', `:day-start', `:hour-start', `:minute-start',
3509 `:year-end', `:month-end', `:day-end', `:hour-end',
3510 `:minute-end', `:repeater-type', `:repeater-value',
3511 `:repeater-unit', `:warning-type', `:warning-value',
3512 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3513 Otherwise, return nil.
3515 Assume point is at the beginning of the timestamp."
3534 date-start)
3545 raw-value)
3547 :repeater-type
3553 :repeater-unit
3562 :warning-unit
3565 year-start month-start day-start hour-start minute-start year-end
3566 month-end day-end hour-end minute-end)
3567 ;; Parse date-start.
3575 ;; Compute date-end. It can be provided directly in time-stamp,
3576 ;; or extracted from time range. Otherwise, it defaults to the
3577 ;; same values as date-start.
3587 :raw-value raw-value
3588 :year-start year-start
3589 :month-start month-start
3590 :day-start day-start
3591 :hour-start hour-start
3592 :minute-start minute-start
3593 :year-end year-end
3594 :month-end month-end
3595 :day-end day-end
3596 :hour-end hour-end
3597 :minute-end minute-end
3598 :begin begin
3599 :end end
3601 repeater-props
3602 warning-props))))))
3605 "Interpret TIMESTAMP object as Org syntax."
3623 ;; Build an Org timestamp string from TIME. ACTIVEP is
3624 ;; non-nil when time stamp is active. If WITH-TIME-P is
3625 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3626 ;; specify a time range in the timestamp. REPEAT-STRING is
3627 ;; the repeater string, if any.
3631 org-time-stamp-formats)
3632 time)))
3638 nil nil ts)))
3643 " "
3644 s
3646 ;; Return value.
3647 ts)))
3659 build-ts-string
3678 0
3686 "--"
3699 ;;;; Underline
3702 "Parse underline object at point, if any.
3704 When at an underline object, return a list whose car is
3705 `underline' and cdr is a plist with `:begin', `:end',
3706 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3707 Otherwise, return nil.
3709 Assume point is at the first underscore marker."
3721 :end end
3722 :contents-begin contents-begin
3723 :contents-end contents-end
3727 "Interpret underline object as Org syntax.
3728 CONTENTS is the contents of the object."
3732 ;;;; Verbatim
3735 "Parse verbatim object at point, if any.
3737 When at a verbatim object, return a list whose car is `verbatim'
3738 and cdr is a plist with `:value', `:begin', `:end' and
3739 `:post-blank' keywords. Otherwise, return nil.
3741 Assume point is at the first equal sign marker."
3752 :begin begin
3753 :end end
3757 "Interpret VERBATIM object as Org syntax."
3761 \f
3762 ;;; Parsing Element Starting At Point
3763 ;;
3764 ;; `org-element--current-element' is the core function of this section.
3765 ;; It returns the Lisp representation of the element starting at
3766 ;; point.
3767 ;;
3768 ;; `org-element--current-element' makes use of special modes. They
3769 ;; are activated for fixed element chaining (e.g., `plain-list' >
3770 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3771 ;; `section'). Special modes are: `first-section', `item',
3772 ;; `node-property', `section' and `table-row'.
3775 "Parse the element starting at point.
3777 Return value is a list like (TYPE PROPS) where TYPE is the type
3778 of the element and PROPS a plist of properties associated to the
3779 element.
3781 Possible types are defined in `org-element-all-elements'.
3783 LIMIT bounds the search.
3785 Optional argument GRANULARITY determines the depth of the
3786 recursion. Allowed values are `headline', `greater-element',
3787 `element', `object' or nil. When it is broader than `object' (or
3788 nil), secondary values will not be parsed, since they only
3789 contain objects.
3791 Optional argument MODE, when non-nil, can be either
3792 `first-section', `section', `planning', `item', `node-property'
3793 and `table-row'.
3795 If STRUCTURE isn't provided but MODE is set to `item', it will be
3796 computed.
3798 This function assumes point is always at the beginning of the
3799 element it has to parse."
3802 ;; Determine if parsing depth allows for secondary strings
3803 ;; parsing. It only applies to elements referenced in
3804 ;; `org-element-secondary-value-alist'.
3807 ;; Item.
3810 ;; Table Row.
3812 ;; Node Property.
3814 ;; Headline.
3817 ;; Sections (must be checked after headline).
3822 limit)))
3823 ;; Planning.
3828 ;; Property drawer.
3834 ;; When not at bol, point is at the beginning of an item or
3835 ;; a footnote definition: next item is always a paragraph.
3837 ;; Clock.
3839 ;; Inlinetask.
3842 ;; From there, elements can have affiliated keywords.
3845 ;; Jumping over affiliated keywords put point off-limits.
3846 ;; Parse them as regular keywords.
3850 ;; LaTeX Environment.
3853 ;; Drawer and Property Drawer.
3856 ;; Fixed Width
3859 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3860 ;; Keywords.
3878 limit
3879 affiliated))
3892 ;; Footnote Definition.
3895 ;; Horizontal Rule.
3898 ;; Diary Sexp.
3901 ;; Table.
3904 ;; List.
3907 limit affiliated
3909 ;; Default element: Paragraph.
3913 ;; Most elements can have affiliated keywords. When looking for an
3914 ;; element beginning, we want to move before them, as they belong to
3915 ;; that element, and, in the meantime, collect information they give
3916 ;; into appropriate properties. Hence the following function.
3919 "Collect affiliated keywords from point down to LIMIT.
3921 Return a list whose CAR is the position at the first of them and
3922 CDR a plist of keywords and values and move point to the
3923 beginning of the first line after them.
3925 As a special case, if element doesn't start at the beginning of
3926 the line (e.g., a paragraph starting an item), CAR is current
3927 position of point and CDR is nil."
3931 ;; RESTRICT is the list of objects allowed in parsed
3932 ;; keywords value.
3934 output)
3937 ;; Apply translation to RAW-KWD. From there, KWD is
3938 ;; the official keyword.
3940 org-element-keyword-translation-alist))
3941 raw-kwd))
3942 ;; Find main value for any keyword.
3948 ;; PARSEDP is non-nil when keyword should have its
3949 ;; value parsed.
3951 ;; If KWD is a dual keyword, find its secondary
3952 ;; value. Maybe parse it.
3961 ;; Attribute a property name to KWD.
3963 ;; Now set final shape for VALUE.
3969 nil restrict)))
3973 ;; Attributes can always appear on multiple lines.
3976 ;; Eventually store the new value in OUTPUT.
3978 ;; Move to next keyword.
3980 ;; If affiliated keywords are orphaned: move back to first one.
3981 ;; They will be parsed as a paragraph.
3983 ;; Return value.
3987 \f
3988 ;;; The Org Parser
3989 ;;
3990 ;; The two major functions here are `org-element-parse-buffer', which
3991 ;; parses Org syntax inside the current buffer, taking into account
3992 ;; region, narrowing, or even visibility if specified, and
3993 ;; `org-element-parse-secondary-string', which parses objects within
3994 ;; a given string.
3995 ;;
3996 ;; The (almost) almighty `org-element-map' allows applying a function
3997 ;; on elements or objects matching some type, and accumulating the
3998 ;; resulting values. In an export situation, it also skips unneeded
3999 ;; parts of the parse tree.
4002 "Recursively parse the buffer and return structure.
4003 If narrowing is in effect, only parse the visible part of the
4004 buffer.
4006 Optional argument GRANULARITY determines the depth of the
4007 recursion. It can be set to the following symbols:
4009 `headline' Only parse headlines.
4010 `greater-element' Don't recurse into greater elements except
4011 headlines and sections. Thus, elements
4012 parsed are the top-level ones.
4013 `element' Parse everything but objects and plain text.
4014 `object' Parse the complete buffer (default).
4016 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4017 elements.
4019 An element or object is represented as a list with the
4020 pattern (TYPE PROPERTIES CONTENTS), where :
4022 TYPE is a symbol describing the element or object. See
4023 `org-element-all-elements' and `org-element-all-objects' for an
4024 exhaustive list of such symbols. One can retrieve it with
4025 `org-element-type' function.
4027 PROPERTIES is the list of attributes attached to the element or
4028 object, as a plist. Although most of them are specific to the
4029 element or object type, all types share `:begin', `:end',
4030 `:post-blank' and `:parent' properties, which respectively
4031 refer to buffer position where the element or object starts,
4032 ends, the number of white spaces or blank lines after it, and
4033 the element or object containing it. Properties values can be
4034 obtained by using `org-element-property' function.
4036 CONTENTS is a list of elements, objects or raw strings
4037 contained in the current element or object, when applicable.
4038 One can access them with `org-element-contents' function.
4040 The Org buffer has `org-data' as type and nil as properties.
4041 `org-element-map' function can be used to find specific elements
4042 or objects within the parse tree.
4044 This function assumes that current major mode is `org-mode'."
4050 ;; Start in `first-section' mode so text before the first
4051 ;; headline belongs to a section.
4055 "Recursively parse objects in STRING and return structure.
4057 RESTRICTION is a symbol limiting the object types that will be
4058 looked after.
4060 Optional argument PARENT, when non-nil, is the element or object
4061 containing the secondary string. It is used to set correctly
4062 `:parent' property within the string.
4064 If STRING is the empty string or nil, return nil."
4081 "Map a function on selected elements or objects.
4083 DATA is a parse tree, an element, an object, a string, or a list
4084 of such constructs. TYPES is a symbol or list of symbols of
4085 elements or objects types (see `org-element-all-elements' and
4086 `org-element-all-objects' for a complete list of types). FUN is
4087 the function called on the matching element or object. It has to
4088 accept one argument: the element or object itself.
4090 When optional argument INFO is non-nil, it should be a plist
4091 holding export options. In that case, parts of the parse tree
4092 not exportable according to that property list will be skipped.
4094 When optional argument FIRST-MATCH is non-nil, stop at the first
4095 match for which FUN doesn't return nil, and return that value.
4097 Optional argument NO-RECURSION is a symbol or a list of symbols
4098 representing elements or objects types. `org-element-map' won't
4099 enter any recursive element or object whose type belongs to that
4100 list. Though, FUN can still be applied on them.
4102 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4103 apply to matching objects within parsed affiliated keywords (see
4104 `org-element-parsed-keywords').
4106 Nil values returned from FUN do not appear in the results.
4109 Examples:
4110 ---------
4112 Assuming TREE is a variable containing an Org buffer parse tree,
4113 the following example will return a flat list of all `src-block'
4114 and `example-block' elements in it:
4118 The following snippet will find the first headline with a level
4122 (lambda (hl)
4123 (and (= (org-element-property :level hl) 1)
4125 (org-element-property :begin hl)))
4126 nil t)
4128 The next example will return a flat list of all `plain-list' type
4129 elements in TREE that are not a sub-list themselves:
4133 Eventually, this example will return a flat list of all `bold'
4134 type objects containing a `latex-snippet' type object, even
4135 looking into captions:
4138 (lambda (b)
4140 nil nil nil t)"
4141 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4145 ;; Recursion depth is determined by --CATEGORY.
4152 ;; If one object is found, the function has
4153 ;; to recurse into every object.
4156 ;; If one regular element is found, the
4157 ;; function has to recurse, at least, into
4158 ;; every element it encounters.
4161 --acc)
4164 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4165 ;; holding contextual information.
4169 ;; Ignored element in an export context.
4171 ;; List of elements or objects.
4173 ;; Unconditionally enter parse trees.
4177 ;; Check if TYPE is matching among TYPES. If so,
4178 ;; apply FUN to --DATA and accumulate return value
4179 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4185 ;; If --DATA has a secondary string that can contain
4186 ;; objects with their type among TYPES, look inside.
4189 org-element-secondary-value-alist)))
4191 ;; If --DATA has any parsed affiliated keywords and
4192 ;; WITH-AFFILIATED is non-nil, look for objects in
4193 ;; them.
4200 ;; Pay attention to the type of parsed
4201 ;; keyword. In particular, preserve order for
4202 ;; multiple keywords.
4215 ;; Determine if a recursion into --DATA is possible.
4217 ;; --TYPE is explicitly removed from recursion.
4219 ;; --DATA has no contents.
4221 ;; Looking for greater elements but --DATA is
4222 ;; simply an element or an object.
4225 ;; Looking for elements but --DATA is an object.
4228 ;; In any other case, map contents.
4232 ;; Return value in a proper order.
4236 ;; The following functions are internal parts of the parser.
4237 ;;
4238 ;; The first one, `org-element--parse-elements' acts at the element's
4239 ;; level.
4240 ;;
4241 ;; The second one, `org-element--parse-objects' applies on all objects
4242 ;; of a paragraph or a secondary string. It calls
4243 ;; `org-element--object-lex' to find the next object in the current
4244 ;; container.
4247 "Return next special mode according to TYPE, or nil.
4248 TYPE is a symbol representing the type of an element or object
4249 containing next element if PARENTP is non-nil, or before it
4250 otherwise. Modes can be either `first-section', `item',
4251 `node-property', `planning', `property-drawer', `section',
4252 `table-row' or nil."
4269 "Parse elements between BEG and END positions.
4271 MODE prioritizes some elements over the others. It can be set to
4272 `first-section', `section', `planning', `item', `node-property'
4273 or `table-row'.
4275 When value is `item', STRUCTURE will be used as the current list
4276 structure.
4278 GRANULARITY determines the depth of the recursion. See
4279 `org-element-parse-buffer' for more information.
4281 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4282 elements.
4284 Elements are accumulated into ACC."
4287 ;; Visible only: skip invisible parts at the beginning of the
4288 ;; element.
4291 ;; When parsing only headlines, skip any text before first one.
4296 ;; Find current element's type and parse it accordingly to
4297 ;; its category.
4299 end granularity mode structure))
4303 ;; Visible only: skip invisible parts between siblings.
4306 ;; Fill ELEMENT contents by side-effect.
4308 ;; If element has no contents, don't modify it.
4310 ;; Greater element: parse it between `contents-begin' and
4311 ;; `contents-end'. Make sure GRANULARITY allows the
4312 ;; recursion, or ELEMENT is a headline, in which case going
4313 ;; inside is mandatory, in order to get sub-level headings.
4321 ;; Possibly switch to a special mode.
4325 granularity visible-only element))
4326 ;; ELEMENT has contents. Parse objects inside, if
4327 ;; GRANULARITY allows it.
4333 ;; Update mode.
4335 ;; Return result.
4339 "Return next object in current buffer or nil.
4340 RESTRICTION is a list of object types, as symbols, that should be
4341 looked after. This function assumes that the buffer is narrowed
4342 to an appropriate container (e.g., a paragraph)."
4346 ;; Object regexp sometimes needs to have a peek at
4347 ;; a character ahead. Therefore, when there is a hard
4348 ;; limit, make it one more than the true beginning of the
4349 ;; radio target.
4356 nil)
4357 ;; Since we moved backward, we do not want to
4358 ;; match again an hypothetical 1-character long
4359 ;; radio link before us. Realizing that this can
4360 ;; only happen if such a radio link starts at
4361 ;; beginning of line, we prevent this here.
4367 found)
4433 ;; This is probably a plain link.
4443 "Parse objects between BEG and END and return recursive structure.
4445 Objects are accumulated in ACC. RESTRICTION is a list of object
4446 successors which are allowed in the current object.
4448 ACC becomes the parent for all parsed objects. However, if ACC
4449 is nil (i.e., a secondary string is being parsed) and optional
4450 argument PARENT is non-nil, use it as the parent for all objects.
4451 Eventually, if both ACC and PARENT are nil, the common parent is
4452 the list of objects itself."
4460 ;; Text before any object.
4465 contents))))
4466 ;; Object...
4471 ;; Fill contents of NEXT-OBJECT if possible.
4473 cont-beg
4475 next-object
4477 next-object)
4478 contents)
4480 ;; Text after last object.
4484 contents)))
4485 ;; Result. Set appropriate parent.
4493 \f
4494 ;;; Towards A Bijective Process
4495 ;;
4496 ;; The parse tree obtained with `org-element-parse-buffer' is really
4497 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4498 ;; interpreted and expanded into a string with canonical Org syntax.
4499 ;; Hence `org-element-interpret-data'.
4500 ;;
4501 ;; The function relies internally on
4502 ;; `org-element--interpret-affiliated-keywords'.
4504 ;;;###autoload
4506 "Interpret DATA as Org syntax.
4507 DATA is a parse tree, an element, an object or a secondary string
4508 to interpret. Return Org syntax as a string."
4512 ;; Find interpreter for current object or
4513 ;; element. If it doesn't exist (e.g. this is
4514 ;; a pseudo object or element), return contents,
4515 ;; if any.
4522 ;; Secondary string.
4525 data
4527 ;; Full Org document.
4532 ;; Plain text: return it.
4534 ;; Element or object without contents.
4537 ;; Element or object with contents.
4540 interpret
4541 data
4542 ;; Recursively interpret contents.
4547 data
4548 ;; Fix indentation of elements containing
4549 ;; objects. We ignore `table-row'
4550 ;; elements as they are one line long
4551 ;; anyway.
4553 data
4554 ;; When normalizing first paragraph of
4555 ;; an item or a footnote-definition,
4556 ;; ignore first line's indentation.
4565 ;; Build white spaces. If no `:post-blank' property
4566 ;; is specified, assume its value is 0.
4576 "Return ELEMENT's affiliated keywords as Org syntax.
4577 If there is no affiliated keyword, return the empty string."
4587 ": "
4590 value)
4598 ;; All attribute keywords can have multiple lines.
4604 ;; List all ELEMENT's properties matching an attribute line or an
4605 ;; affiliated keyword, but ignore translated keywords since they
4606 ;; cannot belong to the property list.
4613 org-element-keyword-translation-alist)))))
4614 collect prop)
4617 ;; Because interpretation of the parse tree must return the same
4618 ;; number of blank lines between elements and the same number of white
4619 ;; space after objects, some special care must be given to white
4620 ;; spaces.
4621 ;;
4622 ;; The first function, `org-element-normalize-string', ensures any
4623 ;; string different from the empty string will end with a single
4624 ;; newline character.
4625 ;;
4626 ;; The second function, `org-element-normalize-contents', removes
4627 ;; global indentation from the contents of the current element.
4630 "Ensure string S ends with a single newline character.
4632 If S isn't a string return it unchanged. If S is the empty
4633 string, return it. Otherwise, return a new string with a single
4634 newline character at its end."
4642 "Normalize plain text in ELEMENT's contents.
4644 ELEMENT must only contain plain text and objects.
4646 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4647 indentation to compute maximal common indentation.
4649 Return the normalized element that is element with global
4650 indentation removed from its contents."
4652 ;; Return minimal common indentation within BLOB. This is
4653 ;; done by walking recursively BLOB and updating MIN-IND
4654 ;; along the way. FIRST-FLAG is non-nil when the next
4655 ;; object is expected to be a string that doesn't start
4656 ;; with a newline character. It happens for strings at
4657 ;; the beginnings of the contents or right after a line
4658 ;; break.
4664 ;; Objects cannot start with spaces: in this
4665 ;; case, indentation is 0.
4706 ;; Build ELEMENT back, replacing each string with the same
4707 ;; string minus common indentation.
4710 ;; Return DATUM with all its strings indentation
4711 ;; shortened from MIN-IND white spaces.
4731 org-element-recursive-objects)
4735 datum)))
4739 \f
4740 ;;; Cache
4741 ;;
4742 ;; Implement a caching mechanism for `org-element-at-point' and
4743 ;; `org-element-context', which see.
4744 ;;
4745 ;; A single public function is provided: `org-element-cache-reset'.
4746 ;;
4747 ;; Cache is enabled by default, but can be disabled globally with
4748 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4749 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4750 ;; can be tweaked to control caching behaviour.
4751 ;;
4752 ;; Internally, parsed elements are stored in an AVL tree,
4753 ;; `org-element--cache'. This tree is updated lazily: whenever
4754 ;; a change happens to the buffer, a synchronization request is
4755 ;; registered in `org-element--cache-sync-requests' (see
4756 ;; `org-element--cache-submit-request'). During idle time, requests
4757 ;; are processed by `org-element--cache-sync'. Synchronization also
4758 ;; happens when an element is required from the cache. In this case,
4759 ;; the process stops as soon as the needed element is up-to-date.
4760 ;;
4761 ;; A synchronization request can only apply on a synchronized part of
4762 ;; the cache. Therefore, the cache is updated at least to the
4763 ;; location where the new request applies. Thus, requests are ordered
4764 ;; from left to right and all elements starting before the first
4765 ;; request are correct. This property is used by functions like
4766 ;; `org-element--cache-find' to retrieve elements in the part of the
4767 ;; cache that can be trusted.
4768 ;;
4769 ;; A request applies to every element, starting from its original
4770 ;; location (or key, see below). When a request is processed, it
4771 ;; moves forward and may collide the next one. In this case, both
4772 ;; requests are merged into a new one that starts from that element.
4773 ;; As a consequence, the whole synchronization complexity does not
4774 ;; depend on the number of pending requests, but on the number of
4775 ;; elements the very first request will be applied on.
4776 ;;
4777 ;; Elements cannot be accessed through their beginning position, which
4778 ;; may or may not be up-to-date. Instead, each element in the tree is
4779 ;; associated to a key, obtained with `org-element--cache-key'. This
4780 ;; mechanism is robust enough to preserve total order among elements
4781 ;; even when the tree is only partially synchronized.
4785 "Non-nil when Org parser should cache its results.
4787 WARNING: for the time being, using cache sometimes triggers
4788 freezes. Therefore, it is disabled by default. Activate it if
4795 "Maximum duration, as a time value, for a cache synchronization.
4796 If the synchronization is not over after this delay, the process
4797 pauses and resumes after `org-element-cache-sync-break'
4801 "Duration, as a time value, of the pause between synchronizations.
4805 ;;;; Data Structure
4808 "AVL tree used to cache elements.
4809 Each node of the tree contains an element. Comparison is done
4810 with `org-element--cache-compare'. This cache is used in
4814 "List of pending synchronization requests.
4816 A request is a vector with the following pattern:
4818 \[NEXT BEG END OFFSET PARENT PHASE]
4820 Processing a synchronization request consists of three phases:
4822 0. Delete modified elements,
4823 1. Fill missing area in cache,
4824 2. Shift positions and re-parent elements after the changes.
4826 During phase 0, NEXT is the key of the first element to be
4827 removed, BEG and END is buffer position delimiting the
4828 modifications. Elements starting between them (inclusive) are
4829 removed. So are elements whose parent is removed. PARENT, when
4830 non-nil, is the parent of the first element to be removed.
4832 During phase 1, NEXT is the key of the next known element in
4833 cache and BEG its beginning position. Parse buffer between that
4834 element and the one before it in order to determine the parent of
4835 the next element. Set PARENT to the element containing NEXT.
4837 During phase 2, NEXT is the key of the next element to shift in
4838 the parse tree. All elements starting from this one have their
4839 properties relatives to buffer positions shifted by integer
4840 OFFSET and, if they belong to element PARENT, are adopted by it.
4848 "Hash table used to store keys during synchronization.
4852 "Return a unique key for ELEMENT in cache tree.
4854 Keys are used to keep a total order among elements in the cache.
4855 Comparison is done with `org-element--cache-key-less-p'.
4857 When no synchronization is taking place, a key is simply the
4858 beginning position of the element, or that position plus one in
4859 the case of an first item (respectively row) in
4860 a list (respectively a table).
4862 During a synchronization, the key is the one the element had when
4863 the cache was synchronized for the last time. Elements added to
4864 cache during the synchronization get a new key generated with
4865 `org-element--cache-generate-key'.
4867 Such keys are stored in `org-element--cache-sync-keys'. The hash
4868 table is cleared once the synchronization is complete."
4871 ;; Increase beginning position of items (respectively
4872 ;; table rows) by one, so the first item can get
4873 ;; a different key from its parent list (respectively
4874 ;; table).
4877 begin)))
4880 key))))
4883 "Generate a key between LOWER and UPPER.
4885 LOWER and UPPER are integers or lists, possibly empty.
4887 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4888 a unique key, as an integer or a list of integers, according to
4889 the following rules:
4891 - LOWER and UPPER are compared level-wise until values differ.
4893 - If, at a given level, LOWER and UPPER differ from more than
4894 2, the new key shares all the levels above with LOWER and
4895 gets a new level. Its value is the mean between LOWER and
4896 UPPER:
4898 (1 2) + (1 4) --> (1 3)
4900 - If LOWER has no value to compare with, it is assumed that its
4901 value is `most-negative-fixnum'. E.g.,
4903 (1 1) + (1 1 2)
4905 is equivalent to
4907 (1 1 m) + (1 1 2)
4909 where m is `most-negative-fixnum'. Likewise, if UPPER is
4910 short of levels, the current value is `most-positive-fixnum'.
4912 - If they differ from only one, the new key inherits from
4913 current LOWER level and fork it at the next level. E.g.,
4915 (2 1) + (3 3)
4917 is equivalent to
4919 (2 1) + (2 M)
4921 where M is `most-positive-fixnum'.
4923 - If the key is only one level long, it is returned as an
4924 integer:
4926 (1 2) + (3 2) --> 2
4928 When they are not equals, the function assumes that LOWER is
4929 lesser than UPPER, per `org-element--cache-key-less-p'."
4933 skip-upper key)
4944 ;; When at a given level, LOWER and UPPER differ from
4945 ;; 1, ignore UPPER altogether. Instead create a key
4946 ;; between LOWER and the greatest key with the same
4947 ;; prefix as LOWER so far.
4953 "Non-nil if key A is less than key B.
4954 A and B are either integers or lists of integers, as returned by
4955 `org-element--cache-key'."
4963 ;; If A is empty, either keys are equal (B is also empty) and
4964 ;; we return nil, or A is lesser than B (B is longer) and we
4965 ;; return a non-nil value.
4966 ;;
4967 ;; If A is not empty, B is necessarily empty and A is greater
4968 ;; than B (A is longer). Therefore, return nil.
4972 "Non-nil when element A is located before element B."
4977 "Return root value in cache.
4978 This function assumes `org-element--cache' is a valid AVL tree."
4982 ;;;; Tools
4985 "Non-nil when cache is active in current buffer."
4987 org-element--cache
4991 "Find element in cache starting at POS or before.
4993 POS refers to a buffer position.
4995 When optional argument SIDE is non-nil, the function checks for
4996 elements starting at or past POS instead. If SIDE is `both', the
4997 function returns a cons cell where car is the first element
4998 starting at or before POS and cdr the first element starting
4999 after POS.
5001 The function can only find elements in the synchronized part of
5002 the cache."
5006 lower upper)
5021 ;; We found an element in cache starting at POS. If `side'
5022 ;; is `both' we also want the next one in order to generate
5023 ;; a key in-between.
5024 ;;
5025 ;; If the element is the first row or item in a table or
5026 ;; a plain list, we always return the table or the plain
5027 ;; list.
5028 ;;
5029 ;; In any other case, we return the element found.
5038 lower parent
5039 upper parent)))))
5042 lower element
5043 upper element)))))
5050 "Store ELEMENT in current buffer's cache, if allowed."
5053 ;; During synchronization, first build an appropriate key for
5054 ;; the new element so `avl-tree-enter' can insert it at the
5055 ;; right spot in the cache.
5064 org-element--cache-sync-keys)))
5068 "Remove ELEMENT from cache.
5069 Assume ELEMENT belongs to cache and that a cache is active."
5073 ;;;; Synchronization
5076 "Set idle timer for cache synchronization in BUFFER."
5083 org-element-cache-sync-idle-time))
5084 nil
5085 #'org-element--cache-sync
5086 buffer)))
5089 "Non-nil when synchronization process should be interrupted.
5090 TIME-LIMIT is a time value or nil."
5096 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5098 Properties containing buffer positions are `:begin', `:end',
5099 `:contents-begin', `:contents-end' and `:structure'. When
5100 optional argument PROPS is a list of keywords, only shift
5101 properties provided in that list.
5103 Properties are modified by side-effect."
5105 ;; Shift `:structure' property for the first plain list only: it
5106 ;; is the only one that really matters and it prevents from
5107 ;; shifting it more than once.
5121 "Synchronize cache with recent modification in BUFFER.
5123 When optional argument THRESHOLD is non-nil, do the
5124 synchronization for all elements starting before or at threshold,
5125 then exit. Otherwise, synchronize cache for as long as
5126 `org-element-cache-sync-duration' or until Emacs leaves idle
5127 state.
5129 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5130 not registered yet in the cache are going to happen. It is used
5131 in `org-element--cache-submit-request', where cache is partially
5132 updated before current modification are actually submitted."
5143 request
5145 threshold
5148 org-element-cache-sync-duration))
5149 future-change)
5150 ;; Request processed. Merge current and next offsets and
5151 ;; transfer ending position.
5157 ;; If more requests are awaiting, set idle timer accordingly.
5158 ;; Otherwise, reset keys.
5165 "Process synchronization REQUEST for all entries before NEXT.
5167 REQUEST is a vector, built by `org-element--cache-submit-request'.
5169 NEXT is a cache key, as returned by `org-element--cache-key'.
5171 When non-nil, THRESHOLD is a buffer position. Synchronization
5172 stops as soon as a shifted element begins after it.
5174 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5175 after this time or when Emacs exits idle state.
5177 When non-nil, FUTURE-CHANGE is a buffer position where changes
5178 not registered yet in the cache are going to happen. See
5179 `org-element--cache-submit-request' for more information.
5181 Throw `interrupt' if the process stops before completing the
5182 request."
5185 ;; Phase 0.
5186 ;;
5187 ;; Delete all elements starting after BEG, but not after buffer
5188 ;; position END or past element with key NEXT. Also delete
5189 ;; elements contained within a previously removed element
5190 ;; (stored in `last-container').
5191 ;;
5192 ;; At each iteration, we start again at tree root since
5193 ;; a deletion modifies structure of the balanced tree.
5198 ;; Find first element in cache with key BEG or after it.
5202 data data-key last-container)
5211 data-key key
5214 data-key key
5215 node nil)))))
5225 up)))
5228 end))
5235 ;; No element starting after modifications left in
5236 ;; cache: further processing is futile.
5239 ;; Phase 1.
5240 ;;
5241 ;; Phase 0 left a hole in the cache. Some elements after it
5242 ;; could have parents within. For example, in the following
5243 ;; buffer:
5244 ;;
5245 ;; - item
5246 ;;
5247 ;;
5248 ;; Paragraph1
5249 ;;
5250 ;; Paragraph2
5251 ;;
5252 ;; if we remove a blank line between "item" and "Paragraph1",
5253 ;; everything down to "Paragraph2" is removed from cache. But
5254 ;; the paragraph now belongs to the list, and its `:parent'
5255 ;; property no longer is accurate.
5256 ;;
5257 ;; Therefore we need to parse again elements in the hole, or at
5258 ;; least in its last section, so that we can re-parent
5259 ;; subsequent elements, during phase 2.
5260 ;;
5261 ;; Note that we only need to get the parent from the first
5262 ;; element in cache after the hole.
5263 ;;
5264 ;; When next key is lesser or equal to the current one, delegate
5265 ;; phase 1 processing to next request in order to preserve key
5266 ;; order among requests.
5274 ;; Next element will start at its beginning position plus
5275 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5276 ;; contains the real beginning position of the first element to
5277 ;; shift and re-parent.
5281 ;; Changes are going to happen around this element and
5282 ;; they will trigger another phase 1 request. Skip the
5283 ;; current one.
5289 ;; Phase 2.
5290 ;;
5291 ;; Shift all elements starting from key START, but before NEXT, by
5292 ;; OFFSET, and re-parent them when appropriate.
5293 ;;
5294 ;; Elements are modified by side-effect so the tree structure
5295 ;; remains intact.
5296 ;;
5297 ;; Once THRESHOLD, if any, is reached, or once there is an input
5298 ;; pending, exit. Before leaving, the current synchronization
5299 ;; request is updated.
5306 exit-flag)
5307 ;; No re-parenting nor shifting planned: request is over.
5317 ;; We reached NEXT. Request is complete.
5319 ;; Handle interruption request. Update current request.
5324 ;; Shift element.
5328 ;; Update PARENT and re-parent DATA, only when
5329 ;; necessary. Propagate new structures for lists.
5343 ;; Cache is up-to-date past THRESHOLD. Request
5344 ;; interruption.
5349 ;; We reached end of tree: synchronization complete.
5350 t)))
5353 "Parse elements in current section, down to POS.
5355 Start parsing from the closest between the last known element in
5356 cache or headline above. Return the smallest element containing
5357 POS.
5359 When optional argument SYNCP is non-nil, return the parent of the
5360 element containing POS instead. In that case, it is also
5361 possible to provide TIME-LIMIT, which is a time value specifying
5362 when the parsing should stop. The function throws `interrupt' if
5363 the process stopped before finding the expected result."
5370 element next mode)
5372 ;; Nothing in cache before point: start parsing from first
5373 ;; element following headline above, or first element in
5374 ;; buffer.
5381 ;; Cache returned exact match: return it.
5384 ;; There's a headline between cached value and POS: cached
5385 ;; value is invalid. Start parsing from first element
5386 ;; following the headline.
5393 ;; Check if CACHED or any of its ancestors contain point.
5394 ;;
5395 ;; If there is such an element, we inspect it in order to know
5396 ;; if we return it or if we need to parse its contents.
5397 ;; Otherwise, we just start parsing from current location,
5398 ;; which is right after the top-most element containing
5399 ;; CACHED.
5400 ;;
5401 ;; As a special case, if POS is at the end of the buffer, we
5402 ;; want to return the innermost element ending there.
5403 ;;
5404 ;; Also, if we find an ancestor and discover that we need to
5405 ;; parse its contents, make sure we don't start from
5406 ;; `:contents-begin', as we would otherwise go past CACHED
5407 ;; again. Instead, in that situation, we will resume parsing
5408 ;; from NEXT, which is located after CACHED or its higher
5409 ;; ancestor not containing point.
5421 ;; Parse successively each element until we reach POS.
5434 end 'element mode
5441 ;; Skip any element ending before point. Also skip
5442 ;; element ending at point (unless it is also the end of
5443 ;; buffer) since we're sure that another element begins
5444 ;; after it.
5448 ;; A non-greater element contains point: return it.
5451 ;; Otherwise, we have to decide if ELEMENT really
5452 ;; contains POS. In that case we start parsing from
5453 ;; contents' beginning.
5454 ;;
5455 ;; If POS is at contents' beginning but it is also at
5456 ;; the beginning of the first item in a list or a table.
5457 ;; In that case, we need to create an anchor for that
5458 ;; list or table, so return it.
5459 ;;
5460 ;; Also, if POS is at the end of the buffer, no element
5461 ;; can start after it, but more than one may end there.
5462 ;; Arbitrarily, we choose to return the innermost of
5463 ;; such elements.
5476 parent element
5477 end cend))))
5478 ;; Otherwise, return ELEMENT as it is the smallest
5479 ;; element containing POS.
5484 ;;;; Staging Buffer Changes
5495 "Regexp matching a sensitive line, structure wise.
5496 A sensitive line is a headline, inlinetask, block, drawer, or
5497 latex-environment boundary. When such a line is modified,
5498 structure changes in the document may propagate in the whole
5502 "Non-nil when a sensitive line is about to be changed.
5506 "Request extension of area going to be modified if needed.
5507 BEG and END are the beginning and end of the range of changed
5508 text. See `before-change-functions' for more information."
5518 'headline
5521 org-element--cache-sensitive-re bottom t)))))))))
5524 "Update buffer modifications for current buffer.
5525 BEG and END are the beginning and end of the range of changed
5526 text, and the length in bytes of the pre-change text replaced by
5527 that range. See `after-change-functions' for more information."
5535 ;; Determine if modified area needs to be extended, according
5536 ;; to both previous and current state. We make a special
5537 ;; case for headline editing: if a headline is modified but
5538 ;; not removed, do not extend.
5541 (`headline
5547 org-element--cache-sensitive-re bottom t))))
5548 ;; Effectively extend modified area.
5556 ;; Store synchronization request.
5559 ;; Activate a timer to process the request during idle time.
5563 "Return first element to remove from cache.
5565 BEG and END are buffer positions delimiting buffer modifications.
5566 OFFSET is the size of the changes.
5568 Returned element is usually the first element in cache containing
5569 any position between BEG and END. As an exception, greater
5570 elements around the changes that are robust to contents
5571 modifications are preserved and updated according to the
5572 changes."
5582 special-block))
5583 ;; Drawers named "PROPERTIES" are probably
5584 ;; a properties drawer being edited. Force
5585 ;; parsing to check if editing is over.
5594 ;; UP is a robust greater element containing changes.
5595 ;; We only need to extend its ending boundaries.
5601 ;; We're at top level element containing ELEMENT: if it's
5602 ;; altered by buffer modifications, it is first element in
5603 ;; cache to be removed. Otherwise, that first element is the
5604 ;; following one.
5605 ;;
5606 ;; As a special case, do not remove BEFORE if it is a robust
5607 ;; container for current changes.
5609 before)))))
5612 "Submit a new cache synchronization request for current buffer.
5613 BEG and END are buffer positions delimiting the minimal area
5614 where cache data should be removed. OFFSET is the size of the
5615 change, as an integer."
5617 delete-to delete-from)
5622 ;; Current changes can be merged with first sync request: we
5623 ;; can save a partial cache synchronization.
5626 ;; If last change happened within area to be removed, extend
5627 ;; boundaries of robust parents, if any. Otherwise, find
5628 ;; first element to remove and update request accordingly.
5640 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5641 ;; if any, is no longer a 0-phase request, thus ensuring that
5642 ;; phases are properly ordered. We need to provide OFFSET as
5643 ;; optional parameter since current modifications are not known
5644 ;; yet to the otherwise correct part of the cache (i.e, before
5645 ;; the first request).
5652 ;; When changes happen before the first known
5653 ;; element, re-parent and shift the rest of the
5654 ;; cache.
5656 ;; Otherwise, we find the first non robust
5657 ;; element containing END. All elements between
5658 ;; FIRST and this one are to be removed.
5669 element up))
5671 org-element--cache-sync-requests)
5672 ;; No element to remove. No need to re-parent either.
5673 ;; Simply shift additional elements, if any, by OFFSET.
5676 offset)))))))
5679 ;;;; Public Functions
5681 ;;;###autoload
5683 "Reset cache in current buffer.
5684 When optional argument ALL is non-nil, reset cache in all Org
5685 buffers."
5702 ;;;###autoload
5704 "Refresh cache at position POS."
5711 \f
5712 ;;; The Toolbox
5713 ;;
5714 ;; The first move is to implement a way to obtain the smallest element
5715 ;; containing point. This is the job of `org-element-at-point'. It
5716 ;; basically jumps back to the beginning of section containing point
5717 ;; and proceed, one element after the other, with
5718 ;; `org-element--current-element' until the container is found. Note:
5719 ;; When using `org-element-at-point', secondary values are never
5720 ;; parsed since the function focuses on elements, not on objects.
5721 ;;
5722 ;; At a deeper level, `org-element-context' lists all elements and
5723 ;; objects containing point.
5724 ;;
5725 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5726 ;; internally by navigation and manipulation tools.
5729 ;;;###autoload
5731 "Determine closest element around point.
5733 Return value is a list like (TYPE PROPS) where TYPE is the type
5734 of the element and PROPS a plist of properties associated to the
5735 element.
5737 Possible types are defined in `org-element-all-elements'.
5738 Properties depend on element or object type, but always include
5739 `:begin', `:end', `:parent' and `:post-blank' properties.
5741 As a special case, if point is at the very beginning of the first
5742 item in a list or sub-list, returned element will be that list
5743 instead of the item. Likewise, if point is at the beginning of
5744 the first row of a table, returned element will be the table
5745 instead of the first row.
5747 When point is at the end of the buffer, return the innermost
5748 element ending there."
5754 ;; Within blank lines at the beginning of buffer, return nil.
5756 ;; Within blank lines right after a headline, return that
5757 ;; headline.
5761 ;; Otherwise parse until we find element containing ORIGIN.
5768 ;;;###autoload
5770 "Return smallest element or object around point.
5772 Return value is a list like (TYPE PROPS) where TYPE is the type
5773 of the element or object and PROPS a plist of properties
5774 associated to it.
5776 Possible types are defined in `org-element-all-elements' and
5777 `org-element-all-objects'. Properties depend on element or
5778 object type, but always include `:begin', `:end', `:parent' and
5779 `:post-blank'.
5781 As a special case, if point is right after an object and not at
5782 the beginning of any other object, return that object.
5784 Optional argument ELEMENT, when non-nil, is the closest element
5785 containing point, as returned by `org-element-at-point'.
5786 Providing it allows for quicker computation."
5793 ;; If point is inside an element containing objects or
5794 ;; a secondary string, narrow buffer to the container and
5795 ;; proceed with parsing. Otherwise, return ELEMENT.
5797 ;; At a parsed affiliated keyword, check if we're inside main
5798 ;; or dual value.
5804 org-element-parsed-keywords))
5813 ;; Also change type to retrieve correct restrictions.
5815 ;; At an item, objects can only be located within tag, if any.
5826 ;; At an headline or inlinetask, objects are in title.
5838 ;; At a paragraph, a table-row or a verse block, objects are
5839 ;; located within their contents.
5843 ;; CBEG is nil for table rules.
5852 last)
5857 ;; Process NEXT, if any, in order to know if we need to
5858 ;; skip it, return it or move into it.
5865 ;; Skip objects ending before point. Also skip
5866 ;; objects ending at point unless it is also the
5867 ;; end of buffer, since we want to return the
5868 ;; innermost object.
5871 ;; For convenience, when object ends at POS,
5872 ;; without any space, store it in LAST, as we
5873 ;; will return it if no object starts here.
5877 ;; If POS is within a container object, move into
5878 ;; that object.
5882 ;; At contents' end, if there is no
5883 ;; space before point, also move into
5884 ;; object, for consistency with
5885 ;; convenience feature above.
5894 ;; Otherwise, return NEXT.
5898 "List all ancestors of a given element or object.
5900 DATUM is an object or element.
5902 Return ancestors from the closest to the farthest. When optional
5903 argument TYPES is a list of symbols, return the first element or
5904 object in the lineage whose type belongs to that list instead.
5906 When optional argument WITH-SELF is non-nil, lineage includes
5907 DATUM itself as the first element, and TYPES, if provided, also
5908 apply to it.
5910 When DATUM is obtained through `org-element-context' or
5911 `org-element-at-point', only ancestors from its section can be
5912 found. There is no such limitation when DATUM belongs to a full
5913 parse tree."
5915 ancestors)
5922 "Non-nil when elements ELEM-A and ELEM-B are nested."
5931 "Swap elements ELEM-A and ELEM-B.
5932 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5933 end of ELEM-A."
5935 ;; There are two special cases when an element doesn't start at bol:
5936 ;; the first paragraph in an item or in a footnote definition.
5938 ;; Only a paragraph without any affiliated keyword can be moved at
5939 ;; ELEM-A position in such a situation. Note that the case of
5940 ;; a footnote definition is impossible: it cannot contain two
5941 ;; paragraphs in a row because it cannot contain a blank line.
5947 ;; In a special situation, ELEM-A will have no indentation. We'll
5948 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5962 ;; Store inner overlays responsible for visibility status.
5963 ;; We also need to store their boundaries as they will be
5964 ;; removed from buffer.
5979 ;; Get contents.
5987 ;; Restore ex ELEM-A overlays.
5994 ;; Restore ex ELEM-B overlays.
6002 ;; Local variables:
6003 ;; generated-autoload-file: "org-loaddefs.el"
6004 ;; End:
6006 ;;; org-element.el ends here