| blob | 0d0f4511d575afd1cd917e8ec72ea949c18ed138 |
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 implements a parser and an interpreter
89 ;; for each type of Org syntax.
90 ;;
91 ;; The next two parts introduce four accessors and a function
92 ;; retrieving the element starting at point (respectively
93 ;; `org-element-type', `org-element-property', `org-element-contents',
94 ;; `org-element-restriction' and `org-element-current-element').
95 ;;
96 ;; The following part creates a fully recursive buffer parser. It
97 ;; also provides a tool to map a function to elements or objects
98 ;; matching some criteria in the parse tree. Functions of interest
99 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
100 ;; extent, `org-element-parse-secondary-string'.
101 ;;
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
104 ;;
105 ;; The library ends by furnishing a set of interactive tools for
106 ;; element's navigation and manipulation, mostly based on
107 ;; `org-element-at-point' function.
110 ;;; Code:
116 \f
117 ;;; Greater elements
118 ;;
119 ;; For each greater element type, we define a parser and an
120 ;; interpreter.
121 ;;
122 ;; A parser returns the element or object as the list described above.
123 ;; Most of them accepts no argument. Though, exceptions exist. Hence
124 ;; every element containing a secondary string (see
125 ;; `org-element-secondary-value-alist') will accept an optional
126 ;; argument to toggle parsing of that secondary string. Moreover,
127 ;; `item' parser requires current list's structure as its first
128 ;; element.
129 ;;
130 ;; An interpreter accepts two arguments: the list representation of
131 ;; the element or object, and its contents. The latter may be nil,
132 ;; depending on the element or object considered. It returns the
133 ;; appropriate Org syntax, as a string.
134 ;;
135 ;; Parsing functions must follow the naming convention:
136 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
137 ;; defined in `org-element-greater-elements'.
138 ;;
139 ;; Similarly, interpreting functions must follow the naming
140 ;; convention: org-element-TYPE-interpreter.
141 ;;
142 ;; With the exception of `headline' and `item' types, greater elements
143 ;; cannot contain other greater elements of their own type.
144 ;;
145 ;; Beside implementing a parser and an interpreter, adding a new
146 ;; greater element requires to tweak `org-element-current-element'.
147 ;; Moreover, the newly defined type must be added to both
148 ;; `org-element-all-elements' and `org-element-greater-elements'.
151 ;;;; Center Block
154 "Parse a center block.
156 Return a list whose CAR is `center-block' and CDR is a plist
157 containing `:begin', `:end', `:hiddenp', `:contents-begin',
158 `:contents-end' and `:post-blank' keywords.
160 Assume point is at the beginning of the block."
183 "Interpret CENTER-BLOCK element as Org syntax.
184 CONTENTS is the contents of the element."
188 ;;;; Drawer
191 "Parse a drawer.
193 Return a list whose CAR is `drawer' and CDR is a plist containing
194 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
195 `:contents-end' and `:post-blank' keywords.
197 Assume point is at beginning of drawer."
222 "Interpret DRAWER element as Org syntax.
223 CONTENTS is the contents of the element."
226 contents))
229 ;;;; Dynamic Block
232 "Parse a dynamic block.
234 Return a list whose CAR is `dynamic-block' and CDR is a plist
235 containing `:block-name', `:begin', `:end', `:hiddenp',
236 `:contents-begin', `:contents-end', `:arguments' and
237 `:post-blank' keywords.
239 Assume point is at beginning of dynamic block."
266 "Interpret DYNAMIC-BLOCK element as Org syntax.
267 CONTENTS is the contents of the element."
272 contents))
275 ;;;; Footnote Definition
278 "Parse a footnote definition.
280 Return a list whose CAR is `footnote-definition' and CDR is
281 a plist containing `:label', `:begin' `:end', `:contents-begin',
282 `:contents-end' and `:post-blank' keywords.
284 Assume point is at the beginning of the footnote definition."
313 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
314 CONTENTS is the contents of the footnote-definition."
316 " "
317 contents))
320 ;;;; Headline
323 "Parse an headline.
325 Return a list whose CAR is `headline' and CDR is a plist
326 containing `:raw-value', `:title', `:begin', `:end',
327 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
328 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
329 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
330 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
331 keywords.
333 The plist also contains any property set in the property drawer,
334 with its name in lowercase, the underscores replaced with hyphens
335 and colons at the beginning (i.e. `:custom-id').
337 When RAW-SECONDARY-P is non-nil, headline's title will not be
338 parsed as a secondary string, but as a plain string instead.
340 Assume point is at beginning of the headline."
370 plist))
386 title)
387 ;; Clean RAW-VALUE from any quote or comment string.
392 ""
393 raw-value)))
394 ;; Clean TAGS from archive tag, if any.
396 ;; Then get TITLE.
427 "Interpret HEADLINE element as Org syntax.
428 CONTENTS is the contents of the element."
455 ;; Align tags.
463 ? )
464 tags))
468 tags))))
470 contents)))
473 ;;;; Inlinetask
476 "Parse an inline task.
478 Return a list whose CAR is `inlinetask' and CDR is a plist
479 containing `:title', `:begin', `:end', `:hiddenp',
480 `:contents-begin' and `:contents-end', `:level', `:priority',
481 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
482 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
484 The plist also contains any property set in the property drawer,
485 with its name in lowercase, the underscores replaced with hyphens
486 and colons at the beginning (i.e. `:custom-id').
488 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
489 title will not be parsed as a secondary string, but as a plain
490 string instead.
492 Assume point is at beginning of the inline task."
517 plist))
526 ;; In the case of a single line task, CONTENTS-BEGIN and
527 ;; CONTENTS-END might overlap.
550 ,@standard-props
554 "Interpret INLINETASK element as Org syntax.
555 CONTENTS is the contents of inlinetask."
570 ;; Align tags.
578 ? )
579 tags))
583 tags))))
584 ;; Prefer degenerate inlinetasks when there are no
585 ;; contents.
588 contents
592 ;;;; Item
595 "Parse an item.
597 STRUCT is the structure of the plain list.
599 Return a list whose CAR is `item' and CDR is a plist containing
600 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
601 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
602 `:post-blank' keywords.
604 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
605 any, will not be parsed as a secondary string, but as a plain
606 string instead.
608 Assume point is at the beginning of the item."
635 ;; If first line isn't empty,
636 ;; contents really start at the text
637 ;; after item's meta-data.
651 ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
652 ;; up in the case of an empty item separated
653 ;; from the next by a blank line. Thus, ensure
654 ;; the former is always the smallest of two.
665 "Interpret ITEM element as Org syntax.
666 CONTENTS is the contents of the element."
680 num
687 ;; Compute indentation.
692 ;; Indent contents.
694 bullet
707 ;;;; Plain List
710 "Parse a plain list.
712 Optional argument STRUCTURE, when non-nil, is the structure of
713 the plain list being parsed.
715 Return a list whose CAR is `plain-list' and CDR is a plist
716 containing `:type', `:begin', `:end', `:contents-begin' and
717 `:contents-end', `:structure' and `:post-blank' keywords.
719 Assume point is at the beginning of the list."
732 ;; Blank lines below list belong to the top-level list only.
737 ;; Return value.
749 "Interpret PLAIN-LIST element as Org syntax.
750 CONTENTS is the contents of the element."
751 contents)
754 ;;;; Quote Block
757 "Parse a quote block.
759 Return a list whose CAR is `quote-block' and CDR is a plist
760 containing `:begin', `:end', `:hiddenp', `:contents-begin',
761 `:contents-end' and `:post-blank' keywords.
763 Assume point is at the beginning of the block."
785 "Interpret QUOTE-BLOCK element as Org syntax.
786 CONTENTS is the contents of the element."
790 ;;;; Section
793 "Parse a section.
795 Return a list whose CAR is `section' and CDR is a plist
796 containing `:begin', `:end', `:contents-begin', `contents-end'
797 and `:post-blank' keywords."
799 ;; Beginning of section is the beginning of the first non-blank
800 ;; line after previous headline.
819 "Interpret SECTION element as Org syntax.
820 CONTENTS is the contents of the element."
821 contents)
824 ;;;; Special Block
827 "Parse a special block.
829 Return a list whose CAR is `special-block' and CDR is a plist
830 containing `:type', `:begin', `:end', `:hiddenp',
831 `:contents-begin', `:contents-end' and `:post-blank' keywords.
833 Assume point is at the beginning of the block."
859 "Interpret SPECIAL-BLOCK element as Org syntax.
860 CONTENTS is the contents of the element."
865 \f
866 ;;; Elements
867 ;;
868 ;; For each element, a parser and an interpreter are also defined.
869 ;; Both follow the same naming convention used for greater elements.
870 ;;
871 ;; Also, as for greater elements, adding a new element type is done
872 ;; through the following steps: implement a parser and an interpreter,
873 ;; tweak `org-element-current-element' so that it recognizes the new
874 ;; type and add that new type to `org-element-all-elements'.
875 ;;
876 ;; As a special case, when the newly defined type is a block type,
877 ;; `org-element-block-name-alist' has to be modified accordingly.
880 ;;;; Babel Call
883 "Parse a babel call.
885 Return a list whose CAR is `babel-call' and CDR is a plist
886 containing `:begin', `:end', `:info' and `:post-blank' as
887 keywords."
903 "Interpret BABEL-CALL element as Org syntax.
904 CONTENTS is nil."
910 ;; Remove redundant square brackets.
915 ;;;; Clock
918 "Parse a clock.
920 Return a list whose CAR is `clock' and CDR is a plist containing
921 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
922 as keywords."
947 "Interpret CLOCK element as Org syntax.
948 CONTENTS is nil."
955 "%2s:%02s"
959 ;;;; Comment
962 "Parse a comment.
964 Return a list whose CAR is `comment' and CDR is a plist
965 containing `:begin', `:end', `:value' and `:post-blank'
966 keywords.
968 Assume point is at comment beginning."
972 ;; Match first line with a loose regexp since it might as
973 ;; well be an ill-defined keyword.
979 ;; Get comments ending. This may not be accurate if
980 ;; commented lines within an item are followed by
981 ;; commented lines outside of a list. Though, parser will
982 ;; always get it right as it already knows surrounding
983 ;; element and has narrowed buffer to its contents.
986 ;; Accumulate lines without leading hash and plus sign
987 ;; if any. First whitespace is also ignored.
1005 "Interpret COMMENT element as Org syntax.
1006 CONTENTS is nil."
1010 ;;;; Comment Block
1013 "Parse an export block.
1015 Return a list whose CAR is `comment-block' and CDR is a plist
1016 containing `:begin', `:end', `:hiddenp', `:value' and
1017 `:post-blank' keywords.
1019 Assume point is at comment block beginning."
1042 "Interpret COMMENT-BLOCK element as Org syntax.
1043 CONTENTS is nil."
1048 ;;;; Example Block
1051 "Parse an example block.
1053 Return a list whose CAR is `example-block' and CDR is a plist
1054 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1055 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1056 `:switches', `:value' and `:post-blank' keywords."
1062 ;; Switches analysis
1067 ;; Should labels be retained in (or stripped from) example
1068 ;; blocks?
1073 ;; What should code-references use - labels or
1074 ;; line-numbers?
1081 ;; Standard block parsing.
1108 "Interpret EXAMPLE-BLOCK element as Org syntax.
1109 CONTENTS is nil."
1117 ;;;; Export Block
1120 "Parse an export block.
1122 Return a list whose CAR is `export-block' and CDR is a plist
1123 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1124 `:post-blank' keywords.
1126 Assume point is at export-block beginning."
1152 "Interpret EXPORT-BLOCK element as Org syntax.
1153 CONTENTS is nil."
1160 ;;;; Fixed-width
1163 "Parse a fixed-width section.
1165 Return a list whose CAR is `fixed-width' and CDR is a plist
1166 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1168 Assume point is at the beginning of the fixed-width area."
1172 value
1174 ;; Ending position may not be accurate if fixed-width
1175 ;; lines within an item are followed by fixed-width lines
1176 ;; outside of a list. Though, parser will always get it
1177 ;; right as it already knows surrounding element and has
1178 ;; narrowed buffer to its contents.
1181 ;, Accumulate text without starting colons.
1199 "Interpret FIXED-WIDTH element as Org syntax.
1200 CONTENTS is nil."
1205 ;;;; Horizontal Rule
1208 "Parse an horizontal rule.
1210 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1211 containing `:begin', `:end' and `:post-blank' keywords."
1225 "Interpret HORIZONTAL-RULE element as Org syntax.
1226 CONTENTS is nil."
1230 ;;;; Keyword
1233 "Parse a keyword at point.
1235 Return a list whose CAR is `keyword' and CDR is a plist
1236 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1237 keywords."
1257 "Interpret KEYWORD element as Org syntax.
1258 CONTENTS is nil."
1264 ;;;; Latex Environment
1267 "Parse a LaTeX environment.
1269 Return a list whose CAR is `latex-environment' and CDR is a plist
1270 containing `:begin', `:end', `:value' and `:post-blank'
1271 keywords.
1273 Assume point is at the beginning of the latex environment."
1296 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1297 CONTENTS is nil."
1301 ;;;; Paragraph
1304 "Parse a paragraph.
1306 Return a list whose CAR is `paragraph' and CDR is a plist
1307 containing `:begin', `:end', `:contents-begin' and
1308 `:contents-end' and `:post-blank' keywords.
1310 Assume point is at the beginning of the paragraph."
1332 "Interpret PARAGRAPH element as Org syntax.
1333 CONTENTS is the contents of the element."
1334 contents)
1337 ;;;; Planning
1340 "Parse a planning.
1342 Return a list whose CAR is `planning' and CDR is a plist
1343 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1344 and `:post-blank' keywords."
1353 closed deadline scheduled)
1373 "Interpret PLANNING element as Org syntax.
1374 CONTENTS is nil."
1376 'identity
1387 ;;;; Property Drawer
1390 "Parse a property drawer.
1392 Return a list whose CAR is `property-drawer' and CDR is a plist
1393 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1394 `:contents-end', `:properties' and `:post-blank' keywords.
1396 Assume point is at the beginning of the property drawer."
1410 val))
1412 val))
1426 "Interpret PROPERTY-DRAWER element as Org syntax.
1427 CONTENTS is nil."
1437 ;;;; Quote Section
1440 "Parse a quote section.
1442 Return a list whose CAR is `quote-section' and CDR is a plist
1443 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1445 Assume point is at beginning of the section."
1461 "Interpret QUOTE-SECTION element as Org syntax.
1462 CONTENTS is nil."
1466 ;;;; Src Block
1469 "Parse a src block.
1471 Return a list whose CAR is `src-block' and CDR is a plist
1472 containing `:language', `:switches', `:parameters', `:begin',
1473 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1474 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1475 `:post-blank' keywords.
1477 Assume point is at the beginning of the block."
1481 ;; Get affiliated keywords.
1483 ;; Get beginning position.
1485 ;; Get language as a string.
1494 ;; Get switches.
1496 ;; Get parameters.
1498 ;; Switches analysis
1506 ;; Should labels be retained in (or stripped from) src
1507 ;; blocks?
1512 ;; What should code-references use - labels or
1513 ;; line-numbers?
1517 ;; Get position at end of block.
1521 ;; Retrieve code.
1527 ;; Get position after ending blank lines.
1530 ;; Get visibility status.
1553 "Interpret SRC-BLOCK element as Org syntax.
1554 CONTENTS is nil."
1574 value
1578 ;;;; Table
1581 "Parse a table at point.
1583 Return a list whose CAR is `table' and CDR is a plist containing
1584 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1585 `:contents-end', `:value' and `:post-blank' keywords.
1587 Assume point is at the beginning of the table."
1599 acc))
1608 ;; Only `org' tables have contents. `table.el' tables
1609 ;; use a `:value' property to store raw table as
1610 ;; a string.
1615 table-begin table-end))
1620 "Interpret TABLE element as Org syntax.
1621 CONTENTS is nil."
1632 ;;;; Table Row
1635 "Parse table row at point.
1637 Return a list whose CAR is `table-row' and CDR is a plist
1638 containing `:begin', `:end', `:contents-begin', `:contents-end',
1639 `:type' and `:post-blank' keywords."
1643 ;; A table rule has no contents. In that case, ensure
1644 ;; CONTENTS-BEGIN matches CONTENTS-END.
1663 "Interpret TABLE-ROW element as Org syntax.
1664 CONTENTS is the contents of the table row."
1669 ;;;; Verse Block
1672 "Parse a verse block.
1674 Return a list whose CAR is `verse-block' and CDR is a plist
1675 containing `:begin', `:end', `:contents-begin', `:contents-end',
1676 `:hiddenp' and `:post-blank' keywords.
1678 Assume point is at beginning of the block."
1702 "Interpret VERSE-BLOCK element as Org syntax.
1703 CONTENTS is verse block contents."
1707 \f
1708 ;;; Objects
1709 ;;
1710 ;; Unlike to elements, interstices can be found between objects.
1711 ;; That's why, along with the parser, successor functions are provided
1712 ;; for each object. Some objects share the same successor (i.e. `code'
1713 ;; and `verbatim' objects).
1714 ;;
1715 ;; A successor must accept a single argument bounding the search. It
1716 ;; will return either a cons cell whose CAR is the object's type, as
1717 ;; a symbol, and CDR the position of its next occurrence, or nil.
1718 ;;
1719 ;; Successors follow the naming convention:
1720 ;; org-element-NAME-successor, where NAME is the name of the
1721 ;; successor, as defined in `org-element-all-successors'.
1722 ;;
1723 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1724 ;; object types they can contain will be specified in
1725 ;; `org-element-object-restrictions'.
1726 ;;
1727 ;; Adding a new type of object is simple. Implement a successor,
1728 ;; a parser, and an interpreter for it, all following the naming
1729 ;; convention. Register type in `org-element-all-objects' and
1730 ;; successor in `org-element-all-successors'. Maybe tweak
1731 ;; restrictions about it, and that's it.
1734 ;;;; Bold
1737 "Parse bold object at point.
1739 Return a list whose CAR is `bold' and CDR is a plist with
1740 `:begin', `:end', `:contents-begin' and `:contents-end' and
1741 `:post-blank' keywords.
1743 Assume point is at the first star marker."
1761 "Interpret BOLD object as Org syntax.
1762 CONTENTS is the contents of the object."
1766 "Search for the next text-markup object.
1768 LIMIT bounds the search.
1770 Return value is a cons cell whose CAR is a symbol among `bold',
1771 `italic', `underline', `strike-through', `code' and `verbatim'
1772 and CDR is beginning position."
1788 ;;;; Code
1791 "Parse code object at point.
1793 Return a list whose CAR is `code' and CDR is a plist with
1794 `:value', `:begin', `:end' and `:post-blank' keywords.
1796 Assume point is at the first tilde marker."
1812 "Interpret CODE object as Org syntax.
1813 CONTENTS is nil."
1817 ;;;; Entity
1820 "Parse entity at point.
1822 Return a list whose CAR is `entity' and CDR a plist with
1823 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1824 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1825 keywords.
1827 Assume point is at the beginning of the entity."
1829 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
1851 "Interpret ENTITY object as Org syntax.
1852 CONTENTS is nil."
1858 "Search for the next latex-fragment or entity object.
1860 LIMIT bounds the search.
1862 Return value is a cons cell whose CAR is `entity' or
1863 `latex-fragment' and CDR is beginning position."
1866 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1873 limit t)
1876 ;; Determine if it's a real entity or a LaTeX command.
1879 ;; No entity nor command: point is at a LaTeX fragment.
1880 ;; Determine its type to get the correct beginning position.
1888 matchers)
1892 ;;;; Export Snippet
1895 "Parse export snippet at point.
1897 Return a list whose CAR is `export-snippet' and CDR a plist with
1898 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1899 keywords.
1901 Assume point is at the beginning of the snippet."
1919 "Interpret EXPORT-SNIPPET object as Org syntax.
1920 CONTENTS is nil."
1926 "Search for the next export-snippet object.
1928 LIMIT bounds the search.
1930 Return value is a cons cell whose CAR is `export-snippet' and CDR
1931 its beginning position."
1940 ;;;; Footnote Reference
1943 "Parse footnote reference at point.
1945 Return a list whose CAR is `footnote-reference' and CDR a plist
1946 with `:label', `:type', `:inline-definition', `:begin', `:end'
1947 and `:post-blank' as keywords."
1980 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1981 CONTENTS is nil."
1991 "Search for the next footnote-reference object.
1993 LIMIT bounds the search.
1995 Return value is a cons cell whose CAR is `footnote-reference' and
1996 CDR is beginning position."
2010 ;;;; Inline Babel Call
2013 "Parse inline babel call at point.
2015 Return a list whose CAR is `inline-babel-call' and CDR a plist
2016 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2018 Assume point is at the beginning of the babel call."
2034 "Interpret INLINE-BABEL-CALL object as Org syntax.
2035 CONTENTS is nil."
2041 ;; Remove redundant square brackets.
2044 main-source)
2048 "Search for the next inline-babel-call object.
2050 LIMIT bounds the search.
2052 Return value is a cons cell whose CAR is `inline-babel-call' and
2053 CDR is beginning position."
2055 ;; Use a simplified version of
2056 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2058 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2059 limit t)
2063 ;;;; Inline Src Block
2066 "Parse inline source block at point.
2068 Return a list whose CAR is `inline-src-block' and CDR a plist
2069 with `:begin', `:end', `:language', `:value', `:parameters' and
2070 `:post-blank' as keywords.
2072 Assume point is at the beginning of the inline src block."
2092 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2093 CONTENTS is nil."
2098 language
2100 body)))
2103 "Search for the next inline-babel-call element.
2105 LIMIT bounds the search.
2107 Return value is a cons cell whose CAR is `inline-babel-call' and
2108 CDR is beginning position."
2113 ;;;; Italic
2116 "Parse italic object at point.
2118 Return a list whose CAR is `italic' and CDR is a plist with
2119 `:begin', `:end', `:contents-begin' and `:contents-end' and
2120 `:post-blank' keywords.
2122 Assume point is at the first slash marker."
2140 "Interpret ITALIC object as Org syntax.
2141 CONTENTS is the contents of the object."
2145 ;;;; Latex Fragment
2148 "Parse latex fragment at point.
2150 Return a list whose CAR is `latex-fragment' and CDR a plist with
2151 `:value', `:begin', `:end', and `:post-blank' as keywords.
2153 Assume point is at the beginning of the latex fragment."
2167 ;; None found: it's a macro.
2181 "Interpret LATEX-FRAGMENT object as Org syntax.
2182 CONTENTS is nil."
2185 ;;;; Line Break
2188 "Parse line break at point.
2190 Return a list whose CAR is `line-break', and CDR a plist with
2191 `:begin', `:end' and `:post-blank' keywords.
2193 Assume point is at the beginning of the line break."
2199 "Interpret LINE-BREAK object as Org syntax.
2200 CONTENTS is nil."
2204 "Search for the next line-break object.
2206 LIMIT bounds the search.
2208 Return value is a cons cell whose CAR is `line-break' and CDR is
2209 beginning position."
2213 ;; A line break can only happen on a non-empty line.
2218 ;;;; Link
2221 "Parse link at point.
2223 Return a list whose CAR is `link' and CDR a plist with `:type',
2224 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2225 `:contents-end' and `:post-blank' as keywords.
2227 Assume point is at the beginning of the link."
2230 end contents-begin contents-end link-end post-blank path type
2231 raw-link link)
2233 ;; Type 1: Text targeted from a radio target.
2238 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2243 ;; RAW-LINK is the original link.
2248 ;; Determine TYPE of link and set PATH accordingly.
2250 ;; File type.
2253 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2256 ;; Id type: PATH is the id.
2259 ;; Code-ref type: PATH is the name of the reference.
2262 ;; Custom-id type: PATH is the name of the custom id.
2265 ;; Fuzzy type: Internal link either matches a target, an
2266 ;; headline name or nothing. PATH is the target or
2267 ;; headline's name.
2269 ;; Type 3: Plain link, i.e. http://orgmode.org
2275 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2282 ;; In any case, deduce end point after trailing white space from
2283 ;; LINK-END variable.
2297 "Interpret LINK object as Org syntax.
2298 CONTENTS is the contents of the object, or nil."
2303 raw-link
2307 "Search for the next link object.
2309 LIMIT bounds the search.
2311 Return value is a cons cell whose CAR is `link' and CDR is
2312 beginning position."
2321 ;;;; Macro
2324 "Parse macro at point.
2326 Return a list whose CAR is `macro' and CDR a plist with `:key',
2327 `:args', `:begin', `:end', `:value' and `:post-blank' as
2328 keywords.
2330 Assume point is at the macro."
2344 ;; Repair bad splits.
2359 "Interpret MACRO object as Org syntax.
2360 CONTENTS is nil."
2364 "Search for the next macro object.
2366 LIMIT bounds the search.
2368 Return value is cons cell whose CAR is `macro' and CDR is
2369 beginning position."
2373 limit t)
2377 ;;;; Radio-target
2380 "Parse radio target at point.
2382 Return a list whose CAR is `radio-target' and CDR a plist with
2383 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2384 and `:post-blank' as keywords.
2386 Assume point is at the radio target."
2405 "Interpret TARGET object as Org syntax.
2406 CONTENTS is the contents of the object."
2410 "Search for the next radio-target object.
2412 LIMIT bounds the search.
2414 Return value is a cons cell whose CAR is `radio-target' and CDR
2415 is beginning position."
2421 ;;;; Statistics Cookie
2424 "Parse statistics cookie at point.
2426 Return a list whose CAR is `statistics-cookie', and CDR a plist
2427 with `:begin', `:end', `:value' and `:post-blank' keywords.
2429 Assume point is at the beginning of the statistics-cookie."
2445 "Interpret STATISTICS-COOKIE object as Org syntax.
2446 CONTENTS is nil."
2450 "Search for the next statistics cookie object.
2452 LIMIT bounds the search.
2454 Return value is a cons cell whose CAR is `statistics-cookie' and
2455 CDR is beginning position."
2461 ;;;; Strike-Through
2464 "Parse strike-through object at point.
2466 Return a list whose CAR is `strike-through' and CDR is a plist
2467 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2468 `:post-blank' keywords.
2470 Assume point is at the first plus sign marker."
2488 "Interpret STRIKE-THROUGH object as Org syntax.
2489 CONTENTS is the contents of the object."
2493 ;;;; Subscript
2496 "Parse subscript at point.
2498 Return a list whose CAR is `subscript' and CDR a plist with
2499 `:begin', `:end', `:contents-begin', `:contents-end',
2500 `:use-brackets-p' and `:post-blank' as keywords.
2502 Assume point is at the underscore."
2506 t
2524 "Interpret SUBSCRIPT object as Org syntax.
2525 CONTENTS is the contents of the object."
2528 contents))
2531 "Search for the next sub/superscript object.
2533 LIMIT bounds the search.
2535 Return value is a cons cell whose CAR is either `subscript' or
2536 `superscript' and CDR is beginning position."
2543 ;;;; Superscript
2546 "Parse superscript at point.
2548 Return a list whose CAR is `superscript' and CDR a plist with
2549 `:begin', `:end', `:contents-begin', `:contents-end',
2550 `:use-brackets-p' and `:post-blank' as keywords.
2552 Assume point is at the caret."
2573 "Interpret SUPERSCRIPT object as Org syntax.
2574 CONTENTS is the contents of the object."
2577 contents))
2580 ;;;; Table Cell
2583 "Parse table cell at point.
2585 Return a list whose CAR is `table-cell' and CDR is a plist
2586 containing `:begin', `:end', `:contents-begin', `:contents-end'
2587 and `:post-blank' keywords."
2601 "Interpret TABLE-CELL element as Org syntax.
2602 CONTENTS is the contents of the cell, or nil."
2606 "Search for the next table-cell object.
2608 LIMIT bounds the search.
2610 Return value is a cons cell whose CAR is `table-cell' and CDR is
2611 beginning position."
2615 ;;;; Target
2618 "Parse target at point.
2620 Return a list whose CAR is `target' and CDR a plist with
2621 `:begin', `:end', `:value' and `:post-blank' as keywords.
2623 Assume point is at the target."
2638 "Interpret TARGET object as Org syntax.
2639 CONTENTS is nil."
2643 "Search for the next target object.
2645 LIMIT bounds the search.
2647 Return value is a cons cell whose CAR is `target' and CDR is
2648 beginning position."
2654 ;;;; Timestamp
2657 "Parse time stamp at point.
2659 Return a list whose CAR is `timestamp', and CDR a plist with
2660 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2662 Assume point is at the beginning of the timestamp."
2688 "Interpret TIMESTAMP object as Org syntax.
2689 CONTENTS is nil."
2693 "Search for the next timestamp object.
2695 LIMIT bounds the search.
2697 Return value is a cons cell whose CAR is `timestamp' and CDR is
2698 beginning position."
2706 limit t)
2710 ;;;; Underline
2713 "Parse underline object at point.
2715 Return a list whose CAR is `underline' and CDR is a plist with
2716 `:begin', `:end', `:contents-begin' and `:contents-end' and
2717 `:post-blank' keywords.
2719 Assume point is at the first underscore marker."
2737 "Interpret UNDERLINE object as Org syntax.
2738 CONTENTS is the contents of the object."
2742 ;;;; Verbatim
2745 "Parse verbatim object at point.
2747 Return a list whose CAR is `verbatim' and CDR is a plist with
2748 `:value', `:begin', `:end' and `:post-blank' keywords.
2750 Assume point is at the first equal sign marker."
2766 "Interpret VERBATIM object as Org syntax.
2767 CONTENTS is nil."
2771 \f
2772 ;;; Definitions And Rules
2773 ;;
2774 ;; Define elements, greater elements and specify recursive objects,
2775 ;; along with the affiliated keywords recognized. Also set up
2776 ;; restrictions on recursive objects combinations.
2777 ;;
2778 ;; These variables really act as a control center for the parsing
2779 ;; process.
2782 ;; Headlines and inlinetasks.
2784 ;; Comments, blocks (any type), keywords and babel calls.
2786 ;; Lists.
2788 ;; Fixed-width, drawers (any type) and tables.
2790 ;; Footnote definitions.
2792 ;; Horizontal rules.
2794 ;; LaTeX environments.
2796 ;; Planning and Clock lines.
2806 export-block fixed-width footnote-definition headline
2807 horizontal-rule inlinetask item keyword latex-environment
2808 babel-call paragraph plain-list planning property-drawer
2809 quote-block quote-section section special-block src-block table
2810 table-row verse-block)
2815 item plain-list quote-block section special-block table)
2820 latex-or-entity line-break link macro radio-target
2821 statistics-cookie sub/superscript table-cell target
2822 text-markup timestamp)
2831 "Alist of translations between object type and successor name.
2833 Sharing the same successor comes handy when, for example, the
2838 inline-src-block italic line-break latex-fragment link macro
2839 radio-target statistics-cookie strike-through subscript superscript
2840 table-cell target timestamp underline verbatim)
2845 table-cell underline)
2860 "Alist between block names and the associated parsing function.
2861 Names must be uppercase. Any block whose name has no association
2867 "List of affiliated keywords as strings.
2875 "Alist of usual translations for keywords.
2876 The key is the old name and the value the new one. The property
2880 "List of affiliated keywords that can occur more that once in an element.
2882 Their value will be consed into a list of strings, which will be
2883 returned as the value of the property.
2885 This list is checked after translations have been applied. See
2886 `org-element-keyword-translation-alist'.
2892 "List of keywords whose value can be parsed.
2894 Their value will be stored as a secondary string: a list of
2895 strings and objects.
2897 This list is checked after translations have been applied. See
2901 "List of keywords which can have a secondary value.
2903 In Org syntax, they can be written with optional square brackets
2904 before the colons. For example, results keyword can be
2905 associated to a hash value with the following:
2907 #+RESULTS[hash-string]: some-source
2909 This list is checked after translations have been applied. See
2916 inline-babel-call inline-src-block latex-fragment
2917 line-break link macro radio-target sub/superscript
2918 target text-markup timestamp)
2920 macro radio-target statistics-cookie sub/superscript target
2921 text-markup timestamp)
2935 link radio-target sub/superscript target text-markup
2936 timestamp)
2947 latex-fragment line-break link macro radio-target
2949 "Alist of objects restrictions.
2951 CAR is an element or object type containing objects and CDR is
2952 a list of successors that will be called within an element or
2953 object of such type.
2955 For example, in a `radio-target' object, one can only find
2956 entities, export snippets, latex-fragments, subscript and
2957 superscript.
2959 This alist also applies to secondary string. For example, an
2960 `headline' type element doesn't directly contain objects, but
2971 \f
2972 ;;; Accessors
2973 ;;
2974 ;; Provide four accessors: `org-element-type', `org-element-property'
2975 ;; `org-element-contents' and `org-element-restriction'.
2978 "Return type of element ELEMENT.
2980 The function returns the type of the element or object provided.
2981 It can also return the following special value:
2982 `plain-text' for a string
2983 `org-data' for a complete document
2984 nil in any other case."
2990 "Extract the value from the PROPERTY of an ELEMENT."
2994 "Extract contents from an ELEMENT."
2998 "Return restriction associated to ELEMENT.
2999 ELEMENT can be an element, an object or a symbol representing an
3000 element or object type."
3002 org-element-object-restrictions)))
3005 \f
3006 ;;; Parsing Element Starting At Point
3007 ;;
3008 ;; `org-element-current-element' is the core function of this section.
3009 ;; It returns the Lisp representation of the element starting at
3010 ;; point.
3011 ;;
3012 ;; `org-element-current-element' makes use of special modes. They are
3013 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3014 ;; or fixed conditional element chaining (i.e. `headline' >
3015 ;; `section'). Special modes are: `section', `quote-section', `item'
3016 ;; and `table-row'.
3019 "Parse the element starting at point.
3021 Return value is a list like (TYPE PROPS) where TYPE is the type
3022 of the element and PROPS a plist of properties associated to the
3023 element.
3025 Possible types are defined in `org-element-all-elements'.
3027 Optional argument GRANULARITY determines the depth of the
3028 recursion. Allowed values are `headline', `greater-element',
3029 `element', `object' or nil. When it is broader than `object' (or
3030 nil), secondary values will not be parsed, since they only
3031 contain objects.
3033 Optional argument SPECIAL, when non-nil, can be either `section',
3034 `quote-section', `table-row' and `item'.
3036 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3037 be computed.
3039 This function assumes point is always at the beginning of the
3040 element it has to parse."
3042 ;; If point is at an affiliated keyword, try moving to the
3043 ;; beginning of the associated element. If none is found, the
3044 ;; keyword is orphaned and will be treated as plain text.
3050 ;; Determine if parsing depth allows for secondary strings
3051 ;; parsing. It only applies to elements referenced in
3052 ;; `org-element-secondary-value-alist'.
3055 ;; Item.
3058 raw-secondary-p))
3059 ;; Quote Section.
3061 ;; Table Row.
3063 ;; Headline.
3066 ;; Section (must be checked after headline).
3068 ;; Planning and Clock.
3073 ;; Blocks.
3084 ;; Inlinetask.
3086 ;; LaTeX Environment.
3092 nil t))
3095 ;; Drawer and Property Drawer.
3103 ;; Fixed Width
3105 ;; Babel Call, Dynamic Block and Keyword.
3118 ;; Footnote Definition.
3121 ;; Comment.
3124 ;; Horizontal Rule.
3127 ;; Table.
3129 ;; List.
3132 ;; Default element: Paragraph.
3136 ;; Most elements can have affiliated keywords. When looking for an
3137 ;; element beginning, we want to move before them, as they belong to
3138 ;; that element, and, in the meantime, collect information they give
3139 ;; into appropriate properties. Hence the following function.
3140 ;;
3141 ;; Usage of optional arguments may not be obvious at first glance:
3142 ;;
3143 ;; - TRANS-LIST is used to polish keywords names that have evolved
3144 ;; during Org history. In example, even though =result= and
3145 ;; =results= coexist, we want to have them under the same =result=
3146 ;; property. It's also true for "srcname" and "name", where the
3147 ;; latter seems to be preferred nowadays (thus the "name" property).
3148 ;;
3149 ;; - CONSED allows to regroup multi-lines keywords under the same
3150 ;; property, while preserving their own identity. This is mostly
3151 ;; used for "attr_latex" and al.
3152 ;;
3153 ;; - PARSED prepares a keyword value for export. This is useful for
3154 ;; "caption". Objects restrictions for such keywords are defined in
3155 ;; `org-element-object-restrictions'.
3156 ;;
3157 ;; - DUALS is used to take care of keywords accepting a main and an
3158 ;; optional secondary values. For example "results" has its
3159 ;; source's name as the main value, and may have an hash string in
3160 ;; optional square brackets as the secondary one.
3161 ;;
3162 ;; A keyword may belong to more than one category.
3166 ;; Regular affiliated keywords.
3169 "Regexp matching any affiliated keyword.
3171 Keyword name is put in match group 1. Moreover, if keyword
3172 belongs to `org-element-dual-keywords', put the dual value in
3173 match group 2.
3179 "Collect affiliated keywords before point.
3181 Optional argument KEY-RE is a regexp matching keywords, which
3182 puts matched keyword in group 1. It defaults to
3183 `org-element--affiliated-re'.
3185 TRANS-LIST is an alist where key is the keyword and value the
3186 property name it should be translated to, without the colons. It
3187 defaults to `org-element-keyword-translation-alist'.
3189 CONSED is a list of strings. Any keyword belonging to that list
3190 will have its value consed. The check is done after keyword
3191 translation. It defaults to `org-element-multiple-keywords'.
3193 PARSED is a list of strings. Any keyword member of this list
3194 will have its value parsed. The check is done after keyword
3195 translation. If a keyword is a member of both CONSED and PARSED,
3196 it's value will be a list of parsed strings. It defaults to
3197 `org-element-parsed-keywords'.
3199 DUALS is a list of strings. Any keyword member of this list can
3200 have two parts: one mandatory and one optional. Its value is
3201 a cons cell whose CAR is the former, and the CDR the latter. If
3202 a keyword is a member of both PARSED and DUALS, both values will
3203 be parsed. It defaults to `org-element-dual-keywords'.
3205 Return a list whose CAR is the position at the first of them and
3206 CDR a plist of keywords and values."
3214 ;; RESTRICT is the list of objects allowed in parsed
3215 ;; keywords value.
3217 output)
3221 ;; Apply translation to RAW-KWD. From there, KWD is
3222 ;; the official keyword.
3224 ;; Find main value for any keyword.
3230 ;; If KWD is a dual keyword, find its secondary
3231 ;; value. Maybe parse it.
3237 ;; Attribute a property name to KWD.
3239 ;; Now set final shape for VALUE.
3243 ;; VALUE is mandatory. Set it to nil if there is none.
3245 ;; Attributes are always consed.
3248 ;; Eventually store the new value in OUTPUT.
3254 \f
3255 ;;; The Org Parser
3256 ;;
3257 ;; The two major functions here are `org-element-parse-buffer', which
3258 ;; parses Org syntax inside the current buffer, taking into account
3259 ;; region, narrowing, or even visibility if specified, and
3260 ;; `org-element-parse-secondary-string', which parses objects within
3261 ;; a given string.
3262 ;;
3263 ;; The (almost) almighty `org-element-map' allows to apply a function
3264 ;; on elements or objects matching some type, and accumulate the
3265 ;; resulting values. In an export situation, it also skips unneeded
3266 ;; parts of the parse tree.
3269 "Recursively parse the buffer and return structure.
3270 If narrowing is in effect, only parse the visible part of the
3271 buffer.
3273 Optional argument GRANULARITY determines the depth of the
3274 recursion. It can be set to the following symbols:
3276 `headline' Only parse headlines.
3277 `greater-element' Don't recurse into greater elements excepted
3278 headlines and sections. Thus, elements
3279 parsed are the top-level ones.
3280 `element' Parse everything but objects and plain text.
3281 `object' Parse the complete buffer (default).
3283 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3284 elements.
3286 Assume buffer is in Org mode."
3292 ;; Start in `section' mode so text before the first
3293 ;; headline belongs to a section.
3297 "Recursively parse objects in STRING and return structure.
3299 RESTRICTION, when non-nil, is a symbol limiting the object types
3300 that will be looked after."
3306 "Map a function on selected elements or objects.
3308 DATA is the parsed tree, as returned by, i.e,
3309 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3310 of elements or objects types. FUN is the function called on the
3311 matching element or object. It must accept one arguments: the
3312 element or object itself.
3314 When optional argument INFO is non-nil, it should be a plist
3315 holding export options. In that case, parts of the parse tree
3316 not exportable according to that property list will be skipped.
3318 When optional argument FIRST-MATCH is non-nil, stop at the first
3319 match for which FUN doesn't return nil, and return that value.
3321 Optional argument NO-RECURSION is a symbol or a list of symbols
3322 representing elements or objects types. `org-element-map' won't
3323 enter any recursive element or object whose type belongs to that
3324 list. Though, FUN can still be applied on them.
3326 Nil values returned from FUN do not appear in the results."
3327 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3330 ;; Recursion depth is determined by --CATEGORY.
3337 ;; If one object is found, the function
3338 ;; has to recurse into every object.
3341 ;; If one regular element is found, the
3342 ;; function has to recurse, at lest, into
3343 ;; every element it encounters.
3346 types)
3347 category)))
3348 --acc
3349 --walk-tree
3353 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3354 ;; holding contextual information.
3358 ;; Ignored element in an export context.
3360 ;; Secondary string: only objects can be found there.
3363 ;; Unconditionally enter parse trees.
3367 ;; Check if TYPE is matching among TYPES. If so,
3368 ;; apply FUN to --DATA and accumulate return value
3369 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3375 ;; If --DATA has a secondary string that can contain
3376 ;; objects with their type among TYPES, look into it.
3383 ;; Determine if a recursion into --DATA is possible.
3385 ;; --TYPE is explicitly removed from recursion.
3387 ;; --DATA has no contents.
3389 ;; Looking for greater elements but --DATA is simply
3390 ;; an element or an object.
3393 ;; Looking for elements but --DATA is an object.
3396 ;; In any other case, map contents.
3400 ;; Return value in a proper order.
3403 ;; The following functions are internal parts of the parser.
3404 ;;
3405 ;; The first one, `org-element-parse-elements' acts at the element's
3406 ;; level.
3407 ;;
3408 ;; The second one, `org-element-parse-objects' applies on all objects
3409 ;; of a paragraph or a secondary string. It uses
3410 ;; `org-element-get-candidates' to optimize the search of the next
3411 ;; object in the buffer.
3412 ;;
3413 ;; More precisely, that function looks for every allowed object type
3414 ;; first. Then, it discards failed searches, keeps further matches,
3415 ;; and searches again types matched behind point, for subsequent
3416 ;; calls. Thus, searching for a given type fails only once, and every
3417 ;; object is searched only once at top level (but sometimes more for
3418 ;; nested types).
3422 "Parse elements between BEG and END positions.
3424 SPECIAL prioritize some elements over the others. It can be set
3425 to `quote-section', `section' `item' or `table-row'.
3427 When value is `item', STRUCTURE will be used as the current list
3428 structure.
3430 GRANULARITY determines the depth of the recursion. See
3431 `org-element-parse-buffer' for more information.
3433 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3434 elements.
3436 Elements are accumulated into ACC."
3441 ;; When parsing only headlines, skip any text before first one.
3444 ;; Main loop start.
3446 ;; Find current element's type and parse it accordingly to
3447 ;; its category.
3449 granularity special structure))
3452 ;; Set ACC as parent of current element. It will be
3453 ;; completed by side-effect. If the element contains any
3454 ;; secondary string, also set `:parent' property of every
3455 ;; object within it as current element.
3464 sec-value)))))
3467 acc
3470 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3471 ;; true and element is hidden or if it has no contents
3472 ;; anyway.
3475 ;; Case 2. Greater element: parse it between
3476 ;; `contents-begin' and `contents-end'. Make sure
3477 ;; GRANULARITY allows the recursion, or ELEMENT is an
3478 ;; headline, in which case going inside is mandatory, in
3479 ;; order to get sub-level headings.
3487 ;; Possibly switch to a special mode.
3495 granularity visible-only element))
3496 ;; Case 3. ELEMENT has contents. Parse objects inside,
3497 ;; if GRANULARITY allows it.
3502 ;; Case 4. Else, just accumulate ELEMENT.
3504 ;; Return result.
3505 acc))
3508 "Parse objects between BEG and END and return recursive structure.
3510 Objects are accumulated in ACC.
3512 RESTRICTION is a list of object types which are allowed in the
3513 current object."
3517 ;; Return the parsing function associated to the nearest
3518 ;; object among list of candidates CAND.
3525 next-object candidates)
3529 end restriction candidates))
3531 ;; Set ACC as parent of current element. It will be completed
3532 ;; by side-effect.
3534 ;; 1. Text before any object. Untabify it.
3543 ;; 2. Object...
3548 cont-beg)
3549 ;; ... recursive. The CONT-BEG check is for
3550 ;; links, as some of them might not be recursive
3551 ;; (i.e. plain links).
3554 cont-beg
3558 ;; Restrict allowed objects.
3560 next-object)))
3563 ;; If the object contains any secondary string, also set
3564 ;; `:parent' property of every object within it as current
3565 ;; object.
3567 org-element-secondary-value-alist)))
3575 :parent
3576 complete-next-object)))
3577 sec-value)))))
3579 ;; 3. Text after last object. Untabify it.
3587 ;; Result.
3588 acc)))
3591 "Return an alist of candidates for the next object.
3593 LIMIT bounds the search, and RESTRICTION narrows candidates to
3594 some object types.
3596 Return value is an alist whose CAR is position and CDR the object
3597 type, as a symbol.
3599 OBJECTS is the previous candidates alist."
3601 ;; If no previous result, search every object type in RESTRICTION.
3602 ;; Otherwise, keep potential candidates (old objects located after
3603 ;; point) and ask to search again those which had matched before.
3608 objects))
3609 ;; Call the appropriate successor function for each type to search
3610 ;; and accumulate matches.
3617 type))))
3620 types-to-search)
3621 ;; Return alist.
3622 next-candidates))
3625 \f
3626 ;;; Towards A Bijective Process
3627 ;;
3628 ;; The parse tree obtained with `org-element-parse-buffer' is really
3629 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3630 ;; interpreted and expanded into a string with canonical Org syntax.
3631 ;; Hence `org-element-interpret-data'.
3632 ;;
3633 ;; The function relies internally on
3634 ;; `org-element-interpret--affiliated-keywords'.
3637 "Interpret DATA as Org syntax.
3639 DATA is a parse tree, an element, an object or a secondary string
3640 to interpret.
3642 Optional argument PARENT is used for recursive calls. It contains
3643 the element or object containing data, or nil.
3645 Return Org syntax as a string."
3649 ;; Secondary string.
3654 ;; Full Org document.
3659 ;; Plain text.
3661 ;; Element/Object without contents.
3664 data nil))
3665 ;; Element/Object with contents.
3675 ;; Elements directly containing objects must
3676 ;; have their indentation normalized first.
3678 data
3679 ;; When normalizing first paragraph of an
3680 ;; item or a footnote-definition, ignore
3681 ;; first line's indentation.
3688 data
3690 contents)))))))
3692 ;; Build white spaces. If no `:post-blank' property is
3693 ;; specified, assume its value is 0.
3703 "Return ELEMENT's affiliated keywords as Org syntax.
3704 If there is no affiliated keyword, return the empty string."
3714 ": "
3717 value)
3725 ;; All attribute keywords can have multiple lines.
3728 value
3731 ;; List all ELEMENT's properties matching an attribute line or an
3732 ;; affiliated keyword, but ignore translated keywords since they
3733 ;; cannot belong to the property list.
3740 org-element-keyword-translation-alist)))))
3741 collect prop)
3744 ;; Because interpretation of the parse tree must return the same
3745 ;; number of blank lines between elements and the same number of white
3746 ;; space after objects, some special care must be given to white
3747 ;; spaces.
3748 ;;
3749 ;; The first function, `org-element-normalize-string', ensures any
3750 ;; string different from the empty string will end with a single
3751 ;; newline character.
3752 ;;
3753 ;; The second function, `org-element-normalize-contents', removes
3754 ;; global indentation from the contents of the current element.
3757 "Ensure string S ends with a single newline character.
3759 If S isn't a string return it unchanged. If S is the empty
3760 string, return it. Otherwise, return a new string with a single
3761 newline character at its end."
3769 "Normalize plain text in ELEMENT's contents.
3771 ELEMENT must only contain plain text and objects.
3773 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3774 indentation to compute maximal common indentation.
3776 Return the normalized element that is element with global
3777 indentation removed from its contents. The function assumes that
3778 indentation is not done with TAB characters."
3780 collect-inds ; for byte-compiler
3783 ;; Return list of indentations within BLOB. This is done by
3784 ;; walking recursively BLOB and updating IND-LIST along the
3785 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3786 ;; been seen yet. It is required as this string is the only
3787 ;; one whose indentation doesn't happen after a newline
3788 ;; character.
3796 ;; An indentation of zero means no string will be
3797 ;; modified. Quit the process.
3803 ;; Avoid matching blank or empty lines.
3811 ;; Collect indentation list in ELEMENT. Possibly remove first
3812 ;; value if IGNORE-FIRST is non-nil.
3815 ;; Build ELEMENT back, replacing each string with the same
3816 ;; string minus common indentation.
3821 ;; Return BLOB with all its strings indentation
3822 ;; shortened from MCI white spaces. FIRST-FLAG is
3823 ;; non-nil when the first string hasn't been seen
3824 ;; yet.
3839 org-element-recursive-objects)
3846 \f
3847 ;;; The Toolbox
3848 ;;
3849 ;; The first move is to implement a way to obtain the smallest element
3850 ;; containing point. This is the job of `org-element-at-point'. It
3851 ;; basically jumps back to the beginning of section containing point
3852 ;; and moves, element after element, with
3853 ;; `org-element-current-element' until the container is found.
3854 ;;
3855 ;; Note: When using `org-element-at-point', secondary values are never
3856 ;; parsed since the function focuses on elements, not on objects.
3859 "Determine closest element around point.
3861 Return value is a list like (TYPE PROPS) where TYPE is the type
3862 of the element and PROPS a plist of properties associated to the
3863 element. Possible types are defined in
3864 `org-element-all-elements'.
3866 As a special case, if point is at the very beginning of a list or
3867 sub-list, returned element will be that list instead of the first
3868 item. In the same way, if point is at the beginning of the first
3869 row of a table, returned element will be the table instead of the
3870 first row.
3872 If optional argument KEEP-TRAIL is non-nil, the function returns
3873 a list of of elements leading to element at point. The list's
3874 CAR is always the element at point. Following positions contain
3875 element's siblings, then parents, siblings of parents, until the
3876 first element of current section."
3878 ;; If at an headline, parse it. It is the sole element that
3879 ;; doesn't require to know about context. Be sure to disallow
3880 ;; secondary string parsing, though.
3886 ;; Otherwise move at the beginning of the section containing
3887 ;; point.
3895 ;; Parse successively each element, skipping those ending
3896 ;; before original position.
3904 ;; 1. Skip any element ending before point or at point.
3909 ;; 2. An element containing point is always the element at
3910 ;; point.
3913 ;; 3. At any other greater element type, if point is
3914 ;; within contents, move into it. Otherwise, return
3915 ;; that element.
3932 ;; Once the local structure around point is well understood, it's easy
3933 ;; to implement some replacements for `forward-paragraph'
3934 ;; `backward-paragraph', namely `org-element-forward' and
3935 ;; `org-element-backward'.
3936 ;;
3937 ;; Also, `org-transpose-elements' mimics the behaviour of
3938 ;; `transpose-words', at the element's level, whereas
3939 ;; `org-element-drag-forward', `org-element-drag-backward', and
3940 ;; `org-element-up' generalize, respectively, functions
3941 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3942 ;;
3943 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3944 ;; smartly remove global indentation from buffer, making it possible
3945 ;; to use Org indent mode on a file created with hard indentation.
3946 ;;
3947 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3948 ;; internally by some of the previously cited tools.
3951 "Non-nil when elements ELEM-A and ELEM-B are nested."
3960 "Swap elements ELEM-A and ELEM-B.
3961 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
3962 end of ELEM-A."
3964 ;; There are two special cases when an element doesn't start at bol:
3965 ;; the first paragraph in an item or in a footnote definition.
3967 ;; Only a paragraph without any affiliated keyword can be moved at
3968 ;; ELEM-A position in such a situation. Note that the case of
3969 ;; a footnote definition is impossible: it cannot contain two
3970 ;; paragraphs in a row because it cannot contain a blank line.
3976 ;; In a special situation, ELEM-A will have no indentation. We'll
3977 ;; give it ELEM-B's (which will in, in turn, have no indentation).
3991 ;; Store overlays responsible for visibility status. We
3992 ;; also need to store their boundaries as they will be
3993 ;; removed from buffer.
4000 ;; Get contents.
4008 ;; Restore ex ELEM-A overlays.
4018 ;; Restore ex ELEM-B overlays.
4027 "Move forward by one element.
4028 Move to the next element at the same level, when possible."
4041 return prev)))
4049 "Move backward by one element.
4050 Move to the previous element at the same level, when possible."
4053 ;; At an headline, move to the previous one, if any, or stay
4054 ;; here.
4065 ;; Move to beginning of current element if point isn't there
4066 ;; already.
4072 "Move to upper element."
4082 return prev)))
4089 "Move to inner element."
4097 ;; If contents are hidden, first disclose them.
4103 "Move backward element at point."
4109 ;; Error out if no previous element or previous element is
4110 ;; a parent of the current one.
4119 "Move forward element at point."
4132 ;; Compute new position of point: it's shifted by NEXT-ELEM
4133 ;; body's length (without final blanks) and by the length of
4134 ;; blanks between ELEM and NEXT-ELEM.
4139 ;; Small correction if buffer doesn't end
4140 ;; with a newline character.
4153 "Put point at beginning of this element, mark at end.
4155 Interactively, if this command is repeated or (in Transient Mark
4156 mode) if the mark is active, it marks the next element after the
4157 ones already marked."
4172 "Narrow buffer to current element."
4190 "Transpose current and previous elements, keeping blank lines between.
4191 Point is moved after both elements."
4199 "Un-indent the visible part of the buffer.
4200 Relative indentation (between items, inside blocks, etc.) isn't
4201 modified."
4206 unindent-tree ; For byte-compiler.
4224 "Fill element at point, when applicable.
4226 This function only applies to paragraph, comment blocks, example
4227 blocks and fixed-width areas. Also, as a special case, re-align
4228 table when point is at one.
4230 If JUSTIFY is non-nil (interactively, with prefix argument),
4231 justify as well. If `sentence-end-double-space' is non-nil, then
4232 period followed by one space does not end a sentence, so don't
4233 break a line there. The variable `fill-column' controls the
4234 width for filling."
4237 ;; Align Org tables, leave table.el tables as-is.
4241 t)
4242 ;; Elements that may contain `line-break' type objects.
4246 ;; Do nothing if point is at an affiliated keyword or at
4247 ;; verse block markers.
4249 ;; At a verse block, first narrow to current "paragraph"
4250 ;; and set current element to that paragraph.
4263 ;; Fill paragraph, taking line breaks into consideration.
4264 ;; For that, slice the paragraph using line breaks as
4265 ;; separators, and fill the parts in reverse order to
4266 ;; avoid messing with markers.
4273 ;; Find the list of ending positions for line breaks
4274 ;; in the current paragraph. Add paragraph beginning
4275 ;; to include first slice.
4280 beg end nil org-element-all-objects)
4281 'line-break
4283 ;; Elements whose contents should be filled as plain text.
4297 ;; Ignore every other element.
4302 ;;; org-element.el ends here