| blob | 4e5e131c11c71ef3f735a2fe261a05333ff091cc |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 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)
259 "Alist between block names and the associated parsing function.
260 Names must be uppercase. Any block whose name has no association
266 Only these types can accept search options and an explicit
272 "List of affiliated keywords as strings.
280 "Alist of usual translations for keywords.
281 The key is the old name and the value the new one. The property
285 "List of affiliated keywords that can occur more than once in an element.
287 Their value will be consed into a list of strings, which will be
288 returned as the value of the property.
290 This list is checked after translations have been applied. See
291 `org-element-keyword-translation-alist'.
297 "List of affiliated keywords whose value can be parsed.
299 Their value will be stored as a secondary string: a list of
300 strings and objects.
302 This list is checked after translations have been applied. See
307 org-element-parsed-keywords)
308 "Alist of parsed keywords and associated properties.
309 This is generated from `org-element-parsed-keywords', which
313 "List of affiliated keywords which can have a secondary value.
315 In Org syntax, they can be written with optional square brackets
316 before the colons. For example, RESULTS keyword can be
317 associated to a hash value with the following:
319 #+RESULTS[hash-string]: some-source
321 This list is checked after translations have been applied. See
325 "List of properties associated to the whole document.
326 Any keyword in this list will have its value parsed and stored as
332 ;; Dual affiliated keywords.
336 ;; Regular affiliated keywords.
342 org-element-affiliated-keywords)))
344 ;; Export attributes.
346 "Regexp matching any affiliated keyword.
348 Keyword name is put in match group 1. Moreover, if keyword
349 belongs to `org-element-dual-keywords', put the dual value in
350 match group 2.
364 ;; Ignore all links excepted plain links in a link description.
365 ;; Also ignore radio-targets and line breaks.
367 italic latex-fragment macro plain-link statistics-cookie
368 strike-through subscript superscript underline verbatim)
370 ;; Remove any variable object from radio target as it would
371 ;; prevent it from being properly recognized.
373 subscript superscript underline superscript)
377 ;; Ignore inline babel call and inline src block as formulas are
378 ;; possible. Also ignore line breaks and statistics cookies.
380 latex-fragment link macro radio-target strike-through
381 subscript superscript target timestamp underline verbatim)
385 "Alist of objects restrictions.
387 key is an element or object type containing objects and value is
388 a list of types that can be contained within an element or object
389 of such type.
391 For example, in a `radio-target' object, one can only find
392 entities, latex-fragments, subscript, superscript and text
393 markup.
395 This alist also applies to secondary string. For example, an
396 `headline' type element doesn't directly contain objects, but
406 \f
407 ;;; Accessors and Setters
408 ;;
409 ;; Provide four accessors: `org-element-type', `org-element-property'
410 ;; `org-element-contents' and `org-element-restriction'.
411 ;;
412 ;; Setter functions allow to modify elements by side effect. There is
413 ;; `org-element-put-property', `org-element-set-contents'. These
414 ;; low-level functions are useful to build a parse tree.
415 ;;
416 ;; `org-element-adopt-element', `org-element-set-element',
417 ;; `org-element-extract-element' and `org-element-insert-before' are
418 ;; high-level functions useful to modify a parse tree.
419 ;;
420 ;; `org-element-secondary-p' is a predicate used to know if a given
421 ;; object belongs to a secondary string.
424 "Return type of ELEMENT.
426 The function returns the type of the element or object provided.
427 It can also return the following special value:
428 `plain-text' for a string
429 `org-data' for a complete document
430 nil in any other case."
436 "Extract the value from the PROPERTY of an ELEMENT."
441 "Extract contents from an ELEMENT."
447 "Return restriction associated to ELEMENT.
448 ELEMENT can be an element, an object or a symbol representing an
449 element or object type."
451 org-element-object-restrictions)))
454 "In ELEMENT set PROPERTY to VALUE.
455 Return modified element."
458 element))
461 "Set ELEMENT contents to CONTENTS.
462 Return modified element."
469 "Non-nil when OBJECT belongs to a secondary string.
470 Return value is the property name, as a keyword, or nil."
473 org-element-secondary-value-alist))))
476 property)))
479 "Append elements to the contents of another element.
481 PARENT is an element or object. CHILDREN can be elements,
482 objects, or a strings.
484 The function takes care of setting `:parent' property for CHILD.
485 Return parent element."
486 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
487 ;; string: parent is the list itself.
490 children)
491 ;; Add CHILDREN at the end of PARENT contents.
494 parent
496 ;; Return modified PARENT element.
500 "Extract ELEMENT from parse tree.
501 Remove element from the parse tree by side-effect, and return it
502 with its `:parent' property stripped out."
507 parent secondary
510 parent
512 ;; Return ELEMENT with its :parent removed.
516 "Insert ELEMENT before LOCATION in parse tree.
517 LOCATION is an element, object or string within the parse tree.
518 Parse tree is modified by side effect."
523 ;; Special case: LOCATION is the first element of an
524 ;; independent secondary string (e.g. :title property). Add
525 ;; ELEMENT in-place.
529 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
539 ;; Store SIBLINGS at appropriate place in parse tree.
544 ;; Set appropriate :parent property.
548 "Replace element or object OLD with element or object NEW.
549 The function takes care of setting `:parent' property for NEW."
550 ;; Ensure OLD and NEW have the same parent.
554 ;; We cannot replace OLD with NEW since one of them is not an
555 ;; object or element. We take the long path.
558 ;; Since OLD is going to be changed into NEW by side-effect, first
559 ;; make sure that every element or object within NEW has OLD as
560 ;; parent.
563 ;; Transfer contents.
565 ;; Overwrite OLD's properties with NEW's.
567 ;; Transfer type.
571 \f
572 ;;; Greater elements
573 ;;
574 ;; For each greater element type, we define a parser and an
575 ;; interpreter.
576 ;;
577 ;; A parser returns the element or object as the list described above.
578 ;; Most of them accepts no argument. Though, exceptions exist. Hence
579 ;; every element containing a secondary string (see
580 ;; `org-element-secondary-value-alist') will accept an optional
581 ;; argument to toggle parsing of that secondary string. Moreover,
582 ;; `item' parser requires current list's structure as its first
583 ;; element.
584 ;;
585 ;; An interpreter accepts two arguments: the list representation of
586 ;; the element or object, and its contents. The latter may be nil,
587 ;; depending on the element or object considered. It returns the
588 ;; appropriate Org syntax, as a string.
589 ;;
590 ;; Parsing functions must follow the naming convention:
591 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
592 ;; defined in `org-element-greater-elements'.
593 ;;
594 ;; Similarly, interpreting functions must follow the naming
595 ;; convention: org-element-TYPE-interpreter.
596 ;;
597 ;; With the exception of `headline' and `item' types, greater elements
598 ;; cannot contain other greater elements of their own type.
599 ;;
600 ;; Beside implementing a parser and an interpreter, adding a new
601 ;; greater element requires to tweak `org-element--current-element'.
602 ;; Moreover, the newly defined type must be added to both
603 ;; `org-element-all-elements' and `org-element-greater-elements'.
606 ;;;; Center Block
609 "Parse a center block.
611 LIMIT bounds the search. AFFILIATED is a list of which CAR is
612 the buffer position at the beginning of the first affiliated
613 keyword and CDR is a plist of affiliated keywords along with
614 their value.
616 Return a list whose CAR is `center-block' and CDR is a plist
617 containing `:begin', `:end', `:contents-begin', `:contents-end',
618 `:post-blank' and `:post-affiliated' keywords.
620 Assume point is at the beginning of the block."
624 ;; Incomplete block: parse it as a paragraph.
629 ;; Empty blocks have no contents.
643 :end end
644 :contents-begin contents-begin
645 :contents-end contents-end
651 "Interpret CENTER-BLOCK element as Org syntax.
652 CONTENTS is the contents of the element."
656 ;;;; Drawer
659 "Parse a drawer.
661 LIMIT bounds the search. AFFILIATED is a list of which CAR is
662 the buffer position at the beginning of the first affiliated
663 keyword and CDR is a plist of affiliated keywords along with
664 their value.
666 Return a list whose CAR is `drawer' and CDR is a plist containing
667 `:drawer-name', `:begin', `:end', `:contents-begin',
668 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
670 Assume point is at beginning of drawer."
673 ;; Incomplete drawer: parse it as a paragraph.
681 ;; Empty drawers have no contents.
694 :end end
695 :drawer-name name
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret DRAWER element as Org syntax.
704 CONTENTS is the contents of the element."
707 contents))
710 ;;;; Dynamic Block
713 "Parse a dynamic block.
715 LIMIT bounds the search. AFFILIATED is a list of which CAR is
716 the buffer position at the beginning of the first affiliated
717 keyword and CDR is a plist of affiliated keywords along with
718 their value.
720 Return a list whose CAR is `dynamic-block' and CDR is a plist
721 containing `:block-name', `:begin', `:end', `:contents-begin',
722 `:contents-end', `:arguments', `:post-blank' and
723 `:post-affiliated' keywords.
725 Assume point is at beginning of dynamic block."
729 ;; Incomplete block: parse it as a paragraph.
738 ;; Empty blocks have no contents.
751 :end end
752 :block-name name
753 :arguments arguments
754 :contents-begin contents-begin
755 :contents-end contents-end
761 "Interpret DYNAMIC-BLOCK element as Org syntax.
762 CONTENTS is the contents of the element."
767 contents))
770 ;;;; Footnote Definition
773 "Parse a footnote definition.
775 LIMIT bounds the search. AFFILIATED is a list of which CAR is
776 the buffer position at the beginning of the first affiliated
777 keyword and CDR is a plist of affiliated keywords along with
778 their value.
780 Return a list whose CAR is `footnote-definition' and CDR is
781 a plist containing `:label', `:begin' `:end', `:contents-begin',
782 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
784 Assume point is at the beginning of the footnote definition."
812 :begin begin
813 :end end
814 :contents-begin contents-begin
815 :contents-end contents-end
821 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
822 CONTENTS is the contents of the footnote-definition."
824 " "
825 contents))
828 ;;;; Headline
831 "Return node properties associated to headline at point.
832 Upcase property names. It avoids confusion between properties
833 obtained through property drawer and default properties from the
834 parser (e.g. `:end' and :END:). Return value is a plist."
846 properties))))
849 "Return time properties associated to headline at point.
850 Return value is a plist."
864 plist))))
867 "Parse a headline.
869 Return a list whose CAR is `headline' and CDR is a plist
870 containing `:raw-value', `:title', `:alt-title', `:begin',
871 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
872 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
873 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
874 `:footnote-section-p', `:post-blank' and `:post-affiliated'
875 keywords.
877 The plist also contains any property set in the property drawer,
878 with its name in upper cases and colons added at the
879 beginning (e.g., `:CUSTOM_ID').
881 LIMIT is a buffer position bounding the search.
883 When RAW-SECONDARY-P is non-nil, headline's title will not be
884 parsed as a secondary string, but as a plain string instead.
886 Assume point is at beginning of the headline."
899 raw-value)))
916 ;; Clean RAW-VALUE from any comment string.
922 ""
923 raw-value))))
924 ;; Clean TAGS from archive tag, if any.
930 :begin begin
931 :end end
932 :pre-blank
935 :contents-begin contents-begin
936 :contents-end contents-end
937 :level level
939 :tags tags
940 :todo-keyword todo
941 :todo-type todo-type
944 end)
945 :footnote-section-p footnote-section-p
946 :archivedp archivedp
947 :commentedp commentedp
949 time-props
950 standard-props))))
954 headline :alt-title
959 headline :title
965 "Interpret HEADLINE element as Org syntax.
966 CONTENTS is the contents of the element."
982 ?*)
986 " "
989 org-footnote-section
990 title))))
992 heading
993 ;; Align tags.
1001 ?\s)
1002 tags))
1006 tags))))
1008 contents)))
1011 ;;;; Inlinetask
1014 "Parse an inline task.
1016 Return a list whose CAR is `inlinetask' and CDR is a plist
1017 containing `:title', `:begin', `:end', `:contents-begin' and
1018 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1019 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1020 `:closed', `:post-blank' and `:post-affiliated' keywords.
1022 The plist also contains any property set in the property drawer,
1023 with its name in upper cases and colons added at the
1024 beginning (e.g., `:CUSTOM_ID').
1026 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1027 title will not be parsed as a secondary string, but as a plain
1028 string instead.
1030 Assume point is at beginning of the inline task."
1060 :begin begin
1061 :end end
1062 :contents-begin contents-begin
1063 :contents-end contents-end
1066 :tags tags
1067 :todo-keyword todo
1068 :todo-type todo-type
1071 time-props
1072 standard-props))))
1074 inlinetask :title
1077 raw-value
1079 inlinetask))))))
1082 "Interpret INLINETASK element as Org syntax.
1083 CONTENTS is the contents of inlinetask."
1098 ;; Align tags.
1106 ? )
1107 tags))
1111 tags))))
1112 ;; Prefer degenerate inlinetasks when there are no
1113 ;; contents.
1116 contents
1120 ;;;; Item
1123 "Parse an item.
1125 STRUCT is the structure of the plain list.
1127 Return a list whose CAR is `item' and CDR is a plist containing
1128 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1129 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1130 `:post-affiliated' keywords.
1132 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1133 any, will not be parsed as a secondary string, but as a plain
1134 string instead.
1136 Assume point is at the beginning of the item."
1160 ;; Ignore tags in un-ordered lists: they are just
1161 ;; a part of item's body.
1167 ;; If first line isn't empty, contents really start
1168 ;; at the text after item's meta-data.
1177 :begin begin
1178 :end end
1179 ;; CONTENTS-BEGIN and CONTENTS-END may be
1180 ;; mixed up in the case of an empty item
1181 ;; separated from the next by a blank line.
1182 ;; Thus ensure the former is always the
1183 ;; smallest.
1186 :checkbox checkbox
1187 :counter counter
1188 :structure struct
1192 item :tag
1200 "Interpret ITEM element as Org syntax.
1201 CONTENTS is the contents of the element."
1211 ;; Compute indentation.
1216 ;; Indent contents.
1218 bullet
1232 ;;;; Plain List
1235 ;; Return structure of list at point. Internal function. See
1236 ;; `org-list-struct' for details.
1241 items struct)
1246 ;; At limit: end all items.
1255 ;; At list end: end all items.
1260 ;; At a new item: end previous sibling.
1272 ind
1273 bullet
1276 ;; Description tag.
1280 ;; Ending position, unknown so far.
1281 nil)))
1282 items))
1284 ;; Skip empty lines.
1286 ;; Skip inline tasks and blank lines along the way.
1293 ;; At some text line. Check if it ends any previous item.
1305 ;; Skip blocks (any type) and drawers contents.
1310 limit t)))
1316 "Parse a plain list.
1318 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1319 the buffer position at the beginning of the first affiliated
1320 keyword and CDR is a plist of affiliated keywords along with
1321 their value. STRUCTURE is the structure of the plain list being
1322 parsed.
1324 Return a list whose CAR is `plain-list' and CDR is a plist
1325 containing `:type', `:begin', `:end', `:contents-begin' and
1326 `:contents-end', `:structure', `:post-blank' and
1327 `:post-affiliated' keywords.
1329 Assume point is at the beginning of the list."
1343 pos))
1347 ;; Return value.
1351 :begin begin
1352 :end end
1353 :contents-begin contents-begin
1354 :contents-end contents-end
1355 :structure struct
1361 "Interpret PLAIN-LIST element as Org syntax.
1362 CONTENTS is the contents of the element."
1370 ;;;; Property Drawer
1373 "Parse a property drawer.
1375 LIMIT bounds the search.
1377 Return a list whose car is `property-drawer' and cdr is a plist
1378 containing `:begin', `:end', `:contents-begin', `:contents-end',
1379 `:post-blank' and `:post-affiliated' keywords.
1381 Assume point is at the beginning of the property drawer."
1394 :end end
1396 :contents-end contents-end
1401 "Interpret PROPERTY-DRAWER element as Org syntax.
1402 CONTENTS is the properties within the drawer."
1406 ;;;; Quote Block
1409 "Parse a quote block.
1411 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1412 the buffer position at the beginning of the first affiliated
1413 keyword and CDR is a plist of affiliated keywords along with
1414 their value.
1416 Return a list whose CAR is `quote-block' and CDR is a plist
1417 containing `:begin', `:end', `:contents-begin', `:contents-end',
1418 `:post-blank' and `:post-affiliated' keywords.
1420 Assume point is at the beginning of the block."
1424 ;; Incomplete block: parse it as a paragraph.
1430 ;; Empty blocks have no contents.
1443 :end end
1444 :contents-begin contents-begin
1445 :contents-end contents-end
1451 "Interpret QUOTE-BLOCK element as Org syntax.
1452 CONTENTS is the contents of the element."
1456 ;;;; Section
1459 "Parse a section.
1461 LIMIT bounds the search.
1463 Return a list whose CAR is `section' and CDR is a plist
1464 containing `:begin', `:end', `:contents-begin', `contents-end',
1465 `:post-blank' and `:post-affiliated' keywords."
1467 ;; Beginning of section is the beginning of the first non-blank
1468 ;; line after previous headline.
1477 :end end
1478 :contents-begin begin
1479 :contents-end pos-before-blank
1484 "Interpret SECTION element as Org syntax.
1485 CONTENTS is the contents of the element."
1486 contents)
1489 ;;;; Special Block
1492 "Parse a special block.
1494 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1495 the buffer position at the beginning of the first affiliated
1496 keyword and CDR is a plist of affiliated keywords along with
1497 their value.
1499 Return a list whose CAR is `special-block' and CDR is a plist
1500 containing `:type', `:begin', `:end', `:contents-begin',
1501 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1503 Assume point is at the beginning of the block."
1510 limit t)))
1511 ;; Incomplete block: parse it as a paragraph.
1517 ;; Empty blocks have no contents.
1530 :begin begin
1531 :end end
1532 :contents-begin contents-begin
1533 :contents-end contents-end
1539 "Interpret SPECIAL-BLOCK element as Org syntax.
1540 CONTENTS is the contents of the element."
1545 \f
1546 ;;; Elements
1547 ;;
1548 ;; For each element, a parser and an interpreter are also defined.
1549 ;; Both follow the same naming convention used for greater elements.
1550 ;;
1551 ;; Also, as for greater elements, adding a new element type is done
1552 ;; through the following steps: implement a parser and an interpreter,
1553 ;; tweak `org-element--current-element' so that it recognizes the new
1554 ;; type and add that new type to `org-element-all-elements'.
1555 ;;
1556 ;; As a special case, when the newly defined type is a block type,
1557 ;; `org-element-block-name-alist' has to be modified accordingly.
1560 ;;;; Babel Call
1563 "Parse a babel call.
1565 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1566 the buffer position at the beginning of the first affiliated
1567 keyword and CDR is a plist of affiliated keywords along with
1568 their value.
1570 Return a list whose CAR is `babel-call' and CDR is a plist
1571 containing `:begin', `:end', `:value', `:post-blank' and
1572 `:post-affiliated' as keywords."
1586 :end end
1587 :value value
1593 "Interpret BABEL-CALL element as Org syntax.
1594 CONTENTS is nil."
1598 ;;;; Clock
1601 "Parse a clock.
1603 LIMIT bounds the search.
1605 Return a list whose CAR is `clock' and CDR is a plist containing
1606 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1607 `:post-affiliated' as keywords."
1627 :value value
1628 :duration duration
1629 :begin begin
1630 :end end
1631 :post-blank post-blank
1635 "Interpret CLOCK element as Org syntax.
1636 CONTENTS is nil."
1644 "%2s:%02s"
1648 ;;;; Comment
1651 "Parse a comment.
1653 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1654 the buffer position at the beginning of the first affiliated
1655 keyword and CDR is a plist of affiliated keywords along with
1656 their value.
1658 Return a list whose CAR is `comment' and CDR is a plist
1659 containing `:begin', `:end', `:value', `:post-blank',
1660 `:post-affiliated' keywords.
1662 Assume point is at comment beginning."
1671 ;; Get comments ending.
1674 ;; Accumulate lines without leading hash and first
1675 ;; whitespace.
1689 :end end
1690 :value value
1696 "Interpret COMMENT element as Org syntax.
1697 CONTENTS is nil."
1701 ;;;; Comment Block
1704 "Parse an export block.
1706 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1707 the buffer position at the beginning of the first affiliated
1708 keyword and CDR is a plist of affiliated keywords along with
1709 their value.
1711 Return a list whose CAR is `comment-block' and CDR is a plist
1712 containing `:begin', `:end', `:value', `:post-blank' and
1713 `:post-affiliated' keywords.
1715 Assume point is at comment block beginning."
1719 ;; Incomplete block: parse it as a paragraph.
1732 contents-begin contents-end)))
1736 :end end
1737 :value value
1743 "Interpret COMMENT-BLOCK element as Org syntax.
1744 CONTENTS is nil."
1751 ;;;; Diary Sexp
1754 "Parse a diary sexp.
1756 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1757 the buffer position at the beginning of the first affiliated
1758 keyword and CDR is a plist of affiliated keywords along with
1759 their value.
1761 Return a list whose CAR is `diary-sexp' and CDR is a plist
1762 containing `:begin', `:end', `:value', `:post-blank' and
1763 `:post-affiliated' keywords."
1775 :begin begin
1776 :end end
1782 "Interpret DIARY-SEXP as Org syntax.
1783 CONTENTS is nil."
1787 ;;;; Example Block
1790 "Parse an example block.
1792 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1793 the buffer position at the beginning of the first affiliated
1794 keyword and CDR is a plist of affiliated keywords along with
1795 their value.
1797 Return a list whose CAR is `example-block' and CDR is a plist
1798 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1799 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1800 `:value', `:post-blank' and `:post-affiliated' keywords."
1804 ;; Incomplete block: parse it as a paragraph.
1812 ;; Switches analysis
1819 ;; Should labels be retained in (or stripped from) example
1820 ;; blocks?
1825 ;; What should code-references use - labels or
1826 ;; line-numbers?
1835 ;; Standard block parsing.
1843 contents-begin contents-end))
1844 block-ind))
1853 :end end
1854 :value value
1855 :switches switches
1856 :number-lines number-lines
1857 :preserve-indent preserve-indent
1858 :retain-labels retain-labels
1859 :use-labels use-labels
1860 :label-fmt label-fmt
1866 "Interpret EXAMPLE-BLOCK element as Org syntax.
1867 CONTENTS is nil."
1875 value
1880 ;;;; Export Block
1883 "Parse an export block.
1885 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1886 the buffer position at the beginning of the first affiliated
1887 keyword and CDR is a plist of affiliated keywords along with
1888 their value.
1890 Return a list whose CAR is `export-block' and CDR is a plist
1891 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1892 `:post-affiliated' keywords.
1894 Assume point is at export-block beginning."
1901 ;; Incomplete block: parse it as a paragraph.
1914 contents-end)))
1918 :end end
1919 :type type
1920 :value value
1926 "Interpret EXPORT-BLOCK element as Org syntax.
1927 CONTENTS is nil."
1934 ;;;; Fixed-width
1937 "Parse a fixed-width section.
1939 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1940 the buffer position at the beginning of the first affiliated
1941 keyword and CDR is a plist of affiliated keywords along with
1942 their value.
1944 Return a list whose CAR is `fixed-width' and CDR is a plist
1945 containing `:begin', `:end', `:value', `:post-blank' and
1946 `:post-affiliated' keywords.
1948 Assume point is at the beginning of the fixed-width area."
1952 value
1957 ;; Accumulate text without starting colons.
1970 :end end
1971 :value value
1977 "Interpret FIXED-WIDTH element as Org syntax.
1978 CONTENTS is nil."
1986 ;;;; Horizontal Rule
1989 "Parse an horizontal rule.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1997 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1998 keywords."
2008 :end end
2014 "Interpret HORIZONTAL-RULE element as Org syntax.
2015 CONTENTS is nil."
2019 ;;;; Keyword
2022 "Parse a keyword at point.
2024 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2025 the buffer position at the beginning of the first affiliated
2026 keyword and CDR is a plist of affiliated keywords along with
2027 their value.
2029 Return a list whose CAR is `keyword' and CDR is a plist
2030 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2031 `:post-affiliated' keywords."
2033 ;; An orphaned affiliated keyword is considered as a regular
2034 ;; keyword. In this case AFFILIATED is nil, so we take care of
2035 ;; this corner case.
2048 :value value
2049 :begin begin
2050 :end end
2056 "Interpret KEYWORD element as Org syntax.
2057 CONTENTS is nil."
2063 ;;;; Latex Environment
2067 "Regexp matching the beginning of a LaTeX environment.
2068 The environment is captured by the first group.
2074 "Format string matching the ending of a LaTeX environment.
2078 "Parse a LaTeX environment.
2080 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2081 the buffer position at the beginning of the first affiliated
2082 keyword and CDR is a plist of affiliated keywords along with
2083 their value.
2085 Return a list whose CAR is `latex-environment' and CDR is a plist
2086 containing `:begin', `:end', `:value', `:post-blank' and
2087 `:post-affiliated' keywords.
2089 Assume point is at the beginning of the latex environment."
2096 limit t))
2097 ;; Incomplete latex environment: parse it as a paragraph.
2107 :end end
2108 :value value
2114 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2115 CONTENTS is nil."
2119 ;;;; Node Property
2122 "Parse a node-property at point.
2124 LIMIT bounds the search.
2126 Return a list whose CAR is `node-property' and CDR is a plist
2127 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2128 `:post-affiliated' keywords."
2138 limit))))
2141 :value value
2142 :begin begin
2143 :end end
2148 "Interpret NODE-PROPERTY element as Org syntax.
2149 CONTENTS is nil."
2155 ;;;; Paragraph
2158 "Parse a paragraph.
2160 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2161 the buffer position at the beginning of the first affiliated
2162 keyword and CDR is a plist of affiliated keywords along with
2163 their value.
2165 Return a list whose CAR is `paragraph' and CDR is a plist
2166 containing `:begin', `:end', `:contents-begin' and
2167 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2169 Assume point is at the beginning of the paragraph."
2178 limit
2179 ;; A matching `org-element-paragraph-separate' is not
2180 ;; necessarily the end of the paragraph. In
2181 ;; particular, lines starting with # or : as a first
2182 ;; non-space character are ambiguous. We have to
2183 ;; check if they are valid Org syntax (e.g., not an
2184 ;; incomplete keyword).
2188 ;; There's no ambiguity for other symbols or
2189 ;; empty lines: stop here.
2191 ;; Stop at valid fixed-width areas.
2193 ;; Stop at drawers.
2198 ;; Stop at valid comments.
2200 ;; Stop at valid dynamic blocks.
2205 ;; Stop at valid blocks.
2212 limit t)))
2213 ;; Stop at valid latex environments.
2220 limit t)))
2221 ;; Stop at valid keywords.
2223 ;; Skip everything else.
2240 :end end
2241 :contents-begin contents-begin
2242 :contents-end contents-end
2248 "Interpret PARAGRAPH element as Org syntax.
2249 CONTENTS is the contents of the element."
2250 contents)
2253 ;;;; Planning
2256 "Parse a planning.
2258 LIMIT bounds the search.
2260 Return a list whose CAR is `planning' and CDR is a plist
2261 containing `:closed', `:deadline', `:scheduled', `:begin',
2262 `:end', `:post-blank' and `:post-affiliated' keywords."
2272 closed deadline scheduled)
2284 :deadline deadline
2285 :scheduled scheduled
2286 :begin begin
2287 :end end
2288 :post-blank post-blank
2292 "Interpret PLANNING element as Org syntax.
2293 CONTENTS is nil."
2295 'identity
2312 ;;;; Src Block
2315 "Parse a src block.
2317 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2318 the buffer position at the beginning of the first affiliated
2319 keyword and CDR is a plist of affiliated keywords along with
2320 their value.
2322 Return a list whose CAR is `src-block' and CDR is a plist
2323 containing `:language', `:switches', `:parameters', `:begin',
2324 `:end', `:number-lines', `:retain-labels', `:use-labels',
2325 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2326 `:post-affiliated' keywords.
2328 Assume point is at the beginning of the block."
2331 limit t)))
2332 ;; Incomplete block: parse it as a paragraph.
2338 ;; Get language as a string.
2347 ;; Get switches.
2349 ;; Get parameters.
2351 ;; Switches analysis
2362 ;; Should labels be retained in (or stripped from)
2363 ;; src blocks?
2368 ;; What should code-references use - labels or
2369 ;; line-numbers?
2374 ;; Indentation.
2376 ;; Retrieve code.
2381 block-ind))
2385 ;; Get position after ending blank lines.
2395 :begin begin
2396 :end end
2397 :number-lines number-lines
2398 :preserve-indent preserve-indent
2399 :retain-labels retain-labels
2400 :use-labels use-labels
2401 :label-fmt label-fmt
2402 :value value
2408 "Interpret SRC-BLOCK element as Org syntax.
2409 CONTENTS is nil."
2418 val)
2432 ;;;; Table
2435 "Parse a table at point.
2437 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2438 the buffer position at the beginning of the first affiliated
2439 keyword and CDR is a plist of affiliated keywords along with
2440 their value.
2442 Return a list whose CAR is `table' and CDR is a plist containing
2443 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2444 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2445 keywords.
2447 Assume point is at the beginning of the table."
2461 acc))
2468 :end end
2469 :type type
2470 :tblfm tblfm
2471 ;; Only `org' tables have contents. `table.el' tables
2472 ;; use a `:value' property to store raw table as
2473 ;; a string.
2478 table-begin table-end))
2484 "Interpret TABLE element as Org syntax.
2485 CONTENTS is a string, if table's type is `org', or nil."
2496 ;;;; Table Row
2499 "Parse table row at point.
2501 LIMIT bounds the search.
2503 Return a list whose CAR is `table-row' and CDR is a plist
2504 containing `:begin', `:end', `:contents-begin', `:contents-end',
2505 `:type', `:post-blank' and `:post-affiliated' keywords."
2509 ;; A table rule has no contents. In that case, ensure
2510 ;; CONTENTS-BEGIN matches CONTENTS-END.
2522 :begin begin
2523 :end end
2524 :contents-begin contents-begin
2525 :contents-end contents-end
2530 "Interpret TABLE-ROW element as Org syntax.
2531 CONTENTS is the contents of the table row."
2536 ;;;; Verse Block
2539 "Parse a verse block.
2541 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2542 the buffer position at the beginning of the first affiliated
2543 keyword and CDR is a plist of affiliated keywords along with
2544 their value.
2546 Return a list whose CAR is `verse-block' and CDR is a plist
2547 containing `:begin', `:end', `:contents-begin', `:contents-end',
2548 `:post-blank' and `:post-affiliated' keywords.
2550 Assume point is at beginning of the block."
2554 ;; Incomplete block: parse it as a paragraph.
2569 :end end
2570 :contents-begin contents-begin
2571 :contents-end contents-end
2577 "Interpret VERSE-BLOCK element as Org syntax.
2578 CONTENTS is verse block contents."
2582 \f
2583 ;;; Objects
2584 ;;
2585 ;; Unlike to elements, raw text can be found between objects. Hence,
2586 ;; `org-element--object-lex' is provided to find the next object in
2587 ;; buffer.
2588 ;;
2589 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2590 ;; object types they can contain will be specified in
2591 ;; `org-element-object-restrictions'.
2592 ;;
2593 ;; Creating a new type of object requires to alter
2594 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2595 ;; new type in `org-element-all-objects', and possibly add
2596 ;; restrictions in `org-element-object-restrictions'.
2598 ;;;; Bold
2601 "Parse bold object at point, if any.
2603 When at a bold object, return a list whose car is `bold' and cdr
2604 is a plist with `:begin', `:end', `:contents-begin' and
2605 `:contents-end' and `:post-blank' keywords. Otherwise, return
2606 nil.
2608 Assume point is at the first star marker."
2620 :end end
2621 :contents-begin contents-begin
2622 :contents-end contents-end
2626 "Interpret BOLD object as Org syntax.
2627 CONTENTS is the contents of the object."
2631 ;;;; Code
2634 "Parse code object at point, if any.
2636 When at a code object, return a list whose car is `code' and cdr
2637 is a plist with `:value', `:begin', `:end' and `:post-blank'
2638 keywords. Otherwise, return nil.
2640 Assume point is at the first tilde marker."
2651 :begin begin
2652 :end end
2656 "Interpret CODE object as Org syntax.
2657 CONTENTS is nil."
2661 ;;;; Entity
2664 "Parse entity at point, if any.
2666 When at an entity, return a list whose car is `entity' and cdr
2667 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2668 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2669 `:post-blank' as keywords. Otherwise, return nil.
2671 Assume point is at the beginning of the entity."
2673 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2691 :begin begin
2692 :end end
2693 :use-brackets-p bracketsp
2697 "Interpret ENTITY object as Org syntax.
2698 CONTENTS is nil."
2704 ;;;; Export Snippet
2707 "Parse export snippet at point.
2709 When at an export snippet, return a list whose car is
2710 `export-snippet' and cdr a plist with `:begin', `:end',
2711 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2712 return nil.
2714 Assume point is at the beginning of the snippet."
2730 :value value
2731 :begin begin
2732 :end end
2736 "Interpret EXPORT-SNIPPET object as Org syntax.
2737 CONTENTS is nil."
2743 ;;;; Footnote Reference
2746 "Parse footnote reference at point, if any.
2748 When at a footnote reference, return a list whose car is
2749 `footnote-reference' and cdr a plist with `:label', `:type',
2750 `:begin', `:end', `:content-begin', `:contents-end' and
2751 `:post-blank' as keywords. Otherwise, return nil."
2775 :type type
2776 :begin begin
2777 :end end
2783 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2784 CONTENTS is its definition, when inline, or nil."
2790 ;;;; Inline Babel Call
2793 "Parse inline babel call at point, if any.
2795 When at an inline babel call, return a list whose car is
2796 `inline-babel-call' and cdr a plist with `:begin', `:end',
2797 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2799 Assume point is at the beginning of the babel call."
2811 :end end
2812 :value value
2816 "Interpret INLINE-BABEL-CALL object as Org syntax.
2817 CONTENTS is nil."
2821 ;;;; Inline Src Block
2824 "Parse inline source block at point, if any.
2826 When at an inline source block, return a list whose car is
2827 `inline-src-block' and cdr a plist with `:begin', `:end',
2828 `:language', `:value', `:parameters' and `:post-blank' as
2829 keywords. Otherwise, return nil.
2831 Assume point is at the beginning of the inline src block."
2844 :value value
2845 :parameters parameters
2846 :begin begin
2847 :end end
2851 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2852 CONTENTS is nil."
2857 language
2859 body)))
2861 ;;;; Italic
2864 "Parse italic object at point, if any.
2866 When at an italic object, return a list whose car is `italic' and
2867 cdr is a plist with `:begin', `:end', `:contents-begin' and
2868 `:contents-end' and `:post-blank' keywords. Otherwise, return
2869 nil.
2871 Assume point is at the first slash marker."
2883 :end end
2884 :contents-begin contents-begin
2885 :contents-end contents-end
2889 "Interpret ITALIC object as Org syntax.
2890 CONTENTS is the contents of the object."
2894 ;;;; Latex Fragment
2897 "Parse LaTeX fragment at point, if any.
2899 When at a LaTeX fragment, return a list whose car is
2900 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2901 and `:post-blank' as keywords. Otherwise, return nil.
2903 Assume point is at the beginning of the LaTeX fragment."
2921 ;; Macro.
2930 :begin begin
2931 :end end
2935 "Interpret LATEX-FRAGMENT object as Org syntax.
2936 CONTENTS is nil."
2939 ;;;; Line Break
2942 "Parse line break at point, if any.
2944 When at a line break, return a list whose car is `line-break',
2945 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2946 Otherwise, return nil.
2948 Assume point is at the beginning of the line break."
2957 "Interpret LINE-BREAK object as Org syntax.
2958 CONTENTS is nil."
2962 ;;;; Link
2965 "Parse link at point, if any.
2967 When at a link, return a list whose car is `link' and cdr a plist
2968 with `:type', `:path', `:raw-link', `:application',
2969 `:search-option', `:begin', `:end', `:contents-begin',
2970 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2971 nil.
2973 Assume point is at the beginning of the link."
2976 end contents-begin contents-end link-end post-blank path type
2977 raw-link link search-option application)
2979 ;; Type 1: Text targeted from a radio target.
2988 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2993 ;; RAW-LINK is the original link. Expand any
2994 ;; abbreviation in it.
2998 ;; Determine TYPE of link and set PATH accordingly.
3000 ;; File type.
3004 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3007 ;; According to RFC 3986, extra whitespace should be
3008 ;; ignored when a URI is extracted.
3011 ;; Id type: PATH is the id.
3014 ;; Code-ref type: PATH is the name of the reference.
3017 ;; Custom-id type: PATH is the name of the custom id.
3020 ;; Fuzzy type: Internal link either matches a target, an
3021 ;; headline name or nothing. PATH is the target or
3022 ;; headline's name.
3024 ;; Type 3: Plain link, e.g., http://orgmode.org
3030 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3038 ;; In any case, deduce end point after trailing white space from
3039 ;; LINK-END variable.
3043 ;; Special "file" type link processing.
3045 ;; Extract opening application and search option.
3053 ;; Normalize URI.
3057 ;; Make sure TYPE always reports "file".
3061 :path path
3063 :application application
3064 :search-option search-option
3065 :begin begin
3066 :end end
3067 :contents-begin contents-begin
3068 :contents-end contents-end
3072 "Interpret LINK object as Org syntax.
3073 CONTENTS is the contents of the object, or nil."
3078 raw-link
3082 ;;;; Macro
3085 "Parse macro at point, if any.
3087 When at a macro, return a list whose car is `macro' and cdr
3088 a plist with `:key', `:args', `:begin', `:end', `:value' and
3089 `:post-blank' as keywords. Otherwise, return nil.
3091 Assume point is at the macro."
3104 :value value
3105 :args args
3106 :begin begin
3107 :end end
3111 "Interpret MACRO object as Org syntax.
3112 CONTENTS is nil."
3116 ;;;; Radio-target
3119 "Parse radio target at point, if any.
3121 When at a radio target, return a list whose car is `radio-target'
3122 and cdr a plist with `:begin', `:end', `:contents-begin',
3123 `:contents-end', `:value' and `:post-blank' as keywords.
3124 Otherwise, return nil.
3126 Assume point is at the radio target."
3138 :end end
3139 :contents-begin contents-begin
3140 :contents-end contents-end
3141 :post-blank post-blank
3145 "Interpret TARGET object as Org syntax.
3146 CONTENTS is the contents of the object."
3150 ;;;; Statistics Cookie
3153 "Parse statistics cookie at point, if any.
3155 When at a statistics cookie, return a list whose car is
3156 `statistics-cookie', and cdr a plist with `:begin', `:end',
3157 `:value' and `:post-blank' keywords. Otherwise, return nil.
3159 Assume point is at the beginning of the statistics-cookie."
3170 :end end
3171 :value value
3175 "Interpret STATISTICS-COOKIE object as Org syntax.
3176 CONTENTS is nil."
3180 ;;;; Strike-Through
3183 "Parse strike-through object at point, if any.
3185 When at a strike-through object, return a list whose car is
3186 `strike-through' and cdr is a plist with `:begin', `:end',
3187 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3188 Otherwise, return nil.
3190 Assume point is at the first plus sign marker."
3202 :end end
3203 :contents-begin contents-begin
3204 :contents-end contents-end
3208 "Interpret STRIKE-THROUGH object as Org syntax.
3209 CONTENTS is the contents of the object."
3213 ;;;; Subscript
3216 "Parse subscript at point, if any.
3218 When at a subscript object, return a list whose car is
3219 `subscript' and cdr a plist with `:begin', `:end',
3220 `:contents-begin', `:contents-end', `:use-brackets-p' and
3221 `:post-blank' as keywords. Otherwise, return nil.
3223 Assume point is at the underscore."
3237 :end end
3238 :use-brackets-p bracketsp
3239 :contents-begin contents-begin
3240 :contents-end contents-end
3244 "Interpret SUBSCRIPT object as Org syntax.
3245 CONTENTS is the contents of the object."
3248 contents))
3251 ;;;; Superscript
3254 "Parse superscript at point, if any.
3256 When at a superscript object, return a list whose car is
3257 `superscript' and cdr a plist with `:begin', `:end',
3258 `:contents-begin', `:contents-end', `:use-brackets-p' and
3259 `:post-blank' as keywords. Otherwise, return nil.
3261 Assume point is at the caret."
3275 :end end
3276 :use-brackets-p bracketsp
3277 :contents-begin contents-begin
3278 :contents-end contents-end
3282 "Interpret SUPERSCRIPT object as Org syntax.
3283 CONTENTS is the contents of the object."
3286 contents))
3289 ;;;; Table Cell
3292 "Parse table cell at point.
3293 Return a list whose car is `table-cell' and cdr is a plist
3294 containing `:begin', `:end', `:contents-begin', `:contents-end'
3295 and `:post-blank' keywords."
3303 :end end
3304 :contents-begin contents-begin
3305 :contents-end contents-end
3309 "Interpret TABLE-CELL element as Org syntax.
3310 CONTENTS is the contents of the cell, or nil."
3314 ;;;; Target
3317 "Parse target at point, if any.
3319 When at a target, return a list whose car is `target' and cdr
3320 a plist with `:begin', `:end', `:value' and `:post-blank' as
3321 keywords. Otherwise, return nil.
3323 Assume point is at the target."
3333 :end end
3334 :value value
3338 "Interpret TARGET object as Org syntax.
3339 CONTENTS is nil."
3343 ;;;; Timestamp
3354 "Parse time stamp at point, if any.
3356 When at a time stamp, return a list whose car is `timestamp', and
3357 cdr a plist with `:type', `:raw-value', `:year-start',
3358 `:month-start', `:day-start', `:hour-start', `:minute-start',
3359 `:year-end', `:month-end', `:day-end', `:hour-end',
3360 `:minute-end', `:repeater-type', `:repeater-value',
3361 `:repeater-unit', `:warning-type', `:warning-value',
3362 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3363 Otherwise, return nil.
3365 Assume point is at the beginning of the timestamp."
3384 date-start)
3395 raw-value)
3397 :repeater-type
3403 :repeater-unit
3412 :warning-unit
3415 year-start month-start day-start hour-start minute-start year-end
3416 month-end day-end hour-end minute-end)
3417 ;; Parse date-start.
3425 ;; Compute date-end. It can be provided directly in time-stamp,
3426 ;; or extracted from time range. Otherwise, it defaults to the
3427 ;; same values as date-start.
3437 :raw-value raw-value
3438 :year-start year-start
3439 :month-start month-start
3440 :day-start day-start
3441 :hour-start hour-start
3442 :minute-start minute-start
3443 :year-end year-end
3444 :month-end month-end
3445 :day-end day-end
3446 :hour-end hour-end
3447 :minute-end minute-end
3448 :begin begin
3449 :end end
3451 repeater-props
3452 warning-props))))))
3455 "Interpret TIMESTAMP object as Org syntax.
3456 CONTENTS is nil."
3475 ;; Build an Org timestamp string from TIME. ACTIVEP is
3476 ;; non-nil when time stamp is active. If WITH-TIME-P is
3477 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3478 ;; specify a time range in the timestamp. REPEAT-STRING is
3479 ;; the repeater string, if any.
3483 org-time-stamp-formats)
3484 time)))
3490 nil nil ts)))
3495 " "
3496 s
3498 ;; Return value.
3499 ts)))
3511 build-ts-string
3530 0
3538 "--"
3551 ;;;; Underline
3554 "Parse underline object at point, if any.
3556 When at an underline object, return a list whose car is
3557 `underline' and cdr is a plist with `:begin', `:end',
3558 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3559 Otherwise, return nil.
3561 Assume point is at the first underscore marker."
3573 :end end
3574 :contents-begin contents-begin
3575 :contents-end contents-end
3579 "Interpret UNDERLINE object as Org syntax.
3580 CONTENTS is the contents of the object."
3584 ;;;; Verbatim
3587 "Parse verbatim object at point, if any.
3589 When at a verbatim object, return a list whose car is `verbatim'
3590 and cdr is a plist with `:value', `:begin', `:end' and
3591 `:post-blank' keywords. Otherwise, return nil.
3593 Assume point is at the first equal sign marker."
3604 :begin begin
3605 :end end
3609 "Interpret VERBATIM object as Org syntax.
3610 CONTENTS is nil."
3614 \f
3615 ;;; Parsing Element Starting At Point
3616 ;;
3617 ;; `org-element--current-element' is the core function of this section.
3618 ;; It returns the Lisp representation of the element starting at
3619 ;; point.
3620 ;;
3621 ;; `org-element--current-element' makes use of special modes. They
3622 ;; are activated for fixed element chaining (e.g., `plain-list' >
3623 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3624 ;; `section'). Special modes are: `first-section', `item',
3625 ;; `node-property', `section' and `table-row'.
3628 "Parse the element starting at point.
3630 Return value is a list like (TYPE PROPS) where TYPE is the type
3631 of the element and PROPS a plist of properties associated to the
3632 element.
3634 Possible types are defined in `org-element-all-elements'.
3636 LIMIT bounds the search.
3638 Optional argument GRANULARITY determines the depth of the
3639 recursion. Allowed values are `headline', `greater-element',
3640 `element', `object' or nil. When it is broader than `object' (or
3641 nil), secondary values will not be parsed, since they only
3642 contain objects.
3644 Optional argument MODE, when non-nil, can be either
3645 `first-section', `section', `planning', `item', `node-property'
3646 and `table-row'.
3648 If STRUCTURE isn't provided but MODE is set to `item', it will be
3649 computed.
3651 This function assumes point is always at the beginning of the
3652 element it has to parse."
3655 ;; Determine if parsing depth allows for secondary strings
3656 ;; parsing. It only applies to elements referenced in
3657 ;; `org-element-secondary-value-alist'.
3660 ;; Item.
3663 ;; Table Row.
3665 ;; Node Property.
3667 ;; Headline.
3670 ;; Sections (must be checked after headline).
3675 limit)))
3676 ;; Planning.
3679 ;; Property drawer.
3683 ;; When not at bol, point is at the beginning of an item or
3684 ;; a footnote definition: next item is always a paragraph.
3686 ;; Clock.
3688 ;; Inlinetask.
3691 ;; From there, elements can have affiliated keywords.
3694 ;; Jumping over affiliated keywords put point off-limits.
3695 ;; Parse them as regular keywords.
3699 ;; LaTeX Environment.
3702 ;; Drawer and Property Drawer.
3705 ;; Fixed Width
3708 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3709 ;; Keywords.
3718 org-element-block-name-alist)))
3733 ;; Footnote Definition.
3736 ;; Horizontal Rule.
3739 ;; Diary Sexp.
3742 ;; Table.
3744 ;; List.
3747 limit affiliated
3749 ;; Default element: Paragraph.
3753 ;; Most elements can have affiliated keywords. When looking for an
3754 ;; element beginning, we want to move before them, as they belong to
3755 ;; that element, and, in the meantime, collect information they give
3756 ;; into appropriate properties. Hence the following function.
3759 "Collect affiliated keywords from point down to LIMIT.
3761 Return a list whose CAR is the position at the first of them and
3762 CDR a plist of keywords and values and move point to the
3763 beginning of the first line after them.
3765 As a special case, if element doesn't start at the beginning of
3766 the line (e.g., a paragraph starting an item), CAR is current
3767 position of point and CDR is nil."
3771 ;; RESTRICT is the list of objects allowed in parsed
3772 ;; keywords value.
3774 output)
3777 ;; Apply translation to RAW-KWD. From there, KWD is
3778 ;; the official keyword.
3780 org-element-keyword-translation-alist))
3781 raw-kwd))
3782 ;; Find main value for any keyword.
3788 ;; PARSEDP is non-nil when keyword should have its
3789 ;; value parsed.
3791 ;; If KWD is a dual keyword, find its secondary
3792 ;; value. Maybe parse it.
3799 ;; Attribute a property name to KWD.
3801 ;; Now set final shape for VALUE.
3807 ;; Attributes can always appear on multiple lines.
3810 ;; Eventually store the new value in OUTPUT.
3812 ;; Move to next keyword.
3814 ;; If affiliated keywords are orphaned: move back to first one.
3815 ;; They will be parsed as a paragraph.
3817 ;; Return value.
3821 \f
3822 ;;; The Org Parser
3823 ;;
3824 ;; The two major functions here are `org-element-parse-buffer', which
3825 ;; parses Org syntax inside the current buffer, taking into account
3826 ;; region, narrowing, or even visibility if specified, and
3827 ;; `org-element-parse-secondary-string', which parses objects within
3828 ;; a given string.
3829 ;;
3830 ;; The (almost) almighty `org-element-map' allows to apply a function
3831 ;; on elements or objects matching some type, and accumulate the
3832 ;; resulting values. In an export situation, it also skips unneeded
3833 ;; parts of the parse tree.
3836 "Recursively parse the buffer and return structure.
3837 If narrowing is in effect, only parse the visible part of the
3838 buffer.
3840 Optional argument GRANULARITY determines the depth of the
3841 recursion. It can be set to the following symbols:
3843 `headline' Only parse headlines.
3844 `greater-element' Don't recurse into greater elements excepted
3845 headlines and sections. Thus, elements
3846 parsed are the top-level ones.
3847 `element' Parse everything but objects and plain text.
3848 `object' Parse the complete buffer (default).
3850 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3851 elements.
3853 An element or an objects is represented as a list with the
3854 pattern (TYPE PROPERTIES CONTENTS), where :
3856 TYPE is a symbol describing the element or object. See
3857 `org-element-all-elements' and `org-element-all-objects' for an
3858 exhaustive list of such symbols. One can retrieve it with
3859 `org-element-type' function.
3861 PROPERTIES is the list of attributes attached to the element or
3862 object, as a plist. Although most of them are specific to the
3863 element or object type, all types share `:begin', `:end',
3864 `:post-blank' and `:parent' properties, which respectively
3865 refer to buffer position where the element or object starts,
3866 ends, the number of white spaces or blank lines after it, and
3867 the element or object containing it. Properties values can be
3868 obtained by using `org-element-property' function.
3870 CONTENTS is a list of elements, objects or raw strings
3871 contained in the current element or object, when applicable.
3872 One can access them with `org-element-contents' function.
3874 The Org buffer has `org-data' as type and nil as properties.
3875 `org-element-map' function can be used to find specific elements
3876 or objects within the parse tree.
3878 This function assumes that current major mode is `org-mode'."
3884 ;; Start in `first-section' mode so text before the first
3885 ;; headline belongs to a section.
3889 "Recursively parse objects in STRING and return structure.
3891 RESTRICTION is a symbol limiting the object types that will be
3892 looked after.
3894 Optional argument PARENT, when non-nil, is the element or object
3895 containing the secondary string. It is used to set correctly
3896 `:parent' property within the string."
3909 secondary))))
3913 "Map a function on selected elements or objects.
3915 DATA is a parse tree, an element, an object, a string, or a list
3916 of such constructs. TYPES is a symbol or list of symbols of
3917 elements or objects types (see `org-element-all-elements' and
3918 `org-element-all-objects' for a complete list of types). FUN is
3919 the function called on the matching element or object. It has to
3920 accept one argument: the element or object itself.
3922 When optional argument INFO is non-nil, it should be a plist
3923 holding export options. In that case, parts of the parse tree
3924 not exportable according to that property list will be skipped.
3926 When optional argument FIRST-MATCH is non-nil, stop at the first
3927 match for which FUN doesn't return nil, and return that value.
3929 Optional argument NO-RECURSION is a symbol or a list of symbols
3930 representing elements or objects types. `org-element-map' won't
3931 enter any recursive element or object whose type belongs to that
3932 list. Though, FUN can still be applied on them.
3934 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3935 apply to matching objects within parsed affiliated keywords (see
3936 `org-element-parsed-keywords').
3938 Nil values returned from FUN do not appear in the results.
3941 Examples:
3942 ---------
3944 Assuming TREE is a variable containing an Org buffer parse tree,
3945 the following example will return a flat list of all `src-block'
3946 and `example-block' elements in it:
3948 \(org-element-map tree '(example-block src-block) #'identity)
3950 The following snippet will find the first headline with a level
3953 \(org-element-map tree 'headline
3954 \(lambda (hl)
3955 \(and (= (org-element-property :level hl) 1)
3957 \(org-element-property :begin hl)))
3958 nil t)
3960 The next example will return a flat list of all `plain-list' type
3961 elements in TREE that are not a sub-list themselves:
3963 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
3965 Eventually, this example will return a flat list of all `bold'
3966 type objects containing a `latex-snippet' type object, even
3967 looking into captions:
3969 \(org-element-map tree 'bold
3970 \(lambda (b)
3971 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
3972 nil nil nil t)"
3973 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3977 ;; Recursion depth is determined by --CATEGORY.
3984 ;; If one object is found, the function has to
3985 ;; recurse into every object.
3988 ;; If one regular element is found, the
3989 ;; function has to recurse, at least, into
3990 ;; every element it encounters.
3993 --acc
3994 --walk-tree
3997 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3998 ;; holding contextual information.
4002 ;; Ignored element in an export context.
4004 ;; List of elements or objects.
4006 ;; Unconditionally enter parse trees.
4010 ;; Check if TYPE is matching among TYPES. If so,
4011 ;; apply FUN to --DATA and accumulate return value
4012 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4018 ;; If --DATA has a secondary string that can contain
4019 ;; objects with their type among TYPES, look into it.
4026 ;; If --DATA has any parsed affiliated keywords and
4027 ;; WITH-AFFILIATED is non-nil, look for objects in
4028 ;; them.
4035 ;; Pay attention to the type of parsed keyword.
4036 ;; In particular, preserve order for multiple
4037 ;; keywords.
4050 ;; Determine if a recursion into --DATA is possible.
4052 ;; --TYPE is explicitly removed from recursion.
4054 ;; --DATA has no contents.
4056 ;; Looking for greater elements but --DATA is simply
4057 ;; an element or an object.
4060 ;; Looking for elements but --DATA is an object.
4063 ;; In any other case, map contents.
4067 ;; Return value in a proper order.
4071 ;; The following functions are internal parts of the parser.
4072 ;;
4073 ;; The first one, `org-element--parse-elements' acts at the element's
4074 ;; level.
4075 ;;
4076 ;; The second one, `org-element--parse-objects' applies on all objects
4077 ;; of a paragraph or a secondary string. It calls
4078 ;; `org-element--object-lex' to find the next object in the current
4079 ;; container.
4082 "Return next special mode according to TYPE, or nil.
4083 TYPE is a symbol representing the type of an element or object
4084 containing next element if PARENTP is non-nil, or before it
4085 otherwise. Modes can be either `first-section', `item',
4086 `node-property', `planning', `property-drawer', `section',
4087 `table-row' or nil."
4103 "Parse elements between BEG and END positions.
4105 MODE prioritizes some elements over the others. It can be set to
4106 `first-section', `section', `planning', `item', `node-property'
4107 or `table-row'.
4109 When value is `item', STRUCTURE will be used as the current list
4110 structure.
4112 GRANULARITY determines the depth of the recursion. See
4113 `org-element-parse-buffer' for more information.
4115 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4116 elements.
4118 Elements are accumulated into ACC."
4121 ;; Visible only: skip invisible parts at the beginning of the
4122 ;; element.
4125 ;; When parsing only headlines, skip any text before first one.
4128 ;; Main loop start.
4130 ;; Find current element's type and parse it accordingly to
4131 ;; its category.
4133 end granularity mode structure))
4137 ;; Visible only: skip invisible parts between siblings.
4140 ;; Fill ELEMENT contents by side-effect.
4142 ;; If element has no contents, don't modify it.
4144 ;; Greater element: parse it between `contents-begin' and
4145 ;; `contents-end'. Make sure GRANULARITY allows the
4146 ;; recursion, or ELEMENT is a headline, in which case going
4147 ;; inside is mandatory, in order to get sub-level headings.
4155 ;; Possibly switch to a special mode.
4159 granularity visible-only element))
4160 ;; ELEMENT has contents. Parse objects inside, if
4161 ;; GRANULARITY allows it.
4167 ;; Update mode.
4169 ;; Return result.
4170 acc))
4173 "Return next object in current buffer or nil.
4174 RESTRICTION is a list of object types, as symbols, that should be
4175 looked after. This function assumes that the buffer is narrowed
4176 to an appropriate container (e.g., a paragraph)."
4184 found)
4249 ;; This is probably a plain link.
4255 ;; Radio link.
4260 "Parse objects between BEG and END and return recursive structure.
4262 Objects are accumulated in ACC.
4264 RESTRICTION is a list of object successors which are allowed in
4265 the current object."
4273 ;; 1. Text before any object. Untabify it.
4278 acc
4282 ;; 2. Object...
4285 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4286 ;; a recursive type.
4294 ;; 3. Text after last object. Untabify it.
4298 acc
4302 ;; Result.
4303 acc)))
4306 \f
4307 ;;; Towards A Bijective Process
4308 ;;
4309 ;; The parse tree obtained with `org-element-parse-buffer' is really
4310 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4311 ;; interpreted and expanded into a string with canonical Org syntax.
4312 ;; Hence `org-element-interpret-data'.
4313 ;;
4314 ;; The function relies internally on
4315 ;; `org-element--interpret-affiliated-keywords'.
4317 ;;;###autoload
4319 "Interpret DATA as Org syntax.
4321 DATA is a parse tree, an element, an object or a secondary string
4322 to interpret.
4324 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4325 new types that should be treated as objects. An unknown type not
4326 belonging to this list is seen as a pseudo-element instead. Both
4327 pseudo-objects and pseudo-elements are transparent entities, i.e.
4328 only their contents are interpreted.
4330 Return Org syntax as a string."
4334 "Interpret DATA as Org syntax.
4336 DATA is a parse tree, an element, an object or a secondary string
4337 to interpret. PARENT is used for recursive calls. It contains
4338 the element or object containing data, or nil. PSEUDO-OBJECTS
4339 are list of symbols defining new element or object types.
4340 Unknown types that don't belong to this list are treated as
4341 pseudo-elements instead.
4343 Return Org syntax as a string."
4345 ;; Find interpreter for current object or element. If it
4346 ;; doesn't exist (e.g. this is a pseudo object or element),
4347 ;; return contents, if any.
4353 ;; Secondary string.
4359 ;; Full Org document.
4365 ;; Plain text: return it.
4367 ;; Element or object without contents.
4369 ;; Element or object with contents.
4372 ;; Recursively interpret contents.
4378 data
4379 ;; Fix indentation of elements containing
4380 ;; objects. We ignore `table-row' elements
4381 ;; as they are one line long anyway.
4383 data
4384 ;; When normalizing first paragraph of an
4385 ;; item or a footnote-definition, ignore
4386 ;; first line's indentation.
4393 ;; Build white spaces. If no `:post-blank' property is
4394 ;; specified, assume its value is 0.
4405 "Return ELEMENT's affiliated keywords as Org syntax.
4406 If there is no affiliated keyword, return the empty string."
4416 ": "
4419 value)
4427 ;; All attribute keywords can have multiple lines.
4433 ;; List all ELEMENT's properties matching an attribute line or an
4434 ;; affiliated keyword, but ignore translated keywords since they
4435 ;; cannot belong to the property list.
4442 org-element-keyword-translation-alist)))))
4443 collect prop)
4446 ;; Because interpretation of the parse tree must return the same
4447 ;; number of blank lines between elements and the same number of white
4448 ;; space after objects, some special care must be given to white
4449 ;; spaces.
4450 ;;
4451 ;; The first function, `org-element-normalize-string', ensures any
4452 ;; string different from the empty string will end with a single
4453 ;; newline character.
4454 ;;
4455 ;; The second function, `org-element-normalize-contents', removes
4456 ;; global indentation from the contents of the current element.
4459 "Ensure string S ends with a single newline character.
4461 If S isn't a string return it unchanged. If S is the empty
4462 string, return it. Otherwise, return a new string with a single
4463 newline character at its end."
4471 "Normalize plain text in ELEMENT's contents.
4473 ELEMENT must only contain plain text and objects.
4475 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4476 indentation to compute maximal common indentation.
4478 Return the normalized element that is element with global
4479 indentation removed from its contents. The function assumes that
4480 indentation is not done with TAB characters."
4482 find-min-ind ; For byte-compiler.
4484 ;; Return minimal common indentation within BLOB. This is
4485 ;; done by walking recursively BLOB and updating MIN-IND
4486 ;; along the way. FIRST-FLAG is non-nil when the first
4487 ;; string hasn't been seen yet. It is required as this
4488 ;; string is the only one whose indentation doesn't happen
4489 ;; after a newline character.
4496 ;; An indentation of zero means no string will be
4497 ;; modified. Quit the process.
4507 ;; Find minimal indentation in ELEMENT.
4510 ;; Build ELEMENT back, replacing each string with the same
4511 ;; string minus common indentation.
4516 ;; Return BLOB with all its strings indentation
4517 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4518 ;; is non-nil when the first string hasn't been seen
4519 ;; yet.
4534 org-element-recursive-objects)
4538 blob))))
4542 \f
4543 ;;; Cache
4544 ;;
4545 ;; Implement a caching mechanism for `org-element-at-point' and
4546 ;; `org-element-context', which see.
4547 ;;
4548 ;; A single public function is provided: `org-element-cache-reset'.
4549 ;;
4550 ;; Cache is enabled by default, but can be disabled globally with
4551 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4552 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4553 ;; can be tweaked to control caching behaviour.
4554 ;;
4555 ;; Internally, parsed elements are stored in an AVL tree,
4556 ;; `org-element--cache'. This tree is updated lazily: whenever
4557 ;; a change happens to the buffer, a synchronization request is
4558 ;; registered in `org-element--cache-sync-requests' (see
4559 ;; `org-element--cache-submit-request'). During idle time, requests
4560 ;; are processed by `org-element--cache-sync'. Synchronization also
4561 ;; happens when an element is required from the cache. In this case,
4562 ;; the process stops as soon as the needed element is up-to-date.
4563 ;;
4564 ;; A synchronization request can only apply on a synchronized part of
4565 ;; the cache. Therefore, the cache is updated at least to the
4566 ;; location where the new request applies. Thus, requests are ordered
4567 ;; from left to right and all elements starting before the first
4568 ;; request are correct. This property is used by functions like
4569 ;; `org-element--cache-find' to retrieve elements in the part of the
4570 ;; cache that can be trusted.
4571 ;;
4572 ;; A request applies to every element, starting from its original
4573 ;; location (or key, see below). When a request is processed, it
4574 ;; moves forward and may collide the next one. In this case, both
4575 ;; requests are merged into a new one that starts from that element.
4576 ;; As a consequence, the whole synchronization complexity does not
4577 ;; depend on the number of pending requests, but on the number of
4578 ;; elements the very first request will be applied on.
4579 ;;
4580 ;; Elements cannot be accessed through their beginning position, which
4581 ;; may or may not be up-to-date. Instead, each element in the tree is
4582 ;; associated to a key, obtained with `org-element--cache-key'. This
4583 ;; mechanism is robust enough to preserve total order among elements
4584 ;; even when the tree is only partially synchronized.
4585 ;;
4586 ;; Objects contained in an element are stored in a hash table,
4587 ;; `org-element--cache-objects'.
4591 "Non nil when Org parser should cache its results.
4598 "Maximum duration, as a time value, for a cache synchronization.
4599 If the synchronization is not over after this delay, the process
4600 pauses and resumes after `org-element-cache-sync-break'
4604 "Duration, as a time value, of the pause between synchronizations.
4608 ;;;; Data Structure
4611 "AVL tree used to cache elements.
4612 Each node of the tree contains an element. Comparison is done
4613 with `org-element--cache-compare'. This cache is used in
4617 "Hash table used as to cache objects.
4618 Key is an element, as returned by `org-element-at-point', and
4619 value is an alist where each association is:
4621 \(PARENT COMPLETEP . OBJECTS)
4623 where PARENT is an element or object, COMPLETEP is a boolean,
4624 non-nil when all direct children of parent are already cached and
4625 OBJECTS is a list of such children, as objects, from farthest to
4626 closest.
4629 contained within a paragraph
4633 If the paragraph is completely parsed, OBJECTS-DATA will be
4635 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4636 \(BOLD-OBJECT t ENTITY-OBJECT))
4638 whereas in a partially parsed paragraph, it could be
4640 \((PARAGRAPH nil ENTITY-OBJECT))
4645 "List of pending synchronization requests.
4647 A request is a vector with the following pattern:
4649 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4651 Processing a synchronization request consists of three phases:
4653 0. Delete modified elements,
4654 1. Fill missing area in cache,
4655 2. Shift positions and re-parent elements after the changes.
4657 During phase 0, NEXT is the key of the first element to be
4658 removed, BEG and END is buffer position delimiting the
4659 modifications. Elements starting between them (inclusive) are
4660 removed and so are those contained within OUTREACH. PARENT, when
4661 non-nil, is the parent of the first element to be removed.
4663 During phase 1, NEXT is the key of the next known element in
4664 cache and BEG its beginning position. Parse buffer between that
4665 element and the one before it in order to determine the parent of
4666 the next element. Set PARENT to the element containing NEXT.
4668 During phase 2, NEXT is the key of the next element to shift in
4669 the parse tree. All elements starting from this one have their
4670 properties relatives to buffer positions shifted by integer
4671 OFFSET and, if they belong to element PARENT, are adopted by it.
4679 "Hash table used to store keys during synchronization.
4683 "Return a unique key for ELEMENT in cache tree.
4685 Keys are used to keep a total order among elements in the cache.
4686 Comparison is done with `org-element--cache-key-less-p'.
4688 When no synchronization is taking place, a key is simply the
4689 beginning position of the element, or that position plus one in
4690 the case of an first item (respectively row) in
4691 a list (respectively a table).
4693 During a synchronization, the key is the one the element had when
4694 the cache was synchronized for the last time. Elements added to
4695 cache during the synchronization get a new key generated with
4696 `org-element--cache-generate-key'.
4698 Such keys are stored in `org-element--cache-sync-keys'. The hash
4699 table is cleared once the synchronization is complete."
4702 ;; Increase beginning position of items (respectively
4703 ;; table rows) by one, so the first item can get
4704 ;; a different key from its parent list (respectively
4705 ;; table).
4708 begin)))
4711 key))))
4714 "Generate a key between LOWER and UPPER.
4716 LOWER and UPPER are integers or lists, possibly empty.
4718 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4719 a unique key, as an integer or a list of integers, according to
4720 the following rules:
4722 - LOWER and UPPER are compared level-wise until values differ.
4724 - If, at a given level, LOWER and UPPER differ from more than
4725 2, the new key shares all the levels above with LOWER and
4726 gets a new level. Its value is the mean between LOWER and
4727 UPPER:
4729 \(1 2) + (1 4) --> (1 3)
4731 - If LOWER has no value to compare with, it is assumed that its
4732 value is `most-negative-fixnum'. E.g.,
4734 \(1 1) + (1 1 2)
4736 is equivalent to
4738 \(1 1 m) + (1 1 2)
4740 where m is `most-negative-fixnum'. Likewise, if UPPER is
4741 short of levels, the current value is `most-positive-fixnum'.
4743 - If they differ from only one, the new key inherits from
4744 current LOWER level and fork it at the next level. E.g.,
4746 \(2 1) + (3 3)
4748 is equivalent to
4750 \(2 1) + (2 M)
4752 where M is `most-positive-fixnum'.
4754 - If the key is only one level long, it is returned as an
4755 integer:
4757 \(1 2) + (3 2) --> 2
4759 When they are not equals, the function assumes that LOWER is
4760 lesser than UPPER, per `org-element--cache-key-less-p'."
4764 skip-upper key)
4775 ;; When at a given level, LOWER and UPPER differ from
4776 ;; 1, ignore UPPER altogether. Instead create a key
4777 ;; between LOWER and the greatest key with the same
4778 ;; prefix as LOWER so far.
4784 "Non-nil if key A is less than key B.
4785 A and B are either integers or lists of integers, as returned by
4786 `org-element--cache-key'."
4794 ;; If A is empty, either keys are equal (B is also empty) and
4795 ;; we return nil, or A is lesser than B (B is longer) and we
4796 ;; return a non-nil value.
4797 ;;
4798 ;; If A is not empty, B is necessarily empty and A is greater
4799 ;; than B (A is longer). Therefore, return nil.
4803 "Non-nil when element A is located before element B."
4808 "Return root value in cache.
4809 This function assumes `org-element--cache' is a valid AVL tree."
4813 ;;;; Tools
4816 "Non-nil when cache is active in current buffer."
4821 "Find element in cache starting at POS or before.
4823 POS refers to a buffer position.
4825 When optional argument SIDE is non-nil, the function checks for
4826 elements starting at or past POS instead. If SIDE is `both', the
4827 function returns a cons cell where car is the first element
4828 starting at or before POS and cdr the first element starting
4829 after POS.
4831 The function can only find elements in the synchronized part of
4832 the cache."
4836 lower upper)
4851 ;; We found an element in cache starting at POS. If `side'
4852 ;; is `both' we also want the next one in order to generate
4853 ;; a key in-between.
4854 ;;
4855 ;; If the element is the first row or item in a table or
4856 ;; a plain list, we always return the table or the plain
4857 ;; list.
4858 ;;
4859 ;; In any other case, we return the element found.
4868 lower parent
4869 upper parent)))))
4872 lower element
4873 upper element)))))
4880 "Store ELEMENT in current buffer's cache, if allowed.
4881 When optional argument DATA is non-nil, assume is it object data
4882 relative to ELEMENT and store it in the objects cache."
4886 ;; During synchronization, first build an appropriate key
4887 ;; for the new element so `avl-tree-enter' can insert it at
4888 ;; the right spot in the cache.
4897 org-element--cache-sync-keys)))
4899 ;; Headlines are not stored in cache, so objects in titles are
4900 ;; not stored either.
4905 "Remove ELEMENT from cache.
4906 Assume ELEMENT belongs to cache and that a cache is active."
4911 ;;;; Synchronization
4914 "Set idle timer for cache synchronization in BUFFER."
4921 org-element-cache-sync-idle-time))
4922 nil
4923 #'org-element--cache-sync
4924 buffer)))
4927 "Non-nil when synchronization process should be interrupted.
4928 TIME-LIMIT is a time value or nil."
4934 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4936 Properties containing buffer positions are `:begin', `:end',
4937 `:contents-begin', `:contents-end' and `:structure'. When
4938 optional argument PROPS is a list of keywords, only shift
4939 properties provided in that list.
4941 Properties are modified by side-effect."
4943 ;; Shift `:structure' property for the first plain list only: it
4944 ;; is the only one that really matters and it prevents from
4945 ;; shifting it more than once.
4959 "Synchronize cache with recent modification in BUFFER.
4961 When optional argument THRESHOLD is non-nil, do the
4962 synchronization for all elements starting before or at threshold,
4963 then exit. Otherwise, synchronize cache for as long as
4964 `org-element-cache-sync-duration' or until Emacs leaves idle
4965 state.
4967 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4968 not registered yet in the cache are going to happen. It is used
4969 in `org-element--cache-submit-request', where cache is partially
4970 updated before current modification are actually submitted."
4981 request
4983 threshold
4986 org-element-cache-sync-duration))
4987 future-change)
4988 ;; Request processed. Merge current and next offsets and
4989 ;; transfer ending position.
4995 ;; If more requests are awaiting, set idle timer accordingly.
4996 ;; Otherwise, reset keys.
5003 "Process synchronization REQUEST for all entries before NEXT.
5005 REQUEST is a vector, built by `org-element--cache-submit-request'.
5007 NEXT is a cache key, as returned by `org-element--cache-key'.
5009 When non-nil, THRESHOLD is a buffer position. Synchronization
5010 stops as soon as a shifted element begins after it.
5012 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5013 after this time or when Emacs exits idle state.
5015 When non-nil, FUTURE-CHANGE is a buffer position where changes
5016 not registered yet in the cache are going to happen. See
5017 `org-element--cache-submit-request' for more information.
5019 Throw `interrupt' if the process stops before completing the
5020 request."
5023 ;; Phase 0.
5024 ;;
5025 ;; Delete all elements starting after BEG, but not after buffer
5026 ;; position END or past element with key NEXT.
5027 ;;
5028 ;; At each iteration, we start again at tree root since
5029 ;; a deletion modifies structure of the balanced tree.
5037 ;; Find first element in cache with key BEG or after it.
5047 data-key key
5050 data-key key
5051 node nil)))))
5060 up))
5066 ;; No element starting after modifications left in
5067 ;; cache: further processing is futile.
5070 ;; Phase 1.
5071 ;;
5072 ;; Phase 0 left a hole in the cache. Some elements after it
5073 ;; could have parents within. For example, in the following
5074 ;; buffer:
5075 ;;
5076 ;; - item
5077 ;;
5078 ;;
5079 ;; Paragraph1
5080 ;;
5081 ;; Paragraph2
5082 ;;
5083 ;; if we remove a blank line between "item" and "Paragraph1",
5084 ;; everything down to "Paragraph2" is removed from cache. But
5085 ;; the paragraph now belongs to the list, and its `:parent'
5086 ;; property no longer is accurate.
5087 ;;
5088 ;; Therefore we need to parse again elements in the hole, or at
5089 ;; least in its last section, so that we can re-parent
5090 ;; subsequent elements, during phase 2.
5091 ;;
5092 ;; Note that we only need to get the parent from the first
5093 ;; element in cache after the hole.
5094 ;;
5095 ;; When next key is lesser or equal to the current one, delegate
5096 ;; phase 1 processing to next request in order to preserve key
5097 ;; order among requests.
5105 ;; Next element will start at its beginning position plus
5106 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5107 ;; contains the real beginning position of the first element to
5108 ;; shift and re-parent.
5112 ;; Changes are going to happen around this element and
5113 ;; they will trigger another phase 1 request. Skip the
5114 ;; current one.
5120 ;; Phase 2.
5121 ;;
5122 ;; Shift all elements starting from key START, but before NEXT, by
5123 ;; OFFSET, and re-parent them when appropriate.
5124 ;;
5125 ;; Elements are modified by side-effect so the tree structure
5126 ;; remains intact.
5127 ;;
5128 ;; Once THRESHOLD, if any, is reached, or once there is an input
5129 ;; pending, exit. Before leaving, the current synchronization
5130 ;; request is updated.
5137 exit-flag)
5138 ;; No re-parenting nor shifting planned: request is over.
5148 ;; We reached NEXT. Request is complete.
5150 ;; Handle interruption request. Update current request.
5155 ;; Shift element.
5158 ;; Shift associated objects data, if any.
5163 ;; Update PARENT and re-parent DATA, only when
5164 ;; necessary. Propagate new structures for lists.
5178 ;; Cache is up-to-date past THRESHOLD. Request
5179 ;; interruption.
5184 ;; We reached end of tree: synchronization complete.
5185 t)))
5188 "Parse elements in current section, down to POS.
5190 Start parsing from the closest between the last known element in
5191 cache or headline above. Return the smallest element containing
5192 POS.
5194 When optional argument SYNCP is non-nil, return the parent of the
5195 element containing POS instead. In that case, it is also
5196 possible to provide TIME-LIMIT, which is a time value specifying
5197 when the parsing should stop. The function throws `interrupt' if
5198 the process stopped before finding the expected result."
5205 element next mode)
5207 ;; Nothing in cache before point: start parsing from first
5208 ;; element following headline above, or first element in
5209 ;; buffer.
5216 ;; Cache returned exact match: return it.
5219 ;; There's a headline between cached value and POS: cached
5220 ;; value is invalid. Start parsing from first element
5221 ;; following the headline.
5228 ;; Check if CACHED or any of its ancestors contain point.
5229 ;;
5230 ;; If there is such an element, we inspect it in order to know
5231 ;; if we return it or if we need to parse its contents.
5232 ;; Otherwise, we just start parsing from current location,
5233 ;; which is right after the top-most element containing
5234 ;; CACHED.
5235 ;;
5236 ;; As a special case, if POS is at the end of the buffer, we
5237 ;; want to return the innermost element ending there.
5238 ;;
5239 ;; Also, if we find an ancestor and discover that we need to
5240 ;; parse its contents, make sure we don't start from
5241 ;; `:contents-begin', as we would otherwise go past CACHED
5242 ;; again. Instead, in that situation, we will resume parsing
5243 ;; from NEXT, which is located after CACHED or its higher
5244 ;; ancestor not containing point.
5256 ;; Parse successively each element until we reach POS.
5269 end 'element mode
5276 ;; Skip any element ending before point. Also skip
5277 ;; element ending at point (unless it is also the end of
5278 ;; buffer) since we're sure that another element begins
5279 ;; after it.
5283 ;; A non-greater element contains point: return it.
5286 ;; Otherwise, we have to decide if ELEMENT really
5287 ;; contains POS. In that case we start parsing from
5288 ;; contents' beginning.
5289 ;;
5290 ;; If POS is at contents' beginning but it is also at
5291 ;; the beginning of the first item in a list or a table.
5292 ;; In that case, we need to create an anchor for that
5293 ;; list or table, so return it.
5294 ;;
5295 ;; Also, if POS is at the end of the buffer, no element
5296 ;; can start after it, but more than one may end there.
5297 ;; Arbitrarily, we choose to return the innermost of
5298 ;; such elements.
5311 parent element
5312 end cend))))
5313 ;; Otherwise, return ELEMENT as it is the smallest
5314 ;; element containing POS.
5319 ;;;; Staging Buffer Changes
5325 ;; Blocks
5327 ;; LaTeX environments.
5329 ;; Drawers.
5332 "Regexp matching a sensitive line, structure wise.
5333 A sensitive line is a headline, inlinetask, block, drawer, or
5334 latex-environment boundary. When such a line is modified,
5335 structure changes in the document may propagate in the whole
5339 "Non-nil when a sensitive line is about to be changed.
5343 "Request extension of area going to be modified if needed.
5344 BEG and END are the beginning and end of the range of changed
5345 text. See `before-change-functions' for more information."
5355 'headline
5358 org-element--cache-sensitive-re bottom t)))))))))
5361 "Update buffer modifications for current buffer.
5362 BEG and END are the beginning and end of the range of changed
5363 text, and the length in bytes of the pre-change text replaced by
5364 that range. See `after-change-functions' for more information."
5372 ;; Determine if modified area needs to be extended, according
5373 ;; to both previous and current state. We make a special
5374 ;; case for headline editing: if a headline is modified but
5375 ;; not removed, do not extend.
5384 org-element--cache-sensitive-re bottom t))))
5385 ;; Effectively extend modified area.
5393 ;; Store synchronization request.
5396 ;; Activate a timer to process the request during idle time.
5400 "Return first element to remove from cache.
5402 BEG and END are buffer positions delimiting buffer modifications.
5403 OFFSET is the size of the changes.
5405 Returned element is usually the first element in cache containing
5406 any position between BEG and END. As an exception, greater
5407 elements around the changes that are robust to contents
5408 modifications are preserved and updated according to the
5409 changes."
5419 quote-block special-block))
5424 ;; UP is a robust greater element containing changes.
5425 ;; We only need to extend its ending boundaries.
5431 ;; We're at top level element containing ELEMENT: if it's
5432 ;; altered by buffer modifications, it is first element in
5433 ;; cache to be removed. Otherwise, that first element is the
5434 ;; following one.
5435 ;;
5436 ;; As a special case, do not remove BEFORE if it is a robust
5437 ;; container for current changes.
5439 before)))))
5442 "Submit a new cache synchronization request for current buffer.
5443 BEG and END are buffer positions delimiting the minimal area
5444 where cache data should be removed. OFFSET is the size of the
5445 change, as an integer."
5447 delete-to delete-from)
5452 ;; Current changes can be merged with first sync request: we
5453 ;; can save a partial cache synchronization.
5456 ;; If last change happened within area to be removed, extend
5457 ;; boundaries of robust parents, if any. Otherwise, find
5458 ;; first element to remove and update request accordingly.
5470 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5471 ;; if any, is no longer a 0-phase request, thus ensuring that
5472 ;; phases are properly ordered. We need to provide OFFSET as
5473 ;; optional parameter since current modifications are not known
5474 ;; yet to the otherwise correct part of the cache (i.e, before
5475 ;; the first request).
5482 ;; When changes happen before the first known
5483 ;; element, re-parent and shift the rest of the
5484 ;; cache.
5486 ;; Otherwise, we find the first non robust
5487 ;; element containing END. All elements between
5488 ;; FIRST and this one are to be removed.
5489 ;;
5490 ;; Among them, some could be located outside the
5491 ;; synchronized part of the cache, in which case
5492 ;; comparing buffer positions to find them is
5493 ;; useless. Instead, we store the element
5494 ;; containing them in the request itself. All
5495 ;; its children will be removed.
5507 element up))
5510 org-element--cache-sync-requests)
5511 ;; No element to remove. No need to re-parent either.
5512 ;; Simply shift additional elements, if any, by OFFSET.
5517 ;;;; Public Functions
5519 ;;;###autoload
5521 "Reset cache in current buffer.
5522 When optional argument ALL is non-nil, reset cache in all Org
5523 buffers."
5541 ;;;###autoload
5543 "Refresh cache at position POS."
5550 \f
5551 ;;; The Toolbox
5552 ;;
5553 ;; The first move is to implement a way to obtain the smallest element
5554 ;; containing point. This is the job of `org-element-at-point'. It
5555 ;; basically jumps back to the beginning of section containing point
5556 ;; and proceed, one element after the other, with
5557 ;; `org-element--current-element' until the container is found. Note:
5558 ;; When using `org-element-at-point', secondary values are never
5559 ;; parsed since the function focuses on elements, not on objects.
5560 ;;
5561 ;; At a deeper level, `org-element-context' lists all elements and
5562 ;; objects containing point.
5563 ;;
5564 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5565 ;; internally by navigation and manipulation tools.
5568 ;;;###autoload
5570 "Determine closest element around point.
5572 Return value is a list like (TYPE PROPS) where TYPE is the type
5573 of the element and PROPS a plist of properties associated to the
5574 element.
5576 Possible types are defined in `org-element-all-elements'.
5577 Properties depend on element or object type, but always include
5578 `:begin', `:end', `:parent' and `:post-blank' properties.
5580 As a special case, if point is at the very beginning of the first
5581 item in a list or sub-list, returned element will be that list
5582 instead of the item. Likewise, if point is at the beginning of
5583 the first row of a table, returned element will be the table
5584 instead of the first row.
5586 When point is at the end of the buffer, return the innermost
5587 element ending there."
5593 ;; Within blank lines at the beginning of buffer, return nil.
5595 ;; Within blank lines right after a headline, return that
5596 ;; headline.
5600 ;; Otherwise parse until we find element containing ORIGIN.
5607 ;;;###autoload
5609 "Return smallest element or object around point.
5611 Return value is a list like (TYPE PROPS) where TYPE is the type
5612 of the element or object and PROPS a plist of properties
5613 associated to it.
5615 Possible types are defined in `org-element-all-elements' and
5616 `org-element-all-objects'. Properties depend on element or
5617 object type, but always include `:begin', `:end', `:parent' and
5618 `:post-blank'.
5620 As a special case, if point is right after an object and not at
5621 the beginning of any other object, return that object.
5623 Optional argument ELEMENT, when non-nil, is the closest element
5624 containing point, as returned by `org-element-at-point'.
5625 Providing it allows for quicker computation."
5631 ;; If point is inside an element containing objects or
5632 ;; a secondary string, narrow buffer to the container and
5633 ;; proceed with parsing. Otherwise, return ELEMENT.
5635 ;; At a parsed affiliated keyword, check if we're inside main
5636 ;; or dual value.
5643 org-element-parsed-keywords))
5652 ;; Also change type to retrieve correct restrictions.
5654 ;; At an item, objects can only be located within tag, if any.
5664 ;; At an headline or inlinetask, objects are in title.
5671 ;; At a paragraph, a table-row or a verse block, objects are
5672 ;; located within their contents.
5676 ;; CBEG is nil for table rules.
5681 ;; At a parsed keyword, objects are located within value.
5684 org-element-document-properties))
5691 ;; At a planning line, if point is at a timestamp, return it,
5692 ;; otherwise, return element.
5700 ;; All other locations cannot contain objects: bail out.
5710 next object-data last)
5714 ;; When entering PARENT for the first time, get list
5715 ;; of objects within known so far. Store it in
5716 ;; OBJECT-DATA.
5721 ;; Find NEXT object for analysis.
5723 ;; If NEXT is non-nil, we already exhausted the
5724 ;; cache so we can parse buffer to find the object
5725 ;; after it.
5727 ;; Otherwise, check if cache can help us.
5738 ;; Cache contains the information needed.
5741 pos)
5743 pos)
5749 ;; If we have a new object to analyze, store it in
5750 ;; cache. Otherwise record that there is nothing
5751 ;; more to parse in this element at this depth.
5756 ;; Process NEXT, if any, in order to know if we need
5757 ;; to skip it, return it or move into it.
5764 ;; Skip objects ending before point. Also skip
5765 ;; objects ending at point unless it is also the
5766 ;; end of buffer, since we want to return the
5767 ;; innermost object.
5770 ;; For convenience, when object ends at POS,
5771 ;; without any space, store it in LAST, as we
5772 ;; will return it if no object starts here.
5776 ;; If POS is within a container object, move
5777 ;; into that object.
5781 ;; At contents' end, if there is no
5782 ;; space before point, also move into
5783 ;; object, for consistency with
5784 ;; convenience feature above.
5793 next nil
5794 object-data nil))
5795 ;; Otherwise, return NEXT.
5797 ;; Store results in cache, if applicable.
5801 "List all ancestors of a given element or object.
5803 BLOB is an object or element.
5805 When optional argument TYPES is a list of symbols, return the
5806 first element or object in the lineage whose type belongs to that
5807 list.
5809 When optional argument WITH-SELF is non-nil, lineage includes
5810 BLOB itself as the first element, and TYPES, if provided, also
5811 apply to it.
5813 When BLOB is obtained through `org-element-context' or
5814 `org-element-at-point', only ancestors from its section can be
5815 found. There is no such limitation when BLOB belongs to a full
5816 parse tree."
5818 ancestors)
5825 "Non-nil when elements ELEM-A and ELEM-B are nested."
5834 "Swap elements ELEM-A and ELEM-B.
5835 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5836 end of ELEM-A."
5838 ;; There are two special cases when an element doesn't start at bol:
5839 ;; the first paragraph in an item or in a footnote definition.
5841 ;; Only a paragraph without any affiliated keyword can be moved at
5842 ;; ELEM-A position in such a situation. Note that the case of
5843 ;; a footnote definition is impossible: it cannot contain two
5844 ;; paragraphs in a row because it cannot contain a blank line.
5850 ;; In a special situation, ELEM-A will have no indentation. We'll
5851 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5865 ;; Store overlays responsible for visibility status. We
5866 ;; also need to store their boundaries as they will be
5867 ;; removed from buffer.
5874 ;; Get contents.
5882 ;; Restore ex ELEM-A overlays.
5891 ;; Restore ex ELEM-B overlays.
5899 "Remove maximum common indentation in string S and return it.
5900 When optional argument N is a positive integer, remove exactly
5901 that much characters from indentation, if possible, or return
5902 S as-is otherwise. Unlike to `org-remove-indentation', this
5903 function doesn't call `untabify' on S."
5908 ;; Find maximum common indentation, if not specified.
5916 min-ind)))
5918 ;; Remove exactly N indentation, but give up if not possible.
5931 ;; Local variables:
5932 ;; generated-autoload-file: "org-loaddefs.el"
5933 ;; End:
5935 ;;; org-element.el ends here