| blob | 15de2a2608f45e6b599299531ac39f3b6fc603f0 |
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. All affiliated keywords
38 ;; are referenced in `org-element-affiliated-keywords'.
39 ;;
40 ;; Element containing other elements (and only elements) are called
41 ;; greater elements. Concerned types are: `center-block', `drawer',
42 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
43 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
44 ;;
45 ;; Other element types are: `babel-call', `clock', `comment',
46 ;; `comment-block', `example-block', `export-block', `fixed-width',
47 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
48 ;; `planning', `property-drawer', `quote-section', `src-block',
49 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
50 ;; and `verse-block' types can contain Org objects and plain text.
51 ;;
52 ;; Objects are related to document's contents. Some of them are
53 ;; recursive. Associated types are of the following: `bold', `code',
54 ;; `entity', `export-snippet', `footnote-reference',
55 ;; `inline-babel-call', `inline-src-block', `italic',
56 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
57 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
58 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
59 ;;
60 ;; Some elements also have special properties whose value can hold
61 ;; objects themselves (i.e. an item tag or an headline name). Such
62 ;; values are called "secondary strings". Any object belongs to
63 ;; either an element or a secondary string.
64 ;;
65 ;; Notwithstanding affiliated keywords, each greater element, element
66 ;; and object has a fixed set of properties attached to it. Among
67 ;; them, four are shared by all types: `:begin' and `:end', which
68 ;; refer to the beginning and ending buffer positions of the
69 ;; considered element or object, `:post-blank', which holds the number
70 ;; of blank lines, or white spaces, at its end and `:parent' which
71 ;; refers to the element or object containing it. Greater elements
72 ;; and elements containing objects will also have `:contents-begin'
73 ;; and `:contents-end' properties to delimit contents.
74 ;;
75 ;; Lisp-wise, an element or an object can be represented as a list.
76 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
77 ;; TYPE is a symbol describing the Org element or object.
78 ;; PROPERTIES is the property list attached to it. See docstring of
79 ;; appropriate parsing function to get an exhaustive
80 ;; list.
81 ;; CONTENTS is a list of elements, objects or raw strings contained
82 ;; in the current element or object, when applicable.
83 ;;
84 ;; An Org buffer is a nested list of such elements and objects, whose
85 ;; type is `org-data' and properties is nil.
86 ;;
87 ;; The first part of this file implements a parser and an interpreter
88 ;; for each type of Org syntax.
89 ;;
90 ;; The next two parts introduce four accessors and a function
91 ;; retrieving the element starting at point (respectively
92 ;; `org-element-type', `org-element-property', `org-element-contents',
93 ;; `org-element-restriction' and `org-element-current-element').
94 ;;
95 ;; The following part creates a fully recursive buffer parser. It
96 ;; also provides a tool to map a function to elements or objects
97 ;; matching some criteria in the parse tree. Functions of interest
98 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
99 ;; extent, `org-element-parse-secondary-string'.
100 ;;
101 ;; The penultimate part is the cradle of an interpreter for the
102 ;; obtained parse tree: `org-element-interpret-data'.
103 ;;
104 ;; The library ends by furnishing a set of interactive tools for
105 ;; element's navigation and manipulation, mostly based on
106 ;; `org-element-at-point' function.
109 ;;; Code:
115 \f
116 ;;; Greater elements
117 ;;
118 ;; For each greater element type, we define a parser and an
119 ;; interpreter.
120 ;;
121 ;; A parser returns the element or object as the list described above.
122 ;; Most of them accepts no argument. Though, exceptions exist. Hence
123 ;; every element containing a secondary string (see
124 ;; `org-element-secondary-value-alist') will accept an optional
125 ;; argument to toggle parsing of that secondary string. Moreover,
126 ;; `item' parser requires current list's structure as its first
127 ;; element.
128 ;;
129 ;; An interpreter accepts two arguments: the list representation of
130 ;; the element or object, and its contents. The latter may be nil,
131 ;; depending on the element or object considered. It returns the
132 ;; appropriate Org syntax, as a string.
133 ;;
134 ;; Parsing functions must follow the naming convention:
135 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
136 ;; defined in `org-element-greater-elements'.
137 ;;
138 ;; Similarly, interpreting functions must follow the naming
139 ;; convention: org-element-TYPE-interpreter.
140 ;;
141 ;; With the exception of `headline' and `item' types, greater elements
142 ;; cannot contain other greater elements of their own type.
143 ;;
144 ;; Beside implementing a parser and an interpreter, adding a new
145 ;; greater element requires to tweak `org-element-current-element'.
146 ;; Moreover, the newly defined type must be added to both
147 ;; `org-element-all-elements' and `org-element-greater-elements'.
150 ;;;; Center Block
153 "Parse a center block.
155 Return a list whose CAR is `center-block' and CDR is a plist
156 containing `:begin', `:end', `:hiddenp', `:contents-begin',
157 `:contents-end' and `:post-blank' keywords.
159 Assume point is at the beginning of the block."
182 "Interpret CENTER-BLOCK element as Org syntax.
183 CONTENTS is the contents of the element."
187 ;;;; Drawer
190 "Parse a drawer.
192 Return a list whose CAR is `drawer' and CDR is a plist containing
193 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
194 `:contents-end' and `:post-blank' keywords.
196 Assume point is at beginning of drawer."
221 "Interpret DRAWER element as Org syntax.
222 CONTENTS is the contents of the element."
225 contents))
228 ;;;; Dynamic Block
231 "Parse a dynamic block.
233 Return a list whose CAR is `dynamic-block' and CDR is a plist
234 containing `:block-name', `:begin', `:end', `:hiddenp',
235 `:contents-begin', `:contents-end', `:arguments' and
236 `:post-blank' keywords.
238 Assume point is at beginning of dynamic block."
265 "Interpret DYNAMIC-BLOCK element as Org syntax.
266 CONTENTS is the contents of the element."
271 contents))
274 ;;;; Footnote Definition
277 "Parse a footnote definition.
279 Return a list whose CAR is `footnote-definition' and CDR is
280 a plist containing `:label', `:begin' `:end', `:contents-begin',
281 `:contents-end' and `:post-blank' keywords.
283 Assume point is at the beginning of the footnote definition."
312 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
313 CONTENTS is the contents of the footnote-definition."
315 " "
316 contents))
319 ;;;; Headline
322 "Parse an headline.
324 Return a list whose CAR is `headline' and CDR is a plist
325 containing `:raw-value', `:title', `:begin', `:end',
326 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
327 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
328 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
329 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
330 keywords.
332 The plist also contains any property set in the property drawer,
333 with its name in lowercase, the underscores replaced with hyphens
334 and colons at the beginning (i.e. `:custom-id').
336 When RAW-SECONDARY-P is non-nil, headline's title will not be
337 parsed as a secondary string, but as a plain string instead.
339 Assume point is at beginning of the headline."
369 plist))
385 title)
386 ;; Clean RAW-VALUE from any quote or comment string.
391 ""
392 raw-value)))
393 ;; Clean TAGS from archive tag, if any.
395 ;; Then get TITLE.
426 "Interpret HEADLINE element as Org syntax.
427 CONTENTS is the contents of the element."
454 ;; Align tags.
462 ? )
463 tags))
467 tags))))
469 contents)))
472 ;;;; Inlinetask
475 "Parse an inline task.
477 Return a list whose CAR is `inlinetask' and CDR is a plist
478 containing `:title', `:begin', `:end', `:hiddenp',
479 `:contents-begin' and `:contents-end', `:level', `:priority',
480 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
481 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
483 The plist also contains any property set in the property drawer,
484 with its name in lowercase, the underscores replaced with hyphens
485 and colons at the beginning (i.e. `:custom-id').
487 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
488 title will not be parsed as a secondary string, but as a plain
489 string instead.
491 Assume point is at beginning of the inline task."
516 plist))
525 ;; In the case of a single line task, CONTENTS-BEGIN and
526 ;; CONTENTS-END might overlap.
549 ,@standard-props
553 "Interpret INLINETASK element as Org syntax.
554 CONTENTS is the contents of inlinetask."
569 ;; Align tags.
577 ? )
578 tags))
582 tags))))
583 ;; Prefer degenerate inlinetasks when there are no
584 ;; contents.
587 contents
591 ;;;; Item
594 "Parse an item.
596 STRUCT is the structure of the plain list.
598 Return a list whose CAR is `item' and CDR is a plist containing
599 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
600 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
601 `:post-blank' keywords.
603 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
604 any, will not be parsed as a secondary string, but as a plain
605 string instead.
607 Assume point is at the beginning of the item."
634 ;; If first line isn't empty,
635 ;; contents really start at the text
636 ;; after item's meta-data.
650 ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
651 ;; up in the case of an empty item separated
652 ;; from the next by a blank line. Thus, ensure
653 ;; the former is always the smallest of two.
664 "Interpret ITEM element as Org syntax.
665 CONTENTS is the contents of the element."
679 num
686 ;; Compute indentation.
691 ;; Indent contents.
693 bullet
706 ;;;; Plain List
709 "Parse a plain list.
711 Optional argument STRUCTURE, when non-nil, is the structure of
712 the plain list being parsed.
714 Return a list whose CAR is `plain-list' and CDR is a plist
715 containing `:type', `:begin', `:end', `:contents-begin' and
716 `:contents-end', `:structure' and `:post-blank' keywords.
718 Assume point is at the beginning of the list."
731 ;; Blank lines below list belong to the top-level list only.
736 ;; Return value.
748 "Interpret PLAIN-LIST element as Org syntax.
749 CONTENTS is the contents of the element."
750 contents)
753 ;;;; Quote Block
756 "Parse a quote block.
758 Return a list whose CAR is `quote-block' and CDR is a plist
759 containing `:begin', `:end', `:hiddenp', `:contents-begin',
760 `:contents-end' and `:post-blank' keywords.
762 Assume point is at the beginning of the block."
784 "Interpret QUOTE-BLOCK element as Org syntax.
785 CONTENTS is the contents of the element."
789 ;;;; Section
792 "Parse a section.
794 Return a list whose CAR is `section' and CDR is a plist
795 containing `:begin', `:end', `:contents-begin', `contents-end'
796 and `:post-blank' keywords."
798 ;; Beginning of section is the beginning of the first non-blank
799 ;; line after previous headline.
818 "Interpret SECTION element as Org syntax.
819 CONTENTS is the contents of the element."
820 contents)
823 ;;;; Special Block
826 "Parse a special block.
828 Return a list whose CAR is `special-block' and CDR is a plist
829 containing `:type', `:begin', `:end', `:hiddenp',
830 `:contents-begin', `:contents-end' and `:post-blank' keywords.
832 Assume point is at the beginning of the block."
858 "Interpret SPECIAL-BLOCK element as Org syntax.
859 CONTENTS is the contents of the element."
864 \f
865 ;;; Elements
866 ;;
867 ;; For each element, a parser and an interpreter are also defined.
868 ;; Both follow the same naming convention used for greater elements.
869 ;;
870 ;; Also, as for greater elements, adding a new element type is done
871 ;; through the following steps: implement a parser and an interpreter,
872 ;; tweak `org-element-current-element' so that it recognizes the new
873 ;; type and add that new type to `org-element-all-elements'.
874 ;;
875 ;; As a special case, when the newly defined type is a block type,
876 ;; `org-element-block-name-alist' has to be modified accordingly.
879 ;;;; Babel Call
882 "Parse a babel call.
884 Return a list whose CAR is `babel-call' and CDR is a plist
885 containing `:begin', `:end', `:info' and `:post-blank' as
886 keywords."
902 "Interpret BABEL-CALL element as Org syntax.
903 CONTENTS is nil."
909 ;; Remove redundant square brackets.
914 ;;;; Clock
917 "Parse a clock.
919 Return a list whose CAR is `clock' and CDR is a plist containing
920 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
921 as keywords."
946 "Interpret CLOCK element as Org syntax.
947 CONTENTS is nil."
954 "%2s:%02s"
958 ;;;; Comment
961 "Parse a comment.
963 Return a list whose CAR is `comment' and CDR is a plist
964 containing `:begin', `:end', `:value' and `:post-blank'
965 keywords.
967 Assume point is at comment beginning."
971 ;; Match first line with a loose regexp since it might as
972 ;; well be an ill-defined keyword.
978 ;; Get comments ending. This may not be accurate if
979 ;; commented lines within an item are followed by
980 ;; commented lines outside of a list. Though, parser will
981 ;; always get it right as it already knows surrounding
982 ;; element and has narrowed buffer to its contents.
985 ;; Accumulate lines without leading hash and plus sign
986 ;; if any. First whitespace is also ignored.
1004 "Interpret COMMENT element as Org syntax.
1005 CONTENTS is nil."
1009 ;;;; Comment Block
1012 "Parse an export block.
1014 Return a list whose CAR is `comment-block' and CDR is a plist
1015 containing `:begin', `:end', `:hiddenp', `:value' and
1016 `:post-blank' keywords.
1018 Assume point is at comment block beginning."
1041 "Interpret COMMENT-BLOCK element as Org syntax.
1042 CONTENTS is nil."
1047 ;;;; Example Block
1050 "Parse an example block.
1052 Return a list whose CAR is `example-block' and CDR is a plist
1053 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1054 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1055 `:switches', `:value' and `:post-blank' keywords."
1061 ;; Switches analysis
1066 ;; Should labels be retained in (or stripped from) example
1067 ;; blocks?
1072 ;; What should code-references use - labels or
1073 ;; line-numbers?
1080 ;; Standard block parsing.
1107 "Interpret EXAMPLE-BLOCK element as Org syntax.
1108 CONTENTS is nil."
1116 ;;;; Export Block
1119 "Parse an export block.
1121 Return a list whose CAR is `export-block' and CDR is a plist
1122 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1123 `:post-blank' keywords.
1125 Assume point is at export-block beginning."
1151 "Interpret EXPORT-BLOCK element as Org syntax.
1152 CONTENTS is nil."
1159 ;;;; Fixed-width
1162 "Parse a fixed-width section.
1164 Return a list whose CAR is `fixed-width' and CDR is a plist
1165 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1167 Assume point is at the beginning of the fixed-width area."
1171 value
1173 ;; Ending position may not be accurate if fixed-width
1174 ;; lines within an item are followed by fixed-width lines
1175 ;; outside of a list. Though, parser will always get it
1176 ;; right as it already knows surrounding element and has
1177 ;; narrowed buffer to its contents.
1180 ;, Accumulate text without starting colons.
1198 "Interpret FIXED-WIDTH element as Org syntax.
1199 CONTENTS is nil."
1204 ;;;; Horizontal Rule
1207 "Parse an horizontal rule.
1209 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1210 containing `:begin', `:end' and `:post-blank' keywords."
1224 "Interpret HORIZONTAL-RULE element as Org syntax.
1225 CONTENTS is nil."
1229 ;;;; Keyword
1232 "Parse a keyword at point.
1234 Return a list whose CAR is `keyword' and CDR is a plist
1235 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1236 keywords."
1256 "Interpret KEYWORD element as Org syntax.
1257 CONTENTS is nil."
1263 ;;;; Latex Environment
1266 "Parse a LaTeX environment.
1268 Return a list whose CAR is `latex-environment' and CDR is a plist
1269 containing `:begin', `:end', `:value' and `:post-blank'
1270 keywords.
1272 Assume point is at the beginning of the latex environment."
1295 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1296 CONTENTS is nil."
1300 ;;;; Paragraph
1303 "Parse a paragraph.
1305 Return a list whose CAR is `paragraph' and CDR is a plist
1306 containing `:begin', `:end', `:contents-begin' and
1307 `:contents-end' and `:post-blank' keywords.
1309 Assume point is at the beginning of the paragraph."
1331 "Interpret PARAGRAPH element as Org syntax.
1332 CONTENTS is the contents of the element."
1333 contents)
1336 ;;;; Planning
1339 "Parse a planning.
1341 Return a list whose CAR is `planning' and CDR is a plist
1342 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1343 and `:post-blank' keywords."
1352 closed deadline scheduled)
1372 "Interpret PLANNING element as Org syntax.
1373 CONTENTS is nil."
1375 'identity
1386 ;;;; Property Drawer
1389 "Parse a property drawer.
1391 Return a list whose CAR is `property-drawer' and CDR is a plist
1392 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1393 `:contents-end', `:properties' and `:post-blank' keywords.
1395 Assume point is at the beginning of the property drawer."
1409 val))
1411 val))
1425 "Interpret PROPERTY-DRAWER element as Org syntax.
1426 CONTENTS is nil."
1436 ;;;; Quote Section
1439 "Parse a quote section.
1441 Return a list whose CAR is `quote-section' and CDR is a plist
1442 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1444 Assume point is at beginning of the section."
1460 "Interpret QUOTE-SECTION element as Org syntax.
1461 CONTENTS is nil."
1465 ;;;; Src Block
1468 "Parse a src block.
1470 Return a list whose CAR is `src-block' and CDR is a plist
1471 containing `:language', `:switches', `:parameters', `:begin',
1472 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1473 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1474 `:post-blank' keywords.
1476 Assume point is at the beginning of the block."
1480 ;; Get affiliated keywords.
1482 ;; Get beginning position.
1484 ;; Get language as a string.
1493 ;; Get switches.
1495 ;; Get parameters.
1497 ;; Switches analysis
1505 ;; Should labels be retained in (or stripped from) src
1506 ;; blocks?
1511 ;; What should code-references use - labels or
1512 ;; line-numbers?
1516 ;; Get position at end of block.
1520 ;; Retrieve code.
1526 ;; Get position after ending blank lines.
1529 ;; Get visibility status.
1552 "Interpret SRC-BLOCK element as Org syntax.
1553 CONTENTS is nil."
1573 value
1577 ;;;; Table
1580 "Parse a table at point.
1582 Return a list whose CAR is `table' and CDR is a plist containing
1583 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1584 `:contents-end', `:value' and `:post-blank' keywords.
1586 Assume point is at the beginning of the table."
1598 acc))
1607 ;; Only `org' tables have contents. `table.el' tables
1608 ;; use a `:value' property to store raw table as
1609 ;; a string.
1614 table-begin table-end))
1619 "Interpret TABLE element as Org syntax.
1620 CONTENTS is nil."
1631 ;;;; Table Row
1634 "Parse table row at point.
1636 Return a list whose CAR is `table-row' and CDR is a plist
1637 containing `:begin', `:end', `:contents-begin', `:contents-end',
1638 `:type' and `:post-blank' keywords."
1642 ;; A table rule has no contents. In that case, ensure
1643 ;; CONTENTS-BEGIN matches CONTENTS-END.
1662 "Interpret TABLE-ROW element as Org syntax.
1663 CONTENTS is the contents of the table row."
1668 ;;;; Verse Block
1671 "Parse a verse block.
1673 Return a list whose CAR is `verse-block' and CDR is a plist
1674 containing `:begin', `:end', `:contents-begin', `:contents-end',
1675 `:hiddenp' and `:post-blank' keywords.
1677 Assume point is at beginning of the block."
1701 "Interpret VERSE-BLOCK element as Org syntax.
1702 CONTENTS is verse block contents."
1706 \f
1707 ;;; Objects
1708 ;;
1709 ;; Unlike to elements, interstices can be found between objects.
1710 ;; That's why, along with the parser, successor functions are provided
1711 ;; for each object. Some objects share the same successor (i.e. `code'
1712 ;; and `verbatim' objects).
1713 ;;
1714 ;; A successor must accept a single argument bounding the search. It
1715 ;; will return either a cons cell whose CAR is the object's type, as
1716 ;; a symbol, and CDR the position of its next occurrence, or nil.
1717 ;;
1718 ;; Successors follow the naming convention:
1719 ;; org-element-NAME-successor, where NAME is the name of the
1720 ;; successor, as defined in `org-element-all-successors'.
1721 ;;
1722 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1723 ;; object types they can contain will be specified in
1724 ;; `org-element-object-restrictions'.
1725 ;;
1726 ;; Adding a new type of object is simple. Implement a successor,
1727 ;; a parser, and an interpreter for it, all following the naming
1728 ;; convention. Register type in `org-element-all-objects' and
1729 ;; successor in `org-element-all-successors'. Maybe tweak
1730 ;; restrictions about it, and that's it.
1733 ;;;; Bold
1736 "Parse bold object at point.
1738 Return a list whose CAR is `bold' and CDR is a plist with
1739 `:begin', `:end', `:contents-begin' and `:contents-end' and
1740 `:post-blank' keywords.
1742 Assume point is at the first star marker."
1760 "Interpret BOLD object as Org syntax.
1761 CONTENTS is the contents of the object."
1765 "Search for the next text-markup object.
1767 LIMIT bounds the search.
1769 Return value is a cons cell whose CAR is a symbol among `bold',
1770 `italic', `underline', `strike-through', `code' and `verbatim'
1771 and CDR is beginning position."
1787 ;;;; Code
1790 "Parse code object at point.
1792 Return a list whose CAR is `code' and CDR is a plist with
1793 `:value', `:begin', `:end' and `:post-blank' keywords.
1795 Assume point is at the first tilde marker."
1811 "Interpret CODE object as Org syntax.
1812 CONTENTS is nil."
1816 ;;;; Entity
1819 "Parse entity at point.
1821 Return a list whose CAR is `entity' and CDR a plist with
1822 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1823 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1824 keywords.
1826 Assume point is at the beginning of the entity."
1828 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
1850 "Interpret ENTITY object as Org syntax.
1851 CONTENTS is nil."
1857 "Search for the next latex-fragment or entity object.
1859 LIMIT bounds the search.
1861 Return value is a cons cell whose CAR is `entity' or
1862 `latex-fragment' and CDR is beginning position."
1865 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1872 limit t)
1875 ;; Determine if it's a real entity or a LaTeX command.
1878 ;; No entity nor command: point is at a LaTeX fragment.
1879 ;; Determine its type to get the correct beginning position.
1887 matchers)
1891 ;;;; Export Snippet
1894 "Parse export snippet at point.
1896 Return a list whose CAR is `export-snippet' and CDR a plist with
1897 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1898 keywords.
1900 Assume point is at the beginning of the snippet."
1923 "Interpret EXPORT-SNIPPET object as Org syntax.
1924 CONTENTS is nil."
1930 "Search for the next export-snippet object.
1932 LIMIT bounds the search.
1934 Return value is a cons cell whose CAR is `export-snippet' CDR is
1935 its beginning position."
1948 ;;;; Footnote Reference
1951 "Parse footnote reference at point.
1953 Return a list whose CAR is `footnote-reference' and CDR a plist
1954 with `:label', `:type', `:inline-definition', `:begin', `:end'
1955 and `:post-blank' as keywords."
1988 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1989 CONTENTS is nil."
1999 "Search for the next footnote-reference object.
2001 LIMIT bounds the search.
2003 Return value is a cons cell whose CAR is `footnote-reference' and
2004 CDR is beginning position."
2018 ;;;; Inline Babel Call
2021 "Parse inline babel call at point.
2023 Return a list whose CAR is `inline-babel-call' and CDR a plist
2024 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2026 Assume point is at the beginning of the babel call."
2042 "Interpret INLINE-BABEL-CALL object as Org syntax.
2043 CONTENTS is nil."
2049 ;; Remove redundant square brackets.
2052 main-source)
2056 "Search for the next inline-babel-call object.
2058 LIMIT bounds the search.
2060 Return value is a cons cell whose CAR is `inline-babel-call' and
2061 CDR is beginning position."
2063 ;; Use a simplified version of
2064 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2066 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2067 limit t)
2071 ;;;; Inline Src Block
2074 "Parse inline source block at point.
2076 Return a list whose CAR is `inline-src-block' and CDR a plist
2077 with `:begin', `:end', `:language', `:value', `:parameters' and
2078 `:post-blank' as keywords.
2080 Assume point is at the beginning of the inline src block."
2100 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2101 CONTENTS is nil."
2106 language
2108 body)))
2111 "Search for the next inline-babel-call element.
2113 LIMIT bounds the search.
2115 Return value is a cons cell whose CAR is `inline-babel-call' and
2116 CDR is beginning position."
2121 ;;;; Italic
2124 "Parse italic object at point.
2126 Return a list whose CAR is `italic' and CDR is a plist with
2127 `:begin', `:end', `:contents-begin' and `:contents-end' and
2128 `:post-blank' keywords.
2130 Assume point is at the first slash marker."
2148 "Interpret ITALIC object as Org syntax.
2149 CONTENTS is the contents of the object."
2153 ;;;; Latex Fragment
2156 "Parse latex fragment at point.
2158 Return a list whose CAR is `latex-fragment' and CDR a plist with
2159 `:value', `:begin', `:end', and `:post-blank' as keywords.
2161 Assume point is at the beginning of the latex fragment."
2175 ;; None found: it's a macro.
2189 "Interpret LATEX-FRAGMENT object as Org syntax.
2190 CONTENTS is nil."
2193 ;;;; Line Break
2196 "Parse line break at point.
2198 Return a list whose CAR is `line-break', and CDR a plist with
2199 `:begin', `:end' and `:post-blank' keywords.
2201 Assume point is at the beginning of the line break."
2207 "Interpret LINE-BREAK object as Org syntax.
2208 CONTENTS is nil."
2212 "Search for the next line-break object.
2214 LIMIT bounds the search.
2216 Return value is a cons cell whose CAR is `line-break' and CDR is
2217 beginning position."
2221 ;; A line break can only happen on a non-empty line.
2226 ;;;; Link
2229 "Parse link at point.
2231 Return a list whose CAR is `link' and CDR a plist with `:type',
2232 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2233 `:contents-end' and `:post-blank' as keywords.
2235 Assume point is at the beginning of the link."
2238 end contents-begin contents-end link-end post-blank path type
2239 raw-link link)
2241 ;; Type 1: Text targeted from a radio target.
2246 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2251 ;; RAW-LINK is the original link.
2256 ;; Determine TYPE of link and set PATH accordingly.
2258 ;; File type.
2261 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2264 ;; Id type: PATH is the id.
2267 ;; Code-ref type: PATH is the name of the reference.
2270 ;; Custom-id type: PATH is the name of the custom id.
2273 ;; Fuzzy type: Internal link either matches a target, an
2274 ;; headline name or nothing. PATH is the target or
2275 ;; headline's name.
2277 ;; Type 3: Plain link, i.e. http://orgmode.org
2283 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2290 ;; In any case, deduce end point after trailing white space from
2291 ;; LINK-END variable.
2305 "Interpret LINK object as Org syntax.
2306 CONTENTS is the contents of the object, or nil."
2311 raw-link
2315 "Search for the next link object.
2317 LIMIT bounds the search.
2319 Return value is a cons cell whose CAR is `link' and CDR is
2320 beginning position."
2329 ;;;; Macro
2332 "Parse macro at point.
2334 Return a list whose CAR is `macro' and CDR a plist with `:key',
2335 `:args', `:begin', `:end', `:value' and `:post-blank' as
2336 keywords.
2338 Assume point is at the macro."
2352 ;; Repair bad splits.
2367 "Interpret MACRO object as Org syntax.
2368 CONTENTS is nil."
2372 "Search for the next macro object.
2374 LIMIT bounds the search.
2376 Return value is cons cell whose CAR is `macro' and CDR is
2377 beginning position."
2381 limit t)
2385 ;;;; Radio-target
2388 "Parse radio target at point.
2390 Return a list whose CAR is `radio-target' and CDR a plist with
2391 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2392 and `:post-blank' as keywords.
2394 Assume point is at the radio target."
2413 "Interpret TARGET object as Org syntax.
2414 CONTENTS is the contents of the object."
2418 "Search for the next radio-target object.
2420 LIMIT bounds the search.
2422 Return value is a cons cell whose CAR is `radio-target' and CDR
2423 is beginning position."
2429 ;;;; Statistics Cookie
2432 "Parse statistics cookie at point.
2434 Return a list whose CAR is `statistics-cookie', and CDR a plist
2435 with `:begin', `:end', `:value' and `:post-blank' keywords.
2437 Assume point is at the beginning of the statistics-cookie."
2453 "Interpret STATISTICS-COOKIE object as Org syntax.
2454 CONTENTS is nil."
2458 "Search for the next statistics cookie object.
2460 LIMIT bounds the search.
2462 Return value is a cons cell whose CAR is `statistics-cookie' and
2463 CDR is beginning position."
2469 ;;;; Strike-Through
2472 "Parse strike-through object at point.
2474 Return a list whose CAR is `strike-through' and CDR is a plist
2475 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2476 `:post-blank' keywords.
2478 Assume point is at the first plus sign marker."
2496 "Interpret STRIKE-THROUGH object as Org syntax.
2497 CONTENTS is the contents of the object."
2501 ;;;; Subscript
2504 "Parse subscript at point.
2506 Return a list whose CAR is `subscript' and CDR a plist with
2507 `:begin', `:end', `:contents-begin', `:contents-end',
2508 `:use-brackets-p' and `:post-blank' as keywords.
2510 Assume point is at the underscore."
2514 t
2532 "Interpret SUBSCRIPT object as Org syntax.
2533 CONTENTS is the contents of the object."
2536 contents))
2539 "Search for the next sub/superscript object.
2541 LIMIT bounds the search.
2543 Return value is a cons cell whose CAR is either `subscript' or
2544 `superscript' and CDR is beginning position."
2551 ;;;; Superscript
2554 "Parse superscript at point.
2556 Return a list whose CAR is `superscript' and CDR a plist with
2557 `:begin', `:end', `:contents-begin', `:contents-end',
2558 `:use-brackets-p' and `:post-blank' as keywords.
2560 Assume point is at the caret."
2581 "Interpret SUPERSCRIPT object as Org syntax.
2582 CONTENTS is the contents of the object."
2585 contents))
2588 ;;;; Table Cell
2591 "Parse table cell at point.
2593 Return a list whose CAR is `table-cell' and CDR is a plist
2594 containing `:begin', `:end', `:contents-begin', `:contents-end'
2595 and `:post-blank' keywords."
2609 "Interpret TABLE-CELL element as Org syntax.
2610 CONTENTS is the contents of the cell, or nil."
2614 "Search for the next table-cell object.
2616 LIMIT bounds the search.
2618 Return value is a cons cell whose CAR is `table-cell' and CDR is
2619 beginning position."
2623 ;;;; Target
2626 "Parse target at point.
2628 Return a list whose CAR is `target' and CDR a plist with
2629 `:begin', `:end', `:value' and `:post-blank' as keywords.
2631 Assume point is at the target."
2646 "Interpret TARGET object as Org syntax.
2647 CONTENTS is nil."
2651 "Search for the next target object.
2653 LIMIT bounds the search.
2655 Return value is a cons cell whose CAR is `target' and CDR is
2656 beginning position."
2662 ;;;; Timestamp
2665 "Parse time stamp at point.
2667 Return a list whose CAR is `timestamp', and CDR a plist with
2668 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2670 Assume point is at the beginning of the timestamp."
2696 "Interpret TIMESTAMP object as Org syntax.
2697 CONTENTS is nil."
2701 "Search for the next timestamp object.
2703 LIMIT bounds the search.
2705 Return value is a cons cell whose CAR is `timestamp' and CDR is
2706 beginning position."
2714 limit t)
2718 ;;;; Underline
2721 "Parse underline object at point.
2723 Return a list whose CAR is `underline' and CDR is a plist with
2724 `:begin', `:end', `:contents-begin' and `:contents-end' and
2725 `:post-blank' keywords.
2727 Assume point is at the first underscore marker."
2745 "Interpret UNDERLINE object as Org syntax.
2746 CONTENTS is the contents of the object."
2750 ;;;; Verbatim
2753 "Parse verbatim object at point.
2755 Return a list whose CAR is `verbatim' and CDR is a plist with
2756 `:value', `:begin', `:end' and `:post-blank' keywords.
2758 Assume point is at the first equal sign marker."
2774 "Interpret VERBATIM object as Org syntax.
2775 CONTENTS is nil."
2779 \f
2780 ;;; Definitions And Rules
2781 ;;
2782 ;; Define elements, greater elements and specify recursive objects,
2783 ;; along with the affiliated keywords recognized. Also set up
2784 ;; restrictions on recursive objects combinations.
2785 ;;
2786 ;; These variables really act as a control center for the parsing
2787 ;; process.
2790 ;; Headlines and inlinetasks.
2792 ;; Comments, blocks (any type), keywords and babel calls.
2794 ;; Lists.
2796 ;; Fixed-width, drawers (any type) and tables.
2798 ;; Footnote definitions.
2800 ;; Horizontal rules.
2802 ;; LaTeX environments.
2804 ;; Planning and Clock lines.
2814 export-block fixed-width footnote-definition headline
2815 horizontal-rule inlinetask item keyword latex-environment
2816 babel-call paragraph plain-list planning property-drawer
2817 quote-block quote-section section special-block src-block table
2818 table-row verse-block)
2823 item plain-list quote-block section special-block table)
2828 latex-or-entity line-break link macro radio-target
2829 statistics-cookie sub/superscript table-cell target
2830 text-markup timestamp)
2839 "Alist of translations between object type and successor name.
2841 Sharing the same successor comes handy when, for example, the
2846 inline-src-block italic line-break latex-fragment link macro
2847 radio-target statistics-cookie strike-through subscript superscript
2848 table-cell target timestamp underline verbatim)
2853 table-cell underline)
2868 "Alist between block names and the associated parsing function.
2869 Names must be uppercase. Any block whose name has no association
2882 "Alist of usual translations for keywords.
2883 The key is the old name and the value the new one. The property
2888 "List of affiliated keywords that can occur more that once in an element.
2890 Their value will be consed into a list of strings, which will be
2891 returned as the value of the property.
2893 This list is checked after translations have been applied. See
2897 "List of keywords whose value can be parsed.
2899 Their value will be stored as a secondary string: a list of
2900 strings and objects.
2902 This list is checked after translations have been applied. See
2906 "List of keywords which can have a secondary value.
2908 In Org syntax, they can be written with optional square brackets
2909 before the colons. For example, results keyword can be
2910 associated to a hash value with the following:
2912 #+RESULTS[hash-string]: some-source
2914 This list is checked after translations have been applied. See
2921 inline-babel-call inline-src-block latex-fragment
2922 line-break link macro radio-target sub/superscript
2923 target text-markup timestamp)
2925 macro radio-target statistics-cookie sub/superscript target
2926 text-markup timestamp)
2940 link radio-target sub/superscript target text-markup
2941 timestamp)
2952 latex-fragment line-break link macro radio-target
2954 "Alist of objects restrictions.
2956 CAR is an element or object type containing objects and CDR is
2957 a list of successors that will be called within an element or
2958 object of such type.
2960 For example, in a `radio-target' object, one can only find
2961 entities, export snippets, latex-fragments, subscript and
2962 superscript.
2964 This alist also applies to secondary string. For example, an
2965 `headline' type element doesn't directly contain objects, but
2976 \f
2977 ;;; Accessors
2978 ;;
2979 ;; Provide four accessors: `org-element-type', `org-element-property'
2980 ;; `org-element-contents' and `org-element-restriction'.
2983 "Return type of element ELEMENT.
2985 The function returns the type of the element or object provided.
2986 It can also return the following special value:
2987 `plain-text' for a string
2988 `org-data' for a complete document
2989 nil in any other case."
2995 "Extract the value from the PROPERTY of an ELEMENT."
2999 "Extract contents from an ELEMENT."
3003 "Return restriction associated to ELEMENT.
3004 ELEMENT can be an element, an object or a symbol representing an
3005 element or object type."
3007 org-element-object-restrictions)))
3010 \f
3011 ;;; Parsing Element Starting At Point
3012 ;;
3013 ;; `org-element-current-element' is the core function of this section.
3014 ;; It returns the Lisp representation of the element starting at
3015 ;; point.
3016 ;;
3017 ;; `org-element-current-element' makes use of special modes. They are
3018 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3019 ;; or fixed conditional element chaining (i.e. `headline' >
3020 ;; `section'). Special modes are: `section', `quote-section', `item'
3021 ;; and `table-row'.
3024 "Parse the element starting at point.
3026 Return value is a list like (TYPE PROPS) where TYPE is the type
3027 of the element and PROPS a plist of properties associated to the
3028 element.
3030 Possible types are defined in `org-element-all-elements'.
3032 Optional argument GRANULARITY determines the depth of the
3033 recursion. Allowed values are `headline', `greater-element',
3034 `element', `object' or nil. When it is broader than `object' (or
3035 nil), secondary values will not be parsed, since they only
3036 contain objects.
3038 Optional argument SPECIAL, when non-nil, can be either `section',
3039 `quote-section', `table-row' and `item'.
3041 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3042 be computed.
3044 This function assumes point is always at the beginning of the
3045 element it has to parse."
3047 ;; If point is at an affiliated keyword, try moving to the
3048 ;; beginning of the associated element. If none is found, the
3049 ;; keyword is orphaned and will be treated as plain text.
3055 ;; Determine if parsing depth allows for secondary strings
3056 ;; parsing. It only applies to elements referenced in
3057 ;; `org-element-secondary-value-alist'.
3060 ;; Item.
3063 raw-secondary-p))
3064 ;; Quote Section.
3066 ;; Table Row.
3068 ;; Headline.
3071 ;; Section (must be checked after headline).
3073 ;; Planning and Clock.
3078 ;; Blocks.
3089 ;; Inlinetask.
3091 ;; LaTeX Environment.
3097 nil t))
3100 ;; Drawer and Property Drawer.
3108 ;; Fixed Width
3110 ;; Babel Call, Dynamic Block and Keyword.
3123 ;; Footnote Definition.
3126 ;; Comment.
3129 ;; Horizontal Rule.
3132 ;; Table.
3134 ;; List.
3137 ;; Default element: Paragraph.
3141 ;; Most elements can have affiliated keywords. When looking for an
3142 ;; element beginning, we want to move before them, as they belong to
3143 ;; that element, and, in the meantime, collect information they give
3144 ;; into appropriate properties. Hence the following function.
3145 ;;
3146 ;; Usage of optional arguments may not be obvious at first glance:
3147 ;;
3148 ;; - TRANS-LIST is used to polish keywords names that have evolved
3149 ;; during Org history. In example, even though =result= and
3150 ;; =results= coexist, we want to have them under the same =result=
3151 ;; property. It's also true for "srcname" and "name", where the
3152 ;; latter seems to be preferred nowadays (thus the "name" property).
3153 ;;
3154 ;; - CONSED allows to regroup multi-lines keywords under the same
3155 ;; property, while preserving their own identity. This is mostly
3156 ;; used for "attr_latex" and al.
3157 ;;
3158 ;; - PARSED prepares a keyword value for export. This is useful for
3159 ;; "caption". Objects restrictions for such keywords are defined in
3160 ;; `org-element-object-restrictions'.
3161 ;;
3162 ;; - DUALS is used to take care of keywords accepting a main and an
3163 ;; optional secondary values. For example "results" has its
3164 ;; source's name as the main value, and may have an hash string in
3165 ;; optional square brackets as the secondary one.
3166 ;;
3167 ;; A keyword may belong to more than one category.
3178 "Regexp matching any affiliated keyword.
3180 Keyword name is put in match group 1. Moreover, if keyword
3181 belongs to `org-element-dual-keywords', put the dual value in
3182 match group 2.
3188 "Collect affiliated keywords before point.
3190 Optional argument KEY-RE is a regexp matching keywords, which
3191 puts matched keyword in group 1. It defaults to
3192 `org-element--affiliated-re'.
3194 TRANS-LIST is an alist where key is the keyword and value the
3195 property name it should be translated to, without the colons. It
3196 defaults to `org-element-keyword-translation-alist'.
3198 CONSED is a list of strings. Any keyword belonging to that list
3199 will have its value consed. The check is done after keyword
3200 translation. It defaults to `org-element-multiple-keywords'.
3202 PARSED is a list of strings. Any keyword member of this list
3203 will have its value parsed. The check is done after keyword
3204 translation. If a keyword is a member of both CONSED and PARSED,
3205 it's value will be a list of parsed strings. It defaults to
3206 `org-element-parsed-keywords'.
3208 DUALS is a list of strings. Any keyword member of this list can
3209 have two parts: one mandatory and one optional. Its value is
3210 a cons cell whose CAR is the former, and the CDR the latter. If
3211 a keyword is a member of both PARSED and DUALS, both values will
3212 be parsed. It defaults to `org-element-dual-keywords'.
3214 Return a list whose CAR is the position at the first of them and
3215 CDR a plist of keywords and values."
3223 ;; RESTRICT is the list of objects allowed in parsed
3224 ;; keywords value.
3226 output)
3231 ;; Apply translation to RAW-KWD. From there, KWD is
3232 ;; the official keyword.
3234 ;; Find main value for any keyword.
3240 ;; If KWD is a dual keyword, find its secondary
3241 ;; value. Maybe parse it.
3247 ;; Attribute a property name to KWD.
3249 ;; Now set final shape for VALUE.
3253 ;; VALUE is mandatory. Set it to nil if there is none.
3257 ;; Eventually store the new value in OUTPUT.
3263 \f
3264 ;;; The Org Parser
3265 ;;
3266 ;; The two major functions here are `org-element-parse-buffer', which
3267 ;; parses Org syntax inside the current buffer, taking into account
3268 ;; region, narrowing, or even visibility if specified, and
3269 ;; `org-element-parse-secondary-string', which parses objects within
3270 ;; a given string.
3271 ;;
3272 ;; The (almost) almighty `org-element-map' allows to apply a function
3273 ;; on elements or objects matching some type, and accumulate the
3274 ;; resulting values. In an export situation, it also skips unneeded
3275 ;; parts of the parse tree.
3278 "Recursively parse the buffer and return structure.
3279 If narrowing is in effect, only parse the visible part of the
3280 buffer.
3282 Optional argument GRANULARITY determines the depth of the
3283 recursion. It can be set to the following symbols:
3285 `headline' Only parse headlines.
3286 `greater-element' Don't recurse into greater elements excepted
3287 headlines and sections. Thus, elements
3288 parsed are the top-level ones.
3289 `element' Parse everything but objects and plain text.
3290 `object' Parse the complete buffer (default).
3292 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3293 elements.
3295 Assume buffer is in Org mode."
3301 ;; Start in `section' mode so text before the first
3302 ;; headline belongs to a section.
3306 "Recursively parse objects in STRING and return structure.
3308 RESTRICTION, when non-nil, is a symbol limiting the object types
3309 that will be looked after."
3315 "Map a function on selected elements or objects.
3317 DATA is the parsed tree, as returned by, i.e,
3318 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3319 of elements or objects types. FUN is the function called on the
3320 matching element or object. It must accept one arguments: the
3321 element or object itself.
3323 When optional argument INFO is non-nil, it should be a plist
3324 holding export options. In that case, parts of the parse tree
3325 not exportable according to that property list will be skipped.
3327 When optional argument FIRST-MATCH is non-nil, stop at the first
3328 match for which FUN doesn't return nil, and return that value.
3330 Optional argument NO-RECURSION is a symbol or a list of symbols
3331 representing elements or objects types. `org-element-map' won't
3332 enter any recursive element or object whose type belongs to that
3333 list. Though, FUN can still be applied on them.
3335 Nil values returned from FUN do not appear in the results."
3336 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3339 ;; Recursion depth is determined by --CATEGORY.
3347 --acc
3348 --walk-tree
3352 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3353 ;; holding contextual information.
3357 ;; Ignored element in an export context.
3359 ;; Secondary string: only objects can be found there.
3362 ;; Unconditionally enter parse trees.
3366 ;; Check if TYPE is matching among TYPES. If so,
3367 ;; apply FUN to --DATA and accumulate return value
3368 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3374 ;; If --DATA has a secondary string that can contain
3375 ;; objects with their type among TYPES, look into it.
3382 ;; Determine if a recursion into --DATA is possible.
3384 ;; --TYPE is explicitly removed from recursion.
3386 ;; --DATA has no contents.
3388 ;; Looking for greater elements but --DATA is simply
3389 ;; an element or an object.
3392 ;; Looking for elements but --DATA is an object.
3395 ;; In any other case, map contents.
3399 ;; Return value in a proper order.
3402 ;; The following functions are internal parts of the parser.
3403 ;;
3404 ;; The first one, `org-element-parse-elements' acts at the element's
3405 ;; level.
3406 ;;
3407 ;; The second one, `org-element-parse-objects' applies on all objects
3408 ;; of a paragraph or a secondary string. It uses
3409 ;; `org-element-get-candidates' to optimize the search of the next
3410 ;; object in the buffer.
3411 ;;
3412 ;; More precisely, that function looks for every allowed object type
3413 ;; first. Then, it discards failed searches, keeps further matches,
3414 ;; and searches again types matched behind point, for subsequent
3415 ;; calls. Thus, searching for a given type fails only once, and every
3416 ;; object is searched only once at top level (but sometimes more for
3417 ;; nested types).
3421 "Parse elements between BEG and END positions.
3423 SPECIAL prioritize some elements over the others. It can be set
3424 to `quote-section', `section' `item' or `table-row'.
3426 When value is `item', STRUCTURE will be used as the current list
3427 structure.
3429 GRANULARITY determines the depth of the recursion. See
3430 `org-element-parse-buffer' for more information.
3432 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3433 elements.
3435 Elements are accumulated into ACC."
3440 ;; When parsing only headlines, skip any text before first one.
3443 ;; Main loop start.
3445 ;; Find current element's type and parse it accordingly to
3446 ;; its category.
3448 granularity special structure))
3451 ;; Set ACC as parent of current element. It will be
3452 ;; completed by side-effect. If the element contains any
3453 ;; secondary string, also set `:parent' property of every
3454 ;; object within it as current element.
3463 sec-value)))))
3466 acc
3469 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3470 ;; true and element is hidden or if it has no contents
3471 ;; anyway.
3474 ;; Case 2. Greater element: parse it between
3475 ;; `contents-begin' and `contents-end'. Make sure
3476 ;; GRANULARITY allows the recursion, or ELEMENT is an
3477 ;; headline, in which case going inside is mandatory, in
3478 ;; order to get sub-level headings.
3486 ;; Possibly switch to a special mode.
3494 granularity visible-only element))
3495 ;; Case 3. ELEMENT has contents. Parse objects inside,
3496 ;; if GRANULARITY allows it.
3501 ;; Case 4. Else, just accumulate ELEMENT.
3503 ;; Return result.
3504 acc))
3507 "Parse objects between BEG and END and return recursive structure.
3509 Objects are accumulated in ACC.
3511 RESTRICTION is a list of object types which are allowed in the
3512 current object."
3516 ;; Return the parsing function associated to the nearest
3517 ;; object among list of candidates CAND.
3524 next-object candidates)
3528 end restriction candidates))
3530 ;; Set ACC as parent of current element. It will be completed
3531 ;; by side-effect.
3533 ;; 1. Text before any object. Untabify it.
3542 ;; 2. Object...
3547 cont-beg)
3548 ;; ... recursive. The CONT-BEG check is for
3549 ;; links, as some of them might not be recursive
3550 ;; (i.e. plain links).
3553 cont-beg
3557 ;; Restrict allowed objects.
3559 next-object)))
3562 ;; If the object contains any secondary string, also set
3563 ;; `:parent' property of every object within it as current
3564 ;; object.
3566 org-element-secondary-value-alist)))
3574 :parent
3575 complete-next-object)))
3576 sec-value)))))
3578 ;; 3. Text after last object. Untabify it.
3586 ;; Result.
3587 acc)))
3590 "Return an alist of candidates for the next object.
3592 LIMIT bounds the search, and RESTRICTION narrows candidates to
3593 some object types.
3595 Return value is an alist whose CAR is position and CDR the object
3596 type, as a symbol.
3598 OBJECTS is the previous candidates alist."
3600 ;; If no previous result, search every object type in RESTRICTION.
3601 ;; Otherwise, keep potential candidates (old objects located after
3602 ;; point) and ask to search again those which had matched before.
3607 objects))
3608 ;; Call the appropriate successor function for each type to search
3609 ;; and accumulate matches.
3616 type))))
3619 types-to-search)
3620 ;; Return alist.
3621 next-candidates))
3624 \f
3625 ;;; Towards A Bijective Process
3626 ;;
3627 ;; The parse tree obtained with `org-element-parse-buffer' is really
3628 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3629 ;; interpreted and expanded into a string with canonical Org syntax.
3630 ;; Hence `org-element-interpret-data'.
3631 ;;
3632 ;; The function relies internally on
3633 ;; `org-element-interpret--affiliated-keywords'.
3636 "Interpret DATA as Org syntax.
3638 DATA is a parse tree, an element, an object or a secondary string
3639 to interpret.
3641 Optional argument PARENT is used for recursive calls. It contains
3642 the element or object containing data, or nil.
3644 Return Org syntax as a string."
3648 ;; Secondary string.
3653 ;; Full Org document.
3658 ;; Plain text.
3660 ;; Element/Object without contents.
3663 data nil))
3664 ;; Element/Object with contents.
3674 ;; Elements directly containing objects must
3675 ;; have their indentation normalized first.
3677 data
3678 ;; When normalizing first paragraph of an
3679 ;; item or a footnote-definition, ignore
3680 ;; first line's indentation.
3687 data
3689 contents)))))))
3691 ;; Build white spaces. If no `:post-blank' property is
3692 ;; specified, assume its value is 0.
3702 "Return ELEMENT's affiliated keywords as Org syntax.
3703 If there is no affiliated keyword, return the empty string."
3713 ": "
3716 value)
3721 element)))
3728 ;; Remove translated keywords.
3733 org-element-affiliated-keywords))
3736 ;; Because interpretation of the parse tree must return the same
3737 ;; number of blank lines between elements and the same number of white
3738 ;; space after objects, some special care must be given to white
3739 ;; spaces.
3740 ;;
3741 ;; The first function, `org-element-normalize-string', ensures any
3742 ;; string different from the empty string will end with a single
3743 ;; newline character.
3744 ;;
3745 ;; The second function, `org-element-normalize-contents', removes
3746 ;; global indentation from the contents of the current element.
3749 "Ensure string S ends with a single newline character.
3751 If S isn't a string return it unchanged. If S is the empty
3752 string, return it. Otherwise, return a new string with a single
3753 newline character at its end."
3761 "Normalize plain text in ELEMENT's contents.
3763 ELEMENT must only contain plain text and objects.
3765 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3766 indentation to compute maximal common indentation.
3768 Return the normalized element that is element with global
3769 indentation removed from its contents. The function assumes that
3770 indentation is not done with TAB characters."
3772 collect-inds ; for byte-compiler
3775 ;; Return list of indentations within BLOB. This is done by
3776 ;; walking recursively BLOB and updating IND-LIST along the
3777 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3778 ;; been seen yet. It is required as this string is the only
3779 ;; one whose indentation doesn't happen after a newline
3780 ;; character.
3788 ;; An indentation of zero means no string will be
3789 ;; modified. Quit the process.
3795 ;; Avoid matching blank or empty lines.
3803 ;; Collect indentation list in ELEMENT. Possibly remove first
3804 ;; value if IGNORE-FIRST is non-nil.
3807 ;; Build ELEMENT back, replacing each string with the same
3808 ;; string minus common indentation.
3813 ;; Return BLOB with all its strings indentation
3814 ;; shortened from MCI white spaces. FIRST-FLAG is
3815 ;; non-nil when the first string hasn't been seen
3816 ;; yet.
3831 org-element-recursive-objects)
3838 \f
3839 ;;; The Toolbox
3840 ;;
3841 ;; The first move is to implement a way to obtain the smallest element
3842 ;; containing point. This is the job of `org-element-at-point'. It
3843 ;; basically jumps back to the beginning of section containing point
3844 ;; and moves, element after element, with
3845 ;; `org-element-current-element' until the container is found.
3846 ;;
3847 ;; Note: When using `org-element-at-point', secondary values are never
3848 ;; parsed since the function focuses on elements, not on objects.
3851 "Determine closest element around point.
3853 Return value is a list like (TYPE PROPS) where TYPE is the type
3854 of the element and PROPS a plist of properties associated to the
3855 element. Possible types are defined in
3856 `org-element-all-elements'.
3858 As a special case, if point is at the very beginning of a list or
3859 sub-list, returned element will be that list instead of the first
3860 item. In the same way, if point is at the beginning of the first
3861 row of a table, returned element will be the table instead of the
3862 first row.
3864 If optional argument KEEP-TRAIL is non-nil, the function returns
3865 a list of of elements leading to element at point. The list's
3866 CAR is always the element at point. Following positions contain
3867 element's siblings, then parents, siblings of parents, until the
3868 first element of current section."
3870 ;; If at an headline, parse it. It is the sole element that
3871 ;; doesn't require to know about context. Be sure to disallow
3872 ;; secondary string parsing, though.
3878 ;; Otherwise move at the beginning of the section containing
3879 ;; point.
3887 ;; Parse successively each element, skipping those ending
3888 ;; before original position.
3896 ;; 1. Skip any element ending before point or at point.
3901 ;; 2. An element containing point is always the element at
3902 ;; point.
3905 ;; 3. At any other greater element type, if point is
3906 ;; within contents, move into it. Otherwise, return
3907 ;; that element.
3924 ;; Once the local structure around point is well understood, it's easy
3925 ;; to implement some replacements for `forward-paragraph'
3926 ;; `backward-paragraph', namely `org-element-forward' and
3927 ;; `org-element-backward'.
3928 ;;
3929 ;; Also, `org-transpose-elements' mimics the behaviour of
3930 ;; `transpose-words', at the element's level, whereas
3931 ;; `org-element-drag-forward', `org-element-drag-backward', and
3932 ;; `org-element-up' generalize, respectively, functions
3933 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3934 ;;
3935 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3936 ;; smartly remove global indentation from buffer, making it possible
3937 ;; to use Org indent mode on a file created with hard indentation.
3938 ;;
3939 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3940 ;; internally by some of the previously cited tools.
3943 "Non-nil when elements ELEM-A and ELEM-B are nested."
3952 "Swap elements ELEM-A and ELEM-B.
3953 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
3954 end of ELEM-A."
3956 ;; There are two special cases when an element doesn't start at bol:
3957 ;; the first paragraph in an item or in a footnote definition.
3959 ;; Only a paragraph without any affiliated keyword can be moved at
3960 ;; ELEM-A position in such a situation. Note that the case of
3961 ;; a footnote definition is impossible: it cannot contain two
3962 ;; paragraphs in a row because it cannot contain a blank line.
3968 ;; In a special situation, ELEM-A will have no indentation. We'll
3969 ;; give it ELEM-B's (which will in, in turn, have no indentation).
3983 ;; Store overlays responsible for visibility status. We
3984 ;; also need to store their boundaries as they will be
3985 ;; removed from buffer.
3992 ;; Get contents.
4000 ;; Restore ex ELEM-A overlays.
4010 ;; Restore ex ELEM-B overlays.
4019 "Move forward by one element.
4020 Move to the next element at the same level, when possible."
4033 return prev)))
4041 "Move backward by one element.
4042 Move to the previous element at the same level, when possible."
4045 ;; At an headline, move to the previous one, if any, or stay
4046 ;; here.
4057 ;; Move to beginning of current element if point isn't there
4058 ;; already.
4064 "Move to upper element."
4074 return prev)))
4081 "Move to inner element."
4089 ;; If contents are hidden, first disclose them.
4095 "Move backward element at point."
4101 ;; Error out if no previous element or previous element is
4102 ;; a parent of the current one.
4111 "Move forward element at point."
4124 ;; Compute new position of point: it's shifted by NEXT-ELEM
4125 ;; body's length (without final blanks) and by the length of
4126 ;; blanks between ELEM and NEXT-ELEM.
4131 ;; Small correction if buffer doesn't end
4132 ;; with a newline character.
4145 "Put point at beginning of this element, mark at end.
4147 Interactively, if this command is repeated or (in Transient Mark
4148 mode) if the mark is active, it marks the next element after the
4149 ones already marked."
4164 "Narrow buffer to current element."
4182 "Transpose current and previous elements, keeping blank lines between.
4183 Point is moved after both elements."
4191 "Un-indent the visible part of the buffer.
4192 Relative indentation (between items, inside blocks, etc.) isn't
4193 modified."
4198 unindent-tree ; For byte-compiler.
4216 "Fill element at point, when applicable.
4218 This function only applies to paragraph, comment blocks, example
4219 blocks and fixed-width areas. Also, as a special case, re-align
4220 table when point is at one.
4222 If JUSTIFY is non-nil (interactively, with prefix argument),
4223 justify as well. If `sentence-end-double-space' is non-nil, then
4224 period followed by one space does not end a sentence, so don't
4225 break a line there. The variable `fill-column' controls the
4226 width for filling."
4229 ;; Align Org tables, leave table.el tables as-is.
4233 t)
4234 ;; Elements that may contain `line-break' type objects.
4238 ;; Do nothing if point is at an affiliated keyword or at
4239 ;; verse block markers.
4241 ;; At a verse block, first narrow to current "paragraph"
4242 ;; and set current element to that paragraph.
4255 ;; Fill paragraph, taking line breaks into consideration.
4256 ;; For that, slice the paragraph using line breaks as
4257 ;; separators, and fill the parts in reverse order to
4258 ;; avoid messing with markers.
4265 ;; Find the list of ending positions for line breaks
4266 ;; in the current paragraph. Add paragraph beginning
4267 ;; to include first slice.
4272 beg end nil org-element-all-objects)
4273 'line-break
4275 ;; Elements whose contents should be filled as plain text.
4289 ;; Ignore every other element.
4294 ;;; org-element.el ends here