| blob | 3dc1e72269afd6568dd99a69bf667000a0001263 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or an headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
202 Sharing the same successor comes handy when, for example, the
207 inline-src-block italic line-break latex-fragment link macro
208 radio-target statistics-cookie strike-through subscript superscript
209 table-cell target timestamp underline verbatim)
214 table-cell underline)
224 "Alist between block names and the associated parsing function.
225 Names must be uppercase. Any block whose name has no association
231 Only these types can accept search options and an explicit
237 "List of affiliated keywords as strings.
243 ;; Regular affiliated keywords.
246 "Regexp matching any affiliated keyword.
248 Keyword name is put in match group 1. Moreover, if keyword
249 belongs to `org-element-dual-keywords', put the dual value in
250 match group 2.
258 "Alist of usual translations for keywords.
259 The key is the old name and the value the new one. The property
263 "List of affiliated keywords that can occur more than once in an element.
265 Their value will be consed into a list of strings, which will be
266 returned as the value of the property.
268 This list is checked after translations have been applied. See
269 `org-element-keyword-translation-alist'.
275 "List of affiliated keywords whose value can be parsed.
277 Their value will be stored as a secondary string: a list of
278 strings and objects.
280 This list is checked after translations have been applied. See
284 "List of affiliated keywords which can have a secondary value.
286 In Org syntax, they can be written with optional square brackets
287 before the colons. For example, RESULTS keyword can be
288 associated to a hash value with the following:
290 #+RESULTS[hash-string]: some-source
292 This list is checked after translations have been applied. See
296 "List of properties associated to the whole document.
297 Any keyword in this list will have its value parsed and stored as
304 inline-src-block latex-or-entity line-break link macro
305 radio-target sub/superscript target text-markup
306 timestamp)
308 radio-target statistics-cookie sub/superscript target text-markup
309 timestamp)
321 inline-src-block latex-or-entity line-break link macro
322 radio-target statistics-cookie sub/superscript target text-markup
323 timestamp)
326 latex-or-entity link radio-target sub/superscript target
327 text-markup timestamp)
338 latex-or-entity line-break link macro radio-target
340 "Alist of objects restrictions.
342 CAR is an element or object type containing objects and CDR is
343 a list of successors that will be called within an element or
344 object of such type.
346 For example, in a `radio-target' object, one can only find
347 entities, export snippets, latex-fragments, subscript and
348 superscript.
350 This alist also applies to secondary string. For example, an
351 `headline' type element doesn't directly contain objects, but
362 "List of buffer-local variables used when parsing objects.
363 These variables are copied to the temporary buffer created by
367 \f
368 ;;; Accessors and Setters
369 ;;
370 ;; Provide four accessors: `org-element-type', `org-element-property'
371 ;; `org-element-contents' and `org-element-restriction'.
372 ;;
373 ;; Setter functions allow to modify elements by side effect. There is
374 ;; `org-element-put-property', `org-element-set-contents',
375 ;; `org-element-set-element' and `org-element-adopt-element'. Note
376 ;; that `org-element-set-element' and `org-element-adopt-elements' are
377 ;; higher level functions since also update `:parent' property.
380 "Return type of ELEMENT.
382 The function returns the type of the element or object provided.
383 It can also return the following special value:
384 `plain-text' for a string
385 `org-data' for a complete document
386 nil in any other case."
392 "Extract the value from the PROPERTY of an ELEMENT."
397 "Extract contents from an ELEMENT."
403 "Return restriction associated to ELEMENT.
404 ELEMENT can be an element, an object or a symbol representing an
405 element or object type."
407 org-element-object-restrictions)))
410 "In ELEMENT set PROPERTY to VALUE.
411 Return modified element."
414 element))
417 "Set ELEMENT contents to CONTENTS.
418 Return modified element."
425 "Replace element or object OLD with element or object NEW.
426 The function takes care of setting `:parent' property for NEW."
427 ;; Since OLD is going to be changed into NEW by side-effect, first
428 ;; make sure that every element or object within NEW has OLD as
429 ;; parent.
432 ;; Transfer contents.
434 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
435 ;; with NEW's.
438 ;; Transfer type.
442 "Append elements to the contents of another element.
444 PARENT is an element or object. CHILDREN can be elements,
445 objects, or a strings.
447 The function takes care of setting `:parent' property for CHILD.
448 Return parent element."
449 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
450 ;; string: parent is the list itself.
453 children)
454 ;; Add CHILDREN at the end of PARENT contents.
457 parent
459 ;; Return modified PARENT element.
463 \f
464 ;;; Greater elements
465 ;;
466 ;; For each greater element type, we define a parser and an
467 ;; interpreter.
468 ;;
469 ;; A parser returns the element or object as the list described above.
470 ;; Most of them accepts no argument. Though, exceptions exist. Hence
471 ;; every element containing a secondary string (see
472 ;; `org-element-secondary-value-alist') will accept an optional
473 ;; argument to toggle parsing of that secondary string. Moreover,
474 ;; `item' parser requires current list's structure as its first
475 ;; element.
476 ;;
477 ;; An interpreter accepts two arguments: the list representation of
478 ;; the element or object, and its contents. The latter may be nil,
479 ;; depending on the element or object considered. It returns the
480 ;; appropriate Org syntax, as a string.
481 ;;
482 ;; Parsing functions must follow the naming convention:
483 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
484 ;; defined in `org-element-greater-elements'.
485 ;;
486 ;; Similarly, interpreting functions must follow the naming
487 ;; convention: org-element-TYPE-interpreter.
488 ;;
489 ;; With the exception of `headline' and `item' types, greater elements
490 ;; cannot contain other greater elements of their own type.
491 ;;
492 ;; Beside implementing a parser and an interpreter, adding a new
493 ;; greater element requires to tweak `org-element--current-element'.
494 ;; Moreover, the newly defined type must be added to both
495 ;; `org-element-all-elements' and `org-element-greater-elements'.
498 ;;;; Center Block
501 "Parse a center block.
503 LIMIT bounds the search. AFFILIATED is a list of which CAR is
504 the buffer position at the beginning of the first affiliated
505 keyword and CDR is a plist of affiliated keywords along with
506 their value.
508 Return a list whose CAR is `center-block' and CDR is a plist
509 containing `:begin', `:end', `:hiddenp', `:contents-begin',
510 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
512 Assume point is at the beginning of the block."
516 ;; Incomplete block: parse it as a paragraph.
521 ;; Empty blocks have no contents.
536 :end end
537 :hiddenp hidden
538 :contents-begin contents-begin
539 :contents-end contents-end
545 "Interpret CENTER-BLOCK element as Org syntax.
546 CONTENTS is the contents of the element."
550 ;;;; Drawer
553 "Parse a drawer.
555 LIMIT bounds the search. AFFILIATED is a list of which CAR is
556 the buffer position at the beginning of the first affiliated
557 keyword and CDR is a plist of affiliated keywords along with
558 their value.
560 Return a list whose CAR is `drawer' and CDR is a plist containing
561 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
562 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
564 Assume point is at beginning of drawer."
567 ;; Incomplete drawer: parse it as a paragraph.
575 ;; Empty drawers have no contents.
590 :end end
591 :drawer-name name
592 :hiddenp hidden
593 :contents-begin contents-begin
594 :contents-end contents-end
600 "Interpret DRAWER element as Org syntax.
601 CONTENTS is the contents of the element."
604 contents))
607 ;;;; Dynamic Block
610 "Parse a dynamic block.
612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
613 the buffer position at the beginning of the first affiliated
614 keyword and CDR is a plist of affiliated keywords along with
615 their value.
617 Return a list whose CAR is `dynamic-block' and CDR is a plist
618 containing `:block-name', `:begin', `:end', `:hiddenp',
619 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
620 and `:post-affiliated' keywords.
622 Assume point is at beginning of dynamic block."
626 ;; Incomplete block: parse it as a paragraph.
635 ;; Empty blocks have no contents.
650 :end end
651 :block-name name
652 :arguments arguments
653 :hiddenp hidden
654 :contents-begin contents-begin
655 :contents-end contents-end
661 "Interpret DYNAMIC-BLOCK element as Org syntax.
662 CONTENTS is the contents of the element."
667 contents))
670 ;;;; Footnote Definition
673 "Parse a footnote definition.
675 LIMIT bounds the search. AFFILIATED is a list of which CAR is
676 the buffer position at the beginning of the first affiliated
677 keyword and CDR is a plist of affiliated keywords along with
678 their value.
680 Return a list whose CAR is `footnote-definition' and CDR is
681 a plist containing `:label', `:begin' `:end', `:contents-begin',
682 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
684 Assume point is at the beginning of the footnote definition."
710 :begin begin
711 :end end
712 :contents-begin contents-begin
713 :contents-end contents-end
719 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
720 CONTENTS is the contents of the footnote-definition."
722 " "
723 contents))
726 ;;;; Headline
729 "Parse an headline.
731 Return a list whose CAR is `headline' and CDR is a plist
732 containing `:raw-value', `:title', `:begin', `:end',
733 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
734 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
735 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
736 `:commentedp' and `:footnote-section-p' keywords.
738 The plist also contains any property set in the property drawer,
739 with its name in 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))))
851 headline :title
857 "Interpret HEADLINE element as Org syntax.
858 CONTENTS is the contents of the element."
885 ;; Align tags.
893 ? )
894 tags))
898 tags))))
900 contents)))
903 ;;;; Inlinetask
906 "Parse an inline task.
908 Return a list whose CAR is `inlinetask' and CDR is a plist
909 containing `:title', `:begin', `:end', `:hiddenp',
910 `:contents-begin' and `:contents-end', `:level', `:priority',
911 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
912 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
914 The plist also contains any property set in the property drawer,
915 with its name in upper cases and colons added at the
916 beginning (i.e. `:CUSTOM_ID').
918 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
919 title will not be parsed as a secondary string, but as a plain
920 string instead.
922 Assume point is at beginning of the inline task."
932 ;; Upcase property names. It avoids confusion between
933 ;; properties obtained through property drawer and default
934 ;; properties from the parser (e.g. `:end' and :END:)
944 plist))
946 ;; Read time properties on the line below the inlinetask
947 ;; opening string.
953 org-keyword-time-not-clock-regexp end t)
963 plist))))
983 :begin begin
984 :end end
985 :hiddenp hidden
986 :contents-begin contents-begin
987 :contents-end contents-end
990 :tags tags
991 :todo-keyword todo
992 :todo-type todo-type
994 time-props
995 standard-props))))
997 inlinetask :title
1000 raw-value
1002 inlinetask))))))
1005 "Interpret INLINETASK element as Org syntax.
1006 CONTENTS is the contents of inlinetask."
1021 ;; Align tags.
1029 ? )
1030 tags))
1034 tags))))
1035 ;; Prefer degenerate inlinetasks when there are no
1036 ;; contents.
1039 contents
1043 ;;;; Item
1046 "Parse an item.
1048 STRUCT is the structure of the plain list.
1050 Return a list whose CAR is `item' and CDR is a plist containing
1051 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1052 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1053 `:post-blank' keywords.
1055 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1056 any, will not be parsed as a secondary string, but as a plain
1057 string instead.
1059 Assume point is at the beginning of the item."
1083 ;; Ignore tags in un-ordered lists: they are just
1084 ;; a part of item's body.
1090 ;; If first line isn't empty, contents really start
1091 ;; at the text after item's meta-data.
1102 :begin begin
1103 :end end
1104 ;; CONTENTS-BEGIN and CONTENTS-END may be
1105 ;; mixed up in the case of an empty item
1106 ;; separated from the next by a blank line.
1107 ;; Thus ensure the former is always the
1108 ;; smallest.
1111 :checkbox checkbox
1112 :counter counter
1113 :hiddenp hidden
1114 :structure struct
1117 item :tag
1125 "Interpret ITEM element as Org syntax.
1126 CONTENTS is the contents of the element."
1132 ;; Compute indentation.
1137 ;; Indent contents.
1139 bullet
1152 ;;;; Plain List
1155 "Parse a plain list.
1157 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1158 the buffer position at the beginning of the first affiliated
1159 keyword and CDR is a plist of affiliated keywords along with
1160 their value. STRUCTURE is the structure of the plain list being
1161 parsed.
1163 Return a list whose CAR is `plain-list' and CDR is a plist
1164 containing `:type', `:begin', `:end', `:contents-begin' and
1165 `:contents-end', `:structure', `:post-blank' and
1166 `:post-affiliated' keywords.
1168 Assume point is at the beginning of the list."
1183 ;; Return value.
1187 :begin begin
1188 :end end
1189 :contents-begin contents-begin
1190 :contents-end contents-end
1191 :structure struct
1197 "Interpret PLAIN-LIST element as Org syntax.
1198 CONTENTS is the contents of the element."
1206 ;;;; Property Drawer
1209 "Parse a property drawer.
1211 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1212 the buffer position at the beginning of the first affiliated
1213 keyword and CDR is a plist of affiliated keywords along with
1214 their value.
1216 Return a list whose CAR is `property-drawer' and CDR is a plist
1217 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1218 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1220 Assume point is at the beginning of the property drawer."
1225 ;; Incomplete drawer: parse it as a paragraph.
1245 :end end
1246 :hiddenp hidden
1247 :contents-begin contents-begin
1248 :contents-end contents-end
1254 "Interpret PROPERTY-DRAWER element as Org syntax.
1255 CONTENTS is the properties within the drawer."
1259 ;;;; Quote Block
1262 "Parse a quote block.
1264 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1265 the buffer position at the beginning of the first affiliated
1266 keyword and CDR is a plist of affiliated keywords along with
1267 their value.
1269 Return a list whose CAR is `quote-block' and CDR is a plist
1270 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1271 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1273 Assume point is at the beginning of the block."
1277 ;; Incomplete block: parse it as a paragraph.
1283 ;; Empty blocks have no contents.
1298 :end end
1299 :hiddenp hidden
1300 :contents-begin contents-begin
1301 :contents-end contents-end
1307 "Interpret QUOTE-BLOCK element as Org syntax.
1308 CONTENTS is the contents of the element."
1312 ;;;; Section
1315 "Parse a section.
1317 LIMIT bounds the search.
1319 Return a list whose CAR is `section' and CDR is a plist
1320 containing `:begin', `:end', `:contents-begin', `contents-end'
1321 and `:post-blank' keywords."
1323 ;; Beginning of section is the beginning of the first non-blank
1324 ;; line after previous headline.
1333 :end end
1334 :contents-begin begin
1335 :contents-end pos-before-blank
1339 "Interpret SECTION element as Org syntax.
1340 CONTENTS is the contents of the element."
1341 contents)
1344 ;;;; Special Block
1347 "Parse a special block.
1349 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1350 the buffer position at the beginning of the first affiliated
1351 keyword and CDR is a plist of affiliated keywords along with
1352 their value.
1354 Return a list whose CAR is `special-block' and CDR is a plist
1355 containing `:type', `:begin', `:end', `:hiddenp',
1356 `:contents-begin', `:contents-end', `:post-blank' and
1357 `:post-affiliated' keywords.
1359 Assume point is at the beginning of the block."
1366 ;; Incomplete block: parse it as a paragraph.
1372 ;; Empty blocks have no contents.
1387 :begin begin
1388 :end end
1389 :hiddenp hidden
1390 :contents-begin contents-begin
1391 :contents-end contents-end
1397 "Interpret SPECIAL-BLOCK element as Org syntax.
1398 CONTENTS is the contents of the element."
1403 \f
1404 ;;; Elements
1405 ;;
1406 ;; For each element, a parser and an interpreter are also defined.
1407 ;; Both follow the same naming convention used for greater elements.
1408 ;;
1409 ;; Also, as for greater elements, adding a new element type is done
1410 ;; through the following steps: implement a parser and an interpreter,
1411 ;; tweak `org-element--current-element' so that it recognizes the new
1412 ;; type and add that new type to `org-element-all-elements'.
1413 ;;
1414 ;; As a special case, when the newly defined type is a block type,
1415 ;; `org-element-block-name-alist' has to be modified accordingly.
1418 ;;;; Babel Call
1421 "Parse a babel call.
1423 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1424 the buffer position at the beginning of the first affiliated
1425 keyword and CDR is a plist of affiliated keywords along with
1426 their value.
1428 Return a list whose CAR is `babel-call' and CDR is a plist
1429 containing `:begin', `:end', `:info', `:post-blank' and
1430 `:post-affiliated' as keywords."
1444 :end end
1445 :info info
1451 "Interpret BABEL-CALL element as Org syntax.
1452 CONTENTS is nil."
1458 ;; Remove redundant square brackets.
1463 ;;;; Clock
1466 "Parse a clock.
1468 LIMIT bounds the search.
1470 Return a list whose CAR is `clock' and CDR is a plist containing
1471 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1472 as keywords."
1492 :value value
1493 :duration duration
1494 :begin begin
1495 :end end
1499 "Interpret CLOCK element as Org syntax.
1500 CONTENTS is nil."
1508 "%2s:%02s"
1512 ;;;; Comment
1515 "Parse a comment.
1517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1518 the buffer position at the beginning of the first affiliated
1519 keyword and CDR is a plist of affiliated keywords along with
1520 their value.
1522 Return a list whose CAR is `comment' and CDR is a plist
1523 containing `:begin', `:end', `:value', `:post-blank',
1524 `:post-affiliated' keywords.
1526 Assume point is at comment beginning."
1535 ;; Get comments ending.
1538 ;; Accumulate lines without leading hash and first
1539 ;; whitespace.
1554 :end end
1555 :value value
1561 "Interpret COMMENT element as Org syntax.
1562 CONTENTS is nil."
1566 ;;;; Comment Block
1569 "Parse an export block.
1571 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1572 the buffer position at the beginning of the first affiliated
1573 keyword and CDR is a plist of affiliated keywords along with
1574 their value.
1576 Return a list whose CAR is `comment-block' and CDR is a plist
1577 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1578 and `:post-affiliated' keywords.
1580 Assume point is at comment block beginning."
1584 ;; Incomplete block: parse it as a paragraph.
1599 contents-begin contents-end)))
1603 :end end
1604 :value value
1605 :hiddenp hidden
1611 "Interpret COMMENT-BLOCK element as Org syntax.
1612 CONTENTS is nil."
1617 ;;;; Diary Sexp
1620 "Parse a diary sexp.
1622 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1623 the buffer position at the beginning of the first affiliated
1624 keyword and CDR is a plist of affiliated keywords along with
1625 their value.
1627 Return a list whose CAR is `diary-sexp' and CDR is a plist
1628 containing `:begin', `:end', `:value', `:post-blank' and
1629 `:post-affiliated' keywords."
1642 :begin begin
1643 :end end
1649 "Interpret DIARY-SEXP as Org syntax.
1650 CONTENTS is nil."
1654 ;;;; Example Block
1657 "Parse an example block.
1659 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1660 the buffer position at the beginning of the first affiliated
1661 keyword and CDR is a plist of affiliated keywords along with
1662 their value.
1664 Return a list whose CAR is `example-block' and CDR is a plist
1665 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1666 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1667 `:switches', `:value', `:post-blank' and `:post-affiliated'
1668 keywords."
1672 ;; Incomplete block: parse it as a paragraph.
1679 ;; Switches analysis
1684 ;; Should labels be retained in (or stripped from) example
1685 ;; blocks?
1690 ;; What should code-references use - labels or
1691 ;; line-numbers?
1698 ;; Standard block parsing.
1705 contents-begin contents-end)))
1715 :end end
1716 :value value
1717 :switches switches
1718 :number-lines number-lines
1719 :preserve-indent preserve-indent
1720 :retain-labels retain-labels
1721 :use-labels use-labels
1722 :label-fmt label-fmt
1723 :hiddenp hidden
1729 "Interpret EXAMPLE-BLOCK element as Org syntax.
1730 CONTENTS is nil."
1739 ;;;; Export Block
1742 "Parse an export block.
1744 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1745 the buffer position at the beginning of the first affiliated
1746 keyword and CDR is a plist of affiliated keywords along with
1747 their value.
1749 Return a list whose CAR is `export-block' and CDR is a plist
1750 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1751 `:post-blank' and `:post-affiliated' keywords.
1753 Assume point is at export-block beginning."
1760 ;; Incomplete block: parse it as a paragraph.
1775 contents-end)))
1779 :end end
1780 :type type
1781 :value value
1782 :hiddenp hidden
1788 "Interpret EXPORT-BLOCK element as Org syntax.
1789 CONTENTS is nil."
1796 ;;;; Fixed-width
1799 "Parse a fixed-width section.
1801 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1802 the buffer position at the beginning of the first affiliated
1803 keyword and CDR is a plist of affiliated keywords along with
1804 their value.
1806 Return a list whose CAR is `fixed-width' and CDR is a plist
1807 containing `:begin', `:end', `:value', `:post-blank' and
1808 `:post-affiliated' keywords.
1810 Assume point is at the beginning of the fixed-width area."
1814 value
1819 ;; Accumulate text without starting colons.
1833 :end end
1834 :value value
1840 "Interpret FIXED-WIDTH element as Org syntax.
1841 CONTENTS is nil."
1846 ;;;; Horizontal Rule
1849 "Parse an horizontal rule.
1851 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1852 the buffer position at the beginning of the first affiliated
1853 keyword and CDR is a plist of affiliated keywords along with
1854 their value.
1856 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1857 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1858 keywords."
1869 :end end
1875 "Interpret HORIZONTAL-RULE element as Org syntax.
1876 CONTENTS is nil."
1880 ;;;; Keyword
1883 "Parse a keyword at point.
1885 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1886 the buffer position at the beginning of the first affiliated
1887 keyword and CDR is a plist of affiliated keywords along with
1888 their value.
1890 Return a list whose CAR is `keyword' and CDR is a plist
1891 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1892 `:post-affiliated' keywords."
1907 :value value
1908 :begin begin
1909 :end end
1915 "Interpret KEYWORD element as Org syntax.
1916 CONTENTS is nil."
1922 ;;;; Latex Environment
1925 "Parse a LaTeX environment.
1927 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1928 the buffer position at the beginning of the first affiliated
1929 keyword and CDR is a plist of affiliated keywords along with
1930 their value.
1932 Return a list whose CAR is `latex-environment' and CDR is a plist
1933 containing `:begin', `:end', `:value', `:post-blank' and
1934 `:post-affiliated' keywords.
1936 Assume point is at the beginning of the latex environment."
1943 limit t))
1944 ;; Incomplete latex environment: parse it as a paragraph.
1956 :end end
1957 :value value
1963 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1964 CONTENTS is nil."
1968 ;;;; Node Property
1971 "Parse a node-property at point.
1973 LIMIT bounds the search.
1975 Return a list whose CAR is `node-property' and CDR is a plist
1976 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1977 keywords."
1989 :value value
1990 :begin begin
1991 :end end
1995 "Interpret NODE-PROPERTY element as Org syntax.
1996 CONTENTS is nil."
2002 ;;;; Paragraph
2005 "Parse a paragraph.
2007 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2008 the buffer position at the beginning of the first affiliated
2009 keyword and CDR is a plist of affiliated keywords along with
2010 their value.
2012 Return a list whose CAR is `paragraph' and CDR is a plist
2013 containing `:begin', `:end', `:contents-begin' and
2014 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2016 Assume point is at the beginning of the paragraph."
2025 limit
2026 ;; A matching `org-element-paragraph-separate' is not
2027 ;; necessarily the end of the paragraph. In
2028 ;; particular, lines starting with # or : as a first
2029 ;; non-space character are ambiguous. We have check
2030 ;; if they are valid Org syntax (i.e. not an
2031 ;; incomplete keyword).
2035 ;; There's no ambiguity for other symbols or
2036 ;; empty lines: stop here.
2038 ;; Stop at valid fixed-width areas.
2040 ;; Stop at drawers.
2045 ;; Stop at valid comments.
2047 ;; Stop at valid dynamic blocks.
2052 ;; Stop at valid blocks.
2059 limit t)))
2060 ;; Stop at valid latex environments.
2067 limit t)))
2068 ;; Stop at valid keywords.
2070 ;; Skip everything else.
2088 :end end
2089 :contents-begin contents-begin
2090 :contents-end contents-end
2096 "Interpret PARAGRAPH element as Org syntax.
2097 CONTENTS is the contents of the element."
2098 contents)
2101 ;;;; Planning
2104 "Parse a planning.
2106 LIMIT bounds the search.
2108 Return a list whose CAR is `planning' and CDR is a plist
2109 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2110 and `:post-blank' keywords."
2120 closed deadline scheduled)
2132 :deadline deadline
2133 :scheduled scheduled
2134 :begin begin
2135 :end end
2139 "Interpret PLANNING element as Org syntax.
2140 CONTENTS is nil."
2142 'identity
2159 ;;;; Quote Section
2162 "Parse a quote section.
2164 LIMIT bounds the search.
2166 Return a list whose CAR is `quote-section' and CDR is a plist
2167 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2169 Assume point is at beginning of the section."
2180 :end end
2181 :value value
2185 "Interpret QUOTE-SECTION element as Org syntax.
2186 CONTENTS is nil."
2190 ;;;; Src Block
2193 "Parse a src block.
2195 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2196 the buffer position at the beginning of the first affiliated
2197 keyword and CDR is a plist of affiliated keywords along with
2198 their value.
2200 Return a list whose CAR is `src-block' and CDR is a plist
2201 containing `:language', `:switches', `:parameters', `:begin',
2202 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2203 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2204 `:post-blank' and `:post-affiliated' keywords.
2206 Assume point is at the beginning of the block."
2209 limit t)))
2210 ;; Incomplete block: parse it as a paragraph.
2216 ;; Get language as a string.
2225 ;; Get switches.
2227 ;; Get parameters.
2229 ;; Switches analysis
2237 ;; Should labels be retained in (or stripped from)
2238 ;; src blocks?
2243 ;; What should code-references use - labels or
2244 ;; line-numbers?
2248 ;; Get visibility status.
2250 ;; Retrieve code.
2256 ;; Get position after ending blank lines.
2267 :begin begin
2268 :end end
2269 :number-lines number-lines
2270 :preserve-indent preserve-indent
2271 :retain-labels retain-labels
2272 :use-labels use-labels
2273 :label-fmt label-fmt
2274 :hiddenp hidden
2275 :value value
2281 "Interpret SRC-BLOCK element as Org syntax.
2282 CONTENTS is nil."
2305 ;;;; Table
2308 "Parse a table at point.
2310 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2311 the buffer position at the beginning of the first affiliated
2312 keyword and CDR is a plist of affiliated keywords along with
2313 their value.
2315 Return a list whose CAR is `table' and CDR is a plist containing
2316 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2317 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2318 keywords.
2320 Assume point is at the beginning of the table."
2334 acc))
2342 :end end
2343 :type type
2344 :tblfm tblfm
2345 ;; Only `org' tables have contents. `table.el' tables
2346 ;; use a `:value' property to store raw table as
2347 ;; a string.
2352 table-begin table-end))
2358 "Interpret TABLE element as Org syntax.
2359 CONTENTS is nil."
2370 ;;;; Table Row
2373 "Parse table row at point.
2375 LIMIT bounds the search.
2377 Return a list whose CAR is `table-row' and CDR is a plist
2378 containing `:begin', `:end', `:contents-begin', `:contents-end',
2379 `:type' and `:post-blank' keywords."
2383 ;; A table rule has no contents. In that case, ensure
2384 ;; CONTENTS-BEGIN matches CONTENTS-END.
2396 :begin begin
2397 :end end
2398 :contents-begin contents-begin
2399 :contents-end contents-end
2403 "Interpret TABLE-ROW element as Org syntax.
2404 CONTENTS is the contents of the table row."
2409 ;;;; Verse Block
2412 "Parse a verse block.
2414 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2415 the buffer position at the beginning of the first affiliated
2416 keyword and CDR is a plist of affiliated keywords along with
2417 their value.
2419 Return a list whose CAR is `verse-block' and CDR is a plist
2420 containing `:begin', `:end', `:contents-begin', `:contents-end',
2421 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2423 Assume point is at beginning of the block."
2427 ;; Incomplete block: parse it as a paragraph.
2444 :end end
2445 :contents-begin contents-begin
2446 :contents-end contents-end
2447 :hiddenp hidden
2453 "Interpret VERSE-BLOCK element as Org syntax.
2454 CONTENTS is verse block contents."
2458 \f
2459 ;;; Objects
2460 ;;
2461 ;; Unlike to elements, interstices can be found between objects.
2462 ;; That's why, along with the parser, successor functions are provided
2463 ;; for each object. Some objects share the same successor (i.e. `code'
2464 ;; and `verbatim' objects).
2465 ;;
2466 ;; A successor must accept a single argument bounding the search. It
2467 ;; will return either a cons cell whose CAR is the object's type, as
2468 ;; a symbol, and CDR the position of its next occurrence, or nil.
2469 ;;
2470 ;; Successors follow the naming convention:
2471 ;; org-element-NAME-successor, where NAME is the name of the
2472 ;; successor, as defined in `org-element-all-successors'.
2473 ;;
2474 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2475 ;; object types they can contain will be specified in
2476 ;; `org-element-object-restrictions'.
2477 ;;
2478 ;; Adding a new type of object is simple. Implement a successor,
2479 ;; a parser, and an interpreter for it, all following the naming
2480 ;; convention. Register type in `org-element-all-objects' and
2481 ;; successor in `org-element-all-successors'. Maybe tweak
2482 ;; restrictions about it, and that's it.
2485 ;;;; Bold
2488 "Parse bold object at point.
2490 Return a list whose CAR is `bold' and CDR is a plist with
2491 `:begin', `:end', `:contents-begin' and `:contents-end' and
2492 `:post-blank' keywords.
2494 Assume point is at the first star marker."
2506 :end end
2507 :contents-begin contents-begin
2508 :contents-end contents-end
2512 "Interpret BOLD object as Org syntax.
2513 CONTENTS is the contents of the object."
2517 "Search for the next text-markup object.
2519 LIMIT bounds the search.
2521 Return value is a cons cell whose CAR is a symbol among `bold',
2522 `italic', `underline', `strike-through', `code' and `verbatim'
2523 and CDR is beginning position."
2539 ;;;; Code
2542 "Parse code object at point.
2544 Return a list whose CAR is `code' and CDR is a plist with
2545 `:value', `:begin', `:end' and `:post-blank' keywords.
2547 Assume point is at the first tilde marker."
2558 :begin begin
2559 :end end
2563 "Interpret CODE object as Org syntax.
2564 CONTENTS is nil."
2568 ;;;; Entity
2571 "Parse entity at point.
2573 Return a list whose CAR is `entity' and CDR a plist with
2574 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2575 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2576 keywords.
2578 Assume point is at the beginning of the entity."
2580 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2596 :begin begin
2597 :end end
2598 :use-brackets-p bracketsp
2602 "Interpret ENTITY object as Org syntax.
2603 CONTENTS is nil."
2609 "Search for the next latex-fragment or entity object.
2611 LIMIT bounds the search.
2613 Return value is a cons cell whose CAR is `entity' or
2614 `latex-fragment' and CDR is beginning position."
2619 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2626 limit t)
2629 ;; Determine if it's a real entity or a LaTeX command.
2632 ;; No entity nor command: point is at a LaTeX fragment.
2633 ;; Determine its type to get the correct beginning position.
2641 matchers)
2645 ;;;; Export Snippet
2648 "Parse export snippet at point.
2650 Return a list whose CAR is `export-snippet' and CDR a plist with
2651 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2652 keywords.
2654 Assume point is at the beginning of the snippet."
2666 :value value
2667 :begin begin
2668 :end end
2672 "Interpret EXPORT-SNIPPET object as Org syntax.
2673 CONTENTS is nil."
2679 "Search for the next export-snippet object.
2681 LIMIT bounds the search.
2683 Return value is a cons cell whose CAR is `export-snippet' and CDR
2684 its beginning position."
2693 ;;;; Footnote Reference
2696 "Parse footnote reference at point.
2698 Return a list whose CAR is `footnote-reference' and CDR a plist
2699 with `:label', `:type', `:inline-definition', `:begin', `:end'
2700 and `:post-blank' as keywords."
2722 :type type
2723 :begin begin
2724 :end end
2727 footnote-reference :inline-definition
2732 footnote-reference))))))
2735 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2736 CONTENTS is nil."
2746 "Search for the next footnote-reference object.
2748 LIMIT bounds the search.
2750 Return value is a cons cell whose CAR is `footnote-reference' and
2751 CDR is beginning position."
2765 ;;;; Inline Babel Call
2768 "Parse inline babel call at point.
2770 Return a list whose CAR is `inline-babel-call' and CDR a plist
2771 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2773 Assume point is at the beginning of the babel call."
2784 :end end
2785 :info info
2789 "Interpret INLINE-BABEL-CALL object as Org syntax.
2790 CONTENTS is nil."
2796 ;; Remove redundant square brackets.
2799 main-source)
2803 "Search for the next inline-babel-call object.
2805 LIMIT bounds the search.
2807 Return value is a cons cell whose CAR is `inline-babel-call' and
2808 CDR is beginning position."
2810 ;; Use a simplified version of
2811 ;; `org-babel-inline-lob-one-liner-regexp'.
2814 limit t)
2818 ;;;; Inline Src Block
2821 "Parse inline source block at point.
2823 LIMIT bounds the search.
2825 Return a list whose CAR is `inline-src-block' and CDR a plist
2826 with `:begin', `:end', `:language', `:value', `:parameters' and
2827 `:post-blank' as keywords.
2829 Assume point is at the beginning of the inline src block."
2842 :value value
2843 :parameters parameters
2844 :begin begin
2845 :end end
2849 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2850 CONTENTS is nil."
2855 language
2857 body)))
2860 "Search for the next inline-babel-call element.
2862 LIMIT bounds the search.
2864 Return value is a cons cell whose CAR is `inline-babel-call' and
2865 CDR is beginning position."
2871 ;;;; Italic
2874 "Parse italic object at point.
2876 Return a list whose CAR is `italic' and CDR is a plist with
2877 `:begin', `:end', `:contents-begin' and `:contents-end' and
2878 `:post-blank' keywords.
2880 Assume point is at the first slash marker."
2892 :end end
2893 :contents-begin contents-begin
2894 :contents-end contents-end
2898 "Interpret ITALIC object as Org syntax.
2899 CONTENTS is the contents of the object."
2903 ;;;; Latex Fragment
2906 "Parse latex fragment at point.
2908 Return a list whose CAR is `latex-fragment' and CDR a plist with
2909 `:value', `:begin', `:end', and `:post-blank' as keywords.
2911 Assume point is at the beginning of the latex fragment."
2925 ;; None found: it's a macro.
2934 :begin begin
2935 :end end
2939 "Interpret LATEX-FRAGMENT object as Org syntax.
2940 CONTENTS is nil."
2943 ;;;; Line Break
2946 "Parse line break at point.
2948 Return a list whose CAR is `line-break', and CDR a plist with
2949 `:begin', `:end' and `:post-blank' keywords.
2951 Assume point is at the beginning of the line break."
2958 "Interpret LINE-BREAK object as Org syntax.
2959 CONTENTS is nil."
2963 "Search for the next line-break object.
2965 LIMIT bounds the search.
2967 Return value is a cons cell whose CAR is `line-break' and CDR is
2968 beginning position."
2972 ;; A line break can only happen on a non-empty line.
2977 ;;;; Link
2980 "Parse link at point.
2982 Return a list whose CAR is `link' and CDR a plist with `:type',
2983 `:path', `:raw-link', `:application', `:search-option', `:begin',
2984 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2985 keywords.
2987 Assume point is at the beginning of the link."
2990 end contents-begin contents-end link-end post-blank path type
2991 raw-link link search-option application)
2993 ;; Type 1: Text targeted from a radio target.
2998 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3003 ;; RAW-LINK is the original link. Expand any
3004 ;; abbreviation in it.
3009 ;; Determine TYPE of link and set PATH accordingly.
3011 ;; File type.
3014 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3017 ;; Id type: PATH is the id.
3020 ;; Code-ref type: PATH is the name of the reference.
3023 ;; Custom-id type: PATH is the name of the custom id.
3026 ;; Fuzzy type: Internal link either matches a target, an
3027 ;; headline name or nothing. PATH is the target or
3028 ;; headline's name.
3030 ;; Type 3: Plain link, i.e. http://orgmode.org
3036 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3043 ;; In any case, deduce end point after trailing white space from
3044 ;; LINK-END variable.
3047 ;; Extract search option and opening application out of
3048 ;; "file"-type links.
3050 ;; Application.
3055 ;; Extract search option from PATH.
3059 ;; Make sure TYPE always report "file".
3063 :path path
3065 :application application
3066 :search-option search-option
3067 :begin begin
3068 :end end
3069 :contents-begin contents-begin
3070 :contents-end contents-end
3074 "Interpret LINK object as Org syntax.
3075 CONTENTS is the contents of the object, or nil."
3080 raw-link
3084 "Search for the next link object.
3086 LIMIT bounds the search.
3088 Return value is a cons cell whose CAR is `link' and CDR is
3089 beginning position."
3098 ;;;; Macro
3101 "Parse macro at point.
3103 Return a list whose CAR is `macro' and CDR a plist with `:key',
3104 `:args', `:begin', `:end', `:value' and `:post-blank' as
3105 keywords.
3107 Assume point is at the macro."
3118 ;; Do not use `org-split-string' since empty
3119 ;; strings are meaningful here.
3123 ;; Repair bad splits, when comma is protected,
3124 ;; and thus not a real separator.
3132 :value value
3133 :args args
3134 :begin begin
3135 :end end
3139 "Interpret MACRO object as Org syntax.
3140 CONTENTS is nil."
3144 "Search for the next macro object.
3146 LIMIT bounds the search.
3148 Return value is cons cell whose CAR is `macro' and CDR is
3149 beginning position."
3153 limit t)
3157 ;;;; Radio-target
3160 "Parse radio target at point.
3162 Return a list whose CAR is `radio-target' and CDR a plist with
3163 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3164 and `:post-blank' as keywords.
3166 Assume point is at the radio target."
3178 :end end
3179 :contents-begin contents-begin
3180 :contents-end contents-end
3181 :post-blank post-blank
3185 "Interpret TARGET object as Org syntax.
3186 CONTENTS is the contents of the object."
3190 "Search for the next radio-target object.
3192 LIMIT bounds the search.
3194 Return value is a cons cell whose CAR is `radio-target' and CDR
3195 is beginning position."
3201 ;;;; Statistics Cookie
3204 "Parse statistics cookie at point.
3206 Return a list whose CAR is `statistics-cookie', and CDR a plist
3207 with `:begin', `:end', `:value' and `:post-blank' keywords.
3209 Assume point is at the beginning of the statistics-cookie."
3220 :end end
3221 :value value
3225 "Interpret STATISTICS-COOKIE object as Org syntax.
3226 CONTENTS is nil."
3230 "Search for the next statistics cookie object.
3232 LIMIT bounds the search.
3234 Return value is a cons cell whose CAR is `statistics-cookie' and
3235 CDR is beginning position."
3241 ;;;; Strike-Through
3244 "Parse strike-through object at point.
3246 Return a list whose CAR is `strike-through' and CDR is a plist
3247 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3248 `:post-blank' keywords.
3250 Assume point is at the first plus sign marker."
3262 :end end
3263 :contents-begin contents-begin
3264 :contents-end contents-end
3268 "Interpret STRIKE-THROUGH object as Org syntax.
3269 CONTENTS is the contents of the object."
3273 ;;;; Subscript
3276 "Parse subscript at point.
3278 Return a list whose CAR is `subscript' and CDR a plist with
3279 `:begin', `:end', `:contents-begin', `:contents-end',
3280 `:use-brackets-p' and `:post-blank' as keywords.
3282 Assume point is at the underscore."
3286 t
3297 :end end
3298 :use-brackets-p bracketsp
3299 :contents-begin contents-begin
3300 :contents-end contents-end
3304 "Interpret SUBSCRIPT object as Org syntax.
3305 CONTENTS is the contents of the object."
3308 contents))
3311 "Search for the next sub/superscript object.
3313 LIMIT bounds the search.
3315 Return value is a cons cell whose CAR is either `subscript' or
3316 `superscript' and CDR is beginning position."
3324 ;;;; Superscript
3327 "Parse superscript at point.
3329 Return a list whose CAR is `superscript' and CDR a plist with
3330 `:begin', `:end', `:contents-begin', `:contents-end',
3331 `:use-brackets-p' and `:post-blank' as keywords.
3333 Assume point is at the caret."
3347 :end end
3348 :use-brackets-p bracketsp
3349 :contents-begin contents-begin
3350 :contents-end contents-end
3354 "Interpret SUPERSCRIPT object as Org syntax.
3355 CONTENTS is the contents of the object."
3358 contents))
3361 ;;;; Table Cell
3364 "Parse table cell at point.
3366 Return a list whose CAR is `table-cell' and CDR is a plist
3367 containing `:begin', `:end', `:contents-begin', `:contents-end'
3368 and `:post-blank' keywords."
3376 :end end
3377 :contents-begin contents-begin
3378 :contents-end contents-end
3382 "Interpret TABLE-CELL element as Org syntax.
3383 CONTENTS is the contents of the cell, or nil."
3387 "Search for the next table-cell object.
3389 LIMIT bounds the search.
3391 Return value is a cons cell whose CAR is `table-cell' and CDR is
3392 beginning position."
3396 ;;;; Target
3399 "Parse target at point.
3401 Return a list whose CAR is `target' and CDR a plist with
3402 `:begin', `:end', `:value' and `:post-blank' as keywords.
3404 Assume point is at the target."
3414 :end end
3415 :value value
3419 "Interpret TARGET object as Org syntax.
3420 CONTENTS is nil."
3424 "Search for the next target object.
3426 LIMIT bounds the search.
3428 Return value is a cons cell whose CAR is `target' and CDR is
3429 beginning position."
3435 ;;;; Timestamp
3438 "Parse time stamp at point.
3440 Return a list whose CAR is `timestamp', and CDR a plist with
3441 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3443 Assume point is at the beginning of the timestamp."
3461 date-start)
3472 raw-value)
3474 :repeater-type
3480 :repeater-unit
3483 year-start month-start day-start hour-start minute-start year-end
3484 month-end day-end hour-end minute-end)
3485 ;; Parse date-start.
3493 ;; Compute date-end. It can be provided directly in time-stamp,
3494 ;; or extracted from time range. Otherwise, it defaults to the
3495 ;; same values as date-start.
3505 :raw-value raw-value
3506 :year-start year-start
3507 :month-start month-start
3508 :day-start day-start
3509 :hour-start hour-start
3510 :minute-start minute-start
3511 :year-end year-end
3512 :month-end month-end
3513 :day-end day-end
3514 :hour-end hour-end
3515 :minute-end minute-end
3516 :begin begin
3517 :end end
3519 repeater-props)))))
3522 "Interpret TIMESTAMP object as Org syntax.
3523 CONTENTS is nil."
3524 ;; Use `:raw-value' if specified.
3526 ;; Otherwise, build timestamp string.
3536 ;; Build an Org timestamp string from TIME. ACTIVEP is
3537 ;; non-nil when time stamp is active. If WITH-TIME-P is
3538 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3539 ;; specify a time range in the timestamp. REPEAT-STRING
3540 ;; is the repeater string, if any.
3544 org-time-stamp-formats)
3545 time)))
3551 nil nil ts)))
3555 " "
3556 repeat-string
3558 ;; Return value.
3559 ts)))
3571 build-ts-string
3590 0
3598 "--"
3610 "Search for the next timestamp object.
3612 LIMIT bounds the search.
3614 Return value is a cons cell whose CAR is `timestamp' and CDR is
3615 beginning position."
3623 limit t)
3627 ;;;; Underline
3630 "Parse underline object at point.
3632 Return a list whose CAR is `underline' and CDR is a plist with
3633 `:begin', `:end', `:contents-begin' and `:contents-end' and
3634 `:post-blank' keywords.
3636 Assume point is at the first underscore marker."
3648 :end end
3649 :contents-begin contents-begin
3650 :contents-end contents-end
3654 "Interpret UNDERLINE object as Org syntax.
3655 CONTENTS is the contents of the object."
3659 ;;;; Verbatim
3662 "Parse verbatim object at point.
3664 Return a list whose CAR is `verbatim' and CDR is a plist with
3665 `:value', `:begin', `:end' and `:post-blank' keywords.
3667 Assume point is at the first equal sign marker."
3678 :begin begin
3679 :end end
3683 "Interpret VERBATIM object as Org syntax.
3684 CONTENTS is nil."
3688 \f
3689 ;;; Parsing Element Starting At Point
3690 ;;
3691 ;; `org-element--current-element' is the core function of this section.
3692 ;; It returns the Lisp representation of the element starting at
3693 ;; point.
3694 ;;
3695 ;; `org-element--current-element' makes use of special modes. They
3696 ;; are activated for fixed element chaining (i.e. `plain-list' >
3697 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3698 ;; `section'). Special modes are: `first-section', `item',
3699 ;; `node-property', `quote-section', `section' and `table-row'.
3703 "Parse the element starting at point.
3705 LIMIT bounds the search.
3707 Return value is a list like (TYPE PROPS) where TYPE is the type
3708 of the element and PROPS a plist of properties associated to the
3709 element.
3711 Possible types are defined in `org-element-all-elements'.
3713 Optional argument GRANULARITY determines the depth of the
3714 recursion. Allowed values are `headline', `greater-element',
3715 `element', `object' or nil. When it is broader than `object' (or
3716 nil), secondary values will not be parsed, since they only
3717 contain objects.
3719 Optional argument SPECIAL, when non-nil, can be either
3720 `first-section', `item', `node-property', `quote-section',
3721 `section', and `table-row'.
3723 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3724 be computed.
3726 This function assumes point is always at the beginning of the
3727 element it has to parse."
3730 ;; Determine if parsing depth allows for secondary strings
3731 ;; parsing. It only applies to elements referenced in
3732 ;; `org-element-secondary-value-alist'.
3735 ;; Item.
3738 ;; Table Row.
3740 ;; Node Property.
3742 ;; Headline.
3745 ;; Sections (must be checked after headline).
3751 limit)))
3752 ;; When not at bol, point is at the beginning of an item or
3753 ;; a footnote definition: next item is always a paragraph.
3755 ;; Planning and Clock.
3760 ;; Inlinetask.
3763 ;; From there, elements can have affiliated keywords.
3766 ;; Jumping over affiliated keywords put point off-limits.
3767 ;; Parse them as regular keywords.
3771 ;; LaTeX Environment.
3774 ;; Drawer and Property Drawer.
3779 ;; Fixed Width
3782 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3783 ;; Keywords.
3792 org-element-block-name-alist)))
3807 ;; Footnote Definition.
3810 ;; Horizontal Rule.
3813 ;; Diary Sexp.
3816 ;; Table.
3818 ;; List.
3822 ;; Default element: Paragraph.
3826 ;; Most elements can have affiliated keywords. When looking for an
3827 ;; element beginning, we want to move before them, as they belong to
3828 ;; that element, and, in the meantime, collect information they give
3829 ;; into appropriate properties. Hence the following function.
3832 "Collect affiliated keywords from point down to LIMIT.
3834 Return a list whose CAR is the position at the first of them and
3835 CDR a plist of keywords and values and move point to the
3836 beginning of the first line after them.
3838 As a special case, if element doesn't start at the beginning of
3839 the line (i.e. a paragraph starting an item), CAR is current
3840 position of point and CDR is nil."
3844 ;; RESTRICT is the list of objects allowed in parsed
3845 ;; keywords value.
3847 output)
3850 ;; Apply translation to RAW-KWD. From there, KWD is
3851 ;; the official keyword.
3853 org-element-keyword-translation-alist))
3854 raw-kwd))
3855 ;; Find main value for any keyword.
3861 ;; PARSEDP is non-nil when keyword should have its
3862 ;; value parsed.
3864 ;; If KWD is a dual keyword, find its secondary
3865 ;; value. Maybe parse it.
3872 ;; Attribute a property name to KWD.
3874 ;; Now set final shape for VALUE.
3880 ;; Attributes can always appear on multiple lines.
3883 ;; Eventually store the new value in OUTPUT.
3885 ;; Move to next keyword.
3887 ;; If affiliated keywords are orphaned: move back to first one.
3888 ;; They will be parsed as a paragraph.
3890 ;; Return value.
3894 \f
3895 ;;; The Org Parser
3896 ;;
3897 ;; The two major functions here are `org-element-parse-buffer', which
3898 ;; parses Org syntax inside the current buffer, taking into account
3899 ;; region, narrowing, or even visibility if specified, and
3900 ;; `org-element-parse-secondary-string', which parses objects within
3901 ;; a given string.
3902 ;;
3903 ;; The (almost) almighty `org-element-map' allows to apply a function
3904 ;; on elements or objects matching some type, and accumulate the
3905 ;; resulting values. In an export situation, it also skips unneeded
3906 ;; parts of the parse tree.
3909 "Recursively parse the buffer and return structure.
3910 If narrowing is in effect, only parse the visible part of the
3911 buffer.
3913 Optional argument GRANULARITY determines the depth of the
3914 recursion. It can be set to the following symbols:
3916 `headline' Only parse headlines.
3917 `greater-element' Don't recurse into greater elements excepted
3918 headlines and sections. Thus, elements
3919 parsed are the top-level ones.
3920 `element' Parse everything but objects and plain text.
3921 `object' Parse the complete buffer (default).
3923 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3924 elements.
3926 An element or an objects is represented as a list with the
3927 pattern (TYPE PROPERTIES CONTENTS), where :
3929 TYPE is a symbol describing the element or object. See
3930 `org-element-all-elements' and `org-element-all-objects' for an
3931 exhaustive list of such symbols. One can retrieve it with
3932 `org-element-type' function.
3934 PROPERTIES is the list of attributes attached to the element or
3935 object, as a plist. Although most of them are specific to the
3936 element or object type, all types share `:begin', `:end',
3937 `:post-blank' and `:parent' properties, which respectively
3938 refer to buffer position where the element or object starts,
3939 ends, the number of white spaces or blank lines after it, and
3940 the element or object containing it. Properties values can be
3941 obtained by using `org-element-property' function.
3943 CONTENTS is a list of elements, objects or raw strings
3944 contained in the current element or object, when applicable.
3945 One can access them with `org-element-contents' function.
3947 The Org buffer has `org-data' as type and nil as properties.
3948 `org-element-map' function can be used to find specific elements
3949 or objects within the parse tree.
3951 This function assumes that current major mode is `org-mode'."
3957 ;; Start in `first-section' mode so text before the first
3958 ;; headline belongs to a section.
3962 "Recursively parse objects in STRING and return structure.
3964 RESTRICTION is a symbol limiting the object types that will be
3965 looked after.
3967 Optional argument PARENT, when non-nil, is the element or object
3968 containing the secondary string. It is used to set correctly
3969 `:parent' property within the string."
3970 ;; Copy buffer-local variables listed in
3971 ;; `org-element-object-variables' into temporary buffer. This is
3972 ;; required since object parsing is dependent on these variables.
3976 org-element-object-variables))))
3984 secondary))
3985 secondary))))
3989 "Map a function on selected elements or objects.
3991 DATA is a parse tree, an element, an object, a string, or a list
3992 of such constructs. TYPES is a symbol or list of symbols of
3993 elements or objects types (see `org-element-all-elements' and
3994 `org-element-all-objects' for a complete list of types). FUN is
3995 the function called on the matching element or object. It has to
3996 accept one argument: the element or object itself.
3998 When optional argument INFO is non-nil, it should be a plist
3999 holding export options. In that case, parts of the parse tree
4000 not exportable according to that property list will be skipped.
4002 When optional argument FIRST-MATCH is non-nil, stop at the first
4003 match for which FUN doesn't return nil, and return that value.
4005 Optional argument NO-RECURSION is a symbol or a list of symbols
4006 representing elements or objects types. `org-element-map' won't
4007 enter any recursive element or object whose type belongs to that
4008 list. Though, FUN can still be applied on them.
4010 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4011 apply to matching objects within parsed affiliated keywords (see
4012 `org-element-parsed-keywords').
4014 Nil values returned from FUN do not appear in the results.
4017 Examples:
4018 --------
4020 Assuming TREE is a variable containing an Org buffer parse tree,
4021 the following example will return a flat list of all `src-block'
4022 and `example-block' elements in it:
4024 \(org-element-map tree '(example-block src-block) 'identity)
4026 The following snippet will find the first headline with a level
4029 \(org-element-map tree 'headline
4030 \(lambda (hl)
4031 \(and (= (org-element-property :level hl) 1)
4033 \(org-element-property :begin hl)))
4034 nil t)
4036 The next example will return a flat list of all `plain-list' type
4037 elements in TREE that are not a sub-list themselves:
4039 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4041 Eventually, this example will return a flat list of all `bold'
4042 type objects containing a `latex-snippet' type object, even
4043 looking into captions:
4045 \(org-element-map tree 'bold
4046 \(lambda (b)
4047 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4048 nil nil nil t)"
4049 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4052 ;; Recursion depth is determined by --CATEGORY.
4059 ;; If one object is found, the function
4060 ;; has to recurse into every object.
4063 ;; If one regular element is found, the
4064 ;; function has to recurse, at least,
4065 ;; into every element it encounters.
4068 types)
4069 category)))
4070 ;; Compute properties for affiliated keywords if necessary.
4075 org-element-affiliated-keywords)))
4076 --acc
4077 --walk-tree
4081 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4082 ;; holding contextual information.
4086 ;; Ignored element in an export context.
4088 ;; List of elements or objects.
4090 ;; Unconditionally enter parse trees.
4094 ;; Check if TYPE is matching among TYPES. If so,
4095 ;; apply FUN to --DATA and accumulate return value
4096 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4102 ;; If --DATA has a secondary string that can contain
4103 ;; objects with their type among TYPES, look into it.
4110 ;; If --DATA has any affiliated keywords and
4111 ;; WITH-AFFILIATED is non-nil, look for objects in
4112 ;; them.
4120 ;; Pay attention to the type of value.
4121 ;; Preserve order for multiple keywords.
4137 --affiliated-alist))
4138 ;; Determine if a recursion into --DATA is possible.
4140 ;; --TYPE is explicitly removed from recursion.
4142 ;; --DATA has no contents.
4144 ;; Looking for greater elements but --DATA is simply
4145 ;; an element or an object.
4148 ;; Looking for elements but --DATA is an object.
4151 ;; In any other case, map contents.
4155 ;; Return value in a proper order.
4159 ;; The following functions are internal parts of the parser.
4160 ;;
4161 ;; The first one, `org-element--parse-elements' acts at the element's
4162 ;; level.
4163 ;;
4164 ;; The second one, `org-element--parse-objects' applies on all objects
4165 ;; of a paragraph or a secondary string. It uses
4166 ;; `org-element--get-next-object-candidates' to optimize the search of
4167 ;; the next object in the buffer.
4168 ;;
4169 ;; More precisely, that function looks for every allowed object type
4170 ;; first. Then, it discards failed searches, keeps further matches,
4171 ;; and searches again types matched behind point, for subsequent
4172 ;; calls. Thus, searching for a given type fails only once, and every
4173 ;; object is searched only once at top level (but sometimes more for
4174 ;; nested types).
4178 "Parse elements between BEG and END positions.
4180 SPECIAL prioritize some elements over the others. It can be set
4181 to `first-section', `quote-section', `section' `item' or
4182 `table-row'.
4184 When value is `item', STRUCTURE will be used as the current list
4185 structure.
4187 GRANULARITY determines the depth of the recursion. See
4188 `org-element-parse-buffer' for more information.
4190 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4191 elements.
4193 Elements are accumulated into ACC."
4196 ;; When parsing only headlines, skip any text before first one.
4199 ;; Main loop start.
4201 ;; Find current element's type and parse it accordingly to
4202 ;; its category.
4204 end granularity special structure))
4208 ;; Fill ELEMENT contents by side-effect.
4210 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4211 ;; no contents, don't modify it.
4214 ;; Greater element: parse it between `contents-begin' and
4215 ;; `contents-end'. Make sure GRANULARITY allows the
4216 ;; recursion, or ELEMENT is an headline, in which case going
4217 ;; inside is mandatory, in order to get sub-level headings.
4225 ;; Possibly switch to a special mode.
4235 granularity visible-only element))
4236 ;; ELEMENT has contents. Parse objects inside, if
4237 ;; GRANULARITY allows it.
4243 ;; Return result.
4244 acc))
4247 "Parse objects between BEG and END and return recursive structure.
4249 Objects are accumulated in ACC.
4251 RESTRICTION is a list of object types which are allowed in the
4252 current object."
4258 end restriction candidates)))
4265 ;; 1. Text before any object. Untabify it.
4270 acc
4274 ;; 2. Object...
4277 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4278 ;; a recursive type.
4283 cont-beg
4290 ;; 3. Text after last object. Untabify it.
4294 acc
4298 ;; Result.
4299 acc)))
4302 "Return an alist of candidates for the next object.
4304 LIMIT bounds the search, and RESTRICTION narrows candidates to
4305 some object types.
4307 Return value is an alist whose CAR is position and CDR the object
4308 type, as a symbol.
4310 OBJECTS is the previous candidates alist."
4311 ;; Filter out any object found but not belonging to RESTRICTION.
4317 type)
4318 restriction)))
4319 objects))
4321 ;; If no previous result, search every object type in RESTRICTION.
4322 ;; Otherwise, keep potential candidates (old objects located after
4323 ;; point) and ask to search again those which had matched before.
4328 objects))
4329 ;; Call the appropriate successor function for each type to search
4330 ;; and accumulate matches.
4337 type))))
4340 types-to-search)
4341 ;; Return alist.
4342 next-candidates))
4345 \f
4346 ;;; Towards A Bijective Process
4347 ;;
4348 ;; The parse tree obtained with `org-element-parse-buffer' is really
4349 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4350 ;; interpreted and expanded into a string with canonical Org syntax.
4351 ;; Hence `org-element-interpret-data'.
4352 ;;
4353 ;; The function relies internally on
4354 ;; `org-element--interpret-affiliated-keywords'.
4356 ;;;###autoload
4358 "Interpret DATA as Org syntax.
4360 DATA is a parse tree, an element, an object or a secondary string
4361 to interpret.
4363 Optional argument PARENT is used for recursive calls. It contains
4364 the element or object containing data, or nil.
4366 Return Org syntax as a string."
4370 ;; Secondary string.
4375 ;; Full Org document.
4380 ;; Plain text: remove `:parent' text property from output.
4382 ;; Element/Object without contents.
4385 data nil))
4386 ;; Element/Object with contents.
4396 ;; Elements directly containing objects must
4397 ;; have their indentation normalized first.
4399 data
4400 ;; When normalizing first paragraph of an
4401 ;; item or a footnote-definition, ignore
4402 ;; first line's indentation.
4409 data
4411 contents)))))))
4413 ;; Build white spaces. If no `:post-blank' property is
4414 ;; specified, assume its value is 0.
4424 "Return ELEMENT's affiliated keywords as Org syntax.
4425 If there is no affiliated keyword, return the empty string."
4435 ": "
4438 value)
4446 ;; All attribute keywords can have multiple lines.
4452 ;; List all ELEMENT's properties matching an attribute line or an
4453 ;; affiliated keyword, but ignore translated keywords since they
4454 ;; cannot belong to the property list.
4461 org-element-keyword-translation-alist)))))
4462 collect prop)
4465 ;; Because interpretation of the parse tree must return the same
4466 ;; number of blank lines between elements and the same number of white
4467 ;; space after objects, some special care must be given to white
4468 ;; spaces.
4469 ;;
4470 ;; The first function, `org-element-normalize-string', ensures any
4471 ;; string different from the empty string will end with a single
4472 ;; newline character.
4473 ;;
4474 ;; The second function, `org-element-normalize-contents', removes
4475 ;; global indentation from the contents of the current element.
4478 "Ensure string S ends with a single newline character.
4480 If S isn't a string return it unchanged. If S is the empty
4481 string, return it. Otherwise, return a new string with a single
4482 newline character at its end."
4490 "Normalize plain text in ELEMENT's contents.
4492 ELEMENT must only contain plain text and objects.
4494 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4495 indentation to compute maximal common indentation.
4497 Return the normalized element that is element with global
4498 indentation removed from its contents. The function assumes that
4499 indentation is not done with TAB characters."
4501 collect-inds ; for byte-compiler
4504 ;; Return list of indentations within BLOB. This is done by
4505 ;; walking recursively BLOB and updating IND-LIST along the
4506 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4507 ;; been seen yet. It is required as this string is the only
4508 ;; one whose indentation doesn't happen after a newline
4509 ;; character.
4517 ;; An indentation of zero means no string will be
4518 ;; modified. Quit the process.
4524 ;; Avoid matching blank or empty lines.
4532 ;; Collect indentation list in ELEMENT. Possibly remove first
4533 ;; value if IGNORE-FIRST is non-nil.
4536 ;; Build ELEMENT back, replacing each string with the same
4537 ;; string minus common indentation.
4542 ;; Return BLOB with all its strings indentation
4543 ;; shortened from MCI white spaces. FIRST-FLAG is
4544 ;; non-nil when the first string hasn't been seen
4545 ;; yet.
4559 org-element-recursive-objects)
4563 blob))))
4567 \f
4568 ;;; The Toolbox
4569 ;;
4570 ;; The first move is to implement a way to obtain the smallest element
4571 ;; containing point. This is the job of `org-element-at-point'. It
4572 ;; basically jumps back to the beginning of section containing point
4573 ;; and moves, element after element, with
4574 ;; `org-element--current-element' until the container is found. Note:
4575 ;; When using `org-element-at-point', secondary values are never
4576 ;; parsed since the function focuses on elements, not on objects.
4577 ;;
4578 ;; At a deeper level, `org-element-context' lists all elements and
4579 ;; objects containing point.
4580 ;;
4581 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4582 ;; internally by navigation and manipulation tools.
4584 ;;;###autoload
4586 "Determine closest element around point.
4588 Return value is a list like (TYPE PROPS) where TYPE is the type
4589 of the element and PROPS a plist of properties associated to the
4590 element.
4592 Possible types are defined in `org-element-all-elements'.
4593 Properties depend on element or object type, but always include
4594 `:begin', `:end', `:parent' and `:post-blank' properties.
4596 As a special case, if point is at the very beginning of a list or
4597 sub-list, returned element will be that list instead of the first
4598 item. In the same way, if point is at the beginning of the first
4599 row of a table, returned element will be the table instead of the
4600 first row.
4602 If optional argument KEEP-TRAIL is non-nil, the function returns
4603 a list of elements leading to element at point. The list's CAR
4604 is always the element at point. The following positions contain
4605 element's siblings, then parents, siblings of parents, until the
4606 first element of current section."
4608 ;; If at an headline, parse it. It is the sole element that
4609 ;; doesn't require to know about context. Be sure to disallow
4610 ;; secondary string parsing, though.
4616 ;; Otherwise move at the beginning of the section containing
4617 ;; point.
4622 element type special-flag trail struct prevs parent)
4625 ;; In empty lines at buffer's beginning, return nil.
4634 ;; In blank lines just after the headline, point still
4635 ;; belongs to the headline.
4643 ;; Parse successively each element, skipping those ending
4644 ;; before original position.
4652 ;; 1. Skip any element ending before point. Also skip
4653 ;; element ending at point when we're sure that another
4654 ;; element has started.
4659 ;; 2. An element containing point is always the element at
4660 ;; point.
4663 ;; 3. At any other greater element type, if point is
4664 ;; within contents, move into it.
4669 ;; Create an anchor for tables and plain lists:
4670 ;; when point is at the very beginning of these
4671 ;; elements, ignoring affiliated keywords,
4672 ;; target them instead of their contents.
4674 ;; When point is at contents end, do not move
4675 ;; into elements with an explicit ending, but
4676 ;; return that element instead.
4680 drawer dynamic-block inlinetask item
4681 plain-list property-drawer quote-block
4682 special-block))))
4697 ;;;###autoload
4699 "Return closest element or object around point.
4701 Return value is a list like (TYPE PROPS) where TYPE is the type
4702 of the element or object and PROPS a plist of properties
4703 associated to it.
4705 Possible types are defined in `org-element-all-elements' and
4706 `org-element-all-objects'. Properties depend on element or
4707 object type, but always include `:begin', `:end', `:parent' and
4708 `:post-blank'.
4710 Optional argument ELEMENT, when non-nil, is the closest element
4711 containing point, as returned by `org-element-at-point'.
4712 Providing it allows for quicker computation."
4717 end)
4718 ;; Check if point is inside an element containing objects or at
4719 ;; a secondary string. In that case, move to beginning of the
4720 ;; element or secondary string and set END to the other side.
4727 org-element-parsed-keywords))
4728 ;; We're at an affiliated keyword. Change
4729 ;; type to retrieve correct restrictions.
4731 ;; Determine if we're at main or dual value.
4745 (<= origin
4746 ;; `1+' is required so some
4747 ;; successors can match
4748 ;; properly their object.
4769 element
4772 candidates)
4775 end restriction candidates))
4777 candidates)))
4778 ;; If ORIGIN is before next object in element, there's
4779 ;; no point in looking further.
4789 ;; ORIGIN is after OBJECT, so skip it.
4795 ;; ORIGIN is within a non-recursive object or at
4796 ;; an object boundaries: Return that object.
4800 ;; Otherwise, move within current object and
4801 ;; restrict search to the end of its contents.
4806 end cend)))))))
4807 parent))))))
4810 "Non-nil when elements ELEM-A and ELEM-B are nested."
4819 "Swap elements ELEM-A and ELEM-B.
4820 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4821 end of ELEM-A."
4823 ;; There are two special cases when an element doesn't start at bol:
4824 ;; the first paragraph in an item or in a footnote definition.
4826 ;; Only a paragraph without any affiliated keyword can be moved at
4827 ;; ELEM-A position in such a situation. Note that the case of
4828 ;; a footnote definition is impossible: it cannot contain two
4829 ;; paragraphs in a row because it cannot contain a blank line.
4835 ;; In a special situation, ELEM-A will have no indentation. We'll
4836 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4850 ;; Store overlays responsible for visibility status. We
4851 ;; also need to store their boundaries as they will be
4852 ;; removed from buffer.
4859 ;; Get contents.
4867 ;; Restore ex ELEM-A overlays.
4876 ;; Restore ex ELEM-B overlays.
4885 ;; Local variables:
4886 ;; generated-autoload-file: "org-loaddefs.el"
4887 ;; End:
4889 ;;; org-element.el ends here