| blob | cb0c1af04f7e4879c452b455974c1c16c40948a8 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `export-block',
49 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
50 ;; `node-property', `paragraph', `planning', `src-block', `table',
51 ;; `table-row' and `verse-block'. Among them, `paragraph' and
52 ;; `verse-block' types can contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, All elements have a `:post-affiliated'
77 ;; property referring to the buffer position after all affiliated
78 ;; keywords, if any, or to their beginning position otherwise.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Clock lines.
158 ;; Lists.
165 "Regexp to separate paragraphs in an Org buffer.
167 is not sufficient to know if point is at a paragraph ending. See
172 dynamic-block example-block export-block fixed-width
173 footnote-definition headline horizontal-rule inlinetask item
174 keyword latex-environment node-property paragraph plain-list
175 planning property-drawer quote-block section
176 special-block src-block table table-row verse-block)
181 item plain-list property-drawer quote-block section
182 special-block table)
187 inline-src-block italic line-break latex-fragment link macro
188 radio-target statistics-cookie strike-through subscript superscript
189 table-cell target timestamp underline verbatim)
194 superscript table-cell underline)
204 "Alist between block names and the associated parsing function.
205 Names must be uppercase. Any block whose name has no association
211 Only these types can accept search options and an explicit
217 "List of affiliated keywords as strings.
225 "Alist of usual translations for keywords.
226 The key is the old name and the value the new one. The property
230 "List of affiliated keywords that can occur more than once in an element.
232 Their value will be consed into a list of strings, which will be
233 returned as the value of the property.
235 This list is checked after translations have been applied. See
236 `org-element-keyword-translation-alist'.
242 "List of affiliated keywords whose value can be parsed.
244 Their value will be stored as a secondary string: a list of
245 strings and objects.
247 This list is checked after translations have been applied. See
251 "List of affiliated keywords which can have a secondary value.
253 In Org syntax, they can be written with optional square brackets
254 before the colons. For example, RESULTS keyword can be
255 associated to a hash value with the following:
257 #+RESULTS[hash-string]: some-source
259 This list is checked after translations have been applied. See
263 "List of properties associated to the whole document.
264 Any keyword in this list will have its value parsed and stored as
270 ;; Dual affiliated keywords.
274 ;; Regular affiliated keywords.
280 org-element-affiliated-keywords)))
282 ;; Export attributes.
284 "Regexp matching any affiliated keyword.
286 Keyword name is put in match group 1. Moreover, if keyword
287 belongs to `org-element-dual-keywords', put the dual value in
288 match group 2.
302 ;; Ignore all links excepted plain links in a link description.
303 ;; Also ignore radio-targets and line breaks.
305 italic latex-fragment macro plain-link statistics-cookie
306 strike-through subscript superscript underline verbatim)
308 ;; Remove any variable object from radio target as it would
309 ;; prevent it from being properly recognized.
311 subscript superscript underline superscript)
315 ;; Ignore inline babel call and inline src block as formulas are
316 ;; possible. Also ignore line breaks and statistics cookies.
318 latex-fragment link macro radio-target strike-through
319 subscript superscript target timestamp underline verbatim)
323 "Alist of objects restrictions.
325 key is an element or object type containing objects and value is
326 a list of types that can be contained within an element or object
327 of such type.
329 For example, in a `radio-target' object, one can only find
330 entities, latex-fragments, subscript, superscript and text
331 markup.
333 This alist also applies to secondary string. For example, an
334 `headline' type element doesn't directly contain objects, but
344 \f
345 ;;; Accessors and Setters
346 ;;
347 ;; Provide four accessors: `org-element-type', `org-element-property'
348 ;; `org-element-contents' and `org-element-restriction'.
349 ;;
350 ;; Setter functions allow to modify elements by side effect. There is
351 ;; `org-element-put-property', `org-element-set-contents'. These
352 ;; low-level functions are useful to build a parse tree.
353 ;;
354 ;; `org-element-adopt-element', `org-element-set-element',
355 ;; `org-element-extract-element' and `org-element-insert-before' are
356 ;; high-level functions useful to modify a parse tree.
357 ;;
358 ;; `org-element-secondary-p' is a predicate used to know if a given
359 ;; object belongs to a secondary string.
362 "Return type of ELEMENT.
364 The function returns the type of the element or object provided.
365 It can also return the following special value:
366 `plain-text' for a string
367 `org-data' for a complete document
368 nil in any other case."
374 "Extract the value from the PROPERTY of an ELEMENT."
379 "Extract contents from an ELEMENT."
385 "Return restriction associated to ELEMENT.
386 ELEMENT can be an element, an object or a symbol representing an
387 element or object type."
389 org-element-object-restrictions)))
392 "In ELEMENT set PROPERTY to VALUE.
393 Return modified element."
396 element))
399 "Set ELEMENT contents to CONTENTS.
400 Return modified element."
407 "Non-nil when OBJECT belongs to a secondary string.
408 Return value is the property name, as a keyword, or nil."
411 org-element-secondary-value-alist))))
414 property)))
417 "Append elements to the contents of another element.
419 PARENT is an element or object. CHILDREN can be elements,
420 objects, or a strings.
422 The function takes care of setting `:parent' property for CHILD.
423 Return parent element."
424 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
425 ;; string: parent is the list itself.
428 children)
429 ;; Add CHILDREN at the end of PARENT contents.
432 parent
434 ;; Return modified PARENT element.
438 "Extract ELEMENT from parse tree.
439 Remove element from the parse tree by side-effect, and return it
440 with its `:parent' property stripped out."
445 parent secondary
448 parent
450 ;; Return ELEMENT with its :parent removed.
454 "Insert ELEMENT before LOCATION in parse tree.
455 LOCATION is an element, object or string within the parse tree.
456 Parse tree is modified by side effect."
461 ;; Special case: LOCATION is the first element of an
462 ;; independent secondary string (e.g. :title property). Add
463 ;; ELEMENT in-place.
467 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
477 ;; Store SIBLINGS at appropriate place in parse tree.
482 ;; Set appropriate :parent property.
486 "Replace element or object OLD with element or object NEW.
487 The function takes care of setting `:parent' property for NEW."
488 ;; Ensure OLD and NEW have the same parent.
492 ;; We cannot replace OLD with NEW since one of them is not an
493 ;; object or element. We take the long path.
496 ;; Since OLD is going to be changed into NEW by side-effect, first
497 ;; make sure that every element or object within NEW has OLD as
498 ;; parent.
501 ;; Transfer contents.
503 ;; Overwrite OLD's properties with NEW's.
505 ;; Transfer type.
509 \f
510 ;;; Greater elements
511 ;;
512 ;; For each greater element type, we define a parser and an
513 ;; interpreter.
514 ;;
515 ;; A parser returns the element or object as the list described above.
516 ;; Most of them accepts no argument. Though, exceptions exist. Hence
517 ;; every element containing a secondary string (see
518 ;; `org-element-secondary-value-alist') will accept an optional
519 ;; argument to toggle parsing of that secondary string. Moreover,
520 ;; `item' parser requires current list's structure as its first
521 ;; element.
522 ;;
523 ;; An interpreter accepts two arguments: the list representation of
524 ;; the element or object, and its contents. The latter may be nil,
525 ;; depending on the element or object considered. It returns the
526 ;; appropriate Org syntax, as a string.
527 ;;
528 ;; Parsing functions must follow the naming convention:
529 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
530 ;; defined in `org-element-greater-elements'.
531 ;;
532 ;; Similarly, interpreting functions must follow the naming
533 ;; convention: org-element-TYPE-interpreter.
534 ;;
535 ;; With the exception of `headline' and `item' types, greater elements
536 ;; cannot contain other greater elements of their own type.
537 ;;
538 ;; Beside implementing a parser and an interpreter, adding a new
539 ;; greater element requires to tweak `org-element--current-element'.
540 ;; Moreover, the newly defined type must be added to both
541 ;; `org-element-all-elements' and `org-element-greater-elements'.
544 ;;;; Center Block
547 "Parse a center block.
549 LIMIT bounds the search. AFFILIATED is a list of which CAR is
550 the buffer position at the beginning of the first affiliated
551 keyword and CDR is a plist of affiliated keywords along with
552 their value.
554 Return a list whose CAR is `center-block' and CDR is a plist
555 containing `:begin', `:end', `:contents-begin', `:contents-end',
556 `:post-blank' and `:post-affiliated' keywords.
558 Assume point is at the beginning of the block."
562 ;; Incomplete block: parse it as a paragraph.
567 ;; Empty blocks have no contents.
581 :end end
582 :contents-begin contents-begin
583 :contents-end contents-end
589 "Interpret CENTER-BLOCK element as Org syntax.
590 CONTENTS is the contents of the element."
594 ;;;; Drawer
597 "Parse a drawer.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `drawer' and CDR is a plist containing
605 `:drawer-name', `:begin', `:end', `:contents-begin',
606 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
608 Assume point is at beginning of drawer."
611 ;; Incomplete drawer: parse it as a paragraph.
619 ;; Empty drawers have no contents.
632 :end end
633 :drawer-name name
634 :contents-begin contents-begin
635 :contents-end contents-end
641 "Interpret DRAWER element as Org syntax.
642 CONTENTS is the contents of the element."
645 contents))
648 ;;;; Dynamic Block
651 "Parse a dynamic block.
653 LIMIT bounds the search. AFFILIATED is a list of which CAR is
654 the buffer position at the beginning of the first affiliated
655 keyword and CDR is a plist of affiliated keywords along with
656 their value.
658 Return a list whose CAR is `dynamic-block' and CDR is a plist
659 containing `:block-name', `:begin', `:end', `:contents-begin',
660 `:contents-end', `:arguments', `:post-blank' and
661 `:post-affiliated' keywords.
663 Assume point is at beginning of dynamic block."
667 ;; Incomplete block: parse it as a paragraph.
676 ;; Empty blocks have no contents.
689 :end end
690 :block-name name
691 :arguments arguments
692 :contents-begin contents-begin
693 :contents-end contents-end
699 "Interpret DYNAMIC-BLOCK element as Org syntax.
700 CONTENTS is the contents of the element."
705 contents))
708 ;;;; Footnote Definition
711 "Parse a footnote definition.
713 LIMIT bounds the search. AFFILIATED is a list of which CAR is
714 the buffer position at the beginning of the first affiliated
715 keyword and CDR is a plist of affiliated keywords along with
716 their value.
718 Return a list whose CAR is `footnote-definition' and CDR is
719 a plist containing `:label', `:begin' `:end', `:contents-begin',
720 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
722 Assume point is at the beginning of the footnote definition."
750 :begin begin
751 :end end
752 :contents-begin contents-begin
753 :contents-end contents-end
759 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
760 CONTENTS is the contents of the footnote-definition."
762 " "
763 contents))
766 ;;;; Headline
769 "Parse a headline.
771 Return a list whose CAR is `headline' and CDR is a plist
772 containing `:raw-value', `:title', `:alt-title', `:begin',
773 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
774 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
775 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
776 `:footnote-section-p', `:post-blank' and `:post-affiliated'
777 keywords.
779 The plist also contains any property set in the property drawer,
780 with its name in upper cases and colons added at the
781 beginning (e.g., `:CUSTOM_ID').
783 LIMIT is a buffer position bounding the search.
785 When RAW-SECONDARY-P is non-nil, headline's title will not be
786 parsed as a secondary string, but as a plain string instead.
788 Assume point is at beginning of the headline."
801 raw-value)))
806 ;; Find property drawer associated to current headline and
807 ;; extract properties.
808 ;;
809 ;; Upcase property names. It avoids confusion between
810 ;; properties obtained through property drawer and default
811 ;; properties from the parser (e.g. `:end' and :END:)
815 plist)
821 ;; Make sure drawer is not associated
822 ;; to an inlinetask.
836 plist
841 plist)))
843 ;; Read time properties on the line below the headline.
849 org-keyword-time-not-clock-regexp end t)
859 plist))))
871 ;; Clean RAW-VALUE from any comment string.
877 ""
878 raw-value))))
879 ;; Clean TAGS from archive tag, if any.
885 :begin begin
886 :end end
887 :pre-blank
890 :contents-begin contents-begin
891 :contents-end contents-end
892 :level level
894 :tags tags
895 :todo-keyword todo
896 :todo-type todo-type
899 end)
900 :footnote-section-p footnote-section-p
901 :archivedp archivedp
902 :commentedp commentedp
904 time-props
905 standard-props))))
909 headline :alt-title
914 headline :title
920 "Interpret HEADLINE element as Org syntax.
921 CONTENTS is the contents of the element."
937 ?*)
941 " "
944 org-footnote-section
945 title))))
947 heading
948 ;; Align tags.
956 ?\s)
957 tags))
961 tags))))
963 contents)))
966 ;;;; Inlinetask
969 "Parse an inline task.
971 Return a list whose CAR is `inlinetask' and CDR is a plist
972 containing `:title', `:begin', `:end', `:contents-begin' and
973 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
974 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
975 `:closed', `:post-blank' and `:post-affiliated' keywords.
977 The plist also contains any property set in the property drawer,
978 with its name in upper cases and colons added at the
979 beginning (e.g., `:CUSTOM_ID').
981 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
982 title will not be parsed as a secondary string, but as a plain
983 string instead.
985 Assume point is at beginning of the inline task."
1001 ;; Read time properties on the line below the inlinetask
1002 ;; opening string.
1008 org-keyword-time-not-clock-regexp end t)
1018 plist)))))
1029 ;; Find property drawer associated to current inlinetask
1030 ;; and extract properties.
1031 ;;
1032 ;; HACK: Calling `org-element-at-point' triggers a parsing
1033 ;; of this inlinetask and, thus, an infloop. To avoid the
1034 ;; problem, we extract contents of the inlinetask and
1035 ;; parse them in a new buffer.
1036 ;;
1037 ;; Upcase property names. It avoids confusion between
1038 ;; properties obtained through property drawer and default
1039 ;; properties from the parser (e.g. `:end' and :END:)
1042 plist)
1049 org-property-start-re task-end t))
1059 plist
1064 plist)))
1069 :begin begin
1070 :end end
1071 :contents-begin contents-begin
1072 :contents-end contents-end
1075 :tags tags
1076 :todo-keyword todo
1077 :todo-type todo-type
1080 time-props
1081 standard-props))))
1083 inlinetask :title
1086 raw-value
1088 inlinetask))))))
1091 "Interpret INLINETASK element as Org syntax.
1092 CONTENTS is the contents of inlinetask."
1107 ;; Align tags.
1115 ? )
1116 tags))
1120 tags))))
1121 ;; Prefer degenerate inlinetasks when there are no
1122 ;; contents.
1125 contents
1129 ;;;; Item
1132 "Parse an item.
1134 STRUCT is the structure of the plain list.
1136 Return a list whose CAR is `item' and CDR is a plist containing
1137 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1138 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1139 `:post-affiliated' keywords.
1141 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1142 any, will not be parsed as a secondary string, but as a plain
1143 string instead.
1145 Assume point is at the beginning of the item."
1169 ;; Ignore tags in un-ordered lists: they are just
1170 ;; a part of item's body.
1176 ;; If first line isn't empty, contents really start
1177 ;; at the text after item's meta-data.
1186 :begin begin
1187 :end end
1188 ;; CONTENTS-BEGIN and CONTENTS-END may be
1189 ;; mixed up in the case of an empty item
1190 ;; separated from the next by a blank line.
1191 ;; Thus ensure the former is always the
1192 ;; smallest.
1195 :checkbox checkbox
1196 :counter counter
1197 :structure struct
1201 item :tag
1209 "Interpret ITEM element as Org syntax.
1210 CONTENTS is the contents of the element."
1220 ;; Compute indentation.
1225 ;; Indent contents.
1227 bullet
1241 ;;;; Plain List
1244 ;; Return structure of list at point. Internal function. See
1245 ;; `org-list-struct' for details.
1250 items struct)
1255 ;; At limit: end all items.
1264 ;; At list end: end all items.
1269 ;; At a new item: end previous sibling.
1281 ind
1282 bullet
1285 ;; Description tag.
1289 ;; Ending position, unknown so far.
1290 nil)))
1291 items))
1293 ;; Skip empty lines.
1295 ;; Skip inline tasks and blank lines along the way.
1302 ;; At some text line. Check if it ends any previous item.
1314 ;; Skip blocks (any type) and drawers contents.
1319 limit t)))
1325 "Parse a plain list.
1327 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1328 the buffer position at the beginning of the first affiliated
1329 keyword and CDR is a plist of affiliated keywords along with
1330 their value. STRUCTURE is the structure of the plain list being
1331 parsed.
1333 Return a list whose CAR is `plain-list' and CDR is a plist
1334 containing `:type', `:begin', `:end', `:contents-begin' and
1335 `:contents-end', `:structure', `:post-blank' and
1336 `:post-affiliated' keywords.
1338 Assume point is at the beginning of the list."
1352 pos))
1356 ;; Return value.
1360 :begin begin
1361 :end end
1362 :contents-begin contents-begin
1363 :contents-end contents-end
1364 :structure struct
1370 "Interpret PLAIN-LIST element as Org syntax.
1371 CONTENTS is the contents of the element."
1379 ;;;; Property Drawer
1382 "Parse a property drawer.
1384 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1385 the buffer position at the beginning of the first affiliated
1386 keyword and CDR is a plist of affiliated keywords along with
1387 their value.
1389 Return a list whose CAR is `property-drawer' and CDR is a plist
1390 containing `:begin', `:end', `:contents-begin', `:contents-end',
1391 `:post-blank' and `:post-affiliated' keywords.
1393 Assume point is at the beginning of the property drawer."
1396 ;; Incomplete drawer: parse it as a paragraph.
1416 :end end
1417 :contents-begin contents-begin
1418 :contents-end contents-end
1424 "Interpret PROPERTY-DRAWER element as Org syntax.
1425 CONTENTS is the properties within the drawer."
1429 ;;;; Quote Block
1432 "Parse a quote block.
1434 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1435 the buffer position at the beginning of the first affiliated
1436 keyword and CDR is a plist of affiliated keywords along with
1437 their value.
1439 Return a list whose CAR is `quote-block' and CDR is a plist
1440 containing `:begin', `:end', `:contents-begin', `:contents-end',
1441 `:post-blank' and `:post-affiliated' keywords.
1443 Assume point is at the beginning of the block."
1447 ;; Incomplete block: parse it as a paragraph.
1453 ;; Empty blocks have no contents.
1466 :end end
1467 :contents-begin contents-begin
1468 :contents-end contents-end
1474 "Interpret QUOTE-BLOCK element as Org syntax.
1475 CONTENTS is the contents of the element."
1479 ;;;; Section
1482 "Parse a section.
1484 LIMIT bounds the search.
1486 Return a list whose CAR is `section' and CDR is a plist
1487 containing `:begin', `:end', `:contents-begin', `contents-end',
1488 `:post-blank' and `:post-affiliated' keywords."
1490 ;; Beginning of section is the beginning of the first non-blank
1491 ;; line after previous headline.
1500 :end end
1501 :contents-begin begin
1502 :contents-end pos-before-blank
1507 "Interpret SECTION element as Org syntax.
1508 CONTENTS is the contents of the element."
1509 contents)
1512 ;;;; Special Block
1515 "Parse a special block.
1517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1518 the buffer position at the beginning of the first affiliated
1519 keyword and CDR is a plist of affiliated keywords along with
1520 their value.
1522 Return a list whose CAR is `special-block' and CDR is a plist
1523 containing `:type', `:begin', `:end', `:contents-begin',
1524 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1526 Assume point is at the beginning of the block."
1533 limit t)))
1534 ;; Incomplete block: parse it as a paragraph.
1540 ;; Empty blocks have no contents.
1553 :begin begin
1554 :end end
1555 :contents-begin contents-begin
1556 :contents-end contents-end
1562 "Interpret SPECIAL-BLOCK element as Org syntax.
1563 CONTENTS is the contents of the element."
1568 \f
1569 ;;; Elements
1570 ;;
1571 ;; For each element, a parser and an interpreter are also defined.
1572 ;; Both follow the same naming convention used for greater elements.
1573 ;;
1574 ;; Also, as for greater elements, adding a new element type is done
1575 ;; through the following steps: implement a parser and an interpreter,
1576 ;; tweak `org-element--current-element' so that it recognizes the new
1577 ;; type and add that new type to `org-element-all-elements'.
1578 ;;
1579 ;; As a special case, when the newly defined type is a block type,
1580 ;; `org-element-block-name-alist' has to be modified accordingly.
1583 ;;;; Babel Call
1586 "Parse a babel call.
1588 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1589 the buffer position at the beginning of the first affiliated
1590 keyword and CDR is a plist of affiliated keywords along with
1591 their value.
1593 Return a list whose CAR is `babel-call' and CDR is a plist
1594 containing `:begin', `:end', `:value', `:post-blank' and
1595 `:post-affiliated' as keywords."
1609 :end end
1610 :value value
1616 "Interpret BABEL-CALL element as Org syntax.
1617 CONTENTS is nil."
1621 ;;;; Clock
1624 "Parse a clock.
1626 LIMIT bounds the search.
1628 Return a list whose CAR is `clock' and CDR is a plist containing
1629 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1630 `:post-affiliated' as keywords."
1650 :value value
1651 :duration duration
1652 :begin begin
1653 :end end
1654 :post-blank post-blank
1658 "Interpret CLOCK element as Org syntax.
1659 CONTENTS is nil."
1667 "%2s:%02s"
1671 ;;;; Comment
1674 "Parse a comment.
1676 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1677 the buffer position at the beginning of the first affiliated
1678 keyword and CDR is a plist of affiliated keywords along with
1679 their value.
1681 Return a list whose CAR is `comment' and CDR is a plist
1682 containing `:begin', `:end', `:value', `:post-blank',
1683 `:post-affiliated' keywords.
1685 Assume point is at comment beginning."
1694 ;; Get comments ending.
1697 ;; Accumulate lines without leading hash and first
1698 ;; whitespace.
1712 :end end
1713 :value value
1719 "Interpret COMMENT element as Org syntax.
1720 CONTENTS is nil."
1724 ;;;; Comment Block
1727 "Parse an export block.
1729 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1730 the buffer position at the beginning of the first affiliated
1731 keyword and CDR is a plist of affiliated keywords along with
1732 their value.
1734 Return a list whose CAR is `comment-block' and CDR is a plist
1735 containing `:begin', `:end', `:value', `:post-blank' and
1736 `:post-affiliated' keywords.
1738 Assume point is at comment block beginning."
1742 ;; Incomplete block: parse it as a paragraph.
1755 contents-begin contents-end)))
1759 :end end
1760 :value value
1766 "Interpret COMMENT-BLOCK element as Org syntax.
1767 CONTENTS is nil."
1774 ;;;; Diary Sexp
1777 "Parse a diary sexp.
1779 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1780 the buffer position at the beginning of the first affiliated
1781 keyword and CDR is a plist of affiliated keywords along with
1782 their value.
1784 Return a list whose CAR is `diary-sexp' and CDR is a plist
1785 containing `:begin', `:end', `:value', `:post-blank' and
1786 `:post-affiliated' keywords."
1798 :begin begin
1799 :end end
1805 "Interpret DIARY-SEXP as Org syntax.
1806 CONTENTS is nil."
1810 ;;;; Example Block
1813 "Parse an example block.
1815 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1816 the buffer position at the beginning of the first affiliated
1817 keyword and CDR is a plist of affiliated keywords along with
1818 their value.
1820 Return a list whose CAR is `example-block' and CDR is a plist
1821 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1822 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1823 `:value', `:post-blank' and `:post-affiliated' keywords."
1827 ;; Incomplete block: parse it as a paragraph.
1835 ;; Switches analysis
1842 ;; Should labels be retained in (or stripped from) example
1843 ;; blocks?
1848 ;; What should code-references use - labels or
1849 ;; line-numbers?
1858 ;; Standard block parsing.
1866 contents-begin contents-end))
1867 block-ind))
1876 :end end
1877 :value value
1878 :switches switches
1879 :number-lines number-lines
1880 :preserve-indent preserve-indent
1881 :retain-labels retain-labels
1882 :use-labels use-labels
1883 :label-fmt label-fmt
1889 "Interpret EXAMPLE-BLOCK element as Org syntax.
1890 CONTENTS is nil."
1898 value
1903 ;;;; Export Block
1906 "Parse an export block.
1908 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1909 the buffer position at the beginning of the first affiliated
1910 keyword and CDR is a plist of affiliated keywords along with
1911 their value.
1913 Return a list whose CAR is `export-block' and CDR is a plist
1914 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1915 `:post-affiliated' keywords.
1917 Assume point is at export-block beginning."
1924 ;; Incomplete block: parse it as a paragraph.
1937 contents-end)))
1941 :end end
1942 :type type
1943 :value value
1949 "Interpret EXPORT-BLOCK element as Org syntax.
1950 CONTENTS is nil."
1957 ;;;; Fixed-width
1960 "Parse a fixed-width section.
1962 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1963 the buffer position at the beginning of the first affiliated
1964 keyword and CDR is a plist of affiliated keywords along with
1965 their value.
1967 Return a list whose CAR is `fixed-width' and CDR is a plist
1968 containing `:begin', `:end', `:value', `:post-blank' and
1969 `:post-affiliated' keywords.
1971 Assume point is at the beginning of the fixed-width area."
1975 value
1980 ;; Accumulate text without starting colons.
1993 :end end
1994 :value value
2000 "Interpret FIXED-WIDTH element as Org syntax.
2001 CONTENTS is nil."
2009 ;;;; Horizontal Rule
2012 "Parse an horizontal rule.
2014 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2015 the buffer position at the beginning of the first affiliated
2016 keyword and CDR is a plist of affiliated keywords along with
2017 their value.
2019 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2020 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2021 keywords."
2031 :end end
2037 "Interpret HORIZONTAL-RULE element as Org syntax.
2038 CONTENTS is nil."
2042 ;;;; Keyword
2045 "Parse a keyword at point.
2047 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2048 the buffer position at the beginning of the first affiliated
2049 keyword and CDR is a plist of affiliated keywords along with
2050 their value.
2052 Return a list whose CAR is `keyword' and CDR is a plist
2053 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2054 `:post-affiliated' keywords."
2056 ;; An orphaned affiliated keyword is considered as a regular
2057 ;; keyword. In this case AFFILIATED is nil, so we take care of
2058 ;; this corner case.
2071 :value value
2072 :begin begin
2073 :end end
2079 "Interpret KEYWORD element as Org syntax.
2080 CONTENTS is nil."
2086 ;;;; Latex Environment
2090 "Regexp matching the beginning of a LaTeX environment.
2091 The environment is captured by the first group.
2097 "Format string matching the ending of a LaTeX environment.
2101 "Parse a LaTeX environment.
2103 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2104 the buffer position at the beginning of the first affiliated
2105 keyword and CDR is a plist of affiliated keywords along with
2106 their value.
2108 Return a list whose CAR is `latex-environment' and CDR is a plist
2109 containing `:begin', `:end', `:value', `:post-blank' and
2110 `:post-affiliated' keywords.
2112 Assume point is at the beginning of the latex environment."
2119 limit t))
2120 ;; Incomplete latex environment: parse it as a paragraph.
2130 :end end
2131 :value value
2137 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2138 CONTENTS is nil."
2142 ;;;; Node Property
2145 "Parse a node-property at point.
2147 LIMIT bounds the search.
2149 Return a list whose CAR is `node-property' and CDR is a plist
2150 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2151 `:post-affiliated' keywords."
2161 limit))))
2164 :value value
2165 :begin begin
2166 :end end
2171 "Interpret NODE-PROPERTY element as Org syntax.
2172 CONTENTS is nil."
2178 ;;;; Paragraph
2181 "Parse a paragraph.
2183 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2184 the buffer position at the beginning of the first affiliated
2185 keyword and CDR is a plist of affiliated keywords along with
2186 their value.
2188 Return a list whose CAR is `paragraph' and CDR is a plist
2189 containing `:begin', `:end', `:contents-begin' and
2190 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2192 Assume point is at the beginning of the paragraph."
2201 limit
2202 ;; A matching `org-element-paragraph-separate' is not
2203 ;; necessarily the end of the paragraph. In
2204 ;; particular, lines starting with # or : as a first
2205 ;; non-space character are ambiguous. We have to
2206 ;; check if they are valid Org syntax (e.g., not an
2207 ;; incomplete keyword).
2211 ;; There's no ambiguity for other symbols or
2212 ;; empty lines: stop here.
2214 ;; Stop at valid fixed-width areas.
2216 ;; Stop at drawers.
2221 ;; Stop at valid comments.
2223 ;; Stop at valid dynamic blocks.
2228 ;; Stop at valid blocks.
2235 limit t)))
2236 ;; Stop at valid latex environments.
2243 limit t)))
2244 ;; Stop at valid keywords.
2246 ;; Skip everything else.
2263 :end end
2264 :contents-begin contents-begin
2265 :contents-end contents-end
2271 "Interpret PARAGRAPH element as Org syntax.
2272 CONTENTS is the contents of the element."
2273 contents)
2276 ;;;; Planning
2279 "Parse a planning.
2281 LIMIT bounds the search.
2283 Return a list whose CAR is `planning' and CDR is a plist
2284 containing `:closed', `:deadline', `:scheduled', `:begin',
2285 `:end', `:post-blank' and `:post-affiliated' keywords."
2295 closed deadline scheduled)
2307 :deadline deadline
2308 :scheduled scheduled
2309 :begin begin
2310 :end end
2311 :post-blank post-blank
2315 "Interpret PLANNING element as Org syntax.
2316 CONTENTS is nil."
2318 'identity
2335 ;;;; Src Block
2338 "Parse a src block.
2340 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2341 the buffer position at the beginning of the first affiliated
2342 keyword and CDR is a plist of affiliated keywords along with
2343 their value.
2345 Return a list whose CAR is `src-block' and CDR is a plist
2346 containing `:language', `:switches', `:parameters', `:begin',
2347 `:end', `:number-lines', `:retain-labels', `:use-labels',
2348 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2349 `:post-affiliated' keywords.
2351 Assume point is at the beginning of the block."
2354 limit t)))
2355 ;; Incomplete block: parse it as a paragraph.
2361 ;; Get language as a string.
2370 ;; Get switches.
2372 ;; Get parameters.
2374 ;; Switches analysis
2385 ;; Should labels be retained in (or stripped from)
2386 ;; src blocks?
2391 ;; What should code-references use - labels or
2392 ;; line-numbers?
2397 ;; Indentation.
2399 ;; Retrieve code.
2404 block-ind))
2408 ;; Get position after ending blank lines.
2418 :begin begin
2419 :end end
2420 :number-lines number-lines
2421 :preserve-indent preserve-indent
2422 :retain-labels retain-labels
2423 :use-labels use-labels
2424 :label-fmt label-fmt
2425 :value value
2431 "Interpret SRC-BLOCK element as Org syntax.
2432 CONTENTS is nil."
2441 val)
2455 ;;;; Table
2458 "Parse a table at point.
2460 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2461 the buffer position at the beginning of the first affiliated
2462 keyword and CDR is a plist of affiliated keywords along with
2463 their value.
2465 Return a list whose CAR is `table' and CDR is a plist containing
2466 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2467 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2468 keywords.
2470 Assume point is at the beginning of the table."
2484 acc))
2491 :end end
2492 :type type
2493 :tblfm tblfm
2494 ;; Only `org' tables have contents. `table.el' tables
2495 ;; use a `:value' property to store raw table as
2496 ;; a string.
2501 table-begin table-end))
2507 "Interpret TABLE element as Org syntax.
2508 CONTENTS is a string, if table's type is `org', or nil."
2519 ;;;; Table Row
2522 "Parse table row at point.
2524 LIMIT bounds the search.
2526 Return a list whose CAR is `table-row' and CDR is a plist
2527 containing `:begin', `:end', `:contents-begin', `:contents-end',
2528 `:type', `:post-blank' and `:post-affiliated' keywords."
2532 ;; A table rule has no contents. In that case, ensure
2533 ;; CONTENTS-BEGIN matches CONTENTS-END.
2545 :begin begin
2546 :end end
2547 :contents-begin contents-begin
2548 :contents-end contents-end
2553 "Interpret TABLE-ROW element as Org syntax.
2554 CONTENTS is the contents of the table row."
2559 ;;;; Verse Block
2562 "Parse a verse block.
2564 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2565 the buffer position at the beginning of the first affiliated
2566 keyword and CDR is a plist of affiliated keywords along with
2567 their value.
2569 Return a list whose CAR is `verse-block' and CDR is a plist
2570 containing `:begin', `:end', `:contents-begin', `:contents-end',
2571 `:post-blank' and `:post-affiliated' keywords.
2573 Assume point is at beginning of the block."
2577 ;; Incomplete block: parse it as a paragraph.
2592 :end end
2593 :contents-begin contents-begin
2594 :contents-end contents-end
2600 "Interpret VERSE-BLOCK element as Org syntax.
2601 CONTENTS is verse block contents."
2605 \f
2606 ;;; Objects
2607 ;;
2608 ;; Unlike to elements, raw text can be found between objects. Hence,
2609 ;; `org-element--object-lex' is provided to find the next object in
2610 ;; buffer.
2611 ;;
2612 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2613 ;; object types they can contain will be specified in
2614 ;; `org-element-object-restrictions'.
2615 ;;
2616 ;; Creating a new type of object requires to alter
2617 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2618 ;; new type in `org-element-all-objects', and possibly add
2619 ;; restrictions in `org-element-object-restrictions'.
2621 ;;;; Bold
2624 "Parse bold object at point, if any.
2626 When at a bold object, return a list whose car is `bold' and cdr
2627 is a plist with `:begin', `:end', `:contents-begin' and
2628 `:contents-end' and `:post-blank' keywords. Otherwise, return
2629 nil.
2631 Assume point is at the first star marker."
2643 :end end
2644 :contents-begin contents-begin
2645 :contents-end contents-end
2649 "Interpret BOLD object as Org syntax.
2650 CONTENTS is the contents of the object."
2654 ;;;; Code
2657 "Parse code object at point, if any.
2659 When at a code object, return a list whose car is `code' and cdr
2660 is a plist with `:value', `:begin', `:end' and `:post-blank'
2661 keywords. Otherwise, return nil.
2663 Assume point is at the first tilde marker."
2674 :begin begin
2675 :end end
2679 "Interpret CODE object as Org syntax.
2680 CONTENTS is nil."
2684 ;;;; Entity
2687 "Parse entity at point, if any.
2689 When at an entity, return a list whose car is `entity' and cdr
2690 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2691 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2692 `:post-blank' as keywords. Otherwise, return nil.
2694 Assume point is at the beginning of the entity."
2696 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2714 :begin begin
2715 :end end
2716 :use-brackets-p bracketsp
2720 "Interpret ENTITY object as Org syntax.
2721 CONTENTS is nil."
2727 ;;;; Export Snippet
2730 "Parse export snippet at point.
2732 When at an export snippet, return a list whose car is
2733 `export-snippet' and cdr a plist with `:begin', `:end',
2734 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2735 return nil.
2737 Assume point is at the beginning of the snippet."
2753 :value value
2754 :begin begin
2755 :end end
2759 "Interpret EXPORT-SNIPPET object as Org syntax.
2760 CONTENTS is nil."
2766 ;;;; Footnote Reference
2769 "Parse footnote reference at point, if any.
2771 When at a footnote reference, return a list whose car is
2772 `footnote-reference' and cdr a plist with `:label', `:type',
2773 `:begin', `:end', `:content-begin', `:contents-end' and
2774 `:post-blank' as keywords. Otherwise, return nil."
2798 :type type
2799 :begin begin
2800 :end end
2806 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2807 CONTENTS is its definition, when inline, or nil."
2813 ;;;; Inline Babel Call
2816 "Parse inline babel call at point, if any.
2818 When at an inline babel call, return a list whose car is
2819 `inline-babel-call' and cdr a plist with `:begin', `:end',
2820 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2822 Assume point is at the beginning of the babel call."
2834 :end end
2835 :value value
2839 "Interpret INLINE-BABEL-CALL object as Org syntax.
2840 CONTENTS is nil."
2844 ;;;; Inline Src Block
2847 "Parse inline source block at point, if any.
2849 When at an inline source block, return a list whose car is
2850 `inline-src-block' and cdr a plist with `:begin', `:end',
2851 `:language', `:value', `:parameters' and `:post-blank' as
2852 keywords. Otherwise, return nil.
2854 Assume point is at the beginning of the inline src block."
2867 :value value
2868 :parameters parameters
2869 :begin begin
2870 :end end
2874 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2875 CONTENTS is nil."
2880 language
2882 body)))
2884 ;;;; Italic
2887 "Parse italic object at point, if any.
2889 When at an italic object, return a list whose car is `italic' and
2890 cdr is a plist with `:begin', `:end', `:contents-begin' and
2891 `:contents-end' and `:post-blank' keywords. Otherwise, return
2892 nil.
2894 Assume point is at the first slash marker."
2906 :end end
2907 :contents-begin contents-begin
2908 :contents-end contents-end
2912 "Interpret ITALIC object as Org syntax.
2913 CONTENTS is the contents of the object."
2917 ;;;; Latex Fragment
2920 "Parse LaTeX fragment at point, if any.
2922 When at a LaTeX fragment, return a list whose car is
2923 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2924 and `:post-blank' as keywords. Otherwise, return nil.
2926 Assume point is at the beginning of the LaTeX fragment."
2944 ;; Macro.
2953 :begin begin
2954 :end end
2958 "Interpret LATEX-FRAGMENT object as Org syntax.
2959 CONTENTS is nil."
2962 ;;;; Line Break
2965 "Parse line break at point, if any.
2967 When at a line break, return a list whose car is `line-break',
2968 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2969 Otherwise, return nil.
2971 Assume point is at the beginning of the line break."
2980 "Interpret LINE-BREAK object as Org syntax.
2981 CONTENTS is nil."
2985 ;;;; Link
2988 "Parse link at point, if any.
2990 When at a link, return a list whose car is `link' and cdr a plist
2991 with `:type', `:path', `:raw-link', `:application',
2992 `:search-option', `:begin', `:end', `:contents-begin',
2993 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2994 nil.
2996 Assume point is at the beginning of the link."
2999 end contents-begin contents-end link-end post-blank path type
3000 raw-link link search-option application)
3002 ;; Type 1: Text targeted from a radio target.
3011 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3016 ;; RAW-LINK is the original link. Expand any
3017 ;; abbreviation in it.
3021 ;; Determine TYPE of link and set PATH accordingly.
3023 ;; File type.
3027 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3030 ;; According to RFC 3986, extra whitespace should be
3031 ;; ignored when a URI is extracted.
3034 ;; Id type: PATH is the id.
3037 ;; Code-ref type: PATH is the name of the reference.
3040 ;; Custom-id type: PATH is the name of the custom id.
3043 ;; Fuzzy type: Internal link either matches a target, an
3044 ;; headline name or nothing. PATH is the target or
3045 ;; headline's name.
3047 ;; Type 3: Plain link, e.g., http://orgmode.org
3053 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3061 ;; In any case, deduce end point after trailing white space from
3062 ;; LINK-END variable.
3066 ;; Special "file" type link processing.
3068 ;; Extract opening application and search option.
3076 ;; Normalize URI.
3080 ;; Make sure TYPE always reports "file".
3084 :path path
3086 :application application
3087 :search-option search-option
3088 :begin begin
3089 :end end
3090 :contents-begin contents-begin
3091 :contents-end contents-end
3095 "Interpret LINK object as Org syntax.
3096 CONTENTS is the contents of the object, or nil."
3101 raw-link
3105 ;;;; Macro
3108 "Parse macro at point, if any.
3110 When at a macro, return a list whose car is `macro' and cdr
3111 a plist with `:key', `:args', `:begin', `:end', `:value' and
3112 `:post-blank' as keywords. Otherwise, return nil.
3114 Assume point is at the macro."
3125 ;; Do not use `org-split-string' since empty
3126 ;; strings are meaningful here.
3134 args nil t)
3138 :value value
3139 :args args
3140 :begin begin
3141 :end end
3145 "Interpret MACRO object as Org syntax.
3146 CONTENTS is nil."
3150 ;;;; Radio-target
3153 "Parse radio target at point, if any.
3155 When at a radio target, return a list whose car is `radio-target'
3156 and cdr a plist with `:begin', `:end', `:contents-begin',
3157 `:contents-end', `:value' and `:post-blank' as keywords.
3158 Otherwise, return nil.
3160 Assume point is at the radio target."
3172 :end end
3173 :contents-begin contents-begin
3174 :contents-end contents-end
3175 :post-blank post-blank
3179 "Interpret TARGET object as Org syntax.
3180 CONTENTS is the contents of the object."
3184 ;;;; Statistics Cookie
3187 "Parse statistics cookie at point, if any.
3189 When at a statistics cookie, return a list whose car is
3190 `statistics-cookie', and cdr a plist with `:begin', `:end',
3191 `:value' and `:post-blank' keywords. Otherwise, return nil.
3193 Assume point is at the beginning of the statistics-cookie."
3204 :end end
3205 :value value
3209 "Interpret STATISTICS-COOKIE object as Org syntax.
3210 CONTENTS is nil."
3214 ;;;; Strike-Through
3217 "Parse strike-through object at point, if any.
3219 When at a strike-through object, return a list whose car is
3220 `strike-through' and cdr is a plist with `:begin', `:end',
3221 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3222 Otherwise, return nil.
3224 Assume point is at the first plus sign marker."
3236 :end end
3237 :contents-begin contents-begin
3238 :contents-end contents-end
3242 "Interpret STRIKE-THROUGH object as Org syntax.
3243 CONTENTS is the contents of the object."
3247 ;;;; Subscript
3250 "Parse subscript at point, if any.
3252 When at a subscript object, return a list whose car is
3253 `subscript' and cdr a plist with `:begin', `:end',
3254 `:contents-begin', `:contents-end', `:use-brackets-p' and
3255 `:post-blank' as keywords. Otherwise, return nil.
3257 Assume point is at the underscore."
3271 :end end
3272 :use-brackets-p bracketsp
3273 :contents-begin contents-begin
3274 :contents-end contents-end
3278 "Interpret SUBSCRIPT object as Org syntax.
3279 CONTENTS is the contents of the object."
3282 contents))
3285 ;;;; Superscript
3288 "Parse superscript at point, if any.
3290 When at a superscript object, return a list whose car is
3291 `superscript' and cdr a plist with `:begin', `:end',
3292 `:contents-begin', `:contents-end', `:use-brackets-p' and
3293 `:post-blank' as keywords. Otherwise, return nil.
3295 Assume point is at the caret."
3309 :end end
3310 :use-brackets-p bracketsp
3311 :contents-begin contents-begin
3312 :contents-end contents-end
3316 "Interpret SUPERSCRIPT object as Org syntax.
3317 CONTENTS is the contents of the object."
3320 contents))
3323 ;;;; Table Cell
3326 "Parse table cell at point.
3327 Return a list whose car is `table-cell' and cdr is a plist
3328 containing `:begin', `:end', `:contents-begin', `:contents-end'
3329 and `:post-blank' keywords."
3337 :end end
3338 :contents-begin contents-begin
3339 :contents-end contents-end
3343 "Interpret TABLE-CELL element as Org syntax.
3344 CONTENTS is the contents of the cell, or nil."
3348 ;;;; Target
3351 "Parse target at point, if any.
3353 When at a target, return a list whose car is `target' and cdr
3354 a plist with `:begin', `:end', `:value' and `:post-blank' as
3355 keywords. Otherwise, return nil.
3357 Assume point is at the target."
3367 :end end
3368 :value value
3372 "Interpret TARGET object as Org syntax.
3373 CONTENTS is nil."
3377 ;;;; Timestamp
3388 "Parse time stamp at point, if any.
3390 When at a time stamp, return a list whose car is `timestamp', and
3391 cdr a plist with `:type', `:raw-value', `:year-start',
3392 `:month-start', `:day-start', `:hour-start', `:minute-start',
3393 `:year-end', `:month-end', `:day-end', `:hour-end',
3394 `:minute-end', `:repeater-type', `:repeater-value',
3395 `:repeater-unit', `:warning-type', `:warning-value',
3396 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3397 Otherwise, return nil.
3399 Assume point is at the beginning of the timestamp."
3418 date-start)
3429 raw-value)
3431 :repeater-type
3437 :repeater-unit
3446 :warning-unit
3449 year-start month-start day-start hour-start minute-start year-end
3450 month-end day-end hour-end minute-end)
3451 ;; Parse date-start.
3459 ;; Compute date-end. It can be provided directly in time-stamp,
3460 ;; or extracted from time range. Otherwise, it defaults to the
3461 ;; same values as date-start.
3471 :raw-value raw-value
3472 :year-start year-start
3473 :month-start month-start
3474 :day-start day-start
3475 :hour-start hour-start
3476 :minute-start minute-start
3477 :year-end year-end
3478 :month-end month-end
3479 :day-end day-end
3480 :hour-end hour-end
3481 :minute-end minute-end
3482 :begin begin
3483 :end end
3485 repeater-props
3486 warning-props))))))
3489 "Interpret TIMESTAMP object as Org syntax.
3490 CONTENTS is nil."
3509 ;; Build an Org timestamp string from TIME. ACTIVEP is
3510 ;; non-nil when time stamp is active. If WITH-TIME-P is
3511 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3512 ;; specify a time range in the timestamp. REPEAT-STRING is
3513 ;; the repeater string, if any.
3517 org-time-stamp-formats)
3518 time)))
3524 nil nil ts)))
3529 " "
3530 s
3532 ;; Return value.
3533 ts)))
3545 build-ts-string
3564 0
3572 "--"
3584 ;;;; Underline
3587 "Parse underline object at point, if any.
3589 When at an underline object, return a list whose car is
3590 `underline' and cdr is a plist with `:begin', `:end',
3591 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3592 Otherwise, return nil.
3594 Assume point is at the first underscore marker."
3606 :end end
3607 :contents-begin contents-begin
3608 :contents-end contents-end
3612 "Interpret UNDERLINE object as Org syntax.
3613 CONTENTS is the contents of the object."
3617 ;;;; Verbatim
3620 "Parse verbatim object at point, if any.
3622 When at a verbatim object, return a list whose car is `verbatim'
3623 and cdr is a plist with `:value', `:begin', `:end' and
3624 `:post-blank' keywords. Otherwise, return nil.
3626 Assume point is at the first equal sign marker."
3637 :begin begin
3638 :end end
3642 "Interpret VERBATIM object as Org syntax.
3643 CONTENTS is nil."
3647 \f
3648 ;;; Parsing Element Starting At Point
3649 ;;
3650 ;; `org-element--current-element' is the core function of this section.
3651 ;; It returns the Lisp representation of the element starting at
3652 ;; point.
3653 ;;
3654 ;; `org-element--current-element' makes use of special modes. They
3655 ;; are activated for fixed element chaining (e.g., `plain-list' >
3656 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3657 ;; `section'). Special modes are: `first-section', `item',
3658 ;; `node-property', `section' and `table-row'.
3661 "Parse the element starting at point.
3663 Return value is a list like (TYPE PROPS) where TYPE is the type
3664 of the element and PROPS a plist of properties associated to the
3665 element.
3667 Possible types are defined in `org-element-all-elements'.
3669 LIMIT bounds the search.
3671 Optional argument GRANULARITY determines the depth of the
3672 recursion. Allowed values are `headline', `greater-element',
3673 `element', `object' or nil. When it is broader than `object' (or
3674 nil), secondary values will not be parsed, since they only
3675 contain objects.
3677 Optional argument MODE, when non-nil, can be either
3678 `first-section', `section', `planning', `item', `node-property'
3679 and `table-row'.
3681 If STRUCTURE isn't provided but MODE is set to `item', it will be
3682 computed.
3684 This function assumes point is always at the beginning of the
3685 element it has to parse."
3688 ;; Determine if parsing depth allows for secondary strings
3689 ;; parsing. It only applies to elements referenced in
3690 ;; `org-element-secondary-value-alist'.
3693 ;; Item.
3696 ;; Table Row.
3698 ;; Node Property.
3700 ;; Headline.
3703 ;; Sections (must be checked after headline).
3708 limit)))
3709 ;; Planning.
3712 ;; When not at bol, point is at the beginning of an item or
3713 ;; a footnote definition: next item is always a paragraph.
3715 ;; Clock.
3717 ;; Inlinetask.
3720 ;; From there, elements can have affiliated keywords.
3723 ;; Jumping over affiliated keywords put point off-limits.
3724 ;; Parse them as regular keywords.
3728 ;; LaTeX Environment.
3731 ;; 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.
3830 ;; Attribute a property name to KWD.
3832 ;; Now set final shape for VALUE.
3838 ;; Attributes can always appear on multiple lines.
3841 ;; Eventually store the new value in OUTPUT.
3843 ;; Move to next keyword.
3845 ;; If affiliated keywords are orphaned: move back to first one.
3846 ;; They will be parsed as a paragraph.
3848 ;; Return value.
3852 \f
3853 ;;; The Org Parser
3854 ;;
3855 ;; The two major functions here are `org-element-parse-buffer', which
3856 ;; parses Org syntax inside the current buffer, taking into account
3857 ;; region, narrowing, or even visibility if specified, and
3858 ;; `org-element-parse-secondary-string', which parses objects within
3859 ;; a given string.
3860 ;;
3861 ;; The (almost) almighty `org-element-map' allows to apply a function
3862 ;; on elements or objects matching some type, and accumulate the
3863 ;; resulting values. In an export situation, it also skips unneeded
3864 ;; parts of the parse tree.
3867 "Recursively parse the buffer and return structure.
3868 If narrowing is in effect, only parse the visible part of the
3869 buffer.
3871 Optional argument GRANULARITY determines the depth of the
3872 recursion. It can be set to the following symbols:
3874 `headline' Only parse headlines.
3875 `greater-element' Don't recurse into greater elements excepted
3876 headlines and sections. Thus, elements
3877 parsed are the top-level ones.
3878 `element' Parse everything but objects and plain text.
3879 `object' Parse the complete buffer (default).
3881 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3882 elements.
3884 An element or an objects is represented as a list with the
3885 pattern (TYPE PROPERTIES CONTENTS), where :
3887 TYPE is a symbol describing the element or object. See
3888 `org-element-all-elements' and `org-element-all-objects' for an
3889 exhaustive list of such symbols. One can retrieve it with
3890 `org-element-type' function.
3892 PROPERTIES is the list of attributes attached to the element or
3893 object, as a plist. Although most of them are specific to the
3894 element or object type, all types share `:begin', `:end',
3895 `:post-blank' and `:parent' properties, which respectively
3896 refer to buffer position where the element or object starts,
3897 ends, the number of white spaces or blank lines after it, and
3898 the element or object containing it. Properties values can be
3899 obtained by using `org-element-property' function.
3901 CONTENTS is a list of elements, objects or raw strings
3902 contained in the current element or object, when applicable.
3903 One can access them with `org-element-contents' function.
3905 The Org buffer has `org-data' as type and nil as properties.
3906 `org-element-map' function can be used to find specific elements
3907 or objects within the parse tree.
3909 This function assumes that current major mode is `org-mode'."
3915 ;; Start in `first-section' mode so text before the first
3916 ;; headline belongs to a section.
3920 "Recursively parse objects in STRING and return structure.
3922 RESTRICTION is a symbol limiting the object types that will be
3923 looked after.
3925 Optional argument PARENT, when non-nil, is the element or object
3926 containing the secondary string. It is used to set correctly
3927 `:parent' property within the string."
3940 secondary))))
3944 "Map a function on selected elements or objects.
3946 DATA is a parse tree, an element, an object, a string, or a list
3947 of such constructs. TYPES is a symbol or list of symbols of
3948 elements or objects types (see `org-element-all-elements' and
3949 `org-element-all-objects' for a complete list of types). FUN is
3950 the function called on the matching element or object. It has to
3951 accept one argument: the element or object itself.
3953 When optional argument INFO is non-nil, it should be a plist
3954 holding export options. In that case, parts of the parse tree
3955 not exportable according to that property list will be skipped.
3957 When optional argument FIRST-MATCH is non-nil, stop at the first
3958 match for which FUN doesn't return nil, and return that value.
3960 Optional argument NO-RECURSION is a symbol or a list of symbols
3961 representing elements or objects types. `org-element-map' won't
3962 enter any recursive element or object whose type belongs to that
3963 list. Though, FUN can still be applied on them.
3965 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3966 apply to matching objects within parsed affiliated keywords (see
3967 `org-element-parsed-keywords').
3969 Nil values returned from FUN do not appear in the results.
3972 Examples:
3973 ---------
3975 Assuming TREE is a variable containing an Org buffer parse tree,
3976 the following example will return a flat list of all `src-block'
3977 and `example-block' elements in it:
3979 \(org-element-map tree '(example-block src-block) 'identity)
3981 The following snippet will find the first headline with a level
3984 \(org-element-map tree 'headline
3985 \(lambda (hl)
3986 \(and (= (org-element-property :level hl) 1)
3988 \(org-element-property :begin hl)))
3989 nil t)
3991 The next example will return a flat list of all `plain-list' type
3992 elements in TREE that are not a sub-list themselves:
3994 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3996 Eventually, this example will return a flat list of all `bold'
3997 type objects containing a `latex-snippet' type object, even
3998 looking into captions:
4000 \(org-element-map tree 'bold
4001 \(lambda (b)
4002 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4003 nil nil nil t)"
4004 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4007 ;; Recursion depth is determined by --CATEGORY.
4014 ;; If one object is found, the function
4015 ;; has to recurse into every object.
4018 ;; If one regular element is found, the
4019 ;; function has to recurse, at least,
4020 ;; into every element it encounters.
4023 types)
4024 category)))
4025 ;; Compute properties for affiliated keywords if necessary.
4030 org-element-affiliated-keywords)))
4031 --acc
4032 --walk-tree
4036 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4037 ;; holding contextual information.
4041 ;; Ignored element in an export context.
4043 ;; List of elements or objects.
4045 ;; Unconditionally enter parse trees.
4049 ;; Check if TYPE is matching among TYPES. If so,
4050 ;; apply FUN to --DATA and accumulate return value
4051 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4057 ;; If --DATA has a secondary string that can contain
4058 ;; objects with their type among TYPES, look into it.
4065 ;; If --DATA has any affiliated keywords and
4066 ;; WITH-AFFILIATED is non-nil, look for objects in
4067 ;; them.
4075 ;; Pay attention to the type of value.
4076 ;; Preserve order for multiple keywords.
4092 --affiliated-alist))
4093 ;; Determine if a recursion into --DATA is possible.
4095 ;; --TYPE is explicitly removed from recursion.
4097 ;; --DATA has no contents.
4099 ;; Looking for greater elements but --DATA is simply
4100 ;; an element or an object.
4103 ;; Looking for elements but --DATA is an object.
4106 ;; In any other case, map contents.
4110 ;; Return value in a proper order.
4114 ;; The following functions are internal parts of the parser.
4115 ;;
4116 ;; The first one, `org-element--parse-elements' acts at the element's
4117 ;; level.
4118 ;;
4119 ;; The second one, `org-element--parse-objects' applies on all objects
4120 ;; of a paragraph or a secondary string. It calls
4121 ;; `org-element--object-lex' to find the next object in the current
4122 ;; container.
4125 "Return next special mode according to TYPE, or nil.
4126 TYPE is a symbol representing the type of an element or object
4127 containing next element if PARENTP is non-nil, or before it
4128 otherwise. Modes can be either `first-section', `section',
4129 `planning', `item', `node-property' and `table-row'."
4145 "Parse elements between BEG and END positions.
4147 MODE prioritizes some elements over the others. It can be set to
4148 `first-section', `section', `planning', `item', `node-property'
4149 or `table-row'.
4151 When value is `item', STRUCTURE will be used as the current list
4152 structure.
4154 GRANULARITY determines the depth of the recursion. See
4155 `org-element-parse-buffer' for more information.
4157 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4158 elements.
4160 Elements are accumulated into ACC."
4163 ;; Visible only: skip invisible parts at the beginning of the
4164 ;; element.
4167 ;; When parsing only headlines, skip any text before first one.
4170 ;; Main loop start.
4172 ;; Find current element's type and parse it accordingly to
4173 ;; its category.
4175 end granularity mode structure))
4179 ;; Visible only: skip invisible parts between siblings.
4182 ;; Fill ELEMENT contents by side-effect.
4184 ;; If element has no contents, don't modify it.
4186 ;; Greater element: parse it between `contents-begin' and
4187 ;; `contents-end'. Make sure GRANULARITY allows the
4188 ;; recursion, or ELEMENT is a headline, in which case going
4189 ;; inside is mandatory, in order to get sub-level headings.
4197 ;; Possibly switch to a special mode.
4201 granularity visible-only element))
4202 ;; ELEMENT has contents. Parse objects inside, if
4203 ;; GRANULARITY allows it.
4209 ;; Update mode.
4211 ;; Return result.
4212 acc))
4218 ;; Sub/superscript.
4220 ;; Bold, code, italic, strike-through, underline and
4221 ;; verbatim.
4224 ;; Plain links.
4226 ;; Objects starting with "[": regular link, footnote
4227 ;; reference, statistics cookie, timestamp (inactive).
4229 ;; Objects starting with "@": export snippets.
4230 "@@"
4231 ;; Objects starting with "{": macro.
4232 "{{{"
4233 ;; Objects starting with "<" : timestamp (active,
4234 ;; diary), target, radio target and angular links.
4236 ;; Objects starting with "$": latex fragment.
4238 ;; Objects starting with "\": line break, entity,
4239 ;; latex fragment.
4241 ;; Objects starting with raw text: inline Babel
4242 ;; source block, inline Babel call.
4245 "Regexp possibly matching the beginning of an object.
4246 This regexp allows false positives. Dedicated parser (e.g.,
4247 `org-export-bold-parser') will take care of further filtering.
4248 Radio links are not matched by this regexp, as they are treated
4252 "Return next object in current buffer or nil.
4253 RESTRICTION is a list of object types, as symbols, that should be
4254 looked after. This function assumes that the buffer is narrowed
4255 to an appropriate container (e.g., a paragraph)."
4263 found)
4328 ;; This is probably a plain link.
4334 ;; Radio link.
4339 "Parse objects between BEG and END and return recursive structure.
4341 Objects are accumulated in ACC.
4343 RESTRICTION is a list of object successors which are allowed in
4344 the current object."
4352 ;; 1. Text before any object. Untabify it.
4357 acc
4361 ;; 2. Object...
4364 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4365 ;; a recursive type.
4373 ;; 3. Text after last object. Untabify it.
4377 acc
4381 ;; Result.
4382 acc)))
4385 \f
4386 ;;; Towards A Bijective Process
4387 ;;
4388 ;; The parse tree obtained with `org-element-parse-buffer' is really
4389 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4390 ;; interpreted and expanded into a string with canonical Org syntax.
4391 ;; Hence `org-element-interpret-data'.
4392 ;;
4393 ;; The function relies internally on
4394 ;; `org-element--interpret-affiliated-keywords'.
4396 ;;;###autoload
4398 "Interpret DATA as Org syntax.
4400 DATA is a parse tree, an element, an object or a secondary string
4401 to interpret.
4403 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4404 new types that should be treated as objects. An unknown type not
4405 belonging to this list is seen as a pseudo-element instead. Both
4406 pseudo-objects and pseudo-elements are transparent entities, i.e.
4407 only their contents are interpreted.
4409 Return Org syntax as a string."
4413 "Interpret DATA as Org syntax.
4415 DATA is a parse tree, an element, an object or a secondary string
4416 to interpret. PARENT is used for recursive calls. It contains
4417 the element or object containing data, or nil. PSEUDO-OBJECTS
4418 are list of symbols defining new element or object types.
4419 Unknown types that don't belong to this list are treated as
4420 pseudo-elements instead.
4422 Return Org syntax as a string."
4424 ;; Find interpreter for current object or element. If it
4425 ;; doesn't exist (e.g. this is a pseudo object or element),
4426 ;; return contents, if any.
4432 ;; Secondary string.
4438 ;; Full Org document.
4444 ;; Plain text: return it.
4446 ;; Element or object without contents.
4448 ;; Element or object with contents.
4451 ;; Recursively interpret contents.
4457 data
4458 ;; Fix indentation of elements containing
4459 ;; objects. We ignore `table-row' elements
4460 ;; as they are one line long anyway.
4462 data
4463 ;; When normalizing first paragraph of an
4464 ;; item or a footnote-definition, ignore
4465 ;; first line's indentation.
4472 ;; Build white spaces. If no `:post-blank' property is
4473 ;; specified, assume its value is 0.
4484 "Return ELEMENT's affiliated keywords as Org syntax.
4485 If there is no affiliated keyword, return the empty string."
4495 ": "
4498 value)
4506 ;; All attribute keywords can have multiple lines.
4512 ;; List all ELEMENT's properties matching an attribute line or an
4513 ;; affiliated keyword, but ignore translated keywords since they
4514 ;; cannot belong to the property list.
4521 org-element-keyword-translation-alist)))))
4522 collect prop)
4525 ;; Because interpretation of the parse tree must return the same
4526 ;; number of blank lines between elements and the same number of white
4527 ;; space after objects, some special care must be given to white
4528 ;; spaces.
4529 ;;
4530 ;; The first function, `org-element-normalize-string', ensures any
4531 ;; string different from the empty string will end with a single
4532 ;; newline character.
4533 ;;
4534 ;; The second function, `org-element-normalize-contents', removes
4535 ;; global indentation from the contents of the current element.
4538 "Ensure string S ends with a single newline character.
4540 If S isn't a string return it unchanged. If S is the empty
4541 string, return it. Otherwise, return a new string with a single
4542 newline character at its end."
4550 "Normalize plain text in ELEMENT's contents.
4552 ELEMENT must only contain plain text and objects.
4554 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4555 indentation to compute maximal common indentation.
4557 Return the normalized element that is element with global
4558 indentation removed from its contents. The function assumes that
4559 indentation is not done with TAB characters."
4561 find-min-ind ; For byte-compiler.
4563 ;; Return minimal common indentation within BLOB. This is
4564 ;; done by walking recursively BLOB and updating MIN-IND
4565 ;; along the way. FIRST-FLAG is non-nil when the first
4566 ;; string hasn't been seen yet. It is required as this
4567 ;; string is the only one whose indentation doesn't happen
4568 ;; after a newline character.
4575 ;; An indentation of zero means no string will be
4576 ;; modified. Quit the process.
4586 ;; Find minimal indentation in ELEMENT.
4589 ;; Build ELEMENT back, replacing each string with the same
4590 ;; string minus common indentation.
4595 ;; Return BLOB with all its strings indentation
4596 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4597 ;; is non-nil when the first string hasn't been seen
4598 ;; yet.
4613 org-element-recursive-objects)
4617 blob))))
4621 \f
4622 ;;; Cache
4623 ;;
4624 ;; Implement a caching mechanism for `org-element-at-point' and
4625 ;; `org-element-context', which see.
4626 ;;
4627 ;; A single public function is provided: `org-element-cache-reset'.
4628 ;;
4629 ;; Cache is enabled by default, but can be disabled globally with
4630 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4631 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4632 ;; can be tweaked to control caching behaviour.
4633 ;;
4634 ;; Internally, parsed elements are stored in an AVL tree,
4635 ;; `org-element--cache'. This tree is updated lazily: whenever
4636 ;; a change happens to the buffer, a synchronization request is
4637 ;; registered in `org-element--cache-sync-requests' (see
4638 ;; `org-element--cache-submit-request'). During idle time, requests
4639 ;; are processed by `org-element--cache-sync'. Synchronization also
4640 ;; happens when an element is required from the cache. In this case,
4641 ;; the process stops as soon as the needed element is up-to-date.
4642 ;;
4643 ;; A synchronization request can only apply on a synchronized part of
4644 ;; the cache. Therefore, the cache is updated at least to the
4645 ;; location where the new request applies. Thus, requests are ordered
4646 ;; from left to right and all elements starting before the first
4647 ;; request are correct. This property is used by functions like
4648 ;; `org-element--cache-find' to retrieve elements in the part of the
4649 ;; cache that can be trusted.
4650 ;;
4651 ;; A request applies to every element, starting from its original
4652 ;; location (or key, see below). When a request is processed, it
4653 ;; moves forward and may collide the next one. In this case, both
4654 ;; requests are merged into a new one that starts from that element.
4655 ;; As a consequence, the whole synchronization complexity does not
4656 ;; depend on the number of pending requests, but on the number of
4657 ;; elements the very first request will be applied on.
4658 ;;
4659 ;; Elements cannot be accessed through their beginning position, which
4660 ;; may or may not be up-to-date. Instead, each element in the tree is
4661 ;; associated to a key, obtained with `org-element--cache-key'. This
4662 ;; mechanism is robust enough to preserve total order among elements
4663 ;; even when the tree is only partially synchronized.
4664 ;;
4665 ;; Objects contained in an element are stored in a hash table,
4666 ;; `org-element--cache-objects'.
4670 "Non nil when Org parser should cache its results.
4677 "Maximum duration, as a time value, for a cache synchronization.
4678 If the synchronization is not over after this delay, the process
4679 pauses and resumes after `org-element-cache-sync-break'
4683 "Duration, as a time value, of the pause between synchronizations.
4687 ;;;; Data Structure
4690 "AVL tree used to cache elements.
4691 Each node of the tree contains an element. Comparison is done
4692 with `org-element--cache-compare'. This cache is used in
4696 "Hash table used as to cache objects.
4697 Key is an element, as returned by `org-element-at-point', and
4698 value is an alist where each association is:
4700 \(PARENT COMPLETEP . OBJECTS)
4702 where PARENT is an element or object, COMPLETEP is a boolean,
4703 non-nil when all direct children of parent are already cached and
4704 OBJECTS is a list of such children, as objects, from farthest to
4705 closest.
4708 contained within a paragraph
4712 If the paragraph is completely parsed, OBJECTS-DATA will be
4714 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4715 \(BOLD-OBJECT t ENTITY-OBJECT))
4717 whereas in a partially parsed paragraph, it could be
4719 \((PARAGRAPH nil ENTITY-OBJECT))
4724 "List of pending synchronization requests.
4726 A request is a vector with the following pattern:
4728 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4730 Processing a synchronization request consists of three phases:
4732 0. Delete modified elements,
4733 1. Fill missing area in cache,
4734 2. Shift positions and re-parent elements after the changes.
4736 During phase 0, NEXT is the key of the first element to be
4737 removed, BEG and END is buffer position delimiting the
4738 modifications. Elements starting between them (inclusive) are
4739 removed and so are those contained within OUTREACH. PARENT, when
4740 non-nil, is the parent of the first element to be removed.
4742 During phase 1, NEXT is the key of the next known element in
4743 cache and BEG its beginning position. Parse buffer between that
4744 element and the one before it in order to determine the parent of
4745 the next element. Set PARENT to the element containing NEXT.
4747 During phase 2, NEXT is the key of the next element to shift in
4748 the parse tree. All elements starting from this one have their
4749 properties relatives to buffer positions shifted by integer
4750 OFFSET and, if they belong to element PARENT, are adopted by it.
4758 "Hash table used to store keys during synchronization.
4762 "Return a unique key for ELEMENT in cache tree.
4764 Keys are used to keep a total order among elements in the cache.
4765 Comparison is done with `org-element--cache-key-less-p'.
4767 When no synchronization is taking place, a key is simply the
4768 beginning position of the element, or that position plus one in
4769 the case of an first item (respectively row) in
4770 a list (respectively a table).
4772 During a synchronization, the key is the one the element had when
4773 the cache was synchronized for the last time. Elements added to
4774 cache during the synchronization get a new key generated with
4775 `org-element--cache-generate-key'.
4777 Such keys are stored in `org-element--cache-sync-keys'. The hash
4778 table is cleared once the synchronization is complete."
4781 ;; Increase beginning position of items (respectively
4782 ;; table rows) by one, so the first item can get
4783 ;; a different key from its parent list (respectively
4784 ;; table).
4787 begin)))
4790 key))))
4793 "Generate a key between LOWER and UPPER.
4795 LOWER and UPPER are integers or lists, possibly empty.
4797 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4798 a unique key, as an integer or a list of integers, according to
4799 the following rules:
4801 - LOWER and UPPER are compared level-wise until values differ.
4803 - If, at a given level, LOWER and UPPER differ from more than
4804 2, the new key shares all the levels above with LOWER and
4805 gets a new level. Its value is the mean between LOWER and
4806 UPPER:
4808 \(1 2) + (1 4) --> (1 3)
4810 - If LOWER has no value to compare with, it is assumed that its
4811 value is `most-negative-fixnum'. E.g.,
4813 \(1 1) + (1 1 2)
4815 is equivalent to
4817 \(1 1 m) + (1 1 2)
4819 where m is `most-negative-fixnum'. Likewise, if UPPER is
4820 short of levels, the current value is `most-positive-fixnum'.
4822 - If they differ from only one, the new key inherits from
4823 current LOWER level and fork it at the next level. E.g.,
4825 \(2 1) + (3 3)
4827 is equivalent to
4829 \(2 1) + (2 M)
4831 where M is `most-positive-fixnum'.
4833 - If the key is only one level long, it is returned as an
4834 integer:
4836 \(1 2) + (3 2) --> 2
4838 When they are not equals, the function assumes that LOWER is
4839 lesser than UPPER, per `org-element--cache-key-less-p'."
4843 skip-upper key)
4854 ;; When at a given level, LOWER and UPPER differ from
4855 ;; 1, ignore UPPER altogether. Instead create a key
4856 ;; between LOWER and the greatest key with the same
4857 ;; prefix as LOWER so far.
4863 "Non-nil if key A is less than key B.
4864 A and B are either integers or lists of integers, as returned by
4865 `org-element--cache-key'."
4873 ;; If A is empty, either keys are equal (B is also empty) and
4874 ;; we return nil, or A is lesser than B (B is longer) and we
4875 ;; return a non-nil value.
4876 ;;
4877 ;; If A is not empty, B is necessarily empty and A is greater
4878 ;; than B (A is longer). Therefore, return nil.
4882 "Non-nil when element A is located before element B."
4887 "Return root value in cache.
4888 This function assumes `org-element--cache' is a valid AVL tree."
4892 ;;;; Tools
4895 "Non-nil when cache is active in current buffer."
4900 "Find element in cache starting at POS or before.
4902 POS refers to a buffer position.
4904 When optional argument SIDE is non-nil, the function checks for
4905 elements starting at or past POS instead. If SIDE is `both', the
4906 function returns a cons cell where car is the first element
4907 starting at or before POS and cdr the first element starting
4908 after POS.
4910 The function can only find elements in the synchronized part of
4911 the cache."
4915 lower upper)
4930 ;; We found an element in cache starting at POS. If `side'
4931 ;; is `both' we also want the next one in order to generate
4932 ;; a key in-between.
4933 ;;
4934 ;; If the element is the first row or item in a table or
4935 ;; a plain list, we always return the table or the plain
4936 ;; list.
4937 ;;
4938 ;; In any other case, we return the element found.
4947 lower parent
4948 upper parent)))))
4951 lower element
4952 upper element)))))
4959 "Store ELEMENT in current buffer's cache, if allowed.
4960 When optional argument DATA is non-nil, assume is it object data
4961 relative to ELEMENT and store it in the objects cache."
4965 ;; During synchronization, first build an appropriate key
4966 ;; for the new element so `avl-tree-enter' can insert it at
4967 ;; the right spot in the cache.
4976 org-element--cache-sync-keys)))
4978 ;; Headlines are not stored in cache, so objects in titles are
4979 ;; not stored either.
4984 "Remove ELEMENT from cache.
4985 Assume ELEMENT belongs to cache and that a cache is active."
4990 ;;;; Synchronization
4993 "Set idle timer for cache synchronization in BUFFER."
5000 org-element-cache-sync-idle-time))
5001 nil
5002 #'org-element--cache-sync
5003 buffer)))
5006 "Non-nil when synchronization process should be interrupted.
5007 TIME-LIMIT is a time value or nil."
5013 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5015 Properties containing buffer positions are `:begin', `:end',
5016 `:contents-begin', `:contents-end' and `:structure'. When
5017 optional argument PROPS is a list of keywords, only shift
5018 properties provided in that list.
5020 Properties are modified by side-effect."
5022 ;; Shift `:structure' property for the first plain list only: it
5023 ;; is the only one that really matters and it prevents from
5024 ;; shifting it more than once.
5038 "Synchronize cache with recent modification in BUFFER.
5040 When optional argument THRESHOLD is non-nil, do the
5041 synchronization for all elements starting before or at threshold,
5042 then exit. Otherwise, synchronize cache for as long as
5043 `org-element-cache-sync-duration' or until Emacs leaves idle
5044 state.
5046 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5047 not registered yet in the cache are going to happen. It is used
5048 in `org-element--cache-submit-request', where cache is partially
5049 updated before current modification are actually submitted."
5060 request
5062 threshold
5065 org-element-cache-sync-duration))
5066 future-change)
5067 ;; Request processed. Merge current and next offsets and
5068 ;; transfer ending position.
5074 ;; If more requests are awaiting, set idle timer accordingly.
5075 ;; Otherwise, reset keys.
5082 "Process synchronization REQUEST for all entries before NEXT.
5084 REQUEST is a vector, built by `org-element--cache-submit-request'.
5086 NEXT is a cache key, as returned by `org-element--cache-key'.
5088 When non-nil, THRESHOLD is a buffer position. Synchronization
5089 stops as soon as a shifted element begins after it.
5091 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5092 after this time or when Emacs exits idle state.
5094 When non-nil, FUTURE-CHANGE is a buffer position where changes
5095 not registered yet in the cache are going to happen. See
5096 `org-element--cache-submit-request' for more information.
5098 Throw `interrupt' if the process stops before completing the
5099 request."
5102 ;; Phase 0.
5103 ;;
5104 ;; Delete all elements starting after BEG, but not after buffer
5105 ;; position END or past element with key NEXT.
5106 ;;
5107 ;; At each iteration, we start again at tree root since
5108 ;; a deletion modifies structure of the balanced tree.
5116 ;; Find first element in cache with key BEG or after it.
5126 data-key key
5129 data-key key
5130 node nil)))))
5139 up))
5145 ;; No element starting after modifications left in
5146 ;; cache: further processing is futile.
5149 ;; Phase 1.
5150 ;;
5151 ;; Phase 0 left a hole in the cache. Some elements after it
5152 ;; could have parents within. For example, in the following
5153 ;; buffer:
5154 ;;
5155 ;; - item
5156 ;;
5157 ;;
5158 ;; Paragraph1
5159 ;;
5160 ;; Paragraph2
5161 ;;
5162 ;; if we remove a blank line between "item" and "Paragraph1",
5163 ;; everything down to "Paragraph2" is removed from cache. But
5164 ;; the paragraph now belongs to the list, and its `:parent'
5165 ;; property no longer is accurate.
5166 ;;
5167 ;; Therefore we need to parse again elements in the hole, or at
5168 ;; least in its last section, so that we can re-parent
5169 ;; subsequent elements, during phase 2.
5170 ;;
5171 ;; Note that we only need to get the parent from the first
5172 ;; element in cache after the hole.
5173 ;;
5174 ;; When next key is lesser or equal to the current one, delegate
5175 ;; phase 1 processing to next request in order to preserve key
5176 ;; order among requests.
5184 ;; Next element will start at its beginning position plus
5185 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5186 ;; contains the real beginning position of the first element to
5187 ;; shift and re-parent.
5191 ;; Changes are going to happen around this element and
5192 ;; they will trigger another phase 1 request. Skip the
5193 ;; current one.
5199 ;; Phase 2.
5200 ;;
5201 ;; Shift all elements starting from key START, but before NEXT, by
5202 ;; OFFSET, and re-parent them when appropriate.
5203 ;;
5204 ;; Elements are modified by side-effect so the tree structure
5205 ;; remains intact.
5206 ;;
5207 ;; Once THRESHOLD, if any, is reached, or once there is an input
5208 ;; pending, exit. Before leaving, the current synchronization
5209 ;; request is updated.
5216 exit-flag)
5217 ;; No re-parenting nor shifting planned: request is over.
5227 ;; We reached NEXT. Request is complete.
5229 ;; Handle interruption request. Update current request.
5234 ;; Shift element.
5237 ;; Shift associated objects data, if any.
5242 ;; Update PARENT and re-parent DATA, only when
5243 ;; necessary. Propagate new structures for lists.
5257 ;; Cache is up-to-date past THRESHOLD. Request
5258 ;; interruption.
5263 ;; We reached end of tree: synchronization complete.
5264 t)))
5267 "Parse elements in current section, down to POS.
5269 Start parsing from the closest between the last known element in
5270 cache or headline above. Return the smallest element containing
5271 POS.
5273 When optional argument SYNCP is non-nil, return the parent of the
5274 element containing POS instead. In that case, it is also
5275 possible to provide TIME-LIMIT, which is a time value specifying
5276 when the parsing should stop. The function throws `interrupt' if
5277 the process stopped before finding the expected result."
5284 element next mode)
5286 ;; Nothing in cache before point: start parsing from first
5287 ;; element following headline above, or first element in
5288 ;; buffer.
5295 ;; Cache returned exact match: return it.
5298 ;; There's a headline between cached value and POS: cached
5299 ;; value is invalid. Start parsing from first element
5300 ;; following the headline.
5307 ;; Check if CACHED or any of its ancestors contain point.
5308 ;;
5309 ;; If there is such an element, we inspect it in order to know
5310 ;; if we return it or if we need to parse its contents.
5311 ;; Otherwise, we just start parsing from current location,
5312 ;; which is right after the top-most element containing
5313 ;; CACHED.
5314 ;;
5315 ;; As a special case, if POS is at the end of the buffer, we
5316 ;; want to return the innermost element ending there.
5317 ;;
5318 ;; Also, if we find an ancestor and discover that we need to
5319 ;; parse its contents, make sure we don't start from
5320 ;; `:contents-begin', as we would otherwise go past CACHED
5321 ;; again. Instead, in that situation, we will resume parsing
5322 ;; from NEXT, which is located after CACHED or its higher
5323 ;; ancestor not containing point.
5335 ;; Parse successively each element until we reach POS.
5348 end 'element mode
5355 ;; Skip any element ending before point. Also skip
5356 ;; element ending at point (unless it is also the end of
5357 ;; buffer) since we're sure that another element begins
5358 ;; after it.
5362 ;; A non-greater element contains point: return it.
5365 ;; Otherwise, we have to decide if ELEMENT really
5366 ;; contains POS. In that case we start parsing from
5367 ;; contents' beginning.
5368 ;;
5369 ;; If POS is at contents' beginning but it is also at
5370 ;; the beginning of the first item in a list or a table.
5371 ;; In that case, we need to create an anchor for that
5372 ;; list or table, so return it.
5373 ;;
5374 ;; Also, if POS is at the end of the buffer, no element
5375 ;; can start after it, but more than one may end there.
5376 ;; Arbitrarily, we choose to return the innermost of
5377 ;; such elements.
5390 parent element
5391 end cend))))
5392 ;; Otherwise, return ELEMENT as it is the smallest
5393 ;; element containing POS.
5398 ;;;; Staging Buffer Changes
5404 ;; Blocks
5406 ;; LaTeX environments.
5408 ;; Drawers.
5411 "Regexp matching a sensitive line, structure wise.
5412 A sensitive line is a headline, inlinetask, block, drawer, or
5413 latex-environment boundary. When such a line is modified,
5414 structure changes in the document may propagate in the whole
5418 "Non-nil when a sensitive line is about to be changed.
5422 "Request extension of area going to be modified if needed.
5423 BEG and END are the beginning and end of the range of changed
5424 text. See `before-change-functions' for more information."
5434 'headline
5437 org-element--cache-sensitive-re bottom t)))))))))
5440 "Update buffer modifications for current buffer.
5441 BEG and END are the beginning and end of the range of changed
5442 text, and the length in bytes of the pre-change text replaced by
5443 that range. See `after-change-functions' for more information."
5451 ;; Determine if modified area needs to be extended, according
5452 ;; to both previous and current state. We make a special
5453 ;; case for headline editing: if a headline is modified but
5454 ;; not removed, do not extend.
5463 org-element--cache-sensitive-re bottom t))))
5464 ;; Effectively extend modified area.
5472 ;; Store synchronization request.
5475 ;; Activate a timer to process the request during idle time.
5479 "Return first element to remove from cache.
5481 BEG and END are buffer positions delimiting buffer modifications.
5482 OFFSET is the size of the changes.
5484 Returned element is usually the first element in cache containing
5485 any position between BEG and END. As an exception, greater
5486 elements around the changes that are robust to contents
5487 modifications are preserved and updated according to the
5488 changes."
5498 quote-block special-block))
5503 ;; UP is a robust greater element containing changes.
5504 ;; We only need to extend its ending boundaries.
5510 ;; We're at top level element containing ELEMENT: if it's
5511 ;; altered by buffer modifications, it is first element in
5512 ;; cache to be removed. Otherwise, that first element is the
5513 ;; following one.
5514 ;;
5515 ;; As a special case, do not remove BEFORE if it is a robust
5516 ;; container for current changes.
5518 before)))))
5521 "Submit a new cache synchronization request for current buffer.
5522 BEG and END are buffer positions delimiting the minimal area
5523 where cache data should be removed. OFFSET is the size of the
5524 change, as an integer."
5526 delete-to delete-from)
5531 ;; Current changes can be merged with first sync request: we
5532 ;; can save a partial cache synchronization.
5535 ;; If last change happened within area to be removed, extend
5536 ;; boundaries of robust parents, if any. Otherwise, find
5537 ;; first element to remove and update request accordingly.
5549 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5550 ;; if any, is no longer a 0-phase request, thus ensuring that
5551 ;; phases are properly ordered. We need to provide OFFSET as
5552 ;; optional parameter since current modifications are not known
5553 ;; yet to the otherwise correct part of the cache (i.e, before
5554 ;; the first request).
5561 ;; When changes happen before the first known
5562 ;; element, re-parent and shift the rest of the
5563 ;; cache.
5565 ;; Otherwise, we find the first non robust
5566 ;; element containing END. All elements between
5567 ;; FIRST and this one are to be removed.
5568 ;;
5569 ;; Among them, some could be located outside the
5570 ;; synchronized part of the cache, in which case
5571 ;; comparing buffer positions to find them is
5572 ;; useless. Instead, we store the element
5573 ;; containing them in the request itself. All
5574 ;; its children will be removed.
5586 element up))
5589 org-element--cache-sync-requests)
5590 ;; No element to remove. No need to re-parent either.
5591 ;; Simply shift additional elements, if any, by OFFSET.
5596 ;;;; Public Functions
5598 ;;;###autoload
5600 "Reset cache in current buffer.
5601 When optional argument ALL is non-nil, reset cache in all Org
5602 buffers."
5620 ;;;###autoload
5622 "Refresh cache at position POS."
5629 \f
5630 ;;; The Toolbox
5631 ;;
5632 ;; The first move is to implement a way to obtain the smallest element
5633 ;; containing point. This is the job of `org-element-at-point'. It
5634 ;; basically jumps back to the beginning of section containing point
5635 ;; and proceed, one element after the other, with
5636 ;; `org-element--current-element' until the container is found. Note:
5637 ;; When using `org-element-at-point', secondary values are never
5638 ;; parsed since the function focuses on elements, not on objects.
5639 ;;
5640 ;; At a deeper level, `org-element-context' lists all elements and
5641 ;; objects containing point.
5642 ;;
5643 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5644 ;; internally by navigation and manipulation tools.
5647 ;;;###autoload
5649 "Determine closest element around point.
5651 Return value is a list like (TYPE PROPS) where TYPE is the type
5652 of the element and PROPS a plist of properties associated to the
5653 element.
5655 Possible types are defined in `org-element-all-elements'.
5656 Properties depend on element or object type, but always include
5657 `:begin', `:end', `:parent' and `:post-blank' properties.
5659 As a special case, if point is at the very beginning of the first
5660 item in a list or sub-list, returned element will be that list
5661 instead of the item. Likewise, if point is at the beginning of
5662 the first row of a table, returned element will be the table
5663 instead of the first row.
5665 When point is at the end of the buffer, return the innermost
5666 element ending there."
5672 ;; Within blank lines at the beginning of buffer, return nil.
5674 ;; Within blank lines right after a headline, return that
5675 ;; headline.
5679 ;; Otherwise parse until we find element containing ORIGIN.
5686 ;;;###autoload
5688 "Return smallest element or object around point.
5690 Return value is a list like (TYPE PROPS) where TYPE is the type
5691 of the element or object and PROPS a plist of properties
5692 associated to it.
5694 Possible types are defined in `org-element-all-elements' and
5695 `org-element-all-objects'. Properties depend on element or
5696 object type, but always include `:begin', `:end', `:parent' and
5697 `:post-blank'.
5699 As a special case, if point is right after an object and not at
5700 the beginning of any other object, return that object.
5702 Optional argument ELEMENT, when non-nil, is the closest element
5703 containing point, as returned by `org-element-at-point'.
5704 Providing it allows for quicker computation."
5710 ;; If point is inside an element containing objects or
5711 ;; a secondary string, narrow buffer to the container and
5712 ;; proceed with parsing. Otherwise, return ELEMENT.
5714 ;; At a parsed affiliated keyword, check if we're inside main
5715 ;; or dual value.
5722 org-element-parsed-keywords))
5731 ;; Also change type to retrieve correct restrictions.
5733 ;; At an item, objects can only be located within tag, if any.
5743 ;; At an headline or inlinetask, objects are in title.
5750 ;; At a paragraph, a table-row or a verse block, objects are
5751 ;; located within their contents.
5755 ;; CBEG is nil for table rules.
5760 ;; At a parsed keyword, objects are located within value.
5763 org-element-document-properties))
5770 ;; At a planning line, if point is at a timestamp, return it,
5771 ;; otherwise, return element.
5779 ;; All other locations cannot contain objects: bail out.
5789 next object-data last)
5793 ;; When entering PARENT for the first time, get list
5794 ;; of objects within known so far. Store it in
5795 ;; OBJECT-DATA.
5800 ;; Find NEXT object for analysis.
5802 ;; If NEXT is non-nil, we already exhausted the
5803 ;; cache so we can parse buffer to find the object
5804 ;; after it.
5806 ;; Otherwise, check if cache can help us.
5817 ;; Cache contains the information needed.
5820 pos)
5822 pos)
5828 ;; If we have a new object to analyze, store it in
5829 ;; cache. Otherwise record that there is nothing
5830 ;; more to parse in this element at this depth.
5835 ;; Process NEXT, if any, in order to know if we need
5836 ;; to skip it, return it or move into it.
5843 ;; Skip objects ending before point. Also skip
5844 ;; objects ending at point unless it is also the
5845 ;; end of buffer, since we want to return the
5846 ;; innermost object.
5849 ;; For convenience, when object ends at POS,
5850 ;; without any space, store it in LAST, as we
5851 ;; will return it if no object starts here.
5855 ;; If POS is within a container object, move
5856 ;; into that object.
5860 ;; At contents' end, if there is no
5861 ;; space before point, also move into
5862 ;; object, for consistency with
5863 ;; convenience feature above.
5872 next nil
5873 object-data nil))
5874 ;; Otherwise, return NEXT.
5876 ;; Store results in cache, if applicable.
5880 "Non-nil when elements ELEM-A and ELEM-B are nested."
5889 "Swap elements ELEM-A and ELEM-B.
5890 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5891 end of ELEM-A."
5893 ;; There are two special cases when an element doesn't start at bol:
5894 ;; the first paragraph in an item or in a footnote definition.
5896 ;; Only a paragraph without any affiliated keyword can be moved at
5897 ;; ELEM-A position in such a situation. Note that the case of
5898 ;; a footnote definition is impossible: it cannot contain two
5899 ;; paragraphs in a row because it cannot contain a blank line.
5905 ;; In a special situation, ELEM-A will have no indentation. We'll
5906 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5920 ;; Store overlays responsible for visibility status. We
5921 ;; also need to store their boundaries as they will be
5922 ;; removed from buffer.
5929 ;; Get contents.
5937 ;; Restore ex ELEM-A overlays.
5946 ;; Restore ex ELEM-B overlays.
5954 "Remove maximum common indentation in string S and return it.
5955 When optional argument N is a positive integer, remove exactly
5956 that much characters from indentation, if possible, or return
5957 S as-is otherwise. Unlike to `org-remove-indentation', this
5958 function doesn't call `untabify' on S."
5963 ;; Find maximum common indentation, if not specified.
5971 min-ind)))
5973 ;; Remove exactly N indentation, but give up if not possible.
5986 ;; Local variables:
5987 ;; generated-autoload-file: "org-loaddefs.el"
5988 ;; End:
5990 ;;; org-element.el ends here