| blob | abf5f62053cd25d5e2f395392a85b20e0aa17d42 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `export-block',
49 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
50 ;; `node-property', `paragraph', `planning', `src-block', `table',
51 ;; `table-row' and `verse-block'. Among them, `paragraph' and
52 ;; `verse-block' types can contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, greater elements and elements accepting
77 ;; affiliated keywords will have a `:post-affiliated' property,
78 ;; referring to the buffer position after all such keywords.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block section
180 special-block src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 inline-src-block italic line-break latex-fragment link macro
192 radio-target statistics-cookie strike-through subscript superscript
193 table-cell target timestamp underline verbatim)
198 table-cell underline)
208 "Alist between block names and the associated parsing function.
209 Names must be uppercase. Any block whose name has no association
215 Only these types can accept search options and an explicit
221 "List of affiliated keywords as strings.
229 "Alist of usual translations for keywords.
230 The key is the old name and the value the new one. The property
234 "List of affiliated keywords that can occur more than once in an element.
236 Their value will be consed into a list of strings, which will be
237 returned as the value of the property.
239 This list is checked after translations have been applied. See
240 `org-element-keyword-translation-alist'.
246 "List of affiliated keywords whose value can be parsed.
248 Their value will be stored as a secondary string: a list of
249 strings and objects.
251 This list is checked after translations have been applied. See
255 "List of affiliated keywords which can have a secondary value.
257 In Org syntax, they can be written with optional square brackets
258 before the colons. For example, RESULTS keyword can be
259 associated to a hash value with the following:
261 #+RESULTS[hash-string]: some-source
263 This list is checked after translations have been applied. See
267 "List of properties associated to the whole document.
268 Any keyword in this list will have its value parsed and stored as
274 ;; Dual affiliated keywords.
278 ;; Regular affiliated keywords.
284 org-element-affiliated-keywords)))
286 ;; Export attributes.
288 "Regexp matching any affiliated keyword.
290 Keyword name is put in match group 1. Moreover, if keyword
291 belongs to `org-element-dual-keywords', put the dual value in
292 match group 2.
306 ;; Ignore all links excepted plain links in a link description.
307 ;; Also ignore radio-targets and line breaks.
309 italic latex-fragment macro plain-link statistics-cookie
310 strike-through subscript superscript underline verbatim)
312 ;; Remove any variable object from radio target as it would
313 ;; prevent it from being properly recognized.
315 subscript superscript underline superscript)
319 ;; Ignore inline babel call and inline src block as formulas are
320 ;; possible. Also ignore line breaks and statistics cookies.
322 latex-fragment link macro radio-target strike-through
323 subscript superscript target timestamp underline verbatim)
327 "Alist of objects restrictions.
329 key is an element or object type containing objects and value is
330 a list of types that can be contained within an element or object
331 of such type.
333 For example, in a `radio-target' object, one can only find
334 entities, latex-fragments, subscript, superscript and text
335 markup.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents'. These
362 ;; low-level functions are useful to build a parse tree.
363 ;;
364 ;; `org-element-adopt-element', `org-element-set-element',
365 ;; `org-element-extract-element' and `org-element-insert-before' are
366 ;; high-level functions useful to modify a parse tree.
367 ;;
368 ;; `org-element-secondary-p' is a predicate used to know if a given
369 ;; object belongs to a secondary string.
372 "Return type of ELEMENT.
374 The function returns the type of the element or object provided.
375 It can also return the following special value:
376 `plain-text' for a string
377 `org-data' for a complete document
378 nil in any other case."
384 "Extract the value from the PROPERTY of an ELEMENT."
389 "Extract contents from an ELEMENT."
395 "Return restriction associated to ELEMENT.
396 ELEMENT can be an element, an object or a symbol representing an
397 element or object type."
399 org-element-object-restrictions)))
402 "In ELEMENT set PROPERTY to VALUE.
403 Return modified element."
406 element))
409 "Set ELEMENT contents to CONTENTS.
410 Return modified element."
417 "Non-nil when OBJECT belongs to a secondary string.
418 Return value is the property name, as a keyword, or nil."
421 org-element-secondary-value-alist))))
424 property)))
427 "Append elements to the contents of another element.
429 PARENT is an element or object. CHILDREN can be elements,
430 objects, or a strings.
432 The function takes care of setting `:parent' property for CHILD.
433 Return parent element."
434 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
435 ;; string: parent is the list itself.
438 children)
439 ;; Add CHILDREN at the end of PARENT contents.
442 parent
444 ;; Return modified PARENT element.
448 "Extract ELEMENT from parse tree.
449 Remove element from the parse tree by side-effect, and return it
450 with its `:parent' property stripped out."
455 parent secondary
458 parent
460 ;; Return ELEMENT with its :parent removed.
464 "Insert ELEMENT before LOCATION in parse tree.
465 LOCATION is an element, object or string within the parse tree.
466 Parse tree is modified by side effect."
471 ;; Special case: LOCATION is the first element of an
472 ;; independent secondary string (e.g. :title property). Add
473 ;; ELEMENT in-place.
477 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
487 ;; Store SIBLINGS at appropriate place in parse tree.
492 ;; Set appropriate :parent property.
496 "Replace element or object OLD with element or object NEW.
497 The function takes care of setting `:parent' property for NEW."
498 ;; Ensure OLD and NEW have the same parent.
502 ;; We cannot replace OLD with NEW since one of them is not an
503 ;; object or element. We take the long path.
506 ;; Since OLD is going to be changed into NEW by side-effect, first
507 ;; make sure that every element or object within NEW has OLD as
508 ;; parent.
511 ;; Transfer contents.
513 ;; Overwrite OLD's properties with NEW's.
515 ;; Transfer type.
519 \f
520 ;;; Greater elements
521 ;;
522 ;; For each greater element type, we define a parser and an
523 ;; interpreter.
524 ;;
525 ;; A parser returns the element or object as the list described above.
526 ;; Most of them accepts no argument. Though, exceptions exist. Hence
527 ;; every element containing a secondary string (see
528 ;; `org-element-secondary-value-alist') will accept an optional
529 ;; argument to toggle parsing of that secondary string. Moreover,
530 ;; `item' parser requires current list's structure as its first
531 ;; element.
532 ;;
533 ;; An interpreter accepts two arguments: the list representation of
534 ;; the element or object, and its contents. The latter may be nil,
535 ;; depending on the element or object considered. It returns the
536 ;; appropriate Org syntax, as a string.
537 ;;
538 ;; Parsing functions must follow the naming convention:
539 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
540 ;; defined in `org-element-greater-elements'.
541 ;;
542 ;; Similarly, interpreting functions must follow the naming
543 ;; convention: org-element-TYPE-interpreter.
544 ;;
545 ;; With the exception of `headline' and `item' types, greater elements
546 ;; cannot contain other greater elements of their own type.
547 ;;
548 ;; Beside implementing a parser and an interpreter, adding a new
549 ;; greater element requires to tweak `org-element--current-element'.
550 ;; Moreover, the newly defined type must be added to both
551 ;; `org-element-all-elements' and `org-element-greater-elements'.
554 ;;;; Center Block
557 "Parse a center block.
559 LIMIT bounds the search. AFFILIATED is a list of which CAR is
560 the buffer position at the beginning of the first affiliated
561 keyword and CDR is a plist of affiliated keywords along with
562 their value.
564 Return a list whose CAR is `center-block' and CDR is a plist
565 containing `:begin', `:end', `:contents-begin', `:contents-end',
566 `:post-blank' and `:post-affiliated' keywords.
568 Assume point is at the beginning of the block."
572 ;; Incomplete block: parse it as a paragraph.
577 ;; Empty blocks have no contents.
591 :end end
592 :contents-begin contents-begin
593 :contents-end contents-end
599 "Interpret CENTER-BLOCK element as Org syntax.
600 CONTENTS is the contents of the element."
604 ;;;; Drawer
607 "Parse a drawer.
609 LIMIT bounds the search. AFFILIATED is a list of which CAR is
610 the buffer position at the beginning of the first affiliated
611 keyword and CDR is a plist of affiliated keywords along with
612 their value.
614 Return a list whose CAR is `drawer' and CDR is a plist containing
615 `:drawer-name', `:begin', `:end', `:contents-begin',
616 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
618 Assume point is at beginning of drawer."
621 ;; Incomplete drawer: parse it as a paragraph.
629 ;; Empty drawers have no contents.
642 :end end
643 :drawer-name name
644 :contents-begin contents-begin
645 :contents-end contents-end
651 "Interpret DRAWER element as Org syntax.
652 CONTENTS is the contents of the element."
655 contents))
658 ;;;; Dynamic Block
661 "Parse a dynamic block.
663 LIMIT bounds the search. AFFILIATED is a list of which CAR is
664 the buffer position at the beginning of the first affiliated
665 keyword and CDR is a plist of affiliated keywords along with
666 their value.
668 Return a list whose CAR is `dynamic-block' and CDR is a plist
669 containing `:block-name', `:begin', `:end', `:contents-begin',
670 `:contents-end', `:arguments', `:post-blank' and
671 `:post-affiliated' keywords.
673 Assume point is at beginning of dynamic block."
677 ;; Incomplete block: parse it as a paragraph.
686 ;; Empty blocks have no contents.
699 :end end
700 :block-name name
701 :arguments arguments
702 :contents-begin contents-begin
703 :contents-end contents-end
709 "Interpret DYNAMIC-BLOCK element as Org syntax.
710 CONTENTS is the contents of the element."
715 contents))
718 ;;;; Footnote Definition
721 "Parse a footnote definition.
723 LIMIT bounds the search. AFFILIATED is a list of which CAR is
724 the buffer position at the beginning of the first affiliated
725 keyword and CDR is a plist of affiliated keywords along with
726 their value.
728 Return a list whose CAR is `footnote-definition' and CDR is
729 a plist containing `:label', `:begin' `:end', `:contents-begin',
730 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
732 Assume point is at the beginning of the footnote definition."
760 :begin begin
761 :end end
762 :contents-begin contents-begin
763 :contents-end contents-end
769 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
770 CONTENTS is the contents of the footnote-definition."
772 " "
773 contents))
776 ;;;; Headline
779 "Parse a headline.
781 Return a list whose CAR is `headline' and CDR is a plist
782 containing `:raw-value', `:title', `:alt-title', `:begin',
783 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
784 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
785 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
786 and `:footnote-section-p' keywords.
788 The plist also contains any property set in the property drawer,
789 with its name in upper cases and colons added at the
790 beginning (e.g., `:CUSTOM_ID').
792 LIMIT is a buffer position bounding the search.
794 When RAW-SECONDARY-P is non-nil, headline's title will not be
795 parsed as a secondary string, but as a plain string instead.
797 Assume point is at beginning of the headline."
810 raw-value)))
815 ;; Find property drawer associated to current headline and
816 ;; extract properties.
817 ;;
818 ;; Upcase property names. It avoids confusion between
819 ;; properties obtained through property drawer and default
820 ;; properties from the parser (e.g. `:end' and :END:)
824 plist)
830 ;; Make sure drawer is not associated
831 ;; to an inlinetask.
845 plist
850 plist)))
852 ;; Read time properties on the line below the headline.
858 org-keyword-time-not-clock-regexp end t)
868 plist))))
880 ;; Clean RAW-VALUE from any comment string.
886 ""
887 raw-value))))
888 ;; Clean TAGS from archive tag, if any.
894 :begin begin
895 :end end
896 :pre-blank
899 :contents-begin contents-begin
900 :contents-end contents-end
901 :level level
903 :tags tags
904 :todo-keyword todo
905 :todo-type todo-type
908 end)
909 :footnote-section-p footnote-section-p
910 :archivedp archivedp
912 time-props
913 standard-props))))
917 headline :alt-title
922 headline :title
928 "Interpret HEADLINE element as Org syntax.
929 CONTENTS is the contents of the element."
954 ;; Align tags.
962 ? )
963 tags))
967 tags))))
969 contents)))
972 ;;;; Inlinetask
975 "Parse an inline task.
977 Return a list whose CAR is `inlinetask' and CDR is a plist
978 containing `:title', `:begin', `:end', `:contents-begin' and
979 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
980 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
981 `:closed' and `:post-blank' keywords.
983 The plist also contains any property set in the property drawer,
984 with its name in upper cases and colons added at the
985 beginning (e.g., `:CUSTOM_ID').
987 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
988 title will not be parsed as a secondary string, but as a plain
989 string instead.
991 Assume point is at beginning of the inline task."
1007 ;; Find property drawer associated to current inlinetask
1008 ;; and extract properties.
1009 ;;
1010 ;; Upcase property names. It avoids confusion between
1011 ;; properties obtained through property drawer and default
1012 ;; properties from the parser (e.g. `:end' and :END:)
1018 org-property-start-re task-end t))
1028 plist
1033 plist))))
1035 ;; Read time properties on the line below the inlinetask
1036 ;; opening string.
1043 org-keyword-time-not-clock-regexp end t)
1053 plist)))))
1067 :begin begin
1068 :end end
1069 :contents-begin contents-begin
1070 :contents-end contents-end
1073 :tags tags
1074 :todo-keyword todo
1075 :todo-type todo-type
1077 time-props
1078 standard-props))))
1080 inlinetask :title
1083 raw-value
1085 inlinetask))))))
1088 "Interpret INLINETASK element as Org syntax.
1089 CONTENTS is the contents of inlinetask."
1104 ;; Align tags.
1112 ? )
1113 tags))
1117 tags))))
1118 ;; Prefer degenerate inlinetasks when there are no
1119 ;; contents.
1122 contents
1126 ;;;; Item
1129 "Parse an item.
1131 STRUCT is the structure of the plain list.
1133 Return a list whose CAR is `item' and CDR is a plist containing
1134 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1135 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1136 keywords.
1138 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1139 any, will not be parsed as a secondary string, but as a plain
1140 string instead.
1142 Assume point is at the beginning of the item."
1166 ;; Ignore tags in un-ordered lists: they are just
1167 ;; a part of item's body.
1173 ;; If first line isn't empty, contents really start
1174 ;; at the text after item's meta-data.
1183 :begin begin
1184 :end end
1185 ;; CONTENTS-BEGIN and CONTENTS-END may be
1186 ;; mixed up in the case of an empty item
1187 ;; separated from the next by a blank line.
1188 ;; Thus ensure the former is always the
1189 ;; smallest.
1192 :checkbox checkbox
1193 :counter counter
1194 :structure struct
1197 item :tag
1205 "Interpret ITEM element as Org syntax.
1206 CONTENTS is the contents of the element."
1216 ;; Compute indentation.
1221 ;; Indent contents.
1223 bullet
1237 ;;;; Plain List
1240 ;; Return structure of list at point. Internal function. See
1241 ;; `org-list-struct' for details.
1246 items struct)
1251 ;; At limit: end all items.
1260 ;; At list end: end all items.
1265 ;; At a new item: end previous sibling.
1277 ind
1278 bullet
1281 ;; Description tag.
1285 ;; Ending position, unknown so far.
1286 nil)))
1287 items))
1289 ;; Skip empty lines.
1291 ;; Skip inline tasks and blank lines along the way.
1298 ;; At some text line. Check if it ends any previous item.
1310 ;; Skip blocks (any type) and drawers contents.
1315 limit t)))
1321 "Parse a plain list.
1323 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1324 the buffer position at the beginning of the first affiliated
1325 keyword and CDR is a plist of affiliated keywords along with
1326 their value. STRUCTURE is the structure of the plain list being
1327 parsed.
1329 Return a list whose CAR is `plain-list' and CDR is a plist
1330 containing `:type', `:begin', `:end', `:contents-begin' and
1331 `:contents-end', `:structure', `:post-blank' and
1332 `:post-affiliated' keywords.
1334 Assume point is at the beginning of the list."
1348 pos))
1352 ;; Return value.
1356 :begin begin
1357 :end end
1358 :contents-begin contents-begin
1359 :contents-end contents-end
1360 :structure struct
1366 "Interpret PLAIN-LIST element as Org syntax.
1367 CONTENTS is the contents of the element."
1375 ;;;; Property Drawer
1378 "Parse a property drawer.
1380 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1381 the buffer position at the beginning of the first affiliated
1382 keyword and CDR is a plist of affiliated keywords along with
1383 their value.
1385 Return a list whose CAR is `property-drawer' and CDR is a plist
1386 containing `:begin', `:end', `:contents-begin', `:contents-end',
1387 `:post-blank' and `:post-affiliated' keywords.
1389 Assume point is at the beginning of the property drawer."
1394 ;; Incomplete drawer: parse it as a paragraph.
1412 :end end
1413 :contents-begin contents-begin
1414 :contents-end contents-end
1420 "Interpret PROPERTY-DRAWER element as Org syntax.
1421 CONTENTS is the properties within the drawer."
1425 ;;;; Quote Block
1428 "Parse a quote block.
1430 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1431 the buffer position at the beginning of the first affiliated
1432 keyword and CDR is a plist of affiliated keywords along with
1433 their value.
1435 Return a list whose CAR is `quote-block' and CDR is a plist
1436 containing `:begin', `:end', `:contents-begin', `:contents-end',
1437 `:post-blank' and `:post-affiliated' keywords.
1439 Assume point is at the beginning of the block."
1443 ;; Incomplete block: parse it as a paragraph.
1449 ;; Empty blocks have no contents.
1462 :end end
1463 :contents-begin contents-begin
1464 :contents-end contents-end
1470 "Interpret QUOTE-BLOCK element as Org syntax.
1471 CONTENTS is the contents of the element."
1475 ;;;; Section
1478 "Parse a section.
1480 LIMIT bounds the search.
1482 Return a list whose CAR is `section' and CDR is a plist
1483 containing `:begin', `:end', `:contents-begin', `contents-end'
1484 and `:post-blank' keywords."
1486 ;; Beginning of section is the beginning of the first non-blank
1487 ;; line after previous headline.
1496 :end end
1497 :contents-begin begin
1498 :contents-end pos-before-blank
1502 "Interpret SECTION element as Org syntax.
1503 CONTENTS is the contents of the element."
1504 contents)
1507 ;;;; Special Block
1510 "Parse a special block.
1512 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1513 the buffer position at the beginning of the first affiliated
1514 keyword and CDR is a plist of affiliated keywords along with
1515 their value.
1517 Return a list whose CAR is `special-block' and CDR is a plist
1518 containing `:type', `:begin', `:end', `:contents-begin',
1519 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1521 Assume point is at the beginning of the block."
1528 limit t)))
1529 ;; Incomplete block: parse it as a paragraph.
1535 ;; Empty blocks have no contents.
1548 :begin begin
1549 :end end
1550 :contents-begin contents-begin
1551 :contents-end contents-end
1557 "Interpret SPECIAL-BLOCK element as Org syntax.
1558 CONTENTS is the contents of the element."
1563 \f
1564 ;;; Elements
1565 ;;
1566 ;; For each element, a parser and an interpreter are also defined.
1567 ;; Both follow the same naming convention used for greater elements.
1568 ;;
1569 ;; Also, as for greater elements, adding a new element type is done
1570 ;; through the following steps: implement a parser and an interpreter,
1571 ;; tweak `org-element--current-element' so that it recognizes the new
1572 ;; type and add that new type to `org-element-all-elements'.
1573 ;;
1574 ;; As a special case, when the newly defined type is a block type,
1575 ;; `org-element-block-name-alist' has to be modified accordingly.
1578 ;;;; Babel Call
1581 "Parse a babel call.
1583 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1584 the buffer position at the beginning of the first affiliated
1585 keyword and CDR is a plist of affiliated keywords along with
1586 their value.
1588 Return a list whose CAR is `babel-call' and CDR is a plist
1589 containing `:begin', `:end', `:value', `:post-blank' and
1590 `:post-affiliated' as keywords."
1604 :end end
1605 :value value
1611 "Interpret BABEL-CALL element as Org syntax.
1612 CONTENTS is nil."
1616 ;;;; Clock
1619 "Parse a clock.
1621 LIMIT bounds the search.
1623 Return a list whose CAR is `clock' and CDR is a plist containing
1624 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1625 as keywords."
1645 :value value
1646 :duration duration
1647 :begin begin
1648 :end end
1652 "Interpret CLOCK element as Org syntax.
1653 CONTENTS is nil."
1661 "%2s:%02s"
1665 ;;;; Comment
1668 "Parse a comment.
1670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1671 the buffer position at the beginning of the first affiliated
1672 keyword and CDR is a plist of affiliated keywords along with
1673 their value.
1675 Return a list whose CAR is `comment' and CDR is a plist
1676 containing `:begin', `:end', `:value', `:post-blank',
1677 `:post-affiliated' keywords.
1679 Assume point is at comment beginning."
1688 ;; Get comments ending.
1691 ;; Accumulate lines without leading hash and first
1692 ;; whitespace.
1706 :end end
1707 :value value
1713 "Interpret COMMENT element as Org syntax.
1714 CONTENTS is nil."
1718 ;;;; Comment Block
1721 "Parse an export block.
1723 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1724 the buffer position at the beginning of the first affiliated
1725 keyword and CDR is a plist of affiliated keywords along with
1726 their value.
1728 Return a list whose CAR is `comment-block' and CDR is a plist
1729 containing `:begin', `:end', `:value', `:post-blank' and
1730 `:post-affiliated' keywords.
1732 Assume point is at comment block beginning."
1736 ;; Incomplete block: parse it as a paragraph.
1749 contents-begin contents-end)))
1753 :end end
1754 :value value
1760 "Interpret COMMENT-BLOCK element as Org syntax.
1761 CONTENTS is nil."
1766 ;;;; Diary Sexp
1769 "Parse a diary sexp.
1771 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1772 the buffer position at the beginning of the first affiliated
1773 keyword and CDR is a plist of affiliated keywords along with
1774 their value.
1776 Return a list whose CAR is `diary-sexp' and CDR is a plist
1777 containing `:begin', `:end', `:value', `:post-blank' and
1778 `:post-affiliated' keywords."
1790 :begin begin
1791 :end end
1797 "Interpret DIARY-SEXP as Org syntax.
1798 CONTENTS is nil."
1802 ;;;; Example Block
1805 "Parse an example block.
1807 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1808 the buffer position at the beginning of the first affiliated
1809 keyword and CDR is a plist of affiliated keywords along with
1810 their value.
1812 Return a list whose CAR is `example-block' and CDR is a plist
1813 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1814 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1815 `:value', `:post-blank' and `:post-affiliated' keywords."
1819 ;; Incomplete block: parse it as a paragraph.
1827 ;; Switches analysis
1834 ;; Should labels be retained in (or stripped from) example
1835 ;; blocks?
1840 ;; What should code-references use - labels or
1841 ;; line-numbers?
1850 ;; Standard block parsing.
1858 contents-begin contents-end))
1859 block-ind))
1868 :end end
1869 :value value
1870 :switches switches
1871 :number-lines number-lines
1872 :preserve-indent preserve-indent
1873 :retain-labels retain-labels
1874 :use-labels use-labels
1875 :label-fmt label-fmt
1881 "Interpret EXAMPLE-BLOCK element as Org syntax.
1882 CONTENTS is nil."
1889 value
1894 ;;;; Export Block
1897 "Parse an export block.
1899 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1900 the buffer position at the beginning of the first affiliated
1901 keyword and CDR is a plist of affiliated keywords along with
1902 their value.
1904 Return a list whose CAR is `export-block' and CDR is a plist
1905 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1906 `:post-affiliated' keywords.
1908 Assume point is at export-block beginning."
1915 ;; Incomplete block: parse it as a paragraph.
1928 contents-end)))
1932 :end end
1933 :type type
1934 :value value
1940 "Interpret EXPORT-BLOCK element as Org syntax.
1941 CONTENTS is nil."
1948 ;;;; Fixed-width
1951 "Parse a fixed-width section.
1953 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1954 the buffer position at the beginning of the first affiliated
1955 keyword and CDR is a plist of affiliated keywords along with
1956 their value.
1958 Return a list whose CAR is `fixed-width' and CDR is a plist
1959 containing `:begin', `:end', `:value', `:post-blank' and
1960 `:post-affiliated' keywords.
1962 Assume point is at the beginning of the fixed-width area."
1966 value
1971 ;; Accumulate text without starting colons.
1984 :end end
1985 :value value
1991 "Interpret FIXED-WIDTH element as Org syntax.
1992 CONTENTS is nil."
2000 ;;;; Horizontal Rule
2003 "Parse an horizontal rule.
2005 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2006 the buffer position at the beginning of the first affiliated
2007 keyword and CDR is a plist of affiliated keywords along with
2008 their value.
2010 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2011 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2012 keywords."
2022 :end end
2028 "Interpret HORIZONTAL-RULE element as Org syntax.
2029 CONTENTS is nil."
2033 ;;;; Keyword
2036 "Parse a keyword at point.
2038 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2039 the buffer position at the beginning of the first affiliated
2040 keyword and CDR is a plist of affiliated keywords along with
2041 their value.
2043 Return a list whose CAR is `keyword' and CDR is a plist
2044 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2045 `:post-affiliated' keywords."
2047 ;; An orphaned affiliated keyword is considered as a regular
2048 ;; keyword. In this case AFFILIATED is nil, so we take care of
2049 ;; this corner case.
2062 :value value
2063 :begin begin
2064 :end end
2070 "Interpret KEYWORD element as Org syntax.
2071 CONTENTS is nil."
2077 ;;;; Latex Environment
2080 "Parse a LaTeX environment.
2082 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2083 the buffer position at the beginning of the first affiliated
2084 keyword and CDR is a plist of affiliated keywords along with
2085 their value.
2087 Return a list whose CAR is `latex-environment' and CDR is a plist
2088 containing `:begin', `:end', `:value', `:post-blank' and
2089 `:post-affiliated' keywords.
2091 Assume point is at the beginning of the latex environment."
2098 limit t))
2099 ;; Incomplete latex environment: parse it as a paragraph.
2109 :end end
2110 :value value
2116 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2117 CONTENTS is nil."
2121 ;;;; Node Property
2124 "Parse a node-property at point.
2126 LIMIT bounds the search.
2128 Return a list whose CAR is `node-property' and CDR is a plist
2129 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2130 keywords."
2142 :value value
2143 :begin begin
2144 :end end
2148 "Interpret NODE-PROPERTY element as Org syntax.
2149 CONTENTS is nil."
2155 ;;;; Paragraph
2158 "Parse a paragraph.
2160 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2161 the buffer position at the beginning of the first affiliated
2162 keyword and CDR is a plist of affiliated keywords along with
2163 their value.
2165 Return a list whose CAR is `paragraph' and CDR is a plist
2166 containing `:begin', `:end', `:contents-begin' and
2167 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2169 Assume point is at the beginning of the paragraph."
2178 limit
2179 ;; A matching `org-element-paragraph-separate' is not
2180 ;; necessarily the end of the paragraph. In
2181 ;; particular, lines starting with # or : as a first
2182 ;; non-space character are ambiguous. We have to
2183 ;; check if they are valid Org syntax (e.g., not an
2184 ;; incomplete keyword).
2188 ;; There's no ambiguity for other symbols or
2189 ;; empty lines: stop here.
2191 ;; Stop at valid fixed-width areas.
2193 ;; Stop at drawers.
2198 ;; Stop at valid comments.
2200 ;; Stop at valid dynamic blocks.
2205 ;; Stop at valid blocks.
2212 limit t)))
2213 ;; Stop at valid latex environments.
2221 limit t)))
2222 ;; Stop at valid keywords.
2224 ;; Skip everything else.
2241 :end end
2242 :contents-begin contents-begin
2243 :contents-end contents-end
2249 "Interpret PARAGRAPH element as Org syntax.
2250 CONTENTS is the contents of the element."
2251 contents)
2254 ;;;; Planning
2257 "Parse a planning.
2259 LIMIT bounds the search.
2261 Return a list whose CAR is `planning' and CDR is a plist
2262 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2263 and `:post-blank' keywords."
2273 closed deadline scheduled)
2285 :deadline deadline
2286 :scheduled scheduled
2287 :begin begin
2288 :end end
2292 "Interpret PLANNING element as Org syntax.
2293 CONTENTS is nil."
2295 'identity
2312 ;;;; Src Block
2315 "Parse a src block.
2317 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2318 the buffer position at the beginning of the first affiliated
2319 keyword and CDR is a plist of affiliated keywords along with
2320 their value.
2322 Return a list whose CAR is `src-block' and CDR is a plist
2323 containing `:language', `:switches', `:parameters', `:begin',
2324 `:end', `:number-lines', `:retain-labels', `:use-labels',
2325 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2326 `:post-affiliated' keywords.
2328 Assume point is at the beginning of the block."
2331 limit t)))
2332 ;; Incomplete block: parse it as a paragraph.
2338 ;; Get language as a string.
2347 ;; Get switches.
2349 ;; Get parameters.
2351 ;; Switches analysis
2362 ;; Should labels be retained in (or stripped from)
2363 ;; src blocks?
2368 ;; What should code-references use - labels or
2369 ;; line-numbers?
2374 ;; Indentation.
2376 ;; Retrieve code.
2381 block-ind))
2385 ;; Get position after ending blank lines.
2395 :begin begin
2396 :end end
2397 :number-lines number-lines
2398 :preserve-indent preserve-indent
2399 :retain-labels retain-labels
2400 :use-labels use-labels
2401 :label-fmt label-fmt
2402 :value value
2408 "Interpret SRC-BLOCK element as Org syntax.
2409 CONTENTS is nil."
2418 val)
2432 ;;;; Table
2435 "Parse a table at point.
2437 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2438 the buffer position at the beginning of the first affiliated
2439 keyword and CDR is a plist of affiliated keywords along with
2440 their value.
2442 Return a list whose CAR is `table' and CDR is a plist containing
2443 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2444 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2445 keywords.
2447 Assume point is at the beginning of the table."
2461 acc))
2468 :end end
2469 :type type
2470 :tblfm tblfm
2471 ;; Only `org' tables have contents. `table.el' tables
2472 ;; use a `:value' property to store raw table as
2473 ;; a string.
2478 table-begin table-end))
2484 "Interpret TABLE element as Org syntax.
2485 CONTENTS is nil."
2496 ;;;; Table Row
2499 "Parse table row at point.
2501 LIMIT bounds the search.
2503 Return a list whose CAR is `table-row' and CDR is a plist
2504 containing `:begin', `:end', `:contents-begin', `:contents-end',
2505 `:type' and `:post-blank' keywords."
2509 ;; A table rule has no contents. In that case, ensure
2510 ;; CONTENTS-BEGIN matches CONTENTS-END.
2522 :begin begin
2523 :end end
2524 :contents-begin contents-begin
2525 :contents-end contents-end
2529 "Interpret TABLE-ROW element as Org syntax.
2530 CONTENTS is the contents of the table row."
2535 ;;;; Verse Block
2538 "Parse a verse block.
2540 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2541 the buffer position at the beginning of the first affiliated
2542 keyword and CDR is a plist of affiliated keywords along with
2543 their value.
2545 Return a list whose CAR is `verse-block' and CDR is a plist
2546 containing `:begin', `:end', `:contents-begin', `:contents-end',
2547 `:post-blank' and `:post-affiliated' keywords.
2549 Assume point is at beginning of the block."
2553 ;; Incomplete block: parse it as a paragraph.
2568 :end end
2569 :contents-begin contents-begin
2570 :contents-end contents-end
2576 "Interpret VERSE-BLOCK element as Org syntax.
2577 CONTENTS is verse block contents."
2581 \f
2582 ;;; Objects
2583 ;;
2584 ;; Unlike to elements, raw text can be found between objects. Hence,
2585 ;; `org-element--object-lex' is provided to find the next object in
2586 ;; buffer.
2587 ;;
2588 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2589 ;; object types they can contain will be specified in
2590 ;; `org-element-object-restrictions'.
2591 ;;
2592 ;; Creating a new type of object requires to alter
2593 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2594 ;; new type in `org-element-all-objects', and possibly add
2595 ;; restrictions in `org-element-object-restrictions'.
2597 ;;;; Bold
2600 "Parse bold object at point, if any.
2602 When at a bold object, return a list whose car is `bold' and cdr
2603 is a plist with `:begin', `:end', `:contents-begin' and
2604 `:contents-end' and `:post-blank' keywords. Otherwise, return
2605 nil.
2607 Assume point is at the first star marker."
2619 :end end
2620 :contents-begin contents-begin
2621 :contents-end contents-end
2625 "Interpret BOLD object as Org syntax.
2626 CONTENTS is the contents of the object."
2630 ;;;; Code
2633 "Parse code object at point, if any.
2635 When at a code object, return a list whose car is `code' and cdr
2636 is a plist with `:value', `:begin', `:end' and `:post-blank'
2637 keywords. Otherwise, return nil.
2639 Assume point is at the first tilde marker."
2650 :begin begin
2651 :end end
2655 "Interpret CODE object as Org syntax.
2656 CONTENTS is nil."
2660 ;;;; Entity
2663 "Parse entity at point, if any.
2665 When at an entity, return a list whose car is `entity' and cdr
2666 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2667 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2668 `:post-blank' as keywords. Otherwise, return nil.
2670 Assume point is at the beginning of the entity."
2672 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2690 :begin begin
2691 :end end
2692 :use-brackets-p bracketsp
2696 "Interpret ENTITY object as Org syntax.
2697 CONTENTS is nil."
2703 ;;;; Export Snippet
2706 "Parse export snippet at point.
2708 When at an export snippet, return a list whose car is
2709 `export-snippet' and cdr a plist with `:begin', `:end',
2710 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2711 return nil.
2713 Assume point is at the beginning of the snippet."
2729 :value value
2730 :begin begin
2731 :end end
2735 "Interpret EXPORT-SNIPPET object as Org syntax.
2736 CONTENTS is nil."
2742 ;;;; Footnote Reference
2745 "Parse footnote reference at point, if any.
2747 When at a footnote reference, return a list whose car is
2748 `footnote-reference' and cdr a plist with `:label', `:type',
2749 `:inline-definition', `:begin', `:end' and `:post-blank' as
2750 keywords. Otherwise, return nil."
2774 :type type
2775 :begin begin
2776 :end end
2779 footnote-reference :inline-definition
2784 footnote-reference))))))))
2787 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2788 CONTENTS is nil."
2798 ;;;; Inline Babel Call
2801 "Parse inline babel call at point, if any.
2803 When at an inline babel call, return a list whose car is
2804 `inline-babel-call' and cdr a plist with `:begin', `:end',
2805 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2807 Assume point is at the beginning of the babel call."
2819 :end end
2820 :value value
2824 "Interpret INLINE-BABEL-CALL object as Org syntax.
2825 CONTENTS is nil."
2829 ;;;; Inline Src Block
2832 "Parse inline source block at point, if any.
2834 When at an inline source block, return a list whose car is
2835 `inline-src-block' and cdr a plist with `:begin', `:end',
2836 `:language', `:value', `:parameters' and `:post-blank' as
2837 keywords. Otherwise, return nil.
2839 Assume point is at the beginning of the inline src block."
2852 :value value
2853 :parameters parameters
2854 :begin begin
2855 :end end
2859 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2860 CONTENTS is nil."
2865 language
2867 body)))
2869 ;;;; Italic
2872 "Parse italic object at point, if any.
2874 When at an italic object, return a list whose car is `italic' and
2875 cdr is a plist with `:begin', `:end', `:contents-begin' and
2876 `:contents-end' and `:post-blank' keywords. Otherwise, return
2877 nil.
2879 Assume point is at the first slash marker."
2891 :end end
2892 :contents-begin contents-begin
2893 :contents-end contents-end
2897 "Interpret ITALIC object as Org syntax.
2898 CONTENTS is the contents of the object."
2902 ;;;; Latex Fragment
2905 "Parse LaTeX fragment at point, if any.
2907 When at a LaTeX fragment, return a list whose car is
2908 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2909 and `:post-blank' as keywords. Otherwise, return nil.
2911 Assume point is at the beginning of the LaTeX fragment."
2925 ;; Macro.
2928 ;; No fragment found.
2936 :begin begin
2937 :end end
2941 "Interpret LATEX-FRAGMENT object as Org syntax.
2942 CONTENTS is nil."
2945 ;;;; Line Break
2948 "Parse line break at point, if any.
2950 When at a line break, return a list whose car is `line-break',
2951 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2952 Otherwise, return nil.
2954 Assume point is at the beginning of the line break."
2963 "Interpret LINE-BREAK object as Org syntax.
2964 CONTENTS is nil."
2968 ;;;; Link
2971 "Parse link at point, if any.
2973 When at a link, return a list whose car is `link' and cdr a plist
2974 with `:type', `:path', `:raw-link', `:application',
2975 `:search-option', `:begin', `:end', `:contents-begin',
2976 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2977 nil.
2979 Assume point is at the beginning of the link."
2982 end contents-begin contents-end link-end post-blank path type
2983 raw-link link search-option application)
2985 ;; Type 1: Text targeted from a radio target.
2994 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2999 ;; RAW-LINK is the original link. Expand any
3000 ;; abbreviation in it.
3004 ;; Determine TYPE of link and set PATH accordingly.
3006 ;; File type.
3010 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3013 ;; Id type: PATH is the id.
3016 ;; Code-ref type: PATH is the name of the reference.
3019 ;; Custom-id type: PATH is the name of the custom id.
3022 ;; Fuzzy type: Internal link either matches a target, an
3023 ;; headline name or nothing. PATH is the target or
3024 ;; headline's name.
3026 ;; Type 3: Plain link, e.g., http://orgmode.org
3032 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3040 ;; In any case, deduce end point after trailing white space from
3041 ;; LINK-END variable.
3045 ;; Special "file" type link processing.
3047 ;; Extract opening application and search option.
3055 ;; Normalize URI.
3059 ;; Make sure TYPE always reports "file".
3063 :path path
3065 :application application
3066 :search-option search-option
3067 :begin begin
3068 :end end
3069 :contents-begin contents-begin
3070 :contents-end contents-end
3074 "Interpret LINK object as Org syntax.
3075 CONTENTS is the contents of the object, or nil."
3080 raw-link
3084 ;;;; Macro
3087 "Parse macro at point, if any.
3089 When at a macro, return a list whose car is `macro' and cdr
3090 a plist with `:key', `:args', `:begin', `:end', `:value' and
3091 `:post-blank' as keywords. Otherwise, return nil.
3093 Assume point is at the macro."
3104 ;; Do not use `org-split-string' since empty
3105 ;; strings are meaningful here.
3113 args nil t)
3117 :value value
3118 :args args
3119 :begin begin
3120 :end end
3124 "Interpret MACRO object as Org syntax.
3125 CONTENTS is nil."
3129 ;;;; Radio-target
3132 "Parse radio target at point, if any.
3134 When at a radio target, return a list whose car is `radio-target'
3135 and cdr a plist with `:begin', `:end', `:contents-begin',
3136 `:contents-end', `:value' and `:post-blank' as keywords.
3137 Otherwise, return nil.
3139 Assume point is at the radio target."
3151 :end end
3152 :contents-begin contents-begin
3153 :contents-end contents-end
3154 :post-blank post-blank
3158 "Interpret TARGET object as Org syntax.
3159 CONTENTS is the contents of the object."
3163 ;;;; Statistics Cookie
3166 "Parse statistics cookie at point, if any.
3168 When at a statistics cookie, return a list whose car is
3169 `statistics-cookie', and cdr a plist with `:begin', `:end',
3170 `:value' and `:post-blank' keywords. Otherwise, return nil.
3172 Assume point is at the beginning of the statistics-cookie."
3183 :end end
3184 :value value
3188 "Interpret STATISTICS-COOKIE object as Org syntax.
3189 CONTENTS is nil."
3193 ;;;; Strike-Through
3196 "Parse strike-through object at point, if any.
3198 When at a strike-through object, return a list whose car is
3199 `strike-through' and cdr is a plist with `:begin', `:end',
3200 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3201 Otherwise, return nil.
3203 Assume point is at the first plus sign marker."
3215 :end end
3216 :contents-begin contents-begin
3217 :contents-end contents-end
3221 "Interpret STRIKE-THROUGH object as Org syntax.
3222 CONTENTS is the contents of the object."
3226 ;;;; Subscript
3229 "Parse subscript at point, if any.
3231 When at a subscript object, return a list whose car is
3232 `subscript' and cdr a plist with `:begin', `:end',
3233 `:contents-begin', `:contents-end', `:use-brackets-p' and
3234 `:post-blank' as keywords. Otherwise, return nil.
3236 Assume point is at the underscore."
3250 :end end
3251 :use-brackets-p bracketsp
3252 :contents-begin contents-begin
3253 :contents-end contents-end
3257 "Interpret SUBSCRIPT object as Org syntax.
3258 CONTENTS is the contents of the object."
3261 contents))
3264 ;;;; Superscript
3267 "Parse superscript at point, if any.
3269 When at a superscript object, return a list whose car is
3270 `superscript' and cdr a plist with `:begin', `:end',
3271 `:contents-begin', `:contents-end', `:use-brackets-p' and
3272 `:post-blank' as keywords. Otherwise, return nil.
3274 Assume point is at the caret."
3288 :end end
3289 :use-brackets-p bracketsp
3290 :contents-begin contents-begin
3291 :contents-end contents-end
3295 "Interpret SUPERSCRIPT object as Org syntax.
3296 CONTENTS is the contents of the object."
3299 contents))
3302 ;;;; Table Cell
3305 "Parse table cell at point.
3306 Return a list whose car is `table-cell' and cdr is a plist
3307 containing `:begin', `:end', `:contents-begin', `:contents-end'
3308 and `:post-blank' keywords."
3316 :end end
3317 :contents-begin contents-begin
3318 :contents-end contents-end
3322 "Interpret TABLE-CELL element as Org syntax.
3323 CONTENTS is the contents of the cell, or nil."
3327 ;;;; Target
3330 "Parse target at point, if any.
3332 When at a target, return a list whose car is `target' and cdr
3333 a plist with `:begin', `:end', `:value' and `:post-blank' as
3334 keywords. Otherwise, return nil.
3336 Assume point is at the target."
3346 :end end
3347 :value value
3351 "Interpret TARGET object as Org syntax.
3352 CONTENTS is nil."
3356 ;;;; Timestamp
3367 "Parse time stamp at point, if any.
3369 When at a time stamp, return a list whose car is `timestamp', and
3370 cdr a plist with `:type', `:raw-value', `:year-start',
3371 `:month-start', `:day-start', `:hour-start', `:minute-start',
3372 `:year-end', `:month-end', `:day-end', `:hour-end',
3373 `:minute-end', `:repeater-type', `:repeater-value',
3374 `:repeater-unit', `:warning-type', `:warning-value',
3375 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3376 Otherwise, return nil.
3378 Assume point is at the beginning of the timestamp."
3397 date-start)
3408 raw-value)
3410 :repeater-type
3416 :repeater-unit
3425 :warning-unit
3428 year-start month-start day-start hour-start minute-start year-end
3429 month-end day-end hour-end minute-end)
3430 ;; Parse date-start.
3438 ;; Compute date-end. It can be provided directly in time-stamp,
3439 ;; or extracted from time range. Otherwise, it defaults to the
3440 ;; same values as date-start.
3450 :raw-value raw-value
3451 :year-start year-start
3452 :month-start month-start
3453 :day-start day-start
3454 :hour-start hour-start
3455 :minute-start minute-start
3456 :year-end year-end
3457 :month-end month-end
3458 :day-end day-end
3459 :hour-end hour-end
3460 :minute-end minute-end
3461 :begin begin
3462 :end end
3464 repeater-props
3465 warning-props))))))
3468 "Interpret TIMESTAMP object as Org syntax.
3469 CONTENTS is nil."
3488 ;; Build an Org timestamp string from TIME. ACTIVEP is
3489 ;; non-nil when time stamp is active. If WITH-TIME-P is
3490 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3491 ;; specify a time range in the timestamp. REPEAT-STRING is
3492 ;; the repeater string, if any.
3496 org-time-stamp-formats)
3497 time)))
3503 nil nil ts)))
3508 " "
3509 s
3511 ;; Return value.
3512 ts)))
3524 build-ts-string
3543 0
3551 "--"
3563 ;;;; Underline
3566 "Parse underline object at point, if any.
3568 When at an underline object, return a list whose car is
3569 `underline' and cdr is a plist with `:begin', `:end',
3570 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3571 Otherwise, return nil.
3573 Assume point is at the first underscore marker."
3585 :end end
3586 :contents-begin contents-begin
3587 :contents-end contents-end
3591 "Interpret UNDERLINE object as Org syntax.
3592 CONTENTS is the contents of the object."
3596 ;;;; Verbatim
3599 "Parse verbatim object at point, if any.
3601 When at a verbatim object, return a list whose car is `verbatim'
3602 and cdr is a plist with `:value', `:begin', `:end' and
3603 `:post-blank' keywords. Otherwise, return nil.
3605 Assume point is at the first equal sign marker."
3616 :begin begin
3617 :end end
3621 "Interpret VERBATIM object as Org syntax.
3622 CONTENTS is nil."
3626 \f
3627 ;;; Parsing Element Starting At Point
3628 ;;
3629 ;; `org-element--current-element' is the core function of this section.
3630 ;; It returns the Lisp representation of the element starting at
3631 ;; point.
3632 ;;
3633 ;; `org-element--current-element' makes use of special modes. They
3634 ;; are activated for fixed element chaining (e.g., `plain-list' >
3635 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3636 ;; `section'). Special modes are: `first-section', `item',
3637 ;; `node-property', `section' and `table-row'.
3641 "Parse the element starting at point.
3643 Return value is a list like (TYPE PROPS) where TYPE is the type
3644 of the element and PROPS a plist of properties associated to the
3645 element.
3647 Possible types are defined in `org-element-all-elements'.
3649 LIMIT bounds the search.
3651 Optional argument GRANULARITY determines the depth of the
3652 recursion. Allowed values are `headline', `greater-element',
3653 `element', `object' or nil. When it is broader than `object' (or
3654 nil), secondary values will not be parsed, since they only
3655 contain objects.
3657 Optional argument SPECIAL, when non-nil, can be either
3658 `first-section', `item', `node-property', `section', and
3659 `table-row'.
3661 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3662 be computed.
3664 This function assumes point is always at the beginning of the
3665 element it has to parse."
3668 ;; Determine if parsing depth allows for secondary strings
3669 ;; parsing. It only applies to elements referenced in
3670 ;; `org-element-secondary-value-alist'.
3673 ;; Item.
3676 ;; Table Row.
3678 ;; Node Property.
3680 ;; Headline.
3683 ;; Sections (must be checked after headline).
3688 limit)))
3689 ;; When not at bol, point is at the beginning of an item or
3690 ;; a footnote definition: next item is always a paragraph.
3692 ;; Planning and Clock.
3697 ;; Inlinetask.
3700 ;; From there, elements can have affiliated keywords.
3703 ;; Jumping over affiliated keywords put point off-limits.
3704 ;; Parse them as regular keywords.
3708 ;; LaTeX Environment.
3712 ;; Drawer and Property Drawer.
3717 ;; Fixed Width
3720 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3721 ;; Keywords.
3730 org-element-block-name-alist)))
3745 ;; Footnote Definition.
3748 ;; Horizontal Rule.
3751 ;; Diary Sexp.
3754 ;; Table.
3756 ;; List.
3759 limit affiliated
3761 ;; Default element: Paragraph.
3765 ;; Most elements can have affiliated keywords. When looking for an
3766 ;; element beginning, we want to move before them, as they belong to
3767 ;; that element, and, in the meantime, collect information they give
3768 ;; into appropriate properties. Hence the following function.
3771 "Collect affiliated keywords from point down to LIMIT.
3773 Return a list whose CAR is the position at the first of them and
3774 CDR a plist of keywords and values and move point to the
3775 beginning of the first line after them.
3777 As a special case, if element doesn't start at the beginning of
3778 the line (e.g., a paragraph starting an item), CAR is current
3779 position of point and CDR is nil."
3783 ;; RESTRICT is the list of objects allowed in parsed
3784 ;; keywords value.
3786 output)
3789 ;; Apply translation to RAW-KWD. From there, KWD is
3790 ;; the official keyword.
3792 org-element-keyword-translation-alist))
3793 raw-kwd))
3794 ;; Find main value for any keyword.
3800 ;; PARSEDP is non-nil when keyword should have its
3801 ;; value parsed.
3803 ;; If KWD is a dual keyword, find its secondary
3804 ;; value. Maybe parse it.
3811 ;; Attribute a property name to KWD.
3813 ;; Now set final shape for VALUE.
3819 ;; Attributes can always appear on multiple lines.
3822 ;; Eventually store the new value in OUTPUT.
3824 ;; Move to next keyword.
3826 ;; If affiliated keywords are orphaned: move back to first one.
3827 ;; They will be parsed as a paragraph.
3829 ;; Return value.
3833 \f
3834 ;;; The Org Parser
3835 ;;
3836 ;; The two major functions here are `org-element-parse-buffer', which
3837 ;; parses Org syntax inside the current buffer, taking into account
3838 ;; region, narrowing, or even visibility if specified, and
3839 ;; `org-element-parse-secondary-string', which parses objects within
3840 ;; a given string.
3841 ;;
3842 ;; The (almost) almighty `org-element-map' allows to apply a function
3843 ;; on elements or objects matching some type, and accumulate the
3844 ;; resulting values. In an export situation, it also skips unneeded
3845 ;; parts of the parse tree.
3848 "Recursively parse the buffer and return structure.
3849 If narrowing is in effect, only parse the visible part of the
3850 buffer.
3852 Optional argument GRANULARITY determines the depth of the
3853 recursion. It can be set to the following symbols:
3855 `headline' Only parse headlines.
3856 `greater-element' Don't recurse into greater elements excepted
3857 headlines and sections. Thus, elements
3858 parsed are the top-level ones.
3859 `element' Parse everything but objects and plain text.
3860 `object' Parse the complete buffer (default).
3862 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3863 elements.
3865 An element or an objects is represented as a list with the
3866 pattern (TYPE PROPERTIES CONTENTS), where :
3868 TYPE is a symbol describing the element or object. See
3869 `org-element-all-elements' and `org-element-all-objects' for an
3870 exhaustive list of such symbols. One can retrieve it with
3871 `org-element-type' function.
3873 PROPERTIES is the list of attributes attached to the element or
3874 object, as a plist. Although most of them are specific to the
3875 element or object type, all types share `:begin', `:end',
3876 `:post-blank' and `:parent' properties, which respectively
3877 refer to buffer position where the element or object starts,
3878 ends, the number of white spaces or blank lines after it, and
3879 the element or object containing it. Properties values can be
3880 obtained by using `org-element-property' function.
3882 CONTENTS is a list of elements, objects or raw strings
3883 contained in the current element or object, when applicable.
3884 One can access them with `org-element-contents' function.
3886 The Org buffer has `org-data' as type and nil as properties.
3887 `org-element-map' function can be used to find specific elements
3888 or objects within the parse tree.
3890 This function assumes that current major mode is `org-mode'."
3896 ;; Start in `first-section' mode so text before the first
3897 ;; headline belongs to a section.
3901 "Recursively parse objects in STRING and return structure.
3903 RESTRICTION is a symbol limiting the object types that will be
3904 looked after.
3906 Optional argument PARENT, when non-nil, is the element or object
3907 containing the secondary string. It is used to set correctly
3908 `:parent' property within the string."
3909 ;; Copy buffer-local variables listed in
3910 ;; `org-element-object-variables' into temporary buffer. This is
3911 ;; required since object parsing is dependent on these variables.
3915 org-element-object-variables))))
3923 secondary))
3924 secondary))))
3928 "Map a function on selected elements or objects.
3930 DATA is a parse tree, an element, an object, a string, or a list
3931 of such constructs. TYPES is a symbol or list of symbols of
3932 elements or objects types (see `org-element-all-elements' and
3933 `org-element-all-objects' for a complete list of types). FUN is
3934 the function called on the matching element or object. It has to
3935 accept one argument: the element or object itself.
3937 When optional argument INFO is non-nil, it should be a plist
3938 holding export options. In that case, parts of the parse tree
3939 not exportable according to that property list will be skipped.
3941 When optional argument FIRST-MATCH is non-nil, stop at the first
3942 match for which FUN doesn't return nil, and return that value.
3944 Optional argument NO-RECURSION is a symbol or a list of symbols
3945 representing elements or objects types. `org-element-map' won't
3946 enter any recursive element or object whose type belongs to that
3947 list. Though, FUN can still be applied on them.
3949 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3950 apply to matching objects within parsed affiliated keywords (see
3951 `org-element-parsed-keywords').
3953 Nil values returned from FUN do not appear in the results.
3956 Examples:
3957 ---------
3959 Assuming TREE is a variable containing an Org buffer parse tree,
3960 the following example will return a flat list of all `src-block'
3961 and `example-block' elements in it:
3963 \(org-element-map tree '(example-block src-block) 'identity)
3965 The following snippet will find the first headline with a level
3968 \(org-element-map tree 'headline
3969 \(lambda (hl)
3970 \(and (= (org-element-property :level hl) 1)
3972 \(org-element-property :begin hl)))
3973 nil t)
3975 The next example will return a flat list of all `plain-list' type
3976 elements in TREE that are not a sub-list themselves:
3978 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3980 Eventually, this example will return a flat list of all `bold'
3981 type objects containing a `latex-snippet' type object, even
3982 looking into captions:
3984 \(org-element-map tree 'bold
3985 \(lambda (b)
3986 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3987 nil nil nil t)"
3988 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3991 ;; Recursion depth is determined by --CATEGORY.
3998 ;; If one object is found, the function
3999 ;; has to recurse into every object.
4002 ;; If one regular element is found, the
4003 ;; function has to recurse, at least,
4004 ;; into every element it encounters.
4007 types)
4008 category)))
4009 ;; Compute properties for affiliated keywords if necessary.
4014 org-element-affiliated-keywords)))
4015 --acc
4016 --walk-tree
4020 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4021 ;; holding contextual information.
4025 ;; Ignored element in an export context.
4027 ;; List of elements or objects.
4029 ;; Unconditionally enter parse trees.
4033 ;; Check if TYPE is matching among TYPES. If so,
4034 ;; apply FUN to --DATA and accumulate return value
4035 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4041 ;; If --DATA has a secondary string that can contain
4042 ;; objects with their type among TYPES, look into it.
4049 ;; If --DATA has any affiliated keywords and
4050 ;; WITH-AFFILIATED is non-nil, look for objects in
4051 ;; them.
4059 ;; Pay attention to the type of value.
4060 ;; Preserve order for multiple keywords.
4076 --affiliated-alist))
4077 ;; Determine if a recursion into --DATA is possible.
4079 ;; --TYPE is explicitly removed from recursion.
4081 ;; --DATA has no contents.
4083 ;; Looking for greater elements but --DATA is simply
4084 ;; an element or an object.
4087 ;; Looking for elements but --DATA is an object.
4090 ;; In any other case, map contents.
4094 ;; Return value in a proper order.
4098 ;; The following functions are internal parts of the parser.
4099 ;;
4100 ;; The first one, `org-element--parse-elements' acts at the element's
4101 ;; level.
4102 ;;
4103 ;; The second one, `org-element--parse-objects' applies on all objects
4104 ;; of a paragraph or a secondary string.
4105 ;;
4106 ;; More precisely, that function looks for every allowed object type
4107 ;; first. Then, it discards failed searches, keeps further matches,
4108 ;; and searches again types matched behind point, for subsequent
4109 ;; calls. Thus, searching for a given type fails only once, and every
4110 ;; object is searched only once at top level (but sometimes more for
4111 ;; nested types).
4115 "Parse elements between BEG and END positions.
4117 SPECIAL prioritize some elements over the others. It can be set
4118 to `first-section', `section' `item' or `table-row'.
4120 When value is `item', STRUCTURE will be used as the current list
4121 structure.
4123 GRANULARITY determines the depth of the recursion. See
4124 `org-element-parse-buffer' for more information.
4126 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4127 elements.
4129 Elements are accumulated into ACC."
4132 ;; Visible only: skip invisible parts at the beginning of the
4133 ;; element.
4136 ;; When parsing only headlines, skip any text before first one.
4139 ;; Main loop start.
4141 ;; Find current element's type and parse it accordingly to
4142 ;; its category.
4144 end granularity special structure))
4148 ;; Visible only: skip invisible parts between siblings.
4151 ;; Fill ELEMENT contents by side-effect.
4153 ;; If element has no contents, don't modify it.
4155 ;; Greater element: parse it between `contents-begin' and
4156 ;; `contents-end'. Make sure GRANULARITY allows the
4157 ;; recursion, or ELEMENT is a headline, in which case going
4158 ;; inside is mandatory, in order to get sub-level headings.
4166 ;; Possibly switch to a special mode.
4174 granularity visible-only element))
4175 ;; ELEMENT has contents. Parse objects inside, if
4176 ;; GRANULARITY allows it.
4182 ;; Return result.
4183 acc))
4189 ;; Sub/superscript.
4191 ;; Bold, code, italic, strike-through, underline and
4192 ;; verbatim.
4195 ;; Plain links.
4197 ;; Objects starting with "[": regular link, footnote
4198 ;; reference, statistics cookie, timestamp (inactive).
4200 ;; Objects starting with "@": export snippets.
4201 "@@"
4202 ;; Objects starting with "{": macro.
4203 "{{{"
4204 ;; Objects starting with "<" : timestamp (active,
4205 ;; diary), target, radio target and angular links.
4207 ;; Objects starting with "$": latex fragment.
4209 ;; Objects starting with "\": line break, entity,
4210 ;; latex fragment.
4212 ;; Objects starting with raw text: inline Babel
4213 ;; source block, inline Babel call.
4216 "Regexp possibly matching the beginning of an object.
4217 This regexp allows false positives. Dedicated parser (e.g.,
4218 `org-export-bold-parser') will take care of further filtering.
4219 Radio links are not matched by this regexp, as they are treated
4223 "Return next object in current buffer or nil.
4224 RESTRICTION is a list of object types, as symbols, that should be
4225 looked after. This function assumes that the buffer is narrowed
4226 to an appropriate container (e.g., a paragraph)."
4234 found)
4297 ;; This is probably a plain link.
4303 ;; Radio link.
4308 "Parse objects between BEG and END and return recursive structure.
4310 Objects are accumulated in ACC.
4312 RESTRICTION is a list of object successors which are allowed in
4313 the current object."
4321 ;; 1. Text before any object. Untabify it.
4326 acc
4330 ;; 2. Object...
4333 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4334 ;; a recursive type.
4342 ;; 3. Text after last object. Untabify it.
4346 acc
4350 ;; Result.
4351 acc)))
4354 \f
4355 ;;; Towards A Bijective Process
4356 ;;
4357 ;; The parse tree obtained with `org-element-parse-buffer' is really
4358 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4359 ;; interpreted and expanded into a string with canonical Org syntax.
4360 ;; Hence `org-element-interpret-data'.
4361 ;;
4362 ;; The function relies internally on
4363 ;; `org-element--interpret-affiliated-keywords'.
4365 ;;;###autoload
4367 "Interpret DATA as Org syntax.
4369 DATA is a parse tree, an element, an object or a secondary string
4370 to interpret.
4372 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4373 new types that should be treated as objects. An unknown type not
4374 belonging to this list is seen as a pseudo-element instead. Both
4375 pseudo-objects and pseudo-elements are transparent entities, i.e.
4376 only their contents are interpreted.
4378 Return Org syntax as a string."
4382 "Interpret DATA as Org syntax.
4384 DATA is a parse tree, an element, an object or a secondary string
4385 to interpret. PARENT is used for recursive calls. It contains
4386 the element or object containing data, or nil. PSEUDO-OBJECTS
4387 are list of symbols defining new element or object types.
4388 Unknown types that don't belong to this list are treated as
4389 pseudo-elements instead.
4391 Return Org syntax as a string."
4393 ;; Find interpreter for current object or element. If it
4394 ;; doesn't exist (e.g. this is a pseudo object or element),
4395 ;; return contents, if any.
4401 ;; Secondary string.
4407 ;; Full Org document.
4413 ;; Plain text: return it.
4415 ;; Element or object without contents.
4417 ;; Element or object with contents.
4420 ;; Recursively interpret contents.
4426 data
4427 ;; Fix indentation of elements containing
4428 ;; objects. We ignore `table-row' elements
4429 ;; as they are one line long anyway.
4431 data
4432 ;; When normalizing first paragraph of an
4433 ;; item or a footnote-definition, ignore
4434 ;; first line's indentation.
4441 ;; Build white spaces. If no `:post-blank' property is
4442 ;; specified, assume its value is 0.
4453 "Return ELEMENT's affiliated keywords as Org syntax.
4454 If there is no affiliated keyword, return the empty string."
4464 ": "
4467 value)
4475 ;; All attribute keywords can have multiple lines.
4481 ;; List all ELEMENT's properties matching an attribute line or an
4482 ;; affiliated keyword, but ignore translated keywords since they
4483 ;; cannot belong to the property list.
4490 org-element-keyword-translation-alist)))))
4491 collect prop)
4494 ;; Because interpretation of the parse tree must return the same
4495 ;; number of blank lines between elements and the same number of white
4496 ;; space after objects, some special care must be given to white
4497 ;; spaces.
4498 ;;
4499 ;; The first function, `org-element-normalize-string', ensures any
4500 ;; string different from the empty string will end with a single
4501 ;; newline character.
4502 ;;
4503 ;; The second function, `org-element-normalize-contents', removes
4504 ;; global indentation from the contents of the current element.
4507 "Ensure string S ends with a single newline character.
4509 If S isn't a string return it unchanged. If S is the empty
4510 string, return it. Otherwise, return a new string with a single
4511 newline character at its end."
4519 "Normalize plain text in ELEMENT's contents.
4521 ELEMENT must only contain plain text and objects.
4523 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4524 indentation to compute maximal common indentation.
4526 Return the normalized element that is element with global
4527 indentation removed from its contents. The function assumes that
4528 indentation is not done with TAB characters."
4530 find-min-ind ; For byte-compiler.
4533 ;; Return minimal common indentation within BLOB. This is
4534 ;; done by walking recursively BLOB and updating MIN-IND
4535 ;; along the way. FIRST-FLAG is non-nil when the first
4536 ;; string hasn't been seen yet. It is required as this
4537 ;; string is the only one whose indentation doesn't happen
4538 ;; after a newline character.
4545 ;; An indentation of zero means no string will be
4546 ;; modified. Quit the process.
4555 ;; Find minimal indentation in ELEMENT.
4558 ;; Build ELEMENT back, replacing each string with the same
4559 ;; string minus common indentation.
4564 ;; Return BLOB with all its strings indentation
4565 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4566 ;; is non-nil when the first string hasn't been seen
4567 ;; yet.
4582 org-element-recursive-objects)
4586 blob))))
4590 \f
4591 ;;; Cache
4592 ;;
4593 ;; Implement a caching mechanism for `org-element-at-point' and
4594 ;; `org-element-context', which see.
4595 ;;
4596 ;; A single public function is provided: `org-element-cache-reset'.
4597 ;;
4598 ;; Cache is enabled by default, but can be disabled globally with
4599 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4600 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4601 ;; can be tweaked to control caching behaviour.
4602 ;;
4603 ;; Internally, parsed elements are stored in an AVL tree,
4604 ;; `org-element--cache'. This tree is updated lazily: whenever
4605 ;; a change happens to the buffer, a synchronization request is
4606 ;; registered in `org-element--cache-sync-requests' (see
4607 ;; `org-element--cache-submit-request'). During idle time, requests
4608 ;; are processed by `org-element--cache-sync'. Synchronization also
4609 ;; happens when an element is required from the cache. In this case,
4610 ;; the process stops as soon as the needed element is up-to-date.
4611 ;;
4612 ;; A synchronization request can only apply on a synchronized part of
4613 ;; the cache. Therefore, the cache is updated at least to the
4614 ;; location where the new request applies. Thus, requests are ordered
4615 ;; from left to right and all elements starting before the first
4616 ;; request are correct. This property is used by functions like
4617 ;; `org-element--cache-find' to retrieve elements in the part of the
4618 ;; cache that can be trusted.
4619 ;;
4620 ;; A request applies to every element, starting from its original
4621 ;; location (or key, see below). When a request is processed, it
4622 ;; moves forward and may collide the next one. In this case, both
4623 ;; requests are merged into a new one that starts from that element.
4624 ;; As a consequence, the whole synchronization complexity does not
4625 ;; depend on the number of pending requests, but on the number of
4626 ;; elements the very first request will be applied on.
4627 ;;
4628 ;; Elements cannot be accessed through their beginning position, which
4629 ;; may or may not be up-to-date. Instead, each element in the tree is
4630 ;; associated to a key, obtained with `org-element--cache-key'. This
4631 ;; mechanism is robust enough to preserve total order among elements
4632 ;; even when the tree is only partially synchronized.
4633 ;;
4634 ;; Objects contained in an element are stored in a hash table,
4635 ;; `org-element--cache-objects'.
4639 "Non nil when Org parser should cache its results.
4646 "Maximum duration, as a time value, for a cache synchronization.
4647 If the synchronization is not over after this delay, the process
4648 pauses and resumes after `org-element-cache-sync-break'
4652 "Duration, as a time value, of the pause between synchronizations.
4656 ;;;; Data Structure
4659 "AVL tree used to cache elements.
4660 Each node of the tree contains an element. Comparison is done
4661 with `org-element--cache-compare'. This cache is used in
4665 "Hash table used as to cache objects.
4666 Key is an element, as returned by `org-element-at-point', and
4667 value is an alist where each association is:
4669 \(PARENT COMPLETEP . OBJECTS)
4671 where PARENT is an element or object, COMPLETEP is a boolean,
4672 non-nil when all direct children of parent are already cached and
4673 OBJECTS is a list of such children, as objects, from farthest to
4674 closest.
4677 contained within a paragraph
4681 If the paragraph is completely parsed, OBJECTS-DATA will be
4683 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4684 \(BOLD-OBJECT t ENTITY-OBJECT))
4686 whereas in a partially parsed paragraph, it could be
4688 \((PARAGRAPH nil ENTITY-OBJECT))
4693 "List of pending synchronization requests.
4695 A request is a vector with the following pattern:
4697 \[NEXT BEG END OFFSET PARENT PHASE]
4699 Processing a synchronization request consists of three phases:
4701 0. Delete modified elements,
4702 1. Fill missing area in cache,
4703 2. Shift positions and re-parent elements after the changes.
4705 During phase 0, NEXT is the key of the first element to be
4706 removed, BEG and END is buffer position delimiting the
4707 modifications. Every element starting between these are removed.
4708 PARENT is an element to be removed. Every element contained in
4709 it will also be removed.
4711 During phase 1, NEXT is the key of the next known element in
4712 cache. Parse buffer between that element and the one before it
4713 in order to determine the parent of the next element. Set PARENT
4714 to the element containing NEXT.
4716 During phase 2, NEXT is the key of the next element to shift in
4717 the parse tree. All elements starting from this one have their
4718 properties relatives to buffer positions shifted by integer
4719 OFFSET and, if they belong to element PARENT, are adopted by it.
4727 "Hash table used to store keys during synchronization.
4731 "Return a unique key for ELEMENT in cache tree.
4733 Keys are used to keep a total order among elements in the cache.
4734 Comparison is done with `org-element--cache-key-less-p'.
4736 When no synchronization is taking place, a key is simply the
4737 beginning position of the element, or that position plus one in
4738 the case of an first item (respectively row) in
4739 a list (respectively a table).
4741 During a synchronization, the key is the one the element had when
4742 the cache was synchronized for the last time. Elements added to
4743 cache during the synchronization get a new key generated with
4744 `org-element--cache-generate-key'.
4746 Such keys are stored in `org-element--cache-sync-keys'. The hash
4747 table is cleared once the synchronization is complete."
4750 ;; Increase beginning position of items (respectively
4751 ;; table rows) by one, so the first item can get
4752 ;; a different key from its parent list (respectively
4753 ;; table).
4756 begin)))
4759 key))))
4762 "Default value for a new key level.
4766 "Generate a key between LOWER and UPPER.
4768 LOWER and UPPER are integers or lists, possibly empty.
4770 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4771 a unique key, as an integer or a list of integers, according to
4772 the following rules:
4774 - LOWER and UPPER are compared level-wise until values differ.
4776 - If, at a given level, LOWER and UPPER differ from more than
4777 2, the new key shares all the levels above with LOWER and
4778 gets a new level. Its value is the mean between LOWER and
4779 UPPER.
4781 \(1 2) + (1 4) --> (1 3)
4783 - If LOWER has no value to compare with, it is assumed that its
4784 value is 0:
4786 \(1 1) + (1 1 2) --> (1 1 1)
4788 Likewise, if UPPER is short of levels, the current value is
4789 `most-positive-fixnum'.
4791 - If they differ from only one, the new key inherits from
4792 current LOWER lever and has a new level at the value
4793 `org-element--cache-default-key'.
4795 \(1 2) + (1 3) --> (1 2 org-element--cache-default-key)
4797 - If the key is only one level long, it is returned as an
4798 integer.
4800 \(1 2) + (3 2) --> 2"
4804 key)
4822 org-element--cache-default-key))
4823 org-element--cache-default-key)
4824 key)
4830 key)
4837 ;; (n) is equivalent to (n 0 0 0 0 ...) so we forbid ending
4838 ;; sequences on 0.
4851 org-element--cache-default-key)))
4852 key))))
4853 ;; Ensure we don't return a list with a single element.
4857 "Non-nil if key A is less than key B.
4858 A and B are either integers or lists of integers, as returned by
4859 `org-element--cache-key'."
4867 ;; If A is empty, either keys are equal (B is also empty) or
4868 ;; B is less than A (B is longer). Therefore return nil.
4869 ;;
4870 ;; If A is not empty, B is necessarily empty and A is less
4871 ;; than B (A is longer). Therefore, return a non-nil value.
4872 a))))
4875 "Non-nil when element A is located before element B."
4880 "Return root value in cache.
4881 This function assumes `org-element--cache' is a valid AVL tree."
4885 ;;;; Tools
4888 "Non-nil when cache is active in current buffer."
4893 "Find element in cache starting at POS or before.
4895 POS refers to a buffer position.
4897 When optional argument SIDE is non-nil, the function checks for
4898 elements starting at or past POS instead. If SIDE is `both', the
4899 function returns a cons cell where car is the first element
4900 starting at or before POS and cdr the first element starting
4901 after POS.
4903 The function can only find elements in the synchronized part of
4904 the cache."
4908 lower upper)
4923 ;; We found an element in cache starting at POS. If `side'
4924 ;; is `both' we also want the next one in order to generate
4925 ;; a key in-between.
4926 ;;
4927 ;; If the element is the first row or item in a table or
4928 ;; a plain list, we always return the table or the plain
4929 ;; list.
4930 ;;
4931 ;; In any other case, we return the element found.
4940 lower parent
4941 upper parent)))))
4944 lower element
4945 upper element)))))
4952 "Store ELEMENT in current buffer's cache, if allowed.
4953 When optional argument DATA is non-nil, assume is it object data
4954 relative to ELEMENT and store it in the objects cache."
4958 ;; During synchronization, first build an appropriate key
4959 ;; for the new element so `avl-tree-enter' can insert it at
4960 ;; the right spot in the cache.
4969 org-element--cache-sync-keys)))
4971 ;; Headlines are not stored in cache, so objects in titles are
4972 ;; not stored either.
4977 "Remove ELEMENT from cache.
4978 Assume ELEMENT belongs to cache and that a cache is active."
4983 ;;;; Synchronization
4986 "Set idle timer for cache synchronization in BUFFER."
4993 org-element-cache-sync-idle-time))
4994 nil
4995 #'org-element--cache-sync
4996 buffer)))
4999 "Non-nil when synchronization process should be interrupted.
5000 TIME-LIMIT is a time value or nil."
5006 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5008 Properties containing buffer positions are `:begin', `:end',
5009 `:contents-begin', `:contents-end' and `:structure'. When
5010 optional argument PROPS is a list of keywords, only shift
5011 properties provided in that list.
5013 Properties are modified by side-effect."
5015 ;; Shift `:structure' property for the first plain list only: it
5016 ;; is the only one that really matters and it prevents from
5017 ;; shifting it more than once.
5031 "Synchronize cache with recent modification in BUFFER.
5033 When optional argument THRESHOLD is non-nil, do the
5034 synchronization for all elements starting before or at threshold,
5035 then exit. Otherwise, synchronize cache for as long as
5036 `org-element-cache-sync-duration' or until Emacs leaves idle
5037 state.
5039 EXTRA, when non-nil, is an additional offset for changes not
5040 registered yet in the cache. It is used in
5041 `org-element--cache-submit-request', where cache is partially
5042 updated before current modification are actually submitted."
5053 request
5055 threshold
5058 org-element-cache-sync-duration))
5060 ;; Request processed. Merge current and next offsets and
5061 ;; transfer phase number and ending position.
5068 ;; If more requests are awaiting, set idle timer accordingly.
5069 ;; Otherwise, reset keys.
5076 "Process synchronization REQUEST for all entries before NEXT.
5078 REQUEST is a vector, built by `org-element--cache-submit-request'.
5080 NEXT is a cache key, as returned by `org-element--cache-key'.
5082 When non-nil, THRESHOLD is a buffer position. Synchronization
5083 stops as soon as a shifted element begins after it.
5085 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5086 after this time or when Emacs exits idle state.
5088 EXTRA is an additional offset taking into consideration changes
5089 not registered yet. See `org-element--cache-submit-request' for
5090 more information.
5092 Throw `interrupt' if the process stops before completing the
5093 request."
5096 ;; Phase 1.
5097 ;;
5098 ;; Delete all elements starting after BEG, but not after buffer
5099 ;; position END or past element with key NEXT.
5100 ;;
5101 ;; As an exception, also delete elements starting after
5102 ;; modifications but included in an element altered by
5103 ;; modifications (orphans).
5104 ;;
5105 ;; At each iteration, we start again at tree root since
5106 ;; a deletion modifies structure of the balanced tree.
5115 ;; Find first element in cache with key BEG or after it.
5116 ;; We don't use `org-element--cache-find' because it
5117 ;; couldn't reach orphaned elements past NEXT. Moreover,
5118 ;; BEG is a key, not a buffer position.
5128 data-key key
5131 data-key key
5132 node nil)))))
5136 ;; Remove orphaned elements.
5142 up))
5146 next)))
5156 ;; Phase 2.
5157 ;;
5158 ;; Phase 1 left a hole in the parse tree. Some elements after
5159 ;; it could have parents within. For example, in the following
5160 ;; buffer:
5161 ;;
5162 ;;
5163 ;; - item
5164 ;;
5165 ;;
5166 ;; Paragraph1
5167 ;;
5168 ;; Paragraph2
5169 ;;
5170 ;;
5171 ;; if we remove a blank line between "item" and "Paragraph1",
5172 ;; everything down to "Paragraph2" is removed from cache. But
5173 ;; the paragraph now belongs to the list, and its `:parent'
5174 ;; property no longer is accurate.
5175 ;;
5176 ;; Therefore we need to parse again elements in the hole, or at
5177 ;; least in its last section, so that we can re-parent
5178 ;; subsequent elements, during phase 3.
5179 ;;
5180 ;; Note that we only need to get the parent from the first
5181 ;; element in cache after the hole.
5182 ;;
5183 ;; Also, this part can be delayed if we don't need to retrieve
5184 ;; an element after the hole.
5186 ;; Next element will start at its beginning position plus
5187 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5188 ;; contains the real beginning position of the first element
5189 ;; to shift and re-parent.
5197 ;; Phase 3.
5198 ;;
5199 ;; Shift all elements starting from key START, but before NEXT, by
5200 ;; OFFSET, and re-parent them when appropriate.
5201 ;;
5202 ;; Elements are modified by side-effect so the tree structure
5203 ;; remains intact.
5204 ;;
5205 ;; Once THRESHOLD, if any, is reached, or once there is an input
5206 ;; pending, exit. Before leaving, the current synchronization
5207 ;; request is updated.
5214 exit-flag)
5215 ;; No re-parenting nor shifting planned: request is over.
5225 ;; We reached NEXT. Request is complete.
5227 ;; Handle interruption request. Update current request.
5232 ;; Shift element.
5235 ;; Shift associated objects data, if any.
5240 ;; Re-parent it.
5246 ;; Cache is up-to-date past THRESHOLD. Request
5247 ;; interruption.
5252 ;; We reached end of tree: synchronization complete.
5253 t)))
5256 "Parse elements in current section, down to POS.
5258 Start parsing from the closest between the last known element in
5259 cache or headline above. Return the smallest element containing
5260 POS.
5262 When optional argument SYNCP is non-nil, return the parent of the
5263 element containing POS instead. In that case, it is also
5264 possible to provide TIME-LIMIT, which is a time value specifying
5265 when the parsing should stop. The function throws `interrupt' if
5266 the process stopped before finding the expected result."
5273 element next)
5275 ;; Nothing in cache before point: start parsing from first
5276 ;; element following headline above, or first element in
5277 ;; buffer.
5283 ;; Cache returned exact match: return it.
5286 ;; There's a headline between cached value and POS: cached
5287 ;; value is invalid. Start parsing from first element
5288 ;; following the headline.
5294 ;; Check if CACHED or any of its ancestors contain point.
5295 ;;
5296 ;; If there is such an element, we inspect it in order to know
5297 ;; if we return it or if we need to parse its contents.
5298 ;; Otherwise, we just start parsing from current location,
5299 ;; which is right after the top-most element containing
5300 ;; CACHED.
5301 ;;
5302 ;; As a special case, if POS is at the end of the buffer, we
5303 ;; want to return the innermost element ending there.
5304 ;;
5305 ;; Also, if we find an ancestor and discover that we need to
5306 ;; parse its contents, make sure we don't start from
5307 ;; `:contents-begin', as we would otherwise go past CACHED
5308 ;; again. Instead, in that situation, we will resume parsing
5309 ;; from NEXT, which is located after CACHED or its higher
5310 ;; ancestor not containing point.
5322 ;; Parse successively each element until we reach POS.
5328 special-flag)
5336 end 'element special-flag
5343 ;; Skip any element ending before point. Also skip
5344 ;; element ending at point (unless it is also the end of
5345 ;; buffer) since we're sure that another element begins
5346 ;; after it.
5349 ;; A non-greater element contains point: return it.
5352 ;; Otherwise, we have to decide if ELEMENT really
5353 ;; contains POS. In that case we start parsing from
5354 ;; contents' beginning.
5355 ;;
5356 ;; If POS is at contents' beginning but it is also at
5357 ;; the beginning of the first item in a list or a table.
5358 ;; In that case, we need to create an anchor for that
5359 ;; list or table, so return it.
5360 ;;
5361 ;; Also, if POS is at the end of the buffer, no element
5362 ;; can start after it, but more than one may end there.
5363 ;; Arbitrarily, we choose to return the innermost of
5364 ;; such elements.
5380 parent element
5381 end cend))))
5382 ;; Otherwise, return ELEMENT as it is the smallest
5383 ;; element containing POS.
5388 ;;;; Staging Buffer Changes
5396 "Regexp matching an element opening line.
5397 When such a line is modified, modifications may propagate after
5398 modified area. In that situation, every element between that
5407 "Regexp matching an element closing line.
5408 When such a line is modified, modifications may propagate before
5409 modified area. In that situation, every element between that
5413 "Non-nil when a sensitive line is about to be changed.
5417 "Request extension of area going to be modified if needed.
5418 BEG and END are the beginning and end of the range of changed
5419 text. See `before-change-functions' for more information."
5428 ;; A sensitive line is a headline or a block (or drawer,
5429 ;; or latex-environment) boundary. Inserting one can
5430 ;; modify buffer drastically both above and below that
5431 ;; line, possibly making cache invalid. Therefore, we
5432 ;; need to pay attention to changes happening to them.
5436 org-element--cache-opening-line)))
5448 "Update buffer modifications for current buffer.
5449 BEG and END are the beginning and end of the range of changed
5450 text, and the length in bytes of the pre-change text replaced by
5451 that range. See `after-change-functions' for more information."
5461 ;; Determine if modified area needs to be extended,
5462 ;; according to both previous and current state. We make
5463 ;; a special case for headline editing: if a headline is
5464 ;; modified but not removed, do not extend.
5469 org-element--cache-opening-line))
5481 ;; Effectively extend modified area.
5488 ;; Store synchronization request.
5491 ;; Activate a timer to process the request during idle time.
5495 "Return first element to remove from cache.
5497 BEG and END are buffer positions delimiting buffer modifications.
5498 OFFSET is the size of the changes.
5500 Returned element is usually the first element in cache containing
5501 any position between BEG and END. As an exception, greater
5502 elements around the changes that are robust to contents
5503 modifications are preserved and updated according to the
5504 changes."
5513 drawer dynamic-block inlinetask
5514 property-drawer quote-block special-block))
5517 ;; UP is a robust greater element containing changes.
5518 ;; We only need to extend its ending boundaries and
5519 ;; those of all its parents.
5525 ;; We're at top level element containing ELEMENT: if it's
5526 ;; altered by buffer modifications, it is first element in
5527 ;; cache to be removed. Otherwise, that first element is the
5528 ;; following one.
5532 "Submit a new cache synchronization request for current buffer.
5533 BEG and END are buffer positions delimiting the minimal area
5534 where cache data should be removed. OFFSET is the size of the
5535 change, as an integer."
5542 ;; Current changes can be merged with first sync request: we
5543 ;; can save a partial cache synchronization.
5552 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5553 ;; if any, is no longer a 0-phase request, thus ensuring that
5554 ;; phases are properly ordered. We need to provide OFFSET as
5555 ;; optional parameter since current modifications are not known
5556 ;; yet to the otherwise correct part of the cache (i.e, before
5557 ;; the first request).
5561 ;; Changes happened before the first known element. Shift
5562 ;; the rest of the cache.
5565 org-element--cache-sync-requests))
5566 ;; There is at least an element to remove. Find position
5567 ;; past every element containing END.
5580 org-element--cache-sync-requests))
5581 ;; No element to remove. No need to re-parent either.
5582 ;; Simply shift additional elements, if any, by OFFSET.
5586 ;;;; Public Functions
5588 ;;;###autoload
5590 "Reset cache in current buffer.
5591 When optional argument ALL is non-nil, reset cache in all Org
5592 buffers."
5610 ;;;###autoload
5612 "Refresh cache at position POS."
5619 \f
5620 ;;; The Toolbox
5621 ;;
5622 ;; The first move is to implement a way to obtain the smallest element
5623 ;; containing point. This is the job of `org-element-at-point'. It
5624 ;; basically jumps back to the beginning of section containing point
5625 ;; and proceed, one element after the other, with
5626 ;; `org-element--current-element' until the container is found. Note:
5627 ;; When using `org-element-at-point', secondary values are never
5628 ;; parsed since the function focuses on elements, not on objects.
5629 ;;
5630 ;; At a deeper level, `org-element-context' lists all elements and
5631 ;; objects containing point.
5632 ;;
5633 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5634 ;; internally by navigation and manipulation tools.
5637 ;;;###autoload
5639 "Determine closest element around point.
5641 Return value is a list like (TYPE PROPS) where TYPE is the type
5642 of the element and PROPS a plist of properties associated to the
5643 element.
5645 Possible types are defined in `org-element-all-elements'.
5646 Properties depend on element or object type, but always include
5647 `:begin', `:end', `:parent' and `:post-blank' properties.
5649 As a special case, if point is at the very beginning of the first
5650 item in a list or sub-list, returned element will be that list
5651 instead of the item. Likewise, if point is at the beginning of
5652 the first row of a table, returned element will be the table
5653 instead of the first row.
5655 When point is at the end of the buffer, return the innermost
5656 element ending there."
5662 ;; Within blank lines at the beginning of buffer, return nil.
5664 ;; Within blank lines right after a headline, return that
5665 ;; headline.
5669 ;; Otherwise parse until we find element containing ORIGIN.
5676 ;;;###autoload
5678 "Return smallest element or object around point.
5680 Return value is a list like (TYPE PROPS) where TYPE is the type
5681 of the element or object and PROPS a plist of properties
5682 associated to it.
5684 Possible types are defined in `org-element-all-elements' and
5685 `org-element-all-objects'. Properties depend on element or
5686 object type, but always include `:begin', `:end', `:parent' and
5687 `:post-blank'.
5689 As a special case, if point is right after an object and not at
5690 the beginning of any other object, return that object.
5692 Optional argument ELEMENT, when non-nil, is the closest element
5693 containing point, as returned by `org-element-at-point'.
5694 Providing it allows for quicker computation."
5700 ;; If point is inside an element containing objects or
5701 ;; a secondary string, narrow buffer to the container and
5702 ;; proceed with parsing. Otherwise, return ELEMENT.
5704 ;; At a parsed affiliated keyword, check if we're inside main
5705 ;; or dual value.
5712 org-element-parsed-keywords))
5721 ;; Also change type to retrieve correct restrictions.
5723 ;; At an item, objects can only be located within tag, if any.
5733 ;; At an headline or inlinetask, objects are in title.
5740 ;; At a paragraph, a table-row or a verse block, objects are
5741 ;; located within their contents.
5745 ;; CBEG is nil for table rules.
5750 ;; At a parsed keyword, objects are located within value.
5753 org-element-document-properties))
5760 ;; At a planning line, if point is at a timestamp, return it,
5761 ;; otherwise, return element.
5769 ;; All other locations cannot contain objects: bail out.
5779 next object-data last)
5783 ;; When entering PARENT for the first time, get list
5784 ;; of objects within known so far. Store it in
5785 ;; OBJECT-DATA.
5790 ;; Find NEXT object for analysis.
5792 ;; If NEXT is non-nil, we already exhausted the
5793 ;; cache so we can parse buffer to find the object
5794 ;; after it.
5796 ;; Otherwise, check if cache can help us.
5807 ;; Cache contains the information needed.
5810 pos)
5812 pos)
5818 ;; If we have a new object to analyze, store it in
5819 ;; cache. Otherwise record that there is nothing
5820 ;; more to parse in this element at this depth.
5825 ;; Process NEXT, if any, in order to know if we need
5826 ;; to skip it, return it or move into it.
5833 ;; Skip objects ending before point. Also skip
5834 ;; objects ending at point unless it is also the
5835 ;; end of buffer, since we want to return the
5836 ;; innermost object.
5839 ;; For convenience, when object ends at POS,
5840 ;; without any space, store it in LAST, as we
5841 ;; will return it if no object starts here.
5845 ;; If POS is within a container object, move
5846 ;; into that object.
5850 ;; At contents' end, if there is no
5851 ;; space before point, also move into
5852 ;; object, for consistency with
5853 ;; convenience feature above.
5862 next nil
5863 object-data nil))
5864 ;; Otherwise, return NEXT.
5866 ;; Store results in cache, if applicable.
5870 "Non-nil when elements ELEM-A and ELEM-B are nested."
5879 "Swap elements ELEM-A and ELEM-B.
5880 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5881 end of ELEM-A."
5883 ;; There are two special cases when an element doesn't start at bol:
5884 ;; the first paragraph in an item or in a footnote definition.
5886 ;; Only a paragraph without any affiliated keyword can be moved at
5887 ;; ELEM-A position in such a situation. Note that the case of
5888 ;; a footnote definition is impossible: it cannot contain two
5889 ;; paragraphs in a row because it cannot contain a blank line.
5895 ;; In a special situation, ELEM-A will have no indentation. We'll
5896 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5910 ;; Store overlays responsible for visibility status. We
5911 ;; also need to store their boundaries as they will be
5912 ;; removed from buffer.
5919 ;; Get contents.
5927 ;; Restore ex ELEM-A overlays.
5936 ;; Restore ex ELEM-B overlays.
5944 "Remove maximum common indentation in string S and return it.
5945 When optional argument N is a positive integer, remove exactly
5946 that much characters from indentation, if possible, or return
5947 S as-is otherwise. Unlike to `org-remove-indentation', this
5948 function doesn't call `untabify' on S."
5953 ;; Find maximum common indentation, if not specified.
5961 min-ind)))
5963 ;; Remove exactly N indentation, but give up if not possible.
5976 ;; Local variables:
5977 ;; generated-autoload-file: "org-loaddefs.el"
5978 ;; End:
5980 ;;; org-element.el ends here