| blob | 352482ef825fa495fd4e0daa7f6f236a442d2b01 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `section' and `table-row' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
45 ;; and `special-block'.
46 ;;
47 ;; Other element types are: `babel-call', `clock', `comment',
48 ;; `comment-block', `diary-sexp', `example-block', `export-block',
49 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
50 ;; `node-property', `paragraph', `planning', `src-block', `table',
51 ;; `table-row' and `verse-block'. Among them, `paragraph' and
52 ;; `verse-block' types can contain Org objects and plain text.
53 ;;
54 ;; Objects are related to document's contents. Some of them are
55 ;; recursive. Associated types are of the following: `bold', `code',
56 ;; `entity', `export-snippet', `footnote-reference',
57 ;; `inline-babel-call', `inline-src-block', `italic',
58 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
59 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
60 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;;
62 ;; Some elements also have special properties whose value can hold
63 ;; objects themselves (e.g. an item tag or a headline name). Such
64 ;; values are called "secondary strings". Any object belongs to
65 ;; either an element or a secondary string.
66 ;;
67 ;; Notwithstanding affiliated keywords, each greater element, element
68 ;; and object has a fixed set of properties attached to it. Among
69 ;; them, four are shared by all types: `:begin' and `:end', which
70 ;; refer to the beginning and ending buffer positions of the
71 ;; considered element or object, `:post-blank', which holds the number
72 ;; of blank lines, or white spaces, at its end and `:parent' which
73 ;; refers to the element or object containing it. Greater elements,
74 ;; elements and objects containing objects will also have
75 ;; `:contents-begin' and `:contents-end' properties to delimit
76 ;; contents. Eventually, 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 export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block section
180 special-block 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 "List of buffer-local variables used when parsing objects.
349 These variables are copied to the temporary buffer created by
353 \f
354 ;;; Accessors and Setters
355 ;;
356 ;; Provide four accessors: `org-element-type', `org-element-property'
357 ;; `org-element-contents' and `org-element-restriction'.
358 ;;
359 ;; Setter functions allow to modify elements by side effect. There is
360 ;; `org-element-put-property', `org-element-set-contents'. These
361 ;; low-level functions are useful to build a parse tree.
362 ;;
363 ;; `org-element-adopt-element', `org-element-set-element',
364 ;; `org-element-extract-element' and `org-element-insert-before' are
365 ;; high-level functions useful to modify a parse tree.
366 ;;
367 ;; `org-element-secondary-p' is a predicate used to know if a given
368 ;; object belongs to a secondary string.
371 "Return type of ELEMENT.
373 The function returns the type of the element or object provided.
374 It can also return the following special value:
375 `plain-text' for a string
376 `org-data' for a complete document
377 nil in any other case."
383 "Extract the value from the PROPERTY of an ELEMENT."
388 "Extract contents from an ELEMENT."
394 "Return restriction associated to ELEMENT.
395 ELEMENT can be an element, an object or a symbol representing an
396 element or object type."
398 org-element-object-restrictions)))
401 "In ELEMENT set PROPERTY to VALUE.
402 Return modified element."
405 element))
408 "Set ELEMENT contents to CONTENTS.
409 Return modified element."
416 "Non-nil when OBJECT belongs to a secondary string.
417 Return value is the property name, as a keyword, or nil."
420 org-element-secondary-value-alist))))
423 property)))
426 "Append elements to the contents of another element.
428 PARENT is an element or object. CHILDREN can be elements,
429 objects, or a strings.
431 The function takes care of setting `:parent' property for CHILD.
432 Return parent element."
433 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
434 ;; string: parent is the list itself.
437 children)
438 ;; Add CHILDREN at the end of PARENT contents.
441 parent
443 ;; Return modified PARENT element.
447 "Extract ELEMENT from parse tree.
448 Remove element from the parse tree by side-effect, and return it
449 with its `:parent' property stripped out."
454 parent secondary
457 parent
459 ;; Return ELEMENT with its :parent removed.
463 "Insert ELEMENT before LOCATION in parse tree.
464 LOCATION is an element, object or string within the parse tree.
465 Parse tree is modified by side effect."
470 ;; Special case: LOCATION is the first element of an
471 ;; independent secondary string (e.g. :title property). Add
472 ;; ELEMENT in-place.
476 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
486 ;; Store SIBLINGS at appropriate place in parse tree.
491 ;; Set appropriate :parent property.
495 "Replace element or object OLD with element or object NEW.
496 The function takes care of setting `:parent' property for NEW."
497 ;; Ensure OLD and NEW have the same parent.
501 ;; We cannot replace OLD with NEW since one of them is not an
502 ;; object or element. We take the long path.
505 ;; Since OLD is going to be changed into NEW by side-effect, first
506 ;; make sure that every element or object within NEW has OLD as
507 ;; parent.
510 ;; Transfer contents.
512 ;; Overwrite OLD's properties with NEW's.
514 ;; Transfer type.
518 \f
519 ;;; Greater elements
520 ;;
521 ;; For each greater element type, we define a parser and an
522 ;; interpreter.
523 ;;
524 ;; A parser returns the element or object as the list described above.
525 ;; Most of them accepts no argument. Though, exceptions exist. Hence
526 ;; every element containing a secondary string (see
527 ;; `org-element-secondary-value-alist') will accept an optional
528 ;; argument to toggle parsing of that secondary string. Moreover,
529 ;; `item' parser requires current list's structure as its first
530 ;; element.
531 ;;
532 ;; An interpreter accepts two arguments: the list representation of
533 ;; the element or object, and its contents. The latter may be nil,
534 ;; depending on the element or object considered. It returns the
535 ;; appropriate Org syntax, as a string.
536 ;;
537 ;; Parsing functions must follow the naming convention:
538 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
539 ;; defined in `org-element-greater-elements'.
540 ;;
541 ;; Similarly, interpreting functions must follow the naming
542 ;; convention: org-element-TYPE-interpreter.
543 ;;
544 ;; With the exception of `headline' and `item' types, greater elements
545 ;; cannot contain other greater elements of their own type.
546 ;;
547 ;; Beside implementing a parser and an interpreter, adding a new
548 ;; greater element requires to tweak `org-element--current-element'.
549 ;; Moreover, the newly defined type must be added to both
550 ;; `org-element-all-elements' and `org-element-greater-elements'.
553 ;;;; Center Block
556 "Parse a center block.
558 LIMIT bounds the search. AFFILIATED is a list of which CAR is
559 the buffer position at the beginning of the first affiliated
560 keyword and CDR is a plist of affiliated keywords along with
561 their value.
563 Return a list whose CAR is `center-block' and CDR is a plist
564 containing `:begin', `:end', `:contents-begin', `:contents-end',
565 `:post-blank' and `:post-affiliated' keywords.
567 Assume point is at the beginning of the block."
571 ;; Incomplete block: parse it as a paragraph.
576 ;; Empty blocks have no contents.
590 :end end
591 :contents-begin contents-begin
592 :contents-end contents-end
598 "Interpret CENTER-BLOCK element as Org syntax.
599 CONTENTS is the contents of the element."
603 ;;;; Drawer
606 "Parse a drawer.
608 LIMIT bounds the search. AFFILIATED is a list of which CAR is
609 the buffer position at the beginning of the first affiliated
610 keyword and CDR is a plist of affiliated keywords along with
611 their value.
613 Return a list whose CAR is `drawer' and CDR is a plist containing
614 `:drawer-name', `:begin', `:end', `:contents-begin',
615 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
617 Assume point is at beginning of drawer."
620 ;; Incomplete drawer: parse it as a paragraph.
628 ;; Empty drawers have no contents.
641 :end end
642 :drawer-name name
643 :contents-begin contents-begin
644 :contents-end contents-end
650 "Interpret DRAWER element as Org syntax.
651 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Dynamic Block
660 "Parse a dynamic block.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `dynamic-block' and CDR is a plist
668 containing `:block-name', `:begin', `:end', `:contents-begin',
669 `:contents-end', `:arguments', `:post-blank' and
670 `:post-affiliated' keywords.
672 Assume point is at beginning of dynamic block."
676 ;; Incomplete block: parse it as a paragraph.
685 ;; Empty blocks have no contents.
698 :end end
699 :block-name name
700 :arguments arguments
701 :contents-begin contents-begin
702 :contents-end contents-end
708 "Interpret DYNAMIC-BLOCK element as Org syntax.
709 CONTENTS is the contents of the element."
714 contents))
717 ;;;; Footnote Definition
720 "Parse a footnote definition.
722 LIMIT bounds the search. AFFILIATED is a list of which CAR is
723 the buffer position at the beginning of the first affiliated
724 keyword and CDR is a plist of affiliated keywords along with
725 their value.
727 Return a list whose CAR is `footnote-definition' and CDR is
728 a plist containing `:label', `:begin' `:end', `:contents-begin',
729 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
731 Assume point is at the beginning of the footnote definition."
759 :begin begin
760 :end end
761 :contents-begin contents-begin
762 :contents-end contents-end
768 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
769 CONTENTS is the contents of the footnote-definition."
771 " "
772 contents))
775 ;;;; Headline
778 "Parse a headline.
780 Return a list whose CAR is `headline' and CDR is a plist
781 containing `:raw-value', `:title', `:alt-title', `:begin',
782 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
783 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
784 `:scheduled', `:deadline', `:closed', `:archivedp', `:commentedp'
785 and `:footnote-section-p' keywords.
787 The plist also contains any property set in the property drawer,
788 with its name in upper cases and colons added at the
789 beginning (e.g., `:CUSTOM_ID').
791 LIMIT is a buffer position bounding the search.
793 When RAW-SECONDARY-P is non-nil, headline's title will not be
794 parsed as a secondary string, but as a plain string instead.
796 Assume point is at beginning of the headline."
809 raw-value)))
814 ;; Find property drawer associated to current headline and
815 ;; extract properties.
816 ;;
817 ;; Upcase property names. It avoids confusion between
818 ;; properties obtained through property drawer and default
819 ;; properties from the parser (e.g. `:end' and :END:)
823 plist)
829 ;; Make sure drawer is not associated
830 ;; to an inlinetask.
844 plist
849 plist)))
851 ;; Read time properties on the line below the headline.
857 org-keyword-time-not-clock-regexp end t)
867 plist))))
879 ;; Clean RAW-VALUE from any comment string.
885 ""
886 raw-value))))
887 ;; Clean TAGS from archive tag, if any.
893 :begin begin
894 :end end
895 :pre-blank
898 :contents-begin contents-begin
899 :contents-end contents-end
900 :level level
902 :tags tags
903 :todo-keyword todo
904 :todo-type todo-type
907 end)
908 :footnote-section-p footnote-section-p
909 :archivedp archivedp
911 time-props
912 standard-props))))
916 headline :alt-title
921 headline :title
927 "Interpret HEADLINE element as Org syntax.
928 CONTENTS is the contents of the element."
953 ;; Align tags.
961 ? )
962 tags))
966 tags))))
968 contents)))
971 ;;;; Inlinetask
974 "Parse an inline task.
976 Return a list whose CAR is `inlinetask' and CDR is a plist
977 containing `:title', `:begin', `:end', `:contents-begin' and
978 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
979 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
980 `:closed' and `:post-blank' keywords.
982 The plist also contains any property set in the property drawer,
983 with its name in upper cases and colons added at the
984 beginning (e.g., `:CUSTOM_ID').
986 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
987 title will not be parsed as a secondary string, but as a plain
988 string instead.
990 Assume point is at beginning of the inline task."
1006 ;; Read time properties on the line below the inlinetask
1007 ;; opening string.
1014 org-keyword-time-not-clock-regexp end t)
1024 plist)))))
1035 ;; Find property drawer associated to current inlinetask
1036 ;; and extract properties.
1037 ;;
1038 ;; HACK: Calling `org-element-at-point' triggers a parsing
1039 ;; of this inlinetask and, thus, an infloop. To avoid the
1040 ;; problem, we extract contents of the inlinetask and
1041 ;; parse them in a new buffer.
1042 ;;
1043 ;; Upcase property names. It avoids confusion between
1044 ;; properties obtained through property drawer and default
1045 ;; properties from the parser (e.g. `:end' and :END:)
1048 plist)
1055 org-property-start-re task-end t))
1065 plist
1070 plist)))
1075 :begin begin
1076 :end end
1077 :contents-begin contents-begin
1078 :contents-end contents-end
1081 :tags tags
1082 :todo-keyword todo
1083 :todo-type todo-type
1085 time-props
1086 standard-props))))
1088 inlinetask :title
1091 raw-value
1093 inlinetask))))))
1096 "Interpret INLINETASK element as Org syntax.
1097 CONTENTS is the contents of inlinetask."
1112 ;; Align tags.
1120 ? )
1121 tags))
1125 tags))))
1126 ;; Prefer degenerate inlinetasks when there are no
1127 ;; contents.
1130 contents
1134 ;;;; Item
1137 "Parse an item.
1139 STRUCT is the structure of the plain list.
1141 Return a list whose CAR is `item' and CDR is a plist containing
1142 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1143 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1144 keywords.
1146 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1147 any, will not be parsed as a secondary string, but as a plain
1148 string instead.
1150 Assume point is at the beginning of the item."
1174 ;; Ignore tags in un-ordered lists: they are just
1175 ;; a part of item's body.
1181 ;; If first line isn't empty, contents really start
1182 ;; at the text after item's meta-data.
1191 :begin begin
1192 :end end
1193 ;; CONTENTS-BEGIN and CONTENTS-END may be
1194 ;; mixed up in the case of an empty item
1195 ;; separated from the next by a blank line.
1196 ;; Thus ensure the former is always the
1197 ;; smallest.
1200 :checkbox checkbox
1201 :counter counter
1202 :structure struct
1205 item :tag
1213 "Interpret ITEM element as Org syntax.
1214 CONTENTS is the contents of the element."
1224 ;; Compute indentation.
1229 ;; Indent contents.
1231 bullet
1245 ;;;; Plain List
1248 ;; Return structure of list at point. Internal function. See
1249 ;; `org-list-struct' for details.
1254 items struct)
1259 ;; At limit: end all items.
1268 ;; At list end: end all items.
1273 ;; At a new item: end previous sibling.
1285 ind
1286 bullet
1289 ;; Description tag.
1293 ;; Ending position, unknown so far.
1294 nil)))
1295 items))
1297 ;; Skip empty lines.
1299 ;; Skip inline tasks and blank lines along the way.
1306 ;; At some text line. Check if it ends any previous item.
1318 ;; Skip blocks (any type) and drawers contents.
1323 limit t)))
1329 "Parse a plain list.
1331 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1332 the buffer position at the beginning of the first affiliated
1333 keyword and CDR is a plist of affiliated keywords along with
1334 their value. STRUCTURE is the structure of the plain list being
1335 parsed.
1337 Return a list whose CAR is `plain-list' and CDR is a plist
1338 containing `:type', `:begin', `:end', `:contents-begin' and
1339 `:contents-end', `:structure', `:post-blank' and
1340 `:post-affiliated' keywords.
1342 Assume point is at the beginning of the list."
1356 pos))
1360 ;; Return value.
1364 :begin begin
1365 :end end
1366 :contents-begin contents-begin
1367 :contents-end contents-end
1368 :structure struct
1374 "Interpret PLAIN-LIST element as Org syntax.
1375 CONTENTS is the contents of the element."
1383 ;;;; Property Drawer
1386 "Parse a property drawer.
1388 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1389 the buffer position at the beginning of the first affiliated
1390 keyword and CDR is a plist of affiliated keywords along with
1391 their value.
1393 Return a list whose CAR is `property-drawer' and CDR is a plist
1394 containing `:begin', `:end', `:contents-begin', `:contents-end',
1395 `:post-blank' and `:post-affiliated' keywords.
1397 Assume point is at the beginning of the property drawer."
1402 ;; Incomplete drawer: parse it as a paragraph.
1420 :end end
1421 :contents-begin contents-begin
1422 :contents-end contents-end
1428 "Interpret PROPERTY-DRAWER element as Org syntax.
1429 CONTENTS is the properties within the drawer."
1433 ;;;; Quote Block
1436 "Parse a quote block.
1438 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1439 the buffer position at the beginning of the first affiliated
1440 keyword and CDR is a plist of affiliated keywords along with
1441 their value.
1443 Return a list whose CAR is `quote-block' and CDR is a plist
1444 containing `:begin', `:end', `:contents-begin', `:contents-end',
1445 `:post-blank' and `:post-affiliated' keywords.
1447 Assume point is at the beginning of the block."
1451 ;; Incomplete block: parse it as a paragraph.
1457 ;; Empty blocks have no contents.
1470 :end end
1471 :contents-begin contents-begin
1472 :contents-end contents-end
1478 "Interpret QUOTE-BLOCK element as Org syntax.
1479 CONTENTS is the contents of the element."
1483 ;;;; Section
1486 "Parse a section.
1488 LIMIT bounds the search.
1490 Return a list whose CAR is `section' and CDR is a plist
1491 containing `:begin', `:end', `:contents-begin', `contents-end'
1492 and `:post-blank' keywords."
1494 ;; Beginning of section is the beginning of the first non-blank
1495 ;; line after previous headline.
1504 :end end
1505 :contents-begin begin
1506 :contents-end pos-before-blank
1510 "Interpret SECTION element as Org syntax.
1511 CONTENTS is the contents of the element."
1512 contents)
1515 ;;;; Special Block
1518 "Parse a special block.
1520 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1521 the buffer position at the beginning of the first affiliated
1522 keyword and CDR is a plist of affiliated keywords along with
1523 their value.
1525 Return a list whose CAR is `special-block' and CDR is a plist
1526 containing `:type', `:begin', `:end', `:contents-begin',
1527 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1529 Assume point is at the beginning of the block."
1536 limit t)))
1537 ;; Incomplete block: parse it as a paragraph.
1543 ;; Empty blocks have no contents.
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 ;;;; Export Block
1905 "Parse an export block.
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 `export-block' and CDR is a plist
1913 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1914 `:post-affiliated' keywords.
1916 Assume point is at export-block beginning."
1923 ;; Incomplete block: parse it as a paragraph.
1936 contents-end)))
1940 :end end
1941 :type type
1942 :value value
1948 "Interpret EXPORT-BLOCK element as Org syntax.
1949 CONTENTS is nil."
1956 ;;;; Fixed-width
1959 "Parse a fixed-width section.
1961 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1962 the buffer position at the beginning of the first affiliated
1963 keyword and CDR is a plist of affiliated keywords along with
1964 their value.
1966 Return a list whose CAR is `fixed-width' and CDR is a plist
1967 containing `:begin', `:end', `:value', `:post-blank' and
1968 `:post-affiliated' keywords.
1970 Assume point is at the beginning of the fixed-width area."
1974 value
1979 ;; Accumulate text without starting colons.
1992 :end end
1993 :value value
1999 "Interpret FIXED-WIDTH element as Org syntax.
2000 CONTENTS is nil."
2008 ;;;; Horizontal Rule
2011 "Parse an horizontal rule.
2013 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2014 the buffer position at the beginning of the first affiliated
2015 keyword and CDR is a plist of affiliated keywords along with
2016 their value.
2018 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2019 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2020 keywords."
2030 :end end
2036 "Interpret HORIZONTAL-RULE element as Org syntax.
2037 CONTENTS is nil."
2041 ;;;; Keyword
2044 "Parse a keyword at point.
2046 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2047 the buffer position at the beginning of the first affiliated
2048 keyword and CDR is a plist of affiliated keywords along with
2049 their value.
2051 Return a list whose CAR is `keyword' and CDR is a plist
2052 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2053 `:post-affiliated' keywords."
2055 ;; An orphaned affiliated keyword is considered as a regular
2056 ;; keyword. In this case AFFILIATED is nil, so we take care of
2057 ;; this corner case.
2070 :value value
2071 :begin begin
2072 :end end
2078 "Interpret KEYWORD element as Org syntax.
2079 CONTENTS is nil."
2085 ;;;; Latex Environment
2089 "Regexp matching the beginning of a LaTeX environment.
2090 The environment is captured by the first group.
2096 "Format string matching the ending of a LaTeX environment.
2100 "Parse a LaTeX environment.
2102 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2103 the buffer position at the beginning of the first affiliated
2104 keyword and CDR is a plist of affiliated keywords along with
2105 their value.
2107 Return a list whose CAR is `latex-environment' and CDR is a plist
2108 containing `:begin', `:end', `:value', `:post-blank' and
2109 `:post-affiliated' keywords.
2111 Assume point is at the beginning of the latex environment."
2118 limit t))
2119 ;; Incomplete latex environment: parse it as a paragraph.
2129 :end end
2130 :value value
2136 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2137 CONTENTS is nil."
2141 ;;;; Node Property
2144 "Parse a node-property at point.
2146 LIMIT bounds the search.
2148 Return a list whose CAR is `node-property' and CDR is a plist
2149 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2150 keywords."
2162 :value value
2163 :begin begin
2164 :end end
2168 "Interpret NODE-PROPERTY element as Org syntax.
2169 CONTENTS is nil."
2175 ;;;; Paragraph
2178 "Parse a paragraph.
2180 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2181 the buffer position at the beginning of the first affiliated
2182 keyword and CDR is a plist of affiliated keywords along with
2183 their value.
2185 Return a list whose CAR is `paragraph' and CDR is a plist
2186 containing `:begin', `:end', `:contents-begin' and
2187 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2189 Assume point is at the beginning of the paragraph."
2198 limit
2199 ;; A matching `org-element-paragraph-separate' is not
2200 ;; necessarily the end of the paragraph. In
2201 ;; particular, lines starting with # or : as a first
2202 ;; non-space character are ambiguous. We have to
2203 ;; check if they are valid Org syntax (e.g., not an
2204 ;; incomplete keyword).
2208 ;; There's no ambiguity for other symbols or
2209 ;; empty lines: stop here.
2211 ;; Stop at valid fixed-width areas.
2213 ;; Stop at drawers.
2218 ;; Stop at valid comments.
2220 ;; Stop at valid dynamic blocks.
2225 ;; Stop at valid blocks.
2232 limit t)))
2233 ;; Stop at valid latex environments.
2240 limit t)))
2241 ;; Stop at valid keywords.
2243 ;; Skip everything else.
2260 :end end
2261 :contents-begin contents-begin
2262 :contents-end contents-end
2268 "Interpret PARAGRAPH element as Org syntax.
2269 CONTENTS is the contents of the element."
2270 contents)
2273 ;;;; Planning
2276 "Parse a planning.
2278 LIMIT bounds the search.
2280 Return a list whose CAR is `planning' and CDR is a plist
2281 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2282 and `:post-blank' keywords."
2292 closed deadline scheduled)
2304 :deadline deadline
2305 :scheduled scheduled
2306 :begin begin
2307 :end end
2311 "Interpret PLANNING element as Org syntax.
2312 CONTENTS is nil."
2314 'identity
2331 ;;;; Src Block
2334 "Parse a src block.
2336 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2337 the buffer position at the beginning of the first affiliated
2338 keyword and CDR is a plist of affiliated keywords along with
2339 their value.
2341 Return a list whose CAR is `src-block' and CDR is a plist
2342 containing `:language', `:switches', `:parameters', `:begin',
2343 `:end', `:number-lines', `:retain-labels', `:use-labels',
2344 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2345 `:post-affiliated' keywords.
2347 Assume point is at the beginning of the block."
2350 limit t)))
2351 ;; Incomplete block: parse it as a paragraph.
2357 ;; Get language as a string.
2366 ;; Get switches.
2368 ;; Get parameters.
2370 ;; Switches analysis
2381 ;; Should labels be retained in (or stripped from)
2382 ;; src blocks?
2387 ;; What should code-references use - labels or
2388 ;; line-numbers?
2393 ;; Indentation.
2395 ;; Retrieve code.
2400 block-ind))
2404 ;; Get position after ending blank lines.
2414 :begin begin
2415 :end end
2416 :number-lines number-lines
2417 :preserve-indent preserve-indent
2418 :retain-labels retain-labels
2419 :use-labels use-labels
2420 :label-fmt label-fmt
2421 :value value
2427 "Interpret SRC-BLOCK element as Org syntax.
2428 CONTENTS is nil."
2437 val)
2451 ;;;; Table
2454 "Parse a table at point.
2456 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2457 the buffer position at the beginning of the first affiliated
2458 keyword and CDR is a plist of affiliated keywords along with
2459 their value.
2461 Return a list whose CAR is `table' and CDR is a plist containing
2462 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2463 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2464 keywords.
2466 Assume point is at the beginning of the table."
2480 acc))
2487 :end end
2488 :type type
2489 :tblfm tblfm
2490 ;; Only `org' tables have contents. `table.el' tables
2491 ;; use a `:value' property to store raw table as
2492 ;; a string.
2497 table-begin table-end))
2503 "Interpret TABLE element as Org syntax.
2504 CONTENTS is nil."
2515 ;;;; Table Row
2518 "Parse table row at point.
2520 LIMIT bounds the search.
2522 Return a list whose CAR is `table-row' and CDR is a plist
2523 containing `:begin', `:end', `:contents-begin', `:contents-end',
2524 `:type' and `:post-blank' keywords."
2528 ;; A table rule has no contents. In that case, ensure
2529 ;; CONTENTS-BEGIN matches CONTENTS-END.
2541 :begin begin
2542 :end end
2543 :contents-begin contents-begin
2544 :contents-end contents-end
2548 "Interpret TABLE-ROW element as Org syntax.
2549 CONTENTS is the contents of the table row."
2554 ;;;; Verse Block
2557 "Parse a verse block.
2559 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2560 the buffer position at the beginning of the first affiliated
2561 keyword and CDR is a plist of affiliated keywords along with
2562 their value.
2564 Return a list whose CAR is `verse-block' and CDR is a plist
2565 containing `:begin', `:end', `:contents-begin', `:contents-end',
2566 `:post-blank' and `:post-affiliated' keywords.
2568 Assume point is at beginning of the block."
2572 ;; Incomplete block: parse it as a paragraph.
2587 :end end
2588 :contents-begin contents-begin
2589 :contents-end contents-end
2595 "Interpret VERSE-BLOCK element as Org syntax.
2596 CONTENTS is verse block contents."
2600 \f
2601 ;;; Objects
2602 ;;
2603 ;; Unlike to elements, raw text can be found between objects. Hence,
2604 ;; `org-element--object-lex' is provided to find the next object in
2605 ;; buffer.
2606 ;;
2607 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2608 ;; object types they can contain will be specified in
2609 ;; `org-element-object-restrictions'.
2610 ;;
2611 ;; Creating a new type of object requires to alter
2612 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2613 ;; new type in `org-element-all-objects', and possibly add
2614 ;; restrictions in `org-element-object-restrictions'.
2616 ;;;; Bold
2619 "Parse bold object at point, if any.
2621 When at a bold object, return a list whose car is `bold' and cdr
2622 is a plist with `:begin', `:end', `:contents-begin' and
2623 `:contents-end' and `:post-blank' keywords. Otherwise, return
2624 nil.
2626 Assume point is at the first star marker."
2638 :end end
2639 :contents-begin contents-begin
2640 :contents-end contents-end
2644 "Interpret BOLD object as Org syntax.
2645 CONTENTS is the contents of the object."
2649 ;;;; Code
2652 "Parse code object at point, if any.
2654 When at a code object, return a list whose car is `code' and cdr
2655 is a plist with `:value', `:begin', `:end' and `:post-blank'
2656 keywords. Otherwise, return nil.
2658 Assume point is at the first tilde marker."
2669 :begin begin
2670 :end end
2674 "Interpret CODE object as Org syntax.
2675 CONTENTS is nil."
2679 ;;;; Entity
2682 "Parse entity at point, if any.
2684 When at an entity, return a list whose car is `entity' and cdr
2685 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2686 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2687 `:post-blank' as keywords. Otherwise, return nil.
2689 Assume point is at the beginning of the entity."
2691 (when (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2709 :begin begin
2710 :end end
2711 :use-brackets-p bracketsp
2715 "Interpret ENTITY object as Org syntax.
2716 CONTENTS is nil."
2722 ;;;; Export Snippet
2725 "Parse export snippet at point.
2727 When at an export snippet, return a list whose car is
2728 `export-snippet' and cdr a plist with `:begin', `:end',
2729 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2730 return nil.
2732 Assume point is at the beginning of the snippet."
2748 :value value
2749 :begin begin
2750 :end end
2754 "Interpret EXPORT-SNIPPET object as Org syntax.
2755 CONTENTS is nil."
2761 ;;;; Footnote Reference
2764 "Parse footnote reference at point, if any.
2766 When at a footnote reference, return a list whose car is
2767 `footnote-reference' and cdr a plist with `:label', `:type',
2768 `:begin', `:end', `:content-begin', `:contents-end' and
2769 `:post-blank' as keywords. Otherwise, return nil."
2793 :type type
2794 :begin begin
2795 :end end
2801 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2802 CONTENTS is its definition, when inline, or nil."
2808 ;;;; Inline Babel Call
2811 "Parse inline babel call at point, if any.
2813 When at an inline babel call, return a list whose car is
2814 `inline-babel-call' and cdr a plist with `:begin', `:end',
2815 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2817 Assume point is at the beginning of the babel call."
2829 :end end
2830 :value value
2834 "Interpret INLINE-BABEL-CALL object as Org syntax.
2835 CONTENTS is nil."
2839 ;;;; Inline Src Block
2842 "Parse inline source block at point, if any.
2844 When at an inline source block, return a list whose car is
2845 `inline-src-block' and cdr a plist with `:begin', `:end',
2846 `:language', `:value', `:parameters' and `:post-blank' as
2847 keywords. Otherwise, return nil.
2849 Assume point is at the beginning of the inline src block."
2862 :value value
2863 :parameters parameters
2864 :begin begin
2865 :end end
2869 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2870 CONTENTS is nil."
2875 language
2877 body)))
2879 ;;;; Italic
2882 "Parse italic object at point, if any.
2884 When at an italic object, return a list whose car is `italic' and
2885 cdr is a plist with `:begin', `:end', `:contents-begin' and
2886 `:contents-end' and `:post-blank' keywords. Otherwise, return
2887 nil.
2889 Assume point is at the first slash marker."
2901 :end end
2902 :contents-begin contents-begin
2903 :contents-end contents-end
2907 "Interpret ITALIC object as Org syntax.
2908 CONTENTS is the contents of the object."
2912 ;;;; Latex Fragment
2915 "Parse LaTeX fragment at point, if any.
2917 When at a LaTeX fragment, return a list whose car is
2918 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2919 and `:post-blank' as keywords. Otherwise, return nil.
2921 Assume point is at the beginning of the LaTeX fragment."
2939 ;; Macro.
2948 :begin begin
2949 :end end
2953 "Interpret LATEX-FRAGMENT object as Org syntax.
2954 CONTENTS is nil."
2957 ;;;; Line Break
2960 "Parse line break at point, if any.
2962 When at a line break, return a list whose car is `line-break',
2963 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
2964 Otherwise, return nil.
2966 Assume point is at the beginning of the line break."
2975 "Interpret LINE-BREAK object as Org syntax.
2976 CONTENTS is nil."
2980 ;;;; Link
2983 "Parse link at point, if any.
2985 When at a link, return a list whose car is `link' and cdr a plist
2986 with `:type', `:path', `:raw-link', `:application',
2987 `:search-option', `:begin', `:end', `:contents-begin',
2988 `:contents-end' and `:post-blank' as keywords. Otherwise, return
2989 nil.
2991 Assume point is at the beginning of the link."
2994 end contents-begin contents-end link-end post-blank path type
2995 raw-link link search-option application)
2997 ;; Type 1: Text targeted from a radio target.
3006 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3011 ;; RAW-LINK is the original link. Expand any
3012 ;; abbreviation in it.
3016 ;; Determine TYPE of link and set PATH accordingly.
3018 ;; File type.
3022 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3025 ;; Id type: PATH is the id.
3028 ;; Code-ref type: PATH is the name of the reference.
3031 ;; Custom-id type: PATH is the name of the custom id.
3034 ;; Fuzzy type: Internal link either matches a target, an
3035 ;; headline name or nothing. PATH is the target or
3036 ;; headline's name.
3038 ;; Type 3: Plain link, e.g., http://orgmode.org
3044 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3052 ;; In any case, deduce end point after trailing white space from
3053 ;; LINK-END variable.
3057 ;; Special "file" type link processing.
3059 ;; Extract opening application and search option.
3067 ;; Normalize URI.
3071 ;; Make sure TYPE always reports "file".
3075 :path path
3077 :application application
3078 :search-option search-option
3079 :begin begin
3080 :end end
3081 :contents-begin contents-begin
3082 :contents-end contents-end
3086 "Interpret LINK object as Org syntax.
3087 CONTENTS is the contents of the object, or nil."
3092 raw-link
3096 ;;;; Macro
3099 "Parse macro at point, if any.
3101 When at a macro, return a list whose car is `macro' and cdr
3102 a plist with `:key', `:args', `:begin', `:end', `:value' and
3103 `:post-blank' as keywords. Otherwise, return nil.
3105 Assume point is at the macro."
3116 ;; Do not use `org-split-string' since empty
3117 ;; strings are meaningful here.
3125 args nil t)
3129 :value value
3130 :args args
3131 :begin begin
3132 :end end
3136 "Interpret MACRO object as Org syntax.
3137 CONTENTS is nil."
3141 ;;;; Radio-target
3144 "Parse radio target at point, if any.
3146 When at a radio target, return a list whose car is `radio-target'
3147 and cdr a plist with `:begin', `:end', `:contents-begin',
3148 `:contents-end', `:value' and `:post-blank' as keywords.
3149 Otherwise, return nil.
3151 Assume point is at the radio target."
3163 :end end
3164 :contents-begin contents-begin
3165 :contents-end contents-end
3166 :post-blank post-blank
3170 "Interpret TARGET object as Org syntax.
3171 CONTENTS is the contents of the object."
3175 ;;;; Statistics Cookie
3178 "Parse statistics cookie at point, if any.
3180 When at a statistics cookie, return a list whose car is
3181 `statistics-cookie', and cdr a plist with `:begin', `:end',
3182 `:value' and `:post-blank' keywords. Otherwise, return nil.
3184 Assume point is at the beginning of the statistics-cookie."
3195 :end end
3196 :value value
3200 "Interpret STATISTICS-COOKIE object as Org syntax.
3201 CONTENTS is nil."
3205 ;;;; Strike-Through
3208 "Parse strike-through object at point, if any.
3210 When at a strike-through object, return a list whose car is
3211 `strike-through' and cdr is a plist with `:begin', `:end',
3212 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3213 Otherwise, return nil.
3215 Assume point is at the first plus sign marker."
3227 :end end
3228 :contents-begin contents-begin
3229 :contents-end contents-end
3233 "Interpret STRIKE-THROUGH object as Org syntax.
3234 CONTENTS is the contents of the object."
3238 ;;;; Subscript
3241 "Parse subscript at point, if any.
3243 When at a subscript object, return a list whose car is
3244 `subscript' and cdr a plist with `:begin', `:end',
3245 `:contents-begin', `:contents-end', `:use-brackets-p' and
3246 `:post-blank' as keywords. Otherwise, return nil.
3248 Assume point is at the underscore."
3262 :end end
3263 :use-brackets-p bracketsp
3264 :contents-begin contents-begin
3265 :contents-end contents-end
3269 "Interpret SUBSCRIPT object as Org syntax.
3270 CONTENTS is the contents of the object."
3273 contents))
3276 ;;;; Superscript
3279 "Parse superscript at point, if any.
3281 When at a superscript object, return a list whose car is
3282 `superscript' and cdr a plist with `:begin', `:end',
3283 `:contents-begin', `:contents-end', `:use-brackets-p' and
3284 `:post-blank' as keywords. Otherwise, return nil.
3286 Assume point is at the caret."
3300 :end end
3301 :use-brackets-p bracketsp
3302 :contents-begin contents-begin
3303 :contents-end contents-end
3307 "Interpret SUPERSCRIPT object as Org syntax.
3308 CONTENTS is the contents of the object."
3311 contents))
3314 ;;;; Table Cell
3317 "Parse table cell at point.
3318 Return a list whose car is `table-cell' and cdr is a plist
3319 containing `:begin', `:end', `:contents-begin', `:contents-end'
3320 and `:post-blank' keywords."
3328 :end end
3329 :contents-begin contents-begin
3330 :contents-end contents-end
3334 "Interpret TABLE-CELL element as Org syntax.
3335 CONTENTS is the contents of the cell, or nil."
3339 ;;;; Target
3342 "Parse target at point, if any.
3344 When at a target, return a list whose car is `target' and cdr
3345 a plist with `:begin', `:end', `:value' and `:post-blank' as
3346 keywords. Otherwise, return nil.
3348 Assume point is at the target."
3358 :end end
3359 :value value
3363 "Interpret TARGET object as Org syntax.
3364 CONTENTS is nil."
3368 ;;;; Timestamp
3379 "Parse time stamp at point, if any.
3381 When at a time stamp, return a list whose car is `timestamp', and
3382 cdr a plist with `:type', `:raw-value', `:year-start',
3383 `:month-start', `:day-start', `:hour-start', `:minute-start',
3384 `:year-end', `:month-end', `:day-end', `:hour-end',
3385 `:minute-end', `:repeater-type', `:repeater-value',
3386 `:repeater-unit', `:warning-type', `:warning-value',
3387 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3388 Otherwise, return nil.
3390 Assume point is at the beginning of the timestamp."
3409 date-start)
3420 raw-value)
3422 :repeater-type
3428 :repeater-unit
3437 :warning-unit
3440 year-start month-start day-start hour-start minute-start year-end
3441 month-end day-end hour-end minute-end)
3442 ;; Parse date-start.
3450 ;; Compute date-end. It can be provided directly in time-stamp,
3451 ;; or extracted from time range. Otherwise, it defaults to the
3452 ;; same values as date-start.
3462 :raw-value raw-value
3463 :year-start year-start
3464 :month-start month-start
3465 :day-start day-start
3466 :hour-start hour-start
3467 :minute-start minute-start
3468 :year-end year-end
3469 :month-end month-end
3470 :day-end day-end
3471 :hour-end hour-end
3472 :minute-end minute-end
3473 :begin begin
3474 :end end
3476 repeater-props
3477 warning-props))))))
3480 "Interpret TIMESTAMP object as Org syntax.
3481 CONTENTS is nil."
3500 ;; Build an Org timestamp string from TIME. ACTIVEP is
3501 ;; non-nil when time stamp is active. If WITH-TIME-P is
3502 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3503 ;; specify a time range in the timestamp. REPEAT-STRING is
3504 ;; the repeater string, if any.
3508 org-time-stamp-formats)
3509 time)))
3515 nil nil ts)))
3520 " "
3521 s
3523 ;; Return value.
3524 ts)))
3536 build-ts-string
3555 0
3563 "--"
3575 ;;;; Underline
3578 "Parse underline object at point, if any.
3580 When at an underline object, return a list whose car is
3581 `underline' and cdr is a plist with `:begin', `:end',
3582 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3583 Otherwise, return nil.
3585 Assume point is at the first underscore marker."
3597 :end end
3598 :contents-begin contents-begin
3599 :contents-end contents-end
3603 "Interpret UNDERLINE object as Org syntax.
3604 CONTENTS is the contents of the object."
3608 ;;;; Verbatim
3611 "Parse verbatim object at point, if any.
3613 When at a verbatim object, return a list whose car is `verbatim'
3614 and cdr is a plist with `:value', `:begin', `:end' and
3615 `:post-blank' keywords. Otherwise, return nil.
3617 Assume point is at the first equal sign marker."
3628 :begin begin
3629 :end end
3633 "Interpret VERBATIM object as Org syntax.
3634 CONTENTS is nil."
3638 \f
3639 ;;; Parsing Element Starting At Point
3640 ;;
3641 ;; `org-element--current-element' is the core function of this section.
3642 ;; It returns the Lisp representation of the element starting at
3643 ;; point.
3644 ;;
3645 ;; `org-element--current-element' makes use of special modes. They
3646 ;; are activated for fixed element chaining (e.g., `plain-list' >
3647 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3648 ;; `section'). Special modes are: `first-section', `item',
3649 ;; `node-property', `section' and `table-row'.
3653 "Parse the element starting at point.
3655 Return value is a list like (TYPE PROPS) where TYPE is the type
3656 of the element and PROPS a plist of properties associated to the
3657 element.
3659 Possible types are defined in `org-element-all-elements'.
3661 LIMIT bounds the search.
3663 Optional argument GRANULARITY determines the depth of the
3664 recursion. Allowed values are `headline', `greater-element',
3665 `element', `object' or nil. When it is broader than `object' (or
3666 nil), secondary values will not be parsed, since they only
3667 contain objects.
3669 Optional argument SPECIAL, when non-nil, can be either
3670 `first-section', `item', `node-property', `section', and
3671 `table-row'.
3673 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3674 be computed.
3676 This function assumes point is always at the beginning of the
3677 element it has to parse."
3680 ;; Determine if parsing depth allows for secondary strings
3681 ;; parsing. It only applies to elements referenced in
3682 ;; `org-element-secondary-value-alist'.
3685 ;; Item.
3688 ;; Table Row.
3690 ;; Node Property.
3692 ;; Headline.
3695 ;; Sections (must be checked after headline).
3700 limit)))
3701 ;; When not at bol, point is at the beginning of an item or
3702 ;; a footnote definition: next item is always a paragraph.
3704 ;; Planning and Clock.
3709 ;; Inlinetask.
3712 ;; From there, elements can have affiliated keywords.
3715 ;; Jumping over affiliated keywords put point off-limits.
3716 ;; Parse them as regular keywords.
3720 ;; LaTeX Environment.
3723 ;; Drawer and Property Drawer.
3728 ;; Fixed Width
3731 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3732 ;; Keywords.
3741 org-element-block-name-alist)))
3756 ;; Footnote Definition.
3759 ;; Horizontal Rule.
3762 ;; Diary Sexp.
3765 ;; Table.
3767 ;; List.
3770 limit affiliated
3772 ;; Default element: Paragraph.
3776 ;; Most elements can have affiliated keywords. When looking for an
3777 ;; element beginning, we want to move before them, as they belong to
3778 ;; that element, and, in the meantime, collect information they give
3779 ;; into appropriate properties. Hence the following function.
3782 "Collect affiliated keywords from point down to LIMIT.
3784 Return a list whose CAR is the position at the first of them and
3785 CDR a plist of keywords and values and move point to the
3786 beginning of the first line after them.
3788 As a special case, if element doesn't start at the beginning of
3789 the line (e.g., a paragraph starting an item), CAR is current
3790 position of point and CDR is nil."
3794 ;; RESTRICT is the list of objects allowed in parsed
3795 ;; keywords value.
3797 output)
3800 ;; Apply translation to RAW-KWD. From there, KWD is
3801 ;; the official keyword.
3803 org-element-keyword-translation-alist))
3804 raw-kwd))
3805 ;; Find main value for any keyword.
3811 ;; PARSEDP is non-nil when keyword should have its
3812 ;; value parsed.
3814 ;; If KWD is a dual keyword, find its secondary
3815 ;; value. Maybe parse it.
3822 ;; Attribute a property name to KWD.
3824 ;; Now set final shape for VALUE.
3830 ;; Attributes can always appear on multiple lines.
3833 ;; Eventually store the new value in OUTPUT.
3835 ;; Move to next keyword.
3837 ;; If affiliated keywords are orphaned: move back to first one.
3838 ;; They will be parsed as a paragraph.
3840 ;; Return value.
3844 \f
3845 ;;; The Org Parser
3846 ;;
3847 ;; The two major functions here are `org-element-parse-buffer', which
3848 ;; parses Org syntax inside the current buffer, taking into account
3849 ;; region, narrowing, or even visibility if specified, and
3850 ;; `org-element-parse-secondary-string', which parses objects within
3851 ;; a given string.
3852 ;;
3853 ;; The (almost) almighty `org-element-map' allows to apply a function
3854 ;; on elements or objects matching some type, and accumulate the
3855 ;; resulting values. In an export situation, it also skips unneeded
3856 ;; parts of the parse tree.
3859 "Recursively parse the buffer and return structure.
3860 If narrowing is in effect, only parse the visible part of the
3861 buffer.
3863 Optional argument GRANULARITY determines the depth of the
3864 recursion. It can be set to the following symbols:
3866 `headline' Only parse headlines.
3867 `greater-element' Don't recurse into greater elements excepted
3868 headlines and sections. Thus, elements
3869 parsed are the top-level ones.
3870 `element' Parse everything but objects and plain text.
3871 `object' Parse the complete buffer (default).
3873 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3874 elements.
3876 An element or an objects is represented as a list with the
3877 pattern (TYPE PROPERTIES CONTENTS), where :
3879 TYPE is a symbol describing the element or object. See
3880 `org-element-all-elements' and `org-element-all-objects' for an
3881 exhaustive list of such symbols. One can retrieve it with
3882 `org-element-type' function.
3884 PROPERTIES is the list of attributes attached to the element or
3885 object, as a plist. Although most of them are specific to the
3886 element or object type, all types share `:begin', `:end',
3887 `:post-blank' and `:parent' properties, which respectively
3888 refer to buffer position where the element or object starts,
3889 ends, the number of white spaces or blank lines after it, and
3890 the element or object containing it. Properties values can be
3891 obtained by using `org-element-property' function.
3893 CONTENTS is a list of elements, objects or raw strings
3894 contained in the current element or object, when applicable.
3895 One can access them with `org-element-contents' function.
3897 The Org buffer has `org-data' as type and nil as properties.
3898 `org-element-map' function can be used to find specific elements
3899 or objects within the parse tree.
3901 This function assumes that current major mode is `org-mode'."
3907 ;; Start in `first-section' mode so text before the first
3908 ;; headline belongs to a section.
3912 "Recursively parse objects in STRING and return structure.
3914 RESTRICTION is a symbol limiting the object types that will be
3915 looked after.
3917 Optional argument PARENT, when non-nil, is the element or object
3918 containing the secondary string. It is used to set correctly
3919 `:parent' property within the string."
3920 ;; Copy buffer-local variables listed in
3921 ;; `org-element-object-variables' into temporary buffer. This is
3922 ;; required since object parsing is dependent on these variables.
3926 org-element-object-variables))))
3934 secondary))
3935 secondary))))
3939 "Map a function on selected elements or objects.
3941 DATA is a parse tree, an element, an object, a string, or a list
3942 of such constructs. TYPES is a symbol or list of symbols of
3943 elements or objects types (see `org-element-all-elements' and
3944 `org-element-all-objects' for a complete list of types). FUN is
3945 the function called on the matching element or object. It has to
3946 accept one argument: the element or object itself.
3948 When optional argument INFO is non-nil, it should be a plist
3949 holding export options. In that case, parts of the parse tree
3950 not exportable according to that property list will be skipped.
3952 When optional argument FIRST-MATCH is non-nil, stop at the first
3953 match for which FUN doesn't return nil, and return that value.
3955 Optional argument NO-RECURSION is a symbol or a list of symbols
3956 representing elements or objects types. `org-element-map' won't
3957 enter any recursive element or object whose type belongs to that
3958 list. Though, FUN can still be applied on them.
3960 When optional argument WITH-AFFILIATED is non-nil, FUN will also
3961 apply to matching objects within parsed affiliated keywords (see
3962 `org-element-parsed-keywords').
3964 Nil values returned from FUN do not appear in the results.
3967 Examples:
3968 ---------
3970 Assuming TREE is a variable containing an Org buffer parse tree,
3971 the following example will return a flat list of all `src-block'
3972 and `example-block' elements in it:
3974 \(org-element-map tree '(example-block src-block) 'identity)
3976 The following snippet will find the first headline with a level
3979 \(org-element-map tree 'headline
3980 \(lambda (hl)
3981 \(and (= (org-element-property :level hl) 1)
3983 \(org-element-property :begin hl)))
3984 nil t)
3986 The next example will return a flat list of all `plain-list' type
3987 elements in TREE that are not a sub-list themselves:
3989 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
3991 Eventually, this example will return a flat list of all `bold'
3992 type objects containing a `latex-snippet' type object, even
3993 looking into captions:
3995 \(org-element-map tree 'bold
3996 \(lambda (b)
3997 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
3998 nil nil nil t)"
3999 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4002 ;; Recursion depth is determined by --CATEGORY.
4009 ;; If one object is found, the function
4010 ;; has to recurse into every object.
4013 ;; If one regular element is found, the
4014 ;; function has to recurse, at least,
4015 ;; into every element it encounters.
4018 types)
4019 category)))
4020 ;; Compute properties for affiliated keywords if necessary.
4025 org-element-affiliated-keywords)))
4026 --acc
4027 --walk-tree
4031 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4032 ;; holding contextual information.
4036 ;; Ignored element in an export context.
4038 ;; List of elements or objects.
4040 ;; Unconditionally enter parse trees.
4044 ;; Check if TYPE is matching among TYPES. If so,
4045 ;; apply FUN to --DATA and accumulate return value
4046 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4052 ;; If --DATA has a secondary string that can contain
4053 ;; objects with their type among TYPES, look into it.
4060 ;; If --DATA has any affiliated keywords and
4061 ;; WITH-AFFILIATED is non-nil, look for objects in
4062 ;; them.
4070 ;; Pay attention to the type of value.
4071 ;; Preserve order for multiple keywords.
4087 --affiliated-alist))
4088 ;; Determine if a recursion into --DATA is possible.
4090 ;; --TYPE is explicitly removed from recursion.
4092 ;; --DATA has no contents.
4094 ;; Looking for greater elements but --DATA is simply
4095 ;; an element or an object.
4098 ;; Looking for elements but --DATA is an object.
4101 ;; In any other case, map contents.
4105 ;; Return value in a proper order.
4109 ;; The following functions are internal parts of the parser.
4110 ;;
4111 ;; The first one, `org-element--parse-elements' acts at the element's
4112 ;; level.
4113 ;;
4114 ;; The second one, `org-element--parse-objects' applies on all objects
4115 ;; of a paragraph or a secondary string.
4116 ;;
4117 ;; More precisely, that function looks for every allowed object type
4118 ;; first. Then, it discards failed searches, keeps further matches,
4119 ;; and searches again types matched behind point, for subsequent
4120 ;; calls. Thus, searching for a given type fails only once, and every
4121 ;; object is searched only once at top level (but sometimes more for
4122 ;; nested types).
4126 "Parse elements between BEG and END positions.
4128 SPECIAL prioritize some elements over the others. It can be set
4129 to `first-section', `section' `item' or `table-row'.
4131 When value is `item', STRUCTURE will be used as the current list
4132 structure.
4134 GRANULARITY determines the depth of the recursion. See
4135 `org-element-parse-buffer' for more information.
4137 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4138 elements.
4140 Elements are accumulated into ACC."
4143 ;; Visible only: skip invisible parts at the beginning of the
4144 ;; element.
4147 ;; When parsing only headlines, skip any text before first one.
4150 ;; Main loop start.
4152 ;; Find current element's type and parse it accordingly to
4153 ;; its category.
4155 end granularity special structure))
4159 ;; Visible only: skip invisible parts between siblings.
4162 ;; Fill ELEMENT contents by side-effect.
4164 ;; If element has no contents, don't modify it.
4166 ;; Greater element: parse it between `contents-begin' and
4167 ;; `contents-end'. Make sure GRANULARITY allows the
4168 ;; recursion, or ELEMENT is a headline, in which case going
4169 ;; inside is mandatory, in order to get sub-level headings.
4177 ;; Possibly switch to a special mode.
4185 granularity visible-only element))
4186 ;; ELEMENT has contents. Parse objects inside, if
4187 ;; GRANULARITY allows it.
4193 ;; Return result.
4194 acc))
4200 ;; Sub/superscript.
4202 ;; Bold, code, italic, strike-through, underline and
4203 ;; verbatim.
4206 ;; Plain links.
4208 ;; Objects starting with "[": regular link, footnote
4209 ;; reference, statistics cookie, timestamp (inactive).
4211 ;; Objects starting with "@": export snippets.
4212 "@@"
4213 ;; Objects starting with "{": macro.
4214 "{{{"
4215 ;; Objects starting with "<" : timestamp (active,
4216 ;; diary), target, radio target and angular links.
4218 ;; Objects starting with "$": latex fragment.
4220 ;; Objects starting with "\": line break, entity,
4221 ;; latex fragment.
4223 ;; Objects starting with raw text: inline Babel
4224 ;; source block, inline Babel call.
4227 "Regexp possibly matching the beginning of an object.
4228 This regexp allows false positives. Dedicated parser (e.g.,
4229 `org-export-bold-parser') will take care of further filtering.
4230 Radio links are not matched by this regexp, as they are treated
4234 "Return next object in current buffer or nil.
4235 RESTRICTION is a list of object types, as symbols, that should be
4236 looked after. This function assumes that the buffer is narrowed
4237 to an appropriate container (e.g., a paragraph)."
4245 found)
4310 ;; This is probably a plain link.
4316 ;; Radio link.
4321 "Parse objects between BEG and END and return recursive structure.
4323 Objects are accumulated in ACC.
4325 RESTRICTION is a list of object successors which are allowed in
4326 the current object."
4334 ;; 1. Text before any object. Untabify it.
4339 acc
4343 ;; 2. Object...
4346 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4347 ;; a recursive type.
4355 ;; 3. Text after last object. Untabify it.
4359 acc
4363 ;; Result.
4364 acc)))
4367 \f
4368 ;;; Towards A Bijective Process
4369 ;;
4370 ;; The parse tree obtained with `org-element-parse-buffer' is really
4371 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4372 ;; interpreted and expanded into a string with canonical Org syntax.
4373 ;; Hence `org-element-interpret-data'.
4374 ;;
4375 ;; The function relies internally on
4376 ;; `org-element--interpret-affiliated-keywords'.
4378 ;;;###autoload
4380 "Interpret DATA as Org syntax.
4382 DATA is a parse tree, an element, an object or a secondary string
4383 to interpret.
4385 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4386 new types that should be treated as objects. An unknown type not
4387 belonging to this list is seen as a pseudo-element instead. Both
4388 pseudo-objects and pseudo-elements are transparent entities, i.e.
4389 only their contents are interpreted.
4391 Return Org syntax as a string."
4395 "Interpret DATA as Org syntax.
4397 DATA is a parse tree, an element, an object or a secondary string
4398 to interpret. PARENT is used for recursive calls. It contains
4399 the element or object containing data, or nil. PSEUDO-OBJECTS
4400 are list of symbols defining new element or object types.
4401 Unknown types that don't belong to this list are treated as
4402 pseudo-elements instead.
4404 Return Org syntax as a string."
4406 ;; Find interpreter for current object or element. If it
4407 ;; doesn't exist (e.g. this is a pseudo object or element),
4408 ;; return contents, if any.
4414 ;; Secondary string.
4420 ;; Full Org document.
4426 ;; Plain text: return it.
4428 ;; Element or object without contents.
4430 ;; Element or object with contents.
4433 ;; Recursively interpret contents.
4439 data
4440 ;; Fix indentation of elements containing
4441 ;; objects. We ignore `table-row' elements
4442 ;; as they are one line long anyway.
4444 data
4445 ;; When normalizing first paragraph of an
4446 ;; item or a footnote-definition, ignore
4447 ;; first line's indentation.
4454 ;; Build white spaces. If no `:post-blank' property is
4455 ;; specified, assume its value is 0.
4466 "Return ELEMENT's affiliated keywords as Org syntax.
4467 If there is no affiliated keyword, return the empty string."
4477 ": "
4480 value)
4488 ;; All attribute keywords can have multiple lines.
4494 ;; List all ELEMENT's properties matching an attribute line or an
4495 ;; affiliated keyword, but ignore translated keywords since they
4496 ;; cannot belong to the property list.
4503 org-element-keyword-translation-alist)))))
4504 collect prop)
4507 ;; Because interpretation of the parse tree must return the same
4508 ;; number of blank lines between elements and the same number of white
4509 ;; space after objects, some special care must be given to white
4510 ;; spaces.
4511 ;;
4512 ;; The first function, `org-element-normalize-string', ensures any
4513 ;; string different from the empty string will end with a single
4514 ;; newline character.
4515 ;;
4516 ;; The second function, `org-element-normalize-contents', removes
4517 ;; global indentation from the contents of the current element.
4520 "Ensure string S ends with a single newline character.
4522 If S isn't a string return it unchanged. If S is the empty
4523 string, return it. Otherwise, return a new string with a single
4524 newline character at its end."
4532 "Normalize plain text in ELEMENT's contents.
4534 ELEMENT must only contain plain text and objects.
4536 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4537 indentation to compute maximal common indentation.
4539 Return the normalized element that is element with global
4540 indentation removed from its contents. The function assumes that
4541 indentation is not done with TAB characters."
4543 find-min-ind ; For byte-compiler.
4546 ;; Return minimal common indentation within BLOB. This is
4547 ;; done by walking recursively BLOB and updating MIN-IND
4548 ;; along the way. FIRST-FLAG is non-nil when the first
4549 ;; string hasn't been seen yet. It is required as this
4550 ;; string is the only one whose indentation doesn't happen
4551 ;; after a newline character.
4558 ;; An indentation of zero means no string will be
4559 ;; modified. Quit the process.
4568 ;; Find minimal indentation in ELEMENT.
4571 ;; Build ELEMENT back, replacing each string with the same
4572 ;; string minus common indentation.
4577 ;; Return BLOB with all its strings indentation
4578 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4579 ;; is non-nil when the first string hasn't been seen
4580 ;; yet.
4595 org-element-recursive-objects)
4599 blob))))
4603 \f
4604 ;;; Cache
4605 ;;
4606 ;; Implement a caching mechanism for `org-element-at-point' and
4607 ;; `org-element-context', which see.
4608 ;;
4609 ;; A single public function is provided: `org-element-cache-reset'.
4610 ;;
4611 ;; Cache is enabled by default, but can be disabled globally with
4612 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4613 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4614 ;; can be tweaked to control caching behaviour.
4615 ;;
4616 ;; Internally, parsed elements are stored in an AVL tree,
4617 ;; `org-element--cache'. This tree is updated lazily: whenever
4618 ;; a change happens to the buffer, a synchronization request is
4619 ;; registered in `org-element--cache-sync-requests' (see
4620 ;; `org-element--cache-submit-request'). During idle time, requests
4621 ;; are processed by `org-element--cache-sync'. Synchronization also
4622 ;; happens when an element is required from the cache. In this case,
4623 ;; the process stops as soon as the needed element is up-to-date.
4624 ;;
4625 ;; A synchronization request can only apply on a synchronized part of
4626 ;; the cache. Therefore, the cache is updated at least to the
4627 ;; location where the new request applies. Thus, requests are ordered
4628 ;; from left to right and all elements starting before the first
4629 ;; request are correct. This property is used by functions like
4630 ;; `org-element--cache-find' to retrieve elements in the part of the
4631 ;; cache that can be trusted.
4632 ;;
4633 ;; A request applies to every element, starting from its original
4634 ;; location (or key, see below). When a request is processed, it
4635 ;; moves forward and may collide the next one. In this case, both
4636 ;; requests are merged into a new one that starts from that element.
4637 ;; As a consequence, the whole synchronization complexity does not
4638 ;; depend on the number of pending requests, but on the number of
4639 ;; elements the very first request will be applied on.
4640 ;;
4641 ;; Elements cannot be accessed through their beginning position, which
4642 ;; may or may not be up-to-date. Instead, each element in the tree is
4643 ;; associated to a key, obtained with `org-element--cache-key'. This
4644 ;; mechanism is robust enough to preserve total order among elements
4645 ;; even when the tree is only partially synchronized.
4646 ;;
4647 ;; Objects contained in an element are stored in a hash table,
4648 ;; `org-element--cache-objects'.
4652 "Non nil when Org parser should cache its results.
4659 "Maximum duration, as a time value, for a cache synchronization.
4660 If the synchronization is not over after this delay, the process
4661 pauses and resumes after `org-element-cache-sync-break'
4665 "Duration, as a time value, of the pause between synchronizations.
4669 ;;;; Data Structure
4672 "AVL tree used to cache elements.
4673 Each node of the tree contains an element. Comparison is done
4674 with `org-element--cache-compare'. This cache is used in
4678 "Hash table used as to cache objects.
4679 Key is an element, as returned by `org-element-at-point', and
4680 value is an alist where each association is:
4682 \(PARENT COMPLETEP . OBJECTS)
4684 where PARENT is an element or object, COMPLETEP is a boolean,
4685 non-nil when all direct children of parent are already cached and
4686 OBJECTS is a list of such children, as objects, from farthest to
4687 closest.
4690 contained within a paragraph
4694 If the paragraph is completely parsed, OBJECTS-DATA will be
4696 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4697 \(BOLD-OBJECT t ENTITY-OBJECT))
4699 whereas in a partially parsed paragraph, it could be
4701 \((PARAGRAPH nil ENTITY-OBJECT))
4706 "List of pending synchronization requests.
4708 A request is a vector with the following pattern:
4710 \[NEXT BEG END OFFSET OUTREACH PARENT PHASE]
4712 Processing a synchronization request consists of three phases:
4714 0. Delete modified elements,
4715 1. Fill missing area in cache,
4716 2. Shift positions and re-parent elements after the changes.
4718 During phase 0, NEXT is the key of the first element to be
4719 removed, BEG and END is buffer position delimiting the
4720 modifications. Elements starting between them (inclusive) are
4721 removed and so are those contained within OUTREACH. PARENT, when
4722 non-nil, is the parent of the first element to be removed.
4724 During phase 1, NEXT is the key of the next known element in
4725 cache and BEG its beginning position. Parse buffer between that
4726 element and the one before it in order to determine the parent of
4727 the next element. Set PARENT to the element containing NEXT.
4729 During phase 2, NEXT is the key of the next element to shift in
4730 the parse tree. All elements starting from this one have their
4731 properties relatives to buffer positions shifted by integer
4732 OFFSET and, if they belong to element PARENT, are adopted by it.
4740 "Hash table used to store keys during synchronization.
4744 "Return a unique key for ELEMENT in cache tree.
4746 Keys are used to keep a total order among elements in the cache.
4747 Comparison is done with `org-element--cache-key-less-p'.
4749 When no synchronization is taking place, a key is simply the
4750 beginning position of the element, or that position plus one in
4751 the case of an first item (respectively row) in
4752 a list (respectively a table).
4754 During a synchronization, the key is the one the element had when
4755 the cache was synchronized for the last time. Elements added to
4756 cache during the synchronization get a new key generated with
4757 `org-element--cache-generate-key'.
4759 Such keys are stored in `org-element--cache-sync-keys'. The hash
4760 table is cleared once the synchronization is complete."
4763 ;; Increase beginning position of items (respectively
4764 ;; table rows) by one, so the first item can get
4765 ;; a different key from its parent list (respectively
4766 ;; table).
4769 begin)))
4772 key))))
4775 "Generate a key between LOWER and UPPER.
4777 LOWER and UPPER are integers or lists, possibly empty.
4779 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4780 a unique key, as an integer or a list of integers, according to
4781 the following rules:
4783 - LOWER and UPPER are compared level-wise until values differ.
4785 - If, at a given level, LOWER and UPPER differ from more than
4786 2, the new key shares all the levels above with LOWER and
4787 gets a new level. Its value is the mean between LOWER and
4788 UPPER:
4790 \(1 2) + (1 4) --> (1 3)
4792 - If LOWER has no value to compare with, it is assumed that its
4793 value is `most-negative-fixnum'. E.g.,
4795 \(1 1) + (1 1 2)
4797 is equivalent to
4799 \(1 1 m) + (1 1 2)
4801 where m is `most-negative-fixnum'. Likewise, if UPPER is
4802 short of levels, the current value is `most-positive-fixnum'.
4804 - If they differ from only one, the new key inherits from
4805 current LOWER level and fork it at the next level. E.g.,
4807 \(2 1) + (3 3)
4809 is equivalent to
4811 \(2 1) + (2 M)
4813 where M is `most-positive-fixnum'.
4815 - If the key is only one level long, it is returned as an
4816 integer:
4818 \(1 2) + (3 2) --> 2
4820 When they are not equals, the function assumes that LOWER is
4821 lesser than UPPER, per `org-element--cache-key-less-p'."
4825 skip-upper key)
4836 ;; When at a given level, LOWER and UPPER differ from
4837 ;; 1, ignore UPPER altogether. Instead create a key
4838 ;; between LOWER and the greatest key with the same
4839 ;; prefix as LOWER so far.
4845 "Non-nil if key A is less than key B.
4846 A and B are either integers or lists of integers, as returned by
4847 `org-element--cache-key'."
4855 ;; If A is empty, either keys are equal (B is also empty) and
4856 ;; we return nil, or A is lesser than B (B is longer) and we
4857 ;; return a non-nil value.
4858 ;;
4859 ;; If A is not empty, B is necessarily empty and A is greater
4860 ;; than B (A is longer). Therefore, return nil.
4864 "Non-nil when element A is located before element B."
4869 "Return root value in cache.
4870 This function assumes `org-element--cache' is a valid AVL tree."
4874 ;;;; Tools
4877 "Non-nil when cache is active in current buffer."
4882 "Find element in cache starting at POS or before.
4884 POS refers to a buffer position.
4886 When optional argument SIDE is non-nil, the function checks for
4887 elements starting at or past POS instead. If SIDE is `both', the
4888 function returns a cons cell where car is the first element
4889 starting at or before POS and cdr the first element starting
4890 after POS.
4892 The function can only find elements in the synchronized part of
4893 the cache."
4897 lower upper)
4912 ;; We found an element in cache starting at POS. If `side'
4913 ;; is `both' we also want the next one in order to generate
4914 ;; a key in-between.
4915 ;;
4916 ;; If the element is the first row or item in a table or
4917 ;; a plain list, we always return the table or the plain
4918 ;; list.
4919 ;;
4920 ;; In any other case, we return the element found.
4929 lower parent
4930 upper parent)))))
4933 lower element
4934 upper element)))))
4941 "Store ELEMENT in current buffer's cache, if allowed.
4942 When optional argument DATA is non-nil, assume is it object data
4943 relative to ELEMENT and store it in the objects cache."
4947 ;; During synchronization, first build an appropriate key
4948 ;; for the new element so `avl-tree-enter' can insert it at
4949 ;; the right spot in the cache.
4958 org-element--cache-sync-keys)))
4960 ;; Headlines are not stored in cache, so objects in titles are
4961 ;; not stored either.
4966 "Remove ELEMENT from cache.
4967 Assume ELEMENT belongs to cache and that a cache is active."
4972 ;;;; Synchronization
4975 "Set idle timer for cache synchronization in BUFFER."
4982 org-element-cache-sync-idle-time))
4983 nil
4984 #'org-element--cache-sync
4985 buffer)))
4988 "Non-nil when synchronization process should be interrupted.
4989 TIME-LIMIT is a time value or nil."
4995 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4997 Properties containing buffer positions are `:begin', `:end',
4998 `:contents-begin', `:contents-end' and `:structure'. When
4999 optional argument PROPS is a list of keywords, only shift
5000 properties provided in that list.
5002 Properties are modified by side-effect."
5004 ;; Shift `:structure' property for the first plain list only: it
5005 ;; is the only one that really matters and it prevents from
5006 ;; shifting it more than once.
5020 "Synchronize cache with recent modification in BUFFER.
5022 When optional argument THRESHOLD is non-nil, do the
5023 synchronization for all elements starting before or at threshold,
5024 then exit. Otherwise, synchronize cache for as long as
5025 `org-element-cache-sync-duration' or until Emacs leaves idle
5026 state.
5028 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5029 not registered yet in the cache are going to happen. It is used
5030 in `org-element--cache-submit-request', where cache is partially
5031 updated before current modification are actually submitted."
5042 request
5044 threshold
5047 org-element-cache-sync-duration))
5048 future-change)
5049 ;; Request processed. Merge current and next offsets and
5050 ;; transfer ending position.
5056 ;; If more requests are awaiting, set idle timer accordingly.
5057 ;; Otherwise, reset keys.
5064 "Process synchronization REQUEST for all entries before NEXT.
5066 REQUEST is a vector, built by `org-element--cache-submit-request'.
5068 NEXT is a cache key, as returned by `org-element--cache-key'.
5070 When non-nil, THRESHOLD is a buffer position. Synchronization
5071 stops as soon as a shifted element begins after it.
5073 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5074 after this time or when Emacs exits idle state.
5076 When non-nil, FUTURE-CHANGE is a buffer position where changes
5077 not registered yet in the cache are going to happen. See
5078 `org-element--cache-submit-request' for more information.
5080 Throw `interrupt' if the process stops before completing the
5081 request."
5084 ;; Phase 0.
5085 ;;
5086 ;; Delete all elements starting after BEG, but not after buffer
5087 ;; position END or past element with key NEXT.
5088 ;;
5089 ;; At each iteration, we start again at tree root since
5090 ;; a deletion modifies structure of the balanced tree.
5098 ;; Find first element in cache with key BEG or after it.
5108 data-key key
5111 data-key key
5112 node nil)))))
5121 up))
5127 ;; No element starting after modifications left in
5128 ;; cache: further processing is futile.
5131 ;; Phase 1.
5132 ;;
5133 ;; Phase 0 left a hole in the cache. Some elements after it
5134 ;; could have parents within. For example, in the following
5135 ;; buffer:
5136 ;;
5137 ;; - item
5138 ;;
5139 ;;
5140 ;; Paragraph1
5141 ;;
5142 ;; Paragraph2
5143 ;;
5144 ;; if we remove a blank line between "item" and "Paragraph1",
5145 ;; everything down to "Paragraph2" is removed from cache. But
5146 ;; the paragraph now belongs to the list, and its `:parent'
5147 ;; property no longer is accurate.
5148 ;;
5149 ;; Therefore we need to parse again elements in the hole, or at
5150 ;; least in its last section, so that we can re-parent
5151 ;; subsequent elements, during phase 2.
5152 ;;
5153 ;; Note that we only need to get the parent from the first
5154 ;; element in cache after the hole.
5155 ;;
5156 ;; When next key is lesser or equal to the current one, delegate
5157 ;; phase 1 processing to next request in order to preserve key
5158 ;; order among requests.
5166 ;; Next element will start at its beginning position plus
5167 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5168 ;; contains the real beginning position of the first element to
5169 ;; shift and re-parent.
5173 ;; Changes are going to happen around this element and
5174 ;; they will trigger another phase 1 request. Skip the
5175 ;; current one.
5181 ;; Phase 2.
5182 ;;
5183 ;; Shift all elements starting from key START, but before NEXT, by
5184 ;; OFFSET, and re-parent them when appropriate.
5185 ;;
5186 ;; Elements are modified by side-effect so the tree structure
5187 ;; remains intact.
5188 ;;
5189 ;; Once THRESHOLD, if any, is reached, or once there is an input
5190 ;; pending, exit. Before leaving, the current synchronization
5191 ;; request is updated.
5198 exit-flag)
5199 ;; No re-parenting nor shifting planned: request is over.
5209 ;; We reached NEXT. Request is complete.
5211 ;; Handle interruption request. Update current request.
5216 ;; Shift element.
5219 ;; Shift associated objects data, if any.
5224 ;; Update PARENT and re-parent DATA, only when
5225 ;; necessary. Propagate new structures for lists.
5239 ;; Cache is up-to-date past THRESHOLD. Request
5240 ;; interruption.
5245 ;; We reached end of tree: synchronization complete.
5246 t)))
5249 "Parse elements in current section, down to POS.
5251 Start parsing from the closest between the last known element in
5252 cache or headline above. Return the smallest element containing
5253 POS.
5255 When optional argument SYNCP is non-nil, return the parent of the
5256 element containing POS instead. In that case, it is also
5257 possible to provide TIME-LIMIT, which is a time value specifying
5258 when the parsing should stop. The function throws `interrupt' if
5259 the process stopped before finding the expected result."
5266 element next)
5268 ;; Nothing in cache before point: start parsing from first
5269 ;; element following headline above, or first element in
5270 ;; buffer.
5276 ;; Cache returned exact match: return it.
5279 ;; There's a headline between cached value and POS: cached
5280 ;; value is invalid. Start parsing from first element
5281 ;; following the headline.
5287 ;; Check if CACHED or any of its ancestors contain point.
5288 ;;
5289 ;; If there is such an element, we inspect it in order to know
5290 ;; if we return it or if we need to parse its contents.
5291 ;; Otherwise, we just start parsing from current location,
5292 ;; which is right after the top-most element containing
5293 ;; CACHED.
5294 ;;
5295 ;; As a special case, if POS is at the end of the buffer, we
5296 ;; want to return the innermost element ending there.
5297 ;;
5298 ;; Also, if we find an ancestor and discover that we need to
5299 ;; parse its contents, make sure we don't start from
5300 ;; `:contents-begin', as we would otherwise go past CACHED
5301 ;; again. Instead, in that situation, we will resume parsing
5302 ;; from NEXT, which is located after CACHED or its higher
5303 ;; ancestor not containing point.
5315 ;; Parse successively each element until we reach POS.
5321 special-flag)
5329 end 'element special-flag
5336 ;; Skip any element ending before point. Also skip
5337 ;; element ending at point (unless it is also the end of
5338 ;; buffer) since we're sure that another element begins
5339 ;; after it.
5342 ;; A non-greater element contains point: return it.
5345 ;; Otherwise, we have to decide if ELEMENT really
5346 ;; contains POS. In that case we start parsing from
5347 ;; contents' beginning.
5348 ;;
5349 ;; If POS is at contents' beginning but it is also at
5350 ;; the beginning of the first item in a list or a table.
5351 ;; In that case, we need to create an anchor for that
5352 ;; list or table, so return it.
5353 ;;
5354 ;; Also, if POS is at the end of the buffer, no element
5355 ;; can start after it, but more than one may end there.
5356 ;; Arbitrarily, we choose to return the innermost of
5357 ;; such elements.
5373 parent element
5374 end cend))))
5375 ;; Otherwise, return ELEMENT as it is the smallest
5376 ;; element containing POS.
5381 ;;;; Staging Buffer Changes
5387 ;; Blocks
5389 ;; LaTeX environments.
5391 ;; Drawers.
5394 "Regexp matching a sensitive line, structure wise.
5395 A sensitive line is a headline, inlinetask, block, drawer, or
5396 latex-environment boundary. When such a line is modified,
5397 structure changes in the document may propagate in the whole
5401 "Non-nil when a sensitive line is about to be changed.
5405 "Request extension of area going to be modified if needed.
5406 BEG and END are the beginning and end of the range of changed
5407 text. See `before-change-functions' for more information."
5417 'headline
5420 org-element--cache-sensitive-re bottom t)))))))))
5423 "Update buffer modifications for current buffer.
5424 BEG and END are the beginning and end of the range of changed
5425 text, and the length in bytes of the pre-change text replaced by
5426 that range. See `after-change-functions' for more information."
5434 ;; Determine if modified area needs to be extended, according
5435 ;; to both previous and current state. We make a special
5436 ;; case for headline editing: if a headline is modified but
5437 ;; not removed, do not extend.
5446 org-element--cache-sensitive-re bottom t))))
5447 ;; Effectively extend modified area.
5455 ;; Store synchronization request.
5458 ;; Activate a timer to process the request during idle time.
5462 "Return first element to remove from cache.
5464 BEG and END are buffer positions delimiting buffer modifications.
5465 OFFSET is the size of the changes.
5467 Returned element is usually the first element in cache containing
5468 any position between BEG and END. As an exception, greater
5469 elements around the changes that are robust to contents
5470 modifications are preserved and updated according to the
5471 changes."
5481 property-drawer quote-block
5482 special-block))
5485 ;; UP is a robust greater element containing changes.
5486 ;; We only need to extend its ending boundaries.
5492 ;; We're at top level element containing ELEMENT: if it's
5493 ;; altered by buffer modifications, it is first element in
5494 ;; cache to be removed. Otherwise, that first element is the
5495 ;; following one.
5496 ;;
5497 ;; As a special case, do not remove BEFORE if it is a robust
5498 ;; container for current changes.
5500 before)))))
5503 "Submit a new cache synchronization request for current buffer.
5504 BEG and END are buffer positions delimiting the minimal area
5505 where cache data should be removed. OFFSET is the size of the
5506 change, as an integer."
5508 delete-to delete-from)
5513 ;; Current changes can be merged with first sync request: we
5514 ;; can save a partial cache synchronization.
5517 ;; If last change happened within area to be removed, extend
5518 ;; boundaries of robust parents, if any. Otherwise, find
5519 ;; first element to remove and update request accordingly.
5531 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5532 ;; if any, is no longer a 0-phase request, thus ensuring that
5533 ;; phases are properly ordered. We need to provide OFFSET as
5534 ;; optional parameter since current modifications are not known
5535 ;; yet to the otherwise correct part of the cache (i.e, before
5536 ;; the first request).
5543 ;; When changes happen before the first known
5544 ;; element, re-parent and shift the rest of the
5545 ;; cache.
5547 ;; Otherwise, we find the first non robust
5548 ;; element containing END. All elements between
5549 ;; FIRST and this one are to be removed.
5550 ;;
5551 ;; Among them, some could be located outside the
5552 ;; synchronized part of the cache, in which case
5553 ;; comparing buffer positions to find them is
5554 ;; useless. Instead, we store the element
5555 ;; containing them in the request itself. All
5556 ;; its children will be removed.
5568 element up))
5571 org-element--cache-sync-requests)
5572 ;; No element to remove. No need to re-parent either.
5573 ;; Simply shift additional elements, if any, by OFFSET.
5578 ;;;; Public Functions
5580 ;;;###autoload
5582 "Reset cache in current buffer.
5583 When optional argument ALL is non-nil, reset cache in all Org
5584 buffers."
5602 ;;;###autoload
5604 "Refresh cache at position POS."
5611 \f
5612 ;;; The Toolbox
5613 ;;
5614 ;; The first move is to implement a way to obtain the smallest element
5615 ;; containing point. This is the job of `org-element-at-point'. It
5616 ;; basically jumps back to the beginning of section containing point
5617 ;; and proceed, one element after the other, with
5618 ;; `org-element--current-element' until the container is found. Note:
5619 ;; When using `org-element-at-point', secondary values are never
5620 ;; parsed since the function focuses on elements, not on objects.
5621 ;;
5622 ;; At a deeper level, `org-element-context' lists all elements and
5623 ;; objects containing point.
5624 ;;
5625 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5626 ;; internally by navigation and manipulation tools.
5629 ;;;###autoload
5631 "Determine closest element around point.
5633 Return value is a list like (TYPE PROPS) where TYPE is the type
5634 of the element and PROPS a plist of properties associated to the
5635 element.
5637 Possible types are defined in `org-element-all-elements'.
5638 Properties depend on element or object type, but always include
5639 `:begin', `:end', `:parent' and `:post-blank' properties.
5641 As a special case, if point is at the very beginning of the first
5642 item in a list or sub-list, returned element will be that list
5643 instead of the item. Likewise, if point is at the beginning of
5644 the first row of a table, returned element will be the table
5645 instead of the first row.
5647 When point is at the end of the buffer, return the innermost
5648 element ending there."
5654 ;; Within blank lines at the beginning of buffer, return nil.
5656 ;; Within blank lines right after a headline, return that
5657 ;; headline.
5661 ;; Otherwise parse until we find element containing ORIGIN.
5668 ;;;###autoload
5670 "Return smallest element or object around point.
5672 Return value is a list like (TYPE PROPS) where TYPE is the type
5673 of the element or object and PROPS a plist of properties
5674 associated to it.
5676 Possible types are defined in `org-element-all-elements' and
5677 `org-element-all-objects'. Properties depend on element or
5678 object type, but always include `:begin', `:end', `:parent' and
5679 `:post-blank'.
5681 As a special case, if point is right after an object and not at
5682 the beginning of any other object, return that object.
5684 Optional argument ELEMENT, when non-nil, is the closest element
5685 containing point, as returned by `org-element-at-point'.
5686 Providing it allows for quicker computation."
5692 ;; If point is inside an element containing objects or
5693 ;; a secondary string, narrow buffer to the container and
5694 ;; proceed with parsing. Otherwise, return ELEMENT.
5696 ;; At a parsed affiliated keyword, check if we're inside main
5697 ;; or dual value.
5704 org-element-parsed-keywords))
5713 ;; Also change type to retrieve correct restrictions.
5715 ;; At an item, objects can only be located within tag, if any.
5725 ;; At an headline or inlinetask, objects are in title.
5732 ;; At a paragraph, a table-row or a verse block, objects are
5733 ;; located within their contents.
5737 ;; CBEG is nil for table rules.
5742 ;; At a parsed keyword, objects are located within value.
5745 org-element-document-properties))
5752 ;; At a planning line, if point is at a timestamp, return it,
5753 ;; otherwise, return element.
5761 ;; All other locations cannot contain objects: bail out.
5771 next object-data last)
5775 ;; When entering PARENT for the first time, get list
5776 ;; of objects within known so far. Store it in
5777 ;; OBJECT-DATA.
5782 ;; Find NEXT object for analysis.
5784 ;; If NEXT is non-nil, we already exhausted the
5785 ;; cache so we can parse buffer to find the object
5786 ;; after it.
5788 ;; Otherwise, check if cache can help us.
5799 ;; Cache contains the information needed.
5802 pos)
5804 pos)
5810 ;; If we have a new object to analyze, store it in
5811 ;; cache. Otherwise record that there is nothing
5812 ;; more to parse in this element at this depth.
5817 ;; Process NEXT, if any, in order to know if we need
5818 ;; to skip it, return it or move into it.
5825 ;; Skip objects ending before point. Also skip
5826 ;; objects ending at point unless it is also the
5827 ;; end of buffer, since we want to return the
5828 ;; innermost object.
5831 ;; For convenience, when object ends at POS,
5832 ;; without any space, store it in LAST, as we
5833 ;; will return it if no object starts here.
5837 ;; If POS is within a container object, move
5838 ;; into that object.
5842 ;; At contents' end, if there is no
5843 ;; space before point, also move into
5844 ;; object, for consistency with
5845 ;; convenience feature above.
5854 next nil
5855 object-data nil))
5856 ;; Otherwise, return NEXT.
5858 ;; Store results in cache, if applicable.
5862 "Non-nil when elements ELEM-A and ELEM-B are nested."
5871 "Swap elements ELEM-A and ELEM-B.
5872 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5873 end of ELEM-A."
5875 ;; There are two special cases when an element doesn't start at bol:
5876 ;; the first paragraph in an item or in a footnote definition.
5878 ;; Only a paragraph without any affiliated keyword can be moved at
5879 ;; ELEM-A position in such a situation. Note that the case of
5880 ;; a footnote definition is impossible: it cannot contain two
5881 ;; paragraphs in a row because it cannot contain a blank line.
5887 ;; In a special situation, ELEM-A will have no indentation. We'll
5888 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5902 ;; Store overlays responsible for visibility status. We
5903 ;; also need to store their boundaries as they will be
5904 ;; removed from buffer.
5911 ;; Get contents.
5919 ;; Restore ex ELEM-A overlays.
5928 ;; Restore ex ELEM-B overlays.
5936 "Remove maximum common indentation in string S and return it.
5937 When optional argument N is a positive integer, remove exactly
5938 that much characters from indentation, if possible, or return
5939 S as-is otherwise. Unlike to `org-remove-indentation', this
5940 function doesn't call `untabify' on S."
5945 ;; Find maximum common indentation, if not specified.
5953 min-ind)))
5955 ;; Remove exactly N indentation, but give up if not possible.
5968 ;; Local variables:
5969 ;; generated-autoload-file: "org-loaddefs.el"
5970 ;; End:
5972 ;;; org-element.el ends here