| blob | 488d1192f3958bbbb85ca84e9a908fcaa0daca97 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `fixed-width',
49 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
50 ;; `paragraph', `planning', `src-block', `table', `table-row' and
51 ;; `verse-block'. Among them, `paragraph' and `verse-block' types can
52 ;; contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, All elements have a `:post-affiliated'
77 ;; property referring to the buffer position after all affiliated
78 ;; keywords, if any, or to their beginning position otherwise.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block fixed-width footnote-definition
177 headline horizontal-rule inlinetask item keyword
178 latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block section special-block
180 src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 inline-src-block italic line-break latex-fragment link macro
192 radio-target statistics-cookie strike-through subscript superscript
193 table-cell target timestamp underline verbatim)
198 superscript table-cell underline)
208 "Alist between block names and the associated parsing function.
209 Names must be uppercase. Any block whose name has no association
215 Only these types can accept search options and an explicit
221 "List of affiliated keywords as strings.
229 "Alist of usual translations for keywords.
230 The key is the old name and the value the new one. The property
234 "List of affiliated keywords that can occur more than once in an element.
236 Their value will be consed into a list of strings, which will be
237 returned as the value of the property.
239 This list is checked after translations have been applied. See
240 `org-element-keyword-translation-alist'.
246 "List of affiliated keywords whose value can be parsed.
248 Their value will be stored as a secondary string: a list of
249 strings and objects.
251 This list is checked after translations have been applied. See
255 "List of affiliated keywords which can have a secondary value.
257 In Org syntax, they can be written with optional square brackets
258 before the colons. For example, RESULTS keyword can be
259 associated to a hash value with the following:
261 #+RESULTS[hash-string]: some-source
263 This list is checked after translations have been applied. See
267 "List of properties associated to the whole document.
268 Any keyword in this list will have its value parsed and stored as
274 ;; Dual affiliated keywords.
278 ;; Regular affiliated keywords.
284 org-element-affiliated-keywords)))
286 ;; Export attributes.
288 "Regexp matching any affiliated keyword.
290 Keyword name is put in match group 1. Moreover, if keyword
291 belongs to `org-element-dual-keywords', put the dual value in
292 match group 2.
306 ;; Ignore all links excepted plain links in a link description.
307 ;; Also ignore radio-targets and line breaks.
309 italic latex-fragment macro plain-link statistics-cookie
310 strike-through subscript superscript underline verbatim)
312 ;; Remove any variable object from radio target as it would
313 ;; prevent it from being properly recognized.
315 subscript superscript underline superscript)
319 ;; Ignore inline babel call and inline src block as formulas are
320 ;; possible. Also ignore line breaks and statistics cookies.
322 latex-fragment link macro radio-target strike-through
323 subscript superscript target timestamp underline verbatim)
327 "Alist of objects restrictions.
329 key is an element or object type containing objects and value is
330 a list of types that can be contained within an element or object
331 of such type.
333 For example, in a `radio-target' object, one can only find
334 entities, latex-fragments, subscript, superscript and text
335 markup.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
348 \f
349 ;;; Accessors and Setters
350 ;;
351 ;; Provide four accessors: `org-element-type', `org-element-property'
352 ;; `org-element-contents' and `org-element-restriction'.
353 ;;
354 ;; Setter functions allow to modify elements by side effect. There is
355 ;; `org-element-put-property', `org-element-set-contents'. These
356 ;; low-level functions are useful to build a parse tree.
357 ;;
358 ;; `org-element-adopt-element', `org-element-set-element',
359 ;; `org-element-extract-element' and `org-element-insert-before' are
360 ;; high-level functions useful to modify a parse tree.
361 ;;
362 ;; `org-element-secondary-p' is a predicate used to know if a given
363 ;; object belongs to a secondary string.
366 "Return type of ELEMENT.
368 The function returns the type of the element or object provided.
369 It can also return the following special value:
370 `plain-text' for a string
371 `org-data' for a complete document
372 nil in any other case."
378 "Extract the value from the PROPERTY of an ELEMENT."
383 "Extract contents from an ELEMENT."
389 "Return restriction associated to ELEMENT.
390 ELEMENT can be an element, an object or a symbol representing an
391 element or object type."
393 org-element-object-restrictions)))
396 "In ELEMENT set PROPERTY to VALUE.
397 Return modified element."
400 element))
403 "Set ELEMENT contents to CONTENTS.
404 Return modified element."
411 "Non-nil when OBJECT belongs to a secondary string.
412 Return value is the property name, as a keyword, or nil."
415 org-element-secondary-value-alist))))
418 property)))
421 "Append elements to the contents of another element.
423 PARENT is an element or object. CHILDREN can be elements,
424 objects, or a strings.
426 The function takes care of setting `:parent' property for CHILD.
427 Return parent element."
428 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
429 ;; string: parent is the list itself.
432 children)
433 ;; Add CHILDREN at the end of PARENT contents.
436 parent
438 ;; Return modified PARENT element.
442 "Extract ELEMENT from parse tree.
443 Remove element from the parse tree by side-effect, and return it
444 with its `:parent' property stripped out."
449 parent secondary
452 parent
454 ;; Return ELEMENT with its :parent removed.
458 "Insert ELEMENT before LOCATION in parse tree.
459 LOCATION is an element, object or string within the parse tree.
460 Parse tree is modified by side effect."
465 ;; Special case: LOCATION is the first element of an
466 ;; independent secondary string (e.g. :title property). Add
467 ;; ELEMENT in-place.
471 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
481 ;; Store SIBLINGS at appropriate place in parse tree.
486 ;; Set appropriate :parent property.
490 "Replace element or object OLD with element or object NEW.
491 The function takes care of setting `:parent' property for NEW."
492 ;; Ensure OLD and NEW have the same parent.
496 ;; We cannot replace OLD with NEW since one of them is not an
497 ;; object or element. We take the long path.
500 ;; Since OLD is going to be changed into NEW by side-effect, first
501 ;; make sure that every element or object within NEW has OLD as
502 ;; parent.
505 ;; Transfer contents.
507 ;; Overwrite OLD's properties with NEW's.
509 ;; Transfer type.
513 \f
514 ;;; Greater elements
515 ;;
516 ;; For each greater element type, we define a parser and an
517 ;; interpreter.
518 ;;
519 ;; A parser returns the element or object as the list described above.
520 ;; Most of them accepts no argument. Though, exceptions exist. Hence
521 ;; every element containing a secondary string (see
522 ;; `org-element-secondary-value-alist') will accept an optional
523 ;; argument to toggle parsing of that secondary string. Moreover,
524 ;; `item' parser requires current list's structure as its first
525 ;; element.
526 ;;
527 ;; An interpreter accepts two arguments: the list representation of
528 ;; the element or object, and its contents. The latter may be nil,
529 ;; depending on the element or object considered. It returns the
530 ;; appropriate Org syntax, as a string.
531 ;;
532 ;; Parsing functions must follow the naming convention:
533 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
534 ;; defined in `org-element-greater-elements'.
535 ;;
536 ;; Similarly, interpreting functions must follow the naming
537 ;; convention: org-element-TYPE-interpreter.
538 ;;
539 ;; With the exception of `headline' and `item' types, greater elements
540 ;; cannot contain other greater elements of their own type.
541 ;;
542 ;; Beside implementing a parser and an interpreter, adding a new
543 ;; greater element requires to tweak `org-element--current-element'.
544 ;; Moreover, the newly defined type must be added to both
545 ;; `org-element-all-elements' and `org-element-greater-elements'.
548 ;;;; Center Block
551 "Parse a center block.
553 LIMIT bounds the search. AFFILIATED is a list of which CAR is
554 the buffer position at the beginning of the first affiliated
555 keyword and CDR is a plist of affiliated keywords along with
556 their value.
558 Return a list whose CAR is `center-block' and CDR is a plist
559 containing `:begin', `:end', `:contents-begin', `:contents-end',
560 `:post-blank' and `:post-affiliated' keywords.
562 Assume point is at the beginning of the block."
566 ;; Incomplete block: parse it as a paragraph.
571 ;; Empty blocks have no contents.
585 :end end
586 :contents-begin contents-begin
587 :contents-end contents-end
593 "Interpret CENTER-BLOCK element as Org syntax.
594 CONTENTS is the contents of the element."
598 ;;;; Drawer
601 "Parse a drawer.
603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
604 the buffer position at the beginning of the first affiliated
605 keyword and CDR is a plist of affiliated keywords along with
606 their value.
608 Return a list whose CAR is `drawer' and CDR is a plist containing
609 `:drawer-name', `:begin', `:end', `:contents-begin',
610 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
612 Assume point is at beginning of drawer."
615 ;; Incomplete drawer: parse it as a paragraph.
623 ;; Empty drawers have no contents.
636 :end end
637 :drawer-name name
638 :contents-begin contents-begin
639 :contents-end contents-end
645 "Interpret DRAWER element as Org syntax.
646 CONTENTS is the contents of the element."
649 contents))
652 ;;;; Dynamic Block
655 "Parse a dynamic block.
657 LIMIT bounds the search. AFFILIATED is a list of which CAR is
658 the buffer position at the beginning of the first affiliated
659 keyword and CDR is a plist of affiliated keywords along with
660 their value.
662 Return a list whose CAR is `dynamic-block' and CDR is a plist
663 containing `:block-name', `:begin', `:end', `:contents-begin',
664 `:contents-end', `:arguments', `:post-blank' and
665 `:post-affiliated' keywords.
667 Assume point is at beginning of dynamic block."
671 ;; Incomplete block: parse it as a paragraph.
680 ;; Empty blocks have no contents.
693 :end end
694 :block-name name
695 :arguments arguments
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret DYNAMIC-BLOCK element as Org syntax.
704 CONTENTS is the contents of the element."
709 contents))
712 ;;;; Footnote Definition
715 "Parse a footnote definition.
717 LIMIT bounds the search. AFFILIATED is a list of which CAR is
718 the buffer position at the beginning of the first affiliated
719 keyword and CDR is a plist of affiliated keywords along with
720 their value.
722 Return a list whose CAR is `footnote-definition' and CDR is
723 a plist containing `:label', `:begin' `:end', `:contents-begin',
724 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
726 Assume point is at the beginning of the footnote definition."
754 :begin begin
755 :end end
756 :contents-begin contents-begin
757 :contents-end contents-end
763 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
764 CONTENTS is the contents of the footnote-definition."
766 " "
767 contents))
770 ;;;; Headline
773 "Parse a headline.
775 Return a list whose CAR is `headline' and CDR is a plist
776 containing `:raw-value', `:title', `:alt-title', `:begin',
777 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
778 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
779 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
780 `:footnote-section-p', `:post-blank' and `:post-affiliated'
781 keywords.
783 The plist also contains any property set in the property drawer,
784 with its name in upper cases and colons added at the
785 beginning (e.g., `:CUSTOM_ID').
787 LIMIT is a buffer position bounding the search.
789 When RAW-SECONDARY-P is non-nil, headline's title will not be
790 parsed as a secondary string, but as a plain string instead.
792 Assume point is at beginning of the headline."
805 raw-value)))
810 ;; Find property drawer associated to current headline and
811 ;; extract properties.
812 ;;
813 ;; Upcase property names. It avoids confusion between
814 ;; properties obtained through property drawer and default
815 ;; properties from the parser (e.g. `:end' and :END:)
819 plist)
825 ;; Make sure drawer is not associated
826 ;; to an inlinetask.
840 plist
845 plist)))
847 ;; Read time properties on the line below the headline.
853 org-keyword-time-not-clock-regexp end t)
863 plist))))
875 ;; Clean RAW-VALUE from any comment string.
881 ""
882 raw-value))))
883 ;; Clean TAGS from archive tag, if any.
889 :begin begin
890 :end end
891 :pre-blank
894 :contents-begin contents-begin
895 :contents-end contents-end
896 :level level
898 :tags tags
899 :todo-keyword todo
900 :todo-type todo-type
903 end)
904 :footnote-section-p footnote-section-p
905 :archivedp archivedp
906 :commentedp commentedp
908 time-props
909 standard-props))))
913 headline :alt-title
918 headline :title
924 "Interpret HEADLINE element as Org syntax.
925 CONTENTS is the contents of the element."
941 ?*)
945 " "
948 org-footnote-section
949 title))))
951 heading
952 ;; Align tags.
960 ?\s)
961 tags))
965 tags))))
967 contents)))
970 ;;;; Inlinetask
973 "Parse an inline task.
975 Return a list whose CAR is `inlinetask' and CDR is a plist
976 containing `:title', `:begin', `:end', `:contents-begin' and
977 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
978 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
979 `:closed', `:post-blank' and `:post-affiliated' keywords.
981 The plist also contains any property set in the property drawer,
982 with its name in upper cases and colons added at the
983 beginning (e.g., `:CUSTOM_ID').
985 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
986 title will not be parsed as a secondary string, but as a plain
987 string instead.
989 Assume point is at beginning of the inline task."
1005 ;; Read time properties on the line below the inlinetask
1006 ;; opening string.
1013 org-keyword-time-not-clock-regexp end t)
1023 plist)))))
1034 ;; Find property drawer associated to current inlinetask
1035 ;; and extract properties.
1036 ;;
1037 ;; HACK: Calling `org-element-at-point' triggers a parsing
1038 ;; of this inlinetask and, thus, an infloop. To avoid the
1039 ;; problem, we extract contents of the inlinetask and
1040 ;; parse them in a new buffer.
1041 ;;
1042 ;; Upcase property names. It avoids confusion between
1043 ;; properties obtained through property drawer and default
1044 ;; properties from the parser (e.g. `:end' and :END:)
1047 plist)
1054 org-property-start-re task-end t))
1064 plist
1069 plist)))
1074 :begin begin
1075 :end end
1076 :contents-begin contents-begin
1077 :contents-end contents-end
1080 :tags tags
1081 :todo-keyword todo
1082 :todo-type todo-type
1085 time-props
1086 standard-props))))
1088 inlinetask :title
1091 raw-value
1093 inlinetask))))))
1096 "Interpret INLINETASK element as Org syntax.
1097 CONTENTS is the contents of inlinetask."
1112 ;; Align tags.
1120 ? )
1121 tags))
1125 tags))))
1126 ;; Prefer degenerate inlinetasks when there are no
1127 ;; contents.
1130 contents
1134 ;;;; Item
1137 "Parse an item.
1139 STRUCT is the structure of the plain list.
1141 Return a list whose CAR is `item' and CDR is a plist containing
1142 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1143 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1144 `:post-affiliated' keywords.
1146 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1147 any, will not be parsed as a secondary string, but as a plain
1148 string instead.
1150 Assume point is at the beginning of the item."
1174 ;; Ignore tags in un-ordered lists: they are just
1175 ;; a part of item's body.
1181 ;; If first line isn't empty, contents really start
1182 ;; at the text after item's meta-data.
1191 :begin begin
1192 :end end
1193 ;; CONTENTS-BEGIN and CONTENTS-END may be
1194 ;; mixed up in the case of an empty item
1195 ;; separated from the next by a blank line.
1196 ;; Thus ensure the former is always the
1197 ;; smallest.
1200 :checkbox checkbox
1201 :counter counter
1202 :structure struct
1206 item :tag
1214 "Interpret ITEM element as Org syntax.
1215 CONTENTS is the contents of the element."
1225 ;; Compute indentation.
1230 ;; Indent contents.
1232 bullet
1246 ;;;; Plain List
1249 ;; Return structure of list at point. Internal function. See
1250 ;; `org-list-struct' for details.
1255 items struct)
1260 ;; At limit: end all items.
1269 ;; At list end: end all items.
1274 ;; At a new item: end previous sibling.
1286 ind
1287 bullet
1290 ;; Description tag.
1294 ;; Ending position, unknown so far.
1295 nil)))
1296 items))
1298 ;; Skip empty lines.
1300 ;; Skip inline tasks and blank lines along the way.
1307 ;; At some text line. Check if it ends any previous item.
1319 ;; Skip blocks (any type) and drawers contents.
1324 limit t)))
1330 "Parse a plain list.
1332 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1333 the buffer position at the beginning of the first affiliated
1334 keyword and CDR is a plist of affiliated keywords along with
1335 their value. STRUCTURE is the structure of the plain list being
1336 parsed.
1338 Return a list whose CAR is `plain-list' and CDR is a plist
1339 containing `:type', `:begin', `:end', `:contents-begin' and
1340 `:contents-end', `:structure', `:post-blank' and
1341 `:post-affiliated' keywords.
1343 Assume point is at the beginning of the list."
1357 pos))
1361 ;; Return value.
1365 :begin begin
1366 :end end
1367 :contents-begin contents-begin
1368 :contents-end contents-end
1369 :structure struct
1375 "Interpret PLAIN-LIST element as Org syntax.
1376 CONTENTS is the contents of the element."
1384 ;;;; Property Drawer
1387 "Parse a property drawer.
1389 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1390 the buffer position at the beginning of the first affiliated
1391 keyword and CDR is a plist of affiliated keywords along with
1392 their value.
1394 Return a list whose CAR is `property-drawer' and CDR is a plist
1395 containing `:begin', `:end', `:contents-begin', `:contents-end',
1396 `:post-blank' and `:post-affiliated' keywords.
1398 Assume point is at the beginning of the property drawer."
1403 ;; Incomplete drawer: parse it as a paragraph.
1421 :end end
1422 :contents-begin contents-begin
1423 :contents-end contents-end
1429 "Interpret PROPERTY-DRAWER element as Org syntax.
1430 CONTENTS is the properties within the drawer."
1434 ;;;; Quote Block
1437 "Parse a quote block.
1439 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1440 the buffer position at the beginning of the first affiliated
1441 keyword and CDR is a plist of affiliated keywords along with
1442 their value.
1444 Return a list whose CAR is `quote-block' and CDR is a plist
1445 containing `:begin', `:end', `:contents-begin', `:contents-end',
1446 `:post-blank' and `:post-affiliated' keywords.
1448 Assume point is at the beginning of the block."
1452 ;; Incomplete block: parse it as a paragraph.
1458 ;; Empty blocks have no contents.
1471 :end end
1472 :contents-begin contents-begin
1473 :contents-end contents-end
1479 "Interpret QUOTE-BLOCK element as Org syntax.
1480 CONTENTS is the contents of the element."
1484 ;;;; Section
1487 "Parse a section.
1489 LIMIT bounds the search.
1491 Return a list whose CAR is `section' and CDR is a plist
1492 containing `:begin', `:end', `:contents-begin', `contents-end',
1493 `:post-blank' and `:post-affiliated' keywords."
1495 ;; Beginning of section is the beginning of the first non-blank
1496 ;; line after previous headline.
1505 :end end
1506 :contents-begin begin
1507 :contents-end pos-before-blank
1512 "Interpret SECTION element as Org syntax.
1513 CONTENTS is the contents of the element."
1514 contents)
1517 ;;;; Special Block
1520 "Parse a special block.
1522 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1523 the buffer position at the beginning of the first affiliated
1524 keyword and CDR is a plist of affiliated keywords along with
1525 their value.
1527 Return a list whose CAR is `special-block' and CDR is a plist
1528 containing `:type', `:raw-value', `:begin', `:end',
1529 `:contents-begin', `:contents-end', `:post-blank' and
1530 `:post-affiliated' keywords.
1532 Assume point is at the beginning of the block."
1539 limit t)))
1540 ;; Incomplete block: parse it as a paragraph.
1546 ;; Empty blocks have no contents.
1559 :raw-value
1562 contents-begin contents-end))
1563 :begin begin
1564 :end end
1565 :contents-begin contents-begin
1566 :contents-end contents-end
1572 "Interpret SPECIAL-BLOCK element as Org syntax.
1573 CONTENTS is the contents of the element."
1578 \f
1579 ;;; Elements
1580 ;;
1581 ;; For each element, a parser and an interpreter are also defined.
1582 ;; Both follow the same naming convention used for greater elements.
1583 ;;
1584 ;; Also, as for greater elements, adding a new element type is done
1585 ;; through the following steps: implement a parser and an interpreter,
1586 ;; tweak `org-element--current-element' so that it recognizes the new
1587 ;; type and add that new type to `org-element-all-elements'.
1588 ;;
1589 ;; As a special case, when the newly defined type is a block type,
1590 ;; `org-element-block-name-alist' has to be modified accordingly.
1593 ;;;; Babel Call
1596 "Parse a babel call.
1598 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1599 the buffer position at the beginning of the first affiliated
1600 keyword and CDR is a plist of affiliated keywords along with
1601 their value.
1603 Return a list whose CAR is `babel-call' and CDR is a plist
1604 containing `:begin', `:end', `:value', `:post-blank' and
1605 `:post-affiliated' as keywords."
1619 :end end
1620 :value value
1626 "Interpret BABEL-CALL element as Org syntax.
1627 CONTENTS is nil."
1631 ;;;; Clock
1634 "Parse a clock.
1636 LIMIT bounds the search.
1638 Return a list whose CAR is `clock' and CDR is a plist containing
1639 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1640 `:post-affiliated' as keywords."
1660 :value value
1661 :duration duration
1662 :begin begin
1663 :end end
1664 :post-blank post-blank
1668 "Interpret CLOCK element as Org syntax.
1669 CONTENTS is nil."
1677 "%2s:%02s"
1681 ;;;; Comment
1684 "Parse a comment.
1686 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1687 the buffer position at the beginning of the first affiliated
1688 keyword and CDR is a plist of affiliated keywords along with
1689 their value.
1691 Return a list whose CAR is `comment' and CDR is a plist
1692 containing `:begin', `:end', `:value', `:post-blank',
1693 `:post-affiliated' keywords.
1695 Assume point is at comment beginning."
1704 ;; Get comments ending.
1707 ;; Accumulate lines without leading hash and first
1708 ;; whitespace.
1722 :end end
1723 :value value
1729 "Interpret COMMENT element as Org syntax.
1730 CONTENTS is nil."
1734 ;;;; Comment Block
1737 "Parse an export block.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `comment-block' and CDR is a plist
1745 containing `:begin', `:end', `:value', `:post-blank' and
1746 `:post-affiliated' keywords.
1748 Assume point is at comment block beginning."
1752 ;; Incomplete block: parse it as a paragraph.
1765 contents-begin contents-end)))
1769 :end end
1770 :value value
1776 "Interpret COMMENT-BLOCK element as Org syntax.
1777 CONTENTS is nil."
1784 ;;;; Diary Sexp
1787 "Parse a diary sexp.
1789 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1790 the buffer position at the beginning of the first affiliated
1791 keyword and CDR is a plist of affiliated keywords along with
1792 their value.
1794 Return a list whose CAR is `diary-sexp' and CDR is a plist
1795 containing `:begin', `:end', `:value', `:post-blank' and
1796 `:post-affiliated' keywords."
1808 :begin begin
1809 :end end
1815 "Interpret DIARY-SEXP as Org syntax.
1816 CONTENTS is nil."
1820 ;;;; Example Block
1823 "Parse an example block.
1825 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1826 the buffer position at the beginning of the first affiliated
1827 keyword and CDR is a plist of affiliated keywords along with
1828 their value.
1830 Return a list whose CAR is `example-block' and CDR is a plist
1831 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1832 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1833 `:value', `:post-blank' and `:post-affiliated' keywords."
1837 ;; Incomplete block: parse it as a paragraph.
1845 ;; Switches analysis
1852 ;; Should labels be retained in (or stripped from) example
1853 ;; blocks?
1858 ;; What should code-references use - labels or
1859 ;; line-numbers?
1868 ;; Standard block parsing.
1876 contents-begin contents-end))
1877 block-ind))
1886 :end end
1887 :value value
1888 :switches switches
1889 :number-lines number-lines
1890 :preserve-indent preserve-indent
1891 :retain-labels retain-labels
1892 :use-labels use-labels
1893 :label-fmt label-fmt
1899 "Interpret EXAMPLE-BLOCK element as Org syntax.
1900 CONTENTS is nil."
1908 value
1913 ;;;; Fixed-width
1916 "Parse a fixed-width section.
1918 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1919 the buffer position at the beginning of the first affiliated
1920 keyword and CDR is a plist of affiliated keywords along with
1921 their value.
1923 Return a list whose CAR is `fixed-width' and CDR is a plist
1924 containing `:begin', `:end', `:value', `:post-blank' and
1925 `:post-affiliated' keywords.
1927 Assume point is at the beginning of the fixed-width area."
1931 value
1936 ;; Accumulate text without starting colons.
1949 :end end
1950 :value value
1956 "Interpret FIXED-WIDTH element as Org syntax.
1957 CONTENTS is nil."
1965 ;;;; Horizontal Rule
1968 "Parse an horizontal rule.
1970 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1971 the buffer position at the beginning of the first affiliated
1972 keyword and CDR is a plist of affiliated keywords along with
1973 their value.
1975 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1976 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1977 keywords."
1987 :end end
1993 "Interpret HORIZONTAL-RULE element as Org syntax.
1994 CONTENTS is nil."
1998 ;;;; Keyword
2001 "Parse a keyword at point.
2003 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2004 the buffer position at the beginning of the first affiliated
2005 keyword and CDR is a plist of affiliated keywords along with
2006 their value.
2008 Return a list whose CAR is `keyword' and CDR is a plist
2009 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2010 `:post-affiliated' keywords."
2012 ;; An orphaned affiliated keyword is considered as a regular
2013 ;; keyword. In this case AFFILIATED is nil, so we take care of
2014 ;; this corner case.
2027 :value value
2028 :begin begin
2029 :end end
2035 "Interpret KEYWORD element as Org syntax.
2036 CONTENTS is nil."
2042 ;;;; Latex Environment
2046 "Regexp matching the beginning of a LaTeX environment.
2047 The environment is captured by the first group.
2053 "Format string matching the ending of a LaTeX environment.
2057 "Parse a LaTeX environment.
2059 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2060 the buffer position at the beginning of the first affiliated
2061 keyword and CDR is a plist of affiliated keywords along with
2062 their value.
2064 Return a list whose CAR is `latex-environment' and CDR is a plist
2065 containing `:begin', `:end', `:value', `:post-blank' and
2066 `:post-affiliated' keywords.
2068 Assume point is at the beginning of the latex environment."
2075 limit t))
2076 ;; Incomplete latex environment: parse it as a paragraph.
2086 :end end
2087 :value value
2093 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2094 CONTENTS is nil."
2098 ;;;; Node Property
2101 "Parse a node-property at point.
2103 LIMIT bounds the search.
2105 Return a list whose CAR is `node-property' and CDR is a plist
2106 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2107 `:post-affiliated' keywords."
2119 :value value
2120 :begin begin
2121 :end end
2126 "Interpret NODE-PROPERTY element as Org syntax.
2127 CONTENTS is nil."
2133 ;;;; Paragraph
2136 "Parse a paragraph.
2138 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2139 the buffer position at the beginning of the first affiliated
2140 keyword and CDR is a plist of affiliated keywords along with
2141 their value.
2143 Return a list whose CAR is `paragraph' and CDR is a plist
2144 containing `:begin', `:end', `:contents-begin' and
2145 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2147 Assume point is at the beginning of the paragraph."
2156 limit
2157 ;; A matching `org-element-paragraph-separate' is not
2158 ;; necessarily the end of the paragraph. In
2159 ;; particular, lines starting with # or : as a first
2160 ;; non-space character are ambiguous. We have to
2161 ;; check if they are valid Org syntax (e.g., not an
2162 ;; incomplete keyword).
2166 ;; There's no ambiguity for other symbols or
2167 ;; empty lines: stop here.
2169 ;; Stop at valid fixed-width areas.
2171 ;; Stop at drawers.
2176 ;; Stop at valid comments.
2178 ;; Stop at valid dynamic blocks.
2183 ;; Stop at valid blocks.
2190 limit t)))
2191 ;; Stop at valid latex environments.
2198 limit t)))
2199 ;; Stop at valid keywords.
2201 ;; Skip everything else.
2218 :end end
2219 :contents-begin contents-begin
2220 :contents-end contents-end
2226 "Interpret PARAGRAPH element as Org syntax.
2227 CONTENTS is the contents of the element."
2228 contents)
2231 ;;;; Planning
2234 "Parse a planning.
2236 LIMIT bounds the search.
2238 Return a list whose CAR is `planning' and CDR is a plist
2239 containing `:closed', `:deadline', `:scheduled', `:begin',
2240 `:end', `:post-blank' and `:post-affiliated' keywords."
2250 closed deadline scheduled)
2262 :deadline deadline
2263 :scheduled scheduled
2264 :begin begin
2265 :end end
2266 :post-blank post-blank
2270 "Interpret PLANNING element as Org syntax.
2271 CONTENTS is nil."
2273 'identity
2290 ;;;; Src Block
2293 "Parse a src block.
2295 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2296 the buffer position at the beginning of the first affiliated
2297 keyword and CDR is a plist of affiliated keywords along with
2298 their value.
2300 Return a list whose CAR is `src-block' and CDR is a plist
2301 containing `:language', `:switches', `:parameters', `:begin',
2302 `:end', `:number-lines', `:retain-labels', `:use-labels',
2303 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2304 `:post-affiliated' keywords.
2306 Assume point is at the beginning of the block."
2309 limit t)))
2310 ;; Incomplete block: parse it as a paragraph.
2316 ;; Get language as a string.
2325 ;; Get switches.
2327 ;; Get parameters.
2329 ;; Switches analysis
2340 ;; Should labels be retained in (or stripped from)
2341 ;; src blocks?
2346 ;; What should code-references use - labels or
2347 ;; line-numbers?
2352 ;; Indentation.
2354 ;; Retrieve code.
2359 block-ind))
2363 ;; Get position after ending blank lines.
2373 :begin begin
2374 :end end
2375 :number-lines number-lines
2376 :preserve-indent preserve-indent
2377 :retain-labels retain-labels
2378 :use-labels use-labels
2379 :label-fmt label-fmt
2380 :value value
2386 "Interpret SRC-BLOCK element as Org syntax.
2387 CONTENTS is nil."
2396 val)
2410 ;;;; Table
2413 "Parse a table at point.
2415 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2416 the buffer position at the beginning of the first affiliated
2417 keyword and CDR is a plist of affiliated keywords along with
2418 their value.
2420 Return a list whose CAR is `table' and CDR is a plist containing
2421 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2422 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2423 keywords.
2425 Assume point is at the beginning of the table."
2439 acc))
2446 :end end
2447 :type type
2448 :tblfm tblfm
2449 ;; Only `org' tables have contents. `table.el' tables
2450 ;; use a `:value' property to store raw table as
2451 ;; a string.
2456 table-begin table-end))
2462 "Interpret TABLE element as Org syntax.
2463 CONTENTS is a string, if table's type is `org', or nil."
2474 ;;;; Table Row
2477 "Parse table row at point.
2479 LIMIT bounds the search.
2481 Return a list whose CAR is `table-row' and CDR is a plist
2482 containing `:begin', `:end', `:contents-begin', `:contents-end',
2483 `:type', `:post-blank' and `:post-affiliated' keywords."
2487 ;; A table rule has no contents. In that case, ensure
2488 ;; CONTENTS-BEGIN matches CONTENTS-END.
2500 :begin begin
2501 :end end
2502 :contents-begin contents-begin
2503 :contents-end contents-end
2508 "Interpret TABLE-ROW element as Org syntax.
2509 CONTENTS is the contents of the table row."
2514 ;;;; Verse Block
2517 "Parse a verse block.
2519 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2520 the buffer position at the beginning of the first affiliated
2521 keyword and CDR is a plist of affiliated keywords along with
2522 their value.
2524 Return a list whose CAR is `verse-block' and CDR is a plist
2525 containing `:begin', `:end', `:contents-begin', `:contents-end',
2526 `:post-blank' and `:post-affiliated' keywords.
2528 Assume point is at beginning of the block."
2532 ;; Incomplete block: parse it as a paragraph.
2547 :end end
2548 :contents-begin contents-begin
2549 :contents-end contents-end
2555 "Interpret VERSE-BLOCK element as Org syntax.
2556 CONTENTS is verse block contents."
2560 \f
2561 ;;; Objects
2562 ;;
2563 ;; Unlike to elements, raw text can be found between objects. Hence,
2564 ;; `org-element--object-lex' is provided to find the next object in
2565 ;; buffer.
2566 ;;
2567 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2568 ;; object types they can contain will be specified in
2569 ;; `org-element-object-restrictions'.
2570 ;;
2571 ;; Creating a new type of object requires to alter
2572 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2573 ;; new type in `org-element-all-objects', and possibly add
2574 ;; restrictions in `org-element-object-restrictions'.
2576 ;;;; Bold
2579 "Parse bold object at point, if any.
2581 When at a bold object, return a list whose car is `bold' and cdr
2582 is a plist with `:begin', `:end', `:contents-begin' and
2583 `:contents-end' and `:post-blank' keywords. Otherwise, return
2584 nil.
2586 Assume point is at the first star marker."
2598 :end end
2599 :contents-begin contents-begin
2600 :contents-end contents-end
2604 "Interpret BOLD object as Org syntax.
2605 CONTENTS is the contents of the object."
2609 ;;;; Code
2612 "Parse code object at point, if any.
2614 When at a code object, return a list whose car is `code' and cdr
2615 is a plist with `:value', `:begin', `:end' and `:post-blank'
2616 keywords. Otherwise, return nil.
2618 Assume point is at the first tilde marker."
2629 :begin begin
2630 :end end
2634 "Interpret CODE object as Org syntax.
2635 CONTENTS is nil."
2639 ;;;; Entity
2642 "Parse entity at point, if any.
2644 When at an entity, return a list whose car is `entity' and cdr
2645 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2646 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2647 `:post-blank' as keywords. Otherwise, return nil.
2649 Assume point is at the beginning of the entity."
2651 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2669 :begin begin
2670 :end end
2671 :use-brackets-p bracketsp
2675 "Interpret ENTITY object as Org syntax.
2676 CONTENTS is nil."
2682 ;;;; Export Snippet
2685 "Parse export snippet at point.
2687 When at an export snippet, return a list whose car is
2688 `export-snippet' and cdr a plist with `:begin', `:end',
2689 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2690 return nil.
2692 Assume point is at the beginning of the snippet."
2708 :value value
2709 :begin begin
2710 :end end
2714 "Interpret EXPORT-SNIPPET object as Org syntax.
2715 CONTENTS is nil."
2721 ;;;; Footnote Reference
2724 "Parse footnote reference at point, if any.
2726 When at a footnote reference, return a list whose car is
2727 `footnote-reference' and cdr a plist with `:label', `:type',
2728 `:begin', `:end', `:content-begin', `:contents-end' and
2729 `:post-blank' as keywords. Otherwise, return nil."
2753 :type type
2754 :begin begin
2755 :end end
2761 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2762 CONTENTS is its definition, when inline, or nil."
2768 ;;;; Inline Babel Call
2771 "Parse inline babel call at point, if any.
2773 When at an inline babel call, return a list whose car is
2774 `inline-babel-call' and cdr a plist with `:begin', `:end',
2775 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2777 Assume point is at the beginning of the babel call."
2789 :end end
2790 :value value
2794 "Interpret INLINE-BABEL-CALL object as Org syntax.
2795 CONTENTS is nil."
2799 ;;;; Inline Src Block
2802 "Parse inline source block at point, if any.
2804 When at an inline source block, return a list whose car is
2805 `inline-src-block' and cdr a plist with `:begin', `:end',
2806 `:language', `:value', `:parameters' and `:post-blank' as
2807 keywords. Otherwise, return nil.
2809 Assume point is at the beginning of the inline src block."
2822 :value value
2823 :parameters parameters
2824 :begin begin
2825 :end end
2829 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2830 CONTENTS is nil."
2835 language
2837 body)))
2839 ;;;; Italic
2842 "Parse italic object at point, if any.
2844 When at an italic object, return a list whose car is `italic' and
2845 cdr is a plist with `:begin', `:end', `:contents-begin' and
2846 `:contents-end' and `:post-blank' keywords. Otherwise, return
2847 nil.
2849 Assume point is at the first slash marker."
2861 :end end
2862 :contents-begin contents-begin
2863 :contents-end contents-end
2867 "Interpret ITALIC object as Org syntax.
2868 CONTENTS is the contents of the object."
2872 ;;;; Latex Fragment
2875 "Parse LaTeX fragment at point, if any.
2877 When at a LaTeX fragment, return a list whose car is
2878 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2879 and `:post-blank' as keywords. Otherwise, return nil.
2881 Assume point is at the beginning of the LaTeX fragment."
2899 ;; Macro.
2908 :begin begin
2909 :end end
2913 "Interpret LATEX-FRAGMENT object as Org syntax.
2914 CONTENTS is nil."
2917 ;;;; Line Break
2920 "Parse line break at point, if any.
2922 When at a line break, return a list whose car is `line-break',
2923 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2924 Otherwise, return nil.
2926 Assume point is at the beginning of the line break."
2935 "Interpret LINE-BREAK object as Org syntax.
2936 CONTENTS is nil."
2940 ;;;; Link
2943 "Parse link at point, if any.
2945 When at a link, return a list whose car is `link' and cdr a plist
2946 with `:type', `:path', `:raw-link', `:application',
2947 `:search-option', `:begin', `:end', `:contents-begin',
2948 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2949 nil.
2951 Assume point is at the beginning of the link."
2954 end contents-begin contents-end link-end post-blank path type
2955 raw-link link search-option application)
2957 ;; Type 1: Text targeted from a radio target.
2966 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2971 ;; RAW-LINK is the original link. Expand any
2972 ;; abbreviation in it.
2976 ;; Determine TYPE of link and set PATH accordingly.
2978 ;; File type.
2982 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2985 ;; According to RFC 3986, extra whitespace should be
2986 ;; ignored when a URI is extracted.
2989 ;; Id type: PATH is the id.
2992 ;; Code-ref type: PATH is the name of the reference.
2995 ;; Custom-id type: PATH is the name of the custom id.
2998 ;; Fuzzy type: Internal link either matches a target, an
2999 ;; headline name or nothing. PATH is the target or
3000 ;; headline's name.
3002 ;; Type 3: Plain link, e.g., http://orgmode.org
3008 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3016 ;; In any case, deduce end point after trailing white space from
3017 ;; LINK-END variable.
3021 ;; Special "file" type link processing.
3023 ;; Extract opening application and search option.
3031 ;; Normalize URI.
3035 ;; Make sure TYPE always reports "file".
3039 :path path
3041 :application application
3042 :search-option search-option
3043 :begin begin
3044 :end end
3045 :contents-begin contents-begin
3046 :contents-end contents-end
3050 "Interpret LINK object as Org syntax.
3051 CONTENTS is the contents of the object, or nil."
3056 raw-link
3060 ;;;; Macro
3063 "Parse macro at point, if any.
3065 When at a macro, return a list whose car is `macro' and cdr
3066 a plist with `:key', `:args', `:begin', `:end', `:value' and
3067 `:post-blank' as keywords. Otherwise, return nil.
3069 Assume point is at the macro."
3080 ;; Do not use `org-split-string' since empty
3081 ;; strings are meaningful here.
3089 args nil t)
3093 :value value
3094 :args args
3095 :begin begin
3096 :end end
3100 "Interpret MACRO object as Org syntax.
3101 CONTENTS is nil."
3105 ;;;; Radio-target
3108 "Parse radio target at point, if any.
3110 When at a radio target, return a list whose car is `radio-target'
3111 and cdr a plist with `:begin', `:end', `:contents-begin',
3112 `:contents-end', `:value' and `:post-blank' as keywords.
3113 Otherwise, return nil.
3115 Assume point is at the radio target."
3127 :end end
3128 :contents-begin contents-begin
3129 :contents-end contents-end
3130 :post-blank post-blank
3134 "Interpret TARGET object as Org syntax.
3135 CONTENTS is the contents of the object."
3139 ;;;; Statistics Cookie
3142 "Parse statistics cookie at point, if any.
3144 When at a statistics cookie, return a list whose car is
3145 `statistics-cookie', and cdr a plist with `:begin', `:end',
3146 `:value' and `:post-blank' keywords. Otherwise, return nil.
3148 Assume point is at the beginning of the statistics-cookie."
3159 :end end
3160 :value value
3164 "Interpret STATISTICS-COOKIE object as Org syntax.
3165 CONTENTS is nil."
3169 ;;;; Strike-Through
3172 "Parse strike-through object at point, if any.
3174 When at a strike-through object, return a list whose car is
3175 `strike-through' and cdr is a plist with `:begin', `:end',
3176 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3177 Otherwise, return nil.
3179 Assume point is at the first plus sign marker."
3191 :end end
3192 :contents-begin contents-begin
3193 :contents-end contents-end
3197 "Interpret STRIKE-THROUGH object as Org syntax.
3198 CONTENTS is the contents of the object."
3202 ;;;; Subscript
3205 "Parse subscript at point, if any.
3207 When at a subscript object, return a list whose car is
3208 `subscript' and cdr a plist with `:begin', `:end',
3209 `:contents-begin', `:contents-end', `:use-brackets-p' and
3210 `:post-blank' as keywords. Otherwise, return nil.
3212 Assume point is at the underscore."
3226 :end end
3227 :use-brackets-p bracketsp
3228 :contents-begin contents-begin
3229 :contents-end contents-end
3233 "Interpret SUBSCRIPT object as Org syntax.
3234 CONTENTS is the contents of the object."
3237 contents))
3240 ;;;; Superscript
3243 "Parse superscript at point, if any.
3245 When at a superscript object, return a list whose car is
3246 `superscript' and cdr a plist with `:begin', `:end',
3247 `:contents-begin', `:contents-end', `:use-brackets-p' and
3248 `:post-blank' as keywords. Otherwise, return nil.
3250 Assume point is at the caret."
3264 :end end
3265 :use-brackets-p bracketsp
3266 :contents-begin contents-begin
3267 :contents-end contents-end
3271 "Interpret SUPERSCRIPT object as Org syntax.
3272 CONTENTS is the contents of the object."
3275 contents))
3278 ;;;; Table Cell
3281 "Parse table cell at point.
3282 Return a list whose car is `table-cell' and cdr is a plist
3283 containing `:begin', `:end', `:contents-begin', `:contents-end'
3284 and `:post-blank' keywords."
3292 :end end
3293 :contents-begin contents-begin
3294 :contents-end contents-end
3298 "Interpret TABLE-CELL element as Org syntax.
3299 CONTENTS is the contents of the cell, or nil."
3303 ;;;; Target
3306 "Parse target at point, if any.
3308 When at a target, return a list whose car is `target' and cdr
3309 a plist with `:begin', `:end', `:value' and `:post-blank' as
3310 keywords. Otherwise, return nil.
3312 Assume point is at the target."
3322 :end end
3323 :value value
3327 "Interpret TARGET object as Org syntax.
3328 CONTENTS is nil."
3332 ;;;; Timestamp
3343 "Parse time stamp at point, if any.
3345 When at a time stamp, return a list whose car is `timestamp', and
3346 cdr a plist with `:type', `:raw-value', `:year-start',
3347 `:month-start', `:day-start', `:hour-start', `:minute-start',
3348 `:year-end', `:month-end', `:day-end', `:hour-end',
3349 `:minute-end', `:repeater-type', `:repeater-value',
3350 `:repeater-unit', `:warning-type', `:warning-value',
3351 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3352 Otherwise, return nil.
3354 Assume point is at the beginning of the timestamp."
3373 date-start)
3384 raw-value)
3386 :repeater-type
3392 :repeater-unit
3401 :warning-unit
3404 year-start month-start day-start hour-start minute-start year-end
3405 month-end day-end hour-end minute-end)
3406 ;; Parse date-start.
3414 ;; Compute date-end. It can be provided directly in time-stamp,
3415 ;; or extracted from time range. Otherwise, it defaults to the
3416 ;; same values as date-start.
3426 :raw-value raw-value
3427 :year-start year-start
3428 :month-start month-start
3429 :day-start day-start
3430 :hour-start hour-start
3431 :minute-start minute-start
3432 :year-end year-end
3433 :month-end month-end
3434 :day-end day-end
3435 :hour-end hour-end
3436 :minute-end minute-end
3437 :begin begin
3438 :end end
3440 repeater-props
3441 warning-props))))))
3444 "Interpret TIMESTAMP object as Org syntax.
3445 CONTENTS is nil."
3464 ;; Build an Org timestamp string from TIME. ACTIVEP is
3465 ;; non-nil when time stamp is active. If WITH-TIME-P is
3466 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3467 ;; specify a time range in the timestamp. REPEAT-STRING is
3468 ;; the repeater string, if any.
3472 org-time-stamp-formats)
3473 time)))
3479 nil nil ts)))
3484 " "
3485 s
3487 ;; Return value.
3488 ts)))
3500 build-ts-string
3519 0
3527 "--"
3539 ;;;; Underline
3542 "Parse underline object at point, if any.
3544 When at an underline object, return a list whose car is
3545 `underline' and cdr is a plist with `:begin', `:end',
3546 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3547 Otherwise, return nil.
3549 Assume point is at the first underscore marker."
3561 :end end
3562 :contents-begin contents-begin
3563 :contents-end contents-end
3567 "Interpret UNDERLINE object as Org syntax.
3568 CONTENTS is the contents of the object."
3572 ;;;; Verbatim
3575 "Parse verbatim object at point, if any.
3577 When at a verbatim object, return a list whose car is `verbatim'
3578 and cdr is a plist with `:value', `:begin', `:end' and
3579 `:post-blank' keywords. Otherwise, return nil.
3581 Assume point is at the first equal sign marker."
3592 :begin begin
3593 :end end
3597 "Interpret VERBATIM object as Org syntax.
3598 CONTENTS is nil."
3602 \f
3603 ;;; Parsing Element Starting At Point
3604 ;;
3605 ;; `org-element--current-element' is the core function of this section.
3606 ;; It returns the Lisp representation of the element starting at
3607 ;; point.
3608 ;;
3609 ;; `org-element--current-element' makes use of special modes. They
3610 ;; are activated for fixed element chaining (e.g., `plain-list' >
3611 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3612 ;; `section'). Special modes are: `first-section', `item',
3613 ;; `node-property', `section' and `table-row'.
3617 "Parse the element starting at point.
3619 Return value is a list like (TYPE PROPS) where TYPE is the type
3620 of the element and PROPS a plist of properties associated to the
3621 element.
3623 Possible types are defined in `org-element-all-elements'.
3625 LIMIT bounds the search.
3627 Optional argument GRANULARITY determines the depth of the
3628 recursion. Allowed values are `headline', `greater-element',
3629 `element', `object' or nil. When it is broader than `object' (or
3630 nil), secondary values will not be parsed, since they only
3631 contain objects.
3633 Optional argument SPECIAL, when non-nil, can be either
3634 `first-section', `item', `node-property', `section', and
3635 `table-row'.
3637 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3638 be computed.
3640 This function assumes point is always at the beginning of the
3641 element it has to parse."
3644 ;; Determine if parsing depth allows for secondary strings
3645 ;; parsing. It only applies to elements referenced in
3646 ;; `org-element-secondary-value-alist'.
3649 ;; Item.
3652 ;; Table Row.
3654 ;; Node Property.
3656 ;; Headline.
3659 ;; Sections (must be checked after headline).
3664 limit)))
3665 ;; When not at bol, point is at the beginning of an item or
3666 ;; a footnote definition: next item is always a paragraph.
3668 ;; Planning and Clock.
3673 ;; Inlinetask.
3676 ;; From there, elements can have affiliated keywords.
3679 ;; Jumping over affiliated keywords put point off-limits.
3680 ;; Parse them as regular keywords.
3684 ;; LaTeX Environment.
3687 ;; Drawer and Property Drawer.
3692 ;; Fixed Width
3695 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3696 ;; Keywords.
3705 org-element-block-name-alist)))
3720 ;; Footnote Definition.
3723 ;; Horizontal Rule.
3726 ;; Diary Sexp.
3729 ;; Table.
3731 ;; List.
3734 limit affiliated
3736 ;; Default element: Paragraph.
3740 ;; Most elements can have affiliated keywords. When looking for an
3741 ;; element beginning, we want to move before them, as they belong to
3742 ;; that element, and, in the meantime, collect information they give
3743 ;; into appropriate properties. Hence the following function.
3746 "Collect affiliated keywords from point down to LIMIT.
3748 Return a list whose CAR is the position at the first of them and
3749 CDR a plist of keywords and values and move point to the
3750 beginning of the first line after them.
3752 As a special case, if element doesn't start at the beginning of
3753 the line (e.g., a paragraph starting an item), CAR is current
3754 position of point and CDR is nil."
3758 ;; RESTRICT is the list of objects allowed in parsed
3759 ;; keywords value.
3761 output)
3764 ;; Apply translation to RAW-KWD. From there, KWD is
3765 ;; the official keyword.
3767 org-element-keyword-translation-alist))
3768 raw-kwd))
3769 ;; Find main value for any keyword.
3775 ;; PARSEDP is non-nil when keyword should have its
3776 ;; value parsed.
3778 ;; If KWD is a dual keyword, find its secondary
3779 ;; value. Maybe parse it.
3786 ;; Attribute a property name to KWD.
3788 ;; Now set final shape for VALUE.
3794 ;; Attributes can always appear on multiple lines.
3797 ;; Eventually store the new value in OUTPUT.
3799 ;; Move to next keyword.
3801 ;; If affiliated keywords are orphaned: move back to first one.
3802 ;; They will be parsed as a paragraph.
3804 ;; Return value.
3808 \f
3809 ;;; The Org Parser
3810 ;;
3811 ;; The two major functions here are `org-element-parse-buffer', which
3812 ;; parses Org syntax inside the current buffer, taking into account
3813 ;; region, narrowing, or even visibility if specified, and
3814 ;; `org-element-parse-secondary-string', which parses objects within
3815 ;; a given string.
3816 ;;
3817 ;; The (almost) almighty `org-element-map' allows to apply a function
3818 ;; on elements or objects matching some type, and accumulate the
3819 ;; resulting values. In an export situation, it also skips unneeded
3820 ;; parts of the parse tree.
3823 "Recursively parse the buffer and return structure.
3824 If narrowing is in effect, only parse the visible part of the
3825 buffer.
3827 Optional argument GRANULARITY determines the depth of the
3828 recursion. It can be set to the following symbols:
3830 `headline' Only parse headlines.
3831 `greater-element' Don't recurse into greater elements excepted
3832 headlines and sections. Thus, elements
3833 parsed are the top-level ones.
3834 `element' Parse everything but objects and plain text.
3835 `object' Parse the complete buffer (default).
3837 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3838 elements.
3840 An element or an objects is represented as a list with the
3841 pattern (TYPE PROPERTIES CONTENTS), where :
3843 TYPE is a symbol describing the element or object. See
3844 `org-element-all-elements' and `org-element-all-objects' for an
3845 exhaustive list of such symbols. One can retrieve it with
3846 `org-element-type' function.
3848 PROPERTIES is the list of attributes attached to the element or
3849 object, as a plist. Although most of them are specific to the
3850 element or object type, all types share `:begin', `:end',
3851 `:post-blank' and `:parent' properties, which respectively
3852 refer to buffer position where the element or object starts,
3853 ends, the number of white spaces or blank lines after it, and
3854 the element or object containing it. Properties values can be
3855 obtained by using `org-element-property' function.
3857 CONTENTS is a list of elements, objects or raw strings
3858 contained in the current element or object, when applicable.
3859 One can access them with `org-element-contents' function.
3861 The Org buffer has `org-data' as type and nil as properties.
3862 `org-element-map' function can be used to find specific elements
3863 or objects within the parse tree.
3865 This function assumes that current major mode is `org-mode'."
3871 ;; Start in `first-section' mode so text before the first
3872 ;; headline belongs to a section.
3876 "Recursively parse objects in STRING and return structure.
3878 RESTRICTION is a symbol limiting the object types that will be
3879 looked after.
3881 Optional argument PARENT, when non-nil, is the element or object
3882 containing the secondary string. It is used to set correctly
3883 `:parent' property within the string."
3896 secondary))))
3900 "Map a function on selected elements or objects.
3902 DATA is a parse tree, an element, an object, a string, or a list
3903 of such constructs. TYPES is a symbol or list of symbols of
3904 elements or objects types (see `org-element-all-elements' and
3905 `org-element-all-objects' for a complete list of types). FUN is
3906 the function called on the matching element or object. It has to
3907 accept one argument: the element or object itself.
3909 When optional argument INFO is non-nil, it should be a plist
3910 holding export options. In that case, parts of the parse tree
3911 not exportable according to that property list will be skipped.
3913 When optional argument FIRST-MATCH is non-nil, stop at the first
3914 match for which FUN doesn't return nil, and return that value.
3916 Optional argument NO-RECURSION is a symbol or a list of symbols
3917 representing elements or objects types. `org-element-map' won't
3918 enter any recursive element or object whose type belongs to that
3919 list. Though, FUN can still be applied on them.
3921 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3922 apply to matching objects within parsed affiliated keywords (see
3923 `org-element-parsed-keywords').
3925 Nil values returned from FUN do not appear in the results.
3928 Examples:
3929 ---------
3931 Assuming TREE is a variable containing an Org buffer parse tree,
3932 the following example will return a flat list of all `src-block'
3933 and `example-block' elements in it:
3935 \(org-element-map tree '(example-block src-block) 'identity)
3937 The following snippet will find the first headline with a level
3940 \(org-element-map tree 'headline
3941 \(lambda (hl)
3942 \(and (= (org-element-property :level hl) 1)
3944 \(org-element-property :begin hl)))
3945 nil t)
3947 The next example will return a flat list of all `plain-list' type
3948 elements in TREE that are not a sub-list themselves:
3950 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3952 Eventually, this example will return a flat list of all `bold'
3953 type objects containing a `latex-snippet' type object, even
3954 looking into captions:
3956 \(org-element-map tree 'bold
3957 \(lambda (b)
3958 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3959 nil nil nil t)"
3960 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3963 ;; Recursion depth is determined by --CATEGORY.
3970 ;; If one object is found, the function
3971 ;; has to recurse into every object.
3974 ;; If one regular element is found, the
3975 ;; function has to recurse, at least,
3976 ;; into every element it encounters.
3979 types)
3980 category)))
3981 ;; Compute properties for affiliated keywords if necessary.
3986 org-element-affiliated-keywords)))
3987 --acc
3988 --walk-tree
3992 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3993 ;; holding contextual information.
3997 ;; Ignored element in an export context.
3999 ;; List of elements or objects.
4001 ;; Unconditionally enter parse trees.
4005 ;; Check if TYPE is matching among TYPES. If so,
4006 ;; apply FUN to --DATA and accumulate return value
4007 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4013 ;; If --DATA has a secondary string that can contain
4014 ;; objects with their type among TYPES, look into it.
4021 ;; If --DATA has any affiliated keywords and
4022 ;; WITH-AFFILIATED is non-nil, look for objects in
4023 ;; them.
4031 ;; Pay attention to the type of value.
4032 ;; Preserve order for multiple keywords.
4048 --affiliated-alist))
4049 ;; Determine if a recursion into --DATA is possible.
4051 ;; --TYPE is explicitly removed from recursion.
4053 ;; --DATA has no contents.
4055 ;; Looking for greater elements but --DATA is simply
4056 ;; an element or an object.
4059 ;; Looking for elements but --DATA is an object.
4062 ;; In any other case, map contents.
4066 ;; Return value in a proper order.
4070 ;; The following functions are internal parts of the parser.
4071 ;;
4072 ;; The first one, `org-element--parse-elements' acts at the element's
4073 ;; level.
4074 ;;
4075 ;; The second one, `org-element--parse-objects' applies on all objects
4076 ;; of a paragraph or a secondary string.
4077 ;;
4078 ;; More precisely, that function looks for every allowed object type
4079 ;; first. Then, it discards failed searches, keeps further matches,
4080 ;; and searches again types matched behind point, for subsequent
4081 ;; calls. Thus, searching for a given type fails only once, and every
4082 ;; object is searched only once at top level (but sometimes more for
4083 ;; nested types).
4087 "Parse elements between BEG and END positions.
4089 SPECIAL prioritize some elements over the others. It can be set
4090 to `first-section', `section' `item' or `table-row'.
4092 When value is `item', STRUCTURE will be used as the current list
4093 structure.
4095 GRANULARITY determines the depth of the recursion. See
4096 `org-element-parse-buffer' for more information.
4098 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4099 elements.
4101 Elements are accumulated into ACC."
4104 ;; Visible only: skip invisible parts at the beginning of the
4105 ;; element.
4108 ;; When parsing only headlines, skip any text before first one.
4111 ;; Main loop start.
4113 ;; Find current element's type and parse it accordingly to
4114 ;; its category.
4116 end granularity special structure))
4120 ;; Visible only: skip invisible parts between siblings.
4123 ;; Fill ELEMENT contents by side-effect.
4125 ;; If element has no contents, don't modify it.
4127 ;; Greater element: parse it between `contents-begin' and
4128 ;; `contents-end'. Make sure GRANULARITY allows the
4129 ;; recursion, or ELEMENT is a headline, in which case going
4130 ;; inside is mandatory, in order to get sub-level headings.
4138 ;; Possibly switch to a special mode.
4146 granularity visible-only element))
4147 ;; ELEMENT has contents. Parse objects inside, if
4148 ;; GRANULARITY allows it.
4154 ;; Return result.
4155 acc))
4161 ;; Sub/superscript.
4163 ;; Bold, code, italic, strike-through, underline and
4164 ;; verbatim.
4167 ;; Plain links.
4169 ;; Objects starting with "[": regular link, footnote
4170 ;; reference, statistics cookie, timestamp (inactive).
4172 ;; Objects starting with "@": export snippets.
4173 "@@"
4174 ;; Objects starting with "{": macro.
4175 "{{{"
4176 ;; Objects starting with "<" : timestamp (active,
4177 ;; diary), target, radio target and angular links.
4179 ;; Objects starting with "$": latex fragment.
4181 ;; Objects starting with "\": line break, entity,
4182 ;; latex fragment.
4184 ;; Objects starting with raw text: inline Babel
4185 ;; source block, inline Babel call.
4188 "Regexp possibly matching the beginning of an object.
4189 This regexp allows false positives. Dedicated parser (e.g.,
4190 `org-export-bold-parser') will take care of further filtering.
4191 Radio links are not matched by this regexp, as they are treated
4195 "Return next object in current buffer or nil.
4196 RESTRICTION is a list of object types, as symbols, that should be
4197 looked after. This function assumes that the buffer is narrowed
4198 to an appropriate container (e.g., a paragraph)."
4206 found)
4271 ;; This is probably a plain link.
4277 ;; Radio link.
4282 "Parse objects between BEG and END and return recursive structure.
4284 Objects are accumulated in ACC.
4286 RESTRICTION is a list of object successors which are allowed in
4287 the current object."
4295 ;; 1. Text before any object. Untabify it.
4300 acc
4304 ;; 2. Object...
4307 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4308 ;; a recursive type.
4316 ;; 3. Text after last object. Untabify it.
4320 acc
4324 ;; Result.
4325 acc)))
4328 \f
4329 ;;; Towards A Bijective Process
4330 ;;
4331 ;; The parse tree obtained with `org-element-parse-buffer' is really
4332 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4333 ;; interpreted and expanded into a string with canonical Org syntax.
4334 ;; Hence `org-element-interpret-data'.
4335 ;;
4336 ;; The function relies internally on
4337 ;; `org-element--interpret-affiliated-keywords'.
4339 ;;;###autoload
4341 "Interpret DATA as Org syntax.
4343 DATA is a parse tree, an element, an object or a secondary string
4344 to interpret.
4346 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4347 new types that should be treated as objects. An unknown type not
4348 belonging to this list is seen as a pseudo-element instead. Both
4349 pseudo-objects and pseudo-elements are transparent entities, i.e.
4350 only their contents are interpreted.
4352 Return Org syntax as a string."
4356 "Interpret DATA as Org syntax.
4358 DATA is a parse tree, an element, an object or a secondary string
4359 to interpret. PARENT is used for recursive calls. It contains
4360 the element or object containing data, or nil. PSEUDO-OBJECTS
4361 are list of symbols defining new element or object types.
4362 Unknown types that don't belong to this list are treated as
4363 pseudo-elements instead.
4365 Return Org syntax as a string."
4367 ;; Find interpreter for current object or element. If it
4368 ;; doesn't exist (e.g. this is a pseudo object or element),
4369 ;; return contents, if any.
4375 ;; Secondary string.
4381 ;; Full Org document.
4387 ;; Plain text: return it.
4389 ;; Element or object without contents.
4391 ;; Element or object with contents.
4394 ;; Recursively interpret contents.
4400 data
4401 ;; Fix indentation of elements containing
4402 ;; objects. We ignore `table-row' elements
4403 ;; as they are one line long anyway.
4405 data
4406 ;; When normalizing first paragraph of an
4407 ;; item or a footnote-definition, ignore
4408 ;; first line's indentation.
4415 ;; Build white spaces. If no `:post-blank' property is
4416 ;; specified, assume its value is 0.
4427 "Return ELEMENT's affiliated keywords as Org syntax.
4428 If there is no affiliated keyword, return the empty string."
4438 ": "
4441 value)
4449 ;; All attribute keywords can have multiple lines.
4455 ;; List all ELEMENT's properties matching an attribute line or an
4456 ;; affiliated keyword, but ignore translated keywords since they
4457 ;; cannot belong to the property list.
4464 org-element-keyword-translation-alist)))))
4465 collect prop)
4468 ;; Because interpretation of the parse tree must return the same
4469 ;; number of blank lines between elements and the same number of white
4470 ;; space after objects, some special care must be given to white
4471 ;; spaces.
4472 ;;
4473 ;; The first function, `org-element-normalize-string', ensures any
4474 ;; string different from the empty string will end with a single
4475 ;; newline character.
4476 ;;
4477 ;; The second function, `org-element-normalize-contents', removes
4478 ;; global indentation from the contents of the current element.
4481 "Ensure string S ends with a single newline character.
4483 If S isn't a string return it unchanged. If S is the empty
4484 string, return it. Otherwise, return a new string with a single
4485 newline character at its end."
4493 "Normalize plain text in ELEMENT's contents.
4495 ELEMENT must only contain plain text and objects.
4497 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4498 indentation to compute maximal common indentation.
4500 Return the normalized element that is element with global
4501 indentation removed from its contents. The function assumes that
4502 indentation is not done with TAB characters."
4504 find-min-ind ; For byte-compiler.
4506 ;; Return minimal common indentation within BLOB. This is
4507 ;; done by walking recursively BLOB and updating MIN-IND
4508 ;; along the way. FIRST-FLAG is non-nil when the first
4509 ;; string hasn't been seen yet. It is required as this
4510 ;; string is the only one whose indentation doesn't happen
4511 ;; after a newline character.
4518 ;; An indentation of zero means no string will be
4519 ;; modified. Quit the process.
4529 ;; Find minimal indentation in ELEMENT.
4532 ;; Build ELEMENT back, replacing each string with the same
4533 ;; string minus common indentation.
4538 ;; Return BLOB with all its strings indentation
4539 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4540 ;; is non-nil when the first string hasn't been seen
4541 ;; yet.
4556 org-element-recursive-objects)
4560 blob))))
4564 \f
4565 ;;; Cache
4566 ;;
4567 ;; Implement a caching mechanism for `org-element-at-point' and
4568 ;; `org-element-context', which see.
4569 ;;
4570 ;; A single public function is provided: `org-element-cache-reset'.
4571 ;;
4572 ;; Cache is enabled by default, but can be disabled globally with
4573 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4574 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4575 ;; can be tweaked to control caching behaviour.
4576 ;;
4577 ;; Internally, parsed elements are stored in an AVL tree,
4578 ;; `org-element--cache'. This tree is updated lazily: whenever
4579 ;; a change happens to the buffer, a synchronization request is
4580 ;; registered in `org-element--cache-sync-requests' (see
4581 ;; `org-element--cache-submit-request'). During idle time, requests
4582 ;; are processed by `org-element--cache-sync'. Synchronization also
4583 ;; happens when an element is required from the cache. In this case,
4584 ;; the process stops as soon as the needed element is up-to-date.
4585 ;;
4586 ;; A synchronization request can only apply on a synchronized part of
4587 ;; the cache. Therefore, the cache is updated at least to the
4588 ;; location where the new request applies. Thus, requests are ordered
4589 ;; from left to right and all elements starting before the first
4590 ;; request are correct. This property is used by functions like
4591 ;; `org-element--cache-find' to retrieve elements in the part of the
4592 ;; cache that can be trusted.
4593 ;;
4594 ;; A request applies to every element, starting from its original
4595 ;; location (or key, see below). When a request is processed, it
4596 ;; moves forward and may collide the next one. In this case, both
4597 ;; requests are merged into a new one that starts from that element.
4598 ;; As a consequence, the whole synchronization complexity does not
4599 ;; depend on the number of pending requests, but on the number of
4600 ;; elements the very first request will be applied on.
4601 ;;
4602 ;; Elements cannot be accessed through their beginning position, which
4603 ;; may or may not be up-to-date. Instead, each element in the tree is
4604 ;; associated to a key, obtained with `org-element--cache-key'. This
4605 ;; mechanism is robust enough to preserve total order among elements
4606 ;; even when the tree is only partially synchronized.
4607 ;;
4608 ;; Objects contained in an element are stored in a hash table,
4609 ;; `org-element--cache-objects'.
4613 "Non nil when Org parser should cache its results.
4620 "Maximum duration, as a time value, for a cache synchronization.
4621 If the synchronization is not over after this delay, the process
4622 pauses and resumes after `org-element-cache-sync-break'
4626 "Duration, as a time value, of the pause between synchronizations.
4630 ;;;; Data Structure
4633 "AVL tree used to cache elements.
4634 Each node of the tree contains an element. Comparison is done
4635 with `org-element--cache-compare'. This cache is used in
4639 "Hash table used as to cache objects.
4640 Key is an element, as returned by `org-element-at-point', and
4641 value is an alist where each association is:
4643 \(PARENT COMPLETEP . OBJECTS)
4645 where PARENT is an element or object, COMPLETEP is a boolean,
4646 non-nil when all direct children of parent are already cached and
4647 OBJECTS is a list of such children, as objects, from farthest to
4648 closest.
4651 contained within a paragraph
4655 If the paragraph is completely parsed, OBJECTS-DATA will be
4657 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4658 \(BOLD-OBJECT t ENTITY-OBJECT))
4660 whereas in a partially parsed paragraph, it could be
4662 \((PARAGRAPH nil ENTITY-OBJECT))
4667 "List of pending synchronization requests.
4669 A request is a vector with the following pattern:
4671 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4673 Processing a synchronization request consists of three phases:
4675 0. Delete modified elements,
4676 1. Fill missing area in cache,
4677 2. Shift positions and re-parent elements after the changes.
4679 During phase 0, NEXT is the key of the first element to be
4680 removed, BEG and END is buffer position delimiting the
4681 modifications. Elements starting between them (inclusive) are
4682 removed and so are those contained within OUTREACH. PARENT, when
4683 non-nil, is the parent of the first element to be removed.
4685 During phase 1, NEXT is the key of the next known element in
4686 cache and BEG its beginning position. Parse buffer between that
4687 element and the one before it in order to determine the parent of
4688 the next element. Set PARENT to the element containing NEXT.
4690 During phase 2, NEXT is the key of the next element to shift in
4691 the parse tree. All elements starting from this one have their
4692 properties relatives to buffer positions shifted by integer
4693 OFFSET and, if they belong to element PARENT, are adopted by it.
4701 "Hash table used to store keys during synchronization.
4705 "Return a unique key for ELEMENT in cache tree.
4707 Keys are used to keep a total order among elements in the cache.
4708 Comparison is done with `org-element--cache-key-less-p'.
4710 When no synchronization is taking place, a key is simply the
4711 beginning position of the element, or that position plus one in
4712 the case of an first item (respectively row) in
4713 a list (respectively a table).
4715 During a synchronization, the key is the one the element had when
4716 the cache was synchronized for the last time. Elements added to
4717 cache during the synchronization get a new key generated with
4718 `org-element--cache-generate-key'.
4720 Such keys are stored in `org-element--cache-sync-keys'. The hash
4721 table is cleared once the synchronization is complete."
4724 ;; Increase beginning position of items (respectively
4725 ;; table rows) by one, so the first item can get
4726 ;; a different key from its parent list (respectively
4727 ;; table).
4730 begin)))
4733 key))))
4736 "Generate a key between LOWER and UPPER.
4738 LOWER and UPPER are integers or lists, possibly empty.
4740 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4741 a unique key, as an integer or a list of integers, according to
4742 the following rules:
4744 - LOWER and UPPER are compared level-wise until values differ.
4746 - If, at a given level, LOWER and UPPER differ from more than
4747 2, the new key shares all the levels above with LOWER and
4748 gets a new level. Its value is the mean between LOWER and
4749 UPPER:
4751 \(1 2) + (1 4) --> (1 3)
4753 - If LOWER has no value to compare with, it is assumed that its
4754 value is `most-negative-fixnum'. E.g.,
4756 \(1 1) + (1 1 2)
4758 is equivalent to
4760 \(1 1 m) + (1 1 2)
4762 where m is `most-negative-fixnum'. Likewise, if UPPER is
4763 short of levels, the current value is `most-positive-fixnum'.
4765 - If they differ from only one, the new key inherits from
4766 current LOWER level and fork it at the next level. E.g.,
4768 \(2 1) + (3 3)
4770 is equivalent to
4772 \(2 1) + (2 M)
4774 where M is `most-positive-fixnum'.
4776 - If the key is only one level long, it is returned as an
4777 integer:
4779 \(1 2) + (3 2) --> 2
4781 When they are not equals, the function assumes that LOWER is
4782 lesser than UPPER, per `org-element--cache-key-less-p'."
4786 skip-upper key)
4797 ;; When at a given level, LOWER and UPPER differ from
4798 ;; 1, ignore UPPER altogether. Instead create a key
4799 ;; between LOWER and the greatest key with the same
4800 ;; prefix as LOWER so far.
4806 "Non-nil if key A is less than key B.
4807 A and B are either integers or lists of integers, as returned by
4808 `org-element--cache-key'."
4816 ;; If A is empty, either keys are equal (B is also empty) and
4817 ;; we return nil, or A is lesser than B (B is longer) and we
4818 ;; return a non-nil value.
4819 ;;
4820 ;; If A is not empty, B is necessarily empty and A is greater
4821 ;; than B (A is longer). Therefore, return nil.
4825 "Non-nil when element A is located before element B."
4830 "Return root value in cache.
4831 This function assumes `org-element--cache' is a valid AVL tree."
4835 ;;;; Tools
4838 "Non-nil when cache is active in current buffer."
4843 "Find element in cache starting at POS or before.
4845 POS refers to a buffer position.
4847 When optional argument SIDE is non-nil, the function checks for
4848 elements starting at or past POS instead. If SIDE is `both', the
4849 function returns a cons cell where car is the first element
4850 starting at or before POS and cdr the first element starting
4851 after POS.
4853 The function can only find elements in the synchronized part of
4854 the cache."
4858 lower upper)
4873 ;; We found an element in cache starting at POS. If `side'
4874 ;; is `both' we also want the next one in order to generate
4875 ;; a key in-between.
4876 ;;
4877 ;; If the element is the first row or item in a table or
4878 ;; a plain list, we always return the table or the plain
4879 ;; list.
4880 ;;
4881 ;; In any other case, we return the element found.
4890 lower parent
4891 upper parent)))))
4894 lower element
4895 upper element)))))
4902 "Store ELEMENT in current buffer's cache, if allowed.
4903 When optional argument DATA is non-nil, assume is it object data
4904 relative to ELEMENT and store it in the objects cache."
4908 ;; During synchronization, first build an appropriate key
4909 ;; for the new element so `avl-tree-enter' can insert it at
4910 ;; the right spot in the cache.
4919 org-element--cache-sync-keys)))
4921 ;; Headlines are not stored in cache, so objects in titles are
4922 ;; not stored either.
4927 "Remove ELEMENT from cache.
4928 Assume ELEMENT belongs to cache and that a cache is active."
4933 ;;;; Synchronization
4936 "Set idle timer for cache synchronization in BUFFER."
4943 org-element-cache-sync-idle-time))
4944 nil
4945 #'org-element--cache-sync
4946 buffer)))
4949 "Non-nil when synchronization process should be interrupted.
4950 TIME-LIMIT is a time value or nil."
4956 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4958 Properties containing buffer positions are `:begin', `:end',
4959 `:contents-begin', `:contents-end' and `:structure'. When
4960 optional argument PROPS is a list of keywords, only shift
4961 properties provided in that list.
4963 Properties are modified by side-effect."
4965 ;; Shift `:structure' property for the first plain list only: it
4966 ;; is the only one that really matters and it prevents from
4967 ;; shifting it more than once.
4981 "Synchronize cache with recent modification in BUFFER.
4983 When optional argument THRESHOLD is non-nil, do the
4984 synchronization for all elements starting before or at threshold,
4985 then exit. Otherwise, synchronize cache for as long as
4986 `org-element-cache-sync-duration' or until Emacs leaves idle
4987 state.
4989 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4990 not registered yet in the cache are going to happen. It is used
4991 in `org-element--cache-submit-request', where cache is partially
4992 updated before current modification are actually submitted."
5003 request
5005 threshold
5008 org-element-cache-sync-duration))
5009 future-change)
5010 ;; Request processed. Merge current and next offsets and
5011 ;; transfer ending position.
5017 ;; If more requests are awaiting, set idle timer accordingly.
5018 ;; Otherwise, reset keys.
5025 "Process synchronization REQUEST for all entries before NEXT.
5027 REQUEST is a vector, built by `org-element--cache-submit-request'.
5029 NEXT is a cache key, as returned by `org-element--cache-key'.
5031 When non-nil, THRESHOLD is a buffer position. Synchronization
5032 stops as soon as a shifted element begins after it.
5034 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5035 after this time or when Emacs exits idle state.
5037 When non-nil, FUTURE-CHANGE is a buffer position where changes
5038 not registered yet in the cache are going to happen. See
5039 `org-element--cache-submit-request' for more information.
5041 Throw `interrupt' if the process stops before completing the
5042 request."
5045 ;; Phase 0.
5046 ;;
5047 ;; Delete all elements starting after BEG, but not after buffer
5048 ;; position END or past element with key NEXT.
5049 ;;
5050 ;; At each iteration, we start again at tree root since
5051 ;; a deletion modifies structure of the balanced tree.
5059 ;; Find first element in cache with key BEG or after it.
5069 data-key key
5072 data-key key
5073 node nil)))))
5082 up))
5088 ;; No element starting after modifications left in
5089 ;; cache: further processing is futile.
5092 ;; Phase 1.
5093 ;;
5094 ;; Phase 0 left a hole in the cache. Some elements after it
5095 ;; could have parents within. For example, in the following
5096 ;; buffer:
5097 ;;
5098 ;; - item
5099 ;;
5100 ;;
5101 ;; Paragraph1
5102 ;;
5103 ;; Paragraph2
5104 ;;
5105 ;; if we remove a blank line between "item" and "Paragraph1",
5106 ;; everything down to "Paragraph2" is removed from cache. But
5107 ;; the paragraph now belongs to the list, and its `:parent'
5108 ;; property no longer is accurate.
5109 ;;
5110 ;; Therefore we need to parse again elements in the hole, or at
5111 ;; least in its last section, so that we can re-parent
5112 ;; subsequent elements, during phase 2.
5113 ;;
5114 ;; Note that we only need to get the parent from the first
5115 ;; element in cache after the hole.
5116 ;;
5117 ;; When next key is lesser or equal to the current one, delegate
5118 ;; phase 1 processing to next request in order to preserve key
5119 ;; order among requests.
5127 ;; Next element will start at its beginning position plus
5128 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5129 ;; contains the real beginning position of the first element to
5130 ;; shift and re-parent.
5134 ;; Changes are going to happen around this element and
5135 ;; they will trigger another phase 1 request. Skip the
5136 ;; current one.
5142 ;; Phase 2.
5143 ;;
5144 ;; Shift all elements starting from key START, but before NEXT, by
5145 ;; OFFSET, and re-parent them when appropriate.
5146 ;;
5147 ;; Elements are modified by side-effect so the tree structure
5148 ;; remains intact.
5149 ;;
5150 ;; Once THRESHOLD, if any, is reached, or once there is an input
5151 ;; pending, exit. Before leaving, the current synchronization
5152 ;; request is updated.
5159 exit-flag)
5160 ;; No re-parenting nor shifting planned: request is over.
5170 ;; We reached NEXT. Request is complete.
5172 ;; Handle interruption request. Update current request.
5177 ;; Shift element.
5180 ;; Shift associated objects data, if any.
5185 ;; Update PARENT and re-parent DATA, only when
5186 ;; necessary. Propagate new structures for lists.
5200 ;; Cache is up-to-date past THRESHOLD. Request
5201 ;; interruption.
5206 ;; We reached end of tree: synchronization complete.
5207 t)))
5210 "Parse elements in current section, down to POS.
5212 Start parsing from the closest between the last known element in
5213 cache or headline above. Return the smallest element containing
5214 POS.
5216 When optional argument SYNCP is non-nil, return the parent of the
5217 element containing POS instead. In that case, it is also
5218 possible to provide TIME-LIMIT, which is a time value specifying
5219 when the parsing should stop. The function throws `interrupt' if
5220 the process stopped before finding the expected result."
5227 element next)
5229 ;; Nothing in cache before point: start parsing from first
5230 ;; element following headline above, or first element in
5231 ;; buffer.
5237 ;; Cache returned exact match: return it.
5240 ;; There's a headline between cached value and POS: cached
5241 ;; value is invalid. Start parsing from first element
5242 ;; following the headline.
5248 ;; Check if CACHED or any of its ancestors contain point.
5249 ;;
5250 ;; If there is such an element, we inspect it in order to know
5251 ;; if we return it or if we need to parse its contents.
5252 ;; Otherwise, we just start parsing from current location,
5253 ;; which is right after the top-most element containing
5254 ;; CACHED.
5255 ;;
5256 ;; As a special case, if POS is at the end of the buffer, we
5257 ;; want to return the innermost element ending there.
5258 ;;
5259 ;; Also, if we find an ancestor and discover that we need to
5260 ;; parse its contents, make sure we don't start from
5261 ;; `:contents-begin', as we would otherwise go past CACHED
5262 ;; again. Instead, in that situation, we will resume parsing
5263 ;; from NEXT, which is located after CACHED or its higher
5264 ;; ancestor not containing point.
5276 ;; Parse successively each element until we reach POS.
5282 special-flag)
5290 end 'element special-flag
5297 ;; Skip any element ending before point. Also skip
5298 ;; element ending at point (unless it is also the end of
5299 ;; buffer) since we're sure that another element begins
5300 ;; after it.
5303 ;; A non-greater element contains point: return it.
5306 ;; Otherwise, we have to decide if ELEMENT really
5307 ;; contains POS. In that case we start parsing from
5308 ;; contents' beginning.
5309 ;;
5310 ;; If POS is at contents' beginning but it is also at
5311 ;; the beginning of the first item in a list or a table.
5312 ;; In that case, we need to create an anchor for that
5313 ;; list or table, so return it.
5314 ;;
5315 ;; Also, if POS is at the end of the buffer, no element
5316 ;; can start after it, but more than one may end there.
5317 ;; Arbitrarily, we choose to return the innermost of
5318 ;; such elements.
5334 parent element
5335 end cend))))
5336 ;; Otherwise, return ELEMENT as it is the smallest
5337 ;; element containing POS.
5342 ;;;; Staging Buffer Changes
5348 ;; Blocks
5350 ;; LaTeX environments.
5352 ;; Drawers.
5355 "Regexp matching a sensitive line, structure wise.
5356 A sensitive line is a headline, inlinetask, block, drawer, or
5357 latex-environment boundary. When such a line is modified,
5358 structure changes in the document may propagate in the whole
5362 "Non-nil when a sensitive line is about to be changed.
5366 "Request extension of area going to be modified if needed.
5367 BEG and END are the beginning and end of the range of changed
5368 text. See `before-change-functions' for more information."
5378 'headline
5381 org-element--cache-sensitive-re bottom t)))))))))
5384 "Update buffer modifications for current buffer.
5385 BEG and END are the beginning and end of the range of changed
5386 text, and the length in bytes of the pre-change text replaced by
5387 that range. See `after-change-functions' for more information."
5395 ;; Determine if modified area needs to be extended, according
5396 ;; to both previous and current state. We make a special
5397 ;; case for headline editing: if a headline is modified but
5398 ;; not removed, do not extend.
5407 org-element--cache-sensitive-re bottom t))))
5408 ;; Effectively extend modified area.
5416 ;; Store synchronization request.
5419 ;; Activate a timer to process the request during idle time.
5423 "Return first element to remove from cache.
5425 BEG and END are buffer positions delimiting buffer modifications.
5426 OFFSET is the size of the changes.
5428 Returned element is usually the first element in cache containing
5429 any position between BEG and END. As an exception, greater
5430 elements around the changes that are robust to contents
5431 modifications are preserved and updated according to the
5432 changes."
5442 property-drawer quote-block
5443 special-block))
5446 ;; UP is a robust greater element containing changes.
5447 ;; We only need to extend its ending boundaries.
5453 ;; We're at top level element containing ELEMENT: if it's
5454 ;; altered by buffer modifications, it is first element in
5455 ;; cache to be removed. Otherwise, that first element is the
5456 ;; following one.
5457 ;;
5458 ;; As a special case, do not remove BEFORE if it is a robust
5459 ;; container for current changes.
5461 before)))))
5464 "Submit a new cache synchronization request for current buffer.
5465 BEG and END are buffer positions delimiting the minimal area
5466 where cache data should be removed. OFFSET is the size of the
5467 change, as an integer."
5469 delete-to delete-from)
5474 ;; Current changes can be merged with first sync request: we
5475 ;; can save a partial cache synchronization.
5478 ;; If last change happened within area to be removed, extend
5479 ;; boundaries of robust parents, if any. Otherwise, find
5480 ;; first element to remove and update request accordingly.
5492 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5493 ;; if any, is no longer a 0-phase request, thus ensuring that
5494 ;; phases are properly ordered. We need to provide OFFSET as
5495 ;; optional parameter since current modifications are not known
5496 ;; yet to the otherwise correct part of the cache (i.e, before
5497 ;; the first request).
5504 ;; When changes happen before the first known
5505 ;; element, re-parent and shift the rest of the
5506 ;; cache.
5508 ;; Otherwise, we find the first non robust
5509 ;; element containing END. All elements between
5510 ;; FIRST and this one are to be removed.
5511 ;;
5512 ;; Among them, some could be located outside the
5513 ;; synchronized part of the cache, in which case
5514 ;; comparing buffer positions to find them is
5515 ;; useless. Instead, we store the element
5516 ;; containing them in the request itself. All
5517 ;; its children will be removed.
5529 element up))
5532 org-element--cache-sync-requests)
5533 ;; No element to remove. No need to re-parent either.
5534 ;; Simply shift additional elements, if any, by OFFSET.
5539 ;;;; Public Functions
5541 ;;;###autoload
5543 "Reset cache in current buffer.
5544 When optional argument ALL is non-nil, reset cache in all Org
5545 buffers."
5563 ;;;###autoload
5565 "Refresh cache at position POS."
5572 \f
5573 ;;; The Toolbox
5574 ;;
5575 ;; The first move is to implement a way to obtain the smallest element
5576 ;; containing point. This is the job of `org-element-at-point'. It
5577 ;; basically jumps back to the beginning of section containing point
5578 ;; and proceed, one element after the other, with
5579 ;; `org-element--current-element' until the container is found. Note:
5580 ;; When using `org-element-at-point', secondary values are never
5581 ;; parsed since the function focuses on elements, not on objects.
5582 ;;
5583 ;; At a deeper level, `org-element-context' lists all elements and
5584 ;; objects containing point.
5585 ;;
5586 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5587 ;; internally by navigation and manipulation tools.
5590 ;;;###autoload
5592 "Determine closest element around point.
5594 Return value is a list like (TYPE PROPS) where TYPE is the type
5595 of the element and PROPS a plist of properties associated to the
5596 element.
5598 Possible types are defined in `org-element-all-elements'.
5599 Properties depend on element or object type, but always include
5600 `:begin', `:end', `:parent' and `:post-blank' properties.
5602 As a special case, if point is at the very beginning of the first
5603 item in a list or sub-list, returned element will be that list
5604 instead of the item. Likewise, if point is at the beginning of
5605 the first row of a table, returned element will be the table
5606 instead of the first row.
5608 When point is at the end of the buffer, return the innermost
5609 element ending there."
5615 ;; Within blank lines at the beginning of buffer, return nil.
5617 ;; Within blank lines right after a headline, return that
5618 ;; headline.
5622 ;; Otherwise parse until we find element containing ORIGIN.
5629 ;;;###autoload
5631 "Return smallest element or object around point.
5633 Return value is a list like (TYPE PROPS) where TYPE is the type
5634 of the element or object and PROPS a plist of properties
5635 associated to it.
5637 Possible types are defined in `org-element-all-elements' and
5638 `org-element-all-objects'. Properties depend on element or
5639 object type, but always include `:begin', `:end', `:parent' and
5640 `:post-blank'.
5642 As a special case, if point is right after an object and not at
5643 the beginning of any other object, return that object.
5645 Optional argument ELEMENT, when non-nil, is the closest element
5646 containing point, as returned by `org-element-at-point'.
5647 Providing it allows for quicker computation."
5653 ;; If point is inside an element containing objects or
5654 ;; a secondary string, narrow buffer to the container and
5655 ;; proceed with parsing. Otherwise, return ELEMENT.
5657 ;; At a parsed affiliated keyword, check if we're inside main
5658 ;; or dual value.
5665 org-element-parsed-keywords))
5674 ;; Also change type to retrieve correct restrictions.
5676 ;; At an item, objects can only be located within tag, if any.
5686 ;; At an headline or inlinetask, objects are in title.
5693 ;; At a paragraph, a table-row or a verse block, objects are
5694 ;; located within their contents.
5698 ;; CBEG is nil for table rules.
5703 ;; At a parsed keyword, objects are located within value.
5706 org-element-document-properties))
5713 ;; At a planning line, if point is at a timestamp, return it,
5714 ;; otherwise, return element.
5722 ;; All other locations cannot contain objects: bail out.
5732 next object-data last)
5736 ;; When entering PARENT for the first time, get list
5737 ;; of objects within known so far. Store it in
5738 ;; OBJECT-DATA.
5743 ;; Find NEXT object for analysis.
5745 ;; If NEXT is non-nil, we already exhausted the
5746 ;; cache so we can parse buffer to find the object
5747 ;; after it.
5749 ;; Otherwise, check if cache can help us.
5760 ;; Cache contains the information needed.
5763 pos)
5765 pos)
5771 ;; If we have a new object to analyze, store it in
5772 ;; cache. Otherwise record that there is nothing
5773 ;; more to parse in this element at this depth.
5778 ;; Process NEXT, if any, in order to know if we need
5779 ;; to skip it, return it or move into it.
5786 ;; Skip objects ending before point. Also skip
5787 ;; objects ending at point unless it is also the
5788 ;; end of buffer, since we want to return the
5789 ;; innermost object.
5792 ;; For convenience, when object ends at POS,
5793 ;; without any space, store it in LAST, as we
5794 ;; will return it if no object starts here.
5798 ;; If POS is within a container object, move
5799 ;; into that object.
5803 ;; At contents' end, if there is no
5804 ;; space before point, also move into
5805 ;; object, for consistency with
5806 ;; convenience feature above.
5815 next nil
5816 object-data nil))
5817 ;; Otherwise, return NEXT.
5819 ;; Store results in cache, if applicable.
5823 "Non-nil when elements ELEM-A and ELEM-B are nested."
5832 "Swap elements ELEM-A and ELEM-B.
5833 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5834 end of ELEM-A."
5836 ;; There are two special cases when an element doesn't start at bol:
5837 ;; the first paragraph in an item or in a footnote definition.
5839 ;; Only a paragraph without any affiliated keyword can be moved at
5840 ;; ELEM-A position in such a situation. Note that the case of
5841 ;; a footnote definition is impossible: it cannot contain two
5842 ;; paragraphs in a row because it cannot contain a blank line.
5848 ;; In a special situation, ELEM-A will have no indentation. We'll
5849 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5863 ;; Store overlays responsible for visibility status. We
5864 ;; also need to store their boundaries as they will be
5865 ;; removed from buffer.
5872 ;; Get contents.
5880 ;; Restore ex ELEM-A overlays.
5889 ;; Restore ex ELEM-B overlays.
5897 "Remove maximum common indentation in string S and return it.
5898 When optional argument N is a positive integer, remove exactly
5899 that much characters from indentation, if possible, or return
5900 S as-is otherwise. Unlike to `org-remove-indentation', this
5901 function doesn't call `untabify' on S."
5906 ;; Find maximum common indentation, if not specified.
5914 min-ind)))
5916 ;; Remove exactly N indentation, but give up if not possible.
5929 ;; Local variables:
5930 ;; generated-autoload-file: "org-loaddefs.el"
5931 ;; End:
5933 ;;; org-element.el ends here