| blob | 64d2123b4e3a0635031f1c5a12c8ddd2f0164232 |
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."
492 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
493 ;; string: parent is the list itself.
496 children)
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 "Return a copy of DATUM.
578 DATUM is an element, object, string or nil. `:parent' property
579 is cleared and contents are removed in the process."
590 \f
591 ;;; Greater elements
592 ;;
593 ;; For each greater element type, we define a parser and an
594 ;; interpreter.
595 ;;
596 ;; A parser returns the element or object as the list described above.
597 ;; Most of them accepts no argument. Though, exceptions exist. Hence
598 ;; every element containing a secondary string (see
599 ;; `org-element-secondary-value-alist') will accept an optional
600 ;; argument to toggle parsing of these secondary strings. Moreover,
601 ;; `item' parser requires current list's structure as its first
602 ;; element.
603 ;;
604 ;; An interpreter accepts two arguments: the list representation of
605 ;; the element or object, and its contents. The latter may be nil,
606 ;; depending on the element or object considered. It returns the
607 ;; appropriate Org syntax, as a string.
608 ;;
609 ;; Parsing functions must follow the naming convention:
610 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
611 ;; defined in `org-element-greater-elements'.
612 ;;
613 ;; Similarly, interpreting functions must follow the naming
614 ;; convention: org-element-TYPE-interpreter.
615 ;;
616 ;; With the exception of `headline' and `item' types, greater elements
617 ;; cannot contain other greater elements of their own type.
618 ;;
619 ;; Beside implementing a parser and an interpreter, adding a new
620 ;; greater element requires to tweak `org-element--current-element'.
621 ;; Moreover, the newly defined type must be added to both
622 ;; `org-element-all-elements' and `org-element-greater-elements'.
625 ;;;; Center Block
628 "Parse a center block.
630 LIMIT bounds the search. AFFILIATED is a list of which CAR is
631 the buffer position at the beginning of the first affiliated
632 keyword and CDR is a plist of affiliated keywords along with
633 their value.
635 Return a list whose CAR is `center-block' and CDR is a plist
636 containing `:begin', `:end', `:contents-begin', `:contents-end',
637 `:post-blank' and `:post-affiliated' keywords.
639 Assume point is at the beginning of the block."
643 ;; Incomplete block: parse it as a paragraph.
648 ;; Empty blocks have no contents.
662 :end end
663 :contents-begin contents-begin
664 :contents-end contents-end
670 "Interpret CENTER-BLOCK element as Org syntax.
671 CONTENTS is the contents of the element."
675 ;;;; Drawer
678 "Parse a drawer.
680 LIMIT bounds the search. AFFILIATED is a list of which CAR is
681 the buffer position at the beginning of the first affiliated
682 keyword and CDR is a plist of affiliated keywords along with
683 their value.
685 Return a list whose CAR is `drawer' and CDR is a plist containing
686 `:drawer-name', `:begin', `:end', `:contents-begin',
687 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
689 Assume point is at beginning of drawer."
692 ;; Incomplete drawer: parse it as a paragraph.
700 ;; Empty drawers have no contents.
713 :end end
714 :drawer-name name
715 :contents-begin contents-begin
716 :contents-end contents-end
722 "Interpret DRAWER element as Org syntax.
723 CONTENTS is the contents of the element."
726 contents))
729 ;;;; Dynamic Block
732 "Parse a dynamic block.
734 LIMIT bounds the search. AFFILIATED is a list of which CAR is
735 the buffer position at the beginning of the first affiliated
736 keyword and CDR is a plist of affiliated keywords along with
737 their value.
739 Return a list whose CAR is `dynamic-block' and CDR is a plist
740 containing `:block-name', `:begin', `:end', `:contents-begin',
741 `:contents-end', `:arguments', `:post-blank' and
742 `:post-affiliated' keywords.
744 Assume point is at beginning of dynamic block."
748 ;; Incomplete block: parse it as a paragraph.
757 ;; Empty blocks have no contents.
770 :end end
771 :block-name name
772 :arguments arguments
773 :contents-begin contents-begin
774 :contents-end contents-end
780 "Interpret DYNAMIC-BLOCK element as Org syntax.
781 CONTENTS is the contents of the element."
786 contents))
789 ;;;; Footnote Definition
792 "Parse a footnote definition.
794 LIMIT bounds the search. AFFILIATED is a list of which CAR is
795 the buffer position at the beginning of the first affiliated
796 keyword and CDR is a plist of affiliated keywords along with
797 their value.
799 Return a list whose CAR is `footnote-definition' and CDR is
800 a plist containing `:label', `:begin' `:end', `:contents-begin',
801 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
803 Assume point is at the beginning of the footnote definition."
831 :begin begin
832 :end end
833 :contents-begin contents-begin
834 :contents-end contents-end
840 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
841 CONTENTS is the contents of the footnote-definition."
843 " "
844 contents))
847 ;;;; Headline
850 "Return node properties associated to headline at point.
851 Upcase property names. It avoids confusion between properties
852 obtained through property drawer and default properties from the
853 parser (e.g. `:end' and :END:). Return value is a plist."
865 properties))))
868 "Return time properties associated to headline at point.
869 Return value is a plist."
883 plist))))
886 "Parse a headline.
888 Return a list whose CAR is `headline' and CDR is a plist
889 containing `:raw-value', `:title', `:begin', `:end',
890 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
891 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
892 `:deadline', `:closed', `:archivedp', `:commentedp'
893 `:footnote-section-p', `:post-blank' and `:post-affiliated'
894 keywords.
896 The plist also contains any property set in the property drawer,
897 with its name in upper cases and colons added at the
898 beginning (e.g., `:CUSTOM_ID').
900 LIMIT is a buffer position bounding the search.
902 When RAW-SECONDARY-P is non-nil, headline's title will not be
903 parsed as a secondary string, but as a plain string instead.
905 Assume point is at beginning of the headline."
952 :begin begin
953 :end end
954 :pre-blank
957 :contents-begin contents-begin
958 :contents-end contents-end
959 :level level
960 :priority priority
961 :tags tags
962 :todo-keyword todo
963 :todo-type todo-type
966 end)
967 :footnote-section-p footnote-section-p
968 :archivedp archivedp
969 :commentedp commentedp
971 time-props
972 standard-props))))
974 headline :title
983 nil
989 "Interpret HEADLINE element as Org syntax.
990 CONTENTS is the contents of the element."
1003 ?*)
1007 " "
1010 org-footnote-section
1011 title))))
1013 heading
1014 ;; Align tags.
1022 ?\s)
1023 tags))
1027 tags))))
1029 contents)))
1032 ;;;; Inlinetask
1035 "Parse an inline task.
1037 Return a list whose CAR is `inlinetask' and CDR is a plist
1038 containing `:title', `:begin', `:end', `:contents-begin' and
1039 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1040 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1041 `:closed', `:post-blank' and `:post-affiliated' keywords.
1043 The plist also contains any property set in the property drawer,
1044 with its name in upper cases and colons added at the
1045 beginning (e.g., `:CUSTOM_ID').
1047 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1048 title will not be parsed as a secondary string, but as a plain
1049 string instead.
1051 Assume point is at beginning of the inline task."
1096 :begin begin
1097 :end end
1098 :contents-begin contents-begin
1099 :contents-end contents-end
1100 :level level
1101 :priority priority
1102 :tags tags
1103 :todo-keyword todo
1104 :todo-type todo-type
1107 time-props
1108 standard-props))))
1110 inlinetask :title
1119 nil
1125 "Interpret INLINETASK element as Org syntax.
1126 CONTENTS is the contents of inlinetask."
1140 ;; Align tags.
1148 ? )
1149 tags))
1153 tags))))
1154 ;; Prefer degenerate inlinetasks when there are no
1155 ;; contents.
1158 contents
1162 ;;;; Item
1165 "Parse an item.
1167 STRUCT is the structure of the plain list.
1169 Return a list whose CAR is `item' and CDR is a plist containing
1170 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1171 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1172 `:post-affiliated' keywords.
1174 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1175 any, will not be parsed as a secondary string, but as a plain
1176 string instead.
1178 Assume point is at the beginning of the item."
1201 ;; Ignore tags in un-ordered lists: they are just
1202 ;; a part of item's body.
1209 ;; If first line isn't empty, contents really
1210 ;; start at the text after item's meta-data.
1220 :begin begin
1221 :end end
1222 :contents-begin contents-begin
1223 :contents-end contents-end
1224 :checkbox checkbox
1225 :counter counter
1226 :structure struct
1230 item :tag
1241 "Interpret ITEM element as Org syntax.
1242 CONTENTS is the contents of the element."
1252 ;; Compute indentation.
1257 ;; Indent contents.
1259 bullet
1273 ;;;; Plain List
1276 ;; Return structure of list at point. Internal function. See
1277 ;; `org-list-struct' for details.
1282 items struct)
1287 ;; At limit: end all items.
1296 ;; At list end: end all items.
1301 ;; At a new item: end previous sibling.
1313 ind
1314 bullet
1317 ;; Description tag.
1321 ;; Ending position, unknown so far.
1322 nil)))
1323 items))
1325 ;; Skip empty lines.
1327 ;; Skip inline tasks and blank lines along the way.
1334 ;; At some text line. Check if it ends any previous item.
1346 ;; Skip blocks (any type) and drawers contents.
1351 limit t)))
1357 "Parse a plain list.
1359 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1360 the buffer position at the beginning of the first affiliated
1361 keyword and CDR is a plist of affiliated keywords along with
1362 their value. STRUCTURE is the structure of the plain list being
1363 parsed.
1365 Return a list whose CAR is `plain-list' and CDR is a plist
1366 containing `:type', `:begin', `:end', `:contents-begin' and
1367 `:contents-end', `:structure', `:post-blank' and
1368 `:post-affiliated' keywords.
1370 Assume point is at the beginning of the list."
1384 pos))
1388 ;; Return value.
1392 :begin begin
1393 :end end
1394 :contents-begin contents-begin
1395 :contents-end contents-end
1396 :structure struct
1402 "Interpret PLAIN-LIST element as Org syntax.
1403 CONTENTS is the contents of the element."
1411 ;;;; Property Drawer
1414 "Parse a property drawer.
1416 LIMIT bounds the search.
1418 Return a list whose car is `property-drawer' and cdr is a plist
1419 containing `:begin', `:end', `:contents-begin', `:contents-end',
1420 `:post-blank' and `:post-affiliated' keywords.
1422 Assume point is at the beginning of the property drawer."
1435 :end end
1437 :contents-end contents-end
1442 "Interpret PROPERTY-DRAWER element as Org syntax.
1443 CONTENTS is the properties within the drawer."
1447 ;;;; Quote Block
1450 "Parse a quote block.
1452 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1453 the buffer position at the beginning of the first affiliated
1454 keyword and CDR is a plist of affiliated keywords along with
1455 their value.
1457 Return a list whose CAR is `quote-block' and CDR is a plist
1458 containing `:begin', `:end', `:contents-begin', `:contents-end',
1459 `:post-blank' and `:post-affiliated' keywords.
1461 Assume point is at the beginning of the block."
1465 ;; Incomplete block: parse it as a paragraph.
1471 ;; Empty blocks have no contents.
1484 :end end
1485 :contents-begin contents-begin
1486 :contents-end contents-end
1492 "Interpret QUOTE-BLOCK element as Org syntax.
1493 CONTENTS is the contents of the element."
1497 ;;;; Section
1500 "Parse a section.
1502 LIMIT bounds the search.
1504 Return a list whose CAR is `section' and CDR is a plist
1505 containing `:begin', `:end', `:contents-begin', `contents-end',
1506 `:post-blank' and `:post-affiliated' keywords."
1508 ;; Beginning of section is the beginning of the first non-blank
1509 ;; line after previous headline.
1518 :end end
1519 :contents-begin begin
1520 :contents-end pos-before-blank
1525 "Interpret SECTION element as Org syntax.
1526 CONTENTS is the contents of the element."
1527 contents)
1530 ;;;; Special Block
1533 "Parse a special block.
1535 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1536 the buffer position at the beginning of the first affiliated
1537 keyword and CDR is a plist of affiliated keywords along with
1538 their value.
1540 Return a list whose CAR is `special-block' and CDR is a plist
1541 containing `:type', `:begin', `:end', `:contents-begin',
1542 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1544 Assume point is at the beginning of the block."
1551 limit t)))
1552 ;; Incomplete block: parse it as a paragraph.
1558 ;; Empty blocks have no contents.
1571 :begin begin
1572 :end end
1573 :contents-begin contents-begin
1574 :contents-end contents-end
1580 "Interpret SPECIAL-BLOCK element as Org syntax.
1581 CONTENTS is the contents of the element."
1586 \f
1587 ;;; Elements
1588 ;;
1589 ;; For each element, a parser and an interpreter are also defined.
1590 ;; Both follow the same naming convention used for greater elements.
1591 ;;
1592 ;; Also, as for greater elements, adding a new element type is done
1593 ;; through the following steps: implement a parser and an interpreter,
1594 ;; tweak `org-element--current-element' so that it recognizes the new
1595 ;; type and add that new type to `org-element-all-elements'.
1596 ;;
1597 ;; As a special case, when the newly defined type is a block type,
1598 ;; `org-element-block-name-alist' has to be modified accordingly.
1601 ;;;; Babel Call
1604 "Parse a babel call.
1606 LIMIT bounds the search. AFFILIATED is a list of which car is
1607 the buffer position at the beginning of the first affiliated
1608 keyword and cdr is a plist of affiliated keywords along with
1609 their value.
1611 Return a list whose car is `babel-call' and cdr is a plist
1612 containing `:call', `:inside-header', `:arguments',
1613 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1614 `:post-affiliated' as keywords."
1628 value)))
1638 :begin begin
1639 :end end
1640 :value value
1646 "Interpret BABEL-CALL element as Org syntax.
1647 CONTENTS is nil."
1657 ;;;; Clock
1660 "Parse a clock.
1662 LIMIT bounds the search.
1664 Return a list whose CAR is `clock' and CDR is a plist containing
1665 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1666 `:post-affiliated' as keywords."
1686 :value value
1687 :duration duration
1688 :begin begin
1689 :end end
1690 :post-blank post-blank
1694 "Interpret CLOCK element as Org syntax.
1695 CONTENTS is nil."
1703 "%2s:%02s"
1707 ;;;; Comment
1710 "Parse a comment.
1712 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1713 the buffer position at the beginning of the first affiliated
1714 keyword and CDR is a plist of affiliated keywords along with
1715 their value.
1717 Return a list whose CAR is `comment' and CDR is a plist
1718 containing `:begin', `:end', `:value', `:post-blank',
1719 `:post-affiliated' keywords.
1721 Assume point is at comment beginning."
1730 ;; Get comments ending.
1733 ;; Accumulate lines without leading hash and first
1734 ;; whitespace.
1748 :end end
1749 :value value
1755 "Interpret COMMENT element as Org syntax.
1756 CONTENTS is nil."
1760 ;;;; Comment Block
1763 "Parse an export block.
1765 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1766 the buffer position at the beginning of the first affiliated
1767 keyword and CDR is a plist of affiliated keywords along with
1768 their value.
1770 Return a list whose CAR is `comment-block' and CDR is a plist
1771 containing `:begin', `:end', `:value', `:post-blank' and
1772 `:post-affiliated' keywords.
1774 Assume point is at comment block beginning."
1778 ;; Incomplete block: parse it as a paragraph.
1791 contents-begin contents-end)))
1795 :end end
1796 :value value
1802 "Interpret COMMENT-BLOCK element as Org syntax.
1803 CONTENTS is nil."
1810 ;;;; Diary Sexp
1813 "Parse a diary sexp.
1815 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1816 the buffer position at the beginning of the first affiliated
1817 keyword and CDR is a plist of affiliated keywords along with
1818 their value.
1820 Return a list whose CAR is `diary-sexp' and CDR is a plist
1821 containing `:begin', `:end', `:value', `:post-blank' and
1822 `:post-affiliated' keywords."
1834 :begin begin
1835 :end end
1841 "Interpret DIARY-SEXP as Org syntax.
1842 CONTENTS is nil."
1846 ;;;; Example Block
1849 "Parse an example block.
1851 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1852 the buffer position at the beginning of the first affiliated
1853 keyword and CDR is a plist of affiliated keywords along with
1854 their value.
1856 Return a list whose CAR is `example-block' and CDR is a plist
1857 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1858 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1859 `:value', `:post-blank' and `:post-affiliated' keywords."
1863 ;; Incomplete block: parse it as a paragraph.
1871 ;; Switches analysis
1878 ;; Should labels be retained in (or stripped from) example
1879 ;; blocks?
1884 ;; What should code-references use - labels or
1885 ;; line-numbers?
1894 ;; Standard block parsing.
1902 contents-begin contents-end))
1903 block-ind))
1912 :end end
1913 :value value
1914 :switches switches
1915 :number-lines number-lines
1916 :preserve-indent preserve-indent
1917 :retain-labels retain-labels
1918 :use-labels use-labels
1919 :label-fmt label-fmt
1925 "Interpret EXAMPLE-BLOCK element as Org syntax.
1926 CONTENTS is nil."
1934 value
1939 ;;;; Export Block
1942 "Parse an export block.
1944 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1945 the buffer position at the beginning of the first affiliated
1946 keyword and CDR is a plist of affiliated keywords along with
1947 their value.
1949 Return a list whose CAR is `export-block' and CDR is a plist
1950 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1951 `:post-affiliated' keywords.
1953 Assume point is at export-block beginning."
1960 ;; Incomplete block: parse it as a paragraph.
1973 contents-end)))
1977 :end end
1978 :type type
1979 :value value
1985 "Interpret EXPORT-BLOCK element as Org syntax.
1986 CONTENTS is nil."
1993 ;;;; Fixed-width
1996 "Parse a fixed-width section.
1998 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1999 the buffer position at the beginning of the first affiliated
2000 keyword and CDR is a plist of affiliated keywords along with
2001 their value.
2003 Return a list whose CAR is `fixed-width' and CDR is a plist
2004 containing `:begin', `:end', `:value', `:post-blank' and
2005 `:post-affiliated' keywords.
2007 Assume point is at the beginning of the fixed-width area."
2011 value
2016 ;; Accumulate text without starting colons.
2029 :end end
2030 :value value
2036 "Interpret FIXED-WIDTH element as Org syntax.
2037 CONTENTS is nil."
2045 ;;;; Horizontal Rule
2048 "Parse an horizontal rule.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2056 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2057 keywords."
2067 :end end
2073 "Interpret HORIZONTAL-RULE element as Org syntax.
2074 CONTENTS is nil."
2078 ;;;; Keyword
2081 "Parse a keyword at point.
2083 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2084 the buffer position at the beginning of the first affiliated
2085 keyword and CDR is a plist of affiliated keywords along with
2086 their value.
2088 Return a list whose CAR is `keyword' and CDR is a plist
2089 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2090 `:post-affiliated' keywords."
2092 ;; An orphaned affiliated keyword is considered as a regular
2093 ;; keyword. In this case AFFILIATED is nil, so we take care of
2094 ;; this corner case.
2107 :value value
2108 :begin begin
2109 :end end
2115 "Interpret KEYWORD element as Org syntax.
2116 CONTENTS is nil."
2122 ;;;; Latex Environment
2126 "Regexp matching the beginning of a LaTeX environment.
2127 The environment is captured by the first group.
2133 "Format string matching the ending of a LaTeX environment.
2137 "Parse a LaTeX environment.
2139 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2140 the buffer position at the beginning of the first affiliated
2141 keyword and CDR is a plist of affiliated keywords along with
2142 their value.
2144 Return a list whose CAR is `latex-environment' and CDR is a plist
2145 containing `:begin', `:end', `:value', `:post-blank' and
2146 `:post-affiliated' keywords.
2148 Assume point is at the beginning of the latex environment."
2155 limit t))
2156 ;; Incomplete latex environment: parse it as a paragraph.
2166 :end end
2167 :value value
2173 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2174 CONTENTS is nil."
2178 ;;;; Node Property
2181 "Parse a node-property at point.
2183 LIMIT bounds the search.
2185 Return a list whose CAR is `node-property' and CDR is a plist
2186 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2187 `:post-affiliated' keywords."
2197 limit))))
2200 :value value
2201 :begin begin
2202 :end end
2207 "Interpret NODE-PROPERTY element as Org syntax.
2208 CONTENTS is nil."
2214 ;;;; Paragraph
2217 "Parse a paragraph.
2219 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2220 the buffer position at the beginning of the first affiliated
2221 keyword and CDR is a plist of affiliated keywords along with
2222 their value.
2224 Return a list whose CAR is `paragraph' and CDR is a plist
2225 containing `:begin', `:end', `:contents-begin' and
2226 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2228 Assume point is at the beginning of the paragraph."
2235 ;; A matching `org-element-paragraph-separate' is not
2236 ;; necessarily the end of the paragraph. In particular,
2237 ;; drawers, blocks or LaTeX environments opening lines
2238 ;; must be closed. Moreover keywords with a secondary
2239 ;; value must belong to "dual keywords".
2253 limit t)))
2259 limit t)))
2262 org-element-dual-keywords))
2263 ;; Everything else is unambiguous.
2276 :end end
2277 :contents-begin contents-begin
2278 :contents-end contents-end
2284 "Interpret PARAGRAPH element as Org syntax.
2285 CONTENTS is the contents of the element."
2286 contents)
2289 ;;;; Planning
2292 "Parse a planning.
2294 LIMIT bounds the search.
2296 Return a list whose CAR is `planning' and CDR is a plist
2297 containing `:closed', `:deadline', `:scheduled', `:begin',
2298 `:end', `:post-blank' and `:post-affiliated' keywords."
2308 closed deadline scheduled)
2320 :deadline deadline
2321 :scheduled scheduled
2322 :begin begin
2323 :end end
2324 :post-blank post-blank
2328 "Interpret PLANNING element as Org syntax.
2329 CONTENTS is nil."
2331 'identity
2348 ;;;; Src Block
2351 "Parse a src block.
2353 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2354 the buffer position at the beginning of the first affiliated
2355 keyword and CDR is a plist of affiliated keywords along with
2356 their value.
2358 Return a list whose CAR is `src-block' and CDR is a plist
2359 containing `:language', `:switches', `:parameters', `:begin',
2360 `:end', `:number-lines', `:retain-labels', `:use-labels',
2361 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2362 `:post-affiliated' keywords.
2364 Assume point is at the beginning of the block."
2367 limit t)))
2368 ;; Incomplete block: parse it as a paragraph.
2374 ;; Get language as a string.
2383 ;; Get switches.
2385 ;; Get parameters.
2387 ;; Switches analysis
2398 ;; Should labels be retained in (or stripped from)
2399 ;; src blocks?
2404 ;; What should code-references use - labels or
2405 ;; line-numbers?
2410 ;; Indentation.
2412 ;; Retrieve code.
2417 block-ind))
2421 ;; Get position after ending blank lines.
2431 :begin begin
2432 :end end
2433 :number-lines number-lines
2434 :preserve-indent preserve-indent
2435 :retain-labels retain-labels
2436 :use-labels use-labels
2437 :label-fmt label-fmt
2438 :value value
2444 "Interpret SRC-BLOCK element as Org syntax.
2445 CONTENTS is nil."
2454 val)
2468 ;;;; Table
2471 "Parse a table at point.
2473 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2474 the buffer position at the beginning of the first affiliated
2475 keyword and CDR is a plist of affiliated keywords along with
2476 their value.
2478 Return a list whose CAR is `table' and CDR is a plist containing
2479 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2480 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2481 keywords.
2483 Assume point is at the beginning of the table."
2497 acc))
2504 :end end
2505 :type type
2506 :tblfm tblfm
2507 ;; Only `org' tables have contents. `table.el' tables
2508 ;; use a `:value' property to store raw table as
2509 ;; a string.
2514 table-begin table-end))
2520 "Interpret TABLE element as Org syntax.
2521 CONTENTS is a string, if table's type is `org', or nil."
2532 ;;;; Table Row
2535 "Parse table row at point.
2537 LIMIT bounds the search.
2539 Return a list whose CAR is `table-row' and CDR is a plist
2540 containing `:begin', `:end', `:contents-begin', `:contents-end',
2541 `:type', `:post-blank' and `:post-affiliated' keywords."
2545 ;; A table rule has no contents. In that case, ensure
2546 ;; CONTENTS-BEGIN matches CONTENTS-END.
2558 :begin begin
2559 :end end
2560 :contents-begin contents-begin
2561 :contents-end contents-end
2566 "Interpret TABLE-ROW element as Org syntax.
2567 CONTENTS is the contents of the table row."
2572 ;;;; Verse Block
2575 "Parse a verse block.
2577 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2578 the buffer position at the beginning of the first affiliated
2579 keyword and CDR is a plist of affiliated keywords along with
2580 their value.
2582 Return a list whose CAR is `verse-block' and CDR is a plist
2583 containing `:begin', `:end', `:contents-begin', `:contents-end',
2584 `:post-blank' and `:post-affiliated' keywords.
2586 Assume point is at beginning of the block."
2590 ;; Incomplete block: parse it as a paragraph.
2605 :end end
2606 :contents-begin contents-begin
2607 :contents-end contents-end
2613 "Interpret VERSE-BLOCK element as Org syntax.
2614 CONTENTS is verse block contents."
2618 \f
2619 ;;; Objects
2620 ;;
2621 ;; Unlike to elements, raw text can be found between objects. Hence,
2622 ;; `org-element--object-lex' is provided to find the next object in
2623 ;; buffer.
2624 ;;
2625 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2626 ;; object types they can contain will be specified in
2627 ;; `org-element-object-restrictions'.
2628 ;;
2629 ;; Creating a new type of object requires to alter
2630 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2631 ;; new type in `org-element-all-objects', and possibly add
2632 ;; restrictions in `org-element-object-restrictions'.
2634 ;;;; Bold
2637 "Parse bold object at point, if any.
2639 When at a bold object, return a list whose car is `bold' and cdr
2640 is a plist with `:begin', `:end', `:contents-begin' and
2641 `:contents-end' and `:post-blank' keywords. Otherwise, return
2642 nil.
2644 Assume point is at the first star marker."
2656 :end end
2657 :contents-begin contents-begin
2658 :contents-end contents-end
2662 "Interpret BOLD object as Org syntax.
2663 CONTENTS is the contents of the object."
2667 ;;;; Code
2670 "Parse code object at point, if any.
2672 When at a code object, return a list whose car is `code' and cdr
2673 is a plist with `:value', `:begin', `:end' and `:post-blank'
2674 keywords. Otherwise, return nil.
2676 Assume point is at the first tilde marker."
2687 :begin begin
2688 :end end
2692 "Interpret CODE object as Org syntax.
2693 CONTENTS is nil."
2697 ;;;; Entity
2700 "Parse entity at point, if any.
2702 When at an entity, return a list whose car is `entity' and cdr
2703 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2704 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2705 `:post-blank' as keywords. Otherwise, return nil.
2707 Assume point is at the beginning of the entity."
2709 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2727 :begin begin
2728 :end end
2729 :use-brackets-p bracketsp
2733 "Interpret ENTITY object as Org syntax.
2734 CONTENTS is nil."
2740 ;;;; Export Snippet
2743 "Parse export snippet at point.
2745 When at an export snippet, return a list whose car is
2746 `export-snippet' and cdr a plist with `:begin', `:end',
2747 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2748 return nil.
2750 Assume point is at the beginning of the snippet."
2766 :value value
2767 :begin begin
2768 :end end
2772 "Interpret EXPORT-SNIPPET object as Org syntax.
2773 CONTENTS is nil."
2779 ;;;; Footnote Reference
2782 "Parse footnote reference at point, if any.
2784 When at a footnote reference, return a list whose car is
2785 `footnote-reference' and cdr a plist with `:label', `:type',
2786 `:begin', `:end', `:content-begin', `:contents-end' and
2787 `:post-blank' as keywords. Otherwise, return nil."
2807 :type type
2808 :begin begin
2809 :end end
2815 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2816 CONTENTS is its definition, when inline, or nil."
2822 ;;;; Inline Babel Call
2825 "Parse inline babel call at point, if any.
2827 When at an inline babel call, return a list whose car is
2828 `inline-babel-call' and cdr a plist with `:call',
2829 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2830 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2832 Assume point is at the beginning of the babel call."
2848 :inside-header inside-header
2849 :arguments arguments
2850 :end-header end-header
2851 :begin begin
2852 :end end
2853 :value value
2857 "Interpret INLINE-BABEL-CALL object as Org syntax.
2858 CONTENTS is nil."
2868 ;;;; Inline Src Block
2871 "Parse inline source block at point, if any.
2873 When at an inline source block, return a list whose car is
2874 `inline-src-block' and cdr a plist with `:begin', `:end',
2875 `:language', `:value', `:parameters' and `:post-blank' as
2876 keywords. Otherwise, return nil.
2878 Assume point is at the beginning of the inline src block."
2891 :value value
2892 :parameters parameters
2893 :begin begin
2894 :end end
2898 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2899 CONTENTS is nil."
2904 language
2906 body)))
2908 ;;;; Italic
2911 "Parse italic object at point, if any.
2913 When at an italic object, return a list whose car is `italic' and
2914 cdr is a plist with `:begin', `:end', `:contents-begin' and
2915 `:contents-end' and `:post-blank' keywords. Otherwise, return
2916 nil.
2918 Assume point is at the first slash marker."
2930 :end end
2931 :contents-begin contents-begin
2932 :contents-end contents-end
2936 "Interpret ITALIC object as Org syntax.
2937 CONTENTS is the contents of the object."
2941 ;;;; Latex Fragment
2944 "Parse LaTeX fragment at point, if any.
2946 When at a LaTeX fragment, return a list whose car is
2947 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2948 and `:post-blank' as keywords. Otherwise, return nil.
2950 Assume point is at the beginning of the LaTeX fragment."
2968 ;; Macro.
2977 :begin begin
2978 :end end
2982 "Interpret LATEX-FRAGMENT object as Org syntax.
2983 CONTENTS is nil."
2986 ;;;; Line Break
2989 "Parse line break at point, if any.
2991 When at a line break, return a list whose car is `line-break',
2992 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2993 Otherwise, return nil.
2995 Assume point is at the beginning of the line break."
3004 "Interpret LINE-BREAK object as Org syntax.
3005 CONTENTS is nil."
3009 ;;;; Link
3012 "Parse link at point, if any.
3014 When at a link, return a list whose car is `link' and cdr a plist
3015 with `:type', `:path', `:raw-link', `:application',
3016 `:search-option', `:begin', `:end', `:contents-begin',
3017 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3018 nil.
3020 Assume point is at the beginning of the link."
3023 end contents-begin contents-end link-end post-blank path type
3024 raw-link link search-option application)
3026 ;; Type 1: Text targeted from a radio target.
3035 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3040 ;; RAW-LINK is the original link. Expand any
3041 ;; abbreviation in it.
3045 ;; Determine TYPE of link and set PATH accordingly.
3047 ;; File type.
3051 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3054 ;; According to RFC 3986, extra whitespace should be
3055 ;; ignored when a URI is extracted.
3058 ;; Id type: PATH is the id.
3061 ;; Code-ref type: PATH is the name of the reference.
3064 ;; Custom-id type: PATH is the name of the custom id.
3067 ;; Fuzzy type: Internal link either matches a target, an
3068 ;; headline name or nothing. PATH is the target or
3069 ;; headline's name.
3071 ;; Type 3: Plain link, e.g., http://orgmode.org
3077 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3085 ;; In any case, deduce end point after trailing white space from
3086 ;; LINK-END variable.
3090 ;; Special "file" type link processing. Extract opening
3091 ;; application and search option, if any. Also normalize URI.
3100 :path path
3102 :application application
3103 :search-option search-option
3104 :begin begin
3105 :end end
3106 :contents-begin contents-begin
3107 :contents-end contents-end
3111 "Interpret LINK object as Org syntax.
3112 CONTENTS is the contents of the object, or nil."
3117 raw-link
3121 ;;;; Macro
3124 "Parse macro at point, if any.
3126 When at a macro, return a list whose car is `macro' and cdr
3127 a plist with `:key', `:args', `:begin', `:end', `:value' and
3128 `:post-blank' as keywords. Otherwise, return nil.
3130 Assume point is at the macro."
3143 :value value
3144 :args args
3145 :begin begin
3146 :end end
3150 "Interpret MACRO object as Org syntax.
3151 CONTENTS is nil."
3155 ;;;; Radio-target
3158 "Parse radio target at point, if any.
3160 When at a radio target, return a list whose car is `radio-target'
3161 and cdr a plist with `:begin', `:end', `:contents-begin',
3162 `:contents-end', `:value' and `:post-blank' as keywords.
3163 Otherwise, return nil.
3165 Assume point is at the radio target."
3177 :end end
3178 :contents-begin contents-begin
3179 :contents-end contents-end
3180 :post-blank post-blank
3184 "Interpret TARGET object as Org syntax.
3185 CONTENTS is the contents of the object."
3189 ;;;; Statistics Cookie
3192 "Parse statistics cookie at point, if any.
3194 When at a statistics cookie, return a list whose car is
3195 `statistics-cookie', and cdr a plist with `:begin', `:end',
3196 `:value' and `:post-blank' keywords. Otherwise, return nil.
3198 Assume point is at the beginning of the statistics-cookie."
3209 :end end
3210 :value value
3214 "Interpret STATISTICS-COOKIE object as Org syntax.
3215 CONTENTS is nil."
3219 ;;;; Strike-Through
3222 "Parse strike-through object at point, if any.
3224 When at a strike-through object, return a list whose car is
3225 `strike-through' and cdr is a plist with `:begin', `:end',
3226 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3227 Otherwise, return nil.
3229 Assume point is at the first plus sign marker."
3241 :end end
3242 :contents-begin contents-begin
3243 :contents-end contents-end
3247 "Interpret STRIKE-THROUGH object as Org syntax.
3248 CONTENTS is the contents of the object."
3252 ;;;; Subscript
3255 "Parse subscript at point, if any.
3257 When at a subscript object, return a list whose car is
3258 `subscript' and cdr a plist with `:begin', `:end',
3259 `:contents-begin', `:contents-end', `:use-brackets-p' and
3260 `:post-blank' as keywords. Otherwise, return nil.
3262 Assume point is at the underscore."
3276 :end end
3277 :use-brackets-p bracketsp
3278 :contents-begin contents-begin
3279 :contents-end contents-end
3283 "Interpret SUBSCRIPT object as Org syntax.
3284 CONTENTS is the contents of the object."
3287 contents))
3290 ;;;; Superscript
3293 "Parse superscript at point, if any.
3295 When at a superscript object, return a list whose car is
3296 `superscript' and cdr a plist with `:begin', `:end',
3297 `:contents-begin', `:contents-end', `:use-brackets-p' and
3298 `:post-blank' as keywords. Otherwise, return nil.
3300 Assume point is at the caret."
3314 :end end
3315 :use-brackets-p bracketsp
3316 :contents-begin contents-begin
3317 :contents-end contents-end
3321 "Interpret SUPERSCRIPT object as Org syntax.
3322 CONTENTS is the contents of the object."
3325 contents))
3328 ;;;; Table Cell
3331 "Parse table cell at point.
3332 Return a list whose car is `table-cell' and cdr is a plist
3333 containing `:begin', `:end', `:contents-begin', `:contents-end'
3334 and `:post-blank' keywords."
3342 :end end
3343 :contents-begin contents-begin
3344 :contents-end contents-end
3348 "Interpret TABLE-CELL element as Org syntax.
3349 CONTENTS is the contents of the cell, or nil."
3353 ;;;; Target
3356 "Parse target at point, if any.
3358 When at a target, return a list whose car is `target' and cdr
3359 a plist with `:begin', `:end', `:value' and `:post-blank' as
3360 keywords. Otherwise, return nil.
3362 Assume point is at the target."
3372 :end end
3373 :value value
3377 "Interpret TARGET object as Org syntax.
3378 CONTENTS is nil."
3382 ;;;; Timestamp
3393 "Parse time stamp at point, if any.
3395 When at a time stamp, return a list whose car is `timestamp', and
3396 cdr a plist with `:type', `:raw-value', `:year-start',
3397 `:month-start', `:day-start', `:hour-start', `:minute-start',
3398 `:year-end', `:month-end', `:day-end', `:hour-end',
3399 `:minute-end', `:repeater-type', `:repeater-value',
3400 `:repeater-unit', `:warning-type', `:warning-value',
3401 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3402 Otherwise, return nil.
3404 Assume point is at the beginning of the timestamp."
3423 date-start)
3434 raw-value)
3436 :repeater-type
3442 :repeater-unit
3451 :warning-unit
3454 year-start month-start day-start hour-start minute-start year-end
3455 month-end day-end hour-end minute-end)
3456 ;; Parse date-start.
3464 ;; Compute date-end. It can be provided directly in time-stamp,
3465 ;; or extracted from time range. Otherwise, it defaults to the
3466 ;; same values as date-start.
3476 :raw-value raw-value
3477 :year-start year-start
3478 :month-start month-start
3479 :day-start day-start
3480 :hour-start hour-start
3481 :minute-start minute-start
3482 :year-end year-end
3483 :month-end month-end
3484 :day-end day-end
3485 :hour-end hour-end
3486 :minute-end minute-end
3487 :begin begin
3488 :end end
3490 repeater-props
3491 warning-props))))))
3494 "Interpret TIMESTAMP object as Org syntax.
3495 CONTENTS is nil."
3514 ;; Build an Org timestamp string from TIME. ACTIVEP is
3515 ;; non-nil when time stamp is active. If WITH-TIME-P is
3516 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3517 ;; specify a time range in the timestamp. REPEAT-STRING is
3518 ;; the repeater string, if any.
3522 org-time-stamp-formats)
3523 time)))
3529 nil nil ts)))
3534 " "
3535 s
3537 ;; Return value.
3538 ts)))
3550 build-ts-string
3569 0
3577 "--"
3590 ;;;; Underline
3593 "Parse underline object at point, if any.
3595 When at an underline object, return a list whose car is
3596 `underline' and cdr is a plist with `:begin', `:end',
3597 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3598 Otherwise, return nil.
3600 Assume point is at the first underscore marker."
3612 :end end
3613 :contents-begin contents-begin
3614 :contents-end contents-end
3618 "Interpret UNDERLINE object as Org syntax.
3619 CONTENTS is the contents of the object."
3623 ;;;; Verbatim
3626 "Parse verbatim object at point, if any.
3628 When at a verbatim object, return a list whose car is `verbatim'
3629 and cdr is a plist with `:value', `:begin', `:end' and
3630 `:post-blank' keywords. Otherwise, return nil.
3632 Assume point is at the first equal sign marker."
3643 :begin begin
3644 :end end
3648 "Interpret VERBATIM object as Org syntax.
3649 CONTENTS is nil."
3653 \f
3654 ;;; Parsing Element Starting At Point
3655 ;;
3656 ;; `org-element--current-element' is the core function of this section.
3657 ;; It returns the Lisp representation of the element starting at
3658 ;; point.
3659 ;;
3660 ;; `org-element--current-element' makes use of special modes. They
3661 ;; are activated for fixed element chaining (e.g., `plain-list' >
3662 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3663 ;; `section'). Special modes are: `first-section', `item',
3664 ;; `node-property', `section' and `table-row'.
3667 "Parse the element starting at point.
3669 Return value is a list like (TYPE PROPS) where TYPE is the type
3670 of the element and PROPS a plist of properties associated to the
3671 element.
3673 Possible types are defined in `org-element-all-elements'.
3675 LIMIT bounds the search.
3677 Optional argument GRANULARITY determines the depth of the
3678 recursion. Allowed values are `headline', `greater-element',
3679 `element', `object' or nil. When it is broader than `object' (or
3680 nil), secondary values will not be parsed, since they only
3681 contain objects.
3683 Optional argument MODE, when non-nil, can be either
3684 `first-section', `section', `planning', `item', `node-property'
3685 and `table-row'.
3687 If STRUCTURE isn't provided but MODE is set to `item', it will be
3688 computed.
3690 This function assumes point is always at the beginning of the
3691 element it has to parse."
3694 ;; Determine if parsing depth allows for secondary strings
3695 ;; parsing. It only applies to elements referenced in
3696 ;; `org-element-secondary-value-alist'.
3699 ;; Item.
3702 ;; Table Row.
3704 ;; Node Property.
3706 ;; Headline.
3709 ;; Sections (must be checked after headline).
3714 limit)))
3715 ;; Planning.
3718 ;; Property drawer.
3722 ;; When not at bol, point is at the beginning of an item or
3723 ;; a footnote definition: next item is always a paragraph.
3725 ;; Clock.
3727 ;; Inlinetask.
3730 ;; From there, elements can have affiliated keywords.
3733 ;; Jumping over affiliated keywords put point off-limits.
3734 ;; Parse them as regular keywords.
3738 ;; LaTeX Environment.
3741 ;; Drawer and Property Drawer.
3744 ;; Fixed Width
3747 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3748 ;; Keywords.
3757 org-element-block-name-alist)))
3772 ;; Footnote Definition.
3775 ;; Horizontal Rule.
3778 ;; Diary Sexp.
3781 ;; Table.
3783 ;; List.
3786 limit affiliated
3788 ;; Default element: Paragraph.
3792 ;; Most elements can have affiliated keywords. When looking for an
3793 ;; element beginning, we want to move before them, as they belong to
3794 ;; that element, and, in the meantime, collect information they give
3795 ;; into appropriate properties. Hence the following function.
3798 "Collect affiliated keywords from point down to LIMIT.
3800 Return a list whose CAR is the position at the first of them and
3801 CDR a plist of keywords and values and move point to the
3802 beginning of the first line after them.
3804 As a special case, if element doesn't start at the beginning of
3805 the line (e.g., a paragraph starting an item), CAR is current
3806 position of point and CDR is nil."
3810 ;; RESTRICT is the list of objects allowed in parsed
3811 ;; keywords value.
3813 output)
3816 ;; Apply translation to RAW-KWD. From there, KWD is
3817 ;; the official keyword.
3819 org-element-keyword-translation-alist))
3820 raw-kwd))
3821 ;; Find main value for any keyword.
3827 ;; PARSEDP is non-nil when keyword should have its
3828 ;; value parsed.
3830 ;; If KWD is a dual keyword, find its secondary
3831 ;; value. Maybe parse it.
3839 ;; Attribute a property name to KWD.
3841 ;; Now set final shape for VALUE.
3847 nil restrict)))
3851 ;; Attributes can always appear on multiple lines.
3854 ;; Eventually store the new value in OUTPUT.
3856 ;; Move to next keyword.
3858 ;; If affiliated keywords are orphaned: move back to first one.
3859 ;; They will be parsed as a paragraph.
3861 ;; Return value.
3865 \f
3866 ;;; The Org Parser
3867 ;;
3868 ;; The two major functions here are `org-element-parse-buffer', which
3869 ;; parses Org syntax inside the current buffer, taking into account
3870 ;; region, narrowing, or even visibility if specified, and
3871 ;; `org-element-parse-secondary-string', which parses objects within
3872 ;; a given string.
3873 ;;
3874 ;; The (almost) almighty `org-element-map' allows to apply a function
3875 ;; on elements or objects matching some type, and accumulate the
3876 ;; resulting values. In an export situation, it also skips unneeded
3877 ;; parts of the parse tree.
3880 "Recursively parse the buffer and return structure.
3881 If narrowing is in effect, only parse the visible part of the
3882 buffer.
3884 Optional argument GRANULARITY determines the depth of the
3885 recursion. It can be set to the following symbols:
3887 `headline' Only parse headlines.
3888 `greater-element' Don't recurse into greater elements excepted
3889 headlines and sections. Thus, elements
3890 parsed are the top-level ones.
3891 `element' Parse everything but objects and plain text.
3892 `object' Parse the complete buffer (default).
3894 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3895 elements.
3897 An element or an objects is represented as a list with the
3898 pattern (TYPE PROPERTIES CONTENTS), where :
3900 TYPE is a symbol describing the element or object. See
3901 `org-element-all-elements' and `org-element-all-objects' for an
3902 exhaustive list of such symbols. One can retrieve it with
3903 `org-element-type' function.
3905 PROPERTIES is the list of attributes attached to the element or
3906 object, as a plist. Although most of them are specific to the
3907 element or object type, all types share `:begin', `:end',
3908 `:post-blank' and `:parent' properties, which respectively
3909 refer to buffer position where the element or object starts,
3910 ends, the number of white spaces or blank lines after it, and
3911 the element or object containing it. Properties values can be
3912 obtained by using `org-element-property' function.
3914 CONTENTS is a list of elements, objects or raw strings
3915 contained in the current element or object, when applicable.
3916 One can access them with `org-element-contents' function.
3918 The Org buffer has `org-data' as type and nil as properties.
3919 `org-element-map' function can be used to find specific elements
3920 or objects within the parse tree.
3922 This function assumes that current major mode is `org-mode'."
3928 ;; Start in `first-section' mode so text before the first
3929 ;; headline belongs to a section.
3933 "Recursively parse objects in STRING and return structure.
3935 RESTRICTION is a symbol limiting the object types that will be
3936 looked after.
3938 Optional argument PARENT, when non-nil, is the element or object
3939 containing the secondary string. It is used to set correctly
3940 `:parent' property within the string.
3942 If STRING is the empty string or nil, return nil."
3958 data))))))
3962 "Map a function on selected elements or objects.
3964 DATA is a parse tree, an element, an object, a string, or a list
3965 of such constructs. TYPES is a symbol or list of symbols of
3966 elements or objects types (see `org-element-all-elements' and
3967 `org-element-all-objects' for a complete list of types). FUN is
3968 the function called on the matching element or object. It has to
3969 accept one argument: the element or object itself.
3971 When optional argument INFO is non-nil, it should be a plist
3972 holding export options. In that case, parts of the parse tree
3973 not exportable according to that property list will be skipped.
3975 When optional argument FIRST-MATCH is non-nil, stop at the first
3976 match for which FUN doesn't return nil, and return that value.
3978 Optional argument NO-RECURSION is a symbol or a list of symbols
3979 representing elements or objects types. `org-element-map' won't
3980 enter any recursive element or object whose type belongs to that
3981 list. Though, FUN can still be applied on them.
3983 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3984 apply to matching objects within parsed affiliated keywords (see
3985 `org-element-parsed-keywords').
3987 Nil values returned from FUN do not appear in the results.
3990 Examples:
3991 ---------
3993 Assuming TREE is a variable containing an Org buffer parse tree,
3994 the following example will return a flat list of all `src-block'
3995 and `example-block' elements in it:
3997 \(org-element-map tree '(example-block src-block) #'identity)
3999 The following snippet will find the first headline with a level
4002 \(org-element-map tree 'headline
4003 \(lambda (hl)
4004 \(and (= (org-element-property :level hl) 1)
4006 \(org-element-property :begin hl)))
4007 nil t)
4009 The next example will return a flat list of all `plain-list' type
4010 elements in TREE that are not a sub-list themselves:
4012 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4014 Eventually, this example will return a flat list of all `bold'
4015 type objects containing a `latex-snippet' type object, even
4016 looking into captions:
4018 \(org-element-map tree 'bold
4019 \(lambda (b)
4020 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4021 nil nil nil t)"
4022 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4026 ;; Recursion depth is determined by --CATEGORY.
4033 ;; If one object is found, the function has to
4034 ;; recurse into every object.
4037 ;; If one regular element is found, the
4038 ;; function has to recurse, at least, into
4039 ;; every element it encounters.
4042 --acc
4043 --walk-tree
4046 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4047 ;; holding contextual information.
4051 ;; Ignored element in an export context.
4053 ;; List of elements or objects.
4055 ;; Unconditionally enter parse trees.
4059 ;; Check if TYPE is matching among TYPES. If so,
4060 ;; apply FUN to --DATA and accumulate return value
4061 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4067 ;; If --DATA has a secondary string that can contain
4068 ;; objects with their type among TYPES, look into it.
4071 org-element-secondary-value-alist)))
4073 ;; If --DATA has any parsed affiliated keywords and
4074 ;; WITH-AFFILIATED is non-nil, look for objects in
4075 ;; them.
4082 ;; Pay attention to the type of parsed keyword.
4083 ;; In particular, preserve order for multiple
4084 ;; keywords.
4097 ;; Determine if a recursion into --DATA is possible.
4099 ;; --TYPE is explicitly removed from recursion.
4101 ;; --DATA has no contents.
4103 ;; Looking for greater elements but --DATA is simply
4104 ;; an element or an object.
4107 ;; Looking for elements but --DATA is an object.
4110 ;; In any other case, map contents.
4114 ;; Return value in a proper order.
4118 ;; The following functions are internal parts of the parser.
4119 ;;
4120 ;; The first one, `org-element--parse-elements' acts at the element's
4121 ;; level.
4122 ;;
4123 ;; The second one, `org-element--parse-objects' applies on all objects
4124 ;; of a paragraph or a secondary string. It calls
4125 ;; `org-element--object-lex' to find the next object in the current
4126 ;; container.
4129 "Return next special mode according to TYPE, or nil.
4130 TYPE is a symbol representing the type of an element or object
4131 containing next element if PARENTP is non-nil, or before it
4132 otherwise. Modes can be either `first-section', `item',
4133 `node-property', `planning', `property-drawer', `section',
4134 `table-row' or nil."
4150 "Parse elements between BEG and END positions.
4152 MODE prioritizes some elements over the others. It can be set to
4153 `first-section', `section', `planning', `item', `node-property'
4154 or `table-row'.
4156 When value is `item', STRUCTURE will be used as the current list
4157 structure.
4159 GRANULARITY determines the depth of the recursion. See
4160 `org-element-parse-buffer' for more information.
4162 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4163 elements.
4165 Elements are accumulated into ACC."
4168 ;; Visible only: skip invisible parts at the beginning of the
4169 ;; element.
4172 ;; When parsing only headlines, skip any text before first one.
4175 ;; Main loop start.
4177 ;; Find current element's type and parse it accordingly to
4178 ;; its category.
4180 end granularity mode structure))
4184 ;; Visible only: skip invisible parts between siblings.
4187 ;; Fill ELEMENT contents by side-effect.
4189 ;; If element has no contents, don't modify it.
4191 ;; Greater element: parse it between `contents-begin' and
4192 ;; `contents-end'. Make sure GRANULARITY allows the
4193 ;; recursion, or ELEMENT is a headline, in which case going
4194 ;; inside is mandatory, in order to get sub-level headings.
4202 ;; Possibly switch to a special mode.
4206 granularity visible-only element))
4207 ;; ELEMENT has contents. Parse objects inside, if
4208 ;; GRANULARITY allows it.
4214 ;; Update mode.
4216 ;; Return result.
4217 acc))
4220 "Return next object in current buffer or nil.
4221 RESTRICTION is a list of object types, as symbols, that should be
4222 looked after. This function assumes that the buffer is narrowed
4223 to an appropriate container (e.g., a paragraph)."
4231 found)
4296 ;; This is probably a plain link.
4302 ;; Radio link.
4307 "Parse objects between BEG and END and return recursive structure.
4309 Objects are accumulated in ACC.
4311 RESTRICTION is a list of object successors which are allowed in
4312 the current object."
4320 ;; 1. Text before any object. Untabify it.
4325 acc
4329 ;; 2. Object...
4332 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4333 ;; a recursive type.
4341 ;; 3. Text after last object. Untabify it.
4345 acc
4349 ;; Result.
4350 acc)))
4353 \f
4354 ;;; Towards A Bijective Process
4355 ;;
4356 ;; The parse tree obtained with `org-element-parse-buffer' is really
4357 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4358 ;; interpreted and expanded into a string with canonical Org syntax.
4359 ;; Hence `org-element-interpret-data'.
4360 ;;
4361 ;; The function relies internally on
4362 ;; `org-element--interpret-affiliated-keywords'.
4364 ;;;###autoload
4366 "Interpret DATA as Org syntax.
4367 DATA is a parse tree, an element, an object or a secondary string
4368 to interpret. Return Org syntax as a string."
4372 "Interpret DATA as Org syntax.
4374 DATA is a parse tree, an element, an object or a secondary string
4375 to interpret. PARENT is used for recursive calls. It contains
4376 the element or object containing data, or nil.
4378 Return Org syntax as a string."
4380 ;; Find interpreter for current object or element. If it
4381 ;; doesn't exist (e.g. this is a pseudo object or element),
4382 ;; return contents, if any.
4388 ;; Secondary string.
4392 ;; Full Org document.
4396 ;; Plain text: return it.
4398 ;; Element or object without contents.
4400 ;; Element or object with contents.
4403 ;; Recursively interpret contents.
4408 data
4409 ;; Fix indentation of elements containing
4410 ;; objects. We ignore `table-row' elements
4411 ;; as they are one line long anyway.
4413 data
4414 ;; When normalizing first paragraph of an
4415 ;; item or a footnote-definition, ignore
4416 ;; first line's indentation.
4423 ;; Build white spaces. If no `:post-blank' property is
4424 ;; specified, assume its value is 0.
4438 "Return ELEMENT's affiliated keywords as Org syntax.
4439 If there is no affiliated keyword, return the empty string."
4449 ": "
4452 value)
4460 ;; All attribute keywords can have multiple lines.
4466 ;; List all ELEMENT's properties matching an attribute line or an
4467 ;; affiliated keyword, but ignore translated keywords since they
4468 ;; cannot belong to the property list.
4475 org-element-keyword-translation-alist)))))
4476 collect prop)
4479 ;; Because interpretation of the parse tree must return the same
4480 ;; number of blank lines between elements and the same number of white
4481 ;; space after objects, some special care must be given to white
4482 ;; spaces.
4483 ;;
4484 ;; The first function, `org-element-normalize-string', ensures any
4485 ;; string different from the empty string will end with a single
4486 ;; newline character.
4487 ;;
4488 ;; The second function, `org-element-normalize-contents', removes
4489 ;; global indentation from the contents of the current element.
4492 "Ensure string S ends with a single newline character.
4494 If S isn't a string return it unchanged. If S is the empty
4495 string, return it. Otherwise, return a new string with a single
4496 newline character at its end."
4504 "Normalize plain text in ELEMENT's contents.
4506 ELEMENT must only contain plain text and objects.
4508 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4509 indentation to compute maximal common indentation.
4511 Return the normalized element that is element with global
4512 indentation removed from its contents. The function assumes that
4513 indentation is not done with TAB characters."
4515 find-min-ind ; For byte-compiler.
4517 ;; Return minimal common indentation within BLOB. This is
4518 ;; done by walking recursively BLOB and updating MIN-IND
4519 ;; along the way. FIRST-FLAG is non-nil when the next
4520 ;; object is expected to be a string that doesn't start with
4521 ;; a newline character. It happens for strings at the
4522 ;; beginnings of the contents or right after a line break.
4527 ;; Objects cannot start with spaces: in this case,
4528 ;; indentation is 0.
4532 ;; An indentation of zero means no string will be
4533 ;; modified. Quit the process.
4544 ;; Find minimal indentation in ELEMENT.
4547 ;; Build ELEMENT back, replacing each string with the same
4548 ;; string minus common indentation.
4552 ;; Return BLOB with all its strings indentation
4553 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4554 ;; non-nil when the next object is expected to be
4555 ;; a string that doesn't start with a newline
4556 ;; character.
4572 org-element-recursive-objects)
4576 object)
4579 blob)))
4583 \f
4584 ;;; Cache
4585 ;;
4586 ;; Implement a caching mechanism for `org-element-at-point' and
4587 ;; `org-element-context', which see.
4588 ;;
4589 ;; A single public function is provided: `org-element-cache-reset'.
4590 ;;
4591 ;; Cache is enabled by default, but can be disabled globally with
4592 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4593 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4594 ;; can be tweaked to control caching behaviour.
4595 ;;
4596 ;; Internally, parsed elements are stored in an AVL tree,
4597 ;; `org-element--cache'. This tree is updated lazily: whenever
4598 ;; a change happens to the buffer, a synchronization request is
4599 ;; registered in `org-element--cache-sync-requests' (see
4600 ;; `org-element--cache-submit-request'). During idle time, requests
4601 ;; are processed by `org-element--cache-sync'. Synchronization also
4602 ;; happens when an element is required from the cache. In this case,
4603 ;; the process stops as soon as the needed element is up-to-date.
4604 ;;
4605 ;; A synchronization request can only apply on a synchronized part of
4606 ;; the cache. Therefore, the cache is updated at least to the
4607 ;; location where the new request applies. Thus, requests are ordered
4608 ;; from left to right and all elements starting before the first
4609 ;; request are correct. This property is used by functions like
4610 ;; `org-element--cache-find' to retrieve elements in the part of the
4611 ;; cache that can be trusted.
4612 ;;
4613 ;; A request applies to every element, starting from its original
4614 ;; location (or key, see below). When a request is processed, it
4615 ;; moves forward and may collide the next one. In this case, both
4616 ;; requests are merged into a new one that starts from that element.
4617 ;; As a consequence, the whole synchronization complexity does not
4618 ;; depend on the number of pending requests, but on the number of
4619 ;; elements the very first request will be applied on.
4620 ;;
4621 ;; Elements cannot be accessed through their beginning position, which
4622 ;; may or may not be up-to-date. Instead, each element in the tree is
4623 ;; associated to a key, obtained with `org-element--cache-key'. This
4624 ;; mechanism is robust enough to preserve total order among elements
4625 ;; even when the tree is only partially synchronized.
4626 ;;
4627 ;; Objects contained in an element are stored in a hash table,
4628 ;; `org-element--cache-objects'.
4632 "Non nil when Org parser should cache its results.
4639 "Maximum duration, as a time value, for a cache synchronization.
4640 If the synchronization is not over after this delay, the process
4641 pauses and resumes after `org-element-cache-sync-break'
4645 "Duration, as a time value, of the pause between synchronizations.
4649 ;;;; Data Structure
4652 "AVL tree used to cache elements.
4653 Each node of the tree contains an element. Comparison is done
4654 with `org-element--cache-compare'. This cache is used in
4658 "Hash table used as to cache objects.
4659 Key is an element, as returned by `org-element-at-point', and
4660 value is an alist where each association is:
4662 \(PARENT COMPLETEP . OBJECTS)
4664 where PARENT is an element or object, COMPLETEP is a boolean,
4665 non-nil when all direct children of parent are already cached and
4666 OBJECTS is a list of such children, as objects, from farthest to
4667 closest.
4670 contained within a paragraph
4674 If the paragraph is completely parsed, OBJECTS-DATA will be
4676 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4677 \(BOLD-OBJECT t ENTITY-OBJECT))
4679 whereas in a partially parsed paragraph, it could be
4681 \((PARAGRAPH nil ENTITY-OBJECT))
4686 "List of pending synchronization requests.
4688 A request is a vector with the following pattern:
4690 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4692 Processing a synchronization request consists of three phases:
4694 0. Delete modified elements,
4695 1. Fill missing area in cache,
4696 2. Shift positions and re-parent elements after the changes.
4698 During phase 0, NEXT is the key of the first element to be
4699 removed, BEG and END is buffer position delimiting the
4700 modifications. Elements starting between them (inclusive) are
4701 removed and so are those contained within OUTREACH. PARENT, when
4702 non-nil, is the parent of the first element to be removed.
4704 During phase 1, NEXT is the key of the next known element in
4705 cache and BEG its beginning position. Parse buffer between that
4706 element and the one before it in order to determine the parent of
4707 the next element. Set PARENT to the element containing NEXT.
4709 During phase 2, NEXT is the key of the next element to shift in
4710 the parse tree. All elements starting from this one have their
4711 properties relatives to buffer positions shifted by integer
4712 OFFSET and, if they belong to element PARENT, are adopted by it.
4720 "Hash table used to store keys during synchronization.
4724 "Return a unique key for ELEMENT in cache tree.
4726 Keys are used to keep a total order among elements in the cache.
4727 Comparison is done with `org-element--cache-key-less-p'.
4729 When no synchronization is taking place, a key is simply the
4730 beginning position of the element, or that position plus one in
4731 the case of an first item (respectively row) in
4732 a list (respectively a table).
4734 During a synchronization, the key is the one the element had when
4735 the cache was synchronized for the last time. Elements added to
4736 cache during the synchronization get a new key generated with
4737 `org-element--cache-generate-key'.
4739 Such keys are stored in `org-element--cache-sync-keys'. The hash
4740 table is cleared once the synchronization is complete."
4743 ;; Increase beginning position of items (respectively
4744 ;; table rows) by one, so the first item can get
4745 ;; a different key from its parent list (respectively
4746 ;; table).
4749 begin)))
4752 key))))
4755 "Generate a key between LOWER and UPPER.
4757 LOWER and UPPER are integers or lists, possibly empty.
4759 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4760 a unique key, as an integer or a list of integers, according to
4761 the following rules:
4763 - LOWER and UPPER are compared level-wise until values differ.
4765 - If, at a given level, LOWER and UPPER differ from more than
4766 2, the new key shares all the levels above with LOWER and
4767 gets a new level. Its value is the mean between LOWER and
4768 UPPER:
4770 \(1 2) + (1 4) --> (1 3)
4772 - If LOWER has no value to compare with, it is assumed that its
4773 value is `most-negative-fixnum'. E.g.,
4775 \(1 1) + (1 1 2)
4777 is equivalent to
4779 \(1 1 m) + (1 1 2)
4781 where m is `most-negative-fixnum'. Likewise, if UPPER is
4782 short of levels, the current value is `most-positive-fixnum'.
4784 - If they differ from only one, the new key inherits from
4785 current LOWER level and fork it at the next level. E.g.,
4787 \(2 1) + (3 3)
4789 is equivalent to
4791 \(2 1) + (2 M)
4793 where M is `most-positive-fixnum'.
4795 - If the key is only one level long, it is returned as an
4796 integer:
4798 \(1 2) + (3 2) --> 2
4800 When they are not equals, the function assumes that LOWER is
4801 lesser than UPPER, per `org-element--cache-key-less-p'."
4805 skip-upper key)
4816 ;; When at a given level, LOWER and UPPER differ from
4817 ;; 1, ignore UPPER altogether. Instead create a key
4818 ;; between LOWER and the greatest key with the same
4819 ;; prefix as LOWER so far.
4825 "Non-nil if key A is less than key B.
4826 A and B are either integers or lists of integers, as returned by
4827 `org-element--cache-key'."
4835 ;; If A is empty, either keys are equal (B is also empty) and
4836 ;; we return nil, or A is lesser than B (B is longer) and we
4837 ;; return a non-nil value.
4838 ;;
4839 ;; If A is not empty, B is necessarily empty and A is greater
4840 ;; than B (A is longer). Therefore, return nil.
4844 "Non-nil when element A is located before element B."
4849 "Return root value in cache.
4850 This function assumes `org-element--cache' is a valid AVL tree."
4854 ;;;; Tools
4857 "Non-nil when cache is active in current buffer."
4862 "Find element in cache starting at POS or before.
4864 POS refers to a buffer position.
4866 When optional argument SIDE is non-nil, the function checks for
4867 elements starting at or past POS instead. If SIDE is `both', the
4868 function returns a cons cell where car is the first element
4869 starting at or before POS and cdr the first element starting
4870 after POS.
4872 The function can only find elements in the synchronized part of
4873 the cache."
4877 lower upper)
4892 ;; We found an element in cache starting at POS. If `side'
4893 ;; is `both' we also want the next one in order to generate
4894 ;; a key in-between.
4895 ;;
4896 ;; If the element is the first row or item in a table or
4897 ;; a plain list, we always return the table or the plain
4898 ;; list.
4899 ;;
4900 ;; In any other case, we return the element found.
4909 lower parent
4910 upper parent)))))
4913 lower element
4914 upper element)))))
4921 "Store ELEMENT in current buffer's cache, if allowed.
4922 When optional argument DATA is non-nil, assume is it object data
4923 relative to ELEMENT and store it in the objects cache."
4927 ;; During synchronization, first build an appropriate key
4928 ;; for the new element so `avl-tree-enter' can insert it at
4929 ;; the right spot in the cache.
4938 org-element--cache-sync-keys)))
4940 ;; Headlines are not stored in cache, so objects in titles are
4941 ;; not stored either.
4946 "Remove ELEMENT from cache.
4947 Assume ELEMENT belongs to cache and that a cache is active."
4952 ;;;; Synchronization
4955 "Set idle timer for cache synchronization in BUFFER."
4962 org-element-cache-sync-idle-time))
4963 nil
4964 #'org-element--cache-sync
4965 buffer)))
4968 "Non-nil when synchronization process should be interrupted.
4969 TIME-LIMIT is a time value or nil."
4975 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4977 Properties containing buffer positions are `:begin', `:end',
4978 `:contents-begin', `:contents-end' and `:structure'. When
4979 optional argument PROPS is a list of keywords, only shift
4980 properties provided in that list.
4982 Properties are modified by side-effect."
4984 ;; Shift `:structure' property for the first plain list only: it
4985 ;; is the only one that really matters and it prevents from
4986 ;; shifting it more than once.
5000 "Synchronize cache with recent modification in BUFFER.
5002 When optional argument THRESHOLD is non-nil, do the
5003 synchronization for all elements starting before or at threshold,
5004 then exit. Otherwise, synchronize cache for as long as
5005 `org-element-cache-sync-duration' or until Emacs leaves idle
5006 state.
5008 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5009 not registered yet in the cache are going to happen. It is used
5010 in `org-element--cache-submit-request', where cache is partially
5011 updated before current modification are actually submitted."
5022 request
5024 threshold
5027 org-element-cache-sync-duration))
5028 future-change)
5029 ;; Request processed. Merge current and next offsets and
5030 ;; transfer ending position.
5036 ;; If more requests are awaiting, set idle timer accordingly.
5037 ;; Otherwise, reset keys.
5044 "Process synchronization REQUEST for all entries before NEXT.
5046 REQUEST is a vector, built by `org-element--cache-submit-request'.
5048 NEXT is a cache key, as returned by `org-element--cache-key'.
5050 When non-nil, THRESHOLD is a buffer position. Synchronization
5051 stops as soon as a shifted element begins after it.
5053 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5054 after this time or when Emacs exits idle state.
5056 When non-nil, FUTURE-CHANGE is a buffer position where changes
5057 not registered yet in the cache are going to happen. See
5058 `org-element--cache-submit-request' for more information.
5060 Throw `interrupt' if the process stops before completing the
5061 request."
5064 ;; Phase 0.
5065 ;;
5066 ;; Delete all elements starting after BEG, but not after buffer
5067 ;; position END or past element with key NEXT.
5068 ;;
5069 ;; At each iteration, we start again at tree root since
5070 ;; a deletion modifies structure of the balanced tree.
5078 ;; Find first element in cache with key BEG or after it.
5088 data-key key
5091 data-key key
5092 node nil)))))
5101 up))
5107 ;; No element starting after modifications left in
5108 ;; cache: further processing is futile.
5111 ;; Phase 1.
5112 ;;
5113 ;; Phase 0 left a hole in the cache. Some elements after it
5114 ;; could have parents within. For example, in the following
5115 ;; buffer:
5116 ;;
5117 ;; - item
5118 ;;
5119 ;;
5120 ;; Paragraph1
5121 ;;
5122 ;; Paragraph2
5123 ;;
5124 ;; if we remove a blank line between "item" and "Paragraph1",
5125 ;; everything down to "Paragraph2" is removed from cache. But
5126 ;; the paragraph now belongs to the list, and its `:parent'
5127 ;; property no longer is accurate.
5128 ;;
5129 ;; Therefore we need to parse again elements in the hole, or at
5130 ;; least in its last section, so that we can re-parent
5131 ;; subsequent elements, during phase 2.
5132 ;;
5133 ;; Note that we only need to get the parent from the first
5134 ;; element in cache after the hole.
5135 ;;
5136 ;; When next key is lesser or equal to the current one, delegate
5137 ;; phase 1 processing to next request in order to preserve key
5138 ;; order among requests.
5146 ;; Next element will start at its beginning position plus
5147 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5148 ;; contains the real beginning position of the first element to
5149 ;; shift and re-parent.
5153 ;; Changes are going to happen around this element and
5154 ;; they will trigger another phase 1 request. Skip the
5155 ;; current one.
5161 ;; Phase 2.
5162 ;;
5163 ;; Shift all elements starting from key START, but before NEXT, by
5164 ;; OFFSET, and re-parent them when appropriate.
5165 ;;
5166 ;; Elements are modified by side-effect so the tree structure
5167 ;; remains intact.
5168 ;;
5169 ;; Once THRESHOLD, if any, is reached, or once there is an input
5170 ;; pending, exit. Before leaving, the current synchronization
5171 ;; request is updated.
5178 exit-flag)
5179 ;; No re-parenting nor shifting planned: request is over.
5189 ;; We reached NEXT. Request is complete.
5191 ;; Handle interruption request. Update current request.
5196 ;; Shift element.
5199 ;; Shift associated objects data, if any.
5204 ;; Update PARENT and re-parent DATA, only when
5205 ;; necessary. Propagate new structures for lists.
5219 ;; Cache is up-to-date past THRESHOLD. Request
5220 ;; interruption.
5225 ;; We reached end of tree: synchronization complete.
5226 t)))
5229 "Parse elements in current section, down to POS.
5231 Start parsing from the closest between the last known element in
5232 cache or headline above. Return the smallest element containing
5233 POS.
5235 When optional argument SYNCP is non-nil, return the parent of the
5236 element containing POS instead. In that case, it is also
5237 possible to provide TIME-LIMIT, which is a time value specifying
5238 when the parsing should stop. The function throws `interrupt' if
5239 the process stopped before finding the expected result."
5246 element next mode)
5248 ;; Nothing in cache before point: start parsing from first
5249 ;; element following headline above, or first element in
5250 ;; buffer.
5257 ;; Cache returned exact match: return it.
5260 ;; There's a headline between cached value and POS: cached
5261 ;; value is invalid. Start parsing from first element
5262 ;; following the headline.
5269 ;; Check if CACHED or any of its ancestors contain point.
5270 ;;
5271 ;; If there is such an element, we inspect it in order to know
5272 ;; if we return it or if we need to parse its contents.
5273 ;; Otherwise, we just start parsing from current location,
5274 ;; which is right after the top-most element containing
5275 ;; CACHED.
5276 ;;
5277 ;; As a special case, if POS is at the end of the buffer, we
5278 ;; want to return the innermost element ending there.
5279 ;;
5280 ;; Also, if we find an ancestor and discover that we need to
5281 ;; parse its contents, make sure we don't start from
5282 ;; `:contents-begin', as we would otherwise go past CACHED
5283 ;; again. Instead, in that situation, we will resume parsing
5284 ;; from NEXT, which is located after CACHED or its higher
5285 ;; ancestor not containing point.
5297 ;; Parse successively each element until we reach POS.
5310 end 'element mode
5317 ;; Skip any element ending before point. Also skip
5318 ;; element ending at point (unless it is also the end of
5319 ;; buffer) since we're sure that another element begins
5320 ;; after it.
5324 ;; A non-greater element contains point: return it.
5327 ;; Otherwise, we have to decide if ELEMENT really
5328 ;; contains POS. In that case we start parsing from
5329 ;; contents' beginning.
5330 ;;
5331 ;; If POS is at contents' beginning but it is also at
5332 ;; the beginning of the first item in a list or a table.
5333 ;; In that case, we need to create an anchor for that
5334 ;; list or table, so return it.
5335 ;;
5336 ;; Also, if POS is at the end of the buffer, no element
5337 ;; can start after it, but more than one may end there.
5338 ;; Arbitrarily, we choose to return the innermost of
5339 ;; such elements.
5352 parent element
5353 end cend))))
5354 ;; Otherwise, return ELEMENT as it is the smallest
5355 ;; element containing POS.
5360 ;;;; Staging Buffer Changes
5371 "Regexp matching a sensitive line, structure wise.
5372 A sensitive line is a headline, inlinetask, block, drawer, or
5373 latex-environment boundary. When such a line is modified,
5374 structure changes in the document may propagate in the whole
5378 "Non-nil when a sensitive line is about to be changed.
5382 "Request extension of area going to be modified if needed.
5383 BEG and END are the beginning and end of the range of changed
5384 text. See `before-change-functions' for more information."
5394 'headline
5397 org-element--cache-sensitive-re bottom t)))))))))
5400 "Update buffer modifications for current buffer.
5401 BEG and END are the beginning and end of the range of changed
5402 text, and the length in bytes of the pre-change text replaced by
5403 that range. See `after-change-functions' for more information."
5411 ;; Determine if modified area needs to be extended, according
5412 ;; to both previous and current state. We make a special
5413 ;; case for headline editing: if a headline is modified but
5414 ;; not removed, do not extend.
5423 org-element--cache-sensitive-re bottom t))))
5424 ;; Effectively extend modified area.
5432 ;; Store synchronization request.
5435 ;; Activate a timer to process the request during idle time.
5439 "Return first element to remove from cache.
5441 BEG and END are buffer positions delimiting buffer modifications.
5442 OFFSET is the size of the changes.
5444 Returned element is usually the first element in cache containing
5445 any position between BEG and END. As an exception, greater
5446 elements around the changes that are robust to contents
5447 modifications are preserved and updated according to the
5448 changes."
5458 special-block))
5459 ;; Drawers named "PROPERTIES" are probably
5460 ;; a properties drawer being edited. Force
5461 ;; parsing to check if editing is over.
5470 ;; UP is a robust greater element containing changes.
5471 ;; We only need to extend its ending boundaries.
5477 ;; We're at top level element containing ELEMENT: if it's
5478 ;; altered by buffer modifications, it is first element in
5479 ;; cache to be removed. Otherwise, that first element is the
5480 ;; following one.
5481 ;;
5482 ;; As a special case, do not remove BEFORE if it is a robust
5483 ;; container for current changes.
5485 before)))))
5488 "Submit a new cache synchronization request for current buffer.
5489 BEG and END are buffer positions delimiting the minimal area
5490 where cache data should be removed. OFFSET is the size of the
5491 change, as an integer."
5493 delete-to delete-from)
5498 ;; Current changes can be merged with first sync request: we
5499 ;; can save a partial cache synchronization.
5502 ;; If last change happened within area to be removed, extend
5503 ;; boundaries of robust parents, if any. Otherwise, find
5504 ;; first element to remove and update request accordingly.
5516 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5517 ;; if any, is no longer a 0-phase request, thus ensuring that
5518 ;; phases are properly ordered. We need to provide OFFSET as
5519 ;; optional parameter since current modifications are not known
5520 ;; yet to the otherwise correct part of the cache (i.e, before
5521 ;; the first request).
5528 ;; When changes happen before the first known
5529 ;; element, re-parent and shift the rest of the
5530 ;; cache.
5532 ;; Otherwise, we find the first non robust
5533 ;; element containing END. All elements between
5534 ;; FIRST and this one are to be removed.
5535 ;;
5536 ;; Among them, some could be located outside the
5537 ;; synchronized part of the cache, in which case
5538 ;; comparing buffer positions to find them is
5539 ;; useless. Instead, we store the element
5540 ;; containing them in the request itself. All
5541 ;; its children will be removed.
5553 element up))
5556 org-element--cache-sync-requests)
5557 ;; No element to remove. No need to re-parent either.
5558 ;; Simply shift additional elements, if any, by OFFSET.
5563 ;;;; Public Functions
5565 ;;;###autoload
5567 "Reset cache in current buffer.
5568 When optional argument ALL is non-nil, reset cache in all Org
5569 buffers."
5587 ;;;###autoload
5589 "Refresh cache at position POS."
5596 \f
5597 ;;; The Toolbox
5598 ;;
5599 ;; The first move is to implement a way to obtain the smallest element
5600 ;; containing point. This is the job of `org-element-at-point'. It
5601 ;; basically jumps back to the beginning of section containing point
5602 ;; and proceed, one element after the other, with
5603 ;; `org-element--current-element' until the container is found. Note:
5604 ;; When using `org-element-at-point', secondary values are never
5605 ;; parsed since the function focuses on elements, not on objects.
5606 ;;
5607 ;; At a deeper level, `org-element-context' lists all elements and
5608 ;; objects containing point.
5609 ;;
5610 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5611 ;; internally by navigation and manipulation tools.
5614 ;;;###autoload
5616 "Determine closest element around point.
5618 Return value is a list like (TYPE PROPS) where TYPE is the type
5619 of the element and PROPS a plist of properties associated to the
5620 element.
5622 Possible types are defined in `org-element-all-elements'.
5623 Properties depend on element or object type, but always include
5624 `:begin', `:end', `:parent' and `:post-blank' properties.
5626 As a special case, if point is at the very beginning of the first
5627 item in a list or sub-list, returned element will be that list
5628 instead of the item. Likewise, if point is at the beginning of
5629 the first row of a table, returned element will be the table
5630 instead of the first row.
5632 When point is at the end of the buffer, return the innermost
5633 element ending there."
5639 ;; Within blank lines at the beginning of buffer, return nil.
5641 ;; Within blank lines right after a headline, return that
5642 ;; headline.
5646 ;; Otherwise parse until we find element containing ORIGIN.
5653 ;;;###autoload
5655 "Return smallest element or object around point.
5657 Return value is a list like (TYPE PROPS) where TYPE is the type
5658 of the element or object and PROPS a plist of properties
5659 associated to it.
5661 Possible types are defined in `org-element-all-elements' and
5662 `org-element-all-objects'. Properties depend on element or
5663 object type, but always include `:begin', `:end', `:parent' and
5664 `:post-blank'.
5666 As a special case, if point is right after an object and not at
5667 the beginning of any other object, return that object.
5669 Optional argument ELEMENT, when non-nil, is the closest element
5670 containing point, as returned by `org-element-at-point'.
5671 Providing it allows for quicker computation."
5677 ;; If point is inside an element containing objects or
5678 ;; a secondary string, narrow buffer to the container and
5679 ;; proceed with parsing. Otherwise, return ELEMENT.
5681 ;; At a parsed affiliated keyword, check if we're inside main
5682 ;; or dual value.
5689 org-element-parsed-keywords))
5698 ;; Also change type to retrieve correct restrictions.
5700 ;; At an item, objects can only be located within tag, if any.
5710 ;; At an headline or inlinetask, objects are in title.
5717 ;; At a paragraph, a table-row or a verse block, objects are
5718 ;; located within their contents.
5722 ;; CBEG is nil for table rules.
5727 ;; At a planning line, if point is at a timestamp, return it,
5728 ;; otherwise, return element.
5736 ;; All other locations cannot contain objects: bail out.
5746 next object-data last)
5750 ;; When entering PARENT for the first time, get list
5751 ;; of objects within known so far. Store it in
5752 ;; OBJECT-DATA.
5757 ;; Find NEXT object for analysis.
5759 ;; If NEXT is non-nil, we already exhausted the
5760 ;; cache so we can parse buffer to find the object
5761 ;; after it.
5763 ;; Otherwise, check if cache can help us.
5774 ;; Cache contains the information needed.
5777 pos)
5779 pos)
5785 ;; If we have a new object to analyze, store it in
5786 ;; cache. Otherwise record that there is nothing
5787 ;; more to parse in this element at this depth.
5792 ;; Process NEXT, if any, in order to know if we need
5793 ;; to skip it, return it or move into it.
5800 ;; Skip objects ending before point. Also skip
5801 ;; objects ending at point unless it is also the
5802 ;; end of buffer, since we want to return the
5803 ;; innermost object.
5806 ;; For convenience, when object ends at POS,
5807 ;; without any space, store it in LAST, as we
5808 ;; will return it if no object starts here.
5812 ;; If POS is within a container object, move
5813 ;; into that object.
5817 ;; At contents' end, if there is no
5818 ;; space before point, also move into
5819 ;; object, for consistency with
5820 ;; convenience feature above.
5829 next nil
5830 object-data nil))
5831 ;; Otherwise, return NEXT.
5833 ;; Store results in cache, if applicable.
5837 "List all ancestors of a given element or object.
5839 BLOB is an object or element.
5841 When optional argument TYPES is a list of symbols, return the
5842 first element or object in the lineage whose type belongs to that
5843 list.
5845 When optional argument WITH-SELF is non-nil, lineage includes
5846 BLOB itself as the first element, and TYPES, if provided, also
5847 apply to it.
5849 When BLOB is obtained through `org-element-context' or
5850 `org-element-at-point', only ancestors from its section can be
5851 found. There is no such limitation when BLOB belongs to a full
5852 parse tree."
5854 ancestors)
5861 "Non-nil when elements ELEM-A and ELEM-B are nested."
5870 "Swap elements ELEM-A and ELEM-B.
5871 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5872 end of ELEM-A."
5874 ;; There are two special cases when an element doesn't start at bol:
5875 ;; the first paragraph in an item or in a footnote definition.
5877 ;; Only a paragraph without any affiliated keyword can be moved at
5878 ;; ELEM-A position in such a situation. Note that the case of
5879 ;; a footnote definition is impossible: it cannot contain two
5880 ;; paragraphs in a row because it cannot contain a blank line.
5886 ;; In a special situation, ELEM-A will have no indentation. We'll
5887 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5901 ;; Store inner overlays responsible for visibility status.
5902 ;; We also need to store their boundaries as they will be
5903 ;; removed from buffer.
5918 ;; Get contents.
5926 ;; Restore ex ELEM-A overlays.
5933 ;; Restore ex ELEM-B overlays.
5939 "Remove maximum common indentation in string S and return it.
5940 When optional argument N is a positive integer, remove exactly
5941 that much characters from indentation, if possible, or return
5942 S as-is otherwise. Unlike to `org-remove-indentation', this
5943 function doesn't call `untabify' on S."
5948 ;; Find maximum common indentation, if not specified.
5956 min-ind)))
5958 ;; Remove exactly N indentation, but give up if not possible.
5971 ;; Local variables:
5972 ;; generated-autoload-file: "org-loaddefs.el"
5973 ;; End:
5975 ;;; org-element.el ends here