| blob | 8835391287db4538a98113b212276f8c2af67d1d |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. All affiliated keywords
38 ;; are referenced in `org-element-affiliated-keywords'.
39 ;;
40 ;; Element containing other elements (and only elements) are called
41 ;; greater elements. Concerned types are: `center-block', `drawer',
42 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
43 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
44 ;;
45 ;; Other element types are: `babel-call', `clock', `comment',
46 ;; `comment-block', `example-block', `export-block', `fixed-width',
47 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
48 ;; `planning', `property-drawer', `quote-section', `src-block',
49 ;; `table', `table-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.
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.
84 ;; An Org buffer is a nested list of such elements and objects, whose
85 ;; type is `org-data' and properties is nil.
87 ;; The first part of this file implements a parser and an interpreter
88 ;; for each type of Org syntax.
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').
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'.
101 ;; The penultimate part is the cradle of an interpreter for the
102 ;; obtained parse tree: `org-element-interpret-data'.
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
118 ;; For each greater element type, we define a parser and an
119 ;; interpreter.
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.
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.
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.
141 ;; With the exception of `headline' and `item' types, greater elements
142 ;; cannot contain other greater elements of their own type.
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
862 ;; For each element, a parser and an interpreter are also defined.
863 ;; Both follow the same naming convention used for greater elements.
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'.
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 value
968 ;; Get comments ending. This may not be accurate if
969 ;; commented lines within an item are followed by
970 ;; commented lines outside of a list. Though, parser will
971 ;; always get it right as it already knows surrounding
972 ;; element and has narrowed buffer to its contents.
975 ;; Accumulate lines without leading hash and plus sign
976 ;; if any. First whitespace is also ignored.
995 "Interpret COMMENT element as Org syntax.
996 CONTENTS is nil."
1002 ;;;; Comment Block
1005 "Parse an export block.
1007 Return a list whose CAR is `comment-block' and CDR is a plist
1008 containing `:begin', `:end', `:hiddenp', `:value' and
1009 `:post-blank' keywords.
1011 Assume point is at comment block beginning."
1034 "Interpret COMMENT-BLOCK element as Org syntax.
1035 CONTENTS is nil."
1040 ;;;; Example Block
1043 "Parse an example block.
1045 Return a list whose CAR is `example-block' and CDR is a plist
1046 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1047 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1048 `:switches', `:value' and `:post-blank' keywords."
1054 ;; Switches analysis
1059 ;; Should labels be retained in (or stripped from) example
1060 ;; blocks?
1065 ;; What should code-references use - labels or
1066 ;; line-numbers?
1073 ;; Standard block parsing.
1100 "Interpret EXAMPLE-BLOCK element as Org syntax.
1101 CONTENTS is nil."
1109 ;;;; Export Block
1112 "Parse an export block.
1114 Return a list whose CAR is `export-block' and CDR is a plist
1115 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1116 `:post-blank' keywords.
1118 Assume point is at export-block beginning."
1144 "Interpret EXPORT-BLOCK element as Org syntax.
1145 CONTENTS is nil."
1152 ;;;; Fixed-width
1155 "Parse a fixed-width section.
1157 Return a list whose CAR is `fixed-width' and CDR is a plist
1158 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1160 Assume point is at the beginning of the fixed-width area."
1164 value
1166 ;; Ending position may not be accurate if fixed-width
1167 ;; lines within an item are followed by fixed-width lines
1168 ;; outside of a list. Though, parser will always get it
1169 ;; right as it already knows surrounding element and has
1170 ;; narrowed buffer to its contents.
1173 ;, Accumulate text without starting colons.
1191 "Interpret FIXED-WIDTH element as Org syntax.
1192 CONTENTS is nil."
1197 ;;;; Horizontal Rule
1200 "Parse an horizontal rule.
1202 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1203 containing `:begin', `:end' and `:post-blank' keywords."
1217 "Interpret HORIZONTAL-RULE element as Org syntax.
1218 CONTENTS is nil."
1222 ;;;; Keyword
1225 "Parse a keyword at point.
1227 Return a list whose CAR is `keyword' and CDR is a plist
1228 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1229 keywords."
1249 "Interpret KEYWORD element as Org syntax.
1250 CONTENTS is nil."
1256 ;;;; Latex Environment
1259 "Parse a LaTeX environment.
1261 Return a list whose CAR is `latex-environment' and CDR is a plist
1262 containing `:begin', `:end', `:value' and `:post-blank'
1263 keywords.
1265 Assume point is at the beginning of the latex environment."
1285 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1286 CONTENTS is nil."
1290 ;;;; Paragraph
1293 "Parse a paragraph.
1295 Return a list whose CAR is `paragraph' and CDR is a plist
1296 containing `:begin', `:end', `:contents-begin' and
1297 `:contents-end' and `:post-blank' keywords.
1299 Assume point is at the beginning of the paragraph."
1321 "Interpret PARAGRAPH element as Org syntax.
1322 CONTENTS is the contents of the element."
1323 contents)
1326 ;;;; Planning
1329 "Parse a planning.
1331 Return a list whose CAR is `planning' and CDR is a plist
1332 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1333 and `:post-blank' keywords."
1342 closed deadline scheduled)
1362 "Interpret PLANNING element as Org syntax.
1363 CONTENTS is nil."
1365 'identity
1376 ;;;; Property Drawer
1379 "Parse a property drawer.
1381 Return a list whose CAR is `property-drawer' and CDR is a plist
1382 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1383 `:contents-end', `:properties' and `:post-blank' keywords.
1385 Assume point is at the beginning of the property drawer."
1399 val))
1401 val))
1415 "Interpret PROPERTY-DRAWER element as Org syntax.
1416 CONTENTS is nil."
1426 ;;;; Quote Section
1429 "Parse a quote section.
1431 Return a list whose CAR is `quote-section' and CDR is a plist
1432 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1434 Assume point is at beginning of the section."
1450 "Interpret QUOTE-SECTION element as Org syntax.
1451 CONTENTS is nil."
1455 ;;;; Src Block
1458 "Parse a src block.
1460 Return a list whose CAR is `src-block' and CDR is a plist
1461 containing `:language', `:switches', `:parameters', `:begin',
1462 `:end', `:hiddenp', `:contents-begin', `:contents-end',
1463 `:number-lines', `:retain-labels', `:use-labels', `:label-fmt',
1464 `:preserve-indent', `:value' and `:post-blank' keywords.
1466 Assume point is at the beginning of the block."
1470 ;; Get affiliated keywords.
1472 ;; Get beginning position.
1474 ;; Get language as a string.
1483 ;; Get switches.
1485 ;; Get parameters.
1487 ;; Switches analysis
1495 ;; Should labels be retained in (or stripped from) src
1496 ;; blocks?
1501 ;; What should code-references use - labels or
1502 ;; line-numbers?
1506 ;; Get position at end of block.
1510 ;; Retrieve code.
1516 ;; Get position after ending blank lines.
1519 ;; Get visibility status.
1542 "Interpret SRC-BLOCK element as Org syntax.
1543 CONTENTS is nil."
1563 value
1567 ;;;; Table
1570 "Parse a table at point.
1572 Return a list whose CAR is `table' and CDR is a plist containing
1573 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1574 `:contents-end', `:value' and `:post-blank' keywords.
1576 Assume point is at the beginning of the table."
1595 ;; Only `org' tables have contents. `table.el' tables
1596 ;; use a `:value' property to store raw table as
1597 ;; a string.
1602 table-begin table-end))
1607 "Interpret TABLE element as Org syntax.
1608 CONTENTS is nil."
1618 ;;;; Table Row
1621 "Parse table row at point.
1623 Return a list whose CAR is `table-row' and CDR is a plist
1624 containing `:begin', `:end', `:contents-begin', `:contents-end',
1625 `:type' and `:post-blank' keywords."
1629 ;; A table rule has no contents. In that case, ensure
1630 ;; CONTENTS-BEGIN matches CONTENTS-END.
1649 "Interpret TABLE-ROW element as Org syntax.
1650 CONTENTS is the contents of the table row."
1655 ;;;; Verse Block
1658 "Parse a verse block.
1660 Return a list whose CAR is `verse-block' and CDR is a plist
1661 containing `:begin', `:end', `:contents-begin', `:contents-end',
1662 `:hiddenp' and `:post-blank' keywords.
1664 Assume point is at beginning of the block."
1688 "Interpret VERSE-BLOCK element as Org syntax.
1689 CONTENTS is verse block contents."
1693 \f
1694 ;;; Objects
1695 ;;
1696 ;; Unlike to elements, interstices can be found between objects.
1697 ;; That's why, along with the parser, successor functions are provided
1698 ;; for each object. Some objects share the same successor (i.e. `code'
1699 ;; and `verbatim' objects).
1700 ;;
1701 ;; A successor must accept a single argument bounding the search. It
1702 ;; will return either a cons cell whose CAR is the object's type, as
1703 ;; a symbol, and CDR the position of its next occurrence, or nil.
1704 ;;
1705 ;; Successors follow the naming convention:
1706 ;; org-element-NAME-successor, where NAME is the name of the
1707 ;; successor, as defined in `org-element-all-successors'.
1708 ;;
1709 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1710 ;; object types they can contain will be specified in
1711 ;; `org-element-object-restrictions'.
1712 ;;
1713 ;; Adding a new type of object is simple. Implement a successor,
1714 ;; a parser, and an interpreter for it, all following the naming
1715 ;; convention. Register type in `org-element-all-objects' and
1716 ;; successor in `org-element-all-successors'. Maybe tweak
1717 ;; restrictions about it, and that's it.
1720 ;;;; Bold
1723 "Parse bold object at point.
1725 Return a list whose CAR is `bold' and CDR is a plist with
1726 `:begin', `:end', `:contents-begin' and `:contents-end' and
1727 `:post-blank' keywords.
1729 Assume point is at the first star marker."
1747 "Interpret BOLD object as Org syntax.
1748 CONTENTS is the contents of the object."
1752 "Search for the next text-markup object.
1754 LIMIT bounds the search.
1756 Return value is a cons cell whose CAR is a symbol among `bold',
1757 `italic', `underline', `strike-through', `code' and `verbatim'
1758 and CDR is beginning position."
1774 ;;;; Code
1777 "Parse code object at point.
1779 Return a list whose CAR is `code' and CDR is a plist with
1780 `:value', `:begin', `:end' and `:post-blank' keywords.
1782 Assume point is at the first tilde marker."
1798 "Interpret CODE object as Org syntax.
1799 CONTENTS is nil."
1803 ;;;; Entity
1806 "Parse entity at point.
1808 Return a list whose CAR is `entity' and CDR a plist with
1809 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1810 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1811 keywords.
1813 Assume point is at the beginning of the entity."
1837 "Interpret ENTITY object as Org syntax.
1838 CONTENTS is nil."
1844 "Search for the next latex-fragment or entity object.
1846 LIMIT bounds the search.
1848 Return value is a cons cell whose CAR is `entity' or
1849 `latex-fragment' and CDR is beginning position."
1852 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1859 limit t)
1862 ;; Determine if it's a real entity or a LaTeX command.
1865 ;; No entity nor command: point is at a LaTeX fragment.
1866 ;; Determine its type to get the correct beginning position.
1874 matchers)
1878 ;;;; Export Snippet
1881 "Parse export snippet at point.
1883 Return a list whose CAR is `export-snippet' and CDR a plist with
1884 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1885 keywords.
1887 Assume point is at the beginning of the snippet."
1910 "Interpret EXPORT-SNIPPET object as Org syntax.
1911 CONTENTS is nil."
1917 "Search for the next export-snippet object.
1919 LIMIT bounds the search.
1921 Return value is a cons cell whose CAR is `export-snippet' CDR is
1922 its beginning position."
1935 ;;;; Footnote Reference
1938 "Parse footnote reference at point.
1940 Return a list whose CAR is `footnote-reference' and CDR a plist
1941 with `:label', `:type', `:inline-definition', `:begin', `:end'
1942 and `:post-blank' as keywords."
1975 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1976 CONTENTS is nil."
1986 "Search for the next footnote-reference object.
1988 LIMIT bounds the search.
1990 Return value is a cons cell whose CAR is `footnote-reference' and
1991 CDR is beginning position."
2005 ;;;; Inline Babel Call
2008 "Parse inline babel call at point.
2010 Return a list whose CAR is `inline-babel-call' and CDR a plist
2011 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2013 Assume point is at the beginning of the babel call."
2029 "Interpret INLINE-BABEL-CALL object as Org syntax.
2030 CONTENTS is nil."
2036 ;; Remove redundant square brackets.
2039 main-source)
2043 "Search for the next inline-babel-call object.
2045 LIMIT bounds the search.
2047 Return value is a cons cell whose CAR is `inline-babel-call' and
2048 CDR is beginning position."
2050 ;; Use a simplified version of
2051 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2053 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2054 limit t)
2058 ;;;; Inline Src Block
2061 "Parse inline source block at point.
2063 Return a list whose CAR is `inline-src-block' and CDR a plist
2064 with `:begin', `:end', `:language', `:value', `:parameters' and
2065 `:post-blank' as keywords.
2067 Assume point is at the beginning of the inline src block."
2087 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2088 CONTENTS is nil."
2093 language
2095 body)))
2098 "Search for the next inline-babel-call element.
2100 LIMIT bounds the search.
2102 Return value is a cons cell whose CAR is `inline-babel-call' and
2103 CDR is beginning position."
2108 ;;;; Italic
2111 "Parse italic object at point.
2113 Return a list whose CAR is `italic' and CDR is a plist with
2114 `:begin', `:end', `:contents-begin' and `:contents-end' and
2115 `:post-blank' keywords.
2117 Assume point is at the first slash marker."
2135 "Interpret ITALIC object as Org syntax.
2136 CONTENTS is the contents of the object."
2140 ;;;; Latex Fragment
2143 "Parse latex fragment at point.
2145 Return a list whose CAR is `latex-fragment' and CDR a plist with
2146 `:value', `:begin', `:end', and `:post-blank' as keywords.
2148 Assume point is at the beginning of the latex fragment."
2162 ;; None found: it's a macro.
2176 "Interpret LATEX-FRAGMENT object as Org syntax.
2177 CONTENTS is nil."
2180 ;;;; Line Break
2183 "Parse line break at point.
2185 Return a list whose CAR is `line-break', and CDR a plist with
2186 `:begin', `:end' and `:post-blank' keywords.
2188 Assume point is at the beginning of the line break."
2194 "Interpret LINE-BREAK object as Org syntax.
2195 CONTENTS is nil."
2199 "Search for the next line-break object.
2201 LIMIT bounds the search.
2203 Return value is a cons cell whose CAR is `line-break' and CDR is
2204 beginning position."
2208 ;; A line break can only happen on a non-empty line.
2213 ;;;; Link
2216 "Parse link at point.
2218 Return a list whose CAR is `link' and CDR a plist with `:type',
2219 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2220 `:contents-end' and `:post-blank' as keywords.
2222 Assume point is at the beginning of the link."
2225 end contents-begin contents-end link-end post-blank path type
2226 raw-link link)
2228 ;; Type 1: Text targeted from a radio target.
2233 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2238 ;; RAW-LINK is the original link.
2243 ;; Determine TYPE of link and set PATH accordingly.
2245 ;; File type.
2248 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2251 ;; Id type: PATH is the id.
2254 ;; Code-ref type: PATH is the name of the reference.
2257 ;; Custom-id type: PATH is the name of the custom id.
2260 ;; Fuzzy type: Internal link either matches a target, an
2261 ;; headline name or nothing. PATH is the target or
2262 ;; headline's name.
2264 ;; Type 3: Plain link, i.e. http://orgmode.org
2270 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2277 ;; In any case, deduce end point after trailing white space from
2278 ;; LINK-END variable.
2292 "Interpret LINK object as Org syntax.
2293 CONTENTS is the contents of the object, or nil."
2298 raw-link
2302 "Search for the next link object.
2304 LIMIT bounds the search.
2306 Return value is a cons cell whose CAR is `link' and CDR is
2307 beginning position."
2316 ;;;; Macro
2319 "Parse macro at point.
2321 Return a list whose CAR is `macro' and CDR a plist with `:key',
2322 `:args', `:begin', `:end', `:value' and `:post-blank' as
2323 keywords.
2325 Assume point is at the macro."
2339 ;; Repair bad splits.
2354 "Interpret MACRO object as Org syntax.
2355 CONTENTS is nil."
2359 "Search for the next macro object.
2361 LIMIT bounds the search.
2363 Return value is cons cell whose CAR is `macro' and CDR is
2364 beginning position."
2368 limit t)
2372 ;;;; Radio-target
2375 "Parse radio target at point.
2377 Return a list whose CAR is `radio-target' and CDR a plist with
2378 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2379 and `:post-blank' as keywords.
2381 Assume point is at the radio target."
2400 "Interpret TARGET object as Org syntax.
2401 CONTENTS is the contents of the object."
2405 "Search for the next radio-target object.
2407 LIMIT bounds the search.
2409 Return value is a cons cell whose CAR is `radio-target' and CDR
2410 is beginning position."
2416 ;;;; Statistics Cookie
2419 "Parse statistics cookie at point.
2421 Return a list whose CAR is `statistics-cookie', and CDR a plist
2422 with `:begin', `:end', `:value' and `:post-blank' keywords.
2424 Assume point is at the beginning of the statistics-cookie."
2440 "Interpret STATISTICS-COOKIE object as Org syntax.
2441 CONTENTS is nil."
2445 "Search for the next statistics cookie object.
2447 LIMIT bounds the search.
2449 Return value is a cons cell whose CAR is `statistics-cookie' and
2450 CDR is beginning position."
2456 ;;;; Strike-Through
2459 "Parse strike-through object at point.
2461 Return a list whose CAR is `strike-through' and CDR is a plist
2462 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2463 `:post-blank' keywords.
2465 Assume point is at the first plus sign marker."
2483 "Interpret STRIKE-THROUGH object as Org syntax.
2484 CONTENTS is the contents of the object."
2488 ;;;; Subscript
2491 "Parse subscript at point.
2493 Return a list whose CAR is `subscript' and CDR a plist with
2494 `:begin', `:end', `:contents-begin', `:contents-end',
2495 `:use-brackets-p' and `:post-blank' as keywords.
2497 Assume point is at the underscore."
2501 t
2519 "Interpret SUBSCRIPT object as Org syntax.
2520 CONTENTS is the contents of the object."
2523 contents))
2526 "Search for the next sub/superscript object.
2528 LIMIT bounds the search.
2530 Return value is a cons cell whose CAR is either `subscript' or
2531 `superscript' and CDR is beginning position."
2538 ;;;; Superscript
2541 "Parse superscript at point.
2543 Return a list whose CAR is `superscript' and CDR a plist with
2544 `:begin', `:end', `:contents-begin', `:contents-end',
2545 `:use-brackets-p' and `:post-blank' as keywords.
2547 Assume point is at the caret."
2568 "Interpret SUPERSCRIPT object as Org syntax.
2569 CONTENTS is the contents of the object."
2572 contents))
2575 ;;;; Table Cell
2578 "Parse table cell at point.
2580 Return a list whose CAR is `table-cell' and CDR is a plist
2581 containing `:begin', `:end', `:contents-begin', `:contents-end'
2582 and `:post-blank' keywords."
2596 "Interpret TABLE-CELL element as Org syntax.
2597 CONTENTS is the contents of the cell, or nil."
2601 "Search for the next table-cell object.
2603 LIMIT bounds the search.
2605 Return value is a cons cell whose CAR is `table-cell' and CDR is
2606 beginning position."
2610 ;;;; Target
2613 "Parse target at point.
2615 Return a list whose CAR is `target' and CDR a plist with
2616 `:begin', `:end', `:value' and `:post-blank' as keywords.
2618 Assume point is at the target."
2633 "Interpret TARGET object as Org syntax.
2634 CONTENTS is nil."
2638 "Search for the next target object.
2640 LIMIT bounds the search.
2642 Return value is a cons cell whose CAR is `target' and CDR is
2643 beginning position."
2649 ;;;; Timestamp
2652 "Parse time stamp at point.
2654 Return a list whose CAR is `timestamp', and CDR a plist with
2655 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2657 Assume point is at the beginning of the timestamp."
2683 "Interpret TIMESTAMP object as Org syntax.
2684 CONTENTS is nil."
2688 "Search for the next timestamp object.
2690 LIMIT bounds the search.
2692 Return value is a cons cell whose CAR is `timestamp' and CDR is
2693 beginning position."
2701 limit t)
2705 ;;;; Underline
2708 "Parse underline object at point.
2710 Return a list whose CAR is `underline' and CDR is a plist with
2711 `:begin', `:end', `:contents-begin' and `:contents-end' and
2712 `:post-blank' keywords.
2714 Assume point is at the first underscore marker."
2732 "Interpret UNDERLINE object as Org syntax.
2733 CONTENTS is the contents of the object."
2737 ;;;; Verbatim
2740 "Parse verbatim object at point.
2742 Return a list whose CAR is `verbatim' and CDR is a plist with
2743 `:value', `:begin', `:end' and `:post-blank' keywords.
2745 Assume point is at the first equal sign marker."
2761 "Interpret VERBATIM object as Org syntax.
2762 CONTENTS is nil."
2766 \f
2767 ;;; Definitions And Rules
2769 ;; Define elements, greater elements and specify recursive objects,
2770 ;; along with the affiliated keywords recognized. Also set up
2771 ;; restrictions on recursive objects combinations.
2773 ;; These variables really act as a control center for the parsing
2774 ;; process.
2777 ;; Headlines and inlinetasks.
2779 ;; Comments, blocks (any type), keywords and babel calls.
2781 ;; Lists.
2783 ;; Fixed-width, drawers (any type) and tables.
2785 ;; Footnote definitions.
2787 ;; Horizontal rules.
2789 ;; LaTeX environments.
2791 ;; Planning and Clock lines.
2801 export-block fixed-width footnote-definition headline
2802 horizontal-rule inlinetask item keyword latex-environment
2803 babel-call paragraph plain-list planning property-drawer
2804 quote-block quote-section section special-block src-block table
2805 table-row verse-block)
2810 item plain-list quote-block section special-block table)
2815 latex-or-entity line-break link macro radio-target
2816 statistics-cookie sub/superscript table-cell target
2817 text-markup timestamp)
2826 "Alist of translations between object type and successor name.
2828 Sharing the same successor comes handy when, for example, the
2833 inline-src-block italic line-break latex-fragment link macro
2834 radio-target statistics-cookie strike-through subscript superscript
2835 table-cell target timestamp underline verbatim)
2840 table-cell underline)
2855 "Alist between block names and their element type.
2856 Any block whose name has no association in the current list has
2869 "Alist of usual translations for keywords.
2870 The key is the old name and the value the new one. The property
2875 "List of affiliated keywords that can occur more that once in an element.
2877 Their value will be consed into a list of strings, which will be
2878 returned as the value of the property.
2880 This list is checked after translations have been applied. See
2884 "List of keywords whose value can be parsed.
2886 Their value will be stored as a secondary string: a list of
2887 strings and objects.
2889 This list is checked after translations have been applied. See
2893 "List of keywords which can have a secondary value.
2895 In Org syntax, they can be written with optional square brackets
2896 before the colons. For example, results keyword can be
2897 associated to a hash value with the following:
2899 #+RESULTS[hash-string]: some-source
2901 This list is checked after translations have been applied. See
2908 inline-babel-call inline-src-block latex-fragment
2909 line-break link macro radio-target sub/superscript
2910 target text-markup timestamp)
2912 macro radio-target statistics-cookie sub/superscript text-markup
2913 timestamp)
2927 link radio-target sub/superscript target text-markup
2928 timestamp)
2939 latex-fragment line-break link macro radio-target
2941 "Alist of objects restrictions.
2943 CAR is an element or object type containing objects and CDR is
2944 a list of successors that will be called within an element or
2945 object of such type.
2947 For example, in a `radio-target' object, one can only find
2948 entities, export snippets, latex-fragments, subscript and
2949 superscript.
2951 This alist also applies to secondary string. For example, an
2952 `headline' type element doesn't directly contain objects, but
2963 \f
2964 ;;; Accessors
2965 ;;
2966 ;; Provide four accessors: `org-element-type', `org-element-property'
2967 ;; `org-element-contents' and `org-element-restriction'.
2970 "Return type of element ELEMENT.
2972 The function returns the type of the element or object provided.
2973 It can also return the following special value:
2974 `plain-text' for a string
2975 `org-data' for a complete document
2976 nil in any other case."
2982 "Extract the value from the PROPERTY of an ELEMENT."
2986 "Extract contents from an ELEMENT."
2990 "Return restriction associated to ELEMENT.
2991 ELEMENT can be an element, an object or a symbol representing an
2992 element or object type."
2994 org-element-object-restrictions)))
2997 \f
2998 ;;; Parsing Element Starting At Point
2999 ;;
3000 ;; `org-element-current-element' is the core function of this section.
3001 ;; It returns the Lisp representation of the element starting at
3002 ;; point.
3003 ;;
3004 ;; `org-element-current-element' makes use of special modes. They are
3005 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3006 ;; or fixed conditional element chaining (i.e. `headline' >
3007 ;; `section'). Special modes are: `section', `quote-section', `item'
3008 ;; and `table-row'.
3011 "Parse the element starting at point.
3013 Return value is a list like (TYPE PROPS) where TYPE is the type
3014 of the element and PROPS a plist of properties associated to the
3015 element.
3017 Possible types are defined in `org-element-all-elements'.
3019 Optional argument GRANULARITY determines the depth of the
3020 recursion. Allowed values are `headline', `greater-element',
3021 `element', `object' or nil. When it is broader than `object' (or
3022 nil), secondary values will not be parsed, since they only
3023 contain objects.
3025 Optional argument SPECIAL, when non-nil, can be either `section',
3026 `quote-section', `table-row' and `item'.
3028 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3029 be computed.
3031 This function assumes point is always at the beginning of the
3032 element it has to parse."
3034 ;; If point is at an affiliated keyword, try moving to the
3035 ;; beginning of the associated element. If none is found, the
3036 ;; keyword is orphaned and will be treated as plain text.
3042 ;; Determine if parsing depth allows for secondary strings
3043 ;; parsing. It only applies to elements referenced in
3044 ;; `org-element-secondary-value-alist'.
3047 ;; Item.
3050 raw-secondary-p))
3051 ;; Quote Section.
3053 ;; Table Row.
3055 ;; Headline.
3058 ;; Section (must be checked after headline).
3060 ;; Planning and Clock.
3065 ;; Blocks.
3076 ;; Inlinetask.
3078 ;; LaTeX Environment.
3084 ;; Drawer and Property Drawer.
3092 ;; Fixed Width
3094 ;; Babel Call, Dynamic Block and Keyword.
3107 ;; Footnote Definition.
3110 ;; Comment.
3113 ;; Horizontal Rule.
3116 ;; Table.
3118 ;; List.
3121 ;; Default element: Paragraph.
3125 ;; Most elements can have affiliated keywords. When looking for an
3126 ;; element beginning, we want to move before them, as they belong to
3127 ;; that element, and, in the meantime, collect information they give
3128 ;; into appropriate properties. Hence the following function.
3130 ;; Usage of optional arguments may not be obvious at first glance:
3132 ;; - TRANS-LIST is used to polish keywords names that have evolved
3133 ;; during Org history. In example, even though =result= and
3134 ;; =results= coexist, we want to have them under the same =result=
3135 ;; property. It's also true for "srcname" and "name", where the
3136 ;; latter seems to be preferred nowadays (thus the "name" property).
3138 ;; - CONSED allows to regroup multi-lines keywords under the same
3139 ;; property, while preserving their own identity. This is mostly
3140 ;; used for "attr_latex" and al.
3142 ;; - PARSED prepares a keyword value for export. This is useful for
3143 ;; "caption". Objects restrictions for such keywords are defined in
3144 ;; `org-element-object-restrictions'.
3146 ;; - DUALS is used to take care of keywords accepting a main and an
3147 ;; optional secondary values. For example "results" has its
3148 ;; source's name as the main value, and may have an hash string in
3149 ;; optional square brackets as the secondary one.
3151 ;; A keyword may belong to more than one category.
3162 "Regexp matching any affiliated keyword.
3164 Keyword name is put in match group 1. Moreover, if keyword
3165 belongs to `org-element-dual-keywords', put the dual value in
3166 match group 2.
3171 consed parsed duals)
3172 "Collect affiliated keywords before point.
3174 Optional argument KEY-RE is a regexp matching keywords, which
3175 puts matched keyword in group 1. It defaults to
3176 `org-element--affiliated-re'.
3178 TRANS-LIST is an alist where key is the keyword and value the
3179 property name it should be translated to, without the colons. It
3180 defaults to `org-element-keyword-translation-alist'.
3182 CONSED is a list of strings. Any keyword belonging to that list
3183 will have its value consed. The check is done after keyword
3184 translation. It defaults to `org-element-multiple-keywords'.
3186 PARSED is a list of strings. Any keyword member of this list
3187 will have its value parsed. The check is done after keyword
3188 translation. If a keyword is a member of both CONSED and PARSED,
3189 it's value will be a list of parsed strings. It defaults to
3190 `org-element-parsed-keywords'.
3192 DUALS is a list of strings. Any keyword member of this list can
3193 have two parts: one mandatory and one optional. Its value is
3194 a cons cell whose car is the former, and the cdr the latter. If
3195 a keyword is a member of both PARSED and DUALS, both values will
3196 be parsed. It defaults to `org-element-dual-keywords'.
3198 Return a list whose car is the position at the first of them and
3199 cdr a plist of keywords and values."
3207 ;; RESTRICT is the list of objects allowed in parsed
3208 ;; keywords value.
3210 output)
3215 ;; Apply translation to RAW-KWD. From there, KWD is
3216 ;; the official keyword.
3218 ;; Find main value for any keyword.
3224 ;; If KWD is a dual keyword, find its secondary
3225 ;; value. Maybe parse it.
3231 ;; Attribute a property name to KWD.
3233 ;; Now set final shape for VALUE.
3237 ;; VALUE is mandatory. Set it to nil if there is none.
3241 ;; Eventually store the new value in OUTPUT.
3247 \f
3248 ;;; The Org Parser
3250 ;; The two major functions here are `org-element-parse-buffer', which
3251 ;; parses Org syntax inside the current buffer, taking into account
3252 ;; region, narrowing, or even visibility if specified, and
3253 ;; `org-element-parse-secondary-string', which parses objects within
3254 ;; a given string.
3256 ;; The (almost) almighty `org-element-map' allows to apply a function
3257 ;; on elements or objects matching some type, and accumulate the
3258 ;; resulting values. In an export situation, it also skips unneeded
3259 ;; parts of the parse tree.
3262 "Recursively parse the buffer and return structure.
3263 If narrowing is in effect, only parse the visible part of the
3264 buffer.
3266 Optional argument GRANULARITY determines the depth of the
3267 recursion. It can be set to the following symbols:
3269 `headline' Only parse headlines.
3270 `greater-element' Don't recurse into greater elements excepted
3271 headlines and sections. Thus, elements
3272 parsed are the top-level ones.
3273 `element' Parse everything but objects and plain text.
3274 `object' Parse the complete buffer (default).
3276 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3277 elements.
3279 Assume buffer is in Org mode."
3286 ;; Start in `section' mode so text before the first
3287 ;; headline belongs to a section.
3291 "Recursively parse objects in STRING and return structure.
3293 RESTRICTION, when non-nil, is a symbol limiting the object types
3294 that will be looked after."
3300 "Map a function on selected elements or objects.
3302 DATA is the parsed tree, as returned by, i.e,
3303 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3304 of elements or objects types. FUN is the function called on the
3305 matching element or object. It must accept one arguments: the
3306 element or object itself.
3308 When optional argument INFO is non-nil, it should be a plist
3309 holding export options. In that case, parts of the parse tree
3310 not exportable according to that property list will be skipped.
3312 When optional argument FIRST-MATCH is non-nil, stop at the first
3313 match for which FUN doesn't return nil, and return that value.
3315 Optional argument NO-RECURSION is a symbol or a list of symbols
3316 representing elements or objects types. `org-element-map' won't
3317 enter any recursive element or object whose type belongs to that
3318 list. Though, FUN can still be applied on them.
3320 Nil values returned from FUN do not appear in the results."
3321 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3324 ;; Recursion depth is determined by --CATEGORY.
3334 ;; --RESTRICTS is a list of element types whose secondary
3335 ;; string could possibly contain an object with a type among
3336 ;; TYPES.
3340 when
3344 --acc
3348 ;; Recursively walk DATA. INFO, if non-nil, is
3349 ;; a plist holding contextual information.
3354 ;; Check if TYPE is matching among TYPES. If so,
3355 ;; apply FUN to --BLOB and accumulate return value
3356 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3362 ;; If --BLOB has a secondary string that can
3363 ;; contain objects with their type among TYPES,
3364 ;; look into that string.
3367 --walk-tree
3369 nil
3372 --blob))))
3373 ;; Now determine if a recursion into --BLOB is
3374 ;; possible. If so, do it.
3385 ;; Return value in a proper order.
3388 ;; The following functions are internal parts of the parser.
3390 ;; The first one, `org-element-parse-elements' acts at the element's
3391 ;; level.
3393 ;; The second one, `org-element-parse-objects' applies on all objects
3394 ;; of a paragraph or a secondary string. It uses
3395 ;; `org-element-get-candidates' to optimize the search of the next
3396 ;; object in the buffer.
3398 ;; More precisely, that function looks for every allowed object type
3399 ;; first. Then, it discards failed searches, keeps further matches,
3400 ;; and searches again types matched behind point, for subsequent
3401 ;; calls. Thus, searching for a given type fails only once, and every
3402 ;; object is searched only once at top level (but sometimes more for
3403 ;; nested types).
3407 "Parse elements between BEG and END positions.
3409 SPECIAL prioritize some elements over the others. It can be set
3410 to `quote-section', `section' `item' or `table-row'.
3412 When value is `item', STRUCTURE will be used as the current list
3413 structure.
3415 GRANULARITY determines the depth of the recursion. See
3416 `org-element-parse-buffer' for more information.
3418 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3419 elements.
3421 Elements are accumulated into ACC."
3426 ;; When parsing only headlines, skip any text before first one.
3429 ;; Main loop start.
3432 ;; Find current element's type and parse it accordingly to
3433 ;; its category.
3435 granularity special structure))
3440 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3441 ;; true and element is hidden or if it has no contents
3442 ;; anyway.
3445 ;; Case 2. Greater element: parse it between
3446 ;; `contents-begin' and `contents-end'. Make sure
3447 ;; GRANULARITY allows the recursion, or ELEMENT is an
3448 ;; headline, in which case going inside is mandatory, in
3449 ;; order to get sub-level headings.
3457 ;; Possibly switch to a special mode.
3466 ;; Case 3. ELEMENT has contents. Parse objects inside,
3467 ;; if GRANULARITY allows it.
3472 ;; Case 4. Else, just accumulate ELEMENT.
3474 acc)))
3475 ;; Return result.
3479 "Parse objects between BEG and END and return recursive structure.
3481 Objects are accumulated in ACC.
3483 RESTRICTION is a list of object types which are allowed in the
3484 current object."
3488 ;; Return the parsing function associated to the nearest
3489 ;; object among list of candidates CAND.
3496 next-object candidates)
3500 end restriction candidates))
3502 ;; 1. Text before any object. Untabify it.
3508 acc)))
3509 ;; 2. Object...
3513 cont-beg)
3514 ;; ... recursive. The CONT-BEG check is for
3515 ;; links, as some of them might not be recursive
3516 ;; (i.e. plain links).
3519 cont-beg
3524 ;; Restrict allowed objects.
3526 ;; ... not recursive. Accumulate the object.
3527 next-object)
3528 acc)
3530 ;; 3. Text after last object. Untabify it.
3535 acc))
3536 ;; Result.
3540 "Return an alist of candidates for the next object.
3542 LIMIT bounds the search, and RESTRICTION narrows candidates to
3543 some object types.
3545 Return value is an alist whose CAR is position and CDR the object
3546 type, as a symbol.
3548 OBJECTS is the previous candidates alist."
3550 ;; If no previous result, search every object type in RESTRICTION.
3551 ;; Otherwise, keep potential candidates (old objects located after
3552 ;; point) and ask to search again those which had matched before.
3557 objects))
3558 ;; Call the appropriate successor function for each type to search
3559 ;; and accumulate matches.
3566 type))))
3569 types-to-search)
3570 ;; Return alist.
3571 next-candidates))
3574 \f
3575 ;;; Towards A Bijective Process
3577 ;; The parse tree obtained with `org-element-parse-buffer' is really
3578 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3579 ;; interpreted and expanded into a string with canonical Org syntax.
3580 ;; Hence `org-element-interpret-data'.
3581 ;;
3582 ;; The function relies internally on
3583 ;; `org-element-interpret--affiliated-keywords'.
3586 "Interpret DATA as Org syntax.
3588 DATA is a parse tree, an element, an object or a secondary string
3589 to interpret.
3591 Optional argument PARENT is used for recursive calls. It contains
3592 the element or object containing data, or nil.
3594 Return Org syntax as a string."
3598 ;; Secondary string.
3603 ;; Full Org document.
3608 ;; Plain text.
3610 ;; Element/Object without contents.
3613 data nil))
3614 ;; Element/Object with contents.
3624 ;; Elements directly containing objects must
3625 ;; have their indentation normalized first.
3627 data
3628 ;; When normalizing first paragraph of an
3629 ;; item or a footnote-definition, ignore
3630 ;; first line's indentation.
3637 data
3639 contents)))))))
3641 ;; Build white spaces. If no `:post-blank' property is
3642 ;; specified, assume its value is 0.
3652 "Return ELEMENT's affiliated keywords as Org syntax.
3653 If there is no affiliated keyword, return the empty string."
3663 ": "
3666 value)
3671 element)))
3678 ;; Remove translated keywords.
3683 org-element-affiliated-keywords))
3686 ;; Because interpretation of the parse tree must return the same
3687 ;; number of blank lines between elements and the same number of white
3688 ;; space after objects, some special care must be given to white
3689 ;; spaces.
3690 ;;
3691 ;; The first function, `org-element-normalize-string', ensures any
3692 ;; string different from the empty string will end with a single
3693 ;; newline character.
3694 ;;
3695 ;; The second function, `org-element-normalize-contents', removes
3696 ;; global indentation from the contents of the current element.
3699 "Ensure string S ends with a single newline character.
3701 If S isn't a string return it unchanged. If S is the empty
3702 string, return it. Otherwise, return a new string with a single
3703 newline character at its end."
3711 "Normalize plain text in ELEMENT's contents.
3713 ELEMENT must only contain plain text and objects.
3715 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3716 indentation to compute maximal common indentation.
3718 Return the normalized element that is element with global
3719 indentation removed from its contents. The function assumes that
3720 indentation is not done with TAB characters."
3724 ;; Return list of indentations within BLOB. This is done by
3725 ;; walking recursively BLOB and updating IND-LIST along the
3726 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3727 ;; been seen yet. It is required as this string is the only
3728 ;; one whose indentation doesn't happen after a newline
3729 ;; character.
3737 ;; An indentation of zero means no string will be
3738 ;; modified. Quit the process.
3744 ;; Avoid matching blank or empty lines.
3752 ;; Collect indentation list in ELEMENT. Possibly remove first
3753 ;; value if IGNORE-FIRST is non-nil.
3756 ;; Build ELEMENT back, replacing each string with the same
3757 ;; string minus common indentation.
3761 ;; Return BLOB with all its strings indentation
3762 ;; shortened from MCI white spaces. FIRST-FLAG is
3763 ;; non-nil when the first string hasn't been seen
3764 ;; yet.
3779 org-element-recursive-objects)
3786 \f
3787 ;;; The Toolbox
3789 ;; The first move is to implement a way to obtain the smallest element
3790 ;; containing point. This is the job of `org-element-at-point'. It
3791 ;; basically jumps back to the beginning of section containing point
3792 ;; and moves, element after element, with
3793 ;; `org-element-current-element' until the container is found.
3794 ;;
3795 ;; Note: When using `org-element-at-point', secondary values are never
3796 ;; parsed since the function focuses on elements, not on objects.
3799 "Determine closest element around point.
3801 Return value is a list like (TYPE PROPS) where TYPE is the type
3802 of the element and PROPS a plist of properties associated to the
3803 element. Possible types are defined in
3804 `org-element-all-elements'.
3806 As a special case, if point is at the very beginning of a list or
3807 sub-list, returned element will be that list instead of the first
3808 item. In the same way, if point is at the beginning of the first
3809 row of a table, returned element will be the table instead of the
3810 first row.
3812 If optional argument KEEP-TRAIL is non-nil, the function returns
3813 a list of of elements leading to element at point. The list's
3814 CAR is always the element at point. Following positions contain
3815 element's siblings, then parents, siblings of parents, until the
3816 first element of current section."
3818 ;; If at an headline, parse it. It is the sole element that
3819 ;; doesn't require to know about context. Be sure to disallow
3820 ;; secondary string parsing, though.
3826 ;; Otherwise move at the beginning of the section containing
3827 ;; point.
3835 ;; Parse successively each element, skipping those ending
3836 ;; before original position.
3844 ;; 1. Skip any element ending before point or at point.
3849 ;; 2. An element containing point is always the element at
3850 ;; point.
3853 ;; 3. At any other greater element type, if point is
3854 ;; within contents, move into it. Otherwise, return
3855 ;; that element.
3872 ;; Once the local structure around point is well understood, it's easy
3873 ;; to implement some replacements for `forward-paragraph'
3874 ;; `backward-paragraph', namely `org-element-forward' and
3875 ;; `org-element-backward'.
3877 ;; Also, `org-transpose-elements' mimics the behaviour of
3878 ;; `transpose-words', at the element's level, whereas
3879 ;; `org-element-drag-forward', `org-element-drag-backward', and
3880 ;; `org-element-up' generalize, respectively, functions
3881 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3883 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3884 ;; smartly remove global indentation from buffer, making it possible
3885 ;; to use Org indent mode on a file created with hard indentation.
3887 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3888 ;; internally by some of the previously cited tools.
3891 "Non-nil when elements ELEM-A and ELEM-B are nested."
3900 "Swap elements ELEM-A and ELEM-B.
3901 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
3902 end of ELEM-A."
3904 ;; There are two special cases when an element doesn't start at bol:
3905 ;; the first paragraph in an item or in a footnote definition.
3907 ;; Only a paragraph without any affiliated keyword can be moved at
3908 ;; ELEM-A position in such a situation. Note that the case of
3909 ;; a footnote definition is impossible: it cannot contain two
3910 ;; paragraphs in a row because it cannot contain a blank line.
3916 ;; In a special situation, ELEM-A will have no indentation. We'll
3917 ;; give it ELEM-B's (which will in, in turn, have no indentation).
3944 "Move forward by one element.
3945 Move to the next element at the same level, when possible."
3958 return prev)))
3966 "Move backward by one element.
3967 Move to the previous element at the same level, when possible."
3970 ;; At an headline, move to the previous one, if any, or stay
3971 ;; here.
3982 ;; Move to beginning of current element if point isn't there
3983 ;; already.
3989 "Move to upper element."
3999 return prev)))
4006 "Move to inner element."
4014 ;; If contents are hidden, first disclose them.
4020 "Move backward element at point."
4026 ;; Error out if no previous element or previous element is
4027 ;; a parent of the current one.
4036 "Move forward element at point."
4049 ;; Compute new position of point: it's shifted by NEXT-ELEM
4050 ;; body's length (without final blanks) and by the length of
4051 ;; blanks between ELEM and NEXT-ELEM.
4056 ;; Small correction if buffer doesn't end
4057 ;; with a newline character.
4070 "Put point at beginning of this element, mark at end.
4072 Interactively, if this command is repeated or (in Transient Mark
4073 mode) if the mark is active, it marks the next element after the
4074 ones already marked."
4089 "Narrow buffer to current element."
4107 "Transpose current and previous elements, keeping blank lines between.
4108 Point is moved after both elements."
4116 "Un-indent the visible part of the buffer.
4117 Relative indentation (between items, inside blocks, etc.) isn't
4118 modified."
4123 unindent-tree ; For byte-compiler.
4142 ;;; org-element.el ends here