| blob | e5e692afb73871eed10dba00f6f78abf408897c6 |
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 ;; Comments, blocks (any type), keywords, Babel calls,
135 ;; drawers (any type) and tables.
137 ;; Fixed width areas.
139 ;; Horizontal rules.
141 ;; LaTeX environments.
143 ;; Planning and Clock lines.
145 org-deadline-string
146 org-closed-string
147 org-clock-string))
149 ;; Lists.
160 export-block fixed-width footnote-definition headline
161 horizontal-rule inlinetask item keyword latex-environment
162 babel-call paragraph plain-list planning property-drawer
163 quote-block quote-section section special-block src-block table
164 table-row verse-block)
169 item plain-list quote-block section special-block table)
174 latex-or-entity line-break link macro radio-target
175 statistics-cookie sub/superscript table-cell target
176 text-markup timestamp)
185 "Alist of translations between object type and successor name.
187 Sharing the same successor comes handy when, for example, the
192 inline-src-block italic line-break latex-fragment link macro
193 radio-target statistics-cookie strike-through subscript superscript
194 table-cell target timestamp underline verbatim)
199 table-cell underline)
209 "Alist between block names and the associated parsing function.
210 Names must be uppercase. Any block whose name has no association
216 "List of affiliated keywords as strings.
222 ;; Regular affiliated keywords.
225 "Regexp matching any affiliated keyword.
227 Keyword name is put in match group 1. Moreover, if keyword
228 belongs to `org-element-dual-keywords', put the dual value in
229 match group 2.
237 "Alist of usual translations for keywords.
238 The key is the old name and the value the new one. The property
242 "List of affiliated keywords that can occur more that once in an element.
244 Their value will be consed into a list of strings, which will be
245 returned as the value of the property.
247 This list is checked after translations have been applied. See
248 `org-element-keyword-translation-alist'.
254 "List of keywords whose value can be parsed.
256 Their value will be stored as a secondary string: a list of
257 strings and objects.
259 This list is checked after translations have been applied. See
263 "List of keywords which can have a secondary value.
265 In Org syntax, they can be written with optional square brackets
266 before the colons. For example, results keyword can be
267 associated to a hash value with the following:
269 #+RESULTS[hash-string]: some-source
271 This list is checked after translations have been applied. See
278 inline-src-block latex-or-entity line-break link macro
279 radio-target sub/superscript target text-markup
280 timestamp)
282 radio-target statistics-cookie sub/superscript target text-markup
283 timestamp)
295 inline-src-block latex-or-entity line-break link macro
296 radio-target statistics-cookie sub/superscript target text-markup
297 timestamp)
300 latex-or-entity link radio-target sub/superscript target
301 text-markup timestamp)
312 latex-or-entity line-break link macro radio-target
314 "Alist of objects restrictions.
316 CAR is an element or object type containing objects and CDR is
317 a list of successors that will be called within an element or
318 object of such type.
320 For example, in a `radio-target' object, one can only find
321 entities, export snippets, latex-fragments, subscript and
322 superscript.
324 This alist also applies to secondary string. For example, an
325 `headline' type element doesn't directly contain objects, but
336 \f
337 ;;; Accessors and Setters
338 ;;
339 ;; Provide four accessors: `org-element-type', `org-element-property'
340 ;; `org-element-contents' and `org-element-restriction'.
341 ;;
342 ;; Setter functions allow to modify elements by side effect. There is
343 ;; `org-element-put-property', `org-element-set-contents',
344 ;; `org-element-set-element' and `org-element-adopt-element'. Note
345 ;; that `org-element-set-element' and `org-element-adopt-element' are
346 ;; higher level functions since also update `:parent' property.
349 "Return type of ELEMENT.
351 The function returns the type of the element or object provided.
352 It can also return the following special value:
353 `plain-text' for a string
354 `org-data' for a complete document
355 nil in any other case."
361 "Extract the value from the PROPERTY of an ELEMENT."
365 "Extract contents from an ELEMENT."
369 "Return restriction associated to ELEMENT.
370 ELEMENT can be an element, an object or a symbol representing an
371 element or object type."
373 org-element-object-restrictions)))
376 "In ELEMENT set PROPERTY to VALUE.
377 Return modified element."
380 element)
383 "Set ELEMENT contents to CONTENTS.
384 Return modified element."
390 "Replace element or object OLD with element or object NEW.
391 The function takes care of setting `:parent' property for NEW."
392 ;; OLD can belong to the contents of PARENT or to its secondary
393 ;; string.
396 org-element-secondary-value-alist)))
399 ;; Make sure NEW has correct `:parent' property.
401 ;; Replace OLD with NEW in PARENT.
405 "Add an element to the contents of another element.
407 PARENT is an element or object. CHILD is an element, an object,
408 or a string.
410 CHILD is added at the beginning of PARENT contents, unless the
411 optional argument APPEND is non-nil, in which case CHILD is added
412 at the end.
414 The function takes care of setting `:parent' property for CHILD.
415 Return parent element."
419 parent
421 ;; Link the CHILD element with PARENT.
423 ;; Return the parent element.
424 parent))
427 \f
428 ;;; Greater elements
429 ;;
430 ;; For each greater element type, we define a parser and an
431 ;; interpreter.
432 ;;
433 ;; A parser returns the element or object as the list described above.
434 ;; Most of them accepts no argument. Though, exceptions exist. Hence
435 ;; every element containing a secondary string (see
436 ;; `org-element-secondary-value-alist') will accept an optional
437 ;; argument to toggle parsing of that secondary string. Moreover,
438 ;; `item' parser requires current list's structure as its first
439 ;; element.
440 ;;
441 ;; An interpreter accepts two arguments: the list representation of
442 ;; the element or object, and its contents. The latter may be nil,
443 ;; depending on the element or object considered. It returns the
444 ;; appropriate Org syntax, as a string.
445 ;;
446 ;; Parsing functions must follow the naming convention:
447 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
448 ;; defined in `org-element-greater-elements'.
449 ;;
450 ;; Similarly, interpreting functions must follow the naming
451 ;; convention: org-element-TYPE-interpreter.
452 ;;
453 ;; With the exception of `headline' and `item' types, greater elements
454 ;; cannot contain other greater elements of their own type.
455 ;;
456 ;; Beside implementing a parser and an interpreter, adding a new
457 ;; greater element requires to tweak `org-element--current-element'.
458 ;; Moreover, the newly defined type must be added to both
459 ;; `org-element-all-elements' and `org-element-greater-elements'.
462 ;;;; Center Block
465 "Parse a center block.
467 LIMIT bounds the search.
469 Return a list whose CAR is `center-block' and CDR is a plist
470 containing `:begin', `:end', `:hiddenp', `:contents-begin',
471 `:contents-end' and `:post-blank' keywords.
473 Assume point is at the beginning of the block."
477 ;; Incomplete block: parse it as a comment.
482 ;; Empty blocks have no contents.
496 :end end
497 :hiddenp hidden
498 :contents-begin contents-begin
499 :contents-end contents-end
504 "Interpret CENTER-BLOCK element as Org syntax.
505 CONTENTS is the contents of the element."
509 ;;;; Drawer
512 "Parse a drawer.
514 LIMIT bounds the search.
516 Return a list whose CAR is `drawer' and CDR is a plist containing
517 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
518 `:contents-end' and `:post-blank' keywords.
520 Assume point is at beginning of drawer."
523 ;; Incomplete drawer: parse it as a paragraph.
532 ;; Empty drawers have no contents.
546 :end end
547 :drawer-name name
548 :hiddenp hidden
549 :contents-begin contents-begin
550 :contents-end contents-end
555 "Interpret DRAWER element as Org syntax.
556 CONTENTS is the contents of the element."
559 contents))
562 ;;;; Dynamic Block
565 "Parse a dynamic block.
567 LIMIT bounds the search.
569 Return a list whose CAR is `dynamic-block' and CDR is a plist
570 containing `:block-name', `:begin', `:end', `:hiddenp',
571 `:contents-begin', `:contents-end', `:arguments' and
572 `:post-blank' keywords.
574 Assume point is at beginning of dynamic block."
577 ;; Incomplete block: parse it as a comment.
586 ;; Empty blocks have no contents.
600 :end end
601 :block-name name
602 :arguments arguments
603 :hiddenp hidden
604 :contents-begin contents-begin
605 :contents-end contents-end
610 "Interpret DYNAMIC-BLOCK element as Org syntax.
611 CONTENTS is the contents of the element."
616 contents))
619 ;;;; Footnote Definition
622 "Parse a footnote definition.
624 LIMIT bounds the search.
626 Return a list whose CAR is `footnote-definition' and CDR is
627 a plist containing `:label', `:begin' `:end', `:contents-begin',
628 `:contents-end' and `:post-blank' keywords.
630 Assume point is at the beginning of the footnote definition."
655 :begin begin
656 :end end
657 :contents-begin contents-begin
658 :contents-end contents-end
663 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
664 CONTENTS is the contents of the footnote-definition."
666 " "
667 contents))
670 ;;;; Headline
673 "Parse an headline.
675 Return a list whose CAR is `headline' and CDR is a plist
676 containing `:raw-value', `:title', `:begin', `:end',
677 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
678 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
679 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
680 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
681 keywords.
683 The plist also contains any property set in the property drawer,
684 with its name in lowercase, the underscores replaced with hyphens
685 and colons at the beginning (i.e. `:custom-id').
687 When RAW-SECONDARY-P is non-nil, headline's title will not be
688 parsed as a secondary string, but as a plain string instead.
690 Assume point is at beginning of the headline."
709 ;; Normalize property names: ":SOME_PROP:" becomes
710 ;; ":some-prop".
722 plist))
740 ;; Clean RAW-VALUE from any quote or comment string.
745 ""
746 raw-value)))
747 ;; Clean TAGS from archive tag, if any.
753 :begin begin
754 :end end
755 :pre-blank
758 :hiddenp hidden
759 :contents-begin contents-begin
760 :contents-end contents-end
761 :level level
763 :tags tags
764 :todo-keyword todo
765 :todo-type todo-type
766 :scheduled scheduled
767 :deadline deadline
768 :timestamp timestamp
769 :clock clock
775 end)
776 :footnote-section-p footnote-section-p
777 :archivedp archivedp
778 :commentedp commentedp
780 standard-props))))
782 headline :title
788 "Interpret HEADLINE element as Org syntax.
789 CONTENTS is the contents of the element."
816 ;; Align tags.
824 ? )
825 tags))
829 tags))))
831 contents)))
834 ;;;; Inlinetask
837 "Parse an inline task.
839 Return a list whose CAR is `inlinetask' and CDR is a plist
840 containing `:title', `:begin', `:end', `:hiddenp',
841 `:contents-begin' and `:contents-end', `:level', `:priority',
842 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
843 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
845 The plist also contains any property set in the property drawer,
846 with its name in lowercase, the underscores replaced with hyphens
847 and colons at the beginning (i.e. `:custom-id').
849 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
850 title will not be parsed as a secondary string, but as a plain
851 string instead.
853 Assume point is at beginning of the inline task."
863 ;; Normalize property names: ":SOME_PROP:" becomes
864 ;; ":some-prop".
876 plist))
900 :end end
901 :hiddenp hidden
902 :contents-begin contents-begin
903 :contents-end contents-end
906 :tags tags
907 :todo-keyword todo
908 :todo-type todo-type
909 :scheduled scheduled
910 :deadline deadline
911 :timestamp timestamp
912 :clock clock
914 standard-props
917 inlinetask :title
922 inlinetask))))))
925 "Interpret INLINETASK element as Org syntax.
926 CONTENTS is the contents of inlinetask."
941 ;; Align tags.
949 ? )
950 tags))
954 tags))))
955 ;; Prefer degenerate inlinetasks when there are no
956 ;; contents.
959 contents
963 ;;;; Item
966 "Parse an item.
968 STRUCT is the structure of the plain list.
970 Return a list whose CAR is `item' and CDR is a plist containing
971 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
972 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
973 `:post-blank' keywords.
975 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
976 any, will not be parsed as a secondary string, but as a plain
977 string instead.
979 Assume point is at the beginning of the item."
1002 ;; If first line isn't empty,
1003 ;; contents really start at the text
1004 ;; after item's meta-data.
1017 :begin begin
1018 :end end
1019 ;; CONTENTS-BEGIN and CONTENTS-END may be
1020 ;; mixed up in the case of an empty item
1021 ;; separated from the next by a blank line.
1022 ;; Thus ensure the former is always the
1023 ;; smallest.
1026 :checkbox checkbox
1027 :counter counter
1028 :hiddenp hidden
1029 :structure struct
1032 item :tag
1040 "Interpret ITEM element as Org syntax.
1041 CONTENTS is the contents of the element."
1047 ;; Compute indentation.
1052 ;; Indent contents.
1054 bullet
1067 ;;;; Plain List
1070 "Parse a plain list.
1072 Optional argument STRUCTURE, when non-nil, is the structure of
1073 the plain list being parsed.
1075 Return a list whose CAR is `plain-list' and CDR is a plist
1076 containing `:type', `:begin', `:end', `:contents-begin' and
1077 `:contents-end', `:structure' and `:post-blank' keywords.
1079 Assume point is at the beginning of the list."
1094 ;; Return value.
1098 :begin begin
1099 :end end
1100 :contents-begin contents-begin
1101 :contents-end contents-end
1102 :structure struct
1107 "Interpret PLAIN-LIST element as Org syntax.
1108 CONTENTS is the contents of the element."
1116 ;;;; Quote Block
1119 "Parse a quote block.
1121 LIMIT bounds the search.
1123 Return a list whose CAR is `quote-block' and CDR is a plist
1124 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1125 `:contents-end' and `:post-blank' keywords.
1127 Assume point is at the beginning of the block."
1131 ;; Incomplete block: parse it as a comment.
1137 ;; Empty blocks have no contents.
1151 :end end
1152 :hiddenp hidden
1153 :contents-begin contents-begin
1154 :contents-end contents-end
1159 "Interpret QUOTE-BLOCK element as Org syntax.
1160 CONTENTS is the contents of the element."
1164 ;;;; Section
1167 "Parse a section.
1169 LIMIT bounds the search.
1171 Return a list whose CAR is `section' and CDR is a plist
1172 containing `:begin', `:end', `:contents-begin', `contents-end'
1173 and `:post-blank' keywords."
1175 ;; Beginning of section is the beginning of the first non-blank
1176 ;; line after previous headline.
1185 :end end
1186 :contents-begin begin
1187 :contents-end pos-before-blank
1191 "Interpret SECTION element as Org syntax.
1192 CONTENTS is the contents of the element."
1193 contents)
1196 ;;;; Special Block
1199 "Parse a special block.
1201 LIMIT bounds the search.
1203 Return a list whose CAR is `special-block' and CDR is a plist
1204 containing `:type', `:begin', `:end', `:hiddenp',
1205 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1207 Assume point is at the beginning of the block."
1213 ;; Incomplete block: parse it as a comment.
1219 ;; Empty blocks have no contents.
1233 :begin begin
1234 :end end
1235 :hiddenp hidden
1236 :contents-begin contents-begin
1237 :contents-end contents-end
1242 "Interpret SPECIAL-BLOCK element as Org syntax.
1243 CONTENTS is the contents of the element."
1248 \f
1249 ;;; Elements
1250 ;;
1251 ;; For each element, a parser and an interpreter are also defined.
1252 ;; Both follow the same naming convention used for greater elements.
1253 ;;
1254 ;; Also, as for greater elements, adding a new element type is done
1255 ;; through the following steps: implement a parser and an interpreter,
1256 ;; tweak `org-element--current-element' so that it recognizes the new
1257 ;; type and add that new type to `org-element-all-elements'.
1258 ;;
1259 ;; As a special case, when the newly defined type is a block type,
1260 ;; `org-element-block-name-alist' has to be modified accordingly.
1263 ;;;; Babel Call
1266 "Parse a babel call.
1268 LIMIT bounds the search.
1270 Return a list whose CAR is `babel-call' and CDR is a plist
1271 containing `:begin', `:end', `:info' and `:post-blank' as
1272 keywords."
1283 :end end
1284 :info info
1288 "Interpret BABEL-CALL element as Org syntax.
1289 CONTENTS is nil."
1295 ;; Remove redundant square brackets.
1300 ;;;; Clock
1303 "Parse a clock.
1305 LIMIT bounds the search.
1307 Return a list whose CAR is `clock' and CDR is a plist containing
1308 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1309 as keywords."
1328 :value value
1329 :time time
1330 :begin begin
1331 :end end
1335 "Interpret CLOCK element as Org syntax.
1336 CONTENTS is nil."
1343 "%2s:%02s"
1347 ;;;; Comment
1350 "Parse a comment.
1352 LIMIT bounds the search.
1354 Return a list whose CAR is `comment' and CDR is a plist
1355 containing `:begin', `:end', `:value' and `:post-blank'
1356 keywords.
1358 Assume point is at comment beginning."
1362 ;; Match first line with a loose regexp since it might as
1363 ;; well be an ill-defined keyword.
1369 ;; Get comments ending.
1372 ;; Accumulate lines without leading hash and first
1373 ;; whitespace.
1387 :end end
1388 :value value
1393 "Interpret COMMENT element as Org syntax.
1394 CONTENTS is nil."
1398 ;;;; Comment Block
1401 "Parse an export block.
1403 LIMIT bounds the search.
1405 Return a list whose CAR is `comment-block' and CDR is a plist
1406 containing `:begin', `:end', `:hiddenp', `:value' and
1407 `:post-blank' keywords.
1409 Assume point is at comment block beginning."
1413 ;; Incomplete block: parse it as a comment.
1427 contents-begin contents-end)))
1431 :end end
1432 :value value
1433 :hiddenp hidden
1438 "Interpret COMMENT-BLOCK element as Org syntax.
1439 CONTENTS is nil."
1444 ;;;; Example Block
1447 "Parse an example block.
1449 LIMIT bounds the search.
1451 Return a list whose CAR is `example-block' and CDR is a plist
1452 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1453 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1454 `:switches', `:value' and `:post-blank' keywords."
1458 ;; Incomplete block: parse it as a comment.
1465 ;; Switches analysis
1470 ;; Should labels be retained in (or stripped from) example
1471 ;; blocks?
1476 ;; What should code-references use - labels or
1477 ;; line-numbers?
1484 ;; Standard block parsing.
1498 :end end
1499 :value value
1500 :switches switches
1501 :number-lines number-lines
1502 :preserve-indent preserve-indent
1503 :retain-labels retain-labels
1504 :use-labels use-labels
1505 :label-fmt label-fmt
1506 :hiddenp hidden
1511 "Interpret EXAMPLE-BLOCK element as Org syntax.
1512 CONTENTS is nil."
1520 ;;;; Export Block
1523 "Parse an export block.
1525 LIMIT bounds the search.
1527 Return a list whose CAR is `export-block' and CDR is a plist
1528 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1529 `:post-blank' keywords.
1531 Assume point is at export-block beginning."
1537 ;; Incomplete block: parse it as a comment.
1551 contents-end)))
1555 :end end
1556 :type type
1557 :value value
1558 :hiddenp hidden
1563 "Interpret EXPORT-BLOCK element as Org syntax.
1564 CONTENTS is nil."
1571 ;;;; Fixed-width
1574 "Parse a fixed-width section.
1576 LIMIT bounds the search.
1578 Return a list whose CAR is `fixed-width' and CDR is a plist
1579 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1581 Assume point is at the beginning of the fixed-width area."
1585 value
1590 ;; Accumulate text without starting colons.
1603 :end end
1604 :value value
1609 "Interpret FIXED-WIDTH element as Org syntax.
1610 CONTENTS is nil."
1615 ;;;; Horizontal Rule
1618 "Parse an horizontal rule.
1620 LIMIT bounds the search.
1622 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1623 containing `:begin', `:end' and `:post-blank' keywords."
1633 :end end
1638 "Interpret HORIZONTAL-RULE element as Org syntax.
1639 CONTENTS is nil."
1643 ;;;; Keyword
1646 "Parse a keyword at point.
1648 LIMIT bounds the search.
1650 Return a list whose CAR is `keyword' and CDR is a plist
1651 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1652 keywords."
1665 :value value
1666 :begin begin
1667 :end end
1671 "Interpret KEYWORD element as Org syntax.
1672 CONTENTS is nil."
1678 ;;;; Latex Environment
1681 "Parse a LaTeX environment.
1683 LIMIT bounds the search.
1685 Return a list whose CAR is `latex-environment' and CDR is a plist
1686 containing `:begin', `:end', `:value' and `:post-blank'
1687 keywords.
1689 Assume point is at the beginning of the latex environment."
1707 :end end
1708 :value value
1713 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1714 CONTENTS is nil."
1718 ;;;; Paragraph
1721 "Parse a paragraph.
1723 LIMIT bounds the search.
1725 Return a list whose CAR is `paragraph' and CDR is a plist
1726 containing `:begin', `:end', `:contents-begin' and
1727 `:contents-end' and `:post-blank' keywords.
1729 Assume point is at the beginning of the paragraph."
1737 limit
1747 ;; If paragraph has no affiliated keywords, it may not begin
1748 ;; at beginning of line if it starts an item.
1751 :end end
1752 :contents-begin contents-begin
1753 :contents-end contents-end
1758 "Interpret PARAGRAPH element as Org syntax.
1759 CONTENTS is the contents of the element."
1760 contents)
1763 ;;;; Planning
1766 "Parse a planning.
1768 LIMIT bounds the search.
1770 Return a list whose CAR is `planning' and CDR is a plist
1771 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1772 and `:post-blank' keywords."
1781 closed deadline scheduled)
1795 :deadline deadline
1796 :scheduled scheduled
1797 :begin begin
1798 :end end
1802 "Interpret PLANNING element as Org syntax.
1803 CONTENTS is nil."
1805 'identity
1817 ;;;; Property Drawer
1820 "Parse a property drawer.
1822 LIMIT bounds the search.
1824 Return a list whose CAR is `property-drawer' and CDR is a plist
1825 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1826 `:contents-end', `:properties' and `:post-blank' keywords.
1828 Assume point is at the beginning of the property drawer."
1842 val))
1844 val))
1852 :end end
1853 :hiddenp hidden
1854 :properties properties
1858 "Interpret PROPERTY-DRAWER element as Org syntax.
1859 CONTENTS is nil."
1869 ;;;; Quote Section
1872 "Parse a quote section.
1874 LIMIT bounds the search.
1876 Return a list whose CAR is `quote-section' and CDR is a plist
1877 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1879 Assume point is at beginning of the section."
1890 :end end
1891 :value value
1895 "Interpret QUOTE-SECTION element as Org syntax.
1896 CONTENTS is nil."
1900 ;;;; Src Block
1903 "Parse a src block.
1905 LIMIT bounds the search.
1907 Return a list whose CAR is `src-block' and CDR is a plist
1908 containing `:language', `:switches', `:parameters', `:begin',
1909 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1910 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1911 `:post-blank' keywords.
1913 Assume point is at the beginning of the block."
1916 ;; Incomplete block: parse it as a comment.
1921 ;; Get beginning position.
1923 ;; Get language as a string.
1932 ;; Get switches.
1934 ;; Get parameters.
1936 ;; Switches analysis
1944 ;; Should labels be retained in (or stripped from)
1945 ;; src blocks?
1950 ;; What should code-references use - labels or
1951 ;; line-numbers?
1955 ;; Get visibility status.
1957 ;; Retrieve code.
1962 ;; Get position after ending blank lines.
1972 :begin begin
1973 :end end
1974 :number-lines number-lines
1975 :preserve-indent preserve-indent
1976 :retain-labels retain-labels
1977 :use-labels use-labels
1978 :label-fmt label-fmt
1979 :hiddenp hidden
1980 :value value
1985 "Interpret SRC-BLOCK element as Org syntax.
1986 CONTENTS is nil."
2006 value
2010 ;;;; Table
2013 "Parse a table at point.
2015 LIMIT bounds the search.
2017 Return a list whose CAR is `table' and CDR is a plist containing
2018 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2019 `:contents-end', `:value' and `:post-blank' keywords.
2021 Assume point is at the beginning of the table."
2033 acc))
2040 :end end
2041 :type type
2042 :tblfm tblfm
2043 ;; Only `org' tables have contents. `table.el' tables
2044 ;; use a `:value' property to store raw table as
2045 ;; a string.
2050 table-begin table-end))
2055 "Interpret TABLE element as Org syntax.
2056 CONTENTS is nil."
2067 ;;;; Table Row
2070 "Parse table row at point.
2072 LIMIT bounds the search.
2074 Return a list whose CAR is `table-row' and CDR is a plist
2075 containing `:begin', `:end', `:contents-begin', `:contents-end',
2076 `:type' and `:post-blank' keywords."
2080 ;; A table rule has no contents. In that case, ensure
2081 ;; CONTENTS-BEGIN matches CONTENTS-END.
2093 :begin begin
2094 :end end
2095 :contents-begin contents-begin
2096 :contents-end contents-end
2100 "Interpret TABLE-ROW element as Org syntax.
2101 CONTENTS is the contents of the table row."
2106 ;;;; Verse Block
2109 "Parse a verse block.
2111 LIMIT bounds the search.
2113 Return a list whose CAR is `verse-block' and CDR is a plist
2114 containing `:begin', `:end', `:contents-begin', `:contents-end',
2115 `:hiddenp' and `:post-blank' keywords.
2117 Assume point is at beginning of the block."
2121 ;; Incomplete block: parse it as a comment.
2137 :end end
2138 :contents-begin contents-begin
2139 :contents-end contents-end
2140 :hiddenp hidden
2145 "Interpret VERSE-BLOCK element as Org syntax.
2146 CONTENTS is verse block contents."
2150 \f
2151 ;;; Objects
2152 ;;
2153 ;; Unlike to elements, interstices can be found between objects.
2154 ;; That's why, along with the parser, successor functions are provided
2155 ;; for each object. Some objects share the same successor (i.e. `code'
2156 ;; and `verbatim' objects).
2157 ;;
2158 ;; A successor must accept a single argument bounding the search. It
2159 ;; will return either a cons cell whose CAR is the object's type, as
2160 ;; a symbol, and CDR the position of its next occurrence, or nil.
2161 ;;
2162 ;; Successors follow the naming convention:
2163 ;; org-element-NAME-successor, where NAME is the name of the
2164 ;; successor, as defined in `org-element-all-successors'.
2165 ;;
2166 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2167 ;; object types they can contain will be specified in
2168 ;; `org-element-object-restrictions'.
2169 ;;
2170 ;; Adding a new type of object is simple. Implement a successor,
2171 ;; a parser, and an interpreter for it, all following the naming
2172 ;; convention. Register type in `org-element-all-objects' and
2173 ;; successor in `org-element-all-successors'. Maybe tweak
2174 ;; restrictions about it, and that's it.
2177 ;;;; Bold
2180 "Parse bold object at point.
2182 Return a list whose CAR is `bold' and CDR is a plist with
2183 `:begin', `:end', `:contents-begin' and `:contents-end' and
2184 `:post-blank' keywords.
2186 Assume point is at the first star marker."
2198 :end end
2199 :contents-begin contents-begin
2200 :contents-end contents-end
2204 "Interpret BOLD object as Org syntax.
2205 CONTENTS is the contents of the object."
2209 "Search for the next text-markup object.
2211 LIMIT bounds the search.
2213 Return value is a cons cell whose CAR is a symbol among `bold',
2214 `italic', `underline', `strike-through', `code' and `verbatim'
2215 and CDR is beginning position."
2231 ;;;; Code
2234 "Parse code object at point.
2236 Return a list whose CAR is `code' and CDR is a plist with
2237 `:value', `:begin', `:end' and `:post-blank' keywords.
2239 Assume point is at the first tilde marker."
2250 :begin begin
2251 :end end
2255 "Interpret CODE object as Org syntax.
2256 CONTENTS is nil."
2260 ;;;; Entity
2263 "Parse entity at point.
2265 Return a list whose CAR is `entity' and CDR a plist with
2266 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2267 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2268 keywords.
2270 Assume point is at the beginning of the entity."
2272 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2288 :begin begin
2289 :end end
2290 :use-brackets-p bracketsp
2294 "Interpret ENTITY object as Org syntax.
2295 CONTENTS is nil."
2301 "Search for the next latex-fragment or entity object.
2303 LIMIT bounds the search.
2305 Return value is a cons cell whose CAR is `entity' or
2306 `latex-fragment' and CDR is beginning position."
2309 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2316 limit t)
2319 ;; Determine if it's a real entity or a LaTeX command.
2322 ;; No entity nor command: point is at a LaTeX fragment.
2323 ;; Determine its type to get the correct beginning position.
2331 matchers)
2335 ;;;; Export Snippet
2338 "Parse export snippet at point.
2340 Return a list whose CAR is `export-snippet' and CDR a plist with
2341 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2342 keywords.
2344 Assume point is at the beginning of the snippet."
2356 :value value
2357 :begin begin
2358 :end end
2362 "Interpret EXPORT-SNIPPET object as Org syntax.
2363 CONTENTS is nil."
2369 "Search for the next export-snippet object.
2371 LIMIT bounds the search.
2373 Return value is a cons cell whose CAR is `export-snippet' and CDR
2374 its beginning position."
2383 ;;;; Footnote Reference
2386 "Parse footnote reference at point.
2388 Return a list whose CAR is `footnote-reference' and CDR a plist
2389 with `:label', `:type', `:inline-definition', `:begin', `:end'
2390 and `:post-blank' as keywords."
2412 :type type
2413 :begin begin
2414 :end end
2417 footnote-reference :inline-definition
2422 footnote-reference))))))
2425 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2426 CONTENTS is nil."
2436 "Search for the next footnote-reference object.
2438 LIMIT bounds the search.
2440 Return value is a cons cell whose CAR is `footnote-reference' and
2441 CDR is beginning position."
2455 ;;;; Inline Babel Call
2458 "Parse inline babel call at point.
2460 Return a list whose CAR is `inline-babel-call' and CDR a plist
2461 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2463 Assume point is at the beginning of the babel call."
2474 :end end
2475 :info info
2479 "Interpret INLINE-BABEL-CALL object as Org syntax.
2480 CONTENTS is nil."
2486 ;; Remove redundant square brackets.
2489 main-source)
2493 "Search for the next inline-babel-call object.
2495 LIMIT bounds the search.
2497 Return value is a cons cell whose CAR is `inline-babel-call' and
2498 CDR is beginning position."
2500 ;; Use a simplified version of
2501 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2503 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2504 limit t)
2508 ;;;; Inline Src Block
2511 "Parse inline source block at point.
2513 LIMIT bounds the search.
2515 Return a list whose CAR is `inline-src-block' and CDR a plist
2516 with `:begin', `:end', `:language', `:value', `:parameters' and
2517 `:post-blank' as keywords.
2519 Assume point is at the beginning of the inline src block."
2532 :value value
2533 :parameters parameters
2534 :begin begin
2535 :end end
2539 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2540 CONTENTS is nil."
2545 language
2547 body)))
2550 "Search for the next inline-babel-call element.
2552 LIMIT bounds the search.
2554 Return value is a cons cell whose CAR is `inline-babel-call' and
2555 CDR is beginning position."
2560 ;;;; Italic
2563 "Parse italic object at point.
2565 Return a list whose CAR is `italic' and CDR is a plist with
2566 `:begin', `:end', `:contents-begin' and `:contents-end' and
2567 `:post-blank' keywords.
2569 Assume point is at the first slash marker."
2581 :end end
2582 :contents-begin contents-begin
2583 :contents-end contents-end
2587 "Interpret ITALIC object as Org syntax.
2588 CONTENTS is the contents of the object."
2592 ;;;; Latex Fragment
2595 "Parse latex fragment at point.
2597 Return a list whose CAR is `latex-fragment' and CDR a plist with
2598 `:value', `:begin', `:end', and `:post-blank' as keywords.
2600 Assume point is at the beginning of the latex fragment."
2614 ;; None found: it's a macro.
2623 :begin begin
2624 :end end
2628 "Interpret LATEX-FRAGMENT object as Org syntax.
2629 CONTENTS is nil."
2632 ;;;; Line Break
2635 "Parse line break at point.
2637 Return a list whose CAR is `line-break', and CDR a plist with
2638 `:begin', `:end' and `:post-blank' keywords.
2640 Assume point is at the beginning of the line break."
2644 "Interpret LINE-BREAK object as Org syntax.
2645 CONTENTS is nil."
2649 "Search for the next line-break object.
2651 LIMIT bounds the search.
2653 Return value is a cons cell whose CAR is `line-break' and CDR is
2654 beginning position."
2658 ;; A line break can only happen on a non-empty line.
2663 ;;;; Link
2666 "Parse link at point.
2668 Return a list whose CAR is `link' and CDR a plist with `:type',
2669 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2670 `:contents-end' and `:post-blank' as keywords.
2672 Assume point is at the beginning of the link."
2675 end contents-begin contents-end link-end post-blank path type
2676 raw-link link)
2678 ;; Type 1: Text targeted from a radio target.
2683 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2688 ;; RAW-LINK is the original link.
2693 ;; Determine TYPE of link and set PATH accordingly.
2695 ;; File type.
2698 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2701 ;; Id type: PATH is the id.
2704 ;; Code-ref type: PATH is the name of the reference.
2707 ;; Custom-id type: PATH is the name of the custom id.
2710 ;; Fuzzy type: Internal link either matches a target, an
2711 ;; headline name or nothing. PATH is the target or
2712 ;; headline's name.
2714 ;; Type 3: Plain link, i.e. http://orgmode.org
2720 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2727 ;; In any case, deduce end point after trailing white space from
2728 ;; LINK-END variable.
2733 :path path
2735 :begin begin
2736 :end end
2737 :contents-begin contents-begin
2738 :contents-end contents-end
2742 "Interpret LINK object as Org syntax.
2743 CONTENTS is the contents of the object, or nil."
2748 raw-link
2752 "Search for the next link object.
2754 LIMIT bounds the search.
2756 Return value is a cons cell whose CAR is `link' and CDR is
2757 beginning position."
2766 ;;;; Macro
2769 "Parse macro at point.
2771 Return a list whose CAR is `macro' and CDR a plist with `:key',
2772 `:args', `:begin', `:end', `:value' and `:post-blank' as
2773 keywords.
2775 Assume point is at the macro."
2789 ;; Repair bad splits.
2797 :value value
2798 :args args
2799 :begin begin
2800 :end end
2804 "Interpret MACRO object as Org syntax.
2805 CONTENTS is nil."
2809 "Search for the next macro object.
2811 LIMIT bounds the search.
2813 Return value is cons cell whose CAR is `macro' and CDR is
2814 beginning position."
2818 limit t)
2822 ;;;; Radio-target
2825 "Parse radio target at point.
2827 Return a list whose CAR is `radio-target' and CDR a plist with
2828 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2829 and `:post-blank' as keywords.
2831 Assume point is at the radio target."
2843 :end end
2844 :contents-begin contents-begin
2845 :contents-end contents-end
2846 :post-blank post-blank
2850 "Interpret TARGET object as Org syntax.
2851 CONTENTS is the contents of the object."
2855 "Search for the next radio-target object.
2857 LIMIT bounds the search.
2859 Return value is a cons cell whose CAR is `radio-target' and CDR
2860 is beginning position."
2866 ;;;; Statistics Cookie
2869 "Parse statistics cookie at point.
2871 Return a list whose CAR is `statistics-cookie', and CDR a plist
2872 with `:begin', `:end', `:value' and `:post-blank' keywords.
2874 Assume point is at the beginning of the statistics-cookie."
2885 :end end
2886 :value value
2890 "Interpret STATISTICS-COOKIE object as Org syntax.
2891 CONTENTS is nil."
2895 "Search for the next statistics cookie object.
2897 LIMIT bounds the search.
2899 Return value is a cons cell whose CAR is `statistics-cookie' and
2900 CDR is beginning position."
2906 ;;;; Strike-Through
2909 "Parse strike-through object at point.
2911 Return a list whose CAR is `strike-through' and CDR is a plist
2912 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2913 `:post-blank' keywords.
2915 Assume point is at the first plus sign marker."
2927 :end end
2928 :contents-begin contents-begin
2929 :contents-end contents-end
2933 "Interpret STRIKE-THROUGH object as Org syntax.
2934 CONTENTS is the contents of the object."
2938 ;;;; Subscript
2941 "Parse subscript at point.
2943 Return a list whose CAR is `subscript' and CDR a plist with
2944 `:begin', `:end', `:contents-begin', `:contents-end',
2945 `:use-brackets-p' and `:post-blank' as keywords.
2947 Assume point is at the underscore."
2951 t
2962 :end end
2963 :use-brackets-p bracketsp
2964 :contents-begin contents-begin
2965 :contents-end contents-end
2969 "Interpret SUBSCRIPT object as Org syntax.
2970 CONTENTS is the contents of the object."
2973 contents))
2976 "Search for the next sub/superscript object.
2978 LIMIT bounds the search.
2980 Return value is a cons cell whose CAR is either `subscript' or
2981 `superscript' and CDR is beginning position."
2988 ;;;; Superscript
2991 "Parse superscript at point.
2993 Return a list whose CAR is `superscript' and CDR a plist with
2994 `:begin', `:end', `:contents-begin', `:contents-end',
2995 `:use-brackets-p' and `:post-blank' as keywords.
2997 Assume point is at the caret."
3011 :end end
3012 :use-brackets-p bracketsp
3013 :contents-begin contents-begin
3014 :contents-end contents-end
3018 "Interpret SUPERSCRIPT object as Org syntax.
3019 CONTENTS is the contents of the object."
3022 contents))
3025 ;;;; Table Cell
3028 "Parse table cell at point.
3030 Return a list whose CAR is `table-cell' and CDR is a plist
3031 containing `:begin', `:end', `:contents-begin', `:contents-end'
3032 and `:post-blank' keywords."
3040 :end end
3041 :contents-begin contents-begin
3042 :contents-end contents-end
3046 "Interpret TABLE-CELL element as Org syntax.
3047 CONTENTS is the contents of the cell, or nil."
3051 "Search for the next table-cell object.
3053 LIMIT bounds the search.
3055 Return value is a cons cell whose CAR is `table-cell' and CDR is
3056 beginning position."
3060 ;;;; Target
3063 "Parse target at point.
3065 Return a list whose CAR is `target' and CDR a plist with
3066 `:begin', `:end', `:value' and `:post-blank' as keywords.
3068 Assume point is at the target."
3078 :end end
3079 :value value
3083 "Interpret TARGET object as Org syntax.
3084 CONTENTS is nil."
3088 "Search for the next target object.
3090 LIMIT bounds the search.
3092 Return value is a cons cell whose CAR is `target' and CDR is
3093 beginning position."
3099 ;;;; Timestamp
3102 "Parse time stamp at point.
3104 Return a list whose CAR is `timestamp', and CDR a plist with
3105 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3107 Assume point is at the beginning of the timestamp."
3126 :value main-value
3127 :range-end range-end
3128 :begin begin
3129 :end end
3133 "Interpret TIMESTAMP object as Org syntax.
3134 CONTENTS is nil."
3143 range-end)))))))
3146 "Search for the next timestamp object.
3148 LIMIT bounds the search.
3150 Return value is a cons cell whose CAR is `timestamp' and CDR is
3151 beginning position."
3159 limit t)
3163 ;;;; Underline
3166 "Parse underline object at point.
3168 Return a list whose CAR is `underline' and CDR is a plist with
3169 `:begin', `:end', `:contents-begin' and `:contents-end' and
3170 `:post-blank' keywords.
3172 Assume point is at the first underscore marker."
3184 :end end
3185 :contents-begin contents-begin
3186 :contents-end contents-end
3190 "Interpret UNDERLINE object as Org syntax.
3191 CONTENTS is the contents of the object."
3195 ;;;; Verbatim
3198 "Parse verbatim object at point.
3200 Return a list whose CAR is `verbatim' and CDR is a plist with
3201 `:value', `:begin', `:end' and `:post-blank' keywords.
3203 Assume point is at the first equal sign marker."
3214 :begin begin
3215 :end end
3219 "Interpret VERBATIM object as Org syntax.
3220 CONTENTS is nil."
3224 \f
3225 ;;; Parsing Element Starting At Point
3226 ;;
3227 ;; `org-element--current-element' is the core function of this section.
3228 ;; It returns the Lisp representation of the element starting at
3229 ;; point.
3230 ;;
3231 ;; `org-element--current-element' makes use of special modes. They
3232 ;; are activated for fixed element chaining (i.e. `plain-list' >
3233 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3234 ;; `section'). Special modes are: `first-section', `section',
3235 ;; `quote-section', `item' and `table-row'.
3239 "Parse the element starting at point.
3241 LIMIT bounds the search.
3243 Return value is a list like (TYPE PROPS) where TYPE is the type
3244 of the element and PROPS a plist of properties associated to the
3245 element.
3247 Possible types are defined in `org-element-all-elements'.
3249 Optional argument GRANULARITY determines the depth of the
3250 recursion. Allowed values are `headline', `greater-element',
3251 `element', `object' or nil. When it is broader than `object' (or
3252 nil), secondary values will not be parsed, since they only
3253 contain objects.
3255 Optional argument SPECIAL, when non-nil, can be either
3256 `first-section', `section', `quote-section', `table-row' and
3257 `item'.
3259 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3260 be computed.
3262 This function assumes point is always at the beginning of the
3263 element it has to parse."
3265 ;; If point is at an affiliated keyword, try moving to the
3266 ;; beginning of the associated element. If none is found, the
3267 ;; keyword is orphaned and will be treated as plain text.
3273 ;; Determine if parsing depth allows for secondary strings
3274 ;; parsing. It only applies to elements referenced in
3275 ;; `org-element-secondary-value-alist'.
3278 ;; Item.
3281 ;; Quote Section.
3283 ;; Table Row.
3285 ;; Headline.
3288 ;; Section (must be checked after headline).
3293 limit)))
3294 ;; Planning and Clock.
3299 ;; Inlinetask.
3302 ;; LaTeX Environment.
3308 nil t))
3311 ;; Drawer and Property Drawer.
3321 ;; Fixed Width
3324 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3325 ;; Keywords.
3331 org-element-block-name-alist)))
3346 ;; Footnote Definition.
3349 ;; Horizontal Rule.
3352 ;; Table.
3354 ;; List.
3357 ;; Default element: Paragraph.
3361 ;; Most elements can have affiliated keywords. When looking for an
3362 ;; element beginning, we want to move before them, as they belong to
3363 ;; that element, and, in the meantime, collect information they give
3364 ;; into appropriate properties. Hence the following function.
3365 ;;
3366 ;; Usage of optional arguments may not be obvious at first glance:
3367 ;;
3368 ;; - TRANS-LIST is used to polish keywords names that have evolved
3369 ;; during Org history. In example, even though =result= and
3370 ;; =results= coexist, we want to have them under the same =result=
3371 ;; property. It's also true for "srcname" and "name", where the
3372 ;; latter seems to be preferred nowadays (thus the "name" property).
3373 ;;
3374 ;; - CONSED allows to regroup multi-lines keywords under the same
3375 ;; property, while preserving their own identity. This is mostly
3376 ;; used for "attr_latex" and al.
3377 ;;
3378 ;; - PARSED prepares a keyword value for export. This is useful for
3379 ;; "caption". Objects restrictions for such keywords are defined in
3380 ;; `org-element-object-restrictions'.
3381 ;;
3382 ;; - DUALS is used to take care of keywords accepting a main and an
3383 ;; optional secondary values. For example "results" has its
3384 ;; source's name as the main value, and may have an hash string in
3385 ;; optional square brackets as the secondary one.
3386 ;;
3387 ;; A keyword may belong to more than one category.
3391 "Collect affiliated keywords before point.
3393 Optional argument KEY-RE is a regexp matching keywords, which
3394 puts matched keyword in group 1. It defaults to
3395 `org-element--affiliated-re'.
3397 TRANS-LIST is an alist where key is the keyword and value the
3398 property name it should be translated to, without the colons. It
3399 defaults to `org-element-keyword-translation-alist'.
3401 CONSED is a list of strings. Any keyword belonging to that list
3402 will have its value consed. The check is done after keyword
3403 translation. It defaults to `org-element-multiple-keywords'.
3405 PARSED is a list of strings. Any keyword member of this list
3406 will have its value parsed. The check is done after keyword
3407 translation. If a keyword is a member of both CONSED and PARSED,
3408 it's value will be a list of parsed strings. It defaults to
3409 `org-element-parsed-keywords'.
3411 DUALS is a list of strings. Any keyword member of this list can
3412 have two parts: one mandatory and one optional. Its value is
3413 a cons cell whose CAR is the former, and the CDR the latter. If
3414 a keyword is a member of both PARSED and DUALS, both values will
3415 be parsed. It defaults to `org-element-dual-keywords'.
3417 Return a list whose CAR is the position at the first of them and
3418 CDR a plist of keywords and values."
3426 ;; RESTRICT is the list of objects allowed in parsed
3427 ;; keywords value.
3429 output)
3433 ;; Apply translation to RAW-KWD. From there, KWD is
3434 ;; the official keyword.
3436 ;; Find main value for any keyword.
3442 ;; If KWD is a dual keyword, find its secondary
3443 ;; value. Maybe parse it.
3449 ;; Attribute a property name to KWD.
3451 ;; Now set final shape for VALUE.
3455 ;; VALUE is mandatory. Set it to nil if there is none.
3457 ;; Attributes are always consed.
3460 ;; Eventually store the new value in OUTPUT.
3466 \f
3467 ;;; The Org Parser
3468 ;;
3469 ;; The two major functions here are `org-element-parse-buffer', which
3470 ;; parses Org syntax inside the current buffer, taking into account
3471 ;; region, narrowing, or even visibility if specified, and
3472 ;; `org-element-parse-secondary-string', which parses objects within
3473 ;; a given string.
3474 ;;
3475 ;; The (almost) almighty `org-element-map' allows to apply a function
3476 ;; on elements or objects matching some type, and accumulate the
3477 ;; resulting values. In an export situation, it also skips unneeded
3478 ;; parts of the parse tree.
3481 "Recursively parse the buffer and return structure.
3482 If narrowing is in effect, only parse the visible part of the
3483 buffer.
3485 Optional argument GRANULARITY determines the depth of the
3486 recursion. It can be set to the following symbols:
3488 `headline' Only parse headlines.
3489 `greater-element' Don't recurse into greater elements excepted
3490 headlines and sections. Thus, elements
3491 parsed are the top-level ones.
3492 `element' Parse everything but objects and plain text.
3493 `object' Parse the complete buffer (default).
3495 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3496 elements.
3498 Assume buffer is in Org mode."
3504 ;; Start in `first-section' mode so text before the first
3505 ;; headline belongs to a section.
3509 "Recursively parse objects in STRING and return structure.
3511 RESTRICTION is a symbol limiting the object types that will be
3512 looked after.
3514 Optional argument PARENT, when non-nil, is the element or object
3515 containing the secondary string. It is used to set correctly
3516 `:parent' property within the string."
3522 secondary))))
3525 "Map a function on selected elements or objects.
3527 DATA is the parsed tree, as returned by, i.e,
3528 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3529 of elements or objects types. FUN is the function called on the
3530 matching element or object. It must accept one arguments: the
3531 element or object itself.
3533 When optional argument INFO is non-nil, it should be a plist
3534 holding export options. In that case, parts of the parse tree
3535 not exportable according to that property list will be skipped.
3537 When optional argument FIRST-MATCH is non-nil, stop at the first
3538 match for which FUN doesn't return nil, and return that value.
3540 Optional argument NO-RECURSION is a symbol or a list of symbols
3541 representing elements or objects types. `org-element-map' won't
3542 enter any recursive element or object whose type belongs to that
3543 list. Though, FUN can still be applied on them.
3545 Nil values returned from FUN do not appear in the results."
3546 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3549 ;; Recursion depth is determined by --CATEGORY.
3556 ;; If one object is found, the function
3557 ;; has to recurse into every object.
3560 ;; If one regular element is found, the
3561 ;; function has to recurse, at lest, into
3562 ;; every element it encounters.
3565 types)
3566 category)))
3567 --acc
3568 --walk-tree
3572 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3573 ;; holding contextual information.
3577 ;; Ignored element in an export context.
3579 ;; Secondary string: only objects can be found there.
3582 ;; Unconditionally enter parse trees.
3586 ;; Check if TYPE is matching among TYPES. If so,
3587 ;; apply FUN to --DATA and accumulate return value
3588 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3594 ;; If --DATA has a secondary string that can contain
3595 ;; objects with their type among TYPES, look into it.
3602 ;; Determine if a recursion into --DATA is possible.
3604 ;; --TYPE is explicitly removed from recursion.
3606 ;; --DATA has no contents.
3608 ;; Looking for greater elements but --DATA is simply
3609 ;; an element or an object.
3612 ;; Looking for elements but --DATA is an object.
3615 ;; In any other case, map contents.
3619 ;; Return value in a proper order.
3622 ;; The following functions are internal parts of the parser.
3623 ;;
3624 ;; The first one, `org-element--parse-elements' acts at the element's
3625 ;; level.
3626 ;;
3627 ;; The second one, `org-element--parse-objects' applies on all objects
3628 ;; of a paragraph or a secondary string. It uses
3629 ;; `org-element--get-next-object-candidates' to optimize the search of
3630 ;; the next object in the buffer.
3631 ;;
3632 ;; More precisely, that function looks for every allowed object type
3633 ;; first. Then, it discards failed searches, keeps further matches,
3634 ;; and searches again types matched behind point, for subsequent
3635 ;; calls. Thus, searching for a given type fails only once, and every
3636 ;; object is searched only once at top level (but sometimes more for
3637 ;; nested types).
3641 "Parse elements between BEG and END positions.
3643 SPECIAL prioritize some elements over the others. It can be set
3644 to `first-section', `quote-section', `section' `item' or
3645 `table-row'.
3647 When value is `item', STRUCTURE will be used as the current list
3648 structure.
3650 GRANULARITY determines the depth of the recursion. See
3651 `org-element-parse-buffer' for more information.
3653 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3654 elements.
3656 Elements are accumulated into ACC."
3659 ;; When parsing only headlines, skip any text before first one.
3662 ;; Main loop start.
3664 ;; Find current element's type and parse it accordingly to
3665 ;; its category.
3667 end granularity special structure))
3671 ;; Fill ELEMENT contents by side-effect.
3673 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3674 ;; no contents, don't modify it.
3677 ;; Greater element: parse it between `contents-begin' and
3678 ;; `contents-end'. Make sure GRANULARITY allows the
3679 ;; recursion, or ELEMENT is an headline, in which case going
3680 ;; inside is mandatory, in order to get sub-level headings.
3688 ;; Possibly switch to a special mode.
3696 granularity visible-only element))
3697 ;; ELEMENT has contents. Parse objects inside, if
3698 ;; GRANULARITY allows it.
3704 ;; Return result.
3705 acc))
3708 "Parse objects between BEG and END and return recursive structure.
3710 Objects are accumulated in ACC.
3712 RESTRICTION is a list of object types which are allowed in the
3713 current object."
3719 end restriction candidates)))
3726 ;; 1. Text before any object. Untabify it.
3731 acc
3735 ;; 2. Object...
3738 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3739 ;; a recursive type.
3744 cont-beg
3751 ;; 3. Text after last object. Untabify it.
3755 acc
3759 ;; Result.
3760 acc)))
3763 "Return an alist of candidates for the next object.
3765 LIMIT bounds the search, and RESTRICTION narrows candidates to
3766 some object types.
3768 Return value is an alist whose CAR is position and CDR the object
3769 type, as a symbol.
3771 OBJECTS is the previous candidates alist."
3773 ;; If no previous result, search every object type in RESTRICTION.
3774 ;; Otherwise, keep potential candidates (old objects located after
3775 ;; point) and ask to search again those which had matched before.
3780 objects))
3781 ;; Call the appropriate successor function for each type to search
3782 ;; and accumulate matches.
3789 type))))
3792 types-to-search)
3793 ;; Return alist.
3794 next-candidates))
3797 \f
3798 ;;; Towards A Bijective Process
3799 ;;
3800 ;; The parse tree obtained with `org-element-parse-buffer' is really
3801 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3802 ;; interpreted and expanded into a string with canonical Org syntax.
3803 ;; Hence `org-element-interpret-data'.
3804 ;;
3805 ;; The function relies internally on
3806 ;; `org-element--interpret-affiliated-keywords'.
3809 "Interpret DATA as Org syntax.
3811 DATA is a parse tree, an element, an object or a secondary string
3812 to interpret.
3814 Optional argument PARENT is used for recursive calls. It contains
3815 the element or object containing data, or nil.
3817 Return Org syntax as a string."
3821 ;; Secondary string.
3826 ;; Full Org document.
3831 ;; Plain text.
3833 ;; Element/Object without contents.
3836 data nil))
3837 ;; Element/Object with contents.
3847 ;; Elements directly containing objects must
3848 ;; have their indentation normalized first.
3850 data
3851 ;; When normalizing first paragraph of an
3852 ;; item or a footnote-definition, ignore
3853 ;; first line's indentation.
3860 data
3862 contents)))))))
3864 ;; Build white spaces. If no `:post-blank' property is
3865 ;; specified, assume its value is 0.
3875 "Return ELEMENT's affiliated keywords as Org syntax.
3876 If there is no affiliated keyword, return the empty string."
3886 ": "
3889 value)
3897 ;; All attribute keywords can have multiple lines.
3900 value
3903 ;; List all ELEMENT's properties matching an attribute line or an
3904 ;; affiliated keyword, but ignore translated keywords since they
3905 ;; cannot belong to the property list.
3912 org-element-keyword-translation-alist)))))
3913 collect prop)
3916 ;; Because interpretation of the parse tree must return the same
3917 ;; number of blank lines between elements and the same number of white
3918 ;; space after objects, some special care must be given to white
3919 ;; spaces.
3920 ;;
3921 ;; The first function, `org-element-normalize-string', ensures any
3922 ;; string different from the empty string will end with a single
3923 ;; newline character.
3924 ;;
3925 ;; The second function, `org-element-normalize-contents', removes
3926 ;; global indentation from the contents of the current element.
3929 "Ensure string S ends with a single newline character.
3931 If S isn't a string return it unchanged. If S is the empty
3932 string, return it. Otherwise, return a new string with a single
3933 newline character at its end."
3941 "Normalize plain text in ELEMENT's contents.
3943 ELEMENT must only contain plain text and objects.
3945 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3946 indentation to compute maximal common indentation.
3948 Return the normalized element that is element with global
3949 indentation removed from its contents. The function assumes that
3950 indentation is not done with TAB characters."
3952 collect-inds ; for byte-compiler
3955 ;; Return list of indentations within BLOB. This is done by
3956 ;; walking recursively BLOB and updating IND-LIST along the
3957 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3958 ;; been seen yet. It is required as this string is the only
3959 ;; one whose indentation doesn't happen after a newline
3960 ;; character.
3968 ;; An indentation of zero means no string will be
3969 ;; modified. Quit the process.
3975 ;; Avoid matching blank or empty lines.
3983 ;; Collect indentation list in ELEMENT. Possibly remove first
3984 ;; value if IGNORE-FIRST is non-nil.
3987 ;; Build ELEMENT back, replacing each string with the same
3988 ;; string minus common indentation.
3993 ;; Return BLOB with all its strings indentation
3994 ;; shortened from MCI white spaces. FIRST-FLAG is
3995 ;; non-nil when the first string hasn't been seen
3996 ;; yet.
4010 org-element-recursive-objects)
4014 blob))))
4018 \f
4019 ;;; The Toolbox
4020 ;;
4021 ;; The first move is to implement a way to obtain the smallest element
4022 ;; containing point. This is the job of `org-element-at-point'. It
4023 ;; basically jumps back to the beginning of section containing point
4024 ;; and moves, element after element, with
4025 ;; `org-element--current-element' until the container is found. Note:
4026 ;; When using `org-element-at-point', secondary values are never
4027 ;; parsed since the function focuses on elements, not on objects.
4028 ;;
4029 ;; At a deeper level, `org-element-context' lists all elements and
4030 ;; objects containing point.
4031 ;;
4032 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4033 ;; internally by navigation and manipulation tools.
4035 ;;;###autoload
4037 "Determine closest element around point.
4039 Return value is a list like (TYPE PROPS) where TYPE is the type
4040 of the element and PROPS a plist of properties associated to the
4041 element.
4043 Possible types are defined in `org-element-all-elements'.
4044 Properties depend on element or object type, but always
4045 include :begin, :end, :parent and :post-blank properties.
4047 As a special case, if point is at the very beginning of a list or
4048 sub-list, returned element will be that list instead of the first
4049 item. In the same way, if point is at the beginning of the first
4050 row of a table, returned element will be the table instead of the
4051 first row.
4053 If optional argument KEEP-TRAIL is non-nil, the function returns
4054 a list of of elements leading to element at point. The list's
4055 CAR is always the element at point. Following positions contain
4056 element's siblings, then parents, siblings of parents, until the
4057 first element of current section."
4059 ;; If at an headline, parse it. It is the sole element that
4060 ;; doesn't require to know about context. Be sure to disallow
4061 ;; secondary string parsing, though.
4067 ;; Otherwise move at the beginning of the section containing
4068 ;; point.
4072 element type special-flag trail struct prevs parent)
4080 ;; Parse successively each element, skipping those ending
4081 ;; before original position.
4090 ;; 1. Skip any element ending before point. Also skip
4091 ;; element ending at point when we're sure that another
4092 ;; element has started.
4097 ;; 2. An element containing point is always the element at
4098 ;; point.
4101 ;; 3. At any other greater element type, if point is
4102 ;; within contents, move into it.
4107 ;; Create an anchor for tables and plain lists:
4108 ;; when point is at the very beginning of these
4109 ;; elements, ignoring affiliated keywords,
4110 ;; target them instead of their contents.
4112 ;; When point is at contents end, do not move
4113 ;; into elements with an explicit ending, but
4114 ;; return that element instead.
4118 drawer dynamic-block inlinetask item
4119 plain-list quote-block special-block))))
4132 "Return closest element or object around point.
4134 Return value is a list like (TYPE PROPS) where TYPE is the type
4135 of the element or object and PROPS a plist of properties
4136 associated to it.
4138 Possible types are defined in `org-element-all-elements' and
4139 `org-element-all-objects'. Properties depend on element or
4140 object type, but always include :begin, :end, :parent
4141 and :post-blank properties."
4146 end)
4147 ;; Check if point is inside an element containing objects or at
4148 ;; a secondary string. In that case, move to beginning of the
4149 ;; element or secondary string and set END to the other side.
4158 (<= origin
4159 ;; `1+' is required so some
4160 ;; successors can match
4161 ;; properly their object.
4175 element
4178 candidates)
4181 end restriction candidates))
4183 candidates)))
4184 ;; If ORIGIN is before next object in element, there's
4185 ;; no point in looking further.
4194 ;; ORIGIN is after OBJECT, so skip it.
4197 ;; ORIGIN is within a non-recursive object or at an
4198 ;; object boundaries: Return that object.
4202 ;; Otherwise, move within current object and restrict
4203 ;; search to the end of its contents.
4207 parent))))))
4210 "Non-nil when elements ELEM-A and ELEM-B are nested."
4219 "Swap elements ELEM-A and ELEM-B.
4220 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4221 end of ELEM-A."
4223 ;; There are two special cases when an element doesn't start at bol:
4224 ;; the first paragraph in an item or in a footnote definition.
4226 ;; Only a paragraph without any affiliated keyword can be moved at
4227 ;; ELEM-A position in such a situation. Note that the case of
4228 ;; a footnote definition is impossible: it cannot contain two
4229 ;; paragraphs in a row because it cannot contain a blank line.
4235 ;; In a special situation, ELEM-A will have no indentation. We'll
4236 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4250 ;; Store overlays responsible for visibility status. We
4251 ;; also need to store their boundaries as they will be
4252 ;; removed from buffer.
4259 ;; Get contents.
4267 ;; Restore ex ELEM-A overlays.
4276 ;; Restore ex ELEM-B overlays.
4285 ;;; org-element.el ends here