| blob | db6a2db022fda1b064540c4eb16fe6a002fded16 |
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 ;; At the lowest level, a `:parent' property is also attached to any
79 ;; string, as a text property.
80 ;;
81 ;; Lisp-wise, an element or an object can be represented as a list.
82 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
83 ;; TYPE is a symbol describing the Org element or object.
84 ;; PROPERTIES is the property list attached to it. See docstring of
85 ;; appropriate parsing function to get an exhaustive
86 ;; list.
87 ;; CONTENTS is a list of elements, objects or raw strings contained
88 ;; in the current element or object, when applicable.
89 ;;
90 ;; An Org buffer is a nested list of such elements and objects, whose
91 ;; type is `org-data' and properties is nil.
92 ;;
93 ;; The first part of this file defines Org syntax, while the second
94 ;; one provide accessors and setters functions.
95 ;;
96 ;; The next part implements a parser and an interpreter for each
97 ;; element and object type in Org syntax.
98 ;;
99 ;; The following part creates a fully recursive buffer parser. It
100 ;; also provides a tool to map a function to elements or objects
101 ;; matching some criteria in the parse tree. Functions of interest
102 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
103 ;; extent, `org-element-parse-secondary-string'.
104 ;;
105 ;; The penultimate part is the cradle of an interpreter for the
106 ;; obtained parse tree: `org-element-interpret-data'.
107 ;;
108 ;; The library ends by furnishing `org-element-at-point' function, and
109 ;; a way to give information about document structure around point
110 ;; with `org-element-context'.
113 ;;; Code:
119 \f
120 ;;; Definitions And Rules
121 ;;
122 ;; Define elements, greater elements and specify recursive objects,
123 ;; along with the affiliated keywords recognized. Also set up
124 ;; restrictions on recursive objects combinations.
125 ;;
126 ;; These variables really act as a control center for the parsing
127 ;; process.
131 ;; Headlines, inlinetasks.
133 ;; Footnote definitions.
136 ;; Empty lines.
138 ;; Tables (any type).
140 ;; Blocks (any type), Babel calls, drawers (any type),
141 ;; fixed-width areas and keywords. Note: this is only an
142 ;; indication and need some thorough check.
144 ;; Horizontal rules.
146 ;; LaTeX environments.
148 ;; Planning and Clock lines.
150 org-deadline-string
151 org-closed-string
152 org-clock-string))
154 ;; Lists.
161 "Regexp to separate paragraphs in an Org buffer.
163 is not sufficient to know if point is at a paragraph ending. See
168 example-block export-block fixed-width footnote-definition
169 headline horizontal-rule inlinetask item keyword
170 latex-environment node-property paragraph plain-list planning
171 property-drawer quote-block quote-section section special-block
172 src-block table table-row verse-block)
177 item plain-list property-drawer quote-block section
178 special-block table)
183 latex-or-entity line-break link macro radio-target
184 statistics-cookie sub/superscript table-cell target
185 text-markup timestamp)
194 "Alist of translations between object type and successor name.
196 Sharing the same successor comes handy when, for example, the
201 inline-src-block italic line-break latex-fragment link macro
202 radio-target statistics-cookie strike-through subscript superscript
203 table-cell target timestamp underline verbatim)
208 table-cell underline)
218 "Alist between block names and the associated parsing function.
219 Names must be uppercase. Any block whose name has no association
225 Only these types can accept search options and an explicit
231 "List of affiliated keywords as strings.
237 ;; Regular affiliated keywords.
240 "Regexp matching any affiliated keyword.
242 Keyword name is put in match group 1. Moreover, if keyword
243 belongs to `org-element-dual-keywords', put the dual value in
244 match group 2.
252 "Alist of usual translations for keywords.
253 The key is the old name and the value the new one. The property
257 "List of affiliated keywords that can occur more than once in an element.
259 Their value will be consed into a list of strings, which will be
260 returned as the value of the property.
262 This list is checked after translations have been applied. See
263 `org-element-keyword-translation-alist'.
269 "List of affiliated keywords whose value can be parsed.
271 Their value will be stored as a secondary string: a list of
272 strings and objects.
274 This list is checked after translations have been applied. See
278 "List of affiliated keywords which can have a secondary value.
280 In Org syntax, they can be written with optional square brackets
281 before the colons. For example, RESULTS keyword can be
282 associated to a hash value with the following:
284 #+RESULTS[hash-string]: some-source
286 This list is checked after translations have been applied. See
290 "List of properties associated to the whole document.
291 Any keyword in this list will have its value parsed and stored as
298 inline-src-block latex-or-entity line-break link macro
299 radio-target sub/superscript target text-markup
300 timestamp)
302 radio-target statistics-cookie sub/superscript target text-markup
303 timestamp)
315 inline-src-block latex-or-entity line-break link macro
316 radio-target statistics-cookie sub/superscript target text-markup
317 timestamp)
320 latex-or-entity link radio-target sub/superscript target
321 text-markup timestamp)
332 latex-or-entity line-break link macro radio-target
334 "Alist of objects restrictions.
336 CAR is an element or object type containing objects and CDR is
337 a list of successors that will be called within an element or
338 object of such type.
340 For example, in a `radio-target' object, one can only find
341 entities, export snippets, latex-fragments, subscript and
342 superscript.
344 This alist also applies to secondary string. For example, an
345 `headline' type element doesn't directly contain objects, but
356 \f
357 ;;; Accessors and Setters
358 ;;
359 ;; Provide four accessors: `org-element-type', `org-element-property'
360 ;; `org-element-contents' and `org-element-restriction'.
361 ;;
362 ;; Setter functions allow to modify elements by side effect. There is
363 ;; `org-element-put-property', `org-element-set-contents',
364 ;; `org-element-set-element' and `org-element-adopt-element'. Note
365 ;; that `org-element-set-element' and `org-element-adopt-elements' are
366 ;; higher level functions since also update `:parent' property.
369 "Return type of ELEMENT.
371 The function returns the type of the element or object provided.
372 It can also return the following special value:
373 `plain-text' for a string
374 `org-data' for a complete document
375 nil in any other case."
381 "Extract the value from the PROPERTY of an ELEMENT."
386 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
411 "Replace element or object OLD with element or object NEW.
412 The function takes care of setting `:parent' property for NEW."
413 ;; Since OLD is going to be changed into NEW by side-effect, first
414 ;; make sure that every element or object within NEW has OLD as
415 ;; parent.
418 ;; Transfer contents.
420 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
421 ;; with NEW's.
424 ;; Transfer type.
428 "Append elements to the contents of another element.
430 PARENT is an element or object. CHILDREN can be elements,
431 objects, or a strings.
433 The function takes care of setting `:parent' property for CHILD.
434 Return parent element."
436 ;; Link every child to PARENT.
438 children)
439 ;; Add CHILDREN at the end of PARENT contents.
441 parent
443 ;; Return modified PARENT element.
444 parent))
447 \f
448 ;;; Greater elements
449 ;;
450 ;; For each greater element type, we define a parser and an
451 ;; interpreter.
452 ;;
453 ;; A parser returns the element or object as the list described above.
454 ;; Most of them accepts no argument. Though, exceptions exist. Hence
455 ;; every element containing a secondary string (see
456 ;; `org-element-secondary-value-alist') will accept an optional
457 ;; argument to toggle parsing of that secondary string. Moreover,
458 ;; `item' parser requires current list's structure as its first
459 ;; element.
460 ;;
461 ;; An interpreter accepts two arguments: the list representation of
462 ;; the element or object, and its contents. The latter may be nil,
463 ;; depending on the element or object considered. It returns the
464 ;; appropriate Org syntax, as a string.
465 ;;
466 ;; Parsing functions must follow the naming convention:
467 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
468 ;; defined in `org-element-greater-elements'.
469 ;;
470 ;; Similarly, interpreting functions must follow the naming
471 ;; convention: org-element-TYPE-interpreter.
472 ;;
473 ;; With the exception of `headline' and `item' types, greater elements
474 ;; cannot contain other greater elements of their own type.
475 ;;
476 ;; Beside implementing a parser and an interpreter, adding a new
477 ;; greater element requires to tweak `org-element--current-element'.
478 ;; Moreover, the newly defined type must be added to both
479 ;; `org-element-all-elements' and `org-element-greater-elements'.
482 ;;;; Center Block
485 "Parse a center block.
487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
488 the buffer position at the beginning of the first affiliated
489 keyword and CDR is a plist of affiliated keywords along with
490 their value.
492 Return a list whose CAR is `center-block' and CDR is a plist
493 containing `:begin', `:end', `:hiddenp', `:contents-begin',
494 `:contents-end' and `:post-blank' keywords.
496 Assume point is at the beginning of the block."
500 ;; Incomplete block: parse it as a paragraph.
504 ;; Empty blocks have no contents.
519 :end end
520 :hiddenp hidden
521 :contents-begin contents-begin
522 :contents-end contents-end
527 "Interpret CENTER-BLOCK element as Org syntax.
528 CONTENTS is the contents of the element."
532 ;;;; Drawer
535 "Parse a drawer.
537 LIMIT bounds the search. AFFILIATED is a list of which CAR is
538 the buffer position at the beginning of the first affiliated
539 keyword and CDR is a plist of affiliated keywords along with
540 their value.
542 Return a list whose CAR is `drawer' and CDR is a plist containing
543 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
544 `:contents-end' and `:post-blank' keywords.
546 Assume point is at beginning of drawer."
549 ;; Incomplete drawer: parse it as a paragraph.
556 ;; Empty drawers have no contents.
571 :end end
572 :drawer-name name
573 :hiddenp hidden
574 :contents-begin contents-begin
575 :contents-end contents-end
580 "Interpret DRAWER element as Org syntax.
581 CONTENTS is the contents of the element."
584 contents))
587 ;;;; Dynamic Block
590 "Parse a dynamic block.
592 LIMIT bounds the search. AFFILIATED is a list of which CAR is
593 the buffer position at the beginning of the first affiliated
594 keyword and CDR is a plist of affiliated keywords along with
595 their value.
597 Return a list whose CAR is `dynamic-block' and CDR is a plist
598 containing `:block-name', `:begin', `:end', `:hiddenp',
599 `:contents-begin', `:contents-end', `:arguments' and
600 `:post-blank' keywords.
602 Assume point is at beginning of dynamic block."
606 ;; Incomplete block: parse it as a paragraph.
614 ;; Empty blocks have no contents.
629 :end end
630 :block-name name
631 :arguments arguments
632 :hiddenp hidden
633 :contents-begin contents-begin
634 :contents-end contents-end
639 "Interpret DYNAMIC-BLOCK element as Org syntax.
640 CONTENTS is the contents of the element."
645 contents))
648 ;;;; Footnote Definition
651 "Parse a footnote definition.
653 LIMIT bounds the search. AFFILIATED is a list of which CAR is
654 the buffer position at the beginning of the first affiliated
655 keyword and CDR is a plist of affiliated keywords along with
656 their value.
658 Return a list whose CAR is `footnote-definition' and CDR is
659 a plist containing `:label', `:begin' `:end', `:contents-begin',
660 `:contents-end' and `:post-blank' keywords.
662 Assume point is at the beginning of the footnote definition."
687 :begin begin
688 :end end
689 :contents-begin contents-begin
690 :contents-end contents-end
695 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
696 CONTENTS is the contents of the footnote-definition."
698 " "
699 contents))
702 ;;;; Headline
705 "Parse an headline.
707 Return a list whose CAR is `headline' and CDR is a plist
708 containing `:raw-value', `:title', `:begin', `:end',
709 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
710 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
711 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
712 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
713 keywords.
715 The plist also contains any property set in the property drawer,
716 with its name in lowercase, the underscores replaced with hyphens
717 and colons at the beginning (i.e. `:custom-id').
719 When RAW-SECONDARY-P is non-nil, headline's title will not be
720 parsed as a secondary string, but as a plain string instead.
722 Assume point is at beginning of the headline."
735 raw-value)))
739 raw-value)))
743 ;; Normalize property names: ":SOME_PROP:" becomes
744 ;; ":some-prop".
756 plist))
774 ;; Clean RAW-VALUE from any quote or comment string.
782 ""
783 raw-value))))
784 ;; Clean TAGS from archive tag, if any.
790 :begin begin
791 :end end
792 :pre-blank
795 :hiddenp hidden
796 :contents-begin contents-begin
797 :contents-end contents-end
798 :level level
800 :tags tags
801 :todo-keyword todo
802 :todo-type todo-type
803 :scheduled scheduled
804 :deadline deadline
805 :timestamp timestamp
806 :clock clock
812 end)
813 :footnote-section-p footnote-section-p
814 :archivedp archivedp
815 :commentedp commentedp
817 standard-props))))
819 headline :title
825 "Interpret HEADLINE element as Org syntax.
826 CONTENTS is the contents of the element."
853 ;; Align tags.
861 ? )
862 tags))
866 tags))))
868 contents)))
871 ;;;; Inlinetask
874 "Parse an inline task.
876 Return a list whose CAR is `inlinetask' and CDR is a plist
877 containing `:title', `:begin', `:end', `:hiddenp',
878 `:contents-begin' and `:contents-end', `:level', `:priority',
879 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
880 `:scheduled', `:deadline', `:timestamp', `:clock' and
881 `:post-blank' keywords.
883 The plist also contains any property set in the property drawer,
884 with its name in lowercase, the underscores replaced with hyphens
885 and colons at the beginning (i.e. `:custom-id').
887 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
888 title will not be parsed as a secondary string, but as a plain
889 string instead.
891 Assume point is at beginning of the inline task."
902 ;; Normalize property names: ":SOME_PROP:" becomes
903 ;; ":some-prop".
915 plist))
940 :begin begin
941 :end end
942 :hiddenp hidden
943 :contents-begin contents-begin
944 :contents-end contents-end
947 :tags tags
948 :todo-keyword todo
949 :todo-type todo-type
950 :scheduled scheduled
951 :deadline deadline
952 :timestamp timestamp
953 :clock clock
955 standard-props
958 inlinetask :title
961 raw-value
963 inlinetask))))))
966 "Interpret INLINETASK element as Org syntax.
967 CONTENTS is the contents of inlinetask."
982 ;; Align tags.
990 ? )
991 tags))
995 tags))))
996 ;; Prefer degenerate inlinetasks when there are no
997 ;; contents.
1000 contents
1004 ;;;; Item
1007 "Parse an item.
1009 STRUCT is the structure of the plain list.
1011 Return a list whose CAR is `item' and CDR is a plist containing
1012 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1013 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1014 `:post-blank' keywords.
1016 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1017 any, will not be parsed as a secondary string, but as a plain
1018 string instead.
1020 Assume point is at the beginning of the item."
1044 ;; Ignore tags in un-ordered lists: they are just
1045 ;; a part of item's body.
1051 ;; If first line isn't empty, contents really start
1052 ;; at the text after item's meta-data.
1063 :begin begin
1064 :end end
1065 ;; CONTENTS-BEGIN and CONTENTS-END may be
1066 ;; mixed up in the case of an empty item
1067 ;; separated from the next by a blank line.
1068 ;; Thus ensure the former is always the
1069 ;; smallest.
1072 :checkbox checkbox
1073 :counter counter
1074 :hiddenp hidden
1075 :structure struct
1078 item :tag
1086 "Interpret ITEM element as Org syntax.
1087 CONTENTS is the contents of the element."
1093 ;; Compute indentation.
1098 ;; Indent contents.
1100 bullet
1113 ;;;; Plain List
1116 "Parse a plain list.
1118 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1119 the buffer position at the beginning of the first affiliated
1120 keyword and CDR is a plist of affiliated keywords along with
1121 their value. STRUCTURE is the structure of the plain list being
1122 parsed.
1124 Return a list whose CAR is `plain-list' and CDR is a plist
1125 containing `:type', `:begin', `:end', `:contents-begin' and
1126 `:contents-end', `:structure' and `:post-blank' keywords.
1128 Assume point is at the beginning of the list."
1143 ;; Return value.
1147 :begin begin
1148 :end end
1149 :contents-begin contents-begin
1150 :contents-end contents-end
1151 :structure struct
1156 "Interpret PLAIN-LIST element as Org syntax.
1157 CONTENTS is the contents of the element."
1165 ;;;; Property Drawer
1168 "Parse a property drawer.
1170 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1171 the buffer position at the beginning of the first affiliated
1172 keyword and CDR is a plist of affiliated keywords along with
1173 their value.
1175 Return a list whose CAR is `property-drawer' and CDR is a plist
1176 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1177 `:contents-end' and `:post-blank' keywords.
1179 Assume point is at the beginning of the property drawer."
1184 ;; Incomplete drawer: parse it as a paragraph.
1203 :end end
1204 :hiddenp hidden
1205 :contents-begin contents-begin
1206 :contents-end contents-end
1211 "Interpret PROPERTY-DRAWER element as Org syntax.
1212 CONTENTS is the properties within the drawer."
1216 ;;;; Quote Block
1219 "Parse a quote block.
1221 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1222 the buffer position at the beginning of the first affiliated
1223 keyword and CDR is a plist of affiliated keywords along with
1224 their value.
1226 Return a list whose CAR is `quote-block' and CDR is a plist
1227 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1228 `:contents-end' and `:post-blank' keywords.
1230 Assume point is at the beginning of the block."
1234 ;; Incomplete block: parse it as a paragraph.
1239 ;; Empty blocks have no contents.
1254 :end end
1255 :hiddenp hidden
1256 :contents-begin contents-begin
1257 :contents-end contents-end
1262 "Interpret QUOTE-BLOCK element as Org syntax.
1263 CONTENTS is the contents of the element."
1267 ;;;; Section
1270 "Parse a section.
1272 LIMIT bounds the search.
1274 Return a list whose CAR is `section' and CDR is a plist
1275 containing `:begin', `:end', `:contents-begin', `contents-end'
1276 and `:post-blank' keywords."
1278 ;; Beginning of section is the beginning of the first non-blank
1279 ;; line after previous headline.
1288 :end end
1289 :contents-begin begin
1290 :contents-end pos-before-blank
1294 "Interpret SECTION element as Org syntax.
1295 CONTENTS is the contents of the element."
1296 contents)
1299 ;;;; Special Block
1302 "Parse a special block.
1304 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1305 the buffer position at the beginning of the first affiliated
1306 keyword and CDR is a plist of affiliated keywords along with
1307 their value.
1309 Return a list whose CAR is `special-block' and CDR is a plist
1310 containing `:type', `:begin', `:end', `:hiddenp',
1311 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1313 Assume point is at the beginning of the block."
1320 ;; Incomplete block: parse it as a paragraph.
1325 ;; Empty blocks have no contents.
1340 :begin begin
1341 :end end
1342 :hiddenp hidden
1343 :contents-begin contents-begin
1344 :contents-end contents-end
1349 "Interpret SPECIAL-BLOCK element as Org syntax.
1350 CONTENTS is the contents of the element."
1355 \f
1356 ;;; Elements
1357 ;;
1358 ;; For each element, a parser and an interpreter are also defined.
1359 ;; Both follow the same naming convention used for greater elements.
1360 ;;
1361 ;; Also, as for greater elements, adding a new element type is done
1362 ;; through the following steps: implement a parser and an interpreter,
1363 ;; tweak `org-element--current-element' so that it recognizes the new
1364 ;; type and add that new type to `org-element-all-elements'.
1365 ;;
1366 ;; As a special case, when the newly defined type is a block type,
1367 ;; `org-element-block-name-alist' has to be modified accordingly.
1370 ;;;; Babel Call
1373 "Parse a babel call.
1375 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1376 the buffer position at the beginning of the first affiliated
1377 keyword and CDR is a plist of affiliated keywords along with
1378 their value.
1380 Return a list whose CAR is `babel-call' and CDR is a plist
1381 containing `:begin', `:end', `:info' and `:post-blank' as
1382 keywords."
1395 :end end
1396 :info info
1401 "Interpret BABEL-CALL element as Org syntax.
1402 CONTENTS is nil."
1408 ;; Remove redundant square brackets.
1413 ;;;; Clock
1416 "Parse a clock.
1418 LIMIT bounds the search.
1420 Return a list whose CAR is `clock' and CDR is a plist containing
1421 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1422 as keywords."
1442 :value value
1443 :time time
1444 :begin begin
1445 :end end
1449 "Interpret CLOCK element as Org syntax.
1450 CONTENTS is nil."
1457 "%2s:%02s"
1461 ;;;; Comment
1464 "Parse a comment.
1466 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1467 the buffer position at the beginning of the first affiliated
1468 keyword and CDR is a plist of affiliated keywords along with
1469 their value.
1471 Return a list whose CAR is `comment' and CDR is a plist
1472 containing `:begin', `:end', `:value' and `:post-blank'
1473 keywords.
1475 Assume point is at comment beginning."
1483 ;; Get comments ending.
1486 ;; Accumulate lines without leading hash and first
1487 ;; whitespace.
1502 :end end
1503 :value value
1508 "Interpret COMMENT element as Org syntax.
1509 CONTENTS is nil."
1513 ;;;; Comment Block
1516 "Parse an export block.
1518 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1519 the buffer position at the beginning of the first affiliated
1520 keyword and CDR is a plist of affiliated keywords along with
1521 their value.
1523 Return a list whose CAR is `comment-block' and CDR is a plist
1524 containing `:begin', `:end', `:hiddenp', `:value' and
1525 `:post-blank' keywords.
1527 Assume point is at comment block beginning."
1531 ;; Incomplete block: parse it as a paragraph.
1545 contents-begin contents-end)))
1549 :end end
1550 :value value
1551 :hiddenp hidden
1556 "Interpret COMMENT-BLOCK element as Org syntax.
1557 CONTENTS is nil."
1562 ;;;; Example Block
1565 "Parse an example block.
1567 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1568 the buffer position at the beginning of the first affiliated
1569 keyword and CDR is a plist of affiliated keywords along with
1570 their value.
1572 Return a list whose CAR is `example-block' and CDR is a plist
1573 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1574 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1575 `:switches', `:value' and `:post-blank' keywords."
1579 ;; Incomplete block: parse it as a paragraph.
1586 ;; Switches analysis
1591 ;; Should labels be retained in (or stripped from) example
1592 ;; blocks?
1597 ;; What should code-references use - labels or
1598 ;; line-numbers?
1605 ;; Standard block parsing.
1611 contents-begin contents-end)))
1621 :end end
1622 :value value
1623 :switches switches
1624 :number-lines number-lines
1625 :preserve-indent preserve-indent
1626 :retain-labels retain-labels
1627 :use-labels use-labels
1628 :label-fmt label-fmt
1629 :hiddenp hidden
1634 "Interpret EXAMPLE-BLOCK element as Org syntax.
1635 CONTENTS is nil."
1644 ;;;; Export Block
1647 "Parse an export block.
1649 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1650 the buffer position at the beginning of the first affiliated
1651 keyword and CDR is a plist of affiliated keywords along with
1652 their value.
1654 Return a list whose CAR is `export-block' and CDR is a plist
1655 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1656 `:post-blank' keywords.
1658 Assume point is at export-block beginning."
1665 ;; Incomplete block: parse it as a paragraph.
1679 contents-end)))
1683 :end end
1684 :type type
1685 :value value
1686 :hiddenp hidden
1691 "Interpret EXPORT-BLOCK element as Org syntax.
1692 CONTENTS is nil."
1699 ;;;; Fixed-width
1702 "Parse a fixed-width section.
1704 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1705 the buffer position at the beginning of the first affiliated
1706 keyword and CDR is a plist of affiliated keywords along with
1707 their value.
1709 Return a list whose CAR is `fixed-width' and CDR is a plist
1710 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1712 Assume point is at the beginning of the fixed-width area."
1715 value
1720 ;; Accumulate text without starting colons.
1734 :end end
1735 :value value
1740 "Interpret FIXED-WIDTH element as Org syntax.
1741 CONTENTS is nil."
1746 ;;;; Horizontal Rule
1749 "Parse an horizontal rule.
1751 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1752 the buffer position at the beginning of the first affiliated
1753 keyword and CDR is a plist of affiliated keywords along with
1754 their value.
1756 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1757 containing `:begin', `:end' and `:post-blank' keywords."
1767 :end end
1772 "Interpret HORIZONTAL-RULE element as Org syntax.
1773 CONTENTS is nil."
1777 ;;;; Keyword
1780 "Parse a keyword at point.
1782 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1783 the buffer position at the beginning of the first affiliated
1784 keyword and CDR is a plist of affiliated keywords along with
1785 their value.
1787 Return a list whose CAR is `keyword' and CDR is a plist
1788 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1789 keywords."
1804 :value value
1805 :begin begin
1806 :end end
1811 "Interpret KEYWORD element as Org syntax.
1812 CONTENTS is nil."
1818 ;;;; Latex Environment
1821 "Parse a LaTeX environment.
1823 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1824 the buffer position at the beginning of the first affiliated
1825 keyword and CDR is a plist of affiliated keywords along with
1826 their value.
1828 Return a list whose CAR is `latex-environment' and CDR is a plist
1829 containing `:begin', `:end', `:value' and `:post-blank'
1830 keywords.
1832 Assume point is at the beginning of the latex environment."
1851 :end end
1852 :value value
1857 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1858 CONTENTS is nil."
1862 ;;;; Node Property
1865 "Parse a node-property at point.
1867 LIMIT bounds the search.
1869 Return a list whose CAR is `node-property' and CDR is a plist
1870 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1871 keywords."
1883 :value value
1884 :begin begin
1885 :end end
1889 "Interpret NODE-PROPERTY element as Org syntax.
1890 CONTENTS is nil."
1896 ;;;; Paragraph
1899 "Parse a paragraph.
1901 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1902 the buffer position at the beginning of the first affiliated
1903 keyword and CDR is a plist of affiliated keywords along with
1904 their value.
1906 Return a list whose CAR is `paragraph' and CDR is a plist
1907 containing `:begin', `:end', `:contents-begin' and
1908 `:contents-end' and `:post-blank' keywords.
1910 Assume point is at the beginning of the paragraph."
1919 limit
1920 ;; A matching `org-element-paragraph-separate' is not
1921 ;; necessarily the end of the paragraph. In
1922 ;; particular, lines starting with # or : as a first
1923 ;; non-space character are ambiguous. We have check
1924 ;; if they are valid Org syntax (i.e. not an
1925 ;; incomplete keyword).
1929 ;; There's no ambiguity for other symbols or
1930 ;; empty lines: stop here.
1932 ;; Stop at valid fixed-width areas.
1934 ;; Stop at drawers.
1939 ;; Stop at valid comments.
1941 ;; Stop at valid dynamic blocks.
1946 ;; Stop at valid blocks.
1953 limit t)))
1954 ;; Stop at valid latex environments.
1961 limit t)))
1962 ;; Stop at valid keywords.
1964 ;; Skip everything else.
1982 :end end
1983 :contents-begin contents-begin
1984 :contents-end contents-end
1989 "Interpret PARAGRAPH element as Org syntax.
1990 CONTENTS is the contents of the element."
1991 contents)
1994 ;;;; Planning
1997 "Parse a planning.
1999 LIMIT bounds the search.
2001 Return a list whose CAR is `planning' and CDR is a plist
2002 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2003 and `:post-blank' keywords."
2013 closed deadline scheduled)
2027 :deadline deadline
2028 :scheduled scheduled
2029 :begin begin
2030 :end end
2034 "Interpret PLANNING element as Org syntax.
2035 CONTENTS is nil."
2037 'identity
2049 ;;;; Quote Section
2052 "Parse a quote section.
2054 LIMIT bounds the search.
2056 Return a list whose CAR is `quote-section' and CDR is a plist
2057 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2059 Assume point is at beginning of the section."
2070 :end end
2071 :value value
2075 "Interpret QUOTE-SECTION element as Org syntax.
2076 CONTENTS is nil."
2080 ;;;; Src Block
2083 "Parse a src block.
2085 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2086 the buffer position at the beginning of the first affiliated
2087 keyword and CDR is a plist of affiliated keywords along with
2088 their value.
2090 Return a list whose CAR is `src-block' and CDR is a plist
2091 containing `:language', `:switches', `:parameters', `:begin',
2092 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2093 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2094 `:post-blank' keywords.
2096 Assume point is at the beginning of the block."
2099 limit t)))
2100 ;; Incomplete block: parse it as a paragraph.
2105 ;; Get language as a string.
2114 ;; Get switches.
2116 ;; Get parameters.
2118 ;; Switches analysis
2126 ;; Should labels be retained in (or stripped from)
2127 ;; src blocks?
2132 ;; What should code-references use - labels or
2133 ;; line-numbers?
2137 ;; Get visibility status.
2139 ;; Retrieve code.
2145 ;; Get position after ending blank lines.
2156 :begin begin
2157 :end end
2158 :number-lines number-lines
2159 :preserve-indent preserve-indent
2160 :retain-labels retain-labels
2161 :use-labels use-labels
2162 :label-fmt label-fmt
2163 :hiddenp hidden
2164 :value value
2169 "Interpret SRC-BLOCK element as Org syntax.
2170 CONTENTS is nil."
2193 ;;;; Table
2196 "Parse a table at point.
2198 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2199 the buffer position at the beginning of the first affiliated
2200 keyword and CDR is a plist of affiliated keywords along with
2201 their value.
2203 Return a list whose CAR is `table' and CDR is a plist containing
2204 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2205 `:contents-end', `:value' and `:post-blank' keywords.
2207 Assume point is at the beginning of the table."
2221 acc))
2229 :end end
2230 :type type
2231 :tblfm tblfm
2232 ;; Only `org' tables have contents. `table.el' tables
2233 ;; use a `:value' property to store raw table as
2234 ;; a string.
2239 table-begin table-end))
2244 "Interpret TABLE element as Org syntax.
2245 CONTENTS is nil."
2256 ;;;; Table Row
2259 "Parse table row at point.
2261 LIMIT bounds the search.
2263 Return a list whose CAR is `table-row' and CDR is a plist
2264 containing `:begin', `:end', `:contents-begin', `:contents-end',
2265 `:type' and `:post-blank' keywords."
2269 ;; A table rule has no contents. In that case, ensure
2270 ;; CONTENTS-BEGIN matches CONTENTS-END.
2282 :begin begin
2283 :end end
2284 :contents-begin contents-begin
2285 :contents-end contents-end
2289 "Interpret TABLE-ROW element as Org syntax.
2290 CONTENTS is the contents of the table row."
2295 ;;;; Verse Block
2298 "Parse a verse block.
2300 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2301 the buffer position at the beginning of the first affiliated
2302 keyword and CDR is a plist of affiliated keywords along with
2303 their value.
2305 Return a list whose CAR is `verse-block' and CDR is a plist
2306 containing `:begin', `:end', `:contents-begin', `:contents-end',
2307 `:hiddenp' and `:post-blank' keywords.
2309 Assume point is at beginning of the block."
2313 ;; Incomplete block: parse it as a paragraph.
2329 :end end
2330 :contents-begin contents-begin
2331 :contents-end contents-end
2332 :hiddenp hidden
2337 "Interpret VERSE-BLOCK element as Org syntax.
2338 CONTENTS is verse block contents."
2342 \f
2343 ;;; Objects
2344 ;;
2345 ;; Unlike to elements, interstices can be found between objects.
2346 ;; That's why, along with the parser, successor functions are provided
2347 ;; for each object. Some objects share the same successor (i.e. `code'
2348 ;; and `verbatim' objects).
2349 ;;
2350 ;; A successor must accept a single argument bounding the search. It
2351 ;; will return either a cons cell whose CAR is the object's type, as
2352 ;; a symbol, and CDR the position of its next occurrence, or nil.
2353 ;;
2354 ;; Successors follow the naming convention:
2355 ;; org-element-NAME-successor, where NAME is the name of the
2356 ;; successor, as defined in `org-element-all-successors'.
2357 ;;
2358 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2359 ;; object types they can contain will be specified in
2360 ;; `org-element-object-restrictions'.
2361 ;;
2362 ;; Adding a new type of object is simple. Implement a successor,
2363 ;; a parser, and an interpreter for it, all following the naming
2364 ;; convention. Register type in `org-element-all-objects' and
2365 ;; successor in `org-element-all-successors'. Maybe tweak
2366 ;; restrictions about it, and that's it.
2369 ;;;; Bold
2372 "Parse bold object at point.
2374 Return a list whose CAR is `bold' and CDR is a plist with
2375 `:begin', `:end', `:contents-begin' and `:contents-end' and
2376 `:post-blank' keywords.
2378 Assume point is at the first star marker."
2390 :end end
2391 :contents-begin contents-begin
2392 :contents-end contents-end
2396 "Interpret BOLD object as Org syntax.
2397 CONTENTS is the contents of the object."
2401 "Search for the next text-markup object.
2403 LIMIT bounds the search.
2405 Return value is a cons cell whose CAR is a symbol among `bold',
2406 `italic', `underline', `strike-through', `code' and `verbatim'
2407 and CDR is beginning position."
2423 ;;;; Code
2426 "Parse code object at point.
2428 Return a list whose CAR is `code' and CDR is a plist with
2429 `:value', `:begin', `:end' and `:post-blank' keywords.
2431 Assume point is at the first tilde marker."
2442 :begin begin
2443 :end end
2447 "Interpret CODE object as Org syntax.
2448 CONTENTS is nil."
2452 ;;;; Entity
2455 "Parse entity at point.
2457 Return a list whose CAR is `entity' and CDR a plist with
2458 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2459 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2460 keywords.
2462 Assume point is at the beginning of the entity."
2464 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2480 :begin begin
2481 :end end
2482 :use-brackets-p bracketsp
2486 "Interpret ENTITY object as Org syntax.
2487 CONTENTS is nil."
2493 "Search for the next latex-fragment or entity object.
2495 LIMIT bounds the search.
2497 Return value is a cons cell whose CAR is `entity' or
2498 `latex-fragment' and CDR is beginning position."
2503 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2510 limit t)
2513 ;; Determine if it's a real entity or a LaTeX command.
2516 ;; No entity nor command: point is at a LaTeX fragment.
2517 ;; Determine its type to get the correct beginning position.
2525 matchers)
2529 ;;;; Export Snippet
2532 "Parse export snippet at point.
2534 Return a list whose CAR is `export-snippet' and CDR a plist with
2535 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2536 keywords.
2538 Assume point is at the beginning of the snippet."
2550 :value value
2551 :begin begin
2552 :end end
2556 "Interpret EXPORT-SNIPPET object as Org syntax.
2557 CONTENTS is nil."
2563 "Search for the next export-snippet object.
2565 LIMIT bounds the search.
2567 Return value is a cons cell whose CAR is `export-snippet' and CDR
2568 its beginning position."
2577 ;;;; Footnote Reference
2580 "Parse footnote reference at point.
2582 Return a list whose CAR is `footnote-reference' and CDR a plist
2583 with `:label', `:type', `:inline-definition', `:begin', `:end'
2584 and `:post-blank' as keywords."
2606 :type type
2607 :begin begin
2608 :end end
2611 footnote-reference :inline-definition
2616 footnote-reference))))))
2619 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2620 CONTENTS is nil."
2630 "Search for the next footnote-reference object.
2632 LIMIT bounds the search.
2634 Return value is a cons cell whose CAR is `footnote-reference' and
2635 CDR is beginning position."
2649 ;;;; Inline Babel Call
2652 "Parse inline babel call at point.
2654 Return a list whose CAR is `inline-babel-call' and CDR a plist
2655 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2657 Assume point is at the beginning of the babel call."
2668 :end end
2669 :info info
2673 "Interpret INLINE-BABEL-CALL object as Org syntax.
2674 CONTENTS is nil."
2680 ;; Remove redundant square brackets.
2683 main-source)
2687 "Search for the next inline-babel-call object.
2689 LIMIT bounds the search.
2691 Return value is a cons cell whose CAR is `inline-babel-call' and
2692 CDR is beginning position."
2694 ;; Use a simplified version of
2695 ;; `org-babel-inline-lob-one-liner-regexp'.
2698 limit t)
2702 ;;;; Inline Src Block
2705 "Parse inline source block at point.
2707 LIMIT bounds the search.
2709 Return a list whose CAR is `inline-src-block' and CDR a plist
2710 with `:begin', `:end', `:language', `:value', `:parameters' and
2711 `:post-blank' as keywords.
2713 Assume point is at the beginning of the inline src block."
2726 :value value
2727 :parameters parameters
2728 :begin begin
2729 :end end
2733 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2734 CONTENTS is nil."
2739 language
2741 body)))
2744 "Search for the next inline-babel-call element.
2746 LIMIT bounds the search.
2748 Return value is a cons cell whose CAR is `inline-babel-call' and
2749 CDR is beginning position."
2755 ;;;; Italic
2758 "Parse italic object at point.
2760 Return a list whose CAR is `italic' and CDR is a plist with
2761 `:begin', `:end', `:contents-begin' and `:contents-end' and
2762 `:post-blank' keywords.
2764 Assume point is at the first slash marker."
2776 :end end
2777 :contents-begin contents-begin
2778 :contents-end contents-end
2782 "Interpret ITALIC object as Org syntax.
2783 CONTENTS is the contents of the object."
2787 ;;;; Latex Fragment
2790 "Parse latex fragment at point.
2792 Return a list whose CAR is `latex-fragment' and CDR a plist with
2793 `:value', `:begin', `:end', and `:post-blank' as keywords.
2795 Assume point is at the beginning of the latex fragment."
2809 ;; None found: it's a macro.
2818 :begin begin
2819 :end end
2823 "Interpret LATEX-FRAGMENT object as Org syntax.
2824 CONTENTS is nil."
2827 ;;;; Line Break
2830 "Parse line break at point.
2832 Return a list whose CAR is `line-break', and CDR a plist with
2833 `:begin', `:end' and `:post-blank' keywords.
2835 Assume point is at the beginning of the line break."
2839 "Interpret LINE-BREAK object as Org syntax.
2840 CONTENTS is nil."
2844 "Search for the next line-break object.
2846 LIMIT bounds the search.
2848 Return value is a cons cell whose CAR is `line-break' and CDR is
2849 beginning position."
2853 ;; A line break can only happen on a non-empty line.
2858 ;;;; Link
2861 "Parse link at point.
2863 Return a list whose CAR is `link' and CDR a plist with `:type',
2864 `:path', `:raw-link', `:application', `:search-option', `:begin',
2865 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2866 keywords.
2868 Assume point is at the beginning of the link."
2871 end contents-begin contents-end link-end post-blank path type
2872 raw-link link search-option application)
2874 ;; Type 1: Text targeted from a radio target.
2879 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2884 ;; RAW-LINK is the original link.
2889 ;; Determine TYPE of link and set PATH accordingly.
2891 ;; File type.
2894 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2897 ;; Id type: PATH is the id.
2900 ;; Code-ref type: PATH is the name of the reference.
2903 ;; Custom-id type: PATH is the name of the custom id.
2906 ;; Fuzzy type: Internal link either matches a target, an
2907 ;; headline name or nothing. PATH is the target or
2908 ;; headline's name.
2910 ;; Type 3: Plain link, i.e. http://orgmode.org
2916 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2923 ;; In any case, deduce end point after trailing white space from
2924 ;; LINK-END variable.
2927 ;; Extract search option and opening application out of
2928 ;; "file"-type links.
2930 ;; Application.
2935 ;; Extract search option from PATH.
2939 ;; Make sure TYPE always report "file".
2943 :path path
2945 :application application
2946 :search-option search-option
2947 :begin begin
2948 :end end
2949 :contents-begin contents-begin
2950 :contents-end contents-end
2954 "Interpret LINK object as Org syntax.
2955 CONTENTS is the contents of the object, or nil."
2960 raw-link
2964 "Search for the next link object.
2966 LIMIT bounds the search.
2968 Return value is a cons cell whose CAR is `link' and CDR is
2969 beginning position."
2978 ;;;; Macro
2981 "Parse macro at point.
2983 Return a list whose CAR is `macro' and CDR a plist with `:key',
2984 `:args', `:begin', `:end', `:value' and `:post-blank' as
2985 keywords.
2987 Assume point is at the macro."
3001 ;; Repair bad splits.
3009 :value value
3010 :args args
3011 :begin begin
3012 :end end
3016 "Interpret MACRO object as Org syntax.
3017 CONTENTS is nil."
3021 "Search for the next macro object.
3023 LIMIT bounds the search.
3025 Return value is cons cell whose CAR is `macro' and CDR is
3026 beginning position."
3030 limit t)
3034 ;;;; Radio-target
3037 "Parse radio target at point.
3039 Return a list whose CAR is `radio-target' and CDR a plist with
3040 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3041 and `:post-blank' as keywords.
3043 Assume point is at the radio target."
3055 :end end
3056 :contents-begin contents-begin
3057 :contents-end contents-end
3058 :post-blank post-blank
3062 "Interpret TARGET object as Org syntax.
3063 CONTENTS is the contents of the object."
3067 "Search for the next radio-target object.
3069 LIMIT bounds the search.
3071 Return value is a cons cell whose CAR is `radio-target' and CDR
3072 is beginning position."
3078 ;;;; Statistics Cookie
3081 "Parse statistics cookie at point.
3083 Return a list whose CAR is `statistics-cookie', and CDR a plist
3084 with `:begin', `:end', `:value' and `:post-blank' keywords.
3086 Assume point is at the beginning of the statistics-cookie."
3097 :end end
3098 :value value
3102 "Interpret STATISTICS-COOKIE object as Org syntax.
3103 CONTENTS is nil."
3107 "Search for the next statistics cookie object.
3109 LIMIT bounds the search.
3111 Return value is a cons cell whose CAR is `statistics-cookie' and
3112 CDR is beginning position."
3118 ;;;; Strike-Through
3121 "Parse strike-through object at point.
3123 Return a list whose CAR is `strike-through' and CDR is a plist
3124 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3125 `:post-blank' keywords.
3127 Assume point is at the first plus sign marker."
3139 :end end
3140 :contents-begin contents-begin
3141 :contents-end contents-end
3145 "Interpret STRIKE-THROUGH object as Org syntax.
3146 CONTENTS is the contents of the object."
3150 ;;;; Subscript
3153 "Parse subscript at point.
3155 Return a list whose CAR is `subscript' and CDR a plist with
3156 `:begin', `:end', `:contents-begin', `:contents-end',
3157 `:use-brackets-p' and `:post-blank' as keywords.
3159 Assume point is at the underscore."
3163 t
3174 :end end
3175 :use-brackets-p bracketsp
3176 :contents-begin contents-begin
3177 :contents-end contents-end
3181 "Interpret SUBSCRIPT object as Org syntax.
3182 CONTENTS is the contents of the object."
3185 contents))
3188 "Search for the next sub/superscript object.
3190 LIMIT bounds the search.
3192 Return value is a cons cell whose CAR is either `subscript' or
3193 `superscript' and CDR is beginning position."
3201 ;;;; Superscript
3204 "Parse superscript at point.
3206 Return a list whose CAR is `superscript' and CDR a plist with
3207 `:begin', `:end', `:contents-begin', `:contents-end',
3208 `:use-brackets-p' and `:post-blank' as keywords.
3210 Assume point is at the caret."
3224 :end end
3225 :use-brackets-p bracketsp
3226 :contents-begin contents-begin
3227 :contents-end contents-end
3231 "Interpret SUPERSCRIPT object as Org syntax.
3232 CONTENTS is the contents of the object."
3235 contents))
3238 ;;;; Table Cell
3241 "Parse table cell at point.
3243 Return a list whose CAR is `table-cell' and CDR is a plist
3244 containing `:begin', `:end', `:contents-begin', `:contents-end'
3245 and `:post-blank' keywords."
3253 :end end
3254 :contents-begin contents-begin
3255 :contents-end contents-end
3259 "Interpret TABLE-CELL element as Org syntax.
3260 CONTENTS is the contents of the cell, or nil."
3264 "Search for the next table-cell object.
3266 LIMIT bounds the search.
3268 Return value is a cons cell whose CAR is `table-cell' and CDR is
3269 beginning position."
3273 ;;;; Target
3276 "Parse target at point.
3278 Return a list whose CAR is `target' and CDR a plist with
3279 `:begin', `:end', `:value' and `:post-blank' as keywords.
3281 Assume point is at the target."
3291 :end end
3292 :value value
3296 "Interpret TARGET object as Org syntax.
3297 CONTENTS is nil."
3301 "Search for the next target object.
3303 LIMIT bounds the search.
3305 Return value is a cons cell whose CAR is `target' and CDR is
3306 beginning position."
3312 ;;;; Timestamp
3315 "Parse time stamp at point.
3317 Return a list whose CAR is `timestamp', and CDR a plist with
3318 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3320 Assume point is at the beginning of the timestamp."
3339 :value main-value
3340 :range-end range-end
3341 :begin begin
3342 :end end
3346 "Interpret TIMESTAMP object as Org syntax.
3347 CONTENTS is nil."
3356 range-end)))))))
3359 "Search for the next timestamp object.
3361 LIMIT bounds the search.
3363 Return value is a cons cell whose CAR is `timestamp' and CDR is
3364 beginning position."
3372 limit t)
3376 ;;;; Underline
3379 "Parse underline object at point.
3381 Return a list whose CAR is `underline' and CDR is a plist with
3382 `:begin', `:end', `:contents-begin' and `:contents-end' and
3383 `:post-blank' keywords.
3385 Assume point is at the first underscore marker."
3397 :end end
3398 :contents-begin contents-begin
3399 :contents-end contents-end
3403 "Interpret UNDERLINE object as Org syntax.
3404 CONTENTS is the contents of the object."
3408 ;;;; Verbatim
3411 "Parse verbatim object at point.
3413 Return a list whose CAR is `verbatim' and CDR is a plist with
3414 `:value', `:begin', `:end' and `:post-blank' keywords.
3416 Assume point is at the first equal sign marker."
3427 :begin begin
3428 :end end
3432 "Interpret VERBATIM object as Org syntax.
3433 CONTENTS is nil."
3437 \f
3438 ;;; Parsing Element Starting At Point
3439 ;;
3440 ;; `org-element--current-element' is the core function of this section.
3441 ;; It returns the Lisp representation of the element starting at
3442 ;; point.
3443 ;;
3444 ;; `org-element--current-element' makes use of special modes. They
3445 ;; are activated for fixed element chaining (i.e. `plain-list' >
3446 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3447 ;; `section'). Special modes are: `first-section', `item',
3448 ;; `node-property', `quote-section', `section' and `table-row'.
3452 "Parse the element starting at point.
3454 LIMIT bounds the search.
3456 Return value is a list like (TYPE PROPS) where TYPE is the type
3457 of the element and PROPS a plist of properties associated to the
3458 element.
3460 Possible types are defined in `org-element-all-elements'.
3462 Optional argument GRANULARITY determines the depth of the
3463 recursion. Allowed values are `headline', `greater-element',
3464 `element', `object' or nil. When it is broader than `object' (or
3465 nil), secondary values will not be parsed, since they only
3466 contain objects.
3468 Optional argument SPECIAL, when non-nil, can be either
3469 `first-section', `item', `node-property', `quote-section',
3470 `section', and `table-row'.
3472 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3473 be computed.
3475 This function assumes point is always at the beginning of the
3476 element it has to parse."
3479 ;; Determine if parsing depth allows for secondary strings
3480 ;; parsing. It only applies to elements referenced in
3481 ;; `org-element-secondary-value-alist'.
3484 ;; Item.
3487 ;; Table Row.
3489 ;; Node Property.
3491 ;; Headline.
3494 ;; Sections (must be checked after headline).
3500 limit)))
3501 ;; When not at bol, point is at the beginning of an item or
3502 ;; a footnote definition: next item is always a paragraph.
3504 ;; Planning and Clock.
3509 ;; Inlinetask.
3512 ;; From there, elements can have affiliated keywords.
3515 ;; LaTeX Environment.
3521 nil t))
3524 ;; Drawer and Property Drawer.
3534 ;; Fixed Width
3537 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3538 ;; Keywords.
3547 org-element-block-name-alist)))
3562 ;; Footnote Definition.
3565 ;; Horizontal Rule.
3568 ;; Table.
3570 ;; List.
3574 ;; Default element: Paragraph.
3578 ;; Most elements can have affiliated keywords. When looking for an
3579 ;; element beginning, we want to move before them, as they belong to
3580 ;; that element, and, in the meantime, collect information they give
3581 ;; into appropriate properties. Hence the following function.
3584 "Collect affiliated keywords from point.
3586 Return a list whose CAR is the position at the first of them and
3587 CDR a plist of keywords and values and move point to the
3588 beginning of the first line after them.
3590 As a special case, if element doesn't start at the beginning of
3591 the line (i.e. a paragraph starting an item), CAR is current
3592 position of point and CDR is nil."
3596 ;; RESTRICT is the list of objects allowed in parsed
3597 ;; keywords value.
3599 output)
3602 ;; Apply translation to RAW-KWD. From there, KWD is
3603 ;; the official keyword.
3605 org-element-keyword-translation-alist))
3606 raw-kwd))
3607 ;; Find main value for any keyword.
3613 ;; PARSEDP is non-nil when keyword should have its
3614 ;; value parsed.
3616 ;; If KWD is a dual keyword, find its secondary
3617 ;; value. Maybe parse it.
3624 ;; Attribute a property name to KWD.
3626 ;; Now set final shape for VALUE.
3631 ;; Attributes can always appear on multiple lines.
3634 ;; Eventually store the new value in OUTPUT.
3636 ;; Move to next keyword.
3638 ;; If affiliated keywords are orphaned: move back to first one.
3639 ;; They will be parsed as a paragraph.
3641 ;; Return value.
3645 \f
3646 ;;; The Org Parser
3647 ;;
3648 ;; The two major functions here are `org-element-parse-buffer', which
3649 ;; parses Org syntax inside the current buffer, taking into account
3650 ;; region, narrowing, or even visibility if specified, and
3651 ;; `org-element-parse-secondary-string', which parses objects within
3652 ;; a given string.
3653 ;;
3654 ;; The (almost) almighty `org-element-map' allows to apply a function
3655 ;; on elements or objects matching some type, and accumulate the
3656 ;; resulting values. In an export situation, it also skips unneeded
3657 ;; parts of the parse tree.
3660 "Recursively parse the buffer and return structure.
3661 If narrowing is in effect, only parse the visible part of the
3662 buffer.
3664 Optional argument GRANULARITY determines the depth of the
3665 recursion. It can be set to the following symbols:
3667 `headline' Only parse headlines.
3668 `greater-element' Don't recurse into greater elements excepted
3669 headlines and sections. Thus, elements
3670 parsed are the top-level ones.
3671 `element' Parse everything but objects and plain text.
3672 `object' Parse the complete buffer (default).
3674 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3675 elements.
3677 Assume buffer is in Org mode."
3683 ;; Start in `first-section' mode so text before the first
3684 ;; headline belongs to a section.
3688 "Recursively parse objects in STRING and return structure.
3690 RESTRICTION is a symbol limiting the object types that will be
3691 looked after.
3693 Optional argument PARENT, when non-nil, is the element or object
3694 containing the secondary string. It is used to set correctly
3695 `:parent' property within the string."
3701 secondary))))
3705 "Map a function on selected elements or objects.
3707 DATA is the parsed tree, as returned by, i.e,
3708 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3709 of elements or objects types. FUN is the function called on the
3710 matching element or object. It must accept one arguments: the
3711 element or object itself.
3713 When optional argument INFO is non-nil, it should be a plist
3714 holding export options. In that case, parts of the parse tree
3715 not exportable according to that property list will be skipped.
3717 When optional argument FIRST-MATCH is non-nil, stop at the first
3718 match for which FUN doesn't return nil, and return that value.
3720 Optional argument NO-RECURSION is a symbol or a list of symbols
3721 representing elements or objects types. `org-element-map' won't
3722 enter any recursive element or object whose type belongs to that
3723 list. Though, FUN can still be applied on them.
3725 When optional argument WITH-AFFILIATED is non-nil, also move into
3726 affiliated keywords to find objects.
3728 Nil values returned from FUN do not appear in the results."
3729 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3732 ;; Recursion depth is determined by --CATEGORY.
3739 ;; If one object is found, the function
3740 ;; has to recurse into every object.
3743 ;; If one regular element is found, the
3744 ;; function has to recurse, at least,
3745 ;; into every element it encounters.
3748 types)
3749 category)))
3750 ;; Compute properties for affiliated keywords if necessary.
3755 org-element-affiliated-keywords)))
3756 --acc
3757 --walk-tree
3761 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3762 ;; holding contextual information.
3766 ;; Ignored element in an export context.
3768 ;; Secondary string: only objects can be found there.
3771 ;; Unconditionally enter parse trees.
3775 ;; Check if TYPE is matching among TYPES. If so,
3776 ;; apply FUN to --DATA and accumulate return value
3777 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3783 ;; If --DATA has a secondary string that can contain
3784 ;; objects with their type among TYPES, look into it.
3791 ;; If --DATA has any affiliated keywords and
3792 ;; WITH-AFFILIATED is non-nil, look for objects in
3793 ;; them.
3801 ;; Pay attention to the type of value.
3802 ;; Preserve order for multiple keywords.
3818 --affiliated-alist))
3819 ;; Determine if a recursion into --DATA is possible.
3821 ;; --TYPE is explicitly removed from recursion.
3823 ;; --DATA has no contents.
3825 ;; Looking for greater elements but --DATA is simply
3826 ;; an element or an object.
3829 ;; Looking for elements but --DATA is an object.
3832 ;; In any other case, map contents.
3836 ;; Return value in a proper order.
3839 ;; The following functions are internal parts of the parser.
3840 ;;
3841 ;; The first one, `org-element--parse-elements' acts at the element's
3842 ;; level.
3843 ;;
3844 ;; The second one, `org-element--parse-objects' applies on all objects
3845 ;; of a paragraph or a secondary string. It uses
3846 ;; `org-element--get-next-object-candidates' to optimize the search of
3847 ;; the next object in the buffer.
3848 ;;
3849 ;; More precisely, that function looks for every allowed object type
3850 ;; first. Then, it discards failed searches, keeps further matches,
3851 ;; and searches again types matched behind point, for subsequent
3852 ;; calls. Thus, searching for a given type fails only once, and every
3853 ;; object is searched only once at top level (but sometimes more for
3854 ;; nested types).
3858 "Parse elements between BEG and END positions.
3860 SPECIAL prioritize some elements over the others. It can be set
3861 to `first-section', `quote-section', `section' `item' or
3862 `table-row'.
3864 When value is `item', STRUCTURE will be used as the current list
3865 structure.
3867 GRANULARITY determines the depth of the recursion. See
3868 `org-element-parse-buffer' for more information.
3870 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3871 elements.
3873 Elements are accumulated into ACC."
3876 ;; When parsing only headlines, skip any text before first one.
3879 ;; Main loop start.
3881 ;; Find current element's type and parse it accordingly to
3882 ;; its category.
3884 end granularity special structure))
3888 ;; Fill ELEMENT contents by side-effect.
3890 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3891 ;; no contents, don't modify it.
3894 ;; Greater element: parse it between `contents-begin' and
3895 ;; `contents-end'. Make sure GRANULARITY allows the
3896 ;; recursion, or ELEMENT is an headline, in which case going
3897 ;; inside is mandatory, in order to get sub-level headings.
3905 ;; Possibly switch to a special mode.
3914 granularity visible-only element))
3915 ;; ELEMENT has contents. Parse objects inside, if
3916 ;; GRANULARITY allows it.
3922 ;; Return result.
3923 acc))
3926 "Parse objects between BEG and END and return recursive structure.
3928 Objects are accumulated in ACC.
3930 RESTRICTION is a list of object types which are allowed in the
3931 current object."
3937 end restriction candidates)))
3944 ;; 1. Text before any object. Untabify it.
3949 acc
3953 ;; 2. Object...
3956 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3957 ;; a recursive type.
3962 cont-beg
3969 ;; 3. Text after last object. Untabify it.
3973 acc
3977 ;; Result.
3978 acc)))
3981 "Return an alist of candidates for the next object.
3983 LIMIT bounds the search, and RESTRICTION narrows candidates to
3984 some object types.
3986 Return value is an alist whose CAR is position and CDR the object
3987 type, as a symbol.
3989 OBJECTS is the previous candidates alist."
3990 ;; Filter out any object found but not belonging to RESTRICTION.
3996 type)
3997 restriction)))
3998 objects))
4000 ;; If no previous result, search every object type in RESTRICTION.
4001 ;; Otherwise, keep potential candidates (old objects located after
4002 ;; point) and ask to search again those which had matched before.
4007 objects))
4008 ;; Call the appropriate successor function for each type to search
4009 ;; and accumulate matches.
4016 type))))
4019 types-to-search)
4020 ;; Return alist.
4021 next-candidates))
4024 \f
4025 ;;; Towards A Bijective Process
4026 ;;
4027 ;; The parse tree obtained with `org-element-parse-buffer' is really
4028 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4029 ;; interpreted and expanded into a string with canonical Org syntax.
4030 ;; Hence `org-element-interpret-data'.
4031 ;;
4032 ;; The function relies internally on
4033 ;; `org-element--interpret-affiliated-keywords'.
4035 ;;;###autoload
4037 "Interpret DATA as Org syntax.
4039 DATA is a parse tree, an element, an object or a secondary string
4040 to interpret.
4042 Optional argument PARENT is used for recursive calls. It contains
4043 the element or object containing data, or nil.
4045 Return Org syntax as a string."
4049 ;; Secondary string.
4054 ;; Full Org document.
4059 ;; Plain text.
4061 ;; Element/Object without contents.
4064 data nil))
4065 ;; Element/Object with contents.
4075 ;; Elements directly containing objects must
4076 ;; have their indentation normalized first.
4078 data
4079 ;; When normalizing first paragraph of an
4080 ;; item or a footnote-definition, ignore
4081 ;; first line's indentation.
4088 data
4090 contents)))))))
4092 ;; Build white spaces. If no `:post-blank' property is
4093 ;; specified, assume its value is 0.
4103 "Return ELEMENT's affiliated keywords as Org syntax.
4104 If there is no affiliated keyword, return the empty string."
4114 ": "
4117 value)
4125 ;; All attribute keywords can have multiple lines.
4131 ;; List all ELEMENT's properties matching an attribute line or an
4132 ;; affiliated keyword, but ignore translated keywords since they
4133 ;; cannot belong to the property list.
4140 org-element-keyword-translation-alist)))))
4141 collect prop)
4144 ;; Because interpretation of the parse tree must return the same
4145 ;; number of blank lines between elements and the same number of white
4146 ;; space after objects, some special care must be given to white
4147 ;; spaces.
4148 ;;
4149 ;; The first function, `org-element-normalize-string', ensures any
4150 ;; string different from the empty string will end with a single
4151 ;; newline character.
4152 ;;
4153 ;; The second function, `org-element-normalize-contents', removes
4154 ;; global indentation from the contents of the current element.
4157 "Ensure string S ends with a single newline character.
4159 If S isn't a string return it unchanged. If S is the empty
4160 string, return it. Otherwise, return a new string with a single
4161 newline character at its end."
4169 "Normalize plain text in ELEMENT's contents.
4171 ELEMENT must only contain plain text and objects.
4173 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4174 indentation to compute maximal common indentation.
4176 Return the normalized element that is element with global
4177 indentation removed from its contents. The function assumes that
4178 indentation is not done with TAB characters."
4180 collect-inds ; for byte-compiler
4183 ;; Return list of indentations within BLOB. This is done by
4184 ;; walking recursively BLOB and updating IND-LIST along the
4185 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4186 ;; been seen yet. It is required as this string is the only
4187 ;; one whose indentation doesn't happen after a newline
4188 ;; character.
4196 ;; An indentation of zero means no string will be
4197 ;; modified. Quit the process.
4203 ;; Avoid matching blank or empty lines.
4211 ;; Collect indentation list in ELEMENT. Possibly remove first
4212 ;; value if IGNORE-FIRST is non-nil.
4215 ;; Build ELEMENT back, replacing each string with the same
4216 ;; string minus common indentation.
4221 ;; Return BLOB with all its strings indentation
4222 ;; shortened from MCI white spaces. FIRST-FLAG is
4223 ;; non-nil when the first string hasn't been seen
4224 ;; yet.
4238 org-element-recursive-objects)
4242 blob))))
4246 \f
4247 ;;; The Toolbox
4248 ;;
4249 ;; The first move is to implement a way to obtain the smallest element
4250 ;; containing point. This is the job of `org-element-at-point'. It
4251 ;; basically jumps back to the beginning of section containing point
4252 ;; and moves, element after element, with
4253 ;; `org-element--current-element' until the container is found. Note:
4254 ;; When using `org-element-at-point', secondary values are never
4255 ;; parsed since the function focuses on elements, not on objects.
4256 ;;
4257 ;; At a deeper level, `org-element-context' lists all elements and
4258 ;; objects containing point.
4259 ;;
4260 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4261 ;; internally by navigation and manipulation tools.
4263 ;;;###autoload
4265 "Determine closest element around point.
4267 Return value is a list like (TYPE PROPS) where TYPE is the type
4268 of the element and PROPS a plist of properties associated to the
4269 element.
4271 Possible types are defined in `org-element-all-elements'.
4272 Properties depend on element or object type, but always
4273 include :begin, :end, :parent and :post-blank properties.
4275 As a special case, if point is at the very beginning of a list or
4276 sub-list, returned element will be that list instead of the first
4277 item. In the same way, if point is at the beginning of the first
4278 row of a table, returned element will be the table instead of the
4279 first row.
4281 If optional argument KEEP-TRAIL is non-nil, the function returns
4282 a list of of elements leading to element at point. The list's
4283 CAR is always the element at point. Following positions contain
4284 element's siblings, then parents, siblings of parents, until the
4285 first element of current section."
4287 ;; If at an headline, parse it. It is the sole element that
4288 ;; doesn't require to know about context. Be sure to disallow
4289 ;; secondary string parsing, though.
4295 ;; Otherwise move at the beginning of the section containing
4296 ;; point.
4300 element type special-flag trail struct prevs parent)
4308 ;; Parse successively each element, skipping those ending
4309 ;; before original position.
4318 ;; 1. Skip any element ending before point. Also skip
4319 ;; element ending at point when we're sure that another
4320 ;; element has started.
4325 ;; 2. An element containing point is always the element at
4326 ;; point.
4329 ;; 3. At any other greater element type, if point is
4330 ;; within contents, move into it.
4335 ;; Create an anchor for tables and plain lists:
4336 ;; when point is at the very beginning of these
4337 ;; elements, ignoring affiliated keywords,
4338 ;; target them instead of their contents.
4340 ;; When point is at contents end, do not move
4341 ;; into elements with an explicit ending, but
4342 ;; return that element instead.
4346 drawer dynamic-block inlinetask item
4347 plain-list property-drawer quote-block
4348 special-block))))
4361 ;;;###autoload
4363 "Return closest element or object around point.
4365 Return value is a list like (TYPE PROPS) where TYPE is the type
4366 of the element or object and PROPS a plist of properties
4367 associated to it.
4369 Possible types are defined in `org-element-all-elements' and
4370 `org-element-all-objects'. Properties depend on element or
4371 object type, but always include :begin, :end, :parent
4372 and :post-blank properties."
4377 end)
4378 ;; Check if point is inside an element containing objects or at
4379 ;; a secondary string. In that case, move to beginning of the
4380 ;; element or secondary string and set END to the other side.
4389 (<= origin
4390 ;; `1+' is required so some
4391 ;; successors can match
4392 ;; properly their object.
4406 element
4409 candidates)
4412 end restriction candidates))
4414 candidates)))
4415 ;; If ORIGIN is before next object in element, there's
4416 ;; no point in looking further.
4425 ;; ORIGIN is after OBJECT, so skip it.
4428 ;; ORIGIN is within a non-recursive object or at an
4429 ;; object boundaries: Return that object.
4433 ;; Otherwise, move within current object and restrict
4434 ;; search to the end of its contents.
4439 end cend)))))))
4440 parent))))))
4443 "Non-nil when elements ELEM-A and ELEM-B are nested."
4452 "Swap elements ELEM-A and ELEM-B.
4453 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4454 end of ELEM-A."
4456 ;; There are two special cases when an element doesn't start at bol:
4457 ;; the first paragraph in an item or in a footnote definition.
4459 ;; Only a paragraph without any affiliated keyword can be moved at
4460 ;; ELEM-A position in such a situation. Note that the case of
4461 ;; a footnote definition is impossible: it cannot contain two
4462 ;; paragraphs in a row because it cannot contain a blank line.
4468 ;; In a special situation, ELEM-A will have no indentation. We'll
4469 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4483 ;; Store overlays responsible for visibility status. We
4484 ;; also need to store their boundaries as they will be
4485 ;; removed from buffer.
4492 ;; Get contents.
4500 ;; Restore ex ELEM-A overlays.
4509 ;; Restore ex ELEM-B overlays.
4518 ;; Local variables:
4519 ;; generated-autoload-file: "org-loaddefs.el"
4520 ;; End:
4522 ;;; org-element.el ends here