| blob | 241e976fb6080fba1e862a3585d9f080fd69ac49 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2015 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', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
162 ;; Blocks (any type), Babel calls and keywords. This
163 ;; is only an indication and need some thorough check.
165 ;; Drawers (any type) and fixed-width areas. This is
166 ;; also only an indication.
168 ;; Horizontal rules.
170 ;; LaTeX environments.
172 ;; Clock lines.
174 ;; Lists.
181 org-element--object-regexp
185 ;; Sub/superscript.
187 ;; Bold, code, italic, strike-through, underline
188 ;; and verbatim.
192 ;; Plain links.
194 ;; Objects starting with "[": regular link,
195 ;; footnote reference, statistics cookie,
196 ;; timestamp (inactive).
198 ;; Objects starting with "@": export snippets.
199 "@@"
200 ;; Objects starting with "{": macro.
201 "{{{"
202 ;; Objects starting with "<" : timestamp
203 ;; (active, diary), target, radio target and
204 ;; angular links.
206 ;; Objects starting with "$": latex fragment.
208 ;; Objects starting with "\": line break,
209 ;; entity, latex fragment.
211 ;; Objects starting with raw text: inline Babel
212 ;; source block, inline Babel call.
218 ;;;###autoload
220 "Update parser internals."
227 dynamic-block example-block export-block fixed-width
228 footnote-definition headline horizontal-rule inlinetask item
229 keyword latex-environment node-property paragraph plain-list
230 planning property-drawer quote-block section
231 special-block src-block table table-row verse-block)
236 item plain-list property-drawer quote-block section
237 special-block table)
242 inline-src-block italic line-break latex-fragment link macro
243 radio-target statistics-cookie strike-through subscript superscript
244 table-cell target timestamp underline verbatim)
249 superscript table-cell underline)
263 "Alist between block names and the associated parsing function.
264 Names must be uppercase. Any block whose name has no association
270 "List of affiliated keywords as strings.
278 "Alist of usual translations for keywords.
279 The key is the old name and the value the new one. The property
283 "List of affiliated keywords that can occur more than once in an element.
285 Their value will be consed into a list of strings, which will be
286 returned as the value of the property.
288 This list is checked after translations have been applied. See
289 `org-element-keyword-translation-alist'.
295 "List of affiliated keywords whose value can be parsed.
297 Their value will be stored as a secondary string: a list of
298 strings and objects.
300 This list is checked after translations have been applied. See
305 org-element-parsed-keywords)
306 "Alist of parsed keywords and associated properties.
307 This is generated from `org-element-parsed-keywords', which
311 "List of affiliated keywords which can have a secondary value.
313 In Org syntax, they can be written with optional square brackets
314 before the colons. For example, RESULTS keyword can be
315 associated to a hash value with the following:
317 #+RESULTS[hash-string]: some-source
319 This list is checked after translations have been applied. See
323 "List of properties associated to the whole document.
324 Any keyword in this list will have its value parsed and stored as
330 ;; Dual affiliated keywords.
334 ;; Regular affiliated keywords.
340 org-element-affiliated-keywords)))
342 ;; Export attributes.
344 "Regexp matching any affiliated keyword.
346 Keyword name is put in match group 1. Moreover, if keyword
347 belongs to `org-element-dual-keywords', put the dual value in
348 match group 2.
362 ;; Ignore all links excepted plain links in a link description.
363 ;; Also ignore radio-targets and line breaks.
365 italic latex-fragment macro plain-link statistics-cookie
366 strike-through subscript superscript underline verbatim)
368 ;; Remove any variable object from radio target as it would
369 ;; prevent it from being properly recognized.
371 subscript superscript underline superscript)
375 ;; Ignore inline babel call and inline src block as formulas are
376 ;; possible. Also ignore line breaks and statistics cookies.
378 latex-fragment link macro radio-target strike-through
379 subscript superscript target timestamp underline verbatim)
383 "Alist of objects restrictions.
385 key is an element or object type containing objects and value is
386 a list of types that can be contained within an element or object
387 of such type.
389 For example, in a `radio-target' object, one can only find
390 entities, latex-fragments, subscript, superscript and text
391 markup.
393 This alist also applies to secondary string. For example, an
394 `headline' type element doesn't directly contain objects, but
409 "Table used internally to pair only square brackets.
413 \f
414 ;;; Accessors and Setters
415 ;;
416 ;; Provide four accessors: `org-element-type', `org-element-property'
417 ;; `org-element-contents' and `org-element-restriction'.
418 ;;
419 ;; Setter functions allow to modify elements by side effect. There is
420 ;; `org-element-put-property', `org-element-set-contents'. These
421 ;; low-level functions are useful to build a parse tree.
422 ;;
423 ;; `org-element-adopt-element', `org-element-set-element',
424 ;; `org-element-extract-element' and `org-element-insert-before' are
425 ;; high-level functions useful to modify a parse tree.
426 ;;
427 ;; `org-element-secondary-p' is a predicate used to know if a given
428 ;; object belongs to a secondary string. `org-element-copy' returns
429 ;; an element or object, stripping its parent property in the process.
432 "Return type of ELEMENT.
434 The function returns the type of the element or object provided.
435 It can also return the following special value:
436 `plain-text' for a string
437 `org-data' for a complete document
438 nil in any other case."
444 "Extract the value from the PROPERTY of an ELEMENT."
449 "Extract contents from an ELEMENT."
455 "Return restriction associated to ELEMENT.
456 ELEMENT can be an element, an object or a symbol representing an
457 element or object type."
459 org-element-object-restrictions)))
462 "In ELEMENT set PROPERTY to VALUE.
463 Return modified element."
466 element))
469 "Set ELEMENT contents to CONTENTS."
476 "Non-nil when OBJECT directly belongs to a secondary string.
477 Return value is the property name, as a keyword, or nil."
480 org-element-secondary-value-alist))))
487 "Append elements to the contents of another element.
489 PARENT is an element or object. CHILDREN can be elements,
490 objects, or a strings.
492 The function takes care of setting `:parent' property for CHILD.
493 Return parent element."
494 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
495 ;; string: parent is the list itself.
498 children)
499 ;; Add CHILDREN at the end of PARENT contents.
502 parent
504 ;; Return modified PARENT element.
508 "Extract ELEMENT from parse tree.
509 Remove element from the parse tree by side-effect, and return it
510 with its `:parent' property stripped out."
515 parent secondary
518 parent
520 ;; Return ELEMENT with its :parent removed.
524 "Insert ELEMENT before LOCATION in parse tree.
525 LOCATION is an element, object or string within the parse tree.
526 Parse tree is modified by side effect."
531 ;; Special case: LOCATION is the first element of an
532 ;; independent secondary string (e.g. :title property). Add
533 ;; ELEMENT in-place.
537 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
547 ;; Store SIBLINGS at appropriate place in parse tree.
552 ;; Set appropriate :parent property.
556 "Replace element or object OLD with element or object NEW.
557 The function takes care of setting `:parent' property for NEW."
558 ;; Ensure OLD and NEW have the same parent.
562 ;; We cannot replace OLD with NEW since one of them is not an
563 ;; object or element. We take the long path.
566 ;; Since OLD is going to be changed into NEW by side-effect, first
567 ;; make sure that every element or object within NEW has OLD as
568 ;; parent.
571 ;; Transfer contents.
573 ;; Overwrite OLD's properties with NEW's.
575 ;; Transfer type.
579 "Return a copy of DATUM.
580 DATUM is an element, object, string or nil. `:parent' property
581 is cleared and contents are removed in the process."
592 \f
593 ;;; Greater elements
594 ;;
595 ;; For each greater element type, we define a parser and an
596 ;; interpreter.
597 ;;
598 ;; A parser returns the element or object as the list described above.
599 ;; Most of them accepts no argument. Though, exceptions exist. Hence
600 ;; every element containing a secondary string (see
601 ;; `org-element-secondary-value-alist') will accept an optional
602 ;; argument to toggle parsing of these secondary strings. Moreover,
603 ;; `item' parser requires current list's structure as its first
604 ;; element.
605 ;;
606 ;; An interpreter accepts two arguments: the list representation of
607 ;; the element or object, and its contents. The latter may be nil,
608 ;; depending on the element or object considered. It returns the
609 ;; appropriate Org syntax, as a string.
610 ;;
611 ;; Parsing functions must follow the naming convention:
612 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
613 ;; defined in `org-element-greater-elements'.
614 ;;
615 ;; Similarly, interpreting functions must follow the naming
616 ;; convention: org-element-TYPE-interpreter.
617 ;;
618 ;; With the exception of `headline' and `item' types, greater elements
619 ;; cannot contain other greater elements of their own type.
620 ;;
621 ;; Beside implementing a parser and an interpreter, adding a new
622 ;; greater element requires to tweak `org-element--current-element'.
623 ;; Moreover, the newly defined type must be added to both
624 ;; `org-element-all-elements' and `org-element-greater-elements'.
627 ;;;; Center Block
630 "Parse a center block.
632 LIMIT bounds the search. AFFILIATED is a list of which CAR is
633 the buffer position at the beginning of the first affiliated
634 keyword and CDR is a plist of affiliated keywords along with
635 their value.
637 Return a list whose CAR is `center-block' and CDR is a plist
638 containing `:begin', `:end', `:contents-begin', `:contents-end',
639 `:post-blank' and `:post-affiliated' keywords.
641 Assume point is at the beginning of the block."
645 ;; Incomplete block: parse it as a paragraph.
650 ;; Empty blocks have no contents.
664 :end end
665 :contents-begin contents-begin
666 :contents-end contents-end
672 "Interpret CENTER-BLOCK element as Org syntax.
673 CONTENTS is the contents of the element."
677 ;;;; Drawer
680 "Parse a drawer.
682 LIMIT bounds the search. AFFILIATED is a list of which CAR is
683 the buffer position at the beginning of the first affiliated
684 keyword and CDR is a plist of affiliated keywords along with
685 their value.
687 Return a list whose CAR is `drawer' and CDR is a plist containing
688 `:drawer-name', `:begin', `:end', `:contents-begin',
689 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
691 Assume point is at beginning of drawer."
694 ;; Incomplete drawer: parse it as a paragraph.
702 ;; Empty drawers have no contents.
715 :end end
716 :drawer-name name
717 :contents-begin contents-begin
718 :contents-end contents-end
724 "Interpret DRAWER element as Org syntax.
725 CONTENTS is the contents of the element."
728 contents))
731 ;;;; Dynamic Block
734 "Parse a dynamic block.
736 LIMIT bounds the search. AFFILIATED is a list of which CAR is
737 the buffer position at the beginning of the first affiliated
738 keyword and CDR is a plist of affiliated keywords along with
739 their value.
741 Return a list whose CAR is `dynamic-block' and CDR is a plist
742 containing `:block-name', `:begin', `:end', `:contents-begin',
743 `:contents-end', `:arguments', `:post-blank' and
744 `:post-affiliated' keywords.
746 Assume point is at beginning of dynamic block."
750 ;; Incomplete block: parse it as a paragraph.
759 ;; Empty blocks have no contents.
772 :end end
773 :block-name name
774 :arguments arguments
775 :contents-begin contents-begin
776 :contents-end contents-end
782 "Interpret DYNAMIC-BLOCK element as Org syntax.
783 CONTENTS is the contents of the element."
788 contents))
791 ;;;; Footnote Definition
794 "Parse a footnote definition.
796 LIMIT bounds the search. AFFILIATED is a list of which CAR is
797 the buffer position at the beginning of the first affiliated
798 keyword and CDR is a plist of affiliated keywords along with
799 their value.
801 Return a list whose CAR is `footnote-definition' and CDR is
802 a plist containing `:label', `:begin' `:end', `:contents-begin',
803 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
805 Assume point is at the beginning of the footnote definition."
833 :begin begin
834 :end end
835 :contents-begin contents-begin
836 :contents-end contents-end
842 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
843 CONTENTS is the contents of the footnote-definition."
845 " "
846 contents))
849 ;;;; Headline
852 "Return node properties associated to headline at point.
853 Upcase property names. It avoids confusion between properties
854 obtained through property drawer and default properties from the
855 parser (e.g. `:end' and :END:). Return value is a plist."
867 properties))))
870 "Return time properties associated to headline at point.
871 Return value is a plist."
885 plist))))
888 "Parse a headline.
890 Return a list whose CAR is `headline' and CDR is a plist
891 containing `:raw-value', `:title', `:begin', `:end',
892 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
893 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
894 `:deadline', `:closed', `:archivedp', `:commentedp'
895 `:footnote-section-p', `:post-blank' and `:post-affiliated'
896 keywords.
898 The plist also contains any property set in the property drawer,
899 with its name in upper cases and colons added at the
900 beginning (e.g., `:CUSTOM_ID').
902 LIMIT is a buffer position bounding the search.
904 When RAW-SECONDARY-P is non-nil, headline's title will not be
905 parsed as a secondary string, but as a plain string instead.
907 Assume point is at beginning of the headline."
950 ;; Clean TAGS from archive tag, if any.
956 :begin begin
957 :end end
958 :pre-blank
961 :contents-begin contents-begin
962 :contents-end contents-end
963 :level level
964 :priority priority
965 :tags tags
966 :todo-keyword todo
967 :todo-type todo-type
970 end)
971 :footnote-section-p footnote-section-p
972 :archivedp archivedp
973 :commentedp commentedp
975 time-props
976 standard-props))))
978 headline :title
987 nil
993 "Interpret HEADLINE element as Org syntax.
994 CONTENTS is the contents of the element."
1010 ?*)
1014 " "
1017 org-footnote-section
1018 title))))
1020 heading
1021 ;; Align tags.
1029 ?\s)
1030 tags))
1034 tags))))
1036 contents)))
1039 ;;;; Inlinetask
1042 "Parse an inline task.
1044 Return a list whose CAR is `inlinetask' and CDR is a plist
1045 containing `:title', `:begin', `:end', `:contents-begin' and
1046 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1047 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1048 `:closed', `:post-blank' and `:post-affiliated' keywords.
1050 The plist also contains any property set in the property drawer,
1051 with its name in upper cases and colons added at the
1052 beginning (e.g., `:CUSTOM_ID').
1054 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1055 title will not be parsed as a secondary string, but as a plain
1056 string instead.
1058 Assume point is at beginning of the inline task."
1103 :begin begin
1104 :end end
1105 :contents-begin contents-begin
1106 :contents-end contents-end
1107 :level level
1108 :priority priority
1109 :tags tags
1110 :todo-keyword todo
1111 :todo-type todo-type
1114 time-props
1115 standard-props))))
1117 inlinetask :title
1126 nil
1132 "Interpret INLINETASK element as Org syntax.
1133 CONTENTS is the contents of inlinetask."
1147 ;; Align tags.
1155 ? )
1156 tags))
1160 tags))))
1161 ;; Prefer degenerate inlinetasks when there are no
1162 ;; contents.
1165 contents
1169 ;;;; Item
1172 "Parse an item.
1174 STRUCT is the structure of the plain list.
1176 Return a list whose CAR is `item' and CDR is a plist containing
1177 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1178 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1179 `:post-affiliated' keywords.
1181 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1182 any, will not be parsed as a secondary string, but as a plain
1183 string instead.
1185 Assume point is at the beginning of the item."
1209 ;; Ignore tags in un-ordered lists: they are just
1210 ;; a part of item's body.
1216 ;; If first line isn't empty, contents really start
1217 ;; at the text after item's meta-data.
1226 :begin begin
1227 :end end
1228 ;; CONTENTS-BEGIN and CONTENTS-END may be
1229 ;; mixed up in the case of an empty item
1230 ;; separated from the next by a blank line.
1231 ;; Thus ensure the former is always the
1232 ;; smallest.
1235 :checkbox checkbox
1236 :counter counter
1237 :structure struct
1241 item :tag
1252 "Interpret ITEM element as Org syntax.
1253 CONTENTS is the contents of the element."
1263 ;; Compute indentation.
1268 ;; Indent contents.
1270 bullet
1284 ;;;; Plain List
1287 ;; Return structure of list at point. Internal function. See
1288 ;; `org-list-struct' for details.
1293 items struct)
1298 ;; At limit: end all items.
1307 ;; At list end: end all items.
1312 ;; At a new item: end previous sibling.
1324 ind
1325 bullet
1328 ;; Description tag.
1332 ;; Ending position, unknown so far.
1333 nil)))
1334 items))
1336 ;; Skip empty lines.
1338 ;; Skip inline tasks and blank lines along the way.
1345 ;; At some text line. Check if it ends any previous item.
1357 ;; Skip blocks (any type) and drawers contents.
1362 limit t)))
1368 "Parse a plain list.
1370 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1371 the buffer position at the beginning of the first affiliated
1372 keyword and CDR is a plist of affiliated keywords along with
1373 their value. STRUCTURE is the structure of the plain list being
1374 parsed.
1376 Return a list whose CAR is `plain-list' and CDR is a plist
1377 containing `:type', `:begin', `:end', `:contents-begin' and
1378 `:contents-end', `:structure', `:post-blank' and
1379 `:post-affiliated' keywords.
1381 Assume point is at the beginning of the list."
1395 pos))
1399 ;; Return value.
1403 :begin begin
1404 :end end
1405 :contents-begin contents-begin
1406 :contents-end contents-end
1407 :structure struct
1413 "Interpret PLAIN-LIST element as Org syntax.
1414 CONTENTS is the contents of the element."
1422 ;;;; Property Drawer
1425 "Parse a property drawer.
1427 LIMIT bounds the search.
1429 Return a list whose car is `property-drawer' and cdr is a plist
1430 containing `:begin', `:end', `:contents-begin', `:contents-end',
1431 `:post-blank' and `:post-affiliated' keywords.
1433 Assume point is at the beginning of the property drawer."
1446 :end end
1448 :contents-end contents-end
1453 "Interpret PROPERTY-DRAWER element as Org syntax.
1454 CONTENTS is the properties within the drawer."
1458 ;;;; Quote Block
1461 "Parse a quote block.
1463 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1464 the buffer position at the beginning of the first affiliated
1465 keyword and CDR is a plist of affiliated keywords along with
1466 their value.
1468 Return a list whose CAR is `quote-block' and CDR is a plist
1469 containing `:begin', `:end', `:contents-begin', `:contents-end',
1470 `:post-blank' and `:post-affiliated' keywords.
1472 Assume point is at the beginning of the block."
1476 ;; Incomplete block: parse it as a paragraph.
1482 ;; Empty blocks have no contents.
1495 :end end
1496 :contents-begin contents-begin
1497 :contents-end contents-end
1503 "Interpret QUOTE-BLOCK element as Org syntax.
1504 CONTENTS is the contents of the element."
1508 ;;;; Section
1511 "Parse a section.
1513 LIMIT bounds the search.
1515 Return a list whose CAR is `section' and CDR is a plist
1516 containing `:begin', `:end', `:contents-begin', `contents-end',
1517 `:post-blank' and `:post-affiliated' keywords."
1519 ;; Beginning of section is the beginning of the first non-blank
1520 ;; line after previous headline.
1529 :end end
1530 :contents-begin begin
1531 :contents-end pos-before-blank
1536 "Interpret SECTION element as Org syntax.
1537 CONTENTS is the contents of the element."
1538 contents)
1541 ;;;; Special Block
1544 "Parse a special block.
1546 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1547 the buffer position at the beginning of the first affiliated
1548 keyword and CDR is a plist of affiliated keywords along with
1549 their value.
1551 Return a list whose CAR is `special-block' and CDR is a plist
1552 containing `:type', `:begin', `:end', `:contents-begin',
1553 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1555 Assume point is at the beginning of the block."
1562 limit t)))
1563 ;; Incomplete block: parse it as a paragraph.
1569 ;; Empty blocks have no contents.
1582 :begin begin
1583 :end end
1584 :contents-begin contents-begin
1585 :contents-end contents-end
1591 "Interpret SPECIAL-BLOCK element as Org syntax.
1592 CONTENTS is the contents of the element."
1597 \f
1598 ;;; Elements
1599 ;;
1600 ;; For each element, a parser and an interpreter are also defined.
1601 ;; Both follow the same naming convention used for greater elements.
1602 ;;
1603 ;; Also, as for greater elements, adding a new element type is done
1604 ;; through the following steps: implement a parser and an interpreter,
1605 ;; tweak `org-element--current-element' so that it recognizes the new
1606 ;; type and add that new type to `org-element-all-elements'.
1607 ;;
1608 ;; As a special case, when the newly defined type is a block type,
1609 ;; `org-element-block-name-alist' has to be modified accordingly.
1612 ;;;; Babel Call
1615 "Parse a babel call.
1617 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1618 the buffer position at the beginning of the first affiliated
1619 keyword and CDR is a plist of affiliated keywords along with
1620 their value.
1622 Return a list whose CAR is `babel-call' and CDR is a plist
1623 containing `:begin', `:end', `:value', `:post-blank' and
1624 `:post-affiliated' as keywords."
1638 :end end
1639 :value value
1645 "Interpret BABEL-CALL element as Org syntax.
1646 CONTENTS is nil."
1650 ;;;; Clock
1653 "Parse a clock.
1655 LIMIT bounds the search.
1657 Return a list whose CAR is `clock' and CDR is a plist containing
1658 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1659 `:post-affiliated' as keywords."
1679 :value value
1680 :duration duration
1681 :begin begin
1682 :end end
1683 :post-blank post-blank
1687 "Interpret CLOCK element as Org syntax.
1688 CONTENTS is nil."
1696 "%2s:%02s"
1700 ;;;; Comment
1703 "Parse a comment.
1705 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1706 the buffer position at the beginning of the first affiliated
1707 keyword and CDR is a plist of affiliated keywords along with
1708 their value.
1710 Return a list whose CAR is `comment' and CDR is a plist
1711 containing `:begin', `:end', `:value', `:post-blank',
1712 `:post-affiliated' keywords.
1714 Assume point is at comment beginning."
1723 ;; Get comments ending.
1726 ;; Accumulate lines without leading hash and first
1727 ;; whitespace.
1741 :end end
1742 :value value
1748 "Interpret COMMENT element as Org syntax.
1749 CONTENTS is nil."
1753 ;;;; Comment Block
1756 "Parse an export block.
1758 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1759 the buffer position at the beginning of the first affiliated
1760 keyword and CDR is a plist of affiliated keywords along with
1761 their value.
1763 Return a list whose CAR is `comment-block' and CDR is a plist
1764 containing `:begin', `:end', `:value', `:post-blank' and
1765 `:post-affiliated' keywords.
1767 Assume point is at comment block beginning."
1771 ;; Incomplete block: parse it as a paragraph.
1784 contents-begin contents-end)))
1788 :end end
1789 :value value
1795 "Interpret COMMENT-BLOCK element as Org syntax.
1796 CONTENTS is nil."
1803 ;;;; Diary Sexp
1806 "Parse a diary sexp.
1808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1809 the buffer position at the beginning of the first affiliated
1810 keyword and CDR is a plist of affiliated keywords along with
1811 their value.
1813 Return a list whose CAR is `diary-sexp' and CDR is a plist
1814 containing `:begin', `:end', `:value', `:post-blank' and
1815 `:post-affiliated' keywords."
1827 :begin begin
1828 :end end
1834 "Interpret DIARY-SEXP as Org syntax.
1835 CONTENTS is nil."
1839 ;;;; Example Block
1842 "Parse an example block.
1844 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1845 the buffer position at the beginning of the first affiliated
1846 keyword and CDR is a plist of affiliated keywords along with
1847 their value.
1849 Return a list whose CAR is `example-block' and CDR is a plist
1850 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1851 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1852 `:value', `:post-blank' and `:post-affiliated' keywords."
1856 ;; Incomplete block: parse it as a paragraph.
1864 ;; Switches analysis
1871 ;; Should labels be retained in (or stripped from) example
1872 ;; blocks?
1877 ;; What should code-references use - labels or
1878 ;; line-numbers?
1887 ;; Standard block parsing.
1895 contents-begin contents-end))
1896 block-ind))
1905 :end end
1906 :value value
1907 :switches switches
1908 :number-lines number-lines
1909 :preserve-indent preserve-indent
1910 :retain-labels retain-labels
1911 :use-labels use-labels
1912 :label-fmt label-fmt
1918 "Interpret EXAMPLE-BLOCK element as Org syntax.
1919 CONTENTS is nil."
1927 value
1932 ;;;; Export Block
1935 "Parse an export block.
1937 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1938 the buffer position at the beginning of the first affiliated
1939 keyword and CDR is a plist of affiliated keywords along with
1940 their value.
1942 Return a list whose CAR is `export-block' and CDR is a plist
1943 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1944 `:post-affiliated' keywords.
1946 Assume point is at export-block beginning."
1953 ;; Incomplete block: parse it as a paragraph.
1966 contents-end)))
1970 :end end
1971 :type type
1972 :value value
1978 "Interpret EXPORT-BLOCK element as Org syntax.
1979 CONTENTS is nil."
1986 ;;;; Fixed-width
1989 "Parse a fixed-width section.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `fixed-width' and CDR is a plist
1997 containing `:begin', `:end', `:value', `:post-blank' and
1998 `:post-affiliated' keywords.
2000 Assume point is at the beginning of the fixed-width area."
2004 value
2009 ;; Accumulate text without starting colons.
2022 :end end
2023 :value value
2029 "Interpret FIXED-WIDTH element as Org syntax.
2030 CONTENTS is nil."
2038 ;;;; Horizontal Rule
2041 "Parse an horizontal rule.
2043 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2044 the buffer position at the beginning of the first affiliated
2045 keyword and CDR is a plist of affiliated keywords along with
2046 their value.
2048 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2049 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2050 keywords."
2060 :end end
2066 "Interpret HORIZONTAL-RULE element as Org syntax.
2067 CONTENTS is nil."
2071 ;;;; Keyword
2074 "Parse a keyword at point.
2076 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2077 the buffer position at the beginning of the first affiliated
2078 keyword and CDR is a plist of affiliated keywords along with
2079 their value.
2081 Return a list whose CAR is `keyword' and CDR is a plist
2082 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2083 `:post-affiliated' keywords."
2085 ;; An orphaned affiliated keyword is considered as a regular
2086 ;; keyword. In this case AFFILIATED is nil, so we take care of
2087 ;; this corner case.
2100 :value value
2101 :begin begin
2102 :end end
2108 "Interpret KEYWORD element as Org syntax.
2109 CONTENTS is nil."
2115 ;;;; Latex Environment
2119 "Regexp matching the beginning of a LaTeX environment.
2120 The environment is captured by the first group.
2126 "Format string matching the ending of a LaTeX environment.
2130 "Parse a LaTeX environment.
2132 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2133 the buffer position at the beginning of the first affiliated
2134 keyword and CDR is a plist of affiliated keywords along with
2135 their value.
2137 Return a list whose CAR is `latex-environment' and CDR is a plist
2138 containing `:begin', `:end', `:value', `:post-blank' and
2139 `:post-affiliated' keywords.
2141 Assume point is at the beginning of the latex environment."
2148 limit t))
2149 ;; Incomplete latex environment: parse it as a paragraph.
2159 :end end
2160 :value value
2166 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2167 CONTENTS is nil."
2171 ;;;; Node Property
2174 "Parse a node-property at point.
2176 LIMIT bounds the search.
2178 Return a list whose CAR is `node-property' and CDR is a plist
2179 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2180 `:post-affiliated' keywords."
2190 limit))))
2193 :value value
2194 :begin begin
2195 :end end
2200 "Interpret NODE-PROPERTY element as Org syntax.
2201 CONTENTS is nil."
2207 ;;;; Paragraph
2210 "Parse a paragraph.
2212 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2213 the buffer position at the beginning of the first affiliated
2214 keyword and CDR is a plist of affiliated keywords along with
2215 their value.
2217 Return a list whose CAR is `paragraph' and CDR is a plist
2218 containing `:begin', `:end', `:contents-begin' and
2219 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2221 Assume point is at the beginning of the paragraph."
2230 limit
2231 ;; A matching `org-element-paragraph-separate' is not
2232 ;; necessarily the end of the paragraph. In
2233 ;; particular, lines starting with # or : as a first
2234 ;; non-space character are ambiguous. We have to
2235 ;; check if they are valid Org syntax (e.g., not an
2236 ;; incomplete keyword).
2240 ;; There's no ambiguity for other symbols or
2241 ;; empty lines: stop here.
2243 ;; Stop at valid fixed-width areas.
2245 ;; Stop at drawers.
2250 ;; Stop at valid comments.
2252 ;; Stop at valid dynamic blocks.
2257 ;; Stop at valid blocks.
2264 limit t)))
2265 ;; Stop at valid latex environments.
2272 limit t)))
2273 ;; Stop at valid keywords.
2275 ;; Skip everything else.
2292 :end end
2293 :contents-begin contents-begin
2294 :contents-end contents-end
2300 "Interpret PARAGRAPH element as Org syntax.
2301 CONTENTS is the contents of the element."
2302 contents)
2305 ;;;; Planning
2308 "Parse a planning.
2310 LIMIT bounds the search.
2312 Return a list whose CAR is `planning' and CDR is a plist
2313 containing `:closed', `:deadline', `:scheduled', `:begin',
2314 `:end', `:post-blank' and `:post-affiliated' keywords."
2324 closed deadline scheduled)
2336 :deadline deadline
2337 :scheduled scheduled
2338 :begin begin
2339 :end end
2340 :post-blank post-blank
2344 "Interpret PLANNING element as Org syntax.
2345 CONTENTS is nil."
2347 'identity
2364 ;;;; Src Block
2367 "Parse a src block.
2369 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2370 the buffer position at the beginning of the first affiliated
2371 keyword and CDR is a plist of affiliated keywords along with
2372 their value.
2374 Return a list whose CAR is `src-block' and CDR is a plist
2375 containing `:language', `:switches', `:parameters', `:begin',
2376 `:end', `:number-lines', `:retain-labels', `:use-labels',
2377 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2378 `:post-affiliated' keywords.
2380 Assume point is at the beginning of the block."
2383 limit t)))
2384 ;; Incomplete block: parse it as a paragraph.
2390 ;; Get language as a string.
2399 ;; Get switches.
2401 ;; Get parameters.
2403 ;; Switches analysis
2414 ;; Should labels be retained in (or stripped from)
2415 ;; src blocks?
2420 ;; What should code-references use - labels or
2421 ;; line-numbers?
2426 ;; Indentation.
2428 ;; Retrieve code.
2433 block-ind))
2437 ;; Get position after ending blank lines.
2447 :begin begin
2448 :end end
2449 :number-lines number-lines
2450 :preserve-indent preserve-indent
2451 :retain-labels retain-labels
2452 :use-labels use-labels
2453 :label-fmt label-fmt
2454 :value value
2460 "Interpret SRC-BLOCK element as Org syntax.
2461 CONTENTS is nil."
2470 val)
2484 ;;;; Table
2487 "Parse a table at point.
2489 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2490 the buffer position at the beginning of the first affiliated
2491 keyword and CDR is a plist of affiliated keywords along with
2492 their value.
2494 Return a list whose CAR is `table' and CDR is a plist containing
2495 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2496 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2497 keywords.
2499 Assume point is at the beginning of the table."
2513 acc))
2520 :end end
2521 :type type
2522 :tblfm tblfm
2523 ;; Only `org' tables have contents. `table.el' tables
2524 ;; use a `:value' property to store raw table as
2525 ;; a string.
2530 table-begin table-end))
2536 "Interpret TABLE element as Org syntax.
2537 CONTENTS is a string, if table's type is `org', or nil."
2548 ;;;; Table Row
2551 "Parse table row at point.
2553 LIMIT bounds the search.
2555 Return a list whose CAR is `table-row' and CDR is a plist
2556 containing `:begin', `:end', `:contents-begin', `:contents-end',
2557 `:type', `:post-blank' and `:post-affiliated' keywords."
2561 ;; A table rule has no contents. In that case, ensure
2562 ;; CONTENTS-BEGIN matches CONTENTS-END.
2574 :begin begin
2575 :end end
2576 :contents-begin contents-begin
2577 :contents-end contents-end
2582 "Interpret TABLE-ROW element as Org syntax.
2583 CONTENTS is the contents of the table row."
2588 ;;;; Verse Block
2591 "Parse a verse block.
2593 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2594 the buffer position at the beginning of the first affiliated
2595 keyword and CDR is a plist of affiliated keywords along with
2596 their value.
2598 Return a list whose CAR is `verse-block' and CDR is a plist
2599 containing `:begin', `:end', `:contents-begin', `:contents-end',
2600 `:post-blank' and `:post-affiliated' keywords.
2602 Assume point is at beginning of the block."
2606 ;; Incomplete block: parse it as a paragraph.
2621 :end end
2622 :contents-begin contents-begin
2623 :contents-end contents-end
2629 "Interpret VERSE-BLOCK element as Org syntax.
2630 CONTENTS is verse block contents."
2634 \f
2635 ;;; Objects
2636 ;;
2637 ;; Unlike to elements, raw text can be found between objects. Hence,
2638 ;; `org-element--object-lex' is provided to find the next object in
2639 ;; buffer.
2640 ;;
2641 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2642 ;; object types they can contain will be specified in
2643 ;; `org-element-object-restrictions'.
2644 ;;
2645 ;; Creating a new type of object requires to alter
2646 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2647 ;; new type in `org-element-all-objects', and possibly add
2648 ;; restrictions in `org-element-object-restrictions'.
2650 ;;;; Bold
2653 "Parse bold object at point, if any.
2655 When at a bold object, return a list whose car is `bold' and cdr
2656 is a plist with `:begin', `:end', `:contents-begin' and
2657 `:contents-end' and `:post-blank' keywords. Otherwise, return
2658 nil.
2660 Assume point is at the first star marker."
2672 :end end
2673 :contents-begin contents-begin
2674 :contents-end contents-end
2678 "Interpret BOLD object as Org syntax.
2679 CONTENTS is the contents of the object."
2683 ;;;; Code
2686 "Parse code object at point, if any.
2688 When at a code object, return a list whose car is `code' and cdr
2689 is a plist with `:value', `:begin', `:end' and `:post-blank'
2690 keywords. Otherwise, return nil.
2692 Assume point is at the first tilde marker."
2703 :begin begin
2704 :end end
2708 "Interpret CODE object as Org syntax.
2709 CONTENTS is nil."
2713 ;;;; Entity
2716 "Parse entity at point, if any.
2718 When at an entity, return a list whose car is `entity' and cdr
2719 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2720 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2721 `:post-blank' as keywords. Otherwise, return nil.
2723 Assume point is at the beginning of the entity."
2725 (when (looking-at "\\\\\\(?:\\(\\.+\\)\\({}\\)?\\|\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)\\)")
2743 :begin begin
2744 :end end
2745 :use-brackets-p bracketsp
2749 "Interpret ENTITY object as Org syntax.
2750 CONTENTS is nil."
2756 ;;;; Export Snippet
2759 "Parse export snippet at point.
2761 When at an export snippet, return a list whose car is
2762 `export-snippet' and cdr a plist with `:begin', `:end',
2763 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2764 return nil.
2766 Assume point is at the beginning of the snippet."
2782 :value value
2783 :begin begin
2784 :end end
2788 "Interpret EXPORT-SNIPPET object as Org syntax.
2789 CONTENTS is nil."
2795 ;;;; Footnote Reference
2798 "Parse footnote reference at point, if any.
2800 When at a footnote reference, return a list whose car is
2801 `footnote-reference' and cdr a plist with `:label', `:type',
2802 `:begin', `:end', `:content-begin', `:contents-end' and
2803 `:post-blank' as keywords. Otherwise, return nil."
2823 :type type
2824 :begin begin
2825 :end end
2831 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2832 CONTENTS is its definition, when inline, or nil."
2838 ;;;; Inline Babel Call
2841 "Parse inline babel call at point, if any.
2843 When at an inline babel call, return a list whose car is
2844 `inline-babel-call' and cdr a plist with `:begin', `:end',
2845 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2847 Assume point is at the beginning of the babel call."
2859 :end end
2860 :value value
2864 "Interpret INLINE-BABEL-CALL object as Org syntax.
2865 CONTENTS is nil."
2869 ;;;; Inline Src Block
2872 "Parse inline source block at point, if any.
2874 When at an inline source block, return a list whose car is
2875 `inline-src-block' and cdr a plist with `:begin', `:end',
2876 `:language', `:value', `:parameters' and `:post-blank' as
2877 keywords. Otherwise, return nil.
2879 Assume point is at the beginning of the inline src block."
2892 :value value
2893 :parameters parameters
2894 :begin begin
2895 :end end
2899 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2900 CONTENTS is nil."
2905 language
2907 body)))
2909 ;;;; Italic
2912 "Parse italic object at point, if any.
2914 When at an italic object, return a list whose car is `italic' and
2915 cdr is a plist with `:begin', `:end', `:contents-begin' and
2916 `:contents-end' and `:post-blank' keywords. Otherwise, return
2917 nil.
2919 Assume point is at the first slash marker."
2931 :end end
2932 :contents-begin contents-begin
2933 :contents-end contents-end
2937 "Interpret ITALIC object as Org syntax.
2938 CONTENTS is the contents of the object."
2942 ;;;; Latex Fragment
2945 "Parse LaTeX fragment at point, if any.
2947 When at a LaTeX fragment, return a list whose car is
2948 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2949 and `:post-blank' as keywords. Otherwise, return nil.
2951 Assume point is at the beginning of the LaTeX fragment."
2969 ;; Macro.
2978 :begin begin
2979 :end end
2983 "Interpret LATEX-FRAGMENT object as Org syntax.
2984 CONTENTS is nil."
2987 ;;;; Line Break
2990 "Parse line break at point, if any.
2992 When at a line break, return a list whose car is `line-break',
2993 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2994 Otherwise, return nil.
2996 Assume point is at the beginning of the line break."
3005 "Interpret LINE-BREAK object as Org syntax.
3006 CONTENTS is nil."
3010 ;;;; Link
3013 "Parse link at point, if any.
3015 When at a link, return a list whose car is `link' and cdr a plist
3016 with `:type', `:path', `:raw-link', `:application',
3017 `:search-option', `:begin', `:end', `:contents-begin',
3018 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3019 nil.
3021 Assume point is at the beginning of the link."
3024 end contents-begin contents-end link-end post-blank path type
3025 raw-link link search-option application)
3027 ;; Type 1: Text targeted from a radio target.
3036 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3041 ;; RAW-LINK is the original link. Expand any
3042 ;; abbreviation in it.
3046 ;; Determine TYPE of link and set PATH accordingly.
3048 ;; File type.
3052 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3055 ;; According to RFC 3986, extra whitespace should be
3056 ;; ignored when a URI is extracted.
3059 ;; Id type: PATH is the id.
3062 ;; Code-ref type: PATH is the name of the reference.
3065 ;; Custom-id type: PATH is the name of the custom id.
3068 ;; Fuzzy type: Internal link either matches a target, an
3069 ;; headline name or nothing. PATH is the target or
3070 ;; headline's name.
3072 ;; Type 3: Plain link, e.g., http://orgmode.org
3078 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3086 ;; In any case, deduce end point after trailing white space from
3087 ;; LINK-END variable.
3091 ;; Special "file" type link processing. Extract opening
3092 ;; application and search option, if any. Also normalize URI.
3103 :path path
3105 :application application
3106 :search-option search-option
3107 :begin begin
3108 :end end
3109 :contents-begin contents-begin
3110 :contents-end contents-end
3114 "Interpret LINK object as Org syntax.
3115 CONTENTS is the contents of the object, or nil."
3120 raw-link
3124 ;;;; Macro
3127 "Parse macro at point, if any.
3129 When at a macro, return a list whose car is `macro' and cdr
3130 a plist with `:key', `:args', `:begin', `:end', `:value' and
3131 `:post-blank' as keywords. Otherwise, return nil.
3133 Assume point is at the macro."
3146 :value value
3147 :args args
3148 :begin begin
3149 :end end
3153 "Interpret MACRO object as Org syntax.
3154 CONTENTS is nil."
3158 ;;;; Radio-target
3161 "Parse radio target at point, if any.
3163 When at a radio target, return a list whose car is `radio-target'
3164 and cdr a plist with `:begin', `:end', `:contents-begin',
3165 `:contents-end', `:value' and `:post-blank' as keywords.
3166 Otherwise, return nil.
3168 Assume point is at the radio target."
3180 :end end
3181 :contents-begin contents-begin
3182 :contents-end contents-end
3183 :post-blank post-blank
3187 "Interpret TARGET object as Org syntax.
3188 CONTENTS is the contents of the object."
3192 ;;;; Statistics Cookie
3195 "Parse statistics cookie at point, if any.
3197 When at a statistics cookie, return a list whose car is
3198 `statistics-cookie', and cdr a plist with `:begin', `:end',
3199 `:value' and `:post-blank' keywords. Otherwise, return nil.
3201 Assume point is at the beginning of the statistics-cookie."
3212 :end end
3213 :value value
3217 "Interpret STATISTICS-COOKIE object as Org syntax.
3218 CONTENTS is nil."
3222 ;;;; Strike-Through
3225 "Parse strike-through object at point, if any.
3227 When at a strike-through object, return a list whose car is
3228 `strike-through' and cdr is a plist with `:begin', `:end',
3229 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3230 Otherwise, return nil.
3232 Assume point is at the first plus sign marker."
3244 :end end
3245 :contents-begin contents-begin
3246 :contents-end contents-end
3250 "Interpret STRIKE-THROUGH object as Org syntax.
3251 CONTENTS is the contents of the object."
3255 ;;;; Subscript
3258 "Parse subscript at point, if any.
3260 When at a subscript object, return a list whose car is
3261 `subscript' and cdr a plist with `:begin', `:end',
3262 `:contents-begin', `:contents-end', `:use-brackets-p' and
3263 `:post-blank' as keywords. Otherwise, return nil.
3265 Assume point is at the underscore."
3279 :end end
3280 :use-brackets-p bracketsp
3281 :contents-begin contents-begin
3282 :contents-end contents-end
3286 "Interpret SUBSCRIPT object as Org syntax.
3287 CONTENTS is the contents of the object."
3290 contents))
3293 ;;;; Superscript
3296 "Parse superscript at point, if any.
3298 When at a superscript object, return a list whose car is
3299 `superscript' and cdr a plist with `:begin', `:end',
3300 `:contents-begin', `:contents-end', `:use-brackets-p' and
3301 `:post-blank' as keywords. Otherwise, return nil.
3303 Assume point is at the caret."
3317 :end end
3318 :use-brackets-p bracketsp
3319 :contents-begin contents-begin
3320 :contents-end contents-end
3324 "Interpret SUPERSCRIPT object as Org syntax.
3325 CONTENTS is the contents of the object."
3328 contents))
3331 ;;;; Table Cell
3334 "Parse table cell at point.
3335 Return a list whose car is `table-cell' and cdr is a plist
3336 containing `:begin', `:end', `:contents-begin', `:contents-end'
3337 and `:post-blank' keywords."
3345 :end end
3346 :contents-begin contents-begin
3347 :contents-end contents-end
3351 "Interpret TABLE-CELL element as Org syntax.
3352 CONTENTS is the contents of the cell, or nil."
3356 ;;;; Target
3359 "Parse target at point, if any.
3361 When at a target, return a list whose car is `target' and cdr
3362 a plist with `:begin', `:end', `:value' and `:post-blank' as
3363 keywords. Otherwise, return nil.
3365 Assume point is at the target."
3375 :end end
3376 :value value
3380 "Interpret TARGET object as Org syntax.
3381 CONTENTS is nil."
3385 ;;;; Timestamp
3396 "Parse time stamp at point, if any.
3398 When at a time stamp, return a list whose car is `timestamp', and
3399 cdr a plist with `:type', `:raw-value', `:year-start',
3400 `:month-start', `:day-start', `:hour-start', `:minute-start',
3401 `:year-end', `:month-end', `:day-end', `:hour-end',
3402 `:minute-end', `:repeater-type', `:repeater-value',
3403 `:repeater-unit', `:warning-type', `:warning-value',
3404 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3405 Otherwise, return nil.
3407 Assume point is at the beginning of the timestamp."
3426 date-start)
3437 raw-value)
3439 :repeater-type
3445 :repeater-unit
3454 :warning-unit
3457 year-start month-start day-start hour-start minute-start year-end
3458 month-end day-end hour-end minute-end)
3459 ;; Parse date-start.
3467 ;; Compute date-end. It can be provided directly in time-stamp,
3468 ;; or extracted from time range. Otherwise, it defaults to the
3469 ;; same values as date-start.
3479 :raw-value raw-value
3480 :year-start year-start
3481 :month-start month-start
3482 :day-start day-start
3483 :hour-start hour-start
3484 :minute-start minute-start
3485 :year-end year-end
3486 :month-end month-end
3487 :day-end day-end
3488 :hour-end hour-end
3489 :minute-end minute-end
3490 :begin begin
3491 :end end
3493 repeater-props
3494 warning-props))))))
3497 "Interpret TIMESTAMP object as Org syntax.
3498 CONTENTS is nil."
3517 ;; Build an Org timestamp string from TIME. ACTIVEP is
3518 ;; non-nil when time stamp is active. If WITH-TIME-P is
3519 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3520 ;; specify a time range in the timestamp. REPEAT-STRING is
3521 ;; the repeater string, if any.
3525 org-time-stamp-formats)
3526 time)))
3532 nil nil ts)))
3537 " "
3538 s
3540 ;; Return value.
3541 ts)))
3553 build-ts-string
3572 0
3580 "--"
3593 ;;;; Underline
3596 "Parse underline object at point, if any.
3598 When at an underline object, return a list whose car is
3599 `underline' and cdr is a plist with `:begin', `:end',
3600 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3601 Otherwise, return nil.
3603 Assume point is at the first underscore marker."
3615 :end end
3616 :contents-begin contents-begin
3617 :contents-end contents-end
3621 "Interpret UNDERLINE object as Org syntax.
3622 CONTENTS is the contents of the object."
3626 ;;;; Verbatim
3629 "Parse verbatim object at point, if any.
3631 When at a verbatim object, return a list whose car is `verbatim'
3632 and cdr is a plist with `:value', `:begin', `:end' and
3633 `:post-blank' keywords. Otherwise, return nil.
3635 Assume point is at the first equal sign marker."
3646 :begin begin
3647 :end end
3651 "Interpret VERBATIM object as Org syntax.
3652 CONTENTS is nil."
3656 \f
3657 ;;; Parsing Element Starting At Point
3658 ;;
3659 ;; `org-element--current-element' is the core function of this section.
3660 ;; It returns the Lisp representation of the element starting at
3661 ;; point.
3662 ;;
3663 ;; `org-element--current-element' makes use of special modes. They
3664 ;; are activated for fixed element chaining (e.g., `plain-list' >
3665 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3666 ;; `section'). Special modes are: `first-section', `item',
3667 ;; `node-property', `section' and `table-row'.
3670 "Parse the element starting at point.
3672 Return value is a list like (TYPE PROPS) where TYPE is the type
3673 of the element and PROPS a plist of properties associated to the
3674 element.
3676 Possible types are defined in `org-element-all-elements'.
3678 LIMIT bounds the search.
3680 Optional argument GRANULARITY determines the depth of the
3681 recursion. Allowed values are `headline', `greater-element',
3682 `element', `object' or nil. When it is broader than `object' (or
3683 nil), secondary values will not be parsed, since they only
3684 contain objects.
3686 Optional argument MODE, when non-nil, can be either
3687 `first-section', `section', `planning', `item', `node-property'
3688 and `table-row'.
3690 If STRUCTURE isn't provided but MODE is set to `item', it will be
3691 computed.
3693 This function assumes point is always at the beginning of the
3694 element it has to parse."
3697 ;; Determine if parsing depth allows for secondary strings
3698 ;; parsing. It only applies to elements referenced in
3699 ;; `org-element-secondary-value-alist'.
3702 ;; Item.
3705 ;; Table Row.
3707 ;; Node Property.
3709 ;; Headline.
3712 ;; Sections (must be checked after headline).
3717 limit)))
3718 ;; Planning.
3721 ;; Property drawer.
3725 ;; When not at bol, point is at the beginning of an item or
3726 ;; a footnote definition: next item is always a paragraph.
3728 ;; Clock.
3730 ;; Inlinetask.
3733 ;; From there, elements can have affiliated keywords.
3736 ;; Jumping over affiliated keywords put point off-limits.
3737 ;; Parse them as regular keywords.
3741 ;; LaTeX Environment.
3744 ;; Drawer and Property Drawer.
3747 ;; Fixed Width
3750 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3751 ;; Keywords.
3760 org-element-block-name-alist)))
3775 ;; Footnote Definition.
3778 ;; Horizontal Rule.
3781 ;; Diary Sexp.
3784 ;; Table.
3786 ;; List.
3789 limit affiliated
3791 ;; Default element: Paragraph.
3795 ;; Most elements can have affiliated keywords. When looking for an
3796 ;; element beginning, we want to move before them, as they belong to
3797 ;; that element, and, in the meantime, collect information they give
3798 ;; into appropriate properties. Hence the following function.
3801 "Collect affiliated keywords from point down to LIMIT.
3803 Return a list whose CAR is the position at the first of them and
3804 CDR a plist of keywords and values and move point to the
3805 beginning of the first line after them.
3807 As a special case, if element doesn't start at the beginning of
3808 the line (e.g., a paragraph starting an item), CAR is current
3809 position of point and CDR is nil."
3813 ;; RESTRICT is the list of objects allowed in parsed
3814 ;; keywords value.
3816 output)
3819 ;; Apply translation to RAW-KWD. From there, KWD is
3820 ;; the official keyword.
3822 org-element-keyword-translation-alist))
3823 raw-kwd))
3824 ;; Find main value for any keyword.
3830 ;; PARSEDP is non-nil when keyword should have its
3831 ;; value parsed.
3833 ;; If KWD is a dual keyword, find its secondary
3834 ;; value. Maybe parse it.
3842 ;; Attribute a property name to KWD.
3844 ;; Now set final shape for VALUE.
3850 nil restrict)))
3854 ;; Attributes can always appear on multiple lines.
3857 ;; Eventually store the new value in OUTPUT.
3859 ;; Move to next keyword.
3861 ;; If affiliated keywords are orphaned: move back to first one.
3862 ;; They will be parsed as a paragraph.
3864 ;; Return value.
3868 \f
3869 ;;; The Org Parser
3870 ;;
3871 ;; The two major functions here are `org-element-parse-buffer', which
3872 ;; parses Org syntax inside the current buffer, taking into account
3873 ;; region, narrowing, or even visibility if specified, and
3874 ;; `org-element-parse-secondary-string', which parses objects within
3875 ;; a given string.
3876 ;;
3877 ;; The (almost) almighty `org-element-map' allows to apply a function
3878 ;; on elements or objects matching some type, and accumulate the
3879 ;; resulting values. In an export situation, it also skips unneeded
3880 ;; parts of the parse tree.
3883 "Recursively parse the buffer and return structure.
3884 If narrowing is in effect, only parse the visible part of the
3885 buffer.
3887 Optional argument GRANULARITY determines the depth of the
3888 recursion. It can be set to the following symbols:
3890 `headline' Only parse headlines.
3891 `greater-element' Don't recurse into greater elements excepted
3892 headlines and sections. Thus, elements
3893 parsed are the top-level ones.
3894 `element' Parse everything but objects and plain text.
3895 `object' Parse the complete buffer (default).
3897 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3898 elements.
3900 An element or an objects is represented as a list with the
3901 pattern (TYPE PROPERTIES CONTENTS), where :
3903 TYPE is a symbol describing the element or object. See
3904 `org-element-all-elements' and `org-element-all-objects' for an
3905 exhaustive list of such symbols. One can retrieve it with
3906 `org-element-type' function.
3908 PROPERTIES is the list of attributes attached to the element or
3909 object, as a plist. Although most of them are specific to the
3910 element or object type, all types share `:begin', `:end',
3911 `:post-blank' and `:parent' properties, which respectively
3912 refer to buffer position where the element or object starts,
3913 ends, the number of white spaces or blank lines after it, and
3914 the element or object containing it. Properties values can be
3915 obtained by using `org-element-property' function.
3917 CONTENTS is a list of elements, objects or raw strings
3918 contained in the current element or object, when applicable.
3919 One can access them with `org-element-contents' function.
3921 The Org buffer has `org-data' as type and nil as properties.
3922 `org-element-map' function can be used to find specific elements
3923 or objects within the parse tree.
3925 This function assumes that current major mode is `org-mode'."
3931 ;; Start in `first-section' mode so text before the first
3932 ;; headline belongs to a section.
3936 "Recursively parse objects in STRING and return structure.
3938 RESTRICTION is a symbol limiting the object types that will be
3939 looked after.
3941 Optional argument PARENT, when non-nil, is the element or object
3942 containing the secondary string. It is used to set correctly
3943 `:parent' property within the string.
3945 If STRING is the empty string or nil, return nil."
3961 data))))))
3965 "Map a function on selected elements or objects.
3967 DATA is a parse tree, an element, an object, a string, or a list
3968 of such constructs. TYPES is a symbol or list of symbols of
3969 elements or objects types (see `org-element-all-elements' and
3970 `org-element-all-objects' for a complete list of types). FUN is
3971 the function called on the matching element or object. It has to
3972 accept one argument: the element or object itself.
3974 When optional argument INFO is non-nil, it should be a plist
3975 holding export options. In that case, parts of the parse tree
3976 not exportable according to that property list will be skipped.
3978 When optional argument FIRST-MATCH is non-nil, stop at the first
3979 match for which FUN doesn't return nil, and return that value.
3981 Optional argument NO-RECURSION is a symbol or a list of symbols
3982 representing elements or objects types. `org-element-map' won't
3983 enter any recursive element or object whose type belongs to that
3984 list. Though, FUN can still be applied on them.
3986 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3987 apply to matching objects within parsed affiliated keywords (see
3988 `org-element-parsed-keywords').
3990 Nil values returned from FUN do not appear in the results.
3993 Examples:
3994 ---------
3996 Assuming TREE is a variable containing an Org buffer parse tree,
3997 the following example will return a flat list of all `src-block'
3998 and `example-block' elements in it:
4000 \(org-element-map tree '(example-block src-block) #'identity)
4002 The following snippet will find the first headline with a level
4005 \(org-element-map tree 'headline
4006 \(lambda (hl)
4007 \(and (= (org-element-property :level hl) 1)
4009 \(org-element-property :begin hl)))
4010 nil t)
4012 The next example will return a flat list of all `plain-list' type
4013 elements in TREE that are not a sub-list themselves:
4015 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4017 Eventually, this example will return a flat list of all `bold'
4018 type objects containing a `latex-snippet' type object, even
4019 looking into captions:
4021 \(org-element-map tree 'bold
4022 \(lambda (b)
4023 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4024 nil nil nil t)"
4025 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4029 ;; Recursion depth is determined by --CATEGORY.
4036 ;; If one object is found, the function has to
4037 ;; recurse into every object.
4040 ;; If one regular element is found, the
4041 ;; function has to recurse, at least, into
4042 ;; every element it encounters.
4045 --acc
4046 --walk-tree
4049 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4050 ;; holding contextual information.
4054 ;; Ignored element in an export context.
4056 ;; List of elements or objects.
4058 ;; Unconditionally enter parse trees.
4062 ;; Check if TYPE is matching among TYPES. If so,
4063 ;; apply FUN to --DATA and accumulate return value
4064 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4070 ;; If --DATA has a secondary string that can contain
4071 ;; objects with their type among TYPES, look into it.
4074 org-element-secondary-value-alist)))
4076 ;; If --DATA has any parsed affiliated keywords and
4077 ;; WITH-AFFILIATED is non-nil, look for objects in
4078 ;; them.
4085 ;; Pay attention to the type of parsed keyword.
4086 ;; In particular, preserve order for multiple
4087 ;; keywords.
4100 ;; Determine if a recursion into --DATA is possible.
4102 ;; --TYPE is explicitly removed from recursion.
4104 ;; --DATA has no contents.
4106 ;; Looking for greater elements but --DATA is simply
4107 ;; an element or an object.
4110 ;; Looking for elements but --DATA is an object.
4113 ;; In any other case, map contents.
4117 ;; Return value in a proper order.
4121 ;; The following functions are internal parts of the parser.
4122 ;;
4123 ;; The first one, `org-element--parse-elements' acts at the element's
4124 ;; level.
4125 ;;
4126 ;; The second one, `org-element--parse-objects' applies on all objects
4127 ;; of a paragraph or a secondary string. It calls
4128 ;; `org-element--object-lex' to find the next object in the current
4129 ;; container.
4132 "Return next special mode according to TYPE, or nil.
4133 TYPE is a symbol representing the type of an element or object
4134 containing next element if PARENTP is non-nil, or before it
4135 otherwise. Modes can be either `first-section', `item',
4136 `node-property', `planning', `property-drawer', `section',
4137 `table-row' or nil."
4153 "Parse elements between BEG and END positions.
4155 MODE prioritizes some elements over the others. It can be set to
4156 `first-section', `section', `planning', `item', `node-property'
4157 or `table-row'.
4159 When value is `item', STRUCTURE will be used as the current list
4160 structure.
4162 GRANULARITY determines the depth of the recursion. See
4163 `org-element-parse-buffer' for more information.
4165 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4166 elements.
4168 Elements are accumulated into ACC."
4171 ;; Visible only: skip invisible parts at the beginning of the
4172 ;; element.
4175 ;; When parsing only headlines, skip any text before first one.
4178 ;; Main loop start.
4180 ;; Find current element's type and parse it accordingly to
4181 ;; its category.
4183 end granularity mode structure))
4187 ;; Visible only: skip invisible parts between siblings.
4190 ;; Fill ELEMENT contents by side-effect.
4192 ;; If element has no contents, don't modify it.
4194 ;; Greater element: parse it between `contents-begin' and
4195 ;; `contents-end'. Make sure GRANULARITY allows the
4196 ;; recursion, or ELEMENT is a headline, in which case going
4197 ;; inside is mandatory, in order to get sub-level headings.
4205 ;; Possibly switch to a special mode.
4209 granularity visible-only element))
4210 ;; ELEMENT has contents. Parse objects inside, if
4211 ;; GRANULARITY allows it.
4217 ;; Update mode.
4219 ;; Return result.
4220 acc))
4223 "Return next object in current buffer or nil.
4224 RESTRICTION is a list of object types, as symbols, that should be
4225 looked after. This function assumes that the buffer is narrowed
4226 to an appropriate container (e.g., a paragraph)."
4234 found)
4299 ;; This is probably a plain link.
4305 ;; Radio link.
4310 "Parse objects between BEG and END and return recursive structure.
4312 Objects are accumulated in ACC.
4314 RESTRICTION is a list of object successors which are allowed in
4315 the current object."
4323 ;; 1. Text before any object. Untabify it.
4328 acc
4332 ;; 2. Object...
4335 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4336 ;; a recursive type.
4344 ;; 3. Text after last object. Untabify it.
4348 acc
4352 ;; Result.
4353 acc)))
4356 \f
4357 ;;; Towards A Bijective Process
4358 ;;
4359 ;; The parse tree obtained with `org-element-parse-buffer' is really
4360 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4361 ;; interpreted and expanded into a string with canonical Org syntax.
4362 ;; Hence `org-element-interpret-data'.
4363 ;;
4364 ;; The function relies internally on
4365 ;; `org-element--interpret-affiliated-keywords'.
4367 ;;;###autoload
4369 "Interpret DATA as Org syntax.
4370 DATA is a parse tree, an element, an object or a secondary string
4371 to interpret. Return Org syntax as a string."
4375 "Interpret DATA as Org syntax.
4377 DATA is a parse tree, an element, an object or a secondary string
4378 to interpret. PARENT is used for recursive calls. It contains
4379 the element or object containing data, or nil.
4381 Return Org syntax as a string."
4383 ;; Find interpreter for current object or element. If it
4384 ;; doesn't exist (e.g. this is a pseudo object or element),
4385 ;; return contents, if any.
4391 ;; Secondary string.
4395 ;; Full Org document.
4399 ;; Plain text: return it.
4401 ;; Element or object without contents.
4403 ;; Element or object with contents.
4406 ;; Recursively interpret contents.
4411 data
4412 ;; Fix indentation of elements containing
4413 ;; objects. We ignore `table-row' elements
4414 ;; as they are one line long anyway.
4416 data
4417 ;; When normalizing first paragraph of an
4418 ;; item or a footnote-definition, ignore
4419 ;; first line's indentation.
4426 ;; Build white spaces. If no `:post-blank' property is
4427 ;; specified, assume its value is 0.
4441 "Return ELEMENT's affiliated keywords as Org syntax.
4442 If there is no affiliated keyword, return the empty string."
4452 ": "
4455 value)
4463 ;; All attribute keywords can have multiple lines.
4469 ;; List all ELEMENT's properties matching an attribute line or an
4470 ;; affiliated keyword, but ignore translated keywords since they
4471 ;; cannot belong to the property list.
4478 org-element-keyword-translation-alist)))))
4479 collect prop)
4482 ;; Because interpretation of the parse tree must return the same
4483 ;; number of blank lines between elements and the same number of white
4484 ;; space after objects, some special care must be given to white
4485 ;; spaces.
4486 ;;
4487 ;; The first function, `org-element-normalize-string', ensures any
4488 ;; string different from the empty string will end with a single
4489 ;; newline character.
4490 ;;
4491 ;; The second function, `org-element-normalize-contents', removes
4492 ;; global indentation from the contents of the current element.
4495 "Ensure string S ends with a single newline character.
4497 If S isn't a string return it unchanged. If S is the empty
4498 string, return it. Otherwise, return a new string with a single
4499 newline character at its end."
4507 "Normalize plain text in ELEMENT's contents.
4509 ELEMENT must only contain plain text and objects.
4511 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4512 indentation to compute maximal common indentation.
4514 Return the normalized element that is element with global
4515 indentation removed from its contents. The function assumes that
4516 indentation is not done with TAB characters."
4518 find-min-ind ; For byte-compiler.
4520 ;; Return minimal common indentation within BLOB. This is
4521 ;; done by walking recursively BLOB and updating MIN-IND
4522 ;; along the way. FIRST-FLAG is non-nil when the next
4523 ;; object is expected to be a string that doesn't start with
4524 ;; a newline character. It happens for strings at the
4525 ;; beginnings of the contents or right after a line break.
4530 ;; Objects cannot start with spaces: in this case,
4531 ;; indentation is 0.
4535 ;; An indentation of zero means no string will be
4536 ;; modified. Quit the process.
4547 ;; Find minimal indentation in ELEMENT.
4550 ;; Build ELEMENT back, replacing each string with the same
4551 ;; string minus common indentation.
4555 ;; Return BLOB with all its strings indentation
4556 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4557 ;; non-nil when the next object is expected to be
4558 ;; a string that doesn't start with a newline
4559 ;; character.
4575 org-element-recursive-objects)
4579 object)
4582 blob)))
4586 \f
4587 ;;; Cache
4588 ;;
4589 ;; Implement a caching mechanism for `org-element-at-point' and
4590 ;; `org-element-context', which see.
4591 ;;
4592 ;; A single public function is provided: `org-element-cache-reset'.
4593 ;;
4594 ;; Cache is enabled by default, but can be disabled globally with
4595 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4596 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4597 ;; can be tweaked to control caching behaviour.
4598 ;;
4599 ;; Internally, parsed elements are stored in an AVL tree,
4600 ;; `org-element--cache'. This tree is updated lazily: whenever
4601 ;; a change happens to the buffer, a synchronization request is
4602 ;; registered in `org-element--cache-sync-requests' (see
4603 ;; `org-element--cache-submit-request'). During idle time, requests
4604 ;; are processed by `org-element--cache-sync'. Synchronization also
4605 ;; happens when an element is required from the cache. In this case,
4606 ;; the process stops as soon as the needed element is up-to-date.
4607 ;;
4608 ;; A synchronization request can only apply on a synchronized part of
4609 ;; the cache. Therefore, the cache is updated at least to the
4610 ;; location where the new request applies. Thus, requests are ordered
4611 ;; from left to right and all elements starting before the first
4612 ;; request are correct. This property is used by functions like
4613 ;; `org-element--cache-find' to retrieve elements in the part of the
4614 ;; cache that can be trusted.
4615 ;;
4616 ;; A request applies to every element, starting from its original
4617 ;; location (or key, see below). When a request is processed, it
4618 ;; moves forward and may collide the next one. In this case, both
4619 ;; requests are merged into a new one that starts from that element.
4620 ;; As a consequence, the whole synchronization complexity does not
4621 ;; depend on the number of pending requests, but on the number of
4622 ;; elements the very first request will be applied on.
4623 ;;
4624 ;; Elements cannot be accessed through their beginning position, which
4625 ;; may or may not be up-to-date. Instead, each element in the tree is
4626 ;; associated to a key, obtained with `org-element--cache-key'. This
4627 ;; mechanism is robust enough to preserve total order among elements
4628 ;; even when the tree is only partially synchronized.
4629 ;;
4630 ;; Objects contained in an element are stored in a hash table,
4631 ;; `org-element--cache-objects'.
4635 "Non nil when Org parser should cache its results.
4642 "Maximum duration, as a time value, for a cache synchronization.
4643 If the synchronization is not over after this delay, the process
4644 pauses and resumes after `org-element-cache-sync-break'
4648 "Duration, as a time value, of the pause between synchronizations.
4652 ;;;; Data Structure
4655 "AVL tree used to cache elements.
4656 Each node of the tree contains an element. Comparison is done
4657 with `org-element--cache-compare'. This cache is used in
4661 "Hash table used as to cache objects.
4662 Key is an element, as returned by `org-element-at-point', and
4663 value is an alist where each association is:
4665 \(PARENT COMPLETEP . OBJECTS)
4667 where PARENT is an element or object, COMPLETEP is a boolean,
4668 non-nil when all direct children of parent are already cached and
4669 OBJECTS is a list of such children, as objects, from farthest to
4670 closest.
4673 contained within a paragraph
4677 If the paragraph is completely parsed, OBJECTS-DATA will be
4679 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4680 \(BOLD-OBJECT t ENTITY-OBJECT))
4682 whereas in a partially parsed paragraph, it could be
4684 \((PARAGRAPH nil ENTITY-OBJECT))
4689 "List of pending synchronization requests.
4691 A request is a vector with the following pattern:
4693 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4695 Processing a synchronization request consists of three phases:
4697 0. Delete modified elements,
4698 1. Fill missing area in cache,
4699 2. Shift positions and re-parent elements after the changes.
4701 During phase 0, NEXT is the key of the first element to be
4702 removed, BEG and END is buffer position delimiting the
4703 modifications. Elements starting between them (inclusive) are
4704 removed and so are those contained within OUTREACH. PARENT, when
4705 non-nil, is the parent of the first element to be removed.
4707 During phase 1, NEXT is the key of the next known element in
4708 cache and BEG its beginning position. Parse buffer between that
4709 element and the one before it in order to determine the parent of
4710 the next element. Set PARENT to the element containing NEXT.
4712 During phase 2, NEXT is the key of the next element to shift in
4713 the parse tree. All elements starting from this one have their
4714 properties relatives to buffer positions shifted by integer
4715 OFFSET and, if they belong to element PARENT, are adopted by it.
4723 "Hash table used to store keys during synchronization.
4727 "Return a unique key for ELEMENT in cache tree.
4729 Keys are used to keep a total order among elements in the cache.
4730 Comparison is done with `org-element--cache-key-less-p'.
4732 When no synchronization is taking place, a key is simply the
4733 beginning position of the element, or that position plus one in
4734 the case of an first item (respectively row) in
4735 a list (respectively a table).
4737 During a synchronization, the key is the one the element had when
4738 the cache was synchronized for the last time. Elements added to
4739 cache during the synchronization get a new key generated with
4740 `org-element--cache-generate-key'.
4742 Such keys are stored in `org-element--cache-sync-keys'. The hash
4743 table is cleared once the synchronization is complete."
4746 ;; Increase beginning position of items (respectively
4747 ;; table rows) by one, so the first item can get
4748 ;; a different key from its parent list (respectively
4749 ;; table).
4752 begin)))
4755 key))))
4758 "Generate a key between LOWER and UPPER.
4760 LOWER and UPPER are integers or lists, possibly empty.
4762 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4763 a unique key, as an integer or a list of integers, according to
4764 the following rules:
4766 - LOWER and UPPER are compared level-wise until values differ.
4768 - If, at a given level, LOWER and UPPER differ from more than
4769 2, the new key shares all the levels above with LOWER and
4770 gets a new level. Its value is the mean between LOWER and
4771 UPPER:
4773 \(1 2) + (1 4) --> (1 3)
4775 - If LOWER has no value to compare with, it is assumed that its
4776 value is `most-negative-fixnum'. E.g.,
4778 \(1 1) + (1 1 2)
4780 is equivalent to
4782 \(1 1 m) + (1 1 2)
4784 where m is `most-negative-fixnum'. Likewise, if UPPER is
4785 short of levels, the current value is `most-positive-fixnum'.
4787 - If they differ from only one, the new key inherits from
4788 current LOWER level and fork it at the next level. E.g.,
4790 \(2 1) + (3 3)
4792 is equivalent to
4794 \(2 1) + (2 M)
4796 where M is `most-positive-fixnum'.
4798 - If the key is only one level long, it is returned as an
4799 integer:
4801 \(1 2) + (3 2) --> 2
4803 When they are not equals, the function assumes that LOWER is
4804 lesser than UPPER, per `org-element--cache-key-less-p'."
4808 skip-upper key)
4819 ;; When at a given level, LOWER and UPPER differ from
4820 ;; 1, ignore UPPER altogether. Instead create a key
4821 ;; between LOWER and the greatest key with the same
4822 ;; prefix as LOWER so far.
4828 "Non-nil if key A is less than key B.
4829 A and B are either integers or lists of integers, as returned by
4830 `org-element--cache-key'."
4838 ;; If A is empty, either keys are equal (B is also empty) and
4839 ;; we return nil, or A is lesser than B (B is longer) and we
4840 ;; return a non-nil value.
4841 ;;
4842 ;; If A is not empty, B is necessarily empty and A is greater
4843 ;; than B (A is longer). Therefore, return nil.
4847 "Non-nil when element A is located before element B."
4852 "Return root value in cache.
4853 This function assumes `org-element--cache' is a valid AVL tree."
4857 ;;;; Tools
4860 "Non-nil when cache is active in current buffer."
4865 "Find element in cache starting at POS or before.
4867 POS refers to a buffer position.
4869 When optional argument SIDE is non-nil, the function checks for
4870 elements starting at or past POS instead. If SIDE is `both', the
4871 function returns a cons cell where car is the first element
4872 starting at or before POS and cdr the first element starting
4873 after POS.
4875 The function can only find elements in the synchronized part of
4876 the cache."
4880 lower upper)
4895 ;; We found an element in cache starting at POS. If `side'
4896 ;; is `both' we also want the next one in order to generate
4897 ;; a key in-between.
4898 ;;
4899 ;; If the element is the first row or item in a table or
4900 ;; a plain list, we always return the table or the plain
4901 ;; list.
4902 ;;
4903 ;; In any other case, we return the element found.
4912 lower parent
4913 upper parent)))))
4916 lower element
4917 upper element)))))
4924 "Store ELEMENT in current buffer's cache, if allowed.
4925 When optional argument DATA is non-nil, assume is it object data
4926 relative to ELEMENT and store it in the objects cache."
4930 ;; During synchronization, first build an appropriate key
4931 ;; for the new element so `avl-tree-enter' can insert it at
4932 ;; the right spot in the cache.
4941 org-element--cache-sync-keys)))
4943 ;; Headlines are not stored in cache, so objects in titles are
4944 ;; not stored either.
4949 "Remove ELEMENT from cache.
4950 Assume ELEMENT belongs to cache and that a cache is active."
4955 ;;;; Synchronization
4958 "Set idle timer for cache synchronization in BUFFER."
4965 org-element-cache-sync-idle-time))
4966 nil
4967 #'org-element--cache-sync
4968 buffer)))
4971 "Non-nil when synchronization process should be interrupted.
4972 TIME-LIMIT is a time value or nil."
4978 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4980 Properties containing buffer positions are `:begin', `:end',
4981 `:contents-begin', `:contents-end' and `:structure'. When
4982 optional argument PROPS is a list of keywords, only shift
4983 properties provided in that list.
4985 Properties are modified by side-effect."
4987 ;; Shift `:structure' property for the first plain list only: it
4988 ;; is the only one that really matters and it prevents from
4989 ;; shifting it more than once.
5003 "Synchronize cache with recent modification in BUFFER.
5005 When optional argument THRESHOLD is non-nil, do the
5006 synchronization for all elements starting before or at threshold,
5007 then exit. Otherwise, synchronize cache for as long as
5008 `org-element-cache-sync-duration' or until Emacs leaves idle
5009 state.
5011 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5012 not registered yet in the cache are going to happen. It is used
5013 in `org-element--cache-submit-request', where cache is partially
5014 updated before current modification are actually submitted."
5025 request
5027 threshold
5030 org-element-cache-sync-duration))
5031 future-change)
5032 ;; Request processed. Merge current and next offsets and
5033 ;; transfer ending position.
5039 ;; If more requests are awaiting, set idle timer accordingly.
5040 ;; Otherwise, reset keys.
5047 "Process synchronization REQUEST for all entries before NEXT.
5049 REQUEST is a vector, built by `org-element--cache-submit-request'.
5051 NEXT is a cache key, as returned by `org-element--cache-key'.
5053 When non-nil, THRESHOLD is a buffer position. Synchronization
5054 stops as soon as a shifted element begins after it.
5056 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5057 after this time or when Emacs exits idle state.
5059 When non-nil, FUTURE-CHANGE is a buffer position where changes
5060 not registered yet in the cache are going to happen. See
5061 `org-element--cache-submit-request' for more information.
5063 Throw `interrupt' if the process stops before completing the
5064 request."
5067 ;; Phase 0.
5068 ;;
5069 ;; Delete all elements starting after BEG, but not after buffer
5070 ;; position END or past element with key NEXT.
5071 ;;
5072 ;; At each iteration, we start again at tree root since
5073 ;; a deletion modifies structure of the balanced tree.
5081 ;; Find first element in cache with key BEG or after it.
5091 data-key key
5094 data-key key
5095 node nil)))))
5104 up))
5110 ;; No element starting after modifications left in
5111 ;; cache: further processing is futile.
5114 ;; Phase 1.
5115 ;;
5116 ;; Phase 0 left a hole in the cache. Some elements after it
5117 ;; could have parents within. For example, in the following
5118 ;; buffer:
5119 ;;
5120 ;; - item
5121 ;;
5122 ;;
5123 ;; Paragraph1
5124 ;;
5125 ;; Paragraph2
5126 ;;
5127 ;; if we remove a blank line between "item" and "Paragraph1",
5128 ;; everything down to "Paragraph2" is removed from cache. But
5129 ;; the paragraph now belongs to the list, and its `:parent'
5130 ;; property no longer is accurate.
5131 ;;
5132 ;; Therefore we need to parse again elements in the hole, or at
5133 ;; least in its last section, so that we can re-parent
5134 ;; subsequent elements, during phase 2.
5135 ;;
5136 ;; Note that we only need to get the parent from the first
5137 ;; element in cache after the hole.
5138 ;;
5139 ;; When next key is lesser or equal to the current one, delegate
5140 ;; phase 1 processing to next request in order to preserve key
5141 ;; order among requests.
5149 ;; Next element will start at its beginning position plus
5150 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5151 ;; contains the real beginning position of the first element to
5152 ;; shift and re-parent.
5156 ;; Changes are going to happen around this element and
5157 ;; they will trigger another phase 1 request. Skip the
5158 ;; current one.
5164 ;; Phase 2.
5165 ;;
5166 ;; Shift all elements starting from key START, but before NEXT, by
5167 ;; OFFSET, and re-parent them when appropriate.
5168 ;;
5169 ;; Elements are modified by side-effect so the tree structure
5170 ;; remains intact.
5171 ;;
5172 ;; Once THRESHOLD, if any, is reached, or once there is an input
5173 ;; pending, exit. Before leaving, the current synchronization
5174 ;; request is updated.
5181 exit-flag)
5182 ;; No re-parenting nor shifting planned: request is over.
5192 ;; We reached NEXT. Request is complete.
5194 ;; Handle interruption request. Update current request.
5199 ;; Shift element.
5202 ;; Shift associated objects data, if any.
5207 ;; Update PARENT and re-parent DATA, only when
5208 ;; necessary. Propagate new structures for lists.
5222 ;; Cache is up-to-date past THRESHOLD. Request
5223 ;; interruption.
5228 ;; We reached end of tree: synchronization complete.
5229 t)))
5232 "Parse elements in current section, down to POS.
5234 Start parsing from the closest between the last known element in
5235 cache or headline above. Return the smallest element containing
5236 POS.
5238 When optional argument SYNCP is non-nil, return the parent of the
5239 element containing POS instead. In that case, it is also
5240 possible to provide TIME-LIMIT, which is a time value specifying
5241 when the parsing should stop. The function throws `interrupt' if
5242 the process stopped before finding the expected result."
5249 element next mode)
5251 ;; Nothing in cache before point: start parsing from first
5252 ;; element following headline above, or first element in
5253 ;; buffer.
5260 ;; Cache returned exact match: return it.
5263 ;; There's a headline between cached value and POS: cached
5264 ;; value is invalid. Start parsing from first element
5265 ;; following the headline.
5272 ;; Check if CACHED or any of its ancestors contain point.
5273 ;;
5274 ;; If there is such an element, we inspect it in order to know
5275 ;; if we return it or if we need to parse its contents.
5276 ;; Otherwise, we just start parsing from current location,
5277 ;; which is right after the top-most element containing
5278 ;; CACHED.
5279 ;;
5280 ;; As a special case, if POS is at the end of the buffer, we
5281 ;; want to return the innermost element ending there.
5282 ;;
5283 ;; Also, if we find an ancestor and discover that we need to
5284 ;; parse its contents, make sure we don't start from
5285 ;; `:contents-begin', as we would otherwise go past CACHED
5286 ;; again. Instead, in that situation, we will resume parsing
5287 ;; from NEXT, which is located after CACHED or its higher
5288 ;; ancestor not containing point.
5300 ;; Parse successively each element until we reach POS.
5313 end 'element mode
5320 ;; Skip any element ending before point. Also skip
5321 ;; element ending at point (unless it is also the end of
5322 ;; buffer) since we're sure that another element begins
5323 ;; after it.
5327 ;; A non-greater element contains point: return it.
5330 ;; Otherwise, we have to decide if ELEMENT really
5331 ;; contains POS. In that case we start parsing from
5332 ;; contents' beginning.
5333 ;;
5334 ;; If POS is at contents' beginning but it is also at
5335 ;; the beginning of the first item in a list or a table.
5336 ;; In that case, we need to create an anchor for that
5337 ;; list or table, so return it.
5338 ;;
5339 ;; Also, if POS is at the end of the buffer, no element
5340 ;; can start after it, but more than one may end there.
5341 ;; Arbitrarily, we choose to return the innermost of
5342 ;; such elements.
5355 parent element
5356 end cend))))
5357 ;; Otherwise, return ELEMENT as it is the smallest
5358 ;; element containing POS.
5363 ;;;; Staging Buffer Changes
5369 ;; Blocks
5371 ;; LaTeX environments.
5373 ;; Drawers.
5376 "Regexp matching a sensitive line, structure wise.
5377 A sensitive line is a headline, inlinetask, block, drawer, or
5378 latex-environment boundary. When such a line is modified,
5379 structure changes in the document may propagate in the whole
5383 "Non-nil when a sensitive line is about to be changed.
5387 "Request extension of area going to be modified if needed.
5388 BEG and END are the beginning and end of the range of changed
5389 text. See `before-change-functions' for more information."
5399 'headline
5402 org-element--cache-sensitive-re bottom t)))))))))
5405 "Update buffer modifications for current buffer.
5406 BEG and END are the beginning and end of the range of changed
5407 text, and the length in bytes of the pre-change text replaced by
5408 that range. See `after-change-functions' for more information."
5416 ;; Determine if modified area needs to be extended, according
5417 ;; to both previous and current state. We make a special
5418 ;; case for headline editing: if a headline is modified but
5419 ;; not removed, do not extend.
5428 org-element--cache-sensitive-re bottom t))))
5429 ;; Effectively extend modified area.
5437 ;; Store synchronization request.
5440 ;; Activate a timer to process the request during idle time.
5444 "Return first element to remove from cache.
5446 BEG and END are buffer positions delimiting buffer modifications.
5447 OFFSET is the size of the changes.
5449 Returned element is usually the first element in cache containing
5450 any position between BEG and END. As an exception, greater
5451 elements around the changes that are robust to contents
5452 modifications are preserved and updated according to the
5453 changes."
5463 quote-block special-block))
5468 ;; UP is a robust greater element containing changes.
5469 ;; We only need to extend its ending boundaries.
5475 ;; We're at top level element containing ELEMENT: if it's
5476 ;; altered by buffer modifications, it is first element in
5477 ;; cache to be removed. Otherwise, that first element is the
5478 ;; following one.
5479 ;;
5480 ;; As a special case, do not remove BEFORE if it is a robust
5481 ;; container for current changes.
5483 before)))))
5486 "Submit a new cache synchronization request for current buffer.
5487 BEG and END are buffer positions delimiting the minimal area
5488 where cache data should be removed. OFFSET is the size of the
5489 change, as an integer."
5491 delete-to delete-from)
5496 ;; Current changes can be merged with first sync request: we
5497 ;; can save a partial cache synchronization.
5500 ;; If last change happened within area to be removed, extend
5501 ;; boundaries of robust parents, if any. Otherwise, find
5502 ;; first element to remove and update request accordingly.
5514 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5515 ;; if any, is no longer a 0-phase request, thus ensuring that
5516 ;; phases are properly ordered. We need to provide OFFSET as
5517 ;; optional parameter since current modifications are not known
5518 ;; yet to the otherwise correct part of the cache (i.e, before
5519 ;; the first request).
5526 ;; When changes happen before the first known
5527 ;; element, re-parent and shift the rest of the
5528 ;; cache.
5530 ;; Otherwise, we find the first non robust
5531 ;; element containing END. All elements between
5532 ;; FIRST and this one are to be removed.
5533 ;;
5534 ;; Among them, some could be located outside the
5535 ;; synchronized part of the cache, in which case
5536 ;; comparing buffer positions to find them is
5537 ;; useless. Instead, we store the element
5538 ;; containing them in the request itself. All
5539 ;; its children will be removed.
5551 element up))
5554 org-element--cache-sync-requests)
5555 ;; No element to remove. No need to re-parent either.
5556 ;; Simply shift additional elements, if any, by OFFSET.
5561 ;;;; Public Functions
5563 ;;;###autoload
5565 "Reset cache in current buffer.
5566 When optional argument ALL is non-nil, reset cache in all Org
5567 buffers."
5585 ;;;###autoload
5587 "Refresh cache at position POS."
5594 \f
5595 ;;; The Toolbox
5596 ;;
5597 ;; The first move is to implement a way to obtain the smallest element
5598 ;; containing point. This is the job of `org-element-at-point'. It
5599 ;; basically jumps back to the beginning of section containing point
5600 ;; and proceed, one element after the other, with
5601 ;; `org-element--current-element' until the container is found. Note:
5602 ;; When using `org-element-at-point', secondary values are never
5603 ;; parsed since the function focuses on elements, not on objects.
5604 ;;
5605 ;; At a deeper level, `org-element-context' lists all elements and
5606 ;; objects containing point.
5607 ;;
5608 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5609 ;; internally by navigation and manipulation tools.
5612 ;;;###autoload
5614 "Determine closest element around point.
5616 Return value is a list like (TYPE PROPS) where TYPE is the type
5617 of the element and PROPS a plist of properties associated to the
5618 element.
5620 Possible types are defined in `org-element-all-elements'.
5621 Properties depend on element or object type, but always include
5622 `:begin', `:end', `:parent' and `:post-blank' properties.
5624 As a special case, if point is at the very beginning of the first
5625 item in a list or sub-list, returned element will be that list
5626 instead of the item. Likewise, if point is at the beginning of
5627 the first row of a table, returned element will be the table
5628 instead of the first row.
5630 When point is at the end of the buffer, return the innermost
5631 element ending there."
5637 ;; Within blank lines at the beginning of buffer, return nil.
5639 ;; Within blank lines right after a headline, return that
5640 ;; headline.
5644 ;; Otherwise parse until we find element containing ORIGIN.
5651 ;;;###autoload
5653 "Return smallest element or object around point.
5655 Return value is a list like (TYPE PROPS) where TYPE is the type
5656 of the element or object and PROPS a plist of properties
5657 associated to it.
5659 Possible types are defined in `org-element-all-elements' and
5660 `org-element-all-objects'. Properties depend on element or
5661 object type, but always include `:begin', `:end', `:parent' and
5662 `:post-blank'.
5664 As a special case, if point is right after an object and not at
5665 the beginning of any other object, return that object.
5667 Optional argument ELEMENT, when non-nil, is the closest element
5668 containing point, as returned by `org-element-at-point'.
5669 Providing it allows for quicker computation."
5675 ;; If point is inside an element containing objects or
5676 ;; a secondary string, narrow buffer to the container and
5677 ;; proceed with parsing. Otherwise, return ELEMENT.
5679 ;; At a parsed affiliated keyword, check if we're inside main
5680 ;; or dual value.
5687 org-element-parsed-keywords))
5696 ;; Also change type to retrieve correct restrictions.
5698 ;; At an item, objects can only be located within tag, if any.
5708 ;; At an headline or inlinetask, objects are in title.
5715 ;; At a paragraph, a table-row or a verse block, objects are
5716 ;; located within their contents.
5720 ;; CBEG is nil for table rules.
5725 ;; At a parsed keyword, objects are located within value.
5728 org-element-document-properties))
5735 ;; At a planning line, if point is at a timestamp, return it,
5736 ;; otherwise, return element.
5744 ;; All other locations cannot contain objects: bail out.
5754 next object-data last)
5758 ;; When entering PARENT for the first time, get list
5759 ;; of objects within known so far. Store it in
5760 ;; OBJECT-DATA.
5765 ;; Find NEXT object for analysis.
5767 ;; If NEXT is non-nil, we already exhausted the
5768 ;; cache so we can parse buffer to find the object
5769 ;; after it.
5771 ;; Otherwise, check if cache can help us.
5782 ;; Cache contains the information needed.
5785 pos)
5787 pos)
5793 ;; If we have a new object to analyze, store it in
5794 ;; cache. Otherwise record that there is nothing
5795 ;; more to parse in this element at this depth.
5800 ;; Process NEXT, if any, in order to know if we need
5801 ;; to skip it, return it or move into it.
5808 ;; Skip objects ending before point. Also skip
5809 ;; objects ending at point unless it is also the
5810 ;; end of buffer, since we want to return the
5811 ;; innermost object.
5814 ;; For convenience, when object ends at POS,
5815 ;; without any space, store it in LAST, as we
5816 ;; will return it if no object starts here.
5820 ;; If POS is within a container object, move
5821 ;; into that object.
5825 ;; At contents' end, if there is no
5826 ;; space before point, also move into
5827 ;; object, for consistency with
5828 ;; convenience feature above.
5837 next nil
5838 object-data nil))
5839 ;; Otherwise, return NEXT.
5841 ;; Store results in cache, if applicable.
5845 "List all ancestors of a given element or object.
5847 BLOB is an object or element.
5849 When optional argument TYPES is a list of symbols, return the
5850 first element or object in the lineage whose type belongs to that
5851 list.
5853 When optional argument WITH-SELF is non-nil, lineage includes
5854 BLOB itself as the first element, and TYPES, if provided, also
5855 apply to it.
5857 When BLOB is obtained through `org-element-context' or
5858 `org-element-at-point', only ancestors from its section can be
5859 found. There is no such limitation when BLOB belongs to a full
5860 parse tree."
5862 ancestors)
5869 "Non-nil when elements ELEM-A and ELEM-B are nested."
5878 "Swap elements ELEM-A and ELEM-B.
5879 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5880 end of ELEM-A."
5882 ;; There are two special cases when an element doesn't start at bol:
5883 ;; the first paragraph in an item or in a footnote definition.
5885 ;; Only a paragraph without any affiliated keyword can be moved at
5886 ;; ELEM-A position in such a situation. Note that the case of
5887 ;; a footnote definition is impossible: it cannot contain two
5888 ;; paragraphs in a row because it cannot contain a blank line.
5894 ;; In a special situation, ELEM-A will have no indentation. We'll
5895 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5909 ;; Store inner overlays responsible for visibility status.
5910 ;; We also need to store their boundaries as they will be
5911 ;; removed from buffer.
5926 ;; Get contents.
5934 ;; Restore ex ELEM-A overlays.
5941 ;; Restore ex ELEM-B overlays.
5947 "Remove maximum common indentation in string S and return it.
5948 When optional argument N is a positive integer, remove exactly
5949 that much characters from indentation, if possible, or return
5950 S as-is otherwise. Unlike to `org-remove-indentation', this
5951 function doesn't call `untabify' on S."
5956 ;; Find maximum common indentation, if not specified.
5964 min-ind)))
5966 ;; Remove exactly N indentation, but give up if not possible.
5979 ;; Local variables:
5980 ;; generated-autoload-file: "org-loaddefs.el"
5981 ;; End:
5983 ;;; org-element.el ends here