| blob | f2c87deac055ca6c97a4b7e5ec71b06267e70f48 |
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 "List of affiliated keywords as strings.
226 ;; Regular affiliated keywords.
229 "Regexp matching any affiliated keyword.
231 Keyword name is put in match group 1. Moreover, if keyword
232 belongs to `org-element-dual-keywords', put the dual value in
233 match group 2.
241 "Alist of usual translations for keywords.
242 The key is the old name and the value the new one. The property
246 "List of affiliated keywords that can occur more that once in an element.
248 Their value will be consed into a list of strings, which will be
249 returned as the value of the property.
251 This list is checked after translations have been applied. See
252 `org-element-keyword-translation-alist'.
258 "List of keywords whose value can be parsed.
260 Their value will be stored as a secondary string: a list of
261 strings and objects.
263 This list is checked after translations have been applied. See
267 "List of keywords which can have a secondary value.
269 In Org syntax, they can be written with optional square brackets
270 before the colons. For example, results keyword can be
271 associated to a hash value with the following:
273 #+RESULTS[hash-string]: some-source
275 This list is checked after translations have been applied. See
282 inline-src-block latex-or-entity line-break link macro
283 radio-target sub/superscript target text-markup
284 timestamp)
286 radio-target statistics-cookie sub/superscript target text-markup
287 timestamp)
299 inline-src-block latex-or-entity line-break link macro
300 radio-target statistics-cookie sub/superscript target text-markup
301 timestamp)
304 latex-or-entity link radio-target sub/superscript target
305 text-markup timestamp)
316 latex-or-entity line-break link macro radio-target
318 "Alist of objects restrictions.
320 CAR is an element or object type containing objects and CDR is
321 a list of successors that will be called within an element or
322 object of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, export snippets, latex-fragments, subscript and
326 superscript.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
340 \f
341 ;;; Accessors and Setters
342 ;;
343 ;; Provide four accessors: `org-element-type', `org-element-property'
344 ;; `org-element-contents' and `org-element-restriction'.
345 ;;
346 ;; Setter functions allow to modify elements by side effect. There is
347 ;; `org-element-put-property', `org-element-set-contents',
348 ;; `org-element-set-element' and `org-element-adopt-element'. Note
349 ;; that `org-element-set-element' and `org-element-adopt-elements' are
350 ;; higher level functions since also update `:parent' property.
353 "Return type of ELEMENT.
355 The function returns the type of the element or object provided.
356 It can also return the following special value:
357 `plain-text' for a string
358 `org-data' for a complete document
359 nil in any other case."
365 "Extract the value from the PROPERTY of an ELEMENT."
369 "Extract contents from an ELEMENT."
373 "Return restriction associated to ELEMENT.
374 ELEMENT can be an element, an object or a symbol representing an
375 element or object type."
377 org-element-object-restrictions)))
380 "In ELEMENT set PROPERTY to VALUE.
381 Return modified element."
384 element)
387 "Set ELEMENT contents to CONTENTS.
388 Return modified element."
394 "Replace element or object OLD with element or object NEW.
395 The function takes care of setting `:parent' property for NEW."
396 ;; Since OLD is going to be changed into NEW by side-effect, first
397 ;; make sure that every element or object within NEW has OLD as
398 ;; parent.
401 ;; Transfer contents.
403 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
404 ;; with NEW's.
407 ;; Transfer type.
411 "Append elements to the contents of another element.
413 PARENT is an element or object. CHILDREN can be elements,
414 objects, or a strings.
416 The function takes care of setting `:parent' property for CHILD.
417 Return parent element."
419 ;; Link every child to PARENT.
423 children)
424 ;; Add CHILDREN at the end of PARENT contents.
426 parent
428 ;; Return modified PARENT element.
429 parent))
432 \f
433 ;;; Greater elements
434 ;;
435 ;; For each greater element type, we define a parser and an
436 ;; interpreter.
437 ;;
438 ;; A parser returns the element or object as the list described above.
439 ;; Most of them accepts no argument. Though, exceptions exist. Hence
440 ;; every element containing a secondary string (see
441 ;; `org-element-secondary-value-alist') will accept an optional
442 ;; argument to toggle parsing of that secondary string. Moreover,
443 ;; `item' parser requires current list's structure as its first
444 ;; element.
445 ;;
446 ;; An interpreter accepts two arguments: the list representation of
447 ;; the element or object, and its contents. The latter may be nil,
448 ;; depending on the element or object considered. It returns the
449 ;; appropriate Org syntax, as a string.
450 ;;
451 ;; Parsing functions must follow the naming convention:
452 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
453 ;; defined in `org-element-greater-elements'.
454 ;;
455 ;; Similarly, interpreting functions must follow the naming
456 ;; convention: org-element-TYPE-interpreter.
457 ;;
458 ;; With the exception of `headline' and `item' types, greater elements
459 ;; cannot contain other greater elements of their own type.
460 ;;
461 ;; Beside implementing a parser and an interpreter, adding a new
462 ;; greater element requires to tweak `org-element--current-element'.
463 ;; Moreover, the newly defined type must be added to both
464 ;; `org-element-all-elements' and `org-element-greater-elements'.
467 ;;;; Center Block
470 "Parse a center block.
472 LIMIT bounds the search.
474 Return a list whose CAR is `center-block' and CDR is a plist
475 containing `:begin', `:end', `:hiddenp', `:contents-begin',
476 `:contents-end' and `:post-blank' keywords.
478 Assume point is at the beginning of the block."
482 ;; Incomplete block: parse it as a paragraph.
487 ;; Empty blocks have no contents.
501 :end end
502 :hiddenp hidden
503 :contents-begin contents-begin
504 :contents-end contents-end
509 "Interpret CENTER-BLOCK element as Org syntax.
510 CONTENTS is the contents of the element."
514 ;;;; Drawer
517 "Parse a drawer.
519 LIMIT bounds the search.
521 Return a list whose CAR is `drawer' and CDR is a plist containing
522 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
523 `:contents-end' and `:post-blank' keywords.
525 Assume point is at beginning of drawer."
528 ;; Incomplete drawer: parse it as a paragraph.
537 ;; Empty drawers have no contents.
551 :end end
552 :drawer-name name
553 :hiddenp hidden
554 :contents-begin contents-begin
555 :contents-end contents-end
560 "Interpret DRAWER element as Org syntax.
561 CONTENTS is the contents of the element."
564 contents))
567 ;;;; Dynamic Block
570 "Parse a dynamic block.
572 LIMIT bounds the search.
574 Return a list whose CAR is `dynamic-block' and CDR is a plist
575 containing `:block-name', `:begin', `:end', `:hiddenp',
576 `:contents-begin', `:contents-end', `:arguments' and
577 `:post-blank' keywords.
579 Assume point is at beginning of dynamic block."
582 ;; Incomplete block: parse it as a paragraph.
591 ;; Empty blocks have no contents.
605 :end end
606 :block-name name
607 :arguments arguments
608 :hiddenp hidden
609 :contents-begin contents-begin
610 :contents-end contents-end
615 "Interpret DYNAMIC-BLOCK element as Org syntax.
616 CONTENTS is the contents of the element."
621 contents))
624 ;;;; Footnote Definition
627 "Parse a footnote definition.
629 LIMIT bounds the search.
631 Return a list whose CAR is `footnote-definition' and CDR is
632 a plist containing `:label', `:begin' `:end', `:contents-begin',
633 `:contents-end' and `:post-blank' keywords.
635 Assume point is at the beginning of the footnote definition."
660 :begin begin
661 :end end
662 :contents-begin contents-begin
663 :contents-end contents-end
668 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
669 CONTENTS is the contents of the footnote-definition."
671 " "
672 contents))
675 ;;;; Headline
678 "Parse an headline.
680 Return a list whose CAR is `headline' and CDR is a plist
681 containing `:raw-value', `:title', `:begin', `:end',
682 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
683 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
684 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
685 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
686 keywords.
688 The plist also contains any property set in the property drawer,
689 with its name in lowercase, the underscores replaced with hyphens
690 and colons at the beginning (i.e. `:custom-id').
692 When RAW-SECONDARY-P is non-nil, headline's title will not be
693 parsed as a secondary string, but as a plain string instead.
695 Assume point is at beginning of the headline."
714 ;; Normalize property names: ":SOME_PROP:" becomes
715 ;; ":some-prop".
727 plist))
745 ;; Clean RAW-VALUE from any quote or comment string.
750 ""
751 raw-value)))
752 ;; Clean TAGS from archive tag, if any.
758 :begin begin
759 :end end
760 :pre-blank
763 :hiddenp hidden
764 :contents-begin contents-begin
765 :contents-end contents-end
766 :level level
768 :tags tags
769 :todo-keyword todo
770 :todo-type todo-type
771 :scheduled scheduled
772 :deadline deadline
773 :timestamp timestamp
774 :clock clock
780 end)
781 :footnote-section-p footnote-section-p
782 :archivedp archivedp
783 :commentedp commentedp
785 standard-props))))
787 headline :title
793 "Interpret HEADLINE element as Org syntax.
794 CONTENTS is the contents of the element."
821 ;; Align tags.
829 ? )
830 tags))
834 tags))))
836 contents)))
839 ;;;; Inlinetask
842 "Parse an inline task.
844 Return a list whose CAR is `inlinetask' and CDR is a plist
845 containing `:title', `:begin', `:end', `:hiddenp',
846 `:contents-begin' and `:contents-end', `:level', `:priority',
847 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
848 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
850 The plist also contains any property set in the property drawer,
851 with its name in lowercase, the underscores replaced with hyphens
852 and colons at the beginning (i.e. `:custom-id').
854 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
855 title will not be parsed as a secondary string, but as a plain
856 string instead.
858 Assume point is at beginning of the inline task."
868 ;; Normalize property names: ":SOME_PROP:" becomes
869 ;; ":some-prop".
881 plist))
905 :end end
906 :hiddenp hidden
907 :contents-begin contents-begin
908 :contents-end contents-end
911 :tags tags
912 :todo-keyword todo
913 :todo-type todo-type
914 :scheduled scheduled
915 :deadline deadline
916 :timestamp timestamp
917 :clock clock
919 standard-props
922 inlinetask :title
927 inlinetask))))))
930 "Interpret INLINETASK element as Org syntax.
931 CONTENTS is the contents of inlinetask."
946 ;; Align tags.
954 ? )
955 tags))
959 tags))))
960 ;; Prefer degenerate inlinetasks when there are no
961 ;; contents.
964 contents
968 ;;;; Item
971 "Parse an item.
973 STRUCT is the structure of the plain list.
975 Return a list whose CAR is `item' and CDR is a plist containing
976 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
977 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
978 `:post-blank' keywords.
980 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
981 any, will not be parsed as a secondary string, but as a plain
982 string instead.
984 Assume point is at the beginning of the item."
1008 ;; Ignore tags in un-ordered lists: they are just
1009 ;; a part of item's body.
1015 ;; If first line isn't empty, contents really start
1016 ;; at the text after item's meta-data.
1027 :begin begin
1028 :end end
1029 ;; CONTENTS-BEGIN and CONTENTS-END may be
1030 ;; mixed up in the case of an empty item
1031 ;; separated from the next by a blank line.
1032 ;; Thus ensure the former is always the
1033 ;; smallest.
1036 :checkbox checkbox
1037 :counter counter
1038 :hiddenp hidden
1039 :structure struct
1042 item :tag
1050 "Interpret ITEM element as Org syntax.
1051 CONTENTS is the contents of the element."
1057 ;; Compute indentation.
1062 ;; Indent contents.
1064 bullet
1077 ;;;; Plain List
1080 "Parse a plain list.
1082 Optional argument STRUCTURE, when non-nil, is the structure of
1083 the plain list being parsed.
1085 Return a list whose CAR is `plain-list' and CDR is a plist
1086 containing `:type', `:begin', `:end', `:contents-begin' and
1087 `:contents-end', `:structure' and `:post-blank' keywords.
1089 Assume point is at the beginning of the list."
1104 ;; Return value.
1108 :begin begin
1109 :end end
1110 :contents-begin contents-begin
1111 :contents-end contents-end
1112 :structure struct
1117 "Interpret PLAIN-LIST element as Org syntax.
1118 CONTENTS is the contents of the element."
1126 ;;;; Quote Block
1129 "Parse a quote block.
1131 LIMIT bounds the search.
1133 Return a list whose CAR is `quote-block' and CDR is a plist
1134 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1135 `:contents-end' and `:post-blank' keywords.
1137 Assume point is at the beginning of the block."
1141 ;; Incomplete block: parse it as a paragraph.
1147 ;; Empty blocks have no contents.
1161 :end end
1162 :hiddenp hidden
1163 :contents-begin contents-begin
1164 :contents-end contents-end
1169 "Interpret QUOTE-BLOCK element as Org syntax.
1170 CONTENTS is the contents of the element."
1174 ;;;; Section
1177 "Parse a section.
1179 LIMIT bounds the search.
1181 Return a list whose CAR is `section' and CDR is a plist
1182 containing `:begin', `:end', `:contents-begin', `contents-end'
1183 and `:post-blank' keywords."
1185 ;; Beginning of section is the beginning of the first non-blank
1186 ;; line after previous headline.
1195 :end end
1196 :contents-begin begin
1197 :contents-end pos-before-blank
1201 "Interpret SECTION element as Org syntax.
1202 CONTENTS is the contents of the element."
1203 contents)
1206 ;;;; Special Block
1209 "Parse a special block.
1211 LIMIT bounds the search.
1213 Return a list whose CAR is `special-block' and CDR is a plist
1214 containing `:type', `:begin', `:end', `:hiddenp',
1215 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1217 Assume point is at the beginning of the block."
1223 ;; Incomplete block: parse it as a paragraph.
1229 ;; Empty blocks have no contents.
1243 :begin begin
1244 :end end
1245 :hiddenp hidden
1246 :contents-begin contents-begin
1247 :contents-end contents-end
1252 "Interpret SPECIAL-BLOCK element as Org syntax.
1253 CONTENTS is the contents of the element."
1258 \f
1259 ;;; Elements
1260 ;;
1261 ;; For each element, a parser and an interpreter are also defined.
1262 ;; Both follow the same naming convention used for greater elements.
1263 ;;
1264 ;; Also, as for greater elements, adding a new element type is done
1265 ;; through the following steps: implement a parser and an interpreter,
1266 ;; tweak `org-element--current-element' so that it recognizes the new
1267 ;; type and add that new type to `org-element-all-elements'.
1268 ;;
1269 ;; As a special case, when the newly defined type is a block type,
1270 ;; `org-element-block-name-alist' has to be modified accordingly.
1273 ;;;; Babel Call
1276 "Parse a babel call.
1278 LIMIT bounds the search.
1280 Return a list whose CAR is `babel-call' and CDR is a plist
1281 containing `:begin', `:end', `:info' and `:post-blank' as
1282 keywords."
1293 :end end
1294 :info info
1298 "Interpret BABEL-CALL element as Org syntax.
1299 CONTENTS is nil."
1305 ;; Remove redundant square brackets.
1310 ;;;; Clock
1313 "Parse a clock.
1315 LIMIT bounds the search.
1317 Return a list whose CAR is `clock' and CDR is a plist containing
1318 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1319 as keywords."
1338 :value value
1339 :time time
1340 :begin begin
1341 :end end
1345 "Interpret CLOCK element as Org syntax.
1346 CONTENTS is nil."
1353 "%2s:%02s"
1357 ;;;; Comment
1360 "Parse a comment.
1362 LIMIT bounds the search.
1364 Return a list whose CAR is `comment' and CDR is a plist
1365 containing `:begin', `:end', `:value' and `:post-blank'
1366 keywords.
1368 Assume point is at comment beginning."
1377 ;; Get comments ending.
1380 ;; Accumulate lines without leading hash and first
1381 ;; whitespace.
1395 :end end
1396 :value value
1401 "Interpret COMMENT element as Org syntax.
1402 CONTENTS is nil."
1406 ;;;; Comment Block
1409 "Parse an export block.
1411 LIMIT bounds the search.
1413 Return a list whose CAR is `comment-block' and CDR is a plist
1414 containing `:begin', `:end', `:hiddenp', `:value' and
1415 `:post-blank' keywords.
1417 Assume point is at comment block beginning."
1421 ;; Incomplete block: parse it as a paragraph.
1435 contents-begin contents-end)))
1439 :end end
1440 :value value
1441 :hiddenp hidden
1446 "Interpret COMMENT-BLOCK element as Org syntax.
1447 CONTENTS is nil."
1452 ;;;; Example Block
1455 "Parse an example block.
1457 LIMIT bounds the search.
1459 Return a list whose CAR is `example-block' and CDR is a plist
1460 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1461 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1462 `:switches', `:value' and `:post-blank' keywords."
1466 ;; Incomplete block: parse it as a paragraph.
1473 ;; Switches analysis
1478 ;; Should labels be retained in (or stripped from) example
1479 ;; blocks?
1484 ;; What should code-references use - labels or
1485 ;; line-numbers?
1492 ;; Standard block parsing.
1506 :end end
1507 :value value
1508 :switches switches
1509 :number-lines number-lines
1510 :preserve-indent preserve-indent
1511 :retain-labels retain-labels
1512 :use-labels use-labels
1513 :label-fmt label-fmt
1514 :hiddenp hidden
1519 "Interpret EXAMPLE-BLOCK element as Org syntax.
1520 CONTENTS is nil."
1528 ;;;; Export Block
1531 "Parse an export block.
1533 LIMIT bounds the search.
1535 Return a list whose CAR is `export-block' and CDR is a plist
1536 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1537 `:post-blank' keywords.
1539 Assume point is at export-block beginning."
1545 ;; Incomplete block: parse it as a paragraph.
1559 contents-end)))
1563 :end end
1564 :type type
1565 :value value
1566 :hiddenp hidden
1571 "Interpret EXPORT-BLOCK element as Org syntax.
1572 CONTENTS is nil."
1579 ;;;; Fixed-width
1582 "Parse a fixed-width section.
1584 LIMIT bounds the search.
1586 Return a list whose CAR is `fixed-width' and CDR is a plist
1587 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1589 Assume point is at the beginning of the fixed-width area."
1593 value
1598 ;; Accumulate text without starting colons.
1611 :end end
1612 :value value
1617 "Interpret FIXED-WIDTH element as Org syntax.
1618 CONTENTS is nil."
1623 ;;;; Horizontal Rule
1626 "Parse an horizontal rule.
1628 LIMIT bounds the search.
1630 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1631 containing `:begin', `:end' and `:post-blank' keywords."
1641 :end end
1646 "Interpret HORIZONTAL-RULE element as Org syntax.
1647 CONTENTS is nil."
1651 ;;;; Keyword
1654 "Parse a keyword at point.
1656 LIMIT bounds the search.
1658 Return a list whose CAR is `keyword' and CDR is a plist
1659 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1660 keywords."
1673 :value value
1674 :begin begin
1675 :end end
1679 "Interpret KEYWORD element as Org syntax.
1680 CONTENTS is nil."
1686 ;;;; Latex Environment
1689 "Parse a LaTeX environment.
1691 LIMIT bounds the search.
1693 Return a list whose CAR is `latex-environment' and CDR is a plist
1694 containing `:begin', `:end', `:value' and `:post-blank'
1695 keywords.
1697 Assume point is at the beginning of the latex environment."
1715 :end end
1716 :value value
1721 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1722 CONTENTS is nil."
1726 ;;;; Paragraph
1729 "Parse a paragraph.
1731 LIMIT bounds the search.
1733 Return a list whose CAR is `paragraph' and CDR is a plist
1734 containing `:begin', `:end', `:contents-begin' and
1735 `:contents-end' and `:post-blank' keywords.
1737 Assume point is at the beginning of the paragraph."
1740 ;; beginning of an item or a footnote reference. In that
1741 ;; case, we mustn't look for affiliated keywords since they
1742 ;; belong to the container.
1754 ;; Skip non-existent or incomplete drawer.
1762 ;; Stop at comments.
1766 ;; Skip incomplete dynamic blocks.
1773 ;; Skip incomplete blocks.
1781 limit t))))
1782 ;; Skip incomplete latex environments.
1790 limit t))))
1791 ;; Skip ill-formed keywords.
1803 ;; If paragraph has no affiliated keywords, it may not begin
1804 ;; at beginning of line if it starts an item.
1807 :end end
1808 :contents-begin contents-begin
1809 :contents-end contents-end
1814 "Interpret PARAGRAPH element as Org syntax.
1815 CONTENTS is the contents of the element."
1816 contents)
1819 ;;;; Planning
1822 "Parse a planning.
1824 LIMIT bounds the search.
1826 Return a list whose CAR is `planning' and CDR is a plist
1827 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1828 and `:post-blank' keywords."
1837 closed deadline scheduled)
1851 :deadline deadline
1852 :scheduled scheduled
1853 :begin begin
1854 :end end
1858 "Interpret PLANNING element as Org syntax.
1859 CONTENTS is nil."
1861 'identity
1873 ;;;; Property Drawer
1876 "Parse a property drawer.
1878 LIMIT bounds the search.
1880 Return a list whose CAR is `property-drawer' and CDR is a plist
1881 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1882 `:contents-end', `:properties' and `:post-blank' keywords.
1884 Assume point is at the beginning of the property drawer."
1898 val))
1900 val))
1908 :end end
1909 :hiddenp hidden
1910 :properties properties
1914 "Interpret PROPERTY-DRAWER element as Org syntax.
1915 CONTENTS is nil."
1925 ;;;; Quote Section
1928 "Parse a quote section.
1930 LIMIT bounds the search.
1932 Return a list whose CAR is `quote-section' and CDR is a plist
1933 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1935 Assume point is at beginning of the section."
1946 :end end
1947 :value value
1951 "Interpret QUOTE-SECTION element as Org syntax.
1952 CONTENTS is nil."
1956 ;;;; Src Block
1959 "Parse a src block.
1961 LIMIT bounds the search.
1963 Return a list whose CAR is `src-block' and CDR is a plist
1964 containing `:language', `:switches', `:parameters', `:begin',
1965 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1966 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1967 `:post-blank' keywords.
1969 Assume point is at the beginning of the block."
1972 ;; Incomplete block: parse it as a paragraph.
1977 ;; Get beginning position.
1979 ;; Get language as a string.
1988 ;; Get switches.
1990 ;; Get parameters.
1992 ;; Switches analysis
2000 ;; Should labels be retained in (or stripped from)
2001 ;; src blocks?
2006 ;; What should code-references use - labels or
2007 ;; line-numbers?
2011 ;; Get visibility status.
2013 ;; Retrieve code.
2018 ;; Get position after ending blank lines.
2028 :begin begin
2029 :end end
2030 :number-lines number-lines
2031 :preserve-indent preserve-indent
2032 :retain-labels retain-labels
2033 :use-labels use-labels
2034 :label-fmt label-fmt
2035 :hiddenp hidden
2036 :value value
2041 "Interpret SRC-BLOCK element as Org syntax.
2042 CONTENTS is nil."
2062 value
2066 ;;;; Table
2069 "Parse a table at point.
2071 LIMIT bounds the search.
2073 Return a list whose CAR is `table' and CDR is a plist containing
2074 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2075 `:contents-end', `:value' and `:post-blank' keywords.
2077 Assume point is at the beginning of the table."
2089 acc))
2096 :end end
2097 :type type
2098 :tblfm tblfm
2099 ;; Only `org' tables have contents. `table.el' tables
2100 ;; use a `:value' property to store raw table as
2101 ;; a string.
2106 table-begin table-end))
2111 "Interpret TABLE element as Org syntax.
2112 CONTENTS is nil."
2123 ;;;; Table Row
2126 "Parse table row at point.
2128 LIMIT bounds the search.
2130 Return a list whose CAR is `table-row' and CDR is a plist
2131 containing `:begin', `:end', `:contents-begin', `:contents-end',
2132 `:type' and `:post-blank' keywords."
2136 ;; A table rule has no contents. In that case, ensure
2137 ;; CONTENTS-BEGIN matches CONTENTS-END.
2149 :begin begin
2150 :end end
2151 :contents-begin contents-begin
2152 :contents-end contents-end
2156 "Interpret TABLE-ROW element as Org syntax.
2157 CONTENTS is the contents of the table row."
2162 ;;;; Verse Block
2165 "Parse a verse block.
2167 LIMIT bounds the search.
2169 Return a list whose CAR is `verse-block' and CDR is a plist
2170 containing `:begin', `:end', `:contents-begin', `:contents-end',
2171 `:hiddenp' and `:post-blank' keywords.
2173 Assume point is at beginning of the block."
2177 ;; Incomplete block: parse it as a paragraph.
2193 :end end
2194 :contents-begin contents-begin
2195 :contents-end contents-end
2196 :hiddenp hidden
2201 "Interpret VERSE-BLOCK element as Org syntax.
2202 CONTENTS is verse block contents."
2206 \f
2207 ;;; Objects
2208 ;;
2209 ;; Unlike to elements, interstices can be found between objects.
2210 ;; That's why, along with the parser, successor functions are provided
2211 ;; for each object. Some objects share the same successor (i.e. `code'
2212 ;; and `verbatim' objects).
2213 ;;
2214 ;; A successor must accept a single argument bounding the search. It
2215 ;; will return either a cons cell whose CAR is the object's type, as
2216 ;; a symbol, and CDR the position of its next occurrence, or nil.
2217 ;;
2218 ;; Successors follow the naming convention:
2219 ;; org-element-NAME-successor, where NAME is the name of the
2220 ;; successor, as defined in `org-element-all-successors'.
2221 ;;
2222 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2223 ;; object types they can contain will be specified in
2224 ;; `org-element-object-restrictions'.
2225 ;;
2226 ;; Adding a new type of object is simple. Implement a successor,
2227 ;; a parser, and an interpreter for it, all following the naming
2228 ;; convention. Register type in `org-element-all-objects' and
2229 ;; successor in `org-element-all-successors'. Maybe tweak
2230 ;; restrictions about it, and that's it.
2233 ;;;; Bold
2236 "Parse bold object at point.
2238 Return a list whose CAR is `bold' and CDR is a plist with
2239 `:begin', `:end', `:contents-begin' and `:contents-end' and
2240 `:post-blank' keywords.
2242 Assume point is at the first star marker."
2254 :end end
2255 :contents-begin contents-begin
2256 :contents-end contents-end
2260 "Interpret BOLD object as Org syntax.
2261 CONTENTS is the contents of the object."
2265 "Search for the next text-markup object.
2267 LIMIT bounds the search.
2269 Return value is a cons cell whose CAR is a symbol among `bold',
2270 `italic', `underline', `strike-through', `code' and `verbatim'
2271 and CDR is beginning position."
2287 ;;;; Code
2290 "Parse code object at point.
2292 Return a list whose CAR is `code' and CDR is a plist with
2293 `:value', `:begin', `:end' and `:post-blank' keywords.
2295 Assume point is at the first tilde marker."
2306 :begin begin
2307 :end end
2311 "Interpret CODE object as Org syntax.
2312 CONTENTS is nil."
2316 ;;;; Entity
2319 "Parse entity at point.
2321 Return a list whose CAR is `entity' and CDR a plist with
2322 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2323 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2324 keywords.
2326 Assume point is at the beginning of the entity."
2328 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2344 :begin begin
2345 :end end
2346 :use-brackets-p bracketsp
2350 "Interpret ENTITY object as Org syntax.
2351 CONTENTS is nil."
2357 "Search for the next latex-fragment or entity object.
2359 LIMIT bounds the search.
2361 Return value is a cons cell whose CAR is `entity' or
2362 `latex-fragment' and CDR is beginning position."
2366 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2373 limit t)
2376 ;; Determine if it's a real entity or a LaTeX command.
2379 ;; No entity nor command: point is at a LaTeX fragment.
2380 ;; Determine its type to get the correct beginning position.
2388 matchers)
2392 ;;;; Export Snippet
2395 "Parse export snippet at point.
2397 Return a list whose CAR is `export-snippet' and CDR a plist with
2398 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2399 keywords.
2401 Assume point is at the beginning of the snippet."
2413 :value value
2414 :begin begin
2415 :end end
2419 "Interpret EXPORT-SNIPPET object as Org syntax.
2420 CONTENTS is nil."
2426 "Search for the next export-snippet object.
2428 LIMIT bounds the search.
2430 Return value is a cons cell whose CAR is `export-snippet' and CDR
2431 its beginning position."
2440 ;;;; Footnote Reference
2443 "Parse footnote reference at point.
2445 Return a list whose CAR is `footnote-reference' and CDR a plist
2446 with `:label', `:type', `:inline-definition', `:begin', `:end'
2447 and `:post-blank' as keywords."
2469 :type type
2470 :begin begin
2471 :end end
2474 footnote-reference :inline-definition
2479 footnote-reference))))))
2482 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2483 CONTENTS is nil."
2493 "Search for the next footnote-reference object.
2495 LIMIT bounds the search.
2497 Return value is a cons cell whose CAR is `footnote-reference' and
2498 CDR is beginning position."
2512 ;;;; Inline Babel Call
2515 "Parse inline babel call at point.
2517 Return a list whose CAR is `inline-babel-call' and CDR a plist
2518 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2520 Assume point is at the beginning of the babel call."
2531 :end end
2532 :info info
2536 "Interpret INLINE-BABEL-CALL object as Org syntax.
2537 CONTENTS is nil."
2543 ;; Remove redundant square brackets.
2546 main-source)
2550 "Search for the next inline-babel-call object.
2552 LIMIT bounds the search.
2554 Return value is a cons cell whose CAR is `inline-babel-call' and
2555 CDR is beginning position."
2557 ;; Use a simplified version of
2558 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2560 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2561 limit t)
2565 ;;;; Inline Src Block
2568 "Parse inline source block at point.
2570 LIMIT bounds the search.
2572 Return a list whose CAR is `inline-src-block' and CDR a plist
2573 with `:begin', `:end', `:language', `:value', `:parameters' and
2574 `:post-blank' as keywords.
2576 Assume point is at the beginning of the inline src block."
2589 :value value
2590 :parameters parameters
2591 :begin begin
2592 :end end
2596 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2597 CONTENTS is nil."
2602 language
2604 body)))
2607 "Search for the next inline-babel-call element.
2609 LIMIT bounds the search.
2611 Return value is a cons cell whose CAR is `inline-babel-call' and
2612 CDR is beginning position."
2617 ;;;; Italic
2620 "Parse italic object at point.
2622 Return a list whose CAR is `italic' and CDR is a plist with
2623 `:begin', `:end', `:contents-begin' and `:contents-end' and
2624 `:post-blank' keywords.
2626 Assume point is at the first slash marker."
2638 :end end
2639 :contents-begin contents-begin
2640 :contents-end contents-end
2644 "Interpret ITALIC object as Org syntax.
2645 CONTENTS is the contents of the object."
2649 ;;;; Latex Fragment
2652 "Parse latex fragment at point.
2654 Return a list whose CAR is `latex-fragment' and CDR a plist with
2655 `:value', `:begin', `:end', and `:post-blank' as keywords.
2657 Assume point is at the beginning of the latex fragment."
2671 ;; None found: it's a macro.
2680 :begin begin
2681 :end end
2685 "Interpret LATEX-FRAGMENT object as Org syntax.
2686 CONTENTS is nil."
2689 ;;;; Line Break
2692 "Parse line break at point.
2694 Return a list whose CAR is `line-break', and CDR a plist with
2695 `:begin', `:end' and `:post-blank' keywords.
2697 Assume point is at the beginning of the line break."
2701 "Interpret LINE-BREAK object as Org syntax.
2702 CONTENTS is nil."
2706 "Search for the next line-break object.
2708 LIMIT bounds the search.
2710 Return value is a cons cell whose CAR is `line-break' and CDR is
2711 beginning position."
2715 ;; A line break can only happen on a non-empty line.
2720 ;;;; Link
2723 "Parse link at point.
2725 Return a list whose CAR is `link' and CDR a plist with `:type',
2726 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2727 `:contents-end' and `:post-blank' as keywords.
2729 Assume point is at the beginning of the link."
2732 end contents-begin contents-end link-end post-blank path type
2733 raw-link link)
2735 ;; Type 1: Text targeted from a radio target.
2740 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2745 ;; RAW-LINK is the original link.
2750 ;; Determine TYPE of link and set PATH accordingly.
2752 ;; File type.
2755 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2758 ;; Id type: PATH is the id.
2761 ;; Code-ref type: PATH is the name of the reference.
2764 ;; Custom-id type: PATH is the name of the custom id.
2767 ;; Fuzzy type: Internal link either matches a target, an
2768 ;; headline name or nothing. PATH is the target or
2769 ;; headline's name.
2771 ;; Type 3: Plain link, i.e. http://orgmode.org
2777 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2784 ;; In any case, deduce end point after trailing white space from
2785 ;; LINK-END variable.
2790 :path path
2792 :begin begin
2793 :end end
2794 :contents-begin contents-begin
2795 :contents-end contents-end
2799 "Interpret LINK object as Org syntax.
2800 CONTENTS is the contents of the object, or nil."
2805 raw-link
2809 "Search for the next link object.
2811 LIMIT bounds the search.
2813 Return value is a cons cell whose CAR is `link' and CDR is
2814 beginning position."
2823 ;;;; Macro
2826 "Parse macro at point.
2828 Return a list whose CAR is `macro' and CDR a plist with `:key',
2829 `:args', `:begin', `:end', `:value' and `:post-blank' as
2830 keywords.
2832 Assume point is at the macro."
2846 ;; Repair bad splits.
2854 :value value
2855 :args args
2856 :begin begin
2857 :end end
2861 "Interpret MACRO object as Org syntax.
2862 CONTENTS is nil."
2866 "Search for the next macro object.
2868 LIMIT bounds the search.
2870 Return value is cons cell whose CAR is `macro' and CDR is
2871 beginning position."
2875 limit t)
2879 ;;;; Radio-target
2882 "Parse radio target at point.
2884 Return a list whose CAR is `radio-target' and CDR a plist with
2885 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2886 and `:post-blank' as keywords.
2888 Assume point is at the radio target."
2900 :end end
2901 :contents-begin contents-begin
2902 :contents-end contents-end
2903 :post-blank post-blank
2907 "Interpret TARGET object as Org syntax.
2908 CONTENTS is the contents of the object."
2912 "Search for the next radio-target object.
2914 LIMIT bounds the search.
2916 Return value is a cons cell whose CAR is `radio-target' and CDR
2917 is beginning position."
2923 ;;;; Statistics Cookie
2926 "Parse statistics cookie at point.
2928 Return a list whose CAR is `statistics-cookie', and CDR a plist
2929 with `:begin', `:end', `:value' and `:post-blank' keywords.
2931 Assume point is at the beginning of the statistics-cookie."
2942 :end end
2943 :value value
2947 "Interpret STATISTICS-COOKIE object as Org syntax.
2948 CONTENTS is nil."
2952 "Search for the next statistics cookie object.
2954 LIMIT bounds the search.
2956 Return value is a cons cell whose CAR is `statistics-cookie' and
2957 CDR is beginning position."
2963 ;;;; Strike-Through
2966 "Parse strike-through object at point.
2968 Return a list whose CAR is `strike-through' and CDR is a plist
2969 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2970 `:post-blank' keywords.
2972 Assume point is at the first plus sign marker."
2984 :end end
2985 :contents-begin contents-begin
2986 :contents-end contents-end
2990 "Interpret STRIKE-THROUGH object as Org syntax.
2991 CONTENTS is the contents of the object."
2995 ;;;; Subscript
2998 "Parse subscript at point.
3000 Return a list whose CAR is `subscript' and CDR a plist with
3001 `:begin', `:end', `:contents-begin', `:contents-end',
3002 `:use-brackets-p' and `:post-blank' as keywords.
3004 Assume point is at the underscore."
3008 t
3019 :end end
3020 :use-brackets-p bracketsp
3021 :contents-begin contents-begin
3022 :contents-end contents-end
3026 "Interpret SUBSCRIPT object as Org syntax.
3027 CONTENTS is the contents of the object."
3030 contents))
3033 "Search for the next sub/superscript object.
3035 LIMIT bounds the search.
3037 Return value is a cons cell whose CAR is either `subscript' or
3038 `superscript' and CDR is beginning position."
3045 ;;;; Superscript
3048 "Parse superscript at point.
3050 Return a list whose CAR is `superscript' and CDR a plist with
3051 `:begin', `:end', `:contents-begin', `:contents-end',
3052 `:use-brackets-p' and `:post-blank' as keywords.
3054 Assume point is at the caret."
3068 :end end
3069 :use-brackets-p bracketsp
3070 :contents-begin contents-begin
3071 :contents-end contents-end
3075 "Interpret SUPERSCRIPT object as Org syntax.
3076 CONTENTS is the contents of the object."
3079 contents))
3082 ;;;; Table Cell
3085 "Parse table cell at point.
3087 Return a list whose CAR is `table-cell' and CDR is a plist
3088 containing `:begin', `:end', `:contents-begin', `:contents-end'
3089 and `:post-blank' keywords."
3097 :end end
3098 :contents-begin contents-begin
3099 :contents-end contents-end
3103 "Interpret TABLE-CELL element as Org syntax.
3104 CONTENTS is the contents of the cell, or nil."
3108 "Search for the next table-cell object.
3110 LIMIT bounds the search.
3112 Return value is a cons cell whose CAR is `table-cell' and CDR is
3113 beginning position."
3117 ;;;; Target
3120 "Parse target at point.
3122 Return a list whose CAR is `target' and CDR a plist with
3123 `:begin', `:end', `:value' and `:post-blank' as keywords.
3125 Assume point is at the target."
3135 :end end
3136 :value value
3140 "Interpret TARGET object as Org syntax.
3141 CONTENTS is nil."
3145 "Search for the next target object.
3147 LIMIT bounds the search.
3149 Return value is a cons cell whose CAR is `target' and CDR is
3150 beginning position."
3156 ;;;; Timestamp
3159 "Parse time stamp at point.
3161 Return a list whose CAR is `timestamp', and CDR a plist with
3162 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3164 Assume point is at the beginning of the timestamp."
3183 :value main-value
3184 :range-end range-end
3185 :begin begin
3186 :end end
3190 "Interpret TIMESTAMP object as Org syntax.
3191 CONTENTS is nil."
3200 range-end)))))))
3203 "Search for the next timestamp object.
3205 LIMIT bounds the search.
3207 Return value is a cons cell whose CAR is `timestamp' and CDR is
3208 beginning position."
3216 limit t)
3220 ;;;; Underline
3223 "Parse underline object at point.
3225 Return a list whose CAR is `underline' and CDR is a plist with
3226 `:begin', `:end', `:contents-begin' and `:contents-end' and
3227 `:post-blank' keywords.
3229 Assume point is at the first underscore marker."
3241 :end end
3242 :contents-begin contents-begin
3243 :contents-end contents-end
3247 "Interpret UNDERLINE object as Org syntax.
3248 CONTENTS is the contents of the object."
3252 ;;;; Verbatim
3255 "Parse verbatim object at point.
3257 Return a list whose CAR is `verbatim' and CDR is a plist with
3258 `:value', `:begin', `:end' and `:post-blank' keywords.
3260 Assume point is at the first equal sign marker."
3271 :begin begin
3272 :end end
3276 "Interpret VERBATIM object as Org syntax.
3277 CONTENTS is nil."
3281 \f
3282 ;;; Parsing Element Starting At Point
3283 ;;
3284 ;; `org-element--current-element' is the core function of this section.
3285 ;; It returns the Lisp representation of the element starting at
3286 ;; point.
3287 ;;
3288 ;; `org-element--current-element' makes use of special modes. They
3289 ;; are activated for fixed element chaining (i.e. `plain-list' >
3290 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3291 ;; `section'). Special modes are: `first-section', `section',
3292 ;; `quote-section', `item' and `table-row'.
3296 "Parse the element starting at point.
3298 LIMIT bounds the search.
3300 Return value is a list like (TYPE PROPS) where TYPE is the type
3301 of the element and PROPS a plist of properties associated to the
3302 element.
3304 Possible types are defined in `org-element-all-elements'.
3306 Optional argument GRANULARITY determines the depth of the
3307 recursion. Allowed values are `headline', `greater-element',
3308 `element', `object' or nil. When it is broader than `object' (or
3309 nil), secondary values will not be parsed, since they only
3310 contain objects.
3312 Optional argument SPECIAL, when non-nil, can be either
3313 `first-section', `section', `quote-section', `table-row' and
3314 `item'.
3316 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3317 be computed.
3319 This function assumes point is always at the beginning of the
3320 element it has to parse."
3322 ;; If point is at an affiliated keyword, try moving to the
3323 ;; beginning of the associated element. If none is found, the
3324 ;; keyword is orphaned and will be treated as plain text.
3330 ;; Determine if parsing depth allows for secondary strings
3331 ;; parsing. It only applies to elements referenced in
3332 ;; `org-element-secondary-value-alist'.
3335 ;; Item.
3338 ;; Quote Section.
3340 ;; Table Row.
3342 ;; Headline.
3345 ;; Section (must be checked after headline).
3350 limit)))
3351 ;; Planning and Clock.
3356 ;; Inlinetask.
3359 ;; LaTeX Environment.
3365 nil t))
3368 ;; Drawer and Property Drawer.
3378 ;; Fixed Width
3381 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3382 ;; Keywords.
3391 org-element-block-name-alist)))
3406 ;; Footnote Definition.
3409 ;; Horizontal Rule.
3412 ;; Table.
3414 ;; List.
3417 ;; Default element: Paragraph.
3421 ;; Most elements can have affiliated keywords. When looking for an
3422 ;; element beginning, we want to move before them, as they belong to
3423 ;; that element, and, in the meantime, collect information they give
3424 ;; into appropriate properties. Hence the following function.
3425 ;;
3426 ;; Usage of optional arguments may not be obvious at first glance:
3427 ;;
3428 ;; - TRANS-LIST is used to polish keywords names that have evolved
3429 ;; during Org history. In example, even though =result= and
3430 ;; =results= coexist, we want to have them under the same =result=
3431 ;; property. It's also true for "srcname" and "name", where the
3432 ;; latter seems to be preferred nowadays (thus the "name" property).
3433 ;;
3434 ;; - CONSED allows to regroup multi-lines keywords under the same
3435 ;; property, while preserving their own identity. This is mostly
3436 ;; used for "attr_latex" and al.
3437 ;;
3438 ;; - PARSED prepares a keyword value for export. This is useful for
3439 ;; "caption". Objects restrictions for such keywords are defined in
3440 ;; `org-element-object-restrictions'.
3441 ;;
3442 ;; - DUALS is used to take care of keywords accepting a main and an
3443 ;; optional secondary values. For example "results" has its
3444 ;; source's name as the main value, and may have an hash string in
3445 ;; optional square brackets as the secondary one.
3446 ;;
3447 ;; A keyword may belong to more than one category.
3451 "Collect affiliated keywords before point.
3453 Optional argument KEY-RE is a regexp matching keywords, which
3454 puts matched keyword in group 1. It defaults to
3455 `org-element--affiliated-re'.
3457 TRANS-LIST is an alist where key is the keyword and value the
3458 property name it should be translated to, without the colons. It
3459 defaults to `org-element-keyword-translation-alist'.
3461 CONSED is a list of strings. Any keyword belonging to that list
3462 will have its value consed. The check is done after keyword
3463 translation. It defaults to `org-element-multiple-keywords'.
3465 PARSED is a list of strings. Any keyword member of this list
3466 will have its value parsed. The check is done after keyword
3467 translation. If a keyword is a member of both CONSED and PARSED,
3468 it's value will be a list of parsed strings. It defaults to
3469 `org-element-parsed-keywords'.
3471 DUALS is a list of strings. Any keyword member of this list can
3472 have two parts: one mandatory and one optional. Its value is
3473 a cons cell whose CAR is the former, and the CDR the latter. If
3474 a keyword is a member of both PARSED and DUALS, both values will
3475 be parsed. It defaults to `org-element-dual-keywords'.
3477 Return a list whose CAR is the position at the first of them and
3478 CDR a plist of keywords and values."
3486 ;; RESTRICT is the list of objects allowed in parsed
3487 ;; keywords value.
3489 output)
3493 ;; Apply translation to RAW-KWD. From there, KWD is
3494 ;; the official keyword.
3496 ;; Find main value for any keyword.
3502 ;; If KWD is a dual keyword, find its secondary
3503 ;; value. Maybe parse it.
3509 ;; Attribute a property name to KWD.
3511 ;; Now set final shape for VALUE.
3515 ;; VALUE is mandatory. Set it to nil if there is none.
3517 ;; Attributes are always consed.
3520 ;; Eventually store the new value in OUTPUT.
3526 \f
3527 ;;; The Org Parser
3528 ;;
3529 ;; The two major functions here are `org-element-parse-buffer', which
3530 ;; parses Org syntax inside the current buffer, taking into account
3531 ;; region, narrowing, or even visibility if specified, and
3532 ;; `org-element-parse-secondary-string', which parses objects within
3533 ;; a given string.
3534 ;;
3535 ;; The (almost) almighty `org-element-map' allows to apply a function
3536 ;; on elements or objects matching some type, and accumulate the
3537 ;; resulting values. In an export situation, it also skips unneeded
3538 ;; parts of the parse tree.
3541 "Recursively parse the buffer and return structure.
3542 If narrowing is in effect, only parse the visible part of the
3543 buffer.
3545 Optional argument GRANULARITY determines the depth of the
3546 recursion. It can be set to the following symbols:
3548 `headline' Only parse headlines.
3549 `greater-element' Don't recurse into greater elements excepted
3550 headlines and sections. Thus, elements
3551 parsed are the top-level ones.
3552 `element' Parse everything but objects and plain text.
3553 `object' Parse the complete buffer (default).
3555 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3556 elements.
3558 Assume buffer is in Org mode."
3564 ;; Start in `first-section' mode so text before the first
3565 ;; headline belongs to a section.
3569 "Recursively parse objects in STRING and return structure.
3571 RESTRICTION is a symbol limiting the object types that will be
3572 looked after.
3574 Optional argument PARENT, when non-nil, is the element or object
3575 containing the secondary string. It is used to set correctly
3576 `:parent' property within the string."
3582 secondary))))
3585 "Map a function on selected elements or objects.
3587 DATA is the parsed tree, as returned by, i.e,
3588 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3589 of elements or objects types. FUN is the function called on the
3590 matching element or object. It must accept one arguments: the
3591 element or object itself.
3593 When optional argument INFO is non-nil, it should be a plist
3594 holding export options. In that case, parts of the parse tree
3595 not exportable according to that property list will be skipped.
3597 When optional argument FIRST-MATCH is non-nil, stop at the first
3598 match for which FUN doesn't return nil, and return that value.
3600 Optional argument NO-RECURSION is a symbol or a list of symbols
3601 representing elements or objects types. `org-element-map' won't
3602 enter any recursive element or object whose type belongs to that
3603 list. Though, FUN can still be applied on them.
3605 Nil values returned from FUN do not appear in the results."
3606 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3609 ;; Recursion depth is determined by --CATEGORY.
3616 ;; If one object is found, the function
3617 ;; has to recurse into every object.
3620 ;; If one regular element is found, the
3621 ;; function has to recurse, at least,
3622 ;; into every element it encounters.
3625 types)
3626 category)))
3627 --acc
3628 --walk-tree
3632 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3633 ;; holding contextual information.
3637 ;; Ignored element in an export context.
3639 ;; Secondary string: only objects can be found there.
3642 ;; Unconditionally enter parse trees.
3646 ;; Check if TYPE is matching among TYPES. If so,
3647 ;; apply FUN to --DATA and accumulate return value
3648 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3654 ;; If --DATA has a secondary string that can contain
3655 ;; objects with their type among TYPES, look into it.
3662 ;; Determine if a recursion into --DATA is possible.
3664 ;; --TYPE is explicitly removed from recursion.
3666 ;; --DATA has no contents.
3668 ;; Looking for greater elements but --DATA is simply
3669 ;; an element or an object.
3672 ;; Looking for elements but --DATA is an object.
3675 ;; In any other case, map contents.
3679 ;; Return value in a proper order.
3682 ;; The following functions are internal parts of the parser.
3683 ;;
3684 ;; The first one, `org-element--parse-elements' acts at the element's
3685 ;; level.
3686 ;;
3687 ;; The second one, `org-element--parse-objects' applies on all objects
3688 ;; of a paragraph or a secondary string. It uses
3689 ;; `org-element--get-next-object-candidates' to optimize the search of
3690 ;; the next object in the buffer.
3691 ;;
3692 ;; More precisely, that function looks for every allowed object type
3693 ;; first. Then, it discards failed searches, keeps further matches,
3694 ;; and searches again types matched behind point, for subsequent
3695 ;; calls. Thus, searching for a given type fails only once, and every
3696 ;; object is searched only once at top level (but sometimes more for
3697 ;; nested types).
3701 "Parse elements between BEG and END positions.
3703 SPECIAL prioritize some elements over the others. It can be set
3704 to `first-section', `quote-section', `section' `item' or
3705 `table-row'.
3707 When value is `item', STRUCTURE will be used as the current list
3708 structure.
3710 GRANULARITY determines the depth of the recursion. See
3711 `org-element-parse-buffer' for more information.
3713 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3714 elements.
3716 Elements are accumulated into ACC."
3719 ;; When parsing only headlines, skip any text before first one.
3722 ;; Main loop start.
3724 ;; Find current element's type and parse it accordingly to
3725 ;; its category.
3727 end granularity special structure))
3731 ;; Fill ELEMENT contents by side-effect.
3733 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3734 ;; no contents, don't modify it.
3737 ;; Greater element: parse it between `contents-begin' and
3738 ;; `contents-end'. Make sure GRANULARITY allows the
3739 ;; recursion, or ELEMENT is an headline, in which case going
3740 ;; inside is mandatory, in order to get sub-level headings.
3748 ;; Possibly switch to a special mode.
3756 granularity visible-only element))
3757 ;; ELEMENT has contents. Parse objects inside, if
3758 ;; GRANULARITY allows it.
3764 ;; Return result.
3765 acc))
3768 "Parse objects between BEG and END and return recursive structure.
3770 Objects are accumulated in ACC.
3772 RESTRICTION is a list of object types which are allowed in the
3773 current object."
3779 end restriction candidates)))
3786 ;; 1. Text before any object. Untabify it.
3791 acc
3795 ;; 2. Object...
3798 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3799 ;; a recursive type.
3804 cont-beg
3811 ;; 3. Text after last object. Untabify it.
3815 acc
3819 ;; Result.
3820 acc)))
3823 "Return an alist of candidates for the next object.
3825 LIMIT bounds the search, and RESTRICTION narrows candidates to
3826 some object types.
3828 Return value is an alist whose CAR is position and CDR the object
3829 type, as a symbol.
3831 OBJECTS is the previous candidates alist."
3833 ;; If no previous result, search every object type in RESTRICTION.
3834 ;; Otherwise, keep potential candidates (old objects located after
3835 ;; point) and ask to search again those which had matched before.
3840 objects))
3841 ;; Call the appropriate successor function for each type to search
3842 ;; and accumulate matches.
3849 type))))
3852 types-to-search)
3853 ;; Return alist.
3854 next-candidates))
3857 \f
3858 ;;; Towards A Bijective Process
3859 ;;
3860 ;; The parse tree obtained with `org-element-parse-buffer' is really
3861 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3862 ;; interpreted and expanded into a string with canonical Org syntax.
3863 ;; Hence `org-element-interpret-data'.
3864 ;;
3865 ;; The function relies internally on
3866 ;; `org-element--interpret-affiliated-keywords'.
3868 ;;;###autoload
3870 "Interpret DATA as Org syntax.
3872 DATA is a parse tree, an element, an object or a secondary string
3873 to interpret.
3875 Optional argument PARENT is used for recursive calls. It contains
3876 the element or object containing data, or nil.
3878 Return Org syntax as a string."
3882 ;; Secondary string.
3887 ;; Full Org document.
3892 ;; Plain text.
3894 ;; Element/Object without contents.
3897 data nil))
3898 ;; Element/Object with contents.
3908 ;; Elements directly containing objects must
3909 ;; have their indentation normalized first.
3911 data
3912 ;; When normalizing first paragraph of an
3913 ;; item or a footnote-definition, ignore
3914 ;; first line's indentation.
3921 data
3923 contents)))))))
3925 ;; Build white spaces. If no `:post-blank' property is
3926 ;; specified, assume its value is 0.
3936 "Return ELEMENT's affiliated keywords as Org syntax.
3937 If there is no affiliated keyword, return the empty string."
3947 ": "
3950 value)
3958 ;; All attribute keywords can have multiple lines.
3961 value
3964 ;; List all ELEMENT's properties matching an attribute line or an
3965 ;; affiliated keyword, but ignore translated keywords since they
3966 ;; cannot belong to the property list.
3973 org-element-keyword-translation-alist)))))
3974 collect prop)
3977 ;; Because interpretation of the parse tree must return the same
3978 ;; number of blank lines between elements and the same number of white
3979 ;; space after objects, some special care must be given to white
3980 ;; spaces.
3981 ;;
3982 ;; The first function, `org-element-normalize-string', ensures any
3983 ;; string different from the empty string will end with a single
3984 ;; newline character.
3985 ;;
3986 ;; The second function, `org-element-normalize-contents', removes
3987 ;; global indentation from the contents of the current element.
3990 "Ensure string S ends with a single newline character.
3992 If S isn't a string return it unchanged. If S is the empty
3993 string, return it. Otherwise, return a new string with a single
3994 newline character at its end."
4002 "Normalize plain text in ELEMENT's contents.
4004 ELEMENT must only contain plain text and objects.
4006 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4007 indentation to compute maximal common indentation.
4009 Return the normalized element that is element with global
4010 indentation removed from its contents. The function assumes that
4011 indentation is not done with TAB characters."
4013 collect-inds ; for byte-compiler
4016 ;; Return list of indentations within BLOB. This is done by
4017 ;; walking recursively BLOB and updating IND-LIST along the
4018 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4019 ;; been seen yet. It is required as this string is the only
4020 ;; one whose indentation doesn't happen after a newline
4021 ;; character.
4029 ;; An indentation of zero means no string will be
4030 ;; modified. Quit the process.
4036 ;; Avoid matching blank or empty lines.
4044 ;; Collect indentation list in ELEMENT. Possibly remove first
4045 ;; value if IGNORE-FIRST is non-nil.
4048 ;; Build ELEMENT back, replacing each string with the same
4049 ;; string minus common indentation.
4054 ;; Return BLOB with all its strings indentation
4055 ;; shortened from MCI white spaces. FIRST-FLAG is
4056 ;; non-nil when the first string hasn't been seen
4057 ;; yet.
4071 org-element-recursive-objects)
4075 blob))))
4079 \f
4080 ;;; The Toolbox
4081 ;;
4082 ;; The first move is to implement a way to obtain the smallest element
4083 ;; containing point. This is the job of `org-element-at-point'. It
4084 ;; basically jumps back to the beginning of section containing point
4085 ;; and moves, element after element, with
4086 ;; `org-element--current-element' until the container is found. Note:
4087 ;; When using `org-element-at-point', secondary values are never
4088 ;; parsed since the function focuses on elements, not on objects.
4089 ;;
4090 ;; At a deeper level, `org-element-context' lists all elements and
4091 ;; objects containing point.
4092 ;;
4093 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4094 ;; internally by navigation and manipulation tools.
4096 ;;;###autoload
4098 "Determine closest element around point.
4100 Return value is a list like (TYPE PROPS) where TYPE is the type
4101 of the element and PROPS a plist of properties associated to the
4102 element.
4104 Possible types are defined in `org-element-all-elements'.
4105 Properties depend on element or object type, but always
4106 include :begin, :end, :parent and :post-blank properties.
4108 As a special case, if point is at the very beginning of a list or
4109 sub-list, returned element will be that list instead of the first
4110 item. In the same way, if point is at the beginning of the first
4111 row of a table, returned element will be the table instead of the
4112 first row.
4114 If optional argument KEEP-TRAIL is non-nil, the function returns
4115 a list of of elements leading to element at point. The list's
4116 CAR is always the element at point. Following positions contain
4117 element's siblings, then parents, siblings of parents, until the
4118 first element of current section."
4120 ;; If at an headline, parse it. It is the sole element that
4121 ;; doesn't require to know about context. Be sure to disallow
4122 ;; secondary string parsing, though.
4128 ;; Otherwise move at the beginning of the section containing
4129 ;; point.
4133 element type special-flag trail struct prevs parent)
4141 ;; Parse successively each element, skipping those ending
4142 ;; before original position.
4151 ;; 1. Skip any element ending before point. Also skip
4152 ;; element ending at point when we're sure that another
4153 ;; element has started.
4158 ;; 2. An element containing point is always the element at
4159 ;; point.
4162 ;; 3. At any other greater element type, if point is
4163 ;; within contents, move into it.
4168 ;; Create an anchor for tables and plain lists:
4169 ;; when point is at the very beginning of these
4170 ;; elements, ignoring affiliated keywords,
4171 ;; target them instead of their contents.
4173 ;; When point is at contents end, do not move
4174 ;; into elements with an explicit ending, but
4175 ;; return that element instead.
4179 drawer dynamic-block inlinetask item
4180 plain-list quote-block special-block))))
4192 ;;;###autoload
4194 "Return closest element or object around point.
4196 Return value is a list like (TYPE PROPS) where TYPE is the type
4197 of the element or object and PROPS a plist of properties
4198 associated to it.
4200 Possible types are defined in `org-element-all-elements' and
4201 `org-element-all-objects'. Properties depend on element or
4202 object type, but always include :begin, :end, :parent
4203 and :post-blank properties."
4208 end)
4209 ;; Check if point is inside an element containing objects or at
4210 ;; a secondary string. In that case, move to beginning of the
4211 ;; element or secondary string and set END to the other side.
4220 (<= origin
4221 ;; `1+' is required so some
4222 ;; successors can match
4223 ;; properly their object.
4237 element
4240 candidates)
4243 end restriction candidates))
4245 candidates)))
4246 ;; If ORIGIN is before next object in element, there's
4247 ;; no point in looking further.
4256 ;; ORIGIN is after OBJECT, so skip it.
4259 ;; ORIGIN is within a non-recursive object or at an
4260 ;; object boundaries: Return that object.
4264 ;; Otherwise, move within current object and restrict
4265 ;; search to the end of its contents.
4269 parent))))))
4272 "Non-nil when elements ELEM-A and ELEM-B are nested."
4281 "Swap elements ELEM-A and ELEM-B.
4282 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4283 end of ELEM-A."
4285 ;; There are two special cases when an element doesn't start at bol:
4286 ;; the first paragraph in an item or in a footnote definition.
4288 ;; Only a paragraph without any affiliated keyword can be moved at
4289 ;; ELEM-A position in such a situation. Note that the case of
4290 ;; a footnote definition is impossible: it cannot contain two
4291 ;; paragraphs in a row because it cannot contain a blank line.
4297 ;; In a special situation, ELEM-A will have no indentation. We'll
4298 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4312 ;; Store overlays responsible for visibility status. We
4313 ;; also need to store their boundaries as they will be
4314 ;; removed from buffer.
4321 ;; Get contents.
4329 ;; Restore ex ELEM-A overlays.
4338 ;; Restore ex ELEM-B overlays.
4347 ;;; org-element.el ends here