| blob | ba80c2a8b8191d2f64dab7c011c5516492279c4b |
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 (i.e. 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 (i.e. `: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 (i.e. `: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.
1291 limit t)))
1297 "Parse a plain list.
1299 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1300 the buffer position at the beginning of the first affiliated
1301 keyword and CDR is a plist of affiliated keywords along with
1302 their value. STRUCTURE is the structure of the plain list being
1303 parsed.
1305 Return a list whose CAR is `plain-list' and CDR is a plist
1306 containing `:type', `:begin', `:end', `:contents-begin' and
1307 `:contents-end', `:structure', `:post-blank' and
1308 `:post-affiliated' keywords.
1310 Assume point is at the beginning of the list."
1324 pos))
1328 ;; Return value.
1332 :begin begin
1333 :end end
1334 :contents-begin contents-begin
1335 :contents-end contents-end
1336 :structure struct
1342 "Interpret PLAIN-LIST element as Org syntax.
1343 CONTENTS is the contents of the element."
1351 ;;;; Property Drawer
1354 "Parse a property drawer.
1356 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1357 the buffer position at the beginning of the first affiliated
1358 keyword and CDR is a plist of affiliated keywords along with
1359 their value.
1361 Return a list whose CAR is `property-drawer' and CDR is a plist
1362 containing `:begin', `:end', `:contents-begin', `:contents-end',
1363 `:post-blank' and `:post-affiliated' keywords.
1365 Assume point is at the beginning of the property drawer."
1370 ;; Incomplete drawer: parse it as a paragraph.
1388 :end end
1389 :contents-begin contents-begin
1390 :contents-end contents-end
1396 "Interpret PROPERTY-DRAWER element as Org syntax.
1397 CONTENTS is the properties within the drawer."
1401 ;;;; Quote Block
1404 "Parse a quote block.
1406 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1407 the buffer position at the beginning of the first affiliated
1408 keyword and CDR is a plist of affiliated keywords along with
1409 their value.
1411 Return a list whose CAR is `quote-block' and CDR is a plist
1412 containing `:begin', `:end', `:contents-begin', `:contents-end',
1413 `:post-blank' and `:post-affiliated' keywords.
1415 Assume point is at the beginning of the block."
1419 ;; Incomplete block: parse it as a paragraph.
1425 ;; Empty blocks have no contents.
1438 :end end
1439 :contents-begin contents-begin
1440 :contents-end contents-end
1446 "Interpret QUOTE-BLOCK element as Org syntax.
1447 CONTENTS is the contents of the element."
1451 ;;;; Section
1454 "Parse a section.
1456 LIMIT bounds the search.
1458 Return a list whose CAR is `section' and CDR is a plist
1459 containing `:begin', `:end', `:contents-begin', `contents-end'
1460 and `:post-blank' keywords."
1462 ;; Beginning of section is the beginning of the first non-blank
1463 ;; line after previous headline.
1472 :end end
1473 :contents-begin begin
1474 :contents-end pos-before-blank
1478 "Interpret SECTION element as Org syntax.
1479 CONTENTS is the contents of the element."
1480 contents)
1483 ;;;; Special Block
1486 "Parse a special block.
1488 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1489 the buffer position at the beginning of the first affiliated
1490 keyword and CDR is a plist of affiliated keywords along with
1491 their value.
1493 Return a list whose CAR is `special-block' and CDR is a plist
1494 containing `:type', `:begin', `:end', `:contents-begin',
1495 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1497 Assume point is at the beginning of the block."
1504 limit t)))
1505 ;; Incomplete block: parse it as a paragraph.
1511 ;; Empty blocks have no contents.
1524 :begin begin
1525 :end end
1526 :contents-begin contents-begin
1527 :contents-end contents-end
1533 "Interpret SPECIAL-BLOCK element as Org syntax.
1534 CONTENTS is the contents of the element."
1539 \f
1540 ;;; Elements
1541 ;;
1542 ;; For each element, a parser and an interpreter are also defined.
1543 ;; Both follow the same naming convention used for greater elements.
1544 ;;
1545 ;; Also, as for greater elements, adding a new element type is done
1546 ;; through the following steps: implement a parser and an interpreter,
1547 ;; tweak `org-element--current-element' so that it recognizes the new
1548 ;; type and add that new type to `org-element-all-elements'.
1549 ;;
1550 ;; As a special case, when the newly defined type is a block type,
1551 ;; `org-element-block-name-alist' has to be modified accordingly.
1554 ;;;; Babel Call
1557 "Parse a babel call.
1559 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1560 the buffer position at the beginning of the first affiliated
1561 keyword and CDR is a plist of affiliated keywords along with
1562 their value.
1564 Return a list whose CAR is `babel-call' and CDR is a plist
1565 containing `:begin', `:end', `:value', `:post-blank' and
1566 `:post-affiliated' as keywords."
1580 :end end
1581 :value value
1587 "Interpret BABEL-CALL element as Org syntax.
1588 CONTENTS is nil."
1592 ;;;; Clock
1595 "Parse a clock.
1597 LIMIT bounds the search.
1599 Return a list whose CAR is `clock' and CDR is a plist containing
1600 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1601 as keywords."
1621 :value value
1622 :duration duration
1623 :begin begin
1624 :end end
1628 "Interpret CLOCK element as Org syntax.
1629 CONTENTS is nil."
1637 "%2s:%02s"
1641 ;;;; Comment
1644 "Parse a comment.
1646 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1647 the buffer position at the beginning of the first affiliated
1648 keyword and CDR is a plist of affiliated keywords along with
1649 their value.
1651 Return a list whose CAR is `comment' and CDR is a plist
1652 containing `:begin', `:end', `:value', `:post-blank',
1653 `:post-affiliated' keywords.
1655 Assume point is at comment beginning."
1664 ;; Get comments ending.
1667 ;; Accumulate lines without leading hash and first
1668 ;; whitespace.
1682 :end end
1683 :value value
1689 "Interpret COMMENT element as Org syntax.
1690 CONTENTS is nil."
1694 ;;;; Comment Block
1697 "Parse an export block.
1699 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1700 the buffer position at the beginning of the first affiliated
1701 keyword and CDR is a plist of affiliated keywords along with
1702 their value.
1704 Return a list whose CAR is `comment-block' and CDR is a plist
1705 containing `:begin', `:end', `:value', `:post-blank' and
1706 `:post-affiliated' keywords.
1708 Assume point is at comment block beginning."
1712 ;; Incomplete block: parse it as a paragraph.
1725 contents-begin contents-end)))
1729 :end end
1730 :value value
1736 "Interpret COMMENT-BLOCK element as Org syntax.
1737 CONTENTS is nil."
1742 ;;;; Diary Sexp
1745 "Parse a diary sexp.
1747 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1748 the buffer position at the beginning of the first affiliated
1749 keyword and CDR is a plist of affiliated keywords along with
1750 their value.
1752 Return a list whose CAR is `diary-sexp' and CDR is a plist
1753 containing `:begin', `:end', `:value', `:post-blank' and
1754 `:post-affiliated' keywords."
1766 :begin begin
1767 :end end
1773 "Interpret DIARY-SEXP as Org syntax.
1774 CONTENTS is nil."
1778 ;;;; Example Block
1781 "Parse an example block.
1783 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1784 the buffer position at the beginning of the first affiliated
1785 keyword and CDR is a plist of affiliated keywords along with
1786 their value.
1788 Return a list whose CAR is `example-block' and CDR is a plist
1789 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1790 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1791 `:value', `:post-blank' and `:post-affiliated' keywords."
1795 ;; Incomplete block: parse it as a paragraph.
1803 ;; Switches analysis
1810 ;; Should labels be retained in (or stripped from) example
1811 ;; blocks?
1816 ;; What should code-references use - labels or
1817 ;; line-numbers?
1826 ;; Standard block parsing.
1834 contents-begin contents-end))
1835 block-ind))
1844 :end end
1845 :value value
1846 :switches switches
1847 :number-lines number-lines
1848 :preserve-indent preserve-indent
1849 :retain-labels retain-labels
1850 :use-labels use-labels
1851 :label-fmt label-fmt
1857 "Interpret EXAMPLE-BLOCK element as Org syntax.
1858 CONTENTS is nil."
1865 value
1870 ;;;; Export Block
1873 "Parse an export block.
1875 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1876 the buffer position at the beginning of the first affiliated
1877 keyword and CDR is a plist of affiliated keywords along with
1878 their value.
1880 Return a list whose CAR is `export-block' and CDR is a plist
1881 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1882 `:post-affiliated' keywords.
1884 Assume point is at export-block beginning."
1891 ;; Incomplete block: parse it as a paragraph.
1904 contents-end)))
1908 :end end
1909 :type type
1910 :value value
1916 "Interpret EXPORT-BLOCK element as Org syntax.
1917 CONTENTS is nil."
1924 ;;;; Fixed-width
1927 "Parse a fixed-width section.
1929 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1930 the buffer position at the beginning of the first affiliated
1931 keyword and CDR is a plist of affiliated keywords along with
1932 their value.
1934 Return a list whose CAR is `fixed-width' and CDR is a plist
1935 containing `:begin', `:end', `:value', `:post-blank' and
1936 `:post-affiliated' keywords.
1938 Assume point is at the beginning of the fixed-width area."
1942 value
1947 ;; Accumulate text without starting colons.
1960 :end end
1961 :value value
1967 "Interpret FIXED-WIDTH element as Org syntax.
1968 CONTENTS is nil."
1976 ;;;; Horizontal Rule
1979 "Parse an horizontal rule.
1981 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1982 the buffer position at the beginning of the first affiliated
1983 keyword and CDR is a plist of affiliated keywords along with
1984 their value.
1986 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1987 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1988 keywords."
1998 :end end
2004 "Interpret HORIZONTAL-RULE element as Org syntax.
2005 CONTENTS is nil."
2009 ;;;; Keyword
2012 "Parse a keyword at point.
2014 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2015 the buffer position at the beginning of the first affiliated
2016 keyword and CDR is a plist of affiliated keywords along with
2017 their value.
2019 Return a list whose CAR is `keyword' and CDR is a plist
2020 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2021 `:post-affiliated' keywords."
2023 ;; An orphaned affiliated keyword is considered as a regular
2024 ;; keyword. In this case AFFILIATED is nil, so we take care of
2025 ;; this corner case.
2038 :value value
2039 :begin begin
2040 :end end
2046 "Interpret KEYWORD element as Org syntax.
2047 CONTENTS is nil."
2053 ;;;; Latex Environment
2056 "Parse a LaTeX environment.
2058 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2059 the buffer position at the beginning of the first affiliated
2060 keyword and CDR is a plist of affiliated keywords along with
2061 their value.
2063 Return a list whose CAR is `latex-environment' and CDR is a plist
2064 containing `:begin', `:end', `:value', `:post-blank' and
2065 `:post-affiliated' keywords.
2067 Assume point is at the beginning of the latex environment."
2074 limit t))
2075 ;; Incomplete latex environment: parse it as a paragraph.
2085 :end end
2086 :value value
2092 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2093 CONTENTS is nil."
2097 ;;;; Node Property
2100 "Parse a node-property at point.
2102 LIMIT bounds the search.
2104 Return a list whose CAR is `node-property' and CDR is a plist
2105 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2106 keywords."
2118 :value value
2119 :begin begin
2120 :end end
2124 "Interpret NODE-PROPERTY element as Org syntax.
2125 CONTENTS is nil."
2131 ;;;; Paragraph
2134 "Parse a paragraph.
2136 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2137 the buffer position at the beginning of the first affiliated
2138 keyword and CDR is a plist of affiliated keywords along with
2139 their value.
2141 Return a list whose CAR is `paragraph' and CDR is a plist
2142 containing `:begin', `:end', `:contents-begin' and
2143 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2145 Assume point is at the beginning of the paragraph."
2154 limit
2155 ;; A matching `org-element-paragraph-separate' is not
2156 ;; necessarily the end of the paragraph. In
2157 ;; particular, lines starting with # or : as a first
2158 ;; non-space character are ambiguous. We have check
2159 ;; if they are valid Org syntax (i.e. not an
2160 ;; incomplete keyword).
2164 ;; There's no ambiguity for other symbols or
2165 ;; empty lines: stop here.
2167 ;; Stop at valid fixed-width areas.
2169 ;; Stop at drawers.
2174 ;; Stop at valid comments.
2176 ;; Stop at valid dynamic blocks.
2181 ;; Stop at valid blocks.
2188 limit t)))
2189 ;; Stop at valid latex environments.
2197 limit t)))
2198 ;; Stop at valid keywords.
2200 ;; Skip everything else.
2217 :end end
2218 :contents-begin contents-begin
2219 :contents-end contents-end
2225 "Interpret PARAGRAPH element as Org syntax.
2226 CONTENTS is the contents of the element."
2227 contents)
2230 ;;;; Planning
2233 "Parse a planning.
2235 LIMIT bounds the search.
2237 Return a list whose CAR is `planning' and CDR is a plist
2238 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2239 and `:post-blank' keywords."
2249 closed deadline scheduled)
2261 :deadline deadline
2262 :scheduled scheduled
2263 :begin begin
2264 :end end
2268 "Interpret PLANNING element as Org syntax.
2269 CONTENTS is nil."
2271 'identity
2288 ;;;; Src Block
2291 "Parse a src block.
2293 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2294 the buffer position at the beginning of the first affiliated
2295 keyword and CDR is a plist of affiliated keywords along with
2296 their value.
2298 Return a list whose CAR is `src-block' and CDR is a plist
2299 containing `:language', `:switches', `:parameters', `:begin',
2300 `:end', `:number-lines', `:retain-labels', `:use-labels',
2301 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2302 `:post-affiliated' keywords.
2304 Assume point is at the beginning of the block."
2307 limit t)))
2308 ;; Incomplete block: parse it as a paragraph.
2314 ;; Get language as a string.
2323 ;; Get switches.
2325 ;; Get parameters.
2327 ;; Switches analysis
2338 ;; Should labels be retained in (or stripped from)
2339 ;; src blocks?
2344 ;; What should code-references use - labels or
2345 ;; line-numbers?
2350 ;; Indentation.
2352 ;; Retrieve code.
2357 block-ind))
2361 ;; Get position after ending blank lines.
2371 :begin begin
2372 :end end
2373 :number-lines number-lines
2374 :preserve-indent preserve-indent
2375 :retain-labels retain-labels
2376 :use-labels use-labels
2377 :label-fmt label-fmt
2378 :value value
2384 "Interpret SRC-BLOCK element as Org syntax.
2385 CONTENTS is nil."
2394 val)
2408 ;;;; Table
2411 "Parse a table at point.
2413 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2414 the buffer position at the beginning of the first affiliated
2415 keyword and CDR is a plist of affiliated keywords along with
2416 their value.
2418 Return a list whose CAR is `table' and CDR is a plist containing
2419 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2420 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2421 keywords.
2423 Assume point is at the beginning of the table."
2437 acc))
2444 :end end
2445 :type type
2446 :tblfm tblfm
2447 ;; Only `org' tables have contents. `table.el' tables
2448 ;; use a `:value' property to store raw table as
2449 ;; a string.
2454 table-begin table-end))
2460 "Interpret TABLE element as Org syntax.
2461 CONTENTS is nil."
2472 ;;;; Table Row
2475 "Parse table row at point.
2477 LIMIT bounds the search.
2479 Return a list whose CAR is `table-row' and CDR is a plist
2480 containing `:begin', `:end', `:contents-begin', `:contents-end',
2481 `:type' and `:post-blank' keywords."
2485 ;; A table rule has no contents. In that case, ensure
2486 ;; CONTENTS-BEGIN matches CONTENTS-END.
2498 :begin begin
2499 :end end
2500 :contents-begin contents-begin
2501 :contents-end contents-end
2505 "Interpret TABLE-ROW element as Org syntax.
2506 CONTENTS is the contents of the table row."
2511 ;;;; Verse Block
2514 "Parse a verse block.
2516 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2517 the buffer position at the beginning of the first affiliated
2518 keyword and CDR is a plist of affiliated keywords along with
2519 their value.
2521 Return a list whose CAR is `verse-block' and CDR is a plist
2522 containing `:begin', `:end', `:contents-begin', `:contents-end',
2523 `:post-blank' and `:post-affiliated' keywords.
2525 Assume point is at beginning of the block."
2529 ;; Incomplete block: parse it as a paragraph.
2544 :end end
2545 :contents-begin contents-begin
2546 :contents-end contents-end
2552 "Interpret VERSE-BLOCK element as Org syntax.
2553 CONTENTS is verse block contents."
2557 \f
2558 ;;; Objects
2559 ;;
2560 ;; Unlike to elements, interstices can be found between objects.
2561 ;; That's why, along with the parser, successor functions are provided
2562 ;; for each object. Some objects share the same successor (i.e. `code'
2563 ;; and `verbatim' objects).
2564 ;;
2565 ;; A successor must accept a single argument bounding the search. It
2566 ;; will return either a cons cell whose CAR is the object's type, as
2567 ;; a symbol, and CDR the position of its next occurrence, or nil.
2568 ;;
2569 ;; Successors follow the naming convention:
2570 ;; org-element-NAME-successor, where NAME is the name of the
2571 ;; successor, as defined in `org-element-all-successors'.
2572 ;;
2573 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2574 ;; object types they can contain will be specified in
2575 ;; `org-element-object-restrictions'.
2576 ;;
2577 ;; Adding a new type of object is simple. Implement a successor,
2578 ;; a parser, and an interpreter for it, all following the naming
2579 ;; convention. Register type in `org-element-all-objects' and
2580 ;; successor in `org-element-all-successors'. Maybe tweak
2581 ;; restrictions about it, and that's it.
2584 ;;;; Bold
2587 "Parse bold object at point.
2589 Return a list whose CAR is `bold' and CDR is a plist with
2590 `:begin', `:end', `:contents-begin' and `:contents-end' and
2591 `:post-blank' keywords.
2593 Assume point is at the first star marker."
2605 :end end
2606 :contents-begin contents-begin
2607 :contents-end contents-end
2611 "Interpret BOLD object as Org syntax.
2612 CONTENTS is the contents of the object."
2616 "Search for the next text-markup object.
2618 Return value is a cons cell whose CAR is a symbol among `bold',
2619 `italic', `underline', `strike-through', `code' and `verbatim'
2620 and CDR is beginning position."
2636 ;;;; Code
2639 "Parse code object at point.
2641 Return a list whose CAR is `code' and CDR is a plist with
2642 `:value', `:begin', `:end' and `:post-blank' keywords.
2644 Assume point is at the first tilde marker."
2655 :begin begin
2656 :end end
2660 "Interpret CODE object as Org syntax.
2661 CONTENTS is nil."
2665 ;;;; Entity
2668 "Parse entity at point.
2670 Return a list whose CAR is `entity' and CDR a plist with
2671 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2672 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2673 keywords.
2675 Assume point is at the beginning of the entity."
2677 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2693 :begin begin
2694 :end end
2695 :use-brackets-p bracketsp
2699 "Interpret ENTITY object as Org syntax.
2700 CONTENTS is nil."
2706 "Search for the next latex-fragment or entity object.
2708 Return value is a cons cell whose CAR is `entity' or
2709 `latex-fragment' and CDR is beginning position."
2713 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2720 ;; Determine if it's a real entity or a LaTeX command.
2723 ;; No entity nor command: point is at a LaTeX fragment.
2724 ;; Determine its type to get the correct beginning position.
2733 ;;;; Export Snippet
2736 "Parse export snippet at point.
2738 Return a list whose CAR is `export-snippet' and CDR a plist with
2739 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2740 keywords.
2742 Assume point is at the beginning of the snippet."
2754 :value value
2755 :begin begin
2756 :end end
2760 "Interpret EXPORT-SNIPPET object as Org syntax.
2761 CONTENTS is nil."
2767 "Search for the next export-snippet object.
2769 Return value is a cons cell whose CAR is `export-snippet' and CDR
2770 its beginning position."
2779 ;;;; Footnote Reference
2782 "Parse footnote reference at point.
2784 Return a list whose CAR is `footnote-reference' and CDR a plist
2785 with `:label', `:type', `:inline-definition', `:begin', `:end'
2786 and `:post-blank' as keywords."
2808 :type type
2809 :begin begin
2810 :end end
2813 footnote-reference :inline-definition
2818 footnote-reference))))))
2821 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2822 CONTENTS is nil."
2832 "Search for the next footnote-reference object.
2834 Return value is a cons cell whose CAR is `footnote-reference' and
2835 CDR is beginning position."
2849 ;;;; Inline Babel Call
2852 "Parse inline babel call at point.
2854 Return a list whose CAR is `inline-babel-call' and CDR a plist
2855 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2857 Assume point is at the beginning of the babel call."
2869 :end end
2870 :value value
2874 "Interpret INLINE-BABEL-CALL object as Org syntax.
2875 CONTENTS is nil."
2879 "Search for the next inline-babel-call object.
2881 Return value is a cons cell whose CAR is `inline-babel-call' and
2882 CDR is beginning position."
2888 ;;;; Inline Src Block
2891 "Parse inline source block at point.
2893 Return a list whose CAR is `inline-src-block' and CDR a plist
2894 with `:begin', `:end', `:language', `:value', `:parameters' and
2895 `:post-blank' as keywords.
2897 Assume point is at the beginning of the inline src block."
2910 :value value
2911 :parameters parameters
2912 :begin begin
2913 :end end
2917 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2918 CONTENTS is nil."
2923 language
2925 body)))
2928 "Search for the next inline-babel-call element.
2930 Return value is a cons cell whose CAR is `inline-babel-call' and
2931 CDR is beginning position."
2937 ;;;; Italic
2940 "Parse italic object at point.
2942 Return a list whose CAR is `italic' and CDR is a plist with
2943 `:begin', `:end', `:contents-begin' and `:contents-end' and
2944 `:post-blank' keywords.
2946 Assume point is at the first slash marker."
2958 :end end
2959 :contents-begin contents-begin
2960 :contents-end contents-end
2964 "Interpret ITALIC object as Org syntax.
2965 CONTENTS is the contents of the object."
2969 ;;;; Latex Fragment
2972 "Parse LaTeX fragment at point.
2974 Return a list whose CAR is `latex-fragment' and CDR a plist with
2975 `:value', `:begin', `:end', and `:post-blank' as keywords.
2977 Assume point is at the beginning of the LaTeX fragment."
2990 ;; None found: it's a macro.
2999 :begin begin
3000 :end end
3004 "Interpret LATEX-FRAGMENT object as Org syntax.
3005 CONTENTS is nil."
3008 ;;;; Line Break
3011 "Parse line break at point.
3013 Return a list whose CAR is `line-break', and CDR a plist with
3014 `:begin', `:end' and `:post-blank' keywords.
3016 Assume point is at the beginning of the line break."
3023 "Interpret LINE-BREAK object as Org syntax.
3024 CONTENTS is nil."
3028 "Search for the next line-break object.
3030 Return value is a cons cell whose CAR is `line-break' and CDR is
3031 beginning position."
3035 ;; A line break can only happen on a non-empty line.
3040 ;;;; Link
3043 "Parse link at point.
3045 Return a list whose CAR is `link' and CDR a plist with `:type',
3046 `:path', `:raw-link', `:application', `:search-option', `:begin',
3047 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3048 keywords.
3050 Assume point is at the beginning of the link."
3053 end contents-begin contents-end link-end post-blank path type
3054 raw-link link search-option application)
3056 ;; Type 1: Text targeted from a radio target.
3061 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3066 ;; RAW-LINK is the original link. Expand any
3067 ;; abbreviation in it.
3071 ;; Determine TYPE of link and set PATH accordingly.
3073 ;; File type.
3077 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3080 ;; Id type: PATH is the id.
3083 ;; Code-ref type: PATH is the name of the reference.
3086 ;; Custom-id type: PATH is the name of the custom id.
3089 ;; Fuzzy type: Internal link either matches a target, an
3090 ;; headline name or nothing. PATH is the target or
3091 ;; headline's name.
3093 ;; Type 3: Plain link, i.e. http://orgmode.org
3099 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3106 ;; In any case, deduce end point after trailing white space from
3107 ;; LINK-END variable.
3110 ;; Extract search option and opening application out of
3111 ;; "file"-type links.
3113 ;; Application.
3118 ;; Extract search option from PATH.
3122 ;; Make sure TYPE always reports "file".
3126 :path path
3128 :application application
3129 :search-option search-option
3130 :begin begin
3131 :end end
3132 :contents-begin contents-begin
3133 :contents-end contents-end
3137 "Interpret LINK object as Org syntax.
3138 CONTENTS is the contents of the object, or nil."
3143 raw-link
3147 "Search for the next link object.
3149 Return value is a cons cell whose CAR is `link' and CDR is
3150 beginning position."
3159 "Search for the next plain link object.
3161 Return value is a cons cell whose CAR is `link' and CDR is
3162 beginning position."
3167 ;;;; Macro
3170 "Parse macro at point.
3172 Return a list whose CAR is `macro' and CDR a plist with `:key',
3173 `:args', `:begin', `:end', `:value' and `:post-blank' as
3174 keywords.
3176 Assume point is at the macro."
3187 ;; Do not use `org-split-string' since empty
3188 ;; strings are meaningful here.
3196 args nil t)
3200 :value value
3201 :args args
3202 :begin begin
3203 :end end
3207 "Interpret MACRO object as Org syntax.
3208 CONTENTS is nil."
3212 "Search for the next macro object.
3214 Return value is cons cell whose CAR is `macro' and CDR is
3215 beginning position."
3219 nil t)
3223 ;;;; Radio-target
3226 "Parse radio target at point.
3228 Return a list whose CAR is `radio-target' and CDR a plist with
3229 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3230 and `:post-blank' as keywords.
3232 Assume point is at the radio target."
3244 :end end
3245 :contents-begin contents-begin
3246 :contents-end contents-end
3247 :post-blank post-blank
3251 "Interpret TARGET object as Org syntax.
3252 CONTENTS is the contents of the object."
3256 "Search for the next radio-target object.
3258 Return value is a cons cell whose CAR is `radio-target' and CDR
3259 is beginning position."
3265 ;;;; Statistics Cookie
3268 "Parse statistics cookie at point.
3270 Return a list whose CAR is `statistics-cookie', and CDR a plist
3271 with `:begin', `:end', `:value' and `:post-blank' keywords.
3273 Assume point is at the beginning of the statistics-cookie."
3284 :end end
3285 :value value
3289 "Interpret STATISTICS-COOKIE object as Org syntax.
3290 CONTENTS is nil."
3294 "Search for the next statistics cookie object.
3296 Return value is a cons cell whose CAR is `statistics-cookie' and
3297 CDR is beginning position."
3303 ;;;; Strike-Through
3306 "Parse strike-through object at point.
3308 Return a list whose CAR is `strike-through' and CDR is a plist
3309 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3310 `:post-blank' keywords.
3312 Assume point is at the first plus sign marker."
3324 :end end
3325 :contents-begin contents-begin
3326 :contents-end contents-end
3330 "Interpret STRIKE-THROUGH object as Org syntax.
3331 CONTENTS is the contents of the object."
3335 ;;;; Subscript
3338 "Parse subscript at point.
3340 Return a list whose CAR is `subscript' and CDR a plist with
3341 `:begin', `:end', `:contents-begin', `:contents-end',
3342 `:use-brackets-p' and `:post-blank' as keywords.
3344 Assume point is at the underscore."
3358 :end end
3359 :use-brackets-p bracketsp
3360 :contents-begin contents-begin
3361 :contents-end contents-end
3365 "Interpret SUBSCRIPT object as Org syntax.
3366 CONTENTS is the contents of the object."
3369 contents))
3372 "Search for the next sub/superscript object.
3374 Return value is a cons cell whose CAR is either `subscript' or
3375 `superscript' and CDR is beginning position."
3383 ;;;; Superscript
3386 "Parse superscript at point.
3388 Return a list whose CAR is `superscript' and CDR a plist with
3389 `:begin', `:end', `:contents-begin', `:contents-end',
3390 `:use-brackets-p' and `:post-blank' as keywords.
3392 Assume point is at the caret."
3406 :end end
3407 :use-brackets-p bracketsp
3408 :contents-begin contents-begin
3409 :contents-end contents-end
3413 "Interpret SUPERSCRIPT object as Org syntax.
3414 CONTENTS is the contents of the object."
3417 contents))
3420 ;;;; Table Cell
3423 "Parse table cell at point.
3425 Return a list whose CAR is `table-cell' and CDR is a plist
3426 containing `:begin', `:end', `:contents-begin', `:contents-end'
3427 and `:post-blank' keywords."
3435 :end end
3436 :contents-begin contents-begin
3437 :contents-end contents-end
3441 "Interpret TABLE-CELL element as Org syntax.
3442 CONTENTS is the contents of the cell, or nil."
3446 "Search for the next table-cell object.
3448 Return value is a cons cell whose CAR is `table-cell' and CDR is
3449 beginning position."
3453 ;;;; Target
3456 "Parse target at point.
3458 Return a list whose CAR is `target' and CDR a plist with
3459 `:begin', `:end', `:value' and `:post-blank' as keywords.
3461 Assume point is at the target."
3471 :end end
3472 :value value
3476 "Interpret TARGET object as Org syntax.
3477 CONTENTS is nil."
3481 "Search for the next target object.
3483 Return value is a cons cell whose CAR is `target' and CDR is
3484 beginning position."
3490 ;;;; Timestamp
3493 "Parse time stamp at point.
3495 Return a list whose CAR is `timestamp', and CDR a plist with
3496 `:type', `:raw-value', `:year-start', `:month-start',
3497 `:day-start', `:hour-start', `:minute-start', `:year-end',
3498 `:month-end', `:day-end', `:hour-end', `:minute-end',
3499 `:repeater-type', `:repeater-value', `:repeater-unit',
3500 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3501 `:end', `:value' and `:post-blank' keywords.
3503 Assume point is at the beginning of the timestamp."
3521 date-start)
3532 raw-value)
3534 :repeater-type
3540 :repeater-unit
3549 :warning-unit
3552 year-start month-start day-start hour-start minute-start year-end
3553 month-end day-end hour-end minute-end)
3554 ;; Parse date-start.
3562 ;; Compute date-end. It can be provided directly in time-stamp,
3563 ;; or extracted from time range. Otherwise, it defaults to the
3564 ;; same values as date-start.
3574 :raw-value raw-value
3575 :year-start year-start
3576 :month-start month-start
3577 :day-start day-start
3578 :hour-start hour-start
3579 :minute-start minute-start
3580 :year-end year-end
3581 :month-end month-end
3582 :day-end day-end
3583 :hour-end hour-end
3584 :minute-end minute-end
3585 :begin begin
3586 :end end
3588 repeater-props
3589 warning-props)))))
3592 "Interpret TIMESTAMP object as Org syntax.
3593 CONTENTS is nil."
3612 ;; Build an Org timestamp string from TIME. ACTIVEP is
3613 ;; non-nil when time stamp is active. If WITH-TIME-P is
3614 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3615 ;; specify a time range in the timestamp. REPEAT-STRING is
3616 ;; the repeater string, if any.
3620 org-time-stamp-formats)
3621 time)))
3627 nil nil ts)))
3632 " "
3633 s
3635 ;; Return value.
3636 ts)))
3648 build-ts-string
3667 0
3675 "--"
3687 "Search for the next timestamp object.
3689 Return value is a cons cell whose CAR is `timestamp' and CDR is
3690 beginning position."
3698 nil t)
3702 ;;;; Underline
3705 "Parse underline object at point.
3707 Return a list whose CAR is `underline' and CDR is a plist with
3708 `:begin', `:end', `:contents-begin' and `:contents-end' and
3709 `:post-blank' keywords.
3711 Assume point is at the first underscore marker."
3723 :end end
3724 :contents-begin contents-begin
3725 :contents-end contents-end
3729 "Interpret UNDERLINE object as Org syntax.
3730 CONTENTS is the contents of the object."
3734 ;;;; Verbatim
3737 "Parse verbatim object at point.
3739 Return a list whose CAR is `verbatim' and CDR is a plist with
3740 `:value', `:begin', `:end' and `:post-blank' keywords.
3742 Assume point is at the first equal sign marker."
3753 :begin begin
3754 :end end
3758 "Interpret VERBATIM object as Org syntax.
3759 CONTENTS is nil."
3763 \f
3764 ;;; Parsing Element Starting At Point
3765 ;;
3766 ;; `org-element--current-element' is the core function of this section.
3767 ;; It returns the Lisp representation of the element starting at
3768 ;; point.
3769 ;;
3770 ;; `org-element--current-element' makes use of special modes. They
3771 ;; are activated for fixed element chaining (i.e. `plain-list' >
3772 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3773 ;; `section'). Special modes are: `first-section', `item',
3774 ;; `node-property', `section' and `table-row'.
3778 "Parse the element starting at point.
3780 Return value is a list like (TYPE PROPS) where TYPE is the type
3781 of the element and PROPS a plist of properties associated to the
3782 element.
3784 Possible types are defined in `org-element-all-elements'.
3786 LIMIT bounds the search.
3788 Optional argument GRANULARITY determines the depth of the
3789 recursion. Allowed values are `headline', `greater-element',
3790 `element', `object' or nil. When it is broader than `object' (or
3791 nil), secondary values will not be parsed, since they only
3792 contain objects.
3794 Optional argument SPECIAL, when non-nil, can be either
3795 `first-section', `item', `node-property', `section', and
3796 `table-row'.
3798 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3799 be computed.
3801 This function assumes point is always at the beginning of the
3802 element it has to parse."
3805 ;; Determine if parsing depth allows for secondary strings
3806 ;; parsing. It only applies to elements referenced in
3807 ;; `org-element-secondary-value-alist'.
3810 ;; Item.
3813 ;; Table Row.
3815 ;; Node Property.
3817 ;; Headline.
3820 ;; Sections (must be checked after headline).
3825 limit)))
3826 ;; When not at bol, point is at the beginning of an item or
3827 ;; a footnote definition: next item is always a paragraph.
3829 ;; Planning and Clock.
3834 ;; Inlinetask.
3837 ;; From there, elements can have affiliated keywords.
3840 ;; Jumping over affiliated keywords put point off-limits.
3841 ;; Parse them as regular keywords.
3845 ;; LaTeX Environment.
3849 ;; Drawer and Property Drawer.
3854 ;; Fixed Width
3857 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3858 ;; Keywords.
3867 org-element-block-name-alist)))
3882 ;; Footnote Definition.
3885 ;; Horizontal Rule.
3888 ;; Diary Sexp.
3891 ;; Table.
3893 ;; List.
3896 limit affiliated
3898 ;; Default element: Paragraph.
3902 ;; Most elements can have affiliated keywords. When looking for an
3903 ;; element beginning, we want to move before them, as they belong to
3904 ;; that element, and, in the meantime, collect information they give
3905 ;; into appropriate properties. Hence the following function.
3908 "Collect affiliated keywords from point down to LIMIT.
3910 Return a list whose CAR is the position at the first of them and
3911 CDR a plist of keywords and values and move point to the
3912 beginning of the first line after them.
3914 As a special case, if element doesn't start at the beginning of
3915 the line (i.e. a paragraph starting an item), CAR is current
3916 position of point and CDR is nil."
3920 ;; RESTRICT is the list of objects allowed in parsed
3921 ;; keywords value.
3923 output)
3926 ;; Apply translation to RAW-KWD. From there, KWD is
3927 ;; the official keyword.
3929 org-element-keyword-translation-alist))
3930 raw-kwd))
3931 ;; Find main value for any keyword.
3937 ;; PARSEDP is non-nil when keyword should have its
3938 ;; value parsed.
3940 ;; If KWD is a dual keyword, find its secondary
3941 ;; value. Maybe parse it.
3948 ;; Attribute a property name to KWD.
3950 ;; Now set final shape for VALUE.
3956 ;; Attributes can always appear on multiple lines.
3959 ;; Eventually store the new value in OUTPUT.
3961 ;; Move to next keyword.
3963 ;; If affiliated keywords are orphaned: move back to first one.
3964 ;; They will be parsed as a paragraph.
3966 ;; Return value.
3970 \f
3971 ;;; The Org Parser
3972 ;;
3973 ;; The two major functions here are `org-element-parse-buffer', which
3974 ;; parses Org syntax inside the current buffer, taking into account
3975 ;; region, narrowing, or even visibility if specified, and
3976 ;; `org-element-parse-secondary-string', which parses objects within
3977 ;; a given string.
3978 ;;
3979 ;; The (almost) almighty `org-element-map' allows to apply a function
3980 ;; on elements or objects matching some type, and accumulate the
3981 ;; resulting values. In an export situation, it also skips unneeded
3982 ;; parts of the parse tree.
3985 "Recursively parse the buffer and return structure.
3986 If narrowing is in effect, only parse the visible part of the
3987 buffer.
3989 Optional argument GRANULARITY determines the depth of the
3990 recursion. It can be set to the following symbols:
3992 `headline' Only parse headlines.
3993 `greater-element' Don't recurse into greater elements excepted
3994 headlines and sections. Thus, elements
3995 parsed are the top-level ones.
3996 `element' Parse everything but objects and plain text.
3997 `object' Parse the complete buffer (default).
3999 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4000 elements.
4002 An element or an objects is represented as a list with the
4003 pattern (TYPE PROPERTIES CONTENTS), where :
4005 TYPE is a symbol describing the element or object. See
4006 `org-element-all-elements' and `org-element-all-objects' for an
4007 exhaustive list of such symbols. One can retrieve it with
4008 `org-element-type' function.
4010 PROPERTIES is the list of attributes attached to the element or
4011 object, as a plist. Although most of them are specific to the
4012 element or object type, all types share `:begin', `:end',
4013 `:post-blank' and `:parent' properties, which respectively
4014 refer to buffer position where the element or object starts,
4015 ends, the number of white spaces or blank lines after it, and
4016 the element or object containing it. Properties values can be
4017 obtained by using `org-element-property' function.
4019 CONTENTS is a list of elements, objects or raw strings
4020 contained in the current element or object, when applicable.
4021 One can access them with `org-element-contents' function.
4023 The Org buffer has `org-data' as type and nil as properties.
4024 `org-element-map' function can be used to find specific elements
4025 or objects within the parse tree.
4027 This function assumes that current major mode is `org-mode'."
4033 ;; Start in `first-section' mode so text before the first
4034 ;; headline belongs to a section.
4038 "Recursively parse objects in STRING and return structure.
4040 RESTRICTION is a symbol limiting the object types that will be
4041 looked after.
4043 Optional argument PARENT, when non-nil, is the element or object
4044 containing the secondary string. It is used to set correctly
4045 `:parent' property within the string."
4046 ;; Copy buffer-local variables listed in
4047 ;; `org-element-object-variables' into temporary buffer. This is
4048 ;; required since object parsing is dependent on these variables.
4052 org-element-object-variables))))
4060 secondary))
4061 secondary))))
4065 "Map a function on selected elements or objects.
4067 DATA is a parse tree, an element, an object, a string, or a list
4068 of such constructs. TYPES is a symbol or list of symbols of
4069 elements or objects types (see `org-element-all-elements' and
4070 `org-element-all-objects' for a complete list of types). FUN is
4071 the function called on the matching element or object. It has to
4072 accept one argument: the element or object itself.
4074 When optional argument INFO is non-nil, it should be a plist
4075 holding export options. In that case, parts of the parse tree
4076 not exportable according to that property list will be skipped.
4078 When optional argument FIRST-MATCH is non-nil, stop at the first
4079 match for which FUN doesn't return nil, and return that value.
4081 Optional argument NO-RECURSION is a symbol or a list of symbols
4082 representing elements or objects types. `org-element-map' won't
4083 enter any recursive element or object whose type belongs to that
4084 list. Though, FUN can still be applied on them.
4086 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4087 apply to matching objects within parsed affiliated keywords (see
4088 `org-element-parsed-keywords').
4090 Nil values returned from FUN do not appear in the results.
4093 Examples:
4094 ---------
4096 Assuming TREE is a variable containing an Org buffer parse tree,
4097 the following example will return a flat list of all `src-block'
4098 and `example-block' elements in it:
4100 \(org-element-map tree '(example-block src-block) 'identity)
4102 The following snippet will find the first headline with a level
4105 \(org-element-map tree 'headline
4106 \(lambda (hl)
4107 \(and (= (org-element-property :level hl) 1)
4109 \(org-element-property :begin hl)))
4110 nil t)
4112 The next example will return a flat list of all `plain-list' type
4113 elements in TREE that are not a sub-list themselves:
4115 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4117 Eventually, this example will return a flat list of all `bold'
4118 type objects containing a `latex-snippet' type object, even
4119 looking into captions:
4121 \(org-element-map tree 'bold
4122 \(lambda (b)
4123 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4124 nil nil nil t)"
4125 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4128 ;; Recursion depth is determined by --CATEGORY.
4135 ;; If one object is found, the function
4136 ;; has to recurse into every object.
4139 ;; If one regular element is found, the
4140 ;; function has to recurse, at least,
4141 ;; into every element it encounters.
4144 types)
4145 category)))
4146 ;; Compute properties for affiliated keywords if necessary.
4151 org-element-affiliated-keywords)))
4152 --acc
4153 --walk-tree
4157 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4158 ;; holding contextual information.
4162 ;; Ignored element in an export context.
4164 ;; List of elements or objects.
4166 ;; Unconditionally enter parse trees.
4170 ;; Check if TYPE is matching among TYPES. If so,
4171 ;; apply FUN to --DATA and accumulate return value
4172 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4178 ;; If --DATA has a secondary string that can contain
4179 ;; objects with their type among TYPES, look into it.
4186 ;; If --DATA has any affiliated keywords and
4187 ;; WITH-AFFILIATED is non-nil, look for objects in
4188 ;; them.
4196 ;; Pay attention to the type of value.
4197 ;; Preserve order for multiple keywords.
4213 --affiliated-alist))
4214 ;; Determine if a recursion into --DATA is possible.
4216 ;; --TYPE is explicitly removed from recursion.
4218 ;; --DATA has no contents.
4220 ;; Looking for greater elements but --DATA is simply
4221 ;; an element or an object.
4224 ;; Looking for elements but --DATA is an object.
4227 ;; In any other case, map contents.
4231 ;; Return value in a proper order.
4235 ;; The following functions are internal parts of the parser.
4236 ;;
4237 ;; The first one, `org-element--parse-elements' acts at the element's
4238 ;; level.
4239 ;;
4240 ;; The second one, `org-element--parse-objects' applies on all objects
4241 ;; of a paragraph or a secondary string. It uses
4242 ;; `org-element--get-next-object-candidates' to optimize the search of
4243 ;; the next object in the buffer.
4244 ;;
4245 ;; More precisely, that function looks for every allowed object type
4246 ;; first. Then, it discards failed searches, keeps further matches,
4247 ;; and searches again types matched behind point, for subsequent
4248 ;; calls. Thus, searching for a given type fails only once, and every
4249 ;; object is searched only once at top level (but sometimes more for
4250 ;; nested types).
4254 "Parse elements between BEG and END positions.
4256 SPECIAL prioritize some elements over the others. It can be set
4257 to `first-section', `section' `item' or `table-row'.
4259 When value is `item', STRUCTURE will be used as the current list
4260 structure.
4262 GRANULARITY determines the depth of the recursion. See
4263 `org-element-parse-buffer' for more information.
4265 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4266 elements.
4268 Elements are accumulated into ACC."
4271 ;; Visible only: skip invisible parts at the beginning of the
4272 ;; element.
4275 ;; When parsing only headlines, skip any text before first one.
4278 ;; Main loop start.
4280 ;; Find current element's type and parse it accordingly to
4281 ;; its category.
4283 end granularity special structure))
4287 ;; Visible only: skip invisible parts between siblings.
4290 ;; Fill ELEMENT contents by side-effect.
4292 ;; If element has no contents, don't modify it.
4294 ;; Greater element: parse it between `contents-begin' and
4295 ;; `contents-end'. Make sure GRANULARITY allows the
4296 ;; recursion, or ELEMENT is a headline, in which case going
4297 ;; inside is mandatory, in order to get sub-level headings.
4305 ;; Possibly switch to a special mode.
4313 granularity visible-only element))
4314 ;; ELEMENT has contents. Parse objects inside, if
4315 ;; GRANULARITY allows it.
4321 ;; Return result.
4322 acc))
4325 "Parse objects between BEG and END and return recursive structure.
4327 Objects are accumulated in ACC.
4329 RESTRICTION is a list of object successors which are allowed in
4330 the current object."
4339 restriction candidates)))
4346 ;; 1. Text before any object. Untabify it.
4351 acc
4355 ;; 2. Object...
4358 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4359 ;; a recursive type.
4367 ;; 3. Text after last object. Untabify it.
4371 acc
4375 ;; Result.
4376 acc))))
4379 "Return an alist of candidates for the next object.
4381 RESTRICTION is a list of object types, as symbols. Only
4382 candidates with such types are looked after.
4384 OBJECTS is the previous candidates alist. If it is set to
4385 `initial', no search has been done before, and all symbols in
4386 RESTRICTION should be looked after.
4388 Return value is an alist whose CAR is the object type and CDR its
4389 beginning position."
4391 nil
4393 ;; When searching for the first time, look for every successor
4394 ;; allowed in RESTRICTION.
4398 restriction)
4399 ;; Focus on objects returned during last search. Keep those
4400 ;; still after point. Search again objects before it.
4406 type)))
4409 objects))))
4412 \f
4413 ;;; Towards A Bijective Process
4414 ;;
4415 ;; The parse tree obtained with `org-element-parse-buffer' is really
4416 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4417 ;; interpreted and expanded into a string with canonical Org syntax.
4418 ;; Hence `org-element-interpret-data'.
4419 ;;
4420 ;; The function relies internally on
4421 ;; `org-element--interpret-affiliated-keywords'.
4423 ;;;###autoload
4425 "Interpret DATA as Org syntax.
4427 DATA is a parse tree, an element, an object or a secondary string
4428 to interpret.
4430 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4431 new types that should be treated as objects. An unknown type not
4432 belonging to this list is seen as a pseudo-element instead. Both
4433 pseudo-objects and pseudo-elements are transparent entities, i.e.
4434 only their contents are interpreted.
4436 Return Org syntax as a string."
4440 "Interpret DATA as Org syntax.
4442 DATA is a parse tree, an element, an object or a secondary string
4443 to interpret. PARENT is used for recursive calls. It contains
4444 the element or object containing data, or nil. PSEUDO-OBJECTS
4445 are list of symbols defining new element or object types.
4446 Unknown types that don't belong to this list are treated as
4447 pseudo-elements instead.
4449 Return Org syntax as a string."
4451 ;; Find interpreter for current object or element. If it
4452 ;; doesn't exist (e.g. this is a pseudo object or element),
4453 ;; return contents, if any.
4459 ;; Secondary string.
4465 ;; Full Org document.
4471 ;; Plain text: return it.
4473 ;; Element or object without contents.
4475 ;; Element or object with contents.
4478 ;; Recursively interpret contents.
4484 data
4485 ;; Fix indentation of elements containing
4486 ;; objects. We ignore `table-row' elements
4487 ;; as they are one line long anyway.
4489 data
4490 ;; When normalizing first paragraph of an
4491 ;; item or a footnote-definition, ignore
4492 ;; first line's indentation.
4499 ;; Build white spaces. If no `:post-blank' property is
4500 ;; specified, assume its value is 0.
4511 "Return ELEMENT's affiliated keywords as Org syntax.
4512 If there is no affiliated keyword, return the empty string."
4522 ": "
4525 value)
4533 ;; All attribute keywords can have multiple lines.
4539 ;; List all ELEMENT's properties matching an attribute line or an
4540 ;; affiliated keyword, but ignore translated keywords since they
4541 ;; cannot belong to the property list.
4548 org-element-keyword-translation-alist)))))
4549 collect prop)
4552 ;; Because interpretation of the parse tree must return the same
4553 ;; number of blank lines between elements and the same number of white
4554 ;; space after objects, some special care must be given to white
4555 ;; spaces.
4556 ;;
4557 ;; The first function, `org-element-normalize-string', ensures any
4558 ;; string different from the empty string will end with a single
4559 ;; newline character.
4560 ;;
4561 ;; The second function, `org-element-normalize-contents', removes
4562 ;; global indentation from the contents of the current element.
4565 "Ensure string S ends with a single newline character.
4567 If S isn't a string return it unchanged. If S is the empty
4568 string, return it. Otherwise, return a new string with a single
4569 newline character at its end."
4577 "Normalize plain text in ELEMENT's contents.
4579 ELEMENT must only contain plain text and objects.
4581 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4582 indentation to compute maximal common indentation.
4584 Return the normalized element that is element with global
4585 indentation removed from its contents. The function assumes that
4586 indentation is not done with TAB characters."
4588 find-min-ind ; For byte-compiler.
4591 ;; Return minimal common indentation within BLOB. This is
4592 ;; done by walking recursively BLOB and updating MIN-IND
4593 ;; along the way. FIRST-FLAG is non-nil when the first
4594 ;; string hasn't been seen yet. It is required as this
4595 ;; string is the only one whose indentation doesn't happen
4596 ;; after a newline character.
4603 ;; An indentation of zero means no string will be
4604 ;; modified. Quit the process.
4613 ;; Find minimal indentation in ELEMENT.
4616 ;; Build ELEMENT back, replacing each string with the same
4617 ;; string minus common indentation.
4622 ;; Return BLOB with all its strings indentation
4623 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4624 ;; is non-nil when the first string hasn't been seen
4625 ;; yet.
4640 org-element-recursive-objects)
4644 blob))))
4648 \f
4649 ;;; Cache
4650 ;;
4651 ;; Implement a caching mechanism for `org-element-at-point' and
4652 ;; `org-element-context', which see.
4653 ;;
4654 ;; A single public function is provided: `org-element-cache-reset'.
4655 ;;
4656 ;; Cache is enabled by default, but can be disabled globally with
4657 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4658 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4659 ;; can be tweaked to control caching behaviour.
4660 ;;
4661 ;; Internally, parsed elements are stored in an AVL tree,
4662 ;; `org-element--cache'. This tree is updated lazily: whenever
4663 ;; a change happens to the buffer, a synchronization request is
4664 ;; registered in `org-element--cache-sync-requests' (see
4665 ;; `org-element--cache-submit-request'). During idle time, requests
4666 ;; are processed by `org-element--cache-sync'. Synchronization also
4667 ;; happens when an element is required from the cache. In this case,
4668 ;; the process stops as soon as the needed element is up-to-date.
4669 ;;
4670 ;; A synchronization request can only apply on a synchronized part of
4671 ;; the cache. Therefore, the cache is updated at least to the
4672 ;; location where the new request applies. Thus, requests are ordered
4673 ;; from left to right and all elements starting before the first
4674 ;; request are correct. This property is used by functions like
4675 ;; `org-element--cache-find' to retrieve elements in the part of the
4676 ;; cache that can be trusted.
4677 ;;
4678 ;; A request applies to every element, starting from its original
4679 ;; location (or key, see below). When a request is processed, it
4680 ;; moves forward and may collide the next one. In this case, both
4681 ;; requests are merged into a new one that starts from that element.
4682 ;; As a consequence, the whole synchronization complexity does not
4683 ;; depend on the number of pending requests, but on the number of
4684 ;; elements the very first request will be applied on.
4685 ;;
4686 ;; Elements cannot be accessed through their beginning position, which
4687 ;; may or may not be up-to-date. Instead, each element in the tree is
4688 ;; associated to a key, obtained with `org-element--cache-key'. This
4689 ;; mechanism is robust enough to preserve total order among elements
4690 ;; even when the tree is only partially synchronized.
4691 ;;
4692 ;; Objects contained in an element are stored in a hash table,
4693 ;; `org-element--cache-objects'.
4697 "Non nil when Org parser should cache its results.
4704 "Maximum duration, as a time value, for a cache synchronization.
4705 If the synchronization is not over after this delay, the process
4706 pauses and resumes after `org-element-cache-sync-break'
4710 "Duration, as a time value, of the pause between synchronizations.
4714 ;;;; Data Structure
4717 "AVL tree used to cache elements.
4718 Each node of the tree contains an element. Comparison is done
4719 with `org-element--cache-compare'. This cache is used in
4723 "Hash table used as to cache objects.
4724 Key is an element, as returned by `org-element-at-point', and
4725 value is an alist where each association is:
4727 \(POS CANDIDATES . OBJECTS)
4729 where POS is a buffer position, CANDIDATES is the last know list
4730 of successors (see `org-element--get-next-object-candidates') in
4731 container starting at POS and OBJECTS is a list of objects known
4732 to live within that container, from farthest to closest.
4735 at, respectively, positions 1, 7 and 8,
4739 If the paragraph is completely parsed, OBJECTS-DATA will be
4741 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
4742 \(8 nil ENTITY-OBJECT))
4744 whereas in a partially parsed paragraph, it could be
4746 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
4751 "List of pending synchronization requests.
4753 A request is a vector with the following pattern:
4755 \[NEXT END OFFSET PARENT PHASE]
4757 Processing a synchronization request consists in three phases:
4759 0. Delete modified elements,
4760 1. Fill missing area in cache,
4761 2. Shift positions and re-parent elements after the changes.
4763 During phase 0, NEXT is the key of the first element to be
4764 removed and END is buffer position delimiting the modifications.
4765 Every element starting between these are removed. PARENT is an
4766 element to be removed. Every element contained in it will also
4767 be removed.
4769 During phase 1, NEXT is the key of the next known element in
4770 cache. Parse buffer between that element and the one before it
4771 in order to determine the parent of the next element. Set PARENT
4772 to the element containing NEXT.
4774 During phase 2, NEXT is the key of the next element to shift in
4775 the parse tree. All elements starting from this one have their
4776 properties relatives to buffer positions shifted by integer
4777 OFFSET and, if they belong to element PARENT, are adopted by it.
4785 "Hash table used to store keys during synchronization.
4789 "Return a unique key for ELEMENT in cache tree.
4791 Keys are used to keep a total order among elements in the cache.
4792 Comparison is done with `org-element--cache-key-less-p'.
4794 When no synchronization is taking place, a key is simply the
4795 beginning position of the element, or that position plus one in
4796 the case of an first item (respectively row) in
4797 a list (respectively a table).
4799 During a synchronization, the key is the one the element had when
4800 the cache was synchronized for the last time. Elements added to
4801 cache during the synchronization get a new key generated with
4802 `org-element--cache-generate-key'.
4804 Such keys are stored in `org-element--cache-sync-keys'. The hash
4805 table is cleared once the synchronization is complete."
4808 ;; Increase beginning position of items (respectively
4809 ;; table rows) by one, so the first item can get
4810 ;; a different key from its parent list (respectively
4811 ;; table).
4814 begin)))
4817 key))))
4820 "Default value for a new key level.
4824 "Generate a key between LOWER and UPPER.
4826 LOWER and UPPER are integers or lists, possibly empty.
4828 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4829 a unique key, as an integer or a list of integers, according to
4830 the following rules:
4832 - LOWER and UPPER are compared level-wise until values differ.
4834 - If, at a given level, LOWER and UPPER differ from more than
4835 2, the new key shares all the levels above with LOWER and
4836 gets a new level. Its value is the mean between LOWER and
4837 UPPER.
4839 \(1 2) + (1 4) --> (1 3)
4841 - If LOWER has no value to compare with, it is assumed that its
4842 value is 0:
4844 \(1 1) + (1 1 2) --> (1 1 1)
4846 Likewise, if UPPER is short of levels, the current value is
4847 `most-positive-fixnum'.
4849 - If they differ from only one, the new key inherits from
4850 current LOWER lever and has a new level at the value
4851 `org-element--cache-default-key'.
4853 \(1 2) + (1 3) --> (1 2 org-element--cache-default-key)
4855 - If the key is only one level long, it is returned as an
4856 integer.
4858 \(1 2) + (3 2) --> 2"
4862 key)
4880 org-element--cache-default-key))
4881 org-element--cache-default-key)
4882 key)
4888 key)
4895 ;; (n) is equivalent to (n 0 0 0 0 ...) so we want to avoid
4896 ;; ending on a sequence of 0.
4901 key)))
4909 org-element--cache-default-key))
4910 org-element--cache-default-key)
4911 key))))
4912 ;; Ensure we don't return a list with a single element.
4916 "Non-nil if key A is less than key B.
4917 A and B are either integers or lists of integers, as returned by
4918 `org-element--cache-key'."
4926 ;; If A is empty, either keys are equal (B is also empty) or
4927 ;; B is less than A (B is longer). Therefore return nil.
4928 ;;
4929 ;; If A is not empty, B is necessarily empty and A is less
4930 ;; than B (A is longer). Therefore, return a non-nil value.
4931 a))))
4934 "Non-nil when element A is located before element B."
4939 "Return root value in cache.
4940 This function assumes `org-element--cache' is a valid AVL tree."
4944 ;;;; Tools
4947 "Non-nil when cache is active in current buffer."
4952 "Find element in cache starting at POS or before.
4954 POS refers to a buffer position.
4956 When optional argument SIDE is non-nil, the function checks for
4957 elements starting at or past POS instead. If SIDE is `both', the
4958 function returns a cons cell where car is the first element
4959 starting at or before POS and cdr the first element starting
4960 after POS.
4962 The function can only find elements in the synchronized part of
4963 the cache."
4967 lower upper)
4982 ;; We found an element in cache starting at POS. If `side'
4983 ;; is `both' we also want the next one in order to generate
4984 ;; a key in-between.
4985 ;;
4986 ;; If the element is the first row or item in a table or
4987 ;; a plain list, we always return the table or the plain
4988 ;; list.
4989 ;;
4990 ;; In any other case, we return the element found.
4999 lower parent
5000 upper parent)))))
5003 lower element
5004 upper element)))))
5011 "Store ELEMENT in current buffer's cache, if allowed.
5012 When optional argument DATA is non-nil, assume is it object data
5013 relative to ELEMENT and store it in the objects cache."
5017 ;; During synchronization, first build an appropriate key for
5018 ;; the new element so `avl-tree-enter' can insert it at the
5019 ;; right spot in the cache.
5028 org-element--cache-sync-keys)))
5032 ;;;; Synchronization
5035 "Set idle timer for cache synchronization in BUFFER."
5042 org-element-cache-sync-idle-time))
5043 nil
5044 #'org-element--cache-sync
5045 buffer)))
5048 "Non-nil when synchronization process should be interrupted.
5049 TIME-LIMIT is a time value or nil."
5055 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5057 Properties containing buffer positions are `:begin', `:end',
5058 `:contents-begin', `:contents-end' and `:structure'. When
5059 optional argument PROPS is a list of keywords, only shift
5060 properties provided in that list.
5062 Properties are modified by side-effect."
5064 ;; Shift `:structure' property for the first plain list only: it
5065 ;; is the only one that really matters and it prevents from
5066 ;; shifting it more than once.
5080 "Synchronize cache with recent modification in BUFFER.
5081 When optional argument THRESHOLD is non-nil, do the
5082 synchronization for all elements starting before or at threshold,
5083 then exit. Otherwise, synchronize cache for as long as
5084 `org-element-cache-sync-duration' or until Emacs leaves idle
5085 state."
5096 request
5098 threshold
5101 org-element-cache-sync-duration)))
5103 ;; Request processed. Merge current and next offsets and
5104 ;; transfer phase number and ending position.
5111 ;; If more requests are awaiting, set idle timer accordingly.
5112 ;; Otherwise, reset keys.
5118 "Process synchronization REQUEST for all entries before NEXT.
5120 REQUEST is a vector, built by `org-element--cache-submit-request'.
5122 NEXT is a cache key, as returned by `org-element--cache-key'.
5124 When non-nil, THRESHOLD is a buffer position. Synchronization
5125 stops as soon as a shifted element begins after it.
5127 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5128 after this time or when Emacs exits idle state.
5130 Return nil if the process stops before completing the request,
5131 t otherwise."
5134 ;; Phase 1.
5135 ;;
5136 ;; Delete all elements starting after BEG, but not after buffer
5137 ;; position END or past element with key NEXT.
5138 ;;
5139 ;; As an exception, also delete elements starting after
5140 ;; modifications but included in an element altered by
5141 ;; modifications (orphans).
5142 ;;
5143 ;; At each iteration, we start again at tree root since
5144 ;; a deletion modifies structure of the balanced tree.
5153 ;; Find first element in cache with key BEG or after it.
5154 ;; We don't use `org-element--cache-find' because it
5155 ;; couldn't reach orphaned elements past NEXT. Moreover,
5156 ;; BEG is a key, not a buffer position.
5166 data-key key
5169 data-key key
5170 node nil)))))
5174 ;; Remove orphaned elements.
5180 up))
5184 next)))
5194 ;; Phase 2.
5195 ;;
5196 ;; Phase 1 left a hole in the parse tree. Some elements after
5197 ;; it could have parents within. For example, in the following
5198 ;; buffer:
5199 ;;
5200 ;;
5201 ;; - item
5202 ;;
5203 ;;
5204 ;; Paragraph1
5205 ;;
5206 ;; Paragraph2
5207 ;;
5208 ;;
5209 ;; if we remove a blank line between "item" and "Paragraph1",
5210 ;; everything down to "Paragraph2" is removed from cache. But
5211 ;; the paragraph now belongs to the list, and its `:parent'
5212 ;; property no longer is accurate.
5213 ;;
5214 ;; Therefore we need to parse again elements in the hole, or at
5215 ;; least in its last section, so that we can re-parent
5216 ;; subsequent elements, during phase 3.
5217 ;;
5218 ;; Note that we only need to get the parent from the first
5219 ;; element in cache after the hole.
5220 ;;
5221 ;; Also, this part can be delayed if we don't need to retrieve
5222 ;; an element after the hole.
5224 ;; Next element will start at its beginning position plus
5225 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5226 ;; contains the real beginning position of the first element
5227 ;; to shift and re-parent.
5236 ;; Phase 3.
5237 ;;
5238 ;; Shift all elements starting from key START, but before NEXT, by
5239 ;; OFFSET, and re-parent them when appropriate.
5240 ;;
5241 ;; Elements are modified by side-effect so the tree structure
5242 ;; remains intact.
5243 ;;
5244 ;; Once THRESHOLD, if any, is reached, or once there is an input
5245 ;; pending, exit. Before leaving, the current synchronization
5246 ;; request is updated.
5253 exit-flag)
5254 ;; No re-parenting nor shifting planned: request is over.
5264 ;; We reached NEXT. Request is complete.
5266 ;; Handle interruption request. Update current request.
5271 ;; Shift element.
5274 ;; Shift associated objects data, if any.
5282 ;; Re-parent it.
5288 ;; Cache is up-to-date past THRESHOLD. Request
5289 ;; interruption.
5294 ;; We reached end of tree: synchronization complete.
5295 t)))
5298 "Parse elements in current section, down to POS.
5300 Start parsing from the closest between the last known element in
5301 cache or headline above. Return the smallest element containing
5302 POS.
5304 When optional argument SYNCP is non-nil, return the parent of the
5305 element containing POS instead. In that case, it is also
5306 possible to provide TIME-LIMIT, which is a time value specifying
5307 when the parsing should stop. The function returns `interrupted'
5308 if the process stopped before finding the expected result."
5315 element next)
5317 ;; Nothing in cache before point: start parsing from first
5318 ;; element following headline above, or first element in
5319 ;; buffer.
5325 ;; Cache returned exact match: return it.
5328 ;; There's a headline between cached value and POS: cached
5329 ;; value is invalid. Start parsing from first element
5330 ;; following the headline.
5336 ;; Check if CACHED or any of its ancestors contain point.
5337 ;;
5338 ;; If there is such an element, we inspect it in order to know
5339 ;; if we return it or if we need to parse its contents.
5340 ;; Otherwise, we just start parsing from current location,
5341 ;; which is right after the top-most element containing
5342 ;; CACHED.
5343 ;;
5344 ;; As a special case, if POS is at the end of the buffer, we
5345 ;; want to return the innermost element ending there.
5346 ;;
5347 ;; Also, if we find an ancestor and discover that we need to
5348 ;; parse its contents, make sure we don't start from
5349 ;; `:contents-begin', as we would otherwise go past CACHED
5350 ;; again. Instead, in that situation, we will resume parsing
5351 ;; from NEXT, which is located after CACHED or its higher
5352 ;; ancestor not containing point.
5364 ;; Parse successively each element until we reach POS.
5370 special-flag)
5378 end 'element special-flag
5385 ;; Skip any element ending before point. Also skip
5386 ;; element ending at point (unless it is also the end of
5387 ;; buffer) since we're sure that another element begins
5388 ;; after it.
5391 ;; A non-greater element contains point: return it.
5394 ;; Otherwise, we have to decide if ELEMENT really
5395 ;; contains POS. In that case we start parsing from
5396 ;; contents' beginning.
5397 ;;
5398 ;; If POS is at contents' beginning but it is also at
5399 ;; the beginning of the first item in a list or a table.
5400 ;; In that case, we need to create an anchor for that
5401 ;; list or table, so return it.
5402 ;;
5403 ;; Also, if POS is at the end of the buffer, no element
5404 ;; can start after it, but more than one may end there.
5405 ;; Arbitrarily, we choose to return the innermost of
5406 ;; such elements.
5422 parent element
5423 end cend))))
5424 ;; Otherwise, return ELEMENT as it is the smallest
5425 ;; element containing POS.
5430 ;;;; Staging Buffer Changes
5438 "Regexp matching an element opening line.
5439 When such a line is modified, modifications may propagate after
5440 modified area. In that situation, every element between that
5449 "Regexp matching an element closing line.
5450 When such a line is modified, modifications may propagate before
5451 modified area. In that situation, every element between that
5455 "Non-nil when a sensitive line is about to be changed.
5459 "Request extension of area going to be modified if needed.
5460 BEG and END are the beginning and end of the range of changed
5461 text. See `before-change-functions' for more information."
5463 ;; Make sure buffer positions in cache are correct until END.
5471 ;; A sensitive line is a headline or a block (or drawer,
5472 ;; or latex-environment) boundary. Inserting one can
5473 ;; modify buffer drastically both above and below that
5474 ;; line, possibly making cache invalid. Therefore, we
5475 ;; need to pay attention to changes happening to them.
5479 org-element--cache-opening-line)))
5492 "Update buffer modifications for current buffer.
5493 BEG and END are the beginning and end of the range of changed
5494 text, and the length in bytes of the pre-change text replaced by
5495 that range. See `after-change-functions' for more information."
5505 ;; Determine if modified area needs to be extended,
5506 ;; according to both previous and current state. We make
5507 ;; a special case for headline editing: if a headline is
5508 ;; modified but not removed, do not extend.
5513 org-element--cache-opening-line))
5525 ;; Effectively extend modified area.
5532 ;; Store synchronization request.
5535 ;; Activate a timer to process the request during idle time.
5539 "Submit a new cache synchronization request for current buffer.
5540 BEG and END are buffer positions delimiting the minimal area
5541 where cache data should be removed. OFFSET is the size of the
5542 change, as an integer."
5544 ;; Find the position of the first element in cache to remove.
5545 ;;
5546 ;; Partially modified elements will be removed during request
5547 ;; processing. As an exception, greater elements around the
5548 ;; changes that are robust to contents modifications are
5549 ;; preserved.
5550 ;;
5551 ;; We look just before BEG because an element ending at BEG
5552 ;; needs to be removed too.
5561 drawer dynamic-block inlinetask
5562 property-drawer quote-block special-block))
5565 ;; UP is a greater element that is wrapped around
5566 ;; the changes. We only need to extend its
5567 ;; ending boundaries and those of all its
5568 ;; parents.
5574 ;; We're at top level element containing ELEMENT: if
5575 ;; it's altered by buffer modifications, it is first
5576 ;; element in cache to be removed. Otherwise, that
5577 ;; first element is the following one.
5580 ;; Changes happened before the first known element. Shift the
5581 ;; rest of the cache.
5584 org-element--cache-sync-requests))
5585 ;; There is at least an element to remove. Find position past
5586 ;; every element containing END.
5597 org-element--cache-sync-requests))
5598 ;; No element to remove. No need to re-parent either. Simply
5599 ;; shift additional elements, if any, by OFFSET.
5604 ;;;; Public Functions
5606 ;;;###autoload
5608 "Reset cache in current buffer.
5609 When optional argument ALL is non-nil, reset cache in all Org
5610 buffers. This function will do nothing if
5611 `org-element-use-cache' is nil."
5631 \f
5632 ;;; The Toolbox
5633 ;;
5634 ;; The first move is to implement a way to obtain the smallest element
5635 ;; containing point. This is the job of `org-element-at-point'. It
5636 ;; basically jumps back to the beginning of section containing point
5637 ;; and proceed, one element after the other, with
5638 ;; `org-element--current-element' until the container is found. Note:
5639 ;; When using `org-element-at-point', secondary values are never
5640 ;; parsed since the function focuses on elements, not on objects.
5641 ;;
5642 ;; At a deeper level, `org-element-context' lists all elements and
5643 ;; objects containing point.
5644 ;;
5645 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5646 ;; internally by navigation and manipulation tools.
5649 ;;;###autoload
5651 "Determine closest element around point.
5653 Return value is a list like (TYPE PROPS) where TYPE is the type
5654 of the element and PROPS a plist of properties associated to the
5655 element.
5657 Possible types are defined in `org-element-all-elements'.
5658 Properties depend on element or object type, but always include
5659 `:begin', `:end', `:parent' and `:post-blank' properties.
5661 As a special case, if point is at the very beginning of the first
5662 item in a list or sub-list, returned element will be that list
5663 instead of the item. Likewise, if point is at the beginning of
5664 the first row of a table, returned element will be the table
5665 instead of the first row.
5667 When point is at the end of the buffer, return the innermost
5668 element ending there."
5674 ;; Within blank lines at the beginning of buffer, return nil.
5676 ;; Within blank lines right after a headline, return that
5677 ;; headline.
5681 ;; Otherwise parse until we find element containing ORIGIN.
5688 ;;;###autoload
5690 "Return closest element or object around point.
5692 Return value is a list like (TYPE PROPS) where TYPE is the type
5693 of the element or object and PROPS a plist of properties
5694 associated to it.
5696 Possible types are defined in `org-element-all-elements' and
5697 `org-element-all-objects'. Properties depend on element or
5698 object type, but always include `:begin', `:end', `:parent' and
5699 `:post-blank'.
5701 Optional argument ELEMENT, when non-nil, is the closest element
5702 containing point, as returned by `org-element-at-point'.
5703 Providing it allows for quicker computation."
5709 ;; If point is inside an element containing objects or
5710 ;; a secondary string, narrow buffer to the container and
5711 ;; proceed with parsing. Otherwise, return ELEMENT.
5713 ;; At a parsed affiliated keyword, check if we're inside main
5714 ;; or dual value.
5721 org-element-parsed-keywords))
5730 ;; Also change type to retrieve correct restrictions.
5732 ;; At an item, objects can only be located within tag, if any.
5742 ;; At an headline or inlinetask, objects are in title.
5749 ;; At a paragraph, a table-row or a verse block, objects are
5750 ;; located within their contents.
5754 ;; CBEG is nil for table rules.
5759 ;; At a parsed keyword, objects are located within value.
5762 org-element-document-properties))
5769 ;; At a planning line, if point is at a timestamp, return it,
5770 ;; otherwise, return element.
5778 ;; All other locations cannot contain objects: bail out.
5787 objects-data next)
5791 ;; Get list of next object candidates in CANDIDATES.
5792 ;; When entering for the first time PARENT, grab it
5793 ;; from cache, if available, or compute it. Then,
5794 ;; for each subsequent iteration in PARENT, always
5795 ;; compute it since we're beyond cache anyway.
5800 cache))))
5804 restriction candidates))
5806 ;; Compare ORIGIN with next object starting position,
5807 ;; if any.
5808 ;;
5809 ;; If ORIGIN is lesser or if there is no object
5810 ;; following, look for a previous object that might
5811 ;; contain it in cache. If there is no cache, we
5812 ;; didn't miss any object so simply return PARENT.
5813 ;;
5814 ;; If ORIGIN is greater or equal, parse next
5815 ;; candidate for further processing.
5819 candidates))))
5836 ;; Process NEXT to know if we need to skip it, return
5837 ;; it or move into it.
5842 ;; ORIGIN is after NEXT, so skip it.
5844 ;; ORIGIN is within a non-recursive next or
5845 ;; at an object boundaries: Return that object.
5849 ;; Otherwise, move into NEXT and reset flags as we
5850 ;; shift parent.
5856 next nil
5857 objects-data nil
5859 ;; Store results in cache, if applicable.
5863 "Non-nil when elements ELEM-A and ELEM-B are nested."
5872 "Swap elements ELEM-A and ELEM-B.
5873 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5874 end of ELEM-A."
5876 ;; There are two special cases when an element doesn't start at bol:
5877 ;; the first paragraph in an item or in a footnote definition.
5879 ;; Only a paragraph without any affiliated keyword can be moved at
5880 ;; ELEM-A position in such a situation. Note that the case of
5881 ;; a footnote definition is impossible: it cannot contain two
5882 ;; paragraphs in a row because it cannot contain a blank line.
5888 ;; In a special situation, ELEM-A will have no indentation. We'll
5889 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5903 ;; Store overlays responsible for visibility status. We
5904 ;; also need to store their boundaries as they will be
5905 ;; removed from buffer.
5912 ;; Get contents.
5920 ;; Restore ex ELEM-A overlays.
5929 ;; Restore ex ELEM-B overlays.
5937 "Remove maximum common indentation in string S and return it.
5938 When optional argument N is a positive integer, remove exactly
5939 that much characters from indentation, if possible, or return
5940 S as-is otherwise. Unlike to `org-remove-indentation', this
5941 function doesn't call `untabify' on S."
5946 ;; Find maximum common indentation, if not specified.
5954 min-ind)))
5956 ;; Remove exactly N indentation, but give up if not possible.
5969 ;; Local variables:
5970 ;; generated-autoload-file: "org-loaddefs.el"
5971 ;; End:
5973 ;;; org-element.el ends here