| blob | d02f9075d6f8be916d36b9842448ec5cffc0c3ff |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 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', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `export-block',
49 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
50 ;; `node-property', `paragraph', `planning', `src-block', `table',
51 ;; `table-row' and `verse-block'. Among them, `paragraph' and
52 ;; `verse-block' types can contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, greater elements and elements accepting
77 ;; affiliated keywords will have a `:post-affiliated' property,
78 ;; referring to the buffer position after all such keywords.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block section
180 special-block src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 inline-src-block italic line-break latex-fragment link macro
192 radio-target statistics-cookie strike-through subscript superscript
193 table-cell target timestamp underline verbatim)
198 table-cell underline)
208 "Alist between block names and the associated parsing function.
209 Names must be uppercase. Any block whose name has no association
215 Only these types can accept search options and an explicit
221 "List of affiliated keywords as strings.
229 "Alist of usual translations for keywords.
230 The key is the old name and the value the new one. The property
234 "List of affiliated keywords that can occur more than once in an element.
236 Their value will be consed into a list of strings, which will be
237 returned as the value of the property.
239 This list is checked after translations have been applied. See
240 `org-element-keyword-translation-alist'.
246 "List of affiliated keywords whose value can be parsed.
248 Their value will be stored as a secondary string: a list of
249 strings and objects.
251 This list is checked after translations have been applied. See
255 "List of affiliated keywords which can have a secondary value.
257 In Org syntax, they can be written with optional square brackets
258 before the colons. For example, RESULTS keyword can be
259 associated to a hash value with the following:
261 #+RESULTS[hash-string]: some-source
263 This list is checked after translations have been applied. See
267 "List of properties associated to the whole document.
268 Any keyword in this list will have its value parsed and stored as
274 ;; Dual affiliated keywords.
278 ;; Regular affiliated keywords.
284 org-element-affiliated-keywords)))
286 ;; Export attributes.
288 "Regexp matching any affiliated keyword.
290 Keyword name is put in match group 1. Moreover, if keyword
291 belongs to `org-element-dual-keywords', put the dual value in
292 match group 2.
306 ;; Ignore all links excepted plain links in a link description.
307 ;; Also ignore radio-targets and line breaks.
309 italic latex-fragment macro plain-link statistics-cookie
310 strike-through subscript superscript underline verbatim)
312 ;; Remove any variable object from radio target as it would
313 ;; prevent it from being properly recognized.
315 subscript superscript underline superscript)
319 ;; Ignore inline babel call and inline src block as formulas are
320 ;; possible. Also ignore line breaks and statistics cookies.
322 latex-fragment link macro radio-target strike-through
323 subscript superscript target timestamp underline verbatim)
327 "Alist of objects restrictions.
329 key is an element or object type containing objects and value is
330 a list of types that can be contained within an element or object
331 of such type.
333 For example, in a `radio-target' object, one can only find
334 entities, latex-fragments, subscript, superscript and text
335 markup.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents'. These
362 ;; low-level functions are useful to build a parse tree.
363 ;;
364 ;; `org-element-adopt-element', `org-element-set-element',
365 ;; `org-element-extract-element' and `org-element-insert-before' are
366 ;; high-level functions useful to modify a parse tree.
367 ;;
368 ;; `org-element-secondary-p' is a predicate used to know if a given
369 ;; object belongs to a secondary string.
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."
395 "Return restriction associated to ELEMENT.
396 ELEMENT can be an element, an object or a symbol representing an
397 element or object type."
399 org-element-object-restrictions)))
402 "In ELEMENT set PROPERTY to VALUE.
403 Return modified element."
406 element))
409 "Set ELEMENT contents to CONTENTS.
410 Return modified element."
417 "Non-nil when OBJECT belongs to a secondary string.
418 Return value is the property name, as a keyword, or nil."
421 org-element-secondary-value-alist))))
424 property)))
427 "Append elements to the contents of another element.
429 PARENT is an element or object. CHILDREN can be elements,
430 objects, or a strings.
432 The function takes care of setting `:parent' property for CHILD.
433 Return parent element."
434 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
435 ;; string: parent is the list itself.
438 children)
439 ;; Add CHILDREN at the end of PARENT contents.
442 parent
444 ;; Return modified PARENT element.
448 "Extract ELEMENT from parse tree.
449 Remove element from the parse tree by side-effect, and return it
450 with its `:parent' property stripped out."
455 parent secondary
458 parent
460 ;; Return ELEMENT with its :parent removed.
464 "Insert ELEMENT before LOCATION in parse tree.
465 LOCATION is an element, object or string within the parse tree.
466 Parse tree is modified by side effect."
471 ;; Special case: LOCATION is the first element of an
472 ;; independent secondary string (e.g. :title property). Add
473 ;; ELEMENT in-place.
477 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
487 ;; Store SIBLINGS at appropriate place in parse tree.
492 ;; Set appropriate :parent property.
496 "Replace element or object OLD with element or object NEW.
497 The function takes care of setting `:parent' property for NEW."
498 ;; Ensure OLD and NEW have the same parent.
502 ;; We cannot replace OLD with NEW since one of them is not an
503 ;; object or element. We take the long path.
506 ;; Since OLD is going to be changed into NEW by side-effect, first
507 ;; make sure that every element or object within NEW has OLD as
508 ;; parent.
511 ;; Transfer contents.
513 ;; Overwrite OLD's properties with NEW's.
515 ;; Transfer type.
519 \f
520 ;;; Greater elements
521 ;;
522 ;; For each greater element type, we define a parser and an
523 ;; interpreter.
524 ;;
525 ;; A parser returns the element or object as the list described above.
526 ;; Most of them accepts no argument. Though, exceptions exist. Hence
527 ;; every element containing a secondary string (see
528 ;; `org-element-secondary-value-alist') will accept an optional
529 ;; argument to toggle parsing of that secondary string. Moreover,
530 ;; `item' parser requires current list's structure as its first
531 ;; element.
532 ;;
533 ;; An interpreter accepts two arguments: the list representation of
534 ;; the element or object, and its contents. The latter may be nil,
535 ;; depending on the element or object considered. It returns the
536 ;; appropriate Org syntax, as a string.
537 ;;
538 ;; Parsing functions must follow the naming convention:
539 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
540 ;; defined in `org-element-greater-elements'.
541 ;;
542 ;; Similarly, interpreting functions must follow the naming
543 ;; convention: org-element-TYPE-interpreter.
544 ;;
545 ;; With the exception of `headline' and `item' types, greater elements
546 ;; cannot contain other greater elements of their own type.
547 ;;
548 ;; Beside implementing a parser and an interpreter, adding a new
549 ;; greater element requires to tweak `org-element--current-element'.
550 ;; Moreover, the newly defined type must be added to both
551 ;; `org-element-all-elements' and `org-element-greater-elements'.
554 ;;;; Center Block
557 "Parse a center block.
559 LIMIT bounds the search. AFFILIATED is a list of which CAR is
560 the buffer position at the beginning of the first affiliated
561 keyword and CDR is a plist of affiliated keywords along with
562 their value.
564 Return a list whose CAR is `center-block' and CDR is a plist
565 containing `:begin', `:end', `:contents-begin', `:contents-end',
566 `:post-blank' and `:post-affiliated' keywords.
568 Assume point is at the beginning of the block."
572 ;; Incomplete block: parse it as a paragraph.
577 ;; Empty blocks have no contents.
591 :end end
592 :contents-begin contents-begin
593 :contents-end contents-end
599 "Interpret CENTER-BLOCK element as Org syntax.
600 CONTENTS is the contents of the element."
604 ;;;; Drawer
607 "Parse a drawer.
609 LIMIT bounds the search. AFFILIATED is a list of which CAR is
610 the buffer position at the beginning of the first affiliated
611 keyword and CDR is a plist of affiliated keywords along with
612 their value.
614 Return a list whose CAR is `drawer' and CDR is a plist containing
615 `:drawer-name', `:begin', `:end', `:contents-begin',
616 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
618 Assume point is at beginning of drawer."
621 ;; Incomplete drawer: parse it as a paragraph.
629 ;; Empty drawers have no contents.
642 :end end
643 :drawer-name name
644 :contents-begin contents-begin
645 :contents-end contents-end
651 "Interpret DRAWER element as Org syntax.
652 CONTENTS is the contents of the element."
655 contents))
658 ;;;; Dynamic Block
661 "Parse a dynamic block.
663 LIMIT bounds the search. AFFILIATED is a list of which CAR is
664 the buffer position at the beginning of the first affiliated
665 keyword and CDR is a plist of affiliated keywords along with
666 their value.
668 Return a list whose CAR is `dynamic-block' and CDR is a plist
669 containing `:block-name', `:begin', `:end', `:contents-begin',
670 `:contents-end', `:arguments', `:post-blank' and
671 `:post-affiliated' keywords.
673 Assume point is at beginning of dynamic block."
677 ;; Incomplete block: parse it as a paragraph.
686 ;; Empty blocks have no contents.
699 :end end
700 :block-name name
701 :arguments arguments
702 :contents-begin contents-begin
703 :contents-end contents-end
709 "Interpret DYNAMIC-BLOCK element as Org syntax.
710 CONTENTS is the contents of the element."
715 contents))
718 ;;;; Footnote Definition
721 "Parse a footnote definition.
723 LIMIT bounds the search. AFFILIATED is a list of which CAR is
724 the buffer position at the beginning of the first affiliated
725 keyword and CDR is a plist of affiliated keywords along with
726 their value.
728 Return a list whose CAR is `footnote-definition' and CDR is
729 a plist containing `:label', `:begin' `:end', `:contents-begin',
730 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
732 Assume point is at the beginning of the footnote definition."
760 :begin begin
761 :end end
762 :contents-begin contents-begin
763 :contents-end contents-end
769 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
770 CONTENTS is the contents of the footnote-definition."
772 " "
773 contents))
776 ;;;; Headline
779 "Parse a headline.
781 Return a list whose CAR is `headline' and CDR is a plist
782 containing `:raw-value', `:title', `:alt-title', `:begin',
783 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
784 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
785 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
786 and `:footnote-section-p' keywords.
788 The plist also contains any property set in the property drawer,
789 with its name in upper cases and colons added at the
790 beginning (e.g., `:CUSTOM_ID').
792 LIMIT is a buffer position bounding the search.
794 When RAW-SECONDARY-P is non-nil, headline's title will not be
795 parsed as a secondary string, but as a plain string instead.
797 Assume point is at beginning of the headline."
810 raw-value)))
814 ;; Upcase property names. It avoids confusion between
815 ;; properties obtained through property drawer and default
816 ;; properties from the parser (e.g. `:end' and :END:)
826 plist))
828 ;; Read time properties on the line below the headline.
834 org-keyword-time-not-clock-regexp end t)
844 plist))))
856 ;; Clean RAW-VALUE from any comment string.
862 ""
863 raw-value))))
864 ;; Clean TAGS from archive tag, if any.
870 :begin begin
871 :end end
872 :pre-blank
875 :contents-begin contents-begin
876 :contents-end contents-end
877 :level level
879 :tags tags
880 :todo-keyword todo
881 :todo-type todo-type
884 end)
885 :footnote-section-p footnote-section-p
886 :archivedp archivedp
888 time-props
889 standard-props))))
893 headline :alt-title
898 headline :title
904 "Interpret HEADLINE element as Org syntax.
905 CONTENTS is the contents of the element."
930 ;; Align tags.
938 ? )
939 tags))
943 tags))))
945 contents)))
948 ;;;; Inlinetask
951 "Parse an inline task.
953 Return a list whose CAR is `inlinetask' and CDR is a plist
954 containing `:title', `:begin', `:end', `:contents-begin' and
955 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
956 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
957 `:closed' and `:post-blank' keywords.
959 The plist also contains any property set in the property drawer,
960 with its name in upper cases and colons added at the
961 beginning (e.g., `:CUSTOM_ID').
963 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
964 title will not be parsed as a secondary string, but as a plain
965 string instead.
967 Assume point is at beginning of the inline task."
977 ;; Upcase property names. It avoids confusion between
978 ;; properties obtained through property drawer and default
979 ;; properties from the parser (e.g. `:end' and :END:)
989 plist))
991 ;; Read time properties on the line below the inlinetask
992 ;; opening string.
998 org-keyword-time-not-clock-regexp end t)
1008 plist))))
1027 :begin begin
1028 :end end
1029 :contents-begin contents-begin
1030 :contents-end contents-end
1033 :tags tags
1034 :todo-keyword todo
1035 :todo-type todo-type
1037 time-props
1038 standard-props))))
1040 inlinetask :title
1043 raw-value
1045 inlinetask))))))
1048 "Interpret INLINETASK element as Org syntax.
1049 CONTENTS is the contents of inlinetask."
1064 ;; Align tags.
1072 ? )
1073 tags))
1077 tags))))
1078 ;; Prefer degenerate inlinetasks when there are no
1079 ;; contents.
1082 contents
1086 ;;;; Item
1089 "Parse an item.
1091 STRUCT is the structure of the plain list.
1093 Return a list whose CAR is `item' and CDR is a plist containing
1094 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1095 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1096 keywords.
1098 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1099 any, will not be parsed as a secondary string, but as a plain
1100 string instead.
1102 Assume point is at the beginning of the item."
1126 ;; Ignore tags in un-ordered lists: they are just
1127 ;; a part of item's body.
1133 ;; If first line isn't empty, contents really start
1134 ;; at the text after item's meta-data.
1143 :begin begin
1144 :end end
1145 ;; CONTENTS-BEGIN and CONTENTS-END may be
1146 ;; mixed up in the case of an empty item
1147 ;; separated from the next by a blank line.
1148 ;; Thus ensure the former is always the
1149 ;; smallest.
1152 :checkbox checkbox
1153 :counter counter
1154 :structure struct
1157 item :tag
1165 "Interpret ITEM element as Org syntax.
1166 CONTENTS is the contents of the element."
1176 ;; Compute indentation.
1181 ;; Indent contents.
1183 bullet
1197 ;;;; Plain List
1200 ;; Return structure of list at point. Internal function. See
1201 ;; `org-list-struct' for details.
1206 items struct)
1211 ;; At limit: end all items.
1220 ;; At list end: end all items.
1225 ;; At a new item: end previous sibling.
1237 ind
1238 bullet
1241 ;; Description tag.
1245 ;; Ending position, unknown so far.
1246 nil)))
1247 items))
1249 ;; Skip empty lines.
1251 ;; Skip inline tasks and blank lines along the way.
1258 ;; At some text line. Check if it ends any previous item.
1270 ;; Skip blocks (any type) and drawers contents.
1275 limit t)))
1281 "Parse a plain list.
1283 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1284 the buffer position at the beginning of the first affiliated
1285 keyword and CDR is a plist of affiliated keywords along with
1286 their value. STRUCTURE is the structure of the plain list being
1287 parsed.
1289 Return a list whose CAR is `plain-list' and CDR is a plist
1290 containing `:type', `:begin', `:end', `:contents-begin' and
1291 `:contents-end', `:structure', `:post-blank' and
1292 `:post-affiliated' keywords.
1294 Assume point is at the beginning of the list."
1308 pos))
1312 ;; Return value.
1316 :begin begin
1317 :end end
1318 :contents-begin contents-begin
1319 :contents-end contents-end
1320 :structure struct
1326 "Interpret PLAIN-LIST element as Org syntax.
1327 CONTENTS is the contents of the element."
1335 ;;;; Property Drawer
1338 "Parse a property drawer.
1340 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1341 the buffer position at the beginning of the first affiliated
1342 keyword and CDR is a plist of affiliated keywords along with
1343 their value.
1345 Return a list whose CAR is `property-drawer' and CDR is a plist
1346 containing `:begin', `:end', `:contents-begin', `:contents-end',
1347 `:post-blank' and `:post-affiliated' keywords.
1349 Assume point is at the beginning of the property drawer."
1354 ;; Incomplete drawer: parse it as a paragraph.
1372 :end end
1373 :contents-begin contents-begin
1374 :contents-end contents-end
1380 "Interpret PROPERTY-DRAWER element as Org syntax.
1381 CONTENTS is the properties within the drawer."
1385 ;;;; Quote Block
1388 "Parse a quote block.
1390 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1391 the buffer position at the beginning of the first affiliated
1392 keyword and CDR is a plist of affiliated keywords along with
1393 their value.
1395 Return a list whose CAR is `quote-block' and CDR is a plist
1396 containing `:begin', `:end', `:contents-begin', `:contents-end',
1397 `:post-blank' and `:post-affiliated' keywords.
1399 Assume point is at the beginning of the block."
1403 ;; Incomplete block: parse it as a paragraph.
1409 ;; Empty blocks have no contents.
1422 :end end
1423 :contents-begin contents-begin
1424 :contents-end contents-end
1430 "Interpret QUOTE-BLOCK element as Org syntax.
1431 CONTENTS is the contents of the element."
1435 ;;;; Section
1438 "Parse a section.
1440 LIMIT bounds the search.
1442 Return a list whose CAR is `section' and CDR is a plist
1443 containing `:begin', `:end', `:contents-begin', `contents-end'
1444 and `:post-blank' keywords."
1446 ;; Beginning of section is the beginning of the first non-blank
1447 ;; line after previous headline.
1456 :end end
1457 :contents-begin begin
1458 :contents-end pos-before-blank
1462 "Interpret SECTION element as Org syntax.
1463 CONTENTS is the contents of the element."
1464 contents)
1467 ;;;; Special Block
1470 "Parse a special block.
1472 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1473 the buffer position at the beginning of the first affiliated
1474 keyword and CDR is a plist of affiliated keywords along with
1475 their value.
1477 Return a list whose CAR is `special-block' and CDR is a plist
1478 containing `:type', `:begin', `:end', `:contents-begin',
1479 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1481 Assume point is at the beginning of the block."
1488 limit t)))
1489 ;; Incomplete block: parse it as a paragraph.
1495 ;; Empty blocks have no contents.
1508 :begin begin
1509 :end end
1510 :contents-begin contents-begin
1511 :contents-end contents-end
1517 "Interpret SPECIAL-BLOCK element as Org syntax.
1518 CONTENTS is the contents of the element."
1523 \f
1524 ;;; Elements
1525 ;;
1526 ;; For each element, a parser and an interpreter are also defined.
1527 ;; Both follow the same naming convention used for greater elements.
1528 ;;
1529 ;; Also, as for greater elements, adding a new element type is done
1530 ;; through the following steps: implement a parser and an interpreter,
1531 ;; tweak `org-element--current-element' so that it recognizes the new
1532 ;; type and add that new type to `org-element-all-elements'.
1533 ;;
1534 ;; As a special case, when the newly defined type is a block type,
1535 ;; `org-element-block-name-alist' has to be modified accordingly.
1538 ;;;; Babel Call
1541 "Parse a babel call.
1543 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1544 the buffer position at the beginning of the first affiliated
1545 keyword and CDR is a plist of affiliated keywords along with
1546 their value.
1548 Return a list whose CAR is `babel-call' and CDR is a plist
1549 containing `:begin', `:end', `:value', `:post-blank' and
1550 `:post-affiliated' as keywords."
1564 :end end
1565 :value value
1571 "Interpret BABEL-CALL element as Org syntax.
1572 CONTENTS is nil."
1576 ;;;; Clock
1579 "Parse a clock.
1581 LIMIT bounds the search.
1583 Return a list whose CAR is `clock' and CDR is a plist containing
1584 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1585 as keywords."
1605 :value value
1606 :duration duration
1607 :begin begin
1608 :end end
1612 "Interpret CLOCK element as Org syntax.
1613 CONTENTS is nil."
1621 "%2s:%02s"
1625 ;;;; Comment
1628 "Parse a comment.
1630 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1631 the buffer position at the beginning of the first affiliated
1632 keyword and CDR is a plist of affiliated keywords along with
1633 their value.
1635 Return a list whose CAR is `comment' and CDR is a plist
1636 containing `:begin', `:end', `:value', `:post-blank',
1637 `:post-affiliated' keywords.
1639 Assume point is at comment beginning."
1648 ;; Get comments ending.
1651 ;; Accumulate lines without leading hash and first
1652 ;; whitespace.
1666 :end end
1667 :value value
1673 "Interpret COMMENT element as Org syntax.
1674 CONTENTS is nil."
1678 ;;;; Comment Block
1681 "Parse an export block.
1683 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1684 the buffer position at the beginning of the first affiliated
1685 keyword and CDR is a plist of affiliated keywords along with
1686 their value.
1688 Return a list whose CAR is `comment-block' and CDR is a plist
1689 containing `:begin', `:end', `:value', `:post-blank' and
1690 `:post-affiliated' keywords.
1692 Assume point is at comment block beginning."
1696 ;; Incomplete block: parse it as a paragraph.
1709 contents-begin contents-end)))
1713 :end end
1714 :value value
1720 "Interpret COMMENT-BLOCK element as Org syntax.
1721 CONTENTS is nil."
1726 ;;;; Diary Sexp
1729 "Parse a diary sexp.
1731 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1732 the buffer position at the beginning of the first affiliated
1733 keyword and CDR is a plist of affiliated keywords along with
1734 their value.
1736 Return a list whose CAR is `diary-sexp' and CDR is a plist
1737 containing `:begin', `:end', `:value', `:post-blank' and
1738 `:post-affiliated' keywords."
1750 :begin begin
1751 :end end
1757 "Interpret DIARY-SEXP as Org syntax.
1758 CONTENTS is nil."
1762 ;;;; Example Block
1765 "Parse an example block.
1767 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1768 the buffer position at the beginning of the first affiliated
1769 keyword and CDR is a plist of affiliated keywords along with
1770 their value.
1772 Return a list whose CAR is `example-block' and CDR is a plist
1773 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1774 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1775 `:value', `:post-blank' and `:post-affiliated' keywords."
1779 ;; Incomplete block: parse it as a paragraph.
1787 ;; Switches analysis
1794 ;; Should labels be retained in (or stripped from) example
1795 ;; blocks?
1800 ;; What should code-references use - labels or
1801 ;; line-numbers?
1810 ;; Standard block parsing.
1818 contents-begin contents-end))
1819 block-ind))
1828 :end end
1829 :value value
1830 :switches switches
1831 :number-lines number-lines
1832 :preserve-indent preserve-indent
1833 :retain-labels retain-labels
1834 :use-labels use-labels
1835 :label-fmt label-fmt
1841 "Interpret EXAMPLE-BLOCK element as Org syntax.
1842 CONTENTS is nil."
1849 value
1854 ;;;; Export Block
1857 "Parse an export block.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1862 their value.
1864 Return a list whose CAR is `export-block' and CDR is a plist
1865 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1866 `:post-affiliated' keywords.
1868 Assume point is at export-block beginning."
1875 ;; Incomplete block: parse it as a paragraph.
1888 contents-end)))
1892 :end end
1893 :type type
1894 :value value
1900 "Interpret EXPORT-BLOCK element as Org syntax.
1901 CONTENTS is nil."
1908 ;;;; Fixed-width
1911 "Parse a fixed-width section.
1913 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1914 the buffer position at the beginning of the first affiliated
1915 keyword and CDR is a plist of affiliated keywords along with
1916 their value.
1918 Return a list whose CAR is `fixed-width' and CDR is a plist
1919 containing `:begin', `:end', `:value', `:post-blank' and
1920 `:post-affiliated' keywords.
1922 Assume point is at the beginning of the fixed-width area."
1926 value
1931 ;; Accumulate text without starting colons.
1944 :end end
1945 :value value
1951 "Interpret FIXED-WIDTH element as Org syntax.
1952 CONTENTS is nil."
1960 ;;;; Horizontal Rule
1963 "Parse an horizontal rule.
1965 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1966 the buffer position at the beginning of the first affiliated
1967 keyword and CDR is a plist of affiliated keywords along with
1968 their value.
1970 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1971 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1972 keywords."
1982 :end end
1988 "Interpret HORIZONTAL-RULE element as Org syntax.
1989 CONTENTS is nil."
1993 ;;;; Keyword
1996 "Parse a keyword at point.
1998 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1999 the buffer position at the beginning of the first affiliated
2000 keyword and CDR is a plist of affiliated keywords along with
2001 their value.
2003 Return a list whose CAR is `keyword' and CDR is a plist
2004 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2005 `:post-affiliated' keywords."
2007 ;; An orphaned affiliated keyword is considered as a regular
2008 ;; keyword. In this case AFFILIATED is nil, so we take care of
2009 ;; this corner case.
2022 :value value
2023 :begin begin
2024 :end end
2030 "Interpret KEYWORD element as Org syntax.
2031 CONTENTS is nil."
2037 ;;;; Latex Environment
2040 "Parse a LaTeX environment.
2042 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2043 the buffer position at the beginning of the first affiliated
2044 keyword and CDR is a plist of affiliated keywords along with
2045 their value.
2047 Return a list whose CAR is `latex-environment' and CDR is a plist
2048 containing `:begin', `:end', `:value', `:post-blank' and
2049 `:post-affiliated' keywords.
2051 Assume point is at the beginning of the latex environment."
2058 limit t))
2059 ;; Incomplete latex environment: parse it as a paragraph.
2069 :end end
2070 :value value
2076 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2077 CONTENTS is nil."
2081 ;;;; Node Property
2084 "Parse a node-property at point.
2086 LIMIT bounds the search.
2088 Return a list whose CAR is `node-property' and CDR is a plist
2089 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2090 keywords."
2102 :value value
2103 :begin begin
2104 :end end
2108 "Interpret NODE-PROPERTY element as Org syntax.
2109 CONTENTS is nil."
2115 ;;;; Paragraph
2118 "Parse a paragraph.
2120 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2121 the buffer position at the beginning of the first affiliated
2122 keyword and CDR is a plist of affiliated keywords along with
2123 their value.
2125 Return a list whose CAR is `paragraph' and CDR is a plist
2126 containing `:begin', `:end', `:contents-begin' and
2127 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2129 Assume point is at the beginning of the paragraph."
2138 limit
2139 ;; A matching `org-element-paragraph-separate' is not
2140 ;; necessarily the end of the paragraph. In
2141 ;; particular, lines starting with # or : as a first
2142 ;; non-space character are ambiguous. We have to
2143 ;; check if they are valid Org syntax (e.g., not an
2144 ;; incomplete keyword).
2148 ;; There's no ambiguity for other symbols or
2149 ;; empty lines: stop here.
2151 ;; Stop at valid fixed-width areas.
2153 ;; Stop at drawers.
2158 ;; Stop at valid comments.
2160 ;; Stop at valid dynamic blocks.
2165 ;; Stop at valid blocks.
2172 limit t)))
2173 ;; Stop at valid latex environments.
2181 limit t)))
2182 ;; Stop at valid keywords.
2184 ;; Skip everything else.
2201 :end end
2202 :contents-begin contents-begin
2203 :contents-end contents-end
2209 "Interpret PARAGRAPH element as Org syntax.
2210 CONTENTS is the contents of the element."
2211 contents)
2214 ;;;; Planning
2217 "Parse a planning.
2219 LIMIT bounds the search.
2221 Return a list whose CAR is `planning' and CDR is a plist
2222 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2223 and `:post-blank' keywords."
2233 closed deadline scheduled)
2245 :deadline deadline
2246 :scheduled scheduled
2247 :begin begin
2248 :end end
2252 "Interpret PLANNING element as Org syntax.
2253 CONTENTS is nil."
2255 'identity
2272 ;;;; Src Block
2275 "Parse a src block.
2277 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2278 the buffer position at the beginning of the first affiliated
2279 keyword and CDR is a plist of affiliated keywords along with
2280 their value.
2282 Return a list whose CAR is `src-block' and CDR is a plist
2283 containing `:language', `:switches', `:parameters', `:begin',
2284 `:end', `:number-lines', `:retain-labels', `:use-labels',
2285 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2286 `:post-affiliated' keywords.
2288 Assume point is at the beginning of the block."
2291 limit t)))
2292 ;; Incomplete block: parse it as a paragraph.
2298 ;; Get language as a string.
2307 ;; Get switches.
2309 ;; Get parameters.
2311 ;; Switches analysis
2322 ;; Should labels be retained in (or stripped from)
2323 ;; src blocks?
2328 ;; What should code-references use - labels or
2329 ;; line-numbers?
2334 ;; Indentation.
2336 ;; Retrieve code.
2341 block-ind))
2345 ;; Get position after ending blank lines.
2355 :begin begin
2356 :end end
2357 :number-lines number-lines
2358 :preserve-indent preserve-indent
2359 :retain-labels retain-labels
2360 :use-labels use-labels
2361 :label-fmt label-fmt
2362 :value value
2368 "Interpret SRC-BLOCK element as Org syntax.
2369 CONTENTS is nil."
2378 val)
2392 ;;;; Table
2395 "Parse a table at point.
2397 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2398 the buffer position at the beginning of the first affiliated
2399 keyword and CDR is a plist of affiliated keywords along with
2400 their value.
2402 Return a list whose CAR is `table' and CDR is a plist containing
2403 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2404 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2405 keywords.
2407 Assume point is at the beginning of the table."
2421 acc))
2428 :end end
2429 :type type
2430 :tblfm tblfm
2431 ;; Only `org' tables have contents. `table.el' tables
2432 ;; use a `:value' property to store raw table as
2433 ;; a string.
2438 table-begin table-end))
2444 "Interpret TABLE element as Org syntax.
2445 CONTENTS is nil."
2456 ;;;; Table Row
2459 "Parse table row at point.
2461 LIMIT bounds the search.
2463 Return a list whose CAR is `table-row' and CDR is a plist
2464 containing `:begin', `:end', `:contents-begin', `:contents-end',
2465 `:type' and `:post-blank' keywords."
2469 ;; A table rule has no contents. In that case, ensure
2470 ;; CONTENTS-BEGIN matches CONTENTS-END.
2482 :begin begin
2483 :end end
2484 :contents-begin contents-begin
2485 :contents-end contents-end
2489 "Interpret TABLE-ROW element as Org syntax.
2490 CONTENTS is the contents of the table row."
2495 ;;;; Verse Block
2498 "Parse a verse block.
2500 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2501 the buffer position at the beginning of the first affiliated
2502 keyword and CDR is a plist of affiliated keywords along with
2503 their value.
2505 Return a list whose CAR is `verse-block' and CDR is a plist
2506 containing `:begin', `:end', `:contents-begin', `:contents-end',
2507 `:post-blank' and `:post-affiliated' keywords.
2509 Assume point is at beginning of the block."
2513 ;; Incomplete block: parse it as a paragraph.
2528 :end end
2529 :contents-begin contents-begin
2530 :contents-end contents-end
2536 "Interpret VERSE-BLOCK element as Org syntax.
2537 CONTENTS is verse block contents."
2541 \f
2542 ;;; Objects
2543 ;;
2544 ;; Unlike to elements, raw text can be found between objects. Hence,
2545 ;; `org-element--object-lex' is provided to find the next object in
2546 ;; buffer.
2547 ;;
2548 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2549 ;; object types they can contain will be specified in
2550 ;; `org-element-object-restrictions'.
2551 ;;
2552 ;; Creating a new type of object requires to alter
2553 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2554 ;; new type in `org-element-all-objects', and possibly add
2555 ;; restrictions in `org-element-object-restrictions'.
2557 ;;;; Bold
2560 "Parse bold object at point, if any.
2562 When at a bold object, return a list whose car is `bold' and cdr
2563 is a plist with `:begin', `:end', `:contents-begin' and
2564 `:contents-end' and `:post-blank' keywords. Otherwise, return
2565 nil.
2567 Assume point is at the first star marker."
2579 :end end
2580 :contents-begin contents-begin
2581 :contents-end contents-end
2585 "Interpret BOLD object as Org syntax.
2586 CONTENTS is the contents of the object."
2590 ;;;; Code
2593 "Parse code object at point, if any.
2595 When at a code object, return a list whose car is `code' and cdr
2596 is a plist with `:value', `:begin', `:end' and `:post-blank'
2597 keywords. Otherwise, return nil.
2599 Assume point is at the first tilde marker."
2610 :begin begin
2611 :end end
2615 "Interpret CODE object as Org syntax.
2616 CONTENTS is nil."
2620 ;;;; Entity
2623 "Parse entity at point, if any.
2625 When at an entity, return a list whose car is `entity' and cdr
2626 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2627 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2628 `:post-blank' as keywords. Otherwise, return nil.
2630 Assume point is at the beginning of the entity."
2632 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2650 :begin begin
2651 :end end
2652 :use-brackets-p bracketsp
2656 "Interpret ENTITY object as Org syntax.
2657 CONTENTS is nil."
2663 ;;;; Export Snippet
2666 "Parse export snippet at point.
2668 When at an export snippet, return a list whose car is
2669 `export-snippet' and cdr a plist with `:begin', `:end',
2670 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2671 return nil.
2673 Assume point is at the beginning of the snippet."
2689 :value value
2690 :begin begin
2691 :end end
2695 "Interpret EXPORT-SNIPPET object as Org syntax.
2696 CONTENTS is nil."
2702 ;;;; Footnote Reference
2705 "Parse footnote reference at point, if any.
2707 When at a footnote reference, return a list whose car is
2708 `footnote-reference' and cdr a plist with `:label', `:type',
2709 `:inline-definition', `:begin', `:end' and `:post-blank' as
2710 keywords. Otherwise, return nil."
2734 :type type
2735 :begin begin
2736 :end end
2739 footnote-reference :inline-definition
2744 footnote-reference))))))))
2747 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2748 CONTENTS is nil."
2758 ;;;; Inline Babel Call
2761 "Parse inline babel call at point, if any.
2763 When at an inline babel call, return a list whose car is
2764 `inline-babel-call' and cdr a plist with `:begin', `:end',
2765 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2767 Assume point is at the beginning of the babel call."
2779 :end end
2780 :value value
2784 "Interpret INLINE-BABEL-CALL object as Org syntax.
2785 CONTENTS is nil."
2789 ;;;; Inline Src Block
2792 "Parse inline source block at point, if any.
2794 When at an inline source block, return a list whose car is
2795 `inline-src-block' and cdr a plist with `:begin', `:end',
2796 `:language', `:value', `:parameters' and `:post-blank' as
2797 keywords. Otherwise, return nil.
2799 Assume point is at the beginning of the inline src block."
2812 :value value
2813 :parameters parameters
2814 :begin begin
2815 :end end
2819 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2820 CONTENTS is nil."
2825 language
2827 body)))
2829 ;;;; Italic
2832 "Parse italic object at point, if any.
2834 When at an italic object, return a list whose car is `italic' and
2835 cdr is a plist with `:begin', `:end', `:contents-begin' and
2836 `:contents-end' and `:post-blank' keywords. Otherwise, return
2837 nil.
2839 Assume point is at the first slash marker."
2851 :end end
2852 :contents-begin contents-begin
2853 :contents-end contents-end
2857 "Interpret ITALIC object as Org syntax.
2858 CONTENTS is the contents of the object."
2862 ;;;; Latex Fragment
2865 "Parse LaTeX fragment at point, if any.
2867 When at a LaTeX fragment, return a list whose car is
2868 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2869 and `:post-blank' as keywords. Otherwise, return nil.
2871 Assume point is at the beginning of the LaTeX fragment."
2885 ;; Macro.
2888 ;; No fragment found.
2896 :begin begin
2897 :end end
2901 "Interpret LATEX-FRAGMENT object as Org syntax.
2902 CONTENTS is nil."
2905 ;;;; Line Break
2908 "Parse line break at point, if any.
2910 When at a line break, return a list whose car is `line-break',
2911 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2912 Otherwise, return nil.
2914 Assume point is at the beginning of the line break."
2923 "Interpret LINE-BREAK object as Org syntax.
2924 CONTENTS is nil."
2928 ;;;; Link
2931 "Parse link at point, if any.
2933 When at a link, return a list whose car is `link' and cdr a plist
2934 with `:type', `:path', `:raw-link', `:application',
2935 `:search-option', `:begin', `:end', `:contents-begin',
2936 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2937 nil.
2939 Assume point is at the beginning of the link."
2942 end contents-begin contents-end link-end post-blank path type
2943 raw-link link search-option application)
2945 ;; Type 1: Text targeted from a radio target.
2954 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2959 ;; RAW-LINK is the original link. Expand any
2960 ;; abbreviation in it.
2964 ;; Determine TYPE of link and set PATH accordingly.
2966 ;; File type.
2970 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2973 ;; Id type: PATH is the id.
2976 ;; Code-ref type: PATH is the name of the reference.
2979 ;; Custom-id type: PATH is the name of the custom id.
2982 ;; Fuzzy type: Internal link either matches a target, an
2983 ;; headline name or nothing. PATH is the target or
2984 ;; headline's name.
2986 ;; Type 3: Plain link, e.g., http://orgmode.org
2992 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3000 ;; In any case, deduce end point after trailing white space from
3001 ;; LINK-END variable.
3005 ;; Special "file" type link processing.
3007 ;; Extract opening application and search option.
3015 ;; Normalize URI.
3019 ;; Make sure TYPE always reports "file".
3023 :path path
3025 :application application
3026 :search-option search-option
3027 :begin begin
3028 :end end
3029 :contents-begin contents-begin
3030 :contents-end contents-end
3034 "Interpret LINK object as Org syntax.
3035 CONTENTS is the contents of the object, or nil."
3040 raw-link
3044 ;;;; Macro
3047 "Parse macro at point, if any.
3049 When at a macro, return a list whose car is `macro' and cdr
3050 a plist with `:key', `:args', `:begin', `:end', `:value' and
3051 `:post-blank' as keywords. Otherwise, return nil.
3053 Assume point is at the macro."
3064 ;; Do not use `org-split-string' since empty
3065 ;; strings are meaningful here.
3073 args nil t)
3077 :value value
3078 :args args
3079 :begin begin
3080 :end end
3084 "Interpret MACRO object as Org syntax.
3085 CONTENTS is nil."
3089 ;;;; Radio-target
3092 "Parse radio target at point, if any.
3094 When at a radio target, return a list whose car is `radio-target'
3095 and cdr a plist with `:begin', `:end', `:contents-begin',
3096 `:contents-end', `:value' and `:post-blank' as keywords.
3097 Otherwise, return nil.
3099 Assume point is at the radio target."
3111 :end end
3112 :contents-begin contents-begin
3113 :contents-end contents-end
3114 :post-blank post-blank
3118 "Interpret TARGET object as Org syntax.
3119 CONTENTS is the contents of the object."
3123 ;;;; Statistics Cookie
3126 "Parse statistics cookie at point, if any.
3128 When at a statistics cookie, return a list whose car is
3129 `statistics-cookie', and cdr a plist with `:begin', `:end',
3130 `:value' and `:post-blank' keywords. Otherwise, return nil.
3132 Assume point is at the beginning of the statistics-cookie."
3143 :end end
3144 :value value
3148 "Interpret STATISTICS-COOKIE object as Org syntax.
3149 CONTENTS is nil."
3153 ;;;; Strike-Through
3156 "Parse strike-through object at point, if any.
3158 When at a strike-through object, return a list whose car is
3159 `strike-through' and cdr is a plist with `:begin', `:end',
3160 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3161 Otherwise, return nil.
3163 Assume point is at the first plus sign marker."
3175 :end end
3176 :contents-begin contents-begin
3177 :contents-end contents-end
3181 "Interpret STRIKE-THROUGH object as Org syntax.
3182 CONTENTS is the contents of the object."
3186 ;;;; Subscript
3189 "Parse subscript at point, if any.
3191 When at a subscript object, return a list whose car is
3192 `subscript' and cdr a plist with `:begin', `:end',
3193 `:contents-begin', `:contents-end', `:use-brackets-p' and
3194 `:post-blank' as keywords. Otherwise, return nil.
3196 Assume point is at the underscore."
3210 :end end
3211 :use-brackets-p bracketsp
3212 :contents-begin contents-begin
3213 :contents-end contents-end
3217 "Interpret SUBSCRIPT object as Org syntax.
3218 CONTENTS is the contents of the object."
3221 contents))
3224 ;;;; Superscript
3227 "Parse superscript at point, if any.
3229 When at a superscript object, return a list whose car is
3230 `superscript' and cdr a plist with `:begin', `:end',
3231 `:contents-begin', `:contents-end', `:use-brackets-p' and
3232 `:post-blank' as keywords. Otherwise, return nil.
3234 Assume point is at the caret."
3248 :end end
3249 :use-brackets-p bracketsp
3250 :contents-begin contents-begin
3251 :contents-end contents-end
3255 "Interpret SUPERSCRIPT object as Org syntax.
3256 CONTENTS is the contents of the object."
3259 contents))
3262 ;;;; Table Cell
3265 "Parse table cell at point.
3266 Return a list whose car is `table-cell' and cdr is a plist
3267 containing `:begin', `:end', `:contents-begin', `:contents-end'
3268 and `:post-blank' keywords."
3276 :end end
3277 :contents-begin contents-begin
3278 :contents-end contents-end
3282 "Interpret TABLE-CELL element as Org syntax.
3283 CONTENTS is the contents of the cell, or nil."
3287 ;;;; Target
3290 "Parse target at point, if any.
3292 When at a target, return a list whose car is `target' and cdr
3293 a plist with `:begin', `:end', `:value' and `:post-blank' as
3294 keywords. Otherwise, return nil.
3296 Assume point is at the target."
3306 :end end
3307 :value value
3311 "Interpret TARGET object as Org syntax.
3312 CONTENTS is nil."
3316 ;;;; Timestamp
3327 "Parse time stamp at point, if any.
3329 When at a time stamp, return a list whose car is `timestamp', and
3330 cdr a plist with `:type', `:raw-value', `:year-start',
3331 `:month-start', `:day-start', `:hour-start', `:minute-start',
3332 `:year-end', `:month-end', `:day-end', `:hour-end',
3333 `:minute-end', `:repeater-type', `:repeater-value',
3334 `:repeater-unit', `:warning-type', `:warning-value',
3335 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3336 Otherwise, return nil.
3338 Assume point is at the beginning of the timestamp."
3357 date-start)
3368 raw-value)
3370 :repeater-type
3376 :repeater-unit
3385 :warning-unit
3388 year-start month-start day-start hour-start minute-start year-end
3389 month-end day-end hour-end minute-end)
3390 ;; Parse date-start.
3398 ;; Compute date-end. It can be provided directly in time-stamp,
3399 ;; or extracted from time range. Otherwise, it defaults to the
3400 ;; same values as date-start.
3410 :raw-value raw-value
3411 :year-start year-start
3412 :month-start month-start
3413 :day-start day-start
3414 :hour-start hour-start
3415 :minute-start minute-start
3416 :year-end year-end
3417 :month-end month-end
3418 :day-end day-end
3419 :hour-end hour-end
3420 :minute-end minute-end
3421 :begin begin
3422 :end end
3424 repeater-props
3425 warning-props))))))
3428 "Interpret TIMESTAMP object as Org syntax.
3429 CONTENTS is nil."
3448 ;; Build an Org timestamp string from TIME. ACTIVEP is
3449 ;; non-nil when time stamp is active. If WITH-TIME-P is
3450 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3451 ;; specify a time range in the timestamp. REPEAT-STRING is
3452 ;; the repeater string, if any.
3456 org-time-stamp-formats)
3457 time)))
3463 nil nil ts)))
3468 " "
3469 s
3471 ;; Return value.
3472 ts)))
3484 build-ts-string
3503 0
3511 "--"
3523 ;;;; Underline
3526 "Parse underline object at point, if any.
3528 When at an underline object, return a list whose car is
3529 `underline' and cdr is a plist with `:begin', `:end',
3530 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3531 Otherwise, return nil.
3533 Assume point is at the first underscore marker."
3545 :end end
3546 :contents-begin contents-begin
3547 :contents-end contents-end
3551 "Interpret UNDERLINE object as Org syntax.
3552 CONTENTS is the contents of the object."
3556 ;;;; Verbatim
3559 "Parse verbatim object at point, if any.
3561 When at a verbatim object, return a list whose car is `verbatim'
3562 and cdr is a plist with `:value', `:begin', `:end' and
3563 `:post-blank' keywords. Otherwise, return nil.
3565 Assume point is at the first equal sign marker."
3576 :begin begin
3577 :end end
3581 "Interpret VERBATIM object as Org syntax.
3582 CONTENTS is nil."
3586 \f
3587 ;;; Parsing Element Starting At Point
3588 ;;
3589 ;; `org-element--current-element' is the core function of this section.
3590 ;; It returns the Lisp representation of the element starting at
3591 ;; point.
3592 ;;
3593 ;; `org-element--current-element' makes use of special modes. They
3594 ;; are activated for fixed element chaining (e.g., `plain-list' >
3595 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3596 ;; `section'). Special modes are: `first-section', `item',
3597 ;; `node-property', `section' and `table-row'.
3601 "Parse the element starting at point.
3603 Return value is a list like (TYPE PROPS) where TYPE is the type
3604 of the element and PROPS a plist of properties associated to the
3605 element.
3607 Possible types are defined in `org-element-all-elements'.
3609 LIMIT bounds the search.
3611 Optional argument GRANULARITY determines the depth of the
3612 recursion. Allowed values are `headline', `greater-element',
3613 `element', `object' or nil. When it is broader than `object' (or
3614 nil), secondary values will not be parsed, since they only
3615 contain objects.
3617 Optional argument SPECIAL, when non-nil, can be either
3618 `first-section', `item', `node-property', `section', and
3619 `table-row'.
3621 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3622 be computed.
3624 This function assumes point is always at the beginning of the
3625 element it has to parse."
3628 ;; Determine if parsing depth allows for secondary strings
3629 ;; parsing. It only applies to elements referenced in
3630 ;; `org-element-secondary-value-alist'.
3633 ;; Item.
3636 ;; Table Row.
3638 ;; Node Property.
3640 ;; Headline.
3643 ;; Sections (must be checked after headline).
3648 limit)))
3649 ;; When not at bol, point is at the beginning of an item or
3650 ;; a footnote definition: next item is always a paragraph.
3652 ;; Planning and Clock.
3657 ;; Inlinetask.
3660 ;; From there, elements can have affiliated keywords.
3663 ;; Jumping over affiliated keywords put point off-limits.
3664 ;; Parse them as regular keywords.
3668 ;; LaTeX Environment.
3672 ;; Drawer and Property Drawer.
3677 ;; Fixed Width
3680 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3681 ;; Keywords.
3690 org-element-block-name-alist)))
3705 ;; Footnote Definition.
3708 ;; Horizontal Rule.
3711 ;; Diary Sexp.
3714 ;; Table.
3716 ;; List.
3719 limit affiliated
3721 ;; Default element: Paragraph.
3725 ;; Most elements can have affiliated keywords. When looking for an
3726 ;; element beginning, we want to move before them, as they belong to
3727 ;; that element, and, in the meantime, collect information they give
3728 ;; into appropriate properties. Hence the following function.
3731 "Collect affiliated keywords from point down to LIMIT.
3733 Return a list whose CAR is the position at the first of them and
3734 CDR a plist of keywords and values and move point to the
3735 beginning of the first line after them.
3737 As a special case, if element doesn't start at the beginning of
3738 the line (e.g., a paragraph starting an item), CAR is current
3739 position of point and CDR is nil."
3743 ;; RESTRICT is the list of objects allowed in parsed
3744 ;; keywords value.
3746 output)
3749 ;; Apply translation to RAW-KWD. From there, KWD is
3750 ;; the official keyword.
3752 org-element-keyword-translation-alist))
3753 raw-kwd))
3754 ;; Find main value for any keyword.
3760 ;; PARSEDP is non-nil when keyword should have its
3761 ;; value parsed.
3763 ;; If KWD is a dual keyword, find its secondary
3764 ;; value. Maybe parse it.
3771 ;; Attribute a property name to KWD.
3773 ;; Now set final shape for VALUE.
3779 ;; Attributes can always appear on multiple lines.
3782 ;; Eventually store the new value in OUTPUT.
3784 ;; Move to next keyword.
3786 ;; If affiliated keywords are orphaned: move back to first one.
3787 ;; They will be parsed as a paragraph.
3789 ;; Return value.
3793 \f
3794 ;;; The Org Parser
3795 ;;
3796 ;; The two major functions here are `org-element-parse-buffer', which
3797 ;; parses Org syntax inside the current buffer, taking into account
3798 ;; region, narrowing, or even visibility if specified, and
3799 ;; `org-element-parse-secondary-string', which parses objects within
3800 ;; a given string.
3801 ;;
3802 ;; The (almost) almighty `org-element-map' allows to apply a function
3803 ;; on elements or objects matching some type, and accumulate the
3804 ;; resulting values. In an export situation, it also skips unneeded
3805 ;; parts of the parse tree.
3808 "Recursively parse the buffer and return structure.
3809 If narrowing is in effect, only parse the visible part of the
3810 buffer.
3812 Optional argument GRANULARITY determines the depth of the
3813 recursion. It can be set to the following symbols:
3815 `headline' Only parse headlines.
3816 `greater-element' Don't recurse into greater elements excepted
3817 headlines and sections. Thus, elements
3818 parsed are the top-level ones.
3819 `element' Parse everything but objects and plain text.
3820 `object' Parse the complete buffer (default).
3822 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3823 elements.
3825 An element or an objects is represented as a list with the
3826 pattern (TYPE PROPERTIES CONTENTS), where :
3828 TYPE is a symbol describing the element or object. See
3829 `org-element-all-elements' and `org-element-all-objects' for an
3830 exhaustive list of such symbols. One can retrieve it with
3831 `org-element-type' function.
3833 PROPERTIES is the list of attributes attached to the element or
3834 object, as a plist. Although most of them are specific to the
3835 element or object type, all types share `:begin', `:end',
3836 `:post-blank' and `:parent' properties, which respectively
3837 refer to buffer position where the element or object starts,
3838 ends, the number of white spaces or blank lines after it, and
3839 the element or object containing it. Properties values can be
3840 obtained by using `org-element-property' function.
3842 CONTENTS is a list of elements, objects or raw strings
3843 contained in the current element or object, when applicable.
3844 One can access them with `org-element-contents' function.
3846 The Org buffer has `org-data' as type and nil as properties.
3847 `org-element-map' function can be used to find specific elements
3848 or objects within the parse tree.
3850 This function assumes that current major mode is `org-mode'."
3856 ;; Start in `first-section' mode so text before the first
3857 ;; headline belongs to a section.
3861 "Recursively parse objects in STRING and return structure.
3863 RESTRICTION is a symbol limiting the object types that will be
3864 looked after.
3866 Optional argument PARENT, when non-nil, is the element or object
3867 containing the secondary string. It is used to set correctly
3868 `:parent' property within the string."
3869 ;; Copy buffer-local variables listed in
3870 ;; `org-element-object-variables' into temporary buffer. This is
3871 ;; required since object parsing is dependent on these variables.
3875 org-element-object-variables))))
3883 secondary))
3884 secondary))))
3888 "Map a function on selected elements or objects.
3890 DATA is a parse tree, an element, an object, a string, or a list
3891 of such constructs. TYPES is a symbol or list of symbols of
3892 elements or objects types (see `org-element-all-elements' and
3893 `org-element-all-objects' for a complete list of types). FUN is
3894 the function called on the matching element or object. It has to
3895 accept one argument: the element or object itself.
3897 When optional argument INFO is non-nil, it should be a plist
3898 holding export options. In that case, parts of the parse tree
3899 not exportable according to that property list will be skipped.
3901 When optional argument FIRST-MATCH is non-nil, stop at the first
3902 match for which FUN doesn't return nil, and return that value.
3904 Optional argument NO-RECURSION is a symbol or a list of symbols
3905 representing elements or objects types. `org-element-map' won't
3906 enter any recursive element or object whose type belongs to that
3907 list. Though, FUN can still be applied on them.
3909 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3910 apply to matching objects within parsed affiliated keywords (see
3911 `org-element-parsed-keywords').
3913 Nil values returned from FUN do not appear in the results.
3916 Examples:
3917 ---------
3919 Assuming TREE is a variable containing an Org buffer parse tree,
3920 the following example will return a flat list of all `src-block'
3921 and `example-block' elements in it:
3923 \(org-element-map tree '(example-block src-block) 'identity)
3925 The following snippet will find the first headline with a level
3928 \(org-element-map tree 'headline
3929 \(lambda (hl)
3930 \(and (= (org-element-property :level hl) 1)
3932 \(org-element-property :begin hl)))
3933 nil t)
3935 The next example will return a flat list of all `plain-list' type
3936 elements in TREE that are not a sub-list themselves:
3938 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3940 Eventually, this example will return a flat list of all `bold'
3941 type objects containing a `latex-snippet' type object, even
3942 looking into captions:
3944 \(org-element-map tree 'bold
3945 \(lambda (b)
3946 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3947 nil nil nil t)"
3948 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3951 ;; Recursion depth is determined by --CATEGORY.
3958 ;; If one object is found, the function
3959 ;; has to recurse into every object.
3962 ;; If one regular element is found, the
3963 ;; function has to recurse, at least,
3964 ;; into every element it encounters.
3967 types)
3968 category)))
3969 ;; Compute properties for affiliated keywords if necessary.
3974 org-element-affiliated-keywords)))
3975 --acc
3976 --walk-tree
3980 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3981 ;; holding contextual information.
3985 ;; Ignored element in an export context.
3987 ;; List of elements or objects.
3989 ;; Unconditionally enter parse trees.
3993 ;; Check if TYPE is matching among TYPES. If so,
3994 ;; apply FUN to --DATA and accumulate return value
3995 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4001 ;; If --DATA has a secondary string that can contain
4002 ;; objects with their type among TYPES, look into it.
4009 ;; If --DATA has any affiliated keywords and
4010 ;; WITH-AFFILIATED is non-nil, look for objects in
4011 ;; them.
4019 ;; Pay attention to the type of value.
4020 ;; Preserve order for multiple keywords.
4036 --affiliated-alist))
4037 ;; Determine if a recursion into --DATA is possible.
4039 ;; --TYPE is explicitly removed from recursion.
4041 ;; --DATA has no contents.
4043 ;; Looking for greater elements but --DATA is simply
4044 ;; an element or an object.
4047 ;; Looking for elements but --DATA is an object.
4050 ;; In any other case, map contents.
4054 ;; Return value in a proper order.
4058 ;; The following functions are internal parts of the parser.
4059 ;;
4060 ;; The first one, `org-element--parse-elements' acts at the element's
4061 ;; level.
4062 ;;
4063 ;; The second one, `org-element--parse-objects' applies on all objects
4064 ;; of a paragraph or a secondary string.
4065 ;;
4066 ;; More precisely, that function looks for every allowed object type
4067 ;; first. Then, it discards failed searches, keeps further matches,
4068 ;; and searches again types matched behind point, for subsequent
4069 ;; calls. Thus, searching for a given type fails only once, and every
4070 ;; object is searched only once at top level (but sometimes more for
4071 ;; nested types).
4075 "Parse elements between BEG and END positions.
4077 SPECIAL prioritize some elements over the others. It can be set
4078 to `first-section', `section' `item' or `table-row'.
4080 When value is `item', STRUCTURE will be used as the current list
4081 structure.
4083 GRANULARITY determines the depth of the recursion. See
4084 `org-element-parse-buffer' for more information.
4086 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4087 elements.
4089 Elements are accumulated into ACC."
4092 ;; Visible only: skip invisible parts at the beginning of the
4093 ;; element.
4096 ;; When parsing only headlines, skip any text before first one.
4099 ;; Main loop start.
4101 ;; Find current element's type and parse it accordingly to
4102 ;; its category.
4104 end granularity special structure))
4108 ;; Visible only: skip invisible parts between siblings.
4111 ;; Fill ELEMENT contents by side-effect.
4113 ;; If element has no contents, don't modify it.
4115 ;; Greater element: parse it between `contents-begin' and
4116 ;; `contents-end'. Make sure GRANULARITY allows the
4117 ;; recursion, or ELEMENT is a headline, in which case going
4118 ;; inside is mandatory, in order to get sub-level headings.
4126 ;; Possibly switch to a special mode.
4134 granularity visible-only element))
4135 ;; ELEMENT has contents. Parse objects inside, if
4136 ;; GRANULARITY allows it.
4142 ;; Return result.
4143 acc))
4149 ;; Sub/superscript.
4151 ;; Bold, code, italic, strike-through, underline and
4152 ;; verbatim.
4155 ;; Plain links.
4157 ;; Objects starting with "[": regular link, footnote
4158 ;; reference, statistics cookie, timestamp (inactive).
4160 ;; Objects starting with "@": export snippets.
4161 "@@"
4162 ;; Objects starting with "{": macro.
4163 "{{{"
4164 ;; Objects starting with "<" : timestamp (active,
4165 ;; diary), target, radio target and angular links.
4167 ;; Objects starting with "$": latex fragment.
4169 ;; Objects starting with "\": line break, entity,
4170 ;; latex fragment.
4172 ;; Objects starting with raw text: inline Babel
4173 ;; source block, inline Babel call.
4176 "Regexp possibly matching the beginning of an object.
4177 This regexp allows false positives. Dedicated parser (e.g.,
4178 `org-export-bold-parser') will take care of further filtering.
4179 Radio links are not matched by this regexp, as they are treated
4183 "Return next object in current buffer or nil.
4184 RESTRICTION is a list of object types, as symbols, that should be
4185 looked after. This function assumes that the buffer is narrowed
4186 to an appropriate container (e.g., a paragraph)."
4194 found)
4257 ;; This is probably a plain link.
4263 ;; Radio link.
4268 "Parse objects between BEG and END and return recursive structure.
4270 Objects are accumulated in ACC.
4272 RESTRICTION is a list of object successors which are allowed in
4273 the current object."
4281 ;; 1. Text before any object. Untabify it.
4286 acc
4290 ;; 2. Object...
4293 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4294 ;; a recursive type.
4302 ;; 3. Text after last object. Untabify it.
4306 acc
4310 ;; Result.
4311 acc)))
4314 \f
4315 ;;; Towards A Bijective Process
4316 ;;
4317 ;; The parse tree obtained with `org-element-parse-buffer' is really
4318 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4319 ;; interpreted and expanded into a string with canonical Org syntax.
4320 ;; Hence `org-element-interpret-data'.
4321 ;;
4322 ;; The function relies internally on
4323 ;; `org-element--interpret-affiliated-keywords'.
4325 ;;;###autoload
4327 "Interpret DATA as Org syntax.
4329 DATA is a parse tree, an element, an object or a secondary string
4330 to interpret.
4332 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4333 new types that should be treated as objects. An unknown type not
4334 belonging to this list is seen as a pseudo-element instead. Both
4335 pseudo-objects and pseudo-elements are transparent entities, i.e.
4336 only their contents are interpreted.
4338 Return Org syntax as a string."
4342 "Interpret DATA as Org syntax.
4344 DATA is a parse tree, an element, an object or a secondary string
4345 to interpret. PARENT is used for recursive calls. It contains
4346 the element or object containing data, or nil. PSEUDO-OBJECTS
4347 are list of symbols defining new element or object types.
4348 Unknown types that don't belong to this list are treated as
4349 pseudo-elements instead.
4351 Return Org syntax as a string."
4353 ;; Find interpreter for current object or element. If it
4354 ;; doesn't exist (e.g. this is a pseudo object or element),
4355 ;; return contents, if any.
4361 ;; Secondary string.
4367 ;; Full Org document.
4373 ;; Plain text: return it.
4375 ;; Element or object without contents.
4377 ;; Element or object with contents.
4380 ;; Recursively interpret contents.
4386 data
4387 ;; Fix indentation of elements containing
4388 ;; objects. We ignore `table-row' elements
4389 ;; as they are one line long anyway.
4391 data
4392 ;; When normalizing first paragraph of an
4393 ;; item or a footnote-definition, ignore
4394 ;; first line's indentation.
4401 ;; Build white spaces. If no `:post-blank' property is
4402 ;; specified, assume its value is 0.
4413 "Return ELEMENT's affiliated keywords as Org syntax.
4414 If there is no affiliated keyword, return the empty string."
4424 ": "
4427 value)
4435 ;; All attribute keywords can have multiple lines.
4441 ;; List all ELEMENT's properties matching an attribute line or an
4442 ;; affiliated keyword, but ignore translated keywords since they
4443 ;; cannot belong to the property list.
4450 org-element-keyword-translation-alist)))))
4451 collect prop)
4454 ;; Because interpretation of the parse tree must return the same
4455 ;; number of blank lines between elements and the same number of white
4456 ;; space after objects, some special care must be given to white
4457 ;; spaces.
4458 ;;
4459 ;; The first function, `org-element-normalize-string', ensures any
4460 ;; string different from the empty string will end with a single
4461 ;; newline character.
4462 ;;
4463 ;; The second function, `org-element-normalize-contents', removes
4464 ;; global indentation from the contents of the current element.
4467 "Ensure string S ends with a single newline character.
4469 If S isn't a string return it unchanged. If S is the empty
4470 string, return it. Otherwise, return a new string with a single
4471 newline character at its end."
4479 "Normalize plain text in ELEMENT's contents.
4481 ELEMENT must only contain plain text and objects.
4483 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4484 indentation to compute maximal common indentation.
4486 Return the normalized element that is element with global
4487 indentation removed from its contents. The function assumes that
4488 indentation is not done with TAB characters."
4490 find-min-ind ; For byte-compiler.
4493 ;; Return minimal common indentation within BLOB. This is
4494 ;; done by walking recursively BLOB and updating MIN-IND
4495 ;; along the way. FIRST-FLAG is non-nil when the first
4496 ;; string hasn't been seen yet. It is required as this
4497 ;; string is the only one whose indentation doesn't happen
4498 ;; after a newline character.
4505 ;; An indentation of zero means no string will be
4506 ;; modified. Quit the process.
4515 ;; Find minimal indentation in ELEMENT.
4518 ;; Build ELEMENT back, replacing each string with the same
4519 ;; string minus common indentation.
4524 ;; Return BLOB with all its strings indentation
4525 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4526 ;; is non-nil when the first string hasn't been seen
4527 ;; yet.
4542 org-element-recursive-objects)
4546 blob))))
4550 \f
4551 ;;; Cache
4552 ;;
4553 ;; Implement a caching mechanism for `org-element-at-point' and
4554 ;; `org-element-context', which see.
4555 ;;
4556 ;; A single public function is provided: `org-element-cache-reset'.
4557 ;;
4558 ;; Cache is enabled by default, but can be disabled globally with
4559 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4560 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4561 ;; can be tweaked to control caching behaviour.
4562 ;;
4563 ;; Internally, parsed elements are stored in an AVL tree,
4564 ;; `org-element--cache'. This tree is updated lazily: whenever
4565 ;; a change happens to the buffer, a synchronization request is
4566 ;; registered in `org-element--cache-sync-requests' (see
4567 ;; `org-element--cache-submit-request'). During idle time, requests
4568 ;; are processed by `org-element--cache-sync'. Synchronization also
4569 ;; happens when an element is required from the cache. In this case,
4570 ;; the process stops as soon as the needed element is up-to-date.
4571 ;;
4572 ;; A synchronization request can only apply on a synchronized part of
4573 ;; the cache. Therefore, the cache is updated at least to the
4574 ;; location where the new request applies. Thus, requests are ordered
4575 ;; from left to right and all elements starting before the first
4576 ;; request are correct. This property is used by functions like
4577 ;; `org-element--cache-find' to retrieve elements in the part of the
4578 ;; cache that can be trusted.
4579 ;;
4580 ;; A request applies to every element, starting from its original
4581 ;; location (or key, see below). When a request is processed, it
4582 ;; moves forward and may collide the next one. In this case, both
4583 ;; requests are merged into a new one that starts from that element.
4584 ;; As a consequence, the whole synchronization complexity does not
4585 ;; depend on the number of pending requests, but on the number of
4586 ;; elements the very first request will be applied on.
4587 ;;
4588 ;; Elements cannot be accessed through their beginning position, which
4589 ;; may or may not be up-to-date. Instead, each element in the tree is
4590 ;; associated to a key, obtained with `org-element--cache-key'. This
4591 ;; mechanism is robust enough to preserve total order among elements
4592 ;; even when the tree is only partially synchronized.
4593 ;;
4594 ;; Objects contained in an element are stored in a hash table,
4595 ;; `org-element--cache-objects'.
4599 "Non nil when Org parser should cache its results.
4606 "Maximum duration, as a time value, for a cache synchronization.
4607 If the synchronization is not over after this delay, the process
4608 pauses and resumes after `org-element-cache-sync-break'
4612 "Duration, as a time value, of the pause between synchronizations.
4616 ;;;; Data Structure
4619 "AVL tree used to cache elements.
4620 Each node of the tree contains an element. Comparison is done
4621 with `org-element--cache-compare'. This cache is used in
4625 "Hash table used as to cache objects.
4626 Key is an element, as returned by `org-element-at-point', and
4627 value is an alist where each association is:
4629 \(PARENT COMPLETEP . OBJECTS)
4631 where PARENT is an element or object, COMPLETEP is a boolean,
4632 non-nil when all direct children of parent are already cached and
4633 OBJECTS is a list of such children, as objects, from farthest to
4634 closest.
4637 contained within a paragraph
4641 If the paragraph is completely parsed, OBJECTS-DATA will be
4643 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4644 \(BOLD-OBJECT t ENTITY-OBJECT))
4646 whereas in a partially parsed paragraph, it could be
4648 \((PARAGRAPH nil ENTITY-OBJECT))
4653 "List of pending synchronization requests.
4655 A request is a vector with the following pattern:
4657 \[NEXT END OFFSET PARENT PHASE]
4659 Processing a synchronization request consists in three phases:
4661 0. Delete modified elements,
4662 1. Fill missing area in cache,
4663 2. Shift positions and re-parent elements after the changes.
4665 During phase 0, NEXT is the key of the first element to be
4666 removed and END is buffer position delimiting the modifications.
4667 Every element starting between these are removed. PARENT is an
4668 element to be removed. Every element contained in it will also
4669 be removed.
4671 During phase 1, NEXT is the key of the next known element in
4672 cache. Parse buffer between that element and the one before it
4673 in order to determine the parent of the next element. Set PARENT
4674 to the element containing NEXT.
4676 During phase 2, NEXT is the key of the next element to shift in
4677 the parse tree. All elements starting from this one have their
4678 properties relatives to buffer positions shifted by integer
4679 OFFSET and, if they belong to element PARENT, are adopted by it.
4687 "Hash table used to store keys during synchronization.
4691 "Return a unique key for ELEMENT in cache tree.
4693 Keys are used to keep a total order among elements in the cache.
4694 Comparison is done with `org-element--cache-key-less-p'.
4696 When no synchronization is taking place, a key is simply the
4697 beginning position of the element, or that position plus one in
4698 the case of an first item (respectively row) in
4699 a list (respectively a table).
4701 During a synchronization, the key is the one the element had when
4702 the cache was synchronized for the last time. Elements added to
4703 cache during the synchronization get a new key generated with
4704 `org-element--cache-generate-key'.
4706 Such keys are stored in `org-element--cache-sync-keys'. The hash
4707 table is cleared once the synchronization is complete."
4710 ;; Increase beginning position of items (respectively
4711 ;; table rows) by one, so the first item can get
4712 ;; a different key from its parent list (respectively
4713 ;; table).
4716 begin)))
4719 key))))
4722 "Default value for a new key level.
4726 "Generate a key between LOWER and UPPER.
4728 LOWER and UPPER are integers or lists, possibly empty.
4730 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4731 a unique key, as an integer or a list of integers, according to
4732 the following rules:
4734 - LOWER and UPPER are compared level-wise until values differ.
4736 - If, at a given level, LOWER and UPPER differ from more than
4737 2, the new key shares all the levels above with LOWER and
4738 gets a new level. Its value is the mean between LOWER and
4739 UPPER.
4741 \(1 2) + (1 4) --> (1 3)
4743 - If LOWER has no value to compare with, it is assumed that its
4744 value is 0:
4746 \(1 1) + (1 1 2) --> (1 1 1)
4748 Likewise, if UPPER is short of levels, the current value is
4749 `most-positive-fixnum'.
4751 - If they differ from only one, the new key inherits from
4752 current LOWER lever and has a new level at the value
4753 `org-element--cache-default-key'.
4755 \(1 2) + (1 3) --> (1 2 org-element--cache-default-key)
4757 - If the key is only one level long, it is returned as an
4758 integer.
4760 \(1 2) + (3 2) --> 2"
4764 key)
4782 org-element--cache-default-key))
4783 org-element--cache-default-key)
4784 key)
4790 key)
4797 ;; (n) is equivalent to (n 0 0 0 0 ...) so we want to avoid
4798 ;; ending on a sequence of 0.
4803 key)))
4811 org-element--cache-default-key))
4812 org-element--cache-default-key)
4813 key))))
4814 ;; Ensure we don't return a list with a single element.
4818 "Non-nil if key A is less than key B.
4819 A and B are either integers or lists of integers, as returned by
4820 `org-element--cache-key'."
4828 ;; If A is empty, either keys are equal (B is also empty) or
4829 ;; B is less than A (B is longer). Therefore return nil.
4830 ;;
4831 ;; If A is not empty, B is necessarily empty and A is less
4832 ;; than B (A is longer). Therefore, return a non-nil value.
4833 a))))
4836 "Non-nil when element A is located before element B."
4841 "Return root value in cache.
4842 This function assumes `org-element--cache' is a valid AVL tree."
4846 ;;;; Tools
4849 "Non-nil when cache is active in current buffer."
4854 "Find element in cache starting at POS or before.
4856 POS refers to a buffer position.
4858 When optional argument SIDE is non-nil, the function checks for
4859 elements starting at or past POS instead. If SIDE is `both', the
4860 function returns a cons cell where car is the first element
4861 starting at or before POS and cdr the first element starting
4862 after POS.
4864 The function can only find elements in the synchronized part of
4865 the cache."
4869 lower upper)
4884 ;; We found an element in cache starting at POS. If `side'
4885 ;; is `both' we also want the next one in order to generate
4886 ;; a key in-between.
4887 ;;
4888 ;; If the element is the first row or item in a table or
4889 ;; a plain list, we always return the table or the plain
4890 ;; list.
4891 ;;
4892 ;; In any other case, we return the element found.
4901 lower parent
4902 upper parent)))))
4905 lower element
4906 upper element)))))
4913 "Store ELEMENT in current buffer's cache, if allowed.
4914 When optional argument DATA is non-nil, assume is it object data
4915 relative to ELEMENT and store it in the objects cache."
4919 ;; During synchronization, first build an appropriate key
4920 ;; for the new element so `avl-tree-enter' can insert it at
4921 ;; the right spot in the cache.
4930 org-element--cache-sync-keys)))
4932 ;; Headlines are not stored in cache, so objects in titles are
4933 ;; not stored either.
4938 "Remove ELEMENT from cache.
4939 Assume ELEMENT belongs to cache and that a cache is active."
4944 ;;;; Synchronization
4947 "Set idle timer for cache synchronization in BUFFER."
4954 org-element-cache-sync-idle-time))
4955 nil
4956 #'org-element--cache-sync
4957 buffer)))
4960 "Non-nil when synchronization process should be interrupted.
4961 TIME-LIMIT is a time value or nil."
4967 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4969 Properties containing buffer positions are `:begin', `:end',
4970 `:contents-begin', `:contents-end' and `:structure'. When
4971 optional argument PROPS is a list of keywords, only shift
4972 properties provided in that list.
4974 Properties are modified by side-effect."
4976 ;; Shift `:structure' property for the first plain list only: it
4977 ;; is the only one that really matters and it prevents from
4978 ;; shifting it more than once.
4992 "Synchronize cache with recent modification in BUFFER.
4993 When optional argument THRESHOLD is non-nil, do the
4994 synchronization for all elements starting before or at threshold,
4995 then exit. Otherwise, synchronize cache for as long as
4996 `org-element-cache-sync-duration' or until Emacs leaves idle
4997 state."
5008 request
5010 threshold
5013 org-element-cache-sync-duration)))
5015 ;; Request processed. Merge current and next offsets and
5016 ;; transfer phase number and ending position.
5023 ;; If more requests are awaiting, set idle timer accordingly.
5024 ;; Otherwise, reset keys.
5030 "Process synchronization REQUEST for all entries before NEXT.
5032 REQUEST is a vector, built by `org-element--cache-submit-request'.
5034 NEXT is a cache key, as returned by `org-element--cache-key'.
5036 When non-nil, THRESHOLD is a buffer position. Synchronization
5037 stops as soon as a shifted element begins after it.
5039 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5040 after this time or when Emacs exits idle state.
5042 Return nil if the process stops before completing the request,
5043 t otherwise."
5046 ;; Phase 1.
5047 ;;
5048 ;; Delete all elements starting after BEG, but not after buffer
5049 ;; position END or past element with key NEXT.
5050 ;;
5051 ;; As an exception, also delete elements starting after
5052 ;; modifications but included in an element altered by
5053 ;; modifications (orphans).
5054 ;;
5055 ;; At each iteration, we start again at tree root since
5056 ;; a deletion modifies structure of the balanced tree.
5065 ;; Find first element in cache with key BEG or after it.
5066 ;; We don't use `org-element--cache-find' because it
5067 ;; couldn't reach orphaned elements past NEXT. Moreover,
5068 ;; BEG is a key, not a buffer position.
5078 data-key key
5081 data-key key
5082 node nil)))))
5086 ;; Remove orphaned elements.
5092 up))
5096 next)))
5106 ;; Phase 2.
5107 ;;
5108 ;; Phase 1 left a hole in the parse tree. Some elements after
5109 ;; it could have parents within. For example, in the following
5110 ;; buffer:
5111 ;;
5112 ;;
5113 ;; - item
5114 ;;
5115 ;;
5116 ;; Paragraph1
5117 ;;
5118 ;; Paragraph2
5119 ;;
5120 ;;
5121 ;; if we remove a blank line between "item" and "Paragraph1",
5122 ;; everything down to "Paragraph2" is removed from cache. But
5123 ;; the paragraph now belongs to the list, and its `:parent'
5124 ;; property no longer is accurate.
5125 ;;
5126 ;; Therefore we need to parse again elements in the hole, or at
5127 ;; least in its last section, so that we can re-parent
5128 ;; subsequent elements, during phase 3.
5129 ;;
5130 ;; Note that we only need to get the parent from the first
5131 ;; element in cache after the hole.
5132 ;;
5133 ;; Also, this part can be delayed if we don't need to retrieve
5134 ;; an element after the hole.
5136 ;; Next element will start at its beginning position plus
5137 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5138 ;; contains the real beginning position of the first element
5139 ;; to shift and re-parent.
5148 ;; Phase 3.
5149 ;;
5150 ;; Shift all elements starting from key START, but before NEXT, by
5151 ;; OFFSET, and re-parent them when appropriate.
5152 ;;
5153 ;; Elements are modified by side-effect so the tree structure
5154 ;; remains intact.
5155 ;;
5156 ;; Once THRESHOLD, if any, is reached, or once there is an input
5157 ;; pending, exit. Before leaving, the current synchronization
5158 ;; request is updated.
5165 exit-flag)
5166 ;; No re-parenting nor shifting planned: request is over.
5176 ;; We reached NEXT. Request is complete.
5178 ;; Handle interruption request. Update current request.
5183 ;; Shift element.
5186 ;; Shift associated objects data, if any.
5191 ;; Re-parent it.
5197 ;; Cache is up-to-date past THRESHOLD. Request
5198 ;; interruption.
5203 ;; We reached end of tree: synchronization complete.
5204 t)))
5207 "Parse elements in current section, down to POS.
5209 Start parsing from the closest between the last known element in
5210 cache or headline above. Return the smallest element containing
5211 POS.
5213 When optional argument SYNCP is non-nil, return the parent of the
5214 element containing POS instead. In that case, it is also
5215 possible to provide TIME-LIMIT, which is a time value specifying
5216 when the parsing should stop. The function returns `interrupted'
5217 if the process stopped before finding the expected result."
5224 element next)
5226 ;; Nothing in cache before point: start parsing from first
5227 ;; element following headline above, or first element in
5228 ;; buffer.
5234 ;; Cache returned exact match: return it.
5237 ;; There's a headline between cached value and POS: cached
5238 ;; value is invalid. Start parsing from first element
5239 ;; following the headline.
5245 ;; Check if CACHED or any of its ancestors contain point.
5246 ;;
5247 ;; If there is such an element, we inspect it in order to know
5248 ;; if we return it or if we need to parse its contents.
5249 ;; Otherwise, we just start parsing from current location,
5250 ;; which is right after the top-most element containing
5251 ;; CACHED.
5252 ;;
5253 ;; As a special case, if POS is at the end of the buffer, we
5254 ;; want to return the innermost element ending there.
5255 ;;
5256 ;; Also, if we find an ancestor and discover that we need to
5257 ;; parse its contents, make sure we don't start from
5258 ;; `:contents-begin', as we would otherwise go past CACHED
5259 ;; again. Instead, in that situation, we will resume parsing
5260 ;; from NEXT, which is located after CACHED or its higher
5261 ;; ancestor not containing point.
5273 ;; Parse successively each element until we reach POS.
5279 special-flag)
5287 end 'element special-flag
5294 ;; Skip any element ending before point. Also skip
5295 ;; element ending at point (unless it is also the end of
5296 ;; buffer) since we're sure that another element begins
5297 ;; after it.
5300 ;; A non-greater element contains point: return it.
5303 ;; Otherwise, we have to decide if ELEMENT really
5304 ;; contains POS. In that case we start parsing from
5305 ;; contents' beginning.
5306 ;;
5307 ;; If POS is at contents' beginning but it is also at
5308 ;; the beginning of the first item in a list or a table.
5309 ;; In that case, we need to create an anchor for that
5310 ;; list or table, so return it.
5311 ;;
5312 ;; Also, if POS is at the end of the buffer, no element
5313 ;; can start after it, but more than one may end there.
5314 ;; Arbitrarily, we choose to return the innermost of
5315 ;; such elements.
5331 parent element
5332 end cend))))
5333 ;; Otherwise, return ELEMENT as it is the smallest
5334 ;; element containing POS.
5339 ;;;; Staging Buffer Changes
5347 "Regexp matching an element opening line.
5348 When such a line is modified, modifications may propagate after
5349 modified area. In that situation, every element between that
5358 "Regexp matching an element closing line.
5359 When such a line is modified, modifications may propagate before
5360 modified area. In that situation, every element between that
5364 "Non-nil when a sensitive line is about to be changed.
5368 "Request extension of area going to be modified if needed.
5369 BEG and END are the beginning and end of the range of changed
5370 text. See `before-change-functions' for more information."
5372 ;; Make sure buffer positions in cache are correct until END.
5381 ;; A sensitive line is a headline or a block (or drawer,
5382 ;; or latex-environment) boundary. Inserting one can
5383 ;; modify buffer drastically both above and below that
5384 ;; line, possibly making cache invalid. Therefore, we
5385 ;; need to pay attention to changes happening to them.
5389 org-element--cache-opening-line)))
5401 "Update buffer modifications for current buffer.
5402 BEG and END are the beginning and end of the range of changed
5403 text, and the length in bytes of the pre-change text replaced by
5404 that range. See `after-change-functions' for more information."
5414 ;; Determine if modified area needs to be extended,
5415 ;; according to both previous and current state. We make
5416 ;; a special case for headline editing: if a headline is
5417 ;; modified but not removed, do not extend.
5422 org-element--cache-opening-line))
5434 ;; Effectively extend modified area.
5441 ;; Store synchronization request.
5444 ;; Activate a timer to process the request during idle time.
5448 "Submit a new cache synchronization request for current buffer.
5449 BEG and END are buffer positions delimiting the minimal area
5450 where cache data should be removed. OFFSET is the size of the
5451 change, as an integer."
5453 ;; Find the position of the first element in cache to remove.
5454 ;;
5455 ;; Partially modified elements will be removed during request
5456 ;; processing. As an exception, greater elements around the
5457 ;; changes that are robust to contents modifications are
5458 ;; preserved.
5459 ;;
5460 ;; We look just before BEG because an element ending at BEG
5461 ;; needs to be removed too.
5470 drawer dynamic-block inlinetask
5471 property-drawer quote-block special-block))
5474 ;; UP is a greater element that is wrapped around
5475 ;; the changes. We only need to extend its
5476 ;; ending boundaries and those of all its
5477 ;; parents.
5483 ;; We're at top level element containing ELEMENT: if
5484 ;; it's altered by buffer modifications, it is first
5485 ;; element in cache to be removed. Otherwise, that
5486 ;; first element is the following one.
5489 ;; Changes happened before the first known element. Shift the
5490 ;; rest of the cache.
5493 org-element--cache-sync-requests))
5494 ;; There is at least an element to remove. Find position past
5495 ;; every element containing END.
5506 org-element--cache-sync-requests))
5507 ;; No element to remove. No need to re-parent either. Simply
5508 ;; shift additional elements, if any, by OFFSET.
5513 ;;;; Public Functions
5515 ;;;###autoload
5517 "Reset cache in current buffer.
5518 When optional argument ALL is non-nil, reset cache in all Org
5519 buffers."
5537 ;;;###autoload
5539 "Refresh cache at position POS."
5546 \f
5547 ;;; The Toolbox
5548 ;;
5549 ;; The first move is to implement a way to obtain the smallest element
5550 ;; containing point. This is the job of `org-element-at-point'. It
5551 ;; basically jumps back to the beginning of section containing point
5552 ;; and proceed, one element after the other, with
5553 ;; `org-element--current-element' until the container is found. Note:
5554 ;; When using `org-element-at-point', secondary values are never
5555 ;; parsed since the function focuses on elements, not on objects.
5556 ;;
5557 ;; At a deeper level, `org-element-context' lists all elements and
5558 ;; objects containing point.
5559 ;;
5560 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5561 ;; internally by navigation and manipulation tools.
5564 ;;;###autoload
5566 "Determine closest element around point.
5568 Return value is a list like (TYPE PROPS) where TYPE is the type
5569 of the element and PROPS a plist of properties associated to the
5570 element.
5572 Possible types are defined in `org-element-all-elements'.
5573 Properties depend on element or object type, but always include
5574 `:begin', `:end', `:parent' and `:post-blank' properties.
5576 As a special case, if point is at the very beginning of the first
5577 item in a list or sub-list, returned element will be that list
5578 instead of the item. Likewise, if point is at the beginning of
5579 the first row of a table, returned element will be the table
5580 instead of the first row.
5582 When point is at the end of the buffer, return the innermost
5583 element ending there."
5589 ;; Within blank lines at the beginning of buffer, return nil.
5591 ;; Within blank lines right after a headline, return that
5592 ;; headline.
5596 ;; Otherwise parse until we find element containing ORIGIN.
5603 ;;;###autoload
5605 "Return smallest element or object around point.
5607 Return value is a list like (TYPE PROPS) where TYPE is the type
5608 of the element or object and PROPS a plist of properties
5609 associated to it.
5611 Possible types are defined in `org-element-all-elements' and
5612 `org-element-all-objects'. Properties depend on element or
5613 object type, but always include `:begin', `:end', `:parent' and
5614 `:post-blank'.
5616 As a special case, if point is right after an object and not at
5617 the beginning of any other object, return that object.
5619 Optional argument ELEMENT, when non-nil, is the closest element
5620 containing point, as returned by `org-element-at-point'.
5621 Providing it allows for quicker computation."
5627 ;; If point is inside an element containing objects or
5628 ;; a secondary string, narrow buffer to the container and
5629 ;; proceed with parsing. Otherwise, return ELEMENT.
5631 ;; At a parsed affiliated keyword, check if we're inside main
5632 ;; or dual value.
5639 org-element-parsed-keywords))
5648 ;; Also change type to retrieve correct restrictions.
5650 ;; At an item, objects can only be located within tag, if any.
5660 ;; At an headline or inlinetask, objects are in title.
5667 ;; At a paragraph, a table-row or a verse block, objects are
5668 ;; located within their contents.
5672 ;; CBEG is nil for table rules.
5677 ;; At a parsed keyword, objects are located within value.
5680 org-element-document-properties))
5687 ;; At a planning line, if point is at a timestamp, return it,
5688 ;; otherwise, return element.
5696 ;; All other locations cannot contain objects: bail out.
5706 next object-data last)
5710 ;; When entering PARENT for the first time, get list
5711 ;; of objects within known so far. Store it in
5712 ;; OBJECT-DATA.
5717 ;; Find NEXT object for analysis.
5719 ;; If NEXT is non-nil, we already exhausted the
5720 ;; cache so we can parse buffer to find the object
5721 ;; after it.
5723 ;; Otherwise, check if cache can help us.
5734 ;; Cache contains the information needed.
5737 pos)
5739 pos)
5745 ;; If we have a new object to analyze, store it in
5746 ;; cache. Otherwise record that there is nothing
5747 ;; more to parse in this element at this depth.
5752 ;; Process NEXT, if any, in order to know if we need
5753 ;; to skip it, return it or move into it.
5760 ;; Skip objects ending before point. Also skip
5761 ;; objects ending at point unless it is also the
5762 ;; end of buffer, since we want to return the
5763 ;; innermost object.
5766 ;; For convenience, when object ends at POS,
5767 ;; without any space, store it in LAST, as we
5768 ;; will return it if no object starts here.
5772 ;; If POS is within a container object, move
5773 ;; into that object.
5777 ;; At contents' end, if there is no
5778 ;; space before point, also move into
5779 ;; object, for consistency with
5780 ;; convenience feature above.
5789 next nil
5790 object-data nil))
5791 ;; Otherwise, return NEXT.
5793 ;; Store results in cache, if applicable.
5797 "Non-nil when elements ELEM-A and ELEM-B are nested."
5806 "Swap elements ELEM-A and ELEM-B.
5807 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5808 end of ELEM-A."
5810 ;; There are two special cases when an element doesn't start at bol:
5811 ;; the first paragraph in an item or in a footnote definition.
5813 ;; Only a paragraph without any affiliated keyword can be moved at
5814 ;; ELEM-A position in such a situation. Note that the case of
5815 ;; a footnote definition is impossible: it cannot contain two
5816 ;; paragraphs in a row because it cannot contain a blank line.
5822 ;; In a special situation, ELEM-A will have no indentation. We'll
5823 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5837 ;; Store overlays responsible for visibility status. We
5838 ;; also need to store their boundaries as they will be
5839 ;; removed from buffer.
5846 ;; Get contents.
5854 ;; Restore ex ELEM-A overlays.
5863 ;; Restore ex ELEM-B overlays.
5871 "Remove maximum common indentation in string S and return it.
5872 When optional argument N is a positive integer, remove exactly
5873 that much characters from indentation, if possible, or return
5874 S as-is otherwise. Unlike to `org-remove-indentation', this
5875 function doesn't call `untabify' on S."
5880 ;; Find maximum common indentation, if not specified.
5888 min-ind)))
5890 ;; Remove exactly N indentation, but give up if not possible.
5903 ;; Local variables:
5904 ;; generated-autoload-file: "org-loaddefs.el"
5905 ;; End:
5907 ;;; org-element.el ends here