| blob | 7ffa7fca468b87a9ee785539d0cdd8bc00057b60 |
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 When RAW-SECONDARY-P is non-nil, headline's title will not be
793 parsed as a secondary string, but as a plain string instead.
795 Assume point is at beginning of the headline."
808 raw-value)))
812 ;; Upcase property names. It avoids confusion between
813 ;; properties obtained through property drawer and default
814 ;; properties from the parser (e.g. `:end' and :END:)
824 plist))
826 ;; Read time properties on the line below the headline.
832 org-keyword-time-not-clock-regexp end t)
842 plist))))
854 ;; Clean RAW-VALUE from any comment string.
860 ""
861 raw-value))))
862 ;; Clean TAGS from archive tag, if any.
868 :begin begin
869 :end end
870 :pre-blank
873 :contents-begin contents-begin
874 :contents-end contents-end
875 :level level
877 :tags tags
878 :todo-keyword todo
879 :todo-type todo-type
885 end)
886 :footnote-section-p footnote-section-p
887 :archivedp archivedp
889 time-props
890 standard-props))))
894 headline :alt-title
899 headline :title
905 "Interpret HEADLINE element as Org syntax.
906 CONTENTS is the contents of the element."
931 ;; Align tags.
939 ? )
940 tags))
944 tags))))
946 contents)))
949 ;;;; Inlinetask
952 "Parse an inline task.
954 Return a list whose CAR is `inlinetask' and CDR is a plist
955 containing `:title', `:begin', `:end', `:contents-begin' and
956 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
957 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
958 `:closed' and `:post-blank' keywords.
960 The plist also contains any property set in the property drawer,
961 with its name in upper cases and colons added at the
962 beginning (e.g., `:CUSTOM_ID').
964 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
965 title will not be parsed as a secondary string, but as a plain
966 string instead.
968 Assume point is at beginning of the inline task."
978 ;; Upcase property names. It avoids confusion between
979 ;; properties obtained through property drawer and default
980 ;; properties from the parser (e.g. `:end' and :END:)
990 plist))
992 ;; Read time properties on the line below the inlinetask
993 ;; opening string.
999 org-keyword-time-not-clock-regexp end t)
1009 plist))))
1028 :begin begin
1029 :end end
1030 :contents-begin contents-begin
1031 :contents-end contents-end
1034 :tags tags
1035 :todo-keyword todo
1036 :todo-type todo-type
1038 time-props
1039 standard-props))))
1041 inlinetask :title
1044 raw-value
1046 inlinetask))))))
1049 "Interpret INLINETASK element as Org syntax.
1050 CONTENTS is the contents of inlinetask."
1065 ;; Align tags.
1073 ? )
1074 tags))
1078 tags))))
1079 ;; Prefer degenerate inlinetasks when there are no
1080 ;; contents.
1083 contents
1087 ;;;; Item
1090 "Parse an item.
1092 STRUCT is the structure of the plain list.
1094 Return a list whose CAR is `item' and CDR is a plist containing
1095 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1096 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1097 keywords.
1099 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1100 any, will not be parsed as a secondary string, but as a plain
1101 string instead.
1103 Assume point is at the beginning of the item."
1127 ;; Ignore tags in un-ordered lists: they are just
1128 ;; a part of item's body.
1134 ;; If first line isn't empty, contents really start
1135 ;; at the text after item's meta-data.
1144 :begin begin
1145 :end end
1146 ;; CONTENTS-BEGIN and CONTENTS-END may be
1147 ;; mixed up in the case of an empty item
1148 ;; separated from the next by a blank line.
1149 ;; Thus ensure the former is always the
1150 ;; smallest.
1153 :checkbox checkbox
1154 :counter counter
1155 :structure struct
1158 item :tag
1166 "Interpret ITEM element as Org syntax.
1167 CONTENTS is the contents of the element."
1177 ;; Compute indentation.
1182 ;; Indent contents.
1184 bullet
1198 ;;;; Plain List
1201 ;; Return structure of list at point. Internal function. See
1202 ;; `org-list-struct' for details.
1207 items struct)
1212 ;; At limit: end all items.
1221 ;; At list end: end all items.
1226 ;; At a new item: end previous sibling.
1238 ind
1239 bullet
1242 ;; Description tag.
1246 ;; Ending position, unknown so far.
1247 nil)))
1248 items))
1250 ;; Skip empty lines.
1252 ;; Skip inline tasks and blank lines along the way.
1259 ;; At some text line. Check if it ends any previous item.
1271 ;; Skip blocks (any type) and drawers contents.
1276 limit t)))
1282 "Parse a plain list.
1284 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1285 the buffer position at the beginning of the first affiliated
1286 keyword and CDR is a plist of affiliated keywords along with
1287 their value. STRUCTURE is the structure of the plain list being
1288 parsed.
1290 Return a list whose CAR is `plain-list' and CDR is a plist
1291 containing `:type', `:begin', `:end', `:contents-begin' and
1292 `:contents-end', `:structure', `:post-blank' and
1293 `:post-affiliated' keywords.
1295 Assume point is at the beginning of the list."
1309 pos))
1313 ;; Return value.
1317 :begin begin
1318 :end end
1319 :contents-begin contents-begin
1320 :contents-end contents-end
1321 :structure struct
1327 "Interpret PLAIN-LIST element as Org syntax.
1328 CONTENTS is the contents of the element."
1336 ;;;; Property Drawer
1339 "Parse a property drawer.
1341 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1342 the buffer position at the beginning of the first affiliated
1343 keyword and CDR is a plist of affiliated keywords along with
1344 their value.
1346 Return a list whose CAR is `property-drawer' and CDR is a plist
1347 containing `:begin', `:end', `:contents-begin', `:contents-end',
1348 `:post-blank' and `:post-affiliated' keywords.
1350 Assume point is at the beginning of the property drawer."
1355 ;; Incomplete drawer: parse it as a paragraph.
1373 :end end
1374 :contents-begin contents-begin
1375 :contents-end contents-end
1381 "Interpret PROPERTY-DRAWER element as Org syntax.
1382 CONTENTS is the properties within the drawer."
1386 ;;;; Quote Block
1389 "Parse a quote block.
1391 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1392 the buffer position at the beginning of the first affiliated
1393 keyword and CDR is a plist of affiliated keywords along with
1394 their value.
1396 Return a list whose CAR is `quote-block' and CDR is a plist
1397 containing `:begin', `:end', `:contents-begin', `:contents-end',
1398 `:post-blank' and `:post-affiliated' keywords.
1400 Assume point is at the beginning of the block."
1404 ;; Incomplete block: parse it as a paragraph.
1410 ;; Empty blocks have no contents.
1423 :end end
1424 :contents-begin contents-begin
1425 :contents-end contents-end
1431 "Interpret QUOTE-BLOCK element as Org syntax.
1432 CONTENTS is the contents of the element."
1436 ;;;; Section
1439 "Parse a section.
1441 LIMIT bounds the search.
1443 Return a list whose CAR is `section' and CDR is a plist
1444 containing `:begin', `:end', `:contents-begin', `contents-end'
1445 and `:post-blank' keywords."
1447 ;; Beginning of section is the beginning of the first non-blank
1448 ;; line after previous headline.
1457 :end end
1458 :contents-begin begin
1459 :contents-end pos-before-blank
1463 "Interpret SECTION element as Org syntax.
1464 CONTENTS is the contents of the element."
1465 contents)
1468 ;;;; Special Block
1471 "Parse a special block.
1473 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1474 the buffer position at the beginning of the first affiliated
1475 keyword and CDR is a plist of affiliated keywords along with
1476 their value.
1478 Return a list whose CAR is `special-block' and CDR is a plist
1479 containing `:type', `:begin', `:end', `:contents-begin',
1480 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1482 Assume point is at the beginning of the block."
1489 limit t)))
1490 ;; Incomplete block: parse it as a paragraph.
1496 ;; Empty blocks have no contents.
1509 :begin begin
1510 :end end
1511 :contents-begin contents-begin
1512 :contents-end contents-end
1518 "Interpret SPECIAL-BLOCK element as Org syntax.
1519 CONTENTS is the contents of the element."
1524 \f
1525 ;;; Elements
1526 ;;
1527 ;; For each element, a parser and an interpreter are also defined.
1528 ;; Both follow the same naming convention used for greater elements.
1529 ;;
1530 ;; Also, as for greater elements, adding a new element type is done
1531 ;; through the following steps: implement a parser and an interpreter,
1532 ;; tweak `org-element--current-element' so that it recognizes the new
1533 ;; type and add that new type to `org-element-all-elements'.
1534 ;;
1535 ;; As a special case, when the newly defined type is a block type,
1536 ;; `org-element-block-name-alist' has to be modified accordingly.
1539 ;;;; Babel Call
1542 "Parse a babel call.
1544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1545 the buffer position at the beginning of the first affiliated
1546 keyword and CDR is a plist of affiliated keywords along with
1547 their value.
1549 Return a list whose CAR is `babel-call' and CDR is a plist
1550 containing `:begin', `:end', `:value', `:post-blank' and
1551 `:post-affiliated' as keywords."
1565 :end end
1566 :value value
1572 "Interpret BABEL-CALL element as Org syntax.
1573 CONTENTS is nil."
1577 ;;;; Clock
1580 "Parse a clock.
1582 LIMIT bounds the search.
1584 Return a list whose CAR is `clock' and CDR is a plist containing
1585 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1586 as keywords."
1606 :value value
1607 :duration duration
1608 :begin begin
1609 :end end
1613 "Interpret CLOCK element as Org syntax.
1614 CONTENTS is nil."
1622 "%2s:%02s"
1626 ;;;; Comment
1629 "Parse a comment.
1631 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1632 the buffer position at the beginning of the first affiliated
1633 keyword and CDR is a plist of affiliated keywords along with
1634 their value.
1636 Return a list whose CAR is `comment' and CDR is a plist
1637 containing `:begin', `:end', `:value', `:post-blank',
1638 `:post-affiliated' keywords.
1640 Assume point is at comment beginning."
1649 ;; Get comments ending.
1652 ;; Accumulate lines without leading hash and first
1653 ;; whitespace.
1667 :end end
1668 :value value
1674 "Interpret COMMENT element as Org syntax.
1675 CONTENTS is nil."
1679 ;;;; Comment Block
1682 "Parse an export block.
1684 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1685 the buffer position at the beginning of the first affiliated
1686 keyword and CDR is a plist of affiliated keywords along with
1687 their value.
1689 Return a list whose CAR is `comment-block' and CDR is a plist
1690 containing `:begin', `:end', `:value', `:post-blank' and
1691 `:post-affiliated' keywords.
1693 Assume point is at comment block beginning."
1697 ;; Incomplete block: parse it as a paragraph.
1710 contents-begin contents-end)))
1714 :end end
1715 :value value
1721 "Interpret COMMENT-BLOCK element as Org syntax.
1722 CONTENTS is nil."
1727 ;;;; Diary Sexp
1730 "Parse a diary sexp.
1732 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1733 the buffer position at the beginning of the first affiliated
1734 keyword and CDR is a plist of affiliated keywords along with
1735 their value.
1737 Return a list whose CAR is `diary-sexp' and CDR is a plist
1738 containing `:begin', `:end', `:value', `:post-blank' and
1739 `:post-affiliated' keywords."
1751 :begin begin
1752 :end end
1758 "Interpret DIARY-SEXP as Org syntax.
1759 CONTENTS is nil."
1763 ;;;; Example Block
1766 "Parse an example block.
1768 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1769 the buffer position at the beginning of the first affiliated
1770 keyword and CDR is a plist of affiliated keywords along with
1771 their value.
1773 Return a list whose CAR is `example-block' and CDR is a plist
1774 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1775 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1776 `:value', `:post-blank' and `:post-affiliated' keywords."
1780 ;; Incomplete block: parse it as a paragraph.
1788 ;; Switches analysis
1795 ;; Should labels be retained in (or stripped from) example
1796 ;; blocks?
1801 ;; What should code-references use - labels or
1802 ;; line-numbers?
1811 ;; Standard block parsing.
1819 contents-begin contents-end))
1820 block-ind))
1829 :end end
1830 :value value
1831 :switches switches
1832 :number-lines number-lines
1833 :preserve-indent preserve-indent
1834 :retain-labels retain-labels
1835 :use-labels use-labels
1836 :label-fmt label-fmt
1842 "Interpret EXAMPLE-BLOCK element as Org syntax.
1843 CONTENTS is nil."
1850 value
1855 ;;;; Export Block
1858 "Parse an export block.
1860 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1861 the buffer position at the beginning of the first affiliated
1862 keyword and CDR is a plist of affiliated keywords along with
1863 their value.
1865 Return a list whose CAR is `export-block' and CDR is a plist
1866 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1867 `:post-affiliated' keywords.
1869 Assume point is at export-block beginning."
1876 ;; Incomplete block: parse it as a paragraph.
1889 contents-end)))
1893 :end end
1894 :type type
1895 :value value
1901 "Interpret EXPORT-BLOCK element as Org syntax.
1902 CONTENTS is nil."
1909 ;;;; Fixed-width
1912 "Parse a fixed-width section.
1914 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1915 the buffer position at the beginning of the first affiliated
1916 keyword and CDR is a plist of affiliated keywords along with
1917 their value.
1919 Return a list whose CAR is `fixed-width' and CDR is a plist
1920 containing `:begin', `:end', `:value', `:post-blank' and
1921 `:post-affiliated' keywords.
1923 Assume point is at the beginning of the fixed-width area."
1927 value
1932 ;; Accumulate text without starting colons.
1945 :end end
1946 :value value
1952 "Interpret FIXED-WIDTH element as Org syntax.
1953 CONTENTS is nil."
1961 ;;;; Horizontal Rule
1964 "Parse an horizontal rule.
1966 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1967 the buffer position at the beginning of the first affiliated
1968 keyword and CDR is a plist of affiliated keywords along with
1969 their value.
1971 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1972 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1973 keywords."
1983 :end end
1989 "Interpret HORIZONTAL-RULE element as Org syntax.
1990 CONTENTS is nil."
1994 ;;;; Keyword
1997 "Parse a keyword at point.
1999 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2000 the buffer position at the beginning of the first affiliated
2001 keyword and CDR is a plist of affiliated keywords along with
2002 their value.
2004 Return a list whose CAR is `keyword' and CDR is a plist
2005 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2006 `:post-affiliated' keywords."
2008 ;; An orphaned affiliated keyword is considered as a regular
2009 ;; keyword. In this case AFFILIATED is nil, so we take care of
2010 ;; this corner case.
2023 :value value
2024 :begin begin
2025 :end end
2031 "Interpret KEYWORD element as Org syntax.
2032 CONTENTS is nil."
2038 ;;;; Latex Environment
2041 "Parse a LaTeX environment.
2043 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2044 the buffer position at the beginning of the first affiliated
2045 keyword and CDR is a plist of affiliated keywords along with
2046 their value.
2048 Return a list whose CAR is `latex-environment' and CDR is a plist
2049 containing `:begin', `:end', `:value', `:post-blank' and
2050 `:post-affiliated' keywords.
2052 Assume point is at the beginning of the latex environment."
2059 limit t))
2060 ;; Incomplete latex environment: parse it as a paragraph.
2070 :end end
2071 :value value
2077 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2078 CONTENTS is nil."
2082 ;;;; Node Property
2085 "Parse a node-property at point.
2087 LIMIT bounds the search.
2089 Return a list whose CAR is `node-property' and CDR is a plist
2090 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2091 keywords."
2103 :value value
2104 :begin begin
2105 :end end
2109 "Interpret NODE-PROPERTY element as Org syntax.
2110 CONTENTS is nil."
2116 ;;;; Paragraph
2119 "Parse a paragraph.
2121 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2122 the buffer position at the beginning of the first affiliated
2123 keyword and CDR is a plist of affiliated keywords along with
2124 their value.
2126 Return a list whose CAR is `paragraph' and CDR is a plist
2127 containing `:begin', `:end', `:contents-begin' and
2128 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2130 Assume point is at the beginning of the paragraph."
2139 limit
2140 ;; A matching `org-element-paragraph-separate' is not
2141 ;; necessarily the end of the paragraph. In
2142 ;; particular, lines starting with # or : as a first
2143 ;; non-space character are ambiguous. We have to
2144 ;; check if they are valid Org syntax (e.g., not an
2145 ;; incomplete keyword).
2149 ;; There's no ambiguity for other symbols or
2150 ;; empty lines: stop here.
2152 ;; Stop at valid fixed-width areas.
2154 ;; Stop at drawers.
2159 ;; Stop at valid comments.
2161 ;; Stop at valid dynamic blocks.
2166 ;; Stop at valid blocks.
2173 limit t)))
2174 ;; Stop at valid latex environments.
2182 limit t)))
2183 ;; Stop at valid keywords.
2185 ;; Skip everything else.
2202 :end end
2203 :contents-begin contents-begin
2204 :contents-end contents-end
2210 "Interpret PARAGRAPH element as Org syntax.
2211 CONTENTS is the contents of the element."
2212 contents)
2215 ;;;; Planning
2218 "Parse a planning.
2220 LIMIT bounds the search.
2222 Return a list whose CAR is `planning' and CDR is a plist
2223 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2224 and `:post-blank' keywords."
2234 closed deadline scheduled)
2246 :deadline deadline
2247 :scheduled scheduled
2248 :begin begin
2249 :end end
2253 "Interpret PLANNING element as Org syntax.
2254 CONTENTS is nil."
2256 'identity
2273 ;;;; Src Block
2276 "Parse a src block.
2278 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2279 the buffer position at the beginning of the first affiliated
2280 keyword and CDR is a plist of affiliated keywords along with
2281 their value.
2283 Return a list whose CAR is `src-block' and CDR is a plist
2284 containing `:language', `:switches', `:parameters', `:begin',
2285 `:end', `:number-lines', `:retain-labels', `:use-labels',
2286 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2287 `:post-affiliated' keywords.
2289 Assume point is at the beginning of the block."
2292 limit t)))
2293 ;; Incomplete block: parse it as a paragraph.
2299 ;; Get language as a string.
2308 ;; Get switches.
2310 ;; Get parameters.
2312 ;; Switches analysis
2323 ;; Should labels be retained in (or stripped from)
2324 ;; src blocks?
2329 ;; What should code-references use - labels or
2330 ;; line-numbers?
2335 ;; Indentation.
2337 ;; Retrieve code.
2342 block-ind))
2346 ;; Get position after ending blank lines.
2356 :begin begin
2357 :end end
2358 :number-lines number-lines
2359 :preserve-indent preserve-indent
2360 :retain-labels retain-labels
2361 :use-labels use-labels
2362 :label-fmt label-fmt
2363 :value value
2369 "Interpret SRC-BLOCK element as Org syntax.
2370 CONTENTS is nil."
2379 val)
2393 ;;;; Table
2396 "Parse a table at point.
2398 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2399 the buffer position at the beginning of the first affiliated
2400 keyword and CDR is a plist of affiliated keywords along with
2401 their value.
2403 Return a list whose CAR is `table' and CDR is a plist containing
2404 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2405 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2406 keywords.
2408 Assume point is at the beginning of the table."
2422 acc))
2429 :end end
2430 :type type
2431 :tblfm tblfm
2432 ;; Only `org' tables have contents. `table.el' tables
2433 ;; use a `:value' property to store raw table as
2434 ;; a string.
2439 table-begin table-end))
2445 "Interpret TABLE element as Org syntax.
2446 CONTENTS is nil."
2457 ;;;; Table Row
2460 "Parse table row at point.
2462 LIMIT bounds the search.
2464 Return a list whose CAR is `table-row' and CDR is a plist
2465 containing `:begin', `:end', `:contents-begin', `:contents-end',
2466 `:type' and `:post-blank' keywords."
2470 ;; A table rule has no contents. In that case, ensure
2471 ;; CONTENTS-BEGIN matches CONTENTS-END.
2483 :begin begin
2484 :end end
2485 :contents-begin contents-begin
2486 :contents-end contents-end
2490 "Interpret TABLE-ROW element as Org syntax.
2491 CONTENTS is the contents of the table row."
2496 ;;;; Verse Block
2499 "Parse a verse block.
2501 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2502 the buffer position at the beginning of the first affiliated
2503 keyword and CDR is a plist of affiliated keywords along with
2504 their value.
2506 Return a list whose CAR is `verse-block' and CDR is a plist
2507 containing `:begin', `:end', `:contents-begin', `:contents-end',
2508 `:post-blank' and `:post-affiliated' keywords.
2510 Assume point is at beginning of the block."
2514 ;; Incomplete block: parse it as a paragraph.
2529 :end end
2530 :contents-begin contents-begin
2531 :contents-end contents-end
2537 "Interpret VERSE-BLOCK element as Org syntax.
2538 CONTENTS is verse block contents."
2542 \f
2543 ;;; Objects
2544 ;;
2545 ;; Unlike to elements, raw text can be found between objects. Hence,
2546 ;; `org-element--object-lex' is provided to find the next object in
2547 ;; buffer.
2548 ;;
2549 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2550 ;; object types they can contain will be specified in
2551 ;; `org-element-object-restrictions'.
2552 ;;
2553 ;; Creating a new type of object requires to alter
2554 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2555 ;; new type in `org-element-all-objects', and possibly add
2556 ;; restrictions in `org-element-object-restrictions'.
2558 ;;;; Bold
2561 "Parse bold object at point, if any.
2563 When at a bold object, return a list whose car is `bold' and cdr
2564 is a plist with `:begin', `:end', `:contents-begin' and
2565 `:contents-end' and `:post-blank' keywords. Otherwise, return
2566 nil.
2568 Assume point is at the first star marker."
2580 :end end
2581 :contents-begin contents-begin
2582 :contents-end contents-end
2586 "Interpret BOLD object as Org syntax.
2587 CONTENTS is the contents of the object."
2591 ;;;; Code
2594 "Parse code object at point, if any.
2596 When at a code object, return a list whose car is `code' and cdr
2597 is a plist with `:value', `:begin', `:end' and `:post-blank'
2598 keywords. Otherwise, return nil.
2600 Assume point is at the first tilde marker."
2611 :begin begin
2612 :end end
2616 "Interpret CODE object as Org syntax.
2617 CONTENTS is nil."
2621 ;;;; Entity
2624 "Parse entity at point, if any.
2626 When at an entity, return a list whose car is `entity' and cdr
2627 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2628 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2629 `:post-blank' as keywords. Otherwise, return nil.
2631 Assume point is at the beginning of the entity."
2633 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2651 :begin begin
2652 :end end
2653 :use-brackets-p bracketsp
2657 "Interpret ENTITY object as Org syntax.
2658 CONTENTS is nil."
2664 ;;;; Export Snippet
2667 "Parse export snippet at point.
2669 When at an export snippet, return a list whose car is
2670 `export-snippet' and cdr a plist with `:begin', `:end',
2671 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2672 return nil.
2674 Assume point is at the beginning of the snippet."
2690 :value value
2691 :begin begin
2692 :end end
2696 "Interpret EXPORT-SNIPPET object as Org syntax.
2697 CONTENTS is nil."
2703 ;;;; Footnote Reference
2706 "Parse footnote reference at point, if any.
2708 When at a footnote reference, return a list whose car is
2709 `footnote-reference' and cdr a plist with `:label', `:type',
2710 `:inline-definition', `:begin', `:end' and `:post-blank' as
2711 keywords. Otherwise, return nil."
2735 :type type
2736 :begin begin
2737 :end end
2740 footnote-reference :inline-definition
2745 footnote-reference))))))))
2748 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2749 CONTENTS is nil."
2759 ;;;; Inline Babel Call
2762 "Parse inline babel call at point, if any.
2764 When at an inline babel call, return a list whose car is
2765 `inline-babel-call' and cdr a plist with `:begin', `:end',
2766 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2768 Assume point is at the beginning of the babel call."
2780 :end end
2781 :value value
2785 "Interpret INLINE-BABEL-CALL object as Org syntax.
2786 CONTENTS is nil."
2790 ;;;; Inline Src Block
2793 "Parse inline source block at point, if any.
2795 When at an inline source block, return a list whose car is
2796 `inline-src-block' and cdr a plist with `:begin', `:end',
2797 `:language', `:value', `:parameters' and `:post-blank' as
2798 keywords. Otherwise, return nil.
2800 Assume point is at the beginning of the inline src block."
2813 :value value
2814 :parameters parameters
2815 :begin begin
2816 :end end
2820 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2821 CONTENTS is nil."
2826 language
2828 body)))
2830 ;;;; Italic
2833 "Parse italic object at point, if any.
2835 When at an italic object, return a list whose car is `italic' and
2836 cdr is a plist with `:begin', `:end', `:contents-begin' and
2837 `:contents-end' and `:post-blank' keywords. Otherwise, return
2838 nil.
2840 Assume point is at the first slash marker."
2852 :end end
2853 :contents-begin contents-begin
2854 :contents-end contents-end
2858 "Interpret ITALIC object as Org syntax.
2859 CONTENTS is the contents of the object."
2863 ;;;; Latex Fragment
2866 "Parse LaTeX fragment at point, if any.
2868 When at a LaTeX fragment, return a list whose car is
2869 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2870 and `:post-blank' as keywords. Otherwise, return nil.
2872 Assume point is at the beginning of the LaTeX fragment."
2886 ;; Macro.
2889 ;; No fragment found.
2897 :begin begin
2898 :end end
2902 "Interpret LATEX-FRAGMENT object as Org syntax.
2903 CONTENTS is nil."
2906 ;;;; Line Break
2909 "Parse line break at point, if any.
2911 When at a line break, return a list whose car is `line-break',
2912 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2913 Otherwise, return nil.
2915 Assume point is at the beginning of the line break."
2924 "Interpret LINE-BREAK object as Org syntax.
2925 CONTENTS is nil."
2929 ;;;; Link
2932 "Parse link at point, if any.
2934 When at a link, return a list whose car is `link' and cdr a plist
2935 with `:type', `:path', `:raw-link', `:application',
2936 `:search-option', `:begin', `:end', `:contents-begin',
2937 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2938 nil.
2940 Assume point is at the beginning of the link."
2943 end contents-begin contents-end link-end post-blank path type
2944 raw-link link search-option application)
2946 ;; Type 1: Text targeted from a radio target.
2953 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2958 ;; RAW-LINK is the original link. Expand any
2959 ;; abbreviation in it.
2963 ;; Determine TYPE of link and set PATH accordingly.
2965 ;; File type.
2969 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2972 ;; Id type: PATH is the id.
2975 ;; Code-ref type: PATH is the name of the reference.
2978 ;; Custom-id type: PATH is the name of the custom id.
2981 ;; Fuzzy type: Internal link either matches a target, an
2982 ;; headline name or nothing. PATH is the target or
2983 ;; headline's name.
2985 ;; Type 3: Plain link, e.g., http://orgmode.org
2991 ;; Type 4: Angular link, e.g., <http://orgmode.org>
2999 ;; In any case, deduce end point after trailing white space from
3000 ;; LINK-END variable.
3004 ;; Extract search option and opening application out of
3005 ;; "file"-type links.
3007 ;; Application.
3012 ;; Extract search option from PATH.
3016 ;; Make sure TYPE always reports "file".
3020 :path path
3022 :application application
3023 :search-option search-option
3024 :begin begin
3025 :end end
3026 :contents-begin contents-begin
3027 :contents-end contents-end
3031 "Interpret LINK object as Org syntax.
3032 CONTENTS is the contents of the object, or nil."
3037 raw-link
3041 ;;;; Macro
3044 "Parse macro at point, if any.
3046 When at a macro, return a list whose car is `macro' and cdr
3047 a plist with `:key', `:args', `:begin', `:end', `:value' and
3048 `:post-blank' as keywords. Otherwise, return nil.
3050 Assume point is at the macro."
3061 ;; Do not use `org-split-string' since empty
3062 ;; strings are meaningful here.
3070 args nil t)
3074 :value value
3075 :args args
3076 :begin begin
3077 :end end
3081 "Interpret MACRO object as Org syntax.
3082 CONTENTS is nil."
3086 ;;;; Radio-target
3089 "Parse radio target at point, if any.
3091 When at a radio target, return a list whose car is `radio-target'
3092 and cdr a plist with `:begin', `:end', `:contents-begin',
3093 `:contents-end', `:value' and `:post-blank' as keywords.
3094 Otherwise, return nil.
3096 Assume point is at the radio target."
3108 :end end
3109 :contents-begin contents-begin
3110 :contents-end contents-end
3111 :post-blank post-blank
3115 "Interpret TARGET object as Org syntax.
3116 CONTENTS is the contents of the object."
3120 ;;;; Statistics Cookie
3123 "Parse statistics cookie at point, if any.
3125 When at a statistics cookie, return a list whose car is
3126 `statistics-cookie', and cdr a plist with `:begin', `:end',
3127 `:value' and `:post-blank' keywords. Otherwise, return nil.
3129 Assume point is at the beginning of the statistics-cookie."
3140 :end end
3141 :value value
3145 "Interpret STATISTICS-COOKIE object as Org syntax.
3146 CONTENTS is nil."
3150 ;;;; Strike-Through
3153 "Parse strike-through object at point, if any.
3155 When at a strike-through object, return a list whose car is
3156 `strike-through' and cdr is a plist with `:begin', `:end',
3157 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3158 Otherwise, return nil.
3160 Assume point is at the first plus sign marker."
3172 :end end
3173 :contents-begin contents-begin
3174 :contents-end contents-end
3178 "Interpret STRIKE-THROUGH object as Org syntax.
3179 CONTENTS is the contents of the object."
3183 ;;;; Subscript
3186 "Parse subscript at point, if any.
3188 When at a subscript object, return a list whose car is
3189 `subscript' and cdr a plist with `:begin', `:end',
3190 `:contents-begin', `:contents-end', `:use-brackets-p' and
3191 `:post-blank' as keywords. Otherwise, return nil.
3193 Assume point is at the underscore."
3207 :end end
3208 :use-brackets-p bracketsp
3209 :contents-begin contents-begin
3210 :contents-end contents-end
3214 "Interpret SUBSCRIPT object as Org syntax.
3215 CONTENTS is the contents of the object."
3218 contents))
3221 ;;;; Superscript
3224 "Parse superscript at point, if any.
3226 When at a superscript object, return a list whose car is
3227 `superscript' and cdr a plist with `:begin', `:end',
3228 `:contents-begin', `:contents-end', `:use-brackets-p' and
3229 `:post-blank' as keywords. Otherwise, return nil.
3231 Assume point is at the caret."
3245 :end end
3246 :use-brackets-p bracketsp
3247 :contents-begin contents-begin
3248 :contents-end contents-end
3252 "Interpret SUPERSCRIPT object as Org syntax.
3253 CONTENTS is the contents of the object."
3256 contents))
3259 ;;;; Table Cell
3262 "Parse table cell at point.
3263 Return a list whose car is `table-cell' and cdr is a plist
3264 containing `:begin', `:end', `:contents-begin', `:contents-end'
3265 and `:post-blank' keywords."
3273 :end end
3274 :contents-begin contents-begin
3275 :contents-end contents-end
3279 "Interpret TABLE-CELL element as Org syntax.
3280 CONTENTS is the contents of the cell, or nil."
3284 ;;;; Target
3287 "Parse target at point, if any.
3289 When at a target, return a list whose car is `target' and cdr
3290 a plist with `:begin', `:end', `:value' and `:post-blank' as
3291 keywords. Otherwise, return nil.
3293 Assume point is at the target."
3303 :end end
3304 :value value
3308 "Interpret TARGET object as Org syntax.
3309 CONTENTS is nil."
3313 ;;;; Timestamp
3324 "Parse time stamp at point, if any.
3326 When at a time stamp, return a list whose car is `timestamp', and
3327 cdr a plist with `:type', `:raw-value', `:year-start',
3328 `:month-start', `:day-start', `:hour-start', `:minute-start',
3329 `:year-end', `:month-end', `:day-end', `:hour-end',
3330 `:minute-end', `:repeater-type', `:repeater-value',
3331 `:repeater-unit', `:warning-type', `:warning-value',
3332 `:warning-unit', `:begin', `:end', `:value' and `:post-blank'
3333 keywords. Otherwise, return nil.
3335 Assume point is at the beginning of the timestamp."
3354 date-start)
3365 raw-value)
3367 :repeater-type
3373 :repeater-unit
3382 :warning-unit
3385 year-start month-start day-start hour-start minute-start year-end
3386 month-end day-end hour-end minute-end)
3387 ;; Parse date-start.
3395 ;; Compute date-end. It can be provided directly in time-stamp,
3396 ;; or extracted from time range. Otherwise, it defaults to the
3397 ;; same values as date-start.
3407 :raw-value raw-value
3408 :year-start year-start
3409 :month-start month-start
3410 :day-start day-start
3411 :hour-start hour-start
3412 :minute-start minute-start
3413 :year-end year-end
3414 :month-end month-end
3415 :day-end day-end
3416 :hour-end hour-end
3417 :minute-end minute-end
3418 :begin begin
3419 :end end
3421 repeater-props
3422 warning-props))))))
3425 "Interpret TIMESTAMP object as Org syntax.
3426 CONTENTS is nil."
3445 ;; Build an Org timestamp string from TIME. ACTIVEP is
3446 ;; non-nil when time stamp is active. If WITH-TIME-P is
3447 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3448 ;; specify a time range in the timestamp. REPEAT-STRING is
3449 ;; the repeater string, if any.
3453 org-time-stamp-formats)
3454 time)))
3460 nil nil ts)))
3465 " "
3466 s
3468 ;; Return value.
3469 ts)))
3481 build-ts-string
3500 0
3508 "--"
3520 ;;;; Underline
3523 "Parse underline object at point, if any.
3525 When at an underline object, return a list whose car is
3526 `underline' and cdr is a plist with `:begin', `:end',
3527 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3528 Otherwise, return nil.
3530 Assume point is at the first underscore marker."
3542 :end end
3543 :contents-begin contents-begin
3544 :contents-end contents-end
3548 "Interpret UNDERLINE object as Org syntax.
3549 CONTENTS is the contents of the object."
3553 ;;;; Verbatim
3556 "Parse verbatim object at point, if any.
3558 When at a verbatim object, return a list whose car is `verbatim'
3559 and cdr is a plist with `:value', `:begin', `:end' and
3560 `:post-blank' keywords. Otherwise, return nil.
3562 Assume point is at the first equal sign marker."
3573 :begin begin
3574 :end end
3578 "Interpret VERBATIM object as Org syntax.
3579 CONTENTS is nil."
3583 \f
3584 ;;; Parsing Element Starting At Point
3585 ;;
3586 ;; `org-element--current-element' is the core function of this section.
3587 ;; It returns the Lisp representation of the element starting at
3588 ;; point.
3589 ;;
3590 ;; `org-element--current-element' makes use of special modes. They
3591 ;; are activated for fixed element chaining (e.g., `plain-list' >
3592 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3593 ;; `section'). Special modes are: `first-section', `item',
3594 ;; `node-property', `section' and `table-row'.
3598 "Parse the element starting at point.
3600 Return value is a list like (TYPE PROPS) where TYPE is the type
3601 of the element and PROPS a plist of properties associated to the
3602 element.
3604 Possible types are defined in `org-element-all-elements'.
3606 LIMIT bounds the search.
3608 Optional argument GRANULARITY determines the depth of the
3609 recursion. Allowed values are `headline', `greater-element',
3610 `element', `object' or nil. When it is broader than `object' (or
3611 nil), secondary values will not be parsed, since they only
3612 contain objects.
3614 Optional argument SPECIAL, when non-nil, can be either
3615 `first-section', `item', `node-property', `section', and
3616 `table-row'.
3618 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3619 be computed.
3621 This function assumes point is always at the beginning of the
3622 element it has to parse."
3625 ;; Determine if parsing depth allows for secondary strings
3626 ;; parsing. It only applies to elements referenced in
3627 ;; `org-element-secondary-value-alist'.
3630 ;; Item.
3633 ;; Table Row.
3635 ;; Node Property.
3637 ;; Headline.
3640 ;; Sections (must be checked after headline).
3645 limit)))
3646 ;; When not at bol, point is at the beginning of an item or
3647 ;; a footnote definition: next item is always a paragraph.
3649 ;; Planning and Clock.
3654 ;; Inlinetask.
3657 ;; From there, elements can have affiliated keywords.
3660 ;; Jumping over affiliated keywords put point off-limits.
3661 ;; Parse them as regular keywords.
3665 ;; LaTeX Environment.
3669 ;; Drawer and Property Drawer.
3674 ;; Fixed Width
3677 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3678 ;; Keywords.
3687 org-element-block-name-alist)))
3702 ;; Footnote Definition.
3705 ;; Horizontal Rule.
3708 ;; Diary Sexp.
3711 ;; Table.
3713 ;; List.
3716 limit affiliated
3718 ;; Default element: Paragraph.
3722 ;; Most elements can have affiliated keywords. When looking for an
3723 ;; element beginning, we want to move before them, as they belong to
3724 ;; that element, and, in the meantime, collect information they give
3725 ;; into appropriate properties. Hence the following function.
3728 "Collect affiliated keywords from point down to LIMIT.
3730 Return a list whose CAR is the position at the first of them and
3731 CDR a plist of keywords and values and move point to the
3732 beginning of the first line after them.
3734 As a special case, if element doesn't start at the beginning of
3735 the line (e.g., a paragraph starting an item), CAR is current
3736 position of point and CDR is nil."
3740 ;; RESTRICT is the list of objects allowed in parsed
3741 ;; keywords value.
3743 output)
3746 ;; Apply translation to RAW-KWD. From there, KWD is
3747 ;; the official keyword.
3749 org-element-keyword-translation-alist))
3750 raw-kwd))
3751 ;; Find main value for any keyword.
3757 ;; PARSEDP is non-nil when keyword should have its
3758 ;; value parsed.
3760 ;; If KWD is a dual keyword, find its secondary
3761 ;; value. Maybe parse it.
3768 ;; Attribute a property name to KWD.
3770 ;; Now set final shape for VALUE.
3776 ;; Attributes can always appear on multiple lines.
3779 ;; Eventually store the new value in OUTPUT.
3781 ;; Move to next keyword.
3783 ;; If affiliated keywords are orphaned: move back to first one.
3784 ;; They will be parsed as a paragraph.
3786 ;; Return value.
3790 \f
3791 ;;; The Org Parser
3792 ;;
3793 ;; The two major functions here are `org-element-parse-buffer', which
3794 ;; parses Org syntax inside the current buffer, taking into account
3795 ;; region, narrowing, or even visibility if specified, and
3796 ;; `org-element-parse-secondary-string', which parses objects within
3797 ;; a given string.
3798 ;;
3799 ;; The (almost) almighty `org-element-map' allows to apply a function
3800 ;; on elements or objects matching some type, and accumulate the
3801 ;; resulting values. In an export situation, it also skips unneeded
3802 ;; parts of the parse tree.
3805 "Recursively parse the buffer and return structure.
3806 If narrowing is in effect, only parse the visible part of the
3807 buffer.
3809 Optional argument GRANULARITY determines the depth of the
3810 recursion. It can be set to the following symbols:
3812 `headline' Only parse headlines.
3813 `greater-element' Don't recurse into greater elements excepted
3814 headlines and sections. Thus, elements
3815 parsed are the top-level ones.
3816 `element' Parse everything but objects and plain text.
3817 `object' Parse the complete buffer (default).
3819 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3820 elements.
3822 An element or an objects is represented as a list with the
3823 pattern (TYPE PROPERTIES CONTENTS), where :
3825 TYPE is a symbol describing the element or object. See
3826 `org-element-all-elements' and `org-element-all-objects' for an
3827 exhaustive list of such symbols. One can retrieve it with
3828 `org-element-type' function.
3830 PROPERTIES is the list of attributes attached to the element or
3831 object, as a plist. Although most of them are specific to the
3832 element or object type, all types share `:begin', `:end',
3833 `:post-blank' and `:parent' properties, which respectively
3834 refer to buffer position where the element or object starts,
3835 ends, the number of white spaces or blank lines after it, and
3836 the element or object containing it. Properties values can be
3837 obtained by using `org-element-property' function.
3839 CONTENTS is a list of elements, objects or raw strings
3840 contained in the current element or object, when applicable.
3841 One can access them with `org-element-contents' function.
3843 The Org buffer has `org-data' as type and nil as properties.
3844 `org-element-map' function can be used to find specific elements
3845 or objects within the parse tree.
3847 This function assumes that current major mode is `org-mode'."
3853 ;; Start in `first-section' mode so text before the first
3854 ;; headline belongs to a section.
3858 "Recursively parse objects in STRING and return structure.
3860 RESTRICTION is a symbol limiting the object types that will be
3861 looked after.
3863 Optional argument PARENT, when non-nil, is the element or object
3864 containing the secondary string. It is used to set correctly
3865 `:parent' property within the string."
3866 ;; Copy buffer-local variables listed in
3867 ;; `org-element-object-variables' into temporary buffer. This is
3868 ;; required since object parsing is dependent on these variables.
3872 org-element-object-variables))))
3880 secondary))
3881 secondary))))
3885 "Map a function on selected elements or objects.
3887 DATA is a parse tree, an element, an object, a string, or a list
3888 of such constructs. TYPES is a symbol or list of symbols of
3889 elements or objects types (see `org-element-all-elements' and
3890 `org-element-all-objects' for a complete list of types). FUN is
3891 the function called on the matching element or object. It has to
3892 accept one argument: the element or object itself.
3894 When optional argument INFO is non-nil, it should be a plist
3895 holding export options. In that case, parts of the parse tree
3896 not exportable according to that property list will be skipped.
3898 When optional argument FIRST-MATCH is non-nil, stop at the first
3899 match for which FUN doesn't return nil, and return that value.
3901 Optional argument NO-RECURSION is a symbol or a list of symbols
3902 representing elements or objects types. `org-element-map' won't
3903 enter any recursive element or object whose type belongs to that
3904 list. Though, FUN can still be applied on them.
3906 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3907 apply to matching objects within parsed affiliated keywords (see
3908 `org-element-parsed-keywords').
3910 Nil values returned from FUN do not appear in the results.
3913 Examples:
3914 ---------
3916 Assuming TREE is a variable containing an Org buffer parse tree,
3917 the following example will return a flat list of all `src-block'
3918 and `example-block' elements in it:
3920 \(org-element-map tree '(example-block src-block) 'identity)
3922 The following snippet will find the first headline with a level
3925 \(org-element-map tree 'headline
3926 \(lambda (hl)
3927 \(and (= (org-element-property :level hl) 1)
3929 \(org-element-property :begin hl)))
3930 nil t)
3932 The next example will return a flat list of all `plain-list' type
3933 elements in TREE that are not a sub-list themselves:
3935 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3937 Eventually, this example will return a flat list of all `bold'
3938 type objects containing a `latex-snippet' type object, even
3939 looking into captions:
3941 \(org-element-map tree 'bold
3942 \(lambda (b)
3943 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3944 nil nil nil t)"
3945 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3948 ;; Recursion depth is determined by --CATEGORY.
3955 ;; If one object is found, the function
3956 ;; has to recurse into every object.
3959 ;; If one regular element is found, the
3960 ;; function has to recurse, at least,
3961 ;; into every element it encounters.
3964 types)
3965 category)))
3966 ;; Compute properties for affiliated keywords if necessary.
3971 org-element-affiliated-keywords)))
3972 --acc
3973 --walk-tree
3977 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3978 ;; holding contextual information.
3982 ;; Ignored element in an export context.
3984 ;; List of elements or objects.
3986 ;; Unconditionally enter parse trees.
3990 ;; Check if TYPE is matching among TYPES. If so,
3991 ;; apply FUN to --DATA and accumulate return value
3992 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3998 ;; If --DATA has a secondary string that can contain
3999 ;; objects with their type among TYPES, look into it.
4006 ;; If --DATA has any affiliated keywords and
4007 ;; WITH-AFFILIATED is non-nil, look for objects in
4008 ;; them.
4016 ;; Pay attention to the type of value.
4017 ;; Preserve order for multiple keywords.
4033 --affiliated-alist))
4034 ;; Determine if a recursion into --DATA is possible.
4036 ;; --TYPE is explicitly removed from recursion.
4038 ;; --DATA has no contents.
4040 ;; Looking for greater elements but --DATA is simply
4041 ;; an element or an object.
4044 ;; Looking for elements but --DATA is an object.
4047 ;; In any other case, map contents.
4051 ;; Return value in a proper order.
4055 ;; The following functions are internal parts of the parser.
4056 ;;
4057 ;; The first one, `org-element--parse-elements' acts at the element's
4058 ;; level.
4059 ;;
4060 ;; The second one, `org-element--parse-objects' applies on all objects
4061 ;; of a paragraph or a secondary string.
4062 ;;
4063 ;; More precisely, that function looks for every allowed object type
4064 ;; first. Then, it discards failed searches, keeps further matches,
4065 ;; and searches again types matched behind point, for subsequent
4066 ;; calls. Thus, searching for a given type fails only once, and every
4067 ;; object is searched only once at top level (but sometimes more for
4068 ;; nested types).
4072 "Parse elements between BEG and END positions.
4074 SPECIAL prioritize some elements over the others. It can be set
4075 to `first-section', `section' `item' or `table-row'.
4077 When value is `item', STRUCTURE will be used as the current list
4078 structure.
4080 GRANULARITY determines the depth of the recursion. See
4081 `org-element-parse-buffer' for more information.
4083 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4084 elements.
4086 Elements are accumulated into ACC."
4089 ;; Visible only: skip invisible parts at the beginning of the
4090 ;; element.
4093 ;; When parsing only headlines, skip any text before first one.
4096 ;; Main loop start.
4098 ;; Find current element's type and parse it accordingly to
4099 ;; its category.
4101 end granularity special structure))
4105 ;; Visible only: skip invisible parts between siblings.
4108 ;; Fill ELEMENT contents by side-effect.
4110 ;; If element has no contents, don't modify it.
4112 ;; Greater element: parse it between `contents-begin' and
4113 ;; `contents-end'. Make sure GRANULARITY allows the
4114 ;; recursion, or ELEMENT is a headline, in which case going
4115 ;; inside is mandatory, in order to get sub-level headings.
4123 ;; Possibly switch to a special mode.
4131 granularity visible-only element))
4132 ;; ELEMENT has contents. Parse objects inside, if
4133 ;; GRANULARITY allows it.
4139 ;; Return result.
4140 acc))
4146 ;; Sub/superscript.
4148 ;; Bold, code, italic, strike-through, underline and
4149 ;; verbatim.
4152 ;; Plain links.
4154 ;; Objects starting with "[": regular link, footnote
4155 ;; reference, statistics cookie, timestamp (inactive).
4157 ;; Objects starting with "@": export snippets.
4158 "@@"
4159 ;; Objects starting with "{": macro.
4160 "{{{"
4161 ;; Objects starting with "<" : timestamp (active,
4162 ;; diary), target, radio target and angular links.
4164 ;; Objects starting with "$": latex fragment.
4166 ;; Objects starting with "\": line break, entity,
4167 ;; latex fragment.
4169 ;; Objects starting with raw text: inline Babel
4170 ;; source block, inline Babel call.
4173 "Regexp possibly matching the beginning of an object.
4174 This regexp allows false positives. Dedicated parser (e.g.,
4175 `org-export-bold-parser') will take care of further filtering.
4176 Radio links are not matched by this regexp, as they are treated
4180 "Return next object in current buffer or nil.
4181 RESTRICTION is a list of object types, as symbols, that should be
4182 looked after. This function assumes that the buffer is narrowed
4183 to an appropriate container (e.g., a paragraph)."
4190 found)
4253 ;; This is probably a plain link.
4259 ;; Radio link.
4264 "Parse objects between BEG and END and return recursive structure.
4266 Objects are accumulated in ACC.
4268 RESTRICTION is a list of object successors which are allowed in
4269 the current object."
4277 ;; 1. Text before any object. Untabify it.
4282 acc
4286 ;; 2. Object...
4289 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4290 ;; a recursive type.
4298 ;; 3. Text after last object. Untabify it.
4302 acc
4306 ;; Result.
4307 acc)))
4310 \f
4311 ;;; Towards A Bijective Process
4312 ;;
4313 ;; The parse tree obtained with `org-element-parse-buffer' is really
4314 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4315 ;; interpreted and expanded into a string with canonical Org syntax.
4316 ;; Hence `org-element-interpret-data'.
4317 ;;
4318 ;; The function relies internally on
4319 ;; `org-element--interpret-affiliated-keywords'.
4321 ;;;###autoload
4323 "Interpret DATA as Org syntax.
4325 DATA is a parse tree, an element, an object or a secondary string
4326 to interpret.
4328 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4329 new types that should be treated as objects. An unknown type not
4330 belonging to this list is seen as a pseudo-element instead. Both
4331 pseudo-objects and pseudo-elements are transparent entities, i.e.
4332 only their contents are interpreted.
4334 Return Org syntax as a string."
4338 "Interpret DATA as Org syntax.
4340 DATA is a parse tree, an element, an object or a secondary string
4341 to interpret. PARENT is used for recursive calls. It contains
4342 the element or object containing data, or nil. PSEUDO-OBJECTS
4343 are list of symbols defining new element or object types.
4344 Unknown types that don't belong to this list are treated as
4345 pseudo-elements instead.
4347 Return Org syntax as a string."
4349 ;; Find interpreter for current object or element. If it
4350 ;; doesn't exist (e.g. this is a pseudo object or element),
4351 ;; return contents, if any.
4357 ;; Secondary string.
4363 ;; Full Org document.
4369 ;; Plain text: return it.
4371 ;; Element or object without contents.
4373 ;; Element or object with contents.
4376 ;; Recursively interpret contents.
4382 data
4383 ;; Fix indentation of elements containing
4384 ;; objects. We ignore `table-row' elements
4385 ;; as they are one line long anyway.
4387 data
4388 ;; When normalizing first paragraph of an
4389 ;; item or a footnote-definition, ignore
4390 ;; first line's indentation.
4397 ;; Build white spaces. If no `:post-blank' property is
4398 ;; specified, assume its value is 0.
4409 "Return ELEMENT's affiliated keywords as Org syntax.
4410 If there is no affiliated keyword, return the empty string."
4420 ": "
4423 value)
4431 ;; All attribute keywords can have multiple lines.
4437 ;; List all ELEMENT's properties matching an attribute line or an
4438 ;; affiliated keyword, but ignore translated keywords since they
4439 ;; cannot belong to the property list.
4446 org-element-keyword-translation-alist)))))
4447 collect prop)
4450 ;; Because interpretation of the parse tree must return the same
4451 ;; number of blank lines between elements and the same number of white
4452 ;; space after objects, some special care must be given to white
4453 ;; spaces.
4454 ;;
4455 ;; The first function, `org-element-normalize-string', ensures any
4456 ;; string different from the empty string will end with a single
4457 ;; newline character.
4458 ;;
4459 ;; The second function, `org-element-normalize-contents', removes
4460 ;; global indentation from the contents of the current element.
4463 "Ensure string S ends with a single newline character.
4465 If S isn't a string return it unchanged. If S is the empty
4466 string, return it. Otherwise, return a new string with a single
4467 newline character at its end."
4475 "Normalize plain text in ELEMENT's contents.
4477 ELEMENT must only contain plain text and objects.
4479 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4480 indentation to compute maximal common indentation.
4482 Return the normalized element that is element with global
4483 indentation removed from its contents. The function assumes that
4484 indentation is not done with TAB characters."
4486 find-min-ind ; For byte-compiler.
4489 ;; Return minimal common indentation within BLOB. This is
4490 ;; done by walking recursively BLOB and updating MIN-IND
4491 ;; along the way. FIRST-FLAG is non-nil when the first
4492 ;; string hasn't been seen yet. It is required as this
4493 ;; string is the only one whose indentation doesn't happen
4494 ;; after a newline character.
4501 ;; An indentation of zero means no string will be
4502 ;; modified. Quit the process.
4511 ;; Find minimal indentation in ELEMENT.
4514 ;; Build ELEMENT back, replacing each string with the same
4515 ;; string minus common indentation.
4520 ;; Return BLOB with all its strings indentation
4521 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4522 ;; is non-nil when the first string hasn't been seen
4523 ;; yet.
4538 org-element-recursive-objects)
4542 blob))))
4546 \f
4547 ;;; Cache
4548 ;;
4549 ;; Implement a caching mechanism for `org-element-at-point' and
4550 ;; `org-element-context', which see.
4551 ;;
4552 ;; A single public function is provided: `org-element-cache-reset'.
4553 ;;
4554 ;; Cache is enabled by default, but can be disabled globally with
4555 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4556 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4557 ;; can be tweaked to control caching behaviour.
4558 ;;
4559 ;; Internally, parsed elements are stored in an AVL tree,
4560 ;; `org-element--cache'. This tree is updated lazily: whenever
4561 ;; a change happens to the buffer, a synchronization request is
4562 ;; registered in `org-element--cache-sync-requests' (see
4563 ;; `org-element--cache-submit-request'). During idle time, requests
4564 ;; are processed by `org-element--cache-sync'. Synchronization also
4565 ;; happens when an element is required from the cache. In this case,
4566 ;; the process stops as soon as the needed element is up-to-date.
4567 ;;
4568 ;; A synchronization request can only apply on a synchronized part of
4569 ;; the cache. Therefore, the cache is updated at least to the
4570 ;; location where the new request applies. Thus, requests are ordered
4571 ;; from left to right and all elements starting before the first
4572 ;; request are correct. This property is used by functions like
4573 ;; `org-element--cache-find' to retrieve elements in the part of the
4574 ;; cache that can be trusted.
4575 ;;
4576 ;; A request applies to every element, starting from its original
4577 ;; location (or key, see below). When a request is processed, it
4578 ;; moves forward and may collide the next one. In this case, both
4579 ;; requests are merged into a new one that starts from that element.
4580 ;; As a consequence, the whole synchronization complexity does not
4581 ;; depend on the number of pending requests, but on the number of
4582 ;; elements the very first request will be applied on.
4583 ;;
4584 ;; Elements cannot be accessed through their beginning position, which
4585 ;; may or may not be up-to-date. Instead, each element in the tree is
4586 ;; associated to a key, obtained with `org-element--cache-key'. This
4587 ;; mechanism is robust enough to preserve total order among elements
4588 ;; even when the tree is only partially synchronized.
4589 ;;
4590 ;; Objects contained in an element are stored in a hash table,
4591 ;; `org-element--cache-objects'.
4595 "Non nil when Org parser should cache its results.
4602 "Maximum duration, as a time value, for a cache synchronization.
4603 If the synchronization is not over after this delay, the process
4604 pauses and resumes after `org-element-cache-sync-break'
4608 "Duration, as a time value, of the pause between synchronizations.
4612 ;;;; Data Structure
4615 "AVL tree used to cache elements.
4616 Each node of the tree contains an element. Comparison is done
4617 with `org-element--cache-compare'. This cache is used in
4621 "Hash table used as to cache objects.
4622 Key is an element, as returned by `org-element-at-point', and
4623 value is an alist where each association is:
4625 \(PARENT COMPLETEP . OBJECTS)
4627 where PARENT is an element or object, COMPLETEP is a boolean,
4628 non-nil when all direct children of parent are already cached and
4629 OBJECTS is a list of such children, as objects, from farthest to
4630 closest.
4633 contained within a paragraph
4637 If the paragraph is completely parsed, OBJECTS-DATA will be
4639 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4640 \(BOLD-OBJECT t ENTITY-OBJECT))
4642 whereas in a partially parsed paragraph, it could be
4644 \((PARAGRAPH nil ENTITY-OBJECT))
4649 "List of pending synchronization requests.
4651 A request is a vector with the following pattern:
4653 \[NEXT END OFFSET PARENT PHASE]
4655 Processing a synchronization request consists in three phases:
4657 0. Delete modified elements,
4658 1. Fill missing area in cache,
4659 2. Shift positions and re-parent elements after the changes.
4661 During phase 0, NEXT is the key of the first element to be
4662 removed and END is buffer position delimiting the modifications.
4663 Every element starting between these are removed. PARENT is an
4664 element to be removed. Every element contained in it will also
4665 be removed.
4667 During phase 1, NEXT is the key of the next known element in
4668 cache. Parse buffer between that element and the one before it
4669 in order to determine the parent of the next element. Set PARENT
4670 to the element containing NEXT.
4672 During phase 2, NEXT is the key of the next element to shift in
4673 the parse tree. All elements starting from this one have their
4674 properties relatives to buffer positions shifted by integer
4675 OFFSET and, if they belong to element PARENT, are adopted by it.
4683 "Hash table used to store keys during synchronization.
4687 "Return a unique key for ELEMENT in cache tree.
4689 Keys are used to keep a total order among elements in the cache.
4690 Comparison is done with `org-element--cache-key-less-p'.
4692 When no synchronization is taking place, a key is simply the
4693 beginning position of the element, or that position plus one in
4694 the case of an first item (respectively row) in
4695 a list (respectively a table).
4697 During a synchronization, the key is the one the element had when
4698 the cache was synchronized for the last time. Elements added to
4699 cache during the synchronization get a new key generated with
4700 `org-element--cache-generate-key'.
4702 Such keys are stored in `org-element--cache-sync-keys'. The hash
4703 table is cleared once the synchronization is complete."
4706 ;; Increase beginning position of items (respectively
4707 ;; table rows) by one, so the first item can get
4708 ;; a different key from its parent list (respectively
4709 ;; table).
4712 begin)))
4715 key))))
4718 "Default value for a new key level.
4722 "Generate a key between LOWER and UPPER.
4724 LOWER and UPPER are integers or lists, possibly empty.
4726 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4727 a unique key, as an integer or a list of integers, according to
4728 the following rules:
4730 - LOWER and UPPER are compared level-wise until values differ.
4732 - If, at a given level, LOWER and UPPER differ from more than
4733 2, the new key shares all the levels above with LOWER and
4734 gets a new level. Its value is the mean between LOWER and
4735 UPPER.
4737 \(1 2) + (1 4) --> (1 3)
4739 - If LOWER has no value to compare with, it is assumed that its
4740 value is 0:
4742 \(1 1) + (1 1 2) --> (1 1 1)
4744 Likewise, if UPPER is short of levels, the current value is
4745 `most-positive-fixnum'.
4747 - If they differ from only one, the new key inherits from
4748 current LOWER lever and has a new level at the value
4749 `org-element--cache-default-key'.
4751 \(1 2) + (1 3) --> (1 2 org-element--cache-default-key)
4753 - If the key is only one level long, it is returned as an
4754 integer.
4756 \(1 2) + (3 2) --> 2"
4760 key)
4778 org-element--cache-default-key))
4779 org-element--cache-default-key)
4780 key)
4786 key)
4793 ;; (n) is equivalent to (n 0 0 0 0 ...) so we want to avoid
4794 ;; ending on a sequence of 0.
4799 key)))
4807 org-element--cache-default-key))
4808 org-element--cache-default-key)
4809 key))))
4810 ;; Ensure we don't return a list with a single element.
4814 "Non-nil if key A is less than key B.
4815 A and B are either integers or lists of integers, as returned by
4816 `org-element--cache-key'."
4824 ;; If A is empty, either keys are equal (B is also empty) or
4825 ;; B is less than A (B is longer). Therefore return nil.
4826 ;;
4827 ;; If A is not empty, B is necessarily empty and A is less
4828 ;; than B (A is longer). Therefore, return a non-nil value.
4829 a))))
4832 "Non-nil when element A is located before element B."
4837 "Return root value in cache.
4838 This function assumes `org-element--cache' is a valid AVL tree."
4842 ;;;; Tools
4845 "Non-nil when cache is active in current buffer."
4850 "Find element in cache starting at POS or before.
4852 POS refers to a buffer position.
4854 When optional argument SIDE is non-nil, the function checks for
4855 elements starting at or past POS instead. If SIDE is `both', the
4856 function returns a cons cell where car is the first element
4857 starting at or before POS and cdr the first element starting
4858 after POS.
4860 The function can only find elements in the synchronized part of
4861 the cache."
4865 lower upper)
4880 ;; We found an element in cache starting at POS. If `side'
4881 ;; is `both' we also want the next one in order to generate
4882 ;; a key in-between.
4883 ;;
4884 ;; If the element is the first row or item in a table or
4885 ;; a plain list, we always return the table or the plain
4886 ;; list.
4887 ;;
4888 ;; In any other case, we return the element found.
4897 lower parent
4898 upper parent)))))
4901 lower element
4902 upper element)))))
4909 "Store ELEMENT in current buffer's cache, if allowed.
4910 When optional argument DATA is non-nil, assume is it object data
4911 relative to ELEMENT and store it in the objects cache."
4915 ;; During synchronization, first build an appropriate key
4916 ;; for the new element so `avl-tree-enter' can insert it at
4917 ;; the right spot in the cache.
4926 org-element--cache-sync-keys)))
4928 ;; Headlines are not stored in cache, so objects in titles are
4929 ;; not stored either.
4934 ;;;; Synchronization
4937 "Set idle timer for cache synchronization in BUFFER."
4944 org-element-cache-sync-idle-time))
4945 nil
4946 #'org-element--cache-sync
4947 buffer)))
4950 "Non-nil when synchronization process should be interrupted.
4951 TIME-LIMIT is a time value or nil."
4957 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4959 Properties containing buffer positions are `:begin', `:end',
4960 `:contents-begin', `:contents-end' and `:structure'. When
4961 optional argument PROPS is a list of keywords, only shift
4962 properties provided in that list.
4964 Properties are modified by side-effect."
4966 ;; Shift `:structure' property for the first plain list only: it
4967 ;; is the only one that really matters and it prevents from
4968 ;; shifting it more than once.
4982 "Synchronize cache with recent modification in BUFFER.
4983 When optional argument THRESHOLD is non-nil, do the
4984 synchronization for all elements starting before or at threshold,
4985 then exit. Otherwise, synchronize cache for as long as
4986 `org-element-cache-sync-duration' or until Emacs leaves idle
4987 state."
4998 request
5000 threshold
5003 org-element-cache-sync-duration)))
5005 ;; Request processed. Merge current and next offsets and
5006 ;; transfer phase number and ending position.
5013 ;; If more requests are awaiting, set idle timer accordingly.
5014 ;; Otherwise, reset keys.
5020 "Process synchronization REQUEST for all entries before NEXT.
5022 REQUEST is a vector, built by `org-element--cache-submit-request'.
5024 NEXT is a cache key, as returned by `org-element--cache-key'.
5026 When non-nil, THRESHOLD is a buffer position. Synchronization
5027 stops as soon as a shifted element begins after it.
5029 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5030 after this time or when Emacs exits idle state.
5032 Return nil if the process stops before completing the request,
5033 t otherwise."
5036 ;; Phase 1.
5037 ;;
5038 ;; Delete all elements starting after BEG, but not after buffer
5039 ;; position END or past element with key NEXT.
5040 ;;
5041 ;; As an exception, also delete elements starting after
5042 ;; modifications but included in an element altered by
5043 ;; modifications (orphans).
5044 ;;
5045 ;; At each iteration, we start again at tree root since
5046 ;; a deletion modifies structure of the balanced tree.
5055 ;; Find first element in cache with key BEG or after it.
5056 ;; We don't use `org-element--cache-find' because it
5057 ;; couldn't reach orphaned elements past NEXT. Moreover,
5058 ;; BEG is a key, not a buffer position.
5068 data-key key
5071 data-key key
5072 node nil)))))
5076 ;; Remove orphaned elements.
5082 up))
5086 next)))
5096 ;; Phase 2.
5097 ;;
5098 ;; Phase 1 left a hole in the parse tree. Some elements after
5099 ;; it could have parents within. For example, in the following
5100 ;; buffer:
5101 ;;
5102 ;;
5103 ;; - item
5104 ;;
5105 ;;
5106 ;; Paragraph1
5107 ;;
5108 ;; Paragraph2
5109 ;;
5110 ;;
5111 ;; if we remove a blank line between "item" and "Paragraph1",
5112 ;; everything down to "Paragraph2" is removed from cache. But
5113 ;; the paragraph now belongs to the list, and its `:parent'
5114 ;; property no longer is accurate.
5115 ;;
5116 ;; Therefore we need to parse again elements in the hole, or at
5117 ;; least in its last section, so that we can re-parent
5118 ;; subsequent elements, during phase 3.
5119 ;;
5120 ;; Note that we only need to get the parent from the first
5121 ;; element in cache after the hole.
5122 ;;
5123 ;; Also, this part can be delayed if we don't need to retrieve
5124 ;; an element after the hole.
5126 ;; Next element will start at its beginning position plus
5127 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5128 ;; contains the real beginning position of the first element
5129 ;; to shift and re-parent.
5138 ;; Phase 3.
5139 ;;
5140 ;; Shift all elements starting from key START, but before NEXT, by
5141 ;; OFFSET, and re-parent them when appropriate.
5142 ;;
5143 ;; Elements are modified by side-effect so the tree structure
5144 ;; remains intact.
5145 ;;
5146 ;; Once THRESHOLD, if any, is reached, or once there is an input
5147 ;; pending, exit. Before leaving, the current synchronization
5148 ;; request is updated.
5155 exit-flag)
5156 ;; No re-parenting nor shifting planned: request is over.
5166 ;; We reached NEXT. Request is complete.
5168 ;; Handle interruption request. Update current request.
5173 ;; Shift element.
5176 ;; Shift associated objects data, if any.
5181 ;; Re-parent it.
5187 ;; Cache is up-to-date past THRESHOLD. Request
5188 ;; interruption.
5193 ;; We reached end of tree: synchronization complete.
5194 t)))
5197 "Parse elements in current section, down to POS.
5199 Start parsing from the closest between the last known element in
5200 cache or headline above. Return the smallest element containing
5201 POS.
5203 When optional argument SYNCP is non-nil, return the parent of the
5204 element containing POS instead. In that case, it is also
5205 possible to provide TIME-LIMIT, which is a time value specifying
5206 when the parsing should stop. The function returns `interrupted'
5207 if the process stopped before finding the expected result."
5214 element next)
5216 ;; Nothing in cache before point: start parsing from first
5217 ;; element following headline above, or first element in
5218 ;; buffer.
5224 ;; Cache returned exact match: return it.
5227 ;; There's a headline between cached value and POS: cached
5228 ;; value is invalid. Start parsing from first element
5229 ;; following the headline.
5235 ;; Check if CACHED or any of its ancestors contain point.
5236 ;;
5237 ;; If there is such an element, we inspect it in order to know
5238 ;; if we return it or if we need to parse its contents.
5239 ;; Otherwise, we just start parsing from current location,
5240 ;; which is right after the top-most element containing
5241 ;; CACHED.
5242 ;;
5243 ;; As a special case, if POS is at the end of the buffer, we
5244 ;; want to return the innermost element ending there.
5245 ;;
5246 ;; Also, if we find an ancestor and discover that we need to
5247 ;; parse its contents, make sure we don't start from
5248 ;; `:contents-begin', as we would otherwise go past CACHED
5249 ;; again. Instead, in that situation, we will resume parsing
5250 ;; from NEXT, which is located after CACHED or its higher
5251 ;; ancestor not containing point.
5263 ;; Parse successively each element until we reach POS.
5269 special-flag)
5277 end 'element special-flag
5284 ;; Skip any element ending before point. Also skip
5285 ;; element ending at point (unless it is also the end of
5286 ;; buffer) since we're sure that another element begins
5287 ;; after it.
5290 ;; A non-greater element contains point: return it.
5293 ;; Otherwise, we have to decide if ELEMENT really
5294 ;; contains POS. In that case we start parsing from
5295 ;; contents' beginning.
5296 ;;
5297 ;; If POS is at contents' beginning but it is also at
5298 ;; the beginning of the first item in a list or a table.
5299 ;; In that case, we need to create an anchor for that
5300 ;; list or table, so return it.
5301 ;;
5302 ;; Also, if POS is at the end of the buffer, no element
5303 ;; can start after it, but more than one may end there.
5304 ;; Arbitrarily, we choose to return the innermost of
5305 ;; such elements.
5321 parent element
5322 end cend))))
5323 ;; Otherwise, return ELEMENT as it is the smallest
5324 ;; element containing POS.
5329 ;;;; Staging Buffer Changes
5337 "Regexp matching an element opening line.
5338 When such a line is modified, modifications may propagate after
5339 modified area. In that situation, every element between that
5348 "Regexp matching an element closing line.
5349 When such a line is modified, modifications may propagate before
5350 modified area. In that situation, every element between that
5354 "Non-nil when a sensitive line is about to be changed.
5358 "Request extension of area going to be modified if needed.
5359 BEG and END are the beginning and end of the range of changed
5360 text. See `before-change-functions' for more information."
5362 ;; Make sure buffer positions in cache are correct until END.
5371 ;; A sensitive line is a headline or a block (or drawer,
5372 ;; or latex-environment) boundary. Inserting one can
5373 ;; modify buffer drastically both above and below that
5374 ;; line, possibly making cache invalid. Therefore, we
5375 ;; need to pay attention to changes happening to them.
5379 org-element--cache-opening-line)))
5391 "Update buffer modifications for current buffer.
5392 BEG and END are the beginning and end of the range of changed
5393 text, and the length in bytes of the pre-change text replaced by
5394 that range. See `after-change-functions' for more information."
5404 ;; Determine if modified area needs to be extended,
5405 ;; according to both previous and current state. We make
5406 ;; a special case for headline editing: if a headline is
5407 ;; modified but not removed, do not extend.
5412 org-element--cache-opening-line))
5424 ;; Effectively extend modified area.
5431 ;; Store synchronization request.
5434 ;; Activate a timer to process the request during idle time.
5438 "Submit a new cache synchronization request for current buffer.
5439 BEG and END are buffer positions delimiting the minimal area
5440 where cache data should be removed. OFFSET is the size of the
5441 change, as an integer."
5443 ;; Find the position of the first element in cache to remove.
5444 ;;
5445 ;; Partially modified elements will be removed during request
5446 ;; processing. As an exception, greater elements around the
5447 ;; changes that are robust to contents modifications are
5448 ;; preserved.
5449 ;;
5450 ;; We look just before BEG because an element ending at BEG
5451 ;; needs to be removed too.
5460 drawer dynamic-block inlinetask
5461 property-drawer quote-block special-block))
5464 ;; UP is a greater element that is wrapped around
5465 ;; the changes. We only need to extend its
5466 ;; ending boundaries and those of all its
5467 ;; parents.
5473 ;; We're at top level element containing ELEMENT: if
5474 ;; it's altered by buffer modifications, it is first
5475 ;; element in cache to be removed. Otherwise, that
5476 ;; first element is the following one.
5479 ;; Changes happened before the first known element. Shift the
5480 ;; rest of the cache.
5483 org-element--cache-sync-requests))
5484 ;; There is at least an element to remove. Find position past
5485 ;; every element containing END.
5496 org-element--cache-sync-requests))
5497 ;; No element to remove. No need to re-parent either. Simply
5498 ;; shift additional elements, if any, by OFFSET.
5503 ;;;; Public Functions
5505 ;;;###autoload
5507 "Reset cache in current buffer.
5508 When optional argument ALL is non-nil, reset cache in all Org
5509 buffers. This function will do nothing if
5510 `org-element-use-cache' is nil."
5530 \f
5531 ;;; The Toolbox
5532 ;;
5533 ;; The first move is to implement a way to obtain the smallest element
5534 ;; containing point. This is the job of `org-element-at-point'. It
5535 ;; basically jumps back to the beginning of section containing point
5536 ;; and proceed, one element after the other, with
5537 ;; `org-element--current-element' until the container is found. Note:
5538 ;; When using `org-element-at-point', secondary values are never
5539 ;; parsed since the function focuses on elements, not on objects.
5540 ;;
5541 ;; At a deeper level, `org-element-context' lists all elements and
5542 ;; objects containing point.
5543 ;;
5544 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5545 ;; internally by navigation and manipulation tools.
5548 ;;;###autoload
5550 "Determine closest element around point.
5552 Return value is a list like (TYPE PROPS) where TYPE is the type
5553 of the element and PROPS a plist of properties associated to the
5554 element.
5556 Possible types are defined in `org-element-all-elements'.
5557 Properties depend on element or object type, but always include
5558 `:begin', `:end', `:parent' and `:post-blank' properties.
5560 As a special case, if point is at the very beginning of the first
5561 item in a list or sub-list, returned element will be that list
5562 instead of the item. Likewise, if point is at the beginning of
5563 the first row of a table, returned element will be the table
5564 instead of the first row.
5566 When point is at the end of the buffer, return the innermost
5567 element ending there."
5573 ;; Within blank lines at the beginning of buffer, return nil.
5575 ;; Within blank lines right after a headline, return that
5576 ;; headline.
5580 ;; Otherwise parse until we find element containing ORIGIN.
5587 ;;;###autoload
5589 "Return smallest element or object around point.
5591 Return value is a list like (TYPE PROPS) where TYPE is the type
5592 of the element or object and PROPS a plist of properties
5593 associated to it.
5595 Possible types are defined in `org-element-all-elements' and
5596 `org-element-all-objects'. Properties depend on element or
5597 object type, but always include `:begin', `:end', `:parent' and
5598 `:post-blank'.
5600 As a special case, if point is right after an object and not at
5601 the beginning of any other object, return that object.
5603 Optional argument ELEMENT, when non-nil, is the closest element
5604 containing point, as returned by `org-element-at-point'.
5605 Providing it allows for quicker computation."
5611 ;; If point is inside an element containing objects or
5612 ;; a secondary string, narrow buffer to the container and
5613 ;; proceed with parsing. Otherwise, return ELEMENT.
5615 ;; At a parsed affiliated keyword, check if we're inside main
5616 ;; or dual value.
5623 org-element-parsed-keywords))
5632 ;; Also change type to retrieve correct restrictions.
5634 ;; At an item, objects can only be located within tag, if any.
5644 ;; At an headline or inlinetask, objects are in title.
5651 ;; At a paragraph, a table-row or a verse block, objects are
5652 ;; located within their contents.
5656 ;; CBEG is nil for table rules.
5661 ;; At a parsed keyword, objects are located within value.
5664 org-element-document-properties))
5671 ;; At a planning line, if point is at a timestamp, return it,
5672 ;; otherwise, return element.
5680 ;; All other locations cannot contain objects: bail out.
5690 next object-data last)
5694 ;; When entering PARENT for the first time, get list
5695 ;; of objects within known so far. Store it in
5696 ;; OBJECT-DATA.
5701 ;; Find NEXT object for analysis.
5703 ;; If NEXT is non-nil, we already exhausted the
5704 ;; cache so we can parse buffer to find the object
5705 ;; after it.
5707 ;; Otherwise, check if cache can help us.
5718 ;; Cache contains the information needed.
5721 pos)
5723 pos)
5729 ;; If we have a new object to analyze, store it in
5730 ;; cache. Otherwise record that there is nothing
5731 ;; more to parse in this element at this depth.
5736 ;; Process NEXT, if any, in order to know if we need
5737 ;; to skip it, return it or move into it.
5744 ;; Skip objects ending before or at POS.
5747 ;; For convenience, when object ends at POS,
5748 ;; without any space, store it in LAST, as we
5749 ;; will return it if no object starts here.
5753 ;; If POS is within a container object, move
5754 ;; into that object.
5758 ;; At contents' end, if there is no
5759 ;; space before point, also move into
5760 ;; object, for consistency with
5761 ;; convenience feature above.
5768 next nil
5769 object-data nil))
5770 ;; Otherwise, return NEXT.
5772 ;; Store results in cache, if applicable.
5776 "Non-nil when elements ELEM-A and ELEM-B are nested."
5785 "Swap elements ELEM-A and ELEM-B.
5786 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5787 end of ELEM-A."
5789 ;; There are two special cases when an element doesn't start at bol:
5790 ;; the first paragraph in an item or in a footnote definition.
5792 ;; Only a paragraph without any affiliated keyword can be moved at
5793 ;; ELEM-A position in such a situation. Note that the case of
5794 ;; a footnote definition is impossible: it cannot contain two
5795 ;; paragraphs in a row because it cannot contain a blank line.
5801 ;; In a special situation, ELEM-A will have no indentation. We'll
5802 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5816 ;; Store overlays responsible for visibility status. We
5817 ;; also need to store their boundaries as they will be
5818 ;; removed from buffer.
5825 ;; Get contents.
5833 ;; Restore ex ELEM-A overlays.
5842 ;; Restore ex ELEM-B overlays.
5850 "Remove maximum common indentation in string S and return it.
5851 When optional argument N is a positive integer, remove exactly
5852 that much characters from indentation, if possible, or return
5853 S as-is otherwise. Unlike to `org-remove-indentation', this
5854 function doesn't call `untabify' on S."
5859 ;; Find maximum common indentation, if not specified.
5867 min-ind)))
5869 ;; Remove exactly N indentation, but give up if not possible.
5882 ;; Local variables:
5883 ;; generated-autoload-file: "org-loaddefs.el"
5884 ;; End:
5886 ;;; org-element.el ends here