| blob | 6e9f93fe4a01b57065f84cb9c818701cc356ea9f |
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', `fixed-width',
49 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
50 ;; `paragraph', `planning', `src-block', `table', `table-row' and
51 ;; `verse-block'. Among them, `paragraph' and `verse-block' types can
52 ;; contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, greater elements and elements accepting
77 ;; affiliated keywords will have a `:post-affiliated' property,
78 ;; referring to the buffer position after all such keywords.
79 ;;
80 ;; At the lowest level, a `:parent' property is also attached to any
81 ;; string, as a text property.
82 ;;
83 ;; Lisp-wise, an element or an object can be represented as a list.
84 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
85 ;; TYPE is a symbol describing the Org element or object.
86 ;; PROPERTIES is the property list attached to it. See docstring of
87 ;; appropriate parsing function to get an exhaustive
88 ;; list.
89 ;; CONTENTS is a list of elements, objects or raw strings contained
90 ;; in the current element or object, when applicable.
91 ;;
92 ;; An Org buffer is a nested list of such elements and objects, whose
93 ;; type is `org-data' and properties is nil.
94 ;;
95 ;; The first part of this file defines Org syntax, while the second
96 ;; one provide accessors and setters functions.
97 ;;
98 ;; The next part implements a parser and an interpreter for each
99 ;; element and object type in Org syntax.
100 ;;
101 ;; The following part creates a fully recursive buffer parser. It
102 ;; also provides a tool to map a function to elements or objects
103 ;; matching some criteria in the parse tree. Functions of interest
104 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
105 ;; extent, `org-element-parse-secondary-string'.
106 ;;
107 ;; The penultimate part is the cradle of an interpreter for the
108 ;; obtained parse tree: `org-element-interpret-data'.
109 ;;
110 ;; The library ends by furnishing `org-element-at-point' function, and
111 ;; a way to give information about document structure around point
112 ;; with `org-element-context'. A cache mechanism is also provided for
113 ;; these functions.
116 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block fixed-width footnote-definition
177 headline horizontal-rule inlinetask item keyword
178 latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block section special-block
180 src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 inline-src-block italic line-break latex-fragment link macro
192 radio-target statistics-cookie strike-through subscript superscript
193 table-cell target timestamp underline verbatim)
198 superscript table-cell underline)
208 "Alist between block names and the associated parsing function.
209 Names must be uppercase. Any block whose name has no association
215 Only these types can accept search options and an explicit
221 "List of affiliated keywords as strings.
229 "Alist of usual translations for keywords.
230 The key is the old name and the value the new one. The property
234 "List of affiliated keywords that can occur more than once in an element.
236 Their value will be consed into a list of strings, which will be
237 returned as the value of the property.
239 This list is checked after translations have been applied. See
240 `org-element-keyword-translation-alist'.
246 "List of affiliated keywords whose value can be parsed.
248 Their value will be stored as a secondary string: a list of
249 strings and objects.
251 This list is checked after translations have been applied. See
255 "List of affiliated keywords which can have a secondary value.
257 In Org syntax, they can be written with optional square brackets
258 before the colons. For example, RESULTS keyword can be
259 associated to a hash value with the following:
261 #+RESULTS[hash-string]: some-source
263 This list is checked after translations have been applied. See
267 "List of properties associated to the whole document.
268 Any keyword in this list will have its value parsed and stored as
274 ;; Dual affiliated keywords.
278 ;; Regular affiliated keywords.
284 org-element-affiliated-keywords)))
286 ;; Export attributes.
288 "Regexp matching any affiliated keyword.
290 Keyword name is put in match group 1. Moreover, if keyword
291 belongs to `org-element-dual-keywords', put the dual value in
292 match group 2.
306 ;; Ignore all links excepted plain links in a link description.
307 ;; Also ignore radio-targets and line breaks.
309 italic latex-fragment macro plain-link statistics-cookie
310 strike-through subscript superscript underline verbatim)
312 ;; Remove any variable object from radio target as it would
313 ;; prevent it from being properly recognized.
315 subscript superscript underline superscript)
319 ;; Ignore inline babel call and inline src block as formulas are
320 ;; possible. Also ignore line breaks and statistics cookies.
322 latex-fragment link macro radio-target strike-through
323 subscript superscript target timestamp underline verbatim)
327 "Alist of objects restrictions.
329 key is an element or object type containing objects and value is
330 a list of types that can be contained within an element or object
331 of such type.
333 For example, in a `radio-target' object, one can only find
334 entities, latex-fragments, subscript, superscript and text
335 markup.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
348 \f
349 ;;; Accessors and Setters
350 ;;
351 ;; Provide four accessors: `org-element-type', `org-element-property'
352 ;; `org-element-contents' and `org-element-restriction'.
353 ;;
354 ;; Setter functions allow to modify elements by side effect. There is
355 ;; `org-element-put-property', `org-element-set-contents'. These
356 ;; low-level functions are useful to build a parse tree.
357 ;;
358 ;; `org-element-adopt-element', `org-element-set-element',
359 ;; `org-element-extract-element' and `org-element-insert-before' are
360 ;; high-level functions useful to modify a parse tree.
361 ;;
362 ;; `org-element-secondary-p' is a predicate used to know if a given
363 ;; object belongs to a secondary string.
366 "Return type of ELEMENT.
368 The function returns the type of the element or object provided.
369 It can also return the following special value:
370 `plain-text' for a string
371 `org-data' for a complete document
372 nil in any other case."
378 "Extract the value from the PROPERTY of an ELEMENT."
383 "Extract contents from an ELEMENT."
389 "Return restriction associated to ELEMENT.
390 ELEMENT can be an element, an object or a symbol representing an
391 element or object type."
393 org-element-object-restrictions)))
396 "In ELEMENT set PROPERTY to VALUE.
397 Return modified element."
400 element))
403 "Set ELEMENT contents to CONTENTS.
404 Return modified element."
411 "Non-nil when OBJECT belongs to a secondary string.
412 Return value is the property name, as a keyword, or nil."
415 org-element-secondary-value-alist))))
418 property)))
421 "Append elements to the contents of another element.
423 PARENT is an element or object. CHILDREN can be elements,
424 objects, or a strings.
426 The function takes care of setting `:parent' property for CHILD.
427 Return parent element."
428 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
429 ;; string: parent is the list itself.
432 children)
433 ;; Add CHILDREN at the end of PARENT contents.
436 parent
438 ;; Return modified PARENT element.
442 "Extract ELEMENT from parse tree.
443 Remove element from the parse tree by side-effect, and return it
444 with its `:parent' property stripped out."
449 parent secondary
452 parent
454 ;; Return ELEMENT with its :parent removed.
458 "Insert ELEMENT before LOCATION in parse tree.
459 LOCATION is an element, object or string within the parse tree.
460 Parse tree is modified by side effect."
465 ;; Special case: LOCATION is the first element of an
466 ;; independent secondary string (e.g. :title property). Add
467 ;; ELEMENT in-place.
471 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
481 ;; Store SIBLINGS at appropriate place in parse tree.
486 ;; Set appropriate :parent property.
490 "Replace element or object OLD with element or object NEW.
491 The function takes care of setting `:parent' property for NEW."
492 ;; Ensure OLD and NEW have the same parent.
496 ;; We cannot replace OLD with NEW since one of them is not an
497 ;; object or element. We take the long path.
500 ;; Since OLD is going to be changed into NEW by side-effect, first
501 ;; make sure that every element or object within NEW has OLD as
502 ;; parent.
505 ;; Transfer contents.
507 ;; Overwrite OLD's properties with NEW's.
509 ;; Transfer type.
513 \f
514 ;;; Greater elements
515 ;;
516 ;; For each greater element type, we define a parser and an
517 ;; interpreter.
518 ;;
519 ;; A parser returns the element or object as the list described above.
520 ;; Most of them accepts no argument. Though, exceptions exist. Hence
521 ;; every element containing a secondary string (see
522 ;; `org-element-secondary-value-alist') will accept an optional
523 ;; argument to toggle parsing of that secondary string. Moreover,
524 ;; `item' parser requires current list's structure as its first
525 ;; element.
526 ;;
527 ;; An interpreter accepts two arguments: the list representation of
528 ;; the element or object, and its contents. The latter may be nil,
529 ;; depending on the element or object considered. It returns the
530 ;; appropriate Org syntax, as a string.
531 ;;
532 ;; Parsing functions must follow the naming convention:
533 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
534 ;; defined in `org-element-greater-elements'.
535 ;;
536 ;; Similarly, interpreting functions must follow the naming
537 ;; convention: org-element-TYPE-interpreter.
538 ;;
539 ;; With the exception of `headline' and `item' types, greater elements
540 ;; cannot contain other greater elements of their own type.
541 ;;
542 ;; Beside implementing a parser and an interpreter, adding a new
543 ;; greater element requires to tweak `org-element--current-element'.
544 ;; Moreover, the newly defined type must be added to both
545 ;; `org-element-all-elements' and `org-element-greater-elements'.
548 ;;;; Center Block
551 "Parse a center block.
553 LIMIT bounds the search. AFFILIATED is a list of which CAR is
554 the buffer position at the beginning of the first affiliated
555 keyword and CDR is a plist of affiliated keywords along with
556 their value.
558 Return a list whose CAR is `center-block' and CDR is a plist
559 containing `:begin', `:end', `:contents-begin', `:contents-end',
560 `:post-blank' and `:post-affiliated' keywords.
562 Assume point is at the beginning of the block."
566 ;; Incomplete block: parse it as a paragraph.
571 ;; Empty blocks have no contents.
585 :end end
586 :contents-begin contents-begin
587 :contents-end contents-end
593 "Interpret CENTER-BLOCK element as Org syntax.
594 CONTENTS is the contents of the element."
598 ;;;; Drawer
601 "Parse a drawer.
603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
604 the buffer position at the beginning of the first affiliated
605 keyword and CDR is a plist of affiliated keywords along with
606 their value.
608 Return a list whose CAR is `drawer' and CDR is a plist containing
609 `:drawer-name', `:begin', `:end', `:contents-begin',
610 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
612 Assume point is at beginning of drawer."
615 ;; Incomplete drawer: parse it as a paragraph.
623 ;; Empty drawers have no contents.
636 :end end
637 :drawer-name name
638 :contents-begin contents-begin
639 :contents-end contents-end
645 "Interpret DRAWER element as Org syntax.
646 CONTENTS is the contents of the element."
649 contents))
652 ;;;; Dynamic Block
655 "Parse a dynamic block.
657 LIMIT bounds the search. AFFILIATED is a list of which CAR is
658 the buffer position at the beginning of the first affiliated
659 keyword and CDR is a plist of affiliated keywords along with
660 their value.
662 Return a list whose CAR is `dynamic-block' and CDR is a plist
663 containing `:block-name', `:begin', `:end', `:contents-begin',
664 `:contents-end', `:arguments', `:post-blank' and
665 `:post-affiliated' keywords.
667 Assume point is at beginning of dynamic block."
671 ;; Incomplete block: parse it as a paragraph.
680 ;; Empty blocks have no contents.
693 :end end
694 :block-name name
695 :arguments arguments
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret DYNAMIC-BLOCK element as Org syntax.
704 CONTENTS is the contents of the element."
709 contents))
712 ;;;; Footnote Definition
715 "Parse a footnote definition.
717 LIMIT bounds the search. AFFILIATED is a list of which CAR is
718 the buffer position at the beginning of the first affiliated
719 keyword and CDR is a plist of affiliated keywords along with
720 their value.
722 Return a list whose CAR is `footnote-definition' and CDR is
723 a plist containing `:label', `:begin' `:end', `:contents-begin',
724 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
726 Assume point is at the beginning of the footnote definition."
754 :begin begin
755 :end end
756 :contents-begin contents-begin
757 :contents-end contents-end
763 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
764 CONTENTS is the contents of the footnote-definition."
766 " "
767 contents))
770 ;;;; Headline
773 "Parse a headline.
775 Return a list whose CAR is `headline' and CDR is a plist
776 containing `:raw-value', `:title', `:alt-title', `:begin',
777 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
778 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
779 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
780 `:footnote-section-p' and `:post-blank' keywords.
782 The plist also contains any property set in the property drawer,
783 with its name in upper cases and colons added at the
784 beginning (e.g., `:CUSTOM_ID').
786 LIMIT is a buffer position bounding the search.
788 When RAW-SECONDARY-P is non-nil, headline's title will not be
789 parsed as a secondary string, but as a plain string instead.
791 Assume point is at beginning of the headline."
804 raw-value)))
809 ;; Find property drawer associated to current headline and
810 ;; extract properties.
811 ;;
812 ;; Upcase property names. It avoids confusion between
813 ;; properties obtained through property drawer and default
814 ;; properties from the parser (e.g. `:end' and :END:)
818 plist)
824 ;; Make sure drawer is not associated
825 ;; to an inlinetask.
839 plist
844 plist)))
846 ;; Read time properties on the line below the headline.
852 org-keyword-time-not-clock-regexp end t)
862 plist))))
874 ;; Clean RAW-VALUE from any comment string.
880 ""
881 raw-value))))
882 ;; Clean TAGS from archive tag, if any.
888 :begin begin
889 :end end
890 :pre-blank
893 :contents-begin contents-begin
894 :contents-end contents-end
895 :level level
897 :tags tags
898 :todo-keyword todo
899 :todo-type todo-type
902 end)
903 :footnote-section-p footnote-section-p
904 :archivedp archivedp
906 time-props
907 standard-props))))
911 headline :alt-title
916 headline :title
922 "Interpret HEADLINE element as Org syntax.
923 CONTENTS is the contents of the element."
948 ;; Align tags.
956 ? )
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' and `:post-blank' 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.
1009 org-keyword-time-not-clock-regexp end t)
1019 plist)))))
1030 ;; Find property drawer associated to current inlinetask
1031 ;; and extract properties.
1032 ;;
1033 ;; HACK: Calling `org-element-at-point' triggers a parsing
1034 ;; of this inlinetask and, thus, an infloop. To avoid the
1035 ;; problem, we extract contents of the inlinetask and
1036 ;; parse them in a new buffer.
1037 ;;
1038 ;; Upcase property names. It avoids confusion between
1039 ;; properties obtained through property drawer and default
1040 ;; properties from the parser (e.g. `:end' and :END:)
1043 plist)
1050 org-property-start-re task-end t))
1060 plist
1065 plist)))
1070 :begin begin
1071 :end end
1072 :contents-begin contents-begin
1073 :contents-end contents-end
1076 :tags tags
1077 :todo-keyword todo
1078 :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' and `:post-blank'
1139 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
1200 item :tag
1208 "Interpret ITEM element as Org syntax.
1209 CONTENTS is the contents of the element."
1219 ;; Compute indentation.
1224 ;; Indent contents.
1226 bullet
1240 ;;;; Plain List
1243 ;; Return structure of list at point. Internal function. See
1244 ;; `org-list-struct' for details.
1249 items struct)
1254 ;; At limit: end all items.
1263 ;; At list end: end all items.
1268 ;; At a new item: end previous sibling.
1280 ind
1281 bullet
1284 ;; Description tag.
1288 ;; Ending position, unknown so far.
1289 nil)))
1290 items))
1292 ;; Skip empty lines.
1294 ;; Skip inline tasks and blank lines along the way.
1301 ;; At some text line. Check if it ends any previous item.
1313 ;; Skip blocks (any type) and drawers contents.
1318 limit t)))
1324 "Parse a plain list.
1326 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1327 the buffer position at the beginning of the first affiliated
1328 keyword and CDR is a plist of affiliated keywords along with
1329 their value. STRUCTURE is the structure of the plain list being
1330 parsed.
1332 Return a list whose CAR is `plain-list' and CDR is a plist
1333 containing `:type', `:begin', `:end', `:contents-begin' and
1334 `:contents-end', `:structure', `:post-blank' and
1335 `:post-affiliated' keywords.
1337 Assume point is at the beginning of the list."
1351 pos))
1355 ;; Return value.
1359 :begin begin
1360 :end end
1361 :contents-begin contents-begin
1362 :contents-end contents-end
1363 :structure struct
1369 "Interpret PLAIN-LIST element as Org syntax.
1370 CONTENTS is the contents of the element."
1378 ;;;; Property Drawer
1381 "Parse a property drawer.
1383 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1384 the buffer position at the beginning of the first affiliated
1385 keyword and CDR is a plist of affiliated keywords along with
1386 their value.
1388 Return a list whose CAR is `property-drawer' and CDR is a plist
1389 containing `:begin', `:end', `:contents-begin', `:contents-end',
1390 `:post-blank' and `:post-affiliated' keywords.
1392 Assume point is at the beginning of the property drawer."
1397 ;; Incomplete drawer: parse it as a paragraph.
1415 :end end
1416 :contents-begin contents-begin
1417 :contents-end contents-end
1423 "Interpret PROPERTY-DRAWER element as Org syntax.
1424 CONTENTS is the properties within the drawer."
1428 ;;;; Quote Block
1431 "Parse a quote block.
1433 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1434 the buffer position at the beginning of the first affiliated
1435 keyword and CDR is a plist of affiliated keywords along with
1436 their value.
1438 Return a list whose CAR is `quote-block' and CDR is a plist
1439 containing `:begin', `:end', `:contents-begin', `:contents-end',
1440 `:post-blank' and `:post-affiliated' keywords.
1442 Assume point is at the beginning of the block."
1446 ;; Incomplete block: parse it as a paragraph.
1452 ;; Empty blocks have no contents.
1465 :end end
1466 :contents-begin contents-begin
1467 :contents-end contents-end
1473 "Interpret QUOTE-BLOCK element as Org syntax.
1474 CONTENTS is the contents of the element."
1478 ;;;; Section
1481 "Parse a section.
1483 LIMIT bounds the search.
1485 Return a list whose CAR is `section' and CDR is a plist
1486 containing `:begin', `:end', `:contents-begin', `contents-end'
1487 and `:post-blank' keywords."
1489 ;; Beginning of section is the beginning of the first non-blank
1490 ;; line after previous headline.
1499 :end end
1500 :contents-begin begin
1501 :contents-end pos-before-blank
1505 "Interpret SECTION element as Org syntax.
1506 CONTENTS is the contents of the element."
1507 contents)
1510 ;;;; Special Block
1513 "Parse a special block.
1515 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1516 the buffer position at the beginning of the first affiliated
1517 keyword and CDR is a plist of affiliated keywords along with
1518 their value.
1520 Return a list whose CAR is `special-block' and CDR is a plist
1521 containing `:type', `:raw-value', `:begin', `:end',
1522 `:contents-begin', `:contents-end', `:post-blank' and
1523 `:post-affiliated' keywords.
1525 Assume point is at the beginning of the block."
1532 limit t)))
1533 ;; Incomplete block: parse it as a paragraph.
1539 ;; Empty blocks have no contents.
1552 :raw-value
1555 contents-begin contents-end))
1556 :begin begin
1557 :end end
1558 :contents-begin contents-begin
1559 :contents-end contents-end
1565 "Interpret SPECIAL-BLOCK element as Org syntax.
1566 CONTENTS is the contents of the element."
1571 \f
1572 ;;; Elements
1573 ;;
1574 ;; For each element, a parser and an interpreter are also defined.
1575 ;; Both follow the same naming convention used for greater elements.
1576 ;;
1577 ;; Also, as for greater elements, adding a new element type is done
1578 ;; through the following steps: implement a parser and an interpreter,
1579 ;; tweak `org-element--current-element' so that it recognizes the new
1580 ;; type and add that new type to `org-element-all-elements'.
1581 ;;
1582 ;; As a special case, when the newly defined type is a block type,
1583 ;; `org-element-block-name-alist' has to be modified accordingly.
1586 ;;;; Babel Call
1589 "Parse a babel call.
1591 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1592 the buffer position at the beginning of the first affiliated
1593 keyword and CDR is a plist of affiliated keywords along with
1594 their value.
1596 Return a list whose CAR is `babel-call' and CDR is a plist
1597 containing `:begin', `:end', `:value', `:post-blank' and
1598 `:post-affiliated' as keywords."
1612 :end end
1613 :value value
1619 "Interpret BABEL-CALL element as Org syntax.
1620 CONTENTS is nil."
1624 ;;;; Clock
1627 "Parse a clock.
1629 LIMIT bounds the search.
1631 Return a list whose CAR is `clock' and CDR is a plist containing
1632 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1633 as keywords."
1653 :value value
1654 :duration duration
1655 :begin begin
1656 :end end
1660 "Interpret CLOCK element as Org syntax.
1661 CONTENTS is nil."
1669 "%2s:%02s"
1673 ;;;; Comment
1676 "Parse a comment.
1678 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1679 the buffer position at the beginning of the first affiliated
1680 keyword and CDR is a plist of affiliated keywords along with
1681 their value.
1683 Return a list whose CAR is `comment' and CDR is a plist
1684 containing `:begin', `:end', `:value', `:post-blank',
1685 `:post-affiliated' keywords.
1687 Assume point is at comment beginning."
1696 ;; Get comments ending.
1699 ;; Accumulate lines without leading hash and first
1700 ;; whitespace.
1714 :end end
1715 :value value
1721 "Interpret COMMENT element as Org syntax.
1722 CONTENTS is nil."
1726 ;;;; Comment Block
1729 "Parse an export block.
1731 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1732 the buffer position at the beginning of the first affiliated
1733 keyword and CDR is a plist of affiliated keywords along with
1734 their value.
1736 Return a list whose CAR is `comment-block' and CDR is a plist
1737 containing `:begin', `:end', `:value', `:post-blank' and
1738 `:post-affiliated' keywords.
1740 Assume point is at comment block beginning."
1744 ;; Incomplete block: parse it as a paragraph.
1757 contents-begin contents-end)))
1761 :end end
1762 :value value
1768 "Interpret COMMENT-BLOCK element as Org syntax.
1769 CONTENTS is nil."
1776 ;;;; Diary Sexp
1779 "Parse a diary sexp.
1781 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1782 the buffer position at the beginning of the first affiliated
1783 keyword and CDR is a plist of affiliated keywords along with
1784 their value.
1786 Return a list whose CAR is `diary-sexp' and CDR is a plist
1787 containing `:begin', `:end', `:value', `:post-blank' and
1788 `:post-affiliated' keywords."
1800 :begin begin
1801 :end end
1807 "Interpret DIARY-SEXP as Org syntax.
1808 CONTENTS is nil."
1812 ;;;; Example Block
1815 "Parse an example block.
1817 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1818 the buffer position at the beginning of the first affiliated
1819 keyword and CDR is a plist of affiliated keywords along with
1820 their value.
1822 Return a list whose CAR is `example-block' and CDR is a plist
1823 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1824 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1825 `:value', `:post-blank' and `:post-affiliated' keywords."
1829 ;; Incomplete block: parse it as a paragraph.
1837 ;; Switches analysis
1844 ;; Should labels be retained in (or stripped from) example
1845 ;; blocks?
1850 ;; What should code-references use - labels or
1851 ;; line-numbers?
1860 ;; Standard block parsing.
1868 contents-begin contents-end))
1869 block-ind))
1878 :end end
1879 :value value
1880 :switches switches
1881 :number-lines number-lines
1882 :preserve-indent preserve-indent
1883 :retain-labels retain-labels
1884 :use-labels use-labels
1885 :label-fmt label-fmt
1891 "Interpret EXAMPLE-BLOCK element as Org syntax.
1892 CONTENTS is nil."
1900 value
1905 ;;;; Fixed-width
1908 "Parse a fixed-width section.
1910 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1911 the buffer position at the beginning of the first affiliated
1912 keyword and CDR is a plist of affiliated keywords along with
1913 their value.
1915 Return a list whose CAR is `fixed-width' and CDR is a plist
1916 containing `:begin', `:end', `:value', `:post-blank' and
1917 `:post-affiliated' keywords.
1919 Assume point is at the beginning of the fixed-width area."
1923 value
1928 ;; Accumulate text without starting colons.
1941 :end end
1942 :value value
1948 "Interpret FIXED-WIDTH element as Org syntax.
1949 CONTENTS is nil."
1957 ;;;; Horizontal Rule
1960 "Parse an horizontal rule.
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 `horizontal-rule' and CDR is a plist
1968 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1969 keywords."
1979 :end end
1985 "Interpret HORIZONTAL-RULE element as Org syntax.
1986 CONTENTS is nil."
1990 ;;;; Keyword
1993 "Parse a keyword at point.
1995 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1996 the buffer position at the beginning of the first affiliated
1997 keyword and CDR is a plist of affiliated keywords along with
1998 their value.
2000 Return a list whose CAR is `keyword' and CDR is a plist
2001 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2002 `:post-affiliated' keywords."
2004 ;; An orphaned affiliated keyword is considered as a regular
2005 ;; keyword. In this case AFFILIATED is nil, so we take care of
2006 ;; this corner case.
2019 :value value
2020 :begin begin
2021 :end end
2027 "Interpret KEYWORD element as Org syntax.
2028 CONTENTS is nil."
2034 ;;;; Latex Environment
2038 "Regexp matching the beginning of a LaTeX environment.
2039 The environment is captured by the first group.
2045 "Format string matching the ending of a LaTeX environment.
2049 "Parse a LaTeX environment.
2051 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2052 the buffer position at the beginning of the first affiliated
2053 keyword and CDR is a plist of affiliated keywords along with
2054 their value.
2056 Return a list whose CAR is `latex-environment' and CDR is a plist
2057 containing `:begin', `:end', `:value', `:post-blank' and
2058 `:post-affiliated' keywords.
2060 Assume point is at the beginning of the latex environment."
2067 limit t))
2068 ;; Incomplete latex environment: parse it as a paragraph.
2078 :end end
2079 :value value
2085 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2086 CONTENTS is nil."
2090 ;;;; Node Property
2093 "Parse a node-property at point.
2095 LIMIT bounds the search.
2097 Return a list whose CAR is `node-property' and CDR is a plist
2098 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2099 keywords."
2111 :value value
2112 :begin begin
2113 :end end
2117 "Interpret NODE-PROPERTY element as Org syntax.
2118 CONTENTS is nil."
2124 ;;;; Paragraph
2127 "Parse a paragraph.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2132 their value.
2134 Return a list whose CAR is `paragraph' and CDR is a plist
2135 containing `:begin', `:end', `:contents-begin' and
2136 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2138 Assume point is at the beginning of the paragraph."
2147 limit
2148 ;; A matching `org-element-paragraph-separate' is not
2149 ;; necessarily the end of the paragraph. In
2150 ;; particular, lines starting with # or : as a first
2151 ;; non-space character are ambiguous. We have to
2152 ;; check if they are valid Org syntax (e.g., not an
2153 ;; incomplete keyword).
2157 ;; There's no ambiguity for other symbols or
2158 ;; empty lines: stop here.
2160 ;; Stop at valid fixed-width areas.
2162 ;; Stop at drawers.
2167 ;; Stop at valid comments.
2169 ;; Stop at valid dynamic blocks.
2174 ;; Stop at valid blocks.
2181 limit t)))
2182 ;; Stop at valid latex environments.
2189 limit t)))
2190 ;; Stop at valid keywords.
2192 ;; Skip everything else.
2209 :end end
2210 :contents-begin contents-begin
2211 :contents-end contents-end
2217 "Interpret PARAGRAPH element as Org syntax.
2218 CONTENTS is the contents of the element."
2219 contents)
2222 ;;;; Planning
2225 "Parse a planning.
2227 LIMIT bounds the search.
2229 Return a list whose CAR is `planning' and CDR is a plist
2230 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2231 and `:post-blank' keywords."
2241 closed deadline scheduled)
2253 :deadline deadline
2254 :scheduled scheduled
2255 :begin begin
2256 :end end
2260 "Interpret PLANNING element as Org syntax.
2261 CONTENTS is nil."
2263 'identity
2280 ;;;; Src Block
2283 "Parse a src block.
2285 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2286 the buffer position at the beginning of the first affiliated
2287 keyword and CDR is a plist of affiliated keywords along with
2288 their value.
2290 Return a list whose CAR is `src-block' and CDR is a plist
2291 containing `:language', `:switches', `:parameters', `:begin',
2292 `:end', `:number-lines', `:retain-labels', `:use-labels',
2293 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2294 `:post-affiliated' keywords.
2296 Assume point is at the beginning of the block."
2299 limit t)))
2300 ;; Incomplete block: parse it as a paragraph.
2306 ;; Get language as a string.
2315 ;; Get switches.
2317 ;; Get parameters.
2319 ;; Switches analysis
2330 ;; Should labels be retained in (or stripped from)
2331 ;; src blocks?
2336 ;; What should code-references use - labels or
2337 ;; line-numbers?
2342 ;; Indentation.
2344 ;; Retrieve code.
2349 block-ind))
2353 ;; Get position after ending blank lines.
2363 :begin begin
2364 :end end
2365 :number-lines number-lines
2366 :preserve-indent preserve-indent
2367 :retain-labels retain-labels
2368 :use-labels use-labels
2369 :label-fmt label-fmt
2370 :value value
2376 "Interpret SRC-BLOCK element as Org syntax.
2377 CONTENTS is nil."
2386 val)
2400 ;;;; Table
2403 "Parse a table at point.
2405 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2406 the buffer position at the beginning of the first affiliated
2407 keyword and CDR is a plist of affiliated keywords along with
2408 their value.
2410 Return a list whose CAR is `table' and CDR is a plist containing
2411 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2412 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2413 keywords.
2415 Assume point is at the beginning of the table."
2429 acc))
2436 :end end
2437 :type type
2438 :tblfm tblfm
2439 ;; Only `org' tables have contents. `table.el' tables
2440 ;; use a `:value' property to store raw table as
2441 ;; a string.
2446 table-begin table-end))
2452 "Interpret TABLE element as Org syntax.
2453 CONTENTS is nil."
2464 ;;;; Table Row
2467 "Parse table row at point.
2469 LIMIT bounds the search.
2471 Return a list whose CAR is `table-row' and CDR is a plist
2472 containing `:begin', `:end', `:contents-begin', `:contents-end',
2473 `:type' and `:post-blank' keywords."
2477 ;; A table rule has no contents. In that case, ensure
2478 ;; CONTENTS-BEGIN matches CONTENTS-END.
2490 :begin begin
2491 :end end
2492 :contents-begin contents-begin
2493 :contents-end contents-end
2497 "Interpret TABLE-ROW element as Org syntax.
2498 CONTENTS is the contents of the table row."
2503 ;;;; Verse Block
2506 "Parse a verse block.
2508 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2509 the buffer position at the beginning of the first affiliated
2510 keyword and CDR is a plist of affiliated keywords along with
2511 their value.
2513 Return a list whose CAR is `verse-block' and CDR is a plist
2514 containing `:begin', `:end', `:contents-begin', `:contents-end',
2515 `:post-blank' and `:post-affiliated' keywords.
2517 Assume point is at beginning of the block."
2521 ;; Incomplete block: parse it as a paragraph.
2536 :end end
2537 :contents-begin contents-begin
2538 :contents-end contents-end
2544 "Interpret VERSE-BLOCK element as Org syntax.
2545 CONTENTS is verse block contents."
2549 \f
2550 ;;; Objects
2551 ;;
2552 ;; Unlike to elements, raw text can be found between objects. Hence,
2553 ;; `org-element--object-lex' is provided to find the next object in
2554 ;; buffer.
2555 ;;
2556 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2557 ;; object types they can contain will be specified in
2558 ;; `org-element-object-restrictions'.
2559 ;;
2560 ;; Creating a new type of object requires to alter
2561 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2562 ;; new type in `org-element-all-objects', and possibly add
2563 ;; restrictions in `org-element-object-restrictions'.
2565 ;;;; Bold
2568 "Parse bold object at point, if any.
2570 When at a bold object, return a list whose car is `bold' and cdr
2571 is a plist with `:begin', `:end', `:contents-begin' and
2572 `:contents-end' and `:post-blank' keywords. Otherwise, return
2573 nil.
2575 Assume point is at the first star marker."
2587 :end end
2588 :contents-begin contents-begin
2589 :contents-end contents-end
2593 "Interpret BOLD object as Org syntax.
2594 CONTENTS is the contents of the object."
2598 ;;;; Code
2601 "Parse code object at point, if any.
2603 When at a code object, return a list whose car is `code' and cdr
2604 is a plist with `:value', `:begin', `:end' and `:post-blank'
2605 keywords. Otherwise, return nil.
2607 Assume point is at the first tilde marker."
2618 :begin begin
2619 :end end
2623 "Interpret CODE object as Org syntax.
2624 CONTENTS is nil."
2628 ;;;; Entity
2631 "Parse entity at point, if any.
2633 When at an entity, return a list whose car is `entity' and cdr
2634 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2635 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2636 `:post-blank' as keywords. Otherwise, return nil.
2638 Assume point is at the beginning of the entity."
2640 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2658 :begin begin
2659 :end end
2660 :use-brackets-p bracketsp
2664 "Interpret ENTITY object as Org syntax.
2665 CONTENTS is nil."
2671 ;;;; Export Snippet
2674 "Parse export snippet at point.
2676 When at an export snippet, return a list whose car is
2677 `export-snippet' and cdr a plist with `:begin', `:end',
2678 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2679 return nil.
2681 Assume point is at the beginning of the snippet."
2697 :value value
2698 :begin begin
2699 :end end
2703 "Interpret EXPORT-SNIPPET object as Org syntax.
2704 CONTENTS is nil."
2710 ;;;; Footnote Reference
2713 "Parse footnote reference at point, if any.
2715 When at a footnote reference, return a list whose car is
2716 `footnote-reference' and cdr a plist with `:label', `:type',
2717 `:begin', `:end', `:content-begin', `:contents-end' and
2718 `:post-blank' as keywords. Otherwise, return nil."
2742 :type type
2743 :begin begin
2744 :end end
2750 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2751 CONTENTS is its definition, when inline, or nil."
2757 ;;;; Inline Babel Call
2760 "Parse inline babel call at point, if any.
2762 When at an inline babel call, return a list whose car is
2763 `inline-babel-call' and cdr a plist with `:begin', `:end',
2764 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2766 Assume point is at the beginning of the babel call."
2778 :end end
2779 :value value
2783 "Interpret INLINE-BABEL-CALL object as Org syntax.
2784 CONTENTS is nil."
2788 ;;;; Inline Src Block
2791 "Parse inline source block at point, if any.
2793 When at an inline source block, return a list whose car is
2794 `inline-src-block' and cdr a plist with `:begin', `:end',
2795 `:language', `:value', `:parameters' and `:post-blank' as
2796 keywords. Otherwise, return nil.
2798 Assume point is at the beginning of the inline src block."
2811 :value value
2812 :parameters parameters
2813 :begin begin
2814 :end end
2818 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2819 CONTENTS is nil."
2824 language
2826 body)))
2828 ;;;; Italic
2831 "Parse italic object at point, if any.
2833 When at an italic object, return a list whose car is `italic' and
2834 cdr is a plist with `:begin', `:end', `:contents-begin' and
2835 `:contents-end' and `:post-blank' keywords. Otherwise, return
2836 nil.
2838 Assume point is at the first slash marker."
2850 :end end
2851 :contents-begin contents-begin
2852 :contents-end contents-end
2856 "Interpret ITALIC object as Org syntax.
2857 CONTENTS is the contents of the object."
2861 ;;;; Latex Fragment
2864 "Parse LaTeX fragment at point, if any.
2866 When at a LaTeX fragment, return a list whose car is
2867 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2868 and `:post-blank' as keywords. Otherwise, return nil.
2870 Assume point is at the beginning of the LaTeX fragment."
2888 ;; Macro.
2897 :begin begin
2898 :end end
2902 "Interpret LATEX-FRAGMENT object as Org syntax.
2903 CONTENTS is nil."
2906 ;;;; Line Break
2909 "Parse line break at point, if any.
2911 When at a line break, return a list whose car is `line-break',
2912 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2913 Otherwise, return nil.
2915 Assume point is at the beginning of the line break."
2924 "Interpret LINE-BREAK object as Org syntax.
2925 CONTENTS is nil."
2929 ;;;; Link
2932 "Parse link at point, if any.
2934 When at a link, return a list whose car is `link' and cdr a plist
2935 with `:type', `:path', `:raw-link', `:application',
2936 `:search-option', `:begin', `:end', `:contents-begin',
2937 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2938 nil.
2940 Assume point is at the beginning of the link."
2943 end contents-begin contents-end link-end post-blank path type
2944 raw-link link search-option application)
2946 ;; Type 1: Text targeted from a radio target.
2955 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2960 ;; RAW-LINK is the original link. Expand any
2961 ;; abbreviation in it.
2965 ;; Determine TYPE of link and set PATH accordingly.
2967 ;; File type.
2971 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2974 ;; According to RFC 3986, extra whitespace should be
2975 ;; ignored when a URI is extracted.
2978 ;; Id type: PATH is the id.
2981 ;; Code-ref type: PATH is the name of the reference.
2984 ;; Custom-id type: PATH is the name of the custom id.
2987 ;; Fuzzy type: Internal link either matches a target, an
2988 ;; headline name or nothing. PATH is the target or
2989 ;; headline's name.
2991 ;; Type 3: Plain link, e.g., http://orgmode.org
2997 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3005 ;; In any case, deduce end point after trailing white space from
3006 ;; LINK-END variable.
3010 ;; Special "file" type link processing.
3012 ;; Extract opening application and search option.
3020 ;; Normalize URI.
3024 ;; Make sure TYPE always reports "file".
3028 :path path
3030 :application application
3031 :search-option search-option
3032 :begin begin
3033 :end end
3034 :contents-begin contents-begin
3035 :contents-end contents-end
3039 "Interpret LINK object as Org syntax.
3040 CONTENTS is the contents of the object, or nil."
3045 raw-link
3049 ;;;; Macro
3052 "Parse macro at point, if any.
3054 When at a macro, return a list whose car is `macro' and cdr
3055 a plist with `:key', `:args', `:begin', `:end', `:value' and
3056 `:post-blank' as keywords. Otherwise, return nil.
3058 Assume point is at the macro."
3069 ;; Do not use `org-split-string' since empty
3070 ;; strings are meaningful here.
3078 args nil t)
3082 :value value
3083 :args args
3084 :begin begin
3085 :end end
3089 "Interpret MACRO object as Org syntax.
3090 CONTENTS is nil."
3094 ;;;; Radio-target
3097 "Parse radio target at point, if any.
3099 When at a radio target, return a list whose car is `radio-target'
3100 and cdr a plist with `:begin', `:end', `:contents-begin',
3101 `:contents-end', `:value' and `:post-blank' as keywords.
3102 Otherwise, return nil.
3104 Assume point is at the radio target."
3116 :end end
3117 :contents-begin contents-begin
3118 :contents-end contents-end
3119 :post-blank post-blank
3123 "Interpret TARGET object as Org syntax.
3124 CONTENTS is the contents of the object."
3128 ;;;; Statistics Cookie
3131 "Parse statistics cookie at point, if any.
3133 When at a statistics cookie, return a list whose car is
3134 `statistics-cookie', and cdr a plist with `:begin', `:end',
3135 `:value' and `:post-blank' keywords. Otherwise, return nil.
3137 Assume point is at the beginning of the statistics-cookie."
3148 :end end
3149 :value value
3153 "Interpret STATISTICS-COOKIE object as Org syntax.
3154 CONTENTS is nil."
3158 ;;;; Strike-Through
3161 "Parse strike-through object at point, if any.
3163 When at a strike-through object, return a list whose car is
3164 `strike-through' and cdr is a plist with `:begin', `:end',
3165 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3166 Otherwise, return nil.
3168 Assume point is at the first plus sign marker."
3180 :end end
3181 :contents-begin contents-begin
3182 :contents-end contents-end
3186 "Interpret STRIKE-THROUGH object as Org syntax.
3187 CONTENTS is the contents of the object."
3191 ;;;; Subscript
3194 "Parse subscript at point, if any.
3196 When at a subscript object, return a list whose car is
3197 `subscript' and cdr a plist with `:begin', `:end',
3198 `:contents-begin', `:contents-end', `:use-brackets-p' and
3199 `:post-blank' as keywords. Otherwise, return nil.
3201 Assume point is at the underscore."
3215 :end end
3216 :use-brackets-p bracketsp
3217 :contents-begin contents-begin
3218 :contents-end contents-end
3222 "Interpret SUBSCRIPT object as Org syntax.
3223 CONTENTS is the contents of the object."
3226 contents))
3229 ;;;; Superscript
3232 "Parse superscript at point, if any.
3234 When at a superscript object, return a list whose car is
3235 `superscript' and cdr a plist with `:begin', `:end',
3236 `:contents-begin', `:contents-end', `:use-brackets-p' and
3237 `:post-blank' as keywords. Otherwise, return nil.
3239 Assume point is at the caret."
3253 :end end
3254 :use-brackets-p bracketsp
3255 :contents-begin contents-begin
3256 :contents-end contents-end
3260 "Interpret SUPERSCRIPT object as Org syntax.
3261 CONTENTS is the contents of the object."
3264 contents))
3267 ;;;; Table Cell
3270 "Parse table cell at point.
3271 Return a list whose car is `table-cell' and cdr is a plist
3272 containing `:begin', `:end', `:contents-begin', `:contents-end'
3273 and `:post-blank' keywords."
3281 :end end
3282 :contents-begin contents-begin
3283 :contents-end contents-end
3287 "Interpret TABLE-CELL element as Org syntax.
3288 CONTENTS is the contents of the cell, or nil."
3292 ;;;; Target
3295 "Parse target at point, if any.
3297 When at a target, return a list whose car is `target' and cdr
3298 a plist with `:begin', `:end', `:value' and `:post-blank' as
3299 keywords. Otherwise, return nil.
3301 Assume point is at the target."
3311 :end end
3312 :value value
3316 "Interpret TARGET object as Org syntax.
3317 CONTENTS is nil."
3321 ;;;; Timestamp
3332 "Parse time stamp at point, if any.
3334 When at a time stamp, return a list whose car is `timestamp', and
3335 cdr a plist with `:type', `:raw-value', `:year-start',
3336 `:month-start', `:day-start', `:hour-start', `:minute-start',
3337 `:year-end', `:month-end', `:day-end', `:hour-end',
3338 `:minute-end', `:repeater-type', `:repeater-value',
3339 `:repeater-unit', `:warning-type', `:warning-value',
3340 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3341 Otherwise, return nil.
3343 Assume point is at the beginning of the timestamp."
3362 date-start)
3373 raw-value)
3375 :repeater-type
3381 :repeater-unit
3390 :warning-unit
3393 year-start month-start day-start hour-start minute-start year-end
3394 month-end day-end hour-end minute-end)
3395 ;; Parse date-start.
3403 ;; Compute date-end. It can be provided directly in time-stamp,
3404 ;; or extracted from time range. Otherwise, it defaults to the
3405 ;; same values as date-start.
3415 :raw-value raw-value
3416 :year-start year-start
3417 :month-start month-start
3418 :day-start day-start
3419 :hour-start hour-start
3420 :minute-start minute-start
3421 :year-end year-end
3422 :month-end month-end
3423 :day-end day-end
3424 :hour-end hour-end
3425 :minute-end minute-end
3426 :begin begin
3427 :end end
3429 repeater-props
3430 warning-props))))))
3433 "Interpret TIMESTAMP object as Org syntax.
3434 CONTENTS is nil."
3453 ;; Build an Org timestamp string from TIME. ACTIVEP is
3454 ;; non-nil when time stamp is active. If WITH-TIME-P is
3455 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3456 ;; specify a time range in the timestamp. REPEAT-STRING is
3457 ;; the repeater string, if any.
3461 org-time-stamp-formats)
3462 time)))
3468 nil nil ts)))
3473 " "
3474 s
3476 ;; Return value.
3477 ts)))
3489 build-ts-string
3508 0
3516 "--"
3528 ;;;; Underline
3531 "Parse underline object at point, if any.
3533 When at an underline object, return a list whose car is
3534 `underline' and cdr is a plist with `:begin', `:end',
3535 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3536 Otherwise, return nil.
3538 Assume point is at the first underscore marker."
3550 :end end
3551 :contents-begin contents-begin
3552 :contents-end contents-end
3556 "Interpret UNDERLINE object as Org syntax.
3557 CONTENTS is the contents of the object."
3561 ;;;; Verbatim
3564 "Parse verbatim object at point, if any.
3566 When at a verbatim object, return a list whose car is `verbatim'
3567 and cdr is a plist with `:value', `:begin', `:end' and
3568 `:post-blank' keywords. Otherwise, return nil.
3570 Assume point is at the first equal sign marker."
3581 :begin begin
3582 :end end
3586 "Interpret VERBATIM object as Org syntax.
3587 CONTENTS is nil."
3591 \f
3592 ;;; Parsing Element Starting At Point
3593 ;;
3594 ;; `org-element--current-element' is the core function of this section.
3595 ;; It returns the Lisp representation of the element starting at
3596 ;; point.
3597 ;;
3598 ;; `org-element--current-element' makes use of special modes. They
3599 ;; are activated for fixed element chaining (e.g., `plain-list' >
3600 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3601 ;; `section'). Special modes are: `first-section', `item',
3602 ;; `node-property', `section' and `table-row'.
3606 "Parse the element starting at point.
3608 Return value is a list like (TYPE PROPS) where TYPE is the type
3609 of the element and PROPS a plist of properties associated to the
3610 element.
3612 Possible types are defined in `org-element-all-elements'.
3614 LIMIT bounds the search.
3616 Optional argument GRANULARITY determines the depth of the
3617 recursion. Allowed values are `headline', `greater-element',
3618 `element', `object' or nil. When it is broader than `object' (or
3619 nil), secondary values will not be parsed, since they only
3620 contain objects.
3622 Optional argument SPECIAL, when non-nil, can be either
3623 `first-section', `item', `node-property', `section', and
3624 `table-row'.
3626 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3627 be computed.
3629 This function assumes point is always at the beginning of the
3630 element it has to parse."
3633 ;; Determine if parsing depth allows for secondary strings
3634 ;; parsing. It only applies to elements referenced in
3635 ;; `org-element-secondary-value-alist'.
3638 ;; Item.
3641 ;; Table Row.
3643 ;; Node Property.
3645 ;; Headline.
3648 ;; Sections (must be checked after headline).
3653 limit)))
3654 ;; When not at bol, point is at the beginning of an item or
3655 ;; a footnote definition: next item is always a paragraph.
3657 ;; Planning and Clock.
3662 ;; Inlinetask.
3665 ;; From there, elements can have affiliated keywords.
3668 ;; Jumping over affiliated keywords put point off-limits.
3669 ;; Parse them as regular keywords.
3673 ;; LaTeX Environment.
3676 ;; Drawer and Property Drawer.
3681 ;; Fixed Width
3684 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3685 ;; Keywords.
3694 org-element-block-name-alist)))
3709 ;; Footnote Definition.
3712 ;; Horizontal Rule.
3715 ;; Diary Sexp.
3718 ;; Table.
3720 ;; List.
3723 limit affiliated
3725 ;; Default element: Paragraph.
3729 ;; Most elements can have affiliated keywords. When looking for an
3730 ;; element beginning, we want to move before them, as they belong to
3731 ;; that element, and, in the meantime, collect information they give
3732 ;; into appropriate properties. Hence the following function.
3735 "Collect affiliated keywords from point down to LIMIT.
3737 Return a list whose CAR is the position at the first of them and
3738 CDR a plist of keywords and values and move point to the
3739 beginning of the first line after them.
3741 As a special case, if element doesn't start at the beginning of
3742 the line (e.g., a paragraph starting an item), CAR is current
3743 position of point and CDR is nil."
3747 ;; RESTRICT is the list of objects allowed in parsed
3748 ;; keywords value.
3750 output)
3753 ;; Apply translation to RAW-KWD. From there, KWD is
3754 ;; the official keyword.
3756 org-element-keyword-translation-alist))
3757 raw-kwd))
3758 ;; Find main value for any keyword.
3764 ;; PARSEDP is non-nil when keyword should have its
3765 ;; value parsed.
3767 ;; If KWD is a dual keyword, find its secondary
3768 ;; value. Maybe parse it.
3775 ;; Attribute a property name to KWD.
3777 ;; Now set final shape for VALUE.
3783 ;; Attributes can always appear on multiple lines.
3786 ;; Eventually store the new value in OUTPUT.
3788 ;; Move to next keyword.
3790 ;; If affiliated keywords are orphaned: move back to first one.
3791 ;; They will be parsed as a paragraph.
3793 ;; Return value.
3797 \f
3798 ;;; The Org Parser
3799 ;;
3800 ;; The two major functions here are `org-element-parse-buffer', which
3801 ;; parses Org syntax inside the current buffer, taking into account
3802 ;; region, narrowing, or even visibility if specified, and
3803 ;; `org-element-parse-secondary-string', which parses objects within
3804 ;; a given string.
3805 ;;
3806 ;; The (almost) almighty `org-element-map' allows to apply a function
3807 ;; on elements or objects matching some type, and accumulate the
3808 ;; resulting values. In an export situation, it also skips unneeded
3809 ;; parts of the parse tree.
3812 "Recursively parse the buffer and return structure.
3813 If narrowing is in effect, only parse the visible part of the
3814 buffer.
3816 Optional argument GRANULARITY determines the depth of the
3817 recursion. It can be set to the following symbols:
3819 `headline' Only parse headlines.
3820 `greater-element' Don't recurse into greater elements excepted
3821 headlines and sections. Thus, elements
3822 parsed are the top-level ones.
3823 `element' Parse everything but objects and plain text.
3824 `object' Parse the complete buffer (default).
3826 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3827 elements.
3829 An element or an objects is represented as a list with the
3830 pattern (TYPE PROPERTIES CONTENTS), where :
3832 TYPE is a symbol describing the element or object. See
3833 `org-element-all-elements' and `org-element-all-objects' for an
3834 exhaustive list of such symbols. One can retrieve it with
3835 `org-element-type' function.
3837 PROPERTIES is the list of attributes attached to the element or
3838 object, as a plist. Although most of them are specific to the
3839 element or object type, all types share `:begin', `:end',
3840 `:post-blank' and `:parent' properties, which respectively
3841 refer to buffer position where the element or object starts,
3842 ends, the number of white spaces or blank lines after it, and
3843 the element or object containing it. Properties values can be
3844 obtained by using `org-element-property' function.
3846 CONTENTS is a list of elements, objects or raw strings
3847 contained in the current element or object, when applicable.
3848 One can access them with `org-element-contents' function.
3850 The Org buffer has `org-data' as type and nil as properties.
3851 `org-element-map' function can be used to find specific elements
3852 or objects within the parse tree.
3854 This function assumes that current major mode is `org-mode'."
3860 ;; Start in `first-section' mode so text before the first
3861 ;; headline belongs to a section.
3865 "Recursively parse objects in STRING and return structure.
3867 RESTRICTION is a symbol limiting the object types that will be
3868 looked after.
3870 Optional argument PARENT, when non-nil, is the element or object
3871 containing the secondary string. It is used to set correctly
3872 `:parent' property within the string."
3885 secondary))))
3889 "Map a function on selected elements or objects.
3891 DATA is a parse tree, an element, an object, a string, or a list
3892 of such constructs. TYPES is a symbol or list of symbols of
3893 elements or objects types (see `org-element-all-elements' and
3894 `org-element-all-objects' for a complete list of types). FUN is
3895 the function called on the matching element or object. It has to
3896 accept one argument: the element or object itself.
3898 When optional argument INFO is non-nil, it should be a plist
3899 holding export options. In that case, parts of the parse tree
3900 not exportable according to that property list will be skipped.
3902 When optional argument FIRST-MATCH is non-nil, stop at the first
3903 match for which FUN doesn't return nil, and return that value.
3905 Optional argument NO-RECURSION is a symbol or a list of symbols
3906 representing elements or objects types. `org-element-map' won't
3907 enter any recursive element or object whose type belongs to that
3908 list. Though, FUN can still be applied on them.
3910 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3911 apply to matching objects within parsed affiliated keywords (see
3912 `org-element-parsed-keywords').
3914 Nil values returned from FUN do not appear in the results.
3917 Examples:
3918 ---------
3920 Assuming TREE is a variable containing an Org buffer parse tree,
3921 the following example will return a flat list of all `src-block'
3922 and `example-block' elements in it:
3924 \(org-element-map tree '(example-block src-block) 'identity)
3926 The following snippet will find the first headline with a level
3929 \(org-element-map tree 'headline
3930 \(lambda (hl)
3931 \(and (= (org-element-property :level hl) 1)
3933 \(org-element-property :begin hl)))
3934 nil t)
3936 The next example will return a flat list of all `plain-list' type
3937 elements in TREE that are not a sub-list themselves:
3939 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3941 Eventually, this example will return a flat list of all `bold'
3942 type objects containing a `latex-snippet' type object, even
3943 looking into captions:
3945 \(org-element-map tree 'bold
3946 \(lambda (b)
3947 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3948 nil nil nil t)"
3949 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3952 ;; Recursion depth is determined by --CATEGORY.
3959 ;; If one object is found, the function
3960 ;; has to recurse into every object.
3963 ;; If one regular element is found, the
3964 ;; function has to recurse, at least,
3965 ;; into every element it encounters.
3968 types)
3969 category)))
3970 ;; Compute properties for affiliated keywords if necessary.
3975 org-element-affiliated-keywords)))
3976 --acc
3977 --walk-tree
3981 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3982 ;; holding contextual information.
3986 ;; Ignored element in an export context.
3988 ;; List of elements or objects.
3990 ;; Unconditionally enter parse trees.
3994 ;; Check if TYPE is matching among TYPES. If so,
3995 ;; apply FUN to --DATA and accumulate return value
3996 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4002 ;; If --DATA has a secondary string that can contain
4003 ;; objects with their type among TYPES, look into it.
4010 ;; If --DATA has any affiliated keywords and
4011 ;; WITH-AFFILIATED is non-nil, look for objects in
4012 ;; them.
4020 ;; Pay attention to the type of value.
4021 ;; Preserve order for multiple keywords.
4037 --affiliated-alist))
4038 ;; Determine if a recursion into --DATA is possible.
4040 ;; --TYPE is explicitly removed from recursion.
4042 ;; --DATA has no contents.
4044 ;; Looking for greater elements but --DATA is simply
4045 ;; an element or an object.
4048 ;; Looking for elements but --DATA is an object.
4051 ;; In any other case, map contents.
4055 ;; Return value in a proper order.
4059 ;; The following functions are internal parts of the parser.
4060 ;;
4061 ;; The first one, `org-element--parse-elements' acts at the element's
4062 ;; level.
4063 ;;
4064 ;; The second one, `org-element--parse-objects' applies on all objects
4065 ;; of a paragraph or a secondary string.
4066 ;;
4067 ;; More precisely, that function looks for every allowed object type
4068 ;; first. Then, it discards failed searches, keeps further matches,
4069 ;; and searches again types matched behind point, for subsequent
4070 ;; calls. Thus, searching for a given type fails only once, and every
4071 ;; object is searched only once at top level (but sometimes more for
4072 ;; nested types).
4076 "Parse elements between BEG and END positions.
4078 SPECIAL prioritize some elements over the others. It can be set
4079 to `first-section', `section' `item' or `table-row'.
4081 When value is `item', STRUCTURE will be used as the current list
4082 structure.
4084 GRANULARITY determines the depth of the recursion. See
4085 `org-element-parse-buffer' for more information.
4087 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4088 elements.
4090 Elements are accumulated into ACC."
4093 ;; Visible only: skip invisible parts at the beginning of the
4094 ;; element.
4097 ;; When parsing only headlines, skip any text before first one.
4100 ;; Main loop start.
4102 ;; Find current element's type and parse it accordingly to
4103 ;; its category.
4105 end granularity special structure))
4109 ;; Visible only: skip invisible parts between siblings.
4112 ;; Fill ELEMENT contents by side-effect.
4114 ;; If element has no contents, don't modify it.
4116 ;; Greater element: parse it between `contents-begin' and
4117 ;; `contents-end'. Make sure GRANULARITY allows the
4118 ;; recursion, or ELEMENT is a headline, in which case going
4119 ;; inside is mandatory, in order to get sub-level headings.
4127 ;; Possibly switch to a special mode.
4135 granularity visible-only element))
4136 ;; ELEMENT has contents. Parse objects inside, if
4137 ;; GRANULARITY allows it.
4143 ;; Return result.
4144 acc))
4150 ;; Sub/superscript.
4152 ;; Bold, code, italic, strike-through, underline and
4153 ;; verbatim.
4156 ;; Plain links.
4158 ;; Objects starting with "[": regular link, footnote
4159 ;; reference, statistics cookie, timestamp (inactive).
4161 ;; Objects starting with "@": export snippets.
4162 "@@"
4163 ;; Objects starting with "{": macro.
4164 "{{{"
4165 ;; Objects starting with "<" : timestamp (active,
4166 ;; diary), target, radio target and angular links.
4168 ;; Objects starting with "$": latex fragment.
4170 ;; Objects starting with "\": line break, entity,
4171 ;; latex fragment.
4173 ;; Objects starting with raw text: inline Babel
4174 ;; source block, inline Babel call.
4177 "Regexp possibly matching the beginning of an object.
4178 This regexp allows false positives. Dedicated parser (e.g.,
4179 `org-export-bold-parser') will take care of further filtering.
4180 Radio links are not matched by this regexp, as they are treated
4184 "Return next object in current buffer or nil.
4185 RESTRICTION is a list of object types, as symbols, that should be
4186 looked after. This function assumes that the buffer is narrowed
4187 to an appropriate container (e.g., a paragraph)."
4195 found)
4260 ;; This is probably a plain link.
4266 ;; Radio link.
4271 "Parse objects between BEG and END and return recursive structure.
4273 Objects are accumulated in ACC.
4275 RESTRICTION is a list of object successors which are allowed in
4276 the current object."
4284 ;; 1. Text before any object. Untabify it.
4289 acc
4293 ;; 2. Object...
4296 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4297 ;; a recursive type.
4305 ;; 3. Text after last object. Untabify it.
4309 acc
4313 ;; Result.
4314 acc)))
4317 \f
4318 ;;; Towards A Bijective Process
4319 ;;
4320 ;; The parse tree obtained with `org-element-parse-buffer' is really
4321 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4322 ;; interpreted and expanded into a string with canonical Org syntax.
4323 ;; Hence `org-element-interpret-data'.
4324 ;;
4325 ;; The function relies internally on
4326 ;; `org-element--interpret-affiliated-keywords'.
4328 ;;;###autoload
4330 "Interpret DATA as Org syntax.
4332 DATA is a parse tree, an element, an object or a secondary string
4333 to interpret.
4335 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4336 new types that should be treated as objects. An unknown type not
4337 belonging to this list is seen as a pseudo-element instead. Both
4338 pseudo-objects and pseudo-elements are transparent entities, i.e.
4339 only their contents are interpreted.
4341 Return Org syntax as a string."
4345 "Interpret DATA as Org syntax.
4347 DATA is a parse tree, an element, an object or a secondary string
4348 to interpret. PARENT is used for recursive calls. It contains
4349 the element or object containing data, or nil. PSEUDO-OBJECTS
4350 are list of symbols defining new element or object types.
4351 Unknown types that don't belong to this list are treated as
4352 pseudo-elements instead.
4354 Return Org syntax as a string."
4356 ;; Find interpreter for current object or element. If it
4357 ;; doesn't exist (e.g. this is a pseudo object or element),
4358 ;; return contents, if any.
4364 ;; Secondary string.
4370 ;; Full Org document.
4376 ;; Plain text: return it.
4378 ;; Element or object without contents.
4380 ;; Element or object with contents.
4383 ;; Recursively interpret contents.
4389 data
4390 ;; Fix indentation of elements containing
4391 ;; objects. We ignore `table-row' elements
4392 ;; as they are one line long anyway.
4394 data
4395 ;; When normalizing first paragraph of an
4396 ;; item or a footnote-definition, ignore
4397 ;; first line's indentation.
4404 ;; Build white spaces. If no `:post-blank' property is
4405 ;; specified, assume its value is 0.
4416 "Return ELEMENT's affiliated keywords as Org syntax.
4417 If there is no affiliated keyword, return the empty string."
4427 ": "
4430 value)
4438 ;; All attribute keywords can have multiple lines.
4444 ;; List all ELEMENT's properties matching an attribute line or an
4445 ;; affiliated keyword, but ignore translated keywords since they
4446 ;; cannot belong to the property list.
4453 org-element-keyword-translation-alist)))))
4454 collect prop)
4457 ;; Because interpretation of the parse tree must return the same
4458 ;; number of blank lines between elements and the same number of white
4459 ;; space after objects, some special care must be given to white
4460 ;; spaces.
4461 ;;
4462 ;; The first function, `org-element-normalize-string', ensures any
4463 ;; string different from the empty string will end with a single
4464 ;; newline character.
4465 ;;
4466 ;; The second function, `org-element-normalize-contents', removes
4467 ;; global indentation from the contents of the current element.
4470 "Ensure string S ends with a single newline character.
4472 If S isn't a string return it unchanged. If S is the empty
4473 string, return it. Otherwise, return a new string with a single
4474 newline character at its end."
4482 "Normalize plain text in ELEMENT's contents.
4484 ELEMENT must only contain plain text and objects.
4486 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4487 indentation to compute maximal common indentation.
4489 Return the normalized element that is element with global
4490 indentation removed from its contents. The function assumes that
4491 indentation is not done with TAB characters."
4493 find-min-ind ; For byte-compiler.
4495 ;; Return minimal common indentation within BLOB. This is
4496 ;; done by walking recursively BLOB and updating MIN-IND
4497 ;; along the way. FIRST-FLAG is non-nil when the first
4498 ;; string hasn't been seen yet. It is required as this
4499 ;; string is the only one whose indentation doesn't happen
4500 ;; after a newline character.
4507 ;; An indentation of zero means no string will be
4508 ;; modified. Quit the process.
4518 ;; Find minimal indentation in ELEMENT.
4521 ;; Build ELEMENT back, replacing each string with the same
4522 ;; string minus common indentation.
4527 ;; Return BLOB with all its strings indentation
4528 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4529 ;; is non-nil when the first string hasn't been seen
4530 ;; yet.
4545 org-element-recursive-objects)
4549 blob))))
4553 \f
4554 ;;; Cache
4555 ;;
4556 ;; Implement a caching mechanism for `org-element-at-point' and
4557 ;; `org-element-context', which see.
4558 ;;
4559 ;; A single public function is provided: `org-element-cache-reset'.
4560 ;;
4561 ;; Cache is enabled by default, but can be disabled globally with
4562 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4563 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4564 ;; can be tweaked to control caching behaviour.
4565 ;;
4566 ;; Internally, parsed elements are stored in an AVL tree,
4567 ;; `org-element--cache'. This tree is updated lazily: whenever
4568 ;; a change happens to the buffer, a synchronization request is
4569 ;; registered in `org-element--cache-sync-requests' (see
4570 ;; `org-element--cache-submit-request'). During idle time, requests
4571 ;; are processed by `org-element--cache-sync'. Synchronization also
4572 ;; happens when an element is required from the cache. In this case,
4573 ;; the process stops as soon as the needed element is up-to-date.
4574 ;;
4575 ;; A synchronization request can only apply on a synchronized part of
4576 ;; the cache. Therefore, the cache is updated at least to the
4577 ;; location where the new request applies. Thus, requests are ordered
4578 ;; from left to right and all elements starting before the first
4579 ;; request are correct. This property is used by functions like
4580 ;; `org-element--cache-find' to retrieve elements in the part of the
4581 ;; cache that can be trusted.
4582 ;;
4583 ;; A request applies to every element, starting from its original
4584 ;; location (or key, see below). When a request is processed, it
4585 ;; moves forward and may collide the next one. In this case, both
4586 ;; requests are merged into a new one that starts from that element.
4587 ;; As a consequence, the whole synchronization complexity does not
4588 ;; depend on the number of pending requests, but on the number of
4589 ;; elements the very first request will be applied on.
4590 ;;
4591 ;; Elements cannot be accessed through their beginning position, which
4592 ;; may or may not be up-to-date. Instead, each element in the tree is
4593 ;; associated to a key, obtained with `org-element--cache-key'. This
4594 ;; mechanism is robust enough to preserve total order among elements
4595 ;; even when the tree is only partially synchronized.
4596 ;;
4597 ;; Objects contained in an element are stored in a hash table,
4598 ;; `org-element--cache-objects'.
4602 "Non nil when Org parser should cache its results.
4609 "Maximum duration, as a time value, for a cache synchronization.
4610 If the synchronization is not over after this delay, the process
4611 pauses and resumes after `org-element-cache-sync-break'
4615 "Duration, as a time value, of the pause between synchronizations.
4619 ;;;; Data Structure
4622 "AVL tree used to cache elements.
4623 Each node of the tree contains an element. Comparison is done
4624 with `org-element--cache-compare'. This cache is used in
4628 "Hash table used as to cache objects.
4629 Key is an element, as returned by `org-element-at-point', and
4630 value is an alist where each association is:
4632 \(PARENT COMPLETEP . OBJECTS)
4634 where PARENT is an element or object, COMPLETEP is a boolean,
4635 non-nil when all direct children of parent are already cached and
4636 OBJECTS is a list of such children, as objects, from farthest to
4637 closest.
4640 contained within a paragraph
4644 If the paragraph is completely parsed, OBJECTS-DATA will be
4646 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4647 \(BOLD-OBJECT t ENTITY-OBJECT))
4649 whereas in a partially parsed paragraph, it could be
4651 \((PARAGRAPH nil ENTITY-OBJECT))
4656 "List of pending synchronization requests.
4658 A request is a vector with the following pattern:
4660 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4662 Processing a synchronization request consists of three phases:
4664 0. Delete modified elements,
4665 1. Fill missing area in cache,
4666 2. Shift positions and re-parent elements after the changes.
4668 During phase 0, NEXT is the key of the first element to be
4669 removed, BEG and END is buffer position delimiting the
4670 modifications. Elements starting between them (inclusive) are
4671 removed and so are those contained within OUTREACH. PARENT, when
4672 non-nil, is the parent of the first element to be removed.
4674 During phase 1, NEXT is the key of the next known element in
4675 cache and BEG its beginning position. Parse buffer between that
4676 element and the one before it in order to determine the parent of
4677 the next element. Set PARENT to the element containing NEXT.
4679 During phase 2, NEXT is the key of the next element to shift in
4680 the parse tree. All elements starting from this one have their
4681 properties relatives to buffer positions shifted by integer
4682 OFFSET and, if they belong to element PARENT, are adopted by it.
4690 "Hash table used to store keys during synchronization.
4694 "Return a unique key for ELEMENT in cache tree.
4696 Keys are used to keep a total order among elements in the cache.
4697 Comparison is done with `org-element--cache-key-less-p'.
4699 When no synchronization is taking place, a key is simply the
4700 beginning position of the element, or that position plus one in
4701 the case of an first item (respectively row) in
4702 a list (respectively a table).
4704 During a synchronization, the key is the one the element had when
4705 the cache was synchronized for the last time. Elements added to
4706 cache during the synchronization get a new key generated with
4707 `org-element--cache-generate-key'.
4709 Such keys are stored in `org-element--cache-sync-keys'. The hash
4710 table is cleared once the synchronization is complete."
4713 ;; Increase beginning position of items (respectively
4714 ;; table rows) by one, so the first item can get
4715 ;; a different key from its parent list (respectively
4716 ;; table).
4719 begin)))
4722 key))))
4725 "Generate a key between LOWER and UPPER.
4727 LOWER and UPPER are integers or lists, possibly empty.
4729 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4730 a unique key, as an integer or a list of integers, according to
4731 the following rules:
4733 - LOWER and UPPER are compared level-wise until values differ.
4735 - If, at a given level, LOWER and UPPER differ from more than
4736 2, the new key shares all the levels above with LOWER and
4737 gets a new level. Its value is the mean between LOWER and
4738 UPPER:
4740 \(1 2) + (1 4) --> (1 3)
4742 - If LOWER has no value to compare with, it is assumed that its
4743 value is `most-negative-fixnum'. E.g.,
4745 \(1 1) + (1 1 2)
4747 is equivalent to
4749 \(1 1 m) + (1 1 2)
4751 where m is `most-negative-fixnum'. Likewise, if UPPER is
4752 short of levels, the current value is `most-positive-fixnum'.
4754 - If they differ from only one, the new key inherits from
4755 current LOWER level and fork it at the next level. E.g.,
4757 \(2 1) + (3 3)
4759 is equivalent to
4761 \(2 1) + (2 M)
4763 where M is `most-positive-fixnum'.
4765 - If the key is only one level long, it is returned as an
4766 integer:
4768 \(1 2) + (3 2) --> 2
4770 When they are not equals, the function assumes that LOWER is
4771 lesser than UPPER, per `org-element--cache-key-less-p'."
4775 skip-upper key)
4786 ;; When at a given level, LOWER and UPPER differ from
4787 ;; 1, ignore UPPER altogether. Instead create a key
4788 ;; between LOWER and the greatest key with the same
4789 ;; prefix as LOWER so far.
4795 "Non-nil if key A is less than key B.
4796 A and B are either integers or lists of integers, as returned by
4797 `org-element--cache-key'."
4805 ;; If A is empty, either keys are equal (B is also empty) and
4806 ;; we return nil, or A is lesser than B (B is longer) and we
4807 ;; return a non-nil value.
4808 ;;
4809 ;; If A is not empty, B is necessarily empty and A is greater
4810 ;; than B (A is longer). Therefore, return nil.
4814 "Non-nil when element A is located before element B."
4819 "Return root value in cache.
4820 This function assumes `org-element--cache' is a valid AVL tree."
4824 ;;;; Tools
4827 "Non-nil when cache is active in current buffer."
4832 "Find element in cache starting at POS or before.
4834 POS refers to a buffer position.
4836 When optional argument SIDE is non-nil, the function checks for
4837 elements starting at or past POS instead. If SIDE is `both', the
4838 function returns a cons cell where car is the first element
4839 starting at or before POS and cdr the first element starting
4840 after POS.
4842 The function can only find elements in the synchronized part of
4843 the cache."
4847 lower upper)
4862 ;; We found an element in cache starting at POS. If `side'
4863 ;; is `both' we also want the next one in order to generate
4864 ;; a key in-between.
4865 ;;
4866 ;; If the element is the first row or item in a table or
4867 ;; a plain list, we always return the table or the plain
4868 ;; list.
4869 ;;
4870 ;; In any other case, we return the element found.
4879 lower parent
4880 upper parent)))))
4883 lower element
4884 upper element)))))
4891 "Store ELEMENT in current buffer's cache, if allowed.
4892 When optional argument DATA is non-nil, assume is it object data
4893 relative to ELEMENT and store it in the objects cache."
4897 ;; During synchronization, first build an appropriate key
4898 ;; for the new element so `avl-tree-enter' can insert it at
4899 ;; the right spot in the cache.
4908 org-element--cache-sync-keys)))
4910 ;; Headlines are not stored in cache, so objects in titles are
4911 ;; not stored either.
4916 "Remove ELEMENT from cache.
4917 Assume ELEMENT belongs to cache and that a cache is active."
4922 ;;;; Synchronization
4925 "Set idle timer for cache synchronization in BUFFER."
4932 org-element-cache-sync-idle-time))
4933 nil
4934 #'org-element--cache-sync
4935 buffer)))
4938 "Non-nil when synchronization process should be interrupted.
4939 TIME-LIMIT is a time value or nil."
4945 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4947 Properties containing buffer positions are `:begin', `:end',
4948 `:contents-begin', `:contents-end' and `:structure'. When
4949 optional argument PROPS is a list of keywords, only shift
4950 properties provided in that list.
4952 Properties are modified by side-effect."
4954 ;; Shift `:structure' property for the first plain list only: it
4955 ;; is the only one that really matters and it prevents from
4956 ;; shifting it more than once.
4970 "Synchronize cache with recent modification in BUFFER.
4972 When optional argument THRESHOLD is non-nil, do the
4973 synchronization for all elements starting before or at threshold,
4974 then exit. Otherwise, synchronize cache for as long as
4975 `org-element-cache-sync-duration' or until Emacs leaves idle
4976 state.
4978 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4979 not registered yet in the cache are going to happen. It is used
4980 in `org-element--cache-submit-request', where cache is partially
4981 updated before current modification are actually submitted."
4992 request
4994 threshold
4997 org-element-cache-sync-duration))
4998 future-change)
4999 ;; Request processed. Merge current and next offsets and
5000 ;; transfer ending position.
5006 ;; If more requests are awaiting, set idle timer accordingly.
5007 ;; Otherwise, reset keys.
5014 "Process synchronization REQUEST for all entries before NEXT.
5016 REQUEST is a vector, built by `org-element--cache-submit-request'.
5018 NEXT is a cache key, as returned by `org-element--cache-key'.
5020 When non-nil, THRESHOLD is a buffer position. Synchronization
5021 stops as soon as a shifted element begins after it.
5023 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5024 after this time or when Emacs exits idle state.
5026 When non-nil, FUTURE-CHANGE is a buffer position where changes
5027 not registered yet in the cache are going to happen. See
5028 `org-element--cache-submit-request' for more information.
5030 Throw `interrupt' if the process stops before completing the
5031 request."
5034 ;; Phase 0.
5035 ;;
5036 ;; Delete all elements starting after BEG, but not after buffer
5037 ;; position END or past element with key NEXT.
5038 ;;
5039 ;; At each iteration, we start again at tree root since
5040 ;; a deletion modifies structure of the balanced tree.
5048 ;; Find first element in cache with key BEG or after it.
5058 data-key key
5061 data-key key
5062 node nil)))))
5071 up))
5077 ;; No element starting after modifications left in
5078 ;; cache: further processing is futile.
5081 ;; Phase 1.
5082 ;;
5083 ;; Phase 0 left a hole in the cache. Some elements after it
5084 ;; could have parents within. For example, in the following
5085 ;; buffer:
5086 ;;
5087 ;; - item
5088 ;;
5089 ;;
5090 ;; Paragraph1
5091 ;;
5092 ;; Paragraph2
5093 ;;
5094 ;; if we remove a blank line between "item" and "Paragraph1",
5095 ;; everything down to "Paragraph2" is removed from cache. But
5096 ;; the paragraph now belongs to the list, and its `:parent'
5097 ;; property no longer is accurate.
5098 ;;
5099 ;; Therefore we need to parse again elements in the hole, or at
5100 ;; least in its last section, so that we can re-parent
5101 ;; subsequent elements, during phase 2.
5102 ;;
5103 ;; Note that we only need to get the parent from the first
5104 ;; element in cache after the hole.
5105 ;;
5106 ;; When next key is lesser or equal to the current one, delegate
5107 ;; phase 1 processing to next request in order to preserve key
5108 ;; order among requests.
5116 ;; Next element will start at its beginning position plus
5117 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5118 ;; contains the real beginning position of the first element to
5119 ;; shift and re-parent.
5123 ;; Changes are going to happen around this element and
5124 ;; they will trigger another phase 1 request. Skip the
5125 ;; current one.
5131 ;; Phase 2.
5132 ;;
5133 ;; Shift all elements starting from key START, but before NEXT, by
5134 ;; OFFSET, and re-parent them when appropriate.
5135 ;;
5136 ;; Elements are modified by side-effect so the tree structure
5137 ;; remains intact.
5138 ;;
5139 ;; Once THRESHOLD, if any, is reached, or once there is an input
5140 ;; pending, exit. Before leaving, the current synchronization
5141 ;; request is updated.
5148 exit-flag)
5149 ;; No re-parenting nor shifting planned: request is over.
5159 ;; We reached NEXT. Request is complete.
5161 ;; Handle interruption request. Update current request.
5166 ;; Shift element.
5169 ;; Shift associated objects data, if any.
5174 ;; Update PARENT and re-parent DATA, only when
5175 ;; necessary. Propagate new structures for lists.
5189 ;; Cache is up-to-date past THRESHOLD. Request
5190 ;; interruption.
5195 ;; We reached end of tree: synchronization complete.
5196 t)))
5199 "Parse elements in current section, down to POS.
5201 Start parsing from the closest between the last known element in
5202 cache or headline above. Return the smallest element containing
5203 POS.
5205 When optional argument SYNCP is non-nil, return the parent of the
5206 element containing POS instead. In that case, it is also
5207 possible to provide TIME-LIMIT, which is a time value specifying
5208 when the parsing should stop. The function throws `interrupt' if
5209 the process stopped before finding the expected result."
5216 element next)
5218 ;; Nothing in cache before point: start parsing from first
5219 ;; element following headline above, or first element in
5220 ;; buffer.
5226 ;; Cache returned exact match: return it.
5229 ;; There's a headline between cached value and POS: cached
5230 ;; value is invalid. Start parsing from first element
5231 ;; following the headline.
5237 ;; Check if CACHED or any of its ancestors contain point.
5238 ;;
5239 ;; If there is such an element, we inspect it in order to know
5240 ;; if we return it or if we need to parse its contents.
5241 ;; Otherwise, we just start parsing from current location,
5242 ;; which is right after the top-most element containing
5243 ;; CACHED.
5244 ;;
5245 ;; As a special case, if POS is at the end of the buffer, we
5246 ;; want to return the innermost element ending there.
5247 ;;
5248 ;; Also, if we find an ancestor and discover that we need to
5249 ;; parse its contents, make sure we don't start from
5250 ;; `:contents-begin', as we would otherwise go past CACHED
5251 ;; again. Instead, in that situation, we will resume parsing
5252 ;; from NEXT, which is located after CACHED or its higher
5253 ;; ancestor not containing point.
5265 ;; Parse successively each element until we reach POS.
5271 special-flag)
5279 end 'element special-flag
5286 ;; Skip any element ending before point. Also skip
5287 ;; element ending at point (unless it is also the end of
5288 ;; buffer) since we're sure that another element begins
5289 ;; after it.
5292 ;; A non-greater element contains point: return it.
5295 ;; Otherwise, we have to decide if ELEMENT really
5296 ;; contains POS. In that case we start parsing from
5297 ;; contents' beginning.
5298 ;;
5299 ;; If POS is at contents' beginning but it is also at
5300 ;; the beginning of the first item in a list or a table.
5301 ;; In that case, we need to create an anchor for that
5302 ;; list or table, so return it.
5303 ;;
5304 ;; Also, if POS is at the end of the buffer, no element
5305 ;; can start after it, but more than one may end there.
5306 ;; Arbitrarily, we choose to return the innermost of
5307 ;; such elements.
5323 parent element
5324 end cend))))
5325 ;; Otherwise, return ELEMENT as it is the smallest
5326 ;; element containing POS.
5331 ;;;; Staging Buffer Changes
5337 ;; Blocks
5339 ;; LaTeX environments.
5341 ;; Drawers.
5344 "Regexp matching a sensitive line, structure wise.
5345 A sensitive line is a headline, inlinetask, block, drawer, or
5346 latex-environment boundary. When such a line is modified,
5347 structure changes in the document may propagate in the whole
5351 "Non-nil when a sensitive line is about to be changed.
5355 "Request extension of area going to be modified if needed.
5356 BEG and END are the beginning and end of the range of changed
5357 text. See `before-change-functions' for more information."
5367 'headline
5370 org-element--cache-sensitive-re bottom t)))))))))
5373 "Update buffer modifications for current buffer.
5374 BEG and END are the beginning and end of the range of changed
5375 text, and the length in bytes of the pre-change text replaced by
5376 that range. See `after-change-functions' for more information."
5384 ;; Determine if modified area needs to be extended, according
5385 ;; to both previous and current state. We make a special
5386 ;; case for headline editing: if a headline is modified but
5387 ;; not removed, do not extend.
5396 org-element--cache-sensitive-re bottom t))))
5397 ;; Effectively extend modified area.
5405 ;; Store synchronization request.
5408 ;; Activate a timer to process the request during idle time.
5412 "Return first element to remove from cache.
5414 BEG and END are buffer positions delimiting buffer modifications.
5415 OFFSET is the size of the changes.
5417 Returned element is usually the first element in cache containing
5418 any position between BEG and END. As an exception, greater
5419 elements around the changes that are robust to contents
5420 modifications are preserved and updated according to the
5421 changes."
5431 property-drawer quote-block
5432 special-block))
5435 ;; UP is a robust greater element containing changes.
5436 ;; We only need to extend its ending boundaries.
5442 ;; We're at top level element containing ELEMENT: if it's
5443 ;; altered by buffer modifications, it is first element in
5444 ;; cache to be removed. Otherwise, that first element is the
5445 ;; following one.
5446 ;;
5447 ;; As a special case, do not remove BEFORE if it is a robust
5448 ;; container for current changes.
5450 before)))))
5453 "Submit a new cache synchronization request for current buffer.
5454 BEG and END are buffer positions delimiting the minimal area
5455 where cache data should be removed. OFFSET is the size of the
5456 change, as an integer."
5458 delete-to delete-from)
5463 ;; Current changes can be merged with first sync request: we
5464 ;; can save a partial cache synchronization.
5467 ;; If last change happened within area to be removed, extend
5468 ;; boundaries of robust parents, if any. Otherwise, find
5469 ;; first element to remove and update request accordingly.
5481 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5482 ;; if any, is no longer a 0-phase request, thus ensuring that
5483 ;; phases are properly ordered. We need to provide OFFSET as
5484 ;; optional parameter since current modifications are not known
5485 ;; yet to the otherwise correct part of the cache (i.e, before
5486 ;; the first request).
5493 ;; When changes happen before the first known
5494 ;; element, re-parent and shift the rest of the
5495 ;; cache.
5497 ;; Otherwise, we find the first non robust
5498 ;; element containing END. All elements between
5499 ;; FIRST and this one are to be removed.
5500 ;;
5501 ;; Among them, some could be located outside the
5502 ;; synchronized part of the cache, in which case
5503 ;; comparing buffer positions to find them is
5504 ;; useless. Instead, we store the element
5505 ;; containing them in the request itself. All
5506 ;; its children will be removed.
5518 element up))
5521 org-element--cache-sync-requests)
5522 ;; No element to remove. No need to re-parent either.
5523 ;; Simply shift additional elements, if any, by OFFSET.
5528 ;;;; Public Functions
5530 ;;;###autoload
5532 "Reset cache in current buffer.
5533 When optional argument ALL is non-nil, reset cache in all Org
5534 buffers."
5552 ;;;###autoload
5554 "Refresh cache at position POS."
5561 \f
5562 ;;; The Toolbox
5563 ;;
5564 ;; The first move is to implement a way to obtain the smallest element
5565 ;; containing point. This is the job of `org-element-at-point'. It
5566 ;; basically jumps back to the beginning of section containing point
5567 ;; and proceed, one element after the other, with
5568 ;; `org-element--current-element' until the container is found. Note:
5569 ;; When using `org-element-at-point', secondary values are never
5570 ;; parsed since the function focuses on elements, not on objects.
5571 ;;
5572 ;; At a deeper level, `org-element-context' lists all elements and
5573 ;; objects containing point.
5574 ;;
5575 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5576 ;; internally by navigation and manipulation tools.
5579 ;;;###autoload
5581 "Determine closest element around point.
5583 Return value is a list like (TYPE PROPS) where TYPE is the type
5584 of the element and PROPS a plist of properties associated to the
5585 element.
5587 Possible types are defined in `org-element-all-elements'.
5588 Properties depend on element or object type, but always include
5589 `:begin', `:end', `:parent' and `:post-blank' properties.
5591 As a special case, if point is at the very beginning of the first
5592 item in a list or sub-list, returned element will be that list
5593 instead of the item. Likewise, if point is at the beginning of
5594 the first row of a table, returned element will be the table
5595 instead of the first row.
5597 When point is at the end of the buffer, return the innermost
5598 element ending there."
5604 ;; Within blank lines at the beginning of buffer, return nil.
5606 ;; Within blank lines right after a headline, return that
5607 ;; headline.
5611 ;; Otherwise parse until we find element containing ORIGIN.
5618 ;;;###autoload
5620 "Return smallest element or object around point.
5622 Return value is a list like (TYPE PROPS) where TYPE is the type
5623 of the element or object and PROPS a plist of properties
5624 associated to it.
5626 Possible types are defined in `org-element-all-elements' and
5627 `org-element-all-objects'. Properties depend on element or
5628 object type, but always include `:begin', `:end', `:parent' and
5629 `:post-blank'.
5631 As a special case, if point is right after an object and not at
5632 the beginning of any other object, return that object.
5634 Optional argument ELEMENT, when non-nil, is the closest element
5635 containing point, as returned by `org-element-at-point'.
5636 Providing it allows for quicker computation."
5642 ;; If point is inside an element containing objects or
5643 ;; a secondary string, narrow buffer to the container and
5644 ;; proceed with parsing. Otherwise, return ELEMENT.
5646 ;; At a parsed affiliated keyword, check if we're inside main
5647 ;; or dual value.
5654 org-element-parsed-keywords))
5663 ;; Also change type to retrieve correct restrictions.
5665 ;; At an item, objects can only be located within tag, if any.
5675 ;; At an headline or inlinetask, objects are in title.
5682 ;; At a paragraph, a table-row or a verse block, objects are
5683 ;; located within their contents.
5687 ;; CBEG is nil for table rules.
5692 ;; At a parsed keyword, objects are located within value.
5695 org-element-document-properties))
5702 ;; At a planning line, if point is at a timestamp, return it,
5703 ;; otherwise, return element.
5711 ;; All other locations cannot contain objects: bail out.
5721 next object-data last)
5725 ;; When entering PARENT for the first time, get list
5726 ;; of objects within known so far. Store it in
5727 ;; OBJECT-DATA.
5732 ;; Find NEXT object for analysis.
5734 ;; If NEXT is non-nil, we already exhausted the
5735 ;; cache so we can parse buffer to find the object
5736 ;; after it.
5738 ;; Otherwise, check if cache can help us.
5749 ;; Cache contains the information needed.
5752 pos)
5754 pos)
5760 ;; If we have a new object to analyze, store it in
5761 ;; cache. Otherwise record that there is nothing
5762 ;; more to parse in this element at this depth.
5767 ;; Process NEXT, if any, in order to know if we need
5768 ;; to skip it, return it or move into it.
5775 ;; Skip objects ending before point. Also skip
5776 ;; objects ending at point unless it is also the
5777 ;; end of buffer, since we want to return the
5778 ;; innermost object.
5781 ;; For convenience, when object ends at POS,
5782 ;; without any space, store it in LAST, as we
5783 ;; will return it if no object starts here.
5787 ;; If POS is within a container object, move
5788 ;; into that object.
5792 ;; At contents' end, if there is no
5793 ;; space before point, also move into
5794 ;; object, for consistency with
5795 ;; convenience feature above.
5804 next nil
5805 object-data nil))
5806 ;; Otherwise, return NEXT.
5808 ;; Store results in cache, if applicable.
5812 "Non-nil when elements ELEM-A and ELEM-B are nested."
5821 "Swap elements ELEM-A and ELEM-B.
5822 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5823 end of ELEM-A."
5825 ;; There are two special cases when an element doesn't start at bol:
5826 ;; the first paragraph in an item or in a footnote definition.
5828 ;; Only a paragraph without any affiliated keyword can be moved at
5829 ;; ELEM-A position in such a situation. Note that the case of
5830 ;; a footnote definition is impossible: it cannot contain two
5831 ;; paragraphs in a row because it cannot contain a blank line.
5837 ;; In a special situation, ELEM-A will have no indentation. We'll
5838 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5852 ;; Store overlays responsible for visibility status. We
5853 ;; also need to store their boundaries as they will be
5854 ;; removed from buffer.
5861 ;; Get contents.
5869 ;; Restore ex ELEM-A overlays.
5878 ;; Restore ex ELEM-B overlays.
5886 "Remove maximum common indentation in string S and return it.
5887 When optional argument N is a positive integer, remove exactly
5888 that much characters from indentation, if possible, or return
5889 S as-is otherwise. Unlike to `org-remove-indentation', this
5890 function doesn't call `untabify' on S."
5895 ;; Find maximum common indentation, if not specified.
5903 min-ind)))
5905 ;; Remove exactly N indentation, but give up if not possible.
5918 ;; Local variables:
5919 ;; generated-autoload-file: "org-loaddefs.el"
5920 ;; End:
5922 ;;; org-element.el ends here