| blob | a4a9ae6829b3ec6651f2d72d54d238f6cb9451e9 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 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', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `example-block', `export-block', `fixed-width',
50 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
51 ;; `paragraph', `planning', `quote-section', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (i.e. an item tag or an headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements
75 ;; and elements containing objects will also have `:contents-begin'
76 ;; and `:contents-end' properties to delimit contents.
77 ;;
78 ;; Lisp-wise, an element or an object can be represented as a list.
79 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
80 ;; TYPE is a symbol describing the Org element or object.
81 ;; PROPERTIES is the property list attached to it. See docstring of
82 ;; appropriate parsing function to get an exhaustive
83 ;; list.
84 ;; CONTENTS is a list of elements, objects or raw strings contained
85 ;; in the current element or object, when applicable.
86 ;;
87 ;; An Org buffer is a nested list of such elements and objects, whose
88 ;; type is `org-data' and properties is nil.
89 ;;
90 ;; The first part of this file defines Org syntax, while the second
91 ;; one provide accessors and setters functions.
92 ;;
93 ;; The next part implements a parser and an interpreter for each
94 ;; element and object type in Org syntax.
95 ;;
96 ;; The following part creates a fully recursive buffer parser. It
97 ;; also provides a tool to map a function to elements or objects
98 ;; matching some criteria in the parse tree. Functions of interest
99 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
100 ;; extent, `org-element-parse-secondary-string'.
101 ;;
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
104 ;;
105 ;; The library ends by furnishing `org-element-at-point' function, and
106 ;; a way to give information about document structure around point
107 ;; with `org-element-context'.
110 ;;; Code:
116 \f
117 ;;; Definitions And Rules
118 ;;
119 ;; Define elements, greater elements and specify recursive objects,
120 ;; along with the affiliated keywords recognized. Also set up
121 ;; restrictions on recursive objects combinations.
122 ;;
123 ;; These variables really act as a control center for the parsing
124 ;; process.
128 ;; Headlines, inlinetasks.
130 ;; Footnote definitions.
133 ;; Empty lines.
135 ;; Tables (any type).
137 ;; Blocks (any type), Babel calls, drawers (any type),
138 ;; fixed-width areas and keywords. Note: this is only an
139 ;; indication and need some thorough check.
141 ;; Horizontal rules.
143 ;; LaTeX environments.
145 ;; Planning and Clock lines.
147 org-deadline-string
148 org-closed-string
149 org-clock-string))
151 ;; Lists.
158 "Regexp to separate paragraphs in an Org buffer.
160 is not sufficient to know if point is at a paragraph ending. See
165 example-block export-block fixed-width footnote-definition
166 headline horizontal-rule inlinetask item keyword
167 latex-environment node-property paragraph plain-list planning
168 property-drawer quote-block quote-section section special-block
169 src-block table table-row verse-block)
174 item plain-list property-drawer quote-block section
175 special-block table)
180 latex-or-entity line-break link macro radio-target
181 statistics-cookie sub/superscript table-cell target
182 text-markup timestamp)
191 "Alist of translations between object type and successor name.
193 Sharing the same successor comes handy when, for example, the
198 inline-src-block italic line-break latex-fragment link macro
199 radio-target statistics-cookie strike-through subscript superscript
200 table-cell target timestamp underline verbatim)
205 table-cell underline)
215 "Alist between block names and the associated parsing function.
216 Names must be uppercase. Any block whose name has no association
222 Only these types can accept search options and an explicit
228 "List of affiliated keywords as strings.
234 ;; Regular affiliated keywords.
237 "Regexp matching any affiliated keyword.
239 Keyword name is put in match group 1. Moreover, if keyword
240 belongs to `org-element-dual-keywords', put the dual value in
241 match group 2.
249 "Alist of usual translations for keywords.
250 The key is the old name and the value the new one. The property
254 "List of affiliated keywords that can occur more than once in an element.
256 Their value will be consed into a list of strings, which will be
257 returned as the value of the property.
259 This list is checked after translations have been applied. See
260 `org-element-keyword-translation-alist'.
266 "List of affiliated keywords whose value can be parsed.
268 Their value will be stored as a secondary string: a list of
269 strings and objects.
271 This list is checked after translations have been applied. See
275 "List of affiliated keywords which can have a secondary value.
277 In Org syntax, they can be written with optional square brackets
278 before the colons. For example, RESULTS keyword can be
279 associated to a hash value with the following:
281 #+RESULTS[hash-string]: some-source
283 This list is checked after translations have been applied. See
287 "List of properties associated to the whole document.
288 Any keyword in this list will have its value parsed and stored as
295 inline-src-block latex-or-entity line-break link macro
296 radio-target sub/superscript target text-markup
297 timestamp)
299 radio-target statistics-cookie sub/superscript target text-markup
300 timestamp)
312 inline-src-block latex-or-entity line-break link macro
313 radio-target statistics-cookie sub/superscript target text-markup
314 timestamp)
317 latex-or-entity link radio-target sub/superscript target
318 text-markup timestamp)
329 latex-or-entity line-break link macro radio-target
331 "Alist of objects restrictions.
333 CAR is an element or object type containing objects and CDR is
334 a list of successors that will be called within an element or
335 object of such type.
337 For example, in a `radio-target' object, one can only find
338 entities, export snippets, latex-fragments, subscript and
339 superscript.
341 This alist also applies to secondary string. For example, an
342 `headline' type element doesn't directly contain objects, but
353 \f
354 ;;; Accessors and Setters
355 ;;
356 ;; Provide four accessors: `org-element-type', `org-element-property'
357 ;; `org-element-contents' and `org-element-restriction'.
358 ;;
359 ;; Setter functions allow to modify elements by side effect. There is
360 ;; `org-element-put-property', `org-element-set-contents',
361 ;; `org-element-set-element' and `org-element-adopt-element'. Note
362 ;; that `org-element-set-element' and `org-element-adopt-elements' are
363 ;; higher level functions since also update `:parent' property.
366 "Return type of ELEMENT.
368 The function returns the type of the element or object provided.
369 It can also return the following special value:
370 `plain-text' for a string
371 `org-data' for a complete document
372 nil in any other case."
378 "Extract the value from the PROPERTY of an ELEMENT."
382 "Extract contents from an ELEMENT."
386 "Return restriction associated to ELEMENT.
387 ELEMENT can be an element, an object or a symbol representing an
388 element or object type."
390 org-element-object-restrictions)))
393 "In ELEMENT set PROPERTY to VALUE.
394 Return modified element."
397 element)
400 "Set ELEMENT contents to CONTENTS.
401 Return modified element."
407 "Replace element or object OLD with element or object NEW.
408 The function takes care of setting `:parent' property for NEW."
409 ;; Since OLD is going to be changed into NEW by side-effect, first
410 ;; make sure that every element or object within NEW has OLD as
411 ;; parent.
414 ;; Transfer contents.
416 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
417 ;; with NEW's.
420 ;; Transfer type.
424 "Append elements to the contents of another element.
426 PARENT is an element or object. CHILDREN can be elements,
427 objects, or a strings.
429 The function takes care of setting `:parent' property for CHILD.
430 Return parent element."
432 ;; Link every child to PARENT.
436 children)
437 ;; Add CHILDREN at the end of PARENT contents.
439 parent
441 ;; Return modified PARENT element.
442 parent))
445 \f
446 ;;; Greater elements
447 ;;
448 ;; For each greater element type, we define a parser and an
449 ;; interpreter.
450 ;;
451 ;; A parser returns the element or object as the list described above.
452 ;; Most of them accepts no argument. Though, exceptions exist. Hence
453 ;; every element containing a secondary string (see
454 ;; `org-element-secondary-value-alist') will accept an optional
455 ;; argument to toggle parsing of that secondary string. Moreover,
456 ;; `item' parser requires current list's structure as its first
457 ;; element.
458 ;;
459 ;; An interpreter accepts two arguments: the list representation of
460 ;; the element or object, and its contents. The latter may be nil,
461 ;; depending on the element or object considered. It returns the
462 ;; appropriate Org syntax, as a string.
463 ;;
464 ;; Parsing functions must follow the naming convention:
465 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
466 ;; defined in `org-element-greater-elements'.
467 ;;
468 ;; Similarly, interpreting functions must follow the naming
469 ;; convention: org-element-TYPE-interpreter.
470 ;;
471 ;; With the exception of `headline' and `item' types, greater elements
472 ;; cannot contain other greater elements of their own type.
473 ;;
474 ;; Beside implementing a parser and an interpreter, adding a new
475 ;; greater element requires to tweak `org-element--current-element'.
476 ;; Moreover, the newly defined type must be added to both
477 ;; `org-element-all-elements' and `org-element-greater-elements'.
480 ;;;; Center Block
483 "Parse a center block.
485 LIMIT bounds the search. AFFILIATED is a list of which CAR is
486 the buffer position at the beginning of the first affiliated
487 keyword and CDR is a plist of affiliated keywords along with
488 their value.
490 Return a list whose CAR is `center-block' and CDR is a plist
491 containing `:begin', `:end', `:hiddenp', `:contents-begin',
492 `:contents-end' and `:post-blank' keywords.
494 Assume point is at the beginning of the block."
498 ;; Incomplete block: parse it as a paragraph.
502 ;; Empty blocks have no contents.
517 :end end
518 :hiddenp hidden
519 :contents-begin contents-begin
520 :contents-end contents-end
525 "Interpret CENTER-BLOCK element as Org syntax.
526 CONTENTS is the contents of the element."
530 ;;;; Drawer
533 "Parse a drawer.
535 LIMIT bounds the search. AFFILIATED is a list of which CAR is
536 the buffer position at the beginning of the first affiliated
537 keyword and CDR is a plist of affiliated keywords along with
538 their value.
540 Return a list whose CAR is `drawer' and CDR is a plist containing
541 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
542 `:contents-end' and `:post-blank' keywords.
544 Assume point is at beginning of drawer."
547 ;; Incomplete drawer: parse it as a paragraph.
554 ;; Empty drawers have no contents.
569 :end end
570 :drawer-name name
571 :hiddenp hidden
572 :contents-begin contents-begin
573 :contents-end contents-end
578 "Interpret DRAWER element as Org syntax.
579 CONTENTS is the contents of the element."
582 contents))
585 ;;;; Dynamic Block
588 "Parse a dynamic block.
590 LIMIT bounds the search. AFFILIATED is a list of which CAR is
591 the buffer position at the beginning of the first affiliated
592 keyword and CDR is a plist of affiliated keywords along with
593 their value.
595 Return a list whose CAR is `dynamic-block' and CDR is a plist
596 containing `:block-name', `:begin', `:end', `:hiddenp',
597 `:contents-begin', `:contents-end', `:arguments' and
598 `:post-blank' keywords.
600 Assume point is at beginning of dynamic block."
604 ;; Incomplete block: parse it as a paragraph.
612 ;; Empty blocks have no contents.
627 :end end
628 :block-name name
629 :arguments arguments
630 :hiddenp hidden
631 :contents-begin contents-begin
632 :contents-end contents-end
637 "Interpret DYNAMIC-BLOCK element as Org syntax.
638 CONTENTS is the contents of the element."
643 contents))
646 ;;;; Footnote Definition
649 "Parse a footnote definition.
651 LIMIT bounds the search. AFFILIATED is a list of which CAR is
652 the buffer position at the beginning of the first affiliated
653 keyword and CDR is a plist of affiliated keywords along with
654 their value.
656 Return a list whose CAR is `footnote-definition' and CDR is
657 a plist containing `:label', `:begin' `:end', `:contents-begin',
658 `:contents-end' and `:post-blank' keywords.
660 Assume point is at the beginning of the footnote definition."
685 :begin begin
686 :end end
687 :contents-begin contents-begin
688 :contents-end contents-end
693 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
694 CONTENTS is the contents of the footnote-definition."
696 " "
697 contents))
700 ;;;; Headline
703 "Parse an headline.
705 Return a list whose CAR is `headline' and CDR is a plist
706 containing `:raw-value', `:title', `:begin', `:end',
707 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
708 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
709 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
710 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
711 keywords.
713 The plist also contains any property set in the property drawer,
714 with its name in lowercase, the underscores replaced with hyphens
715 and colons at the beginning (i.e. `:custom-id').
717 When RAW-SECONDARY-P is non-nil, headline's title will not be
718 parsed as a secondary string, but as a plain string instead.
720 Assume point is at beginning of the headline."
733 raw-value)))
737 raw-value)))
741 ;; Normalize property names: ":SOME_PROP:" becomes
742 ;; ":some-prop".
754 plist))
772 ;; Clean RAW-VALUE from any quote or comment string.
780 ""
781 raw-value))))
782 ;; Clean TAGS from archive tag, if any.
788 :begin begin
789 :end end
790 :pre-blank
793 :hiddenp hidden
794 :contents-begin contents-begin
795 :contents-end contents-end
796 :level level
798 :tags tags
799 :todo-keyword todo
800 :todo-type todo-type
801 :scheduled scheduled
802 :deadline deadline
803 :timestamp timestamp
804 :clock clock
810 end)
811 :footnote-section-p footnote-section-p
812 :archivedp archivedp
813 :commentedp commentedp
815 standard-props))))
817 headline :title
823 "Interpret HEADLINE element as Org syntax.
824 CONTENTS is the contents of the element."
851 ;; Align tags.
859 ? )
860 tags))
864 tags))))
866 contents)))
869 ;;;; Inlinetask
872 "Parse an inline task.
874 Return a list whose CAR is `inlinetask' and CDR is a plist
875 containing `:title', `:begin', `:end', `:hiddenp',
876 `:contents-begin' and `:contents-end', `:level', `:priority',
877 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
878 `:scheduled', `:deadline', `:timestamp', `:clock' and
879 `:post-blank' keywords.
881 The plist also contains any property set in the property drawer,
882 with its name in lowercase, the underscores replaced with hyphens
883 and colons at the beginning (i.e. `:custom-id').
885 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
886 title will not be parsed as a secondary string, but as a plain
887 string instead.
889 Assume point is at beginning of the inline task."
900 ;; Normalize property names: ":SOME_PROP:" becomes
901 ;; ":some-prop".
913 plist))
938 :begin begin
939 :end end
940 :hiddenp hidden
941 :contents-begin contents-begin
942 :contents-end contents-end
945 :tags tags
946 :todo-keyword todo
947 :todo-type todo-type
948 :scheduled scheduled
949 :deadline deadline
950 :timestamp timestamp
951 :clock clock
953 standard-props
956 inlinetask :title
959 raw-value
961 inlinetask))))))
964 "Interpret INLINETASK element as Org syntax.
965 CONTENTS is the contents of inlinetask."
980 ;; Align tags.
988 ? )
989 tags))
993 tags))))
994 ;; Prefer degenerate inlinetasks when there are no
995 ;; contents.
998 contents
1002 ;;;; Item
1005 "Parse an item.
1007 STRUCT is the structure of the plain list.
1009 Return a list whose CAR is `item' and CDR is a plist containing
1010 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1011 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1012 `:post-blank' keywords.
1014 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1015 any, will not be parsed as a secondary string, but as a plain
1016 string instead.
1018 Assume point is at the beginning of the item."
1042 ;; Ignore tags in un-ordered lists: they are just
1043 ;; a part of item's body.
1049 ;; If first line isn't empty, contents really start
1050 ;; at the text after item's meta-data.
1061 :begin begin
1062 :end end
1063 ;; CONTENTS-BEGIN and CONTENTS-END may be
1064 ;; mixed up in the case of an empty item
1065 ;; separated from the next by a blank line.
1066 ;; Thus ensure the former is always the
1067 ;; smallest.
1070 :checkbox checkbox
1071 :counter counter
1072 :hiddenp hidden
1073 :structure struct
1076 item :tag
1084 "Interpret ITEM element as Org syntax.
1085 CONTENTS is the contents of the element."
1091 ;; Compute indentation.
1096 ;; Indent contents.
1098 bullet
1111 ;;;; Plain List
1114 "Parse a plain list.
1116 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1117 the buffer position at the beginning of the first affiliated
1118 keyword and CDR is a plist of affiliated keywords along with
1119 their value. STRUCTURE is the structure of the plain list being
1120 parsed.
1122 Return a list whose CAR is `plain-list' and CDR is a plist
1123 containing `:type', `:begin', `:end', `:contents-begin' and
1124 `:contents-end', `:structure' and `:post-blank' keywords.
1126 Assume point is at the beginning of the list."
1141 ;; Return value.
1145 :begin begin
1146 :end end
1147 :contents-begin contents-begin
1148 :contents-end contents-end
1149 :structure struct
1154 "Interpret PLAIN-LIST element as Org syntax.
1155 CONTENTS is the contents of the element."
1163 ;;;; Property Drawer
1166 "Parse a property drawer.
1168 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1169 the buffer position at the beginning of the first affiliated
1170 keyword and CDR is a plist of affiliated keywords along with
1171 their value.
1173 Return a list whose CAR is `property-drawer' and CDR is a plist
1174 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1175 `:contents-end' and `:post-blank' keywords.
1177 Assume point is at the beginning of the property drawer."
1182 ;; Incomplete drawer: parse it as a paragraph.
1201 :end end
1202 :hiddenp hidden
1203 :contents-begin contents-begin
1204 :contents-end contents-end
1209 "Interpret PROPERTY-DRAWER element as Org syntax.
1210 CONTENTS is the properties within the drawer."
1214 ;;;; Quote Block
1217 "Parse a quote block.
1219 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1220 the buffer position at the beginning of the first affiliated
1221 keyword and CDR is a plist of affiliated keywords along with
1222 their value.
1224 Return a list whose CAR is `quote-block' and CDR is a plist
1225 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1226 `:contents-end' and `:post-blank' keywords.
1228 Assume point is at the beginning of the block."
1232 ;; Incomplete block: parse it as a paragraph.
1237 ;; Empty blocks have no contents.
1252 :end end
1253 :hiddenp hidden
1254 :contents-begin contents-begin
1255 :contents-end contents-end
1260 "Interpret QUOTE-BLOCK element as Org syntax.
1261 CONTENTS is the contents of the element."
1265 ;;;; Section
1268 "Parse a section.
1270 LIMIT bounds the search.
1272 Return a list whose CAR is `section' and CDR is a plist
1273 containing `:begin', `:end', `:contents-begin', `contents-end'
1274 and `:post-blank' keywords."
1276 ;; Beginning of section is the beginning of the first non-blank
1277 ;; line after previous headline.
1286 :end end
1287 :contents-begin begin
1288 :contents-end pos-before-blank
1292 "Interpret SECTION element as Org syntax.
1293 CONTENTS is the contents of the element."
1294 contents)
1297 ;;;; Special Block
1300 "Parse a special block.
1302 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1303 the buffer position at the beginning of the first affiliated
1304 keyword and CDR is a plist of affiliated keywords along with
1305 their value.
1307 Return a list whose CAR is `special-block' and CDR is a plist
1308 containing `:type', `:begin', `:end', `:hiddenp',
1309 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1311 Assume point is at the beginning of the block."
1318 ;; Incomplete block: parse it as a paragraph.
1323 ;; Empty blocks have no contents.
1338 :begin begin
1339 :end end
1340 :hiddenp hidden
1341 :contents-begin contents-begin
1342 :contents-end contents-end
1347 "Interpret SPECIAL-BLOCK element as Org syntax.
1348 CONTENTS is the contents of the element."
1353 \f
1354 ;;; Elements
1355 ;;
1356 ;; For each element, a parser and an interpreter are also defined.
1357 ;; Both follow the same naming convention used for greater elements.
1358 ;;
1359 ;; Also, as for greater elements, adding a new element type is done
1360 ;; through the following steps: implement a parser and an interpreter,
1361 ;; tweak `org-element--current-element' so that it recognizes the new
1362 ;; type and add that new type to `org-element-all-elements'.
1363 ;;
1364 ;; As a special case, when the newly defined type is a block type,
1365 ;; `org-element-block-name-alist' has to be modified accordingly.
1368 ;;;; Babel Call
1371 "Parse a babel call.
1373 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1374 the buffer position at the beginning of the first affiliated
1375 keyword and CDR is a plist of affiliated keywords along with
1376 their value.
1378 Return a list whose CAR is `babel-call' and CDR is a plist
1379 containing `:begin', `:end', `:info' and `:post-blank' as
1380 keywords."
1393 :end end
1394 :info info
1399 "Interpret BABEL-CALL element as Org syntax.
1400 CONTENTS is nil."
1406 ;; Remove redundant square brackets.
1411 ;;;; Clock
1414 "Parse a clock.
1416 LIMIT bounds the search.
1418 Return a list whose CAR is `clock' and CDR is a plist containing
1419 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1420 as keywords."
1440 :value value
1441 :time time
1442 :begin begin
1443 :end end
1447 "Interpret CLOCK element as Org syntax.
1448 CONTENTS is nil."
1455 "%2s:%02s"
1459 ;;;; Comment
1462 "Parse a comment.
1464 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1465 the buffer position at the beginning of the first affiliated
1466 keyword and CDR is a plist of affiliated keywords along with
1467 their value.
1469 Return a list whose CAR is `comment' and CDR is a plist
1470 containing `:begin', `:end', `:value' and `:post-blank'
1471 keywords.
1473 Assume point is at comment beginning."
1481 ;; Get comments ending.
1484 ;; Accumulate lines without leading hash and first
1485 ;; whitespace.
1500 :end end
1501 :value value
1506 "Interpret COMMENT element as Org syntax.
1507 CONTENTS is nil."
1511 ;;;; Comment Block
1514 "Parse an export block.
1516 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1517 the buffer position at the beginning of the first affiliated
1518 keyword and CDR is a plist of affiliated keywords along with
1519 their value.
1521 Return a list whose CAR is `comment-block' and CDR is a plist
1522 containing `:begin', `:end', `:hiddenp', `:value' and
1523 `:post-blank' keywords.
1525 Assume point is at comment block beginning."
1529 ;; Incomplete block: parse it as a paragraph.
1543 contents-begin contents-end)))
1547 :end end
1548 :value value
1549 :hiddenp hidden
1554 "Interpret COMMENT-BLOCK element as Org syntax.
1555 CONTENTS is nil."
1560 ;;;; Example Block
1563 "Parse an example block.
1565 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1566 the buffer position at the beginning of the first affiliated
1567 keyword and CDR is a plist of affiliated keywords along with
1568 their value.
1570 Return a list whose CAR is `example-block' and CDR is a plist
1571 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1572 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1573 `:switches', `:value' and `:post-blank' keywords."
1577 ;; Incomplete block: parse it as a paragraph.
1584 ;; Switches analysis
1589 ;; Should labels be retained in (or stripped from) example
1590 ;; blocks?
1595 ;; What should code-references use - labels or
1596 ;; line-numbers?
1603 ;; Standard block parsing.
1609 contents-begin contents-end)))
1619 :end end
1620 :value value
1621 :switches switches
1622 :number-lines number-lines
1623 :preserve-indent preserve-indent
1624 :retain-labels retain-labels
1625 :use-labels use-labels
1626 :label-fmt label-fmt
1627 :hiddenp hidden
1632 "Interpret EXAMPLE-BLOCK element as Org syntax.
1633 CONTENTS is nil."
1642 ;;;; Export Block
1645 "Parse an export block.
1647 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1648 the buffer position at the beginning of the first affiliated
1649 keyword and CDR is a plist of affiliated keywords along with
1650 their value.
1652 Return a list whose CAR is `export-block' and CDR is a plist
1653 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1654 `:post-blank' keywords.
1656 Assume point is at export-block beginning."
1663 ;; Incomplete block: parse it as a paragraph.
1677 contents-end)))
1681 :end end
1682 :type type
1683 :value value
1684 :hiddenp hidden
1689 "Interpret EXPORT-BLOCK element as Org syntax.
1690 CONTENTS is nil."
1697 ;;;; Fixed-width
1700 "Parse a fixed-width section.
1702 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1703 the buffer position at the beginning of the first affiliated
1704 keyword and CDR is a plist of affiliated keywords along with
1705 their value.
1707 Return a list whose CAR is `fixed-width' and CDR is a plist
1708 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1710 Assume point is at the beginning of the fixed-width area."
1713 value
1718 ;; Accumulate text without starting colons.
1732 :end end
1733 :value value
1738 "Interpret FIXED-WIDTH element as Org syntax.
1739 CONTENTS is nil."
1744 ;;;; Horizontal Rule
1747 "Parse an horizontal rule.
1749 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1750 the buffer position at the beginning of the first affiliated
1751 keyword and CDR is a plist of affiliated keywords along with
1752 their value.
1754 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1755 containing `:begin', `:end' and `:post-blank' keywords."
1765 :end end
1770 "Interpret HORIZONTAL-RULE element as Org syntax.
1771 CONTENTS is nil."
1775 ;;;; Keyword
1778 "Parse a keyword at point.
1780 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1781 the buffer position at the beginning of the first affiliated
1782 keyword and CDR is a plist of affiliated keywords along with
1783 their value.
1785 Return a list whose CAR is `keyword' and CDR is a plist
1786 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1787 keywords."
1802 :value value
1803 :begin begin
1804 :end end
1809 "Interpret KEYWORD element as Org syntax.
1810 CONTENTS is nil."
1816 ;;;; Latex Environment
1819 "Parse a LaTeX environment.
1821 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1822 the buffer position at the beginning of the first affiliated
1823 keyword and CDR is a plist of affiliated keywords along with
1824 their value.
1826 Return a list whose CAR is `latex-environment' and CDR is a plist
1827 containing `:begin', `:end', `:value' and `:post-blank'
1828 keywords.
1830 Assume point is at the beginning of the latex environment."
1849 :end end
1850 :value value
1855 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1856 CONTENTS is nil."
1860 ;;;; Node Property
1863 "Parse a node-property at point.
1865 LIMIT bounds the search.
1867 Return a list whose CAR is `node-property' and CDR is a plist
1868 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1869 keywords."
1881 :value value
1882 :begin begin
1883 :end end
1887 "Interpret NODE-PROPERTY element as Org syntax.
1888 CONTENTS is nil."
1894 ;;;; Paragraph
1897 "Parse a paragraph.
1899 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1900 the buffer position at the beginning of the first affiliated
1901 keyword and CDR is a plist of affiliated keywords along with
1902 their value.
1904 Return a list whose CAR is `paragraph' and CDR is a plist
1905 containing `:begin', `:end', `:contents-begin' and
1906 `:contents-end' and `:post-blank' keywords.
1908 Assume point is at the beginning of the paragraph."
1917 limit
1918 ;; A matching `org-element-paragraph-separate' is not
1919 ;; necessarily the end of the paragraph. In
1920 ;; particular, lines starting with # or : as a first
1921 ;; non-space character are ambiguous. We have check
1922 ;; if they are valid Org syntax (i.e. not an
1923 ;; incomplete keyword).
1927 ;; There's no ambiguity for other symbols or
1928 ;; empty lines: stop here.
1930 ;; Stop at valid fixed-width areas.
1932 ;; Stop at drawers.
1937 ;; Stop at valid comments.
1939 ;; Stop at valid dynamic blocks.
1944 ;; Stop at valid blocks.
1951 limit t)))
1952 ;; Stop at valid latex environments.
1959 limit t)))
1960 ;; Stop at valid keywords.
1962 ;; Skip everything else.
1980 :end end
1981 :contents-begin contents-begin
1982 :contents-end contents-end
1987 "Interpret PARAGRAPH element as Org syntax.
1988 CONTENTS is the contents of the element."
1989 contents)
1992 ;;;; Planning
1995 "Parse a planning.
1997 LIMIT bounds the search.
1999 Return a list whose CAR is `planning' and CDR is a plist
2000 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2001 and `:post-blank' keywords."
2011 closed deadline scheduled)
2025 :deadline deadline
2026 :scheduled scheduled
2027 :begin begin
2028 :end end
2032 "Interpret PLANNING element as Org syntax.
2033 CONTENTS is nil."
2035 'identity
2047 ;;;; Quote Section
2050 "Parse a quote section.
2052 LIMIT bounds the search.
2054 Return a list whose CAR is `quote-section' and CDR is a plist
2055 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2057 Assume point is at beginning of the section."
2068 :end end
2069 :value value
2073 "Interpret QUOTE-SECTION element as Org syntax.
2074 CONTENTS is nil."
2078 ;;;; Src Block
2081 "Parse a src block.
2083 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2084 the buffer position at the beginning of the first affiliated
2085 keyword and CDR is a plist of affiliated keywords along with
2086 their value.
2088 Return a list whose CAR is `src-block' and CDR is a plist
2089 containing `:language', `:switches', `:parameters', `:begin',
2090 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2091 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2092 `:post-blank' keywords.
2094 Assume point is at the beginning of the block."
2097 limit t)))
2098 ;; Incomplete block: parse it as a paragraph.
2103 ;; Get language as a string.
2112 ;; Get switches.
2114 ;; Get parameters.
2116 ;; Switches analysis
2124 ;; Should labels be retained in (or stripped from)
2125 ;; src blocks?
2130 ;; What should code-references use - labels or
2131 ;; line-numbers?
2135 ;; Get visibility status.
2137 ;; Retrieve code.
2143 ;; Get position after ending blank lines.
2154 :begin begin
2155 :end end
2156 :number-lines number-lines
2157 :preserve-indent preserve-indent
2158 :retain-labels retain-labels
2159 :use-labels use-labels
2160 :label-fmt label-fmt
2161 :hiddenp hidden
2162 :value value
2167 "Interpret SRC-BLOCK element as Org syntax.
2168 CONTENTS is nil."
2191 ;;;; Table
2194 "Parse a table at point.
2196 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2197 the buffer position at the beginning of the first affiliated
2198 keyword and CDR is a plist of affiliated keywords along with
2199 their value.
2201 Return a list whose CAR is `table' and CDR is a plist containing
2202 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2203 `:contents-end', `:value' and `:post-blank' keywords.
2205 Assume point is at the beginning of the table."
2219 acc))
2227 :end end
2228 :type type
2229 :tblfm tblfm
2230 ;; Only `org' tables have contents. `table.el' tables
2231 ;; use a `:value' property to store raw table as
2232 ;; a string.
2237 table-begin table-end))
2242 "Interpret TABLE element as Org syntax.
2243 CONTENTS is nil."
2254 ;;;; Table Row
2257 "Parse table row at point.
2259 LIMIT bounds the search.
2261 Return a list whose CAR is `table-row' and CDR is a plist
2262 containing `:begin', `:end', `:contents-begin', `:contents-end',
2263 `:type' and `:post-blank' keywords."
2267 ;; A table rule has no contents. In that case, ensure
2268 ;; CONTENTS-BEGIN matches CONTENTS-END.
2280 :begin begin
2281 :end end
2282 :contents-begin contents-begin
2283 :contents-end contents-end
2287 "Interpret TABLE-ROW element as Org syntax.
2288 CONTENTS is the contents of the table row."
2293 ;;;; Verse Block
2296 "Parse a verse block.
2298 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2299 the buffer position at the beginning of the first affiliated
2300 keyword and CDR is a plist of affiliated keywords along with
2301 their value.
2303 Return a list whose CAR is `verse-block' and CDR is a plist
2304 containing `:begin', `:end', `:contents-begin', `:contents-end',
2305 `:hiddenp' and `:post-blank' keywords.
2307 Assume point is at beginning of the block."
2311 ;; Incomplete block: parse it as a paragraph.
2327 :end end
2328 :contents-begin contents-begin
2329 :contents-end contents-end
2330 :hiddenp hidden
2335 "Interpret VERSE-BLOCK element as Org syntax.
2336 CONTENTS is verse block contents."
2340 \f
2341 ;;; Objects
2342 ;;
2343 ;; Unlike to elements, interstices can be found between objects.
2344 ;; That's why, along with the parser, successor functions are provided
2345 ;; for each object. Some objects share the same successor (i.e. `code'
2346 ;; and `verbatim' objects).
2347 ;;
2348 ;; A successor must accept a single argument bounding the search. It
2349 ;; will return either a cons cell whose CAR is the object's type, as
2350 ;; a symbol, and CDR the position of its next occurrence, or nil.
2351 ;;
2352 ;; Successors follow the naming convention:
2353 ;; org-element-NAME-successor, where NAME is the name of the
2354 ;; successor, as defined in `org-element-all-successors'.
2355 ;;
2356 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2357 ;; object types they can contain will be specified in
2358 ;; `org-element-object-restrictions'.
2359 ;;
2360 ;; Adding a new type of object is simple. Implement a successor,
2361 ;; a parser, and an interpreter for it, all following the naming
2362 ;; convention. Register type in `org-element-all-objects' and
2363 ;; successor in `org-element-all-successors'. Maybe tweak
2364 ;; restrictions about it, and that's it.
2367 ;;;; Bold
2370 "Parse bold object at point.
2372 Return a list whose CAR is `bold' and CDR is a plist with
2373 `:begin', `:end', `:contents-begin' and `:contents-end' and
2374 `:post-blank' keywords.
2376 Assume point is at the first star marker."
2388 :end end
2389 :contents-begin contents-begin
2390 :contents-end contents-end
2394 "Interpret BOLD object as Org syntax.
2395 CONTENTS is the contents of the object."
2399 "Search for the next text-markup object.
2401 LIMIT bounds the search.
2403 Return value is a cons cell whose CAR is a symbol among `bold',
2404 `italic', `underline', `strike-through', `code' and `verbatim'
2405 and CDR is beginning position."
2421 ;;;; Code
2424 "Parse code object at point.
2426 Return a list whose CAR is `code' and CDR is a plist with
2427 `:value', `:begin', `:end' and `:post-blank' keywords.
2429 Assume point is at the first tilde marker."
2440 :begin begin
2441 :end end
2445 "Interpret CODE object as Org syntax.
2446 CONTENTS is nil."
2450 ;;;; Entity
2453 "Parse entity at point.
2455 Return a list whose CAR is `entity' and CDR a plist with
2456 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2457 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2458 keywords.
2460 Assume point is at the beginning of the entity."
2462 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2478 :begin begin
2479 :end end
2480 :use-brackets-p bracketsp
2484 "Interpret ENTITY object as Org syntax.
2485 CONTENTS is nil."
2491 "Search for the next latex-fragment or entity object.
2493 LIMIT bounds the search.
2495 Return value is a cons cell whose CAR is `entity' or
2496 `latex-fragment' and CDR is beginning position."
2501 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2508 limit t)
2511 ;; Determine if it's a real entity or a LaTeX command.
2514 ;; No entity nor command: point is at a LaTeX fragment.
2515 ;; Determine its type to get the correct beginning position.
2523 matchers)
2527 ;;;; Export Snippet
2530 "Parse export snippet at point.
2532 Return a list whose CAR is `export-snippet' and CDR a plist with
2533 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2534 keywords.
2536 Assume point is at the beginning of the snippet."
2548 :value value
2549 :begin begin
2550 :end end
2554 "Interpret EXPORT-SNIPPET object as Org syntax.
2555 CONTENTS is nil."
2561 "Search for the next export-snippet object.
2563 LIMIT bounds the search.
2565 Return value is a cons cell whose CAR is `export-snippet' and CDR
2566 its beginning position."
2575 ;;;; Footnote Reference
2578 "Parse footnote reference at point.
2580 Return a list whose CAR is `footnote-reference' and CDR a plist
2581 with `:label', `:type', `:inline-definition', `:begin', `:end'
2582 and `:post-blank' as keywords."
2604 :type type
2605 :begin begin
2606 :end end
2609 footnote-reference :inline-definition
2614 footnote-reference))))))
2617 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2618 CONTENTS is nil."
2628 "Search for the next footnote-reference object.
2630 LIMIT bounds the search.
2632 Return value is a cons cell whose CAR is `footnote-reference' and
2633 CDR is beginning position."
2647 ;;;; Inline Babel Call
2650 "Parse inline babel call at point.
2652 Return a list whose CAR is `inline-babel-call' and CDR a plist
2653 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2655 Assume point is at the beginning of the babel call."
2666 :end end
2667 :info info
2671 "Interpret INLINE-BABEL-CALL object as Org syntax.
2672 CONTENTS is nil."
2678 ;; Remove redundant square brackets.
2681 main-source)
2685 "Search for the next inline-babel-call object.
2687 LIMIT bounds the search.
2689 Return value is a cons cell whose CAR is `inline-babel-call' and
2690 CDR is beginning position."
2692 ;; Use a simplified version of
2693 ;; `org-babel-inline-lob-one-liner-regexp'.
2696 limit t)
2700 ;;;; Inline Src Block
2703 "Parse inline source block at point.
2705 LIMIT bounds the search.
2707 Return a list whose CAR is `inline-src-block' and CDR a plist
2708 with `:begin', `:end', `:language', `:value', `:parameters' and
2709 `:post-blank' as keywords.
2711 Assume point is at the beginning of the inline src block."
2724 :value value
2725 :parameters parameters
2726 :begin begin
2727 :end end
2731 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2732 CONTENTS is nil."
2737 language
2739 body)))
2742 "Search for the next inline-babel-call element.
2744 LIMIT bounds the search.
2746 Return value is a cons cell whose CAR is `inline-babel-call' and
2747 CDR is beginning position."
2753 ;;;; Italic
2756 "Parse italic object at point.
2758 Return a list whose CAR is `italic' and CDR is a plist with
2759 `:begin', `:end', `:contents-begin' and `:contents-end' and
2760 `:post-blank' keywords.
2762 Assume point is at the first slash marker."
2774 :end end
2775 :contents-begin contents-begin
2776 :contents-end contents-end
2780 "Interpret ITALIC object as Org syntax.
2781 CONTENTS is the contents of the object."
2785 ;;;; Latex Fragment
2788 "Parse latex fragment at point.
2790 Return a list whose CAR is `latex-fragment' and CDR a plist with
2791 `:value', `:begin', `:end', and `:post-blank' as keywords.
2793 Assume point is at the beginning of the latex fragment."
2807 ;; None found: it's a macro.
2816 :begin begin
2817 :end end
2821 "Interpret LATEX-FRAGMENT object as Org syntax.
2822 CONTENTS is nil."
2825 ;;;; Line Break
2828 "Parse line break at point.
2830 Return a list whose CAR is `line-break', and CDR a plist with
2831 `:begin', `:end' and `:post-blank' keywords.
2833 Assume point is at the beginning of the line break."
2837 "Interpret LINE-BREAK object as Org syntax.
2838 CONTENTS is nil."
2842 "Search for the next line-break object.
2844 LIMIT bounds the search.
2846 Return value is a cons cell whose CAR is `line-break' and CDR is
2847 beginning position."
2851 ;; A line break can only happen on a non-empty line.
2856 ;;;; Link
2859 "Parse link at point.
2861 Return a list whose CAR is `link' and CDR a plist with `:type',
2862 `:path', `:raw-link', `:application', `:search-option', `:begin',
2863 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2864 keywords.
2866 Assume point is at the beginning of the link."
2869 end contents-begin contents-end link-end post-blank path type
2870 raw-link link search-option application)
2872 ;; Type 1: Text targeted from a radio target.
2877 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2882 ;; RAW-LINK is the original link.
2887 ;; Determine TYPE of link and set PATH accordingly.
2889 ;; File type.
2892 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2895 ;; Id type: PATH is the id.
2898 ;; Code-ref type: PATH is the name of the reference.
2901 ;; Custom-id type: PATH is the name of the custom id.
2904 ;; Fuzzy type: Internal link either matches a target, an
2905 ;; headline name or nothing. PATH is the target or
2906 ;; headline's name.
2908 ;; Type 3: Plain link, i.e. http://orgmode.org
2914 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2921 ;; In any case, deduce end point after trailing white space from
2922 ;; LINK-END variable.
2925 ;; Extract search option and opening application out of
2926 ;; "file"-type links.
2928 ;; Application.
2933 ;; Extract search option from PATH.
2937 ;; Make sure TYPE always report "file".
2941 :path path
2943 :application application
2944 :search-option search-option
2945 :begin begin
2946 :end end
2947 :contents-begin contents-begin
2948 :contents-end contents-end
2952 "Interpret LINK object as Org syntax.
2953 CONTENTS is the contents of the object, or nil."
2958 raw-link
2962 "Search for the next link object.
2964 LIMIT bounds the search.
2966 Return value is a cons cell whose CAR is `link' and CDR is
2967 beginning position."
2976 ;;;; Macro
2979 "Parse macro at point.
2981 Return a list whose CAR is `macro' and CDR a plist with `:key',
2982 `:args', `:begin', `:end', `:value' and `:post-blank' as
2983 keywords.
2985 Assume point is at the macro."
2999 ;; Repair bad splits.
3007 :value value
3008 :args args
3009 :begin begin
3010 :end end
3014 "Interpret MACRO object as Org syntax.
3015 CONTENTS is nil."
3019 "Search for the next macro object.
3021 LIMIT bounds the search.
3023 Return value is cons cell whose CAR is `macro' and CDR is
3024 beginning position."
3028 limit t)
3032 ;;;; Radio-target
3035 "Parse radio target at point.
3037 Return a list whose CAR is `radio-target' and CDR a plist with
3038 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3039 and `:post-blank' as keywords.
3041 Assume point is at the radio target."
3053 :end end
3054 :contents-begin contents-begin
3055 :contents-end contents-end
3056 :post-blank post-blank
3060 "Interpret TARGET object as Org syntax.
3061 CONTENTS is the contents of the object."
3065 "Search for the next radio-target object.
3067 LIMIT bounds the search.
3069 Return value is a cons cell whose CAR is `radio-target' and CDR
3070 is beginning position."
3076 ;;;; Statistics Cookie
3079 "Parse statistics cookie at point.
3081 Return a list whose CAR is `statistics-cookie', and CDR a plist
3082 with `:begin', `:end', `:value' and `:post-blank' keywords.
3084 Assume point is at the beginning of the statistics-cookie."
3095 :end end
3096 :value value
3100 "Interpret STATISTICS-COOKIE object as Org syntax.
3101 CONTENTS is nil."
3105 "Search for the next statistics cookie object.
3107 LIMIT bounds the search.
3109 Return value is a cons cell whose CAR is `statistics-cookie' and
3110 CDR is beginning position."
3116 ;;;; Strike-Through
3119 "Parse strike-through object at point.
3121 Return a list whose CAR is `strike-through' and CDR is a plist
3122 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3123 `:post-blank' keywords.
3125 Assume point is at the first plus sign marker."
3137 :end end
3138 :contents-begin contents-begin
3139 :contents-end contents-end
3143 "Interpret STRIKE-THROUGH object as Org syntax.
3144 CONTENTS is the contents of the object."
3148 ;;;; Subscript
3151 "Parse subscript at point.
3153 Return a list whose CAR is `subscript' and CDR a plist with
3154 `:begin', `:end', `:contents-begin', `:contents-end',
3155 `:use-brackets-p' and `:post-blank' as keywords.
3157 Assume point is at the underscore."
3161 t
3172 :end end
3173 :use-brackets-p bracketsp
3174 :contents-begin contents-begin
3175 :contents-end contents-end
3179 "Interpret SUBSCRIPT object as Org syntax.
3180 CONTENTS is the contents of the object."
3183 contents))
3186 "Search for the next sub/superscript object.
3188 LIMIT bounds the search.
3190 Return value is a cons cell whose CAR is either `subscript' or
3191 `superscript' and CDR is beginning position."
3199 ;;;; Superscript
3202 "Parse superscript at point.
3204 Return a list whose CAR is `superscript' and CDR a plist with
3205 `:begin', `:end', `:contents-begin', `:contents-end',
3206 `:use-brackets-p' and `:post-blank' as keywords.
3208 Assume point is at the caret."
3222 :end end
3223 :use-brackets-p bracketsp
3224 :contents-begin contents-begin
3225 :contents-end contents-end
3229 "Interpret SUPERSCRIPT object as Org syntax.
3230 CONTENTS is the contents of the object."
3233 contents))
3236 ;;;; Table Cell
3239 "Parse table cell at point.
3241 Return a list whose CAR is `table-cell' and CDR is a plist
3242 containing `:begin', `:end', `:contents-begin', `:contents-end'
3243 and `:post-blank' keywords."
3251 :end end
3252 :contents-begin contents-begin
3253 :contents-end contents-end
3257 "Interpret TABLE-CELL element as Org syntax.
3258 CONTENTS is the contents of the cell, or nil."
3262 "Search for the next table-cell object.
3264 LIMIT bounds the search.
3266 Return value is a cons cell whose CAR is `table-cell' and CDR is
3267 beginning position."
3271 ;;;; Target
3274 "Parse target at point.
3276 Return a list whose CAR is `target' and CDR a plist with
3277 `:begin', `:end', `:value' and `:post-blank' as keywords.
3279 Assume point is at the target."
3289 :end end
3290 :value value
3294 "Interpret TARGET object as Org syntax.
3295 CONTENTS is nil."
3299 "Search for the next target object.
3301 LIMIT bounds the search.
3303 Return value is a cons cell whose CAR is `target' and CDR is
3304 beginning position."
3310 ;;;; Timestamp
3313 "Parse time stamp at point.
3315 Return a list whose CAR is `timestamp', and CDR a plist with
3316 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3318 Assume point is at the beginning of the timestamp."
3337 :value main-value
3338 :range-end range-end
3339 :begin begin
3340 :end end
3344 "Interpret TIMESTAMP object as Org syntax.
3345 CONTENTS is nil."
3354 range-end)))))))
3357 "Search for the next timestamp object.
3359 LIMIT bounds the search.
3361 Return value is a cons cell whose CAR is `timestamp' and CDR is
3362 beginning position."
3370 limit t)
3374 ;;;; Underline
3377 "Parse underline object at point.
3379 Return a list whose CAR is `underline' and CDR is a plist with
3380 `:begin', `:end', `:contents-begin' and `:contents-end' and
3381 `:post-blank' keywords.
3383 Assume point is at the first underscore marker."
3395 :end end
3396 :contents-begin contents-begin
3397 :contents-end contents-end
3401 "Interpret UNDERLINE object as Org syntax.
3402 CONTENTS is the contents of the object."
3406 ;;;; Verbatim
3409 "Parse verbatim object at point.
3411 Return a list whose CAR is `verbatim' and CDR is a plist with
3412 `:value', `:begin', `:end' and `:post-blank' keywords.
3414 Assume point is at the first equal sign marker."
3425 :begin begin
3426 :end end
3430 "Interpret VERBATIM object as Org syntax.
3431 CONTENTS is nil."
3435 \f
3436 ;;; Parsing Element Starting At Point
3437 ;;
3438 ;; `org-element--current-element' is the core function of this section.
3439 ;; It returns the Lisp representation of the element starting at
3440 ;; point.
3441 ;;
3442 ;; `org-element--current-element' makes use of special modes. They
3443 ;; are activated for fixed element chaining (i.e. `plain-list' >
3444 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3445 ;; `section'). Special modes are: `first-section', `item',
3446 ;; `node-property', `quote-section', `section' and `table-row'.
3450 "Parse the element starting at point.
3452 LIMIT bounds the search.
3454 Return value is a list like (TYPE PROPS) where TYPE is the type
3455 of the element and PROPS a plist of properties associated to the
3456 element.
3458 Possible types are defined in `org-element-all-elements'.
3460 Optional argument GRANULARITY determines the depth of the
3461 recursion. Allowed values are `headline', `greater-element',
3462 `element', `object' or nil. When it is broader than `object' (or
3463 nil), secondary values will not be parsed, since they only
3464 contain objects.
3466 Optional argument SPECIAL, when non-nil, can be either
3467 `first-section', `item', `node-property', `quote-section',
3468 `section', and `table-row'.
3470 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3471 be computed.
3473 This function assumes point is always at the beginning of the
3474 element it has to parse."
3477 ;; Determine if parsing depth allows for secondary strings
3478 ;; parsing. It only applies to elements referenced in
3479 ;; `org-element-secondary-value-alist'.
3482 ;; Item.
3485 ;; Table Row.
3487 ;; Node Property.
3489 ;; Headline.
3492 ;; Sections (must be checked after headline).
3498 limit)))
3499 ;; When not at bol, point is at the beginning of an item or
3500 ;; a footnote definition: next item is always a paragraph.
3502 ;; Planning and Clock.
3507 ;; Inlinetask.
3510 ;; From there, elements can have affiliated keywords.
3513 ;; LaTeX Environment.
3519 nil t))
3522 ;; Drawer and Property Drawer.
3532 ;; Fixed Width
3535 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3536 ;; Keywords.
3545 org-element-block-name-alist)))
3560 ;; Footnote Definition.
3563 ;; Horizontal Rule.
3566 ;; Table.
3568 ;; List.
3572 ;; Default element: Paragraph.
3576 ;; Most elements can have affiliated keywords. When looking for an
3577 ;; element beginning, we want to move before them, as they belong to
3578 ;; that element, and, in the meantime, collect information they give
3579 ;; into appropriate properties. Hence the following function.
3582 "Collect affiliated keywords from point.
3584 Return a list whose CAR is the position at the first of them and
3585 CDR a plist of keywords and values and move point to the
3586 beginning of the first line after them.
3588 As a special case, if element doesn't start at the beginning of
3589 the line (i.e. a paragraph starting an item), CAR is current
3590 position of point and CDR is nil."
3594 ;; RESTRICT is the list of objects allowed in parsed
3595 ;; keywords value.
3597 output)
3600 ;; Apply translation to RAW-KWD. From there, KWD is
3601 ;; the official keyword.
3603 org-element-keyword-translation-alist))
3604 raw-kwd))
3605 ;; Find main value for any keyword.
3611 ;; PARSEDP is non-nil when keyword should have its
3612 ;; value parsed.
3614 ;; If KWD is a dual keyword, find its secondary
3615 ;; value. Maybe parse it.
3622 ;; Attribute a property name to KWD.
3624 ;; Now set final shape for VALUE.
3629 ;; Attributes can always appear on multiple lines.
3632 ;; Eventually store the new value in OUTPUT.
3634 ;; Move to next keyword.
3636 ;; If affiliated keywords are orphaned: move back to first one.
3637 ;; They will be parsed as a paragraph.
3639 ;; Return value.
3643 \f
3644 ;;; The Org Parser
3645 ;;
3646 ;; The two major functions here are `org-element-parse-buffer', which
3647 ;; parses Org syntax inside the current buffer, taking into account
3648 ;; region, narrowing, or even visibility if specified, and
3649 ;; `org-element-parse-secondary-string', which parses objects within
3650 ;; a given string.
3651 ;;
3652 ;; The (almost) almighty `org-element-map' allows to apply a function
3653 ;; on elements or objects matching some type, and accumulate the
3654 ;; resulting values. In an export situation, it also skips unneeded
3655 ;; parts of the parse tree.
3658 "Recursively parse the buffer and return structure.
3659 If narrowing is in effect, only parse the visible part of the
3660 buffer.
3662 Optional argument GRANULARITY determines the depth of the
3663 recursion. It can be set to the following symbols:
3665 `headline' Only parse headlines.
3666 `greater-element' Don't recurse into greater elements excepted
3667 headlines and sections. Thus, elements
3668 parsed are the top-level ones.
3669 `element' Parse everything but objects and plain text.
3670 `object' Parse the complete buffer (default).
3672 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3673 elements.
3675 Assume buffer is in Org mode."
3681 ;; Start in `first-section' mode so text before the first
3682 ;; headline belongs to a section.
3686 "Recursively parse objects in STRING and return structure.
3688 RESTRICTION is a symbol limiting the object types that will be
3689 looked after.
3691 Optional argument PARENT, when non-nil, is the element or object
3692 containing the secondary string. It is used to set correctly
3693 `:parent' property within the string."
3699 secondary))))
3703 "Map a function on selected elements or objects.
3705 DATA is the parsed tree, as returned by, i.e,
3706 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3707 of elements or objects types. FUN is the function called on the
3708 matching element or object. It must accept one arguments: the
3709 element or object itself.
3711 When optional argument INFO is non-nil, it should be a plist
3712 holding export options. In that case, parts of the parse tree
3713 not exportable according to that property list will be skipped.
3715 When optional argument FIRST-MATCH is non-nil, stop at the first
3716 match for which FUN doesn't return nil, and return that value.
3718 Optional argument NO-RECURSION is a symbol or a list of symbols
3719 representing elements or objects types. `org-element-map' won't
3720 enter any recursive element or object whose type belongs to that
3721 list. Though, FUN can still be applied on them.
3723 When optional argument WITH-AFFILIATED is non-nil, also move into
3724 affiliated keywords to find objects.
3726 Nil values returned from FUN do not appear in the results."
3727 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3730 ;; Recursion depth is determined by --CATEGORY.
3737 ;; If one object is found, the function
3738 ;; has to recurse into every object.
3741 ;; If one regular element is found, the
3742 ;; function has to recurse, at least,
3743 ;; into every element it encounters.
3746 types)
3747 category)))
3748 ;; Compute properties for affiliated keywords if necessary.
3753 org-element-affiliated-keywords)))
3754 --acc
3755 --walk-tree
3759 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3760 ;; holding contextual information.
3764 ;; Ignored element in an export context.
3766 ;; Secondary string: only objects can be found there.
3769 ;; Unconditionally enter parse trees.
3773 ;; Check if TYPE is matching among TYPES. If so,
3774 ;; apply FUN to --DATA and accumulate return value
3775 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3781 ;; If --DATA has a secondary string that can contain
3782 ;; objects with their type among TYPES, look into it.
3789 ;; If --DATA has any affiliated keywords and
3790 ;; WITH-AFFILIATED is non-nil, look for objects in
3791 ;; them.
3799 ;; Pay attention to the type of value.
3800 ;; Preserve order for multiple keywords.
3816 --affiliated-alist))
3817 ;; Determine if a recursion into --DATA is possible.
3819 ;; --TYPE is explicitly removed from recursion.
3821 ;; --DATA has no contents.
3823 ;; Looking for greater elements but --DATA is simply
3824 ;; an element or an object.
3827 ;; Looking for elements but --DATA is an object.
3830 ;; In any other case, map contents.
3834 ;; Return value in a proper order.
3837 ;; The following functions are internal parts of the parser.
3838 ;;
3839 ;; The first one, `org-element--parse-elements' acts at the element's
3840 ;; level.
3841 ;;
3842 ;; The second one, `org-element--parse-objects' applies on all objects
3843 ;; of a paragraph or a secondary string. It uses
3844 ;; `org-element--get-next-object-candidates' to optimize the search of
3845 ;; the next object in the buffer.
3846 ;;
3847 ;; More precisely, that function looks for every allowed object type
3848 ;; first. Then, it discards failed searches, keeps further matches,
3849 ;; and searches again types matched behind point, for subsequent
3850 ;; calls. Thus, searching for a given type fails only once, and every
3851 ;; object is searched only once at top level (but sometimes more for
3852 ;; nested types).
3856 "Parse elements between BEG and END positions.
3858 SPECIAL prioritize some elements over the others. It can be set
3859 to `first-section', `quote-section', `section' `item' or
3860 `table-row'.
3862 When value is `item', STRUCTURE will be used as the current list
3863 structure.
3865 GRANULARITY determines the depth of the recursion. See
3866 `org-element-parse-buffer' for more information.
3868 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3869 elements.
3871 Elements are accumulated into ACC."
3874 ;; When parsing only headlines, skip any text before first one.
3877 ;; Main loop start.
3879 ;; Find current element's type and parse it accordingly to
3880 ;; its category.
3882 end granularity special structure))
3886 ;; Fill ELEMENT contents by side-effect.
3888 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3889 ;; no contents, don't modify it.
3892 ;; Greater element: parse it between `contents-begin' and
3893 ;; `contents-end'. Make sure GRANULARITY allows the
3894 ;; recursion, or ELEMENT is an headline, in which case going
3895 ;; inside is mandatory, in order to get sub-level headings.
3903 ;; Possibly switch to a special mode.
3912 granularity visible-only element))
3913 ;; ELEMENT has contents. Parse objects inside, if
3914 ;; GRANULARITY allows it.
3920 ;; Return result.
3921 acc))
3924 "Parse objects between BEG and END and return recursive structure.
3926 Objects are accumulated in ACC.
3928 RESTRICTION is a list of object types which are allowed in the
3929 current object."
3935 end restriction candidates)))
3942 ;; 1. Text before any object. Untabify it.
3947 acc
3951 ;; 2. Object...
3954 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3955 ;; a recursive type.
3960 cont-beg
3967 ;; 3. Text after last object. Untabify it.
3971 acc
3975 ;; Result.
3976 acc)))
3979 "Return an alist of candidates for the next object.
3981 LIMIT bounds the search, and RESTRICTION narrows candidates to
3982 some object types.
3984 Return value is an alist whose CAR is position and CDR the object
3985 type, as a symbol.
3987 OBJECTS is the previous candidates alist."
3988 ;; Filter out any object found but not belonging to RESTRICTION.
3994 type)
3995 restriction)))
3996 objects))
3998 ;; If no previous result, search every object type in RESTRICTION.
3999 ;; Otherwise, keep potential candidates (old objects located after
4000 ;; point) and ask to search again those which had matched before.
4005 objects))
4006 ;; Call the appropriate successor function for each type to search
4007 ;; and accumulate matches.
4014 type))))
4017 types-to-search)
4018 ;; Return alist.
4019 next-candidates))
4022 \f
4023 ;;; Towards A Bijective Process
4024 ;;
4025 ;; The parse tree obtained with `org-element-parse-buffer' is really
4026 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4027 ;; interpreted and expanded into a string with canonical Org syntax.
4028 ;; Hence `org-element-interpret-data'.
4029 ;;
4030 ;; The function relies internally on
4031 ;; `org-element--interpret-affiliated-keywords'.
4033 ;;;###autoload
4035 "Interpret DATA as Org syntax.
4037 DATA is a parse tree, an element, an object or a secondary string
4038 to interpret.
4040 Optional argument PARENT is used for recursive calls. It contains
4041 the element or object containing data, or nil.
4043 Return Org syntax as a string."
4047 ;; Secondary string.
4052 ;; Full Org document.
4057 ;; Plain text.
4059 ;; Element/Object without contents.
4062 data nil))
4063 ;; Element/Object with contents.
4073 ;; Elements directly containing objects must
4074 ;; have their indentation normalized first.
4076 data
4077 ;; When normalizing first paragraph of an
4078 ;; item or a footnote-definition, ignore
4079 ;; first line's indentation.
4086 data
4088 contents)))))))
4090 ;; Build white spaces. If no `:post-blank' property is
4091 ;; specified, assume its value is 0.
4101 "Return ELEMENT's affiliated keywords as Org syntax.
4102 If there is no affiliated keyword, return the empty string."
4112 ": "
4115 value)
4123 ;; All attribute keywords can have multiple lines.
4129 ;; List all ELEMENT's properties matching an attribute line or an
4130 ;; affiliated keyword, but ignore translated keywords since they
4131 ;; cannot belong to the property list.
4138 org-element-keyword-translation-alist)))))
4139 collect prop)
4142 ;; Because interpretation of the parse tree must return the same
4143 ;; number of blank lines between elements and the same number of white
4144 ;; space after objects, some special care must be given to white
4145 ;; spaces.
4146 ;;
4147 ;; The first function, `org-element-normalize-string', ensures any
4148 ;; string different from the empty string will end with a single
4149 ;; newline character.
4150 ;;
4151 ;; The second function, `org-element-normalize-contents', removes
4152 ;; global indentation from the contents of the current element.
4155 "Ensure string S ends with a single newline character.
4157 If S isn't a string return it unchanged. If S is the empty
4158 string, return it. Otherwise, return a new string with a single
4159 newline character at its end."
4167 "Normalize plain text in ELEMENT's contents.
4169 ELEMENT must only contain plain text and objects.
4171 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4172 indentation to compute maximal common indentation.
4174 Return the normalized element that is element with global
4175 indentation removed from its contents. The function assumes that
4176 indentation is not done with TAB characters."
4178 collect-inds ; for byte-compiler
4181 ;; Return list of indentations within BLOB. This is done by
4182 ;; walking recursively BLOB and updating IND-LIST along the
4183 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4184 ;; been seen yet. It is required as this string is the only
4185 ;; one whose indentation doesn't happen after a newline
4186 ;; character.
4194 ;; An indentation of zero means no string will be
4195 ;; modified. Quit the process.
4201 ;; Avoid matching blank or empty lines.
4209 ;; Collect indentation list in ELEMENT. Possibly remove first
4210 ;; value if IGNORE-FIRST is non-nil.
4213 ;; Build ELEMENT back, replacing each string with the same
4214 ;; string minus common indentation.
4219 ;; Return BLOB with all its strings indentation
4220 ;; shortened from MCI white spaces. FIRST-FLAG is
4221 ;; non-nil when the first string hasn't been seen
4222 ;; yet.
4236 org-element-recursive-objects)
4240 blob))))
4244 \f
4245 ;;; The Toolbox
4246 ;;
4247 ;; The first move is to implement a way to obtain the smallest element
4248 ;; containing point. This is the job of `org-element-at-point'. It
4249 ;; basically jumps back to the beginning of section containing point
4250 ;; and moves, element after element, with
4251 ;; `org-element--current-element' until the container is found. Note:
4252 ;; When using `org-element-at-point', secondary values are never
4253 ;; parsed since the function focuses on elements, not on objects.
4254 ;;
4255 ;; At a deeper level, `org-element-context' lists all elements and
4256 ;; objects containing point.
4257 ;;
4258 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4259 ;; internally by navigation and manipulation tools.
4261 ;;;###autoload
4263 "Determine closest element around point.
4265 Return value is a list like (TYPE PROPS) where TYPE is the type
4266 of the element and PROPS a plist of properties associated to the
4267 element.
4269 Possible types are defined in `org-element-all-elements'.
4270 Properties depend on element or object type, but always
4271 include :begin, :end, :parent and :post-blank properties.
4273 As a special case, if point is at the very beginning of a list or
4274 sub-list, returned element will be that list instead of the first
4275 item. In the same way, if point is at the beginning of the first
4276 row of a table, returned element will be the table instead of the
4277 first row.
4279 If optional argument KEEP-TRAIL is non-nil, the function returns
4280 a list of of elements leading to element at point. The list's
4281 CAR is always the element at point. Following positions contain
4282 element's siblings, then parents, siblings of parents, until the
4283 first element of current section."
4285 ;; If at an headline, parse it. It is the sole element that
4286 ;; doesn't require to know about context. Be sure to disallow
4287 ;; secondary string parsing, though.
4293 ;; Otherwise move at the beginning of the section containing
4294 ;; point.
4298 element type special-flag trail struct prevs parent)
4306 ;; Parse successively each element, skipping those ending
4307 ;; before original position.
4316 ;; 1. Skip any element ending before point. Also skip
4317 ;; element ending at point when we're sure that another
4318 ;; element has started.
4323 ;; 2. An element containing point is always the element at
4324 ;; point.
4327 ;; 3. At any other greater element type, if point is
4328 ;; within contents, move into it.
4333 ;; Create an anchor for tables and plain lists:
4334 ;; when point is at the very beginning of these
4335 ;; elements, ignoring affiliated keywords,
4336 ;; target them instead of their contents.
4338 ;; When point is at contents end, do not move
4339 ;; into elements with an explicit ending, but
4340 ;; return that element instead.
4344 drawer dynamic-block inlinetask item
4345 plain-list property-drawer quote-block
4346 special-block))))
4359 ;;;###autoload
4361 "Return closest element or object around point.
4363 Return value is a list like (TYPE PROPS) where TYPE is the type
4364 of the element or object and PROPS a plist of properties
4365 associated to it.
4367 Possible types are defined in `org-element-all-elements' and
4368 `org-element-all-objects'. Properties depend on element or
4369 object type, but always include :begin, :end, :parent
4370 and :post-blank properties."
4375 end)
4376 ;; Check if point is inside an element containing objects or at
4377 ;; a secondary string. In that case, move to beginning of the
4378 ;; element or secondary string and set END to the other side.
4387 (<= origin
4388 ;; `1+' is required so some
4389 ;; successors can match
4390 ;; properly their object.
4404 element
4407 candidates)
4410 end restriction candidates))
4412 candidates)))
4413 ;; If ORIGIN is before next object in element, there's
4414 ;; no point in looking further.
4423 ;; ORIGIN is after OBJECT, so skip it.
4426 ;; ORIGIN is within a non-recursive object or at an
4427 ;; object boundaries: Return that object.
4431 ;; Otherwise, move within current object and restrict
4432 ;; search to the end of its contents.
4437 end cend)))))))
4438 parent))))))
4441 "Non-nil when elements ELEM-A and ELEM-B are nested."
4450 "Swap elements ELEM-A and ELEM-B.
4451 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4452 end of ELEM-A."
4454 ;; There are two special cases when an element doesn't start at bol:
4455 ;; the first paragraph in an item or in a footnote definition.
4457 ;; Only a paragraph without any affiliated keyword can be moved at
4458 ;; ELEM-A position in such a situation. Note that the case of
4459 ;; a footnote definition is impossible: it cannot contain two
4460 ;; paragraphs in a row because it cannot contain a blank line.
4466 ;; In a special situation, ELEM-A will have no indentation. We'll
4467 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4481 ;; Store overlays responsible for visibility status. We
4482 ;; also need to store their boundaries as they will be
4483 ;; removed from buffer.
4490 ;; Get contents.
4498 ;; Restore ex ELEM-A overlays.
4507 ;; Restore ex ELEM-B overlays.
4516 ;; Local variables:
4517 ;; generated-autoload-file: "org-loaddefs.el"
4518 ;; End:
4520 ;;; org-element.el ends here