| blob | c60d9799779d42e302bf69afd4c261b12203462c |
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', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or an headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements
76 ;; and elements containing objects will also have `:contents-begin'
77 ;; and `:contents-end' properties to delimit contents.
78 ;;
79 ;; At the lowest level, a `:parent' property is also attached to any
80 ;; string, as a text property.
81 ;;
82 ;; Lisp-wise, an element or an object can be represented as a list.
83 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
84 ;; TYPE is a symbol describing the Org element or object.
85 ;; PROPERTIES is the property list attached to it. See docstring of
86 ;; appropriate parsing function to get an exhaustive
87 ;; list.
88 ;; CONTENTS is a list of elements, objects or raw strings contained
89 ;; in the current element or object, when applicable.
90 ;;
91 ;; An Org buffer is a nested list of such elements and objects, whose
92 ;; type is `org-data' and properties is nil.
93 ;;
94 ;; The first part of this file defines Org syntax, while the second
95 ;; one provide accessors and setters functions.
96 ;;
97 ;; The next part implements a parser and an interpreter for each
98 ;; element and object type in Org syntax.
99 ;;
100 ;; The following part creates a fully recursive buffer parser. It
101 ;; also provides a tool to map a function to elements or objects
102 ;; matching some criteria in the parse tree. Functions of interest
103 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
104 ;; extent, `org-element-parse-secondary-string'.
105 ;;
106 ;; The penultimate part is the cradle of an interpreter for the
107 ;; obtained parse tree: `org-element-interpret-data'.
108 ;;
109 ;; The library ends by furnishing `org-element-at-point' function, and
110 ;; a way to give information about document structure around point
111 ;; with `org-element-context'.
114 ;;; Code:
120 \f
121 ;;; Definitions And Rules
122 ;;
123 ;; Define elements, greater elements and specify recursive objects,
124 ;; along with the affiliated keywords recognized. Also set up
125 ;; restrictions on recursive objects combinations.
126 ;;
127 ;; These variables really act as a control center for the parsing
128 ;; process.
132 ;; Headlines, inlinetasks.
134 ;; Footnote definitions.
136 ;; Diary sexps.
139 ;; Empty lines.
141 ;; Tables (any type).
143 ;; Blocks (any type), Babel calls, drawers (any type),
144 ;; fixed-width areas and keywords. Note: this is only an
145 ;; indication and need some thorough check.
147 ;; Horizontal rules.
149 ;; LaTeX environments.
151 ;; Planning and Clock lines.
153 org-deadline-string
154 org-closed-string
155 org-clock-string))
157 ;; Lists.
164 "Regexp to separate paragraphs in an Org buffer.
166 is not sufficient to know if point is at a paragraph ending. See
171 dynamic-block example-block export-block fixed-width
172 footnote-definition headline horizontal-rule inlinetask item
173 keyword latex-environment node-property paragraph plain-list
174 planning property-drawer quote-block quote-section section
175 special-block src-block table table-row verse-block)
180 item plain-list property-drawer quote-block section
181 special-block table)
186 latex-or-entity line-break link macro radio-target
187 statistics-cookie sub/superscript table-cell target
188 text-markup timestamp)
197 "Alist of translations between object type and successor name.
199 Sharing the same successor comes handy when, for example, the
204 inline-src-block italic line-break latex-fragment link macro
205 radio-target statistics-cookie strike-through subscript superscript
206 table-cell target timestamp underline verbatim)
211 table-cell underline)
221 "Alist between block names and the associated parsing function.
222 Names must be uppercase. Any block whose name has no association
228 Only these types can accept search options and an explicit
234 "List of affiliated keywords as strings.
240 ;; Regular affiliated keywords.
243 "Regexp matching any affiliated keyword.
245 Keyword name is put in match group 1. Moreover, if keyword
246 belongs to `org-element-dual-keywords', put the dual value in
247 match group 2.
255 "Alist of usual translations for keywords.
256 The key is the old name and the value the new one. The property
260 "List of affiliated keywords that can occur more than once in an element.
262 Their value will be consed into a list of strings, which will be
263 returned as the value of the property.
265 This list is checked after translations have been applied. See
266 `org-element-keyword-translation-alist'.
272 "List of affiliated keywords whose value can be parsed.
274 Their value will be stored as a secondary string: a list of
275 strings and objects.
277 This list is checked after translations have been applied. See
281 "List of affiliated keywords which can have a secondary value.
283 In Org syntax, they can be written with optional square brackets
284 before the colons. For example, RESULTS keyword can be
285 associated to a hash value with the following:
287 #+RESULTS[hash-string]: some-source
289 This list is checked after translations have been applied. See
293 "List of properties associated to the whole document.
294 Any keyword in this list will have its value parsed and stored as
301 inline-src-block latex-or-entity line-break link macro
302 radio-target sub/superscript target text-markup
303 timestamp)
305 radio-target statistics-cookie sub/superscript target text-markup
306 timestamp)
318 inline-src-block latex-or-entity line-break link macro
319 radio-target statistics-cookie sub/superscript target text-markup
320 timestamp)
323 latex-or-entity link radio-target sub/superscript target
324 text-markup timestamp)
335 latex-or-entity line-break link macro radio-target
337 "Alist of objects restrictions.
339 CAR is an element or object type containing objects and CDR is
340 a list of successors that will be called within an element or
341 object of such type.
343 For example, in a `radio-target' object, one can only find
344 entities, export snippets, latex-fragments, subscript and
345 superscript.
347 This alist also applies to secondary string. For example, an
348 `headline' type element doesn't directly contain objects, but
359 \f
360 ;;; Accessors and Setters
361 ;;
362 ;; Provide four accessors: `org-element-type', `org-element-property'
363 ;; `org-element-contents' and `org-element-restriction'.
364 ;;
365 ;; Setter functions allow to modify elements by side effect. There is
366 ;; `org-element-put-property', `org-element-set-contents',
367 ;; `org-element-set-element' and `org-element-adopt-element'. Note
368 ;; that `org-element-set-element' and `org-element-adopt-elements' are
369 ;; higher level functions since also update `:parent' property.
372 "Return type of ELEMENT.
374 The function returns the type of the element or object provided.
375 It can also return the following special value:
376 `plain-text' for a string
377 `org-data' for a complete document
378 nil in any other case."
384 "Extract the value from the PROPERTY of an ELEMENT."
389 "Extract contents from an ELEMENT."
393 "Return restriction associated to ELEMENT.
394 ELEMENT can be an element, an object or a symbol representing an
395 element or object type."
397 org-element-object-restrictions)))
400 "In ELEMENT set PROPERTY to VALUE.
401 Return modified element."
404 element))
407 "Set ELEMENT contents to CONTENTS.
408 Return modified element."
414 "Replace element or object OLD with element or object NEW.
415 The function takes care of setting `:parent' property for NEW."
416 ;; Since OLD is going to be changed into NEW by side-effect, first
417 ;; make sure that every element or object within NEW has OLD as
418 ;; parent.
421 ;; Transfer contents.
423 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
424 ;; with NEW's.
427 ;; Transfer type.
431 "Append elements to the contents of another element.
433 PARENT is an element or object. CHILDREN can be elements,
434 objects, or a strings.
436 The function takes care of setting `:parent' property for CHILD.
437 Return parent element."
439 ;; Link every child to PARENT.
441 children)
442 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
447 parent))
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end' and `:post-blank' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
507 ;; Empty blocks have no contents.
522 :end end
523 :hiddenp hidden
524 :contents-begin contents-begin
525 :contents-end contents-end
530 "Interpret CENTER-BLOCK element as Org syntax.
531 CONTENTS is the contents of the element."
535 ;;;; Drawer
538 "Parse a drawer.
540 LIMIT bounds the search. AFFILIATED is a list of which CAR is
541 the buffer position at the beginning of the first affiliated
542 keyword and CDR is a plist of affiliated keywords along with
543 their value.
545 Return a list whose CAR is `drawer' and CDR is a plist containing
546 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
547 `:contents-end' and `:post-blank' keywords.
549 Assume point is at beginning of drawer."
552 ;; Incomplete drawer: parse it as a paragraph.
559 ;; Empty drawers have no contents.
574 :end end
575 :drawer-name name
576 :hiddenp hidden
577 :contents-begin contents-begin
578 :contents-end contents-end
583 "Interpret DRAWER element as Org syntax.
584 CONTENTS is the contents of the element."
587 contents))
590 ;;;; Dynamic Block
593 "Parse a dynamic block.
595 LIMIT bounds the search. AFFILIATED is a list of which CAR is
596 the buffer position at the beginning of the first affiliated
597 keyword and CDR is a plist of affiliated keywords along with
598 their value.
600 Return a list whose CAR is `dynamic-block' and CDR is a plist
601 containing `:block-name', `:begin', `:end', `:hiddenp',
602 `:contents-begin', `:contents-end', `:arguments' and
603 `:post-blank' keywords.
605 Assume point is at beginning of dynamic block."
609 ;; Incomplete block: parse it as a paragraph.
617 ;; Empty blocks have no contents.
632 :end end
633 :block-name name
634 :arguments arguments
635 :hiddenp hidden
636 :contents-begin contents-begin
637 :contents-end contents-end
642 "Interpret DYNAMIC-BLOCK element as Org syntax.
643 CONTENTS is the contents of the element."
648 contents))
651 ;;;; Footnote Definition
654 "Parse a footnote definition.
656 LIMIT bounds the search. AFFILIATED is a list of which CAR is
657 the buffer position at the beginning of the first affiliated
658 keyword and CDR is a plist of affiliated keywords along with
659 their value.
661 Return a list whose CAR is `footnote-definition' and CDR is
662 a plist containing `:label', `:begin' `:end', `:contents-begin',
663 `:contents-end' and `:post-blank' keywords.
665 Assume point is at the beginning of the footnote definition."
690 :begin begin
691 :end end
692 :contents-begin contents-begin
693 :contents-end contents-end
698 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
699 CONTENTS is the contents of the footnote-definition."
701 " "
702 contents))
705 ;;;; Headline
708 "Parse an headline.
710 Return a list whose CAR is `headline' and CDR is a plist
711 containing `:raw-value', `:title', `:begin', `:end',
712 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
713 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
714 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
715 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
716 keywords.
718 The plist also contains any property set in the property drawer,
719 with its name in lowercase, the underscores replaced with hyphens
720 and colons at the beginning (i.e. `:custom-id').
722 When RAW-SECONDARY-P is non-nil, headline's title will not be
723 parsed as a secondary string, but as a plain string instead.
725 Assume point is at beginning of the headline."
738 raw-value)))
742 raw-value)))
746 ;; Normalize property names: ":SOME_PROP:" becomes
747 ;; ":some-prop".
759 plist))
777 ;; Clean RAW-VALUE from any quote or comment string.
785 ""
786 raw-value))))
787 ;; Clean TAGS from archive tag, if any.
793 :begin begin
794 :end end
795 :pre-blank
798 :hiddenp hidden
799 :contents-begin contents-begin
800 :contents-end contents-end
801 :level level
803 :tags tags
804 :todo-keyword todo
805 :todo-type todo-type
806 :scheduled scheduled
807 :deadline deadline
808 :timestamp timestamp
809 :clock clock
815 end)
816 :footnote-section-p footnote-section-p
817 :archivedp archivedp
818 :commentedp commentedp
820 standard-props))))
822 headline :title
828 "Interpret HEADLINE element as Org syntax.
829 CONTENTS is the contents of the element."
856 ;; Align tags.
864 ? )
865 tags))
869 tags))))
871 contents)))
874 ;;;; Inlinetask
877 "Parse an inline task.
879 Return a list whose CAR is `inlinetask' and CDR is a plist
880 containing `:title', `:begin', `:end', `:hiddenp',
881 `:contents-begin' and `:contents-end', `:level', `:priority',
882 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
883 `:scheduled', `:deadline', `:timestamp', `:clock' and
884 `:post-blank' keywords.
886 The plist also contains any property set in the property drawer,
887 with its name in lowercase, the underscores replaced with hyphens
888 and colons at the beginning (i.e. `:custom-id').
890 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
891 title will not be parsed as a secondary string, but as a plain
892 string instead.
894 Assume point is at beginning of the inline task."
905 ;; Normalize property names: ":SOME_PROP:" becomes
906 ;; ":some-prop".
918 plist))
943 :begin begin
944 :end end
945 :hiddenp hidden
946 :contents-begin contents-begin
947 :contents-end contents-end
950 :tags tags
951 :todo-keyword todo
952 :todo-type todo-type
953 :scheduled scheduled
954 :deadline deadline
955 :timestamp timestamp
956 :clock clock
958 standard-props
961 inlinetask :title
964 raw-value
966 inlinetask))))))
969 "Interpret INLINETASK element as Org syntax.
970 CONTENTS is the contents of inlinetask."
985 ;; Align tags.
993 ? )
994 tags))
998 tags))))
999 ;; Prefer degenerate inlinetasks when there are no
1000 ;; contents.
1003 contents
1007 ;;;; Item
1010 "Parse an item.
1012 STRUCT is the structure of the plain list.
1014 Return a list whose CAR is `item' and CDR is a plist containing
1015 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1016 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1017 `:post-blank' keywords.
1019 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1020 any, will not be parsed as a secondary string, but as a plain
1021 string instead.
1023 Assume point is at the beginning of the item."
1047 ;; Ignore tags in un-ordered lists: they are just
1048 ;; a part of item's body.
1054 ;; If first line isn't empty, contents really start
1055 ;; at the text after item's meta-data.
1066 :begin begin
1067 :end end
1068 ;; CONTENTS-BEGIN and CONTENTS-END may be
1069 ;; mixed up in the case of an empty item
1070 ;; separated from the next by a blank line.
1071 ;; Thus ensure the former is always the
1072 ;; smallest.
1075 :checkbox checkbox
1076 :counter counter
1077 :hiddenp hidden
1078 :structure struct
1081 item :tag
1089 "Interpret ITEM element as Org syntax.
1090 CONTENTS is the contents of the element."
1096 ;; Compute indentation.
1101 ;; Indent contents.
1103 bullet
1116 ;;;; Plain List
1119 "Parse a plain list.
1121 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1122 the buffer position at the beginning of the first affiliated
1123 keyword and CDR is a plist of affiliated keywords along with
1124 their value. STRUCTURE is the structure of the plain list being
1125 parsed.
1127 Return a list whose CAR is `plain-list' and CDR is a plist
1128 containing `:type', `:begin', `:end', `:contents-begin' and
1129 `:contents-end', `:structure' and `:post-blank' keywords.
1131 Assume point is at the beginning of the list."
1146 ;; Return value.
1150 :begin begin
1151 :end end
1152 :contents-begin contents-begin
1153 :contents-end contents-end
1154 :structure struct
1159 "Interpret PLAIN-LIST element as Org syntax.
1160 CONTENTS is the contents of the element."
1168 ;;;; Property Drawer
1171 "Parse a property drawer.
1173 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1174 the buffer position at the beginning of the first affiliated
1175 keyword and CDR is a plist of affiliated keywords along with
1176 their value.
1178 Return a list whose CAR is `property-drawer' and CDR is a plist
1179 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1180 `:contents-end' and `:post-blank' keywords.
1182 Assume point is at the beginning of the property drawer."
1187 ;; Incomplete drawer: parse it as a paragraph.
1206 :end end
1207 :hiddenp hidden
1208 :contents-begin contents-begin
1209 :contents-end contents-end
1214 "Interpret PROPERTY-DRAWER element as Org syntax.
1215 CONTENTS is the properties within the drawer."
1219 ;;;; Quote Block
1222 "Parse a quote block.
1224 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1225 the buffer position at the beginning of the first affiliated
1226 keyword and CDR is a plist of affiliated keywords along with
1227 their value.
1229 Return a list whose CAR is `quote-block' and CDR is a plist
1230 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1231 `:contents-end' and `:post-blank' keywords.
1233 Assume point is at the beginning of the block."
1237 ;; Incomplete block: parse it as a paragraph.
1242 ;; Empty blocks have no contents.
1257 :end end
1258 :hiddenp hidden
1259 :contents-begin contents-begin
1260 :contents-end contents-end
1265 "Interpret QUOTE-BLOCK element as Org syntax.
1266 CONTENTS is the contents of the element."
1270 ;;;; Section
1273 "Parse a section.
1275 LIMIT bounds the search.
1277 Return a list whose CAR is `section' and CDR is a plist
1278 containing `:begin', `:end', `:contents-begin', `contents-end'
1279 and `:post-blank' keywords."
1281 ;; Beginning of section is the beginning of the first non-blank
1282 ;; line after previous headline.
1291 :end end
1292 :contents-begin begin
1293 :contents-end pos-before-blank
1297 "Interpret SECTION element as Org syntax.
1298 CONTENTS is the contents of the element."
1299 contents)
1302 ;;;; Special Block
1305 "Parse a special block.
1307 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1308 the buffer position at the beginning of the first affiliated
1309 keyword and CDR is a plist of affiliated keywords along with
1310 their value.
1312 Return a list whose CAR is `special-block' and CDR is a plist
1313 containing `:type', `:begin', `:end', `:hiddenp',
1314 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1316 Assume point is at the beginning of the block."
1323 ;; Incomplete block: parse it as a paragraph.
1328 ;; Empty blocks have no contents.
1343 :begin begin
1344 :end end
1345 :hiddenp hidden
1346 :contents-begin contents-begin
1347 :contents-end contents-end
1352 "Interpret SPECIAL-BLOCK element as Org syntax.
1353 CONTENTS is the contents of the element."
1358 \f
1359 ;;; Elements
1360 ;;
1361 ;; For each element, a parser and an interpreter are also defined.
1362 ;; Both follow the same naming convention used for greater elements.
1363 ;;
1364 ;; Also, as for greater elements, adding a new element type is done
1365 ;; through the following steps: implement a parser and an interpreter,
1366 ;; tweak `org-element--current-element' so that it recognizes the new
1367 ;; type and add that new type to `org-element-all-elements'.
1368 ;;
1369 ;; As a special case, when the newly defined type is a block type,
1370 ;; `org-element-block-name-alist' has to be modified accordingly.
1373 ;;;; Babel Call
1376 "Parse a babel call.
1378 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1379 the buffer position at the beginning of the first affiliated
1380 keyword and CDR is a plist of affiliated keywords along with
1381 their value.
1383 Return a list whose CAR is `babel-call' and CDR is a plist
1384 containing `:begin', `:end', `:info' and `:post-blank' as
1385 keywords."
1398 :end end
1399 :info info
1404 "Interpret BABEL-CALL element as Org syntax.
1405 CONTENTS is nil."
1411 ;; Remove redundant square brackets.
1416 ;;;; Clock
1419 "Parse a clock.
1421 LIMIT bounds the search.
1423 Return a list whose CAR is `clock' and CDR is a plist containing
1424 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1425 as keywords."
1445 :value value
1446 :time time
1447 :begin begin
1448 :end end
1452 "Interpret CLOCK element as Org syntax.
1453 CONTENTS is nil."
1460 "%2s:%02s"
1464 ;;;; Comment
1467 "Parse a comment.
1469 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1470 the buffer position at the beginning of the first affiliated
1471 keyword and CDR is a plist of affiliated keywords along with
1472 their value.
1474 Return a list whose CAR is `comment' and CDR is a plist
1475 containing `:begin', `:end', `:value' and `:post-blank'
1476 keywords.
1478 Assume point is at comment beginning."
1486 ;; Get comments ending.
1489 ;; Accumulate lines without leading hash and first
1490 ;; whitespace.
1505 :end end
1506 :value value
1511 "Interpret COMMENT element as Org syntax.
1512 CONTENTS is nil."
1516 ;;;; Comment Block
1519 "Parse an export block.
1521 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1522 the buffer position at the beginning of the first affiliated
1523 keyword and CDR is a plist of affiliated keywords along with
1524 their value.
1526 Return a list whose CAR is `comment-block' and CDR is a plist
1527 containing `:begin', `:end', `:hiddenp', `:value' and
1528 `:post-blank' keywords.
1530 Assume point is at comment block beginning."
1534 ;; Incomplete block: parse it as a paragraph.
1548 contents-begin contents-end)))
1552 :end end
1553 :value value
1554 :hiddenp hidden
1559 "Interpret COMMENT-BLOCK element as Org syntax.
1560 CONTENTS is nil."
1565 ;;;; Diary Sexp
1568 "Parse a diary sexp.
1570 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1571 the buffer position at the beginning of the first affiliated
1572 keyword and CDR is a plist of affiliated keywords along with
1573 their value.
1575 Return a list whose CAR is `diary-sexp' and CDR is a plist
1576 containing `:begin', `:end', `:value' and `:post-blank'
1577 keywords."
1589 :begin begin
1590 :end end
1595 "Interpret DIARY-SEXP as Org syntax.
1596 CONTENTS is nil."
1600 ;;;; Example Block
1603 "Parse an example block.
1605 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1606 the buffer position at the beginning of the first affiliated
1607 keyword and CDR is a plist of affiliated keywords along with
1608 their value.
1610 Return a list whose CAR is `example-block' and CDR is a plist
1611 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1612 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1613 `:switches', `:value' and `:post-blank' keywords."
1617 ;; Incomplete block: parse it as a paragraph.
1624 ;; Switches analysis
1629 ;; Should labels be retained in (or stripped from) example
1630 ;; blocks?
1635 ;; What should code-references use - labels or
1636 ;; line-numbers?
1643 ;; Standard block parsing.
1649 contents-begin contents-end)))
1659 :end end
1660 :value value
1661 :switches switches
1662 :number-lines number-lines
1663 :preserve-indent preserve-indent
1664 :retain-labels retain-labels
1665 :use-labels use-labels
1666 :label-fmt label-fmt
1667 :hiddenp hidden
1672 "Interpret EXAMPLE-BLOCK element as Org syntax.
1673 CONTENTS is nil."
1682 ;;;; Export Block
1685 "Parse an export block.
1687 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1688 the buffer position at the beginning of the first affiliated
1689 keyword and CDR is a plist of affiliated keywords along with
1690 their value.
1692 Return a list whose CAR is `export-block' and CDR is a plist
1693 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1694 `:post-blank' keywords.
1696 Assume point is at export-block beginning."
1703 ;; Incomplete block: parse it as a paragraph.
1717 contents-end)))
1721 :end end
1722 :type type
1723 :value value
1724 :hiddenp hidden
1729 "Interpret EXPORT-BLOCK element as Org syntax.
1730 CONTENTS is nil."
1737 ;;;; Fixed-width
1740 "Parse a fixed-width section.
1742 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1743 the buffer position at the beginning of the first affiliated
1744 keyword and CDR is a plist of affiliated keywords along with
1745 their value.
1747 Return a list whose CAR is `fixed-width' and CDR is a plist
1748 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1750 Assume point is at the beginning of the fixed-width area."
1753 value
1758 ;; Accumulate text without starting colons.
1772 :end end
1773 :value value
1778 "Interpret FIXED-WIDTH element as Org syntax.
1779 CONTENTS is nil."
1784 ;;;; Horizontal Rule
1787 "Parse an horizontal rule.
1789 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1790 the buffer position at the beginning of the first affiliated
1791 keyword and CDR is a plist of affiliated keywords along with
1792 their value.
1794 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1795 containing `:begin', `:end' and `:post-blank' keywords."
1805 :end end
1810 "Interpret HORIZONTAL-RULE element as Org syntax.
1811 CONTENTS is nil."
1815 ;;;; Keyword
1818 "Parse a keyword at point.
1820 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1821 the buffer position at the beginning of the first affiliated
1822 keyword and CDR is a plist of affiliated keywords along with
1823 their value.
1825 Return a list whose CAR is `keyword' and CDR is a plist
1826 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1827 keywords."
1841 :value value
1842 :begin begin
1843 :end end
1848 "Interpret KEYWORD element as Org syntax.
1849 CONTENTS is nil."
1855 ;;;; Latex Environment
1858 "Parse a LaTeX environment.
1860 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1861 the buffer position at the beginning of the first affiliated
1862 keyword and CDR is a plist of affiliated keywords along with
1863 their value.
1865 Return a list whose CAR is `latex-environment' and CDR is a plist
1866 containing `:begin', `:end', `:value' and `:post-blank'
1867 keywords.
1869 Assume point is at the beginning of the latex environment."
1876 limit t))
1877 ;; Incomplete latex environment: parse it as a paragraph.
1888 :end end
1889 :value value
1894 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1895 CONTENTS is nil."
1899 ;;;; Node Property
1902 "Parse a node-property at point.
1904 LIMIT bounds the search.
1906 Return a list whose CAR is `node-property' and CDR is a plist
1907 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1908 keywords."
1920 :value value
1921 :begin begin
1922 :end end
1926 "Interpret NODE-PROPERTY element as Org syntax.
1927 CONTENTS is nil."
1933 ;;;; Paragraph
1936 "Parse a paragraph.
1938 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1939 the buffer position at the beginning of the first affiliated
1940 keyword and CDR is a plist of affiliated keywords along with
1941 their value.
1943 Return a list whose CAR is `paragraph' and CDR is a plist
1944 containing `:begin', `:end', `:contents-begin' and
1945 `:contents-end' and `:post-blank' keywords.
1947 Assume point is at the beginning of the paragraph."
1956 limit
1957 ;; A matching `org-element-paragraph-separate' is not
1958 ;; necessarily the end of the paragraph. In
1959 ;; particular, lines starting with # or : as a first
1960 ;; non-space character are ambiguous. We have check
1961 ;; if they are valid Org syntax (i.e. not an
1962 ;; incomplete keyword).
1966 ;; There's no ambiguity for other symbols or
1967 ;; empty lines: stop here.
1969 ;; Stop at valid fixed-width areas.
1971 ;; Stop at drawers.
1976 ;; Stop at valid comments.
1978 ;; Stop at valid dynamic blocks.
1983 ;; Stop at valid blocks.
1990 limit t)))
1991 ;; Stop at valid latex environments.
1998 limit t)))
1999 ;; Stop at valid keywords.
2001 ;; Skip everything else.
2019 :end end
2020 :contents-begin contents-begin
2021 :contents-end contents-end
2026 "Interpret PARAGRAPH element as Org syntax.
2027 CONTENTS is the contents of the element."
2028 contents)
2031 ;;;; Planning
2034 "Parse a planning.
2036 LIMIT bounds the search.
2038 Return a list whose CAR is `planning' and CDR is a plist
2039 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2040 and `:post-blank' keywords."
2050 closed deadline scheduled)
2064 :deadline deadline
2065 :scheduled scheduled
2066 :begin begin
2067 :end end
2071 "Interpret PLANNING element as Org syntax.
2072 CONTENTS is nil."
2074 'identity
2086 ;;;; Quote Section
2089 "Parse a quote section.
2091 LIMIT bounds the search.
2093 Return a list whose CAR is `quote-section' and CDR is a plist
2094 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2096 Assume point is at beginning of the section."
2107 :end end
2108 :value value
2112 "Interpret QUOTE-SECTION element as Org syntax.
2113 CONTENTS is nil."
2117 ;;;; Src Block
2120 "Parse a src block.
2122 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2123 the buffer position at the beginning of the first affiliated
2124 keyword and CDR is a plist of affiliated keywords along with
2125 their value.
2127 Return a list whose CAR is `src-block' and CDR is a plist
2128 containing `:language', `:switches', `:parameters', `:begin',
2129 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2130 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2131 `:post-blank' keywords.
2133 Assume point is at the beginning of the block."
2136 limit t)))
2137 ;; Incomplete block: parse it as a paragraph.
2142 ;; Get language as a string.
2151 ;; Get switches.
2153 ;; Get parameters.
2155 ;; Switches analysis
2163 ;; Should labels be retained in (or stripped from)
2164 ;; src blocks?
2169 ;; What should code-references use - labels or
2170 ;; line-numbers?
2174 ;; Get visibility status.
2176 ;; Retrieve code.
2182 ;; Get position after ending blank lines.
2193 :begin begin
2194 :end end
2195 :number-lines number-lines
2196 :preserve-indent preserve-indent
2197 :retain-labels retain-labels
2198 :use-labels use-labels
2199 :label-fmt label-fmt
2200 :hiddenp hidden
2201 :value value
2206 "Interpret SRC-BLOCK element as Org syntax.
2207 CONTENTS is nil."
2230 ;;;; Table
2233 "Parse a table at point.
2235 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2236 the buffer position at the beginning of the first affiliated
2237 keyword and CDR is a plist of affiliated keywords along with
2238 their value.
2240 Return a list whose CAR is `table' and CDR is a plist containing
2241 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2242 `:contents-end', `:value' and `:post-blank' keywords.
2244 Assume point is at the beginning of the table."
2258 acc))
2266 :end end
2267 :type type
2268 :tblfm tblfm
2269 ;; Only `org' tables have contents. `table.el' tables
2270 ;; use a `:value' property to store raw table as
2271 ;; a string.
2276 table-begin table-end))
2281 "Interpret TABLE element as Org syntax.
2282 CONTENTS is nil."
2293 ;;;; Table Row
2296 "Parse table row at point.
2298 LIMIT bounds the search.
2300 Return a list whose CAR is `table-row' and CDR is a plist
2301 containing `:begin', `:end', `:contents-begin', `:contents-end',
2302 `:type' and `:post-blank' keywords."
2306 ;; A table rule has no contents. In that case, ensure
2307 ;; CONTENTS-BEGIN matches CONTENTS-END.
2319 :begin begin
2320 :end end
2321 :contents-begin contents-begin
2322 :contents-end contents-end
2326 "Interpret TABLE-ROW element as Org syntax.
2327 CONTENTS is the contents of the table row."
2332 ;;;; Verse Block
2335 "Parse a verse block.
2337 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2338 the buffer position at the beginning of the first affiliated
2339 keyword and CDR is a plist of affiliated keywords along with
2340 their value.
2342 Return a list whose CAR is `verse-block' and CDR is a plist
2343 containing `:begin', `:end', `:contents-begin', `:contents-end',
2344 `:hiddenp' and `:post-blank' keywords.
2346 Assume point is at beginning of the block."
2350 ;; Incomplete block: parse it as a paragraph.
2366 :end end
2367 :contents-begin contents-begin
2368 :contents-end contents-end
2369 :hiddenp hidden
2374 "Interpret VERSE-BLOCK element as Org syntax.
2375 CONTENTS is verse block contents."
2379 \f
2380 ;;; Objects
2381 ;;
2382 ;; Unlike to elements, interstices can be found between objects.
2383 ;; That's why, along with the parser, successor functions are provided
2384 ;; for each object. Some objects share the same successor (i.e. `code'
2385 ;; and `verbatim' objects).
2386 ;;
2387 ;; A successor must accept a single argument bounding the search. It
2388 ;; will return either a cons cell whose CAR is the object's type, as
2389 ;; a symbol, and CDR the position of its next occurrence, or nil.
2390 ;;
2391 ;; Successors follow the naming convention:
2392 ;; org-element-NAME-successor, where NAME is the name of the
2393 ;; successor, as defined in `org-element-all-successors'.
2394 ;;
2395 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2396 ;; object types they can contain will be specified in
2397 ;; `org-element-object-restrictions'.
2398 ;;
2399 ;; Adding a new type of object is simple. Implement a successor,
2400 ;; a parser, and an interpreter for it, all following the naming
2401 ;; convention. Register type in `org-element-all-objects' and
2402 ;; successor in `org-element-all-successors'. Maybe tweak
2403 ;; restrictions about it, and that's it.
2406 ;;;; Bold
2409 "Parse bold object at point.
2411 Return a list whose CAR is `bold' and CDR is a plist with
2412 `:begin', `:end', `:contents-begin' and `:contents-end' and
2413 `:post-blank' keywords.
2415 Assume point is at the first star marker."
2427 :end end
2428 :contents-begin contents-begin
2429 :contents-end contents-end
2433 "Interpret BOLD object as Org syntax.
2434 CONTENTS is the contents of the object."
2438 "Search for the next text-markup object.
2440 LIMIT bounds the search.
2442 Return value is a cons cell whose CAR is a symbol among `bold',
2443 `italic', `underline', `strike-through', `code' and `verbatim'
2444 and CDR is beginning position."
2460 ;;;; Code
2463 "Parse code object at point.
2465 Return a list whose CAR is `code' and CDR is a plist with
2466 `:value', `:begin', `:end' and `:post-blank' keywords.
2468 Assume point is at the first tilde marker."
2479 :begin begin
2480 :end end
2484 "Interpret CODE object as Org syntax.
2485 CONTENTS is nil."
2489 ;;;; Entity
2492 "Parse entity at point.
2494 Return a list whose CAR is `entity' and CDR a plist with
2495 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2496 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2497 keywords.
2499 Assume point is at the beginning of the entity."
2501 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2517 :begin begin
2518 :end end
2519 :use-brackets-p bracketsp
2523 "Interpret ENTITY object as Org syntax.
2524 CONTENTS is nil."
2530 "Search for the next latex-fragment or entity object.
2532 LIMIT bounds the search.
2534 Return value is a cons cell whose CAR is `entity' or
2535 `latex-fragment' and CDR is beginning position."
2540 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2547 limit t)
2550 ;; Determine if it's a real entity or a LaTeX command.
2553 ;; No entity nor command: point is at a LaTeX fragment.
2554 ;; Determine its type to get the correct beginning position.
2562 matchers)
2566 ;;;; Export Snippet
2569 "Parse export snippet at point.
2571 Return a list whose CAR is `export-snippet' and CDR a plist with
2572 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2573 keywords.
2575 Assume point is at the beginning of the snippet."
2587 :value value
2588 :begin begin
2589 :end end
2593 "Interpret EXPORT-SNIPPET object as Org syntax.
2594 CONTENTS is nil."
2600 "Search for the next export-snippet object.
2602 LIMIT bounds the search.
2604 Return value is a cons cell whose CAR is `export-snippet' and CDR
2605 its beginning position."
2614 ;;;; Footnote Reference
2617 "Parse footnote reference at point.
2619 Return a list whose CAR is `footnote-reference' and CDR a plist
2620 with `:label', `:type', `:inline-definition', `:begin', `:end'
2621 and `:post-blank' as keywords."
2643 :type type
2644 :begin begin
2645 :end end
2648 footnote-reference :inline-definition
2653 footnote-reference))))))
2656 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2657 CONTENTS is nil."
2667 "Search for the next footnote-reference object.
2669 LIMIT bounds the search.
2671 Return value is a cons cell whose CAR is `footnote-reference' and
2672 CDR is beginning position."
2686 ;;;; Inline Babel Call
2689 "Parse inline babel call at point.
2691 Return a list whose CAR is `inline-babel-call' and CDR a plist
2692 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2694 Assume point is at the beginning of the babel call."
2705 :end end
2706 :info info
2710 "Interpret INLINE-BABEL-CALL object as Org syntax.
2711 CONTENTS is nil."
2717 ;; Remove redundant square brackets.
2720 main-source)
2724 "Search for the next inline-babel-call object.
2726 LIMIT bounds the search.
2728 Return value is a cons cell whose CAR is `inline-babel-call' and
2729 CDR is beginning position."
2731 ;; Use a simplified version of
2732 ;; `org-babel-inline-lob-one-liner-regexp'.
2735 limit t)
2739 ;;;; Inline Src Block
2742 "Parse inline source block at point.
2744 LIMIT bounds the search.
2746 Return a list whose CAR is `inline-src-block' and CDR a plist
2747 with `:begin', `:end', `:language', `:value', `:parameters' and
2748 `:post-blank' as keywords.
2750 Assume point is at the beginning of the inline src block."
2763 :value value
2764 :parameters parameters
2765 :begin begin
2766 :end end
2770 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2771 CONTENTS is nil."
2776 language
2778 body)))
2781 "Search for the next inline-babel-call element.
2783 LIMIT bounds the search.
2785 Return value is a cons cell whose CAR is `inline-babel-call' and
2786 CDR is beginning position."
2792 ;;;; Italic
2795 "Parse italic object at point.
2797 Return a list whose CAR is `italic' and CDR is a plist with
2798 `:begin', `:end', `:contents-begin' and `:contents-end' and
2799 `:post-blank' keywords.
2801 Assume point is at the first slash marker."
2813 :end end
2814 :contents-begin contents-begin
2815 :contents-end contents-end
2819 "Interpret ITALIC object as Org syntax.
2820 CONTENTS is the contents of the object."
2824 ;;;; Latex Fragment
2827 "Parse latex fragment at point.
2829 Return a list whose CAR is `latex-fragment' and CDR a plist with
2830 `:value', `:begin', `:end', and `:post-blank' as keywords.
2832 Assume point is at the beginning of the latex fragment."
2846 ;; None found: it's a macro.
2855 :begin begin
2856 :end end
2860 "Interpret LATEX-FRAGMENT object as Org syntax.
2861 CONTENTS is nil."
2864 ;;;; Line Break
2867 "Parse line break at point.
2869 Return a list whose CAR is `line-break', and CDR a plist with
2870 `:begin', `:end' and `:post-blank' keywords.
2872 Assume point is at the beginning of the line break."
2876 "Interpret LINE-BREAK object as Org syntax.
2877 CONTENTS is nil."
2881 "Search for the next line-break object.
2883 LIMIT bounds the search.
2885 Return value is a cons cell whose CAR is `line-break' and CDR is
2886 beginning position."
2890 ;; A line break can only happen on a non-empty line.
2895 ;;;; Link
2898 "Parse link at point.
2900 Return a list whose CAR is `link' and CDR a plist with `:type',
2901 `:path', `:raw-link', `:application', `:search-option', `:begin',
2902 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2903 keywords.
2905 Assume point is at the beginning of the link."
2908 end contents-begin contents-end link-end post-blank path type
2909 raw-link link search-option application)
2911 ;; Type 1: Text targeted from a radio target.
2916 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2921 ;; RAW-LINK is the original link.
2926 ;; Determine TYPE of link and set PATH accordingly.
2928 ;; File type.
2931 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2934 ;; Id type: PATH is the id.
2937 ;; Code-ref type: PATH is the name of the reference.
2940 ;; Custom-id type: PATH is the name of the custom id.
2943 ;; Fuzzy type: Internal link either matches a target, an
2944 ;; headline name or nothing. PATH is the target or
2945 ;; headline's name.
2947 ;; Type 3: Plain link, i.e. http://orgmode.org
2953 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2960 ;; In any case, deduce end point after trailing white space from
2961 ;; LINK-END variable.
2964 ;; Extract search option and opening application out of
2965 ;; "file"-type links.
2967 ;; Application.
2972 ;; Extract search option from PATH.
2976 ;; Make sure TYPE always report "file".
2980 :path path
2982 :application application
2983 :search-option search-option
2984 :begin begin
2985 :end end
2986 :contents-begin contents-begin
2987 :contents-end contents-end
2991 "Interpret LINK object as Org syntax.
2992 CONTENTS is the contents of the object, or nil."
2997 raw-link
3001 "Search for the next link object.
3003 LIMIT bounds the search.
3005 Return value is a cons cell whose CAR is `link' and CDR is
3006 beginning position."
3015 ;;;; Macro
3018 "Parse macro at point.
3020 Return a list whose CAR is `macro' and CDR a plist with `:key',
3021 `:args', `:begin', `:end', `:value' and `:post-blank' as
3022 keywords.
3024 Assume point is at the macro."
3038 ;; Repair bad splits.
3046 :value value
3047 :args args
3048 :begin begin
3049 :end end
3053 "Interpret MACRO object as Org syntax.
3054 CONTENTS is nil."
3058 "Search for the next macro object.
3060 LIMIT bounds the search.
3062 Return value is cons cell whose CAR is `macro' and CDR is
3063 beginning position."
3067 limit t)
3071 ;;;; Radio-target
3074 "Parse radio target at point.
3076 Return a list whose CAR is `radio-target' and CDR a plist with
3077 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3078 and `:post-blank' as keywords.
3080 Assume point is at the radio target."
3092 :end end
3093 :contents-begin contents-begin
3094 :contents-end contents-end
3095 :post-blank post-blank
3099 "Interpret TARGET object as Org syntax.
3100 CONTENTS is the contents of the object."
3104 "Search for the next radio-target object.
3106 LIMIT bounds the search.
3108 Return value is a cons cell whose CAR is `radio-target' and CDR
3109 is beginning position."
3115 ;;;; Statistics Cookie
3118 "Parse statistics cookie at point.
3120 Return a list whose CAR is `statistics-cookie', and CDR a plist
3121 with `:begin', `:end', `:value' and `:post-blank' keywords.
3123 Assume point is at the beginning of the statistics-cookie."
3134 :end end
3135 :value value
3139 "Interpret STATISTICS-COOKIE object as Org syntax.
3140 CONTENTS is nil."
3144 "Search for the next statistics cookie object.
3146 LIMIT bounds the search.
3148 Return value is a cons cell whose CAR is `statistics-cookie' and
3149 CDR is beginning position."
3155 ;;;; Strike-Through
3158 "Parse strike-through object at point.
3160 Return a list whose CAR is `strike-through' and CDR is a plist
3161 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3162 `:post-blank' keywords.
3164 Assume point is at the first plus sign marker."
3176 :end end
3177 :contents-begin contents-begin
3178 :contents-end contents-end
3182 "Interpret STRIKE-THROUGH object as Org syntax.
3183 CONTENTS is the contents of the object."
3187 ;;;; Subscript
3190 "Parse subscript at point.
3192 Return a list whose CAR is `subscript' and CDR a plist with
3193 `:begin', `:end', `:contents-begin', `:contents-end',
3194 `:use-brackets-p' and `:post-blank' as keywords.
3196 Assume point is at the underscore."
3200 t
3211 :end end
3212 :use-brackets-p bracketsp
3213 :contents-begin contents-begin
3214 :contents-end contents-end
3218 "Interpret SUBSCRIPT object as Org syntax.
3219 CONTENTS is the contents of the object."
3222 contents))
3225 "Search for the next sub/superscript object.
3227 LIMIT bounds the search.
3229 Return value is a cons cell whose CAR is either `subscript' or
3230 `superscript' and CDR is beginning position."
3238 ;;;; Superscript
3241 "Parse superscript at point.
3243 Return a list whose CAR is `superscript' and CDR a plist with
3244 `:begin', `:end', `:contents-begin', `:contents-end',
3245 `:use-brackets-p' and `:post-blank' as keywords.
3247 Assume point is at the caret."
3261 :end end
3262 :use-brackets-p bracketsp
3263 :contents-begin contents-begin
3264 :contents-end contents-end
3268 "Interpret SUPERSCRIPT object as Org syntax.
3269 CONTENTS is the contents of the object."
3272 contents))
3275 ;;;; Table Cell
3278 "Parse table cell at point.
3280 Return a list whose CAR is `table-cell' and CDR is a plist
3281 containing `:begin', `:end', `:contents-begin', `:contents-end'
3282 and `:post-blank' keywords."
3290 :end end
3291 :contents-begin contents-begin
3292 :contents-end contents-end
3296 "Interpret TABLE-CELL element as Org syntax.
3297 CONTENTS is the contents of the cell, or nil."
3301 "Search for the next table-cell object.
3303 LIMIT bounds the search.
3305 Return value is a cons cell whose CAR is `table-cell' and CDR is
3306 beginning position."
3310 ;;;; Target
3313 "Parse target at point.
3315 Return a list whose CAR is `target' and CDR a plist with
3316 `:begin', `:end', `:value' and `:post-blank' as keywords.
3318 Assume point is at the target."
3328 :end end
3329 :value value
3333 "Interpret TARGET object as Org syntax.
3334 CONTENTS is nil."
3338 "Search for the next target object.
3340 LIMIT bounds the search.
3342 Return value is a cons cell whose CAR is `target' and CDR is
3343 beginning position."
3349 ;;;; Timestamp
3352 "Parse time stamp at point.
3354 Return a list whose CAR is `timestamp', and CDR a plist with
3355 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3357 Assume point is at the beginning of the timestamp."
3376 :value main-value
3377 :range-end range-end
3378 :begin begin
3379 :end end
3383 "Interpret TIMESTAMP object as Org syntax.
3384 CONTENTS is nil."
3393 range-end)))))))
3396 "Search for the next timestamp object.
3398 LIMIT bounds the search.
3400 Return value is a cons cell whose CAR is `timestamp' and CDR is
3401 beginning position."
3409 limit t)
3413 ;;;; Underline
3416 "Parse underline object at point.
3418 Return a list whose CAR is `underline' and CDR is a plist with
3419 `:begin', `:end', `:contents-begin' and `:contents-end' and
3420 `:post-blank' keywords.
3422 Assume point is at the first underscore marker."
3434 :end end
3435 :contents-begin contents-begin
3436 :contents-end contents-end
3440 "Interpret UNDERLINE object as Org syntax.
3441 CONTENTS is the contents of the object."
3445 ;;;; Verbatim
3448 "Parse verbatim object at point.
3450 Return a list whose CAR is `verbatim' and CDR is a plist with
3451 `:value', `:begin', `:end' and `:post-blank' keywords.
3453 Assume point is at the first equal sign marker."
3464 :begin begin
3465 :end end
3469 "Interpret VERBATIM object as Org syntax.
3470 CONTENTS is nil."
3474 \f
3475 ;;; Parsing Element Starting At Point
3476 ;;
3477 ;; `org-element--current-element' is the core function of this section.
3478 ;; It returns the Lisp representation of the element starting at
3479 ;; point.
3480 ;;
3481 ;; `org-element--current-element' makes use of special modes. They
3482 ;; are activated for fixed element chaining (i.e. `plain-list' >
3483 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3484 ;; `section'). Special modes are: `first-section', `item',
3485 ;; `node-property', `quote-section', `section' and `table-row'.
3489 "Parse the element starting at point.
3491 LIMIT bounds the search.
3493 Return value is a list like (TYPE PROPS) where TYPE is the type
3494 of the element and PROPS a plist of properties associated to the
3495 element.
3497 Possible types are defined in `org-element-all-elements'.
3499 Optional argument GRANULARITY determines the depth of the
3500 recursion. Allowed values are `headline', `greater-element',
3501 `element', `object' or nil. When it is broader than `object' (or
3502 nil), secondary values will not be parsed, since they only
3503 contain objects.
3505 Optional argument SPECIAL, when non-nil, can be either
3506 `first-section', `item', `node-property', `quote-section',
3507 `section', and `table-row'.
3509 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3510 be computed.
3512 This function assumes point is always at the beginning of the
3513 element it has to parse."
3516 ;; Determine if parsing depth allows for secondary strings
3517 ;; parsing. It only applies to elements referenced in
3518 ;; `org-element-secondary-value-alist'.
3521 ;; Item.
3524 ;; Table Row.
3526 ;; Node Property.
3528 ;; Headline.
3531 ;; Sections (must be checked after headline).
3537 limit)))
3538 ;; When not at bol, point is at the beginning of an item or
3539 ;; a footnote definition: next item is always a paragraph.
3541 ;; Planning and Clock.
3546 ;; Inlinetask.
3549 ;; From there, elements can have affiliated keywords.
3552 ;; LaTeX Environment.
3555 ;; Drawer and Property Drawer.
3560 ;; Fixed Width
3563 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3564 ;; Keywords.
3573 org-element-block-name-alist)))
3588 ;; Footnote Definition.
3591 ;; Horizontal Rule.
3594 ;; Diary Sexp.
3597 ;; Table.
3599 ;; List.
3603 ;; Default element: Paragraph.
3607 ;; Most elements can have affiliated keywords. When looking for an
3608 ;; element beginning, we want to move before them, as they belong to
3609 ;; that element, and, in the meantime, collect information they give
3610 ;; into appropriate properties. Hence the following function.
3613 "Collect affiliated keywords from point.
3615 Return a list whose CAR is the position at the first of them and
3616 CDR a plist of keywords and values and move point to the
3617 beginning of the first line after them.
3619 As a special case, if element doesn't start at the beginning of
3620 the line (i.e. a paragraph starting an item), CAR is current
3621 position of point and CDR is nil."
3625 ;; RESTRICT is the list of objects allowed in parsed
3626 ;; keywords value.
3628 output)
3631 ;; Apply translation to RAW-KWD. From there, KWD is
3632 ;; the official keyword.
3634 org-element-keyword-translation-alist))
3635 raw-kwd))
3636 ;; Find main value for any keyword.
3642 ;; PARSEDP is non-nil when keyword should have its
3643 ;; value parsed.
3645 ;; If KWD is a dual keyword, find its secondary
3646 ;; value. Maybe parse it.
3653 ;; Attribute a property name to KWD.
3655 ;; Now set final shape for VALUE.
3660 ;; Attributes can always appear on multiple lines.
3663 ;; Eventually store the new value in OUTPUT.
3665 ;; Move to next keyword.
3667 ;; If affiliated keywords are orphaned: move back to first one.
3668 ;; They will be parsed as a paragraph.
3670 ;; Return value.
3674 \f
3675 ;;; The Org Parser
3676 ;;
3677 ;; The two major functions here are `org-element-parse-buffer', which
3678 ;; parses Org syntax inside the current buffer, taking into account
3679 ;; region, narrowing, or even visibility if specified, and
3680 ;; `org-element-parse-secondary-string', which parses objects within
3681 ;; a given string.
3682 ;;
3683 ;; The (almost) almighty `org-element-map' allows to apply a function
3684 ;; on elements or objects matching some type, and accumulate the
3685 ;; resulting values. In an export situation, it also skips unneeded
3686 ;; parts of the parse tree.
3689 "Recursively parse the buffer and return structure.
3690 If narrowing is in effect, only parse the visible part of the
3691 buffer.
3693 Optional argument GRANULARITY determines the depth of the
3694 recursion. It can be set to the following symbols:
3696 `headline' Only parse headlines.
3697 `greater-element' Don't recurse into greater elements excepted
3698 headlines and sections. Thus, elements
3699 parsed are the top-level ones.
3700 `element' Parse everything but objects and plain text.
3701 `object' Parse the complete buffer (default).
3703 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3704 elements.
3706 Assume buffer is in Org mode."
3712 ;; Start in `first-section' mode so text before the first
3713 ;; headline belongs to a section.
3717 "Recursively parse objects in STRING and return structure.
3719 RESTRICTION is a symbol limiting the object types that will be
3720 looked after.
3722 Optional argument PARENT, when non-nil, is the element or object
3723 containing the secondary string. It is used to set correctly
3724 `:parent' property within the string."
3730 secondary))))
3734 "Map a function on selected elements or objects.
3736 DATA is the parsed tree, as returned by, i.e,
3737 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3738 of elements or objects types. FUN is the function called on the
3739 matching element or object. It must accept one arguments: the
3740 element or object itself.
3742 When optional argument INFO is non-nil, it should be a plist
3743 holding export options. In that case, parts of the parse tree
3744 not exportable according to that property list will be skipped.
3746 When optional argument FIRST-MATCH is non-nil, stop at the first
3747 match for which FUN doesn't return nil, and return that value.
3749 Optional argument NO-RECURSION is a symbol or a list of symbols
3750 representing elements or objects types. `org-element-map' won't
3751 enter any recursive element or object whose type belongs to that
3752 list. Though, FUN can still be applied on them.
3754 When optional argument WITH-AFFILIATED is non-nil, also move into
3755 affiliated keywords to find objects.
3757 Nil values returned from FUN do not appear in the results."
3758 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3761 ;; Recursion depth is determined by --CATEGORY.
3768 ;; If one object is found, the function
3769 ;; has to recurse into every object.
3772 ;; If one regular element is found, the
3773 ;; function has to recurse, at least,
3774 ;; into every element it encounters.
3777 types)
3778 category)))
3779 ;; Compute properties for affiliated keywords if necessary.
3784 org-element-affiliated-keywords)))
3785 --acc
3786 --walk-tree
3790 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3791 ;; holding contextual information.
3795 ;; Ignored element in an export context.
3797 ;; Secondary string: only objects can be found there.
3800 ;; Unconditionally enter parse trees.
3804 ;; Check if TYPE is matching among TYPES. If so,
3805 ;; apply FUN to --DATA and accumulate return value
3806 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3812 ;; If --DATA has a secondary string that can contain
3813 ;; objects with their type among TYPES, look into it.
3820 ;; If --DATA has any affiliated keywords and
3821 ;; WITH-AFFILIATED is non-nil, look for objects in
3822 ;; them.
3830 ;; Pay attention to the type of value.
3831 ;; Preserve order for multiple keywords.
3847 --affiliated-alist))
3848 ;; Determine if a recursion into --DATA is possible.
3850 ;; --TYPE is explicitly removed from recursion.
3852 ;; --DATA has no contents.
3854 ;; Looking for greater elements but --DATA is simply
3855 ;; an element or an object.
3858 ;; Looking for elements but --DATA is an object.
3861 ;; In any other case, map contents.
3865 ;; Return value in a proper order.
3868 ;; The following functions are internal parts of the parser.
3869 ;;
3870 ;; The first one, `org-element--parse-elements' acts at the element's
3871 ;; level.
3872 ;;
3873 ;; The second one, `org-element--parse-objects' applies on all objects
3874 ;; of a paragraph or a secondary string. It uses
3875 ;; `org-element--get-next-object-candidates' to optimize the search of
3876 ;; the next object in the buffer.
3877 ;;
3878 ;; More precisely, that function looks for every allowed object type
3879 ;; first. Then, it discards failed searches, keeps further matches,
3880 ;; and searches again types matched behind point, for subsequent
3881 ;; calls. Thus, searching for a given type fails only once, and every
3882 ;; object is searched only once at top level (but sometimes more for
3883 ;; nested types).
3887 "Parse elements between BEG and END positions.
3889 SPECIAL prioritize some elements over the others. It can be set
3890 to `first-section', `quote-section', `section' `item' or
3891 `table-row'.
3893 When value is `item', STRUCTURE will be used as the current list
3894 structure.
3896 GRANULARITY determines the depth of the recursion. See
3897 `org-element-parse-buffer' for more information.
3899 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3900 elements.
3902 Elements are accumulated into ACC."
3905 ;; When parsing only headlines, skip any text before first one.
3908 ;; Main loop start.
3910 ;; Find current element's type and parse it accordingly to
3911 ;; its category.
3913 end granularity special structure))
3917 ;; Fill ELEMENT contents by side-effect.
3919 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3920 ;; no contents, don't modify it.
3923 ;; Greater element: parse it between `contents-begin' and
3924 ;; `contents-end'. Make sure GRANULARITY allows the
3925 ;; recursion, or ELEMENT is an headline, in which case going
3926 ;; inside is mandatory, in order to get sub-level headings.
3934 ;; Possibly switch to a special mode.
3943 granularity visible-only element))
3944 ;; ELEMENT has contents. Parse objects inside, if
3945 ;; GRANULARITY allows it.
3951 ;; Return result.
3952 acc))
3955 "Parse objects between BEG and END and return recursive structure.
3957 Objects are accumulated in ACC.
3959 RESTRICTION is a list of object types which are allowed in the
3960 current object."
3966 end restriction candidates)))
3973 ;; 1. Text before any object. Untabify it.
3978 acc
3982 ;; 2. Object...
3985 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3986 ;; a recursive type.
3991 cont-beg
3998 ;; 3. Text after last object. Untabify it.
4002 acc
4006 ;; Result.
4007 acc)))
4010 "Return an alist of candidates for the next object.
4012 LIMIT bounds the search, and RESTRICTION narrows candidates to
4013 some object types.
4015 Return value is an alist whose CAR is position and CDR the object
4016 type, as a symbol.
4018 OBJECTS is the previous candidates alist."
4019 ;; Filter out any object found but not belonging to RESTRICTION.
4025 type)
4026 restriction)))
4027 objects))
4029 ;; If no previous result, search every object type in RESTRICTION.
4030 ;; Otherwise, keep potential candidates (old objects located after
4031 ;; point) and ask to search again those which had matched before.
4036 objects))
4037 ;; Call the appropriate successor function for each type to search
4038 ;; and accumulate matches.
4045 type))))
4048 types-to-search)
4049 ;; Return alist.
4050 next-candidates))
4053 \f
4054 ;;; Towards A Bijective Process
4055 ;;
4056 ;; The parse tree obtained with `org-element-parse-buffer' is really
4057 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4058 ;; interpreted and expanded into a string with canonical Org syntax.
4059 ;; Hence `org-element-interpret-data'.
4060 ;;
4061 ;; The function relies internally on
4062 ;; `org-element--interpret-affiliated-keywords'.
4064 ;;;###autoload
4066 "Interpret DATA as Org syntax.
4068 DATA is a parse tree, an element, an object or a secondary string
4069 to interpret.
4071 Optional argument PARENT is used for recursive calls. It contains
4072 the element or object containing data, or nil.
4074 Return Org syntax as a string."
4078 ;; Secondary string.
4083 ;; Full Org document.
4088 ;; Plain text.
4090 ;; Element/Object without contents.
4093 data nil))
4094 ;; Element/Object with contents.
4104 ;; Elements directly containing objects must
4105 ;; have their indentation normalized first.
4107 data
4108 ;; When normalizing first paragraph of an
4109 ;; item or a footnote-definition, ignore
4110 ;; first line's indentation.
4117 data
4119 contents)))))))
4121 ;; Build white spaces. If no `:post-blank' property is
4122 ;; specified, assume its value is 0.
4132 "Return ELEMENT's affiliated keywords as Org syntax.
4133 If there is no affiliated keyword, return the empty string."
4143 ": "
4146 value)
4154 ;; All attribute keywords can have multiple lines.
4160 ;; List all ELEMENT's properties matching an attribute line or an
4161 ;; affiliated keyword, but ignore translated keywords since they
4162 ;; cannot belong to the property list.
4169 org-element-keyword-translation-alist)))))
4170 collect prop)
4173 ;; Because interpretation of the parse tree must return the same
4174 ;; number of blank lines between elements and the same number of white
4175 ;; space after objects, some special care must be given to white
4176 ;; spaces.
4177 ;;
4178 ;; The first function, `org-element-normalize-string', ensures any
4179 ;; string different from the empty string will end with a single
4180 ;; newline character.
4181 ;;
4182 ;; The second function, `org-element-normalize-contents', removes
4183 ;; global indentation from the contents of the current element.
4186 "Ensure string S ends with a single newline character.
4188 If S isn't a string return it unchanged. If S is the empty
4189 string, return it. Otherwise, return a new string with a single
4190 newline character at its end."
4198 "Normalize plain text in ELEMENT's contents.
4200 ELEMENT must only contain plain text and objects.
4202 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4203 indentation to compute maximal common indentation.
4205 Return the normalized element that is element with global
4206 indentation removed from its contents. The function assumes that
4207 indentation is not done with TAB characters."
4209 collect-inds ; for byte-compiler
4212 ;; Return list of indentations within BLOB. This is done by
4213 ;; walking recursively BLOB and updating IND-LIST along the
4214 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4215 ;; been seen yet. It is required as this string is the only
4216 ;; one whose indentation doesn't happen after a newline
4217 ;; character.
4225 ;; An indentation of zero means no string will be
4226 ;; modified. Quit the process.
4232 ;; Avoid matching blank or empty lines.
4240 ;; Collect indentation list in ELEMENT. Possibly remove first
4241 ;; value if IGNORE-FIRST is non-nil.
4244 ;; Build ELEMENT back, replacing each string with the same
4245 ;; string minus common indentation.
4250 ;; Return BLOB with all its strings indentation
4251 ;; shortened from MCI white spaces. FIRST-FLAG is
4252 ;; non-nil when the first string hasn't been seen
4253 ;; yet.
4267 org-element-recursive-objects)
4271 blob))))
4275 \f
4276 ;;; The Toolbox
4277 ;;
4278 ;; The first move is to implement a way to obtain the smallest element
4279 ;; containing point. This is the job of `org-element-at-point'. It
4280 ;; basically jumps back to the beginning of section containing point
4281 ;; and moves, element after element, with
4282 ;; `org-element--current-element' until the container is found. Note:
4283 ;; When using `org-element-at-point', secondary values are never
4284 ;; parsed since the function focuses on elements, not on objects.
4285 ;;
4286 ;; At a deeper level, `org-element-context' lists all elements and
4287 ;; objects containing point.
4288 ;;
4289 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4290 ;; internally by navigation and manipulation tools.
4292 ;;;###autoload
4294 "Determine closest element around point.
4296 Return value is a list like (TYPE PROPS) where TYPE is the type
4297 of the element and PROPS a plist of properties associated to the
4298 element.
4300 Possible types are defined in `org-element-all-elements'.
4301 Properties depend on element or object type, but always
4302 include :begin, :end, :parent and :post-blank properties.
4304 As a special case, if point is at the very beginning of a list or
4305 sub-list, returned element will be that list instead of the first
4306 item. In the same way, if point is at the beginning of the first
4307 row of a table, returned element will be the table instead of the
4308 first row.
4310 If optional argument KEEP-TRAIL is non-nil, the function returns
4311 a list of of elements leading to element at point. The list's
4312 CAR is always the element at point. Following positions contain
4313 element's siblings, then parents, siblings of parents, until the
4314 first element of current section."
4316 ;; If at an headline, parse it. It is the sole element that
4317 ;; doesn't require to know about context. Be sure to disallow
4318 ;; secondary string parsing, though.
4324 ;; Otherwise move at the beginning of the section containing
4325 ;; point.
4329 element type special-flag trail struct prevs parent)
4337 ;; Parse successively each element, skipping those ending
4338 ;; before original position.
4347 ;; 1. Skip any element ending before point. Also skip
4348 ;; element ending at point when we're sure that another
4349 ;; element has started.
4354 ;; 2. An element containing point is always the element at
4355 ;; point.
4358 ;; 3. At any other greater element type, if point is
4359 ;; within contents, move into it.
4364 ;; Create an anchor for tables and plain lists:
4365 ;; when point is at the very beginning of these
4366 ;; elements, ignoring affiliated keywords,
4367 ;; target them instead of their contents.
4369 ;; When point is at contents end, do not move
4370 ;; into elements with an explicit ending, but
4371 ;; return that element instead.
4375 drawer dynamic-block inlinetask item
4376 plain-list property-drawer quote-block
4377 special-block))))
4390 ;;;###autoload
4392 "Return closest element or object around point.
4394 Return value is a list like (TYPE PROPS) where TYPE is the type
4395 of the element or object and PROPS a plist of properties
4396 associated to it.
4398 Possible types are defined in `org-element-all-elements' and
4399 `org-element-all-objects'. Properties depend on element or
4400 object type, but always include :begin, :end, :parent
4401 and :post-blank properties."
4406 end)
4407 ;; Check if point is inside an element containing objects or at
4408 ;; a secondary string. In that case, move to beginning of the
4409 ;; element or secondary string and set END to the other side.
4418 (<= origin
4419 ;; `1+' is required so some
4420 ;; successors can match
4421 ;; properly their object.
4435 element
4438 candidates)
4441 end restriction candidates))
4443 candidates)))
4444 ;; If ORIGIN is before next object in element, there's
4445 ;; no point in looking further.
4454 ;; ORIGIN is after OBJECT, so skip it.
4457 ;; ORIGIN is within a non-recursive object or at an
4458 ;; object boundaries: Return that object.
4462 ;; Otherwise, move within current object and restrict
4463 ;; search to the end of its contents.
4468 end cend)))))))
4469 parent))))))
4472 "Non-nil when elements ELEM-A and ELEM-B are nested."
4481 "Swap elements ELEM-A and ELEM-B.
4482 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4483 end of ELEM-A."
4485 ;; There are two special cases when an element doesn't start at bol:
4486 ;; the first paragraph in an item or in a footnote definition.
4488 ;; Only a paragraph without any affiliated keyword can be moved at
4489 ;; ELEM-A position in such a situation. Note that the case of
4490 ;; a footnote definition is impossible: it cannot contain two
4491 ;; paragraphs in a row because it cannot contain a blank line.
4497 ;; In a special situation, ELEM-A will have no indentation. We'll
4498 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4512 ;; Store overlays responsible for visibility status. We
4513 ;; also need to store their boundaries as they will be
4514 ;; removed from buffer.
4521 ;; Get contents.
4529 ;; Restore ex ELEM-A overlays.
4538 ;; Restore ex ELEM-B overlays.
4547 ;; Local variables:
4548 ;; generated-autoload-file: "org-loaddefs.el"
4549 ;; End:
4551 ;;; org-element.el ends here