| blob | df6cc72e3ed7f28ffcc0d5884e8db60ddace5f0a |
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 `org-element-at-point' function, and
104 ;; a way to give information about document structure around point
105 ;; with `org-element-context'.
108 ;;; Code:
115 \f
116 ;;; Definitions And Rules
117 ;;
118 ;; Define elements, greater elements and specify recursive objects,
119 ;; along with the affiliated keywords recognized. Also set up
120 ;; restrictions on recursive objects combinations.
121 ;;
122 ;; These variables really act as a control center for the parsing
123 ;; process.
127 ;; Headlines, inlinetasks.
129 ;; Footnote definitions.
132 ;; Empty lines.
134 ;; Tables (any type).
136 ;; Blocks (any type), Babel calls, drawers (any type),
137 ;; fixed-width areas and keywords. Note: this is only an
138 ;; indication and need some thorough check.
140 ;; Horizontal rules.
142 ;; LaTeX environments.
144 ;; Planning and Clock lines.
146 org-deadline-string
147 org-closed-string
148 org-clock-string))
150 ;; Lists.
157 "Regexp to separate paragraphs in an Org buffer.
159 is not sufficient to know if point is at a paragraph ending. See
164 export-block fixed-width footnote-definition headline
165 horizontal-rule inlinetask item keyword latex-environment
166 babel-call paragraph plain-list planning property-drawer
167 quote-block quote-section section special-block src-block table
168 table-row verse-block)
173 item plain-list quote-block section special-block table)
178 latex-or-entity line-break link macro radio-target
179 statistics-cookie sub/superscript table-cell target
180 text-markup timestamp)
189 "Alist of translations between object type and successor name.
191 Sharing the same successor comes handy when, for example, the
196 inline-src-block italic line-break latex-fragment link macro
197 radio-target statistics-cookie strike-through subscript superscript
198 table-cell target timestamp underline verbatim)
203 table-cell underline)
213 "Alist between block names and the associated parsing function.
214 Names must be uppercase. Any block whose name has no association
220 Only these types can accept search options and an explicit
226 "List of affiliated keywords as strings.
232 ;; Regular affiliated keywords.
235 "Regexp matching any affiliated keyword.
237 Keyword name is put in match group 1. Moreover, if keyword
238 belongs to `org-element-dual-keywords', put the dual value in
239 match group 2.
247 "Alist of usual translations for keywords.
248 The key is the old name and the value the new one. The property
252 "List of affiliated keywords that can occur more that once in an element.
254 Their value will be consed into a list of strings, which will be
255 returned as the value of the property.
257 This list is checked after translations have been applied. See
258 `org-element-keyword-translation-alist'.
264 "List of keywords whose value can be parsed.
266 Their value will be stored as a secondary string: a list of
267 strings and objects.
269 This list is checked after translations have been applied. See
273 "List of keywords which can have a secondary value.
275 In Org syntax, they can be written with optional square brackets
276 before the colons. For example, results keyword can be
277 associated to a hash value with the following:
279 #+RESULTS[hash-string]: some-source
281 This list is checked after translations have been applied. See
288 inline-src-block latex-or-entity line-break link macro
289 radio-target sub/superscript target text-markup
290 timestamp)
292 radio-target statistics-cookie sub/superscript target text-markup
293 timestamp)
305 inline-src-block latex-or-entity line-break link macro
306 radio-target statistics-cookie sub/superscript target text-markup
307 timestamp)
310 latex-or-entity link radio-target sub/superscript target
311 text-markup timestamp)
322 latex-or-entity line-break link macro radio-target
324 "Alist of objects restrictions.
326 CAR is an element or object type containing objects and CDR is
327 a list of successors that will be called within an element or
328 object of such type.
330 For example, in a `radio-target' object, one can only find
331 entities, export snippets, latex-fragments, subscript and
332 superscript.
334 This alist also applies to secondary string. For example, an
335 `headline' type element doesn't directly contain objects, but
346 \f
347 ;;; Accessors and Setters
348 ;;
349 ;; Provide four accessors: `org-element-type', `org-element-property'
350 ;; `org-element-contents' and `org-element-restriction'.
351 ;;
352 ;; Setter functions allow to modify elements by side effect. There is
353 ;; `org-element-put-property', `org-element-set-contents',
354 ;; `org-element-set-element' and `org-element-adopt-element'. Note
355 ;; that `org-element-set-element' and `org-element-adopt-elements' are
356 ;; higher level functions since also update `:parent' property.
359 "Return type of ELEMENT.
361 The function returns the type of the element or object provided.
362 It can also return the following special value:
363 `plain-text' for a string
364 `org-data' for a complete document
365 nil in any other case."
371 "Extract the value from the PROPERTY of an ELEMENT."
375 "Extract contents from an ELEMENT."
379 "Return restriction associated to ELEMENT.
380 ELEMENT can be an element, an object or a symbol representing an
381 element or object type."
383 org-element-object-restrictions)))
386 "In ELEMENT set PROPERTY to VALUE.
387 Return modified element."
390 element)
393 "Set ELEMENT contents to CONTENTS.
394 Return modified element."
400 "Replace element or object OLD with element or object NEW.
401 The function takes care of setting `:parent' property for NEW."
402 ;; Since OLD is going to be changed into NEW by side-effect, first
403 ;; make sure that every element or object within NEW has OLD as
404 ;; parent.
407 ;; Transfer contents.
409 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
410 ;; with NEW's.
413 ;; Transfer type.
417 "Append elements to the contents of another element.
419 PARENT is an element or object. CHILDREN can be elements,
420 objects, or a strings.
422 The function takes care of setting `:parent' property for CHILD.
423 Return parent element."
425 ;; Link every child to PARENT.
429 children)
430 ;; Add CHILDREN at the end of PARENT contents.
432 parent
434 ;; Return modified PARENT element.
435 parent))
438 \f
439 ;;; Greater elements
440 ;;
441 ;; For each greater element type, we define a parser and an
442 ;; interpreter.
443 ;;
444 ;; A parser returns the element or object as the list described above.
445 ;; Most of them accepts no argument. Though, exceptions exist. Hence
446 ;; every element containing a secondary string (see
447 ;; `org-element-secondary-value-alist') will accept an optional
448 ;; argument to toggle parsing of that secondary string. Moreover,
449 ;; `item' parser requires current list's structure as its first
450 ;; element.
451 ;;
452 ;; An interpreter accepts two arguments: the list representation of
453 ;; the element or object, and its contents. The latter may be nil,
454 ;; depending on the element or object considered. It returns the
455 ;; appropriate Org syntax, as a string.
456 ;;
457 ;; Parsing functions must follow the naming convention:
458 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
459 ;; defined in `org-element-greater-elements'.
460 ;;
461 ;; Similarly, interpreting functions must follow the naming
462 ;; convention: org-element-TYPE-interpreter.
463 ;;
464 ;; With the exception of `headline' and `item' types, greater elements
465 ;; cannot contain other greater elements of their own type.
466 ;;
467 ;; Beside implementing a parser and an interpreter, adding a new
468 ;; greater element requires to tweak `org-element--current-element'.
469 ;; Moreover, the newly defined type must be added to both
470 ;; `org-element-all-elements' and `org-element-greater-elements'.
473 ;;;; Center Block
476 "Parse a center block.
478 LIMIT bounds the search.
480 Return a list whose CAR is `center-block' and CDR is a plist
481 containing `:begin', `:end', `:hiddenp', `:contents-begin',
482 `:contents-end' and `:post-blank' keywords.
484 Assume point is at the beginning of the block."
488 ;; Incomplete block: parse it as a paragraph.
493 ;; Empty blocks have no contents.
507 :end end
508 :hiddenp hidden
509 :contents-begin contents-begin
510 :contents-end contents-end
515 "Interpret CENTER-BLOCK element as Org syntax.
516 CONTENTS is the contents of the element."
520 ;;;; Drawer
523 "Parse a drawer.
525 LIMIT bounds the search.
527 Return a list whose CAR is `drawer' and CDR is a plist containing
528 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
529 `:contents-end' and `:post-blank' keywords.
531 Assume point is at beginning of drawer."
534 ;; Incomplete drawer: parse it as a paragraph.
543 ;; Empty drawers have no contents.
557 :end end
558 :drawer-name name
559 :hiddenp hidden
560 :contents-begin contents-begin
561 :contents-end contents-end
566 "Interpret DRAWER element as Org syntax.
567 CONTENTS is the contents of the element."
570 contents))
573 ;;;; Dynamic Block
576 "Parse a dynamic block.
578 LIMIT bounds the search.
580 Return a list whose CAR is `dynamic-block' and CDR is a plist
581 containing `:block-name', `:begin', `:end', `:hiddenp',
582 `:contents-begin', `:contents-end', `:arguments' and
583 `:post-blank' keywords.
585 Assume point is at beginning of dynamic block."
588 ;; Incomplete block: parse it as a paragraph.
597 ;; Empty blocks have no contents.
611 :end end
612 :block-name name
613 :arguments arguments
614 :hiddenp hidden
615 :contents-begin contents-begin
616 :contents-end contents-end
621 "Interpret DYNAMIC-BLOCK element as Org syntax.
622 CONTENTS is the contents of the element."
627 contents))
630 ;;;; Footnote Definition
633 "Parse a footnote definition.
635 LIMIT bounds the search.
637 Return a list whose CAR is `footnote-definition' and CDR is
638 a plist containing `:label', `:begin' `:end', `:contents-begin',
639 `:contents-end' and `:post-blank' keywords.
641 Assume point is at the beginning of the footnote definition."
666 :begin begin
667 :end end
668 :contents-begin contents-begin
669 :contents-end contents-end
674 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
675 CONTENTS is the contents of the footnote-definition."
677 " "
678 contents))
681 ;;;; Headline
684 "Parse an headline.
686 Return a list whose CAR is `headline' and CDR is a plist
687 containing `:raw-value', `:title', `:begin', `:end',
688 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
689 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
690 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
691 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
692 keywords.
694 The plist also contains any property set in the property drawer,
695 with its name in lowercase, the underscores replaced with hyphens
696 and colons at the beginning (i.e. `:custom-id').
698 When RAW-SECONDARY-P is non-nil, headline's title will not be
699 parsed as a secondary string, but as a plain string instead.
701 Assume point is at beginning of the headline."
720 ;; Normalize property names: ":SOME_PROP:" becomes
721 ;; ":some-prop".
733 plist))
751 ;; Clean RAW-VALUE from any quote or comment string.
756 ""
757 raw-value)))
758 ;; Clean TAGS from archive tag, if any.
764 :begin begin
765 :end end
766 :pre-blank
769 :hiddenp hidden
770 :contents-begin contents-begin
771 :contents-end contents-end
772 :level level
774 :tags tags
775 :todo-keyword todo
776 :todo-type todo-type
777 :scheduled scheduled
778 :deadline deadline
779 :timestamp timestamp
780 :clock clock
786 end)
787 :footnote-section-p footnote-section-p
788 :archivedp archivedp
789 :commentedp commentedp
791 standard-props))))
793 headline :title
799 "Interpret HEADLINE element as Org syntax.
800 CONTENTS is the contents of the element."
827 ;; Align tags.
835 ? )
836 tags))
840 tags))))
842 contents)))
845 ;;;; Inlinetask
848 "Parse an inline task.
850 Return a list whose CAR is `inlinetask' and CDR is a plist
851 containing `:title', `:begin', `:end', `:hiddenp',
852 `:contents-begin' and `:contents-end', `:level', `:priority',
853 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
854 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
856 The plist also contains any property set in the property drawer,
857 with its name in lowercase, the underscores replaced with hyphens
858 and colons at the beginning (i.e. `:custom-id').
860 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
861 title will not be parsed as a secondary string, but as a plain
862 string instead.
864 Assume point is at beginning of the inline task."
874 ;; Normalize property names: ":SOME_PROP:" becomes
875 ;; ":some-prop".
887 plist))
911 :end end
912 :hiddenp hidden
913 :contents-begin contents-begin
914 :contents-end contents-end
917 :tags tags
918 :todo-keyword todo
919 :todo-type todo-type
920 :scheduled scheduled
921 :deadline deadline
922 :timestamp timestamp
923 :clock clock
925 standard-props
928 inlinetask :title
933 inlinetask))))))
936 "Interpret INLINETASK element as Org syntax.
937 CONTENTS is the contents of inlinetask."
952 ;; Align tags.
960 ? )
961 tags))
965 tags))))
966 ;; Prefer degenerate inlinetasks when there are no
967 ;; contents.
970 contents
974 ;;;; Item
977 "Parse an item.
979 STRUCT is the structure of the plain list.
981 Return a list whose CAR is `item' and CDR is a plist containing
982 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
983 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
984 `:post-blank' keywords.
986 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
987 any, will not be parsed as a secondary string, but as a plain
988 string instead.
990 Assume point is at the beginning of the item."
1014 ;; Ignore tags in un-ordered lists: they are just
1015 ;; a part of item's body.
1021 ;; If first line isn't empty, contents really start
1022 ;; at the text after item's meta-data.
1033 :begin begin
1034 :end end
1035 ;; CONTENTS-BEGIN and CONTENTS-END may be
1036 ;; mixed up in the case of an empty item
1037 ;; separated from the next by a blank line.
1038 ;; Thus ensure the former is always the
1039 ;; smallest.
1042 :checkbox checkbox
1043 :counter counter
1044 :hiddenp hidden
1045 :structure struct
1048 item :tag
1056 "Interpret ITEM element as Org syntax.
1057 CONTENTS is the contents of the element."
1063 ;; Compute indentation.
1068 ;; Indent contents.
1070 bullet
1083 ;;;; Plain List
1086 "Parse a plain list.
1088 Optional argument STRUCTURE, when non-nil, is the structure of
1089 the plain list being parsed.
1091 Return a list whose CAR is `plain-list' and CDR is a plist
1092 containing `:type', `:begin', `:end', `:contents-begin' and
1093 `:contents-end', `:structure' and `:post-blank' keywords.
1095 Assume point is at the beginning of the list."
1110 ;; Return value.
1114 :begin begin
1115 :end end
1116 :contents-begin contents-begin
1117 :contents-end contents-end
1118 :structure struct
1123 "Interpret PLAIN-LIST element as Org syntax.
1124 CONTENTS is the contents of the element."
1132 ;;;; Quote Block
1135 "Parse a quote block.
1137 LIMIT bounds the search.
1139 Return a list whose CAR is `quote-block' and CDR is a plist
1140 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1141 `:contents-end' and `:post-blank' keywords.
1143 Assume point is at the beginning of the block."
1147 ;; Incomplete block: parse it as a paragraph.
1153 ;; Empty blocks have no contents.
1167 :end end
1168 :hiddenp hidden
1169 :contents-begin contents-begin
1170 :contents-end contents-end
1175 "Interpret QUOTE-BLOCK element as Org syntax.
1176 CONTENTS is the contents of the element."
1180 ;;;; Section
1183 "Parse a section.
1185 LIMIT bounds the search.
1187 Return a list whose CAR is `section' and CDR is a plist
1188 containing `:begin', `:end', `:contents-begin', `contents-end'
1189 and `:post-blank' keywords."
1191 ;; Beginning of section is the beginning of the first non-blank
1192 ;; line after previous headline.
1201 :end end
1202 :contents-begin begin
1203 :contents-end pos-before-blank
1207 "Interpret SECTION element as Org syntax.
1208 CONTENTS is the contents of the element."
1209 contents)
1212 ;;;; Special Block
1215 "Parse a special block.
1217 LIMIT bounds the search.
1219 Return a list whose CAR is `special-block' and CDR is a plist
1220 containing `:type', `:begin', `:end', `:hiddenp',
1221 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1223 Assume point is at the beginning of the block."
1229 ;; Incomplete block: parse it as a paragraph.
1235 ;; Empty blocks have no contents.
1249 :begin begin
1250 :end end
1251 :hiddenp hidden
1252 :contents-begin contents-begin
1253 :contents-end contents-end
1258 "Interpret SPECIAL-BLOCK element as Org syntax.
1259 CONTENTS is the contents of the element."
1264 \f
1265 ;;; Elements
1266 ;;
1267 ;; For each element, a parser and an interpreter are also defined.
1268 ;; Both follow the same naming convention used for greater elements.
1269 ;;
1270 ;; Also, as for greater elements, adding a new element type is done
1271 ;; through the following steps: implement a parser and an interpreter,
1272 ;; tweak `org-element--current-element' so that it recognizes the new
1273 ;; type and add that new type to `org-element-all-elements'.
1274 ;;
1275 ;; As a special case, when the newly defined type is a block type,
1276 ;; `org-element-block-name-alist' has to be modified accordingly.
1279 ;;;; Babel Call
1282 "Parse a babel call.
1284 LIMIT bounds the search.
1286 Return a list whose CAR is `babel-call' and CDR is a plist
1287 containing `:begin', `:end', `:info' and `:post-blank' as
1288 keywords."
1299 :end end
1300 :info info
1304 "Interpret BABEL-CALL element as Org syntax.
1305 CONTENTS is nil."
1311 ;; Remove redundant square brackets.
1316 ;;;; Clock
1319 "Parse a clock.
1321 LIMIT bounds the search.
1323 Return a list whose CAR is `clock' and CDR is a plist containing
1324 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1325 as keywords."
1344 :value value
1345 :time time
1346 :begin begin
1347 :end end
1351 "Interpret CLOCK element as Org syntax.
1352 CONTENTS is nil."
1359 "%2s:%02s"
1363 ;;;; Comment
1366 "Parse a comment.
1368 LIMIT bounds the search.
1370 Return a list whose CAR is `comment' and CDR is a plist
1371 containing `:begin', `:end', `:value' and `:post-blank'
1372 keywords.
1374 Assume point is at comment beginning."
1383 ;; Get comments ending.
1386 ;; Accumulate lines without leading hash and first
1387 ;; whitespace.
1401 :end end
1402 :value value
1407 "Interpret COMMENT element as Org syntax.
1408 CONTENTS is nil."
1412 ;;;; Comment Block
1415 "Parse an export block.
1417 LIMIT bounds the search.
1419 Return a list whose CAR is `comment-block' and CDR is a plist
1420 containing `:begin', `:end', `:hiddenp', `:value' and
1421 `:post-blank' keywords.
1423 Assume point is at comment block beginning."
1427 ;; Incomplete block: parse it as a paragraph.
1441 contents-begin contents-end)))
1445 :end end
1446 :value value
1447 :hiddenp hidden
1452 "Interpret COMMENT-BLOCK element as Org syntax.
1453 CONTENTS is nil."
1458 ;;;; Example Block
1461 "Parse an example block.
1463 LIMIT bounds the search.
1465 Return a list whose CAR is `example-block' and CDR is a plist
1466 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1467 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1468 `:switches', `:value' and `:post-blank' keywords."
1472 ;; Incomplete block: parse it as a paragraph.
1479 ;; Switches analysis
1484 ;; Should labels be retained in (or stripped from) example
1485 ;; blocks?
1490 ;; What should code-references use - labels or
1491 ;; line-numbers?
1498 ;; Standard block parsing.
1512 :end end
1513 :value value
1514 :switches switches
1515 :number-lines number-lines
1516 :preserve-indent preserve-indent
1517 :retain-labels retain-labels
1518 :use-labels use-labels
1519 :label-fmt label-fmt
1520 :hiddenp hidden
1525 "Interpret EXAMPLE-BLOCK element as Org syntax.
1526 CONTENTS is nil."
1534 ;;;; Export Block
1537 "Parse an export block.
1539 LIMIT bounds the search.
1541 Return a list whose CAR is `export-block' and CDR is a plist
1542 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1543 `:post-blank' keywords.
1545 Assume point is at export-block beginning."
1551 ;; Incomplete block: parse it as a paragraph.
1565 contents-end)))
1569 :end end
1570 :type type
1571 :value value
1572 :hiddenp hidden
1577 "Interpret EXPORT-BLOCK element as Org syntax.
1578 CONTENTS is nil."
1585 ;;;; Fixed-width
1588 "Parse a fixed-width section.
1590 LIMIT bounds the search.
1592 Return a list whose CAR is `fixed-width' and CDR is a plist
1593 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1595 Assume point is at the beginning of the fixed-width area."
1599 value
1604 ;; Accumulate text without starting colons.
1617 :end end
1618 :value value
1623 "Interpret FIXED-WIDTH element as Org syntax.
1624 CONTENTS is nil."
1629 ;;;; Horizontal Rule
1632 "Parse an horizontal rule.
1634 LIMIT bounds the search.
1636 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1637 containing `:begin', `:end' and `:post-blank' keywords."
1647 :end end
1652 "Interpret HORIZONTAL-RULE element as Org syntax.
1653 CONTENTS is nil."
1657 ;;;; Keyword
1660 "Parse a keyword at point.
1662 LIMIT bounds the search.
1664 Return a list whose CAR is `keyword' and CDR is a plist
1665 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1666 keywords."
1679 :value value
1680 :begin begin
1681 :end end
1685 "Interpret KEYWORD element as Org syntax.
1686 CONTENTS is nil."
1692 ;;;; Latex Environment
1695 "Parse a LaTeX environment.
1697 LIMIT bounds the search.
1699 Return a list whose CAR is `latex-environment' and CDR is a plist
1700 containing `:begin', `:end', `:value' and `:post-blank'
1701 keywords.
1703 Assume point is at the beginning of the latex environment."
1721 :end end
1722 :value value
1727 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1728 CONTENTS is nil."
1732 ;;;; Paragraph
1735 "Parse a paragraph.
1737 LIMIT bounds the search.
1739 Return a list whose CAR is `paragraph' and CDR is a plist
1740 containing `:begin', `:end', `:contents-begin' and
1741 `:contents-end' and `:post-blank' keywords.
1743 Assume point is at the beginning of the paragraph."
1746 ;; beginning of an item or a footnote reference. In that
1747 ;; case, we mustn't look for affiliated keywords since they
1748 ;; belong to the container.
1760 ;; Skip non-existent or incomplete drawer.
1768 ;; Stop at comments.
1772 ;; Skip incomplete dynamic blocks.
1779 ;; Skip incomplete blocks.
1787 limit t))))
1788 ;; Skip incomplete latex environments.
1796 limit t))))
1797 ;; Skip ill-formed keywords.
1811 :end end
1812 :contents-begin contents-begin
1813 :contents-end contents-end
1818 "Interpret PARAGRAPH element as Org syntax.
1819 CONTENTS is the contents of the element."
1820 contents)
1823 ;;;; Planning
1826 "Parse a planning.
1828 LIMIT bounds the search.
1830 Return a list whose CAR is `planning' and CDR is a plist
1831 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1832 and `:post-blank' keywords."
1841 closed deadline scheduled)
1855 :deadline deadline
1856 :scheduled scheduled
1857 :begin begin
1858 :end end
1862 "Interpret PLANNING element as Org syntax.
1863 CONTENTS is nil."
1865 'identity
1877 ;;;; Property Drawer
1880 "Parse a property drawer.
1882 LIMIT bounds the search.
1884 Return a list whose CAR is `property-drawer' and CDR is a plist
1885 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1886 `:contents-end', `:properties' and `:post-blank' keywords.
1888 Assume point is at the beginning of the property drawer."
1902 val))
1904 val))
1912 :end end
1913 :hiddenp hidden
1914 :properties properties
1918 "Interpret PROPERTY-DRAWER element as Org syntax.
1919 CONTENTS is nil."
1929 ;;;; Quote Section
1932 "Parse a quote section.
1934 LIMIT bounds the search.
1936 Return a list whose CAR is `quote-section' and CDR is a plist
1937 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1939 Assume point is at beginning of the section."
1950 :end end
1951 :value value
1955 "Interpret QUOTE-SECTION element as Org syntax.
1956 CONTENTS is nil."
1960 ;;;; Src Block
1963 "Parse a src block.
1965 LIMIT bounds the search.
1967 Return a list whose CAR is `src-block' and CDR is a plist
1968 containing `:language', `:switches', `:parameters', `:begin',
1969 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1970 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1971 `:post-blank' keywords.
1973 Assume point is at the beginning of the block."
1976 ;; Incomplete block: parse it as a paragraph.
1981 ;; Get beginning position.
1983 ;; Get language as a string.
1992 ;; Get switches.
1994 ;; Get parameters.
1996 ;; Switches analysis
2004 ;; Should labels be retained in (or stripped from)
2005 ;; src blocks?
2010 ;; What should code-references use - labels or
2011 ;; line-numbers?
2015 ;; Get visibility status.
2017 ;; Retrieve code.
2022 ;; Get position after ending blank lines.
2032 :begin begin
2033 :end end
2034 :number-lines number-lines
2035 :preserve-indent preserve-indent
2036 :retain-labels retain-labels
2037 :use-labels use-labels
2038 :label-fmt label-fmt
2039 :hiddenp hidden
2040 :value value
2045 "Interpret SRC-BLOCK element as Org syntax.
2046 CONTENTS is nil."
2066 value
2070 ;;;; Table
2073 "Parse a table at point.
2075 LIMIT bounds the search.
2077 Return a list whose CAR is `table' and CDR is a plist containing
2078 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2079 `:contents-end', `:value' and `:post-blank' keywords.
2081 Assume point is at the beginning of the table."
2093 acc))
2100 :end end
2101 :type type
2102 :tblfm tblfm
2103 ;; Only `org' tables have contents. `table.el' tables
2104 ;; use a `:value' property to store raw table as
2105 ;; a string.
2110 table-begin table-end))
2115 "Interpret TABLE element as Org syntax.
2116 CONTENTS is nil."
2127 ;;;; Table Row
2130 "Parse table row at point.
2132 LIMIT bounds the search.
2134 Return a list whose CAR is `table-row' and CDR is a plist
2135 containing `:begin', `:end', `:contents-begin', `:contents-end',
2136 `:type' and `:post-blank' keywords."
2140 ;; A table rule has no contents. In that case, ensure
2141 ;; CONTENTS-BEGIN matches CONTENTS-END.
2153 :begin begin
2154 :end end
2155 :contents-begin contents-begin
2156 :contents-end contents-end
2160 "Interpret TABLE-ROW element as Org syntax.
2161 CONTENTS is the contents of the table row."
2166 ;;;; Verse Block
2169 "Parse a verse block.
2171 LIMIT bounds the search.
2173 Return a list whose CAR is `verse-block' and CDR is a plist
2174 containing `:begin', `:end', `:contents-begin', `:contents-end',
2175 `:hiddenp' and `:post-blank' keywords.
2177 Assume point is at beginning of the block."
2181 ;; Incomplete block: parse it as a paragraph.
2197 :end end
2198 :contents-begin contents-begin
2199 :contents-end contents-end
2200 :hiddenp hidden
2205 "Interpret VERSE-BLOCK element as Org syntax.
2206 CONTENTS is verse block contents."
2210 \f
2211 ;;; Objects
2212 ;;
2213 ;; Unlike to elements, interstices can be found between objects.
2214 ;; That's why, along with the parser, successor functions are provided
2215 ;; for each object. Some objects share the same successor (i.e. `code'
2216 ;; and `verbatim' objects).
2217 ;;
2218 ;; A successor must accept a single argument bounding the search. It
2219 ;; will return either a cons cell whose CAR is the object's type, as
2220 ;; a symbol, and CDR the position of its next occurrence, or nil.
2221 ;;
2222 ;; Successors follow the naming convention:
2223 ;; org-element-NAME-successor, where NAME is the name of the
2224 ;; successor, as defined in `org-element-all-successors'.
2225 ;;
2226 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2227 ;; object types they can contain will be specified in
2228 ;; `org-element-object-restrictions'.
2229 ;;
2230 ;; Adding a new type of object is simple. Implement a successor,
2231 ;; a parser, and an interpreter for it, all following the naming
2232 ;; convention. Register type in `org-element-all-objects' and
2233 ;; successor in `org-element-all-successors'. Maybe tweak
2234 ;; restrictions about it, and that's it.
2237 ;;;; Bold
2240 "Parse bold object at point.
2242 Return a list whose CAR is `bold' and CDR is a plist with
2243 `:begin', `:end', `:contents-begin' and `:contents-end' and
2244 `:post-blank' keywords.
2246 Assume point is at the first star marker."
2258 :end end
2259 :contents-begin contents-begin
2260 :contents-end contents-end
2264 "Interpret BOLD object as Org syntax.
2265 CONTENTS is the contents of the object."
2269 "Search for the next text-markup object.
2271 LIMIT bounds the search.
2273 Return value is a cons cell whose CAR is a symbol among `bold',
2274 `italic', `underline', `strike-through', `code' and `verbatim'
2275 and CDR is beginning position."
2291 ;;;; Code
2294 "Parse code object at point.
2296 Return a list whose CAR is `code' and CDR is a plist with
2297 `:value', `:begin', `:end' and `:post-blank' keywords.
2299 Assume point is at the first tilde marker."
2310 :begin begin
2311 :end end
2315 "Interpret CODE object as Org syntax.
2316 CONTENTS is nil."
2320 ;;;; Entity
2323 "Parse entity at point.
2325 Return a list whose CAR is `entity' and CDR a plist with
2326 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2327 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2328 keywords.
2330 Assume point is at the beginning of the entity."
2332 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2348 :begin begin
2349 :end end
2350 :use-brackets-p bracketsp
2354 "Interpret ENTITY object as Org syntax.
2355 CONTENTS is nil."
2361 "Search for the next latex-fragment or entity object.
2363 LIMIT bounds the search.
2365 Return value is a cons cell whose CAR is `entity' or
2366 `latex-fragment' and CDR is beginning position."
2370 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2377 limit t)
2380 ;; Determine if it's a real entity or a LaTeX command.
2383 ;; No entity nor command: point is at a LaTeX fragment.
2384 ;; Determine its type to get the correct beginning position.
2392 matchers)
2396 ;;;; Export Snippet
2399 "Parse export snippet at point.
2401 Return a list whose CAR is `export-snippet' and CDR a plist with
2402 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2403 keywords.
2405 Assume point is at the beginning of the snippet."
2417 :value value
2418 :begin begin
2419 :end end
2423 "Interpret EXPORT-SNIPPET object as Org syntax.
2424 CONTENTS is nil."
2430 "Search for the next export-snippet object.
2432 LIMIT bounds the search.
2434 Return value is a cons cell whose CAR is `export-snippet' and CDR
2435 its beginning position."
2444 ;;;; Footnote Reference
2447 "Parse footnote reference at point.
2449 Return a list whose CAR is `footnote-reference' and CDR a plist
2450 with `:label', `:type', `:inline-definition', `:begin', `:end'
2451 and `:post-blank' as keywords."
2473 :type type
2474 :begin begin
2475 :end end
2478 footnote-reference :inline-definition
2483 footnote-reference))))))
2486 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2487 CONTENTS is nil."
2497 "Search for the next footnote-reference object.
2499 LIMIT bounds the search.
2501 Return value is a cons cell whose CAR is `footnote-reference' and
2502 CDR is beginning position."
2516 ;;;; Inline Babel Call
2519 "Parse inline babel call at point.
2521 Return a list whose CAR is `inline-babel-call' and CDR a plist
2522 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2524 Assume point is at the beginning of the babel call."
2535 :end end
2536 :info info
2540 "Interpret INLINE-BABEL-CALL object as Org syntax.
2541 CONTENTS is nil."
2547 ;; Remove redundant square brackets.
2550 main-source)
2554 "Search for the next inline-babel-call object.
2556 LIMIT bounds the search.
2558 Return value is a cons cell whose CAR is `inline-babel-call' and
2559 CDR is beginning position."
2561 ;; Use a simplified version of
2562 ;; `org-babel-inline-lob-one-liner-regexp'.
2565 limit t)
2569 ;;;; Inline Src Block
2572 "Parse inline source block at point.
2574 LIMIT bounds the search.
2576 Return a list whose CAR is `inline-src-block' and CDR a plist
2577 with `:begin', `:end', `:language', `:value', `:parameters' and
2578 `:post-blank' as keywords.
2580 Assume point is at the beginning of the inline src block."
2593 :value value
2594 :parameters parameters
2595 :begin begin
2596 :end end
2600 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2601 CONTENTS is nil."
2606 language
2608 body)))
2611 "Search for the next inline-babel-call element.
2613 LIMIT bounds the search.
2615 Return value is a cons cell whose CAR is `inline-babel-call' and
2616 CDR is beginning position."
2621 ;;;; Italic
2624 "Parse italic object at point.
2626 Return a list whose CAR is `italic' and CDR is a plist with
2627 `:begin', `:end', `:contents-begin' and `:contents-end' and
2628 `:post-blank' keywords.
2630 Assume point is at the first slash marker."
2642 :end end
2643 :contents-begin contents-begin
2644 :contents-end contents-end
2648 "Interpret ITALIC object as Org syntax.
2649 CONTENTS is the contents of the object."
2653 ;;;; Latex Fragment
2656 "Parse latex fragment at point.
2658 Return a list whose CAR is `latex-fragment' and CDR a plist with
2659 `:value', `:begin', `:end', and `:post-blank' as keywords.
2661 Assume point is at the beginning of the latex fragment."
2675 ;; None found: it's a macro.
2684 :begin begin
2685 :end end
2689 "Interpret LATEX-FRAGMENT object as Org syntax.
2690 CONTENTS is nil."
2693 ;;;; Line Break
2696 "Parse line break at point.
2698 Return a list whose CAR is `line-break', and CDR a plist with
2699 `:begin', `:end' and `:post-blank' keywords.
2701 Assume point is at the beginning of the line break."
2705 "Interpret LINE-BREAK object as Org syntax.
2706 CONTENTS is nil."
2710 "Search for the next line-break object.
2712 LIMIT bounds the search.
2714 Return value is a cons cell whose CAR is `line-break' and CDR is
2715 beginning position."
2719 ;; A line break can only happen on a non-empty line.
2724 ;;;; Link
2727 "Parse link at point.
2729 Return a list whose CAR is `link' and CDR a plist with `:type',
2730 `:path', `:raw-link', `:application', `:search-option', `:begin',
2731 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2732 keywords.
2734 Assume point is at the beginning of the link."
2737 end contents-begin contents-end link-end post-blank path type
2738 raw-link link search-option application)
2740 ;; Type 1: Text targeted from a radio target.
2745 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2750 ;; RAW-LINK is the original link.
2755 ;; Determine TYPE of link and set PATH accordingly.
2757 ;; File type.
2760 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2763 ;; Id type: PATH is the id.
2766 ;; Code-ref type: PATH is the name of the reference.
2769 ;; Custom-id type: PATH is the name of the custom id.
2772 ;; Fuzzy type: Internal link either matches a target, an
2773 ;; headline name or nothing. PATH is the target or
2774 ;; headline's name.
2776 ;; Type 3: Plain link, i.e. http://orgmode.org
2782 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2789 ;; In any case, deduce end point after trailing white space from
2790 ;; LINK-END variable.
2793 ;; Extract search option and opening application out of
2794 ;; "file"-type links.
2796 ;; Application.
2801 ;; Extract search option from PATH.
2805 ;; Make sure TYPE always report "file".
2809 :path path
2811 :application application
2812 :search-option search-option
2813 :begin begin
2814 :end end
2815 :contents-begin contents-begin
2816 :contents-end contents-end
2820 "Interpret LINK object as Org syntax.
2821 CONTENTS is the contents of the object, or nil."
2826 raw-link
2830 "Search for the next link object.
2832 LIMIT bounds the search.
2834 Return value is a cons cell whose CAR is `link' and CDR is
2835 beginning position."
2844 ;;;; Macro
2847 "Parse macro at point.
2849 Return a list whose CAR is `macro' and CDR a plist with `:key',
2850 `:args', `:begin', `:end', `:value' and `:post-blank' as
2851 keywords.
2853 Assume point is at the macro."
2867 ;; Repair bad splits.
2875 :value value
2876 :args args
2877 :begin begin
2878 :end end
2882 "Interpret MACRO object as Org syntax.
2883 CONTENTS is nil."
2887 "Search for the next macro object.
2889 LIMIT bounds the search.
2891 Return value is cons cell whose CAR is `macro' and CDR is
2892 beginning position."
2896 limit t)
2900 ;;;; Radio-target
2903 "Parse radio target at point.
2905 Return a list whose CAR is `radio-target' and CDR a plist with
2906 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2907 and `:post-blank' as keywords.
2909 Assume point is at the radio target."
2921 :end end
2922 :contents-begin contents-begin
2923 :contents-end contents-end
2924 :post-blank post-blank
2928 "Interpret TARGET object as Org syntax.
2929 CONTENTS is the contents of the object."
2933 "Search for the next radio-target object.
2935 LIMIT bounds the search.
2937 Return value is a cons cell whose CAR is `radio-target' and CDR
2938 is beginning position."
2944 ;;;; Statistics Cookie
2947 "Parse statistics cookie at point.
2949 Return a list whose CAR is `statistics-cookie', and CDR a plist
2950 with `:begin', `:end', `:value' and `:post-blank' keywords.
2952 Assume point is at the beginning of the statistics-cookie."
2963 :end end
2964 :value value
2968 "Interpret STATISTICS-COOKIE object as Org syntax.
2969 CONTENTS is nil."
2973 "Search for the next statistics cookie object.
2975 LIMIT bounds the search.
2977 Return value is a cons cell whose CAR is `statistics-cookie' and
2978 CDR is beginning position."
2984 ;;;; Strike-Through
2987 "Parse strike-through object at point.
2989 Return a list whose CAR is `strike-through' and CDR is a plist
2990 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2991 `:post-blank' keywords.
2993 Assume point is at the first plus sign marker."
3005 :end end
3006 :contents-begin contents-begin
3007 :contents-end contents-end
3011 "Interpret STRIKE-THROUGH object as Org syntax.
3012 CONTENTS is the contents of the object."
3016 ;;;; Subscript
3019 "Parse subscript at point.
3021 Return a list whose CAR is `subscript' and CDR a plist with
3022 `:begin', `:end', `:contents-begin', `:contents-end',
3023 `:use-brackets-p' and `:post-blank' as keywords.
3025 Assume point is at the underscore."
3029 t
3040 :end end
3041 :use-brackets-p bracketsp
3042 :contents-begin contents-begin
3043 :contents-end contents-end
3047 "Interpret SUBSCRIPT object as Org syntax.
3048 CONTENTS is the contents of the object."
3051 contents))
3054 "Search for the next sub/superscript object.
3056 LIMIT bounds the search.
3058 Return value is a cons cell whose CAR is either `subscript' or
3059 `superscript' and CDR is beginning position."
3066 ;;;; Superscript
3069 "Parse superscript at point.
3071 Return a list whose CAR is `superscript' and CDR a plist with
3072 `:begin', `:end', `:contents-begin', `:contents-end',
3073 `:use-brackets-p' and `:post-blank' as keywords.
3075 Assume point is at the caret."
3089 :end end
3090 :use-brackets-p bracketsp
3091 :contents-begin contents-begin
3092 :contents-end contents-end
3096 "Interpret SUPERSCRIPT object as Org syntax.
3097 CONTENTS is the contents of the object."
3100 contents))
3103 ;;;; Table Cell
3106 "Parse table cell at point.
3108 Return a list whose CAR is `table-cell' and CDR is a plist
3109 containing `:begin', `:end', `:contents-begin', `:contents-end'
3110 and `:post-blank' keywords."
3118 :end end
3119 :contents-begin contents-begin
3120 :contents-end contents-end
3124 "Interpret TABLE-CELL element as Org syntax.
3125 CONTENTS is the contents of the cell, or nil."
3129 "Search for the next table-cell object.
3131 LIMIT bounds the search.
3133 Return value is a cons cell whose CAR is `table-cell' and CDR is
3134 beginning position."
3138 ;;;; Target
3141 "Parse target at point.
3143 Return a list whose CAR is `target' and CDR a plist with
3144 `:begin', `:end', `:value' and `:post-blank' as keywords.
3146 Assume point is at the target."
3156 :end end
3157 :value value
3161 "Interpret TARGET object as Org syntax.
3162 CONTENTS is nil."
3166 "Search for the next target object.
3168 LIMIT bounds the search.
3170 Return value is a cons cell whose CAR is `target' and CDR is
3171 beginning position."
3177 ;;;; Timestamp
3180 "Parse time stamp at point.
3182 Return a list whose CAR is `timestamp', and CDR a plist with
3183 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3185 Assume point is at the beginning of the timestamp."
3204 :value main-value
3205 :range-end range-end
3206 :begin begin
3207 :end end
3211 "Interpret TIMESTAMP object as Org syntax.
3212 CONTENTS is nil."
3221 range-end)))))))
3224 "Search for the next timestamp object.
3226 LIMIT bounds the search.
3228 Return value is a cons cell whose CAR is `timestamp' and CDR is
3229 beginning position."
3237 limit t)
3241 ;;;; Underline
3244 "Parse underline object at point.
3246 Return a list whose CAR is `underline' and CDR is a plist with
3247 `:begin', `:end', `:contents-begin' and `:contents-end' and
3248 `:post-blank' keywords.
3250 Assume point is at the first underscore marker."
3262 :end end
3263 :contents-begin contents-begin
3264 :contents-end contents-end
3268 "Interpret UNDERLINE object as Org syntax.
3269 CONTENTS is the contents of the object."
3273 ;;;; Verbatim
3276 "Parse verbatim object at point.
3278 Return a list whose CAR is `verbatim' and CDR is a plist with
3279 `:value', `:begin', `:end' and `:post-blank' keywords.
3281 Assume point is at the first equal sign marker."
3292 :begin begin
3293 :end end
3297 "Interpret VERBATIM object as Org syntax.
3298 CONTENTS is nil."
3302 \f
3303 ;;; Parsing Element Starting At Point
3304 ;;
3305 ;; `org-element--current-element' is the core function of this section.
3306 ;; It returns the Lisp representation of the element starting at
3307 ;; point.
3308 ;;
3309 ;; `org-element--current-element' makes use of special modes. They
3310 ;; are activated for fixed element chaining (i.e. `plain-list' >
3311 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3312 ;; `section'). Special modes are: `first-section', `section',
3313 ;; `quote-section', `item' and `table-row'.
3317 "Parse the element starting at point.
3319 LIMIT bounds the search.
3321 Return value is a list like (TYPE PROPS) where TYPE is the type
3322 of the element and PROPS a plist of properties associated to the
3323 element.
3325 Possible types are defined in `org-element-all-elements'.
3327 Optional argument GRANULARITY determines the depth of the
3328 recursion. Allowed values are `headline', `greater-element',
3329 `element', `object' or nil. When it is broader than `object' (or
3330 nil), secondary values will not be parsed, since they only
3331 contain objects.
3333 Optional argument SPECIAL, when non-nil, can be either
3334 `first-section', `section', `quote-section', `table-row' and
3335 `item'.
3337 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3338 be computed.
3340 This function assumes point is always at the beginning of the
3341 element it has to parse."
3343 ;; If point is at an affiliated keyword, try moving to the
3344 ;; beginning of the associated element. If none is found, the
3345 ;; keyword is orphaned and will be treated as plain text.
3351 ;; Determine if parsing depth allows for secondary strings
3352 ;; parsing. It only applies to elements referenced in
3353 ;; `org-element-secondary-value-alist'.
3356 ;; Item.
3359 ;; Quote Section.
3361 ;; Table Row.
3363 ;; Headline.
3366 ;; Section (must be checked after headline).
3371 limit)))
3372 ;; Planning and Clock.
3377 ;; Inlinetask.
3380 ;; LaTeX Environment.
3386 nil t))
3389 ;; Drawer and Property Drawer.
3399 ;; Fixed Width
3402 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3403 ;; Keywords.
3412 org-element-block-name-alist)))
3427 ;; Footnote Definition.
3430 ;; Horizontal Rule.
3433 ;; Table.
3435 ;; List.
3438 ;; Default element: Paragraph.
3442 ;; Most elements can have affiliated keywords. When looking for an
3443 ;; element beginning, we want to move before them, as they belong to
3444 ;; that element, and, in the meantime, collect information they give
3445 ;; into appropriate properties. Hence the following function.
3446 ;;
3447 ;; Usage of optional arguments may not be obvious at first glance:
3448 ;;
3449 ;; - TRANS-LIST is used to polish keywords names that have evolved
3450 ;; during Org history. In example, even though =result= and
3451 ;; =results= coexist, we want to have them under the same =result=
3452 ;; property. It's also true for "srcname" and "name", where the
3453 ;; latter seems to be preferred nowadays (thus the "name" property).
3454 ;;
3455 ;; - CONSED allows to regroup multi-lines keywords under the same
3456 ;; property, while preserving their own identity. This is mostly
3457 ;; used for "attr_latex" and al.
3458 ;;
3459 ;; - PARSED prepares a keyword value for export. This is useful for
3460 ;; "caption". Objects restrictions for such keywords are defined in
3461 ;; `org-element-object-restrictions'.
3462 ;;
3463 ;; - DUALS is used to take care of keywords accepting a main and an
3464 ;; optional secondary values. For example "results" has its
3465 ;; source's name as the main value, and may have an hash string in
3466 ;; optional square brackets as the secondary one.
3467 ;;
3468 ;; A keyword may belong to more than one category.
3472 "Collect affiliated keywords before point.
3474 Optional argument KEY-RE is a regexp matching keywords, which
3475 puts matched keyword in group 1. It defaults to
3476 `org-element--affiliated-re'.
3478 TRANS-LIST is an alist where key is the keyword and value the
3479 property name it should be translated to, without the colons. It
3480 defaults to `org-element-keyword-translation-alist'.
3482 CONSED is a list of strings. Any keyword belonging to that list
3483 will have its value consed. The check is done after keyword
3484 translation. It defaults to `org-element-multiple-keywords'.
3486 PARSED is a list of strings. Any keyword member of this list
3487 will have its value parsed. The check is done after keyword
3488 translation. If a keyword is a member of both CONSED and PARSED,
3489 it's value will be a list of parsed strings. It defaults to
3490 `org-element-parsed-keywords'.
3492 DUALS is a list of strings. Any keyword member of this list can
3493 have two parts: one mandatory and one optional. Its value is
3494 a cons cell whose CAR is the former, and the CDR the latter. If
3495 a keyword is a member of both PARSED and DUALS, both values will
3496 be parsed. It defaults to `org-element-dual-keywords'.
3498 Return a list whose CAR is the position at the first of them and
3499 CDR a plist of keywords and values."
3507 ;; RESTRICT is the list of objects allowed in parsed
3508 ;; keywords value.
3510 output)
3514 ;; Apply translation to RAW-KWD. From there, KWD is
3515 ;; the official keyword.
3517 ;; Find main value for any keyword.
3523 ;; If KWD is a dual keyword, find its secondary
3524 ;; value. Maybe parse it.
3530 ;; Attribute a property name to KWD.
3532 ;; Now set final shape for VALUE.
3536 ;; VALUE is mandatory. Set it to nil if there is none.
3538 ;; Attributes are always consed.
3541 ;; Eventually store the new value in OUTPUT.
3547 \f
3548 ;;; The Org Parser
3549 ;;
3550 ;; The two major functions here are `org-element-parse-buffer', which
3551 ;; parses Org syntax inside the current buffer, taking into account
3552 ;; region, narrowing, or even visibility if specified, and
3553 ;; `org-element-parse-secondary-string', which parses objects within
3554 ;; a given string.
3555 ;;
3556 ;; The (almost) almighty `org-element-map' allows to apply a function
3557 ;; on elements or objects matching some type, and accumulate the
3558 ;; resulting values. In an export situation, it also skips unneeded
3559 ;; parts of the parse tree.
3562 "Recursively parse the buffer and return structure.
3563 If narrowing is in effect, only parse the visible part of the
3564 buffer.
3566 Optional argument GRANULARITY determines the depth of the
3567 recursion. It can be set to the following symbols:
3569 `headline' Only parse headlines.
3570 `greater-element' Don't recurse into greater elements excepted
3571 headlines and sections. Thus, elements
3572 parsed are the top-level ones.
3573 `element' Parse everything but objects and plain text.
3574 `object' Parse the complete buffer (default).
3576 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3577 elements.
3579 Assume buffer is in Org mode."
3585 ;; Start in `first-section' mode so text before the first
3586 ;; headline belongs to a section.
3590 "Recursively parse objects in STRING and return structure.
3592 RESTRICTION is a symbol limiting the object types that will be
3593 looked after.
3595 Optional argument PARENT, when non-nil, is the element or object
3596 containing the secondary string. It is used to set correctly
3597 `:parent' property within the string."
3603 secondary))))
3606 "Map a function on selected elements or objects.
3608 DATA is the parsed tree, as returned by, i.e,
3609 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3610 of elements or objects types. FUN is the function called on the
3611 matching element or object. It must accept one arguments: the
3612 element or object itself.
3614 When optional argument INFO is non-nil, it should be a plist
3615 holding export options. In that case, parts of the parse tree
3616 not exportable according to that property list will be skipped.
3618 When optional argument FIRST-MATCH is non-nil, stop at the first
3619 match for which FUN doesn't return nil, and return that value.
3621 Optional argument NO-RECURSION is a symbol or a list of symbols
3622 representing elements or objects types. `org-element-map' won't
3623 enter any recursive element or object whose type belongs to that
3624 list. Though, FUN can still be applied on them.
3626 Nil values returned from FUN do not appear in the results."
3627 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3630 ;; Recursion depth is determined by --CATEGORY.
3637 ;; If one object is found, the function
3638 ;; has to recurse into every object.
3641 ;; If one regular element is found, the
3642 ;; function has to recurse, at least,
3643 ;; into every element it encounters.
3646 types)
3647 category)))
3648 --acc
3649 --walk-tree
3653 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3654 ;; holding contextual information.
3658 ;; Ignored element in an export context.
3660 ;; Secondary string: only objects can be found there.
3663 ;; Unconditionally enter parse trees.
3667 ;; Check if TYPE is matching among TYPES. If so,
3668 ;; apply FUN to --DATA and accumulate return value
3669 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3675 ;; If --DATA has a secondary string that can contain
3676 ;; objects with their type among TYPES, look into it.
3683 ;; Determine if a recursion into --DATA is possible.
3685 ;; --TYPE is explicitly removed from recursion.
3687 ;; --DATA has no contents.
3689 ;; Looking for greater elements but --DATA is simply
3690 ;; an element or an object.
3693 ;; Looking for elements but --DATA is an object.
3696 ;; In any other case, map contents.
3700 ;; Return value in a proper order.
3703 ;; The following functions are internal parts of the parser.
3704 ;;
3705 ;; The first one, `org-element--parse-elements' acts at the element's
3706 ;; level.
3707 ;;
3708 ;; The second one, `org-element--parse-objects' applies on all objects
3709 ;; of a paragraph or a secondary string. It uses
3710 ;; `org-element--get-next-object-candidates' to optimize the search of
3711 ;; the next object in the buffer.
3712 ;;
3713 ;; More precisely, that function looks for every allowed object type
3714 ;; first. Then, it discards failed searches, keeps further matches,
3715 ;; and searches again types matched behind point, for subsequent
3716 ;; calls. Thus, searching for a given type fails only once, and every
3717 ;; object is searched only once at top level (but sometimes more for
3718 ;; nested types).
3722 "Parse elements between BEG and END positions.
3724 SPECIAL prioritize some elements over the others. It can be set
3725 to `first-section', `quote-section', `section' `item' or
3726 `table-row'.
3728 When value is `item', STRUCTURE will be used as the current list
3729 structure.
3731 GRANULARITY determines the depth of the recursion. See
3732 `org-element-parse-buffer' for more information.
3734 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3735 elements.
3737 Elements are accumulated into ACC."
3740 ;; When parsing only headlines, skip any text before first one.
3743 ;; Main loop start.
3745 ;; Find current element's type and parse it accordingly to
3746 ;; its category.
3748 end granularity special structure))
3752 ;; Fill ELEMENT contents by side-effect.
3754 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3755 ;; no contents, don't modify it.
3758 ;; Greater element: parse it between `contents-begin' and
3759 ;; `contents-end'. Make sure GRANULARITY allows the
3760 ;; recursion, or ELEMENT is an headline, in which case going
3761 ;; inside is mandatory, in order to get sub-level headings.
3769 ;; Possibly switch to a special mode.
3777 granularity visible-only element))
3778 ;; ELEMENT has contents. Parse objects inside, if
3779 ;; GRANULARITY allows it.
3785 ;; Return result.
3786 acc))
3789 "Parse objects between BEG and END and return recursive structure.
3791 Objects are accumulated in ACC.
3793 RESTRICTION is a list of object types which are allowed in the
3794 current object."
3800 end restriction candidates)))
3807 ;; 1. Text before any object. Untabify it.
3812 acc
3816 ;; 2. Object...
3819 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3820 ;; a recursive type.
3825 cont-beg
3832 ;; 3. Text after last object. Untabify it.
3836 acc
3840 ;; Result.
3841 acc)))
3844 "Return an alist of candidates for the next object.
3846 LIMIT bounds the search, and RESTRICTION narrows candidates to
3847 some object types.
3849 Return value is an alist whose CAR is position and CDR the object
3850 type, as a symbol.
3852 OBJECTS is the previous candidates alist."
3854 ;; If no previous result, search every object type in RESTRICTION.
3855 ;; Otherwise, keep potential candidates (old objects located after
3856 ;; point) and ask to search again those which had matched before.
3861 objects))
3862 ;; Call the appropriate successor function for each type to search
3863 ;; and accumulate matches.
3870 type))))
3873 types-to-search)
3874 ;; Return alist.
3875 next-candidates))
3878 \f
3879 ;;; Towards A Bijective Process
3880 ;;
3881 ;; The parse tree obtained with `org-element-parse-buffer' is really
3882 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3883 ;; interpreted and expanded into a string with canonical Org syntax.
3884 ;; Hence `org-element-interpret-data'.
3885 ;;
3886 ;; The function relies internally on
3887 ;; `org-element--interpret-affiliated-keywords'.
3889 ;;;###autoload
3891 "Interpret DATA as Org syntax.
3893 DATA is a parse tree, an element, an object or a secondary string
3894 to interpret.
3896 Optional argument PARENT is used for recursive calls. It contains
3897 the element or object containing data, or nil.
3899 Return Org syntax as a string."
3903 ;; Secondary string.
3908 ;; Full Org document.
3913 ;; Plain text.
3915 ;; Element/Object without contents.
3918 data nil))
3919 ;; Element/Object with contents.
3929 ;; Elements directly containing objects must
3930 ;; have their indentation normalized first.
3932 data
3933 ;; When normalizing first paragraph of an
3934 ;; item or a footnote-definition, ignore
3935 ;; first line's indentation.
3942 data
3944 contents)))))))
3946 ;; Build white spaces. If no `:post-blank' property is
3947 ;; specified, assume its value is 0.
3957 "Return ELEMENT's affiliated keywords as Org syntax.
3958 If there is no affiliated keyword, return the empty string."
3968 ": "
3971 value)
3979 ;; All attribute keywords can have multiple lines.
3982 value
3985 ;; List all ELEMENT's properties matching an attribute line or an
3986 ;; affiliated keyword, but ignore translated keywords since they
3987 ;; cannot belong to the property list.
3994 org-element-keyword-translation-alist)))))
3995 collect prop)
3998 ;; Because interpretation of the parse tree must return the same
3999 ;; number of blank lines between elements and the same number of white
4000 ;; space after objects, some special care must be given to white
4001 ;; spaces.
4002 ;;
4003 ;; The first function, `org-element-normalize-string', ensures any
4004 ;; string different from the empty string will end with a single
4005 ;; newline character.
4006 ;;
4007 ;; The second function, `org-element-normalize-contents', removes
4008 ;; global indentation from the contents of the current element.
4011 "Ensure string S ends with a single newline character.
4013 If S isn't a string return it unchanged. If S is the empty
4014 string, return it. Otherwise, return a new string with a single
4015 newline character at its end."
4023 "Normalize plain text in ELEMENT's contents.
4025 ELEMENT must only contain plain text and objects.
4027 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4028 indentation to compute maximal common indentation.
4030 Return the normalized element that is element with global
4031 indentation removed from its contents. The function assumes that
4032 indentation is not done with TAB characters."
4034 collect-inds ; for byte-compiler
4037 ;; Return list of indentations within BLOB. This is done by
4038 ;; walking recursively BLOB and updating IND-LIST along the
4039 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4040 ;; been seen yet. It is required as this string is the only
4041 ;; one whose indentation doesn't happen after a newline
4042 ;; character.
4050 ;; An indentation of zero means no string will be
4051 ;; modified. Quit the process.
4057 ;; Avoid matching blank or empty lines.
4065 ;; Collect indentation list in ELEMENT. Possibly remove first
4066 ;; value if IGNORE-FIRST is non-nil.
4069 ;; Build ELEMENT back, replacing each string with the same
4070 ;; string minus common indentation.
4075 ;; Return BLOB with all its strings indentation
4076 ;; shortened from MCI white spaces. FIRST-FLAG is
4077 ;; non-nil when the first string hasn't been seen
4078 ;; yet.
4092 org-element-recursive-objects)
4096 blob))))
4100 \f
4101 ;;; The Toolbox
4102 ;;
4103 ;; The first move is to implement a way to obtain the smallest element
4104 ;; containing point. This is the job of `org-element-at-point'. It
4105 ;; basically jumps back to the beginning of section containing point
4106 ;; and moves, element after element, with
4107 ;; `org-element--current-element' until the container is found. Note:
4108 ;; When using `org-element-at-point', secondary values are never
4109 ;; parsed since the function focuses on elements, not on objects.
4110 ;;
4111 ;; At a deeper level, `org-element-context' lists all elements and
4112 ;; objects containing point.
4113 ;;
4114 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4115 ;; internally by navigation and manipulation tools.
4117 ;;;###autoload
4119 "Determine closest element around point.
4121 Return value is a list like (TYPE PROPS) where TYPE is the type
4122 of the element and PROPS a plist of properties associated to the
4123 element.
4125 Possible types are defined in `org-element-all-elements'.
4126 Properties depend on element or object type, but always
4127 include :begin, :end, :parent and :post-blank properties.
4129 As a special case, if point is at the very beginning of a list or
4130 sub-list, returned element will be that list instead of the first
4131 item. In the same way, if point is at the beginning of the first
4132 row of a table, returned element will be the table instead of the
4133 first row.
4135 If optional argument KEEP-TRAIL is non-nil, the function returns
4136 a list of of elements leading to element at point. The list's
4137 CAR is always the element at point. Following positions contain
4138 element's siblings, then parents, siblings of parents, until the
4139 first element of current section."
4141 ;; If at an headline, parse it. It is the sole element that
4142 ;; doesn't require to know about context. Be sure to disallow
4143 ;; secondary string parsing, though.
4149 ;; Otherwise move at the beginning of the section containing
4150 ;; point.
4154 element type special-flag trail struct prevs parent)
4162 ;; Parse successively each element, skipping those ending
4163 ;; before original position.
4172 ;; 1. Skip any element ending before point. Also skip
4173 ;; element ending at point when we're sure that another
4174 ;; element has started.
4179 ;; 2. An element containing point is always the element at
4180 ;; point.
4183 ;; 3. At any other greater element type, if point is
4184 ;; within contents, move into it.
4189 ;; Create an anchor for tables and plain lists:
4190 ;; when point is at the very beginning of these
4191 ;; elements, ignoring affiliated keywords,
4192 ;; target them instead of their contents.
4194 ;; When point is at contents end, do not move
4195 ;; into elements with an explicit ending, but
4196 ;; return that element instead.
4200 drawer dynamic-block inlinetask item
4201 plain-list quote-block special-block))))
4213 ;;;###autoload
4215 "Return closest element or object around point.
4217 Return value is a list like (TYPE PROPS) where TYPE is the type
4218 of the element or object and PROPS a plist of properties
4219 associated to it.
4221 Possible types are defined in `org-element-all-elements' and
4222 `org-element-all-objects'. Properties depend on element or
4223 object type, but always include :begin, :end, :parent
4224 and :post-blank properties."
4229 end)
4230 ;; Check if point is inside an element containing objects or at
4231 ;; a secondary string. In that case, move to beginning of the
4232 ;; element or secondary string and set END to the other side.
4241 (<= origin
4242 ;; `1+' is required so some
4243 ;; successors can match
4244 ;; properly their object.
4258 element
4261 candidates)
4264 end restriction candidates))
4266 candidates)))
4267 ;; If ORIGIN is before next object in element, there's
4268 ;; no point in looking further.
4277 ;; ORIGIN is after OBJECT, so skip it.
4280 ;; ORIGIN is within a non-recursive object or at an
4281 ;; object boundaries: Return that object.
4285 ;; Otherwise, move within current object and restrict
4286 ;; search to the end of its contents.
4290 parent))))))
4293 "Non-nil when elements ELEM-A and ELEM-B are nested."
4302 "Swap elements ELEM-A and ELEM-B.
4303 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4304 end of ELEM-A."
4306 ;; There are two special cases when an element doesn't start at bol:
4307 ;; the first paragraph in an item or in a footnote definition.
4309 ;; Only a paragraph without any affiliated keyword can be moved at
4310 ;; ELEM-A position in such a situation. Note that the case of
4311 ;; a footnote definition is impossible: it cannot contain two
4312 ;; paragraphs in a row because it cannot contain a blank line.
4318 ;; In a special situation, ELEM-A will have no indentation. We'll
4319 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4333 ;; Store overlays responsible for visibility status. We
4334 ;; also need to store their boundaries as they will be
4335 ;; removed from buffer.
4342 ;; Get contents.
4350 ;; Restore ex ELEM-A overlays.
4359 ;; Restore ex ELEM-B overlays.
4368 ;;; org-element.el ends here