| blob | 519fedf737c6ced70e312a929f2e3ff183d390da |
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 `:call', `:inside-header', `:arguments',
1619 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1620 `:post-affiliated' as keywords."
1634 value)))
1644 :begin begin
1645 :end end
1646 :value value
1652 "Interpret BABEL-CALL element as Org syntax.
1653 CONTENTS is nil."
1663 ;;;; Clock
1666 "Parse a clock.
1668 LIMIT bounds the search.
1670 Return a list whose CAR is `clock' and CDR is a plist containing
1671 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1672 `:post-affiliated' as keywords."
1692 :value value
1693 :duration duration
1694 :begin begin
1695 :end end
1696 :post-blank post-blank
1700 "Interpret CLOCK element as Org syntax.
1701 CONTENTS is nil."
1709 "%2s:%02s"
1713 ;;;; Comment
1716 "Parse a comment.
1718 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1719 the buffer position at the beginning of the first affiliated
1720 keyword and CDR is a plist of affiliated keywords along with
1721 their value.
1723 Return a list whose CAR is `comment' and CDR is a plist
1724 containing `:begin', `:end', `:value', `:post-blank',
1725 `:post-affiliated' keywords.
1727 Assume point is at comment beginning."
1736 ;; Get comments ending.
1739 ;; Accumulate lines without leading hash and first
1740 ;; whitespace.
1754 :end end
1755 :value value
1761 "Interpret COMMENT element as Org syntax.
1762 CONTENTS is nil."
1766 ;;;; Comment Block
1769 "Parse an export block.
1771 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1772 the buffer position at the beginning of the first affiliated
1773 keyword and CDR is a plist of affiliated keywords along with
1774 their value.
1776 Return a list whose CAR is `comment-block' and CDR is a plist
1777 containing `:begin', `:end', `:value', `:post-blank' and
1778 `:post-affiliated' keywords.
1780 Assume point is at comment block beginning."
1784 ;; Incomplete block: parse it as a paragraph.
1797 contents-begin contents-end)))
1801 :end end
1802 :value value
1808 "Interpret COMMENT-BLOCK element as Org syntax.
1809 CONTENTS is nil."
1816 ;;;; Diary Sexp
1819 "Parse a diary sexp.
1821 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1822 the buffer position at the beginning of the first affiliated
1823 keyword and CDR is a plist of affiliated keywords along with
1824 their value.
1826 Return a list whose CAR is `diary-sexp' and CDR is a plist
1827 containing `:begin', `:end', `:value', `:post-blank' and
1828 `:post-affiliated' keywords."
1840 :begin begin
1841 :end end
1847 "Interpret DIARY-SEXP as Org syntax.
1848 CONTENTS is nil."
1852 ;;;; Example Block
1855 "Parse an example block.
1857 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1858 the buffer position at the beginning of the first affiliated
1859 keyword and CDR is a plist of affiliated keywords along with
1860 their value.
1862 Return a list whose CAR is `example-block' and CDR is a plist
1863 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1864 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1865 `:value', `:post-blank' and `:post-affiliated' keywords."
1869 ;; Incomplete block: parse it as a paragraph.
1877 ;; Switches analysis
1884 ;; Should labels be retained in (or stripped from) example
1885 ;; blocks?
1890 ;; What should code-references use - labels or
1891 ;; line-numbers?
1900 ;; Standard block parsing.
1908 contents-begin contents-end))
1909 block-ind))
1918 :end end
1919 :value value
1920 :switches switches
1921 :number-lines number-lines
1922 :preserve-indent preserve-indent
1923 :retain-labels retain-labels
1924 :use-labels use-labels
1925 :label-fmt label-fmt
1931 "Interpret EXAMPLE-BLOCK element as Org syntax.
1932 CONTENTS is nil."
1940 value
1945 ;;;; Export Block
1948 "Parse an export block.
1950 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1951 the buffer position at the beginning of the first affiliated
1952 keyword and CDR is a plist of affiliated keywords along with
1953 their value.
1955 Return a list whose CAR is `export-block' and CDR is a plist
1956 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1957 `:post-affiliated' keywords.
1959 Assume point is at export-block beginning."
1966 ;; Incomplete block: parse it as a paragraph.
1979 contents-end)))
1983 :end end
1984 :type type
1985 :value value
1991 "Interpret EXPORT-BLOCK element as Org syntax.
1992 CONTENTS is nil."
1999 ;;;; Fixed-width
2002 "Parse a fixed-width section.
2004 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2005 the buffer position at the beginning of the first affiliated
2006 keyword and CDR is a plist of affiliated keywords along with
2007 their value.
2009 Return a list whose CAR is `fixed-width' and CDR is a plist
2010 containing `:begin', `:end', `:value', `:post-blank' and
2011 `:post-affiliated' keywords.
2013 Assume point is at the beginning of the fixed-width area."
2017 value
2022 ;; Accumulate text without starting colons.
2035 :end end
2036 :value value
2042 "Interpret FIXED-WIDTH element as Org syntax.
2043 CONTENTS is nil."
2051 ;;;; Horizontal Rule
2054 "Parse an horizontal rule.
2056 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2057 the buffer position at the beginning of the first affiliated
2058 keyword and CDR is a plist of affiliated keywords along with
2059 their value.
2061 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2062 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2063 keywords."
2073 :end end
2079 "Interpret HORIZONTAL-RULE element as Org syntax.
2080 CONTENTS is nil."
2084 ;;;; Keyword
2087 "Parse a keyword at point.
2089 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2090 the buffer position at the beginning of the first affiliated
2091 keyword and CDR is a plist of affiliated keywords along with
2092 their value.
2094 Return a list whose CAR is `keyword' and CDR is a plist
2095 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2096 `:post-affiliated' keywords."
2098 ;; An orphaned affiliated keyword is considered as a regular
2099 ;; keyword. In this case AFFILIATED is nil, so we take care of
2100 ;; this corner case.
2113 :value value
2114 :begin begin
2115 :end end
2121 "Interpret KEYWORD element as Org syntax.
2122 CONTENTS is nil."
2128 ;;;; Latex Environment
2132 "Regexp matching the beginning of a LaTeX environment.
2133 The environment is captured by the first group.
2139 "Format string matching the ending of a LaTeX environment.
2143 "Parse a LaTeX environment.
2145 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2146 the buffer position at the beginning of the first affiliated
2147 keyword and CDR is a plist of affiliated keywords along with
2148 their value.
2150 Return a list whose CAR is `latex-environment' and CDR is a plist
2151 containing `:begin', `:end', `:value', `:post-blank' and
2152 `:post-affiliated' keywords.
2154 Assume point is at the beginning of the latex environment."
2161 limit t))
2162 ;; Incomplete latex environment: parse it as a paragraph.
2172 :end end
2173 :value value
2179 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2180 CONTENTS is nil."
2184 ;;;; Node Property
2187 "Parse a node-property at point.
2189 LIMIT bounds the search.
2191 Return a list whose CAR is `node-property' and CDR is a plist
2192 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2193 `:post-affiliated' keywords."
2203 limit))))
2206 :value value
2207 :begin begin
2208 :end end
2213 "Interpret NODE-PROPERTY element as Org syntax.
2214 CONTENTS is nil."
2220 ;;;; Paragraph
2223 "Parse a paragraph.
2225 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2226 the buffer position at the beginning of the first affiliated
2227 keyword and CDR is a plist of affiliated keywords along with
2228 their value.
2230 Return a list whose CAR is `paragraph' and CDR is a plist
2231 containing `:begin', `:end', `:contents-begin' and
2232 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2234 Assume point is at the beginning of the paragraph."
2243 limit
2244 ;; A matching `org-element-paragraph-separate' is not
2245 ;; necessarily the end of the paragraph. In
2246 ;; particular, lines starting with # or : as a first
2247 ;; non-space character are ambiguous. We have to
2248 ;; check if they are valid Org syntax (e.g., not an
2249 ;; incomplete keyword).
2253 ;; There's no ambiguity for other symbols or
2254 ;; empty lines: stop here.
2256 ;; Stop at valid fixed-width areas.
2258 ;; Stop at drawers.
2263 ;; Stop at valid comments.
2265 ;; Stop at valid dynamic blocks.
2270 ;; Stop at valid blocks.
2277 limit t)))
2278 ;; Stop at valid latex environments.
2285 limit t)))
2286 ;; Stop at valid keywords.
2288 ;; Skip everything else.
2305 :end end
2306 :contents-begin contents-begin
2307 :contents-end contents-end
2313 "Interpret PARAGRAPH element as Org syntax.
2314 CONTENTS is the contents of the element."
2315 contents)
2318 ;;;; Planning
2321 "Parse a planning.
2323 LIMIT bounds the search.
2325 Return a list whose CAR is `planning' and CDR is a plist
2326 containing `:closed', `:deadline', `:scheduled', `:begin',
2327 `:end', `:post-blank' and `:post-affiliated' keywords."
2337 closed deadline scheduled)
2349 :deadline deadline
2350 :scheduled scheduled
2351 :begin begin
2352 :end end
2353 :post-blank post-blank
2357 "Interpret PLANNING element as Org syntax.
2358 CONTENTS is nil."
2360 'identity
2377 ;;;; Src Block
2380 "Parse a src block.
2382 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2383 the buffer position at the beginning of the first affiliated
2384 keyword and CDR is a plist of affiliated keywords along with
2385 their value.
2387 Return a list whose CAR is `src-block' and CDR is a plist
2388 containing `:language', `:switches', `:parameters', `:begin',
2389 `:end', `:number-lines', `:retain-labels', `:use-labels',
2390 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2391 `:post-affiliated' keywords.
2393 Assume point is at the beginning of the block."
2396 limit t)))
2397 ;; Incomplete block: parse it as a paragraph.
2403 ;; Get language as a string.
2412 ;; Get switches.
2414 ;; Get parameters.
2416 ;; Switches analysis
2427 ;; Should labels be retained in (or stripped from)
2428 ;; src blocks?
2433 ;; What should code-references use - labels or
2434 ;; line-numbers?
2439 ;; Indentation.
2441 ;; Retrieve code.
2446 block-ind))
2450 ;; Get position after ending blank lines.
2460 :begin begin
2461 :end end
2462 :number-lines number-lines
2463 :preserve-indent preserve-indent
2464 :retain-labels retain-labels
2465 :use-labels use-labels
2466 :label-fmt label-fmt
2467 :value value
2473 "Interpret SRC-BLOCK element as Org syntax.
2474 CONTENTS is nil."
2483 val)
2497 ;;;; Table
2500 "Parse a table at point.
2502 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2503 the buffer position at the beginning of the first affiliated
2504 keyword and CDR is a plist of affiliated keywords along with
2505 their value.
2507 Return a list whose CAR is `table' and CDR is a plist containing
2508 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2509 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2510 keywords.
2512 Assume point is at the beginning of the table."
2526 acc))
2533 :end end
2534 :type type
2535 :tblfm tblfm
2536 ;; Only `org' tables have contents. `table.el' tables
2537 ;; use a `:value' property to store raw table as
2538 ;; a string.
2543 table-begin table-end))
2549 "Interpret TABLE element as Org syntax.
2550 CONTENTS is a string, if table's type is `org', or nil."
2561 ;;;; Table Row
2564 "Parse table row at point.
2566 LIMIT bounds the search.
2568 Return a list whose CAR is `table-row' and CDR is a plist
2569 containing `:begin', `:end', `:contents-begin', `:contents-end',
2570 `:type', `:post-blank' and `:post-affiliated' keywords."
2574 ;; A table rule has no contents. In that case, ensure
2575 ;; CONTENTS-BEGIN matches CONTENTS-END.
2587 :begin begin
2588 :end end
2589 :contents-begin contents-begin
2590 :contents-end contents-end
2595 "Interpret TABLE-ROW element as Org syntax.
2596 CONTENTS is the contents of the table row."
2601 ;;;; Verse Block
2604 "Parse a verse block.
2606 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2607 the buffer position at the beginning of the first affiliated
2608 keyword and CDR is a plist of affiliated keywords along with
2609 their value.
2611 Return a list whose CAR is `verse-block' and CDR is a plist
2612 containing `:begin', `:end', `:contents-begin', `:contents-end',
2613 `:post-blank' and `:post-affiliated' keywords.
2615 Assume point is at beginning of the block."
2619 ;; Incomplete block: parse it as a paragraph.
2634 :end end
2635 :contents-begin contents-begin
2636 :contents-end contents-end
2642 "Interpret VERSE-BLOCK element as Org syntax.
2643 CONTENTS is verse block contents."
2647 \f
2648 ;;; Objects
2649 ;;
2650 ;; Unlike to elements, raw text can be found between objects. Hence,
2651 ;; `org-element--object-lex' is provided to find the next object in
2652 ;; buffer.
2653 ;;
2654 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2655 ;; object types they can contain will be specified in
2656 ;; `org-element-object-restrictions'.
2657 ;;
2658 ;; Creating a new type of object requires to alter
2659 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2660 ;; new type in `org-element-all-objects', and possibly add
2661 ;; restrictions in `org-element-object-restrictions'.
2663 ;;;; Bold
2666 "Parse bold object at point, if any.
2668 When at a bold object, return a list whose car is `bold' and cdr
2669 is a plist with `:begin', `:end', `:contents-begin' and
2670 `:contents-end' and `:post-blank' keywords. Otherwise, return
2671 nil.
2673 Assume point is at the first star marker."
2685 :end end
2686 :contents-begin contents-begin
2687 :contents-end contents-end
2691 "Interpret BOLD object as Org syntax.
2692 CONTENTS is the contents of the object."
2696 ;;;; Code
2699 "Parse code object at point, if any.
2701 When at a code object, return a list whose car is `code' and cdr
2702 is a plist with `:value', `:begin', `:end' and `:post-blank'
2703 keywords. Otherwise, return nil.
2705 Assume point is at the first tilde marker."
2716 :begin begin
2717 :end end
2721 "Interpret CODE object as Org syntax.
2722 CONTENTS is nil."
2726 ;;;; Entity
2729 "Parse entity at point, if any.
2731 When at an entity, return a list whose car is `entity' and cdr
2732 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2733 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2734 `:post-blank' as keywords. Otherwise, return nil.
2736 Assume point is at the beginning of the entity."
2738 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2756 :begin begin
2757 :end end
2758 :use-brackets-p bracketsp
2762 "Interpret ENTITY object as Org syntax.
2763 CONTENTS is nil."
2769 ;;;; Export Snippet
2772 "Parse export snippet at point.
2774 When at an export snippet, return a list whose car is
2775 `export-snippet' and cdr a plist with `:begin', `:end',
2776 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2777 return nil.
2779 Assume point is at the beginning of the snippet."
2795 :value value
2796 :begin begin
2797 :end end
2801 "Interpret EXPORT-SNIPPET object as Org syntax.
2802 CONTENTS is nil."
2808 ;;;; Footnote Reference
2811 "Parse footnote reference at point, if any.
2813 When at a footnote reference, return a list whose car is
2814 `footnote-reference' and cdr a plist with `:label', `:type',
2815 `:begin', `:end', `:content-begin', `:contents-end' and
2816 `:post-blank' as keywords. Otherwise, return nil."
2836 :type type
2837 :begin begin
2838 :end end
2844 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2845 CONTENTS is its definition, when inline, or nil."
2851 ;;;; Inline Babel Call
2854 "Parse inline babel call at point, if any.
2856 When at an inline babel call, return a list whose car is
2857 `inline-babel-call' and cdr a plist with `:call',
2858 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2859 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2861 Assume point is at the beginning of the babel call."
2877 :inside-header inside-header
2878 :arguments arguments
2879 :end-header end-header
2880 :begin begin
2881 :end end
2882 :value value
2886 "Interpret INLINE-BABEL-CALL object as Org syntax.
2887 CONTENTS is nil."
2897 ;;;; Inline Src Block
2900 "Parse inline source block at point, if any.
2902 When at an inline source block, return a list whose car is
2903 `inline-src-block' and cdr a plist with `:begin', `:end',
2904 `:language', `:value', `:parameters' and `:post-blank' as
2905 keywords. Otherwise, return nil.
2907 Assume point is at the beginning of the inline src block."
2920 :value value
2921 :parameters parameters
2922 :begin begin
2923 :end end
2927 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2928 CONTENTS is nil."
2933 language
2935 body)))
2937 ;;;; Italic
2940 "Parse italic object at point, if any.
2942 When at an italic object, return a list whose car is `italic' and
2943 cdr is a plist with `:begin', `:end', `:contents-begin' and
2944 `:contents-end' and `:post-blank' keywords. Otherwise, return
2945 nil.
2947 Assume point is at the first slash marker."
2959 :end end
2960 :contents-begin contents-begin
2961 :contents-end contents-end
2965 "Interpret ITALIC object as Org syntax.
2966 CONTENTS is the contents of the object."
2970 ;;;; Latex Fragment
2973 "Parse LaTeX fragment at point, if any.
2975 When at a LaTeX fragment, return a list whose car is
2976 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2977 and `:post-blank' as keywords. Otherwise, return nil.
2979 Assume point is at the beginning of the LaTeX fragment."
2997 ;; Macro.
3006 :begin begin
3007 :end end
3011 "Interpret LATEX-FRAGMENT object as Org syntax.
3012 CONTENTS is nil."
3015 ;;;; Line Break
3018 "Parse line break at point, if any.
3020 When at a line break, return a list whose car is `line-break',
3021 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3022 Otherwise, return nil.
3024 Assume point is at the beginning of the line break."
3033 "Interpret LINE-BREAK object as Org syntax.
3034 CONTENTS is nil."
3038 ;;;; Link
3041 "Parse link at point, if any.
3043 When at a link, return a list whose car is `link' and cdr a plist
3044 with `:type', `:path', `:raw-link', `:application',
3045 `:search-option', `:begin', `:end', `:contents-begin',
3046 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3047 nil.
3049 Assume point is at the beginning of the link."
3052 end contents-begin contents-end link-end post-blank path type
3053 raw-link link search-option application)
3055 ;; Type 1: Text targeted from a radio target.
3064 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3069 ;; RAW-LINK is the original link. Expand any
3070 ;; abbreviation in it.
3074 ;; Determine TYPE of link and set PATH accordingly.
3076 ;; File type.
3080 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3083 ;; According to RFC 3986, extra whitespace should be
3084 ;; ignored when a URI is extracted.
3087 ;; Id type: PATH is the id.
3090 ;; Code-ref type: PATH is the name of the reference.
3093 ;; Custom-id type: PATH is the name of the custom id.
3096 ;; Fuzzy type: Internal link either matches a target, an
3097 ;; headline name or nothing. PATH is the target or
3098 ;; headline's name.
3100 ;; Type 3: Plain link, e.g., http://orgmode.org
3106 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3114 ;; In any case, deduce end point after trailing white space from
3115 ;; LINK-END variable.
3119 ;; Special "file" type link processing. Extract opening
3120 ;; application and search option, if any. Also normalize URI.
3129 :path path
3131 :application application
3132 :search-option search-option
3133 :begin begin
3134 :end end
3135 :contents-begin contents-begin
3136 :contents-end contents-end
3140 "Interpret LINK object as Org syntax.
3141 CONTENTS is the contents of the object, or nil."
3146 raw-link
3150 ;;;; Macro
3153 "Parse macro at point, if any.
3155 When at a macro, return a list whose car is `macro' and cdr
3156 a plist with `:key', `:args', `:begin', `:end', `:value' and
3157 `:post-blank' as keywords. Otherwise, return nil.
3159 Assume point is at the macro."
3172 :value value
3173 :args args
3174 :begin begin
3175 :end end
3179 "Interpret MACRO object as Org syntax.
3180 CONTENTS is nil."
3184 ;;;; Radio-target
3187 "Parse radio target at point, if any.
3189 When at a radio target, return a list whose car is `radio-target'
3190 and cdr a plist with `:begin', `:end', `:contents-begin',
3191 `:contents-end', `:value' and `:post-blank' as keywords.
3192 Otherwise, return nil.
3194 Assume point is at the radio target."
3206 :end end
3207 :contents-begin contents-begin
3208 :contents-end contents-end
3209 :post-blank post-blank
3213 "Interpret TARGET object as Org syntax.
3214 CONTENTS is the contents of the object."
3218 ;;;; Statistics Cookie
3221 "Parse statistics cookie at point, if any.
3223 When at a statistics cookie, return a list whose car is
3224 `statistics-cookie', and cdr a plist with `:begin', `:end',
3225 `:value' and `:post-blank' keywords. Otherwise, return nil.
3227 Assume point is at the beginning of the statistics-cookie."
3238 :end end
3239 :value value
3243 "Interpret STATISTICS-COOKIE object as Org syntax.
3244 CONTENTS is nil."
3248 ;;;; Strike-Through
3251 "Parse strike-through object at point, if any.
3253 When at a strike-through object, return a list whose car is
3254 `strike-through' and cdr is a plist with `:begin', `:end',
3255 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3256 Otherwise, return nil.
3258 Assume point is at the first plus sign marker."
3270 :end end
3271 :contents-begin contents-begin
3272 :contents-end contents-end
3276 "Interpret STRIKE-THROUGH object as Org syntax.
3277 CONTENTS is the contents of the object."
3281 ;;;; Subscript
3284 "Parse subscript at point, if any.
3286 When at a subscript object, return a list whose car is
3287 `subscript' and cdr a plist with `:begin', `:end',
3288 `:contents-begin', `:contents-end', `:use-brackets-p' and
3289 `:post-blank' as keywords. Otherwise, return nil.
3291 Assume point is at the underscore."
3305 :end end
3306 :use-brackets-p bracketsp
3307 :contents-begin contents-begin
3308 :contents-end contents-end
3312 "Interpret SUBSCRIPT object as Org syntax.
3313 CONTENTS is the contents of the object."
3316 contents))
3319 ;;;; Superscript
3322 "Parse superscript at point, if any.
3324 When at a superscript object, return a list whose car is
3325 `superscript' and cdr a plist with `:begin', `:end',
3326 `:contents-begin', `:contents-end', `:use-brackets-p' and
3327 `:post-blank' as keywords. Otherwise, return nil.
3329 Assume point is at the caret."
3343 :end end
3344 :use-brackets-p bracketsp
3345 :contents-begin contents-begin
3346 :contents-end contents-end
3350 "Interpret SUPERSCRIPT object as Org syntax.
3351 CONTENTS is the contents of the object."
3354 contents))
3357 ;;;; Table Cell
3360 "Parse table cell at point.
3361 Return a list whose car is `table-cell' and cdr is a plist
3362 containing `:begin', `:end', `:contents-begin', `:contents-end'
3363 and `:post-blank' keywords."
3371 :end end
3372 :contents-begin contents-begin
3373 :contents-end contents-end
3377 "Interpret TABLE-CELL element as Org syntax.
3378 CONTENTS is the contents of the cell, or nil."
3382 ;;;; Target
3385 "Parse target at point, if any.
3387 When at a target, return a list whose car is `target' and cdr
3388 a plist with `:begin', `:end', `:value' and `:post-blank' as
3389 keywords. Otherwise, return nil.
3391 Assume point is at the target."
3401 :end end
3402 :value value
3406 "Interpret TARGET object as Org syntax.
3407 CONTENTS is nil."
3411 ;;;; Timestamp
3422 "Parse time stamp at point, if any.
3424 When at a time stamp, return a list whose car is `timestamp', and
3425 cdr a plist with `:type', `:raw-value', `:year-start',
3426 `:month-start', `:day-start', `:hour-start', `:minute-start',
3427 `:year-end', `:month-end', `:day-end', `:hour-end',
3428 `:minute-end', `:repeater-type', `:repeater-value',
3429 `:repeater-unit', `:warning-type', `:warning-value',
3430 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3431 Otherwise, return nil.
3433 Assume point is at the beginning of the timestamp."
3452 date-start)
3463 raw-value)
3465 :repeater-type
3471 :repeater-unit
3480 :warning-unit
3483 year-start month-start day-start hour-start minute-start year-end
3484 month-end day-end hour-end minute-end)
3485 ;; Parse date-start.
3493 ;; Compute date-end. It can be provided directly in time-stamp,
3494 ;; or extracted from time range. Otherwise, it defaults to the
3495 ;; same values as date-start.
3505 :raw-value raw-value
3506 :year-start year-start
3507 :month-start month-start
3508 :day-start day-start
3509 :hour-start hour-start
3510 :minute-start minute-start
3511 :year-end year-end
3512 :month-end month-end
3513 :day-end day-end
3514 :hour-end hour-end
3515 :minute-end minute-end
3516 :begin begin
3517 :end end
3519 repeater-props
3520 warning-props))))))
3523 "Interpret TIMESTAMP object as Org syntax.
3524 CONTENTS is nil."
3543 ;; Build an Org timestamp string from TIME. ACTIVEP is
3544 ;; non-nil when time stamp is active. If WITH-TIME-P is
3545 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3546 ;; specify a time range in the timestamp. REPEAT-STRING is
3547 ;; the repeater string, if any.
3551 org-time-stamp-formats)
3552 time)))
3558 nil nil ts)))
3563 " "
3564 s
3566 ;; Return value.
3567 ts)))
3579 build-ts-string
3598 0
3606 "--"
3619 ;;;; Underline
3622 "Parse underline object at point, if any.
3624 When at an underline object, return a list whose car is
3625 `underline' and cdr is a plist with `:begin', `:end',
3626 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3627 Otherwise, return nil.
3629 Assume point is at the first underscore marker."
3641 :end end
3642 :contents-begin contents-begin
3643 :contents-end contents-end
3647 "Interpret UNDERLINE object as Org syntax.
3648 CONTENTS is the contents of the object."
3652 ;;;; Verbatim
3655 "Parse verbatim object at point, if any.
3657 When at a verbatim object, return a list whose car is `verbatim'
3658 and cdr is a plist with `:value', `:begin', `:end' and
3659 `:post-blank' keywords. Otherwise, return nil.
3661 Assume point is at the first equal sign marker."
3672 :begin begin
3673 :end end
3677 "Interpret VERBATIM object as Org syntax.
3678 CONTENTS is nil."
3682 \f
3683 ;;; Parsing Element Starting At Point
3684 ;;
3685 ;; `org-element--current-element' is the core function of this section.
3686 ;; It returns the Lisp representation of the element starting at
3687 ;; point.
3688 ;;
3689 ;; `org-element--current-element' makes use of special modes. They
3690 ;; are activated for fixed element chaining (e.g., `plain-list' >
3691 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3692 ;; `section'). Special modes are: `first-section', `item',
3693 ;; `node-property', `section' and `table-row'.
3696 "Parse the element starting at point.
3698 Return value is a list like (TYPE PROPS) where TYPE is the type
3699 of the element and PROPS a plist of properties associated to the
3700 element.
3702 Possible types are defined in `org-element-all-elements'.
3704 LIMIT bounds the search.
3706 Optional argument GRANULARITY determines the depth of the
3707 recursion. Allowed values are `headline', `greater-element',
3708 `element', `object' or nil. When it is broader than `object' (or
3709 nil), secondary values will not be parsed, since they only
3710 contain objects.
3712 Optional argument MODE, when non-nil, can be either
3713 `first-section', `section', `planning', `item', `node-property'
3714 and `table-row'.
3716 If STRUCTURE isn't provided but MODE is set to `item', it will be
3717 computed.
3719 This function assumes point is always at the beginning of the
3720 element it has to parse."
3723 ;; Determine if parsing depth allows for secondary strings
3724 ;; parsing. It only applies to elements referenced in
3725 ;; `org-element-secondary-value-alist'.
3728 ;; Item.
3731 ;; Table Row.
3733 ;; Node Property.
3735 ;; Headline.
3738 ;; Sections (must be checked after headline).
3743 limit)))
3744 ;; Planning.
3747 ;; Property drawer.
3751 ;; When not at bol, point is at the beginning of an item or
3752 ;; a footnote definition: next item is always a paragraph.
3754 ;; Clock.
3756 ;; Inlinetask.
3759 ;; From there, elements can have affiliated keywords.
3762 ;; Jumping over affiliated keywords put point off-limits.
3763 ;; Parse them as regular keywords.
3767 ;; LaTeX Environment.
3770 ;; Drawer and Property Drawer.
3773 ;; Fixed Width
3776 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3777 ;; Keywords.
3786 org-element-block-name-alist)))
3801 ;; Footnote Definition.
3804 ;; Horizontal Rule.
3807 ;; Diary Sexp.
3810 ;; Table.
3812 ;; List.
3815 limit affiliated
3817 ;; Default element: Paragraph.
3821 ;; Most elements can have affiliated keywords. When looking for an
3822 ;; element beginning, we want to move before them, as they belong to
3823 ;; that element, and, in the meantime, collect information they give
3824 ;; into appropriate properties. Hence the following function.
3827 "Collect affiliated keywords from point down to LIMIT.
3829 Return a list whose CAR is the position at the first of them and
3830 CDR a plist of keywords and values and move point to the
3831 beginning of the first line after them.
3833 As a special case, if element doesn't start at the beginning of
3834 the line (e.g., a paragraph starting an item), CAR is current
3835 position of point and CDR is nil."
3839 ;; RESTRICT is the list of objects allowed in parsed
3840 ;; keywords value.
3842 output)
3845 ;; Apply translation to RAW-KWD. From there, KWD is
3846 ;; the official keyword.
3848 org-element-keyword-translation-alist))
3849 raw-kwd))
3850 ;; Find main value for any keyword.
3856 ;; PARSEDP is non-nil when keyword should have its
3857 ;; value parsed.
3859 ;; If KWD is a dual keyword, find its secondary
3860 ;; value. Maybe parse it.
3868 ;; Attribute a property name to KWD.
3870 ;; Now set final shape for VALUE.
3876 nil restrict)))
3880 ;; Attributes can always appear on multiple lines.
3883 ;; Eventually store the new value in OUTPUT.
3885 ;; Move to next keyword.
3887 ;; If affiliated keywords are orphaned: move back to first one.
3888 ;; They will be parsed as a paragraph.
3890 ;; Return value.
3894 \f
3895 ;;; The Org Parser
3896 ;;
3897 ;; The two major functions here are `org-element-parse-buffer', which
3898 ;; parses Org syntax inside the current buffer, taking into account
3899 ;; region, narrowing, or even visibility if specified, and
3900 ;; `org-element-parse-secondary-string', which parses objects within
3901 ;; a given string.
3902 ;;
3903 ;; The (almost) almighty `org-element-map' allows to apply a function
3904 ;; on elements or objects matching some type, and accumulate the
3905 ;; resulting values. In an export situation, it also skips unneeded
3906 ;; parts of the parse tree.
3909 "Recursively parse the buffer and return structure.
3910 If narrowing is in effect, only parse the visible part of the
3911 buffer.
3913 Optional argument GRANULARITY determines the depth of the
3914 recursion. It can be set to the following symbols:
3916 `headline' Only parse headlines.
3917 `greater-element' Don't recurse into greater elements excepted
3918 headlines and sections. Thus, elements
3919 parsed are the top-level ones.
3920 `element' Parse everything but objects and plain text.
3921 `object' Parse the complete buffer (default).
3923 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3924 elements.
3926 An element or an objects is represented as a list with the
3927 pattern (TYPE PROPERTIES CONTENTS), where :
3929 TYPE is a symbol describing the element or object. See
3930 `org-element-all-elements' and `org-element-all-objects' for an
3931 exhaustive list of such symbols. One can retrieve it with
3932 `org-element-type' function.
3934 PROPERTIES is the list of attributes attached to the element or
3935 object, as a plist. Although most of them are specific to the
3936 element or object type, all types share `:begin', `:end',
3937 `:post-blank' and `:parent' properties, which respectively
3938 refer to buffer position where the element or object starts,
3939 ends, the number of white spaces or blank lines after it, and
3940 the element or object containing it. Properties values can be
3941 obtained by using `org-element-property' function.
3943 CONTENTS is a list of elements, objects or raw strings
3944 contained in the current element or object, when applicable.
3945 One can access them with `org-element-contents' function.
3947 The Org buffer has `org-data' as type and nil as properties.
3948 `org-element-map' function can be used to find specific elements
3949 or objects within the parse tree.
3951 This function assumes that current major mode is `org-mode'."
3957 ;; Start in `first-section' mode so text before the first
3958 ;; headline belongs to a section.
3962 "Recursively parse objects in STRING and return structure.
3964 RESTRICTION is a symbol limiting the object types that will be
3965 looked after.
3967 Optional argument PARENT, when non-nil, is the element or object
3968 containing the secondary string. It is used to set correctly
3969 `:parent' property within the string.
3971 If STRING is the empty string or nil, return nil."
3987 data))))))
3991 "Map a function on selected elements or objects.
3993 DATA is a parse tree, an element, an object, a string, or a list
3994 of such constructs. TYPES is a symbol or list of symbols of
3995 elements or objects types (see `org-element-all-elements' and
3996 `org-element-all-objects' for a complete list of types). FUN is
3997 the function called on the matching element or object. It has to
3998 accept one argument: the element or object itself.
4000 When optional argument INFO is non-nil, it should be a plist
4001 holding export options. In that case, parts of the parse tree
4002 not exportable according to that property list will be skipped.
4004 When optional argument FIRST-MATCH is non-nil, stop at the first
4005 match for which FUN doesn't return nil, and return that value.
4007 Optional argument NO-RECURSION is a symbol or a list of symbols
4008 representing elements or objects types. `org-element-map' won't
4009 enter any recursive element or object whose type belongs to that
4010 list. Though, FUN can still be applied on them.
4012 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4013 apply to matching objects within parsed affiliated keywords (see
4014 `org-element-parsed-keywords').
4016 Nil values returned from FUN do not appear in the results.
4019 Examples:
4020 ---------
4022 Assuming TREE is a variable containing an Org buffer parse tree,
4023 the following example will return a flat list of all `src-block'
4024 and `example-block' elements in it:
4026 \(org-element-map tree '(example-block src-block) #'identity)
4028 The following snippet will find the first headline with a level
4031 \(org-element-map tree 'headline
4032 \(lambda (hl)
4033 \(and (= (org-element-property :level hl) 1)
4035 \(org-element-property :begin hl)))
4036 nil t)
4038 The next example will return a flat list of all `plain-list' type
4039 elements in TREE that are not a sub-list themselves:
4041 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4043 Eventually, this example will return a flat list of all `bold'
4044 type objects containing a `latex-snippet' type object, even
4045 looking into captions:
4047 \(org-element-map tree 'bold
4048 \(lambda (b)
4049 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4050 nil nil nil t)"
4051 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4055 ;; Recursion depth is determined by --CATEGORY.
4062 ;; If one object is found, the function has to
4063 ;; recurse into every object.
4066 ;; If one regular element is found, the
4067 ;; function has to recurse, at least, into
4068 ;; every element it encounters.
4071 --acc
4072 --walk-tree
4075 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4076 ;; holding contextual information.
4080 ;; Ignored element in an export context.
4082 ;; List of elements or objects.
4084 ;; Unconditionally enter parse trees.
4088 ;; Check if TYPE is matching among TYPES. If so,
4089 ;; apply FUN to --DATA and accumulate return value
4090 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4096 ;; If --DATA has a secondary string that can contain
4097 ;; objects with their type among TYPES, look into it.
4100 org-element-secondary-value-alist)))
4102 ;; If --DATA has any parsed affiliated keywords and
4103 ;; WITH-AFFILIATED is non-nil, look for objects in
4104 ;; them.
4111 ;; Pay attention to the type of parsed keyword.
4112 ;; In particular, preserve order for multiple
4113 ;; keywords.
4126 ;; Determine if a recursion into --DATA is possible.
4128 ;; --TYPE is explicitly removed from recursion.
4130 ;; --DATA has no contents.
4132 ;; Looking for greater elements but --DATA is simply
4133 ;; an element or an object.
4136 ;; Looking for elements but --DATA is an object.
4139 ;; In any other case, map contents.
4143 ;; Return value in a proper order.
4147 ;; The following functions are internal parts of the parser.
4148 ;;
4149 ;; The first one, `org-element--parse-elements' acts at the element's
4150 ;; level.
4151 ;;
4152 ;; The second one, `org-element--parse-objects' applies on all objects
4153 ;; of a paragraph or a secondary string. It calls
4154 ;; `org-element--object-lex' to find the next object in the current
4155 ;; container.
4158 "Return next special mode according to TYPE, or nil.
4159 TYPE is a symbol representing the type of an element or object
4160 containing next element if PARENTP is non-nil, or before it
4161 otherwise. Modes can be either `first-section', `item',
4162 `node-property', `planning', `property-drawer', `section',
4163 `table-row' or nil."
4179 "Parse elements between BEG and END positions.
4181 MODE prioritizes some elements over the others. It can be set to
4182 `first-section', `section', `planning', `item', `node-property'
4183 or `table-row'.
4185 When value is `item', STRUCTURE will be used as the current list
4186 structure.
4188 GRANULARITY determines the depth of the recursion. See
4189 `org-element-parse-buffer' for more information.
4191 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4192 elements.
4194 Elements are accumulated into ACC."
4197 ;; Visible only: skip invisible parts at the beginning of the
4198 ;; element.
4201 ;; When parsing only headlines, skip any text before first one.
4204 ;; Main loop start.
4206 ;; Find current element's type and parse it accordingly to
4207 ;; its category.
4209 end granularity mode structure))
4213 ;; Visible only: skip invisible parts between siblings.
4216 ;; Fill ELEMENT contents by side-effect.
4218 ;; If element has no contents, don't modify it.
4220 ;; Greater element: parse it between `contents-begin' and
4221 ;; `contents-end'. Make sure GRANULARITY allows the
4222 ;; recursion, or ELEMENT is a headline, in which case going
4223 ;; inside is mandatory, in order to get sub-level headings.
4231 ;; Possibly switch to a special mode.
4235 granularity visible-only element))
4236 ;; ELEMENT has contents. Parse objects inside, if
4237 ;; GRANULARITY allows it.
4243 ;; Update mode.
4245 ;; Return result.
4246 acc))
4249 "Return next object in current buffer or nil.
4250 RESTRICTION is a list of object types, as symbols, that should be
4251 looked after. This function assumes that the buffer is narrowed
4252 to an appropriate container (e.g., a paragraph)."
4260 found)
4325 ;; This is probably a plain link.
4331 ;; Radio link.
4336 "Parse objects between BEG and END and return recursive structure.
4338 Objects are accumulated in ACC.
4340 RESTRICTION is a list of object successors which are allowed in
4341 the current object."
4349 ;; 1. Text before any object. Untabify it.
4354 acc
4358 ;; 2. Object...
4361 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4362 ;; a recursive type.
4370 ;; 3. Text after last object. Untabify it.
4374 acc
4378 ;; Result.
4379 acc)))
4382 \f
4383 ;;; Towards A Bijective Process
4384 ;;
4385 ;; The parse tree obtained with `org-element-parse-buffer' is really
4386 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4387 ;; interpreted and expanded into a string with canonical Org syntax.
4388 ;; Hence `org-element-interpret-data'.
4389 ;;
4390 ;; The function relies internally on
4391 ;; `org-element--interpret-affiliated-keywords'.
4393 ;;;###autoload
4395 "Interpret DATA as Org syntax.
4396 DATA is a parse tree, an element, an object or a secondary string
4397 to interpret. Return Org syntax as a string."
4401 "Interpret DATA as Org syntax.
4403 DATA is a parse tree, an element, an object or a secondary string
4404 to interpret. PARENT is used for recursive calls. It contains
4405 the element or object containing data, or nil.
4407 Return Org syntax as a string."
4409 ;; Find interpreter for current object or element. If it
4410 ;; doesn't exist (e.g. this is a pseudo object or element),
4411 ;; return contents, if any.
4417 ;; Secondary string.
4421 ;; Full Org document.
4425 ;; Plain text: return it.
4427 ;; Element or object without contents.
4429 ;; Element or object with contents.
4432 ;; Recursively interpret contents.
4437 data
4438 ;; Fix indentation of elements containing
4439 ;; objects. We ignore `table-row' elements
4440 ;; as they are one line long anyway.
4442 data
4443 ;; When normalizing first paragraph of an
4444 ;; item or a footnote-definition, ignore
4445 ;; first line's indentation.
4452 ;; Build white spaces. If no `:post-blank' property is
4453 ;; specified, assume its value is 0.
4467 "Return ELEMENT's affiliated keywords as Org syntax.
4468 If there is no affiliated keyword, return the empty string."
4478 ": "
4481 value)
4489 ;; All attribute keywords can have multiple lines.
4495 ;; List all ELEMENT's properties matching an attribute line or an
4496 ;; affiliated keyword, but ignore translated keywords since they
4497 ;; cannot belong to the property list.
4504 org-element-keyword-translation-alist)))))
4505 collect prop)
4508 ;; Because interpretation of the parse tree must return the same
4509 ;; number of blank lines between elements and the same number of white
4510 ;; space after objects, some special care must be given to white
4511 ;; spaces.
4512 ;;
4513 ;; The first function, `org-element-normalize-string', ensures any
4514 ;; string different from the empty string will end with a single
4515 ;; newline character.
4516 ;;
4517 ;; The second function, `org-element-normalize-contents', removes
4518 ;; global indentation from the contents of the current element.
4521 "Ensure string S ends with a single newline character.
4523 If S isn't a string return it unchanged. If S is the empty
4524 string, return it. Otherwise, return a new string with a single
4525 newline character at its end."
4533 "Normalize plain text in ELEMENT's contents.
4535 ELEMENT must only contain plain text and objects.
4537 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4538 indentation to compute maximal common indentation.
4540 Return the normalized element that is element with global
4541 indentation removed from its contents. The function assumes that
4542 indentation is not done with TAB characters."
4544 find-min-ind ; For byte-compiler.
4546 ;; Return minimal common indentation within BLOB. This is
4547 ;; done by walking recursively BLOB and updating MIN-IND
4548 ;; along the way. FIRST-FLAG is non-nil when the next
4549 ;; object is expected to be a string that doesn't start with
4550 ;; a newline character. It happens for strings at the
4551 ;; beginnings of the contents or right after a line break.
4556 ;; Objects cannot start with spaces: in this case,
4557 ;; indentation is 0.
4561 ;; An indentation of zero means no string will be
4562 ;; modified. Quit the process.
4573 ;; Find minimal indentation in ELEMENT.
4576 ;; Build ELEMENT back, replacing each string with the same
4577 ;; string minus common indentation.
4581 ;; Return BLOB with all its strings indentation
4582 ;; shortened from MIN-IND white spaces. FIRST-FLAG is
4583 ;; non-nil when the next object is expected to be
4584 ;; a string that doesn't start with a newline
4585 ;; character.
4601 org-element-recursive-objects)
4605 object)
4608 blob)))
4612 \f
4613 ;;; Cache
4614 ;;
4615 ;; Implement a caching mechanism for `org-element-at-point' and
4616 ;; `org-element-context', which see.
4617 ;;
4618 ;; A single public function is provided: `org-element-cache-reset'.
4619 ;;
4620 ;; Cache is enabled by default, but can be disabled globally with
4621 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4622 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4623 ;; can be tweaked to control caching behaviour.
4624 ;;
4625 ;; Internally, parsed elements are stored in an AVL tree,
4626 ;; `org-element--cache'. This tree is updated lazily: whenever
4627 ;; a change happens to the buffer, a synchronization request is
4628 ;; registered in `org-element--cache-sync-requests' (see
4629 ;; `org-element--cache-submit-request'). During idle time, requests
4630 ;; are processed by `org-element--cache-sync'. Synchronization also
4631 ;; happens when an element is required from the cache. In this case,
4632 ;; the process stops as soon as the needed element is up-to-date.
4633 ;;
4634 ;; A synchronization request can only apply on a synchronized part of
4635 ;; the cache. Therefore, the cache is updated at least to the
4636 ;; location where the new request applies. Thus, requests are ordered
4637 ;; from left to right and all elements starting before the first
4638 ;; request are correct. This property is used by functions like
4639 ;; `org-element--cache-find' to retrieve elements in the part of the
4640 ;; cache that can be trusted.
4641 ;;
4642 ;; A request applies to every element, starting from its original
4643 ;; location (or key, see below). When a request is processed, it
4644 ;; moves forward and may collide the next one. In this case, both
4645 ;; requests are merged into a new one that starts from that element.
4646 ;; As a consequence, the whole synchronization complexity does not
4647 ;; depend on the number of pending requests, but on the number of
4648 ;; elements the very first request will be applied on.
4649 ;;
4650 ;; Elements cannot be accessed through their beginning position, which
4651 ;; may or may not be up-to-date. Instead, each element in the tree is
4652 ;; associated to a key, obtained with `org-element--cache-key'. This
4653 ;; mechanism is robust enough to preserve total order among elements
4654 ;; even when the tree is only partially synchronized.
4655 ;;
4656 ;; Objects contained in an element are stored in a hash table,
4657 ;; `org-element--cache-objects'.
4661 "Non nil when Org parser should cache its results.
4668 "Maximum duration, as a time value, for a cache synchronization.
4669 If the synchronization is not over after this delay, the process
4670 pauses and resumes after `org-element-cache-sync-break'
4674 "Duration, as a time value, of the pause between synchronizations.
4678 ;;;; Data Structure
4681 "AVL tree used to cache elements.
4682 Each node of the tree contains an element. Comparison is done
4683 with `org-element--cache-compare'. This cache is used in
4687 "Hash table used as to cache objects.
4688 Key is an element, as returned by `org-element-at-point', and
4689 value is an alist where each association is:
4691 \(PARENT COMPLETEP . OBJECTS)
4693 where PARENT is an element or object, COMPLETEP is a boolean,
4694 non-nil when all direct children of parent are already cached and
4695 OBJECTS is a list of such children, as objects, from farthest to
4696 closest.
4699 contained within a paragraph
4703 If the paragraph is completely parsed, OBJECTS-DATA will be
4705 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4706 \(BOLD-OBJECT t ENTITY-OBJECT))
4708 whereas in a partially parsed paragraph, it could be
4710 \((PARAGRAPH nil ENTITY-OBJECT))
4715 "List of pending synchronization requests.
4717 A request is a vector with the following pattern:
4719 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4721 Processing a synchronization request consists of three phases:
4723 0. Delete modified elements,
4724 1. Fill missing area in cache,
4725 2. Shift positions and re-parent elements after the changes.
4727 During phase 0, NEXT is the key of the first element to be
4728 removed, BEG and END is buffer position delimiting the
4729 modifications. Elements starting between them (inclusive) are
4730 removed and so are those contained within OUTREACH. PARENT, when
4731 non-nil, is the parent of the first element to be removed.
4733 During phase 1, NEXT is the key of the next known element in
4734 cache and BEG its beginning position. Parse buffer between that
4735 element and the one before it in order to determine the parent of
4736 the next element. Set PARENT to the element containing NEXT.
4738 During phase 2, NEXT is the key of the next element to shift in
4739 the parse tree. All elements starting from this one have their
4740 properties relatives to buffer positions shifted by integer
4741 OFFSET and, if they belong to element PARENT, are adopted by it.
4749 "Hash table used to store keys during synchronization.
4753 "Return a unique key for ELEMENT in cache tree.
4755 Keys are used to keep a total order among elements in the cache.
4756 Comparison is done with `org-element--cache-key-less-p'.
4758 When no synchronization is taking place, a key is simply the
4759 beginning position of the element, or that position plus one in
4760 the case of an first item (respectively row) in
4761 a list (respectively a table).
4763 During a synchronization, the key is the one the element had when
4764 the cache was synchronized for the last time. Elements added to
4765 cache during the synchronization get a new key generated with
4766 `org-element--cache-generate-key'.
4768 Such keys are stored in `org-element--cache-sync-keys'. The hash
4769 table is cleared once the synchronization is complete."
4772 ;; Increase beginning position of items (respectively
4773 ;; table rows) by one, so the first item can get
4774 ;; a different key from its parent list (respectively
4775 ;; table).
4778 begin)))
4781 key))))
4784 "Generate a key between LOWER and UPPER.
4786 LOWER and UPPER are integers or lists, possibly empty.
4788 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4789 a unique key, as an integer or a list of integers, according to
4790 the following rules:
4792 - LOWER and UPPER are compared level-wise until values differ.
4794 - If, at a given level, LOWER and UPPER differ from more than
4795 2, the new key shares all the levels above with LOWER and
4796 gets a new level. Its value is the mean between LOWER and
4797 UPPER:
4799 \(1 2) + (1 4) --> (1 3)
4801 - If LOWER has no value to compare with, it is assumed that its
4802 value is `most-negative-fixnum'. E.g.,
4804 \(1 1) + (1 1 2)
4806 is equivalent to
4808 \(1 1 m) + (1 1 2)
4810 where m is `most-negative-fixnum'. Likewise, if UPPER is
4811 short of levels, the current value is `most-positive-fixnum'.
4813 - If they differ from only one, the new key inherits from
4814 current LOWER level and fork it at the next level. E.g.,
4816 \(2 1) + (3 3)
4818 is equivalent to
4820 \(2 1) + (2 M)
4822 where M is `most-positive-fixnum'.
4824 - If the key is only one level long, it is returned as an
4825 integer:
4827 \(1 2) + (3 2) --> 2
4829 When they are not equals, the function assumes that LOWER is
4830 lesser than UPPER, per `org-element--cache-key-less-p'."
4834 skip-upper key)
4845 ;; When at a given level, LOWER and UPPER differ from
4846 ;; 1, ignore UPPER altogether. Instead create a key
4847 ;; between LOWER and the greatest key with the same
4848 ;; prefix as LOWER so far.
4854 "Non-nil if key A is less than key B.
4855 A and B are either integers or lists of integers, as returned by
4856 `org-element--cache-key'."
4864 ;; If A is empty, either keys are equal (B is also empty) and
4865 ;; we return nil, or A is lesser than B (B is longer) and we
4866 ;; return a non-nil value.
4867 ;;
4868 ;; If A is not empty, B is necessarily empty and A is greater
4869 ;; than B (A is longer). Therefore, return nil.
4873 "Non-nil when element A is located before element B."
4878 "Return root value in cache.
4879 This function assumes `org-element--cache' is a valid AVL tree."
4883 ;;;; Tools
4886 "Non-nil when cache is active in current buffer."
4891 "Find element in cache starting at POS or before.
4893 POS refers to a buffer position.
4895 When optional argument SIDE is non-nil, the function checks for
4896 elements starting at or past POS instead. If SIDE is `both', the
4897 function returns a cons cell where car is the first element
4898 starting at or before POS and cdr the first element starting
4899 after POS.
4901 The function can only find elements in the synchronized part of
4902 the cache."
4906 lower upper)
4921 ;; We found an element in cache starting at POS. If `side'
4922 ;; is `both' we also want the next one in order to generate
4923 ;; a key in-between.
4924 ;;
4925 ;; If the element is the first row or item in a table or
4926 ;; a plain list, we always return the table or the plain
4927 ;; list.
4928 ;;
4929 ;; In any other case, we return the element found.
4938 lower parent
4939 upper parent)))))
4942 lower element
4943 upper element)))))
4950 "Store ELEMENT in current buffer's cache, if allowed.
4951 When optional argument DATA is non-nil, assume is it object data
4952 relative to ELEMENT and store it in the objects cache."
4956 ;; During synchronization, first build an appropriate key
4957 ;; for the new element so `avl-tree-enter' can insert it at
4958 ;; the right spot in the cache.
4967 org-element--cache-sync-keys)))
4969 ;; Headlines are not stored in cache, so objects in titles are
4970 ;; not stored either.
4975 "Remove ELEMENT from cache.
4976 Assume ELEMENT belongs to cache and that a cache is active."
4981 ;;;; Synchronization
4984 "Set idle timer for cache synchronization in BUFFER."
4991 org-element-cache-sync-idle-time))
4992 nil
4993 #'org-element--cache-sync
4994 buffer)))
4997 "Non-nil when synchronization process should be interrupted.
4998 TIME-LIMIT is a time value or nil."
5004 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5006 Properties containing buffer positions are `:begin', `:end',
5007 `:contents-begin', `:contents-end' and `:structure'. When
5008 optional argument PROPS is a list of keywords, only shift
5009 properties provided in that list.
5011 Properties are modified by side-effect."
5013 ;; Shift `:structure' property for the first plain list only: it
5014 ;; is the only one that really matters and it prevents from
5015 ;; shifting it more than once.
5029 "Synchronize cache with recent modification in BUFFER.
5031 When optional argument THRESHOLD is non-nil, do the
5032 synchronization for all elements starting before or at threshold,
5033 then exit. Otherwise, synchronize cache for as long as
5034 `org-element-cache-sync-duration' or until Emacs leaves idle
5035 state.
5037 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5038 not registered yet in the cache are going to happen. It is used
5039 in `org-element--cache-submit-request', where cache is partially
5040 updated before current modification are actually submitted."
5051 request
5053 threshold
5056 org-element-cache-sync-duration))
5057 future-change)
5058 ;; Request processed. Merge current and next offsets and
5059 ;; transfer ending position.
5065 ;; If more requests are awaiting, set idle timer accordingly.
5066 ;; Otherwise, reset keys.
5073 "Process synchronization REQUEST for all entries before NEXT.
5075 REQUEST is a vector, built by `org-element--cache-submit-request'.
5077 NEXT is a cache key, as returned by `org-element--cache-key'.
5079 When non-nil, THRESHOLD is a buffer position. Synchronization
5080 stops as soon as a shifted element begins after it.
5082 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5083 after this time or when Emacs exits idle state.
5085 When non-nil, FUTURE-CHANGE is a buffer position where changes
5086 not registered yet in the cache are going to happen. See
5087 `org-element--cache-submit-request' for more information.
5089 Throw `interrupt' if the process stops before completing the
5090 request."
5093 ;; Phase 0.
5094 ;;
5095 ;; Delete all elements starting after BEG, but not after buffer
5096 ;; position END or past element with key NEXT.
5097 ;;
5098 ;; At each iteration, we start again at tree root since
5099 ;; a deletion modifies structure of the balanced tree.
5107 ;; Find first element in cache with key BEG or after it.
5117 data-key key
5120 data-key key
5121 node nil)))))
5130 up))
5136 ;; No element starting after modifications left in
5137 ;; cache: further processing is futile.
5140 ;; Phase 1.
5141 ;;
5142 ;; Phase 0 left a hole in the cache. Some elements after it
5143 ;; could have parents within. For example, in the following
5144 ;; buffer:
5145 ;;
5146 ;; - item
5147 ;;
5148 ;;
5149 ;; Paragraph1
5150 ;;
5151 ;; Paragraph2
5152 ;;
5153 ;; if we remove a blank line between "item" and "Paragraph1",
5154 ;; everything down to "Paragraph2" is removed from cache. But
5155 ;; the paragraph now belongs to the list, and its `:parent'
5156 ;; property no longer is accurate.
5157 ;;
5158 ;; Therefore we need to parse again elements in the hole, or at
5159 ;; least in its last section, so that we can re-parent
5160 ;; subsequent elements, during phase 2.
5161 ;;
5162 ;; Note that we only need to get the parent from the first
5163 ;; element in cache after the hole.
5164 ;;
5165 ;; When next key is lesser or equal to the current one, delegate
5166 ;; phase 1 processing to next request in order to preserve key
5167 ;; order among requests.
5175 ;; Next element will start at its beginning position plus
5176 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5177 ;; contains the real beginning position of the first element to
5178 ;; shift and re-parent.
5182 ;; Changes are going to happen around this element and
5183 ;; they will trigger another phase 1 request. Skip the
5184 ;; current one.
5190 ;; Phase 2.
5191 ;;
5192 ;; Shift all elements starting from key START, but before NEXT, by
5193 ;; OFFSET, and re-parent them when appropriate.
5194 ;;
5195 ;; Elements are modified by side-effect so the tree structure
5196 ;; remains intact.
5197 ;;
5198 ;; Once THRESHOLD, if any, is reached, or once there is an input
5199 ;; pending, exit. Before leaving, the current synchronization
5200 ;; request is updated.
5207 exit-flag)
5208 ;; No re-parenting nor shifting planned: request is over.
5218 ;; We reached NEXT. Request is complete.
5220 ;; Handle interruption request. Update current request.
5225 ;; Shift element.
5228 ;; Shift associated objects data, if any.
5233 ;; Update PARENT and re-parent DATA, only when
5234 ;; necessary. Propagate new structures for lists.
5248 ;; Cache is up-to-date past THRESHOLD. Request
5249 ;; interruption.
5254 ;; We reached end of tree: synchronization complete.
5255 t)))
5258 "Parse elements in current section, down to POS.
5260 Start parsing from the closest between the last known element in
5261 cache or headline above. Return the smallest element containing
5262 POS.
5264 When optional argument SYNCP is non-nil, return the parent of the
5265 element containing POS instead. In that case, it is also
5266 possible to provide TIME-LIMIT, which is a time value specifying
5267 when the parsing should stop. The function throws `interrupt' if
5268 the process stopped before finding the expected result."
5275 element next mode)
5277 ;; Nothing in cache before point: start parsing from first
5278 ;; element following headline above, or first element in
5279 ;; buffer.
5286 ;; Cache returned exact match: return it.
5289 ;; There's a headline between cached value and POS: cached
5290 ;; value is invalid. Start parsing from first element
5291 ;; following the headline.
5298 ;; Check if CACHED or any of its ancestors contain point.
5299 ;;
5300 ;; If there is such an element, we inspect it in order to know
5301 ;; if we return it or if we need to parse its contents.
5302 ;; Otherwise, we just start parsing from current location,
5303 ;; which is right after the top-most element containing
5304 ;; CACHED.
5305 ;;
5306 ;; As a special case, if POS is at the end of the buffer, we
5307 ;; want to return the innermost element ending there.
5308 ;;
5309 ;; Also, if we find an ancestor and discover that we need to
5310 ;; parse its contents, make sure we don't start from
5311 ;; `:contents-begin', as we would otherwise go past CACHED
5312 ;; again. Instead, in that situation, we will resume parsing
5313 ;; from NEXT, which is located after CACHED or its higher
5314 ;; ancestor not containing point.
5326 ;; Parse successively each element until we reach POS.
5339 end 'element mode
5346 ;; Skip any element ending before point. Also skip
5347 ;; element ending at point (unless it is also the end of
5348 ;; buffer) since we're sure that another element begins
5349 ;; after it.
5353 ;; A non-greater element contains point: return it.
5356 ;; Otherwise, we have to decide if ELEMENT really
5357 ;; contains POS. In that case we start parsing from
5358 ;; contents' beginning.
5359 ;;
5360 ;; If POS is at contents' beginning but it is also at
5361 ;; the beginning of the first item in a list or a table.
5362 ;; In that case, we need to create an anchor for that
5363 ;; list or table, so return it.
5364 ;;
5365 ;; Also, if POS is at the end of the buffer, no element
5366 ;; can start after it, but more than one may end there.
5367 ;; Arbitrarily, we choose to return the innermost of
5368 ;; such elements.
5381 parent element
5382 end cend))))
5383 ;; Otherwise, return ELEMENT as it is the smallest
5384 ;; element containing POS.
5389 ;;;; Staging Buffer Changes
5400 "Regexp matching a sensitive line, structure wise.
5401 A sensitive line is a headline, inlinetask, block, drawer, or
5402 latex-environment boundary. When such a line is modified,
5403 structure changes in the document may propagate in the whole
5407 "Non-nil when a sensitive line is about to be changed.
5411 "Request extension of area going to be modified if needed.
5412 BEG and END are the beginning and end of the range of changed
5413 text. See `before-change-functions' for more information."
5423 'headline
5426 org-element--cache-sensitive-re bottom t)))))))))
5429 "Update buffer modifications for current buffer.
5430 BEG and END are the beginning and end of the range of changed
5431 text, and the length in bytes of the pre-change text replaced by
5432 that range. See `after-change-functions' for more information."
5440 ;; Determine if modified area needs to be extended, according
5441 ;; to both previous and current state. We make a special
5442 ;; case for headline editing: if a headline is modified but
5443 ;; not removed, do not extend.
5452 org-element--cache-sensitive-re bottom t))))
5453 ;; Effectively extend modified area.
5461 ;; Store synchronization request.
5464 ;; Activate a timer to process the request during idle time.
5468 "Return first element to remove from cache.
5470 BEG and END are buffer positions delimiting buffer modifications.
5471 OFFSET is the size of the changes.
5473 Returned element is usually the first element in cache containing
5474 any position between BEG and END. As an exception, greater
5475 elements around the changes that are robust to contents
5476 modifications are preserved and updated according to the
5477 changes."
5487 special-block))
5488 ;; Drawers named "PROPERTIES" are probably
5489 ;; a properties drawer being edited. Force
5490 ;; parsing to check if editing is over.
5499 ;; UP is a robust greater element containing changes.
5500 ;; We only need to extend its ending boundaries.
5506 ;; We're at top level element containing ELEMENT: if it's
5507 ;; altered by buffer modifications, it is first element in
5508 ;; cache to be removed. Otherwise, that first element is the
5509 ;; following one.
5510 ;;
5511 ;; As a special case, do not remove BEFORE if it is a robust
5512 ;; container for current changes.
5514 before)))))
5517 "Submit a new cache synchronization request for current buffer.
5518 BEG and END are buffer positions delimiting the minimal area
5519 where cache data should be removed. OFFSET is the size of the
5520 change, as an integer."
5522 delete-to delete-from)
5527 ;; Current changes can be merged with first sync request: we
5528 ;; can save a partial cache synchronization.
5531 ;; If last change happened within area to be removed, extend
5532 ;; boundaries of robust parents, if any. Otherwise, find
5533 ;; first element to remove and update request accordingly.
5545 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5546 ;; if any, is no longer a 0-phase request, thus ensuring that
5547 ;; phases are properly ordered. We need to provide OFFSET as
5548 ;; optional parameter since current modifications are not known
5549 ;; yet to the otherwise correct part of the cache (i.e, before
5550 ;; the first request).
5557 ;; When changes happen before the first known
5558 ;; element, re-parent and shift the rest of the
5559 ;; cache.
5561 ;; Otherwise, we find the first non robust
5562 ;; element containing END. All elements between
5563 ;; FIRST and this one are to be removed.
5564 ;;
5565 ;; Among them, some could be located outside the
5566 ;; synchronized part of the cache, in which case
5567 ;; comparing buffer positions to find them is
5568 ;; useless. Instead, we store the element
5569 ;; containing them in the request itself. All
5570 ;; its children will be removed.
5582 element up))
5585 org-element--cache-sync-requests)
5586 ;; No element to remove. No need to re-parent either.
5587 ;; Simply shift additional elements, if any, by OFFSET.
5592 ;;;; Public Functions
5594 ;;;###autoload
5596 "Reset cache in current buffer.
5597 When optional argument ALL is non-nil, reset cache in all Org
5598 buffers."
5616 ;;;###autoload
5618 "Refresh cache at position POS."
5625 \f
5626 ;;; The Toolbox
5627 ;;
5628 ;; The first move is to implement a way to obtain the smallest element
5629 ;; containing point. This is the job of `org-element-at-point'. It
5630 ;; basically jumps back to the beginning of section containing point
5631 ;; and proceed, one element after the other, with
5632 ;; `org-element--current-element' until the container is found. Note:
5633 ;; When using `org-element-at-point', secondary values are never
5634 ;; parsed since the function focuses on elements, not on objects.
5635 ;;
5636 ;; At a deeper level, `org-element-context' lists all elements and
5637 ;; objects containing point.
5638 ;;
5639 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5640 ;; internally by navigation and manipulation tools.
5643 ;;;###autoload
5645 "Determine closest element around point.
5647 Return value is a list like (TYPE PROPS) where TYPE is the type
5648 of the element and PROPS a plist of properties associated to the
5649 element.
5651 Possible types are defined in `org-element-all-elements'.
5652 Properties depend on element or object type, but always include
5653 `:begin', `:end', `:parent' and `:post-blank' properties.
5655 As a special case, if point is at the very beginning of the first
5656 item in a list or sub-list, returned element will be that list
5657 instead of the item. Likewise, if point is at the beginning of
5658 the first row of a table, returned element will be the table
5659 instead of the first row.
5661 When point is at the end of the buffer, return the innermost
5662 element ending there."
5668 ;; Within blank lines at the beginning of buffer, return nil.
5670 ;; Within blank lines right after a headline, return that
5671 ;; headline.
5675 ;; Otherwise parse until we find element containing ORIGIN.
5682 ;;;###autoload
5684 "Return smallest element or object around point.
5686 Return value is a list like (TYPE PROPS) where TYPE is the type
5687 of the element or object and PROPS a plist of properties
5688 associated to it.
5690 Possible types are defined in `org-element-all-elements' and
5691 `org-element-all-objects'. Properties depend on element or
5692 object type, but always include `:begin', `:end', `:parent' and
5693 `:post-blank'.
5695 As a special case, if point is right after an object and not at
5696 the beginning of any other object, return that object.
5698 Optional argument ELEMENT, when non-nil, is the closest element
5699 containing point, as returned by `org-element-at-point'.
5700 Providing it allows for quicker computation."
5706 ;; If point is inside an element containing objects or
5707 ;; a secondary string, narrow buffer to the container and
5708 ;; proceed with parsing. Otherwise, return ELEMENT.
5710 ;; At a parsed affiliated keyword, check if we're inside main
5711 ;; or dual value.
5718 org-element-parsed-keywords))
5727 ;; Also change type to retrieve correct restrictions.
5729 ;; At an item, objects can only be located within tag, if any.
5739 ;; At an headline or inlinetask, objects are in title.
5746 ;; At a paragraph, a table-row or a verse block, objects are
5747 ;; located within their contents.
5751 ;; CBEG is nil for table rules.
5756 ;; At a planning line, if point is at a timestamp, return it,
5757 ;; otherwise, return element.
5765 ;; All other locations cannot contain objects: bail out.
5775 next object-data last)
5779 ;; When entering PARENT for the first time, get list
5780 ;; of objects within known so far. Store it in
5781 ;; OBJECT-DATA.
5786 ;; Find NEXT object for analysis.
5788 ;; If NEXT is non-nil, we already exhausted the
5789 ;; cache so we can parse buffer to find the object
5790 ;; after it.
5792 ;; Otherwise, check if cache can help us.
5803 ;; Cache contains the information needed.
5806 pos)
5808 pos)
5814 ;; If we have a new object to analyze, store it in
5815 ;; cache. Otherwise record that there is nothing
5816 ;; more to parse in this element at this depth.
5821 ;; Process NEXT, if any, in order to know if we need
5822 ;; to skip it, return it or move into it.
5829 ;; Skip objects ending before point. Also skip
5830 ;; objects ending at point unless it is also the
5831 ;; end of buffer, since we want to return the
5832 ;; innermost object.
5835 ;; For convenience, when object ends at POS,
5836 ;; without any space, store it in LAST, as we
5837 ;; will return it if no object starts here.
5841 ;; If POS is within a container object, move
5842 ;; into that object.
5846 ;; At contents' end, if there is no
5847 ;; space before point, also move into
5848 ;; object, for consistency with
5849 ;; convenience feature above.
5858 next nil
5859 object-data nil))
5860 ;; Otherwise, return NEXT.
5862 ;; Store results in cache, if applicable.
5866 "List all ancestors of a given element or object.
5868 BLOB is an object or element.
5870 When optional argument TYPES is a list of symbols, return the
5871 first element or object in the lineage whose type belongs to that
5872 list.
5874 When optional argument WITH-SELF is non-nil, lineage includes
5875 BLOB itself as the first element, and TYPES, if provided, also
5876 apply to it.
5878 When BLOB is obtained through `org-element-context' or
5879 `org-element-at-point', only ancestors from its section can be
5880 found. There is no such limitation when BLOB belongs to a full
5881 parse tree."
5883 ancestors)
5890 "Non-nil when elements ELEM-A and ELEM-B are nested."
5899 "Swap elements ELEM-A and ELEM-B.
5900 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5901 end of ELEM-A."
5903 ;; There are two special cases when an element doesn't start at bol:
5904 ;; the first paragraph in an item or in a footnote definition.
5906 ;; Only a paragraph without any affiliated keyword can be moved at
5907 ;; ELEM-A position in such a situation. Note that the case of
5908 ;; a footnote definition is impossible: it cannot contain two
5909 ;; paragraphs in a row because it cannot contain a blank line.
5915 ;; In a special situation, ELEM-A will have no indentation. We'll
5916 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5930 ;; Store inner overlays responsible for visibility status.
5931 ;; We also need to store their boundaries as they will be
5932 ;; removed from buffer.
5947 ;; Get contents.
5955 ;; Restore ex ELEM-A overlays.
5962 ;; Restore ex ELEM-B overlays.
5968 "Remove maximum common indentation in string S and return it.
5969 When optional argument N is a positive integer, remove exactly
5970 that much characters from indentation, if possible, or return
5971 S as-is otherwise. Unlike to `org-remove-indentation', this
5972 function doesn't call `untabify' on S."
5977 ;; Find maximum common indentation, if not specified.
5985 min-ind)))
5987 ;; Remove exactly N indentation, but give up if not possible.
6000 ;; Local variables:
6001 ;; generated-autoload-file: "org-loaddefs.el"
6002 ;; End:
6004 ;;; org-element.el ends here