| blob | 4ef76a286a11119be01e1442ce1b9c6944297a67 |
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
409 "Table used internally to pair only square brackets.
413 \f
414 ;;; Accessors and Setters
415 ;;
416 ;; Provide four accessors: `org-element-type', `org-element-property'
417 ;; `org-element-contents' and `org-element-restriction'.
418 ;;
419 ;; Setter functions allow to modify elements by side effect. There is
420 ;; `org-element-put-property', `org-element-set-contents'. These
421 ;; low-level functions are useful to build a parse tree.
422 ;;
423 ;; `org-element-adopt-element', `org-element-set-element',
424 ;; `org-element-extract-element' and `org-element-insert-before' are
425 ;; high-level functions useful to modify a parse tree.
426 ;;
427 ;; `org-element-secondary-p' is a predicate used to know if a given
428 ;; object belongs to a secondary string. `org-element-copy' returns
429 ;; an element or object, stripping its parent property in the process.
432 "Return type of ELEMENT.
434 The function returns the type of the element or object provided.
435 It can also return the following special value:
436 `plain-text' for a string
437 `org-data' for a complete document
438 nil in any other case."
444 "Extract the value from the PROPERTY of an ELEMENT."
449 "Extract contents from an ELEMENT."
455 "Return restriction associated to ELEMENT.
456 ELEMENT can be an element, an object or a symbol representing an
457 element or object type."
459 org-element-object-restrictions)))
462 "In ELEMENT set PROPERTY to VALUE.
463 Return modified element."
466 element))
469 "Set ELEMENT contents to CONTENTS."
476 "Non-nil when OBJECT belongs to a secondary string.
477 Return value is the property name, as a keyword, or nil."
480 org-element-secondary-value-alist))))
483 property)))
486 "Append elements to the contents of another element.
488 PARENT is an element or object. CHILDREN can be elements,
489 objects, or a strings.
491 The function takes care of setting `:parent' property for CHILD.
492 Return parent element."
493 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
494 ;; string: parent is the list itself.
497 children)
498 ;; Add CHILDREN at the end of PARENT contents.
501 parent
503 ;; Return modified PARENT element.
507 "Extract ELEMENT from parse tree.
508 Remove element from the parse tree by side-effect, and return it
509 with its `:parent' property stripped out."
514 parent secondary
517 parent
519 ;; Return ELEMENT with its :parent removed.
523 "Insert ELEMENT before LOCATION in parse tree.
524 LOCATION is an element, object or string within the parse tree.
525 Parse tree is modified by side effect."
530 ;; Special case: LOCATION is the first element of an
531 ;; independent secondary string (e.g. :title property). Add
532 ;; ELEMENT in-place.
536 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
546 ;; Store SIBLINGS at appropriate place in parse tree.
551 ;; Set appropriate :parent property.
555 "Replace element or object OLD with element or object NEW.
556 The function takes care of setting `:parent' property for NEW."
557 ;; Ensure OLD and NEW have the same parent.
561 ;; We cannot replace OLD with NEW since one of them is not an
562 ;; object or element. We take the long path.
565 ;; Since OLD is going to be changed into NEW by side-effect, first
566 ;; make sure that every element or object within NEW has OLD as
567 ;; parent.
570 ;; Transfer contents.
572 ;; Overwrite OLD's properties with NEW's.
574 ;; Transfer type.
578 "Return a copy of DATUM.
579 DATUM is an element, object, string or nil. `:parent' property
580 is cleared and contents are removed in the process."
591 \f
592 ;;; Greater elements
593 ;;
594 ;; For each greater element type, we define a parser and an
595 ;; interpreter.
596 ;;
597 ;; A parser returns the element or object as the list described above.
598 ;; Most of them accepts no argument. Though, exceptions exist. Hence
599 ;; every element containing a secondary string (see
600 ;; `org-element-secondary-value-alist') will accept an optional
601 ;; argument to toggle parsing of that secondary string. Moreover,
602 ;; `item' parser requires current list's structure as its first
603 ;; element.
604 ;;
605 ;; An interpreter accepts two arguments: the list representation of
606 ;; the element or object, and its contents. The latter may be nil,
607 ;; depending on the element or object considered. It returns the
608 ;; appropriate Org syntax, as a string.
609 ;;
610 ;; Parsing functions must follow the naming convention:
611 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
612 ;; defined in `org-element-greater-elements'.
613 ;;
614 ;; Similarly, interpreting functions must follow the naming
615 ;; convention: org-element-TYPE-interpreter.
616 ;;
617 ;; With the exception of `headline' and `item' types, greater elements
618 ;; cannot contain other greater elements of their own type.
619 ;;
620 ;; Beside implementing a parser and an interpreter, adding a new
621 ;; greater element requires to tweak `org-element--current-element'.
622 ;; Moreover, the newly defined type must be added to both
623 ;; `org-element-all-elements' and `org-element-greater-elements'.
626 ;;;; Center Block
629 "Parse a center block.
631 LIMIT bounds the search. AFFILIATED is a list of which CAR is
632 the buffer position at the beginning of the first affiliated
633 keyword and CDR is a plist of affiliated keywords along with
634 their value.
636 Return a list whose CAR is `center-block' and CDR is a plist
637 containing `:begin', `:end', `:contents-begin', `:contents-end',
638 `:post-blank' and `:post-affiliated' keywords.
640 Assume point is at the beginning of the block."
644 ;; Incomplete block: parse it as a paragraph.
649 ;; Empty blocks have no contents.
663 :end end
664 :contents-begin contents-begin
665 :contents-end contents-end
671 "Interpret CENTER-BLOCK element as Org syntax.
672 CONTENTS is the contents of the element."
676 ;;;; Drawer
679 "Parse a drawer.
681 LIMIT bounds the search. AFFILIATED is a list of which CAR is
682 the buffer position at the beginning of the first affiliated
683 keyword and CDR is a plist of affiliated keywords along with
684 their value.
686 Return a list whose CAR is `drawer' and CDR is a plist containing
687 `:drawer-name', `:begin', `:end', `:contents-begin',
688 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
690 Assume point is at beginning of drawer."
693 ;; Incomplete drawer: parse it as a paragraph.
701 ;; Empty drawers have no contents.
714 :end end
715 :drawer-name name
716 :contents-begin contents-begin
717 :contents-end contents-end
723 "Interpret DRAWER element as Org syntax.
724 CONTENTS is the contents of the element."
727 contents))
730 ;;;; Dynamic Block
733 "Parse a dynamic block.
735 LIMIT bounds the search. AFFILIATED is a list of which CAR is
736 the buffer position at the beginning of the first affiliated
737 keyword and CDR is a plist of affiliated keywords along with
738 their value.
740 Return a list whose CAR is `dynamic-block' and CDR is a plist
741 containing `:block-name', `:begin', `:end', `:contents-begin',
742 `:contents-end', `:arguments', `:post-blank' and
743 `:post-affiliated' keywords.
745 Assume point is at beginning of dynamic block."
749 ;; Incomplete block: parse it as a paragraph.
758 ;; Empty blocks have no contents.
771 :end end
772 :block-name name
773 :arguments arguments
774 :contents-begin contents-begin
775 :contents-end contents-end
781 "Interpret DYNAMIC-BLOCK element as Org syntax.
782 CONTENTS is the contents of the element."
787 contents))
790 ;;;; Footnote Definition
793 "Parse a footnote definition.
795 LIMIT bounds the search. AFFILIATED is a list of which CAR is
796 the buffer position at the beginning of the first affiliated
797 keyword and CDR is a plist of affiliated keywords along with
798 their value.
800 Return a list whose CAR is `footnote-definition' and CDR is
801 a plist containing `:label', `:begin' `:end', `:contents-begin',
802 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
804 Assume point is at the beginning of the footnote definition."
832 :begin begin
833 :end end
834 :contents-begin contents-begin
835 :contents-end contents-end
841 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
842 CONTENTS is the contents of the footnote-definition."
844 " "
845 contents))
848 ;;;; Headline
851 "Return node properties associated to headline at point.
852 Upcase property names. It avoids confusion between properties
853 obtained through property drawer and default properties from the
854 parser (e.g. `:end' and :END:). Return value is a plist."
866 properties))))
869 "Return time properties associated to headline at point.
870 Return value is a plist."
884 plist))))
887 "Parse a headline.
889 Return a list whose CAR is `headline' and CDR is a plist
890 containing `:raw-value', `:title', `:begin', `:end',
891 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
892 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
893 `:deadline', `:closed', `:archivedp', `:commentedp'
894 `:footnote-section-p', `:post-blank' and `:post-affiliated'
895 keywords.
897 The plist also contains any property set in the property drawer,
898 with its name in upper cases and colons added at the
899 beginning (e.g., `:CUSTOM_ID').
901 LIMIT is a buffer position bounding the search.
903 When RAW-SECONDARY-P is non-nil, headline's title will not be
904 parsed as a secondary string, but as a plain string instead.
906 Assume point is at beginning of the headline."
949 ;; Clean TAGS from archive tag, if any.
955 :begin begin
956 :end end
957 :pre-blank
960 :contents-begin contents-begin
961 :contents-end contents-end
962 :level level
963 :priority priority
964 :tags tags
965 :todo-keyword todo
966 :todo-type todo-type
969 end)
970 :footnote-section-p footnote-section-p
971 :archivedp archivedp
972 :commentedp commentedp
974 time-props
975 standard-props))))
977 headline :title
986 nil
992 "Interpret HEADLINE element as Org syntax.
993 CONTENTS is the contents of the element."
1009 ?*)
1013 " "
1016 org-footnote-section
1017 title))))
1019 heading
1020 ;; Align tags.
1028 ?\s)
1029 tags))
1033 tags))))
1035 contents)))
1038 ;;;; Inlinetask
1041 "Parse an inline task.
1043 Return a list whose CAR is `inlinetask' and CDR is a plist
1044 containing `:title', `:begin', `:end', `:contents-begin' and
1045 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1046 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1047 `:closed', `:post-blank' and `:post-affiliated' keywords.
1049 The plist also contains any property set in the property drawer,
1050 with its name in upper cases and colons added at the
1051 beginning (e.g., `:CUSTOM_ID').
1053 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1054 title will not be parsed as a secondary string, but as a plain
1055 string instead.
1057 Assume point is at beginning of the inline task."
1102 :begin begin
1103 :end end
1104 :contents-begin contents-begin
1105 :contents-end contents-end
1106 :level level
1107 :priority priority
1108 :tags tags
1109 :todo-keyword todo
1110 :todo-type todo-type
1113 time-props
1114 standard-props))))
1116 inlinetask :title
1125 nil
1131 "Interpret INLINETASK element as Org syntax.
1132 CONTENTS is the contents of inlinetask."
1146 ;; Align tags.
1154 ? )
1155 tags))
1159 tags))))
1160 ;; Prefer degenerate inlinetasks when there are no
1161 ;; contents.
1164 contents
1168 ;;;; Item
1171 "Parse an item.
1173 STRUCT is the structure of the plain list.
1175 Return a list whose CAR is `item' and CDR is a plist containing
1176 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1177 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1178 `:post-affiliated' keywords.
1180 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1181 any, will not be parsed as a secondary string, but as a plain
1182 string instead.
1184 Assume point is at the beginning of the item."
1208 ;; Ignore tags in un-ordered lists: they are just
1209 ;; a part of item's body.
1215 ;; If first line isn't empty, contents really start
1216 ;; at the text after item's meta-data.
1225 :begin begin
1226 :end end
1227 ;; CONTENTS-BEGIN and CONTENTS-END may be
1228 ;; mixed up in the case of an empty item
1229 ;; separated from the next by a blank line.
1230 ;; Thus ensure the former is always the
1231 ;; smallest.
1234 :checkbox checkbox
1235 :counter counter
1236 :structure struct
1240 item :tag
1251 "Interpret ITEM element as Org syntax.
1252 CONTENTS is the contents of the element."
1262 ;; Compute indentation.
1267 ;; Indent contents.
1269 bullet
1283 ;;;; Plain List
1286 ;; Return structure of list at point. Internal function. See
1287 ;; `org-list-struct' for details.
1292 items struct)
1297 ;; At limit: end all items.
1306 ;; At list end: end all items.
1311 ;; At a new item: end previous sibling.
1323 ind
1324 bullet
1327 ;; Description tag.
1331 ;; Ending position, unknown so far.
1332 nil)))
1333 items))
1335 ;; Skip empty lines.
1337 ;; Skip inline tasks and blank lines along the way.
1344 ;; At some text line. Check if it ends any previous item.
1356 ;; Skip blocks (any type) and drawers contents.
1361 limit t)))
1367 "Parse a plain list.
1369 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1370 the buffer position at the beginning of the first affiliated
1371 keyword and CDR is a plist of affiliated keywords along with
1372 their value. STRUCTURE is the structure of the plain list being
1373 parsed.
1375 Return a list whose CAR is `plain-list' and CDR is a plist
1376 containing `:type', `:begin', `:end', `:contents-begin' and
1377 `:contents-end', `:structure', `:post-blank' and
1378 `:post-affiliated' keywords.
1380 Assume point is at the beginning of the list."
1394 pos))
1398 ;; Return value.
1402 :begin begin
1403 :end end
1404 :contents-begin contents-begin
1405 :contents-end contents-end
1406 :structure struct
1412 "Interpret PLAIN-LIST element as Org syntax.
1413 CONTENTS is the contents of the element."
1421 ;;;; Property Drawer
1424 "Parse a property drawer.
1426 LIMIT bounds the search.
1428 Return a list whose car is `property-drawer' and cdr is a plist
1429 containing `:begin', `:end', `:contents-begin', `:contents-end',
1430 `:post-blank' and `:post-affiliated' keywords.
1432 Assume point is at the beginning of the property drawer."
1445 :end end
1447 :contents-end contents-end
1452 "Interpret PROPERTY-DRAWER element as Org syntax.
1453 CONTENTS is the properties within the drawer."
1457 ;;;; Quote Block
1460 "Parse a quote block.
1462 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1463 the buffer position at the beginning of the first affiliated
1464 keyword and CDR is a plist of affiliated keywords along with
1465 their value.
1467 Return a list whose CAR is `quote-block' and CDR is a plist
1468 containing `:begin', `:end', `:contents-begin', `:contents-end',
1469 `:post-blank' and `:post-affiliated' keywords.
1471 Assume point is at the beginning of the block."
1475 ;; Incomplete block: parse it as a paragraph.
1481 ;; Empty blocks have no contents.
1494 :end end
1495 :contents-begin contents-begin
1496 :contents-end contents-end
1502 "Interpret QUOTE-BLOCK element as Org syntax.
1503 CONTENTS is the contents of the element."
1507 ;;;; Section
1510 "Parse a section.
1512 LIMIT bounds the search.
1514 Return a list whose CAR is `section' and CDR is a plist
1515 containing `:begin', `:end', `:contents-begin', `contents-end',
1516 `:post-blank' and `:post-affiliated' keywords."
1518 ;; Beginning of section is the beginning of the first non-blank
1519 ;; line after previous headline.
1528 :end end
1529 :contents-begin begin
1530 :contents-end pos-before-blank
1535 "Interpret SECTION element as Org syntax.
1536 CONTENTS is the contents of the element."
1537 contents)
1540 ;;;; Special Block
1543 "Parse a special block.
1545 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1546 the buffer position at the beginning of the first affiliated
1547 keyword and CDR is a plist of affiliated keywords along with
1548 their value.
1550 Return a list whose CAR is `special-block' and CDR is a plist
1551 containing `:type', `:begin', `:end', `:contents-begin',
1552 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1554 Assume point is at the beginning of the block."
1561 limit t)))
1562 ;; Incomplete block: parse it as a paragraph.
1568 ;; Empty blocks have no contents.
1581 :begin begin
1582 :end end
1583 :contents-begin contents-begin
1584 :contents-end contents-end
1590 "Interpret SPECIAL-BLOCK element as Org syntax.
1591 CONTENTS is the contents of the element."
1596 \f
1597 ;;; Elements
1598 ;;
1599 ;; For each element, a parser and an interpreter are also defined.
1600 ;; Both follow the same naming convention used for greater elements.
1601 ;;
1602 ;; Also, as for greater elements, adding a new element type is done
1603 ;; through the following steps: implement a parser and an interpreter,
1604 ;; tweak `org-element--current-element' so that it recognizes the new
1605 ;; type and add that new type to `org-element-all-elements'.
1606 ;;
1607 ;; As a special case, when the newly defined type is a block type,
1608 ;; `org-element-block-name-alist' has to be modified accordingly.
1611 ;;;; Babel Call
1614 "Parse a babel call.
1616 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1617 the buffer position at the beginning of the first affiliated
1618 keyword and CDR is a plist of affiliated keywords along with
1619 their value.
1621 Return a list whose CAR is `babel-call' and CDR is a plist
1622 containing `:begin', `:end', `:value', `:post-blank' and
1623 `:post-affiliated' as keywords."
1637 :end end
1638 :value value
1644 "Interpret BABEL-CALL element as Org syntax.
1645 CONTENTS is nil."
1649 ;;;; Clock
1652 "Parse a clock.
1654 LIMIT bounds the search.
1656 Return a list whose CAR is `clock' and CDR is a plist containing
1657 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1658 `:post-affiliated' as keywords."
1678 :value value
1679 :duration duration
1680 :begin begin
1681 :end end
1682 :post-blank post-blank
1686 "Interpret CLOCK element as Org syntax.
1687 CONTENTS is nil."
1695 "%2s:%02s"
1699 ;;;; Comment
1702 "Parse a comment.
1704 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1705 the buffer position at the beginning of the first affiliated
1706 keyword and CDR is a plist of affiliated keywords along with
1707 their value.
1709 Return a list whose CAR is `comment' and CDR is a plist
1710 containing `:begin', `:end', `:value', `:post-blank',
1711 `:post-affiliated' keywords.
1713 Assume point is at comment beginning."
1722 ;; Get comments ending.
1725 ;; Accumulate lines without leading hash and first
1726 ;; whitespace.
1740 :end end
1741 :value value
1747 "Interpret COMMENT element as Org syntax.
1748 CONTENTS is nil."
1752 ;;;; Comment Block
1755 "Parse an export block.
1757 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1758 the buffer position at the beginning of the first affiliated
1759 keyword and CDR is a plist of affiliated keywords along with
1760 their value.
1762 Return a list whose CAR is `comment-block' and CDR is a plist
1763 containing `:begin', `:end', `:value', `:post-blank' and
1764 `:post-affiliated' keywords.
1766 Assume point is at comment block beginning."
1770 ;; Incomplete block: parse it as a paragraph.
1783 contents-begin contents-end)))
1787 :end end
1788 :value value
1794 "Interpret COMMENT-BLOCK element as Org syntax.
1795 CONTENTS is nil."
1802 ;;;; Diary Sexp
1805 "Parse a diary sexp.
1807 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1808 the buffer position at the beginning of the first affiliated
1809 keyword and CDR is a plist of affiliated keywords along with
1810 their value.
1812 Return a list whose CAR is `diary-sexp' and CDR is a plist
1813 containing `:begin', `:end', `:value', `:post-blank' and
1814 `:post-affiliated' keywords."
1826 :begin begin
1827 :end end
1833 "Interpret DIARY-SEXP as Org syntax.
1834 CONTENTS is nil."
1838 ;;;; Example Block
1841 "Parse an example block.
1843 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1844 the buffer position at the beginning of the first affiliated
1845 keyword and CDR is a plist of affiliated keywords along with
1846 their value.
1848 Return a list whose CAR is `example-block' and CDR is a plist
1849 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1850 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1851 `:value', `:post-blank' and `:post-affiliated' keywords."
1855 ;; Incomplete block: parse it as a paragraph.
1863 ;; Switches analysis
1870 ;; Should labels be retained in (or stripped from) example
1871 ;; blocks?
1876 ;; What should code-references use - labels or
1877 ;; line-numbers?
1886 ;; Standard block parsing.
1894 contents-begin contents-end))
1895 block-ind))
1904 :end end
1905 :value value
1906 :switches switches
1907 :number-lines number-lines
1908 :preserve-indent preserve-indent
1909 :retain-labels retain-labels
1910 :use-labels use-labels
1911 :label-fmt label-fmt
1917 "Interpret EXAMPLE-BLOCK element as Org syntax.
1918 CONTENTS is nil."
1926 value
1931 ;;;; Export Block
1934 "Parse an export block.
1936 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1937 the buffer position at the beginning of the first affiliated
1938 keyword and CDR is a plist of affiliated keywords along with
1939 their value.
1941 Return a list whose CAR is `export-block' and CDR is a plist
1942 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1943 `:post-affiliated' keywords.
1945 Assume point is at export-block beginning."
1952 ;; Incomplete block: parse it as a paragraph.
1965 contents-end)))
1969 :end end
1970 :type type
1971 :value value
1977 "Interpret EXPORT-BLOCK element as Org syntax.
1978 CONTENTS is nil."
1985 ;;;; Fixed-width
1988 "Parse a fixed-width section.
1990 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1991 the buffer position at the beginning of the first affiliated
1992 keyword and CDR is a plist of affiliated keywords along with
1993 their value.
1995 Return a list whose CAR is `fixed-width' and CDR is a plist
1996 containing `:begin', `:end', `:value', `:post-blank' and
1997 `:post-affiliated' keywords.
1999 Assume point is at the beginning of the fixed-width area."
2003 value
2008 ;; Accumulate text without starting colons.
2021 :end end
2022 :value value
2028 "Interpret FIXED-WIDTH element as Org syntax.
2029 CONTENTS is nil."
2037 ;;;; Horizontal Rule
2040 "Parse an horizontal rule.
2042 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2043 the buffer position at the beginning of the first affiliated
2044 keyword and CDR is a plist of affiliated keywords along with
2045 their value.
2047 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2048 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2049 keywords."
2059 :end end
2065 "Interpret HORIZONTAL-RULE element as Org syntax.
2066 CONTENTS is nil."
2070 ;;;; Keyword
2073 "Parse a keyword at point.
2075 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2076 the buffer position at the beginning of the first affiliated
2077 keyword and CDR is a plist of affiliated keywords along with
2078 their value.
2080 Return a list whose CAR is `keyword' and CDR is a plist
2081 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2082 `:post-affiliated' keywords."
2084 ;; An orphaned affiliated keyword is considered as a regular
2085 ;; keyword. In this case AFFILIATED is nil, so we take care of
2086 ;; this corner case.
2099 :value value
2100 :begin begin
2101 :end end
2107 "Interpret KEYWORD element as Org syntax.
2108 CONTENTS is nil."
2114 ;;;; Latex Environment
2118 "Regexp matching the beginning of a LaTeX environment.
2119 The environment is captured by the first group.
2125 "Format string matching the ending of a LaTeX environment.
2129 "Parse a LaTeX environment.
2131 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2132 the buffer position at the beginning of the first affiliated
2133 keyword and CDR is a plist of affiliated keywords along with
2134 their value.
2136 Return a list whose CAR is `latex-environment' and CDR is a plist
2137 containing `:begin', `:end', `:value', `:post-blank' and
2138 `:post-affiliated' keywords.
2140 Assume point is at the beginning of the latex environment."
2147 limit t))
2148 ;; Incomplete latex environment: parse it as a paragraph.
2158 :end end
2159 :value value
2165 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2166 CONTENTS is nil."
2170 ;;;; Node Property
2173 "Parse a node-property at point.
2175 LIMIT bounds the search.
2177 Return a list whose CAR is `node-property' and CDR is a plist
2178 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2179 `:post-affiliated' keywords."
2189 limit))))
2192 :value value
2193 :begin begin
2194 :end end
2199 "Interpret NODE-PROPERTY element as Org syntax.
2200 CONTENTS is nil."
2206 ;;;; Paragraph
2209 "Parse a paragraph.
2211 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2212 the buffer position at the beginning of the first affiliated
2213 keyword and CDR is a plist of affiliated keywords along with
2214 their value.
2216 Return a list whose CAR is `paragraph' and CDR is a plist
2217 containing `:begin', `:end', `:contents-begin' and
2218 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2220 Assume point is at the beginning of the paragraph."
2229 limit
2230 ;; A matching `org-element-paragraph-separate' is not
2231 ;; necessarily the end of the paragraph. In
2232 ;; particular, lines starting with # or : as a first
2233 ;; non-space character are ambiguous. We have to
2234 ;; check if they are valid Org syntax (e.g., not an
2235 ;; incomplete keyword).
2239 ;; There's no ambiguity for other symbols or
2240 ;; empty lines: stop here.
2242 ;; Stop at valid fixed-width areas.
2244 ;; Stop at drawers.
2249 ;; Stop at valid comments.
2251 ;; Stop at valid dynamic blocks.
2256 ;; Stop at valid blocks.
2263 limit t)))
2264 ;; Stop at valid latex environments.
2271 limit t)))
2272 ;; Stop at valid keywords.
2274 ;; Skip everything else.
2291 :end end
2292 :contents-begin contents-begin
2293 :contents-end contents-end
2299 "Interpret PARAGRAPH element as Org syntax.
2300 CONTENTS is the contents of the element."
2301 contents)
2304 ;;;; Planning
2307 "Parse a planning.
2309 LIMIT bounds the search.
2311 Return a list whose CAR is `planning' and CDR is a plist
2312 containing `:closed', `:deadline', `:scheduled', `:begin',
2313 `:end', `:post-blank' and `:post-affiliated' keywords."
2323 closed deadline scheduled)
2335 :deadline deadline
2336 :scheduled scheduled
2337 :begin begin
2338 :end end
2339 :post-blank post-blank
2343 "Interpret PLANNING element as Org syntax.
2344 CONTENTS is nil."
2346 'identity
2363 ;;;; Src Block
2366 "Parse a src block.
2368 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2369 the buffer position at the beginning of the first affiliated
2370 keyword and CDR is a plist of affiliated keywords along with
2371 their value.
2373 Return a list whose CAR is `src-block' and CDR is a plist
2374 containing `:language', `:switches', `:parameters', `:begin',
2375 `:end', `:number-lines', `:retain-labels', `:use-labels',
2376 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2377 `:post-affiliated' keywords.
2379 Assume point is at the beginning of the block."
2382 limit t)))
2383 ;; Incomplete block: parse it as a paragraph.
2389 ;; Get language as a string.
2398 ;; Get switches.
2400 ;; Get parameters.
2402 ;; Switches analysis
2413 ;; Should labels be retained in (or stripped from)
2414 ;; src blocks?
2419 ;; What should code-references use - labels or
2420 ;; line-numbers?
2425 ;; Indentation.
2427 ;; Retrieve code.
2432 block-ind))
2436 ;; Get position after ending blank lines.
2446 :begin begin
2447 :end end
2448 :number-lines number-lines
2449 :preserve-indent preserve-indent
2450 :retain-labels retain-labels
2451 :use-labels use-labels
2452 :label-fmt label-fmt
2453 :value value
2459 "Interpret SRC-BLOCK element as Org syntax.
2460 CONTENTS is nil."
2469 val)
2483 ;;;; Table
2486 "Parse a table at point.
2488 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2489 the buffer position at the beginning of the first affiliated
2490 keyword and CDR is a plist of affiliated keywords along with
2491 their value.
2493 Return a list whose CAR is `table' and CDR is a plist containing
2494 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2495 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2496 keywords.
2498 Assume point is at the beginning of the table."
2512 acc))
2519 :end end
2520 :type type
2521 :tblfm tblfm
2522 ;; Only `org' tables have contents. `table.el' tables
2523 ;; use a `:value' property to store raw table as
2524 ;; a string.
2529 table-begin table-end))
2535 "Interpret TABLE element as Org syntax.
2536 CONTENTS is a string, if table's type is `org', or nil."
2547 ;;;; Table Row
2550 "Parse table row at point.
2552 LIMIT bounds the search.
2554 Return a list whose CAR is `table-row' and CDR is a plist
2555 containing `:begin', `:end', `:contents-begin', `:contents-end',
2556 `:type', `:post-blank' and `:post-affiliated' keywords."
2560 ;; A table rule has no contents. In that case, ensure
2561 ;; CONTENTS-BEGIN matches CONTENTS-END.
2573 :begin begin
2574 :end end
2575 :contents-begin contents-begin
2576 :contents-end contents-end
2581 "Interpret TABLE-ROW element as Org syntax.
2582 CONTENTS is the contents of the table row."
2587 ;;;; Verse Block
2590 "Parse a verse block.
2592 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2593 the buffer position at the beginning of the first affiliated
2594 keyword and CDR is a plist of affiliated keywords along with
2595 their value.
2597 Return a list whose CAR is `verse-block' and CDR is a plist
2598 containing `:begin', `:end', `:contents-begin', `:contents-end',
2599 `:post-blank' and `:post-affiliated' keywords.
2601 Assume point is at beginning of the block."
2605 ;; Incomplete block: parse it as a paragraph.
2620 :end end
2621 :contents-begin contents-begin
2622 :contents-end contents-end
2628 "Interpret VERSE-BLOCK element as Org syntax.
2629 CONTENTS is verse block contents."
2633 \f
2634 ;;; Objects
2635 ;;
2636 ;; Unlike to elements, raw text can be found between objects. Hence,
2637 ;; `org-element--object-lex' is provided to find the next object in
2638 ;; buffer.
2639 ;;
2640 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2641 ;; object types they can contain will be specified in
2642 ;; `org-element-object-restrictions'.
2643 ;;
2644 ;; Creating a new type of object requires to alter
2645 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2646 ;; new type in `org-element-all-objects', and possibly add
2647 ;; restrictions in `org-element-object-restrictions'.
2649 ;;;; Bold
2652 "Parse bold object at point, if any.
2654 When at a bold object, return a list whose car is `bold' and cdr
2655 is a plist with `:begin', `:end', `:contents-begin' and
2656 `:contents-end' and `:post-blank' keywords. Otherwise, return
2657 nil.
2659 Assume point is at the first star marker."
2671 :end end
2672 :contents-begin contents-begin
2673 :contents-end contents-end
2677 "Interpret BOLD object as Org syntax.
2678 CONTENTS is the contents of the object."
2682 ;;;; Code
2685 "Parse code object at point, if any.
2687 When at a code object, return a list whose car is `code' and cdr
2688 is a plist with `:value', `:begin', `:end' and `:post-blank'
2689 keywords. Otherwise, return nil.
2691 Assume point is at the first tilde marker."
2702 :begin begin
2703 :end end
2707 "Interpret CODE object as Org syntax.
2708 CONTENTS is nil."
2712 ;;;; Entity
2715 "Parse entity at point, if any.
2717 When at an entity, return a list whose car is `entity' and cdr
2718 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2719 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2720 `:post-blank' as keywords. Otherwise, return nil.
2722 Assume point is at the beginning of the entity."
2724 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2742 :begin begin
2743 :end end
2744 :use-brackets-p bracketsp
2748 "Interpret ENTITY object as Org syntax.
2749 CONTENTS is nil."
2755 ;;;; Export Snippet
2758 "Parse export snippet at point.
2760 When at an export snippet, return a list whose car is
2761 `export-snippet' and cdr a plist with `:begin', `:end',
2762 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2763 return nil.
2765 Assume point is at the beginning of the snippet."
2781 :value value
2782 :begin begin
2783 :end end
2787 "Interpret EXPORT-SNIPPET object as Org syntax.
2788 CONTENTS is nil."
2794 ;;;; Footnote Reference
2797 "Parse footnote reference at point, if any.
2799 When at a footnote reference, return a list whose car is
2800 `footnote-reference' and cdr a plist with `:label', `:type',
2801 `:begin', `:end', `:content-begin', `:contents-end' and
2802 `:post-blank' as keywords. Otherwise, return nil."
2822 :type type
2823 :begin begin
2824 :end end
2830 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2831 CONTENTS is its definition, when inline, or nil."
2837 ;;;; Inline Babel Call
2840 "Parse inline babel call at point, if any.
2842 When at an inline babel call, return a list whose car is
2843 `inline-babel-call' and cdr a plist with `:begin', `:end',
2844 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2846 Assume point is at the beginning of the babel call."
2858 :end end
2859 :value value
2863 "Interpret INLINE-BABEL-CALL object as Org syntax.
2864 CONTENTS is nil."
2868 ;;;; Inline Src Block
2871 "Parse inline source block at point, if any.
2873 When at an inline source block, return a list whose car is
2874 `inline-src-block' and cdr a plist with `:begin', `:end',
2875 `:language', `:value', `:parameters' and `:post-blank' as
2876 keywords. Otherwise, return nil.
2878 Assume point is at the beginning of the inline src block."
2891 :value value
2892 :parameters parameters
2893 :begin begin
2894 :end end
2898 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2899 CONTENTS is nil."
2904 language
2906 body)))
2908 ;;;; Italic
2911 "Parse italic object at point, if any.
2913 When at an italic object, return a list whose car is `italic' and
2914 cdr is a plist with `:begin', `:end', `:contents-begin' and
2915 `:contents-end' and `:post-blank' keywords. Otherwise, return
2916 nil.
2918 Assume point is at the first slash marker."
2930 :end end
2931 :contents-begin contents-begin
2932 :contents-end contents-end
2936 "Interpret ITALIC object as Org syntax.
2937 CONTENTS is the contents of the object."
2941 ;;;; Latex Fragment
2944 "Parse LaTeX fragment at point, if any.
2946 When at a LaTeX fragment, return a list whose car is
2947 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2948 and `:post-blank' as keywords. Otherwise, return nil.
2950 Assume point is at the beginning of the LaTeX fragment."
2968 ;; Macro.
2977 :begin begin
2978 :end end
2982 "Interpret LATEX-FRAGMENT object as Org syntax.
2983 CONTENTS is nil."
2986 ;;;; Line Break
2989 "Parse line break at point, if any.
2991 When at a line break, return a list whose car is `line-break',
2992 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2993 Otherwise, return nil.
2995 Assume point is at the beginning of the line break."
3004 "Interpret LINE-BREAK object as Org syntax.
3005 CONTENTS is nil."
3009 ;;;; Link
3012 "Parse link at point, if any.
3014 When at a link, return a list whose car is `link' and cdr a plist
3015 with `:type', `:path', `:raw-link', `:application',
3016 `:search-option', `:begin', `:end', `:contents-begin',
3017 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3018 nil.
3020 Assume point is at the beginning of the link."
3023 end contents-begin contents-end link-end post-blank path type
3024 raw-link link search-option application)
3026 ;; Type 1: Text targeted from a radio target.
3035 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3040 ;; RAW-LINK is the original link. Expand any
3041 ;; abbreviation in it.
3045 ;; Determine TYPE of link and set PATH accordingly.
3047 ;; File type.
3051 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3054 ;; According to RFC 3986, extra whitespace should be
3055 ;; ignored when a URI is extracted.
3058 ;; Id type: PATH is the id.
3061 ;; Code-ref type: PATH is the name of the reference.
3064 ;; Custom-id type: PATH is the name of the custom id.
3067 ;; Fuzzy type: Internal link either matches a target, an
3068 ;; headline name or nothing. PATH is the target or
3069 ;; headline's name.
3071 ;; Type 3: Plain link, e.g., http://orgmode.org
3077 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3085 ;; In any case, deduce end point after trailing white space from
3086 ;; LINK-END variable.
3090 ;; Special "file" type link processing. Extract opening
3091 ;; application and search option, if any. Also normalize URI.
3102 :path path
3104 :application application
3105 :search-option search-option
3106 :begin begin
3107 :end end
3108 :contents-begin contents-begin
3109 :contents-end contents-end
3113 "Interpret LINK object as Org syntax.
3114 CONTENTS is the contents of the object, or nil."
3119 raw-link
3123 ;;;; Macro
3126 "Parse macro at point, if any.
3128 When at a macro, return a list whose car is `macro' and cdr
3129 a plist with `:key', `:args', `:begin', `:end', `:value' and
3130 `:post-blank' as keywords. Otherwise, return nil.
3132 Assume point is at the macro."
3145 :value value
3146 :args args
3147 :begin begin
3148 :end end
3152 "Interpret MACRO object as Org syntax.
3153 CONTENTS is nil."
3157 ;;;; Radio-target
3160 "Parse radio target at point, if any.
3162 When at a radio target, return a list whose car is `radio-target'
3163 and cdr a plist with `:begin', `:end', `:contents-begin',
3164 `:contents-end', `:value' and `:post-blank' as keywords.
3165 Otherwise, return nil.
3167 Assume point is at the radio target."
3179 :end end
3180 :contents-begin contents-begin
3181 :contents-end contents-end
3182 :post-blank post-blank
3186 "Interpret TARGET object as Org syntax.
3187 CONTENTS is the contents of the object."
3191 ;;;; Statistics Cookie
3194 "Parse statistics cookie at point, if any.
3196 When at a statistics cookie, return a list whose car is
3197 `statistics-cookie', and cdr a plist with `:begin', `:end',
3198 `:value' and `:post-blank' keywords. Otherwise, return nil.
3200 Assume point is at the beginning of the statistics-cookie."
3211 :end end
3212 :value value
3216 "Interpret STATISTICS-COOKIE object as Org syntax.
3217 CONTENTS is nil."
3221 ;;;; Strike-Through
3224 "Parse strike-through object at point, if any.
3226 When at a strike-through object, return a list whose car is
3227 `strike-through' and cdr is a plist with `:begin', `:end',
3228 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3229 Otherwise, return nil.
3231 Assume point is at the first plus sign marker."
3243 :end end
3244 :contents-begin contents-begin
3245 :contents-end contents-end
3249 "Interpret STRIKE-THROUGH object as Org syntax.
3250 CONTENTS is the contents of the object."
3254 ;;;; Subscript
3257 "Parse subscript at point, if any.
3259 When at a subscript object, return a list whose car is
3260 `subscript' and cdr a plist with `:begin', `:end',
3261 `:contents-begin', `:contents-end', `:use-brackets-p' and
3262 `:post-blank' as keywords. Otherwise, return nil.
3264 Assume point is at the underscore."
3278 :end end
3279 :use-brackets-p bracketsp
3280 :contents-begin contents-begin
3281 :contents-end contents-end
3285 "Interpret SUBSCRIPT object as Org syntax.
3286 CONTENTS is the contents of the object."
3289 contents))
3292 ;;;; Superscript
3295 "Parse superscript at point, if any.
3297 When at a superscript object, return a list whose car is
3298 `superscript' and cdr a plist with `:begin', `:end',
3299 `:contents-begin', `:contents-end', `:use-brackets-p' and
3300 `:post-blank' as keywords. Otherwise, return nil.
3302 Assume point is at the caret."
3316 :end end
3317 :use-brackets-p bracketsp
3318 :contents-begin contents-begin
3319 :contents-end contents-end
3323 "Interpret SUPERSCRIPT object as Org syntax.
3324 CONTENTS is the contents of the object."
3327 contents))
3330 ;;;; Table Cell
3333 "Parse table cell at point.
3334 Return a list whose car is `table-cell' and cdr is a plist
3335 containing `:begin', `:end', `:contents-begin', `:contents-end'
3336 and `:post-blank' keywords."
3344 :end end
3345 :contents-begin contents-begin
3346 :contents-end contents-end
3350 "Interpret TABLE-CELL element as Org syntax.
3351 CONTENTS is the contents of the cell, or nil."
3355 ;;;; Target
3358 "Parse target at point, if any.
3360 When at a target, return a list whose car is `target' and cdr
3361 a plist with `:begin', `:end', `:value' and `:post-blank' as
3362 keywords. Otherwise, return nil.
3364 Assume point is at the target."
3374 :end end
3375 :value value
3379 "Interpret TARGET object as Org syntax.
3380 CONTENTS is nil."
3384 ;;;; Timestamp
3395 "Parse time stamp at point, if any.
3397 When at a time stamp, return a list whose car is `timestamp', and
3398 cdr a plist with `:type', `:raw-value', `:year-start',
3399 `:month-start', `:day-start', `:hour-start', `:minute-start',
3400 `:year-end', `:month-end', `:day-end', `:hour-end',
3401 `:minute-end', `:repeater-type', `:repeater-value',
3402 `:repeater-unit', `:warning-type', `:warning-value',
3403 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3404 Otherwise, return nil.
3406 Assume point is at the beginning of the timestamp."
3425 date-start)
3436 raw-value)
3438 :repeater-type
3444 :repeater-unit
3453 :warning-unit
3456 year-start month-start day-start hour-start minute-start year-end
3457 month-end day-end hour-end minute-end)
3458 ;; Parse date-start.
3466 ;; Compute date-end. It can be provided directly in time-stamp,
3467 ;; or extracted from time range. Otherwise, it defaults to the
3468 ;; same values as date-start.
3478 :raw-value raw-value
3479 :year-start year-start
3480 :month-start month-start
3481 :day-start day-start
3482 :hour-start hour-start
3483 :minute-start minute-start
3484 :year-end year-end
3485 :month-end month-end
3486 :day-end day-end
3487 :hour-end hour-end
3488 :minute-end minute-end
3489 :begin begin
3490 :end end
3492 repeater-props
3493 warning-props))))))
3496 "Interpret TIMESTAMP object as Org syntax.
3497 CONTENTS is nil."
3516 ;; Build an Org timestamp string from TIME. ACTIVEP is
3517 ;; non-nil when time stamp is active. If WITH-TIME-P is
3518 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3519 ;; specify a time range in the timestamp. REPEAT-STRING is
3520 ;; the repeater string, if any.
3524 org-time-stamp-formats)
3525 time)))
3531 nil nil ts)))
3536 " "
3537 s
3539 ;; Return value.
3540 ts)))
3552 build-ts-string
3571 0
3579 "--"
3592 ;;;; Underline
3595 "Parse underline object at point, if any.
3597 When at an underline object, return a list whose car is
3598 `underline' and cdr is a plist with `:begin', `:end',
3599 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3600 Otherwise, return nil.
3602 Assume point is at the first underscore marker."
3614 :end end
3615 :contents-begin contents-begin
3616 :contents-end contents-end
3620 "Interpret UNDERLINE object as Org syntax.
3621 CONTENTS is the contents of the object."
3625 ;;;; Verbatim
3628 "Parse verbatim object at point, if any.
3630 When at a verbatim object, return a list whose car is `verbatim'
3631 and cdr is a plist with `:value', `:begin', `:end' and
3632 `:post-blank' keywords. Otherwise, return nil.
3634 Assume point is at the first equal sign marker."
3645 :begin begin
3646 :end end
3650 "Interpret VERBATIM object as Org syntax.
3651 CONTENTS is nil."
3655 \f
3656 ;;; Parsing Element Starting At Point
3657 ;;
3658 ;; `org-element--current-element' is the core function of this section.
3659 ;; It returns the Lisp representation of the element starting at
3660 ;; point.
3661 ;;
3662 ;; `org-element--current-element' makes use of special modes. They
3663 ;; are activated for fixed element chaining (e.g., `plain-list' >
3664 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3665 ;; `section'). Special modes are: `first-section', `item',
3666 ;; `node-property', `section' and `table-row'.
3669 "Parse the element starting at point.
3671 Return value is a list like (TYPE PROPS) where TYPE is the type
3672 of the element and PROPS a plist of properties associated to the
3673 element.
3675 Possible types are defined in `org-element-all-elements'.
3677 LIMIT bounds the search.
3679 Optional argument GRANULARITY determines the depth of the
3680 recursion. Allowed values are `headline', `greater-element',
3681 `element', `object' or nil. When it is broader than `object' (or
3682 nil), secondary values will not be parsed, since they only
3683 contain objects.
3685 Optional argument MODE, when non-nil, can be either
3686 `first-section', `section', `planning', `item', `node-property'
3687 and `table-row'.
3689 If STRUCTURE isn't provided but MODE is set to `item', it will be
3690 computed.
3692 This function assumes point is always at the beginning of the
3693 element it has to parse."
3696 ;; Determine if parsing depth allows for secondary strings
3697 ;; parsing. It only applies to elements referenced in
3698 ;; `org-element-secondary-value-alist'.
3701 ;; Item.
3704 ;; Table Row.
3706 ;; Node Property.
3708 ;; Headline.
3711 ;; Sections (must be checked after headline).
3716 limit)))
3717 ;; Planning.
3720 ;; Property drawer.
3724 ;; When not at bol, point is at the beginning of an item or
3725 ;; a footnote definition: next item is always a paragraph.
3727 ;; Clock.
3729 ;; Inlinetask.
3732 ;; From there, elements can have affiliated keywords.
3735 ;; Jumping over affiliated keywords put point off-limits.
3736 ;; Parse them as regular keywords.
3740 ;; LaTeX Environment.
3743 ;; Drawer and Property Drawer.
3746 ;; Fixed Width
3749 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3750 ;; Keywords.
3759 org-element-block-name-alist)))
3774 ;; Footnote Definition.
3777 ;; Horizontal Rule.
3780 ;; Diary Sexp.
3783 ;; Table.
3785 ;; List.
3788 limit affiliated
3790 ;; Default element: Paragraph.
3794 ;; Most elements can have affiliated keywords. When looking for an
3795 ;; element beginning, we want to move before them, as they belong to
3796 ;; that element, and, in the meantime, collect information they give
3797 ;; into appropriate properties. Hence the following function.
3800 "Collect affiliated keywords from point down to LIMIT.
3802 Return a list whose CAR is the position at the first of them and
3803 CDR a plist of keywords and values and move point to the
3804 beginning of the first line after them.
3806 As a special case, if element doesn't start at the beginning of
3807 the line (e.g., a paragraph starting an item), CAR is current
3808 position of point and CDR is nil."
3812 ;; RESTRICT is the list of objects allowed in parsed
3813 ;; keywords value.
3815 output)
3818 ;; Apply translation to RAW-KWD. From there, KWD is
3819 ;; the official keyword.
3821 org-element-keyword-translation-alist))
3822 raw-kwd))
3823 ;; Find main value for any keyword.
3829 ;; PARSEDP is non-nil when keyword should have its
3830 ;; value parsed.
3832 ;; If KWD is a dual keyword, find its secondary
3833 ;; value. Maybe parse it.
3841 ;; Attribute a property name to KWD.
3843 ;; Now set final shape for VALUE.
3849 nil restrict)))
3853 ;; Attributes can always appear on multiple lines.
3856 ;; Eventually store the new value in OUTPUT.
3858 ;; Move to next keyword.
3860 ;; If affiliated keywords are orphaned: move back to first one.
3861 ;; They will be parsed as a paragraph.
3863 ;; Return value.
3867 \f
3868 ;;; The Org Parser
3869 ;;
3870 ;; The two major functions here are `org-element-parse-buffer', which
3871 ;; parses Org syntax inside the current buffer, taking into account
3872 ;; region, narrowing, or even visibility if specified, and
3873 ;; `org-element-parse-secondary-string', which parses objects within
3874 ;; a given string.
3875 ;;
3876 ;; The (almost) almighty `org-element-map' allows to apply a function
3877 ;; on elements or objects matching some type, and accumulate the
3878 ;; resulting values. In an export situation, it also skips unneeded
3879 ;; parts of the parse tree.
3882 "Recursively parse the buffer and return structure.
3883 If narrowing is in effect, only parse the visible part of the
3884 buffer.
3886 Optional argument GRANULARITY determines the depth of the
3887 recursion. It can be set to the following symbols:
3889 `headline' Only parse headlines.
3890 `greater-element' Don't recurse into greater elements excepted
3891 headlines and sections. Thus, elements
3892 parsed are the top-level ones.
3893 `element' Parse everything but objects and plain text.
3894 `object' Parse the complete buffer (default).
3896 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3897 elements.
3899 An element or an objects is represented as a list with the
3900 pattern (TYPE PROPERTIES CONTENTS), where :
3902 TYPE is a symbol describing the element or object. See
3903 `org-element-all-elements' and `org-element-all-objects' for an
3904 exhaustive list of such symbols. One can retrieve it with
3905 `org-element-type' function.
3907 PROPERTIES is the list of attributes attached to the element or
3908 object, as a plist. Although most of them are specific to the
3909 element or object type, all types share `:begin', `:end',
3910 `:post-blank' and `:parent' properties, which respectively
3911 refer to buffer position where the element or object starts,
3912 ends, the number of white spaces or blank lines after it, and
3913 the element or object containing it. Properties values can be
3914 obtained by using `org-element-property' function.
3916 CONTENTS is a list of elements, objects or raw strings
3917 contained in the current element or object, when applicable.
3918 One can access them with `org-element-contents' function.
3920 The Org buffer has `org-data' as type and nil as properties.
3921 `org-element-map' function can be used to find specific elements
3922 or objects within the parse tree.
3924 This function assumes that current major mode is `org-mode'."
3930 ;; Start in `first-section' mode so text before the first
3931 ;; headline belongs to a section.
3935 "Recursively parse objects in STRING and return structure.
3937 RESTRICTION is a symbol limiting the object types that will be
3938 looked after.
3940 Optional argument PARENT, when non-nil, is the element or object
3941 containing the secondary string. It is used to set correctly
3942 `:parent' property within the string."
3955 secondary))))
3959 "Map a function on selected elements or objects.
3961 DATA is a parse tree, an element, an object, a string, or a list
3962 of such constructs. TYPES is a symbol or list of symbols of
3963 elements or objects types (see `org-element-all-elements' and
3964 `org-element-all-objects' for a complete list of types). FUN is
3965 the function called on the matching element or object. It has to
3966 accept one argument: the element or object itself.
3968 When optional argument INFO is non-nil, it should be a plist
3969 holding export options. In that case, parts of the parse tree
3970 not exportable according to that property list will be skipped.
3972 When optional argument FIRST-MATCH is non-nil, stop at the first
3973 match for which FUN doesn't return nil, and return that value.
3975 Optional argument NO-RECURSION is a symbol or a list of symbols
3976 representing elements or objects types. `org-element-map' won't
3977 enter any recursive element or object whose type belongs to that
3978 list. Though, FUN can still be applied on them.
3980 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3981 apply to matching objects within parsed affiliated keywords (see
3982 `org-element-parsed-keywords').
3984 Nil values returned from FUN do not appear in the results.
3987 Examples:
3988 ---------
3990 Assuming TREE is a variable containing an Org buffer parse tree,
3991 the following example will return a flat list of all `src-block'
3992 and `example-block' elements in it:
3994 \(org-element-map tree '(example-block src-block) #'identity)
3996 The following snippet will find the first headline with a level
3999 \(org-element-map tree 'headline
4000 \(lambda (hl)
4001 \(and (= (org-element-property :level hl) 1)
4003 \(org-element-property :begin hl)))
4004 nil t)
4006 The next example will return a flat list of all `plain-list' type
4007 elements in TREE that are not a sub-list themselves:
4009 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4011 Eventually, this example will return a flat list of all `bold'
4012 type objects containing a `latex-snippet' type object, even
4013 looking into captions:
4015 \(org-element-map tree 'bold
4016 \(lambda (b)
4017 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4018 nil nil nil t)"
4019 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4023 ;; Recursion depth is determined by --CATEGORY.
4030 ;; If one object is found, the function has to
4031 ;; recurse into every object.
4034 ;; If one regular element is found, the
4035 ;; function has to recurse, at least, into
4036 ;; every element it encounters.
4039 --acc
4040 --walk-tree
4043 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4044 ;; holding contextual information.
4048 ;; Ignored element in an export context.
4050 ;; List of elements or objects.
4052 ;; Unconditionally enter parse trees.
4056 ;; Check if TYPE is matching among TYPES. If so,
4057 ;; apply FUN to --DATA and accumulate return value
4058 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4064 ;; If --DATA has a secondary string that can contain
4065 ;; objects with their type among TYPES, look into it.
4072 ;; If --DATA has any parsed affiliated keywords and
4073 ;; WITH-AFFILIATED is non-nil, look for objects in
4074 ;; them.
4081 ;; Pay attention to the type of parsed keyword.
4082 ;; In particular, preserve order for multiple
4083 ;; keywords.
4096 ;; Determine if a recursion into --DATA is possible.
4098 ;; --TYPE is explicitly removed from recursion.
4100 ;; --DATA has no contents.
4102 ;; Looking for greater elements but --DATA is simply
4103 ;; an element or an object.
4106 ;; Looking for elements but --DATA is an object.
4109 ;; In any other case, map contents.
4113 ;; Return value in a proper order.
4117 ;; The following functions are internal parts of the parser.
4118 ;;
4119 ;; The first one, `org-element--parse-elements' acts at the element's
4120 ;; level.
4121 ;;
4122 ;; The second one, `org-element--parse-objects' applies on all objects
4123 ;; of a paragraph or a secondary string. It calls
4124 ;; `org-element--object-lex' to find the next object in the current
4125 ;; container.
4128 "Return next special mode according to TYPE, or nil.
4129 TYPE is a symbol representing the type of an element or object
4130 containing next element if PARENTP is non-nil, or before it
4131 otherwise. Modes can be either `first-section', `item',
4132 `node-property', `planning', `property-drawer', `section',
4133 `table-row' or nil."
4149 "Parse elements between BEG and END positions.
4151 MODE prioritizes some elements over the others. It can be set to
4152 `first-section', `section', `planning', `item', `node-property'
4153 or `table-row'.
4155 When value is `item', STRUCTURE will be used as the current list
4156 structure.
4158 GRANULARITY determines the depth of the recursion. See
4159 `org-element-parse-buffer' for more information.
4161 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4162 elements.
4164 Elements are accumulated into ACC."
4167 ;; Visible only: skip invisible parts at the beginning of the
4168 ;; element.
4171 ;; When parsing only headlines, skip any text before first one.
4174 ;; Main loop start.
4176 ;; Find current element's type and parse it accordingly to
4177 ;; its category.
4179 end granularity mode structure))
4183 ;; Visible only: skip invisible parts between siblings.
4186 ;; Fill ELEMENT contents by side-effect.
4188 ;; If element has no contents, don't modify it.
4190 ;; Greater element: parse it between `contents-begin' and
4191 ;; `contents-end'. Make sure GRANULARITY allows the
4192 ;; recursion, or ELEMENT is a headline, in which case going
4193 ;; inside is mandatory, in order to get sub-level headings.
4201 ;; Possibly switch to a special mode.
4205 granularity visible-only element))
4206 ;; ELEMENT has contents. Parse objects inside, if
4207 ;; GRANULARITY allows it.
4213 ;; Update mode.
4215 ;; Return result.
4216 acc))
4219 "Return next object in current buffer or nil.
4220 RESTRICTION is a list of object types, as symbols, that should be
4221 looked after. This function assumes that the buffer is narrowed
4222 to an appropriate container (e.g., a paragraph)."
4230 found)
4295 ;; This is probably a plain link.
4301 ;; Radio link.
4306 "Parse objects between BEG and END and return recursive structure.
4308 Objects are accumulated in ACC.
4310 RESTRICTION is a list of object successors which are allowed in
4311 the current object."
4319 ;; 1. Text before any object. Untabify it.
4324 acc
4328 ;; 2. Object...
4331 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4332 ;; a recursive type.
4340 ;; 3. Text after last object. Untabify it.
4344 acc
4348 ;; Result.
4349 acc)))
4352 \f
4353 ;;; Towards A Bijective Process
4354 ;;
4355 ;; The parse tree obtained with `org-element-parse-buffer' is really
4356 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4357 ;; interpreted and expanded into a string with canonical Org syntax.
4358 ;; Hence `org-element-interpret-data'.
4359 ;;
4360 ;; The function relies internally on
4361 ;; `org-element--interpret-affiliated-keywords'.
4363 ;;;###autoload
4365 "Interpret DATA as Org syntax.
4366 DATA is a parse tree, an element, an object or a secondary string
4367 to interpret. Return Org syntax as a string."
4371 "Interpret DATA as Org syntax.
4373 DATA is a parse tree, an element, an object or a secondary string
4374 to interpret. PARENT is used for recursive calls. It contains
4375 the element or object containing data, or nil.
4377 Return Org syntax as a string."
4379 ;; Find interpreter for current object or element. If it
4380 ;; doesn't exist (e.g. this is a pseudo object or element),
4381 ;; return contents, if any.
4387 ;; Secondary string.
4391 ;; Full Org document.
4395 ;; Plain text: return it.
4397 ;; Element or object without contents.
4399 ;; Element or object with contents.
4402 ;; Recursively interpret contents.
4407 data
4408 ;; Fix indentation of elements containing
4409 ;; objects. We ignore `table-row' elements
4410 ;; as they are one line long anyway.
4412 data
4413 ;; When normalizing first paragraph of an
4414 ;; item or a footnote-definition, ignore
4415 ;; first line's indentation.
4422 ;; Build white spaces. If no `:post-blank' property is
4423 ;; specified, assume its value is 0.
4437 "Return ELEMENT's affiliated keywords as Org syntax.
4438 If there is no affiliated keyword, return the empty string."
4448 ": "
4451 value)
4459 ;; All attribute keywords can have multiple lines.
4465 ;; List all ELEMENT's properties matching an attribute line or an
4466 ;; affiliated keyword, but ignore translated keywords since they
4467 ;; cannot belong to the property list.
4474 org-element-keyword-translation-alist)))))
4475 collect prop)
4478 ;; Because interpretation of the parse tree must return the same
4479 ;; number of blank lines between elements and the same number of white
4480 ;; space after objects, some special care must be given to white
4481 ;; spaces.
4482 ;;
4483 ;; The first function, `org-element-normalize-string', ensures any
4484 ;; string different from the empty string will end with a single
4485 ;; newline character.
4486 ;;
4487 ;; The second function, `org-element-normalize-contents', removes
4488 ;; global indentation from the contents of the current element.
4491 "Ensure string S ends with a single newline character.
4493 If S isn't a string return it unchanged. If S is the empty
4494 string, return it. Otherwise, return a new string with a single
4495 newline character at its end."
4503 "Normalize plain text in ELEMENT's contents.
4505 ELEMENT must only contain plain text and objects.
4507 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4508 indentation to compute maximal common indentation.
4510 Return the normalized element that is element with global
4511 indentation removed from its contents. The function assumes that
4512 indentation is not done with TAB characters."
4514 find-min-ind ; For byte-compiler.
4516 ;; Return minimal common indentation within BLOB. This is
4517 ;; done by walking recursively BLOB and updating MIN-IND
4518 ;; along the way. FIRST-FLAG is non-nil when the first
4519 ;; string hasn't been seen yet. It is required as this
4520 ;; string is the only one whose indentation doesn't happen
4521 ;; after a newline character.
4528 ;; An indentation of zero means no string will be
4529 ;; modified. Quit the process.
4539 ;; Find minimal indentation in ELEMENT.
4542 ;; Build ELEMENT back, replacing each string with the same
4543 ;; string minus common indentation.
4548 ;; Return BLOB with all its strings indentation
4549 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4550 ;; is non-nil when the first string hasn't been seen
4551 ;; yet.
4566 org-element-recursive-objects)
4570 blob))))
4574 \f
4575 ;;; Cache
4576 ;;
4577 ;; Implement a caching mechanism for `org-element-at-point' and
4578 ;; `org-element-context', which see.
4579 ;;
4580 ;; A single public function is provided: `org-element-cache-reset'.
4581 ;;
4582 ;; Cache is enabled by default, but can be disabled globally with
4583 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4584 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4585 ;; can be tweaked to control caching behaviour.
4586 ;;
4587 ;; Internally, parsed elements are stored in an AVL tree,
4588 ;; `org-element--cache'. This tree is updated lazily: whenever
4589 ;; a change happens to the buffer, a synchronization request is
4590 ;; registered in `org-element--cache-sync-requests' (see
4591 ;; `org-element--cache-submit-request'). During idle time, requests
4592 ;; are processed by `org-element--cache-sync'. Synchronization also
4593 ;; happens when an element is required from the cache. In this case,
4594 ;; the process stops as soon as the needed element is up-to-date.
4595 ;;
4596 ;; A synchronization request can only apply on a synchronized part of
4597 ;; the cache. Therefore, the cache is updated at least to the
4598 ;; location where the new request applies. Thus, requests are ordered
4599 ;; from left to right and all elements starting before the first
4600 ;; request are correct. This property is used by functions like
4601 ;; `org-element--cache-find' to retrieve elements in the part of the
4602 ;; cache that can be trusted.
4603 ;;
4604 ;; A request applies to every element, starting from its original
4605 ;; location (or key, see below). When a request is processed, it
4606 ;; moves forward and may collide the next one. In this case, both
4607 ;; requests are merged into a new one that starts from that element.
4608 ;; As a consequence, the whole synchronization complexity does not
4609 ;; depend on the number of pending requests, but on the number of
4610 ;; elements the very first request will be applied on.
4611 ;;
4612 ;; Elements cannot be accessed through their beginning position, which
4613 ;; may or may not be up-to-date. Instead, each element in the tree is
4614 ;; associated to a key, obtained with `org-element--cache-key'. This
4615 ;; mechanism is robust enough to preserve total order among elements
4616 ;; even when the tree is only partially synchronized.
4617 ;;
4618 ;; Objects contained in an element are stored in a hash table,
4619 ;; `org-element--cache-objects'.
4623 "Non nil when Org parser should cache its results.
4630 "Maximum duration, as a time value, for a cache synchronization.
4631 If the synchronization is not over after this delay, the process
4632 pauses and resumes after `org-element-cache-sync-break'
4636 "Duration, as a time value, of the pause between synchronizations.
4640 ;;;; Data Structure
4643 "AVL tree used to cache elements.
4644 Each node of the tree contains an element. Comparison is done
4645 with `org-element--cache-compare'. This cache is used in
4649 "Hash table used as to cache objects.
4650 Key is an element, as returned by `org-element-at-point', and
4651 value is an alist where each association is:
4653 \(PARENT COMPLETEP . OBJECTS)
4655 where PARENT is an element or object, COMPLETEP is a boolean,
4656 non-nil when all direct children of parent are already cached and
4657 OBJECTS is a list of such children, as objects, from farthest to
4658 closest.
4661 contained within a paragraph
4665 If the paragraph is completely parsed, OBJECTS-DATA will be
4667 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4668 \(BOLD-OBJECT t ENTITY-OBJECT))
4670 whereas in a partially parsed paragraph, it could be
4672 \((PARAGRAPH nil ENTITY-OBJECT))
4677 "List of pending synchronization requests.
4679 A request is a vector with the following pattern:
4681 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4683 Processing a synchronization request consists of three phases:
4685 0. Delete modified elements,
4686 1. Fill missing area in cache,
4687 2. Shift positions and re-parent elements after the changes.
4689 During phase 0, NEXT is the key of the first element to be
4690 removed, BEG and END is buffer position delimiting the
4691 modifications. Elements starting between them (inclusive) are
4692 removed and so are those contained within OUTREACH. PARENT, when
4693 non-nil, is the parent of the first element to be removed.
4695 During phase 1, NEXT is the key of the next known element in
4696 cache and BEG its beginning position. Parse buffer between that
4697 element and the one before it in order to determine the parent of
4698 the next element. Set PARENT to the element containing NEXT.
4700 During phase 2, NEXT is the key of the next element to shift in
4701 the parse tree. All elements starting from this one have their
4702 properties relatives to buffer positions shifted by integer
4703 OFFSET and, if they belong to element PARENT, are adopted by it.
4711 "Hash table used to store keys during synchronization.
4715 "Return a unique key for ELEMENT in cache tree.
4717 Keys are used to keep a total order among elements in the cache.
4718 Comparison is done with `org-element--cache-key-less-p'.
4720 When no synchronization is taking place, a key is simply the
4721 beginning position of the element, or that position plus one in
4722 the case of an first item (respectively row) in
4723 a list (respectively a table).
4725 During a synchronization, the key is the one the element had when
4726 the cache was synchronized for the last time. Elements added to
4727 cache during the synchronization get a new key generated with
4728 `org-element--cache-generate-key'.
4730 Such keys are stored in `org-element--cache-sync-keys'. The hash
4731 table is cleared once the synchronization is complete."
4734 ;; Increase beginning position of items (respectively
4735 ;; table rows) by one, so the first item can get
4736 ;; a different key from its parent list (respectively
4737 ;; table).
4740 begin)))
4743 key))))
4746 "Generate a key between LOWER and UPPER.
4748 LOWER and UPPER are integers or lists, possibly empty.
4750 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4751 a unique key, as an integer or a list of integers, according to
4752 the following rules:
4754 - LOWER and UPPER are compared level-wise until values differ.
4756 - If, at a given level, LOWER and UPPER differ from more than
4757 2, the new key shares all the levels above with LOWER and
4758 gets a new level. Its value is the mean between LOWER and
4759 UPPER:
4761 \(1 2) + (1 4) --> (1 3)
4763 - If LOWER has no value to compare with, it is assumed that its
4764 value is `most-negative-fixnum'. E.g.,
4766 \(1 1) + (1 1 2)
4768 is equivalent to
4770 \(1 1 m) + (1 1 2)
4772 where m is `most-negative-fixnum'. Likewise, if UPPER is
4773 short of levels, the current value is `most-positive-fixnum'.
4775 - If they differ from only one, the new key inherits from
4776 current LOWER level and fork it at the next level. E.g.,
4778 \(2 1) + (3 3)
4780 is equivalent to
4782 \(2 1) + (2 M)
4784 where M is `most-positive-fixnum'.
4786 - If the key is only one level long, it is returned as an
4787 integer:
4789 \(1 2) + (3 2) --> 2
4791 When they are not equals, the function assumes that LOWER is
4792 lesser than UPPER, per `org-element--cache-key-less-p'."
4796 skip-upper key)
4807 ;; When at a given level, LOWER and UPPER differ from
4808 ;; 1, ignore UPPER altogether. Instead create a key
4809 ;; between LOWER and the greatest key with the same
4810 ;; prefix as LOWER so far.
4816 "Non-nil if key A is less than key B.
4817 A and B are either integers or lists of integers, as returned by
4818 `org-element--cache-key'."
4826 ;; If A is empty, either keys are equal (B is also empty) and
4827 ;; we return nil, or A is lesser than B (B is longer) and we
4828 ;; return a non-nil value.
4829 ;;
4830 ;; If A is not empty, B is necessarily empty and A is greater
4831 ;; than B (A is longer). Therefore, return nil.
4835 "Non-nil when element A is located before element B."
4840 "Return root value in cache.
4841 This function assumes `org-element--cache' is a valid AVL tree."
4845 ;;;; Tools
4848 "Non-nil when cache is active in current buffer."
4853 "Find element in cache starting at POS or before.
4855 POS refers to a buffer position.
4857 When optional argument SIDE is non-nil, the function checks for
4858 elements starting at or past POS instead. If SIDE is `both', the
4859 function returns a cons cell where car is the first element
4860 starting at or before POS and cdr the first element starting
4861 after POS.
4863 The function can only find elements in the synchronized part of
4864 the cache."
4868 lower upper)
4883 ;; We found an element in cache starting at POS. If `side'
4884 ;; is `both' we also want the next one in order to generate
4885 ;; a key in-between.
4886 ;;
4887 ;; If the element is the first row or item in a table or
4888 ;; a plain list, we always return the table or the plain
4889 ;; list.
4890 ;;
4891 ;; In any other case, we return the element found.
4900 lower parent
4901 upper parent)))))
4904 lower element
4905 upper element)))))
4912 "Store ELEMENT in current buffer's cache, if allowed.
4913 When optional argument DATA is non-nil, assume is it object data
4914 relative to ELEMENT and store it in the objects cache."
4918 ;; During synchronization, first build an appropriate key
4919 ;; for the new element so `avl-tree-enter' can insert it at
4920 ;; the right spot in the cache.
4929 org-element--cache-sync-keys)))
4931 ;; Headlines are not stored in cache, so objects in titles are
4932 ;; not stored either.
4937 "Remove ELEMENT from cache.
4938 Assume ELEMENT belongs to cache and that a cache is active."
4943 ;;;; Synchronization
4946 "Set idle timer for cache synchronization in BUFFER."
4953 org-element-cache-sync-idle-time))
4954 nil
4955 #'org-element--cache-sync
4956 buffer)))
4959 "Non-nil when synchronization process should be interrupted.
4960 TIME-LIMIT is a time value or nil."
4966 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4968 Properties containing buffer positions are `:begin', `:end',
4969 `:contents-begin', `:contents-end' and `:structure'. When
4970 optional argument PROPS is a list of keywords, only shift
4971 properties provided in that list.
4973 Properties are modified by side-effect."
4975 ;; Shift `:structure' property for the first plain list only: it
4976 ;; is the only one that really matters and it prevents from
4977 ;; shifting it more than once.
4991 "Synchronize cache with recent modification in BUFFER.
4993 When optional argument THRESHOLD is non-nil, do the
4994 synchronization for all elements starting before or at threshold,
4995 then exit. Otherwise, synchronize cache for as long as
4996 `org-element-cache-sync-duration' or until Emacs leaves idle
4997 state.
4999 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5000 not registered yet in the cache are going to happen. It is used
5001 in `org-element--cache-submit-request', where cache is partially
5002 updated before current modification are actually submitted."
5013 request
5015 threshold
5018 org-element-cache-sync-duration))
5019 future-change)
5020 ;; Request processed. Merge current and next offsets and
5021 ;; transfer ending position.
5027 ;; If more requests are awaiting, set idle timer accordingly.
5028 ;; Otherwise, reset keys.
5035 "Process synchronization REQUEST for all entries before NEXT.
5037 REQUEST is a vector, built by `org-element--cache-submit-request'.
5039 NEXT is a cache key, as returned by `org-element--cache-key'.
5041 When non-nil, THRESHOLD is a buffer position. Synchronization
5042 stops as soon as a shifted element begins after it.
5044 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5045 after this time or when Emacs exits idle state.
5047 When non-nil, FUTURE-CHANGE is a buffer position where changes
5048 not registered yet in the cache are going to happen. See
5049 `org-element--cache-submit-request' for more information.
5051 Throw `interrupt' if the process stops before completing the
5052 request."
5055 ;; Phase 0.
5056 ;;
5057 ;; Delete all elements starting after BEG, but not after buffer
5058 ;; position END or past element with key NEXT.
5059 ;;
5060 ;; At each iteration, we start again at tree root since
5061 ;; a deletion modifies structure of the balanced tree.
5069 ;; Find first element in cache with key BEG or after it.
5079 data-key key
5082 data-key key
5083 node nil)))))
5092 up))
5098 ;; No element starting after modifications left in
5099 ;; cache: further processing is futile.
5102 ;; Phase 1.
5103 ;;
5104 ;; Phase 0 left a hole in the cache. Some elements after it
5105 ;; could have parents within. For example, in the following
5106 ;; buffer:
5107 ;;
5108 ;; - item
5109 ;;
5110 ;;
5111 ;; Paragraph1
5112 ;;
5113 ;; Paragraph2
5114 ;;
5115 ;; if we remove a blank line between "item" and "Paragraph1",
5116 ;; everything down to "Paragraph2" is removed from cache. But
5117 ;; the paragraph now belongs to the list, and its `:parent'
5118 ;; property no longer is accurate.
5119 ;;
5120 ;; Therefore we need to parse again elements in the hole, or at
5121 ;; least in its last section, so that we can re-parent
5122 ;; subsequent elements, during phase 2.
5123 ;;
5124 ;; Note that we only need to get the parent from the first
5125 ;; element in cache after the hole.
5126 ;;
5127 ;; When next key is lesser or equal to the current one, delegate
5128 ;; phase 1 processing to next request in order to preserve key
5129 ;; order among requests.
5137 ;; Next element will start at its beginning position plus
5138 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5139 ;; contains the real beginning position of the first element to
5140 ;; shift and re-parent.
5144 ;; Changes are going to happen around this element and
5145 ;; they will trigger another phase 1 request. Skip the
5146 ;; current one.
5152 ;; Phase 2.
5153 ;;
5154 ;; Shift all elements starting from key START, but before NEXT, by
5155 ;; OFFSET, and re-parent them when appropriate.
5156 ;;
5157 ;; Elements are modified by side-effect so the tree structure
5158 ;; remains intact.
5159 ;;
5160 ;; Once THRESHOLD, if any, is reached, or once there is an input
5161 ;; pending, exit. Before leaving, the current synchronization
5162 ;; request is updated.
5169 exit-flag)
5170 ;; No re-parenting nor shifting planned: request is over.
5180 ;; We reached NEXT. Request is complete.
5182 ;; Handle interruption request. Update current request.
5187 ;; Shift element.
5190 ;; Shift associated objects data, if any.
5195 ;; Update PARENT and re-parent DATA, only when
5196 ;; necessary. Propagate new structures for lists.
5210 ;; Cache is up-to-date past THRESHOLD. Request
5211 ;; interruption.
5216 ;; We reached end of tree: synchronization complete.
5217 t)))
5220 "Parse elements in current section, down to POS.
5222 Start parsing from the closest between the last known element in
5223 cache or headline above. Return the smallest element containing
5224 POS.
5226 When optional argument SYNCP is non-nil, return the parent of the
5227 element containing POS instead. In that case, it is also
5228 possible to provide TIME-LIMIT, which is a time value specifying
5229 when the parsing should stop. The function throws `interrupt' if
5230 the process stopped before finding the expected result."
5237 element next mode)
5239 ;; Nothing in cache before point: start parsing from first
5240 ;; element following headline above, or first element in
5241 ;; buffer.
5248 ;; Cache returned exact match: return it.
5251 ;; There's a headline between cached value and POS: cached
5252 ;; value is invalid. Start parsing from first element
5253 ;; following the headline.
5260 ;; Check if CACHED or any of its ancestors contain point.
5261 ;;
5262 ;; If there is such an element, we inspect it in order to know
5263 ;; if we return it or if we need to parse its contents.
5264 ;; Otherwise, we just start parsing from current location,
5265 ;; which is right after the top-most element containing
5266 ;; CACHED.
5267 ;;
5268 ;; As a special case, if POS is at the end of the buffer, we
5269 ;; want to return the innermost element ending there.
5270 ;;
5271 ;; Also, if we find an ancestor and discover that we need to
5272 ;; parse its contents, make sure we don't start from
5273 ;; `:contents-begin', as we would otherwise go past CACHED
5274 ;; again. Instead, in that situation, we will resume parsing
5275 ;; from NEXT, which is located after CACHED or its higher
5276 ;; ancestor not containing point.
5288 ;; Parse successively each element until we reach POS.
5301 end 'element mode
5308 ;; Skip any element ending before point. Also skip
5309 ;; element ending at point (unless it is also the end of
5310 ;; buffer) since we're sure that another element begins
5311 ;; after it.
5315 ;; A non-greater element contains point: return it.
5318 ;; Otherwise, we have to decide if ELEMENT really
5319 ;; contains POS. In that case we start parsing from
5320 ;; contents' beginning.
5321 ;;
5322 ;; If POS is at contents' beginning but it is also at
5323 ;; the beginning of the first item in a list or a table.
5324 ;; In that case, we need to create an anchor for that
5325 ;; list or table, so return it.
5326 ;;
5327 ;; Also, if POS is at the end of the buffer, no element
5328 ;; can start after it, but more than one may end there.
5329 ;; Arbitrarily, we choose to return the innermost of
5330 ;; such elements.
5343 parent element
5344 end cend))))
5345 ;; Otherwise, return ELEMENT as it is the smallest
5346 ;; element containing POS.
5351 ;;;; Staging Buffer Changes
5357 ;; Blocks
5359 ;; LaTeX environments.
5361 ;; Drawers.
5364 "Regexp matching a sensitive line, structure wise.
5365 A sensitive line is a headline, inlinetask, block, drawer, or
5366 latex-environment boundary. When such a line is modified,
5367 structure changes in the document may propagate in the whole
5371 "Non-nil when a sensitive line is about to be changed.
5375 "Request extension of area going to be modified if needed.
5376 BEG and END are the beginning and end of the range of changed
5377 text. See `before-change-functions' for more information."
5387 'headline
5390 org-element--cache-sensitive-re bottom t)))))))))
5393 "Update buffer modifications for current buffer.
5394 BEG and END are the beginning and end of the range of changed
5395 text, and the length in bytes of the pre-change text replaced by
5396 that range. See `after-change-functions' for more information."
5404 ;; Determine if modified area needs to be extended, according
5405 ;; to both previous and current state. We make a special
5406 ;; case for headline editing: if a headline is modified but
5407 ;; not removed, do not extend.
5416 org-element--cache-sensitive-re bottom t))))
5417 ;; Effectively extend modified area.
5425 ;; Store synchronization request.
5428 ;; Activate a timer to process the request during idle time.
5432 "Return first element to remove from cache.
5434 BEG and END are buffer positions delimiting buffer modifications.
5435 OFFSET is the size of the changes.
5437 Returned element is usually the first element in cache containing
5438 any position between BEG and END. As an exception, greater
5439 elements around the changes that are robust to contents
5440 modifications are preserved and updated according to the
5441 changes."
5451 quote-block special-block))
5456 ;; UP is a robust greater element containing changes.
5457 ;; We only need to extend its ending boundaries.
5463 ;; We're at top level element containing ELEMENT: if it's
5464 ;; altered by buffer modifications, it is first element in
5465 ;; cache to be removed. Otherwise, that first element is the
5466 ;; following one.
5467 ;;
5468 ;; As a special case, do not remove BEFORE if it is a robust
5469 ;; container for current changes.
5471 before)))))
5474 "Submit a new cache synchronization request for current buffer.
5475 BEG and END are buffer positions delimiting the minimal area
5476 where cache data should be removed. OFFSET is the size of the
5477 change, as an integer."
5479 delete-to delete-from)
5484 ;; Current changes can be merged with first sync request: we
5485 ;; can save a partial cache synchronization.
5488 ;; If last change happened within area to be removed, extend
5489 ;; boundaries of robust parents, if any. Otherwise, find
5490 ;; first element to remove and update request accordingly.
5502 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5503 ;; if any, is no longer a 0-phase request, thus ensuring that
5504 ;; phases are properly ordered. We need to provide OFFSET as
5505 ;; optional parameter since current modifications are not known
5506 ;; yet to the otherwise correct part of the cache (i.e, before
5507 ;; the first request).
5514 ;; When changes happen before the first known
5515 ;; element, re-parent and shift the rest of the
5516 ;; cache.
5518 ;; Otherwise, we find the first non robust
5519 ;; element containing END. All elements between
5520 ;; FIRST and this one are to be removed.
5521 ;;
5522 ;; Among them, some could be located outside the
5523 ;; synchronized part of the cache, in which case
5524 ;; comparing buffer positions to find them is
5525 ;; useless. Instead, we store the element
5526 ;; containing them in the request itself. All
5527 ;; its children will be removed.
5539 element up))
5542 org-element--cache-sync-requests)
5543 ;; No element to remove. No need to re-parent either.
5544 ;; Simply shift additional elements, if any, by OFFSET.
5549 ;;;; Public Functions
5551 ;;;###autoload
5553 "Reset cache in current buffer.
5554 When optional argument ALL is non-nil, reset cache in all Org
5555 buffers."
5573 ;;;###autoload
5575 "Refresh cache at position POS."
5582 \f
5583 ;;; The Toolbox
5584 ;;
5585 ;; The first move is to implement a way to obtain the smallest element
5586 ;; containing point. This is the job of `org-element-at-point'. It
5587 ;; basically jumps back to the beginning of section containing point
5588 ;; and proceed, one element after the other, with
5589 ;; `org-element--current-element' until the container is found. Note:
5590 ;; When using `org-element-at-point', secondary values are never
5591 ;; parsed since the function focuses on elements, not on objects.
5592 ;;
5593 ;; At a deeper level, `org-element-context' lists all elements and
5594 ;; objects containing point.
5595 ;;
5596 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5597 ;; internally by navigation and manipulation tools.
5600 ;;;###autoload
5602 "Determine closest element around point.
5604 Return value is a list like (TYPE PROPS) where TYPE is the type
5605 of the element and PROPS a plist of properties associated to the
5606 element.
5608 Possible types are defined in `org-element-all-elements'.
5609 Properties depend on element or object type, but always include
5610 `:begin', `:end', `:parent' and `:post-blank' properties.
5612 As a special case, if point is at the very beginning of the first
5613 item in a list or sub-list, returned element will be that list
5614 instead of the item. Likewise, if point is at the beginning of
5615 the first row of a table, returned element will be the table
5616 instead of the first row.
5618 When point is at the end of the buffer, return the innermost
5619 element ending there."
5625 ;; Within blank lines at the beginning of buffer, return nil.
5627 ;; Within blank lines right after a headline, return that
5628 ;; headline.
5632 ;; Otherwise parse until we find element containing ORIGIN.
5639 ;;;###autoload
5641 "Return smallest element or object around point.
5643 Return value is a list like (TYPE PROPS) where TYPE is the type
5644 of the element or object and PROPS a plist of properties
5645 associated to it.
5647 Possible types are defined in `org-element-all-elements' and
5648 `org-element-all-objects'. Properties depend on element or
5649 object type, but always include `:begin', `:end', `:parent' and
5650 `:post-blank'.
5652 As a special case, if point is right after an object and not at
5653 the beginning of any other object, return that object.
5655 Optional argument ELEMENT, when non-nil, is the closest element
5656 containing point, as returned by `org-element-at-point'.
5657 Providing it allows for quicker computation."
5663 ;; If point is inside an element containing objects or
5664 ;; a secondary string, narrow buffer to the container and
5665 ;; proceed with parsing. Otherwise, return ELEMENT.
5667 ;; At a parsed affiliated keyword, check if we're inside main
5668 ;; or dual value.
5675 org-element-parsed-keywords))
5684 ;; Also change type to retrieve correct restrictions.
5686 ;; At an item, objects can only be located within tag, if any.
5696 ;; At an headline or inlinetask, objects are in title.
5703 ;; At a paragraph, a table-row or a verse block, objects are
5704 ;; located within their contents.
5708 ;; CBEG is nil for table rules.
5713 ;; At a parsed keyword, objects are located within value.
5716 org-element-document-properties))
5723 ;; At a planning line, if point is at a timestamp, return it,
5724 ;; otherwise, return element.
5732 ;; All other locations cannot contain objects: bail out.
5742 next object-data last)
5746 ;; When entering PARENT for the first time, get list
5747 ;; of objects within known so far. Store it in
5748 ;; OBJECT-DATA.
5753 ;; Find NEXT object for analysis.
5755 ;; If NEXT is non-nil, we already exhausted the
5756 ;; cache so we can parse buffer to find the object
5757 ;; after it.
5759 ;; Otherwise, check if cache can help us.
5770 ;; Cache contains the information needed.
5773 pos)
5775 pos)
5781 ;; If we have a new object to analyze, store it in
5782 ;; cache. Otherwise record that there is nothing
5783 ;; more to parse in this element at this depth.
5788 ;; Process NEXT, if any, in order to know if we need
5789 ;; to skip it, return it or move into it.
5796 ;; Skip objects ending before point. Also skip
5797 ;; objects ending at point unless it is also the
5798 ;; end of buffer, since we want to return the
5799 ;; innermost object.
5802 ;; For convenience, when object ends at POS,
5803 ;; without any space, store it in LAST, as we
5804 ;; will return it if no object starts here.
5808 ;; If POS is within a container object, move
5809 ;; into that object.
5813 ;; At contents' end, if there is no
5814 ;; space before point, also move into
5815 ;; object, for consistency with
5816 ;; convenience feature above.
5825 next nil
5826 object-data nil))
5827 ;; Otherwise, return NEXT.
5829 ;; Store results in cache, if applicable.
5833 "List all ancestors of a given element or object.
5835 BLOB is an object or element.
5837 When optional argument TYPES is a list of symbols, return the
5838 first element or object in the lineage whose type belongs to that
5839 list.
5841 When optional argument WITH-SELF is non-nil, lineage includes
5842 BLOB itself as the first element, and TYPES, if provided, also
5843 apply to it.
5845 When BLOB is obtained through `org-element-context' or
5846 `org-element-at-point', only ancestors from its section can be
5847 found. There is no such limitation when BLOB belongs to a full
5848 parse tree."
5850 ancestors)
5857 "Non-nil when elements ELEM-A and ELEM-B are nested."
5866 "Swap elements ELEM-A and ELEM-B.
5867 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5868 end of ELEM-A."
5870 ;; There are two special cases when an element doesn't start at bol:
5871 ;; the first paragraph in an item or in a footnote definition.
5873 ;; Only a paragraph without any affiliated keyword can be moved at
5874 ;; ELEM-A position in such a situation. Note that the case of
5875 ;; a footnote definition is impossible: it cannot contain two
5876 ;; paragraphs in a row because it cannot contain a blank line.
5882 ;; In a special situation, ELEM-A will have no indentation. We'll
5883 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5897 ;; Store inner overlays responsible for visibility status.
5898 ;; We also need to store their boundaries as they will be
5899 ;; removed from buffer.
5914 ;; Get contents.
5922 ;; Restore ex ELEM-A overlays.
5929 ;; Restore ex ELEM-B overlays.
5935 "Remove maximum common indentation in string S and return it.
5936 When optional argument N is a positive integer, remove exactly
5937 that much characters from indentation, if possible, or return
5938 S as-is otherwise. Unlike to `org-remove-indentation', this
5939 function doesn't call `untabify' on S."
5944 ;; Find maximum common indentation, if not specified.
5952 min-ind)))
5954 ;; Remove exactly N indentation, but give up if not possible.
5967 ;; Local variables:
5968 ;; generated-autoload-file: "org-loaddefs.el"
5969 ;; End:
5971 ;;; org-element.el ends here