| blob | 4a138b6a4c991296a5919514fff00f62740bb759 |
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', `:begin', `:end',
871 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
872 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
873 `: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))))
957 headline :title
966 nil
972 "Interpret HEADLINE element as Org syntax.
973 CONTENTS is the contents of the element."
989 ?*)
993 " "
996 org-footnote-section
997 title))))
999 heading
1000 ;; Align tags.
1008 ?\s)
1009 tags))
1013 tags))))
1015 contents)))
1018 ;;;; Inlinetask
1021 "Parse an inline task.
1023 Return a list whose CAR is `inlinetask' and CDR is a plist
1024 containing `:title', `:begin', `:end', `:contents-begin' and
1025 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1026 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1027 `:closed', `:post-blank' and `:post-affiliated' keywords.
1029 The plist also contains any property set in the property drawer,
1030 with its name in upper cases and colons added at the
1031 beginning (e.g., `:CUSTOM_ID').
1033 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1034 title will not be parsed as a secondary string, but as a plain
1035 string instead.
1037 Assume point is at beginning of the inline task."
1082 :begin begin
1083 :end end
1084 :contents-begin contents-begin
1085 :contents-end contents-end
1086 :level level
1087 :priority priority
1088 :tags tags
1089 :todo-keyword todo
1090 :todo-type todo-type
1093 time-props
1094 standard-props))))
1096 inlinetask :title
1105 nil
1111 "Interpret INLINETASK element as Org syntax.
1112 CONTENTS is the contents of inlinetask."
1126 ;; Align tags.
1134 ? )
1135 tags))
1139 tags))))
1140 ;; Prefer degenerate inlinetasks when there are no
1141 ;; contents.
1144 contents
1148 ;;;; Item
1151 "Parse an item.
1153 STRUCT is the structure of the plain list.
1155 Return a list whose CAR is `item' and CDR is a plist containing
1156 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1157 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1158 `:post-affiliated' keywords.
1160 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1161 any, will not be parsed as a secondary string, but as a plain
1162 string instead.
1164 Assume point is at the beginning of the item."
1188 ;; Ignore tags in un-ordered lists: they are just
1189 ;; a part of item's body.
1195 ;; If first line isn't empty, contents really start
1196 ;; at the text after item's meta-data.
1205 :begin begin
1206 :end end
1207 ;; CONTENTS-BEGIN and CONTENTS-END may be
1208 ;; mixed up in the case of an empty item
1209 ;; separated from the next by a blank line.
1210 ;; Thus ensure the former is always the
1211 ;; smallest.
1214 :checkbox checkbox
1215 :counter counter
1216 :structure struct
1220 item :tag
1231 "Interpret ITEM element as Org syntax.
1232 CONTENTS is the contents of the element."
1242 ;; Compute indentation.
1247 ;; Indent contents.
1249 bullet
1263 ;;;; Plain List
1266 ;; Return structure of list at point. Internal function. See
1267 ;; `org-list-struct' for details.
1272 items struct)
1277 ;; At limit: end all items.
1286 ;; At list end: end all items.
1291 ;; At a new item: end previous sibling.
1303 ind
1304 bullet
1307 ;; Description tag.
1311 ;; Ending position, unknown so far.
1312 nil)))
1313 items))
1315 ;; Skip empty lines.
1317 ;; Skip inline tasks and blank lines along the way.
1324 ;; At some text line. Check if it ends any previous item.
1336 ;; Skip blocks (any type) and drawers contents.
1341 limit t)))
1347 "Parse a plain list.
1349 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1350 the buffer position at the beginning of the first affiliated
1351 keyword and CDR is a plist of affiliated keywords along with
1352 their value. STRUCTURE is the structure of the plain list being
1353 parsed.
1355 Return a list whose CAR is `plain-list' and CDR is a plist
1356 containing `:type', `:begin', `:end', `:contents-begin' and
1357 `:contents-end', `:structure', `:post-blank' and
1358 `:post-affiliated' keywords.
1360 Assume point is at the beginning of the list."
1374 pos))
1378 ;; Return value.
1382 :begin begin
1383 :end end
1384 :contents-begin contents-begin
1385 :contents-end contents-end
1386 :structure struct
1392 "Interpret PLAIN-LIST element as Org syntax.
1393 CONTENTS is the contents of the element."
1401 ;;;; Property Drawer
1404 "Parse a property drawer.
1406 LIMIT bounds the search.
1408 Return a list whose car is `property-drawer' and cdr is a plist
1409 containing `:begin', `:end', `:contents-begin', `:contents-end',
1410 `:post-blank' and `:post-affiliated' keywords.
1412 Assume point is at the beginning of the property drawer."
1425 :end end
1427 :contents-end contents-end
1432 "Interpret PROPERTY-DRAWER element as Org syntax.
1433 CONTENTS is the properties within the drawer."
1437 ;;;; Quote Block
1440 "Parse a quote block.
1442 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1443 the buffer position at the beginning of the first affiliated
1444 keyword and CDR is a plist of affiliated keywords along with
1445 their value.
1447 Return a list whose CAR is `quote-block' and CDR is a plist
1448 containing `:begin', `:end', `:contents-begin', `:contents-end',
1449 `:post-blank' and `:post-affiliated' keywords.
1451 Assume point is at the beginning of the block."
1455 ;; Incomplete block: parse it as a paragraph.
1461 ;; Empty blocks have no contents.
1474 :end end
1475 :contents-begin contents-begin
1476 :contents-end contents-end
1482 "Interpret QUOTE-BLOCK element as Org syntax.
1483 CONTENTS is the contents of the element."
1487 ;;;; Section
1490 "Parse a section.
1492 LIMIT bounds the search.
1494 Return a list whose CAR is `section' and CDR is a plist
1495 containing `:begin', `:end', `:contents-begin', `contents-end',
1496 `:post-blank' and `:post-affiliated' keywords."
1498 ;; Beginning of section is the beginning of the first non-blank
1499 ;; line after previous headline.
1508 :end end
1509 :contents-begin begin
1510 :contents-end pos-before-blank
1515 "Interpret SECTION element as Org syntax.
1516 CONTENTS is the contents of the element."
1517 contents)
1520 ;;;; Special Block
1523 "Parse a special block.
1525 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1526 the buffer position at the beginning of the first affiliated
1527 keyword and CDR is a plist of affiliated keywords along with
1528 their value.
1530 Return a list whose CAR is `special-block' and CDR is a plist
1531 containing `:type', `:begin', `:end', `:contents-begin',
1532 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1534 Assume point is at the beginning of the block."
1541 limit t)))
1542 ;; Incomplete block: parse it as a paragraph.
1548 ;; Empty blocks have no contents.
1561 :begin begin
1562 :end end
1563 :contents-begin contents-begin
1564 :contents-end contents-end
1570 "Interpret SPECIAL-BLOCK element as Org syntax.
1571 CONTENTS is the contents of the element."
1576 \f
1577 ;;; Elements
1578 ;;
1579 ;; For each element, a parser and an interpreter are also defined.
1580 ;; Both follow the same naming convention used for greater elements.
1581 ;;
1582 ;; Also, as for greater elements, adding a new element type is done
1583 ;; through the following steps: implement a parser and an interpreter,
1584 ;; tweak `org-element--current-element' so that it recognizes the new
1585 ;; type and add that new type to `org-element-all-elements'.
1586 ;;
1587 ;; As a special case, when the newly defined type is a block type,
1588 ;; `org-element-block-name-alist' has to be modified accordingly.
1591 ;;;; Babel Call
1594 "Parse a babel call.
1596 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1597 the buffer position at the beginning of the first affiliated
1598 keyword and CDR is a plist of affiliated keywords along with
1599 their value.
1601 Return a list whose CAR is `babel-call' and CDR is a plist
1602 containing `:begin', `:end', `:value', `:post-blank' and
1603 `:post-affiliated' as keywords."
1617 :end end
1618 :value value
1624 "Interpret BABEL-CALL element as Org syntax.
1625 CONTENTS is nil."
1629 ;;;; Clock
1632 "Parse a clock.
1634 LIMIT bounds the search.
1636 Return a list whose CAR is `clock' and CDR is a plist containing
1637 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1638 `:post-affiliated' as keywords."
1658 :value value
1659 :duration duration
1660 :begin begin
1661 :end end
1662 :post-blank post-blank
1666 "Interpret CLOCK element as Org syntax.
1667 CONTENTS is nil."
1675 "%2s:%02s"
1679 ;;;; Comment
1682 "Parse a comment.
1684 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1685 the buffer position at the beginning of the first affiliated
1686 keyword and CDR is a plist of affiliated keywords along with
1687 their value.
1689 Return a list whose CAR is `comment' and CDR is a plist
1690 containing `:begin', `:end', `:value', `:post-blank',
1691 `:post-affiliated' keywords.
1693 Assume point is at comment beginning."
1702 ;; Get comments ending.
1705 ;; Accumulate lines without leading hash and first
1706 ;; whitespace.
1720 :end end
1721 :value value
1727 "Interpret COMMENT element as Org syntax.
1728 CONTENTS is nil."
1732 ;;;; Comment Block
1735 "Parse an export block.
1737 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1738 the buffer position at the beginning of the first affiliated
1739 keyword and CDR is a plist of affiliated keywords along with
1740 their value.
1742 Return a list whose CAR is `comment-block' and CDR is a plist
1743 containing `:begin', `:end', `:value', `:post-blank' and
1744 `:post-affiliated' keywords.
1746 Assume point is at comment block beginning."
1750 ;; Incomplete block: parse it as a paragraph.
1763 contents-begin contents-end)))
1767 :end end
1768 :value value
1774 "Interpret COMMENT-BLOCK element as Org syntax.
1775 CONTENTS is nil."
1782 ;;;; Diary Sexp
1785 "Parse a diary sexp.
1787 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1788 the buffer position at the beginning of the first affiliated
1789 keyword and CDR is a plist of affiliated keywords along with
1790 their value.
1792 Return a list whose CAR is `diary-sexp' and CDR is a plist
1793 containing `:begin', `:end', `:value', `:post-blank' and
1794 `:post-affiliated' keywords."
1806 :begin begin
1807 :end end
1813 "Interpret DIARY-SEXP as Org syntax.
1814 CONTENTS is nil."
1818 ;;;; Example Block
1821 "Parse an example block.
1823 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1824 the buffer position at the beginning of the first affiliated
1825 keyword and CDR is a plist of affiliated keywords along with
1826 their value.
1828 Return a list whose CAR is `example-block' and CDR is a plist
1829 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1830 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1831 `:value', `:post-blank' and `:post-affiliated' keywords."
1835 ;; Incomplete block: parse it as a paragraph.
1843 ;; Switches analysis
1850 ;; Should labels be retained in (or stripped from) example
1851 ;; blocks?
1856 ;; What should code-references use - labels or
1857 ;; line-numbers?
1866 ;; Standard block parsing.
1874 contents-begin contents-end))
1875 block-ind))
1884 :end end
1885 :value value
1886 :switches switches
1887 :number-lines number-lines
1888 :preserve-indent preserve-indent
1889 :retain-labels retain-labels
1890 :use-labels use-labels
1891 :label-fmt label-fmt
1897 "Interpret EXAMPLE-BLOCK element as Org syntax.
1898 CONTENTS is nil."
1906 value
1911 ;;;; Export Block
1914 "Parse an export block.
1916 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1917 the buffer position at the beginning of the first affiliated
1918 keyword and CDR is a plist of affiliated keywords along with
1919 their value.
1921 Return a list whose CAR is `export-block' and CDR is a plist
1922 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1923 `:post-affiliated' keywords.
1925 Assume point is at export-block beginning."
1932 ;; Incomplete block: parse it as a paragraph.
1945 contents-end)))
1949 :end end
1950 :type type
1951 :value value
1957 "Interpret EXPORT-BLOCK element as Org syntax.
1958 CONTENTS is nil."
1965 ;;;; Fixed-width
1968 "Parse a fixed-width section.
1970 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1971 the buffer position at the beginning of the first affiliated
1972 keyword and CDR is a plist of affiliated keywords along with
1973 their value.
1975 Return a list whose CAR is `fixed-width' and CDR is a plist
1976 containing `:begin', `:end', `:value', `:post-blank' and
1977 `:post-affiliated' keywords.
1979 Assume point is at the beginning of the fixed-width area."
1983 value
1988 ;; Accumulate text without starting colons.
2001 :end end
2002 :value value
2008 "Interpret FIXED-WIDTH element as Org syntax.
2009 CONTENTS is nil."
2017 ;;;; Horizontal Rule
2020 "Parse an horizontal rule.
2022 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2023 the buffer position at the beginning of the first affiliated
2024 keyword and CDR is a plist of affiliated keywords along with
2025 their value.
2027 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2028 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2029 keywords."
2039 :end end
2045 "Interpret HORIZONTAL-RULE element as Org syntax.
2046 CONTENTS is nil."
2050 ;;;; Keyword
2053 "Parse a keyword at point.
2055 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2056 the buffer position at the beginning of the first affiliated
2057 keyword and CDR is a plist of affiliated keywords along with
2058 their value.
2060 Return a list whose CAR is `keyword' and CDR is a plist
2061 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2062 `:post-affiliated' keywords."
2064 ;; An orphaned affiliated keyword is considered as a regular
2065 ;; keyword. In this case AFFILIATED is nil, so we take care of
2066 ;; this corner case.
2079 :value value
2080 :begin begin
2081 :end end
2087 "Interpret KEYWORD element as Org syntax.
2088 CONTENTS is nil."
2094 ;;;; Latex Environment
2098 "Regexp matching the beginning of a LaTeX environment.
2099 The environment is captured by the first group.
2105 "Format string matching the ending of a LaTeX environment.
2109 "Parse a LaTeX environment.
2111 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2112 the buffer position at the beginning of the first affiliated
2113 keyword and CDR is a plist of affiliated keywords along with
2114 their value.
2116 Return a list whose CAR is `latex-environment' and CDR is a plist
2117 containing `:begin', `:end', `:value', `:post-blank' and
2118 `:post-affiliated' keywords.
2120 Assume point is at the beginning of the latex environment."
2127 limit t))
2128 ;; Incomplete latex environment: parse it as a paragraph.
2138 :end end
2139 :value value
2145 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2146 CONTENTS is nil."
2150 ;;;; Node Property
2153 "Parse a node-property at point.
2155 LIMIT bounds the search.
2157 Return a list whose CAR is `node-property' and CDR is a plist
2158 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2159 `:post-affiliated' keywords."
2169 limit))))
2172 :value value
2173 :begin begin
2174 :end end
2179 "Interpret NODE-PROPERTY element as Org syntax.
2180 CONTENTS is nil."
2186 ;;;; Paragraph
2189 "Parse a paragraph.
2191 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2192 the buffer position at the beginning of the first affiliated
2193 keyword and CDR is a plist of affiliated keywords along with
2194 their value.
2196 Return a list whose CAR is `paragraph' and CDR is a plist
2197 containing `:begin', `:end', `:contents-begin' and
2198 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2200 Assume point is at the beginning of the paragraph."
2209 limit
2210 ;; A matching `org-element-paragraph-separate' is not
2211 ;; necessarily the end of the paragraph. In
2212 ;; particular, lines starting with # or : as a first
2213 ;; non-space character are ambiguous. We have to
2214 ;; check if they are valid Org syntax (e.g., not an
2215 ;; incomplete keyword).
2219 ;; There's no ambiguity for other symbols or
2220 ;; empty lines: stop here.
2222 ;; Stop at valid fixed-width areas.
2224 ;; Stop at drawers.
2229 ;; Stop at valid comments.
2231 ;; Stop at valid dynamic blocks.
2236 ;; Stop at valid blocks.
2243 limit t)))
2244 ;; Stop at valid latex environments.
2251 limit t)))
2252 ;; Stop at valid keywords.
2254 ;; Skip everything else.
2271 :end end
2272 :contents-begin contents-begin
2273 :contents-end contents-end
2279 "Interpret PARAGRAPH element as Org syntax.
2280 CONTENTS is the contents of the element."
2281 contents)
2284 ;;;; Planning
2287 "Parse a planning.
2289 LIMIT bounds the search.
2291 Return a list whose CAR is `planning' and CDR is a plist
2292 containing `:closed', `:deadline', `:scheduled', `:begin',
2293 `:end', `:post-blank' and `:post-affiliated' keywords."
2303 closed deadline scheduled)
2315 :deadline deadline
2316 :scheduled scheduled
2317 :begin begin
2318 :end end
2319 :post-blank post-blank
2323 "Interpret PLANNING element as Org syntax.
2324 CONTENTS is nil."
2326 'identity
2343 ;;;; Src Block
2346 "Parse a src block.
2348 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2349 the buffer position at the beginning of the first affiliated
2350 keyword and CDR is a plist of affiliated keywords along with
2351 their value.
2353 Return a list whose CAR is `src-block' and CDR is a plist
2354 containing `:language', `:switches', `:parameters', `:begin',
2355 `:end', `:number-lines', `:retain-labels', `:use-labels',
2356 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2357 `:post-affiliated' keywords.
2359 Assume point is at the beginning of the block."
2362 limit t)))
2363 ;; Incomplete block: parse it as a paragraph.
2369 ;; Get language as a string.
2378 ;; Get switches.
2380 ;; Get parameters.
2382 ;; Switches analysis
2393 ;; Should labels be retained in (or stripped from)
2394 ;; src blocks?
2399 ;; What should code-references use - labels or
2400 ;; line-numbers?
2405 ;; Indentation.
2407 ;; Retrieve code.
2412 block-ind))
2416 ;; Get position after ending blank lines.
2426 :begin begin
2427 :end end
2428 :number-lines number-lines
2429 :preserve-indent preserve-indent
2430 :retain-labels retain-labels
2431 :use-labels use-labels
2432 :label-fmt label-fmt
2433 :value value
2439 "Interpret SRC-BLOCK element as Org syntax.
2440 CONTENTS is nil."
2449 val)
2463 ;;;; Table
2466 "Parse a table at point.
2468 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2469 the buffer position at the beginning of the first affiliated
2470 keyword and CDR is a plist of affiliated keywords along with
2471 their value.
2473 Return a list whose CAR is `table' and CDR is a plist containing
2474 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2475 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2476 keywords.
2478 Assume point is at the beginning of the table."
2492 acc))
2499 :end end
2500 :type type
2501 :tblfm tblfm
2502 ;; Only `org' tables have contents. `table.el' tables
2503 ;; use a `:value' property to store raw table as
2504 ;; a string.
2509 table-begin table-end))
2515 "Interpret TABLE element as Org syntax.
2516 CONTENTS is a string, if table's type is `org', or nil."
2527 ;;;; Table Row
2530 "Parse table row at point.
2532 LIMIT bounds the search.
2534 Return a list whose CAR is `table-row' and CDR is a plist
2535 containing `:begin', `:end', `:contents-begin', `:contents-end',
2536 `:type', `:post-blank' and `:post-affiliated' keywords."
2540 ;; A table rule has no contents. In that case, ensure
2541 ;; CONTENTS-BEGIN matches CONTENTS-END.
2553 :begin begin
2554 :end end
2555 :contents-begin contents-begin
2556 :contents-end contents-end
2561 "Interpret TABLE-ROW element as Org syntax.
2562 CONTENTS is the contents of the table row."
2567 ;;;; Verse Block
2570 "Parse a verse block.
2572 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2573 the buffer position at the beginning of the first affiliated
2574 keyword and CDR is a plist of affiliated keywords along with
2575 their value.
2577 Return a list whose CAR is `verse-block' and CDR is a plist
2578 containing `:begin', `:end', `:contents-begin', `:contents-end',
2579 `:post-blank' and `:post-affiliated' keywords.
2581 Assume point is at beginning of the block."
2585 ;; Incomplete block: parse it as a paragraph.
2600 :end end
2601 :contents-begin contents-begin
2602 :contents-end contents-end
2608 "Interpret VERSE-BLOCK element as Org syntax.
2609 CONTENTS is verse block contents."
2613 \f
2614 ;;; Objects
2615 ;;
2616 ;; Unlike to elements, raw text can be found between objects. Hence,
2617 ;; `org-element--object-lex' is provided to find the next object in
2618 ;; buffer.
2619 ;;
2620 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2621 ;; object types they can contain will be specified in
2622 ;; `org-element-object-restrictions'.
2623 ;;
2624 ;; Creating a new type of object requires to alter
2625 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2626 ;; new type in `org-element-all-objects', and possibly add
2627 ;; restrictions in `org-element-object-restrictions'.
2629 ;;;; Bold
2632 "Parse bold object at point, if any.
2634 When at a bold object, return a list whose car is `bold' and cdr
2635 is a plist with `:begin', `:end', `:contents-begin' and
2636 `:contents-end' and `:post-blank' keywords. Otherwise, return
2637 nil.
2639 Assume point is at the first star marker."
2651 :end end
2652 :contents-begin contents-begin
2653 :contents-end contents-end
2657 "Interpret BOLD object as Org syntax.
2658 CONTENTS is the contents of the object."
2662 ;;;; Code
2665 "Parse code object at point, if any.
2667 When at a code object, return a list whose car is `code' and cdr
2668 is a plist with `:value', `:begin', `:end' and `:post-blank'
2669 keywords. Otherwise, return nil.
2671 Assume point is at the first tilde marker."
2682 :begin begin
2683 :end end
2687 "Interpret CODE object as Org syntax.
2688 CONTENTS is nil."
2692 ;;;; Entity
2695 "Parse entity at point, if any.
2697 When at an entity, return a list whose car is `entity' and cdr
2698 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2699 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2700 `:post-blank' as keywords. Otherwise, return nil.
2702 Assume point is at the beginning of the entity."
2704 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2722 :begin begin
2723 :end end
2724 :use-brackets-p bracketsp
2728 "Interpret ENTITY object as Org syntax.
2729 CONTENTS is nil."
2735 ;;;; Export Snippet
2738 "Parse export snippet at point.
2740 When at an export snippet, return a list whose car is
2741 `export-snippet' and cdr a plist with `:begin', `:end',
2742 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2743 return nil.
2745 Assume point is at the beginning of the snippet."
2761 :value value
2762 :begin begin
2763 :end end
2767 "Interpret EXPORT-SNIPPET object as Org syntax.
2768 CONTENTS is nil."
2774 ;;;; Footnote Reference
2777 "Parse footnote reference at point, if any.
2779 When at a footnote reference, return a list whose car is
2780 `footnote-reference' and cdr a plist with `:label', `:type',
2781 `:begin', `:end', `:content-begin', `:contents-end' and
2782 `:post-blank' as keywords. Otherwise, return nil."
2806 :type type
2807 :begin begin
2808 :end end
2814 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2815 CONTENTS is its definition, when inline, or nil."
2821 ;;;; Inline Babel Call
2824 "Parse inline babel call at point, if any.
2826 When at an inline babel call, return a list whose car is
2827 `inline-babel-call' and cdr a plist with `:begin', `:end',
2828 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2830 Assume point is at the beginning of the babel call."
2842 :end end
2843 :value value
2847 "Interpret INLINE-BABEL-CALL object as Org syntax.
2848 CONTENTS is nil."
2852 ;;;; Inline Src Block
2855 "Parse inline source block at point, if any.
2857 When at an inline source block, return a list whose car is
2858 `inline-src-block' and cdr a plist with `:begin', `:end',
2859 `:language', `:value', `:parameters' and `:post-blank' as
2860 keywords. Otherwise, return nil.
2862 Assume point is at the beginning of the inline src block."
2875 :value value
2876 :parameters parameters
2877 :begin begin
2878 :end end
2882 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2883 CONTENTS is nil."
2888 language
2890 body)))
2892 ;;;; Italic
2895 "Parse italic object at point, if any.
2897 When at an italic object, return a list whose car is `italic' and
2898 cdr is a plist with `:begin', `:end', `:contents-begin' and
2899 `:contents-end' and `:post-blank' keywords. Otherwise, return
2900 nil.
2902 Assume point is at the first slash marker."
2914 :end end
2915 :contents-begin contents-begin
2916 :contents-end contents-end
2920 "Interpret ITALIC object as Org syntax.
2921 CONTENTS is the contents of the object."
2925 ;;;; Latex Fragment
2928 "Parse LaTeX fragment at point, if any.
2930 When at a LaTeX fragment, return a list whose car is
2931 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2932 and `:post-blank' as keywords. Otherwise, return nil.
2934 Assume point is at the beginning of the LaTeX fragment."
2952 ;; Macro.
2961 :begin begin
2962 :end end
2966 "Interpret LATEX-FRAGMENT object as Org syntax.
2967 CONTENTS is nil."
2970 ;;;; Line Break
2973 "Parse line break at point, if any.
2975 When at a line break, return a list whose car is `line-break',
2976 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2977 Otherwise, return nil.
2979 Assume point is at the beginning of the line break."
2988 "Interpret LINE-BREAK object as Org syntax.
2989 CONTENTS is nil."
2993 ;;;; Link
2996 "Parse link at point, if any.
2998 When at a link, return a list whose car is `link' and cdr a plist
2999 with `:type', `:path', `:raw-link', `:application',
3000 `:search-option', `:begin', `:end', `:contents-begin',
3001 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3002 nil.
3004 Assume point is at the beginning of the link."
3007 end contents-begin contents-end link-end post-blank path type
3008 raw-link link search-option application)
3010 ;; Type 1: Text targeted from a radio target.
3019 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3024 ;; RAW-LINK is the original link. Expand any
3025 ;; abbreviation in it.
3029 ;; Determine TYPE of link and set PATH accordingly.
3031 ;; File type.
3035 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3038 ;; According to RFC 3986, extra whitespace should be
3039 ;; ignored when a URI is extracted.
3042 ;; Id type: PATH is the id.
3045 ;; Code-ref type: PATH is the name of the reference.
3048 ;; Custom-id type: PATH is the name of the custom id.
3051 ;; Fuzzy type: Internal link either matches a target, an
3052 ;; headline name or nothing. PATH is the target or
3053 ;; headline's name.
3055 ;; Type 3: Plain link, e.g., http://orgmode.org
3061 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3069 ;; In any case, deduce end point after trailing white space from
3070 ;; LINK-END variable.
3074 ;; Special "file" type link processing.
3076 ;; Extract opening application and search option.
3084 ;; Normalize URI.
3088 ;; Make sure TYPE always reports "file".
3092 :path path
3094 :application application
3095 :search-option search-option
3096 :begin begin
3097 :end end
3098 :contents-begin contents-begin
3099 :contents-end contents-end
3103 "Interpret LINK object as Org syntax.
3104 CONTENTS is the contents of the object, or nil."
3109 raw-link
3113 ;;;; Macro
3116 "Parse macro at point, if any.
3118 When at a macro, return a list whose car is `macro' and cdr
3119 a plist with `:key', `:args', `:begin', `:end', `:value' and
3120 `:post-blank' as keywords. Otherwise, return nil.
3122 Assume point is at the macro."
3135 :value value
3136 :args args
3137 :begin begin
3138 :end end
3142 "Interpret MACRO object as Org syntax.
3143 CONTENTS is nil."
3147 ;;;; Radio-target
3150 "Parse radio target at point, if any.
3152 When at a radio target, return a list whose car is `radio-target'
3153 and cdr a plist with `:begin', `:end', `:contents-begin',
3154 `:contents-end', `:value' and `:post-blank' as keywords.
3155 Otherwise, return nil.
3157 Assume point is at the radio target."
3169 :end end
3170 :contents-begin contents-begin
3171 :contents-end contents-end
3172 :post-blank post-blank
3176 "Interpret TARGET object as Org syntax.
3177 CONTENTS is the contents of the object."
3181 ;;;; Statistics Cookie
3184 "Parse statistics cookie at point, if any.
3186 When at a statistics cookie, return a list whose car is
3187 `statistics-cookie', and cdr a plist with `:begin', `:end',
3188 `:value' and `:post-blank' keywords. Otherwise, return nil.
3190 Assume point is at the beginning of the statistics-cookie."
3201 :end end
3202 :value value
3206 "Interpret STATISTICS-COOKIE object as Org syntax.
3207 CONTENTS is nil."
3211 ;;;; Strike-Through
3214 "Parse strike-through object at point, if any.
3216 When at a strike-through object, return a list whose car is
3217 `strike-through' and cdr is a plist with `:begin', `:end',
3218 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3219 Otherwise, return nil.
3221 Assume point is at the first plus sign marker."
3233 :end end
3234 :contents-begin contents-begin
3235 :contents-end contents-end
3239 "Interpret STRIKE-THROUGH object as Org syntax.
3240 CONTENTS is the contents of the object."
3244 ;;;; Subscript
3247 "Parse subscript at point, if any.
3249 When at a subscript object, return a list whose car is
3250 `subscript' and cdr a plist with `:begin', `:end',
3251 `:contents-begin', `:contents-end', `:use-brackets-p' and
3252 `:post-blank' as keywords. Otherwise, return nil.
3254 Assume point is at the underscore."
3268 :end end
3269 :use-brackets-p bracketsp
3270 :contents-begin contents-begin
3271 :contents-end contents-end
3275 "Interpret SUBSCRIPT object as Org syntax.
3276 CONTENTS is the contents of the object."
3279 contents))
3282 ;;;; Superscript
3285 "Parse superscript at point, if any.
3287 When at a superscript object, return a list whose car is
3288 `superscript' and cdr a plist with `:begin', `:end',
3289 `:contents-begin', `:contents-end', `:use-brackets-p' and
3290 `:post-blank' as keywords. Otherwise, return nil.
3292 Assume point is at the caret."
3306 :end end
3307 :use-brackets-p bracketsp
3308 :contents-begin contents-begin
3309 :contents-end contents-end
3313 "Interpret SUPERSCRIPT object as Org syntax.
3314 CONTENTS is the contents of the object."
3317 contents))
3320 ;;;; Table Cell
3323 "Parse table cell at point.
3324 Return a list whose car is `table-cell' and cdr is a plist
3325 containing `:begin', `:end', `:contents-begin', `:contents-end'
3326 and `:post-blank' keywords."
3334 :end end
3335 :contents-begin contents-begin
3336 :contents-end contents-end
3340 "Interpret TABLE-CELL element as Org syntax.
3341 CONTENTS is the contents of the cell, or nil."
3345 ;;;; Target
3348 "Parse target at point, if any.
3350 When at a target, return a list whose car is `target' and cdr
3351 a plist with `:begin', `:end', `:value' and `:post-blank' as
3352 keywords. Otherwise, return nil.
3354 Assume point is at the target."
3364 :end end
3365 :value value
3369 "Interpret TARGET object as Org syntax.
3370 CONTENTS is nil."
3374 ;;;; Timestamp
3385 "Parse time stamp at point, if any.
3387 When at a time stamp, return a list whose car is `timestamp', and
3388 cdr a plist with `:type', `:raw-value', `:year-start',
3389 `:month-start', `:day-start', `:hour-start', `:minute-start',
3390 `:year-end', `:month-end', `:day-end', `:hour-end',
3391 `:minute-end', `:repeater-type', `:repeater-value',
3392 `:repeater-unit', `:warning-type', `:warning-value',
3393 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3394 Otherwise, return nil.
3396 Assume point is at the beginning of the timestamp."
3415 date-start)
3426 raw-value)
3428 :repeater-type
3434 :repeater-unit
3443 :warning-unit
3446 year-start month-start day-start hour-start minute-start year-end
3447 month-end day-end hour-end minute-end)
3448 ;; Parse date-start.
3456 ;; Compute date-end. It can be provided directly in time-stamp,
3457 ;; or extracted from time range. Otherwise, it defaults to the
3458 ;; same values as date-start.
3468 :raw-value raw-value
3469 :year-start year-start
3470 :month-start month-start
3471 :day-start day-start
3472 :hour-start hour-start
3473 :minute-start minute-start
3474 :year-end year-end
3475 :month-end month-end
3476 :day-end day-end
3477 :hour-end hour-end
3478 :minute-end minute-end
3479 :begin begin
3480 :end end
3482 repeater-props
3483 warning-props))))))
3486 "Interpret TIMESTAMP object as Org syntax.
3487 CONTENTS is nil."
3506 ;; Build an Org timestamp string from TIME. ACTIVEP is
3507 ;; non-nil when time stamp is active. If WITH-TIME-P is
3508 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3509 ;; specify a time range in the timestamp. REPEAT-STRING is
3510 ;; the repeater string, if any.
3514 org-time-stamp-formats)
3515 time)))
3521 nil nil ts)))
3526 " "
3527 s
3529 ;; Return value.
3530 ts)))
3542 build-ts-string
3561 0
3569 "--"
3582 ;;;; Underline
3585 "Parse underline object at point, if any.
3587 When at an underline object, return a list whose car is
3588 `underline' and cdr is a plist with `:begin', `:end',
3589 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3590 Otherwise, return nil.
3592 Assume point is at the first underscore marker."
3604 :end end
3605 :contents-begin contents-begin
3606 :contents-end contents-end
3610 "Interpret UNDERLINE object as Org syntax.
3611 CONTENTS is the contents of the object."
3615 ;;;; Verbatim
3618 "Parse verbatim object at point, if any.
3620 When at a verbatim object, return a list whose car is `verbatim'
3621 and cdr is a plist with `:value', `:begin', `:end' and
3622 `:post-blank' keywords. Otherwise, return nil.
3624 Assume point is at the first equal sign marker."
3635 :begin begin
3636 :end end
3640 "Interpret VERBATIM object as Org syntax.
3641 CONTENTS is nil."
3645 \f
3646 ;;; Parsing Element Starting At Point
3647 ;;
3648 ;; `org-element--current-element' is the core function of this section.
3649 ;; It returns the Lisp representation of the element starting at
3650 ;; point.
3651 ;;
3652 ;; `org-element--current-element' makes use of special modes. They
3653 ;; are activated for fixed element chaining (e.g., `plain-list' >
3654 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3655 ;; `section'). Special modes are: `first-section', `item',
3656 ;; `node-property', `section' and `table-row'.
3659 "Parse the element starting at point.
3661 Return value is a list like (TYPE PROPS) where TYPE is the type
3662 of the element and PROPS a plist of properties associated to the
3663 element.
3665 Possible types are defined in `org-element-all-elements'.
3667 LIMIT bounds the search.
3669 Optional argument GRANULARITY determines the depth of the
3670 recursion. Allowed values are `headline', `greater-element',
3671 `element', `object' or nil. When it is broader than `object' (or
3672 nil), secondary values will not be parsed, since they only
3673 contain objects.
3675 Optional argument MODE, when non-nil, can be either
3676 `first-section', `section', `planning', `item', `node-property'
3677 and `table-row'.
3679 If STRUCTURE isn't provided but MODE is set to `item', it will be
3680 computed.
3682 This function assumes point is always at the beginning of the
3683 element it has to parse."
3686 ;; Determine if parsing depth allows for secondary strings
3687 ;; parsing. It only applies to elements referenced in
3688 ;; `org-element-secondary-value-alist'.
3691 ;; Item.
3694 ;; Table Row.
3696 ;; Node Property.
3698 ;; Headline.
3701 ;; Sections (must be checked after headline).
3706 limit)))
3707 ;; Planning.
3710 ;; Property drawer.
3714 ;; When not at bol, point is at the beginning of an item or
3715 ;; a footnote definition: next item is always a paragraph.
3717 ;; Clock.
3719 ;; Inlinetask.
3722 ;; From there, elements can have affiliated keywords.
3725 ;; Jumping over affiliated keywords put point off-limits.
3726 ;; Parse them as regular keywords.
3730 ;; LaTeX Environment.
3733 ;; Drawer and Property Drawer.
3736 ;; Fixed Width
3739 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3740 ;; Keywords.
3749 org-element-block-name-alist)))
3764 ;; Footnote Definition.
3767 ;; Horizontal Rule.
3770 ;; Diary Sexp.
3773 ;; Table.
3775 ;; List.
3778 limit affiliated
3780 ;; Default element: Paragraph.
3784 ;; Most elements can have affiliated keywords. When looking for an
3785 ;; element beginning, we want to move before them, as they belong to
3786 ;; that element, and, in the meantime, collect information they give
3787 ;; into appropriate properties. Hence the following function.
3790 "Collect affiliated keywords from point down to LIMIT.
3792 Return a list whose CAR is the position at the first of them and
3793 CDR a plist of keywords and values and move point to the
3794 beginning of the first line after them.
3796 As a special case, if element doesn't start at the beginning of
3797 the line (e.g., a paragraph starting an item), CAR is current
3798 position of point and CDR is nil."
3802 ;; RESTRICT is the list of objects allowed in parsed
3803 ;; keywords value.
3805 output)
3808 ;; Apply translation to RAW-KWD. From there, KWD is
3809 ;; the official keyword.
3811 org-element-keyword-translation-alist))
3812 raw-kwd))
3813 ;; Find main value for any keyword.
3819 ;; PARSEDP is non-nil when keyword should have its
3820 ;; value parsed.
3822 ;; If KWD is a dual keyword, find its secondary
3823 ;; value. Maybe parse it.
3831 ;; Attribute a property name to KWD.
3833 ;; Now set final shape for VALUE.
3839 nil restrict)))
3843 ;; Attributes can always appear on multiple lines.
3846 ;; Eventually store the new value in OUTPUT.
3848 ;; Move to next keyword.
3850 ;; If affiliated keywords are orphaned: move back to first one.
3851 ;; They will be parsed as a paragraph.
3853 ;; Return value.
3857 \f
3858 ;;; The Org Parser
3859 ;;
3860 ;; The two major functions here are `org-element-parse-buffer', which
3861 ;; parses Org syntax inside the current buffer, taking into account
3862 ;; region, narrowing, or even visibility if specified, and
3863 ;; `org-element-parse-secondary-string', which parses objects within
3864 ;; a given string.
3865 ;;
3866 ;; The (almost) almighty `org-element-map' allows to apply a function
3867 ;; on elements or objects matching some type, and accumulate the
3868 ;; resulting values. In an export situation, it also skips unneeded
3869 ;; parts of the parse tree.
3872 "Recursively parse the buffer and return structure.
3873 If narrowing is in effect, only parse the visible part of the
3874 buffer.
3876 Optional argument GRANULARITY determines the depth of the
3877 recursion. It can be set to the following symbols:
3879 `headline' Only parse headlines.
3880 `greater-element' Don't recurse into greater elements excepted
3881 headlines and sections. Thus, elements
3882 parsed are the top-level ones.
3883 `element' Parse everything but objects and plain text.
3884 `object' Parse the complete buffer (default).
3886 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3887 elements.
3889 An element or an objects is represented as a list with the
3890 pattern (TYPE PROPERTIES CONTENTS), where :
3892 TYPE is a symbol describing the element or object. See
3893 `org-element-all-elements' and `org-element-all-objects' for an
3894 exhaustive list of such symbols. One can retrieve it with
3895 `org-element-type' function.
3897 PROPERTIES is the list of attributes attached to the element or
3898 object, as a plist. Although most of them are specific to the
3899 element or object type, all types share `:begin', `:end',
3900 `:post-blank' and `:parent' properties, which respectively
3901 refer to buffer position where the element or object starts,
3902 ends, the number of white spaces or blank lines after it, and
3903 the element or object containing it. Properties values can be
3904 obtained by using `org-element-property' function.
3906 CONTENTS is a list of elements, objects or raw strings
3907 contained in the current element or object, when applicable.
3908 One can access them with `org-element-contents' function.
3910 The Org buffer has `org-data' as type and nil as properties.
3911 `org-element-map' function can be used to find specific elements
3912 or objects within the parse tree.
3914 This function assumes that current major mode is `org-mode'."
3920 ;; Start in `first-section' mode so text before the first
3921 ;; headline belongs to a section.
3925 "Recursively parse objects in STRING and return structure.
3927 RESTRICTION is a symbol limiting the object types that will be
3928 looked after.
3930 Optional argument PARENT, when non-nil, is the element or object
3931 containing the secondary string. It is used to set correctly
3932 `:parent' property within the string."
3945 secondary))))
3949 "Map a function on selected elements or objects.
3951 DATA is a parse tree, an element, an object, a string, or a list
3952 of such constructs. TYPES is a symbol or list of symbols of
3953 elements or objects types (see `org-element-all-elements' and
3954 `org-element-all-objects' for a complete list of types). FUN is
3955 the function called on the matching element or object. It has to
3956 accept one argument: the element or object itself.
3958 When optional argument INFO is non-nil, it should be a plist
3959 holding export options. In that case, parts of the parse tree
3960 not exportable according to that property list will be skipped.
3962 When optional argument FIRST-MATCH is non-nil, stop at the first
3963 match for which FUN doesn't return nil, and return that value.
3965 Optional argument NO-RECURSION is a symbol or a list of symbols
3966 representing elements or objects types. `org-element-map' won't
3967 enter any recursive element or object whose type belongs to that
3968 list. Though, FUN can still be applied on them.
3970 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3971 apply to matching objects within parsed affiliated keywords (see
3972 `org-element-parsed-keywords').
3974 Nil values returned from FUN do not appear in the results.
3977 Examples:
3978 ---------
3980 Assuming TREE is a variable containing an Org buffer parse tree,
3981 the following example will return a flat list of all `src-block'
3982 and `example-block' elements in it:
3984 \(org-element-map tree '(example-block src-block) #'identity)
3986 The following snippet will find the first headline with a level
3989 \(org-element-map tree 'headline
3990 \(lambda (hl)
3991 \(and (= (org-element-property :level hl) 1)
3993 \(org-element-property :begin hl)))
3994 nil t)
3996 The next example will return a flat list of all `plain-list' type
3997 elements in TREE that are not a sub-list themselves:
3999 \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
4001 Eventually, this example will return a flat list of all `bold'
4002 type objects containing a `latex-snippet' type object, even
4003 looking into captions:
4005 \(org-element-map tree 'bold
4006 \(lambda (b)
4007 \(and (org-element-map b 'latex-snippet #'identity nil t) b))
4008 nil nil nil t)"
4009 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4013 ;; Recursion depth is determined by --CATEGORY.
4020 ;; If one object is found, the function has to
4021 ;; recurse into every object.
4024 ;; If one regular element is found, the
4025 ;; function has to recurse, at least, into
4026 ;; every element it encounters.
4029 --acc
4030 --walk-tree
4033 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4034 ;; holding contextual information.
4038 ;; Ignored element in an export context.
4040 ;; List of elements or objects.
4042 ;; Unconditionally enter parse trees.
4046 ;; Check if TYPE is matching among TYPES. If so,
4047 ;; apply FUN to --DATA and accumulate return value
4048 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4054 ;; If --DATA has a secondary string that can contain
4055 ;; objects with their type among TYPES, look into it.
4062 ;; If --DATA has any parsed affiliated keywords and
4063 ;; WITH-AFFILIATED is non-nil, look for objects in
4064 ;; them.
4071 ;; Pay attention to the type of parsed keyword.
4072 ;; In particular, preserve order for multiple
4073 ;; keywords.
4086 ;; Determine if a recursion into --DATA is possible.
4088 ;; --TYPE is explicitly removed from recursion.
4090 ;; --DATA has no contents.
4092 ;; Looking for greater elements but --DATA is simply
4093 ;; an element or an object.
4096 ;; Looking for elements but --DATA is an object.
4099 ;; In any other case, map contents.
4103 ;; Return value in a proper order.
4107 ;; The following functions are internal parts of the parser.
4108 ;;
4109 ;; The first one, `org-element--parse-elements' acts at the element's
4110 ;; level.
4111 ;;
4112 ;; The second one, `org-element--parse-objects' applies on all objects
4113 ;; of a paragraph or a secondary string. It calls
4114 ;; `org-element--object-lex' to find the next object in the current
4115 ;; container.
4118 "Return next special mode according to TYPE, or nil.
4119 TYPE is a symbol representing the type of an element or object
4120 containing next element if PARENTP is non-nil, or before it
4121 otherwise. Modes can be either `first-section', `item',
4122 `node-property', `planning', `property-drawer', `section',
4123 `table-row' or nil."
4139 "Parse elements between BEG and END positions.
4141 MODE prioritizes some elements over the others. It can be set to
4142 `first-section', `section', `planning', `item', `node-property'
4143 or `table-row'.
4145 When value is `item', STRUCTURE will be used as the current list
4146 structure.
4148 GRANULARITY determines the depth of the recursion. See
4149 `org-element-parse-buffer' for more information.
4151 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4152 elements.
4154 Elements are accumulated into ACC."
4157 ;; Visible only: skip invisible parts at the beginning of the
4158 ;; element.
4161 ;; When parsing only headlines, skip any text before first one.
4164 ;; Main loop start.
4166 ;; Find current element's type and parse it accordingly to
4167 ;; its category.
4169 end granularity mode structure))
4173 ;; Visible only: skip invisible parts between siblings.
4176 ;; Fill ELEMENT contents by side-effect.
4178 ;; If element has no contents, don't modify it.
4180 ;; Greater element: parse it between `contents-begin' and
4181 ;; `contents-end'. Make sure GRANULARITY allows the
4182 ;; recursion, or ELEMENT is a headline, in which case going
4183 ;; inside is mandatory, in order to get sub-level headings.
4191 ;; Possibly switch to a special mode.
4195 granularity visible-only element))
4196 ;; ELEMENT has contents. Parse objects inside, if
4197 ;; GRANULARITY allows it.
4203 ;; Update mode.
4205 ;; Return result.
4206 acc))
4209 "Return next object in current buffer or nil.
4210 RESTRICTION is a list of object types, as symbols, that should be
4211 looked after. This function assumes that the buffer is narrowed
4212 to an appropriate container (e.g., a paragraph)."
4220 found)
4285 ;; This is probably a plain link.
4291 ;; Radio link.
4296 "Parse objects between BEG and END and return recursive structure.
4298 Objects are accumulated in ACC.
4300 RESTRICTION is a list of object successors which are allowed in
4301 the current object."
4309 ;; 1. Text before any object. Untabify it.
4314 acc
4318 ;; 2. Object...
4321 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4322 ;; a recursive type.
4330 ;; 3. Text after last object. Untabify it.
4334 acc
4338 ;; Result.
4339 acc)))
4342 \f
4343 ;;; Towards A Bijective Process
4344 ;;
4345 ;; The parse tree obtained with `org-element-parse-buffer' is really
4346 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4347 ;; interpreted and expanded into a string with canonical Org syntax.
4348 ;; Hence `org-element-interpret-data'.
4349 ;;
4350 ;; The function relies internally on
4351 ;; `org-element--interpret-affiliated-keywords'.
4353 ;;;###autoload
4355 "Interpret DATA as Org syntax.
4357 DATA is a parse tree, an element, an object or a secondary string
4358 to interpret.
4360 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4361 new types that should be treated as objects. An unknown type not
4362 belonging to this list is seen as a pseudo-element instead. Both
4363 pseudo-objects and pseudo-elements are transparent entities, i.e.
4364 only their contents are interpreted.
4366 Return Org syntax as a string."
4370 "Interpret DATA as Org syntax.
4372 DATA is a parse tree, an element, an object or a secondary string
4373 to interpret. PARENT is used for recursive calls. It contains
4374 the element or object containing data, or nil. PSEUDO-OBJECTS
4375 are list of symbols defining new element or object types.
4376 Unknown types that don't belong to this list are treated as
4377 pseudo-elements instead.
4379 Return Org syntax as a string."
4381 ;; Find interpreter for current object or element. If it
4382 ;; doesn't exist (e.g. this is a pseudo object or element),
4383 ;; return contents, if any.
4389 ;; Secondary string.
4395 ;; Full Org document.
4401 ;; Plain text: return it.
4403 ;; Element or object without contents.
4405 ;; Element or object with contents.
4408 ;; Recursively interpret contents.
4414 data
4415 ;; Fix indentation of elements containing
4416 ;; objects. We ignore `table-row' elements
4417 ;; as they are one line long anyway.
4419 data
4420 ;; When normalizing first paragraph of an
4421 ;; item or a footnote-definition, ignore
4422 ;; first line's indentation.
4429 ;; Build white spaces. If no `:post-blank' property is
4430 ;; specified, assume its value is 0.
4441 "Return ELEMENT's affiliated keywords as Org syntax.
4442 If there is no affiliated keyword, return the empty string."
4452 ": "
4455 value)
4463 ;; All attribute keywords can have multiple lines.
4469 ;; List all ELEMENT's properties matching an attribute line or an
4470 ;; affiliated keyword, but ignore translated keywords since they
4471 ;; cannot belong to the property list.
4478 org-element-keyword-translation-alist)))))
4479 collect prop)
4482 ;; Because interpretation of the parse tree must return the same
4483 ;; number of blank lines between elements and the same number of white
4484 ;; space after objects, some special care must be given to white
4485 ;; spaces.
4486 ;;
4487 ;; The first function, `org-element-normalize-string', ensures any
4488 ;; string different from the empty string will end with a single
4489 ;; newline character.
4490 ;;
4491 ;; The second function, `org-element-normalize-contents', removes
4492 ;; global indentation from the contents of the current element.
4495 "Ensure string S ends with a single newline character.
4497 If S isn't a string return it unchanged. If S is the empty
4498 string, return it. Otherwise, return a new string with a single
4499 newline character at its end."
4507 "Normalize plain text in ELEMENT's contents.
4509 ELEMENT must only contain plain text and objects.
4511 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4512 indentation to compute maximal common indentation.
4514 Return the normalized element that is element with global
4515 indentation removed from its contents. The function assumes that
4516 indentation is not done with TAB characters."
4518 find-min-ind ; For byte-compiler.
4520 ;; Return minimal common indentation within BLOB. This is
4521 ;; done by walking recursively BLOB and updating MIN-IND
4522 ;; along the way. FIRST-FLAG is non-nil when the first
4523 ;; string hasn't been seen yet. It is required as this
4524 ;; string is the only one whose indentation doesn't happen
4525 ;; after a newline character.
4532 ;; An indentation of zero means no string will be
4533 ;; modified. Quit the process.
4543 ;; Find minimal indentation in ELEMENT.
4546 ;; Build ELEMENT back, replacing each string with the same
4547 ;; string minus common indentation.
4552 ;; Return BLOB with all its strings indentation
4553 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4554 ;; is non-nil when the first string hasn't been seen
4555 ;; yet.
4570 org-element-recursive-objects)
4574 blob))))
4578 \f
4579 ;;; Cache
4580 ;;
4581 ;; Implement a caching mechanism for `org-element-at-point' and
4582 ;; `org-element-context', which see.
4583 ;;
4584 ;; A single public function is provided: `org-element-cache-reset'.
4585 ;;
4586 ;; Cache is enabled by default, but can be disabled globally with
4587 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4588 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4589 ;; can be tweaked to control caching behaviour.
4590 ;;
4591 ;; Internally, parsed elements are stored in an AVL tree,
4592 ;; `org-element--cache'. This tree is updated lazily: whenever
4593 ;; a change happens to the buffer, a synchronization request is
4594 ;; registered in `org-element--cache-sync-requests' (see
4595 ;; `org-element--cache-submit-request'). During idle time, requests
4596 ;; are processed by `org-element--cache-sync'. Synchronization also
4597 ;; happens when an element is required from the cache. In this case,
4598 ;; the process stops as soon as the needed element is up-to-date.
4599 ;;
4600 ;; A synchronization request can only apply on a synchronized part of
4601 ;; the cache. Therefore, the cache is updated at least to the
4602 ;; location where the new request applies. Thus, requests are ordered
4603 ;; from left to right and all elements starting before the first
4604 ;; request are correct. This property is used by functions like
4605 ;; `org-element--cache-find' to retrieve elements in the part of the
4606 ;; cache that can be trusted.
4607 ;;
4608 ;; A request applies to every element, starting from its original
4609 ;; location (or key, see below). When a request is processed, it
4610 ;; moves forward and may collide the next one. In this case, both
4611 ;; requests are merged into a new one that starts from that element.
4612 ;; As a consequence, the whole synchronization complexity does not
4613 ;; depend on the number of pending requests, but on the number of
4614 ;; elements the very first request will be applied on.
4615 ;;
4616 ;; Elements cannot be accessed through their beginning position, which
4617 ;; may or may not be up-to-date. Instead, each element in the tree is
4618 ;; associated to a key, obtained with `org-element--cache-key'. This
4619 ;; mechanism is robust enough to preserve total order among elements
4620 ;; even when the tree is only partially synchronized.
4621 ;;
4622 ;; Objects contained in an element are stored in a hash table,
4623 ;; `org-element--cache-objects'.
4627 "Non nil when Org parser should cache its results.
4634 "Maximum duration, as a time value, for a cache synchronization.
4635 If the synchronization is not over after this delay, the process
4636 pauses and resumes after `org-element-cache-sync-break'
4640 "Duration, as a time value, of the pause between synchronizations.
4644 ;;;; Data Structure
4647 "AVL tree used to cache elements.
4648 Each node of the tree contains an element. Comparison is done
4649 with `org-element--cache-compare'. This cache is used in
4653 "Hash table used as to cache objects.
4654 Key is an element, as returned by `org-element-at-point', and
4655 value is an alist where each association is:
4657 \(PARENT COMPLETEP . OBJECTS)
4659 where PARENT is an element or object, COMPLETEP is a boolean,
4660 non-nil when all direct children of parent are already cached and
4661 OBJECTS is a list of such children, as objects, from farthest to
4662 closest.
4665 contained within a paragraph
4669 If the paragraph is completely parsed, OBJECTS-DATA will be
4671 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4672 \(BOLD-OBJECT t ENTITY-OBJECT))
4674 whereas in a partially parsed paragraph, it could be
4676 \((PARAGRAPH nil ENTITY-OBJECT))
4681 "List of pending synchronization requests.
4683 A request is a vector with the following pattern:
4685 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4687 Processing a synchronization request consists of three phases:
4689 0. Delete modified elements,
4690 1. Fill missing area in cache,
4691 2. Shift positions and re-parent elements after the changes.
4693 During phase 0, NEXT is the key of the first element to be
4694 removed, BEG and END is buffer position delimiting the
4695 modifications. Elements starting between them (inclusive) are
4696 removed and so are those contained within OUTREACH. PARENT, when
4697 non-nil, is the parent of the first element to be removed.
4699 During phase 1, NEXT is the key of the next known element in
4700 cache and BEG its beginning position. Parse buffer between that
4701 element and the one before it in order to determine the parent of
4702 the next element. Set PARENT to the element containing NEXT.
4704 During phase 2, NEXT is the key of the next element to shift in
4705 the parse tree. All elements starting from this one have their
4706 properties relatives to buffer positions shifted by integer
4707 OFFSET and, if they belong to element PARENT, are adopted by it.
4715 "Hash table used to store keys during synchronization.
4719 "Return a unique key for ELEMENT in cache tree.
4721 Keys are used to keep a total order among elements in the cache.
4722 Comparison is done with `org-element--cache-key-less-p'.
4724 When no synchronization is taking place, a key is simply the
4725 beginning position of the element, or that position plus one in
4726 the case of an first item (respectively row) in
4727 a list (respectively a table).
4729 During a synchronization, the key is the one the element had when
4730 the cache was synchronized for the last time. Elements added to
4731 cache during the synchronization get a new key generated with
4732 `org-element--cache-generate-key'.
4734 Such keys are stored in `org-element--cache-sync-keys'. The hash
4735 table is cleared once the synchronization is complete."
4738 ;; Increase beginning position of items (respectively
4739 ;; table rows) by one, so the first item can get
4740 ;; a different key from its parent list (respectively
4741 ;; table).
4744 begin)))
4747 key))))
4750 "Generate a key between LOWER and UPPER.
4752 LOWER and UPPER are integers or lists, possibly empty.
4754 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4755 a unique key, as an integer or a list of integers, according to
4756 the following rules:
4758 - LOWER and UPPER are compared level-wise until values differ.
4760 - If, at a given level, LOWER and UPPER differ from more than
4761 2, the new key shares all the levels above with LOWER and
4762 gets a new level. Its value is the mean between LOWER and
4763 UPPER:
4765 \(1 2) + (1 4) --> (1 3)
4767 - If LOWER has no value to compare with, it is assumed that its
4768 value is `most-negative-fixnum'. E.g.,
4770 \(1 1) + (1 1 2)
4772 is equivalent to
4774 \(1 1 m) + (1 1 2)
4776 where m is `most-negative-fixnum'. Likewise, if UPPER is
4777 short of levels, the current value is `most-positive-fixnum'.
4779 - If they differ from only one, the new key inherits from
4780 current LOWER level and fork it at the next level. E.g.,
4782 \(2 1) + (3 3)
4784 is equivalent to
4786 \(2 1) + (2 M)
4788 where M is `most-positive-fixnum'.
4790 - If the key is only one level long, it is returned as an
4791 integer:
4793 \(1 2) + (3 2) --> 2
4795 When they are not equals, the function assumes that LOWER is
4796 lesser than UPPER, per `org-element--cache-key-less-p'."
4800 skip-upper key)
4811 ;; When at a given level, LOWER and UPPER differ from
4812 ;; 1, ignore UPPER altogether. Instead create a key
4813 ;; between LOWER and the greatest key with the same
4814 ;; prefix as LOWER so far.
4820 "Non-nil if key A is less than key B.
4821 A and B are either integers or lists of integers, as returned by
4822 `org-element--cache-key'."
4830 ;; If A is empty, either keys are equal (B is also empty) and
4831 ;; we return nil, or A is lesser than B (B is longer) and we
4832 ;; return a non-nil value.
4833 ;;
4834 ;; If A is not empty, B is necessarily empty and A is greater
4835 ;; than B (A is longer). Therefore, return nil.
4839 "Non-nil when element A is located before element B."
4844 "Return root value in cache.
4845 This function assumes `org-element--cache' is a valid AVL tree."
4849 ;;;; Tools
4852 "Non-nil when cache is active in current buffer."
4857 "Find element in cache starting at POS or before.
4859 POS refers to a buffer position.
4861 When optional argument SIDE is non-nil, the function checks for
4862 elements starting at or past POS instead. If SIDE is `both', the
4863 function returns a cons cell where car is the first element
4864 starting at or before POS and cdr the first element starting
4865 after POS.
4867 The function can only find elements in the synchronized part of
4868 the cache."
4872 lower upper)
4887 ;; We found an element in cache starting at POS. If `side'
4888 ;; is `both' we also want the next one in order to generate
4889 ;; a key in-between.
4890 ;;
4891 ;; If the element is the first row or item in a table or
4892 ;; a plain list, we always return the table or the plain
4893 ;; list.
4894 ;;
4895 ;; In any other case, we return the element found.
4904 lower parent
4905 upper parent)))))
4908 lower element
4909 upper element)))))
4916 "Store ELEMENT in current buffer's cache, if allowed.
4917 When optional argument DATA is non-nil, assume is it object data
4918 relative to ELEMENT and store it in the objects cache."
4922 ;; During synchronization, first build an appropriate key
4923 ;; for the new element so `avl-tree-enter' can insert it at
4924 ;; the right spot in the cache.
4933 org-element--cache-sync-keys)))
4935 ;; Headlines are not stored in cache, so objects in titles are
4936 ;; not stored either.
4941 "Remove ELEMENT from cache.
4942 Assume ELEMENT belongs to cache and that a cache is active."
4947 ;;;; Synchronization
4950 "Set idle timer for cache synchronization in BUFFER."
4957 org-element-cache-sync-idle-time))
4958 nil
4959 #'org-element--cache-sync
4960 buffer)))
4963 "Non-nil when synchronization process should be interrupted.
4964 TIME-LIMIT is a time value or nil."
4970 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4972 Properties containing buffer positions are `:begin', `:end',
4973 `:contents-begin', `:contents-end' and `:structure'. When
4974 optional argument PROPS is a list of keywords, only shift
4975 properties provided in that list.
4977 Properties are modified by side-effect."
4979 ;; Shift `:structure' property for the first plain list only: it
4980 ;; is the only one that really matters and it prevents from
4981 ;; shifting it more than once.
4995 "Synchronize cache with recent modification in BUFFER.
4997 When optional argument THRESHOLD is non-nil, do the
4998 synchronization for all elements starting before or at threshold,
4999 then exit. Otherwise, synchronize cache for as long as
5000 `org-element-cache-sync-duration' or until Emacs leaves idle
5001 state.
5003 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5004 not registered yet in the cache are going to happen. It is used
5005 in `org-element--cache-submit-request', where cache is partially
5006 updated before current modification are actually submitted."
5017 request
5019 threshold
5022 org-element-cache-sync-duration))
5023 future-change)
5024 ;; Request processed. Merge current and next offsets and
5025 ;; transfer ending position.
5031 ;; If more requests are awaiting, set idle timer accordingly.
5032 ;; Otherwise, reset keys.
5039 "Process synchronization REQUEST for all entries before NEXT.
5041 REQUEST is a vector, built by `org-element--cache-submit-request'.
5043 NEXT is a cache key, as returned by `org-element--cache-key'.
5045 When non-nil, THRESHOLD is a buffer position. Synchronization
5046 stops as soon as a shifted element begins after it.
5048 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5049 after this time or when Emacs exits idle state.
5051 When non-nil, FUTURE-CHANGE is a buffer position where changes
5052 not registered yet in the cache are going to happen. See
5053 `org-element--cache-submit-request' for more information.
5055 Throw `interrupt' if the process stops before completing the
5056 request."
5059 ;; Phase 0.
5060 ;;
5061 ;; Delete all elements starting after BEG, but not after buffer
5062 ;; position END or past element with key NEXT.
5063 ;;
5064 ;; At each iteration, we start again at tree root since
5065 ;; a deletion modifies structure of the balanced tree.
5073 ;; Find first element in cache with key BEG or after it.
5083 data-key key
5086 data-key key
5087 node nil)))))
5096 up))
5102 ;; No element starting after modifications left in
5103 ;; cache: further processing is futile.
5106 ;; Phase 1.
5107 ;;
5108 ;; Phase 0 left a hole in the cache. Some elements after it
5109 ;; could have parents within. For example, in the following
5110 ;; buffer:
5111 ;;
5112 ;; - item
5113 ;;
5114 ;;
5115 ;; Paragraph1
5116 ;;
5117 ;; Paragraph2
5118 ;;
5119 ;; if we remove a blank line between "item" and "Paragraph1",
5120 ;; everything down to "Paragraph2" is removed from cache. But
5121 ;; the paragraph now belongs to the list, and its `:parent'
5122 ;; property no longer is accurate.
5123 ;;
5124 ;; Therefore we need to parse again elements in the hole, or at
5125 ;; least in its last section, so that we can re-parent
5126 ;; subsequent elements, during phase 2.
5127 ;;
5128 ;; Note that we only need to get the parent from the first
5129 ;; element in cache after the hole.
5130 ;;
5131 ;; When next key is lesser or equal to the current one, delegate
5132 ;; phase 1 processing to next request in order to preserve key
5133 ;; order among requests.
5141 ;; Next element will start at its beginning position plus
5142 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5143 ;; contains the real beginning position of the first element to
5144 ;; shift and re-parent.
5148 ;; Changes are going to happen around this element and
5149 ;; they will trigger another phase 1 request. Skip the
5150 ;; current one.
5156 ;; Phase 2.
5157 ;;
5158 ;; Shift all elements starting from key START, but before NEXT, by
5159 ;; OFFSET, and re-parent them when appropriate.
5160 ;;
5161 ;; Elements are modified by side-effect so the tree structure
5162 ;; remains intact.
5163 ;;
5164 ;; Once THRESHOLD, if any, is reached, or once there is an input
5165 ;; pending, exit. Before leaving, the current synchronization
5166 ;; request is updated.
5173 exit-flag)
5174 ;; No re-parenting nor shifting planned: request is over.
5184 ;; We reached NEXT. Request is complete.
5186 ;; Handle interruption request. Update current request.
5191 ;; Shift element.
5194 ;; Shift associated objects data, if any.
5199 ;; Update PARENT and re-parent DATA, only when
5200 ;; necessary. Propagate new structures for lists.
5214 ;; Cache is up-to-date past THRESHOLD. Request
5215 ;; interruption.
5220 ;; We reached end of tree: synchronization complete.
5221 t)))
5224 "Parse elements in current section, down to POS.
5226 Start parsing from the closest between the last known element in
5227 cache or headline above. Return the smallest element containing
5228 POS.
5230 When optional argument SYNCP is non-nil, return the parent of the
5231 element containing POS instead. In that case, it is also
5232 possible to provide TIME-LIMIT, which is a time value specifying
5233 when the parsing should stop. The function throws `interrupt' if
5234 the process stopped before finding the expected result."
5241 element next mode)
5243 ;; Nothing in cache before point: start parsing from first
5244 ;; element following headline above, or first element in
5245 ;; buffer.
5252 ;; Cache returned exact match: return it.
5255 ;; There's a headline between cached value and POS: cached
5256 ;; value is invalid. Start parsing from first element
5257 ;; following the headline.
5264 ;; Check if CACHED or any of its ancestors contain point.
5265 ;;
5266 ;; If there is such an element, we inspect it in order to know
5267 ;; if we return it or if we need to parse its contents.
5268 ;; Otherwise, we just start parsing from current location,
5269 ;; which is right after the top-most element containing
5270 ;; CACHED.
5271 ;;
5272 ;; As a special case, if POS is at the end of the buffer, we
5273 ;; want to return the innermost element ending there.
5274 ;;
5275 ;; Also, if we find an ancestor and discover that we need to
5276 ;; parse its contents, make sure we don't start from
5277 ;; `:contents-begin', as we would otherwise go past CACHED
5278 ;; again. Instead, in that situation, we will resume parsing
5279 ;; from NEXT, which is located after CACHED or its higher
5280 ;; ancestor not containing point.
5292 ;; Parse successively each element until we reach POS.
5305 end 'element mode
5312 ;; Skip any element ending before point. Also skip
5313 ;; element ending at point (unless it is also the end of
5314 ;; buffer) since we're sure that another element begins
5315 ;; after it.
5319 ;; A non-greater element contains point: return it.
5322 ;; Otherwise, we have to decide if ELEMENT really
5323 ;; contains POS. In that case we start parsing from
5324 ;; contents' beginning.
5325 ;;
5326 ;; If POS is at contents' beginning but it is also at
5327 ;; the beginning of the first item in a list or a table.
5328 ;; In that case, we need to create an anchor for that
5329 ;; list or table, so return it.
5330 ;;
5331 ;; Also, if POS is at the end of the buffer, no element
5332 ;; can start after it, but more than one may end there.
5333 ;; Arbitrarily, we choose to return the innermost of
5334 ;; such elements.
5347 parent element
5348 end cend))))
5349 ;; Otherwise, return ELEMENT as it is the smallest
5350 ;; element containing POS.
5355 ;;;; Staging Buffer Changes
5361 ;; Blocks
5363 ;; LaTeX environments.
5365 ;; Drawers.
5368 "Regexp matching a sensitive line, structure wise.
5369 A sensitive line is a headline, inlinetask, block, drawer, or
5370 latex-environment boundary. When such a line is modified,
5371 structure changes in the document may propagate in the whole
5375 "Non-nil when a sensitive line is about to be changed.
5379 "Request extension of area going to be modified if needed.
5380 BEG and END are the beginning and end of the range of changed
5381 text. See `before-change-functions' for more information."
5391 'headline
5394 org-element--cache-sensitive-re bottom t)))))))))
5397 "Update buffer modifications for current buffer.
5398 BEG and END are the beginning and end of the range of changed
5399 text, and the length in bytes of the pre-change text replaced by
5400 that range. See `after-change-functions' for more information."
5408 ;; Determine if modified area needs to be extended, according
5409 ;; to both previous and current state. We make a special
5410 ;; case for headline editing: if a headline is modified but
5411 ;; not removed, do not extend.
5420 org-element--cache-sensitive-re bottom t))))
5421 ;; Effectively extend modified area.
5429 ;; Store synchronization request.
5432 ;; Activate a timer to process the request during idle time.
5436 "Return first element to remove from cache.
5438 BEG and END are buffer positions delimiting buffer modifications.
5439 OFFSET is the size of the changes.
5441 Returned element is usually the first element in cache containing
5442 any position between BEG and END. As an exception, greater
5443 elements around the changes that are robust to contents
5444 modifications are preserved and updated according to the
5445 changes."
5455 quote-block special-block))
5460 ;; UP is a robust greater element containing changes.
5461 ;; We only need to extend its ending boundaries.
5467 ;; We're at top level element containing ELEMENT: if it's
5468 ;; altered by buffer modifications, it is first element in
5469 ;; cache to be removed. Otherwise, that first element is the
5470 ;; following one.
5471 ;;
5472 ;; As a special case, do not remove BEFORE if it is a robust
5473 ;; container for current changes.
5475 before)))))
5478 "Submit a new cache synchronization request for current buffer.
5479 BEG and END are buffer positions delimiting the minimal area
5480 where cache data should be removed. OFFSET is the size of the
5481 change, as an integer."
5483 delete-to delete-from)
5488 ;; Current changes can be merged with first sync request: we
5489 ;; can save a partial cache synchronization.
5492 ;; If last change happened within area to be removed, extend
5493 ;; boundaries of robust parents, if any. Otherwise, find
5494 ;; first element to remove and update request accordingly.
5506 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5507 ;; if any, is no longer a 0-phase request, thus ensuring that
5508 ;; phases are properly ordered. We need to provide OFFSET as
5509 ;; optional parameter since current modifications are not known
5510 ;; yet to the otherwise correct part of the cache (i.e, before
5511 ;; the first request).
5518 ;; When changes happen before the first known
5519 ;; element, re-parent and shift the rest of the
5520 ;; cache.
5522 ;; Otherwise, we find the first non robust
5523 ;; element containing END. All elements between
5524 ;; FIRST and this one are to be removed.
5525 ;;
5526 ;; Among them, some could be located outside the
5527 ;; synchronized part of the cache, in which case
5528 ;; comparing buffer positions to find them is
5529 ;; useless. Instead, we store the element
5530 ;; containing them in the request itself. All
5531 ;; its children will be removed.
5543 element up))
5546 org-element--cache-sync-requests)
5547 ;; No element to remove. No need to re-parent either.
5548 ;; Simply shift additional elements, if any, by OFFSET.
5553 ;;;; Public Functions
5555 ;;;###autoload
5557 "Reset cache in current buffer.
5558 When optional argument ALL is non-nil, reset cache in all Org
5559 buffers."
5577 ;;;###autoload
5579 "Refresh cache at position POS."
5586 \f
5587 ;;; The Toolbox
5588 ;;
5589 ;; The first move is to implement a way to obtain the smallest element
5590 ;; containing point. This is the job of `org-element-at-point'. It
5591 ;; basically jumps back to the beginning of section containing point
5592 ;; and proceed, one element after the other, with
5593 ;; `org-element--current-element' until the container is found. Note:
5594 ;; When using `org-element-at-point', secondary values are never
5595 ;; parsed since the function focuses on elements, not on objects.
5596 ;;
5597 ;; At a deeper level, `org-element-context' lists all elements and
5598 ;; objects containing point.
5599 ;;
5600 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5601 ;; internally by navigation and manipulation tools.
5604 ;;;###autoload
5606 "Determine closest element around point.
5608 Return value is a list like (TYPE PROPS) where TYPE is the type
5609 of the element and PROPS a plist of properties associated to the
5610 element.
5612 Possible types are defined in `org-element-all-elements'.
5613 Properties depend on element or object type, but always include
5614 `:begin', `:end', `:parent' and `:post-blank' properties.
5616 As a special case, if point is at the very beginning of the first
5617 item in a list or sub-list, returned element will be that list
5618 instead of the item. Likewise, if point is at the beginning of
5619 the first row of a table, returned element will be the table
5620 instead of the first row.
5622 When point is at the end of the buffer, return the innermost
5623 element ending there."
5629 ;; Within blank lines at the beginning of buffer, return nil.
5631 ;; Within blank lines right after a headline, return that
5632 ;; headline.
5636 ;; Otherwise parse until we find element containing ORIGIN.
5643 ;;;###autoload
5645 "Return smallest element or object around point.
5647 Return value is a list like (TYPE PROPS) where TYPE is the type
5648 of the element or object and PROPS a plist of properties
5649 associated to it.
5651 Possible types are defined in `org-element-all-elements' and
5652 `org-element-all-objects'. Properties depend on element or
5653 object type, but always include `:begin', `:end', `:parent' and
5654 `:post-blank'.
5656 As a special case, if point is right after an object and not at
5657 the beginning of any other object, return that object.
5659 Optional argument ELEMENT, when non-nil, is the closest element
5660 containing point, as returned by `org-element-at-point'.
5661 Providing it allows for quicker computation."
5667 ;; If point is inside an element containing objects or
5668 ;; a secondary string, narrow buffer to the container and
5669 ;; proceed with parsing. Otherwise, return ELEMENT.
5671 ;; At a parsed affiliated keyword, check if we're inside main
5672 ;; or dual value.
5679 org-element-parsed-keywords))
5688 ;; Also change type to retrieve correct restrictions.
5690 ;; At an item, objects can only be located within tag, if any.
5700 ;; At an headline or inlinetask, objects are in title.
5707 ;; At a paragraph, a table-row or a verse block, objects are
5708 ;; located within their contents.
5712 ;; CBEG is nil for table rules.
5717 ;; At a parsed keyword, objects are located within value.
5720 org-element-document-properties))
5727 ;; At a planning line, if point is at a timestamp, return it,
5728 ;; otherwise, return element.
5736 ;; All other locations cannot contain objects: bail out.
5746 next object-data last)
5750 ;; When entering PARENT for the first time, get list
5751 ;; of objects within known so far. Store it in
5752 ;; OBJECT-DATA.
5757 ;; Find NEXT object for analysis.
5759 ;; If NEXT is non-nil, we already exhausted the
5760 ;; cache so we can parse buffer to find the object
5761 ;; after it.
5763 ;; Otherwise, check if cache can help us.
5774 ;; Cache contains the information needed.
5777 pos)
5779 pos)
5785 ;; If we have a new object to analyze, store it in
5786 ;; cache. Otherwise record that there is nothing
5787 ;; more to parse in this element at this depth.
5792 ;; Process NEXT, if any, in order to know if we need
5793 ;; to skip it, return it or move into it.
5800 ;; Skip objects ending before point. Also skip
5801 ;; objects ending at point unless it is also the
5802 ;; end of buffer, since we want to return the
5803 ;; innermost object.
5806 ;; For convenience, when object ends at POS,
5807 ;; without any space, store it in LAST, as we
5808 ;; will return it if no object starts here.
5812 ;; If POS is within a container object, move
5813 ;; into that object.
5817 ;; At contents' end, if there is no
5818 ;; space before point, also move into
5819 ;; object, for consistency with
5820 ;; convenience feature above.
5829 next nil
5830 object-data nil))
5831 ;; Otherwise, return NEXT.
5833 ;; Store results in cache, if applicable.
5837 "List all ancestors of a given element or object.
5839 BLOB is an object or element.
5841 When optional argument TYPES is a list of symbols, return the
5842 first element or object in the lineage whose type belongs to that
5843 list.
5845 When optional argument WITH-SELF is non-nil, lineage includes
5846 BLOB itself as the first element, and TYPES, if provided, also
5847 apply to it.
5849 When BLOB is obtained through `org-element-context' or
5850 `org-element-at-point', only ancestors from its section can be
5851 found. There is no such limitation when BLOB belongs to a full
5852 parse tree."
5854 ancestors)
5861 "Non-nil when elements ELEM-A and ELEM-B are nested."
5870 "Swap elements ELEM-A and ELEM-B.
5871 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5872 end of ELEM-A."
5874 ;; There are two special cases when an element doesn't start at bol:
5875 ;; the first paragraph in an item or in a footnote definition.
5877 ;; Only a paragraph without any affiliated keyword can be moved at
5878 ;; ELEM-A position in such a situation. Note that the case of
5879 ;; a footnote definition is impossible: it cannot contain two
5880 ;; paragraphs in a row because it cannot contain a blank line.
5886 ;; In a special situation, ELEM-A will have no indentation. We'll
5887 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5901 ;; Store overlays responsible for visibility status. We
5902 ;; also need to store their boundaries as they will be
5903 ;; removed from buffer.
5910 ;; Get contents.
5918 ;; Restore ex ELEM-A overlays.
5927 ;; Restore ex ELEM-B overlays.
5935 "Remove maximum common indentation in string S and return it.
5936 When optional argument N is a positive integer, remove exactly
5937 that much characters from indentation, if possible, or return
5938 S as-is otherwise. Unlike to `org-remove-indentation', this
5939 function doesn't call `untabify' on S."
5944 ;; Find maximum common indentation, if not specified.
5952 min-ind)))
5954 ;; Remove exactly N indentation, but give up if not possible.
5967 ;; Local variables:
5968 ;; generated-autoload-file: "org-loaddefs.el"
5969 ;; End:
5971 ;;; org-element.el ends here