| blob | f6a92e55135c5e096fad3ad87d97aa7720cd0152 |
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 ;; Read time properties on the line below the inlinetask
1008 ;; opening string.
1015 org-keyword-time-not-clock-regexp end t)
1025 plist)))))
1036 ;; Find property drawer associated to current inlinetask
1037 ;; and extract properties.
1038 ;;
1039 ;; HACK: Calling `org-element-at-point' triggers a parsing
1040 ;; of this inlinetask and, thus, an infloop. To avoid the
1041 ;; problem, we extract contents of the inlinetask and
1042 ;; parse them in a new buffer.
1043 ;;
1044 ;; Upcase property names. It avoids confusion between
1045 ;; properties obtained through property drawer and default
1046 ;; properties from the parser (e.g. `:end' and :END:)
1049 plist)
1056 org-property-start-re task-end t))
1066 plist
1071 plist)))
1076 :begin begin
1077 :end end
1078 :contents-begin contents-begin
1079 :contents-end contents-end
1082 :tags tags
1083 :todo-keyword todo
1084 :todo-type todo-type
1086 time-props
1087 standard-props))))
1089 inlinetask :title
1092 raw-value
1094 inlinetask))))))
1097 "Interpret INLINETASK element as Org syntax.
1098 CONTENTS is the contents of inlinetask."
1113 ;; Align tags.
1121 ? )
1122 tags))
1126 tags))))
1127 ;; Prefer degenerate inlinetasks when there are no
1128 ;; contents.
1131 contents
1135 ;;;; Item
1138 "Parse an item.
1140 STRUCT is the structure of the plain list.
1142 Return a list whose CAR is `item' and CDR is a plist containing
1143 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1144 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1145 keywords.
1147 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1148 any, will not be parsed as a secondary string, but as a plain
1149 string instead.
1151 Assume point is at the beginning of the item."
1175 ;; Ignore tags in un-ordered lists: they are just
1176 ;; a part of item's body.
1182 ;; If first line isn't empty, contents really start
1183 ;; at the text after item's meta-data.
1192 :begin begin
1193 :end end
1194 ;; CONTENTS-BEGIN and CONTENTS-END may be
1195 ;; mixed up in the case of an empty item
1196 ;; separated from the next by a blank line.
1197 ;; Thus ensure the former is always the
1198 ;; smallest.
1201 :checkbox checkbox
1202 :counter counter
1203 :structure struct
1206 item :tag
1214 "Interpret ITEM element as Org syntax.
1215 CONTENTS is the contents of the element."
1225 ;; Compute indentation.
1230 ;; Indent contents.
1232 bullet
1246 ;;;; Plain List
1249 ;; Return structure of list at point. Internal function. See
1250 ;; `org-list-struct' for details.
1255 items struct)
1260 ;; At limit: end all items.
1269 ;; At list end: end all items.
1274 ;; At a new item: end previous sibling.
1286 ind
1287 bullet
1290 ;; Description tag.
1294 ;; Ending position, unknown so far.
1295 nil)))
1296 items))
1298 ;; Skip empty lines.
1300 ;; Skip inline tasks and blank lines along the way.
1307 ;; At some text line. Check if it ends any previous item.
1319 ;; Skip blocks (any type) and drawers contents.
1324 limit t)))
1330 "Parse a plain list.
1332 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1333 the buffer position at the beginning of the first affiliated
1334 keyword and CDR is a plist of affiliated keywords along with
1335 their value. STRUCTURE is the structure of the plain list being
1336 parsed.
1338 Return a list whose CAR is `plain-list' and CDR is a plist
1339 containing `:type', `:begin', `:end', `:contents-begin' and
1340 `:contents-end', `:structure', `:post-blank' and
1341 `:post-affiliated' keywords.
1343 Assume point is at the beginning of the list."
1357 pos))
1361 ;; Return value.
1365 :begin begin
1366 :end end
1367 :contents-begin contents-begin
1368 :contents-end contents-end
1369 :structure struct
1375 "Interpret PLAIN-LIST element as Org syntax.
1376 CONTENTS is the contents of the element."
1384 ;;;; Property Drawer
1387 "Parse a property drawer.
1389 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1390 the buffer position at the beginning of the first affiliated
1391 keyword and CDR is a plist of affiliated keywords along with
1392 their value.
1394 Return a list whose CAR is `property-drawer' and CDR is a plist
1395 containing `:begin', `:end', `:contents-begin', `:contents-end',
1396 `:post-blank' and `:post-affiliated' keywords.
1398 Assume point is at the beginning of the property drawer."
1403 ;; Incomplete drawer: parse it as a paragraph.
1421 :end end
1422 :contents-begin contents-begin
1423 :contents-end contents-end
1429 "Interpret PROPERTY-DRAWER element as Org syntax.
1430 CONTENTS is the properties within the drawer."
1434 ;;;; Quote Block
1437 "Parse a quote block.
1439 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1440 the buffer position at the beginning of the first affiliated
1441 keyword and CDR is a plist of affiliated keywords along with
1442 their value.
1444 Return a list whose CAR is `quote-block' and CDR is a plist
1445 containing `:begin', `:end', `:contents-begin', `:contents-end',
1446 `:post-blank' and `:post-affiliated' keywords.
1448 Assume point is at the beginning of the block."
1452 ;; Incomplete block: parse it as a paragraph.
1458 ;; Empty blocks have no contents.
1471 :end end
1472 :contents-begin contents-begin
1473 :contents-end contents-end
1479 "Interpret QUOTE-BLOCK element as Org syntax.
1480 CONTENTS is the contents of the element."
1484 ;;;; Section
1487 "Parse a section.
1489 LIMIT bounds the search.
1491 Return a list whose CAR is `section' and CDR is a plist
1492 containing `:begin', `:end', `:contents-begin', `contents-end'
1493 and `:post-blank' keywords."
1495 ;; Beginning of section is the beginning of the first non-blank
1496 ;; line after previous headline.
1505 :end end
1506 :contents-begin begin
1507 :contents-end pos-before-blank
1511 "Interpret SECTION element as Org syntax.
1512 CONTENTS is the contents of the element."
1513 contents)
1516 ;;;; Special Block
1519 "Parse a special block.
1521 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1522 the buffer position at the beginning of the first affiliated
1523 keyword and CDR is a plist of affiliated keywords along with
1524 their value.
1526 Return a list whose CAR is `special-block' and CDR is a plist
1527 containing `:type', `:begin', `:end', `:contents-begin',
1528 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1530 Assume point is at the beginning of the block."
1537 limit t)))
1538 ;; Incomplete block: parse it as a paragraph.
1544 ;; Empty blocks have no contents.
1557 :begin begin
1558 :end end
1559 :contents-begin contents-begin
1560 :contents-end contents-end
1566 "Interpret SPECIAL-BLOCK element as Org syntax.
1567 CONTENTS is the contents of the element."
1572 \f
1573 ;;; Elements
1574 ;;
1575 ;; For each element, a parser and an interpreter are also defined.
1576 ;; Both follow the same naming convention used for greater elements.
1577 ;;
1578 ;; Also, as for greater elements, adding a new element type is done
1579 ;; through the following steps: implement a parser and an interpreter,
1580 ;; tweak `org-element--current-element' so that it recognizes the new
1581 ;; type and add that new type to `org-element-all-elements'.
1582 ;;
1583 ;; As a special case, when the newly defined type is a block type,
1584 ;; `org-element-block-name-alist' has to be modified accordingly.
1587 ;;;; Babel Call
1590 "Parse a babel call.
1592 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1593 the buffer position at the beginning of the first affiliated
1594 keyword and CDR is a plist of affiliated keywords along with
1595 their value.
1597 Return a list whose CAR is `babel-call' and CDR is a plist
1598 containing `:begin', `:end', `:value', `:post-blank' and
1599 `:post-affiliated' as keywords."
1613 :end end
1614 :value value
1620 "Interpret BABEL-CALL element as Org syntax.
1621 CONTENTS is nil."
1625 ;;;; Clock
1628 "Parse a clock.
1630 LIMIT bounds the search.
1632 Return a list whose CAR is `clock' and CDR is a plist containing
1633 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1634 as keywords."
1654 :value value
1655 :duration duration
1656 :begin begin
1657 :end end
1661 "Interpret CLOCK element as Org syntax.
1662 CONTENTS is nil."
1670 "%2s:%02s"
1674 ;;;; Comment
1677 "Parse a comment.
1679 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1680 the buffer position at the beginning of the first affiliated
1681 keyword and CDR is a plist of affiliated keywords along with
1682 their value.
1684 Return a list whose CAR is `comment' and CDR is a plist
1685 containing `:begin', `:end', `:value', `:post-blank',
1686 `:post-affiliated' keywords.
1688 Assume point is at comment beginning."
1697 ;; Get comments ending.
1700 ;; Accumulate lines without leading hash and first
1701 ;; whitespace.
1715 :end end
1716 :value value
1722 "Interpret COMMENT element as Org syntax.
1723 CONTENTS is nil."
1727 ;;;; Comment Block
1730 "Parse an export block.
1732 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1733 the buffer position at the beginning of the first affiliated
1734 keyword and CDR is a plist of affiliated keywords along with
1735 their value.
1737 Return a list whose CAR is `comment-block' and CDR is a plist
1738 containing `:begin', `:end', `:value', `:post-blank' and
1739 `:post-affiliated' keywords.
1741 Assume point is at comment block beginning."
1745 ;; Incomplete block: parse it as a paragraph.
1758 contents-begin contents-end)))
1762 :end end
1763 :value value
1769 "Interpret COMMENT-BLOCK element as Org syntax.
1770 CONTENTS is nil."
1775 ;;;; Diary Sexp
1778 "Parse a diary sexp.
1780 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1781 the buffer position at the beginning of the first affiliated
1782 keyword and CDR is a plist of affiliated keywords along with
1783 their value.
1785 Return a list whose CAR is `diary-sexp' and CDR is a plist
1786 containing `:begin', `:end', `:value', `:post-blank' and
1787 `:post-affiliated' keywords."
1799 :begin begin
1800 :end end
1806 "Interpret DIARY-SEXP as Org syntax.
1807 CONTENTS is nil."
1811 ;;;; Example Block
1814 "Parse an example block.
1816 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1817 the buffer position at the beginning of the first affiliated
1818 keyword and CDR is a plist of affiliated keywords along with
1819 their value.
1821 Return a list whose CAR is `example-block' and CDR is a plist
1822 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1823 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1824 `:value', `:post-blank' and `:post-affiliated' keywords."
1828 ;; Incomplete block: parse it as a paragraph.
1836 ;; Switches analysis
1843 ;; Should labels be retained in (or stripped from) example
1844 ;; blocks?
1849 ;; What should code-references use - labels or
1850 ;; line-numbers?
1859 ;; Standard block parsing.
1867 contents-begin contents-end))
1868 block-ind))
1877 :end end
1878 :value value
1879 :switches switches
1880 :number-lines number-lines
1881 :preserve-indent preserve-indent
1882 :retain-labels retain-labels
1883 :use-labels use-labels
1884 :label-fmt label-fmt
1890 "Interpret EXAMPLE-BLOCK element as Org syntax.
1891 CONTENTS is nil."
1898 value
1903 ;;;; Export Block
1906 "Parse an export block.
1908 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1909 the buffer position at the beginning of the first affiliated
1910 keyword and CDR is a plist of affiliated keywords along with
1911 their value.
1913 Return a list whose CAR is `export-block' and CDR is a plist
1914 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1915 `:post-affiliated' keywords.
1917 Assume point is at export-block beginning."
1924 ;; Incomplete block: parse it as a paragraph.
1937 contents-end)))
1941 :end end
1942 :type type
1943 :value value
1949 "Interpret EXPORT-BLOCK element as Org syntax.
1950 CONTENTS is nil."
1957 ;;;; Fixed-width
1960 "Parse a fixed-width section.
1962 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1963 the buffer position at the beginning of the first affiliated
1964 keyword and CDR is a plist of affiliated keywords along with
1965 their value.
1967 Return a list whose CAR is `fixed-width' and CDR is a plist
1968 containing `:begin', `:end', `:value', `:post-blank' and
1969 `:post-affiliated' keywords.
1971 Assume point is at the beginning of the fixed-width area."
1975 value
1980 ;; Accumulate text without starting colons.
1993 :end end
1994 :value value
2000 "Interpret FIXED-WIDTH element as Org syntax.
2001 CONTENTS is nil."
2009 ;;;; Horizontal Rule
2012 "Parse an horizontal rule.
2014 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2015 the buffer position at the beginning of the first affiliated
2016 keyword and CDR is a plist of affiliated keywords along with
2017 their value.
2019 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2020 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2021 keywords."
2031 :end end
2037 "Interpret HORIZONTAL-RULE element as Org syntax.
2038 CONTENTS is nil."
2042 ;;;; Keyword
2045 "Parse a keyword at point.
2047 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2048 the buffer position at the beginning of the first affiliated
2049 keyword and CDR is a plist of affiliated keywords along with
2050 their value.
2052 Return a list whose CAR is `keyword' and CDR is a plist
2053 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2054 `:post-affiliated' keywords."
2056 ;; An orphaned affiliated keyword is considered as a regular
2057 ;; keyword. In this case AFFILIATED is nil, so we take care of
2058 ;; this corner case.
2071 :value value
2072 :begin begin
2073 :end end
2079 "Interpret KEYWORD element as Org syntax.
2080 CONTENTS is nil."
2086 ;;;; Latex Environment
2089 "Parse a LaTeX environment.
2091 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2092 the buffer position at the beginning of the first affiliated
2093 keyword and CDR is a plist of affiliated keywords along with
2094 their value.
2096 Return a list whose CAR is `latex-environment' and CDR is a plist
2097 containing `:begin', `:end', `:value', `:post-blank' and
2098 `:post-affiliated' keywords.
2100 Assume point is at the beginning of the latex environment."
2107 limit t))
2108 ;; Incomplete latex environment: parse it as a paragraph.
2118 :end end
2119 :value value
2125 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2126 CONTENTS is nil."
2130 ;;;; Node Property
2133 "Parse a node-property at point.
2135 LIMIT bounds the search.
2137 Return a list whose CAR is `node-property' and CDR is a plist
2138 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2139 keywords."
2151 :value value
2152 :begin begin
2153 :end end
2157 "Interpret NODE-PROPERTY element as Org syntax.
2158 CONTENTS is nil."
2164 ;;;; Paragraph
2167 "Parse a paragraph.
2169 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2170 the buffer position at the beginning of the first affiliated
2171 keyword and CDR is a plist of affiliated keywords along with
2172 their value.
2174 Return a list whose CAR is `paragraph' and CDR is a plist
2175 containing `:begin', `:end', `:contents-begin' and
2176 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2178 Assume point is at the beginning of the paragraph."
2187 limit
2188 ;; A matching `org-element-paragraph-separate' is not
2189 ;; necessarily the end of the paragraph. In
2190 ;; particular, lines starting with # or : as a first
2191 ;; non-space character are ambiguous. We have to
2192 ;; check if they are valid Org syntax (e.g., not an
2193 ;; incomplete keyword).
2197 ;; There's no ambiguity for other symbols or
2198 ;; empty lines: stop here.
2200 ;; Stop at valid fixed-width areas.
2202 ;; Stop at drawers.
2207 ;; Stop at valid comments.
2209 ;; Stop at valid dynamic blocks.
2214 ;; Stop at valid blocks.
2221 limit t)))
2222 ;; Stop at valid latex environments.
2230 limit t)))
2231 ;; Stop at valid keywords.
2233 ;; Skip everything else.
2250 :end end
2251 :contents-begin contents-begin
2252 :contents-end contents-end
2258 "Interpret PARAGRAPH element as Org syntax.
2259 CONTENTS is the contents of the element."
2260 contents)
2263 ;;;; Planning
2266 "Parse a planning.
2268 LIMIT bounds the search.
2270 Return a list whose CAR is `planning' and CDR is a plist
2271 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2272 and `:post-blank' keywords."
2282 closed deadline scheduled)
2294 :deadline deadline
2295 :scheduled scheduled
2296 :begin begin
2297 :end end
2301 "Interpret PLANNING element as Org syntax.
2302 CONTENTS is nil."
2304 'identity
2321 ;;;; Src Block
2324 "Parse a src block.
2326 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2327 the buffer position at the beginning of the first affiliated
2328 keyword and CDR is a plist of affiliated keywords along with
2329 their value.
2331 Return a list whose CAR is `src-block' and CDR is a plist
2332 containing `:language', `:switches', `:parameters', `:begin',
2333 `:end', `:number-lines', `:retain-labels', `:use-labels',
2334 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2335 `:post-affiliated' keywords.
2337 Assume point is at the beginning of the block."
2340 limit t)))
2341 ;; Incomplete block: parse it as a paragraph.
2347 ;; Get language as a string.
2356 ;; Get switches.
2358 ;; Get parameters.
2360 ;; Switches analysis
2371 ;; Should labels be retained in (or stripped from)
2372 ;; src blocks?
2377 ;; What should code-references use - labels or
2378 ;; line-numbers?
2383 ;; Indentation.
2385 ;; Retrieve code.
2390 block-ind))
2394 ;; Get position after ending blank lines.
2404 :begin begin
2405 :end end
2406 :number-lines number-lines
2407 :preserve-indent preserve-indent
2408 :retain-labels retain-labels
2409 :use-labels use-labels
2410 :label-fmt label-fmt
2411 :value value
2417 "Interpret SRC-BLOCK element as Org syntax.
2418 CONTENTS is nil."
2427 val)
2441 ;;;; Table
2444 "Parse a table at point.
2446 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2447 the buffer position at the beginning of the first affiliated
2448 keyword and CDR is a plist of affiliated keywords along with
2449 their value.
2451 Return a list whose CAR is `table' and CDR is a plist containing
2452 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2453 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2454 keywords.
2456 Assume point is at the beginning of the table."
2470 acc))
2477 :end end
2478 :type type
2479 :tblfm tblfm
2480 ;; Only `org' tables have contents. `table.el' tables
2481 ;; use a `:value' property to store raw table as
2482 ;; a string.
2487 table-begin table-end))
2493 "Interpret TABLE element as Org syntax.
2494 CONTENTS is nil."
2505 ;;;; Table Row
2508 "Parse table row at point.
2510 LIMIT bounds the search.
2512 Return a list whose CAR is `table-row' and CDR is a plist
2513 containing `:begin', `:end', `:contents-begin', `:contents-end',
2514 `:type' and `:post-blank' keywords."
2518 ;; A table rule has no contents. In that case, ensure
2519 ;; CONTENTS-BEGIN matches CONTENTS-END.
2531 :begin begin
2532 :end end
2533 :contents-begin contents-begin
2534 :contents-end contents-end
2538 "Interpret TABLE-ROW element as Org syntax.
2539 CONTENTS is the contents of the table row."
2544 ;;;; Verse Block
2547 "Parse a verse block.
2549 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2550 the buffer position at the beginning of the first affiliated
2551 keyword and CDR is a plist of affiliated keywords along with
2552 their value.
2554 Return a list whose CAR is `verse-block' and CDR is a plist
2555 containing `:begin', `:end', `:contents-begin', `:contents-end',
2556 `:post-blank' and `:post-affiliated' keywords.
2558 Assume point is at beginning of the block."
2562 ;; Incomplete block: parse it as a paragraph.
2577 :end end
2578 :contents-begin contents-begin
2579 :contents-end contents-end
2585 "Interpret VERSE-BLOCK element as Org syntax.
2586 CONTENTS is verse block contents."
2590 \f
2591 ;;; Objects
2592 ;;
2593 ;; Unlike to elements, raw text can be found between objects. Hence,
2594 ;; `org-element--object-lex' is provided to find the next object in
2595 ;; buffer.
2596 ;;
2597 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2598 ;; object types they can contain will be specified in
2599 ;; `org-element-object-restrictions'.
2600 ;;
2601 ;; Creating a new type of object requires to alter
2602 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2603 ;; new type in `org-element-all-objects', and possibly add
2604 ;; restrictions in `org-element-object-restrictions'.
2606 ;;;; Bold
2609 "Parse bold object at point, if any.
2611 When at a bold object, return a list whose car is `bold' and cdr
2612 is a plist with `:begin', `:end', `:contents-begin' and
2613 `:contents-end' and `:post-blank' keywords. Otherwise, return
2614 nil.
2616 Assume point is at the first star marker."
2628 :end end
2629 :contents-begin contents-begin
2630 :contents-end contents-end
2634 "Interpret BOLD object as Org syntax.
2635 CONTENTS is the contents of the object."
2639 ;;;; Code
2642 "Parse code object at point, if any.
2644 When at a code object, return a list whose car is `code' and cdr
2645 is a plist with `:value', `:begin', `:end' and `:post-blank'
2646 keywords. Otherwise, return nil.
2648 Assume point is at the first tilde marker."
2659 :begin begin
2660 :end end
2664 "Interpret CODE object as Org syntax.
2665 CONTENTS is nil."
2669 ;;;; Entity
2672 "Parse entity at point, if any.
2674 When at an entity, return a list whose car is `entity' and cdr
2675 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2676 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2677 `:post-blank' as keywords. Otherwise, return nil.
2679 Assume point is at the beginning of the entity."
2681 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2699 :begin begin
2700 :end end
2701 :use-brackets-p bracketsp
2705 "Interpret ENTITY object as Org syntax.
2706 CONTENTS is nil."
2712 ;;;; Export Snippet
2715 "Parse export snippet at point.
2717 When at an export snippet, return a list whose car is
2718 `export-snippet' and cdr a plist with `:begin', `:end',
2719 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2720 return nil.
2722 Assume point is at the beginning of the snippet."
2738 :value value
2739 :begin begin
2740 :end end
2744 "Interpret EXPORT-SNIPPET object as Org syntax.
2745 CONTENTS is nil."
2751 ;;;; Footnote Reference
2754 "Parse footnote reference at point, if any.
2756 When at a footnote reference, return a list whose car is
2757 `footnote-reference' and cdr a plist with `:label', `:type',
2758 `:inline-definition', `:begin', `:end' and `:post-blank' as
2759 keywords. Otherwise, return nil."
2783 :type type
2784 :begin begin
2785 :end end
2788 footnote-reference :inline-definition
2793 footnote-reference))))))))
2796 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2797 CONTENTS is nil."
2807 ;;;; Inline Babel Call
2810 "Parse inline babel call at point, if any.
2812 When at an inline babel call, return a list whose car is
2813 `inline-babel-call' and cdr a plist with `:begin', `:end',
2814 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2816 Assume point is at the beginning of the babel call."
2828 :end end
2829 :value value
2833 "Interpret INLINE-BABEL-CALL object as Org syntax.
2834 CONTENTS is nil."
2838 ;;;; Inline Src Block
2841 "Parse inline source block at point, if any.
2843 When at an inline source block, return a list whose car is
2844 `inline-src-block' and cdr a plist with `:begin', `:end',
2845 `:language', `:value', `:parameters' and `:post-blank' as
2846 keywords. Otherwise, return nil.
2848 Assume point is at the beginning of the inline src block."
2861 :value value
2862 :parameters parameters
2863 :begin begin
2864 :end end
2868 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2869 CONTENTS is nil."
2874 language
2876 body)))
2878 ;;;; Italic
2881 "Parse italic object at point, if any.
2883 When at an italic object, return a list whose car is `italic' and
2884 cdr is a plist with `:begin', `:end', `:contents-begin' and
2885 `:contents-end' and `:post-blank' keywords. Otherwise, return
2886 nil.
2888 Assume point is at the first slash marker."
2900 :end end
2901 :contents-begin contents-begin
2902 :contents-end contents-end
2906 "Interpret ITALIC object as Org syntax.
2907 CONTENTS is the contents of the object."
2911 ;;;; Latex Fragment
2914 "Parse LaTeX fragment at point, if any.
2916 When at a LaTeX fragment, return a list whose car is
2917 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2918 and `:post-blank' as keywords. Otherwise, return nil.
2920 Assume point is at the beginning of the LaTeX fragment."
2934 ;; Macro.
2937 ;; No fragment found.
2945 :begin begin
2946 :end end
2950 "Interpret LATEX-FRAGMENT object as Org syntax.
2951 CONTENTS is nil."
2954 ;;;; Line Break
2957 "Parse line break at point, if any.
2959 When at a line break, return a list whose car is `line-break',
2960 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2961 Otherwise, return nil.
2963 Assume point is at the beginning of the line break."
2972 "Interpret LINE-BREAK object as Org syntax.
2973 CONTENTS is nil."
2977 ;;;; Link
2980 "Parse link at point, if any.
2982 When at a link, return a list whose car is `link' and cdr a plist
2983 with `:type', `:path', `:raw-link', `:application',
2984 `:search-option', `:begin', `:end', `:contents-begin',
2985 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2986 nil.
2988 Assume point is at the beginning of the link."
2991 end contents-begin contents-end link-end post-blank path type
2992 raw-link link search-option application)
2994 ;; Type 1: Text targeted from a radio target.
3003 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3008 ;; RAW-LINK is the original link. Expand any
3009 ;; abbreviation in it.
3013 ;; Determine TYPE of link and set PATH accordingly.
3015 ;; File type.
3019 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3022 ;; Id type: PATH is the id.
3025 ;; Code-ref type: PATH is the name of the reference.
3028 ;; Custom-id type: PATH is the name of the custom id.
3031 ;; Fuzzy type: Internal link either matches a target, an
3032 ;; headline name or nothing. PATH is the target or
3033 ;; headline's name.
3035 ;; Type 3: Plain link, e.g., http://orgmode.org
3041 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3049 ;; In any case, deduce end point after trailing white space from
3050 ;; LINK-END variable.
3054 ;; Special "file" type link processing.
3056 ;; Extract opening application and search option.
3064 ;; Normalize URI.
3068 ;; Make sure TYPE always reports "file".
3072 :path path
3074 :application application
3075 :search-option search-option
3076 :begin begin
3077 :end end
3078 :contents-begin contents-begin
3079 :contents-end contents-end
3083 "Interpret LINK object as Org syntax.
3084 CONTENTS is the contents of the object, or nil."
3089 raw-link
3093 ;;;; Macro
3096 "Parse macro at point, if any.
3098 When at a macro, return a list whose car is `macro' and cdr
3099 a plist with `:key', `:args', `:begin', `:end', `:value' and
3100 `:post-blank' as keywords. Otherwise, return nil.
3102 Assume point is at the macro."
3113 ;; Do not use `org-split-string' since empty
3114 ;; strings are meaningful here.
3122 args nil t)
3126 :value value
3127 :args args
3128 :begin begin
3129 :end end
3133 "Interpret MACRO object as Org syntax.
3134 CONTENTS is nil."
3138 ;;;; Radio-target
3141 "Parse radio target at point, if any.
3143 When at a radio target, return a list whose car is `radio-target'
3144 and cdr a plist with `:begin', `:end', `:contents-begin',
3145 `:contents-end', `:value' and `:post-blank' as keywords.
3146 Otherwise, return nil.
3148 Assume point is at the radio target."
3160 :end end
3161 :contents-begin contents-begin
3162 :contents-end contents-end
3163 :post-blank post-blank
3167 "Interpret TARGET object as Org syntax.
3168 CONTENTS is the contents of the object."
3172 ;;;; Statistics Cookie
3175 "Parse statistics cookie at point, if any.
3177 When at a statistics cookie, return a list whose car is
3178 `statistics-cookie', and cdr a plist with `:begin', `:end',
3179 `:value' and `:post-blank' keywords. Otherwise, return nil.
3181 Assume point is at the beginning of the statistics-cookie."
3192 :end end
3193 :value value
3197 "Interpret STATISTICS-COOKIE object as Org syntax.
3198 CONTENTS is nil."
3202 ;;;; Strike-Through
3205 "Parse strike-through object at point, if any.
3207 When at a strike-through object, return a list whose car is
3208 `strike-through' and cdr is a plist with `:begin', `:end',
3209 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3210 Otherwise, return nil.
3212 Assume point is at the first plus sign marker."
3224 :end end
3225 :contents-begin contents-begin
3226 :contents-end contents-end
3230 "Interpret STRIKE-THROUGH object as Org syntax.
3231 CONTENTS is the contents of the object."
3235 ;;;; Subscript
3238 "Parse subscript at point, if any.
3240 When at a subscript object, return a list whose car is
3241 `subscript' and cdr a plist with `:begin', `:end',
3242 `:contents-begin', `:contents-end', `:use-brackets-p' and
3243 `:post-blank' as keywords. Otherwise, return nil.
3245 Assume point is at the underscore."
3259 :end end
3260 :use-brackets-p bracketsp
3261 :contents-begin contents-begin
3262 :contents-end contents-end
3266 "Interpret SUBSCRIPT object as Org syntax.
3267 CONTENTS is the contents of the object."
3270 contents))
3273 ;;;; Superscript
3276 "Parse superscript at point, if any.
3278 When at a superscript object, return a list whose car is
3279 `superscript' and cdr a plist with `:begin', `:end',
3280 `:contents-begin', `:contents-end', `:use-brackets-p' and
3281 `:post-blank' as keywords. Otherwise, return nil.
3283 Assume point is at the caret."
3297 :end end
3298 :use-brackets-p bracketsp
3299 :contents-begin contents-begin
3300 :contents-end contents-end
3304 "Interpret SUPERSCRIPT object as Org syntax.
3305 CONTENTS is the contents of the object."
3308 contents))
3311 ;;;; Table Cell
3314 "Parse table cell at point.
3315 Return a list whose car is `table-cell' and cdr is a plist
3316 containing `:begin', `:end', `:contents-begin', `:contents-end'
3317 and `:post-blank' keywords."
3325 :end end
3326 :contents-begin contents-begin
3327 :contents-end contents-end
3331 "Interpret TABLE-CELL element as Org syntax.
3332 CONTENTS is the contents of the cell, or nil."
3336 ;;;; Target
3339 "Parse target at point, if any.
3341 When at a target, return a list whose car is `target' and cdr
3342 a plist with `:begin', `:end', `:value' and `:post-blank' as
3343 keywords. Otherwise, return nil.
3345 Assume point is at the target."
3355 :end end
3356 :value value
3360 "Interpret TARGET object as Org syntax.
3361 CONTENTS is nil."
3365 ;;;; Timestamp
3376 "Parse time stamp at point, if any.
3378 When at a time stamp, return a list whose car is `timestamp', and
3379 cdr a plist with `:type', `:raw-value', `:year-start',
3380 `:month-start', `:day-start', `:hour-start', `:minute-start',
3381 `:year-end', `:month-end', `:day-end', `:hour-end',
3382 `:minute-end', `:repeater-type', `:repeater-value',
3383 `:repeater-unit', `:warning-type', `:warning-value',
3384 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3385 Otherwise, return nil.
3387 Assume point is at the beginning of the timestamp."
3406 date-start)
3417 raw-value)
3419 :repeater-type
3425 :repeater-unit
3434 :warning-unit
3437 year-start month-start day-start hour-start minute-start year-end
3438 month-end day-end hour-end minute-end)
3439 ;; Parse date-start.
3447 ;; Compute date-end. It can be provided directly in time-stamp,
3448 ;; or extracted from time range. Otherwise, it defaults to the
3449 ;; same values as date-start.
3459 :raw-value raw-value
3460 :year-start year-start
3461 :month-start month-start
3462 :day-start day-start
3463 :hour-start hour-start
3464 :minute-start minute-start
3465 :year-end year-end
3466 :month-end month-end
3467 :day-end day-end
3468 :hour-end hour-end
3469 :minute-end minute-end
3470 :begin begin
3471 :end end
3473 repeater-props
3474 warning-props))))))
3477 "Interpret TIMESTAMP object as Org syntax.
3478 CONTENTS is nil."
3497 ;; Build an Org timestamp string from TIME. ACTIVEP is
3498 ;; non-nil when time stamp is active. If WITH-TIME-P is
3499 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3500 ;; specify a time range in the timestamp. REPEAT-STRING is
3501 ;; the repeater string, if any.
3505 org-time-stamp-formats)
3506 time)))
3512 nil nil ts)))
3517 " "
3518 s
3520 ;; Return value.
3521 ts)))
3533 build-ts-string
3552 0
3560 "--"
3572 ;;;; Underline
3575 "Parse underline object at point, if any.
3577 When at an underline object, return a list whose car is
3578 `underline' and cdr is a plist with `:begin', `:end',
3579 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3580 Otherwise, return nil.
3582 Assume point is at the first underscore marker."
3594 :end end
3595 :contents-begin contents-begin
3596 :contents-end contents-end
3600 "Interpret UNDERLINE object as Org syntax.
3601 CONTENTS is the contents of the object."
3605 ;;;; Verbatim
3608 "Parse verbatim object at point, if any.
3610 When at a verbatim object, return a list whose car is `verbatim'
3611 and cdr is a plist with `:value', `:begin', `:end' and
3612 `:post-blank' keywords. Otherwise, return nil.
3614 Assume point is at the first equal sign marker."
3625 :begin begin
3626 :end end
3630 "Interpret VERBATIM object as Org syntax.
3631 CONTENTS is nil."
3635 \f
3636 ;;; Parsing Element Starting At Point
3637 ;;
3638 ;; `org-element--current-element' is the core function of this section.
3639 ;; It returns the Lisp representation of the element starting at
3640 ;; point.
3641 ;;
3642 ;; `org-element--current-element' makes use of special modes. They
3643 ;; are activated for fixed element chaining (e.g., `plain-list' >
3644 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3645 ;; `section'). Special modes are: `first-section', `item',
3646 ;; `node-property', `section' and `table-row'.
3650 "Parse the element starting at point.
3652 Return value is a list like (TYPE PROPS) where TYPE is the type
3653 of the element and PROPS a plist of properties associated to the
3654 element.
3656 Possible types are defined in `org-element-all-elements'.
3658 LIMIT bounds the search.
3660 Optional argument GRANULARITY determines the depth of the
3661 recursion. Allowed values are `headline', `greater-element',
3662 `element', `object' or nil. When it is broader than `object' (or
3663 nil), secondary values will not be parsed, since they only
3664 contain objects.
3666 Optional argument SPECIAL, when non-nil, can be either
3667 `first-section', `item', `node-property', `section', and
3668 `table-row'.
3670 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3671 be computed.
3673 This function assumes point is always at the beginning of the
3674 element it has to parse."
3677 ;; Determine if parsing depth allows for secondary strings
3678 ;; parsing. It only applies to elements referenced in
3679 ;; `org-element-secondary-value-alist'.
3682 ;; Item.
3685 ;; Table Row.
3687 ;; Node Property.
3689 ;; Headline.
3692 ;; Sections (must be checked after headline).
3697 limit)))
3698 ;; When not at bol, point is at the beginning of an item or
3699 ;; a footnote definition: next item is always a paragraph.
3701 ;; Planning and Clock.
3706 ;; Inlinetask.
3709 ;; From there, elements can have affiliated keywords.
3712 ;; Jumping over affiliated keywords put point off-limits.
3713 ;; Parse them as regular keywords.
3717 ;; LaTeX Environment.
3721 ;; Drawer and Property Drawer.
3726 ;; Fixed Width
3729 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3730 ;; Keywords.
3739 org-element-block-name-alist)))
3754 ;; Footnote Definition.
3757 ;; Horizontal Rule.
3760 ;; Diary Sexp.
3763 ;; Table.
3765 ;; List.
3768 limit affiliated
3770 ;; Default element: Paragraph.
3774 ;; Most elements can have affiliated keywords. When looking for an
3775 ;; element beginning, we want to move before them, as they belong to
3776 ;; that element, and, in the meantime, collect information they give
3777 ;; into appropriate properties. Hence the following function.
3780 "Collect affiliated keywords from point down to LIMIT.
3782 Return a list whose CAR is the position at the first of them and
3783 CDR a plist of keywords and values and move point to the
3784 beginning of the first line after them.
3786 As a special case, if element doesn't start at the beginning of
3787 the line (e.g., a paragraph starting an item), CAR is current
3788 position of point and CDR is nil."
3792 ;; RESTRICT is the list of objects allowed in parsed
3793 ;; keywords value.
3795 output)
3798 ;; Apply translation to RAW-KWD. From there, KWD is
3799 ;; the official keyword.
3801 org-element-keyword-translation-alist))
3802 raw-kwd))
3803 ;; Find main value for any keyword.
3809 ;; PARSEDP is non-nil when keyword should have its
3810 ;; value parsed.
3812 ;; If KWD is a dual keyword, find its secondary
3813 ;; value. Maybe parse it.
3820 ;; Attribute a property name to KWD.
3822 ;; Now set final shape for VALUE.
3828 ;; Attributes can always appear on multiple lines.
3831 ;; Eventually store the new value in OUTPUT.
3833 ;; Move to next keyword.
3835 ;; If affiliated keywords are orphaned: move back to first one.
3836 ;; They will be parsed as a paragraph.
3838 ;; Return value.
3842 \f
3843 ;;; The Org Parser
3844 ;;
3845 ;; The two major functions here are `org-element-parse-buffer', which
3846 ;; parses Org syntax inside the current buffer, taking into account
3847 ;; region, narrowing, or even visibility if specified, and
3848 ;; `org-element-parse-secondary-string', which parses objects within
3849 ;; a given string.
3850 ;;
3851 ;; The (almost) almighty `org-element-map' allows to apply a function
3852 ;; on elements or objects matching some type, and accumulate the
3853 ;; resulting values. In an export situation, it also skips unneeded
3854 ;; parts of the parse tree.
3857 "Recursively parse the buffer and return structure.
3858 If narrowing is in effect, only parse the visible part of the
3859 buffer.
3861 Optional argument GRANULARITY determines the depth of the
3862 recursion. It can be set to the following symbols:
3864 `headline' Only parse headlines.
3865 `greater-element' Don't recurse into greater elements excepted
3866 headlines and sections. Thus, elements
3867 parsed are the top-level ones.
3868 `element' Parse everything but objects and plain text.
3869 `object' Parse the complete buffer (default).
3871 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3872 elements.
3874 An element or an objects is represented as a list with the
3875 pattern (TYPE PROPERTIES CONTENTS), where :
3877 TYPE is a symbol describing the element or object. See
3878 `org-element-all-elements' and `org-element-all-objects' for an
3879 exhaustive list of such symbols. One can retrieve it with
3880 `org-element-type' function.
3882 PROPERTIES is the list of attributes attached to the element or
3883 object, as a plist. Although most of them are specific to the
3884 element or object type, all types share `:begin', `:end',
3885 `:post-blank' and `:parent' properties, which respectively
3886 refer to buffer position where the element or object starts,
3887 ends, the number of white spaces or blank lines after it, and
3888 the element or object containing it. Properties values can be
3889 obtained by using `org-element-property' function.
3891 CONTENTS is a list of elements, objects or raw strings
3892 contained in the current element or object, when applicable.
3893 One can access them with `org-element-contents' function.
3895 The Org buffer has `org-data' as type and nil as properties.
3896 `org-element-map' function can be used to find specific elements
3897 or objects within the parse tree.
3899 This function assumes that current major mode is `org-mode'."
3905 ;; Start in `first-section' mode so text before the first
3906 ;; headline belongs to a section.
3910 "Recursively parse objects in STRING and return structure.
3912 RESTRICTION is a symbol limiting the object types that will be
3913 looked after.
3915 Optional argument PARENT, when non-nil, is the element or object
3916 containing the secondary string. It is used to set correctly
3917 `:parent' property within the string."
3918 ;; Copy buffer-local variables listed in
3919 ;; `org-element-object-variables' into temporary buffer. This is
3920 ;; required since object parsing is dependent on these variables.
3924 org-element-object-variables))))
3932 secondary))
3933 secondary))))
3937 "Map a function on selected elements or objects.
3939 DATA is a parse tree, an element, an object, a string, or a list
3940 of such constructs. TYPES is a symbol or list of symbols of
3941 elements or objects types (see `org-element-all-elements' and
3942 `org-element-all-objects' for a complete list of types). FUN is
3943 the function called on the matching element or object. It has to
3944 accept one argument: the element or object itself.
3946 When optional argument INFO is non-nil, it should be a plist
3947 holding export options. In that case, parts of the parse tree
3948 not exportable according to that property list will be skipped.
3950 When optional argument FIRST-MATCH is non-nil, stop at the first
3951 match for which FUN doesn't return nil, and return that value.
3953 Optional argument NO-RECURSION is a symbol or a list of symbols
3954 representing elements or objects types. `org-element-map' won't
3955 enter any recursive element or object whose type belongs to that
3956 list. Though, FUN can still be applied on them.
3958 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3959 apply to matching objects within parsed affiliated keywords (see
3960 `org-element-parsed-keywords').
3962 Nil values returned from FUN do not appear in the results.
3965 Examples:
3966 ---------
3968 Assuming TREE is a variable containing an Org buffer parse tree,
3969 the following example will return a flat list of all `src-block'
3970 and `example-block' elements in it:
3972 \(org-element-map tree '(example-block src-block) 'identity)
3974 The following snippet will find the first headline with a level
3977 \(org-element-map tree 'headline
3978 \(lambda (hl)
3979 \(and (= (org-element-property :level hl) 1)
3981 \(org-element-property :begin hl)))
3982 nil t)
3984 The next example will return a flat list of all `plain-list' type
3985 elements in TREE that are not a sub-list themselves:
3987 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3989 Eventually, this example will return a flat list of all `bold'
3990 type objects containing a `latex-snippet' type object, even
3991 looking into captions:
3993 \(org-element-map tree 'bold
3994 \(lambda (b)
3995 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3996 nil nil nil t)"
3997 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4000 ;; Recursion depth is determined by --CATEGORY.
4007 ;; If one object is found, the function
4008 ;; has to recurse into every object.
4011 ;; If one regular element is found, the
4012 ;; function has to recurse, at least,
4013 ;; into every element it encounters.
4016 types)
4017 category)))
4018 ;; Compute properties for affiliated keywords if necessary.
4023 org-element-affiliated-keywords)))
4024 --acc
4025 --walk-tree
4029 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4030 ;; holding contextual information.
4034 ;; Ignored element in an export context.
4036 ;; List of elements or objects.
4038 ;; Unconditionally enter parse trees.
4042 ;; Check if TYPE is matching among TYPES. If so,
4043 ;; apply FUN to --DATA and accumulate return value
4044 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4050 ;; If --DATA has a secondary string that can contain
4051 ;; objects with their type among TYPES, look into it.
4058 ;; If --DATA has any affiliated keywords and
4059 ;; WITH-AFFILIATED is non-nil, look for objects in
4060 ;; them.
4068 ;; Pay attention to the type of value.
4069 ;; Preserve order for multiple keywords.
4085 --affiliated-alist))
4086 ;; Determine if a recursion into --DATA is possible.
4088 ;; --TYPE is explicitly removed from recursion.
4090 ;; --DATA has no contents.
4092 ;; Looking for greater elements but --DATA is simply
4093 ;; an element or an object.
4096 ;; Looking for elements but --DATA is an object.
4099 ;; In any other case, map contents.
4103 ;; Return value in a proper order.
4107 ;; The following functions are internal parts of the parser.
4108 ;;
4109 ;; The first one, `org-element--parse-elements' acts at the element's
4110 ;; level.
4111 ;;
4112 ;; The second one, `org-element--parse-objects' applies on all objects
4113 ;; of a paragraph or a secondary string.
4114 ;;
4115 ;; More precisely, that function looks for every allowed object type
4116 ;; first. Then, it discards failed searches, keeps further matches,
4117 ;; and searches again types matched behind point, for subsequent
4118 ;; calls. Thus, searching for a given type fails only once, and every
4119 ;; object is searched only once at top level (but sometimes more for
4120 ;; nested types).
4124 "Parse elements between BEG and END positions.
4126 SPECIAL prioritize some elements over the others. It can be set
4127 to `first-section', `section' `item' or `table-row'.
4129 When value is `item', STRUCTURE will be used as the current list
4130 structure.
4132 GRANULARITY determines the depth of the recursion. See
4133 `org-element-parse-buffer' for more information.
4135 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4136 elements.
4138 Elements are accumulated into ACC."
4141 ;; Visible only: skip invisible parts at the beginning of the
4142 ;; element.
4145 ;; When parsing only headlines, skip any text before first one.
4148 ;; Main loop start.
4150 ;; Find current element's type and parse it accordingly to
4151 ;; its category.
4153 end granularity special structure))
4157 ;; Visible only: skip invisible parts between siblings.
4160 ;; Fill ELEMENT contents by side-effect.
4162 ;; If element has no contents, don't modify it.
4164 ;; Greater element: parse it between `contents-begin' and
4165 ;; `contents-end'. Make sure GRANULARITY allows the
4166 ;; recursion, or ELEMENT is a headline, in which case going
4167 ;; inside is mandatory, in order to get sub-level headings.
4175 ;; Possibly switch to a special mode.
4183 granularity visible-only element))
4184 ;; ELEMENT has contents. Parse objects inside, if
4185 ;; GRANULARITY allows it.
4191 ;; Return result.
4192 acc))
4198 ;; Sub/superscript.
4200 ;; Bold, code, italic, strike-through, underline and
4201 ;; verbatim.
4204 ;; Plain links.
4206 ;; Objects starting with "[": regular link, footnote
4207 ;; reference, statistics cookie, timestamp (inactive).
4209 ;; Objects starting with "@": export snippets.
4210 "@@"
4211 ;; Objects starting with "{": macro.
4212 "{{{"
4213 ;; Objects starting with "<" : timestamp (active,
4214 ;; diary), target, radio target and angular links.
4216 ;; Objects starting with "$": latex fragment.
4218 ;; Objects starting with "\": line break, entity,
4219 ;; latex fragment.
4221 ;; Objects starting with raw text: inline Babel
4222 ;; source block, inline Babel call.
4225 "Regexp possibly matching the beginning of an object.
4226 This regexp allows false positives. Dedicated parser (e.g.,
4227 `org-export-bold-parser') will take care of further filtering.
4228 Radio links are not matched by this regexp, as they are treated
4232 "Return next object in current buffer or nil.
4233 RESTRICTION is a list of object types, as symbols, that should be
4234 looked after. This function assumes that the buffer is narrowed
4235 to an appropriate container (e.g., a paragraph)."
4243 found)
4306 ;; This is probably a plain link.
4312 ;; Radio link.
4317 "Parse objects between BEG and END and return recursive structure.
4319 Objects are accumulated in ACC.
4321 RESTRICTION is a list of object successors which are allowed in
4322 the current object."
4330 ;; 1. Text before any object. Untabify it.
4335 acc
4339 ;; 2. Object...
4342 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4343 ;; a recursive type.
4351 ;; 3. Text after last object. Untabify it.
4355 acc
4359 ;; Result.
4360 acc)))
4363 \f
4364 ;;; Towards A Bijective Process
4365 ;;
4366 ;; The parse tree obtained with `org-element-parse-buffer' is really
4367 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4368 ;; interpreted and expanded into a string with canonical Org syntax.
4369 ;; Hence `org-element-interpret-data'.
4370 ;;
4371 ;; The function relies internally on
4372 ;; `org-element--interpret-affiliated-keywords'.
4374 ;;;###autoload
4376 "Interpret DATA as Org syntax.
4378 DATA is a parse tree, an element, an object or a secondary string
4379 to interpret.
4381 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4382 new types that should be treated as objects. An unknown type not
4383 belonging to this list is seen as a pseudo-element instead. Both
4384 pseudo-objects and pseudo-elements are transparent entities, i.e.
4385 only their contents are interpreted.
4387 Return Org syntax as a string."
4391 "Interpret DATA as Org syntax.
4393 DATA is a parse tree, an element, an object or a secondary string
4394 to interpret. PARENT is used for recursive calls. It contains
4395 the element or object containing data, or nil. PSEUDO-OBJECTS
4396 are list of symbols defining new element or object types.
4397 Unknown types that don't belong to this list are treated as
4398 pseudo-elements instead.
4400 Return Org syntax as a string."
4402 ;; Find interpreter for current object or element. If it
4403 ;; doesn't exist (e.g. this is a pseudo object or element),
4404 ;; return contents, if any.
4410 ;; Secondary string.
4416 ;; Full Org document.
4422 ;; Plain text: return it.
4424 ;; Element or object without contents.
4426 ;; Element or object with contents.
4429 ;; Recursively interpret contents.
4435 data
4436 ;; Fix indentation of elements containing
4437 ;; objects. We ignore `table-row' elements
4438 ;; as they are one line long anyway.
4440 data
4441 ;; When normalizing first paragraph of an
4442 ;; item or a footnote-definition, ignore
4443 ;; first line's indentation.
4450 ;; Build white spaces. If no `:post-blank' property is
4451 ;; specified, assume its value is 0.
4462 "Return ELEMENT's affiliated keywords as Org syntax.
4463 If there is no affiliated keyword, return the empty string."
4473 ": "
4476 value)
4484 ;; All attribute keywords can have multiple lines.
4490 ;; List all ELEMENT's properties matching an attribute line or an
4491 ;; affiliated keyword, but ignore translated keywords since they
4492 ;; cannot belong to the property list.
4499 org-element-keyword-translation-alist)))))
4500 collect prop)
4503 ;; Because interpretation of the parse tree must return the same
4504 ;; number of blank lines between elements and the same number of white
4505 ;; space after objects, some special care must be given to white
4506 ;; spaces.
4507 ;;
4508 ;; The first function, `org-element-normalize-string', ensures any
4509 ;; string different from the empty string will end with a single
4510 ;; newline character.
4511 ;;
4512 ;; The second function, `org-element-normalize-contents', removes
4513 ;; global indentation from the contents of the current element.
4516 "Ensure string S ends with a single newline character.
4518 If S isn't a string return it unchanged. If S is the empty
4519 string, return it. Otherwise, return a new string with a single
4520 newline character at its end."
4528 "Normalize plain text in ELEMENT's contents.
4530 ELEMENT must only contain plain text and objects.
4532 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4533 indentation to compute maximal common indentation.
4535 Return the normalized element that is element with global
4536 indentation removed from its contents. The function assumes that
4537 indentation is not done with TAB characters."
4539 find-min-ind ; For byte-compiler.
4542 ;; Return minimal common indentation within BLOB. This is
4543 ;; done by walking recursively BLOB and updating MIN-IND
4544 ;; along the way. FIRST-FLAG is non-nil when the first
4545 ;; string hasn't been seen yet. It is required as this
4546 ;; string is the only one whose indentation doesn't happen
4547 ;; after a newline character.
4554 ;; An indentation of zero means no string will be
4555 ;; modified. Quit the process.
4564 ;; Find minimal indentation in ELEMENT.
4567 ;; Build ELEMENT back, replacing each string with the same
4568 ;; string minus common indentation.
4573 ;; Return BLOB with all its strings indentation
4574 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4575 ;; is non-nil when the first string hasn't been seen
4576 ;; yet.
4591 org-element-recursive-objects)
4595 blob))))
4599 \f
4600 ;;; Cache
4601 ;;
4602 ;; Implement a caching mechanism for `org-element-at-point' and
4603 ;; `org-element-context', which see.
4604 ;;
4605 ;; A single public function is provided: `org-element-cache-reset'.
4606 ;;
4607 ;; Cache is enabled by default, but can be disabled globally with
4608 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4609 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4610 ;; can be tweaked to control caching behaviour.
4611 ;;
4612 ;; Internally, parsed elements are stored in an AVL tree,
4613 ;; `org-element--cache'. This tree is updated lazily: whenever
4614 ;; a change happens to the buffer, a synchronization request is
4615 ;; registered in `org-element--cache-sync-requests' (see
4616 ;; `org-element--cache-submit-request'). During idle time, requests
4617 ;; are processed by `org-element--cache-sync'. Synchronization also
4618 ;; happens when an element is required from the cache. In this case,
4619 ;; the process stops as soon as the needed element is up-to-date.
4620 ;;
4621 ;; A synchronization request can only apply on a synchronized part of
4622 ;; the cache. Therefore, the cache is updated at least to the
4623 ;; location where the new request applies. Thus, requests are ordered
4624 ;; from left to right and all elements starting before the first
4625 ;; request are correct. This property is used by functions like
4626 ;; `org-element--cache-find' to retrieve elements in the part of the
4627 ;; cache that can be trusted.
4628 ;;
4629 ;; A request applies to every element, starting from its original
4630 ;; location (or key, see below). When a request is processed, it
4631 ;; moves forward and may collide the next one. In this case, both
4632 ;; requests are merged into a new one that starts from that element.
4633 ;; As a consequence, the whole synchronization complexity does not
4634 ;; depend on the number of pending requests, but on the number of
4635 ;; elements the very first request will be applied on.
4636 ;;
4637 ;; Elements cannot be accessed through their beginning position, which
4638 ;; may or may not be up-to-date. Instead, each element in the tree is
4639 ;; associated to a key, obtained with `org-element--cache-key'. This
4640 ;; mechanism is robust enough to preserve total order among elements
4641 ;; even when the tree is only partially synchronized.
4642 ;;
4643 ;; Objects contained in an element are stored in a hash table,
4644 ;; `org-element--cache-objects'.
4648 "Non nil when Org parser should cache its results.
4655 "Maximum duration, as a time value, for a cache synchronization.
4656 If the synchronization is not over after this delay, the process
4657 pauses and resumes after `org-element-cache-sync-break'
4661 "Duration, as a time value, of the pause between synchronizations.
4665 ;;;; Data Structure
4668 "AVL tree used to cache elements.
4669 Each node of the tree contains an element. Comparison is done
4670 with `org-element--cache-compare'. This cache is used in
4674 "Hash table used as to cache objects.
4675 Key is an element, as returned by `org-element-at-point', and
4676 value is an alist where each association is:
4678 \(PARENT COMPLETEP . OBJECTS)
4680 where PARENT is an element or object, COMPLETEP is a boolean,
4681 non-nil when all direct children of parent are already cached and
4682 OBJECTS is a list of such children, as objects, from farthest to
4683 closest.
4686 contained within a paragraph
4690 If the paragraph is completely parsed, OBJECTS-DATA will be
4692 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4693 \(BOLD-OBJECT t ENTITY-OBJECT))
4695 whereas in a partially parsed paragraph, it could be
4697 \((PARAGRAPH nil ENTITY-OBJECT))
4702 "List of pending synchronization requests.
4704 A request is a vector with the following pattern:
4706 \[NEXT BEG END OFFSET PARENT PHASE]
4708 Processing a synchronization request consists of three phases:
4710 0. Delete modified elements,
4711 1. Fill missing area in cache,
4712 2. Shift positions and re-parent elements after the changes.
4714 During phase 0, NEXT is the key of the first element to be
4715 removed, BEG and END is buffer position delimiting the
4716 modifications. Every element starting between these are removed.
4717 PARENT is an element to be removed. Every element contained in
4718 it will also be removed.
4720 During phase 1, NEXT is the key of the next known element in
4721 cache. Parse buffer between that element and the one before it
4722 in order to determine the parent of the next element. Set PARENT
4723 to the element containing NEXT.
4725 During phase 2, NEXT is the key of the next element to shift in
4726 the parse tree. All elements starting from this one have their
4727 properties relatives to buffer positions shifted by integer
4728 OFFSET and, if they belong to element PARENT, are adopted by it.
4736 "Hash table used to store keys during synchronization.
4740 "Return a unique key for ELEMENT in cache tree.
4742 Keys are used to keep a total order among elements in the cache.
4743 Comparison is done with `org-element--cache-key-less-p'.
4745 When no synchronization is taking place, a key is simply the
4746 beginning position of the element, or that position plus one in
4747 the case of an first item (respectively row) in
4748 a list (respectively a table).
4750 During a synchronization, the key is the one the element had when
4751 the cache was synchronized for the last time. Elements added to
4752 cache during the synchronization get a new key generated with
4753 `org-element--cache-generate-key'.
4755 Such keys are stored in `org-element--cache-sync-keys'. The hash
4756 table is cleared once the synchronization is complete."
4759 ;; Increase beginning position of items (respectively
4760 ;; table rows) by one, so the first item can get
4761 ;; a different key from its parent list (respectively
4762 ;; table).
4765 begin)))
4768 key))))
4771 "Generate a key between LOWER and UPPER.
4773 LOWER and UPPER are integers or lists, possibly empty.
4775 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4776 a unique key, as an integer or a list of integers, according to
4777 the following rules:
4779 - LOWER and UPPER are compared level-wise until values differ.
4781 - If, at a given level, LOWER and UPPER differ from more than
4782 2, the new key shares all the levels above with LOWER and
4783 gets a new level. Its value is the mean between LOWER and
4784 UPPER:
4786 \(1 2) + (1 4) --> (1 3)
4788 - If LOWER has no value to compare with, it is assumed that its
4789 value is `most-negative-fixnum'. E.g.,
4791 \(1 1) + (1 1 2)
4793 is equivalent to
4795 \(1 1 m) + (1 1 2)
4797 where m is `most-negative-fixnum'. Likewise, if UPPER is
4798 short of levels, the current value is `most-positive-fixnum'.
4800 - If they differ from only one, the new key inherits from
4801 current LOWER level and fork it at the next level. E.g.,
4803 \(2 1) + (3 3)
4805 is equivalent to
4807 \(2 1) + (2 M)
4809 where M is `most-positive-fixnum'.
4811 - If the key is only one level long, it is returned as an
4812 integer:
4814 \(1 2) + (3 2) --> 2
4816 When they are not equals, the function assumes that LOWER is
4817 lesser than UPPER, per `org-element--cache-key-less-p'."
4821 skip-upper key)
4832 ;; When at a given level, LOWER and UPPER differ from
4833 ;; 1, ignore UPPER altogether. Instead create a key
4834 ;; between LOWER and the greatest key with the same
4835 ;; prefix as LOWER so far.
4841 "Non-nil if key A is less than key B.
4842 A and B are either integers or lists of integers, as returned by
4843 `org-element--cache-key'."
4851 ;; If A is empty, either keys are equal (B is also empty) and
4852 ;; we return nil, or A is lesser than B (B is longer) and we
4853 ;; return a non-nil value.
4854 ;;
4855 ;; If A is not empty, B is necessarily empty and A is greater
4856 ;; than B (A is longer). Therefore, return nil.
4860 "Non-nil when element A is located before element B."
4865 "Return root value in cache.
4866 This function assumes `org-element--cache' is a valid AVL tree."
4870 ;;;; Tools
4873 "Non-nil when cache is active in current buffer."
4878 "Find element in cache starting at POS or before.
4880 POS refers to a buffer position.
4882 When optional argument SIDE is non-nil, the function checks for
4883 elements starting at or past POS instead. If SIDE is `both', the
4884 function returns a cons cell where car is the first element
4885 starting at or before POS and cdr the first element starting
4886 after POS.
4888 The function can only find elements in the synchronized part of
4889 the cache."
4893 lower upper)
4908 ;; We found an element in cache starting at POS. If `side'
4909 ;; is `both' we also want the next one in order to generate
4910 ;; a key in-between.
4911 ;;
4912 ;; If the element is the first row or item in a table or
4913 ;; a plain list, we always return the table or the plain
4914 ;; list.
4915 ;;
4916 ;; In any other case, we return the element found.
4925 lower parent
4926 upper parent)))))
4929 lower element
4930 upper element)))))
4937 "Store ELEMENT in current buffer's cache, if allowed.
4938 When optional argument DATA is non-nil, assume is it object data
4939 relative to ELEMENT and store it in the objects cache."
4943 ;; During synchronization, first build an appropriate key
4944 ;; for the new element so `avl-tree-enter' can insert it at
4945 ;; the right spot in the cache.
4954 org-element--cache-sync-keys)))
4956 ;; Headlines are not stored in cache, so objects in titles are
4957 ;; not stored either.
4962 "Remove ELEMENT from cache.
4963 Assume ELEMENT belongs to cache and that a cache is active."
4968 ;;;; Synchronization
4971 "Set idle timer for cache synchronization in BUFFER."
4978 org-element-cache-sync-idle-time))
4979 nil
4980 #'org-element--cache-sync
4981 buffer)))
4984 "Non-nil when synchronization process should be interrupted.
4985 TIME-LIMIT is a time value or nil."
4991 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4993 Properties containing buffer positions are `:begin', `:end',
4994 `:contents-begin', `:contents-end' and `:structure'. When
4995 optional argument PROPS is a list of keywords, only shift
4996 properties provided in that list.
4998 Properties are modified by side-effect."
5000 ;; Shift `:structure' property for the first plain list only: it
5001 ;; is the only one that really matters and it prevents from
5002 ;; shifting it more than once.
5016 "Synchronize cache with recent modification in BUFFER.
5018 When optional argument THRESHOLD is non-nil, do the
5019 synchronization for all elements starting before or at threshold,
5020 then exit. Otherwise, synchronize cache for as long as
5021 `org-element-cache-sync-duration' or until Emacs leaves idle
5022 state.
5024 EXTRA, when non-nil, is an additional offset for changes not
5025 registered yet in the cache. It is used in
5026 `org-element--cache-submit-request', where cache is partially
5027 updated before current modification are actually submitted."
5038 request
5040 threshold
5043 org-element-cache-sync-duration))
5045 ;; Request processed. Merge current and next offsets and
5046 ;; transfer phase number and ending position.
5053 ;; If more requests are awaiting, set idle timer accordingly.
5054 ;; Otherwise, reset keys.
5061 "Process synchronization REQUEST for all entries before NEXT.
5063 REQUEST is a vector, built by `org-element--cache-submit-request'.
5065 NEXT is a cache key, as returned by `org-element--cache-key'.
5067 When non-nil, THRESHOLD is a buffer position. Synchronization
5068 stops as soon as a shifted element begins after it.
5070 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5071 after this time or when Emacs exits idle state.
5073 EXTRA is an additional offset taking into consideration changes
5074 not registered yet. See `org-element--cache-submit-request' for
5075 more information.
5077 Throw `interrupt' if the process stops before completing the
5078 request."
5081 ;; Phase 1.
5082 ;;
5083 ;; Delete all elements starting after BEG, but not after buffer
5084 ;; position END or past element with key NEXT.
5085 ;;
5086 ;; As an exception, also delete elements starting after
5087 ;; modifications but included in an element altered by
5088 ;; modifications (orphans).
5089 ;;
5090 ;; At each iteration, we start again at tree root since
5091 ;; a deletion modifies structure of the balanced tree.
5100 ;; Find first element in cache with key BEG or after it.
5101 ;; We don't use `org-element--cache-find' because it
5102 ;; couldn't reach orphaned elements past NEXT. Moreover,
5103 ;; BEG is a key, not a buffer position.
5113 data-key key
5116 data-key key
5117 node nil)))))
5121 ;; Remove orphaned elements.
5127 up))
5131 next)))
5141 ;; Phase 2.
5142 ;;
5143 ;; Phase 1 left a hole in the parse tree. Some elements after
5144 ;; it could have parents within. For example, in the following
5145 ;; buffer:
5146 ;;
5147 ;;
5148 ;; - item
5149 ;;
5150 ;;
5151 ;; Paragraph1
5152 ;;
5153 ;; Paragraph2
5154 ;;
5155 ;;
5156 ;; if we remove a blank line between "item" and "Paragraph1",
5157 ;; everything down to "Paragraph2" is removed from cache. But
5158 ;; the paragraph now belongs to the list, and its `:parent'
5159 ;; property no longer is accurate.
5160 ;;
5161 ;; Therefore we need to parse again elements in the hole, or at
5162 ;; least in its last section, so that we can re-parent
5163 ;; subsequent elements, during phase 3.
5164 ;;
5165 ;; Note that we only need to get the parent from the first
5166 ;; element in cache after the hole.
5167 ;;
5168 ;; Also, this part can be delayed if we don't need to retrieve
5169 ;; an element after the hole.
5171 ;; Next element will start at its beginning position plus
5172 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5173 ;; contains the real beginning position of the first element
5174 ;; to shift and re-parent.
5182 ;; Phase 3.
5183 ;;
5184 ;; Shift all elements starting from key START, but before NEXT, by
5185 ;; OFFSET, and re-parent them when appropriate.
5186 ;;
5187 ;; Elements are modified by side-effect so the tree structure
5188 ;; remains intact.
5189 ;;
5190 ;; Once THRESHOLD, if any, is reached, or once there is an input
5191 ;; pending, exit. Before leaving, the current synchronization
5192 ;; request is updated.
5199 exit-flag)
5200 ;; No re-parenting nor shifting planned: request is over.
5210 ;; We reached NEXT. Request is complete.
5212 ;; Handle interruption request. Update current request.
5217 ;; Shift element.
5220 ;; Shift associated objects data, if any.
5225 ;; Re-parent it.
5231 ;; Cache is up-to-date past THRESHOLD. Request
5232 ;; interruption.
5237 ;; We reached end of tree: synchronization complete.
5238 t)))
5241 "Parse elements in current section, down to POS.
5243 Start parsing from the closest between the last known element in
5244 cache or headline above. Return the smallest element containing
5245 POS.
5247 When optional argument SYNCP is non-nil, return the parent of the
5248 element containing POS instead. In that case, it is also
5249 possible to provide TIME-LIMIT, which is a time value specifying
5250 when the parsing should stop. The function throws `interrupt' if
5251 the process stopped before finding the expected result."
5258 element next)
5260 ;; Nothing in cache before point: start parsing from first
5261 ;; element following headline above, or first element in
5262 ;; buffer.
5268 ;; Cache returned exact match: return it.
5271 ;; There's a headline between cached value and POS: cached
5272 ;; value is invalid. Start parsing from first element
5273 ;; following the headline.
5279 ;; Check if CACHED or any of its ancestors contain point.
5280 ;;
5281 ;; If there is such an element, we inspect it in order to know
5282 ;; if we return it or if we need to parse its contents.
5283 ;; Otherwise, we just start parsing from current location,
5284 ;; which is right after the top-most element containing
5285 ;; CACHED.
5286 ;;
5287 ;; As a special case, if POS is at the end of the buffer, we
5288 ;; want to return the innermost element ending there.
5289 ;;
5290 ;; Also, if we find an ancestor and discover that we need to
5291 ;; parse its contents, make sure we don't start from
5292 ;; `:contents-begin', as we would otherwise go past CACHED
5293 ;; again. Instead, in that situation, we will resume parsing
5294 ;; from NEXT, which is located after CACHED or its higher
5295 ;; ancestor not containing point.
5307 ;; Parse successively each element until we reach POS.
5313 special-flag)
5321 end 'element special-flag
5328 ;; Skip any element ending before point. Also skip
5329 ;; element ending at point (unless it is also the end of
5330 ;; buffer) since we're sure that another element begins
5331 ;; after it.
5334 ;; A non-greater element contains point: return it.
5337 ;; Otherwise, we have to decide if ELEMENT really
5338 ;; contains POS. In that case we start parsing from
5339 ;; contents' beginning.
5340 ;;
5341 ;; If POS is at contents' beginning but it is also at
5342 ;; the beginning of the first item in a list or a table.
5343 ;; In that case, we need to create an anchor for that
5344 ;; list or table, so return it.
5345 ;;
5346 ;; Also, if POS is at the end of the buffer, no element
5347 ;; can start after it, but more than one may end there.
5348 ;; Arbitrarily, we choose to return the innermost of
5349 ;; such elements.
5365 parent element
5366 end cend))))
5367 ;; Otherwise, return ELEMENT as it is the smallest
5368 ;; element containing POS.
5373 ;;;; Staging Buffer Changes
5379 ;; Blocks
5381 ;; LaTeX environments.
5383 ;; Drawers.
5386 "Regexp matching a sensitive line, structure wise.
5387 A sensitive line is a headline, inlinetask, block, drawer, or
5388 latex-environment boundary. When such a line is modified,
5389 structure changes in the document may propagate in the whole
5393 "Non-nil when a sensitive line is about to be changed.
5397 "Request extension of area going to be modified if needed.
5398 BEG and END are the beginning and end of the range of changed
5399 text. See `before-change-functions' for more information."
5409 'headline
5412 org-element--cache-sensitive-re bottom t)))))))))
5415 "Update buffer modifications for current buffer.
5416 BEG and END are the beginning and end of the range of changed
5417 text, and the length in bytes of the pre-change text replaced by
5418 that range. See `after-change-functions' for more information."
5426 ;; Determine if modified area needs to be extended, according
5427 ;; to both previous and current state. We make a special
5428 ;; case for headline editing: if a headline is modified but
5429 ;; not removed, do not extend.
5438 org-element--cache-sensitive-re bottom t))))
5439 ;; Effectively extend modified area.
5447 ;; Store synchronization request.
5450 ;; Activate a timer to process the request during idle time.
5454 "Return first element to remove from cache.
5456 BEG and END are buffer positions delimiting buffer modifications.
5457 OFFSET is the size of the changes.
5459 Returned element is usually the first element in cache containing
5460 any position between BEG and END. As an exception, greater
5461 elements around the changes that are robust to contents
5462 modifications are preserved and updated according to the
5463 changes."
5472 drawer dynamic-block inlinetask
5473 property-drawer quote-block special-block))
5476 ;; UP is a robust greater element containing changes.
5477 ;; We only need to extend its ending boundaries and
5478 ;; those of all its parents.
5484 ;; We're at top level element containing ELEMENT: if it's
5485 ;; altered by buffer modifications, it is first element in
5486 ;; cache to be removed. Otherwise, that first element is the
5487 ;; following one.
5491 "Submit a new cache synchronization request for current buffer.
5492 BEG and END are buffer positions delimiting the minimal area
5493 where cache data should be removed. OFFSET is the size of the
5494 change, as an integer."
5501 ;; Current changes can be merged with first sync request: we
5502 ;; can save a partial cache synchronization.
5506 ;; If last changes happened before old ones, we need to
5507 ;; recompute the key of the first element to remove.
5508 ;; Otherwise, we need to extend boundaries of robust parents
5509 ;; (see `org-element--cache-for-removal'), if any.
5520 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5521 ;; if any, is no longer a 0-phase request, thus ensuring that
5522 ;; phases are properly ordered. We need to provide OFFSET as
5523 ;; optional parameter since current modifications are not known
5524 ;; yet to the otherwise correct part of the cache (i.e, before
5525 ;; the first request).
5529 ;; Changes happened before the first known element. Shift
5530 ;; the rest of the cache.
5533 org-element--cache-sync-requests))
5534 ;; There is at least an element to remove. Find position
5535 ;; past every element containing END.
5548 org-element--cache-sync-requests))
5549 ;; No element to remove. No need to re-parent either.
5550 ;; Simply shift additional elements, if any, by OFFSET.
5554 ;;;; Public Functions
5556 ;;;###autoload
5558 "Reset cache in current buffer.
5559 When optional argument ALL is non-nil, reset cache in all Org
5560 buffers."
5578 ;;;###autoload
5580 "Refresh cache at position POS."
5587 \f
5588 ;;; The Toolbox
5589 ;;
5590 ;; The first move is to implement a way to obtain the smallest element
5591 ;; containing point. This is the job of `org-element-at-point'. It
5592 ;; basically jumps back to the beginning of section containing point
5593 ;; and proceed, one element after the other, with
5594 ;; `org-element--current-element' until the container is found. Note:
5595 ;; When using `org-element-at-point', secondary values are never
5596 ;; parsed since the function focuses on elements, not on objects.
5597 ;;
5598 ;; At a deeper level, `org-element-context' lists all elements and
5599 ;; objects containing point.
5600 ;;
5601 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5602 ;; internally by navigation and manipulation tools.
5605 ;;;###autoload
5607 "Determine closest element around point.
5609 Return value is a list like (TYPE PROPS) where TYPE is the type
5610 of the element and PROPS a plist of properties associated to the
5611 element.
5613 Possible types are defined in `org-element-all-elements'.
5614 Properties depend on element or object type, but always include
5615 `:begin', `:end', `:parent' and `:post-blank' properties.
5617 As a special case, if point is at the very beginning of the first
5618 item in a list or sub-list, returned element will be that list
5619 instead of the item. Likewise, if point is at the beginning of
5620 the first row of a table, returned element will be the table
5621 instead of the first row.
5623 When point is at the end of the buffer, return the innermost
5624 element ending there."
5630 ;; Within blank lines at the beginning of buffer, return nil.
5632 ;; Within blank lines right after a headline, return that
5633 ;; headline.
5637 ;; Otherwise parse until we find element containing ORIGIN.
5644 ;;;###autoload
5646 "Return smallest element or object around point.
5648 Return value is a list like (TYPE PROPS) where TYPE is the type
5649 of the element or object and PROPS a plist of properties
5650 associated to it.
5652 Possible types are defined in `org-element-all-elements' and
5653 `org-element-all-objects'. Properties depend on element or
5654 object type, but always include `:begin', `:end', `:parent' and
5655 `:post-blank'.
5657 As a special case, if point is right after an object and not at
5658 the beginning of any other object, return that object.
5660 Optional argument ELEMENT, when non-nil, is the closest element
5661 containing point, as returned by `org-element-at-point'.
5662 Providing it allows for quicker computation."
5668 ;; If point is inside an element containing objects or
5669 ;; a secondary string, narrow buffer to the container and
5670 ;; proceed with parsing. Otherwise, return ELEMENT.
5672 ;; At a parsed affiliated keyword, check if we're inside main
5673 ;; or dual value.
5680 org-element-parsed-keywords))
5689 ;; Also change type to retrieve correct restrictions.
5691 ;; At an item, objects can only be located within tag, if any.
5701 ;; At an headline or inlinetask, objects are in title.
5708 ;; At a paragraph, a table-row or a verse block, objects are
5709 ;; located within their contents.
5713 ;; CBEG is nil for table rules.
5718 ;; At a parsed keyword, objects are located within value.
5721 org-element-document-properties))
5728 ;; At a planning line, if point is at a timestamp, return it,
5729 ;; otherwise, return element.
5737 ;; All other locations cannot contain objects: bail out.
5747 next object-data last)
5751 ;; When entering PARENT for the first time, get list
5752 ;; of objects within known so far. Store it in
5753 ;; OBJECT-DATA.
5758 ;; Find NEXT object for analysis.
5760 ;; If NEXT is non-nil, we already exhausted the
5761 ;; cache so we can parse buffer to find the object
5762 ;; after it.
5764 ;; Otherwise, check if cache can help us.
5775 ;; Cache contains the information needed.
5778 pos)
5780 pos)
5786 ;; If we have a new object to analyze, store it in
5787 ;; cache. Otherwise record that there is nothing
5788 ;; more to parse in this element at this depth.
5793 ;; Process NEXT, if any, in order to know if we need
5794 ;; to skip it, return it or move into it.
5801 ;; Skip objects ending before point. Also skip
5802 ;; objects ending at point unless it is also the
5803 ;; end of buffer, since we want to return the
5804 ;; innermost object.
5807 ;; For convenience, when object ends at POS,
5808 ;; without any space, store it in LAST, as we
5809 ;; will return it if no object starts here.
5813 ;; If POS is within a container object, move
5814 ;; into that object.
5818 ;; At contents' end, if there is no
5819 ;; space before point, also move into
5820 ;; object, for consistency with
5821 ;; convenience feature above.
5830 next nil
5831 object-data nil))
5832 ;; Otherwise, return NEXT.
5834 ;; Store results in cache, if applicable.
5838 "Non-nil when elements ELEM-A and ELEM-B are nested."
5847 "Swap elements ELEM-A and ELEM-B.
5848 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5849 end of ELEM-A."
5851 ;; There are two special cases when an element doesn't start at bol:
5852 ;; the first paragraph in an item or in a footnote definition.
5854 ;; Only a paragraph without any affiliated keyword can be moved at
5855 ;; ELEM-A position in such a situation. Note that the case of
5856 ;; a footnote definition is impossible: it cannot contain two
5857 ;; paragraphs in a row because it cannot contain a blank line.
5863 ;; In a special situation, ELEM-A will have no indentation. We'll
5864 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5878 ;; Store overlays responsible for visibility status. We
5879 ;; also need to store their boundaries as they will be
5880 ;; removed from buffer.
5887 ;; Get contents.
5895 ;; Restore ex ELEM-A overlays.
5904 ;; Restore ex ELEM-B overlays.
5912 "Remove maximum common indentation in string S and return it.
5913 When optional argument N is a positive integer, remove exactly
5914 that much characters from indentation, if possible, or return
5915 S as-is otherwise. Unlike to `org-remove-indentation', this
5916 function doesn't call `untabify' on S."
5921 ;; Find maximum common indentation, if not specified.
5929 min-ind)))
5931 ;; Remove exactly N indentation, but give up if not possible.
5944 ;; Local variables:
5945 ;; generated-autoload-file: "org-loaddefs.el"
5946 ;; End:
5948 ;;; org-element.el ends here