| blob | 703b35571b76f0132cae0229abb42b5c7ee17478 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 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', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or an headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; 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, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
202 Sharing the same successor comes handy when, for example, the
207 inline-src-block italic line-break latex-fragment link macro
208 radio-target statistics-cookie strike-through subscript superscript
209 table-cell target timestamp underline verbatim)
214 table-cell underline)
224 "Alist between block names and the associated parsing function.
225 Names must be uppercase. Any block whose name has no association
231 Only these types can accept search options and an explicit
237 "List of affiliated keywords as strings.
243 ;; Regular affiliated keywords.
246 "Regexp matching any affiliated keyword.
248 Keyword name is put in match group 1. Moreover, if keyword
249 belongs to `org-element-dual-keywords', put the dual value in
250 match group 2.
258 "Alist of usual translations for keywords.
259 The key is the old name and the value the new one. The property
263 "List of affiliated keywords that can occur more than once in an element.
265 Their value will be consed into a list of strings, which will be
266 returned as the value of the property.
268 This list is checked after translations have been applied. See
269 `org-element-keyword-translation-alist'.
275 "List of affiliated keywords whose value can be parsed.
277 Their value will be stored as a secondary string: a list of
278 strings and objects.
280 This list is checked after translations have been applied. See
284 "List of affiliated keywords which can have a secondary value.
286 In Org syntax, they can be written with optional square brackets
287 before the colons. For example, RESULTS keyword can be
288 associated to a hash value with the following:
290 #+RESULTS[hash-string]: some-source
292 This list is checked after translations have been applied. See
296 "List of properties associated to the whole document.
297 Any keyword in this list will have its value parsed and stored as
304 inline-src-block latex-or-entity line-break link macro
305 radio-target sub/superscript target text-markup
306 timestamp)
308 radio-target statistics-cookie sub/superscript target text-markup
309 timestamp)
321 inline-src-block latex-or-entity line-break link macro
322 radio-target statistics-cookie sub/superscript target text-markup
323 timestamp)
326 latex-or-entity link radio-target sub/superscript target
327 text-markup timestamp)
338 latex-or-entity line-break link macro radio-target
340 "Alist of objects restrictions.
342 CAR is an element or object type containing objects and CDR is
343 a list of successors that will be called within an element or
344 object of such type.
346 For example, in a `radio-target' object, one can only find
347 entities, export snippets, latex-fragments, subscript and
348 superscript.
350 This alist also applies to secondary string. For example, an
351 `headline' type element doesn't directly contain objects, but
362 "List of buffer-local variables used when parsing objects.
363 These variables are copied to the temporary buffer created by
367 \f
368 ;;; Accessors and Setters
369 ;;
370 ;; Provide four accessors: `org-element-type', `org-element-property'
371 ;; `org-element-contents' and `org-element-restriction'.
372 ;;
373 ;; Setter functions allow to modify elements by side effect. There is
374 ;; `org-element-put-property', `org-element-set-contents',
375 ;; `org-element-set-element' and `org-element-adopt-element'. Note
376 ;; that `org-element-set-element' and `org-element-adopt-elements' are
377 ;; higher level functions since also update `:parent' property.
380 "Return type of ELEMENT.
382 The function returns the type of the element or object provided.
383 It can also return the following special value:
384 `plain-text' for a string
385 `org-data' for a complete document
386 nil in any other case."
392 "Extract the value from the PROPERTY of an ELEMENT."
397 "Extract contents from an ELEMENT."
403 "Return restriction associated to ELEMENT.
404 ELEMENT can be an element, an object or a symbol representing an
405 element or object type."
407 org-element-object-restrictions)))
410 "In ELEMENT set PROPERTY to VALUE.
411 Return modified element."
414 element))
417 "Set ELEMENT contents to CONTENTS.
418 Return modified element."
425 "Replace element or object OLD with element or object NEW.
426 The function takes care of setting `:parent' property for NEW."
427 ;; Since OLD is going to be changed into NEW by side-effect, first
428 ;; make sure that every element or object within NEW has OLD as
429 ;; parent.
432 ;; Transfer contents.
434 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
435 ;; with NEW's.
438 ;; Transfer type.
442 "Append elements to the contents of another element.
444 PARENT is an element or object. CHILDREN can be elements,
445 objects, or a strings.
447 The function takes care of setting `:parent' property for CHILD.
448 Return parent element."
449 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
450 ;; string: parent is the list itself.
453 children)
454 ;; Add CHILDREN at the end of PARENT contents.
457 parent
459 ;; Return modified PARENT element.
463 \f
464 ;;; Greater elements
465 ;;
466 ;; For each greater element type, we define a parser and an
467 ;; interpreter.
468 ;;
469 ;; A parser returns the element or object as the list described above.
470 ;; Most of them accepts no argument. Though, exceptions exist. Hence
471 ;; every element containing a secondary string (see
472 ;; `org-element-secondary-value-alist') will accept an optional
473 ;; argument to toggle parsing of that secondary string. Moreover,
474 ;; `item' parser requires current list's structure as its first
475 ;; element.
476 ;;
477 ;; An interpreter accepts two arguments: the list representation of
478 ;; the element or object, and its contents. The latter may be nil,
479 ;; depending on the element or object considered. It returns the
480 ;; appropriate Org syntax, as a string.
481 ;;
482 ;; Parsing functions must follow the naming convention:
483 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
484 ;; defined in `org-element-greater-elements'.
485 ;;
486 ;; Similarly, interpreting functions must follow the naming
487 ;; convention: org-element-TYPE-interpreter.
488 ;;
489 ;; With the exception of `headline' and `item' types, greater elements
490 ;; cannot contain other greater elements of their own type.
491 ;;
492 ;; Beside implementing a parser and an interpreter, adding a new
493 ;; greater element requires to tweak `org-element--current-element'.
494 ;; Moreover, the newly defined type must be added to both
495 ;; `org-element-all-elements' and `org-element-greater-elements'.
498 ;;;; Center Block
501 "Parse a center block.
503 LIMIT bounds the search. AFFILIATED is a list of which CAR is
504 the buffer position at the beginning of the first affiliated
505 keyword and CDR is a plist of affiliated keywords along with
506 their value.
508 Return a list whose CAR is `center-block' and CDR is a plist
509 containing `:begin', `:end', `:hiddenp', `:contents-begin',
510 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
512 Assume point is at the beginning of the block."
516 ;; Incomplete block: parse it as a paragraph.
521 ;; Empty blocks have no contents.
536 :end end
537 :hiddenp hidden
538 :contents-begin contents-begin
539 :contents-end contents-end
545 "Interpret CENTER-BLOCK element as Org syntax.
546 CONTENTS is the contents of the element."
550 ;;;; Drawer
553 "Parse a drawer.
555 LIMIT bounds the search. AFFILIATED is a list of which CAR is
556 the buffer position at the beginning of the first affiliated
557 keyword and CDR is a plist of affiliated keywords along with
558 their value.
560 Return a list whose CAR is `drawer' and CDR is a plist containing
561 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
562 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
564 Assume point is at beginning of drawer."
567 ;; Incomplete drawer: parse it as a paragraph.
575 ;; Empty drawers have no contents.
590 :end end
591 :drawer-name name
592 :hiddenp hidden
593 :contents-begin contents-begin
594 :contents-end contents-end
600 "Interpret DRAWER element as Org syntax.
601 CONTENTS is the contents of the element."
604 contents))
607 ;;;; Dynamic Block
610 "Parse a dynamic block.
612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
613 the buffer position at the beginning of the first affiliated
614 keyword and CDR is a plist of affiliated keywords along with
615 their value.
617 Return a list whose CAR is `dynamic-block' and CDR is a plist
618 containing `:block-name', `:begin', `:end', `:hiddenp',
619 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
620 and `:post-affiliated' keywords.
622 Assume point is at beginning of dynamic block."
626 ;; Incomplete block: parse it as a paragraph.
635 ;; Empty blocks have no contents.
650 :end end
651 :block-name name
652 :arguments arguments
653 :hiddenp hidden
654 :contents-begin contents-begin
655 :contents-end contents-end
661 "Interpret DYNAMIC-BLOCK element as Org syntax.
662 CONTENTS is the contents of the element."
667 contents))
670 ;;;; Footnote Definition
673 "Parse a footnote definition.
675 LIMIT bounds the search. AFFILIATED is a list of which CAR is
676 the buffer position at the beginning of the first affiliated
677 keyword and CDR is a plist of affiliated keywords along with
678 their value.
680 Return a list whose CAR is `footnote-definition' and CDR is
681 a plist containing `:label', `:begin' `:end', `:contents-begin',
682 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
684 Assume point is at the beginning of the footnote definition."
710 :begin begin
711 :end end
712 :contents-begin contents-begin
713 :contents-end contents-end
719 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
720 CONTENTS is the contents of the footnote-definition."
722 " "
723 contents))
726 ;;;; Headline
729 "Parse an headline.
731 Return a list whose CAR is `headline' and CDR is a plist
732 containing `:raw-value', `:title', `:begin', `:end',
733 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
734 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
735 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
736 `:commentedp' and `:footnote-section-p' keywords.
738 The plist also contains any property set in the property drawer,
739 with its name in lowercase, the underscores replaced with hyphens
740 and colons at the beginning (i.e. `:custom-id').
742 When RAW-SECONDARY-P is non-nil, headline's title will not be
743 parsed as a secondary string, but as a plain string instead.
745 Assume point is at beginning of the headline."
758 raw-value)))
762 raw-value)))
766 ;; Normalize property names: ":SOME_PROP:" becomes
767 ;; ":some-prop".
779 plist))
781 ;; Read time properties on the line below the headline.
787 org-keyword-time-not-clock-regexp end t)
797 plist))))
810 ;; Clean RAW-VALUE from any quote or comment string.
818 ""
819 raw-value))))
820 ;; Clean TAGS from archive tag, if any.
826 :begin begin
827 :end end
828 :pre-blank
831 :hiddenp hidden
832 :contents-begin contents-begin
833 :contents-end contents-end
834 :level level
836 :tags tags
837 :todo-keyword todo
838 :todo-type todo-type
844 end)
845 :footnote-section-p footnote-section-p
846 :archivedp archivedp
847 :commentedp commentedp
849 time-props
850 standard-props))))
852 headline :title
858 "Interpret HEADLINE element as Org syntax.
859 CONTENTS is the contents of the element."
886 ;; Align tags.
894 ? )
895 tags))
899 tags))))
901 contents)))
904 ;;;; Inlinetask
907 "Parse an inline task.
909 Return a list whose CAR is `inlinetask' and CDR is a plist
910 containing `:title', `:begin', `:end', `:hiddenp',
911 `:contents-begin' and `:contents-end', `:level', `:priority',
912 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
913 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
915 The plist also contains any property set in the property drawer,
916 with its name in lowercase, the underscores replaced with hyphens
917 and colons at the beginning (i.e. `:custom-id').
919 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
920 title will not be parsed as a secondary string, but as a plain
921 string instead.
923 Assume point is at beginning of the inline task."
933 ;; Normalize property names: ":SOME_PROP:" becomes
934 ;; ":some-prop".
946 plist))
948 ;; Read time properties on the line below the inlinetask
949 ;; opening string.
955 org-keyword-time-not-clock-regexp end t)
965 plist))))
985 :begin begin
986 :end end
987 :hiddenp hidden
988 :contents-begin contents-begin
989 :contents-end contents-end
992 :tags tags
993 :todo-keyword todo
994 :todo-type todo-type
996 time-props
997 standard-props))))
999 inlinetask :title
1002 raw-value
1004 inlinetask))))))
1007 "Interpret INLINETASK element as Org syntax.
1008 CONTENTS is the contents of inlinetask."
1023 ;; Align tags.
1031 ? )
1032 tags))
1036 tags))))
1037 ;; Prefer degenerate inlinetasks when there are no
1038 ;; contents.
1041 contents
1045 ;;;; Item
1048 "Parse an item.
1050 STRUCT is the structure of the plain list.
1052 Return a list whose CAR is `item' and CDR is a plist containing
1053 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1054 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1055 `:post-blank' keywords.
1057 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1058 any, will not be parsed as a secondary string, but as a plain
1059 string instead.
1061 Assume point is at the beginning of the item."
1085 ;; Ignore tags in un-ordered lists: they are just
1086 ;; a part of item's body.
1092 ;; If first line isn't empty, contents really start
1093 ;; at the text after item's meta-data.
1104 :begin begin
1105 :end end
1106 ;; CONTENTS-BEGIN and CONTENTS-END may be
1107 ;; mixed up in the case of an empty item
1108 ;; separated from the next by a blank line.
1109 ;; Thus ensure the former is always the
1110 ;; smallest.
1113 :checkbox checkbox
1114 :counter counter
1115 :hiddenp hidden
1116 :structure struct
1119 item :tag
1127 "Interpret ITEM element as Org syntax.
1128 CONTENTS is the contents of the element."
1134 ;; Compute indentation.
1139 ;; Indent contents.
1141 bullet
1154 ;;;; Plain List
1157 "Parse a plain list.
1159 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1160 the buffer position at the beginning of the first affiliated
1161 keyword and CDR is a plist of affiliated keywords along with
1162 their value. STRUCTURE is the structure of the plain list being
1163 parsed.
1165 Return a list whose CAR is `plain-list' and CDR is a plist
1166 containing `:type', `:begin', `:end', `:contents-begin' and
1167 `:contents-end', `:structure', `:post-blank' and
1168 `:post-affiliated' keywords.
1170 Assume point is at the beginning of the list."
1185 ;; Return value.
1189 :begin begin
1190 :end end
1191 :contents-begin contents-begin
1192 :contents-end contents-end
1193 :structure struct
1199 "Interpret PLAIN-LIST element as Org syntax.
1200 CONTENTS is the contents of the element."
1208 ;;;; Property Drawer
1211 "Parse a property drawer.
1213 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1214 the buffer position at the beginning of the first affiliated
1215 keyword and CDR is a plist of affiliated keywords along with
1216 their value.
1218 Return a list whose CAR is `property-drawer' and CDR is a plist
1219 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1220 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1222 Assume point is at the beginning of the property drawer."
1227 ;; Incomplete drawer: parse it as a paragraph.
1247 :end end
1248 :hiddenp hidden
1249 :contents-begin contents-begin
1250 :contents-end contents-end
1256 "Interpret PROPERTY-DRAWER element as Org syntax.
1257 CONTENTS is the properties within the drawer."
1261 ;;;; Quote Block
1264 "Parse a quote block.
1266 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1267 the buffer position at the beginning of the first affiliated
1268 keyword and CDR is a plist of affiliated keywords along with
1269 their value.
1271 Return a list whose CAR is `quote-block' and CDR is a plist
1272 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1273 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1275 Assume point is at the beginning of the block."
1279 ;; Incomplete block: parse it as a paragraph.
1285 ;; Empty blocks have no contents.
1300 :end end
1301 :hiddenp hidden
1302 :contents-begin contents-begin
1303 :contents-end contents-end
1309 "Interpret QUOTE-BLOCK element as Org syntax.
1310 CONTENTS is the contents of the element."
1314 ;;;; Section
1317 "Parse a section.
1319 LIMIT bounds the search.
1321 Return a list whose CAR is `section' and CDR is a plist
1322 containing `:begin', `:end', `:contents-begin', `contents-end'
1323 and `:post-blank' keywords."
1325 ;; Beginning of section is the beginning of the first non-blank
1326 ;; line after previous headline.
1335 :end end
1336 :contents-begin begin
1337 :contents-end pos-before-blank
1341 "Interpret SECTION element as Org syntax.
1342 CONTENTS is the contents of the element."
1343 contents)
1346 ;;;; Special Block
1349 "Parse a special block.
1351 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1352 the buffer position at the beginning of the first affiliated
1353 keyword and CDR is a plist of affiliated keywords along with
1354 their value.
1356 Return a list whose CAR is `special-block' and CDR is a plist
1357 containing `:type', `:begin', `:end', `:hiddenp',
1358 `:contents-begin', `:contents-end', `:post-blank' and
1359 `:post-affiliated' keywords.
1361 Assume point is at the beginning of the block."
1368 ;; Incomplete block: parse it as a paragraph.
1374 ;; Empty blocks have no contents.
1389 :begin begin
1390 :end end
1391 :hiddenp hidden
1392 :contents-begin contents-begin
1393 :contents-end contents-end
1399 "Interpret SPECIAL-BLOCK element as Org syntax.
1400 CONTENTS is the contents of the element."
1405 \f
1406 ;;; Elements
1407 ;;
1408 ;; For each element, a parser and an interpreter are also defined.
1409 ;; Both follow the same naming convention used for greater elements.
1410 ;;
1411 ;; Also, as for greater elements, adding a new element type is done
1412 ;; through the following steps: implement a parser and an interpreter,
1413 ;; tweak `org-element--current-element' so that it recognizes the new
1414 ;; type and add that new type to `org-element-all-elements'.
1415 ;;
1416 ;; As a special case, when the newly defined type is a block type,
1417 ;; `org-element-block-name-alist' has to be modified accordingly.
1420 ;;;; Babel Call
1423 "Parse a babel call.
1425 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1426 the buffer position at the beginning of the first affiliated
1427 keyword and CDR is a plist of affiliated keywords along with
1428 their value.
1430 Return a list whose CAR is `babel-call' and CDR is a plist
1431 containing `:begin', `:end', `:info', `:post-blank' and
1432 `:post-affiliated' as keywords."
1446 :end end
1447 :info info
1453 "Interpret BABEL-CALL element as Org syntax.
1454 CONTENTS is nil."
1460 ;; Remove redundant square brackets.
1465 ;;;; Clock
1468 "Parse a clock.
1470 LIMIT bounds the search.
1472 Return a list whose CAR is `clock' and CDR is a plist containing
1473 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1474 as keywords."
1494 :value value
1495 :duration duration
1496 :begin begin
1497 :end end
1501 "Interpret CLOCK element as Org syntax.
1502 CONTENTS is nil."
1510 "%2s:%02s"
1514 ;;;; Comment
1517 "Parse a comment.
1519 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1520 the buffer position at the beginning of the first affiliated
1521 keyword and CDR is a plist of affiliated keywords along with
1522 their value.
1524 Return a list whose CAR is `comment' and CDR is a plist
1525 containing `:begin', `:end', `:value', `:post-blank',
1526 `:post-affiliated' keywords.
1528 Assume point is at comment beginning."
1537 ;; Get comments ending.
1540 ;; Accumulate lines without leading hash and first
1541 ;; whitespace.
1556 :end end
1557 :value value
1563 "Interpret COMMENT element as Org syntax.
1564 CONTENTS is nil."
1568 ;;;; Comment Block
1571 "Parse an export block.
1573 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1574 the buffer position at the beginning of the first affiliated
1575 keyword and CDR is a plist of affiliated keywords along with
1576 their value.
1578 Return a list whose CAR is `comment-block' and CDR is a plist
1579 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1580 and `:post-affiliated' keywords.
1582 Assume point is at comment block beginning."
1586 ;; Incomplete block: parse it as a paragraph.
1601 contents-begin contents-end)))
1605 :end end
1606 :value value
1607 :hiddenp hidden
1613 "Interpret COMMENT-BLOCK element as Org syntax.
1614 CONTENTS is nil."
1619 ;;;; Diary Sexp
1622 "Parse a diary sexp.
1624 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1625 the buffer position at the beginning of the first affiliated
1626 keyword and CDR is a plist of affiliated keywords along with
1627 their value.
1629 Return a list whose CAR is `diary-sexp' and CDR is a plist
1630 containing `:begin', `:end', `:value', `:post-blank' and
1631 `:post-affiliated' keywords."
1644 :begin begin
1645 :end end
1651 "Interpret DIARY-SEXP as Org syntax.
1652 CONTENTS is nil."
1656 ;;;; Example Block
1659 "Parse an example block.
1661 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1662 the buffer position at the beginning of the first affiliated
1663 keyword and CDR is a plist of affiliated keywords along with
1664 their value.
1666 Return a list whose CAR is `example-block' and CDR is a plist
1667 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1668 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1669 `:switches', `:value', `:post-blank' and `:post-affiliated'
1670 keywords."
1674 ;; Incomplete block: parse it as a paragraph.
1681 ;; Switches analysis
1686 ;; Should labels be retained in (or stripped from) example
1687 ;; blocks?
1692 ;; What should code-references use - labels or
1693 ;; line-numbers?
1700 ;; Standard block parsing.
1707 contents-begin contents-end)))
1717 :end end
1718 :value value
1719 :switches switches
1720 :number-lines number-lines
1721 :preserve-indent preserve-indent
1722 :retain-labels retain-labels
1723 :use-labels use-labels
1724 :label-fmt label-fmt
1725 :hiddenp hidden
1731 "Interpret EXAMPLE-BLOCK element as Org syntax.
1732 CONTENTS is nil."
1741 ;;;; Export Block
1744 "Parse an export block.
1746 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1747 the buffer position at the beginning of the first affiliated
1748 keyword and CDR is a plist of affiliated keywords along with
1749 their value.
1751 Return a list whose CAR is `export-block' and CDR is a plist
1752 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1753 `:post-blank' and `:post-affiliated' keywords.
1755 Assume point is at export-block beginning."
1762 ;; Incomplete block: parse it as a paragraph.
1777 contents-end)))
1781 :end end
1782 :type type
1783 :value value
1784 :hiddenp hidden
1790 "Interpret EXPORT-BLOCK element as Org syntax.
1791 CONTENTS is nil."
1798 ;;;; Fixed-width
1801 "Parse a fixed-width section.
1803 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1804 the buffer position at the beginning of the first affiliated
1805 keyword and CDR is a plist of affiliated keywords along with
1806 their value.
1808 Return a list whose CAR is `fixed-width' and CDR is a plist
1809 containing `:begin', `:end', `:value', `:post-blank' and
1810 `:post-affiliated' keywords.
1812 Assume point is at the beginning of the fixed-width area."
1816 value
1821 ;; Accumulate text without starting colons.
1835 :end end
1836 :value value
1842 "Interpret FIXED-WIDTH element as Org syntax.
1843 CONTENTS is nil."
1848 ;;;; Horizontal Rule
1851 "Parse an horizontal rule.
1853 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1854 the buffer position at the beginning of the first affiliated
1855 keyword and CDR is a plist of affiliated keywords along with
1856 their value.
1858 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1859 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1860 keywords."
1871 :end end
1877 "Interpret HORIZONTAL-RULE element as Org syntax.
1878 CONTENTS is nil."
1882 ;;;; Keyword
1885 "Parse a keyword at point.
1887 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1888 the buffer position at the beginning of the first affiliated
1889 keyword and CDR is a plist of affiliated keywords along with
1890 their value.
1892 Return a list whose CAR is `keyword' and CDR is a plist
1893 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1894 `:post-affiliated' keywords."
1909 :value value
1910 :begin begin
1911 :end end
1917 "Interpret KEYWORD element as Org syntax.
1918 CONTENTS is nil."
1924 ;;;; Latex Environment
1927 "Parse a LaTeX environment.
1929 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1930 the buffer position at the beginning of the first affiliated
1931 keyword and CDR is a plist of affiliated keywords along with
1932 their value.
1934 Return a list whose CAR is `latex-environment' and CDR is a plist
1935 containing `:begin', `:end', `:value', `:post-blank' and
1936 `:post-affiliated' keywords.
1938 Assume point is at the beginning of the latex environment."
1945 limit t))
1946 ;; Incomplete latex environment: parse it as a paragraph.
1958 :end end
1959 :value value
1965 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1966 CONTENTS is nil."
1970 ;;;; Node Property
1973 "Parse a node-property at point.
1975 LIMIT bounds the search.
1977 Return a list whose CAR is `node-property' and CDR is a plist
1978 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1979 keywords."
1991 :value value
1992 :begin begin
1993 :end end
1997 "Interpret NODE-PROPERTY element as Org syntax.
1998 CONTENTS is nil."
2004 ;;;; Paragraph
2007 "Parse a paragraph.
2009 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2010 the buffer position at the beginning of the first affiliated
2011 keyword and CDR is a plist of affiliated keywords along with
2012 their value.
2014 Return a list whose CAR is `paragraph' and CDR is a plist
2015 containing `:begin', `:end', `:contents-begin' and
2016 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2018 Assume point is at the beginning of the paragraph."
2027 limit
2028 ;; A matching `org-element-paragraph-separate' is not
2029 ;; necessarily the end of the paragraph. In
2030 ;; particular, lines starting with # or : as a first
2031 ;; non-space character are ambiguous. We have check
2032 ;; if they are valid Org syntax (i.e. not an
2033 ;; incomplete keyword).
2037 ;; There's no ambiguity for other symbols or
2038 ;; empty lines: stop here.
2040 ;; Stop at valid fixed-width areas.
2042 ;; Stop at drawers.
2047 ;; Stop at valid comments.
2049 ;; Stop at valid dynamic blocks.
2054 ;; Stop at valid blocks.
2061 limit t)))
2062 ;; Stop at valid latex environments.
2069 limit t)))
2070 ;; Stop at valid keywords.
2072 ;; Skip everything else.
2090 :end end
2091 :contents-begin contents-begin
2092 :contents-end contents-end
2098 "Interpret PARAGRAPH element as Org syntax.
2099 CONTENTS is the contents of the element."
2100 contents)
2103 ;;;; Planning
2106 "Parse a planning.
2108 LIMIT bounds the search.
2110 Return a list whose CAR is `planning' and CDR is a plist
2111 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2112 and `:post-blank' keywords."
2122 closed deadline scheduled)
2134 :deadline deadline
2135 :scheduled scheduled
2136 :begin begin
2137 :end end
2141 "Interpret PLANNING element as Org syntax.
2142 CONTENTS is nil."
2144 'identity
2161 ;;;; Quote Section
2164 "Parse a quote section.
2166 LIMIT bounds the search.
2168 Return a list whose CAR is `quote-section' and CDR is a plist
2169 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2171 Assume point is at beginning of the section."
2182 :end end
2183 :value value
2187 "Interpret QUOTE-SECTION element as Org syntax.
2188 CONTENTS is nil."
2192 ;;;; Src Block
2195 "Parse a src block.
2197 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2198 the buffer position at the beginning of the first affiliated
2199 keyword and CDR is a plist of affiliated keywords along with
2200 their value.
2202 Return a list whose CAR is `src-block' and CDR is a plist
2203 containing `:language', `:switches', `:parameters', `:begin',
2204 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2205 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2206 `:post-blank' and `:post-affiliated' keywords.
2208 Assume point is at the beginning of the block."
2211 limit t)))
2212 ;; Incomplete block: parse it as a paragraph.
2218 ;; Get language as a string.
2227 ;; Get switches.
2229 ;; Get parameters.
2231 ;; Switches analysis
2239 ;; Should labels be retained in (or stripped from)
2240 ;; src blocks?
2245 ;; What should code-references use - labels or
2246 ;; line-numbers?
2250 ;; Get visibility status.
2252 ;; Retrieve code.
2258 ;; Get position after ending blank lines.
2269 :begin begin
2270 :end end
2271 :number-lines number-lines
2272 :preserve-indent preserve-indent
2273 :retain-labels retain-labels
2274 :use-labels use-labels
2275 :label-fmt label-fmt
2276 :hiddenp hidden
2277 :value value
2283 "Interpret SRC-BLOCK element as Org syntax.
2284 CONTENTS is nil."
2307 ;;;; Table
2310 "Parse a table at point.
2312 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2313 the buffer position at the beginning of the first affiliated
2314 keyword and CDR is a plist of affiliated keywords along with
2315 their value.
2317 Return a list whose CAR is `table' and CDR is a plist containing
2318 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2319 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2320 keywords.
2322 Assume point is at the beginning of the table."
2336 acc))
2344 :end end
2345 :type type
2346 :tblfm tblfm
2347 ;; Only `org' tables have contents. `table.el' tables
2348 ;; use a `:value' property to store raw table as
2349 ;; a string.
2354 table-begin table-end))
2360 "Interpret TABLE element as Org syntax.
2361 CONTENTS is nil."
2372 ;;;; Table Row
2375 "Parse table row at point.
2377 LIMIT bounds the search.
2379 Return a list whose CAR is `table-row' and CDR is a plist
2380 containing `:begin', `:end', `:contents-begin', `:contents-end',
2381 `:type' and `:post-blank' keywords."
2385 ;; A table rule has no contents. In that case, ensure
2386 ;; CONTENTS-BEGIN matches CONTENTS-END.
2398 :begin begin
2399 :end end
2400 :contents-begin contents-begin
2401 :contents-end contents-end
2405 "Interpret TABLE-ROW element as Org syntax.
2406 CONTENTS is the contents of the table row."
2411 ;;;; Verse Block
2414 "Parse a verse block.
2416 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2417 the buffer position at the beginning of the first affiliated
2418 keyword and CDR is a plist of affiliated keywords along with
2419 their value.
2421 Return a list whose CAR is `verse-block' and CDR is a plist
2422 containing `:begin', `:end', `:contents-begin', `:contents-end',
2423 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2425 Assume point is at beginning of the block."
2429 ;; Incomplete block: parse it as a paragraph.
2446 :end end
2447 :contents-begin contents-begin
2448 :contents-end contents-end
2449 :hiddenp hidden
2455 "Interpret VERSE-BLOCK element as Org syntax.
2456 CONTENTS is verse block contents."
2460 \f
2461 ;;; Objects
2462 ;;
2463 ;; Unlike to elements, interstices can be found between objects.
2464 ;; That's why, along with the parser, successor functions are provided
2465 ;; for each object. Some objects share the same successor (i.e. `code'
2466 ;; and `verbatim' objects).
2467 ;;
2468 ;; A successor must accept a single argument bounding the search. It
2469 ;; will return either a cons cell whose CAR is the object's type, as
2470 ;; a symbol, and CDR the position of its next occurrence, or nil.
2471 ;;
2472 ;; Successors follow the naming convention:
2473 ;; org-element-NAME-successor, where NAME is the name of the
2474 ;; successor, as defined in `org-element-all-successors'.
2475 ;;
2476 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2477 ;; object types they can contain will be specified in
2478 ;; `org-element-object-restrictions'.
2479 ;;
2480 ;; Adding a new type of object is simple. Implement a successor,
2481 ;; a parser, and an interpreter for it, all following the naming
2482 ;; convention. Register type in `org-element-all-objects' and
2483 ;; successor in `org-element-all-successors'. Maybe tweak
2484 ;; restrictions about it, and that's it.
2487 ;;;; Bold
2490 "Parse bold object at point.
2492 Return a list whose CAR is `bold' and CDR is a plist with
2493 `:begin', `:end', `:contents-begin' and `:contents-end' and
2494 `:post-blank' keywords.
2496 Assume point is at the first star marker."
2508 :end end
2509 :contents-begin contents-begin
2510 :contents-end contents-end
2514 "Interpret BOLD object as Org syntax.
2515 CONTENTS is the contents of the object."
2519 "Search for the next text-markup object.
2521 LIMIT bounds the search.
2523 Return value is a cons cell whose CAR is a symbol among `bold',
2524 `italic', `underline', `strike-through', `code' and `verbatim'
2525 and CDR is beginning position."
2541 ;;;; Code
2544 "Parse code object at point.
2546 Return a list whose CAR is `code' and CDR is a plist with
2547 `:value', `:begin', `:end' and `:post-blank' keywords.
2549 Assume point is at the first tilde marker."
2560 :begin begin
2561 :end end
2565 "Interpret CODE object as Org syntax.
2566 CONTENTS is nil."
2570 ;;;; Entity
2573 "Parse entity at point.
2575 Return a list whose CAR is `entity' and CDR a plist with
2576 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2577 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2578 keywords.
2580 Assume point is at the beginning of the entity."
2582 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2598 :begin begin
2599 :end end
2600 :use-brackets-p bracketsp
2604 "Interpret ENTITY object as Org syntax.
2605 CONTENTS is nil."
2611 "Search for the next latex-fragment or entity object.
2613 LIMIT bounds the search.
2615 Return value is a cons cell whose CAR is `entity' or
2616 `latex-fragment' and CDR is beginning position."
2621 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2628 limit t)
2631 ;; Determine if it's a real entity or a LaTeX command.
2634 ;; No entity nor command: point is at a LaTeX fragment.
2635 ;; Determine its type to get the correct beginning position.
2643 matchers)
2647 ;;;; Export Snippet
2650 "Parse export snippet at point.
2652 Return a list whose CAR is `export-snippet' and CDR a plist with
2653 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2654 keywords.
2656 Assume point is at the beginning of the snippet."
2668 :value value
2669 :begin begin
2670 :end end
2674 "Interpret EXPORT-SNIPPET object as Org syntax.
2675 CONTENTS is nil."
2681 "Search for the next export-snippet object.
2683 LIMIT bounds the search.
2685 Return value is a cons cell whose CAR is `export-snippet' and CDR
2686 its beginning position."
2695 ;;;; Footnote Reference
2698 "Parse footnote reference at point.
2700 Return a list whose CAR is `footnote-reference' and CDR a plist
2701 with `:label', `:type', `:inline-definition', `:begin', `:end'
2702 and `:post-blank' as keywords."
2724 :type type
2725 :begin begin
2726 :end end
2729 footnote-reference :inline-definition
2734 footnote-reference))))))
2737 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2738 CONTENTS is nil."
2748 "Search for the next footnote-reference object.
2750 LIMIT bounds the search.
2752 Return value is a cons cell whose CAR is `footnote-reference' and
2753 CDR is beginning position."
2767 ;;;; Inline Babel Call
2770 "Parse inline babel call at point.
2772 Return a list whose CAR is `inline-babel-call' and CDR a plist
2773 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2775 Assume point is at the beginning of the babel call."
2786 :end end
2787 :info info
2791 "Interpret INLINE-BABEL-CALL object as Org syntax.
2792 CONTENTS is nil."
2798 ;; Remove redundant square brackets.
2801 main-source)
2805 "Search for the next inline-babel-call object.
2807 LIMIT bounds the search.
2809 Return value is a cons cell whose CAR is `inline-babel-call' and
2810 CDR is beginning position."
2812 ;; Use a simplified version of
2813 ;; `org-babel-inline-lob-one-liner-regexp'.
2816 limit t)
2820 ;;;; Inline Src Block
2823 "Parse inline source block at point.
2825 LIMIT bounds the search.
2827 Return a list whose CAR is `inline-src-block' and CDR a plist
2828 with `:begin', `:end', `:language', `:value', `:parameters' and
2829 `:post-blank' as keywords.
2831 Assume point is at the beginning of the inline src block."
2844 :value value
2845 :parameters parameters
2846 :begin begin
2847 :end end
2851 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2852 CONTENTS is nil."
2857 language
2859 body)))
2862 "Search for the next inline-babel-call element.
2864 LIMIT bounds the search.
2866 Return value is a cons cell whose CAR is `inline-babel-call' and
2867 CDR is beginning position."
2873 ;;;; Italic
2876 "Parse italic object at point.
2878 Return a list whose CAR is `italic' and CDR is a plist with
2879 `:begin', `:end', `:contents-begin' and `:contents-end' and
2880 `:post-blank' keywords.
2882 Assume point is at the first slash marker."
2894 :end end
2895 :contents-begin contents-begin
2896 :contents-end contents-end
2900 "Interpret ITALIC object as Org syntax.
2901 CONTENTS is the contents of the object."
2905 ;;;; Latex Fragment
2908 "Parse latex fragment at point.
2910 Return a list whose CAR is `latex-fragment' and CDR a plist with
2911 `:value', `:begin', `:end', and `:post-blank' as keywords.
2913 Assume point is at the beginning of the latex fragment."
2927 ;; None found: it's a macro.
2936 :begin begin
2937 :end end
2941 "Interpret LATEX-FRAGMENT object as Org syntax.
2942 CONTENTS is nil."
2945 ;;;; Line Break
2948 "Parse line break at point.
2950 Return a list whose CAR is `line-break', and CDR a plist with
2951 `:begin', `:end' and `:post-blank' keywords.
2953 Assume point is at the beginning of the line break."
2960 "Interpret LINE-BREAK object as Org syntax.
2961 CONTENTS is nil."
2965 "Search for the next line-break object.
2967 LIMIT bounds the search.
2969 Return value is a cons cell whose CAR is `line-break' and CDR is
2970 beginning position."
2974 ;; A line break can only happen on a non-empty line.
2979 ;;;; Link
2982 "Parse link at point.
2984 Return a list whose CAR is `link' and CDR a plist with `:type',
2985 `:path', `:raw-link', `:application', `:search-option', `:begin',
2986 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2987 keywords.
2989 Assume point is at the beginning of the link."
2992 end contents-begin contents-end link-end post-blank path type
2993 raw-link link search-option application)
2995 ;; Type 1: Text targeted from a radio target.
3000 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3005 ;; RAW-LINK is the original link.
3010 ;; Determine TYPE of link and set PATH accordingly.
3012 ;; File type.
3015 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3018 ;; Id type: PATH is the id.
3021 ;; Code-ref type: PATH is the name of the reference.
3024 ;; Custom-id type: PATH is the name of the custom id.
3027 ;; Fuzzy type: Internal link either matches a target, an
3028 ;; headline name or nothing. PATH is the target or
3029 ;; headline's name.
3031 ;; Type 3: Plain link, i.e. http://orgmode.org
3037 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3044 ;; In any case, deduce end point after trailing white space from
3045 ;; LINK-END variable.
3048 ;; Extract search option and opening application out of
3049 ;; "file"-type links.
3051 ;; Application.
3056 ;; Extract search option from PATH.
3060 ;; Make sure TYPE always report "file".
3064 :path path
3066 :application application
3067 :search-option search-option
3068 :begin begin
3069 :end end
3070 :contents-begin contents-begin
3071 :contents-end contents-end
3075 "Interpret LINK object as Org syntax.
3076 CONTENTS is the contents of the object, or nil."
3081 raw-link
3085 "Search for the next link object.
3087 LIMIT bounds the search.
3089 Return value is a cons cell whose CAR is `link' and CDR is
3090 beginning position."
3099 ;;;; Macro
3102 "Parse macro at point.
3104 Return a list whose CAR is `macro' and CDR a plist with `:key',
3105 `:args', `:begin', `:end', `:value' and `:post-blank' as
3106 keywords.
3108 Assume point is at the macro."
3119 ;; Do not use `org-split-string' since empty
3120 ;; strings are meaningful here.
3124 ;; Repair bad splits, when comma is protected,
3125 ;; and thus not a real separator.
3133 :value value
3134 :args args
3135 :begin begin
3136 :end end
3140 "Interpret MACRO object as Org syntax.
3141 CONTENTS is nil."
3145 "Search for the next macro object.
3147 LIMIT bounds the search.
3149 Return value is cons cell whose CAR is `macro' and CDR is
3150 beginning position."
3154 limit t)
3158 ;;;; Radio-target
3161 "Parse radio target at point.
3163 Return a list whose CAR is `radio-target' and CDR a plist with
3164 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3165 and `:post-blank' as keywords.
3167 Assume point is at the radio target."
3179 :end end
3180 :contents-begin contents-begin
3181 :contents-end contents-end
3182 :post-blank post-blank
3186 "Interpret TARGET object as Org syntax.
3187 CONTENTS is the contents of the object."
3191 "Search for the next radio-target object.
3193 LIMIT bounds the search.
3195 Return value is a cons cell whose CAR is `radio-target' and CDR
3196 is beginning position."
3202 ;;;; Statistics Cookie
3205 "Parse statistics cookie at point.
3207 Return a list whose CAR is `statistics-cookie', and CDR a plist
3208 with `:begin', `:end', `:value' and `:post-blank' keywords.
3210 Assume point is at the beginning of the statistics-cookie."
3221 :end end
3222 :value value
3226 "Interpret STATISTICS-COOKIE object as Org syntax.
3227 CONTENTS is nil."
3231 "Search for the next statistics cookie object.
3233 LIMIT bounds the search.
3235 Return value is a cons cell whose CAR is `statistics-cookie' and
3236 CDR is beginning position."
3242 ;;;; Strike-Through
3245 "Parse strike-through object at point.
3247 Return a list whose CAR is `strike-through' and CDR is a plist
3248 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3249 `:post-blank' keywords.
3251 Assume point is at the first plus sign marker."
3263 :end end
3264 :contents-begin contents-begin
3265 :contents-end contents-end
3269 "Interpret STRIKE-THROUGH object as Org syntax.
3270 CONTENTS is the contents of the object."
3274 ;;;; Subscript
3277 "Parse subscript at point.
3279 Return a list whose CAR is `subscript' and CDR a plist with
3280 `:begin', `:end', `:contents-begin', `:contents-end',
3281 `:use-brackets-p' and `:post-blank' as keywords.
3283 Assume point is at the underscore."
3287 t
3298 :end end
3299 :use-brackets-p bracketsp
3300 :contents-begin contents-begin
3301 :contents-end contents-end
3305 "Interpret SUBSCRIPT object as Org syntax.
3306 CONTENTS is the contents of the object."
3309 contents))
3312 "Search for the next sub/superscript object.
3314 LIMIT bounds the search.
3316 Return value is a cons cell whose CAR is either `subscript' or
3317 `superscript' and CDR is beginning position."
3325 ;;;; Superscript
3328 "Parse superscript at point.
3330 Return a list whose CAR is `superscript' and CDR a plist with
3331 `:begin', `:end', `:contents-begin', `:contents-end',
3332 `:use-brackets-p' and `:post-blank' as keywords.
3334 Assume point is at the caret."
3348 :end end
3349 :use-brackets-p bracketsp
3350 :contents-begin contents-begin
3351 :contents-end contents-end
3355 "Interpret SUPERSCRIPT object as Org syntax.
3356 CONTENTS is the contents of the object."
3359 contents))
3362 ;;;; Table Cell
3365 "Parse table cell at point.
3367 Return a list whose CAR is `table-cell' and CDR is a plist
3368 containing `:begin', `:end', `:contents-begin', `:contents-end'
3369 and `:post-blank' keywords."
3377 :end end
3378 :contents-begin contents-begin
3379 :contents-end contents-end
3383 "Interpret TABLE-CELL element as Org syntax.
3384 CONTENTS is the contents of the cell, or nil."
3388 "Search for the next table-cell object.
3390 LIMIT bounds the search.
3392 Return value is a cons cell whose CAR is `table-cell' and CDR is
3393 beginning position."
3397 ;;;; Target
3400 "Parse target at point.
3402 Return a list whose CAR is `target' and CDR a plist with
3403 `:begin', `:end', `:value' and `:post-blank' as keywords.
3405 Assume point is at the target."
3415 :end end
3416 :value value
3420 "Interpret TARGET object as Org syntax.
3421 CONTENTS is nil."
3425 "Search for the next target object.
3427 LIMIT bounds the search.
3429 Return value is a cons cell whose CAR is `target' and CDR is
3430 beginning position."
3436 ;;;; Timestamp
3439 "Parse time stamp at point.
3441 Return a list whose CAR is `timestamp', and CDR a plist with
3442 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3444 Assume point is at the beginning of the timestamp."
3462 date-start)
3473 raw-value)
3475 :repeater-type
3481 :repeater-unit
3484 year-start month-start day-start hour-start minute-start year-end
3485 month-end day-end hour-end minute-end)
3486 ;; Parse date-start.
3494 ;; Compute date-end. It can be provided directly in time-stamp,
3495 ;; or extracted from time range. Otherwise, it defaults to the
3496 ;; same values as date-start.
3506 :raw-value raw-value
3507 :year-start year-start
3508 :month-start month-start
3509 :day-start day-start
3510 :hour-start hour-start
3511 :minute-start minute-start
3512 :year-end year-end
3513 :month-end month-end
3514 :day-end day-end
3515 :hour-end hour-end
3516 :minute-end minute-end
3517 :begin begin
3518 :end end
3520 repeater-props)))))
3523 "Interpret TIMESTAMP object as Org syntax.
3524 CONTENTS is nil."
3525 ;; Use `:raw-value' if specified.
3527 ;; Otherwise, build timestamp string.
3537 ;; Build an Org timestamp string from TIME. ACTIVEP is
3538 ;; non-nil when time stamp is active. If WITH-TIME-P is
3539 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3540 ;; specify a time range in the timestamp. REPEAT-STRING
3541 ;; is the repeater string, if any.
3545 org-time-stamp-formats)
3546 time)))
3552 nil nil ts)))
3556 " "
3557 repeat-string
3559 ;; Return value.
3560 ts)))
3572 build-ts-string
3591 0
3599 "--"
3611 "Search for the next timestamp object.
3613 LIMIT bounds the search.
3615 Return value is a cons cell whose CAR is `timestamp' and CDR is
3616 beginning position."
3624 limit t)
3628 ;;;; Underline
3631 "Parse underline object at point.
3633 Return a list whose CAR is `underline' and CDR is a plist with
3634 `:begin', `:end', `:contents-begin' and `:contents-end' and
3635 `:post-blank' keywords.
3637 Assume point is at the first underscore marker."
3649 :end end
3650 :contents-begin contents-begin
3651 :contents-end contents-end
3655 "Interpret UNDERLINE object as Org syntax.
3656 CONTENTS is the contents of the object."
3660 ;;;; Verbatim
3663 "Parse verbatim object at point.
3665 Return a list whose CAR is `verbatim' and CDR is a plist with
3666 `:value', `:begin', `:end' and `:post-blank' keywords.
3668 Assume point is at the first equal sign marker."
3679 :begin begin
3680 :end end
3684 "Interpret VERBATIM object as Org syntax.
3685 CONTENTS is nil."
3689 \f
3690 ;;; Parsing Element Starting At Point
3691 ;;
3692 ;; `org-element--current-element' is the core function of this section.
3693 ;; It returns the Lisp representation of the element starting at
3694 ;; point.
3695 ;;
3696 ;; `org-element--current-element' makes use of special modes. They
3697 ;; are activated for fixed element chaining (i.e. `plain-list' >
3698 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3699 ;; `section'). Special modes are: `first-section', `item',
3700 ;; `node-property', `quote-section', `section' and `table-row'.
3704 "Parse the element starting at point.
3706 LIMIT bounds the search.
3708 Return value is a list like (TYPE PROPS) where TYPE is the type
3709 of the element and PROPS a plist of properties associated to the
3710 element.
3712 Possible types are defined in `org-element-all-elements'.
3714 Optional argument GRANULARITY determines the depth of the
3715 recursion. Allowed values are `headline', `greater-element',
3716 `element', `object' or nil. When it is broader than `object' (or
3717 nil), secondary values will not be parsed, since they only
3718 contain objects.
3720 Optional argument SPECIAL, when non-nil, can be either
3721 `first-section', `item', `node-property', `quote-section',
3722 `section', and `table-row'.
3724 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3725 be computed.
3727 This function assumes point is always at the beginning of the
3728 element it has to parse."
3731 ;; Determine if parsing depth allows for secondary strings
3732 ;; parsing. It only applies to elements referenced in
3733 ;; `org-element-secondary-value-alist'.
3736 ;; Item.
3739 ;; Table Row.
3741 ;; Node Property.
3743 ;; Headline.
3746 ;; Sections (must be checked after headline).
3752 limit)))
3753 ;; When not at bol, point is at the beginning of an item or
3754 ;; a footnote definition: next item is always a paragraph.
3756 ;; Planning and Clock.
3761 ;; Inlinetask.
3764 ;; From there, elements can have affiliated keywords.
3767 ;; Jumping over affiliated keywords put point off-limits.
3768 ;; Parse them as regular keywords.
3772 ;; LaTeX Environment.
3775 ;; Drawer and Property Drawer.
3780 ;; Fixed Width
3783 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3784 ;; Keywords.
3793 org-element-block-name-alist)))
3808 ;; Footnote Definition.
3811 ;; Horizontal Rule.
3814 ;; Diary Sexp.
3817 ;; Table.
3819 ;; List.
3823 ;; Default element: Paragraph.
3827 ;; Most elements can have affiliated keywords. When looking for an
3828 ;; element beginning, we want to move before them, as they belong to
3829 ;; that element, and, in the meantime, collect information they give
3830 ;; into appropriate properties. Hence the following function.
3833 "Collect affiliated keywords from point down to LIMIT.
3835 Return a list whose CAR is the position at the first of them and
3836 CDR a plist of keywords and values and move point to the
3837 beginning of the first line after them.
3839 As a special case, if element doesn't start at the beginning of
3840 the line (i.e. a paragraph starting an item), CAR is current
3841 position of point and CDR is nil."
3845 ;; RESTRICT is the list of objects allowed in parsed
3846 ;; keywords value.
3848 output)
3851 ;; Apply translation to RAW-KWD. From there, KWD is
3852 ;; the official keyword.
3854 org-element-keyword-translation-alist))
3855 raw-kwd))
3856 ;; Find main value for any keyword.
3862 ;; PARSEDP is non-nil when keyword should have its
3863 ;; value parsed.
3865 ;; If KWD is a dual keyword, find its secondary
3866 ;; value. Maybe parse it.
3873 ;; Attribute a property name to KWD.
3875 ;; Now set final shape for VALUE.
3881 ;; Attributes can always appear on multiple lines.
3884 ;; Eventually store the new value in OUTPUT.
3886 ;; Move to next keyword.
3888 ;; If affiliated keywords are orphaned: move back to first one.
3889 ;; They will be parsed as a paragraph.
3891 ;; Return value.
3895 \f
3896 ;;; The Org Parser
3897 ;;
3898 ;; The two major functions here are `org-element-parse-buffer', which
3899 ;; parses Org syntax inside the current buffer, taking into account
3900 ;; region, narrowing, or even visibility if specified, and
3901 ;; `org-element-parse-secondary-string', which parses objects within
3902 ;; a given string.
3903 ;;
3904 ;; The (almost) almighty `org-element-map' allows to apply a function
3905 ;; on elements or objects matching some type, and accumulate the
3906 ;; resulting values. In an export situation, it also skips unneeded
3907 ;; parts of the parse tree.
3910 "Recursively parse the buffer and return structure.
3911 If narrowing is in effect, only parse the visible part of the
3912 buffer.
3914 Optional argument GRANULARITY determines the depth of the
3915 recursion. It can be set to the following symbols:
3917 `headline' Only parse headlines.
3918 `greater-element' Don't recurse into greater elements excepted
3919 headlines and sections. Thus, elements
3920 parsed are the top-level ones.
3921 `element' Parse everything but objects and plain text.
3922 `object' Parse the complete buffer (default).
3924 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3925 elements.
3927 An element or an objects is represented as a list with the
3928 pattern (TYPE PROPERTIES CONTENTS), where :
3930 TYPE is a symbol describing the element or object. See
3931 `org-element-all-elements' and `org-element-all-objects' for an
3932 exhaustive list of such symbols. One can retrieve it with
3933 `org-element-type' function.
3935 PROPERTIES is the list of attributes attached to the element or
3936 object, as a plist. Although most of them are specific to the
3937 element or object type, all types share `:begin', `:end',
3938 `:post-blank' and `:parent' properties, which respectively
3939 refer to buffer position where the element or object starts,
3940 ends, the number of white spaces or blank lines after it, and
3941 the element or object containing it. Properties values can be
3942 obtained by using `org-element-property' function.
3944 CONTENTS is a list of elements, objects or raw strings
3945 contained in the current element or object, when applicable.
3946 One can access them with `org-element-contents' function.
3948 The Org buffer has `org-data' as type and nil as properties.
3949 `org-element-map' function can be used to find specific elements
3950 or objects within the parse tree.
3952 This function assumes that current major mode is `org-mode'."
3958 ;; Start in `first-section' mode so text before the first
3959 ;; headline belongs to a section.
3963 "Recursively parse objects in STRING and return structure.
3965 RESTRICTION is a symbol limiting the object types that will be
3966 looked after.
3968 Optional argument PARENT, when non-nil, is the element or object
3969 containing the secondary string. It is used to set correctly
3970 `:parent' property within the string."
3971 ;; Copy buffer-local variables listed in
3972 ;; `org-element-object-variables' into temporary buffer. This is
3973 ;; required since object parsing is dependent on these variables.
3977 org-element-object-variables))))
3985 secondary))
3986 secondary))))
3990 "Map a function on selected elements or objects.
3992 DATA is an Org buffer parse tree, as returned by, i.e,
3993 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3994 of elements or objects types (see `org-element-all-elements' and
3995 `org-element-all-objects' for a complete list of types). FUN is
3996 the function called on the matching element or object. It has to
3997 accept one argument: the element or object itself.
3999 When optional argument INFO is non-nil, it should be a plist
4000 holding export options. In that case, parts of the parse tree
4001 not exportable according to that property list will be skipped.
4003 When optional argument FIRST-MATCH is non-nil, stop at the first
4004 match for which FUN doesn't return nil, and return that value.
4006 Optional argument NO-RECURSION is a symbol or a list of symbols
4007 representing elements or objects types. `org-element-map' won't
4008 enter any recursive element or object whose type belongs to that
4009 list. Though, FUN can still be applied on them.
4011 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4012 apply to matching objects within parsed affiliated keywords (see
4013 `org-element-parsed-keywords').
4015 Nil values returned from FUN do not appear in the results.
4018 Examples:
4019 --------
4021 Assuming TREE is a variable containing an Org buffer parse tree,
4022 the following example will return a flat list of all `src-block'
4023 and `example-block' elements in it:
4025 \(org-element-map tree '(example-block src-block) 'identity)
4027 The following snippet will find the first headline with a level
4030 \(org-element-map tree 'headline
4031 \(lambda (hl)
4032 \(and (= (org-element-property :level hl) 1)
4034 \(org-element-property :begin hl)))
4035 nil t)
4037 The next example will return a flat list of all `plain-list' type
4038 elements in TREE that are not a sub-list themselves:
4040 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4042 Eventually, this example will return a flat list of all `bold'
4043 type objects containing a `latex-snippet' type object, even
4044 looking into captions:
4046 \(org-element-map tree 'bold
4047 \(lambda (b)
4048 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4049 nil nil nil t)"
4050 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4053 ;; Recursion depth is determined by --CATEGORY.
4060 ;; If one object is found, the function
4061 ;; has to recurse into every object.
4064 ;; If one regular element is found, the
4065 ;; function has to recurse, at least,
4066 ;; into every element it encounters.
4069 types)
4070 category)))
4071 ;; Compute properties for affiliated keywords if necessary.
4076 org-element-affiliated-keywords)))
4077 --acc
4078 --walk-tree
4082 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4083 ;; holding contextual information.
4087 ;; Ignored element in an export context.
4089 ;; Secondary string: only objects can be found there.
4092 ;; Unconditionally enter parse trees.
4096 ;; Check if TYPE is matching among TYPES. If so,
4097 ;; apply FUN to --DATA and accumulate return value
4098 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4104 ;; If --DATA has a secondary string that can contain
4105 ;; objects with their type among TYPES, look into it.
4112 ;; If --DATA has any affiliated keywords and
4113 ;; WITH-AFFILIATED is non-nil, look for objects in
4114 ;; them.
4122 ;; Pay attention to the type of value.
4123 ;; Preserve order for multiple keywords.
4139 --affiliated-alist))
4140 ;; Determine if a recursion into --DATA is possible.
4142 ;; --TYPE is explicitly removed from recursion.
4144 ;; --DATA has no contents.
4146 ;; Looking for greater elements but --DATA is simply
4147 ;; an element or an object.
4150 ;; Looking for elements but --DATA is an object.
4153 ;; In any other case, map contents.
4157 ;; Return value in a proper order.
4161 ;; The following functions are internal parts of the parser.
4162 ;;
4163 ;; The first one, `org-element--parse-elements' acts at the element's
4164 ;; level.
4165 ;;
4166 ;; The second one, `org-element--parse-objects' applies on all objects
4167 ;; of a paragraph or a secondary string. It uses
4168 ;; `org-element--get-next-object-candidates' to optimize the search of
4169 ;; the next object in the buffer.
4170 ;;
4171 ;; More precisely, that function looks for every allowed object type
4172 ;; first. Then, it discards failed searches, keeps further matches,
4173 ;; and searches again types matched behind point, for subsequent
4174 ;; calls. Thus, searching for a given type fails only once, and every
4175 ;; object is searched only once at top level (but sometimes more for
4176 ;; nested types).
4180 "Parse elements between BEG and END positions.
4182 SPECIAL prioritize some elements over the others. It can be set
4183 to `first-section', `quote-section', `section' `item' or
4184 `table-row'.
4186 When value is `item', STRUCTURE will be used as the current list
4187 structure.
4189 GRANULARITY determines the depth of the recursion. See
4190 `org-element-parse-buffer' for more information.
4192 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4193 elements.
4195 Elements are accumulated into ACC."
4198 ;; When parsing only headlines, skip any text before first one.
4201 ;; Main loop start.
4203 ;; Find current element's type and parse it accordingly to
4204 ;; its category.
4206 end granularity special structure))
4210 ;; Fill ELEMENT contents by side-effect.
4212 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4213 ;; no contents, don't modify it.
4216 ;; Greater element: parse it between `contents-begin' and
4217 ;; `contents-end'. Make sure GRANULARITY allows the
4218 ;; recursion, or ELEMENT is an headline, in which case going
4219 ;; inside is mandatory, in order to get sub-level headings.
4227 ;; Possibly switch to a special mode.
4237 granularity visible-only element))
4238 ;; ELEMENT has contents. Parse objects inside, if
4239 ;; GRANULARITY allows it.
4245 ;; Return result.
4246 acc))
4249 "Parse objects between BEG and END and return recursive structure.
4251 Objects are accumulated in ACC.
4253 RESTRICTION is a list of object types which are allowed in the
4254 current object."
4260 end restriction candidates)))
4267 ;; 1. Text before any object. Untabify it.
4272 acc
4276 ;; 2. Object...
4279 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4280 ;; a recursive type.
4285 cont-beg
4292 ;; 3. Text after last object. Untabify it.
4296 acc
4300 ;; Result.
4301 acc)))
4304 "Return an alist of candidates for the next object.
4306 LIMIT bounds the search, and RESTRICTION narrows candidates to
4307 some object types.
4309 Return value is an alist whose CAR is position and CDR the object
4310 type, as a symbol.
4312 OBJECTS is the previous candidates alist."
4313 ;; Filter out any object found but not belonging to RESTRICTION.
4319 type)
4320 restriction)))
4321 objects))
4323 ;; If no previous result, search every object type in RESTRICTION.
4324 ;; Otherwise, keep potential candidates (old objects located after
4325 ;; point) and ask to search again those which had matched before.
4330 objects))
4331 ;; Call the appropriate successor function for each type to search
4332 ;; and accumulate matches.
4339 type))))
4342 types-to-search)
4343 ;; Return alist.
4344 next-candidates))
4347 \f
4348 ;;; Towards A Bijective Process
4349 ;;
4350 ;; The parse tree obtained with `org-element-parse-buffer' is really
4351 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4352 ;; interpreted and expanded into a string with canonical Org syntax.
4353 ;; Hence `org-element-interpret-data'.
4354 ;;
4355 ;; The function relies internally on
4356 ;; `org-element--interpret-affiliated-keywords'.
4358 ;;;###autoload
4360 "Interpret DATA as Org syntax.
4362 DATA is a parse tree, an element, an object or a secondary string
4363 to interpret.
4365 Optional argument PARENT is used for recursive calls. It contains
4366 the element or object containing data, or nil.
4368 Return Org syntax as a string."
4372 ;; Secondary string.
4377 ;; Full Org document.
4382 ;; Plain text: remove `:parent' text property from output.
4384 ;; Element/Object without contents.
4387 data nil))
4388 ;; Element/Object with contents.
4398 ;; Elements directly containing objects must
4399 ;; have their indentation normalized first.
4401 data
4402 ;; When normalizing first paragraph of an
4403 ;; item or a footnote-definition, ignore
4404 ;; first line's indentation.
4411 data
4413 contents)))))))
4415 ;; Build white spaces. If no `:post-blank' property is
4416 ;; specified, assume its value is 0.
4426 "Return ELEMENT's affiliated keywords as Org syntax.
4427 If there is no affiliated keyword, return the empty string."
4437 ": "
4440 value)
4448 ;; All attribute keywords can have multiple lines.
4454 ;; List all ELEMENT's properties matching an attribute line or an
4455 ;; affiliated keyword, but ignore translated keywords since they
4456 ;; cannot belong to the property list.
4463 org-element-keyword-translation-alist)))))
4464 collect prop)
4467 ;; Because interpretation of the parse tree must return the same
4468 ;; number of blank lines between elements and the same number of white
4469 ;; space after objects, some special care must be given to white
4470 ;; spaces.
4471 ;;
4472 ;; The first function, `org-element-normalize-string', ensures any
4473 ;; string different from the empty string will end with a single
4474 ;; newline character.
4475 ;;
4476 ;; The second function, `org-element-normalize-contents', removes
4477 ;; global indentation from the contents of the current element.
4480 "Ensure string S ends with a single newline character.
4482 If S isn't a string return it unchanged. If S is the empty
4483 string, return it. Otherwise, return a new string with a single
4484 newline character at its end."
4492 "Normalize plain text in ELEMENT's contents.
4494 ELEMENT must only contain plain text and objects.
4496 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4497 indentation to compute maximal common indentation.
4499 Return the normalized element that is element with global
4500 indentation removed from its contents. The function assumes that
4501 indentation is not done with TAB characters."
4503 collect-inds ; for byte-compiler
4506 ;; Return list of indentations within BLOB. This is done by
4507 ;; walking recursively BLOB and updating IND-LIST along the
4508 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4509 ;; been seen yet. It is required as this string is the only
4510 ;; one whose indentation doesn't happen after a newline
4511 ;; character.
4519 ;; An indentation of zero means no string will be
4520 ;; modified. Quit the process.
4526 ;; Avoid matching blank or empty lines.
4534 ;; Collect indentation list in ELEMENT. Possibly remove first
4535 ;; value if IGNORE-FIRST is non-nil.
4538 ;; Build ELEMENT back, replacing each string with the same
4539 ;; string minus common indentation.
4544 ;; Return BLOB with all its strings indentation
4545 ;; shortened from MCI white spaces. FIRST-FLAG is
4546 ;; non-nil when the first string hasn't been seen
4547 ;; yet.
4561 org-element-recursive-objects)
4565 blob))))
4569 \f
4570 ;;; The Toolbox
4571 ;;
4572 ;; The first move is to implement a way to obtain the smallest element
4573 ;; containing point. This is the job of `org-element-at-point'. It
4574 ;; basically jumps back to the beginning of section containing point
4575 ;; and moves, element after element, with
4576 ;; `org-element--current-element' until the container is found. Note:
4577 ;; When using `org-element-at-point', secondary values are never
4578 ;; parsed since the function focuses on elements, not on objects.
4579 ;;
4580 ;; At a deeper level, `org-element-context' lists all elements and
4581 ;; objects containing point.
4582 ;;
4583 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4584 ;; internally by navigation and manipulation tools.
4586 ;;;###autoload
4588 "Determine closest element around point.
4590 Return value is a list like (TYPE PROPS) where TYPE is the type
4591 of the element and PROPS a plist of properties associated to the
4592 element.
4594 Possible types are defined in `org-element-all-elements'.
4595 Properties depend on element or object type, but always include
4596 `:begin', `:end', `:parent' and `:post-blank' properties.
4598 As a special case, if point is at the very beginning of a list or
4599 sub-list, returned element will be that list instead of the first
4600 item. In the same way, if point is at the beginning of the first
4601 row of a table, returned element will be the table instead of the
4602 first row.
4604 If optional argument KEEP-TRAIL is non-nil, the function returns
4605 a list of elements leading to element at point. The list's CAR
4606 is always the element at point. The following positions contain
4607 element's siblings, then parents, siblings of parents, until the
4608 first element of current section."
4610 ;; If at an headline, parse it. It is the sole element that
4611 ;; doesn't require to know about context. Be sure to disallow
4612 ;; secondary string parsing, though.
4618 ;; Otherwise move at the beginning of the section containing
4619 ;; point.
4623 element type special-flag trail struct prevs parent)
4630 ;; Parse successively each element, skipping those ending
4631 ;; before original position.
4640 ;; 1. Skip any element ending before point. Also skip
4641 ;; element ending at point when we're sure that another
4642 ;; element has started.
4647 ;; 2. An element containing point is always the element at
4648 ;; point.
4651 ;; 3. At any other greater element type, if point is
4652 ;; within contents, move into it.
4657 ;; Create an anchor for tables and plain lists:
4658 ;; when point is at the very beginning of these
4659 ;; elements, ignoring affiliated keywords,
4660 ;; target them instead of their contents.
4662 ;; When point is at contents end, do not move
4663 ;; into elements with an explicit ending, but
4664 ;; return that element instead.
4668 drawer dynamic-block inlinetask item
4669 plain-list property-drawer quote-block
4670 special-block))))
4685 ;;;###autoload
4687 "Return closest element or object around point.
4689 Return value is a list like (TYPE PROPS) where TYPE is the type
4690 of the element or object and PROPS a plist of properties
4691 associated to it.
4693 Possible types are defined in `org-element-all-elements' and
4694 `org-element-all-objects'. Properties depend on element or
4695 object type, but always include `:begin', `:end', `:parent' and
4696 `:post-blank'.
4698 Optional argument ELEMENT, when non-nil, is the closest element
4699 containing point, as returned by `org-element-at-point'.
4700 Providing it allows for quicker computation."
4705 end)
4706 ;; Check if point is inside an element containing objects or at
4707 ;; a secondary string. In that case, move to beginning of the
4708 ;; element or secondary string and set END to the other side.
4715 org-element-parsed-keywords))
4716 ;; We're at an affiliated keyword. Change
4717 ;; type to retrieve correct restrictions.
4719 ;; Determine if we're at main or dual value.
4733 (<= origin
4734 ;; `1+' is required so some
4735 ;; successors can match
4736 ;; properly their object.
4757 element
4760 candidates)
4763 end restriction candidates))
4765 candidates)))
4766 ;; If ORIGIN is before next object in element, there's
4767 ;; no point in looking further.
4777 ;; ORIGIN is after OBJECT, so skip it.
4783 ;; ORIGIN is within a non-recursive object or at
4784 ;; an object boundaries: Return that object.
4788 ;; Otherwise, move within current object and
4789 ;; restrict search to the end of its contents.
4794 end cend)))))))
4795 parent))))))
4798 "Non-nil when elements ELEM-A and ELEM-B are nested."
4807 "Swap elements ELEM-A and ELEM-B.
4808 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4809 end of ELEM-A."
4811 ;; There are two special cases when an element doesn't start at bol:
4812 ;; the first paragraph in an item or in a footnote definition.
4814 ;; Only a paragraph without any affiliated keyword can be moved at
4815 ;; ELEM-A position in such a situation. Note that the case of
4816 ;; a footnote definition is impossible: it cannot contain two
4817 ;; paragraphs in a row because it cannot contain a blank line.
4823 ;; In a special situation, ELEM-A will have no indentation. We'll
4824 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4838 ;; Store overlays responsible for visibility status. We
4839 ;; also need to store their boundaries as they will be
4840 ;; removed from buffer.
4847 ;; Get contents.
4855 ;; Restore ex ELEM-A overlays.
4864 ;; Restore ex ELEM-B overlays.
4873 ;; Local variables:
4874 ;; generated-autoload-file: "org-loaddefs.el"
4875 ;; End:
4877 ;;; org-element.el ends here