| blob | 2eca35026710feba7318cfcc84b25a0012228b00 |
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', `node-property', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `fixed-width',
49 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
50 ;; `paragraph', `planning', `src-block', `table', `table-row' and
51 ;; `verse-block'. Among them, `paragraph' and `verse-block' types can
52 ;; contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, All elements have a `:post-affiliated'
77 ;; property referring to the buffer position after all affiliated
78 ;; keywords, if any, or to their beginning position otherwise.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Clock lines.
158 ;; Lists.
165 "Regexp to separate paragraphs in an Org buffer.
167 is not sufficient to know if point is at a paragraph ending. See
172 dynamic-block example-block fixed-width footnote-definition
173 headline horizontal-rule inlinetask item keyword
174 latex-environment node-property paragraph plain-list
175 planning property-drawer quote-block section special-block
176 src-block table table-row verse-block)
181 item plain-list property-drawer quote-block section
182 special-block table)
187 inline-src-block italic line-break latex-fragment link macro
188 radio-target statistics-cookie strike-through subscript superscript
189 table-cell target timestamp underline verbatim)
194 superscript table-cell underline)
204 "Alist between block names and the associated parsing function.
205 Names must be uppercase. Any block whose name has no association
211 Only these types can accept search options and an explicit
217 "List of affiliated keywords as strings.
225 "Alist of usual translations for keywords.
226 The key is the old name and the value the new one. The property
230 "List of affiliated keywords that can occur more than once in an element.
232 Their value will be consed into a list of strings, which will be
233 returned as the value of the property.
235 This list is checked after translations have been applied. See
236 `org-element-keyword-translation-alist'.
242 "List of affiliated keywords whose value can be parsed.
244 Their value will be stored as a secondary string: a list of
245 strings and objects.
247 This list is checked after translations have been applied. See
251 "List of affiliated keywords which can have a secondary value.
253 In Org syntax, they can be written with optional square brackets
254 before the colons. For example, RESULTS keyword can be
255 associated to a hash value with the following:
257 #+RESULTS[hash-string]: some-source
259 This list is checked after translations have been applied. See
263 "List of properties associated to the whole document.
264 Any keyword in this list will have its value parsed and stored as
270 ;; Dual affiliated keywords.
274 ;; Regular affiliated keywords.
280 org-element-affiliated-keywords)))
282 ;; Export attributes.
284 "Regexp matching any affiliated keyword.
286 Keyword name is put in match group 1. Moreover, if keyword
287 belongs to `org-element-dual-keywords', put the dual value in
288 match group 2.
302 ;; Ignore all links excepted plain links in a link description.
303 ;; Also ignore radio-targets and line breaks.
305 italic latex-fragment macro plain-link statistics-cookie
306 strike-through subscript superscript underline verbatim)
308 ;; Remove any variable object from radio target as it would
309 ;; prevent it from being properly recognized.
311 subscript superscript underline superscript)
315 ;; Ignore inline babel call and inline src block as formulas are
316 ;; possible. Also ignore line breaks and statistics cookies.
318 latex-fragment link macro radio-target strike-through
319 subscript superscript target timestamp underline verbatim)
323 "Alist of objects restrictions.
325 key is an element or object type containing objects and value is
326 a list of types that can be contained within an element or object
327 of such type.
329 For example, in a `radio-target' object, one can only find
330 entities, latex-fragments, subscript, superscript and text
331 markup.
333 This alist also applies to secondary string. For example, an
334 `headline' type element doesn't directly contain objects, but
344 \f
345 ;;; Accessors and Setters
346 ;;
347 ;; Provide four accessors: `org-element-type', `org-element-property'
348 ;; `org-element-contents' and `org-element-restriction'.
349 ;;
350 ;; Setter functions allow to modify elements by side effect. There is
351 ;; `org-element-put-property', `org-element-set-contents'. These
352 ;; low-level functions are useful to build a parse tree.
353 ;;
354 ;; `org-element-adopt-element', `org-element-set-element',
355 ;; `org-element-extract-element' and `org-element-insert-before' are
356 ;; high-level functions useful to modify a parse tree.
357 ;;
358 ;; `org-element-secondary-p' is a predicate used to know if a given
359 ;; object belongs to a secondary string.
362 "Return type of ELEMENT.
364 The function returns the type of the element or object provided.
365 It can also return the following special value:
366 `plain-text' for a string
367 `org-data' for a complete document
368 nil in any other case."
374 "Extract the value from the PROPERTY of an ELEMENT."
379 "Extract contents from an ELEMENT."
385 "Return restriction associated to ELEMENT.
386 ELEMENT can be an element, an object or a symbol representing an
387 element or object type."
389 org-element-object-restrictions)))
392 "In ELEMENT set PROPERTY to VALUE.
393 Return modified element."
396 element))
399 "Set ELEMENT contents to CONTENTS.
400 Return modified element."
407 "Non-nil when OBJECT belongs to a secondary string.
408 Return value is the property name, as a keyword, or nil."
411 org-element-secondary-value-alist))))
414 property)))
417 "Append elements to the contents of another element.
419 PARENT is an element or object. CHILDREN can be elements,
420 objects, or a strings.
422 The function takes care of setting `:parent' property for CHILD.
423 Return parent element."
424 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
425 ;; string: parent is the list itself.
428 children)
429 ;; Add CHILDREN at the end of PARENT contents.
432 parent
434 ;; Return modified PARENT element.
438 "Extract ELEMENT from parse tree.
439 Remove element from the parse tree by side-effect, and return it
440 with its `:parent' property stripped out."
445 parent secondary
448 parent
450 ;; Return ELEMENT with its :parent removed.
454 "Insert ELEMENT before LOCATION in parse tree.
455 LOCATION is an element, object or string within the parse tree.
456 Parse tree is modified by side effect."
461 ;; Special case: LOCATION is the first element of an
462 ;; independent secondary string (e.g. :title property). Add
463 ;; ELEMENT in-place.
467 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
477 ;; Store SIBLINGS at appropriate place in parse tree.
482 ;; Set appropriate :parent property.
486 "Replace element or object OLD with element or object NEW.
487 The function takes care of setting `:parent' property for NEW."
488 ;; Ensure OLD and NEW have the same parent.
492 ;; We cannot replace OLD with NEW since one of them is not an
493 ;; object or element. We take the long path.
496 ;; Since OLD is going to be changed into NEW by side-effect, first
497 ;; make sure that every element or object within NEW has OLD as
498 ;; parent.
501 ;; Transfer contents.
503 ;; Overwrite OLD's properties with NEW's.
505 ;; Transfer type.
509 \f
510 ;;; Greater elements
511 ;;
512 ;; For each greater element type, we define a parser and an
513 ;; interpreter.
514 ;;
515 ;; A parser returns the element or object as the list described above.
516 ;; Most of them accepts no argument. Though, exceptions exist. Hence
517 ;; every element containing a secondary string (see
518 ;; `org-element-secondary-value-alist') will accept an optional
519 ;; argument to toggle parsing of that secondary string. Moreover,
520 ;; `item' parser requires current list's structure as its first
521 ;; element.
522 ;;
523 ;; An interpreter accepts two arguments: the list representation of
524 ;; the element or object, and its contents. The latter may be nil,
525 ;; depending on the element or object considered. It returns the
526 ;; appropriate Org syntax, as a string.
527 ;;
528 ;; Parsing functions must follow the naming convention:
529 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
530 ;; defined in `org-element-greater-elements'.
531 ;;
532 ;; Similarly, interpreting functions must follow the naming
533 ;; convention: org-element-TYPE-interpreter.
534 ;;
535 ;; With the exception of `headline' and `item' types, greater elements
536 ;; cannot contain other greater elements of their own type.
537 ;;
538 ;; Beside implementing a parser and an interpreter, adding a new
539 ;; greater element requires to tweak `org-element--current-element'.
540 ;; Moreover, the newly defined type must be added to both
541 ;; `org-element-all-elements' and `org-element-greater-elements'.
544 ;;;; Center Block
547 "Parse a center block.
549 LIMIT bounds the search. AFFILIATED is a list of which CAR is
550 the buffer position at the beginning of the first affiliated
551 keyword and CDR is a plist of affiliated keywords along with
552 their value.
554 Return a list whose CAR is `center-block' and CDR is a plist
555 containing `:begin', `:end', `:contents-begin', `:contents-end',
556 `:post-blank' and `:post-affiliated' keywords.
558 Assume point is at the beginning of the block."
562 ;; Incomplete block: parse it as a paragraph.
567 ;; Empty blocks have no contents.
581 :end end
582 :contents-begin contents-begin
583 :contents-end contents-end
589 "Interpret CENTER-BLOCK element as Org syntax.
590 CONTENTS is the contents of the element."
594 ;;;; Drawer
597 "Parse a drawer.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `drawer' and CDR is a plist containing
605 `:drawer-name', `:begin', `:end', `:contents-begin',
606 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
608 Assume point is at beginning of drawer."
611 ;; Incomplete drawer: parse it as a paragraph.
619 ;; Empty drawers have no contents.
632 :end end
633 :drawer-name name
634 :contents-begin contents-begin
635 :contents-end contents-end
641 "Interpret DRAWER element as Org syntax.
642 CONTENTS is the contents of the element."
645 contents))
648 ;;;; Dynamic Block
651 "Parse a dynamic block.
653 LIMIT bounds the search. AFFILIATED is a list of which CAR is
654 the buffer position at the beginning of the first affiliated
655 keyword and CDR is a plist of affiliated keywords along with
656 their value.
658 Return a list whose CAR is `dynamic-block' and CDR is a plist
659 containing `:block-name', `:begin', `:end', `:contents-begin',
660 `:contents-end', `:arguments', `:post-blank' and
661 `:post-affiliated' keywords.
663 Assume point is at beginning of dynamic block."
667 ;; Incomplete block: parse it as a paragraph.
676 ;; Empty blocks have no contents.
689 :end end
690 :block-name name
691 :arguments arguments
692 :contents-begin contents-begin
693 :contents-end contents-end
699 "Interpret DYNAMIC-BLOCK element as Org syntax.
700 CONTENTS is the contents of the element."
705 contents))
708 ;;;; Footnote Definition
711 "Parse a footnote definition.
713 LIMIT bounds the search. AFFILIATED is a list of which CAR is
714 the buffer position at the beginning of the first affiliated
715 keyword and CDR is a plist of affiliated keywords along with
716 their value.
718 Return a list whose CAR is `footnote-definition' and CDR is
719 a plist containing `:label', `:begin' `:end', `:contents-begin',
720 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
722 Assume point is at the beginning of the footnote definition."
750 :begin begin
751 :end end
752 :contents-begin contents-begin
753 :contents-end contents-end
759 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
760 CONTENTS is the contents of the footnote-definition."
762 " "
763 contents))
766 ;;;; Headline
769 "Parse a headline.
771 Return a list whose CAR is `headline' and CDR is a plist
772 containing `:raw-value', `:title', `:alt-title', `:begin',
773 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
774 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
775 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
776 `:footnote-section-p', `:post-blank' and `:post-affiliated'
777 keywords.
779 The plist also contains any property set in the property drawer,
780 with its name in upper cases and colons added at the
781 beginning (e.g., `:CUSTOM_ID').
783 LIMIT is a buffer position bounding the search.
785 When RAW-SECONDARY-P is non-nil, headline's title will not be
786 parsed as a secondary string, but as a plain string instead.
788 Assume point is at beginning of the headline."
801 raw-value)))
806 ;; Find property drawer associated to current headline and
807 ;; extract properties.
808 ;;
809 ;; Upcase property names. It avoids confusion between
810 ;; properties obtained through property drawer and default
811 ;; properties from the parser (e.g. `:end' and :END:)
815 plist)
821 ;; Make sure drawer is not associated
822 ;; to an inlinetask.
836 plist
841 plist)))
843 ;; Read time properties on the line below the headline.
849 org-keyword-time-not-clock-regexp end t)
859 plist))))
871 ;; Clean RAW-VALUE from any comment string.
877 ""
878 raw-value))))
879 ;; Clean TAGS from archive tag, if any.
885 :begin begin
886 :end end
887 :pre-blank
890 :contents-begin contents-begin
891 :contents-end contents-end
892 :level level
894 :tags tags
895 :todo-keyword todo
896 :todo-type todo-type
899 end)
900 :footnote-section-p footnote-section-p
901 :archivedp archivedp
902 :commentedp commentedp
904 time-props
905 standard-props))))
909 headline :alt-title
914 headline :title
920 "Interpret HEADLINE element as Org syntax.
921 CONTENTS is the contents of the element."
937 ?*)
941 " "
944 org-footnote-section
945 title))))
947 heading
948 ;; Align tags.
956 ?\s)
957 tags))
961 tags))))
963 contents)))
966 ;;;; Inlinetask
969 "Parse an inline task.
971 Return a list whose CAR is `inlinetask' and CDR is a plist
972 containing `:title', `:begin', `:end', `:contents-begin' and
973 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
974 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
975 `:closed', `:post-blank' and `:post-affiliated' keywords.
977 The plist also contains any property set in the property drawer,
978 with its name in upper cases and colons added at the
979 beginning (e.g., `:CUSTOM_ID').
981 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
982 title will not be parsed as a secondary string, but as a plain
983 string instead.
985 Assume point is at beginning of the inline task."
1001 ;; Read time properties on the line below the inlinetask
1002 ;; opening string.
1008 org-keyword-time-not-clock-regexp end t)
1018 plist)))))
1029 ;; Find property drawer associated to current inlinetask
1030 ;; and extract properties.
1031 ;;
1032 ;; HACK: Calling `org-element-at-point' triggers a parsing
1033 ;; of this inlinetask and, thus, an infloop. To avoid the
1034 ;; problem, we extract contents of the inlinetask and
1035 ;; parse them in a new buffer.
1036 ;;
1037 ;; Upcase property names. It avoids confusion between
1038 ;; properties obtained through property drawer and default
1039 ;; properties from the parser (e.g. `:end' and :END:)
1042 plist)
1049 org-property-start-re task-end t))
1059 plist
1064 plist)))
1069 :begin begin
1070 :end end
1071 :contents-begin contents-begin
1072 :contents-end contents-end
1075 :tags tags
1076 :todo-keyword todo
1077 :todo-type todo-type
1080 time-props
1081 standard-props))))
1083 inlinetask :title
1086 raw-value
1088 inlinetask))))))
1091 "Interpret INLINETASK element as Org syntax.
1092 CONTENTS is the contents of inlinetask."
1107 ;; Align tags.
1115 ? )
1116 tags))
1120 tags))))
1121 ;; Prefer degenerate inlinetasks when there are no
1122 ;; contents.
1125 contents
1129 ;;;; Item
1132 "Parse an item.
1134 STRUCT is the structure of the plain list.
1136 Return a list whose CAR is `item' and CDR is a plist containing
1137 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1138 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1139 `:post-affiliated' keywords.
1141 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1142 any, will not be parsed as a secondary string, but as a plain
1143 string instead.
1145 Assume point is at the beginning of the item."
1169 ;; Ignore tags in un-ordered lists: they are just
1170 ;; a part of item's body.
1176 ;; If first line isn't empty, contents really start
1177 ;; at the text after item's meta-data.
1186 :begin begin
1187 :end end
1188 ;; CONTENTS-BEGIN and CONTENTS-END may be
1189 ;; mixed up in the case of an empty item
1190 ;; separated from the next by a blank line.
1191 ;; Thus ensure the former is always the
1192 ;; smallest.
1195 :checkbox checkbox
1196 :counter counter
1197 :structure struct
1201 item :tag
1209 "Interpret ITEM element as Org syntax.
1210 CONTENTS is the contents of the element."
1220 ;; Compute indentation.
1225 ;; Indent contents.
1227 bullet
1241 ;;;; Plain List
1244 ;; Return structure of list at point. Internal function. See
1245 ;; `org-list-struct' for details.
1250 items struct)
1255 ;; At limit: end all items.
1264 ;; At list end: end all items.
1269 ;; At a new item: end previous sibling.
1281 ind
1282 bullet
1285 ;; Description tag.
1289 ;; Ending position, unknown so far.
1290 nil)))
1291 items))
1293 ;; Skip empty lines.
1295 ;; Skip inline tasks and blank lines along the way.
1302 ;; At some text line. Check if it ends any previous item.
1314 ;; Skip blocks (any type) and drawers contents.
1319 limit t)))
1325 "Parse a plain list.
1327 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1328 the buffer position at the beginning of the first affiliated
1329 keyword and CDR is a plist of affiliated keywords along with
1330 their value. STRUCTURE is the structure of the plain list being
1331 parsed.
1333 Return a list whose CAR is `plain-list' and CDR is a plist
1334 containing `:type', `:begin', `:end', `:contents-begin' and
1335 `:contents-end', `:structure', `:post-blank' and
1336 `:post-affiliated' keywords.
1338 Assume point is at the beginning of the list."
1352 pos))
1356 ;; Return value.
1360 :begin begin
1361 :end end
1362 :contents-begin contents-begin
1363 :contents-end contents-end
1364 :structure struct
1370 "Interpret PLAIN-LIST element as Org syntax.
1371 CONTENTS is the contents of the element."
1379 ;;;; Property Drawer
1382 "Parse a property drawer.
1384 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1385 the buffer position at the beginning of the first affiliated
1386 keyword and CDR is a plist of affiliated keywords along with
1387 their value.
1389 Return a list whose CAR is `property-drawer' and CDR is a plist
1390 containing `:begin', `:end', `:contents-begin', `:contents-end',
1391 `:post-blank' and `:post-affiliated' keywords.
1393 Assume point is at the beginning of the property drawer."
1396 ;; Incomplete drawer: parse it as a paragraph.
1416 :end end
1417 :contents-begin contents-begin
1418 :contents-end contents-end
1424 "Interpret PROPERTY-DRAWER element as Org syntax.
1425 CONTENTS is the properties within the drawer."
1429 ;;;; Quote Block
1432 "Parse a quote block.
1434 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1435 the buffer position at the beginning of the first affiliated
1436 keyword and CDR is a plist of affiliated keywords along with
1437 their value.
1439 Return a list whose CAR is `quote-block' and CDR is a plist
1440 containing `:begin', `:end', `:contents-begin', `:contents-end',
1441 `:post-blank' and `:post-affiliated' keywords.
1443 Assume point is at the beginning of the block."
1447 ;; Incomplete block: parse it as a paragraph.
1453 ;; Empty blocks have no contents.
1466 :end end
1467 :contents-begin contents-begin
1468 :contents-end contents-end
1474 "Interpret QUOTE-BLOCK element as Org syntax.
1475 CONTENTS is the contents of the element."
1479 ;;;; Section
1482 "Parse a section.
1484 LIMIT bounds the search.
1486 Return a list whose CAR is `section' and CDR is a plist
1487 containing `:begin', `:end', `:contents-begin', `contents-end',
1488 `:post-blank' and `:post-affiliated' keywords."
1490 ;; Beginning of section is the beginning of the first non-blank
1491 ;; line after previous headline.
1500 :end end
1501 :contents-begin begin
1502 :contents-end pos-before-blank
1507 "Interpret SECTION element as Org syntax.
1508 CONTENTS is the contents of the element."
1509 contents)
1512 ;;;; Special Block
1515 "Parse a special block.
1517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1518 the buffer position at the beginning of the first affiliated
1519 keyword and CDR is a plist of affiliated keywords along with
1520 their value.
1522 Return a list whose CAR is `special-block' and CDR is a plist
1523 containing `:type', `:raw-value', `:begin', `:end',
1524 `:contents-begin', `:contents-end', `:post-blank' and
1525 `:post-affiliated' keywords.
1527 Assume point is at the beginning of the block."
1534 limit t)))
1535 ;; Incomplete block: parse it as a paragraph.
1541 ;; Empty blocks have no contents.
1554 :raw-value
1557 contents-begin contents-end))
1558 :begin begin
1559 :end end
1560 :contents-begin contents-begin
1561 :contents-end contents-end
1567 "Interpret SPECIAL-BLOCK element as Org syntax.
1568 CONTENTS is the contents of the element."
1573 \f
1574 ;;; Elements
1575 ;;
1576 ;; For each element, a parser and an interpreter are also defined.
1577 ;; Both follow the same naming convention used for greater elements.
1578 ;;
1579 ;; Also, as for greater elements, adding a new element type is done
1580 ;; through the following steps: implement a parser and an interpreter,
1581 ;; tweak `org-element--current-element' so that it recognizes the new
1582 ;; type and add that new type to `org-element-all-elements'.
1583 ;;
1584 ;; As a special case, when the newly defined type is a block type,
1585 ;; `org-element-block-name-alist' has to be modified accordingly.
1588 ;;;; Babel Call
1591 "Parse a babel call.
1593 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1594 the buffer position at the beginning of the first affiliated
1595 keyword and CDR is a plist of affiliated keywords along with
1596 their value.
1598 Return a list whose CAR is `babel-call' and CDR is a plist
1599 containing `:begin', `:end', `:value', `:post-blank' and
1600 `:post-affiliated' as keywords."
1614 :end end
1615 :value value
1621 "Interpret BABEL-CALL element as Org syntax.
1622 CONTENTS is nil."
1626 ;;;; Clock
1629 "Parse a clock.
1631 LIMIT bounds the search.
1633 Return a list whose CAR is `clock' and CDR is a plist containing
1634 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1635 `:post-affiliated' as keywords."
1655 :value value
1656 :duration duration
1657 :begin begin
1658 :end end
1659 :post-blank post-blank
1663 "Interpret CLOCK element as Org syntax.
1664 CONTENTS is nil."
1672 "%2s:%02s"
1676 ;;;; Comment
1679 "Parse a comment.
1681 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1682 the buffer position at the beginning of the first affiliated
1683 keyword and CDR is a plist of affiliated keywords along with
1684 their value.
1686 Return a list whose CAR is `comment' and CDR is a plist
1687 containing `:begin', `:end', `:value', `:post-blank',
1688 `:post-affiliated' keywords.
1690 Assume point is at comment beginning."
1699 ;; Get comments ending.
1702 ;; Accumulate lines without leading hash and first
1703 ;; whitespace.
1717 :end end
1718 :value value
1724 "Interpret COMMENT element as Org syntax.
1725 CONTENTS is nil."
1729 ;;;; Comment Block
1732 "Parse an export block.
1734 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1735 the buffer position at the beginning of the first affiliated
1736 keyword and CDR is a plist of affiliated keywords along with
1737 their value.
1739 Return a list whose CAR is `comment-block' and CDR is a plist
1740 containing `:begin', `:end', `:value', `:post-blank' and
1741 `:post-affiliated' keywords.
1743 Assume point is at comment block beginning."
1747 ;; Incomplete block: parse it as a paragraph.
1760 contents-begin contents-end)))
1764 :end end
1765 :value value
1771 "Interpret COMMENT-BLOCK element as Org syntax.
1772 CONTENTS is nil."
1779 ;;;; Diary Sexp
1782 "Parse a diary sexp.
1784 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1785 the buffer position at the beginning of the first affiliated
1786 keyword and CDR is a plist of affiliated keywords along with
1787 their value.
1789 Return a list whose CAR is `diary-sexp' and CDR is a plist
1790 containing `:begin', `:end', `:value', `:post-blank' and
1791 `:post-affiliated' keywords."
1803 :begin begin
1804 :end end
1810 "Interpret DIARY-SEXP as Org syntax.
1811 CONTENTS is nil."
1815 ;;;; Example Block
1818 "Parse an example block.
1820 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1821 the buffer position at the beginning of the first affiliated
1822 keyword and CDR is a plist of affiliated keywords along with
1823 their value.
1825 Return a list whose CAR is `example-block' and CDR is a plist
1826 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1827 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1828 `:value', `:post-blank' and `:post-affiliated' keywords."
1832 ;; Incomplete block: parse it as a paragraph.
1840 ;; Switches analysis
1847 ;; Should labels be retained in (or stripped from) example
1848 ;; blocks?
1853 ;; What should code-references use - labels or
1854 ;; line-numbers?
1863 ;; Standard block parsing.
1871 contents-begin contents-end))
1872 block-ind))
1881 :end end
1882 :value value
1883 :switches switches
1884 :number-lines number-lines
1885 :preserve-indent preserve-indent
1886 :retain-labels retain-labels
1887 :use-labels use-labels
1888 :label-fmt label-fmt
1894 "Interpret EXAMPLE-BLOCK element as Org syntax.
1895 CONTENTS is nil."
1903 value
1908 ;;;; Fixed-width
1911 "Parse a fixed-width section.
1913 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1914 the buffer position at the beginning of the first affiliated
1915 keyword and CDR is a plist of affiliated keywords along with
1916 their value.
1918 Return a list whose CAR is `fixed-width' and CDR is a plist
1919 containing `:begin', `:end', `:value', `:post-blank' and
1920 `:post-affiliated' keywords.
1922 Assume point is at the beginning of the fixed-width area."
1926 value
1931 ;; Accumulate text without starting colons.
1944 :end end
1945 :value value
1951 "Interpret FIXED-WIDTH element as Org syntax.
1952 CONTENTS is nil."
1960 ;;;; Horizontal Rule
1963 "Parse an horizontal rule.
1965 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1966 the buffer position at the beginning of the first affiliated
1967 keyword and CDR is a plist of affiliated keywords along with
1968 their value.
1970 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1971 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1972 keywords."
1982 :end end
1988 "Interpret HORIZONTAL-RULE element as Org syntax.
1989 CONTENTS is nil."
1993 ;;;; Keyword
1996 "Parse a keyword at point.
1998 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1999 the buffer position at the beginning of the first affiliated
2000 keyword and CDR is a plist of affiliated keywords along with
2001 their value.
2003 Return a list whose CAR is `keyword' and CDR is a plist
2004 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2005 `:post-affiliated' keywords."
2007 ;; An orphaned affiliated keyword is considered as a regular
2008 ;; keyword. In this case AFFILIATED is nil, so we take care of
2009 ;; this corner case.
2022 :value value
2023 :begin begin
2024 :end end
2030 "Interpret KEYWORD element as Org syntax.
2031 CONTENTS is nil."
2037 ;;;; Latex Environment
2041 "Regexp matching the beginning of a LaTeX environment.
2042 The environment is captured by the first group.
2048 "Format string matching the ending of a LaTeX environment.
2052 "Parse a LaTeX environment.
2054 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2055 the buffer position at the beginning of the first affiliated
2056 keyword and CDR is a plist of affiliated keywords along with
2057 their value.
2059 Return a list whose CAR is `latex-environment' and CDR is a plist
2060 containing `:begin', `:end', `:value', `:post-blank' and
2061 `:post-affiliated' keywords.
2063 Assume point is at the beginning of the latex environment."
2070 limit t))
2071 ;; Incomplete latex environment: parse it as a paragraph.
2081 :end end
2082 :value value
2088 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2089 CONTENTS is nil."
2093 ;;;; Node Property
2096 "Parse a node-property at point.
2098 LIMIT bounds the search.
2100 Return a list whose CAR is `node-property' and CDR is a plist
2101 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2102 `:post-affiliated' keywords."
2112 limit))))
2115 :value value
2116 :begin begin
2117 :end end
2122 "Interpret NODE-PROPERTY element as Org syntax.
2123 CONTENTS is nil."
2129 ;;;; Paragraph
2132 "Parse a paragraph.
2134 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2135 the buffer position at the beginning of the first affiliated
2136 keyword and CDR is a plist of affiliated keywords along with
2137 their value.
2139 Return a list whose CAR is `paragraph' and CDR is a plist
2140 containing `:begin', `:end', `:contents-begin' and
2141 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2143 Assume point is at the beginning of the paragraph."
2152 limit
2153 ;; A matching `org-element-paragraph-separate' is not
2154 ;; necessarily the end of the paragraph. In
2155 ;; particular, lines starting with # or : as a first
2156 ;; non-space character are ambiguous. We have to
2157 ;; check if they are valid Org syntax (e.g., not an
2158 ;; incomplete keyword).
2162 ;; There's no ambiguity for other symbols or
2163 ;; empty lines: stop here.
2165 ;; Stop at valid fixed-width areas.
2167 ;; Stop at drawers.
2172 ;; Stop at valid comments.
2174 ;; Stop at valid dynamic blocks.
2179 ;; Stop at valid blocks.
2186 limit t)))
2187 ;; Stop at valid latex environments.
2194 limit t)))
2195 ;; Stop at valid keywords.
2197 ;; Skip everything else.
2214 :end end
2215 :contents-begin contents-begin
2216 :contents-end contents-end
2222 "Interpret PARAGRAPH element as Org syntax.
2223 CONTENTS is the contents of the element."
2224 contents)
2227 ;;;; Planning
2230 "Parse a planning.
2232 LIMIT bounds the search.
2234 Return a list whose CAR is `planning' and CDR is a plist
2235 containing `:closed', `:deadline', `:scheduled', `:begin',
2236 `:end', `:post-blank' and `:post-affiliated' keywords."
2248 closed deadline scheduled)
2260 :deadline deadline
2261 :scheduled scheduled
2262 :begin begin
2263 :end end
2264 :post-blank post-blank
2268 "Interpret PLANNING element as Org syntax.
2269 CONTENTS is nil."
2271 'identity
2288 ;;;; Src Block
2291 "Parse a src block.
2293 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2294 the buffer position at the beginning of the first affiliated
2295 keyword and CDR is a plist of affiliated keywords along with
2296 their value.
2298 Return a list whose CAR is `src-block' and CDR is a plist
2299 containing `:language', `:switches', `:parameters', `:begin',
2300 `:end', `:number-lines', `:retain-labels', `:use-labels',
2301 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2302 `:post-affiliated' keywords.
2304 Assume point is at the beginning of the block."
2307 limit t)))
2308 ;; Incomplete block: parse it as a paragraph.
2314 ;; Get language as a string.
2323 ;; Get switches.
2325 ;; Get parameters.
2327 ;; Switches analysis
2338 ;; Should labels be retained in (or stripped from)
2339 ;; src blocks?
2344 ;; What should code-references use - labels or
2345 ;; line-numbers?
2350 ;; Indentation.
2352 ;; Retrieve code.
2357 block-ind))
2361 ;; Get position after ending blank lines.
2371 :begin begin
2372 :end end
2373 :number-lines number-lines
2374 :preserve-indent preserve-indent
2375 :retain-labels retain-labels
2376 :use-labels use-labels
2377 :label-fmt label-fmt
2378 :value value
2384 "Interpret SRC-BLOCK element as Org syntax.
2385 CONTENTS is nil."
2394 val)
2408 ;;;; Table
2411 "Parse a table at point.
2413 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2414 the buffer position at the beginning of the first affiliated
2415 keyword and CDR is a plist of affiliated keywords along with
2416 their value.
2418 Return a list whose CAR is `table' and CDR is a plist containing
2419 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2420 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2421 keywords.
2423 Assume point is at the beginning of the table."
2437 acc))
2444 :end end
2445 :type type
2446 :tblfm tblfm
2447 ;; Only `org' tables have contents. `table.el' tables
2448 ;; use a `:value' property to store raw table as
2449 ;; a string.
2454 table-begin table-end))
2460 "Interpret TABLE element as Org syntax.
2461 CONTENTS is a string, if table's type is `org', or nil."
2472 ;;;; Table Row
2475 "Parse table row at point.
2477 LIMIT bounds the search.
2479 Return a list whose CAR is `table-row' and CDR is a plist
2480 containing `:begin', `:end', `:contents-begin', `:contents-end',
2481 `:type', `:post-blank' and `:post-affiliated' keywords."
2485 ;; A table rule has no contents. In that case, ensure
2486 ;; CONTENTS-BEGIN matches CONTENTS-END.
2498 :begin begin
2499 :end end
2500 :contents-begin contents-begin
2501 :contents-end contents-end
2506 "Interpret TABLE-ROW element as Org syntax.
2507 CONTENTS is the contents of the table row."
2512 ;;;; Verse Block
2515 "Parse a verse block.
2517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2518 the buffer position at the beginning of the first affiliated
2519 keyword and CDR is a plist of affiliated keywords along with
2520 their value.
2522 Return a list whose CAR is `verse-block' and CDR is a plist
2523 containing `:begin', `:end', `:contents-begin', `:contents-end',
2524 `:post-blank' and `:post-affiliated' keywords.
2526 Assume point is at beginning of the block."
2530 ;; Incomplete block: parse it as a paragraph.
2545 :end end
2546 :contents-begin contents-begin
2547 :contents-end contents-end
2553 "Interpret VERSE-BLOCK element as Org syntax.
2554 CONTENTS is verse block contents."
2558 \f
2559 ;;; Objects
2560 ;;
2561 ;; Unlike to elements, raw text can be found between objects. Hence,
2562 ;; `org-element--object-lex' is provided to find the next object in
2563 ;; buffer.
2564 ;;
2565 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2566 ;; object types they can contain will be specified in
2567 ;; `org-element-object-restrictions'.
2568 ;;
2569 ;; Creating a new type of object requires to alter
2570 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2571 ;; new type in `org-element-all-objects', and possibly add
2572 ;; restrictions in `org-element-object-restrictions'.
2574 ;;;; Bold
2577 "Parse bold object at point, if any.
2579 When at a bold object, return a list whose car is `bold' and cdr
2580 is a plist with `:begin', `:end', `:contents-begin' and
2581 `:contents-end' and `:post-blank' keywords. Otherwise, return
2582 nil.
2584 Assume point is at the first star marker."
2596 :end end
2597 :contents-begin contents-begin
2598 :contents-end contents-end
2602 "Interpret BOLD object as Org syntax.
2603 CONTENTS is the contents of the object."
2607 ;;;; Code
2610 "Parse code object at point, if any.
2612 When at a code object, return a list whose car is `code' and cdr
2613 is a plist with `:value', `:begin', `:end' and `:post-blank'
2614 keywords. Otherwise, return nil.
2616 Assume point is at the first tilde marker."
2627 :begin begin
2628 :end end
2632 "Interpret CODE object as Org syntax.
2633 CONTENTS is nil."
2637 ;;;; Entity
2640 "Parse entity at point, if any.
2642 When at an entity, return a list whose car is `entity' and cdr
2643 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2644 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2645 `:post-blank' as keywords. Otherwise, return nil.
2647 Assume point is at the beginning of the entity."
2649 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2667 :begin begin
2668 :end end
2669 :use-brackets-p bracketsp
2673 "Interpret ENTITY object as Org syntax.
2674 CONTENTS is nil."
2680 ;;;; Export Snippet
2683 "Parse export snippet at point.
2685 When at an export snippet, return a list whose car is
2686 `export-snippet' and cdr a plist with `:begin', `:end',
2687 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2688 return nil.
2690 Assume point is at the beginning of the snippet."
2706 :value value
2707 :begin begin
2708 :end end
2712 "Interpret EXPORT-SNIPPET object as Org syntax.
2713 CONTENTS is nil."
2719 ;;;; Footnote Reference
2722 "Parse footnote reference at point, if any.
2724 When at a footnote reference, return a list whose car is
2725 `footnote-reference' and cdr a plist with `:label', `:type',
2726 `:begin', `:end', `:content-begin', `:contents-end' and
2727 `:post-blank' as keywords. Otherwise, return nil."
2751 :type type
2752 :begin begin
2753 :end end
2759 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2760 CONTENTS is its definition, when inline, or nil."
2766 ;;;; Inline Babel Call
2769 "Parse inline babel call at point, if any.
2771 When at an inline babel call, return a list whose car is
2772 `inline-babel-call' and cdr a plist with `:begin', `:end',
2773 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2775 Assume point is at the beginning of the babel call."
2787 :end end
2788 :value value
2792 "Interpret INLINE-BABEL-CALL object as Org syntax.
2793 CONTENTS is nil."
2797 ;;;; Inline Src Block
2800 "Parse inline source block at point, if any.
2802 When at an inline source block, return a list whose car is
2803 `inline-src-block' and cdr a plist with `:begin', `:end',
2804 `:language', `:value', `:parameters' and `:post-blank' as
2805 keywords. Otherwise, return nil.
2807 Assume point is at the beginning of the inline src block."
2820 :value value
2821 :parameters parameters
2822 :begin begin
2823 :end end
2827 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2828 CONTENTS is nil."
2833 language
2835 body)))
2837 ;;;; Italic
2840 "Parse italic object at point, if any.
2842 When at an italic object, return a list whose car is `italic' and
2843 cdr is a plist with `:begin', `:end', `:contents-begin' and
2844 `:contents-end' and `:post-blank' keywords. Otherwise, return
2845 nil.
2847 Assume point is at the first slash marker."
2859 :end end
2860 :contents-begin contents-begin
2861 :contents-end contents-end
2865 "Interpret ITALIC object as Org syntax.
2866 CONTENTS is the contents of the object."
2870 ;;;; Latex Fragment
2873 "Parse LaTeX fragment at point, if any.
2875 When at a LaTeX fragment, return a list whose car is
2876 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2877 and `:post-blank' as keywords. Otherwise, return nil.
2879 Assume point is at the beginning of the LaTeX fragment."
2897 ;; Macro.
2906 :begin begin
2907 :end end
2911 "Interpret LATEX-FRAGMENT object as Org syntax.
2912 CONTENTS is nil."
2915 ;;;; Line Break
2918 "Parse line break at point, if any.
2920 When at a line break, return a list whose car is `line-break',
2921 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2922 Otherwise, return nil.
2924 Assume point is at the beginning of the line break."
2933 "Interpret LINE-BREAK object as Org syntax.
2934 CONTENTS is nil."
2938 ;;;; Link
2941 "Parse link at point, if any.
2943 When at a link, return a list whose car is `link' and cdr a plist
2944 with `:type', `:path', `:raw-link', `:application',
2945 `:search-option', `:begin', `:end', `:contents-begin',
2946 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2947 nil.
2949 Assume point is at the beginning of the link."
2952 end contents-begin contents-end link-end post-blank path type
2953 raw-link link search-option application)
2955 ;; Type 1: Text targeted from a radio target.
2964 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2969 ;; RAW-LINK is the original link. Expand any
2970 ;; abbreviation in it.
2974 ;; Determine TYPE of link and set PATH accordingly.
2976 ;; File type.
2980 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2983 ;; According to RFC 3986, extra whitespace should be
2984 ;; ignored when a URI is extracted.
2987 ;; Id type: PATH is the id.
2990 ;; Code-ref type: PATH is the name of the reference.
2993 ;; Custom-id type: PATH is the name of the custom id.
2996 ;; Fuzzy type: Internal link either matches a target, an
2997 ;; headline name or nothing. PATH is the target or
2998 ;; headline's name.
3000 ;; Type 3: Plain link, e.g., http://orgmode.org
3006 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3014 ;; In any case, deduce end point after trailing white space from
3015 ;; LINK-END variable.
3019 ;; Special "file" type link processing.
3021 ;; Extract opening application and search option.
3029 ;; Normalize URI.
3033 ;; Make sure TYPE always reports "file".
3037 :path path
3039 :application application
3040 :search-option search-option
3041 :begin begin
3042 :end end
3043 :contents-begin contents-begin
3044 :contents-end contents-end
3048 "Interpret LINK object as Org syntax.
3049 CONTENTS is the contents of the object, or nil."
3054 raw-link
3058 ;;;; Macro
3061 "Parse macro at point, if any.
3063 When at a macro, return a list whose car is `macro' and cdr
3064 a plist with `:key', `:args', `:begin', `:end', `:value' and
3065 `:post-blank' as keywords. Otherwise, return nil.
3067 Assume point is at the macro."
3078 ;; Do not use `org-split-string' since empty
3079 ;; strings are meaningful here.
3087 args nil t)
3091 :value value
3092 :args args
3093 :begin begin
3094 :end end
3098 "Interpret MACRO object as Org syntax.
3099 CONTENTS is nil."
3103 ;;;; Radio-target
3106 "Parse radio target at point, if any.
3108 When at a radio target, return a list whose car is `radio-target'
3109 and cdr a plist with `:begin', `:end', `:contents-begin',
3110 `:contents-end', `:value' and `:post-blank' as keywords.
3111 Otherwise, return nil.
3113 Assume point is at the radio target."
3125 :end end
3126 :contents-begin contents-begin
3127 :contents-end contents-end
3128 :post-blank post-blank
3132 "Interpret TARGET object as Org syntax.
3133 CONTENTS is the contents of the object."
3137 ;;;; Statistics Cookie
3140 "Parse statistics cookie at point, if any.
3142 When at a statistics cookie, return a list whose car is
3143 `statistics-cookie', and cdr a plist with `:begin', `:end',
3144 `:value' and `:post-blank' keywords. Otherwise, return nil.
3146 Assume point is at the beginning of the statistics-cookie."
3157 :end end
3158 :value value
3162 "Interpret STATISTICS-COOKIE object as Org syntax.
3163 CONTENTS is nil."
3167 ;;;; Strike-Through
3170 "Parse strike-through object at point, if any.
3172 When at a strike-through object, return a list whose car is
3173 `strike-through' and cdr is a plist with `:begin', `:end',
3174 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3175 Otherwise, return nil.
3177 Assume point is at the first plus sign marker."
3189 :end end
3190 :contents-begin contents-begin
3191 :contents-end contents-end
3195 "Interpret STRIKE-THROUGH object as Org syntax.
3196 CONTENTS is the contents of the object."
3200 ;;;; Subscript
3203 "Parse subscript at point, if any.
3205 When at a subscript object, return a list whose car is
3206 `subscript' and cdr a plist with `:begin', `:end',
3207 `:contents-begin', `:contents-end', `:use-brackets-p' and
3208 `:post-blank' as keywords. Otherwise, return nil.
3210 Assume point is at the underscore."
3224 :end end
3225 :use-brackets-p bracketsp
3226 :contents-begin contents-begin
3227 :contents-end contents-end
3231 "Interpret SUBSCRIPT object as Org syntax.
3232 CONTENTS is the contents of the object."
3235 contents))
3238 ;;;; Superscript
3241 "Parse superscript at point, if any.
3243 When at a superscript object, return a list whose car is
3244 `superscript' and cdr a plist with `:begin', `:end',
3245 `:contents-begin', `:contents-end', `:use-brackets-p' and
3246 `:post-blank' as keywords. Otherwise, return nil.
3248 Assume point is at the caret."
3262 :end end
3263 :use-brackets-p bracketsp
3264 :contents-begin contents-begin
3265 :contents-end contents-end
3269 "Interpret SUPERSCRIPT object as Org syntax.
3270 CONTENTS is the contents of the object."
3273 contents))
3276 ;;;; Table Cell
3279 "Parse table cell at point.
3280 Return a list whose car is `table-cell' and cdr is a plist
3281 containing `:begin', `:end', `:contents-begin', `:contents-end'
3282 and `:post-blank' keywords."
3290 :end end
3291 :contents-begin contents-begin
3292 :contents-end contents-end
3296 "Interpret TABLE-CELL element as Org syntax.
3297 CONTENTS is the contents of the cell, or nil."
3301 ;;;; Target
3304 "Parse target at point, if any.
3306 When at a target, return a list whose car is `target' and cdr
3307 a plist with `:begin', `:end', `:value' and `:post-blank' as
3308 keywords. Otherwise, return nil.
3310 Assume point is at the target."
3320 :end end
3321 :value value
3325 "Interpret TARGET object as Org syntax.
3326 CONTENTS is nil."
3330 ;;;; Timestamp
3341 "Parse time stamp at point, if any.
3343 When at a time stamp, return a list whose car is `timestamp', and
3344 cdr a plist with `:type', `:raw-value', `:year-start',
3345 `:month-start', `:day-start', `:hour-start', `:minute-start',
3346 `:year-end', `:month-end', `:day-end', `:hour-end',
3347 `:minute-end', `:repeater-type', `:repeater-value',
3348 `:repeater-unit', `:warning-type', `:warning-value',
3349 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3350 Otherwise, return nil.
3352 Assume point is at the beginning of the timestamp."
3371 date-start)
3382 raw-value)
3384 :repeater-type
3390 :repeater-unit
3399 :warning-unit
3402 year-start month-start day-start hour-start minute-start year-end
3403 month-end day-end hour-end minute-end)
3404 ;; Parse date-start.
3412 ;; Compute date-end. It can be provided directly in time-stamp,
3413 ;; or extracted from time range. Otherwise, it defaults to the
3414 ;; same values as date-start.
3424 :raw-value raw-value
3425 :year-start year-start
3426 :month-start month-start
3427 :day-start day-start
3428 :hour-start hour-start
3429 :minute-start minute-start
3430 :year-end year-end
3431 :month-end month-end
3432 :day-end day-end
3433 :hour-end hour-end
3434 :minute-end minute-end
3435 :begin begin
3436 :end end
3438 repeater-props
3439 warning-props))))))
3442 "Interpret TIMESTAMP object as Org syntax.
3443 CONTENTS is nil."
3462 ;; Build an Org timestamp string from TIME. ACTIVEP is
3463 ;; non-nil when time stamp is active. If WITH-TIME-P is
3464 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3465 ;; specify a time range in the timestamp. REPEAT-STRING is
3466 ;; the repeater string, if any.
3470 org-time-stamp-formats)
3471 time)))
3477 nil nil ts)))
3482 " "
3483 s
3485 ;; Return value.
3486 ts)))
3498 build-ts-string
3517 0
3525 "--"
3537 ;;;; Underline
3540 "Parse underline object at point, if any.
3542 When at an underline object, return a list whose car is
3543 `underline' and cdr is a plist with `:begin', `:end',
3544 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3545 Otherwise, return nil.
3547 Assume point is at the first underscore marker."
3559 :end end
3560 :contents-begin contents-begin
3561 :contents-end contents-end
3565 "Interpret UNDERLINE object as Org syntax.
3566 CONTENTS is the contents of the object."
3570 ;;;; Verbatim
3573 "Parse verbatim object at point, if any.
3575 When at a verbatim object, return a list whose car is `verbatim'
3576 and cdr is a plist with `:value', `:begin', `:end' and
3577 `:post-blank' keywords. Otherwise, return nil.
3579 Assume point is at the first equal sign marker."
3590 :begin begin
3591 :end end
3595 "Interpret VERBATIM object as Org syntax.
3596 CONTENTS is nil."
3600 \f
3601 ;;; Parsing Element Starting At Point
3602 ;;
3603 ;; `org-element--current-element' is the core function of this section.
3604 ;; It returns the Lisp representation of the element starting at
3605 ;; point.
3606 ;;
3607 ;; `org-element--current-element' makes use of special modes. They
3608 ;; are activated for fixed element chaining (e.g., `plain-list' >
3609 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3610 ;; `section'). Special modes are: `first-section', `item',
3611 ;; `node-property', `section' and `table-row'.
3614 "Parse the element starting at point.
3616 Return value is a list like (TYPE PROPS) where TYPE is the type
3617 of the element and PROPS a plist of properties associated to the
3618 element.
3620 Possible types are defined in `org-element-all-elements'.
3622 LIMIT bounds the search.
3624 Optional argument GRANULARITY determines the depth of the
3625 recursion. Allowed values are `headline', `greater-element',
3626 `element', `object' or nil. When it is broader than `object' (or
3627 nil), secondary values will not be parsed, since they only
3628 contain objects.
3630 Optional argument MODE, when non-nil, can be either
3631 `first-section', `section', `planning', `item', `node-property'
3632 and `table-row'.
3634 If STRUCTURE isn't provided but MODE is set to `item', it will be
3635 computed.
3637 This function assumes point is always at the beginning of the
3638 element it has to parse."
3641 ;; Determine if parsing depth allows for secondary strings
3642 ;; parsing. It only applies to elements referenced in
3643 ;; `org-element-secondary-value-alist'.
3646 ;; Item.
3649 ;; Table Row.
3651 ;; Node Property.
3653 ;; Headline.
3656 ;; Sections (must be checked after headline).
3661 limit)))
3662 ;; Planning.
3665 ;; When not at bol, point is at the beginning of an item or
3666 ;; a footnote definition: next item is always a paragraph.
3668 ;; Clock.
3670 ;; Inlinetask.
3673 ;; From there, elements can have affiliated keywords.
3676 ;; Jumping over affiliated keywords put point off-limits.
3677 ;; Parse them as regular keywords.
3681 ;; LaTeX Environment.
3684 ;; Drawer and Property Drawer.
3689 ;; Fixed Width
3692 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3693 ;; Keywords.
3702 org-element-block-name-alist)))
3717 ;; Footnote Definition.
3720 ;; Horizontal Rule.
3723 ;; Diary Sexp.
3726 ;; Table.
3728 ;; List.
3731 limit affiliated
3733 ;; Default element: Paragraph.
3737 ;; Most elements can have affiliated keywords. When looking for an
3738 ;; element beginning, we want to move before them, as they belong to
3739 ;; that element, and, in the meantime, collect information they give
3740 ;; into appropriate properties. Hence the following function.
3743 "Collect affiliated keywords from point down to LIMIT.
3745 Return a list whose CAR is the position at the first of them and
3746 CDR a plist of keywords and values and move point to the
3747 beginning of the first line after them.
3749 As a special case, if element doesn't start at the beginning of
3750 the line (e.g., a paragraph starting an item), CAR is current
3751 position of point and CDR is nil."
3755 ;; RESTRICT is the list of objects allowed in parsed
3756 ;; keywords value.
3758 output)
3761 ;; Apply translation to RAW-KWD. From there, KWD is
3762 ;; the official keyword.
3764 org-element-keyword-translation-alist))
3765 raw-kwd))
3766 ;; Find main value for any keyword.
3772 ;; PARSEDP is non-nil when keyword should have its
3773 ;; value parsed.
3775 ;; If KWD is a dual keyword, find its secondary
3776 ;; value. Maybe parse it.
3783 ;; Attribute a property name to KWD.
3785 ;; Now set final shape for VALUE.
3791 ;; Attributes can always appear on multiple lines.
3794 ;; Eventually store the new value in OUTPUT.
3796 ;; Move to next keyword.
3798 ;; If affiliated keywords are orphaned: move back to first one.
3799 ;; They will be parsed as a paragraph.
3801 ;; Return value.
3805 \f
3806 ;;; The Org Parser
3807 ;;
3808 ;; The two major functions here are `org-element-parse-buffer', which
3809 ;; parses Org syntax inside the current buffer, taking into account
3810 ;; region, narrowing, or even visibility if specified, and
3811 ;; `org-element-parse-secondary-string', which parses objects within
3812 ;; a given string.
3813 ;;
3814 ;; The (almost) almighty `org-element-map' allows to apply a function
3815 ;; on elements or objects matching some type, and accumulate the
3816 ;; resulting values. In an export situation, it also skips unneeded
3817 ;; parts of the parse tree.
3820 "Recursively parse the buffer and return structure.
3821 If narrowing is in effect, only parse the visible part of the
3822 buffer.
3824 Optional argument GRANULARITY determines the depth of the
3825 recursion. It can be set to the following symbols:
3827 `headline' Only parse headlines.
3828 `greater-element' Don't recurse into greater elements excepted
3829 headlines and sections. Thus, elements
3830 parsed are the top-level ones.
3831 `element' Parse everything but objects and plain text.
3832 `object' Parse the complete buffer (default).
3834 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3835 elements.
3837 An element or an objects is represented as a list with the
3838 pattern (TYPE PROPERTIES CONTENTS), where :
3840 TYPE is a symbol describing the element or object. See
3841 `org-element-all-elements' and `org-element-all-objects' for an
3842 exhaustive list of such symbols. One can retrieve it with
3843 `org-element-type' function.
3845 PROPERTIES is the list of attributes attached to the element or
3846 object, as a plist. Although most of them are specific to the
3847 element or object type, all types share `:begin', `:end',
3848 `:post-blank' and `:parent' properties, which respectively
3849 refer to buffer position where the element or object starts,
3850 ends, the number of white spaces or blank lines after it, and
3851 the element or object containing it. Properties values can be
3852 obtained by using `org-element-property' function.
3854 CONTENTS is a list of elements, objects or raw strings
3855 contained in the current element or object, when applicable.
3856 One can access them with `org-element-contents' function.
3858 The Org buffer has `org-data' as type and nil as properties.
3859 `org-element-map' function can be used to find specific elements
3860 or objects within the parse tree.
3862 This function assumes that current major mode is `org-mode'."
3868 ;; Start in `first-section' mode so text before the first
3869 ;; headline belongs to a section.
3873 "Recursively parse objects in STRING and return structure.
3875 RESTRICTION is a symbol limiting the object types that will be
3876 looked after.
3878 Optional argument PARENT, when non-nil, is the element or object
3879 containing the secondary string. It is used to set correctly
3880 `:parent' property within the string."
3893 secondary))))
3897 "Map a function on selected elements or objects.
3899 DATA is a parse tree, an element, an object, a string, or a list
3900 of such constructs. TYPES is a symbol or list of symbols of
3901 elements or objects types (see `org-element-all-elements' and
3902 `org-element-all-objects' for a complete list of types). FUN is
3903 the function called on the matching element or object. It has to
3904 accept one argument: the element or object itself.
3906 When optional argument INFO is non-nil, it should be a plist
3907 holding export options. In that case, parts of the parse tree
3908 not exportable according to that property list will be skipped.
3910 When optional argument FIRST-MATCH is non-nil, stop at the first
3911 match for which FUN doesn't return nil, and return that value.
3913 Optional argument NO-RECURSION is a symbol or a list of symbols
3914 representing elements or objects types. `org-element-map' won't
3915 enter any recursive element or object whose type belongs to that
3916 list. Though, FUN can still be applied on them.
3918 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3919 apply to matching objects within parsed affiliated keywords (see
3920 `org-element-parsed-keywords').
3922 Nil values returned from FUN do not appear in the results.
3925 Examples:
3926 ---------
3928 Assuming TREE is a variable containing an Org buffer parse tree,
3929 the following example will return a flat list of all `src-block'
3930 and `example-block' elements in it:
3932 \(org-element-map tree '(example-block src-block) 'identity)
3934 The following snippet will find the first headline with a level
3937 \(org-element-map tree 'headline
3938 \(lambda (hl)
3939 \(and (= (org-element-property :level hl) 1)
3941 \(org-element-property :begin hl)))
3942 nil t)
3944 The next example will return a flat list of all `plain-list' type
3945 elements in TREE that are not a sub-list themselves:
3947 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3949 Eventually, this example will return a flat list of all `bold'
3950 type objects containing a `latex-snippet' type object, even
3951 looking into captions:
3953 \(org-element-map tree 'bold
3954 \(lambda (b)
3955 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3956 nil nil nil t)"
3957 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3960 ;; Recursion depth is determined by --CATEGORY.
3967 ;; If one object is found, the function
3968 ;; has to recurse into every object.
3971 ;; If one regular element is found, the
3972 ;; function has to recurse, at least,
3973 ;; into every element it encounters.
3976 types)
3977 category)))
3978 ;; Compute properties for affiliated keywords if necessary.
3983 org-element-affiliated-keywords)))
3984 --acc
3985 --walk-tree
3989 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3990 ;; holding contextual information.
3994 ;; Ignored element in an export context.
3996 ;; List of elements or objects.
3998 ;; Unconditionally enter parse trees.
4002 ;; Check if TYPE is matching among TYPES. If so,
4003 ;; apply FUN to --DATA and accumulate return value
4004 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4010 ;; If --DATA has a secondary string that can contain
4011 ;; objects with their type among TYPES, look into it.
4018 ;; If --DATA has any affiliated keywords and
4019 ;; WITH-AFFILIATED is non-nil, look for objects in
4020 ;; them.
4028 ;; Pay attention to the type of value.
4029 ;; Preserve order for multiple keywords.
4045 --affiliated-alist))
4046 ;; Determine if a recursion into --DATA is possible.
4048 ;; --TYPE is explicitly removed from recursion.
4050 ;; --DATA has no contents.
4052 ;; Looking for greater elements but --DATA is simply
4053 ;; an element or an object.
4056 ;; Looking for elements but --DATA is an object.
4059 ;; In any other case, map contents.
4063 ;; Return value in a proper order.
4067 ;; The following functions are internal parts of the parser.
4068 ;;
4069 ;; The first one, `org-element--parse-elements' acts at the element's
4070 ;; level.
4071 ;;
4072 ;; The second one, `org-element--parse-objects' applies on all objects
4073 ;; of a paragraph or a secondary string.
4074 ;;
4075 ;; More precisely, that function looks for every allowed object type
4076 ;; first. Then, it discards failed searches, keeps further matches,
4077 ;; and searches again types matched behind point, for subsequent
4078 ;; calls. Thus, searching for a given type fails only once, and every
4079 ;; object is searched only once at top level (but sometimes more for
4080 ;; nested types).
4083 "Return next special mode according to TYPE, or nil.
4084 TYPE is a symbol representing the type of an element or object.
4085 Modes can be either `first-section', `section', `planning',
4086 `item', `node-property' and `table-row'."
4096 "Parse elements between BEG and END positions.
4098 SPECIAL prioritize some elements over the others. It can be set
4099 to `first-section', `section' `item' or `table-row'.
4101 When value is `item', STRUCTURE will be used as the current list
4102 structure.
4104 GRANULARITY determines the depth of the recursion. See
4105 `org-element-parse-buffer' for more information.
4107 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4108 elements.
4110 Elements are accumulated into ACC."
4113 ;; Visible only: skip invisible parts at the beginning of the
4114 ;; element.
4117 ;; When parsing only headlines, skip any text before first one.
4120 ;; Main loop start.
4122 ;; Find current element's type and parse it accordingly to
4123 ;; its category.
4125 end granularity special structure))
4129 ;; Visible only: skip invisible parts between siblings.
4132 ;; Fill ELEMENT contents by side-effect.
4134 ;; If element has no contents, don't modify it.
4136 ;; Greater element: parse it between `contents-begin' and
4137 ;; `contents-end'. Make sure GRANULARITY allows the
4138 ;; recursion, or ELEMENT is a headline, in which case going
4139 ;; inside is mandatory, in order to get sub-level headings.
4147 ;; Possibly switch to a special mode.
4151 granularity visible-only element))
4152 ;; ELEMENT has contents. Parse objects inside, if
4153 ;; GRANULARITY allows it.
4159 ;; Return result.
4160 acc))
4166 ;; Sub/superscript.
4168 ;; Bold, code, italic, strike-through, underline and
4169 ;; verbatim.
4172 ;; Plain links.
4174 ;; Objects starting with "[": regular link, footnote
4175 ;; reference, statistics cookie, timestamp (inactive).
4177 ;; Objects starting with "@": export snippets.
4178 "@@"
4179 ;; Objects starting with "{": macro.
4180 "{{{"
4181 ;; Objects starting with "<" : timestamp (active,
4182 ;; diary), target, radio target and angular links.
4184 ;; Objects starting with "$": latex fragment.
4186 ;; Objects starting with "\": line break, entity,
4187 ;; latex fragment.
4189 ;; Objects starting with raw text: inline Babel
4190 ;; source block, inline Babel call.
4193 "Regexp possibly matching the beginning of an object.
4194 This regexp allows false positives. Dedicated parser (e.g.,
4195 `org-export-bold-parser') will take care of further filtering.
4196 Radio links are not matched by this regexp, as they are treated
4200 "Return next object in current buffer or nil.
4201 RESTRICTION is a list of object types, as symbols, that should be
4202 looked after. This function assumes that the buffer is narrowed
4203 to an appropriate container (e.g., a paragraph)."
4211 found)
4276 ;; This is probably a plain link.
4282 ;; Radio link.
4287 "Parse objects between BEG and END and return recursive structure.
4289 Objects are accumulated in ACC.
4291 RESTRICTION is a list of object successors which are allowed in
4292 the current object."
4300 ;; 1. Text before any object. Untabify it.
4305 acc
4309 ;; 2. Object...
4312 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4313 ;; a recursive type.
4321 ;; 3. Text after last object. Untabify it.
4325 acc
4329 ;; Result.
4330 acc)))
4333 \f
4334 ;;; Towards A Bijective Process
4335 ;;
4336 ;; The parse tree obtained with `org-element-parse-buffer' is really
4337 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4338 ;; interpreted and expanded into a string with canonical Org syntax.
4339 ;; Hence `org-element-interpret-data'.
4340 ;;
4341 ;; The function relies internally on
4342 ;; `org-element--interpret-affiliated-keywords'.
4344 ;;;###autoload
4346 "Interpret DATA as Org syntax.
4348 DATA is a parse tree, an element, an object or a secondary string
4349 to interpret.
4351 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4352 new types that should be treated as objects. An unknown type not
4353 belonging to this list is seen as a pseudo-element instead. Both
4354 pseudo-objects and pseudo-elements are transparent entities, i.e.
4355 only their contents are interpreted.
4357 Return Org syntax as a string."
4361 "Interpret DATA as Org syntax.
4363 DATA is a parse tree, an element, an object or a secondary string
4364 to interpret. PARENT is used for recursive calls. It contains
4365 the element or object containing data, or nil. PSEUDO-OBJECTS
4366 are list of symbols defining new element or object types.
4367 Unknown types that don't belong to this list are treated as
4368 pseudo-elements instead.
4370 Return Org syntax as a string."
4372 ;; Find interpreter for current object or element. If it
4373 ;; doesn't exist (e.g. this is a pseudo object or element),
4374 ;; return contents, if any.
4380 ;; Secondary string.
4386 ;; Full Org document.
4392 ;; Plain text: return it.
4394 ;; Element or object without contents.
4396 ;; Element or object with contents.
4399 ;; Recursively interpret contents.
4405 data
4406 ;; Fix indentation of elements containing
4407 ;; objects. We ignore `table-row' elements
4408 ;; as they are one line long anyway.
4410 data
4411 ;; When normalizing first paragraph of an
4412 ;; item or a footnote-definition, ignore
4413 ;; first line's indentation.
4420 ;; Build white spaces. If no `:post-blank' property is
4421 ;; specified, assume its value is 0.
4432 "Return ELEMENT's affiliated keywords as Org syntax.
4433 If there is no affiliated keyword, return the empty string."
4443 ": "
4446 value)
4454 ;; All attribute keywords can have multiple lines.
4460 ;; List all ELEMENT's properties matching an attribute line or an
4461 ;; affiliated keyword, but ignore translated keywords since they
4462 ;; cannot belong to the property list.
4469 org-element-keyword-translation-alist)))))
4470 collect prop)
4473 ;; Because interpretation of the parse tree must return the same
4474 ;; number of blank lines between elements and the same number of white
4475 ;; space after objects, some special care must be given to white
4476 ;; spaces.
4477 ;;
4478 ;; The first function, `org-element-normalize-string', ensures any
4479 ;; string different from the empty string will end with a single
4480 ;; newline character.
4481 ;;
4482 ;; The second function, `org-element-normalize-contents', removes
4483 ;; global indentation from the contents of the current element.
4486 "Ensure string S ends with a single newline character.
4488 If S isn't a string return it unchanged. If S is the empty
4489 string, return it. Otherwise, return a new string with a single
4490 newline character at its end."
4498 "Normalize plain text in ELEMENT's contents.
4500 ELEMENT must only contain plain text and objects.
4502 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4503 indentation to compute maximal common indentation.
4505 Return the normalized element that is element with global
4506 indentation removed from its contents. The function assumes that
4507 indentation is not done with TAB characters."
4509 find-min-ind ; For byte-compiler.
4511 ;; Return minimal common indentation within BLOB. This is
4512 ;; done by walking recursively BLOB and updating MIN-IND
4513 ;; along the way. FIRST-FLAG is non-nil when the first
4514 ;; string hasn't been seen yet. It is required as this
4515 ;; string is the only one whose indentation doesn't happen
4516 ;; after a newline character.
4523 ;; An indentation of zero means no string will be
4524 ;; modified. Quit the process.
4534 ;; Find minimal indentation in ELEMENT.
4537 ;; Build ELEMENT back, replacing each string with the same
4538 ;; string minus common indentation.
4543 ;; Return BLOB with all its strings indentation
4544 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4545 ;; is non-nil when the first string hasn't been seen
4546 ;; yet.
4561 org-element-recursive-objects)
4565 blob))))
4569 \f
4570 ;;; Cache
4571 ;;
4572 ;; Implement a caching mechanism for `org-element-at-point' and
4573 ;; `org-element-context', which see.
4574 ;;
4575 ;; A single public function is provided: `org-element-cache-reset'.
4576 ;;
4577 ;; Cache is enabled by default, but can be disabled globally with
4578 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4579 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4580 ;; can be tweaked to control caching behaviour.
4581 ;;
4582 ;; Internally, parsed elements are stored in an AVL tree,
4583 ;; `org-element--cache'. This tree is updated lazily: whenever
4584 ;; a change happens to the buffer, a synchronization request is
4585 ;; registered in `org-element--cache-sync-requests' (see
4586 ;; `org-element--cache-submit-request'). During idle time, requests
4587 ;; are processed by `org-element--cache-sync'. Synchronization also
4588 ;; happens when an element is required from the cache. In this case,
4589 ;; the process stops as soon as the needed element is up-to-date.
4590 ;;
4591 ;; A synchronization request can only apply on a synchronized part of
4592 ;; the cache. Therefore, the cache is updated at least to the
4593 ;; location where the new request applies. Thus, requests are ordered
4594 ;; from left to right and all elements starting before the first
4595 ;; request are correct. This property is used by functions like
4596 ;; `org-element--cache-find' to retrieve elements in the part of the
4597 ;; cache that can be trusted.
4598 ;;
4599 ;; A request applies to every element, starting from its original
4600 ;; location (or key, see below). When a request is processed, it
4601 ;; moves forward and may collide the next one. In this case, both
4602 ;; requests are merged into a new one that starts from that element.
4603 ;; As a consequence, the whole synchronization complexity does not
4604 ;; depend on the number of pending requests, but on the number of
4605 ;; elements the very first request will be applied on.
4606 ;;
4607 ;; Elements cannot be accessed through their beginning position, which
4608 ;; may or may not be up-to-date. Instead, each element in the tree is
4609 ;; associated to a key, obtained with `org-element--cache-key'. This
4610 ;; mechanism is robust enough to preserve total order among elements
4611 ;; even when the tree is only partially synchronized.
4612 ;;
4613 ;; Objects contained in an element are stored in a hash table,
4614 ;; `org-element--cache-objects'.
4618 "Non nil when Org parser should cache its results.
4625 "Maximum duration, as a time value, for a cache synchronization.
4626 If the synchronization is not over after this delay, the process
4627 pauses and resumes after `org-element-cache-sync-break'
4631 "Duration, as a time value, of the pause between synchronizations.
4635 ;;;; Data Structure
4638 "AVL tree used to cache elements.
4639 Each node of the tree contains an element. Comparison is done
4640 with `org-element--cache-compare'. This cache is used in
4644 "Hash table used as to cache objects.
4645 Key is an element, as returned by `org-element-at-point', and
4646 value is an alist where each association is:
4648 \(PARENT COMPLETEP . OBJECTS)
4650 where PARENT is an element or object, COMPLETEP is a boolean,
4651 non-nil when all direct children of parent are already cached and
4652 OBJECTS is a list of such children, as objects, from farthest to
4653 closest.
4656 contained within a paragraph
4660 If the paragraph is completely parsed, OBJECTS-DATA will be
4662 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4663 \(BOLD-OBJECT t ENTITY-OBJECT))
4665 whereas in a partially parsed paragraph, it could be
4667 \((PARAGRAPH nil ENTITY-OBJECT))
4672 "List of pending synchronization requests.
4674 A request is a vector with the following pattern:
4676 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4678 Processing a synchronization request consists of three phases:
4680 0. Delete modified elements,
4681 1. Fill missing area in cache,
4682 2. Shift positions and re-parent elements after the changes.
4684 During phase 0, NEXT is the key of the first element to be
4685 removed, BEG and END is buffer position delimiting the
4686 modifications. Elements starting between them (inclusive) are
4687 removed and so are those contained within OUTREACH. PARENT, when
4688 non-nil, is the parent of the first element to be removed.
4690 During phase 1, NEXT is the key of the next known element in
4691 cache and BEG its beginning position. Parse buffer between that
4692 element and the one before it in order to determine the parent of
4693 the next element. Set PARENT to the element containing NEXT.
4695 During phase 2, NEXT is the key of the next element to shift in
4696 the parse tree. All elements starting from this one have their
4697 properties relatives to buffer positions shifted by integer
4698 OFFSET and, if they belong to element PARENT, are adopted by it.
4706 "Hash table used to store keys during synchronization.
4710 "Return a unique key for ELEMENT in cache tree.
4712 Keys are used to keep a total order among elements in the cache.
4713 Comparison is done with `org-element--cache-key-less-p'.
4715 When no synchronization is taking place, a key is simply the
4716 beginning position of the element, or that position plus one in
4717 the case of an first item (respectively row) in
4718 a list (respectively a table).
4720 During a synchronization, the key is the one the element had when
4721 the cache was synchronized for the last time. Elements added to
4722 cache during the synchronization get a new key generated with
4723 `org-element--cache-generate-key'.
4725 Such keys are stored in `org-element--cache-sync-keys'. The hash
4726 table is cleared once the synchronization is complete."
4729 ;; Increase beginning position of items (respectively
4730 ;; table rows) by one, so the first item can get
4731 ;; a different key from its parent list (respectively
4732 ;; table).
4735 begin)))
4738 key))))
4741 "Generate a key between LOWER and UPPER.
4743 LOWER and UPPER are integers or lists, possibly empty.
4745 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4746 a unique key, as an integer or a list of integers, according to
4747 the following rules:
4749 - LOWER and UPPER are compared level-wise until values differ.
4751 - If, at a given level, LOWER and UPPER differ from more than
4752 2, the new key shares all the levels above with LOWER and
4753 gets a new level. Its value is the mean between LOWER and
4754 UPPER:
4756 \(1 2) + (1 4) --> (1 3)
4758 - If LOWER has no value to compare with, it is assumed that its
4759 value is `most-negative-fixnum'. E.g.,
4761 \(1 1) + (1 1 2)
4763 is equivalent to
4765 \(1 1 m) + (1 1 2)
4767 where m is `most-negative-fixnum'. Likewise, if UPPER is
4768 short of levels, the current value is `most-positive-fixnum'.
4770 - If they differ from only one, the new key inherits from
4771 current LOWER level and fork it at the next level. E.g.,
4773 \(2 1) + (3 3)
4775 is equivalent to
4777 \(2 1) + (2 M)
4779 where M is `most-positive-fixnum'.
4781 - If the key is only one level long, it is returned as an
4782 integer:
4784 \(1 2) + (3 2) --> 2
4786 When they are not equals, the function assumes that LOWER is
4787 lesser than UPPER, per `org-element--cache-key-less-p'."
4791 skip-upper key)
4802 ;; When at a given level, LOWER and UPPER differ from
4803 ;; 1, ignore UPPER altogether. Instead create a key
4804 ;; between LOWER and the greatest key with the same
4805 ;; prefix as LOWER so far.
4811 "Non-nil if key A is less than key B.
4812 A and B are either integers or lists of integers, as returned by
4813 `org-element--cache-key'."
4821 ;; If A is empty, either keys are equal (B is also empty) and
4822 ;; we return nil, or A is lesser than B (B is longer) and we
4823 ;; return a non-nil value.
4824 ;;
4825 ;; If A is not empty, B is necessarily empty and A is greater
4826 ;; than B (A is longer). Therefore, return nil.
4830 "Non-nil when element A is located before element B."
4835 "Return root value in cache.
4836 This function assumes `org-element--cache' is a valid AVL tree."
4840 ;;;; Tools
4843 "Non-nil when cache is active in current buffer."
4848 "Find element in cache starting at POS or before.
4850 POS refers to a buffer position.
4852 When optional argument SIDE is non-nil, the function checks for
4853 elements starting at or past POS instead. If SIDE is `both', the
4854 function returns a cons cell where car is the first element
4855 starting at or before POS and cdr the first element starting
4856 after POS.
4858 The function can only find elements in the synchronized part of
4859 the cache."
4863 lower upper)
4878 ;; We found an element in cache starting at POS. If `side'
4879 ;; is `both' we also want the next one in order to generate
4880 ;; a key in-between.
4881 ;;
4882 ;; If the element is the first row or item in a table or
4883 ;; a plain list, we always return the table or the plain
4884 ;; list.
4885 ;;
4886 ;; In any other case, we return the element found.
4895 lower parent
4896 upper parent)))))
4899 lower element
4900 upper element)))))
4907 "Store ELEMENT in current buffer's cache, if allowed.
4908 When optional argument DATA is non-nil, assume is it object data
4909 relative to ELEMENT and store it in the objects cache."
4913 ;; During synchronization, first build an appropriate key
4914 ;; for the new element so `avl-tree-enter' can insert it at
4915 ;; the right spot in the cache.
4924 org-element--cache-sync-keys)))
4926 ;; Headlines are not stored in cache, so objects in titles are
4927 ;; not stored either.
4932 "Remove ELEMENT from cache.
4933 Assume ELEMENT belongs to cache and that a cache is active."
4938 ;;;; Synchronization
4941 "Set idle timer for cache synchronization in BUFFER."
4948 org-element-cache-sync-idle-time))
4949 nil
4950 #'org-element--cache-sync
4951 buffer)))
4954 "Non-nil when synchronization process should be interrupted.
4955 TIME-LIMIT is a time value or nil."
4961 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4963 Properties containing buffer positions are `:begin', `:end',
4964 `:contents-begin', `:contents-end' and `:structure'. When
4965 optional argument PROPS is a list of keywords, only shift
4966 properties provided in that list.
4968 Properties are modified by side-effect."
4970 ;; Shift `:structure' property for the first plain list only: it
4971 ;; is the only one that really matters and it prevents from
4972 ;; shifting it more than once.
4986 "Synchronize cache with recent modification in BUFFER.
4988 When optional argument THRESHOLD is non-nil, do the
4989 synchronization for all elements starting before or at threshold,
4990 then exit. Otherwise, synchronize cache for as long as
4991 `org-element-cache-sync-duration' or until Emacs leaves idle
4992 state.
4994 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4995 not registered yet in the cache are going to happen. It is used
4996 in `org-element--cache-submit-request', where cache is partially
4997 updated before current modification are actually submitted."
5008 request
5010 threshold
5013 org-element-cache-sync-duration))
5014 future-change)
5015 ;; Request processed. Merge current and next offsets and
5016 ;; transfer ending position.
5022 ;; If more requests are awaiting, set idle timer accordingly.
5023 ;; Otherwise, reset keys.
5030 "Process synchronization REQUEST for all entries before NEXT.
5032 REQUEST is a vector, built by `org-element--cache-submit-request'.
5034 NEXT is a cache key, as returned by `org-element--cache-key'.
5036 When non-nil, THRESHOLD is a buffer position. Synchronization
5037 stops as soon as a shifted element begins after it.
5039 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5040 after this time or when Emacs exits idle state.
5042 When non-nil, FUTURE-CHANGE is a buffer position where changes
5043 not registered yet in the cache are going to happen. See
5044 `org-element--cache-submit-request' for more information.
5046 Throw `interrupt' if the process stops before completing the
5047 request."
5050 ;; Phase 0.
5051 ;;
5052 ;; Delete all elements starting after BEG, but not after buffer
5053 ;; position END or past element with key NEXT.
5054 ;;
5055 ;; At each iteration, we start again at tree root since
5056 ;; a deletion modifies structure of the balanced tree.
5064 ;; Find first element in cache with key BEG or after it.
5074 data-key key
5077 data-key key
5078 node nil)))))
5087 up))
5093 ;; No element starting after modifications left in
5094 ;; cache: further processing is futile.
5097 ;; Phase 1.
5098 ;;
5099 ;; Phase 0 left a hole in the cache. Some elements after it
5100 ;; could have parents within. For example, in the following
5101 ;; buffer:
5102 ;;
5103 ;; - item
5104 ;;
5105 ;;
5106 ;; Paragraph1
5107 ;;
5108 ;; Paragraph2
5109 ;;
5110 ;; if we remove a blank line between "item" and "Paragraph1",
5111 ;; everything down to "Paragraph2" is removed from cache. But
5112 ;; the paragraph now belongs to the list, and its `:parent'
5113 ;; property no longer is accurate.
5114 ;;
5115 ;; Therefore we need to parse again elements in the hole, or at
5116 ;; least in its last section, so that we can re-parent
5117 ;; subsequent elements, during phase 2.
5118 ;;
5119 ;; Note that we only need to get the parent from the first
5120 ;; element in cache after the hole.
5121 ;;
5122 ;; When next key is lesser or equal to the current one, delegate
5123 ;; phase 1 processing to next request in order to preserve key
5124 ;; order among requests.
5132 ;; Next element will start at its beginning position plus
5133 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5134 ;; contains the real beginning position of the first element to
5135 ;; shift and re-parent.
5139 ;; Changes are going to happen around this element and
5140 ;; they will trigger another phase 1 request. Skip the
5141 ;; current one.
5147 ;; Phase 2.
5148 ;;
5149 ;; Shift all elements starting from key START, but before NEXT, by
5150 ;; OFFSET, and re-parent them when appropriate.
5151 ;;
5152 ;; Elements are modified by side-effect so the tree structure
5153 ;; remains intact.
5154 ;;
5155 ;; Once THRESHOLD, if any, is reached, or once there is an input
5156 ;; pending, exit. Before leaving, the current synchronization
5157 ;; request is updated.
5164 exit-flag)
5165 ;; No re-parenting nor shifting planned: request is over.
5175 ;; We reached NEXT. Request is complete.
5177 ;; Handle interruption request. Update current request.
5182 ;; Shift element.
5185 ;; Shift associated objects data, if any.
5190 ;; Update PARENT and re-parent DATA, only when
5191 ;; necessary. Propagate new structures for lists.
5205 ;; Cache is up-to-date past THRESHOLD. Request
5206 ;; interruption.
5211 ;; We reached end of tree: synchronization complete.
5212 t)))
5215 "Parse elements in current section, down to POS.
5217 Start parsing from the closest between the last known element in
5218 cache or headline above. Return the smallest element containing
5219 POS.
5221 When optional argument SYNCP is non-nil, return the parent of the
5222 element containing POS instead. In that case, it is also
5223 possible to provide TIME-LIMIT, which is a time value specifying
5224 when the parsing should stop. The function throws `interrupt' if
5225 the process stopped before finding the expected result."
5232 element next mode)
5234 ;; Nothing in cache before point: start parsing from first
5235 ;; element following headline above, or first element in
5236 ;; buffer.
5243 ;; Cache returned exact match: return it.
5246 ;; There's a headline between cached value and POS: cached
5247 ;; value is invalid. Start parsing from first element
5248 ;; following the headline.
5255 ;; Check if CACHED or any of its ancestors contain point.
5256 ;;
5257 ;; If there is such an element, we inspect it in order to know
5258 ;; if we return it or if we need to parse its contents.
5259 ;; Otherwise, we just start parsing from current location,
5260 ;; which is right after the top-most element containing
5261 ;; CACHED.
5262 ;;
5263 ;; As a special case, if POS is at the end of the buffer, we
5264 ;; want to return the innermost element ending there.
5265 ;;
5266 ;; Also, if we find an ancestor and discover that we need to
5267 ;; parse its contents, make sure we don't start from
5268 ;; `:contents-begin', as we would otherwise go past CACHED
5269 ;; again. Instead, in that situation, we will resume parsing
5270 ;; from NEXT, which is located after CACHED or its higher
5271 ;; ancestor not containing point.
5283 ;; Parse successively each element until we reach POS.
5296 end 'element mode
5303 ;; Skip any element ending before point. Also skip
5304 ;; element ending at point (unless it is also the end of
5305 ;; buffer) since we're sure that another element begins
5306 ;; after it.
5309 ;; A non-greater element contains point: return it.
5312 ;; Otherwise, we have to decide if ELEMENT really
5313 ;; contains POS. In that case we start parsing from
5314 ;; contents' beginning.
5315 ;;
5316 ;; If POS is at contents' beginning but it is also at
5317 ;; the beginning of the first item in a list or a table.
5318 ;; In that case, we need to create an anchor for that
5319 ;; list or table, so return it.
5320 ;;
5321 ;; Also, if POS is at the end of the buffer, no element
5322 ;; can start after it, but more than one may end there.
5323 ;; Arbitrarily, we choose to return the innermost of
5324 ;; such elements.
5337 parent element
5338 end cend))))
5339 ;; Otherwise, return ELEMENT as it is the smallest
5340 ;; element containing POS.
5345 ;;;; Staging Buffer Changes
5351 ;; Blocks
5353 ;; LaTeX environments.
5355 ;; Drawers.
5358 "Regexp matching a sensitive line, structure wise.
5359 A sensitive line is a headline, inlinetask, block, drawer, or
5360 latex-environment boundary. When such a line is modified,
5361 structure changes in the document may propagate in the whole
5365 "Non-nil when a sensitive line is about to be changed.
5369 "Request extension of area going to be modified if needed.
5370 BEG and END are the beginning and end of the range of changed
5371 text. See `before-change-functions' for more information."
5381 'headline
5384 org-element--cache-sensitive-re bottom t)))))))))
5387 "Update buffer modifications for current buffer.
5388 BEG and END are the beginning and end of the range of changed
5389 text, and the length in bytes of the pre-change text replaced by
5390 that range. See `after-change-functions' for more information."
5398 ;; Determine if modified area needs to be extended, according
5399 ;; to both previous and current state. We make a special
5400 ;; case for headline editing: if a headline is modified but
5401 ;; not removed, do not extend.
5410 org-element--cache-sensitive-re bottom t))))
5411 ;; Effectively extend modified area.
5419 ;; Store synchronization request.
5422 ;; Activate a timer to process the request during idle time.
5426 "Return first element to remove from cache.
5428 BEG and END are buffer positions delimiting buffer modifications.
5429 OFFSET is the size of the changes.
5431 Returned element is usually the first element in cache containing
5432 any position between BEG and END. As an exception, greater
5433 elements around the changes that are robust to contents
5434 modifications are preserved and updated according to the
5435 changes."
5445 property-drawer quote-block
5446 special-block))
5449 ;; UP is a robust greater element containing changes.
5450 ;; We only need to extend its ending boundaries.
5456 ;; We're at top level element containing ELEMENT: if it's
5457 ;; altered by buffer modifications, it is first element in
5458 ;; cache to be removed. Otherwise, that first element is the
5459 ;; following one.
5460 ;;
5461 ;; As a special case, do not remove BEFORE if it is a robust
5462 ;; container for current changes.
5464 before)))))
5467 "Submit a new cache synchronization request for current buffer.
5468 BEG and END are buffer positions delimiting the minimal area
5469 where cache data should be removed. OFFSET is the size of the
5470 change, as an integer."
5472 delete-to delete-from)
5477 ;; Current changes can be merged with first sync request: we
5478 ;; can save a partial cache synchronization.
5481 ;; If last change happened within area to be removed, extend
5482 ;; boundaries of robust parents, if any. Otherwise, find
5483 ;; first element to remove and update request accordingly.
5495 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5496 ;; if any, is no longer a 0-phase request, thus ensuring that
5497 ;; phases are properly ordered. We need to provide OFFSET as
5498 ;; optional parameter since current modifications are not known
5499 ;; yet to the otherwise correct part of the cache (i.e, before
5500 ;; the first request).
5507 ;; When changes happen before the first known
5508 ;; element, re-parent and shift the rest of the
5509 ;; cache.
5511 ;; Otherwise, we find the first non robust
5512 ;; element containing END. All elements between
5513 ;; FIRST and this one are to be removed.
5514 ;;
5515 ;; Among them, some could be located outside the
5516 ;; synchronized part of the cache, in which case
5517 ;; comparing buffer positions to find them is
5518 ;; useless. Instead, we store the element
5519 ;; containing them in the request itself. All
5520 ;; its children will be removed.
5532 element up))
5535 org-element--cache-sync-requests)
5536 ;; No element to remove. No need to re-parent either.
5537 ;; Simply shift additional elements, if any, by OFFSET.
5542 ;;;; Public Functions
5544 ;;;###autoload
5546 "Reset cache in current buffer.
5547 When optional argument ALL is non-nil, reset cache in all Org
5548 buffers."
5566 ;;;###autoload
5568 "Refresh cache at position POS."
5575 \f
5576 ;;; The Toolbox
5577 ;;
5578 ;; The first move is to implement a way to obtain the smallest element
5579 ;; containing point. This is the job of `org-element-at-point'. It
5580 ;; basically jumps back to the beginning of section containing point
5581 ;; and proceed, one element after the other, with
5582 ;; `org-element--current-element' until the container is found. Note:
5583 ;; When using `org-element-at-point', secondary values are never
5584 ;; parsed since the function focuses on elements, not on objects.
5585 ;;
5586 ;; At a deeper level, `org-element-context' lists all elements and
5587 ;; objects containing point.
5588 ;;
5589 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5590 ;; internally by navigation and manipulation tools.
5593 ;;;###autoload
5595 "Determine closest element around point.
5597 Return value is a list like (TYPE PROPS) where TYPE is the type
5598 of the element and PROPS a plist of properties associated to the
5599 element.
5601 Possible types are defined in `org-element-all-elements'.
5602 Properties depend on element or object type, but always include
5603 `:begin', `:end', `:parent' and `:post-blank' properties.
5605 As a special case, if point is at the very beginning of the first
5606 item in a list or sub-list, returned element will be that list
5607 instead of the item. Likewise, if point is at the beginning of
5608 the first row of a table, returned element will be the table
5609 instead of the first row.
5611 When point is at the end of the buffer, return the innermost
5612 element ending there."
5618 ;; Within blank lines at the beginning of buffer, return nil.
5620 ;; Within blank lines right after a headline, return that
5621 ;; headline.
5625 ;; Otherwise parse until we find element containing ORIGIN.
5632 ;;;###autoload
5634 "Return smallest element or object around point.
5636 Return value is a list like (TYPE PROPS) where TYPE is the type
5637 of the element or object and PROPS a plist of properties
5638 associated to it.
5640 Possible types are defined in `org-element-all-elements' and
5641 `org-element-all-objects'. Properties depend on element or
5642 object type, but always include `:begin', `:end', `:parent' and
5643 `:post-blank'.
5645 As a special case, if point is right after an object and not at
5646 the beginning of any other object, return that object.
5648 Optional argument ELEMENT, when non-nil, is the closest element
5649 containing point, as returned by `org-element-at-point'.
5650 Providing it allows for quicker computation."
5656 ;; If point is inside an element containing objects or
5657 ;; a secondary string, narrow buffer to the container and
5658 ;; proceed with parsing. Otherwise, return ELEMENT.
5660 ;; At a parsed affiliated keyword, check if we're inside main
5661 ;; or dual value.
5668 org-element-parsed-keywords))
5677 ;; Also change type to retrieve correct restrictions.
5679 ;; At an item, objects can only be located within tag, if any.
5689 ;; At an headline or inlinetask, objects are in title.
5696 ;; At a paragraph, a table-row or a verse block, objects are
5697 ;; located within their contents.
5701 ;; CBEG is nil for table rules.
5706 ;; At a parsed keyword, objects are located within value.
5709 org-element-document-properties))
5716 ;; At a planning line, if point is at a timestamp, return it,
5717 ;; otherwise, return element.
5725 ;; All other locations cannot contain objects: bail out.
5735 next object-data last)
5739 ;; When entering PARENT for the first time, get list
5740 ;; of objects within known so far. Store it in
5741 ;; OBJECT-DATA.
5746 ;; Find NEXT object for analysis.
5748 ;; If NEXT is non-nil, we already exhausted the
5749 ;; cache so we can parse buffer to find the object
5750 ;; after it.
5752 ;; Otherwise, check if cache can help us.
5763 ;; Cache contains the information needed.
5766 pos)
5768 pos)
5774 ;; If we have a new object to analyze, store it in
5775 ;; cache. Otherwise record that there is nothing
5776 ;; more to parse in this element at this depth.
5781 ;; Process NEXT, if any, in order to know if we need
5782 ;; to skip it, return it or move into it.
5789 ;; Skip objects ending before point. Also skip
5790 ;; objects ending at point unless it is also the
5791 ;; end of buffer, since we want to return the
5792 ;; innermost object.
5795 ;; For convenience, when object ends at POS,
5796 ;; without any space, store it in LAST, as we
5797 ;; will return it if no object starts here.
5801 ;; If POS is within a container object, move
5802 ;; into that object.
5806 ;; At contents' end, if there is no
5807 ;; space before point, also move into
5808 ;; object, for consistency with
5809 ;; convenience feature above.
5818 next nil
5819 object-data nil))
5820 ;; Otherwise, return NEXT.
5822 ;; Store results in cache, if applicable.
5826 "Non-nil when elements ELEM-A and ELEM-B are nested."
5835 "Swap elements ELEM-A and ELEM-B.
5836 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5837 end of ELEM-A."
5839 ;; There are two special cases when an element doesn't start at bol:
5840 ;; the first paragraph in an item or in a footnote definition.
5842 ;; Only a paragraph without any affiliated keyword can be moved at
5843 ;; ELEM-A position in such a situation. Note that the case of
5844 ;; a footnote definition is impossible: it cannot contain two
5845 ;; paragraphs in a row because it cannot contain a blank line.
5851 ;; In a special situation, ELEM-A will have no indentation. We'll
5852 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5866 ;; Store overlays responsible for visibility status. We
5867 ;; also need to store their boundaries as they will be
5868 ;; removed from buffer.
5875 ;; Get contents.
5883 ;; Restore ex ELEM-A overlays.
5892 ;; Restore ex ELEM-B overlays.
5900 "Remove maximum common indentation in string S and return it.
5901 When optional argument N is a positive integer, remove exactly
5902 that much characters from indentation, if possible, or return
5903 S as-is otherwise. Unlike to `org-remove-indentation', this
5904 function doesn't call `untabify' on S."
5909 ;; Find maximum common indentation, if not specified.
5917 min-ind)))
5919 ;; Remove exactly N indentation, but give up if not possible.
5932 ;; Local variables:
5933 ;; generated-autoload-file: "org-loaddefs.el"
5934 ;; End:
5936 ;;; org-element.el ends here