| blob | cbe6ae73cfbb2cfa35f456c8aaffa386d46c406c |
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', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
80 ;;
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
83 ;;
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
89 ;; list.
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
92 ;;
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
95 ;;
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
98 ;;
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
101 ;;
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
107 ;;
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
110 ;;
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
114 ;; these functions.
117 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; `org-element-update-syntax' builds proper syntax regexps according
132 ;; to current setup.
135 "Regexp to separate paragraphs in an Org buffer.
137 is not sufficient to know if point is at a paragraph ending. See
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
148 "Build variable syntax regexps."
151 ;; Headlines, inlinetasks.
153 ;; Footnote definitions.
155 ;; Diary sexps.
158 ;; Empty lines.
160 ;; Tables (any type).
162 ;; Blocks (any type), Babel calls and keywords. This
163 ;; is only an indication and need some thorough check.
165 ;; Drawers (any type) and fixed-width areas. This is
166 ;; also only an indication.
168 ;; Horizontal rules.
170 ;; LaTeX environments.
172 ;; Clock lines.
174 ;; Lists.
181 org-element--object-regexp
185 ;; Sub/superscript.
187 ;; Bold, code, italic, strike-through, underline
188 ;; and verbatim.
192 ;; Plain links.
194 ;; Objects starting with "[": regular link,
195 ;; footnote reference, statistics cookie,
196 ;; timestamp (inactive).
198 ;; Objects starting with "@": export snippets.
199 "@@"
200 ;; Objects starting with "{": macro.
201 "{{{"
202 ;; Objects starting with "<" : timestamp
203 ;; (active, diary), target, radio target and
204 ;; angular links.
206 ;; Objects starting with "$": latex fragment.
208 ;; Objects starting with "\": line break,
209 ;; entity, latex fragment.
211 ;; Objects starting with raw text: inline Babel
212 ;; source block, inline Babel call.
218 ;;;###autoload
220 "Update parser internals."
227 dynamic-block example-block export-block fixed-width
228 footnote-definition headline horizontal-rule inlinetask item
229 keyword latex-environment node-property paragraph plain-list
230 planning property-drawer quote-block section
231 special-block src-block table table-row verse-block)
236 item plain-list property-drawer quote-block section
237 special-block table)
242 inline-src-block italic line-break latex-fragment link macro
243 radio-target statistics-cookie strike-through subscript superscript
244 table-cell target timestamp underline verbatim)
249 superscript table-cell underline)
259 "Alist between block names and the associated parsing function.
260 Names must be uppercase. Any block whose name has no association
266 Only these types can accept search options and an explicit
272 "List of affiliated keywords as strings.
280 "Alist of usual translations for keywords.
281 The key is the old name and the value the new one. The property
285 "List of affiliated keywords that can occur more than once in an element.
287 Their value will be consed into a list of strings, which will be
288 returned as the value of the property.
290 This list is checked after translations have been applied. See
291 `org-element-keyword-translation-alist'.
297 "List of affiliated keywords whose value can be parsed.
299 Their value will be stored as a secondary string: a list of
300 strings and objects.
302 This list is checked after translations have been applied. See
307 org-element-parsed-keywords)
308 "Alist of parsed keywords and associated properties.
309 This is generated from `org-element-parsed-keywords', which
313 "List of affiliated keywords which can have a secondary value.
315 In Org syntax, they can be written with optional square brackets
316 before the colons. For example, RESULTS keyword can be
317 associated to a hash value with the following:
319 #+RESULTS[hash-string]: some-source
321 This list is checked after translations have been applied. See
325 "List of properties associated to the whole document.
326 Any keyword in this list will have its value parsed and stored as
332 ;; Dual affiliated keywords.
336 ;; Regular affiliated keywords.
342 org-element-affiliated-keywords)))
344 ;; Export attributes.
346 "Regexp matching any affiliated keyword.
348 Keyword name is put in match group 1. Moreover, if keyword
349 belongs to `org-element-dual-keywords', put the dual value in
350 match group 2.
364 ;; Ignore all links excepted plain links in a link description.
365 ;; Also ignore radio-targets and line breaks.
367 italic latex-fragment macro plain-link statistics-cookie
368 strike-through subscript superscript underline verbatim)
370 ;; Remove any variable object from radio target as it would
371 ;; prevent it from being properly recognized.
373 subscript superscript underline superscript)
377 ;; Ignore inline babel call and inline src block as formulas are
378 ;; possible. Also ignore line breaks and statistics cookies.
380 latex-fragment link macro radio-target strike-through
381 subscript superscript target timestamp underline verbatim)
385 "Alist of objects restrictions.
387 key is an element or object type containing objects and value is
388 a list of types that can be contained within an element or object
389 of such type.
391 For example, in a `radio-target' object, one can only find
392 entities, latex-fragments, subscript, superscript and text
393 markup.
395 This alist also applies to secondary string. For example, an
396 `headline' type element doesn't directly contain objects, but
406 \f
407 ;;; Accessors and Setters
408 ;;
409 ;; Provide four accessors: `org-element-type', `org-element-property'
410 ;; `org-element-contents' and `org-element-restriction'.
411 ;;
412 ;; Setter functions allow to modify elements by side effect. There is
413 ;; `org-element-put-property', `org-element-set-contents'. These
414 ;; low-level functions are useful to build a parse tree.
415 ;;
416 ;; `org-element-adopt-element', `org-element-set-element',
417 ;; `org-element-extract-element' and `org-element-insert-before' are
418 ;; high-level functions useful to modify a parse tree.
419 ;;
420 ;; `org-element-secondary-p' is a predicate used to know if a given
421 ;; object belongs to a secondary string.
424 "Return type of ELEMENT.
426 The function returns the type of the element or object provided.
427 It can also return the following special value:
428 `plain-text' for a string
429 `org-data' for a complete document
430 nil in any other case."
436 "Extract the value from the PROPERTY of an ELEMENT."
441 "Extract contents from an ELEMENT."
447 "Return restriction associated to ELEMENT.
448 ELEMENT can be an element, an object or a symbol representing an
449 element or object type."
451 org-element-object-restrictions)))
454 "In ELEMENT set PROPERTY to VALUE.
455 Return modified element."
458 element))
461 "Set ELEMENT contents to CONTENTS.
462 Return modified element."
469 "Non-nil when OBJECT belongs to a secondary string.
470 Return value is the property name, as a keyword, or nil."
473 org-element-secondary-value-alist))))
476 property)))
479 "Append elements to the contents of another element.
481 PARENT is an element or object. CHILDREN can be elements,
482 objects, or a strings.
484 The function takes care of setting `:parent' property for CHILD.
485 Return parent element."
486 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
487 ;; string: parent is the list itself.
490 children)
491 ;; Add CHILDREN at the end of PARENT contents.
494 parent
496 ;; Return modified PARENT element.
500 "Extract ELEMENT from parse tree.
501 Remove element from the parse tree by side-effect, and return it
502 with its `:parent' property stripped out."
507 parent secondary
510 parent
512 ;; Return ELEMENT with its :parent removed.
516 "Insert ELEMENT before LOCATION in parse tree.
517 LOCATION is an element, object or string within the parse tree.
518 Parse tree is modified by side effect."
523 ;; Special case: LOCATION is the first element of an
524 ;; independent secondary string (e.g. :title property). Add
525 ;; ELEMENT in-place.
529 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
539 ;; Store SIBLINGS at appropriate place in parse tree.
544 ;; Set appropriate :parent property.
548 "Replace element or object OLD with element or object NEW.
549 The function takes care of setting `:parent' property for NEW."
550 ;; Ensure OLD and NEW have the same parent.
554 ;; We cannot replace OLD with NEW since one of them is not an
555 ;; object or element. We take the long path.
558 ;; Since OLD is going to be changed into NEW by side-effect, first
559 ;; make sure that every element or object within NEW has OLD as
560 ;; parent.
563 ;; Transfer contents.
565 ;; Overwrite OLD's properties with NEW's.
567 ;; Transfer type.
571 \f
572 ;;; Greater elements
573 ;;
574 ;; For each greater element type, we define a parser and an
575 ;; interpreter.
576 ;;
577 ;; A parser returns the element or object as the list described above.
578 ;; Most of them accepts no argument. Though, exceptions exist. Hence
579 ;; every element containing a secondary string (see
580 ;; `org-element-secondary-value-alist') will accept an optional
581 ;; argument to toggle parsing of that secondary string. Moreover,
582 ;; `item' parser requires current list's structure as its first
583 ;; element.
584 ;;
585 ;; An interpreter accepts two arguments: the list representation of
586 ;; the element or object, and its contents. The latter may be nil,
587 ;; depending on the element or object considered. It returns the
588 ;; appropriate Org syntax, as a string.
589 ;;
590 ;; Parsing functions must follow the naming convention:
591 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
592 ;; defined in `org-element-greater-elements'.
593 ;;
594 ;; Similarly, interpreting functions must follow the naming
595 ;; convention: org-element-TYPE-interpreter.
596 ;;
597 ;; With the exception of `headline' and `item' types, greater elements
598 ;; cannot contain other greater elements of their own type.
599 ;;
600 ;; Beside implementing a parser and an interpreter, adding a new
601 ;; greater element requires to tweak `org-element--current-element'.
602 ;; Moreover, the newly defined type must be added to both
603 ;; `org-element-all-elements' and `org-element-greater-elements'.
606 ;;;; Center Block
609 "Parse a center block.
611 LIMIT bounds the search. AFFILIATED is a list of which CAR is
612 the buffer position at the beginning of the first affiliated
613 keyword and CDR is a plist of affiliated keywords along with
614 their value.
616 Return a list whose CAR is `center-block' and CDR is a plist
617 containing `:begin', `:end', `:contents-begin', `:contents-end',
618 `:post-blank' and `:post-affiliated' keywords.
620 Assume point is at the beginning of the block."
624 ;; Incomplete block: parse it as a paragraph.
629 ;; Empty blocks have no contents.
643 :end end
644 :contents-begin contents-begin
645 :contents-end contents-end
651 "Interpret CENTER-BLOCK element as Org syntax.
652 CONTENTS is the contents of the element."
656 ;;;; Drawer
659 "Parse a drawer.
661 LIMIT bounds the search. AFFILIATED is a list of which CAR is
662 the buffer position at the beginning of the first affiliated
663 keyword and CDR is a plist of affiliated keywords along with
664 their value.
666 Return a list whose CAR is `drawer' and CDR is a plist containing
667 `:drawer-name', `:begin', `:end', `:contents-begin',
668 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
670 Assume point is at beginning of drawer."
673 ;; Incomplete drawer: parse it as a paragraph.
681 ;; Empty drawers have no contents.
694 :end end
695 :drawer-name name
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret DRAWER element as Org syntax.
704 CONTENTS is the contents of the element."
707 contents))
710 ;;;; Dynamic Block
713 "Parse a dynamic block.
715 LIMIT bounds the search. AFFILIATED is a list of which CAR is
716 the buffer position at the beginning of the first affiliated
717 keyword and CDR is a plist of affiliated keywords along with
718 their value.
720 Return a list whose CAR is `dynamic-block' and CDR is a plist
721 containing `:block-name', `:begin', `:end', `:contents-begin',
722 `:contents-end', `:arguments', `:post-blank' and
723 `:post-affiliated' keywords.
725 Assume point is at beginning of dynamic block."
729 ;; Incomplete block: parse it as a paragraph.
738 ;; Empty blocks have no contents.
751 :end end
752 :block-name name
753 :arguments arguments
754 :contents-begin contents-begin
755 :contents-end contents-end
761 "Interpret DYNAMIC-BLOCK element as Org syntax.
762 CONTENTS is the contents of the element."
767 contents))
770 ;;;; Footnote Definition
773 "Parse a footnote definition.
775 LIMIT bounds the search. AFFILIATED is a list of which CAR is
776 the buffer position at the beginning of the first affiliated
777 keyword and CDR is a plist of affiliated keywords along with
778 their value.
780 Return a list whose CAR is `footnote-definition' and CDR is
781 a plist containing `:label', `:begin' `:end', `:contents-begin',
782 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
784 Assume point is at the beginning of the footnote definition."
812 :begin begin
813 :end end
814 :contents-begin contents-begin
815 :contents-end contents-end
821 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
822 CONTENTS is the contents of the footnote-definition."
824 " "
825 contents))
828 ;;;; Headline
831 "Return node properties associated to headline at point.
832 Upcase property names. It avoids confusion between properties
833 obtained through property drawer and default properties from the
834 parser (e.g. `:end' and :END:). Return value is a plist."
846 properties))))
849 "Return time properties associated to headline at point.
850 Return value is a plist."
864 plist))))
867 "Parse a headline.
869 Return a list whose CAR is `headline' and CDR is a plist
870 containing `:raw-value', `:title', `:alt-title', `:begin',
871 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
872 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
873 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
874 `:footnote-section-p', `:post-blank' and `:post-affiliated'
875 keywords.
877 The plist also contains any property set in the property drawer,
878 with its name in upper cases and colons added at the
879 beginning (e.g., `:CUSTOM_ID').
881 LIMIT is a buffer position bounding the search.
883 When RAW-SECONDARY-P is non-nil, headline's title will not be
884 parsed as a secondary string, but as a plain string instead.
886 Assume point is at beginning of the headline."
929 ;; Clean TAGS from archive tag, if any.
935 :begin begin
936 :end end
937 :pre-blank
940 :contents-begin contents-begin
941 :contents-end contents-end
942 :level level
943 :priority priority
944 :tags tags
945 :todo-keyword todo
946 :todo-type todo-type
949 end)
950 :footnote-section-p footnote-section-p
951 :archivedp archivedp
952 :commentedp commentedp
954 time-props
955 standard-props))))
959 headline :alt-title
964 headline :title
973 nil
979 "Interpret HEADLINE element as Org syntax.
980 CONTENTS is the contents of the element."
996 ?*)
1000 " "
1003 org-footnote-section
1004 title))))
1006 heading
1007 ;; Align tags.
1015 ?\s)
1016 tags))
1020 tags))))
1022 contents)))
1025 ;;;; Inlinetask
1028 "Parse an inline task.
1030 Return a list whose CAR is `inlinetask' and CDR is a plist
1031 containing `:title', `:begin', `:end', `:contents-begin' and
1032 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1033 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1034 `:closed', `:post-blank' and `:post-affiliated' keywords.
1036 The plist also contains any property set in the property drawer,
1037 with its name in upper cases and colons added at the
1038 beginning (e.g., `:CUSTOM_ID').
1040 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1041 title will not be parsed as a secondary string, but as a plain
1042 string instead.
1044 Assume point is at beginning of the inline task."
1089 :begin begin
1090 :end end
1091 :contents-begin contents-begin
1092 :contents-end contents-end
1093 :level level
1094 :priority priority
1095 :tags tags
1096 :todo-keyword todo
1097 :todo-type todo-type
1100 time-props
1101 standard-props))))
1103 inlinetask :title
1112 nil
1118 "Interpret INLINETASK element as Org syntax.
1119 CONTENTS is the contents of inlinetask."
1133 ;; Align tags.
1141 ? )
1142 tags))
1146 tags))))
1147 ;; Prefer degenerate inlinetasks when there are no
1148 ;; contents.
1151 contents
1155 ;;;; Item
1158 "Parse an item.
1160 STRUCT is the structure of the plain list.
1162 Return a list whose CAR is `item' and CDR is a plist containing
1163 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1164 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1165 `:post-affiliated' keywords.
1167 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1168 any, will not be parsed as a secondary string, but as a plain
1169 string instead.
1171 Assume point is at the beginning of the item."
1195 ;; Ignore tags in un-ordered lists: they are just
1196 ;; a part of item's body.
1202 ;; If first line isn't empty, contents really start
1203 ;; at the text after item's meta-data.
1212 :begin begin
1213 :end end
1214 ;; CONTENTS-BEGIN and CONTENTS-END may be
1215 ;; mixed up in the case of an empty item
1216 ;; separated from the next by a blank line.
1217 ;; Thus ensure the former is always the
1218 ;; smallest.
1221 :checkbox checkbox
1222 :counter counter
1223 :structure struct
1227 item :tag
1238 "Interpret ITEM element as Org syntax.
1239 CONTENTS is the contents of the element."
1249 ;; Compute indentation.
1254 ;; Indent contents.
1256 bullet
1270 ;;;; Plain List
1273 ;; Return structure of list at point. Internal function. See
1274 ;; `org-list-struct' for details.
1279 items struct)
1284 ;; At limit: end all items.
1293 ;; At list end: end all items.
1298 ;; At a new item: end previous sibling.
1310 ind
1311 bullet
1314 ;; Description tag.
1318 ;; Ending position, unknown so far.
1319 nil)))
1320 items))
1322 ;; Skip empty lines.
1324 ;; Skip inline tasks and blank lines along the way.
1331 ;; At some text line. Check if it ends any previous item.
1343 ;; Skip blocks (any type) and drawers contents.
1348 limit t)))
1354 "Parse a plain list.
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. STRUCTURE is the structure of the plain list being
1360 parsed.
1362 Return a list whose CAR is `plain-list' and CDR is a plist
1363 containing `:type', `:begin', `:end', `:contents-begin' and
1364 `:contents-end', `:structure', `:post-blank' and
1365 `:post-affiliated' keywords.
1367 Assume point is at the beginning of the list."
1381 pos))
1385 ;; Return value.
1389 :begin begin
1390 :end end
1391 :contents-begin contents-begin
1392 :contents-end contents-end
1393 :structure struct
1399 "Interpret PLAIN-LIST element as Org syntax.
1400 CONTENTS is the contents of the element."
1408 ;;;; Property Drawer
1411 "Parse a property drawer.
1413 LIMIT bounds the search.
1415 Return a list whose car is `property-drawer' and cdr is a plist
1416 containing `:begin', `:end', `:contents-begin', `:contents-end',
1417 `:post-blank' and `:post-affiliated' keywords.
1419 Assume point is at the beginning of the property drawer."
1432 :end end
1434 :contents-end contents-end
1439 "Interpret PROPERTY-DRAWER element as Org syntax.
1440 CONTENTS is the properties within the drawer."
1444 ;;;; Quote Block
1447 "Parse a quote block.
1449 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1450 the buffer position at the beginning of the first affiliated
1451 keyword and CDR is a plist of affiliated keywords along with
1452 their value.
1454 Return a list whose CAR is `quote-block' and CDR is a plist
1455 containing `:begin', `:end', `:contents-begin', `:contents-end',
1456 `:post-blank' and `:post-affiliated' keywords.
1458 Assume point is at the beginning of the block."
1462 ;; Incomplete block: parse it as a paragraph.
1468 ;; Empty blocks have no contents.
1481 :end end
1482 :contents-begin contents-begin
1483 :contents-end contents-end
1489 "Interpret QUOTE-BLOCK element as Org syntax.
1490 CONTENTS is the contents of the element."
1494 ;;;; Section
1497 "Parse a section.
1499 LIMIT bounds the search.
1501 Return a list whose CAR is `section' and CDR is a plist
1502 containing `:begin', `:end', `:contents-begin', `contents-end',
1503 `:post-blank' and `:post-affiliated' keywords."
1505 ;; Beginning of section is the beginning of the first non-blank
1506 ;; line after previous headline.
1515 :end end
1516 :contents-begin begin
1517 :contents-end pos-before-blank
1522 "Interpret SECTION element as Org syntax.
1523 CONTENTS is the contents of the element."
1524 contents)
1527 ;;;; Special Block
1530 "Parse a special block.
1532 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1533 the buffer position at the beginning of the first affiliated
1534 keyword and CDR is a plist of affiliated keywords along with
1535 their value.
1537 Return a list whose CAR is `special-block' and CDR is a plist
1538 containing `:type', `:begin', `:end', `:contents-begin',
1539 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1541 Assume point is at the beginning of the block."
1548 limit t)))
1549 ;; Incomplete block: parse it as a paragraph.
1555 ;; Empty blocks have no contents.
1568 :begin begin
1569 :end end
1570 :contents-begin contents-begin
1571 :contents-end contents-end
1577 "Interpret SPECIAL-BLOCK element as Org syntax.
1578 CONTENTS is the contents of the element."
1583 \f
1584 ;;; Elements
1585 ;;
1586 ;; For each element, a parser and an interpreter are also defined.
1587 ;; Both follow the same naming convention used for greater elements.
1588 ;;
1589 ;; Also, as for greater elements, adding a new element type is done
1590 ;; through the following steps: implement a parser and an interpreter,
1591 ;; tweak `org-element--current-element' so that it recognizes the new
1592 ;; type and add that new type to `org-element-all-elements'.
1593 ;;
1594 ;; As a special case, when the newly defined type is a block type,
1595 ;; `org-element-block-name-alist' has to be modified accordingly.
1598 ;;;; Babel Call
1601 "Parse a babel call.
1603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1604 the buffer position at the beginning of the first affiliated
1605 keyword and CDR is a plist of affiliated keywords along with
1606 their value.
1608 Return a list whose CAR is `babel-call' and CDR is a plist
1609 containing `:begin', `:end', `:value', `:post-blank' and
1610 `:post-affiliated' as keywords."
1624 :end end
1625 :value value
1631 "Interpret BABEL-CALL element as Org syntax.
1632 CONTENTS is nil."
1636 ;;;; Clock
1639 "Parse a clock.
1641 LIMIT bounds the search.
1643 Return a list whose CAR is `clock' and CDR is a plist containing
1644 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1645 `:post-affiliated' as keywords."
1665 :value value
1666 :duration duration
1667 :begin begin
1668 :end end
1669 :post-blank post-blank
1673 "Interpret CLOCK element as Org syntax.
1674 CONTENTS is nil."
1682 "%2s:%02s"
1686 ;;;; Comment
1689 "Parse a comment.
1691 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1692 the buffer position at the beginning of the first affiliated
1693 keyword and CDR is a plist of affiliated keywords along with
1694 their value.
1696 Return a list whose CAR is `comment' and CDR is a plist
1697 containing `:begin', `:end', `:value', `:post-blank',
1698 `:post-affiliated' keywords.
1700 Assume point is at comment beginning."
1709 ;; Get comments ending.
1712 ;; Accumulate lines without leading hash and first
1713 ;; whitespace.
1727 :end end
1728 :value value
1734 "Interpret COMMENT element as Org syntax.
1735 CONTENTS is nil."
1739 ;;;; Comment Block
1742 "Parse an export block.
1744 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1745 the buffer position at the beginning of the first affiliated
1746 keyword and CDR is a plist of affiliated keywords along with
1747 their value.
1749 Return a list whose CAR is `comment-block' and CDR is a plist
1750 containing `:begin', `:end', `:value', `:post-blank' and
1751 `:post-affiliated' keywords.
1753 Assume point is at comment block beginning."
1757 ;; Incomplete block: parse it as a paragraph.
1770 contents-begin contents-end)))
1774 :end end
1775 :value value
1781 "Interpret COMMENT-BLOCK element as Org syntax.
1782 CONTENTS is nil."
1789 ;;;; Diary Sexp
1792 "Parse a diary sexp.
1794 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1795 the buffer position at the beginning of the first affiliated
1796 keyword and CDR is a plist of affiliated keywords along with
1797 their value.
1799 Return a list whose CAR is `diary-sexp' and CDR is a plist
1800 containing `:begin', `:end', `:value', `:post-blank' and
1801 `:post-affiliated' keywords."
1813 :begin begin
1814 :end end
1820 "Interpret DIARY-SEXP as Org syntax.
1821 CONTENTS is nil."
1825 ;;;; Example Block
1828 "Parse an example block.
1830 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1831 the buffer position at the beginning of the first affiliated
1832 keyword and CDR is a plist of affiliated keywords along with
1833 their value.
1835 Return a list whose CAR is `example-block' and CDR is a plist
1836 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1837 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1838 `:value', `:post-blank' and `:post-affiliated' keywords."
1842 ;; Incomplete block: parse it as a paragraph.
1850 ;; Switches analysis
1857 ;; Should labels be retained in (or stripped from) example
1858 ;; blocks?
1863 ;; What should code-references use - labels or
1864 ;; line-numbers?
1873 ;; Standard block parsing.
1881 contents-begin contents-end))
1882 block-ind))
1891 :end end
1892 :value value
1893 :switches switches
1894 :number-lines number-lines
1895 :preserve-indent preserve-indent
1896 :retain-labels retain-labels
1897 :use-labels use-labels
1898 :label-fmt label-fmt
1904 "Interpret EXAMPLE-BLOCK element as Org syntax.
1905 CONTENTS is nil."
1913 value
1918 ;;;; Export Block
1921 "Parse an export block.
1923 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1924 the buffer position at the beginning of the first affiliated
1925 keyword and CDR is a plist of affiliated keywords along with
1926 their value.
1928 Return a list whose CAR is `export-block' and CDR is a plist
1929 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1930 `:post-affiliated' keywords.
1932 Assume point is at export-block beginning."
1939 ;; Incomplete block: parse it as a paragraph.
1952 contents-end)))
1956 :end end
1957 :type type
1958 :value value
1964 "Interpret EXPORT-BLOCK element as Org syntax.
1965 CONTENTS is nil."
1972 ;;;; Fixed-width
1975 "Parse a fixed-width section.
1977 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1978 the buffer position at the beginning of the first affiliated
1979 keyword and CDR is a plist of affiliated keywords along with
1980 their value.
1982 Return a list whose CAR is `fixed-width' and CDR is a plist
1983 containing `:begin', `:end', `:value', `:post-blank' and
1984 `:post-affiliated' keywords.
1986 Assume point is at the beginning of the fixed-width area."
1990 value
1995 ;; Accumulate text without starting colons.
2008 :end end
2009 :value value
2015 "Interpret FIXED-WIDTH element as Org syntax.
2016 CONTENTS is nil."
2024 ;;;; Horizontal Rule
2027 "Parse an horizontal rule.
2029 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2030 the buffer position at the beginning of the first affiliated
2031 keyword and CDR is a plist of affiliated keywords along with
2032 their value.
2034 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2035 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2036 keywords."
2046 :end end
2052 "Interpret HORIZONTAL-RULE element as Org syntax.
2053 CONTENTS is nil."
2057 ;;;; Keyword
2060 "Parse a keyword at point.
2062 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2063 the buffer position at the beginning of the first affiliated
2064 keyword and CDR is a plist of affiliated keywords along with
2065 their value.
2067 Return a list whose CAR is `keyword' and CDR is a plist
2068 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2069 `:post-affiliated' keywords."
2071 ;; An orphaned affiliated keyword is considered as a regular
2072 ;; keyword. In this case AFFILIATED is nil, so we take care of
2073 ;; this corner case.
2086 :value value
2087 :begin begin
2088 :end end
2094 "Interpret KEYWORD element as Org syntax.
2095 CONTENTS is nil."
2101 ;;;; Latex Environment
2105 "Regexp matching the beginning of a LaTeX environment.
2106 The environment is captured by the first group.
2112 "Format string matching the ending of a LaTeX environment.
2116 "Parse a LaTeX environment.
2118 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2119 the buffer position at the beginning of the first affiliated
2120 keyword and CDR is a plist of affiliated keywords along with
2121 their value.
2123 Return a list whose CAR is `latex-environment' and CDR is a plist
2124 containing `:begin', `:end', `:value', `:post-blank' and
2125 `:post-affiliated' keywords.
2127 Assume point is at the beginning of the latex environment."
2134 limit t))
2135 ;; Incomplete latex environment: parse it as a paragraph.
2145 :end end
2146 :value value
2152 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2153 CONTENTS is nil."
2157 ;;;; Node Property
2160 "Parse a node-property at point.
2162 LIMIT bounds the search.
2164 Return a list whose CAR is `node-property' and CDR is a plist
2165 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2166 `:post-affiliated' keywords."
2176 limit))))
2179 :value value
2180 :begin begin
2181 :end end
2186 "Interpret NODE-PROPERTY element as Org syntax.
2187 CONTENTS is nil."
2193 ;;;; Paragraph
2196 "Parse a paragraph.
2198 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2199 the buffer position at the beginning of the first affiliated
2200 keyword and CDR is a plist of affiliated keywords along with
2201 their value.
2203 Return a list whose CAR is `paragraph' and CDR is a plist
2204 containing `:begin', `:end', `:contents-begin' and
2205 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2207 Assume point is at the beginning of the paragraph."
2216 limit
2217 ;; A matching `org-element-paragraph-separate' is not
2218 ;; necessarily the end of the paragraph. In
2219 ;; particular, lines starting with # or : as a first
2220 ;; non-space character are ambiguous. We have to
2221 ;; check if they are valid Org syntax (e.g., not an
2222 ;; incomplete keyword).
2226 ;; There's no ambiguity for other symbols or
2227 ;; empty lines: stop here.
2229 ;; Stop at valid fixed-width areas.
2231 ;; Stop at drawers.
2236 ;; Stop at valid comments.
2238 ;; Stop at valid dynamic blocks.
2243 ;; Stop at valid blocks.
2250 limit t)))
2251 ;; Stop at valid latex environments.
2258 limit t)))
2259 ;; Stop at valid keywords.
2261 ;; Skip everything else.
2278 :end end
2279 :contents-begin contents-begin
2280 :contents-end contents-end
2286 "Interpret PARAGRAPH element as Org syntax.
2287 CONTENTS is the contents of the element."
2288 contents)
2291 ;;;; Planning
2294 "Parse a planning.
2296 LIMIT bounds the search.
2298 Return a list whose CAR is `planning' and CDR is a plist
2299 containing `:closed', `:deadline', `:scheduled', `:begin',
2300 `:end', `:post-blank' and `:post-affiliated' keywords."
2310 closed deadline scheduled)
2322 :deadline deadline
2323 :scheduled scheduled
2324 :begin begin
2325 :end end
2326 :post-blank post-blank
2330 "Interpret PLANNING element as Org syntax.
2331 CONTENTS is nil."
2333 'identity
2350 ;;;; Src Block
2353 "Parse a src block.
2355 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2356 the buffer position at the beginning of the first affiliated
2357 keyword and CDR is a plist of affiliated keywords along with
2358 their value.
2360 Return a list whose CAR is `src-block' and CDR is a plist
2361 containing `:language', `:switches', `:parameters', `:begin',
2362 `:end', `:number-lines', `:retain-labels', `:use-labels',
2363 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2364 `:post-affiliated' keywords.
2366 Assume point is at the beginning of the block."
2369 limit t)))
2370 ;; Incomplete block: parse it as a paragraph.
2376 ;; Get language as a string.
2385 ;; Get switches.
2387 ;; Get parameters.
2389 ;; Switches analysis
2400 ;; Should labels be retained in (or stripped from)
2401 ;; src blocks?
2406 ;; What should code-references use - labels or
2407 ;; line-numbers?
2412 ;; Indentation.
2414 ;; Retrieve code.
2419 block-ind))
2423 ;; Get position after ending blank lines.
2433 :begin begin
2434 :end end
2435 :number-lines number-lines
2436 :preserve-indent preserve-indent
2437 :retain-labels retain-labels
2438 :use-labels use-labels
2439 :label-fmt label-fmt
2440 :value value
2446 "Interpret SRC-BLOCK element as Org syntax.
2447 CONTENTS is nil."
2456 val)
2470 ;;;; Table
2473 "Parse a table at point.
2475 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2476 the buffer position at the beginning of the first affiliated
2477 keyword and CDR is a plist of affiliated keywords along with
2478 their value.
2480 Return a list whose CAR is `table' and CDR is a plist containing
2481 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2482 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2483 keywords.
2485 Assume point is at the beginning of the table."
2499 acc))
2506 :end end
2507 :type type
2508 :tblfm tblfm
2509 ;; Only `org' tables have contents. `table.el' tables
2510 ;; use a `:value' property to store raw table as
2511 ;; a string.
2516 table-begin table-end))
2522 "Interpret TABLE element as Org syntax.
2523 CONTENTS is a string, if table's type is `org', or nil."
2534 ;;;; Table Row
2537 "Parse table row at point.
2539 LIMIT bounds the search.
2541 Return a list whose CAR is `table-row' and CDR is a plist
2542 containing `:begin', `:end', `:contents-begin', `:contents-end',
2543 `:type', `:post-blank' and `:post-affiliated' keywords."
2547 ;; A table rule has no contents. In that case, ensure
2548 ;; CONTENTS-BEGIN matches CONTENTS-END.
2560 :begin begin
2561 :end end
2562 :contents-begin contents-begin
2563 :contents-end contents-end
2568 "Interpret TABLE-ROW element as Org syntax.
2569 CONTENTS is the contents of the table row."
2574 ;;;; Verse Block
2577 "Parse a verse block.
2579 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2580 the buffer position at the beginning of the first affiliated
2581 keyword and CDR is a plist of affiliated keywords along with
2582 their value.
2584 Return a list whose CAR is `verse-block' and CDR is a plist
2585 containing `:begin', `:end', `:contents-begin', `:contents-end',
2586 `:post-blank' and `:post-affiliated' keywords.
2588 Assume point is at beginning of the block."
2592 ;; Incomplete block: parse it as a paragraph.
2607 :end end
2608 :contents-begin contents-begin
2609 :contents-end contents-end
2615 "Interpret VERSE-BLOCK element as Org syntax.
2616 CONTENTS is verse block contents."
2620 \f
2621 ;;; Objects
2622 ;;
2623 ;; Unlike to elements, raw text can be found between objects. Hence,
2624 ;; `org-element--object-lex' is provided to find the next object in
2625 ;; buffer.
2626 ;;
2627 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2628 ;; object types they can contain will be specified in
2629 ;; `org-element-object-restrictions'.
2630 ;;
2631 ;; Creating a new type of object requires to alter
2632 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2633 ;; new type in `org-element-all-objects', and possibly add
2634 ;; restrictions in `org-element-object-restrictions'.
2636 ;;;; Bold
2639 "Parse bold object at point, if any.
2641 When at a bold object, return a list whose car is `bold' and cdr
2642 is a plist with `:begin', `:end', `:contents-begin' and
2643 `:contents-end' and `:post-blank' keywords. Otherwise, return
2644 nil.
2646 Assume point is at the first star marker."
2658 :end end
2659 :contents-begin contents-begin
2660 :contents-end contents-end
2664 "Interpret BOLD object as Org syntax.
2665 CONTENTS is the contents of the object."
2669 ;;;; Code
2672 "Parse code object at point, if any.
2674 When at a code object, return a list whose car is `code' and cdr
2675 is a plist with `:value', `:begin', `:end' and `:post-blank'
2676 keywords. Otherwise, return nil.
2678 Assume point is at the first tilde marker."
2689 :begin begin
2690 :end end
2694 "Interpret CODE object as Org syntax.
2695 CONTENTS is nil."
2699 ;;;; Entity
2702 "Parse entity at point, if any.
2704 When at an entity, return a list whose car is `entity' and cdr
2705 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2706 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2707 `:post-blank' as keywords. Otherwise, return nil.
2709 Assume point is at the beginning of the entity."
2711 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2729 :begin begin
2730 :end end
2731 :use-brackets-p bracketsp
2735 "Interpret ENTITY object as Org syntax.
2736 CONTENTS is nil."
2742 ;;;; Export Snippet
2745 "Parse export snippet at point.
2747 When at an export snippet, return a list whose car is
2748 `export-snippet' and cdr a plist with `:begin', `:end',
2749 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2750 return nil.
2752 Assume point is at the beginning of the snippet."
2768 :value value
2769 :begin begin
2770 :end end
2774 "Interpret EXPORT-SNIPPET object as Org syntax.
2775 CONTENTS is nil."
2781 ;;;; Footnote Reference
2784 "Parse footnote reference at point, if any.
2786 When at a footnote reference, return a list whose car is
2787 `footnote-reference' and cdr a plist with `:label', `:type',
2788 `:begin', `:end', `:content-begin', `:contents-end' and
2789 `:post-blank' as keywords. Otherwise, return nil."
2813 :type type
2814 :begin begin
2815 :end end
2821 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2822 CONTENTS is its definition, when inline, or nil."
2828 ;;;; Inline Babel Call
2831 "Parse inline babel call at point, if any.
2833 When at an inline babel call, return a list whose car is
2834 `inline-babel-call' and cdr a plist with `:begin', `:end',
2835 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2837 Assume point is at the beginning of the babel call."
2849 :end end
2850 :value value
2854 "Interpret INLINE-BABEL-CALL object as Org syntax.
2855 CONTENTS is nil."
2859 ;;;; Inline Src Block
2862 "Parse inline source block at point, if any.
2864 When at an inline source block, return a list whose car is
2865 `inline-src-block' and cdr a plist with `:begin', `:end',
2866 `:language', `:value', `:parameters' and `:post-blank' as
2867 keywords. Otherwise, return nil.
2869 Assume point is at the beginning of the inline src block."
2882 :value value
2883 :parameters parameters
2884 :begin begin
2885 :end end
2889 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2890 CONTENTS is nil."
2895 language
2897 body)))
2899 ;;;; Italic
2902 "Parse italic object at point, if any.
2904 When at an italic object, return a list whose car is `italic' and
2905 cdr is a plist with `:begin', `:end', `:contents-begin' and
2906 `:contents-end' and `:post-blank' keywords. Otherwise, return
2907 nil.
2909 Assume point is at the first slash marker."
2921 :end end
2922 :contents-begin contents-begin
2923 :contents-end contents-end
2927 "Interpret ITALIC object as Org syntax.
2928 CONTENTS is the contents of the object."
2932 ;;;; Latex Fragment
2935 "Parse LaTeX fragment at point, if any.
2937 When at a LaTeX fragment, return a list whose car is
2938 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2939 and `:post-blank' as keywords. Otherwise, return nil.
2941 Assume point is at the beginning of the LaTeX fragment."
2959 ;; Macro.
2968 :begin begin
2969 :end end
2973 "Interpret LATEX-FRAGMENT object as Org syntax.
2974 CONTENTS is nil."
2977 ;;;; Line Break
2980 "Parse line break at point, if any.
2982 When at a line break, return a list whose car is `line-break',
2983 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2984 Otherwise, return nil.
2986 Assume point is at the beginning of the line break."
2995 "Interpret LINE-BREAK object as Org syntax.
2996 CONTENTS is nil."
3000 ;;;; Link
3003 "Parse link at point, if any.
3005 When at a link, return a list whose car is `link' and cdr a plist
3006 with `:type', `:path', `:raw-link', `:application',
3007 `:search-option', `:begin', `:end', `:contents-begin',
3008 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3009 nil.
3011 Assume point is at the beginning of the link."
3014 end contents-begin contents-end link-end post-blank path type
3015 raw-link link search-option application)
3017 ;; Type 1: Text targeted from a radio target.
3026 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3031 ;; RAW-LINK is the original link. Expand any
3032 ;; abbreviation in it.
3036 ;; Determine TYPE of link and set PATH accordingly.
3038 ;; File type.
3042 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3045 ;; According to RFC 3986, extra whitespace should be
3046 ;; ignored when a URI is extracted.
3049 ;; Id type: PATH is the id.
3052 ;; Code-ref type: PATH is the name of the reference.
3055 ;; Custom-id type: PATH is the name of the custom id.
3058 ;; Fuzzy type: Internal link either matches a target, an
3059 ;; headline name or nothing. PATH is the target or
3060 ;; headline's name.
3062 ;; Type 3: Plain link, e.g., http://orgmode.org
3068 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3076 ;; In any case, deduce end point after trailing white space from
3077 ;; LINK-END variable.
3081 ;; Special "file" type link processing.
3083 ;; Extract opening application and search option.
3091 ;; Normalize URI.
3095 ;; Make sure TYPE always reports "file".
3099 :path path
3101 :application application
3102 :search-option search-option
3103 :begin begin
3104 :end end
3105 :contents-begin contents-begin
3106 :contents-end contents-end
3110 "Interpret LINK object as Org syntax.
3111 CONTENTS is the contents of the object, or nil."
3116 raw-link
3120 ;;;; Macro
3123 "Parse macro at point, if any.
3125 When at a macro, return a list whose car is `macro' and cdr
3126 a plist with `:key', `:args', `:begin', `:end', `:value' and
3127 `:post-blank' as keywords. Otherwise, return nil.
3129 Assume point is at the macro."
3142 :value value
3143 :args args
3144 :begin begin
3145 :end end
3149 "Interpret MACRO object as Org syntax.
3150 CONTENTS is nil."
3154 ;;;; Radio-target
3157 "Parse radio target at point, if any.
3159 When at a radio target, return a list whose car is `radio-target'
3160 and cdr a plist with `:begin', `:end', `:contents-begin',
3161 `:contents-end', `:value' and `:post-blank' as keywords.
3162 Otherwise, return nil.
3164 Assume point is at the radio target."
3176 :end end
3177 :contents-begin contents-begin
3178 :contents-end contents-end
3179 :post-blank post-blank
3183 "Interpret TARGET object as Org syntax.
3184 CONTENTS is the contents of the object."
3188 ;;;; Statistics Cookie
3191 "Parse statistics cookie at point, if any.
3193 When at a statistics cookie, return a list whose car is
3194 `statistics-cookie', and cdr a plist with `:begin', `:end',
3195 `:value' and `:post-blank' keywords. Otherwise, return nil.
3197 Assume point is at the beginning of the statistics-cookie."
3208 :end end
3209 :value value
3213 "Interpret STATISTICS-COOKIE object as Org syntax.
3214 CONTENTS is nil."
3218 ;;;; Strike-Through
3221 "Parse strike-through object at point, if any.
3223 When at a strike-through object, return a list whose car is
3224 `strike-through' and cdr is a plist with `:begin', `:end',
3225 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3226 Otherwise, return nil.
3228 Assume point is at the first plus sign marker."
3240 :end end
3241 :contents-begin contents-begin
3242 :contents-end contents-end
3246 "Interpret STRIKE-THROUGH object as Org syntax.
3247 CONTENTS is the contents of the object."
3251 ;;;; Subscript
3254 "Parse subscript at point, if any.
3256 When at a subscript object, return a list whose car is
3257 `subscript' and cdr a plist with `:begin', `:end',
3258 `:contents-begin', `:contents-end', `:use-brackets-p' and
3259 `:post-blank' as keywords. Otherwise, return nil.
3261 Assume point is at the underscore."
3275 :end end
3276 :use-brackets-p bracketsp
3277 :contents-begin contents-begin
3278 :contents-end contents-end
3282 "Interpret SUBSCRIPT object as Org syntax.
3283 CONTENTS is the contents of the object."
3286 contents))
3289 ;;;; Superscript
3292 "Parse superscript at point, if any.
3294 When at a superscript object, return a list whose car is
3295 `superscript' and cdr a plist with `:begin', `:end',
3296 `:contents-begin', `:contents-end', `:use-brackets-p' and
3297 `:post-blank' as keywords. Otherwise, return nil.
3299 Assume point is at the caret."
3313 :end end
3314 :use-brackets-p bracketsp
3315 :contents-begin contents-begin
3316 :contents-end contents-end
3320 "Interpret SUPERSCRIPT object as Org syntax.
3321 CONTENTS is the contents of the object."
3324 contents))
3327 ;;;; Table Cell
3330 "Parse table cell at point.
3331 Return a list whose car is `table-cell' and cdr is a plist
3332 containing `:begin', `:end', `:contents-begin', `:contents-end'
3333 and `:post-blank' keywords."
3341 :end end
3342 :contents-begin contents-begin
3343 :contents-end contents-end
3347 "Interpret TABLE-CELL element as Org syntax.
3348 CONTENTS is the contents of the cell, or nil."
3352 ;;;; Target
3355 "Parse target at point, if any.
3357 When at a target, return a list whose car is `target' and cdr
3358 a plist with `:begin', `:end', `:value' and `:post-blank' as
3359 keywords. Otherwise, return nil.
3361 Assume point is at the target."
3371 :end end
3372 :value value
3376 "Interpret TARGET object as Org syntax.
3377 CONTENTS is nil."
3381 ;;;; Timestamp
3392 "Parse time stamp at point, if any.
3394 When at a time stamp, return a list whose car is `timestamp', and
3395 cdr a plist with `:type', `:raw-value', `:year-start',
3396 `:month-start', `:day-start', `:hour-start', `:minute-start',
3397 `:year-end', `:month-end', `:day-end', `:hour-end',
3398 `:minute-end', `:repeater-type', `:repeater-value',
3399 `:repeater-unit', `:warning-type', `:warning-value',
3400 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3401 Otherwise, return nil.
3403 Assume point is at the beginning of the timestamp."
3422 date-start)
3433 raw-value)
3435 :repeater-type
3441 :repeater-unit
3450 :warning-unit
3453 year-start month-start day-start hour-start minute-start year-end
3454 month-end day-end hour-end minute-end)
3455 ;; Parse date-start.
3463 ;; Compute date-end. It can be provided directly in time-stamp,
3464 ;; or extracted from time range. Otherwise, it defaults to the
3465 ;; same values as date-start.
3475 :raw-value raw-value
3476 :year-start year-start
3477 :month-start month-start
3478 :day-start day-start
3479 :hour-start hour-start
3480 :minute-start minute-start
3481 :year-end year-end
3482 :month-end month-end
3483 :day-end day-end
3484 :hour-end hour-end
3485 :minute-end minute-end
3486 :begin begin
3487 :end end
3489 repeater-props
3490 warning-props))))))
3493 "Interpret TIMESTAMP object as Org syntax.
3494 CONTENTS is nil."
3513 ;; Build an Org timestamp string from TIME. ACTIVEP is
3514 ;; non-nil when time stamp is active. If WITH-TIME-P is
3515 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3516 ;; specify a time range in the timestamp. REPEAT-STRING is
3517 ;; the repeater string, if any.
3521 org-time-stamp-formats)
3522 time)))
3528 nil nil ts)))
3533 " "
3534 s
3536 ;; Return value.
3537 ts)))
3549 build-ts-string
3568 0
3576 "--"
3589 ;;;; Underline
3592 "Parse underline object at point, if any.
3594 When at an underline object, return a list whose car is
3595 `underline' and cdr is a plist with `:begin', `:end',
3596 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3597 Otherwise, return nil.
3599 Assume point is at the first underscore marker."
3611 :end end
3612 :contents-begin contents-begin
3613 :contents-end contents-end
3617 "Interpret UNDERLINE object as Org syntax.
3618 CONTENTS is the contents of the object."
3622 ;;;; Verbatim
3625 "Parse verbatim object at point, if any.
3627 When at a verbatim object, return a list whose car is `verbatim'
3628 and cdr is a plist with `:value', `:begin', `:end' and
3629 `:post-blank' keywords. Otherwise, return nil.
3631 Assume point is at the first equal sign marker."
3642 :begin begin
3643 :end end
3647 "Interpret VERBATIM object as Org syntax.
3648 CONTENTS is nil."
3652 \f
3653 ;;; Parsing Element Starting At Point
3654 ;;
3655 ;; `org-element--current-element' is the core function of this section.
3656 ;; It returns the Lisp representation of the element starting at
3657 ;; point.
3658 ;;
3659 ;; `org-element--current-element' makes use of special modes. They
3660 ;; are activated for fixed element chaining (e.g., `plain-list' >
3661 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3662 ;; `section'). Special modes are: `first-section', `item',
3663 ;; `node-property', `section' and `table-row'.
3666 "Parse the element starting at point.
3668 Return value is a list like (TYPE PROPS) where TYPE is the type
3669 of the element and PROPS a plist of properties associated to the
3670 element.
3672 Possible types are defined in `org-element-all-elements'.
3674 LIMIT bounds the search.
3676 Optional argument GRANULARITY determines the depth of the
3677 recursion. Allowed values are `headline', `greater-element',
3678 `element', `object' or nil. When it is broader than `object' (or
3679 nil), secondary values will not be parsed, since they only
3680 contain objects.
3682 Optional argument MODE, when non-nil, can be either
3683 `first-section', `section', `planning', `item', `node-property'
3684 and `table-row'.
3686 If STRUCTURE isn't provided but MODE is set to `item', it will be
3687 computed.
3689 This function assumes point is always at the beginning of the
3690 element it has to parse."
3693 ;; Determine if parsing depth allows for secondary strings
3694 ;; parsing. It only applies to elements referenced in
3695 ;; `org-element-secondary-value-alist'.
3698 ;; Item.
3701 ;; Table Row.
3703 ;; Node Property.
3705 ;; Headline.
3708 ;; Sections (must be checked after headline).
3713 limit)))
3714 ;; Planning.
3717 ;; Property drawer.
3721 ;; When not at bol, point is at the beginning of an item or
3722 ;; a footnote definition: next item is always a paragraph.
3724 ;; Clock.
3726 ;; Inlinetask.
3729 ;; From there, elements can have affiliated keywords.
3732 ;; Jumping over affiliated keywords put point off-limits.
3733 ;; Parse them as regular keywords.
3737 ;; LaTeX Environment.
3740 ;; Drawer and Property Drawer.
3743 ;; Fixed Width
3746 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3747 ;; Keywords.
3756 org-element-block-name-alist)))
3771 ;; Footnote Definition.
3774 ;; Horizontal Rule.
3777 ;; Diary Sexp.
3780 ;; Table.
3782 ;; List.
3785 limit affiliated
3787 ;; Default element: Paragraph.
3791 ;; Most elements can have affiliated keywords. When looking for an
3792 ;; element beginning, we want to move before them, as they belong to
3793 ;; that element, and, in the meantime, collect information they give
3794 ;; into appropriate properties. Hence the following function.
3797 "Collect affiliated keywords from point down to LIMIT.
3799 Return a list whose CAR is the position at the first of them and
3800 CDR a plist of keywords and values and move point to the
3801 beginning of the first line after them.
3803 As a special case, if element doesn't start at the beginning of
3804 the line (e.g., a paragraph starting an item), CAR is current
3805 position of point and CDR is nil."
3809 ;; RESTRICT is the list of objects allowed in parsed
3810 ;; keywords value.
3812 output)
3815 ;; Apply translation to RAW-KWD. From there, KWD is
3816 ;; the official keyword.
3818 org-element-keyword-translation-alist))
3819 raw-kwd))
3820 ;; Find main value for any keyword.
3826 ;; PARSEDP is non-nil when keyword should have its
3827 ;; value parsed.
3829 ;; If KWD is a dual keyword, find its secondary
3830 ;; value. Maybe parse it.
3838 ;; Attribute a property name to KWD.
3840 ;; Now set final shape for VALUE.
3846 nil restrict)))
3850 ;; Attributes can always appear on multiple lines.
3853 ;; Eventually store the new value in OUTPUT.
3855 ;; Move to next keyword.
3857 ;; If affiliated keywords are orphaned: move back to first one.
3858 ;; They will be parsed as a paragraph.
3860 ;; Return value.
3864 \f
3865 ;;; The Org Parser
3866 ;;
3867 ;; The two major functions here are `org-element-parse-buffer', which
3868 ;; parses Org syntax inside the current buffer, taking into account
3869 ;; region, narrowing, or even visibility if specified, and
3870 ;; `org-element-parse-secondary-string', which parses objects within
3871 ;; a given string.
3872 ;;
3873 ;; The (almost) almighty `org-element-map' allows to apply a function
3874 ;; on elements or objects matching some type, and accumulate the
3875 ;; resulting values. In an export situation, it also skips unneeded
3876 ;; parts of the parse tree.
3879 "Recursively parse the buffer and return structure.
3880 If narrowing is in effect, only parse the visible part of the
3881 buffer.
3883 Optional argument GRANULARITY determines the depth of the
3884 recursion. It can be set to the following symbols:
3886 `headline' Only parse headlines.
3887 `greater-element' Don't recurse into greater elements excepted
3888 headlines and sections. Thus, elements
3889 parsed are the top-level ones.
3890 `element' Parse everything but objects and plain text.
3891 `object' Parse the complete buffer (default).
3893 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3894 elements.
3896 An element or an objects is represented as a list with the
3897 pattern (TYPE PROPERTIES CONTENTS), where :
3899 TYPE is a symbol describing the element or object. See
3900 `org-element-all-elements' and `org-element-all-objects' for an
3901 exhaustive list of such symbols. One can retrieve it with
3902 `org-element-type' function.
3904 PROPERTIES is the list of attributes attached to the element or
3905 object, as a plist. Although most of them are specific to the
3906 element or object type, all types share `:begin', `:end',
3907 `:post-blank' and `:parent' properties, which respectively
3908 refer to buffer position where the element or object starts,
3909 ends, the number of white spaces or blank lines after it, and
3910 the element or object containing it. Properties values can be
3911 obtained by using `org-element-property' function.
3913 CONTENTS is a list of elements, objects or raw strings
3914 contained in the current element or object, when applicable.
3915 One can access them with `org-element-contents' function.
3917 The Org buffer has `org-data' as type and nil as properties.
3918 `org-element-map' function can be used to find specific elements
3919 or objects within the parse tree.
3921 This function assumes that current major mode is `org-mode'."
3927 ;; Start in `first-section' mode so text before the first
3928 ;; headline belongs to a section.
3932 "Recursively parse objects in STRING and return structure.
3934 RESTRICTION is a symbol limiting the object types that will be
3935 looked after.
3937 Optional argument PARENT, when non-nil, is the element or object
3938 containing the secondary string. It is used to set correctly
3939 `:parent' property within the string."
3952 secondary))))
3956 "Map a function on selected elements or objects.
3958 DATA is a parse tree, an element, an object, a string, or a list
3959 of such constructs. TYPES is a symbol or list of symbols of
3960 elements or objects types (see `org-element-all-elements' and
3961 `org-element-all-objects' for a complete list of types). FUN is
3962 the function called on the matching element or object. It has to
3963 accept one argument: the element or object itself.
3965 When optional argument INFO is non-nil, it should be a plist
3966 holding export options. In that case, parts of the parse tree
3967 not exportable according to that property list will be skipped.
3969 When optional argument FIRST-MATCH is non-nil, stop at the first
3970 match for which FUN doesn't return nil, and return that value.
3972 Optional argument NO-RECURSION is a symbol or a list of symbols
3973 representing elements or objects types. `org-element-map' won't
3974 enter any recursive element or object whose type belongs to that
3975 list. Though, FUN can still be applied on them.
3977 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3978 apply to matching objects within parsed affiliated keywords (see
3979 `org-element-parsed-keywords').
3981 Nil values returned from FUN do not appear in the results.
3984 Examples:
3985 ---------
3987 Assuming TREE is a variable containing an Org buffer parse tree,
3988 the following example will return a flat list of all `src-block'
3989 and `example-block' elements in it:
3991 \(org-element-map tree '(example-block src-block) #'identity)
3993 The following snippet will find the first headline with a level
3996 \(org-element-map tree 'headline
3997 \(lambda (hl)
3998 \(and (= (org-element-property :level hl) 1)
4000 \(org-element-property :begin hl)))
4001 nil t)
4003 The next example will return a flat list of all `plain-list' type
4004 elements in TREE that are not a sub-list themselves:
4006 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4008 Eventually, this example will return a flat list of all `bold'
4009 type objects containing a `latex-snippet' type object, even
4010 looking into captions:
4012 \(org-element-map tree 'bold
4013 \(lambda (b)
4014 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4015 nil nil nil t)"
4016 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4020 ;; Recursion depth is determined by --CATEGORY.
4027 ;; If one object is found, the function has to
4028 ;; recurse into every object.
4031 ;; If one regular element is found, the
4032 ;; function has to recurse, at least, into
4033 ;; every element it encounters.
4036 --acc
4037 --walk-tree
4040 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4041 ;; holding contextual information.
4045 ;; Ignored element in an export context.
4047 ;; List of elements or objects.
4049 ;; Unconditionally enter parse trees.
4053 ;; Check if TYPE is matching among TYPES. If so,
4054 ;; apply FUN to --DATA and accumulate return value
4055 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4061 ;; If --DATA has a secondary string that can contain
4062 ;; objects with their type among TYPES, look into it.
4069 ;; If --DATA has any parsed affiliated keywords and
4070 ;; WITH-AFFILIATED is non-nil, look for objects in
4071 ;; them.
4078 ;; Pay attention to the type of parsed keyword.
4079 ;; In particular, preserve order for multiple
4080 ;; keywords.
4093 ;; Determine if a recursion into --DATA is possible.
4095 ;; --TYPE is explicitly removed from recursion.
4097 ;; --DATA has no contents.
4099 ;; Looking for greater elements but --DATA is simply
4100 ;; an element or an object.
4103 ;; Looking for elements but --DATA is an object.
4106 ;; In any other case, map contents.
4110 ;; Return value in a proper order.
4114 ;; The following functions are internal parts of the parser.
4115 ;;
4116 ;; The first one, `org-element--parse-elements' acts at the element's
4117 ;; level.
4118 ;;
4119 ;; The second one, `org-element--parse-objects' applies on all objects
4120 ;; of a paragraph or a secondary string. It calls
4121 ;; `org-element--object-lex' to find the next object in the current
4122 ;; container.
4125 "Return next special mode according to TYPE, or nil.
4126 TYPE is a symbol representing the type of an element or object
4127 containing next element if PARENTP is non-nil, or before it
4128 otherwise. Modes can be either `first-section', `item',
4129 `node-property', `planning', `property-drawer', `section',
4130 `table-row' or nil."
4146 "Parse elements between BEG and END positions.
4148 MODE prioritizes some elements over the others. It can be set to
4149 `first-section', `section', `planning', `item', `node-property'
4150 or `table-row'.
4152 When value is `item', STRUCTURE will be used as the current list
4153 structure.
4155 GRANULARITY determines the depth of the recursion. See
4156 `org-element-parse-buffer' for more information.
4158 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4159 elements.
4161 Elements are accumulated into ACC."
4164 ;; Visible only: skip invisible parts at the beginning of the
4165 ;; element.
4168 ;; When parsing only headlines, skip any text before first one.
4171 ;; Main loop start.
4173 ;; Find current element's type and parse it accordingly to
4174 ;; its category.
4176 end granularity mode structure))
4180 ;; Visible only: skip invisible parts between siblings.
4183 ;; Fill ELEMENT contents by side-effect.
4185 ;; If element has no contents, don't modify it.
4187 ;; Greater element: parse it between `contents-begin' and
4188 ;; `contents-end'. Make sure GRANULARITY allows the
4189 ;; recursion, or ELEMENT is a headline, in which case going
4190 ;; inside is mandatory, in order to get sub-level headings.
4198 ;; Possibly switch to a special mode.
4202 granularity visible-only element))
4203 ;; ELEMENT has contents. Parse objects inside, if
4204 ;; GRANULARITY allows it.
4210 ;; Update mode.
4212 ;; Return result.
4213 acc))
4216 "Return next object in current buffer or nil.
4217 RESTRICTION is a list of object types, as symbols, that should be
4218 looked after. This function assumes that the buffer is narrowed
4219 to an appropriate container (e.g., a paragraph)."
4227 found)
4292 ;; This is probably a plain link.
4298 ;; Radio link.
4303 "Parse objects between BEG and END and return recursive structure.
4305 Objects are accumulated in ACC.
4307 RESTRICTION is a list of object successors which are allowed in
4308 the current object."
4316 ;; 1. Text before any object. Untabify it.
4321 acc
4325 ;; 2. Object...
4328 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4329 ;; a recursive type.
4337 ;; 3. Text after last object. Untabify it.
4341 acc
4345 ;; Result.
4346 acc)))
4349 \f
4350 ;;; Towards A Bijective Process
4351 ;;
4352 ;; The parse tree obtained with `org-element-parse-buffer' is really
4353 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4354 ;; interpreted and expanded into a string with canonical Org syntax.
4355 ;; Hence `org-element-interpret-data'.
4356 ;;
4357 ;; The function relies internally on
4358 ;; `org-element--interpret-affiliated-keywords'.
4360 ;;;###autoload
4362 "Interpret DATA as Org syntax.
4364 DATA is a parse tree, an element, an object or a secondary string
4365 to interpret.
4367 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4368 new types that should be treated as objects. An unknown type not
4369 belonging to this list is seen as a pseudo-element instead. Both
4370 pseudo-objects and pseudo-elements are transparent entities, i.e.
4371 only their contents are interpreted.
4373 Return Org syntax as a string."
4377 "Interpret DATA as Org syntax.
4379 DATA is a parse tree, an element, an object or a secondary string
4380 to interpret. PARENT is used for recursive calls. It contains
4381 the element or object containing data, or nil. PSEUDO-OBJECTS
4382 are list of symbols defining new element or object types.
4383 Unknown types that don't belong to this list are treated as
4384 pseudo-elements instead.
4386 Return Org syntax as a string."
4388 ;; Find interpreter for current object or element. If it
4389 ;; doesn't exist (e.g. this is a pseudo object or element),
4390 ;; return contents, if any.
4396 ;; Secondary string.
4402 ;; Full Org document.
4408 ;; Plain text: return it.
4410 ;; Element or object without contents.
4412 ;; Element or object with contents.
4415 ;; Recursively interpret contents.
4421 data
4422 ;; Fix indentation of elements containing
4423 ;; objects. We ignore `table-row' elements
4424 ;; as they are one line long anyway.
4426 data
4427 ;; When normalizing first paragraph of an
4428 ;; item or a footnote-definition, ignore
4429 ;; first line's indentation.
4436 ;; Build white spaces. If no `:post-blank' property is
4437 ;; specified, assume its value is 0.
4448 "Return ELEMENT's affiliated keywords as Org syntax.
4449 If there is no affiliated keyword, return the empty string."
4459 ": "
4462 value)
4470 ;; All attribute keywords can have multiple lines.
4476 ;; List all ELEMENT's properties matching an attribute line or an
4477 ;; affiliated keyword, but ignore translated keywords since they
4478 ;; cannot belong to the property list.
4485 org-element-keyword-translation-alist)))))
4486 collect prop)
4489 ;; Because interpretation of the parse tree must return the same
4490 ;; number of blank lines between elements and the same number of white
4491 ;; space after objects, some special care must be given to white
4492 ;; spaces.
4493 ;;
4494 ;; The first function, `org-element-normalize-string', ensures any
4495 ;; string different from the empty string will end with a single
4496 ;; newline character.
4497 ;;
4498 ;; The second function, `org-element-normalize-contents', removes
4499 ;; global indentation from the contents of the current element.
4502 "Ensure string S ends with a single newline character.
4504 If S isn't a string return it unchanged. If S is the empty
4505 string, return it. Otherwise, return a new string with a single
4506 newline character at its end."
4514 "Normalize plain text in ELEMENT's contents.
4516 ELEMENT must only contain plain text and objects.
4518 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4519 indentation to compute maximal common indentation.
4521 Return the normalized element that is element with global
4522 indentation removed from its contents. The function assumes that
4523 indentation is not done with TAB characters."
4525 find-min-ind ; For byte-compiler.
4527 ;; Return minimal common indentation within BLOB. This is
4528 ;; done by walking recursively BLOB and updating MIN-IND
4529 ;; along the way. FIRST-FLAG is non-nil when the first
4530 ;; string hasn't been seen yet. It is required as this
4531 ;; string is the only one whose indentation doesn't happen
4532 ;; after a newline character.
4539 ;; An indentation of zero means no string will be
4540 ;; modified. Quit the process.
4550 ;; Find minimal indentation in ELEMENT.
4553 ;; Build ELEMENT back, replacing each string with the same
4554 ;; string minus common indentation.
4559 ;; Return BLOB with all its strings indentation
4560 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4561 ;; is non-nil when the first string hasn't been seen
4562 ;; yet.
4577 org-element-recursive-objects)
4581 blob))))
4585 \f
4586 ;;; Cache
4587 ;;
4588 ;; Implement a caching mechanism for `org-element-at-point' and
4589 ;; `org-element-context', which see.
4590 ;;
4591 ;; A single public function is provided: `org-element-cache-reset'.
4592 ;;
4593 ;; Cache is enabled by default, but can be disabled globally with
4594 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4595 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4596 ;; can be tweaked to control caching behaviour.
4597 ;;
4598 ;; Internally, parsed elements are stored in an AVL tree,
4599 ;; `org-element--cache'. This tree is updated lazily: whenever
4600 ;; a change happens to the buffer, a synchronization request is
4601 ;; registered in `org-element--cache-sync-requests' (see
4602 ;; `org-element--cache-submit-request'). During idle time, requests
4603 ;; are processed by `org-element--cache-sync'. Synchronization also
4604 ;; happens when an element is required from the cache. In this case,
4605 ;; the process stops as soon as the needed element is up-to-date.
4606 ;;
4607 ;; A synchronization request can only apply on a synchronized part of
4608 ;; the cache. Therefore, the cache is updated at least to the
4609 ;; location where the new request applies. Thus, requests are ordered
4610 ;; from left to right and all elements starting before the first
4611 ;; request are correct. This property is used by functions like
4612 ;; `org-element--cache-find' to retrieve elements in the part of the
4613 ;; cache that can be trusted.
4614 ;;
4615 ;; A request applies to every element, starting from its original
4616 ;; location (or key, see below). When a request is processed, it
4617 ;; moves forward and may collide the next one. In this case, both
4618 ;; requests are merged into a new one that starts from that element.
4619 ;; As a consequence, the whole synchronization complexity does not
4620 ;; depend on the number of pending requests, but on the number of
4621 ;; elements the very first request will be applied on.
4622 ;;
4623 ;; Elements cannot be accessed through their beginning position, which
4624 ;; may or may not be up-to-date. Instead, each element in the tree is
4625 ;; associated to a key, obtained with `org-element--cache-key'. This
4626 ;; mechanism is robust enough to preserve total order among elements
4627 ;; even when the tree is only partially synchronized.
4628 ;;
4629 ;; Objects contained in an element are stored in a hash table,
4630 ;; `org-element--cache-objects'.
4634 "Non nil when Org parser should cache its results.
4641 "Maximum duration, as a time value, for a cache synchronization.
4642 If the synchronization is not over after this delay, the process
4643 pauses and resumes after `org-element-cache-sync-break'
4647 "Duration, as a time value, of the pause between synchronizations.
4651 ;;;; Data Structure
4654 "AVL tree used to cache elements.
4655 Each node of the tree contains an element. Comparison is done
4656 with `org-element--cache-compare'. This cache is used in
4660 "Hash table used as to cache objects.
4661 Key is an element, as returned by `org-element-at-point', and
4662 value is an alist where each association is:
4664 \(PARENT COMPLETEP . OBJECTS)
4666 where PARENT is an element or object, COMPLETEP is a boolean,
4667 non-nil when all direct children of parent are already cached and
4668 OBJECTS is a list of such children, as objects, from farthest to
4669 closest.
4672 contained within a paragraph
4676 If the paragraph is completely parsed, OBJECTS-DATA will be
4678 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4679 \(BOLD-OBJECT t ENTITY-OBJECT))
4681 whereas in a partially parsed paragraph, it could be
4683 \((PARAGRAPH nil ENTITY-OBJECT))
4688 "List of pending synchronization requests.
4690 A request is a vector with the following pattern:
4692 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4694 Processing a synchronization request consists of three phases:
4696 0. Delete modified elements,
4697 1. Fill missing area in cache,
4698 2. Shift positions and re-parent elements after the changes.
4700 During phase 0, NEXT is the key of the first element to be
4701 removed, BEG and END is buffer position delimiting the
4702 modifications. Elements starting between them (inclusive) are
4703 removed and so are those contained within OUTREACH. PARENT, when
4704 non-nil, is the parent of the first element to be removed.
4706 During phase 1, NEXT is the key of the next known element in
4707 cache and BEG its beginning position. Parse buffer between that
4708 element and the one before it in order to determine the parent of
4709 the next element. Set PARENT to the element containing NEXT.
4711 During phase 2, NEXT is the key of the next element to shift in
4712 the parse tree. All elements starting from this one have their
4713 properties relatives to buffer positions shifted by integer
4714 OFFSET and, if they belong to element PARENT, are adopted by it.
4722 "Hash table used to store keys during synchronization.
4726 "Return a unique key for ELEMENT in cache tree.
4728 Keys are used to keep a total order among elements in the cache.
4729 Comparison is done with `org-element--cache-key-less-p'.
4731 When no synchronization is taking place, a key is simply the
4732 beginning position of the element, or that position plus one in
4733 the case of an first item (respectively row) in
4734 a list (respectively a table).
4736 During a synchronization, the key is the one the element had when
4737 the cache was synchronized for the last time. Elements added to
4738 cache during the synchronization get a new key generated with
4739 `org-element--cache-generate-key'.
4741 Such keys are stored in `org-element--cache-sync-keys'. The hash
4742 table is cleared once the synchronization is complete."
4745 ;; Increase beginning position of items (respectively
4746 ;; table rows) by one, so the first item can get
4747 ;; a different key from its parent list (respectively
4748 ;; table).
4751 begin)))
4754 key))))
4757 "Generate a key between LOWER and UPPER.
4759 LOWER and UPPER are integers or lists, possibly empty.
4761 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4762 a unique key, as an integer or a list of integers, according to
4763 the following rules:
4765 - LOWER and UPPER are compared level-wise until values differ.
4767 - If, at a given level, LOWER and UPPER differ from more than
4768 2, the new key shares all the levels above with LOWER and
4769 gets a new level. Its value is the mean between LOWER and
4770 UPPER:
4772 \(1 2) + (1 4) --> (1 3)
4774 - If LOWER has no value to compare with, it is assumed that its
4775 value is `most-negative-fixnum'. E.g.,
4777 \(1 1) + (1 1 2)
4779 is equivalent to
4781 \(1 1 m) + (1 1 2)
4783 where m is `most-negative-fixnum'. Likewise, if UPPER is
4784 short of levels, the current value is `most-positive-fixnum'.
4786 - If they differ from only one, the new key inherits from
4787 current LOWER level and fork it at the next level. E.g.,
4789 \(2 1) + (3 3)
4791 is equivalent to
4793 \(2 1) + (2 M)
4795 where M is `most-positive-fixnum'.
4797 - If the key is only one level long, it is returned as an
4798 integer:
4800 \(1 2) + (3 2) --> 2
4802 When they are not equals, the function assumes that LOWER is
4803 lesser than UPPER, per `org-element--cache-key-less-p'."
4807 skip-upper key)
4818 ;; When at a given level, LOWER and UPPER differ from
4819 ;; 1, ignore UPPER altogether. Instead create a key
4820 ;; between LOWER and the greatest key with the same
4821 ;; prefix as LOWER so far.
4827 "Non-nil if key A is less than key B.
4828 A and B are either integers or lists of integers, as returned by
4829 `org-element--cache-key'."
4837 ;; If A is empty, either keys are equal (B is also empty) and
4838 ;; we return nil, or A is lesser than B (B is longer) and we
4839 ;; return a non-nil value.
4840 ;;
4841 ;; If A is not empty, B is necessarily empty and A is greater
4842 ;; than B (A is longer). Therefore, return nil.
4846 "Non-nil when element A is located before element B."
4851 "Return root value in cache.
4852 This function assumes `org-element--cache' is a valid AVL tree."
4856 ;;;; Tools
4859 "Non-nil when cache is active in current buffer."
4864 "Find element in cache starting at POS or before.
4866 POS refers to a buffer position.
4868 When optional argument SIDE is non-nil, the function checks for
4869 elements starting at or past POS instead. If SIDE is `both', the
4870 function returns a cons cell where car is the first element
4871 starting at or before POS and cdr the first element starting
4872 after POS.
4874 The function can only find elements in the synchronized part of
4875 the cache."
4879 lower upper)
4894 ;; We found an element in cache starting at POS. If `side'
4895 ;; is `both' we also want the next one in order to generate
4896 ;; a key in-between.
4897 ;;
4898 ;; If the element is the first row or item in a table or
4899 ;; a plain list, we always return the table or the plain
4900 ;; list.
4901 ;;
4902 ;; In any other case, we return the element found.
4911 lower parent
4912 upper parent)))))
4915 lower element
4916 upper element)))))
4923 "Store ELEMENT in current buffer's cache, if allowed.
4924 When optional argument DATA is non-nil, assume is it object data
4925 relative to ELEMENT and store it in the objects cache."
4929 ;; During synchronization, first build an appropriate key
4930 ;; for the new element so `avl-tree-enter' can insert it at
4931 ;; the right spot in the cache.
4940 org-element--cache-sync-keys)))
4942 ;; Headlines are not stored in cache, so objects in titles are
4943 ;; not stored either.
4948 "Remove ELEMENT from cache.
4949 Assume ELEMENT belongs to cache and that a cache is active."
4954 ;;;; Synchronization
4957 "Set idle timer for cache synchronization in BUFFER."
4964 org-element-cache-sync-idle-time))
4965 nil
4966 #'org-element--cache-sync
4967 buffer)))
4970 "Non-nil when synchronization process should be interrupted.
4971 TIME-LIMIT is a time value or nil."
4977 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4979 Properties containing buffer positions are `:begin', `:end',
4980 `:contents-begin', `:contents-end' and `:structure'. When
4981 optional argument PROPS is a list of keywords, only shift
4982 properties provided in that list.
4984 Properties are modified by side-effect."
4986 ;; Shift `:structure' property for the first plain list only: it
4987 ;; is the only one that really matters and it prevents from
4988 ;; shifting it more than once.
5002 "Synchronize cache with recent modification in BUFFER.
5004 When optional argument THRESHOLD is non-nil, do the
5005 synchronization for all elements starting before or at threshold,
5006 then exit. Otherwise, synchronize cache for as long as
5007 `org-element-cache-sync-duration' or until Emacs leaves idle
5008 state.
5010 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5011 not registered yet in the cache are going to happen. It is used
5012 in `org-element--cache-submit-request', where cache is partially
5013 updated before current modification are actually submitted."
5024 request
5026 threshold
5029 org-element-cache-sync-duration))
5030 future-change)
5031 ;; Request processed. Merge current and next offsets and
5032 ;; transfer ending position.
5038 ;; If more requests are awaiting, set idle timer accordingly.
5039 ;; Otherwise, reset keys.
5046 "Process synchronization REQUEST for all entries before NEXT.
5048 REQUEST is a vector, built by `org-element--cache-submit-request'.
5050 NEXT is a cache key, as returned by `org-element--cache-key'.
5052 When non-nil, THRESHOLD is a buffer position. Synchronization
5053 stops as soon as a shifted element begins after it.
5055 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5056 after this time or when Emacs exits idle state.
5058 When non-nil, FUTURE-CHANGE is a buffer position where changes
5059 not registered yet in the cache are going to happen. See
5060 `org-element--cache-submit-request' for more information.
5062 Throw `interrupt' if the process stops before completing the
5063 request."
5066 ;; Phase 0.
5067 ;;
5068 ;; Delete all elements starting after BEG, but not after buffer
5069 ;; position END or past element with key NEXT.
5070 ;;
5071 ;; At each iteration, we start again at tree root since
5072 ;; a deletion modifies structure of the balanced tree.
5080 ;; Find first element in cache with key BEG or after it.
5090 data-key key
5093 data-key key
5094 node nil)))))
5103 up))
5109 ;; No element starting after modifications left in
5110 ;; cache: further processing is futile.
5113 ;; Phase 1.
5114 ;;
5115 ;; Phase 0 left a hole in the cache. Some elements after it
5116 ;; could have parents within. For example, in the following
5117 ;; buffer:
5118 ;;
5119 ;; - item
5120 ;;
5121 ;;
5122 ;; Paragraph1
5123 ;;
5124 ;; Paragraph2
5125 ;;
5126 ;; if we remove a blank line between "item" and "Paragraph1",
5127 ;; everything down to "Paragraph2" is removed from cache. But
5128 ;; the paragraph now belongs to the list, and its `:parent'
5129 ;; property no longer is accurate.
5130 ;;
5131 ;; Therefore we need to parse again elements in the hole, or at
5132 ;; least in its last section, so that we can re-parent
5133 ;; subsequent elements, during phase 2.
5134 ;;
5135 ;; Note that we only need to get the parent from the first
5136 ;; element in cache after the hole.
5137 ;;
5138 ;; When next key is lesser or equal to the current one, delegate
5139 ;; phase 1 processing to next request in order to preserve key
5140 ;; order among requests.
5148 ;; Next element will start at its beginning position plus
5149 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5150 ;; contains the real beginning position of the first element to
5151 ;; shift and re-parent.
5155 ;; Changes are going to happen around this element and
5156 ;; they will trigger another phase 1 request. Skip the
5157 ;; current one.
5163 ;; Phase 2.
5164 ;;
5165 ;; Shift all elements starting from key START, but before NEXT, by
5166 ;; OFFSET, and re-parent them when appropriate.
5167 ;;
5168 ;; Elements are modified by side-effect so the tree structure
5169 ;; remains intact.
5170 ;;
5171 ;; Once THRESHOLD, if any, is reached, or once there is an input
5172 ;; pending, exit. Before leaving, the current synchronization
5173 ;; request is updated.
5180 exit-flag)
5181 ;; No re-parenting nor shifting planned: request is over.
5191 ;; We reached NEXT. Request is complete.
5193 ;; Handle interruption request. Update current request.
5198 ;; Shift element.
5201 ;; Shift associated objects data, if any.
5206 ;; Update PARENT and re-parent DATA, only when
5207 ;; necessary. Propagate new structures for lists.
5221 ;; Cache is up-to-date past THRESHOLD. Request
5222 ;; interruption.
5227 ;; We reached end of tree: synchronization complete.
5228 t)))
5231 "Parse elements in current section, down to POS.
5233 Start parsing from the closest between the last known element in
5234 cache or headline above. Return the smallest element containing
5235 POS.
5237 When optional argument SYNCP is non-nil, return the parent of the
5238 element containing POS instead. In that case, it is also
5239 possible to provide TIME-LIMIT, which is a time value specifying
5240 when the parsing should stop. The function throws `interrupt' if
5241 the process stopped before finding the expected result."
5248 element next mode)
5250 ;; Nothing in cache before point: start parsing from first
5251 ;; element following headline above, or first element in
5252 ;; buffer.
5259 ;; Cache returned exact match: return it.
5262 ;; There's a headline between cached value and POS: cached
5263 ;; value is invalid. Start parsing from first element
5264 ;; following the headline.
5271 ;; Check if CACHED or any of its ancestors contain point.
5272 ;;
5273 ;; If there is such an element, we inspect it in order to know
5274 ;; if we return it or if we need to parse its contents.
5275 ;; Otherwise, we just start parsing from current location,
5276 ;; which is right after the top-most element containing
5277 ;; CACHED.
5278 ;;
5279 ;; As a special case, if POS is at the end of the buffer, we
5280 ;; want to return the innermost element ending there.
5281 ;;
5282 ;; Also, if we find an ancestor and discover that we need to
5283 ;; parse its contents, make sure we don't start from
5284 ;; `:contents-begin', as we would otherwise go past CACHED
5285 ;; again. Instead, in that situation, we will resume parsing
5286 ;; from NEXT, which is located after CACHED or its higher
5287 ;; ancestor not containing point.
5299 ;; Parse successively each element until we reach POS.
5312 end 'element mode
5319 ;; Skip any element ending before point. Also skip
5320 ;; element ending at point (unless it is also the end of
5321 ;; buffer) since we're sure that another element begins
5322 ;; after it.
5326 ;; A non-greater element contains point: return it.
5329 ;; Otherwise, we have to decide if ELEMENT really
5330 ;; contains POS. In that case we start parsing from
5331 ;; contents' beginning.
5332 ;;
5333 ;; If POS is at contents' beginning but it is also at
5334 ;; the beginning of the first item in a list or a table.
5335 ;; In that case, we need to create an anchor for that
5336 ;; list or table, so return it.
5337 ;;
5338 ;; Also, if POS is at the end of the buffer, no element
5339 ;; can start after it, but more than one may end there.
5340 ;; Arbitrarily, we choose to return the innermost of
5341 ;; such elements.
5354 parent element
5355 end cend))))
5356 ;; Otherwise, return ELEMENT as it is the smallest
5357 ;; element containing POS.
5362 ;;;; Staging Buffer Changes
5368 ;; Blocks
5370 ;; LaTeX environments.
5372 ;; Drawers.
5375 "Regexp matching a sensitive line, structure wise.
5376 A sensitive line is a headline, inlinetask, block, drawer, or
5377 latex-environment boundary. When such a line is modified,
5378 structure changes in the document may propagate in the whole
5382 "Non-nil when a sensitive line is about to be changed.
5386 "Request extension of area going to be modified if needed.
5387 BEG and END are the beginning and end of the range of changed
5388 text. See `before-change-functions' for more information."
5398 'headline
5401 org-element--cache-sensitive-re bottom t)))))))))
5404 "Update buffer modifications for current buffer.
5405 BEG and END are the beginning and end of the range of changed
5406 text, and the length in bytes of the pre-change text replaced by
5407 that range. See `after-change-functions' for more information."
5415 ;; Determine if modified area needs to be extended, according
5416 ;; to both previous and current state. We make a special
5417 ;; case for headline editing: if a headline is modified but
5418 ;; not removed, do not extend.
5427 org-element--cache-sensitive-re bottom t))))
5428 ;; Effectively extend modified area.
5436 ;; Store synchronization request.
5439 ;; Activate a timer to process the request during idle time.
5443 "Return first element to remove from cache.
5445 BEG and END are buffer positions delimiting buffer modifications.
5446 OFFSET is the size of the changes.
5448 Returned element is usually the first element in cache containing
5449 any position between BEG and END. As an exception, greater
5450 elements around the changes that are robust to contents
5451 modifications are preserved and updated according to the
5452 changes."
5462 quote-block special-block))
5467 ;; UP is a robust greater element containing changes.
5468 ;; We only need to extend its ending boundaries.
5474 ;; We're at top level element containing ELEMENT: if it's
5475 ;; altered by buffer modifications, it is first element in
5476 ;; cache to be removed. Otherwise, that first element is the
5477 ;; following one.
5478 ;;
5479 ;; As a special case, do not remove BEFORE if it is a robust
5480 ;; container for current changes.
5482 before)))))
5485 "Submit a new cache synchronization request for current buffer.
5486 BEG and END are buffer positions delimiting the minimal area
5487 where cache data should be removed. OFFSET is the size of the
5488 change, as an integer."
5490 delete-to delete-from)
5495 ;; Current changes can be merged with first sync request: we
5496 ;; can save a partial cache synchronization.
5499 ;; If last change happened within area to be removed, extend
5500 ;; boundaries of robust parents, if any. Otherwise, find
5501 ;; first element to remove and update request accordingly.
5513 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5514 ;; if any, is no longer a 0-phase request, thus ensuring that
5515 ;; phases are properly ordered. We need to provide OFFSET as
5516 ;; optional parameter since current modifications are not known
5517 ;; yet to the otherwise correct part of the cache (i.e, before
5518 ;; the first request).
5525 ;; When changes happen before the first known
5526 ;; element, re-parent and shift the rest of the
5527 ;; cache.
5529 ;; Otherwise, we find the first non robust
5530 ;; element containing END. All elements between
5531 ;; FIRST and this one are to be removed.
5532 ;;
5533 ;; Among them, some could be located outside the
5534 ;; synchronized part of the cache, in which case
5535 ;; comparing buffer positions to find them is
5536 ;; useless. Instead, we store the element
5537 ;; containing them in the request itself. All
5538 ;; its children will be removed.
5550 element up))
5553 org-element--cache-sync-requests)
5554 ;; No element to remove. No need to re-parent either.
5555 ;; Simply shift additional elements, if any, by OFFSET.
5560 ;;;; Public Functions
5562 ;;;###autoload
5564 "Reset cache in current buffer.
5565 When optional argument ALL is non-nil, reset cache in all Org
5566 buffers."
5584 ;;;###autoload
5586 "Refresh cache at position POS."
5593 \f
5594 ;;; The Toolbox
5595 ;;
5596 ;; The first move is to implement a way to obtain the smallest element
5597 ;; containing point. This is the job of `org-element-at-point'. It
5598 ;; basically jumps back to the beginning of section containing point
5599 ;; and proceed, one element after the other, with
5600 ;; `org-element--current-element' until the container is found. Note:
5601 ;; When using `org-element-at-point', secondary values are never
5602 ;; parsed since the function focuses on elements, not on objects.
5603 ;;
5604 ;; At a deeper level, `org-element-context' lists all elements and
5605 ;; objects containing point.
5606 ;;
5607 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5608 ;; internally by navigation and manipulation tools.
5611 ;;;###autoload
5613 "Determine closest element around point.
5615 Return value is a list like (TYPE PROPS) where TYPE is the type
5616 of the element and PROPS a plist of properties associated to the
5617 element.
5619 Possible types are defined in `org-element-all-elements'.
5620 Properties depend on element or object type, but always include
5621 `:begin', `:end', `:parent' and `:post-blank' properties.
5623 As a special case, if point is at the very beginning of the first
5624 item in a list or sub-list, returned element will be that list
5625 instead of the item. Likewise, if point is at the beginning of
5626 the first row of a table, returned element will be the table
5627 instead of the first row.
5629 When point is at the end of the buffer, return the innermost
5630 element ending there."
5636 ;; Within blank lines at the beginning of buffer, return nil.
5638 ;; Within blank lines right after a headline, return that
5639 ;; headline.
5643 ;; Otherwise parse until we find element containing ORIGIN.
5650 ;;;###autoload
5652 "Return smallest element or object around point.
5654 Return value is a list like (TYPE PROPS) where TYPE is the type
5655 of the element or object and PROPS a plist of properties
5656 associated to it.
5658 Possible types are defined in `org-element-all-elements' and
5659 `org-element-all-objects'. Properties depend on element or
5660 object type, but always include `:begin', `:end', `:parent' and
5661 `:post-blank'.
5663 As a special case, if point is right after an object and not at
5664 the beginning of any other object, return that object.
5666 Optional argument ELEMENT, when non-nil, is the closest element
5667 containing point, as returned by `org-element-at-point'.
5668 Providing it allows for quicker computation."
5674 ;; If point is inside an element containing objects or
5675 ;; a secondary string, narrow buffer to the container and
5676 ;; proceed with parsing. Otherwise, return ELEMENT.
5678 ;; At a parsed affiliated keyword, check if we're inside main
5679 ;; or dual value.
5686 org-element-parsed-keywords))
5695 ;; Also change type to retrieve correct restrictions.
5697 ;; At an item, objects can only be located within tag, if any.
5707 ;; At an headline or inlinetask, objects are in title.
5714 ;; At a paragraph, a table-row or a verse block, objects are
5715 ;; located within their contents.
5719 ;; CBEG is nil for table rules.
5724 ;; At a parsed keyword, objects are located within value.
5727 org-element-document-properties))
5734 ;; At a planning line, if point is at a timestamp, return it,
5735 ;; otherwise, return element.
5743 ;; All other locations cannot contain objects: bail out.
5753 next object-data last)
5757 ;; When entering PARENT for the first time, get list
5758 ;; of objects within known so far. Store it in
5759 ;; OBJECT-DATA.
5764 ;; Find NEXT object for analysis.
5766 ;; If NEXT is non-nil, we already exhausted the
5767 ;; cache so we can parse buffer to find the object
5768 ;; after it.
5770 ;; Otherwise, check if cache can help us.
5781 ;; Cache contains the information needed.
5784 pos)
5786 pos)
5792 ;; If we have a new object to analyze, store it in
5793 ;; cache. Otherwise record that there is nothing
5794 ;; more to parse in this element at this depth.
5799 ;; Process NEXT, if any, in order to know if we need
5800 ;; to skip it, return it or move into it.
5807 ;; Skip objects ending before point. Also skip
5808 ;; objects ending at point unless it is also the
5809 ;; end of buffer, since we want to return the
5810 ;; innermost object.
5813 ;; For convenience, when object ends at POS,
5814 ;; without any space, store it in LAST, as we
5815 ;; will return it if no object starts here.
5819 ;; If POS is within a container object, move
5820 ;; into that object.
5824 ;; At contents' end, if there is no
5825 ;; space before point, also move into
5826 ;; object, for consistency with
5827 ;; convenience feature above.
5836 next nil
5837 object-data nil))
5838 ;; Otherwise, return NEXT.
5840 ;; Store results in cache, if applicable.
5844 "List all ancestors of a given element or object.
5846 BLOB is an object or element.
5848 When optional argument TYPES is a list of symbols, return the
5849 first element or object in the lineage whose type belongs to that
5850 list.
5852 When optional argument WITH-SELF is non-nil, lineage includes
5853 BLOB itself as the first element, and TYPES, if provided, also
5854 apply to it.
5856 When BLOB is obtained through `org-element-context' or
5857 `org-element-at-point', only ancestors from its section can be
5858 found. There is no such limitation when BLOB belongs to a full
5859 parse tree."
5861 ancestors)
5868 "Non-nil when elements ELEM-A and ELEM-B are nested."
5877 "Swap elements ELEM-A and ELEM-B.
5878 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5879 end of ELEM-A."
5881 ;; There are two special cases when an element doesn't start at bol:
5882 ;; the first paragraph in an item or in a footnote definition.
5884 ;; Only a paragraph without any affiliated keyword can be moved at
5885 ;; ELEM-A position in such a situation. Note that the case of
5886 ;; a footnote definition is impossible: it cannot contain two
5887 ;; paragraphs in a row because it cannot contain a blank line.
5893 ;; In a special situation, ELEM-A will have no indentation. We'll
5894 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5908 ;; Store overlays responsible for visibility status. We
5909 ;; also need to store their boundaries as they will be
5910 ;; removed from buffer.
5917 ;; Get contents.
5925 ;; Restore ex ELEM-A overlays.
5934 ;; Restore ex ELEM-B overlays.
5942 "Remove maximum common indentation in string S and return it.
5943 When optional argument N is a positive integer, remove exactly
5944 that much characters from indentation, if possible, or return
5945 S as-is otherwise. Unlike to `org-remove-indentation', this
5946 function doesn't call `untabify' on S."
5951 ;; Find maximum common indentation, if not specified.
5959 min-ind)))
5961 ;; Remove exactly N indentation, but give up if not possible.
5974 ;; Local variables:
5975 ;; generated-autoload-file: "org-loaddefs.el"
5976 ;; End:
5978 ;;; org-element.el ends here