| blob | f0ac5d84af5f312f306a49ecd5869a95f7011b7c |
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 two accessors and a function
83 ;; retrieving the smallest element containing point (respectively
84 ;; `org-element-get-property', `org-element-get-contents' and
85 ;; `org-element-at-point').
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.
101 ;;; Code:
107 \f
108 ;;; Greater elements
110 ;; For each greater element type, we define a parser and an
111 ;; interpreter.
113 ;; A parser (`item''s excepted) accepts no argument and represents the
114 ;; element or object as the list described above. An interpreter
115 ;; accepts two arguments: the list representation of the element or
116 ;; object, and its contents. The latter may be nil, depending on the
117 ;; element or object considered. It returns the appropriate Org
118 ;; syntax, as a string.
120 ;; Parsing functions must follow the naming convention:
121 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
122 ;; defined in `org-element-greater-elements'.
123 ;;
124 ;; Similarly, interpreting functions must follow the naming
125 ;; convention: org-element-TYPE-interpreter.
127 ;; With the exception of `headline' and `item' types, greater elements
128 ;; cannot contain other greater elements of their own type.
130 ;; Beside implementing a parser and an interpreter, adding a new
131 ;; greater element requires to tweak `org-element-guess-type'.
132 ;; Moreover, the newly defined type must be added to both
133 ;; `org-element-all-elements' and `org-element-greater-elements'.
136 ;;;; Center Block
139 "Parse a center block.
141 Return a list whose car is `center-block' and cdr is a plist
142 containing `:begin', `:end', `:hiddenp', `:contents-begin',
143 `:contents-end' and `:post-blank' keywords.
145 Assume point is at beginning or end of the block."
172 "Interpret CENTER-BLOCK element as Org syntax.
173 CONTENTS is the contents of the element."
177 ;;;; Drawer
180 "Parse a drawer.
182 Return a list whose car is `drawer' and cdr is a plist containing
183 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
184 `:contents-end' and `:post-blank' keywords.
186 Assume point is at beginning of drawer."
211 "Interpret DRAWER element as Org syntax.
212 CONTENTS is the contents of the element."
215 contents))
218 ;;;; Dynamic Block
221 "Parse a dynamic block.
223 Return a list whose car is `dynamic-block' and cdr is a plist
224 containing `:block-name', `:begin', `:end', `:hiddenp',
225 `:contents-begin', `:contents-end', `:arguments' and
226 `:post-blank' keywords.
228 Assume point is at beginning of dynamic block."
255 "Interpret DYNAMIC-BLOCK element as Org syntax.
256 CONTENTS is the contents of the element."
261 contents))
264 ;;;; Footnote Definition
267 "Parse a footnote definition.
269 Return a list whose car is `footnote-definition' and cdr is
270 a plist containing `:label', `:begin' `:end', `:contents-begin',
271 `:contents-end' and `:post-blank' keywords."
296 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
297 CONTENTS is the contents of the footnote-definition."
299 " "
300 contents))
303 ;;;; Headline
306 "Parse an headline.
308 Return a list whose car is `headline' and cdr is a plist
309 containing `:raw-value', `:title', `:begin', `:end',
310 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
311 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
312 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
313 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
314 keywords.
316 The plist also contains any property set in the property drawer,
317 with its name in lowercase, the underscores replaced with hyphens
318 and colons at the beginning (i.e. `:custom-id').
320 Assume point is at beginning of the headline."
347 plist))
363 title)
364 ;; Clean RAW-VALUE from any quote or comment string.
369 ""
370 raw-value)))
371 ;; Clean TAGS from archive tag, if any.
378 ;; Then get TITLE.
380 raw-value
408 "Interpret HEADLINE element as Org syntax.
409 CONTENTS is the contents of the element."
434 ;; Align tags.
444 tags-len)
448 contents)))
451 ;;;; Inlinetask
454 "Parse an inline task.
456 Return a list whose car is `inlinetask' and cdr is a plist
457 containing `:raw-value', `:title', `:begin', `:end', `:hiddenp',
458 `:contents-begin' and `:contents-end', `:level', `:priority',
459 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
460 `:scheduled', `:deadline', `:timestamp', `:clock' and
461 `:post-blank' keywords.
463 The plist also contains any property set in the property drawer,
464 with its name in lowercase, the underscores replaced with hyphens
465 and colons at the beginning (i.e. `:custom-id').
467 Assume point is at beginning of the inline task."
487 plist))
494 raw-value
499 ;; In the case of a single line task, CONTENTS-BEGIN and
500 ;; CONTENTS-END might overlap.
523 ,@standard-props
527 "Interpret INLINETASK element as Org syntax.
528 CONTENTS is the contents of inlinetask."
538 ;; Align tags.
553 ;;;; Item
556 "Parse an item.
558 STRUCT is the structure of the plain list.
560 Return a list whose car is `item' and cdr is a plist containing
561 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
562 `:checkbox', `:counter', `:tag', `:raw-tag', `:structure',
563 `:hiddenp' and `:post-blank' keywords.
565 Assume point is at the beginning of the item."
585 raw-tag
591 ;; If first line isn't empty,
592 ;; contents really start at the text
593 ;; after item's meta-data.
607 ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
608 ;; up in the case of an empty item separated
609 ;; from the next by a blank line. Thus, ensure
610 ;; the former is always the smallest of two.
622 "Interpret ITEM element as Org syntax.
623 CONTENTS is the contents of the element."
637 num
643 ;; Compute indentation.
645 ;; Indent contents.
647 bullet
658 ;;;; Plain List
661 "Parse a plain list.
663 Optional argument STRUCTURE, when non-nil, is the structure of
664 the plain list being parsed.
666 Return a list whose car is `plain-list' and cdr is a plist
667 containing `:type', `:begin', `:end', `:contents-begin' and
668 `:contents-end', `:level', `:structure' and `:post-blank'
669 keywords.
671 Assume point is at one of the list items."
686 ;; Get list level.
691 struct parents))
693 ;; Blank lines below list belong to the top-level list only.
698 ;; Return value.
711 "Interpret PLAIN-LIST element as Org syntax.
712 CONTENTS is the contents of the element."
713 contents)
716 ;;;; Quote Block
719 "Parse a quote block.
721 Return a list whose car is `quote-block' and cdr is a plist
722 containing `:begin', `:end', `:hiddenp', `:contents-begin',
723 `:contents-end' and `:post-blank' keywords.
725 Assume point is at beginning or end of the block."
752 "Interpret QUOTE-BLOCK element as Org syntax.
753 CONTENTS is the contents of the element."
757 ;;;; Section
760 "Parse a section.
762 Return a list whose car is `section' and cdr is a plist
763 containing `:begin', `:end', `:contents-begin', `contents-end'
764 and `:post-blank' keywords."
766 ;; Beginning of section is the beginning of the first non-blank
767 ;; line after previous headline.
786 "Interpret SECTION element as Org syntax.
787 CONTENTS is the contents of the element."
788 contents)
791 ;;;; Special Block
794 "Parse a special block.
796 Return a list whose car is `special-block' and cdr is a plist
797 containing `:type', `:begin', `:end', `:hiddenp',
798 `:contents-begin', `:contents-end' and `:post-blank' keywords.
800 Assume point is at beginning or end of the block."
831 "Interpret SPECIAL-BLOCK element as Org syntax.
832 CONTENTS is the contents of the element."
837 \f
838 ;;; Elements
840 ;; For each element, a parser and an interpreter are also defined.
841 ;; Both follow the same naming convention used for greater elements.
843 ;; Also, as for greater elements, adding a new element type is done
844 ;; through the following steps: implement a parser and an interpreter,
845 ;; tweak `org-element-guess-type' so that it recognizes the new type
846 ;; and add that new type to `org-element-all-elements'.
848 ;; As a special case, when the newly defined type is a block type,
849 ;; `org-element-non-recursive-block-alist' has to be modified
850 ;; accordingly.
853 ;;;; Babel Call
856 "Parse a babel call.
858 Return a list whose car is `babel-call' and cdr is a plist
859 containing `:begin', `:end', `:info' and `:post-blank' as
860 keywords."
875 "Interpret INLINE-BABEL-CALL object as Org syntax.
876 CONTENTS is nil."
882 ;; Remove redundant square brackets.
885 main-source)
889 ;;;; Comment
892 "Parse a comment.
894 Return a list whose car is `comment' and cdr is a plist
895 containing `:begin', `:end', `:value' and `:post-blank'
896 keywords."
900 ;; First type of comment: comments at column 0.
910 ;; Second type of comment: indented comments.
918 ;; Get comments ending. This may not be accurate if
919 ;; commented lines within an item are followed by commented
920 ;; lines outside of the list. Though, parser will always
921 ;; get it right as it already knows surrounding element and
922 ;; has narrowed buffer to its contents.
925 ;; Find position after blank.
937 "Interpret COMMENT element as Org syntax.
938 CONTENTS is nil."
942 ;;;; Comment Block
945 "Parse an export block.
947 Return a list whose car is `comment-block' and cdr is a plist
948 containing `:begin', `:end', `:hiddenp', `:value' and
949 `:post-blank' keywords."
975 "Interpret COMMENT-BLOCK element as Org syntax.
976 CONTENTS is nil."
983 ;;;; Example Block
986 "Parse an example block.
988 Return a list whose car is `example' and cdr is a plist
989 containing `:begin', `:end', `:options', `:hiddenp', `:value' and
990 `:post-blank' keywords."
1019 "Interpret EXAMPLE-BLOCK element as Org syntax.
1020 CONTENTS is nil."
1028 ;;;; Export Block
1031 "Parse an export block.
1033 Return a list whose car is `export-block' and cdr is a plist
1034 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1035 `:post-blank' keywords."
1065 "Interpret EXPORT-BLOCK element as Org syntax.
1066 CONTENTS is nil."
1073 ;;;; Fixed-width
1076 "Parse a fixed-width section.
1078 Return a list whose car is `fixed-width' and cdr is a plist
1079 containing `:begin', `:end', `:value' and `:post-blank'
1080 keywords."
1082 beg-area begin end value pos-before-blank keywords)
1084 ;; Move to the beginning of the fixed-width area.
1090 ;; Get affiliated keywords, if any.
1092 ;; Store true beginning of element.
1094 ;; Get ending of fixed-width area. If point is in a list,
1095 ;; ensure to not get outside of it.
1104 ;; Find position after blank
1107 ;; Extract value.
1117 "Interpret FIXED-WIDTH element as Org syntax.
1118 CONTENTS is nil."
1122 ;;;; Horizontal Rule
1125 "Parse an horizontal rule.
1127 Return a list whose car is `horizontal-rule' and cdr is
1128 a plist containing `:begin', `:end' and `:post-blank'
1129 keywords."
1143 "Interpret HORIZONTAL-RULE element as Org syntax.
1144 CONTENTS is nil."
1148 ;;;; Keyword
1151 "Parse a keyword at point.
1153 Return a list whose car is `keyword' and cdr is a plist
1154 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1155 keywords."
1174 "Interpret KEYWORD element as Org syntax.
1175 CONTENTS is nil."
1181 ;;;; Latex Environment
1184 "Parse a LaTeX environment.
1186 Return a list whose car is `latex-environment' and cdr is a plist
1187 containing `:begin', `:end', `:value' and `:post-blank' keywords."
1208 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1209 CONTENTS is nil."
1213 ;;;; Paragraph
1216 "Parse a paragraph.
1218 Return a list whose car is `paragraph' and cdr is a plist
1219 containing `:begin', `:end', `:contents-begin' and
1220 `:contents-end' and `:post-blank' keywords.
1222 Assume point is at the beginning of the paragraph."
1245 "Interpret PARAGRAPH element as Org syntax.
1246 CONTENTS is the contents of the element."
1247 contents)
1250 ;;;; Property Drawer
1253 "Parse a property drawer.
1255 Return a list whose car is `property-drawer' and cdr is a plist
1256 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1257 `:contents-end', `:properties' and `:post-blank' keywords."
1274 val))
1276 val))
1290 "Interpret PROPERTY-DRAWER element as Org syntax.
1291 CONTENTS is nil."
1301 ;;;; Quote Section
1304 "Parse a quote section.
1306 Return a list whose car is `quote-section' and cdr is a plist
1307 containing `:begin', `:end', `:value' and `:post-blank'
1308 keywords.
1310 Assume point is at beginning of the section."
1326 "Interpret QUOTE-SECTION element as Org syntax.
1327 CONTENTS is nil."
1331 ;;;; Src Block
1334 "Parse a src block.
1336 Return a list whose car is `src-block' and cdr is a plist
1337 containing `:language', `:switches', `:parameters', `:begin',
1338 `:end', `:hiddenp', `:contents-begin', `:contents-end', `:value'
1339 and `:post-blank' keywords."
1343 ;; Get position at beginning of block.
1350 nil t))
1351 ;; Get language as a string.
1353 ;; Get switches.
1355 ;; Get parameters.
1357 ;; Get affiliated keywords.
1359 ;; Get beginning position.
1361 ;; Get position at end of block.
1365 ;; Retrieve code.
1371 ;; Get position after ending blank lines.
1374 ;; Get visibility status.
1390 "Interpret SRC-BLOCK element as Org syntax.
1391 CONTENTS is nil."
1410 value
1414 ;;;; Table
1417 "Parse a table at point.
1419 Return a list whose car is `table' and cdr is a plist containing
1420 `:begin', `:end', `:contents-begin', `:contents-end', `:tblfm',
1421 `:type', `:raw-table' and `:post-blank' keywords."
1446 "Interpret TABLE element as Org syntax.
1447 CONTENTS is nil."
1451 ;;;; Verse Block
1454 "Parse a verse block.
1456 Return a list whose car is `verse-block' and cdr is a plist
1457 containing `:begin', `:end', `:hiddenp', `:raw-value', `:value'
1458 and `:post-blank' keywords.
1460 Assume point is at beginning or end of the block."
1491 "Interpret VERSE-BLOCK element as Org syntax.
1492 CONTENTS is nil."
1498 \f
1499 ;;; Objects
1501 ;; Unlike to elements, interstices can be found between objects.
1502 ;; That's why, along with the parser, successor functions are provided
1503 ;; for each object. Some objects share the same successor
1504 ;; (i.e. `emphasis' and `verbatim' objects).
1506 ;; A successor must accept a single argument bounding the search. It
1507 ;; will return either a cons cell whose car is the object's type, as
1508 ;; a symbol, and cdr the position of its next occurrence, or nil.
1510 ;; Successors follow the naming convention:
1511 ;; org-element-NAME-successor, where NAME is the name of the
1512 ;; successor, as defined in `org-element-all-successors'.
1514 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1515 ;; object types they can contain will be specified in
1516 ;; `org-element-object-restrictions'.
1518 ;; Adding a new type of object is simple. Implement a successor,
1519 ;; a parser, and an interpreter for it, all following the naming
1520 ;; convention. Register successor in `org-element-all-successors',
1521 ;; maybe tweak restrictions about it, and that's it.
1523 ;;;; Emphasis
1526 "Parse text markup object at point.
1528 Return a list whose car is `emphasis' and cdr is a plist with
1529 `:marker', `:begin', `:end', `:contents-begin' and
1530 `:contents-end' and `:post-blank' keywords.
1532 Assume point is at the first emphasis marker."
1552 "Interpret EMPHASIS object as Org syntax.
1553 CONTENTS is the contents of the object."
1558 "Search for the next emphasis or verbatim object.
1560 LIMIT bounds the search.
1562 Return value is a cons cell whose car is `emphasis' or
1563 `verbatim' and cdr is beginning position."
1568 'verbatim
1572 ;;;; Entity
1575 "Parse entity at point.
1577 Return a list whose car is `entity' and cdr a plist with
1578 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
1579 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
1580 keywords.
1582 Assume point is at the beginning of the entity."
1606 "Interpret ENTITY object as Org syntax.
1607 CONTENTS is nil."
1613 "Search for the next latex-fragment or entity object.
1615 LIMIT bounds the search.
1617 Return value is a cons cell whose car is `entity' or
1618 `latex-fragment' and cdr is beginning position."
1621 ;; ENTITY-RE matches both LaTeX commands and Org entities.
1628 limit t)
1631 ;; Determine if it's a real entity or a LaTeX command.
1634 ;; No entity nor command: point is at a LaTeX fragment.
1635 ;; Determine its type to get the correct beginning position.
1643 matchers)
1647 ;;;; Export Snippet
1650 "Parse export snippet at point.
1652 Return a list whose car is `export-snippet' and cdr a plist with
1653 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
1654 keywords.
1656 Assume point is at the beginning of the snippet."
1674 "Interpret EXPORT-SNIPPET object as Org syntax.
1675 CONTENTS is nil."
1681 "Search for the next export-snippet object.
1683 LIMIT bounds the search.
1685 Return value is a cons cell whose car is `export-snippet' cdr is
1686 its beginning position."
1695 ;;;; Footnote Reference
1698 "Parse footnote reference at point.
1700 Return a list whose car is `footnote-reference' and cdr a plist
1701 with `:label', `:type', `:definition', `:begin', `:end' and
1702 `:post-blank' as keywords."
1724 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
1725 CONTENTS is nil."
1734 "Search for the next footnote-reference object.
1736 LIMIT bounds the search.
1738 Return value is a cons cell whose car is `footnote-reference' and
1739 cdr is beginning position."
1745 ;;;; Inline Babel Call
1748 "Parse inline babel call at point.
1750 Return a list whose car is `inline-babel-call' and cdr a plist with
1751 `:begin', `:end', `:info' and `:post-blank' as keywords.
1753 Assume point is at the beginning of the babel call."
1769 "Interpret INLINE-BABEL-CALL object as Org syntax.
1770 CONTENTS is nil."
1776 ;; Remove redundant square brackets.
1779 main-source)
1783 "Search for the next inline-babel-call object.
1785 LIMIT bounds the search.
1787 Return value is a cons cell whose car is `inline-babel-call' and
1788 cdr is beginning position."
1790 ;; Use a simplified version of
1791 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
1793 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
1794 limit t)
1798 ;;;; Inline Src Block
1801 "Parse inline source block at point.
1803 Return a list whose car is `inline-src-block' and cdr a plist
1804 with `:begin', `:end', `:language', `:value', `:parameters' and
1805 `:post-blank' as keywords.
1807 Assume point is at the beginning of the inline src block."
1827 "Interpret INLINE-SRC-BLOCK object as Org syntax.
1828 CONTENTS is nil."
1833 language
1835 body)))
1838 "Search for the next inline-babel-call element.
1840 LIMIT bounds the search.
1842 Return value is a cons cell whose car is `inline-babel-call' and
1843 cdr is beginning position."
1849 ;;;; Latex Fragment
1852 "Parse latex fragment at point.
1854 Return a list whose car is `latex-fragment' and cdr a plist with
1855 `:value', `:begin', `:end', and `:post-blank' as keywords.
1857 Assume point is at the beginning of the latex fragment."
1871 ;; None found: it's a macro.
1885 "Interpret LATEX-FRAGMENT object as Org syntax.
1886 CONTENTS is nil."
1889 ;;;; Line Break
1892 "Parse line break at point.
1894 Return a list whose car is `line-break', and cdr a plist with
1895 `:begin', `:end' and `:post-blank' keywords.
1897 Assume point is at the beginning of the line break."
1903 "Interpret LINE-BREAK object as Org syntax.
1904 CONTENTS is nil."
1908 "Search for the next line-break object.
1910 LIMIT bounds the search.
1912 Return value is a cons cell whose car is `line-break' and cdr is
1913 beginning position."
1917 ;; A line break can only happen on a non-empty line.
1922 ;;;; Link
1925 "Parse link at point.
1927 Return a list whose car is `link' and cdr a plist with `:type',
1928 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
1929 `:contents-end' and `:post-blank' as keywords.
1931 Assume point is at the beginning of the link."
1934 end contents-begin contents-end link-end post-blank path type
1935 raw-link link)
1937 ;; Type 1: Text targeted from a radio target.
1942 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
1947 ;; RAW-LINK is the original link.
1952 ;; Determine TYPE of link and set PATH accordingly.
1954 ;; File type.
1957 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
1960 ;; Ref type: PATH is the name of the target element.
1963 ;; Id type: PATH is the id.
1966 ;; Code-ref type: PATH is the name of the reference.
1969 ;; Custom-id type: PATH is the name of the custom id.
1972 ;; Fuzzy type: Internal link either matches a target, an
1973 ;; headline name or nothing. PATH is the target or headline's
1974 ;; name.
1976 ;; Type 3: Plain link, i.e. http://orgmode.org
1982 ;; Type 4: Angular link, i.e. <http://orgmode.org>
1989 ;; In any case, deduce end point after trailing white space from
1990 ;; LINK-END variable.
2004 "Interpret LINK object as Org syntax.
2005 CONTENTS is the contents of the object."
2011 raw-link
2015 "Search for the next link object.
2017 LIMIT bounds the search.
2019 Return value is a cons cell whose car is `link' and cdr is
2020 beginning position."
2025 org-any-link-re)))
2030 ;;;; Macro
2033 "Parse macro at point.
2035 Return a list whose car is `macro' and cdr a plist with `:key',
2036 `:args', `:begin', `:end', `:value' and `:post-blank' as
2037 keywords.
2039 Assume point is at the macro."
2053 ;; Repair bad splits.
2068 "Interpret MACRO object as Org syntax.
2069 CONTENTS is nil."
2073 "Search for the next macro object.
2075 LIMIT bounds the search.
2077 Return value is cons cell whose car is `macro' and cdr is
2078 beginning position."
2082 limit t)
2086 ;;;; Radio-target
2089 "Parse radio target at point.
2091 Return a list whose car is `radio-target' and cdr a plist with
2092 `:begin', `:end', `:contents-begin', `:contents-end', `raw-value'
2093 and `:post-blank' as keywords.
2095 Assume point is at the radio target."
2114 "Interpret TARGET object as Org syntax.
2115 CONTENTS is the contents of the object."
2119 "Search for the next radio-target object.
2121 LIMIT bounds the search.
2123 Return value is a cons cell whose car is `radio-target' and cdr
2124 is beginning position."
2130 ;;;; Statistics Cookie
2133 "Parse statistics cookie at point.
2135 Return a list whose car is `statistics-cookie', and cdr a plist
2136 with `:begin', `:end', `:value' and `:post-blank' keywords.
2138 Assume point is at the beginning of the statistics-cookie."
2154 "Interpret STATISTICS-COOKIE object as Org syntax.
2155 CONTENTS is nil."
2159 "Search for the next statistics cookie object.
2161 LIMIT bounds the search.
2163 Return value is a cons cell whose car is `statistics-cookie' and
2164 cdr is beginning position."
2170 ;;;; Subscript
2173 "Parse subscript at point.
2175 Return a list whose car is `subscript' and cdr a plist with
2176 `:begin', `:end', `:contents-begin', `:contents-end',
2177 `:use-brackets-p' and `:post-blank' as keywords.
2179 Assume point is at the underscore."
2183 t
2201 "Interpret SUBSCRIPT object as Org syntax.
2202 CONTENTS is the contents of the object."
2205 contents))
2208 "Search for the next sub/superscript object.
2210 LIMIT bounds the search.
2212 Return value is a cons cell whose car is either `subscript' or
2213 `superscript' and cdr is beginning position."
2220 ;;;; Superscript
2223 "Parse superscript at point.
2225 Return a list whose car is `superscript' and cdr a plist with
2226 `:begin', `:end', `:contents-begin', `:contents-end',
2227 `:use-brackets-p' and `:post-blank' as keywords.
2229 Assume point is at the caret."
2233 t
2251 "Interpret SUPERSCRIPT object as Org syntax.
2252 CONTENTS is the contents of the object."
2255 contents))
2258 ;;;; Target
2261 "Parse target at point.
2263 Return a list whose car is `target' and cdr a plist with
2264 `:begin', `:end', `:contents-begin', `:contents-end', `raw-value'
2265 and `:post-blank' as keywords.
2267 Assume point is at the target."
2286 "Interpret TARGET object as Org syntax.
2287 CONTENTS is the contents of target."
2291 "Search for the next target object.
2293 LIMIT bounds the search.
2295 Return value is a cons cell whose car is `target' and cdr is
2296 beginning position."
2302 ;;;; Time-stamp
2305 "Parse time stamp at point.
2307 Return a list whose car is `time-stamp', and cdr a plist with
2308 `:appt-type', `:type', `:begin', `:end', `:value' and
2309 `:post-blank' keywords.
2311 Assume point is at the beginning of the time-stamp."
2349 "Interpret TIME-STAMP object as Org syntax.
2350 CONTENTS is nil."
2359 "Search for the next time-stamp object.
2361 LIMIT bounds the search.
2363 Return value is a cons cell whose car is `time-stamp' and cdr is
2364 beginning position."
2369 org-ts-regexp-both
2374 limit t)
2378 ;;;; Verbatim
2381 "Parse verbatim object at point.
2383 Return a list whose car is `verbatim' and cdr is a plist with
2384 `:marker', `:begin', `:end' and `:post-blank' keywords.
2386 Assume point is at the first verbatim marker."
2404 "Interpret VERBATIM object as Org syntax.
2405 CONTENTS is nil."
2411 \f
2412 ;;; Definitions And Rules
2414 ;; Define elements, greater elements and specify recursive objects,
2415 ;; along with the affiliated keywords recognized. Also set up
2416 ;; restrictions on recursive objects combinations.
2418 ;; These variables really act as a control center for the parsing
2419 ;; process.
2422 ;; Headlines and inlinetasks.
2424 ;; Comments, blocks (any type), keywords and babel calls.
2426 ;; Lists.
2428 ;; Fixed-width, drawers (any type) and tables.
2430 ;; Footnote definitions.
2432 ;; Horizontal rules.
2434 ;; LaTeX environments.
2440 export-block fixed-width footnote-definition headline
2441 horizontal-rule inlinetask item keyword latex-environment
2442 babel-call paragraph plain-list property-drawer quote-block
2443 quote-section section special-block src-block table
2444 verse-block)
2449 item plain-list quote-block section special-block)
2454 latex-or-entity line-break link macro radio-target
2455 statistics-cookie sub/superscript target text-markup
2456 time-stamp)
2463 "Alist of translations between object type and successor name.
2465 Sharing the same successor comes handy when, for example, the
2494 "Alist of usual translations for keywords.
2495 The key is the old name and the value the new one. The property
2500 "List of affiliated keywords that can occur more that once in an element.
2502 Their value will be consed into a list of strings, which will be
2503 returned as the value of the property.
2505 This list is checked after translations have been applied. See
2509 "List of keywords whose value can be parsed.
2511 Their value will be stored as a secondary string: a list of
2512 strings and objects.
2514 This list is checked after translations have been applied. See
2518 "List of keywords which can have a secondary value.
2520 In Org syntax, they can be written with optional square brackets
2521 before the colons. For example, results keyword can be
2522 associated to a hash value with the following:
2524 #+results[hash-string]: some-source
2526 This list is checked after translations have been applied. See
2541 "Alist of recursive objects restrictions.
2543 Car is a recursive object type and cdr is a list of successors
2544 that will be called within an object of such type.
2546 For example, in a `radio-target' object, one can only find
2547 entities, export snippets, latex-fragments, subscript and
2560 latex-fragment line-break link macro radio-target
2562 "Alist of secondary strings restrictions.
2564 When parsed, some elements have a secondary string which could
2565 contain various objects (i.e. headline's name, or table's cells).
2566 For association, the car is the element type, and the cdr a list
2567 of successors that will be called in that secondary string.
2569 Note: `keyword' secondary string type only applies to keywords
2573 \f
2574 ;;; Accessors
2575 ;;
2576 ;; Provide two accessors: `org-element-get-property' and
2577 ;; `org-element-get-contents'.
2580 "Extract the value from the PROPERTY of an ELEMENT."
2584 "Extract contents from an ELEMENT."
2588 \f
2589 ;; Obtaining The Smallest Element Containing Point
2591 ;; `org-element-at-point' is the core function of this section. It
2592 ;; returns the Lisp representation of the element at point. It uses
2593 ;; `org-element-guess-type' and `org-element-skip-keywords' as helper
2594 ;; functions.
2596 ;; When point is at an item, there is no automatic way to determine if
2597 ;; the function should return the `plain-list' element, or the
2598 ;; corresponding `item' element. By default, `org-element-at-point'
2599 ;; works at the `plain-list' level. But, by providing an optional
2600 ;; argument, one can make it switch to the `item' level.
2611 "Regexp matching any affiliated keyword.
2613 Keyword name is put in match group 1. Moreover, if keyword
2614 belongs to `org-element-dual-keywords', put the dual value in
2615 match group 2.
2620 "Determine closest element around point.
2622 Return value is a list \(TYPE PROPS\) where TYPE is the type of
2623 the element and PROPS a plist of properties associated to the
2624 element.
2626 Possible types are defined in `org-element-all-elements'.
2628 Optional argument SPECIAL, when non-nil, can be either `item' or
2629 `section'. The former allows to parse item wise instead of
2630 plain-list wise, using STRUCTURE as the current list structure.
2631 The latter will try to parse a section before anything else.
2633 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
2634 be computed."
2637 ;; Move before any blank line.
2642 ;; Check if point is at an affiliated keyword. In that case,
2643 ;; try moving to the beginning of the associated element. If
2644 ;; the keyword is orphaned, treat it as plain text.
2651 ;; Guessing element type on the current line is impossible:
2652 ;; try to find the beginning of the current element to get
2653 ;; more information.
2662 ;; Unable to find a paragraph delimiter above: we're at
2663 ;; bob and looking at a paragraph.
2665 ;; Trying to find element's beginning set point back to
2666 ;; its original position. There's something peculiar on
2667 ;; this line that prevents parsing, probably an
2668 ;; ill-formed keyword or an undefined drawer name. Parse
2669 ;; it as plain text anyway.
2671 ;; Original point wasn't in a list but previous paragraph
2672 ;; is. It means that either point was inside some block,
2673 ;; or current list was ended without using a blank line.
2674 ;; In the last case, paragraph really starts at list end.
2691 ;; In any other case, the paragraph started the line
2692 ;; below.
2698 ;; Straightforward case: call the appropriate parser.
2702 ;; It is obvious to tell if point is in most elements, either by
2703 ;; looking for a specific regexp in the current line, or by using
2704 ;; already implemented functions. This is the goal of
2705 ;; `org-element-guess-type'.
2709 "List of non-recursive block types, as strings.
2710 Used internally by `org-element-guess-type'. Do not modify it
2714 "Return the type of element at point, or nil if undetermined.
2716 This function may move point to an appropriate position for
2717 parsing. Used internally by `org-element-at-point'.
2719 When optional argument SECTION-MODE is non-nil, try to find if
2720 point is in a section in priority."
2721 ;; Beware: Order matters for some cases in that function.
2730 headline))))
2731 ;; Move to section beginning.
2737 ;; Any buffer position not at an headline or in a quote section
2738 ;; is inside a section, provided function is actively looking for
2739 ;; them.
2741 ;; Non-recursive block.
2747 ;; Property drawer. Almost `org-at-property-p', but allow drawer
2748 ;; boundaries.
2756 ;; Recursive block. If the block isn't complete, parse the
2757 ;; current part as a paragraph.
2765 ;; Regular drawers must be tested after property drawer as both
2766 ;; elements share the same ending regexp.
2773 ;; Babel calls must be tested before general keywords as they are
2774 ;; a subset of them.
2779 'paragraph
2781 ;; Dynamic block: simplify regexp used for match. If it isn't
2782 ;; complete, parse the current part as a paragraph.
2794 ;; A TBLFM line separated from any table is just plain text.
2799 ;; Most elements can have affiliated keywords. When looking for an
2800 ;; element beginning, we want to move before them, as they belong to
2801 ;; that element, and, in the meantime, collect information they give
2802 ;; into appropriate properties. Hence the following function.
2804 ;; Usage of optional arguments may not be obvious at first glance:
2806 ;; - TRANS-LIST is used to polish keywords names that have evolved
2807 ;; during Org history. In example, even though =result= and
2808 ;; =results= coexist, we want to have them under the same =result=
2809 ;; property. It's also true for "srcname" and "name", where the
2810 ;; latter seems to be preferred nowadays (thus the "name" property).
2812 ;; - CONSED allows to regroup multi-lines keywords under the same
2813 ;; property, while preserving their own identity. This is mostly
2814 ;; used for "attr_latex" and al.
2816 ;; - PARSED prepares a keyword value for export. This is useful for
2817 ;; "caption". Objects restrictions for such keywords are defined in
2818 ;; `org-element-string-restrictions'.
2820 ;; - DUALS is used to take care of keywords accepting a main and an
2821 ;; optional secondary values. For example "results" has its
2822 ;; source's name as the main value, and may have an hash string in
2823 ;; optional square brackets as the secondary one.
2825 ;; A keyword may belong to more than one category.
2828 consed parsed duals)
2829 "Collect affiliated keywords before point.
2831 Optional argument KEY-RE is a regexp matching keywords, which
2832 puts matched keyword in group 1. It defaults to
2833 `org-element--affiliated-re'.
2835 TRANS-LIST is an alist where key is the keyword and value the
2836 property name it should be translated to, without the colons. It
2837 defaults to `org-element-keyword-translation-alist'.
2839 CONSED is a list of strings. Any keyword belonging to that list
2840 will have its value consed. The check is done after keyword
2841 translation. It defaults to `org-element-multiple-keywords'.
2843 PARSED is a list of strings. Any keyword member of this list
2844 will have its value parsed. The check is done after keyword
2845 translation. If a keyword is a member of both CONSED and PARSED,
2846 it's value will be a list of parsed strings. It defaults to
2847 `org-element-parsed-keywords'.
2849 DUALS is a list of strings. Any keyword member of this list can
2850 have two parts: one mandatory and one optional. Its value is
2851 a cons cell whose car is the former, and the cdr the latter. If
2852 a keyword is a member of both PARSED and DUALS, both values will
2853 be parsed. It defaults to `org-element-dual-keywords'.
2855 Return a list whose car is the position at the first of them and
2856 cdr a plist of keywords and values."
2864 ;; RESTRICT is the list of objects allowed in parsed
2865 ;; keywords value.
2867 output)
2872 ;; Apply translation to RAW-KWD. From there, KWD is
2873 ;; the official keyword.
2875 ;; Find main value for any keyword.
2881 ;; If KWD is a dual keyword, find its secondary
2882 ;; value. Maybe parse it.
2888 ;; Attribute a property name to KWD.
2890 ;; Now set final shape for VALUE.
2894 ;; VALUE is mandatory. Set it to nil if there is none.
2898 ;; Eventually store the new value in OUTPUT.
2904 \f
2905 ;;; The Org Parser
2907 ;; The two major functions here are `org-element-parse-buffer', which
2908 ;; parses Org syntax inside the current buffer, taking into account
2909 ;; region, narrowing, or even visibility if specified, and
2910 ;; `org-element-parse-secondary-string', which parses objects within
2911 ;; a given string.
2913 ;; The (almost) almighty `org-element-map' allows to apply a function
2914 ;; on elements or objects matching some type, and accumulate the
2915 ;; resulting values. In an export situation, it also skips unneeded
2916 ;; parts of the parse tree, transparently walks into included files,
2917 ;; and maintain a list of local properties (i.e. those inherited from
2918 ;; parent headlines) for function's consumption.
2921 "Recursively parse the buffer and return structure.
2922 If narrowing is in effect, only parse the visible part of the
2923 buffer.
2925 Optional argument GRANULARITY determines the depth of the
2926 recursion. It can be set to the following symbols:
2928 `headline' Only parse headlines.
2929 `greater-element' Don't recurse into greater elements. Thus,
2930 elements parsed are the top-level ones.
2931 `element' Parse everything but objects and plain text.
2932 `object' Parse the complete buffer (default).
2934 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
2935 elements.
2937 Assume buffer is in Org mode."
2944 ;; Start is section mode so text before the first headline
2945 ;; belongs to a section.
2949 "Recursively parse objects in STRING and return structure.
2951 RESTRICTION, when non-nil, is a symbol limiting the object types
2952 that will be looked after.
2954 Optional argument BUFFER indicates the buffer from where the
2955 secondary string was extracted. It is used to determine where to
2956 get extraneous information for an object \(i.e. when resolving
2957 a link or looking for a footnote definition\). It defaults to
2958 the current buffer."
2964 "Map a function on selected elements or objects.
2966 DATA is the parsed tree, as returned by, i.e,
2967 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
2968 of elements or objects types. FUN is the function called on the
2969 matching element or object. It must accept two arguments: the
2970 element or object itself and a plist holding contextual
2971 information.
2973 When optional argument INFO is non-nil, it should be a plist
2974 holding export options. In that case, parts of the parse tree
2975 not exportable according to that property list will be skipped
2976 and files included through a keyword will be visited.
2978 When optional argument FIRST-MATCH is non-nil, stop at the first
2979 match for which FUN doesn't return nil, and return that value.
2981 Nil values returned from FUN are ignored in the result."
2982 ;; Ensure TYPES is a list, even of one element.
2984 ;; Recursion depth is determined by --CATEGORY.
2994 walk-tree ; For byte-compiler
2995 --acc
2999 ;; Check if TYPE is matching among TYPES. If so, apply
3000 ;; FUN to --BLOB and accumulate return value
3001 ;; into --ACC. --LOCAL is the communication channel.
3010 ;; Recursively walk DATA. --LOCAL, if non-nil, is
3011 ;; a plist holding contextual information.
3015 ;; Determine if a recursion into --BLOB is
3016 ;; possible and allowed.
3018 ;; Element or object not exportable.
3020 ;; Archived headline: Maybe apply fun on it, but
3021 ;; skip contents.
3027 ;; Limiting recursion to greater elements, and --BLOB
3028 ;; isn't one.
3032 ;; Limiting recursion to elements, and --BLOB only
3033 ;; contains objects.
3035 ;; No limitation on recursion, but --BLOB hasn't
3036 ;; got a recursive type.
3042 ;; Recursion is possible and allowed: Update local
3043 ;; information and move into --BLOB.
3046 walk-tree --blob
3048 --local
3049 `(:genealogy
3054 ;; Return value in a proper order.
3057 ;; The following functions are internal parts of the parser.
3059 ;; The first one, `org-element-parse-elements' acts at the element's
3060 ;; level. As point is always at the beginning of an element during
3061 ;; parsing, it doesn't have to rely on `org-element-at-point'.
3062 ;; Instead, it calls a more restrictive, though way quicker,
3063 ;; alternative: `org-element-current-element'. That function
3064 ;; internally uses `org-element--element-block-re' for quick access to
3065 ;; a common regexp.
3067 ;; The second one, `org-element-parse-objects' applies on all objects
3068 ;; of a paragraph or a secondary string. It uses
3069 ;; `org-element-get-candidates' to optimize the search of the next
3070 ;; object in the buffer.
3072 ;; More precisely, that function looks for every allowed object type
3073 ;; first. Then, it discards failed searches, keeps further matches,
3074 ;; and searches again types matched behind point, for subsequent
3075 ;; calls. Thus, searching for a given type fails only once, and every
3076 ;; object is searched only once at top level (but sometimes more for
3077 ;; nested types).
3081 "Parse elements between BEG and END positions.
3083 SPECIAL prioritize some elements over the others. It can set to
3084 `quote-section', `section' or `item', which will focus search,
3085 respectively, on quote sections, sections and items. Moreover,
3086 when value is `item', STRUCTURE will be used as the current list
3087 structure.
3089 GRANULARITY determines the depth of the recursion. It can be set
3090 to the following symbols:
3092 `headline' Only parse headlines.
3093 `greater-element' Don't recurse into greater elements. Thus,
3094 elements parsed are the top-level ones.
3095 `element' Parse everything but objects and plain text.
3096 `object' or nil Parse the complete buffer.
3098 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3099 elements.
3101 Elements are accumulated into ACC."
3106 ;; When parsing only headlines, skip any text before first one.
3109 ;; Main loop start.
3112 ;; 1. Item mode is active: point must be at an item. Parse it
3113 ;; directly, skipping `org-element-current-element'.
3121 ;; 2. When ITEM is nil, find current element's type and parse
3122 ;; it accordingly to its category.
3126 ;; Case 1. ELEMENT is a paragraph. Parse objects inside,
3127 ;; if GRANULARITY allows it.
3134 ;; Case 2. ELEMENT is recursive: parse it between
3135 ;; `contents-begin' and `contents-end'. Make sure
3136 ;; GRANULARITY allows the recursion, or ELEMENT is an
3137 ;; headline, in which case going inside is mandatory, in
3138 ;; order to get sub-level headings. If VISIBLE-ONLY is
3139 ;; true and element is hidden, do not recurse into it.
3149 ;; At a plain list, switch to item mode. At an
3150 ;; headline, switch to section mode. Any other
3151 ;; element turns off special modes.
3155 'quote-section
3159 ;; Case 3. Else, just accumulate ELEMENT.
3161 acc)))
3162 ;; Return result.
3168 'regexp-quote
3170 "Regexp matching the beginning of a non-recursive block type.
3171 Used internally by `org-element-current-element'. Do not modify
3175 "Parse the element at point.
3177 Return value is a list \(TYPE PROPS\) where TYPE is the type of
3178 the element and PROPS a plist of properties associated to the
3179 element.
3181 Possible types are defined in `org-element-all-elements'.
3183 Optional argument SPECIAL, when non-nil, can be either `item',
3184 `section' or `quote-section'. `item' allows to parse item wise
3185 instead of plain-list wise, using STRUCTURE as the current list
3186 structure. `section' (resp. `quote-section') will try to parse
3187 a section (resp. a quote section) before anything else.
3189 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3190 be computed.
3192 Unlike to `org-element-at-point', this function assumes point is
3193 always at the beginning of the element it has to parse. As such,
3194 it is quicker than its counterpart and always accurate, albeit
3195 more restrictive."
3198 ;; If point is at an affiliated keyword, try moving to the
3199 ;; beginning of the associated element. If none is found, the
3200 ;; keyword is orphaned and will be treated as plain text.
3207 ;; Headline.
3210 ;; Quote section.
3212 ;; Section.
3214 ;; Non-recursive block.
3220 ;; Build appropriate parser.
3225 org-element-non-recursive-block-alist)))))
3227 ;; Inlinetask.
3229 ;; LaTeX Environment or paragraph if incomplete.
3235 ;; Property drawer.
3240 ;; Recursive block, or paragraph if incomplete.
3251 ;; Drawer.
3257 ;; Babel call.
3260 ;; Keyword, or paragraph if at an affiliated keyword.
3267 ;; Footnote definition.
3270 ;; Dynamic block or paragraph if incomplete.
3276 ;; Comment.
3279 ;; Horizontal rule.
3282 ;; Table.
3284 ;; List or item.
3289 ;; Default element: Paragraph.
3293 "Parse objects between BEG and END and return recursive structure.
3295 Objects are accumulated in ACC.
3297 RESTRICTION, when non-nil, is a list of object types which are
3298 allowed in the current object."
3302 ;; Return the parsing function associated to the nearest
3303 ;; object among list of candidates CAND.
3310 next-object candidates)
3314 end restriction candidates))
3316 ;; 1. Text before any object. Untabify it.
3322 acc)))
3323 ;; 2. Object...
3327 cont-beg)
3328 ;; ... recursive. The CONT-BEG check is for
3329 ;; links, as some of them might not be recursive
3330 ;; (i.e. plain links).
3333 cont-beg
3337 ;; Restrict allowed objects. This is the
3338 ;; intersection of current restriction and next
3339 ;; object's restriction.
3342 org-element-object-restrictions))))
3346 new-restr))))))
3347 ;; ... not recursive.
3348 next-object)
3349 acc)
3351 ;; 3. Text after last object. Untabify it.
3356 acc))
3357 ;; Result.
3361 "Return an alist of candidates for the next object.
3363 LIMIT bounds the search, and RESTRICTION, when non-nil, bounds
3364 the possible object types.
3366 Return value is an alist whose car is position and cdr the object
3367 type, as a string. There is an association for the closest
3368 object of each type within RESTRICTION when non-nil, or for every
3369 type otherwise.
3371 OBJECTS is the previous candidates alist."
3373 next-candidates types-to-search)
3374 ;; If no previous result, search every object type in RESTRICTION.
3375 ;; Otherwise, keep potential candidates (old objects located after
3376 ;; point) and ask to search again those which had matched before.
3381 objects))
3382 ;; Call the appropriate "get-next" function for each type to
3383 ;; search and accumulate matches.
3390 type))))
3393 types-to-search)
3394 ;; Return alist.
3395 next-candidates))
3398 \f
3399 ;;; Towards A Bijective Process
3401 ;; The parse tree obtained with `org-element-parse-buffer' is really
3402 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3403 ;; interpreted and expanded into a string with canonical Org
3404 ;; syntax. Hence `org-element-interpret-data'.
3405 ;;
3406 ;; Data parsed from secondary strings, whose shape is slightly
3407 ;; different than the standard parse tree, is expanded with the
3408 ;; equivalent function `org-element-interpret-secondary'.
3409 ;;
3410 ;; Both functions rely internally on
3411 ;; `org-element-interpret--affiliated-keywords'.
3414 "Interpret a parse tree representing Org data.
3416 DATA is the parse tree to interpret.
3418 Optional arguments GENEALOGY and PREVIOUS are used for recursive
3419 calls:
3420 GENEALOGY is the list of its parents types.
3421 PREVIOUS is the type of the element or object at the same level
3422 interpreted before.
3424 Return Org syntax as a string."
3427 ;; BLOB can be an element, an object, a string, or nil.
3439 ;; Full Org document.
3442 ;; Recursive objects.
3446 ;; Recursive elements.
3451 ;; Paragraphs.
3455 blob
3456 ;; When normalizing contents of an item,
3457 ;; ignore first line's indentation.
3464 ;; Update PREVIOUS.
3466 ;; Build white spaces.
3475 results
3481 "Interpret SECONDARY string as Org syntax.
3483 SECONDARY-STRING is a nested list as returned by
3484 `org-element-parse-secondary-string'.
3486 Return interpreted string."
3487 ;; Make SECONDARY acceptable for `org-element-interpret-data'.
3491 ;; Both functions internally use `org-element--affiliated-keywords'.
3494 "Return ELEMENT's affiliated keywords as Org syntax.
3495 If there is no affiliated keyword, return the empty string."
3505 value)
3516 ;; Remove translated keywords.
3521 org-element-affiliated-keywords))
3524 ;; Because interpretation of the parse tree must return the same
3525 ;; number of blank lines between elements and the same number of white
3526 ;; space after objects, some special care must be given to white
3527 ;; spaces.
3528 ;;
3529 ;; The first function, `org-element-normalize-string', ensures any
3530 ;; string different from the empty string will end with a single
3531 ;; newline character.
3532 ;;
3533 ;; The second function, `org-element-normalize-contents', removes
3534 ;; global indentation from the contents of the current element.
3537 "Ensure string S ends with a single newline character.
3539 If S isn't a string return it unchanged. If S is the empty
3540 string, return it. Otherwise, return a new string with a single
3541 newline character at its end."
3549 "Normalize plain text in ELEMENT's contents.
3551 ELEMENT must only contain plain text and objects.
3553 The following changes are applied to plain text:
3554 - Remove global indentation, preserving relative one.
3555 - Untabify it.
3557 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3558 indentation to compute maximal common indentation.
3560 Return the normalized element."
3566 ;; 1. Get maximal common indentation (MCI) among each string
3567 ;; in CONTENTS.
3578 object)))
3579 contents))
3582 ;; 2. Remove that indentation from CONTENTS. First string
3583 ;; must be treated differently because it's the only one
3584 ;; whose indentation doesn't happen after a newline
3585 ;; character.
3596 contents)))))))
3599 \f
3600 ;;; The Toolbox
3602 ;; Once the structure of an Org file is well understood, it's easy to
3603 ;; implement some replacements for `forward-paragraph'
3604 ;; `backward-paragraph', namely `org-element-forward' and
3605 ;; `org-element-backward'.
3607 ;; Also, `org-transpose-elements' mimics the behaviour of
3608 ;; `transpose-words', at the element's level, whereas
3609 ;; `org-element-drag-forward', `org-element-drag-backward', and
3610 ;; `org-element-up' generalize, respectively, functions
3611 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
3613 ;; `org-element-unindent-buffer' will, as its name almost suggests,
3614 ;; smartly remove global indentation from buffer, making it possible
3615 ;; to use Org indent mode on a file created with hard indentation.
3617 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
3618 ;; internally by some of the previously cited tools.
3621 "Non-nil when elements ELEM-A and ELEM-B are nested."
3630 "Swap elements ELEM-A and ELEM-B.
3632 Leave point at the end of ELEM-A.
3634 Assume ELEM-A is before ELEM-B and that they are not nested."
3656 "Move backward by one element."
3661 ;; At an headline. The previous element is the previous sibling,
3662 ;; or the parent if any.
3664 ;; Already at the beginning of the current element: move to the
3665 ;; beginning of the previous one.
3674 ;; When moving into a new list, go directly at the
3675 ;; beginning of the top list structure.
3683 ;; Else, move at the element beginning. One exception: if point
3684 ;; was in the blank lines after the end of a list, move directly
3685 ;; to the top item.
3692 opoint))
3699 "Drag backward element at point."
3716 ;; Compute new position of point: it's shifted by PREV-ELEM
3717 ;; body's length.
3724 "Move forward element at point."
3737 ;; Compute new position of point: it's shifted by NEXT-ELEM
3738 ;; body's length (without final blanks) and by the length of
3739 ;; blanks between ELEM and NEXT-ELEM.
3756 "Move forward by one element."
3767 ;; At an item: Either move to the next element inside, or
3768 ;; to its end if it's hidden.
3776 ;; At a recursive element: Either move inside, or if it's
3777 ;; hidden, move to its end.
3784 cbeg))))
3785 ;; Else: move to the current element's end.
3789 "Put point at beginning of this element, mark at end.
3791 Interactively, if this command is repeated or (in Transient Mark
3792 mode) if the mark is active, it marks the next element after the
3793 ones already marked."
3808 "Narrow buffer to current element."
3826 "Transpose current and previous elements, keeping blank lines between.
3827 Point is moved after both elements."
3846 "Un-indent the visible part of the buffer.
3847 Relative indentation \(between items, inside blocks, etc.\) isn't
3848 modified."
3853 unindent-tree ; For byte-compiler.
3871 "Move to upper element.
3872 Return position at the beginning of the upper element."
3883 ;; If parent is bound to be in the same list as the
3884 ;; original point, move to that parent.
3896 prev-elem)
3901 end)
3912 ;;; org-element.el ends here