| blob | a5a273cc937ee80581e1833ff74bcf4dbacd6ca1 |
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:
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
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.
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-cell', `table-row' and `verse-block'. Among them,
50 ;; `paragraph', `table-cell' and `verse-block' types can contain Org
51 ;; 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, three 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, and `:post-blank', which holds the
71 ;; number of blank lines, or white spaces, at its end. Greater
72 ;; elements and elements containing objects will also have
73 ;; `:contents-begin' and `:contents-end' properties to delimit
74 ;; contents.
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.
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
88 ;; The first part of this file implements a parser and an interpreter
89 ;; for each type of Org syntax.
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').
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'.
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
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
119 ;; For each greater element type, we define a parser and an
120 ;; interpreter.
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.
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.
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.
142 ;; With the exception of `headline' and `item' types, greater elements
143 ;; cannot contain other greater elements of their own type.
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.
689 ;; Indent contents.
691 bullet
702 ;;;; Plain List
705 "Parse a plain list.
707 Optional argument STRUCTURE, when non-nil, is the structure of
708 the plain list being parsed.
710 Return a list whose CAR is `plain-list' and CDR is a plist
711 containing `:type', `:begin', `:end', `:contents-begin' and
712 `:contents-end', `:level', `:structure' and `:post-blank'
713 keywords.
715 Assume point is at the beginning of the list."
729 ;; Get list level.
734 struct parents))
736 ;; Blank lines below list belong to the top-level list only.
741 ;; Return value.
754 "Interpret PLAIN-LIST element as Org syntax.
755 CONTENTS is the contents of the element."
756 contents)
759 ;;;; Quote Block
762 "Parse a quote block.
764 Return a list whose CAR is `quote-block' and CDR is a plist
765 containing `:begin', `:end', `:hiddenp', `:contents-begin',
766 `:contents-end' and `:post-blank' keywords.
768 Assume point is at the beginning of the block."
790 "Interpret QUOTE-BLOCK element as Org syntax.
791 CONTENTS is the contents of the element."
795 ;;;; Section
798 "Parse a section.
800 Return a list whose CAR is `section' and CDR is a plist
801 containing `:begin', `:end', `:contents-begin', `contents-end'
802 and `:post-blank' keywords."
804 ;; Beginning of section is the beginning of the first non-blank
805 ;; line after previous headline.
824 "Interpret SECTION element as Org syntax.
825 CONTENTS is the contents of the element."
826 contents)
829 ;;;; Special Block
832 "Parse a special block.
834 Return a list whose CAR is `special-block' and CDR is a plist
835 containing `:type', `:begin', `:end', `:hiddenp',
836 `:contents-begin', `:contents-end' and `:post-blank' keywords.
838 Assume point is at the beginning of the block."
864 "Interpret SPECIAL-BLOCK element as Org syntax.
865 CONTENTS is the contents of the element."
870 \f
871 ;;; Elements
873 ;; For each element, a parser and an interpreter are also defined.
874 ;; Both follow the same naming convention used for greater elements.
876 ;; Also, as for greater elements, adding a new element type is done
877 ;; through the following steps: implement a parser and an interpreter,
878 ;; tweak `org-element-current-element' so that it recognizes the new
879 ;; type and add that new type to `org-element-all-elements'.
881 ;; As a special case, when the newly defined type is a block type,
882 ;; `org-element-non-recursive-block-alist' has to be modified
883 ;; accordingly.
886 ;;;; Babel Call
889 "Parse a babel call.
891 Return a list whose CAR is `babel-call' and CDR is a plist
892 containing `:begin', `:end', `:info' and `:post-blank' as
893 keywords."
908 "Interpret BABEL-CALL element as Org syntax.
909 CONTENTS is nil."
915 ;; Remove redundant square brackets.
920 ;;;; Clock
923 "Parse a clock.
925 Return a list whose CAR is `clock' and CDR is a plist containing
926 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
927 as keywords."
952 "Interpret CLOCK element as Org syntax.
953 CONTENTS is nil."
960 "%2s:%02s"
964 ;;;; Comment
967 "Parse a comment.
969 Return a list whose CAR is `comment' and CDR is a plist
970 containing `:begin', `:end', `:value' and `:post-blank'
971 keywords.
973 Assume point is at comment beginning."
977 value
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.
1006 "Interpret COMMENT element as Org syntax.
1007 CONTENTS is nil."
1013 ;;;; Comment Block
1016 "Parse an export block.
1018 Return a list whose CAR is `comment-block' and CDR is a plist
1019 containing `:begin', `:end', `:hiddenp', `:value' and
1020 `:post-blank' keywords.
1022 Assume point is at comment block beginning."
1045 "Interpret COMMENT-BLOCK element as Org syntax.
1046 CONTENTS is nil."
1051 ;;;; Example Block
1054 "Parse an example block.
1056 Return a list whose CAR is `example-block' and CDR is a plist
1057 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1058 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1059 `:switches', `:value' and `:post-blank' keywords."
1065 ;; Switches analysis
1070 ;; Should labels be retained in (or stripped from) example
1071 ;; blocks?
1076 ;; What should code-references use - labels or
1077 ;; line-numbers?
1084 ;; Standard block parsing.
1111 "Interpret EXAMPLE-BLOCK element as Org syntax.
1112 CONTENTS is nil."
1120 ;;;; Export Block
1123 "Parse an export block.
1125 Return a list whose CAR is `export-block' and CDR is a plist
1126 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1127 `:post-blank' keywords.
1129 Assume point is at export-block beginning."
1155 "Interpret EXPORT-BLOCK element as Org syntax.
1156 CONTENTS is nil."
1163 ;;;; Fixed-width
1166 "Parse a fixed-width section.
1168 Return a list whose CAR is `fixed-width' and CDR is a plist
1169 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1171 Assume point is at the beginning of the fixed-width area."
1175 value
1177 ;; Ending position may not be accurate if fixed-width
1178 ;; lines within an item are followed by fixed-width lines
1179 ;; outside of a list. Though, parser will always get it
1180 ;; right as it already knows surrounding element and has
1181 ;; narrowed buffer to its contents.
1184 ;, Accumulate text without starting colons.
1202 "Interpret FIXED-WIDTH element as Org syntax.
1203 CONTENTS is nil."
1208 ;;;; Horizontal Rule
1211 "Parse an horizontal rule.
1213 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1214 containing `:begin', `:end' and `:post-blank' keywords."
1228 "Interpret HORIZONTAL-RULE element as Org syntax.
1229 CONTENTS is nil."
1233 ;;;; Keyword
1236 "Parse a keyword at point.
1238 Return a list whose CAR is `keyword' and CDR is a plist
1239 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1240 keywords."
1260 "Interpret KEYWORD element as Org syntax.
1261 CONTENTS is nil."
1267 ;;;; Latex Environment
1270 "Parse a LaTeX environment.
1272 Return a list whose CAR is `latex-environment' and CDR is a plist
1273 containing `:begin', `:end', `:value' and `:post-blank'
1274 keywords.
1276 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', `:contents-begin', `:contents-end',
1474 `:number-lines', `:retain-labels', `:use-labels', `:label-fmt',
1475 `:preserve-indent', `:value' and `: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."
1606 ;; Only `org' tables have contents. `table.el' tables
1607 ;; use a `:value' property to store raw table as
1608 ;; a string.
1613 table-begin table-end))
1618 "Interpret TABLE element as Org syntax.
1619 CONTENTS is nil."
1629 ;;;; Table Row
1632 "Parse table row at point.
1634 Return a list whose CAR is `table-row' and CDR is a plist
1635 containing `:begin', `:end', `:contents-begin', `:contents-end',
1636 `:type' and `:post-blank' keywords."
1640 ;; A table rule has no contents. In that case, ensure
1641 ;; CONTENTS-BEGIN matches CONTENTS-END.
1660 "Interpret TABLE-ROW element as Org syntax.
1661 CONTENTS is the contents of the table row."
1666 ;;;; Verse Block
1669 "Parse a verse block.
1671 Return a list whose CAR is `verse-block' and CDR is a plist
1672 containing `:begin', `:end', `:contents-begin', `:contents-end',
1673 `:hiddenp' and `:post-blank' keywords.
1675 Assume point is at beginning of the block."
1699 "Interpret VERSE-BLOCK element as Org syntax.
1700 CONTENTS is verse block contents."
1704 \f
1705 ;;; Objects
1706 ;;
1707 ;; Unlike to elements, interstices can be found between objects.
1708 ;; That's why, along with the parser, successor functions are provided
1709 ;; for each object. Some objects share the same successor (i.e. `code'
1710 ;; and `verbatim' objects).
1711 ;;
1712 ;; A successor must accept a single argument bounding the search. It
1713 ;; will return either a cons cell whose CAR is the object's type, as
1714 ;; a symbol, and CDR the position of its next occurrence, or nil.
1715 ;;
1716 ;; Successors follow the naming convention:
1717 ;; org-element-NAME-successor, where NAME is the name of the
1718 ;; successor, as defined in `org-element-all-successors'.
1719 ;;
1720 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1721 ;; object types they can contain will be specified in
1722 ;; `org-element-object-restrictions'.
1723 ;;
1724 ;; Adding a new type of object is simple. Implement a successor,
1725 ;; a parser, and an interpreter for it, all following the naming
1726 ;; convention. Register type in `org-element-all-objects' and
1727 ;; successor in `org-element-all-successors'. Maybe tweak
1728 ;; restrictions about it, and that's it.
1731 ;;;; Bold
1734 "Parse bold object at point.
1736 Return a list whose CAR is `bold' and CDR is a plist with
1737 `:begin', `:end', `:contents-begin' and `:contents-end' and
1738 `:post-blank' keywords.
1740 Assume point is at the first star marker."
1758 "Interpret BOLD object as Org syntax.
1759 CONTENTS is the contents of the object."
1763 "Search for the next text-markup object.
1765 LIMIT bounds the search.
1767 Return value is a cons cell whose CAR is a symbol among `bold',
1768 `italic', `underline', `strike-through', `code' and `verbatim'
1769 and CDR is beginning position."
1785 ;;;; Code
1788 "Parse code object at point.
1790 Return a list whose CAR is `code' and CDR is a plist with
1791 `:value', `:begin', `:end' and `:post-blank' keywords.
1793 Assume point is at the first tilde marker."
1809 "Interpret CODE object as Org syntax.
1810 CONTENTS is nil."
1814 ;;;; Entity
1817 "Parse entity at point.
1819 Return a list whose CAR is `entity' and CDR a plist with
1820 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1821 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1822 keywords.
1824 Assume point is at the beginning of the entity."
1848 "Interpret ENTITY object as Org syntax.
1849 CONTENTS is nil."
1855 "Search for the next latex-fragment or entity object.
1857 LIMIT bounds the search.
1859 Return value is a cons cell whose CAR is `entity' or
1860 `latex-fragment' and CDR is beginning position."
1863 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1870 limit t)
1873 ;; Determine if it's a real entity or a LaTeX command.
1876 ;; No entity nor command: point is at a LaTeX fragment.
1877 ;; Determine its type to get the correct beginning position.
1885 matchers)
1889 ;;;; Export Snippet
1892 "Parse export snippet at point.
1894 Return a list whose CAR is `export-snippet' and CDR a plist with
1895 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1896 keywords.
1898 Assume point is at the beginning of the snippet."
1921 "Interpret EXPORT-SNIPPET object as Org syntax.
1922 CONTENTS is nil."
1928 "Search for the next export-snippet object.
1930 LIMIT bounds the search.
1932 Return value is a cons cell whose CAR is `export-snippet' CDR is
1933 its beginning position."
1946 ;;;; Footnote Reference
1949 "Parse footnote reference at point.
1951 Return a list whose CAR is `footnote-reference' and CDR a plist
1952 with `:label', `:type', `:inline-definition', `:begin', `:end'
1953 and `:post-blank' as keywords."
1986 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1987 CONTENTS is nil."
1997 "Search for the next footnote-reference object.
1999 LIMIT bounds the search.
2001 Return value is a cons cell whose CAR is `footnote-reference' and
2002 CDR is beginning position."
2016 ;;;; Inline Babel Call
2019 "Parse inline babel call at point.
2021 Return a list whose CAR is `inline-babel-call' and CDR a plist
2022 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2024 Assume point is at the beginning of the babel call."
2040 "Interpret INLINE-BABEL-CALL object as Org syntax.
2041 CONTENTS is nil."
2047 ;; Remove redundant square brackets.
2050 main-source)
2054 "Search for the next inline-babel-call object.
2056 LIMIT bounds the search.
2058 Return value is a cons cell whose CAR is `inline-babel-call' and
2059 CDR is beginning position."
2061 ;; Use a simplified version of
2062 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2064 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2065 limit t)
2069 ;;;; Inline Src Block
2072 "Parse inline source block at point.
2074 Return a list whose CAR is `inline-src-block' and CDR a plist
2075 with `:begin', `:end', `:language', `:value', `:parameters' and
2076 `:post-blank' as keywords.
2078 Assume point is at the beginning of the inline src block."
2098 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2099 CONTENTS is nil."
2104 language
2106 body)))
2109 "Search for the next inline-babel-call element.
2111 LIMIT bounds the search.
2113 Return value is a cons cell whose CAR is `inline-babel-call' and
2114 CDR is beginning position."
2119 ;;;; Italic
2122 "Parse italic object at point.
2124 Return a list whose CAR is `italic' and CDR is a plist with
2125 `:begin', `:end', `:contents-begin' and `:contents-end' and
2126 `:post-blank' keywords.
2128 Assume point is at the first slash marker."
2146 "Interpret ITALIC object as Org syntax.
2147 CONTENTS is the contents of the object."
2151 ;;;; Latex Fragment
2154 "Parse latex fragment at point.
2156 Return a list whose CAR is `latex-fragment' and CDR a plist with
2157 `:value', `:begin', `:end', and `:post-blank' as keywords.
2159 Assume point is at the beginning of the latex fragment."
2173 ;; None found: it's a macro.
2187 "Interpret LATEX-FRAGMENT object as Org syntax.
2188 CONTENTS is nil."
2191 ;;;; Line Break
2194 "Parse line break at point.
2196 Return a list whose CAR is `line-break', and CDR a plist with
2197 `:begin', `:end' and `:post-blank' keywords.
2199 Assume point is at the beginning of the line break."
2205 "Interpret LINE-BREAK object as Org syntax.
2206 CONTENTS is nil."
2210 "Search for the next line-break object.
2212 LIMIT bounds the search.
2214 Return value is a cons cell whose CAR is `line-break' and CDR is
2215 beginning position."
2219 ;; A line break can only happen on a non-empty line.
2224 ;;;; Link
2227 "Parse link at point.
2229 Return a list whose CAR is `link' and CDR a plist with `:type',
2230 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2231 `:contents-end' and `:post-blank' as keywords.
2233 Assume point is at the beginning of the link."
2236 end contents-begin contents-end link-end post-blank path type
2237 raw-link link)
2239 ;; Type 1: Text targeted from a radio target.
2244 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2249 ;; RAW-LINK is the original link.
2254 ;; Determine TYPE of link and set PATH accordingly.
2256 ;; File type.
2259 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2262 ;; Id type: PATH is the id.
2265 ;; Code-ref type: PATH is the name of the reference.
2268 ;; Custom-id type: PATH is the name of the custom id.
2271 ;; Fuzzy type: Internal link either matches a target, an
2272 ;; headline name or nothing. PATH is the target or
2273 ;; headline's name.
2275 ;; Type 3: Plain link, i.e. http://orgmode.org
2281 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2288 ;; In any case, deduce end point after trailing white space from
2289 ;; LINK-END variable.
2303 "Interpret LINK object as Org syntax.
2304 CONTENTS is the contents of the object, or nil."
2309 raw-link
2313 "Search for the next link object.
2315 LIMIT bounds the search.
2317 Return value is a cons cell whose CAR is `link' and CDR is
2318 beginning position."
2327 ;;;; Macro
2330 "Parse macro at point.
2332 Return a list whose CAR is `macro' and CDR a plist with `:key',
2333 `:args', `:begin', `:end', `:value' and `:post-blank' as
2334 keywords.
2336 Assume point is at the macro."
2350 ;; Repair bad splits.
2365 "Interpret MACRO object as Org syntax.
2366 CONTENTS is nil."
2370 "Search for the next macro object.
2372 LIMIT bounds the search.
2374 Return value is cons cell whose CAR is `macro' and CDR is
2375 beginning position."
2379 limit t)
2383 ;;;; Radio-target
2386 "Parse radio target at point.
2388 Return a list whose CAR is `radio-target' and CDR a plist with
2389 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2390 and `:post-blank' as keywords.
2392 Assume point is at the radio target."
2411 "Interpret TARGET object as Org syntax.
2412 CONTENTS is the contents of the object."
2416 "Search for the next radio-target object.
2418 LIMIT bounds the search.
2420 Return value is a cons cell whose CAR is `radio-target' and CDR
2421 is beginning position."
2427 ;;;; Statistics Cookie
2430 "Parse statistics cookie at point.
2432 Return a list whose CAR is `statistics-cookie', and CDR a plist
2433 with `:begin', `:end', `:value' and `:post-blank' keywords.
2435 Assume point is at the beginning of the statistics-cookie."
2451 "Interpret STATISTICS-COOKIE object as Org syntax.
2452 CONTENTS is nil."
2456 "Search for the next statistics cookie object.
2458 LIMIT bounds the search.
2460 Return value is a cons cell whose CAR is `statistics-cookie' and
2461 CDR is beginning position."
2467 ;;;; Strike-Through
2470 "Parse strike-through object at point.
2472 Return a list whose CAR is `strike-through' and CDR is a plist
2473 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2474 `:post-blank' keywords.
2476 Assume point is at the first plus sign marker."
2494 "Interpret STRIKE-THROUGH object as Org syntax.
2495 CONTENTS is the contents of the object."
2499 ;;;; Subscript
2502 "Parse subscript at point.
2504 Return a list whose CAR is `subscript' and CDR a plist with
2505 `:begin', `:end', `:contents-begin', `:contents-end',
2506 `:use-brackets-p' and `:post-blank' as keywords.
2508 Assume point is at the underscore."
2512 t
2530 "Interpret SUBSCRIPT object as Org syntax.
2531 CONTENTS is the contents of the object."
2534 contents))
2537 "Search for the next sub/superscript object.
2539 LIMIT bounds the search.
2541 Return value is a cons cell whose CAR is either `subscript' or
2542 `superscript' and CDR is beginning position."
2549 ;;;; Superscript
2552 "Parse superscript at point.
2554 Return a list whose CAR is `superscript' and CDR a plist with
2555 `:begin', `:end', `:contents-begin', `:contents-end',
2556 `:use-brackets-p' and `:post-blank' as keywords.
2558 Assume point is at the caret."
2579 "Interpret SUPERSCRIPT object as Org syntax.
2580 CONTENTS is the contents of the object."
2583 contents))
2586 ;;;; Table Cell
2589 "Parse table cell at point.
2591 Return a list whose CAR is `table-cell' and CDR is a plist
2592 containing `:begin', `:end', `:contents-begin', `:contents-end'
2593 and `:post-blank' keywords."
2607 "Interpret TABLE-CELL element as Org syntax.
2608 CONTENTS is the contents of the cell, or nil."
2612 "Search for the next table-cell object.
2614 LIMIT bounds the search.
2616 Return value is a cons cell whose CAR is `table-cell' and CDR is
2617 beginning position."
2621 ;;;; Target
2624 "Parse target at point.
2626 Return a list whose CAR is `target' and CDR a plist with
2627 `:begin', `:end', `:value' and `:post-blank' as keywords.
2629 Assume point is at the target."
2644 "Interpret TARGET object as Org syntax.
2645 CONTENTS is nil."
2649 "Search for the next target object.
2651 LIMIT bounds the search.
2653 Return value is a cons cell whose CAR is `target' and CDR is
2654 beginning position."
2660 ;;;; Timestamp
2663 "Parse time stamp at point.
2665 Return a list whose CAR is `timestamp', and CDR a plist with
2666 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2668 Assume point is at the beginning of the timestamp."
2694 "Interpret TIMESTAMP object as Org syntax.
2695 CONTENTS is nil."
2699 "Search for the next timestamp object.
2701 LIMIT bounds the search.
2703 Return value is a cons cell whose CAR is `timestamp' and CDR is
2704 beginning position."
2712 limit t)
2716 ;;;; Underline
2719 "Parse underline object at point.
2721 Return a list whose CAR is `underline' and CDR is a plist with
2722 `:begin', `:end', `:contents-begin' and `:contents-end' and
2723 `:post-blank' keywords.
2725 Assume point is at the first underscore marker."
2743 "Interpret UNDERLINE object as Org syntax.
2744 CONTENTS is the contents of the object."
2748 ;;;; Verbatim
2751 "Parse verbatim object at point.
2753 Return a list whose CAR is `verbatim' and CDR is a plist with
2754 `:value', `:begin', `:end' and `:post-blank' keywords.
2756 Assume point is at the first equal sign marker."
2772 "Interpret VERBATIM object as Org syntax.
2773 CONTENTS is nil."
2777 \f
2778 ;;; Definitions And Rules
2780 ;; Define elements, greater elements and specify recursive objects,
2781 ;; along with the affiliated keywords recognized. Also set up
2782 ;; restrictions on recursive objects combinations.
2784 ;; These variables really act as a control center for the parsing
2785 ;; process.
2788 ;; Headlines and inlinetasks.
2790 ;; Comments, blocks (any type), keywords and babel calls.
2792 ;; Lists.
2794 ;; Fixed-width, drawers (any type) and tables.
2796 ;; Footnote definitions.
2798 ;; Horizontal rules.
2800 ;; LaTeX environments.
2802 ;; Planning and Clock lines.
2812 export-block fixed-width footnote-definition headline
2813 horizontal-rule inlinetask item keyword latex-environment
2814 babel-call paragraph plain-list planning property-drawer
2815 quote-block quote-section section special-block src-block table
2816 table-row verse-block)
2821 item plain-list quote-block section special-block table)
2826 latex-or-entity line-break link macro radio-target
2827 statistics-cookie sub/superscript table-cell target
2828 text-markup timestamp)
2837 "Alist of translations between object type and successor name.
2839 Sharing the same successor comes handy when, for example, the
2844 inline-src-block italic line-break latex-fragment link macro
2845 radio-target statistics-cookie strike-through subscript superscript
2846 table-cell target timestamp underline verbatim)
2851 table-cell underline)
2876 "Alist of usual translations for keywords.
2877 The key is the old name and the value the new one. The property
2882 "List of affiliated keywords that can occur more that once in an element.
2884 Their value will be consed into a list of strings, which will be
2885 returned as the value of the property.
2887 This list is checked after translations have been applied. See
2891 "List of keywords whose value can be parsed.
2893 Their value will be stored as a secondary string: a list of
2894 strings and objects.
2896 This list is checked after translations have been applied. See
2900 "List of keywords which can have a secondary value.
2902 In Org syntax, they can be written with optional square brackets
2903 before the colons. For example, results keyword can be
2904 associated to a hash value with the following:
2906 #+RESULTS[hash-string]: some-source
2908 This list is checked after translations have been applied. See
2915 inline-babel-call inline-src-block latex-fragment
2916 line-break link macro radio-target sub/superscript
2917 target text-markup timestamp)
2919 macro radio-target statistics-cookie sub/superscript text-markup
2920 timestamp)
2934 link radio-target sub/superscript target text-markup
2935 timestamp)
2946 latex-fragment line-break link macro radio-target
2948 "Alist of objects restrictions.
2950 CAR is an element or object type containing objects and CDR is
2951 a list of successors that will be called within an element or
2952 object of such type.
2954 For example, in a `radio-target' object, one can only find
2955 entities, export snippets, latex-fragments, subscript and
2956 superscript.
2958 This alist also applies to secondary string. For example, an
2959 `headline' type element doesn't directly contain objects, but
2970 \f
2971 ;;; Accessors
2972 ;;
2973 ;; Provide four accessors: `org-element-type', `org-element-property'
2974 ;; `org-element-contents' and `org-element-restriction'.
2977 "Return type of element ELEMENT.
2979 The function returns the type of the element or object provided.
2980 It can also return the following special value:
2981 `plain-text' for a string
2982 `org-data' for a complete document
2983 nil in any other case."
2989 "Extract the value from the PROPERTY of an ELEMENT."
2993 "Extract contents from an ELEMENT."
2997 "Return restriction associated to ELEMENT.
2998 ELEMENT can be an element, an object or a symbol representing an
2999 element or object type."
3001 org-element-object-restrictions)))
3004 \f
3005 ;;; Parsing Element Starting At Point
3006 ;;
3007 ;; `org-element-current-element' is the core function of this section.
3008 ;; It returns the Lisp representation of the element starting at
3009 ;; point. It uses `org-element--element-block-re' for quick access to
3010 ;; a common regexp.
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'.
3021 'regexp-quote
3023 "Regexp matching the beginning of a non-recursive block type.
3027 "Parse the element starting at point.
3029 Return value is a list like (TYPE PROPS) where TYPE is the type
3030 of the element and PROPS a plist of properties associated to the
3031 element.
3033 Possible types are defined in `org-element-all-elements'.
3035 Optional argument GRANULARITY determines the depth of the
3036 recursion. Allowed values are `headline', `greater-element',
3037 `element', `object' or nil. When it is broader than `object' (or
3038 nil), secondary values will not be parsed, since they only
3039 contain objects.
3041 Optional argument SPECIAL, when non-nil, can be either `section',
3042 `quote-section', `table-row' and `item'.
3044 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3045 be computed.
3047 Unlike to `org-element-at-point', this function assumes point is
3048 always at the beginning of the element it has to parse. As such,
3049 it is quicker than its counterpart, albeit more restrictive."
3051 ;; If point is at an affiliated keyword, try moving to the
3052 ;; beginning of the associated element. If none is found, the
3053 ;; keyword is orphaned and will be treated as plain text.
3059 ;; Determine if parsing depth allows for secondary strings
3060 ;; parsing. It only applies to elements referenced in
3061 ;; `org-element-secondary-value-alist'.
3064 ;; Item
3067 raw-secondary-p))
3068 ;; Quote Section.
3070 ;; Table Row.
3072 ;; Headline.
3075 ;; Section (must be checked after headline).
3077 ;; Planning and Clock.
3082 ;; Non-recursive block.
3091 "org-element-%s-parser"
3094 ;; Inlinetask.
3096 ;; LaTeX Environment or Paragraph if incomplete.
3102 ;; Property Drawer.
3107 ;; Recursive Block, or Paragraph if incomplete.
3118 ;; Drawer.
3124 ;; Babel Call.
3127 ;; Dynamic Block or Paragraph if incomplete. This must be
3128 ;; checked before regular keywords since their regexp matches
3129 ;; dynamic blocks too.
3135 ;; Keyword, or Paragraph if at an orphaned affiliated keyword.
3142 ;; Footnote definition.
3145 ;; Comment.
3148 ;; Horizontal Rule.
3151 ;; Table.
3153 ;; List or Item.
3156 ;; Default element: Paragraph.
3160 ;; Most elements can have affiliated keywords. When looking for an
3161 ;; element beginning, we want to move before them, as they belong to
3162 ;; that element, and, in the meantime, collect information they give
3163 ;; into appropriate properties. Hence the following function.
3165 ;; Usage of optional arguments may not be obvious at first glance:
3167 ;; - TRANS-LIST is used to polish keywords names that have evolved
3168 ;; during Org history. In example, even though =result= and
3169 ;; =results= coexist, we want to have them under the same =result=
3170 ;; property. It's also true for "srcname" and "name", where the
3171 ;; latter seems to be preferred nowadays (thus the "name" property).
3173 ;; - CONSED allows to regroup multi-lines keywords under the same
3174 ;; property, while preserving their own identity. This is mostly
3175 ;; used for "attr_latex" and al.
3177 ;; - PARSED prepares a keyword value for export. This is useful for
3178 ;; "caption". Objects restrictions for such keywords are defined in
3179 ;; `org-element-object-restrictions'.
3181 ;; - DUALS is used to take care of keywords accepting a main and an
3182 ;; optional secondary values. For example "results" has its
3183 ;; source's name as the main value, and may have an hash string in
3184 ;; optional square brackets as the secondary one.
3186 ;; A keyword may belong to more than one category.
3197 "Regexp matching any affiliated keyword.
3199 Keyword name is put in match group 1. Moreover, if keyword
3200 belongs to `org-element-dual-keywords', put the dual value in
3201 match group 2.
3206 consed parsed duals)
3207 "Collect affiliated keywords before point.
3209 Optional argument KEY-RE is a regexp matching keywords, which
3210 puts matched keyword in group 1. It defaults to
3211 `org-element--affiliated-re'.
3213 TRANS-LIST is an alist where key is the keyword and value the
3214 property name it should be translated to, without the colons. It
3215 defaults to `org-element-keyword-translation-alist'.
3217 CONSED is a list of strings. Any keyword belonging to that list
3218 will have its value consed. The check is done after keyword
3219 translation. It defaults to `org-element-multiple-keywords'.
3221 PARSED is a list of strings. Any keyword member of this list
3222 will have its value parsed. The check is done after keyword
3223 translation. If a keyword is a member of both CONSED and PARSED,
3224 it's value will be a list of parsed strings. It defaults to
3225 `org-element-parsed-keywords'.
3227 DUALS is a list of strings. Any keyword member of this list can
3228 have two parts: one mandatory and one optional. Its value is
3229 a cons cell whose car is the former, and the cdr the latter. If
3230 a keyword is a member of both PARSED and DUALS, both values will
3231 be parsed. It defaults to `org-element-dual-keywords'.
3233 Return a list whose car is the position at the first of them and
3234 cdr a plist of keywords and values."
3242 ;; RESTRICT is the list of objects allowed in parsed
3243 ;; keywords value.
3245 output)
3250 ;; Apply translation to RAW-KWD. From there, KWD is
3251 ;; the official keyword.
3253 ;; Find main value for any keyword.
3259 ;; If KWD is a dual keyword, find its secondary
3260 ;; value. Maybe parse it.
3266 ;; Attribute a property name to KWD.
3268 ;; Now set final shape for VALUE.
3272 ;; VALUE is mandatory. Set it to nil if there is none.
3276 ;; Eventually store the new value in OUTPUT.
3282 \f
3283 ;;; The Org Parser
3285 ;; The two major functions here are `org-element-parse-buffer', which
3286 ;; parses Org syntax inside the current buffer, taking into account
3287 ;; region, narrowing, or even visibility if specified, and
3288 ;; `org-element-parse-secondary-string', which parses objects within
3289 ;; a given string.
3291 ;; The (almost) almighty `org-element-map' allows to apply a function
3292 ;; on elements or objects matching some type, and accumulate the
3293 ;; resulting values. In an export situation, it also skips unneeded
3294 ;; parts of the parse tree.
3297 "Recursively parse the buffer and return structure.
3298 If narrowing is in effect, only parse the visible part of the
3299 buffer.
3301 Optional argument GRANULARITY determines the depth of the
3302 recursion. It can be set to the following symbols:
3304 `headline' Only parse headlines.
3305 `greater-element' Don't recurse into greater elements excepted
3306 headlines and sections. Thus, elements
3307 parsed are the top-level ones.
3308 `element' Parse everything but objects and plain text.
3309 `object' Parse the complete buffer (default).
3311 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3312 elements.
3314 Assume buffer is in Org mode."
3321 ;; Start in `section' mode so text before the first
3322 ;; headline belongs to a section.
3326 "Recursively parse objects in STRING and return structure.
3328 RESTRICTION, when non-nil, is a symbol limiting the object types
3329 that will be looked after."
3335 "Map a function on selected elements or objects.
3337 DATA is the parsed tree, as returned by, i.e,
3338 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3339 of elements or objects types. FUN is the function called on the
3340 matching element or object. It must accept one arguments: the
3341 element or object itself.
3343 When optional argument INFO is non-nil, it should be a plist
3344 holding export options. In that case, parts of the parse tree
3345 not exportable according to that property list will be skipped.
3347 When optional argument FIRST-MATCH is non-nil, stop at the first
3348 match for which FUN doesn't return nil, and return that value.
3350 Optional argument NO-RECURSION is a symbol or a list of symbols
3351 representing elements or objects types. `org-element-map' won't
3352 enter any recursive element or object whose type belongs to that
3353 list. Though, FUN can still be applied on them.
3355 Nil values returned from FUN do not appear in the results."
3356 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3359 ;; Recursion depth is determined by --CATEGORY.
3369 ;; --RESTRICTS is a list of element types whose secondary
3370 ;; string could possibly contain an object with a type among
3371 ;; TYPES.
3375 when
3379 --acc
3383 ;; Recursively walk DATA. INFO, if non-nil, is
3384 ;; a plist holding contextual information.
3389 ;; Check if TYPE is matching among TYPES. If so,
3390 ;; apply FUN to --BLOB and accumulate return value
3391 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3397 ;; If --BLOB has a secondary string that can
3398 ;; contain objects with their type among TYPES,
3399 ;; look into that string.
3402 --walk-tree
3404 nil
3407 --blob))))
3408 ;; Now determine if a recursion into --BLOB is
3409 ;; possible. If so, do it.
3420 ;; Return value in a proper order.
3423 ;; The following functions are internal parts of the parser.
3425 ;; The first one, `org-element-parse-elements' acts at the element's
3426 ;; level.
3428 ;; The second one, `org-element-parse-objects' applies on all objects
3429 ;; of a paragraph or a secondary string. It uses
3430 ;; `org-element-get-candidates' to optimize the search of the next
3431 ;; object in the buffer.
3433 ;; More precisely, that function looks for every allowed object type
3434 ;; first. Then, it discards failed searches, keeps further matches,
3435 ;; and searches again types matched behind point, for subsequent
3436 ;; calls. Thus, searching for a given type fails only once, and every
3437 ;; object is searched only once at top level (but sometimes more for
3438 ;; nested types).
3442 "Parse elements between BEG and END positions.
3444 SPECIAL prioritize some elements over the others. It can be set
3445 to `quote-section', `section' `item' or `table-row'.
3447 When value is `item', STRUCTURE will be used as the current list
3448 structure.
3450 GRANULARITY determines the depth of the recursion. See
3451 `org-element-parse-buffer' for more information.
3453 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3454 elements.
3456 Elements are accumulated into ACC."
3461 ;; When parsing only headlines, skip any text before first one.
3464 ;; Main loop start.
3467 ;; Find current element's type and parse it accordingly to
3468 ;; its category.
3470 granularity special structure))
3475 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3476 ;; true and element is hidden or if it has no contents
3477 ;; anyway.
3480 ;; Case 2. Greater element: parse it between
3481 ;; `contents-begin' and `contents-end'. Make sure
3482 ;; GRANULARITY allows the recursion, or ELEMENT is an
3483 ;; headline, in which case going inside is mandatory, in
3484 ;; order to get sub-level headings.
3492 ;; Possibly switch to a special mode.
3501 ;; Case 3. ELEMENT has contents. Parse objects inside,
3502 ;; if GRANULARITY allows it.
3507 ;; Case 4. Else, just accumulate ELEMENT.
3509 acc)))
3510 ;; Return result.
3514 "Parse objects between BEG and END and return recursive structure.
3516 Objects are accumulated in ACC.
3518 RESTRICTION is a list of object types which are allowed in the
3519 current object."
3523 ;; Return the parsing function associated to the nearest
3524 ;; object among list of candidates CAND.
3531 next-object candidates)
3535 end restriction candidates))
3537 ;; 1. Text before any object. Untabify it.
3543 acc)))
3544 ;; 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
3559 ;; Restrict allowed objects.
3561 ;; ... not recursive. Accumulate the object.
3562 next-object)
3563 acc)
3565 ;; 3. Text after last object. Untabify it.
3570 acc))
3571 ;; Result.
3575 "Return an alist of candidates for the next object.
3577 LIMIT bounds the search, and RESTRICTION narrows candidates to
3578 some object types.
3580 Return value is an alist whose CAR is position and CDR the object
3581 type, as a symbol.
3583 OBJECTS is the previous candidates alist."
3585 ;; If no previous result, search every object type in RESTRICTION.
3586 ;; Otherwise, keep potential candidates (old objects located after
3587 ;; point) and ask to search again those which had matched before.
3592 objects))
3593 ;; Call the appropriate successor function for each type to search
3594 ;; and accumulate matches.
3601 type))))
3604 types-to-search)
3605 ;; Return alist.
3606 next-candidates))
3609 \f
3610 ;;; Towards A Bijective Process
3612 ;; The parse tree obtained with `org-element-parse-buffer' is really
3613 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3614 ;; interpreted and expanded into a string with canonical Org syntax.
3615 ;; Hence `org-element-interpret-data'.
3616 ;;
3617 ;; The function relies internally on
3618 ;; `org-element-interpret--affiliated-keywords'.
3621 "Interpret DATA as Org syntax.
3623 DATA is a parse tree, an element, an object or a secondary string
3624 to interpret.
3626 Optional argument PARENT is used for recursive calls. It contains
3627 the element or object containing data, or nil.
3629 Return Org syntax as a string."
3633 ;; Secondary string.
3638 ;; Full Org document.
3643 ;; Plain text.
3645 ;; Element/Object without contents.
3648 data nil))
3649 ;; Element/Object with contents.
3659 ;; Elements directly containing objects must
3660 ;; have their indentation normalized first.
3662 data
3663 ;; When normalizing first paragraph of an
3664 ;; item or a footnote-definition, ignore
3665 ;; first line's indentation.
3672 data
3674 contents)))))))
3676 ;; Build white spaces. If no `:post-blank' property is
3677 ;; specified, assume its value is 0.
3687 "Return ELEMENT's affiliated keywords as Org syntax.
3688 If there is no affiliated keyword, return the empty string."
3698 ": "
3701 value)
3706 element)))
3713 ;; Remove translated keywords.
3718 org-element-affiliated-keywords))
3721 ;; Because interpretation of the parse tree must return the same
3722 ;; number of blank lines between elements and the same number of white
3723 ;; space after objects, some special care must be given to white
3724 ;; spaces.
3725 ;;
3726 ;; The first function, `org-element-normalize-string', ensures any
3727 ;; string different from the empty string will end with a single
3728 ;; newline character.
3729 ;;
3730 ;; The second function, `org-element-normalize-contents', removes
3731 ;; global indentation from the contents of the current element.
3734 "Ensure string S ends with a single newline character.
3736 If S isn't a string return it unchanged. If S is the empty
3737 string, return it. Otherwise, return a new string with a single
3738 newline character at its end."
3746 "Normalize plain text in ELEMENT's contents.
3748 ELEMENT must only contain plain text and objects.
3750 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3751 indentation to compute maximal common indentation.
3753 Return the normalized element that is element with global
3754 indentation removed from its contents. The function assumes that
3755 indentation is not done with TAB characters."
3759 ;; Return list of indentations within BLOB. This is done by
3760 ;; walking recursively BLOB and updating IND-LIST along the
3761 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3762 ;; been seen yet. It is required as this string is the only
3763 ;; one whose indentation doesn't happen after a newline
3764 ;; character.
3772 ;; An indentation of zero means no string will be
3773 ;; modified. Quit the process.
3779 ;; Avoid matching blank or empty lines.
3787 ;; Collect indentation list in ELEMENT. Possibly remove first
3788 ;; value if IGNORE-FIRST is non-nil.
3791 ;; Build ELEMENT back, replacing each string with the same
3792 ;; string minus common indentation.
3796 ;; Return BLOB with all its strings indentation
3797 ;; shortened from MCI white spaces. FIRST-FLAG is
3798 ;; non-nil when the first string hasn't been seen
3799 ;; yet.
3814 org-element-recursive-objects)
3821 \f
3822 ;;; The Toolbox
3824 ;; The first move is to implement a way to obtain the smallest element
3825 ;; containing point. This is the job of `org-element-at-point'. It
3826 ;; basically jumps back to the beginning of section containing point
3827 ;; and moves, element after element, with
3828 ;; `org-element-current-element' until the container is found.
3829 ;;
3830 ;; Note: When using `org-element-at-point', secondary values are never
3831 ;; parsed since the function focuses on elements, not on objects.
3834 "Determine closest element around point.
3836 Return value is a list like (TYPE PROPS) where TYPE is the type
3837 of the element and PROPS a plist of properties associated to the
3838 element. Possible types are defined in
3839 `org-element-all-elements'.
3841 As a special case, if point is at the very beginning of a list or
3842 sub-list, returned element will be that list instead of the first
3843 item. In the same way, if point is at the beginning of the first
3844 row of a table, returned element will be the table instead of the
3845 first row.
3847 If optional argument KEEP-TRAIL is non-nil, the function returns
3848 a list of of elements leading to element at point. The list's
3849 CAR is always the element at point. Its last item will be the
3850 element's parent, unless element was either the first in its
3851 section (in which case the last item in the list is the first
3852 element of section) or an headline (in which case the list
3853 contains that headline as its single element). Elements
3854 in-between, if any, are siblings of the element at point."
3856 ;; If at an headline, parse it. It is the sole element that
3857 ;; doesn't require to know about context. Be sure to disallow
3858 ;; secondary string parsing, though.
3862 ;; Otherwise move at the beginning of the section containing
3863 ;; point.
3871 ;; Starting parsing successively each element with
3872 ;; `org-element-current-element'. Skip those ending before
3873 ;; original position.
3881 ;; 1. Skip any element ending before point or at point.
3886 ;; 2. An element containing point is always the element at
3887 ;; point.
3890 ;; 3. At a plain list.
3896 ;; Find the item at this level containing ORIGIN.
3898 parent)
3903 ;; Item ends before point: skip it.
3905 ;; Item contains point: store is in PARENT.
3907 ;; We went too far: return PARENT.
3909 ;; No parent: no item contained point, though the
3910 ;; plain list does. Point is in the blank lines
3911 ;; after the list: return plain list.
3915 ;; 4. At a table.
3926 ;; 4. At any other greater element type, if point is
3927 ;; within contents, move into it. Otherwise, return
3928 ;; that element.
3935 ;; Reset trail, since we found a parent.
3941 ;; Once the local structure around point is well understood, it's easy
3942 ;; to implement some replacements for `forward-paragraph'
3943 ;; `backward-paragraph', namely `org-element-forward' and
3944 ;; `org-element-backward'.
3946 ;; Also, `org-transpose-elements' mimics the behaviour of
3947 ;; `transpose-words', at the element's level, whereas
3948 ;; `org-element-drag-forward', `org-element-drag-backward', and
3949 ;; `org-element-up' generalize, respectively, functions
3950 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3952 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3953 ;; smartly remove global indentation from buffer, making it possible
3954 ;; to use Org indent mode on a file created with hard indentation.
3956 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3957 ;; internally by some of the previously cited tools.
3960 "Non-nil when elements ELEM-A and ELEM-B are nested."
3969 "Swap elements ELEM-A and ELEM-B.
3971 Leave point at the end of ELEM-A."
3993 "Move backward by one element.
3994 Move to the previous element at the same level, when possible."
4001 ;; Move to beginning of current element if point isn't there.
4005 ;; At an headline: move to previous headline at the same
4006 ;; level, a parent, or BOB.
4011 ;; At an item: try to move to the previous item, if any.
4017 ;; In any other case, find the previous element in the
4018 ;; trail and move to its beginning. If no previous element
4019 ;; can be found, move to headline.
4025 "Drag backward element at point."
4042 ;; Compute new position of point: it's shifted by PREV-ELEM
4043 ;; body's length.
4050 "Move forward element at point."
4063 ;; Compute new position of point: it's shifted by NEXT-ELEM
4064 ;; body's length (without final blanks) and by the length of
4065 ;; blanks between ELEM and NEXT-ELEM.
4082 "Move forward by one element.
4083 Move to the next element at the same level, when possible."
4091 ;; At an headline, move to next headline at the same level.
4093 ;; At an item. Move to the next item, if possible.
4100 ;; In any other case, move to element's end, unless this
4101 ;; position is also the end of its parent's contents, in which
4102 ;; case, directly jump to parent's end.
4105 ;; Determine if TRAIL contains the real parent of ELEMENT.
4109 org-element-greater-elements)
4112 parent-candidate)))))
4119 "Put point at beginning of this element, mark at end.
4121 Interactively, if this command is repeated or (in Transient Mark
4122 mode) if the mark is active, it marks the next element after the
4123 ones already marked."
4138 "Narrow buffer to current element."
4156 "Transpose current and previous elements, keeping blank lines between.
4157 Point is moved after both elements."
4176 "Un-indent the visible part of the buffer.
4177 Relative indentation \(between items, inside blocks, etc.\) isn't
4178 modified."
4183 unindent-tree ; For byte-compiler.
4201 "Move to upper element."
4212 ;; At an item, with a parent in the list: move to that parent.
4219 ;; Determine parent in the trail.
4225 org-element-greater-elements)
4228 parentp)))))
4230 ;; When parent is found move to its beginning.
4232 ;; If no parent was found, move to headline above, if any
4233 ;; or return an error.
4238 "Move to inner element."
4246 ;; If contents are hidden, first disclose them.
4253 ;;; org-element.el ends here