| blob | fb12b419ff505e2fecf6ff9ecb0e94f96a52605a |
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 plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
303 inline-src-block latex-or-entity line-break link macro
304 radio-target sub/superscript target text-markup
305 timestamp)
307 radio-target statistics-cookie sub/superscript target text-markup
308 timestamp)
320 inline-src-block latex-or-entity line-break link macro
321 radio-target statistics-cookie sub/superscript target text-markup
322 timestamp)
325 latex-or-entity link radio-target sub/superscript target
326 text-markup timestamp)
337 latex-or-entity line-break link macro radio-target
339 "Alist of objects restrictions.
341 CAR is an element or object type containing objects and CDR is
342 a list of successors that will be called within an element or
343 object of such type.
345 For example, in a `radio-target' object, one can only find
346 entities, export snippets, latex-fragments, subscript and
347 superscript.
349 This alist also applies to secondary string. For example, an
350 `headline' type element doesn't directly contain objects, but
361 "List of buffer-local variables used when parsing objects.
362 These variables are copied to the temporary buffer created by
366 \f
367 ;;; Accessors and Setters
368 ;;
369 ;; Provide four accessors: `org-element-type', `org-element-property'
370 ;; `org-element-contents' and `org-element-restriction'.
371 ;;
372 ;; Setter functions allow to modify elements by side effect. There is
373 ;; `org-element-put-property', `org-element-set-contents',
374 ;; `org-element-set-element' and `org-element-adopt-element'. Note
375 ;; that `org-element-set-element' and `org-element-adopt-elements' are
376 ;; higher level functions since also update `:parent' property.
379 "Return type of ELEMENT.
381 The function returns the type of the element or object provided.
382 It can also return the following special value:
383 `plain-text' for a string
384 `org-data' for a complete document
385 nil in any other case."
391 "Extract the value from the PROPERTY of an ELEMENT."
396 "Extract contents from an ELEMENT."
402 "Return restriction associated to ELEMENT.
403 ELEMENT can be an element, an object or a symbol representing an
404 element or object type."
406 org-element-object-restrictions)))
409 "In ELEMENT set PROPERTY to VALUE.
410 Return modified element."
413 element))
416 "Set ELEMENT contents to CONTENTS.
417 Return modified element."
424 "Replace element or object OLD with element or object NEW.
425 The function takes care of setting `:parent' property for NEW."
426 ;; Since OLD is going to be changed into NEW by side-effect, first
427 ;; make sure that every element or object within NEW has OLD as
428 ;; parent.
431 ;; Transfer contents.
433 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
434 ;; with NEW's.
437 ;; Transfer type.
441 "Append elements to the contents of another element.
443 PARENT is an element or object. CHILDREN can be elements,
444 objects, or a strings.
446 The function takes care of setting `:parent' property for CHILD.
447 Return parent element."
448 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
449 ;; string: parent is the list itself.
452 children)
453 ;; Add CHILDREN at the end of PARENT contents.
456 parent
458 ;; Return modified PARENT element.
462 \f
463 ;;; Greater elements
464 ;;
465 ;; For each greater element type, we define a parser and an
466 ;; interpreter.
467 ;;
468 ;; A parser returns the element or object as the list described above.
469 ;; Most of them accepts no argument. Though, exceptions exist. Hence
470 ;; every element containing a secondary string (see
471 ;; `org-element-secondary-value-alist') will accept an optional
472 ;; argument to toggle parsing of that secondary string. Moreover,
473 ;; `item' parser requires current list's structure as its first
474 ;; element.
475 ;;
476 ;; An interpreter accepts two arguments: the list representation of
477 ;; the element or object, and its contents. The latter may be nil,
478 ;; depending on the element or object considered. It returns the
479 ;; appropriate Org syntax, as a string.
480 ;;
481 ;; Parsing functions must follow the naming convention:
482 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
483 ;; defined in `org-element-greater-elements'.
484 ;;
485 ;; Similarly, interpreting functions must follow the naming
486 ;; convention: org-element-TYPE-interpreter.
487 ;;
488 ;; With the exception of `headline' and `item' types, greater elements
489 ;; cannot contain other greater elements of their own type.
490 ;;
491 ;; Beside implementing a parser and an interpreter, adding a new
492 ;; greater element requires to tweak `org-element--current-element'.
493 ;; Moreover, the newly defined type must be added to both
494 ;; `org-element-all-elements' and `org-element-greater-elements'.
497 ;;;; Center Block
500 "Parse a center block.
502 LIMIT bounds the search. AFFILIATED is a list of which CAR is
503 the buffer position at the beginning of the first affiliated
504 keyword and CDR is a plist of affiliated keywords along with
505 their value.
507 Return a list whose CAR is `center-block' and CDR is a plist
508 containing `:begin', `:end', `:hiddenp', `:contents-begin',
509 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
511 Assume point is at the beginning of the block."
515 ;; Incomplete block: parse it as a paragraph.
520 ;; Empty blocks have no contents.
535 :end end
536 :hiddenp hidden
537 :contents-begin contents-begin
538 :contents-end contents-end
544 "Interpret CENTER-BLOCK element as Org syntax.
545 CONTENTS is the contents of the element."
549 ;;;; Drawer
552 "Parse a drawer.
554 LIMIT bounds the search. AFFILIATED is a list of which CAR is
555 the buffer position at the beginning of the first affiliated
556 keyword and CDR is a plist of affiliated keywords along with
557 their value.
559 Return a list whose CAR is `drawer' and CDR is a plist containing
560 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
561 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
563 Assume point is at beginning of drawer."
566 ;; Incomplete drawer: parse it as a paragraph.
574 ;; Empty drawers have no contents.
589 :end end
590 :drawer-name name
591 :hiddenp hidden
592 :contents-begin contents-begin
593 :contents-end contents-end
599 "Interpret DRAWER element as Org syntax.
600 CONTENTS is the contents of the element."
603 contents))
606 ;;;; Dynamic Block
609 "Parse a dynamic block.
611 LIMIT bounds the search. AFFILIATED is a list of which CAR is
612 the buffer position at the beginning of the first affiliated
613 keyword and CDR is a plist of affiliated keywords along with
614 their value.
616 Return a list whose CAR is `dynamic-block' and CDR is a plist
617 containing `:block-name', `:begin', `:end', `:hiddenp',
618 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
619 and `:post-affiliated' keywords.
621 Assume point is at beginning of dynamic block."
625 ;; Incomplete block: parse it as a paragraph.
634 ;; Empty blocks have no contents.
649 :end end
650 :block-name name
651 :arguments arguments
652 :hiddenp hidden
653 :contents-begin contents-begin
654 :contents-end contents-end
660 "Interpret DYNAMIC-BLOCK element as Org syntax.
661 CONTENTS is the contents of the element."
666 contents))
669 ;;;; Footnote Definition
672 "Parse a footnote definition.
674 LIMIT bounds the search. AFFILIATED is a list of which CAR is
675 the buffer position at the beginning of the first affiliated
676 keyword and CDR is a plist of affiliated keywords along with
677 their value.
679 Return a list whose CAR is `footnote-definition' and CDR is
680 a plist containing `:label', `:begin' `:end', `:contents-begin',
681 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
683 Assume point is at the beginning of the footnote definition."
709 :begin begin
710 :end end
711 :contents-begin contents-begin
712 :contents-end contents-end
718 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
719 CONTENTS is the contents of the footnote-definition."
721 " "
722 contents))
725 ;;;; Headline
728 "Parse a headline.
730 Return a list whose CAR is `headline' and CDR is a plist
731 containing `:raw-value', `:title', `:optional-title', `:begin',
732 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
733 `:contents-end', `:level', `:priority', `:tags',
734 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
735 `:closed', `:quotedp', `:archivedp', `:commentedp' and
736 `:footnote-section-p' keywords.
738 The plist also contains any property set in the property drawer,
739 with its name in upper cases and colons added at the
740 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 ;; Upcase property names. It avoids confusion between
767 ;; properties obtained through property drawer and default
768 ;; properties from the parser (e.g. `:end' and :END:)
778 plist))
780 ;; Read time properties on the line below the headline.
786 org-keyword-time-not-clock-regexp end t)
796 plist))))
809 ;; Clean RAW-VALUE from any quote or comment string.
817 ""
818 raw-value))))
819 ;; Clean TAGS from archive tag, if any.
825 :begin begin
826 :end end
827 :pre-blank
830 :hiddenp hidden
831 :contents-begin contents-begin
832 :contents-end contents-end
833 :level level
835 :tags tags
836 :todo-keyword todo
837 :todo-type todo-type
843 end)
844 :footnote-section-p footnote-section-p
845 :archivedp archivedp
846 :commentedp commentedp
848 time-props
849 standard-props))))
853 headline :optional-title
858 headline :title
864 "Interpret HEADLINE element as Org syntax.
865 CONTENTS is the contents of the element."
892 ;; Align tags.
900 ? )
901 tags))
905 tags))))
907 contents)))
910 ;;;; Inlinetask
913 "Parse an inline task.
915 Return a list whose CAR is `inlinetask' and CDR is a plist
916 containing `:title', `:begin', `:end', `:hiddenp',
917 `:contents-begin' and `:contents-end', `:level', `:priority',
918 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
919 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
921 The plist also contains any property set in the property drawer,
922 with its name in upper cases and colons added at the
923 beginning (i.e. `:CUSTOM_ID').
925 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
926 title will not be parsed as a secondary string, but as a plain
927 string instead.
929 Assume point is at beginning of the inline task."
939 ;; Upcase property names. It avoids confusion between
940 ;; properties obtained through property drawer and default
941 ;; properties from the parser (e.g. `:end' and :END:)
951 plist))
953 ;; Read time properties on the line below the inlinetask
954 ;; opening string.
960 org-keyword-time-not-clock-regexp end t)
970 plist))))
990 :begin begin
991 :end end
992 :hiddenp hidden
993 :contents-begin contents-begin
994 :contents-end contents-end
997 :tags tags
998 :todo-keyword todo
999 :todo-type todo-type
1001 time-props
1002 standard-props))))
1004 inlinetask :title
1007 raw-value
1009 inlinetask))))))
1012 "Interpret INLINETASK element as Org syntax.
1013 CONTENTS is the contents of inlinetask."
1028 ;; Align tags.
1036 ? )
1037 tags))
1041 tags))))
1042 ;; Prefer degenerate inlinetasks when there are no
1043 ;; contents.
1046 contents
1050 ;;;; Item
1053 "Parse an item.
1055 STRUCT is the structure of the plain list.
1057 Return a list whose CAR is `item' and CDR is a plist containing
1058 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1059 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1060 `:post-blank' keywords.
1062 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1063 any, will not be parsed as a secondary string, but as a plain
1064 string instead.
1066 Assume point is at the beginning of the item."
1090 ;; Ignore tags in un-ordered lists: they are just
1091 ;; a part of item's body.
1097 ;; If first line isn't empty, contents really start
1098 ;; at the text after item's meta-data.
1109 :begin begin
1110 :end end
1111 ;; CONTENTS-BEGIN and CONTENTS-END may be
1112 ;; mixed up in the case of an empty item
1113 ;; separated from the next by a blank line.
1114 ;; Thus ensure the former is always the
1115 ;; smallest.
1118 :checkbox checkbox
1119 :counter counter
1120 :hiddenp hidden
1121 :structure struct
1124 item :tag
1132 "Interpret ITEM element as Org syntax.
1133 CONTENTS is the contents of the element."
1139 ;; Compute indentation.
1144 ;; Indent contents.
1146 bullet
1159 ;;;; Plain List
1162 "Parse a plain list.
1164 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1165 the buffer position at the beginning of the first affiliated
1166 keyword and CDR is a plist of affiliated keywords along with
1167 their value. STRUCTURE is the structure of the plain list being
1168 parsed.
1170 Return a list whose CAR is `plain-list' and CDR is a plist
1171 containing `:type', `:begin', `:end', `:contents-begin' and
1172 `:contents-end', `:structure', `:post-blank' and
1173 `:post-affiliated' keywords.
1175 Assume point is at the beginning of the list."
1190 ;; Return value.
1194 :begin begin
1195 :end end
1196 :contents-begin contents-begin
1197 :contents-end contents-end
1198 :structure struct
1204 "Interpret PLAIN-LIST element as Org syntax.
1205 CONTENTS is the contents of the element."
1213 ;;;; Property Drawer
1216 "Parse a property drawer.
1218 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1219 the buffer position at the beginning of the first affiliated
1220 keyword and CDR is a plist of affiliated keywords along with
1221 their value.
1223 Return a list whose CAR is `property-drawer' and CDR is a plist
1224 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1225 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1227 Assume point is at the beginning of the property drawer."
1232 ;; Incomplete drawer: parse it as a paragraph.
1252 :end end
1253 :hiddenp hidden
1254 :contents-begin contents-begin
1255 :contents-end contents-end
1261 "Interpret PROPERTY-DRAWER element as Org syntax.
1262 CONTENTS is the properties within the drawer."
1266 ;;;; Quote Block
1269 "Parse a quote block.
1271 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1272 the buffer position at the beginning of the first affiliated
1273 keyword and CDR is a plist of affiliated keywords along with
1274 their value.
1276 Return a list whose CAR is `quote-block' and CDR is a plist
1277 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1278 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1280 Assume point is at the beginning of the block."
1284 ;; Incomplete block: parse it as a paragraph.
1290 ;; Empty blocks have no contents.
1305 :end end
1306 :hiddenp hidden
1307 :contents-begin contents-begin
1308 :contents-end contents-end
1314 "Interpret QUOTE-BLOCK element as Org syntax.
1315 CONTENTS is the contents of the element."
1319 ;;;; Section
1322 "Parse a section.
1324 LIMIT bounds the search.
1326 Return a list whose CAR is `section' and CDR is a plist
1327 containing `:begin', `:end', `:contents-begin', `contents-end'
1328 and `:post-blank' keywords."
1330 ;; Beginning of section is the beginning of the first non-blank
1331 ;; line after previous headline.
1340 :end end
1341 :contents-begin begin
1342 :contents-end pos-before-blank
1346 "Interpret SECTION element as Org syntax.
1347 CONTENTS is the contents of the element."
1348 contents)
1351 ;;;; Special Block
1354 "Parse a special block.
1356 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1357 the buffer position at the beginning of the first affiliated
1358 keyword and CDR is a plist of affiliated keywords along with
1359 their value.
1361 Return a list whose CAR is `special-block' and CDR is a plist
1362 containing `:type', `:begin', `:end', `:hiddenp',
1363 `:contents-begin', `:contents-end', `:post-blank' and
1364 `:post-affiliated' keywords.
1366 Assume point is at the beginning of the block."
1373 ;; Incomplete block: parse it as a paragraph.
1379 ;; Empty blocks have no contents.
1394 :begin begin
1395 :end end
1396 :hiddenp hidden
1397 :contents-begin contents-begin
1398 :contents-end contents-end
1404 "Interpret SPECIAL-BLOCK element as Org syntax.
1405 CONTENTS is the contents of the element."
1410 \f
1411 ;;; Elements
1412 ;;
1413 ;; For each element, a parser and an interpreter are also defined.
1414 ;; Both follow the same naming convention used for greater elements.
1415 ;;
1416 ;; Also, as for greater elements, adding a new element type is done
1417 ;; through the following steps: implement a parser and an interpreter,
1418 ;; tweak `org-element--current-element' so that it recognizes the new
1419 ;; type and add that new type to `org-element-all-elements'.
1420 ;;
1421 ;; As a special case, when the newly defined type is a block type,
1422 ;; `org-element-block-name-alist' has to be modified accordingly.
1425 ;;;; Babel Call
1428 "Parse a babel call.
1430 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1431 the buffer position at the beginning of the first affiliated
1432 keyword and CDR is a plist of affiliated keywords along with
1433 their value.
1435 Return a list whose CAR is `babel-call' and CDR is a plist
1436 containing `:begin', `:end', `:info', `:post-blank' and
1437 `:post-affiliated' as keywords."
1451 :end end
1452 :info info
1458 "Interpret BABEL-CALL element as Org syntax.
1459 CONTENTS is nil."
1465 ;; Remove redundant square brackets.
1470 ;;;; Clock
1473 "Parse a clock.
1475 LIMIT bounds the search.
1477 Return a list whose CAR is `clock' and CDR is a plist containing
1478 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1479 as keywords."
1499 :value value
1500 :duration duration
1501 :begin begin
1502 :end end
1506 "Interpret CLOCK element as Org syntax.
1507 CONTENTS is nil."
1515 "%2s:%02s"
1519 ;;;; Comment
1522 "Parse a comment.
1524 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1525 the buffer position at the beginning of the first affiliated
1526 keyword and CDR is a plist of affiliated keywords along with
1527 their value.
1529 Return a list whose CAR is `comment' and CDR is a plist
1530 containing `:begin', `:end', `:value', `:post-blank',
1531 `:post-affiliated' keywords.
1533 Assume point is at comment beginning."
1542 ;; Get comments ending.
1545 ;; Accumulate lines without leading hash and first
1546 ;; whitespace.
1561 :end end
1562 :value value
1568 "Interpret COMMENT element as Org syntax.
1569 CONTENTS is nil."
1573 ;;;; Comment Block
1576 "Parse an export block.
1578 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1579 the buffer position at the beginning of the first affiliated
1580 keyword and CDR is a plist of affiliated keywords along with
1581 their value.
1583 Return a list whose CAR is `comment-block' and CDR is a plist
1584 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1585 and `:post-affiliated' keywords.
1587 Assume point is at comment block beginning."
1591 ;; Incomplete block: parse it as a paragraph.
1606 contents-begin contents-end)))
1610 :end end
1611 :value value
1612 :hiddenp hidden
1618 "Interpret COMMENT-BLOCK element as Org syntax.
1619 CONTENTS is nil."
1624 ;;;; Diary Sexp
1627 "Parse a diary sexp.
1629 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1630 the buffer position at the beginning of the first affiliated
1631 keyword and CDR is a plist of affiliated keywords along with
1632 their value.
1634 Return a list whose CAR is `diary-sexp' and CDR is a plist
1635 containing `:begin', `:end', `:value', `:post-blank' and
1636 `:post-affiliated' keywords."
1649 :begin begin
1650 :end end
1656 "Interpret DIARY-SEXP as Org syntax.
1657 CONTENTS is nil."
1661 ;;;; Example Block
1664 "Parse an example block.
1666 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1667 the buffer position at the beginning of the first affiliated
1668 keyword and CDR is a plist of affiliated keywords along with
1669 their value.
1671 Return a list whose CAR is `example-block' and CDR is a plist
1672 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1673 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1674 `:switches', `:value', `:post-blank' and `:post-affiliated'
1675 keywords."
1679 ;; Incomplete block: parse it as a paragraph.
1686 ;; Switches analysis
1691 ;; Should labels be retained in (or stripped from) example
1692 ;; blocks?
1697 ;; What should code-references use - labels or
1698 ;; line-numbers?
1705 ;; Standard block parsing.
1712 contents-begin contents-end)))
1722 :end end
1723 :value value
1724 :switches switches
1725 :number-lines number-lines
1726 :preserve-indent preserve-indent
1727 :retain-labels retain-labels
1728 :use-labels use-labels
1729 :label-fmt label-fmt
1730 :hiddenp hidden
1736 "Interpret EXAMPLE-BLOCK element as Org syntax.
1737 CONTENTS is nil."
1746 ;;;; Export Block
1749 "Parse an export block.
1751 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1752 the buffer position at the beginning of the first affiliated
1753 keyword and CDR is a plist of affiliated keywords along with
1754 their value.
1756 Return a list whose CAR is `export-block' and CDR is a plist
1757 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1758 `:post-blank' and `:post-affiliated' keywords.
1760 Assume point is at export-block beginning."
1767 ;; Incomplete block: parse it as a paragraph.
1782 contents-end)))
1786 :end end
1787 :type type
1788 :value value
1789 :hiddenp hidden
1795 "Interpret EXPORT-BLOCK element as Org syntax.
1796 CONTENTS is nil."
1803 ;;;; Fixed-width
1806 "Parse a fixed-width section.
1808 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1809 the buffer position at the beginning of the first affiliated
1810 keyword and CDR is a plist of affiliated keywords along with
1811 their value.
1813 Return a list whose CAR is `fixed-width' and CDR is a plist
1814 containing `:begin', `:end', `:value', `:post-blank' and
1815 `:post-affiliated' keywords.
1817 Assume point is at the beginning of the fixed-width area."
1821 value
1826 ;; Accumulate text without starting colons.
1840 :end end
1841 :value value
1847 "Interpret FIXED-WIDTH element as Org syntax.
1848 CONTENTS is nil."
1853 ;;;; Horizontal Rule
1856 "Parse an horizontal rule.
1858 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1859 the buffer position at the beginning of the first affiliated
1860 keyword and CDR is a plist of affiliated keywords along with
1861 their value.
1863 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1864 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1865 keywords."
1876 :end end
1882 "Interpret HORIZONTAL-RULE element as Org syntax.
1883 CONTENTS is nil."
1887 ;;;; Keyword
1890 "Parse a keyword at point.
1892 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1893 the buffer position at the beginning of the first affiliated
1894 keyword and CDR is a plist of affiliated keywords along with
1895 their value.
1897 Return a list whose CAR is `keyword' and CDR is a plist
1898 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1899 `:post-affiliated' keywords."
1914 :value value
1915 :begin begin
1916 :end end
1922 "Interpret KEYWORD element as Org syntax.
1923 CONTENTS is nil."
1929 ;;;; Latex Environment
1932 "Parse a LaTeX environment.
1934 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1935 the buffer position at the beginning of the first affiliated
1936 keyword and CDR is a plist of affiliated keywords along with
1937 their value.
1939 Return a list whose CAR is `latex-environment' and CDR is a plist
1940 containing `:begin', `:end', `:value', `:post-blank' and
1941 `:post-affiliated' keywords.
1943 Assume point is at the beginning of the latex environment."
1950 limit t))
1951 ;; Incomplete latex environment: parse it as a paragraph.
1962 :end end
1963 :value value
1969 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1970 CONTENTS is nil."
1974 ;;;; Node Property
1977 "Parse a node-property at point.
1979 LIMIT bounds the search.
1981 Return a list whose CAR is `node-property' and CDR is a plist
1982 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1983 keywords."
1995 :value value
1996 :begin begin
1997 :end end
2001 "Interpret NODE-PROPERTY element as Org syntax.
2002 CONTENTS is nil."
2008 ;;;; Paragraph
2011 "Parse a paragraph.
2013 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2014 the buffer position at the beginning of the first affiliated
2015 keyword and CDR is a plist of affiliated keywords along with
2016 their value.
2018 Return a list whose CAR is `paragraph' and CDR is a plist
2019 containing `:begin', `:end', `:contents-begin' and
2020 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2022 Assume point is at the beginning of the paragraph."
2031 limit
2032 ;; A matching `org-element-paragraph-separate' is not
2033 ;; necessarily the end of the paragraph. In
2034 ;; particular, lines starting with # or : as a first
2035 ;; non-space character are ambiguous. We have check
2036 ;; if they are valid Org syntax (i.e. not an
2037 ;; incomplete keyword).
2041 ;; There's no ambiguity for other symbols or
2042 ;; empty lines: stop here.
2044 ;; Stop at valid fixed-width areas.
2046 ;; Stop at drawers.
2051 ;; Stop at valid comments.
2053 ;; Stop at valid dynamic blocks.
2058 ;; Stop at valid blocks.
2065 limit t)))
2066 ;; Stop at valid latex environments.
2073 limit t)))
2074 ;; Stop at valid keywords.
2076 ;; Skip everything else.
2094 :end end
2095 :contents-begin contents-begin
2096 :contents-end contents-end
2102 "Interpret PARAGRAPH element as Org syntax.
2103 CONTENTS is the contents of the element."
2104 contents)
2107 ;;;; Planning
2110 "Parse a planning.
2112 LIMIT bounds the search.
2114 Return a list whose CAR is `planning' and CDR is a plist
2115 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2116 and `:post-blank' keywords."
2126 closed deadline scheduled)
2138 :deadline deadline
2139 :scheduled scheduled
2140 :begin begin
2141 :end end
2145 "Interpret PLANNING element as Org syntax.
2146 CONTENTS is nil."
2148 'identity
2165 ;;;; Quote Section
2168 "Parse a quote section.
2170 LIMIT bounds the search.
2172 Return a list whose CAR is `quote-section' and CDR is a plist
2173 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2175 Assume point is at beginning of the section."
2186 :end end
2187 :value value
2191 "Interpret QUOTE-SECTION element as Org syntax.
2192 CONTENTS is nil."
2196 ;;;; Src Block
2199 "Parse a src block.
2201 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2202 the buffer position at the beginning of the first affiliated
2203 keyword and CDR is a plist of affiliated keywords along with
2204 their value.
2206 Return a list whose CAR is `src-block' and CDR is a plist
2207 containing `:language', `:switches', `:parameters', `:begin',
2208 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2209 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2210 `:post-blank' and `:post-affiliated' keywords.
2212 Assume point is at the beginning of the block."
2215 limit t)))
2216 ;; Incomplete block: parse it as a paragraph.
2222 ;; Get language as a string.
2231 ;; Get switches.
2233 ;; Get parameters.
2235 ;; Switches analysis
2243 ;; Should labels be retained in (or stripped from)
2244 ;; src blocks?
2249 ;; What should code-references use - labels or
2250 ;; line-numbers?
2254 ;; Get visibility status.
2256 ;; Retrieve code.
2262 ;; Get position after ending blank lines.
2273 :begin begin
2274 :end end
2275 :number-lines number-lines
2276 :preserve-indent preserve-indent
2277 :retain-labels retain-labels
2278 :use-labels use-labels
2279 :label-fmt label-fmt
2280 :hiddenp hidden
2281 :value value
2287 "Interpret SRC-BLOCK element as Org syntax.
2288 CONTENTS is nil."
2311 ;;;; Table
2314 "Parse a table at point.
2316 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2317 the buffer position at the beginning of the first affiliated
2318 keyword and CDR is a plist of affiliated keywords along with
2319 their value.
2321 Return a list whose CAR is `table' and CDR is a plist containing
2322 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2323 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2324 keywords.
2326 Assume point is at the beginning of the table."
2340 acc))
2348 :end end
2349 :type type
2350 :tblfm tblfm
2351 ;; Only `org' tables have contents. `table.el' tables
2352 ;; use a `:value' property to store raw table as
2353 ;; a string.
2358 table-begin table-end))
2364 "Interpret TABLE element as Org syntax.
2365 CONTENTS is nil."
2376 ;;;; Table Row
2379 "Parse table row at point.
2381 LIMIT bounds the search.
2383 Return a list whose CAR is `table-row' and CDR is a plist
2384 containing `:begin', `:end', `:contents-begin', `:contents-end',
2385 `:type' and `:post-blank' keywords."
2389 ;; A table rule has no contents. In that case, ensure
2390 ;; CONTENTS-BEGIN matches CONTENTS-END.
2402 :begin begin
2403 :end end
2404 :contents-begin contents-begin
2405 :contents-end contents-end
2409 "Interpret TABLE-ROW element as Org syntax.
2410 CONTENTS is the contents of the table row."
2415 ;;;; Verse Block
2418 "Parse a verse block.
2420 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2421 the buffer position at the beginning of the first affiliated
2422 keyword and CDR is a plist of affiliated keywords along with
2423 their value.
2425 Return a list whose CAR is `verse-block' and CDR is a plist
2426 containing `:begin', `:end', `:contents-begin', `:contents-end',
2427 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2429 Assume point is at beginning of the block."
2433 ;; Incomplete block: parse it as a paragraph.
2450 :end end
2451 :contents-begin contents-begin
2452 :contents-end contents-end
2453 :hiddenp hidden
2459 "Interpret VERSE-BLOCK element as Org syntax.
2460 CONTENTS is verse block contents."
2464 \f
2465 ;;; Objects
2466 ;;
2467 ;; Unlike to elements, interstices can be found between objects.
2468 ;; That's why, along with the parser, successor functions are provided
2469 ;; for each object. Some objects share the same successor (i.e. `code'
2470 ;; and `verbatim' objects).
2471 ;;
2472 ;; A successor must accept a single argument bounding the search. It
2473 ;; will return either a cons cell whose CAR is the object's type, as
2474 ;; a symbol, and CDR the position of its next occurrence, or nil.
2475 ;;
2476 ;; Successors follow the naming convention:
2477 ;; org-element-NAME-successor, where NAME is the name of the
2478 ;; successor, as defined in `org-element-all-successors'.
2479 ;;
2480 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2481 ;; object types they can contain will be specified in
2482 ;; `org-element-object-restrictions'.
2483 ;;
2484 ;; Adding a new type of object is simple. Implement a successor,
2485 ;; a parser, and an interpreter for it, all following the naming
2486 ;; convention. Register type in `org-element-all-objects' and
2487 ;; successor in `org-element-all-successors'. Maybe tweak
2488 ;; restrictions about it, and that's it.
2491 ;;;; Bold
2494 "Parse bold object at point.
2496 Return a list whose CAR is `bold' and CDR is a plist with
2497 `:begin', `:end', `:contents-begin' and `:contents-end' and
2498 `:post-blank' keywords.
2500 Assume point is at the first star marker."
2512 :end end
2513 :contents-begin contents-begin
2514 :contents-end contents-end
2518 "Interpret BOLD object as Org syntax.
2519 CONTENTS is the contents of the object."
2523 "Search for the next text-markup object.
2525 LIMIT bounds the search.
2527 Return value is a cons cell whose CAR is a symbol among `bold',
2528 `italic', `underline', `strike-through', `code' and `verbatim'
2529 and CDR is beginning position."
2545 ;;;; Code
2548 "Parse code object at point.
2550 Return a list whose CAR is `code' and CDR is a plist with
2551 `:value', `:begin', `:end' and `:post-blank' keywords.
2553 Assume point is at the first tilde marker."
2564 :begin begin
2565 :end end
2569 "Interpret CODE object as Org syntax.
2570 CONTENTS is nil."
2574 ;;;; Entity
2577 "Parse entity at point.
2579 Return a list whose CAR is `entity' and CDR a plist with
2580 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2581 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2582 keywords.
2584 Assume point is at the beginning of the entity."
2586 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2602 :begin begin
2603 :end end
2604 :use-brackets-p bracketsp
2608 "Interpret ENTITY object as Org syntax.
2609 CONTENTS is nil."
2615 "Search for the next latex-fragment or entity object.
2617 LIMIT bounds the search.
2619 Return value is a cons cell whose CAR is `entity' or
2620 `latex-fragment' and CDR is beginning position."
2625 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2632 limit t)
2635 ;; Determine if it's a real entity or a LaTeX command.
2638 ;; No entity nor command: point is at a LaTeX fragment.
2639 ;; Determine its type to get the correct beginning position.
2647 matchers)
2651 ;;;; Export Snippet
2654 "Parse export snippet at point.
2656 Return a list whose CAR is `export-snippet' and CDR a plist with
2657 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2658 keywords.
2660 Assume point is at the beginning of the snippet."
2672 :value value
2673 :begin begin
2674 :end end
2678 "Interpret EXPORT-SNIPPET object as Org syntax.
2679 CONTENTS is nil."
2685 "Search for the next export-snippet object.
2687 LIMIT bounds the search.
2689 Return value is a cons cell whose CAR is `export-snippet' and CDR
2690 its beginning position."
2699 ;;;; Footnote Reference
2702 "Parse footnote reference at point.
2704 Return a list whose CAR is `footnote-reference' and CDR a plist
2705 with `:label', `:type', `:inline-definition', `:begin', `:end'
2706 and `:post-blank' as keywords."
2728 :type type
2729 :begin begin
2730 :end end
2733 footnote-reference :inline-definition
2738 footnote-reference))))))
2741 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2742 CONTENTS is nil."
2752 "Search for the next footnote-reference object.
2754 LIMIT bounds the search.
2756 Return value is a cons cell whose CAR is `footnote-reference' and
2757 CDR is beginning position."
2771 ;;;; Inline Babel Call
2774 "Parse inline babel call at point.
2776 Return a list whose CAR is `inline-babel-call' and CDR a plist
2777 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2779 Assume point is at the beginning of the babel call."
2790 :end end
2791 :info info
2795 "Interpret INLINE-BABEL-CALL object as Org syntax.
2796 CONTENTS is nil."
2802 ;; Remove redundant square brackets.
2805 main-source)
2809 "Search for the next inline-babel-call object.
2811 LIMIT bounds the search.
2813 Return value is a cons cell whose CAR is `inline-babel-call' and
2814 CDR is beginning position."
2816 ;; Use a simplified version of
2817 ;; `org-babel-inline-lob-one-liner-regexp'.
2820 limit t)
2824 ;;;; Inline Src Block
2827 "Parse inline source block at point.
2829 LIMIT bounds the search.
2831 Return a list whose CAR is `inline-src-block' and CDR a plist
2832 with `:begin', `:end', `:language', `:value', `:parameters' and
2833 `:post-blank' as keywords.
2835 Assume point is at the beginning of the inline src block."
2848 :value value
2849 :parameters parameters
2850 :begin begin
2851 :end end
2855 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2856 CONTENTS is nil."
2861 language
2863 body)))
2866 "Search for the next inline-babel-call element.
2868 LIMIT bounds the search.
2870 Return value is a cons cell whose CAR is `inline-babel-call' and
2871 CDR is beginning position."
2877 ;;;; Italic
2880 "Parse italic object at point.
2882 Return a list whose CAR is `italic' and CDR is a plist with
2883 `:begin', `:end', `:contents-begin' and `:contents-end' and
2884 `:post-blank' keywords.
2886 Assume point is at the first slash marker."
2898 :end end
2899 :contents-begin contents-begin
2900 :contents-end contents-end
2904 "Interpret ITALIC object as Org syntax.
2905 CONTENTS is the contents of the object."
2909 ;;;; Latex Fragment
2912 "Parse latex fragment at point.
2914 Return a list whose CAR is `latex-fragment' and CDR a plist with
2915 `:value', `:begin', `:end', and `:post-blank' as keywords.
2917 Assume point is at the beginning of the latex fragment."
2931 ;; None found: it's a macro.
2940 :begin begin
2941 :end end
2945 "Interpret LATEX-FRAGMENT object as Org syntax.
2946 CONTENTS is nil."
2949 ;;;; Line Break
2952 "Parse line break at point.
2954 Return a list whose CAR is `line-break', and CDR a plist with
2955 `:begin', `:end' and `:post-blank' keywords.
2957 Assume point is at the beginning of the line break."
2964 "Interpret LINE-BREAK object as Org syntax.
2965 CONTENTS is nil."
2969 "Search for the next line-break object.
2971 LIMIT bounds the search.
2973 Return value is a cons cell whose CAR is `line-break' and CDR is
2974 beginning position."
2978 ;; A line break can only happen on a non-empty line.
2983 ;;;; Link
2986 "Parse link at point.
2988 Return a list whose CAR is `link' and CDR a plist with `:type',
2989 `:path', `:raw-link', `:application', `:search-option', `:begin',
2990 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2991 keywords.
2993 Assume point is at the beginning of the link."
2996 end contents-begin contents-end link-end post-blank path type
2997 raw-link link search-option application)
2999 ;; Type 1: Text targeted from a radio target.
3004 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3009 ;; RAW-LINK is the original link. Expand any
3010 ;; abbreviation in it.
3015 ;; Determine TYPE of link and set PATH accordingly.
3017 ;; File type.
3020 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3023 ;; Id type: PATH is the id.
3026 ;; Code-ref type: PATH is the name of the reference.
3029 ;; Custom-id type: PATH is the name of the custom id.
3032 ;; Fuzzy type: Internal link either matches a target, an
3033 ;; headline name or nothing. PATH is the target or
3034 ;; headline's name.
3036 ;; Type 3: Plain link, i.e. http://orgmode.org
3042 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3049 ;; In any case, deduce end point after trailing white space from
3050 ;; LINK-END variable.
3053 ;; Extract search option and opening application out of
3054 ;; "file"-type links.
3056 ;; Application.
3061 ;; Extract search option from PATH.
3065 ;; Make sure TYPE always report "file".
3069 :path path
3071 :application application
3072 :search-option search-option
3073 :begin begin
3074 :end end
3075 :contents-begin contents-begin
3076 :contents-end contents-end
3080 "Interpret LINK object as Org syntax.
3081 CONTENTS is the contents of the object, or nil."
3086 raw-link
3090 "Search for the next link object.
3092 LIMIT bounds the search.
3094 Return value is a cons cell whose CAR is `link' and CDR is
3095 beginning position."
3104 "Search for the next plain link object.
3106 LIMIT bounds the search.
3108 Return value is a cons cell whose CAR is `link' and CDR is
3109 beginning position."
3114 ;;;; Macro
3117 "Parse macro at point.
3119 Return a list whose CAR is `macro' and CDR a plist with `:key',
3120 `:args', `:begin', `:end', `:value' and `:post-blank' as
3121 keywords.
3123 Assume point is at the macro."
3134 ;; Do not use `org-split-string' since empty
3135 ;; strings are meaningful here.
3139 ;; Repair bad splits, when comma is protected,
3140 ;; and thus not a real separator.
3148 :value value
3149 :args args
3150 :begin begin
3151 :end end
3155 "Interpret MACRO object as Org syntax.
3156 CONTENTS is nil."
3160 "Search for the next macro object.
3162 LIMIT bounds the search.
3164 Return value is cons cell whose CAR is `macro' and CDR is
3165 beginning position."
3169 limit t)
3173 ;;;; Radio-target
3176 "Parse radio target at point.
3178 Return a list whose CAR is `radio-target' and CDR a plist with
3179 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3180 and `:post-blank' as keywords.
3182 Assume point is at the radio target."
3194 :end end
3195 :contents-begin contents-begin
3196 :contents-end contents-end
3197 :post-blank post-blank
3201 "Interpret TARGET object as Org syntax.
3202 CONTENTS is the contents of the object."
3206 "Search for the next radio-target object.
3208 LIMIT bounds the search.
3210 Return value is a cons cell whose CAR is `radio-target' and CDR
3211 is beginning position."
3217 ;;;; Statistics Cookie
3220 "Parse statistics cookie at point.
3222 Return a list whose CAR is `statistics-cookie', and CDR a plist
3223 with `:begin', `:end', `:value' and `:post-blank' keywords.
3225 Assume point is at the beginning of the statistics-cookie."
3236 :end end
3237 :value value
3241 "Interpret STATISTICS-COOKIE object as Org syntax.
3242 CONTENTS is nil."
3246 "Search for the next statistics cookie object.
3248 LIMIT bounds the search.
3250 Return value is a cons cell whose CAR is `statistics-cookie' and
3251 CDR is beginning position."
3257 ;;;; Strike-Through
3260 "Parse strike-through object at point.
3262 Return a list whose CAR is `strike-through' and CDR is a plist
3263 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3264 `:post-blank' keywords.
3266 Assume point is at the first plus sign marker."
3278 :end end
3279 :contents-begin contents-begin
3280 :contents-end contents-end
3284 "Interpret STRIKE-THROUGH object as Org syntax.
3285 CONTENTS is the contents of the object."
3289 ;;;; Subscript
3292 "Parse subscript at point.
3294 Return a list whose CAR is `subscript' and CDR a plist with
3295 `:begin', `:end', `:contents-begin', `:contents-end',
3296 `:use-brackets-p' and `:post-blank' as keywords.
3298 Assume point is at the underscore."
3302 t
3313 :end end
3314 :use-brackets-p bracketsp
3315 :contents-begin contents-begin
3316 :contents-end contents-end
3320 "Interpret SUBSCRIPT object as Org syntax.
3321 CONTENTS is the contents of the object."
3324 contents))
3327 "Search for the next sub/superscript object.
3329 LIMIT bounds the search.
3331 Return value is a cons cell whose CAR is either `subscript' or
3332 `superscript' and CDR is beginning position."
3340 ;;;; Superscript
3343 "Parse superscript at point.
3345 Return a list whose CAR is `superscript' and CDR a plist with
3346 `:begin', `:end', `:contents-begin', `:contents-end',
3347 `:use-brackets-p' and `:post-blank' as keywords.
3349 Assume point is at the caret."
3363 :end end
3364 :use-brackets-p bracketsp
3365 :contents-begin contents-begin
3366 :contents-end contents-end
3370 "Interpret SUPERSCRIPT object as Org syntax.
3371 CONTENTS is the contents of the object."
3374 contents))
3377 ;;;; Table Cell
3380 "Parse table cell at point.
3382 Return a list whose CAR is `table-cell' and CDR is a plist
3383 containing `:begin', `:end', `:contents-begin', `:contents-end'
3384 and `:post-blank' keywords."
3392 :end end
3393 :contents-begin contents-begin
3394 :contents-end contents-end
3398 "Interpret TABLE-CELL element as Org syntax.
3399 CONTENTS is the contents of the cell, or nil."
3403 "Search for the next table-cell object.
3405 LIMIT bounds the search.
3407 Return value is a cons cell whose CAR is `table-cell' and CDR is
3408 beginning position."
3412 ;;;; Target
3415 "Parse target at point.
3417 Return a list whose CAR is `target' and CDR a plist with
3418 `:begin', `:end', `:value' and `:post-blank' as keywords.
3420 Assume point is at the target."
3430 :end end
3431 :value value
3435 "Interpret TARGET object as Org syntax.
3436 CONTENTS is nil."
3440 "Search for the next target object.
3442 LIMIT bounds the search.
3444 Return value is a cons cell whose CAR is `target' and CDR is
3445 beginning position."
3451 ;;;; Timestamp
3454 "Parse time stamp at point.
3456 Return a list whose CAR is `timestamp', and CDR a plist with
3457 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3459 Assume point is at the beginning of the timestamp."
3477 date-start)
3488 raw-value)
3490 :repeater-type
3496 :repeater-unit
3499 year-start month-start day-start hour-start minute-start year-end
3500 month-end day-end hour-end minute-end)
3501 ;; Parse date-start.
3509 ;; Compute date-end. It can be provided directly in time-stamp,
3510 ;; or extracted from time range. Otherwise, it defaults to the
3511 ;; same values as date-start.
3521 :raw-value raw-value
3522 :year-start year-start
3523 :month-start month-start
3524 :day-start day-start
3525 :hour-start hour-start
3526 :minute-start minute-start
3527 :year-end year-end
3528 :month-end month-end
3529 :day-end day-end
3530 :hour-end hour-end
3531 :minute-end minute-end
3532 :begin begin
3533 :end end
3535 repeater-props)))))
3538 "Interpret TIMESTAMP object as Org syntax.
3539 CONTENTS is nil."
3540 ;; Use `:raw-value' if specified.
3542 ;; Otherwise, build timestamp string.
3552 ;; Build an Org timestamp string from TIME. ACTIVEP is
3553 ;; non-nil when time stamp is active. If WITH-TIME-P is
3554 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3555 ;; specify a time range in the timestamp. REPEAT-STRING
3556 ;; is the repeater string, if any.
3560 org-time-stamp-formats)
3561 time)))
3567 nil nil ts)))
3571 " "
3572 repeat-string
3574 ;; Return value.
3575 ts)))
3587 build-ts-string
3606 0
3614 "--"
3626 "Search for the next timestamp object.
3628 LIMIT bounds the search.
3630 Return value is a cons cell whose CAR is `timestamp' and CDR is
3631 beginning position."
3639 limit t)
3643 ;;;; Underline
3646 "Parse underline object at point.
3648 Return a list whose CAR is `underline' and CDR is a plist with
3649 `:begin', `:end', `:contents-begin' and `:contents-end' and
3650 `:post-blank' keywords.
3652 Assume point is at the first underscore marker."
3664 :end end
3665 :contents-begin contents-begin
3666 :contents-end contents-end
3670 "Interpret UNDERLINE object as Org syntax.
3671 CONTENTS is the contents of the object."
3675 ;;;; Verbatim
3678 "Parse verbatim object at point.
3680 Return a list whose CAR is `verbatim' and CDR is a plist with
3681 `:value', `:begin', `:end' and `:post-blank' keywords.
3683 Assume point is at the first equal sign marker."
3694 :begin begin
3695 :end end
3699 "Interpret VERBATIM object as Org syntax.
3700 CONTENTS is nil."
3704 \f
3705 ;;; Parsing Element Starting At Point
3706 ;;
3707 ;; `org-element--current-element' is the core function of this section.
3708 ;; It returns the Lisp representation of the element starting at
3709 ;; point.
3710 ;;
3711 ;; `org-element--current-element' makes use of special modes. They
3712 ;; are activated for fixed element chaining (i.e. `plain-list' >
3713 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3714 ;; `section'). Special modes are: `first-section', `item',
3715 ;; `node-property', `quote-section', `section' and `table-row'.
3719 "Parse the element starting at point.
3721 LIMIT bounds the search.
3723 Return value is a list like (TYPE PROPS) where TYPE is the type
3724 of the element and PROPS a plist of properties associated to the
3725 element.
3727 Possible types are defined in `org-element-all-elements'.
3729 Optional argument GRANULARITY determines the depth of the
3730 recursion. Allowed values are `headline', `greater-element',
3731 `element', `object' or nil. When it is broader than `object' (or
3732 nil), secondary values will not be parsed, since they only
3733 contain objects.
3735 Optional argument SPECIAL, when non-nil, can be either
3736 `first-section', `item', `node-property', `quote-section',
3737 `section', and `table-row'.
3739 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3740 be computed.
3742 This function assumes point is always at the beginning of the
3743 element it has to parse."
3746 ;; Determine if parsing depth allows for secondary strings
3747 ;; parsing. It only applies to elements referenced in
3748 ;; `org-element-secondary-value-alist'.
3751 ;; Item.
3754 ;; Table Row.
3756 ;; Node Property.
3758 ;; Headline.
3761 ;; Sections (must be checked after headline).
3767 limit)))
3768 ;; When not at bol, point is at the beginning of an item or
3769 ;; a footnote definition: next item is always a paragraph.
3771 ;; Planning and Clock.
3776 ;; Inlinetask.
3779 ;; From there, elements can have affiliated keywords.
3782 ;; Jumping over affiliated keywords put point off-limits.
3783 ;; Parse them as regular keywords.
3787 ;; LaTeX Environment.
3790 ;; Drawer and Property Drawer.
3795 ;; Fixed Width
3798 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3799 ;; Keywords.
3808 org-element-block-name-alist)))
3823 ;; Footnote Definition.
3826 ;; Horizontal Rule.
3829 ;; Diary Sexp.
3832 ;; Table.
3834 ;; List.
3838 ;; Default element: Paragraph.
3842 ;; Most elements can have affiliated keywords. When looking for an
3843 ;; element beginning, we want to move before them, as they belong to
3844 ;; that element, and, in the meantime, collect information they give
3845 ;; into appropriate properties. Hence the following function.
3848 "Collect affiliated keywords from point down to LIMIT.
3850 Return a list whose CAR is the position at the first of them and
3851 CDR a plist of keywords and values and move point to the
3852 beginning of the first line after them.
3854 As a special case, if element doesn't start at the beginning of
3855 the line (i.e. a paragraph starting an item), CAR is current
3856 position of point and CDR is nil."
3860 ;; RESTRICT is the list of objects allowed in parsed
3861 ;; keywords value.
3863 output)
3866 ;; Apply translation to RAW-KWD. From there, KWD is
3867 ;; the official keyword.
3869 org-element-keyword-translation-alist))
3870 raw-kwd))
3871 ;; Find main value for any keyword.
3877 ;; PARSEDP is non-nil when keyword should have its
3878 ;; value parsed.
3880 ;; If KWD is a dual keyword, find its secondary
3881 ;; value. Maybe parse it.
3888 ;; Attribute a property name to KWD.
3890 ;; Now set final shape for VALUE.
3896 ;; Attributes can always appear on multiple lines.
3899 ;; Eventually store the new value in OUTPUT.
3901 ;; Move to next keyword.
3903 ;; If affiliated keywords are orphaned: move back to first one.
3904 ;; They will be parsed as a paragraph.
3906 ;; Return value.
3910 \f
3911 ;;; The Org Parser
3912 ;;
3913 ;; The two major functions here are `org-element-parse-buffer', which
3914 ;; parses Org syntax inside the current buffer, taking into account
3915 ;; region, narrowing, or even visibility if specified, and
3916 ;; `org-element-parse-secondary-string', which parses objects within
3917 ;; a given string.
3918 ;;
3919 ;; The (almost) almighty `org-element-map' allows to apply a function
3920 ;; on elements or objects matching some type, and accumulate the
3921 ;; resulting values. In an export situation, it also skips unneeded
3922 ;; parts of the parse tree.
3925 "Recursively parse the buffer and return structure.
3926 If narrowing is in effect, only parse the visible part of the
3927 buffer.
3929 Optional argument GRANULARITY determines the depth of the
3930 recursion. It can be set to the following symbols:
3932 `headline' Only parse headlines.
3933 `greater-element' Don't recurse into greater elements excepted
3934 headlines and sections. Thus, elements
3935 parsed are the top-level ones.
3936 `element' Parse everything but objects and plain text.
3937 `object' Parse the complete buffer (default).
3939 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3940 elements.
3942 An element or an objects is represented as a list with the
3943 pattern (TYPE PROPERTIES CONTENTS), where :
3945 TYPE is a symbol describing the element or object. See
3946 `org-element-all-elements' and `org-element-all-objects' for an
3947 exhaustive list of such symbols. One can retrieve it with
3948 `org-element-type' function.
3950 PROPERTIES is the list of attributes attached to the element or
3951 object, as a plist. Although most of them are specific to the
3952 element or object type, all types share `:begin', `:end',
3953 `:post-blank' and `:parent' properties, which respectively
3954 refer to buffer position where the element or object starts,
3955 ends, the number of white spaces or blank lines after it, and
3956 the element or object containing it. Properties values can be
3957 obtained by using `org-element-property' function.
3959 CONTENTS is a list of elements, objects or raw strings
3960 contained in the current element or object, when applicable.
3961 One can access them with `org-element-contents' function.
3963 The Org buffer has `org-data' as type and nil as properties.
3964 `org-element-map' function can be used to find specific elements
3965 or objects within the parse tree.
3967 This function assumes that current major mode is `org-mode'."
3973 ;; Start in `first-section' mode so text before the first
3974 ;; headline belongs to a section.
3978 "Recursively parse objects in STRING and return structure.
3980 RESTRICTION is a symbol limiting the object types that will be
3981 looked after.
3983 Optional argument PARENT, when non-nil, is the element or object
3984 containing the secondary string. It is used to set correctly
3985 `:parent' property within the string."
3986 ;; Copy buffer-local variables listed in
3987 ;; `org-element-object-variables' into temporary buffer. This is
3988 ;; required since object parsing is dependent on these variables.
3992 org-element-object-variables))))
4000 secondary))
4001 secondary))))
4005 "Map a function on selected elements or objects.
4007 DATA is a parse tree, an element, an object, a string, or a list
4008 of such constructs. TYPES is a symbol or list of symbols of
4009 elements or objects types (see `org-element-all-elements' and
4010 `org-element-all-objects' for a complete list of types). FUN is
4011 the function called on the matching element or object. It has to
4012 accept one argument: the element or object itself.
4014 When optional argument INFO is non-nil, it should be a plist
4015 holding export options. In that case, parts of the parse tree
4016 not exportable according to that property list will be skipped.
4018 When optional argument FIRST-MATCH is non-nil, stop at the first
4019 match for which FUN doesn't return nil, and return that value.
4021 Optional argument NO-RECURSION is a symbol or a list of symbols
4022 representing elements or objects types. `org-element-map' won't
4023 enter any recursive element or object whose type belongs to that
4024 list. Though, FUN can still be applied on them.
4026 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4027 apply to matching objects within parsed affiliated keywords (see
4028 `org-element-parsed-keywords').
4030 Nil values returned from FUN do not appear in the results.
4033 Examples:
4034 --------
4036 Assuming TREE is a variable containing an Org buffer parse tree,
4037 the following example will return a flat list of all `src-block'
4038 and `example-block' elements in it:
4040 \(org-element-map tree '(example-block src-block) 'identity)
4042 The following snippet will find the first headline with a level
4045 \(org-element-map tree 'headline
4046 \(lambda (hl)
4047 \(and (= (org-element-property :level hl) 1)
4049 \(org-element-property :begin hl)))
4050 nil t)
4052 The next example will return a flat list of all `plain-list' type
4053 elements in TREE that are not a sub-list themselves:
4055 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4057 Eventually, this example will return a flat list of all `bold'
4058 type objects containing a `latex-snippet' type object, even
4059 looking into captions:
4061 \(org-element-map tree 'bold
4062 \(lambda (b)
4063 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4064 nil nil nil t)"
4065 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4068 ;; Recursion depth is determined by --CATEGORY.
4075 ;; If one object is found, the function
4076 ;; has to recurse into every object.
4079 ;; If one regular element is found, the
4080 ;; function has to recurse, at least,
4081 ;; into every element it encounters.
4084 types)
4085 category)))
4086 ;; Compute properties for affiliated keywords if necessary.
4091 org-element-affiliated-keywords)))
4092 --acc
4093 --walk-tree
4097 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4098 ;; holding contextual information.
4102 ;; Ignored element in an export context.
4104 ;; List of elements or objects.
4106 ;; Unconditionally enter parse trees.
4110 ;; Check if TYPE is matching among TYPES. If so,
4111 ;; apply FUN to --DATA and accumulate return value
4112 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4118 ;; If --DATA has a secondary string that can contain
4119 ;; objects with their type among TYPES, look into it.
4126 ;; If --DATA has any affiliated keywords and
4127 ;; WITH-AFFILIATED is non-nil, look for objects in
4128 ;; them.
4136 ;; Pay attention to the type of value.
4137 ;; Preserve order for multiple keywords.
4153 --affiliated-alist))
4154 ;; Determine if a recursion into --DATA is possible.
4156 ;; --TYPE is explicitly removed from recursion.
4158 ;; --DATA has no contents.
4160 ;; Looking for greater elements but --DATA is simply
4161 ;; an element or an object.
4164 ;; Looking for elements but --DATA is an object.
4167 ;; In any other case, map contents.
4171 ;; Return value in a proper order.
4175 ;; The following functions are internal parts of the parser.
4176 ;;
4177 ;; The first one, `org-element--parse-elements' acts at the element's
4178 ;; level.
4179 ;;
4180 ;; The second one, `org-element--parse-objects' applies on all objects
4181 ;; of a paragraph or a secondary string. It uses
4182 ;; `org-element--get-next-object-candidates' to optimize the search of
4183 ;; the next object in the buffer.
4184 ;;
4185 ;; More precisely, that function looks for every allowed object type
4186 ;; first. Then, it discards failed searches, keeps further matches,
4187 ;; and searches again types matched behind point, for subsequent
4188 ;; calls. Thus, searching for a given type fails only once, and every
4189 ;; object is searched only once at top level (but sometimes more for
4190 ;; nested types).
4194 "Parse elements between BEG and END positions.
4196 SPECIAL prioritize some elements over the others. It can be set
4197 to `first-section', `quote-section', `section' `item' or
4198 `table-row'.
4200 When value is `item', STRUCTURE will be used as the current list
4201 structure.
4203 GRANULARITY determines the depth of the recursion. See
4204 `org-element-parse-buffer' for more information.
4206 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4207 elements.
4209 Elements are accumulated into ACC."
4212 ;; When parsing only headlines, skip any text before first one.
4215 ;; Main loop start.
4217 ;; Find current element's type and parse it accordingly to
4218 ;; its category.
4220 end granularity special structure))
4224 ;; Fill ELEMENT contents by side-effect.
4226 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4227 ;; no contents, don't modify it.
4230 ;; Greater element: parse it between `contents-begin' and
4231 ;; `contents-end'. Make sure GRANULARITY allows the
4232 ;; recursion, or ELEMENT is a headline, in which case going
4233 ;; inside is mandatory, in order to get sub-level headings.
4241 ;; Possibly switch to a special mode.
4251 granularity visible-only element))
4252 ;; ELEMENT has contents. Parse objects inside, if
4253 ;; GRANULARITY allows it.
4259 ;; Return result.
4260 acc))
4263 "Parse objects between BEG and END and return recursive structure.
4265 Objects are accumulated in ACC.
4267 RESTRICTION is a list of object successors which are allowed in
4268 the current object."
4274 end restriction candidates)))
4281 ;; 1. Text before any object. Untabify it.
4286 acc
4290 ;; 2. Object...
4293 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4294 ;; a recursive type.
4299 cont-beg
4306 ;; 3. Text after last object. Untabify it.
4310 acc
4314 ;; Result.
4315 acc)))
4318 "Return an alist of candidates for the next object.
4320 LIMIT bounds the search, and RESTRICTION narrows candidates to
4321 some object successors.
4323 OBJECTS is the previous candidates alist. If it is set to
4324 `initial', no search has been done before, and all symbols in
4325 RESTRICTION should be looked after.
4327 Return value is an alist whose CAR is the object type and CDR its
4328 beginning position."
4330 nil
4332 ;; When searching for the first time, look for every successor
4333 ;; allowed in RESTRICTION.
4337 restriction)
4338 ;; Focus on objects returned during last search. Keep those
4339 ;; still after point. Search again objects before it.
4345 type)))
4348 limit)))))
4349 objects))))
4352 \f
4353 ;;; Towards A Bijective Process
4354 ;;
4355 ;; The parse tree obtained with `org-element-parse-buffer' is really
4356 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4357 ;; interpreted and expanded into a string with canonical Org syntax.
4358 ;; Hence `org-element-interpret-data'.
4359 ;;
4360 ;; The function relies internally on
4361 ;; `org-element--interpret-affiliated-keywords'.
4363 ;;;###autoload
4365 "Interpret DATA as Org syntax.
4367 DATA is a parse tree, an element, an object or a secondary string
4368 to interpret.
4370 Optional argument PARENT is used for recursive calls. It contains
4371 the element or object containing data, or nil.
4373 Return Org syntax as a string."
4377 ;; Secondary string.
4382 ;; Full Org document.
4387 ;; Plain text: remove `:parent' text property from output.
4389 ;; Element/Object without contents.
4392 data nil))
4393 ;; Element/Object with contents.
4403 ;; Elements directly containing objects must
4404 ;; have their indentation normalized first.
4406 data
4407 ;; When normalizing first paragraph of an
4408 ;; item or a footnote-definition, ignore
4409 ;; first line's indentation.
4416 data
4418 contents)))))))
4420 ;; Build white spaces. If no `:post-blank' property is
4421 ;; specified, assume its value is 0.
4431 "Return ELEMENT's affiliated keywords as Org syntax.
4432 If there is no affiliated keyword, return the empty string."
4442 ": "
4445 value)
4453 ;; All attribute keywords can have multiple lines.
4459 ;; List all ELEMENT's properties matching an attribute line or an
4460 ;; affiliated keyword, but ignore translated keywords since they
4461 ;; cannot belong to the property list.
4468 org-element-keyword-translation-alist)))))
4469 collect prop)
4472 ;; Because interpretation of the parse tree must return the same
4473 ;; number of blank lines between elements and the same number of white
4474 ;; space after objects, some special care must be given to white
4475 ;; spaces.
4476 ;;
4477 ;; The first function, `org-element-normalize-string', ensures any
4478 ;; string different from the empty string will end with a single
4479 ;; newline character.
4480 ;;
4481 ;; The second function, `org-element-normalize-contents', removes
4482 ;; global indentation from the contents of the current element.
4485 "Ensure string S ends with a single newline character.
4487 If S isn't a string return it unchanged. If S is the empty
4488 string, return it. Otherwise, return a new string with a single
4489 newline character at its end."
4497 "Normalize plain text in ELEMENT's contents.
4499 ELEMENT must only contain plain text and objects.
4501 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4502 indentation to compute maximal common indentation.
4504 Return the normalized element that is element with global
4505 indentation removed from its contents. The function assumes that
4506 indentation is not done with TAB characters."
4508 collect-inds ; for byte-compiler
4511 ;; Return list of indentations within BLOB. This is done by
4512 ;; walking recursively BLOB and updating IND-LIST along the
4513 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4514 ;; been seen yet. It is required as this string is the only
4515 ;; one whose indentation doesn't happen after a newline
4516 ;; character.
4524 ;; An indentation of zero means no string will be
4525 ;; modified. Quit the process.
4531 ;; Avoid matching blank or empty lines.
4539 ;; Collect indentation list in ELEMENT. Possibly remove first
4540 ;; value if IGNORE-FIRST is non-nil.
4543 ;; Build ELEMENT back, replacing each string with the same
4544 ;; string minus common indentation.
4549 ;; Return BLOB with all its strings indentation
4550 ;; shortened from MCI white spaces. FIRST-FLAG is
4551 ;; non-nil when the first string hasn't been seen
4552 ;; yet.
4566 org-element-recursive-objects)
4570 blob))))
4574 \f
4575 ;;; The Toolbox
4576 ;;
4577 ;; The first move is to implement a way to obtain the smallest element
4578 ;; containing point. This is the job of `org-element-at-point'. It
4579 ;; basically jumps back to the beginning of section containing point
4580 ;; and moves, element after element, with
4581 ;; `org-element--current-element' until the container is found. Note:
4582 ;; When using `org-element-at-point', secondary values are never
4583 ;; parsed since the function focuses on elements, not on objects.
4584 ;;
4585 ;; At a deeper level, `org-element-context' lists all elements and
4586 ;; objects containing point.
4587 ;;
4588 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4589 ;; internally by navigation and manipulation tools.
4591 ;;;###autoload
4593 "Determine closest element around point.
4595 Return value is a list like (TYPE PROPS) where TYPE is the type
4596 of the element and PROPS a plist of properties associated to the
4597 element.
4599 Possible types are defined in `org-element-all-elements'.
4600 Properties depend on element or object type, but always include
4601 `:begin', `:end', `:parent' and `:post-blank' properties.
4603 As a special case, if point is at the very beginning of a list or
4604 sub-list, returned element will be that list instead of the first
4605 item. In the same way, if point is at the beginning of the first
4606 row of a table, returned element will be the table instead of the
4607 first row.
4609 If optional argument KEEP-TRAIL is non-nil, the function returns
4610 a list of elements leading to element at point. The list's CAR
4611 is always the element at point. The following positions contain
4612 element's siblings, then parents, siblings of parents, until the
4613 first element of current section."
4615 ;; If at a headline, parse it. It is the sole element that
4616 ;; doesn't require to know about context. Be sure to disallow
4617 ;; secondary string parsing, though.
4623 ;; Otherwise move at the beginning of the section containing
4624 ;; point.
4629 element type special-flag trail struct prevs parent)
4632 ;; In empty lines at buffer's beginning, return nil.
4641 ;; In blank lines just after the headline, point still
4642 ;; belongs to the headline.
4650 ;; Parse successively each element, skipping those ending
4651 ;; before original position.
4659 ;; 1. Skip any element ending before point. Also skip
4660 ;; element ending at point when we're sure that another
4661 ;; element has started.
4666 ;; 2. An element containing point is always the element at
4667 ;; point.
4670 ;; 3. At any other greater element type, if point is
4671 ;; within contents, move into it.
4676 ;; Create an anchor for tables and plain lists:
4677 ;; when point is at the very beginning of these
4678 ;; elements, ignoring affiliated keywords,
4679 ;; target them instead of their contents.
4681 ;; When point is at contents end, do not move
4682 ;; into elements with an explicit ending, but
4683 ;; return that element instead.
4687 drawer dynamic-block inlinetask item
4688 plain-list property-drawer quote-block
4689 special-block))))
4704 ;;;###autoload
4706 "Return closest element or object around point.
4708 Return value is a list like (TYPE PROPS) where TYPE is the type
4709 of the element or object and PROPS a plist of properties
4710 associated to it.
4712 Possible types are defined in `org-element-all-elements' and
4713 `org-element-all-objects'. Properties depend on element or
4714 object type, but always include `:begin', `:end', `:parent' and
4715 `:post-blank'.
4717 Optional argument ELEMENT, when non-nil, is the closest element
4718 containing point, as returned by `org-element-at-point'.
4719 Providing it allows for quicker computation."
4724 end)
4725 ;; Check if point is inside an element containing objects or at
4726 ;; a secondary string. In that case, move to beginning of the
4727 ;; element or secondary string and set END to the other side.
4734 org-element-parsed-keywords))
4735 ;; We're at an affiliated keyword. Change
4736 ;; type to retrieve correct restrictions.
4738 ;; Determine if we're at main or dual value.
4752 (<= origin
4753 ;; `1+' is required so some
4754 ;; successors can match
4755 ;; properly their object.
4776 element
4782 end restriction candidates))
4784 candidates)))
4785 ;; If ORIGIN is before next object in element, there's
4786 ;; no point in looking further.
4796 ;; ORIGIN is after OBJECT, so skip it.
4802 ;; ORIGIN is within a non-recursive object or at
4803 ;; an object boundaries: Return that object.
4807 ;; Otherwise, move within current object and
4808 ;; restrict search to the end of its contents.
4813 candidates 'initial
4814 end cend)))))))
4815 parent))))))
4818 "Non-nil when elements ELEM-A and ELEM-B are nested."
4827 "Swap elements ELEM-A and ELEM-B.
4828 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4829 end of ELEM-A."
4831 ;; There are two special cases when an element doesn't start at bol:
4832 ;; the first paragraph in an item or in a footnote definition.
4834 ;; Only a paragraph without any affiliated keyword can be moved at
4835 ;; ELEM-A position in such a situation. Note that the case of
4836 ;; a footnote definition is impossible: it cannot contain two
4837 ;; paragraphs in a row because it cannot contain a blank line.
4843 ;; In a special situation, ELEM-A will have no indentation. We'll
4844 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4858 ;; Store overlays responsible for visibility status. We
4859 ;; also need to store their boundaries as they will be
4860 ;; removed from buffer.
4867 ;; Get contents.
4875 ;; Restore ex ELEM-A overlays.
4884 ;; Restore ex ELEM-B overlays.
4893 ;; Local variables:
4894 ;; generated-autoload-file: "org-loaddefs.el"
4895 ;; End:
4897 ;;; org-element.el ends here