| blob | d5d4bb9d774e9974c681e0f384168b0264041af2 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
162 ;; Blocks (any type), Babel calls and keywords. This
163 ;; is only an indication and need some thorough check.
165 ;; Drawers (any type) and fixed-width areas. This is
166 ;; also only an indication.
168 ;; Horizontal rules.
170 ;; LaTeX environments.
172 ;; Clock lines.
174 ;; Lists.
181 org-element--object-regexp
185 ;; Sub/superscript.
187 ;; Bold, code, italic, strike-through, underline
188 ;; and verbatim.
192 ;; Plain links.
194 ;; Objects starting with "[": regular link,
195 ;; footnote reference, statistics cookie,
196 ;; timestamp (inactive).
198 ;; Objects starting with "@": export snippets.
199 "@@"
200 ;; Objects starting with "{": macro.
201 "{{{"
202 ;; Objects starting with "<" : timestamp
203 ;; (active, diary), target, radio target and
204 ;; angular links.
206 ;; Objects starting with "$": latex fragment.
208 ;; Objects starting with "\": line break,
209 ;; entity, latex fragment.
211 ;; Objects starting with raw text: inline Babel
212 ;; source block, inline Babel call.
218 ;;;###autoload
220 "Update parser internals."
227 dynamic-block example-block export-block fixed-width
228 footnote-definition headline horizontal-rule inlinetask item
229 keyword latex-environment node-property paragraph plain-list
230 planning property-drawer quote-block section
231 special-block src-block table table-row verse-block)
236 item plain-list property-drawer quote-block section
237 special-block table)
242 inline-src-block italic line-break latex-fragment link macro
243 radio-target statistics-cookie strike-through subscript superscript
244 table-cell target timestamp underline verbatim)
249 superscript table-cell underline)
259 "Alist between block names and the associated parsing function.
260 Names must be uppercase. Any block whose name has no association
266 Only these types can accept search options and an explicit
272 "List of affiliated keywords as strings.
280 "Alist of usual translations for keywords.
281 The key is the old name and the value the new one. The property
285 "List of affiliated keywords that can occur more than once in an element.
287 Their value will be consed into a list of strings, which will be
288 returned as the value of the property.
290 This list is checked after translations have been applied. See
291 `org-element-keyword-translation-alist'.
297 "List of affiliated keywords whose value can be parsed.
299 Their value will be stored as a secondary string: a list of
300 strings and objects.
302 This list is checked after translations have been applied. See
306 "List of affiliated keywords which can have a secondary value.
308 In Org syntax, they can be written with optional square brackets
309 before the colons. For example, RESULTS keyword can be
310 associated to a hash value with the following:
312 #+RESULTS[hash-string]: some-source
314 This list is checked after translations have been applied. See
318 "List of properties associated to the whole document.
319 Any keyword in this list will have its value parsed and stored as
325 ;; Dual affiliated keywords.
329 ;; Regular affiliated keywords.
335 org-element-affiliated-keywords)))
337 ;; Export attributes.
339 "Regexp matching any affiliated keyword.
341 Keyword name is put in match group 1. Moreover, if keyword
342 belongs to `org-element-dual-keywords', put the dual value in
343 match group 2.
357 ;; Ignore all links excepted plain links in a link description.
358 ;; Also ignore radio-targets and line breaks.
360 italic latex-fragment macro plain-link statistics-cookie
361 strike-through subscript superscript underline verbatim)
363 ;; Remove any variable object from radio target as it would
364 ;; prevent it from being properly recognized.
366 subscript superscript underline superscript)
370 ;; Ignore inline babel call and inline src block as formulas are
371 ;; possible. Also ignore line breaks and statistics cookies.
373 latex-fragment link macro radio-target strike-through
374 subscript superscript target timestamp underline verbatim)
378 "Alist of objects restrictions.
380 key is an element or object type containing objects and value is
381 a list of types that can be contained within an element or object
382 of such type.
384 For example, in a `radio-target' object, one can only find
385 entities, latex-fragments, subscript, superscript and text
386 markup.
388 This alist also applies to secondary string. For example, an
389 `headline' type element doesn't directly contain objects, but
399 \f
400 ;;; Accessors and Setters
401 ;;
402 ;; Provide four accessors: `org-element-type', `org-element-property'
403 ;; `org-element-contents' and `org-element-restriction'.
404 ;;
405 ;; Setter functions allow to modify elements by side effect. There is
406 ;; `org-element-put-property', `org-element-set-contents'. These
407 ;; low-level functions are useful to build a parse tree.
408 ;;
409 ;; `org-element-adopt-element', `org-element-set-element',
410 ;; `org-element-extract-element' and `org-element-insert-before' are
411 ;; high-level functions useful to modify a parse tree.
412 ;;
413 ;; `org-element-secondary-p' is a predicate used to know if a given
414 ;; object belongs to a secondary string.
417 "Return type of ELEMENT.
419 The function returns the type of the element or object provided.
420 It can also return the following special value:
421 `plain-text' for a string
422 `org-data' for a complete document
423 nil in any other case."
429 "Extract the value from the PROPERTY of an ELEMENT."
434 "Extract contents from an ELEMENT."
440 "Return restriction associated to ELEMENT.
441 ELEMENT can be an element, an object or a symbol representing an
442 element or object type."
444 org-element-object-restrictions)))
447 "In ELEMENT set PROPERTY to VALUE.
448 Return modified element."
451 element))
454 "Set ELEMENT contents to CONTENTS.
455 Return modified element."
462 "Non-nil when OBJECT belongs to a secondary string.
463 Return value is the property name, as a keyword, or nil."
466 org-element-secondary-value-alist))))
469 property)))
472 "Append elements to the contents of another element.
474 PARENT is an element or object. CHILDREN can be elements,
475 objects, or a strings.
477 The function takes care of setting `:parent' property for CHILD.
478 Return parent element."
479 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
480 ;; string: parent is the list itself.
483 children)
484 ;; Add CHILDREN at the end of PARENT contents.
487 parent
489 ;; Return modified PARENT element.
493 "Extract ELEMENT from parse tree.
494 Remove element from the parse tree by side-effect, and return it
495 with its `:parent' property stripped out."
500 parent secondary
503 parent
505 ;; Return ELEMENT with its :parent removed.
509 "Insert ELEMENT before LOCATION in parse tree.
510 LOCATION is an element, object or string within the parse tree.
511 Parse tree is modified by side effect."
516 ;; Special case: LOCATION is the first element of an
517 ;; independent secondary string (e.g. :title property). Add
518 ;; ELEMENT in-place.
522 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
532 ;; Store SIBLINGS at appropriate place in parse tree.
537 ;; Set appropriate :parent property.
541 "Replace element or object OLD with element or object NEW.
542 The function takes care of setting `:parent' property for NEW."
543 ;; Ensure OLD and NEW have the same parent.
547 ;; We cannot replace OLD with NEW since one of them is not an
548 ;; object or element. We take the long path.
551 ;; Since OLD is going to be changed into NEW by side-effect, first
552 ;; make sure that every element or object within NEW has OLD as
553 ;; parent.
556 ;; Transfer contents.
558 ;; Overwrite OLD's properties with NEW's.
560 ;; Transfer type.
564 \f
565 ;;; Greater elements
566 ;;
567 ;; For each greater element type, we define a parser and an
568 ;; interpreter.
569 ;;
570 ;; A parser returns the element or object as the list described above.
571 ;; Most of them accepts no argument. Though, exceptions exist. Hence
572 ;; every element containing a secondary string (see
573 ;; `org-element-secondary-value-alist') will accept an optional
574 ;; argument to toggle parsing of that secondary string. Moreover,
575 ;; `item' parser requires current list's structure as its first
576 ;; element.
577 ;;
578 ;; An interpreter accepts two arguments: the list representation of
579 ;; the element or object, and its contents. The latter may be nil,
580 ;; depending on the element or object considered. It returns the
581 ;; appropriate Org syntax, as a string.
582 ;;
583 ;; Parsing functions must follow the naming convention:
584 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
585 ;; defined in `org-element-greater-elements'.
586 ;;
587 ;; Similarly, interpreting functions must follow the naming
588 ;; convention: org-element-TYPE-interpreter.
589 ;;
590 ;; With the exception of `headline' and `item' types, greater elements
591 ;; cannot contain other greater elements of their own type.
592 ;;
593 ;; Beside implementing a parser and an interpreter, adding a new
594 ;; greater element requires to tweak `org-element--current-element'.
595 ;; Moreover, the newly defined type must be added to both
596 ;; `org-element-all-elements' and `org-element-greater-elements'.
599 ;;;; Center Block
602 "Parse a center block.
604 LIMIT bounds the search. AFFILIATED is a list of which CAR is
605 the buffer position at the beginning of the first affiliated
606 keyword and CDR is a plist of affiliated keywords along with
607 their value.
609 Return a list whose CAR is `center-block' and CDR is a plist
610 containing `:begin', `:end', `:contents-begin', `:contents-end',
611 `:post-blank' and `:post-affiliated' keywords.
613 Assume point is at the beginning of the block."
617 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
636 :end end
637 :contents-begin contents-begin
638 :contents-end contents-end
644 "Interpret CENTER-BLOCK element as Org syntax.
645 CONTENTS is the contents of the element."
649 ;;;; Drawer
652 "Parse a drawer.
654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
655 the buffer position at the beginning of the first affiliated
656 keyword and CDR is a plist of affiliated keywords along with
657 their value.
659 Return a list whose CAR is `drawer' and CDR is a plist containing
660 `:drawer-name', `:begin', `:end', `:contents-begin',
661 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
663 Assume point is at beginning of drawer."
666 ;; Incomplete drawer: parse it as a paragraph.
674 ;; Empty drawers have no contents.
687 :end end
688 :drawer-name name
689 :contents-begin contents-begin
690 :contents-end contents-end
696 "Interpret DRAWER element as Org syntax.
697 CONTENTS is the contents of the element."
700 contents))
703 ;;;; Dynamic Block
706 "Parse a dynamic block.
708 LIMIT bounds the search. AFFILIATED is a list of which CAR is
709 the buffer position at the beginning of the first affiliated
710 keyword and CDR is a plist of affiliated keywords along with
711 their value.
713 Return a list whose CAR is `dynamic-block' and CDR is a plist
714 containing `:block-name', `:begin', `:end', `:contents-begin',
715 `:contents-end', `:arguments', `:post-blank' and
716 `:post-affiliated' keywords.
718 Assume point is at beginning of dynamic block."
722 ;; Incomplete block: parse it as a paragraph.
731 ;; Empty blocks have no contents.
744 :end end
745 :block-name name
746 :arguments arguments
747 :contents-begin contents-begin
748 :contents-end contents-end
754 "Interpret DYNAMIC-BLOCK element as Org syntax.
755 CONTENTS is the contents of the element."
760 contents))
763 ;;;; Footnote Definition
766 "Parse a footnote definition.
768 LIMIT bounds the search. AFFILIATED is a list of which CAR is
769 the buffer position at the beginning of the first affiliated
770 keyword and CDR is a plist of affiliated keywords along with
771 their value.
773 Return a list whose CAR is `footnote-definition' and CDR is
774 a plist containing `:label', `:begin' `:end', `:contents-begin',
775 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
777 Assume point is at the beginning of the footnote definition."
805 :begin begin
806 :end end
807 :contents-begin contents-begin
808 :contents-end contents-end
814 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
815 CONTENTS is the contents of the footnote-definition."
817 " "
818 contents))
821 ;;;; Headline
824 "Return node properties associated to headline at point.
825 Upcase property names. It avoids confusion between properties
826 obtained through property drawer and default properties from the
827 parser (e.g. `:end' and :END:). Return value is a plist."
839 properties))))
842 "Return time properties associated to headline at point.
843 Return value is a plist."
857 plist))))
860 "Parse a headline.
862 Return a list whose CAR is `headline' and CDR is a plist
863 containing `:raw-value', `:title', `:alt-title', `:begin',
864 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
865 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
866 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
867 `:footnote-section-p', `:post-blank' and `:post-affiliated'
868 keywords.
870 The plist also contains any property set in the property drawer,
871 with its name in upper cases and colons added at the
872 beginning (e.g., `:CUSTOM_ID').
874 LIMIT is a buffer position bounding the search.
876 When RAW-SECONDARY-P is non-nil, headline's title will not be
877 parsed as a secondary string, but as a plain string instead.
879 Assume point is at beginning of the headline."
892 raw-value)))
909 ;; Clean RAW-VALUE from any comment string.
915 ""
916 raw-value))))
917 ;; Clean TAGS from archive tag, if any.
923 :begin begin
924 :end end
925 :pre-blank
928 :contents-begin contents-begin
929 :contents-end contents-end
930 :level level
932 :tags tags
933 :todo-keyword todo
934 :todo-type todo-type
937 end)
938 :footnote-section-p footnote-section-p
939 :archivedp archivedp
940 :commentedp commentedp
942 time-props
943 standard-props))))
947 headline :alt-title
952 headline :title
958 "Interpret HEADLINE element as Org syntax.
959 CONTENTS is the contents of the element."
975 ?*)
979 " "
982 org-footnote-section
983 title))))
985 heading
986 ;; Align tags.
994 ?\s)
995 tags))
999 tags))))
1001 contents)))
1004 ;;;; Inlinetask
1007 "Parse an inline task.
1009 Return a list whose CAR is `inlinetask' and CDR is a plist
1010 containing `:title', `:begin', `:end', `:contents-begin' and
1011 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1012 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1013 `:closed', `:post-blank' and `:post-affiliated' keywords.
1015 The plist also contains any property set in the property drawer,
1016 with its name in upper cases and colons added at the
1017 beginning (e.g., `:CUSTOM_ID').
1019 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1020 title will not be parsed as a secondary string, but as a plain
1021 string instead.
1023 Assume point is at beginning of the inline task."
1053 :begin begin
1054 :end end
1055 :contents-begin contents-begin
1056 :contents-end contents-end
1059 :tags tags
1060 :todo-keyword todo
1061 :todo-type todo-type
1064 time-props
1065 standard-props))))
1067 inlinetask :title
1070 raw-value
1072 inlinetask))))))
1075 "Interpret INLINETASK element as Org syntax.
1076 CONTENTS is the contents of inlinetask."
1091 ;; Align tags.
1099 ? )
1100 tags))
1104 tags))))
1105 ;; Prefer degenerate inlinetasks when there are no
1106 ;; contents.
1109 contents
1113 ;;;; Item
1116 "Parse an item.
1118 STRUCT is the structure of the plain list.
1120 Return a list whose CAR is `item' and CDR is a plist containing
1121 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1122 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1123 `:post-affiliated' keywords.
1125 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1126 any, will not be parsed as a secondary string, but as a plain
1127 string instead.
1129 Assume point is at the beginning of the item."
1153 ;; Ignore tags in un-ordered lists: they are just
1154 ;; a part of item's body.
1160 ;; If first line isn't empty, contents really start
1161 ;; at the text after item's meta-data.
1170 :begin begin
1171 :end end
1172 ;; CONTENTS-BEGIN and CONTENTS-END may be
1173 ;; mixed up in the case of an empty item
1174 ;; separated from the next by a blank line.
1175 ;; Thus ensure the former is always the
1176 ;; smallest.
1179 :checkbox checkbox
1180 :counter counter
1181 :structure struct
1185 item :tag
1193 "Interpret ITEM element as Org syntax.
1194 CONTENTS is the contents of the element."
1204 ;; Compute indentation.
1209 ;; Indent contents.
1211 bullet
1225 ;;;; Plain List
1228 ;; Return structure of list at point. Internal function. See
1229 ;; `org-list-struct' for details.
1234 items struct)
1239 ;; At limit: end all items.
1248 ;; At list end: end all items.
1253 ;; At a new item: end previous sibling.
1265 ind
1266 bullet
1269 ;; Description tag.
1273 ;; Ending position, unknown so far.
1274 nil)))
1275 items))
1277 ;; Skip empty lines.
1279 ;; Skip inline tasks and blank lines along the way.
1286 ;; At some text line. Check if it ends any previous item.
1298 ;; Skip blocks (any type) and drawers contents.
1303 limit t)))
1309 "Parse a plain list.
1311 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1312 the buffer position at the beginning of the first affiliated
1313 keyword and CDR is a plist of affiliated keywords along with
1314 their value. STRUCTURE is the structure of the plain list being
1315 parsed.
1317 Return a list whose CAR is `plain-list' and CDR is a plist
1318 containing `:type', `:begin', `:end', `:contents-begin' and
1319 `:contents-end', `:structure', `:post-blank' and
1320 `:post-affiliated' keywords.
1322 Assume point is at the beginning of the list."
1336 pos))
1340 ;; Return value.
1344 :begin begin
1345 :end end
1346 :contents-begin contents-begin
1347 :contents-end contents-end
1348 :structure struct
1354 "Interpret PLAIN-LIST element as Org syntax.
1355 CONTENTS is the contents of the element."
1363 ;;;; Property Drawer
1366 "Parse a property drawer.
1368 LIMIT bounds the search.
1370 Return a list whose car is `property-drawer' and cdr is a plist
1371 containing `:begin', `:end', `:contents-begin', `:contents-end',
1372 `:post-blank' and `:post-affiliated' keywords.
1374 Assume point is at the beginning of the property drawer."
1387 :end end
1389 :contents-end contents-end
1394 "Interpret PROPERTY-DRAWER element as Org syntax.
1395 CONTENTS is the properties within the drawer."
1399 ;;;; Quote Block
1402 "Parse a quote block.
1404 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1405 the buffer position at the beginning of the first affiliated
1406 keyword and CDR is a plist of affiliated keywords along with
1407 their value.
1409 Return a list whose CAR is `quote-block' and CDR is a plist
1410 containing `:begin', `:end', `:contents-begin', `:contents-end',
1411 `:post-blank' and `:post-affiliated' keywords.
1413 Assume point is at the beginning of the block."
1417 ;; Incomplete block: parse it as a paragraph.
1423 ;; Empty blocks have no contents.
1436 :end end
1437 :contents-begin contents-begin
1438 :contents-end contents-end
1444 "Interpret QUOTE-BLOCK element as Org syntax.
1445 CONTENTS is the contents of the element."
1449 ;;;; Section
1452 "Parse a section.
1454 LIMIT bounds the search.
1456 Return a list whose CAR is `section' and CDR is a plist
1457 containing `:begin', `:end', `:contents-begin', `contents-end',
1458 `:post-blank' and `:post-affiliated' keywords."
1460 ;; Beginning of section is the beginning of the first non-blank
1461 ;; line after previous headline.
1470 :end end
1471 :contents-begin begin
1472 :contents-end pos-before-blank
1477 "Interpret SECTION element as Org syntax.
1478 CONTENTS is the contents of the element."
1479 contents)
1482 ;;;; Special Block
1485 "Parse a special block.
1487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1488 the buffer position at the beginning of the first affiliated
1489 keyword and CDR is a plist of affiliated keywords along with
1490 their value.
1492 Return a list whose CAR is `special-block' and CDR is a plist
1493 containing `:type', `:begin', `:end', `:contents-begin',
1494 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1496 Assume point is at the beginning of the block."
1503 limit t)))
1504 ;; Incomplete block: parse it as a paragraph.
1510 ;; Empty blocks have no contents.
1523 :begin begin
1524 :end end
1525 :contents-begin contents-begin
1526 :contents-end contents-end
1532 "Interpret SPECIAL-BLOCK element as Org syntax.
1533 CONTENTS is the contents of the element."
1538 \f
1539 ;;; Elements
1540 ;;
1541 ;; For each element, a parser and an interpreter are also defined.
1542 ;; Both follow the same naming convention used for greater elements.
1543 ;;
1544 ;; Also, as for greater elements, adding a new element type is done
1545 ;; through the following steps: implement a parser and an interpreter,
1546 ;; tweak `org-element--current-element' so that it recognizes the new
1547 ;; type and add that new type to `org-element-all-elements'.
1548 ;;
1549 ;; As a special case, when the newly defined type is a block type,
1550 ;; `org-element-block-name-alist' has to be modified accordingly.
1553 ;;;; Babel Call
1556 "Parse a babel call.
1558 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1559 the buffer position at the beginning of the first affiliated
1560 keyword and CDR is a plist of affiliated keywords along with
1561 their value.
1563 Return a list whose CAR is `babel-call' and CDR is a plist
1564 containing `:begin', `:end', `:value', `:post-blank' and
1565 `:post-affiliated' as keywords."
1579 :end end
1580 :value value
1586 "Interpret BABEL-CALL element as Org syntax.
1587 CONTENTS is nil."
1591 ;;;; Clock
1594 "Parse a clock.
1596 LIMIT bounds the search.
1598 Return a list whose CAR is `clock' and CDR is a plist containing
1599 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1600 `:post-affiliated' as keywords."
1620 :value value
1621 :duration duration
1622 :begin begin
1623 :end end
1624 :post-blank post-blank
1628 "Interpret CLOCK element as Org syntax.
1629 CONTENTS is nil."
1637 "%2s:%02s"
1641 ;;;; Comment
1644 "Parse a comment.
1646 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1647 the buffer position at the beginning of the first affiliated
1648 keyword and CDR is a plist of affiliated keywords along with
1649 their value.
1651 Return a list whose CAR is `comment' and CDR is a plist
1652 containing `:begin', `:end', `:value', `:post-blank',
1653 `:post-affiliated' keywords.
1655 Assume point is at comment beginning."
1664 ;; Get comments ending.
1667 ;; Accumulate lines without leading hash and first
1668 ;; whitespace.
1682 :end end
1683 :value value
1689 "Interpret COMMENT element as Org syntax.
1690 CONTENTS is nil."
1694 ;;;; Comment Block
1697 "Parse an export block.
1699 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1700 the buffer position at the beginning of the first affiliated
1701 keyword and CDR is a plist of affiliated keywords along with
1702 their value.
1704 Return a list whose CAR is `comment-block' and CDR is a plist
1705 containing `:begin', `:end', `:value', `:post-blank' and
1706 `:post-affiliated' keywords.
1708 Assume point is at comment block beginning."
1712 ;; Incomplete block: parse it as a paragraph.
1725 contents-begin contents-end)))
1729 :end end
1730 :value value
1736 "Interpret COMMENT-BLOCK element as Org syntax.
1737 CONTENTS is nil."
1744 ;;;; Diary Sexp
1747 "Parse a diary sexp.
1749 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1750 the buffer position at the beginning of the first affiliated
1751 keyword and CDR is a plist of affiliated keywords along with
1752 their value.
1754 Return a list whose CAR is `diary-sexp' and CDR is a plist
1755 containing `:begin', `:end', `:value', `:post-blank' and
1756 `:post-affiliated' keywords."
1768 :begin begin
1769 :end end
1775 "Interpret DIARY-SEXP as Org syntax.
1776 CONTENTS is nil."
1780 ;;;; Example Block
1783 "Parse an example block.
1785 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1786 the buffer position at the beginning of the first affiliated
1787 keyword and CDR is a plist of affiliated keywords along with
1788 their value.
1790 Return a list whose CAR is `example-block' and CDR is a plist
1791 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1792 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1793 `:value', `:post-blank' and `:post-affiliated' keywords."
1797 ;; Incomplete block: parse it as a paragraph.
1805 ;; Switches analysis
1812 ;; Should labels be retained in (or stripped from) example
1813 ;; blocks?
1818 ;; What should code-references use - labels or
1819 ;; line-numbers?
1828 ;; Standard block parsing.
1836 contents-begin contents-end))
1837 block-ind))
1846 :end end
1847 :value value
1848 :switches switches
1849 :number-lines number-lines
1850 :preserve-indent preserve-indent
1851 :retain-labels retain-labels
1852 :use-labels use-labels
1853 :label-fmt label-fmt
1859 "Interpret EXAMPLE-BLOCK element as Org syntax.
1860 CONTENTS is nil."
1868 value
1873 ;;;; Export Block
1876 "Parse an export block.
1878 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1879 the buffer position at the beginning of the first affiliated
1880 keyword and CDR is a plist of affiliated keywords along with
1881 their value.
1883 Return a list whose CAR is `export-block' and CDR is a plist
1884 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1885 `:post-affiliated' keywords.
1887 Assume point is at export-block beginning."
1894 ;; Incomplete block: parse it as a paragraph.
1907 contents-end)))
1911 :end end
1912 :type type
1913 :value value
1919 "Interpret EXPORT-BLOCK element as Org syntax.
1920 CONTENTS is nil."
1927 ;;;; Fixed-width
1930 "Parse a fixed-width section.
1932 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1933 the buffer position at the beginning of the first affiliated
1934 keyword and CDR is a plist of affiliated keywords along with
1935 their value.
1937 Return a list whose CAR is `fixed-width' and CDR is a plist
1938 containing `:begin', `:end', `:value', `:post-blank' and
1939 `:post-affiliated' keywords.
1941 Assume point is at the beginning of the fixed-width area."
1945 value
1950 ;; Accumulate text without starting colons.
1963 :end end
1964 :value value
1970 "Interpret FIXED-WIDTH element as Org syntax.
1971 CONTENTS is nil."
1979 ;;;; Horizontal Rule
1982 "Parse an horizontal rule.
1984 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1985 the buffer position at the beginning of the first affiliated
1986 keyword and CDR is a plist of affiliated keywords along with
1987 their value.
1989 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1990 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1991 keywords."
2001 :end end
2007 "Interpret HORIZONTAL-RULE element as Org syntax.
2008 CONTENTS is nil."
2012 ;;;; Keyword
2015 "Parse a keyword at point.
2017 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2018 the buffer position at the beginning of the first affiliated
2019 keyword and CDR is a plist of affiliated keywords along with
2020 their value.
2022 Return a list whose CAR is `keyword' and CDR is a plist
2023 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2024 `:post-affiliated' keywords."
2026 ;; An orphaned affiliated keyword is considered as a regular
2027 ;; keyword. In this case AFFILIATED is nil, so we take care of
2028 ;; this corner case.
2041 :value value
2042 :begin begin
2043 :end end
2049 "Interpret KEYWORD element as Org syntax.
2050 CONTENTS is nil."
2056 ;;;; Latex Environment
2060 "Regexp matching the beginning of a LaTeX environment.
2061 The environment is captured by the first group.
2067 "Format string matching the ending of a LaTeX environment.
2071 "Parse a LaTeX environment.
2073 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2074 the buffer position at the beginning of the first affiliated
2075 keyword and CDR is a plist of affiliated keywords along with
2076 their value.
2078 Return a list whose CAR is `latex-environment' and CDR is a plist
2079 containing `:begin', `:end', `:value', `:post-blank' and
2080 `:post-affiliated' keywords.
2082 Assume point is at the beginning of the latex environment."
2089 limit t))
2090 ;; Incomplete latex environment: parse it as a paragraph.
2100 :end end
2101 :value value
2107 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2108 CONTENTS is nil."
2112 ;;;; Node Property
2115 "Parse a node-property at point.
2117 LIMIT bounds the search.
2119 Return a list whose CAR is `node-property' and CDR is a plist
2120 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2121 `:post-affiliated' keywords."
2131 limit))))
2134 :value value
2135 :begin begin
2136 :end end
2141 "Interpret NODE-PROPERTY element as Org syntax.
2142 CONTENTS is nil."
2148 ;;;; Paragraph
2151 "Parse a paragraph.
2153 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2154 the buffer position at the beginning of the first affiliated
2155 keyword and CDR is a plist of affiliated keywords along with
2156 their value.
2158 Return a list whose CAR is `paragraph' and CDR is a plist
2159 containing `:begin', `:end', `:contents-begin' and
2160 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2162 Assume point is at the beginning of the paragraph."
2171 limit
2172 ;; A matching `org-element-paragraph-separate' is not
2173 ;; necessarily the end of the paragraph. In
2174 ;; particular, lines starting with # or : as a first
2175 ;; non-space character are ambiguous. We have to
2176 ;; check if they are valid Org syntax (e.g., not an
2177 ;; incomplete keyword).
2181 ;; There's no ambiguity for other symbols or
2182 ;; empty lines: stop here.
2184 ;; Stop at valid fixed-width areas.
2186 ;; Stop at drawers.
2191 ;; Stop at valid comments.
2193 ;; Stop at valid dynamic blocks.
2198 ;; Stop at valid blocks.
2205 limit t)))
2206 ;; Stop at valid latex environments.
2213 limit t)))
2214 ;; Stop at valid keywords.
2216 ;; Skip everything else.
2233 :end end
2234 :contents-begin contents-begin
2235 :contents-end contents-end
2241 "Interpret PARAGRAPH element as Org syntax.
2242 CONTENTS is the contents of the element."
2243 contents)
2246 ;;;; Planning
2249 "Parse a planning.
2251 LIMIT bounds the search.
2253 Return a list whose CAR is `planning' and CDR is a plist
2254 containing `:closed', `:deadline', `:scheduled', `:begin',
2255 `:end', `:post-blank' and `:post-affiliated' keywords."
2265 closed deadline scheduled)
2277 :deadline deadline
2278 :scheduled scheduled
2279 :begin begin
2280 :end end
2281 :post-blank post-blank
2285 "Interpret PLANNING element as Org syntax.
2286 CONTENTS is nil."
2288 'identity
2305 ;;;; Src Block
2308 "Parse a src block.
2310 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2311 the buffer position at the beginning of the first affiliated
2312 keyword and CDR is a plist of affiliated keywords along with
2313 their value.
2315 Return a list whose CAR is `src-block' and CDR is a plist
2316 containing `:language', `:switches', `:parameters', `:begin',
2317 `:end', `:number-lines', `:retain-labels', `:use-labels',
2318 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2319 `:post-affiliated' keywords.
2321 Assume point is at the beginning of the block."
2324 limit t)))
2325 ;; Incomplete block: parse it as a paragraph.
2331 ;; Get language as a string.
2340 ;; Get switches.
2342 ;; Get parameters.
2344 ;; Switches analysis
2355 ;; Should labels be retained in (or stripped from)
2356 ;; src blocks?
2361 ;; What should code-references use - labels or
2362 ;; line-numbers?
2367 ;; Indentation.
2369 ;; Retrieve code.
2374 block-ind))
2378 ;; Get position after ending blank lines.
2388 :begin begin
2389 :end end
2390 :number-lines number-lines
2391 :preserve-indent preserve-indent
2392 :retain-labels retain-labels
2393 :use-labels use-labels
2394 :label-fmt label-fmt
2395 :value value
2401 "Interpret SRC-BLOCK element as Org syntax.
2402 CONTENTS is nil."
2411 val)
2425 ;;;; Table
2428 "Parse a table at point.
2430 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2431 the buffer position at the beginning of the first affiliated
2432 keyword and CDR is a plist of affiliated keywords along with
2433 their value.
2435 Return a list whose CAR is `table' and CDR is a plist containing
2436 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2437 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2438 keywords.
2440 Assume point is at the beginning of the table."
2454 acc))
2461 :end end
2462 :type type
2463 :tblfm tblfm
2464 ;; Only `org' tables have contents. `table.el' tables
2465 ;; use a `:value' property to store raw table as
2466 ;; a string.
2471 table-begin table-end))
2477 "Interpret TABLE element as Org syntax.
2478 CONTENTS is a string, if table's type is `org', or nil."
2489 ;;;; Table Row
2492 "Parse table row at point.
2494 LIMIT bounds the search.
2496 Return a list whose CAR is `table-row' and CDR is a plist
2497 containing `:begin', `:end', `:contents-begin', `:contents-end',
2498 `:type', `:post-blank' and `:post-affiliated' keywords."
2502 ;; A table rule has no contents. In that case, ensure
2503 ;; CONTENTS-BEGIN matches CONTENTS-END.
2515 :begin begin
2516 :end end
2517 :contents-begin contents-begin
2518 :contents-end contents-end
2523 "Interpret TABLE-ROW element as Org syntax.
2524 CONTENTS is the contents of the table row."
2529 ;;;; Verse Block
2532 "Parse a verse block.
2534 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2535 the buffer position at the beginning of the first affiliated
2536 keyword and CDR is a plist of affiliated keywords along with
2537 their value.
2539 Return a list whose CAR is `verse-block' and CDR is a plist
2540 containing `:begin', `:end', `:contents-begin', `:contents-end',
2541 `:post-blank' and `:post-affiliated' keywords.
2543 Assume point is at beginning of the block."
2547 ;; Incomplete block: parse it as a paragraph.
2562 :end end
2563 :contents-begin contents-begin
2564 :contents-end contents-end
2570 "Interpret VERSE-BLOCK element as Org syntax.
2571 CONTENTS is verse block contents."
2575 \f
2576 ;;; Objects
2577 ;;
2578 ;; Unlike to elements, raw text can be found between objects. Hence,
2579 ;; `org-element--object-lex' is provided to find the next object in
2580 ;; buffer.
2581 ;;
2582 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2583 ;; object types they can contain will be specified in
2584 ;; `org-element-object-restrictions'.
2585 ;;
2586 ;; Creating a new type of object requires to alter
2587 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2588 ;; new type in `org-element-all-objects', and possibly add
2589 ;; restrictions in `org-element-object-restrictions'.
2591 ;;;; Bold
2594 "Parse bold object at point, if any.
2596 When at a bold object, return a list whose car is `bold' and cdr
2597 is a plist with `:begin', `:end', `:contents-begin' and
2598 `:contents-end' and `:post-blank' keywords. Otherwise, return
2599 nil.
2601 Assume point is at the first star marker."
2613 :end end
2614 :contents-begin contents-begin
2615 :contents-end contents-end
2619 "Interpret BOLD object as Org syntax.
2620 CONTENTS is the contents of the object."
2624 ;;;; Code
2627 "Parse code object at point, if any.
2629 When at a code object, return a list whose car is `code' and cdr
2630 is a plist with `:value', `:begin', `:end' and `:post-blank'
2631 keywords. Otherwise, return nil.
2633 Assume point is at the first tilde marker."
2644 :begin begin
2645 :end end
2649 "Interpret CODE object as Org syntax.
2650 CONTENTS is nil."
2654 ;;;; Entity
2657 "Parse entity at point, if any.
2659 When at an entity, return a list whose car is `entity' and cdr
2660 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2661 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2662 `:post-blank' as keywords. Otherwise, return nil.
2664 Assume point is at the beginning of the entity."
2666 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2684 :begin begin
2685 :end end
2686 :use-brackets-p bracketsp
2690 "Interpret ENTITY object as Org syntax.
2691 CONTENTS is nil."
2697 ;;;; Export Snippet
2700 "Parse export snippet at point.
2702 When at an export snippet, return a list whose car is
2703 `export-snippet' and cdr a plist with `:begin', `:end',
2704 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2705 return nil.
2707 Assume point is at the beginning of the snippet."
2723 :value value
2724 :begin begin
2725 :end end
2729 "Interpret EXPORT-SNIPPET object as Org syntax.
2730 CONTENTS is nil."
2736 ;;;; Footnote Reference
2739 "Parse footnote reference at point, if any.
2741 When at a footnote reference, return a list whose car is
2742 `footnote-reference' and cdr a plist with `:label', `:type',
2743 `:begin', `:end', `:content-begin', `:contents-end' and
2744 `:post-blank' as keywords. Otherwise, return nil."
2768 :type type
2769 :begin begin
2770 :end end
2776 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2777 CONTENTS is its definition, when inline, or nil."
2783 ;;;; Inline Babel Call
2786 "Parse inline babel call at point, if any.
2788 When at an inline babel call, return a list whose car is
2789 `inline-babel-call' and cdr a plist with `:begin', `:end',
2790 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2792 Assume point is at the beginning of the babel call."
2804 :end end
2805 :value value
2809 "Interpret INLINE-BABEL-CALL object as Org syntax.
2810 CONTENTS is nil."
2814 ;;;; Inline Src Block
2817 "Parse inline source block at point, if any.
2819 When at an inline source block, return a list whose car is
2820 `inline-src-block' and cdr a plist with `:begin', `:end',
2821 `:language', `:value', `:parameters' and `:post-blank' as
2822 keywords. Otherwise, return nil.
2824 Assume point is at the beginning of the inline src block."
2837 :value value
2838 :parameters parameters
2839 :begin begin
2840 :end end
2844 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2845 CONTENTS is nil."
2850 language
2852 body)))
2854 ;;;; Italic
2857 "Parse italic object at point, if any.
2859 When at an italic object, return a list whose car is `italic' and
2860 cdr is a plist with `:begin', `:end', `:contents-begin' and
2861 `:contents-end' and `:post-blank' keywords. Otherwise, return
2862 nil.
2864 Assume point is at the first slash marker."
2876 :end end
2877 :contents-begin contents-begin
2878 :contents-end contents-end
2882 "Interpret ITALIC object as Org syntax.
2883 CONTENTS is the contents of the object."
2887 ;;;; Latex Fragment
2890 "Parse LaTeX fragment at point, if any.
2892 When at a LaTeX fragment, return a list whose car is
2893 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2894 and `:post-blank' as keywords. Otherwise, return nil.
2896 Assume point is at the beginning of the LaTeX fragment."
2914 ;; Macro.
2923 :begin begin
2924 :end end
2928 "Interpret LATEX-FRAGMENT object as Org syntax.
2929 CONTENTS is nil."
2932 ;;;; Line Break
2935 "Parse line break at point, if any.
2937 When at a line break, return a list whose car is `line-break',
2938 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2939 Otherwise, return nil.
2941 Assume point is at the beginning of the line break."
2950 "Interpret LINE-BREAK object as Org syntax.
2951 CONTENTS is nil."
2955 ;;;; Link
2958 "Parse link at point, if any.
2960 When at a link, return a list whose car is `link' and cdr a plist
2961 with `:type', `:path', `:raw-link', `:application',
2962 `:search-option', `:begin', `:end', `:contents-begin',
2963 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2964 nil.
2966 Assume point is at the beginning of the link."
2969 end contents-begin contents-end link-end post-blank path type
2970 raw-link link search-option application)
2972 ;; Type 1: Text targeted from a radio target.
2981 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2986 ;; RAW-LINK is the original link. Expand any
2987 ;; abbreviation in it.
2991 ;; Determine TYPE of link and set PATH accordingly.
2993 ;; File type.
2997 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3000 ;; According to RFC 3986, extra whitespace should be
3001 ;; ignored when a URI is extracted.
3004 ;; Id type: PATH is the id.
3007 ;; Code-ref type: PATH is the name of the reference.
3010 ;; Custom-id type: PATH is the name of the custom id.
3013 ;; Fuzzy type: Internal link either matches a target, an
3014 ;; headline name or nothing. PATH is the target or
3015 ;; headline's name.
3017 ;; Type 3: Plain link, e.g., http://orgmode.org
3023 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3031 ;; In any case, deduce end point after trailing white space from
3032 ;; LINK-END variable.
3036 ;; Special "file" type link processing.
3038 ;; Extract opening application and search option.
3046 ;; Normalize URI.
3050 ;; Make sure TYPE always reports "file".
3054 :path path
3056 :application application
3057 :search-option search-option
3058 :begin begin
3059 :end end
3060 :contents-begin contents-begin
3061 :contents-end contents-end
3065 "Interpret LINK object as Org syntax.
3066 CONTENTS is the contents of the object, or nil."
3071 raw-link
3075 ;;;; Macro
3078 "Parse macro at point, if any.
3080 When at a macro, return a list whose car is `macro' and cdr
3081 a plist with `:key', `:args', `:begin', `:end', `:value' and
3082 `:post-blank' as keywords. Otherwise, return nil.
3084 Assume point is at the macro."
3095 ;; Do not use `org-split-string' since empty
3096 ;; strings are meaningful here.
3104 args nil t)
3108 :value value
3109 :args args
3110 :begin begin
3111 :end end
3115 "Interpret MACRO object as Org syntax.
3116 CONTENTS is nil."
3120 ;;;; Radio-target
3123 "Parse radio target at point, if any.
3125 When at a radio target, return a list whose car is `radio-target'
3126 and cdr a plist with `:begin', `:end', `:contents-begin',
3127 `:contents-end', `:value' and `:post-blank' as keywords.
3128 Otherwise, return nil.
3130 Assume point is at the radio target."
3142 :end end
3143 :contents-begin contents-begin
3144 :contents-end contents-end
3145 :post-blank post-blank
3149 "Interpret TARGET object as Org syntax.
3150 CONTENTS is the contents of the object."
3154 ;;;; Statistics Cookie
3157 "Parse statistics cookie at point, if any.
3159 When at a statistics cookie, return a list whose car is
3160 `statistics-cookie', and cdr a plist with `:begin', `:end',
3161 `:value' and `:post-blank' keywords. Otherwise, return nil.
3163 Assume point is at the beginning of the statistics-cookie."
3174 :end end
3175 :value value
3179 "Interpret STATISTICS-COOKIE object as Org syntax.
3180 CONTENTS is nil."
3184 ;;;; Strike-Through
3187 "Parse strike-through object at point, if any.
3189 When at a strike-through object, return a list whose car is
3190 `strike-through' and cdr is a plist with `:begin', `:end',
3191 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3192 Otherwise, return nil.
3194 Assume point is at the first plus sign marker."
3206 :end end
3207 :contents-begin contents-begin
3208 :contents-end contents-end
3212 "Interpret STRIKE-THROUGH object as Org syntax.
3213 CONTENTS is the contents of the object."
3217 ;;;; Subscript
3220 "Parse subscript at point, if any.
3222 When at a subscript object, return a list whose car is
3223 `subscript' and cdr a plist with `:begin', `:end',
3224 `:contents-begin', `:contents-end', `:use-brackets-p' and
3225 `:post-blank' as keywords. Otherwise, return nil.
3227 Assume point is at the underscore."
3241 :end end
3242 :use-brackets-p bracketsp
3243 :contents-begin contents-begin
3244 :contents-end contents-end
3248 "Interpret SUBSCRIPT object as Org syntax.
3249 CONTENTS is the contents of the object."
3252 contents))
3255 ;;;; Superscript
3258 "Parse superscript at point, if any.
3260 When at a superscript object, return a list whose car is
3261 `superscript' and cdr a plist with `:begin', `:end',
3262 `:contents-begin', `:contents-end', `:use-brackets-p' and
3263 `:post-blank' as keywords. Otherwise, return nil.
3265 Assume point is at the caret."
3279 :end end
3280 :use-brackets-p bracketsp
3281 :contents-begin contents-begin
3282 :contents-end contents-end
3286 "Interpret SUPERSCRIPT object as Org syntax.
3287 CONTENTS is the contents of the object."
3290 contents))
3293 ;;;; Table Cell
3296 "Parse table cell at point.
3297 Return a list whose car is `table-cell' and cdr is a plist
3298 containing `:begin', `:end', `:contents-begin', `:contents-end'
3299 and `:post-blank' keywords."
3307 :end end
3308 :contents-begin contents-begin
3309 :contents-end contents-end
3313 "Interpret TABLE-CELL element as Org syntax.
3314 CONTENTS is the contents of the cell, or nil."
3318 ;;;; Target
3321 "Parse target at point, if any.
3323 When at a target, return a list whose car is `target' and cdr
3324 a plist with `:begin', `:end', `:value' and `:post-blank' as
3325 keywords. Otherwise, return nil.
3327 Assume point is at the target."
3337 :end end
3338 :value value
3342 "Interpret TARGET object as Org syntax.
3343 CONTENTS is nil."
3347 ;;;; Timestamp
3358 "Parse time stamp at point, if any.
3360 When at a time stamp, return a list whose car is `timestamp', and
3361 cdr a plist with `:type', `:raw-value', `:year-start',
3362 `:month-start', `:day-start', `:hour-start', `:minute-start',
3363 `:year-end', `:month-end', `:day-end', `:hour-end',
3364 `:minute-end', `:repeater-type', `:repeater-value',
3365 `:repeater-unit', `:warning-type', `:warning-value',
3366 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3367 Otherwise, return nil.
3369 Assume point is at the beginning of the timestamp."
3388 date-start)
3399 raw-value)
3401 :repeater-type
3407 :repeater-unit
3416 :warning-unit
3419 year-start month-start day-start hour-start minute-start year-end
3420 month-end day-end hour-end minute-end)
3421 ;; Parse date-start.
3429 ;; Compute date-end. It can be provided directly in time-stamp,
3430 ;; or extracted from time range. Otherwise, it defaults to the
3431 ;; same values as date-start.
3441 :raw-value raw-value
3442 :year-start year-start
3443 :month-start month-start
3444 :day-start day-start
3445 :hour-start hour-start
3446 :minute-start minute-start
3447 :year-end year-end
3448 :month-end month-end
3449 :day-end day-end
3450 :hour-end hour-end
3451 :minute-end minute-end
3452 :begin begin
3453 :end end
3455 repeater-props
3456 warning-props))))))
3459 "Interpret TIMESTAMP object as Org syntax.
3460 CONTENTS is nil."
3479 ;; Build an Org timestamp string from TIME. ACTIVEP is
3480 ;; non-nil when time stamp is active. If WITH-TIME-P is
3481 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3482 ;; specify a time range in the timestamp. REPEAT-STRING is
3483 ;; the repeater string, if any.
3487 org-time-stamp-formats)
3488 time)))
3494 nil nil ts)))
3499 " "
3500 s
3502 ;; Return value.
3503 ts)))
3515 build-ts-string
3534 0
3542 "--"
3555 ;;;; Underline
3558 "Parse underline object at point, if any.
3560 When at an underline object, return a list whose car is
3561 `underline' and cdr is a plist with `:begin', `:end',
3562 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3563 Otherwise, return nil.
3565 Assume point is at the first underscore marker."
3577 :end end
3578 :contents-begin contents-begin
3579 :contents-end contents-end
3583 "Interpret UNDERLINE object as Org syntax.
3584 CONTENTS is the contents of the object."
3588 ;;;; Verbatim
3591 "Parse verbatim object at point, if any.
3593 When at a verbatim object, return a list whose car is `verbatim'
3594 and cdr is a plist with `:value', `:begin', `:end' and
3595 `:post-blank' keywords. Otherwise, return nil.
3597 Assume point is at the first equal sign marker."
3608 :begin begin
3609 :end end
3613 "Interpret VERBATIM object as Org syntax.
3614 CONTENTS is nil."
3618 \f
3619 ;;; Parsing Element Starting At Point
3620 ;;
3621 ;; `org-element--current-element' is the core function of this section.
3622 ;; It returns the Lisp representation of the element starting at
3623 ;; point.
3624 ;;
3625 ;; `org-element--current-element' makes use of special modes. They
3626 ;; are activated for fixed element chaining (e.g., `plain-list' >
3627 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3628 ;; `section'). Special modes are: `first-section', `item',
3629 ;; `node-property', `section' and `table-row'.
3632 "Parse the element starting at point.
3634 Return value is a list like (TYPE PROPS) where TYPE is the type
3635 of the element and PROPS a plist of properties associated to the
3636 element.
3638 Possible types are defined in `org-element-all-elements'.
3640 LIMIT bounds the search.
3642 Optional argument GRANULARITY determines the depth of the
3643 recursion. Allowed values are `headline', `greater-element',
3644 `element', `object' or nil. When it is broader than `object' (or
3645 nil), secondary values will not be parsed, since they only
3646 contain objects.
3648 Optional argument MODE, when non-nil, can be either
3649 `first-section', `section', `planning', `item', `node-property'
3650 and `table-row'.
3652 If STRUCTURE isn't provided but MODE is set to `item', it will be
3653 computed.
3655 This function assumes point is always at the beginning of the
3656 element it has to parse."
3659 ;; Determine if parsing depth allows for secondary strings
3660 ;; parsing. It only applies to elements referenced in
3661 ;; `org-element-secondary-value-alist'.
3664 ;; Item.
3667 ;; Table Row.
3669 ;; Node Property.
3671 ;; Headline.
3674 ;; Sections (must be checked after headline).
3679 limit)))
3680 ;; Planning.
3683 ;; Property drawer.
3687 ;; When not at bol, point is at the beginning of an item or
3688 ;; a footnote definition: next item is always a paragraph.
3690 ;; Clock.
3692 ;; Inlinetask.
3695 ;; From there, elements can have affiliated keywords.
3698 ;; Jumping over affiliated keywords put point off-limits.
3699 ;; Parse them as regular keywords.
3703 ;; LaTeX Environment.
3706 ;; Drawer and Property Drawer.
3709 ;; Fixed Width
3712 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3713 ;; Keywords.
3722 org-element-block-name-alist)))
3737 ;; Footnote Definition.
3740 ;; Horizontal Rule.
3743 ;; Diary Sexp.
3746 ;; Table.
3748 ;; List.
3751 limit affiliated
3753 ;; Default element: Paragraph.
3757 ;; Most elements can have affiliated keywords. When looking for an
3758 ;; element beginning, we want to move before them, as they belong to
3759 ;; that element, and, in the meantime, collect information they give
3760 ;; into appropriate properties. Hence the following function.
3763 "Collect affiliated keywords from point down to LIMIT.
3765 Return a list whose CAR is the position at the first of them and
3766 CDR a plist of keywords and values and move point to the
3767 beginning of the first line after them.
3769 As a special case, if element doesn't start at the beginning of
3770 the line (e.g., a paragraph starting an item), CAR is current
3771 position of point and CDR is nil."
3775 ;; RESTRICT is the list of objects allowed in parsed
3776 ;; keywords value.
3778 output)
3781 ;; Apply translation to RAW-KWD. From there, KWD is
3782 ;; the official keyword.
3784 org-element-keyword-translation-alist))
3785 raw-kwd))
3786 ;; Find main value for any keyword.
3792 ;; PARSEDP is non-nil when keyword should have its
3793 ;; value parsed.
3795 ;; If KWD is a dual keyword, find its secondary
3796 ;; value. Maybe parse it.
3803 ;; Attribute a property name to KWD.
3805 ;; Now set final shape for VALUE.
3811 ;; Attributes can always appear on multiple lines.
3814 ;; Eventually store the new value in OUTPUT.
3816 ;; Move to next keyword.
3818 ;; If affiliated keywords are orphaned: move back to first one.
3819 ;; They will be parsed as a paragraph.
3821 ;; Return value.
3825 \f
3826 ;;; The Org Parser
3827 ;;
3828 ;; The two major functions here are `org-element-parse-buffer', which
3829 ;; parses Org syntax inside the current buffer, taking into account
3830 ;; region, narrowing, or even visibility if specified, and
3831 ;; `org-element-parse-secondary-string', which parses objects within
3832 ;; a given string.
3833 ;;
3834 ;; The (almost) almighty `org-element-map' allows to apply a function
3835 ;; on elements or objects matching some type, and accumulate the
3836 ;; resulting values. In an export situation, it also skips unneeded
3837 ;; parts of the parse tree.
3840 "Recursively parse the buffer and return structure.
3841 If narrowing is in effect, only parse the visible part of the
3842 buffer.
3844 Optional argument GRANULARITY determines the depth of the
3845 recursion. It can be set to the following symbols:
3847 `headline' Only parse headlines.
3848 `greater-element' Don't recurse into greater elements excepted
3849 headlines and sections. Thus, elements
3850 parsed are the top-level ones.
3851 `element' Parse everything but objects and plain text.
3852 `object' Parse the complete buffer (default).
3854 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3855 elements.
3857 An element or an objects is represented as a list with the
3858 pattern (TYPE PROPERTIES CONTENTS), where :
3860 TYPE is a symbol describing the element or object. See
3861 `org-element-all-elements' and `org-element-all-objects' for an
3862 exhaustive list of such symbols. One can retrieve it with
3863 `org-element-type' function.
3865 PROPERTIES is the list of attributes attached to the element or
3866 object, as a plist. Although most of them are specific to the
3867 element or object type, all types share `:begin', `:end',
3868 `:post-blank' and `:parent' properties, which respectively
3869 refer to buffer position where the element or object starts,
3870 ends, the number of white spaces or blank lines after it, and
3871 the element or object containing it. Properties values can be
3872 obtained by using `org-element-property' function.
3874 CONTENTS is a list of elements, objects or raw strings
3875 contained in the current element or object, when applicable.
3876 One can access them with `org-element-contents' function.
3878 The Org buffer has `org-data' as type and nil as properties.
3879 `org-element-map' function can be used to find specific elements
3880 or objects within the parse tree.
3882 This function assumes that current major mode is `org-mode'."
3888 ;; Start in `first-section' mode so text before the first
3889 ;; headline belongs to a section.
3893 "Recursively parse objects in STRING and return structure.
3895 RESTRICTION is a symbol limiting the object types that will be
3896 looked after.
3898 Optional argument PARENT, when non-nil, is the element or object
3899 containing the secondary string. It is used to set correctly
3900 `:parent' property within the string."
3913 secondary))))
3917 "Map a function on selected elements or objects.
3919 DATA is a parse tree, an element, an object, a string, or a list
3920 of such constructs. TYPES is a symbol or list of symbols of
3921 elements or objects types (see `org-element-all-elements' and
3922 `org-element-all-objects' for a complete list of types). FUN is
3923 the function called on the matching element or object. It has to
3924 accept one argument: the element or object itself.
3926 When optional argument INFO is non-nil, it should be a plist
3927 holding export options. In that case, parts of the parse tree
3928 not exportable according to that property list will be skipped.
3930 When optional argument FIRST-MATCH is non-nil, stop at the first
3931 match for which FUN doesn't return nil, and return that value.
3933 Optional argument NO-RECURSION is a symbol or a list of symbols
3934 representing elements or objects types. `org-element-map' won't
3935 enter any recursive element or object whose type belongs to that
3936 list. Though, FUN can still be applied on them.
3938 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3939 apply to matching objects within parsed affiliated keywords (see
3940 `org-element-parsed-keywords').
3942 Nil values returned from FUN do not appear in the results.
3945 Examples:
3946 ---------
3948 Assuming TREE is a variable containing an Org buffer parse tree,
3949 the following example will return a flat list of all `src-block'
3950 and `example-block' elements in it:
3952 \(org-element-map tree '(example-block src-block) 'identity)
3954 The following snippet will find the first headline with a level
3957 \(org-element-map tree 'headline
3958 \(lambda (hl)
3959 \(and (= (org-element-property :level hl) 1)
3961 \(org-element-property :begin hl)))
3962 nil t)
3964 The next example will return a flat list of all `plain-list' type
3965 elements in TREE that are not a sub-list themselves:
3967 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3969 Eventually, this example will return a flat list of all `bold'
3970 type objects containing a `latex-snippet' type object, even
3971 looking into captions:
3973 \(org-element-map tree 'bold
3974 \(lambda (b)
3975 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3976 nil nil nil t)"
3977 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3980 ;; Recursion depth is determined by --CATEGORY.
3987 ;; If one object is found, the function
3988 ;; has to recurse into every object.
3991 ;; If one regular element is found, the
3992 ;; function has to recurse, at least,
3993 ;; into every element it encounters.
3996 types)
3997 category)))
3998 ;; Compute properties for affiliated keywords if necessary.
4003 org-element-affiliated-keywords)))
4004 --acc
4005 --walk-tree
4009 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4010 ;; holding contextual information.
4014 ;; Ignored element in an export context.
4016 ;; List of elements or objects.
4018 ;; Unconditionally enter parse trees.
4022 ;; Check if TYPE is matching among TYPES. If so,
4023 ;; apply FUN to --DATA and accumulate return value
4024 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4030 ;; If --DATA has a secondary string that can contain
4031 ;; objects with their type among TYPES, look into it.
4038 ;; If --DATA has any affiliated keywords and
4039 ;; WITH-AFFILIATED is non-nil, look for objects in
4040 ;; them.
4048 ;; Pay attention to the type of value.
4049 ;; Preserve order for multiple keywords.
4065 --affiliated-alist))
4066 ;; Determine if a recursion into --DATA is possible.
4068 ;; --TYPE is explicitly removed from recursion.
4070 ;; --DATA has no contents.
4072 ;; Looking for greater elements but --DATA is simply
4073 ;; an element or an object.
4076 ;; Looking for elements but --DATA is an object.
4079 ;; In any other case, map contents.
4083 ;; Return value in a proper order.
4087 ;; The following functions are internal parts of the parser.
4088 ;;
4089 ;; The first one, `org-element--parse-elements' acts at the element's
4090 ;; level.
4091 ;;
4092 ;; The second one, `org-element--parse-objects' applies on all objects
4093 ;; of a paragraph or a secondary string. It calls
4094 ;; `org-element--object-lex' to find the next object in the current
4095 ;; container.
4098 "Return next special mode according to TYPE, or nil.
4099 TYPE is a symbol representing the type of an element or object
4100 containing next element if PARENTP is non-nil, or before it
4101 otherwise. Modes can be either `first-section', `item',
4102 `node-property', `planning', `property-drawer', `section',
4103 `table-row' or nil."
4119 "Parse elements between BEG and END positions.
4121 MODE prioritizes some elements over the others. It can be set to
4122 `first-section', `section', `planning', `item', `node-property'
4123 or `table-row'.
4125 When value is `item', STRUCTURE will be used as the current list
4126 structure.
4128 GRANULARITY determines the depth of the recursion. See
4129 `org-element-parse-buffer' for more information.
4131 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4132 elements.
4134 Elements are accumulated into ACC."
4137 ;; Visible only: skip invisible parts at the beginning of the
4138 ;; element.
4141 ;; When parsing only headlines, skip any text before first one.
4144 ;; Main loop start.
4146 ;; Find current element's type and parse it accordingly to
4147 ;; its category.
4149 end granularity mode structure))
4153 ;; Visible only: skip invisible parts between siblings.
4156 ;; Fill ELEMENT contents by side-effect.
4158 ;; If element has no contents, don't modify it.
4160 ;; Greater element: parse it between `contents-begin' and
4161 ;; `contents-end'. Make sure GRANULARITY allows the
4162 ;; recursion, or ELEMENT is a headline, in which case going
4163 ;; inside is mandatory, in order to get sub-level headings.
4171 ;; Possibly switch to a special mode.
4175 granularity visible-only element))
4176 ;; ELEMENT has contents. Parse objects inside, if
4177 ;; GRANULARITY allows it.
4183 ;; Update mode.
4185 ;; Return result.
4186 acc))
4189 "Return next object in current buffer or nil.
4190 RESTRICTION is a list of object types, as symbols, that should be
4191 looked after. This function assumes that the buffer is narrowed
4192 to an appropriate container (e.g., a paragraph)."
4200 found)
4265 ;; This is probably a plain link.
4271 ;; Radio link.
4276 "Parse objects between BEG and END and return recursive structure.
4278 Objects are accumulated in ACC.
4280 RESTRICTION is a list of object successors which are allowed in
4281 the current object."
4289 ;; 1. Text before any object. Untabify it.
4294 acc
4298 ;; 2. Object...
4301 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4302 ;; a recursive type.
4310 ;; 3. Text after last object. Untabify it.
4314 acc
4318 ;; Result.
4319 acc)))
4322 \f
4323 ;;; Towards A Bijective Process
4324 ;;
4325 ;; The parse tree obtained with `org-element-parse-buffer' is really
4326 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4327 ;; interpreted and expanded into a string with canonical Org syntax.
4328 ;; Hence `org-element-interpret-data'.
4329 ;;
4330 ;; The function relies internally on
4331 ;; `org-element--interpret-affiliated-keywords'.
4333 ;;;###autoload
4335 "Interpret DATA as Org syntax.
4337 DATA is a parse tree, an element, an object or a secondary string
4338 to interpret.
4340 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4341 new types that should be treated as objects. An unknown type not
4342 belonging to this list is seen as a pseudo-element instead. Both
4343 pseudo-objects and pseudo-elements are transparent entities, i.e.
4344 only their contents are interpreted.
4346 Return Org syntax as a string."
4350 "Interpret DATA as Org syntax.
4352 DATA is a parse tree, an element, an object or a secondary string
4353 to interpret. PARENT is used for recursive calls. It contains
4354 the element or object containing data, or nil. PSEUDO-OBJECTS
4355 are list of symbols defining new element or object types.
4356 Unknown types that don't belong to this list are treated as
4357 pseudo-elements instead.
4359 Return Org syntax as a string."
4361 ;; Find interpreter for current object or element. If it
4362 ;; doesn't exist (e.g. this is a pseudo object or element),
4363 ;; return contents, if any.
4369 ;; Secondary string.
4375 ;; Full Org document.
4381 ;; Plain text: return it.
4383 ;; Element or object without contents.
4385 ;; Element or object with contents.
4388 ;; Recursively interpret contents.
4394 data
4395 ;; Fix indentation of elements containing
4396 ;; objects. We ignore `table-row' elements
4397 ;; as they are one line long anyway.
4399 data
4400 ;; When normalizing first paragraph of an
4401 ;; item or a footnote-definition, ignore
4402 ;; first line's indentation.
4409 ;; Build white spaces. If no `:post-blank' property is
4410 ;; specified, assume its value is 0.
4421 "Return ELEMENT's affiliated keywords as Org syntax.
4422 If there is no affiliated keyword, return the empty string."
4432 ": "
4435 value)
4443 ;; All attribute keywords can have multiple lines.
4449 ;; List all ELEMENT's properties matching an attribute line or an
4450 ;; affiliated keyword, but ignore translated keywords since they
4451 ;; cannot belong to the property list.
4458 org-element-keyword-translation-alist)))))
4459 collect prop)
4462 ;; Because interpretation of the parse tree must return the same
4463 ;; number of blank lines between elements and the same number of white
4464 ;; space after objects, some special care must be given to white
4465 ;; spaces.
4466 ;;
4467 ;; The first function, `org-element-normalize-string', ensures any
4468 ;; string different from the empty string will end with a single
4469 ;; newline character.
4470 ;;
4471 ;; The second function, `org-element-normalize-contents', removes
4472 ;; global indentation from the contents of the current element.
4475 "Ensure string S ends with a single newline character.
4477 If S isn't a string return it unchanged. If S is the empty
4478 string, return it. Otherwise, return a new string with a single
4479 newline character at its end."
4487 "Normalize plain text in ELEMENT's contents.
4489 ELEMENT must only contain plain text and objects.
4491 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4492 indentation to compute maximal common indentation.
4494 Return the normalized element that is element with global
4495 indentation removed from its contents. The function assumes that
4496 indentation is not done with TAB characters."
4498 find-min-ind ; For byte-compiler.
4500 ;; Return minimal common indentation within BLOB. This is
4501 ;; done by walking recursively BLOB and updating MIN-IND
4502 ;; along the way. FIRST-FLAG is non-nil when the first
4503 ;; string hasn't been seen yet. It is required as this
4504 ;; string is the only one whose indentation doesn't happen
4505 ;; after a newline character.
4512 ;; An indentation of zero means no string will be
4513 ;; modified. Quit the process.
4523 ;; Find minimal indentation in ELEMENT.
4526 ;; Build ELEMENT back, replacing each string with the same
4527 ;; string minus common indentation.
4532 ;; Return BLOB with all its strings indentation
4533 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4534 ;; is non-nil when the first string hasn't been seen
4535 ;; yet.
4550 org-element-recursive-objects)
4554 blob))))
4558 \f
4559 ;;; Cache
4560 ;;
4561 ;; Implement a caching mechanism for `org-element-at-point' and
4562 ;; `org-element-context', which see.
4563 ;;
4564 ;; A single public function is provided: `org-element-cache-reset'.
4565 ;;
4566 ;; Cache is enabled by default, but can be disabled globally with
4567 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4568 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4569 ;; can be tweaked to control caching behaviour.
4570 ;;
4571 ;; Internally, parsed elements are stored in an AVL tree,
4572 ;; `org-element--cache'. This tree is updated lazily: whenever
4573 ;; a change happens to the buffer, a synchronization request is
4574 ;; registered in `org-element--cache-sync-requests' (see
4575 ;; `org-element--cache-submit-request'). During idle time, requests
4576 ;; are processed by `org-element--cache-sync'. Synchronization also
4577 ;; happens when an element is required from the cache. In this case,
4578 ;; the process stops as soon as the needed element is up-to-date.
4579 ;;
4580 ;; A synchronization request can only apply on a synchronized part of
4581 ;; the cache. Therefore, the cache is updated at least to the
4582 ;; location where the new request applies. Thus, requests are ordered
4583 ;; from left to right and all elements starting before the first
4584 ;; request are correct. This property is used by functions like
4585 ;; `org-element--cache-find' to retrieve elements in the part of the
4586 ;; cache that can be trusted.
4587 ;;
4588 ;; A request applies to every element, starting from its original
4589 ;; location (or key, see below). When a request is processed, it
4590 ;; moves forward and may collide the next one. In this case, both
4591 ;; requests are merged into a new one that starts from that element.
4592 ;; As a consequence, the whole synchronization complexity does not
4593 ;; depend on the number of pending requests, but on the number of
4594 ;; elements the very first request will be applied on.
4595 ;;
4596 ;; Elements cannot be accessed through their beginning position, which
4597 ;; may or may not be up-to-date. Instead, each element in the tree is
4598 ;; associated to a key, obtained with `org-element--cache-key'. This
4599 ;; mechanism is robust enough to preserve total order among elements
4600 ;; even when the tree is only partially synchronized.
4601 ;;
4602 ;; Objects contained in an element are stored in a hash table,
4603 ;; `org-element--cache-objects'.
4607 "Non nil when Org parser should cache its results.
4614 "Maximum duration, as a time value, for a cache synchronization.
4615 If the synchronization is not over after this delay, the process
4616 pauses and resumes after `org-element-cache-sync-break'
4620 "Duration, as a time value, of the pause between synchronizations.
4624 ;;;; Data Structure
4627 "AVL tree used to cache elements.
4628 Each node of the tree contains an element. Comparison is done
4629 with `org-element--cache-compare'. This cache is used in
4633 "Hash table used as to cache objects.
4634 Key is an element, as returned by `org-element-at-point', and
4635 value is an alist where each association is:
4637 \(PARENT COMPLETEP . OBJECTS)
4639 where PARENT is an element or object, COMPLETEP is a boolean,
4640 non-nil when all direct children of parent are already cached and
4641 OBJECTS is a list of such children, as objects, from farthest to
4642 closest.
4645 contained within a paragraph
4649 If the paragraph is completely parsed, OBJECTS-DATA will be
4651 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4652 \(BOLD-OBJECT t ENTITY-OBJECT))
4654 whereas in a partially parsed paragraph, it could be
4656 \((PARAGRAPH nil ENTITY-OBJECT))
4661 "List of pending synchronization requests.
4663 A request is a vector with the following pattern:
4665 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4667 Processing a synchronization request consists of three phases:
4669 0. Delete modified elements,
4670 1. Fill missing area in cache,
4671 2. Shift positions and re-parent elements after the changes.
4673 During phase 0, NEXT is the key of the first element to be
4674 removed, BEG and END is buffer position delimiting the
4675 modifications. Elements starting between them (inclusive) are
4676 removed and so are those contained within OUTREACH. PARENT, when
4677 non-nil, is the parent of the first element to be removed.
4679 During phase 1, NEXT is the key of the next known element in
4680 cache and BEG its beginning position. Parse buffer between that
4681 element and the one before it in order to determine the parent of
4682 the next element. Set PARENT to the element containing NEXT.
4684 During phase 2, NEXT is the key of the next element to shift in
4685 the parse tree. All elements starting from this one have their
4686 properties relatives to buffer positions shifted by integer
4687 OFFSET and, if they belong to element PARENT, are adopted by it.
4695 "Hash table used to store keys during synchronization.
4699 "Return a unique key for ELEMENT in cache tree.
4701 Keys are used to keep a total order among elements in the cache.
4702 Comparison is done with `org-element--cache-key-less-p'.
4704 When no synchronization is taking place, a key is simply the
4705 beginning position of the element, or that position plus one in
4706 the case of an first item (respectively row) in
4707 a list (respectively a table).
4709 During a synchronization, the key is the one the element had when
4710 the cache was synchronized for the last time. Elements added to
4711 cache during the synchronization get a new key generated with
4712 `org-element--cache-generate-key'.
4714 Such keys are stored in `org-element--cache-sync-keys'. The hash
4715 table is cleared once the synchronization is complete."
4718 ;; Increase beginning position of items (respectively
4719 ;; table rows) by one, so the first item can get
4720 ;; a different key from its parent list (respectively
4721 ;; table).
4724 begin)))
4727 key))))
4730 "Generate a key between LOWER and UPPER.
4732 LOWER and UPPER are integers or lists, possibly empty.
4734 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4735 a unique key, as an integer or a list of integers, according to
4736 the following rules:
4738 - LOWER and UPPER are compared level-wise until values differ.
4740 - If, at a given level, LOWER and UPPER differ from more than
4741 2, the new key shares all the levels above with LOWER and
4742 gets a new level. Its value is the mean between LOWER and
4743 UPPER:
4745 \(1 2) + (1 4) --> (1 3)
4747 - If LOWER has no value to compare with, it is assumed that its
4748 value is `most-negative-fixnum'. E.g.,
4750 \(1 1) + (1 1 2)
4752 is equivalent to
4754 \(1 1 m) + (1 1 2)
4756 where m is `most-negative-fixnum'. Likewise, if UPPER is
4757 short of levels, the current value is `most-positive-fixnum'.
4759 - If they differ from only one, the new key inherits from
4760 current LOWER level and fork it at the next level. E.g.,
4762 \(2 1) + (3 3)
4764 is equivalent to
4766 \(2 1) + (2 M)
4768 where M is `most-positive-fixnum'.
4770 - If the key is only one level long, it is returned as an
4771 integer:
4773 \(1 2) + (3 2) --> 2
4775 When they are not equals, the function assumes that LOWER is
4776 lesser than UPPER, per `org-element--cache-key-less-p'."
4780 skip-upper key)
4791 ;; When at a given level, LOWER and UPPER differ from
4792 ;; 1, ignore UPPER altogether. Instead create a key
4793 ;; between LOWER and the greatest key with the same
4794 ;; prefix as LOWER so far.
4800 "Non-nil if key A is less than key B.
4801 A and B are either integers or lists of integers, as returned by
4802 `org-element--cache-key'."
4810 ;; If A is empty, either keys are equal (B is also empty) and
4811 ;; we return nil, or A is lesser than B (B is longer) and we
4812 ;; return a non-nil value.
4813 ;;
4814 ;; If A is not empty, B is necessarily empty and A is greater
4815 ;; than B (A is longer). Therefore, return nil.
4819 "Non-nil when element A is located before element B."
4824 "Return root value in cache.
4825 This function assumes `org-element--cache' is a valid AVL tree."
4829 ;;;; Tools
4832 "Non-nil when cache is active in current buffer."
4837 "Find element in cache starting at POS or before.
4839 POS refers to a buffer position.
4841 When optional argument SIDE is non-nil, the function checks for
4842 elements starting at or past POS instead. If SIDE is `both', the
4843 function returns a cons cell where car is the first element
4844 starting at or before POS and cdr the first element starting
4845 after POS.
4847 The function can only find elements in the synchronized part of
4848 the cache."
4852 lower upper)
4867 ;; We found an element in cache starting at POS. If `side'
4868 ;; is `both' we also want the next one in order to generate
4869 ;; a key in-between.
4870 ;;
4871 ;; If the element is the first row or item in a table or
4872 ;; a plain list, we always return the table or the plain
4873 ;; list.
4874 ;;
4875 ;; In any other case, we return the element found.
4884 lower parent
4885 upper parent)))))
4888 lower element
4889 upper element)))))
4896 "Store ELEMENT in current buffer's cache, if allowed.
4897 When optional argument DATA is non-nil, assume is it object data
4898 relative to ELEMENT and store it in the objects cache."
4902 ;; During synchronization, first build an appropriate key
4903 ;; for the new element so `avl-tree-enter' can insert it at
4904 ;; the right spot in the cache.
4913 org-element--cache-sync-keys)))
4915 ;; Headlines are not stored in cache, so objects in titles are
4916 ;; not stored either.
4921 "Remove ELEMENT from cache.
4922 Assume ELEMENT belongs to cache and that a cache is active."
4927 ;;;; Synchronization
4930 "Set idle timer for cache synchronization in BUFFER."
4937 org-element-cache-sync-idle-time))
4938 nil
4939 #'org-element--cache-sync
4940 buffer)))
4943 "Non-nil when synchronization process should be interrupted.
4944 TIME-LIMIT is a time value or nil."
4950 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4952 Properties containing buffer positions are `:begin', `:end',
4953 `:contents-begin', `:contents-end' and `:structure'. When
4954 optional argument PROPS is a list of keywords, only shift
4955 properties provided in that list.
4957 Properties are modified by side-effect."
4959 ;; Shift `:structure' property for the first plain list only: it
4960 ;; is the only one that really matters and it prevents from
4961 ;; shifting it more than once.
4975 "Synchronize cache with recent modification in BUFFER.
4977 When optional argument THRESHOLD is non-nil, do the
4978 synchronization for all elements starting before or at threshold,
4979 then exit. Otherwise, synchronize cache for as long as
4980 `org-element-cache-sync-duration' or until Emacs leaves idle
4981 state.
4983 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4984 not registered yet in the cache are going to happen. It is used
4985 in `org-element--cache-submit-request', where cache is partially
4986 updated before current modification are actually submitted."
4997 request
4999 threshold
5002 org-element-cache-sync-duration))
5003 future-change)
5004 ;; Request processed. Merge current and next offsets and
5005 ;; transfer ending position.
5011 ;; If more requests are awaiting, set idle timer accordingly.
5012 ;; Otherwise, reset keys.
5019 "Process synchronization REQUEST for all entries before NEXT.
5021 REQUEST is a vector, built by `org-element--cache-submit-request'.
5023 NEXT is a cache key, as returned by `org-element--cache-key'.
5025 When non-nil, THRESHOLD is a buffer position. Synchronization
5026 stops as soon as a shifted element begins after it.
5028 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5029 after this time or when Emacs exits idle state.
5031 When non-nil, FUTURE-CHANGE is a buffer position where changes
5032 not registered yet in the cache are going to happen. See
5033 `org-element--cache-submit-request' for more information.
5035 Throw `interrupt' if the process stops before completing the
5036 request."
5039 ;; Phase 0.
5040 ;;
5041 ;; Delete all elements starting after BEG, but not after buffer
5042 ;; position END or past element with key NEXT.
5043 ;;
5044 ;; At each iteration, we start again at tree root since
5045 ;; a deletion modifies structure of the balanced tree.
5053 ;; Find first element in cache with key BEG or after it.
5063 data-key key
5066 data-key key
5067 node nil)))))
5076 up))
5082 ;; No element starting after modifications left in
5083 ;; cache: further processing is futile.
5086 ;; Phase 1.
5087 ;;
5088 ;; Phase 0 left a hole in the cache. Some elements after it
5089 ;; could have parents within. For example, in the following
5090 ;; buffer:
5091 ;;
5092 ;; - item
5093 ;;
5094 ;;
5095 ;; Paragraph1
5096 ;;
5097 ;; Paragraph2
5098 ;;
5099 ;; if we remove a blank line between "item" and "Paragraph1",
5100 ;; everything down to "Paragraph2" is removed from cache. But
5101 ;; the paragraph now belongs to the list, and its `:parent'
5102 ;; property no longer is accurate.
5103 ;;
5104 ;; Therefore we need to parse again elements in the hole, or at
5105 ;; least in its last section, so that we can re-parent
5106 ;; subsequent elements, during phase 2.
5107 ;;
5108 ;; Note that we only need to get the parent from the first
5109 ;; element in cache after the hole.
5110 ;;
5111 ;; When next key is lesser or equal to the current one, delegate
5112 ;; phase 1 processing to next request in order to preserve key
5113 ;; order among requests.
5121 ;; Next element will start at its beginning position plus
5122 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5123 ;; contains the real beginning position of the first element to
5124 ;; shift and re-parent.
5128 ;; Changes are going to happen around this element and
5129 ;; they will trigger another phase 1 request. Skip the
5130 ;; current one.
5136 ;; Phase 2.
5137 ;;
5138 ;; Shift all elements starting from key START, but before NEXT, by
5139 ;; OFFSET, and re-parent them when appropriate.
5140 ;;
5141 ;; Elements are modified by side-effect so the tree structure
5142 ;; remains intact.
5143 ;;
5144 ;; Once THRESHOLD, if any, is reached, or once there is an input
5145 ;; pending, exit. Before leaving, the current synchronization
5146 ;; request is updated.
5153 exit-flag)
5154 ;; No re-parenting nor shifting planned: request is over.
5164 ;; We reached NEXT. Request is complete.
5166 ;; Handle interruption request. Update current request.
5171 ;; Shift element.
5174 ;; Shift associated objects data, if any.
5179 ;; Update PARENT and re-parent DATA, only when
5180 ;; necessary. Propagate new structures for lists.
5194 ;; Cache is up-to-date past THRESHOLD. Request
5195 ;; interruption.
5200 ;; We reached end of tree: synchronization complete.
5201 t)))
5204 "Parse elements in current section, down to POS.
5206 Start parsing from the closest between the last known element in
5207 cache or headline above. Return the smallest element containing
5208 POS.
5210 When optional argument SYNCP is non-nil, return the parent of the
5211 element containing POS instead. In that case, it is also
5212 possible to provide TIME-LIMIT, which is a time value specifying
5213 when the parsing should stop. The function throws `interrupt' if
5214 the process stopped before finding the expected result."
5221 element next mode)
5223 ;; Nothing in cache before point: start parsing from first
5224 ;; element following headline above, or first element in
5225 ;; buffer.
5232 ;; Cache returned exact match: return it.
5235 ;; There's a headline between cached value and POS: cached
5236 ;; value is invalid. Start parsing from first element
5237 ;; following the headline.
5244 ;; Check if CACHED or any of its ancestors contain point.
5245 ;;
5246 ;; If there is such an element, we inspect it in order to know
5247 ;; if we return it or if we need to parse its contents.
5248 ;; Otherwise, we just start parsing from current location,
5249 ;; which is right after the top-most element containing
5250 ;; CACHED.
5251 ;;
5252 ;; As a special case, if POS is at the end of the buffer, we
5253 ;; want to return the innermost element ending there.
5254 ;;
5255 ;; Also, if we find an ancestor and discover that we need to
5256 ;; parse its contents, make sure we don't start from
5257 ;; `:contents-begin', as we would otherwise go past CACHED
5258 ;; again. Instead, in that situation, we will resume parsing
5259 ;; from NEXT, which is located after CACHED or its higher
5260 ;; ancestor not containing point.
5272 ;; Parse successively each element until we reach POS.
5285 end 'element mode
5292 ;; Skip any element ending before point. Also skip
5293 ;; element ending at point (unless it is also the end of
5294 ;; buffer) since we're sure that another element begins
5295 ;; after it.
5299 ;; A non-greater element contains point: return it.
5302 ;; Otherwise, we have to decide if ELEMENT really
5303 ;; contains POS. In that case we start parsing from
5304 ;; contents' beginning.
5305 ;;
5306 ;; If POS is at contents' beginning but it is also at
5307 ;; the beginning of the first item in a list or a table.
5308 ;; In that case, we need to create an anchor for that
5309 ;; list or table, so return it.
5310 ;;
5311 ;; Also, if POS is at the end of the buffer, no element
5312 ;; can start after it, but more than one may end there.
5313 ;; Arbitrarily, we choose to return the innermost of
5314 ;; such elements.
5327 parent element
5328 end cend))))
5329 ;; Otherwise, return ELEMENT as it is the smallest
5330 ;; element containing POS.
5335 ;;;; Staging Buffer Changes
5341 ;; Blocks
5343 ;; LaTeX environments.
5345 ;; Drawers.
5348 "Regexp matching a sensitive line, structure wise.
5349 A sensitive line is a headline, inlinetask, block, drawer, or
5350 latex-environment boundary. When such a line is modified,
5351 structure changes in the document may propagate in the whole
5355 "Non-nil when a sensitive line is about to be changed.
5359 "Request extension of area going to be modified if needed.
5360 BEG and END are the beginning and end of the range of changed
5361 text. See `before-change-functions' for more information."
5371 'headline
5374 org-element--cache-sensitive-re bottom t)))))))))
5377 "Update buffer modifications for current buffer.
5378 BEG and END are the beginning and end of the range of changed
5379 text, and the length in bytes of the pre-change text replaced by
5380 that range. See `after-change-functions' for more information."
5388 ;; Determine if modified area needs to be extended, according
5389 ;; to both previous and current state. We make a special
5390 ;; case for headline editing: if a headline is modified but
5391 ;; not removed, do not extend.
5400 org-element--cache-sensitive-re bottom t))))
5401 ;; Effectively extend modified area.
5409 ;; Store synchronization request.
5412 ;; Activate a timer to process the request during idle time.
5416 "Return first element to remove from cache.
5418 BEG and END are buffer positions delimiting buffer modifications.
5419 OFFSET is the size of the changes.
5421 Returned element is usually the first element in cache containing
5422 any position between BEG and END. As an exception, greater
5423 elements around the changes that are robust to contents
5424 modifications are preserved and updated according to the
5425 changes."
5435 quote-block special-block))
5440 ;; UP is a robust greater element containing changes.
5441 ;; We only need to extend its ending boundaries.
5447 ;; We're at top level element containing ELEMENT: if it's
5448 ;; altered by buffer modifications, it is first element in
5449 ;; cache to be removed. Otherwise, that first element is the
5450 ;; following one.
5451 ;;
5452 ;; As a special case, do not remove BEFORE if it is a robust
5453 ;; container for current changes.
5455 before)))))
5458 "Submit a new cache synchronization request for current buffer.
5459 BEG and END are buffer positions delimiting the minimal area
5460 where cache data should be removed. OFFSET is the size of the
5461 change, as an integer."
5463 delete-to delete-from)
5468 ;; Current changes can be merged with first sync request: we
5469 ;; can save a partial cache synchronization.
5472 ;; If last change happened within area to be removed, extend
5473 ;; boundaries of robust parents, if any. Otherwise, find
5474 ;; first element to remove and update request accordingly.
5486 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5487 ;; if any, is no longer a 0-phase request, thus ensuring that
5488 ;; phases are properly ordered. We need to provide OFFSET as
5489 ;; optional parameter since current modifications are not known
5490 ;; yet to the otherwise correct part of the cache (i.e, before
5491 ;; the first request).
5498 ;; When changes happen before the first known
5499 ;; element, re-parent and shift the rest of the
5500 ;; cache.
5502 ;; Otherwise, we find the first non robust
5503 ;; element containing END. All elements between
5504 ;; FIRST and this one are to be removed.
5505 ;;
5506 ;; Among them, some could be located outside the
5507 ;; synchronized part of the cache, in which case
5508 ;; comparing buffer positions to find them is
5509 ;; useless. Instead, we store the element
5510 ;; containing them in the request itself. All
5511 ;; its children will be removed.
5523 element up))
5526 org-element--cache-sync-requests)
5527 ;; No element to remove. No need to re-parent either.
5528 ;; Simply shift additional elements, if any, by OFFSET.
5533 ;;;; Public Functions
5535 ;;;###autoload
5537 "Reset cache in current buffer.
5538 When optional argument ALL is non-nil, reset cache in all Org
5539 buffers."
5557 ;;;###autoload
5559 "Refresh cache at position POS."
5566 \f
5567 ;;; The Toolbox
5568 ;;
5569 ;; The first move is to implement a way to obtain the smallest element
5570 ;; containing point. This is the job of `org-element-at-point'. It
5571 ;; basically jumps back to the beginning of section containing point
5572 ;; and proceed, one element after the other, with
5573 ;; `org-element--current-element' until the container is found. Note:
5574 ;; When using `org-element-at-point', secondary values are never
5575 ;; parsed since the function focuses on elements, not on objects.
5576 ;;
5577 ;; At a deeper level, `org-element-context' lists all elements and
5578 ;; objects containing point.
5579 ;;
5580 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5581 ;; internally by navigation and manipulation tools.
5584 ;;;###autoload
5586 "Determine closest element around point.
5588 Return value is a list like (TYPE PROPS) where TYPE is the type
5589 of the element and PROPS a plist of properties associated to the
5590 element.
5592 Possible types are defined in `org-element-all-elements'.
5593 Properties depend on element or object type, but always include
5594 `:begin', `:end', `:parent' and `:post-blank' properties.
5596 As a special case, if point is at the very beginning of the first
5597 item in a list or sub-list, returned element will be that list
5598 instead of the item. Likewise, if point is at the beginning of
5599 the first row of a table, returned element will be the table
5600 instead of the first row.
5602 When point is at the end of the buffer, return the innermost
5603 element ending there."
5609 ;; Within blank lines at the beginning of buffer, return nil.
5611 ;; Within blank lines right after a headline, return that
5612 ;; headline.
5616 ;; Otherwise parse until we find element containing ORIGIN.
5623 ;;;###autoload
5625 "Return smallest element or object around point.
5627 Return value is a list like (TYPE PROPS) where TYPE is the type
5628 of the element or object and PROPS a plist of properties
5629 associated to it.
5631 Possible types are defined in `org-element-all-elements' and
5632 `org-element-all-objects'. Properties depend on element or
5633 object type, but always include `:begin', `:end', `:parent' and
5634 `:post-blank'.
5636 As a special case, if point is right after an object and not at
5637 the beginning of any other object, return that object.
5639 Optional argument ELEMENT, when non-nil, is the closest element
5640 containing point, as returned by `org-element-at-point'.
5641 Providing it allows for quicker computation."
5647 ;; If point is inside an element containing objects or
5648 ;; a secondary string, narrow buffer to the container and
5649 ;; proceed with parsing. Otherwise, return ELEMENT.
5651 ;; At a parsed affiliated keyword, check if we're inside main
5652 ;; or dual value.
5659 org-element-parsed-keywords))
5668 ;; Also change type to retrieve correct restrictions.
5670 ;; At an item, objects can only be located within tag, if any.
5680 ;; At an headline or inlinetask, objects are in title.
5687 ;; At a paragraph, a table-row or a verse block, objects are
5688 ;; located within their contents.
5692 ;; CBEG is nil for table rules.
5697 ;; At a parsed keyword, objects are located within value.
5700 org-element-document-properties))
5707 ;; At a planning line, if point is at a timestamp, return it,
5708 ;; otherwise, return element.
5716 ;; All other locations cannot contain objects: bail out.
5726 next object-data last)
5730 ;; When entering PARENT for the first time, get list
5731 ;; of objects within known so far. Store it in
5732 ;; OBJECT-DATA.
5737 ;; Find NEXT object for analysis.
5739 ;; If NEXT is non-nil, we already exhausted the
5740 ;; cache so we can parse buffer to find the object
5741 ;; after it.
5743 ;; Otherwise, check if cache can help us.
5754 ;; Cache contains the information needed.
5757 pos)
5759 pos)
5765 ;; If we have a new object to analyze, store it in
5766 ;; cache. Otherwise record that there is nothing
5767 ;; more to parse in this element at this depth.
5772 ;; Process NEXT, if any, in order to know if we need
5773 ;; to skip it, return it or move into it.
5780 ;; Skip objects ending before point. Also skip
5781 ;; objects ending at point unless it is also the
5782 ;; end of buffer, since we want to return the
5783 ;; innermost object.
5786 ;; For convenience, when object ends at POS,
5787 ;; without any space, store it in LAST, as we
5788 ;; will return it if no object starts here.
5792 ;; If POS is within a container object, move
5793 ;; into that object.
5797 ;; At contents' end, if there is no
5798 ;; space before point, also move into
5799 ;; object, for consistency with
5800 ;; convenience feature above.
5809 next nil
5810 object-data nil))
5811 ;; Otherwise, return NEXT.
5813 ;; Store results in cache, if applicable.
5817 "List all ancestors of a given element or object.
5819 BLOB is an object or element.
5821 When optional argument TYPES is a list of symbols, return the
5822 first element or object in the lineage whose type belongs to that
5823 list.
5825 When optional argument WITH-SELF is non-nil, lineage includes
5826 BLOB itself as the first element, and TYPES, if provided, also
5827 apply to it.
5829 When BLOB is obtained through `org-element-context' or
5830 `org-element-at-point', only ancestors from its section can be
5831 found. There is no such limitation when BLOB belongs to a full
5832 parse tree."
5834 ancestors)
5841 "Non-nil when elements ELEM-A and ELEM-B are nested."
5850 "Swap elements ELEM-A and ELEM-B.
5851 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5852 end of ELEM-A."
5854 ;; There are two special cases when an element doesn't start at bol:
5855 ;; the first paragraph in an item or in a footnote definition.
5857 ;; Only a paragraph without any affiliated keyword can be moved at
5858 ;; ELEM-A position in such a situation. Note that the case of
5859 ;; a footnote definition is impossible: it cannot contain two
5860 ;; paragraphs in a row because it cannot contain a blank line.
5866 ;; In a special situation, ELEM-A will have no indentation. We'll
5867 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5881 ;; Store overlays responsible for visibility status. We
5882 ;; also need to store their boundaries as they will be
5883 ;; removed from buffer.
5890 ;; Get contents.
5898 ;; Restore ex ELEM-A overlays.
5907 ;; Restore ex ELEM-B overlays.
5915 "Remove maximum common indentation in string S and return it.
5916 When optional argument N is a positive integer, remove exactly
5917 that much characters from indentation, if possible, or return
5918 S as-is otherwise. Unlike to `org-remove-indentation', this
5919 function doesn't call `untabify' on S."
5924 ;; Find maximum common indentation, if not specified.
5932 min-ind)))
5934 ;; Remove exactly N indentation, but give up if not possible.
5947 ;; Local variables:
5948 ;; generated-autoload-file: "org-loaddefs.el"
5949 ;; End:
5951 ;;; org-element.el ends here