| blob | 1e6499c154e4c06afe191e9e282cedadfbdb1830 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
162 ;; Comments, keyword-like or block-like constructs.
163 ;; Blocks and keywords with dual values need to be
164 ;; double-checked.
169 ;; Drawers (any type) and fixed-width areas. Drawers
170 ;; need to be double-checked.
172 ;; Horizontal rules.
174 ;; LaTeX environments.
176 ;; Clock lines.
178 ;; Lists.
185 org-element--object-regexp
189 ;; Sub/superscript.
191 ;; Bold, code, italic, strike-through, underline
192 ;; and verbatim.
196 ;; Plain links.
198 ;; Objects starting with "[": regular link,
199 ;; footnote reference, statistics cookie,
200 ;; timestamp (inactive).
202 ;; Objects starting with "@": export snippets.
203 "@@"
204 ;; Objects starting with "{": macro.
205 "{{{"
206 ;; Objects starting with "<" : timestamp
207 ;; (active, diary), target, radio target and
208 ;; angular links.
210 ;; Objects starting with "$": latex fragment.
212 ;; Objects starting with "\": line break,
213 ;; entity, latex fragment.
215 ;; Objects starting with raw text: inline Babel
216 ;; source block, inline Babel call.
222 ;;;###autoload
224 "Update parser internals."
231 dynamic-block example-block export-block fixed-width
232 footnote-definition headline horizontal-rule inlinetask item
233 keyword latex-environment node-property paragraph plain-list
234 planning property-drawer quote-block section
235 special-block src-block table table-row verse-block)
240 item plain-list property-drawer quote-block section
241 special-block table)
246 inline-src-block italic line-break latex-fragment link macro
247 radio-target statistics-cookie strike-through subscript superscript
248 table-cell target timestamp underline verbatim)
253 superscript table-cell underline)
267 "Alist between block names and the associated parsing function.
268 Names must be uppercase. Any block whose name has no association
274 "List of affiliated keywords as strings.
282 "Alist of usual translations for keywords.
283 The key is the old name and the value the new one. The property
287 "List of affiliated keywords that can occur more than once in an element.
289 Their value will be consed into a list of strings, which will be
290 returned as the value of the property.
292 This list is checked after translations have been applied. See
293 `org-element-keyword-translation-alist'.
299 "List of affiliated keywords whose value can be parsed.
301 Their value will be stored as a secondary string: a list of
302 strings and objects.
304 This list is checked after translations have been applied. See
309 org-element-parsed-keywords)
310 "Alist of parsed keywords and associated properties.
311 This is generated from `org-element-parsed-keywords', which
315 "List of affiliated keywords which can have a secondary value.
317 In Org syntax, they can be written with optional square brackets
318 before the colons. For example, RESULTS keyword can be
319 associated to a hash value with the following:
321 #+RESULTS[hash-string]: some-source
323 This list is checked after translations have been applied. See
329 ;; Dual affiliated keywords.
333 ;; Regular affiliated keywords.
338 org-element-affiliated-keywords)))
340 ;; Export attributes.
342 "Regexp matching any affiliated keyword.
344 Keyword name is put in match group 1. Moreover, if keyword
345 belongs to `org-element-dual-keywords', put the dual value in
346 match group 2.
360 ;; Ignore all links excepted plain links in a link description.
361 ;; Also ignore radio-targets and line breaks.
363 italic latex-fragment macro plain-link statistics-cookie
364 strike-through subscript superscript underline verbatim)
366 ;; Remove any variable object from radio target as it would
367 ;; prevent it from being properly recognized.
369 subscript superscript underline superscript)
373 ;; Ignore inline babel call and inline src block as formulas are
374 ;; possible. Also ignore line breaks and statistics cookies.
376 latex-fragment link macro radio-target strike-through
377 subscript superscript target timestamp underline verbatim)
381 "Alist of objects restrictions.
383 key is an element or object type containing objects and value is
384 a list of types that can be contained within an element or object
385 of such type.
387 For example, in a `radio-target' object, one can only find
388 entities, latex-fragments, subscript, superscript and text
389 markup.
391 This alist also applies to secondary string. For example, an
392 `headline' type element doesn't directly contain objects, but
407 "Table used internally to pair only square brackets.
411 \f
412 ;;; Accessors and Setters
413 ;;
414 ;; Provide four accessors: `org-element-type', `org-element-property'
415 ;; `org-element-contents' and `org-element-restriction'.
416 ;;
417 ;; Setter functions allow to modify elements by side effect. There is
418 ;; `org-element-put-property', `org-element-set-contents'. These
419 ;; low-level functions are useful to build a parse tree.
420 ;;
421 ;; `org-element-adopt-element', `org-element-set-element',
422 ;; `org-element-extract-element' and `org-element-insert-before' are
423 ;; high-level functions useful to modify a parse tree.
424 ;;
425 ;; `org-element-secondary-p' is a predicate used to know if a given
426 ;; object belongs to a secondary string. `org-element-copy' returns
427 ;; an element or object, stripping its parent property in the process.
430 "Return type of ELEMENT.
432 The function returns the type of the element or object provided.
433 It can also return the following special value:
434 `plain-text' for a string
435 `org-data' for a complete document
436 nil in any other case."
442 "Extract the value from the PROPERTY of an ELEMENT."
447 "Extract contents from an ELEMENT."
453 "Return restriction associated to ELEMENT.
454 ELEMENT can be an element, an object or a symbol representing an
455 element or object type."
457 org-element-object-restrictions)))
460 "In ELEMENT set PROPERTY to VALUE.
461 Return modified element."
464 element))
467 "Set ELEMENT contents to CONTENTS."
474 "Non-nil when OBJECT directly belongs to a secondary string.
475 Return value is the property name, as a keyword, or nil."
478 org-element-secondary-value-alist))))
485 "Append elements to the contents of another element.
487 PARENT is an element or object. CHILDREN can be elements,
488 objects, or a strings.
490 The function takes care of setting `:parent' property for CHILD.
491 Return parent element."
493 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
494 ;; string: parent is the list itself.
497 ;; Add CHILDREN at the end of PARENT contents.
500 parent
502 ;; Return modified PARENT element.
506 "Extract ELEMENT from parse tree.
507 Remove element from the parse tree by side-effect, and return it
508 with its `:parent' property stripped out."
513 parent secondary
516 parent
518 ;; Return ELEMENT with its :parent removed.
522 "Insert ELEMENT before LOCATION in parse tree.
523 LOCATION is an element, object or string within the parse tree.
524 Parse tree is modified by side effect."
529 ;; Special case: LOCATION is the first element of an
530 ;; independent secondary string (e.g. :title property). Add
531 ;; ELEMENT in-place.
535 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
545 ;; Store SIBLINGS at appropriate place in parse tree.
550 ;; Set appropriate :parent property.
554 "Replace element or object OLD with element or object NEW.
555 The function takes care of setting `:parent' property for NEW."
556 ;; Ensure OLD and NEW have the same parent.
560 ;; We cannot replace OLD with NEW since one of them is not an
561 ;; object or element. We take the long path.
564 ;; Since OLD is going to be changed into NEW by side-effect, first
565 ;; make sure that every element or object within NEW has OLD as
566 ;; parent.
569 ;; Transfer contents.
571 ;; Overwrite OLD's properties with NEW's.
573 ;; Transfer type.
577 "Create a new element of type TYPE.
578 Optional argument PROPS, when non-nil, is a plist defining the
579 properties of the element. CHILDREN can be elements, objects or
580 strings."
584 "Return a copy of DATUM.
585 DATUM is an element, object, string or nil. `:parent' property
586 is cleared and contents are removed in the process."
597 \f
598 ;;; Greater elements
599 ;;
600 ;; For each greater element type, we define a parser and an
601 ;; interpreter.
602 ;;
603 ;; A parser returns the element or object as the list described above.
604 ;; Most of them accepts no argument. Though, exceptions exist. Hence
605 ;; every element containing a secondary string (see
606 ;; `org-element-secondary-value-alist') will accept an optional
607 ;; argument to toggle parsing of these secondary strings. Moreover,
608 ;; `item' parser requires current list's structure as its first
609 ;; element.
610 ;;
611 ;; An interpreter accepts two arguments: the list representation of
612 ;; the element or object, and its contents. The latter may be nil,
613 ;; depending on the element or object considered. It returns the
614 ;; appropriate Org syntax, as a string.
615 ;;
616 ;; Parsing functions must follow the naming convention:
617 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
618 ;; defined in `org-element-greater-elements'.
619 ;;
620 ;; Similarly, interpreting functions must follow the naming
621 ;; convention: org-element-TYPE-interpreter.
622 ;;
623 ;; With the exception of `headline' and `item' types, greater elements
624 ;; cannot contain other greater elements of their own type.
625 ;;
626 ;; Beside implementing a parser and an interpreter, adding a new
627 ;; greater element requires to tweak `org-element--current-element'.
628 ;; Moreover, the newly defined type must be added to both
629 ;; `org-element-all-elements' and `org-element-greater-elements'.
632 ;;;; Center Block
635 "Parse a center block.
637 LIMIT bounds the search. AFFILIATED is a list of which CAR is
638 the buffer position at the beginning of the first affiliated
639 keyword and CDR is a plist of affiliated keywords along with
640 their value.
642 Return a list whose CAR is `center-block' and CDR is a plist
643 containing `:begin', `:end', `:contents-begin', `:contents-end',
644 `:post-blank' and `:post-affiliated' keywords.
646 Assume point is at the beginning of the block."
650 ;; Incomplete block: parse it as a paragraph.
655 ;; Empty blocks have no contents.
669 :end end
670 :contents-begin contents-begin
671 :contents-end contents-end
677 "Interpret CENTER-BLOCK element as Org syntax.
678 CONTENTS is the contents of the element."
682 ;;;; Drawer
685 "Parse a drawer.
687 LIMIT bounds the search. AFFILIATED is a list of which CAR is
688 the buffer position at the beginning of the first affiliated
689 keyword and CDR is a plist of affiliated keywords along with
690 their value.
692 Return a list whose CAR is `drawer' and CDR is a plist containing
693 `:drawer-name', `:begin', `:end', `:contents-begin',
694 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
696 Assume point is at beginning of drawer."
699 ;; Incomplete drawer: parse it as a paragraph.
707 ;; Empty drawers have no contents.
720 :end end
721 :drawer-name name
722 :contents-begin contents-begin
723 :contents-end contents-end
729 "Interpret DRAWER element as Org syntax.
730 CONTENTS is the contents of the element."
733 contents))
736 ;;;; Dynamic Block
739 "Parse a dynamic block.
741 LIMIT bounds the search. AFFILIATED is a list of which CAR is
742 the buffer position at the beginning of the first affiliated
743 keyword and CDR is a plist of affiliated keywords along with
744 their value.
746 Return a list whose CAR is `dynamic-block' and CDR is a plist
747 containing `:block-name', `:begin', `:end', `:contents-begin',
748 `:contents-end', `:arguments', `:post-blank' and
749 `:post-affiliated' keywords.
751 Assume point is at beginning of dynamic block."
755 ;; Incomplete block: parse it as a paragraph.
764 ;; Empty blocks have no contents.
777 :end end
778 :block-name name
779 :arguments arguments
780 :contents-begin contents-begin
781 :contents-end contents-end
787 "Interpret DYNAMIC-BLOCK element as Org syntax.
788 CONTENTS is the contents of the element."
793 contents))
796 ;;;; Footnote Definition
799 "Parse a footnote definition.
801 LIMIT bounds the search. AFFILIATED is a list of which CAR is
802 the buffer position at the beginning of the first affiliated
803 keyword and CDR is a plist of affiliated keywords along with
804 their value.
806 Return a list whose CAR is `footnote-definition' and CDR is
807 a plist containing `:label', `:begin' `:end', `:contents-begin',
808 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
810 Assume point is at the beginning of the footnote definition."
838 :begin begin
839 :end end
840 :contents-begin contents-begin
841 :contents-end contents-end
847 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
848 CONTENTS is the contents of the footnote-definition."
850 " "
851 contents))
854 ;;;; Headline
857 "Return node properties associated to headline at point.
858 Upcase property names. It avoids confusion between properties
859 obtained through property drawer and default properties from the
860 parser (e.g. `:end' and :END:). Return value is a plist."
872 properties))))
875 "Return time properties associated to headline at point.
876 Return value is a plist."
890 plist))))
893 "Parse a headline.
895 Return a list whose CAR is `headline' and CDR is a plist
896 containing `:raw-value', `:title', `:begin', `:end',
897 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
898 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
899 `:deadline', `:closed', `:archivedp', `:commentedp'
900 `:footnote-section-p', `:post-blank' and `:post-affiliated'
901 keywords.
903 The plist also contains any property set in the property drawer,
904 with its name in upper cases and colons added at the
905 beginning (e.g., `:CUSTOM_ID').
907 LIMIT is a buffer position bounding the search.
909 When RAW-SECONDARY-P is non-nil, headline's title will not be
910 parsed as a secondary string, but as a plain string instead.
912 Assume point is at beginning of the headline."
959 :begin begin
960 :end end
961 :pre-blank
964 :contents-begin contents-begin
965 :contents-end contents-end
966 :level level
967 :priority priority
968 :tags tags
969 :todo-keyword todo
970 :todo-type todo-type
973 end)
974 :footnote-section-p footnote-section-p
975 :archivedp archivedp
976 :commentedp commentedp
978 time-props
979 standard-props))))
981 headline :title
990 nil
996 "Interpret HEADLINE element as Org syntax.
997 CONTENTS is the contents of the element."
1010 ?*)
1014 " "
1017 org-footnote-section
1018 title))))
1020 heading
1021 ;; Align tags.
1029 ?\s)
1030 tags))
1034 tags))))
1036 contents)))
1039 ;;;; Inlinetask
1042 "Parse an inline task.
1044 Return a list whose CAR is `inlinetask' and CDR is a plist
1045 containing `:title', `:begin', `:end', `:contents-begin' and
1046 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1047 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1048 `:closed', `:post-blank' and `:post-affiliated' keywords.
1050 The plist also contains any property set in the property drawer,
1051 with its name in upper cases and colons added at the
1052 beginning (e.g., `:CUSTOM_ID').
1054 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1055 title will not be parsed as a secondary string, but as a plain
1056 string instead.
1058 Assume point is at beginning of the inline task."
1103 :begin begin
1104 :end end
1105 :contents-begin contents-begin
1106 :contents-end contents-end
1107 :level level
1108 :priority priority
1109 :tags tags
1110 :todo-keyword todo
1111 :todo-type todo-type
1114 time-props
1115 standard-props))))
1117 inlinetask :title
1126 nil
1132 "Interpret INLINETASK element as Org syntax.
1133 CONTENTS is the contents of inlinetask."
1147 ;; Align tags.
1155 ? )
1156 tags))
1160 tags))))
1161 ;; Prefer degenerate inlinetasks when there are no
1162 ;; contents.
1165 contents
1169 ;;;; Item
1172 "Parse an item.
1174 STRUCT is the structure of the plain list.
1176 Return a list whose CAR is `item' and CDR is a plist containing
1177 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1178 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1179 `:post-affiliated' keywords.
1181 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1182 any, will not be parsed as a secondary string, but as a plain
1183 string instead.
1185 Assume point is at the beginning of the item."
1208 ;; Ignore tags in un-ordered lists: they are just
1209 ;; a part of item's body.
1216 ;; If first line isn't empty, contents really
1217 ;; start at the text after item's meta-data.
1227 :begin begin
1228 :end end
1229 :contents-begin contents-begin
1230 :contents-end contents-end
1231 :checkbox checkbox
1232 :counter counter
1233 :structure struct
1237 item :tag
1248 "Interpret ITEM element as Org syntax.
1249 CONTENTS is the contents of the element."
1259 ;; Compute indentation.
1264 ;; Indent contents.
1266 bullet
1280 ;;;; Plain List
1283 ;; Return structure of list at point. Internal function. See
1284 ;; `org-list-struct' for details.
1289 items struct)
1294 ;; At limit: end all items.
1303 ;; At list end: end all items.
1308 ;; At a new item: end previous sibling.
1320 ind
1321 bullet
1324 ;; Description tag.
1328 ;; Ending position, unknown so far.
1329 nil)))
1330 items))
1332 ;; Skip empty lines.
1334 ;; Skip inline tasks and blank lines along the way.
1341 ;; At some text line. Check if it ends any previous item.
1354 ;; Skip blocks (any type) and drawers contents.
1359 limit t)))
1365 "Parse a plain list.
1367 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1368 the buffer position at the beginning of the first affiliated
1369 keyword and CDR is a plist of affiliated keywords along with
1370 their value. STRUCTURE is the structure of the plain list being
1371 parsed.
1373 Return a list whose CAR is `plain-list' and CDR is a plist
1374 containing `:type', `:begin', `:end', `:contents-begin' and
1375 `:contents-end', `:structure', `:post-blank' and
1376 `:post-affiliated' keywords.
1378 Assume point is at the beginning of the list."
1392 pos))
1396 ;; Return value.
1400 :begin begin
1401 :end end
1402 :contents-begin contents-begin
1403 :contents-end contents-end
1404 :structure struct
1410 "Interpret PLAIN-LIST element as Org syntax.
1411 CONTENTS is the contents of the element."
1419 ;;;; Property Drawer
1422 "Parse a property drawer.
1424 LIMIT bounds the search.
1426 Return a list whose car is `property-drawer' and cdr is a plist
1427 containing `:begin', `:end', `:contents-begin', `:contents-end',
1428 `:post-blank' and `:post-affiliated' keywords.
1430 Assume point is at the beginning of the property drawer."
1443 :end end
1445 :contents-end contents-end
1450 "Interpret PROPERTY-DRAWER element as Org syntax.
1451 CONTENTS is the properties within the drawer."
1455 ;;;; Quote Block
1458 "Parse a quote block.
1460 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1461 the buffer position at the beginning of the first affiliated
1462 keyword and CDR is a plist of affiliated keywords along with
1463 their value.
1465 Return a list whose CAR is `quote-block' and CDR is a plist
1466 containing `:begin', `:end', `:contents-begin', `:contents-end',
1467 `:post-blank' and `:post-affiliated' keywords.
1469 Assume point is at the beginning of the block."
1473 ;; Incomplete block: parse it as a paragraph.
1479 ;; Empty blocks have no contents.
1492 :end end
1493 :contents-begin contents-begin
1494 :contents-end contents-end
1500 "Interpret QUOTE-BLOCK element as Org syntax.
1501 CONTENTS is the contents of the element."
1505 ;;;; Section
1508 "Parse a section.
1510 LIMIT bounds the search.
1512 Return a list whose CAR is `section' and CDR is a plist
1513 containing `:begin', `:end', `:contents-begin', `contents-end',
1514 `:post-blank' and `:post-affiliated' keywords."
1516 ;; Beginning of section is the beginning of the first non-blank
1517 ;; line after previous headline.
1526 :end end
1527 :contents-begin begin
1528 :contents-end pos-before-blank
1533 "Interpret SECTION element as Org syntax.
1534 CONTENTS is the contents of the element."
1535 contents)
1538 ;;;; Special Block
1541 "Parse a special block.
1543 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1544 the buffer position at the beginning of the first affiliated
1545 keyword and CDR is a plist of affiliated keywords along with
1546 their value.
1548 Return a list whose CAR is `special-block' and CDR is a plist
1549 containing `:type', `:begin', `:end', `:contents-begin',
1550 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1552 Assume point is at the beginning of the block."
1559 limit t)))
1560 ;; Incomplete block: parse it as a paragraph.
1566 ;; Empty blocks have no contents.
1579 :begin begin
1580 :end end
1581 :contents-begin contents-begin
1582 :contents-end contents-end
1588 "Interpret SPECIAL-BLOCK element as Org syntax.
1589 CONTENTS is the contents of the element."
1594 \f
1595 ;;; Elements
1596 ;;
1597 ;; For each element, a parser and an interpreter are also defined.
1598 ;; Both follow the same naming convention used for greater elements.
1599 ;;
1600 ;; Also, as for greater elements, adding a new element type is done
1601 ;; through the following steps: implement a parser and an interpreter,
1602 ;; tweak `org-element--current-element' so that it recognizes the new
1603 ;; type and add that new type to `org-element-all-elements'.
1604 ;;
1605 ;; As a special case, when the newly defined type is a block type,
1606 ;; `org-element-block-name-alist' has to be modified accordingly.
1609 ;;;; Babel Call
1612 "Parse a babel call.
1614 LIMIT bounds the search. AFFILIATED is a list of which car is
1615 the buffer position at the beginning of the first affiliated
1616 keyword and cdr is a plist of affiliated keywords along with
1617 their value.
1619 Return a list whose car is `babel-call' and cdr is a plist
1620 containing `:call', `:inside-header', `:arguments',
1621 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1622 `:post-affiliated' as keywords."
1636 value)))
1646 :begin begin
1647 :end end
1648 :value value
1654 "Interpret BABEL-CALL element as Org syntax.
1655 CONTENTS is nil."
1665 ;;;; Clock
1668 "Parse a clock.
1670 LIMIT bounds the search.
1672 Return a list whose CAR is `clock' and CDR is a plist containing
1673 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1674 `:post-affiliated' as keywords."
1694 :value value
1695 :duration duration
1696 :begin begin
1697 :end end
1698 :post-blank post-blank
1702 "Interpret CLOCK element as Org syntax.
1703 CONTENTS is nil."
1711 "%2s:%02s"
1715 ;;;; Comment
1718 "Parse a comment.
1720 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1721 the buffer position at the beginning of the first affiliated
1722 keyword and CDR is a plist of affiliated keywords along with
1723 their value.
1725 Return a list whose CAR is `comment' and CDR is a plist
1726 containing `:begin', `:end', `:value', `:post-blank',
1727 `:post-affiliated' keywords.
1729 Assume point is at comment beginning."
1738 ;; Get comments ending.
1741 ;; Accumulate lines without leading hash and first
1742 ;; whitespace.
1756 :end end
1757 :value value
1763 "Interpret COMMENT element as Org syntax.
1764 CONTENTS is nil."
1768 ;;;; Comment Block
1771 "Parse an export block.
1773 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1774 the buffer position at the beginning of the first affiliated
1775 keyword and CDR is a plist of affiliated keywords along with
1776 their value.
1778 Return a list whose CAR is `comment-block' and CDR is a plist
1779 containing `:begin', `:end', `:value', `:post-blank' and
1780 `:post-affiliated' keywords.
1782 Assume point is at comment block beginning."
1786 ;; Incomplete block: parse it as a paragraph.
1799 contents-begin contents-end)))
1803 :end end
1804 :value value
1810 "Interpret COMMENT-BLOCK element as Org syntax.
1811 CONTENTS is nil."
1818 ;;;; Diary Sexp
1821 "Parse a diary sexp.
1823 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1824 the buffer position at the beginning of the first affiliated
1825 keyword and CDR is a plist of affiliated keywords along with
1826 their value.
1828 Return a list whose CAR is `diary-sexp' and CDR is a plist
1829 containing `:begin', `:end', `:value', `:post-blank' and
1830 `:post-affiliated' keywords."
1842 :begin begin
1843 :end end
1849 "Interpret DIARY-SEXP as Org syntax.
1850 CONTENTS is nil."
1854 ;;;; Example Block
1857 "Parse an example block.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1862 their value.
1864 Return a list whose CAR is `example-block' and CDR is a plist
1865 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1866 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1867 `:value', `:post-blank' and `:post-affiliated' keywords."
1871 ;; Incomplete block: parse it as a paragraph.
1879 ;; Switches analysis
1886 ;; Should labels be retained in (or stripped from) example
1887 ;; blocks?
1892 ;; What should code-references use - labels or
1893 ;; line-numbers?
1902 ;; Standard block parsing.
1910 contents-begin contents-end))
1911 block-ind))
1920 :end end
1921 :value value
1922 :switches switches
1923 :number-lines number-lines
1924 :preserve-indent preserve-indent
1925 :retain-labels retain-labels
1926 :use-labels use-labels
1927 :label-fmt label-fmt
1933 "Interpret EXAMPLE-BLOCK element as Org syntax.
1934 CONTENTS is nil."
1942 value
1947 ;;;; Export Block
1950 "Parse an export block.
1952 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1953 the buffer position at the beginning of the first affiliated
1954 keyword and CDR is a plist of affiliated keywords along with
1955 their value.
1957 Return a list whose CAR is `export-block' and CDR is a plist
1958 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1959 `:post-affiliated' keywords.
1961 Assume point is at export-block beginning."
1968 ;; Incomplete block: parse it as a paragraph.
1981 contents-end)))
1985 :end end
1986 :type type
1987 :value value
1993 "Interpret EXPORT-BLOCK element as Org syntax.
1994 CONTENTS is nil."
2001 ;;;; Fixed-width
2004 "Parse a fixed-width section.
2006 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2007 the buffer position at the beginning of the first affiliated
2008 keyword and CDR is a plist of affiliated keywords along with
2009 their value.
2011 Return a list whose CAR is `fixed-width' and CDR is a plist
2012 containing `:begin', `:end', `:value', `:post-blank' and
2013 `:post-affiliated' keywords.
2015 Assume point is at the beginning of the fixed-width area."
2019 value
2024 ;; Accumulate text without starting colons.
2037 :end end
2038 :value value
2044 "Interpret FIXED-WIDTH element as Org syntax.
2045 CONTENTS is nil."
2053 ;;;; Horizontal Rule
2056 "Parse an horizontal rule.
2058 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2059 the buffer position at the beginning of the first affiliated
2060 keyword and CDR is a plist of affiliated keywords along with
2061 their value.
2063 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2064 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2065 keywords."
2075 :end end
2081 "Interpret HORIZONTAL-RULE element as Org syntax.
2082 CONTENTS is nil."
2086 ;;;; Keyword
2089 "Parse a keyword at point.
2091 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2092 the buffer position at the beginning of the first affiliated
2093 keyword and CDR is a plist of affiliated keywords along with
2094 their value.
2096 Return a list whose CAR is `keyword' and CDR is a plist
2097 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2098 `:post-affiliated' keywords."
2100 ;; An orphaned affiliated keyword is considered as a regular
2101 ;; keyword. In this case AFFILIATED is nil, so we take care of
2102 ;; this corner case.
2115 :value value
2116 :begin begin
2117 :end end
2123 "Interpret KEYWORD element as Org syntax.
2124 CONTENTS is nil."
2130 ;;;; Latex Environment
2134 "Regexp matching the beginning of a LaTeX environment.
2135 The environment is captured by the first group.
2141 "Format string matching the ending of a LaTeX environment.
2145 "Parse a LaTeX environment.
2147 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2148 the buffer position at the beginning of the first affiliated
2149 keyword and CDR is a plist of affiliated keywords along with
2150 their value.
2152 Return a list whose CAR is `latex-environment' and CDR is a plist
2153 containing `:begin', `:end', `:value', `:post-blank' and
2154 `:post-affiliated' keywords.
2156 Assume point is at the beginning of the latex environment."
2163 limit t))
2164 ;; Incomplete latex environment: parse it as a paragraph.
2174 :end end
2175 :value value
2181 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2182 CONTENTS is nil."
2186 ;;;; Node Property
2189 "Parse a node-property at point.
2191 LIMIT bounds the search.
2193 Return a list whose CAR is `node-property' and CDR is a plist
2194 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2195 `:post-affiliated' keywords."
2205 limit))))
2208 :value value
2209 :begin begin
2210 :end end
2215 "Interpret NODE-PROPERTY element as Org syntax.
2216 CONTENTS is nil."
2222 ;;;; Paragraph
2225 "Parse a paragraph.
2227 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2228 the buffer position at the beginning of the first affiliated
2229 keyword and CDR is a plist of affiliated keywords along with
2230 their value.
2232 Return a list whose CAR is `paragraph' and CDR is a plist
2233 containing `:begin', `:end', `:contents-begin' and
2234 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2236 Assume point is at the beginning of the paragraph."
2243 ;; A matching `org-element-paragraph-separate' is not
2244 ;; necessarily the end of the paragraph. In particular,
2245 ;; drawers, blocks or LaTeX environments opening lines
2246 ;; must be closed. Moreover keywords with a secondary
2247 ;; value must belong to "dual keywords".
2261 limit t)))
2267 limit t)))
2270 org-element-dual-keywords))
2271 ;; Everything else is unambiguous.
2284 :end end
2285 :contents-begin contents-begin
2286 :contents-end contents-end
2292 "Interpret PARAGRAPH element as Org syntax.
2293 CONTENTS is the contents of the element."
2294 contents)
2297 ;;;; Planning
2300 "Parse a planning.
2302 LIMIT bounds the search.
2304 Return a list whose CAR is `planning' and CDR is a plist
2305 containing `:closed', `:deadline', `:scheduled', `:begin',
2306 `:end', `:post-blank' and `:post-affiliated' keywords."
2316 closed deadline scheduled)
2328 :deadline deadline
2329 :scheduled scheduled
2330 :begin begin
2331 :end end
2332 :post-blank post-blank
2336 "Interpret PLANNING element as Org syntax.
2337 CONTENTS is nil."
2339 'identity
2356 ;;;; Src Block
2359 "Parse a src block.
2361 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2362 the buffer position at the beginning of the first affiliated
2363 keyword and CDR is a plist of affiliated keywords along with
2364 their value.
2366 Return a list whose CAR is `src-block' and CDR is a plist
2367 containing `:language', `:switches', `:parameters', `:begin',
2368 `:end', `:number-lines', `:retain-labels', `:use-labels',
2369 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2370 `:post-affiliated' keywords.
2372 Assume point is at the beginning of the block."
2375 limit t)))
2376 ;; Incomplete block: parse it as a paragraph.
2382 ;; Get language as a string.
2391 ;; Get switches.
2393 ;; Get parameters.
2395 ;; Switches analysis
2406 ;; Should labels be retained in (or stripped from)
2407 ;; src blocks?
2412 ;; What should code-references use - labels or
2413 ;; line-numbers?
2418 ;; Indentation.
2420 ;; Retrieve code.
2425 block-ind))
2429 ;; Get position after ending blank lines.
2439 :begin begin
2440 :end end
2441 :number-lines number-lines
2442 :preserve-indent preserve-indent
2443 :retain-labels retain-labels
2444 :use-labels use-labels
2445 :label-fmt label-fmt
2446 :value value
2452 "Interpret SRC-BLOCK element as Org syntax.
2453 CONTENTS is nil."
2462 val)
2476 ;;;; Table
2479 "Parse a table at point.
2481 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2482 the buffer position at the beginning of the first affiliated
2483 keyword and CDR is a plist of affiliated keywords along with
2484 their value.
2486 Return a list whose CAR is `table' and CDR is a plist containing
2487 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2488 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2489 keywords.
2491 Assume point is at the beginning of the table."
2507 acc))
2514 :end end
2515 :type type
2516 :tblfm tblfm
2517 ;; Only `org' tables have contents. `table.el' tables
2518 ;; use a `:value' property to store raw table as
2519 ;; a string.
2524 table-begin table-end))
2530 "Interpret TABLE element as Org syntax.
2531 CONTENTS is a string, if table's type is `org', or nil."
2542 ;;;; Table Row
2545 "Parse table row at point.
2547 LIMIT bounds the search.
2549 Return a list whose CAR is `table-row' and CDR is a plist
2550 containing `:begin', `:end', `:contents-begin', `:contents-end',
2551 `:type', `:post-blank' and `:post-affiliated' keywords."
2555 ;; A table rule has no contents. In that case, ensure
2556 ;; CONTENTS-BEGIN matches CONTENTS-END.
2568 :begin begin
2569 :end end
2570 :contents-begin contents-begin
2571 :contents-end contents-end
2576 "Interpret TABLE-ROW element as Org syntax.
2577 CONTENTS is the contents of the table row."
2582 ;;;; Verse Block
2585 "Parse a verse block.
2587 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2588 the buffer position at the beginning of the first affiliated
2589 keyword and CDR is a plist of affiliated keywords along with
2590 their value.
2592 Return a list whose CAR is `verse-block' and CDR is a plist
2593 containing `:begin', `:end', `:contents-begin', `:contents-end',
2594 `:post-blank' and `:post-affiliated' keywords.
2596 Assume point is at beginning of the block."
2600 ;; Incomplete block: parse it as a paragraph.
2615 :end end
2616 :contents-begin contents-begin
2617 :contents-end contents-end
2623 "Interpret VERSE-BLOCK element as Org syntax.
2624 CONTENTS is verse block contents."
2628 \f
2629 ;;; Objects
2630 ;;
2631 ;; Unlike to elements, raw text can be found between objects. Hence,
2632 ;; `org-element--object-lex' is provided to find the next object in
2633 ;; buffer.
2634 ;;
2635 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2636 ;; object types they can contain will be specified in
2637 ;; `org-element-object-restrictions'.
2638 ;;
2639 ;; Creating a new type of object requires to alter
2640 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2641 ;; new type in `org-element-all-objects', and possibly add
2642 ;; restrictions in `org-element-object-restrictions'.
2644 ;;;; Bold
2647 "Parse bold object at point, if any.
2649 When at a bold object, return a list whose car is `bold' and cdr
2650 is a plist with `:begin', `:end', `:contents-begin' and
2651 `:contents-end' and `:post-blank' keywords. Otherwise, return
2652 nil.
2654 Assume point is at the first star marker."
2666 :end end
2667 :contents-begin contents-begin
2668 :contents-end contents-end
2672 "Interpret BOLD object as Org syntax.
2673 CONTENTS is the contents of the object."
2677 ;;;; Code
2680 "Parse code object at point, if any.
2682 When at a code object, return a list whose car is `code' and cdr
2683 is a plist with `:value', `:begin', `:end' and `:post-blank'
2684 keywords. Otherwise, return nil.
2686 Assume point is at the first tilde marker."
2697 :begin begin
2698 :end end
2702 "Interpret CODE object as Org syntax.
2703 CONTENTS is nil."
2707 ;;;; Entity
2710 "Parse entity at point, if any.
2712 When at an entity, return a list whose car is `entity' and cdr
2713 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2714 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2715 `:post-blank' as keywords. Otherwise, return nil.
2717 Assume point is at the beginning of the entity."
2719 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2737 :begin begin
2738 :end end
2739 :use-brackets-p bracketsp
2743 "Interpret ENTITY object as Org syntax.
2744 CONTENTS is nil."
2750 ;;;; Export Snippet
2753 "Parse export snippet at point.
2755 When at an export snippet, return a list whose car is
2756 `export-snippet' and cdr a plist with `:begin', `:end',
2757 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2758 return nil.
2760 Assume point is at the beginning of the snippet."
2776 :value value
2777 :begin begin
2778 :end end
2782 "Interpret EXPORT-SNIPPET object as Org syntax.
2783 CONTENTS is nil."
2789 ;;;; Footnote Reference
2792 "Parse footnote reference at point, if any.
2794 When at a footnote reference, return a list whose car is
2795 `footnote-reference' and cdr a plist with `:label', `:type',
2796 `:begin', `:end', `:content-begin', `:contents-end' and
2797 `:post-blank' as keywords. Otherwise, return nil."
2817 :type type
2818 :begin begin
2819 :end end
2825 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2826 CONTENTS is its definition, when inline, or nil."
2832 ;;;; Inline Babel Call
2835 "Parse inline babel call at point, if any.
2837 When at an inline babel call, return a list whose car is
2838 `inline-babel-call' and cdr a plist with `:call',
2839 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2840 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2842 Assume point is at the beginning of the babel call."
2858 :inside-header inside-header
2859 :arguments arguments
2860 :end-header end-header
2861 :begin begin
2862 :end end
2863 :value value
2867 "Interpret INLINE-BABEL-CALL object as Org syntax.
2868 CONTENTS is nil."
2878 ;;;; Inline Src Block
2881 "Parse inline source block at point, if any.
2883 When at an inline source block, return a list whose car is
2884 `inline-src-block' and cdr a plist with `:begin', `:end',
2885 `:language', `:value', `:parameters' and `:post-blank' as
2886 keywords. Otherwise, return nil.
2888 Assume point is at the beginning of the inline src block."
2901 :value value
2902 :parameters parameters
2903 :begin begin
2904 :end end
2908 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2909 CONTENTS is nil."
2914 language
2916 body)))
2918 ;;;; Italic
2921 "Parse italic object at point, if any.
2923 When at an italic object, return a list whose car is `italic' and
2924 cdr is a plist with `:begin', `:end', `:contents-begin' and
2925 `:contents-end' and `:post-blank' keywords. Otherwise, return
2926 nil.
2928 Assume point is at the first slash marker."
2940 :end end
2941 :contents-begin contents-begin
2942 :contents-end contents-end
2946 "Interpret ITALIC object as Org syntax.
2947 CONTENTS is the contents of the object."
2951 ;;;; Latex Fragment
2954 "Parse LaTeX fragment at point, if any.
2956 When at a LaTeX fragment, return a list whose car is
2957 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2958 and `:post-blank' as keywords. Otherwise, return nil.
2960 Assume point is at the beginning of the LaTeX fragment."
2978 ;; Macro.
2987 :begin begin
2988 :end end
2992 "Interpret LATEX-FRAGMENT object as Org syntax.
2993 CONTENTS is nil."
2996 ;;;; Line Break
2999 "Parse line break at point, if any.
3001 When at a line break, return a list whose car is `line-break',
3002 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3003 Otherwise, return nil.
3005 Assume point is at the beginning of the line break."
3014 "Interpret LINE-BREAK object as Org syntax.
3015 CONTENTS is nil."
3019 ;;;; Link
3022 "Parse link at point, if any.
3024 When at a link, return a list whose car is `link' and cdr a plist
3025 with `:type', `:path', `:raw-link', `:application',
3026 `:search-option', `:begin', `:end', `:contents-begin',
3027 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3028 nil.
3030 Assume point is at the beginning of the link."
3033 end contents-begin contents-end link-end post-blank path type
3034 raw-link link search-option application)
3036 ;; Type 1: Text targeted from a radio target.
3045 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3050 ;; RAW-LINK is the original link. Expand any
3051 ;; abbreviation in it.
3055 ;; Determine TYPE of link and set PATH accordingly.
3057 ;; File type.
3061 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3064 ;; According to RFC 3986, extra whitespace should be
3065 ;; ignored when a URI is extracted.
3068 ;; Id type: PATH is the id.
3071 ;; Code-ref type: PATH is the name of the reference.
3074 ;; Custom-id type: PATH is the name of the custom id.
3077 ;; Fuzzy type: Internal link either matches a target, an
3078 ;; headline name or nothing. PATH is the target or
3079 ;; headline's name.
3081 ;; Type 3: Plain link, e.g., http://orgmode.org
3087 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3095 ;; In any case, deduce end point after trailing white space from
3096 ;; LINK-END variable.
3100 ;; Special "file" type link processing. Extract opening
3101 ;; application and search option, if any. Also normalize URI.
3110 :path path
3112 :application application
3113 :search-option search-option
3114 :begin begin
3115 :end end
3116 :contents-begin contents-begin
3117 :contents-end contents-end
3121 "Interpret LINK object as Org syntax.
3122 CONTENTS is the contents of the object, or nil."
3127 raw-link
3131 ;;;; Macro
3134 "Parse macro at point, if any.
3136 When at a macro, return a list whose car is `macro' and cdr
3137 a plist with `:key', `:args', `:begin', `:end', `:value' and
3138 `:post-blank' as keywords. Otherwise, return nil.
3140 Assume point is at the macro."
3153 :value value
3154 :args args
3155 :begin begin
3156 :end end
3160 "Interpret MACRO object as Org syntax.
3161 CONTENTS is nil."
3165 ;;;; Radio-target
3168 "Parse radio target at point, if any.
3170 When at a radio target, return a list whose car is `radio-target'
3171 and cdr a plist with `:begin', `:end', `:contents-begin',
3172 `:contents-end', `:value' and `:post-blank' as keywords.
3173 Otherwise, return nil.
3175 Assume point is at the radio target."
3187 :end end
3188 :contents-begin contents-begin
3189 :contents-end contents-end
3190 :post-blank post-blank
3194 "Interpret TARGET object as Org syntax.
3195 CONTENTS is the contents of the object."
3199 ;;;; Statistics Cookie
3202 "Parse statistics cookie at point, if any.
3204 When at a statistics cookie, return a list whose car is
3205 `statistics-cookie', and cdr a plist with `:begin', `:end',
3206 `:value' and `:post-blank' keywords. Otherwise, return nil.
3208 Assume point is at the beginning of the statistics-cookie."
3219 :end end
3220 :value value
3224 "Interpret STATISTICS-COOKIE object as Org syntax.
3225 CONTENTS is nil."
3229 ;;;; Strike-Through
3232 "Parse strike-through object at point, if any.
3234 When at a strike-through object, return a list whose car is
3235 `strike-through' and cdr is a plist with `:begin', `:end',
3236 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3237 Otherwise, return nil.
3239 Assume point is at the first plus sign marker."
3251 :end end
3252 :contents-begin contents-begin
3253 :contents-end contents-end
3257 "Interpret STRIKE-THROUGH object as Org syntax.
3258 CONTENTS is the contents of the object."
3262 ;;;; Subscript
3265 "Parse subscript at point, if any.
3267 When at a subscript object, return a list whose car is
3268 `subscript' and cdr a plist with `:begin', `:end',
3269 `:contents-begin', `:contents-end', `:use-brackets-p' and
3270 `:post-blank' as keywords. Otherwise, return nil.
3272 Assume point is at the underscore."
3286 :end end
3287 :use-brackets-p bracketsp
3288 :contents-begin contents-begin
3289 :contents-end contents-end
3293 "Interpret SUBSCRIPT object as Org syntax.
3294 CONTENTS is the contents of the object."
3297 contents))
3300 ;;;; Superscript
3303 "Parse superscript at point, if any.
3305 When at a superscript object, return a list whose car is
3306 `superscript' and cdr a plist with `:begin', `:end',
3307 `:contents-begin', `:contents-end', `:use-brackets-p' and
3308 `:post-blank' as keywords. Otherwise, return nil.
3310 Assume point is at the caret."
3324 :end end
3325 :use-brackets-p bracketsp
3326 :contents-begin contents-begin
3327 :contents-end contents-end
3331 "Interpret SUPERSCRIPT object as Org syntax.
3332 CONTENTS is the contents of the object."
3335 contents))
3338 ;;;; Table Cell
3341 "Parse table cell at point.
3342 Return a list whose car is `table-cell' and cdr is a plist
3343 containing `:begin', `:end', `:contents-begin', `:contents-end'
3344 and `:post-blank' keywords."
3352 :end end
3353 :contents-begin contents-begin
3354 :contents-end contents-end
3358 "Interpret TABLE-CELL element as Org syntax.
3359 CONTENTS is the contents of the cell, or nil."
3363 ;;;; Target
3366 "Parse target at point, if any.
3368 When at a target, return a list whose car is `target' and cdr
3369 a plist with `:begin', `:end', `:value' and `:post-blank' as
3370 keywords. Otherwise, return nil.
3372 Assume point is at the target."
3382 :end end
3383 :value value
3387 "Interpret TARGET object as Org syntax.
3388 CONTENTS is nil."
3392 ;;;; Timestamp
3403 "Parse time stamp at point, if any.
3405 When at a time stamp, return a list whose car is `timestamp', and
3406 cdr a plist with `:type', `:raw-value', `:year-start',
3407 `:month-start', `:day-start', `:hour-start', `:minute-start',
3408 `:year-end', `:month-end', `:day-end', `:hour-end',
3409 `:minute-end', `:repeater-type', `:repeater-value',
3410 `:repeater-unit', `:warning-type', `:warning-value',
3411 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3412 Otherwise, return nil.
3414 Assume point is at the beginning of the timestamp."
3433 date-start)
3444 raw-value)
3446 :repeater-type
3452 :repeater-unit
3461 :warning-unit
3464 year-start month-start day-start hour-start minute-start year-end
3465 month-end day-end hour-end minute-end)
3466 ;; Parse date-start.
3474 ;; Compute date-end. It can be provided directly in time-stamp,
3475 ;; or extracted from time range. Otherwise, it defaults to the
3476 ;; same values as date-start.
3486 :raw-value raw-value
3487 :year-start year-start
3488 :month-start month-start
3489 :day-start day-start
3490 :hour-start hour-start
3491 :minute-start minute-start
3492 :year-end year-end
3493 :month-end month-end
3494 :day-end day-end
3495 :hour-end hour-end
3496 :minute-end minute-end
3497 :begin begin
3498 :end end
3500 repeater-props
3501 warning-props))))))
3504 "Interpret TIMESTAMP object as Org syntax.
3505 CONTENTS is nil."
3524 ;; Build an Org timestamp string from TIME. ACTIVEP is
3525 ;; non-nil when time stamp is active. If WITH-TIME-P is
3526 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3527 ;; specify a time range in the timestamp. REPEAT-STRING is
3528 ;; the repeater string, if any.
3532 org-time-stamp-formats)
3533 time)))
3539 nil nil ts)))
3544 " "
3545 s
3547 ;; Return value.
3548 ts)))
3560 build-ts-string
3579 0
3587 "--"
3600 ;;;; Underline
3603 "Parse underline object at point, if any.
3605 When at an underline object, return a list whose car is
3606 `underline' and cdr is a plist with `:begin', `:end',
3607 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3608 Otherwise, return nil.
3610 Assume point is at the first underscore marker."
3622 :end end
3623 :contents-begin contents-begin
3624 :contents-end contents-end
3628 "Interpret UNDERLINE object as Org syntax.
3629 CONTENTS is the contents of the object."
3633 ;;;; Verbatim
3636 "Parse verbatim object at point, if any.
3638 When at a verbatim object, return a list whose car is `verbatim'
3639 and cdr is a plist with `:value', `:begin', `:end' and
3640 `:post-blank' keywords. Otherwise, return nil.
3642 Assume point is at the first equal sign marker."
3653 :begin begin
3654 :end end
3658 "Interpret VERBATIM object as Org syntax.
3659 CONTENTS is nil."
3663 \f
3664 ;;; Parsing Element Starting At Point
3665 ;;
3666 ;; `org-element--current-element' is the core function of this section.
3667 ;; It returns the Lisp representation of the element starting at
3668 ;; point.
3669 ;;
3670 ;; `org-element--current-element' makes use of special modes. They
3671 ;; are activated for fixed element chaining (e.g., `plain-list' >
3672 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3673 ;; `section'). Special modes are: `first-section', `item',
3674 ;; `node-property', `section' and `table-row'.
3677 "Parse the element starting at point.
3679 Return value is a list like (TYPE PROPS) where TYPE is the type
3680 of the element and PROPS a plist of properties associated to the
3681 element.
3683 Possible types are defined in `org-element-all-elements'.
3685 LIMIT bounds the search.
3687 Optional argument GRANULARITY determines the depth of the
3688 recursion. Allowed values are `headline', `greater-element',
3689 `element', `object' or nil. When it is broader than `object' (or
3690 nil), secondary values will not be parsed, since they only
3691 contain objects.
3693 Optional argument MODE, when non-nil, can be either
3694 `first-section', `section', `planning', `item', `node-property'
3695 and `table-row'.
3697 If STRUCTURE isn't provided but MODE is set to `item', it will be
3698 computed.
3700 This function assumes point is always at the beginning of the
3701 element it has to parse."
3704 ;; Determine if parsing depth allows for secondary strings
3705 ;; parsing. It only applies to elements referenced in
3706 ;; `org-element-secondary-value-alist'.
3709 ;; Item.
3712 ;; Table Row.
3714 ;; Node Property.
3716 ;; Headline.
3719 ;; Sections (must be checked after headline).
3724 limit)))
3725 ;; Planning.
3728 ;; Property drawer.
3732 ;; When not at bol, point is at the beginning of an item or
3733 ;; a footnote definition: next item is always a paragraph.
3735 ;; Clock.
3737 ;; Inlinetask.
3740 ;; From there, elements can have affiliated keywords.
3743 ;; Jumping over affiliated keywords put point off-limits.
3744 ;; Parse them as regular keywords.
3748 ;; LaTeX Environment.
3751 ;; Drawer and Property Drawer.
3754 ;; Fixed Width
3757 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3758 ;; Keywords.
3767 org-element-block-name-alist)))
3782 ;; Footnote Definition.
3785 ;; Horizontal Rule.
3788 ;; Diary Sexp.
3791 ;; Table.
3794 ;; List.
3797 limit affiliated
3799 ;; Default element: Paragraph.
3803 ;; Most elements can have affiliated keywords. When looking for an
3804 ;; element beginning, we want to move before them, as they belong to
3805 ;; that element, and, in the meantime, collect information they give
3806 ;; into appropriate properties. Hence the following function.
3809 "Collect affiliated keywords from point down to LIMIT.
3811 Return a list whose CAR is the position at the first of them and
3812 CDR a plist of keywords and values and move point to the
3813 beginning of the first line after them.
3815 As a special case, if element doesn't start at the beginning of
3816 the line (e.g., a paragraph starting an item), CAR is current
3817 position of point and CDR is nil."
3821 ;; RESTRICT is the list of objects allowed in parsed
3822 ;; keywords value.
3824 output)
3827 ;; Apply translation to RAW-KWD. From there, KWD is
3828 ;; the official keyword.
3830 org-element-keyword-translation-alist))
3831 raw-kwd))
3832 ;; Find main value for any keyword.
3838 ;; PARSEDP is non-nil when keyword should have its
3839 ;; value parsed.
3841 ;; If KWD is a dual keyword, find its secondary
3842 ;; value. Maybe parse it.
3850 ;; Attribute a property name to KWD.
3852 ;; Now set final shape for VALUE.
3858 nil restrict)))
3862 ;; Attributes can always appear on multiple lines.
3865 ;; Eventually store the new value in OUTPUT.
3867 ;; Move to next keyword.
3869 ;; If affiliated keywords are orphaned: move back to first one.
3870 ;; They will be parsed as a paragraph.
3872 ;; Return value.
3876 \f
3877 ;;; The Org Parser
3878 ;;
3879 ;; The two major functions here are `org-element-parse-buffer', which
3880 ;; parses Org syntax inside the current buffer, taking into account
3881 ;; region, narrowing, or even visibility if specified, and
3882 ;; `org-element-parse-secondary-string', which parses objects within
3883 ;; a given string.
3884 ;;
3885 ;; The (almost) almighty `org-element-map' allows to apply a function
3886 ;; on elements or objects matching some type, and accumulate the
3887 ;; resulting values. In an export situation, it also skips unneeded
3888 ;; parts of the parse tree.
3891 "Recursively parse the buffer and return structure.
3892 If narrowing is in effect, only parse the visible part of the
3893 buffer.
3895 Optional argument GRANULARITY determines the depth of the
3896 recursion. It can be set to the following symbols:
3898 `headline' Only parse headlines.
3899 `greater-element' Don't recurse into greater elements excepted
3900 headlines and sections. Thus, elements
3901 parsed are the top-level ones.
3902 `element' Parse everything but objects and plain text.
3903 `object' Parse the complete buffer (default).
3905 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3906 elements.
3908 An element or an objects is represented as a list with the
3909 pattern (TYPE PROPERTIES CONTENTS), where :
3911 TYPE is a symbol describing the element or object. See
3912 `org-element-all-elements' and `org-element-all-objects' for an
3913 exhaustive list of such symbols. One can retrieve it with
3914 `org-element-type' function.
3916 PROPERTIES is the list of attributes attached to the element or
3917 object, as a plist. Although most of them are specific to the
3918 element or object type, all types share `:begin', `:end',
3919 `:post-blank' and `:parent' properties, which respectively
3920 refer to buffer position where the element or object starts,
3921 ends, the number of white spaces or blank lines after it, and
3922 the element or object containing it. Properties values can be
3923 obtained by using `org-element-property' function.
3925 CONTENTS is a list of elements, objects or raw strings
3926 contained in the current element or object, when applicable.
3927 One can access them with `org-element-contents' function.
3929 The Org buffer has `org-data' as type and nil as properties.
3930 `org-element-map' function can be used to find specific elements
3931 or objects within the parse tree.
3933 This function assumes that current major mode is `org-mode'."
3939 ;; Start in `first-section' mode so text before the first
3940 ;; headline belongs to a section.
3944 "Recursively parse objects in STRING and return structure.
3946 RESTRICTION is a symbol limiting the object types that will be
3947 looked after.
3949 Optional argument PARENT, when non-nil, is the element or object
3950 containing the secondary string. It is used to set correctly
3951 `:parent' property within the string.
3953 If STRING is the empty string or nil, return nil."
3969 data))))))
3973 "Map a function on selected elements or objects.
3975 DATA is a parse tree, an element, an object, a string, or a list
3976 of such constructs. TYPES is a symbol or list of symbols of
3977 elements or objects types (see `org-element-all-elements' and
3978 `org-element-all-objects' for a complete list of types). FUN is
3979 the function called on the matching element or object. It has to
3980 accept one argument: the element or object itself.
3982 When optional argument INFO is non-nil, it should be a plist
3983 holding export options. In that case, parts of the parse tree
3984 not exportable according to that property list will be skipped.
3986 When optional argument FIRST-MATCH is non-nil, stop at the first
3987 match for which FUN doesn't return nil, and return that value.
3989 Optional argument NO-RECURSION is a symbol or a list of symbols
3990 representing elements or objects types. `org-element-map' won't
3991 enter any recursive element or object whose type belongs to that
3992 list. Though, FUN can still be applied on them.
3994 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3995 apply to matching objects within parsed affiliated keywords (see
3996 `org-element-parsed-keywords').
3998 Nil values returned from FUN do not appear in the results.
4001 Examples:
4002 ---------
4004 Assuming TREE is a variable containing an Org buffer parse tree,
4005 the following example will return a flat list of all `src-block'
4006 and `example-block' elements in it:
4008 \(org-element-map tree '(example-block src-block) #'identity)
4010 The following snippet will find the first headline with a level
4013 \(org-element-map tree 'headline
4014 \(lambda (hl)
4015 \(and (= (org-element-property :level hl) 1)
4017 \(org-element-property :begin hl)))
4018 nil t)
4020 The next example will return a flat list of all `plain-list' type
4021 elements in TREE that are not a sub-list themselves:
4023 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4025 Eventually, this example will return a flat list of all `bold'
4026 type objects containing a `latex-snippet' type object, even
4027 looking into captions:
4029 \(org-element-map tree 'bold
4030 \(lambda (b)
4031 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4032 nil nil nil t)"
4033 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4037 ;; Recursion depth is determined by --CATEGORY.
4044 ;; If one object is found, the function has to
4045 ;; recurse into every object.
4048 ;; If one regular element is found, the
4049 ;; function has to recurse, at least, into
4050 ;; every element it encounters.
4053 --acc
4054 --walk-tree
4057 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4058 ;; holding contextual information.
4062 ;; Ignored element in an export context.
4064 ;; List of elements or objects.
4066 ;; Unconditionally enter parse trees.
4070 ;; Check if TYPE is matching among TYPES. If so,
4071 ;; apply FUN to --DATA and accumulate return value
4072 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4078 ;; If --DATA has a secondary string that can contain
4079 ;; objects with their type among TYPES, look into it.
4082 org-element-secondary-value-alist)))
4084 ;; If --DATA has any parsed affiliated keywords and
4085 ;; WITH-AFFILIATED is non-nil, look for objects in
4086 ;; them.
4093 ;; Pay attention to the type of parsed keyword.
4094 ;; In particular, preserve order for multiple
4095 ;; keywords.
4108 ;; Determine if a recursion into --DATA is possible.
4110 ;; --TYPE is explicitly removed from recursion.
4112 ;; --DATA has no contents.
4114 ;; Looking for greater elements but --DATA is simply
4115 ;; an element or an object.
4118 ;; Looking for elements but --DATA is an object.
4121 ;; In any other case, map contents.
4125 ;; Return value in a proper order.
4129 ;; The following functions are internal parts of the parser.
4130 ;;
4131 ;; The first one, `org-element--parse-elements' acts at the element's
4132 ;; level.
4133 ;;
4134 ;; The second one, `org-element--parse-objects' applies on all objects
4135 ;; of a paragraph or a secondary string. It calls
4136 ;; `org-element--object-lex' to find the next object in the current
4137 ;; container.
4140 "Return next special mode according to TYPE, or nil.
4141 TYPE is a symbol representing the type of an element or object
4142 containing next element if PARENTP is non-nil, or before it
4143 otherwise. Modes can be either `first-section', `item',
4144 `node-property', `planning', `property-drawer', `section',
4145 `table-row' or nil."
4161 "Parse elements between BEG and END positions.
4163 MODE prioritizes some elements over the others. It can be set to
4164 `first-section', `section', `planning', `item', `node-property'
4165 or `table-row'.
4167 When value is `item', STRUCTURE will be used as the current list
4168 structure.
4170 GRANULARITY determines the depth of the recursion. See
4171 `org-element-parse-buffer' for more information.
4173 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4174 elements.
4176 Elements are accumulated into ACC."
4179 ;; Visible only: skip invisible parts at the beginning of the
4180 ;; element.
4183 ;; When parsing only headlines, skip any text before first one.
4186 ;; Main loop start.
4188 ;; Find current element's type and parse it accordingly to
4189 ;; its category.
4191 end granularity mode structure))
4195 ;; Visible only: skip invisible parts between siblings.
4198 ;; Fill ELEMENT contents by side-effect.
4200 ;; If element has no contents, don't modify it.
4202 ;; Greater element: parse it between `contents-begin' and
4203 ;; `contents-end'. Make sure GRANULARITY allows the
4204 ;; recursion, or ELEMENT is a headline, in which case going
4205 ;; inside is mandatory, in order to get sub-level headings.
4213 ;; Possibly switch to a special mode.
4217 granularity visible-only element))
4218 ;; ELEMENT has contents. Parse objects inside, if
4219 ;; GRANULARITY allows it.
4225 ;; Update mode.
4227 ;; Return result.
4228 acc))
4231 "Return next object in current buffer or nil.
4232 RESTRICTION is a list of object types, as symbols, that should be
4233 looked after. This function assumes that the buffer is narrowed
4234 to an appropriate container (e.g., a paragraph)."
4242 found)
4307 ;; This is probably a plain link.
4313 ;; Radio link.
4318 "Parse objects between BEG and END and return recursive structure.
4320 Objects are accumulated in ACC.
4322 RESTRICTION is a list of object successors which are allowed in
4323 the current object."
4331 ;; 1. Text before any object. Untabify it.
4336 acc
4340 ;; 2. Object...
4343 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4344 ;; a recursive type.
4352 ;; 3. Text after last object. Untabify it.
4356 acc
4360 ;; Result.
4361 acc)))
4364 \f
4365 ;;; Towards A Bijective Process
4366 ;;
4367 ;; The parse tree obtained with `org-element-parse-buffer' is really
4368 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4369 ;; interpreted and expanded into a string with canonical Org syntax.
4370 ;; Hence `org-element-interpret-data'.
4371 ;;
4372 ;; The function relies internally on
4373 ;; `org-element--interpret-affiliated-keywords'.
4375 ;;;###autoload
4377 "Interpret DATA as Org syntax.
4378 DATA is a parse tree, an element, an object or a secondary string
4379 to interpret. Return Org syntax as a string."
4383 "Interpret DATA as Org syntax.
4385 DATA is a parse tree, an element, an object or a secondary string
4386 to interpret. PARENT is used for recursive calls. It contains
4387 the element or object containing data, or nil.
4389 Return Org syntax as a string."
4391 ;; Find interpreter for current object or element. If it
4392 ;; doesn't exist (e.g. this is a pseudo object or element),
4393 ;; return contents, if any.
4399 ;; Secondary string.
4403 ;; Full Org document.
4407 ;; Plain text: return it.
4409 ;; Element or object without contents.
4411 ;; Element or object with contents.
4414 ;; Recursively interpret contents.
4419 data
4420 ;; Fix indentation of elements containing
4421 ;; objects. We ignore `table-row' elements
4422 ;; as they are one line long anyway.
4424 data
4425 ;; When normalizing first paragraph of an
4426 ;; item or a footnote-definition, ignore
4427 ;; first line's indentation.
4434 ;; Build white spaces. If no `:post-blank' property is
4435 ;; specified, assume its value is 0.
4449 "Return ELEMENT's affiliated keywords as Org syntax.
4450 If there is no affiliated keyword, return the empty string."
4460 ": "
4463 value)
4471 ;; All attribute keywords can have multiple lines.
4477 ;; List all ELEMENT's properties matching an attribute line or an
4478 ;; affiliated keyword, but ignore translated keywords since they
4479 ;; cannot belong to the property list.
4486 org-element-keyword-translation-alist)))))
4487 collect prop)
4490 ;; Because interpretation of the parse tree must return the same
4491 ;; number of blank lines between elements and the same number of white
4492 ;; space after objects, some special care must be given to white
4493 ;; spaces.
4494 ;;
4495 ;; The first function, `org-element-normalize-string', ensures any
4496 ;; string different from the empty string will end with a single
4497 ;; newline character.
4498 ;;
4499 ;; The second function, `org-element-normalize-contents', removes
4500 ;; global indentation from the contents of the current element.
4503 "Ensure string S ends with a single newline character.
4505 If S isn't a string return it unchanged. If S is the empty
4506 string, return it. Otherwise, return a new string with a single
4507 newline character at its end."
4515 "Normalize plain text in ELEMENT's contents.
4517 ELEMENT must only contain plain text and objects.
4519 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4520 indentation to compute maximal common indentation.
4522 Return the normalized element that is element with global
4523 indentation removed from its contents. The function assumes that
4524 indentation is not done with TAB characters."
4526 find-min-ind ; For byte-compiler.
4528 ;; Return minimal common indentation within BLOB. This is
4529 ;; done by walking recursively BLOB and updating MIN-IND
4530 ;; along the way. FIRST-FLAG is non-nil when the next
4531 ;; object is expected to be a string that doesn't start with
4532 ;; a newline character. It happens for strings at the
4533 ;; beginnings of the contents or right after a line break.
4538 ;; Objects cannot start with spaces: in this case,
4539 ;; indentation is 0.
4543 ;; An indentation of zero means no string will be
4544 ;; modified. Quit the process.
4555 ;; Find minimal indentation in ELEMENT.
4558 ;; Build ELEMENT back, replacing each string with the same
4559 ;; string minus common indentation.
4563 ;; Return BLOB with all its strings indentation
4564 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4565 ;; non-nil when the next object is expected to be
4566 ;; a string that doesn't start with a newline
4567 ;; character.
4583 org-element-recursive-objects)
4587 object)
4590 blob)))
4594 \f
4595 ;;; Cache
4596 ;;
4597 ;; Implement a caching mechanism for `org-element-at-point' and
4598 ;; `org-element-context', which see.
4599 ;;
4600 ;; A single public function is provided: `org-element-cache-reset'.
4601 ;;
4602 ;; Cache is enabled by default, but can be disabled globally with
4603 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4604 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4605 ;; can be tweaked to control caching behaviour.
4606 ;;
4607 ;; Internally, parsed elements are stored in an AVL tree,
4608 ;; `org-element--cache'. This tree is updated lazily: whenever
4609 ;; a change happens to the buffer, a synchronization request is
4610 ;; registered in `org-element--cache-sync-requests' (see
4611 ;; `org-element--cache-submit-request'). During idle time, requests
4612 ;; are processed by `org-element--cache-sync'. Synchronization also
4613 ;; happens when an element is required from the cache. In this case,
4614 ;; the process stops as soon as the needed element is up-to-date.
4615 ;;
4616 ;; A synchronization request can only apply on a synchronized part of
4617 ;; the cache. Therefore, the cache is updated at least to the
4618 ;; location where the new request applies. Thus, requests are ordered
4619 ;; from left to right and all elements starting before the first
4620 ;; request are correct. This property is used by functions like
4621 ;; `org-element--cache-find' to retrieve elements in the part of the
4622 ;; cache that can be trusted.
4623 ;;
4624 ;; A request applies to every element, starting from its original
4625 ;; location (or key, see below). When a request is processed, it
4626 ;; moves forward and may collide the next one. In this case, both
4627 ;; requests are merged into a new one that starts from that element.
4628 ;; As a consequence, the whole synchronization complexity does not
4629 ;; depend on the number of pending requests, but on the number of
4630 ;; elements the very first request will be applied on.
4631 ;;
4632 ;; Elements cannot be accessed through their beginning position, which
4633 ;; may or may not be up-to-date. Instead, each element in the tree is
4634 ;; associated to a key, obtained with `org-element--cache-key'. This
4635 ;; mechanism is robust enough to preserve total order among elements
4636 ;; even when the tree is only partially synchronized.
4637 ;;
4638 ;; Objects contained in an element are stored in a hash table,
4639 ;; `org-element--cache-objects'.
4643 "Non nil when Org parser should cache its results.
4650 "Maximum duration, as a time value, for a cache synchronization.
4651 If the synchronization is not over after this delay, the process
4652 pauses and resumes after `org-element-cache-sync-break'
4656 "Duration, as a time value, of the pause between synchronizations.
4660 ;;;; Data Structure
4663 "AVL tree used to cache elements.
4664 Each node of the tree contains an element. Comparison is done
4665 with `org-element--cache-compare'. This cache is used in
4669 "Hash table used as to cache objects.
4670 Key is an element, as returned by `org-element-at-point', and
4671 value is an alist where each association is:
4673 \(PARENT COMPLETEP . OBJECTS)
4675 where PARENT is an element or object, COMPLETEP is a boolean,
4676 non-nil when all direct children of parent are already cached and
4677 OBJECTS is a list of such children, as objects, from farthest to
4678 closest.
4681 contained within a paragraph
4685 If the paragraph is completely parsed, OBJECTS-DATA will be
4687 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4688 \(BOLD-OBJECT t ENTITY-OBJECT))
4690 whereas in a partially parsed paragraph, it could be
4692 \((PARAGRAPH nil ENTITY-OBJECT))
4697 "List of pending synchronization requests.
4699 A request is a vector with the following pattern:
4701 \[NEXT BEG END OFFSET PARENT PHASE]
4703 Processing a synchronization request consists of three phases:
4705 0. Delete modified elements,
4706 1. Fill missing area in cache,
4707 2. Shift positions and re-parent elements after the changes.
4709 During phase 0, NEXT is the key of the first element to be
4710 removed, BEG and END is buffer position delimiting the
4711 modifications. Elements starting between them (inclusive) are
4712 removed. So are elements whose parent is removed. PARENT, when
4713 non-nil, is the parent of the first element to be removed.
4715 During phase 1, NEXT is the key of the next known element in
4716 cache and BEG its beginning position. Parse buffer between that
4717 element and the one before it in order to determine the parent of
4718 the next element. Set PARENT to the element containing NEXT.
4720 During phase 2, NEXT is the key of the next element to shift in
4721 the parse tree. All elements starting from this one have their
4722 properties relatives to buffer positions shifted by integer
4723 OFFSET and, if they belong to element PARENT, are adopted by it.
4731 "Hash table used to store keys during synchronization.
4735 "Return a unique key for ELEMENT in cache tree.
4737 Keys are used to keep a total order among elements in the cache.
4738 Comparison is done with `org-element--cache-key-less-p'.
4740 When no synchronization is taking place, a key is simply the
4741 beginning position of the element, or that position plus one in
4742 the case of an first item (respectively row) in
4743 a list (respectively a table).
4745 During a synchronization, the key is the one the element had when
4746 the cache was synchronized for the last time. Elements added to
4747 cache during the synchronization get a new key generated with
4748 `org-element--cache-generate-key'.
4750 Such keys are stored in `org-element--cache-sync-keys'. The hash
4751 table is cleared once the synchronization is complete."
4754 ;; Increase beginning position of items (respectively
4755 ;; table rows) by one, so the first item can get
4756 ;; a different key from its parent list (respectively
4757 ;; table).
4760 begin)))
4763 key))))
4766 "Generate a key between LOWER and UPPER.
4768 LOWER and UPPER are integers or lists, possibly empty.
4770 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4771 a unique key, as an integer or a list of integers, according to
4772 the following rules:
4774 - LOWER and UPPER are compared level-wise until values differ.
4776 - If, at a given level, LOWER and UPPER differ from more than
4777 2, the new key shares all the levels above with LOWER and
4778 gets a new level. Its value is the mean between LOWER and
4779 UPPER:
4781 \(1 2) + (1 4) --> (1 3)
4783 - If LOWER has no value to compare with, it is assumed that its
4784 value is `most-negative-fixnum'. E.g.,
4786 \(1 1) + (1 1 2)
4788 is equivalent to
4790 \(1 1 m) + (1 1 2)
4792 where m is `most-negative-fixnum'. Likewise, if UPPER is
4793 short of levels, the current value is `most-positive-fixnum'.
4795 - If they differ from only one, the new key inherits from
4796 current LOWER level and fork it at the next level. E.g.,
4798 \(2 1) + (3 3)
4800 is equivalent to
4802 \(2 1) + (2 M)
4804 where M is `most-positive-fixnum'.
4806 - If the key is only one level long, it is returned as an
4807 integer:
4809 \(1 2) + (3 2) --> 2
4811 When they are not equals, the function assumes that LOWER is
4812 lesser than UPPER, per `org-element--cache-key-less-p'."
4816 skip-upper key)
4827 ;; When at a given level, LOWER and UPPER differ from
4828 ;; 1, ignore UPPER altogether. Instead create a key
4829 ;; between LOWER and the greatest key with the same
4830 ;; prefix as LOWER so far.
4836 "Non-nil if key A is less than key B.
4837 A and B are either integers or lists of integers, as returned by
4838 `org-element--cache-key'."
4846 ;; If A is empty, either keys are equal (B is also empty) and
4847 ;; we return nil, or A is lesser than B (B is longer) and we
4848 ;; return a non-nil value.
4849 ;;
4850 ;; If A is not empty, B is necessarily empty and A is greater
4851 ;; than B (A is longer). Therefore, return nil.
4855 "Non-nil when element A is located before element B."
4860 "Return root value in cache.
4861 This function assumes `org-element--cache' is a valid AVL tree."
4865 ;;;; Tools
4868 "Non-nil when cache is active in current buffer."
4873 "Find element in cache starting at POS or before.
4875 POS refers to a buffer position.
4877 When optional argument SIDE is non-nil, the function checks for
4878 elements starting at or past POS instead. If SIDE is `both', the
4879 function returns a cons cell where car is the first element
4880 starting at or before POS and cdr the first element starting
4881 after POS.
4883 The function can only find elements in the synchronized part of
4884 the cache."
4888 lower upper)
4903 ;; We found an element in cache starting at POS. If `side'
4904 ;; is `both' we also want the next one in order to generate
4905 ;; a key in-between.
4906 ;;
4907 ;; If the element is the first row or item in a table or
4908 ;; a plain list, we always return the table or the plain
4909 ;; list.
4910 ;;
4911 ;; In any other case, we return the element found.
4920 lower parent
4921 upper parent)))))
4924 lower element
4925 upper element)))))
4932 "Store ELEMENT in current buffer's cache, if allowed.
4933 When optional argument DATA is non-nil, assume is it object data
4934 relative to ELEMENT and store it in the objects cache."
4938 ;; During synchronization, first build an appropriate key
4939 ;; for the new element so `avl-tree-enter' can insert it at
4940 ;; the right spot in the cache.
4949 org-element--cache-sync-keys)))
4951 ;; Headlines are not stored in cache, so objects in titles are
4952 ;; not stored either.
4957 "Remove ELEMENT from cache.
4958 Assume ELEMENT belongs to cache and that a cache is active."
4963 ;;;; Synchronization
4966 "Set idle timer for cache synchronization in BUFFER."
4973 org-element-cache-sync-idle-time))
4974 nil
4975 #'org-element--cache-sync
4976 buffer)))
4979 "Non-nil when synchronization process should be interrupted.
4980 TIME-LIMIT is a time value or nil."
4986 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4988 Properties containing buffer positions are `:begin', `:end',
4989 `:contents-begin', `:contents-end' and `:structure'. When
4990 optional argument PROPS is a list of keywords, only shift
4991 properties provided in that list.
4993 Properties are modified by side-effect."
4995 ;; Shift `:structure' property for the first plain list only: it
4996 ;; is the only one that really matters and it prevents from
4997 ;; shifting it more than once.
5011 "Synchronize cache with recent modification in BUFFER.
5013 When optional argument THRESHOLD is non-nil, do the
5014 synchronization for all elements starting before or at threshold,
5015 then exit. Otherwise, synchronize cache for as long as
5016 `org-element-cache-sync-duration' or until Emacs leaves idle
5017 state.
5019 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5020 not registered yet in the cache are going to happen. It is used
5021 in `org-element--cache-submit-request', where cache is partially
5022 updated before current modification are actually submitted."
5033 request
5035 threshold
5038 org-element-cache-sync-duration))
5039 future-change)
5040 ;; Request processed. Merge current and next offsets and
5041 ;; transfer ending position.
5047 ;; If more requests are awaiting, set idle timer accordingly.
5048 ;; Otherwise, reset keys.
5055 "Process synchronization REQUEST for all entries before NEXT.
5057 REQUEST is a vector, built by `org-element--cache-submit-request'.
5059 NEXT is a cache key, as returned by `org-element--cache-key'.
5061 When non-nil, THRESHOLD is a buffer position. Synchronization
5062 stops as soon as a shifted element begins after it.
5064 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5065 after this time or when Emacs exits idle state.
5067 When non-nil, FUTURE-CHANGE is a buffer position where changes
5068 not registered yet in the cache are going to happen. See
5069 `org-element--cache-submit-request' for more information.
5071 Throw `interrupt' if the process stops before completing the
5072 request."
5075 ;; Phase 0.
5076 ;;
5077 ;; Delete all elements starting after BEG, but not after buffer
5078 ;; position END or past element with key NEXT. Also delete
5079 ;; elements contained within a previously removed element
5080 ;; (stored in `last-container').
5081 ;;
5082 ;; At each iteration, we start again at tree root since
5083 ;; a deletion modifies structure of the balanced tree.
5088 ;; Find first element in cache with key BEG or after it.
5092 data data-key last-container)
5101 data-key key
5104 data-key key
5105 node nil)))))
5115 up)))
5118 end))
5125 ;; No element starting after modifications left in
5126 ;; cache: further processing is futile.
5129 ;; Phase 1.
5130 ;;
5131 ;; Phase 0 left a hole in the cache. Some elements after it
5132 ;; could have parents within. For example, in the following
5133 ;; buffer:
5134 ;;
5135 ;; - item
5136 ;;
5137 ;;
5138 ;; Paragraph1
5139 ;;
5140 ;; Paragraph2
5141 ;;
5142 ;; if we remove a blank line between "item" and "Paragraph1",
5143 ;; everything down to "Paragraph2" is removed from cache. But
5144 ;; the paragraph now belongs to the list, and its `:parent'
5145 ;; property no longer is accurate.
5146 ;;
5147 ;; Therefore we need to parse again elements in the hole, or at
5148 ;; least in its last section, so that we can re-parent
5149 ;; subsequent elements, during phase 2.
5150 ;;
5151 ;; Note that we only need to get the parent from the first
5152 ;; element in cache after the hole.
5153 ;;
5154 ;; When next key is lesser or equal to the current one, delegate
5155 ;; phase 1 processing to next request in order to preserve key
5156 ;; order among requests.
5164 ;; Next element will start at its beginning position plus
5165 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5166 ;; contains the real beginning position of the first element to
5167 ;; shift and re-parent.
5171 ;; Changes are going to happen around this element and
5172 ;; they will trigger another phase 1 request. Skip the
5173 ;; current one.
5179 ;; Phase 2.
5180 ;;
5181 ;; Shift all elements starting from key START, but before NEXT, by
5182 ;; OFFSET, and re-parent them when appropriate.
5183 ;;
5184 ;; Elements are modified by side-effect so the tree structure
5185 ;; remains intact.
5186 ;;
5187 ;; Once THRESHOLD, if any, is reached, or once there is an input
5188 ;; pending, exit. Before leaving, the current synchronization
5189 ;; request is updated.
5196 exit-flag)
5197 ;; No re-parenting nor shifting planned: request is over.
5207 ;; We reached NEXT. Request is complete.
5209 ;; Handle interruption request. Update current request.
5214 ;; Shift element.
5217 ;; Shift associated objects data, if any.
5222 ;; Update PARENT and re-parent DATA, only when
5223 ;; necessary. Propagate new structures for lists.
5237 ;; Cache is up-to-date past THRESHOLD. Request
5238 ;; interruption.
5243 ;; We reached end of tree: synchronization complete.
5244 t)))
5247 "Parse elements in current section, down to POS.
5249 Start parsing from the closest between the last known element in
5250 cache or headline above. Return the smallest element containing
5251 POS.
5253 When optional argument SYNCP is non-nil, return the parent of the
5254 element containing POS instead. In that case, it is also
5255 possible to provide TIME-LIMIT, which is a time value specifying
5256 when the parsing should stop. The function throws `interrupt' if
5257 the process stopped before finding the expected result."
5264 element next mode)
5266 ;; Nothing in cache before point: start parsing from first
5267 ;; element following headline above, or first element in
5268 ;; buffer.
5275 ;; Cache returned exact match: return it.
5278 ;; There's a headline between cached value and POS: cached
5279 ;; value is invalid. Start parsing from first element
5280 ;; following the headline.
5287 ;; Check if CACHED or any of its ancestors contain point.
5288 ;;
5289 ;; If there is such an element, we inspect it in order to know
5290 ;; if we return it or if we need to parse its contents.
5291 ;; Otherwise, we just start parsing from current location,
5292 ;; which is right after the top-most element containing
5293 ;; CACHED.
5294 ;;
5295 ;; As a special case, if POS is at the end of the buffer, we
5296 ;; want to return the innermost element ending there.
5297 ;;
5298 ;; Also, if we find an ancestor and discover that we need to
5299 ;; parse its contents, make sure we don't start from
5300 ;; `:contents-begin', as we would otherwise go past CACHED
5301 ;; again. Instead, in that situation, we will resume parsing
5302 ;; from NEXT, which is located after CACHED or its higher
5303 ;; ancestor not containing point.
5315 ;; Parse successively each element until we reach POS.
5328 end 'element mode
5335 ;; Skip any element ending before point. Also skip
5336 ;; element ending at point (unless it is also the end of
5337 ;; buffer) since we're sure that another element begins
5338 ;; after it.
5342 ;; A non-greater element contains point: return it.
5345 ;; Otherwise, we have to decide if ELEMENT really
5346 ;; contains POS. In that case we start parsing from
5347 ;; contents' beginning.
5348 ;;
5349 ;; If POS is at contents' beginning but it is also at
5350 ;; the beginning of the first item in a list or a table.
5351 ;; In that case, we need to create an anchor for that
5352 ;; list or table, so return it.
5353 ;;
5354 ;; Also, if POS is at the end of the buffer, no element
5355 ;; can start after it, but more than one may end there.
5356 ;; Arbitrarily, we choose to return the innermost of
5357 ;; such elements.
5370 parent element
5371 end cend))))
5372 ;; Otherwise, return ELEMENT as it is the smallest
5373 ;; element containing POS.
5378 ;;;; Staging Buffer Changes
5389 "Regexp matching a sensitive line, structure wise.
5390 A sensitive line is a headline, inlinetask, block, drawer, or
5391 latex-environment boundary. When such a line is modified,
5392 structure changes in the document may propagate in the whole
5396 "Non-nil when a sensitive line is about to be changed.
5400 "Request extension of area going to be modified if needed.
5401 BEG and END are the beginning and end of the range of changed
5402 text. See `before-change-functions' for more information."
5412 'headline
5415 org-element--cache-sensitive-re bottom t)))))))))
5418 "Update buffer modifications for current buffer.
5419 BEG and END are the beginning and end of the range of changed
5420 text, and the length in bytes of the pre-change text replaced by
5421 that range. See `after-change-functions' for more information."
5429 ;; Determine if modified area needs to be extended, according
5430 ;; to both previous and current state. We make a special
5431 ;; case for headline editing: if a headline is modified but
5432 ;; not removed, do not extend.
5441 org-element--cache-sensitive-re bottom t))))
5442 ;; Effectively extend modified area.
5450 ;; Store synchronization request.
5453 ;; Activate a timer to process the request during idle time.
5457 "Return first element to remove from cache.
5459 BEG and END are buffer positions delimiting buffer modifications.
5460 OFFSET is the size of the changes.
5462 Returned element is usually the first element in cache containing
5463 any position between BEG and END. As an exception, greater
5464 elements around the changes that are robust to contents
5465 modifications are preserved and updated according to the
5466 changes."
5476 special-block))
5477 ;; Drawers named "PROPERTIES" are probably
5478 ;; a properties drawer being edited. Force
5479 ;; parsing to check if editing is over.
5488 ;; UP is a robust greater element containing changes.
5489 ;; We only need to extend its ending boundaries.
5495 ;; We're at top level element containing ELEMENT: if it's
5496 ;; altered by buffer modifications, it is first element in
5497 ;; cache to be removed. Otherwise, that first element is the
5498 ;; following one.
5499 ;;
5500 ;; As a special case, do not remove BEFORE if it is a robust
5501 ;; container for current changes.
5503 before)))))
5506 "Submit a new cache synchronization request for current buffer.
5507 BEG and END are buffer positions delimiting the minimal area
5508 where cache data should be removed. OFFSET is the size of the
5509 change, as an integer."
5511 delete-to delete-from)
5516 ;; Current changes can be merged with first sync request: we
5517 ;; can save a partial cache synchronization.
5520 ;; If last change happened within area to be removed, extend
5521 ;; boundaries of robust parents, if any. Otherwise, find
5522 ;; first element to remove and update request accordingly.
5534 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5535 ;; if any, is no longer a 0-phase request, thus ensuring that
5536 ;; phases are properly ordered. We need to provide OFFSET as
5537 ;; optional parameter since current modifications are not known
5538 ;; yet to the otherwise correct part of the cache (i.e, before
5539 ;; the first request).
5546 ;; When changes happen before the first known
5547 ;; element, re-parent and shift the rest of the
5548 ;; cache.
5550 ;; Otherwise, we find the first non robust
5551 ;; element containing END. All elements between
5552 ;; FIRST and this one are to be removed.
5563 element up))
5565 org-element--cache-sync-requests)
5566 ;; No element to remove. No need to re-parent either.
5567 ;; Simply shift additional elements, if any, by OFFSET.
5572 ;;;; Public Functions
5574 ;;;###autoload
5576 "Reset cache in current buffer.
5577 When optional argument ALL is non-nil, reset cache in all Org
5578 buffers."
5596 ;;;###autoload
5598 "Refresh cache at position POS."
5605 \f
5606 ;;; The Toolbox
5607 ;;
5608 ;; The first move is to implement a way to obtain the smallest element
5609 ;; containing point. This is the job of `org-element-at-point'. It
5610 ;; basically jumps back to the beginning of section containing point
5611 ;; and proceed, one element after the other, with
5612 ;; `org-element--current-element' until the container is found. Note:
5613 ;; When using `org-element-at-point', secondary values are never
5614 ;; parsed since the function focuses on elements, not on objects.
5615 ;;
5616 ;; At a deeper level, `org-element-context' lists all elements and
5617 ;; objects containing point.
5618 ;;
5619 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5620 ;; internally by navigation and manipulation tools.
5623 ;;;###autoload
5625 "Determine closest element around point.
5627 Return value is a list like (TYPE PROPS) where TYPE is the type
5628 of the element and PROPS a plist of properties associated to the
5629 element.
5631 Possible types are defined in `org-element-all-elements'.
5632 Properties depend on element or object type, but always include
5633 `:begin', `:end', `:parent' and `:post-blank' properties.
5635 As a special case, if point is at the very beginning of the first
5636 item in a list or sub-list, returned element will be that list
5637 instead of the item. Likewise, if point is at the beginning of
5638 the first row of a table, returned element will be the table
5639 instead of the first row.
5641 When point is at the end of the buffer, return the innermost
5642 element ending there."
5648 ;; Within blank lines at the beginning of buffer, return nil.
5650 ;; Within blank lines right after a headline, return that
5651 ;; headline.
5655 ;; Otherwise parse until we find element containing ORIGIN.
5662 ;;;###autoload
5664 "Return smallest element or object around point.
5666 Return value is a list like (TYPE PROPS) where TYPE is the type
5667 of the element or object and PROPS a plist of properties
5668 associated to it.
5670 Possible types are defined in `org-element-all-elements' and
5671 `org-element-all-objects'. Properties depend on element or
5672 object type, but always include `:begin', `:end', `:parent' and
5673 `:post-blank'.
5675 As a special case, if point is right after an object and not at
5676 the beginning of any other object, return that object.
5678 Optional argument ELEMENT, when non-nil, is the closest element
5679 containing point, as returned by `org-element-at-point'.
5680 Providing it allows for quicker computation."
5686 ;; If point is inside an element containing objects or
5687 ;; a secondary string, narrow buffer to the container and
5688 ;; proceed with parsing. Otherwise, return ELEMENT.
5690 ;; At a parsed affiliated keyword, check if we're inside main
5691 ;; or dual value.
5698 org-element-parsed-keywords))
5707 ;; Also change type to retrieve correct restrictions.
5709 ;; At an item, objects can only be located within tag, if any.
5719 ;; At an headline or inlinetask, objects are in title.
5726 ;; At a paragraph, a table-row or a verse block, objects are
5727 ;; located within their contents.
5731 ;; CBEG is nil for table rules.
5736 ;; At a planning line, if point is at a timestamp, return it,
5737 ;; otherwise, return element.
5745 ;; All other locations cannot contain objects: bail out.
5755 next object-data last)
5759 ;; When entering PARENT for the first time, get list
5760 ;; of objects within known so far. Store it in
5761 ;; OBJECT-DATA.
5766 ;; Find NEXT object for analysis.
5768 ;; If NEXT is non-nil, we already exhausted the
5769 ;; cache so we can parse buffer to find the object
5770 ;; after it.
5772 ;; Otherwise, check if cache can help us.
5783 ;; Cache contains the information needed.
5786 pos)
5788 pos)
5794 ;; If we have a new object to analyze, store it in
5795 ;; cache. Otherwise record that there is nothing
5796 ;; more to parse in this element at this depth.
5801 ;; Process NEXT, if any, in order to know if we need
5802 ;; to skip it, return it or move into it.
5809 ;; Skip objects ending before point. Also skip
5810 ;; objects ending at point unless it is also the
5811 ;; end of buffer, since we want to return the
5812 ;; innermost object.
5815 ;; For convenience, when object ends at POS,
5816 ;; without any space, store it in LAST, as we
5817 ;; will return it if no object starts here.
5821 ;; If POS is within a container object, move
5822 ;; into that object.
5826 ;; At contents' end, if there is no
5827 ;; space before point, also move into
5828 ;; object, for consistency with
5829 ;; convenience feature above.
5838 next nil
5839 object-data nil))
5840 ;; Otherwise, return NEXT.
5842 ;; Store results in cache, if applicable.
5846 "List all ancestors of a given element or object.
5848 BLOB is an object or element.
5850 When optional argument TYPES is a list of symbols, return the
5851 first element or object in the lineage whose type belongs to that
5852 list.
5854 When optional argument WITH-SELF is non-nil, lineage includes
5855 BLOB itself as the first element, and TYPES, if provided, also
5856 apply to it.
5858 When BLOB is obtained through `org-element-context' or
5859 `org-element-at-point', only ancestors from its section can be
5860 found. There is no such limitation when BLOB belongs to a full
5861 parse tree."
5863 ancestors)
5870 "Non-nil when elements ELEM-A and ELEM-B are nested."
5879 "Swap elements ELEM-A and ELEM-B.
5880 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5881 end of ELEM-A."
5883 ;; There are two special cases when an element doesn't start at bol:
5884 ;; the first paragraph in an item or in a footnote definition.
5886 ;; Only a paragraph without any affiliated keyword can be moved at
5887 ;; ELEM-A position in such a situation. Note that the case of
5888 ;; a footnote definition is impossible: it cannot contain two
5889 ;; paragraphs in a row because it cannot contain a blank line.
5895 ;; In a special situation, ELEM-A will have no indentation. We'll
5896 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5910 ;; Store inner overlays responsible for visibility status.
5911 ;; We also need to store their boundaries as they will be
5912 ;; removed from buffer.
5927 ;; Get contents.
5935 ;; Restore ex ELEM-A overlays.
5942 ;; Restore ex ELEM-B overlays.
5948 "Remove maximum common indentation in string S and return it.
5949 When optional argument N is a positive integer, remove exactly
5950 that much characters from indentation, if possible, or return
5951 S as-is otherwise. Unlike to `org-remove-indentation', this
5952 function doesn't call `untabify' on S."
5957 ;; Find maximum common indentation, if not specified.
5965 min-ind)))
5967 ;; Remove exactly N indentation, but give up if not possible.
5980 ;; Local variables:
5981 ;; generated-autoload-file: "org-loaddefs.el"
5982 ;; End:
5984 ;;; org-element.el ends here