| blob | d9aa79f1598decde9122a141fc774be51269742b |
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.
1347 ;; Skip blocks (any type) and drawers contents.
1352 limit t)))
1358 "Parse a plain list.
1360 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1361 the buffer position at the beginning of the first affiliated
1362 keyword and CDR is a plist of affiliated keywords along with
1363 their value. STRUCTURE is the structure of the plain list being
1364 parsed.
1366 Return a list whose CAR is `plain-list' and CDR is a plist
1367 containing `:type', `:begin', `:end', `:contents-begin' and
1368 `:contents-end', `:structure', `:post-blank' and
1369 `:post-affiliated' keywords.
1371 Assume point is at the beginning of the list."
1385 pos))
1389 ;; Return value.
1393 :begin begin
1394 :end end
1395 :contents-begin contents-begin
1396 :contents-end contents-end
1397 :structure struct
1403 "Interpret PLAIN-LIST element as Org syntax.
1404 CONTENTS is the contents of the element."
1412 ;;;; Property Drawer
1415 "Parse a property drawer.
1417 LIMIT bounds the search.
1419 Return a list whose car is `property-drawer' and cdr is a plist
1420 containing `:begin', `:end', `:contents-begin', `:contents-end',
1421 `:post-blank' and `:post-affiliated' keywords.
1423 Assume point is at the beginning of the property drawer."
1436 :end end
1438 :contents-end contents-end
1443 "Interpret PROPERTY-DRAWER element as Org syntax.
1444 CONTENTS is the properties within the drawer."
1448 ;;;; Quote Block
1451 "Parse a quote block.
1453 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1454 the buffer position at the beginning of the first affiliated
1455 keyword and CDR is a plist of affiliated keywords along with
1456 their value.
1458 Return a list whose CAR is `quote-block' and CDR is a plist
1459 containing `:begin', `:end', `:contents-begin', `:contents-end',
1460 `:post-blank' and `:post-affiliated' keywords.
1462 Assume point is at the beginning of the block."
1466 ;; Incomplete block: parse it as a paragraph.
1472 ;; Empty blocks have no contents.
1485 :end end
1486 :contents-begin contents-begin
1487 :contents-end contents-end
1493 "Interpret QUOTE-BLOCK element as Org syntax.
1494 CONTENTS is the contents of the element."
1498 ;;;; Section
1501 "Parse a section.
1503 LIMIT bounds the search.
1505 Return a list whose CAR is `section' and CDR is a plist
1506 containing `:begin', `:end', `:contents-begin', `contents-end',
1507 `:post-blank' and `:post-affiliated' keywords."
1509 ;; Beginning of section is the beginning of the first non-blank
1510 ;; line after previous headline.
1519 :end end
1520 :contents-begin begin
1521 :contents-end pos-before-blank
1526 "Interpret SECTION element as Org syntax.
1527 CONTENTS is the contents of the element."
1528 contents)
1531 ;;;; Special Block
1534 "Parse a special block.
1536 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1537 the buffer position at the beginning of the first affiliated
1538 keyword and CDR is a plist of affiliated keywords along with
1539 their value.
1541 Return a list whose CAR is `special-block' and CDR is a plist
1542 containing `:type', `:begin', `:end', `:contents-begin',
1543 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1545 Assume point is at the beginning of the block."
1552 limit t)))
1553 ;; Incomplete block: parse it as a paragraph.
1559 ;; Empty blocks have no contents.
1572 :begin begin
1573 :end end
1574 :contents-begin contents-begin
1575 :contents-end contents-end
1581 "Interpret SPECIAL-BLOCK element as Org syntax.
1582 CONTENTS is the contents of the element."
1587 \f
1588 ;;; Elements
1589 ;;
1590 ;; For each element, a parser and an interpreter are also defined.
1591 ;; Both follow the same naming convention used for greater elements.
1592 ;;
1593 ;; Also, as for greater elements, adding a new element type is done
1594 ;; through the following steps: implement a parser and an interpreter,
1595 ;; tweak `org-element--current-element' so that it recognizes the new
1596 ;; type and add that new type to `org-element-all-elements'.
1597 ;;
1598 ;; As a special case, when the newly defined type is a block type,
1599 ;; `org-element-block-name-alist' has to be modified accordingly.
1602 ;;;; Babel Call
1605 "Parse a babel call.
1607 LIMIT bounds the search. AFFILIATED is a list of which car is
1608 the buffer position at the beginning of the first affiliated
1609 keyword and cdr is a plist of affiliated keywords along with
1610 their value.
1612 Return a list whose car is `babel-call' and cdr is a plist
1613 containing `:call', `:inside-header', `:arguments',
1614 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1615 `:post-affiliated' as keywords."
1629 value)))
1639 :begin begin
1640 :end end
1641 :value value
1647 "Interpret BABEL-CALL element as Org syntax.
1648 CONTENTS is nil."
1658 ;;;; Clock
1661 "Parse a clock.
1663 LIMIT bounds the search.
1665 Return a list whose CAR is `clock' and CDR is a plist containing
1666 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1667 `:post-affiliated' as keywords."
1687 :value value
1688 :duration duration
1689 :begin begin
1690 :end end
1691 :post-blank post-blank
1695 "Interpret CLOCK element as Org syntax.
1696 CONTENTS is nil."
1704 "%2s:%02s"
1708 ;;;; Comment
1711 "Parse a comment.
1713 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1714 the buffer position at the beginning of the first affiliated
1715 keyword and CDR is a plist of affiliated keywords along with
1716 their value.
1718 Return a list whose CAR is `comment' and CDR is a plist
1719 containing `:begin', `:end', `:value', `:post-blank',
1720 `:post-affiliated' keywords.
1722 Assume point is at comment beginning."
1731 ;; Get comments ending.
1734 ;; Accumulate lines without leading hash and first
1735 ;; whitespace.
1749 :end end
1750 :value value
1756 "Interpret COMMENT element as Org syntax.
1757 CONTENTS is nil."
1761 ;;;; Comment Block
1764 "Parse an export block.
1766 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1767 the buffer position at the beginning of the first affiliated
1768 keyword and CDR is a plist of affiliated keywords along with
1769 their value.
1771 Return a list whose CAR is `comment-block' and CDR is a plist
1772 containing `:begin', `:end', `:value', `:post-blank' and
1773 `:post-affiliated' keywords.
1775 Assume point is at comment block beginning."
1779 ;; Incomplete block: parse it as a paragraph.
1792 contents-begin contents-end)))
1796 :end end
1797 :value value
1803 "Interpret COMMENT-BLOCK element as Org syntax.
1804 CONTENTS is nil."
1811 ;;;; Diary Sexp
1814 "Parse a diary sexp.
1816 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1817 the buffer position at the beginning of the first affiliated
1818 keyword and CDR is a plist of affiliated keywords along with
1819 their value.
1821 Return a list whose CAR is `diary-sexp' and CDR is a plist
1822 containing `:begin', `:end', `:value', `:post-blank' and
1823 `:post-affiliated' keywords."
1835 :begin begin
1836 :end end
1842 "Interpret DIARY-SEXP as Org syntax.
1843 CONTENTS is nil."
1847 ;;;; Example Block
1850 "Parse an example block.
1852 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1853 the buffer position at the beginning of the first affiliated
1854 keyword and CDR is a plist of affiliated keywords along with
1855 their value.
1857 Return a list whose CAR is `example-block' and CDR is a plist
1858 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1859 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1860 `:value', `:post-blank' and `:post-affiliated' keywords."
1864 ;; Incomplete block: parse it as a paragraph.
1872 ;; Switches analysis
1879 ;; Should labels be retained in (or stripped from) example
1880 ;; blocks?
1885 ;; What should code-references use - labels or
1886 ;; line-numbers?
1895 ;; Standard block parsing.
1903 contents-begin contents-end))
1904 block-ind))
1913 :end end
1914 :value value
1915 :switches switches
1916 :number-lines number-lines
1917 :preserve-indent preserve-indent
1918 :retain-labels retain-labels
1919 :use-labels use-labels
1920 :label-fmt label-fmt
1926 "Interpret EXAMPLE-BLOCK element as Org syntax.
1927 CONTENTS is nil."
1935 value
1940 ;;;; Export Block
1943 "Parse an export block.
1945 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1946 the buffer position at the beginning of the first affiliated
1947 keyword and CDR is a plist of affiliated keywords along with
1948 their value.
1950 Return a list whose CAR is `export-block' and CDR is a plist
1951 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1952 `:post-affiliated' keywords.
1954 Assume point is at export-block beginning."
1961 ;; Incomplete block: parse it as a paragraph.
1974 contents-end)))
1978 :end end
1979 :type type
1980 :value value
1986 "Interpret EXPORT-BLOCK element as Org syntax.
1987 CONTENTS is nil."
1994 ;;;; Fixed-width
1997 "Parse a fixed-width section.
1999 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2000 the buffer position at the beginning of the first affiliated
2001 keyword and CDR is a plist of affiliated keywords along with
2002 their value.
2004 Return a list whose CAR is `fixed-width' and CDR is a plist
2005 containing `:begin', `:end', `:value', `:post-blank' and
2006 `:post-affiliated' keywords.
2008 Assume point is at the beginning of the fixed-width area."
2012 value
2017 ;; Accumulate text without starting colons.
2030 :end end
2031 :value value
2037 "Interpret FIXED-WIDTH element as Org syntax.
2038 CONTENTS is nil."
2046 ;;;; Horizontal Rule
2049 "Parse an horizontal rule.
2051 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2052 the buffer position at the beginning of the first affiliated
2053 keyword and CDR is a plist of affiliated keywords along with
2054 their value.
2056 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2057 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2058 keywords."
2068 :end end
2074 "Interpret HORIZONTAL-RULE element as Org syntax.
2075 CONTENTS is nil."
2079 ;;;; Keyword
2082 "Parse a keyword at point.
2084 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2085 the buffer position at the beginning of the first affiliated
2086 keyword and CDR is a plist of affiliated keywords along with
2087 their value.
2089 Return a list whose CAR is `keyword' and CDR is a plist
2090 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2091 `:post-affiliated' keywords."
2093 ;; An orphaned affiliated keyword is considered as a regular
2094 ;; keyword. In this case AFFILIATED is nil, so we take care of
2095 ;; this corner case.
2108 :value value
2109 :begin begin
2110 :end end
2116 "Interpret KEYWORD element as Org syntax.
2117 CONTENTS is nil."
2123 ;;;; Latex Environment
2127 "Regexp matching the beginning of a LaTeX environment.
2128 The environment is captured by the first group.
2134 "Format string matching the ending of a LaTeX environment.
2138 "Parse a LaTeX environment.
2140 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2141 the buffer position at the beginning of the first affiliated
2142 keyword and CDR is a plist of affiliated keywords along with
2143 their value.
2145 Return a list whose CAR is `latex-environment' and CDR is a plist
2146 containing `:begin', `:end', `:value', `:post-blank' and
2147 `:post-affiliated' keywords.
2149 Assume point is at the beginning of the latex environment."
2156 limit t))
2157 ;; Incomplete latex environment: parse it as a paragraph.
2167 :end end
2168 :value value
2174 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2175 CONTENTS is nil."
2179 ;;;; Node Property
2182 "Parse a node-property at point.
2184 LIMIT bounds the search.
2186 Return a list whose CAR is `node-property' and CDR is a plist
2187 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2188 `:post-affiliated' keywords."
2198 limit))))
2201 :value value
2202 :begin begin
2203 :end end
2208 "Interpret NODE-PROPERTY element as Org syntax.
2209 CONTENTS is nil."
2215 ;;;; Paragraph
2218 "Parse a paragraph.
2220 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2221 the buffer position at the beginning of the first affiliated
2222 keyword and CDR is a plist of affiliated keywords along with
2223 their value.
2225 Return a list whose CAR is `paragraph' and CDR is a plist
2226 containing `:begin', `:end', `:contents-begin' and
2227 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2229 Assume point is at the beginning of the paragraph."
2236 ;; A matching `org-element-paragraph-separate' is not
2237 ;; necessarily the end of the paragraph. In particular,
2238 ;; drawers, blocks or LaTeX environments opening lines
2239 ;; must be closed. Moreover keywords with a secondary
2240 ;; value must belong to "dual keywords".
2254 limit t)))
2260 limit t)))
2263 org-element-dual-keywords))
2264 ;; Everything else is unambiguous.
2277 :end end
2278 :contents-begin contents-begin
2279 :contents-end contents-end
2285 "Interpret PARAGRAPH element as Org syntax.
2286 CONTENTS is the contents of the element."
2287 contents)
2290 ;;;; Planning
2293 "Parse a planning.
2295 LIMIT bounds the search.
2297 Return a list whose CAR is `planning' and CDR is a plist
2298 containing `:closed', `:deadline', `:scheduled', `:begin',
2299 `:end', `:post-blank' and `:post-affiliated' keywords."
2309 closed deadline scheduled)
2321 :deadline deadline
2322 :scheduled scheduled
2323 :begin begin
2324 :end end
2325 :post-blank post-blank
2329 "Interpret PLANNING element as Org syntax.
2330 CONTENTS is nil."
2332 'identity
2349 ;;;; Src Block
2352 "Parse a src block.
2354 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2355 the buffer position at the beginning of the first affiliated
2356 keyword and CDR is a plist of affiliated keywords along with
2357 their value.
2359 Return a list whose CAR is `src-block' and CDR is a plist
2360 containing `:language', `:switches', `:parameters', `:begin',
2361 `:end', `:number-lines', `:retain-labels', `:use-labels',
2362 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2363 `:post-affiliated' keywords.
2365 Assume point is at the beginning of the block."
2368 limit t)))
2369 ;; Incomplete block: parse it as a paragraph.
2375 ;; Get language as a string.
2384 ;; Get switches.
2386 ;; Get parameters.
2388 ;; Switches analysis
2399 ;; Should labels be retained in (or stripped from)
2400 ;; src blocks?
2405 ;; What should code-references use - labels or
2406 ;; line-numbers?
2411 ;; Indentation.
2413 ;; Retrieve code.
2418 block-ind))
2422 ;; Get position after ending blank lines.
2432 :begin begin
2433 :end end
2434 :number-lines number-lines
2435 :preserve-indent preserve-indent
2436 :retain-labels retain-labels
2437 :use-labels use-labels
2438 :label-fmt label-fmt
2439 :value value
2445 "Interpret SRC-BLOCK element as Org syntax.
2446 CONTENTS is nil."
2455 val)
2469 ;;;; Table
2472 "Parse a table at point.
2474 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2475 the buffer position at the beginning of the first affiliated
2476 keyword and CDR is a plist of affiliated keywords along with
2477 their value.
2479 Return a list whose CAR is `table' and CDR is a plist containing
2480 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2481 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2482 keywords.
2484 Assume point is at the beginning of the table."
2498 acc))
2505 :end end
2506 :type type
2507 :tblfm tblfm
2508 ;; Only `org' tables have contents. `table.el' tables
2509 ;; use a `:value' property to store raw table as
2510 ;; a string.
2515 table-begin table-end))
2521 "Interpret TABLE element as Org syntax.
2522 CONTENTS is a string, if table's type is `org', or nil."
2533 ;;;; Table Row
2536 "Parse table row at point.
2538 LIMIT bounds the search.
2540 Return a list whose CAR is `table-row' and CDR is a plist
2541 containing `:begin', `:end', `:contents-begin', `:contents-end',
2542 `:type', `:post-blank' and `:post-affiliated' keywords."
2546 ;; A table rule has no contents. In that case, ensure
2547 ;; CONTENTS-BEGIN matches CONTENTS-END.
2559 :begin begin
2560 :end end
2561 :contents-begin contents-begin
2562 :contents-end contents-end
2567 "Interpret TABLE-ROW element as Org syntax.
2568 CONTENTS is the contents of the table row."
2573 ;;;; Verse Block
2576 "Parse a verse block.
2578 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2579 the buffer position at the beginning of the first affiliated
2580 keyword and CDR is a plist of affiliated keywords along with
2581 their value.
2583 Return a list whose CAR is `verse-block' and CDR is a plist
2584 containing `:begin', `:end', `:contents-begin', `:contents-end',
2585 `:post-blank' and `:post-affiliated' keywords.
2587 Assume point is at beginning of the block."
2591 ;; Incomplete block: parse it as a paragraph.
2606 :end end
2607 :contents-begin contents-begin
2608 :contents-end contents-end
2614 "Interpret VERSE-BLOCK element as Org syntax.
2615 CONTENTS is verse block contents."
2619 \f
2620 ;;; Objects
2621 ;;
2622 ;; Unlike to elements, raw text can be found between objects. Hence,
2623 ;; `org-element--object-lex' is provided to find the next object in
2624 ;; buffer.
2625 ;;
2626 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2627 ;; object types they can contain will be specified in
2628 ;; `org-element-object-restrictions'.
2629 ;;
2630 ;; Creating a new type of object requires to alter
2631 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2632 ;; new type in `org-element-all-objects', and possibly add
2633 ;; restrictions in `org-element-object-restrictions'.
2635 ;;;; Bold
2638 "Parse bold object at point, if any.
2640 When at a bold object, return a list whose car is `bold' and cdr
2641 is a plist with `:begin', `:end', `:contents-begin' and
2642 `:contents-end' and `:post-blank' keywords. Otherwise, return
2643 nil.
2645 Assume point is at the first star marker."
2657 :end end
2658 :contents-begin contents-begin
2659 :contents-end contents-end
2663 "Interpret BOLD object as Org syntax.
2664 CONTENTS is the contents of the object."
2668 ;;;; Code
2671 "Parse code object at point, if any.
2673 When at a code object, return a list whose car is `code' and cdr
2674 is a plist with `:value', `:begin', `:end' and `:post-blank'
2675 keywords. Otherwise, return nil.
2677 Assume point is at the first tilde marker."
2688 :begin begin
2689 :end end
2693 "Interpret CODE object as Org syntax.
2694 CONTENTS is nil."
2698 ;;;; Entity
2701 "Parse entity at point, if any.
2703 When at an entity, return a list whose car is `entity' and cdr
2704 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2705 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2706 `:post-blank' as keywords. Otherwise, return nil.
2708 Assume point is at the beginning of the entity."
2710 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2728 :begin begin
2729 :end end
2730 :use-brackets-p bracketsp
2734 "Interpret ENTITY object as Org syntax.
2735 CONTENTS is nil."
2741 ;;;; Export Snippet
2744 "Parse export snippet at point.
2746 When at an export snippet, return a list whose car is
2747 `export-snippet' and cdr a plist with `:begin', `:end',
2748 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2749 return nil.
2751 Assume point is at the beginning of the snippet."
2767 :value value
2768 :begin begin
2769 :end end
2773 "Interpret EXPORT-SNIPPET object as Org syntax.
2774 CONTENTS is nil."
2780 ;;;; Footnote Reference
2783 "Parse footnote reference at point, if any.
2785 When at a footnote reference, return a list whose car is
2786 `footnote-reference' and cdr a plist with `:label', `:type',
2787 `:begin', `:end', `:content-begin', `:contents-end' and
2788 `:post-blank' as keywords. Otherwise, return nil."
2808 :type type
2809 :begin begin
2810 :end end
2816 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2817 CONTENTS is its definition, when inline, or nil."
2823 ;;;; Inline Babel Call
2826 "Parse inline babel call at point, if any.
2828 When at an inline babel call, return a list whose car is
2829 `inline-babel-call' and cdr a plist with `:call',
2830 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2831 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2833 Assume point is at the beginning of the babel call."
2849 :inside-header inside-header
2850 :arguments arguments
2851 :end-header end-header
2852 :begin begin
2853 :end end
2854 :value value
2858 "Interpret INLINE-BABEL-CALL object as Org syntax.
2859 CONTENTS is nil."
2869 ;;;; Inline Src Block
2872 "Parse inline source block at point, if any.
2874 When at an inline source block, return a list whose car is
2875 `inline-src-block' and cdr a plist with `:begin', `:end',
2876 `:language', `:value', `:parameters' and `:post-blank' as
2877 keywords. Otherwise, return nil.
2879 Assume point is at the beginning of the inline src block."
2892 :value value
2893 :parameters parameters
2894 :begin begin
2895 :end end
2899 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2900 CONTENTS is nil."
2905 language
2907 body)))
2909 ;;;; Italic
2912 "Parse italic object at point, if any.
2914 When at an italic object, return a list whose car is `italic' and
2915 cdr is a plist with `:begin', `:end', `:contents-begin' and
2916 `:contents-end' and `:post-blank' keywords. Otherwise, return
2917 nil.
2919 Assume point is at the first slash marker."
2931 :end end
2932 :contents-begin contents-begin
2933 :contents-end contents-end
2937 "Interpret ITALIC object as Org syntax.
2938 CONTENTS is the contents of the object."
2942 ;;;; Latex Fragment
2945 "Parse LaTeX fragment at point, if any.
2947 When at a LaTeX fragment, return a list whose car is
2948 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2949 and `:post-blank' as keywords. Otherwise, return nil.
2951 Assume point is at the beginning of the LaTeX fragment."
2969 ;; Macro.
2978 :begin begin
2979 :end end
2983 "Interpret LATEX-FRAGMENT object as Org syntax.
2984 CONTENTS is nil."
2987 ;;;; Line Break
2990 "Parse line break at point, if any.
2992 When at a line break, return a list whose car is `line-break',
2993 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2994 Otherwise, return nil.
2996 Assume point is at the beginning of the line break."
3005 "Interpret LINE-BREAK object as Org syntax.
3006 CONTENTS is nil."
3010 ;;;; Link
3013 "Parse link at point, if any.
3015 When at a link, return a list whose car is `link' and cdr a plist
3016 with `:type', `:path', `:raw-link', `:application',
3017 `:search-option', `:begin', `:end', `:contents-begin',
3018 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3019 nil.
3021 Assume point is at the beginning of the link."
3024 end contents-begin contents-end link-end post-blank path type
3025 raw-link link search-option application)
3027 ;; Type 1: Text targeted from a radio target.
3036 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3041 ;; RAW-LINK is the original link. Expand any
3042 ;; abbreviation in it.
3046 ;; Determine TYPE of link and set PATH accordingly.
3048 ;; File type.
3052 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3055 ;; According to RFC 3986, extra whitespace should be
3056 ;; ignored when a URI is extracted.
3059 ;; Id type: PATH is the id.
3062 ;; Code-ref type: PATH is the name of the reference.
3065 ;; Custom-id type: PATH is the name of the custom id.
3068 ;; Fuzzy type: Internal link either matches a target, an
3069 ;; headline name or nothing. PATH is the target or
3070 ;; headline's name.
3072 ;; Type 3: Plain link, e.g., http://orgmode.org
3078 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3086 ;; In any case, deduce end point after trailing white space from
3087 ;; LINK-END variable.
3091 ;; Special "file" type link processing. Extract opening
3092 ;; application and search option, if any. Also normalize URI.
3101 :path path
3103 :application application
3104 :search-option search-option
3105 :begin begin
3106 :end end
3107 :contents-begin contents-begin
3108 :contents-end contents-end
3112 "Interpret LINK object as Org syntax.
3113 CONTENTS is the contents of the object, or nil."
3118 raw-link
3122 ;;;; Macro
3125 "Parse macro at point, if any.
3127 When at a macro, return a list whose car is `macro' and cdr
3128 a plist with `:key', `:args', `:begin', `:end', `:value' and
3129 `:post-blank' as keywords. Otherwise, return nil.
3131 Assume point is at the macro."
3144 :value value
3145 :args args
3146 :begin begin
3147 :end end
3151 "Interpret MACRO object as Org syntax.
3152 CONTENTS is nil."
3156 ;;;; Radio-target
3159 "Parse radio target at point, if any.
3161 When at a radio target, return a list whose car is `radio-target'
3162 and cdr a plist with `:begin', `:end', `:contents-begin',
3163 `:contents-end', `:value' and `:post-blank' as keywords.
3164 Otherwise, return nil.
3166 Assume point is at the radio target."
3178 :end end
3179 :contents-begin contents-begin
3180 :contents-end contents-end
3181 :post-blank post-blank
3185 "Interpret TARGET object as Org syntax.
3186 CONTENTS is the contents of the object."
3190 ;;;; Statistics Cookie
3193 "Parse statistics cookie at point, if any.
3195 When at a statistics cookie, return a list whose car is
3196 `statistics-cookie', and cdr a plist with `:begin', `:end',
3197 `:value' and `:post-blank' keywords. Otherwise, return nil.
3199 Assume point is at the beginning of the statistics-cookie."
3210 :end end
3211 :value value
3215 "Interpret STATISTICS-COOKIE object as Org syntax.
3216 CONTENTS is nil."
3220 ;;;; Strike-Through
3223 "Parse strike-through object at point, if any.
3225 When at a strike-through object, return a list whose car is
3226 `strike-through' and cdr is a plist with `:begin', `:end',
3227 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3228 Otherwise, return nil.
3230 Assume point is at the first plus sign marker."
3242 :end end
3243 :contents-begin contents-begin
3244 :contents-end contents-end
3248 "Interpret STRIKE-THROUGH object as Org syntax.
3249 CONTENTS is the contents of the object."
3253 ;;;; Subscript
3256 "Parse subscript at point, if any.
3258 When at a subscript object, return a list whose car is
3259 `subscript' and cdr a plist with `:begin', `:end',
3260 `:contents-begin', `:contents-end', `:use-brackets-p' and
3261 `:post-blank' as keywords. Otherwise, return nil.
3263 Assume point is at the underscore."
3277 :end end
3278 :use-brackets-p bracketsp
3279 :contents-begin contents-begin
3280 :contents-end contents-end
3284 "Interpret SUBSCRIPT object as Org syntax.
3285 CONTENTS is the contents of the object."
3288 contents))
3291 ;;;; Superscript
3294 "Parse superscript at point, if any.
3296 When at a superscript object, return a list whose car is
3297 `superscript' and cdr a plist with `:begin', `:end',
3298 `:contents-begin', `:contents-end', `:use-brackets-p' and
3299 `:post-blank' as keywords. Otherwise, return nil.
3301 Assume point is at the caret."
3315 :end end
3316 :use-brackets-p bracketsp
3317 :contents-begin contents-begin
3318 :contents-end contents-end
3322 "Interpret SUPERSCRIPT object as Org syntax.
3323 CONTENTS is the contents of the object."
3326 contents))
3329 ;;;; Table Cell
3332 "Parse table cell at point.
3333 Return a list whose car is `table-cell' and cdr is a plist
3334 containing `:begin', `:end', `:contents-begin', `:contents-end'
3335 and `:post-blank' keywords."
3343 :end end
3344 :contents-begin contents-begin
3345 :contents-end contents-end
3349 "Interpret TABLE-CELL element as Org syntax.
3350 CONTENTS is the contents of the cell, or nil."
3354 ;;;; Target
3357 "Parse target at point, if any.
3359 When at a target, return a list whose car is `target' and cdr
3360 a plist with `:begin', `:end', `:value' and `:post-blank' as
3361 keywords. Otherwise, return nil.
3363 Assume point is at the target."
3373 :end end
3374 :value value
3378 "Interpret TARGET object as Org syntax.
3379 CONTENTS is nil."
3383 ;;;; Timestamp
3394 "Parse time stamp at point, if any.
3396 When at a time stamp, return a list whose car is `timestamp', and
3397 cdr a plist with `:type', `:raw-value', `:year-start',
3398 `:month-start', `:day-start', `:hour-start', `:minute-start',
3399 `:year-end', `:month-end', `:day-end', `:hour-end',
3400 `:minute-end', `:repeater-type', `:repeater-value',
3401 `:repeater-unit', `:warning-type', `:warning-value',
3402 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3403 Otherwise, return nil.
3405 Assume point is at the beginning of the timestamp."
3424 date-start)
3435 raw-value)
3437 :repeater-type
3443 :repeater-unit
3452 :warning-unit
3455 year-start month-start day-start hour-start minute-start year-end
3456 month-end day-end hour-end minute-end)
3457 ;; Parse date-start.
3465 ;; Compute date-end. It can be provided directly in time-stamp,
3466 ;; or extracted from time range. Otherwise, it defaults to the
3467 ;; same values as date-start.
3477 :raw-value raw-value
3478 :year-start year-start
3479 :month-start month-start
3480 :day-start day-start
3481 :hour-start hour-start
3482 :minute-start minute-start
3483 :year-end year-end
3484 :month-end month-end
3485 :day-end day-end
3486 :hour-end hour-end
3487 :minute-end minute-end
3488 :begin begin
3489 :end end
3491 repeater-props
3492 warning-props))))))
3495 "Interpret TIMESTAMP object as Org syntax.
3496 CONTENTS is nil."
3515 ;; Build an Org timestamp string from TIME. ACTIVEP is
3516 ;; non-nil when time stamp is active. If WITH-TIME-P is
3517 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3518 ;; specify a time range in the timestamp. REPEAT-STRING is
3519 ;; the repeater string, if any.
3523 org-time-stamp-formats)
3524 time)))
3530 nil nil ts)))
3535 " "
3536 s
3538 ;; Return value.
3539 ts)))
3551 build-ts-string
3570 0
3578 "--"
3591 ;;;; Underline
3594 "Parse underline object at point, if any.
3596 When at an underline object, return a list whose car is
3597 `underline' and cdr is a plist with `:begin', `:end',
3598 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3599 Otherwise, return nil.
3601 Assume point is at the first underscore marker."
3613 :end end
3614 :contents-begin contents-begin
3615 :contents-end contents-end
3619 "Interpret UNDERLINE object as Org syntax.
3620 CONTENTS is the contents of the object."
3624 ;;;; Verbatim
3627 "Parse verbatim object at point, if any.
3629 When at a verbatim object, return a list whose car is `verbatim'
3630 and cdr is a plist with `:value', `:begin', `:end' and
3631 `:post-blank' keywords. Otherwise, return nil.
3633 Assume point is at the first equal sign marker."
3644 :begin begin
3645 :end end
3649 "Interpret VERBATIM object as Org syntax.
3650 CONTENTS is nil."
3654 \f
3655 ;;; Parsing Element Starting At Point
3656 ;;
3657 ;; `org-element--current-element' is the core function of this section.
3658 ;; It returns the Lisp representation of the element starting at
3659 ;; point.
3660 ;;
3661 ;; `org-element--current-element' makes use of special modes. They
3662 ;; are activated for fixed element chaining (e.g., `plain-list' >
3663 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3664 ;; `section'). Special modes are: `first-section', `item',
3665 ;; `node-property', `section' and `table-row'.
3668 "Parse the element starting at point.
3670 Return value is a list like (TYPE PROPS) where TYPE is the type
3671 of the element and PROPS a plist of properties associated to the
3672 element.
3674 Possible types are defined in `org-element-all-elements'.
3676 LIMIT bounds the search.
3678 Optional argument GRANULARITY determines the depth of the
3679 recursion. Allowed values are `headline', `greater-element',
3680 `element', `object' or nil. When it is broader than `object' (or
3681 nil), secondary values will not be parsed, since they only
3682 contain objects.
3684 Optional argument MODE, when non-nil, can be either
3685 `first-section', `section', `planning', `item', `node-property'
3686 and `table-row'.
3688 If STRUCTURE isn't provided but MODE is set to `item', it will be
3689 computed.
3691 This function assumes point is always at the beginning of the
3692 element it has to parse."
3695 ;; Determine if parsing depth allows for secondary strings
3696 ;; parsing. It only applies to elements referenced in
3697 ;; `org-element-secondary-value-alist'.
3700 ;; Item.
3703 ;; Table Row.
3705 ;; Node Property.
3707 ;; Headline.
3710 ;; Sections (must be checked after headline).
3715 limit)))
3716 ;; Planning.
3719 ;; Property drawer.
3723 ;; When not at bol, point is at the beginning of an item or
3724 ;; a footnote definition: next item is always a paragraph.
3726 ;; Clock.
3728 ;; Inlinetask.
3731 ;; From there, elements can have affiliated keywords.
3734 ;; Jumping over affiliated keywords put point off-limits.
3735 ;; Parse them as regular keywords.
3739 ;; LaTeX Environment.
3742 ;; Drawer and Property Drawer.
3745 ;; Fixed Width
3748 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3749 ;; Keywords.
3758 org-element-block-name-alist)))
3773 ;; Footnote Definition.
3776 ;; Horizontal Rule.
3779 ;; Diary Sexp.
3782 ;; Table.
3784 ;; List.
3787 limit affiliated
3789 ;; Default element: Paragraph.
3793 ;; Most elements can have affiliated keywords. When looking for an
3794 ;; element beginning, we want to move before them, as they belong to
3795 ;; that element, and, in the meantime, collect information they give
3796 ;; into appropriate properties. Hence the following function.
3799 "Collect affiliated keywords from point down to LIMIT.
3801 Return a list whose CAR is the position at the first of them and
3802 CDR a plist of keywords and values and move point to the
3803 beginning of the first line after them.
3805 As a special case, if element doesn't start at the beginning of
3806 the line (e.g., a paragraph starting an item), CAR is current
3807 position of point and CDR is nil."
3811 ;; RESTRICT is the list of objects allowed in parsed
3812 ;; keywords value.
3814 output)
3817 ;; Apply translation to RAW-KWD. From there, KWD is
3818 ;; the official keyword.
3820 org-element-keyword-translation-alist))
3821 raw-kwd))
3822 ;; Find main value for any keyword.
3828 ;; PARSEDP is non-nil when keyword should have its
3829 ;; value parsed.
3831 ;; If KWD is a dual keyword, find its secondary
3832 ;; value. Maybe parse it.
3840 ;; Attribute a property name to KWD.
3842 ;; Now set final shape for VALUE.
3848 nil restrict)))
3852 ;; Attributes can always appear on multiple lines.
3855 ;; Eventually store the new value in OUTPUT.
3857 ;; Move to next keyword.
3859 ;; If affiliated keywords are orphaned: move back to first one.
3860 ;; They will be parsed as a paragraph.
3862 ;; Return value.
3866 \f
3867 ;;; The Org Parser
3868 ;;
3869 ;; The two major functions here are `org-element-parse-buffer', which
3870 ;; parses Org syntax inside the current buffer, taking into account
3871 ;; region, narrowing, or even visibility if specified, and
3872 ;; `org-element-parse-secondary-string', which parses objects within
3873 ;; a given string.
3874 ;;
3875 ;; The (almost) almighty `org-element-map' allows to apply a function
3876 ;; on elements or objects matching some type, and accumulate the
3877 ;; resulting values. In an export situation, it also skips unneeded
3878 ;; parts of the parse tree.
3881 "Recursively parse the buffer and return structure.
3882 If narrowing is in effect, only parse the visible part of the
3883 buffer.
3885 Optional argument GRANULARITY determines the depth of the
3886 recursion. It can be set to the following symbols:
3888 `headline' Only parse headlines.
3889 `greater-element' Don't recurse into greater elements excepted
3890 headlines and sections. Thus, elements
3891 parsed are the top-level ones.
3892 `element' Parse everything but objects and plain text.
3893 `object' Parse the complete buffer (default).
3895 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3896 elements.
3898 An element or an objects is represented as a list with the
3899 pattern (TYPE PROPERTIES CONTENTS), where :
3901 TYPE is a symbol describing the element or object. See
3902 `org-element-all-elements' and `org-element-all-objects' for an
3903 exhaustive list of such symbols. One can retrieve it with
3904 `org-element-type' function.
3906 PROPERTIES is the list of attributes attached to the element or
3907 object, as a plist. Although most of them are specific to the
3908 element or object type, all types share `:begin', `:end',
3909 `:post-blank' and `:parent' properties, which respectively
3910 refer to buffer position where the element or object starts,
3911 ends, the number of white spaces or blank lines after it, and
3912 the element or object containing it. Properties values can be
3913 obtained by using `org-element-property' function.
3915 CONTENTS is a list of elements, objects or raw strings
3916 contained in the current element or object, when applicable.
3917 One can access them with `org-element-contents' function.
3919 The Org buffer has `org-data' as type and nil as properties.
3920 `org-element-map' function can be used to find specific elements
3921 or objects within the parse tree.
3923 This function assumes that current major mode is `org-mode'."
3929 ;; Start in `first-section' mode so text before the first
3930 ;; headline belongs to a section.
3934 "Recursively parse objects in STRING and return structure.
3936 RESTRICTION is a symbol limiting the object types that will be
3937 looked after.
3939 Optional argument PARENT, when non-nil, is the element or object
3940 containing the secondary string. It is used to set correctly
3941 `:parent' property within the string.
3943 If STRING is the empty string or nil, return nil."
3959 data))))))
3963 "Map a function on selected elements or objects.
3965 DATA is a parse tree, an element, an object, a string, or a list
3966 of such constructs. TYPES is a symbol or list of symbols of
3967 elements or objects types (see `org-element-all-elements' and
3968 `org-element-all-objects' for a complete list of types). FUN is
3969 the function called on the matching element or object. It has to
3970 accept one argument: the element or object itself.
3972 When optional argument INFO is non-nil, it should be a plist
3973 holding export options. In that case, parts of the parse tree
3974 not exportable according to that property list will be skipped.
3976 When optional argument FIRST-MATCH is non-nil, stop at the first
3977 match for which FUN doesn't return nil, and return that value.
3979 Optional argument NO-RECURSION is a symbol or a list of symbols
3980 representing elements or objects types. `org-element-map' won't
3981 enter any recursive element or object whose type belongs to that
3982 list. Though, FUN can still be applied on them.
3984 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3985 apply to matching objects within parsed affiliated keywords (see
3986 `org-element-parsed-keywords').
3988 Nil values returned from FUN do not appear in the results.
3991 Examples:
3992 ---------
3994 Assuming TREE is a variable containing an Org buffer parse tree,
3995 the following example will return a flat list of all `src-block'
3996 and `example-block' elements in it:
3998 \(org-element-map tree '(example-block src-block) #'identity)
4000 The following snippet will find the first headline with a level
4003 \(org-element-map tree 'headline
4004 \(lambda (hl)
4005 \(and (= (org-element-property :level hl) 1)
4007 \(org-element-property :begin hl)))
4008 nil t)
4010 The next example will return a flat list of all `plain-list' type
4011 elements in TREE that are not a sub-list themselves:
4013 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4015 Eventually, this example will return a flat list of all `bold'
4016 type objects containing a `latex-snippet' type object, even
4017 looking into captions:
4019 \(org-element-map tree 'bold
4020 \(lambda (b)
4021 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4022 nil nil nil t)"
4023 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4027 ;; Recursion depth is determined by --CATEGORY.
4034 ;; If one object is found, the function has to
4035 ;; recurse into every object.
4038 ;; If one regular element is found, the
4039 ;; function has to recurse, at least, into
4040 ;; every element it encounters.
4043 --acc
4044 --walk-tree
4047 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4048 ;; holding contextual information.
4052 ;; Ignored element in an export context.
4054 ;; List of elements or objects.
4056 ;; Unconditionally enter parse trees.
4060 ;; Check if TYPE is matching among TYPES. If so,
4061 ;; apply FUN to --DATA and accumulate return value
4062 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4068 ;; If --DATA has a secondary string that can contain
4069 ;; objects with their type among TYPES, look into it.
4072 org-element-secondary-value-alist)))
4074 ;; If --DATA has any parsed affiliated keywords and
4075 ;; WITH-AFFILIATED is non-nil, look for objects in
4076 ;; them.
4083 ;; Pay attention to the type of parsed keyword.
4084 ;; In particular, preserve order for multiple
4085 ;; keywords.
4098 ;; Determine if a recursion into --DATA is possible.
4100 ;; --TYPE is explicitly removed from recursion.
4102 ;; --DATA has no contents.
4104 ;; Looking for greater elements but --DATA is simply
4105 ;; an element or an object.
4108 ;; Looking for elements but --DATA is an object.
4111 ;; In any other case, map contents.
4115 ;; Return value in a proper order.
4119 ;; The following functions are internal parts of the parser.
4120 ;;
4121 ;; The first one, `org-element--parse-elements' acts at the element's
4122 ;; level.
4123 ;;
4124 ;; The second one, `org-element--parse-objects' applies on all objects
4125 ;; of a paragraph or a secondary string. It calls
4126 ;; `org-element--object-lex' to find the next object in the current
4127 ;; container.
4130 "Return next special mode according to TYPE, or nil.
4131 TYPE is a symbol representing the type of an element or object
4132 containing next element if PARENTP is non-nil, or before it
4133 otherwise. Modes can be either `first-section', `item',
4134 `node-property', `planning', `property-drawer', `section',
4135 `table-row' or nil."
4151 "Parse elements between BEG and END positions.
4153 MODE prioritizes some elements over the others. It can be set to
4154 `first-section', `section', `planning', `item', `node-property'
4155 or `table-row'.
4157 When value is `item', STRUCTURE will be used as the current list
4158 structure.
4160 GRANULARITY determines the depth of the recursion. See
4161 `org-element-parse-buffer' for more information.
4163 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4164 elements.
4166 Elements are accumulated into ACC."
4169 ;; Visible only: skip invisible parts at the beginning of the
4170 ;; element.
4173 ;; When parsing only headlines, skip any text before first one.
4176 ;; Main loop start.
4178 ;; Find current element's type and parse it accordingly to
4179 ;; its category.
4181 end granularity mode structure))
4185 ;; Visible only: skip invisible parts between siblings.
4188 ;; Fill ELEMENT contents by side-effect.
4190 ;; If element has no contents, don't modify it.
4192 ;; Greater element: parse it between `contents-begin' and
4193 ;; `contents-end'. Make sure GRANULARITY allows the
4194 ;; recursion, or ELEMENT is a headline, in which case going
4195 ;; inside is mandatory, in order to get sub-level headings.
4203 ;; Possibly switch to a special mode.
4207 granularity visible-only element))
4208 ;; ELEMENT has contents. Parse objects inside, if
4209 ;; GRANULARITY allows it.
4215 ;; Update mode.
4217 ;; Return result.
4218 acc))
4221 "Return next object in current buffer or nil.
4222 RESTRICTION is a list of object types, as symbols, that should be
4223 looked after. This function assumes that the buffer is narrowed
4224 to an appropriate container (e.g., a paragraph)."
4232 found)
4297 ;; This is probably a plain link.
4303 ;; Radio link.
4308 "Parse objects between BEG and END and return recursive structure.
4310 Objects are accumulated in ACC.
4312 RESTRICTION is a list of object successors which are allowed in
4313 the current object."
4321 ;; 1. Text before any object. Untabify it.
4326 acc
4330 ;; 2. Object...
4333 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4334 ;; a recursive type.
4342 ;; 3. Text after last object. Untabify it.
4346 acc
4350 ;; Result.
4351 acc)))
4354 \f
4355 ;;; Towards A Bijective Process
4356 ;;
4357 ;; The parse tree obtained with `org-element-parse-buffer' is really
4358 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4359 ;; interpreted and expanded into a string with canonical Org syntax.
4360 ;; Hence `org-element-interpret-data'.
4361 ;;
4362 ;; The function relies internally on
4363 ;; `org-element--interpret-affiliated-keywords'.
4365 ;;;###autoload
4367 "Interpret DATA as Org syntax.
4368 DATA is a parse tree, an element, an object or a secondary string
4369 to interpret. Return Org syntax as a string."
4373 "Interpret DATA as Org syntax.
4375 DATA is a parse tree, an element, an object or a secondary string
4376 to interpret. PARENT is used for recursive calls. It contains
4377 the element or object containing data, or nil.
4379 Return Org syntax as a string."
4381 ;; Find interpreter for current object or element. If it
4382 ;; doesn't exist (e.g. this is a pseudo object or element),
4383 ;; return contents, if any.
4389 ;; Secondary string.
4393 ;; Full Org document.
4397 ;; Plain text: return it.
4399 ;; Element or object without contents.
4401 ;; Element or object with contents.
4404 ;; Recursively interpret contents.
4409 data
4410 ;; Fix indentation of elements containing
4411 ;; objects. We ignore `table-row' elements
4412 ;; as they are one line long anyway.
4414 data
4415 ;; When normalizing first paragraph of an
4416 ;; item or a footnote-definition, ignore
4417 ;; first line's indentation.
4424 ;; Build white spaces. If no `:post-blank' property is
4425 ;; specified, assume its value is 0.
4439 "Return ELEMENT's affiliated keywords as Org syntax.
4440 If there is no affiliated keyword, return the empty string."
4450 ": "
4453 value)
4461 ;; All attribute keywords can have multiple lines.
4467 ;; List all ELEMENT's properties matching an attribute line or an
4468 ;; affiliated keyword, but ignore translated keywords since they
4469 ;; cannot belong to the property list.
4476 org-element-keyword-translation-alist)))))
4477 collect prop)
4480 ;; Because interpretation of the parse tree must return the same
4481 ;; number of blank lines between elements and the same number of white
4482 ;; space after objects, some special care must be given to white
4483 ;; spaces.
4484 ;;
4485 ;; The first function, `org-element-normalize-string', ensures any
4486 ;; string different from the empty string will end with a single
4487 ;; newline character.
4488 ;;
4489 ;; The second function, `org-element-normalize-contents', removes
4490 ;; global indentation from the contents of the current element.
4493 "Ensure string S ends with a single newline character.
4495 If S isn't a string return it unchanged. If S is the empty
4496 string, return it. Otherwise, return a new string with a single
4497 newline character at its end."
4505 "Normalize plain text in ELEMENT's contents.
4507 ELEMENT must only contain plain text and objects.
4509 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4510 indentation to compute maximal common indentation.
4512 Return the normalized element that is element with global
4513 indentation removed from its contents. The function assumes that
4514 indentation is not done with TAB characters."
4516 find-min-ind ; For byte-compiler.
4518 ;; Return minimal common indentation within BLOB. This is
4519 ;; done by walking recursively BLOB and updating MIN-IND
4520 ;; along the way. FIRST-FLAG is non-nil when the next
4521 ;; object is expected to be a string that doesn't start with
4522 ;; a newline character. It happens for strings at the
4523 ;; beginnings of the contents or right after a line break.
4528 ;; Objects cannot start with spaces: in this case,
4529 ;; indentation is 0.
4533 ;; An indentation of zero means no string will be
4534 ;; modified. Quit the process.
4545 ;; Find minimal indentation in ELEMENT.
4548 ;; Build ELEMENT back, replacing each string with the same
4549 ;; string minus common indentation.
4553 ;; Return BLOB with all its strings indentation
4554 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4555 ;; non-nil when the next object is expected to be
4556 ;; a string that doesn't start with a newline
4557 ;; character.
4573 org-element-recursive-objects)
4577 object)
4580 blob)))
4584 \f
4585 ;;; Cache
4586 ;;
4587 ;; Implement a caching mechanism for `org-element-at-point' and
4588 ;; `org-element-context', which see.
4589 ;;
4590 ;; A single public function is provided: `org-element-cache-reset'.
4591 ;;
4592 ;; Cache is enabled by default, but can be disabled globally with
4593 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4594 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4595 ;; can be tweaked to control caching behaviour.
4596 ;;
4597 ;; Internally, parsed elements are stored in an AVL tree,
4598 ;; `org-element--cache'. This tree is updated lazily: whenever
4599 ;; a change happens to the buffer, a synchronization request is
4600 ;; registered in `org-element--cache-sync-requests' (see
4601 ;; `org-element--cache-submit-request'). During idle time, requests
4602 ;; are processed by `org-element--cache-sync'. Synchronization also
4603 ;; happens when an element is required from the cache. In this case,
4604 ;; the process stops as soon as the needed element is up-to-date.
4605 ;;
4606 ;; A synchronization request can only apply on a synchronized part of
4607 ;; the cache. Therefore, the cache is updated at least to the
4608 ;; location where the new request applies. Thus, requests are ordered
4609 ;; from left to right and all elements starting before the first
4610 ;; request are correct. This property is used by functions like
4611 ;; `org-element--cache-find' to retrieve elements in the part of the
4612 ;; cache that can be trusted.
4613 ;;
4614 ;; A request applies to every element, starting from its original
4615 ;; location (or key, see below). When a request is processed, it
4616 ;; moves forward and may collide the next one. In this case, both
4617 ;; requests are merged into a new one that starts from that element.
4618 ;; As a consequence, the whole synchronization complexity does not
4619 ;; depend on the number of pending requests, but on the number of
4620 ;; elements the very first request will be applied on.
4621 ;;
4622 ;; Elements cannot be accessed through their beginning position, which
4623 ;; may or may not be up-to-date. Instead, each element in the tree is
4624 ;; associated to a key, obtained with `org-element--cache-key'. This
4625 ;; mechanism is robust enough to preserve total order among elements
4626 ;; even when the tree is only partially synchronized.
4627 ;;
4628 ;; Objects contained in an element are stored in a hash table,
4629 ;; `org-element--cache-objects'.
4633 "Non nil when Org parser should cache its results.
4640 "Maximum duration, as a time value, for a cache synchronization.
4641 If the synchronization is not over after this delay, the process
4642 pauses and resumes after `org-element-cache-sync-break'
4646 "Duration, as a time value, of the pause between synchronizations.
4650 ;;;; Data Structure
4653 "AVL tree used to cache elements.
4654 Each node of the tree contains an element. Comparison is done
4655 with `org-element--cache-compare'. This cache is used in
4659 "Hash table used as to cache objects.
4660 Key is an element, as returned by `org-element-at-point', and
4661 value is an alist where each association is:
4663 \(PARENT COMPLETEP . OBJECTS)
4665 where PARENT is an element or object, COMPLETEP is a boolean,
4666 non-nil when all direct children of parent are already cached and
4667 OBJECTS is a list of such children, as objects, from farthest to
4668 closest.
4671 contained within a paragraph
4675 If the paragraph is completely parsed, OBJECTS-DATA will be
4677 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4678 \(BOLD-OBJECT t ENTITY-OBJECT))
4680 whereas in a partially parsed paragraph, it could be
4682 \((PARAGRAPH nil ENTITY-OBJECT))
4687 "List of pending synchronization requests.
4689 A request is a vector with the following pattern:
4691 \[NEXT BEG END OFFSET PARENT PHASE]
4693 Processing a synchronization request consists of three phases:
4695 0. Delete modified elements,
4696 1. Fill missing area in cache,
4697 2. Shift positions and re-parent elements after the changes.
4699 During phase 0, NEXT is the key of the first element to be
4700 removed, BEG and END is buffer position delimiting the
4701 modifications. Elements starting between them (inclusive) are
4702 removed. So are elements whose parent is removed. PARENT, when
4703 non-nil, is the parent of the first element to be removed.
4705 During phase 1, NEXT is the key of the next known element in
4706 cache and BEG its beginning position. Parse buffer between that
4707 element and the one before it in order to determine the parent of
4708 the next element. Set PARENT to the element containing NEXT.
4710 During phase 2, NEXT is the key of the next element to shift in
4711 the parse tree. All elements starting from this one have their
4712 properties relatives to buffer positions shifted by integer
4713 OFFSET and, if they belong to element PARENT, are adopted by it.
4721 "Hash table used to store keys during synchronization.
4725 "Return a unique key for ELEMENT in cache tree.
4727 Keys are used to keep a total order among elements in the cache.
4728 Comparison is done with `org-element--cache-key-less-p'.
4730 When no synchronization is taking place, a key is simply the
4731 beginning position of the element, or that position plus one in
4732 the case of an first item (respectively row) in
4733 a list (respectively a table).
4735 During a synchronization, the key is the one the element had when
4736 the cache was synchronized for the last time. Elements added to
4737 cache during the synchronization get a new key generated with
4738 `org-element--cache-generate-key'.
4740 Such keys are stored in `org-element--cache-sync-keys'. The hash
4741 table is cleared once the synchronization is complete."
4744 ;; Increase beginning position of items (respectively
4745 ;; table rows) by one, so the first item can get
4746 ;; a different key from its parent list (respectively
4747 ;; table).
4750 begin)))
4753 key))))
4756 "Generate a key between LOWER and UPPER.
4758 LOWER and UPPER are integers or lists, possibly empty.
4760 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4761 a unique key, as an integer or a list of integers, according to
4762 the following rules:
4764 - LOWER and UPPER are compared level-wise until values differ.
4766 - If, at a given level, LOWER and UPPER differ from more than
4767 2, the new key shares all the levels above with LOWER and
4768 gets a new level. Its value is the mean between LOWER and
4769 UPPER:
4771 \(1 2) + (1 4) --> (1 3)
4773 - If LOWER has no value to compare with, it is assumed that its
4774 value is `most-negative-fixnum'. E.g.,
4776 \(1 1) + (1 1 2)
4778 is equivalent to
4780 \(1 1 m) + (1 1 2)
4782 where m is `most-negative-fixnum'. Likewise, if UPPER is
4783 short of levels, the current value is `most-positive-fixnum'.
4785 - If they differ from only one, the new key inherits from
4786 current LOWER level and fork it at the next level. E.g.,
4788 \(2 1) + (3 3)
4790 is equivalent to
4792 \(2 1) + (2 M)
4794 where M is `most-positive-fixnum'.
4796 - If the key is only one level long, it is returned as an
4797 integer:
4799 \(1 2) + (3 2) --> 2
4801 When they are not equals, the function assumes that LOWER is
4802 lesser than UPPER, per `org-element--cache-key-less-p'."
4806 skip-upper key)
4817 ;; When at a given level, LOWER and UPPER differ from
4818 ;; 1, ignore UPPER altogether. Instead create a key
4819 ;; between LOWER and the greatest key with the same
4820 ;; prefix as LOWER so far.
4826 "Non-nil if key A is less than key B.
4827 A and B are either integers or lists of integers, as returned by
4828 `org-element--cache-key'."
4836 ;; If A is empty, either keys are equal (B is also empty) and
4837 ;; we return nil, or A is lesser than B (B is longer) and we
4838 ;; return a non-nil value.
4839 ;;
4840 ;; If A is not empty, B is necessarily empty and A is greater
4841 ;; than B (A is longer). Therefore, return nil.
4845 "Non-nil when element A is located before element B."
4850 "Return root value in cache.
4851 This function assumes `org-element--cache' is a valid AVL tree."
4855 ;;;; Tools
4858 "Non-nil when cache is active in current buffer."
4863 "Find element in cache starting at POS or before.
4865 POS refers to a buffer position.
4867 When optional argument SIDE is non-nil, the function checks for
4868 elements starting at or past POS instead. If SIDE is `both', the
4869 function returns a cons cell where car is the first element
4870 starting at or before POS and cdr the first element starting
4871 after POS.
4873 The function can only find elements in the synchronized part of
4874 the cache."
4878 lower upper)
4893 ;; We found an element in cache starting at POS. If `side'
4894 ;; is `both' we also want the next one in order to generate
4895 ;; a key in-between.
4896 ;;
4897 ;; If the element is the first row or item in a table or
4898 ;; a plain list, we always return the table or the plain
4899 ;; list.
4900 ;;
4901 ;; In any other case, we return the element found.
4910 lower parent
4911 upper parent)))))
4914 lower element
4915 upper element)))))
4922 "Store ELEMENT in current buffer's cache, if allowed.
4923 When optional argument DATA is non-nil, assume is it object data
4924 relative to ELEMENT and store it in the objects cache."
4928 ;; During synchronization, first build an appropriate key
4929 ;; for the new element so `avl-tree-enter' can insert it at
4930 ;; the right spot in the cache.
4939 org-element--cache-sync-keys)))
4941 ;; Headlines are not stored in cache, so objects in titles are
4942 ;; not stored either.
4947 "Remove ELEMENT from cache.
4948 Assume ELEMENT belongs to cache and that a cache is active."
4953 ;;;; Synchronization
4956 "Set idle timer for cache synchronization in BUFFER."
4963 org-element-cache-sync-idle-time))
4964 nil
4965 #'org-element--cache-sync
4966 buffer)))
4969 "Non-nil when synchronization process should be interrupted.
4970 TIME-LIMIT is a time value or nil."
4976 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4978 Properties containing buffer positions are `:begin', `:end',
4979 `:contents-begin', `:contents-end' and `:structure'. When
4980 optional argument PROPS is a list of keywords, only shift
4981 properties provided in that list.
4983 Properties are modified by side-effect."
4985 ;; Shift `:structure' property for the first plain list only: it
4986 ;; is the only one that really matters and it prevents from
4987 ;; shifting it more than once.
5001 "Synchronize cache with recent modification in BUFFER.
5003 When optional argument THRESHOLD is non-nil, do the
5004 synchronization for all elements starting before or at threshold,
5005 then exit. Otherwise, synchronize cache for as long as
5006 `org-element-cache-sync-duration' or until Emacs leaves idle
5007 state.
5009 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5010 not registered yet in the cache are going to happen. It is used
5011 in `org-element--cache-submit-request', where cache is partially
5012 updated before current modification are actually submitted."
5023 request
5025 threshold
5028 org-element-cache-sync-duration))
5029 future-change)
5030 ;; Request processed. Merge current and next offsets and
5031 ;; transfer ending position.
5037 ;; If more requests are awaiting, set idle timer accordingly.
5038 ;; Otherwise, reset keys.
5045 "Process synchronization REQUEST for all entries before NEXT.
5047 REQUEST is a vector, built by `org-element--cache-submit-request'.
5049 NEXT is a cache key, as returned by `org-element--cache-key'.
5051 When non-nil, THRESHOLD is a buffer position. Synchronization
5052 stops as soon as a shifted element begins after it.
5054 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5055 after this time or when Emacs exits idle state.
5057 When non-nil, FUTURE-CHANGE is a buffer position where changes
5058 not registered yet in the cache are going to happen. See
5059 `org-element--cache-submit-request' for more information.
5061 Throw `interrupt' if the process stops before completing the
5062 request."
5065 ;; Phase 0.
5066 ;;
5067 ;; Delete all elements starting after BEG, but not after buffer
5068 ;; position END or past element with key NEXT. Also delete
5069 ;; elements contained within a previously removed element
5070 ;; (stored in `last-container').
5071 ;;
5072 ;; At each iteration, we start again at tree root since
5073 ;; a deletion modifies structure of the balanced tree.
5078 ;; Find first element in cache with key BEG or after it.
5082 data data-key last-container)
5091 data-key key
5094 data-key key
5095 node nil)))))
5105 up)))
5108 end))
5115 ;; No element starting after modifications left in
5116 ;; cache: further processing is futile.
5119 ;; Phase 1.
5120 ;;
5121 ;; Phase 0 left a hole in the cache. Some elements after it
5122 ;; could have parents within. For example, in the following
5123 ;; buffer:
5124 ;;
5125 ;; - item
5126 ;;
5127 ;;
5128 ;; Paragraph1
5129 ;;
5130 ;; Paragraph2
5131 ;;
5132 ;; if we remove a blank line between "item" and "Paragraph1",
5133 ;; everything down to "Paragraph2" is removed from cache. But
5134 ;; the paragraph now belongs to the list, and its `:parent'
5135 ;; property no longer is accurate.
5136 ;;
5137 ;; Therefore we need to parse again elements in the hole, or at
5138 ;; least in its last section, so that we can re-parent
5139 ;; subsequent elements, during phase 2.
5140 ;;
5141 ;; Note that we only need to get the parent from the first
5142 ;; element in cache after the hole.
5143 ;;
5144 ;; When next key is lesser or equal to the current one, delegate
5145 ;; phase 1 processing to next request in order to preserve key
5146 ;; order among requests.
5154 ;; Next element will start at its beginning position plus
5155 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5156 ;; contains the real beginning position of the first element to
5157 ;; shift and re-parent.
5161 ;; Changes are going to happen around this element and
5162 ;; they will trigger another phase 1 request. Skip the
5163 ;; current one.
5169 ;; Phase 2.
5170 ;;
5171 ;; Shift all elements starting from key START, but before NEXT, by
5172 ;; OFFSET, and re-parent them when appropriate.
5173 ;;
5174 ;; Elements are modified by side-effect so the tree structure
5175 ;; remains intact.
5176 ;;
5177 ;; Once THRESHOLD, if any, is reached, or once there is an input
5178 ;; pending, exit. Before leaving, the current synchronization
5179 ;; request is updated.
5186 exit-flag)
5187 ;; No re-parenting nor shifting planned: request is over.
5197 ;; We reached NEXT. Request is complete.
5199 ;; Handle interruption request. Update current request.
5204 ;; Shift element.
5207 ;; Shift associated objects data, if any.
5212 ;; Update PARENT and re-parent DATA, only when
5213 ;; necessary. Propagate new structures for lists.
5227 ;; Cache is up-to-date past THRESHOLD. Request
5228 ;; interruption.
5233 ;; We reached end of tree: synchronization complete.
5234 t)))
5237 "Parse elements in current section, down to POS.
5239 Start parsing from the closest between the last known element in
5240 cache or headline above. Return the smallest element containing
5241 POS.
5243 When optional argument SYNCP is non-nil, return the parent of the
5244 element containing POS instead. In that case, it is also
5245 possible to provide TIME-LIMIT, which is a time value specifying
5246 when the parsing should stop. The function throws `interrupt' if
5247 the process stopped before finding the expected result."
5254 element next mode)
5256 ;; Nothing in cache before point: start parsing from first
5257 ;; element following headline above, or first element in
5258 ;; buffer.
5265 ;; Cache returned exact match: return it.
5268 ;; There's a headline between cached value and POS: cached
5269 ;; value is invalid. Start parsing from first element
5270 ;; following the headline.
5277 ;; Check if CACHED or any of its ancestors contain point.
5278 ;;
5279 ;; If there is such an element, we inspect it in order to know
5280 ;; if we return it or if we need to parse its contents.
5281 ;; Otherwise, we just start parsing from current location,
5282 ;; which is right after the top-most element containing
5283 ;; CACHED.
5284 ;;
5285 ;; As a special case, if POS is at the end of the buffer, we
5286 ;; want to return the innermost element ending there.
5287 ;;
5288 ;; Also, if we find an ancestor and discover that we need to
5289 ;; parse its contents, make sure we don't start from
5290 ;; `:contents-begin', as we would otherwise go past CACHED
5291 ;; again. Instead, in that situation, we will resume parsing
5292 ;; from NEXT, which is located after CACHED or its higher
5293 ;; ancestor not containing point.
5305 ;; Parse successively each element until we reach POS.
5318 end 'element mode
5325 ;; Skip any element ending before point. Also skip
5326 ;; element ending at point (unless it is also the end of
5327 ;; buffer) since we're sure that another element begins
5328 ;; after it.
5332 ;; A non-greater element contains point: return it.
5335 ;; Otherwise, we have to decide if ELEMENT really
5336 ;; contains POS. In that case we start parsing from
5337 ;; contents' beginning.
5338 ;;
5339 ;; If POS is at contents' beginning but it is also at
5340 ;; the beginning of the first item in a list or a table.
5341 ;; In that case, we need to create an anchor for that
5342 ;; list or table, so return it.
5343 ;;
5344 ;; Also, if POS is at the end of the buffer, no element
5345 ;; can start after it, but more than one may end there.
5346 ;; Arbitrarily, we choose to return the innermost of
5347 ;; such elements.
5360 parent element
5361 end cend))))
5362 ;; Otherwise, return ELEMENT as it is the smallest
5363 ;; element containing POS.
5368 ;;;; Staging Buffer Changes
5379 "Regexp matching a sensitive line, structure wise.
5380 A sensitive line is a headline, inlinetask, block, drawer, or
5381 latex-environment boundary. When such a line is modified,
5382 structure changes in the document may propagate in the whole
5386 "Non-nil when a sensitive line is about to be changed.
5390 "Request extension of area going to be modified if needed.
5391 BEG and END are the beginning and end of the range of changed
5392 text. See `before-change-functions' for more information."
5402 'headline
5405 org-element--cache-sensitive-re bottom t)))))))))
5408 "Update buffer modifications for current buffer.
5409 BEG and END are the beginning and end of the range of changed
5410 text, and the length in bytes of the pre-change text replaced by
5411 that range. See `after-change-functions' for more information."
5419 ;; Determine if modified area needs to be extended, according
5420 ;; to both previous and current state. We make a special
5421 ;; case for headline editing: if a headline is modified but
5422 ;; not removed, do not extend.
5431 org-element--cache-sensitive-re bottom t))))
5432 ;; Effectively extend modified area.
5440 ;; Store synchronization request.
5443 ;; Activate a timer to process the request during idle time.
5447 "Return first element to remove from cache.
5449 BEG and END are buffer positions delimiting buffer modifications.
5450 OFFSET is the size of the changes.
5452 Returned element is usually the first element in cache containing
5453 any position between BEG and END. As an exception, greater
5454 elements around the changes that are robust to contents
5455 modifications are preserved and updated according to the
5456 changes."
5466 special-block))
5467 ;; Drawers named "PROPERTIES" are probably
5468 ;; a properties drawer being edited. Force
5469 ;; parsing to check if editing is over.
5478 ;; UP is a robust greater element containing changes.
5479 ;; We only need to extend its ending boundaries.
5485 ;; We're at top level element containing ELEMENT: if it's
5486 ;; altered by buffer modifications, it is first element in
5487 ;; cache to be removed. Otherwise, that first element is the
5488 ;; following one.
5489 ;;
5490 ;; As a special case, do not remove BEFORE if it is a robust
5491 ;; container for current changes.
5493 before)))))
5496 "Submit a new cache synchronization request for current buffer.
5497 BEG and END are buffer positions delimiting the minimal area
5498 where cache data should be removed. OFFSET is the size of the
5499 change, as an integer."
5501 delete-to delete-from)
5506 ;; Current changes can be merged with first sync request: we
5507 ;; can save a partial cache synchronization.
5510 ;; If last change happened within area to be removed, extend
5511 ;; boundaries of robust parents, if any. Otherwise, find
5512 ;; first element to remove and update request accordingly.
5524 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5525 ;; if any, is no longer a 0-phase request, thus ensuring that
5526 ;; phases are properly ordered. We need to provide OFFSET as
5527 ;; optional parameter since current modifications are not known
5528 ;; yet to the otherwise correct part of the cache (i.e, before
5529 ;; the first request).
5536 ;; When changes happen before the first known
5537 ;; element, re-parent and shift the rest of the
5538 ;; cache.
5540 ;; Otherwise, we find the first non robust
5541 ;; element containing END. All elements between
5542 ;; FIRST and this one are to be removed.
5553 element up))
5555 org-element--cache-sync-requests)
5556 ;; No element to remove. No need to re-parent either.
5557 ;; Simply shift additional elements, if any, by OFFSET.
5562 ;;;; Public Functions
5564 ;;;###autoload
5566 "Reset cache in current buffer.
5567 When optional argument ALL is non-nil, reset cache in all Org
5568 buffers."
5586 ;;;###autoload
5588 "Refresh cache at position POS."
5595 \f
5596 ;;; The Toolbox
5597 ;;
5598 ;; The first move is to implement a way to obtain the smallest element
5599 ;; containing point. This is the job of `org-element-at-point'. It
5600 ;; basically jumps back to the beginning of section containing point
5601 ;; and proceed, one element after the other, with
5602 ;; `org-element--current-element' until the container is found. Note:
5603 ;; When using `org-element-at-point', secondary values are never
5604 ;; parsed since the function focuses on elements, not on objects.
5605 ;;
5606 ;; At a deeper level, `org-element-context' lists all elements and
5607 ;; objects containing point.
5608 ;;
5609 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5610 ;; internally by navigation and manipulation tools.
5613 ;;;###autoload
5615 "Determine closest element around point.
5617 Return value is a list like (TYPE PROPS) where TYPE is the type
5618 of the element and PROPS a plist of properties associated to the
5619 element.
5621 Possible types are defined in `org-element-all-elements'.
5622 Properties depend on element or object type, but always include
5623 `:begin', `:end', `:parent' and `:post-blank' properties.
5625 As a special case, if point is at the very beginning of the first
5626 item in a list or sub-list, returned element will be that list
5627 instead of the item. Likewise, if point is at the beginning of
5628 the first row of a table, returned element will be the table
5629 instead of the first row.
5631 When point is at the end of the buffer, return the innermost
5632 element ending there."
5638 ;; Within blank lines at the beginning of buffer, return nil.
5640 ;; Within blank lines right after a headline, return that
5641 ;; headline.
5645 ;; Otherwise parse until we find element containing ORIGIN.
5652 ;;;###autoload
5654 "Return smallest element or object around point.
5656 Return value is a list like (TYPE PROPS) where TYPE is the type
5657 of the element or object and PROPS a plist of properties
5658 associated to it.
5660 Possible types are defined in `org-element-all-elements' and
5661 `org-element-all-objects'. Properties depend on element or
5662 object type, but always include `:begin', `:end', `:parent' and
5663 `:post-blank'.
5665 As a special case, if point is right after an object and not at
5666 the beginning of any other object, return that object.
5668 Optional argument ELEMENT, when non-nil, is the closest element
5669 containing point, as returned by `org-element-at-point'.
5670 Providing it allows for quicker computation."
5676 ;; If point is inside an element containing objects or
5677 ;; a secondary string, narrow buffer to the container and
5678 ;; proceed with parsing. Otherwise, return ELEMENT.
5680 ;; At a parsed affiliated keyword, check if we're inside main
5681 ;; or dual value.
5688 org-element-parsed-keywords))
5697 ;; Also change type to retrieve correct restrictions.
5699 ;; At an item, objects can only be located within tag, if any.
5709 ;; At an headline or inlinetask, objects are in title.
5716 ;; At a paragraph, a table-row or a verse block, objects are
5717 ;; located within their contents.
5721 ;; CBEG is nil for table rules.
5726 ;; At a planning line, if point is at a timestamp, return it,
5727 ;; otherwise, return element.
5735 ;; All other locations cannot contain objects: bail out.
5745 next object-data last)
5749 ;; When entering PARENT for the first time, get list
5750 ;; of objects within known so far. Store it in
5751 ;; OBJECT-DATA.
5756 ;; Find NEXT object for analysis.
5758 ;; If NEXT is non-nil, we already exhausted the
5759 ;; cache so we can parse buffer to find the object
5760 ;; after it.
5762 ;; Otherwise, check if cache can help us.
5773 ;; Cache contains the information needed.
5776 pos)
5778 pos)
5784 ;; If we have a new object to analyze, store it in
5785 ;; cache. Otherwise record that there is nothing
5786 ;; more to parse in this element at this depth.
5791 ;; Process NEXT, if any, in order to know if we need
5792 ;; to skip it, return it or move into it.
5799 ;; Skip objects ending before point. Also skip
5800 ;; objects ending at point unless it is also the
5801 ;; end of buffer, since we want to return the
5802 ;; innermost object.
5805 ;; For convenience, when object ends at POS,
5806 ;; without any space, store it in LAST, as we
5807 ;; will return it if no object starts here.
5811 ;; If POS is within a container object, move
5812 ;; into that object.
5816 ;; At contents' end, if there is no
5817 ;; space before point, also move into
5818 ;; object, for consistency with
5819 ;; convenience feature above.
5828 next nil
5829 object-data nil))
5830 ;; Otherwise, return NEXT.
5832 ;; Store results in cache, if applicable.
5836 "List all ancestors of a given element or object.
5838 BLOB is an object or element.
5840 When optional argument TYPES is a list of symbols, return the
5841 first element or object in the lineage whose type belongs to that
5842 list.
5844 When optional argument WITH-SELF is non-nil, lineage includes
5845 BLOB itself as the first element, and TYPES, if provided, also
5846 apply to it.
5848 When BLOB is obtained through `org-element-context' or
5849 `org-element-at-point', only ancestors from its section can be
5850 found. There is no such limitation when BLOB belongs to a full
5851 parse tree."
5853 ancestors)
5860 "Non-nil when elements ELEM-A and ELEM-B are nested."
5869 "Swap elements ELEM-A and ELEM-B.
5870 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5871 end of ELEM-A."
5873 ;; There are two special cases when an element doesn't start at bol:
5874 ;; the first paragraph in an item or in a footnote definition.
5876 ;; Only a paragraph without any affiliated keyword can be moved at
5877 ;; ELEM-A position in such a situation. Note that the case of
5878 ;; a footnote definition is impossible: it cannot contain two
5879 ;; paragraphs in a row because it cannot contain a blank line.
5885 ;; In a special situation, ELEM-A will have no indentation. We'll
5886 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5900 ;; Store inner overlays responsible for visibility status.
5901 ;; We also need to store their boundaries as they will be
5902 ;; removed from buffer.
5917 ;; Get contents.
5925 ;; Restore ex ELEM-A overlays.
5932 ;; Restore ex ELEM-B overlays.
5938 "Remove maximum common indentation in string S and return it.
5939 When optional argument N is a positive integer, remove exactly
5940 that much characters from indentation, if possible, or return
5941 S as-is otherwise. Unlike to `org-remove-indentation', this
5942 function doesn't call `untabify' on S."
5947 ;; Find maximum common indentation, if not specified.
5955 min-ind)))
5957 ;; Remove exactly N indentation, but give up if not possible.
5970 ;; Local variables:
5971 ;; generated-autoload-file: "org-loaddefs.el"
5972 ;; End:
5974 ;;; org-element.el ends here