| blob | e2aee7c91a6c5e230394baf4a7e3ca513838b9ad |
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 latex-or-entity line-break link macro plain-link radio-target
192 statistics-cookie sub/superscript table-cell target
193 text-markup timestamp)
202 "Alist of translations between object type and successor name.
203 Sharing the same successor comes handy when, for example, the
208 inline-src-block italic line-break latex-fragment link macro
209 radio-target statistics-cookie strike-through subscript superscript
210 table-cell target timestamp underline verbatim)
215 table-cell underline)
225 "Alist between block names and the associated parsing function.
226 Names must be uppercase. Any block whose name has no association
232 Only these types can accept search options and an explicit
238 "List of affiliated keywords as strings.
246 "Alist of usual translations for keywords.
247 The key is the old name and the value the new one. The property
251 "List of affiliated keywords that can occur more than once in an element.
253 Their value will be consed into a list of strings, which will be
254 returned as the value of the property.
256 This list is checked after translations have been applied. See
257 `org-element-keyword-translation-alist'.
263 "List of affiliated keywords whose value can be parsed.
265 Their value will be stored as a secondary string: a list of
266 strings and objects.
268 This list is checked after translations have been applied. See
272 "List of affiliated keywords which can have a secondary value.
274 In Org syntax, they can be written with optional square brackets
275 before the colons. For example, RESULTS keyword can be
276 associated to a hash value with the following:
278 #+RESULTS[hash-string]: some-source
280 This list is checked after translations have been applied. See
284 "List of properties associated to the whole document.
285 Any keyword in this list will have its value parsed and stored as
291 ;; Dual affiliated keywords.
295 ;; Regular affiliated keywords.
301 org-element-affiliated-keywords)))
303 ;; Export attributes.
305 "Regexp matching any affiliated keyword.
307 Keyword name is put in match group 1. Moreover, if keyword
308 belongs to `org-element-dual-keywords', put the dual value in
309 match group 2.
324 ;; Ignore all links excepted plain links in a link description.
325 ;; Also ignore radio-targets and line breaks.
329 ;; Remove any variable object from radio target as it would
330 ;; prevent it from being properly recognized.
335 ;; Ignore inline babel call and inline src block as formulas are
336 ;; possible. Also ignore line breaks and statistics cookies.
342 "Alist of objects restrictions.
344 CAR is an element or object type containing objects and CDR is
345 a list of successors that will be called within an element or
346 object of such type.
348 For example, in a `radio-target' object, one can only find
349 entities, latex-fragments, subscript and superscript.
351 This alist also applies to secondary string. For example, an
352 `headline' type element doesn't directly contain objects, but
363 "List of buffer-local variables used when parsing objects.
364 These variables are copied to the temporary buffer created by
368 \f
369 ;;; Accessors and Setters
370 ;;
371 ;; Provide four accessors: `org-element-type', `org-element-property'
372 ;; `org-element-contents' and `org-element-restriction'.
373 ;;
374 ;; Setter functions allow to modify elements by side effect. There is
375 ;; `org-element-put-property', `org-element-set-contents'. These
376 ;; low-level functions are useful to build a parse tree.
377 ;;
378 ;; `org-element-adopt-element', `org-element-set-element',
379 ;; `org-element-extract-element' and `org-element-insert-before' are
380 ;; high-level functions useful to modify a parse tree.
381 ;;
382 ;; `org-element-secondary-p' is a predicate used to know if a given
383 ;; object belongs to a secondary string.
386 "Return type of ELEMENT.
388 The function returns the type of the element or object provided.
389 It can also return the following special value:
390 `plain-text' for a string
391 `org-data' for a complete document
392 nil in any other case."
398 "Extract the value from the PROPERTY of an ELEMENT."
403 "Extract contents from an ELEMENT."
409 "Return restriction associated to ELEMENT.
410 ELEMENT can be an element, an object or a symbol representing an
411 element or object type."
413 org-element-object-restrictions)))
416 "In ELEMENT set PROPERTY to VALUE.
417 Return modified element."
420 element))
423 "Set ELEMENT contents to CONTENTS.
424 Return modified element."
431 "Non-nil when OBJECT belongs to a secondary string.
432 Return value is the property name, as a keyword, or nil."
435 org-element-secondary-value-alist))))
438 property)))
441 "Append elements to the contents of another element.
443 PARENT is an element or object. CHILDREN can be elements,
444 objects, or a strings.
446 The function takes care of setting `:parent' property for CHILD.
447 Return parent element."
448 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
449 ;; string: parent is the list itself.
452 children)
453 ;; Add CHILDREN at the end of PARENT contents.
456 parent
458 ;; Return modified PARENT element.
462 "Extract ELEMENT from parse tree.
463 Remove element from the parse tree by side-effect, and return it
464 with its `:parent' property stripped out."
469 parent secondary
472 parent
474 ;; Return ELEMENT with its :parent removed.
478 "Insert ELEMENT before LOCATION in parse tree.
479 LOCATION is an element, object or string within the parse tree.
480 Parse tree is modified by side effect."
485 ;; Special case: LOCATION is the first element of an
486 ;; independent secondary string (e.g. :title property). Add
487 ;; ELEMENT in-place.
491 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
501 ;; Store SIBLINGS at appropriate place in parse tree.
506 ;; Set appropriate :parent property.
510 "Replace element or object OLD with element or object NEW.
511 The function takes care of setting `:parent' property for NEW."
512 ;; Ensure OLD and NEW have the same parent.
516 ;; We cannot replace OLD with NEW since one of them is not an
517 ;; object or element. We take the long path.
520 ;; Since OLD is going to be changed into NEW by side-effect, first
521 ;; make sure that every element or object within NEW has OLD as
522 ;; parent.
525 ;; Transfer contents.
527 ;; Overwrite OLD's properties with NEW's.
529 ;; Transfer type.
533 \f
534 ;;; Greater elements
535 ;;
536 ;; For each greater element type, we define a parser and an
537 ;; interpreter.
538 ;;
539 ;; A parser returns the element or object as the list described above.
540 ;; Most of them accepts no argument. Though, exceptions exist. Hence
541 ;; every element containing a secondary string (see
542 ;; `org-element-secondary-value-alist') will accept an optional
543 ;; argument to toggle parsing of that secondary string. Moreover,
544 ;; `item' parser requires current list's structure as its first
545 ;; element.
546 ;;
547 ;; An interpreter accepts two arguments: the list representation of
548 ;; the element or object, and its contents. The latter may be nil,
549 ;; depending on the element or object considered. It returns the
550 ;; appropriate Org syntax, as a string.
551 ;;
552 ;; Parsing functions must follow the naming convention:
553 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
554 ;; defined in `org-element-greater-elements'.
555 ;;
556 ;; Similarly, interpreting functions must follow the naming
557 ;; convention: org-element-TYPE-interpreter.
558 ;;
559 ;; With the exception of `headline' and `item' types, greater elements
560 ;; cannot contain other greater elements of their own type.
561 ;;
562 ;; Beside implementing a parser and an interpreter, adding a new
563 ;; greater element requires to tweak `org-element--current-element'.
564 ;; Moreover, the newly defined type must be added to both
565 ;; `org-element-all-elements' and `org-element-greater-elements'.
568 ;;;; Center Block
571 "Parse a center block.
573 LIMIT bounds the search. AFFILIATED is a list of which CAR is
574 the buffer position at the beginning of the first affiliated
575 keyword and CDR is a plist of affiliated keywords along with
576 their value.
578 Return a list whose CAR is `center-block' and CDR is a plist
579 containing `:begin', `:end', `:contents-begin', `:contents-end',
580 `:post-blank' and `:post-affiliated' keywords.
582 Assume point is at the beginning of the block."
586 ;; Incomplete block: parse it as a paragraph.
591 ;; Empty blocks have no contents.
605 :end end
606 :contents-begin contents-begin
607 :contents-end contents-end
613 "Interpret CENTER-BLOCK element as Org syntax.
614 CONTENTS is the contents of the element."
618 ;;;; Drawer
621 "Parse a drawer.
623 LIMIT bounds the search. AFFILIATED is a list of which CAR is
624 the buffer position at the beginning of the first affiliated
625 keyword and CDR is a plist of affiliated keywords along with
626 their value.
628 Return a list whose CAR is `drawer' and CDR is a plist containing
629 `:drawer-name', `:begin', `:end', `:contents-begin',
630 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
632 Assume point is at beginning of drawer."
635 ;; Incomplete drawer: parse it as a paragraph.
643 ;; Empty drawers have no contents.
656 :end end
657 :drawer-name name
658 :contents-begin contents-begin
659 :contents-end contents-end
665 "Interpret DRAWER element as Org syntax.
666 CONTENTS is the contents of the element."
669 contents))
672 ;;;; Dynamic Block
675 "Parse a dynamic block.
677 LIMIT bounds the search. AFFILIATED is a list of which CAR is
678 the buffer position at the beginning of the first affiliated
679 keyword and CDR is a plist of affiliated keywords along with
680 their value.
682 Return a list whose CAR is `dynamic-block' and CDR is a plist
683 containing `:block-name', `:begin', `:end', `:contents-begin',
684 `:contents-end', `:arguments', `:post-blank' and
685 `:post-affiliated' keywords.
687 Assume point is at beginning of dynamic block."
691 ;; Incomplete block: parse it as a paragraph.
700 ;; Empty blocks have no contents.
713 :end end
714 :block-name name
715 :arguments arguments
716 :contents-begin contents-begin
717 :contents-end contents-end
723 "Interpret DYNAMIC-BLOCK element as Org syntax.
724 CONTENTS is the contents of the element."
729 contents))
732 ;;;; Footnote Definition
735 "Parse a footnote definition.
737 LIMIT bounds the search. AFFILIATED is a list of which CAR is
738 the buffer position at the beginning of the first affiliated
739 keyword and CDR is a plist of affiliated keywords along with
740 their value.
742 Return a list whose CAR is `footnote-definition' and CDR is
743 a plist containing `:label', `:begin' `:end', `:contents-begin',
744 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
746 Assume point is at the beginning of the footnote definition."
774 :begin begin
775 :end end
776 :contents-begin contents-begin
777 :contents-end contents-end
783 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
784 CONTENTS is the contents of the footnote-definition."
786 " "
787 contents))
790 ;;;; Headline
793 "Parse a headline.
795 Return a list whose CAR is `headline' and CDR is a plist
796 containing `:raw-value', `:title', `:alt-title', `:begin',
797 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
798 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
799 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
800 and `:footnote-section-p' keywords.
802 The plist also contains any property set in the property drawer,
803 with its name in upper cases and colons added at the
804 beginning (e.g., `:CUSTOM_ID').
806 When RAW-SECONDARY-P is non-nil, headline's title will not be
807 parsed as a secondary string, but as a plain string instead.
809 Assume point is at beginning of the headline."
822 raw-value)))
826 ;; Upcase property names. It avoids confusion between
827 ;; properties obtained through property drawer and default
828 ;; properties from the parser (e.g. `:end' and :END:)
838 plist))
840 ;; Read time properties on the line below the headline.
846 org-keyword-time-not-clock-regexp end t)
856 plist))))
868 ;; Clean RAW-VALUE from any comment string.
874 ""
875 raw-value))))
876 ;; Clean TAGS from archive tag, if any.
882 :begin begin
883 :end end
884 :pre-blank
887 :contents-begin contents-begin
888 :contents-end contents-end
889 :level level
891 :tags tags
892 :todo-keyword todo
893 :todo-type todo-type
899 end)
900 :footnote-section-p footnote-section-p
901 :archivedp archivedp
903 time-props
904 standard-props))))
908 headline :alt-title
913 headline :title
919 "Interpret HEADLINE element as Org syntax.
920 CONTENTS is the contents of the element."
945 ;; Align tags.
953 ? )
954 tags))
958 tags))))
960 contents)))
963 ;;;; Inlinetask
966 "Parse an inline task.
968 Return a list whose CAR is `inlinetask' and CDR is a plist
969 containing `:title', `:begin', `:end', `:contents-begin' and
970 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
971 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
972 `:closed' and `:post-blank' keywords.
974 The plist also contains any property set in the property drawer,
975 with its name in upper cases and colons added at the
976 beginning (e.g., `:CUSTOM_ID').
978 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
979 title will not be parsed as a secondary string, but as a plain
980 string instead.
982 Assume point is at beginning of the inline task."
992 ;; Upcase property names. It avoids confusion between
993 ;; properties obtained through property drawer and default
994 ;; properties from the parser (e.g. `:end' and :END:)
1004 plist))
1006 ;; Read time properties on the line below the inlinetask
1007 ;; opening string.
1013 org-keyword-time-not-clock-regexp end t)
1023 plist))))
1042 :begin begin
1043 :end end
1044 :contents-begin contents-begin
1045 :contents-end contents-end
1048 :tags tags
1049 :todo-keyword todo
1050 :todo-type todo-type
1052 time-props
1053 standard-props))))
1055 inlinetask :title
1058 raw-value
1060 inlinetask))))))
1063 "Interpret INLINETASK element as Org syntax.
1064 CONTENTS is the contents of inlinetask."
1079 ;; Align tags.
1087 ? )
1088 tags))
1092 tags))))
1093 ;; Prefer degenerate inlinetasks when there are no
1094 ;; contents.
1097 contents
1101 ;;;; Item
1104 "Parse an item.
1106 STRUCT is the structure of the plain list.
1108 Return a list whose CAR is `item' and CDR is a plist containing
1109 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1110 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1111 keywords.
1113 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1114 any, will not be parsed as a secondary string, but as a plain
1115 string instead.
1117 Assume point is at the beginning of the item."
1141 ;; Ignore tags in un-ordered lists: they are just
1142 ;; a part of item's body.
1148 ;; If first line isn't empty, contents really start
1149 ;; at the text after item's meta-data.
1158 :begin begin
1159 :end end
1160 ;; CONTENTS-BEGIN and CONTENTS-END may be
1161 ;; mixed up in the case of an empty item
1162 ;; separated from the next by a blank line.
1163 ;; Thus ensure the former is always the
1164 ;; smallest.
1167 :checkbox checkbox
1168 :counter counter
1169 :structure struct
1172 item :tag
1180 "Interpret ITEM element as Org syntax.
1181 CONTENTS is the contents of the element."
1191 ;; Compute indentation.
1196 ;; Indent contents.
1198 bullet
1212 ;;;; Plain List
1215 ;; Return structure of list at point. Internal function. See
1216 ;; `org-list-struct' for details.
1221 items struct)
1226 ;; At limit: end all items.
1235 ;; At list end: end all items.
1240 ;; At a new item: end previous sibling.
1252 ind
1253 bullet
1256 ;; Description tag.
1260 ;; Ending position, unknown so far.
1261 nil)))
1262 items))
1264 ;; Skip empty lines.
1266 ;; Skip inline tasks and blank lines along the way.
1273 ;; At some text line. Check if it ends any previous item.
1285 ;; Skip blocks (any type) and drawers contents.
1290 limit t)))
1296 "Parse a plain list.
1298 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1299 the buffer position at the beginning of the first affiliated
1300 keyword and CDR is a plist of affiliated keywords along with
1301 their value. STRUCTURE is the structure of the plain list being
1302 parsed.
1304 Return a list whose CAR is `plain-list' and CDR is a plist
1305 containing `:type', `:begin', `:end', `:contents-begin' and
1306 `:contents-end', `:structure', `:post-blank' and
1307 `:post-affiliated' keywords.
1309 Assume point is at the beginning of the list."
1323 pos))
1327 ;; Return value.
1331 :begin begin
1332 :end end
1333 :contents-begin contents-begin
1334 :contents-end contents-end
1335 :structure struct
1341 "Interpret PLAIN-LIST element as Org syntax.
1342 CONTENTS is the contents of the element."
1350 ;;;; Property Drawer
1353 "Parse a property drawer.
1355 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1356 the buffer position at the beginning of the first affiliated
1357 keyword and CDR is a plist of affiliated keywords along with
1358 their value.
1360 Return a list whose CAR is `property-drawer' and CDR is a plist
1361 containing `:begin', `:end', `:contents-begin', `:contents-end',
1362 `:post-blank' and `:post-affiliated' keywords.
1364 Assume point is at the beginning of the property drawer."
1369 ;; Incomplete drawer: parse it as a paragraph.
1387 :end end
1388 :contents-begin contents-begin
1389 :contents-end contents-end
1395 "Interpret PROPERTY-DRAWER element as Org syntax.
1396 CONTENTS is the properties within the drawer."
1400 ;;;; Quote Block
1403 "Parse a quote block.
1405 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1406 the buffer position at the beginning of the first affiliated
1407 keyword and CDR is a plist of affiliated keywords along with
1408 their value.
1410 Return a list whose CAR is `quote-block' and CDR is a plist
1411 containing `:begin', `:end', `:contents-begin', `:contents-end',
1412 `:post-blank' and `:post-affiliated' keywords.
1414 Assume point is at the beginning of the block."
1418 ;; Incomplete block: parse it as a paragraph.
1424 ;; Empty blocks have no contents.
1437 :end end
1438 :contents-begin contents-begin
1439 :contents-end contents-end
1445 "Interpret QUOTE-BLOCK element as Org syntax.
1446 CONTENTS is the contents of the element."
1450 ;;;; Section
1453 "Parse a section.
1455 LIMIT bounds the search.
1457 Return a list whose CAR is `section' and CDR is a plist
1458 containing `:begin', `:end', `:contents-begin', `contents-end'
1459 and `:post-blank' keywords."
1461 ;; Beginning of section is the beginning of the first non-blank
1462 ;; line after previous headline.
1471 :end end
1472 :contents-begin begin
1473 :contents-end pos-before-blank
1477 "Interpret SECTION element as Org syntax.
1478 CONTENTS is the contents of the element."
1479 contents)
1482 ;;;; Special Block
1485 "Parse a special block.
1487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1488 the buffer position at the beginning of the first affiliated
1489 keyword and CDR is a plist of affiliated keywords along with
1490 their value.
1492 Return a list whose CAR is `special-block' and CDR is a plist
1493 containing `:type', `:begin', `:end', `:contents-begin',
1494 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1496 Assume point is at the beginning of the block."
1503 limit t)))
1504 ;; Incomplete block: parse it as a paragraph.
1510 ;; Empty blocks have no contents.
1523 :begin begin
1524 :end end
1525 :contents-begin contents-begin
1526 :contents-end contents-end
1532 "Interpret SPECIAL-BLOCK element as Org syntax.
1533 CONTENTS is the contents of the element."
1538 \f
1539 ;;; Elements
1540 ;;
1541 ;; For each element, a parser and an interpreter are also defined.
1542 ;; Both follow the same naming convention used for greater elements.
1543 ;;
1544 ;; Also, as for greater elements, adding a new element type is done
1545 ;; through the following steps: implement a parser and an interpreter,
1546 ;; tweak `org-element--current-element' so that it recognizes the new
1547 ;; type and add that new type to `org-element-all-elements'.
1548 ;;
1549 ;; As a special case, when the newly defined type is a block type,
1550 ;; `org-element-block-name-alist' has to be modified accordingly.
1553 ;;;; Babel Call
1556 "Parse a babel call.
1558 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1559 the buffer position at the beginning of the first affiliated
1560 keyword and CDR is a plist of affiliated keywords along with
1561 their value.
1563 Return a list whose CAR is `babel-call' and CDR is a plist
1564 containing `:begin', `:end', `:value', `:post-blank' and
1565 `:post-affiliated' as keywords."
1579 :end end
1580 :value value
1586 "Interpret BABEL-CALL element as Org syntax.
1587 CONTENTS is nil."
1591 ;;;; Clock
1594 "Parse a clock.
1596 LIMIT bounds the search.
1598 Return a list whose CAR is `clock' and CDR is a plist containing
1599 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1600 as keywords."
1620 :value value
1621 :duration duration
1622 :begin begin
1623 :end end
1627 "Interpret CLOCK element as Org syntax.
1628 CONTENTS is nil."
1636 "%2s:%02s"
1640 ;;;; Comment
1643 "Parse a comment.
1645 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1646 the buffer position at the beginning of the first affiliated
1647 keyword and CDR is a plist of affiliated keywords along with
1648 their value.
1650 Return a list whose CAR is `comment' and CDR is a plist
1651 containing `:begin', `:end', `:value', `:post-blank',
1652 `:post-affiliated' keywords.
1654 Assume point is at comment beginning."
1663 ;; Get comments ending.
1666 ;; Accumulate lines without leading hash and first
1667 ;; whitespace.
1681 :end end
1682 :value value
1688 "Interpret COMMENT element as Org syntax.
1689 CONTENTS is nil."
1693 ;;;; Comment Block
1696 "Parse an export block.
1698 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1699 the buffer position at the beginning of the first affiliated
1700 keyword and CDR is a plist of affiliated keywords along with
1701 their value.
1703 Return a list whose CAR is `comment-block' and CDR is a plist
1704 containing `:begin', `:end', `:value', `:post-blank' and
1705 `:post-affiliated' keywords.
1707 Assume point is at comment block beginning."
1711 ;; Incomplete block: parse it as a paragraph.
1724 contents-begin contents-end)))
1728 :end end
1729 :value value
1735 "Interpret COMMENT-BLOCK element as Org syntax.
1736 CONTENTS is nil."
1741 ;;;; Diary Sexp
1744 "Parse a diary sexp.
1746 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1747 the buffer position at the beginning of the first affiliated
1748 keyword and CDR is a plist of affiliated keywords along with
1749 their value.
1751 Return a list whose CAR is `diary-sexp' and CDR is a plist
1752 containing `:begin', `:end', `:value', `:post-blank' and
1753 `:post-affiliated' keywords."
1765 :begin begin
1766 :end end
1772 "Interpret DIARY-SEXP as Org syntax.
1773 CONTENTS is nil."
1777 ;;;; Example Block
1780 "Parse an example block.
1782 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1783 the buffer position at the beginning of the first affiliated
1784 keyword and CDR is a plist of affiliated keywords along with
1785 their value.
1787 Return a list whose CAR is `example-block' and CDR is a plist
1788 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1789 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1790 `:value', `:post-blank' and `:post-affiliated' keywords."
1794 ;; Incomplete block: parse it as a paragraph.
1802 ;; Switches analysis
1809 ;; Should labels be retained in (or stripped from) example
1810 ;; blocks?
1815 ;; What should code-references use - labels or
1816 ;; line-numbers?
1825 ;; Standard block parsing.
1833 contents-begin contents-end))
1834 block-ind))
1843 :end end
1844 :value value
1845 :switches switches
1846 :number-lines number-lines
1847 :preserve-indent preserve-indent
1848 :retain-labels retain-labels
1849 :use-labels use-labels
1850 :label-fmt label-fmt
1856 "Interpret EXAMPLE-BLOCK element as Org syntax.
1857 CONTENTS is nil."
1864 value
1869 ;;;; Export Block
1872 "Parse an export block.
1874 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1875 the buffer position at the beginning of the first affiliated
1876 keyword and CDR is a plist of affiliated keywords along with
1877 their value.
1879 Return a list whose CAR is `export-block' and CDR is a plist
1880 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1881 `:post-affiliated' keywords.
1883 Assume point is at export-block beginning."
1890 ;; Incomplete block: parse it as a paragraph.
1903 contents-end)))
1907 :end end
1908 :type type
1909 :value value
1915 "Interpret EXPORT-BLOCK element as Org syntax.
1916 CONTENTS is nil."
1923 ;;;; Fixed-width
1926 "Parse a fixed-width section.
1928 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1929 the buffer position at the beginning of the first affiliated
1930 keyword and CDR is a plist of affiliated keywords along with
1931 their value.
1933 Return a list whose CAR is `fixed-width' and CDR is a plist
1934 containing `:begin', `:end', `:value', `:post-blank' and
1935 `:post-affiliated' keywords.
1937 Assume point is at the beginning of the fixed-width area."
1941 value
1946 ;; Accumulate text without starting colons.
1959 :end end
1960 :value value
1966 "Interpret FIXED-WIDTH element as Org syntax.
1967 CONTENTS is nil."
1975 ;;;; Horizontal Rule
1978 "Parse an horizontal rule.
1980 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1981 the buffer position at the beginning of the first affiliated
1982 keyword and CDR is a plist of affiliated keywords along with
1983 their value.
1985 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1986 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1987 keywords."
1997 :end end
2003 "Interpret HORIZONTAL-RULE element as Org syntax.
2004 CONTENTS is nil."
2008 ;;;; Keyword
2011 "Parse a keyword at point.
2013 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2014 the buffer position at the beginning of the first affiliated
2015 keyword and CDR is a plist of affiliated keywords along with
2016 their value.
2018 Return a list whose CAR is `keyword' and CDR is a plist
2019 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2020 `:post-affiliated' keywords."
2022 ;; An orphaned affiliated keyword is considered as a regular
2023 ;; keyword. In this case AFFILIATED is nil, so we take care of
2024 ;; this corner case.
2037 :value value
2038 :begin begin
2039 :end end
2045 "Interpret KEYWORD element as Org syntax.
2046 CONTENTS is nil."
2052 ;;;; Latex Environment
2055 "Parse a LaTeX environment.
2057 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2058 the buffer position at the beginning of the first affiliated
2059 keyword and CDR is a plist of affiliated keywords along with
2060 their value.
2062 Return a list whose CAR is `latex-environment' and CDR is a plist
2063 containing `:begin', `:end', `:value', `:post-blank' and
2064 `:post-affiliated' keywords.
2066 Assume point is at the beginning of the latex environment."
2073 limit t))
2074 ;; Incomplete latex environment: parse it as a paragraph.
2084 :end end
2085 :value value
2091 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2092 CONTENTS is nil."
2096 ;;;; Node Property
2099 "Parse a node-property at point.
2101 LIMIT bounds the search.
2103 Return a list whose CAR is `node-property' and CDR is a plist
2104 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2105 keywords."
2117 :value value
2118 :begin begin
2119 :end end
2123 "Interpret NODE-PROPERTY element as Org syntax.
2124 CONTENTS is nil."
2130 ;;;; Paragraph
2133 "Parse a paragraph.
2135 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2136 the buffer position at the beginning of the first affiliated
2137 keyword and CDR is a plist of affiliated keywords along with
2138 their value.
2140 Return a list whose CAR is `paragraph' and CDR is a plist
2141 containing `:begin', `:end', `:contents-begin' and
2142 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2144 Assume point is at the beginning of the paragraph."
2153 limit
2154 ;; A matching `org-element-paragraph-separate' is not
2155 ;; necessarily the end of the paragraph. In
2156 ;; particular, lines starting with # or : as a first
2157 ;; non-space character are ambiguous. We have to
2158 ;; check if they are valid Org syntax (e.g., not an
2159 ;; incomplete keyword).
2163 ;; There's no ambiguity for other symbols or
2164 ;; empty lines: stop here.
2166 ;; Stop at valid fixed-width areas.
2168 ;; Stop at drawers.
2173 ;; Stop at valid comments.
2175 ;; Stop at valid dynamic blocks.
2180 ;; Stop at valid blocks.
2187 limit t)))
2188 ;; Stop at valid latex environments.
2196 limit t)))
2197 ;; Stop at valid keywords.
2199 ;; Skip everything else.
2216 :end end
2217 :contents-begin contents-begin
2218 :contents-end contents-end
2224 "Interpret PARAGRAPH element as Org syntax.
2225 CONTENTS is the contents of the element."
2226 contents)
2229 ;;;; Planning
2232 "Parse a planning.
2234 LIMIT bounds the search.
2236 Return a list whose CAR is `planning' and CDR is a plist
2237 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2238 and `:post-blank' keywords."
2248 closed deadline scheduled)
2260 :deadline deadline
2261 :scheduled scheduled
2262 :begin begin
2263 :end end
2267 "Interpret PLANNING element as Org syntax.
2268 CONTENTS is nil."
2270 'identity
2287 ;;;; Src Block
2290 "Parse a src block.
2292 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2293 the buffer position at the beginning of the first affiliated
2294 keyword and CDR is a plist of affiliated keywords along with
2295 their value.
2297 Return a list whose CAR is `src-block' and CDR is a plist
2298 containing `:language', `:switches', `:parameters', `:begin',
2299 `:end', `:number-lines', `:retain-labels', `:use-labels',
2300 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2301 `:post-affiliated' keywords.
2303 Assume point is at the beginning of the block."
2306 limit t)))
2307 ;; Incomplete block: parse it as a paragraph.
2313 ;; Get language as a string.
2322 ;; Get switches.
2324 ;; Get parameters.
2326 ;; Switches analysis
2337 ;; Should labels be retained in (or stripped from)
2338 ;; src blocks?
2343 ;; What should code-references use - labels or
2344 ;; line-numbers?
2349 ;; Indentation.
2351 ;; Retrieve code.
2356 block-ind))
2360 ;; Get position after ending blank lines.
2370 :begin begin
2371 :end end
2372 :number-lines number-lines
2373 :preserve-indent preserve-indent
2374 :retain-labels retain-labels
2375 :use-labels use-labels
2376 :label-fmt label-fmt
2377 :value value
2383 "Interpret SRC-BLOCK element as Org syntax.
2384 CONTENTS is nil."
2393 val)
2407 ;;;; Table
2410 "Parse a table at point.
2412 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2413 the buffer position at the beginning of the first affiliated
2414 keyword and CDR is a plist of affiliated keywords along with
2415 their value.
2417 Return a list whose CAR is `table' and CDR is a plist containing
2418 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2419 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2420 keywords.
2422 Assume point is at the beginning of the table."
2436 acc))
2443 :end end
2444 :type type
2445 :tblfm tblfm
2446 ;; Only `org' tables have contents. `table.el' tables
2447 ;; use a `:value' property to store raw table as
2448 ;; a string.
2453 table-begin table-end))
2459 "Interpret TABLE element as Org syntax.
2460 CONTENTS is nil."
2471 ;;;; Table Row
2474 "Parse table row at point.
2476 LIMIT bounds the search.
2478 Return a list whose CAR is `table-row' and CDR is a plist
2479 containing `:begin', `:end', `:contents-begin', `:contents-end',
2480 `:type' and `:post-blank' keywords."
2484 ;; A table rule has no contents. In that case, ensure
2485 ;; CONTENTS-BEGIN matches CONTENTS-END.
2497 :begin begin
2498 :end end
2499 :contents-begin contents-begin
2500 :contents-end contents-end
2504 "Interpret TABLE-ROW element as Org syntax.
2505 CONTENTS is the contents of the table row."
2510 ;;;; Verse Block
2513 "Parse a verse block.
2515 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2516 the buffer position at the beginning of the first affiliated
2517 keyword and CDR is a plist of affiliated keywords along with
2518 their value.
2520 Return a list whose CAR is `verse-block' and CDR is a plist
2521 containing `:begin', `:end', `:contents-begin', `:contents-end',
2522 `:post-blank' and `:post-affiliated' keywords.
2524 Assume point is at beginning of the block."
2528 ;; Incomplete block: parse it as a paragraph.
2543 :end end
2544 :contents-begin contents-begin
2545 :contents-end contents-end
2551 "Interpret VERSE-BLOCK element as Org syntax.
2552 CONTENTS is verse block contents."
2556 \f
2557 ;;; Objects
2558 ;;
2559 ;; Unlike to elements, interstices can be found between objects.
2560 ;; That's why, along with the parser, successor functions are provided
2561 ;; for each object. Some objects share the same successor (e.g.,
2562 ;; `code' and `verbatim' objects).
2563 ;;
2564 ;; A successor must accept a single argument bounding the search. It
2565 ;; will return either a cons cell whose CAR is the object's type, as
2566 ;; a symbol, and CDR the position of its next occurrence, or nil.
2567 ;;
2568 ;; Successors follow the naming convention:
2569 ;; org-element-NAME-successor, where NAME is the name of the
2570 ;; successor, as defined in `org-element-all-successors'.
2571 ;;
2572 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2573 ;; object types they can contain will be specified in
2574 ;; `org-element-object-restrictions'.
2575 ;;
2576 ;; Adding a new type of object is simple. Implement a successor,
2577 ;; a parser, and an interpreter for it, all following the naming
2578 ;; convention. Register type in `org-element-all-objects' and
2579 ;; successor in `org-element-all-successors'. Maybe tweak
2580 ;; restrictions about it, and that's it.
2583 ;;;; Bold
2586 "Parse bold object at point.
2588 Return a list whose CAR is `bold' and CDR is a plist with
2589 `:begin', `:end', `:contents-begin' and `:contents-end' and
2590 `:post-blank' keywords.
2592 Assume point is at the first star marker."
2604 :end end
2605 :contents-begin contents-begin
2606 :contents-end contents-end
2610 "Interpret BOLD object as Org syntax.
2611 CONTENTS is the contents of the object."
2615 "Search for the next text-markup object.
2617 Return value is a cons cell whose CAR is a symbol among `bold',
2618 `italic', `underline', `strike-through', `code' and `verbatim'
2619 and CDR is beginning position."
2635 ;;;; Code
2638 "Parse code object at point.
2640 Return a list whose CAR is `code' and CDR is a plist with
2641 `:value', `:begin', `:end' and `:post-blank' keywords.
2643 Assume point is at the first tilde marker."
2654 :begin begin
2655 :end end
2659 "Interpret CODE object as Org syntax.
2660 CONTENTS is nil."
2664 ;;;; Entity
2667 "Parse entity at point.
2669 Return a list whose CAR is `entity' and CDR a plist with
2670 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2671 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2672 keywords.
2674 Assume point is at the beginning of the entity."
2676 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2692 :begin begin
2693 :end end
2694 :use-brackets-p bracketsp
2698 "Interpret ENTITY object as Org syntax.
2699 CONTENTS is nil."
2705 "Search for the next latex-fragment or entity object.
2707 Return value is a cons cell whose CAR is `entity' or
2708 `latex-fragment' and CDR is beginning position."
2712 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2719 ;; Determine if it's a real entity or a LaTeX command.
2722 ;; No entity nor command: point is at a LaTeX fragment.
2723 ;; Determine its type to get the correct beginning position.
2732 ;;;; Export Snippet
2735 "Parse export snippet at point.
2737 Return a list whose CAR is `export-snippet' and CDR a plist with
2738 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2739 keywords.
2741 Assume point is at the beginning of the snippet."
2753 :value value
2754 :begin begin
2755 :end end
2759 "Interpret EXPORT-SNIPPET object as Org syntax.
2760 CONTENTS is nil."
2766 "Search for the next export-snippet object.
2768 Return value is a cons cell whose CAR is `export-snippet' and CDR
2769 its beginning position."
2778 ;;;; Footnote Reference
2781 "Parse footnote reference at point.
2783 Return a list whose CAR is `footnote-reference' and CDR a plist
2784 with `:label', `:type', `:inline-definition', `:begin', `:end'
2785 and `:post-blank' as keywords."
2807 :type type
2808 :begin begin
2809 :end end
2812 footnote-reference :inline-definition
2817 footnote-reference))))))
2820 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2821 CONTENTS is nil."
2831 "Search for the next footnote-reference object.
2833 Return value is a cons cell whose CAR is `footnote-reference' and
2834 CDR is beginning position."
2848 ;;;; Inline Babel Call
2851 "Parse inline babel call at point.
2853 Return a list whose CAR is `inline-babel-call' and CDR a plist
2854 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2856 Assume point is at the beginning of the babel call."
2868 :end end
2869 :value value
2873 "Interpret INLINE-BABEL-CALL object as Org syntax.
2874 CONTENTS is nil."
2878 "Search for the next inline-babel-call object.
2880 Return value is a cons cell whose CAR is `inline-babel-call' and
2881 CDR is beginning position."
2891 ;;;; Inline Src Block
2894 "Parse inline source block at point.
2896 Return a list whose CAR is `inline-src-block' and CDR a plist
2897 with `:begin', `:end', `:language', `:value', `:parameters' and
2898 `:post-blank' as keywords.
2900 Assume point is at the beginning of the inline src block."
2913 :value value
2914 :parameters parameters
2915 :begin begin
2916 :end end
2920 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2921 CONTENTS is nil."
2926 language
2928 body)))
2931 "Search for the next inline-babel-call element.
2933 Return value is a cons cell whose CAR is `inline-babel-call' and
2934 CDR is beginning position."
2940 ;;;; Italic
2943 "Parse italic object at point.
2945 Return a list whose CAR is `italic' and CDR is a plist with
2946 `:begin', `:end', `:contents-begin' and `:contents-end' and
2947 `:post-blank' keywords.
2949 Assume point is at the first slash marker."
2961 :end end
2962 :contents-begin contents-begin
2963 :contents-end contents-end
2967 "Interpret ITALIC object as Org syntax.
2968 CONTENTS is the contents of the object."
2972 ;;;; Latex Fragment
2975 "Parse LaTeX fragment at point.
2977 Return a list whose CAR is `latex-fragment' and CDR a plist with
2978 `:value', `:begin', `:end', and `:post-blank' as keywords.
2980 Assume point is at the beginning of the LaTeX fragment."
2993 ;; None found: it's a macro.
3002 :begin begin
3003 :end end
3007 "Interpret LATEX-FRAGMENT object as Org syntax.
3008 CONTENTS is nil."
3011 ;;;; Line Break
3014 "Parse line break at point.
3016 Return a list whose CAR is `line-break', and CDR a plist with
3017 `:begin', `:end' and `:post-blank' keywords.
3019 Assume point is at the beginning of the line break."
3026 "Interpret LINE-BREAK object as Org syntax.
3027 CONTENTS is nil."
3031 "Search for the next line-break object.
3033 Return value is a cons cell whose CAR is `line-break' and CDR is
3034 beginning position."
3038 ;; A line break can only happen on a non-empty line.
3043 ;;;; Link
3046 "Parse link at point.
3048 Return a list whose CAR is `link' and CDR a plist with `:type',
3049 `:path', `:raw-link', `:application', `:search-option', `:begin',
3050 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3051 keywords.
3053 Assume point is at the beginning of the link."
3056 end contents-begin contents-end link-end post-blank path type
3057 raw-link link search-option application)
3059 ;; Type 1: Text targeted from a radio target.
3064 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3069 ;; RAW-LINK is the original link. Expand any
3070 ;; abbreviation in it.
3074 ;; Determine TYPE of link and set PATH accordingly.
3076 ;; File type.
3080 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3083 ;; Id type: PATH is the id.
3086 ;; Code-ref type: PATH is the name of the reference.
3089 ;; Custom-id type: PATH is the name of the custom id.
3092 ;; Fuzzy type: Internal link either matches a target, an
3093 ;; headline name or nothing. PATH is the target or
3094 ;; headline's name.
3096 ;; Type 3: Plain link, e.g., http://orgmode.org
3102 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3109 ;; In any case, deduce end point after trailing white space from
3110 ;; LINK-END variable.
3113 ;; Extract search option and opening application out of
3114 ;; "file"-type links.
3116 ;; Application.
3121 ;; Extract search option from PATH.
3125 ;; Make sure TYPE always reports "file".
3129 :path path
3131 :application application
3132 :search-option search-option
3133 :begin begin
3134 :end end
3135 :contents-begin contents-begin
3136 :contents-end contents-end
3140 "Interpret LINK object as Org syntax.
3141 CONTENTS is the contents of the object, or nil."
3146 raw-link
3150 "Search for the next link object.
3152 Return value is a cons cell whose CAR is `link' and CDR is
3153 beginning position."
3162 "Search for the next plain link object.
3164 Return value is a cons cell whose CAR is `link' and CDR is
3165 beginning position."
3170 ;;;; Macro
3173 "Parse macro at point.
3175 Return a list whose CAR is `macro' and CDR a plist with `:key',
3176 `:args', `:begin', `:end', `:value' and `:post-blank' as
3177 keywords.
3179 Assume point is at the macro."
3190 ;; Do not use `org-split-string' since empty
3191 ;; strings are meaningful here.
3199 args nil t)
3203 :value value
3204 :args args
3205 :begin begin
3206 :end end
3210 "Interpret MACRO object as Org syntax.
3211 CONTENTS is nil."
3215 "Search for the next macro object.
3217 Return value is cons cell whose CAR is `macro' and CDR is
3218 beginning position."
3222 nil t)
3226 ;;;; Radio-target
3229 "Parse radio target at point.
3231 Return a list whose CAR is `radio-target' and CDR a plist with
3232 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3233 and `:post-blank' as keywords.
3235 Assume point is at the radio target."
3247 :end end
3248 :contents-begin contents-begin
3249 :contents-end contents-end
3250 :post-blank post-blank
3254 "Interpret TARGET object as Org syntax.
3255 CONTENTS is the contents of the object."
3259 "Search for the next radio-target object.
3261 Return value is a cons cell whose CAR is `radio-target' and CDR
3262 is beginning position."
3268 ;;;; Statistics Cookie
3271 "Parse statistics cookie at point.
3273 Return a list whose CAR is `statistics-cookie', and CDR a plist
3274 with `:begin', `:end', `:value' and `:post-blank' keywords.
3276 Assume point is at the beginning of the statistics-cookie."
3287 :end end
3288 :value value
3292 "Interpret STATISTICS-COOKIE object as Org syntax.
3293 CONTENTS is nil."
3297 "Search for the next statistics cookie object.
3299 Return value is a cons cell whose CAR is `statistics-cookie' and
3300 CDR is beginning position."
3306 ;;;; Strike-Through
3309 "Parse strike-through object at point.
3311 Return a list whose CAR is `strike-through' and CDR is a plist
3312 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3313 `:post-blank' keywords.
3315 Assume point is at the first plus sign marker."
3327 :end end
3328 :contents-begin contents-begin
3329 :contents-end contents-end
3333 "Interpret STRIKE-THROUGH object as Org syntax.
3334 CONTENTS is the contents of the object."
3338 ;;;; Subscript
3341 "Parse subscript at point.
3343 Return a list whose CAR is `subscript' and CDR a plist with
3344 `:begin', `:end', `:contents-begin', `:contents-end',
3345 `:use-brackets-p' and `:post-blank' as keywords.
3347 Assume point is at the underscore."
3361 :end end
3362 :use-brackets-p bracketsp
3363 :contents-begin contents-begin
3364 :contents-end contents-end
3368 "Interpret SUBSCRIPT object as Org syntax.
3369 CONTENTS is the contents of the object."
3372 contents))
3375 "Search for the next sub/superscript object.
3377 Return value is a cons cell whose CAR is either `subscript' or
3378 `superscript' and CDR is beginning position."
3386 ;;;; Superscript
3389 "Parse superscript at point.
3391 Return a list whose CAR is `superscript' and CDR a plist with
3392 `:begin', `:end', `:contents-begin', `:contents-end',
3393 `:use-brackets-p' and `:post-blank' as keywords.
3395 Assume point is at the caret."
3409 :end end
3410 :use-brackets-p bracketsp
3411 :contents-begin contents-begin
3412 :contents-end contents-end
3416 "Interpret SUPERSCRIPT object as Org syntax.
3417 CONTENTS is the contents of the object."
3420 contents))
3423 ;;;; Table Cell
3426 "Parse table cell at point.
3428 Return a list whose CAR is `table-cell' and CDR is a plist
3429 containing `:begin', `:end', `:contents-begin', `:contents-end'
3430 and `:post-blank' keywords."
3438 :end end
3439 :contents-begin contents-begin
3440 :contents-end contents-end
3444 "Interpret TABLE-CELL element as Org syntax.
3445 CONTENTS is the contents of the cell, or nil."
3449 "Search for the next table-cell object.
3451 Return value is a cons cell whose CAR is `table-cell' and CDR is
3452 beginning position."
3456 ;;;; Target
3459 "Parse target at point.
3461 Return a list whose CAR is `target' and CDR a plist with
3462 `:begin', `:end', `:value' and `:post-blank' as keywords.
3464 Assume point is at the target."
3474 :end end
3475 :value value
3479 "Interpret TARGET object as Org syntax.
3480 CONTENTS is nil."
3484 "Search for the next target object.
3486 Return value is a cons cell whose CAR is `target' and CDR is
3487 beginning position."
3493 ;;;; Timestamp
3496 "Parse time stamp at point.
3498 Return a list whose CAR is `timestamp', and CDR a plist with
3499 `:type', `:raw-value', `:year-start', `:month-start',
3500 `:day-start', `:hour-start', `:minute-start', `:year-end',
3501 `:month-end', `:day-end', `:hour-end', `:minute-end',
3502 `:repeater-type', `:repeater-value', `:repeater-unit',
3503 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3504 `:end', `:value' and `:post-blank' keywords.
3506 Assume point is at the beginning of the timestamp."
3524 date-start)
3535 raw-value)
3537 :repeater-type
3543 :repeater-unit
3552 :warning-unit
3555 year-start month-start day-start hour-start minute-start year-end
3556 month-end day-end hour-end minute-end)
3557 ;; Parse date-start.
3565 ;; Compute date-end. It can be provided directly in time-stamp,
3566 ;; or extracted from time range. Otherwise, it defaults to the
3567 ;; same values as date-start.
3577 :raw-value raw-value
3578 :year-start year-start
3579 :month-start month-start
3580 :day-start day-start
3581 :hour-start hour-start
3582 :minute-start minute-start
3583 :year-end year-end
3584 :month-end month-end
3585 :day-end day-end
3586 :hour-end hour-end
3587 :minute-end minute-end
3588 :begin begin
3589 :end end
3591 repeater-props
3592 warning-props)))))
3595 "Interpret TIMESTAMP object as Org syntax.
3596 CONTENTS is nil."
3615 ;; Build an Org timestamp string from TIME. ACTIVEP is
3616 ;; non-nil when time stamp is active. If WITH-TIME-P is
3617 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3618 ;; specify a time range in the timestamp. REPEAT-STRING is
3619 ;; the repeater string, if any.
3623 org-time-stamp-formats)
3624 time)))
3630 nil nil ts)))
3635 " "
3636 s
3638 ;; Return value.
3639 ts)))
3651 build-ts-string
3670 0
3678 "--"
3690 "Search for the next timestamp object.
3692 Return value is a cons cell whose CAR is `timestamp' and CDR is
3693 beginning position."
3701 nil t)
3705 ;;;; Underline
3708 "Parse underline object at point.
3710 Return a list whose CAR is `underline' and CDR is a plist with
3711 `:begin', `:end', `:contents-begin' and `:contents-end' and
3712 `:post-blank' keywords.
3714 Assume point is at the first underscore marker."
3726 :end end
3727 :contents-begin contents-begin
3728 :contents-end contents-end
3732 "Interpret UNDERLINE object as Org syntax.
3733 CONTENTS is the contents of the object."
3737 ;;;; Verbatim
3740 "Parse verbatim object at point.
3742 Return a list whose CAR is `verbatim' and CDR is a plist with
3743 `:value', `:begin', `:end' and `:post-blank' keywords.
3745 Assume point is at the first equal sign marker."
3756 :begin begin
3757 :end end
3761 "Interpret VERBATIM object as Org syntax.
3762 CONTENTS is nil."
3766 \f
3767 ;;; Parsing Element Starting At Point
3768 ;;
3769 ;; `org-element--current-element' is the core function of this section.
3770 ;; It returns the Lisp representation of the element starting at
3771 ;; point.
3772 ;;
3773 ;; `org-element--current-element' makes use of special modes. They
3774 ;; are activated for fixed element chaining (e.g., `plain-list' >
3775 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3776 ;; `section'). Special modes are: `first-section', `item',
3777 ;; `node-property', `section' and `table-row'.
3781 "Parse the element starting at point.
3783 Return value is a list like (TYPE PROPS) where TYPE is the type
3784 of the element and PROPS a plist of properties associated to the
3785 element.
3787 Possible types are defined in `org-element-all-elements'.
3789 LIMIT bounds the search.
3791 Optional argument GRANULARITY determines the depth of the
3792 recursion. Allowed values are `headline', `greater-element',
3793 `element', `object' or nil. When it is broader than `object' (or
3794 nil), secondary values will not be parsed, since they only
3795 contain objects.
3797 Optional argument SPECIAL, when non-nil, can be either
3798 `first-section', `item', `node-property', `section', and
3799 `table-row'.
3801 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3802 be computed.
3804 This function assumes point is always at the beginning of the
3805 element it has to parse."
3808 ;; Determine if parsing depth allows for secondary strings
3809 ;; parsing. It only applies to elements referenced in
3810 ;; `org-element-secondary-value-alist'.
3813 ;; Item.
3816 ;; Table Row.
3818 ;; Node Property.
3820 ;; Headline.
3823 ;; Sections (must be checked after headline).
3828 limit)))
3829 ;; When not at bol, point is at the beginning of an item or
3830 ;; a footnote definition: next item is always a paragraph.
3832 ;; Planning and Clock.
3837 ;; Inlinetask.
3840 ;; From there, elements can have affiliated keywords.
3843 ;; Jumping over affiliated keywords put point off-limits.
3844 ;; Parse them as regular keywords.
3848 ;; LaTeX Environment.
3852 ;; Drawer and Property Drawer.
3857 ;; Fixed Width
3860 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3861 ;; Keywords.
3870 org-element-block-name-alist)))
3885 ;; Footnote Definition.
3888 ;; Horizontal Rule.
3891 ;; Diary Sexp.
3894 ;; Table.
3896 ;; List.
3899 limit affiliated
3901 ;; Default element: Paragraph.
3905 ;; Most elements can have affiliated keywords. When looking for an
3906 ;; element beginning, we want to move before them, as they belong to
3907 ;; that element, and, in the meantime, collect information they give
3908 ;; into appropriate properties. Hence the following function.
3911 "Collect affiliated keywords from point down to LIMIT.
3913 Return a list whose CAR is the position at the first of them and
3914 CDR a plist of keywords and values and move point to the
3915 beginning of the first line after them.
3917 As a special case, if element doesn't start at the beginning of
3918 the line (e.g., a paragraph starting an item), CAR is current
3919 position of point and CDR is nil."
3923 ;; RESTRICT is the list of objects allowed in parsed
3924 ;; keywords value.
3926 output)
3929 ;; Apply translation to RAW-KWD. From there, KWD is
3930 ;; the official keyword.
3932 org-element-keyword-translation-alist))
3933 raw-kwd))
3934 ;; Find main value for any keyword.
3940 ;; PARSEDP is non-nil when keyword should have its
3941 ;; value parsed.
3943 ;; If KWD is a dual keyword, find its secondary
3944 ;; value. Maybe parse it.
3951 ;; Attribute a property name to KWD.
3953 ;; Now set final shape for VALUE.
3959 ;; Attributes can always appear on multiple lines.
3962 ;; Eventually store the new value in OUTPUT.
3964 ;; Move to next keyword.
3966 ;; If affiliated keywords are orphaned: move back to first one.
3967 ;; They will be parsed as a paragraph.
3969 ;; Return value.
3973 \f
3974 ;;; The Org Parser
3975 ;;
3976 ;; The two major functions here are `org-element-parse-buffer', which
3977 ;; parses Org syntax inside the current buffer, taking into account
3978 ;; region, narrowing, or even visibility if specified, and
3979 ;; `org-element-parse-secondary-string', which parses objects within
3980 ;; a given string.
3981 ;;
3982 ;; The (almost) almighty `org-element-map' allows to apply a function
3983 ;; on elements or objects matching some type, and accumulate the
3984 ;; resulting values. In an export situation, it also skips unneeded
3985 ;; parts of the parse tree.
3988 "Recursively parse the buffer and return structure.
3989 If narrowing is in effect, only parse the visible part of the
3990 buffer.
3992 Optional argument GRANULARITY determines the depth of the
3993 recursion. It can be set to the following symbols:
3995 `headline' Only parse headlines.
3996 `greater-element' Don't recurse into greater elements excepted
3997 headlines and sections. Thus, elements
3998 parsed are the top-level ones.
3999 `element' Parse everything but objects and plain text.
4000 `object' Parse the complete buffer (default).
4002 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4003 elements.
4005 An element or an objects is represented as a list with the
4006 pattern (TYPE PROPERTIES CONTENTS), where :
4008 TYPE is a symbol describing the element or object. See
4009 `org-element-all-elements' and `org-element-all-objects' for an
4010 exhaustive list of such symbols. One can retrieve it with
4011 `org-element-type' function.
4013 PROPERTIES is the list of attributes attached to the element or
4014 object, as a plist. Although most of them are specific to the
4015 element or object type, all types share `:begin', `:end',
4016 `:post-blank' and `:parent' properties, which respectively
4017 refer to buffer position where the element or object starts,
4018 ends, the number of white spaces or blank lines after it, and
4019 the element or object containing it. Properties values can be
4020 obtained by using `org-element-property' function.
4022 CONTENTS is a list of elements, objects or raw strings
4023 contained in the current element or object, when applicable.
4024 One can access them with `org-element-contents' function.
4026 The Org buffer has `org-data' as type and nil as properties.
4027 `org-element-map' function can be used to find specific elements
4028 or objects within the parse tree.
4030 This function assumes that current major mode is `org-mode'."
4036 ;; Start in `first-section' mode so text before the first
4037 ;; headline belongs to a section.
4041 "Recursively parse objects in STRING and return structure.
4043 RESTRICTION is a symbol limiting the object types that will be
4044 looked after.
4046 Optional argument PARENT, when non-nil, is the element or object
4047 containing the secondary string. It is used to set correctly
4048 `:parent' property within the string."
4049 ;; Copy buffer-local variables listed in
4050 ;; `org-element-object-variables' into temporary buffer. This is
4051 ;; required since object parsing is dependent on these variables.
4055 org-element-object-variables))))
4063 secondary))
4064 secondary))))
4068 "Map a function on selected elements or objects.
4070 DATA is a parse tree, an element, an object, a string, or a list
4071 of such constructs. TYPES is a symbol or list of symbols of
4072 elements or objects types (see `org-element-all-elements' and
4073 `org-element-all-objects' for a complete list of types). FUN is
4074 the function called on the matching element or object. It has to
4075 accept one argument: the element or object itself.
4077 When optional argument INFO is non-nil, it should be a plist
4078 holding export options. In that case, parts of the parse tree
4079 not exportable according to that property list will be skipped.
4081 When optional argument FIRST-MATCH is non-nil, stop at the first
4082 match for which FUN doesn't return nil, and return that value.
4084 Optional argument NO-RECURSION is a symbol or a list of symbols
4085 representing elements or objects types. `org-element-map' won't
4086 enter any recursive element or object whose type belongs to that
4087 list. Though, FUN can still be applied on them.
4089 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4090 apply to matching objects within parsed affiliated keywords (see
4091 `org-element-parsed-keywords').
4093 Nil values returned from FUN do not appear in the results.
4096 Examples:
4097 ---------
4099 Assuming TREE is a variable containing an Org buffer parse tree,
4100 the following example will return a flat list of all `src-block'
4101 and `example-block' elements in it:
4103 \(org-element-map tree '(example-block src-block) 'identity)
4105 The following snippet will find the first headline with a level
4108 \(org-element-map tree 'headline
4109 \(lambda (hl)
4110 \(and (= (org-element-property :level hl) 1)
4112 \(org-element-property :begin hl)))
4113 nil t)
4115 The next example will return a flat list of all `plain-list' type
4116 elements in TREE that are not a sub-list themselves:
4118 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4120 Eventually, this example will return a flat list of all `bold'
4121 type objects containing a `latex-snippet' type object, even
4122 looking into captions:
4124 \(org-element-map tree 'bold
4125 \(lambda (b)
4126 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4127 nil nil nil t)"
4128 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4131 ;; Recursion depth is determined by --CATEGORY.
4138 ;; If one object is found, the function
4139 ;; has to recurse into every object.
4142 ;; If one regular element is found, the
4143 ;; function has to recurse, at least,
4144 ;; into every element it encounters.
4147 types)
4148 category)))
4149 ;; Compute properties for affiliated keywords if necessary.
4154 org-element-affiliated-keywords)))
4155 --acc
4156 --walk-tree
4160 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4161 ;; holding contextual information.
4165 ;; Ignored element in an export context.
4167 ;; List of elements or objects.
4169 ;; Unconditionally enter parse trees.
4173 ;; Check if TYPE is matching among TYPES. If so,
4174 ;; apply FUN to --DATA and accumulate return value
4175 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4181 ;; If --DATA has a secondary string that can contain
4182 ;; objects with their type among TYPES, look into it.
4189 ;; If --DATA has any affiliated keywords and
4190 ;; WITH-AFFILIATED is non-nil, look for objects in
4191 ;; them.
4199 ;; Pay attention to the type of value.
4200 ;; Preserve order for multiple keywords.
4216 --affiliated-alist))
4217 ;; Determine if a recursion into --DATA is possible.
4219 ;; --TYPE is explicitly removed from recursion.
4221 ;; --DATA has no contents.
4223 ;; Looking for greater elements but --DATA is simply
4224 ;; an element or an object.
4227 ;; Looking for elements but --DATA is an object.
4230 ;; In any other case, map contents.
4234 ;; Return value in a proper order.
4238 ;; The following functions are internal parts of the parser.
4239 ;;
4240 ;; The first one, `org-element--parse-elements' acts at the element's
4241 ;; level.
4242 ;;
4243 ;; The second one, `org-element--parse-objects' applies on all objects
4244 ;; of a paragraph or a secondary string. It uses
4245 ;; `org-element--get-next-object-candidates' to optimize the search of
4246 ;; the next object in the buffer.
4247 ;;
4248 ;; More precisely, that function looks for every allowed object type
4249 ;; first. Then, it discards failed searches, keeps further matches,
4250 ;; and searches again types matched behind point, for subsequent
4251 ;; calls. Thus, searching for a given type fails only once, and every
4252 ;; object is searched only once at top level (but sometimes more for
4253 ;; nested types).
4257 "Parse elements between BEG and END positions.
4259 SPECIAL prioritize some elements over the others. It can be set
4260 to `first-section', `section' `item' or `table-row'.
4262 When value is `item', STRUCTURE will be used as the current list
4263 structure.
4265 GRANULARITY determines the depth of the recursion. See
4266 `org-element-parse-buffer' for more information.
4268 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4269 elements.
4271 Elements are accumulated into ACC."
4274 ;; Visible only: skip invisible parts at the beginning of the
4275 ;; element.
4278 ;; When parsing only headlines, skip any text before first one.
4281 ;; Main loop start.
4283 ;; Find current element's type and parse it accordingly to
4284 ;; its category.
4286 end granularity special structure))
4290 ;; Visible only: skip invisible parts between siblings.
4293 ;; Fill ELEMENT contents by side-effect.
4295 ;; If element has no contents, don't modify it.
4297 ;; Greater element: parse it between `contents-begin' and
4298 ;; `contents-end'. Make sure GRANULARITY allows the
4299 ;; recursion, or ELEMENT is a headline, in which case going
4300 ;; inside is mandatory, in order to get sub-level headings.
4308 ;; Possibly switch to a special mode.
4316 granularity visible-only element))
4317 ;; ELEMENT has contents. Parse objects inside, if
4318 ;; GRANULARITY allows it.
4324 ;; Return result.
4325 acc))
4328 "Parse objects between BEG and END and return recursive structure.
4330 Objects are accumulated in ACC.
4332 RESTRICTION is a list of object successors which are allowed in
4333 the current object."
4342 restriction candidates)))
4349 ;; 1. Text before any object. Untabify it.
4354 acc
4358 ;; 2. Object...
4361 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4362 ;; a recursive type.
4370 ;; 3. Text after last object. Untabify it.
4374 acc
4378 ;; Result.
4379 acc))))
4382 "Return an alist of candidates for the next object.
4384 RESTRICTION is a list of object types, as symbols. Only
4385 candidates with such types are looked after.
4387 OBJECTS is the previous candidates alist. If it is set to
4388 `initial', no search has been done before, and all symbols in
4389 RESTRICTION should be looked after.
4391 Return value is an alist whose CAR is the object type and CDR its
4392 beginning position."
4394 nil
4396 ;; When searching for the first time, look for every successor
4397 ;; allowed in RESTRICTION.
4401 restriction)
4402 ;; Focus on objects returned during last search. Keep those
4403 ;; still after point. Search again objects before it.
4409 type)))
4412 objects))))
4415 \f
4416 ;;; Towards A Bijective Process
4417 ;;
4418 ;; The parse tree obtained with `org-element-parse-buffer' is really
4419 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4420 ;; interpreted and expanded into a string with canonical Org syntax.
4421 ;; Hence `org-element-interpret-data'.
4422 ;;
4423 ;; The function relies internally on
4424 ;; `org-element--interpret-affiliated-keywords'.
4426 ;;;###autoload
4428 "Interpret DATA as Org syntax.
4430 DATA is a parse tree, an element, an object or a secondary string
4431 to interpret.
4433 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4434 new types that should be treated as objects. An unknown type not
4435 belonging to this list is seen as a pseudo-element instead. Both
4436 pseudo-objects and pseudo-elements are transparent entities, i.e.
4437 only their contents are interpreted.
4439 Return Org syntax as a string."
4443 "Interpret DATA as Org syntax.
4445 DATA is a parse tree, an element, an object or a secondary string
4446 to interpret. PARENT is used for recursive calls. It contains
4447 the element or object containing data, or nil. PSEUDO-OBJECTS
4448 are list of symbols defining new element or object types.
4449 Unknown types that don't belong to this list are treated as
4450 pseudo-elements instead.
4452 Return Org syntax as a string."
4454 ;; Find interpreter for current object or element. If it
4455 ;; doesn't exist (e.g. this is a pseudo object or element),
4456 ;; return contents, if any.
4462 ;; Secondary string.
4468 ;; Full Org document.
4474 ;; Plain text: return it.
4476 ;; Element or object without contents.
4478 ;; Element or object with contents.
4481 ;; Recursively interpret contents.
4487 data
4488 ;; Fix indentation of elements containing
4489 ;; objects. We ignore `table-row' elements
4490 ;; as they are one line long anyway.
4492 data
4493 ;; When normalizing first paragraph of an
4494 ;; item or a footnote-definition, ignore
4495 ;; first line's indentation.
4502 ;; Build white spaces. If no `:post-blank' property is
4503 ;; specified, assume its value is 0.
4514 "Return ELEMENT's affiliated keywords as Org syntax.
4515 If there is no affiliated keyword, return the empty string."
4525 ": "
4528 value)
4536 ;; All attribute keywords can have multiple lines.
4542 ;; List all ELEMENT's properties matching an attribute line or an
4543 ;; affiliated keyword, but ignore translated keywords since they
4544 ;; cannot belong to the property list.
4551 org-element-keyword-translation-alist)))))
4552 collect prop)
4555 ;; Because interpretation of the parse tree must return the same
4556 ;; number of blank lines between elements and the same number of white
4557 ;; space after objects, some special care must be given to white
4558 ;; spaces.
4559 ;;
4560 ;; The first function, `org-element-normalize-string', ensures any
4561 ;; string different from the empty string will end with a single
4562 ;; newline character.
4563 ;;
4564 ;; The second function, `org-element-normalize-contents', removes
4565 ;; global indentation from the contents of the current element.
4568 "Ensure string S ends with a single newline character.
4570 If S isn't a string return it unchanged. If S is the empty
4571 string, return it. Otherwise, return a new string with a single
4572 newline character at its end."
4580 "Normalize plain text in ELEMENT's contents.
4582 ELEMENT must only contain plain text and objects.
4584 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4585 indentation to compute maximal common indentation.
4587 Return the normalized element that is element with global
4588 indentation removed from its contents. The function assumes that
4589 indentation is not done with TAB characters."
4591 find-min-ind ; For byte-compiler.
4594 ;; Return minimal common indentation within BLOB. This is
4595 ;; done by walking recursively BLOB and updating MIN-IND
4596 ;; along the way. FIRST-FLAG is non-nil when the first
4597 ;; string hasn't been seen yet. It is required as this
4598 ;; string is the only one whose indentation doesn't happen
4599 ;; after a newline character.
4606 ;; An indentation of zero means no string will be
4607 ;; modified. Quit the process.
4616 ;; Find minimal indentation in ELEMENT.
4619 ;; Build ELEMENT back, replacing each string with the same
4620 ;; string minus common indentation.
4625 ;; Return BLOB with all its strings indentation
4626 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4627 ;; is non-nil when the first string hasn't been seen
4628 ;; yet.
4643 org-element-recursive-objects)
4647 blob))))
4651 \f
4652 ;;; Cache
4653 ;;
4654 ;; Implement a caching mechanism for `org-element-at-point' and
4655 ;; `org-element-context', which see.
4656 ;;
4657 ;; A single public function is provided: `org-element-cache-reset'.
4658 ;;
4659 ;; Cache is enabled by default, but can be disabled globally with
4660 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4661 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4662 ;; can be tweaked to control caching behaviour.
4663 ;;
4664 ;; Internally, parsed elements are stored in an AVL tree,
4665 ;; `org-element--cache'. This tree is updated lazily: whenever
4666 ;; a change happens to the buffer, a synchronization request is
4667 ;; registered in `org-element--cache-sync-requests' (see
4668 ;; `org-element--cache-submit-request'). During idle time, requests
4669 ;; are processed by `org-element--cache-sync'. Synchronization also
4670 ;; happens when an element is required from the cache. In this case,
4671 ;; the process stops as soon as the needed element is up-to-date.
4672 ;;
4673 ;; A synchronization request can only apply on a synchronized part of
4674 ;; the cache. Therefore, the cache is updated at least to the
4675 ;; location where the new request applies. Thus, requests are ordered
4676 ;; from left to right and all elements starting before the first
4677 ;; request are correct. This property is used by functions like
4678 ;; `org-element--cache-find' to retrieve elements in the part of the
4679 ;; cache that can be trusted.
4680 ;;
4681 ;; A request applies to every element, starting from its original
4682 ;; location (or key, see below). When a request is processed, it
4683 ;; moves forward and may collide the next one. In this case, both
4684 ;; requests are merged into a new one that starts from that element.
4685 ;; As a consequence, the whole synchronization complexity does not
4686 ;; depend on the number of pending requests, but on the number of
4687 ;; elements the very first request will be applied on.
4688 ;;
4689 ;; Elements cannot be accessed through their beginning position, which
4690 ;; may or may not be up-to-date. Instead, each element in the tree is
4691 ;; associated to a key, obtained with `org-element--cache-key'. This
4692 ;; mechanism is robust enough to preserve total order among elements
4693 ;; even when the tree is only partially synchronized.
4694 ;;
4695 ;; Objects contained in an element are stored in a hash table,
4696 ;; `org-element--cache-objects'.
4700 "Non nil when Org parser should cache its results.
4707 "Maximum duration, as a time value, for a cache synchronization.
4708 If the synchronization is not over after this delay, the process
4709 pauses and resumes after `org-element-cache-sync-break'
4713 "Duration, as a time value, of the pause between synchronizations.
4717 ;;;; Data Structure
4720 "AVL tree used to cache elements.
4721 Each node of the tree contains an element. Comparison is done
4722 with `org-element--cache-compare'. This cache is used in
4726 "Hash table used as to cache objects.
4727 Key is an element, as returned by `org-element-at-point', and
4728 value is an alist where each association is:
4730 \(POS CANDIDATES . OBJECTS)
4732 where POS is a buffer position, CANDIDATES is the last know list
4733 of successors (see `org-element--get-next-object-candidates') in
4734 container starting at POS and OBJECTS is a list of objects known
4735 to live within that container, from farthest to closest.
4738 at, respectively, positions 1, 7 and 8,
4742 If the paragraph is completely parsed, OBJECTS-DATA will be
4744 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
4745 \(8 nil ENTITY-OBJECT))
4747 whereas in a partially parsed paragraph, it could be
4749 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
4754 "List of pending synchronization requests.
4756 A request is a vector with the following pattern:
4758 \[NEXT END OFFSET PARENT PHASE]
4760 Processing a synchronization request consists in three phases:
4762 0. Delete modified elements,
4763 1. Fill missing area in cache,
4764 2. Shift positions and re-parent elements after the changes.
4766 During phase 0, NEXT is the key of the first element to be
4767 removed and END is buffer position delimiting the modifications.
4768 Every element starting between these are removed. PARENT is an
4769 element to be removed. Every element contained in it will also
4770 be removed.
4772 During phase 1, NEXT is the key of the next known element in
4773 cache. Parse buffer between that element and the one before it
4774 in order to determine the parent of the next element. Set PARENT
4775 to the element containing NEXT.
4777 During phase 2, NEXT is the key of the next element to shift in
4778 the parse tree. All elements starting from this one have their
4779 properties relatives to buffer positions shifted by integer
4780 OFFSET and, if they belong to element PARENT, are adopted by it.
4788 "Hash table used to store keys during synchronization.
4792 "Return a unique key for ELEMENT in cache tree.
4794 Keys are used to keep a total order among elements in the cache.
4795 Comparison is done with `org-element--cache-key-less-p'.
4797 When no synchronization is taking place, a key is simply the
4798 beginning position of the element, or that position plus one in
4799 the case of an first item (respectively row) in
4800 a list (respectively a table).
4802 During a synchronization, the key is the one the element had when
4803 the cache was synchronized for the last time. Elements added to
4804 cache during the synchronization get a new key generated with
4805 `org-element--cache-generate-key'.
4807 Such keys are stored in `org-element--cache-sync-keys'. The hash
4808 table is cleared once the synchronization is complete."
4811 ;; Increase beginning position of items (respectively
4812 ;; table rows) by one, so the first item can get
4813 ;; a different key from its parent list (respectively
4814 ;; table).
4817 begin)))
4820 key))))
4823 "Default value for a new key level.
4827 "Generate a key between LOWER and UPPER.
4829 LOWER and UPPER are integers or lists, possibly empty.
4831 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4832 a unique key, as an integer or a list of integers, according to
4833 the following rules:
4835 - LOWER and UPPER are compared level-wise until values differ.
4837 - If, at a given level, LOWER and UPPER differ from more than
4838 2, the new key shares all the levels above with LOWER and
4839 gets a new level. Its value is the mean between LOWER and
4840 UPPER.
4842 \(1 2) + (1 4) --> (1 3)
4844 - If LOWER has no value to compare with, it is assumed that its
4845 value is 0:
4847 \(1 1) + (1 1 2) --> (1 1 1)
4849 Likewise, if UPPER is short of levels, the current value is
4850 `most-positive-fixnum'.
4852 - If they differ from only one, the new key inherits from
4853 current LOWER lever and has a new level at the value
4854 `org-element--cache-default-key'.
4856 \(1 2) + (1 3) --> (1 2 org-element--cache-default-key)
4858 - If the key is only one level long, it is returned as an
4859 integer.
4861 \(1 2) + (3 2) --> 2"
4865 key)
4883 org-element--cache-default-key))
4884 org-element--cache-default-key)
4885 key)
4891 key)
4898 ;; (n) is equivalent to (n 0 0 0 0 ...) so we want to avoid
4899 ;; ending on a sequence of 0.
4904 key)))
4912 org-element--cache-default-key))
4913 org-element--cache-default-key)
4914 key))))
4915 ;; Ensure we don't return a list with a single element.
4919 "Non-nil if key A is less than key B.
4920 A and B are either integers or lists of integers, as returned by
4921 `org-element--cache-key'."
4929 ;; If A is empty, either keys are equal (B is also empty) or
4930 ;; B is less than A (B is longer). Therefore return nil.
4931 ;;
4932 ;; If A is not empty, B is necessarily empty and A is less
4933 ;; than B (A is longer). Therefore, return a non-nil value.
4934 a))))
4937 "Non-nil when element A is located before element B."
4942 "Return root value in cache.
4943 This function assumes `org-element--cache' is a valid AVL tree."
4947 ;;;; Tools
4950 "Non-nil when cache is active in current buffer."
4955 "Find element in cache starting at POS or before.
4957 POS refers to a buffer position.
4959 When optional argument SIDE is non-nil, the function checks for
4960 elements starting at or past POS instead. If SIDE is `both', the
4961 function returns a cons cell where car is the first element
4962 starting at or before POS and cdr the first element starting
4963 after POS.
4965 The function can only find elements in the synchronized part of
4966 the cache."
4970 lower upper)
4985 ;; We found an element in cache starting at POS. If `side'
4986 ;; is `both' we also want the next one in order to generate
4987 ;; a key in-between.
4988 ;;
4989 ;; If the element is the first row or item in a table or
4990 ;; a plain list, we always return the table or the plain
4991 ;; list.
4992 ;;
4993 ;; In any other case, we return the element found.
5002 lower parent
5003 upper parent)))))
5006 lower element
5007 upper element)))))
5014 "Store ELEMENT in current buffer's cache, if allowed.
5015 When optional argument DATA is non-nil, assume is it object data
5016 relative to ELEMENT and store it in the objects cache."
5020 ;; During synchronization, first build an appropriate key
5021 ;; for the new element so `avl-tree-enter' can insert it at
5022 ;; the right spot in the cache.
5031 org-element--cache-sync-keys)))
5033 ;; Headlines are not stored in cache, so objects in titles are
5034 ;; not stored either.
5039 ;;;; Synchronization
5042 "Set idle timer for cache synchronization in BUFFER."
5049 org-element-cache-sync-idle-time))
5050 nil
5051 #'org-element--cache-sync
5052 buffer)))
5055 "Non-nil when synchronization process should be interrupted.
5056 TIME-LIMIT is a time value or nil."
5062 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5064 Properties containing buffer positions are `:begin', `:end',
5065 `:contents-begin', `:contents-end' and `:structure'. When
5066 optional argument PROPS is a list of keywords, only shift
5067 properties provided in that list.
5069 Properties are modified by side-effect."
5071 ;; Shift `:structure' property for the first plain list only: it
5072 ;; is the only one that really matters and it prevents from
5073 ;; shifting it more than once.
5087 "Synchronize cache with recent modification in BUFFER.
5088 When optional argument THRESHOLD is non-nil, do the
5089 synchronization for all elements starting before or at threshold,
5090 then exit. Otherwise, synchronize cache for as long as
5091 `org-element-cache-sync-duration' or until Emacs leaves idle
5092 state."
5103 request
5105 threshold
5108 org-element-cache-sync-duration)))
5110 ;; Request processed. Merge current and next offsets and
5111 ;; transfer phase number and ending position.
5118 ;; If more requests are awaiting, set idle timer accordingly.
5119 ;; Otherwise, reset keys.
5125 "Process synchronization REQUEST for all entries before NEXT.
5127 REQUEST is a vector, built by `org-element--cache-submit-request'.
5129 NEXT is a cache key, as returned by `org-element--cache-key'.
5131 When non-nil, THRESHOLD is a buffer position. Synchronization
5132 stops as soon as a shifted element begins after it.
5134 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5135 after this time or when Emacs exits idle state.
5137 Return nil if the process stops before completing the request,
5138 t otherwise."
5141 ;; Phase 1.
5142 ;;
5143 ;; Delete all elements starting after BEG, but not after buffer
5144 ;; position END or past element with key NEXT.
5145 ;;
5146 ;; As an exception, also delete elements starting after
5147 ;; modifications but included in an element altered by
5148 ;; modifications (orphans).
5149 ;;
5150 ;; At each iteration, we start again at tree root since
5151 ;; a deletion modifies structure of the balanced tree.
5160 ;; Find first element in cache with key BEG or after it.
5161 ;; We don't use `org-element--cache-find' because it
5162 ;; couldn't reach orphaned elements past NEXT. Moreover,
5163 ;; BEG is a key, not a buffer position.
5173 data-key key
5176 data-key key
5177 node nil)))))
5181 ;; Remove orphaned elements.
5187 up))
5191 next)))
5201 ;; Phase 2.
5202 ;;
5203 ;; Phase 1 left a hole in the parse tree. Some elements after
5204 ;; it could have parents within. For example, in the following
5205 ;; buffer:
5206 ;;
5207 ;;
5208 ;; - item
5209 ;;
5210 ;;
5211 ;; Paragraph1
5212 ;;
5213 ;; Paragraph2
5214 ;;
5215 ;;
5216 ;; if we remove a blank line between "item" and "Paragraph1",
5217 ;; everything down to "Paragraph2" is removed from cache. But
5218 ;; the paragraph now belongs to the list, and its `:parent'
5219 ;; property no longer is accurate.
5220 ;;
5221 ;; Therefore we need to parse again elements in the hole, or at
5222 ;; least in its last section, so that we can re-parent
5223 ;; subsequent elements, during phase 3.
5224 ;;
5225 ;; Note that we only need to get the parent from the first
5226 ;; element in cache after the hole.
5227 ;;
5228 ;; Also, this part can be delayed if we don't need to retrieve
5229 ;; an element after the hole.
5231 ;; Next element will start at its beginning position plus
5232 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5233 ;; contains the real beginning position of the first element
5234 ;; to shift and re-parent.
5243 ;; Phase 3.
5244 ;;
5245 ;; Shift all elements starting from key START, but before NEXT, by
5246 ;; OFFSET, and re-parent them when appropriate.
5247 ;;
5248 ;; Elements are modified by side-effect so the tree structure
5249 ;; remains intact.
5250 ;;
5251 ;; Once THRESHOLD, if any, is reached, or once there is an input
5252 ;; pending, exit. Before leaving, the current synchronization
5253 ;; request is updated.
5260 exit-flag)
5261 ;; No re-parenting nor shifting planned: request is over.
5271 ;; We reached NEXT. Request is complete.
5273 ;; Handle interruption request. Update current request.
5278 ;; Shift element.
5281 ;; Shift associated objects data, if any.
5289 ;; Re-parent it.
5295 ;; Cache is up-to-date past THRESHOLD. Request
5296 ;; interruption.
5301 ;; We reached end of tree: synchronization complete.
5302 t)))
5305 "Parse elements in current section, down to POS.
5307 Start parsing from the closest between the last known element in
5308 cache or headline above. Return the smallest element containing
5309 POS.
5311 When optional argument SYNCP is non-nil, return the parent of the
5312 element containing POS instead. In that case, it is also
5313 possible to provide TIME-LIMIT, which is a time value specifying
5314 when the parsing should stop. The function returns `interrupted'
5315 if the process stopped before finding the expected result."
5322 element next)
5324 ;; Nothing in cache before point: start parsing from first
5325 ;; element following headline above, or first element in
5326 ;; buffer.
5332 ;; Cache returned exact match: return it.
5335 ;; There's a headline between cached value and POS: cached
5336 ;; value is invalid. Start parsing from first element
5337 ;; following the headline.
5343 ;; Check if CACHED or any of its ancestors contain point.
5344 ;;
5345 ;; If there is such an element, we inspect it in order to know
5346 ;; if we return it or if we need to parse its contents.
5347 ;; Otherwise, we just start parsing from current location,
5348 ;; which is right after the top-most element containing
5349 ;; CACHED.
5350 ;;
5351 ;; As a special case, if POS is at the end of the buffer, we
5352 ;; want to return the innermost element ending there.
5353 ;;
5354 ;; Also, if we find an ancestor and discover that we need to
5355 ;; parse its contents, make sure we don't start from
5356 ;; `:contents-begin', as we would otherwise go past CACHED
5357 ;; again. Instead, in that situation, we will resume parsing
5358 ;; from NEXT, which is located after CACHED or its higher
5359 ;; ancestor not containing point.
5371 ;; Parse successively each element until we reach POS.
5377 special-flag)
5385 end 'element special-flag
5392 ;; Skip any element ending before point. Also skip
5393 ;; element ending at point (unless it is also the end of
5394 ;; buffer) since we're sure that another element begins
5395 ;; after it.
5398 ;; A non-greater element contains point: return it.
5401 ;; Otherwise, we have to decide if ELEMENT really
5402 ;; contains POS. In that case we start parsing from
5403 ;; contents' beginning.
5404 ;;
5405 ;; If POS is at contents' beginning but it is also at
5406 ;; the beginning of the first item in a list or a table.
5407 ;; In that case, we need to create an anchor for that
5408 ;; list or table, so return it.
5409 ;;
5410 ;; Also, if POS is at the end of the buffer, no element
5411 ;; can start after it, but more than one may end there.
5412 ;; Arbitrarily, we choose to return the innermost of
5413 ;; such elements.
5429 parent element
5430 end cend))))
5431 ;; Otherwise, return ELEMENT as it is the smallest
5432 ;; element containing POS.
5437 ;;;; Staging Buffer Changes
5445 "Regexp matching an element opening line.
5446 When such a line is modified, modifications may propagate after
5447 modified area. In that situation, every element between that
5456 "Regexp matching an element closing line.
5457 When such a line is modified, modifications may propagate before
5458 modified area. In that situation, every element between that
5462 "Non-nil when a sensitive line is about to be changed.
5466 "Request extension of area going to be modified if needed.
5467 BEG and END are the beginning and end of the range of changed
5468 text. See `before-change-functions' for more information."
5470 ;; Make sure buffer positions in cache are correct until END.
5479 ;; A sensitive line is a headline or a block (or drawer,
5480 ;; or latex-environment) boundary. Inserting one can
5481 ;; modify buffer drastically both above and below that
5482 ;; line, possibly making cache invalid. Therefore, we
5483 ;; need to pay attention to changes happening to them.
5487 org-element--cache-opening-line)))
5499 "Update buffer modifications for current buffer.
5500 BEG and END are the beginning and end of the range of changed
5501 text, and the length in bytes of the pre-change text replaced by
5502 that range. See `after-change-functions' for more information."
5512 ;; Determine if modified area needs to be extended,
5513 ;; according to both previous and current state. We make
5514 ;; a special case for headline editing: if a headline is
5515 ;; modified but not removed, do not extend.
5520 org-element--cache-opening-line))
5532 ;; Effectively extend modified area.
5539 ;; Store synchronization request.
5542 ;; Activate a timer to process the request during idle time.
5546 "Submit a new cache synchronization request for current buffer.
5547 BEG and END are buffer positions delimiting the minimal area
5548 where cache data should be removed. OFFSET is the size of the
5549 change, as an integer."
5551 ;; Find the position of the first element in cache to remove.
5552 ;;
5553 ;; Partially modified elements will be removed during request
5554 ;; processing. As an exception, greater elements around the
5555 ;; changes that are robust to contents modifications are
5556 ;; preserved.
5557 ;;
5558 ;; We look just before BEG because an element ending at BEG
5559 ;; needs to be removed too.
5568 drawer dynamic-block inlinetask
5569 property-drawer quote-block special-block))
5572 ;; UP is a greater element that is wrapped around
5573 ;; the changes. We only need to extend its
5574 ;; ending boundaries and those of all its
5575 ;; parents.
5581 ;; We're at top level element containing ELEMENT: if
5582 ;; it's altered by buffer modifications, it is first
5583 ;; element in cache to be removed. Otherwise, that
5584 ;; first element is the following one.
5587 ;; Changes happened before the first known element. Shift the
5588 ;; rest of the cache.
5591 org-element--cache-sync-requests))
5592 ;; There is at least an element to remove. Find position past
5593 ;; every element containing END.
5604 org-element--cache-sync-requests))
5605 ;; No element to remove. No need to re-parent either. Simply
5606 ;; shift additional elements, if any, by OFFSET.
5611 ;;;; Public Functions
5613 ;;;###autoload
5615 "Reset cache in current buffer.
5616 When optional argument ALL is non-nil, reset cache in all Org
5617 buffers. This function will do nothing if
5618 `org-element-use-cache' is nil."
5638 \f
5639 ;;; The Toolbox
5640 ;;
5641 ;; The first move is to implement a way to obtain the smallest element
5642 ;; containing point. This is the job of `org-element-at-point'. It
5643 ;; basically jumps back to the beginning of section containing point
5644 ;; and proceed, one element after the other, with
5645 ;; `org-element--current-element' until the container is found. Note:
5646 ;; When using `org-element-at-point', secondary values are never
5647 ;; parsed since the function focuses on elements, not on objects.
5648 ;;
5649 ;; At a deeper level, `org-element-context' lists all elements and
5650 ;; objects containing point.
5651 ;;
5652 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5653 ;; internally by navigation and manipulation tools.
5656 ;;;###autoload
5658 "Determine closest element around point.
5660 Return value is a list like (TYPE PROPS) where TYPE is the type
5661 of the element and PROPS a plist of properties associated to the
5662 element.
5664 Possible types are defined in `org-element-all-elements'.
5665 Properties depend on element or object type, but always include
5666 `:begin', `:end', `:parent' and `:post-blank' properties.
5668 As a special case, if point is at the very beginning of the first
5669 item in a list or sub-list, returned element will be that list
5670 instead of the item. Likewise, if point is at the beginning of
5671 the first row of a table, returned element will be the table
5672 instead of the first row.
5674 When point is at the end of the buffer, return the innermost
5675 element ending there."
5681 ;; Within blank lines at the beginning of buffer, return nil.
5683 ;; Within blank lines right after a headline, return that
5684 ;; headline.
5688 ;; Otherwise parse until we find element containing ORIGIN.
5695 ;;;###autoload
5697 "Return closest element or object around point.
5699 Return value is a list like (TYPE PROPS) where TYPE is the type
5700 of the element or object and PROPS a plist of properties
5701 associated to it.
5703 Possible types are defined in `org-element-all-elements' and
5704 `org-element-all-objects'. Properties depend on element or
5705 object type, but always include `:begin', `:end', `:parent' and
5706 `:post-blank'.
5708 Optional argument ELEMENT, when non-nil, is the closest element
5709 containing point, as returned by `org-element-at-point'.
5710 Providing it allows for quicker computation."
5716 ;; If point is inside an element containing objects or
5717 ;; a secondary string, narrow buffer to the container and
5718 ;; proceed with parsing. Otherwise, return ELEMENT.
5720 ;; At a parsed affiliated keyword, check if we're inside main
5721 ;; or dual value.
5728 org-element-parsed-keywords))
5737 ;; Also change type to retrieve correct restrictions.
5739 ;; At an item, objects can only be located within tag, if any.
5749 ;; At an headline or inlinetask, objects are in title.
5756 ;; At a paragraph, a table-row or a verse block, objects are
5757 ;; located within their contents.
5761 ;; CBEG is nil for table rules.
5766 ;; At a parsed keyword, objects are located within value.
5769 org-element-document-properties))
5776 ;; At a planning line, if point is at a timestamp, return it,
5777 ;; otherwise, return element.
5785 ;; All other locations cannot contain objects: bail out.
5796 objects-data next)
5800 ;; Get list of next object candidates in CANDIDATES.
5801 ;; When entering for the first time PARENT, grab it
5802 ;; from cache, if available, or compute it. Then,
5803 ;; for each subsequent iteration in PARENT, always
5804 ;; compute it since we're beyond cache anyway.
5807 ;; Increase key of objects contained in
5808 ;; table cells by one so they cannot get
5809 ;; the same key as the cell itself.
5816 cache))))
5820 restriction candidates))
5822 ;; Compare ORIGIN with next object starting position,
5823 ;; if any.
5824 ;;
5825 ;; If ORIGIN is lesser or if there is no object
5826 ;; following, look for a previous object that might
5827 ;; contain it in cache. If there is no cache, we
5828 ;; didn't miss any object so simply return PARENT.
5829 ;;
5830 ;; If ORIGIN is greater or equal, parse next
5831 ;; candidate for further processing.
5835 candidates))))
5852 ;; Process NEXT to know if we need to skip it, return
5853 ;; it or move into it.
5858 ;; ORIGIN is after NEXT, so skip it.
5860 ;; ORIGIN is within a non-recursive next or
5861 ;; at an object boundaries: Return that object.
5865 ;; Otherwise, move into NEXT and reset flags as we
5866 ;; shift parent.
5872 next nil
5873 objects-data nil
5875 ;; Store results in cache, if applicable.
5879 "Non-nil when elements ELEM-A and ELEM-B are nested."
5888 "Swap elements ELEM-A and ELEM-B.
5889 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5890 end of ELEM-A."
5892 ;; There are two special cases when an element doesn't start at bol:
5893 ;; the first paragraph in an item or in a footnote definition.
5895 ;; Only a paragraph without any affiliated keyword can be moved at
5896 ;; ELEM-A position in such a situation. Note that the case of
5897 ;; a footnote definition is impossible: it cannot contain two
5898 ;; paragraphs in a row because it cannot contain a blank line.
5904 ;; In a special situation, ELEM-A will have no indentation. We'll
5905 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5919 ;; Store overlays responsible for visibility status. We
5920 ;; also need to store their boundaries as they will be
5921 ;; removed from buffer.
5928 ;; Get contents.
5936 ;; Restore ex ELEM-A overlays.
5945 ;; Restore ex ELEM-B overlays.
5953 "Remove maximum common indentation in string S and return it.
5954 When optional argument N is a positive integer, remove exactly
5955 that much characters from indentation, if possible, or return
5956 S as-is otherwise. Unlike to `org-remove-indentation', this
5957 function doesn't call `untabify' on S."
5962 ;; Find maximum common indentation, if not specified.
5970 min-ind)))
5972 ;; Remove exactly N indentation, but give up if not possible.
5985 ;; Local variables:
5986 ;; generated-autoload-file: "org-loaddefs.el"
5987 ;; End:
5989 ;;; org-element.el ends here