| blob | a5992442f8fcc82edb05d09aa4cf4bf47abc7d14 |
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.
516 :end end
517 :hiddenp hidden
518 :contents-begin contents-begin
519 :contents-end contents-end
524 "Interpret CENTER-BLOCK element as Org syntax.
525 CONTENTS is the contents of the element."
529 ;;;; Drawer
532 "Parse a drawer.
534 LIMIT bounds the search. AFFILIATED is a list of which CAR is
535 the buffer position at the beginning of the first affiliated
536 keyword and CDR is a plist of affiliated keywords along with
537 their value.
539 Return a list whose CAR is `drawer' and CDR is a plist containing
540 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
541 `:contents-end' and `:post-blank' keywords.
543 Assume point is at beginning of drawer."
546 ;; Incomplete drawer: parse it as a paragraph.
553 ;; Empty drawers have no contents.
567 :end end
568 :drawer-name name
569 :hiddenp hidden
570 :contents-begin contents-begin
571 :contents-end contents-end
576 "Interpret DRAWER element as Org syntax.
577 CONTENTS is the contents of the element."
580 contents))
583 ;;;; Dynamic Block
586 "Parse a dynamic block.
588 LIMIT bounds the search. AFFILIATED is a list of which CAR is
589 the buffer position at the beginning of the first affiliated
590 keyword and CDR is a plist of affiliated keywords along with
591 their value.
593 Return a list whose CAR is `dynamic-block' and CDR is a plist
594 containing `:block-name', `:begin', `:end', `:hiddenp',
595 `:contents-begin', `:contents-end', `:arguments' and
596 `:post-blank' keywords.
598 Assume point is at beginning of dynamic block."
602 ;; Incomplete block: parse it as a paragraph.
610 ;; Empty blocks have no contents.
624 :end end
625 :block-name name
626 :arguments arguments
627 :hiddenp hidden
628 :contents-begin contents-begin
629 :contents-end contents-end
634 "Interpret DYNAMIC-BLOCK element as Org syntax.
635 CONTENTS is the contents of the element."
640 contents))
643 ;;;; Footnote Definition
646 "Parse a footnote definition.
648 LIMIT bounds the search. AFFILIATED is a list of which CAR is
649 the buffer position at the beginning of the first affiliated
650 keyword and CDR is a plist of affiliated keywords along with
651 their value.
653 Return a list whose CAR is `footnote-definition' and CDR is
654 a plist containing `:label', `:begin' `:end', `:contents-begin',
655 `:contents-end' and `:post-blank' keywords.
657 Assume point is at the beginning of the footnote definition."
681 :begin begin
682 :end end
683 :contents-begin contents-begin
684 :contents-end contents-end
689 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
690 CONTENTS is the contents of the footnote-definition."
692 " "
693 contents))
696 ;;;; Headline
699 "Parse an headline.
701 Return a list whose CAR is `headline' and CDR is a plist
702 containing `:raw-value', `:title', `:begin', `:end',
703 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
704 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
705 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
706 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
707 keywords.
709 The plist also contains any property set in the property drawer,
710 with its name in lowercase, the underscores replaced with hyphens
711 and colons at the beginning (i.e. `:custom-id').
713 When RAW-SECONDARY-P is non-nil, headline's title will not be
714 parsed as a secondary string, but as a plain string instead.
716 Assume point is at beginning of the headline."
729 raw-value)))
733 raw-value)))
737 ;; Normalize property names: ":SOME_PROP:" becomes
738 ;; ":some-prop".
750 plist))
768 ;; Clean RAW-VALUE from any quote or comment string.
776 ""
777 raw-value))))
778 ;; Clean TAGS from archive tag, if any.
784 :begin begin
785 :end end
786 :pre-blank
789 :hiddenp hidden
790 :contents-begin contents-begin
791 :contents-end contents-end
792 :level level
794 :tags tags
795 :todo-keyword todo
796 :todo-type todo-type
797 :scheduled scheduled
798 :deadline deadline
799 :timestamp timestamp
800 :clock clock
806 end)
807 :footnote-section-p footnote-section-p
808 :archivedp archivedp
809 :commentedp commentedp
811 standard-props))))
813 headline :title
819 "Interpret HEADLINE element as Org syntax.
820 CONTENTS is the contents of the element."
847 ;; Align tags.
855 ? )
856 tags))
860 tags))))
862 contents)))
865 ;;;; Inlinetask
868 "Parse an inline task.
870 Return a list whose CAR is `inlinetask' and CDR is a plist
871 containing `:title', `:begin', `:end', `:hiddenp',
872 `:contents-begin' and `:contents-end', `:level', `:priority',
873 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
874 `:scheduled', `:deadline', `:timestamp', `:clock' and
875 `:post-blank' keywords.
877 The plist also contains any property set in the property drawer,
878 with its name in lowercase, the underscores replaced with hyphens
879 and colons at the beginning (i.e. `:custom-id').
881 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
882 title will not be parsed as a secondary string, but as a plain
883 string instead.
885 Assume point is at beginning of the inline task."
896 ;; Normalize property names: ":SOME_PROP:" becomes
897 ;; ":some-prop".
909 plist))
933 :begin begin
934 :end end
935 :hiddenp hidden
936 :contents-begin contents-begin
937 :contents-end contents-end
940 :tags tags
941 :todo-keyword todo
942 :todo-type todo-type
943 :scheduled scheduled
944 :deadline deadline
945 :timestamp timestamp
946 :clock clock
948 standard-props
951 inlinetask :title
954 raw-value
956 inlinetask))))))
959 "Interpret INLINETASK element as Org syntax.
960 CONTENTS is the contents of inlinetask."
975 ;; Align tags.
983 ? )
984 tags))
988 tags))))
989 ;; Prefer degenerate inlinetasks when there are no
990 ;; contents.
993 contents
997 ;;;; Item
1000 "Parse an item.
1002 STRUCT is the structure of the plain list.
1004 Return a list whose CAR is `item' and CDR is a plist containing
1005 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1006 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1007 `:post-blank' keywords.
1009 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1010 any, will not be parsed as a secondary string, but as a plain
1011 string instead.
1013 Assume point is at the beginning of the item."
1037 ;; Ignore tags in un-ordered lists: they are just
1038 ;; a part of item's body.
1044 ;; If first line isn't empty, contents really start
1045 ;; at the text after item's meta-data.
1056 :begin begin
1057 :end end
1058 ;; CONTENTS-BEGIN and CONTENTS-END may be
1059 ;; mixed up in the case of an empty item
1060 ;; separated from the next by a blank line.
1061 ;; Thus ensure the former is always the
1062 ;; smallest.
1065 :checkbox checkbox
1066 :counter counter
1067 :hiddenp hidden
1068 :structure struct
1071 item :tag
1079 "Interpret ITEM element as Org syntax.
1080 CONTENTS is the contents of the element."
1086 ;; Compute indentation.
1091 ;; Indent contents.
1093 bullet
1106 ;;;; Plain List
1109 "Parse a plain list.
1111 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1112 the buffer position at the beginning of the first affiliated
1113 keyword and CDR is a plist of affiliated keywords along with
1114 their value. STRUCTURE is the structure of the plain list being
1115 parsed.
1117 Return a list whose CAR is `plain-list' and CDR is a plist
1118 containing `:type', `:begin', `:end', `:contents-begin' and
1119 `:contents-end', `:structure' and `:post-blank' keywords.
1121 Assume point is at the beginning of the list."
1135 ;; Return value.
1139 :begin begin
1140 :end end
1141 :contents-begin contents-begin
1142 :contents-end contents-end
1143 :structure struct
1148 "Interpret PLAIN-LIST element as Org syntax.
1149 CONTENTS is the contents of the element."
1157 ;;;; Property Drawer
1160 "Parse a property drawer.
1162 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1163 the buffer position at the beginning of the first affiliated
1164 keyword and CDR is a plist of affiliated keywords along with
1165 their value.
1167 Return a list whose CAR is `property-drawer' and CDR is a plist
1168 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1169 `:contents-end' and `:post-blank' keywords.
1171 Assume point is at the beginning of the property drawer."
1176 ;; Incomplete drawer: parse it as a paragraph.
1194 :end end
1195 :hiddenp hidden
1196 :contents-begin contents-begin
1197 :contents-end contents-end
1202 "Interpret PROPERTY-DRAWER element as Org syntax.
1203 CONTENTS is the properties within the drawer."
1207 ;;;; Quote Block
1210 "Parse a quote block.
1212 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1213 the buffer position at the beginning of the first affiliated
1214 keyword and CDR is a plist of affiliated keywords along with
1215 their value.
1217 Return a list whose CAR is `quote-block' and CDR is a plist
1218 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1219 `:contents-end' and `:post-blank' keywords.
1221 Assume point is at the beginning of the block."
1225 ;; Incomplete block: parse it as a paragraph.
1230 ;; Empty blocks have no contents.
1244 :end end
1245 :hiddenp hidden
1246 :contents-begin contents-begin
1247 :contents-end contents-end
1252 "Interpret QUOTE-BLOCK element as Org syntax.
1253 CONTENTS is the contents of the element."
1257 ;;;; Section
1260 "Parse a section.
1262 LIMIT bounds the search.
1264 Return a list whose CAR is `section' and CDR is a plist
1265 containing `:begin', `:end', `:contents-begin', `contents-end'
1266 and `:post-blank' keywords."
1268 ;; Beginning of section is the beginning of the first non-blank
1269 ;; line after previous headline.
1278 :end end
1279 :contents-begin begin
1280 :contents-end pos-before-blank
1284 "Interpret SECTION element as Org syntax.
1285 CONTENTS is the contents of the element."
1286 contents)
1289 ;;;; Special Block
1292 "Parse a special block.
1294 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1295 the buffer position at the beginning of the first affiliated
1296 keyword and CDR is a plist of affiliated keywords along with
1297 their value.
1299 Return a list whose CAR is `special-block' and CDR is a plist
1300 containing `:type', `:begin', `:end', `:hiddenp',
1301 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1303 Assume point is at the beginning of the block."
1310 ;; Incomplete block: parse it as a paragraph.
1315 ;; Empty blocks have no contents.
1329 :begin begin
1330 :end end
1331 :hiddenp hidden
1332 :contents-begin contents-begin
1333 :contents-end contents-end
1338 "Interpret SPECIAL-BLOCK element as Org syntax.
1339 CONTENTS is the contents of the element."
1344 \f
1345 ;;; Elements
1346 ;;
1347 ;; For each element, a parser and an interpreter are also defined.
1348 ;; Both follow the same naming convention used for greater elements.
1349 ;;
1350 ;; Also, as for greater elements, adding a new element type is done
1351 ;; through the following steps: implement a parser and an interpreter,
1352 ;; tweak `org-element--current-element' so that it recognizes the new
1353 ;; type and add that new type to `org-element-all-elements'.
1354 ;;
1355 ;; As a special case, when the newly defined type is a block type,
1356 ;; `org-element-block-name-alist' has to be modified accordingly.
1359 ;;;; Babel Call
1362 "Parse a babel call.
1364 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1365 the buffer position at the beginning of the first affiliated
1366 keyword and CDR is a plist of affiliated keywords along with
1367 their value.
1369 Return a list whose CAR is `babel-call' and CDR is a plist
1370 containing `:begin', `:end', `:info' and `:post-blank' as
1371 keywords."
1383 :end end
1384 :info info
1389 "Interpret BABEL-CALL element as Org syntax.
1390 CONTENTS is nil."
1396 ;; Remove redundant square brackets.
1401 ;;;; Clock
1404 "Parse a clock.
1406 LIMIT bounds the search.
1408 Return a list whose CAR is `clock' and CDR is a plist containing
1409 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1410 as keywords."
1429 :value value
1430 :time time
1431 :begin begin
1432 :end end
1436 "Interpret CLOCK element as Org syntax.
1437 CONTENTS is nil."
1444 "%2s:%02s"
1448 ;;;; Comment
1451 "Parse a comment.
1453 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1454 the buffer position at the beginning of the first affiliated
1455 keyword and CDR is a plist of affiliated keywords along with
1456 their value.
1458 Return a list whose CAR is `comment' and CDR is a plist
1459 containing `:begin', `:end', `:value' and `:post-blank'
1460 keywords.
1462 Assume point is at comment beginning."
1470 ;; Get comments ending.
1473 ;; Accumulate lines without leading hash and first
1474 ;; whitespace.
1488 :end end
1489 :value value
1494 "Interpret COMMENT element as Org syntax.
1495 CONTENTS is nil."
1499 ;;;; Comment Block
1502 "Parse an export block.
1504 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1505 the buffer position at the beginning of the first affiliated
1506 keyword and CDR is a plist of affiliated keywords along with
1507 their value.
1509 Return a list whose CAR is `comment-block' and CDR is a plist
1510 containing `:begin', `:end', `:hiddenp', `:value' and
1511 `:post-blank' keywords.
1513 Assume point is at comment block beginning."
1517 ;; Incomplete block: parse it as a paragraph.
1530 contents-begin contents-end)))
1534 :end end
1535 :value value
1536 :hiddenp hidden
1541 "Interpret COMMENT-BLOCK element as Org syntax.
1542 CONTENTS is nil."
1547 ;;;; Example Block
1550 "Parse an example block.
1552 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1553 the buffer position at the beginning of the first affiliated
1554 keyword and CDR is a plist of affiliated keywords along with
1555 their value.
1557 Return a list whose CAR is `example-block' and CDR is a plist
1558 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1559 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1560 `:switches', `:value' and `:post-blank' keywords."
1564 ;; Incomplete block: parse it as a paragraph.
1571 ;; Switches analysis
1576 ;; Should labels be retained in (or stripped from) example
1577 ;; blocks?
1582 ;; What should code-references use - labels or
1583 ;; line-numbers?
1590 ;; Standard block parsing.
1596 contents-begin contents-end)))
1605 :end end
1606 :value value
1607 :switches switches
1608 :number-lines number-lines
1609 :preserve-indent preserve-indent
1610 :retain-labels retain-labels
1611 :use-labels use-labels
1612 :label-fmt label-fmt
1613 :hiddenp hidden
1618 "Interpret EXAMPLE-BLOCK element as Org syntax.
1619 CONTENTS is nil."
1628 ;;;; Export Block
1631 "Parse an export block.
1633 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1634 the buffer position at the beginning of the first affiliated
1635 keyword and CDR is a plist of affiliated keywords along with
1636 their value.
1638 Return a list whose CAR is `export-block' and CDR is a plist
1639 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1640 `:post-blank' keywords.
1642 Assume point is at export-block beginning."
1649 ;; Incomplete block: parse it as a paragraph.
1662 contents-end)))
1666 :end end
1667 :type type
1668 :value value
1669 :hiddenp hidden
1674 "Interpret EXPORT-BLOCK element as Org syntax.
1675 CONTENTS is nil."
1682 ;;;; Fixed-width
1685 "Parse a fixed-width section.
1687 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1688 the buffer position at the beginning of the first affiliated
1689 keyword and CDR is a plist of affiliated keywords along with
1690 their value.
1692 Return a list whose CAR is `fixed-width' and CDR is a plist
1693 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1695 Assume point is at the beginning of the fixed-width area."
1698 value
1703 ;; Accumulate text without starting colons.
1716 :end end
1717 :value value
1722 "Interpret FIXED-WIDTH element as Org syntax.
1723 CONTENTS is nil."
1728 ;;;; Horizontal Rule
1731 "Parse an horizontal rule.
1733 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1734 the buffer position at the beginning of the first affiliated
1735 keyword and CDR is a plist of affiliated keywords along with
1736 their value.
1738 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1739 containing `:begin', `:end' and `:post-blank' keywords."
1748 :end end
1753 "Interpret HORIZONTAL-RULE element as Org syntax.
1754 CONTENTS is nil."
1758 ;;;; Keyword
1761 "Parse a keyword at point.
1763 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1764 the buffer position at the beginning of the first affiliated
1765 keyword and CDR is a plist of affiliated keywords along with
1766 their value.
1768 Return a list whose CAR is `keyword' and CDR is a plist
1769 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1770 keywords."
1784 :value value
1785 :begin begin
1786 :end end
1791 "Interpret KEYWORD element as Org syntax.
1792 CONTENTS is nil."
1798 ;;;; Latex Environment
1801 "Parse a LaTeX environment.
1803 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1804 the buffer position at the beginning of the first affiliated
1805 keyword and CDR is a plist of affiliated keywords along with
1806 their value.
1808 Return a list whose CAR is `latex-environment' and CDR is a plist
1809 containing `:begin', `:end', `:value' and `:post-blank'
1810 keywords.
1812 Assume point is at the beginning of the latex environment."
1830 :end end
1831 :value value
1836 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1837 CONTENTS is nil."
1841 ;;;; Node Property
1844 "Parse a node-property at point.
1846 LIMIT bounds the search.
1848 Return a list whose CAR is `node-property' and CDR is a plist
1849 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1850 keywords."
1862 :value value
1863 :begin begin
1864 :end end
1868 "Interpret NODE-PROPERTY element as Org syntax.
1869 CONTENTS is nil."
1875 ;;;; Paragraph
1878 "Parse a paragraph.
1880 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1881 the buffer position at the beginning of the first affiliated
1882 keyword and CDR is a plist of affiliated keywords along with
1883 their value.
1885 Return a list whose CAR is `paragraph' and CDR is a plist
1886 containing `:begin', `:end', `:contents-begin' and
1887 `:contents-end' and `:post-blank' keywords.
1889 Assume point is at the beginning of the paragraph."
1898 limit
1899 ;; A matching `org-element-paragraph-separate' is not
1900 ;; necessarily the end of the paragraph. In
1901 ;; particular, lines starting with # or : as a first
1902 ;; non-space character are ambiguous. We have check
1903 ;; if they are valid Org syntax (i.e. not an
1904 ;; incomplete keyword).
1908 ;; There's no ambiguity for other symbols or
1909 ;; empty lines: stop here.
1911 ;; Stop at valid fixed-width areas.
1913 ;; Stop at drawers.
1918 ;; Stop at valid comments.
1920 ;; Stop at valid dynamic blocks.
1925 ;; Stop at valid blocks.
1932 limit t)))
1933 ;; Stop at valid latex environments.
1940 limit t)))
1941 ;; Stop at valid keywords.
1943 ;; Skip everything else.
1960 :end end
1961 :contents-begin contents-begin
1962 :contents-end contents-end
1967 "Interpret PARAGRAPH element as Org syntax.
1968 CONTENTS is the contents of the element."
1969 contents)
1972 ;;;; Planning
1975 "Parse a planning.
1977 LIMIT bounds the search.
1979 Return a list whose CAR is `planning' and CDR is a plist
1980 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1981 and `:post-blank' keywords."
1990 closed deadline scheduled)
2004 :deadline deadline
2005 :scheduled scheduled
2006 :begin begin
2007 :end end
2011 "Interpret PLANNING element as Org syntax.
2012 CONTENTS is nil."
2014 'identity
2026 ;;;; Quote Section
2029 "Parse a quote section.
2031 LIMIT bounds the search.
2033 Return a list whose CAR is `quote-section' and CDR is a plist
2034 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2036 Assume point is at beginning of the section."
2047 :end end
2048 :value value
2052 "Interpret QUOTE-SECTION element as Org syntax.
2053 CONTENTS is nil."
2057 ;;;; Src Block
2060 "Parse a src block.
2062 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2063 the buffer position at the beginning of the first affiliated
2064 keyword and CDR is a plist of affiliated keywords along with
2065 their value.
2067 Return a list whose CAR is `src-block' and CDR is a plist
2068 containing `:language', `:switches', `:parameters', `:begin',
2069 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2070 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2071 `:post-blank' keywords.
2073 Assume point is at the beginning of the block."
2076 limit t)))
2077 ;; Incomplete block: parse it as a paragraph.
2082 ;; Get language as a string.
2091 ;; Get switches.
2093 ;; Get parameters.
2095 ;; Switches analysis
2103 ;; Should labels be retained in (or stripped from)
2104 ;; src blocks?
2109 ;; What should code-references use - labels or
2110 ;; line-numbers?
2114 ;; Get visibility status.
2116 ;; Retrieve code.
2122 ;; Get position after ending blank lines.
2132 :begin begin
2133 :end end
2134 :number-lines number-lines
2135 :preserve-indent preserve-indent
2136 :retain-labels retain-labels
2137 :use-labels use-labels
2138 :label-fmt label-fmt
2139 :hiddenp hidden
2140 :value value
2145 "Interpret SRC-BLOCK element as Org syntax.
2146 CONTENTS is nil."
2170 ;;;; Table
2173 "Parse a table at point.
2175 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2176 the buffer position at the beginning of the first affiliated
2177 keyword and CDR is a plist of affiliated keywords along with
2178 their value.
2180 Return a list whose CAR is `table' and CDR is a plist containing
2181 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2182 `:contents-end', `:value' and `:post-blank' keywords.
2184 Assume point is at the beginning of the table."
2196 acc))
2203 :end end
2204 :type type
2205 :tblfm tblfm
2206 ;; Only `org' tables have contents. `table.el' tables
2207 ;; use a `:value' property to store raw table as
2208 ;; a string.
2213 table-begin table-end))
2218 "Interpret TABLE element as Org syntax.
2219 CONTENTS is nil."
2230 ;;;; Table Row
2233 "Parse table row at point.
2235 LIMIT bounds the search.
2237 Return a list whose CAR is `table-row' and CDR is a plist
2238 containing `:begin', `:end', `:contents-begin', `:contents-end',
2239 `:type' and `:post-blank' keywords."
2243 ;; A table rule has no contents. In that case, ensure
2244 ;; CONTENTS-BEGIN matches CONTENTS-END.
2256 :begin begin
2257 :end end
2258 :contents-begin contents-begin
2259 :contents-end contents-end
2263 "Interpret TABLE-ROW element as Org syntax.
2264 CONTENTS is the contents of the table row."
2269 ;;;; Verse Block
2272 "Parse a verse block.
2274 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2275 the buffer position at the beginning of the first affiliated
2276 keyword and CDR is a plist of affiliated keywords along with
2277 their value.
2279 Return a list whose CAR is `verse-block' and CDR is a plist
2280 containing `:begin', `:end', `:contents-begin', `:contents-end',
2281 `:hiddenp' and `:post-blank' keywords.
2283 Assume point is at beginning of the block."
2287 ;; Incomplete block: parse it as a paragraph.
2302 :end end
2303 :contents-begin contents-begin
2304 :contents-end contents-end
2305 :hiddenp hidden
2310 "Interpret VERSE-BLOCK element as Org syntax.
2311 CONTENTS is verse block contents."
2315 \f
2316 ;;; Objects
2317 ;;
2318 ;; Unlike to elements, interstices can be found between objects.
2319 ;; That's why, along with the parser, successor functions are provided
2320 ;; for each object. Some objects share the same successor (i.e. `code'
2321 ;; and `verbatim' objects).
2322 ;;
2323 ;; A successor must accept a single argument bounding the search. It
2324 ;; will return either a cons cell whose CAR is the object's type, as
2325 ;; a symbol, and CDR the position of its next occurrence, or nil.
2326 ;;
2327 ;; Successors follow the naming convention:
2328 ;; org-element-NAME-successor, where NAME is the name of the
2329 ;; successor, as defined in `org-element-all-successors'.
2330 ;;
2331 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2332 ;; object types they can contain will be specified in
2333 ;; `org-element-object-restrictions'.
2334 ;;
2335 ;; Adding a new type of object is simple. Implement a successor,
2336 ;; a parser, and an interpreter for it, all following the naming
2337 ;; convention. Register type in `org-element-all-objects' and
2338 ;; successor in `org-element-all-successors'. Maybe tweak
2339 ;; restrictions about it, and that's it.
2342 ;;;; Bold
2345 "Parse bold object at point.
2347 Return a list whose CAR is `bold' and CDR is a plist with
2348 `:begin', `:end', `:contents-begin' and `:contents-end' and
2349 `:post-blank' keywords.
2351 Assume point is at the first star marker."
2363 :end end
2364 :contents-begin contents-begin
2365 :contents-end contents-end
2369 "Interpret BOLD object as Org syntax.
2370 CONTENTS is the contents of the object."
2374 "Search for the next text-markup object.
2376 LIMIT bounds the search.
2378 Return value is a cons cell whose CAR is a symbol among `bold',
2379 `italic', `underline', `strike-through', `code' and `verbatim'
2380 and CDR is beginning position."
2396 ;;;; Code
2399 "Parse code object at point.
2401 Return a list whose CAR is `code' and CDR is a plist with
2402 `:value', `:begin', `:end' and `:post-blank' keywords.
2404 Assume point is at the first tilde marker."
2415 :begin begin
2416 :end end
2420 "Interpret CODE object as Org syntax.
2421 CONTENTS is nil."
2425 ;;;; Entity
2428 "Parse entity at point.
2430 Return a list whose CAR is `entity' and CDR a plist with
2431 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2432 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2433 keywords.
2435 Assume point is at the beginning of the entity."
2437 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2453 :begin begin
2454 :end end
2455 :use-brackets-p bracketsp
2459 "Interpret ENTITY object as Org syntax.
2460 CONTENTS is nil."
2466 "Search for the next latex-fragment or entity object.
2468 LIMIT bounds the search.
2470 Return value is a cons cell whose CAR is `entity' or
2471 `latex-fragment' and CDR is beginning position."
2475 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2482 limit t)
2485 ;; Determine if it's a real entity or a LaTeX command.
2488 ;; No entity nor command: point is at a LaTeX fragment.
2489 ;; Determine its type to get the correct beginning position.
2497 matchers)
2501 ;;;; Export Snippet
2504 "Parse export snippet at point.
2506 Return a list whose CAR is `export-snippet' and CDR a plist with
2507 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2508 keywords.
2510 Assume point is at the beginning of the snippet."
2522 :value value
2523 :begin begin
2524 :end end
2528 "Interpret EXPORT-SNIPPET object as Org syntax.
2529 CONTENTS is nil."
2535 "Search for the next export-snippet object.
2537 LIMIT bounds the search.
2539 Return value is a cons cell whose CAR is `export-snippet' and CDR
2540 its beginning position."
2549 ;;;; Footnote Reference
2552 "Parse footnote reference at point.
2554 Return a list whose CAR is `footnote-reference' and CDR a plist
2555 with `:label', `:type', `:inline-definition', `:begin', `:end'
2556 and `:post-blank' as keywords."
2578 :type type
2579 :begin begin
2580 :end end
2583 footnote-reference :inline-definition
2588 footnote-reference))))))
2591 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2592 CONTENTS is nil."
2602 "Search for the next footnote-reference object.
2604 LIMIT bounds the search.
2606 Return value is a cons cell whose CAR is `footnote-reference' and
2607 CDR is beginning position."
2621 ;;;; Inline Babel Call
2624 "Parse inline babel call at point.
2626 Return a list whose CAR is `inline-babel-call' and CDR a plist
2627 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2629 Assume point is at the beginning of the babel call."
2640 :end end
2641 :info info
2645 "Interpret INLINE-BABEL-CALL object as Org syntax.
2646 CONTENTS is nil."
2652 ;; Remove redundant square brackets.
2655 main-source)
2659 "Search for the next inline-babel-call object.
2661 LIMIT bounds the search.
2663 Return value is a cons cell whose CAR is `inline-babel-call' and
2664 CDR is beginning position."
2666 ;; Use a simplified version of
2667 ;; `org-babel-inline-lob-one-liner-regexp'.
2670 limit t)
2674 ;;;; Inline Src Block
2677 "Parse inline source block at point.
2679 LIMIT bounds the search.
2681 Return a list whose CAR is `inline-src-block' and CDR a plist
2682 with `:begin', `:end', `:language', `:value', `:parameters' and
2683 `:post-blank' as keywords.
2685 Assume point is at the beginning of the inline src block."
2698 :value value
2699 :parameters parameters
2700 :begin begin
2701 :end end
2705 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2706 CONTENTS is nil."
2711 language
2713 body)))
2716 "Search for the next inline-babel-call element.
2718 LIMIT bounds the search.
2720 Return value is a cons cell whose CAR is `inline-babel-call' and
2721 CDR is beginning position."
2727 ;;;; Italic
2730 "Parse italic object at point.
2732 Return a list whose CAR is `italic' and CDR is a plist with
2733 `:begin', `:end', `:contents-begin' and `:contents-end' and
2734 `:post-blank' keywords.
2736 Assume point is at the first slash marker."
2748 :end end
2749 :contents-begin contents-begin
2750 :contents-end contents-end
2754 "Interpret ITALIC object as Org syntax.
2755 CONTENTS is the contents of the object."
2759 ;;;; Latex Fragment
2762 "Parse latex fragment at point.
2764 Return a list whose CAR is `latex-fragment' and CDR a plist with
2765 `:value', `:begin', `:end', and `:post-blank' as keywords.
2767 Assume point is at the beginning of the latex fragment."
2781 ;; None found: it's a macro.
2790 :begin begin
2791 :end end
2795 "Interpret LATEX-FRAGMENT object as Org syntax.
2796 CONTENTS is nil."
2799 ;;;; Line Break
2802 "Parse line break at point.
2804 Return a list whose CAR is `line-break', and CDR a plist with
2805 `:begin', `:end' and `:post-blank' keywords.
2807 Assume point is at the beginning of the line break."
2811 "Interpret LINE-BREAK object as Org syntax.
2812 CONTENTS is nil."
2816 "Search for the next line-break object.
2818 LIMIT bounds the search.
2820 Return value is a cons cell whose CAR is `line-break' and CDR is
2821 beginning position."
2825 ;; A line break can only happen on a non-empty line.
2830 ;;;; Link
2833 "Parse link at point.
2835 Return a list whose CAR is `link' and CDR a plist with `:type',
2836 `:path', `:raw-link', `:application', `:search-option', `:begin',
2837 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2838 keywords.
2840 Assume point is at the beginning of the link."
2843 end contents-begin contents-end link-end post-blank path type
2844 raw-link link search-option application)
2846 ;; Type 1: Text targeted from a radio target.
2851 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2856 ;; RAW-LINK is the original link.
2861 ;; Determine TYPE of link and set PATH accordingly.
2863 ;; File type.
2866 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2869 ;; Id type: PATH is the id.
2872 ;; Code-ref type: PATH is the name of the reference.
2875 ;; Custom-id type: PATH is the name of the custom id.
2878 ;; Fuzzy type: Internal link either matches a target, an
2879 ;; headline name or nothing. PATH is the target or
2880 ;; headline's name.
2882 ;; Type 3: Plain link, i.e. http://orgmode.org
2888 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2895 ;; In any case, deduce end point after trailing white space from
2896 ;; LINK-END variable.
2899 ;; Extract search option and opening application out of
2900 ;; "file"-type links.
2902 ;; Application.
2907 ;; Extract search option from PATH.
2911 ;; Make sure TYPE always report "file".
2915 :path path
2917 :application application
2918 :search-option search-option
2919 :begin begin
2920 :end end
2921 :contents-begin contents-begin
2922 :contents-end contents-end
2926 "Interpret LINK object as Org syntax.
2927 CONTENTS is the contents of the object, or nil."
2932 raw-link
2936 "Search for the next link object.
2938 LIMIT bounds the search.
2940 Return value is a cons cell whose CAR is `link' and CDR is
2941 beginning position."
2950 ;;;; Macro
2953 "Parse macro at point.
2955 Return a list whose CAR is `macro' and CDR a plist with `:key',
2956 `:args', `:begin', `:end', `:value' and `:post-blank' as
2957 keywords.
2959 Assume point is at the macro."
2973 ;; Repair bad splits.
2981 :value value
2982 :args args
2983 :begin begin
2984 :end end
2988 "Interpret MACRO object as Org syntax.
2989 CONTENTS is nil."
2993 "Search for the next macro object.
2995 LIMIT bounds the search.
2997 Return value is cons cell whose CAR is `macro' and CDR is
2998 beginning position."
3002 limit t)
3006 ;;;; Radio-target
3009 "Parse radio target at point.
3011 Return a list whose CAR is `radio-target' and CDR a plist with
3012 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3013 and `:post-blank' as keywords.
3015 Assume point is at the radio target."
3027 :end end
3028 :contents-begin contents-begin
3029 :contents-end contents-end
3030 :post-blank post-blank
3034 "Interpret TARGET object as Org syntax.
3035 CONTENTS is the contents of the object."
3039 "Search for the next radio-target object.
3041 LIMIT bounds the search.
3043 Return value is a cons cell whose CAR is `radio-target' and CDR
3044 is beginning position."
3050 ;;;; Statistics Cookie
3053 "Parse statistics cookie at point.
3055 Return a list whose CAR is `statistics-cookie', and CDR a plist
3056 with `:begin', `:end', `:value' and `:post-blank' keywords.
3058 Assume point is at the beginning of the statistics-cookie."
3069 :end end
3070 :value value
3074 "Interpret STATISTICS-COOKIE object as Org syntax.
3075 CONTENTS is nil."
3079 "Search for the next statistics cookie object.
3081 LIMIT bounds the search.
3083 Return value is a cons cell whose CAR is `statistics-cookie' and
3084 CDR is beginning position."
3090 ;;;; Strike-Through
3093 "Parse strike-through object at point.
3095 Return a list whose CAR is `strike-through' and CDR is a plist
3096 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3097 `:post-blank' keywords.
3099 Assume point is at the first plus sign marker."
3111 :end end
3112 :contents-begin contents-begin
3113 :contents-end contents-end
3117 "Interpret STRIKE-THROUGH object as Org syntax.
3118 CONTENTS is the contents of the object."
3122 ;;;; Subscript
3125 "Parse subscript at point.
3127 Return a list whose CAR is `subscript' and CDR a plist with
3128 `:begin', `:end', `:contents-begin', `:contents-end',
3129 `:use-brackets-p' and `:post-blank' as keywords.
3131 Assume point is at the underscore."
3135 t
3146 :end end
3147 :use-brackets-p bracketsp
3148 :contents-begin contents-begin
3149 :contents-end contents-end
3153 "Interpret SUBSCRIPT object as Org syntax.
3154 CONTENTS is the contents of the object."
3157 contents))
3160 "Search for the next sub/superscript object.
3162 LIMIT bounds the search.
3164 Return value is a cons cell whose CAR is either `subscript' or
3165 `superscript' and CDR is beginning position."
3172 ;;;; Superscript
3175 "Parse superscript at point.
3177 Return a list whose CAR is `superscript' and CDR a plist with
3178 `:begin', `:end', `:contents-begin', `:contents-end',
3179 `:use-brackets-p' and `:post-blank' as keywords.
3181 Assume point is at the caret."
3195 :end end
3196 :use-brackets-p bracketsp
3197 :contents-begin contents-begin
3198 :contents-end contents-end
3202 "Interpret SUPERSCRIPT object as Org syntax.
3203 CONTENTS is the contents of the object."
3206 contents))
3209 ;;;; Table Cell
3212 "Parse table cell at point.
3214 Return a list whose CAR is `table-cell' and CDR is a plist
3215 containing `:begin', `:end', `:contents-begin', `:contents-end'
3216 and `:post-blank' keywords."
3224 :end end
3225 :contents-begin contents-begin
3226 :contents-end contents-end
3230 "Interpret TABLE-CELL element as Org syntax.
3231 CONTENTS is the contents of the cell, or nil."
3235 "Search for the next table-cell object.
3237 LIMIT bounds the search.
3239 Return value is a cons cell whose CAR is `table-cell' and CDR is
3240 beginning position."
3244 ;;;; Target
3247 "Parse target at point.
3249 Return a list whose CAR is `target' and CDR a plist with
3250 `:begin', `:end', `:value' and `:post-blank' as keywords.
3252 Assume point is at the target."
3262 :end end
3263 :value value
3267 "Interpret TARGET object as Org syntax.
3268 CONTENTS is nil."
3272 "Search for the next target object.
3274 LIMIT bounds the search.
3276 Return value is a cons cell whose CAR is `target' and CDR is
3277 beginning position."
3283 ;;;; Timestamp
3286 "Parse time stamp at point.
3288 Return a list whose CAR is `timestamp', and CDR a plist with
3289 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3291 Assume point is at the beginning of the timestamp."
3310 :value main-value
3311 :range-end range-end
3312 :begin begin
3313 :end end
3317 "Interpret TIMESTAMP object as Org syntax.
3318 CONTENTS is nil."
3327 range-end)))))))
3330 "Search for the next timestamp object.
3332 LIMIT bounds the search.
3334 Return value is a cons cell whose CAR is `timestamp' and CDR is
3335 beginning position."
3343 limit t)
3347 ;;;; Underline
3350 "Parse underline object at point.
3352 Return a list whose CAR is `underline' and CDR is a plist with
3353 `:begin', `:end', `:contents-begin' and `:contents-end' and
3354 `:post-blank' keywords.
3356 Assume point is at the first underscore marker."
3368 :end end
3369 :contents-begin contents-begin
3370 :contents-end contents-end
3374 "Interpret UNDERLINE object as Org syntax.
3375 CONTENTS is the contents of the object."
3379 ;;;; Verbatim
3382 "Parse verbatim object at point.
3384 Return a list whose CAR is `verbatim' and CDR is a plist with
3385 `:value', `:begin', `:end' and `:post-blank' keywords.
3387 Assume point is at the first equal sign marker."
3398 :begin begin
3399 :end end
3403 "Interpret VERBATIM object as Org syntax.
3404 CONTENTS is nil."
3408 \f
3409 ;;; Parsing Element Starting At Point
3410 ;;
3411 ;; `org-element--current-element' is the core function of this section.
3412 ;; It returns the Lisp representation of the element starting at
3413 ;; point.
3414 ;;
3415 ;; `org-element--current-element' makes use of special modes. They
3416 ;; are activated for fixed element chaining (i.e. `plain-list' >
3417 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3418 ;; `section'). Special modes are: `first-section', `item',
3419 ;; `node-property', `quote-section', `section' and `table-row'.
3423 "Parse the element starting at point.
3425 LIMIT bounds the search.
3427 Return value is a list like (TYPE PROPS) where TYPE is the type
3428 of the element and PROPS a plist of properties associated to the
3429 element.
3431 Possible types are defined in `org-element-all-elements'.
3433 Optional argument GRANULARITY determines the depth of the
3434 recursion. Allowed values are `headline', `greater-element',
3435 `element', `object' or nil. When it is broader than `object' (or
3436 nil), secondary values will not be parsed, since they only
3437 contain objects.
3439 Optional argument SPECIAL, when non-nil, can be either
3440 `first-section', `item', `node-property', `quote-section',
3441 `section', and `table-row'.
3443 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3444 be computed.
3446 This function assumes point is always at the beginning of the
3447 element it has to parse."
3450 ;; Determine if parsing depth allows for secondary strings
3451 ;; parsing. It only applies to elements referenced in
3452 ;; `org-element-secondary-value-alist'.
3455 ;; Item.
3458 ;; Table Row.
3460 ;; Node Property.
3462 ;; Headline.
3465 ;; Sections (must be checked after headline).
3471 limit)))
3472 ;; When not at bol, point is at the beginning of an item or
3473 ;; a footnote definition: next item is always a paragraph.
3475 ;; Planning and Clock.
3480 ;; Inlinetask.
3483 ;; From there, elements can have affiliated keywords.
3486 ;; LaTeX Environment.
3492 nil t))
3495 ;; Drawer and Property Drawer.
3505 ;; Fixed Width
3508 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3509 ;; Keywords.
3518 org-element-block-name-alist)))
3533 ;; Footnote Definition.
3536 ;; Horizontal Rule.
3539 ;; Table.
3541 ;; List.
3545 ;; Default element: Paragraph.
3549 ;; Most elements can have affiliated keywords. When looking for an
3550 ;; element beginning, we want to move before them, as they belong to
3551 ;; that element, and, in the meantime, collect information they give
3552 ;; into appropriate properties. Hence the following function.
3555 "Collect affiliated keywords from point.
3557 Return a list whose CAR is the position at the first of them and
3558 CDR a plist of keywords and values and move point to the
3559 beginning of the first line after them.
3561 As a special case, if element doesn't start at the beginning of
3562 the line (i.e. a paragraph starting an item), CAR is current
3563 position of point and CDR is nil."
3567 ;; RESTRICT is the list of objects allowed in parsed
3568 ;; keywords value.
3570 output)
3573 ;; Apply translation to RAW-KWD. From there, KWD is
3574 ;; the official keyword.
3576 org-element-keyword-translation-alist))
3577 raw-kwd))
3578 ;; Find main value for any keyword.
3584 ;; PARSEDP is non-nil when keyword should have its
3585 ;; value parsed.
3587 ;; If KWD is a dual keyword, find its secondary
3588 ;; value. Maybe parse it.
3595 ;; Attribute a property name to KWD.
3597 ;; Now set final shape for VALUE.
3602 ;; Attributes can always appear on multiple lines.
3605 ;; Eventually store the new value in OUTPUT.
3607 ;; Move to next keyword.
3609 ;; If affiliated keywords are orphaned: move back to first one.
3610 ;; They will be parsed as a paragraph.
3612 ;; Return value.
3616 \f
3617 ;;; The Org Parser
3618 ;;
3619 ;; The two major functions here are `org-element-parse-buffer', which
3620 ;; parses Org syntax inside the current buffer, taking into account
3621 ;; region, narrowing, or even visibility if specified, and
3622 ;; `org-element-parse-secondary-string', which parses objects within
3623 ;; a given string.
3624 ;;
3625 ;; The (almost) almighty `org-element-map' allows to apply a function
3626 ;; on elements or objects matching some type, and accumulate the
3627 ;; resulting values. In an export situation, it also skips unneeded
3628 ;; parts of the parse tree.
3631 "Recursively parse the buffer and return structure.
3632 If narrowing is in effect, only parse the visible part of the
3633 buffer.
3635 Optional argument GRANULARITY determines the depth of the
3636 recursion. It can be set to the following symbols:
3638 `headline' Only parse headlines.
3639 `greater-element' Don't recurse into greater elements excepted
3640 headlines and sections. Thus, elements
3641 parsed are the top-level ones.
3642 `element' Parse everything but objects and plain text.
3643 `object' Parse the complete buffer (default).
3645 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3646 elements.
3648 Assume buffer is in Org mode."
3654 ;; Start in `first-section' mode so text before the first
3655 ;; headline belongs to a section.
3659 "Recursively parse objects in STRING and return structure.
3661 RESTRICTION is a symbol limiting the object types that will be
3662 looked after.
3664 Optional argument PARENT, when non-nil, is the element or object
3665 containing the secondary string. It is used to set correctly
3666 `:parent' property within the string."
3672 secondary))))
3676 "Map a function on selected elements or objects.
3678 DATA is the parsed tree, as returned by, i.e,
3679 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3680 of elements or objects types. FUN is the function called on the
3681 matching element or object. It must accept one arguments: the
3682 element or object itself.
3684 When optional argument INFO is non-nil, it should be a plist
3685 holding export options. In that case, parts of the parse tree
3686 not exportable according to that property list will be skipped.
3688 When optional argument FIRST-MATCH is non-nil, stop at the first
3689 match for which FUN doesn't return nil, and return that value.
3691 Optional argument NO-RECURSION is a symbol or a list of symbols
3692 representing elements or objects types. `org-element-map' won't
3693 enter any recursive element or object whose type belongs to that
3694 list. Though, FUN can still be applied on them.
3696 When optional argument WITH-AFFILIATED is non-nil, also move into
3697 affiliated keywords to find objects.
3699 Nil values returned from FUN do not appear in the results."
3700 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3703 ;; Recursion depth is determined by --CATEGORY.
3710 ;; If one object is found, the function
3711 ;; has to recurse into every object.
3714 ;; If one regular element is found, the
3715 ;; function has to recurse, at least,
3716 ;; into every element it encounters.
3719 types)
3720 category)))
3721 ;; Compute properties for affiliated keywords if necessary.
3726 org-element-affiliated-keywords)))
3727 --acc
3728 --walk-tree
3732 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3733 ;; holding contextual information.
3737 ;; Ignored element in an export context.
3739 ;; Secondary string: only objects can be found there.
3742 ;; Unconditionally enter parse trees.
3746 ;; Check if TYPE is matching among TYPES. If so,
3747 ;; apply FUN to --DATA and accumulate return value
3748 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3754 ;; If --DATA has a secondary string that can contain
3755 ;; objects with their type among TYPES, look into it.
3762 ;; If --DATA has any affiliated keywords and
3763 ;; WITH-AFFILIATED is non-nil, look for objects in
3764 ;; them.
3772 ;; Pay attention to the type of value.
3773 ;; Preserve order for multiple keywords.
3789 --affiliated-alist))
3790 ;; Determine if a recursion into --DATA is possible.
3792 ;; --TYPE is explicitly removed from recursion.
3794 ;; --DATA has no contents.
3796 ;; Looking for greater elements but --DATA is simply
3797 ;; an element or an object.
3800 ;; Looking for elements but --DATA is an object.
3803 ;; In any other case, map contents.
3807 ;; Return value in a proper order.
3810 ;; The following functions are internal parts of the parser.
3811 ;;
3812 ;; The first one, `org-element--parse-elements' acts at the element's
3813 ;; level.
3814 ;;
3815 ;; The second one, `org-element--parse-objects' applies on all objects
3816 ;; of a paragraph or a secondary string. It uses
3817 ;; `org-element--get-next-object-candidates' to optimize the search of
3818 ;; the next object in the buffer.
3819 ;;
3820 ;; More precisely, that function looks for every allowed object type
3821 ;; first. Then, it discards failed searches, keeps further matches,
3822 ;; and searches again types matched behind point, for subsequent
3823 ;; calls. Thus, searching for a given type fails only once, and every
3824 ;; object is searched only once at top level (but sometimes more for
3825 ;; nested types).
3829 "Parse elements between BEG and END positions.
3831 SPECIAL prioritize some elements over the others. It can be set
3832 to `first-section', `quote-section', `section' `item' or
3833 `table-row'.
3835 When value is `item', STRUCTURE will be used as the current list
3836 structure.
3838 GRANULARITY determines the depth of the recursion. See
3839 `org-element-parse-buffer' for more information.
3841 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3842 elements.
3844 Elements are accumulated into ACC."
3847 ;; When parsing only headlines, skip any text before first one.
3850 ;; Main loop start.
3852 ;; Find current element's type and parse it accordingly to
3853 ;; its category.
3855 end granularity special structure))
3859 ;; Fill ELEMENT contents by side-effect.
3861 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3862 ;; no contents, don't modify it.
3865 ;; Greater element: parse it between `contents-begin' and
3866 ;; `contents-end'. Make sure GRANULARITY allows the
3867 ;; recursion, or ELEMENT is an headline, in which case going
3868 ;; inside is mandatory, in order to get sub-level headings.
3876 ;; Possibly switch to a special mode.
3885 granularity visible-only element))
3886 ;; ELEMENT has contents. Parse objects inside, if
3887 ;; GRANULARITY allows it.
3893 ;; Return result.
3894 acc))
3897 "Parse objects between BEG and END and return recursive structure.
3899 Objects are accumulated in ACC.
3901 RESTRICTION is a list of object types which are allowed in the
3902 current object."
3908 end restriction candidates)))
3915 ;; 1. Text before any object. Untabify it.
3920 acc
3924 ;; 2. Object...
3927 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3928 ;; a recursive type.
3933 cont-beg
3940 ;; 3. Text after last object. Untabify it.
3944 acc
3948 ;; Result.
3949 acc)))
3952 "Return an alist of candidates for the next object.
3954 LIMIT bounds the search, and RESTRICTION narrows candidates to
3955 some object types.
3957 Return value is an alist whose CAR is position and CDR the object
3958 type, as a symbol.
3960 OBJECTS is the previous candidates alist."
3962 ;; If no previous result, search every object type in RESTRICTION.
3963 ;; Otherwise, keep potential candidates (old objects located after
3964 ;; point) and ask to search again those which had matched before.
3969 objects))
3970 ;; Call the appropriate successor function for each type to search
3971 ;; and accumulate matches.
3978 type))))
3981 types-to-search)
3982 ;; Return alist.
3983 next-candidates))
3986 \f
3987 ;;; Towards A Bijective Process
3988 ;;
3989 ;; The parse tree obtained with `org-element-parse-buffer' is really
3990 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3991 ;; interpreted and expanded into a string with canonical Org syntax.
3992 ;; Hence `org-element-interpret-data'.
3993 ;;
3994 ;; The function relies internally on
3995 ;; `org-element--interpret-affiliated-keywords'.
3997 ;;;###autoload
3999 "Interpret DATA as Org syntax.
4001 DATA is a parse tree, an element, an object or a secondary string
4002 to interpret.
4004 Optional argument PARENT is used for recursive calls. It contains
4005 the element or object containing data, or nil.
4007 Return Org syntax as a string."
4011 ;; Secondary string.
4016 ;; Full Org document.
4021 ;; Plain text.
4023 ;; Element/Object without contents.
4026 data nil))
4027 ;; Element/Object with contents.
4037 ;; Elements directly containing objects must
4038 ;; have their indentation normalized first.
4040 data
4041 ;; When normalizing first paragraph of an
4042 ;; item or a footnote-definition, ignore
4043 ;; first line's indentation.
4050 data
4052 contents)))))))
4054 ;; Build white spaces. If no `:post-blank' property is
4055 ;; specified, assume its value is 0.
4065 "Return ELEMENT's affiliated keywords as Org syntax.
4066 If there is no affiliated keyword, return the empty string."
4076 ": "
4079 value)
4087 ;; All attribute keywords can have multiple lines.
4093 ;; List all ELEMENT's properties matching an attribute line or an
4094 ;; affiliated keyword, but ignore translated keywords since they
4095 ;; cannot belong to the property list.
4102 org-element-keyword-translation-alist)))))
4103 collect prop)
4106 ;; Because interpretation of the parse tree must return the same
4107 ;; number of blank lines between elements and the same number of white
4108 ;; space after objects, some special care must be given to white
4109 ;; spaces.
4110 ;;
4111 ;; The first function, `org-element-normalize-string', ensures any
4112 ;; string different from the empty string will end with a single
4113 ;; newline character.
4114 ;;
4115 ;; The second function, `org-element-normalize-contents', removes
4116 ;; global indentation from the contents of the current element.
4119 "Ensure string S ends with a single newline character.
4121 If S isn't a string return it unchanged. If S is the empty
4122 string, return it. Otherwise, return a new string with a single
4123 newline character at its end."
4131 "Normalize plain text in ELEMENT's contents.
4133 ELEMENT must only contain plain text and objects.
4135 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4136 indentation to compute maximal common indentation.
4138 Return the normalized element that is element with global
4139 indentation removed from its contents. The function assumes that
4140 indentation is not done with TAB characters."
4142 collect-inds ; for byte-compiler
4145 ;; Return list of indentations within BLOB. This is done by
4146 ;; walking recursively BLOB and updating IND-LIST along the
4147 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4148 ;; been seen yet. It is required as this string is the only
4149 ;; one whose indentation doesn't happen after a newline
4150 ;; character.
4158 ;; An indentation of zero means no string will be
4159 ;; modified. Quit the process.
4165 ;; Avoid matching blank or empty lines.
4173 ;; Collect indentation list in ELEMENT. Possibly remove first
4174 ;; value if IGNORE-FIRST is non-nil.
4177 ;; Build ELEMENT back, replacing each string with the same
4178 ;; string minus common indentation.
4183 ;; Return BLOB with all its strings indentation
4184 ;; shortened from MCI white spaces. FIRST-FLAG is
4185 ;; non-nil when the first string hasn't been seen
4186 ;; yet.
4200 org-element-recursive-objects)
4204 blob))))
4208 \f
4209 ;;; The Toolbox
4210 ;;
4211 ;; The first move is to implement a way to obtain the smallest element
4212 ;; containing point. This is the job of `org-element-at-point'. It
4213 ;; basically jumps back to the beginning of section containing point
4214 ;; and moves, element after element, with
4215 ;; `org-element--current-element' until the container is found. Note:
4216 ;; When using `org-element-at-point', secondary values are never
4217 ;; parsed since the function focuses on elements, not on objects.
4218 ;;
4219 ;; At a deeper level, `org-element-context' lists all elements and
4220 ;; objects containing point.
4221 ;;
4222 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4223 ;; internally by navigation and manipulation tools.
4225 ;;;###autoload
4227 "Determine closest element around point.
4229 Return value is a list like (TYPE PROPS) where TYPE is the type
4230 of the element and PROPS a plist of properties associated to the
4231 element.
4233 Possible types are defined in `org-element-all-elements'.
4234 Properties depend on element or object type, but always
4235 include :begin, :end, :parent and :post-blank properties.
4237 As a special case, if point is at the very beginning of a list or
4238 sub-list, returned element will be that list instead of the first
4239 item. In the same way, if point is at the beginning of the first
4240 row of a table, returned element will be the table instead of the
4241 first row.
4243 If optional argument KEEP-TRAIL is non-nil, the function returns
4244 a list of of elements leading to element at point. The list's
4245 CAR is always the element at point. Following positions contain
4246 element's siblings, then parents, siblings of parents, until the
4247 first element of current section."
4249 ;; If at an headline, parse it. It is the sole element that
4250 ;; doesn't require to know about context. Be sure to disallow
4251 ;; secondary string parsing, though.
4257 ;; Otherwise move at the beginning of the section containing
4258 ;; point.
4262 element type special-flag trail struct prevs parent)
4270 ;; Parse successively each element, skipping those ending
4271 ;; before original position.
4280 ;; 1. Skip any element ending before point. Also skip
4281 ;; element ending at point when we're sure that another
4282 ;; element has started.
4287 ;; 2. An element containing point is always the element at
4288 ;; point.
4291 ;; 3. At any other greater element type, if point is
4292 ;; within contents, move into it.
4297 ;; Create an anchor for tables and plain lists:
4298 ;; when point is at the very beginning of these
4299 ;; elements, ignoring affiliated keywords,
4300 ;; target them instead of their contents.
4302 ;; When point is at contents end, do not move
4303 ;; into elements with an explicit ending, but
4304 ;; return that element instead.
4308 drawer dynamic-block inlinetask item
4309 plain-list property-drawer quote-block
4310 special-block))))
4323 ;;;###autoload
4325 "Return closest element or object around point.
4327 Return value is a list like (TYPE PROPS) where TYPE is the type
4328 of the element or object and PROPS a plist of properties
4329 associated to it.
4331 Possible types are defined in `org-element-all-elements' and
4332 `org-element-all-objects'. Properties depend on element or
4333 object type, but always include :begin, :end, :parent
4334 and :post-blank properties."
4339 end)
4340 ;; Check if point is inside an element containing objects or at
4341 ;; a secondary string. In that case, move to beginning of the
4342 ;; element or secondary string and set END to the other side.
4351 (<= origin
4352 ;; `1+' is required so some
4353 ;; successors can match
4354 ;; properly their object.
4368 element
4371 candidates)
4374 end restriction candidates))
4376 candidates)))
4377 ;; If ORIGIN is before next object in element, there's
4378 ;; no point in looking further.
4387 ;; ORIGIN is after OBJECT, so skip it.
4390 ;; ORIGIN is within a non-recursive object or at an
4391 ;; object boundaries: Return that object.
4395 ;; Otherwise, move within current object and restrict
4396 ;; search to the end of its contents.
4400 parent))))))
4403 "Non-nil when elements ELEM-A and ELEM-B are nested."
4412 "Swap elements ELEM-A and ELEM-B.
4413 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4414 end of ELEM-A."
4416 ;; There are two special cases when an element doesn't start at bol:
4417 ;; the first paragraph in an item or in a footnote definition.
4419 ;; Only a paragraph without any affiliated keyword can be moved at
4420 ;; ELEM-A position in such a situation. Note that the case of
4421 ;; a footnote definition is impossible: it cannot contain two
4422 ;; paragraphs in a row because it cannot contain a blank line.
4428 ;; In a special situation, ELEM-A will have no indentation. We'll
4429 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4443 ;; Store overlays responsible for visibility status. We
4444 ;; also need to store their boundaries as they will be
4445 ;; removed from buffer.
4452 ;; Get contents.
4460 ;; Restore ex ELEM-A overlays.
4469 ;; Restore ex ELEM-B overlays.
4478 ;;; org-element.el ends here