| blob | ef1e70379b7cc4a879c85eee467a99b5a9730de7 |
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
325 ;; Dual affiliated keywords.
329 ;; Regular affiliated keywords.
335 org-element-affiliated-keywords)))
337 ;; Export attributes.
339 "Regexp matching any affiliated keyword.
341 Keyword name is put in match group 1. Moreover, if keyword
342 belongs to `org-element-dual-keywords', put the dual value in
343 match group 2.
357 ;; Ignore all links excepted plain links in a link description.
358 ;; Also ignore radio-targets and line breaks.
360 italic latex-fragment macro plain-link statistics-cookie
361 strike-through subscript superscript underline verbatim)
363 ;; Remove any variable object from radio target as it would
364 ;; prevent it from being properly recognized.
366 subscript superscript underline superscript)
370 ;; Ignore inline babel call and inline src block as formulas are
371 ;; possible. Also ignore line breaks and statistics cookies.
373 latex-fragment link macro radio-target strike-through
374 subscript superscript target timestamp underline verbatim)
378 "Alist of objects restrictions.
380 key is an element or object type containing objects and value is
381 a list of types that can be contained within an element or object
382 of such type.
384 For example, in a `radio-target' object, one can only find
385 entities, latex-fragments, subscript, superscript and text
386 markup.
388 This alist also applies to secondary string. For example, an
389 `headline' type element doesn't directly contain objects, but
404 "Table used internally to pair only square brackets.
408 \f
409 ;;; Accessors and Setters
410 ;;
411 ;; Provide four accessors: `org-element-type', `org-element-property'
412 ;; `org-element-contents' and `org-element-restriction'.
413 ;;
414 ;; Setter functions allow to modify elements by side effect. There is
415 ;; `org-element-put-property', `org-element-set-contents'. These
416 ;; low-level functions are useful to build a parse tree.
417 ;;
418 ;; `org-element-adopt-element', `org-element-set-element',
419 ;; `org-element-extract-element' and `org-element-insert-before' are
420 ;; high-level functions useful to modify a parse tree.
421 ;;
422 ;; `org-element-secondary-p' is a predicate used to know if a given
423 ;; object belongs to a secondary string. `org-element-copy' returns
424 ;; an element or object, stripping its parent property in the process.
427 "Return type of ELEMENT.
429 The function returns the type of the element or object provided.
430 It can also return the following special value:
431 `plain-text' for a string
432 `org-data' for a complete document
433 nil in any other case."
439 "Extract the value from the PROPERTY of an ELEMENT."
444 "Extract contents from an ELEMENT."
450 "Return restriction associated to ELEMENT.
451 ELEMENT can be an element, an object or a symbol representing an
452 element or object type."
454 org-element-object-restrictions)))
457 "In ELEMENT set PROPERTY to VALUE.
458 Return modified element."
461 element))
464 "Set ELEMENT contents to CONTENTS."
471 "Non-nil when OBJECT directly belongs to a secondary string.
472 Return value is the property name, as a keyword, or nil."
475 org-element-secondary-value-alist))))
482 "Append elements to the contents of another element.
484 PARENT is an element or object. CHILDREN can be elements,
485 objects, or a strings.
487 The function takes care of setting `:parent' property for CHILD.
488 Return parent element."
489 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
490 ;; string: parent is the list itself.
493 children)
494 ;; Add CHILDREN at the end of PARENT contents.
497 parent
499 ;; Return modified PARENT element.
503 "Extract ELEMENT from parse tree.
504 Remove element from the parse tree by side-effect, and return it
505 with its `:parent' property stripped out."
510 parent secondary
513 parent
515 ;; Return ELEMENT with its :parent removed.
519 "Insert ELEMENT before LOCATION in parse tree.
520 LOCATION is an element, object or string within the parse tree.
521 Parse tree is modified by side effect."
526 ;; Special case: LOCATION is the first element of an
527 ;; independent secondary string (e.g. :title property). Add
528 ;; ELEMENT in-place.
532 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
542 ;; Store SIBLINGS at appropriate place in parse tree.
547 ;; Set appropriate :parent property.
551 "Replace element or object OLD with element or object NEW.
552 The function takes care of setting `:parent' property for NEW."
553 ;; Ensure OLD and NEW have the same parent.
557 ;; We cannot replace OLD with NEW since one of them is not an
558 ;; object or element. We take the long path.
561 ;; Since OLD is going to be changed into NEW by side-effect, first
562 ;; make sure that every element or object within NEW has OLD as
563 ;; parent.
566 ;; Transfer contents.
568 ;; Overwrite OLD's properties with NEW's.
570 ;; Transfer type.
574 "Return a copy of DATUM.
575 DATUM is an element, object, string or nil. `:parent' property
576 is cleared and contents are removed in the process."
587 \f
588 ;;; Greater elements
589 ;;
590 ;; For each greater element type, we define a parser and an
591 ;; interpreter.
592 ;;
593 ;; A parser returns the element or object as the list described above.
594 ;; Most of them accepts no argument. Though, exceptions exist. Hence
595 ;; every element containing a secondary string (see
596 ;; `org-element-secondary-value-alist') will accept an optional
597 ;; argument to toggle parsing of these secondary strings. Moreover,
598 ;; `item' parser requires current list's structure as its first
599 ;; element.
600 ;;
601 ;; An interpreter accepts two arguments: the list representation of
602 ;; the element or object, and its contents. The latter may be nil,
603 ;; depending on the element or object considered. It returns the
604 ;; appropriate Org syntax, as a string.
605 ;;
606 ;; Parsing functions must follow the naming convention:
607 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
608 ;; defined in `org-element-greater-elements'.
609 ;;
610 ;; Similarly, interpreting functions must follow the naming
611 ;; convention: org-element-TYPE-interpreter.
612 ;;
613 ;; With the exception of `headline' and `item' types, greater elements
614 ;; cannot contain other greater elements of their own type.
615 ;;
616 ;; Beside implementing a parser and an interpreter, adding a new
617 ;; greater element requires to tweak `org-element--current-element'.
618 ;; Moreover, the newly defined type must be added to both
619 ;; `org-element-all-elements' and `org-element-greater-elements'.
622 ;;;; Center Block
625 "Parse a center block.
627 LIMIT bounds the search. AFFILIATED is a list of which CAR is
628 the buffer position at the beginning of the first affiliated
629 keyword and CDR is a plist of affiliated keywords along with
630 their value.
632 Return a list whose CAR is `center-block' and CDR is a plist
633 containing `:begin', `:end', `:contents-begin', `:contents-end',
634 `:post-blank' and `:post-affiliated' keywords.
636 Assume point is at the beginning of the block."
640 ;; Incomplete block: parse it as a paragraph.
645 ;; Empty blocks have no contents.
659 :end end
660 :contents-begin contents-begin
661 :contents-end contents-end
667 "Interpret CENTER-BLOCK element as Org syntax.
668 CONTENTS is the contents of the element."
672 ;;;; Drawer
675 "Parse a drawer.
677 LIMIT bounds the search. AFFILIATED is a list of which CAR is
678 the buffer position at the beginning of the first affiliated
679 keyword and CDR is a plist of affiliated keywords along with
680 their value.
682 Return a list whose CAR is `drawer' and CDR is a plist containing
683 `:drawer-name', `:begin', `:end', `:contents-begin',
684 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
686 Assume point is at beginning of drawer."
689 ;; Incomplete drawer: parse it as a paragraph.
697 ;; Empty drawers have no contents.
710 :end end
711 :drawer-name name
712 :contents-begin contents-begin
713 :contents-end contents-end
719 "Interpret DRAWER element as Org syntax.
720 CONTENTS is the contents of the element."
723 contents))
726 ;;;; Dynamic Block
729 "Parse a dynamic block.
731 LIMIT bounds the search. AFFILIATED is a list of which CAR is
732 the buffer position at the beginning of the first affiliated
733 keyword and CDR is a plist of affiliated keywords along with
734 their value.
736 Return a list whose CAR is `dynamic-block' and CDR is a plist
737 containing `:block-name', `:begin', `:end', `:contents-begin',
738 `:contents-end', `:arguments', `:post-blank' and
739 `:post-affiliated' keywords.
741 Assume point is at beginning of dynamic block."
745 ;; Incomplete block: parse it as a paragraph.
754 ;; Empty blocks have no contents.
767 :end end
768 :block-name name
769 :arguments arguments
770 :contents-begin contents-begin
771 :contents-end contents-end
777 "Interpret DYNAMIC-BLOCK element as Org syntax.
778 CONTENTS is the contents of the element."
783 contents))
786 ;;;; Footnote Definition
789 "Parse a footnote definition.
791 LIMIT bounds the search. AFFILIATED is a list of which CAR is
792 the buffer position at the beginning of the first affiliated
793 keyword and CDR is a plist of affiliated keywords along with
794 their value.
796 Return a list whose CAR is `footnote-definition' and CDR is
797 a plist containing `:label', `:begin' `:end', `:contents-begin',
798 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
800 Assume point is at the beginning of the footnote definition."
828 :begin begin
829 :end end
830 :contents-begin contents-begin
831 :contents-end contents-end
837 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
838 CONTENTS is the contents of the footnote-definition."
840 " "
841 contents))
844 ;;;; Headline
847 "Return node properties associated to headline at point.
848 Upcase property names. It avoids confusion between properties
849 obtained through property drawer and default properties from the
850 parser (e.g. `:end' and :END:). Return value is a plist."
862 properties))))
865 "Return time properties associated to headline at point.
866 Return value is a plist."
880 plist))))
883 "Parse a headline.
885 Return a list whose CAR is `headline' and CDR is a plist
886 containing `:raw-value', `:title', `:begin', `:end',
887 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
888 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
889 `:deadline', `:closed', `:archivedp', `:commentedp'
890 `:footnote-section-p', `:post-blank' and `:post-affiliated'
891 keywords.
893 The plist also contains any property set in the property drawer,
894 with its name in upper cases and colons added at the
895 beginning (e.g., `:CUSTOM_ID').
897 LIMIT is a buffer position bounding the search.
899 When RAW-SECONDARY-P is non-nil, headline's title will not be
900 parsed as a secondary string, but as a plain string instead.
902 Assume point is at beginning of the headline."
945 ;; Clean TAGS from archive tag, if any.
951 :begin begin
952 :end end
953 :pre-blank
956 :contents-begin contents-begin
957 :contents-end contents-end
958 :level level
959 :priority priority
960 :tags tags
961 :todo-keyword todo
962 :todo-type todo-type
965 end)
966 :footnote-section-p footnote-section-p
967 :archivedp archivedp
968 :commentedp commentedp
970 time-props
971 standard-props))))
973 headline :title
982 nil
988 "Interpret HEADLINE element as Org syntax.
989 CONTENTS is the contents of the element."
1005 ?*)
1009 " "
1012 org-footnote-section
1013 title))))
1015 heading
1016 ;; Align tags.
1024 ?\s)
1025 tags))
1029 tags))))
1031 contents)))
1034 ;;;; Inlinetask
1037 "Parse an inline task.
1039 Return a list whose CAR is `inlinetask' and CDR is a plist
1040 containing `:title', `:begin', `:end', `:contents-begin' and
1041 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1042 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1043 `:closed', `:post-blank' and `:post-affiliated' keywords.
1045 The plist also contains any property set in the property drawer,
1046 with its name in upper cases and colons added at the
1047 beginning (e.g., `:CUSTOM_ID').
1049 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1050 title will not be parsed as a secondary string, but as a plain
1051 string instead.
1053 Assume point is at beginning of the inline task."
1098 :begin begin
1099 :end end
1100 :contents-begin contents-begin
1101 :contents-end contents-end
1102 :level level
1103 :priority priority
1104 :tags tags
1105 :todo-keyword todo
1106 :todo-type todo-type
1109 time-props
1110 standard-props))))
1112 inlinetask :title
1121 nil
1127 "Interpret INLINETASK element as Org syntax.
1128 CONTENTS is the contents of inlinetask."
1142 ;; Align tags.
1150 ? )
1151 tags))
1155 tags))))
1156 ;; Prefer degenerate inlinetasks when there are no
1157 ;; contents.
1160 contents
1164 ;;;; Item
1167 "Parse an item.
1169 STRUCT is the structure of the plain list.
1171 Return a list whose CAR is `item' and CDR is a plist containing
1172 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1173 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1174 `:post-affiliated' keywords.
1176 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1177 any, will not be parsed as a secondary string, but as a plain
1178 string instead.
1180 Assume point is at the beginning of the item."
1204 ;; Ignore tags in un-ordered lists: they are just
1205 ;; a part of item's body.
1211 ;; If first line isn't empty, contents really start
1212 ;; at the text after item's meta-data.
1221 :begin begin
1222 :end end
1223 ;; CONTENTS-BEGIN and CONTENTS-END may be
1224 ;; mixed up in the case of an empty item
1225 ;; separated from the next by a blank line.
1226 ;; Thus ensure the former is always the
1227 ;; smallest.
1230 :checkbox checkbox
1231 :counter counter
1232 :structure struct
1236 item :tag
1247 "Interpret ITEM element as Org syntax.
1248 CONTENTS is the contents of the element."
1258 ;; Compute indentation.
1263 ;; Indent contents.
1265 bullet
1279 ;;;; Plain List
1282 ;; Return structure of list at point. Internal function. See
1283 ;; `org-list-struct' for details.
1288 items struct)
1293 ;; At limit: end all items.
1302 ;; At list end: end all items.
1307 ;; At a new item: end previous sibling.
1319 ind
1320 bullet
1323 ;; Description tag.
1327 ;; Ending position, unknown so far.
1328 nil)))
1329 items))
1331 ;; Skip empty lines.
1333 ;; Skip inline tasks and blank lines along the way.
1340 ;; At some text line. Check if it ends any previous item.
1352 ;; Skip blocks (any type) and drawers contents.
1357 limit t)))
1363 "Parse a plain list.
1365 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1366 the buffer position at the beginning of the first affiliated
1367 keyword and CDR is a plist of affiliated keywords along with
1368 their value. STRUCTURE is the structure of the plain list being
1369 parsed.
1371 Return a list whose CAR is `plain-list' and CDR is a plist
1372 containing `:type', `:begin', `:end', `:contents-begin' and
1373 `:contents-end', `:structure', `:post-blank' and
1374 `:post-affiliated' keywords.
1376 Assume point is at the beginning of the list."
1390 pos))
1394 ;; Return value.
1398 :begin begin
1399 :end end
1400 :contents-begin contents-begin
1401 :contents-end contents-end
1402 :structure struct
1408 "Interpret PLAIN-LIST element as Org syntax.
1409 CONTENTS is the contents of the element."
1417 ;;;; Property Drawer
1420 "Parse a property drawer.
1422 LIMIT bounds the search.
1424 Return a list whose car is `property-drawer' and cdr is a plist
1425 containing `:begin', `:end', `:contents-begin', `:contents-end',
1426 `:post-blank' and `:post-affiliated' keywords.
1428 Assume point is at the beginning of the property drawer."
1441 :end end
1443 :contents-end contents-end
1448 "Interpret PROPERTY-DRAWER element as Org syntax.
1449 CONTENTS is the properties within the drawer."
1453 ;;;; Quote Block
1456 "Parse a quote block.
1458 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1459 the buffer position at the beginning of the first affiliated
1460 keyword and CDR is a plist of affiliated keywords along with
1461 their value.
1463 Return a list whose CAR is `quote-block' and CDR is a plist
1464 containing `:begin', `:end', `:contents-begin', `:contents-end',
1465 `:post-blank' and `:post-affiliated' keywords.
1467 Assume point is at the beginning of the block."
1471 ;; Incomplete block: parse it as a paragraph.
1477 ;; Empty blocks have no contents.
1490 :end end
1491 :contents-begin contents-begin
1492 :contents-end contents-end
1498 "Interpret QUOTE-BLOCK element as Org syntax.
1499 CONTENTS is the contents of the element."
1503 ;;;; Section
1506 "Parse a section.
1508 LIMIT bounds the search.
1510 Return a list whose CAR is `section' and CDR is a plist
1511 containing `:begin', `:end', `:contents-begin', `contents-end',
1512 `:post-blank' and `:post-affiliated' keywords."
1514 ;; Beginning of section is the beginning of the first non-blank
1515 ;; line after previous headline.
1524 :end end
1525 :contents-begin begin
1526 :contents-end pos-before-blank
1531 "Interpret SECTION element as Org syntax.
1532 CONTENTS is the contents of the element."
1533 contents)
1536 ;;;; Special Block
1539 "Parse a special block.
1541 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1542 the buffer position at the beginning of the first affiliated
1543 keyword and CDR is a plist of affiliated keywords along with
1544 their value.
1546 Return a list whose CAR is `special-block' and CDR is a plist
1547 containing `:type', `:begin', `:end', `:contents-begin',
1548 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1550 Assume point is at the beginning of the block."
1557 limit t)))
1558 ;; Incomplete block: parse it as a paragraph.
1564 ;; Empty blocks have no contents.
1577 :begin begin
1578 :end end
1579 :contents-begin contents-begin
1580 :contents-end contents-end
1586 "Interpret SPECIAL-BLOCK element as Org syntax.
1587 CONTENTS is the contents of the element."
1592 \f
1593 ;;; Elements
1594 ;;
1595 ;; For each element, a parser and an interpreter are also defined.
1596 ;; Both follow the same naming convention used for greater elements.
1597 ;;
1598 ;; Also, as for greater elements, adding a new element type is done
1599 ;; through the following steps: implement a parser and an interpreter,
1600 ;; tweak `org-element--current-element' so that it recognizes the new
1601 ;; type and add that new type to `org-element-all-elements'.
1602 ;;
1603 ;; As a special case, when the newly defined type is a block type,
1604 ;; `org-element-block-name-alist' has to be modified accordingly.
1607 ;;;; Babel Call
1610 "Parse a babel call.
1612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1613 the buffer position at the beginning of the first affiliated
1614 keyword and CDR is a plist of affiliated keywords along with
1615 their value.
1617 Return a list whose CAR is `babel-call' and CDR is a plist
1618 containing `:begin', `:end', `:value', `:post-blank' and
1619 `:post-affiliated' as keywords."
1633 :end end
1634 :value value
1640 "Interpret BABEL-CALL element as Org syntax.
1641 CONTENTS is nil."
1645 ;;;; Clock
1648 "Parse a clock.
1650 LIMIT bounds the search.
1652 Return a list whose CAR is `clock' and CDR is a plist containing
1653 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1654 `:post-affiliated' as keywords."
1674 :value value
1675 :duration duration
1676 :begin begin
1677 :end end
1678 :post-blank post-blank
1682 "Interpret CLOCK element as Org syntax.
1683 CONTENTS is nil."
1691 "%2s:%02s"
1695 ;;;; Comment
1698 "Parse a comment.
1700 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1701 the buffer position at the beginning of the first affiliated
1702 keyword and CDR is a plist of affiliated keywords along with
1703 their value.
1705 Return a list whose CAR is `comment' and CDR is a plist
1706 containing `:begin', `:end', `:value', `:post-blank',
1707 `:post-affiliated' keywords.
1709 Assume point is at comment beginning."
1718 ;; Get comments ending.
1721 ;; Accumulate lines without leading hash and first
1722 ;; whitespace.
1736 :end end
1737 :value value
1743 "Interpret COMMENT element as Org syntax.
1744 CONTENTS is nil."
1748 ;;;; Comment Block
1751 "Parse an export block.
1753 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1754 the buffer position at the beginning of the first affiliated
1755 keyword and CDR is a plist of affiliated keywords along with
1756 their value.
1758 Return a list whose CAR is `comment-block' and CDR is a plist
1759 containing `:begin', `:end', `:value', `:post-blank' and
1760 `:post-affiliated' keywords.
1762 Assume point is at comment block beginning."
1766 ;; Incomplete block: parse it as a paragraph.
1779 contents-begin contents-end)))
1783 :end end
1784 :value value
1790 "Interpret COMMENT-BLOCK element as Org syntax.
1791 CONTENTS is nil."
1798 ;;;; Diary Sexp
1801 "Parse a diary sexp.
1803 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1804 the buffer position at the beginning of the first affiliated
1805 keyword and CDR is a plist of affiliated keywords along with
1806 their value.
1808 Return a list whose CAR is `diary-sexp' and CDR is a plist
1809 containing `:begin', `:end', `:value', `:post-blank' and
1810 `:post-affiliated' keywords."
1822 :begin begin
1823 :end end
1829 "Interpret DIARY-SEXP as Org syntax.
1830 CONTENTS is nil."
1834 ;;;; Example Block
1837 "Parse an example block.
1839 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1840 the buffer position at the beginning of the first affiliated
1841 keyword and CDR is a plist of affiliated keywords along with
1842 their value.
1844 Return a list whose CAR is `example-block' and CDR is a plist
1845 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1846 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1847 `:value', `:post-blank' and `:post-affiliated' keywords."
1851 ;; Incomplete block: parse it as a paragraph.
1859 ;; Switches analysis
1866 ;; Should labels be retained in (or stripped from) example
1867 ;; blocks?
1872 ;; What should code-references use - labels or
1873 ;; line-numbers?
1882 ;; Standard block parsing.
1890 contents-begin contents-end))
1891 block-ind))
1900 :end end
1901 :value value
1902 :switches switches
1903 :number-lines number-lines
1904 :preserve-indent preserve-indent
1905 :retain-labels retain-labels
1906 :use-labels use-labels
1907 :label-fmt label-fmt
1913 "Interpret EXAMPLE-BLOCK element as Org syntax.
1914 CONTENTS is nil."
1922 value
1927 ;;;; Export Block
1930 "Parse an export block.
1932 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1933 the buffer position at the beginning of the first affiliated
1934 keyword and CDR is a plist of affiliated keywords along with
1935 their value.
1937 Return a list whose CAR is `export-block' and CDR is a plist
1938 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1939 `:post-affiliated' keywords.
1941 Assume point is at export-block beginning."
1948 ;; Incomplete block: parse it as a paragraph.
1961 contents-end)))
1965 :end end
1966 :type type
1967 :value value
1973 "Interpret EXPORT-BLOCK element as Org syntax.
1974 CONTENTS is nil."
1981 ;;;; Fixed-width
1984 "Parse a fixed-width section.
1986 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1987 the buffer position at the beginning of the first affiliated
1988 keyword and CDR is a plist of affiliated keywords along with
1989 their value.
1991 Return a list whose CAR is `fixed-width' and CDR is a plist
1992 containing `:begin', `:end', `:value', `:post-blank' and
1993 `:post-affiliated' keywords.
1995 Assume point is at the beginning of the fixed-width area."
1999 value
2004 ;; Accumulate text without starting colons.
2017 :end end
2018 :value value
2024 "Interpret FIXED-WIDTH element as Org syntax.
2025 CONTENTS is nil."
2033 ;;;; Horizontal Rule
2036 "Parse an horizontal rule.
2038 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2039 the buffer position at the beginning of the first affiliated
2040 keyword and CDR is a plist of affiliated keywords along with
2041 their value.
2043 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2044 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2045 keywords."
2055 :end end
2061 "Interpret HORIZONTAL-RULE element as Org syntax.
2062 CONTENTS is nil."
2066 ;;;; Keyword
2069 "Parse a keyword at point.
2071 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2072 the buffer position at the beginning of the first affiliated
2073 keyword and CDR is a plist of affiliated keywords along with
2074 their value.
2076 Return a list whose CAR is `keyword' and CDR is a plist
2077 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2078 `:post-affiliated' keywords."
2080 ;; An orphaned affiliated keyword is considered as a regular
2081 ;; keyword. In this case AFFILIATED is nil, so we take care of
2082 ;; this corner case.
2095 :value value
2096 :begin begin
2097 :end end
2103 "Interpret KEYWORD element as Org syntax.
2104 CONTENTS is nil."
2110 ;;;; Latex Environment
2114 "Regexp matching the beginning of a LaTeX environment.
2115 The environment is captured by the first group.
2121 "Format string matching the ending of a LaTeX environment.
2125 "Parse a LaTeX environment.
2127 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2128 the buffer position at the beginning of the first affiliated
2129 keyword and CDR is a plist of affiliated keywords along with
2130 their value.
2132 Return a list whose CAR is `latex-environment' and CDR is a plist
2133 containing `:begin', `:end', `:value', `:post-blank' and
2134 `:post-affiliated' keywords.
2136 Assume point is at the beginning of the latex environment."
2143 limit t))
2144 ;; Incomplete latex environment: parse it as a paragraph.
2154 :end end
2155 :value value
2161 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2162 CONTENTS is nil."
2166 ;;;; Node Property
2169 "Parse a node-property at point.
2171 LIMIT bounds the search.
2173 Return a list whose CAR is `node-property' and CDR is a plist
2174 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2175 `:post-affiliated' keywords."
2185 limit))))
2188 :value value
2189 :begin begin
2190 :end end
2195 "Interpret NODE-PROPERTY element as Org syntax.
2196 CONTENTS is nil."
2202 ;;;; Paragraph
2205 "Parse a paragraph.
2207 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2208 the buffer position at the beginning of the first affiliated
2209 keyword and CDR is a plist of affiliated keywords along with
2210 their value.
2212 Return a list whose CAR is `paragraph' and CDR is a plist
2213 containing `:begin', `:end', `:contents-begin' and
2214 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2216 Assume point is at the beginning of the paragraph."
2225 limit
2226 ;; A matching `org-element-paragraph-separate' is not
2227 ;; necessarily the end of the paragraph. In
2228 ;; particular, lines starting with # or : as a first
2229 ;; non-space character are ambiguous. We have to
2230 ;; check if they are valid Org syntax (e.g., not an
2231 ;; incomplete keyword).
2235 ;; There's no ambiguity for other symbols or
2236 ;; empty lines: stop here.
2238 ;; Stop at valid fixed-width areas.
2240 ;; Stop at drawers.
2245 ;; Stop at valid comments.
2247 ;; Stop at valid dynamic blocks.
2252 ;; Stop at valid blocks.
2259 limit t)))
2260 ;; Stop at valid latex environments.
2267 limit t)))
2268 ;; Stop at valid keywords.
2270 ;; Skip everything else.
2287 :end end
2288 :contents-begin contents-begin
2289 :contents-end contents-end
2295 "Interpret PARAGRAPH element as Org syntax.
2296 CONTENTS is the contents of the element."
2297 contents)
2300 ;;;; Planning
2303 "Parse a planning.
2305 LIMIT bounds the search.
2307 Return a list whose CAR is `planning' and CDR is a plist
2308 containing `:closed', `:deadline', `:scheduled', `:begin',
2309 `:end', `:post-blank' and `:post-affiliated' keywords."
2319 closed deadline scheduled)
2331 :deadline deadline
2332 :scheduled scheduled
2333 :begin begin
2334 :end end
2335 :post-blank post-blank
2339 "Interpret PLANNING element as Org syntax.
2340 CONTENTS is nil."
2342 'identity
2359 ;;;; Src Block
2362 "Parse a src block.
2364 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2365 the buffer position at the beginning of the first affiliated
2366 keyword and CDR is a plist of affiliated keywords along with
2367 their value.
2369 Return a list whose CAR is `src-block' and CDR is a plist
2370 containing `:language', `:switches', `:parameters', `:begin',
2371 `:end', `:number-lines', `:retain-labels', `:use-labels',
2372 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2373 `:post-affiliated' keywords.
2375 Assume point is at the beginning of the block."
2378 limit t)))
2379 ;; Incomplete block: parse it as a paragraph.
2385 ;; Get language as a string.
2394 ;; Get switches.
2396 ;; Get parameters.
2398 ;; Switches analysis
2409 ;; Should labels be retained in (or stripped from)
2410 ;; src blocks?
2415 ;; What should code-references use - labels or
2416 ;; line-numbers?
2421 ;; Indentation.
2423 ;; Retrieve code.
2428 block-ind))
2432 ;; Get position after ending blank lines.
2442 :begin begin
2443 :end end
2444 :number-lines number-lines
2445 :preserve-indent preserve-indent
2446 :retain-labels retain-labels
2447 :use-labels use-labels
2448 :label-fmt label-fmt
2449 :value value
2455 "Interpret SRC-BLOCK element as Org syntax.
2456 CONTENTS is nil."
2465 val)
2479 ;;;; Table
2482 "Parse a table at point.
2484 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2485 the buffer position at the beginning of the first affiliated
2486 keyword and CDR is a plist of affiliated keywords along with
2487 their value.
2489 Return a list whose CAR is `table' and CDR is a plist containing
2490 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2491 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2492 keywords.
2494 Assume point is at the beginning of the table."
2508 acc))
2515 :end end
2516 :type type
2517 :tblfm tblfm
2518 ;; Only `org' tables have contents. `table.el' tables
2519 ;; use a `:value' property to store raw table as
2520 ;; a string.
2525 table-begin table-end))
2531 "Interpret TABLE element as Org syntax.
2532 CONTENTS is a string, if table's type is `org', or nil."
2543 ;;;; Table Row
2546 "Parse table row at point.
2548 LIMIT bounds the search.
2550 Return a list whose CAR is `table-row' and CDR is a plist
2551 containing `:begin', `:end', `:contents-begin', `:contents-end',
2552 `:type', `:post-blank' and `:post-affiliated' keywords."
2556 ;; A table rule has no contents. In that case, ensure
2557 ;; CONTENTS-BEGIN matches CONTENTS-END.
2569 :begin begin
2570 :end end
2571 :contents-begin contents-begin
2572 :contents-end contents-end
2577 "Interpret TABLE-ROW element as Org syntax.
2578 CONTENTS is the contents of the table row."
2583 ;;;; Verse Block
2586 "Parse a verse block.
2588 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2589 the buffer position at the beginning of the first affiliated
2590 keyword and CDR is a plist of affiliated keywords along with
2591 their value.
2593 Return a list whose CAR is `verse-block' and CDR is a plist
2594 containing `:begin', `:end', `:contents-begin', `:contents-end',
2595 `:post-blank' and `:post-affiliated' keywords.
2597 Assume point is at beginning of the block."
2601 ;; Incomplete block: parse it as a paragraph.
2616 :end end
2617 :contents-begin contents-begin
2618 :contents-end contents-end
2624 "Interpret VERSE-BLOCK element as Org syntax.
2625 CONTENTS is verse block contents."
2629 \f
2630 ;;; Objects
2631 ;;
2632 ;; Unlike to elements, raw text can be found between objects. Hence,
2633 ;; `org-element--object-lex' is provided to find the next object in
2634 ;; buffer.
2635 ;;
2636 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2637 ;; object types they can contain will be specified in
2638 ;; `org-element-object-restrictions'.
2639 ;;
2640 ;; Creating a new type of object requires to alter
2641 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2642 ;; new type in `org-element-all-objects', and possibly add
2643 ;; restrictions in `org-element-object-restrictions'.
2645 ;;;; Bold
2648 "Parse bold object at point, if any.
2650 When at a bold object, return a list whose car is `bold' and cdr
2651 is a plist with `:begin', `:end', `:contents-begin' and
2652 `:contents-end' and `:post-blank' keywords. Otherwise, return
2653 nil.
2655 Assume point is at the first star marker."
2667 :end end
2668 :contents-begin contents-begin
2669 :contents-end contents-end
2673 "Interpret BOLD object as Org syntax.
2674 CONTENTS is the contents of the object."
2678 ;;;; Code
2681 "Parse code object at point, if any.
2683 When at a code object, return a list whose car is `code' and cdr
2684 is a plist with `:value', `:begin', `:end' and `:post-blank'
2685 keywords. Otherwise, return nil.
2687 Assume point is at the first tilde marker."
2698 :begin begin
2699 :end end
2703 "Interpret CODE object as Org syntax.
2704 CONTENTS is nil."
2708 ;;;; Entity
2711 "Parse entity at point, if any.
2713 When at an entity, return a list whose car is `entity' and cdr
2714 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2715 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2716 `:post-blank' as keywords. Otherwise, return nil.
2718 Assume point is at the beginning of the entity."
2720 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2738 :begin begin
2739 :end end
2740 :use-brackets-p bracketsp
2744 "Interpret ENTITY object as Org syntax.
2745 CONTENTS is nil."
2751 ;;;; Export Snippet
2754 "Parse export snippet at point.
2756 When at an export snippet, return a list whose car is
2757 `export-snippet' and cdr a plist with `:begin', `:end',
2758 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2759 return nil.
2761 Assume point is at the beginning of the snippet."
2777 :value value
2778 :begin begin
2779 :end end
2783 "Interpret EXPORT-SNIPPET object as Org syntax.
2784 CONTENTS is nil."
2790 ;;;; Footnote Reference
2793 "Parse footnote reference at point, if any.
2795 When at a footnote reference, return a list whose car is
2796 `footnote-reference' and cdr a plist with `:label', `:type',
2797 `:begin', `:end', `:content-begin', `:contents-end' and
2798 `:post-blank' as keywords. Otherwise, return nil."
2818 :type type
2819 :begin begin
2820 :end end
2826 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2827 CONTENTS is its definition, when inline, or nil."
2833 ;;;; Inline Babel Call
2836 "Parse inline babel call at point, if any.
2838 When at an inline babel call, return a list whose car is
2839 `inline-babel-call' and cdr a plist with `:begin', `:end',
2840 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2842 Assume point is at the beginning of the babel call."
2854 :end end
2855 :value value
2859 "Interpret INLINE-BABEL-CALL object as Org syntax.
2860 CONTENTS is nil."
2864 ;;;; Inline Src Block
2867 "Parse inline source block at point, if any.
2869 When at an inline source block, return a list whose car is
2870 `inline-src-block' and cdr a plist with `:begin', `:end',
2871 `:language', `:value', `:parameters' and `:post-blank' as
2872 keywords. Otherwise, return nil.
2874 Assume point is at the beginning of the inline src block."
2887 :value value
2888 :parameters parameters
2889 :begin begin
2890 :end end
2894 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2895 CONTENTS is nil."
2900 language
2902 body)))
2904 ;;;; Italic
2907 "Parse italic object at point, if any.
2909 When at an italic object, return a list whose car is `italic' and
2910 cdr is a plist with `:begin', `:end', `:contents-begin' and
2911 `:contents-end' and `:post-blank' keywords. Otherwise, return
2912 nil.
2914 Assume point is at the first slash marker."
2926 :end end
2927 :contents-begin contents-begin
2928 :contents-end contents-end
2932 "Interpret ITALIC object as Org syntax.
2933 CONTENTS is the contents of the object."
2937 ;;;; Latex Fragment
2940 "Parse LaTeX fragment at point, if any.
2942 When at a LaTeX fragment, return a list whose car is
2943 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2944 and `:post-blank' as keywords. Otherwise, return nil.
2946 Assume point is at the beginning of the LaTeX fragment."
2964 ;; Macro.
2973 :begin begin
2974 :end end
2978 "Interpret LATEX-FRAGMENT object as Org syntax.
2979 CONTENTS is nil."
2982 ;;;; Line Break
2985 "Parse line break at point, if any.
2987 When at a line break, return a list whose car is `line-break',
2988 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2989 Otherwise, return nil.
2991 Assume point is at the beginning of the line break."
3000 "Interpret LINE-BREAK object as Org syntax.
3001 CONTENTS is nil."
3005 ;;;; Link
3008 "Parse link at point, if any.
3010 When at a link, return a list whose car is `link' and cdr a plist
3011 with `:type', `:path', `:raw-link', `:application',
3012 `:search-option', `:begin', `:end', `:contents-begin',
3013 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3014 nil.
3016 Assume point is at the beginning of the link."
3019 end contents-begin contents-end link-end post-blank path type
3020 raw-link link search-option application)
3022 ;; Type 1: Text targeted from a radio target.
3031 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3036 ;; RAW-LINK is the original link. Expand any
3037 ;; abbreviation in it.
3041 ;; Determine TYPE of link and set PATH accordingly.
3043 ;; File type.
3047 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3050 ;; According to RFC 3986, extra whitespace should be
3051 ;; ignored when a URI is extracted.
3054 ;; Id type: PATH is the id.
3057 ;; Code-ref type: PATH is the name of the reference.
3060 ;; Custom-id type: PATH is the name of the custom id.
3063 ;; Fuzzy type: Internal link either matches a target, an
3064 ;; headline name or nothing. PATH is the target or
3065 ;; headline's name.
3067 ;; Type 3: Plain link, e.g., http://orgmode.org
3073 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3081 ;; In any case, deduce end point after trailing white space from
3082 ;; LINK-END variable.
3086 ;; Special "file" type link processing. Extract opening
3087 ;; application and search option, if any. Also normalize URI.
3098 :path path
3100 :application application
3101 :search-option search-option
3102 :begin begin
3103 :end end
3104 :contents-begin contents-begin
3105 :contents-end contents-end
3109 "Interpret LINK object as Org syntax.
3110 CONTENTS is the contents of the object, or nil."
3115 raw-link
3119 ;;;; Macro
3122 "Parse macro at point, if any.
3124 When at a macro, return a list whose car is `macro' and cdr
3125 a plist with `:key', `:args', `:begin', `:end', `:value' and
3126 `:post-blank' as keywords. Otherwise, return nil.
3128 Assume point is at the macro."
3141 :value value
3142 :args args
3143 :begin begin
3144 :end end
3148 "Interpret MACRO object as Org syntax.
3149 CONTENTS is nil."
3153 ;;;; Radio-target
3156 "Parse radio target at point, if any.
3158 When at a radio target, return a list whose car is `radio-target'
3159 and cdr a plist with `:begin', `:end', `:contents-begin',
3160 `:contents-end', `:value' and `:post-blank' as keywords.
3161 Otherwise, return nil.
3163 Assume point is at the radio target."
3175 :end end
3176 :contents-begin contents-begin
3177 :contents-end contents-end
3178 :post-blank post-blank
3182 "Interpret TARGET object as Org syntax.
3183 CONTENTS is the contents of the object."
3187 ;;;; Statistics Cookie
3190 "Parse statistics cookie at point, if any.
3192 When at a statistics cookie, return a list whose car is
3193 `statistics-cookie', and cdr a plist with `:begin', `:end',
3194 `:value' and `:post-blank' keywords. Otherwise, return nil.
3196 Assume point is at the beginning of the statistics-cookie."
3207 :end end
3208 :value value
3212 "Interpret STATISTICS-COOKIE object as Org syntax.
3213 CONTENTS is nil."
3217 ;;;; Strike-Through
3220 "Parse strike-through object at point, if any.
3222 When at a strike-through object, return a list whose car is
3223 `strike-through' and cdr is a plist with `:begin', `:end',
3224 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3225 Otherwise, return nil.
3227 Assume point is at the first plus sign marker."
3239 :end end
3240 :contents-begin contents-begin
3241 :contents-end contents-end
3245 "Interpret STRIKE-THROUGH object as Org syntax.
3246 CONTENTS is the contents of the object."
3250 ;;;; Subscript
3253 "Parse subscript at point, if any.
3255 When at a subscript object, return a list whose car is
3256 `subscript' and cdr a plist with `:begin', `:end',
3257 `:contents-begin', `:contents-end', `:use-brackets-p' and
3258 `:post-blank' as keywords. Otherwise, return nil.
3260 Assume point is at the underscore."
3274 :end end
3275 :use-brackets-p bracketsp
3276 :contents-begin contents-begin
3277 :contents-end contents-end
3281 "Interpret SUBSCRIPT object as Org syntax.
3282 CONTENTS is the contents of the object."
3285 contents))
3288 ;;;; Superscript
3291 "Parse superscript at point, if any.
3293 When at a superscript object, return a list whose car is
3294 `superscript' and cdr a plist with `:begin', `:end',
3295 `:contents-begin', `:contents-end', `:use-brackets-p' and
3296 `:post-blank' as keywords. Otherwise, return nil.
3298 Assume point is at the caret."
3312 :end end
3313 :use-brackets-p bracketsp
3314 :contents-begin contents-begin
3315 :contents-end contents-end
3319 "Interpret SUPERSCRIPT object as Org syntax.
3320 CONTENTS is the contents of the object."
3323 contents))
3326 ;;;; Table Cell
3329 "Parse table cell at point.
3330 Return a list whose car is `table-cell' and cdr is a plist
3331 containing `:begin', `:end', `:contents-begin', `:contents-end'
3332 and `:post-blank' keywords."
3340 :end end
3341 :contents-begin contents-begin
3342 :contents-end contents-end
3346 "Interpret TABLE-CELL element as Org syntax.
3347 CONTENTS is the contents of the cell, or nil."
3351 ;;;; Target
3354 "Parse target at point, if any.
3356 When at a target, return a list whose car is `target' and cdr
3357 a plist with `:begin', `:end', `:value' and `:post-blank' as
3358 keywords. Otherwise, return nil.
3360 Assume point is at the target."
3370 :end end
3371 :value value
3375 "Interpret TARGET object as Org syntax.
3376 CONTENTS is nil."
3380 ;;;; Timestamp
3391 "Parse time stamp at point, if any.
3393 When at a time stamp, return a list whose car is `timestamp', and
3394 cdr a plist with `:type', `:raw-value', `:year-start',
3395 `:month-start', `:day-start', `:hour-start', `:minute-start',
3396 `:year-end', `:month-end', `:day-end', `:hour-end',
3397 `:minute-end', `:repeater-type', `:repeater-value',
3398 `:repeater-unit', `:warning-type', `:warning-value',
3399 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3400 Otherwise, return nil.
3402 Assume point is at the beginning of the timestamp."
3421 date-start)
3432 raw-value)
3434 :repeater-type
3440 :repeater-unit
3449 :warning-unit
3452 year-start month-start day-start hour-start minute-start year-end
3453 month-end day-end hour-end minute-end)
3454 ;; Parse date-start.
3462 ;; Compute date-end. It can be provided directly in time-stamp,
3463 ;; or extracted from time range. Otherwise, it defaults to the
3464 ;; same values as date-start.
3474 :raw-value raw-value
3475 :year-start year-start
3476 :month-start month-start
3477 :day-start day-start
3478 :hour-start hour-start
3479 :minute-start minute-start
3480 :year-end year-end
3481 :month-end month-end
3482 :day-end day-end
3483 :hour-end hour-end
3484 :minute-end minute-end
3485 :begin begin
3486 :end end
3488 repeater-props
3489 warning-props))))))
3492 "Interpret TIMESTAMP object as Org syntax.
3493 CONTENTS is nil."
3512 ;; Build an Org timestamp string from TIME. ACTIVEP is
3513 ;; non-nil when time stamp is active. If WITH-TIME-P is
3514 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3515 ;; specify a time range in the timestamp. REPEAT-STRING is
3516 ;; the repeater string, if any.
3520 org-time-stamp-formats)
3521 time)))
3527 nil nil ts)))
3532 " "
3533 s
3535 ;; Return value.
3536 ts)))
3548 build-ts-string
3567 0
3575 "--"
3588 ;;;; Underline
3591 "Parse underline object at point, if any.
3593 When at an underline object, return a list whose car is
3594 `underline' and cdr is a plist with `:begin', `:end',
3595 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3596 Otherwise, return nil.
3598 Assume point is at the first underscore marker."
3610 :end end
3611 :contents-begin contents-begin
3612 :contents-end contents-end
3616 "Interpret UNDERLINE object as Org syntax.
3617 CONTENTS is the contents of the object."
3621 ;;;; Verbatim
3624 "Parse verbatim object at point, if any.
3626 When at a verbatim object, return a list whose car is `verbatim'
3627 and cdr is a plist with `:value', `:begin', `:end' and
3628 `:post-blank' keywords. Otherwise, return nil.
3630 Assume point is at the first equal sign marker."
3641 :begin begin
3642 :end end
3646 "Interpret VERBATIM object as Org syntax.
3647 CONTENTS is nil."
3651 \f
3652 ;;; Parsing Element Starting At Point
3653 ;;
3654 ;; `org-element--current-element' is the core function of this section.
3655 ;; It returns the Lisp representation of the element starting at
3656 ;; point.
3657 ;;
3658 ;; `org-element--current-element' makes use of special modes. They
3659 ;; are activated for fixed element chaining (e.g., `plain-list' >
3660 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3661 ;; `section'). Special modes are: `first-section', `item',
3662 ;; `node-property', `section' and `table-row'.
3665 "Parse the element starting at point.
3667 Return value is a list like (TYPE PROPS) where TYPE is the type
3668 of the element and PROPS a plist of properties associated to the
3669 element.
3671 Possible types are defined in `org-element-all-elements'.
3673 LIMIT bounds the search.
3675 Optional argument GRANULARITY determines the depth of the
3676 recursion. Allowed values are `headline', `greater-element',
3677 `element', `object' or nil. When it is broader than `object' (or
3678 nil), secondary values will not be parsed, since they only
3679 contain objects.
3681 Optional argument MODE, when non-nil, can be either
3682 `first-section', `section', `planning', `item', `node-property'
3683 and `table-row'.
3685 If STRUCTURE isn't provided but MODE is set to `item', it will be
3686 computed.
3688 This function assumes point is always at the beginning of the
3689 element it has to parse."
3692 ;; Determine if parsing depth allows for secondary strings
3693 ;; parsing. It only applies to elements referenced in
3694 ;; `org-element-secondary-value-alist'.
3697 ;; Item.
3700 ;; Table Row.
3702 ;; Node Property.
3704 ;; Headline.
3707 ;; Sections (must be checked after headline).
3712 limit)))
3713 ;; Planning.
3716 ;; Property drawer.
3720 ;; When not at bol, point is at the beginning of an item or
3721 ;; a footnote definition: next item is always a paragraph.
3723 ;; Clock.
3725 ;; Inlinetask.
3728 ;; From there, elements can have affiliated keywords.
3731 ;; Jumping over affiliated keywords put point off-limits.
3732 ;; Parse them as regular keywords.
3736 ;; LaTeX Environment.
3739 ;; Drawer and Property Drawer.
3742 ;; Fixed Width
3745 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3746 ;; Keywords.
3755 org-element-block-name-alist)))
3770 ;; Footnote Definition.
3773 ;; Horizontal Rule.
3776 ;; Diary Sexp.
3779 ;; Table.
3781 ;; List.
3784 limit affiliated
3786 ;; Default element: Paragraph.
3790 ;; Most elements can have affiliated keywords. When looking for an
3791 ;; element beginning, we want to move before them, as they belong to
3792 ;; that element, and, in the meantime, collect information they give
3793 ;; into appropriate properties. Hence the following function.
3796 "Collect affiliated keywords from point down to LIMIT.
3798 Return a list whose CAR is the position at the first of them and
3799 CDR a plist of keywords and values and move point to the
3800 beginning of the first line after them.
3802 As a special case, if element doesn't start at the beginning of
3803 the line (e.g., a paragraph starting an item), CAR is current
3804 position of point and CDR is nil."
3808 ;; RESTRICT is the list of objects allowed in parsed
3809 ;; keywords value.
3811 output)
3814 ;; Apply translation to RAW-KWD. From there, KWD is
3815 ;; the official keyword.
3817 org-element-keyword-translation-alist))
3818 raw-kwd))
3819 ;; Find main value for any keyword.
3825 ;; PARSEDP is non-nil when keyword should have its
3826 ;; value parsed.
3828 ;; If KWD is a dual keyword, find its secondary
3829 ;; value. Maybe parse it.
3837 ;; Attribute a property name to KWD.
3839 ;; Now set final shape for VALUE.
3845 nil restrict)))
3849 ;; Attributes can always appear on multiple lines.
3852 ;; Eventually store the new value in OUTPUT.
3854 ;; Move to next keyword.
3856 ;; If affiliated keywords are orphaned: move back to first one.
3857 ;; They will be parsed as a paragraph.
3859 ;; Return value.
3863 \f
3864 ;;; The Org Parser
3865 ;;
3866 ;; The two major functions here are `org-element-parse-buffer', which
3867 ;; parses Org syntax inside the current buffer, taking into account
3868 ;; region, narrowing, or even visibility if specified, and
3869 ;; `org-element-parse-secondary-string', which parses objects within
3870 ;; a given string.
3871 ;;
3872 ;; The (almost) almighty `org-element-map' allows to apply a function
3873 ;; on elements or objects matching some type, and accumulate the
3874 ;; resulting values. In an export situation, it also skips unneeded
3875 ;; parts of the parse tree.
3878 "Recursively parse the buffer and return structure.
3879 If narrowing is in effect, only parse the visible part of the
3880 buffer.
3882 Optional argument GRANULARITY determines the depth of the
3883 recursion. It can be set to the following symbols:
3885 `headline' Only parse headlines.
3886 `greater-element' Don't recurse into greater elements excepted
3887 headlines and sections. Thus, elements
3888 parsed are the top-level ones.
3889 `element' Parse everything but objects and plain text.
3890 `object' Parse the complete buffer (default).
3892 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3893 elements.
3895 An element or an objects is represented as a list with the
3896 pattern (TYPE PROPERTIES CONTENTS), where :
3898 TYPE is a symbol describing the element or object. See
3899 `org-element-all-elements' and `org-element-all-objects' for an
3900 exhaustive list of such symbols. One can retrieve it with
3901 `org-element-type' function.
3903 PROPERTIES is the list of attributes attached to the element or
3904 object, as a plist. Although most of them are specific to the
3905 element or object type, all types share `:begin', `:end',
3906 `:post-blank' and `:parent' properties, which respectively
3907 refer to buffer position where the element or object starts,
3908 ends, the number of white spaces or blank lines after it, and
3909 the element or object containing it. Properties values can be
3910 obtained by using `org-element-property' function.
3912 CONTENTS is a list of elements, objects or raw strings
3913 contained in the current element or object, when applicable.
3914 One can access them with `org-element-contents' function.
3916 The Org buffer has `org-data' as type and nil as properties.
3917 `org-element-map' function can be used to find specific elements
3918 or objects within the parse tree.
3920 This function assumes that current major mode is `org-mode'."
3926 ;; Start in `first-section' mode so text before the first
3927 ;; headline belongs to a section.
3931 "Recursively parse objects in STRING and return structure.
3933 RESTRICTION is a symbol limiting the object types that will be
3934 looked after.
3936 Optional argument PARENT, when non-nil, is the element or object
3937 containing the secondary string. It is used to set correctly
3938 `:parent' property within the string.
3940 If STRING is the empty string or nil, return nil."
3956 data))))))
3960 "Map a function on selected elements or objects.
3962 DATA is a parse tree, an element, an object, a string, or a list
3963 of such constructs. TYPES is a symbol or list of symbols of
3964 elements or objects types (see `org-element-all-elements' and
3965 `org-element-all-objects' for a complete list of types). FUN is
3966 the function called on the matching element or object. It has to
3967 accept one argument: the element or object itself.
3969 When optional argument INFO is non-nil, it should be a plist
3970 holding export options. In that case, parts of the parse tree
3971 not exportable according to that property list will be skipped.
3973 When optional argument FIRST-MATCH is non-nil, stop at the first
3974 match for which FUN doesn't return nil, and return that value.
3976 Optional argument NO-RECURSION is a symbol or a list of symbols
3977 representing elements or objects types. `org-element-map' won't
3978 enter any recursive element or object whose type belongs to that
3979 list. Though, FUN can still be applied on them.
3981 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3982 apply to matching objects within parsed affiliated keywords (see
3983 `org-element-parsed-keywords').
3985 Nil values returned from FUN do not appear in the results.
3988 Examples:
3989 ---------
3991 Assuming TREE is a variable containing an Org buffer parse tree,
3992 the following example will return a flat list of all `src-block'
3993 and `example-block' elements in it:
3995 \(org-element-map tree '(example-block src-block) #'identity)
3997 The following snippet will find the first headline with a level
4000 \(org-element-map tree 'headline
4001 \(lambda (hl)
4002 \(and (= (org-element-property :level hl) 1)
4004 \(org-element-property :begin hl)))
4005 nil t)
4007 The next example will return a flat list of all `plain-list' type
4008 elements in TREE that are not a sub-list themselves:
4010 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4012 Eventually, this example will return a flat list of all `bold'
4013 type objects containing a `latex-snippet' type object, even
4014 looking into captions:
4016 \(org-element-map tree 'bold
4017 \(lambda (b)
4018 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4019 nil nil nil t)"
4020 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4024 ;; Recursion depth is determined by --CATEGORY.
4031 ;; If one object is found, the function has to
4032 ;; recurse into every object.
4035 ;; If one regular element is found, the
4036 ;; function has to recurse, at least, into
4037 ;; every element it encounters.
4040 --acc
4041 --walk-tree
4044 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4045 ;; holding contextual information.
4049 ;; Ignored element in an export context.
4051 ;; List of elements or objects.
4053 ;; Unconditionally enter parse trees.
4057 ;; Check if TYPE is matching among TYPES. If so,
4058 ;; apply FUN to --DATA and accumulate return value
4059 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4065 ;; If --DATA has a secondary string that can contain
4066 ;; objects with their type among TYPES, look into it.
4069 org-element-secondary-value-alist)))
4071 ;; If --DATA has any parsed affiliated keywords and
4072 ;; WITH-AFFILIATED is non-nil, look for objects in
4073 ;; them.
4080 ;; Pay attention to the type of parsed keyword.
4081 ;; In particular, preserve order for multiple
4082 ;; keywords.
4095 ;; Determine if a recursion into --DATA is possible.
4097 ;; --TYPE is explicitly removed from recursion.
4099 ;; --DATA has no contents.
4101 ;; Looking for greater elements but --DATA is simply
4102 ;; an element or an object.
4105 ;; Looking for elements but --DATA is an object.
4108 ;; In any other case, map contents.
4112 ;; Return value in a proper order.
4116 ;; The following functions are internal parts of the parser.
4117 ;;
4118 ;; The first one, `org-element--parse-elements' acts at the element's
4119 ;; level.
4120 ;;
4121 ;; The second one, `org-element--parse-objects' applies on all objects
4122 ;; of a paragraph or a secondary string. It calls
4123 ;; `org-element--object-lex' to find the next object in the current
4124 ;; container.
4127 "Return next special mode according to TYPE, or nil.
4128 TYPE is a symbol representing the type of an element or object
4129 containing next element if PARENTP is non-nil, or before it
4130 otherwise. Modes can be either `first-section', `item',
4131 `node-property', `planning', `property-drawer', `section',
4132 `table-row' or nil."
4148 "Parse elements between BEG and END positions.
4150 MODE prioritizes some elements over the others. It can be set to
4151 `first-section', `section', `planning', `item', `node-property'
4152 or `table-row'.
4154 When value is `item', STRUCTURE will be used as the current list
4155 structure.
4157 GRANULARITY determines the depth of the recursion. See
4158 `org-element-parse-buffer' for more information.
4160 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4161 elements.
4163 Elements are accumulated into ACC."
4166 ;; Visible only: skip invisible parts at the beginning of the
4167 ;; element.
4170 ;; When parsing only headlines, skip any text before first one.
4173 ;; Main loop start.
4175 ;; Find current element's type and parse it accordingly to
4176 ;; its category.
4178 end granularity mode structure))
4182 ;; Visible only: skip invisible parts between siblings.
4185 ;; Fill ELEMENT contents by side-effect.
4187 ;; If element has no contents, don't modify it.
4189 ;; Greater element: parse it between `contents-begin' and
4190 ;; `contents-end'. Make sure GRANULARITY allows the
4191 ;; recursion, or ELEMENT is a headline, in which case going
4192 ;; inside is mandatory, in order to get sub-level headings.
4200 ;; Possibly switch to a special mode.
4204 granularity visible-only element))
4205 ;; ELEMENT has contents. Parse objects inside, if
4206 ;; GRANULARITY allows it.
4212 ;; Update mode.
4214 ;; Return result.
4215 acc))
4218 "Return next object in current buffer or nil.
4219 RESTRICTION is a list of object types, as symbols, that should be
4220 looked after. This function assumes that the buffer is narrowed
4221 to an appropriate container (e.g., a paragraph)."
4229 found)
4294 ;; This is probably a plain link.
4300 ;; Radio link.
4305 "Parse objects between BEG and END and return recursive structure.
4307 Objects are accumulated in ACC.
4309 RESTRICTION is a list of object successors which are allowed in
4310 the current object."
4318 ;; 1. Text before any object. Untabify it.
4323 acc
4327 ;; 2. Object...
4330 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4331 ;; a recursive type.
4339 ;; 3. Text after last object. Untabify it.
4343 acc
4347 ;; Result.
4348 acc)))
4351 \f
4352 ;;; Towards A Bijective Process
4353 ;;
4354 ;; The parse tree obtained with `org-element-parse-buffer' is really
4355 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4356 ;; interpreted and expanded into a string with canonical Org syntax.
4357 ;; Hence `org-element-interpret-data'.
4358 ;;
4359 ;; The function relies internally on
4360 ;; `org-element--interpret-affiliated-keywords'.
4362 ;;;###autoload
4364 "Interpret DATA as Org syntax.
4365 DATA is a parse tree, an element, an object or a secondary string
4366 to interpret. Return Org syntax as a string."
4370 "Interpret DATA as Org syntax.
4372 DATA is a parse tree, an element, an object or a secondary string
4373 to interpret. PARENT is used for recursive calls. It contains
4374 the element or object containing data, or nil.
4376 Return Org syntax as a string."
4378 ;; Find interpreter for current object or element. If it
4379 ;; doesn't exist (e.g. this is a pseudo object or element),
4380 ;; return contents, if any.
4386 ;; Secondary string.
4390 ;; Full Org document.
4394 ;; Plain text: return it.
4396 ;; Element or object without contents.
4398 ;; Element or object with contents.
4401 ;; Recursively interpret contents.
4406 data
4407 ;; Fix indentation of elements containing
4408 ;; objects. We ignore `table-row' elements
4409 ;; as they are one line long anyway.
4411 data
4412 ;; When normalizing first paragraph of an
4413 ;; item or a footnote-definition, ignore
4414 ;; first line's indentation.
4421 ;; Build white spaces. If no `:post-blank' property is
4422 ;; specified, assume its value is 0.
4436 "Return ELEMENT's affiliated keywords as Org syntax.
4437 If there is no affiliated keyword, return the empty string."
4447 ": "
4450 value)
4458 ;; All attribute keywords can have multiple lines.
4464 ;; List all ELEMENT's properties matching an attribute line or an
4465 ;; affiliated keyword, but ignore translated keywords since they
4466 ;; cannot belong to the property list.
4473 org-element-keyword-translation-alist)))))
4474 collect prop)
4477 ;; Because interpretation of the parse tree must return the same
4478 ;; number of blank lines between elements and the same number of white
4479 ;; space after objects, some special care must be given to white
4480 ;; spaces.
4481 ;;
4482 ;; The first function, `org-element-normalize-string', ensures any
4483 ;; string different from the empty string will end with a single
4484 ;; newline character.
4485 ;;
4486 ;; The second function, `org-element-normalize-contents', removes
4487 ;; global indentation from the contents of the current element.
4490 "Ensure string S ends with a single newline character.
4492 If S isn't a string return it unchanged. If S is the empty
4493 string, return it. Otherwise, return a new string with a single
4494 newline character at its end."
4502 "Normalize plain text in ELEMENT's contents.
4504 ELEMENT must only contain plain text and objects.
4506 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4507 indentation to compute maximal common indentation.
4509 Return the normalized element that is element with global
4510 indentation removed from its contents. The function assumes that
4511 indentation is not done with TAB characters."
4513 find-min-ind ; For byte-compiler.
4515 ;; Return minimal common indentation within BLOB. This is
4516 ;; done by walking recursively BLOB and updating MIN-IND
4517 ;; along the way. FIRST-FLAG is non-nil when the next
4518 ;; object is expected to be a string that doesn't start with
4519 ;; a newline character. It happens for strings at the
4520 ;; beginnings of the contents or right after a line break.
4525 ;; Objects cannot start with spaces: in this case,
4526 ;; indentation is 0.
4530 ;; An indentation of zero means no string will be
4531 ;; modified. Quit the process.
4542 ;; Find minimal indentation in ELEMENT.
4545 ;; Build ELEMENT back, replacing each string with the same
4546 ;; string minus common indentation.
4550 ;; Return BLOB with all its strings indentation
4551 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4552 ;; non-nil when the next object is expected to be
4553 ;; a string that doesn't start with a newline
4554 ;; character.
4570 org-element-recursive-objects)
4574 object)
4577 blob)))
4581 \f
4582 ;;; Cache
4583 ;;
4584 ;; Implement a caching mechanism for `org-element-at-point' and
4585 ;; `org-element-context', which see.
4586 ;;
4587 ;; A single public function is provided: `org-element-cache-reset'.
4588 ;;
4589 ;; Cache is enabled by default, but can be disabled globally with
4590 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4591 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4592 ;; can be tweaked to control caching behaviour.
4593 ;;
4594 ;; Internally, parsed elements are stored in an AVL tree,
4595 ;; `org-element--cache'. This tree is updated lazily: whenever
4596 ;; a change happens to the buffer, a synchronization request is
4597 ;; registered in `org-element--cache-sync-requests' (see
4598 ;; `org-element--cache-submit-request'). During idle time, requests
4599 ;; are processed by `org-element--cache-sync'. Synchronization also
4600 ;; happens when an element is required from the cache. In this case,
4601 ;; the process stops as soon as the needed element is up-to-date.
4602 ;;
4603 ;; A synchronization request can only apply on a synchronized part of
4604 ;; the cache. Therefore, the cache is updated at least to the
4605 ;; location where the new request applies. Thus, requests are ordered
4606 ;; from left to right and all elements starting before the first
4607 ;; request are correct. This property is used by functions like
4608 ;; `org-element--cache-find' to retrieve elements in the part of the
4609 ;; cache that can be trusted.
4610 ;;
4611 ;; A request applies to every element, starting from its original
4612 ;; location (or key, see below). When a request is processed, it
4613 ;; moves forward and may collide the next one. In this case, both
4614 ;; requests are merged into a new one that starts from that element.
4615 ;; As a consequence, the whole synchronization complexity does not
4616 ;; depend on the number of pending requests, but on the number of
4617 ;; elements the very first request will be applied on.
4618 ;;
4619 ;; Elements cannot be accessed through their beginning position, which
4620 ;; may or may not be up-to-date. Instead, each element in the tree is
4621 ;; associated to a key, obtained with `org-element--cache-key'. This
4622 ;; mechanism is robust enough to preserve total order among elements
4623 ;; even when the tree is only partially synchronized.
4624 ;;
4625 ;; Objects contained in an element are stored in a hash table,
4626 ;; `org-element--cache-objects'.
4630 "Non nil when Org parser should cache its results.
4637 "Maximum duration, as a time value, for a cache synchronization.
4638 If the synchronization is not over after this delay, the process
4639 pauses and resumes after `org-element-cache-sync-break'
4643 "Duration, as a time value, of the pause between synchronizations.
4647 ;;;; Data Structure
4650 "AVL tree used to cache elements.
4651 Each node of the tree contains an element. Comparison is done
4652 with `org-element--cache-compare'. This cache is used in
4656 "Hash table used as to cache objects.
4657 Key is an element, as returned by `org-element-at-point', and
4658 value is an alist where each association is:
4660 \(PARENT COMPLETEP . OBJECTS)
4662 where PARENT is an element or object, COMPLETEP is a boolean,
4663 non-nil when all direct children of parent are already cached and
4664 OBJECTS is a list of such children, as objects, from farthest to
4665 closest.
4668 contained within a paragraph
4672 If the paragraph is completely parsed, OBJECTS-DATA will be
4674 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4675 \(BOLD-OBJECT t ENTITY-OBJECT))
4677 whereas in a partially parsed paragraph, it could be
4679 \((PARAGRAPH nil ENTITY-OBJECT))
4684 "List of pending synchronization requests.
4686 A request is a vector with the following pattern:
4688 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4690 Processing a synchronization request consists of three phases:
4692 0. Delete modified elements,
4693 1. Fill missing area in cache,
4694 2. Shift positions and re-parent elements after the changes.
4696 During phase 0, NEXT is the key of the first element to be
4697 removed, BEG and END is buffer position delimiting the
4698 modifications. Elements starting between them (inclusive) are
4699 removed and so are those contained within OUTREACH. PARENT, when
4700 non-nil, is the parent of the first element to be removed.
4702 During phase 1, NEXT is the key of the next known element in
4703 cache and BEG its beginning position. Parse buffer between that
4704 element and the one before it in order to determine the parent of
4705 the next element. Set PARENT to the element containing NEXT.
4707 During phase 2, NEXT is the key of the next element to shift in
4708 the parse tree. All elements starting from this one have their
4709 properties relatives to buffer positions shifted by integer
4710 OFFSET and, if they belong to element PARENT, are adopted by it.
4718 "Hash table used to store keys during synchronization.
4722 "Return a unique key for ELEMENT in cache tree.
4724 Keys are used to keep a total order among elements in the cache.
4725 Comparison is done with `org-element--cache-key-less-p'.
4727 When no synchronization is taking place, a key is simply the
4728 beginning position of the element, or that position plus one in
4729 the case of an first item (respectively row) in
4730 a list (respectively a table).
4732 During a synchronization, the key is the one the element had when
4733 the cache was synchronized for the last time. Elements added to
4734 cache during the synchronization get a new key generated with
4735 `org-element--cache-generate-key'.
4737 Such keys are stored in `org-element--cache-sync-keys'. The hash
4738 table is cleared once the synchronization is complete."
4741 ;; Increase beginning position of items (respectively
4742 ;; table rows) by one, so the first item can get
4743 ;; a different key from its parent list (respectively
4744 ;; table).
4747 begin)))
4750 key))))
4753 "Generate a key between LOWER and UPPER.
4755 LOWER and UPPER are integers or lists, possibly empty.
4757 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4758 a unique key, as an integer or a list of integers, according to
4759 the following rules:
4761 - LOWER and UPPER are compared level-wise until values differ.
4763 - If, at a given level, LOWER and UPPER differ from more than
4764 2, the new key shares all the levels above with LOWER and
4765 gets a new level. Its value is the mean between LOWER and
4766 UPPER:
4768 \(1 2) + (1 4) --> (1 3)
4770 - If LOWER has no value to compare with, it is assumed that its
4771 value is `most-negative-fixnum'. E.g.,
4773 \(1 1) + (1 1 2)
4775 is equivalent to
4777 \(1 1 m) + (1 1 2)
4779 where m is `most-negative-fixnum'. Likewise, if UPPER is
4780 short of levels, the current value is `most-positive-fixnum'.
4782 - If they differ from only one, the new key inherits from
4783 current LOWER level and fork it at the next level. E.g.,
4785 \(2 1) + (3 3)
4787 is equivalent to
4789 \(2 1) + (2 M)
4791 where M is `most-positive-fixnum'.
4793 - If the key is only one level long, it is returned as an
4794 integer:
4796 \(1 2) + (3 2) --> 2
4798 When they are not equals, the function assumes that LOWER is
4799 lesser than UPPER, per `org-element--cache-key-less-p'."
4803 skip-upper key)
4814 ;; When at a given level, LOWER and UPPER differ from
4815 ;; 1, ignore UPPER altogether. Instead create a key
4816 ;; between LOWER and the greatest key with the same
4817 ;; prefix as LOWER so far.
4823 "Non-nil if key A is less than key B.
4824 A and B are either integers or lists of integers, as returned by
4825 `org-element--cache-key'."
4833 ;; If A is empty, either keys are equal (B is also empty) and
4834 ;; we return nil, or A is lesser than B (B is longer) and we
4835 ;; return a non-nil value.
4836 ;;
4837 ;; If A is not empty, B is necessarily empty and A is greater
4838 ;; than B (A is longer). Therefore, return nil.
4842 "Non-nil when element A is located before element B."
4847 "Return root value in cache.
4848 This function assumes `org-element--cache' is a valid AVL tree."
4852 ;;;; Tools
4855 "Non-nil when cache is active in current buffer."
4860 "Find element in cache starting at POS or before.
4862 POS refers to a buffer position.
4864 When optional argument SIDE is non-nil, the function checks for
4865 elements starting at or past POS instead. If SIDE is `both', the
4866 function returns a cons cell where car is the first element
4867 starting at or before POS and cdr the first element starting
4868 after POS.
4870 The function can only find elements in the synchronized part of
4871 the cache."
4875 lower upper)
4890 ;; We found an element in cache starting at POS. If `side'
4891 ;; is `both' we also want the next one in order to generate
4892 ;; a key in-between.
4893 ;;
4894 ;; If the element is the first row or item in a table or
4895 ;; a plain list, we always return the table or the plain
4896 ;; list.
4897 ;;
4898 ;; In any other case, we return the element found.
4907 lower parent
4908 upper parent)))))
4911 lower element
4912 upper element)))))
4919 "Store ELEMENT in current buffer's cache, if allowed.
4920 When optional argument DATA is non-nil, assume is it object data
4921 relative to ELEMENT and store it in the objects cache."
4925 ;; During synchronization, first build an appropriate key
4926 ;; for the new element so `avl-tree-enter' can insert it at
4927 ;; the right spot in the cache.
4936 org-element--cache-sync-keys)))
4938 ;; Headlines are not stored in cache, so objects in titles are
4939 ;; not stored either.
4944 "Remove ELEMENT from cache.
4945 Assume ELEMENT belongs to cache and that a cache is active."
4950 ;;;; Synchronization
4953 "Set idle timer for cache synchronization in BUFFER."
4960 org-element-cache-sync-idle-time))
4961 nil
4962 #'org-element--cache-sync
4963 buffer)))
4966 "Non-nil when synchronization process should be interrupted.
4967 TIME-LIMIT is a time value or nil."
4973 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4975 Properties containing buffer positions are `:begin', `:end',
4976 `:contents-begin', `:contents-end' and `:structure'. When
4977 optional argument PROPS is a list of keywords, only shift
4978 properties provided in that list.
4980 Properties are modified by side-effect."
4982 ;; Shift `:structure' property for the first plain list only: it
4983 ;; is the only one that really matters and it prevents from
4984 ;; shifting it more than once.
4998 "Synchronize cache with recent modification in BUFFER.
5000 When optional argument THRESHOLD is non-nil, do the
5001 synchronization for all elements starting before or at threshold,
5002 then exit. Otherwise, synchronize cache for as long as
5003 `org-element-cache-sync-duration' or until Emacs leaves idle
5004 state.
5006 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5007 not registered yet in the cache are going to happen. It is used
5008 in `org-element--cache-submit-request', where cache is partially
5009 updated before current modification are actually submitted."
5020 request
5022 threshold
5025 org-element-cache-sync-duration))
5026 future-change)
5027 ;; Request processed. Merge current and next offsets and
5028 ;; transfer ending position.
5034 ;; If more requests are awaiting, set idle timer accordingly.
5035 ;; Otherwise, reset keys.
5042 "Process synchronization REQUEST for all entries before NEXT.
5044 REQUEST is a vector, built by `org-element--cache-submit-request'.
5046 NEXT is a cache key, as returned by `org-element--cache-key'.
5048 When non-nil, THRESHOLD is a buffer position. Synchronization
5049 stops as soon as a shifted element begins after it.
5051 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5052 after this time or when Emacs exits idle state.
5054 When non-nil, FUTURE-CHANGE is a buffer position where changes
5055 not registered yet in the cache are going to happen. See
5056 `org-element--cache-submit-request' for more information.
5058 Throw `interrupt' if the process stops before completing the
5059 request."
5062 ;; Phase 0.
5063 ;;
5064 ;; Delete all elements starting after BEG, but not after buffer
5065 ;; position END or past element with key NEXT.
5066 ;;
5067 ;; At each iteration, we start again at tree root since
5068 ;; a deletion modifies structure of the balanced tree.
5076 ;; Find first element in cache with key BEG or after it.
5086 data-key key
5089 data-key key
5090 node nil)))))
5099 up))
5105 ;; No element starting after modifications left in
5106 ;; cache: further processing is futile.
5109 ;; Phase 1.
5110 ;;
5111 ;; Phase 0 left a hole in the cache. Some elements after it
5112 ;; could have parents within. For example, in the following
5113 ;; buffer:
5114 ;;
5115 ;; - item
5116 ;;
5117 ;;
5118 ;; Paragraph1
5119 ;;
5120 ;; Paragraph2
5121 ;;
5122 ;; if we remove a blank line between "item" and "Paragraph1",
5123 ;; everything down to "Paragraph2" is removed from cache. But
5124 ;; the paragraph now belongs to the list, and its `:parent'
5125 ;; property no longer is accurate.
5126 ;;
5127 ;; Therefore we need to parse again elements in the hole, or at
5128 ;; least in its last section, so that we can re-parent
5129 ;; subsequent elements, during phase 2.
5130 ;;
5131 ;; Note that we only need to get the parent from the first
5132 ;; element in cache after the hole.
5133 ;;
5134 ;; When next key is lesser or equal to the current one, delegate
5135 ;; phase 1 processing to next request in order to preserve key
5136 ;; order among requests.
5144 ;; Next element will start at its beginning position plus
5145 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5146 ;; contains the real beginning position of the first element to
5147 ;; shift and re-parent.
5151 ;; Changes are going to happen around this element and
5152 ;; they will trigger another phase 1 request. Skip the
5153 ;; current one.
5159 ;; Phase 2.
5160 ;;
5161 ;; Shift all elements starting from key START, but before NEXT, by
5162 ;; OFFSET, and re-parent them when appropriate.
5163 ;;
5164 ;; Elements are modified by side-effect so the tree structure
5165 ;; remains intact.
5166 ;;
5167 ;; Once THRESHOLD, if any, is reached, or once there is an input
5168 ;; pending, exit. Before leaving, the current synchronization
5169 ;; request is updated.
5176 exit-flag)
5177 ;; No re-parenting nor shifting planned: request is over.
5187 ;; We reached NEXT. Request is complete.
5189 ;; Handle interruption request. Update current request.
5194 ;; Shift element.
5197 ;; Shift associated objects data, if any.
5202 ;; Update PARENT and re-parent DATA, only when
5203 ;; necessary. Propagate new structures for lists.
5217 ;; Cache is up-to-date past THRESHOLD. Request
5218 ;; interruption.
5223 ;; We reached end of tree: synchronization complete.
5224 t)))
5227 "Parse elements in current section, down to POS.
5229 Start parsing from the closest between the last known element in
5230 cache or headline above. Return the smallest element containing
5231 POS.
5233 When optional argument SYNCP is non-nil, return the parent of the
5234 element containing POS instead. In that case, it is also
5235 possible to provide TIME-LIMIT, which is a time value specifying
5236 when the parsing should stop. The function throws `interrupt' if
5237 the process stopped before finding the expected result."
5244 element next mode)
5246 ;; Nothing in cache before point: start parsing from first
5247 ;; element following headline above, or first element in
5248 ;; buffer.
5255 ;; Cache returned exact match: return it.
5258 ;; There's a headline between cached value and POS: cached
5259 ;; value is invalid. Start parsing from first element
5260 ;; following the headline.
5267 ;; Check if CACHED or any of its ancestors contain point.
5268 ;;
5269 ;; If there is such an element, we inspect it in order to know
5270 ;; if we return it or if we need to parse its contents.
5271 ;; Otherwise, we just start parsing from current location,
5272 ;; which is right after the top-most element containing
5273 ;; CACHED.
5274 ;;
5275 ;; As a special case, if POS is at the end of the buffer, we
5276 ;; want to return the innermost element ending there.
5277 ;;
5278 ;; Also, if we find an ancestor and discover that we need to
5279 ;; parse its contents, make sure we don't start from
5280 ;; `:contents-begin', as we would otherwise go past CACHED
5281 ;; again. Instead, in that situation, we will resume parsing
5282 ;; from NEXT, which is located after CACHED or its higher
5283 ;; ancestor not containing point.
5295 ;; Parse successively each element until we reach POS.
5308 end 'element mode
5315 ;; Skip any element ending before point. Also skip
5316 ;; element ending at point (unless it is also the end of
5317 ;; buffer) since we're sure that another element begins
5318 ;; after it.
5322 ;; A non-greater element contains point: return it.
5325 ;; Otherwise, we have to decide if ELEMENT really
5326 ;; contains POS. In that case we start parsing from
5327 ;; contents' beginning.
5328 ;;
5329 ;; If POS is at contents' beginning but it is also at
5330 ;; the beginning of the first item in a list or a table.
5331 ;; In that case, we need to create an anchor for that
5332 ;; list or table, so return it.
5333 ;;
5334 ;; Also, if POS is at the end of the buffer, no element
5335 ;; can start after it, but more than one may end there.
5336 ;; Arbitrarily, we choose to return the innermost of
5337 ;; such elements.
5350 parent element
5351 end cend))))
5352 ;; Otherwise, return ELEMENT as it is the smallest
5353 ;; element containing POS.
5358 ;;;; Staging Buffer Changes
5369 "Regexp matching a sensitive line, structure wise.
5370 A sensitive line is a headline, inlinetask, block, drawer, or
5371 latex-environment boundary. When such a line is modified,
5372 structure changes in the document may propagate in the whole
5376 "Non-nil when a sensitive line is about to be changed.
5380 "Request extension of area going to be modified if needed.
5381 BEG and END are the beginning and end of the range of changed
5382 text. See `before-change-functions' for more information."
5392 'headline
5395 org-element--cache-sensitive-re bottom t)))))))))
5398 "Update buffer modifications for current buffer.
5399 BEG and END are the beginning and end of the range of changed
5400 text, and the length in bytes of the pre-change text replaced by
5401 that range. See `after-change-functions' for more information."
5409 ;; Determine if modified area needs to be extended, according
5410 ;; to both previous and current state. We make a special
5411 ;; case for headline editing: if a headline is modified but
5412 ;; not removed, do not extend.
5421 org-element--cache-sensitive-re bottom t))))
5422 ;; Effectively extend modified area.
5430 ;; Store synchronization request.
5433 ;; Activate a timer to process the request during idle time.
5437 "Return first element to remove from cache.
5439 BEG and END are buffer positions delimiting buffer modifications.
5440 OFFSET is the size of the changes.
5442 Returned element is usually the first element in cache containing
5443 any position between BEG and END. As an exception, greater
5444 elements around the changes that are robust to contents
5445 modifications are preserved and updated according to the
5446 changes."
5456 special-block))
5457 ;; Drawers named "PROPERTIES" are probably
5458 ;; a properties drawer being edited. Force
5459 ;; parsing to check if editing is over.
5468 ;; UP is a robust greater element containing changes.
5469 ;; We only need to extend its ending boundaries.
5475 ;; We're at top level element containing ELEMENT: if it's
5476 ;; altered by buffer modifications, it is first element in
5477 ;; cache to be removed. Otherwise, that first element is the
5478 ;; following one.
5479 ;;
5480 ;; As a special case, do not remove BEFORE if it is a robust
5481 ;; container for current changes.
5483 before)))))
5486 "Submit a new cache synchronization request for current buffer.
5487 BEG and END are buffer positions delimiting the minimal area
5488 where cache data should be removed. OFFSET is the size of the
5489 change, as an integer."
5491 delete-to delete-from)
5496 ;; Current changes can be merged with first sync request: we
5497 ;; can save a partial cache synchronization.
5500 ;; If last change happened within area to be removed, extend
5501 ;; boundaries of robust parents, if any. Otherwise, find
5502 ;; first element to remove and update request accordingly.
5514 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5515 ;; if any, is no longer a 0-phase request, thus ensuring that
5516 ;; phases are properly ordered. We need to provide OFFSET as
5517 ;; optional parameter since current modifications are not known
5518 ;; yet to the otherwise correct part of the cache (i.e, before
5519 ;; the first request).
5526 ;; When changes happen before the first known
5527 ;; element, re-parent and shift the rest of the
5528 ;; cache.
5530 ;; Otherwise, we find the first non robust
5531 ;; element containing END. All elements between
5532 ;; FIRST and this one are to be removed.
5533 ;;
5534 ;; Among them, some could be located outside the
5535 ;; synchronized part of the cache, in which case
5536 ;; comparing buffer positions to find them is
5537 ;; useless. Instead, we store the element
5538 ;; containing them in the request itself. All
5539 ;; its children will be removed.
5551 element up))
5554 org-element--cache-sync-requests)
5555 ;; No element to remove. No need to re-parent either.
5556 ;; Simply shift additional elements, if any, by OFFSET.
5561 ;;;; Public Functions
5563 ;;;###autoload
5565 "Reset cache in current buffer.
5566 When optional argument ALL is non-nil, reset cache in all Org
5567 buffers."
5585 ;;;###autoload
5587 "Refresh cache at position POS."
5594 \f
5595 ;;; The Toolbox
5596 ;;
5597 ;; The first move is to implement a way to obtain the smallest element
5598 ;; containing point. This is the job of `org-element-at-point'. It
5599 ;; basically jumps back to the beginning of section containing point
5600 ;; and proceed, one element after the other, with
5601 ;; `org-element--current-element' until the container is found. Note:
5602 ;; When using `org-element-at-point', secondary values are never
5603 ;; parsed since the function focuses on elements, not on objects.
5604 ;;
5605 ;; At a deeper level, `org-element-context' lists all elements and
5606 ;; objects containing point.
5607 ;;
5608 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5609 ;; internally by navigation and manipulation tools.
5612 ;;;###autoload
5614 "Determine closest element around point.
5616 Return value is a list like (TYPE PROPS) where TYPE is the type
5617 of the element and PROPS a plist of properties associated to the
5618 element.
5620 Possible types are defined in `org-element-all-elements'.
5621 Properties depend on element or object type, but always include
5622 `:begin', `:end', `:parent' and `:post-blank' properties.
5624 As a special case, if point is at the very beginning of the first
5625 item in a list or sub-list, returned element will be that list
5626 instead of the item. Likewise, if point is at the beginning of
5627 the first row of a table, returned element will be the table
5628 instead of the first row.
5630 When point is at the end of the buffer, return the innermost
5631 element ending there."
5637 ;; Within blank lines at the beginning of buffer, return nil.
5639 ;; Within blank lines right after a headline, return that
5640 ;; headline.
5644 ;; Otherwise parse until we find element containing ORIGIN.
5651 ;;;###autoload
5653 "Return smallest element or object around point.
5655 Return value is a list like (TYPE PROPS) where TYPE is the type
5656 of the element or object and PROPS a plist of properties
5657 associated to it.
5659 Possible types are defined in `org-element-all-elements' and
5660 `org-element-all-objects'. Properties depend on element or
5661 object type, but always include `:begin', `:end', `:parent' and
5662 `:post-blank'.
5664 As a special case, if point is right after an object and not at
5665 the beginning of any other object, return that object.
5667 Optional argument ELEMENT, when non-nil, is the closest element
5668 containing point, as returned by `org-element-at-point'.
5669 Providing it allows for quicker computation."
5675 ;; If point is inside an element containing objects or
5676 ;; a secondary string, narrow buffer to the container and
5677 ;; proceed with parsing. Otherwise, return ELEMENT.
5679 ;; At a parsed affiliated keyword, check if we're inside main
5680 ;; or dual value.
5687 org-element-parsed-keywords))
5696 ;; Also change type to retrieve correct restrictions.
5698 ;; At an item, objects can only be located within tag, if any.
5708 ;; At an headline or inlinetask, objects are in title.
5715 ;; At a paragraph, a table-row or a verse block, objects are
5716 ;; located within their contents.
5720 ;; CBEG is nil for table rules.
5725 ;; At a planning line, if point is at a timestamp, return it,
5726 ;; otherwise, return element.
5734 ;; All other locations cannot contain objects: bail out.
5744 next object-data last)
5748 ;; When entering PARENT for the first time, get list
5749 ;; of objects within known so far. Store it in
5750 ;; OBJECT-DATA.
5755 ;; Find NEXT object for analysis.
5757 ;; If NEXT is non-nil, we already exhausted the
5758 ;; cache so we can parse buffer to find the object
5759 ;; after it.
5761 ;; Otherwise, check if cache can help us.
5772 ;; Cache contains the information needed.
5775 pos)
5777 pos)
5783 ;; If we have a new object to analyze, store it in
5784 ;; cache. Otherwise record that there is nothing
5785 ;; more to parse in this element at this depth.
5790 ;; Process NEXT, if any, in order to know if we need
5791 ;; to skip it, return it or move into it.
5798 ;; Skip objects ending before point. Also skip
5799 ;; objects ending at point unless it is also the
5800 ;; end of buffer, since we want to return the
5801 ;; innermost object.
5804 ;; For convenience, when object ends at POS,
5805 ;; without any space, store it in LAST, as we
5806 ;; will return it if no object starts here.
5810 ;; If POS is within a container object, move
5811 ;; into that object.
5815 ;; At contents' end, if there is no
5816 ;; space before point, also move into
5817 ;; object, for consistency with
5818 ;; convenience feature above.
5827 next nil
5828 object-data nil))
5829 ;; Otherwise, return NEXT.
5831 ;; Store results in cache, if applicable.
5835 "List all ancestors of a given element or object.
5837 BLOB is an object or element.
5839 When optional argument TYPES is a list of symbols, return the
5840 first element or object in the lineage whose type belongs to that
5841 list.
5843 When optional argument WITH-SELF is non-nil, lineage includes
5844 BLOB itself as the first element, and TYPES, if provided, also
5845 apply to it.
5847 When BLOB is obtained through `org-element-context' or
5848 `org-element-at-point', only ancestors from its section can be
5849 found. There is no such limitation when BLOB belongs to a full
5850 parse tree."
5852 ancestors)
5859 "Non-nil when elements ELEM-A and ELEM-B are nested."
5868 "Swap elements ELEM-A and ELEM-B.
5869 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5870 end of ELEM-A."
5872 ;; There are two special cases when an element doesn't start at bol:
5873 ;; the first paragraph in an item or in a footnote definition.
5875 ;; Only a paragraph without any affiliated keyword can be moved at
5876 ;; ELEM-A position in such a situation. Note that the case of
5877 ;; a footnote definition is impossible: it cannot contain two
5878 ;; paragraphs in a row because it cannot contain a blank line.
5884 ;; In a special situation, ELEM-A will have no indentation. We'll
5885 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5899 ;; Store inner overlays responsible for visibility status.
5900 ;; We also need to store their boundaries as they will be
5901 ;; removed from buffer.
5916 ;; Get contents.
5924 ;; Restore ex ELEM-A overlays.
5931 ;; Restore ex ELEM-B overlays.
5937 "Remove maximum common indentation in string S and return it.
5938 When optional argument N is a positive integer, remove exactly
5939 that much characters from indentation, if possible, or return
5940 S as-is otherwise. Unlike to `org-remove-indentation', this
5941 function doesn't call `untabify' on S."
5946 ;; Find maximum common indentation, if not specified.
5954 min-ind)))
5956 ;; Remove exactly N indentation, but give up if not possible.
5969 ;; Local variables:
5970 ;; generated-autoload-file: "org-loaddefs.el"
5971 ;; End:
5973 ;;; org-element.el ends here