| blob | 29f714e57b3ce954e9bc711c44069273df022bde |
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).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
203 ;; Objects starting with "@": export snippets.
204 "@@"
205 ;; Objects starting with "{": macro.
206 "{{{"
207 ;; Objects starting with "<" : timestamp
208 ;; (active, diary), target, radio target and
209 ;; angular links.
211 ;; Objects starting with "$": latex fragment.
213 ;; Objects starting with "\": line break,
214 ;; entity, latex fragment.
216 ;; Objects starting with raw text: inline Babel
217 ;; source block, inline Babel call.
223 ;;;###autoload
225 "Update parser internals."
232 dynamic-block example-block export-block fixed-width
233 footnote-definition headline horizontal-rule inlinetask item
234 keyword latex-environment node-property paragraph plain-list
235 planning property-drawer quote-block section
236 special-block src-block table table-row verse-block)
241 item plain-list property-drawer quote-block section
242 special-block table)
247 inline-src-block italic line-break latex-fragment link macro
248 radio-target statistics-cookie strike-through subscript superscript
249 table-cell target timestamp underline verbatim)
254 superscript table-cell underline)
268 "Alist between block names and the associated parsing function.
269 Names must be uppercase. Any block whose name has no association
275 "List of affiliated keywords as strings.
283 "Alist of usual translations for keywords.
284 The key is the old name and the value the new one. The property
288 "List of affiliated keywords that can occur more than once in an element.
290 Their value will be consed into a list of strings, which will be
291 returned as the value of the property.
293 This list is checked after translations have been applied. See
294 `org-element-keyword-translation-alist'.
300 "List of affiliated keywords whose value can be parsed.
302 Their value will be stored as a secondary string: a list of
303 strings and objects.
305 This list is checked after translations have been applied. See
310 org-element-parsed-keywords)
311 "Alist of parsed keywords and associated properties.
312 This is generated from `org-element-parsed-keywords', which
316 "List of affiliated keywords which can have a secondary value.
318 In Org syntax, they can be written with optional square brackets
319 before the colons. For example, RESULTS keyword can be
320 associated to a hash value with the following:
322 #+RESULTS[hash-string]: some-source
324 This list is checked after translations have been applied. See
330 ;; Dual affiliated keywords.
334 ;; Regular affiliated keywords.
339 org-element-affiliated-keywords)))
341 ;; Export attributes.
343 "Regexp matching any affiliated keyword.
345 Keyword name is put in match group 1. Moreover, if keyword
346 belongs to `org-element-dual-keywords', put the dual value in
347 match group 2.
361 ;; Ignore all links excepted plain links in a link description.
362 ;; Also ignore radio-targets and line breaks.
364 italic latex-fragment macro plain-link statistics-cookie
365 strike-through subscript superscript underline verbatim)
367 ;; Remove any variable object from radio target as it would
368 ;; prevent it from being properly recognized.
370 subscript superscript underline superscript)
374 ;; Ignore inline babel call and inline src block as formulas are
375 ;; possible. Also ignore line breaks and statistics cookies.
377 latex-fragment link macro radio-target strike-through
378 subscript superscript target timestamp underline verbatim)
382 "Alist of objects restrictions.
384 key is an element or object type containing objects and value is
385 a list of types that can be contained within an element or object
386 of such type.
388 For example, in a `radio-target' object, one can only find
389 entities, latex-fragments, subscript, superscript and text
390 markup.
392 This alist also applies to secondary string. For example, an
393 `headline' type element doesn't directly contain objects, but
408 "Table used internally to pair only square brackets.
412 \f
413 ;;; Accessors and Setters
414 ;;
415 ;; Provide four accessors: `org-element-type', `org-element-property'
416 ;; `org-element-contents' and `org-element-restriction'.
417 ;;
418 ;; Setter functions allow to modify elements by side effect. There is
419 ;; `org-element-put-property', `org-element-set-contents'. These
420 ;; low-level functions are useful to build a parse tree.
421 ;;
422 ;; `org-element-adopt-element', `org-element-set-element',
423 ;; `org-element-extract-element' and `org-element-insert-before' are
424 ;; high-level functions useful to modify a parse tree.
425 ;;
426 ;; `org-element-secondary-p' is a predicate used to know if a given
427 ;; object belongs to a secondary string. `org-element-copy' returns
428 ;; an element or object, stripping its parent property in the process.
431 "Return type of ELEMENT.
433 The function returns the type of the element or object provided.
434 It can also return the following special value:
435 `plain-text' for a string
436 `org-data' for a complete document
437 nil in any other case."
443 "Extract the value from the PROPERTY of an ELEMENT."
448 "Extract contents from an ELEMENT."
454 "Return restriction associated to ELEMENT.
455 ELEMENT can be an element, an object or a symbol representing an
456 element or object type."
458 org-element-object-restrictions)))
461 "In ELEMENT set PROPERTY to VALUE.
462 Return modified element."
465 element))
468 "Set ELEMENT contents to CONTENTS."
475 "Non-nil when OBJECT directly belongs to a secondary string.
476 Return value is the property name, as a keyword, or nil."
479 org-element-secondary-value-alist))))
486 "Append elements to the contents of another element.
488 PARENT is an element or object. CHILDREN can be elements,
489 objects, or a strings.
491 The function takes care of setting `:parent' property for CHILD.
492 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 ;; Add CHILDREN at the end of PARENT contents.
501 parent
503 ;; Return modified PARENT element.
507 "Extract ELEMENT from parse tree.
508 Remove element from the parse tree by side-effect, and return it
509 with its `:parent' property stripped out."
514 parent secondary
517 parent
519 ;; Return ELEMENT with its :parent removed.
523 "Insert ELEMENT before LOCATION in parse tree.
524 LOCATION is an element, object or string within the parse tree.
525 Parse tree is modified by side effect."
530 ;; Special case: LOCATION is the first element of an
531 ;; independent secondary string (e.g. :title property). Add
532 ;; ELEMENT in-place.
536 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires to tweak `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret CENTER-BLOCK element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
800 "Parse a footnote definition.
802 LIMIT bounds the search. AFFILIATED is a list of which CAR is
803 the buffer position at the beginning of the first affiliated
804 keyword and CDR is a plist of affiliated keywords along with
805 their value.
807 Return a list whose CAR is `footnote-definition' and CDR is
808 a plist containing `:label', `:begin' `:end', `:contents-begin',
809 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
811 Assume point is at the beginning of the footnote definition."
839 :begin begin
840 :end end
841 :contents-begin contents-begin
842 :contents-end contents-end
848 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
849 CONTENTS is the contents of the footnote-definition."
851 " "
852 contents))
855 ;;;; Headline
858 "Return node properties associated to headline at point.
859 Upcase property names. It avoids confusion between properties
860 obtained through property drawer and default properties from the
861 parser (e.g. `:end' and :END:). Return value is a plist."
873 properties))))
876 "Return time properties associated to headline at point.
877 Return value is a plist."
891 plist))))
894 "Parse a headline.
896 Return a list whose CAR is `headline' and CDR is a plist
897 containing `:raw-value', `:title', `:begin', `:end',
898 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
899 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
900 `:deadline', `:closed', `:archivedp', `:commentedp'
901 `:footnote-section-p', `:post-blank' and `:post-affiliated'
902 keywords.
904 The plist also contains any property set in the property drawer,
905 with its name in upper cases and colons added at the
906 beginning (e.g., `:CUSTOM_ID').
908 LIMIT is a buffer position bounding the search.
910 When RAW-SECONDARY-P is non-nil, headline's title will not be
911 parsed as a secondary string, but as a plain string instead.
913 Assume point is at beginning of the headline."
960 :begin begin
961 :end end
962 :pre-blank
965 :contents-begin contents-begin
966 :contents-end contents-end
967 :level level
968 :priority priority
969 :tags tags
970 :todo-keyword todo
971 :todo-type todo-type
974 end)
975 :footnote-section-p footnote-section-p
976 :archivedp archivedp
977 :commentedp commentedp
979 time-props
980 standard-props))))
982 headline :title
991 nil
997 "Interpret HEADLINE element as Org syntax.
998 CONTENTS is the contents of the element."
1011 ?*)
1015 " "
1018 org-footnote-section
1019 title))))
1021 heading
1022 ;; Align tags.
1030 ?\s)
1031 tags))
1035 tags))))
1037 contents)))
1040 ;;;; Inlinetask
1043 "Parse an inline task.
1045 Return a list whose CAR is `inlinetask' and CDR is a plist
1046 containing `:title', `:begin', `:end', `:contents-begin' and
1047 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1048 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1049 `:closed', `:post-blank' and `:post-affiliated' keywords.
1051 The plist also contains any property set in the property drawer,
1052 with its name in upper cases and colons added at the
1053 beginning (e.g., `:CUSTOM_ID').
1055 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1056 title will not be parsed as a secondary string, but as a plain
1057 string instead.
1059 Assume point is at beginning of the inline task."
1104 :begin begin
1105 :end end
1106 :contents-begin contents-begin
1107 :contents-end contents-end
1108 :level level
1109 :priority priority
1110 :tags tags
1111 :todo-keyword todo
1112 :todo-type todo-type
1115 time-props
1116 standard-props))))
1118 inlinetask :title
1127 nil
1133 "Interpret INLINETASK element as Org syntax.
1134 CONTENTS is the contents of inlinetask."
1148 ;; Align tags.
1156 ? )
1157 tags))
1161 tags))))
1162 ;; Prefer degenerate inlinetasks when there are no
1163 ;; contents.
1166 contents
1170 ;;;; Item
1173 "Parse an item.
1175 STRUCT is the structure of the plain list.
1177 Return a list whose CAR is `item' and CDR is a plist containing
1178 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1179 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1180 `:post-affiliated' keywords.
1182 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1183 any, will not be parsed as a secondary string, but as a plain
1184 string instead.
1186 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.
1217 ;; If first line isn't empty, contents really
1218 ;; start at the text after item's meta-data.
1228 :begin begin
1229 :end end
1230 :contents-begin contents-begin
1231 :contents-end contents-end
1232 :checkbox checkbox
1233 :counter counter
1234 :structure struct
1238 item :tag
1249 "Interpret ITEM element as Org syntax.
1250 CONTENTS is the contents of the element."
1260 ;; Compute indentation.
1265 ;; Indent contents.
1267 bullet
1281 ;;;; Plain List
1284 ;; Return structure of list at point. Internal function. See
1285 ;; `org-list-struct' for details.
1290 items struct)
1295 ;; At limit: end all items.
1304 ;; At list end: end all items.
1309 ;; At a new item: end previous sibling.
1321 ind
1322 bullet
1325 ;; Description tag.
1329 ;; Ending position, unknown so far.
1330 nil)))
1331 items))
1333 ;; Skip empty lines.
1335 ;; Skip inline tasks and blank lines along the way.
1342 ;; At some text line. Check if it ends any previous item.
1355 ;; Skip blocks (any type) and drawers contents.
1360 limit t)))
1366 "Parse a plain list.
1368 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1369 the buffer position at the beginning of the first affiliated
1370 keyword and CDR is a plist of affiliated keywords along with
1371 their value. STRUCTURE is the structure of the plain list being
1372 parsed.
1374 Return a list whose CAR is `plain-list' and CDR is a plist
1375 containing `:type', `:begin', `:end', `:contents-begin' and
1376 `:contents-end', `:structure', `:post-blank' and
1377 `:post-affiliated' keywords.
1379 Assume point is at the beginning of the list."
1393 pos))
1397 ;; Return value.
1401 :begin begin
1402 :end end
1403 :contents-begin contents-begin
1404 :contents-end contents-end
1405 :structure struct
1411 "Interpret PLAIN-LIST element as Org syntax.
1412 CONTENTS is the contents of the element."
1420 ;;;; Property Drawer
1423 "Parse a property drawer.
1425 LIMIT bounds the search.
1427 Return a list whose car is `property-drawer' and cdr is a plist
1428 containing `:begin', `:end', `:contents-begin', `:contents-end',
1429 `:post-blank' and `:post-affiliated' keywords.
1431 Assume point is at the beginning of the property drawer."
1444 :end end
1446 :contents-end contents-end
1451 "Interpret PROPERTY-DRAWER element as Org syntax.
1452 CONTENTS is the properties within the drawer."
1456 ;;;; Quote Block
1459 "Parse a quote block.
1461 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1462 the buffer position at the beginning of the first affiliated
1463 keyword and CDR is a plist of affiliated keywords along with
1464 their value.
1466 Return a list whose CAR is `quote-block' and CDR is a plist
1467 containing `:begin', `:end', `:contents-begin', `:contents-end',
1468 `:post-blank' and `:post-affiliated' keywords.
1470 Assume point is at the beginning of the block."
1474 ;; Incomplete block: parse it as a paragraph.
1480 ;; Empty blocks have no contents.
1493 :end end
1494 :contents-begin contents-begin
1495 :contents-end contents-end
1501 "Interpret QUOTE-BLOCK element as Org syntax.
1502 CONTENTS is the contents of the element."
1506 ;;;; Section
1509 "Parse a section.
1511 LIMIT bounds the search.
1513 Return a list whose CAR is `section' and CDR is a plist
1514 containing `:begin', `:end', `:contents-begin', `contents-end',
1515 `:post-blank' and `:post-affiliated' keywords."
1517 ;; Beginning of section is the beginning of the first non-blank
1518 ;; line after previous headline.
1527 :end end
1528 :contents-begin begin
1529 :contents-end pos-before-blank
1534 "Interpret SECTION element as Org syntax.
1535 CONTENTS is the contents of the element."
1536 contents)
1539 ;;;; Special Block
1542 "Parse a special block.
1544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1545 the buffer position at the beginning of the first affiliated
1546 keyword and CDR is a plist of affiliated keywords along with
1547 their value.
1549 Return a list whose CAR is `special-block' and CDR is a plist
1550 containing `:type', `:begin', `:end', `:contents-begin',
1551 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1553 Assume point is at the beginning of the block."
1560 limit t)))
1561 ;; Incomplete block: parse it as a paragraph.
1567 ;; Empty blocks have no contents.
1580 :begin begin
1581 :end end
1582 :contents-begin contents-begin
1583 :contents-end contents-end
1589 "Interpret SPECIAL-BLOCK element as Org syntax.
1590 CONTENTS is the contents of the element."
1595 \f
1596 ;;; Elements
1597 ;;
1598 ;; For each element, a parser and an interpreter are also defined.
1599 ;; Both follow the same naming convention used for greater elements.
1600 ;;
1601 ;; Also, as for greater elements, adding a new element type is done
1602 ;; through the following steps: implement a parser and an interpreter,
1603 ;; tweak `org-element--current-element' so that it recognizes the new
1604 ;; type and add that new type to `org-element-all-elements'.
1605 ;;
1606 ;; As a special case, when the newly defined type is a block type,
1607 ;; `org-element-block-name-alist' has to be modified accordingly.
1610 ;;;; Babel Call
1613 "Parse a babel call.
1615 LIMIT bounds the search. AFFILIATED is a list of which car is
1616 the buffer position at the beginning of the first affiliated
1617 keyword and cdr is a plist of affiliated keywords along with
1618 their value.
1620 Return a list whose car is `babel-call' and cdr is a plist
1621 containing `:call', `:inside-header', `:arguments',
1622 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1623 `:post-affiliated' as keywords."
1637 value)))
1647 :begin begin
1648 :end end
1649 :value value
1655 "Interpret BABEL-CALL element as Org syntax.
1656 CONTENTS is nil."
1666 ;;;; Clock
1669 "Parse a clock.
1671 LIMIT bounds the search.
1673 Return a list whose CAR is `clock' and CDR is a plist containing
1674 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1675 `:post-affiliated' as keywords."
1695 :value value
1696 :duration duration
1697 :begin begin
1698 :end end
1699 :post-blank post-blank
1703 "Interpret CLOCK element as Org syntax.
1704 CONTENTS is nil."
1712 "%2s:%02s"
1716 ;;;; Comment
1719 "Parse a comment.
1721 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1722 the buffer position at the beginning of the first affiliated
1723 keyword and CDR is a plist of affiliated keywords along with
1724 their value.
1726 Return a list whose CAR is `comment' and CDR is a plist
1727 containing `:begin', `:end', `:value', `:post-blank',
1728 `:post-affiliated' keywords.
1730 Assume point is at comment beginning."
1739 ;; Get comments ending.
1742 ;; Accumulate lines without leading hash and first
1743 ;; whitespace.
1757 :end end
1758 :value value
1764 "Interpret COMMENT element as Org syntax.
1765 CONTENTS is nil."
1769 ;;;; Comment Block
1772 "Parse an export block.
1774 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1775 the buffer position at the beginning of the first affiliated
1776 keyword and CDR is a plist of affiliated keywords along with
1777 their value.
1779 Return a list whose CAR is `comment-block' and CDR is a plist
1780 containing `:begin', `:end', `:value', `:post-blank' and
1781 `:post-affiliated' keywords.
1783 Assume point is at comment block beginning."
1787 ;; Incomplete block: parse it as a paragraph.
1800 contents-begin contents-end)))
1804 :end end
1805 :value value
1811 "Interpret COMMENT-BLOCK element as Org syntax.
1812 CONTENTS is nil."
1819 ;;;; Diary Sexp
1822 "Parse a diary sexp.
1824 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1825 the buffer position at the beginning of the first affiliated
1826 keyword and CDR is a plist of affiliated keywords along with
1827 their value.
1829 Return a list whose CAR is `diary-sexp' and CDR is a plist
1830 containing `:begin', `:end', `:value', `:post-blank' and
1831 `:post-affiliated' keywords."
1843 :begin begin
1844 :end end
1850 "Interpret DIARY-SEXP as Org syntax.
1851 CONTENTS is nil."
1855 ;;;; Example Block
1858 "Parse an example block.
1860 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1861 the buffer position at the beginning of the first affiliated
1862 keyword and CDR is a plist of affiliated keywords along with
1863 their value.
1865 Return a list whose CAR is `example-block' and CDR is a plist
1866 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1867 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1868 `:value', `:post-blank' and `:post-affiliated' keywords."
1872 ;; Incomplete block: parse it as a paragraph.
1880 ;; Switches analysis
1887 ;; Should labels be retained in (or stripped from) example
1888 ;; blocks?
1893 ;; What should code-references use - labels or
1894 ;; line-numbers?
1903 ;; Standard block parsing.
1911 contents-begin contents-end))
1912 block-ind))
1921 :end end
1922 :value value
1923 :switches switches
1924 :number-lines number-lines
1925 :preserve-indent preserve-indent
1926 :retain-labels retain-labels
1927 :use-labels use-labels
1928 :label-fmt label-fmt
1934 "Interpret EXAMPLE-BLOCK element as Org syntax.
1935 CONTENTS is nil."
1943 value
1948 ;;;; Export Block
1951 "Parse an export block.
1953 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1954 the buffer position at the beginning of the first affiliated
1955 keyword and CDR is a plist of affiliated keywords along with
1956 their value.
1958 Return a list whose CAR is `export-block' and CDR is a plist
1959 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1960 `:post-affiliated' keywords.
1962 Assume point is at export-block beginning."
1969 ;; Incomplete block: parse it as a paragraph.
1982 contents-end)))
1986 :end end
1987 :type type
1988 :value value
1994 "Interpret EXPORT-BLOCK element as Org syntax.
1995 CONTENTS is nil."
2002 ;;;; Fixed-width
2005 "Parse a fixed-width section.
2007 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2008 the buffer position at the beginning of the first affiliated
2009 keyword and CDR is a plist of affiliated keywords along with
2010 their value.
2012 Return a list whose CAR is `fixed-width' and CDR is a plist
2013 containing `:begin', `:end', `:value', `:post-blank' and
2014 `:post-affiliated' keywords.
2016 Assume point is at the beginning of the fixed-width area."
2020 value
2025 ;; Accumulate text without starting colons.
2038 :end end
2039 :value value
2045 "Interpret FIXED-WIDTH element as Org syntax.
2046 CONTENTS is nil."
2054 ;;;; Horizontal Rule
2057 "Parse an horizontal rule.
2059 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2060 the buffer position at the beginning of the first affiliated
2061 keyword and CDR is a plist of affiliated keywords along with
2062 their value.
2064 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2065 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2066 keywords."
2076 :end end
2082 "Interpret HORIZONTAL-RULE element as Org syntax.
2083 CONTENTS is nil."
2087 ;;;; Keyword
2090 "Parse a keyword at point.
2092 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2093 the buffer position at the beginning of the first affiliated
2094 keyword and CDR is a plist of affiliated keywords along with
2095 their value.
2097 Return a list whose CAR is `keyword' and CDR is a plist
2098 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2099 `:post-affiliated' keywords."
2101 ;; An orphaned affiliated keyword is considered as a regular
2102 ;; keyword. In this case AFFILIATED is nil, so we take care of
2103 ;; this corner case.
2116 :value value
2117 :begin begin
2118 :end end
2124 "Interpret KEYWORD element as Org syntax.
2125 CONTENTS is nil."
2131 ;;;; Latex Environment
2135 "Regexp matching the beginning of a LaTeX environment.
2136 The environment is captured by the first group.
2142 "Format string matching the ending of a LaTeX environment.
2146 "Parse a LaTeX environment.
2148 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2149 the buffer position at the beginning of the first affiliated
2150 keyword and CDR is a plist of affiliated keywords along with
2151 their value.
2153 Return a list whose CAR is `latex-environment' and CDR is a plist
2154 containing `:begin', `:end', `:value', `:post-blank' and
2155 `:post-affiliated' keywords.
2157 Assume point is at the beginning of the latex environment."
2164 limit t))
2165 ;; Incomplete latex environment: parse it as a paragraph.
2175 :end end
2176 :value value
2182 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2183 CONTENTS is nil."
2187 ;;;; Node Property
2190 "Parse a node-property at point.
2192 LIMIT bounds the search.
2194 Return a list whose CAR is `node-property' and CDR is a plist
2195 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2196 `:post-affiliated' keywords."
2206 limit))))
2209 :value value
2210 :begin begin
2211 :end end
2216 "Interpret NODE-PROPERTY element as Org syntax.
2217 CONTENTS is nil."
2223 ;;;; Paragraph
2226 "Parse a paragraph.
2228 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2229 the buffer position at the beginning of the first affiliated
2230 keyword and CDR is a plist of affiliated keywords along with
2231 their value.
2233 Return a list whose CAR is `paragraph' and CDR is a plist
2234 containing `:begin', `:end', `:contents-begin' and
2235 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2237 Assume point is at the beginning of the paragraph."
2244 ;; A matching `org-element-paragraph-separate' is not
2245 ;; necessarily the end of the paragraph. In particular,
2246 ;; drawers, blocks or LaTeX environments opening lines
2247 ;; must be closed. Moreover keywords with a secondary
2248 ;; value must belong to "dual keywords".
2262 limit t)))
2268 limit t)))
2271 org-element-dual-keywords))
2272 ;; Everything else is unambiguous.
2285 :end end
2286 :contents-begin contents-begin
2287 :contents-end contents-end
2293 "Interpret PARAGRAPH element as Org syntax.
2294 CONTENTS is the contents of the element."
2295 contents)
2298 ;;;; Planning
2301 "Parse a planning.
2303 LIMIT bounds the search.
2305 Return a list whose CAR is `planning' and CDR is a plist
2306 containing `:closed', `:deadline', `:scheduled', `:begin',
2307 `:end', `:post-blank' and `:post-affiliated' keywords."
2317 closed deadline scheduled)
2329 :deadline deadline
2330 :scheduled scheduled
2331 :begin begin
2332 :end end
2333 :post-blank post-blank
2337 "Interpret PLANNING element as Org syntax.
2338 CONTENTS is nil."
2340 'identity
2357 ;;;; Src Block
2360 "Parse a src block.
2362 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2363 the buffer position at the beginning of the first affiliated
2364 keyword and CDR is a plist of affiliated keywords along with
2365 their value.
2367 Return a list whose CAR is `src-block' and CDR is a plist
2368 containing `:language', `:switches', `:parameters', `:begin',
2369 `:end', `:number-lines', `:retain-labels', `:use-labels',
2370 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2371 `:post-affiliated' keywords.
2373 Assume point is at the beginning of the block."
2376 limit t)))
2377 ;; Incomplete block: parse it as a paragraph.
2383 ;; Get language as a string.
2392 ;; Get switches.
2394 ;; Get parameters.
2396 ;; Switches analysis
2407 ;; Should labels be retained in (or stripped from)
2408 ;; src blocks?
2413 ;; What should code-references use - labels or
2414 ;; line-numbers?
2419 ;; Indentation.
2421 ;; Retrieve code.
2426 block-ind))
2430 ;; Get position after ending blank lines.
2440 :begin begin
2441 :end end
2442 :number-lines number-lines
2443 :preserve-indent preserve-indent
2444 :retain-labels retain-labels
2445 :use-labels use-labels
2446 :label-fmt label-fmt
2447 :value value
2453 "Interpret SRC-BLOCK element as Org syntax.
2454 CONTENTS is nil."
2463 val)
2477 ;;;; Table
2480 "Parse a table at point.
2482 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2483 the buffer position at the beginning of the first affiliated
2484 keyword and CDR is a plist of affiliated keywords along with
2485 their value.
2487 Return a list whose CAR is `table' and CDR is a plist containing
2488 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2489 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2490 keywords.
2492 Assume point is at the beginning of the table."
2508 acc))
2515 :end end
2516 :type type
2517 :tblfm tblfm
2518 ;; Only `org' tables have contents. `table.el' tables
2519 ;; use a `:value' property to store raw table as
2520 ;; a string.
2525 table-begin table-end))
2531 "Interpret TABLE element as Org syntax.
2532 CONTENTS is a string, if table's type is `org', or nil."
2543 ;;;; Table Row
2546 "Parse table row at point.
2548 LIMIT bounds the search.
2550 Return a list whose CAR is `table-row' and CDR is a plist
2551 containing `:begin', `:end', `:contents-begin', `:contents-end',
2552 `:type', `:post-blank' and `:post-affiliated' keywords."
2556 ;; A table rule has no contents. In that case, ensure
2557 ;; CONTENTS-BEGIN matches CONTENTS-END.
2569 :begin begin
2570 :end end
2571 :contents-begin contents-begin
2572 :contents-end contents-end
2577 "Interpret TABLE-ROW element as Org syntax.
2578 CONTENTS is the contents of the table row."
2583 ;;;; Verse Block
2586 "Parse a verse block.
2588 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2589 the buffer position at the beginning of the first affiliated
2590 keyword and CDR is a plist of affiliated keywords along with
2591 their value.
2593 Return a list whose CAR is `verse-block' and CDR is a plist
2594 containing `:begin', `:end', `:contents-begin', `:contents-end',
2595 `:post-blank' and `:post-affiliated' keywords.
2597 Assume point is at beginning of the block."
2601 ;; Incomplete block: parse it as a paragraph.
2616 :end end
2617 :contents-begin contents-begin
2618 :contents-end contents-end
2624 "Interpret VERSE-BLOCK element as Org syntax.
2625 CONTENTS is verse block contents."
2629 \f
2630 ;;; Objects
2631 ;;
2632 ;; Unlike to elements, raw text can be found between objects. Hence,
2633 ;; `org-element--object-lex' is provided to find the next object in
2634 ;; buffer.
2635 ;;
2636 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2637 ;; object types they can contain will be specified in
2638 ;; `org-element-object-restrictions'.
2639 ;;
2640 ;; Creating a new type of object requires to alter
2641 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2642 ;; new type in `org-element-all-objects', and possibly add
2643 ;; restrictions in `org-element-object-restrictions'.
2645 ;;;; Bold
2648 "Parse bold object at point, if any.
2650 When at a bold object, return a list whose car is `bold' and cdr
2651 is a plist with `:begin', `:end', `:contents-begin' and
2652 `:contents-end' and `:post-blank' keywords. Otherwise, return
2653 nil.
2655 Assume point is at the first star marker."
2667 :end end
2668 :contents-begin contents-begin
2669 :contents-end contents-end
2673 "Interpret BOLD object as Org syntax.
2674 CONTENTS is the contents of the object."
2678 ;;;; Code
2681 "Parse code object at point, if any.
2683 When at a code object, return a list whose car is `code' and cdr
2684 is a plist with `:value', `:begin', `:end' and `:post-blank'
2685 keywords. Otherwise, return nil.
2687 Assume point is at the first tilde marker."
2698 :begin begin
2699 :end end
2703 "Interpret CODE object as Org syntax.
2704 CONTENTS is nil."
2708 ;;;; Entity
2711 "Parse entity at point, if any.
2713 When at an entity, return a list whose car is `entity' and cdr
2714 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2715 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2716 `:post-blank' as keywords. Otherwise, return nil.
2718 Assume point is at the beginning of the entity."
2720 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2738 :begin begin
2739 :end end
2740 :use-brackets-p bracketsp
2744 "Interpret ENTITY object as Org syntax.
2745 CONTENTS is nil."
2751 ;;;; Export Snippet
2754 "Parse export snippet at point.
2756 When at an export snippet, return a list whose car is
2757 `export-snippet' and cdr a plist with `:begin', `:end',
2758 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2759 return nil.
2761 Assume point is at the beginning of the snippet."
2777 :value value
2778 :begin begin
2779 :end end
2783 "Interpret EXPORT-SNIPPET object as Org syntax.
2784 CONTENTS is nil."
2790 ;;;; Footnote Reference
2793 "Parse footnote reference at point, if any.
2795 When at a footnote reference, return a list whose car is
2796 `footnote-reference' and cdr a plist with `:label', `:type',
2797 `:begin', `:end', `:content-begin', `:contents-end' and
2798 `:post-blank' as keywords. Otherwise, return nil."
2818 :type type
2819 :begin begin
2820 :end end
2826 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2827 CONTENTS is its definition, when inline, or nil."
2833 ;;;; Inline Babel Call
2836 "Parse inline babel call at point, if any.
2838 When at an inline babel call, return a list whose car is
2839 `inline-babel-call' and cdr a plist with `:call',
2840 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2841 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2843 Assume point is at the beginning of the babel call."
2859 :inside-header inside-header
2860 :arguments arguments
2861 :end-header end-header
2862 :begin begin
2863 :end end
2864 :value value
2868 "Interpret INLINE-BABEL-CALL object as Org syntax.
2869 CONTENTS is nil."
2879 ;;;; Inline Src Block
2882 "Parse inline source block at point, if any.
2884 When at an inline source block, return a list whose car is
2885 `inline-src-block' and cdr a plist with `:begin', `:end',
2886 `:language', `:value', `:parameters' and `:post-blank' as
2887 keywords. Otherwise, return nil.
2889 Assume point is at the beginning of the inline src block."
2902 :value value
2903 :parameters parameters
2904 :begin begin
2905 :end end
2909 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2910 CONTENTS is nil."
2915 language
2917 body)))
2919 ;;;; Italic
2922 "Parse italic object at point, if any.
2924 When at an italic object, return a list whose car is `italic' and
2925 cdr is a plist with `:begin', `:end', `:contents-begin' and
2926 `:contents-end' and `:post-blank' keywords. Otherwise, return
2927 nil.
2929 Assume point is at the first slash marker."
2941 :end end
2942 :contents-begin contents-begin
2943 :contents-end contents-end
2947 "Interpret ITALIC object as Org syntax.
2948 CONTENTS is the contents of the object."
2952 ;;;; Latex Fragment
2955 "Parse LaTeX fragment at point, if any.
2957 When at a LaTeX fragment, return a list whose car is
2958 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2959 and `:post-blank' as keywords. Otherwise, return nil.
2961 Assume point is at the beginning of the LaTeX fragment."
2979 ;; Macro.
2988 :begin begin
2989 :end end
2993 "Interpret LATEX-FRAGMENT object as Org syntax.
2994 CONTENTS is nil."
2997 ;;;; Line Break
3000 "Parse line break at point, if any.
3002 When at a line break, return a list whose car is `line-break',
3003 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3004 Otherwise, return nil.
3006 Assume point is at the beginning of the line break."
3015 "Interpret LINE-BREAK object as Org syntax.
3016 CONTENTS is nil."
3020 ;;;; Link
3023 "Parse link at point, if any.
3025 When at a link, return a list whose car is `link' and cdr a plist
3026 with `:type', `:path', `:raw-link', `:application',
3027 `:search-option', `:begin', `:end', `:contents-begin',
3028 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3029 nil.
3031 Assume point is at the beginning of the link."
3034 end contents-begin contents-end link-end post-blank path type
3035 raw-link link search-option application)
3037 ;; Type 1: Text targeted from a radio target.
3046 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3051 ;; RAW-LINK is the original link. Expand any
3052 ;; abbreviation in it.
3056 ;; Determine TYPE of link and set PATH accordingly.
3058 ;; File type.
3062 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3065 ;; According to RFC 3986, extra whitespace should be
3066 ;; ignored when a URI is extracted.
3069 ;; Id type: PATH is the id.
3072 ;; Code-ref type: PATH is the name of the reference.
3075 ;; Custom-id type: PATH is the name of the custom id.
3078 ;; Fuzzy type: Internal link either matches a target, an
3079 ;; headline name or nothing. PATH is the target or
3080 ;; headline's name.
3082 ;; Type 3: Plain link, e.g., http://orgmode.org
3088 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3096 ;; In any case, deduce end point after trailing white space from
3097 ;; LINK-END variable.
3101 ;; Special "file" type link processing. Extract opening
3102 ;; application and search option, if any. Also normalize URI.
3111 :path path
3113 :application application
3114 :search-option search-option
3115 :begin begin
3116 :end end
3117 :contents-begin contents-begin
3118 :contents-end contents-end
3122 "Interpret LINK object as Org syntax.
3123 CONTENTS is the contents of the object, or nil."
3128 raw-link
3132 ;;;; Macro
3135 "Parse macro at point, if any.
3137 When at a macro, return a list whose car is `macro' and cdr
3138 a plist with `:key', `:args', `:begin', `:end', `:value' and
3139 `:post-blank' as keywords. Otherwise, return nil.
3141 Assume point is at the macro."
3154 :value value
3155 :args args
3156 :begin begin
3157 :end end
3161 "Interpret MACRO object as Org syntax.
3162 CONTENTS is nil."
3166 ;;;; Radio-target
3169 "Parse radio target at point, if any.
3171 When at a radio target, return a list whose car is `radio-target'
3172 and cdr a plist with `:begin', `:end', `:contents-begin',
3173 `:contents-end', `:value' and `:post-blank' as keywords.
3174 Otherwise, return nil.
3176 Assume point is at the radio target."
3188 :end end
3189 :contents-begin contents-begin
3190 :contents-end contents-end
3191 :post-blank post-blank
3195 "Interpret TARGET object as Org syntax.
3196 CONTENTS is the contents of the object."
3200 ;;;; Statistics Cookie
3203 "Parse statistics cookie at point, if any.
3205 When at a statistics cookie, return a list whose car is
3206 `statistics-cookie', and cdr a plist with `:begin', `:end',
3207 `:value' and `:post-blank' keywords. Otherwise, return nil.
3209 Assume point is at the beginning of the statistics-cookie."
3220 :end end
3221 :value value
3225 "Interpret STATISTICS-COOKIE object as Org syntax.
3226 CONTENTS is nil."
3230 ;;;; Strike-Through
3233 "Parse strike-through object at point, if any.
3235 When at a strike-through object, return a list whose car is
3236 `strike-through' and cdr is a plist with `:begin', `:end',
3237 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3238 Otherwise, return nil.
3240 Assume point is at the first plus sign marker."
3252 :end end
3253 :contents-begin contents-begin
3254 :contents-end contents-end
3258 "Interpret STRIKE-THROUGH object as Org syntax.
3259 CONTENTS is the contents of the object."
3263 ;;;; Subscript
3266 "Parse subscript at point, if any.
3268 When at a subscript object, return a list whose car is
3269 `subscript' and cdr a plist with `:begin', `:end',
3270 `:contents-begin', `:contents-end', `:use-brackets-p' and
3271 `:post-blank' as keywords. Otherwise, return nil.
3273 Assume point is at the underscore."
3287 :end end
3288 :use-brackets-p bracketsp
3289 :contents-begin contents-begin
3290 :contents-end contents-end
3294 "Interpret SUBSCRIPT object as Org syntax.
3295 CONTENTS is the contents of the object."
3298 contents))
3301 ;;;; Superscript
3304 "Parse superscript at point, if any.
3306 When at a superscript object, return a list whose car is
3307 `superscript' and cdr a plist with `:begin', `:end',
3308 `:contents-begin', `:contents-end', `:use-brackets-p' and
3309 `:post-blank' as keywords. Otherwise, return nil.
3311 Assume point is at the caret."
3325 :end end
3326 :use-brackets-p bracketsp
3327 :contents-begin contents-begin
3328 :contents-end contents-end
3332 "Interpret SUPERSCRIPT object as Org syntax.
3333 CONTENTS is the contents of the object."
3336 contents))
3339 ;;;; Table Cell
3342 "Parse table cell at point.
3343 Return a list whose car is `table-cell' and cdr is a plist
3344 containing `:begin', `:end', `:contents-begin', `:contents-end'
3345 and `:post-blank' keywords."
3353 :end end
3354 :contents-begin contents-begin
3355 :contents-end contents-end
3359 "Interpret TABLE-CELL element as Org syntax.
3360 CONTENTS is the contents of the cell, or nil."
3364 ;;;; Target
3367 "Parse target at point, if any.
3369 When at a target, return a list whose car is `target' and cdr
3370 a plist with `:begin', `:end', `:value' and `:post-blank' as
3371 keywords. Otherwise, return nil.
3373 Assume point is at the target."
3383 :end end
3384 :value value
3388 "Interpret TARGET object as Org syntax.
3389 CONTENTS is nil."
3393 ;;;; Timestamp
3404 "Parse time stamp at point, if any.
3406 When at a time stamp, return a list whose car is `timestamp', and
3407 cdr a plist with `:type', `:raw-value', `:year-start',
3408 `:month-start', `:day-start', `:hour-start', `:minute-start',
3409 `:year-end', `:month-end', `:day-end', `:hour-end',
3410 `:minute-end', `:repeater-type', `:repeater-value',
3411 `:repeater-unit', `:warning-type', `:warning-value',
3412 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3413 Otherwise, return nil.
3415 Assume point is at the beginning of the timestamp."
3434 date-start)
3445 raw-value)
3447 :repeater-type
3453 :repeater-unit
3462 :warning-unit
3465 year-start month-start day-start hour-start minute-start year-end
3466 month-end day-end hour-end minute-end)
3467 ;; Parse date-start.
3475 ;; Compute date-end. It can be provided directly in time-stamp,
3476 ;; or extracted from time range. Otherwise, it defaults to the
3477 ;; same values as date-start.
3487 :raw-value raw-value
3488 :year-start year-start
3489 :month-start month-start
3490 :day-start day-start
3491 :hour-start hour-start
3492 :minute-start minute-start
3493 :year-end year-end
3494 :month-end month-end
3495 :day-end day-end
3496 :hour-end hour-end
3497 :minute-end minute-end
3498 :begin begin
3499 :end end
3501 repeater-props
3502 warning-props))))))
3505 "Interpret TIMESTAMP object as Org syntax.
3506 CONTENTS is nil."
3525 ;; Build an Org timestamp string from TIME. ACTIVEP is
3526 ;; non-nil when time stamp is active. If WITH-TIME-P is
3527 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3528 ;; specify a time range in the timestamp. REPEAT-STRING is
3529 ;; the repeater string, if any.
3533 org-time-stamp-formats)
3534 time)))
3540 nil nil ts)))
3545 " "
3546 s
3548 ;; Return value.
3549 ts)))
3561 build-ts-string
3580 0
3588 "--"
3601 ;;;; Underline
3604 "Parse underline object at point, if any.
3606 When at an underline object, return a list whose car is
3607 `underline' and cdr is a plist with `:begin', `:end',
3608 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3609 Otherwise, return nil.
3611 Assume point is at the first underscore marker."
3623 :end end
3624 :contents-begin contents-begin
3625 :contents-end contents-end
3629 "Interpret UNDERLINE object as Org syntax.
3630 CONTENTS is the contents of the object."
3634 ;;;; Verbatim
3637 "Parse verbatim object at point, if any.
3639 When at a verbatim object, return a list whose car is `verbatim'
3640 and cdr is a plist with `:value', `:begin', `:end' and
3641 `:post-blank' keywords. Otherwise, return nil.
3643 Assume point is at the first equal sign marker."
3654 :begin begin
3655 :end end
3659 "Interpret VERBATIM object as Org syntax.
3660 CONTENTS is nil."
3664 \f
3665 ;;; Parsing Element Starting At Point
3666 ;;
3667 ;; `org-element--current-element' is the core function of this section.
3668 ;; It returns the Lisp representation of the element starting at
3669 ;; point.
3670 ;;
3671 ;; `org-element--current-element' makes use of special modes. They
3672 ;; are activated for fixed element chaining (e.g., `plain-list' >
3673 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3674 ;; `section'). Special modes are: `first-section', `item',
3675 ;; `node-property', `section' and `table-row'.
3678 "Parse the element starting at point.
3680 Return value is a list like (TYPE PROPS) where TYPE is the type
3681 of the element and PROPS a plist of properties associated to the
3682 element.
3684 Possible types are defined in `org-element-all-elements'.
3686 LIMIT bounds the search.
3688 Optional argument GRANULARITY determines the depth of the
3689 recursion. Allowed values are `headline', `greater-element',
3690 `element', `object' or nil. When it is broader than `object' (or
3691 nil), secondary values will not be parsed, since they only
3692 contain objects.
3694 Optional argument MODE, when non-nil, can be either
3695 `first-section', `section', `planning', `item', `node-property'
3696 and `table-row'.
3698 If STRUCTURE isn't provided but MODE is set to `item', it will be
3699 computed.
3701 This function assumes point is always at the beginning of the
3702 element it has to parse."
3705 ;; Determine if parsing depth allows for secondary strings
3706 ;; parsing. It only applies to elements referenced in
3707 ;; `org-element-secondary-value-alist'.
3710 ;; Item.
3713 ;; Table Row.
3715 ;; Node Property.
3717 ;; Headline.
3720 ;; Sections (must be checked after headline).
3725 limit)))
3726 ;; Planning.
3729 ;; Property drawer.
3733 ;; When not at bol, point is at the beginning of an item or
3734 ;; a footnote definition: next item is always a paragraph.
3736 ;; Clock.
3738 ;; Inlinetask.
3741 ;; From there, elements can have affiliated keywords.
3744 ;; Jumping over affiliated keywords put point off-limits.
3745 ;; Parse them as regular keywords.
3749 ;; LaTeX Environment.
3752 ;; Drawer and Property Drawer.
3755 ;; Fixed Width
3758 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3759 ;; Keywords.
3768 org-element-block-name-alist)))
3783 ;; Footnote Definition.
3786 ;; Horizontal Rule.
3789 ;; Diary Sexp.
3792 ;; Table.
3795 ;; List.
3798 limit affiliated
3800 ;; Default element: Paragraph.
3804 ;; Most elements can have affiliated keywords. When looking for an
3805 ;; element beginning, we want to move before them, as they belong to
3806 ;; that element, and, in the meantime, collect information they give
3807 ;; into appropriate properties. Hence the following function.
3810 "Collect affiliated keywords from point down to LIMIT.
3812 Return a list whose CAR is the position at the first of them and
3813 CDR a plist of keywords and values and move point to the
3814 beginning of the first line after them.
3816 As a special case, if element doesn't start at the beginning of
3817 the line (e.g., a paragraph starting an item), CAR is current
3818 position of point and CDR is nil."
3822 ;; RESTRICT is the list of objects allowed in parsed
3823 ;; keywords value.
3825 output)
3828 ;; Apply translation to RAW-KWD. From there, KWD is
3829 ;; the official keyword.
3831 org-element-keyword-translation-alist))
3832 raw-kwd))
3833 ;; Find main value for any keyword.
3839 ;; PARSEDP is non-nil when keyword should have its
3840 ;; value parsed.
3842 ;; If KWD is a dual keyword, find its secondary
3843 ;; value. Maybe parse it.
3851 ;; Attribute a property name to KWD.
3853 ;; Now set final shape for VALUE.
3859 nil restrict)))
3863 ;; Attributes can always appear on multiple lines.
3866 ;; Eventually store the new value in OUTPUT.
3868 ;; Move to next keyword.
3870 ;; If affiliated keywords are orphaned: move back to first one.
3871 ;; They will be parsed as a paragraph.
3873 ;; Return value.
3877 \f
3878 ;;; The Org Parser
3879 ;;
3880 ;; The two major functions here are `org-element-parse-buffer', which
3881 ;; parses Org syntax inside the current buffer, taking into account
3882 ;; region, narrowing, or even visibility if specified, and
3883 ;; `org-element-parse-secondary-string', which parses objects within
3884 ;; a given string.
3885 ;;
3886 ;; The (almost) almighty `org-element-map' allows to apply a function
3887 ;; on elements or objects matching some type, and accumulate the
3888 ;; resulting values. In an export situation, it also skips unneeded
3889 ;; parts of the parse tree.
3892 "Recursively parse the buffer and return structure.
3893 If narrowing is in effect, only parse the visible part of the
3894 buffer.
3896 Optional argument GRANULARITY determines the depth of the
3897 recursion. It can be set to the following symbols:
3899 `headline' Only parse headlines.
3900 `greater-element' Don't recurse into greater elements excepted
3901 headlines and sections. Thus, elements
3902 parsed are the top-level ones.
3903 `element' Parse everything but objects and plain text.
3904 `object' Parse the complete buffer (default).
3906 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3907 elements.
3909 An element or an objects is represented as a list with the
3910 pattern (TYPE PROPERTIES CONTENTS), where :
3912 TYPE is a symbol describing the element or object. See
3913 `org-element-all-elements' and `org-element-all-objects' for an
3914 exhaustive list of such symbols. One can retrieve it with
3915 `org-element-type' function.
3917 PROPERTIES is the list of attributes attached to the element or
3918 object, as a plist. Although most of them are specific to the
3919 element or object type, all types share `:begin', `:end',
3920 `:post-blank' and `:parent' properties, which respectively
3921 refer to buffer position where the element or object starts,
3922 ends, the number of white spaces or blank lines after it, and
3923 the element or object containing it. Properties values can be
3924 obtained by using `org-element-property' function.
3926 CONTENTS is a list of elements, objects or raw strings
3927 contained in the current element or object, when applicable.
3928 One can access them with `org-element-contents' function.
3930 The Org buffer has `org-data' as type and nil as properties.
3931 `org-element-map' function can be used to find specific elements
3932 or objects within the parse tree.
3934 This function assumes that current major mode is `org-mode'."
3940 ;; Start in `first-section' mode so text before the first
3941 ;; headline belongs to a section.
3945 "Recursively parse objects in STRING and return structure.
3947 RESTRICTION is a symbol limiting the object types that will be
3948 looked after.
3950 Optional argument PARENT, when non-nil, is the element or object
3951 containing the secondary string. It is used to set correctly
3952 `:parent' property within the string.
3954 If STRING is the empty string or nil, return nil."
3970 data))))))
3974 "Map a function on selected elements or objects.
3976 DATA is a parse tree, an element, an object, a string, or a list
3977 of such constructs. TYPES is a symbol or list of symbols of
3978 elements or objects types (see `org-element-all-elements' and
3979 `org-element-all-objects' for a complete list of types). FUN is
3980 the function called on the matching element or object. It has to
3981 accept one argument: the element or object itself.
3983 When optional argument INFO is non-nil, it should be a plist
3984 holding export options. In that case, parts of the parse tree
3985 not exportable according to that property list will be skipped.
3987 When optional argument FIRST-MATCH is non-nil, stop at the first
3988 match for which FUN doesn't return nil, and return that value.
3990 Optional argument NO-RECURSION is a symbol or a list of symbols
3991 representing elements or objects types. `org-element-map' won't
3992 enter any recursive element or object whose type belongs to that
3993 list. Though, FUN can still be applied on them.
3995 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3996 apply to matching objects within parsed affiliated keywords (see
3997 `org-element-parsed-keywords').
3999 Nil values returned from FUN do not appear in the results.
4002 Examples:
4003 ---------
4005 Assuming TREE is a variable containing an Org buffer parse tree,
4006 the following example will return a flat list of all `src-block'
4007 and `example-block' elements in it:
4009 \(org-element-map tree '(example-block src-block) #'identity)
4011 The following snippet will find the first headline with a level
4014 \(org-element-map tree 'headline
4015 \(lambda (hl)
4016 \(and (= (org-element-property :level hl) 1)
4018 \(org-element-property :begin hl)))
4019 nil t)
4021 The next example will return a flat list of all `plain-list' type
4022 elements in TREE that are not a sub-list themselves:
4024 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4026 Eventually, this example will return a flat list of all `bold'
4027 type objects containing a `latex-snippet' type object, even
4028 looking into captions:
4030 \(org-element-map tree 'bold
4031 \(lambda (b)
4032 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4033 nil nil nil t)"
4034 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4038 ;; Recursion depth is determined by --CATEGORY.
4045 ;; If one object is found, the function has to
4046 ;; recurse into every object.
4049 ;; If one regular element is found, the
4050 ;; function has to recurse, at least, into
4051 ;; every element it encounters.
4054 --acc
4055 --walk-tree
4058 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4059 ;; holding contextual information.
4063 ;; Ignored element in an export context.
4065 ;; List of elements or objects.
4067 ;; Unconditionally enter parse trees.
4071 ;; Check if TYPE is matching among TYPES. If so,
4072 ;; apply FUN to --DATA and accumulate return value
4073 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4079 ;; If --DATA has a secondary string that can contain
4080 ;; objects with their type among TYPES, look into it.
4083 org-element-secondary-value-alist)))
4085 ;; If --DATA has any parsed affiliated keywords and
4086 ;; WITH-AFFILIATED is non-nil, look for objects in
4087 ;; them.
4094 ;; Pay attention to the type of parsed keyword.
4095 ;; In particular, preserve order for multiple
4096 ;; keywords.
4109 ;; Determine if a recursion into --DATA is possible.
4111 ;; --TYPE is explicitly removed from recursion.
4113 ;; --DATA has no contents.
4115 ;; Looking for greater elements but --DATA is simply
4116 ;; an element or an object.
4119 ;; Looking for elements but --DATA is an object.
4122 ;; In any other case, map contents.
4126 ;; Return value in a proper order.
4130 ;; The following functions are internal parts of the parser.
4131 ;;
4132 ;; The first one, `org-element--parse-elements' acts at the element's
4133 ;; level.
4134 ;;
4135 ;; The second one, `org-element--parse-objects' applies on all objects
4136 ;; of a paragraph or a secondary string. It calls
4137 ;; `org-element--object-lex' to find the next object in the current
4138 ;; container.
4141 "Return next special mode according to TYPE, or nil.
4142 TYPE is a symbol representing the type of an element or object
4143 containing next element if PARENTP is non-nil, or before it
4144 otherwise. Modes can be either `first-section', `item',
4145 `node-property', `planning', `property-drawer', `section',
4146 `table-row' or nil."
4162 "Parse elements between BEG and END positions.
4164 MODE prioritizes some elements over the others. It can be set to
4165 `first-section', `section', `planning', `item', `node-property'
4166 or `table-row'.
4168 When value is `item', STRUCTURE will be used as the current list
4169 structure.
4171 GRANULARITY determines the depth of the recursion. See
4172 `org-element-parse-buffer' for more information.
4174 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4175 elements.
4177 Elements are accumulated into ACC."
4180 ;; Visible only: skip invisible parts at the beginning of the
4181 ;; element.
4184 ;; When parsing only headlines, skip any text before first one.
4187 ;; Main loop start.
4189 ;; Find current element's type and parse it accordingly to
4190 ;; its category.
4192 end granularity mode structure))
4196 ;; Visible only: skip invisible parts between siblings.
4199 ;; Fill ELEMENT contents by side-effect.
4201 ;; If element has no contents, don't modify it.
4203 ;; Greater element: parse it between `contents-begin' and
4204 ;; `contents-end'. Make sure GRANULARITY allows the
4205 ;; recursion, or ELEMENT is a headline, in which case going
4206 ;; inside is mandatory, in order to get sub-level headings.
4214 ;; Possibly switch to a special mode.
4218 granularity visible-only element))
4219 ;; ELEMENT has contents. Parse objects inside, if
4220 ;; GRANULARITY allows it.
4226 ;; Update mode.
4228 ;; Return result.
4229 acc))
4232 "Return next object in current buffer or nil.
4233 RESTRICTION is a list of object types, as symbols, that should be
4234 looked after. This function assumes that the buffer is narrowed
4235 to an appropriate container (e.g., a paragraph)."
4243 found)
4308 ;; This is probably a plain link.
4314 ;; Radio link.
4319 "Parse objects between BEG and END and return recursive structure.
4321 Objects are accumulated in ACC.
4323 RESTRICTION is a list of object successors which are allowed in
4324 the current object."
4332 ;; 1. Text before any object. Untabify it.
4337 acc
4341 ;; 2. Object...
4344 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4345 ;; a recursive type.
4353 ;; 3. Text after last object. Untabify it.
4357 acc
4361 ;; Result.
4362 acc)))
4365 \f
4366 ;;; Towards A Bijective Process
4367 ;;
4368 ;; The parse tree obtained with `org-element-parse-buffer' is really
4369 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4370 ;; interpreted and expanded into a string with canonical Org syntax.
4371 ;; Hence `org-element-interpret-data'.
4372 ;;
4373 ;; The function relies internally on
4374 ;; `org-element--interpret-affiliated-keywords'.
4376 ;;;###autoload
4378 "Interpret DATA as Org syntax.
4379 DATA is a parse tree, an element, an object or a secondary string
4380 to interpret. Return Org syntax as a string."
4384 "Interpret DATA as Org syntax.
4386 DATA is a parse tree, an element, an object or a secondary string
4387 to interpret. PARENT is used for recursive calls. It contains
4388 the element or object containing data, or nil.
4390 Return Org syntax as a string."
4392 ;; Find interpreter for current object or element. If it
4393 ;; doesn't exist (e.g. this is a pseudo object or element),
4394 ;; return contents, if any.
4400 ;; Secondary string.
4404 ;; Full Org document.
4408 ;; Plain text: return it.
4410 ;; Element or object without contents.
4412 ;; Element or object with contents.
4415 ;; Recursively interpret contents.
4420 data
4421 ;; Fix indentation of elements containing
4422 ;; objects. We ignore `table-row' elements
4423 ;; as they are one line long anyway.
4425 data
4426 ;; When normalizing first paragraph of an
4427 ;; item or a footnote-definition, ignore
4428 ;; first line's indentation.
4435 ;; Build white spaces. If no `:post-blank' property is
4436 ;; specified, assume its value is 0.
4450 "Return ELEMENT's affiliated keywords as Org syntax.
4451 If there is no affiliated keyword, return the empty string."
4461 ": "
4464 value)
4472 ;; All attribute keywords can have multiple lines.
4478 ;; List all ELEMENT's properties matching an attribute line or an
4479 ;; affiliated keyword, but ignore translated keywords since they
4480 ;; cannot belong to the property list.
4487 org-element-keyword-translation-alist)))))
4488 collect prop)
4491 ;; Because interpretation of the parse tree must return the same
4492 ;; number of blank lines between elements and the same number of white
4493 ;; space after objects, some special care must be given to white
4494 ;; spaces.
4495 ;;
4496 ;; The first function, `org-element-normalize-string', ensures any
4497 ;; string different from the empty string will end with a single
4498 ;; newline character.
4499 ;;
4500 ;; The second function, `org-element-normalize-contents', removes
4501 ;; global indentation from the contents of the current element.
4504 "Ensure string S ends with a single newline character.
4506 If S isn't a string return it unchanged. If S is the empty
4507 string, return it. Otherwise, return a new string with a single
4508 newline character at its end."
4516 "Normalize plain text in ELEMENT's contents.
4518 ELEMENT must only contain plain text and objects.
4520 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4521 indentation to compute maximal common indentation.
4523 Return the normalized element that is element with global
4524 indentation removed from its contents. The function assumes that
4525 indentation is not done with TAB characters."
4527 find-min-ind ; For byte-compiler.
4529 ;; Return minimal common indentation within BLOB. This is
4530 ;; done by walking recursively BLOB and updating MIN-IND
4531 ;; along the way. FIRST-FLAG is non-nil when the next
4532 ;; object is expected to be a string that doesn't start with
4533 ;; a newline character. It happens for strings at the
4534 ;; beginnings of the contents or right after a line break.
4539 ;; Objects cannot start with spaces: in this case,
4540 ;; indentation is 0.
4544 ;; An indentation of zero means no string will be
4545 ;; modified. Quit the process.
4556 ;; Find minimal indentation in ELEMENT.
4559 ;; Build ELEMENT back, replacing each string with the same
4560 ;; string minus common indentation.
4564 ;; Return BLOB with all its strings indentation
4565 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4566 ;; non-nil when the next object is expected to be
4567 ;; a string that doesn't start with a newline
4568 ;; character.
4584 org-element-recursive-objects)
4588 object)
4591 blob)))
4595 \f
4596 ;;; Cache
4597 ;;
4598 ;; Implement a caching mechanism for `org-element-at-point' and
4599 ;; `org-element-context', which see.
4600 ;;
4601 ;; A single public function is provided: `org-element-cache-reset'.
4602 ;;
4603 ;; Cache is enabled by default, but can be disabled globally with
4604 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4605 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4606 ;; can be tweaked to control caching behaviour.
4607 ;;
4608 ;; Internally, parsed elements are stored in an AVL tree,
4609 ;; `org-element--cache'. This tree is updated lazily: whenever
4610 ;; a change happens to the buffer, a synchronization request is
4611 ;; registered in `org-element--cache-sync-requests' (see
4612 ;; `org-element--cache-submit-request'). During idle time, requests
4613 ;; are processed by `org-element--cache-sync'. Synchronization also
4614 ;; happens when an element is required from the cache. In this case,
4615 ;; the process stops as soon as the needed element is up-to-date.
4616 ;;
4617 ;; A synchronization request can only apply on a synchronized part of
4618 ;; the cache. Therefore, the cache is updated at least to the
4619 ;; location where the new request applies. Thus, requests are ordered
4620 ;; from left to right and all elements starting before the first
4621 ;; request are correct. This property is used by functions like
4622 ;; `org-element--cache-find' to retrieve elements in the part of the
4623 ;; cache that can be trusted.
4624 ;;
4625 ;; A request applies to every element, starting from its original
4626 ;; location (or key, see below). When a request is processed, it
4627 ;; moves forward and may collide the next one. In this case, both
4628 ;; requests are merged into a new one that starts from that element.
4629 ;; As a consequence, the whole synchronization complexity does not
4630 ;; depend on the number of pending requests, but on the number of
4631 ;; elements the very first request will be applied on.
4632 ;;
4633 ;; Elements cannot be accessed through their beginning position, which
4634 ;; may or may not be up-to-date. Instead, each element in the tree is
4635 ;; associated to a key, obtained with `org-element--cache-key'. This
4636 ;; mechanism is robust enough to preserve total order among elements
4637 ;; even when the tree is only partially synchronized.
4638 ;;
4639 ;; Objects contained in an element are stored in a hash table,
4640 ;; `org-element--cache-objects'.
4644 "Non nil when Org parser should cache its results.
4651 "Maximum duration, as a time value, for a cache synchronization.
4652 If the synchronization is not over after this delay, the process
4653 pauses and resumes after `org-element-cache-sync-break'
4657 "Duration, as a time value, of the pause between synchronizations.
4661 ;;;; Data Structure
4664 "AVL tree used to cache elements.
4665 Each node of the tree contains an element. Comparison is done
4666 with `org-element--cache-compare'. This cache is used in
4670 "Hash table used as to cache objects.
4671 Key is an element, as returned by `org-element-at-point', and
4672 value is an alist where each association is:
4674 \(PARENT COMPLETEP . OBJECTS)
4676 where PARENT is an element or object, COMPLETEP is a boolean,
4677 non-nil when all direct children of parent are already cached and
4678 OBJECTS is a list of such children, as objects, from farthest to
4679 closest.
4682 contained within a paragraph
4686 If the paragraph is completely parsed, OBJECTS-DATA will be
4688 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4689 \(BOLD-OBJECT t ENTITY-OBJECT))
4691 whereas in a partially parsed paragraph, it could be
4693 \((PARAGRAPH nil ENTITY-OBJECT))
4698 "List of pending synchronization requests.
4700 A request is a vector with the following pattern:
4702 \[NEXT BEG END OFFSET PARENT PHASE]
4704 Processing a synchronization request consists of three phases:
4706 0. Delete modified elements,
4707 1. Fill missing area in cache,
4708 2. Shift positions and re-parent elements after the changes.
4710 During phase 0, NEXT is the key of the first element to be
4711 removed, BEG and END is buffer position delimiting the
4712 modifications. Elements starting between them (inclusive) are
4713 removed. So are elements whose parent is removed. PARENT, when
4714 non-nil, is the parent of the first element to be removed.
4716 During phase 1, NEXT is the key of the next known element in
4717 cache and BEG its beginning position. Parse buffer between that
4718 element and the one before it in order to determine the parent of
4719 the next element. Set PARENT to the element containing NEXT.
4721 During phase 2, NEXT is the key of the next element to shift in
4722 the parse tree. All elements starting from this one have their
4723 properties relatives to buffer positions shifted by integer
4724 OFFSET and, if they belong to element PARENT, are adopted by it.
4732 "Hash table used to store keys during synchronization.
4736 "Return a unique key for ELEMENT in cache tree.
4738 Keys are used to keep a total order among elements in the cache.
4739 Comparison is done with `org-element--cache-key-less-p'.
4741 When no synchronization is taking place, a key is simply the
4742 beginning position of the element, or that position plus one in
4743 the case of an first item (respectively row) in
4744 a list (respectively a table).
4746 During a synchronization, the key is the one the element had when
4747 the cache was synchronized for the last time. Elements added to
4748 cache during the synchronization get a new key generated with
4749 `org-element--cache-generate-key'.
4751 Such keys are stored in `org-element--cache-sync-keys'. The hash
4752 table is cleared once the synchronization is complete."
4755 ;; Increase beginning position of items (respectively
4756 ;; table rows) by one, so the first item can get
4757 ;; a different key from its parent list (respectively
4758 ;; table).
4761 begin)))
4764 key))))
4767 "Generate a key between LOWER and UPPER.
4769 LOWER and UPPER are integers or lists, possibly empty.
4771 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4772 a unique key, as an integer or a list of integers, according to
4773 the following rules:
4775 - LOWER and UPPER are compared level-wise until values differ.
4777 - If, at a given level, LOWER and UPPER differ from more than
4778 2, the new key shares all the levels above with LOWER and
4779 gets a new level. Its value is the mean between LOWER and
4780 UPPER:
4782 \(1 2) + (1 4) --> (1 3)
4784 - If LOWER has no value to compare with, it is assumed that its
4785 value is `most-negative-fixnum'. E.g.,
4787 \(1 1) + (1 1 2)
4789 is equivalent to
4791 \(1 1 m) + (1 1 2)
4793 where m is `most-negative-fixnum'. Likewise, if UPPER is
4794 short of levels, the current value is `most-positive-fixnum'.
4796 - If they differ from only one, the new key inherits from
4797 current LOWER level and fork it at the next level. E.g.,
4799 \(2 1) + (3 3)
4801 is equivalent to
4803 \(2 1) + (2 M)
4805 where M is `most-positive-fixnum'.
4807 - If the key is only one level long, it is returned as an
4808 integer:
4810 \(1 2) + (3 2) --> 2
4812 When they are not equals, the function assumes that LOWER is
4813 lesser than UPPER, per `org-element--cache-key-less-p'."
4817 skip-upper key)
4828 ;; When at a given level, LOWER and UPPER differ from
4829 ;; 1, ignore UPPER altogether. Instead create a key
4830 ;; between LOWER and the greatest key with the same
4831 ;; prefix as LOWER so far.
4837 "Non-nil if key A is less than key B.
4838 A and B are either integers or lists of integers, as returned by
4839 `org-element--cache-key'."
4847 ;; If A is empty, either keys are equal (B is also empty) and
4848 ;; we return nil, or A is lesser than B (B is longer) and we
4849 ;; return a non-nil value.
4850 ;;
4851 ;; If A is not empty, B is necessarily empty and A is greater
4852 ;; than B (A is longer). Therefore, return nil.
4856 "Non-nil when element A is located before element B."
4861 "Return root value in cache.
4862 This function assumes `org-element--cache' is a valid AVL tree."
4866 ;;;; Tools
4869 "Non-nil when cache is active in current buffer."
4874 "Find element in cache starting at POS or before.
4876 POS refers to a buffer position.
4878 When optional argument SIDE is non-nil, the function checks for
4879 elements starting at or past POS instead. If SIDE is `both', the
4880 function returns a cons cell where car is the first element
4881 starting at or before POS and cdr the first element starting
4882 after POS.
4884 The function can only find elements in the synchronized part of
4885 the cache."
4889 lower upper)
4904 ;; We found an element in cache starting at POS. If `side'
4905 ;; is `both' we also want the next one in order to generate
4906 ;; a key in-between.
4907 ;;
4908 ;; If the element is the first row or item in a table or
4909 ;; a plain list, we always return the table or the plain
4910 ;; list.
4911 ;;
4912 ;; In any other case, we return the element found.
4921 lower parent
4922 upper parent)))))
4925 lower element
4926 upper element)))))
4933 "Store ELEMENT in current buffer's cache, if allowed.
4934 When optional argument DATA is non-nil, assume is it object data
4935 relative to ELEMENT and store it in the objects cache."
4939 ;; During synchronization, first build an appropriate key
4940 ;; for the new element so `avl-tree-enter' can insert it at
4941 ;; the right spot in the cache.
4950 org-element--cache-sync-keys)))
4952 ;; Headlines are not stored in cache, so objects in titles are
4953 ;; not stored either.
4958 "Remove ELEMENT from cache.
4959 Assume ELEMENT belongs to cache and that a cache is active."
4964 ;;;; Synchronization
4967 "Set idle timer for cache synchronization in BUFFER."
4974 org-element-cache-sync-idle-time))
4975 nil
4976 #'org-element--cache-sync
4977 buffer)))
4980 "Non-nil when synchronization process should be interrupted.
4981 TIME-LIMIT is a time value or nil."
4987 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4989 Properties containing buffer positions are `:begin', `:end',
4990 `:contents-begin', `:contents-end' and `:structure'. When
4991 optional argument PROPS is a list of keywords, only shift
4992 properties provided in that list.
4994 Properties are modified by side-effect."
4996 ;; Shift `:structure' property for the first plain list only: it
4997 ;; is the only one that really matters and it prevents from
4998 ;; shifting it more than once.
5012 "Synchronize cache with recent modification in BUFFER.
5014 When optional argument THRESHOLD is non-nil, do the
5015 synchronization for all elements starting before or at threshold,
5016 then exit. Otherwise, synchronize cache for as long as
5017 `org-element-cache-sync-duration' or until Emacs leaves idle
5018 state.
5020 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5021 not registered yet in the cache are going to happen. It is used
5022 in `org-element--cache-submit-request', where cache is partially
5023 updated before current modification are actually submitted."
5034 request
5036 threshold
5039 org-element-cache-sync-duration))
5040 future-change)
5041 ;; Request processed. Merge current and next offsets and
5042 ;; transfer ending position.
5048 ;; If more requests are awaiting, set idle timer accordingly.
5049 ;; Otherwise, reset keys.
5056 "Process synchronization REQUEST for all entries before NEXT.
5058 REQUEST is a vector, built by `org-element--cache-submit-request'.
5060 NEXT is a cache key, as returned by `org-element--cache-key'.
5062 When non-nil, THRESHOLD is a buffer position. Synchronization
5063 stops as soon as a shifted element begins after it.
5065 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5066 after this time or when Emacs exits idle state.
5068 When non-nil, FUTURE-CHANGE is a buffer position where changes
5069 not registered yet in the cache are going to happen. See
5070 `org-element--cache-submit-request' for more information.
5072 Throw `interrupt' if the process stops before completing the
5073 request."
5076 ;; Phase 0.
5077 ;;
5078 ;; Delete all elements starting after BEG, but not after buffer
5079 ;; position END or past element with key NEXT. Also delete
5080 ;; elements contained within a previously removed element
5081 ;; (stored in `last-container').
5082 ;;
5083 ;; At each iteration, we start again at tree root since
5084 ;; a deletion modifies structure of the balanced tree.
5089 ;; Find first element in cache with key BEG or after it.
5093 data data-key last-container)
5102 data-key key
5105 data-key key
5106 node nil)))))
5116 up)))
5119 end))
5126 ;; No element starting after modifications left in
5127 ;; cache: further processing is futile.
5130 ;; Phase 1.
5131 ;;
5132 ;; Phase 0 left a hole in the cache. Some elements after it
5133 ;; could have parents within. For example, in the following
5134 ;; buffer:
5135 ;;
5136 ;; - item
5137 ;;
5138 ;;
5139 ;; Paragraph1
5140 ;;
5141 ;; Paragraph2
5142 ;;
5143 ;; if we remove a blank line between "item" and "Paragraph1",
5144 ;; everything down to "Paragraph2" is removed from cache. But
5145 ;; the paragraph now belongs to the list, and its `:parent'
5146 ;; property no longer is accurate.
5147 ;;
5148 ;; Therefore we need to parse again elements in the hole, or at
5149 ;; least in its last section, so that we can re-parent
5150 ;; subsequent elements, during phase 2.
5151 ;;
5152 ;; Note that we only need to get the parent from the first
5153 ;; element in cache after the hole.
5154 ;;
5155 ;; When next key is lesser or equal to the current one, delegate
5156 ;; phase 1 processing to next request in order to preserve key
5157 ;; order among requests.
5165 ;; Next element will start at its beginning position plus
5166 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5167 ;; contains the real beginning position of the first element to
5168 ;; shift and re-parent.
5172 ;; Changes are going to happen around this element and
5173 ;; they will trigger another phase 1 request. Skip the
5174 ;; current one.
5180 ;; Phase 2.
5181 ;;
5182 ;; Shift all elements starting from key START, but before NEXT, by
5183 ;; OFFSET, and re-parent them when appropriate.
5184 ;;
5185 ;; Elements are modified by side-effect so the tree structure
5186 ;; remains intact.
5187 ;;
5188 ;; Once THRESHOLD, if any, is reached, or once there is an input
5189 ;; pending, exit. Before leaving, the current synchronization
5190 ;; request is updated.
5197 exit-flag)
5198 ;; No re-parenting nor shifting planned: request is over.
5208 ;; We reached NEXT. Request is complete.
5210 ;; Handle interruption request. Update current request.
5215 ;; Shift element.
5218 ;; Shift associated objects data, if any.
5223 ;; Update PARENT and re-parent DATA, only when
5224 ;; necessary. Propagate new structures for lists.
5238 ;; Cache is up-to-date past THRESHOLD. Request
5239 ;; interruption.
5244 ;; We reached end of tree: synchronization complete.
5245 t)))
5248 "Parse elements in current section, down to POS.
5250 Start parsing from the closest between the last known element in
5251 cache or headline above. Return the smallest element containing
5252 POS.
5254 When optional argument SYNCP is non-nil, return the parent of the
5255 element containing POS instead. In that case, it is also
5256 possible to provide TIME-LIMIT, which is a time value specifying
5257 when the parsing should stop. The function throws `interrupt' if
5258 the process stopped before finding the expected result."
5265 element next mode)
5267 ;; Nothing in cache before point: start parsing from first
5268 ;; element following headline above, or first element in
5269 ;; buffer.
5276 ;; Cache returned exact match: return it.
5279 ;; There's a headline between cached value and POS: cached
5280 ;; value is invalid. Start parsing from first element
5281 ;; following the headline.
5288 ;; Check if CACHED or any of its ancestors contain point.
5289 ;;
5290 ;; If there is such an element, we inspect it in order to know
5291 ;; if we return it or if we need to parse its contents.
5292 ;; Otherwise, we just start parsing from current location,
5293 ;; which is right after the top-most element containing
5294 ;; CACHED.
5295 ;;
5296 ;; As a special case, if POS is at the end of the buffer, we
5297 ;; want to return the innermost element ending there.
5298 ;;
5299 ;; Also, if we find an ancestor and discover that we need to
5300 ;; parse its contents, make sure we don't start from
5301 ;; `:contents-begin', as we would otherwise go past CACHED
5302 ;; again. Instead, in that situation, we will resume parsing
5303 ;; from NEXT, which is located after CACHED or its higher
5304 ;; ancestor not containing point.
5316 ;; Parse successively each element until we reach POS.
5329 end 'element mode
5336 ;; Skip any element ending before point. Also skip
5337 ;; element ending at point (unless it is also the end of
5338 ;; buffer) since we're sure that another element begins
5339 ;; after it.
5343 ;; A non-greater element contains point: return it.
5346 ;; Otherwise, we have to decide if ELEMENT really
5347 ;; contains POS. In that case we start parsing from
5348 ;; contents' beginning.
5349 ;;
5350 ;; If POS is at contents' beginning but it is also at
5351 ;; the beginning of the first item in a list or a table.
5352 ;; In that case, we need to create an anchor for that
5353 ;; list or table, so return it.
5354 ;;
5355 ;; Also, if POS is at the end of the buffer, no element
5356 ;; can start after it, but more than one may end there.
5357 ;; Arbitrarily, we choose to return the innermost of
5358 ;; such elements.
5371 parent element
5372 end cend))))
5373 ;; Otherwise, return ELEMENT as it is the smallest
5374 ;; element containing POS.
5379 ;;;; Staging Buffer Changes
5390 "Regexp matching a sensitive line, structure wise.
5391 A sensitive line is a headline, inlinetask, block, drawer, or
5392 latex-environment boundary. When such a line is modified,
5393 structure changes in the document may propagate in the whole
5397 "Non-nil when a sensitive line is about to be changed.
5401 "Request extension of area going to be modified if needed.
5402 BEG and END are the beginning and end of the range of changed
5403 text. See `before-change-functions' for more information."
5413 'headline
5416 org-element--cache-sensitive-re bottom t)))))))))
5419 "Update buffer modifications for current buffer.
5420 BEG and END are the beginning and end of the range of changed
5421 text, and the length in bytes of the pre-change text replaced by
5422 that range. See `after-change-functions' for more information."
5430 ;; Determine if modified area needs to be extended, according
5431 ;; to both previous and current state. We make a special
5432 ;; case for headline editing: if a headline is modified but
5433 ;; not removed, do not extend.
5442 org-element--cache-sensitive-re bottom t))))
5443 ;; Effectively extend modified area.
5451 ;; Store synchronization request.
5454 ;; Activate a timer to process the request during idle time.
5458 "Return first element to remove from cache.
5460 BEG and END are buffer positions delimiting buffer modifications.
5461 OFFSET is the size of the changes.
5463 Returned element is usually the first element in cache containing
5464 any position between BEG and END. As an exception, greater
5465 elements around the changes that are robust to contents
5466 modifications are preserved and updated according to the
5467 changes."
5477 special-block))
5478 ;; Drawers named "PROPERTIES" are probably
5479 ;; a properties drawer being edited. Force
5480 ;; parsing to check if editing is over.
5489 ;; UP is a robust greater element containing changes.
5490 ;; We only need to extend its ending boundaries.
5496 ;; We're at top level element containing ELEMENT: if it's
5497 ;; altered by buffer modifications, it is first element in
5498 ;; cache to be removed. Otherwise, that first element is the
5499 ;; following one.
5500 ;;
5501 ;; As a special case, do not remove BEFORE if it is a robust
5502 ;; container for current changes.
5504 before)))))
5507 "Submit a new cache synchronization request for current buffer.
5508 BEG and END are buffer positions delimiting the minimal area
5509 where cache data should be removed. OFFSET is the size of the
5510 change, as an integer."
5512 delete-to delete-from)
5517 ;; Current changes can be merged with first sync request: we
5518 ;; can save a partial cache synchronization.
5521 ;; If last change happened within area to be removed, extend
5522 ;; boundaries of robust parents, if any. Otherwise, find
5523 ;; first element to remove and update request accordingly.
5535 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5536 ;; if any, is no longer a 0-phase request, thus ensuring that
5537 ;; phases are properly ordered. We need to provide OFFSET as
5538 ;; optional parameter since current modifications are not known
5539 ;; yet to the otherwise correct part of the cache (i.e, before
5540 ;; the first request).
5547 ;; When changes happen before the first known
5548 ;; element, re-parent and shift the rest of the
5549 ;; cache.
5551 ;; Otherwise, we find the first non robust
5552 ;; element containing END. All elements between
5553 ;; FIRST and this one are to be removed.
5564 element up))
5566 org-element--cache-sync-requests)
5567 ;; No element to remove. No need to re-parent either.
5568 ;; Simply shift additional elements, if any, by OFFSET.
5573 ;;;; Public Functions
5575 ;;;###autoload
5577 "Reset cache in current buffer.
5578 When optional argument ALL is non-nil, reset cache in all Org
5579 buffers."
5597 ;;;###autoload
5599 "Refresh cache at position POS."
5606 \f
5607 ;;; The Toolbox
5608 ;;
5609 ;; The first move is to implement a way to obtain the smallest element
5610 ;; containing point. This is the job of `org-element-at-point'. It
5611 ;; basically jumps back to the beginning of section containing point
5612 ;; and proceed, one element after the other, with
5613 ;; `org-element--current-element' until the container is found. Note:
5614 ;; When using `org-element-at-point', secondary values are never
5615 ;; parsed since the function focuses on elements, not on objects.
5616 ;;
5617 ;; At a deeper level, `org-element-context' lists all elements and
5618 ;; objects containing point.
5619 ;;
5620 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5621 ;; internally by navigation and manipulation tools.
5624 ;;;###autoload
5626 "Determine closest element around point.
5628 Return value is a list like (TYPE PROPS) where TYPE is the type
5629 of the element and PROPS a plist of properties associated to the
5630 element.
5632 Possible types are defined in `org-element-all-elements'.
5633 Properties depend on element or object type, but always include
5634 `:begin', `:end', `:parent' and `:post-blank' properties.
5636 As a special case, if point is at the very beginning of the first
5637 item in a list or sub-list, returned element will be that list
5638 instead of the item. Likewise, if point is at the beginning of
5639 the first row of a table, returned element will be the table
5640 instead of the first row.
5642 When point is at the end of the buffer, return the innermost
5643 element ending there."
5649 ;; Within blank lines at the beginning of buffer, return nil.
5651 ;; Within blank lines right after a headline, return that
5652 ;; headline.
5656 ;; Otherwise parse until we find element containing ORIGIN.
5663 ;;;###autoload
5665 "Return smallest element or object around point.
5667 Return value is a list like (TYPE PROPS) where TYPE is the type
5668 of the element or object and PROPS a plist of properties
5669 associated to it.
5671 Possible types are defined in `org-element-all-elements' and
5672 `org-element-all-objects'. Properties depend on element or
5673 object type, but always include `:begin', `:end', `:parent' and
5674 `:post-blank'.
5676 As a special case, if point is right after an object and not at
5677 the beginning of any other object, return that object.
5679 Optional argument ELEMENT, when non-nil, is the closest element
5680 containing point, as returned by `org-element-at-point'.
5681 Providing it allows for quicker computation."
5687 ;; If point is inside an element containing objects or
5688 ;; a secondary string, narrow buffer to the container and
5689 ;; proceed with parsing. Otherwise, return ELEMENT.
5691 ;; At a parsed affiliated keyword, check if we're inside main
5692 ;; or dual value.
5699 org-element-parsed-keywords))
5708 ;; Also change type to retrieve correct restrictions.
5710 ;; At an item, objects can only be located within tag, if any.
5720 ;; At an headline or inlinetask, objects are in title.
5727 ;; At a paragraph, a table-row or a verse block, objects are
5728 ;; located within their contents.
5732 ;; CBEG is nil for table rules.
5737 ;; At a planning line, if point is at a timestamp, return it,
5738 ;; otherwise, return element.
5746 ;; All other locations cannot contain objects: bail out.
5756 next object-data last)
5760 ;; When entering PARENT for the first time, get list
5761 ;; of objects within known so far. Store it in
5762 ;; OBJECT-DATA.
5767 ;; Find NEXT object for analysis.
5769 ;; If NEXT is non-nil, we already exhausted the
5770 ;; cache so we can parse buffer to find the object
5771 ;; after it.
5773 ;; Otherwise, check if cache can help us.
5784 ;; Cache contains the information needed.
5787 pos)
5789 pos)
5795 ;; If we have a new object to analyze, store it in
5796 ;; cache. Otherwise record that there is nothing
5797 ;; more to parse in this element at this depth.
5802 ;; Process NEXT, if any, in order to know if we need
5803 ;; to skip it, return it or move into it.
5810 ;; Skip objects ending before point. Also skip
5811 ;; objects ending at point unless it is also the
5812 ;; end of buffer, since we want to return the
5813 ;; innermost object.
5816 ;; For convenience, when object ends at POS,
5817 ;; without any space, store it in LAST, as we
5818 ;; will return it if no object starts here.
5822 ;; If POS is within a container object, move
5823 ;; into that object.
5827 ;; At contents' end, if there is no
5828 ;; space before point, also move into
5829 ;; object, for consistency with
5830 ;; convenience feature above.
5839 next nil
5840 object-data nil))
5841 ;; Otherwise, return NEXT.
5843 ;; Store results in cache, if applicable.
5847 "List all ancestors of a given element or object.
5849 BLOB is an object or element.
5851 When optional argument TYPES is a list of symbols, return the
5852 first element or object in the lineage whose type belongs to that
5853 list.
5855 When optional argument WITH-SELF is non-nil, lineage includes
5856 BLOB itself as the first element, and TYPES, if provided, also
5857 apply to it.
5859 When BLOB is obtained through `org-element-context' or
5860 `org-element-at-point', only ancestors from its section can be
5861 found. There is no such limitation when BLOB belongs to a full
5862 parse tree."
5864 ancestors)
5871 "Non-nil when elements ELEM-A and ELEM-B are nested."
5880 "Swap elements ELEM-A and ELEM-B.
5881 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5882 end of ELEM-A."
5884 ;; There are two special cases when an element doesn't start at bol:
5885 ;; the first paragraph in an item or in a footnote definition.
5887 ;; Only a paragraph without any affiliated keyword can be moved at
5888 ;; ELEM-A position in such a situation. Note that the case of
5889 ;; a footnote definition is impossible: it cannot contain two
5890 ;; paragraphs in a row because it cannot contain a blank line.
5896 ;; In a special situation, ELEM-A will have no indentation. We'll
5897 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5911 ;; Store inner overlays responsible for visibility status.
5912 ;; We also need to store their boundaries as they will be
5913 ;; removed from buffer.
5928 ;; Get contents.
5936 ;; Restore ex ELEM-A overlays.
5943 ;; Restore ex ELEM-B overlays.
5949 "Remove maximum common indentation in string S and return it.
5950 When optional argument N is a positive integer, remove exactly
5951 that much characters from indentation, if possible, or return
5952 S as-is otherwise. Unlike to `org-remove-indentation', this
5953 function doesn't call `untabify' on S."
5958 ;; Find maximum common indentation, if not specified.
5966 min-ind)))
5968 ;; Remove exactly N indentation, but give up if not possible.
5981 ;; Local variables:
5982 ;; generated-autoload-file: "org-loaddefs.el"
5983 ;; End:
5985 ;;; org-element.el ends here