| blob | 8f2d7a42edb593b35bbf6eb0eee2ab845609ce98 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
162 ;; Blocks (any type), Babel calls and keywords. This
163 ;; is only an indication and need some thorough check.
165 ;; Drawers (any type) and fixed-width areas. This is
166 ;; also only an indication.
168 ;; Horizontal rules.
170 ;; LaTeX environments.
172 ;; Clock lines.
174 ;; Lists.
181 org-element--object-regexp
185 ;; Sub/superscript.
187 ;; Bold, code, italic, strike-through, underline
188 ;; and verbatim.
192 ;; Plain links.
194 ;; Objects starting with "[": regular link,
195 ;; footnote reference, statistics cookie,
196 ;; timestamp (inactive).
198 ;; Objects starting with "@": export snippets.
199 "@@"
200 ;; Objects starting with "{": macro.
201 "{{{"
202 ;; Objects starting with "<" : timestamp
203 ;; (active, diary), target, radio target and
204 ;; angular links.
206 ;; Objects starting with "$": latex fragment.
208 ;; Objects starting with "\": line break,
209 ;; entity, latex fragment.
211 ;; Objects starting with raw text: inline Babel
212 ;; source block, inline Babel call.
218 ;;;###autoload
220 "Update parser internals."
227 dynamic-block example-block export-block fixed-width
228 footnote-definition headline horizontal-rule inlinetask item
229 keyword latex-environment node-property paragraph plain-list
230 planning property-drawer quote-block section
231 special-block src-block table table-row verse-block)
236 item plain-list property-drawer quote-block section
237 special-block table)
242 inline-src-block italic line-break latex-fragment link macro
243 radio-target statistics-cookie strike-through subscript superscript
244 table-cell target timestamp underline verbatim)
249 superscript table-cell underline)
263 "Alist between block names and the associated parsing function.
264 Names must be uppercase. Any block whose name has no association
270 "List of affiliated keywords as strings.
278 "Alist of usual translations for keywords.
279 The key is the old name and the value the new one. The property
283 "List of affiliated keywords that can occur more than once in an element.
285 Their value will be consed into a list of strings, which will be
286 returned as the value of the property.
288 This list is checked after translations have been applied. See
289 `org-element-keyword-translation-alist'.
295 "List of affiliated keywords whose value can be parsed.
297 Their value will be stored as a secondary string: a list of
298 strings and objects.
300 This list is checked after translations have been applied. See
305 org-element-parsed-keywords)
306 "Alist of parsed keywords and associated properties.
307 This is generated from `org-element-parsed-keywords', which
311 "List of affiliated keywords which can have a secondary value.
313 In Org syntax, they can be written with optional square brackets
314 before the colons. For example, RESULTS keyword can be
315 associated to a hash value with the following:
317 #+RESULTS[hash-string]: some-source
319 This list is checked after translations have been applied. See
323 "List of properties associated to the whole document.
324 Any keyword in this list will have its value parsed and stored as
330 ;; Dual affiliated keywords.
334 ;; Regular affiliated keywords.
340 org-element-affiliated-keywords)))
342 ;; Export attributes.
344 "Regexp matching any affiliated keyword.
346 Keyword name is put in match group 1. Moreover, if keyword
347 belongs to `org-element-dual-keywords', put the dual value in
348 match group 2.
362 ;; Ignore all links excepted plain links in a link description.
363 ;; Also ignore radio-targets and line breaks.
365 italic latex-fragment macro plain-link statistics-cookie
366 strike-through subscript superscript underline verbatim)
368 ;; Remove any variable object from radio target as it would
369 ;; prevent it from being properly recognized.
371 subscript superscript underline superscript)
375 ;; Ignore inline babel call and inline src block as formulas are
376 ;; possible. Also ignore line breaks and statistics cookies.
378 latex-fragment link macro radio-target strike-through
379 subscript superscript target timestamp underline verbatim)
383 "Alist of objects restrictions.
385 key is an element or object type containing objects and value is
386 a list of types that can be contained within an element or object
387 of such type.
389 For example, in a `radio-target' object, one can only find
390 entities, latex-fragments, subscript, superscript and text
391 markup.
393 This alist also applies to secondary string. For example, an
394 `headline' type element doesn't directly contain objects, but
404 \f
405 ;;; Accessors and Setters
406 ;;
407 ;; Provide four accessors: `org-element-type', `org-element-property'
408 ;; `org-element-contents' and `org-element-restriction'.
409 ;;
410 ;; Setter functions allow to modify elements by side effect. There is
411 ;; `org-element-put-property', `org-element-set-contents'. These
412 ;; low-level functions are useful to build a parse tree.
413 ;;
414 ;; `org-element-adopt-element', `org-element-set-element',
415 ;; `org-element-extract-element' and `org-element-insert-before' are
416 ;; high-level functions useful to modify a parse tree.
417 ;;
418 ;; `org-element-secondary-p' is a predicate used to know if a given
419 ;; object belongs to a secondary string. `org-element-copy' returns
420 ;; an element or object, stripping its parent property in the process.
423 "Return type of ELEMENT.
425 The function returns the type of the element or object provided.
426 It can also return the following special value:
427 `plain-text' for a string
428 `org-data' for a complete document
429 nil in any other case."
435 "Extract the value from the PROPERTY of an ELEMENT."
440 "Extract contents from an ELEMENT."
446 "Return restriction associated to ELEMENT.
447 ELEMENT can be an element, an object or a symbol representing an
448 element or object type."
450 org-element-object-restrictions)))
453 "In ELEMENT set PROPERTY to VALUE.
454 Return modified element."
457 element))
460 "Set ELEMENT contents to CONTENTS.
461 Return modified element."
468 "Non-nil when OBJECT belongs to a secondary string.
469 Return value is the property name, as a keyword, or nil."
472 org-element-secondary-value-alist))))
475 property)))
478 "Append elements to the contents of another element.
480 PARENT is an element or object. CHILDREN can be elements,
481 objects, or a strings.
483 The function takes care of setting `:parent' property for CHILD.
484 Return parent element."
485 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
486 ;; string: parent is the list itself.
489 children)
490 ;; Add CHILDREN at the end of PARENT contents.
493 parent
495 ;; Return modified PARENT element.
499 "Extract ELEMENT from parse tree.
500 Remove element from the parse tree by side-effect, and return it
501 with its `:parent' property stripped out."
506 parent secondary
509 parent
511 ;; Return ELEMENT with its :parent removed.
515 "Insert ELEMENT before LOCATION in parse tree.
516 LOCATION is an element, object or string within the parse tree.
517 Parse tree is modified by side effect."
522 ;; Special case: LOCATION is the first element of an
523 ;; independent secondary string (e.g. :title property). Add
524 ;; ELEMENT in-place.
528 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
538 ;; Store SIBLINGS at appropriate place in parse tree.
543 ;; Set appropriate :parent property.
547 "Replace element or object OLD with element or object NEW.
548 The function takes care of setting `:parent' property for NEW."
549 ;; Ensure OLD and NEW have the same parent.
553 ;; We cannot replace OLD with NEW since one of them is not an
554 ;; object or element. We take the long path.
557 ;; Since OLD is going to be changed into NEW by side-effect, first
558 ;; make sure that every element or object within NEW has OLD as
559 ;; parent.
562 ;; Transfer contents.
564 ;; Overwrite OLD's properties with NEW's.
566 ;; Transfer type.
570 "Return a copy of DATUM.
571 DATUM is an element, object, string or nil. `:parent' property
572 is cleared and contents are removed in the process."
583 \f
584 ;;; Greater elements
585 ;;
586 ;; For each greater element type, we define a parser and an
587 ;; interpreter.
588 ;;
589 ;; A parser returns the element or object as the list described above.
590 ;; Most of them accepts no argument. Though, exceptions exist. Hence
591 ;; every element containing a secondary string (see
592 ;; `org-element-secondary-value-alist') will accept an optional
593 ;; argument to toggle parsing of that secondary string. Moreover,
594 ;; `item' parser requires current list's structure as its first
595 ;; element.
596 ;;
597 ;; An interpreter accepts two arguments: the list representation of
598 ;; the element or object, and its contents. The latter may be nil,
599 ;; depending on the element or object considered. It returns the
600 ;; appropriate Org syntax, as a string.
601 ;;
602 ;; Parsing functions must follow the naming convention:
603 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
604 ;; defined in `org-element-greater-elements'.
605 ;;
606 ;; Similarly, interpreting functions must follow the naming
607 ;; convention: org-element-TYPE-interpreter.
608 ;;
609 ;; With the exception of `headline' and `item' types, greater elements
610 ;; cannot contain other greater elements of their own type.
611 ;;
612 ;; Beside implementing a parser and an interpreter, adding a new
613 ;; greater element requires to tweak `org-element--current-element'.
614 ;; Moreover, the newly defined type must be added to both
615 ;; `org-element-all-elements' and `org-element-greater-elements'.
618 ;;;; Center Block
621 "Parse a center block.
623 LIMIT bounds the search. AFFILIATED is a list of which CAR is
624 the buffer position at the beginning of the first affiliated
625 keyword and CDR is a plist of affiliated keywords along with
626 their value.
628 Return a list whose CAR is `center-block' and CDR is a plist
629 containing `:begin', `:end', `:contents-begin', `:contents-end',
630 `:post-blank' and `:post-affiliated' keywords.
632 Assume point is at the beginning of the block."
636 ;; Incomplete block: parse it as a paragraph.
641 ;; Empty blocks have no contents.
655 :end end
656 :contents-begin contents-begin
657 :contents-end contents-end
663 "Interpret CENTER-BLOCK element as Org syntax.
664 CONTENTS is the contents of the element."
668 ;;;; Drawer
671 "Parse a drawer.
673 LIMIT bounds the search. AFFILIATED is a list of which CAR is
674 the buffer position at the beginning of the first affiliated
675 keyword and CDR is a plist of affiliated keywords along with
676 their value.
678 Return a list whose CAR is `drawer' and CDR is a plist containing
679 `:drawer-name', `:begin', `:end', `:contents-begin',
680 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
682 Assume point is at beginning of drawer."
685 ;; Incomplete drawer: parse it as a paragraph.
693 ;; Empty drawers have no contents.
706 :end end
707 :drawer-name name
708 :contents-begin contents-begin
709 :contents-end contents-end
715 "Interpret DRAWER element as Org syntax.
716 CONTENTS is the contents of the element."
719 contents))
722 ;;;; Dynamic Block
725 "Parse a dynamic block.
727 LIMIT bounds the search. AFFILIATED is a list of which CAR is
728 the buffer position at the beginning of the first affiliated
729 keyword and CDR is a plist of affiliated keywords along with
730 their value.
732 Return a list whose CAR is `dynamic-block' and CDR is a plist
733 containing `:block-name', `:begin', `:end', `:contents-begin',
734 `:contents-end', `:arguments', `:post-blank' and
735 `:post-affiliated' keywords.
737 Assume point is at beginning of dynamic block."
741 ;; Incomplete block: parse it as a paragraph.
750 ;; Empty blocks have no contents.
763 :end end
764 :block-name name
765 :arguments arguments
766 :contents-begin contents-begin
767 :contents-end contents-end
773 "Interpret DYNAMIC-BLOCK element as Org syntax.
774 CONTENTS is the contents of the element."
779 contents))
782 ;;;; Footnote Definition
785 "Parse a footnote definition.
787 LIMIT bounds the search. AFFILIATED is a list of which CAR is
788 the buffer position at the beginning of the first affiliated
789 keyword and CDR is a plist of affiliated keywords along with
790 their value.
792 Return a list whose CAR is `footnote-definition' and CDR is
793 a plist containing `:label', `:begin' `:end', `:contents-begin',
794 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
796 Assume point is at the beginning of the footnote definition."
824 :begin begin
825 :end end
826 :contents-begin contents-begin
827 :contents-end contents-end
833 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
834 CONTENTS is the contents of the footnote-definition."
836 " "
837 contents))
840 ;;;; Headline
843 "Return node properties associated to headline at point.
844 Upcase property names. It avoids confusion between properties
845 obtained through property drawer and default properties from the
846 parser (e.g. `:end' and :END:). Return value is a plist."
858 properties))))
861 "Return time properties associated to headline at point.
862 Return value is a plist."
876 plist))))
879 "Parse a headline.
881 Return a list whose CAR is `headline' and CDR is a plist
882 containing `:raw-value', `:title', `:begin', `:end',
883 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
884 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
885 `:deadline', `:closed', `:archivedp', `:commentedp'
886 `:footnote-section-p', `:post-blank' and `:post-affiliated'
887 keywords.
889 The plist also contains any property set in the property drawer,
890 with its name in upper cases and colons added at the
891 beginning (e.g., `:CUSTOM_ID').
893 LIMIT is a buffer position bounding the search.
895 When RAW-SECONDARY-P is non-nil, headline's title will not be
896 parsed as a secondary string, but as a plain string instead.
898 Assume point is at beginning of the headline."
941 ;; Clean TAGS from archive tag, if any.
947 :begin begin
948 :end end
949 :pre-blank
952 :contents-begin contents-begin
953 :contents-end contents-end
954 :level level
955 :priority priority
956 :tags tags
957 :todo-keyword todo
958 :todo-type todo-type
961 end)
962 :footnote-section-p footnote-section-p
963 :archivedp archivedp
964 :commentedp commentedp
966 time-props
967 standard-props))))
969 headline :title
978 nil
984 "Interpret HEADLINE element as Org syntax.
985 CONTENTS is the contents of the element."
1001 ?*)
1005 " "
1008 org-footnote-section
1009 title))))
1011 heading
1012 ;; Align tags.
1020 ?\s)
1021 tags))
1025 tags))))
1027 contents)))
1030 ;;;; Inlinetask
1033 "Parse an inline task.
1035 Return a list whose CAR is `inlinetask' and CDR is a plist
1036 containing `:title', `:begin', `:end', `:contents-begin' and
1037 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1038 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1039 `:closed', `:post-blank' and `:post-affiliated' keywords.
1041 The plist also contains any property set in the property drawer,
1042 with its name in upper cases and colons added at the
1043 beginning (e.g., `:CUSTOM_ID').
1045 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1046 title will not be parsed as a secondary string, but as a plain
1047 string instead.
1049 Assume point is at beginning of the inline task."
1094 :begin begin
1095 :end end
1096 :contents-begin contents-begin
1097 :contents-end contents-end
1098 :level level
1099 :priority priority
1100 :tags tags
1101 :todo-keyword todo
1102 :todo-type todo-type
1105 time-props
1106 standard-props))))
1108 inlinetask :title
1117 nil
1123 "Interpret INLINETASK element as Org syntax.
1124 CONTENTS is the contents of inlinetask."
1138 ;; Align tags.
1146 ? )
1147 tags))
1151 tags))))
1152 ;; Prefer degenerate inlinetasks when there are no
1153 ;; contents.
1156 contents
1160 ;;;; Item
1163 "Parse an item.
1165 STRUCT is the structure of the plain list.
1167 Return a list whose CAR is `item' and CDR is a plist containing
1168 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1169 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1170 `:post-affiliated' keywords.
1172 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1173 any, will not be parsed as a secondary string, but as a plain
1174 string instead.
1176 Assume point is at the beginning of the item."
1200 ;; Ignore tags in un-ordered lists: they are just
1201 ;; a part of item's body.
1207 ;; If first line isn't empty, contents really start
1208 ;; at the text after item's meta-data.
1217 :begin begin
1218 :end end
1219 ;; CONTENTS-BEGIN and CONTENTS-END may be
1220 ;; mixed up in the case of an empty item
1221 ;; separated from the next by a blank line.
1222 ;; Thus ensure the former is always the
1223 ;; smallest.
1226 :checkbox checkbox
1227 :counter counter
1228 :structure struct
1232 item :tag
1243 "Interpret ITEM element as Org syntax.
1244 CONTENTS is the contents of the element."
1254 ;; Compute indentation.
1259 ;; Indent contents.
1261 bullet
1275 ;;;; Plain List
1278 ;; Return structure of list at point. Internal function. See
1279 ;; `org-list-struct' for details.
1284 items struct)
1289 ;; At limit: end all items.
1298 ;; At list end: end all items.
1303 ;; At a new item: end previous sibling.
1315 ind
1316 bullet
1319 ;; Description tag.
1323 ;; Ending position, unknown so far.
1324 nil)))
1325 items))
1327 ;; Skip empty lines.
1329 ;; Skip inline tasks and blank lines along the way.
1336 ;; At some text line. Check if it ends any previous item.
1348 ;; Skip blocks (any type) and drawers contents.
1353 limit t)))
1359 "Parse a plain list.
1361 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1362 the buffer position at the beginning of the first affiliated
1363 keyword and CDR is a plist of affiliated keywords along with
1364 their value. STRUCTURE is the structure of the plain list being
1365 parsed.
1367 Return a list whose CAR is `plain-list' and CDR is a plist
1368 containing `:type', `:begin', `:end', `:contents-begin' and
1369 `:contents-end', `:structure', `:post-blank' and
1370 `:post-affiliated' keywords.
1372 Assume point is at the beginning of the list."
1386 pos))
1390 ;; Return value.
1394 :begin begin
1395 :end end
1396 :contents-begin contents-begin
1397 :contents-end contents-end
1398 :structure struct
1404 "Interpret PLAIN-LIST element as Org syntax.
1405 CONTENTS is the contents of the element."
1413 ;;;; Property Drawer
1416 "Parse a property drawer.
1418 LIMIT bounds the search.
1420 Return a list whose car is `property-drawer' and cdr is a plist
1421 containing `:begin', `:end', `:contents-begin', `:contents-end',
1422 `:post-blank' and `:post-affiliated' keywords.
1424 Assume point is at the beginning of the property drawer."
1437 :end end
1439 :contents-end contents-end
1444 "Interpret PROPERTY-DRAWER element as Org syntax.
1445 CONTENTS is the properties within the drawer."
1449 ;;;; Quote Block
1452 "Parse a quote block.
1454 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1455 the buffer position at the beginning of the first affiliated
1456 keyword and CDR is a plist of affiliated keywords along with
1457 their value.
1459 Return a list whose CAR is `quote-block' and CDR is a plist
1460 containing `:begin', `:end', `:contents-begin', `:contents-end',
1461 `:post-blank' and `:post-affiliated' keywords.
1463 Assume point is at the beginning of the block."
1467 ;; Incomplete block: parse it as a paragraph.
1473 ;; Empty blocks have no contents.
1486 :end end
1487 :contents-begin contents-begin
1488 :contents-end contents-end
1494 "Interpret QUOTE-BLOCK element as Org syntax.
1495 CONTENTS is the contents of the element."
1499 ;;;; Section
1502 "Parse a section.
1504 LIMIT bounds the search.
1506 Return a list whose CAR is `section' and CDR is a plist
1507 containing `:begin', `:end', `:contents-begin', `contents-end',
1508 `:post-blank' and `:post-affiliated' keywords."
1510 ;; Beginning of section is the beginning of the first non-blank
1511 ;; line after previous headline.
1520 :end end
1521 :contents-begin begin
1522 :contents-end pos-before-blank
1527 "Interpret SECTION element as Org syntax.
1528 CONTENTS is the contents of the element."
1529 contents)
1532 ;;;; Special Block
1535 "Parse a special block.
1537 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1538 the buffer position at the beginning of the first affiliated
1539 keyword and CDR is a plist of affiliated keywords along with
1540 their value.
1542 Return a list whose CAR is `special-block' and CDR is a plist
1543 containing `:type', `:begin', `:end', `:contents-begin',
1544 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1546 Assume point is at the beginning of the block."
1553 limit t)))
1554 ;; Incomplete block: parse it as a paragraph.
1560 ;; Empty blocks have no contents.
1573 :begin begin
1574 :end end
1575 :contents-begin contents-begin
1576 :contents-end contents-end
1582 "Interpret SPECIAL-BLOCK element as Org syntax.
1583 CONTENTS is the contents of the element."
1588 \f
1589 ;;; Elements
1590 ;;
1591 ;; For each element, a parser and an interpreter are also defined.
1592 ;; Both follow the same naming convention used for greater elements.
1593 ;;
1594 ;; Also, as for greater elements, adding a new element type is done
1595 ;; through the following steps: implement a parser and an interpreter,
1596 ;; tweak `org-element--current-element' so that it recognizes the new
1597 ;; type and add that new type to `org-element-all-elements'.
1598 ;;
1599 ;; As a special case, when the newly defined type is a block type,
1600 ;; `org-element-block-name-alist' has to be modified accordingly.
1603 ;;;; Babel Call
1606 "Parse a babel call.
1608 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1609 the buffer position at the beginning of the first affiliated
1610 keyword and CDR is a plist of affiliated keywords along with
1611 their value.
1613 Return a list whose CAR is `babel-call' and CDR is a plist
1614 containing `:begin', `:end', `:value', `:post-blank' and
1615 `:post-affiliated' as keywords."
1629 :end end
1630 :value value
1636 "Interpret BABEL-CALL element as Org syntax.
1637 CONTENTS is nil."
1641 ;;;; Clock
1644 "Parse a clock.
1646 LIMIT bounds the search.
1648 Return a list whose CAR is `clock' and CDR is a plist containing
1649 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1650 `:post-affiliated' as keywords."
1670 :value value
1671 :duration duration
1672 :begin begin
1673 :end end
1674 :post-blank post-blank
1678 "Interpret CLOCK element as Org syntax.
1679 CONTENTS is nil."
1687 "%2s:%02s"
1691 ;;;; Comment
1694 "Parse a comment.
1696 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1697 the buffer position at the beginning of the first affiliated
1698 keyword and CDR is a plist of affiliated keywords along with
1699 their value.
1701 Return a list whose CAR is `comment' and CDR is a plist
1702 containing `:begin', `:end', `:value', `:post-blank',
1703 `:post-affiliated' keywords.
1705 Assume point is at comment beginning."
1714 ;; Get comments ending.
1717 ;; Accumulate lines without leading hash and first
1718 ;; whitespace.
1732 :end end
1733 :value value
1739 "Interpret COMMENT element as Org syntax.
1740 CONTENTS is nil."
1744 ;;;; Comment Block
1747 "Parse an export block.
1749 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1750 the buffer position at the beginning of the first affiliated
1751 keyword and CDR is a plist of affiliated keywords along with
1752 their value.
1754 Return a list whose CAR is `comment-block' and CDR is a plist
1755 containing `:begin', `:end', `:value', `:post-blank' and
1756 `:post-affiliated' keywords.
1758 Assume point is at comment block beginning."
1762 ;; Incomplete block: parse it as a paragraph.
1775 contents-begin contents-end)))
1779 :end end
1780 :value value
1786 "Interpret COMMENT-BLOCK element as Org syntax.
1787 CONTENTS is nil."
1794 ;;;; Diary Sexp
1797 "Parse a diary sexp.
1799 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1800 the buffer position at the beginning of the first affiliated
1801 keyword and CDR is a plist of affiliated keywords along with
1802 their value.
1804 Return a list whose CAR is `diary-sexp' and CDR is a plist
1805 containing `:begin', `:end', `:value', `:post-blank' and
1806 `:post-affiliated' keywords."
1818 :begin begin
1819 :end end
1825 "Interpret DIARY-SEXP as Org syntax.
1826 CONTENTS is nil."
1830 ;;;; Example Block
1833 "Parse an example block.
1835 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1836 the buffer position at the beginning of the first affiliated
1837 keyword and CDR is a plist of affiliated keywords along with
1838 their value.
1840 Return a list whose CAR is `example-block' and CDR is a plist
1841 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1842 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1843 `:value', `:post-blank' and `:post-affiliated' keywords."
1847 ;; Incomplete block: parse it as a paragraph.
1855 ;; Switches analysis
1862 ;; Should labels be retained in (or stripped from) example
1863 ;; blocks?
1868 ;; What should code-references use - labels or
1869 ;; line-numbers?
1878 ;; Standard block parsing.
1886 contents-begin contents-end))
1887 block-ind))
1896 :end end
1897 :value value
1898 :switches switches
1899 :number-lines number-lines
1900 :preserve-indent preserve-indent
1901 :retain-labels retain-labels
1902 :use-labels use-labels
1903 :label-fmt label-fmt
1909 "Interpret EXAMPLE-BLOCK element as Org syntax.
1910 CONTENTS is nil."
1918 value
1923 ;;;; Export Block
1926 "Parse an export block.
1928 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1929 the buffer position at the beginning of the first affiliated
1930 keyword and CDR is a plist of affiliated keywords along with
1931 their value.
1933 Return a list whose CAR is `export-block' and CDR is a plist
1934 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1935 `:post-affiliated' keywords.
1937 Assume point is at export-block beginning."
1944 ;; Incomplete block: parse it as a paragraph.
1957 contents-end)))
1961 :end end
1962 :type type
1963 :value value
1969 "Interpret EXPORT-BLOCK element as Org syntax.
1970 CONTENTS is nil."
1977 ;;;; Fixed-width
1980 "Parse a fixed-width section.
1982 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1983 the buffer position at the beginning of the first affiliated
1984 keyword and CDR is a plist of affiliated keywords along with
1985 their value.
1987 Return a list whose CAR is `fixed-width' and CDR is a plist
1988 containing `:begin', `:end', `:value', `:post-blank' and
1989 `:post-affiliated' keywords.
1991 Assume point is at the beginning of the fixed-width area."
1995 value
2000 ;; Accumulate text without starting colons.
2013 :end end
2014 :value value
2020 "Interpret FIXED-WIDTH element as Org syntax.
2021 CONTENTS is nil."
2029 ;;;; Horizontal Rule
2032 "Parse an horizontal rule.
2034 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2035 the buffer position at the beginning of the first affiliated
2036 keyword and CDR is a plist of affiliated keywords along with
2037 their value.
2039 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2040 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2041 keywords."
2051 :end end
2057 "Interpret HORIZONTAL-RULE element as Org syntax.
2058 CONTENTS is nil."
2062 ;;;; Keyword
2065 "Parse a keyword at point.
2067 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2068 the buffer position at the beginning of the first affiliated
2069 keyword and CDR is a plist of affiliated keywords along with
2070 their value.
2072 Return a list whose CAR is `keyword' and CDR is a plist
2073 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2074 `:post-affiliated' keywords."
2076 ;; An orphaned affiliated keyword is considered as a regular
2077 ;; keyword. In this case AFFILIATED is nil, so we take care of
2078 ;; this corner case.
2091 :value value
2092 :begin begin
2093 :end end
2099 "Interpret KEYWORD element as Org syntax.
2100 CONTENTS is nil."
2106 ;;;; Latex Environment
2110 "Regexp matching the beginning of a LaTeX environment.
2111 The environment is captured by the first group.
2117 "Format string matching the ending of a LaTeX environment.
2121 "Parse a LaTeX environment.
2123 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2124 the buffer position at the beginning of the first affiliated
2125 keyword and CDR is a plist of affiliated keywords along with
2126 their value.
2128 Return a list whose CAR is `latex-environment' and CDR is a plist
2129 containing `:begin', `:end', `:value', `:post-blank' and
2130 `:post-affiliated' keywords.
2132 Assume point is at the beginning of the latex environment."
2139 limit t))
2140 ;; Incomplete latex environment: parse it as a paragraph.
2150 :end end
2151 :value value
2157 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2158 CONTENTS is nil."
2162 ;;;; Node Property
2165 "Parse a node-property at point.
2167 LIMIT bounds the search.
2169 Return a list whose CAR is `node-property' and CDR is a plist
2170 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2171 `:post-affiliated' keywords."
2181 limit))))
2184 :value value
2185 :begin begin
2186 :end end
2191 "Interpret NODE-PROPERTY element as Org syntax.
2192 CONTENTS is nil."
2198 ;;;; Paragraph
2201 "Parse a paragraph.
2203 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2204 the buffer position at the beginning of the first affiliated
2205 keyword and CDR is a plist of affiliated keywords along with
2206 their value.
2208 Return a list whose CAR is `paragraph' and CDR is a plist
2209 containing `:begin', `:end', `:contents-begin' and
2210 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2212 Assume point is at the beginning of the paragraph."
2221 limit
2222 ;; A matching `org-element-paragraph-separate' is not
2223 ;; necessarily the end of the paragraph. In
2224 ;; particular, lines starting with # or : as a first
2225 ;; non-space character are ambiguous. We have to
2226 ;; check if they are valid Org syntax (e.g., not an
2227 ;; incomplete keyword).
2231 ;; There's no ambiguity for other symbols or
2232 ;; empty lines: stop here.
2234 ;; Stop at valid fixed-width areas.
2236 ;; Stop at drawers.
2241 ;; Stop at valid comments.
2243 ;; Stop at valid dynamic blocks.
2248 ;; Stop at valid blocks.
2255 limit t)))
2256 ;; Stop at valid latex environments.
2263 limit t)))
2264 ;; Stop at valid keywords.
2266 ;; Skip everything else.
2283 :end end
2284 :contents-begin contents-begin
2285 :contents-end contents-end
2291 "Interpret PARAGRAPH element as Org syntax.
2292 CONTENTS is the contents of the element."
2293 contents)
2296 ;;;; Planning
2299 "Parse a planning.
2301 LIMIT bounds the search.
2303 Return a list whose CAR is `planning' and CDR is a plist
2304 containing `:closed', `:deadline', `:scheduled', `:begin',
2305 `:end', `:post-blank' and `:post-affiliated' keywords."
2315 closed deadline scheduled)
2327 :deadline deadline
2328 :scheduled scheduled
2329 :begin begin
2330 :end end
2331 :post-blank post-blank
2335 "Interpret PLANNING element as Org syntax.
2336 CONTENTS is nil."
2338 'identity
2355 ;;;; Src Block
2358 "Parse a src block.
2360 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2361 the buffer position at the beginning of the first affiliated
2362 keyword and CDR is a plist of affiliated keywords along with
2363 their value.
2365 Return a list whose CAR is `src-block' and CDR is a plist
2366 containing `:language', `:switches', `:parameters', `:begin',
2367 `:end', `:number-lines', `:retain-labels', `:use-labels',
2368 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2369 `:post-affiliated' keywords.
2371 Assume point is at the beginning of the block."
2374 limit t)))
2375 ;; Incomplete block: parse it as a paragraph.
2381 ;; Get language as a string.
2390 ;; Get switches.
2392 ;; Get parameters.
2394 ;; Switches analysis
2405 ;; Should labels be retained in (or stripped from)
2406 ;; src blocks?
2411 ;; What should code-references use - labels or
2412 ;; line-numbers?
2417 ;; Indentation.
2419 ;; Retrieve code.
2424 block-ind))
2428 ;; Get position after ending blank lines.
2438 :begin begin
2439 :end end
2440 :number-lines number-lines
2441 :preserve-indent preserve-indent
2442 :retain-labels retain-labels
2443 :use-labels use-labels
2444 :label-fmt label-fmt
2445 :value value
2451 "Interpret SRC-BLOCK element as Org syntax.
2452 CONTENTS is nil."
2461 val)
2475 ;;;; Table
2478 "Parse a table at point.
2480 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2481 the buffer position at the beginning of the first affiliated
2482 keyword and CDR is a plist of affiliated keywords along with
2483 their value.
2485 Return a list whose CAR is `table' and CDR is a plist containing
2486 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2487 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2488 keywords.
2490 Assume point is at the beginning of the table."
2504 acc))
2511 :end end
2512 :type type
2513 :tblfm tblfm
2514 ;; Only `org' tables have contents. `table.el' tables
2515 ;; use a `:value' property to store raw table as
2516 ;; a string.
2521 table-begin table-end))
2527 "Interpret TABLE element as Org syntax.
2528 CONTENTS is a string, if table's type is `org', or nil."
2539 ;;;; Table Row
2542 "Parse table row at point.
2544 LIMIT bounds the search.
2546 Return a list whose CAR is `table-row' and CDR is a plist
2547 containing `:begin', `:end', `:contents-begin', `:contents-end',
2548 `:type', `:post-blank' and `:post-affiliated' keywords."
2552 ;; A table rule has no contents. In that case, ensure
2553 ;; CONTENTS-BEGIN matches CONTENTS-END.
2565 :begin begin
2566 :end end
2567 :contents-begin contents-begin
2568 :contents-end contents-end
2573 "Interpret TABLE-ROW element as Org syntax.
2574 CONTENTS is the contents of the table row."
2579 ;;;; Verse Block
2582 "Parse a verse block.
2584 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2585 the buffer position at the beginning of the first affiliated
2586 keyword and CDR is a plist of affiliated keywords along with
2587 their value.
2589 Return a list whose CAR is `verse-block' and CDR is a plist
2590 containing `:begin', `:end', `:contents-begin', `:contents-end',
2591 `:post-blank' and `:post-affiliated' keywords.
2593 Assume point is at beginning of the block."
2597 ;; Incomplete block: parse it as a paragraph.
2612 :end end
2613 :contents-begin contents-begin
2614 :contents-end contents-end
2620 "Interpret VERSE-BLOCK element as Org syntax.
2621 CONTENTS is verse block contents."
2625 \f
2626 ;;; Objects
2627 ;;
2628 ;; Unlike to elements, raw text can be found between objects. Hence,
2629 ;; `org-element--object-lex' is provided to find the next object in
2630 ;; buffer.
2631 ;;
2632 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2633 ;; object types they can contain will be specified in
2634 ;; `org-element-object-restrictions'.
2635 ;;
2636 ;; Creating a new type of object requires to alter
2637 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2638 ;; new type in `org-element-all-objects', and possibly add
2639 ;; restrictions in `org-element-object-restrictions'.
2641 ;;;; Bold
2644 "Parse bold object at point, if any.
2646 When at a bold object, return a list whose car is `bold' and cdr
2647 is a plist with `:begin', `:end', `:contents-begin' and
2648 `:contents-end' and `:post-blank' keywords. Otherwise, return
2649 nil.
2651 Assume point is at the first star marker."
2663 :end end
2664 :contents-begin contents-begin
2665 :contents-end contents-end
2669 "Interpret BOLD object as Org syntax.
2670 CONTENTS is the contents of the object."
2674 ;;;; Code
2677 "Parse code object at point, if any.
2679 When at a code object, return a list whose car is `code' and cdr
2680 is a plist with `:value', `:begin', `:end' and `:post-blank'
2681 keywords. Otherwise, return nil.
2683 Assume point is at the first tilde marker."
2694 :begin begin
2695 :end end
2699 "Interpret CODE object as Org syntax.
2700 CONTENTS is nil."
2704 ;;;; Entity
2707 "Parse entity at point, if any.
2709 When at an entity, return a list whose car is `entity' and cdr
2710 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2711 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2712 `:post-blank' as keywords. Otherwise, return nil.
2714 Assume point is at the beginning of the entity."
2716 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2734 :begin begin
2735 :end end
2736 :use-brackets-p bracketsp
2740 "Interpret ENTITY object as Org syntax.
2741 CONTENTS is nil."
2747 ;;;; Export Snippet
2750 "Parse export snippet at point.
2752 When at an export snippet, return a list whose car is
2753 `export-snippet' and cdr a plist with `:begin', `:end',
2754 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2755 return nil.
2757 Assume point is at the beginning of the snippet."
2773 :value value
2774 :begin begin
2775 :end end
2779 "Interpret EXPORT-SNIPPET object as Org syntax.
2780 CONTENTS is nil."
2786 ;;;; Footnote Reference
2789 "Parse footnote reference at point, if any.
2791 When at a footnote reference, return a list whose car is
2792 `footnote-reference' and cdr a plist with `:label', `:type',
2793 `:begin', `:end', `:content-begin', `:contents-end' and
2794 `:post-blank' as keywords. Otherwise, return nil."
2818 :type type
2819 :begin begin
2820 :end end
2826 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2827 CONTENTS is its definition, when inline, or nil."
2833 ;;;; Inline Babel Call
2836 "Parse inline babel call at point, if any.
2838 When at an inline babel call, return a list whose car is
2839 `inline-babel-call' and cdr a plist with `:begin', `:end',
2840 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2842 Assume point is at the beginning of the babel call."
2854 :end end
2855 :value value
2859 "Interpret INLINE-BABEL-CALL object as Org syntax.
2860 CONTENTS is nil."
2864 ;;;; Inline Src Block
2867 "Parse inline source block at point, if any.
2869 When at an inline source block, return a list whose car is
2870 `inline-src-block' and cdr a plist with `:begin', `:end',
2871 `:language', `:value', `:parameters' and `:post-blank' as
2872 keywords. Otherwise, return nil.
2874 Assume point is at the beginning of the inline src block."
2887 :value value
2888 :parameters parameters
2889 :begin begin
2890 :end end
2894 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2895 CONTENTS is nil."
2900 language
2902 body)))
2904 ;;;; Italic
2907 "Parse italic object at point, if any.
2909 When at an italic object, return a list whose car is `italic' and
2910 cdr is a plist with `:begin', `:end', `:contents-begin' and
2911 `:contents-end' and `:post-blank' keywords. Otherwise, return
2912 nil.
2914 Assume point is at the first slash marker."
2926 :end end
2927 :contents-begin contents-begin
2928 :contents-end contents-end
2932 "Interpret ITALIC object as Org syntax.
2933 CONTENTS is the contents of the object."
2937 ;;;; Latex Fragment
2940 "Parse LaTeX fragment at point, if any.
2942 When at a LaTeX fragment, return a list whose car is
2943 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2944 and `:post-blank' as keywords. Otherwise, return nil.
2946 Assume point is at the beginning of the LaTeX fragment."
2964 ;; Macro.
2973 :begin begin
2974 :end end
2978 "Interpret LATEX-FRAGMENT object as Org syntax.
2979 CONTENTS is nil."
2982 ;;;; Line Break
2985 "Parse line break at point, if any.
2987 When at a line break, return a list whose car is `line-break',
2988 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2989 Otherwise, return nil.
2991 Assume point is at the beginning of the line break."
3000 "Interpret LINE-BREAK object as Org syntax.
3001 CONTENTS is nil."
3005 ;;;; Link
3008 "Parse link at point, if any.
3010 When at a link, return a list whose car is `link' and cdr a plist
3011 with `:type', `:path', `:raw-link', `:application',
3012 `:search-option', `:begin', `:end', `:contents-begin',
3013 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3014 nil.
3016 Assume point is at the beginning of the link."
3019 end contents-begin contents-end link-end post-blank path type
3020 raw-link link search-option application)
3022 ;; Type 1: Text targeted from a radio target.
3031 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3036 ;; RAW-LINK is the original link. Expand any
3037 ;; abbreviation in it.
3041 ;; Determine TYPE of link and set PATH accordingly.
3043 ;; File type.
3047 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3050 ;; According to RFC 3986, extra whitespace should be
3051 ;; ignored when a URI is extracted.
3054 ;; Id type: PATH is the id.
3057 ;; Code-ref type: PATH is the name of the reference.
3060 ;; Custom-id type: PATH is the name of the custom id.
3063 ;; Fuzzy type: Internal link either matches a target, an
3064 ;; headline name or nothing. PATH is the target or
3065 ;; headline's name.
3067 ;; Type 3: Plain link, e.g., http://orgmode.org
3073 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3081 ;; In any case, deduce end point after trailing white space from
3082 ;; LINK-END variable.
3086 ;; Special "file" type link processing. Extract opening
3087 ;; application and search option, if any. Also normalize URI.
3098 :path path
3100 :application application
3101 :search-option search-option
3102 :begin begin
3103 :end end
3104 :contents-begin contents-begin
3105 :contents-end contents-end
3109 "Interpret LINK object as Org syntax.
3110 CONTENTS is the contents of the object, or nil."
3115 raw-link
3119 ;;;; Macro
3122 "Parse macro at point, if any.
3124 When at a macro, return a list whose car is `macro' and cdr
3125 a plist with `:key', `:args', `:begin', `:end', `:value' and
3126 `:post-blank' as keywords. Otherwise, return nil.
3128 Assume point is at the macro."
3141 :value value
3142 :args args
3143 :begin begin
3144 :end end
3148 "Interpret MACRO object as Org syntax.
3149 CONTENTS is nil."
3153 ;;;; Radio-target
3156 "Parse radio target at point, if any.
3158 When at a radio target, return a list whose car is `radio-target'
3159 and cdr a plist with `:begin', `:end', `:contents-begin',
3160 `:contents-end', `:value' and `:post-blank' as keywords.
3161 Otherwise, return nil.
3163 Assume point is at the radio target."
3175 :end end
3176 :contents-begin contents-begin
3177 :contents-end contents-end
3178 :post-blank post-blank
3182 "Interpret TARGET object as Org syntax.
3183 CONTENTS is the contents of the object."
3187 ;;;; Statistics Cookie
3190 "Parse statistics cookie at point, if any.
3192 When at a statistics cookie, return a list whose car is
3193 `statistics-cookie', and cdr a plist with `:begin', `:end',
3194 `:value' and `:post-blank' keywords. Otherwise, return nil.
3196 Assume point is at the beginning of the statistics-cookie."
3207 :end end
3208 :value value
3212 "Interpret STATISTICS-COOKIE object as Org syntax.
3213 CONTENTS is nil."
3217 ;;;; Strike-Through
3220 "Parse strike-through object at point, if any.
3222 When at a strike-through object, return a list whose car is
3223 `strike-through' and cdr is a plist with `:begin', `:end',
3224 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3225 Otherwise, return nil.
3227 Assume point is at the first plus sign marker."
3239 :end end
3240 :contents-begin contents-begin
3241 :contents-end contents-end
3245 "Interpret STRIKE-THROUGH object as Org syntax.
3246 CONTENTS is the contents of the object."
3250 ;;;; Subscript
3253 "Parse subscript at point, if any.
3255 When at a subscript object, return a list whose car is
3256 `subscript' and cdr a plist with `:begin', `:end',
3257 `:contents-begin', `:contents-end', `:use-brackets-p' and
3258 `:post-blank' as keywords. Otherwise, return nil.
3260 Assume point is at the underscore."
3274 :end end
3275 :use-brackets-p bracketsp
3276 :contents-begin contents-begin
3277 :contents-end contents-end
3281 "Interpret SUBSCRIPT object as Org syntax.
3282 CONTENTS is the contents of the object."
3285 contents))
3288 ;;;; Superscript
3291 "Parse superscript at point, if any.
3293 When at a superscript object, return a list whose car is
3294 `superscript' and cdr a plist with `:begin', `:end',
3295 `:contents-begin', `:contents-end', `:use-brackets-p' and
3296 `:post-blank' as keywords. Otherwise, return nil.
3298 Assume point is at the caret."
3312 :end end
3313 :use-brackets-p bracketsp
3314 :contents-begin contents-begin
3315 :contents-end contents-end
3319 "Interpret SUPERSCRIPT object as Org syntax.
3320 CONTENTS is the contents of the object."
3323 contents))
3326 ;;;; Table Cell
3329 "Parse table cell at point.
3330 Return a list whose car is `table-cell' and cdr is a plist
3331 containing `:begin', `:end', `:contents-begin', `:contents-end'
3332 and `:post-blank' keywords."
3340 :end end
3341 :contents-begin contents-begin
3342 :contents-end contents-end
3346 "Interpret TABLE-CELL element as Org syntax.
3347 CONTENTS is the contents of the cell, or nil."
3351 ;;;; Target
3354 "Parse target at point, if any.
3356 When at a target, return a list whose car is `target' and cdr
3357 a plist with `:begin', `:end', `:value' and `:post-blank' as
3358 keywords. Otherwise, return nil.
3360 Assume point is at the target."
3370 :end end
3371 :value value
3375 "Interpret TARGET object as Org syntax.
3376 CONTENTS is nil."
3380 ;;;; Timestamp
3391 "Parse time stamp at point, if any.
3393 When at a time stamp, return a list whose car is `timestamp', and
3394 cdr a plist with `:type', `:raw-value', `:year-start',
3395 `:month-start', `:day-start', `:hour-start', `:minute-start',
3396 `:year-end', `:month-end', `:day-end', `:hour-end',
3397 `:minute-end', `:repeater-type', `:repeater-value',
3398 `:repeater-unit', `:warning-type', `:warning-value',
3399 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3400 Otherwise, return nil.
3402 Assume point is at the beginning of the timestamp."
3421 date-start)
3432 raw-value)
3434 :repeater-type
3440 :repeater-unit
3449 :warning-unit
3452 year-start month-start day-start hour-start minute-start year-end
3453 month-end day-end hour-end minute-end)
3454 ;; Parse date-start.
3462 ;; Compute date-end. It can be provided directly in time-stamp,
3463 ;; or extracted from time range. Otherwise, it defaults to the
3464 ;; same values as date-start.
3474 :raw-value raw-value
3475 :year-start year-start
3476 :month-start month-start
3477 :day-start day-start
3478 :hour-start hour-start
3479 :minute-start minute-start
3480 :year-end year-end
3481 :month-end month-end
3482 :day-end day-end
3483 :hour-end hour-end
3484 :minute-end minute-end
3485 :begin begin
3486 :end end
3488 repeater-props
3489 warning-props))))))
3492 "Interpret TIMESTAMP object as Org syntax.
3493 CONTENTS is nil."
3512 ;; Build an Org timestamp string from TIME. ACTIVEP is
3513 ;; non-nil when time stamp is active. If WITH-TIME-P is
3514 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3515 ;; specify a time range in the timestamp. REPEAT-STRING is
3516 ;; the repeater string, if any.
3520 org-time-stamp-formats)
3521 time)))
3527 nil nil ts)))
3532 " "
3533 s
3535 ;; Return value.
3536 ts)))
3548 build-ts-string
3567 0
3575 "--"
3588 ;;;; Underline
3591 "Parse underline object at point, if any.
3593 When at an underline object, return a list whose car is
3594 `underline' and cdr is a plist with `:begin', `:end',
3595 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3596 Otherwise, return nil.
3598 Assume point is at the first underscore marker."
3610 :end end
3611 :contents-begin contents-begin
3612 :contents-end contents-end
3616 "Interpret UNDERLINE object as Org syntax.
3617 CONTENTS is the contents of the object."
3621 ;;;; Verbatim
3624 "Parse verbatim object at point, if any.
3626 When at a verbatim object, return a list whose car is `verbatim'
3627 and cdr is a plist with `:value', `:begin', `:end' and
3628 `:post-blank' keywords. Otherwise, return nil.
3630 Assume point is at the first equal sign marker."
3641 :begin begin
3642 :end end
3646 "Interpret VERBATIM object as Org syntax.
3647 CONTENTS is nil."
3651 \f
3652 ;;; Parsing Element Starting At Point
3653 ;;
3654 ;; `org-element--current-element' is the core function of this section.
3655 ;; It returns the Lisp representation of the element starting at
3656 ;; point.
3657 ;;
3658 ;; `org-element--current-element' makes use of special modes. They
3659 ;; are activated for fixed element chaining (e.g., `plain-list' >
3660 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3661 ;; `section'). Special modes are: `first-section', `item',
3662 ;; `node-property', `section' and `table-row'.
3665 "Parse the element starting at point.
3667 Return value is a list like (TYPE PROPS) where TYPE is the type
3668 of the element and PROPS a plist of properties associated to the
3669 element.
3671 Possible types are defined in `org-element-all-elements'.
3673 LIMIT bounds the search.
3675 Optional argument GRANULARITY determines the depth of the
3676 recursion. Allowed values are `headline', `greater-element',
3677 `element', `object' or nil. When it is broader than `object' (or
3678 nil), secondary values will not be parsed, since they only
3679 contain objects.
3681 Optional argument MODE, when non-nil, can be either
3682 `first-section', `section', `planning', `item', `node-property'
3683 and `table-row'.
3685 If STRUCTURE isn't provided but MODE is set to `item', it will be
3686 computed.
3688 This function assumes point is always at the beginning of the
3689 element it has to parse."
3692 ;; Determine if parsing depth allows for secondary strings
3693 ;; parsing. It only applies to elements referenced in
3694 ;; `org-element-secondary-value-alist'.
3697 ;; Item.
3700 ;; Table Row.
3702 ;; Node Property.
3704 ;; Headline.
3707 ;; Sections (must be checked after headline).
3712 limit)))
3713 ;; Planning.
3716 ;; Property drawer.
3720 ;; When not at bol, point is at the beginning of an item or
3721 ;; a footnote definition: next item is always a paragraph.
3723 ;; Clock.
3725 ;; Inlinetask.
3728 ;; From there, elements can have affiliated keywords.
3731 ;; Jumping over affiliated keywords put point off-limits.
3732 ;; Parse them as regular keywords.
3736 ;; LaTeX Environment.
3739 ;; Drawer and Property Drawer.
3742 ;; Fixed Width
3745 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3746 ;; Keywords.
3755 org-element-block-name-alist)))
3770 ;; Footnote Definition.
3773 ;; Horizontal Rule.
3776 ;; Diary Sexp.
3779 ;; Table.
3781 ;; List.
3784 limit affiliated
3786 ;; Default element: Paragraph.
3790 ;; Most elements can have affiliated keywords. When looking for an
3791 ;; element beginning, we want to move before them, as they belong to
3792 ;; that element, and, in the meantime, collect information they give
3793 ;; into appropriate properties. Hence the following function.
3796 "Collect affiliated keywords from point down to LIMIT.
3798 Return a list whose CAR is the position at the first of them and
3799 CDR a plist of keywords and values and move point to the
3800 beginning of the first line after them.
3802 As a special case, if element doesn't start at the beginning of
3803 the line (e.g., a paragraph starting an item), CAR is current
3804 position of point and CDR is nil."
3808 ;; RESTRICT is the list of objects allowed in parsed
3809 ;; keywords value.
3811 output)
3814 ;; Apply translation to RAW-KWD. From there, KWD is
3815 ;; the official keyword.
3817 org-element-keyword-translation-alist))
3818 raw-kwd))
3819 ;; Find main value for any keyword.
3825 ;; PARSEDP is non-nil when keyword should have its
3826 ;; value parsed.
3828 ;; If KWD is a dual keyword, find its secondary
3829 ;; value. Maybe parse it.
3837 ;; Attribute a property name to KWD.
3839 ;; Now set final shape for VALUE.
3845 nil restrict)))
3849 ;; Attributes can always appear on multiple lines.
3852 ;; Eventually store the new value in OUTPUT.
3854 ;; Move to next keyword.
3856 ;; If affiliated keywords are orphaned: move back to first one.
3857 ;; They will be parsed as a paragraph.
3859 ;; Return value.
3863 \f
3864 ;;; The Org Parser
3865 ;;
3866 ;; The two major functions here are `org-element-parse-buffer', which
3867 ;; parses Org syntax inside the current buffer, taking into account
3868 ;; region, narrowing, or even visibility if specified, and
3869 ;; `org-element-parse-secondary-string', which parses objects within
3870 ;; a given string.
3871 ;;
3872 ;; The (almost) almighty `org-element-map' allows to apply a function
3873 ;; on elements or objects matching some type, and accumulate the
3874 ;; resulting values. In an export situation, it also skips unneeded
3875 ;; parts of the parse tree.
3878 "Recursively parse the buffer and return structure.
3879 If narrowing is in effect, only parse the visible part of the
3880 buffer.
3882 Optional argument GRANULARITY determines the depth of the
3883 recursion. It can be set to the following symbols:
3885 `headline' Only parse headlines.
3886 `greater-element' Don't recurse into greater elements excepted
3887 headlines and sections. Thus, elements
3888 parsed are the top-level ones.
3889 `element' Parse everything but objects and plain text.
3890 `object' Parse the complete buffer (default).
3892 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3893 elements.
3895 An element or an objects is represented as a list with the
3896 pattern (TYPE PROPERTIES CONTENTS), where :
3898 TYPE is a symbol describing the element or object. See
3899 `org-element-all-elements' and `org-element-all-objects' for an
3900 exhaustive list of such symbols. One can retrieve it with
3901 `org-element-type' function.
3903 PROPERTIES is the list of attributes attached to the element or
3904 object, as a plist. Although most of them are specific to the
3905 element or object type, all types share `:begin', `:end',
3906 `:post-blank' and `:parent' properties, which respectively
3907 refer to buffer position where the element or object starts,
3908 ends, the number of white spaces or blank lines after it, and
3909 the element or object containing it. Properties values can be
3910 obtained by using `org-element-property' function.
3912 CONTENTS is a list of elements, objects or raw strings
3913 contained in the current element or object, when applicable.
3914 One can access them with `org-element-contents' function.
3916 The Org buffer has `org-data' as type and nil as properties.
3917 `org-element-map' function can be used to find specific elements
3918 or objects within the parse tree.
3920 This function assumes that current major mode is `org-mode'."
3926 ;; Start in `first-section' mode so text before the first
3927 ;; headline belongs to a section.
3931 "Recursively parse objects in STRING and return structure.
3933 RESTRICTION is a symbol limiting the object types that will be
3934 looked after.
3936 Optional argument PARENT, when non-nil, is the element or object
3937 containing the secondary string. It is used to set correctly
3938 `:parent' property within the string."
3951 secondary))))
3955 "Map a function on selected elements or objects.
3957 DATA is a parse tree, an element, an object, a string, or a list
3958 of such constructs. TYPES is a symbol or list of symbols of
3959 elements or objects types (see `org-element-all-elements' and
3960 `org-element-all-objects' for a complete list of types). FUN is
3961 the function called on the matching element or object. It has to
3962 accept one argument: the element or object itself.
3964 When optional argument INFO is non-nil, it should be a plist
3965 holding export options. In that case, parts of the parse tree
3966 not exportable according to that property list will be skipped.
3968 When optional argument FIRST-MATCH is non-nil, stop at the first
3969 match for which FUN doesn't return nil, and return that value.
3971 Optional argument NO-RECURSION is a symbol or a list of symbols
3972 representing elements or objects types. `org-element-map' won't
3973 enter any recursive element or object whose type belongs to that
3974 list. Though, FUN can still be applied on them.
3976 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3977 apply to matching objects within parsed affiliated keywords (see
3978 `org-element-parsed-keywords').
3980 Nil values returned from FUN do not appear in the results.
3983 Examples:
3984 ---------
3986 Assuming TREE is a variable containing an Org buffer parse tree,
3987 the following example will return a flat list of all `src-block'
3988 and `example-block' elements in it:
3990 \(org-element-map tree '(example-block src-block) #'identity)
3992 The following snippet will find the first headline with a level
3995 \(org-element-map tree 'headline
3996 \(lambda (hl)
3997 \(and (= (org-element-property :level hl) 1)
3999 \(org-element-property :begin hl)))
4000 nil t)
4002 The next example will return a flat list of all `plain-list' type
4003 elements in TREE that are not a sub-list themselves:
4005 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4007 Eventually, this example will return a flat list of all `bold'
4008 type objects containing a `latex-snippet' type object, even
4009 looking into captions:
4011 \(org-element-map tree 'bold
4012 \(lambda (b)
4013 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4014 nil nil nil t)"
4015 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4019 ;; Recursion depth is determined by --CATEGORY.
4026 ;; If one object is found, the function has to
4027 ;; recurse into every object.
4030 ;; If one regular element is found, the
4031 ;; function has to recurse, at least, into
4032 ;; every element it encounters.
4035 --acc
4036 --walk-tree
4039 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4040 ;; holding contextual information.
4044 ;; Ignored element in an export context.
4046 ;; List of elements or objects.
4048 ;; Unconditionally enter parse trees.
4052 ;; Check if TYPE is matching among TYPES. If so,
4053 ;; apply FUN to --DATA and accumulate return value
4054 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4060 ;; If --DATA has a secondary string that can contain
4061 ;; objects with their type among TYPES, look into it.
4068 ;; If --DATA has any parsed affiliated keywords and
4069 ;; WITH-AFFILIATED is non-nil, look for objects in
4070 ;; them.
4077 ;; Pay attention to the type of parsed keyword.
4078 ;; In particular, preserve order for multiple
4079 ;; keywords.
4092 ;; Determine if a recursion into --DATA is possible.
4094 ;; --TYPE is explicitly removed from recursion.
4096 ;; --DATA has no contents.
4098 ;; Looking for greater elements but --DATA is simply
4099 ;; an element or an object.
4102 ;; Looking for elements but --DATA is an object.
4105 ;; In any other case, map contents.
4109 ;; Return value in a proper order.
4113 ;; The following functions are internal parts of the parser.
4114 ;;
4115 ;; The first one, `org-element--parse-elements' acts at the element's
4116 ;; level.
4117 ;;
4118 ;; The second one, `org-element--parse-objects' applies on all objects
4119 ;; of a paragraph or a secondary string. It calls
4120 ;; `org-element--object-lex' to find the next object in the current
4121 ;; container.
4124 "Return next special mode according to TYPE, or nil.
4125 TYPE is a symbol representing the type of an element or object
4126 containing next element if PARENTP is non-nil, or before it
4127 otherwise. Modes can be either `first-section', `item',
4128 `node-property', `planning', `property-drawer', `section',
4129 `table-row' or nil."
4145 "Parse elements between BEG and END positions.
4147 MODE prioritizes some elements over the others. It can be set to
4148 `first-section', `section', `planning', `item', `node-property'
4149 or `table-row'.
4151 When value is `item', STRUCTURE will be used as the current list
4152 structure.
4154 GRANULARITY determines the depth of the recursion. See
4155 `org-element-parse-buffer' for more information.
4157 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4158 elements.
4160 Elements are accumulated into ACC."
4163 ;; Visible only: skip invisible parts at the beginning of the
4164 ;; element.
4167 ;; When parsing only headlines, skip any text before first one.
4170 ;; Main loop start.
4172 ;; Find current element's type and parse it accordingly to
4173 ;; its category.
4175 end granularity mode structure))
4179 ;; Visible only: skip invisible parts between siblings.
4182 ;; Fill ELEMENT contents by side-effect.
4184 ;; If element has no contents, don't modify it.
4186 ;; Greater element: parse it between `contents-begin' and
4187 ;; `contents-end'. Make sure GRANULARITY allows the
4188 ;; recursion, or ELEMENT is a headline, in which case going
4189 ;; inside is mandatory, in order to get sub-level headings.
4197 ;; Possibly switch to a special mode.
4201 granularity visible-only element))
4202 ;; ELEMENT has contents. Parse objects inside, if
4203 ;; GRANULARITY allows it.
4209 ;; Update mode.
4211 ;; Return result.
4212 acc))
4215 "Return next object in current buffer or nil.
4216 RESTRICTION is a list of object types, as symbols, that should be
4217 looked after. This function assumes that the buffer is narrowed
4218 to an appropriate container (e.g., a paragraph)."
4226 found)
4291 ;; This is probably a plain link.
4297 ;; Radio link.
4302 "Parse objects between BEG and END and return recursive structure.
4304 Objects are accumulated in ACC.
4306 RESTRICTION is a list of object successors which are allowed in
4307 the current object."
4315 ;; 1. Text before any object. Untabify it.
4320 acc
4324 ;; 2. Object...
4327 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4328 ;; a recursive type.
4336 ;; 3. Text after last object. Untabify it.
4340 acc
4344 ;; Result.
4345 acc)))
4348 \f
4349 ;;; Towards A Bijective Process
4350 ;;
4351 ;; The parse tree obtained with `org-element-parse-buffer' is really
4352 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4353 ;; interpreted and expanded into a string with canonical Org syntax.
4354 ;; Hence `org-element-interpret-data'.
4355 ;;
4356 ;; The function relies internally on
4357 ;; `org-element--interpret-affiliated-keywords'.
4359 ;;;###autoload
4361 "Interpret DATA as Org syntax.
4362 DATA is a parse tree, an element, an object or a secondary string
4363 to interpret. Return Org syntax as a string."
4367 "Interpret DATA as Org syntax.
4369 DATA is a parse tree, an element, an object or a secondary string
4370 to interpret. PARENT is used for recursive calls. It contains
4371 the element or object containing data, or nil.
4373 Return Org syntax as a string."
4375 ;; Find interpreter for current object or element. If it
4376 ;; doesn't exist (e.g. this is a pseudo object or element),
4377 ;; return contents, if any.
4383 ;; Secondary string.
4387 ;; Full Org document.
4391 ;; Plain text: return it.
4393 ;; Element or object without contents.
4395 ;; Element or object with contents.
4398 ;; Recursively interpret contents.
4403 data
4404 ;; Fix indentation of elements containing
4405 ;; objects. We ignore `table-row' elements
4406 ;; as they are one line long anyway.
4408 data
4409 ;; When normalizing first paragraph of an
4410 ;; item or a footnote-definition, ignore
4411 ;; first line's indentation.
4418 ;; Build white spaces. If no `:post-blank' property is
4419 ;; specified, assume its value is 0.
4433 "Return ELEMENT's affiliated keywords as Org syntax.
4434 If there is no affiliated keyword, return the empty string."
4444 ": "
4447 value)
4455 ;; All attribute keywords can have multiple lines.
4461 ;; List all ELEMENT's properties matching an attribute line or an
4462 ;; affiliated keyword, but ignore translated keywords since they
4463 ;; cannot belong to the property list.
4470 org-element-keyword-translation-alist)))))
4471 collect prop)
4474 ;; Because interpretation of the parse tree must return the same
4475 ;; number of blank lines between elements and the same number of white
4476 ;; space after objects, some special care must be given to white
4477 ;; spaces.
4478 ;;
4479 ;; The first function, `org-element-normalize-string', ensures any
4480 ;; string different from the empty string will end with a single
4481 ;; newline character.
4482 ;;
4483 ;; The second function, `org-element-normalize-contents', removes
4484 ;; global indentation from the contents of the current element.
4487 "Ensure string S ends with a single newline character.
4489 If S isn't a string return it unchanged. If S is the empty
4490 string, return it. Otherwise, return a new string with a single
4491 newline character at its end."
4499 "Normalize plain text in ELEMENT's contents.
4501 ELEMENT must only contain plain text and objects.
4503 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4504 indentation to compute maximal common indentation.
4506 Return the normalized element that is element with global
4507 indentation removed from its contents. The function assumes that
4508 indentation is not done with TAB characters."
4510 find-min-ind ; For byte-compiler.
4512 ;; Return minimal common indentation within BLOB. This is
4513 ;; done by walking recursively BLOB and updating MIN-IND
4514 ;; along the way. FIRST-FLAG is non-nil when the first
4515 ;; string hasn't been seen yet. It is required as this
4516 ;; string is the only one whose indentation doesn't happen
4517 ;; after a newline character.
4524 ;; An indentation of zero means no string will be
4525 ;; modified. Quit the process.
4535 ;; Find minimal indentation in ELEMENT.
4538 ;; Build ELEMENT back, replacing each string with the same
4539 ;; string minus common indentation.
4544 ;; Return BLOB with all its strings indentation
4545 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4546 ;; is non-nil when the first string hasn't been seen
4547 ;; yet.
4562 org-element-recursive-objects)
4566 blob))))
4570 \f
4571 ;;; Cache
4572 ;;
4573 ;; Implement a caching mechanism for `org-element-at-point' and
4574 ;; `org-element-context', which see.
4575 ;;
4576 ;; A single public function is provided: `org-element-cache-reset'.
4577 ;;
4578 ;; Cache is enabled by default, but can be disabled globally with
4579 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4580 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4581 ;; can be tweaked to control caching behaviour.
4582 ;;
4583 ;; Internally, parsed elements are stored in an AVL tree,
4584 ;; `org-element--cache'. This tree is updated lazily: whenever
4585 ;; a change happens to the buffer, a synchronization request is
4586 ;; registered in `org-element--cache-sync-requests' (see
4587 ;; `org-element--cache-submit-request'). During idle time, requests
4588 ;; are processed by `org-element--cache-sync'. Synchronization also
4589 ;; happens when an element is required from the cache. In this case,
4590 ;; the process stops as soon as the needed element is up-to-date.
4591 ;;
4592 ;; A synchronization request can only apply on a synchronized part of
4593 ;; the cache. Therefore, the cache is updated at least to the
4594 ;; location where the new request applies. Thus, requests are ordered
4595 ;; from left to right and all elements starting before the first
4596 ;; request are correct. This property is used by functions like
4597 ;; `org-element--cache-find' to retrieve elements in the part of the
4598 ;; cache that can be trusted.
4599 ;;
4600 ;; A request applies to every element, starting from its original
4601 ;; location (or key, see below). When a request is processed, it
4602 ;; moves forward and may collide the next one. In this case, both
4603 ;; requests are merged into a new one that starts from that element.
4604 ;; As a consequence, the whole synchronization complexity does not
4605 ;; depend on the number of pending requests, but on the number of
4606 ;; elements the very first request will be applied on.
4607 ;;
4608 ;; Elements cannot be accessed through their beginning position, which
4609 ;; may or may not be up-to-date. Instead, each element in the tree is
4610 ;; associated to a key, obtained with `org-element--cache-key'. This
4611 ;; mechanism is robust enough to preserve total order among elements
4612 ;; even when the tree is only partially synchronized.
4613 ;;
4614 ;; Objects contained in an element are stored in a hash table,
4615 ;; `org-element--cache-objects'.
4619 "Non nil when Org parser should cache its results.
4626 "Maximum duration, as a time value, for a cache synchronization.
4627 If the synchronization is not over after this delay, the process
4628 pauses and resumes after `org-element-cache-sync-break'
4632 "Duration, as a time value, of the pause between synchronizations.
4636 ;;;; Data Structure
4639 "AVL tree used to cache elements.
4640 Each node of the tree contains an element. Comparison is done
4641 with `org-element--cache-compare'. This cache is used in
4645 "Hash table used as to cache objects.
4646 Key is an element, as returned by `org-element-at-point', and
4647 value is an alist where each association is:
4649 \(PARENT COMPLETEP . OBJECTS)
4651 where PARENT is an element or object, COMPLETEP is a boolean,
4652 non-nil when all direct children of parent are already cached and
4653 OBJECTS is a list of such children, as objects, from farthest to
4654 closest.
4657 contained within a paragraph
4661 If the paragraph is completely parsed, OBJECTS-DATA will be
4663 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4664 \(BOLD-OBJECT t ENTITY-OBJECT))
4666 whereas in a partially parsed paragraph, it could be
4668 \((PARAGRAPH nil ENTITY-OBJECT))
4673 "List of pending synchronization requests.
4675 A request is a vector with the following pattern:
4677 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4679 Processing a synchronization request consists of three phases:
4681 0. Delete modified elements,
4682 1. Fill missing area in cache,
4683 2. Shift positions and re-parent elements after the changes.
4685 During phase 0, NEXT is the key of the first element to be
4686 removed, BEG and END is buffer position delimiting the
4687 modifications. Elements starting between them (inclusive) are
4688 removed and so are those contained within OUTREACH. PARENT, when
4689 non-nil, is the parent of the first element to be removed.
4691 During phase 1, NEXT is the key of the next known element in
4692 cache and BEG its beginning position. Parse buffer between that
4693 element and the one before it in order to determine the parent of
4694 the next element. Set PARENT to the element containing NEXT.
4696 During phase 2, NEXT is the key of the next element to shift in
4697 the parse tree. All elements starting from this one have their
4698 properties relatives to buffer positions shifted by integer
4699 OFFSET and, if they belong to element PARENT, are adopted by it.
4707 "Hash table used to store keys during synchronization.
4711 "Return a unique key for ELEMENT in cache tree.
4713 Keys are used to keep a total order among elements in the cache.
4714 Comparison is done with `org-element--cache-key-less-p'.
4716 When no synchronization is taking place, a key is simply the
4717 beginning position of the element, or that position plus one in
4718 the case of an first item (respectively row) in
4719 a list (respectively a table).
4721 During a synchronization, the key is the one the element had when
4722 the cache was synchronized for the last time. Elements added to
4723 cache during the synchronization get a new key generated with
4724 `org-element--cache-generate-key'.
4726 Such keys are stored in `org-element--cache-sync-keys'. The hash
4727 table is cleared once the synchronization is complete."
4730 ;; Increase beginning position of items (respectively
4731 ;; table rows) by one, so the first item can get
4732 ;; a different key from its parent list (respectively
4733 ;; table).
4736 begin)))
4739 key))))
4742 "Generate a key between LOWER and UPPER.
4744 LOWER and UPPER are integers or lists, possibly empty.
4746 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4747 a unique key, as an integer or a list of integers, according to
4748 the following rules:
4750 - LOWER and UPPER are compared level-wise until values differ.
4752 - If, at a given level, LOWER and UPPER differ from more than
4753 2, the new key shares all the levels above with LOWER and
4754 gets a new level. Its value is the mean between LOWER and
4755 UPPER:
4757 \(1 2) + (1 4) --> (1 3)
4759 - If LOWER has no value to compare with, it is assumed that its
4760 value is `most-negative-fixnum'. E.g.,
4762 \(1 1) + (1 1 2)
4764 is equivalent to
4766 \(1 1 m) + (1 1 2)
4768 where m is `most-negative-fixnum'. Likewise, if UPPER is
4769 short of levels, the current value is `most-positive-fixnum'.
4771 - If they differ from only one, the new key inherits from
4772 current LOWER level and fork it at the next level. E.g.,
4774 \(2 1) + (3 3)
4776 is equivalent to
4778 \(2 1) + (2 M)
4780 where M is `most-positive-fixnum'.
4782 - If the key is only one level long, it is returned as an
4783 integer:
4785 \(1 2) + (3 2) --> 2
4787 When they are not equals, the function assumes that LOWER is
4788 lesser than UPPER, per `org-element--cache-key-less-p'."
4792 skip-upper key)
4803 ;; When at a given level, LOWER and UPPER differ from
4804 ;; 1, ignore UPPER altogether. Instead create a key
4805 ;; between LOWER and the greatest key with the same
4806 ;; prefix as LOWER so far.
4812 "Non-nil if key A is less than key B.
4813 A and B are either integers or lists of integers, as returned by
4814 `org-element--cache-key'."
4822 ;; If A is empty, either keys are equal (B is also empty) and
4823 ;; we return nil, or A is lesser than B (B is longer) and we
4824 ;; return a non-nil value.
4825 ;;
4826 ;; If A is not empty, B is necessarily empty and A is greater
4827 ;; than B (A is longer). Therefore, return nil.
4831 "Non-nil when element A is located before element B."
4836 "Return root value in cache.
4837 This function assumes `org-element--cache' is a valid AVL tree."
4841 ;;;; Tools
4844 "Non-nil when cache is active in current buffer."
4849 "Find element in cache starting at POS or before.
4851 POS refers to a buffer position.
4853 When optional argument SIDE is non-nil, the function checks for
4854 elements starting at or past POS instead. If SIDE is `both', the
4855 function returns a cons cell where car is the first element
4856 starting at or before POS and cdr the first element starting
4857 after POS.
4859 The function can only find elements in the synchronized part of
4860 the cache."
4864 lower upper)
4879 ;; We found an element in cache starting at POS. If `side'
4880 ;; is `both' we also want the next one in order to generate
4881 ;; a key in-between.
4882 ;;
4883 ;; If the element is the first row or item in a table or
4884 ;; a plain list, we always return the table or the plain
4885 ;; list.
4886 ;;
4887 ;; In any other case, we return the element found.
4896 lower parent
4897 upper parent)))))
4900 lower element
4901 upper element)))))
4908 "Store ELEMENT in current buffer's cache, if allowed.
4909 When optional argument DATA is non-nil, assume is it object data
4910 relative to ELEMENT and store it in the objects cache."
4914 ;; During synchronization, first build an appropriate key
4915 ;; for the new element so `avl-tree-enter' can insert it at
4916 ;; the right spot in the cache.
4925 org-element--cache-sync-keys)))
4927 ;; Headlines are not stored in cache, so objects in titles are
4928 ;; not stored either.
4933 "Remove ELEMENT from cache.
4934 Assume ELEMENT belongs to cache and that a cache is active."
4939 ;;;; Synchronization
4942 "Set idle timer for cache synchronization in BUFFER."
4949 org-element-cache-sync-idle-time))
4950 nil
4951 #'org-element--cache-sync
4952 buffer)))
4955 "Non-nil when synchronization process should be interrupted.
4956 TIME-LIMIT is a time value or nil."
4962 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4964 Properties containing buffer positions are `:begin', `:end',
4965 `:contents-begin', `:contents-end' and `:structure'. When
4966 optional argument PROPS is a list of keywords, only shift
4967 properties provided in that list.
4969 Properties are modified by side-effect."
4971 ;; Shift `:structure' property for the first plain list only: it
4972 ;; is the only one that really matters and it prevents from
4973 ;; shifting it more than once.
4987 "Synchronize cache with recent modification in BUFFER.
4989 When optional argument THRESHOLD is non-nil, do the
4990 synchronization for all elements starting before or at threshold,
4991 then exit. Otherwise, synchronize cache for as long as
4992 `org-element-cache-sync-duration' or until Emacs leaves idle
4993 state.
4995 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4996 not registered yet in the cache are going to happen. It is used
4997 in `org-element--cache-submit-request', where cache is partially
4998 updated before current modification are actually submitted."
5009 request
5011 threshold
5014 org-element-cache-sync-duration))
5015 future-change)
5016 ;; Request processed. Merge current and next offsets and
5017 ;; transfer ending position.
5023 ;; If more requests are awaiting, set idle timer accordingly.
5024 ;; Otherwise, reset keys.
5031 "Process synchronization REQUEST for all entries before NEXT.
5033 REQUEST is a vector, built by `org-element--cache-submit-request'.
5035 NEXT is a cache key, as returned by `org-element--cache-key'.
5037 When non-nil, THRESHOLD is a buffer position. Synchronization
5038 stops as soon as a shifted element begins after it.
5040 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5041 after this time or when Emacs exits idle state.
5043 When non-nil, FUTURE-CHANGE is a buffer position where changes
5044 not registered yet in the cache are going to happen. See
5045 `org-element--cache-submit-request' for more information.
5047 Throw `interrupt' if the process stops before completing the
5048 request."
5051 ;; Phase 0.
5052 ;;
5053 ;; Delete all elements starting after BEG, but not after buffer
5054 ;; position END or past element with key NEXT.
5055 ;;
5056 ;; At each iteration, we start again at tree root since
5057 ;; a deletion modifies structure of the balanced tree.
5065 ;; Find first element in cache with key BEG or after it.
5075 data-key key
5078 data-key key
5079 node nil)))))
5088 up))
5094 ;; No element starting after modifications left in
5095 ;; cache: further processing is futile.
5098 ;; Phase 1.
5099 ;;
5100 ;; Phase 0 left a hole in the cache. Some elements after it
5101 ;; could have parents within. For example, in the following
5102 ;; buffer:
5103 ;;
5104 ;; - item
5105 ;;
5106 ;;
5107 ;; Paragraph1
5108 ;;
5109 ;; Paragraph2
5110 ;;
5111 ;; if we remove a blank line between "item" and "Paragraph1",
5112 ;; everything down to "Paragraph2" is removed from cache. But
5113 ;; the paragraph now belongs to the list, and its `:parent'
5114 ;; property no longer is accurate.
5115 ;;
5116 ;; Therefore we need to parse again elements in the hole, or at
5117 ;; least in its last section, so that we can re-parent
5118 ;; subsequent elements, during phase 2.
5119 ;;
5120 ;; Note that we only need to get the parent from the first
5121 ;; element in cache after the hole.
5122 ;;
5123 ;; When next key is lesser or equal to the current one, delegate
5124 ;; phase 1 processing to next request in order to preserve key
5125 ;; order among requests.
5133 ;; Next element will start at its beginning position plus
5134 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5135 ;; contains the real beginning position of the first element to
5136 ;; shift and re-parent.
5140 ;; Changes are going to happen around this element and
5141 ;; they will trigger another phase 1 request. Skip the
5142 ;; current one.
5148 ;; Phase 2.
5149 ;;
5150 ;; Shift all elements starting from key START, but before NEXT, by
5151 ;; OFFSET, and re-parent them when appropriate.
5152 ;;
5153 ;; Elements are modified by side-effect so the tree structure
5154 ;; remains intact.
5155 ;;
5156 ;; Once THRESHOLD, if any, is reached, or once there is an input
5157 ;; pending, exit. Before leaving, the current synchronization
5158 ;; request is updated.
5165 exit-flag)
5166 ;; No re-parenting nor shifting planned: request is over.
5176 ;; We reached NEXT. Request is complete.
5178 ;; Handle interruption request. Update current request.
5183 ;; Shift element.
5186 ;; Shift associated objects data, if any.
5191 ;; Update PARENT and re-parent DATA, only when
5192 ;; necessary. Propagate new structures for lists.
5206 ;; Cache is up-to-date past THRESHOLD. Request
5207 ;; interruption.
5212 ;; We reached end of tree: synchronization complete.
5213 t)))
5216 "Parse elements in current section, down to POS.
5218 Start parsing from the closest between the last known element in
5219 cache or headline above. Return the smallest element containing
5220 POS.
5222 When optional argument SYNCP is non-nil, return the parent of the
5223 element containing POS instead. In that case, it is also
5224 possible to provide TIME-LIMIT, which is a time value specifying
5225 when the parsing should stop. The function throws `interrupt' if
5226 the process stopped before finding the expected result."
5233 element next mode)
5235 ;; Nothing in cache before point: start parsing from first
5236 ;; element following headline above, or first element in
5237 ;; buffer.
5244 ;; Cache returned exact match: return it.
5247 ;; There's a headline between cached value and POS: cached
5248 ;; value is invalid. Start parsing from first element
5249 ;; following the headline.
5256 ;; Check if CACHED or any of its ancestors contain point.
5257 ;;
5258 ;; If there is such an element, we inspect it in order to know
5259 ;; if we return it or if we need to parse its contents.
5260 ;; Otherwise, we just start parsing from current location,
5261 ;; which is right after the top-most element containing
5262 ;; CACHED.
5263 ;;
5264 ;; As a special case, if POS is at the end of the buffer, we
5265 ;; want to return the innermost element ending there.
5266 ;;
5267 ;; Also, if we find an ancestor and discover that we need to
5268 ;; parse its contents, make sure we don't start from
5269 ;; `:contents-begin', as we would otherwise go past CACHED
5270 ;; again. Instead, in that situation, we will resume parsing
5271 ;; from NEXT, which is located after CACHED or its higher
5272 ;; ancestor not containing point.
5284 ;; Parse successively each element until we reach POS.
5297 end 'element mode
5304 ;; Skip any element ending before point. Also skip
5305 ;; element ending at point (unless it is also the end of
5306 ;; buffer) since we're sure that another element begins
5307 ;; after it.
5311 ;; A non-greater element contains point: return it.
5314 ;; Otherwise, we have to decide if ELEMENT really
5315 ;; contains POS. In that case we start parsing from
5316 ;; contents' beginning.
5317 ;;
5318 ;; If POS is at contents' beginning but it is also at
5319 ;; the beginning of the first item in a list or a table.
5320 ;; In that case, we need to create an anchor for that
5321 ;; list or table, so return it.
5322 ;;
5323 ;; Also, if POS is at the end of the buffer, no element
5324 ;; can start after it, but more than one may end there.
5325 ;; Arbitrarily, we choose to return the innermost of
5326 ;; such elements.
5339 parent element
5340 end cend))))
5341 ;; Otherwise, return ELEMENT as it is the smallest
5342 ;; element containing POS.
5347 ;;;; Staging Buffer Changes
5353 ;; Blocks
5355 ;; LaTeX environments.
5357 ;; Drawers.
5360 "Regexp matching a sensitive line, structure wise.
5361 A sensitive line is a headline, inlinetask, block, drawer, or
5362 latex-environment boundary. When such a line is modified,
5363 structure changes in the document may propagate in the whole
5367 "Non-nil when a sensitive line is about to be changed.
5371 "Request extension of area going to be modified if needed.
5372 BEG and END are the beginning and end of the range of changed
5373 text. See `before-change-functions' for more information."
5383 'headline
5386 org-element--cache-sensitive-re bottom t)))))))))
5389 "Update buffer modifications for current buffer.
5390 BEG and END are the beginning and end of the range of changed
5391 text, and the length in bytes of the pre-change text replaced by
5392 that range. See `after-change-functions' for more information."
5400 ;; Determine if modified area needs to be extended, according
5401 ;; to both previous and current state. We make a special
5402 ;; case for headline editing: if a headline is modified but
5403 ;; not removed, do not extend.
5412 org-element--cache-sensitive-re bottom t))))
5413 ;; Effectively extend modified area.
5421 ;; Store synchronization request.
5424 ;; Activate a timer to process the request during idle time.
5428 "Return first element to remove from cache.
5430 BEG and END are buffer positions delimiting buffer modifications.
5431 OFFSET is the size of the changes.
5433 Returned element is usually the first element in cache containing
5434 any position between BEG and END. As an exception, greater
5435 elements around the changes that are robust to contents
5436 modifications are preserved and updated according to the
5437 changes."
5447 quote-block special-block))
5452 ;; UP is a robust greater element containing changes.
5453 ;; We only need to extend its ending boundaries.
5459 ;; We're at top level element containing ELEMENT: if it's
5460 ;; altered by buffer modifications, it is first element in
5461 ;; cache to be removed. Otherwise, that first element is the
5462 ;; following one.
5463 ;;
5464 ;; As a special case, do not remove BEFORE if it is a robust
5465 ;; container for current changes.
5467 before)))))
5470 "Submit a new cache synchronization request for current buffer.
5471 BEG and END are buffer positions delimiting the minimal area
5472 where cache data should be removed. OFFSET is the size of the
5473 change, as an integer."
5475 delete-to delete-from)
5480 ;; Current changes can be merged with first sync request: we
5481 ;; can save a partial cache synchronization.
5484 ;; If last change happened within area to be removed, extend
5485 ;; boundaries of robust parents, if any. Otherwise, find
5486 ;; first element to remove and update request accordingly.
5498 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5499 ;; if any, is no longer a 0-phase request, thus ensuring that
5500 ;; phases are properly ordered. We need to provide OFFSET as
5501 ;; optional parameter since current modifications are not known
5502 ;; yet to the otherwise correct part of the cache (i.e, before
5503 ;; the first request).
5510 ;; When changes happen before the first known
5511 ;; element, re-parent and shift the rest of the
5512 ;; cache.
5514 ;; Otherwise, we find the first non robust
5515 ;; element containing END. All elements between
5516 ;; FIRST and this one are to be removed.
5517 ;;
5518 ;; Among them, some could be located outside the
5519 ;; synchronized part of the cache, in which case
5520 ;; comparing buffer positions to find them is
5521 ;; useless. Instead, we store the element
5522 ;; containing them in the request itself. All
5523 ;; its children will be removed.
5535 element up))
5538 org-element--cache-sync-requests)
5539 ;; No element to remove. No need to re-parent either.
5540 ;; Simply shift additional elements, if any, by OFFSET.
5545 ;;;; Public Functions
5547 ;;;###autoload
5549 "Reset cache in current buffer.
5550 When optional argument ALL is non-nil, reset cache in all Org
5551 buffers."
5569 ;;;###autoload
5571 "Refresh cache at position POS."
5578 \f
5579 ;;; The Toolbox
5580 ;;
5581 ;; The first move is to implement a way to obtain the smallest element
5582 ;; containing point. This is the job of `org-element-at-point'. It
5583 ;; basically jumps back to the beginning of section containing point
5584 ;; and proceed, one element after the other, with
5585 ;; `org-element--current-element' until the container is found. Note:
5586 ;; When using `org-element-at-point', secondary values are never
5587 ;; parsed since the function focuses on elements, not on objects.
5588 ;;
5589 ;; At a deeper level, `org-element-context' lists all elements and
5590 ;; objects containing point.
5591 ;;
5592 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5593 ;; internally by navigation and manipulation tools.
5596 ;;;###autoload
5598 "Determine closest element around point.
5600 Return value is a list like (TYPE PROPS) where TYPE is the type
5601 of the element and PROPS a plist of properties associated to the
5602 element.
5604 Possible types are defined in `org-element-all-elements'.
5605 Properties depend on element or object type, but always include
5606 `:begin', `:end', `:parent' and `:post-blank' properties.
5608 As a special case, if point is at the very beginning of the first
5609 item in a list or sub-list, returned element will be that list
5610 instead of the item. Likewise, if point is at the beginning of
5611 the first row of a table, returned element will be the table
5612 instead of the first row.
5614 When point is at the end of the buffer, return the innermost
5615 element ending there."
5621 ;; Within blank lines at the beginning of buffer, return nil.
5623 ;; Within blank lines right after a headline, return that
5624 ;; headline.
5628 ;; Otherwise parse until we find element containing ORIGIN.
5635 ;;;###autoload
5637 "Return smallest element or object around point.
5639 Return value is a list like (TYPE PROPS) where TYPE is the type
5640 of the element or object and PROPS a plist of properties
5641 associated to it.
5643 Possible types are defined in `org-element-all-elements' and
5644 `org-element-all-objects'. Properties depend on element or
5645 object type, but always include `:begin', `:end', `:parent' and
5646 `:post-blank'.
5648 As a special case, if point is right after an object and not at
5649 the beginning of any other object, return that object.
5651 Optional argument ELEMENT, when non-nil, is the closest element
5652 containing point, as returned by `org-element-at-point'.
5653 Providing it allows for quicker computation."
5659 ;; If point is inside an element containing objects or
5660 ;; a secondary string, narrow buffer to the container and
5661 ;; proceed with parsing. Otherwise, return ELEMENT.
5663 ;; At a parsed affiliated keyword, check if we're inside main
5664 ;; or dual value.
5671 org-element-parsed-keywords))
5680 ;; Also change type to retrieve correct restrictions.
5682 ;; At an item, objects can only be located within tag, if any.
5692 ;; At an headline or inlinetask, objects are in title.
5699 ;; At a paragraph, a table-row or a verse block, objects are
5700 ;; located within their contents.
5704 ;; CBEG is nil for table rules.
5709 ;; At a parsed keyword, objects are located within value.
5712 org-element-document-properties))
5719 ;; At a planning line, if point is at a timestamp, return it,
5720 ;; otherwise, return element.
5728 ;; All other locations cannot contain objects: bail out.
5738 next object-data last)
5742 ;; When entering PARENT for the first time, get list
5743 ;; of objects within known so far. Store it in
5744 ;; OBJECT-DATA.
5749 ;; Find NEXT object for analysis.
5751 ;; If NEXT is non-nil, we already exhausted the
5752 ;; cache so we can parse buffer to find the object
5753 ;; after it.
5755 ;; Otherwise, check if cache can help us.
5766 ;; Cache contains the information needed.
5769 pos)
5771 pos)
5777 ;; If we have a new object to analyze, store it in
5778 ;; cache. Otherwise record that there is nothing
5779 ;; more to parse in this element at this depth.
5784 ;; Process NEXT, if any, in order to know if we need
5785 ;; to skip it, return it or move into it.
5792 ;; Skip objects ending before point. Also skip
5793 ;; objects ending at point unless it is also the
5794 ;; end of buffer, since we want to return the
5795 ;; innermost object.
5798 ;; For convenience, when object ends at POS,
5799 ;; without any space, store it in LAST, as we
5800 ;; will return it if no object starts here.
5804 ;; If POS is within a container object, move
5805 ;; into that object.
5809 ;; At contents' end, if there is no
5810 ;; space before point, also move into
5811 ;; object, for consistency with
5812 ;; convenience feature above.
5821 next nil
5822 object-data nil))
5823 ;; Otherwise, return NEXT.
5825 ;; Store results in cache, if applicable.
5829 "List all ancestors of a given element or object.
5831 BLOB is an object or element.
5833 When optional argument TYPES is a list of symbols, return the
5834 first element or object in the lineage whose type belongs to that
5835 list.
5837 When optional argument WITH-SELF is non-nil, lineage includes
5838 BLOB itself as the first element, and TYPES, if provided, also
5839 apply to it.
5841 When BLOB is obtained through `org-element-context' or
5842 `org-element-at-point', only ancestors from its section can be
5843 found. There is no such limitation when BLOB belongs to a full
5844 parse tree."
5846 ancestors)
5853 "Non-nil when elements ELEM-A and ELEM-B are nested."
5862 "Swap elements ELEM-A and ELEM-B.
5863 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5864 end of ELEM-A."
5866 ;; There are two special cases when an element doesn't start at bol:
5867 ;; the first paragraph in an item or in a footnote definition.
5869 ;; Only a paragraph without any affiliated keyword can be moved at
5870 ;; ELEM-A position in such a situation. Note that the case of
5871 ;; a footnote definition is impossible: it cannot contain two
5872 ;; paragraphs in a row because it cannot contain a blank line.
5878 ;; In a special situation, ELEM-A will have no indentation. We'll
5879 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5893 ;; Store inner overlays responsible for visibility status.
5894 ;; We also need to store their boundaries as they will be
5895 ;; removed from buffer.
5910 ;; Get contents.
5918 ;; Restore ex ELEM-A overlays.
5925 ;; Restore ex ELEM-B overlays.
5931 "Remove maximum common indentation in string S and return it.
5932 When optional argument N is a positive integer, remove exactly
5933 that much characters from indentation, if possible, or return
5934 S as-is otherwise. Unlike to `org-remove-indentation', this
5935 function doesn't call `untabify' on S."
5940 ;; Find maximum common indentation, if not specified.
5948 min-ind)))
5950 ;; Remove exactly N indentation, but give up if not possible.
5963 ;; Local variables:
5964 ;; generated-autoload-file: "org-loaddefs.el"
5965 ;; End:
5967 ;;; org-element.el ends here