| blob | 38596e456100f7f687bc481b85c10693cd714234 |
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, three 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, and `:post-blank', which holds the
70 ;; number of blank lines, or white spaces, at its end. Greater
71 ;; elements and elements containing objects will also have
72 ;; `:contents-begin' and `:contents-end' properties to delimit
73 ;; 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.
688 ;; Indent contents.
690 bullet
701 ;;;; Plain List
704 "Parse a plain list.
706 Optional argument STRUCTURE, when non-nil, is the structure of
707 the plain list being parsed.
709 Return a list whose CAR is `plain-list' and CDR is a plist
710 containing `:type', `:begin', `:end', `:contents-begin' and
711 `:contents-end', `:structure' and `:post-blank' keywords.
713 Assume point is at the beginning of the list."
726 ;; Blank lines below list belong to the top-level list only.
731 ;; Return value.
743 "Interpret PLAIN-LIST element as Org syntax.
744 CONTENTS is the contents of the element."
745 contents)
748 ;;;; Quote Block
751 "Parse a quote block.
753 Return a list whose CAR is `quote-block' and CDR is a plist
754 containing `:begin', `:end', `:hiddenp', `:contents-begin',
755 `:contents-end' and `:post-blank' keywords.
757 Assume point is at the beginning of the block."
779 "Interpret QUOTE-BLOCK element as Org syntax.
780 CONTENTS is the contents of the element."
784 ;;;; Section
787 "Parse a section.
789 Return a list whose CAR is `section' and CDR is a plist
790 containing `:begin', `:end', `:contents-begin', `contents-end'
791 and `:post-blank' keywords."
793 ;; Beginning of section is the beginning of the first non-blank
794 ;; line after previous headline.
813 "Interpret SECTION element as Org syntax.
814 CONTENTS is the contents of the element."
815 contents)
818 ;;;; Special Block
821 "Parse a special block.
823 Return a list whose CAR is `special-block' and CDR is a plist
824 containing `:type', `:begin', `:end', `:hiddenp',
825 `:contents-begin', `:contents-end' and `:post-blank' keywords.
827 Assume point is at the beginning of the block."
853 "Interpret SPECIAL-BLOCK element as Org syntax.
854 CONTENTS is the contents of the element."
859 \f
860 ;;; Elements
861 ;;
862 ;; For each element, a parser and an interpreter are also defined.
863 ;; Both follow the same naming convention used for greater elements.
864 ;;
865 ;; Also, as for greater elements, adding a new element type is done
866 ;; through the following steps: implement a parser and an interpreter,
867 ;; tweak `org-element-current-element' so that it recognizes the new
868 ;; type and add that new type to `org-element-all-elements'.
869 ;;
870 ;; As a special case, when the newly defined type is a block type,
871 ;; `org-element-block-name-alist' has to be modified accordingly.
874 ;;;; Babel Call
877 "Parse a babel call.
879 Return a list whose CAR is `babel-call' and CDR is a plist
880 containing `:begin', `:end', `:info' and `:post-blank' as
881 keywords."
897 "Interpret BABEL-CALL element as Org syntax.
898 CONTENTS is nil."
904 ;; Remove redundant square brackets.
909 ;;;; Clock
912 "Parse a clock.
914 Return a list whose CAR is `clock' and CDR is a plist containing
915 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
916 as keywords."
941 "Interpret CLOCK element as Org syntax.
942 CONTENTS is nil."
949 "%2s:%02s"
953 ;;;; Comment
956 "Parse a comment.
958 Return a list whose CAR is `comment' and CDR is a plist
959 containing `:begin', `:end', `:value' and `:post-blank'
960 keywords.
962 Assume point is at comment beginning."
966 ;; Match first line with a loose regexp since it might as
967 ;; well be an ill-defined keyword.
973 ;; Get comments ending. This may not be accurate if
974 ;; commented lines within an item are followed by
975 ;; commented lines outside of a list. Though, parser will
976 ;; always get it right as it already knows surrounding
977 ;; element and has narrowed buffer to its contents.
980 ;; Accumulate lines without leading hash and plus sign
981 ;; if any. First whitespace is also ignored.
999 "Interpret COMMENT element as Org syntax.
1000 CONTENTS is nil."
1004 ;;;; Comment Block
1007 "Parse an export block.
1009 Return a list whose CAR is `comment-block' and CDR is a plist
1010 containing `:begin', `:end', `:hiddenp', `:value' and
1011 `:post-blank' keywords.
1013 Assume point is at comment block beginning."
1036 "Interpret COMMENT-BLOCK element as Org syntax.
1037 CONTENTS is nil."
1042 ;;;; Example Block
1045 "Parse an example block.
1047 Return a list whose CAR is `example-block' and CDR is a plist
1048 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1049 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1050 `:switches', `:value' and `:post-blank' keywords."
1056 ;; Switches analysis
1061 ;; Should labels be retained in (or stripped from) example
1062 ;; blocks?
1067 ;; What should code-references use - labels or
1068 ;; line-numbers?
1075 ;; Standard block parsing.
1102 "Interpret EXAMPLE-BLOCK element as Org syntax.
1103 CONTENTS is nil."
1111 ;;;; Export Block
1114 "Parse an export block.
1116 Return a list whose CAR is `export-block' and CDR is a plist
1117 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1118 `:post-blank' keywords.
1120 Assume point is at export-block beginning."
1146 "Interpret EXPORT-BLOCK element as Org syntax.
1147 CONTENTS is nil."
1154 ;;;; Fixed-width
1157 "Parse a fixed-width section.
1159 Return a list whose CAR is `fixed-width' and CDR is a plist
1160 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1162 Assume point is at the beginning of the fixed-width area."
1166 value
1168 ;; Ending position may not be accurate if fixed-width
1169 ;; lines within an item are followed by fixed-width lines
1170 ;; outside of a list. Though, parser will always get it
1171 ;; right as it already knows surrounding element and has
1172 ;; narrowed buffer to its contents.
1175 ;, Accumulate text without starting colons.
1193 "Interpret FIXED-WIDTH element as Org syntax.
1194 CONTENTS is nil."
1199 ;;;; Horizontal Rule
1202 "Parse an horizontal rule.
1204 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1205 containing `:begin', `:end' and `:post-blank' keywords."
1219 "Interpret HORIZONTAL-RULE element as Org syntax.
1220 CONTENTS is nil."
1224 ;;;; Keyword
1227 "Parse a keyword at point.
1229 Return a list whose CAR is `keyword' and CDR is a plist
1230 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1231 keywords."
1251 "Interpret KEYWORD element as Org syntax.
1252 CONTENTS is nil."
1258 ;;;; Latex Environment
1261 "Parse a LaTeX environment.
1263 Return a list whose CAR is `latex-environment' and CDR is a plist
1264 containing `:begin', `:end', `:value' and `:post-blank'
1265 keywords.
1267 Assume point is at the beginning of the latex environment."
1290 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1291 CONTENTS is nil."
1295 ;;;; Paragraph
1298 "Parse a paragraph.
1300 Return a list whose CAR is `paragraph' and CDR is a plist
1301 containing `:begin', `:end', `:contents-begin' and
1302 `:contents-end' and `:post-blank' keywords.
1304 Assume point is at the beginning of the paragraph."
1326 "Interpret PARAGRAPH element as Org syntax.
1327 CONTENTS is the contents of the element."
1328 contents)
1331 ;;;; Planning
1334 "Parse a planning.
1336 Return a list whose CAR is `planning' and CDR is a plist
1337 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1338 and `:post-blank' keywords."
1347 closed deadline scheduled)
1367 "Interpret PLANNING element as Org syntax.
1368 CONTENTS is nil."
1370 'identity
1381 ;;;; Property Drawer
1384 "Parse a property drawer.
1386 Return a list whose CAR is `property-drawer' and CDR is a plist
1387 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1388 `:contents-end', `:properties' and `:post-blank' keywords.
1390 Assume point is at the beginning of the property drawer."
1404 val))
1406 val))
1420 "Interpret PROPERTY-DRAWER element as Org syntax.
1421 CONTENTS is nil."
1431 ;;;; Quote Section
1434 "Parse a quote section.
1436 Return a list whose CAR is `quote-section' and CDR is a plist
1437 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1439 Assume point is at beginning of the section."
1455 "Interpret QUOTE-SECTION element as Org syntax.
1456 CONTENTS is nil."
1460 ;;;; Src Block
1463 "Parse a src block.
1465 Return a list whose CAR is `src-block' and CDR is a plist
1466 containing `:language', `:switches', `:parameters', `:begin',
1467 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1468 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1469 `:post-blank' keywords.
1471 Assume point is at the beginning of the block."
1475 ;; Get affiliated keywords.
1477 ;; Get beginning position.
1479 ;; Get language as a string.
1488 ;; Get switches.
1490 ;; Get parameters.
1492 ;; Switches analysis
1500 ;; Should labels be retained in (or stripped from) src
1501 ;; blocks?
1506 ;; What should code-references use - labels or
1507 ;; line-numbers?
1511 ;; Get position at end of block.
1515 ;; Retrieve code.
1521 ;; Get position after ending blank lines.
1524 ;; Get visibility status.
1547 "Interpret SRC-BLOCK element as Org syntax.
1548 CONTENTS is nil."
1568 value
1572 ;;;; Table
1575 "Parse a table at point.
1577 Return a list whose CAR is `table' and CDR is a plist containing
1578 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1579 `:contents-end', `:value' and `:post-blank' keywords.
1581 Assume point is at the beginning of the table."
1593 acc))
1602 ;; Only `org' tables have contents. `table.el' tables
1603 ;; use a `:value' property to store raw table as
1604 ;; a string.
1609 table-begin table-end))
1614 "Interpret TABLE element as Org syntax.
1615 CONTENTS is nil."
1626 ;;;; Table Row
1629 "Parse table row at point.
1631 Return a list whose CAR is `table-row' and CDR is a plist
1632 containing `:begin', `:end', `:contents-begin', `:contents-end',
1633 `:type' and `:post-blank' keywords."
1637 ;; A table rule has no contents. In that case, ensure
1638 ;; CONTENTS-BEGIN matches CONTENTS-END.
1657 "Interpret TABLE-ROW element as Org syntax.
1658 CONTENTS is the contents of the table row."
1663 ;;;; Verse Block
1666 "Parse a verse block.
1668 Return a list whose CAR is `verse-block' and CDR is a plist
1669 containing `:begin', `:end', `:contents-begin', `:contents-end',
1670 `:hiddenp' and `:post-blank' keywords.
1672 Assume point is at beginning of the block."
1696 "Interpret VERSE-BLOCK element as Org syntax.
1697 CONTENTS is verse block contents."
1701 \f
1702 ;;; Objects
1703 ;;
1704 ;; Unlike to elements, interstices can be found between objects.
1705 ;; That's why, along with the parser, successor functions are provided
1706 ;; for each object. Some objects share the same successor (i.e. `code'
1707 ;; and `verbatim' objects).
1708 ;;
1709 ;; A successor must accept a single argument bounding the search. It
1710 ;; will return either a cons cell whose CAR is the object's type, as
1711 ;; a symbol, and CDR the position of its next occurrence, or nil.
1712 ;;
1713 ;; Successors follow the naming convention:
1714 ;; org-element-NAME-successor, where NAME is the name of the
1715 ;; successor, as defined in `org-element-all-successors'.
1716 ;;
1717 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1718 ;; object types they can contain will be specified in
1719 ;; `org-element-object-restrictions'.
1720 ;;
1721 ;; Adding a new type of object is simple. Implement a successor,
1722 ;; a parser, and an interpreter for it, all following the naming
1723 ;; convention. Register type in `org-element-all-objects' and
1724 ;; successor in `org-element-all-successors'. Maybe tweak
1725 ;; restrictions about it, and that's it.
1728 ;;;; Bold
1731 "Parse bold object at point.
1733 Return a list whose CAR is `bold' and CDR is a plist with
1734 `:begin', `:end', `:contents-begin' and `:contents-end' and
1735 `:post-blank' keywords.
1737 Assume point is at the first star marker."
1755 "Interpret BOLD object as Org syntax.
1756 CONTENTS is the contents of the object."
1760 "Search for the next text-markup object.
1762 LIMIT bounds the search.
1764 Return value is a cons cell whose CAR is a symbol among `bold',
1765 `italic', `underline', `strike-through', `code' and `verbatim'
1766 and CDR is beginning position."
1782 ;;;; Code
1785 "Parse code object at point.
1787 Return a list whose CAR is `code' and CDR is a plist with
1788 `:value', `:begin', `:end' and `:post-blank' keywords.
1790 Assume point is at the first tilde marker."
1806 "Interpret CODE object as Org syntax.
1807 CONTENTS is nil."
1811 ;;;; Entity
1814 "Parse entity at point.
1816 Return a list whose CAR is `entity' and CDR a plist with
1817 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1818 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1819 keywords.
1821 Assume point is at the beginning of the entity."
1823 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
1845 "Interpret ENTITY object as Org syntax.
1846 CONTENTS is nil."
1852 "Search for the next latex-fragment or entity object.
1854 LIMIT bounds the search.
1856 Return value is a cons cell whose CAR is `entity' or
1857 `latex-fragment' and CDR is beginning position."
1860 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1867 limit t)
1870 ;; Determine if it's a real entity or a LaTeX command.
1873 ;; No entity nor command: point is at a LaTeX fragment.
1874 ;; Determine its type to get the correct beginning position.
1882 matchers)
1886 ;;;; Export Snippet
1889 "Parse export snippet at point.
1891 Return a list whose CAR is `export-snippet' and CDR a plist with
1892 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1893 keywords.
1895 Assume point is at the beginning of the snippet."
1918 "Interpret EXPORT-SNIPPET object as Org syntax.
1919 CONTENTS is nil."
1925 "Search for the next export-snippet object.
1927 LIMIT bounds the search.
1929 Return value is a cons cell whose CAR is `export-snippet' CDR is
1930 its beginning position."
1943 ;;;; Footnote Reference
1946 "Parse footnote reference at point.
1948 Return a list whose CAR is `footnote-reference' and CDR a plist
1949 with `:label', `:type', `:inline-definition', `:begin', `:end'
1950 and `:post-blank' as keywords."
1983 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1984 CONTENTS is nil."
1994 "Search for the next footnote-reference object.
1996 LIMIT bounds the search.
1998 Return value is a cons cell whose CAR is `footnote-reference' and
1999 CDR is beginning position."
2013 ;;;; Inline Babel Call
2016 "Parse inline babel call at point.
2018 Return a list whose CAR is `inline-babel-call' and CDR a plist
2019 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2021 Assume point is at the beginning of the babel call."
2037 "Interpret INLINE-BABEL-CALL object as Org syntax.
2038 CONTENTS is nil."
2044 ;; Remove redundant square brackets.
2047 main-source)
2051 "Search for the next inline-babel-call object.
2053 LIMIT bounds the search.
2055 Return value is a cons cell whose CAR is `inline-babel-call' and
2056 CDR is beginning position."
2058 ;; Use a simplified version of
2059 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2061 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2062 limit t)
2066 ;;;; Inline Src Block
2069 "Parse inline source block at point.
2071 Return a list whose CAR is `inline-src-block' and CDR a plist
2072 with `:begin', `:end', `:language', `:value', `:parameters' and
2073 `:post-blank' as keywords.
2075 Assume point is at the beginning of the inline src block."
2095 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2096 CONTENTS is nil."
2101 language
2103 body)))
2106 "Search for the next inline-babel-call element.
2108 LIMIT bounds the search.
2110 Return value is a cons cell whose CAR is `inline-babel-call' and
2111 CDR is beginning position."
2116 ;;;; Italic
2119 "Parse italic object at point.
2121 Return a list whose CAR is `italic' and CDR is a plist with
2122 `:begin', `:end', `:contents-begin' and `:contents-end' and
2123 `:post-blank' keywords.
2125 Assume point is at the first slash marker."
2143 "Interpret ITALIC object as Org syntax.
2144 CONTENTS is the contents of the object."
2148 ;;;; Latex Fragment
2151 "Parse latex fragment at point.
2153 Return a list whose CAR is `latex-fragment' and CDR a plist with
2154 `:value', `:begin', `:end', and `:post-blank' as keywords.
2156 Assume point is at the beginning of the latex fragment."
2170 ;; None found: it's a macro.
2184 "Interpret LATEX-FRAGMENT object as Org syntax.
2185 CONTENTS is nil."
2188 ;;;; Line Break
2191 "Parse line break at point.
2193 Return a list whose CAR is `line-break', and CDR a plist with
2194 `:begin', `:end' and `:post-blank' keywords.
2196 Assume point is at the beginning of the line break."
2202 "Interpret LINE-BREAK object as Org syntax.
2203 CONTENTS is nil."
2207 "Search for the next line-break object.
2209 LIMIT bounds the search.
2211 Return value is a cons cell whose CAR is `line-break' and CDR is
2212 beginning position."
2216 ;; A line break can only happen on a non-empty line.
2221 ;;;; Link
2224 "Parse link at point.
2226 Return a list whose CAR is `link' and CDR a plist with `:type',
2227 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2228 `:contents-end' and `:post-blank' as keywords.
2230 Assume point is at the beginning of the link."
2233 end contents-begin contents-end link-end post-blank path type
2234 raw-link link)
2236 ;; Type 1: Text targeted from a radio target.
2241 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2246 ;; RAW-LINK is the original link.
2251 ;; Determine TYPE of link and set PATH accordingly.
2253 ;; File type.
2256 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2259 ;; Id type: PATH is the id.
2262 ;; Code-ref type: PATH is the name of the reference.
2265 ;; Custom-id type: PATH is the name of the custom id.
2268 ;; Fuzzy type: Internal link either matches a target, an
2269 ;; headline name or nothing. PATH is the target or
2270 ;; headline's name.
2272 ;; Type 3: Plain link, i.e. http://orgmode.org
2278 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2285 ;; In any case, deduce end point after trailing white space from
2286 ;; LINK-END variable.
2300 "Interpret LINK object as Org syntax.
2301 CONTENTS is the contents of the object, or nil."
2306 raw-link
2310 "Search for the next link object.
2312 LIMIT bounds the search.
2314 Return value is a cons cell whose CAR is `link' and CDR is
2315 beginning position."
2324 ;;;; Macro
2327 "Parse macro at point.
2329 Return a list whose CAR is `macro' and CDR a plist with `:key',
2330 `:args', `:begin', `:end', `:value' and `:post-blank' as
2331 keywords.
2333 Assume point is at the macro."
2347 ;; Repair bad splits.
2362 "Interpret MACRO object as Org syntax.
2363 CONTENTS is nil."
2367 "Search for the next macro object.
2369 LIMIT bounds the search.
2371 Return value is cons cell whose CAR is `macro' and CDR is
2372 beginning position."
2376 limit t)
2380 ;;;; Radio-target
2383 "Parse radio target at point.
2385 Return a list whose CAR is `radio-target' and CDR a plist with
2386 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2387 and `:post-blank' as keywords.
2389 Assume point is at the radio target."
2408 "Interpret TARGET object as Org syntax.
2409 CONTENTS is the contents of the object."
2413 "Search for the next radio-target object.
2415 LIMIT bounds the search.
2417 Return value is a cons cell whose CAR is `radio-target' and CDR
2418 is beginning position."
2424 ;;;; Statistics Cookie
2427 "Parse statistics cookie at point.
2429 Return a list whose CAR is `statistics-cookie', and CDR a plist
2430 with `:begin', `:end', `:value' and `:post-blank' keywords.
2432 Assume point is at the beginning of the statistics-cookie."
2448 "Interpret STATISTICS-COOKIE object as Org syntax.
2449 CONTENTS is nil."
2453 "Search for the next statistics cookie object.
2455 LIMIT bounds the search.
2457 Return value is a cons cell whose CAR is `statistics-cookie' and
2458 CDR is beginning position."
2464 ;;;; Strike-Through
2467 "Parse strike-through object at point.
2469 Return a list whose CAR is `strike-through' and CDR is a plist
2470 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2471 `:post-blank' keywords.
2473 Assume point is at the first plus sign marker."
2491 "Interpret STRIKE-THROUGH object as Org syntax.
2492 CONTENTS is the contents of the object."
2496 ;;;; Subscript
2499 "Parse subscript at point.
2501 Return a list whose CAR is `subscript' and CDR a plist with
2502 `:begin', `:end', `:contents-begin', `:contents-end',
2503 `:use-brackets-p' and `:post-blank' as keywords.
2505 Assume point is at the underscore."
2509 t
2527 "Interpret SUBSCRIPT object as Org syntax.
2528 CONTENTS is the contents of the object."
2531 contents))
2534 "Search for the next sub/superscript object.
2536 LIMIT bounds the search.
2538 Return value is a cons cell whose CAR is either `subscript' or
2539 `superscript' and CDR is beginning position."
2546 ;;;; Superscript
2549 "Parse superscript at point.
2551 Return a list whose CAR is `superscript' and CDR a plist with
2552 `:begin', `:end', `:contents-begin', `:contents-end',
2553 `:use-brackets-p' and `:post-blank' as keywords.
2555 Assume point is at the caret."
2576 "Interpret SUPERSCRIPT object as Org syntax.
2577 CONTENTS is the contents of the object."
2580 contents))
2583 ;;;; Table Cell
2586 "Parse table cell at point.
2588 Return a list whose CAR is `table-cell' and CDR is a plist
2589 containing `:begin', `:end', `:contents-begin', `:contents-end'
2590 and `:post-blank' keywords."
2604 "Interpret TABLE-CELL element as Org syntax.
2605 CONTENTS is the contents of the cell, or nil."
2609 "Search for the next table-cell object.
2611 LIMIT bounds the search.
2613 Return value is a cons cell whose CAR is `table-cell' and CDR is
2614 beginning position."
2618 ;;;; Target
2621 "Parse target at point.
2623 Return a list whose CAR is `target' and CDR a plist with
2624 `:begin', `:end', `:value' and `:post-blank' as keywords.
2626 Assume point is at the target."
2641 "Interpret TARGET object as Org syntax.
2642 CONTENTS is nil."
2646 "Search for the next target object.
2648 LIMIT bounds the search.
2650 Return value is a cons cell whose CAR is `target' and CDR is
2651 beginning position."
2657 ;;;; Timestamp
2660 "Parse time stamp at point.
2662 Return a list whose CAR is `timestamp', and CDR a plist with
2663 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2665 Assume point is at the beginning of the timestamp."
2691 "Interpret TIMESTAMP object as Org syntax.
2692 CONTENTS is nil."
2696 "Search for the next timestamp object.
2698 LIMIT bounds the search.
2700 Return value is a cons cell whose CAR is `timestamp' and CDR is
2701 beginning position."
2709 limit t)
2713 ;;;; Underline
2716 "Parse underline object at point.
2718 Return a list whose CAR is `underline' and CDR is a plist with
2719 `:begin', `:end', `:contents-begin' and `:contents-end' and
2720 `:post-blank' keywords.
2722 Assume point is at the first underscore marker."
2740 "Interpret UNDERLINE object as Org syntax.
2741 CONTENTS is the contents of the object."
2745 ;;;; Verbatim
2748 "Parse verbatim object at point.
2750 Return a list whose CAR is `verbatim' and CDR is a plist with
2751 `:value', `:begin', `:end' and `:post-blank' keywords.
2753 Assume point is at the first equal sign marker."
2769 "Interpret VERBATIM object as Org syntax.
2770 CONTENTS is nil."
2774 \f
2775 ;;; Definitions And Rules
2776 ;;
2777 ;; Define elements, greater elements and specify recursive objects,
2778 ;; along with the affiliated keywords recognized. Also set up
2779 ;; restrictions on recursive objects combinations.
2780 ;;
2781 ;; These variables really act as a control center for the parsing
2782 ;; process.
2785 ;; Headlines and inlinetasks.
2787 ;; Comments, blocks (any type), keywords and babel calls.
2789 ;; Lists.
2791 ;; Fixed-width, drawers (any type) and tables.
2793 ;; Footnote definitions.
2795 ;; Horizontal rules.
2797 ;; LaTeX environments.
2799 ;; Planning and Clock lines.
2809 export-block fixed-width footnote-definition headline
2810 horizontal-rule inlinetask item keyword latex-environment
2811 babel-call paragraph plain-list planning property-drawer
2812 quote-block quote-section section special-block src-block table
2813 table-row verse-block)
2818 item plain-list quote-block section special-block table)
2823 latex-or-entity line-break link macro radio-target
2824 statistics-cookie sub/superscript table-cell target
2825 text-markup timestamp)
2834 "Alist of translations between object type and successor name.
2836 Sharing the same successor comes handy when, for example, the
2841 inline-src-block italic line-break latex-fragment link macro
2842 radio-target statistics-cookie strike-through subscript superscript
2843 table-cell target timestamp underline verbatim)
2848 table-cell underline)
2863 "Alist between block names and the associated parsing function.
2864 Names must be uppercase. Any block whose name has no association
2877 "Alist of usual translations for keywords.
2878 The key is the old name and the value the new one. The property
2883 "List of affiliated keywords that can occur more that once in an element.
2885 Their value will be consed into a list of strings, which will be
2886 returned as the value of the property.
2888 This list is checked after translations have been applied. See
2892 "List of keywords whose value can be parsed.
2894 Their value will be stored as a secondary string: a list of
2895 strings and objects.
2897 This list is checked after translations have been applied. See
2901 "List of keywords which can have a secondary value.
2903 In Org syntax, they can be written with optional square brackets
2904 before the colons. For example, results keyword can be
2905 associated to a hash value with the following:
2907 #+RESULTS[hash-string]: some-source
2909 This list is checked after translations have been applied. See
2916 inline-babel-call inline-src-block latex-fragment
2917 line-break link macro radio-target sub/superscript
2918 target text-markup timestamp)
2920 macro radio-target statistics-cookie sub/superscript target
2921 text-markup timestamp)
2935 link radio-target sub/superscript target text-markup
2936 timestamp)
2947 latex-fragment line-break link macro radio-target
2949 "Alist of objects restrictions.
2951 CAR is an element or object type containing objects and CDR is
2952 a list of successors that will be called within an element or
2953 object of such type.
2955 For example, in a `radio-target' object, one can only find
2956 entities, export snippets, latex-fragments, subscript and
2957 superscript.
2959 This alist also applies to secondary string. For example, an
2960 `headline' type element doesn't directly contain objects, but
2971 \f
2972 ;;; Accessors
2973 ;;
2974 ;; Provide four accessors: `org-element-type', `org-element-property'
2975 ;; `org-element-contents' and `org-element-restriction'.
2978 "Return type of element ELEMENT.
2980 The function returns the type of the element or object provided.
2981 It can also return the following special value:
2982 `plain-text' for a string
2983 `org-data' for a complete document
2984 nil in any other case."
2990 "Extract the value from the PROPERTY of an ELEMENT."
2994 "Extract contents from an ELEMENT."
2998 "Return restriction associated to ELEMENT.
2999 ELEMENT can be an element, an object or a symbol representing an
3000 element or object type."
3002 org-element-object-restrictions)))
3005 \f
3006 ;;; Parsing Element Starting At Point
3007 ;;
3008 ;; `org-element-current-element' is the core function of this section.
3009 ;; It returns the Lisp representation of the element starting at
3010 ;; point.
3011 ;;
3012 ;; `org-element-current-element' makes use of special modes. They are
3013 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3014 ;; or fixed conditional element chaining (i.e. `headline' >
3015 ;; `section'). Special modes are: `section', `quote-section', `item'
3016 ;; and `table-row'.
3019 "Parse the element starting at point.
3021 Return value is a list like (TYPE PROPS) where TYPE is the type
3022 of the element and PROPS a plist of properties associated to the
3023 element.
3025 Possible types are defined in `org-element-all-elements'.
3027 Optional argument GRANULARITY determines the depth of the
3028 recursion. Allowed values are `headline', `greater-element',
3029 `element', `object' or nil. When it is broader than `object' (or
3030 nil), secondary values will not be parsed, since they only
3031 contain objects.
3033 Optional argument SPECIAL, when non-nil, can be either `section',
3034 `quote-section', `table-row' and `item'.
3036 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3037 be computed.
3039 This function assumes point is always at the beginning of the
3040 element it has to parse."
3042 ;; If point is at an affiliated keyword, try moving to the
3043 ;; beginning of the associated element. If none is found, the
3044 ;; keyword is orphaned and will be treated as plain text.
3050 ;; Determine if parsing depth allows for secondary strings
3051 ;; parsing. It only applies to elements referenced in
3052 ;; `org-element-secondary-value-alist'.
3055 ;; Item.
3058 raw-secondary-p))
3059 ;; Quote Section.
3061 ;; Table Row.
3063 ;; Headline.
3066 ;; Section (must be checked after headline).
3068 ;; Planning and Clock.
3073 ;; Blocks.
3084 ;; Inlinetask.
3086 ;; LaTeX Environment.
3092 nil t))
3095 ;; Drawer and Property Drawer.
3103 ;; Fixed Width
3105 ;; Babel Call, Dynamic Block and Keyword.
3118 ;; Footnote Definition.
3121 ;; Comment.
3124 ;; Horizontal Rule.
3127 ;; Table.
3129 ;; List.
3132 ;; Default element: Paragraph.
3136 ;; Most elements can have affiliated keywords. When looking for an
3137 ;; element beginning, we want to move before them, as they belong to
3138 ;; that element, and, in the meantime, collect information they give
3139 ;; into appropriate properties. Hence the following function.
3140 ;;
3141 ;; Usage of optional arguments may not be obvious at first glance:
3142 ;;
3143 ;; - TRANS-LIST is used to polish keywords names that have evolved
3144 ;; during Org history. In example, even though =result= and
3145 ;; =results= coexist, we want to have them under the same =result=
3146 ;; property. It's also true for "srcname" and "name", where the
3147 ;; latter seems to be preferred nowadays (thus the "name" property).
3148 ;;
3149 ;; - CONSED allows to regroup multi-lines keywords under the same
3150 ;; property, while preserving their own identity. This is mostly
3151 ;; used for "attr_latex" and al.
3152 ;;
3153 ;; - PARSED prepares a keyword value for export. This is useful for
3154 ;; "caption". Objects restrictions for such keywords are defined in
3155 ;; `org-element-object-restrictions'.
3156 ;;
3157 ;; - DUALS is used to take care of keywords accepting a main and an
3158 ;; optional secondary values. For example "results" has its
3159 ;; source's name as the main value, and may have an hash string in
3160 ;; optional square brackets as the secondary one.
3161 ;;
3162 ;; A keyword may belong to more than one category.
3173 "Regexp matching any affiliated keyword.
3175 Keyword name is put in match group 1. Moreover, if keyword
3176 belongs to `org-element-dual-keywords', put the dual value in
3177 match group 2.
3183 "Collect affiliated keywords before point.
3185 Optional argument KEY-RE is a regexp matching keywords, which
3186 puts matched keyword in group 1. It defaults to
3187 `org-element--affiliated-re'.
3189 TRANS-LIST is an alist where key is the keyword and value the
3190 property name it should be translated to, without the colons. It
3191 defaults to `org-element-keyword-translation-alist'.
3193 CONSED is a list of strings. Any keyword belonging to that list
3194 will have its value consed. The check is done after keyword
3195 translation. It defaults to `org-element-multiple-keywords'.
3197 PARSED is a list of strings. Any keyword member of this list
3198 will have its value parsed. The check is done after keyword
3199 translation. If a keyword is a member of both CONSED and PARSED,
3200 it's value will be a list of parsed strings. It defaults to
3201 `org-element-parsed-keywords'.
3203 DUALS is a list of strings. Any keyword member of this list can
3204 have two parts: one mandatory and one optional. Its value is
3205 a cons cell whose CAR is the former, and the CDR the latter. If
3206 a keyword is a member of both PARSED and DUALS, both values will
3207 be parsed. It defaults to `org-element-dual-keywords'.
3209 Return a list whose CAR is the position at the first of them and
3210 CDR a plist of keywords and values."
3218 ;; RESTRICT is the list of objects allowed in parsed
3219 ;; keywords value.
3221 output)
3226 ;; Apply translation to RAW-KWD. From there, KWD is
3227 ;; the official keyword.
3229 ;; Find main value for any keyword.
3235 ;; If KWD is a dual keyword, find its secondary
3236 ;; value. Maybe parse it.
3242 ;; Attribute a property name to KWD.
3244 ;; Now set final shape for VALUE.
3248 ;; VALUE is mandatory. Set it to nil if there is none.
3252 ;; Eventually store the new value in OUTPUT.
3258 \f
3259 ;;; The Org Parser
3260 ;;
3261 ;; The two major functions here are `org-element-parse-buffer', which
3262 ;; parses Org syntax inside the current buffer, taking into account
3263 ;; region, narrowing, or even visibility if specified, and
3264 ;; `org-element-parse-secondary-string', which parses objects within
3265 ;; a given string.
3266 ;;
3267 ;; The (almost) almighty `org-element-map' allows to apply a function
3268 ;; on elements or objects matching some type, and accumulate the
3269 ;; resulting values. In an export situation, it also skips unneeded
3270 ;; parts of the parse tree.
3273 "Recursively parse the buffer and return structure.
3274 If narrowing is in effect, only parse the visible part of the
3275 buffer.
3277 Optional argument GRANULARITY determines the depth of the
3278 recursion. It can be set to the following symbols:
3280 `headline' Only parse headlines.
3281 `greater-element' Don't recurse into greater elements excepted
3282 headlines and sections. Thus, elements
3283 parsed are the top-level ones.
3284 `element' Parse everything but objects and plain text.
3285 `object' Parse the complete buffer (default).
3287 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3288 elements.
3290 Assume buffer is in Org mode."
3297 ;; Start in `section' mode so text before the first
3298 ;; headline belongs to a section.
3302 "Recursively parse objects in STRING and return structure.
3304 RESTRICTION, when non-nil, is a symbol limiting the object types
3305 that will be looked after."
3311 "Map a function on selected elements or objects.
3313 DATA is the parsed tree, as returned by, i.e,
3314 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3315 of elements or objects types. FUN is the function called on the
3316 matching element or object. It must accept one arguments: the
3317 element or object itself.
3319 When optional argument INFO is non-nil, it should be a plist
3320 holding export options. In that case, parts of the parse tree
3321 not exportable according to that property list will be skipped.
3323 When optional argument FIRST-MATCH is non-nil, stop at the first
3324 match for which FUN doesn't return nil, and return that value.
3326 Optional argument NO-RECURSION is a symbol or a list of symbols
3327 representing elements or objects types. `org-element-map' won't
3328 enter any recursive element or object whose type belongs to that
3329 list. Though, FUN can still be applied on them.
3331 Nil values returned from FUN do not appear in the results."
3332 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3335 ;; Recursion depth is determined by --CATEGORY.
3343 --acc
3344 --walk-tree
3348 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3349 ;; holding contextual information.
3353 ;; Ignored element in an export context.
3355 ;; Secondary string: only objects can be found there.
3358 ;; Unconditionally enter parse trees.
3362 ;; Check if TYPE is matching among TYPES. If so,
3363 ;; apply FUN to --DATA and accumulate return value
3364 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3370 ;; If --DATA has a secondary string that can contain
3371 ;; objects with their type among TYPES, look into it.
3378 ;; Determine if a recursion into --DATA is possible.
3380 ;; --TYPE is explicitly removed from recursion.
3382 ;; --DATA has no contents.
3384 ;; Looking for greater elements but --DATA is simply
3385 ;; an element or an object.
3388 ;; Looking for elements but --DATA is an object.
3391 ;; In any other case, map contents.
3395 ;; Return value in a proper order.
3398 ;; The following functions are internal parts of the parser.
3399 ;;
3400 ;; The first one, `org-element-parse-elements' acts at the element's
3401 ;; level.
3402 ;;
3403 ;; The second one, `org-element-parse-objects' applies on all objects
3404 ;; of a paragraph or a secondary string. It uses
3405 ;; `org-element-get-candidates' to optimize the search of the next
3406 ;; object in the buffer.
3407 ;;
3408 ;; More precisely, that function looks for every allowed object type
3409 ;; first. Then, it discards failed searches, keeps further matches,
3410 ;; and searches again types matched behind point, for subsequent
3411 ;; calls. Thus, searching for a given type fails only once, and every
3412 ;; object is searched only once at top level (but sometimes more for
3413 ;; nested types).
3417 "Parse elements between BEG and END positions.
3419 SPECIAL prioritize some elements over the others. It can be set
3420 to `quote-section', `section' `item' or `table-row'.
3422 When value is `item', STRUCTURE will be used as the current list
3423 structure.
3425 GRANULARITY determines the depth of the recursion. See
3426 `org-element-parse-buffer' for more information.
3428 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3429 elements.
3431 Elements are accumulated into ACC."
3436 ;; When parsing only headlines, skip any text before first one.
3439 ;; Main loop start.
3442 ;; Find current element's type and parse it accordingly to
3443 ;; its category.
3445 granularity special structure))
3450 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3451 ;; true and element is hidden or if it has no contents
3452 ;; anyway.
3455 ;; Case 2. Greater element: parse it between
3456 ;; `contents-begin' and `contents-end'. Make sure
3457 ;; GRANULARITY allows the recursion, or ELEMENT is an
3458 ;; headline, in which case going inside is mandatory, in
3459 ;; order to get sub-level headings.
3467 ;; Possibly switch to a special mode.
3476 ;; Case 3. ELEMENT has contents. Parse objects inside,
3477 ;; if GRANULARITY allows it.
3482 ;; Case 4. Else, just accumulate ELEMENT.
3484 acc)))
3485 ;; Return result.
3489 "Parse objects between BEG and END and return recursive structure.
3491 Objects are accumulated in ACC.
3493 RESTRICTION is a list of object types which are allowed in the
3494 current object."
3498 ;; Return the parsing function associated to the nearest
3499 ;; object among list of candidates CAND.
3506 next-object candidates)
3510 end restriction candidates))
3512 ;; 1. Text before any object. Untabify it.
3518 acc)))
3519 ;; 2. Object...
3523 cont-beg)
3524 ;; ... recursive. The CONT-BEG check is for
3525 ;; links, as some of them might not be recursive
3526 ;; (i.e. plain links).
3529 cont-beg
3534 ;; Restrict allowed objects.
3536 ;; ... not recursive. Accumulate the object.
3537 next-object)
3538 acc)
3540 ;; 3. Text after last object. Untabify it.
3545 acc))
3546 ;; Result.
3550 "Return an alist of candidates for the next object.
3552 LIMIT bounds the search, and RESTRICTION narrows candidates to
3553 some object types.
3555 Return value is an alist whose CAR is position and CDR the object
3556 type, as a symbol.
3558 OBJECTS is the previous candidates alist."
3560 ;; If no previous result, search every object type in RESTRICTION.
3561 ;; Otherwise, keep potential candidates (old objects located after
3562 ;; point) and ask to search again those which had matched before.
3567 objects))
3568 ;; Call the appropriate successor function for each type to search
3569 ;; and accumulate matches.
3576 type))))
3579 types-to-search)
3580 ;; Return alist.
3581 next-candidates))
3584 \f
3585 ;;; Towards A Bijective Process
3586 ;;
3587 ;; The parse tree obtained with `org-element-parse-buffer' is really
3588 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3589 ;; interpreted and expanded into a string with canonical Org syntax.
3590 ;; Hence `org-element-interpret-data'.
3591 ;;
3592 ;; The function relies internally on
3593 ;; `org-element-interpret--affiliated-keywords'.
3596 "Interpret DATA as Org syntax.
3598 DATA is a parse tree, an element, an object or a secondary string
3599 to interpret.
3601 Optional argument PARENT is used for recursive calls. It contains
3602 the element or object containing data, or nil.
3604 Return Org syntax as a string."
3608 ;; Secondary string.
3613 ;; Full Org document.
3618 ;; Plain text.
3620 ;; Element/Object without contents.
3623 data nil))
3624 ;; Element/Object with contents.
3634 ;; Elements directly containing objects must
3635 ;; have their indentation normalized first.
3637 data
3638 ;; When normalizing first paragraph of an
3639 ;; item or a footnote-definition, ignore
3640 ;; first line's indentation.
3647 data
3649 contents)))))))
3651 ;; Build white spaces. If no `:post-blank' property is
3652 ;; specified, assume its value is 0.
3662 "Return ELEMENT's affiliated keywords as Org syntax.
3663 If there is no affiliated keyword, return the empty string."
3673 ": "
3676 value)
3681 element)))
3688 ;; Remove translated keywords.
3693 org-element-affiliated-keywords))
3696 ;; Because interpretation of the parse tree must return the same
3697 ;; number of blank lines between elements and the same number of white
3698 ;; space after objects, some special care must be given to white
3699 ;; spaces.
3700 ;;
3701 ;; The first function, `org-element-normalize-string', ensures any
3702 ;; string different from the empty string will end with a single
3703 ;; newline character.
3704 ;;
3705 ;; The second function, `org-element-normalize-contents', removes
3706 ;; global indentation from the contents of the current element.
3709 "Ensure string S ends with a single newline character.
3711 If S isn't a string return it unchanged. If S is the empty
3712 string, return it. Otherwise, return a new string with a single
3713 newline character at its end."
3721 "Normalize plain text in ELEMENT's contents.
3723 ELEMENT must only contain plain text and objects.
3725 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3726 indentation to compute maximal common indentation.
3728 Return the normalized element that is element with global
3729 indentation removed from its contents. The function assumes that
3730 indentation is not done with TAB characters."
3732 collect-inds ; for byte-compiler
3735 ;; Return list of indentations within BLOB. This is done by
3736 ;; walking recursively BLOB and updating IND-LIST along the
3737 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3738 ;; been seen yet. It is required as this string is the only
3739 ;; one whose indentation doesn't happen after a newline
3740 ;; character.
3748 ;; An indentation of zero means no string will be
3749 ;; modified. Quit the process.
3755 ;; Avoid matching blank or empty lines.
3763 ;; Collect indentation list in ELEMENT. Possibly remove first
3764 ;; value if IGNORE-FIRST is non-nil.
3767 ;; Build ELEMENT back, replacing each string with the same
3768 ;; string minus common indentation.
3773 ;; Return BLOB with all its strings indentation
3774 ;; shortened from MCI white spaces. FIRST-FLAG is
3775 ;; non-nil when the first string hasn't been seen
3776 ;; yet.
3791 org-element-recursive-objects)
3798 \f
3799 ;;; The Toolbox
3800 ;;
3801 ;; The first move is to implement a way to obtain the smallest element
3802 ;; containing point. This is the job of `org-element-at-point'. It
3803 ;; basically jumps back to the beginning of section containing point
3804 ;; and moves, element after element, with
3805 ;; `org-element-current-element' until the container is found.
3806 ;;
3807 ;; Note: When using `org-element-at-point', secondary values are never
3808 ;; parsed since the function focuses on elements, not on objects.
3811 "Determine closest element around point.
3813 Return value is a list like (TYPE PROPS) where TYPE is the type
3814 of the element and PROPS a plist of properties associated to the
3815 element. Possible types are defined in
3816 `org-element-all-elements'.
3818 As a special case, if point is at the very beginning of a list or
3819 sub-list, returned element will be that list instead of the first
3820 item. In the same way, if point is at the beginning of the first
3821 row of a table, returned element will be the table instead of the
3822 first row.
3824 If optional argument KEEP-TRAIL is non-nil, the function returns
3825 a list of of elements leading to element at point. The list's
3826 CAR is always the element at point. Following positions contain
3827 element's siblings, then parents, siblings of parents, until the
3828 first element of current section."
3830 ;; If at an headline, parse it. It is the sole element that
3831 ;; doesn't require to know about context. Be sure to disallow
3832 ;; secondary string parsing, though.
3838 ;; Otherwise move at the beginning of the section containing
3839 ;; point.
3847 ;; Parse successively each element, skipping those ending
3848 ;; before original position.
3856 ;; 1. Skip any element ending before point or at point.
3861 ;; 2. An element containing point is always the element at
3862 ;; point.
3865 ;; 3. At any other greater element type, if point is
3866 ;; within contents, move into it. Otherwise, return
3867 ;; that element.
3884 ;; Once the local structure around point is well understood, it's easy
3885 ;; to implement some replacements for `forward-paragraph'
3886 ;; `backward-paragraph', namely `org-element-forward' and
3887 ;; `org-element-backward'.
3888 ;;
3889 ;; Also, `org-transpose-elements' mimics the behaviour of
3890 ;; `transpose-words', at the element's level, whereas
3891 ;; `org-element-drag-forward', `org-element-drag-backward', and
3892 ;; `org-element-up' generalize, respectively, functions
3893 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3894 ;;
3895 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3896 ;; smartly remove global indentation from buffer, making it possible
3897 ;; to use Org indent mode on a file created with hard indentation.
3898 ;;
3899 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3900 ;; internally by some of the previously cited tools.
3903 "Non-nil when elements ELEM-A and ELEM-B are nested."
3912 "Swap elements ELEM-A and ELEM-B.
3913 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
3914 end of ELEM-A."
3916 ;; There are two special cases when an element doesn't start at bol:
3917 ;; the first paragraph in an item or in a footnote definition.
3919 ;; Only a paragraph without any affiliated keyword can be moved at
3920 ;; ELEM-A position in such a situation. Note that the case of
3921 ;; a footnote definition is impossible: it cannot contain two
3922 ;; paragraphs in a row because it cannot contain a blank line.
3928 ;; In a special situation, ELEM-A will have no indentation. We'll
3929 ;; give it ELEM-B's (which will in, in turn, have no indentation).
3943 ;; Store overlays responsible for visibility status. We
3944 ;; also need to store their boundaries as they will be
3945 ;; removed from buffer.
3952 ;; Get contents.
3960 ;; Restore ex ELEM-A overlays.
3970 ;; Restore ex ELEM-B overlays.
3979 "Move forward by one element.
3980 Move to the next element at the same level, when possible."
3993 return prev)))
4001 "Move backward by one element.
4002 Move to the previous element at the same level, when possible."
4005 ;; At an headline, move to the previous one, if any, or stay
4006 ;; here.
4017 ;; Move to beginning of current element if point isn't there
4018 ;; already.
4024 "Move to upper element."
4034 return prev)))
4041 "Move to inner element."
4049 ;; If contents are hidden, first disclose them.
4055 "Move backward element at point."
4061 ;; Error out if no previous element or previous element is
4062 ;; a parent of the current one.
4071 "Move forward element at point."
4084 ;; Compute new position of point: it's shifted by NEXT-ELEM
4085 ;; body's length (without final blanks) and by the length of
4086 ;; blanks between ELEM and NEXT-ELEM.
4091 ;; Small correction if buffer doesn't end
4092 ;; with a newline character.
4105 "Put point at beginning of this element, mark at end.
4107 Interactively, if this command is repeated or (in Transient Mark
4108 mode) if the mark is active, it marks the next element after the
4109 ones already marked."
4124 "Narrow buffer to current element."
4142 "Transpose current and previous elements, keeping blank lines between.
4143 Point is moved after both elements."
4151 "Un-indent the visible part of the buffer.
4152 Relative indentation (between items, inside blocks, etc.) isn't
4153 modified."
4158 unindent-tree ; For byte-compiler.
4176 "Fill element at point, when applicable.
4178 This function only applies to paragraph, comment blocks, example
4179 blocks and fixed-width areas. Also, as a special case, re-align
4180 table when point is at one.
4182 If JUSTIFY is non-nil (interactively, with prefix argument),
4183 justify as well. If `sentence-end-double-space' is non-nil, then
4184 period followed by one space does not end a sentence, so don't
4185 break a line there. The variable `fill-column' controls the
4186 width for filling."
4189 ;; Align Org tables, leave table.el tables as-is.
4193 t)
4194 ;; Elements that may contain `line-break' type objects.
4198 ;; Do nothing if point is at an affiliated keyword or at
4199 ;; verse block markers.
4201 ;; At a verse block, first narrow to current "paragraph"
4202 ;; and set current element to that paragraph.
4215 ;; Fill paragraph, taking line breaks into consideration.
4216 ;; For that, slice the paragraph using line breaks as
4217 ;; separators, and fill the parts in reverse order to
4218 ;; avoid messing with markers.
4225 ;; Find the list of ending positions for line breaks
4226 ;; in the current paragraph. Add paragraph beginning
4227 ;; to include first slice.
4232 beg end nil org-element-all-objects)
4233 'line-break
4235 ;; Elements whose contents should be filled as plain text.
4249 ;; Ignore every other element.
4254 ;;; org-element.el ends here