| blob | a32c5d780bc0c9a4884c3b808b1b4609a63611eb |
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."
1803 :value value
1804 :begin begin
1805 :end end
1810 "Interpret KEYWORD element as Org syntax.
1811 CONTENTS is nil."
1817 ;;;; Latex Environment
1820 "Parse a LaTeX environment.
1822 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1823 the buffer position at the beginning of the first affiliated
1824 keyword and CDR is a plist of affiliated keywords along with
1825 their value.
1827 Return a list whose CAR is `latex-environment' and CDR is a plist
1828 containing `:begin', `:end', `:value' and `:post-blank'
1829 keywords.
1831 Assume point is at the beginning of the latex environment."
1838 limit t))
1839 ;; Incomplete latex environment: parse it as a paragraph.
1850 :end end
1851 :value value
1856 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1857 CONTENTS is nil."
1861 ;;;; Node Property
1864 "Parse a node-property at point.
1866 LIMIT bounds the search.
1868 Return a list whose CAR is `node-property' and CDR is a plist
1869 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1870 keywords."
1882 :value value
1883 :begin begin
1884 :end end
1888 "Interpret NODE-PROPERTY element as Org syntax.
1889 CONTENTS is nil."
1895 ;;;; Paragraph
1898 "Parse a paragraph.
1900 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1901 the buffer position at the beginning of the first affiliated
1902 keyword and CDR is a plist of affiliated keywords along with
1903 their value.
1905 Return a list whose CAR is `paragraph' and CDR is a plist
1906 containing `:begin', `:end', `:contents-begin' and
1907 `:contents-end' and `:post-blank' keywords.
1909 Assume point is at the beginning of the paragraph."
1918 limit
1919 ;; A matching `org-element-paragraph-separate' is not
1920 ;; necessarily the end of the paragraph. In
1921 ;; particular, lines starting with # or : as a first
1922 ;; non-space character are ambiguous. We have check
1923 ;; if they are valid Org syntax (i.e. not an
1924 ;; incomplete keyword).
1928 ;; There's no ambiguity for other symbols or
1929 ;; empty lines: stop here.
1931 ;; Stop at valid fixed-width areas.
1933 ;; Stop at drawers.
1938 ;; Stop at valid comments.
1940 ;; Stop at valid dynamic blocks.
1945 ;; Stop at valid blocks.
1952 limit t)))
1953 ;; Stop at valid latex environments.
1960 limit t)))
1961 ;; Stop at valid keywords.
1963 ;; Skip everything else.
1981 :end end
1982 :contents-begin contents-begin
1983 :contents-end contents-end
1988 "Interpret PARAGRAPH element as Org syntax.
1989 CONTENTS is the contents of the element."
1990 contents)
1993 ;;;; Planning
1996 "Parse a planning.
1998 LIMIT bounds the search.
2000 Return a list whose CAR is `planning' and CDR is a plist
2001 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2002 and `:post-blank' keywords."
2012 closed deadline scheduled)
2026 :deadline deadline
2027 :scheduled scheduled
2028 :begin begin
2029 :end end
2033 "Interpret PLANNING element as Org syntax.
2034 CONTENTS is nil."
2036 'identity
2048 ;;;; Quote Section
2051 "Parse a quote section.
2053 LIMIT bounds the search.
2055 Return a list whose CAR is `quote-section' and CDR is a plist
2056 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2058 Assume point is at beginning of the section."
2069 :end end
2070 :value value
2074 "Interpret QUOTE-SECTION element as Org syntax.
2075 CONTENTS is nil."
2079 ;;;; Src Block
2082 "Parse a src block.
2084 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2085 the buffer position at the beginning of the first affiliated
2086 keyword and CDR is a plist of affiliated keywords along with
2087 their value.
2089 Return a list whose CAR is `src-block' and CDR is a plist
2090 containing `:language', `:switches', `:parameters', `:begin',
2091 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2092 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2093 `:post-blank' keywords.
2095 Assume point is at the beginning of the block."
2098 limit t)))
2099 ;; Incomplete block: parse it as a paragraph.
2104 ;; Get language as a string.
2113 ;; Get switches.
2115 ;; Get parameters.
2117 ;; Switches analysis
2125 ;; Should labels be retained in (or stripped from)
2126 ;; src blocks?
2131 ;; What should code-references use - labels or
2132 ;; line-numbers?
2136 ;; Get visibility status.
2138 ;; Retrieve code.
2144 ;; Get position after ending blank lines.
2155 :begin begin
2156 :end end
2157 :number-lines number-lines
2158 :preserve-indent preserve-indent
2159 :retain-labels retain-labels
2160 :use-labels use-labels
2161 :label-fmt label-fmt
2162 :hiddenp hidden
2163 :value value
2168 "Interpret SRC-BLOCK element as Org syntax.
2169 CONTENTS is nil."
2192 ;;;; Table
2195 "Parse a table at point.
2197 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2198 the buffer position at the beginning of the first affiliated
2199 keyword and CDR is a plist of affiliated keywords along with
2200 their value.
2202 Return a list whose CAR is `table' and CDR is a plist containing
2203 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2204 `:contents-end', `:value' and `:post-blank' keywords.
2206 Assume point is at the beginning of the table."
2220 acc))
2228 :end end
2229 :type type
2230 :tblfm tblfm
2231 ;; Only `org' tables have contents. `table.el' tables
2232 ;; use a `:value' property to store raw table as
2233 ;; a string.
2238 table-begin table-end))
2243 "Interpret TABLE element as Org syntax.
2244 CONTENTS is nil."
2255 ;;;; Table Row
2258 "Parse table row at point.
2260 LIMIT bounds the search.
2262 Return a list whose CAR is `table-row' and CDR is a plist
2263 containing `:begin', `:end', `:contents-begin', `:contents-end',
2264 `:type' and `:post-blank' keywords."
2268 ;; A table rule has no contents. In that case, ensure
2269 ;; CONTENTS-BEGIN matches CONTENTS-END.
2281 :begin begin
2282 :end end
2283 :contents-begin contents-begin
2284 :contents-end contents-end
2288 "Interpret TABLE-ROW element as Org syntax.
2289 CONTENTS is the contents of the table row."
2294 ;;;; Verse Block
2297 "Parse a verse block.
2299 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2300 the buffer position at the beginning of the first affiliated
2301 keyword and CDR is a plist of affiliated keywords along with
2302 their value.
2304 Return a list whose CAR is `verse-block' and CDR is a plist
2305 containing `:begin', `:end', `:contents-begin', `:contents-end',
2306 `:hiddenp' and `:post-blank' keywords.
2308 Assume point is at beginning of the block."
2312 ;; Incomplete block: parse it as a paragraph.
2328 :end end
2329 :contents-begin contents-begin
2330 :contents-end contents-end
2331 :hiddenp hidden
2336 "Interpret VERSE-BLOCK element as Org syntax.
2337 CONTENTS is verse block contents."
2341 \f
2342 ;;; Objects
2343 ;;
2344 ;; Unlike to elements, interstices can be found between objects.
2345 ;; That's why, along with the parser, successor functions are provided
2346 ;; for each object. Some objects share the same successor (i.e. `code'
2347 ;; and `verbatim' objects).
2348 ;;
2349 ;; A successor must accept a single argument bounding the search. It
2350 ;; will return either a cons cell whose CAR is the object's type, as
2351 ;; a symbol, and CDR the position of its next occurrence, or nil.
2352 ;;
2353 ;; Successors follow the naming convention:
2354 ;; org-element-NAME-successor, where NAME is the name of the
2355 ;; successor, as defined in `org-element-all-successors'.
2356 ;;
2357 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2358 ;; object types they can contain will be specified in
2359 ;; `org-element-object-restrictions'.
2360 ;;
2361 ;; Adding a new type of object is simple. Implement a successor,
2362 ;; a parser, and an interpreter for it, all following the naming
2363 ;; convention. Register type in `org-element-all-objects' and
2364 ;; successor in `org-element-all-successors'. Maybe tweak
2365 ;; restrictions about it, and that's it.
2368 ;;;; Bold
2371 "Parse bold object at point.
2373 Return a list whose CAR is `bold' and CDR is a plist with
2374 `:begin', `:end', `:contents-begin' and `:contents-end' and
2375 `:post-blank' keywords.
2377 Assume point is at the first star marker."
2389 :end end
2390 :contents-begin contents-begin
2391 :contents-end contents-end
2395 "Interpret BOLD object as Org syntax.
2396 CONTENTS is the contents of the object."
2400 "Search for the next text-markup object.
2402 LIMIT bounds the search.
2404 Return value is a cons cell whose CAR is a symbol among `bold',
2405 `italic', `underline', `strike-through', `code' and `verbatim'
2406 and CDR is beginning position."
2422 ;;;; Code
2425 "Parse code object at point.
2427 Return a list whose CAR is `code' and CDR is a plist with
2428 `:value', `:begin', `:end' and `:post-blank' keywords.
2430 Assume point is at the first tilde marker."
2441 :begin begin
2442 :end end
2446 "Interpret CODE object as Org syntax.
2447 CONTENTS is nil."
2451 ;;;; Entity
2454 "Parse entity at point.
2456 Return a list whose CAR is `entity' and CDR a plist with
2457 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2458 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2459 keywords.
2461 Assume point is at the beginning of the entity."
2463 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2479 :begin begin
2480 :end end
2481 :use-brackets-p bracketsp
2485 "Interpret ENTITY object as Org syntax.
2486 CONTENTS is nil."
2492 "Search for the next latex-fragment or entity object.
2494 LIMIT bounds the search.
2496 Return value is a cons cell whose CAR is `entity' or
2497 `latex-fragment' and CDR is beginning position."
2502 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2509 limit t)
2512 ;; Determine if it's a real entity or a LaTeX command.
2515 ;; No entity nor command: point is at a LaTeX fragment.
2516 ;; Determine its type to get the correct beginning position.
2524 matchers)
2528 ;;;; Export Snippet
2531 "Parse export snippet at point.
2533 Return a list whose CAR is `export-snippet' and CDR a plist with
2534 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2535 keywords.
2537 Assume point is at the beginning of the snippet."
2549 :value value
2550 :begin begin
2551 :end end
2555 "Interpret EXPORT-SNIPPET object as Org syntax.
2556 CONTENTS is nil."
2562 "Search for the next export-snippet object.
2564 LIMIT bounds the search.
2566 Return value is a cons cell whose CAR is `export-snippet' and CDR
2567 its beginning position."
2576 ;;;; Footnote Reference
2579 "Parse footnote reference at point.
2581 Return a list whose CAR is `footnote-reference' and CDR a plist
2582 with `:label', `:type', `:inline-definition', `:begin', `:end'
2583 and `:post-blank' as keywords."
2605 :type type
2606 :begin begin
2607 :end end
2610 footnote-reference :inline-definition
2615 footnote-reference))))))
2618 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2619 CONTENTS is nil."
2629 "Search for the next footnote-reference object.
2631 LIMIT bounds the search.
2633 Return value is a cons cell whose CAR is `footnote-reference' and
2634 CDR is beginning position."
2648 ;;;; Inline Babel Call
2651 "Parse inline babel call at point.
2653 Return a list whose CAR is `inline-babel-call' and CDR a plist
2654 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2656 Assume point is at the beginning of the babel call."
2667 :end end
2668 :info info
2672 "Interpret INLINE-BABEL-CALL object as Org syntax.
2673 CONTENTS is nil."
2679 ;; Remove redundant square brackets.
2682 main-source)
2686 "Search for the next inline-babel-call object.
2688 LIMIT bounds the search.
2690 Return value is a cons cell whose CAR is `inline-babel-call' and
2691 CDR is beginning position."
2693 ;; Use a simplified version of
2694 ;; `org-babel-inline-lob-one-liner-regexp'.
2697 limit t)
2701 ;;;; Inline Src Block
2704 "Parse inline source block at point.
2706 LIMIT bounds the search.
2708 Return a list whose CAR is `inline-src-block' and CDR a plist
2709 with `:begin', `:end', `:language', `:value', `:parameters' and
2710 `:post-blank' as keywords.
2712 Assume point is at the beginning of the inline src block."
2725 :value value
2726 :parameters parameters
2727 :begin begin
2728 :end end
2732 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2733 CONTENTS is nil."
2738 language
2740 body)))
2743 "Search for the next inline-babel-call element.
2745 LIMIT bounds the search.
2747 Return value is a cons cell whose CAR is `inline-babel-call' and
2748 CDR is beginning position."
2754 ;;;; Italic
2757 "Parse italic object at point.
2759 Return a list whose CAR is `italic' and CDR is a plist with
2760 `:begin', `:end', `:contents-begin' and `:contents-end' and
2761 `:post-blank' keywords.
2763 Assume point is at the first slash marker."
2775 :end end
2776 :contents-begin contents-begin
2777 :contents-end contents-end
2781 "Interpret ITALIC object as Org syntax.
2782 CONTENTS is the contents of the object."
2786 ;;;; Latex Fragment
2789 "Parse latex fragment at point.
2791 Return a list whose CAR is `latex-fragment' and CDR a plist with
2792 `:value', `:begin', `:end', and `:post-blank' as keywords.
2794 Assume point is at the beginning of the latex fragment."
2808 ;; None found: it's a macro.
2817 :begin begin
2818 :end end
2822 "Interpret LATEX-FRAGMENT object as Org syntax.
2823 CONTENTS is nil."
2826 ;;;; Line Break
2829 "Parse line break at point.
2831 Return a list whose CAR is `line-break', and CDR a plist with
2832 `:begin', `:end' and `:post-blank' keywords.
2834 Assume point is at the beginning of the line break."
2838 "Interpret LINE-BREAK object as Org syntax.
2839 CONTENTS is nil."
2843 "Search for the next line-break object.
2845 LIMIT bounds the search.
2847 Return value is a cons cell whose CAR is `line-break' and CDR is
2848 beginning position."
2852 ;; A line break can only happen on a non-empty line.
2857 ;;;; Link
2860 "Parse link at point.
2862 Return a list whose CAR is `link' and CDR a plist with `:type',
2863 `:path', `:raw-link', `:application', `:search-option', `:begin',
2864 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2865 keywords.
2867 Assume point is at the beginning of the link."
2870 end contents-begin contents-end link-end post-blank path type
2871 raw-link link search-option application)
2873 ;; Type 1: Text targeted from a radio target.
2878 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2883 ;; RAW-LINK is the original link.
2888 ;; Determine TYPE of link and set PATH accordingly.
2890 ;; File type.
2893 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2896 ;; Id type: PATH is the id.
2899 ;; Code-ref type: PATH is the name of the reference.
2902 ;; Custom-id type: PATH is the name of the custom id.
2905 ;; Fuzzy type: Internal link either matches a target, an
2906 ;; headline name or nothing. PATH is the target or
2907 ;; headline's name.
2909 ;; Type 3: Plain link, i.e. http://orgmode.org
2915 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2922 ;; In any case, deduce end point after trailing white space from
2923 ;; LINK-END variable.
2926 ;; Extract search option and opening application out of
2927 ;; "file"-type links.
2929 ;; Application.
2934 ;; Extract search option from PATH.
2938 ;; Make sure TYPE always report "file".
2942 :path path
2944 :application application
2945 :search-option search-option
2946 :begin begin
2947 :end end
2948 :contents-begin contents-begin
2949 :contents-end contents-end
2953 "Interpret LINK object as Org syntax.
2954 CONTENTS is the contents of the object, or nil."
2959 raw-link
2963 "Search for the next link object.
2965 LIMIT bounds the search.
2967 Return value is a cons cell whose CAR is `link' and CDR is
2968 beginning position."
2977 ;;;; Macro
2980 "Parse macro at point.
2982 Return a list whose CAR is `macro' and CDR a plist with `:key',
2983 `:args', `:begin', `:end', `:value' and `:post-blank' as
2984 keywords.
2986 Assume point is at the macro."
3000 ;; Repair bad splits.
3008 :value value
3009 :args args
3010 :begin begin
3011 :end end
3015 "Interpret MACRO object as Org syntax.
3016 CONTENTS is nil."
3020 "Search for the next macro object.
3022 LIMIT bounds the search.
3024 Return value is cons cell whose CAR is `macro' and CDR is
3025 beginning position."
3029 limit t)
3033 ;;;; Radio-target
3036 "Parse radio target at point.
3038 Return a list whose CAR is `radio-target' and CDR a plist with
3039 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3040 and `:post-blank' as keywords.
3042 Assume point is at the radio target."
3054 :end end
3055 :contents-begin contents-begin
3056 :contents-end contents-end
3057 :post-blank post-blank
3061 "Interpret TARGET object as Org syntax.
3062 CONTENTS is the contents of the object."
3066 "Search for the next radio-target object.
3068 LIMIT bounds the search.
3070 Return value is a cons cell whose CAR is `radio-target' and CDR
3071 is beginning position."
3077 ;;;; Statistics Cookie
3080 "Parse statistics cookie at point.
3082 Return a list whose CAR is `statistics-cookie', and CDR a plist
3083 with `:begin', `:end', `:value' and `:post-blank' keywords.
3085 Assume point is at the beginning of the statistics-cookie."
3096 :end end
3097 :value value
3101 "Interpret STATISTICS-COOKIE object as Org syntax.
3102 CONTENTS is nil."
3106 "Search for the next statistics cookie object.
3108 LIMIT bounds the search.
3110 Return value is a cons cell whose CAR is `statistics-cookie' and
3111 CDR is beginning position."
3117 ;;;; Strike-Through
3120 "Parse strike-through object at point.
3122 Return a list whose CAR is `strike-through' and CDR is a plist
3123 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3124 `:post-blank' keywords.
3126 Assume point is at the first plus sign marker."
3138 :end end
3139 :contents-begin contents-begin
3140 :contents-end contents-end
3144 "Interpret STRIKE-THROUGH object as Org syntax.
3145 CONTENTS is the contents of the object."
3149 ;;;; Subscript
3152 "Parse subscript at point.
3154 Return a list whose CAR is `subscript' and CDR a plist with
3155 `:begin', `:end', `:contents-begin', `:contents-end',
3156 `:use-brackets-p' and `:post-blank' as keywords.
3158 Assume point is at the underscore."
3162 t
3173 :end end
3174 :use-brackets-p bracketsp
3175 :contents-begin contents-begin
3176 :contents-end contents-end
3180 "Interpret SUBSCRIPT object as Org syntax.
3181 CONTENTS is the contents of the object."
3184 contents))
3187 "Search for the next sub/superscript object.
3189 LIMIT bounds the search.
3191 Return value is a cons cell whose CAR is either `subscript' or
3192 `superscript' and CDR is beginning position."
3200 ;;;; Superscript
3203 "Parse superscript at point.
3205 Return a list whose CAR is `superscript' and CDR a plist with
3206 `:begin', `:end', `:contents-begin', `:contents-end',
3207 `:use-brackets-p' and `:post-blank' as keywords.
3209 Assume point is at the caret."
3223 :end end
3224 :use-brackets-p bracketsp
3225 :contents-begin contents-begin
3226 :contents-end contents-end
3230 "Interpret SUPERSCRIPT object as Org syntax.
3231 CONTENTS is the contents of the object."
3234 contents))
3237 ;;;; Table Cell
3240 "Parse table cell at point.
3242 Return a list whose CAR is `table-cell' and CDR is a plist
3243 containing `:begin', `:end', `:contents-begin', `:contents-end'
3244 and `:post-blank' keywords."
3252 :end end
3253 :contents-begin contents-begin
3254 :contents-end contents-end
3258 "Interpret TABLE-CELL element as Org syntax.
3259 CONTENTS is the contents of the cell, or nil."
3263 "Search for the next table-cell object.
3265 LIMIT bounds the search.
3267 Return value is a cons cell whose CAR is `table-cell' and CDR is
3268 beginning position."
3272 ;;;; Target
3275 "Parse target at point.
3277 Return a list whose CAR is `target' and CDR a plist with
3278 `:begin', `:end', `:value' and `:post-blank' as keywords.
3280 Assume point is at the target."
3290 :end end
3291 :value value
3295 "Interpret TARGET object as Org syntax.
3296 CONTENTS is nil."
3300 "Search for the next target object.
3302 LIMIT bounds the search.
3304 Return value is a cons cell whose CAR is `target' and CDR is
3305 beginning position."
3311 ;;;; Timestamp
3314 "Parse time stamp at point.
3316 Return a list whose CAR is `timestamp', and CDR a plist with
3317 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3319 Assume point is at the beginning of the timestamp."
3338 :value main-value
3339 :range-end range-end
3340 :begin begin
3341 :end end
3345 "Interpret TIMESTAMP object as Org syntax.
3346 CONTENTS is nil."
3355 range-end)))))))
3358 "Search for the next timestamp object.
3360 LIMIT bounds the search.
3362 Return value is a cons cell whose CAR is `timestamp' and CDR is
3363 beginning position."
3371 limit t)
3375 ;;;; Underline
3378 "Parse underline object at point.
3380 Return a list whose CAR is `underline' and CDR is a plist with
3381 `:begin', `:end', `:contents-begin' and `:contents-end' and
3382 `:post-blank' keywords.
3384 Assume point is at the first underscore marker."
3396 :end end
3397 :contents-begin contents-begin
3398 :contents-end contents-end
3402 "Interpret UNDERLINE object as Org syntax.
3403 CONTENTS is the contents of the object."
3407 ;;;; Verbatim
3410 "Parse verbatim object at point.
3412 Return a list whose CAR is `verbatim' and CDR is a plist with
3413 `:value', `:begin', `:end' and `:post-blank' keywords.
3415 Assume point is at the first equal sign marker."
3426 :begin begin
3427 :end end
3431 "Interpret VERBATIM object as Org syntax.
3432 CONTENTS is nil."
3436 \f
3437 ;;; Parsing Element Starting At Point
3438 ;;
3439 ;; `org-element--current-element' is the core function of this section.
3440 ;; It returns the Lisp representation of the element starting at
3441 ;; point.
3442 ;;
3443 ;; `org-element--current-element' makes use of special modes. They
3444 ;; are activated for fixed element chaining (i.e. `plain-list' >
3445 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3446 ;; `section'). Special modes are: `first-section', `item',
3447 ;; `node-property', `quote-section', `section' and `table-row'.
3451 "Parse the element starting at point.
3453 LIMIT bounds the search.
3455 Return value is a list like (TYPE PROPS) where TYPE is the type
3456 of the element and PROPS a plist of properties associated to the
3457 element.
3459 Possible types are defined in `org-element-all-elements'.
3461 Optional argument GRANULARITY determines the depth of the
3462 recursion. Allowed values are `headline', `greater-element',
3463 `element', `object' or nil. When it is broader than `object' (or
3464 nil), secondary values will not be parsed, since they only
3465 contain objects.
3467 Optional argument SPECIAL, when non-nil, can be either
3468 `first-section', `item', `node-property', `quote-section',
3469 `section', and `table-row'.
3471 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3472 be computed.
3474 This function assumes point is always at the beginning of the
3475 element it has to parse."
3478 ;; Determine if parsing depth allows for secondary strings
3479 ;; parsing. It only applies to elements referenced in
3480 ;; `org-element-secondary-value-alist'.
3483 ;; Item.
3486 ;; Table Row.
3488 ;; Node Property.
3490 ;; Headline.
3493 ;; Sections (must be checked after headline).
3499 limit)))
3500 ;; When not at bol, point is at the beginning of an item or
3501 ;; a footnote definition: next item is always a paragraph.
3503 ;; Planning and Clock.
3508 ;; Inlinetask.
3511 ;; From there, elements can have affiliated keywords.
3514 ;; LaTeX Environment.
3517 ;; Drawer and Property Drawer.
3522 ;; Fixed Width
3525 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3526 ;; Keywords.
3535 org-element-block-name-alist)))
3550 ;; Footnote Definition.
3553 ;; Horizontal Rule.
3556 ;; Table.
3558 ;; List.
3562 ;; Default element: Paragraph.
3566 ;; Most elements can have affiliated keywords. When looking for an
3567 ;; element beginning, we want to move before them, as they belong to
3568 ;; that element, and, in the meantime, collect information they give
3569 ;; into appropriate properties. Hence the following function.
3572 "Collect affiliated keywords from point.
3574 Return a list whose CAR is the position at the first of them and
3575 CDR a plist of keywords and values and move point to the
3576 beginning of the first line after them.
3578 As a special case, if element doesn't start at the beginning of
3579 the line (i.e. a paragraph starting an item), CAR is current
3580 position of point and CDR is nil."
3584 ;; RESTRICT is the list of objects allowed in parsed
3585 ;; keywords value.
3587 output)
3590 ;; Apply translation to RAW-KWD. From there, KWD is
3591 ;; the official keyword.
3593 org-element-keyword-translation-alist))
3594 raw-kwd))
3595 ;; Find main value for any keyword.
3601 ;; PARSEDP is non-nil when keyword should have its
3602 ;; value parsed.
3604 ;; If KWD is a dual keyword, find its secondary
3605 ;; value. Maybe parse it.
3612 ;; Attribute a property name to KWD.
3614 ;; Now set final shape for VALUE.
3619 ;; Attributes can always appear on multiple lines.
3622 ;; Eventually store the new value in OUTPUT.
3624 ;; Move to next keyword.
3626 ;; If affiliated keywords are orphaned: move back to first one.
3627 ;; They will be parsed as a paragraph.
3629 ;; Return value.
3633 \f
3634 ;;; The Org Parser
3635 ;;
3636 ;; The two major functions here are `org-element-parse-buffer', which
3637 ;; parses Org syntax inside the current buffer, taking into account
3638 ;; region, narrowing, or even visibility if specified, and
3639 ;; `org-element-parse-secondary-string', which parses objects within
3640 ;; a given string.
3641 ;;
3642 ;; The (almost) almighty `org-element-map' allows to apply a function
3643 ;; on elements or objects matching some type, and accumulate the
3644 ;; resulting values. In an export situation, it also skips unneeded
3645 ;; parts of the parse tree.
3648 "Recursively parse the buffer and return structure.
3649 If narrowing is in effect, only parse the visible part of the
3650 buffer.
3652 Optional argument GRANULARITY determines the depth of the
3653 recursion. It can be set to the following symbols:
3655 `headline' Only parse headlines.
3656 `greater-element' Don't recurse into greater elements excepted
3657 headlines and sections. Thus, elements
3658 parsed are the top-level ones.
3659 `element' Parse everything but objects and plain text.
3660 `object' Parse the complete buffer (default).
3662 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3663 elements.
3665 Assume buffer is in Org mode."
3671 ;; Start in `first-section' mode so text before the first
3672 ;; headline belongs to a section.
3676 "Recursively parse objects in STRING and return structure.
3678 RESTRICTION is a symbol limiting the object types that will be
3679 looked after.
3681 Optional argument PARENT, when non-nil, is the element or object
3682 containing the secondary string. It is used to set correctly
3683 `:parent' property within the string."
3689 secondary))))
3693 "Map a function on selected elements or objects.
3695 DATA is the parsed tree, as returned by, i.e,
3696 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3697 of elements or objects types. FUN is the function called on the
3698 matching element or object. It must accept one arguments: the
3699 element or object itself.
3701 When optional argument INFO is non-nil, it should be a plist
3702 holding export options. In that case, parts of the parse tree
3703 not exportable according to that property list will be skipped.
3705 When optional argument FIRST-MATCH is non-nil, stop at the first
3706 match for which FUN doesn't return nil, and return that value.
3708 Optional argument NO-RECURSION is a symbol or a list of symbols
3709 representing elements or objects types. `org-element-map' won't
3710 enter any recursive element or object whose type belongs to that
3711 list. Though, FUN can still be applied on them.
3713 When optional argument WITH-AFFILIATED is non-nil, also move into
3714 affiliated keywords to find objects.
3716 Nil values returned from FUN do not appear in the results."
3717 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3720 ;; Recursion depth is determined by --CATEGORY.
3727 ;; If one object is found, the function
3728 ;; has to recurse into every object.
3731 ;; If one regular element is found, the
3732 ;; function has to recurse, at least,
3733 ;; into every element it encounters.
3736 types)
3737 category)))
3738 ;; Compute properties for affiliated keywords if necessary.
3743 org-element-affiliated-keywords)))
3744 --acc
3745 --walk-tree
3749 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3750 ;; holding contextual information.
3754 ;; Ignored element in an export context.
3756 ;; Secondary string: only objects can be found there.
3759 ;; Unconditionally enter parse trees.
3763 ;; Check if TYPE is matching among TYPES. If so,
3764 ;; apply FUN to --DATA and accumulate return value
3765 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3771 ;; If --DATA has a secondary string that can contain
3772 ;; objects with their type among TYPES, look into it.
3779 ;; If --DATA has any affiliated keywords and
3780 ;; WITH-AFFILIATED is non-nil, look for objects in
3781 ;; them.
3789 ;; Pay attention to the type of value.
3790 ;; Preserve order for multiple keywords.
3806 --affiliated-alist))
3807 ;; Determine if a recursion into --DATA is possible.
3809 ;; --TYPE is explicitly removed from recursion.
3811 ;; --DATA has no contents.
3813 ;; Looking for greater elements but --DATA is simply
3814 ;; an element or an object.
3817 ;; Looking for elements but --DATA is an object.
3820 ;; In any other case, map contents.
3824 ;; Return value in a proper order.
3827 ;; The following functions are internal parts of the parser.
3828 ;;
3829 ;; The first one, `org-element--parse-elements' acts at the element's
3830 ;; level.
3831 ;;
3832 ;; The second one, `org-element--parse-objects' applies on all objects
3833 ;; of a paragraph or a secondary string. It uses
3834 ;; `org-element--get-next-object-candidates' to optimize the search of
3835 ;; the next object in the buffer.
3836 ;;
3837 ;; More precisely, that function looks for every allowed object type
3838 ;; first. Then, it discards failed searches, keeps further matches,
3839 ;; and searches again types matched behind point, for subsequent
3840 ;; calls. Thus, searching for a given type fails only once, and every
3841 ;; object is searched only once at top level (but sometimes more for
3842 ;; nested types).
3846 "Parse elements between BEG and END positions.
3848 SPECIAL prioritize some elements over the others. It can be set
3849 to `first-section', `quote-section', `section' `item' or
3850 `table-row'.
3852 When value is `item', STRUCTURE will be used as the current list
3853 structure.
3855 GRANULARITY determines the depth of the recursion. See
3856 `org-element-parse-buffer' for more information.
3858 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3859 elements.
3861 Elements are accumulated into ACC."
3864 ;; When parsing only headlines, skip any text before first one.
3867 ;; Main loop start.
3869 ;; Find current element's type and parse it accordingly to
3870 ;; its category.
3872 end granularity special structure))
3876 ;; Fill ELEMENT contents by side-effect.
3878 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3879 ;; no contents, don't modify it.
3882 ;; Greater element: parse it between `contents-begin' and
3883 ;; `contents-end'. Make sure GRANULARITY allows the
3884 ;; recursion, or ELEMENT is an headline, in which case going
3885 ;; inside is mandatory, in order to get sub-level headings.
3893 ;; Possibly switch to a special mode.
3902 granularity visible-only element))
3903 ;; ELEMENT has contents. Parse objects inside, if
3904 ;; GRANULARITY allows it.
3910 ;; Return result.
3911 acc))
3914 "Parse objects between BEG and END and return recursive structure.
3916 Objects are accumulated in ACC.
3918 RESTRICTION is a list of object types which are allowed in the
3919 current object."
3925 end restriction candidates)))
3932 ;; 1. Text before any object. Untabify it.
3937 acc
3941 ;; 2. Object...
3944 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3945 ;; a recursive type.
3950 cont-beg
3957 ;; 3. Text after last object. Untabify it.
3961 acc
3965 ;; Result.
3966 acc)))
3969 "Return an alist of candidates for the next object.
3971 LIMIT bounds the search, and RESTRICTION narrows candidates to
3972 some object types.
3974 Return value is an alist whose CAR is position and CDR the object
3975 type, as a symbol.
3977 OBJECTS is the previous candidates alist."
3978 ;; Filter out any object found but not belonging to RESTRICTION.
3984 type)
3985 restriction)))
3986 objects))
3988 ;; If no previous result, search every object type in RESTRICTION.
3989 ;; Otherwise, keep potential candidates (old objects located after
3990 ;; point) and ask to search again those which had matched before.
3995 objects))
3996 ;; Call the appropriate successor function for each type to search
3997 ;; and accumulate matches.
4004 type))))
4007 types-to-search)
4008 ;; Return alist.
4009 next-candidates))
4012 \f
4013 ;;; Towards A Bijective Process
4014 ;;
4015 ;; The parse tree obtained with `org-element-parse-buffer' is really
4016 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4017 ;; interpreted and expanded into a string with canonical Org syntax.
4018 ;; Hence `org-element-interpret-data'.
4019 ;;
4020 ;; The function relies internally on
4021 ;; `org-element--interpret-affiliated-keywords'.
4023 ;;;###autoload
4025 "Interpret DATA as Org syntax.
4027 DATA is a parse tree, an element, an object or a secondary string
4028 to interpret.
4030 Optional argument PARENT is used for recursive calls. It contains
4031 the element or object containing data, or nil.
4033 Return Org syntax as a string."
4037 ;; Secondary string.
4042 ;; Full Org document.
4047 ;; Plain text.
4049 ;; Element/Object without contents.
4052 data nil))
4053 ;; Element/Object with contents.
4063 ;; Elements directly containing objects must
4064 ;; have their indentation normalized first.
4066 data
4067 ;; When normalizing first paragraph of an
4068 ;; item or a footnote-definition, ignore
4069 ;; first line's indentation.
4076 data
4078 contents)))))))
4080 ;; Build white spaces. If no `:post-blank' property is
4081 ;; specified, assume its value is 0.
4091 "Return ELEMENT's affiliated keywords as Org syntax.
4092 If there is no affiliated keyword, return the empty string."
4102 ": "
4105 value)
4113 ;; All attribute keywords can have multiple lines.
4119 ;; List all ELEMENT's properties matching an attribute line or an
4120 ;; affiliated keyword, but ignore translated keywords since they
4121 ;; cannot belong to the property list.
4128 org-element-keyword-translation-alist)))))
4129 collect prop)
4132 ;; Because interpretation of the parse tree must return the same
4133 ;; number of blank lines between elements and the same number of white
4134 ;; space after objects, some special care must be given to white
4135 ;; spaces.
4136 ;;
4137 ;; The first function, `org-element-normalize-string', ensures any
4138 ;; string different from the empty string will end with a single
4139 ;; newline character.
4140 ;;
4141 ;; The second function, `org-element-normalize-contents', removes
4142 ;; global indentation from the contents of the current element.
4145 "Ensure string S ends with a single newline character.
4147 If S isn't a string return it unchanged. If S is the empty
4148 string, return it. Otherwise, return a new string with a single
4149 newline character at its end."
4157 "Normalize plain text in ELEMENT's contents.
4159 ELEMENT must only contain plain text and objects.
4161 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4162 indentation to compute maximal common indentation.
4164 Return the normalized element that is element with global
4165 indentation removed from its contents. The function assumes that
4166 indentation is not done with TAB characters."
4168 collect-inds ; for byte-compiler
4171 ;; Return list of indentations within BLOB. This is done by
4172 ;; walking recursively BLOB and updating IND-LIST along the
4173 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4174 ;; been seen yet. It is required as this string is the only
4175 ;; one whose indentation doesn't happen after a newline
4176 ;; character.
4184 ;; An indentation of zero means no string will be
4185 ;; modified. Quit the process.
4191 ;; Avoid matching blank or empty lines.
4199 ;; Collect indentation list in ELEMENT. Possibly remove first
4200 ;; value if IGNORE-FIRST is non-nil.
4203 ;; Build ELEMENT back, replacing each string with the same
4204 ;; string minus common indentation.
4209 ;; Return BLOB with all its strings indentation
4210 ;; shortened from MCI white spaces. FIRST-FLAG is
4211 ;; non-nil when the first string hasn't been seen
4212 ;; yet.
4226 org-element-recursive-objects)
4230 blob))))
4234 \f
4235 ;;; The Toolbox
4236 ;;
4237 ;; The first move is to implement a way to obtain the smallest element
4238 ;; containing point. This is the job of `org-element-at-point'. It
4239 ;; basically jumps back to the beginning of section containing point
4240 ;; and moves, element after element, with
4241 ;; `org-element--current-element' until the container is found. Note:
4242 ;; When using `org-element-at-point', secondary values are never
4243 ;; parsed since the function focuses on elements, not on objects.
4244 ;;
4245 ;; At a deeper level, `org-element-context' lists all elements and
4246 ;; objects containing point.
4247 ;;
4248 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4249 ;; internally by navigation and manipulation tools.
4251 ;;;###autoload
4253 "Determine closest element around point.
4255 Return value is a list like (TYPE PROPS) where TYPE is the type
4256 of the element and PROPS a plist of properties associated to the
4257 element.
4259 Possible types are defined in `org-element-all-elements'.
4260 Properties depend on element or object type, but always
4261 include :begin, :end, :parent and :post-blank properties.
4263 As a special case, if point is at the very beginning of a list or
4264 sub-list, returned element will be that list instead of the first
4265 item. In the same way, if point is at the beginning of the first
4266 row of a table, returned element will be the table instead of the
4267 first row.
4269 If optional argument KEEP-TRAIL is non-nil, the function returns
4270 a list of of elements leading to element at point. The list's
4271 CAR is always the element at point. Following positions contain
4272 element's siblings, then parents, siblings of parents, until the
4273 first element of current section."
4275 ;; If at an headline, parse it. It is the sole element that
4276 ;; doesn't require to know about context. Be sure to disallow
4277 ;; secondary string parsing, though.
4283 ;; Otherwise move at the beginning of the section containing
4284 ;; point.
4288 element type special-flag trail struct prevs parent)
4296 ;; Parse successively each element, skipping those ending
4297 ;; before original position.
4306 ;; 1. Skip any element ending before point. Also skip
4307 ;; element ending at point when we're sure that another
4308 ;; element has started.
4313 ;; 2. An element containing point is always the element at
4314 ;; point.
4317 ;; 3. At any other greater element type, if point is
4318 ;; within contents, move into it.
4323 ;; Create an anchor for tables and plain lists:
4324 ;; when point is at the very beginning of these
4325 ;; elements, ignoring affiliated keywords,
4326 ;; target them instead of their contents.
4328 ;; When point is at contents end, do not move
4329 ;; into elements with an explicit ending, but
4330 ;; return that element instead.
4334 drawer dynamic-block inlinetask item
4335 plain-list property-drawer quote-block
4336 special-block))))
4349 ;;;###autoload
4351 "Return closest element or object around point.
4353 Return value is a list like (TYPE PROPS) where TYPE is the type
4354 of the element or object and PROPS a plist of properties
4355 associated to it.
4357 Possible types are defined in `org-element-all-elements' and
4358 `org-element-all-objects'. Properties depend on element or
4359 object type, but always include :begin, :end, :parent
4360 and :post-blank properties."
4365 end)
4366 ;; Check if point is inside an element containing objects or at
4367 ;; a secondary string. In that case, move to beginning of the
4368 ;; element or secondary string and set END to the other side.
4377 (<= origin
4378 ;; `1+' is required so some
4379 ;; successors can match
4380 ;; properly their object.
4394 element
4397 candidates)
4400 end restriction candidates))
4402 candidates)))
4403 ;; If ORIGIN is before next object in element, there's
4404 ;; no point in looking further.
4413 ;; ORIGIN is after OBJECT, so skip it.
4416 ;; ORIGIN is within a non-recursive object or at an
4417 ;; object boundaries: Return that object.
4421 ;; Otherwise, move within current object and restrict
4422 ;; search to the end of its contents.
4427 end cend)))))))
4428 parent))))))
4431 "Non-nil when elements ELEM-A and ELEM-B are nested."
4440 "Swap elements ELEM-A and ELEM-B.
4441 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4442 end of ELEM-A."
4444 ;; There are two special cases when an element doesn't start at bol:
4445 ;; the first paragraph in an item or in a footnote definition.
4447 ;; Only a paragraph without any affiliated keyword can be moved at
4448 ;; ELEM-A position in such a situation. Note that the case of
4449 ;; a footnote definition is impossible: it cannot contain two
4450 ;; paragraphs in a row because it cannot contain a blank line.
4456 ;; In a special situation, ELEM-A will have no indentation. We'll
4457 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4471 ;; Store overlays responsible for visibility status. We
4472 ;; also need to store their boundaries as they will be
4473 ;; removed from buffer.
4480 ;; Get contents.
4488 ;; Restore ex ELEM-A overlays.
4497 ;; Restore ex ELEM-B overlays.
4506 ;; Local variables:
4507 ;; generated-autoload-file: "org-loaddefs.el"
4508 ;; End:
4510 ;;; org-element.el ends here