| blob | 711c7916c49d2bacf4355c920e4396d74664d97f |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. 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 (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
45 ;;
46 ;; Other element types are: `babel-call', `clock', `comment',
47 ;; `comment-block', `example-block', `export-block', `fixed-width',
48 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
49 ;; `planning', `property-drawer', `quote-section', `src-block',
50 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
51 ;; and `verse-block' types can contain Org objects and plain text.
52 ;;
53 ;; Objects are related to document's contents. Some of them are
54 ;; recursive. Associated types are of the following: `bold', `code',
55 ;; `entity', `export-snippet', `footnote-reference',
56 ;; `inline-babel-call', `inline-src-block', `italic',
57 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
58 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
59 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
60 ;;
61 ;; Some elements also have special properties whose value can hold
62 ;; objects themselves (i.e. an item tag or an headline name). Such
63 ;; values are called "secondary strings". Any object belongs to
64 ;; either an element or a secondary string.
65 ;;
66 ;; Notwithstanding affiliated keywords, each greater element, element
67 ;; and object has a fixed set of properties attached to it. Among
68 ;; them, four are shared by all types: `:begin' and `:end', which
69 ;; refer to the beginning and ending buffer positions of the
70 ;; considered element or object, `:post-blank', which holds the number
71 ;; of blank lines, or white spaces, at its end and `:parent' which
72 ;; refers to the element or object containing it. Greater elements
73 ;; and elements containing objects will also have `:contents-begin'
74 ;; and `:contents-end' properties to delimit contents.
75 ;;
76 ;; Lisp-wise, an element or an object can be represented as a list.
77 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
78 ;; TYPE is a symbol describing the Org element or object.
79 ;; PROPERTIES is the property list attached to it. See docstring of
80 ;; appropriate parsing function to get an exhaustive
81 ;; list.
82 ;; CONTENTS is a list of elements, objects or raw strings contained
83 ;; in the current element or object, when applicable.
84 ;;
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
87 ;;
88 ;; The first part of this file defines Org syntax, while the second
89 ;; one provide accessors and setters functions.
90 ;;
91 ;; The next part implements a parser and an interpreter for each
92 ;; element and object type in Org syntax.
93 ;;
94 ;; The following part creates a fully recursive buffer parser. It
95 ;; also provides a tool to map a function to elements or objects
96 ;; matching some criteria in the parse tree. Functions of interest
97 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
98 ;; extent, `org-element-parse-secondary-string'.
99 ;;
100 ;; The penultimate part is the cradle of an interpreter for the
101 ;; obtained parse tree: `org-element-interpret-data'.
102 ;;
103 ;; The library ends by furnishing a set of interactive tools for
104 ;; element's navigation and manipulation, mostly based on
105 ;; `org-element-at-point' function, and a way to give information
106 ;; about document structure around point with `org-element-context'.
109 ;;; Code:
116 \f
117 ;;; Definitions And Rules
118 ;;
119 ;; Define elements, greater elements and specify recursive objects,
120 ;; along with the affiliated keywords recognized. Also set up
121 ;; restrictions on recursive objects combinations.
122 ;;
123 ;; These variables really act as a control center for the parsing
124 ;; process.
128 ;; Headlines and inlinetasks.
130 ;; Comments, blocks (any type), keywords and babel calls.
132 ;; Lists.
134 ;; Fixed-width, drawers (any type) and tables.
136 ;; Footnote definitions.
138 ;; Horizontal rules.
140 ;; LaTeX environments.
142 ;; Planning and Clock lines.
143 org-planning-or-clock-line-re)
148 export-block fixed-width footnote-definition headline
149 horizontal-rule inlinetask item keyword latex-environment
150 babel-call paragraph plain-list planning property-drawer
151 quote-block quote-section section special-block src-block table
152 table-row verse-block)
157 item plain-list quote-block section special-block table)
162 latex-or-entity line-break link macro radio-target
163 statistics-cookie sub/superscript table-cell target
164 text-markup timestamp)
173 "Alist of translations between object type and successor name.
175 Sharing the same successor comes handy when, for example, the
180 inline-src-block italic line-break latex-fragment link macro
181 radio-target statistics-cookie strike-through subscript superscript
182 table-cell target timestamp underline verbatim)
187 table-cell underline)
197 "Alist between block names and the associated parsing function.
198 Names must be uppercase. Any block whose name has no association
204 "List of affiliated keywords as strings.
210 ;; Regular affiliated keywords.
213 "Regexp matching any affiliated keyword.
215 Keyword name is put in match group 1. Moreover, if keyword
216 belongs to `org-element-dual-keywords', put the dual value in
217 match group 2.
225 "Alist of usual translations for keywords.
226 The key is the old name and the value the new one. The property
230 "List of affiliated keywords that can occur more that once in an element.
232 Their value will be consed into a list of strings, which will be
233 returned as the value of the property.
235 This list is checked after translations have been applied. See
236 `org-element-keyword-translation-alist'.
242 "List of keywords whose value can be parsed.
244 Their value will be stored as a secondary string: a list of
245 strings and objects.
247 This list is checked after translations have been applied. See
251 "List of keywords which can have a secondary value.
253 In Org syntax, they can be written with optional square brackets
254 before the colons. For example, results keyword can be
255 associated to a hash value with the following:
257 #+RESULTS[hash-string]: some-source
259 This list is checked after translations have been applied. See
266 inline-src-block latex-or-entity line-break link macro
267 radio-target sub/superscript target text-markup
268 timestamp)
270 radio-target statistics-cookie sub/superscript target text-markup
271 timestamp)
283 inline-src-block latex-or-entity line-break link macro
284 radio-target statistics-cookie sub/superscript target text-markup
285 timestamp)
288 latex-or-entity link radio-target sub/superscript target
289 text-markup timestamp)
300 latex-or-entity line-break link macro radio-target
302 "Alist of objects restrictions.
304 CAR is an element or object type containing objects and CDR is
305 a list of successors that will be called within an element or
306 object of such type.
308 For example, in a `radio-target' object, one can only find
309 entities, export snippets, latex-fragments, subscript and
310 superscript.
312 This alist also applies to secondary string. For example, an
313 `headline' type element doesn't directly contain objects, but
324 \f
325 ;;; Accessors and Setters
326 ;;
327 ;; Provide four accessors: `org-element-type', `org-element-property'
328 ;; `org-element-contents' and `org-element-restriction'.
329 ;;
330 ;; Setter functions allow to modify elements by side effect. There is
331 ;; `org-element-put-property', `org-element-set-contents',
332 ;; `org-element-set-element' and `org-element-adopt-element'. Note
333 ;; that `org-element-set-element' and `org-element-adopt-element' are
334 ;; higher level functions since also update `:parent' property.
337 "Return type of ELEMENT.
339 The function returns the type of the element or object provided.
340 It can also return the following special value:
341 `plain-text' for a string
342 `org-data' for a complete document
343 nil in any other case."
349 "Extract the value from the PROPERTY of an ELEMENT."
353 "Extract contents from an ELEMENT."
357 "Return restriction associated to ELEMENT.
358 ELEMENT can be an element, an object or a symbol representing an
359 element or object type."
361 org-element-object-restrictions)))
364 "In ELEMENT set PROPERTY to VALUE.
365 Return modified element."
368 element)
371 "Set ELEMENT contents to CONTENTS.
372 Return modified element."
378 "Replace element or object OLD with element or object NEW.
379 The function takes care of setting `:parent' property for NEW."
380 ;; OLD can belong to the contents of PARENT or to its secondary
381 ;; string.
384 org-element-secondary-value-alist)))
387 ;; Make sure NEW has correct `:parent' property.
389 ;; Replace OLD with NEW in PARENT.
393 "Add an element to the contents of another element.
395 PARENT is an element or object. CHILD is an element, an object,
396 or a string.
398 CHILD is added at the beginning of PARENT contents, unless the
399 optional argument APPEND is non-nil, in which case CHILD is added
400 at the end.
402 The function takes care of setting `:parent' property for CHILD.
403 Return parent element."
407 parent
409 ;; Link the CHILD element with PARENT.
411 ;; Return the parent element.
412 parent))
415 \f
416 ;;; Greater elements
417 ;;
418 ;; For each greater element type, we define a parser and an
419 ;; interpreter.
420 ;;
421 ;; A parser returns the element or object as the list described above.
422 ;; Most of them accepts no argument. Though, exceptions exist. Hence
423 ;; every element containing a secondary string (see
424 ;; `org-element-secondary-value-alist') will accept an optional
425 ;; argument to toggle parsing of that secondary string. Moreover,
426 ;; `item' parser requires current list's structure as its first
427 ;; element.
428 ;;
429 ;; An interpreter accepts two arguments: the list representation of
430 ;; the element or object, and its contents. The latter may be nil,
431 ;; depending on the element or object considered. It returns the
432 ;; appropriate Org syntax, as a string.
433 ;;
434 ;; Parsing functions must follow the naming convention:
435 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
436 ;; defined in `org-element-greater-elements'.
437 ;;
438 ;; Similarly, interpreting functions must follow the naming
439 ;; convention: org-element-TYPE-interpreter.
440 ;;
441 ;; With the exception of `headline' and `item' types, greater elements
442 ;; cannot contain other greater elements of their own type.
443 ;;
444 ;; Beside implementing a parser and an interpreter, adding a new
445 ;; greater element requires to tweak `org-element--current-element'.
446 ;; Moreover, the newly defined type must be added to both
447 ;; `org-element-all-elements' and `org-element-greater-elements'.
450 ;;;; Center Block
453 "Parse a center block.
455 LIMIT bounds the search.
457 Return a list whose CAR is `center-block' and CDR is a plist
458 containing `:begin', `:end', `:hiddenp', `:contents-begin',
459 `:contents-end' and `:post-blank' keywords.
461 Assume point is at the beginning of the block."
465 ;; Incomplete block: parse it as a comment.
470 ;; Empty blocks have no contents.
484 :end end
485 :hiddenp hidden
486 :contents-begin contents-begin
487 :contents-end contents-end
492 "Interpret CENTER-BLOCK element as Org syntax.
493 CONTENTS is the contents of the element."
497 ;;;; Drawer
500 "Parse a drawer.
502 LIMIT bounds the search.
504 Return a list whose CAR is `drawer' and CDR is a plist containing
505 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
506 `:contents-end' and `:post-blank' keywords.
508 Assume point is at beginning of drawer."
511 ;; Incomplete drawer: parse it as a paragraph.
520 ;; Empty drawers have no contents.
534 :end end
535 :drawer-name name
536 :hiddenp hidden
537 :contents-begin contents-begin
538 :contents-end contents-end
543 "Interpret DRAWER element as Org syntax.
544 CONTENTS is the contents of the element."
547 contents))
550 ;;;; Dynamic Block
553 "Parse a dynamic block.
555 LIMIT bounds the search.
557 Return a list whose CAR is `dynamic-block' and CDR is a plist
558 containing `:block-name', `:begin', `:end', `:hiddenp',
559 `:contents-begin', `:contents-end', `:arguments' and
560 `:post-blank' keywords.
562 Assume point is at beginning of dynamic block."
565 ;; Incomplete block: parse it as a comment.
574 ;; Empty blocks have no contents.
588 :end end
589 :block-name name
590 :arguments arguments
591 :hiddenp hidden
592 :contents-begin contents-begin
593 :contents-end contents-end
598 "Interpret DYNAMIC-BLOCK element as Org syntax.
599 CONTENTS is the contents of the element."
604 contents))
607 ;;;; Footnote Definition
610 "Parse a footnote definition.
612 LIMIT bounds the search.
614 Return a list whose CAR is `footnote-definition' and CDR is
615 a plist containing `:label', `:begin' `:end', `:contents-begin',
616 `:contents-end' and `:post-blank' keywords.
618 Assume point is at the beginning of the footnote definition."
643 :begin begin
644 :end end
645 :contents-begin contents-begin
646 :contents-end contents-end
651 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
652 CONTENTS is the contents of the footnote-definition."
654 " "
655 contents))
658 ;;;; Headline
661 "Parse an headline.
663 Return a list whose CAR is `headline' and CDR is a plist
664 containing `:raw-value', `:title', `:begin', `:end',
665 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
666 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
667 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
668 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
669 keywords.
671 The plist also contains any property set in the property drawer,
672 with its name in lowercase, the underscores replaced with hyphens
673 and colons at the beginning (i.e. `:custom-id').
675 When RAW-SECONDARY-P is non-nil, headline's title will not be
676 parsed as a secondary string, but as a plain string instead.
678 Assume point is at beginning of the headline."
697 ;; Normalize property names: ":SOME_PROP:" becomes
698 ;; ":some-prop".
710 plist))
728 ;; Clean RAW-VALUE from any quote or comment string.
733 ""
734 raw-value)))
735 ;; Clean TAGS from archive tag, if any.
741 :begin begin
742 :end end
743 :pre-blank
746 :hiddenp hidden
747 :contents-begin contents-begin
748 :contents-end contents-end
749 :level level
751 :tags tags
752 :todo-keyword todo
753 :todo-type todo-type
754 :scheduled scheduled
755 :deadline deadline
756 :timestamp timestamp
757 :clock clock
763 end)
764 :footnote-section-p footnote-section-p
765 :archivedp archivedp
766 :commentedp commentedp
768 standard-props))))
770 headline :title
776 "Interpret HEADLINE element as Org syntax.
777 CONTENTS is the contents of the element."
804 ;; Align tags.
812 ? )
813 tags))
817 tags))))
819 contents)))
822 ;;;; Inlinetask
825 "Parse an inline task.
827 Return a list whose CAR is `inlinetask' and CDR is a plist
828 containing `:title', `:begin', `:end', `:hiddenp',
829 `:contents-begin' and `:contents-end', `:level', `:priority',
830 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
831 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
833 The plist also contains any property set in the property drawer,
834 with its name in lowercase, the underscores replaced with hyphens
835 and colons at the beginning (i.e. `:custom-id').
837 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
838 title will not be parsed as a secondary string, but as a plain
839 string instead.
841 Assume point is at beginning of the inline task."
851 ;; Normalize property names: ":SOME_PROP:" becomes
852 ;; ":some-prop".
864 plist))
888 :end end
889 :hiddenp hidden
890 :contents-begin contents-begin
891 :contents-end contents-end
894 :tags tags
895 :todo-keyword todo
896 :todo-type todo-type
897 :scheduled scheduled
898 :deadline deadline
899 :timestamp timestamp
900 :clock clock
902 standard-props
905 inlinetask :title
910 inlinetask))))))
913 "Interpret INLINETASK element as Org syntax.
914 CONTENTS is the contents of inlinetask."
929 ;; Align tags.
937 ? )
938 tags))
942 tags))))
943 ;; Prefer degenerate inlinetasks when there are no
944 ;; contents.
947 contents
951 ;;;; Item
954 "Parse an item.
956 STRUCT is the structure of the plain list.
958 Return a list whose CAR is `item' and CDR is a plist containing
959 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
960 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
961 `:post-blank' keywords.
963 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
964 any, will not be parsed as a secondary string, but as a plain
965 string instead.
967 Assume point is at the beginning of the item."
988 ;; If first line isn't empty,
989 ;; contents really start at the text
990 ;; after item's meta-data.
1003 :begin begin
1004 :end end
1005 ;; CONTENTS-BEGIN and CONTENTS-END may be
1006 ;; mixed up in the case of an empty item
1007 ;; separated from the next by a blank line.
1008 ;; Thus ensure the former is always the
1009 ;; smallest.
1012 :checkbox checkbox
1013 :counter counter
1014 :hiddenp hidden
1015 :structure struct
1018 item :tag
1026 "Interpret ITEM element as Org syntax.
1027 CONTENTS is the contents of the element."
1033 ;; Compute indentation.
1038 ;; Indent contents.
1040 bullet
1053 ;;;; Plain List
1056 "Parse a plain list.
1058 Optional argument STRUCTURE, when non-nil, is the structure of
1059 the plain list being parsed.
1061 Return a list whose CAR is `plain-list' and CDR is a plist
1062 containing `:type', `:begin', `:end', `:contents-begin' and
1063 `:contents-end', `:structure' and `:post-blank' keywords.
1065 Assume point is at the beginning of the list."
1078 ;; Blank lines below list belong to the top-level list only.
1083 ;; Return value.
1087 :begin begin
1088 :end end
1089 :contents-begin contents-begin
1090 :contents-end contents-end
1091 :structure struct
1096 "Interpret PLAIN-LIST element as Org syntax.
1097 CONTENTS is the contents of the element."
1105 ;;;; Quote Block
1108 "Parse a quote block.
1110 LIMIT bounds the search.
1112 Return a list whose CAR is `quote-block' and CDR is a plist
1113 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1114 `:contents-end' and `:post-blank' keywords.
1116 Assume point is at the beginning of the block."
1120 ;; Incomplete block: parse it as a comment.
1126 ;; Empty blocks have no contents.
1140 :end end
1141 :hiddenp hidden
1142 :contents-begin contents-begin
1143 :contents-end contents-end
1148 "Interpret QUOTE-BLOCK element as Org syntax.
1149 CONTENTS is the contents of the element."
1153 ;;;; Section
1156 "Parse a section.
1158 LIMIT bounds the search.
1160 Return a list whose CAR is `section' and CDR is a plist
1161 containing `:begin', `:end', `:contents-begin', `contents-end'
1162 and `:post-blank' keywords."
1164 ;; Beginning of section is the beginning of the first non-blank
1165 ;; line after previous headline.
1174 :end end
1175 :contents-begin begin
1176 :contents-end pos-before-blank
1180 "Interpret SECTION element as Org syntax.
1181 CONTENTS is the contents of the element."
1182 contents)
1185 ;;;; Special Block
1188 "Parse a special block.
1190 LIMIT bounds the search.
1192 Return a list whose CAR is `special-block' and CDR is a plist
1193 containing `:type', `:begin', `:end', `:hiddenp',
1194 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1196 Assume point is at the beginning of the block."
1202 ;; Incomplete block: parse it as a comment.
1208 ;; Empty blocks have no contents.
1222 :begin begin
1223 :end end
1224 :hiddenp hidden
1225 :contents-begin contents-begin
1226 :contents-end contents-end
1231 "Interpret SPECIAL-BLOCK element as Org syntax.
1232 CONTENTS is the contents of the element."
1237 \f
1238 ;;; Elements
1239 ;;
1240 ;; For each element, a parser and an interpreter are also defined.
1241 ;; Both follow the same naming convention used for greater elements.
1242 ;;
1243 ;; Also, as for greater elements, adding a new element type is done
1244 ;; through the following steps: implement a parser and an interpreter,
1245 ;; tweak `org-element--current-element' so that it recognizes the new
1246 ;; type and add that new type to `org-element-all-elements'.
1247 ;;
1248 ;; As a special case, when the newly defined type is a block type,
1249 ;; `org-element-block-name-alist' has to be modified accordingly.
1252 ;;;; Babel Call
1255 "Parse a babel call.
1257 LIMIT bounds the search.
1259 Return a list whose CAR is `babel-call' and CDR is a plist
1260 containing `:begin', `:end', `:info' and `:post-blank' as
1261 keywords."
1272 :end end
1273 :info info
1277 "Interpret BABEL-CALL element as Org syntax.
1278 CONTENTS is nil."
1284 ;; Remove redundant square brackets.
1289 ;;;; Clock
1292 "Parse a clock.
1294 LIMIT bounds the search.
1296 Return a list whose CAR is `clock' and CDR is a plist containing
1297 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1298 as keywords."
1317 :value value
1318 :time time
1319 :begin begin
1320 :end end
1324 "Interpret CLOCK element as Org syntax.
1325 CONTENTS is nil."
1332 "%2s:%02s"
1336 ;;;; Comment
1339 "Parse a comment.
1341 LIMIT bounds the search.
1343 Return a list whose CAR is `comment' and CDR is a plist
1344 containing `:begin', `:end', `:value' and `:post-blank'
1345 keywords.
1347 Assume point is at comment beginning."
1351 ;; Match first line with a loose regexp since it might as
1352 ;; well be an ill-defined keyword.
1358 ;; Get comments ending.
1361 ;; Accumulate lines without leading hash and first
1362 ;; whitespace.
1376 :end end
1377 :value value
1382 "Interpret COMMENT element as Org syntax.
1383 CONTENTS is nil."
1387 ;;;; Comment Block
1390 "Parse an export block.
1392 LIMIT bounds the search.
1394 Return a list whose CAR is `comment-block' and CDR is a plist
1395 containing `:begin', `:end', `:hiddenp', `:value' and
1396 `:post-blank' keywords.
1398 Assume point is at comment block beginning."
1402 ;; Incomplete block: parse it as a comment.
1416 contents-begin contents-end)))
1420 :end end
1421 :value value
1422 :hiddenp hidden
1427 "Interpret COMMENT-BLOCK element as Org syntax.
1428 CONTENTS is nil."
1433 ;;;; Example Block
1436 "Parse an example block.
1438 LIMIT bounds the search.
1440 Return a list whose CAR is `example-block' and CDR is a plist
1441 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1442 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1443 `:switches', `:value' and `:post-blank' keywords."
1447 ;; Incomplete block: parse it as a comment.
1454 ;; Switches analysis
1459 ;; Should labels be retained in (or stripped from) example
1460 ;; blocks?
1465 ;; What should code-references use - labels or
1466 ;; line-numbers?
1473 ;; Standard block parsing.
1487 :end end
1488 :value value
1489 :switches switches
1490 :number-lines number-lines
1491 :preserve-indent preserve-indent
1492 :retain-labels retain-labels
1493 :use-labels use-labels
1494 :label-fmt label-fmt
1495 :hiddenp hidden
1500 "Interpret EXAMPLE-BLOCK element as Org syntax.
1501 CONTENTS is nil."
1509 ;;;; Export Block
1512 "Parse an export block.
1514 LIMIT bounds the search.
1516 Return a list whose CAR is `export-block' and CDR is a plist
1517 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1518 `:post-blank' keywords.
1520 Assume point is at export-block beginning."
1526 ;; Incomplete block: parse it as a comment.
1540 contents-end)))
1544 :end end
1545 :type type
1546 :value value
1547 :hiddenp hidden
1552 "Interpret EXPORT-BLOCK element as Org syntax.
1553 CONTENTS is nil."
1560 ;;;; Fixed-width
1563 "Parse a fixed-width section.
1565 LIMIT bounds the search.
1567 Return a list whose CAR is `fixed-width' and CDR is a plist
1568 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1570 Assume point is at the beginning of the fixed-width area."
1574 value
1579 ;; Accumulate text without starting colons.
1592 :end end
1593 :value value
1598 "Interpret FIXED-WIDTH element as Org syntax.
1599 CONTENTS is nil."
1604 ;;;; Horizontal Rule
1607 "Parse an horizontal rule.
1609 LIMIT bounds the search.
1611 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1612 containing `:begin', `:end' and `:post-blank' keywords."
1622 :end end
1627 "Interpret HORIZONTAL-RULE element as Org syntax.
1628 CONTENTS is nil."
1632 ;;;; Keyword
1635 "Parse a keyword at point.
1637 LIMIT bounds the search.
1639 Return a list whose CAR is `keyword' and CDR is a plist
1640 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1641 keywords."
1654 :value value
1655 :begin begin
1656 :end end
1660 "Interpret KEYWORD element as Org syntax.
1661 CONTENTS is nil."
1667 ;;;; Latex Environment
1670 "Parse a LaTeX environment.
1672 LIMIT bounds the search.
1674 Return a list whose CAR is `latex-environment' and CDR is a plist
1675 containing `:begin', `:end', `:value' and `:post-blank'
1676 keywords.
1678 Assume point is at the beginning of the latex environment."
1696 :end end
1697 :value value
1702 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1703 CONTENTS is nil."
1707 ;;;; Paragraph
1710 "Parse a paragraph.
1712 LIMIT bounds the search.
1714 Return a list whose CAR is `paragraph' and CDR is a plist
1715 containing `:begin', `:end', `:contents-begin' and
1716 `:contents-end' and `:post-blank' keywords.
1718 Assume point is at the beginning of the paragraph."
1726 limit
1736 ;; If paragraph has no affiliated keywords, it may not begin
1737 ;; at beginning of line if it starts an item.
1740 :end end
1741 :contents-begin contents-begin
1742 :contents-end contents-end
1747 "Interpret PARAGRAPH element as Org syntax.
1748 CONTENTS is the contents of the element."
1749 contents)
1752 ;;;; Planning
1755 "Parse a planning.
1757 LIMIT bounds the search.
1759 Return a list whose CAR is `planning' and CDR is a plist
1760 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1761 and `:post-blank' keywords."
1770 closed deadline scheduled)
1784 :deadline deadline
1785 :scheduled scheduled
1786 :begin begin
1787 :end end
1791 "Interpret PLANNING element as Org syntax.
1792 CONTENTS is nil."
1794 'identity
1806 ;;;; Property Drawer
1809 "Parse a property drawer.
1811 LIMIT bounds the search.
1813 Return a list whose CAR is `property-drawer' and CDR is a plist
1814 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1815 `:contents-end', `:properties' and `:post-blank' keywords.
1817 Assume point is at the beginning of the property drawer."
1831 val))
1833 val))
1841 :end end
1842 :hiddenp hidden
1843 :properties properties
1847 "Interpret PROPERTY-DRAWER element as Org syntax.
1848 CONTENTS is nil."
1858 ;;;; Quote Section
1861 "Parse a quote section.
1863 LIMIT bounds the search.
1865 Return a list whose CAR is `quote-section' and CDR is a plist
1866 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1868 Assume point is at beginning of the section."
1879 :end end
1880 :value value
1884 "Interpret QUOTE-SECTION element as Org syntax.
1885 CONTENTS is nil."
1889 ;;;; Src Block
1892 "Parse a src block.
1894 LIMIT bounds the search.
1896 Return a list whose CAR is `src-block' and CDR is a plist
1897 containing `:language', `:switches', `:parameters', `:begin',
1898 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1899 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1900 `:post-blank' keywords.
1902 Assume point is at the beginning of the block."
1905 ;; Incomplete block: parse it as a comment.
1910 ;; Get beginning position.
1912 ;; Get language as a string.
1921 ;; Get switches.
1923 ;; Get parameters.
1925 ;; Switches analysis
1933 ;; Should labels be retained in (or stripped from)
1934 ;; src blocks?
1939 ;; What should code-references use - labels or
1940 ;; line-numbers?
1944 ;; Get visibility status.
1946 ;; Retrieve code.
1951 ;; Get position after ending blank lines.
1961 :begin begin
1962 :end end
1963 :number-lines number-lines
1964 :preserve-indent preserve-indent
1965 :retain-labels retain-labels
1966 :use-labels use-labels
1967 :label-fmt label-fmt
1968 :hiddenp hidden
1969 :value value
1974 "Interpret SRC-BLOCK element as Org syntax.
1975 CONTENTS is nil."
1995 value
1999 ;;;; Table
2002 "Parse a table at point.
2004 LIMIT bounds the search.
2006 Return a list whose CAR is `table' and CDR is a plist containing
2007 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2008 `:contents-end', `:value' and `:post-blank' keywords.
2010 Assume point is at the beginning of the table."
2022 acc))
2029 :end end
2030 :type type
2031 :tblfm tblfm
2032 ;; Only `org' tables have contents. `table.el' tables
2033 ;; use a `:value' property to store raw table as
2034 ;; a string.
2039 table-begin table-end))
2044 "Interpret TABLE element as Org syntax.
2045 CONTENTS is nil."
2056 ;;;; Table Row
2059 "Parse table row at point.
2061 LIMIT bounds the search.
2063 Return a list whose CAR is `table-row' and CDR is a plist
2064 containing `:begin', `:end', `:contents-begin', `:contents-end',
2065 `:type' and `:post-blank' keywords."
2069 ;; A table rule has no contents. In that case, ensure
2070 ;; CONTENTS-BEGIN matches CONTENTS-END.
2082 :begin begin
2083 :end end
2084 :contents-begin contents-begin
2085 :contents-end contents-end
2089 "Interpret TABLE-ROW element as Org syntax.
2090 CONTENTS is the contents of the table row."
2095 ;;;; Verse Block
2098 "Parse a verse block.
2100 LIMIT bounds the search.
2102 Return a list whose CAR is `verse-block' and CDR is a plist
2103 containing `:begin', `:end', `:contents-begin', `:contents-end',
2104 `:hiddenp' and `:post-blank' keywords.
2106 Assume point is at beginning of the block."
2110 ;; Incomplete block: parse it as a comment.
2126 :end end
2127 :contents-begin contents-begin
2128 :contents-end contents-end
2129 :hiddenp hidden
2134 "Interpret VERSE-BLOCK element as Org syntax.
2135 CONTENTS is verse block contents."
2139 \f
2140 ;;; Objects
2141 ;;
2142 ;; Unlike to elements, interstices can be found between objects.
2143 ;; That's why, along with the parser, successor functions are provided
2144 ;; for each object. Some objects share the same successor (i.e. `code'
2145 ;; and `verbatim' objects).
2146 ;;
2147 ;; A successor must accept a single argument bounding the search. It
2148 ;; will return either a cons cell whose CAR is the object's type, as
2149 ;; a symbol, and CDR the position of its next occurrence, or nil.
2150 ;;
2151 ;; Successors follow the naming convention:
2152 ;; org-element-NAME-successor, where NAME is the name of the
2153 ;; successor, as defined in `org-element-all-successors'.
2154 ;;
2155 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2156 ;; object types they can contain will be specified in
2157 ;; `org-element-object-restrictions'.
2158 ;;
2159 ;; Adding a new type of object is simple. Implement a successor,
2160 ;; a parser, and an interpreter for it, all following the naming
2161 ;; convention. Register type in `org-element-all-objects' and
2162 ;; successor in `org-element-all-successors'. Maybe tweak
2163 ;; restrictions about it, and that's it.
2166 ;;;; Bold
2169 "Parse bold object at point.
2171 Return a list whose CAR is `bold' and CDR is a plist with
2172 `:begin', `:end', `:contents-begin' and `:contents-end' and
2173 `:post-blank' keywords.
2175 Assume point is at the first star marker."
2187 :end end
2188 :contents-begin contents-begin
2189 :contents-end contents-end
2193 "Interpret BOLD object as Org syntax.
2194 CONTENTS is the contents of the object."
2198 "Search for the next text-markup object.
2200 LIMIT bounds the search.
2202 LIMIT bounds the search.
2204 Return value is a cons cell whose CAR is a symbol among `bold',
2205 `italic', `underline', `strike-through', `code' and `verbatim'
2206 and CDR is beginning position."
2222 ;;;; Code
2225 "Parse code object at point.
2227 Return a list whose CAR is `code' and CDR is a plist with
2228 `:value', `:begin', `:end' and `:post-blank' keywords.
2230 Assume point is at the first tilde marker."
2241 :begin begin
2242 :end end
2246 "Interpret CODE object as Org syntax.
2247 CONTENTS is nil."
2251 ;;;; Entity
2254 "Parse entity at point.
2256 Return a list whose CAR is `entity' and CDR a plist with
2257 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2258 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2259 keywords.
2261 Assume point is at the beginning of the entity."
2263 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2279 :begin begin
2280 :end end
2281 :use-brackets-p bracketsp
2285 "Interpret ENTITY object as Org syntax.
2286 CONTENTS is nil."
2292 "Search for the next latex-fragment or entity object.
2294 LIMIT bounds the search.
2296 Return value is a cons cell whose CAR is `entity' or
2297 `latex-fragment' and CDR is beginning position."
2300 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2307 limit t)
2310 ;; Determine if it's a real entity or a LaTeX command.
2313 ;; No entity nor command: point is at a LaTeX fragment.
2314 ;; Determine its type to get the correct beginning position.
2322 matchers)
2326 ;;;; Export Snippet
2329 "Parse export snippet at point.
2331 Return a list whose CAR is `export-snippet' and CDR a plist with
2332 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2333 keywords.
2335 Assume point is at the beginning of the snippet."
2347 :value value
2348 :begin begin
2349 :end end
2353 "Interpret EXPORT-SNIPPET object as Org syntax.
2354 CONTENTS is nil."
2360 "Search for the next export-snippet object.
2362 LIMIT bounds the search.
2364 Return value is a cons cell whose CAR is `export-snippet' and CDR
2365 its beginning position."
2374 ;;;; Footnote Reference
2377 "Parse footnote reference at point.
2379 Return a list whose CAR is `footnote-reference' and CDR a plist
2380 with `:label', `:type', `:inline-definition', `:begin', `:end'
2381 and `:post-blank' as keywords."
2403 :type type
2404 :begin begin
2405 :end end
2408 footnote-reference :inline-definition
2413 footnote-reference))))))
2416 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2417 CONTENTS is nil."
2427 "Search for the next footnote-reference object.
2429 LIMIT bounds the search.
2431 Return value is a cons cell whose CAR is `footnote-reference' and
2432 CDR is beginning position."
2446 ;;;; Inline Babel Call
2449 "Parse inline babel call at point.
2451 Return a list whose CAR is `inline-babel-call' and CDR a plist
2452 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2454 Assume point is at the beginning of the babel call."
2465 :end end
2466 :info info
2470 "Interpret INLINE-BABEL-CALL object as Org syntax.
2471 CONTENTS is nil."
2477 ;; Remove redundant square brackets.
2480 main-source)
2484 "Search for the next inline-babel-call object.
2486 LIMIT bounds the search.
2488 Return value is a cons cell whose CAR is `inline-babel-call' and
2489 CDR is beginning position."
2491 ;; Use a simplified version of
2492 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2494 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2495 limit t)
2499 ;;;; Inline Src Block
2502 "Parse inline source block at point.
2504 LIMIT bounds the search.
2506 Return a list whose CAR is `inline-src-block' and CDR a plist
2507 with `:begin', `:end', `:language', `:value', `:parameters' and
2508 `:post-blank' as keywords.
2510 Assume point is at the beginning of the inline src block."
2523 :value value
2524 :parameters parameters
2525 :begin begin
2526 :end end
2530 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2531 CONTENTS is nil."
2536 language
2538 body)))
2541 "Search for the next inline-babel-call element.
2543 LIMIT bounds the search.
2545 Return value is a cons cell whose CAR is `inline-babel-call' and
2546 CDR is beginning position."
2551 ;;;; Italic
2554 "Parse italic object at point.
2556 Return a list whose CAR is `italic' and CDR is a plist with
2557 `:begin', `:end', `:contents-begin' and `:contents-end' and
2558 `:post-blank' keywords.
2560 Assume point is at the first slash marker."
2572 :end end
2573 :contents-begin contents-begin
2574 :contents-end contents-end
2578 "Interpret ITALIC object as Org syntax.
2579 CONTENTS is the contents of the object."
2583 ;;;; Latex Fragment
2586 "Parse latex fragment at point.
2588 Return a list whose CAR is `latex-fragment' and CDR a plist with
2589 `:value', `:begin', `:end', and `:post-blank' as keywords.
2591 Assume point is at the beginning of the latex fragment."
2605 ;; None found: it's a macro.
2614 :begin begin
2615 :end end
2619 "Interpret LATEX-FRAGMENT object as Org syntax.
2620 CONTENTS is nil."
2623 ;;;; Line Break
2626 "Parse line break at point.
2628 Return a list whose CAR is `line-break', and CDR a plist with
2629 `:begin', `:end' and `:post-blank' keywords.
2631 Assume point is at the beginning of the line break."
2635 "Interpret LINE-BREAK object as Org syntax.
2636 CONTENTS is nil."
2640 "Search for the next line-break object.
2642 LIMIT bounds the search.
2644 Return value is a cons cell whose CAR is `line-break' and CDR is
2645 beginning position."
2649 ;; A line break can only happen on a non-empty line.
2654 ;;;; Link
2657 "Parse link at point.
2659 Return a list whose CAR is `link' and CDR a plist with `:type',
2660 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2661 `:contents-end' and `:post-blank' as keywords.
2663 Assume point is at the beginning of the link."
2666 end contents-begin contents-end link-end post-blank path type
2667 raw-link link)
2669 ;; Type 1: Text targeted from a radio target.
2674 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2679 ;; RAW-LINK is the original link.
2684 ;; Determine TYPE of link and set PATH accordingly.
2686 ;; File type.
2689 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2692 ;; Id type: PATH is the id.
2695 ;; Code-ref type: PATH is the name of the reference.
2698 ;; Custom-id type: PATH is the name of the custom id.
2701 ;; Fuzzy type: Internal link either matches a target, an
2702 ;; headline name or nothing. PATH is the target or
2703 ;; headline's name.
2705 ;; Type 3: Plain link, i.e. http://orgmode.org
2711 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2718 ;; In any case, deduce end point after trailing white space from
2719 ;; LINK-END variable.
2724 :path path
2726 :begin begin
2727 :end end
2728 :contents-begin contents-begin
2729 :contents-end contents-end
2733 "Interpret LINK object as Org syntax.
2734 CONTENTS is the contents of the object, or nil."
2739 raw-link
2743 "Search for the next link object.
2745 LIMIT bounds the search.
2747 Return value is a cons cell whose CAR is `link' and CDR is
2748 beginning position."
2757 ;;;; Macro
2760 "Parse macro at point.
2762 Return a list whose CAR is `macro' and CDR a plist with `:key',
2763 `:args', `:begin', `:end', `:value' and `:post-blank' as
2764 keywords.
2766 Assume point is at the macro."
2780 ;; Repair bad splits.
2788 :value value
2789 :args args
2790 :begin begin
2791 :end end
2795 "Interpret MACRO object as Org syntax.
2796 CONTENTS is nil."
2800 "Search for the next macro object.
2802 LIMIT bounds the search.
2804 Return value is cons cell whose CAR is `macro' and CDR is
2805 beginning position."
2809 limit t)
2813 ;;;; Radio-target
2816 "Parse radio target at point.
2818 Return a list whose CAR is `radio-target' and CDR a plist with
2819 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2820 and `:post-blank' as keywords.
2822 Assume point is at the radio target."
2834 :end end
2835 :contents-begin contents-begin
2836 :contents-end contents-end
2837 :post-blank post-blank
2841 "Interpret TARGET object as Org syntax.
2842 CONTENTS is the contents of the object."
2846 "Search for the next radio-target object.
2848 LIMIT bounds the search.
2850 Return value is a cons cell whose CAR is `radio-target' and CDR
2851 is beginning position."
2857 ;;;; Statistics Cookie
2860 "Parse statistics cookie at point.
2862 Return a list whose CAR is `statistics-cookie', and CDR a plist
2863 with `:begin', `:end', `:value' and `:post-blank' keywords.
2865 Assume point is at the beginning of the statistics-cookie."
2876 :end end
2877 :value value
2881 "Interpret STATISTICS-COOKIE object as Org syntax.
2882 CONTENTS is nil."
2886 "Search for the next statistics cookie object.
2888 LIMIT bounds the search.
2890 Return value is a cons cell whose CAR is `statistics-cookie' and
2891 CDR is beginning position."
2897 ;;;; Strike-Through
2900 "Parse strike-through object at point.
2902 Return a list whose CAR is `strike-through' and CDR is a plist
2903 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2904 `:post-blank' keywords.
2906 Assume point is at the first plus sign marker."
2918 :end end
2919 :contents-begin contents-begin
2920 :contents-end contents-end
2924 "Interpret STRIKE-THROUGH object as Org syntax.
2925 CONTENTS is the contents of the object."
2929 ;;;; Subscript
2932 "Parse subscript at point.
2934 Return a list whose CAR is `subscript' and CDR a plist with
2935 `:begin', `:end', `:contents-begin', `:contents-end',
2936 `:use-brackets-p' and `:post-blank' as keywords.
2938 Assume point is at the underscore."
2942 t
2953 :end end
2954 :use-brackets-p bracketsp
2955 :contents-begin contents-begin
2956 :contents-end contents-end
2960 "Interpret SUBSCRIPT object as Org syntax.
2961 CONTENTS is the contents of the object."
2964 contents))
2967 "Search for the next sub/superscript object.
2969 LIMIT bounds the search.
2971 Return value is a cons cell whose CAR is either `subscript' or
2972 `superscript' and CDR is beginning position."
2979 ;;;; Superscript
2982 "Parse superscript at point.
2984 Return a list whose CAR is `superscript' and CDR a plist with
2985 `:begin', `:end', `:contents-begin', `:contents-end',
2986 `:use-brackets-p' and `:post-blank' as keywords.
2988 Assume point is at the caret."
3002 :end end
3003 :use-brackets-p bracketsp
3004 :contents-begin contents-begin
3005 :contents-end contents-end
3009 "Interpret SUPERSCRIPT object as Org syntax.
3010 CONTENTS is the contents of the object."
3013 contents))
3016 ;;;; Table Cell
3019 "Parse table cell at point.
3021 Return a list whose CAR is `table-cell' and CDR is a plist
3022 containing `:begin', `:end', `:contents-begin', `:contents-end'
3023 and `:post-blank' keywords."
3031 :end end
3032 :contents-begin contents-begin
3033 :contents-end contents-end
3037 "Interpret TABLE-CELL element as Org syntax.
3038 CONTENTS is the contents of the cell, or nil."
3042 "Search for the next table-cell object.
3044 LIMIT bounds the search.
3046 Return value is a cons cell whose CAR is `table-cell' and CDR is
3047 beginning position."
3051 ;;;; Target
3054 "Parse target at point.
3056 Return a list whose CAR is `target' and CDR a plist with
3057 `:begin', `:end', `:value' and `:post-blank' as keywords.
3059 Assume point is at the target."
3069 :end end
3070 :value value
3074 "Interpret TARGET object as Org syntax.
3075 CONTENTS is nil."
3079 "Search for the next target object.
3081 LIMIT bounds the search.
3083 Return value is a cons cell whose CAR is `target' and CDR is
3084 beginning position."
3090 ;;;; Timestamp
3093 "Parse time stamp at point.
3095 Return a list whose CAR is `timestamp', and CDR a plist with
3096 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3098 Assume point is at the beginning of the timestamp."
3117 :value main-value
3118 :range-end range-end
3119 :begin begin
3120 :end end
3124 "Interpret TIMESTAMP object as Org syntax.
3125 CONTENTS is nil."
3134 range-end)))))))
3137 "Search for the next timestamp object.
3139 LIMIT bounds the search.
3141 Return value is a cons cell whose CAR is `timestamp' and CDR is
3142 beginning position."
3150 limit t)
3154 ;;;; Underline
3157 "Parse underline object at point.
3159 Return a list whose CAR is `underline' and CDR is a plist with
3160 `:begin', `:end', `:contents-begin' and `:contents-end' and
3161 `:post-blank' keywords.
3163 Assume point is at the first underscore marker."
3175 :end end
3176 :contents-begin contents-begin
3177 :contents-end contents-end
3181 "Interpret UNDERLINE object as Org syntax.
3182 CONTENTS is the contents of the object."
3186 ;;;; Verbatim
3189 "Parse verbatim object at point.
3191 Return a list whose CAR is `verbatim' and CDR is a plist with
3192 `:value', `:begin', `:end' and `:post-blank' keywords.
3194 Assume point is at the first equal sign marker."
3205 :begin begin
3206 :end end
3210 "Interpret VERBATIM object as Org syntax.
3211 CONTENTS is nil."
3215 \f
3216 ;;; Parsing Element Starting At Point
3217 ;;
3218 ;; `org-element--current-element' is the core function of this section.
3219 ;; It returns the Lisp representation of the element starting at
3220 ;; point.
3221 ;;
3222 ;; `org-element--current-element' makes use of special modes. They
3223 ;; are activated for fixed element chaining (i.e. `plain-list' >
3224 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3225 ;; `section'). Special modes are: `first-section', `section',
3226 ;; `quote-section', `item' and `table-row'.
3230 "Parse the element starting at point.
3232 LIMIT bounds the search.
3234 Return value is a list like (TYPE PROPS) where TYPE is the type
3235 of the element and PROPS a plist of properties associated to the
3236 element.
3238 Possible types are defined in `org-element-all-elements'.
3240 Optional argument GRANULARITY determines the depth of the
3241 recursion. Allowed values are `headline', `greater-element',
3242 `element', `object' or nil. When it is broader than `object' (or
3243 nil), secondary values will not be parsed, since they only
3244 contain objects.
3246 Optional argument SPECIAL, when non-nil, can be either
3247 `first-section', `section', `quote-section', `table-row' and
3248 `item'.
3250 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3251 be computed.
3253 This function assumes point is always at the beginning of the
3254 element it has to parse."
3256 ;; If point is at an affiliated keyword, try moving to the
3257 ;; beginning of the associated element. If none is found, the
3258 ;; keyword is orphaned and will be treated as plain text.
3264 ;; Determine if parsing depth allows for secondary strings
3265 ;; parsing. It only applies to elements referenced in
3266 ;; `org-element-secondary-value-alist'.
3269 ;; Item.
3272 ;; Quote Section.
3274 ;; Table Row.
3276 ;; Headline.
3279 ;; Section (must be checked after headline).
3284 limit)))
3285 ;; Planning and Clock.
3290 ;; Inlinetask.
3293 ;; LaTeX Environment.
3299 nil t))
3302 ;; Drawer and Property Drawer.
3312 ;; Fixed Width
3315 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3316 ;; Keywords.
3322 org-element-block-name-alist)))
3337 ;; Footnote Definition.
3340 ;; Horizontal Rule.
3343 ;; Table.
3345 ;; List.
3348 ;; Default element: Paragraph.
3352 ;; Most elements can have affiliated keywords. When looking for an
3353 ;; element beginning, we want to move before them, as they belong to
3354 ;; that element, and, in the meantime, collect information they give
3355 ;; into appropriate properties. Hence the following function.
3356 ;;
3357 ;; Usage of optional arguments may not be obvious at first glance:
3358 ;;
3359 ;; - TRANS-LIST is used to polish keywords names that have evolved
3360 ;; during Org history. In example, even though =result= and
3361 ;; =results= coexist, we want to have them under the same =result=
3362 ;; property. It's also true for "srcname" and "name", where the
3363 ;; latter seems to be preferred nowadays (thus the "name" property).
3364 ;;
3365 ;; - CONSED allows to regroup multi-lines keywords under the same
3366 ;; property, while preserving their own identity. This is mostly
3367 ;; used for "attr_latex" and al.
3368 ;;
3369 ;; - PARSED prepares a keyword value for export. This is useful for
3370 ;; "caption". Objects restrictions for such keywords are defined in
3371 ;; `org-element-object-restrictions'.
3372 ;;
3373 ;; - DUALS is used to take care of keywords accepting a main and an
3374 ;; optional secondary values. For example "results" has its
3375 ;; source's name as the main value, and may have an hash string in
3376 ;; optional square brackets as the secondary one.
3377 ;;
3378 ;; A keyword may belong to more than one category.
3382 "Collect affiliated keywords before point.
3384 Optional argument KEY-RE is a regexp matching keywords, which
3385 puts matched keyword in group 1. It defaults to
3386 `org-element--affiliated-re'.
3388 TRANS-LIST is an alist where key is the keyword and value the
3389 property name it should be translated to, without the colons. It
3390 defaults to `org-element-keyword-translation-alist'.
3392 CONSED is a list of strings. Any keyword belonging to that list
3393 will have its value consed. The check is done after keyword
3394 translation. It defaults to `org-element-multiple-keywords'.
3396 PARSED is a list of strings. Any keyword member of this list
3397 will have its value parsed. The check is done after keyword
3398 translation. If a keyword is a member of both CONSED and PARSED,
3399 it's value will be a list of parsed strings. It defaults to
3400 `org-element-parsed-keywords'.
3402 DUALS is a list of strings. Any keyword member of this list can
3403 have two parts: one mandatory and one optional. Its value is
3404 a cons cell whose CAR is the former, and the CDR the latter. If
3405 a keyword is a member of both PARSED and DUALS, both values will
3406 be parsed. It defaults to `org-element-dual-keywords'.
3408 Return a list whose CAR is the position at the first of them and
3409 CDR a plist of keywords and values."
3417 ;; RESTRICT is the list of objects allowed in parsed
3418 ;; keywords value.
3420 output)
3424 ;; Apply translation to RAW-KWD. From there, KWD is
3425 ;; the official keyword.
3427 ;; Find main value for any keyword.
3433 ;; If KWD is a dual keyword, find its secondary
3434 ;; value. Maybe parse it.
3440 ;; Attribute a property name to KWD.
3442 ;; Now set final shape for VALUE.
3446 ;; VALUE is mandatory. Set it to nil if there is none.
3448 ;; Attributes are always consed.
3451 ;; Eventually store the new value in OUTPUT.
3457 \f
3458 ;;; The Org Parser
3459 ;;
3460 ;; The two major functions here are `org-element-parse-buffer', which
3461 ;; parses Org syntax inside the current buffer, taking into account
3462 ;; region, narrowing, or even visibility if specified, and
3463 ;; `org-element-parse-secondary-string', which parses objects within
3464 ;; a given string.
3465 ;;
3466 ;; The (almost) almighty `org-element-map' allows to apply a function
3467 ;; on elements or objects matching some type, and accumulate the
3468 ;; resulting values. In an export situation, it also skips unneeded
3469 ;; parts of the parse tree.
3472 "Recursively parse the buffer and return structure.
3473 If narrowing is in effect, only parse the visible part of the
3474 buffer.
3476 Optional argument GRANULARITY determines the depth of the
3477 recursion. It can be set to the following symbols:
3479 `headline' Only parse headlines.
3480 `greater-element' Don't recurse into greater elements excepted
3481 headlines and sections. Thus, elements
3482 parsed are the top-level ones.
3483 `element' Parse everything but objects and plain text.
3484 `object' Parse the complete buffer (default).
3486 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3487 elements.
3489 Assume buffer is in Org mode."
3495 ;; Start in `first-section' mode so text before the first
3496 ;; headline belongs to a section.
3500 "Recursively parse objects in STRING and return structure.
3502 RESTRICTION is a symbol limiting the object types that will be
3503 looked after.
3505 Optional argument PARENT, when non-nil, is the element or object
3506 containing the secondary string. It is used to set correctly
3507 `:parent' property within the string."
3513 secondary))))
3516 "Map a function on selected elements or objects.
3518 DATA is the parsed tree, as returned by, i.e,
3519 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3520 of elements or objects types. FUN is the function called on the
3521 matching element or object. It must accept one arguments: the
3522 element or object itself.
3524 When optional argument INFO is non-nil, it should be a plist
3525 holding export options. In that case, parts of the parse tree
3526 not exportable according to that property list will be skipped.
3528 When optional argument FIRST-MATCH is non-nil, stop at the first
3529 match for which FUN doesn't return nil, and return that value.
3531 Optional argument NO-RECURSION is a symbol or a list of symbols
3532 representing elements or objects types. `org-element-map' won't
3533 enter any recursive element or object whose type belongs to that
3534 list. Though, FUN can still be applied on them.
3536 Nil values returned from FUN do not appear in the results."
3537 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3540 ;; Recursion depth is determined by --CATEGORY.
3547 ;; If one object is found, the function
3548 ;; has to recurse into every object.
3551 ;; If one regular element is found, the
3552 ;; function has to recurse, at lest, into
3553 ;; every element it encounters.
3556 types)
3557 category)))
3558 --acc
3559 --walk-tree
3563 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3564 ;; holding contextual information.
3568 ;; Ignored element in an export context.
3570 ;; Secondary string: only objects can be found there.
3573 ;; Unconditionally enter parse trees.
3577 ;; Check if TYPE is matching among TYPES. If so,
3578 ;; apply FUN to --DATA and accumulate return value
3579 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3585 ;; If --DATA has a secondary string that can contain
3586 ;; objects with their type among TYPES, look into it.
3593 ;; Determine if a recursion into --DATA is possible.
3595 ;; --TYPE is explicitly removed from recursion.
3597 ;; --DATA has no contents.
3599 ;; Looking for greater elements but --DATA is simply
3600 ;; an element or an object.
3603 ;; Looking for elements but --DATA is an object.
3606 ;; In any other case, map contents.
3610 ;; Return value in a proper order.
3613 ;; The following functions are internal parts of the parser.
3614 ;;
3615 ;; The first one, `org-element--parse-elements' acts at the element's
3616 ;; level.
3617 ;;
3618 ;; The second one, `org-element--parse-objects' applies on all objects
3619 ;; of a paragraph or a secondary string. It uses
3620 ;; `org-element--get-next-object-candidates' to optimize the search of
3621 ;; the next object in the buffer.
3622 ;;
3623 ;; More precisely, that function looks for every allowed object type
3624 ;; first. Then, it discards failed searches, keeps further matches,
3625 ;; and searches again types matched behind point, for subsequent
3626 ;; calls. Thus, searching for a given type fails only once, and every
3627 ;; object is searched only once at top level (but sometimes more for
3628 ;; nested types).
3632 "Parse elements between BEG and END positions.
3634 SPECIAL prioritize some elements over the others. It can be set
3635 to `first-section', `quote-section', `section' `item' or
3636 `table-row'.
3638 When value is `item', STRUCTURE will be used as the current list
3639 structure.
3641 GRANULARITY determines the depth of the recursion. See
3642 `org-element-parse-buffer' for more information.
3644 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3645 elements.
3647 Elements are accumulated into ACC."
3650 ;; When parsing only headlines, skip any text before first one.
3653 ;; Main loop start.
3655 ;; Find current element's type and parse it accordingly to
3656 ;; its category.
3658 end granularity special structure))
3662 ;; Fill ELEMENT contents by side-effect.
3664 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3665 ;; no contents, don't modify it.
3668 ;; Greater element: parse it between `contents-begin' and
3669 ;; `contents-end'. Make sure GRANULARITY allows the
3670 ;; recursion, or ELEMENT is an headline, in which case going
3671 ;; inside is mandatory, in order to get sub-level headings.
3679 ;; Possibly switch to a special mode.
3687 granularity visible-only element))
3688 ;; ELEMENT has contents. Parse objects inside, if
3689 ;; GRANULARITY allows it.
3695 ;; Return result.
3696 acc))
3699 "Parse objects between BEG and END and return recursive structure.
3701 Objects are accumulated in ACC.
3703 RESTRICTION is a list of object types which are allowed in the
3704 current object."
3710 end restriction candidates)))
3717 ;; 1. Text before any object. Untabify it.
3722 acc
3726 ;; 2. Object...
3729 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3730 ;; a recursive type.
3735 cont-beg
3742 ;; 3. Text after last object. Untabify it.
3746 acc
3750 ;; Result.
3751 acc)))
3754 "Return an alist of candidates for the next object.
3756 LIMIT bounds the search, and RESTRICTION narrows candidates to
3757 some object types.
3759 Return value is an alist whose CAR is position and CDR the object
3760 type, as a symbol.
3762 OBJECTS is the previous candidates alist."
3764 ;; If no previous result, search every object type in RESTRICTION.
3765 ;; Otherwise, keep potential candidates (old objects located after
3766 ;; point) and ask to search again those which had matched before.
3771 objects))
3772 ;; Call the appropriate successor function for each type to search
3773 ;; and accumulate matches.
3780 type))))
3783 types-to-search)
3784 ;; Return alist.
3785 next-candidates))
3788 \f
3789 ;;; Towards A Bijective Process
3790 ;;
3791 ;; The parse tree obtained with `org-element-parse-buffer' is really
3792 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3793 ;; interpreted and expanded into a string with canonical Org syntax.
3794 ;; Hence `org-element-interpret-data'.
3795 ;;
3796 ;; The function relies internally on
3797 ;; `org-element--interpret-affiliated-keywords'.
3800 "Interpret DATA as Org syntax.
3802 DATA is a parse tree, an element, an object or a secondary string
3803 to interpret.
3805 Optional argument PARENT is used for recursive calls. It contains
3806 the element or object containing data, or nil.
3808 Return Org syntax as a string."
3812 ;; Secondary string.
3817 ;; Full Org document.
3822 ;; Plain text.
3824 ;; Element/Object without contents.
3827 data nil))
3828 ;; Element/Object with contents.
3838 ;; Elements directly containing objects must
3839 ;; have their indentation normalized first.
3841 data
3842 ;; When normalizing first paragraph of an
3843 ;; item or a footnote-definition, ignore
3844 ;; first line's indentation.
3851 data
3853 contents)))))))
3855 ;; Build white spaces. If no `:post-blank' property is
3856 ;; specified, assume its value is 0.
3866 "Return ELEMENT's affiliated keywords as Org syntax.
3867 If there is no affiliated keyword, return the empty string."
3877 ": "
3880 value)
3888 ;; All attribute keywords can have multiple lines.
3891 value
3894 ;; List all ELEMENT's properties matching an attribute line or an
3895 ;; affiliated keyword, but ignore translated keywords since they
3896 ;; cannot belong to the property list.
3903 org-element-keyword-translation-alist)))))
3904 collect prop)
3907 ;; Because interpretation of the parse tree must return the same
3908 ;; number of blank lines between elements and the same number of white
3909 ;; space after objects, some special care must be given to white
3910 ;; spaces.
3911 ;;
3912 ;; The first function, `org-element-normalize-string', ensures any
3913 ;; string different from the empty string will end with a single
3914 ;; newline character.
3915 ;;
3916 ;; The second function, `org-element-normalize-contents', removes
3917 ;; global indentation from the contents of the current element.
3920 "Ensure string S ends with a single newline character.
3922 If S isn't a string return it unchanged. If S is the empty
3923 string, return it. Otherwise, return a new string with a single
3924 newline character at its end."
3932 "Normalize plain text in ELEMENT's contents.
3934 ELEMENT must only contain plain text and objects.
3936 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3937 indentation to compute maximal common indentation.
3939 Return the normalized element that is element with global
3940 indentation removed from its contents. The function assumes that
3941 indentation is not done with TAB characters."
3943 collect-inds ; for byte-compiler
3946 ;; Return list of indentations within BLOB. This is done by
3947 ;; walking recursively BLOB and updating IND-LIST along the
3948 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3949 ;; been seen yet. It is required as this string is the only
3950 ;; one whose indentation doesn't happen after a newline
3951 ;; character.
3959 ;; An indentation of zero means no string will be
3960 ;; modified. Quit the process.
3966 ;; Avoid matching blank or empty lines.
3974 ;; Collect indentation list in ELEMENT. Possibly remove first
3975 ;; value if IGNORE-FIRST is non-nil.
3978 ;; Build ELEMENT back, replacing each string with the same
3979 ;; string minus common indentation.
3984 ;; Return BLOB with all its strings indentation
3985 ;; shortened from MCI white spaces. FIRST-FLAG is
3986 ;; non-nil when the first string hasn't been seen
3987 ;; yet.
4001 org-element-recursive-objects)
4005 blob))))
4009 \f
4010 ;;; The Toolbox
4011 ;;
4012 ;; The first move is to implement a way to obtain the smallest element
4013 ;; containing point. This is the job of `org-element-at-point'. It
4014 ;; basically jumps back to the beginning of section containing point
4015 ;; and moves, element after element, with
4016 ;; `org-element--current-element' until the container is found.
4017 ;;
4018 ;; At a deeper level, `org-element-context' lists all elements and
4019 ;; objects containing point.
4020 ;;
4021 ;; Note: When using `org-element-at-point', secondary values are never
4022 ;; parsed since the function focuses on elements, not on objects.
4024 ;;;###autoload
4026 "Determine closest element around point.
4028 Return value is a list like (TYPE PROPS) where TYPE is the type
4029 of the element and PROPS a plist of properties associated to the
4030 element.
4032 Possible types are defined in `org-element-all-elements'.
4033 Properties depend on element or object type, but always
4034 include :begin, :end, :parent and :post-blank properties.
4036 As a special case, if point is at the very beginning of a list or
4037 sub-list, returned element will be that list instead of the first
4038 item. In the same way, if point is at the beginning of the first
4039 row of a table, returned element will be the table instead of the
4040 first row.
4042 If optional argument KEEP-TRAIL is non-nil, the function returns
4043 a list of of elements leading to element at point. The list's
4044 CAR is always the element at point. Following positions contain
4045 element's siblings, then parents, siblings of parents, until the
4046 first element of current section."
4048 ;; If at an headline, parse it. It is the sole element that
4049 ;; doesn't require to know about context. Be sure to disallow
4050 ;; secondary string parsing, though.
4056 ;; Otherwise move at the beginning of the section containing
4057 ;; point.
4061 element type special-flag trail struct prevs parent)
4069 ;; Parse successively each element, skipping those ending
4070 ;; before original position.
4079 ;; 1. Skip any element ending before point or at point
4080 ;; because the following element has started. On the
4081 ;; other hand, if the element ends at point and that
4082 ;; point is also the end of the buffer, do not skip it.
4088 ;; 2. An element containing point is always the element at
4089 ;; point.
4092 ;; 3. At any other greater element type, if point is
4093 ;; within contents, move into it. Otherwise, return
4094 ;; that element. As a special case, when ORIGIN is
4095 ;; contents end and is also the end of the buffer, try
4096 ;; to move inside the greater element to find the end
4097 ;; of the innermost element.
4116 "Return closest element or object around point.
4118 Return value is a list like (TYPE PROPS) where TYPE is the type
4119 of the element or object and PROPS a plist of properties
4120 associated to it.
4122 Possible types are defined in `org-element-all-elements' and
4123 `org-element-all-objects'. Properties depend on element or
4124 object type, but always include :begin, :end, :parent
4125 and :post-blank properties."
4130 end)
4131 ;; Check if point is inside an element containing objects or at
4132 ;; a secondary string. In that case, move to beginning of the
4133 ;; element or secondary string and set END to the other side.
4142 (<= origin
4143 ;; `1+' is required so some
4144 ;; successors can match
4145 ;; properly their object.
4159 element
4162 candidates)
4165 end restriction candidates))
4167 candidates)))
4168 ;; If ORIGIN is before next object in element, there's
4169 ;; no point in looking further.
4178 ;; ORIGIN is after OBJECT, so skip it.
4181 ;; ORIGIN is within a non-recursive object or at an
4182 ;; object boundaries: Return that object.
4186 ;; Otherwise, move within current object and restrict
4187 ;; search to the end of its contents.
4191 parent))))))
4194 ;; Once the local structure around point is well understood, it's easy
4195 ;; to implement some replacements for `forward-paragraph'
4196 ;; `backward-paragraph', namely `org-element-forward' and
4197 ;; `org-element-backward'.
4198 ;;
4199 ;; Also, `org-transpose-elements' mimics the behaviour of
4200 ;; `transpose-words', at the element's level, whereas
4201 ;; `org-element-drag-forward', `org-element-drag-backward', and
4202 ;; `org-element-up' generalize, respectively, functions
4203 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
4204 ;;
4205 ;; `org-element-unindent-buffer' will, as its name almost suggests,
4206 ;; smartly remove global indentation from buffer, making it possible
4207 ;; to use Org indent mode on a file created with hard indentation.
4208 ;;
4209 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
4210 ;; internally by some of the previously cited tools.
4213 "Non-nil when elements ELEM-A and ELEM-B are nested."
4222 "Swap elements ELEM-A and ELEM-B.
4223 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4224 end of ELEM-A."
4226 ;; There are two special cases when an element doesn't start at bol:
4227 ;; the first paragraph in an item or in a footnote definition.
4229 ;; Only a paragraph without any affiliated keyword can be moved at
4230 ;; ELEM-A position in such a situation. Note that the case of
4231 ;; a footnote definition is impossible: it cannot contain two
4232 ;; paragraphs in a row because it cannot contain a blank line.
4238 ;; In a special situation, ELEM-A will have no indentation. We'll
4239 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4253 ;; Store overlays responsible for visibility status. We
4254 ;; also need to store their boundaries as they will be
4255 ;; removed from buffer.
4262 ;; Get contents.
4270 ;; Restore ex ELEM-A overlays.
4280 ;; Restore ex ELEM-B overlays.
4288 ;;;###autoload
4290 "Move forward by one element.
4291 Move to the next element at the same level, when possible."
4308 ;;;###autoload
4310 "Move backward by one element.
4311 Move to the previous element at the same level, when possible."
4314 ;; At an headline, move to the previous one, if any, or stay
4315 ;; here.
4326 ;; Move to beginning of current element if point isn't there
4327 ;; already.
4332 ;;;###autoload
4334 "Move to upper element."
4345 ;;;###autoload
4347 "Move to inner element."
4355 ;; If contents are hidden, first disclose them.
4361 ;;;###autoload
4363 "Move backward element at point."
4369 ;; Error out if no previous element or previous element is
4370 ;; a parent of the current one.
4378 ;;;###autoload
4380 "Move forward element at point."
4393 ;; Compute new position of point: it's shifted by NEXT-ELEM
4394 ;; body's length (without final blanks) and by the length of
4395 ;; blanks between ELEM and NEXT-ELEM.
4400 ;; Small correction if buffer doesn't end
4401 ;; with a newline character.
4413 ;;;###autoload
4415 "Put point at beginning of this element, mark at end.
4417 Interactively, if this command is repeated or (in Transient Mark
4418 mode) if the mark is active, it marks the next element after the
4419 ones already marked."
4433 ;;;###autoload
4435 "Narrow buffer to current element."
4452 ;;;###autoload
4454 "Transpose current and previous elements, keeping blank lines between.
4455 Point is moved after both elements."
4462 ;;;###autoload
4464 "Un-indent the visible part of the buffer.
4465 Relative indentation (between items, inside blocks, etc.) isn't
4466 modified."
4471 unindent-tree ; For byte-compiler.
4490 ;;; org-element.el ends here