| blob | 84cd42c27a9bcb149d31516b4ec946e311163fea |
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 ;; An object can be defined anywhere on a line. It may span over more
29 ;; than a line but never contains a blank one. Objects belong to the
30 ;; following types: `emphasis', `entity', `export-snippet',
31 ;; `footnote-reference', `inline-babel-call', `inline-src-block',
32 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
33 ;; `statistics-cookie', `subscript', `superscript', `target',
34 ;; `time-stamp' and `verbatim'.
36 ;; An element always starts and ends at the beginning of a line. The
37 ;; only element's type containing objects is called a `paragraph'.
38 ;; Other types are: `comment', `comment-block', `example-block',
39 ;; `export-block', `fixed-width', `horizontal-rule', `keyword',
40 ;; `latex-environment', `babel-call', `property-drawer',
41 ;; `quote-section', `src-block', `table' and `verse-block'.
43 ;; Elements containing paragraphs are called greater elements.
44 ;; Concerned types are: `center-block', `drawer', `dynamic-block',
45 ;; `footnote-definition', `headline', `inlinetask', `item',
46 ;; `plain-list', `quote-block', `section' and `special-block'.
48 ;; Greater elements (excepted `headline', `item' and `section' types)
49 ;; and elements (excepted `keyword', `babel-call', and
50 ;; `property-drawer' types) can have a fixed set of keywords as
51 ;; attributes. Those are called "affiliated keywords", to distinguish
52 ;; them from others keywords, which are full-fledged elements. In
53 ;; particular, the "name" affiliated keyword allows to label almost
54 ;; any element in an Org buffer.
56 ;; Notwithstanding affiliated keywords, each greater element, element
57 ;; and object has a fixed set of properties attached to it. Among
58 ;; them, three are shared by all types: `:begin' and `:end', which
59 ;; refer to the beginning and ending buffer positions of the
60 ;; considered element or object, and `:post-blank', which holds the
61 ;; number of blank lines, or white spaces, at its end.
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (i.e. an item tag, an headline name, a table
65 ;; cell). Such values are called "secondary strings".
67 ;; Lisp-wise, an element or an object can be represented as a list.
68 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
69 ;; TYPE is a symbol describing the Org element or object.
70 ;; PROPERTIES is the property list attached to it. See docstring of
71 ;; appropriate parsing function to get an exhaustive
72 ;; list.
73 ;; CONTENTS is a list of elements, objects or raw strings contained
74 ;; in the current element or object, when applicable.
76 ;; An Org buffer is a nested list of such elements and objects, whose
77 ;; type is `org-data' and properties is nil.
79 ;; The first part of this file implements a parser and an interpreter
80 ;; for each type of Org syntax.
82 ;; The next two parts introduce three accessors and a function
83 ;; retrieving the smallest element starting at point (respectively
84 ;; `org-element-type', `org-element-property', `org-element-contents'
85 ;; and `org-element-current-element').
87 ;; The following part creates a fully recursive buffer parser. It
88 ;; also provides a tool to map a function to elements or objects
89 ;; matching some criteria in the parse tree. Functions of interest
90 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
91 ;; extent, `org-element-parse-secondary-string'.
93 ;; The penultimate part is the cradle of an interpreter for the
94 ;; obtained parse tree: `org-element-interpret-data' (and its
95 ;; relative, `org-element-interpret-secondary').
97 ;; The library ends by furnishing a set of interactive tools for
98 ;; element's navigation and manipulation, mostly based on
99 ;; `org-element-at-point' function.
102 ;;; Code:
108 \f
109 ;;; Greater elements
111 ;; For each greater element type, we define a parser and an
112 ;; interpreter.
114 ;; A parser returns the element or object as the list described above.
115 ;; Most of them accepts no argument. Though, exceptions exist. Hence
116 ;; every element containing a secondary string (see
117 ;; `org-element-secondary-value-alist') will accept an optional
118 ;; argument to toggle parsing of that secondary string. Moreover,
119 ;; `item' parser requires current list's structure as its first
120 ;; element.
122 ;; An interpreter accepts two arguments: the list representation of
123 ;; the element or object, and its contents. The latter may be nil,
124 ;; depending on the element or object considered. It returns the
125 ;; appropriate Org syntax, as a string.
127 ;; Parsing functions must follow the naming convention:
128 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
129 ;; defined in `org-element-greater-elements'.
130 ;;
131 ;; Similarly, interpreting functions must follow the naming
132 ;; convention: org-element-TYPE-interpreter.
134 ;; With the exception of `headline' and `item' types, greater elements
135 ;; cannot contain other greater elements of their own type.
137 ;; Beside implementing a parser and an interpreter, adding a new
138 ;; greater element requires to tweak `org-element-current-element'.
139 ;; Moreover, the newly defined type must be added to both
140 ;; `org-element-all-elements' and `org-element-greater-elements'.
143 ;;;; Center Block
146 "Parse a center block.
148 Return a list whose car is `center-block' and cdr is a plist
149 containing `:begin', `:end', `:hiddenp', `:contents-begin',
150 `:contents-end' and `:post-blank' keywords.
152 Assume point is at beginning or end of the block."
179 "Interpret CENTER-BLOCK element as Org syntax.
180 CONTENTS is the contents of the element."
184 ;;;; Drawer
187 "Parse a drawer.
189 Return a list whose car is `drawer' and cdr is a plist containing
190 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
191 `:contents-end' and `:post-blank' keywords.
193 Assume point is at beginning of drawer."
218 "Interpret DRAWER element as Org syntax.
219 CONTENTS is the contents of the element."
222 contents))
225 ;;;; Dynamic Block
228 "Parse a dynamic block.
230 Return a list whose car is `dynamic-block' and cdr is a plist
231 containing `:block-name', `:begin', `:end', `:hiddenp',
232 `:contents-begin', `:contents-end', `:arguments' and
233 `:post-blank' keywords.
235 Assume point is at beginning of dynamic block."
262 "Interpret DYNAMIC-BLOCK element as Org syntax.
263 CONTENTS is the contents of the element."
268 contents))
271 ;;;; Footnote Definition
274 "Parse a footnote definition.
276 Return a list whose CAR is `footnote-definition' and CDR is
277 a plist containing `:label', `:begin' `:end', `:contents-begin',
278 `:contents-end' and `:post-blank' keywords.
280 Assume point is at the beginning of the footnote definition."
309 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
310 CONTENTS is the contents of the footnote-definition."
312 " "
313 contents))
316 ;;;; Headline
319 "Parse an headline.
321 Return a list whose car is `headline' and cdr is a plist
322 containing `:raw-value', `:title', `:begin', `:end',
323 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
324 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
325 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
326 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
327 keywords.
329 The plist also contains any property set in the property drawer,
330 with its name in lowercase, the underscores replaced with hyphens
331 and colons at the beginning (i.e. `:custom-id').
333 When RAW-SECONDARY-P is non-nil, headline's title will not be
334 parsed as a secondary string, but as a plain string instead.
336 Assume point is at beginning of the headline."
368 plist))
384 title)
385 ;; Clean RAW-VALUE from any quote or comment string.
390 ""
391 raw-value)))
392 ;; Clean TAGS from archive tag, if any.
399 ;; Then get TITLE.
403 raw-value
431 "Interpret HEADLINE element as Org syntax.
432 CONTENTS is the contents of the element."
458 ;; Align tags.
468 tags-len)
472 contents)))
475 ;;;; Inlinetask
478 "Parse an inline task.
480 Return a list whose car is `inlinetask' and cdr is a plist
481 containing `:title', `:begin', `:end', `:hiddenp',
482 `:contents-begin' and `:contents-end', `:level', `:priority',
483 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
484 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
486 The plist also contains any property set in the property drawer,
487 with its name in lowercase, the underscores replaced with hyphens
488 and colons at the beginning (i.e. `:custom-id').
490 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
491 title will not be parsed as a secondary string, but as a plain
492 string instead.
494 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.
549 ,@standard-props
553 "Interpret INLINETASK element as Org syntax.
554 CONTENTS is the contents of inlinetask."
565 ;; Align tags.
580 ;;;; Item
583 "Parse an item.
585 STRUCT is the structure of the plain list.
587 Return a list whose car is `item' and cdr is a plist containing
588 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
589 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
590 `:post-blank' keywords.
592 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
593 any, will not be parsed as a secondary string, but as a plain
594 string instead.
596 Assume point is at the beginning of the item."
618 raw-tag
624 ;; If first line isn't empty,
625 ;; contents really start at the text
626 ;; after item's meta-data.
640 ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
641 ;; up in the case of an empty item separated
642 ;; from the next by a blank line. Thus, ensure
643 ;; the former is always the smallest of two.
654 "Interpret ITEM element as Org syntax.
655 CONTENTS is the contents of the element."
669 num
676 ;; Compute indentation.
678 ;; Indent contents.
680 bullet
691 ;;;; Plain List
694 "Parse a plain list.
696 Optional argument STRUCTURE, when non-nil, is the structure of
697 the plain list being parsed.
699 Return a list whose car is `plain-list' and cdr is a plist
700 containing `:type', `:begin', `:end', `:contents-begin' and
701 `:contents-end', `:level', `:structure' and `:post-blank'
702 keywords.
704 Assume point is at one of the list items."
719 ;; Get list level.
724 struct parents))
726 ;; Blank lines below list belong to the top-level list only.
731 ;; Return value.
744 "Interpret PLAIN-LIST element as Org syntax.
745 CONTENTS is the contents of the element."
746 contents)
749 ;;;; Quote Block
752 "Parse a quote block.
754 Return a list whose car is `quote-block' and cdr is a plist
755 containing `:begin', `:end', `:hiddenp', `:contents-begin',
756 `:contents-end' and `:post-blank' keywords.
758 Assume point is at beginning or end of the block."
785 "Interpret QUOTE-BLOCK element as Org syntax.
786 CONTENTS is the contents of the element."
790 ;;;; Section
793 "Parse a section.
795 Return a list whose car is `section' and cdr is a plist
796 containing `:begin', `:end', `:contents-begin', `contents-end'
797 and `:post-blank' keywords."
799 ;; Beginning of section is the beginning of the first non-blank
800 ;; line after previous headline.
819 "Interpret SECTION element as Org syntax.
820 CONTENTS is the contents of the element."
821 contents)
824 ;;;; Special Block
827 "Parse a special block.
829 Return a list whose car is `special-block' and cdr is a plist
830 containing `:type', `:begin', `:end', `:hiddenp',
831 `:contents-begin', `:contents-end' and `:post-blank' keywords.
833 Assume point is at beginning or end 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 INLINE-BABEL-CALL object as Org syntax.
909 CONTENTS is nil."
915 ;; Remove redundant square brackets.
918 main-source)
922 ;;;; Comment
925 "Parse a comment.
927 Return a list whose car is `comment' and cdr is a plist
928 containing `:begin', `:end', `:value' and `:post-blank'
929 keywords."
933 ;; First type of comment: comments at column 0.
943 ;; Second type of comment: indented comments.
951 ;; Get comments ending. This may not be accurate if
952 ;; commented lines within an item are followed by commented
953 ;; lines outside of the list. Though, parser will always
954 ;; get it right as it already knows surrounding element and
955 ;; has narrowed buffer to its contents.
958 ;; Find position after blank.
970 "Interpret COMMENT element as Org syntax.
971 CONTENTS is nil."
975 ;;;; Comment Block
978 "Parse an export block.
980 Return a list whose car is `comment-block' and cdr is a plist
981 containing `:begin', `:end', `:hiddenp', `:value' and
982 `:post-blank' keywords."
1008 "Interpret COMMENT-BLOCK element as Org syntax.
1009 CONTENTS is nil."
1016 ;;;; Example Block
1019 "Parse an example block.
1021 Return a list whose car is `example-block' and cdr is a plist
1022 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1023 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1024 `:switches', `:value' and `:post-blank' keywords."
1032 ;; Switches analysis
1037 ;; Should labels be retained in (or stripped from) example
1038 ;; blocks?
1043 ;; What should code-references use - labels or
1044 ;; line-numbers?
1051 ;; Standard block parsing.
1078 "Interpret EXAMPLE-BLOCK element as Org syntax.
1079 CONTENTS is nil."
1087 ;;;; Export Block
1090 "Parse an export block.
1092 Return a list whose car is `export-block' and cdr is a plist
1093 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1094 `:post-blank' keywords."
1124 "Interpret EXPORT-BLOCK element as Org syntax.
1125 CONTENTS is nil."
1132 ;;;; Fixed-width
1135 "Parse a fixed-width section.
1137 Return a list whose car is `fixed-width' and cdr is a plist
1138 containing `:begin', `:end', `:value' and `:post-blank'
1139 keywords."
1141 beg-area begin end value pos-before-blank keywords)
1143 ;; Move to the beginning of the fixed-width area.
1149 ;; Get affiliated keywords, if any.
1151 ;; Store true beginning of element.
1153 ;; Get ending of fixed-width area. If point is in a list,
1154 ;; ensure to not get outside of it.
1163 ;; Find position after blank
1166 ;; Extract value.
1176 "Interpret FIXED-WIDTH element as Org syntax.
1177 CONTENTS is nil."
1181 ;;;; Horizontal Rule
1184 "Parse an horizontal rule.
1186 Return a list whose car is `horizontal-rule' and cdr is
1187 a plist containing `:begin', `:end' and `:post-blank'
1188 keywords."
1202 "Interpret HORIZONTAL-RULE element as Org syntax.
1203 CONTENTS is nil."
1207 ;;;; Keyword
1210 "Parse a keyword at point.
1212 Return a list whose car is `keyword' and cdr is a plist
1213 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1214 keywords."
1233 "Interpret KEYWORD element as Org syntax.
1234 CONTENTS is nil."
1240 ;;;; Latex Environment
1243 "Parse a LaTeX environment.
1245 Return a list whose car is `latex-environment' and cdr is a plist
1246 containing `:begin', `:end', `:value' and `:post-blank' keywords."
1267 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1268 CONTENTS is nil."
1272 ;;;; Paragraph
1275 "Parse a paragraph.
1277 Return a list whose car is `paragraph' and cdr is a plist
1278 containing `:begin', `:end', `:contents-begin' and
1279 `:contents-end' and `:post-blank' keywords.
1281 Assume point is at the beginning of the paragraph."
1304 "Interpret PARAGRAPH element as Org syntax.
1305 CONTENTS is the contents of the element."
1306 contents)
1309 ;;;; Property Drawer
1312 "Parse a property drawer.
1314 Return a list whose car is `property-drawer' and cdr is a plist
1315 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1316 `:contents-end', `:properties' and `:post-blank' keywords."
1333 val))
1335 val))
1349 "Interpret PROPERTY-DRAWER element as Org syntax.
1350 CONTENTS is nil."
1360 ;;;; Quote Section
1363 "Parse a quote section.
1365 Return a list whose car is `quote-section' and cdr is a plist
1366 containing `:begin', `:end', `:value' and `:post-blank'
1367 keywords.
1369 Assume point is at beginning of the section."
1385 "Interpret QUOTE-SECTION element as Org syntax.
1386 CONTENTS is nil."
1390 ;;;; Src Block
1393 "Parse a src block.
1395 Return a list whose car is `src-block' and cdr is a plist
1396 containing `:language', `:switches', `:parameters', `:begin',
1397 `:end', `:hiddenp', `:contents-begin', `:contents-end',
1398 `:number-lines', `:retain-labels', `:use-labels', `:label-fmt',
1399 `:preserve-indent', `:value' and `:post-blank' keywords."
1403 ;; Get position at beginning of block.
1411 nil t))
1412 ;; Get language as a string.
1414 ;; Get parameters.
1416 ;; Get switches.
1418 ;; Switches analysis
1426 ;; Should labels be retained in (or stripped from) src
1427 ;; blocks?
1432 ;; What should code-references use - labels or
1433 ;; line-numbers?
1437 ;; Get affiliated keywords.
1439 ;; Get beginning position.
1441 ;; Get position at end of block.
1445 ;; Retrieve code.
1451 ;; Get position after ending blank lines.
1454 ;; Get visibility status.
1475 "Interpret SRC-BLOCK element as Org syntax.
1476 CONTENTS is nil."
1495 value
1499 ;;;; Table
1502 "Parse a table at point.
1504 Return a list whose car is `table' and cdr is a plist containing
1505 `:begin', `:end', `:contents-begin', `:contents-end', `:tblfm',
1506 `:type', `:raw-table' and `:post-blank' keywords."
1531 "Interpret TABLE element as Org syntax.
1532 CONTENTS is nil."
1536 ;;;; Verse Block
1539 "Parse a verse block.
1541 Return a list whose car is `verse-block' and cdr is a plist
1542 containing `:begin', `:end', `:hiddenp', `:value' and
1543 `:post-blank' keywords.
1545 When optional argument RAW-SECONDARY-P is non-nil, verse-block's
1546 value will not be parsed as a secondary string, but as a plain
1547 string instead.
1549 Assume point is at beginning or end of the block."
1582 "Interpret VERSE-BLOCK element as Org syntax.
1583 CONTENTS is nil."
1590 \f
1591 ;;; Objects
1593 ;; Unlike to elements, interstices can be found between objects.
1594 ;; That's why, along with the parser, successor functions are provided
1595 ;; for each object. Some objects share the same successor
1596 ;; (i.e. `emphasis' and `verbatim' objects).
1598 ;; A successor must accept a single argument bounding the search. It
1599 ;; will return either a cons cell whose car is the object's type, as
1600 ;; a symbol, and cdr the position of its next occurrence, or nil.
1602 ;; Successors follow the naming convention:
1603 ;; org-element-NAME-successor, where NAME is the name of the
1604 ;; successor, as defined in `org-element-all-successors'.
1606 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1607 ;; object types they can contain will be specified in
1608 ;; `org-element-object-restrictions'.
1610 ;; Adding a new type of object is simple. Implement a successor,
1611 ;; a parser, and an interpreter for it, all following the naming
1612 ;; convention. Register type in `org-element-all-objects' and
1613 ;; successor in `org-element-all-successors'. Maybe tweak
1614 ;; restrictions about it, and that's it.
1616 ;;;; Emphasis
1619 "Parse text markup object at point.
1621 Return a list whose car is `emphasis' and cdr is a plist with
1622 `:marker', `:begin', `:end', `:contents-begin' and
1623 `:contents-end' and `:post-blank' keywords.
1625 Assume point is at the first emphasis marker."
1645 "Interpret EMPHASIS object as Org syntax.
1646 CONTENTS is the contents of the object."
1651 "Search for the next emphasis or verbatim object.
1653 LIMIT bounds the search.
1655 Return value is a cons cell whose car is `emphasis' or
1656 `verbatim' and cdr is beginning position."
1661 'verbatim
1665 ;;;; Entity
1668 "Parse entity at point.
1670 Return a list whose car is `entity' and cdr a plist with
1671 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1672 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1673 keywords.
1675 Assume point is at the beginning of the entity."
1699 "Interpret ENTITY object as Org syntax.
1700 CONTENTS is nil."
1706 "Search for the next latex-fragment or entity object.
1708 LIMIT bounds the search.
1710 Return value is a cons cell whose car is `entity' or
1711 `latex-fragment' and cdr is beginning position."
1714 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1721 limit t)
1724 ;; Determine if it's a real entity or a LaTeX command.
1727 ;; No entity nor command: point is at a LaTeX fragment.
1728 ;; Determine its type to get the correct beginning position.
1736 matchers)
1740 ;;;; Export Snippet
1743 "Parse export snippet at point.
1745 Return a list whose car is `export-snippet' and cdr a plist with
1746 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1747 keywords.
1749 Assume point is at the beginning of the snippet."
1767 "Interpret EXPORT-SNIPPET object as Org syntax.
1768 CONTENTS is nil."
1774 "Search for the next export-snippet object.
1776 LIMIT bounds the search.
1778 Return value is a cons cell whose car is `export-snippet' cdr is
1779 its beginning position."
1788 ;;;; Footnote Reference
1791 "Parse footnote reference at point.
1793 Return a list whose CAR is `footnote-reference' and CDR a plist
1794 with `:label', `:type', `:inline-definition', `:begin', `:end'
1795 and `:post-blank' as keywords."
1819 org-element-string-restrictions))))))
1829 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1830 CONTENTS is nil."
1840 "Search for the next footnote-reference object.
1842 LIMIT bounds the search.
1844 Return value is a cons cell whose CAR is `footnote-reference' and
1845 CDR is beginning position."
1859 ;;;; Inline Babel Call
1862 "Parse inline babel call at point.
1864 Return a list whose car is `inline-babel-call' and cdr a plist with
1865 `:begin', `:end', `:info' and `:post-blank' as keywords.
1867 Assume point is at the beginning of the babel call."
1883 "Interpret INLINE-BABEL-CALL object as Org syntax.
1884 CONTENTS is nil."
1890 ;; Remove redundant square brackets.
1893 main-source)
1897 "Search for the next inline-babel-call object.
1899 LIMIT bounds the search.
1901 Return value is a cons cell whose car is `inline-babel-call' and
1902 cdr is beginning position."
1904 ;; Use a simplified version of
1905 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
1907 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
1908 limit t)
1912 ;;;; Inline Src Block
1915 "Parse inline source block at point.
1917 Return a list whose car is `inline-src-block' and cdr a plist
1918 with `:begin', `:end', `:language', `:value', `:parameters' and
1919 `:post-blank' as keywords.
1921 Assume point is at the beginning of the inline src block."
1941 "Interpret INLINE-SRC-BLOCK object as Org syntax.
1942 CONTENTS is nil."
1947 language
1949 body)))
1952 "Search for the next inline-babel-call element.
1954 LIMIT bounds the search.
1956 Return value is a cons cell whose car is `inline-babel-call' and
1957 cdr is beginning position."
1963 ;;;; Latex Fragment
1966 "Parse latex fragment at point.
1968 Return a list whose car is `latex-fragment' and cdr a plist with
1969 `:value', `:begin', `:end', and `:post-blank' as keywords.
1971 Assume point is at the beginning of the latex fragment."
1985 ;; None found: it's a macro.
1999 "Interpret LATEX-FRAGMENT object as Org syntax.
2000 CONTENTS is nil."
2003 ;;;; Line Break
2006 "Parse line break at point.
2008 Return a list whose car is `line-break', and cdr a plist with
2009 `:begin', `:end' and `:post-blank' keywords.
2011 Assume point is at the beginning of the line break."
2017 "Interpret LINE-BREAK object as Org syntax.
2018 CONTENTS is nil."
2022 "Search for the next line-break object.
2024 LIMIT bounds the search.
2026 Return value is a cons cell whose car is `line-break' and cdr is
2027 beginning position."
2031 ;; A line break can only happen on a non-empty line.
2036 ;;;; Link
2039 "Parse link at point.
2041 Return a list whose car is `link' and cdr a plist with `:type',
2042 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2043 `:contents-end' and `:post-blank' as keywords.
2045 Assume point is at the beginning of the link."
2048 end contents-begin contents-end link-end post-blank path type
2049 raw-link link)
2051 ;; Type 1: Text targeted from a radio target.
2056 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2061 ;; RAW-LINK is the original link.
2066 ;; Determine TYPE of link and set PATH accordingly.
2068 ;; File type.
2071 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2074 ;; Id type: PATH is the id.
2077 ;; Code-ref type: PATH is the name of the reference.
2080 ;; Custom-id type: PATH is the name of the custom id.
2083 ;; Fuzzy type: Internal link either matches a target, an
2084 ;; headline name or nothing. PATH is the target or headline's
2085 ;; name.
2087 ;; Type 3: Plain link, i.e. http://orgmode.org
2093 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2100 ;; In any case, deduce end point after trailing white space from
2101 ;; LINK-END variable.
2115 "Interpret LINK object as Org syntax.
2116 CONTENTS is the contents of the object."
2121 raw-link
2125 "Search for the next link object.
2127 LIMIT bounds the search.
2129 Return value is a cons cell whose car is `link' and cdr is
2130 beginning position."
2139 ;;;; Macro
2142 "Parse macro at point.
2144 Return a list whose car is `macro' and cdr a plist with `:key',
2145 `:args', `:begin', `:end', `:value' and `:post-blank' as
2146 keywords.
2148 Assume point is at the macro."
2162 ;; Repair bad splits.
2177 "Interpret MACRO object as Org syntax.
2178 CONTENTS is nil."
2182 "Search for the next macro object.
2184 LIMIT bounds the search.
2186 Return value is cons cell whose car is `macro' and cdr is
2187 beginning position."
2191 limit t)
2195 ;;;; Radio-target
2198 "Parse radio target at point.
2200 Return a list whose car is `radio-target' and cdr a plist with
2201 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2202 and `:post-blank' as keywords.
2204 Assume point is at the radio target."
2223 "Interpret TARGET object as Org syntax.
2224 CONTENTS is the contents of the object."
2228 "Search for the next radio-target object.
2230 LIMIT bounds the search.
2232 Return value is a cons cell whose car is `radio-target' and cdr
2233 is beginning position."
2239 ;;;; Statistics Cookie
2242 "Parse statistics cookie at point.
2244 Return a list whose car is `statistics-cookie', and cdr a plist
2245 with `:begin', `:end', `:value' and `:post-blank' keywords.
2247 Assume point is at the beginning of the statistics-cookie."
2263 "Interpret STATISTICS-COOKIE object as Org syntax.
2264 CONTENTS is nil."
2268 "Search for the next statistics cookie object.
2270 LIMIT bounds the search.
2272 Return value is a cons cell whose car is `statistics-cookie' and
2273 cdr is beginning position."
2279 ;;;; Subscript
2282 "Parse subscript at point.
2284 Return a list whose car is `subscript' and cdr a plist with
2285 `:begin', `:end', `:contents-begin', `:contents-end',
2286 `:use-brackets-p' and `:post-blank' as keywords.
2288 Assume point is at the underscore."
2292 t
2310 "Interpret SUBSCRIPT object as Org syntax.
2311 CONTENTS is the contents of the object."
2314 contents))
2317 "Search for the next sub/superscript object.
2319 LIMIT bounds the search.
2321 Return value is a cons cell whose car is either `subscript' or
2322 `superscript' and cdr is beginning position."
2329 ;;;; Superscript
2332 "Parse superscript at point.
2334 Return a list whose car is `superscript' and cdr a plist with
2335 `:begin', `:end', `:contents-begin', `:contents-end',
2336 `:use-brackets-p' and `:post-blank' as keywords.
2338 Assume point is at the caret."
2342 t
2360 "Interpret SUPERSCRIPT object as Org syntax.
2361 CONTENTS is the contents of the object."
2364 contents))
2367 ;;;; Target
2370 "Parse target at point.
2372 Return a list whose CAR is `target' and CDR a plist with
2373 `:begin', `:end', `value' and `:post-blank' as keywords.
2375 Assume point is at the target."
2390 "Interpret TARGET object as Org syntax.
2391 CONTENTS is nil."
2395 "Search for the next target object.
2397 LIMIT bounds the search.
2399 Return value is a cons cell whose car is `target' and cdr is
2400 beginning position."
2406 ;;;; Time-stamp
2409 "Parse time stamp at point.
2411 Return a list whose car is `time-stamp', and cdr a plist with
2412 `:appt-type', `:type', `:begin', `:end', `:value' and
2413 `:post-blank' keywords.
2415 Assume point is at the beginning of the time-stamp."
2453 "Interpret TIME-STAMP object as Org syntax.
2454 CONTENTS is nil."
2463 "Search for the next time-stamp object.
2465 LIMIT bounds the search.
2467 Return value is a cons cell whose car is `time-stamp' and cdr is
2468 beginning position."
2473 org-ts-regexp-both
2478 limit t)
2482 ;;;; Verbatim
2485 "Parse verbatim object at point.
2487 Return a list whose car is `verbatim' and cdr is a plist with
2488 `:marker', `:begin', `:end' and `:post-blank' keywords.
2490 Assume point is at the first verbatim marker."
2508 "Interpret VERBATIM object as Org syntax.
2509 CONTENTS is nil."
2515 \f
2516 ;;; Definitions And Rules
2518 ;; Define elements, greater elements and specify recursive objects,
2519 ;; along with the affiliated keywords recognized. Also set up
2520 ;; restrictions on recursive objects combinations.
2522 ;; These variables really act as a control center for the parsing
2523 ;; process.
2526 ;; Headlines and inlinetasks.
2528 ;; Comments, blocks (any type), keywords and babel calls.
2530 ;; Lists.
2532 ;; Fixed-width, drawers (any type) and tables.
2534 ;; Footnote definitions.
2536 ;; Horizontal rules.
2538 ;; LaTeX environments.
2544 export-block fixed-width footnote-definition headline
2545 horizontal-rule inlinetask item keyword latex-environment
2546 babel-call paragraph plain-list property-drawer quote-block
2547 quote-section section special-block src-block table
2548 verse-block)
2553 item plain-list quote-block section special-block)
2558 latex-or-entity line-break link macro radio-target
2559 statistics-cookie sub/superscript target text-markup
2560 time-stamp)
2567 "Alist of translations between object type and successor name.
2569 Sharing the same successor comes handy when, for example, the
2574 inline-src-block line-break latex-fragment link macro radio-target
2575 statistics-cookie subscript superscript target time-stamp
2576 verbatim)
2605 "Alist of usual translations for keywords.
2606 The key is the old name and the value the new one. The property
2611 "List of affiliated keywords that can occur more that once in an element.
2613 Their value will be consed into a list of strings, which will be
2614 returned as the value of the property.
2616 This list is checked after translations have been applied. See
2620 "List of keywords whose value can be parsed.
2622 Their value will be stored as a secondary string: a list of
2623 strings and objects.
2625 This list is checked after translations have been applied. See
2629 "List of keywords which can have a secondary value.
2631 In Org syntax, they can be written with optional square brackets
2632 before the colons. For example, results keyword can be
2633 associated to a hash value with the following:
2635 #+RESULTS[hash-string]: some-source
2637 This list is checked after translations have been applied. See
2651 "Alist of recursive objects restrictions.
2653 CAR is a recursive object type and CDR is a list of successors
2654 that will be called within an object of such type.
2656 For example, in a `radio-target' object, one can only find
2657 entities, export snippets, latex-fragments, subscript and
2662 inline-babel-call inline-src-block latex-fragment
2663 line-break link macro radio-target sub/superscript
2664 target text-markup time-stamp)
2666 macro radio-target statistics-cookie sub/superscript text-markup
2667 time-stamp)
2675 latex-fragment line-break link macro radio-target
2677 "Alist of secondary strings restrictions.
2679 When parsed, some elements have a secondary string which could
2680 contain various objects (i.e. headline's name, or table's cells).
2681 For association, CAR is the element type, and CDR a list of
2682 successors that will be called in that secondary string.
2684 Note: `keyword' secondary string type only applies to keywords
2696 \f
2697 ;;; Accessors
2698 ;;
2699 ;; Provide three accessors: `org-element-type', `org-element-property'
2700 ;; and `org-element-contents'.
2703 "Return type of element ELEMENT.
2705 The function returns the type of the element or object provided.
2706 It can also return the following special value:
2707 `plain-text' for a string
2708 `org-data' for a complete document
2709 nil in any other case."
2715 "Extract the value from the PROPERTY of an ELEMENT."
2719 "Extract contents from an ELEMENT."
2723 \f
2724 ;;; Parsing Element Starting At Point
2726 ;; `org-element-current-element' is the core function of this section.
2727 ;; It returns the Lisp representation of the element starting at
2728 ;; point. It uses `org-element--element-block-re' for quick access to
2729 ;; a common regexp.
2734 'regexp-quote
2736 "Regexp matching the beginning of a non-recursive block type.
2737 Used internally by `org-element-current-element'. Do not modify
2741 "Parse the element starting at point.
2743 Return value is a list like (TYPE PROPS) where TYPE is the type
2744 of the element and PROPS a plist of properties associated to the
2745 element.
2747 Possible types are defined in `org-element-all-elements'.
2749 Optional argument GRANULARITY determines the depth of the
2750 recursion. Allowed values are `headline', `greater-element',
2751 `element', `object' or nil. When it is bigger than `object' (or
2752 nil), secondary values will not be parsed, since they only
2753 contain objects.
2755 Optional argument SPECIAL, when non-nil, can be either `item',
2756 `section' or `quote-section'. `item' allows to parse item wise
2757 instead of plain-list wise, using STRUCTURE as the current list
2758 structure. `section' (resp. `quote-section') will try to parse
2759 a section (resp. a quote section) before anything else.
2761 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
2762 be computed.
2764 Unlike to `org-element-at-point', this function assumes point is
2765 always at the beginning of the element it has to parse. As such,
2766 it is quicker than its counterpart, albeit more restrictive."
2769 ;; If point is at an affiliated keyword, try moving to the
2770 ;; beginning of the associated element. If none is found, the
2771 ;; keyword is orphaned and will be treated as plain text.
2777 ;; Determine if parsing depth allows for secondary strings
2778 ;; parsing. It only applies to elements referenced in
2779 ;; `org-element-secondary-value-alist'.
2782 ;; Headline.
2785 ;; Quote section.
2787 ;; Section.
2789 ;; Non-recursive block.
2795 ;; Build appropriate parser. `verse-block' type
2796 ;; elements require an additional argument, so they
2797 ;; must be treated separately.
2803 "org-element-%s-parser"
2805 org-element-non-recursive-block-alist))))))
2807 ;; Inlinetask.
2809 ;; LaTeX Environment or paragraph if incomplete.
2815 ;; Property drawer.
2820 ;; Recursive block, or paragraph if incomplete.
2831 ;; Drawer.
2837 ;; Babel call.
2840 ;; Keyword, or paragraph if at an affiliated keyword.
2847 ;; Footnote definition.
2850 ;; Dynamic block or paragraph if incomplete.
2856 ;; Comment.
2859 ;; Horizontal rule.
2862 ;; Table.
2864 ;; List or item.
2869 raw-secondary-p)
2871 ;; Default element: Paragraph.
2875 ;; Most elements can have affiliated keywords. When looking for an
2876 ;; element beginning, we want to move before them, as they belong to
2877 ;; that element, and, in the meantime, collect information they give
2878 ;; into appropriate properties. Hence the following function.
2880 ;; Usage of optional arguments may not be obvious at first glance:
2882 ;; - TRANS-LIST is used to polish keywords names that have evolved
2883 ;; during Org history. In example, even though =result= and
2884 ;; =results= coexist, we want to have them under the same =result=
2885 ;; property. It's also true for "srcname" and "name", where the
2886 ;; latter seems to be preferred nowadays (thus the "name" property).
2888 ;; - CONSED allows to regroup multi-lines keywords under the same
2889 ;; property, while preserving their own identity. This is mostly
2890 ;; used for "attr_latex" and al.
2892 ;; - PARSED prepares a keyword value for export. This is useful for
2893 ;; "caption". Objects restrictions for such keywords are defined in
2894 ;; `org-element-string-restrictions'.
2896 ;; - DUALS is used to take care of keywords accepting a main and an
2897 ;; optional secondary values. For example "results" has its
2898 ;; source's name as the main value, and may have an hash string in
2899 ;; optional square brackets as the secondary one.
2901 ;; A keyword may belong to more than one category.
2912 "Regexp matching any affiliated keyword.
2914 Keyword name is put in match group 1. Moreover, if keyword
2915 belongs to `org-element-dual-keywords', put the dual value in
2916 match group 2.
2921 consed parsed duals)
2922 "Collect affiliated keywords before point.
2924 Optional argument KEY-RE is a regexp matching keywords, which
2925 puts matched keyword in group 1. It defaults to
2926 `org-element--affiliated-re'.
2928 TRANS-LIST is an alist where key is the keyword and value the
2929 property name it should be translated to, without the colons. It
2930 defaults to `org-element-keyword-translation-alist'.
2932 CONSED is a list of strings. Any keyword belonging to that list
2933 will have its value consed. The check is done after keyword
2934 translation. It defaults to `org-element-multiple-keywords'.
2936 PARSED is a list of strings. Any keyword member of this list
2937 will have its value parsed. The check is done after keyword
2938 translation. If a keyword is a member of both CONSED and PARSED,
2939 it's value will be a list of parsed strings. It defaults to
2940 `org-element-parsed-keywords'.
2942 DUALS is a list of strings. Any keyword member of this list can
2943 have two parts: one mandatory and one optional. Its value is
2944 a cons cell whose car is the former, and the cdr the latter. If
2945 a keyword is a member of both PARSED and DUALS, both values will
2946 be parsed. It defaults to `org-element-dual-keywords'.
2948 Return a list whose car is the position at the first of them and
2949 cdr a plist of keywords and values."
2957 ;; RESTRICT is the list of objects allowed in parsed
2958 ;; keywords value.
2960 output)
2965 ;; Apply translation to RAW-KWD. From there, KWD is
2966 ;; the official keyword.
2968 ;; Find main value for any keyword.
2974 ;; If KWD is a dual keyword, find its secondary
2975 ;; value. Maybe parse it.
2981 ;; Attribute a property name to KWD.
2983 ;; Now set final shape for VALUE.
2987 ;; VALUE is mandatory. Set it to nil if there is none.
2991 ;; Eventually store the new value in OUTPUT.
2997 \f
2998 ;;; The Org Parser
3000 ;; The two major functions here are `org-element-parse-buffer', which
3001 ;; parses Org syntax inside the current buffer, taking into account
3002 ;; region, narrowing, or even visibility if specified, and
3003 ;; `org-element-parse-secondary-string', which parses objects within
3004 ;; a given string.
3006 ;; The (almost) almighty `org-element-map' allows to apply a function
3007 ;; on elements or objects matching some type, and accumulate the
3008 ;; resulting values. In an export situation, it also skips unneeded
3009 ;; parts of the parse tree.
3012 "Recursively parse the buffer and return structure.
3013 If narrowing is in effect, only parse the visible part of the
3014 buffer.
3016 Optional argument GRANULARITY determines the depth of the
3017 recursion. It can be set to the following symbols:
3019 `headline' Only parse headlines.
3020 `greater-element' Don't recurse into greater elements excepted
3021 headlines and sections. Thus, elements
3022 parsed are the top-level ones.
3023 `element' Parse everything but objects and plain text.
3024 `object' Parse the complete buffer (default).
3026 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3027 elements.
3029 Assume buffer is in Org mode."
3036 ;; Start is section mode so text before the first headline
3037 ;; belongs to a section.
3041 "Recursively parse objects in STRING and return structure.
3043 RESTRICTION, when non-nil, is a symbol limiting the object types
3044 that will be looked after."
3050 "Map a function on selected elements or objects.
3052 DATA is the parsed tree, as returned by, i.e,
3053 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3054 of elements or objects types. FUN is the function called on the
3055 matching element or object. It must accept one arguments: the
3056 element or object itself.
3058 When optional argument INFO is non-nil, it should be a plist
3059 holding export options. In that case, parts of the parse tree
3060 not exportable according to that property list will be skipped.
3062 When optional argument FIRST-MATCH is non-nil, stop at the first
3063 match for which FUN doesn't return nil, and return that value.
3065 Optional argument NO-RECURSION is a symbol or a list of symbols
3066 representing elements or objects types. `org-element-map' won't
3067 enter any recursive element or object whose type belongs to that
3068 list. Though, FUN can still be applied on them.
3070 Nil values returned from FUN do not appear in the results."
3071 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3074 ;; Recursion depth is determined by --CATEGORY.
3084 ;; --RESTRICTS is a list of element types whose secondary
3085 ;; string could possibly contain an object with a type among
3086 ;; TYPES.
3090 when
3092 thereis
3095 org-element-string-restrictions))))
3097 --acc
3101 ;; Recursively walk DATA. INFO, if non-nil, is
3102 ;; a plist holding contextual information.
3107 ;; Check if TYPE is matching among TYPES. If so,
3108 ;; apply FUN to --BLOB and accumulate return value
3109 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3115 ;; If --BLOB has a secondary string that can
3116 ;; contain objects with their type among TYPES,
3117 ;; look into that string.
3120 --walk-tree
3122 nil
3125 --blob))))
3126 ;; Now determine if a recursion into --BLOB is
3127 ;; possible. If so, do it.
3138 ;; Return value in a proper order.
3141 ;; The following functions are internal parts of the parser.
3143 ;; The first one, `org-element-parse-elements' acts at the element's
3144 ;; level.
3146 ;; The second one, `org-element-parse-objects' applies on all objects
3147 ;; of a paragraph or a secondary string. It uses
3148 ;; `org-element-get-candidates' to optimize the search of the next
3149 ;; object in the buffer.
3151 ;; More precisely, that function looks for every allowed object type
3152 ;; first. Then, it discards failed searches, keeps further matches,
3153 ;; and searches again types matched behind point, for subsequent
3154 ;; calls. Thus, searching for a given type fails only once, and every
3155 ;; object is searched only once at top level (but sometimes more for
3156 ;; nested types).
3160 "Parse elements between BEG and END positions.
3162 SPECIAL prioritize some elements over the others. It can set to
3163 `quote-section', `section' or `item', which will focus search,
3164 respectively, on quote sections, sections and items. Moreover,
3165 when value is `item', STRUCTURE will be used as the current list
3166 structure.
3168 GRANULARITY determines the depth of the recursion. See
3169 `org-element-parse-buffer' for more information.
3171 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3172 elements.
3174 Elements are accumulated into ACC."
3179 ;; When parsing only headlines, skip any text before first one.
3182 ;; Main loop start.
3185 ;; 1. Item mode is active: point must be at an item. Parse it
3186 ;; directly, skipping `org-element-current-element'.
3190 structure
3197 ;; 2. When ITEM is nil, find current element's type and parse
3198 ;; it accordingly to its category.
3200 granularity special structure))
3204 ;; Case 1. ELEMENT is a paragraph. Parse objects inside,
3205 ;; if GRANULARITY allows it.
3212 ;; Case 2. ELEMENT is recursive: parse it between
3213 ;; `contents-begin' and `contents-end'. Make sure
3214 ;; GRANULARITY allows the recursion, or ELEMENT is an
3215 ;; headline, in which case going inside is mandatory, in
3216 ;; order to get sub-level headings. If VISIBLE-ONLY is
3217 ;; true and element is hidden, do not recurse into it.
3228 ;; At a plain list, switch to item mode. At an
3229 ;; headline, switch to section mode. Any other
3230 ;; element turns off special modes.
3234 'quote-section
3238 ;; Case 3. Else, just accumulate ELEMENT.
3240 acc)))
3241 ;; Return result.
3245 "Parse objects between BEG and END and return recursive structure.
3247 Objects are accumulated in ACC.
3249 RESTRICTION, when non-nil, is a list of object types which are
3250 allowed in the current object."
3254 ;; Return the parsing function associated to the nearest
3255 ;; object among list of candidates CAND.
3262 next-object candidates)
3266 end restriction candidates))
3268 ;; 1. Text before any object. Untabify it.
3274 acc)))
3275 ;; 2. Object...
3279 cont-beg)
3280 ;; ... recursive. The CONT-BEG check is for
3281 ;; links, as some of them might not be recursive
3282 ;; (i.e. plain links).
3285 cont-beg
3289 ;; Restrict allowed objects. This is the
3290 ;; intersection of current restriction and next
3291 ;; object's restriction.
3294 org-element-object-restrictions))))
3298 new-restr))))))
3299 ;; ... not recursive.
3300 next-object)
3301 acc)
3303 ;; 3. Text after last object. Untabify it.
3308 acc))
3309 ;; Result.
3313 "Return an alist of candidates for the next object.
3315 LIMIT bounds the search, and RESTRICTION, when non-nil, bounds
3316 the possible object types.
3318 Return value is an alist whose car is position and cdr the object
3319 type, as a string. There is an association for the closest
3320 object of each type within RESTRICTION when non-nil, or for every
3321 type otherwise.
3323 OBJECTS is the previous candidates alist."
3325 next-candidates types-to-search)
3326 ;; If no previous result, search every object type in RESTRICTION.
3327 ;; Otherwise, keep potential candidates (old objects located after
3328 ;; point) and ask to search again those which had matched before.
3333 objects))
3334 ;; Call the appropriate "get-next" function for each type to
3335 ;; search and accumulate matches.
3342 type))))
3345 types-to-search)
3346 ;; Return alist.
3347 next-candidates))
3350 \f
3351 ;;; Towards A Bijective Process
3353 ;; The parse tree obtained with `org-element-parse-buffer' is really
3354 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3355 ;; interpreted and expanded into a string with canonical Org
3356 ;; syntax. Hence `org-element-interpret-data'.
3357 ;;
3358 ;; Data parsed from secondary strings, whose shape is slightly
3359 ;; different than the standard parse tree, is expanded with the
3360 ;; equivalent function `org-element-interpret-secondary'.
3361 ;;
3362 ;; Both functions rely internally on
3363 ;; `org-element-interpret--affiliated-keywords'.
3366 "Interpret a parse tree representing Org data.
3368 DATA is the parse tree to interpret.
3370 Optional arguments GENEALOGY and PREVIOUS are used for recursive
3371 calls:
3372 GENEALOGY is the list of its parents types.
3373 PREVIOUS is the type of the element or object at the same level
3374 interpreted before.
3376 Return Org syntax as a string."
3379 ;; BLOB can be an element, an object, a string, or nil.
3391 ;; Full Org document.
3394 ;; Recursive objects.
3398 ;; Recursive elements.
3403 ;; Paragraphs.
3407 blob
3408 ;; When normalizing contents of an item,
3409 ;; ignore first line's indentation.
3416 ;; Update PREVIOUS.
3418 ;; Build white spaces. If no `:post-blank' property is
3419 ;; specified, assume its value is 0.
3432 "Interpret SECONDARY string as Org syntax.
3434 SECONDARY-STRING is a nested list as returned by
3435 `org-element-parse-secondary-string'.
3437 Return interpreted string."
3438 ;; Make SECONDARY acceptable for `org-element-interpret-data'.
3442 ;; Both functions internally use `org-element--affiliated-keywords'.
3445 "Return ELEMENT's affiliated keywords as Org syntax.
3446 If there is no affiliated keyword, return the empty string."
3457 ": "
3460 value)
3465 element)))
3472 ;; Remove translated keywords.
3477 org-element-affiliated-keywords))
3480 ;; Because interpretation of the parse tree must return the same
3481 ;; number of blank lines between elements and the same number of white
3482 ;; space after objects, some special care must be given to white
3483 ;; spaces.
3484 ;;
3485 ;; The first function, `org-element-normalize-string', ensures any
3486 ;; string different from the empty string will end with a single
3487 ;; newline character.
3488 ;;
3489 ;; The second function, `org-element-normalize-contents', removes
3490 ;; global indentation from the contents of the current element.
3493 "Ensure string S ends with a single newline character.
3495 If S isn't a string return it unchanged. If S is the empty
3496 string, return it. Otherwise, return a new string with a single
3497 newline character at its end."
3505 "Normalize plain text in ELEMENT's contents.
3507 ELEMENT must only contain plain text and objects.
3509 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3510 indentation to compute maximal common indentation.
3512 Return the normalized element that is element with global
3513 indentation removed from its contents. The function assumes that
3514 indentation is not done with TAB characters."
3518 ;; Return list of indentations within BLOB. This is done by
3519 ;; walking recursively BLOB and updating IND-LIST along the
3520 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3521 ;; been seen yet. It is required as this string is the only
3522 ;; one whose indentation doesn't happen after a newline
3523 ;; character.
3531 ;; An indentation of zero means no string will be
3532 ;; modified. Quit the process.
3544 ;; Collect indentation list in ELEMENT. Possibly remove first
3545 ;; value if IGNORE-FIRST is non-nil.
3548 ;; Build ELEMENT back, replacing each string with the same
3549 ;; string minus common indentation.
3553 ;; Return BLOB with all its strings indentation
3554 ;; shortened from MCI white spaces. FIRST-FLAG is
3555 ;; non-nil when the first string hasn't been seen
3556 ;; yet.
3577 \f
3578 ;;; The Toolbox
3580 ;; The first move is to implement a way to obtain the smallest element
3581 ;; containing point. This is the job of `org-element-at-point'. It
3582 ;; basically jumps back to the beginning of section containing point
3583 ;; and moves, element after element, with
3584 ;; `org-element-current-element' until the container is found.
3585 ;;
3586 ;; Note: When using `org-element-at-point', secondary values are never
3587 ;; parsed since the function focuses on elements, not on objects.
3590 "Determine closest element around point.
3592 Return value is a list like (TYPE PROPS) where TYPE is the type
3593 of the element and PROPS a plist of properties associated to the
3594 element. Possible types are defined in
3595 `org-element-all-elements'.
3597 As a special case, if point is at the very beginning of a list or
3598 sub-list, element returned will be that list instead of the first
3599 item.
3601 If optional argument KEEP-TRAIL is non-nil, the function returns
3602 a list of of elements leading to element at point. The list's
3603 CAR is always the element at point. Its last item will be the
3604 element's parent, unless element was either the first in its
3605 section (in which case the last item in the list is the first
3606 element of section) or an headline (in which case the list
3607 contains that headline as its single element). Elements
3608 in-between, if any, are siblings of the element at point."
3610 ;; If at an headline, parse it. It is the sole element that
3611 ;; doesn't require to know about context. Be sure to disallow
3612 ;; secondary string parsing, though.
3616 ;; Otherwise move at the beginning of the section containing
3617 ;; point.
3625 ;; Starting parsing successively each element with
3626 ;; `org-element-current-element'. Skip those ending before
3627 ;; original position.
3634 ;; 1. Skip any element ending before point or at point.
3639 ;; 2. An element containing point is always the element at
3640 ;; point.
3643 ;; 3. At a plain list.
3649 ;; Find the item at this level containing ORIGIN.
3656 ;; Item ends before point: skip it.
3658 ;; Item contains point: store is in PARENT.
3660 ;; We went too far: return PARENT.
3662 ;; No parent: no item contained point, though
3663 ;; the plain list does. Point is in the blank
3664 ;; lines after the list: return plain list.
3668 ;; 4. At any other greater element type, if point is
3669 ;; within contents, move into it. Otherwise, return
3670 ;; that element.
3677 ;; Reset trail, since we found a parent.
3683 ;; Once the local structure around point is well understood, it's easy
3684 ;; to implement some replacements for `forward-paragraph'
3685 ;; `backward-paragraph', namely `org-element-forward' and
3686 ;; `org-element-backward'.
3688 ;; Also, `org-transpose-elements' mimics the behaviour of
3689 ;; `transpose-words', at the element's level, whereas
3690 ;; `org-element-drag-forward', `org-element-drag-backward', and
3691 ;; `org-element-up' generalize, respectively, functions
3692 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3694 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3695 ;; smartly remove global indentation from buffer, making it possible
3696 ;; to use Org indent mode on a file created with hard indentation.
3698 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3699 ;; internally by some of the previously cited tools.
3702 "Non-nil when elements ELEM-A and ELEM-B are nested."
3711 "Swap elements ELEM-A and ELEM-B.
3713 Leave point at the end of ELEM-A."
3735 "Move backward by one element.
3736 Move to the previous element at the same level, when possible."
3743 ;; Move to beginning of current element if point isn't there.
3747 ;; At an headline: move to previous headline at the same
3748 ;; level, a parent, or BOB.
3753 ;; At an item: try to move to the previous item, if any.
3759 ;; In any other case, find the previous element in the
3760 ;; trail and move to its beginning. If no previous element
3761 ;; can be found, move to headline.
3767 "Drag backward element at point."
3784 ;; Compute new position of point: it's shifted by PREV-ELEM
3785 ;; body's length.
3792 "Move forward element at point."
3805 ;; Compute new position of point: it's shifted by NEXT-ELEM
3806 ;; body's length (without final blanks) and by the length of
3807 ;; blanks between ELEM and NEXT-ELEM.
3824 "Move forward by one element.
3825 Move to the next element at the same level, when possible."
3833 ;; At an headline, move to next headline at the same level.
3835 ;; At an item. Move to the next item, if possible.
3842 ;; In any other case, move to element's end, unless this
3843 ;; position is also the end of its parent's contents, in which
3844 ;; case, directly jump to parent's end.
3847 ;; Determine if TRAIL contains the real parent of ELEMENT.
3851 org-element-greater-elements)
3854 parent-candidate)))))
3861 "Put point at beginning of this element, mark at end.
3863 Interactively, if this command is repeated or (in Transient Mark
3864 mode) if the mark is active, it marks the next element after the
3865 ones already marked."
3880 "Narrow buffer to current element."
3898 "Transpose current and previous elements, keeping blank lines between.
3899 Point is moved after both elements."
3918 "Un-indent the visible part of the buffer.
3919 Relative indentation \(between items, inside blocks, etc.\) isn't
3920 modified."
3925 unindent-tree ; For byte-compiler.
3943 "Move to upper element."
3954 ;; At an item, with a parent in the list: move to that parent.
3961 ;; Determine parent in the trail.
3967 org-element-greater-elements)
3970 parentp)))))
3972 ;; When parent is found move to its beginning.
3974 ;; If no parent was found, move to headline above, if any
3975 ;; or return an error.
3980 "Move to inner element."
3987 ;; If contents are hidden, first disclose them.
3994 ;;; org-element.el ends here