| blob | 1c9ee9ff5fdb271b9a2e149bba66c984e10fc6f7 |
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 a 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 a headline.
731 Return a list whose CAR is `headline' and CDR is a plist
732 containing `:raw-value', `:title', `:optional-title', `:begin',
733 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
734 `:contents-end', `:level', `:priority', `:tags',
735 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
736 `:closed', `:quotedp', `:archivedp', `:commentedp' and
737 `:footnote-section-p' keywords.
739 The plist also contains any property set in the property drawer,
740 with its name in upper cases and colons added at the
741 beginning (i.e. `:CUSTOM_ID').
743 When RAW-SECONDARY-P is non-nil, headline's title will not be
744 parsed as a secondary string, but as a plain string instead.
746 Assume point is at beginning of the headline."
759 raw-value)))
763 raw-value)))
767 ;; Upcase property names. It avoids confusion between
768 ;; properties obtained through property drawer and default
769 ;; properties from the parser (e.g. `:end' and :END:)
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))))
854 headline :optional-title
859 headline :title
865 "Interpret HEADLINE element as Org syntax.
866 CONTENTS is the contents of the element."
893 ;; Align tags.
901 ? )
902 tags))
906 tags))))
908 contents)))
911 ;;;; Inlinetask
914 "Parse an inline task.
916 Return a list whose CAR is `inlinetask' and CDR is a plist
917 containing `:title', `:begin', `:end', `:hiddenp',
918 `:contents-begin' and `:contents-end', `:level', `:priority',
919 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
920 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
922 The plist also contains any property set in the property drawer,
923 with its name in upper cases and colons added at the
924 beginning (i.e. `:CUSTOM_ID').
926 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
927 title will not be parsed as a secondary string, but as a plain
928 string instead.
930 Assume point is at beginning of the inline task."
940 ;; Upcase property names. It avoids confusion between
941 ;; properties obtained through property drawer and default
942 ;; properties from the parser (e.g. `:end' and :END:)
952 plist))
954 ;; Read time properties on the line below the inlinetask
955 ;; opening string.
961 org-keyword-time-not-clock-regexp end t)
971 plist))))
991 :begin begin
992 :end end
993 :hiddenp hidden
994 :contents-begin contents-begin
995 :contents-end contents-end
998 :tags tags
999 :todo-keyword todo
1000 :todo-type todo-type
1002 time-props
1003 standard-props))))
1005 inlinetask :title
1008 raw-value
1010 inlinetask))))))
1013 "Interpret INLINETASK element as Org syntax.
1014 CONTENTS is the contents of inlinetask."
1029 ;; Align tags.
1037 ? )
1038 tags))
1042 tags))))
1043 ;; Prefer degenerate inlinetasks when there are no
1044 ;; contents.
1047 contents
1051 ;;;; Item
1054 "Parse an item.
1056 STRUCT is the structure of the plain list.
1058 Return a list whose CAR is `item' and CDR is a plist containing
1059 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1060 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1061 `:post-blank' keywords.
1063 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1064 any, will not be parsed as a secondary string, but as a plain
1065 string instead.
1067 Assume point is at the beginning of the item."
1091 ;; Ignore tags in un-ordered lists: they are just
1092 ;; a part of item's body.
1098 ;; If first line isn't empty, contents really start
1099 ;; at the text after item's meta-data.
1110 :begin begin
1111 :end end
1112 ;; CONTENTS-BEGIN and CONTENTS-END may be
1113 ;; mixed up in the case of an empty item
1114 ;; separated from the next by a blank line.
1115 ;; Thus ensure the former is always the
1116 ;; smallest.
1119 :checkbox checkbox
1120 :counter counter
1121 :hiddenp hidden
1122 :structure struct
1125 item :tag
1133 "Interpret ITEM element as Org syntax.
1134 CONTENTS is the contents of the element."
1140 ;; Compute indentation.
1145 ;; Indent contents.
1147 bullet
1160 ;;;; Plain List
1163 "Parse a plain list.
1165 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1166 the buffer position at the beginning of the first affiliated
1167 keyword and CDR is a plist of affiliated keywords along with
1168 their value. STRUCTURE is the structure of the plain list being
1169 parsed.
1171 Return a list whose CAR is `plain-list' and CDR is a plist
1172 containing `:type', `:begin', `:end', `:contents-begin' and
1173 `:contents-end', `:structure', `:post-blank' and
1174 `:post-affiliated' keywords.
1176 Assume point is at the beginning of the list."
1191 ;; Return value.
1195 :begin begin
1196 :end end
1197 :contents-begin contents-begin
1198 :contents-end contents-end
1199 :structure struct
1205 "Interpret PLAIN-LIST element as Org syntax.
1206 CONTENTS is the contents of the element."
1214 ;;;; Property Drawer
1217 "Parse a property drawer.
1219 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1220 the buffer position at the beginning of the first affiliated
1221 keyword and CDR is a plist of affiliated keywords along with
1222 their value.
1224 Return a list whose CAR is `property-drawer' and CDR is a plist
1225 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1226 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1228 Assume point is at the beginning of the property drawer."
1233 ;; Incomplete drawer: parse it as a paragraph.
1253 :end end
1254 :hiddenp hidden
1255 :contents-begin contents-begin
1256 :contents-end contents-end
1262 "Interpret PROPERTY-DRAWER element as Org syntax.
1263 CONTENTS is the properties within the drawer."
1267 ;;;; Quote Block
1270 "Parse a quote block.
1272 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1273 the buffer position at the beginning of the first affiliated
1274 keyword and CDR is a plist of affiliated keywords along with
1275 their value.
1277 Return a list whose CAR is `quote-block' and CDR is a plist
1278 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1279 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1281 Assume point is at the beginning of the block."
1285 ;; Incomplete block: parse it as a paragraph.
1291 ;; Empty blocks have no contents.
1306 :end end
1307 :hiddenp hidden
1308 :contents-begin contents-begin
1309 :contents-end contents-end
1315 "Interpret QUOTE-BLOCK element as Org syntax.
1316 CONTENTS is the contents of the element."
1320 ;;;; Section
1323 "Parse a section.
1325 LIMIT bounds the search.
1327 Return a list whose CAR is `section' and CDR is a plist
1328 containing `:begin', `:end', `:contents-begin', `contents-end'
1329 and `:post-blank' keywords."
1331 ;; Beginning of section is the beginning of the first non-blank
1332 ;; line after previous headline.
1341 :end end
1342 :contents-begin begin
1343 :contents-end pos-before-blank
1347 "Interpret SECTION element as Org syntax.
1348 CONTENTS is the contents of the element."
1349 contents)
1352 ;;;; Special Block
1355 "Parse a special block.
1357 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1358 the buffer position at the beginning of the first affiliated
1359 keyword and CDR is a plist of affiliated keywords along with
1360 their value.
1362 Return a list whose CAR is `special-block' and CDR is a plist
1363 containing `:type', `:begin', `:end', `:hiddenp',
1364 `:contents-begin', `:contents-end', `:post-blank' and
1365 `:post-affiliated' keywords.
1367 Assume point is at the beginning of the block."
1374 ;; Incomplete block: parse it as a paragraph.
1380 ;; Empty blocks have no contents.
1395 :begin begin
1396 :end end
1397 :hiddenp hidden
1398 :contents-begin contents-begin
1399 :contents-end contents-end
1405 "Interpret SPECIAL-BLOCK element as Org syntax.
1406 CONTENTS is the contents of the element."
1411 \f
1412 ;;; Elements
1413 ;;
1414 ;; For each element, a parser and an interpreter are also defined.
1415 ;; Both follow the same naming convention used for greater elements.
1416 ;;
1417 ;; Also, as for greater elements, adding a new element type is done
1418 ;; through the following steps: implement a parser and an interpreter,
1419 ;; tweak `org-element--current-element' so that it recognizes the new
1420 ;; type and add that new type to `org-element-all-elements'.
1421 ;;
1422 ;; As a special case, when the newly defined type is a block type,
1423 ;; `org-element-block-name-alist' has to be modified accordingly.
1426 ;;;; Babel Call
1429 "Parse a babel call.
1431 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1432 the buffer position at the beginning of the first affiliated
1433 keyword and CDR is a plist of affiliated keywords along with
1434 their value.
1436 Return a list whose CAR is `babel-call' and CDR is a plist
1437 containing `:begin', `:end', `:info', `:post-blank' and
1438 `:post-affiliated' as keywords."
1452 :end end
1453 :info info
1459 "Interpret BABEL-CALL element as Org syntax.
1460 CONTENTS is nil."
1466 ;; Remove redundant square brackets.
1471 ;;;; Clock
1474 "Parse a clock.
1476 LIMIT bounds the search.
1478 Return a list whose CAR is `clock' and CDR is a plist containing
1479 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1480 as keywords."
1500 :value value
1501 :duration duration
1502 :begin begin
1503 :end end
1507 "Interpret CLOCK element as Org syntax.
1508 CONTENTS is nil."
1516 "%2s:%02s"
1520 ;;;; Comment
1523 "Parse a comment.
1525 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1526 the buffer position at the beginning of the first affiliated
1527 keyword and CDR is a plist of affiliated keywords along with
1528 their value.
1530 Return a list whose CAR is `comment' and CDR is a plist
1531 containing `:begin', `:end', `:value', `:post-blank',
1532 `:post-affiliated' keywords.
1534 Assume point is at comment beginning."
1543 ;; Get comments ending.
1546 ;; Accumulate lines without leading hash and first
1547 ;; whitespace.
1562 :end end
1563 :value value
1569 "Interpret COMMENT element as Org syntax.
1570 CONTENTS is nil."
1574 ;;;; Comment Block
1577 "Parse an export block.
1579 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1580 the buffer position at the beginning of the first affiliated
1581 keyword and CDR is a plist of affiliated keywords along with
1582 their value.
1584 Return a list whose CAR is `comment-block' and CDR is a plist
1585 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1586 and `:post-affiliated' keywords.
1588 Assume point is at comment block beginning."
1592 ;; Incomplete block: parse it as a paragraph.
1607 contents-begin contents-end)))
1611 :end end
1612 :value value
1613 :hiddenp hidden
1619 "Interpret COMMENT-BLOCK element as Org syntax.
1620 CONTENTS is nil."
1625 ;;;; Diary Sexp
1628 "Parse a diary sexp.
1630 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1631 the buffer position at the beginning of the first affiliated
1632 keyword and CDR is a plist of affiliated keywords along with
1633 their value.
1635 Return a list whose CAR is `diary-sexp' and CDR is a plist
1636 containing `:begin', `:end', `:value', `:post-blank' and
1637 `:post-affiliated' keywords."
1650 :begin begin
1651 :end end
1657 "Interpret DIARY-SEXP as Org syntax.
1658 CONTENTS is nil."
1662 ;;;; Example Block
1665 "Parse an example block.
1667 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1668 the buffer position at the beginning of the first affiliated
1669 keyword and CDR is a plist of affiliated keywords along with
1670 their value.
1672 Return a list whose CAR is `example-block' and CDR is a plist
1673 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1674 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1675 `:switches', `:value', `:post-blank' and `:post-affiliated'
1676 keywords."
1680 ;; Incomplete block: parse it as a paragraph.
1687 ;; Switches analysis
1692 ;; Should labels be retained in (or stripped from) example
1693 ;; blocks?
1698 ;; What should code-references use - labels or
1699 ;; line-numbers?
1706 ;; Standard block parsing.
1713 contents-begin contents-end)))
1723 :end end
1724 :value value
1725 :switches switches
1726 :number-lines number-lines
1727 :preserve-indent preserve-indent
1728 :retain-labels retain-labels
1729 :use-labels use-labels
1730 :label-fmt label-fmt
1731 :hiddenp hidden
1737 "Interpret EXAMPLE-BLOCK element as Org syntax.
1738 CONTENTS is nil."
1747 ;;;; Export Block
1750 "Parse an export block.
1752 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1753 the buffer position at the beginning of the first affiliated
1754 keyword and CDR is a plist of affiliated keywords along with
1755 their value.
1757 Return a list whose CAR is `export-block' and CDR is a plist
1758 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1759 `:post-blank' and `:post-affiliated' keywords.
1761 Assume point is at export-block beginning."
1768 ;; Incomplete block: parse it as a paragraph.
1783 contents-end)))
1787 :end end
1788 :type type
1789 :value value
1790 :hiddenp hidden
1796 "Interpret EXPORT-BLOCK element as Org syntax.
1797 CONTENTS is nil."
1804 ;;;; Fixed-width
1807 "Parse a fixed-width section.
1809 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1810 the buffer position at the beginning of the first affiliated
1811 keyword and CDR is a plist of affiliated keywords along with
1812 their value.
1814 Return a list whose CAR is `fixed-width' and CDR is a plist
1815 containing `:begin', `:end', `:value', `:post-blank' and
1816 `:post-affiliated' keywords.
1818 Assume point is at the beginning of the fixed-width area."
1822 value
1827 ;; Accumulate text without starting colons.
1841 :end end
1842 :value value
1848 "Interpret FIXED-WIDTH element as Org syntax.
1849 CONTENTS is nil."
1854 ;;;; Horizontal Rule
1857 "Parse an horizontal rule.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1862 their value.
1864 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1865 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1866 keywords."
1877 :end end
1883 "Interpret HORIZONTAL-RULE element as Org syntax.
1884 CONTENTS is nil."
1888 ;;;; Keyword
1891 "Parse a keyword at point.
1893 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1894 the buffer position at the beginning of the first affiliated
1895 keyword and CDR is a plist of affiliated keywords along with
1896 their value.
1898 Return a list whose CAR is `keyword' and CDR is a plist
1899 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1900 `:post-affiliated' keywords."
1915 :value value
1916 :begin begin
1917 :end end
1923 "Interpret KEYWORD element as Org syntax.
1924 CONTENTS is nil."
1930 ;;;; Latex Environment
1933 "Parse a LaTeX environment.
1935 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1936 the buffer position at the beginning of the first affiliated
1937 keyword and CDR is a plist of affiliated keywords along with
1938 their value.
1940 Return a list whose CAR is `latex-environment' and CDR is a plist
1941 containing `:begin', `:end', `:value', `:post-blank' and
1942 `:post-affiliated' keywords.
1944 Assume point is at the beginning of the latex environment."
1951 limit t))
1952 ;; Incomplete latex environment: parse it as a paragraph.
1963 :end end
1964 :value value
1970 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1971 CONTENTS is nil."
1975 ;;;; Node Property
1978 "Parse a node-property at point.
1980 LIMIT bounds the search.
1982 Return a list whose CAR is `node-property' and CDR is a plist
1983 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1984 keywords."
1996 :value value
1997 :begin begin
1998 :end end
2002 "Interpret NODE-PROPERTY element as Org syntax.
2003 CONTENTS is nil."
2009 ;;;; Paragraph
2012 "Parse a paragraph.
2014 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2015 the buffer position at the beginning of the first affiliated
2016 keyword and CDR is a plist of affiliated keywords along with
2017 their value.
2019 Return a list whose CAR is `paragraph' and CDR is a plist
2020 containing `:begin', `:end', `:contents-begin' and
2021 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2023 Assume point is at the beginning of the paragraph."
2032 limit
2033 ;; A matching `org-element-paragraph-separate' is not
2034 ;; necessarily the end of the paragraph. In
2035 ;; particular, lines starting with # or : as a first
2036 ;; non-space character are ambiguous. We have check
2037 ;; if they are valid Org syntax (i.e. not an
2038 ;; incomplete keyword).
2042 ;; There's no ambiguity for other symbols or
2043 ;; empty lines: stop here.
2045 ;; Stop at valid fixed-width areas.
2047 ;; Stop at drawers.
2052 ;; Stop at valid comments.
2054 ;; Stop at valid dynamic blocks.
2059 ;; Stop at valid blocks.
2066 limit t)))
2067 ;; Stop at valid latex environments.
2074 limit t)))
2075 ;; Stop at valid keywords.
2077 ;; Skip everything else.
2095 :end end
2096 :contents-begin contents-begin
2097 :contents-end contents-end
2103 "Interpret PARAGRAPH element as Org syntax.
2104 CONTENTS is the contents of the element."
2105 contents)
2108 ;;;; Planning
2111 "Parse a planning.
2113 LIMIT bounds the search.
2115 Return a list whose CAR is `planning' and CDR is a plist
2116 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2117 and `:post-blank' keywords."
2127 closed deadline scheduled)
2139 :deadline deadline
2140 :scheduled scheduled
2141 :begin begin
2142 :end end
2146 "Interpret PLANNING element as Org syntax.
2147 CONTENTS is nil."
2149 'identity
2166 ;;;; Quote Section
2169 "Parse a quote section.
2171 LIMIT bounds the search.
2173 Return a list whose CAR is `quote-section' and CDR is a plist
2174 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2176 Assume point is at beginning of the section."
2187 :end end
2188 :value value
2192 "Interpret QUOTE-SECTION element as Org syntax.
2193 CONTENTS is nil."
2197 ;;;; Src Block
2200 "Parse a src block.
2202 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2203 the buffer position at the beginning of the first affiliated
2204 keyword and CDR is a plist of affiliated keywords along with
2205 their value.
2207 Return a list whose CAR is `src-block' and CDR is a plist
2208 containing `:language', `:switches', `:parameters', `:begin',
2209 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2210 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2211 `:post-blank' and `:post-affiliated' keywords.
2213 Assume point is at the beginning of the block."
2216 limit t)))
2217 ;; Incomplete block: parse it as a paragraph.
2223 ;; Get language as a string.
2232 ;; Get switches.
2234 ;; Get parameters.
2236 ;; Switches analysis
2244 ;; Should labels be retained in (or stripped from)
2245 ;; src blocks?
2250 ;; What should code-references use - labels or
2251 ;; line-numbers?
2255 ;; Get visibility status.
2257 ;; Retrieve code.
2263 ;; Get position after ending blank lines.
2274 :begin begin
2275 :end end
2276 :number-lines number-lines
2277 :preserve-indent preserve-indent
2278 :retain-labels retain-labels
2279 :use-labels use-labels
2280 :label-fmt label-fmt
2281 :hiddenp hidden
2282 :value value
2288 "Interpret SRC-BLOCK element as Org syntax.
2289 CONTENTS is nil."
2312 ;;;; Table
2315 "Parse a table at point.
2317 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2318 the buffer position at the beginning of the first affiliated
2319 keyword and CDR is a plist of affiliated keywords along with
2320 their value.
2322 Return a list whose CAR is `table' and CDR is a plist containing
2323 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2324 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2325 keywords.
2327 Assume point is at the beginning of the table."
2341 acc))
2349 :end end
2350 :type type
2351 :tblfm tblfm
2352 ;; Only `org' tables have contents. `table.el' tables
2353 ;; use a `:value' property to store raw table as
2354 ;; a string.
2359 table-begin table-end))
2365 "Interpret TABLE element as Org syntax.
2366 CONTENTS is nil."
2377 ;;;; Table Row
2380 "Parse table row at point.
2382 LIMIT bounds the search.
2384 Return a list whose CAR is `table-row' and CDR is a plist
2385 containing `:begin', `:end', `:contents-begin', `:contents-end',
2386 `:type' and `:post-blank' keywords."
2390 ;; A table rule has no contents. In that case, ensure
2391 ;; CONTENTS-BEGIN matches CONTENTS-END.
2403 :begin begin
2404 :end end
2405 :contents-begin contents-begin
2406 :contents-end contents-end
2410 "Interpret TABLE-ROW element as Org syntax.
2411 CONTENTS is the contents of the table row."
2416 ;;;; Verse Block
2419 "Parse a verse block.
2421 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2422 the buffer position at the beginning of the first affiliated
2423 keyword and CDR is a plist of affiliated keywords along with
2424 their value.
2426 Return a list whose CAR is `verse-block' and CDR is a plist
2427 containing `:begin', `:end', `:contents-begin', `:contents-end',
2428 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2430 Assume point is at beginning of the block."
2434 ;; Incomplete block: parse it as a paragraph.
2451 :end end
2452 :contents-begin contents-begin
2453 :contents-end contents-end
2454 :hiddenp hidden
2460 "Interpret VERSE-BLOCK element as Org syntax.
2461 CONTENTS is verse block contents."
2465 \f
2466 ;;; Objects
2467 ;;
2468 ;; Unlike to elements, interstices can be found between objects.
2469 ;; That's why, along with the parser, successor functions are provided
2470 ;; for each object. Some objects share the same successor (i.e. `code'
2471 ;; and `verbatim' objects).
2472 ;;
2473 ;; A successor must accept a single argument bounding the search. It
2474 ;; will return either a cons cell whose CAR is the object's type, as
2475 ;; a symbol, and CDR the position of its next occurrence, or nil.
2476 ;;
2477 ;; Successors follow the naming convention:
2478 ;; org-element-NAME-successor, where NAME is the name of the
2479 ;; successor, as defined in `org-element-all-successors'.
2480 ;;
2481 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2482 ;; object types they can contain will be specified in
2483 ;; `org-element-object-restrictions'.
2484 ;;
2485 ;; Adding a new type of object is simple. Implement a successor,
2486 ;; a parser, and an interpreter for it, all following the naming
2487 ;; convention. Register type in `org-element-all-objects' and
2488 ;; successor in `org-element-all-successors'. Maybe tweak
2489 ;; restrictions about it, and that's it.
2492 ;;;; Bold
2495 "Parse bold object at point.
2497 Return a list whose CAR is `bold' and CDR is a plist with
2498 `:begin', `:end', `:contents-begin' and `:contents-end' and
2499 `:post-blank' keywords.
2501 Assume point is at the first star marker."
2513 :end end
2514 :contents-begin contents-begin
2515 :contents-end contents-end
2519 "Interpret BOLD object as Org syntax.
2520 CONTENTS is the contents of the object."
2524 "Search for the next text-markup object.
2526 LIMIT bounds the search.
2528 Return value is a cons cell whose CAR is a symbol among `bold',
2529 `italic', `underline', `strike-through', `code' and `verbatim'
2530 and CDR is beginning position."
2546 ;;;; Code
2549 "Parse code object at point.
2551 Return a list whose CAR is `code' and CDR is a plist with
2552 `:value', `:begin', `:end' and `:post-blank' keywords.
2554 Assume point is at the first tilde marker."
2565 :begin begin
2566 :end end
2570 "Interpret CODE object as Org syntax.
2571 CONTENTS is nil."
2575 ;;;; Entity
2578 "Parse entity at point.
2580 Return a list whose CAR is `entity' and CDR a plist with
2581 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2582 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2583 keywords.
2585 Assume point is at the beginning of the entity."
2587 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2603 :begin begin
2604 :end end
2605 :use-brackets-p bracketsp
2609 "Interpret ENTITY object as Org syntax.
2610 CONTENTS is nil."
2616 "Search for the next latex-fragment or entity object.
2618 LIMIT bounds the search.
2620 Return value is a cons cell whose CAR is `entity' or
2621 `latex-fragment' and CDR is beginning position."
2626 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2633 limit t)
2636 ;; Determine if it's a real entity or a LaTeX command.
2639 ;; No entity nor command: point is at a LaTeX fragment.
2640 ;; Determine its type to get the correct beginning position.
2648 matchers)
2652 ;;;; Export Snippet
2655 "Parse export snippet at point.
2657 Return a list whose CAR is `export-snippet' and CDR a plist with
2658 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2659 keywords.
2661 Assume point is at the beginning of the snippet."
2673 :value value
2674 :begin begin
2675 :end end
2679 "Interpret EXPORT-SNIPPET object as Org syntax.
2680 CONTENTS is nil."
2686 "Search for the next export-snippet object.
2688 LIMIT bounds the search.
2690 Return value is a cons cell whose CAR is `export-snippet' and CDR
2691 its beginning position."
2700 ;;;; Footnote Reference
2703 "Parse footnote reference at point.
2705 Return a list whose CAR is `footnote-reference' and CDR a plist
2706 with `:label', `:type', `:inline-definition', `:begin', `:end'
2707 and `:post-blank' as keywords."
2729 :type type
2730 :begin begin
2731 :end end
2734 footnote-reference :inline-definition
2739 footnote-reference))))))
2742 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2743 CONTENTS is nil."
2753 "Search for the next footnote-reference object.
2755 LIMIT bounds the search.
2757 Return value is a cons cell whose CAR is `footnote-reference' and
2758 CDR is beginning position."
2772 ;;;; Inline Babel Call
2775 "Parse inline babel call at point.
2777 Return a list whose CAR is `inline-babel-call' and CDR a plist
2778 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2780 Assume point is at the beginning of the babel call."
2791 :end end
2792 :info info
2796 "Interpret INLINE-BABEL-CALL object as Org syntax.
2797 CONTENTS is nil."
2803 ;; Remove redundant square brackets.
2806 main-source)
2810 "Search for the next inline-babel-call object.
2812 LIMIT bounds the search.
2814 Return value is a cons cell whose CAR is `inline-babel-call' and
2815 CDR is beginning position."
2817 ;; Use a simplified version of
2818 ;; `org-babel-inline-lob-one-liner-regexp'.
2821 limit t)
2825 ;;;; Inline Src Block
2828 "Parse inline source block at point.
2830 LIMIT bounds the search.
2832 Return a list whose CAR is `inline-src-block' and CDR a plist
2833 with `:begin', `:end', `:language', `:value', `:parameters' and
2834 `:post-blank' as keywords.
2836 Assume point is at the beginning of the inline src block."
2849 :value value
2850 :parameters parameters
2851 :begin begin
2852 :end end
2856 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2857 CONTENTS is nil."
2862 language
2864 body)))
2867 "Search for the next inline-babel-call element.
2869 LIMIT bounds the search.
2871 Return value is a cons cell whose CAR is `inline-babel-call' and
2872 CDR is beginning position."
2878 ;;;; Italic
2881 "Parse italic object at point.
2883 Return a list whose CAR is `italic' and CDR is a plist with
2884 `:begin', `:end', `:contents-begin' and `:contents-end' and
2885 `:post-blank' keywords.
2887 Assume point is at the first slash marker."
2899 :end end
2900 :contents-begin contents-begin
2901 :contents-end contents-end
2905 "Interpret ITALIC object as Org syntax.
2906 CONTENTS is the contents of the object."
2910 ;;;; Latex Fragment
2913 "Parse latex fragment at point.
2915 Return a list whose CAR is `latex-fragment' and CDR a plist with
2916 `:value', `:begin', `:end', and `:post-blank' as keywords.
2918 Assume point is at the beginning of the latex fragment."
2932 ;; None found: it's a macro.
2941 :begin begin
2942 :end end
2946 "Interpret LATEX-FRAGMENT object as Org syntax.
2947 CONTENTS is nil."
2950 ;;;; Line Break
2953 "Parse line break at point.
2955 Return a list whose CAR is `line-break', and CDR a plist with
2956 `:begin', `:end' and `:post-blank' keywords.
2958 Assume point is at the beginning of the line break."
2965 "Interpret LINE-BREAK object as Org syntax.
2966 CONTENTS is nil."
2970 "Search for the next line-break object.
2972 LIMIT bounds the search.
2974 Return value is a cons cell whose CAR is `line-break' and CDR is
2975 beginning position."
2979 ;; A line break can only happen on a non-empty line.
2984 ;;;; Link
2987 "Parse link at point.
2989 Return a list whose CAR is `link' and CDR a plist with `:type',
2990 `:path', `:raw-link', `:application', `:search-option', `:begin',
2991 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2992 keywords.
2994 Assume point is at the beginning of the link."
2997 end contents-begin contents-end link-end post-blank path type
2998 raw-link link search-option application)
3000 ;; Type 1: Text targeted from a radio target.
3005 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3010 ;; RAW-LINK is the original link. Expand any
3011 ;; abbreviation in it.
3016 ;; Determine TYPE of link and set PATH accordingly.
3018 ;; File type.
3021 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3024 ;; Id type: PATH is the id.
3027 ;; Code-ref type: PATH is the name of the reference.
3030 ;; Custom-id type: PATH is the name of the custom id.
3033 ;; Fuzzy type: Internal link either matches a target, an
3034 ;; headline name or nothing. PATH is the target or
3035 ;; headline's name.
3037 ;; Type 3: Plain link, i.e. http://orgmode.org
3043 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3050 ;; In any case, deduce end point after trailing white space from
3051 ;; LINK-END variable.
3054 ;; Extract search option and opening application out of
3055 ;; "file"-type links.
3057 ;; Application.
3062 ;; Extract search option from PATH.
3066 ;; Make sure TYPE always report "file".
3070 :path path
3072 :application application
3073 :search-option search-option
3074 :begin begin
3075 :end end
3076 :contents-begin contents-begin
3077 :contents-end contents-end
3081 "Interpret LINK object as Org syntax.
3082 CONTENTS is the contents of the object, or nil."
3087 raw-link
3091 "Search for the next link object.
3093 LIMIT bounds the search.
3095 Return value is a cons cell whose CAR is `link' and CDR is
3096 beginning position."
3105 ;;;; Macro
3108 "Parse macro at point.
3110 Return a list whose CAR is `macro' and CDR a plist with `:key',
3111 `:args', `:begin', `:end', `:value' and `:post-blank' as
3112 keywords.
3114 Assume point is at the macro."
3125 ;; Do not use `org-split-string' since empty
3126 ;; strings are meaningful here.
3130 ;; Repair bad splits, when comma is protected,
3131 ;; and thus not a real separator.
3139 :value value
3140 :args args
3141 :begin begin
3142 :end end
3146 "Interpret MACRO object as Org syntax.
3147 CONTENTS is nil."
3151 "Search for the next macro object.
3153 LIMIT bounds the search.
3155 Return value is cons cell whose CAR is `macro' and CDR is
3156 beginning position."
3160 limit t)
3164 ;;;; Radio-target
3167 "Parse radio target at point.
3169 Return a list whose CAR is `radio-target' and CDR a plist with
3170 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3171 and `:post-blank' as keywords.
3173 Assume point is at the radio target."
3185 :end end
3186 :contents-begin contents-begin
3187 :contents-end contents-end
3188 :post-blank post-blank
3192 "Interpret TARGET object as Org syntax.
3193 CONTENTS is the contents of the object."
3197 "Search for the next radio-target object.
3199 LIMIT bounds the search.
3201 Return value is a cons cell whose CAR is `radio-target' and CDR
3202 is beginning position."
3208 ;;;; Statistics Cookie
3211 "Parse statistics cookie at point.
3213 Return a list whose CAR is `statistics-cookie', and CDR a plist
3214 with `:begin', `:end', `:value' and `:post-blank' keywords.
3216 Assume point is at the beginning of the statistics-cookie."
3227 :end end
3228 :value value
3232 "Interpret STATISTICS-COOKIE object as Org syntax.
3233 CONTENTS is nil."
3237 "Search for the next statistics cookie object.
3239 LIMIT bounds the search.
3241 Return value is a cons cell whose CAR is `statistics-cookie' and
3242 CDR is beginning position."
3248 ;;;; Strike-Through
3251 "Parse strike-through object at point.
3253 Return a list whose CAR is `strike-through' and CDR is a plist
3254 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3255 `:post-blank' keywords.
3257 Assume point is at the first plus sign marker."
3269 :end end
3270 :contents-begin contents-begin
3271 :contents-end contents-end
3275 "Interpret STRIKE-THROUGH object as Org syntax.
3276 CONTENTS is the contents of the object."
3280 ;;;; Subscript
3283 "Parse subscript at point.
3285 Return a list whose CAR is `subscript' and CDR a plist with
3286 `:begin', `:end', `:contents-begin', `:contents-end',
3287 `:use-brackets-p' and `:post-blank' as keywords.
3289 Assume point is at the underscore."
3293 t
3304 :end end
3305 :use-brackets-p bracketsp
3306 :contents-begin contents-begin
3307 :contents-end contents-end
3311 "Interpret SUBSCRIPT object as Org syntax.
3312 CONTENTS is the contents of the object."
3315 contents))
3318 "Search for the next sub/superscript object.
3320 LIMIT bounds the search.
3322 Return value is a cons cell whose CAR is either `subscript' or
3323 `superscript' and CDR is beginning position."
3331 ;;;; Superscript
3334 "Parse superscript at point.
3336 Return a list whose CAR is `superscript' and CDR a plist with
3337 `:begin', `:end', `:contents-begin', `:contents-end',
3338 `:use-brackets-p' and `:post-blank' as keywords.
3340 Assume point is at the caret."
3354 :end end
3355 :use-brackets-p bracketsp
3356 :contents-begin contents-begin
3357 :contents-end contents-end
3361 "Interpret SUPERSCRIPT object as Org syntax.
3362 CONTENTS is the contents of the object."
3365 contents))
3368 ;;;; Table Cell
3371 "Parse table cell at point.
3373 Return a list whose CAR is `table-cell' and CDR is a plist
3374 containing `:begin', `:end', `:contents-begin', `:contents-end'
3375 and `:post-blank' keywords."
3383 :end end
3384 :contents-begin contents-begin
3385 :contents-end contents-end
3389 "Interpret TABLE-CELL element as Org syntax.
3390 CONTENTS is the contents of the cell, or nil."
3394 "Search for the next table-cell object.
3396 LIMIT bounds the search.
3398 Return value is a cons cell whose CAR is `table-cell' and CDR is
3399 beginning position."
3403 ;;;; Target
3406 "Parse target at point.
3408 Return a list whose CAR is `target' and CDR a plist with
3409 `:begin', `:end', `:value' and `:post-blank' as keywords.
3411 Assume point is at the target."
3421 :end end
3422 :value value
3426 "Interpret TARGET object as Org syntax.
3427 CONTENTS is nil."
3431 "Search for the next target object.
3433 LIMIT bounds the search.
3435 Return value is a cons cell whose CAR is `target' and CDR is
3436 beginning position."
3442 ;;;; Timestamp
3445 "Parse time stamp at point.
3447 Return a list whose CAR is `timestamp', and CDR a plist with
3448 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3450 Assume point is at the beginning of the timestamp."
3468 date-start)
3479 raw-value)
3481 :repeater-type
3487 :repeater-unit
3490 year-start month-start day-start hour-start minute-start year-end
3491 month-end day-end hour-end minute-end)
3492 ;; Parse date-start.
3500 ;; Compute date-end. It can be provided directly in time-stamp,
3501 ;; or extracted from time range. Otherwise, it defaults to the
3502 ;; same values as date-start.
3512 :raw-value raw-value
3513 :year-start year-start
3514 :month-start month-start
3515 :day-start day-start
3516 :hour-start hour-start
3517 :minute-start minute-start
3518 :year-end year-end
3519 :month-end month-end
3520 :day-end day-end
3521 :hour-end hour-end
3522 :minute-end minute-end
3523 :begin begin
3524 :end end
3526 repeater-props)))))
3529 "Interpret TIMESTAMP object as Org syntax.
3530 CONTENTS is nil."
3531 ;; Use `:raw-value' if specified.
3533 ;; Otherwise, build timestamp string.
3543 ;; Build an Org timestamp string from TIME. ACTIVEP is
3544 ;; non-nil when time stamp is active. If WITH-TIME-P is
3545 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3546 ;; specify a time range in the timestamp. REPEAT-STRING
3547 ;; is the repeater string, if any.
3551 org-time-stamp-formats)
3552 time)))
3558 nil nil ts)))
3562 " "
3563 repeat-string
3565 ;; Return value.
3566 ts)))
3578 build-ts-string
3597 0
3605 "--"
3617 "Search for the next timestamp object.
3619 LIMIT bounds the search.
3621 Return value is a cons cell whose CAR is `timestamp' and CDR is
3622 beginning position."
3630 limit t)
3634 ;;;; Underline
3637 "Parse underline object at point.
3639 Return a list whose CAR is `underline' and CDR is a plist with
3640 `:begin', `:end', `:contents-begin' and `:contents-end' and
3641 `:post-blank' keywords.
3643 Assume point is at the first underscore marker."
3655 :end end
3656 :contents-begin contents-begin
3657 :contents-end contents-end
3661 "Interpret UNDERLINE object as Org syntax.
3662 CONTENTS is the contents of the object."
3666 ;;;; Verbatim
3669 "Parse verbatim object at point.
3671 Return a list whose CAR is `verbatim' and CDR is a plist with
3672 `:value', `:begin', `:end' and `:post-blank' keywords.
3674 Assume point is at the first equal sign marker."
3685 :begin begin
3686 :end end
3690 "Interpret VERBATIM object as Org syntax.
3691 CONTENTS is nil."
3695 \f
3696 ;;; Parsing Element Starting At Point
3697 ;;
3698 ;; `org-element--current-element' is the core function of this section.
3699 ;; It returns the Lisp representation of the element starting at
3700 ;; point.
3701 ;;
3702 ;; `org-element--current-element' makes use of special modes. They
3703 ;; are activated for fixed element chaining (i.e. `plain-list' >
3704 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3705 ;; `section'). Special modes are: `first-section', `item',
3706 ;; `node-property', `quote-section', `section' and `table-row'.
3710 "Parse the element starting at point.
3712 LIMIT bounds the search.
3714 Return value is a list like (TYPE PROPS) where TYPE is the type
3715 of the element and PROPS a plist of properties associated to the
3716 element.
3718 Possible types are defined in `org-element-all-elements'.
3720 Optional argument GRANULARITY determines the depth of the
3721 recursion. Allowed values are `headline', `greater-element',
3722 `element', `object' or nil. When it is broader than `object' (or
3723 nil), secondary values will not be parsed, since they only
3724 contain objects.
3726 Optional argument SPECIAL, when non-nil, can be either
3727 `first-section', `item', `node-property', `quote-section',
3728 `section', and `table-row'.
3730 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3731 be computed.
3733 This function assumes point is always at the beginning of the
3734 element it has to parse."
3737 ;; Determine if parsing depth allows for secondary strings
3738 ;; parsing. It only applies to elements referenced in
3739 ;; `org-element-secondary-value-alist'.
3742 ;; Item.
3745 ;; Table Row.
3747 ;; Node Property.
3749 ;; Headline.
3752 ;; Sections (must be checked after headline).
3758 limit)))
3759 ;; When not at bol, point is at the beginning of an item or
3760 ;; a footnote definition: next item is always a paragraph.
3762 ;; Planning and Clock.
3767 ;; Inlinetask.
3770 ;; From there, elements can have affiliated keywords.
3773 ;; Jumping over affiliated keywords put point off-limits.
3774 ;; Parse them as regular keywords.
3778 ;; LaTeX Environment.
3781 ;; Drawer and Property Drawer.
3786 ;; Fixed Width
3789 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3790 ;; Keywords.
3799 org-element-block-name-alist)))
3814 ;; Footnote Definition.
3817 ;; Horizontal Rule.
3820 ;; Diary Sexp.
3823 ;; Table.
3825 ;; List.
3829 ;; Default element: Paragraph.
3833 ;; Most elements can have affiliated keywords. When looking for an
3834 ;; element beginning, we want to move before them, as they belong to
3835 ;; that element, and, in the meantime, collect information they give
3836 ;; into appropriate properties. Hence the following function.
3839 "Collect affiliated keywords from point down to LIMIT.
3841 Return a list whose CAR is the position at the first of them and
3842 CDR a plist of keywords and values and move point to the
3843 beginning of the first line after them.
3845 As a special case, if element doesn't start at the beginning of
3846 the line (i.e. a paragraph starting an item), CAR is current
3847 position of point and CDR is nil."
3851 ;; RESTRICT is the list of objects allowed in parsed
3852 ;; keywords value.
3854 output)
3857 ;; Apply translation to RAW-KWD. From there, KWD is
3858 ;; the official keyword.
3860 org-element-keyword-translation-alist))
3861 raw-kwd))
3862 ;; Find main value for any keyword.
3868 ;; PARSEDP is non-nil when keyword should have its
3869 ;; value parsed.
3871 ;; If KWD is a dual keyword, find its secondary
3872 ;; value. Maybe parse it.
3879 ;; Attribute a property name to KWD.
3881 ;; Now set final shape for VALUE.
3887 ;; Attributes can always appear on multiple lines.
3890 ;; Eventually store the new value in OUTPUT.
3892 ;; Move to next keyword.
3894 ;; If affiliated keywords are orphaned: move back to first one.
3895 ;; They will be parsed as a paragraph.
3897 ;; Return value.
3901 \f
3902 ;;; The Org Parser
3903 ;;
3904 ;; The two major functions here are `org-element-parse-buffer', which
3905 ;; parses Org syntax inside the current buffer, taking into account
3906 ;; region, narrowing, or even visibility if specified, and
3907 ;; `org-element-parse-secondary-string', which parses objects within
3908 ;; a given string.
3909 ;;
3910 ;; The (almost) almighty `org-element-map' allows to apply a function
3911 ;; on elements or objects matching some type, and accumulate the
3912 ;; resulting values. In an export situation, it also skips unneeded
3913 ;; parts of the parse tree.
3916 "Recursively parse the buffer and return structure.
3917 If narrowing is in effect, only parse the visible part of the
3918 buffer.
3920 Optional argument GRANULARITY determines the depth of the
3921 recursion. It can be set to the following symbols:
3923 `headline' Only parse headlines.
3924 `greater-element' Don't recurse into greater elements excepted
3925 headlines and sections. Thus, elements
3926 parsed are the top-level ones.
3927 `element' Parse everything but objects and plain text.
3928 `object' Parse the complete buffer (default).
3930 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3931 elements.
3933 An element or an objects is represented as a list with the
3934 pattern (TYPE PROPERTIES CONTENTS), where :
3936 TYPE is a symbol describing the element or object. See
3937 `org-element-all-elements' and `org-element-all-objects' for an
3938 exhaustive list of such symbols. One can retrieve it with
3939 `org-element-type' function.
3941 PROPERTIES is the list of attributes attached to the element or
3942 object, as a plist. Although most of them are specific to the
3943 element or object type, all types share `:begin', `:end',
3944 `:post-blank' and `:parent' properties, which respectively
3945 refer to buffer position where the element or object starts,
3946 ends, the number of white spaces or blank lines after it, and
3947 the element or object containing it. Properties values can be
3948 obtained by using `org-element-property' function.
3950 CONTENTS is a list of elements, objects or raw strings
3951 contained in the current element or object, when applicable.
3952 One can access them with `org-element-contents' function.
3954 The Org buffer has `org-data' as type and nil as properties.
3955 `org-element-map' function can be used to find specific elements
3956 or objects within the parse tree.
3958 This function assumes that current major mode is `org-mode'."
3964 ;; Start in `first-section' mode so text before the first
3965 ;; headline belongs to a section.
3969 "Recursively parse objects in STRING and return structure.
3971 RESTRICTION is a symbol limiting the object types that will be
3972 looked after.
3974 Optional argument PARENT, when non-nil, is the element or object
3975 containing the secondary string. It is used to set correctly
3976 `:parent' property within the string."
3977 ;; Copy buffer-local variables listed in
3978 ;; `org-element-object-variables' into temporary buffer. This is
3979 ;; required since object parsing is dependent on these variables.
3983 org-element-object-variables))))
3991 secondary))
3992 secondary))))
3996 "Map a function on selected elements or objects.
3998 DATA is a parse tree, an element, an object, a string, or a list
3999 of such constructs. TYPES is a symbol or list of symbols of
4000 elements or objects types (see `org-element-all-elements' and
4001 `org-element-all-objects' for a complete list of types). FUN is
4002 the function called on the matching element or object. It has to
4003 accept one argument: the element or object itself.
4005 When optional argument INFO is non-nil, it should be a plist
4006 holding export options. In that case, parts of the parse tree
4007 not exportable according to that property list will be skipped.
4009 When optional argument FIRST-MATCH is non-nil, stop at the first
4010 match for which FUN doesn't return nil, and return that value.
4012 Optional argument NO-RECURSION is a symbol or a list of symbols
4013 representing elements or objects types. `org-element-map' won't
4014 enter any recursive element or object whose type belongs to that
4015 list. Though, FUN can still be applied on them.
4017 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4018 apply to matching objects within parsed affiliated keywords (see
4019 `org-element-parsed-keywords').
4021 Nil values returned from FUN do not appear in the results.
4024 Examples:
4025 --------
4027 Assuming TREE is a variable containing an Org buffer parse tree,
4028 the following example will return a flat list of all `src-block'
4029 and `example-block' elements in it:
4031 \(org-element-map tree '(example-block src-block) 'identity)
4033 The following snippet will find the first headline with a level
4036 \(org-element-map tree 'headline
4037 \(lambda (hl)
4038 \(and (= (org-element-property :level hl) 1)
4040 \(org-element-property :begin hl)))
4041 nil t)
4043 The next example will return a flat list of all `plain-list' type
4044 elements in TREE that are not a sub-list themselves:
4046 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4048 Eventually, this example will return a flat list of all `bold'
4049 type objects containing a `latex-snippet' type object, even
4050 looking into captions:
4052 \(org-element-map tree 'bold
4053 \(lambda (b)
4054 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4055 nil nil nil t)"
4056 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4059 ;; Recursion depth is determined by --CATEGORY.
4066 ;; If one object is found, the function
4067 ;; has to recurse into every object.
4070 ;; If one regular element is found, the
4071 ;; function has to recurse, at least,
4072 ;; into every element it encounters.
4075 types)
4076 category)))
4077 ;; Compute properties for affiliated keywords if necessary.
4082 org-element-affiliated-keywords)))
4083 --acc
4084 --walk-tree
4088 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4089 ;; holding contextual information.
4093 ;; Ignored element in an export context.
4095 ;; List of elements or objects.
4097 ;; Unconditionally enter parse trees.
4101 ;; Check if TYPE is matching among TYPES. If so,
4102 ;; apply FUN to --DATA and accumulate return value
4103 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4109 ;; If --DATA has a secondary string that can contain
4110 ;; objects with their type among TYPES, look into it.
4117 ;; If --DATA has any affiliated keywords and
4118 ;; WITH-AFFILIATED is non-nil, look for objects in
4119 ;; them.
4127 ;; Pay attention to the type of value.
4128 ;; Preserve order for multiple keywords.
4144 --affiliated-alist))
4145 ;; Determine if a recursion into --DATA is possible.
4147 ;; --TYPE is explicitly removed from recursion.
4149 ;; --DATA has no contents.
4151 ;; Looking for greater elements but --DATA is simply
4152 ;; an element or an object.
4155 ;; Looking for elements but --DATA is an object.
4158 ;; In any other case, map contents.
4162 ;; Return value in a proper order.
4166 ;; The following functions are internal parts of the parser.
4167 ;;
4168 ;; The first one, `org-element--parse-elements' acts at the element's
4169 ;; level.
4170 ;;
4171 ;; The second one, `org-element--parse-objects' applies on all objects
4172 ;; of a paragraph or a secondary string. It uses
4173 ;; `org-element--get-next-object-candidates' to optimize the search of
4174 ;; the next object in the buffer.
4175 ;;
4176 ;; More precisely, that function looks for every allowed object type
4177 ;; first. Then, it discards failed searches, keeps further matches,
4178 ;; and searches again types matched behind point, for subsequent
4179 ;; calls. Thus, searching for a given type fails only once, and every
4180 ;; object is searched only once at top level (but sometimes more for
4181 ;; nested types).
4185 "Parse elements between BEG and END positions.
4187 SPECIAL prioritize some elements over the others. It can be set
4188 to `first-section', `quote-section', `section' `item' or
4189 `table-row'.
4191 When value is `item', STRUCTURE will be used as the current list
4192 structure.
4194 GRANULARITY determines the depth of the recursion. See
4195 `org-element-parse-buffer' for more information.
4197 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4198 elements.
4200 Elements are accumulated into ACC."
4203 ;; When parsing only headlines, skip any text before first one.
4206 ;; Main loop start.
4208 ;; Find current element's type and parse it accordingly to
4209 ;; its category.
4211 end granularity special structure))
4215 ;; Fill ELEMENT contents by side-effect.
4217 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4218 ;; no contents, don't modify it.
4221 ;; Greater element: parse it between `contents-begin' and
4222 ;; `contents-end'. Make sure GRANULARITY allows the
4223 ;; recursion, or ELEMENT is a headline, in which case going
4224 ;; inside is mandatory, in order to get sub-level headings.
4232 ;; Possibly switch to a special mode.
4242 granularity visible-only element))
4243 ;; ELEMENT has contents. Parse objects inside, if
4244 ;; GRANULARITY allows it.
4250 ;; Return result.
4251 acc))
4254 "Parse objects between BEG and END and return recursive structure.
4256 Objects are accumulated in ACC.
4258 RESTRICTION is a list of object successors which are allowed in
4259 the current object."
4265 end restriction candidates)))
4272 ;; 1. Text before any object. Untabify it.
4277 acc
4281 ;; 2. Object...
4284 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4285 ;; a recursive type.
4290 cont-beg
4297 ;; 3. Text after last object. Untabify it.
4301 acc
4305 ;; Result.
4306 acc)))
4309 "Return an alist of candidates for the next object.
4311 LIMIT bounds the search, and RESTRICTION narrows candidates to
4312 some object successors.
4314 OBJECTS is the previous candidates alist. If it is set to
4315 `initial', no search has been done before, and all symbols in
4316 RESTRICTION should be looked after.
4318 Return value is an alist whose CAR is the object type and CDR its
4319 beginning position."
4321 nil
4323 ;; When searching for the first time, look for every successor
4324 ;; allowed in RESTRICTION.
4328 restriction)
4329 ;; Focus on objects returned during last search. Keep those
4330 ;; still after point. Search again objects before it.
4336 type)))
4339 limit)))))
4340 objects))))
4343 \f
4344 ;;; Towards A Bijective Process
4345 ;;
4346 ;; The parse tree obtained with `org-element-parse-buffer' is really
4347 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4348 ;; interpreted and expanded into a string with canonical Org syntax.
4349 ;; Hence `org-element-interpret-data'.
4350 ;;
4351 ;; The function relies internally on
4352 ;; `org-element--interpret-affiliated-keywords'.
4354 ;;;###autoload
4356 "Interpret DATA as Org syntax.
4358 DATA is a parse tree, an element, an object or a secondary string
4359 to interpret.
4361 Optional argument PARENT is used for recursive calls. It contains
4362 the element or object containing data, or nil.
4364 Return Org syntax as a string."
4368 ;; Secondary string.
4373 ;; Full Org document.
4378 ;; Plain text: remove `:parent' text property from output.
4380 ;; Element/Object without contents.
4383 data nil))
4384 ;; Element/Object with contents.
4394 ;; Elements directly containing objects must
4395 ;; have their indentation normalized first.
4397 data
4398 ;; When normalizing first paragraph of an
4399 ;; item or a footnote-definition, ignore
4400 ;; first line's indentation.
4407 data
4409 contents)))))))
4411 ;; Build white spaces. If no `:post-blank' property is
4412 ;; specified, assume its value is 0.
4422 "Return ELEMENT's affiliated keywords as Org syntax.
4423 If there is no affiliated keyword, return the empty string."
4433 ": "
4436 value)
4444 ;; All attribute keywords can have multiple lines.
4450 ;; List all ELEMENT's properties matching an attribute line or an
4451 ;; affiliated keyword, but ignore translated keywords since they
4452 ;; cannot belong to the property list.
4459 org-element-keyword-translation-alist)))))
4460 collect prop)
4463 ;; Because interpretation of the parse tree must return the same
4464 ;; number of blank lines between elements and the same number of white
4465 ;; space after objects, some special care must be given to white
4466 ;; spaces.
4467 ;;
4468 ;; The first function, `org-element-normalize-string', ensures any
4469 ;; string different from the empty string will end with a single
4470 ;; newline character.
4471 ;;
4472 ;; The second function, `org-element-normalize-contents', removes
4473 ;; global indentation from the contents of the current element.
4476 "Ensure string S ends with a single newline character.
4478 If S isn't a string return it unchanged. If S is the empty
4479 string, return it. Otherwise, return a new string with a single
4480 newline character at its end."
4488 "Normalize plain text in ELEMENT's contents.
4490 ELEMENT must only contain plain text and objects.
4492 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4493 indentation to compute maximal common indentation.
4495 Return the normalized element that is element with global
4496 indentation removed from its contents. The function assumes that
4497 indentation is not done with TAB characters."
4499 collect-inds ; for byte-compiler
4502 ;; Return list of indentations within BLOB. This is done by
4503 ;; walking recursively BLOB and updating IND-LIST along the
4504 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4505 ;; been seen yet. It is required as this string is the only
4506 ;; one whose indentation doesn't happen after a newline
4507 ;; character.
4515 ;; An indentation of zero means no string will be
4516 ;; modified. Quit the process.
4522 ;; Avoid matching blank or empty lines.
4530 ;; Collect indentation list in ELEMENT. Possibly remove first
4531 ;; value if IGNORE-FIRST is non-nil.
4534 ;; Build ELEMENT back, replacing each string with the same
4535 ;; string minus common indentation.
4540 ;; Return BLOB with all its strings indentation
4541 ;; shortened from MCI white spaces. FIRST-FLAG is
4542 ;; non-nil when the first string hasn't been seen
4543 ;; yet.
4557 org-element-recursive-objects)
4561 blob))))
4565 \f
4566 ;;; The Toolbox
4567 ;;
4568 ;; The first move is to implement a way to obtain the smallest element
4569 ;; containing point. This is the job of `org-element-at-point'. It
4570 ;; basically jumps back to the beginning of section containing point
4571 ;; and moves, element after element, with
4572 ;; `org-element--current-element' until the container is found. Note:
4573 ;; When using `org-element-at-point', secondary values are never
4574 ;; parsed since the function focuses on elements, not on objects.
4575 ;;
4576 ;; At a deeper level, `org-element-context' lists all elements and
4577 ;; objects containing point.
4578 ;;
4579 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4580 ;; internally by navigation and manipulation tools.
4582 ;;;###autoload
4584 "Determine closest element around point.
4586 Return value is a list like (TYPE PROPS) where TYPE is the type
4587 of the element and PROPS a plist of properties associated to the
4588 element.
4590 Possible types are defined in `org-element-all-elements'.
4591 Properties depend on element or object type, but always include
4592 `:begin', `:end', `:parent' and `:post-blank' properties.
4594 As a special case, if point is at the very beginning of a list or
4595 sub-list, returned element will be that list instead of the first
4596 item. In the same way, if point is at the beginning of the first
4597 row of a table, returned element will be the table instead of the
4598 first row.
4600 If optional argument KEEP-TRAIL is non-nil, the function returns
4601 a list of elements leading to element at point. The list's CAR
4602 is always the element at point. The following positions contain
4603 element's siblings, then parents, siblings of parents, until the
4604 first element of current section."
4606 ;; If at a headline, parse it. It is the sole element that
4607 ;; doesn't require to know about context. Be sure to disallow
4608 ;; secondary string parsing, though.
4614 ;; Otherwise move at the beginning of the section containing
4615 ;; point.
4620 element type special-flag trail struct prevs parent)
4623 ;; In empty lines at buffer's beginning, return nil.
4632 ;; In blank lines just after the headline, point still
4633 ;; belongs to the headline.
4641 ;; Parse successively each element, skipping those ending
4642 ;; before original position.
4650 ;; 1. Skip any element ending before point. Also skip
4651 ;; element ending at point when we're sure that another
4652 ;; element has started.
4657 ;; 2. An element containing point is always the element at
4658 ;; point.
4661 ;; 3. At any other greater element type, if point is
4662 ;; within contents, move into it.
4667 ;; Create an anchor for tables and plain lists:
4668 ;; when point is at the very beginning of these
4669 ;; elements, ignoring affiliated keywords,
4670 ;; target them instead of their contents.
4672 ;; When point is at contents end, do not move
4673 ;; into elements with an explicit ending, but
4674 ;; return that element instead.
4678 drawer dynamic-block inlinetask item
4679 plain-list property-drawer quote-block
4680 special-block))))
4695 ;;;###autoload
4697 "Return closest element or object around point.
4699 Return value is a list like (TYPE PROPS) where TYPE is the type
4700 of the element or object and PROPS a plist of properties
4701 associated to it.
4703 Possible types are defined in `org-element-all-elements' and
4704 `org-element-all-objects'. Properties depend on element or
4705 object type, but always include `:begin', `:end', `:parent' and
4706 `:post-blank'.
4708 Optional argument ELEMENT, when non-nil, is the closest element
4709 containing point, as returned by `org-element-at-point'.
4710 Providing it allows for quicker computation."
4715 end)
4716 ;; Check if point is inside an element containing objects or at
4717 ;; a secondary string. In that case, move to beginning of the
4718 ;; element or secondary string and set END to the other side.
4725 org-element-parsed-keywords))
4726 ;; We're at an affiliated keyword. Change
4727 ;; type to retrieve correct restrictions.
4729 ;; Determine if we're at main or dual value.
4743 (<= origin
4744 ;; `1+' is required so some
4745 ;; successors can match
4746 ;; properly their object.
4767 element
4773 end restriction candidates))
4775 candidates)))
4776 ;; If ORIGIN is before next object in element, there's
4777 ;; no point in looking further.
4787 ;; ORIGIN is after OBJECT, so skip it.
4793 ;; ORIGIN is within a non-recursive object or at
4794 ;; an object boundaries: Return that object.
4798 ;; Otherwise, move within current object and
4799 ;; restrict search to the end of its contents.
4804 candidates 'initial
4805 end cend)))))))
4806 parent))))))
4809 "Non-nil when elements ELEM-A and ELEM-B are nested."
4818 "Swap elements ELEM-A and ELEM-B.
4819 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4820 end of ELEM-A."
4822 ;; There are two special cases when an element doesn't start at bol:
4823 ;; the first paragraph in an item or in a footnote definition.
4825 ;; Only a paragraph without any affiliated keyword can be moved at
4826 ;; ELEM-A position in such a situation. Note that the case of
4827 ;; a footnote definition is impossible: it cannot contain two
4828 ;; paragraphs in a row because it cannot contain a blank line.
4834 ;; In a special situation, ELEM-A will have no indentation. We'll
4835 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4849 ;; Store overlays responsible for visibility status. We
4850 ;; also need to store their boundaries as they will be
4851 ;; removed from buffer.
4858 ;; Get contents.
4866 ;; Restore ex ELEM-A overlays.
4875 ;; Restore ex ELEM-B overlays.
4884 ;; Local variables:
4885 ;; generated-autoload-file: "org-loaddefs.el"
4886 ;; End:
4888 ;;; org-element.el ends here