| blob | 2576c3facbf3e7a39860324b406051fa3e7a358e |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
165 ;; double-checked.
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
173 ;; Horizontal rules.
175 ;; LaTeX environments.
177 ;; Clock lines.
179 ;; Lists.
186 org-element--object-regexp
190 ;; Sub/superscript.
192 ;; Bold, code, italic, strike-through, underline
193 ;; and verbatim.
197 ;; Plain links.
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
203 ;; Objects starting with "@": export snippets.
204 "@@"
205 ;; Objects starting with "{": macro.
206 "{{{"
207 ;; Objects starting with "<" : timestamp
208 ;; (active, diary), target, radio target and
209 ;; angular links.
211 ;; Objects starting with "$": latex fragment.
213 ;; Objects starting with "\": line break,
214 ;; entity, latex fragment.
216 ;; Objects starting with raw text: inline Babel
217 ;; source block, inline Babel call.
223 ;;;###autoload
225 "Update parser internals."
232 dynamic-block example-block export-block fixed-width
233 footnote-definition headline horizontal-rule inlinetask item
234 keyword latex-environment node-property paragraph plain-list
235 planning property-drawer quote-block section
236 special-block src-block table table-row verse-block)
241 item plain-list property-drawer quote-block section
242 special-block table)
247 inline-src-block italic line-break latex-fragment link macro
248 radio-target statistics-cookie strike-through subscript superscript
249 table-cell target timestamp underline verbatim)
254 superscript table-cell underline)
268 "Alist between block names and the associated parsing function.
269 Names must be uppercase. Any block whose name has no association
275 "List of affiliated keywords as strings.
283 "Alist of usual translations for keywords.
284 The key is the old name and the value the new one. The property
288 "List of affiliated keywords that can occur more than once in an element.
290 Their value will be consed into a list of strings, which will be
291 returned as the value of the property.
293 This list is checked after translations have been applied. See
294 `org-element-keyword-translation-alist'.
300 "List of affiliated keywords whose value can be parsed.
302 Their value will be stored as a secondary string: a list of
303 strings and objects.
305 This list is checked after translations have been applied. See
310 org-element-parsed-keywords)
311 "Alist of parsed keywords and associated properties.
312 This is generated from `org-element-parsed-keywords', which
316 "List of affiliated keywords which can have a secondary value.
318 In Org syntax, they can be written with optional square brackets
319 before the colons. For example, RESULTS keyword can be
320 associated to a hash value with the following:
322 #+RESULTS[hash-string]: some-source
324 This list is checked after translations have been applied. See
330 ;; Dual affiliated keywords.
334 ;; Regular affiliated keywords.
339 org-element-affiliated-keywords)))
341 ;; Export attributes.
343 "Regexp matching any affiliated keyword.
345 Keyword name is put in match group 1. Moreover, if keyword
346 belongs to `org-element-dual-keywords', put the dual value in
347 match group 2.
361 ;; Ignore all links excepted plain links in a link description.
362 ;; Also ignore radio-targets and line breaks.
364 italic latex-fragment macro plain-link statistics-cookie
365 strike-through subscript superscript underline verbatim)
367 ;; Remove any variable object from radio target as it would
368 ;; prevent it from being properly recognized.
370 subscript superscript underline superscript)
374 ;; Ignore inline babel call and inline src block as formulas are
375 ;; possible. Also ignore line breaks and statistics cookies.
377 latex-fragment link macro radio-target strike-through
378 subscript superscript target timestamp underline verbatim)
382 "Alist of objects restrictions.
384 key is an element or object type containing objects and value is
385 a list of types that can be contained within an element or object
386 of such type.
388 For example, in a `radio-target' object, one can only find
389 entities, latex-fragments, subscript, superscript and text
390 markup.
392 This alist also applies to secondary string. For example, an
393 `headline' type element doesn't directly contain objects, but
408 "Table used internally to pair only square brackets.
412 \f
413 ;;; Accessors and Setters
414 ;;
415 ;; Provide four accessors: `org-element-type', `org-element-property'
416 ;; `org-element-contents' and `org-element-restriction'.
417 ;;
418 ;; Setter functions allow modification of elements by side effect.
419 ;; There is `org-element-put-property', `org-element-set-contents'.
420 ;; These low-level functions are useful to build a parse tree.
421 ;;
422 ;; `org-element-adopt-element', `org-element-set-element',
423 ;; `org-element-extract-element' and `org-element-insert-before' are
424 ;; high-level functions useful to modify a parse tree.
425 ;;
426 ;; `org-element-secondary-p' is a predicate used to know if a given
427 ;; object belongs to a secondary string. `org-element-copy' returns
428 ;; an element or object, stripping its parent property in the process.
431 "Return type of ELEMENT.
433 The function returns the type of the element or object provided.
434 It can also return the following special value:
435 `plain-text' for a string
436 `org-data' for a complete document
437 nil in any other case."
443 "Extract the value from the PROPERTY of an ELEMENT."
448 "Extract contents from an ELEMENT."
454 "Return restriction associated to ELEMENT.
455 ELEMENT can be an element, an object or a symbol representing an
456 element or object type."
458 org-element-object-restrictions)))
461 "In ELEMENT set PROPERTY to VALUE.
462 Return modified element."
465 element))
468 "Set ELEMENT contents to CONTENTS."
475 "Non-nil when OBJECT directly belongs to a secondary string.
476 Return value is the property name, as a keyword, or nil."
479 org-element-secondary-value-alist))))
486 "Append elements to the contents of another element.
488 PARENT is an element or object. CHILDREN can be elements,
489 objects, or a strings.
491 The function takes care of setting `:parent' property for CHILD.
492 Return parent element."
494 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
495 ;; string: parent is the list itself.
498 ;; Add CHILDREN at the end of PARENT contents.
501 parent
503 ;; Return modified PARENT element.
507 "Extract ELEMENT from parse tree.
508 Remove element from the parse tree by side-effect, and return it
509 with its `:parent' property stripped out."
514 parent secondary
517 parent
519 ;; Return ELEMENT with its :parent removed.
523 "Insert ELEMENT before LOCATION in parse tree.
524 LOCATION is an element, object or string within the parse tree.
525 Parse tree is modified by side effect."
530 ;; Special case: LOCATION is the first element of an
531 ;; independent secondary string (e.g. :title property). Add
532 ;; ELEMENT in-place.
536 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Create a new element of type TYPE.
579 Optional argument PROPS, when non-nil, is a plist defining the
580 properties of the element. CHILDREN can be elements, objects or
581 strings."
585 "Return a copy of DATUM.
586 DATUM is an element, object, string or nil. `:parent' property
587 is cleared and contents are removed in the process."
598 \f
599 ;;; Greater elements
600 ;;
601 ;; For each greater element type, we define a parser and an
602 ;; interpreter.
603 ;;
604 ;; A parser returns the element or object as the list described above.
605 ;; Most of them accepts no argument. Though, exceptions exist. Hence
606 ;; every element containing a secondary string (see
607 ;; `org-element-secondary-value-alist') will accept an optional
608 ;; argument to toggle parsing of these secondary strings. Moreover,
609 ;; `item' parser requires current list's structure as its first
610 ;; element.
611 ;;
612 ;; An interpreter accepts two arguments: the list representation of
613 ;; the element or object, and its contents. The latter may be nil,
614 ;; depending on the element or object considered. It returns the
615 ;; appropriate Org syntax, as a string.
616 ;;
617 ;; Parsing functions must follow the naming convention:
618 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
619 ;; defined in `org-element-greater-elements'.
620 ;;
621 ;; Similarly, interpreting functions must follow the naming
622 ;; convention: org-element-TYPE-interpreter.
623 ;;
624 ;; With the exception of `headline' and `item' types, greater elements
625 ;; cannot contain other greater elements of their own type.
626 ;;
627 ;; Beside implementing a parser and an interpreter, adding a new
628 ;; greater element requires tweaking `org-element--current-element'.
629 ;; Moreover, the newly defined type must be added to both
630 ;; `org-element-all-elements' and `org-element-greater-elements'.
633 ;;;; Center Block
636 "Parse a center block.
638 LIMIT bounds the search. AFFILIATED is a list of which CAR is
639 the buffer position at the beginning of the first affiliated
640 keyword and CDR is a plist of affiliated keywords along with
641 their value.
643 Return a list whose CAR is `center-block' and CDR is a plist
644 containing `:begin', `:end', `:contents-begin', `:contents-end',
645 `:post-blank' and `:post-affiliated' keywords.
647 Assume point is at the beginning of the block."
651 ;; Incomplete block: parse it as a paragraph.
656 ;; Empty blocks have no contents.
670 :end end
671 :contents-begin contents-begin
672 :contents-end contents-end
678 "Interpret CENTER-BLOCK element as Org syntax.
679 CONTENTS is the contents of the element."
683 ;;;; Drawer
686 "Parse a drawer.
688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
689 the buffer position at the beginning of the first affiliated
690 keyword and CDR is a plist of affiliated keywords along with
691 their value.
693 Return a list whose CAR is `drawer' and CDR is a plist containing
694 `:drawer-name', `:begin', `:end', `:contents-begin',
695 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
697 Assume point is at beginning of drawer."
700 ;; Incomplete drawer: parse it as a paragraph.
708 ;; Empty drawers have no contents.
721 :end end
722 :drawer-name name
723 :contents-begin contents-begin
724 :contents-end contents-end
730 "Interpret DRAWER element as Org syntax.
731 CONTENTS is the contents of the element."
734 contents))
737 ;;;; Dynamic Block
740 "Parse a dynamic block.
742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
743 the buffer position at the beginning of the first affiliated
744 keyword and CDR is a plist of affiliated keywords along with
745 their value.
747 Return a list whose CAR is `dynamic-block' and CDR is a plist
748 containing `:block-name', `:begin', `:end', `:contents-begin',
749 `:contents-end', `:arguments', `:post-blank' and
750 `:post-affiliated' keywords.
752 Assume point is at beginning of dynamic block."
756 ;; Incomplete block: parse it as a paragraph.
765 ;; Empty blocks have no contents.
778 :end end
779 :block-name name
780 :arguments arguments
781 :contents-begin contents-begin
782 :contents-end contents-end
788 "Interpret DYNAMIC-BLOCK element as Org syntax.
789 CONTENTS is the contents of the element."
794 contents))
797 ;;;; Footnote Definition
806 "Parse a footnote definition.
808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
809 the buffer position at the beginning of the first affiliated
810 keyword and CDR is a plist of affiliated keywords along with
811 their value.
813 Return a list whose CAR is `footnote-definition' and CDR is
814 a plist containing `:label', `:begin' `:end', `:contents-begin',
815 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
817 Assume point is at the beginning of the footnote definition."
829 limit)
831 ;; At a new footnote definition, make sure we end
832 ;; before any affiliated keyword above.
853 :begin begin
854 :end end
855 :contents-begin contents-begin
856 :contents-end contents-end
862 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
863 CONTENTS is the contents of the footnote-definition."
865 " "
866 contents))
869 ;;;; Headline
872 "Return node properties associated to headline at point.
873 Upcase property names. It avoids confusion between properties
874 obtained through property drawer and default properties from the
875 parser (e.g. `:end' and :END:). Return value is a plist."
887 properties))))
890 "Return time properties associated to headline at point.
891 Return value is a plist."
905 plist))))
908 "Parse a headline.
910 Return a list whose CAR is `headline' and CDR is a plist
911 containing `:raw-value', `:title', `:begin', `:end',
912 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
913 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
914 `:deadline', `:closed', `:archivedp', `:commentedp'
915 `:footnote-section-p', `:post-blank' and `:post-affiliated'
916 keywords.
918 The plist also contains any property set in the property drawer,
919 with its name in upper cases and colons added at the
920 beginning (e.g., `:CUSTOM_ID').
922 LIMIT is a buffer position bounding the search.
924 When RAW-SECONDARY-P is non-nil, headline's title will not be
925 parsed as a secondary string, but as a plain string instead.
927 Assume point is at beginning of the headline."
974 :begin begin
975 :end end
976 :pre-blank
979 :contents-begin contents-begin
980 :contents-end contents-end
981 :level level
982 :priority priority
983 :tags tags
984 :todo-keyword todo
985 :todo-type todo-type
988 end)
989 :footnote-section-p footnote-section-p
990 :archivedp archivedp
991 :commentedp commentedp
993 time-props
994 standard-props))))
996 headline :title
1005 nil
1011 "Interpret HEADLINE element as Org syntax.
1012 CONTENTS is the contents of the element."
1025 ?*)
1029 " "
1032 org-footnote-section
1033 title))))
1035 heading
1036 ;; Align tags.
1044 ?\s)
1045 tags))
1049 tags))))
1051 contents)))
1054 ;;;; Inlinetask
1057 "Parse an inline task.
1059 Return a list whose CAR is `inlinetask' and CDR is a plist
1060 containing `:title', `:begin', `:end', `:contents-begin' and
1061 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1062 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1063 `:closed', `:post-blank' and `:post-affiliated' keywords.
1065 The plist also contains any property set in the property drawer,
1066 with its name in upper cases and colons added at the
1067 beginning (e.g., `:CUSTOM_ID').
1069 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1070 title will not be parsed as a secondary string, but as a plain
1071 string instead.
1073 Assume point is at beginning of the inline task."
1118 :begin begin
1119 :end end
1120 :contents-begin contents-begin
1121 :contents-end contents-end
1122 :level level
1123 :priority priority
1124 :tags tags
1125 :todo-keyword todo
1126 :todo-type todo-type
1129 time-props
1130 standard-props))))
1132 inlinetask :title
1141 nil
1147 "Interpret INLINETASK element as Org syntax.
1148 CONTENTS is the contents of inlinetask."
1162 ;; Align tags.
1170 ? )
1171 tags))
1175 tags))))
1176 ;; Prefer degenerate inlinetasks when there are no
1177 ;; contents.
1180 contents
1184 ;;;; Item
1187 "Parse an item.
1189 STRUCT is the structure of the plain list.
1191 Return a list whose CAR is `item' and CDR is a plist containing
1192 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1193 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1194 `:post-affiliated' keywords.
1196 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1197 any, will not be parsed as a secondary string, but as a plain
1198 string instead.
1200 Assume point is at the beginning of the item."
1223 ;; Ignore tags in un-ordered lists: they are just
1224 ;; a part of item's body.
1231 ;; If first line isn't empty, contents really
1232 ;; start at the text after item's meta-data.
1242 :begin begin
1243 :end end
1244 :contents-begin contents-begin
1245 :contents-end contents-end
1246 :checkbox checkbox
1247 :counter counter
1248 :structure struct
1252 item :tag
1263 "Interpret ITEM element as Org syntax.
1264 CONTENTS is the contents of the element."
1274 ;; Compute indentation.
1279 ;; Indent contents.
1281 bullet
1295 ;;;; Plain List
1298 ;; Return structure of list at point. Internal function. See
1299 ;; `org-list-struct' for details.
1304 items struct)
1309 ;; At limit: end all items.
1318 ;; At list end: end all items.
1323 ;; At a new item: end previous sibling.
1335 ind
1336 bullet
1339 ;; Description tag.
1343 ;; Ending position, unknown so far.
1344 nil)))
1345 items))
1347 ;; Skip empty lines.
1349 ;; Skip inline tasks and blank lines along the way.
1356 ;; At some text line. Check if it ends any previous item.
1369 ;; Skip blocks (any type) and drawers contents.
1374 limit t)))
1380 "Parse a plain list.
1382 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1383 the buffer position at the beginning of the first affiliated
1384 keyword and CDR is a plist of affiliated keywords along with
1385 their value. STRUCTURE is the structure of the plain list being
1386 parsed.
1388 Return a list whose CAR is `plain-list' and CDR is a plist
1389 containing `:type', `:begin', `:end', `:contents-begin' and
1390 `:contents-end', `:structure', `:post-blank' and
1391 `:post-affiliated' keywords.
1393 Assume point is at the beginning of the list."
1407 pos))
1411 ;; Return value.
1415 :begin begin
1416 :end end
1417 :contents-begin contents-begin
1418 :contents-end contents-end
1419 :structure struct
1425 "Interpret PLAIN-LIST element as Org syntax.
1426 CONTENTS is the contents of the element."
1434 ;;;; Property Drawer
1437 "Parse a property drawer.
1439 LIMIT bounds the search.
1441 Return a list whose car is `property-drawer' and cdr is a plist
1442 containing `:begin', `:end', `:contents-begin', `:contents-end',
1443 `:post-blank' and `:post-affiliated' keywords.
1445 Assume point is at the beginning of the property drawer."
1458 :end end
1460 :contents-end contents-end
1465 "Interpret PROPERTY-DRAWER element as Org syntax.
1466 CONTENTS is the properties within the drawer."
1470 ;;;; Quote Block
1473 "Parse a quote block.
1475 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1476 the buffer position at the beginning of the first affiliated
1477 keyword and CDR is a plist of affiliated keywords along with
1478 their value.
1480 Return a list whose CAR is `quote-block' and CDR is a plist
1481 containing `:begin', `:end', `:contents-begin', `:contents-end',
1482 `:post-blank' and `:post-affiliated' keywords.
1484 Assume point is at the beginning of the block."
1488 ;; Incomplete block: parse it as a paragraph.
1494 ;; Empty blocks have no contents.
1507 :end end
1508 :contents-begin contents-begin
1509 :contents-end contents-end
1515 "Interpret QUOTE-BLOCK element as Org syntax.
1516 CONTENTS is the contents of the element."
1520 ;;;; Section
1523 "Parse a section.
1525 LIMIT bounds the search.
1527 Return a list whose CAR is `section' and CDR is a plist
1528 containing `:begin', `:end', `:contents-begin', `contents-end',
1529 `:post-blank' and `:post-affiliated' keywords."
1531 ;; Beginning of section is the beginning of the first non-blank
1532 ;; line after previous headline.
1541 :end end
1542 :contents-begin begin
1543 :contents-end pos-before-blank
1548 "Interpret SECTION element as Org syntax.
1549 CONTENTS is the contents of the element."
1550 contents)
1553 ;;;; Special Block
1556 "Parse a special block.
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 `special-block' and CDR is a plist
1564 containing `:type', `:begin', `:end', `:contents-begin',
1565 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1567 Assume point is at the beginning of the block."
1574 limit t)))
1575 ;; Incomplete block: parse it as a paragraph.
1581 ;; Empty blocks have no contents.
1594 :begin begin
1595 :end end
1596 :contents-begin contents-begin
1597 :contents-end contents-end
1603 "Interpret SPECIAL-BLOCK element as Org syntax.
1604 CONTENTS is the contents of the element."
1609 \f
1610 ;;; Elements
1611 ;;
1612 ;; For each element, a parser and an interpreter are also defined.
1613 ;; Both follow the same naming convention used for greater elements.
1614 ;;
1615 ;; Also, as for greater elements, adding a new element type is done
1616 ;; through the following steps: implement a parser and an interpreter,
1617 ;; tweak `org-element--current-element' so that it recognizes the new
1618 ;; type and add that new type to `org-element-all-elements'.
1619 ;;
1620 ;; As a special case, when the newly defined type is a block type,
1621 ;; `org-element-block-name-alist' has to be modified accordingly.
1624 ;;;; Babel Call
1627 "Parse a babel call.
1629 LIMIT bounds the search. AFFILIATED is a list of which car is
1630 the buffer position at the beginning of the first affiliated
1631 keyword and cdr is a plist of affiliated keywords along with
1632 their value.
1634 Return a list whose car is `babel-call' and cdr is a plist
1635 containing `:call', `:inside-header', `:arguments',
1636 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1637 `:post-affiliated' as keywords."
1651 value)))
1661 :begin begin
1662 :end end
1663 :value value
1669 "Interpret BABEL-CALL element as Org syntax.
1670 CONTENTS is nil."
1680 ;;;; Clock
1683 "Parse a clock.
1685 LIMIT bounds the search.
1687 Return a list whose CAR is `clock' and CDR is a plist containing
1688 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1689 `:post-affiliated' as keywords."
1709 :value value
1710 :duration duration
1711 :begin begin
1712 :end end
1713 :post-blank post-blank
1717 "Interpret CLOCK element as Org syntax.
1718 CONTENTS is nil."
1726 "%2s:%02s"
1730 ;;;; Comment
1733 "Parse a comment.
1735 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1736 the buffer position at the beginning of the first affiliated
1737 keyword and CDR is a plist of affiliated keywords along with
1738 their value.
1740 Return a list whose CAR is `comment' and CDR is a plist
1741 containing `:begin', `:end', `:value', `:post-blank',
1742 `:post-affiliated' keywords.
1744 Assume point is at comment beginning."
1753 ;; Get comments ending.
1756 ;; Accumulate lines without leading hash and first
1757 ;; whitespace.
1771 :end end
1772 :value value
1778 "Interpret COMMENT element as Org syntax.
1779 CONTENTS is nil."
1783 ;;;; Comment Block
1786 "Parse an export block.
1788 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1789 the buffer position at the beginning of the first affiliated
1790 keyword and CDR is a plist of affiliated keywords along with
1791 their value.
1793 Return a list whose CAR is `comment-block' and CDR is a plist
1794 containing `:begin', `:end', `:value', `:post-blank' and
1795 `:post-affiliated' keywords.
1797 Assume point is at comment block beginning."
1801 ;; Incomplete block: parse it as a paragraph.
1814 contents-begin contents-end)))
1818 :end end
1819 :value value
1825 "Interpret COMMENT-BLOCK element as Org syntax.
1826 CONTENTS is nil."
1833 ;;;; Diary Sexp
1836 "Parse a diary sexp.
1838 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1839 the buffer position at the beginning of the first affiliated
1840 keyword and CDR is a plist of affiliated keywords along with
1841 their value.
1843 Return a list whose CAR is `diary-sexp' and CDR is a plist
1844 containing `:begin', `:end', `:value', `:post-blank' and
1845 `:post-affiliated' keywords."
1857 :begin begin
1858 :end end
1864 "Interpret DIARY-SEXP as Org syntax.
1865 CONTENTS is nil."
1869 ;;;; Example Block
1872 "Parse an example block.
1874 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1875 the buffer position at the beginning of the first affiliated
1876 keyword and CDR is a plist of affiliated keywords along with
1877 their value.
1879 Return a list whose CAR is `example-block' and CDR is a plist
1880 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1881 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1882 `:value', `:post-blank' and `:post-affiliated' keywords."
1886 ;; Incomplete block: parse it as a paragraph.
1894 ;; Switches analysis
1901 ;; Should labels be retained in (or stripped from) example
1902 ;; blocks?
1907 ;; What should code-references use - labels or
1908 ;; line-numbers?
1917 ;; Standard block parsing.
1925 contents-begin contents-end))
1926 block-ind))
1935 :end end
1936 :value value
1937 :switches switches
1938 :number-lines number-lines
1939 :preserve-indent preserve-indent
1940 :retain-labels retain-labels
1941 :use-labels use-labels
1942 :label-fmt label-fmt
1948 "Interpret EXAMPLE-BLOCK element as Org syntax.
1949 CONTENTS is nil."
1957 value
1962 ;;;; Export Block
1965 "Parse an export block.
1967 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1968 the buffer position at the beginning of the first affiliated
1969 keyword and CDR is a plist of affiliated keywords along with
1970 their value.
1972 Return a list whose CAR is `export-block' and CDR is a plist
1973 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1974 `:post-affiliated' keywords.
1976 Assume point is at export-block beginning."
1983 ;; Incomplete block: parse it as a paragraph.
1996 contents-end)))
2000 :end end
2001 :type type
2002 :value value
2008 "Interpret EXPORT-BLOCK element as Org syntax.
2009 CONTENTS is nil."
2016 ;;;; Fixed-width
2019 "Parse a fixed-width section.
2021 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2022 the buffer position at the beginning of the first affiliated
2023 keyword and CDR is a plist of affiliated keywords along with
2024 their value.
2026 Return a list whose CAR is `fixed-width' and CDR is a plist
2027 containing `:begin', `:end', `:value', `:post-blank' and
2028 `:post-affiliated' keywords.
2030 Assume point is at the beginning of the fixed-width area."
2034 value
2039 ;; Accumulate text without starting colons.
2052 :end end
2053 :value value
2059 "Interpret FIXED-WIDTH element as Org syntax.
2060 CONTENTS is nil."
2068 ;;;; Horizontal Rule
2071 "Parse an horizontal rule.
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 `horizontal-rule' and CDR is a plist
2079 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2080 keywords."
2090 :end end
2096 "Interpret HORIZONTAL-RULE element as Org syntax.
2097 CONTENTS is nil."
2101 ;;;; Keyword
2104 "Parse a keyword at point.
2106 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2107 the buffer position at the beginning of the first affiliated
2108 keyword and CDR is a plist of affiliated keywords along with
2109 their value.
2111 Return a list whose CAR is `keyword' and CDR is a plist
2112 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2113 `:post-affiliated' keywords."
2115 ;; An orphaned affiliated keyword is considered as a regular
2116 ;; keyword. In this case AFFILIATED is nil, so we take care of
2117 ;; this corner case.
2130 :value value
2131 :begin begin
2132 :end end
2138 "Interpret KEYWORD element as Org syntax.
2139 CONTENTS is nil."
2145 ;;;; Latex Environment
2149 "Regexp matching the beginning of a LaTeX environment.
2150 The environment is captured by the first group.
2156 "Format string matching the ending of a LaTeX environment.
2160 "Parse a LaTeX environment.
2162 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2163 the buffer position at the beginning of the first affiliated
2164 keyword and CDR is a plist of affiliated keywords along with
2165 their value.
2167 Return a list whose CAR is `latex-environment' and CDR is a plist
2168 containing `:begin', `:end', `:value', `:post-blank' and
2169 `:post-affiliated' keywords.
2171 Assume point is at the beginning of the latex environment."
2178 limit t))
2179 ;; Incomplete latex environment: parse it as a paragraph.
2189 :end end
2190 :value value
2196 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2197 CONTENTS is nil."
2201 ;;;; Node Property
2204 "Parse a node-property at point.
2206 LIMIT bounds the search.
2208 Return a list whose CAR is `node-property' and CDR is a plist
2209 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2210 `:post-affiliated' keywords."
2220 limit))))
2223 :value value
2224 :begin begin
2225 :end end
2230 "Interpret NODE-PROPERTY element as Org syntax.
2231 CONTENTS is nil."
2237 ;;;; Paragraph
2240 "Parse a paragraph.
2242 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2243 the buffer position at the beginning of the first affiliated
2244 keyword and CDR is a plist of affiliated keywords along with
2245 their value.
2247 Return a list whose CAR is `paragraph' and CDR is a plist
2248 containing `:begin', `:end', `:contents-begin' and
2249 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2251 Assume point is at the beginning of the paragraph."
2258 ;; A matching `org-element-paragraph-separate' is not
2259 ;; necessarily the end of the paragraph. In particular,
2260 ;; drawers, blocks or LaTeX environments opening lines
2261 ;; must be closed. Moreover keywords with a secondary
2262 ;; value must belong to "dual keywords".
2276 limit t)))
2282 limit t)))
2285 org-element-dual-keywords))
2286 ;; Everything else is unambiguous.
2299 :end end
2300 :contents-begin contents-begin
2301 :contents-end contents-end
2307 "Interpret PARAGRAPH element as Org syntax.
2308 CONTENTS is the contents of the element."
2309 contents)
2312 ;;;; Planning
2315 "Parse a planning.
2317 LIMIT bounds the search.
2319 Return a list whose CAR is `planning' and CDR is a plist
2320 containing `:closed', `:deadline', `:scheduled', `:begin',
2321 `:end', `:post-blank' and `:post-affiliated' keywords."
2331 closed deadline scheduled)
2343 :deadline deadline
2344 :scheduled scheduled
2345 :begin begin
2346 :end end
2347 :post-blank post-blank
2351 "Interpret PLANNING element as Org syntax.
2352 CONTENTS is nil."
2354 'identity
2371 ;;;; Src Block
2374 "Parse a src block.
2376 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2377 the buffer position at the beginning of the first affiliated
2378 keyword and CDR is a plist of affiliated keywords along with
2379 their value.
2381 Return a list whose CAR is `src-block' and CDR is a plist
2382 containing `:language', `:switches', `:parameters', `:begin',
2383 `:end', `:number-lines', `:retain-labels', `:use-labels',
2384 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2385 `:post-affiliated' keywords.
2387 Assume point is at the beginning of the block."
2390 limit t)))
2391 ;; Incomplete block: parse it as a paragraph.
2397 ;; Get language as a string.
2406 ;; Get switches.
2408 ;; Get parameters.
2410 ;; Switches analysis
2421 ;; Should labels be retained in (or stripped from)
2422 ;; src blocks?
2427 ;; What should code-references use - labels or
2428 ;; line-numbers?
2433 ;; Indentation.
2435 ;; Retrieve code.
2440 block-ind))
2444 ;; Get position after ending blank lines.
2454 :begin begin
2455 :end end
2456 :number-lines number-lines
2457 :preserve-indent preserve-indent
2458 :retain-labels retain-labels
2459 :use-labels use-labels
2460 :label-fmt label-fmt
2461 :value value
2467 "Interpret SRC-BLOCK element as Org syntax.
2468 CONTENTS is nil."
2477 val)
2491 ;;;; Table
2494 "Parse a table at point.
2496 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2497 the buffer position at the beginning of the first affiliated
2498 keyword and CDR is a plist of affiliated keywords along with
2499 their value.
2501 Return a list whose CAR is `table' and CDR is a plist containing
2502 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2503 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2504 keywords.
2506 Assume point is at the beginning of the table."
2522 acc))
2529 :end end
2530 :type type
2531 :tblfm tblfm
2532 ;; Only `org' tables have contents. `table.el' tables
2533 ;; use a `:value' property to store raw table as
2534 ;; a string.
2539 table-begin table-end))
2545 "Interpret TABLE element as Org syntax.
2546 CONTENTS is a string, if table's type is `org', or nil."
2557 ;;;; Table Row
2560 "Parse table row at point.
2562 LIMIT bounds the search.
2564 Return a list whose CAR is `table-row' and CDR is a plist
2565 containing `:begin', `:end', `:contents-begin', `:contents-end',
2566 `:type', `:post-blank' and `:post-affiliated' keywords."
2570 ;; A table rule has no contents. In that case, ensure
2571 ;; CONTENTS-BEGIN matches CONTENTS-END.
2583 :begin begin
2584 :end end
2585 :contents-begin contents-begin
2586 :contents-end contents-end
2591 "Interpret TABLE-ROW element as Org syntax.
2592 CONTENTS is the contents of the table row."
2597 ;;;; Verse Block
2600 "Parse a verse block.
2602 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2603 the buffer position at the beginning of the first affiliated
2604 keyword and CDR is a plist of affiliated keywords along with
2605 their value.
2607 Return a list whose CAR is `verse-block' and CDR is a plist
2608 containing `:begin', `:end', `:contents-begin', `:contents-end',
2609 `:post-blank' and `:post-affiliated' keywords.
2611 Assume point is at beginning of the block."
2615 ;; Incomplete block: parse it as a paragraph.
2630 :end end
2631 :contents-begin contents-begin
2632 :contents-end contents-end
2638 "Interpret VERSE-BLOCK element as Org syntax.
2639 CONTENTS is verse block contents."
2643 \f
2644 ;;; Objects
2645 ;;
2646 ;; Unlike to elements, raw text can be found between objects. Hence,
2647 ;; `org-element--object-lex' is provided to find the next object in
2648 ;; buffer.
2649 ;;
2650 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2651 ;; object types they can contain will be specified in
2652 ;; `org-element-object-restrictions'.
2653 ;;
2654 ;; Creating a new type of object requires to alter
2655 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2656 ;; new type in `org-element-all-objects', and possibly add
2657 ;; restrictions in `org-element-object-restrictions'.
2659 ;;;; Bold
2662 "Parse bold object at point, if any.
2664 When at a bold object, return a list whose car is `bold' and cdr
2665 is a plist with `:begin', `:end', `:contents-begin' and
2666 `:contents-end' and `:post-blank' keywords. Otherwise, return
2667 nil.
2669 Assume point is at the first star marker."
2681 :end end
2682 :contents-begin contents-begin
2683 :contents-end contents-end
2687 "Interpret BOLD object as Org syntax.
2688 CONTENTS is the contents of the object."
2692 ;;;; Code
2695 "Parse code object at point, if any.
2697 When at a code object, return a list whose car is `code' and cdr
2698 is a plist with `:value', `:begin', `:end' and `:post-blank'
2699 keywords. Otherwise, return nil.
2701 Assume point is at the first tilde marker."
2712 :begin begin
2713 :end end
2717 "Interpret CODE object as Org syntax.
2718 CONTENTS is nil."
2722 ;;;; Entity
2725 "Parse entity at point, if any.
2727 When at an entity, return a list whose car is `entity' and cdr
2728 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2729 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2730 `:post-blank' as keywords. Otherwise, return nil.
2732 Assume point is at the beginning of the entity."
2734 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2752 :begin begin
2753 :end end
2754 :use-brackets-p bracketsp
2758 "Interpret ENTITY object as Org syntax.
2759 CONTENTS is nil."
2765 ;;;; Export Snippet
2768 "Parse export snippet at point.
2770 When at an export snippet, return a list whose car is
2771 `export-snippet' and cdr a plist with `:begin', `:end',
2772 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2773 return nil.
2775 Assume point is at the beginning of the snippet."
2791 :value value
2792 :begin begin
2793 :end end
2797 "Interpret EXPORT-SNIPPET object as Org syntax.
2798 CONTENTS is nil."
2804 ;;;; Footnote Reference
2807 "Parse footnote reference at point, if any.
2809 When at a footnote reference, return a list whose car is
2810 `footnote-reference' and cdr a plist with `:label', `:type',
2811 `:begin', `:end', `:content-begin', `:contents-end' and
2812 `:post-blank' as keywords. Otherwise, return nil."
2832 :type type
2833 :begin begin
2834 :end end
2840 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2841 CONTENTS is its definition, when inline, or nil."
2847 ;;;; Inline Babel Call
2850 "Parse inline babel call at point, if any.
2852 When at an inline babel call, return a list whose car is
2853 `inline-babel-call' and cdr a plist with `:call',
2854 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2855 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2857 Assume point is at the beginning of the babel call."
2873 :inside-header inside-header
2874 :arguments arguments
2875 :end-header end-header
2876 :begin begin
2877 :end end
2878 :value value
2882 "Interpret INLINE-BABEL-CALL object as Org syntax.
2883 CONTENTS is nil."
2893 ;;;; Inline Src Block
2896 "Parse inline source block at point, if any.
2898 When at an inline source block, return a list whose car is
2899 `inline-src-block' and cdr a plist with `:begin', `:end',
2900 `:language', `:value', `:parameters' and `:post-blank' as
2901 keywords. Otherwise, return nil.
2903 Assume point is at the beginning of the inline src block."
2916 :value value
2917 :parameters parameters
2918 :begin begin
2919 :end end
2923 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2924 CONTENTS is nil."
2929 language
2931 body)))
2933 ;;;; Italic
2936 "Parse italic object at point, if any.
2938 When at an italic object, return a list whose car is `italic' and
2939 cdr is a plist with `:begin', `:end', `:contents-begin' and
2940 `:contents-end' and `:post-blank' keywords. Otherwise, return
2941 nil.
2943 Assume point is at the first slash marker."
2955 :end end
2956 :contents-begin contents-begin
2957 :contents-end contents-end
2961 "Interpret ITALIC object as Org syntax.
2962 CONTENTS is the contents of the object."
2966 ;;;; Latex Fragment
2969 "Parse LaTeX fragment at point, if any.
2971 When at a LaTeX fragment, return a list whose car is
2972 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2973 and `:post-blank' as keywords. Otherwise, return nil.
2975 Assume point is at the beginning of the LaTeX fragment."
2993 ;; Macro.
3002 :begin begin
3003 :end end
3007 "Interpret LATEX-FRAGMENT object as Org syntax.
3008 CONTENTS is nil."
3011 ;;;; Line Break
3014 "Parse line break at point, if any.
3016 When at a line break, return a list whose car is `line-break',
3017 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3018 Otherwise, return nil.
3020 Assume point is at the beginning of the line break."
3029 "Interpret LINE-BREAK object as Org syntax.
3030 CONTENTS is nil."
3034 ;;;; Link
3037 "Parse link at point, if any.
3039 When at a link, return a list whose car is `link' and cdr a plist
3040 with `:type', `:path', `:raw-link', `:application',
3041 `:search-option', `:begin', `:end', `:contents-begin',
3042 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3043 nil.
3045 Assume point is at the beginning of the link."
3048 end contents-begin contents-end link-end post-blank path type
3049 raw-link link search-option application)
3051 ;; Type 1: Text targeted from a radio target.
3060 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3065 ;; RAW-LINK is the original link. Expand any
3066 ;; abbreviation in it.
3067 ;;
3068 ;; Also treat any newline character and associated
3069 ;; indentation as a single space character. This is not
3070 ;; compatible with RFC 3986, which requires to ignore
3071 ;; them altogether. However, doing so would require
3072 ;; users to encode spaces on the fly when writing links
3073 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3074 ;; [[shell:ls *.org]], which defeats Org's focus on
3075 ;; simplicity.
3080 ;; Determine TYPE of link and set PATH accordingly. According
3081 ;; to RFC 3986, remove whitespaces from URI in external links.
3082 ;; In internal ones, treat indentation as a single space.
3084 ;; File type.
3089 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3093 ;; Id type: PATH is the id.
3096 ;; Code-ref type: PATH is the name of the reference.
3101 ;; Custom-id type: PATH is the name of the custom id.
3105 ;; Fuzzy type: Internal link either matches a target, an
3106 ;; headline name or nothing. PATH is the target or
3107 ;; headline's name.
3111 ;; Type 3: Plain link, e.g., http://orgmode.org
3117 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3118 ;; bracket links, follow RFC 3986 and remove any extra
3119 ;; whitespace in URI.
3129 ;; In any case, deduce end point after trailing white space from
3130 ;; LINK-END variable.
3135 ;; Special "file" type link processing. Extract opening
3136 ;; application and search option, if any. Also normalize URI.
3143 ;; Translate link, if `org-link-translation-function' is set.
3151 :path path
3153 :application application
3154 :search-option search-option
3155 :begin begin
3156 :end end
3157 :contents-begin contents-begin
3158 :contents-end contents-end
3162 "Interpret LINK object as Org syntax.
3163 CONTENTS is the contents of the object, or nil."
3174 path
3181 ;;;; Macro
3184 "Parse macro at point, if any.
3186 When at a macro, return a list whose car is `macro' and cdr
3187 a plist with `:key', `:args', `:begin', `:end', `:value' and
3188 `:post-blank' as keywords. Otherwise, return nil.
3190 Assume point is at the macro."
3203 :value value
3204 :args args
3205 :begin begin
3206 :end end
3210 "Interpret MACRO object as Org syntax.
3211 CONTENTS is nil."
3215 ;;;; Radio-target
3218 "Parse radio target at point, if any.
3220 When at a radio target, return a list whose car is `radio-target'
3221 and cdr a plist with `:begin', `:end', `:contents-begin',
3222 `:contents-end', `:value' and `:post-blank' as keywords.
3223 Otherwise, return nil.
3225 Assume point is at the radio target."
3237 :end end
3238 :contents-begin contents-begin
3239 :contents-end contents-end
3240 :post-blank post-blank
3244 "Interpret TARGET object as Org syntax.
3245 CONTENTS is the contents of the object."
3249 ;;;; Statistics Cookie
3252 "Parse statistics cookie at point, if any.
3254 When at a statistics cookie, return a list whose car is
3255 `statistics-cookie', and cdr a plist with `:begin', `:end',
3256 `:value' and `:post-blank' keywords. Otherwise, return nil.
3258 Assume point is at the beginning of the statistics-cookie."
3269 :end end
3270 :value value
3274 "Interpret STATISTICS-COOKIE object as Org syntax.
3275 CONTENTS is nil."
3279 ;;;; Strike-Through
3282 "Parse strike-through object at point, if any.
3284 When at a strike-through object, return a list whose car is
3285 `strike-through' and cdr is a plist with `:begin', `:end',
3286 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3287 Otherwise, return nil.
3289 Assume point is at the first plus sign marker."
3301 :end end
3302 :contents-begin contents-begin
3303 :contents-end contents-end
3307 "Interpret STRIKE-THROUGH object as Org syntax.
3308 CONTENTS is the contents of the object."
3312 ;;;; Subscript
3315 "Parse subscript at point, if any.
3317 When at a subscript object, return a list whose car is
3318 `subscript' and cdr a plist with `:begin', `:end',
3319 `:contents-begin', `:contents-end', `:use-brackets-p' and
3320 `:post-blank' as keywords. Otherwise, return nil.
3322 Assume point is at the underscore."
3336 :end end
3337 :use-brackets-p bracketsp
3338 :contents-begin contents-begin
3339 :contents-end contents-end
3343 "Interpret SUBSCRIPT object as Org syntax.
3344 CONTENTS is the contents of the object."
3347 contents))
3350 ;;;; Superscript
3353 "Parse superscript at point, if any.
3355 When at a superscript object, return a list whose car is
3356 `superscript' and cdr a plist with `:begin', `:end',
3357 `:contents-begin', `:contents-end', `:use-brackets-p' and
3358 `:post-blank' as keywords. Otherwise, return nil.
3360 Assume point is at the caret."
3374 :end end
3375 :use-brackets-p bracketsp
3376 :contents-begin contents-begin
3377 :contents-end contents-end
3381 "Interpret SUPERSCRIPT object as Org syntax.
3382 CONTENTS is the contents of the object."
3385 contents))
3388 ;;;; Table Cell
3391 "Parse table cell at point.
3392 Return a list whose car is `table-cell' and cdr is a plist
3393 containing `:begin', `:end', `:contents-begin', `:contents-end'
3394 and `:post-blank' keywords."
3402 :end end
3403 :contents-begin contents-begin
3404 :contents-end contents-end
3408 "Interpret TABLE-CELL element as Org syntax.
3409 CONTENTS is the contents of the cell, or nil."
3413 ;;;; Target
3416 "Parse target at point, if any.
3418 When at a target, return a list whose car is `target' and cdr
3419 a plist with `:begin', `:end', `:value' and `:post-blank' as
3420 keywords. Otherwise, return nil.
3422 Assume point is at the target."
3432 :end end
3433 :value value
3437 "Interpret TARGET object as Org syntax.
3438 CONTENTS is nil."
3442 ;;;; Timestamp
3453 "Parse time stamp at point, if any.
3455 When at a time stamp, return a list whose car is `timestamp', and
3456 cdr a plist with `:type', `:raw-value', `:year-start',
3457 `:month-start', `:day-start', `:hour-start', `:minute-start',
3458 `:year-end', `:month-end', `:day-end', `:hour-end',
3459 `:minute-end', `:repeater-type', `:repeater-value',
3460 `:repeater-unit', `:warning-type', `:warning-value',
3461 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3462 Otherwise, return nil.
3464 Assume point is at the beginning of the timestamp."
3483 date-start)
3494 raw-value)
3496 :repeater-type
3502 :repeater-unit
3511 :warning-unit
3514 year-start month-start day-start hour-start minute-start year-end
3515 month-end day-end hour-end minute-end)
3516 ;; Parse date-start.
3524 ;; Compute date-end. It can be provided directly in time-stamp,
3525 ;; or extracted from time range. Otherwise, it defaults to the
3526 ;; same values as date-start.
3536 :raw-value raw-value
3537 :year-start year-start
3538 :month-start month-start
3539 :day-start day-start
3540 :hour-start hour-start
3541 :minute-start minute-start
3542 :year-end year-end
3543 :month-end month-end
3544 :day-end day-end
3545 :hour-end hour-end
3546 :minute-end minute-end
3547 :begin begin
3548 :end end
3550 repeater-props
3551 warning-props))))))
3554 "Interpret TIMESTAMP object as Org syntax.
3555 CONTENTS is nil."
3574 ;; Build an Org timestamp string from TIME. ACTIVEP is
3575 ;; non-nil when time stamp is active. If WITH-TIME-P is
3576 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3577 ;; specify a time range in the timestamp. REPEAT-STRING is
3578 ;; the repeater string, if any.
3582 org-time-stamp-formats)
3583 time)))
3589 nil nil ts)))
3594 " "
3595 s
3597 ;; Return value.
3598 ts)))
3610 build-ts-string
3629 0
3637 "--"
3650 ;;;; Underline
3653 "Parse underline object at point, if any.
3655 When at an underline object, return a list whose car is
3656 `underline' and cdr is a plist with `:begin', `:end',
3657 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3658 Otherwise, return nil.
3660 Assume point is at the first underscore marker."
3672 :end end
3673 :contents-begin contents-begin
3674 :contents-end contents-end
3678 "Interpret UNDERLINE object as Org syntax.
3679 CONTENTS is the contents of the object."
3683 ;;;; Verbatim
3686 "Parse verbatim object at point, if any.
3688 When at a verbatim object, return a list whose car is `verbatim'
3689 and cdr is a plist with `:value', `:begin', `:end' and
3690 `:post-blank' keywords. Otherwise, return nil.
3692 Assume point is at the first equal sign marker."
3703 :begin begin
3704 :end end
3708 "Interpret VERBATIM object as Org syntax.
3709 CONTENTS is nil."
3713 \f
3714 ;;; Parsing Element Starting At Point
3715 ;;
3716 ;; `org-element--current-element' is the core function of this section.
3717 ;; It returns the Lisp representation of the element starting at
3718 ;; point.
3719 ;;
3720 ;; `org-element--current-element' makes use of special modes. They
3721 ;; are activated for fixed element chaining (e.g., `plain-list' >
3722 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3723 ;; `section'). Special modes are: `first-section', `item',
3724 ;; `node-property', `section' and `table-row'.
3727 "Parse the element starting at point.
3729 Return value is a list like (TYPE PROPS) where TYPE is the type
3730 of the element and PROPS a plist of properties associated to the
3731 element.
3733 Possible types are defined in `org-element-all-elements'.
3735 LIMIT bounds the search.
3737 Optional argument GRANULARITY determines the depth of the
3738 recursion. Allowed values are `headline', `greater-element',
3739 `element', `object' or nil. When it is broader than `object' (or
3740 nil), secondary values will not be parsed, since they only
3741 contain objects.
3743 Optional argument MODE, when non-nil, can be either
3744 `first-section', `section', `planning', `item', `node-property'
3745 and `table-row'.
3747 If STRUCTURE isn't provided but MODE is set to `item', it will be
3748 computed.
3750 This function assumes point is always at the beginning of the
3751 element it has to parse."
3754 ;; Determine if parsing depth allows for secondary strings
3755 ;; parsing. It only applies to elements referenced in
3756 ;; `org-element-secondary-value-alist'.
3759 ;; Item.
3762 ;; Table Row.
3764 ;; Node Property.
3766 ;; Headline.
3769 ;; Sections (must be checked after headline).
3774 limit)))
3775 ;; Planning.
3778 ;; Property drawer.
3782 ;; When not at bol, point is at the beginning of an item or
3783 ;; a footnote definition: next item is always a paragraph.
3785 ;; Clock.
3787 ;; Inlinetask.
3790 ;; From there, elements can have affiliated keywords.
3793 ;; Jumping over affiliated keywords put point off-limits.
3794 ;; Parse them as regular keywords.
3798 ;; LaTeX Environment.
3801 ;; Drawer and Property Drawer.
3804 ;; Fixed Width
3807 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3808 ;; Keywords.
3817 org-element-block-name-alist)))
3832 ;; Footnote Definition.
3835 ;; Horizontal Rule.
3838 ;; Diary Sexp.
3841 ;; Table.
3844 ;; List.
3847 limit affiliated
3849 ;; Default element: Paragraph.
3853 ;; Most elements can have affiliated keywords. When looking for an
3854 ;; element beginning, we want to move before them, as they belong to
3855 ;; that element, and, in the meantime, collect information they give
3856 ;; into appropriate properties. Hence the following function.
3859 "Collect affiliated keywords from point down to LIMIT.
3861 Return a list whose CAR is the position at the first of them and
3862 CDR a plist of keywords and values and move point to the
3863 beginning of the first line after them.
3865 As a special case, if element doesn't start at the beginning of
3866 the line (e.g., a paragraph starting an item), CAR is current
3867 position of point and CDR is nil."
3871 ;; RESTRICT is the list of objects allowed in parsed
3872 ;; keywords value.
3874 output)
3877 ;; Apply translation to RAW-KWD. From there, KWD is
3878 ;; the official keyword.
3880 org-element-keyword-translation-alist))
3881 raw-kwd))
3882 ;; Find main value for any keyword.
3888 ;; PARSEDP is non-nil when keyword should have its
3889 ;; value parsed.
3891 ;; If KWD is a dual keyword, find its secondary
3892 ;; value. Maybe parse it.
3901 ;; Attribute a property name to KWD.
3903 ;; Now set final shape for VALUE.
3909 nil restrict)))
3913 ;; Attributes can always appear on multiple lines.
3916 ;; Eventually store the new value in OUTPUT.
3918 ;; Move to next keyword.
3920 ;; If affiliated keywords are orphaned: move back to first one.
3921 ;; They will be parsed as a paragraph.
3923 ;; Return value.
3927 \f
3928 ;;; The Org Parser
3929 ;;
3930 ;; The two major functions here are `org-element-parse-buffer', which
3931 ;; parses Org syntax inside the current buffer, taking into account
3932 ;; region, narrowing, or even visibility if specified, and
3933 ;; `org-element-parse-secondary-string', which parses objects within
3934 ;; a given string.
3935 ;;
3936 ;; The (almost) almighty `org-element-map' allows applying a function
3937 ;; on elements or objects matching some type, and accumulating the
3938 ;; resulting values. In an export situation, it also skips unneeded
3939 ;; parts of the parse tree.
3942 "Recursively parse the buffer and return structure.
3943 If narrowing is in effect, only parse the visible part of the
3944 buffer.
3946 Optional argument GRANULARITY determines the depth of the
3947 recursion. It can be set to the following symbols:
3949 `headline' Only parse headlines.
3950 `greater-element' Don't recurse into greater elements excepted
3951 headlines and sections. Thus, elements
3952 parsed are the top-level ones.
3953 `element' Parse everything but objects and plain text.
3954 `object' Parse the complete buffer (default).
3956 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3957 elements.
3959 An element or an objects is represented as a list with the
3960 pattern (TYPE PROPERTIES CONTENTS), where :
3962 TYPE is a symbol describing the element or object. See
3963 `org-element-all-elements' and `org-element-all-objects' for an
3964 exhaustive list of such symbols. One can retrieve it with
3965 `org-element-type' function.
3967 PROPERTIES is the list of attributes attached to the element or
3968 object, as a plist. Although most of them are specific to the
3969 element or object type, all types share `:begin', `:end',
3970 `:post-blank' and `:parent' properties, which respectively
3971 refer to buffer position where the element or object starts,
3972 ends, the number of white spaces or blank lines after it, and
3973 the element or object containing it. Properties values can be
3974 obtained by using `org-element-property' function.
3976 CONTENTS is a list of elements, objects or raw strings
3977 contained in the current element or object, when applicable.
3978 One can access them with `org-element-contents' function.
3980 The Org buffer has `org-data' as type and nil as properties.
3981 `org-element-map' function can be used to find specific elements
3982 or objects within the parse tree.
3984 This function assumes that current major mode is `org-mode'."
3990 ;; Start in `first-section' mode so text before the first
3991 ;; headline belongs to a section.
3995 "Recursively parse objects in STRING and return structure.
3997 RESTRICTION is a symbol limiting the object types that will be
3998 looked after.
4000 Optional argument PARENT, when non-nil, is the element or object
4001 containing the secondary string. It is used to set correctly
4002 `:parent' property within the string.
4004 If STRING is the empty string or nil, return nil."
4020 data))))))
4024 "Map a function on selected elements or objects.
4026 DATA is a parse tree, an element, an object, a string, or a list
4027 of such constructs. TYPES is a symbol or list of symbols of
4028 elements or objects types (see `org-element-all-elements' and
4029 `org-element-all-objects' for a complete list of types). FUN is
4030 the function called on the matching element or object. It has to
4031 accept one argument: the element or object itself.
4033 When optional argument INFO is non-nil, it should be a plist
4034 holding export options. In that case, parts of the parse tree
4035 not exportable according to that property list will be skipped.
4037 When optional argument FIRST-MATCH is non-nil, stop at the first
4038 match for which FUN doesn't return nil, and return that value.
4040 Optional argument NO-RECURSION is a symbol or a list of symbols
4041 representing elements or objects types. `org-element-map' won't
4042 enter any recursive element or object whose type belongs to that
4043 list. Though, FUN can still be applied on them.
4045 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4046 apply to matching objects within parsed affiliated keywords (see
4047 `org-element-parsed-keywords').
4049 Nil values returned from FUN do not appear in the results.
4052 Examples:
4053 ---------
4055 Assuming TREE is a variable containing an Org buffer parse tree,
4056 the following example will return a flat list of all `src-block'
4057 and `example-block' elements in it:
4061 The following snippet will find the first headline with a level
4065 (lambda (hl)
4066 (and (= (org-element-property :level hl) 1)
4068 (org-element-property :begin hl)))
4069 nil t)
4071 The next example will return a flat list of all `plain-list' type
4072 elements in TREE that are not a sub-list themselves:
4076 Eventually, this example will return a flat list of all `bold'
4077 type objects containing a `latex-snippet' type object, even
4078 looking into captions:
4081 (lambda (b)
4083 nil nil nil t)"
4084 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4088 ;; Recursion depth is determined by --CATEGORY.
4095 ;; If one object is found, the function has to
4096 ;; recurse into every object.
4099 ;; If one regular element is found, the
4100 ;; function has to recurse, at least, into
4101 ;; every element it encounters.
4104 --acc
4105 --walk-tree
4108 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4109 ;; holding contextual information.
4113 ;; Ignored element in an export context.
4115 ;; List of elements or objects.
4117 ;; Unconditionally enter parse trees.
4121 ;; Check if TYPE is matching among TYPES. If so,
4122 ;; apply FUN to --DATA and accumulate return value
4123 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4129 ;; If --DATA has a secondary string that can contain
4130 ;; objects with their type among TYPES, look into it.
4133 org-element-secondary-value-alist)))
4135 ;; If --DATA has any parsed affiliated keywords and
4136 ;; WITH-AFFILIATED is non-nil, look for objects in
4137 ;; them.
4144 ;; Pay attention to the type of parsed keyword.
4145 ;; In particular, preserve order for multiple
4146 ;; keywords.
4159 ;; Determine if a recursion into --DATA is possible.
4161 ;; --TYPE is explicitly removed from recursion.
4163 ;; --DATA has no contents.
4165 ;; Looking for greater elements but --DATA is simply
4166 ;; an element or an object.
4169 ;; Looking for elements but --DATA is an object.
4172 ;; In any other case, map contents.
4176 ;; Return value in a proper order.
4180 ;; The following functions are internal parts of the parser.
4181 ;;
4182 ;; The first one, `org-element--parse-elements' acts at the element's
4183 ;; level.
4184 ;;
4185 ;; The second one, `org-element--parse-objects' applies on all objects
4186 ;; of a paragraph or a secondary string. It calls
4187 ;; `org-element--object-lex' to find the next object in the current
4188 ;; container.
4191 "Return next special mode according to TYPE, or nil.
4192 TYPE is a symbol representing the type of an element or object
4193 containing next element if PARENTP is non-nil, or before it
4194 otherwise. Modes can be either `first-section', `item',
4195 `node-property', `planning', `property-drawer', `section',
4196 `table-row' or nil."
4213 "Parse elements between BEG and END positions.
4215 MODE prioritizes some elements over the others. It can be set to
4216 `first-section', `section', `planning', `item', `node-property'
4217 or `table-row'.
4219 When value is `item', STRUCTURE will be used as the current list
4220 structure.
4222 GRANULARITY determines the depth of the recursion. See
4223 `org-element-parse-buffer' for more information.
4225 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4226 elements.
4228 Elements are accumulated into ACC."
4231 ;; Visible only: skip invisible parts at the beginning of the
4232 ;; element.
4235 ;; When parsing only headlines, skip any text before first one.
4238 ;; Main loop start.
4240 ;; Find current element's type and parse it accordingly to
4241 ;; its category.
4243 end granularity mode structure))
4247 ;; Visible only: skip invisible parts between siblings.
4250 ;; Fill ELEMENT contents by side-effect.
4252 ;; If element has no contents, don't modify it.
4254 ;; Greater element: parse it between `contents-begin' and
4255 ;; `contents-end'. Make sure GRANULARITY allows the
4256 ;; recursion, or ELEMENT is a headline, in which case going
4257 ;; inside is mandatory, in order to get sub-level headings.
4265 ;; Possibly switch to a special mode.
4269 granularity visible-only element))
4270 ;; ELEMENT has contents. Parse objects inside, if
4271 ;; GRANULARITY allows it.
4277 ;; Update mode.
4279 ;; Return result.
4280 acc))
4283 "Return next object in current buffer or nil.
4284 RESTRICTION is a list of object types, as symbols, that should be
4285 looked after. This function assumes that the buffer is narrowed
4286 to an appropriate container (e.g., a paragraph)."
4294 found)
4359 ;; This is probably a plain link.
4365 ;; Radio link.
4370 "Parse objects between BEG and END and return recursive structure.
4372 Objects are accumulated in ACC.
4374 RESTRICTION is a list of object successors which are allowed in
4375 the current object."
4383 ;; 1. Text before any object. Untabify it.
4388 acc
4392 ;; 2. Object...
4395 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4396 ;; a recursive type.
4404 ;; 3. Text after last object. Untabify it.
4408 acc
4412 ;; Result.
4413 acc)))
4416 \f
4417 ;;; Towards A Bijective Process
4418 ;;
4419 ;; The parse tree obtained with `org-element-parse-buffer' is really
4420 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4421 ;; interpreted and expanded into a string with canonical Org syntax.
4422 ;; Hence `org-element-interpret-data'.
4423 ;;
4424 ;; The function relies internally on
4425 ;; `org-element--interpret-affiliated-keywords'.
4427 ;;;###autoload
4429 "Interpret DATA as Org syntax.
4430 DATA is a parse tree, an element, an object or a secondary string
4431 to interpret. Return Org syntax as a string."
4435 "Interpret DATA as Org syntax.
4437 DATA is a parse tree, an element, an object or a secondary string
4438 to interpret. PARENT is used for recursive calls. It contains
4439 the element or object containing data, or nil.
4441 Return Org syntax as a string."
4443 ;; Find interpreter for current object or element. If it
4444 ;; doesn't exist (e.g. this is a pseudo object or element),
4445 ;; return contents, if any.
4451 ;; Secondary string.
4455 ;; Full Org document.
4459 ;; Plain text: return it.
4461 ;; Element or object without contents.
4463 ;; Element or object with contents.
4466 ;; Recursively interpret contents.
4471 data
4472 ;; Fix indentation of elements containing
4473 ;; objects. We ignore `table-row' elements
4474 ;; as they are one line long anyway.
4476 data
4477 ;; When normalizing first paragraph of an
4478 ;; item or a footnote-definition, ignore
4479 ;; first line's indentation.
4486 ;; Build white spaces. If no `:post-blank' property is
4487 ;; specified, assume its value is 0.
4501 "Return ELEMENT's affiliated keywords as Org syntax.
4502 If there is no affiliated keyword, return the empty string."
4512 ": "
4515 value)
4523 ;; All attribute keywords can have multiple lines.
4529 ;; List all ELEMENT's properties matching an attribute line or an
4530 ;; affiliated keyword, but ignore translated keywords since they
4531 ;; cannot belong to the property list.
4538 org-element-keyword-translation-alist)))))
4539 collect prop)
4542 ;; Because interpretation of the parse tree must return the same
4543 ;; number of blank lines between elements and the same number of white
4544 ;; space after objects, some special care must be given to white
4545 ;; spaces.
4546 ;;
4547 ;; The first function, `org-element-normalize-string', ensures any
4548 ;; string different from the empty string will end with a single
4549 ;; newline character.
4550 ;;
4551 ;; The second function, `org-element-normalize-contents', removes
4552 ;; global indentation from the contents of the current element.
4555 "Ensure string S ends with a single newline character.
4557 If S isn't a string return it unchanged. If S is the empty
4558 string, return it. Otherwise, return a new string with a single
4559 newline character at its end."
4567 "Normalize plain text in ELEMENT's contents.
4569 ELEMENT must only contain plain text and objects.
4571 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4572 indentation to compute maximal common indentation.
4574 Return the normalized element that is element with global
4575 indentation removed from its contents. The function assumes that
4576 indentation is not done with TAB characters."
4578 find-min-ind ; For byte-compiler.
4580 ;; Return minimal common indentation within BLOB. This is
4581 ;; done by walking recursively BLOB and updating MIN-IND
4582 ;; along the way. FIRST-FLAG is non-nil when the next
4583 ;; object is expected to be a string that doesn't start with
4584 ;; a newline character. It happens for strings at the
4585 ;; beginnings of the contents or right after a line break.
4590 ;; Objects cannot start with spaces: in this case,
4591 ;; indentation is 0.
4595 ;; An indentation of zero means no string will be
4596 ;; modified. Quit the process.
4607 ;; Find minimal indentation in ELEMENT.
4610 ;; Build ELEMENT back, replacing each string with the same
4611 ;; string minus common indentation.
4615 ;; Return BLOB with all its strings indentation
4616 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4617 ;; non-nil when the next object is expected to be
4618 ;; a string that doesn't start with a newline
4619 ;; character.
4635 org-element-recursive-objects)
4639 object)
4642 blob)))
4646 \f
4647 ;;; Cache
4648 ;;
4649 ;; Implement a caching mechanism for `org-element-at-point' and
4650 ;; `org-element-context', which see.
4651 ;;
4652 ;; A single public function is provided: `org-element-cache-reset'.
4653 ;;
4654 ;; Cache is enabled by default, but can be disabled globally with
4655 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4656 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4657 ;; can be tweaked to control caching behaviour.
4658 ;;
4659 ;; Internally, parsed elements are stored in an AVL tree,
4660 ;; `org-element--cache'. This tree is updated lazily: whenever
4661 ;; a change happens to the buffer, a synchronization request is
4662 ;; registered in `org-element--cache-sync-requests' (see
4663 ;; `org-element--cache-submit-request'). During idle time, requests
4664 ;; are processed by `org-element--cache-sync'. Synchronization also
4665 ;; happens when an element is required from the cache. In this case,
4666 ;; the process stops as soon as the needed element is up-to-date.
4667 ;;
4668 ;; A synchronization request can only apply on a synchronized part of
4669 ;; the cache. Therefore, the cache is updated at least to the
4670 ;; location where the new request applies. Thus, requests are ordered
4671 ;; from left to right and all elements starting before the first
4672 ;; request are correct. This property is used by functions like
4673 ;; `org-element--cache-find' to retrieve elements in the part of the
4674 ;; cache that can be trusted.
4675 ;;
4676 ;; A request applies to every element, starting from its original
4677 ;; location (or key, see below). When a request is processed, it
4678 ;; moves forward and may collide the next one. In this case, both
4679 ;; requests are merged into a new one that starts from that element.
4680 ;; As a consequence, the whole synchronization complexity does not
4681 ;; depend on the number of pending requests, but on the number of
4682 ;; elements the very first request will be applied on.
4683 ;;
4684 ;; Elements cannot be accessed through their beginning position, which
4685 ;; may or may not be up-to-date. Instead, each element in the tree is
4686 ;; associated to a key, obtained with `org-element--cache-key'. This
4687 ;; mechanism is robust enough to preserve total order among elements
4688 ;; even when the tree is only partially synchronized.
4689 ;;
4690 ;; Objects contained in an element are stored in a hash table,
4691 ;; `org-element--cache-objects'.
4695 "Non nil when Org parser should cache its results.
4702 "Maximum duration, as a time value, for a cache synchronization.
4703 If the synchronization is not over after this delay, the process
4704 pauses and resumes after `org-element-cache-sync-break'
4708 "Duration, as a time value, of the pause between synchronizations.
4712 ;;;; Data Structure
4715 "AVL tree used to cache elements.
4716 Each node of the tree contains an element. Comparison is done
4717 with `org-element--cache-compare'. This cache is used in
4721 "Hash table used as to cache objects.
4722 Key is an element, as returned by `org-element-at-point', and
4723 value is an alist where each association is:
4725 \(PARENT COMPLETEP . OBJECTS)
4727 where PARENT is an element or object, COMPLETEP is a boolean,
4728 non-nil when all direct children of parent are already cached and
4729 OBJECTS is a list of such children, as objects, from farthest to
4730 closest.
4733 contained within a paragraph
4737 If the paragraph is completely parsed, OBJECTS-DATA will be
4739 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4740 \(BOLD-OBJECT t ENTITY-OBJECT))
4742 whereas in a partially parsed paragraph, it could be
4744 \((PARAGRAPH nil ENTITY-OBJECT))
4749 "List of pending synchronization requests.
4751 A request is a vector with the following pattern:
4753 \[NEXT BEG END OFFSET PARENT PHASE]
4755 Processing a synchronization request consists of three phases:
4757 0. Delete modified elements,
4758 1. Fill missing area in cache,
4759 2. Shift positions and re-parent elements after the changes.
4761 During phase 0, NEXT is the key of the first element to be
4762 removed, BEG and END is buffer position delimiting the
4763 modifications. Elements starting between them (inclusive) are
4764 removed. So are elements whose parent is removed. PARENT, when
4765 non-nil, is the parent of the first element to be removed.
4767 During phase 1, NEXT is the key of the next known element in
4768 cache and BEG its beginning position. Parse buffer between that
4769 element and the one before it in order to determine the parent of
4770 the next element. Set PARENT to the element containing NEXT.
4772 During phase 2, NEXT is the key of the next element to shift in
4773 the parse tree. All elements starting from this one have their
4774 properties relatives to buffer positions shifted by integer
4775 OFFSET and, if they belong to element PARENT, are adopted by it.
4783 "Hash table used to store keys during synchronization.
4787 "Return a unique key for ELEMENT in cache tree.
4789 Keys are used to keep a total order among elements in the cache.
4790 Comparison is done with `org-element--cache-key-less-p'.
4792 When no synchronization is taking place, a key is simply the
4793 beginning position of the element, or that position plus one in
4794 the case of an first item (respectively row) in
4795 a list (respectively a table).
4797 During a synchronization, the key is the one the element had when
4798 the cache was synchronized for the last time. Elements added to
4799 cache during the synchronization get a new key generated with
4800 `org-element--cache-generate-key'.
4802 Such keys are stored in `org-element--cache-sync-keys'. The hash
4803 table is cleared once the synchronization is complete."
4806 ;; Increase beginning position of items (respectively
4807 ;; table rows) by one, so the first item can get
4808 ;; a different key from its parent list (respectively
4809 ;; table).
4812 begin)))
4815 key))))
4818 "Generate a key between LOWER and UPPER.
4820 LOWER and UPPER are integers or lists, possibly empty.
4822 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4823 a unique key, as an integer or a list of integers, according to
4824 the following rules:
4826 - LOWER and UPPER are compared level-wise until values differ.
4828 - If, at a given level, LOWER and UPPER differ from more than
4829 2, the new key shares all the levels above with LOWER and
4830 gets a new level. Its value is the mean between LOWER and
4831 UPPER:
4833 \(1 2) + (1 4) --> (1 3)
4835 - If LOWER has no value to compare with, it is assumed that its
4836 value is `most-negative-fixnum'. E.g.,
4838 \(1 1) + (1 1 2)
4840 is equivalent to
4842 \(1 1 m) + (1 1 2)
4844 where m is `most-negative-fixnum'. Likewise, if UPPER is
4845 short of levels, the current value is `most-positive-fixnum'.
4847 - If they differ from only one, the new key inherits from
4848 current LOWER level and fork it at the next level. E.g.,
4850 \(2 1) + (3 3)
4852 is equivalent to
4854 \(2 1) + (2 M)
4856 where M is `most-positive-fixnum'.
4858 - If the key is only one level long, it is returned as an
4859 integer:
4861 \(1 2) + (3 2) --> 2
4863 When they are not equals, the function assumes that LOWER is
4864 lesser than UPPER, per `org-element--cache-key-less-p'."
4868 skip-upper key)
4879 ;; When at a given level, LOWER and UPPER differ from
4880 ;; 1, ignore UPPER altogether. Instead create a key
4881 ;; between LOWER and the greatest key with the same
4882 ;; prefix as LOWER so far.
4888 "Non-nil if key A is less than key B.
4889 A and B are either integers or lists of integers, as returned by
4890 `org-element--cache-key'."
4898 ;; If A is empty, either keys are equal (B is also empty) and
4899 ;; we return nil, or A is lesser than B (B is longer) and we
4900 ;; return a non-nil value.
4901 ;;
4902 ;; If A is not empty, B is necessarily empty and A is greater
4903 ;; than B (A is longer). Therefore, return nil.
4907 "Non-nil when element A is located before element B."
4912 "Return root value in cache.
4913 This function assumes `org-element--cache' is a valid AVL tree."
4917 ;;;; Tools
4920 "Non-nil when cache is active in current buffer."
4922 org-element--cache
4926 "Find element in cache starting at POS or before.
4928 POS refers to a buffer position.
4930 When optional argument SIDE is non-nil, the function checks for
4931 elements starting at or past POS instead. If SIDE is `both', the
4932 function returns a cons cell where car is the first element
4933 starting at or before POS and cdr the first element starting
4934 after POS.
4936 The function can only find elements in the synchronized part of
4937 the cache."
4941 lower upper)
4956 ;; We found an element in cache starting at POS. If `side'
4957 ;; is `both' we also want the next one in order to generate
4958 ;; a key in-between.
4959 ;;
4960 ;; If the element is the first row or item in a table or
4961 ;; a plain list, we always return the table or the plain
4962 ;; list.
4963 ;;
4964 ;; In any other case, we return the element found.
4973 lower parent
4974 upper parent)))))
4977 lower element
4978 upper element)))))
4985 "Store ELEMENT in current buffer's cache, if allowed.
4986 When optional argument DATA is non-nil, assume is it object data
4987 relative to ELEMENT and store it in the objects cache."
4991 ;; During synchronization, first build an appropriate key
4992 ;; for the new element so `avl-tree-enter' can insert it at
4993 ;; the right spot in the cache.
5002 org-element--cache-sync-keys)))
5004 ;; Headlines are not stored in cache, so objects in titles are
5005 ;; not stored either.
5010 "Remove ELEMENT from cache.
5011 Assume ELEMENT belongs to cache and that a cache is active."
5016 ;;;; Synchronization
5019 "Set idle timer for cache synchronization in BUFFER."
5026 org-element-cache-sync-idle-time))
5027 nil
5028 #'org-element--cache-sync
5029 buffer)))
5032 "Non-nil when synchronization process should be interrupted.
5033 TIME-LIMIT is a time value or nil."
5039 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5041 Properties containing buffer positions are `:begin', `:end',
5042 `:contents-begin', `:contents-end' and `:structure'. When
5043 optional argument PROPS is a list of keywords, only shift
5044 properties provided in that list.
5046 Properties are modified by side-effect."
5048 ;; Shift `:structure' property for the first plain list only: it
5049 ;; is the only one that really matters and it prevents from
5050 ;; shifting it more than once.
5064 "Synchronize cache with recent modification in BUFFER.
5066 When optional argument THRESHOLD is non-nil, do the
5067 synchronization for all elements starting before or at threshold,
5068 then exit. Otherwise, synchronize cache for as long as
5069 `org-element-cache-sync-duration' or until Emacs leaves idle
5070 state.
5072 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5073 not registered yet in the cache are going to happen. It is used
5074 in `org-element--cache-submit-request', where cache is partially
5075 updated before current modification are actually submitted."
5086 request
5088 threshold
5091 org-element-cache-sync-duration))
5092 future-change)
5093 ;; Request processed. Merge current and next offsets and
5094 ;; transfer ending position.
5100 ;; If more requests are awaiting, set idle timer accordingly.
5101 ;; Otherwise, reset keys.
5108 "Process synchronization REQUEST for all entries before NEXT.
5110 REQUEST is a vector, built by `org-element--cache-submit-request'.
5112 NEXT is a cache key, as returned by `org-element--cache-key'.
5114 When non-nil, THRESHOLD is a buffer position. Synchronization
5115 stops as soon as a shifted element begins after it.
5117 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5118 after this time or when Emacs exits idle state.
5120 When non-nil, FUTURE-CHANGE is a buffer position where changes
5121 not registered yet in the cache are going to happen. See
5122 `org-element--cache-submit-request' for more information.
5124 Throw `interrupt' if the process stops before completing the
5125 request."
5128 ;; Phase 0.
5129 ;;
5130 ;; Delete all elements starting after BEG, but not after buffer
5131 ;; position END or past element with key NEXT. Also delete
5132 ;; elements contained within a previously removed element
5133 ;; (stored in `last-container').
5134 ;;
5135 ;; At each iteration, we start again at tree root since
5136 ;; a deletion modifies structure of the balanced tree.
5141 ;; Find first element in cache with key BEG or after it.
5145 data data-key last-container)
5154 data-key key
5157 data-key key
5158 node nil)))))
5168 up)))
5171 end))
5178 ;; No element starting after modifications left in
5179 ;; cache: further processing is futile.
5182 ;; Phase 1.
5183 ;;
5184 ;; Phase 0 left a hole in the cache. Some elements after it
5185 ;; could have parents within. For example, in the following
5186 ;; buffer:
5187 ;;
5188 ;; - item
5189 ;;
5190 ;;
5191 ;; Paragraph1
5192 ;;
5193 ;; Paragraph2
5194 ;;
5195 ;; if we remove a blank line between "item" and "Paragraph1",
5196 ;; everything down to "Paragraph2" is removed from cache. But
5197 ;; the paragraph now belongs to the list, and its `:parent'
5198 ;; property no longer is accurate.
5199 ;;
5200 ;; Therefore we need to parse again elements in the hole, or at
5201 ;; least in its last section, so that we can re-parent
5202 ;; subsequent elements, during phase 2.
5203 ;;
5204 ;; Note that we only need to get the parent from the first
5205 ;; element in cache after the hole.
5206 ;;
5207 ;; When next key is lesser or equal to the current one, delegate
5208 ;; phase 1 processing to next request in order to preserve key
5209 ;; order among requests.
5217 ;; Next element will start at its beginning position plus
5218 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5219 ;; contains the real beginning position of the first element to
5220 ;; shift and re-parent.
5224 ;; Changes are going to happen around this element and
5225 ;; they will trigger another phase 1 request. Skip the
5226 ;; current one.
5232 ;; Phase 2.
5233 ;;
5234 ;; Shift all elements starting from key START, but before NEXT, by
5235 ;; OFFSET, and re-parent them when appropriate.
5236 ;;
5237 ;; Elements are modified by side-effect so the tree structure
5238 ;; remains intact.
5239 ;;
5240 ;; Once THRESHOLD, if any, is reached, or once there is an input
5241 ;; pending, exit. Before leaving, the current synchronization
5242 ;; request is updated.
5249 exit-flag)
5250 ;; No re-parenting nor shifting planned: request is over.
5260 ;; We reached NEXT. Request is complete.
5262 ;; Handle interruption request. Update current request.
5267 ;; Shift element.
5270 ;; Shift associated objects data, if any.
5275 ;; Update PARENT and re-parent DATA, only when
5276 ;; necessary. Propagate new structures for lists.
5290 ;; Cache is up-to-date past THRESHOLD. Request
5291 ;; interruption.
5296 ;; We reached end of tree: synchronization complete.
5297 t)))
5300 "Parse elements in current section, down to POS.
5302 Start parsing from the closest between the last known element in
5303 cache or headline above. Return the smallest element containing
5304 POS.
5306 When optional argument SYNCP is non-nil, return the parent of the
5307 element containing POS instead. In that case, it is also
5308 possible to provide TIME-LIMIT, which is a time value specifying
5309 when the parsing should stop. The function throws `interrupt' if
5310 the process stopped before finding the expected result."
5317 element next mode)
5319 ;; Nothing in cache before point: start parsing from first
5320 ;; element following headline above, or first element in
5321 ;; buffer.
5328 ;; Cache returned exact match: return it.
5331 ;; There's a headline between cached value and POS: cached
5332 ;; value is invalid. Start parsing from first element
5333 ;; following the headline.
5340 ;; Check if CACHED or any of its ancestors contain point.
5341 ;;
5342 ;; If there is such an element, we inspect it in order to know
5343 ;; if we return it or if we need to parse its contents.
5344 ;; Otherwise, we just start parsing from current location,
5345 ;; which is right after the top-most element containing
5346 ;; CACHED.
5347 ;;
5348 ;; As a special case, if POS is at the end of the buffer, we
5349 ;; want to return the innermost element ending there.
5350 ;;
5351 ;; Also, if we find an ancestor and discover that we need to
5352 ;; parse its contents, make sure we don't start from
5353 ;; `:contents-begin', as we would otherwise go past CACHED
5354 ;; again. Instead, in that situation, we will resume parsing
5355 ;; from NEXT, which is located after CACHED or its higher
5356 ;; ancestor not containing point.
5368 ;; Parse successively each element until we reach POS.
5381 end 'element mode
5388 ;; Skip any element ending before point. Also skip
5389 ;; element ending at point (unless it is also the end of
5390 ;; buffer) since we're sure that another element begins
5391 ;; after it.
5395 ;; A non-greater element contains point: return it.
5398 ;; Otherwise, we have to decide if ELEMENT really
5399 ;; contains POS. In that case we start parsing from
5400 ;; contents' beginning.
5401 ;;
5402 ;; If POS is at contents' beginning but it is also at
5403 ;; the beginning of the first item in a list or a table.
5404 ;; In that case, we need to create an anchor for that
5405 ;; list or table, so return it.
5406 ;;
5407 ;; Also, if POS is at the end of the buffer, no element
5408 ;; can start after it, but more than one may end there.
5409 ;; Arbitrarily, we choose to return the innermost of
5410 ;; such elements.
5423 parent element
5424 end cend))))
5425 ;; Otherwise, return ELEMENT as it is the smallest
5426 ;; element containing POS.
5431 ;;;; Staging Buffer Changes
5442 "Regexp matching a sensitive line, structure wise.
5443 A sensitive line is a headline, inlinetask, block, drawer, or
5444 latex-environment boundary. When such a line is modified,
5445 structure changes in the document may propagate in the whole
5449 "Non-nil when a sensitive line is about to be changed.
5453 "Request extension of area going to be modified if needed.
5454 BEG and END are the beginning and end of the range of changed
5455 text. See `before-change-functions' for more information."
5465 'headline
5468 org-element--cache-sensitive-re bottom t)))))))))
5471 "Update buffer modifications for current buffer.
5472 BEG and END are the beginning and end of the range of changed
5473 text, and the length in bytes of the pre-change text replaced by
5474 that range. See `after-change-functions' for more information."
5482 ;; Determine if modified area needs to be extended, according
5483 ;; to both previous and current state. We make a special
5484 ;; case for headline editing: if a headline is modified but
5485 ;; not removed, do not extend.
5494 org-element--cache-sensitive-re bottom t))))
5495 ;; Effectively extend modified area.
5503 ;; Store synchronization request.
5506 ;; Activate a timer to process the request during idle time.
5510 "Return first element to remove from cache.
5512 BEG and END are buffer positions delimiting buffer modifications.
5513 OFFSET is the size of the changes.
5515 Returned element is usually the first element in cache containing
5516 any position between BEG and END. As an exception, greater
5517 elements around the changes that are robust to contents
5518 modifications are preserved and updated according to the
5519 changes."
5529 special-block))
5530 ;; Drawers named "PROPERTIES" are probably
5531 ;; a properties drawer being edited. Force
5532 ;; parsing to check if editing is over.
5541 ;; UP is a robust greater element containing changes.
5542 ;; We only need to extend its ending boundaries.
5548 ;; We're at top level element containing ELEMENT: if it's
5549 ;; altered by buffer modifications, it is first element in
5550 ;; cache to be removed. Otherwise, that first element is the
5551 ;; following one.
5552 ;;
5553 ;; As a special case, do not remove BEFORE if it is a robust
5554 ;; container for current changes.
5556 before)))))
5559 "Submit a new cache synchronization request for current buffer.
5560 BEG and END are buffer positions delimiting the minimal area
5561 where cache data should be removed. OFFSET is the size of the
5562 change, as an integer."
5564 delete-to delete-from)
5569 ;; Current changes can be merged with first sync request: we
5570 ;; can save a partial cache synchronization.
5573 ;; If last change happened within area to be removed, extend
5574 ;; boundaries of robust parents, if any. Otherwise, find
5575 ;; first element to remove and update request accordingly.
5587 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5588 ;; if any, is no longer a 0-phase request, thus ensuring that
5589 ;; phases are properly ordered. We need to provide OFFSET as
5590 ;; optional parameter since current modifications are not known
5591 ;; yet to the otherwise correct part of the cache (i.e, before
5592 ;; the first request).
5599 ;; When changes happen before the first known
5600 ;; element, re-parent and shift the rest of the
5601 ;; cache.
5603 ;; Otherwise, we find the first non robust
5604 ;; element containing END. All elements between
5605 ;; FIRST and this one are to be removed.
5616 element up))
5618 org-element--cache-sync-requests)
5619 ;; No element to remove. No need to re-parent either.
5620 ;; Simply shift additional elements, if any, by OFFSET.
5625 ;;;; Public Functions
5627 ;;;###autoload
5629 "Reset cache in current buffer.
5630 When optional argument ALL is non-nil, reset cache in all Org
5631 buffers."
5649 ;;;###autoload
5651 "Refresh cache at position POS."
5658 \f
5659 ;;; The Toolbox
5660 ;;
5661 ;; The first move is to implement a way to obtain the smallest element
5662 ;; containing point. This is the job of `org-element-at-point'. It
5663 ;; basically jumps back to the beginning of section containing point
5664 ;; and proceed, one element after the other, with
5665 ;; `org-element--current-element' until the container is found. Note:
5666 ;; When using `org-element-at-point', secondary values are never
5667 ;; parsed since the function focuses on elements, not on objects.
5668 ;;
5669 ;; At a deeper level, `org-element-context' lists all elements and
5670 ;; objects containing point.
5671 ;;
5672 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5673 ;; internally by navigation and manipulation tools.
5676 ;;;###autoload
5678 "Determine closest element around point.
5680 Return value is a list like (TYPE PROPS) where TYPE is the type
5681 of the element and PROPS a plist of properties associated to the
5682 element.
5684 Possible types are defined in `org-element-all-elements'.
5685 Properties depend on element or object type, but always include
5686 `:begin', `:end', `:parent' and `:post-blank' properties.
5688 As a special case, if point is at the very beginning of the first
5689 item in a list or sub-list, returned element will be that list
5690 instead of the item. Likewise, if point is at the beginning of
5691 the first row of a table, returned element will be the table
5692 instead of the first row.
5694 When point is at the end of the buffer, return the innermost
5695 element ending there."
5701 ;; Within blank lines at the beginning of buffer, return nil.
5703 ;; Within blank lines right after a headline, return that
5704 ;; headline.
5708 ;; Otherwise parse until we find element containing ORIGIN.
5715 ;;;###autoload
5717 "Return smallest element or object around point.
5719 Return value is a list like (TYPE PROPS) where TYPE is the type
5720 of the element or object and PROPS a plist of properties
5721 associated to it.
5723 Possible types are defined in `org-element-all-elements' and
5724 `org-element-all-objects'. Properties depend on element or
5725 object type, but always include `:begin', `:end', `:parent' and
5726 `:post-blank'.
5728 As a special case, if point is right after an object and not at
5729 the beginning of any other object, return that object.
5731 Optional argument ELEMENT, when non-nil, is the closest element
5732 containing point, as returned by `org-element-at-point'.
5733 Providing it allows for quicker computation."
5740 ;; If point is inside an element containing objects or
5741 ;; a secondary string, narrow buffer to the container and
5742 ;; proceed with parsing. Otherwise, return ELEMENT.
5744 ;; At a parsed affiliated keyword, check if we're inside main
5745 ;; or dual value.
5751 org-element-parsed-keywords))
5760 ;; Also change type to retrieve correct restrictions.
5762 ;; At an item, objects can only be located within tag, if any.
5773 ;; At an headline or inlinetask, objects are in title.
5784 ;; At a paragraph, a table-row or a verse block, objects are
5785 ;; located within their contents.
5789 ;; CBEG is nil for table rules.
5794 ;; At a planning line, if point is at a timestamp, return it,
5795 ;; otherwise, return element.
5803 ;; All other locations cannot contain objects: bail out.
5813 next object-data last)
5817 ;; When entering PARENT for the first time, get list
5818 ;; of objects within known so far. Store it in
5819 ;; OBJECT-DATA.
5824 ;; Find NEXT object for analysis.
5826 ;; If NEXT is non-nil, we already exhausted the
5827 ;; cache so we can parse buffer to find the object
5828 ;; after it.
5830 ;; Otherwise, check if cache can help us.
5841 ;; Cache contains the information needed.
5844 pos)
5846 pos)
5852 ;; If we have a new object to analyze, store it in
5853 ;; cache. Otherwise record that there is nothing
5854 ;; more to parse in this element at this depth.
5859 ;; Process NEXT, if any, in order to know if we need
5860 ;; to skip it, return it or move into it.
5867 ;; Skip objects ending before point. Also skip
5868 ;; objects ending at point unless it is also the
5869 ;; end of buffer, since we want to return the
5870 ;; innermost object.
5873 ;; For convenience, when object ends at POS,
5874 ;; without any space, store it in LAST, as we
5875 ;; will return it if no object starts here.
5879 ;; If POS is within a container object, move
5880 ;; into that object.
5884 ;; At contents' end, if there is no
5885 ;; space before point, also move into
5886 ;; object, for consistency with
5887 ;; convenience feature above.
5896 next nil
5897 object-data nil))
5898 ;; Otherwise, return NEXT.
5900 ;; Store results in cache, if applicable.
5904 "List all ancestors of a given element or object.
5906 BLOB is an object or element.
5908 When optional argument TYPES is a list of symbols, return the
5909 first element or object in the lineage whose type belongs to that
5910 list.
5912 When optional argument WITH-SELF is non-nil, lineage includes
5913 BLOB itself as the first element, and TYPES, if provided, also
5914 apply to it.
5916 When BLOB is obtained through `org-element-context' or
5917 `org-element-at-point', only ancestors from its section can be
5918 found. There is no such limitation when BLOB belongs to a full
5919 parse tree."
5921 ancestors)
5928 "Non-nil when elements ELEM-A and ELEM-B are nested."
5937 "Swap elements ELEM-A and ELEM-B.
5938 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5939 end of ELEM-A."
5941 ;; There are two special cases when an element doesn't start at bol:
5942 ;; the first paragraph in an item or in a footnote definition.
5944 ;; Only a paragraph without any affiliated keyword can be moved at
5945 ;; ELEM-A position in such a situation. Note that the case of
5946 ;; a footnote definition is impossible: it cannot contain two
5947 ;; paragraphs in a row because it cannot contain a blank line.
5953 ;; In a special situation, ELEM-A will have no indentation. We'll
5954 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5968 ;; Store inner overlays responsible for visibility status.
5969 ;; We also need to store their boundaries as they will be
5970 ;; removed from buffer.
5985 ;; Get contents.
5993 ;; Restore ex ELEM-A overlays.
6000 ;; Restore ex ELEM-B overlays.
6006 "Remove maximum common indentation in string S and return it.
6007 When optional argument N is a positive integer, remove exactly
6008 that much characters from indentation, if possible, or return
6009 S as-is otherwise. Unlike to `org-remove-indentation', this
6010 function doesn't call `untabify' on S."
6015 ;; Find maximum common indentation, if not specified.
6023 min-ind)))
6025 ;; Remove exactly N indentation, but give up if not possible.
6038 ;; Local variables:
6039 ;; generated-autoload-file: "org-loaddefs.el"
6040 ;; End:
6042 ;;; org-element.el ends here