| blob | a7c2c0406865e33b7f0288ea5861b15b79c52ae0 |
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 and `:footnote-section-p' 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."
1774 ;;;; Diary Sexp
1777 "Parse a diary sexp.
1779 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1780 the buffer position at the beginning of the first affiliated
1781 keyword and CDR is a plist of affiliated keywords along with
1782 their value.
1784 Return a list whose CAR is `diary-sexp' and CDR is a plist
1785 containing `:begin', `:end', `:value', `:post-blank' and
1786 `:post-affiliated' keywords."
1798 :begin begin
1799 :end end
1805 "Interpret DIARY-SEXP as Org syntax.
1806 CONTENTS is nil."
1810 ;;;; Example Block
1813 "Parse an example block.
1815 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1816 the buffer position at the beginning of the first affiliated
1817 keyword and CDR is a plist of affiliated keywords along with
1818 their value.
1820 Return a list whose CAR is `example-block' and CDR is a plist
1821 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1822 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1823 `:value', `:post-blank' and `:post-affiliated' keywords."
1827 ;; Incomplete block: parse it as a paragraph.
1835 ;; Switches analysis
1842 ;; Should labels be retained in (or stripped from) example
1843 ;; blocks?
1848 ;; What should code-references use - labels or
1849 ;; line-numbers?
1858 ;; Standard block parsing.
1866 contents-begin contents-end))
1867 block-ind))
1876 :end end
1877 :value value
1878 :switches switches
1879 :number-lines number-lines
1880 :preserve-indent preserve-indent
1881 :retain-labels retain-labels
1882 :use-labels use-labels
1883 :label-fmt label-fmt
1889 "Interpret EXAMPLE-BLOCK element as Org syntax.
1890 CONTENTS is nil."
1897 value
1902 ;;;; Fixed-width
1905 "Parse a fixed-width section.
1907 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1908 the buffer position at the beginning of the first affiliated
1909 keyword and CDR is a plist of affiliated keywords along with
1910 their value.
1912 Return a list whose CAR is `fixed-width' and CDR is a plist
1913 containing `:begin', `:end', `:value', `:post-blank' and
1914 `:post-affiliated' keywords.
1916 Assume point is at the beginning of the fixed-width area."
1920 value
1925 ;; Accumulate text without starting colons.
1938 :end end
1939 :value value
1945 "Interpret FIXED-WIDTH element as Org syntax.
1946 CONTENTS is nil."
1954 ;;;; Horizontal Rule
1957 "Parse an horizontal rule.
1959 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1960 the buffer position at the beginning of the first affiliated
1961 keyword and CDR is a plist of affiliated keywords along with
1962 their value.
1964 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1965 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1966 keywords."
1976 :end end
1982 "Interpret HORIZONTAL-RULE element as Org syntax.
1983 CONTENTS is nil."
1987 ;;;; Keyword
1990 "Parse a keyword at point.
1992 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1993 the buffer position at the beginning of the first affiliated
1994 keyword and CDR is a plist of affiliated keywords along with
1995 their value.
1997 Return a list whose CAR is `keyword' and CDR is a plist
1998 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1999 `:post-affiliated' keywords."
2001 ;; An orphaned affiliated keyword is considered as a regular
2002 ;; keyword. In this case AFFILIATED is nil, so we take care of
2003 ;; this corner case.
2016 :value value
2017 :begin begin
2018 :end end
2024 "Interpret KEYWORD element as Org syntax.
2025 CONTENTS is nil."
2031 ;;;; Latex Environment
2035 "Regexp matching the beginning of a LaTeX environment.
2036 The environment is captured by the first group.
2042 "Format string matching the ending of a LaTeX environment.
2046 "Parse a LaTeX environment.
2048 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2049 the buffer position at the beginning of the first affiliated
2050 keyword and CDR is a plist of affiliated keywords along with
2051 their value.
2053 Return a list whose CAR is `latex-environment' and CDR is a plist
2054 containing `:begin', `:end', `:value', `:post-blank' and
2055 `:post-affiliated' keywords.
2057 Assume point is at the beginning of the latex environment."
2064 limit t))
2065 ;; Incomplete latex environment: parse it as a paragraph.
2075 :end end
2076 :value value
2082 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2083 CONTENTS is nil."
2087 ;;;; Node Property
2090 "Parse a node-property at point.
2092 LIMIT bounds the search.
2094 Return a list whose CAR is `node-property' and CDR is a plist
2095 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2096 keywords."
2108 :value value
2109 :begin begin
2110 :end end
2114 "Interpret NODE-PROPERTY element as Org syntax.
2115 CONTENTS is nil."
2121 ;;;; Paragraph
2124 "Parse a paragraph.
2126 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2127 the buffer position at the beginning of the first affiliated
2128 keyword and CDR is a plist of affiliated keywords along with
2129 their value.
2131 Return a list whose CAR is `paragraph' and CDR is a plist
2132 containing `:begin', `:end', `:contents-begin' and
2133 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2135 Assume point is at the beginning of the paragraph."
2144 limit
2145 ;; A matching `org-element-paragraph-separate' is not
2146 ;; necessarily the end of the paragraph. In
2147 ;; particular, lines starting with # or : as a first
2148 ;; non-space character are ambiguous. We have to
2149 ;; check if they are valid Org syntax (e.g., not an
2150 ;; incomplete keyword).
2154 ;; There's no ambiguity for other symbols or
2155 ;; empty lines: stop here.
2157 ;; Stop at valid fixed-width areas.
2159 ;; Stop at drawers.
2164 ;; Stop at valid comments.
2166 ;; Stop at valid dynamic blocks.
2171 ;; Stop at valid blocks.
2178 limit t)))
2179 ;; Stop at valid latex environments.
2186 limit t)))
2187 ;; Stop at valid keywords.
2189 ;; Skip everything else.
2206 :end end
2207 :contents-begin contents-begin
2208 :contents-end contents-end
2214 "Interpret PARAGRAPH element as Org syntax.
2215 CONTENTS is the contents of the element."
2216 contents)
2219 ;;;; Planning
2222 "Parse a planning.
2224 LIMIT bounds the search.
2226 Return a list whose CAR is `planning' and CDR is a plist
2227 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2228 and `:post-blank' keywords."
2238 closed deadline scheduled)
2250 :deadline deadline
2251 :scheduled scheduled
2252 :begin begin
2253 :end end
2257 "Interpret PLANNING element as Org syntax.
2258 CONTENTS is nil."
2260 'identity
2277 ;;;; Src Block
2280 "Parse a src block.
2282 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2283 the buffer position at the beginning of the first affiliated
2284 keyword and CDR is a plist of affiliated keywords along with
2285 their value.
2287 Return a list whose CAR is `src-block' and CDR is a plist
2288 containing `:language', `:switches', `:parameters', `:begin',
2289 `:end', `:number-lines', `:retain-labels', `:use-labels',
2290 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2291 `:post-affiliated' keywords.
2293 Assume point is at the beginning of the block."
2296 limit t)))
2297 ;; Incomplete block: parse it as a paragraph.
2303 ;; Get language as a string.
2312 ;; Get switches.
2314 ;; Get parameters.
2316 ;; Switches analysis
2327 ;; Should labels be retained in (or stripped from)
2328 ;; src blocks?
2333 ;; What should code-references use - labels or
2334 ;; line-numbers?
2339 ;; Indentation.
2341 ;; Retrieve code.
2346 block-ind))
2350 ;; Get position after ending blank lines.
2360 :begin begin
2361 :end end
2362 :number-lines number-lines
2363 :preserve-indent preserve-indent
2364 :retain-labels retain-labels
2365 :use-labels use-labels
2366 :label-fmt label-fmt
2367 :value value
2373 "Interpret SRC-BLOCK element as Org syntax.
2374 CONTENTS is nil."
2383 val)
2397 ;;;; Table
2400 "Parse a table at point.
2402 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2403 the buffer position at the beginning of the first affiliated
2404 keyword and CDR is a plist of affiliated keywords along with
2405 their value.
2407 Return a list whose CAR is `table' and CDR is a plist containing
2408 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2409 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2410 keywords.
2412 Assume point is at the beginning of the table."
2426 acc))
2433 :end end
2434 :type type
2435 :tblfm tblfm
2436 ;; Only `org' tables have contents. `table.el' tables
2437 ;; use a `:value' property to store raw table as
2438 ;; a string.
2443 table-begin table-end))
2449 "Interpret TABLE element as Org syntax.
2450 CONTENTS is nil."
2461 ;;;; Table Row
2464 "Parse table row at point.
2466 LIMIT bounds the search.
2468 Return a list whose CAR is `table-row' and CDR is a plist
2469 containing `:begin', `:end', `:contents-begin', `:contents-end',
2470 `:type' and `:post-blank' keywords."
2474 ;; A table rule has no contents. In that case, ensure
2475 ;; CONTENTS-BEGIN matches CONTENTS-END.
2487 :begin begin
2488 :end end
2489 :contents-begin contents-begin
2490 :contents-end contents-end
2494 "Interpret TABLE-ROW element as Org syntax.
2495 CONTENTS is the contents of the table row."
2500 ;;;; Verse Block
2503 "Parse a verse block.
2505 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2506 the buffer position at the beginning of the first affiliated
2507 keyword and CDR is a plist of affiliated keywords along with
2508 their value.
2510 Return a list whose CAR is `verse-block' and CDR is a plist
2511 containing `:begin', `:end', `:contents-begin', `:contents-end',
2512 `:post-blank' and `:post-affiliated' keywords.
2514 Assume point is at beginning of the block."
2518 ;; Incomplete block: parse it as a paragraph.
2533 :end end
2534 :contents-begin contents-begin
2535 :contents-end contents-end
2541 "Interpret VERSE-BLOCK element as Org syntax.
2542 CONTENTS is verse block contents."
2546 \f
2547 ;;; Objects
2548 ;;
2549 ;; Unlike to elements, raw text can be found between objects. Hence,
2550 ;; `org-element--object-lex' is provided to find the next object in
2551 ;; buffer.
2552 ;;
2553 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2554 ;; object types they can contain will be specified in
2555 ;; `org-element-object-restrictions'.
2556 ;;
2557 ;; Creating a new type of object requires to alter
2558 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2559 ;; new type in `org-element-all-objects', and possibly add
2560 ;; restrictions in `org-element-object-restrictions'.
2562 ;;;; Bold
2565 "Parse bold object at point, if any.
2567 When at a bold object, return a list whose car is `bold' and cdr
2568 is a plist with `:begin', `:end', `:contents-begin' and
2569 `:contents-end' and `:post-blank' keywords. Otherwise, return
2570 nil.
2572 Assume point is at the first star marker."
2584 :end end
2585 :contents-begin contents-begin
2586 :contents-end contents-end
2590 "Interpret BOLD object as Org syntax.
2591 CONTENTS is the contents of the object."
2595 ;;;; Code
2598 "Parse code object at point, if any.
2600 When at a code object, return a list whose car is `code' and cdr
2601 is a plist with `:value', `:begin', `:end' and `:post-blank'
2602 keywords. Otherwise, return nil.
2604 Assume point is at the first tilde marker."
2615 :begin begin
2616 :end end
2620 "Interpret CODE object as Org syntax.
2621 CONTENTS is nil."
2625 ;;;; Entity
2628 "Parse entity at point, if any.
2630 When at an entity, return a list whose car is `entity' and cdr
2631 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2632 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2633 `:post-blank' as keywords. Otherwise, return nil.
2635 Assume point is at the beginning of the entity."
2637 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2655 :begin begin
2656 :end end
2657 :use-brackets-p bracketsp
2661 "Interpret ENTITY object as Org syntax.
2662 CONTENTS is nil."
2668 ;;;; Export Snippet
2671 "Parse export snippet at point.
2673 When at an export snippet, return a list whose car is
2674 `export-snippet' and cdr a plist with `:begin', `:end',
2675 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2676 return nil.
2678 Assume point is at the beginning of the snippet."
2694 :value value
2695 :begin begin
2696 :end end
2700 "Interpret EXPORT-SNIPPET object as Org syntax.
2701 CONTENTS is nil."
2707 ;;;; Footnote Reference
2710 "Parse footnote reference at point, if any.
2712 When at a footnote reference, return a list whose car is
2713 `footnote-reference' and cdr a plist with `:label', `:type',
2714 `:begin', `:end', `:content-begin', `:contents-end' and
2715 `:post-blank' as keywords. Otherwise, return nil."
2739 :type type
2740 :begin begin
2741 :end end
2747 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2748 CONTENTS is its definition, when inline, or nil."
2754 ;;;; Inline Babel Call
2757 "Parse inline babel call at point, if any.
2759 When at an inline babel call, return a list whose car is
2760 `inline-babel-call' and cdr a plist with `:begin', `:end',
2761 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2763 Assume point is at the beginning of the babel call."
2775 :end end
2776 :value value
2780 "Interpret INLINE-BABEL-CALL object as Org syntax.
2781 CONTENTS is nil."
2785 ;;;; Inline Src Block
2788 "Parse inline source block at point, if any.
2790 When at an inline source block, return a list whose car is
2791 `inline-src-block' and cdr a plist with `:begin', `:end',
2792 `:language', `:value', `:parameters' and `:post-blank' as
2793 keywords. Otherwise, return nil.
2795 Assume point is at the beginning of the inline src block."
2808 :value value
2809 :parameters parameters
2810 :begin begin
2811 :end end
2815 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2816 CONTENTS is nil."
2821 language
2823 body)))
2825 ;;;; Italic
2828 "Parse italic object at point, if any.
2830 When at an italic object, return a list whose car is `italic' and
2831 cdr is a plist with `:begin', `:end', `:contents-begin' and
2832 `:contents-end' and `:post-blank' keywords. Otherwise, return
2833 nil.
2835 Assume point is at the first slash marker."
2847 :end end
2848 :contents-begin contents-begin
2849 :contents-end contents-end
2853 "Interpret ITALIC object as Org syntax.
2854 CONTENTS is the contents of the object."
2858 ;;;; Latex Fragment
2861 "Parse LaTeX fragment at point, if any.
2863 When at a LaTeX fragment, return a list whose car is
2864 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2865 and `:post-blank' as keywords. Otherwise, return nil.
2867 Assume point is at the beginning of the LaTeX fragment."
2885 ;; Macro.
2894 :begin begin
2895 :end end
2899 "Interpret LATEX-FRAGMENT object as Org syntax.
2900 CONTENTS is nil."
2903 ;;;; Line Break
2906 "Parse line break at point, if any.
2908 When at a line break, return a list whose car is `line-break',
2909 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2910 Otherwise, return nil.
2912 Assume point is at the beginning of the line break."
2921 "Interpret LINE-BREAK object as Org syntax.
2922 CONTENTS is nil."
2926 ;;;; Link
2929 "Parse link at point, if any.
2931 When at a link, return a list whose car is `link' and cdr a plist
2932 with `:type', `:path', `:raw-link', `:application',
2933 `:search-option', `:begin', `:end', `:contents-begin',
2934 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2935 nil.
2937 Assume point is at the beginning of the link."
2940 end contents-begin contents-end link-end post-blank path type
2941 raw-link link search-option application)
2943 ;; Type 1: Text targeted from a radio target.
2952 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2957 ;; RAW-LINK is the original link. Expand any
2958 ;; abbreviation in it.
2962 ;; Determine TYPE of link and set PATH accordingly.
2964 ;; File type.
2968 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2971 ;; According to RFC 3986, extra whitespace should be
2972 ;; ignored when a URI is extracted.
2975 ;; Id type: PATH is the id.
2978 ;; Code-ref type: PATH is the name of the reference.
2981 ;; Custom-id type: PATH is the name of the custom id.
2984 ;; Fuzzy type: Internal link either matches a target, an
2985 ;; headline name or nothing. PATH is the target or
2986 ;; headline's name.
2988 ;; Type 3: Plain link, e.g., http://orgmode.org
2994 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3002 ;; In any case, deduce end point after trailing white space from
3003 ;; LINK-END variable.
3007 ;; Special "file" type link processing.
3009 ;; Extract opening application and search option.
3017 ;; Normalize URI.
3021 ;; Make sure TYPE always reports "file".
3025 :path path
3027 :application application
3028 :search-option search-option
3029 :begin begin
3030 :end end
3031 :contents-begin contents-begin
3032 :contents-end contents-end
3036 "Interpret LINK object as Org syntax.
3037 CONTENTS is the contents of the object, or nil."
3042 raw-link
3046 ;;;; Macro
3049 "Parse macro at point, if any.
3051 When at a macro, return a list whose car is `macro' and cdr
3052 a plist with `:key', `:args', `:begin', `:end', `:value' and
3053 `:post-blank' as keywords. Otherwise, return nil.
3055 Assume point is at the macro."
3066 ;; Do not use `org-split-string' since empty
3067 ;; strings are meaningful here.
3075 args nil t)
3079 :value value
3080 :args args
3081 :begin begin
3082 :end end
3086 "Interpret MACRO object as Org syntax.
3087 CONTENTS is nil."
3091 ;;;; Radio-target
3094 "Parse radio target at point, if any.
3096 When at a radio target, return a list whose car is `radio-target'
3097 and cdr a plist with `:begin', `:end', `:contents-begin',
3098 `:contents-end', `:value' and `:post-blank' as keywords.
3099 Otherwise, return nil.
3101 Assume point is at the radio target."
3113 :end end
3114 :contents-begin contents-begin
3115 :contents-end contents-end
3116 :post-blank post-blank
3120 "Interpret TARGET object as Org syntax.
3121 CONTENTS is the contents of the object."
3125 ;;;; Statistics Cookie
3128 "Parse statistics cookie at point, if any.
3130 When at a statistics cookie, return a list whose car is
3131 `statistics-cookie', and cdr a plist with `:begin', `:end',
3132 `:value' and `:post-blank' keywords. Otherwise, return nil.
3134 Assume point is at the beginning of the statistics-cookie."
3145 :end end
3146 :value value
3150 "Interpret STATISTICS-COOKIE object as Org syntax.
3151 CONTENTS is nil."
3155 ;;;; Strike-Through
3158 "Parse strike-through object at point, if any.
3160 When at a strike-through object, return a list whose car is
3161 `strike-through' and cdr is a plist with `:begin', `:end',
3162 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3163 Otherwise, return nil.
3165 Assume point is at the first plus sign marker."
3177 :end end
3178 :contents-begin contents-begin
3179 :contents-end contents-end
3183 "Interpret STRIKE-THROUGH object as Org syntax.
3184 CONTENTS is the contents of the object."
3188 ;;;; Subscript
3191 "Parse subscript at point, if any.
3193 When at a subscript object, return a list whose car is
3194 `subscript' and cdr a plist with `:begin', `:end',
3195 `:contents-begin', `:contents-end', `:use-brackets-p' and
3196 `:post-blank' as keywords. Otherwise, return nil.
3198 Assume point is at the underscore."
3212 :end end
3213 :use-brackets-p bracketsp
3214 :contents-begin contents-begin
3215 :contents-end contents-end
3219 "Interpret SUBSCRIPT object as Org syntax.
3220 CONTENTS is the contents of the object."
3223 contents))
3226 ;;;; Superscript
3229 "Parse superscript at point, if any.
3231 When at a superscript object, return a list whose car is
3232 `superscript' and cdr a plist with `:begin', `:end',
3233 `:contents-begin', `:contents-end', `:use-brackets-p' and
3234 `:post-blank' as keywords. Otherwise, return nil.
3236 Assume point is at the caret."
3250 :end end
3251 :use-brackets-p bracketsp
3252 :contents-begin contents-begin
3253 :contents-end contents-end
3257 "Interpret SUPERSCRIPT object as Org syntax.
3258 CONTENTS is the contents of the object."
3261 contents))
3264 ;;;; Table Cell
3267 "Parse table cell at point.
3268 Return a list whose car is `table-cell' and cdr is a plist
3269 containing `:begin', `:end', `:contents-begin', `:contents-end'
3270 and `:post-blank' keywords."
3278 :end end
3279 :contents-begin contents-begin
3280 :contents-end contents-end
3284 "Interpret TABLE-CELL element as Org syntax.
3285 CONTENTS is the contents of the cell, or nil."
3289 ;;;; Target
3292 "Parse target at point, if any.
3294 When at a target, return a list whose car is `target' and cdr
3295 a plist with `:begin', `:end', `:value' and `:post-blank' as
3296 keywords. Otherwise, return nil.
3298 Assume point is at the target."
3308 :end end
3309 :value value
3313 "Interpret TARGET object as Org syntax.
3314 CONTENTS is nil."
3318 ;;;; Timestamp
3329 "Parse time stamp at point, if any.
3331 When at a time stamp, return a list whose car is `timestamp', and
3332 cdr a plist with `:type', `:raw-value', `:year-start',
3333 `:month-start', `:day-start', `:hour-start', `:minute-start',
3334 `:year-end', `:month-end', `:day-end', `:hour-end',
3335 `:minute-end', `:repeater-type', `:repeater-value',
3336 `:repeater-unit', `:warning-type', `:warning-value',
3337 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3338 Otherwise, return nil.
3340 Assume point is at the beginning of the timestamp."
3359 date-start)
3370 raw-value)
3372 :repeater-type
3378 :repeater-unit
3387 :warning-unit
3390 year-start month-start day-start hour-start minute-start year-end
3391 month-end day-end hour-end minute-end)
3392 ;; Parse date-start.
3400 ;; Compute date-end. It can be provided directly in time-stamp,
3401 ;; or extracted from time range. Otherwise, it defaults to the
3402 ;; same values as date-start.
3412 :raw-value raw-value
3413 :year-start year-start
3414 :month-start month-start
3415 :day-start day-start
3416 :hour-start hour-start
3417 :minute-start minute-start
3418 :year-end year-end
3419 :month-end month-end
3420 :day-end day-end
3421 :hour-end hour-end
3422 :minute-end minute-end
3423 :begin begin
3424 :end end
3426 repeater-props
3427 warning-props))))))
3430 "Interpret TIMESTAMP object as Org syntax.
3431 CONTENTS is nil."
3450 ;; Build an Org timestamp string from TIME. ACTIVEP is
3451 ;; non-nil when time stamp is active. If WITH-TIME-P is
3452 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3453 ;; specify a time range in the timestamp. REPEAT-STRING is
3454 ;; the repeater string, if any.
3458 org-time-stamp-formats)
3459 time)))
3465 nil nil ts)))
3470 " "
3471 s
3473 ;; Return value.
3474 ts)))
3486 build-ts-string
3505 0
3513 "--"
3525 ;;;; Underline
3528 "Parse underline object at point, if any.
3530 When at an underline object, return a list whose car is
3531 `underline' and cdr is a plist with `:begin', `:end',
3532 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3533 Otherwise, return nil.
3535 Assume point is at the first underscore marker."
3547 :end end
3548 :contents-begin contents-begin
3549 :contents-end contents-end
3553 "Interpret UNDERLINE object as Org syntax.
3554 CONTENTS is the contents of the object."
3558 ;;;; Verbatim
3561 "Parse verbatim object at point, if any.
3563 When at a verbatim object, return a list whose car is `verbatim'
3564 and cdr is a plist with `:value', `:begin', `:end' and
3565 `:post-blank' keywords. Otherwise, return nil.
3567 Assume point is at the first equal sign marker."
3578 :begin begin
3579 :end end
3583 "Interpret VERBATIM object as Org syntax.
3584 CONTENTS is nil."
3588 \f
3589 ;;; Parsing Element Starting At Point
3590 ;;
3591 ;; `org-element--current-element' is the core function of this section.
3592 ;; It returns the Lisp representation of the element starting at
3593 ;; point.
3594 ;;
3595 ;; `org-element--current-element' makes use of special modes. They
3596 ;; are activated for fixed element chaining (e.g., `plain-list' >
3597 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3598 ;; `section'). Special modes are: `first-section', `item',
3599 ;; `node-property', `section' and `table-row'.
3603 "Parse the element starting at point.
3605 Return value is a list like (TYPE PROPS) where TYPE is the type
3606 of the element and PROPS a plist of properties associated to the
3607 element.
3609 Possible types are defined in `org-element-all-elements'.
3611 LIMIT bounds the search.
3613 Optional argument GRANULARITY determines the depth of the
3614 recursion. Allowed values are `headline', `greater-element',
3615 `element', `object' or nil. When it is broader than `object' (or
3616 nil), secondary values will not be parsed, since they only
3617 contain objects.
3619 Optional argument SPECIAL, when non-nil, can be either
3620 `first-section', `item', `node-property', `section', and
3621 `table-row'.
3623 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3624 be computed.
3626 This function assumes point is always at the beginning of the
3627 element it has to parse."
3630 ;; Determine if parsing depth allows for secondary strings
3631 ;; parsing. It only applies to elements referenced in
3632 ;; `org-element-secondary-value-alist'.
3635 ;; Item.
3638 ;; Table Row.
3640 ;; Node Property.
3642 ;; Headline.
3645 ;; Sections (must be checked after headline).
3650 limit)))
3651 ;; When not at bol, point is at the beginning of an item or
3652 ;; a footnote definition: next item is always a paragraph.
3654 ;; Planning and Clock.
3659 ;; Inlinetask.
3662 ;; From there, elements can have affiliated keywords.
3665 ;; Jumping over affiliated keywords put point off-limits.
3666 ;; Parse them as regular keywords.
3670 ;; LaTeX Environment.
3673 ;; Drawer and Property Drawer.
3678 ;; Fixed Width
3681 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3682 ;; Keywords.
3691 org-element-block-name-alist)))
3706 ;; Footnote Definition.
3709 ;; Horizontal Rule.
3712 ;; Diary Sexp.
3715 ;; Table.
3717 ;; List.
3720 limit affiliated
3722 ;; Default element: Paragraph.
3726 ;; Most elements can have affiliated keywords. When looking for an
3727 ;; element beginning, we want to move before them, as they belong to
3728 ;; that element, and, in the meantime, collect information they give
3729 ;; into appropriate properties. Hence the following function.
3732 "Collect affiliated keywords from point down to LIMIT.
3734 Return a list whose CAR is the position at the first of them and
3735 CDR a plist of keywords and values and move point to the
3736 beginning of the first line after them.
3738 As a special case, if element doesn't start at the beginning of
3739 the line (e.g., a paragraph starting an item), CAR is current
3740 position of point and CDR is nil."
3744 ;; RESTRICT is the list of objects allowed in parsed
3745 ;; keywords value.
3747 output)
3750 ;; Apply translation to RAW-KWD. From there, KWD is
3751 ;; the official keyword.
3753 org-element-keyword-translation-alist))
3754 raw-kwd))
3755 ;; Find main value for any keyword.
3761 ;; PARSEDP is non-nil when keyword should have its
3762 ;; value parsed.
3764 ;; If KWD is a dual keyword, find its secondary
3765 ;; value. Maybe parse it.
3772 ;; Attribute a property name to KWD.
3774 ;; Now set final shape for VALUE.
3780 ;; Attributes can always appear on multiple lines.
3783 ;; Eventually store the new value in OUTPUT.
3785 ;; Move to next keyword.
3787 ;; If affiliated keywords are orphaned: move back to first one.
3788 ;; They will be parsed as a paragraph.
3790 ;; Return value.
3794 \f
3795 ;;; The Org Parser
3796 ;;
3797 ;; The two major functions here are `org-element-parse-buffer', which
3798 ;; parses Org syntax inside the current buffer, taking into account
3799 ;; region, narrowing, or even visibility if specified, and
3800 ;; `org-element-parse-secondary-string', which parses objects within
3801 ;; a given string.
3802 ;;
3803 ;; The (almost) almighty `org-element-map' allows to apply a function
3804 ;; on elements or objects matching some type, and accumulate the
3805 ;; resulting values. In an export situation, it also skips unneeded
3806 ;; parts of the parse tree.
3809 "Recursively parse the buffer and return structure.
3810 If narrowing is in effect, only parse the visible part of the
3811 buffer.
3813 Optional argument GRANULARITY determines the depth of the
3814 recursion. It can be set to the following symbols:
3816 `headline' Only parse headlines.
3817 `greater-element' Don't recurse into greater elements excepted
3818 headlines and sections. Thus, elements
3819 parsed are the top-level ones.
3820 `element' Parse everything but objects and plain text.
3821 `object' Parse the complete buffer (default).
3823 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3824 elements.
3826 An element or an objects is represented as a list with the
3827 pattern (TYPE PROPERTIES CONTENTS), where :
3829 TYPE is a symbol describing the element or object. See
3830 `org-element-all-elements' and `org-element-all-objects' for an
3831 exhaustive list of such symbols. One can retrieve it with
3832 `org-element-type' function.
3834 PROPERTIES is the list of attributes attached to the element or
3835 object, as a plist. Although most of them are specific to the
3836 element or object type, all types share `:begin', `:end',
3837 `:post-blank' and `:parent' properties, which respectively
3838 refer to buffer position where the element or object starts,
3839 ends, the number of white spaces or blank lines after it, and
3840 the element or object containing it. Properties values can be
3841 obtained by using `org-element-property' function.
3843 CONTENTS is a list of elements, objects or raw strings
3844 contained in the current element or object, when applicable.
3845 One can access them with `org-element-contents' function.
3847 The Org buffer has `org-data' as type and nil as properties.
3848 `org-element-map' function can be used to find specific elements
3849 or objects within the parse tree.
3851 This function assumes that current major mode is `org-mode'."
3857 ;; Start in `first-section' mode so text before the first
3858 ;; headline belongs to a section.
3862 "Recursively parse objects in STRING and return structure.
3864 RESTRICTION is a symbol limiting the object types that will be
3865 looked after.
3867 Optional argument PARENT, when non-nil, is the element or object
3868 containing the secondary string. It is used to set correctly
3869 `:parent' property within the string."
3882 secondary))))
3886 "Map a function on selected elements or objects.
3888 DATA is a parse tree, an element, an object, a string, or a list
3889 of such constructs. TYPES is a symbol or list of symbols of
3890 elements or objects types (see `org-element-all-elements' and
3891 `org-element-all-objects' for a complete list of types). FUN is
3892 the function called on the matching element or object. It has to
3893 accept one argument: the element or object itself.
3895 When optional argument INFO is non-nil, it should be a plist
3896 holding export options. In that case, parts of the parse tree
3897 not exportable according to that property list will be skipped.
3899 When optional argument FIRST-MATCH is non-nil, stop at the first
3900 match for which FUN doesn't return nil, and return that value.
3902 Optional argument NO-RECURSION is a symbol or a list of symbols
3903 representing elements or objects types. `org-element-map' won't
3904 enter any recursive element or object whose type belongs to that
3905 list. Though, FUN can still be applied on them.
3907 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3908 apply to matching objects within parsed affiliated keywords (see
3909 `org-element-parsed-keywords').
3911 Nil values returned from FUN do not appear in the results.
3914 Examples:
3915 ---------
3917 Assuming TREE is a variable containing an Org buffer parse tree,
3918 the following example will return a flat list of all `src-block'
3919 and `example-block' elements in it:
3921 \(org-element-map tree '(example-block src-block) 'identity)
3923 The following snippet will find the first headline with a level
3926 \(org-element-map tree 'headline
3927 \(lambda (hl)
3928 \(and (= (org-element-property :level hl) 1)
3930 \(org-element-property :begin hl)))
3931 nil t)
3933 The next example will return a flat list of all `plain-list' type
3934 elements in TREE that are not a sub-list themselves:
3936 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3938 Eventually, this example will return a flat list of all `bold'
3939 type objects containing a `latex-snippet' type object, even
3940 looking into captions:
3942 \(org-element-map tree 'bold
3943 \(lambda (b)
3944 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3945 nil nil nil t)"
3946 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3949 ;; Recursion depth is determined by --CATEGORY.
3956 ;; If one object is found, the function
3957 ;; has to recurse into every object.
3960 ;; If one regular element is found, the
3961 ;; function has to recurse, at least,
3962 ;; into every element it encounters.
3965 types)
3966 category)))
3967 ;; Compute properties for affiliated keywords if necessary.
3972 org-element-affiliated-keywords)))
3973 --acc
3974 --walk-tree
3978 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3979 ;; holding contextual information.
3983 ;; Ignored element in an export context.
3985 ;; List of elements or objects.
3987 ;; Unconditionally enter parse trees.
3991 ;; Check if TYPE is matching among TYPES. If so,
3992 ;; apply FUN to --DATA and accumulate return value
3993 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3999 ;; If --DATA has a secondary string that can contain
4000 ;; objects with their type among TYPES, look into it.
4007 ;; If --DATA has any affiliated keywords and
4008 ;; WITH-AFFILIATED is non-nil, look for objects in
4009 ;; them.
4017 ;; Pay attention to the type of value.
4018 ;; Preserve order for multiple keywords.
4034 --affiliated-alist))
4035 ;; Determine if a recursion into --DATA is possible.
4037 ;; --TYPE is explicitly removed from recursion.
4039 ;; --DATA has no contents.
4041 ;; Looking for greater elements but --DATA is simply
4042 ;; an element or an object.
4045 ;; Looking for elements but --DATA is an object.
4048 ;; In any other case, map contents.
4052 ;; Return value in a proper order.
4056 ;; The following functions are internal parts of the parser.
4057 ;;
4058 ;; The first one, `org-element--parse-elements' acts at the element's
4059 ;; level.
4060 ;;
4061 ;; The second one, `org-element--parse-objects' applies on all objects
4062 ;; of a paragraph or a secondary string.
4063 ;;
4064 ;; More precisely, that function looks for every allowed object type
4065 ;; first. Then, it discards failed searches, keeps further matches,
4066 ;; and searches again types matched behind point, for subsequent
4067 ;; calls. Thus, searching for a given type fails only once, and every
4068 ;; object is searched only once at top level (but sometimes more for
4069 ;; nested types).
4073 "Parse elements between BEG and END positions.
4075 SPECIAL prioritize some elements over the others. It can be set
4076 to `first-section', `section' `item' or `table-row'.
4078 When value is `item', STRUCTURE will be used as the current list
4079 structure.
4081 GRANULARITY determines the depth of the recursion. See
4082 `org-element-parse-buffer' for more information.
4084 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4085 elements.
4087 Elements are accumulated into ACC."
4090 ;; Visible only: skip invisible parts at the beginning of the
4091 ;; element.
4094 ;; When parsing only headlines, skip any text before first one.
4097 ;; Main loop start.
4099 ;; Find current element's type and parse it accordingly to
4100 ;; its category.
4102 end granularity special structure))
4106 ;; Visible only: skip invisible parts between siblings.
4109 ;; Fill ELEMENT contents by side-effect.
4111 ;; If element has no contents, don't modify it.
4113 ;; Greater element: parse it between `contents-begin' and
4114 ;; `contents-end'. Make sure GRANULARITY allows the
4115 ;; recursion, or ELEMENT is a headline, in which case going
4116 ;; inside is mandatory, in order to get sub-level headings.
4124 ;; Possibly switch to a special mode.
4132 granularity visible-only element))
4133 ;; ELEMENT has contents. Parse objects inside, if
4134 ;; GRANULARITY allows it.
4140 ;; Return result.
4141 acc))
4147 ;; Sub/superscript.
4149 ;; Bold, code, italic, strike-through, underline and
4150 ;; verbatim.
4153 ;; Plain links.
4155 ;; Objects starting with "[": regular link, footnote
4156 ;; reference, statistics cookie, timestamp (inactive).
4158 ;; Objects starting with "@": export snippets.
4159 "@@"
4160 ;; Objects starting with "{": macro.
4161 "{{{"
4162 ;; Objects starting with "<" : timestamp (active,
4163 ;; diary), target, radio target and angular links.
4165 ;; Objects starting with "$": latex fragment.
4167 ;; Objects starting with "\": line break, entity,
4168 ;; latex fragment.
4170 ;; Objects starting with raw text: inline Babel
4171 ;; source block, inline Babel call.
4174 "Regexp possibly matching the beginning of an object.
4175 This regexp allows false positives. Dedicated parser (e.g.,
4176 `org-export-bold-parser') will take care of further filtering.
4177 Radio links are not matched by this regexp, as they are treated
4181 "Return next object in current buffer or nil.
4182 RESTRICTION is a list of object types, as symbols, that should be
4183 looked after. This function assumes that the buffer is narrowed
4184 to an appropriate container (e.g., a paragraph)."
4192 found)
4257 ;; This is probably a plain link.
4263 ;; Radio link.
4268 "Parse objects between BEG and END and return recursive structure.
4270 Objects are accumulated in ACC.
4272 RESTRICTION is a list of object successors which are allowed in
4273 the current object."
4281 ;; 1. Text before any object. Untabify it.
4286 acc
4290 ;; 2. Object...
4293 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4294 ;; a recursive type.
4302 ;; 3. Text after last object. Untabify it.
4306 acc
4310 ;; Result.
4311 acc)))
4314 \f
4315 ;;; Towards A Bijective Process
4316 ;;
4317 ;; The parse tree obtained with `org-element-parse-buffer' is really
4318 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4319 ;; interpreted and expanded into a string with canonical Org syntax.
4320 ;; Hence `org-element-interpret-data'.
4321 ;;
4322 ;; The function relies internally on
4323 ;; `org-element--interpret-affiliated-keywords'.
4325 ;;;###autoload
4327 "Interpret DATA as Org syntax.
4329 DATA is a parse tree, an element, an object or a secondary string
4330 to interpret.
4332 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4333 new types that should be treated as objects. An unknown type not
4334 belonging to this list is seen as a pseudo-element instead. Both
4335 pseudo-objects and pseudo-elements are transparent entities, i.e.
4336 only their contents are interpreted.
4338 Return Org syntax as a string."
4342 "Interpret DATA as Org syntax.
4344 DATA is a parse tree, an element, an object or a secondary string
4345 to interpret. PARENT is used for recursive calls. It contains
4346 the element or object containing data, or nil. PSEUDO-OBJECTS
4347 are list of symbols defining new element or object types.
4348 Unknown types that don't belong to this list are treated as
4349 pseudo-elements instead.
4351 Return Org syntax as a string."
4353 ;; Find interpreter for current object or element. If it
4354 ;; doesn't exist (e.g. this is a pseudo object or element),
4355 ;; return contents, if any.
4361 ;; Secondary string.
4367 ;; Full Org document.
4373 ;; Plain text: return it.
4375 ;; Element or object without contents.
4377 ;; Element or object with contents.
4380 ;; Recursively interpret contents.
4386 data
4387 ;; Fix indentation of elements containing
4388 ;; objects. We ignore `table-row' elements
4389 ;; as they are one line long anyway.
4391 data
4392 ;; When normalizing first paragraph of an
4393 ;; item or a footnote-definition, ignore
4394 ;; first line's indentation.
4401 ;; Build white spaces. If no `:post-blank' property is
4402 ;; specified, assume its value is 0.
4413 "Return ELEMENT's affiliated keywords as Org syntax.
4414 If there is no affiliated keyword, return the empty string."
4424 ": "
4427 value)
4435 ;; All attribute keywords can have multiple lines.
4441 ;; List all ELEMENT's properties matching an attribute line or an
4442 ;; affiliated keyword, but ignore translated keywords since they
4443 ;; cannot belong to the property list.
4450 org-element-keyword-translation-alist)))))
4451 collect prop)
4454 ;; Because interpretation of the parse tree must return the same
4455 ;; number of blank lines between elements and the same number of white
4456 ;; space after objects, some special care must be given to white
4457 ;; spaces.
4458 ;;
4459 ;; The first function, `org-element-normalize-string', ensures any
4460 ;; string different from the empty string will end with a single
4461 ;; newline character.
4462 ;;
4463 ;; The second function, `org-element-normalize-contents', removes
4464 ;; global indentation from the contents of the current element.
4467 "Ensure string S ends with a single newline character.
4469 If S isn't a string return it unchanged. If S is the empty
4470 string, return it. Otherwise, return a new string with a single
4471 newline character at its end."
4479 "Normalize plain text in ELEMENT's contents.
4481 ELEMENT must only contain plain text and objects.
4483 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4484 indentation to compute maximal common indentation.
4486 Return the normalized element that is element with global
4487 indentation removed from its contents. The function assumes that
4488 indentation is not done with TAB characters."
4490 find-min-ind ; For byte-compiler.
4493 ;; Return minimal common indentation within BLOB. This is
4494 ;; done by walking recursively BLOB and updating MIN-IND
4495 ;; along the way. FIRST-FLAG is non-nil when the first
4496 ;; string hasn't been seen yet. It is required as this
4497 ;; string is the only one whose indentation doesn't happen
4498 ;; after a newline character.
4505 ;; An indentation of zero means no string will be
4506 ;; modified. Quit the process.
4515 ;; Find minimal indentation in ELEMENT.
4518 ;; Build ELEMENT back, replacing each string with the same
4519 ;; string minus common indentation.
4524 ;; Return BLOB with all its strings indentation
4525 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4526 ;; is non-nil when the first string hasn't been seen
4527 ;; yet.
4542 org-element-recursive-objects)
4546 blob))))
4550 \f
4551 ;;; Cache
4552 ;;
4553 ;; Implement a caching mechanism for `org-element-at-point' and
4554 ;; `org-element-context', which see.
4555 ;;
4556 ;; A single public function is provided: `org-element-cache-reset'.
4557 ;;
4558 ;; Cache is enabled by default, but can be disabled globally with
4559 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4560 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4561 ;; can be tweaked to control caching behaviour.
4562 ;;
4563 ;; Internally, parsed elements are stored in an AVL tree,
4564 ;; `org-element--cache'. This tree is updated lazily: whenever
4565 ;; a change happens to the buffer, a synchronization request is
4566 ;; registered in `org-element--cache-sync-requests' (see
4567 ;; `org-element--cache-submit-request'). During idle time, requests
4568 ;; are processed by `org-element--cache-sync'. Synchronization also
4569 ;; happens when an element is required from the cache. In this case,
4570 ;; the process stops as soon as the needed element is up-to-date.
4571 ;;
4572 ;; A synchronization request can only apply on a synchronized part of
4573 ;; the cache. Therefore, the cache is updated at least to the
4574 ;; location where the new request applies. Thus, requests are ordered
4575 ;; from left to right and all elements starting before the first
4576 ;; request are correct. This property is used by functions like
4577 ;; `org-element--cache-find' to retrieve elements in the part of the
4578 ;; cache that can be trusted.
4579 ;;
4580 ;; A request applies to every element, starting from its original
4581 ;; location (or key, see below). When a request is processed, it
4582 ;; moves forward and may collide the next one. In this case, both
4583 ;; requests are merged into a new one that starts from that element.
4584 ;; As a consequence, the whole synchronization complexity does not
4585 ;; depend on the number of pending requests, but on the number of
4586 ;; elements the very first request will be applied on.
4587 ;;
4588 ;; Elements cannot be accessed through their beginning position, which
4589 ;; may or may not be up-to-date. Instead, each element in the tree is
4590 ;; associated to a key, obtained with `org-element--cache-key'. This
4591 ;; mechanism is robust enough to preserve total order among elements
4592 ;; even when the tree is only partially synchronized.
4593 ;;
4594 ;; Objects contained in an element are stored in a hash table,
4595 ;; `org-element--cache-objects'.
4599 "Non nil when Org parser should cache its results.
4606 "Maximum duration, as a time value, for a cache synchronization.
4607 If the synchronization is not over after this delay, the process
4608 pauses and resumes after `org-element-cache-sync-break'
4612 "Duration, as a time value, of the pause between synchronizations.
4616 ;;;; Data Structure
4619 "AVL tree used to cache elements.
4620 Each node of the tree contains an element. Comparison is done
4621 with `org-element--cache-compare'. This cache is used in
4625 "Hash table used as to cache objects.
4626 Key is an element, as returned by `org-element-at-point', and
4627 value is an alist where each association is:
4629 \(PARENT COMPLETEP . OBJECTS)
4631 where PARENT is an element or object, COMPLETEP is a boolean,
4632 non-nil when all direct children of parent are already cached and
4633 OBJECTS is a list of such children, as objects, from farthest to
4634 closest.
4637 contained within a paragraph
4641 If the paragraph is completely parsed, OBJECTS-DATA will be
4643 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4644 \(BOLD-OBJECT t ENTITY-OBJECT))
4646 whereas in a partially parsed paragraph, it could be
4648 \((PARAGRAPH nil ENTITY-OBJECT))
4653 "List of pending synchronization requests.
4655 A request is a vector with the following pattern:
4657 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4659 Processing a synchronization request consists of three phases:
4661 0. Delete modified elements,
4662 1. Fill missing area in cache,
4663 2. Shift positions and re-parent elements after the changes.
4665 During phase 0, NEXT is the key of the first element to be
4666 removed, BEG and END is buffer position delimiting the
4667 modifications. Elements starting between them (inclusive) are
4668 removed and so are those contained within OUTREACH. PARENT, when
4669 non-nil, is the parent of the first element to be removed.
4671 During phase 1, NEXT is the key of the next known element in
4672 cache and BEG its beginning position. Parse buffer between that
4673 element and the one before it in order to determine the parent of
4674 the next element. Set PARENT to the element containing NEXT.
4676 During phase 2, NEXT is the key of the next element to shift in
4677 the parse tree. All elements starting from this one have their
4678 properties relatives to buffer positions shifted by integer
4679 OFFSET and, if they belong to element PARENT, are adopted by it.
4687 "Hash table used to store keys during synchronization.
4691 "Return a unique key for ELEMENT in cache tree.
4693 Keys are used to keep a total order among elements in the cache.
4694 Comparison is done with `org-element--cache-key-less-p'.
4696 When no synchronization is taking place, a key is simply the
4697 beginning position of the element, or that position plus one in
4698 the case of an first item (respectively row) in
4699 a list (respectively a table).
4701 During a synchronization, the key is the one the element had when
4702 the cache was synchronized for the last time. Elements added to
4703 cache during the synchronization get a new key generated with
4704 `org-element--cache-generate-key'.
4706 Such keys are stored in `org-element--cache-sync-keys'. The hash
4707 table is cleared once the synchronization is complete."
4710 ;; Increase beginning position of items (respectively
4711 ;; table rows) by one, so the first item can get
4712 ;; a different key from its parent list (respectively
4713 ;; table).
4716 begin)))
4719 key))))
4722 "Generate a key between LOWER and UPPER.
4724 LOWER and UPPER are integers or lists, possibly empty.
4726 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4727 a unique key, as an integer or a list of integers, according to
4728 the following rules:
4730 - LOWER and UPPER are compared level-wise until values differ.
4732 - If, at a given level, LOWER and UPPER differ from more than
4733 2, the new key shares all the levels above with LOWER and
4734 gets a new level. Its value is the mean between LOWER and
4735 UPPER:
4737 \(1 2) + (1 4) --> (1 3)
4739 - If LOWER has no value to compare with, it is assumed that its
4740 value is `most-negative-fixnum'. E.g.,
4742 \(1 1) + (1 1 2)
4744 is equivalent to
4746 \(1 1 m) + (1 1 2)
4748 where m is `most-negative-fixnum'. Likewise, if UPPER is
4749 short of levels, the current value is `most-positive-fixnum'.
4751 - If they differ from only one, the new key inherits from
4752 current LOWER level and fork it at the next level. E.g.,
4754 \(2 1) + (3 3)
4756 is equivalent to
4758 \(2 1) + (2 M)
4760 where M is `most-positive-fixnum'.
4762 - If the key is only one level long, it is returned as an
4763 integer:
4765 \(1 2) + (3 2) --> 2
4767 When they are not equals, the function assumes that LOWER is
4768 lesser than UPPER, per `org-element--cache-key-less-p'."
4772 skip-upper key)
4783 ;; When at a given level, LOWER and UPPER differ from
4784 ;; 1, ignore UPPER altogether. Instead create a key
4785 ;; between LOWER and the greatest key with the same
4786 ;; prefix as LOWER so far.
4792 "Non-nil if key A is less than key B.
4793 A and B are either integers or lists of integers, as returned by
4794 `org-element--cache-key'."
4802 ;; If A is empty, either keys are equal (B is also empty) and
4803 ;; we return nil, or A is lesser than B (B is longer) and we
4804 ;; return a non-nil value.
4805 ;;
4806 ;; If A is not empty, B is necessarily empty and A is greater
4807 ;; than B (A is longer). Therefore, return nil.
4811 "Non-nil when element A is located before element B."
4816 "Return root value in cache.
4817 This function assumes `org-element--cache' is a valid AVL tree."
4821 ;;;; Tools
4824 "Non-nil when cache is active in current buffer."
4829 "Find element in cache starting at POS or before.
4831 POS refers to a buffer position.
4833 When optional argument SIDE is non-nil, the function checks for
4834 elements starting at or past POS instead. If SIDE is `both', the
4835 function returns a cons cell where car is the first element
4836 starting at or before POS and cdr the first element starting
4837 after POS.
4839 The function can only find elements in the synchronized part of
4840 the cache."
4844 lower upper)
4859 ;; We found an element in cache starting at POS. If `side'
4860 ;; is `both' we also want the next one in order to generate
4861 ;; a key in-between.
4862 ;;
4863 ;; If the element is the first row or item in a table or
4864 ;; a plain list, we always return the table or the plain
4865 ;; list.
4866 ;;
4867 ;; In any other case, we return the element found.
4876 lower parent
4877 upper parent)))))
4880 lower element
4881 upper element)))))
4888 "Store ELEMENT in current buffer's cache, if allowed.
4889 When optional argument DATA is non-nil, assume is it object data
4890 relative to ELEMENT and store it in the objects cache."
4894 ;; During synchronization, first build an appropriate key
4895 ;; for the new element so `avl-tree-enter' can insert it at
4896 ;; the right spot in the cache.
4905 org-element--cache-sync-keys)))
4907 ;; Headlines are not stored in cache, so objects in titles are
4908 ;; not stored either.
4913 "Remove ELEMENT from cache.
4914 Assume ELEMENT belongs to cache and that a cache is active."
4919 ;;;; Synchronization
4922 "Set idle timer for cache synchronization in BUFFER."
4929 org-element-cache-sync-idle-time))
4930 nil
4931 #'org-element--cache-sync
4932 buffer)))
4935 "Non-nil when synchronization process should be interrupted.
4936 TIME-LIMIT is a time value or nil."
4942 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4944 Properties containing buffer positions are `:begin', `:end',
4945 `:contents-begin', `:contents-end' and `:structure'. When
4946 optional argument PROPS is a list of keywords, only shift
4947 properties provided in that list.
4949 Properties are modified by side-effect."
4951 ;; Shift `:structure' property for the first plain list only: it
4952 ;; is the only one that really matters and it prevents from
4953 ;; shifting it more than once.
4967 "Synchronize cache with recent modification in BUFFER.
4969 When optional argument THRESHOLD is non-nil, do the
4970 synchronization for all elements starting before or at threshold,
4971 then exit. Otherwise, synchronize cache for as long as
4972 `org-element-cache-sync-duration' or until Emacs leaves idle
4973 state.
4975 FUTURE-CHANGE, when non-nil, is a buffer position where changes
4976 not registered yet in the cache are going to happen. It is used
4977 in `org-element--cache-submit-request', where cache is partially
4978 updated before current modification are actually submitted."
4989 request
4991 threshold
4994 org-element-cache-sync-duration))
4995 future-change)
4996 ;; Request processed. Merge current and next offsets and
4997 ;; transfer ending position.
5003 ;; If more requests are awaiting, set idle timer accordingly.
5004 ;; Otherwise, reset keys.
5011 "Process synchronization REQUEST for all entries before NEXT.
5013 REQUEST is a vector, built by `org-element--cache-submit-request'.
5015 NEXT is a cache key, as returned by `org-element--cache-key'.
5017 When non-nil, THRESHOLD is a buffer position. Synchronization
5018 stops as soon as a shifted element begins after it.
5020 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5021 after this time or when Emacs exits idle state.
5023 When non-nil, FUTURE-CHANGE is a buffer position where changes
5024 not registered yet in the cache are going to happen. See
5025 `org-element--cache-submit-request' for more information.
5027 Throw `interrupt' if the process stops before completing the
5028 request."
5031 ;; Phase 0.
5032 ;;
5033 ;; Delete all elements starting after BEG, but not after buffer
5034 ;; position END or past element with key NEXT.
5035 ;;
5036 ;; At each iteration, we start again at tree root since
5037 ;; a deletion modifies structure of the balanced tree.
5045 ;; Find first element in cache with key BEG or after it.
5055 data-key key
5058 data-key key
5059 node nil)))))
5068 up))
5074 ;; No element starting after modifications left in
5075 ;; cache: further processing is futile.
5078 ;; Phase 1.
5079 ;;
5080 ;; Phase 0 left a hole in the cache. Some elements after it
5081 ;; could have parents within. For example, in the following
5082 ;; buffer:
5083 ;;
5084 ;; - item
5085 ;;
5086 ;;
5087 ;; Paragraph1
5088 ;;
5089 ;; Paragraph2
5090 ;;
5091 ;; if we remove a blank line between "item" and "Paragraph1",
5092 ;; everything down to "Paragraph2" is removed from cache. But
5093 ;; the paragraph now belongs to the list, and its `:parent'
5094 ;; property no longer is accurate.
5095 ;;
5096 ;; Therefore we need to parse again elements in the hole, or at
5097 ;; least in its last section, so that we can re-parent
5098 ;; subsequent elements, during phase 2.
5099 ;;
5100 ;; Note that we only need to get the parent from the first
5101 ;; element in cache after the hole.
5102 ;;
5103 ;; When next key is lesser or equal to the current one, delegate
5104 ;; phase 1 processing to next request in order to preserve key
5105 ;; order among requests.
5113 ;; Next element will start at its beginning position plus
5114 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5115 ;; contains the real beginning position of the first element to
5116 ;; shift and re-parent.
5120 ;; Changes are going to happen around this element and
5121 ;; they will trigger another phase 1 request. Skip the
5122 ;; current one.
5128 ;; Phase 2.
5129 ;;
5130 ;; Shift all elements starting from key START, but before NEXT, by
5131 ;; OFFSET, and re-parent them when appropriate.
5132 ;;
5133 ;; Elements are modified by side-effect so the tree structure
5134 ;; remains intact.
5135 ;;
5136 ;; Once THRESHOLD, if any, is reached, or once there is an input
5137 ;; pending, exit. Before leaving, the current synchronization
5138 ;; request is updated.
5145 exit-flag)
5146 ;; No re-parenting nor shifting planned: request is over.
5156 ;; We reached NEXT. Request is complete.
5158 ;; Handle interruption request. Update current request.
5163 ;; Shift element.
5166 ;; Shift associated objects data, if any.
5171 ;; Update PARENT and re-parent DATA, only when
5172 ;; necessary. Propagate new structures for lists.
5186 ;; Cache is up-to-date past THRESHOLD. Request
5187 ;; interruption.
5192 ;; We reached end of tree: synchronization complete.
5193 t)))
5196 "Parse elements in current section, down to POS.
5198 Start parsing from the closest between the last known element in
5199 cache or headline above. Return the smallest element containing
5200 POS.
5202 When optional argument SYNCP is non-nil, return the parent of the
5203 element containing POS instead. In that case, it is also
5204 possible to provide TIME-LIMIT, which is a time value specifying
5205 when the parsing should stop. The function throws `interrupt' if
5206 the process stopped before finding the expected result."
5213 element next)
5215 ;; Nothing in cache before point: start parsing from first
5216 ;; element following headline above, or first element in
5217 ;; buffer.
5223 ;; Cache returned exact match: return it.
5226 ;; There's a headline between cached value and POS: cached
5227 ;; value is invalid. Start parsing from first element
5228 ;; following the headline.
5234 ;; Check if CACHED or any of its ancestors contain point.
5235 ;;
5236 ;; If there is such an element, we inspect it in order to know
5237 ;; if we return it or if we need to parse its contents.
5238 ;; Otherwise, we just start parsing from current location,
5239 ;; which is right after the top-most element containing
5240 ;; CACHED.
5241 ;;
5242 ;; As a special case, if POS is at the end of the buffer, we
5243 ;; want to return the innermost element ending there.
5244 ;;
5245 ;; Also, if we find an ancestor and discover that we need to
5246 ;; parse its contents, make sure we don't start from
5247 ;; `:contents-begin', as we would otherwise go past CACHED
5248 ;; again. Instead, in that situation, we will resume parsing
5249 ;; from NEXT, which is located after CACHED or its higher
5250 ;; ancestor not containing point.
5262 ;; Parse successively each element until we reach POS.
5268 special-flag)
5276 end 'element special-flag
5283 ;; Skip any element ending before point. Also skip
5284 ;; element ending at point (unless it is also the end of
5285 ;; buffer) since we're sure that another element begins
5286 ;; after it.
5289 ;; A non-greater element contains point: return it.
5292 ;; Otherwise, we have to decide if ELEMENT really
5293 ;; contains POS. In that case we start parsing from
5294 ;; contents' beginning.
5295 ;;
5296 ;; If POS is at contents' beginning but it is also at
5297 ;; the beginning of the first item in a list or a table.
5298 ;; In that case, we need to create an anchor for that
5299 ;; list or table, so return it.
5300 ;;
5301 ;; Also, if POS is at the end of the buffer, no element
5302 ;; can start after it, but more than one may end there.
5303 ;; Arbitrarily, we choose to return the innermost of
5304 ;; such elements.
5320 parent element
5321 end cend))))
5322 ;; Otherwise, return ELEMENT as it is the smallest
5323 ;; element containing POS.
5328 ;;;; Staging Buffer Changes
5334 ;; Blocks
5336 ;; LaTeX environments.
5338 ;; Drawers.
5341 "Regexp matching a sensitive line, structure wise.
5342 A sensitive line is a headline, inlinetask, block, drawer, or
5343 latex-environment boundary. When such a line is modified,
5344 structure changes in the document may propagate in the whole
5348 "Non-nil when a sensitive line is about to be changed.
5352 "Request extension of area going to be modified if needed.
5353 BEG and END are the beginning and end of the range of changed
5354 text. See `before-change-functions' for more information."
5364 'headline
5367 org-element--cache-sensitive-re bottom t)))))))))
5370 "Update buffer modifications for current buffer.
5371 BEG and END are the beginning and end of the range of changed
5372 text, and the length in bytes of the pre-change text replaced by
5373 that range. See `after-change-functions' for more information."
5381 ;; Determine if modified area needs to be extended, according
5382 ;; to both previous and current state. We make a special
5383 ;; case for headline editing: if a headline is modified but
5384 ;; not removed, do not extend.
5393 org-element--cache-sensitive-re bottom t))))
5394 ;; Effectively extend modified area.
5402 ;; Store synchronization request.
5405 ;; Activate a timer to process the request during idle time.
5409 "Return first element to remove from cache.
5411 BEG and END are buffer positions delimiting buffer modifications.
5412 OFFSET is the size of the changes.
5414 Returned element is usually the first element in cache containing
5415 any position between BEG and END. As an exception, greater
5416 elements around the changes that are robust to contents
5417 modifications are preserved and updated according to the
5418 changes."
5428 property-drawer quote-block
5429 special-block))
5432 ;; UP is a robust greater element containing changes.
5433 ;; We only need to extend its ending boundaries.
5439 ;; We're at top level element containing ELEMENT: if it's
5440 ;; altered by buffer modifications, it is first element in
5441 ;; cache to be removed. Otherwise, that first element is the
5442 ;; following one.
5443 ;;
5444 ;; As a special case, do not remove BEFORE if it is a robust
5445 ;; container for current changes.
5447 before)))))
5450 "Submit a new cache synchronization request for current buffer.
5451 BEG and END are buffer positions delimiting the minimal area
5452 where cache data should be removed. OFFSET is the size of the
5453 change, as an integer."
5455 delete-to delete-from)
5460 ;; Current changes can be merged with first sync request: we
5461 ;; can save a partial cache synchronization.
5464 ;; If last change happened within area to be removed, extend
5465 ;; boundaries of robust parents, if any. Otherwise, find
5466 ;; first element to remove and update request accordingly.
5478 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5479 ;; if any, is no longer a 0-phase request, thus ensuring that
5480 ;; phases are properly ordered. We need to provide OFFSET as
5481 ;; optional parameter since current modifications are not known
5482 ;; yet to the otherwise correct part of the cache (i.e, before
5483 ;; the first request).
5490 ;; When changes happen before the first known
5491 ;; element, re-parent and shift the rest of the
5492 ;; cache.
5494 ;; Otherwise, we find the first non robust
5495 ;; element containing END. All elements between
5496 ;; FIRST and this one are to be removed.
5497 ;;
5498 ;; Among them, some could be located outside the
5499 ;; synchronized part of the cache, in which case
5500 ;; comparing buffer positions to find them is
5501 ;; useless. Instead, we store the element
5502 ;; containing them in the request itself. All
5503 ;; its children will be removed.
5515 element up))
5518 org-element--cache-sync-requests)
5519 ;; No element to remove. No need to re-parent either.
5520 ;; Simply shift additional elements, if any, by OFFSET.
5525 ;;;; Public Functions
5527 ;;;###autoload
5529 "Reset cache in current buffer.
5530 When optional argument ALL is non-nil, reset cache in all Org
5531 buffers."
5549 ;;;###autoload
5551 "Refresh cache at position POS."
5558 \f
5559 ;;; The Toolbox
5560 ;;
5561 ;; The first move is to implement a way to obtain the smallest element
5562 ;; containing point. This is the job of `org-element-at-point'. It
5563 ;; basically jumps back to the beginning of section containing point
5564 ;; and proceed, one element after the other, with
5565 ;; `org-element--current-element' until the container is found. Note:
5566 ;; When using `org-element-at-point', secondary values are never
5567 ;; parsed since the function focuses on elements, not on objects.
5568 ;;
5569 ;; At a deeper level, `org-element-context' lists all elements and
5570 ;; objects containing point.
5571 ;;
5572 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5573 ;; internally by navigation and manipulation tools.
5576 ;;;###autoload
5578 "Determine closest element around point.
5580 Return value is a list like (TYPE PROPS) where TYPE is the type
5581 of the element and PROPS a plist of properties associated to the
5582 element.
5584 Possible types are defined in `org-element-all-elements'.
5585 Properties depend on element or object type, but always include
5586 `:begin', `:end', `:parent' and `:post-blank' properties.
5588 As a special case, if point is at the very beginning of the first
5589 item in a list or sub-list, returned element will be that list
5590 instead of the item. Likewise, if point is at the beginning of
5591 the first row of a table, returned element will be the table
5592 instead of the first row.
5594 When point is at the end of the buffer, return the innermost
5595 element ending there."
5601 ;; Within blank lines at the beginning of buffer, return nil.
5603 ;; Within blank lines right after a headline, return that
5604 ;; headline.
5608 ;; Otherwise parse until we find element containing ORIGIN.
5615 ;;;###autoload
5617 "Return smallest element or object around point.
5619 Return value is a list like (TYPE PROPS) where TYPE is the type
5620 of the element or object and PROPS a plist of properties
5621 associated to it.
5623 Possible types are defined in `org-element-all-elements' and
5624 `org-element-all-objects'. Properties depend on element or
5625 object type, but always include `:begin', `:end', `:parent' and
5626 `:post-blank'.
5628 As a special case, if point is right after an object and not at
5629 the beginning of any other object, return that object.
5631 Optional argument ELEMENT, when non-nil, is the closest element
5632 containing point, as returned by `org-element-at-point'.
5633 Providing it allows for quicker computation."
5639 ;; If point is inside an element containing objects or
5640 ;; a secondary string, narrow buffer to the container and
5641 ;; proceed with parsing. Otherwise, return ELEMENT.
5643 ;; At a parsed affiliated keyword, check if we're inside main
5644 ;; or dual value.
5651 org-element-parsed-keywords))
5660 ;; Also change type to retrieve correct restrictions.
5662 ;; At an item, objects can only be located within tag, if any.
5672 ;; At an headline or inlinetask, objects are in title.
5679 ;; At a paragraph, a table-row or a verse block, objects are
5680 ;; located within their contents.
5684 ;; CBEG is nil for table rules.
5689 ;; At a parsed keyword, objects are located within value.
5692 org-element-document-properties))
5699 ;; At a planning line, if point is at a timestamp, return it,
5700 ;; otherwise, return element.
5708 ;; All other locations cannot contain objects: bail out.
5718 next object-data last)
5722 ;; When entering PARENT for the first time, get list
5723 ;; of objects within known so far. Store it in
5724 ;; OBJECT-DATA.
5729 ;; Find NEXT object for analysis.
5731 ;; If NEXT is non-nil, we already exhausted the
5732 ;; cache so we can parse buffer to find the object
5733 ;; after it.
5735 ;; Otherwise, check if cache can help us.
5746 ;; Cache contains the information needed.
5749 pos)
5751 pos)
5757 ;; If we have a new object to analyze, store it in
5758 ;; cache. Otherwise record that there is nothing
5759 ;; more to parse in this element at this depth.
5764 ;; Process NEXT, if any, in order to know if we need
5765 ;; to skip it, return it or move into it.
5772 ;; Skip objects ending before point. Also skip
5773 ;; objects ending at point unless it is also the
5774 ;; end of buffer, since we want to return the
5775 ;; innermost object.
5778 ;; For convenience, when object ends at POS,
5779 ;; without any space, store it in LAST, as we
5780 ;; will return it if no object starts here.
5784 ;; If POS is within a container object, move
5785 ;; into that object.
5789 ;; At contents' end, if there is no
5790 ;; space before point, also move into
5791 ;; object, for consistency with
5792 ;; convenience feature above.
5801 next nil
5802 object-data nil))
5803 ;; Otherwise, return NEXT.
5805 ;; Store results in cache, if applicable.
5809 "Non-nil when elements ELEM-A and ELEM-B are nested."
5818 "Swap elements ELEM-A and ELEM-B.
5819 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5820 end of ELEM-A."
5822 ;; There are two special cases when an element doesn't start at bol:
5823 ;; the first paragraph in an item or in a footnote definition.
5825 ;; Only a paragraph without any affiliated keyword can be moved at
5826 ;; ELEM-A position in such a situation. Note that the case of
5827 ;; a footnote definition is impossible: it cannot contain two
5828 ;; paragraphs in a row because it cannot contain a blank line.
5834 ;; In a special situation, ELEM-A will have no indentation. We'll
5835 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5849 ;; Store overlays responsible for visibility status. We
5850 ;; also need to store their boundaries as they will be
5851 ;; removed from buffer.
5858 ;; Get contents.
5866 ;; Restore ex ELEM-A overlays.
5875 ;; Restore ex ELEM-B overlays.
5883 "Remove maximum common indentation in string S and return it.
5884 When optional argument N is a positive integer, remove exactly
5885 that much characters from indentation, if possible, or return
5886 S as-is otherwise. Unlike to `org-remove-indentation', this
5887 function doesn't call `untabify' on S."
5892 ;; Find maximum common indentation, if not specified.
5900 min-ind)))
5902 ;; Remove exactly N indentation, but give up if not possible.
5915 ;; Local variables:
5916 ;; generated-autoload-file: "org-loaddefs.el"
5917 ;; End:
5919 ;;; org-element.el ends here