| blob | 2fef7b6b6b246b053d80f3e12dbc485d84d4ed15 |
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)
304 inline-src-block latex-or-entity line-break link macro
305 radio-target statistics-cookie sub/superscript target text-markup
306 timestamp)
309 latex-or-entity link radio-target sub/superscript target
310 text-markup timestamp)
321 latex-or-entity line-break link macro radio-target
323 "Alist of objects restrictions.
325 CAR is an element or object type containing objects and CDR is
326 a list of successors that will be called within an element or
327 object of such type.
329 For example, in a `radio-target' object, one can only find
330 entities, export snippets, latex-fragments, subscript and
331 superscript.
333 This alist also applies to secondary string. For example, an
334 `headline' type element doesn't directly contain objects, but
345 \f
346 ;;; Accessors and Setters
347 ;;
348 ;; Provide four accessors: `org-element-type', `org-element-property'
349 ;; `org-element-contents' and `org-element-restriction'.
350 ;;
351 ;; Setter functions allow to modify elements by side effect. There is
352 ;; `org-element-put-property', `org-element-set-contents',
353 ;; `org-element-set-element' and `org-element-adopt-element'. Note
354 ;; that `org-element-set-element' and `org-element-adopt-elements' are
355 ;; higher level functions since also update `:parent' property.
358 "Return type of ELEMENT.
360 The function returns the type of the element or object provided.
361 It can also return the following special value:
362 `plain-text' for a string
363 `org-data' for a complete document
364 nil in any other case."
370 "Extract the value from the PROPERTY of an ELEMENT."
374 "Extract contents from an ELEMENT."
378 "Return restriction associated to ELEMENT.
379 ELEMENT can be an element, an object or a symbol representing an
380 element or object type."
382 org-element-object-restrictions)))
385 "In ELEMENT set PROPERTY to VALUE.
386 Return modified element."
389 element)
392 "Set ELEMENT contents to CONTENTS.
393 Return modified element."
399 "Replace element or object OLD with element or object NEW.
400 The function takes care of setting `:parent' property for NEW."
401 ;; Since OLD is going to be changed into NEW by side-effect, first
402 ;; make sure that every element or object within NEW has OLD as
403 ;; parent.
406 ;; Transfer contents.
408 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
409 ;; with NEW's.
412 ;; Transfer type.
416 "Append elements to the contents of another element.
418 PARENT is an element or object. CHILDREN can be elements,
419 objects, or a strings.
421 The function takes care of setting `:parent' property for CHILD.
422 Return parent element."
424 ;; Link every child to PARENT.
428 children)
429 ;; Add CHILDREN at the end of PARENT contents.
431 parent
433 ;; Return modified PARENT element.
434 parent))
437 \f
438 ;;; Greater elements
439 ;;
440 ;; For each greater element type, we define a parser and an
441 ;; interpreter.
442 ;;
443 ;; A parser returns the element or object as the list described above.
444 ;; Most of them accepts no argument. Though, exceptions exist. Hence
445 ;; every element containing a secondary string (see
446 ;; `org-element-secondary-value-alist') will accept an optional
447 ;; argument to toggle parsing of that secondary string. Moreover,
448 ;; `item' parser requires current list's structure as its first
449 ;; element.
450 ;;
451 ;; An interpreter accepts two arguments: the list representation of
452 ;; the element or object, and its contents. The latter may be nil,
453 ;; depending on the element or object considered. It returns the
454 ;; appropriate Org syntax, as a string.
455 ;;
456 ;; Parsing functions must follow the naming convention:
457 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
458 ;; defined in `org-element-greater-elements'.
459 ;;
460 ;; Similarly, interpreting functions must follow the naming
461 ;; convention: org-element-TYPE-interpreter.
462 ;;
463 ;; With the exception of `headline' and `item' types, greater elements
464 ;; cannot contain other greater elements of their own type.
465 ;;
466 ;; Beside implementing a parser and an interpreter, adding a new
467 ;; greater element requires to tweak `org-element--current-element'.
468 ;; Moreover, the newly defined type must be added to both
469 ;; `org-element-all-elements' and `org-element-greater-elements'.
472 ;;;; Center Block
475 "Parse a center block.
477 LIMIT bounds the search.
479 Return a list whose CAR is `center-block' and CDR is a plist
480 containing `:begin', `:end', `:hiddenp', `:contents-begin',
481 `:contents-end' and `:post-blank' keywords.
483 Assume point is at the beginning of the block."
487 ;; Incomplete block: parse it as a paragraph.
492 ;; Empty blocks have no contents.
506 :end end
507 :hiddenp hidden
508 :contents-begin contents-begin
509 :contents-end contents-end
514 "Interpret CENTER-BLOCK element as Org syntax.
515 CONTENTS is the contents of the element."
519 ;;;; Drawer
522 "Parse a drawer.
524 LIMIT bounds the search.
526 Return a list whose CAR is `drawer' and CDR is a plist containing
527 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
528 `:contents-end' and `:post-blank' keywords.
530 Assume point is at beginning of drawer."
533 ;; Incomplete drawer: parse it as a paragraph.
542 ;; Empty drawers have no contents.
556 :end end
557 :drawer-name name
558 :hiddenp hidden
559 :contents-begin contents-begin
560 :contents-end contents-end
565 "Interpret DRAWER element as Org syntax.
566 CONTENTS is the contents of the element."
569 contents))
572 ;;;; Dynamic Block
575 "Parse a dynamic block.
577 LIMIT bounds the search.
579 Return a list whose CAR is `dynamic-block' and CDR is a plist
580 containing `:block-name', `:begin', `:end', `:hiddenp',
581 `:contents-begin', `:contents-end', `:arguments' and
582 `:post-blank' keywords.
584 Assume point is at beginning of dynamic block."
587 ;; Incomplete block: parse it as a paragraph.
596 ;; Empty blocks have no contents.
610 :end end
611 :block-name name
612 :arguments arguments
613 :hiddenp hidden
614 :contents-begin contents-begin
615 :contents-end contents-end
620 "Interpret DYNAMIC-BLOCK element as Org syntax.
621 CONTENTS is the contents of the element."
626 contents))
629 ;;;; Footnote Definition
632 "Parse a footnote definition.
634 LIMIT bounds the search.
636 Return a list whose CAR is `footnote-definition' and CDR is
637 a plist containing `:label', `:begin' `:end', `:contents-begin',
638 `:contents-end' and `:post-blank' keywords.
640 Assume point is at the beginning of the footnote definition."
665 :begin begin
666 :end end
667 :contents-begin contents-begin
668 :contents-end contents-end
673 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
674 CONTENTS is the contents of the footnote-definition."
676 " "
677 contents))
680 ;;;; Headline
683 "Parse an headline.
685 Return a list whose CAR is `headline' and CDR is a plist
686 containing `:raw-value', `:title', `:begin', `:end',
687 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
688 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
689 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
690 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
691 keywords.
693 The plist also contains any property set in the property drawer,
694 with its name in lowercase, the underscores replaced with hyphens
695 and colons at the beginning (i.e. `:custom-id').
697 When RAW-SECONDARY-P is non-nil, headline's title will not be
698 parsed as a secondary string, but as a plain string instead.
700 Assume point is at beginning of the headline."
719 ;; Normalize property names: ":SOME_PROP:" becomes
720 ;; ":some-prop".
732 plist))
750 ;; Clean RAW-VALUE from any quote or comment string.
755 ""
756 raw-value)))
757 ;; Clean TAGS from archive tag, if any.
763 :begin begin
764 :end end
765 :pre-blank
768 :hiddenp hidden
769 :contents-begin contents-begin
770 :contents-end contents-end
771 :level level
773 :tags tags
774 :todo-keyword todo
775 :todo-type todo-type
776 :scheduled scheduled
777 :deadline deadline
778 :timestamp timestamp
779 :clock clock
785 end)
786 :footnote-section-p footnote-section-p
787 :archivedp archivedp
788 :commentedp commentedp
790 standard-props))))
792 headline :title
798 "Interpret HEADLINE element as Org syntax.
799 CONTENTS is the contents of the element."
826 ;; Align tags.
834 ? )
835 tags))
839 tags))))
841 contents)))
844 ;;;; Inlinetask
847 "Parse an inline task.
849 Return a list whose CAR is `inlinetask' and CDR is a plist
850 containing `:title', `:begin', `:end', `:hiddenp',
851 `:contents-begin' and `:contents-end', `:level', `:priority',
852 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
853 `:scheduled', `:deadline', `:timestamp', `:clock' and
854 `: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."
875 ;; Normalize property names: ":SOME_PROP:" becomes
876 ;; ":some-prop".
888 plist))
912 :begin begin
913 :end end
914 :hiddenp hidden
915 :contents-begin contents-begin
916 :contents-end contents-end
919 :tags tags
920 :todo-keyword todo
921 :todo-type todo-type
922 :scheduled scheduled
923 :deadline deadline
924 :timestamp timestamp
925 :clock clock
927 standard-props
930 inlinetask :title
933 raw-value
935 inlinetask))))))
938 "Interpret INLINETASK element as Org syntax.
939 CONTENTS is the contents of inlinetask."
954 ;; Align tags.
962 ? )
963 tags))
967 tags))))
968 ;; Prefer degenerate inlinetasks when there are no
969 ;; contents.
972 contents
976 ;;;; Item
979 "Parse an item.
981 STRUCT is the structure of the plain list.
983 Return a list whose CAR is `item' and CDR is a plist containing
984 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
985 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
986 `:post-blank' keywords.
988 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
989 any, will not be parsed as a secondary string, but as a plain
990 string instead.
992 Assume point is at the beginning of the item."
1016 ;; Ignore tags in un-ordered lists: they are just
1017 ;; a part of item's body.
1023 ;; If first line isn't empty, contents really start
1024 ;; at the text after item's meta-data.
1035 :begin begin
1036 :end end
1037 ;; CONTENTS-BEGIN and CONTENTS-END may be
1038 ;; mixed up in the case of an empty item
1039 ;; separated from the next by a blank line.
1040 ;; Thus ensure the former is always the
1041 ;; smallest.
1044 :checkbox checkbox
1045 :counter counter
1046 :hiddenp hidden
1047 :structure struct
1050 item :tag
1058 "Interpret ITEM element as Org syntax.
1059 CONTENTS is the contents of the element."
1065 ;; Compute indentation.
1070 ;; Indent contents.
1072 bullet
1085 ;;;; Plain List
1088 "Parse a plain list.
1090 Optional argument STRUCTURE, when non-nil, is the structure of
1091 the plain list being parsed.
1093 Return a list whose CAR is `plain-list' and CDR is a plist
1094 containing `:type', `:begin', `:end', `:contents-begin' and
1095 `:contents-end', `:structure' and `:post-blank' keywords.
1097 Assume point is at the beginning of the list."
1112 ;; Return value.
1116 :begin begin
1117 :end end
1118 :contents-begin contents-begin
1119 :contents-end contents-end
1120 :structure struct
1125 "Interpret PLAIN-LIST element as Org syntax.
1126 CONTENTS is the contents of the element."
1134 ;;;; Quote Block
1137 "Parse a quote block.
1139 LIMIT bounds the search.
1141 Return a list whose CAR is `quote-block' and CDR is a plist
1142 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1143 `:contents-end' and `:post-blank' keywords.
1145 Assume point is at the beginning of the block."
1149 ;; Incomplete block: parse it as a paragraph.
1155 ;; Empty blocks have no contents.
1169 :end end
1170 :hiddenp hidden
1171 :contents-begin contents-begin
1172 :contents-end contents-end
1177 "Interpret QUOTE-BLOCK element as Org syntax.
1178 CONTENTS is the contents of the element."
1182 ;;;; Section
1185 "Parse a section.
1187 LIMIT bounds the search.
1189 Return a list whose CAR is `section' and CDR is a plist
1190 containing `:begin', `:end', `:contents-begin', `contents-end'
1191 and `:post-blank' keywords."
1193 ;; Beginning of section is the beginning of the first non-blank
1194 ;; line after previous headline.
1203 :end end
1204 :contents-begin begin
1205 :contents-end pos-before-blank
1209 "Interpret SECTION element as Org syntax.
1210 CONTENTS is the contents of the element."
1211 contents)
1214 ;;;; Special Block
1217 "Parse a special block.
1219 LIMIT bounds the search.
1221 Return a list whose CAR is `special-block' and CDR is a plist
1222 containing `:type', `:begin', `:end', `:hiddenp',
1223 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1225 Assume point is at the beginning of the block."
1231 ;; Incomplete block: parse it as a paragraph.
1237 ;; Empty blocks have no contents.
1251 :begin begin
1252 :end end
1253 :hiddenp hidden
1254 :contents-begin contents-begin
1255 :contents-end contents-end
1260 "Interpret SPECIAL-BLOCK element as Org syntax.
1261 CONTENTS is the contents of the element."
1266 \f
1267 ;;; Elements
1268 ;;
1269 ;; For each element, a parser and an interpreter are also defined.
1270 ;; Both follow the same naming convention used for greater elements.
1271 ;;
1272 ;; Also, as for greater elements, adding a new element type is done
1273 ;; through the following steps: implement a parser and an interpreter,
1274 ;; tweak `org-element--current-element' so that it recognizes the new
1275 ;; type and add that new type to `org-element-all-elements'.
1276 ;;
1277 ;; As a special case, when the newly defined type is a block type,
1278 ;; `org-element-block-name-alist' has to be modified accordingly.
1281 ;;;; Babel Call
1284 "Parse a babel call.
1286 LIMIT bounds the search.
1288 Return a list whose CAR is `babel-call' and CDR is a plist
1289 containing `:begin', `:end', `:info' and `:post-blank' as
1290 keywords."
1301 :end end
1302 :info info
1306 "Interpret BABEL-CALL element as Org syntax.
1307 CONTENTS is nil."
1313 ;; Remove redundant square brackets.
1318 ;;;; Clock
1321 "Parse a clock.
1323 LIMIT bounds the search.
1325 Return a list whose CAR is `clock' and CDR is a plist containing
1326 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1327 as keywords."
1346 :value value
1347 :time time
1348 :begin begin
1349 :end end
1353 "Interpret CLOCK element as Org syntax.
1354 CONTENTS is nil."
1361 "%2s:%02s"
1365 ;;;; Comment
1368 "Parse a comment.
1370 LIMIT bounds the search.
1372 Return a list whose CAR is `comment' and CDR is a plist
1373 containing `:begin', `:end', `:value' and `:post-blank'
1374 keywords.
1376 Assume point is at comment beginning."
1385 ;; Get comments ending.
1388 ;; Accumulate lines without leading hash and first
1389 ;; whitespace.
1403 :end end
1404 :value value
1409 "Interpret COMMENT element as Org syntax.
1410 CONTENTS is nil."
1414 ;;;; Comment Block
1417 "Parse an export block.
1419 LIMIT bounds the search.
1421 Return a list whose CAR is `comment-block' and CDR is a plist
1422 containing `:begin', `:end', `:hiddenp', `:value' and
1423 `:post-blank' keywords.
1425 Assume point is at comment block beginning."
1429 ;; Incomplete block: parse it as a paragraph.
1443 contents-begin contents-end)))
1447 :end end
1448 :value value
1449 :hiddenp hidden
1454 "Interpret COMMENT-BLOCK element as Org syntax.
1455 CONTENTS is nil."
1460 ;;;; Example Block
1463 "Parse an example block.
1465 LIMIT bounds the search.
1467 Return a list whose CAR is `example-block' and CDR is a plist
1468 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1469 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1470 `:switches', `:value' and `:post-blank' keywords."
1474 ;; Incomplete block: parse it as a paragraph.
1481 ;; Switches analysis
1486 ;; Should labels be retained in (or stripped from) example
1487 ;; blocks?
1492 ;; What should code-references use - labels or
1493 ;; line-numbers?
1500 ;; Standard block parsing.
1514 :end end
1515 :value value
1516 :switches switches
1517 :number-lines number-lines
1518 :preserve-indent preserve-indent
1519 :retain-labels retain-labels
1520 :use-labels use-labels
1521 :label-fmt label-fmt
1522 :hiddenp hidden
1527 "Interpret EXAMPLE-BLOCK element as Org syntax.
1528 CONTENTS is nil."
1536 ;;;; Export Block
1539 "Parse an export block.
1541 LIMIT bounds the search.
1543 Return a list whose CAR is `export-block' and CDR is a plist
1544 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1545 `:post-blank' keywords.
1547 Assume point is at export-block beginning."
1553 ;; Incomplete block: parse it as a paragraph.
1567 contents-end)))
1571 :end end
1572 :type type
1573 :value value
1574 :hiddenp hidden
1579 "Interpret EXPORT-BLOCK element as Org syntax.
1580 CONTENTS is nil."
1587 ;;;; Fixed-width
1590 "Parse a fixed-width section.
1592 LIMIT bounds the search.
1594 Return a list whose CAR is `fixed-width' and CDR is a plist
1595 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1597 Assume point is at the beginning of the fixed-width area."
1601 value
1606 ;; Accumulate text without starting colons.
1619 :end end
1620 :value value
1625 "Interpret FIXED-WIDTH element as Org syntax.
1626 CONTENTS is nil."
1631 ;;;; Horizontal Rule
1634 "Parse an horizontal rule.
1636 LIMIT bounds the search.
1638 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1639 containing `:begin', `:end' and `:post-blank' keywords."
1649 :end end
1654 "Interpret HORIZONTAL-RULE element as Org syntax.
1655 CONTENTS is nil."
1659 ;;;; Keyword
1662 "Parse a keyword at point.
1664 LIMIT bounds the search.
1666 Return a list whose CAR is `keyword' and CDR is a plist
1667 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1668 keywords."
1681 :value value
1682 :begin begin
1683 :end end
1687 "Interpret KEYWORD element as Org syntax.
1688 CONTENTS is nil."
1694 ;;;; Latex Environment
1697 "Parse a LaTeX environment.
1699 LIMIT bounds the search.
1701 Return a list whose CAR is `latex-environment' and CDR is a plist
1702 containing `:begin', `:end', `:value' and `:post-blank'
1703 keywords.
1705 Assume point is at the beginning of the latex environment."
1723 :end end
1724 :value value
1729 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1730 CONTENTS is nil."
1734 ;;;; Paragraph
1737 "Parse a paragraph.
1739 LIMIT bounds the search.
1741 Return a list whose CAR is `paragraph' and CDR is a plist
1742 containing `:begin', `:end', `:contents-begin' and
1743 `:contents-end' and `:post-blank' keywords.
1745 Assume point is at the beginning of the paragraph."
1748 ;; beginning of an item or a footnote reference. In that
1749 ;; case, we mustn't look for affiliated keywords since they
1750 ;; belong to the container.
1762 ;; Skip non-existent or incomplete drawer.
1770 ;; Stop at comments.
1774 ;; Skip incomplete dynamic blocks.
1781 ;; Skip incomplete blocks.
1789 limit t))))
1790 ;; Skip incomplete latex environments.
1798 limit t))))
1799 ;; Skip ill-formed keywords.
1813 :end end
1814 :contents-begin contents-begin
1815 :contents-end contents-end
1820 "Interpret PARAGRAPH element as Org syntax.
1821 CONTENTS is the contents of the element."
1822 contents)
1825 ;;;; Planning
1828 "Parse a planning.
1830 LIMIT bounds the search.
1832 Return a list whose CAR is `planning' and CDR is a plist
1833 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1834 and `:post-blank' keywords."
1843 closed deadline scheduled)
1857 :deadline deadline
1858 :scheduled scheduled
1859 :begin begin
1860 :end end
1864 "Interpret PLANNING element as Org syntax.
1865 CONTENTS is nil."
1867 'identity
1879 ;;;; Property Drawer
1882 "Parse a property drawer.
1884 LIMIT bounds the search.
1886 Return a list whose CAR is `property-drawer' and CDR is a plist
1887 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1888 `:contents-end', `:properties' and `:post-blank' keywords.
1890 Assume point is at the beginning of the property drawer."
1904 val))
1906 val))
1914 :end end
1915 :hiddenp hidden
1916 :properties properties
1920 "Interpret PROPERTY-DRAWER element as Org syntax.
1921 CONTENTS is nil."
1931 ;;;; Quote Section
1934 "Parse a quote section.
1936 LIMIT bounds the search.
1938 Return a list whose CAR is `quote-section' and CDR is a plist
1939 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1941 Assume point is at beginning of the section."
1952 :end end
1953 :value value
1957 "Interpret QUOTE-SECTION element as Org syntax.
1958 CONTENTS is nil."
1962 ;;;; Src Block
1965 "Parse a src block.
1967 LIMIT bounds the search.
1969 Return a list whose CAR is `src-block' and CDR is a plist
1970 containing `:language', `:switches', `:parameters', `:begin',
1971 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1972 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1973 `:post-blank' keywords.
1975 Assume point is at the beginning of the block."
1978 ;; Incomplete block: parse it as a paragraph.
1983 ;; Get beginning position.
1985 ;; Get language as a string.
1994 ;; Get switches.
1996 ;; Get parameters.
1998 ;; Switches analysis
2006 ;; Should labels be retained in (or stripped from)
2007 ;; src blocks?
2012 ;; What should code-references use - labels or
2013 ;; line-numbers?
2017 ;; Get visibility status.
2019 ;; Retrieve code.
2024 ;; Get position after ending blank lines.
2034 :begin begin
2035 :end end
2036 :number-lines number-lines
2037 :preserve-indent preserve-indent
2038 :retain-labels retain-labels
2039 :use-labels use-labels
2040 :label-fmt label-fmt
2041 :hiddenp hidden
2042 :value value
2047 "Interpret SRC-BLOCK element as Org syntax.
2048 CONTENTS is nil."
2068 value
2072 ;;;; Table
2075 "Parse a table at point.
2077 LIMIT bounds the search.
2079 Return a list whose CAR is `table' and CDR is a plist containing
2080 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2081 `:contents-end', `:value' and `:post-blank' keywords.
2083 Assume point is at the beginning of the table."
2095 acc))
2102 :end end
2103 :type type
2104 :tblfm tblfm
2105 ;; Only `org' tables have contents. `table.el' tables
2106 ;; use a `:value' property to store raw table as
2107 ;; a string.
2112 table-begin table-end))
2117 "Interpret TABLE element as Org syntax.
2118 CONTENTS is nil."
2129 ;;;; Table Row
2132 "Parse table row at point.
2134 LIMIT bounds the search.
2136 Return a list whose CAR is `table-row' and CDR is a plist
2137 containing `:begin', `:end', `:contents-begin', `:contents-end',
2138 `:type' and `:post-blank' keywords."
2142 ;; A table rule has no contents. In that case, ensure
2143 ;; CONTENTS-BEGIN matches CONTENTS-END.
2155 :begin begin
2156 :end end
2157 :contents-begin contents-begin
2158 :contents-end contents-end
2162 "Interpret TABLE-ROW element as Org syntax.
2163 CONTENTS is the contents of the table row."
2168 ;;;; Verse Block
2171 "Parse a verse block.
2173 LIMIT bounds the search.
2175 Return a list whose CAR is `verse-block' and CDR is a plist
2176 containing `:begin', `:end', `:contents-begin', `:contents-end',
2177 `:hiddenp' and `:post-blank' keywords.
2179 Assume point is at beginning of the block."
2183 ;; Incomplete block: parse it as a paragraph.
2199 :end end
2200 :contents-begin contents-begin
2201 :contents-end contents-end
2202 :hiddenp hidden
2207 "Interpret VERSE-BLOCK element as Org syntax.
2208 CONTENTS is verse block contents."
2212 \f
2213 ;;; Objects
2214 ;;
2215 ;; Unlike to elements, interstices can be found between objects.
2216 ;; That's why, along with the parser, successor functions are provided
2217 ;; for each object. Some objects share the same successor (i.e. `code'
2218 ;; and `verbatim' objects).
2219 ;;
2220 ;; A successor must accept a single argument bounding the search. It
2221 ;; will return either a cons cell whose CAR is the object's type, as
2222 ;; a symbol, and CDR the position of its next occurrence, or nil.
2223 ;;
2224 ;; Successors follow the naming convention:
2225 ;; org-element-NAME-successor, where NAME is the name of the
2226 ;; successor, as defined in `org-element-all-successors'.
2227 ;;
2228 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2229 ;; object types they can contain will be specified in
2230 ;; `org-element-object-restrictions'.
2231 ;;
2232 ;; Adding a new type of object is simple. Implement a successor,
2233 ;; a parser, and an interpreter for it, all following the naming
2234 ;; convention. Register type in `org-element-all-objects' and
2235 ;; successor in `org-element-all-successors'. Maybe tweak
2236 ;; restrictions about it, and that's it.
2239 ;;;; Bold
2242 "Parse bold object at point.
2244 Return a list whose CAR is `bold' and CDR is a plist with
2245 `:begin', `:end', `:contents-begin' and `:contents-end' and
2246 `:post-blank' keywords.
2248 Assume point is at the first star marker."
2260 :end end
2261 :contents-begin contents-begin
2262 :contents-end contents-end
2266 "Interpret BOLD object as Org syntax.
2267 CONTENTS is the contents of the object."
2271 "Search for the next text-markup object.
2273 LIMIT bounds the search.
2275 Return value is a cons cell whose CAR is a symbol among `bold',
2276 `italic', `underline', `strike-through', `code' and `verbatim'
2277 and CDR is beginning position."
2293 ;;;; Code
2296 "Parse code object at point.
2298 Return a list whose CAR is `code' and CDR is a plist with
2299 `:value', `:begin', `:end' and `:post-blank' keywords.
2301 Assume point is at the first tilde marker."
2312 :begin begin
2313 :end end
2317 "Interpret CODE object as Org syntax.
2318 CONTENTS is nil."
2322 ;;;; Entity
2325 "Parse entity at point.
2327 Return a list whose CAR is `entity' and CDR a plist with
2328 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2329 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2330 keywords.
2332 Assume point is at the beginning of the entity."
2334 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2350 :begin begin
2351 :end end
2352 :use-brackets-p bracketsp
2356 "Interpret ENTITY object as Org syntax.
2357 CONTENTS is nil."
2363 "Search for the next latex-fragment or entity object.
2365 LIMIT bounds the search.
2367 Return value is a cons cell whose CAR is `entity' or
2368 `latex-fragment' and CDR is beginning position."
2372 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2379 limit t)
2382 ;; Determine if it's a real entity or a LaTeX command.
2385 ;; No entity nor command: point is at a LaTeX fragment.
2386 ;; Determine its type to get the correct beginning position.
2394 matchers)
2398 ;;;; Export Snippet
2401 "Parse export snippet at point.
2403 Return a list whose CAR is `export-snippet' and CDR a plist with
2404 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2405 keywords.
2407 Assume point is at the beginning of the snippet."
2419 :value value
2420 :begin begin
2421 :end end
2425 "Interpret EXPORT-SNIPPET object as Org syntax.
2426 CONTENTS is nil."
2432 "Search for the next export-snippet object.
2434 LIMIT bounds the search.
2436 Return value is a cons cell whose CAR is `export-snippet' and CDR
2437 its beginning position."
2446 ;;;; Footnote Reference
2449 "Parse footnote reference at point.
2451 Return a list whose CAR is `footnote-reference' and CDR a plist
2452 with `:label', `:type', `:inline-definition', `:begin', `:end'
2453 and `:post-blank' as keywords."
2475 :type type
2476 :begin begin
2477 :end end
2480 footnote-reference :inline-definition
2485 footnote-reference))))))
2488 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2489 CONTENTS is nil."
2499 "Search for the next footnote-reference object.
2501 LIMIT bounds the search.
2503 Return value is a cons cell whose CAR is `footnote-reference' and
2504 CDR is beginning position."
2518 ;;;; Inline Babel Call
2521 "Parse inline babel call at point.
2523 Return a list whose CAR is `inline-babel-call' and CDR a plist
2524 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2526 Assume point is at the beginning of the babel call."
2537 :end end
2538 :info info
2542 "Interpret INLINE-BABEL-CALL object as Org syntax.
2543 CONTENTS is nil."
2549 ;; Remove redundant square brackets.
2552 main-source)
2556 "Search for the next inline-babel-call object.
2558 LIMIT bounds the search.
2560 Return value is a cons cell whose CAR is `inline-babel-call' and
2561 CDR is beginning position."
2563 ;; Use a simplified version of
2564 ;; `org-babel-inline-lob-one-liner-regexp'.
2567 limit t)
2571 ;;;; Inline Src Block
2574 "Parse inline source block at point.
2576 LIMIT bounds the search.
2578 Return a list whose CAR is `inline-src-block' and CDR a plist
2579 with `:begin', `:end', `:language', `:value', `:parameters' and
2580 `:post-blank' as keywords.
2582 Assume point is at the beginning of the inline src block."
2595 :value value
2596 :parameters parameters
2597 :begin begin
2598 :end end
2602 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2603 CONTENTS is nil."
2608 language
2610 body)))
2613 "Search for the next inline-babel-call element.
2615 LIMIT bounds the search.
2617 Return value is a cons cell whose CAR is `inline-babel-call' and
2618 CDR is beginning position."
2623 ;;;; Italic
2626 "Parse italic object at point.
2628 Return a list whose CAR is `italic' and CDR is a plist with
2629 `:begin', `:end', `:contents-begin' and `:contents-end' and
2630 `:post-blank' keywords.
2632 Assume point is at the first slash marker."
2644 :end end
2645 :contents-begin contents-begin
2646 :contents-end contents-end
2650 "Interpret ITALIC object as Org syntax.
2651 CONTENTS is the contents of the object."
2655 ;;;; Latex Fragment
2658 "Parse latex fragment at point.
2660 Return a list whose CAR is `latex-fragment' and CDR a plist with
2661 `:value', `:begin', `:end', and `:post-blank' as keywords.
2663 Assume point is at the beginning of the latex fragment."
2677 ;; None found: it's a macro.
2686 :begin begin
2687 :end end
2691 "Interpret LATEX-FRAGMENT object as Org syntax.
2692 CONTENTS is nil."
2695 ;;;; Line Break
2698 "Parse line break at point.
2700 Return a list whose CAR is `line-break', and CDR a plist with
2701 `:begin', `:end' and `:post-blank' keywords.
2703 Assume point is at the beginning of the line break."
2707 "Interpret LINE-BREAK object as Org syntax.
2708 CONTENTS is nil."
2712 "Search for the next line-break object.
2714 LIMIT bounds the search.
2716 Return value is a cons cell whose CAR is `line-break' and CDR is
2717 beginning position."
2721 ;; A line break can only happen on a non-empty line.
2726 ;;;; Link
2729 "Parse link at point.
2731 Return a list whose CAR is `link' and CDR a plist with `:type',
2732 `:path', `:raw-link', `:application', `:search-option', `:begin',
2733 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2734 keywords.
2736 Assume point is at the beginning of the link."
2739 end contents-begin contents-end link-end post-blank path type
2740 raw-link link search-option application)
2742 ;; Type 1: Text targeted from a radio target.
2747 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2752 ;; RAW-LINK is the original link.
2757 ;; Determine TYPE of link and set PATH accordingly.
2759 ;; File type.
2762 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2765 ;; Id type: PATH is the id.
2768 ;; Code-ref type: PATH is the name of the reference.
2771 ;; Custom-id type: PATH is the name of the custom id.
2774 ;; Fuzzy type: Internal link either matches a target, an
2775 ;; headline name or nothing. PATH is the target or
2776 ;; headline's name.
2778 ;; Type 3: Plain link, i.e. http://orgmode.org
2784 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2791 ;; In any case, deduce end point after trailing white space from
2792 ;; LINK-END variable.
2795 ;; Extract search option and opening application out of
2796 ;; "file"-type links.
2798 ;; Application.
2803 ;; Extract search option from PATH.
2807 ;; Make sure TYPE always report "file".
2811 :path path
2813 :application application
2814 :search-option search-option
2815 :begin begin
2816 :end end
2817 :contents-begin contents-begin
2818 :contents-end contents-end
2822 "Interpret LINK object as Org syntax.
2823 CONTENTS is the contents of the object, or nil."
2828 raw-link
2832 "Search for the next link object.
2834 LIMIT bounds the search.
2836 Return value is a cons cell whose CAR is `link' and CDR is
2837 beginning position."
2846 ;;;; Macro
2849 "Parse macro at point.
2851 Return a list whose CAR is `macro' and CDR a plist with `:key',
2852 `:args', `:begin', `:end', `:value' and `:post-blank' as
2853 keywords.
2855 Assume point is at the macro."
2869 ;; Repair bad splits.
2877 :value value
2878 :args args
2879 :begin begin
2880 :end end
2884 "Interpret MACRO object as Org syntax.
2885 CONTENTS is nil."
2889 "Search for the next macro object.
2891 LIMIT bounds the search.
2893 Return value is cons cell whose CAR is `macro' and CDR is
2894 beginning position."
2898 limit t)
2902 ;;;; Radio-target
2905 "Parse radio target at point.
2907 Return a list whose CAR is `radio-target' and CDR a plist with
2908 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2909 and `:post-blank' as keywords.
2911 Assume point is at the radio target."
2923 :end end
2924 :contents-begin contents-begin
2925 :contents-end contents-end
2926 :post-blank post-blank
2930 "Interpret TARGET object as Org syntax.
2931 CONTENTS is the contents of the object."
2935 "Search for the next radio-target object.
2937 LIMIT bounds the search.
2939 Return value is a cons cell whose CAR is `radio-target' and CDR
2940 is beginning position."
2946 ;;;; Statistics Cookie
2949 "Parse statistics cookie at point.
2951 Return a list whose CAR is `statistics-cookie', and CDR a plist
2952 with `:begin', `:end', `:value' and `:post-blank' keywords.
2954 Assume point is at the beginning of the statistics-cookie."
2965 :end end
2966 :value value
2970 "Interpret STATISTICS-COOKIE object as Org syntax.
2971 CONTENTS is nil."
2975 "Search for the next statistics cookie object.
2977 LIMIT bounds the search.
2979 Return value is a cons cell whose CAR is `statistics-cookie' and
2980 CDR is beginning position."
2986 ;;;; Strike-Through
2989 "Parse strike-through object at point.
2991 Return a list whose CAR is `strike-through' and CDR is a plist
2992 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2993 `:post-blank' keywords.
2995 Assume point is at the first plus sign marker."
3007 :end end
3008 :contents-begin contents-begin
3009 :contents-end contents-end
3013 "Interpret STRIKE-THROUGH object as Org syntax.
3014 CONTENTS is the contents of the object."
3018 ;;;; Subscript
3021 "Parse subscript at point.
3023 Return a list whose CAR is `subscript' and CDR a plist with
3024 `:begin', `:end', `:contents-begin', `:contents-end',
3025 `:use-brackets-p' and `:post-blank' as keywords.
3027 Assume point is at the underscore."
3031 t
3042 :end end
3043 :use-brackets-p bracketsp
3044 :contents-begin contents-begin
3045 :contents-end contents-end
3049 "Interpret SUBSCRIPT object as Org syntax.
3050 CONTENTS is the contents of the object."
3053 contents))
3056 "Search for the next sub/superscript object.
3058 LIMIT bounds the search.
3060 Return value is a cons cell whose CAR is either `subscript' or
3061 `superscript' and CDR is beginning position."
3068 ;;;; Superscript
3071 "Parse superscript at point.
3073 Return a list whose CAR is `superscript' and CDR a plist with
3074 `:begin', `:end', `:contents-begin', `:contents-end',
3075 `:use-brackets-p' and `:post-blank' as keywords.
3077 Assume point is at the caret."
3091 :end end
3092 :use-brackets-p bracketsp
3093 :contents-begin contents-begin
3094 :contents-end contents-end
3098 "Interpret SUPERSCRIPT object as Org syntax.
3099 CONTENTS is the contents of the object."
3102 contents))
3105 ;;;; Table Cell
3108 "Parse table cell at point.
3110 Return a list whose CAR is `table-cell' and CDR is a plist
3111 containing `:begin', `:end', `:contents-begin', `:contents-end'
3112 and `:post-blank' keywords."
3120 :end end
3121 :contents-begin contents-begin
3122 :contents-end contents-end
3126 "Interpret TABLE-CELL element as Org syntax.
3127 CONTENTS is the contents of the cell, or nil."
3131 "Search for the next table-cell object.
3133 LIMIT bounds the search.
3135 Return value is a cons cell whose CAR is `table-cell' and CDR is
3136 beginning position."
3140 ;;;; Target
3143 "Parse target at point.
3145 Return a list whose CAR is `target' and CDR a plist with
3146 `:begin', `:end', `:value' and `:post-blank' as keywords.
3148 Assume point is at the target."
3158 :end end
3159 :value value
3163 "Interpret TARGET object as Org syntax.
3164 CONTENTS is nil."
3168 "Search for the next target object.
3170 LIMIT bounds the search.
3172 Return value is a cons cell whose CAR is `target' and CDR is
3173 beginning position."
3179 ;;;; Timestamp
3182 "Parse time stamp at point.
3184 Return a list whose CAR is `timestamp', and CDR a plist with
3185 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3187 Assume point is at the beginning of the timestamp."
3206 :value main-value
3207 :range-end range-end
3208 :begin begin
3209 :end end
3213 "Interpret TIMESTAMP object as Org syntax.
3214 CONTENTS is nil."
3223 range-end)))))))
3226 "Search for the next timestamp object.
3228 LIMIT bounds the search.
3230 Return value is a cons cell whose CAR is `timestamp' and CDR is
3231 beginning position."
3239 limit t)
3243 ;;;; Underline
3246 "Parse underline object at point.
3248 Return a list whose CAR is `underline' and CDR is a plist with
3249 `:begin', `:end', `:contents-begin' and `:contents-end' and
3250 `:post-blank' keywords.
3252 Assume point is at the first underscore marker."
3264 :end end
3265 :contents-begin contents-begin
3266 :contents-end contents-end
3270 "Interpret UNDERLINE object as Org syntax.
3271 CONTENTS is the contents of the object."
3275 ;;;; Verbatim
3278 "Parse verbatim object at point.
3280 Return a list whose CAR is `verbatim' and CDR is a plist with
3281 `:value', `:begin', `:end' and `:post-blank' keywords.
3283 Assume point is at the first equal sign marker."
3294 :begin begin
3295 :end end
3299 "Interpret VERBATIM object as Org syntax.
3300 CONTENTS is nil."
3304 \f
3305 ;;; Parsing Element Starting At Point
3306 ;;
3307 ;; `org-element--current-element' is the core function of this section.
3308 ;; It returns the Lisp representation of the element starting at
3309 ;; point.
3310 ;;
3311 ;; `org-element--current-element' makes use of special modes. They
3312 ;; are activated for fixed element chaining (i.e. `plain-list' >
3313 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3314 ;; `section'). Special modes are: `first-section', `section',
3315 ;; `quote-section', `item' and `table-row'.
3319 "Parse the element starting at point.
3321 LIMIT bounds the search.
3323 Return value is a list like (TYPE PROPS) where TYPE is the type
3324 of the element and PROPS a plist of properties associated to the
3325 element.
3327 Possible types are defined in `org-element-all-elements'.
3329 Optional argument GRANULARITY determines the depth of the
3330 recursion. Allowed values are `headline', `greater-element',
3331 `element', `object' or nil. When it is broader than `object' (or
3332 nil), secondary values will not be parsed, since they only
3333 contain objects.
3335 Optional argument SPECIAL, when non-nil, can be either
3336 `first-section', `section', `quote-section', `table-row' and
3337 `item'.
3339 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3340 be computed.
3342 This function assumes point is always at the beginning of the
3343 element it has to parse."
3345 ;; If point is at an affiliated keyword, try moving to the
3346 ;; beginning of the associated element. If none is found, the
3347 ;; keyword is orphaned and will be treated as plain text.
3353 ;; Determine if parsing depth allows for secondary strings
3354 ;; parsing. It only applies to elements referenced in
3355 ;; `org-element-secondary-value-alist'.
3358 ;; Item.
3361 ;; Table Row.
3363 ;; Headline.
3366 ;; Sections (must be checked after headline).
3372 limit)))
3373 ;; When not at bol, point is at the beginning of an item or
3374 ;; a footnote definition: next item is always a paragraph.
3376 ;; Planning and Clock.
3381 ;; Inlinetask.
3384 ;; LaTeX Environment.
3390 nil t))
3393 ;; Drawer and Property Drawer.
3403 ;; Fixed Width
3406 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3407 ;; Keywords.
3416 org-element-block-name-alist)))
3431 ;; Footnote Definition.
3434 ;; Horizontal Rule.
3437 ;; Table.
3439 ;; List.
3442 ;; Default element: Paragraph.
3446 ;; Most elements can have affiliated keywords. When looking for an
3447 ;; element beginning, we want to move before them, as they belong to
3448 ;; that element, and, in the meantime, collect information they give
3449 ;; into appropriate properties. Hence the following function.
3450 ;;
3451 ;; Usage of optional arguments may not be obvious at first glance:
3452 ;;
3453 ;; - TRANS-LIST is used to polish keywords names that have evolved
3454 ;; during Org history. In example, even though =result= and
3455 ;; =results= coexist, we want to have them under the same =result=
3456 ;; property. It's also true for "srcname" and "name", where the
3457 ;; latter seems to be preferred nowadays (thus the "name" property).
3458 ;;
3459 ;; - CONSED allows to regroup multi-lines keywords under the same
3460 ;; property, while preserving their own identity. This is mostly
3461 ;; used for "attr_latex" and al.
3462 ;;
3463 ;; - PARSED prepares a keyword value for export. This is useful for
3464 ;; "caption". Objects restrictions for such keywords are defined in
3465 ;; `org-element-object-restrictions'.
3466 ;;
3467 ;; - DUALS is used to take care of keywords accepting a main and an
3468 ;; optional secondary values. For example "results" has its
3469 ;; source's name as the main value, and may have an hash string in
3470 ;; optional square brackets as the secondary one.
3471 ;;
3472 ;; A keyword may belong to more than one category.
3476 "Collect affiliated keywords before point.
3478 Optional argument KEY-RE is a regexp matching keywords, which
3479 puts matched keyword in group 1. It defaults to
3480 `org-element--affiliated-re'.
3482 TRANS-LIST is an alist where key is the keyword and value the
3483 property name it should be translated to, without the colons. It
3484 defaults to `org-element-keyword-translation-alist'.
3486 CONSED is a list of strings. Any keyword belonging to that list
3487 will have its value consed. The check is done after keyword
3488 translation. It defaults to `org-element-multiple-keywords'.
3490 PARSED is a list of strings. Any keyword member of this list
3491 will have its value parsed. The check is done after keyword
3492 translation. If a keyword is a member of both CONSED and PARSED,
3493 it's value will be a list of parsed strings. It defaults to
3494 `org-element-parsed-keywords'.
3496 DUALS is a list of strings. Any keyword member of this list can
3497 have two parts: one mandatory and one optional. Its value is
3498 a cons cell whose CAR is the former, and the CDR the latter. If
3499 a keyword is a member of both PARSED and DUALS, both values will
3500 be parsed. It defaults to `org-element-dual-keywords'.
3502 Return a list whose CAR is the position at the first of them and
3503 CDR a plist of keywords and values."
3511 ;; RESTRICT is the list of objects allowed in parsed
3512 ;; keywords value.
3514 output)
3518 ;; Apply translation to RAW-KWD. From there, KWD is
3519 ;; the official keyword.
3521 ;; Find main value for any keyword.
3527 ;; If KWD is a dual keyword, find its secondary
3528 ;; value. Maybe parse it.
3534 ;; Attribute a property name to KWD.
3536 ;; Now set final shape for VALUE.
3540 ;; VALUE is mandatory. Set it to nil if there is none.
3542 ;; Attributes are always consed.
3545 ;; Eventually store the new value in OUTPUT.
3551 \f
3552 ;;; The Org Parser
3553 ;;
3554 ;; The two major functions here are `org-element-parse-buffer', which
3555 ;; parses Org syntax inside the current buffer, taking into account
3556 ;; region, narrowing, or even visibility if specified, and
3557 ;; `org-element-parse-secondary-string', which parses objects within
3558 ;; a given string.
3559 ;;
3560 ;; The (almost) almighty `org-element-map' allows to apply a function
3561 ;; on elements or objects matching some type, and accumulate the
3562 ;; resulting values. In an export situation, it also skips unneeded
3563 ;; parts of the parse tree.
3566 "Recursively parse the buffer and return structure.
3567 If narrowing is in effect, only parse the visible part of the
3568 buffer.
3570 Optional argument GRANULARITY determines the depth of the
3571 recursion. It can be set to the following symbols:
3573 `headline' Only parse headlines.
3574 `greater-element' Don't recurse into greater elements excepted
3575 headlines and sections. Thus, elements
3576 parsed are the top-level ones.
3577 `element' Parse everything but objects and plain text.
3578 `object' Parse the complete buffer (default).
3580 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3581 elements.
3583 Assume buffer is in Org mode."
3589 ;; Start in `first-section' mode so text before the first
3590 ;; headline belongs to a section.
3594 "Recursively parse objects in STRING and return structure.
3596 RESTRICTION is a symbol limiting the object types that will be
3597 looked after.
3599 Optional argument PARENT, when non-nil, is the element or object
3600 containing the secondary string. It is used to set correctly
3601 `:parent' property within the string."
3607 secondary))))
3610 "Map a function on selected elements or objects.
3612 DATA is the parsed tree, as returned by, i.e,
3613 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3614 of elements or objects types. FUN is the function called on the
3615 matching element or object. It must accept one arguments: the
3616 element or object itself.
3618 When optional argument INFO is non-nil, it should be a plist
3619 holding export options. In that case, parts of the parse tree
3620 not exportable according to that property list will be skipped.
3622 When optional argument FIRST-MATCH is non-nil, stop at the first
3623 match for which FUN doesn't return nil, and return that value.
3625 Optional argument NO-RECURSION is a symbol or a list of symbols
3626 representing elements or objects types. `org-element-map' won't
3627 enter any recursive element or object whose type belongs to that
3628 list. Though, FUN can still be applied on them.
3630 Nil values returned from FUN do not appear in the results."
3631 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3634 ;; Recursion depth is determined by --CATEGORY.
3641 ;; If one object is found, the function
3642 ;; has to recurse into every object.
3645 ;; If one regular element is found, the
3646 ;; function has to recurse, at least,
3647 ;; into every element it encounters.
3650 types)
3651 category)))
3652 --acc
3653 --walk-tree
3657 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3658 ;; holding contextual information.
3662 ;; Ignored element in an export context.
3664 ;; Secondary string: only objects can be found there.
3667 ;; Unconditionally enter parse trees.
3671 ;; Check if TYPE is matching among TYPES. If so,
3672 ;; apply FUN to --DATA and accumulate return value
3673 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3679 ;; If --DATA has a secondary string that can contain
3680 ;; objects with their type among TYPES, look into it.
3687 ;; Determine if a recursion into --DATA is possible.
3689 ;; --TYPE is explicitly removed from recursion.
3691 ;; --DATA has no contents.
3693 ;; Looking for greater elements but --DATA is simply
3694 ;; an element or an object.
3697 ;; Looking for elements but --DATA is an object.
3700 ;; In any other case, map contents.
3704 ;; Return value in a proper order.
3707 ;; The following functions are internal parts of the parser.
3708 ;;
3709 ;; The first one, `org-element--parse-elements' acts at the element's
3710 ;; level.
3711 ;;
3712 ;; The second one, `org-element--parse-objects' applies on all objects
3713 ;; of a paragraph or a secondary string. It uses
3714 ;; `org-element--get-next-object-candidates' to optimize the search of
3715 ;; the next object in the buffer.
3716 ;;
3717 ;; More precisely, that function looks for every allowed object type
3718 ;; first. Then, it discards failed searches, keeps further matches,
3719 ;; and searches again types matched behind point, for subsequent
3720 ;; calls. Thus, searching for a given type fails only once, and every
3721 ;; object is searched only once at top level (but sometimes more for
3722 ;; nested types).
3726 "Parse elements between BEG and END positions.
3728 SPECIAL prioritize some elements over the others. It can be set
3729 to `first-section', `quote-section', `section' `item' or
3730 `table-row'.
3732 When value is `item', STRUCTURE will be used as the current list
3733 structure.
3735 GRANULARITY determines the depth of the recursion. See
3736 `org-element-parse-buffer' for more information.
3738 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3739 elements.
3741 Elements are accumulated into ACC."
3744 ;; When parsing only headlines, skip any text before first one.
3747 ;; Main loop start.
3749 ;; Find current element's type and parse it accordingly to
3750 ;; its category.
3752 end granularity special structure))
3756 ;; Fill ELEMENT contents by side-effect.
3758 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3759 ;; no contents, don't modify it.
3762 ;; Greater element: parse it between `contents-begin' and
3763 ;; `contents-end'. Make sure GRANULARITY allows the
3764 ;; recursion, or ELEMENT is an headline, in which case going
3765 ;; inside is mandatory, in order to get sub-level headings.
3773 ;; Possibly switch to a special mode.
3781 granularity visible-only element))
3782 ;; ELEMENT has contents. Parse objects inside, if
3783 ;; GRANULARITY allows it.
3789 ;; Return result.
3790 acc))
3793 "Parse objects between BEG and END and return recursive structure.
3795 Objects are accumulated in ACC.
3797 RESTRICTION is a list of object types which are allowed in the
3798 current object."
3804 end restriction candidates)))
3811 ;; 1. Text before any object. Untabify it.
3816 acc
3820 ;; 2. Object...
3823 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3824 ;; a recursive type.
3829 cont-beg
3836 ;; 3. Text after last object. Untabify it.
3840 acc
3844 ;; Result.
3845 acc)))
3848 "Return an alist of candidates for the next object.
3850 LIMIT bounds the search, and RESTRICTION narrows candidates to
3851 some object types.
3853 Return value is an alist whose CAR is position and CDR the object
3854 type, as a symbol.
3856 OBJECTS is the previous candidates alist."
3858 ;; If no previous result, search every object type in RESTRICTION.
3859 ;; Otherwise, keep potential candidates (old objects located after
3860 ;; point) and ask to search again those which had matched before.
3865 objects))
3866 ;; Call the appropriate successor function for each type to search
3867 ;; and accumulate matches.
3874 type))))
3877 types-to-search)
3878 ;; Return alist.
3879 next-candidates))
3882 \f
3883 ;;; Towards A Bijective Process
3884 ;;
3885 ;; The parse tree obtained with `org-element-parse-buffer' is really
3886 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3887 ;; interpreted and expanded into a string with canonical Org syntax.
3888 ;; Hence `org-element-interpret-data'.
3889 ;;
3890 ;; The function relies internally on
3891 ;; `org-element--interpret-affiliated-keywords'.
3893 ;;;###autoload
3895 "Interpret DATA as Org syntax.
3897 DATA is a parse tree, an element, an object or a secondary string
3898 to interpret.
3900 Optional argument PARENT is used for recursive calls. It contains
3901 the element or object containing data, or nil.
3903 Return Org syntax as a string."
3907 ;; Secondary string.
3912 ;; Full Org document.
3917 ;; Plain text.
3919 ;; Element/Object without contents.
3922 data nil))
3923 ;; Element/Object with contents.
3933 ;; Elements directly containing objects must
3934 ;; have their indentation normalized first.
3936 data
3937 ;; When normalizing first paragraph of an
3938 ;; item or a footnote-definition, ignore
3939 ;; first line's indentation.
3946 data
3948 contents)))))))
3950 ;; Build white spaces. If no `:post-blank' property is
3951 ;; specified, assume its value is 0.
3961 "Return ELEMENT's affiliated keywords as Org syntax.
3962 If there is no affiliated keyword, return the empty string."
3972 ": "
3975 value)
3983 ;; All attribute keywords can have multiple lines.
3986 value
3989 ;; List all ELEMENT's properties matching an attribute line or an
3990 ;; affiliated keyword, but ignore translated keywords since they
3991 ;; cannot belong to the property list.
3998 org-element-keyword-translation-alist)))))
3999 collect prop)
4002 ;; Because interpretation of the parse tree must return the same
4003 ;; number of blank lines between elements and the same number of white
4004 ;; space after objects, some special care must be given to white
4005 ;; spaces.
4006 ;;
4007 ;; The first function, `org-element-normalize-string', ensures any
4008 ;; string different from the empty string will end with a single
4009 ;; newline character.
4010 ;;
4011 ;; The second function, `org-element-normalize-contents', removes
4012 ;; global indentation from the contents of the current element.
4015 "Ensure string S ends with a single newline character.
4017 If S isn't a string return it unchanged. If S is the empty
4018 string, return it. Otherwise, return a new string with a single
4019 newline character at its end."
4027 "Normalize plain text in ELEMENT's contents.
4029 ELEMENT must only contain plain text and objects.
4031 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4032 indentation to compute maximal common indentation.
4034 Return the normalized element that is element with global
4035 indentation removed from its contents. The function assumes that
4036 indentation is not done with TAB characters."
4038 collect-inds ; for byte-compiler
4041 ;; Return list of indentations within BLOB. This is done by
4042 ;; walking recursively BLOB and updating IND-LIST along the
4043 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4044 ;; been seen yet. It is required as this string is the only
4045 ;; one whose indentation doesn't happen after a newline
4046 ;; character.
4054 ;; An indentation of zero means no string will be
4055 ;; modified. Quit the process.
4061 ;; Avoid matching blank or empty lines.
4069 ;; Collect indentation list in ELEMENT. Possibly remove first
4070 ;; value if IGNORE-FIRST is non-nil.
4073 ;; Build ELEMENT back, replacing each string with the same
4074 ;; string minus common indentation.
4079 ;; Return BLOB with all its strings indentation
4080 ;; shortened from MCI white spaces. FIRST-FLAG is
4081 ;; non-nil when the first string hasn't been seen
4082 ;; yet.
4096 org-element-recursive-objects)
4100 blob))))
4104 \f
4105 ;;; The Toolbox
4106 ;;
4107 ;; The first move is to implement a way to obtain the smallest element
4108 ;; containing point. This is the job of `org-element-at-point'. It
4109 ;; basically jumps back to the beginning of section containing point
4110 ;; and moves, element after element, with
4111 ;; `org-element--current-element' until the container is found. Note:
4112 ;; When using `org-element-at-point', secondary values are never
4113 ;; parsed since the function focuses on elements, not on objects.
4114 ;;
4115 ;; At a deeper level, `org-element-context' lists all elements and
4116 ;; objects containing point.
4117 ;;
4118 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4119 ;; internally by navigation and manipulation tools.
4121 ;;;###autoload
4123 "Determine closest element around point.
4125 Return value is a list like (TYPE PROPS) where TYPE is the type
4126 of the element and PROPS a plist of properties associated to the
4127 element.
4129 Possible types are defined in `org-element-all-elements'.
4130 Properties depend on element or object type, but always
4131 include :begin, :end, :parent and :post-blank properties.
4133 As a special case, if point is at the very beginning of a list or
4134 sub-list, returned element will be that list instead of the first
4135 item. In the same way, if point is at the beginning of the first
4136 row of a table, returned element will be the table instead of the
4137 first row.
4139 If optional argument KEEP-TRAIL is non-nil, the function returns
4140 a list of of elements leading to element at point. The list's
4141 CAR is always the element at point. Following positions contain
4142 element's siblings, then parents, siblings of parents, until the
4143 first element of current section."
4145 ;; If at an headline, parse it. It is the sole element that
4146 ;; doesn't require to know about context. Be sure to disallow
4147 ;; secondary string parsing, though.
4153 ;; Otherwise move at the beginning of the section containing
4154 ;; point.
4158 element type special-flag trail struct prevs parent)
4166 ;; Parse successively each element, skipping those ending
4167 ;; before original position.
4176 ;; 1. Skip any element ending before point. Also skip
4177 ;; element ending at point when we're sure that another
4178 ;; element has started.
4183 ;; 2. An element containing point is always the element at
4184 ;; point.
4187 ;; 3. At any other greater element type, if point is
4188 ;; within contents, move into it.
4193 ;; Create an anchor for tables and plain lists:
4194 ;; when point is at the very beginning of these
4195 ;; elements, ignoring affiliated keywords,
4196 ;; target them instead of their contents.
4198 ;; When point is at contents end, do not move
4199 ;; into elements with an explicit ending, but
4200 ;; return that element instead.
4204 drawer dynamic-block inlinetask item
4205 plain-list quote-block special-block))))
4217 ;;;###autoload
4219 "Return closest element or object around point.
4221 Return value is a list like (TYPE PROPS) where TYPE is the type
4222 of the element or object and PROPS a plist of properties
4223 associated to it.
4225 Possible types are defined in `org-element-all-elements' and
4226 `org-element-all-objects'. Properties depend on element or
4227 object type, but always include :begin, :end, :parent
4228 and :post-blank properties."
4233 end)
4234 ;; Check if point is inside an element containing objects or at
4235 ;; a secondary string. In that case, move to beginning of the
4236 ;; element or secondary string and set END to the other side.
4245 (<= origin
4246 ;; `1+' is required so some
4247 ;; successors can match
4248 ;; properly their object.
4262 element
4265 candidates)
4268 end restriction candidates))
4270 candidates)))
4271 ;; If ORIGIN is before next object in element, there's
4272 ;; no point in looking further.
4281 ;; ORIGIN is after OBJECT, so skip it.
4284 ;; ORIGIN is within a non-recursive object or at an
4285 ;; object boundaries: Return that object.
4289 ;; Otherwise, move within current object and restrict
4290 ;; search to the end of its contents.
4294 parent))))))
4297 "Non-nil when elements ELEM-A and ELEM-B are nested."
4306 "Swap elements ELEM-A and ELEM-B.
4307 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4308 end of ELEM-A."
4310 ;; There are two special cases when an element doesn't start at bol:
4311 ;; the first paragraph in an item or in a footnote definition.
4313 ;; Only a paragraph without any affiliated keyword can be moved at
4314 ;; ELEM-A position in such a situation. Note that the case of
4315 ;; a footnote definition is impossible: it cannot contain two
4316 ;; paragraphs in a row because it cannot contain a blank line.
4322 ;; In a special situation, ELEM-A will have no indentation. We'll
4323 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4337 ;; Store overlays responsible for visibility status. We
4338 ;; also need to store their boundaries as they will be
4339 ;; removed from buffer.
4346 ;; Get contents.
4354 ;; Restore ex ELEM-A overlays.
4363 ;; Restore ex ELEM-B overlays.
4372 ;;; org-element.el ends here