| blob | add9740dbbcf8ff9cbcc9d9a9cea32c8e378ea99 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
45 ;;
46 ;; Other element types are: `babel-call', `clock', `comment',
47 ;; `comment-block', `example-block', `export-block', `fixed-width',
48 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
49 ;; `planning', `property-drawer', `quote-section', `src-block',
50 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
51 ;; and `verse-block' types can contain Org objects and plain text.
52 ;;
53 ;; Objects are related to document's contents. Some of them are
54 ;; recursive. Associated types are of the following: `bold', `code',
55 ;; `entity', `export-snippet', `footnote-reference',
56 ;; `inline-babel-call', `inline-src-block', `italic',
57 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
58 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
59 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
60 ;;
61 ;; Some elements also have special properties whose value can hold
62 ;; objects themselves (i.e. an item tag or an headline name). Such
63 ;; values are called "secondary strings". Any object belongs to
64 ;; either an element or a secondary string.
65 ;;
66 ;; Notwithstanding affiliated keywords, each greater element, element
67 ;; and object has a fixed set of properties attached to it. Among
68 ;; them, four are shared by all types: `:begin' and `:end', which
69 ;; refer to the beginning and ending buffer positions of the
70 ;; considered element or object, `:post-blank', which holds the number
71 ;; of blank lines, or white spaces, at its end and `:parent' which
72 ;; refers to the element or object containing it. Greater elements
73 ;; and elements containing objects will also have `:contents-begin'
74 ;; and `:contents-end' properties to delimit contents.
75 ;;
76 ;; Lisp-wise, an element or an object can be represented as a list.
77 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
78 ;; TYPE is a symbol describing the Org element or object.
79 ;; PROPERTIES is the property list attached to it. See docstring of
80 ;; appropriate parsing function to get an exhaustive
81 ;; list.
82 ;; CONTENTS is a list of elements, objects or raw strings contained
83 ;; in the current element or object, when applicable.
84 ;;
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
87 ;;
88 ;; The first part of this file implements a parser and an interpreter
89 ;; for each type of Org syntax.
90 ;;
91 ;; The next two parts introduce four accessors and a function
92 ;; retrieving the element starting at point (respectively
93 ;; `org-element-type', `org-element-property', `org-element-contents',
94 ;; `org-element-restriction' and `org-element-current-element').
95 ;;
96 ;; The following part creates a fully recursive buffer parser. It
97 ;; also provides a tool to map a function to elements or objects
98 ;; matching some criteria in the parse tree. Functions of interest
99 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
100 ;; extent, `org-element-parse-secondary-string'.
101 ;;
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
104 ;;
105 ;; The library ends by furnishing a set of interactive tools for
106 ;; element's navigation and manipulation, mostly based on
107 ;; `org-element-at-point' function.
110 ;;; Code:
117 \f
118 ;;; Definitions And Rules
119 ;;
120 ;; Define elements, greater elements and specify recursive objects,
121 ;; along with the affiliated keywords recognized. Also set up
122 ;; restrictions on recursive objects combinations.
123 ;;
124 ;; These variables really act as a control center for the parsing
125 ;; process.
128 ;; Headlines and inlinetasks.
130 ;; Comments, blocks (any type), keywords and babel calls.
132 ;; Lists.
134 ;; Fixed-width, drawers (any type) and tables.
136 ;; Footnote definitions.
138 ;; Horizontal rules.
140 ;; LaTeX environments.
142 ;; Planning and Clock lines.
152 export-block fixed-width footnote-definition headline
153 horizontal-rule inlinetask item keyword latex-environment
154 babel-call paragraph plain-list planning property-drawer
155 quote-block quote-section section special-block src-block table
156 table-row verse-block)
161 item plain-list quote-block section special-block table)
166 latex-or-entity line-break link macro radio-target
167 statistics-cookie sub/superscript table-cell target
168 text-markup timestamp)
177 "Alist of translations between object type and successor name.
179 Sharing the same successor comes handy when, for example, the
184 inline-src-block italic line-break latex-fragment link macro
185 radio-target statistics-cookie strike-through subscript superscript
186 table-cell target timestamp underline verbatim)
191 table-cell underline)
206 "Alist between block names and the associated parsing function.
207 Names must be uppercase. Any block whose name has no association
213 "List of affiliated keywords as strings.
219 ;; Regular affiliated keywords.
222 "Regexp matching any affiliated keyword.
224 Keyword name is put in match group 1. Moreover, if keyword
225 belongs to `org-element-dual-keywords', put the dual value in
226 match group 2.
234 "Alist of usual translations for keywords.
235 The key is the old name and the value the new one. The property
239 "List of affiliated keywords that can occur more that once in an element.
241 Their value will be consed into a list of strings, which will be
242 returned as the value of the property.
244 This list is checked after translations have been applied. See
245 `org-element-keyword-translation-alist'.
251 "List of keywords whose value can be parsed.
253 Their value will be stored as a secondary string: a list of
254 strings and objects.
256 This list is checked after translations have been applied. See
260 "List of keywords which can have a secondary value.
262 In Org syntax, they can be written with optional square brackets
263 before the colons. For example, results keyword can be
264 associated to a hash value with the following:
266 #+RESULTS[hash-string]: some-source
268 This list is checked after translations have been applied. See
275 inline-babel-call inline-src-block latex-fragment
276 line-break link macro radio-target sub/superscript
277 target text-markup timestamp)
279 macro radio-target statistics-cookie sub/superscript target
280 text-markup timestamp)
294 link radio-target sub/superscript target text-markup
295 timestamp)
306 latex-fragment line-break link macro radio-target
308 "Alist of objects restrictions.
310 CAR is an element or object type containing objects and CDR is
311 a list of successors that will be called within an element or
312 object of such type.
314 For example, in a `radio-target' object, one can only find
315 entities, export snippets, latex-fragments, subscript and
316 superscript.
318 This alist also applies to secondary string. For example, an
319 `headline' type element doesn't directly contain objects, but
330 \f
331 ;;; Greater elements
332 ;;
333 ;; For each greater element type, we define a parser and an
334 ;; interpreter.
335 ;;
336 ;; A parser returns the element or object as the list described above.
337 ;; Most of them accepts no argument. Though, exceptions exist. Hence
338 ;; every element containing a secondary string (see
339 ;; `org-element-secondary-value-alist') will accept an optional
340 ;; argument to toggle parsing of that secondary string. Moreover,
341 ;; `item' parser requires current list's structure as its first
342 ;; element.
343 ;;
344 ;; An interpreter accepts two arguments: the list representation of
345 ;; the element or object, and its contents. The latter may be nil,
346 ;; depending on the element or object considered. It returns the
347 ;; appropriate Org syntax, as a string.
348 ;;
349 ;; Parsing functions must follow the naming convention:
350 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
351 ;; defined in `org-element-greater-elements'.
352 ;;
353 ;; Similarly, interpreting functions must follow the naming
354 ;; convention: org-element-TYPE-interpreter.
355 ;;
356 ;; With the exception of `headline' and `item' types, greater elements
357 ;; cannot contain other greater elements of their own type.
358 ;;
359 ;; Beside implementing a parser and an interpreter, adding a new
360 ;; greater element requires to tweak `org-element-current-element'.
361 ;; Moreover, the newly defined type must be added to both
362 ;; `org-element-all-elements' and `org-element-greater-elements'.
365 ;;;; Center Block
368 "Parse a center block.
370 Return a list whose CAR is `center-block' and CDR is a plist
371 containing `:begin', `:end', `:hiddenp', `:contents-begin',
372 `:contents-end' and `:post-blank' keywords.
374 Assume point is at the beginning of the block."
397 "Interpret CENTER-BLOCK element as Org syntax.
398 CONTENTS is the contents of the element."
402 ;;;; Drawer
405 "Parse a drawer.
407 Return a list whose CAR is `drawer' and CDR is a plist containing
408 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
409 `:contents-end' and `:post-blank' keywords.
411 Assume point is at beginning of drawer."
436 "Interpret DRAWER element as Org syntax.
437 CONTENTS is the contents of the element."
440 contents))
443 ;;;; Dynamic Block
446 "Parse a dynamic block.
448 Return a list whose CAR is `dynamic-block' and CDR is a plist
449 containing `:block-name', `:begin', `:end', `:hiddenp',
450 `:contents-begin', `:contents-end', `:arguments' and
451 `:post-blank' keywords.
453 Assume point is at beginning of dynamic block."
480 "Interpret DYNAMIC-BLOCK element as Org syntax.
481 CONTENTS is the contents of the element."
486 contents))
489 ;;;; Footnote Definition
492 "Parse a footnote definition.
494 Return a list whose CAR is `footnote-definition' and CDR is
495 a plist containing `:label', `:begin' `:end', `:contents-begin',
496 `:contents-end' and `:post-blank' keywords.
498 Assume point is at the beginning of the footnote definition."
527 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
528 CONTENTS is the contents of the footnote-definition."
530 " "
531 contents))
534 ;;;; Headline
537 "Parse an headline.
539 Return a list whose CAR is `headline' and CDR is a plist
540 containing `:raw-value', `:title', `:begin', `:end',
541 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
542 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
543 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
544 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
545 keywords.
547 The plist also contains any property set in the property drawer,
548 with its name in lowercase, the underscores replaced with hyphens
549 and colons at the beginning (i.e. `:custom-id').
551 When RAW-SECONDARY-P is non-nil, headline's title will not be
552 parsed as a secondary string, but as a plain string instead.
554 Assume point is at beginning of the headline."
584 plist))
600 title)
601 ;; Clean RAW-VALUE from any quote or comment string.
606 ""
607 raw-value)))
608 ;; Clean TAGS from archive tag, if any.
610 ;; Then get TITLE.
641 "Interpret HEADLINE element as Org syntax.
642 CONTENTS is the contents of the element."
669 ;; Align tags.
677 ? )
678 tags))
682 tags))))
684 contents)))
687 ;;;; Inlinetask
690 "Parse an inline task.
692 Return a list whose CAR is `inlinetask' and CDR is a plist
693 containing `:title', `:begin', `:end', `:hiddenp',
694 `:contents-begin' and `:contents-end', `:level', `:priority',
695 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
696 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
698 The plist also contains any property set in the property drawer,
699 with its name in lowercase, the underscores replaced with hyphens
700 and colons at the beginning (i.e. `:custom-id').
702 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
703 title will not be parsed as a secondary string, but as a plain
704 string instead.
706 Assume point is at beginning of the inline task."
731 plist))
740 ;; In the case of a single line task, CONTENTS-BEGIN and
741 ;; CONTENTS-END might overlap.
764 ,@standard-props
768 "Interpret INLINETASK element as Org syntax.
769 CONTENTS is the contents of inlinetask."
784 ;; Align tags.
792 ? )
793 tags))
797 tags))))
798 ;; Prefer degenerate inlinetasks when there are no
799 ;; contents.
802 contents
806 ;;;; Item
809 "Parse an item.
811 STRUCT is the structure of the plain list.
813 Return a list whose CAR is `item' and CDR is a plist containing
814 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
815 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
816 `:post-blank' keywords.
818 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
819 any, will not be parsed as a secondary string, but as a plain
820 string instead.
822 Assume point is at the beginning of the item."
849 ;; If first line isn't empty,
850 ;; contents really start at the text
851 ;; after item's meta-data.
865 ;; CONTENTS-BEGIN and CONTENTS-END may be mixed
866 ;; up in the case of an empty item separated
867 ;; from the next by a blank line. Thus, ensure
868 ;; the former is always the smallest of two.
879 "Interpret ITEM element as Org syntax.
880 CONTENTS is the contents of the element."
894 num
901 ;; Compute indentation.
906 ;; Indent contents.
908 bullet
921 ;;;; Plain List
924 "Parse a plain list.
926 Optional argument STRUCTURE, when non-nil, is the structure of
927 the plain list being parsed.
929 Return a list whose CAR is `plain-list' and CDR is a plist
930 containing `:type', `:begin', `:end', `:contents-begin' and
931 `:contents-end', `:structure' and `:post-blank' keywords.
933 Assume point is at the beginning of the list."
946 ;; Blank lines below list belong to the top-level list only.
951 ;; Return value.
963 "Interpret PLAIN-LIST element as Org syntax.
964 CONTENTS is the contents of the element."
965 contents)
968 ;;;; Quote Block
971 "Parse a quote block.
973 Return a list whose CAR is `quote-block' and CDR is a plist
974 containing `:begin', `:end', `:hiddenp', `:contents-begin',
975 `:contents-end' and `:post-blank' keywords.
977 Assume point is at the beginning of the block."
999 "Interpret QUOTE-BLOCK element as Org syntax.
1000 CONTENTS is the contents of the element."
1004 ;;;; Section
1007 "Parse a section.
1009 Return a list whose CAR is `section' and CDR is a plist
1010 containing `:begin', `:end', `:contents-begin', `contents-end'
1011 and `:post-blank' keywords."
1013 ;; Beginning of section is the beginning of the first non-blank
1014 ;; line after previous headline.
1033 "Interpret SECTION element as Org syntax.
1034 CONTENTS is the contents of the element."
1035 contents)
1038 ;;;; Special Block
1041 "Parse a special block.
1043 Return a list whose CAR is `special-block' and CDR is a plist
1044 containing `:type', `:begin', `:end', `:hiddenp',
1045 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1047 Assume point is at the beginning of the block."
1073 "Interpret SPECIAL-BLOCK element as Org syntax.
1074 CONTENTS is the contents of the element."
1079 \f
1080 ;;; Elements
1081 ;;
1082 ;; For each element, a parser and an interpreter are also defined.
1083 ;; Both follow the same naming convention used for greater elements.
1084 ;;
1085 ;; Also, as for greater elements, adding a new element type is done
1086 ;; through the following steps: implement a parser and an interpreter,
1087 ;; tweak `org-element-current-element' so that it recognizes the new
1088 ;; type and add that new type to `org-element-all-elements'.
1089 ;;
1090 ;; As a special case, when the newly defined type is a block type,
1091 ;; `org-element-block-name-alist' has to be modified accordingly.
1094 ;;;; Babel Call
1097 "Parse a babel call.
1099 Return a list whose CAR is `babel-call' and CDR is a plist
1100 containing `:begin', `:end', `:info' and `:post-blank' as
1101 keywords."
1117 "Interpret BABEL-CALL element as Org syntax.
1118 CONTENTS is nil."
1124 ;; Remove redundant square brackets.
1129 ;;;; Clock
1132 "Parse a clock.
1134 Return a list whose CAR is `clock' and CDR is a plist containing
1135 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1136 as keywords."
1161 "Interpret CLOCK element as Org syntax.
1162 CONTENTS is nil."
1169 "%2s:%02s"
1173 ;;;; Comment
1176 "Parse a comment.
1178 Return a list whose CAR is `comment' and CDR is a plist
1179 containing `:begin', `:end', `:value' and `:post-blank'
1180 keywords.
1182 Assume point is at comment beginning."
1186 ;; Match first line with a loose regexp since it might as
1187 ;; well be an ill-defined keyword.
1193 ;; Get comments ending. This may not be accurate if
1194 ;; commented lines within an item are followed by
1195 ;; commented lines outside of a list. Though, parser will
1196 ;; always get it right as it already knows surrounding
1197 ;; element and has narrowed buffer to its contents.
1200 ;; Accumulate lines without leading hash and plus sign
1201 ;; if any. First whitespace is also ignored.
1219 "Interpret COMMENT element as Org syntax.
1220 CONTENTS is nil."
1224 ;;;; Comment Block
1227 "Parse an export block.
1229 Return a list whose CAR is `comment-block' and CDR is a plist
1230 containing `:begin', `:end', `:hiddenp', `:value' and
1231 `:post-blank' keywords.
1233 Assume point is at comment block beginning."
1256 "Interpret COMMENT-BLOCK element as Org syntax.
1257 CONTENTS is nil."
1262 ;;;; Example Block
1265 "Parse an example block.
1267 Return a list whose CAR is `example-block' and CDR is a plist
1268 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1269 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1270 `:switches', `:value' and `:post-blank' keywords."
1276 ;; Switches analysis
1281 ;; Should labels be retained in (or stripped from) example
1282 ;; blocks?
1287 ;; What should code-references use - labels or
1288 ;; line-numbers?
1295 ;; Standard block parsing.
1322 "Interpret EXAMPLE-BLOCK element as Org syntax.
1323 CONTENTS is nil."
1331 ;;;; Export Block
1334 "Parse an export block.
1336 Return a list whose CAR is `export-block' and CDR is a plist
1337 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1338 `:post-blank' keywords.
1340 Assume point is at export-block beginning."
1366 "Interpret EXPORT-BLOCK element as Org syntax.
1367 CONTENTS is nil."
1374 ;;;; Fixed-width
1377 "Parse a fixed-width section.
1379 Return a list whose CAR is `fixed-width' and CDR is a plist
1380 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1382 Assume point is at the beginning of the fixed-width area."
1386 value
1388 ;; Ending position may not be accurate if fixed-width
1389 ;; lines within an item are followed by fixed-width lines
1390 ;; outside of a list. Though, parser will always get it
1391 ;; right as it already knows surrounding element and has
1392 ;; narrowed buffer to its contents.
1395 ;, Accumulate text without starting colons.
1413 "Interpret FIXED-WIDTH element as Org syntax.
1414 CONTENTS is nil."
1419 ;;;; Horizontal Rule
1422 "Parse an horizontal rule.
1424 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1425 containing `:begin', `:end' and `:post-blank' keywords."
1439 "Interpret HORIZONTAL-RULE element as Org syntax.
1440 CONTENTS is nil."
1444 ;;;; Keyword
1447 "Parse a keyword at point.
1449 Return a list whose CAR is `keyword' and CDR is a plist
1450 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1451 keywords."
1471 "Interpret KEYWORD element as Org syntax.
1472 CONTENTS is nil."
1478 ;;;; Latex Environment
1481 "Parse a LaTeX environment.
1483 Return a list whose CAR is `latex-environment' and CDR is a plist
1484 containing `:begin', `:end', `:value' and `:post-blank'
1485 keywords.
1487 Assume point is at the beginning of the latex environment."
1510 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1511 CONTENTS is nil."
1515 ;;;; Paragraph
1518 "Parse a paragraph.
1520 Return a list whose CAR is `paragraph' and CDR is a plist
1521 containing `:begin', `:end', `:contents-begin' and
1522 `:contents-end' and `:post-blank' keywords.
1524 Assume point is at the beginning of the paragraph."
1546 "Interpret PARAGRAPH element as Org syntax.
1547 CONTENTS is the contents of the element."
1548 contents)
1551 ;;;; Planning
1554 "Parse a planning.
1556 Return a list whose CAR is `planning' and CDR is a plist
1557 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1558 and `:post-blank' keywords."
1567 closed deadline scheduled)
1587 "Interpret PLANNING element as Org syntax.
1588 CONTENTS is nil."
1590 'identity
1601 ;;;; Property Drawer
1604 "Parse a property drawer.
1606 Return a list whose CAR is `property-drawer' and CDR is a plist
1607 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1608 `:contents-end', `:properties' and `:post-blank' keywords.
1610 Assume point is at the beginning of the property drawer."
1624 val))
1626 val))
1640 "Interpret PROPERTY-DRAWER element as Org syntax.
1641 CONTENTS is nil."
1651 ;;;; Quote Section
1654 "Parse a quote section.
1656 Return a list whose CAR is `quote-section' and CDR is a plist
1657 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1659 Assume point is at beginning of the section."
1675 "Interpret QUOTE-SECTION element as Org syntax.
1676 CONTENTS is nil."
1680 ;;;; Src Block
1683 "Parse a src block.
1685 Return a list whose CAR is `src-block' and CDR is a plist
1686 containing `:language', `:switches', `:parameters', `:begin',
1687 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1688 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1689 `:post-blank' keywords.
1691 Assume point is at the beginning of the block."
1695 ;; Get affiliated keywords.
1697 ;; Get beginning position.
1699 ;; Get language as a string.
1708 ;; Get switches.
1710 ;; Get parameters.
1712 ;; Switches analysis
1720 ;; Should labels be retained in (or stripped from) src
1721 ;; blocks?
1726 ;; What should code-references use - labels or
1727 ;; line-numbers?
1731 ;; Get position at end of block.
1735 ;; Retrieve code.
1741 ;; Get position after ending blank lines.
1744 ;; Get visibility status.
1767 "Interpret SRC-BLOCK element as Org syntax.
1768 CONTENTS is nil."
1788 value
1792 ;;;; Table
1795 "Parse a table at point.
1797 Return a list whose CAR is `table' and CDR is a plist containing
1798 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1799 `:contents-end', `:value' and `:post-blank' keywords.
1801 Assume point is at the beginning of the table."
1813 acc))
1822 ;; Only `org' tables have contents. `table.el' tables
1823 ;; use a `:value' property to store raw table as
1824 ;; a string.
1829 table-begin table-end))
1834 "Interpret TABLE element as Org syntax.
1835 CONTENTS is nil."
1846 ;;;; Table Row
1849 "Parse table row at point.
1851 Return a list whose CAR is `table-row' and CDR is a plist
1852 containing `:begin', `:end', `:contents-begin', `:contents-end',
1853 `:type' and `:post-blank' keywords."
1857 ;; A table rule has no contents. In that case, ensure
1858 ;; CONTENTS-BEGIN matches CONTENTS-END.
1877 "Interpret TABLE-ROW element as Org syntax.
1878 CONTENTS is the contents of the table row."
1883 ;;;; Verse Block
1886 "Parse a verse block.
1888 Return a list whose CAR is `verse-block' and CDR is a plist
1889 containing `:begin', `:end', `:contents-begin', `:contents-end',
1890 `:hiddenp' and `:post-blank' keywords.
1892 Assume point is at beginning of the block."
1916 "Interpret VERSE-BLOCK element as Org syntax.
1917 CONTENTS is verse block contents."
1921 \f
1922 ;;; Objects
1923 ;;
1924 ;; Unlike to elements, interstices can be found between objects.
1925 ;; That's why, along with the parser, successor functions are provided
1926 ;; for each object. Some objects share the same successor (i.e. `code'
1927 ;; and `verbatim' objects).
1928 ;;
1929 ;; A successor must accept a single argument bounding the search. It
1930 ;; will return either a cons cell whose CAR is the object's type, as
1931 ;; a symbol, and CDR the position of its next occurrence, or nil.
1932 ;;
1933 ;; Successors follow the naming convention:
1934 ;; org-element-NAME-successor, where NAME is the name of the
1935 ;; successor, as defined in `org-element-all-successors'.
1936 ;;
1937 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
1938 ;; object types they can contain will be specified in
1939 ;; `org-element-object-restrictions'.
1940 ;;
1941 ;; Adding a new type of object is simple. Implement a successor,
1942 ;; a parser, and an interpreter for it, all following the naming
1943 ;; convention. Register type in `org-element-all-objects' and
1944 ;; successor in `org-element-all-successors'. Maybe tweak
1945 ;; restrictions about it, and that's it.
1948 ;;;; Bold
1951 "Parse bold object at point.
1953 Return a list whose CAR is `bold' and CDR is a plist with
1954 `:begin', `:end', `:contents-begin' and `:contents-end' and
1955 `:post-blank' keywords.
1957 Assume point is at the first star marker."
1975 "Interpret BOLD object as Org syntax.
1976 CONTENTS is the contents of the object."
1980 "Search for the next text-markup object.
1982 LIMIT bounds the search.
1984 Return value is a cons cell whose CAR is a symbol among `bold',
1985 `italic', `underline', `strike-through', `code' and `verbatim'
1986 and CDR is beginning position."
2002 ;;;; Code
2005 "Parse code object at point.
2007 Return a list whose CAR is `code' and CDR is a plist with
2008 `:value', `:begin', `:end' and `:post-blank' keywords.
2010 Assume point is at the first tilde marker."
2026 "Interpret CODE object as Org syntax.
2027 CONTENTS is nil."
2031 ;;;; Entity
2034 "Parse entity at point.
2036 Return a list whose CAR is `entity' and CDR a plist with
2037 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2038 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2039 keywords.
2041 Assume point is at the beginning of the entity."
2043 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2065 "Interpret ENTITY object as Org syntax.
2066 CONTENTS is nil."
2072 "Search for the next latex-fragment or entity object.
2074 LIMIT bounds the search.
2076 Return value is a cons cell whose CAR is `entity' or
2077 `latex-fragment' and CDR is beginning position."
2080 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2087 limit t)
2090 ;; Determine if it's a real entity or a LaTeX command.
2093 ;; No entity nor command: point is at a LaTeX fragment.
2094 ;; Determine its type to get the correct beginning position.
2102 matchers)
2106 ;;;; Export Snippet
2109 "Parse export snippet at point.
2111 Return a list whose CAR is `export-snippet' and CDR a plist with
2112 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2113 keywords.
2115 Assume point is at the beginning of the snippet."
2133 "Interpret EXPORT-SNIPPET object as Org syntax.
2134 CONTENTS is nil."
2140 "Search for the next export-snippet object.
2142 LIMIT bounds the search.
2144 Return value is a cons cell whose CAR is `export-snippet' and CDR
2145 its beginning position."
2154 ;;;; Footnote Reference
2157 "Parse footnote reference at point.
2159 Return a list whose CAR is `footnote-reference' and CDR a plist
2160 with `:label', `:type', `:inline-definition', `:begin', `:end'
2161 and `:post-blank' as keywords."
2194 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2195 CONTENTS is nil."
2205 "Search for the next footnote-reference object.
2207 LIMIT bounds the search.
2209 Return value is a cons cell whose CAR is `footnote-reference' and
2210 CDR is beginning position."
2224 ;;;; Inline Babel Call
2227 "Parse inline babel call at point.
2229 Return a list whose CAR is `inline-babel-call' and CDR a plist
2230 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2232 Assume point is at the beginning of the babel call."
2248 "Interpret INLINE-BABEL-CALL object as Org syntax.
2249 CONTENTS is nil."
2255 ;; Remove redundant square brackets.
2258 main-source)
2262 "Search for the next inline-babel-call object.
2264 LIMIT bounds the search.
2266 Return value is a cons cell whose CAR is `inline-babel-call' and
2267 CDR is beginning position."
2269 ;; Use a simplified version of
2270 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2272 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2273 limit t)
2277 ;;;; Inline Src Block
2280 "Parse inline source block at point.
2282 Return a list whose CAR is `inline-src-block' and CDR a plist
2283 with `:begin', `:end', `:language', `:value', `:parameters' and
2284 `:post-blank' as keywords.
2286 Assume point is at the beginning of the inline src block."
2306 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2307 CONTENTS is nil."
2312 language
2314 body)))
2317 "Search for the next inline-babel-call element.
2319 LIMIT bounds the search.
2321 Return value is a cons cell whose CAR is `inline-babel-call' and
2322 CDR is beginning position."
2327 ;;;; Italic
2330 "Parse italic object at point.
2332 Return a list whose CAR is `italic' and CDR is a plist with
2333 `:begin', `:end', `:contents-begin' and `:contents-end' and
2334 `:post-blank' keywords.
2336 Assume point is at the first slash marker."
2354 "Interpret ITALIC object as Org syntax.
2355 CONTENTS is the contents of the object."
2359 ;;;; Latex Fragment
2362 "Parse latex fragment at point.
2364 Return a list whose CAR is `latex-fragment' and CDR a plist with
2365 `:value', `:begin', `:end', and `:post-blank' as keywords.
2367 Assume point is at the beginning of the latex fragment."
2381 ;; None found: it's a macro.
2395 "Interpret LATEX-FRAGMENT object as Org syntax.
2396 CONTENTS is nil."
2399 ;;;; Line Break
2402 "Parse line break at point.
2404 Return a list whose CAR is `line-break', and CDR a plist with
2405 `:begin', `:end' and `:post-blank' keywords.
2407 Assume point is at the beginning of the line break."
2413 "Interpret LINE-BREAK object as Org syntax.
2414 CONTENTS is nil."
2418 "Search for the next line-break object.
2420 LIMIT bounds the search.
2422 Return value is a cons cell whose CAR is `line-break' and CDR is
2423 beginning position."
2427 ;; A line break can only happen on a non-empty line.
2432 ;;;; Link
2435 "Parse link at point.
2437 Return a list whose CAR is `link' and CDR a plist with `:type',
2438 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2439 `:contents-end' and `:post-blank' as keywords.
2441 Assume point is at the beginning of the link."
2444 end contents-begin contents-end link-end post-blank path type
2445 raw-link link)
2447 ;; Type 1: Text targeted from a radio target.
2452 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2457 ;; RAW-LINK is the original link.
2462 ;; Determine TYPE of link and set PATH accordingly.
2464 ;; File type.
2467 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2470 ;; Id type: PATH is the id.
2473 ;; Code-ref type: PATH is the name of the reference.
2476 ;; Custom-id type: PATH is the name of the custom id.
2479 ;; Fuzzy type: Internal link either matches a target, an
2480 ;; headline name or nothing. PATH is the target or
2481 ;; headline's name.
2483 ;; Type 3: Plain link, i.e. http://orgmode.org
2489 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2496 ;; In any case, deduce end point after trailing white space from
2497 ;; LINK-END variable.
2511 "Interpret LINK object as Org syntax.
2512 CONTENTS is the contents of the object, or nil."
2517 raw-link
2521 "Search for the next link object.
2523 LIMIT bounds the search.
2525 Return value is a cons cell whose CAR is `link' and CDR is
2526 beginning position."
2535 ;;;; Macro
2538 "Parse macro at point.
2540 Return a list whose CAR is `macro' and CDR a plist with `:key',
2541 `:args', `:begin', `:end', `:value' and `:post-blank' as
2542 keywords.
2544 Assume point is at the macro."
2558 ;; Repair bad splits.
2573 "Interpret MACRO object as Org syntax.
2574 CONTENTS is nil."
2578 "Search for the next macro object.
2580 LIMIT bounds the search.
2582 Return value is cons cell whose CAR is `macro' and CDR is
2583 beginning position."
2587 limit t)
2591 ;;;; Radio-target
2594 "Parse radio target at point.
2596 Return a list whose CAR is `radio-target' and CDR a plist with
2597 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2598 and `:post-blank' as keywords.
2600 Assume point is at the radio target."
2619 "Interpret TARGET object as Org syntax.
2620 CONTENTS is the contents of the object."
2624 "Search for the next radio-target object.
2626 LIMIT bounds the search.
2628 Return value is a cons cell whose CAR is `radio-target' and CDR
2629 is beginning position."
2635 ;;;; Statistics Cookie
2638 "Parse statistics cookie at point.
2640 Return a list whose CAR is `statistics-cookie', and CDR a plist
2641 with `:begin', `:end', `:value' and `:post-blank' keywords.
2643 Assume point is at the beginning of the statistics-cookie."
2659 "Interpret STATISTICS-COOKIE object as Org syntax.
2660 CONTENTS is nil."
2664 "Search for the next statistics cookie object.
2666 LIMIT bounds the search.
2668 Return value is a cons cell whose CAR is `statistics-cookie' and
2669 CDR is beginning position."
2675 ;;;; Strike-Through
2678 "Parse strike-through object at point.
2680 Return a list whose CAR is `strike-through' and CDR is a plist
2681 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2682 `:post-blank' keywords.
2684 Assume point is at the first plus sign marker."
2702 "Interpret STRIKE-THROUGH object as Org syntax.
2703 CONTENTS is the contents of the object."
2707 ;;;; Subscript
2710 "Parse subscript at point.
2712 Return a list whose CAR is `subscript' and CDR a plist with
2713 `:begin', `:end', `:contents-begin', `:contents-end',
2714 `:use-brackets-p' and `:post-blank' as keywords.
2716 Assume point is at the underscore."
2720 t
2738 "Interpret SUBSCRIPT object as Org syntax.
2739 CONTENTS is the contents of the object."
2742 contents))
2745 "Search for the next sub/superscript object.
2747 LIMIT bounds the search.
2749 Return value is a cons cell whose CAR is either `subscript' or
2750 `superscript' and CDR is beginning position."
2757 ;;;; Superscript
2760 "Parse superscript at point.
2762 Return a list whose CAR is `superscript' and CDR a plist with
2763 `:begin', `:end', `:contents-begin', `:contents-end',
2764 `:use-brackets-p' and `:post-blank' as keywords.
2766 Assume point is at the caret."
2787 "Interpret SUPERSCRIPT object as Org syntax.
2788 CONTENTS is the contents of the object."
2791 contents))
2794 ;;;; Table Cell
2797 "Parse table cell at point.
2799 Return a list whose CAR is `table-cell' and CDR is a plist
2800 containing `:begin', `:end', `:contents-begin', `:contents-end'
2801 and `:post-blank' keywords."
2815 "Interpret TABLE-CELL element as Org syntax.
2816 CONTENTS is the contents of the cell, or nil."
2820 "Search for the next table-cell object.
2822 LIMIT bounds the search.
2824 Return value is a cons cell whose CAR is `table-cell' and CDR is
2825 beginning position."
2829 ;;;; Target
2832 "Parse target at point.
2834 Return a list whose CAR is `target' and CDR a plist with
2835 `:begin', `:end', `:value' and `:post-blank' as keywords.
2837 Assume point is at the target."
2852 "Interpret TARGET object as Org syntax.
2853 CONTENTS is nil."
2857 "Search for the next target object.
2859 LIMIT bounds the search.
2861 Return value is a cons cell whose CAR is `target' and CDR is
2862 beginning position."
2868 ;;;; Timestamp
2871 "Parse time stamp at point.
2873 Return a list whose CAR is `timestamp', and CDR a plist with
2874 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
2876 Assume point is at the beginning of the timestamp."
2902 "Interpret TIMESTAMP object as Org syntax.
2903 CONTENTS is nil."
2907 "Search for the next timestamp object.
2909 LIMIT bounds the search.
2911 Return value is a cons cell whose CAR is `timestamp' and CDR is
2912 beginning position."
2920 limit t)
2924 ;;;; Underline
2927 "Parse underline object at point.
2929 Return a list whose CAR is `underline' and CDR is a plist with
2930 `:begin', `:end', `:contents-begin' and `:contents-end' and
2931 `:post-blank' keywords.
2933 Assume point is at the first underscore marker."
2951 "Interpret UNDERLINE object as Org syntax.
2952 CONTENTS is the contents of the object."
2956 ;;;; Verbatim
2959 "Parse verbatim object at point.
2961 Return a list whose CAR is `verbatim' and CDR is a plist with
2962 `:value', `:begin', `:end' and `:post-blank' keywords.
2964 Assume point is at the first equal sign marker."
2980 "Interpret VERBATIM object as Org syntax.
2981 CONTENTS is nil."
2985 \f
2986 ;;; Accessors and Setters
2987 ;;
2988 ;; Provide four accessors: `org-element-type', `org-element-property'
2989 ;; `org-element-contents' and `org-element-restriction'.
2990 ;;
2991 ;; Setter functions allow to modify elements by side effect. There is
2992 ;; `org-element-put-property', `org-element-set-contents',
2993 ;; `org-element-set-element' and `org-element-adopt-element'. Note
2994 ;; that `org-element-set-element' and `org-element-adopt-element' are
2995 ;; higher level functions since also update `:parent' property.
2998 "Return type of ELEMENT.
3000 The function returns the type of the element or object provided.
3001 It can also return the following special value:
3002 `plain-text' for a string
3003 `org-data' for a complete document
3004 nil in any other case."
3010 "Extract the value from the PROPERTY of an ELEMENT."
3014 "Extract contents from an ELEMENT."
3018 "Return restriction associated to ELEMENT.
3019 ELEMENT can be an element, an object or a symbol representing an
3020 element or object type."
3022 org-element-object-restrictions)))
3025 "In ELEMENT set PROPERTY to VALUE.
3026 Return modified element."
3028 element)
3031 "Set ELEMENT contents to CONTENTS.
3032 Return modified element."
3036 "Replace element or object OLD with element or object NEW.
3037 The function takes care of setting `:parent' property for NEW."
3038 ;; OLD can belong to the contents of PARENT or to its secondary
3039 ;; string.
3042 org-element-secondary-value-alist)))
3045 ;; Make sure NEW has correct `:parent' property.
3047 ;; Replace OLD with NEW in PARENT.
3051 "Add an element to the contents of another element.
3053 PARENT is an element or object. CHILD is an element, an object,
3054 or a string.
3056 CHILD is added at the beginning of PARENT contents, unless the
3057 optional argument APPEND is non-nil, in which case CHILD is added
3058 at the end.
3060 The function takes care of setting `:parent' property for CHILD.
3061 Return parent element."
3064 parent
3066 ;; Link the child element with parent.
3068 ;; Return the parent element.
3069 parent)
3072 \f
3073 ;;; Parsing Element Starting At Point
3074 ;;
3075 ;; `org-element-current-element' is the core function of this section.
3076 ;; It returns the Lisp representation of the element starting at
3077 ;; point.
3078 ;;
3079 ;; `org-element-current-element' makes use of special modes. They are
3080 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3081 ;; or fixed conditional element chaining (i.e. `headline' >
3082 ;; `section'). Special modes are: `section', `quote-section', `item'
3083 ;; and `table-row'.
3086 "Parse the element starting at point.
3088 Return value is a list like (TYPE PROPS) where TYPE is the type
3089 of the element and PROPS a plist of properties associated to the
3090 element.
3092 Possible types are defined in `org-element-all-elements'.
3094 Optional argument GRANULARITY determines the depth of the
3095 recursion. Allowed values are `headline', `greater-element',
3096 `element', `object' or nil. When it is broader than `object' (or
3097 nil), secondary values will not be parsed, since they only
3098 contain objects.
3100 Optional argument SPECIAL, when non-nil, can be either `section',
3101 `quote-section', `table-row' and `item'.
3103 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3104 be computed.
3106 This function assumes point is always at the beginning of the
3107 element it has to parse."
3109 ;; If point is at an affiliated keyword, try moving to the
3110 ;; beginning of the associated element. If none is found, the
3111 ;; keyword is orphaned and will be treated as plain text.
3117 ;; Determine if parsing depth allows for secondary strings
3118 ;; parsing. It only applies to elements referenced in
3119 ;; `org-element-secondary-value-alist'.
3122 ;; Item.
3125 raw-secondary-p))
3126 ;; Quote Section.
3128 ;; Table Row.
3130 ;; Headline.
3133 ;; Section (must be checked after headline).
3135 ;; Planning and Clock.
3140 ;; Blocks.
3151 ;; Inlinetask.
3153 ;; LaTeX Environment.
3159 nil t))
3162 ;; Drawer and Property Drawer.
3170 ;; Fixed Width
3172 ;; Babel Call, Dynamic Block and Keyword.
3185 ;; Footnote Definition.
3188 ;; Comment.
3191 ;; Horizontal Rule.
3194 ;; Table.
3196 ;; List.
3199 ;; Default element: Paragraph.
3203 ;; Most elements can have affiliated keywords. When looking for an
3204 ;; element beginning, we want to move before them, as they belong to
3205 ;; that element, and, in the meantime, collect information they give
3206 ;; into appropriate properties. Hence the following function.
3207 ;;
3208 ;; Usage of optional arguments may not be obvious at first glance:
3209 ;;
3210 ;; - TRANS-LIST is used to polish keywords names that have evolved
3211 ;; during Org history. In example, even though =result= and
3212 ;; =results= coexist, we want to have them under the same =result=
3213 ;; property. It's also true for "srcname" and "name", where the
3214 ;; latter seems to be preferred nowadays (thus the "name" property).
3215 ;;
3216 ;; - CONSED allows to regroup multi-lines keywords under the same
3217 ;; property, while preserving their own identity. This is mostly
3218 ;; used for "attr_latex" and al.
3219 ;;
3220 ;; - PARSED prepares a keyword value for export. This is useful for
3221 ;; "caption". Objects restrictions for such keywords are defined in
3222 ;; `org-element-object-restrictions'.
3223 ;;
3224 ;; - DUALS is used to take care of keywords accepting a main and an
3225 ;; optional secondary values. For example "results" has its
3226 ;; source's name as the main value, and may have an hash string in
3227 ;; optional square brackets as the secondary one.
3228 ;;
3229 ;; A keyword may belong to more than one category.
3233 "Collect affiliated keywords before point.
3235 Optional argument KEY-RE is a regexp matching keywords, which
3236 puts matched keyword in group 1. It defaults to
3237 `org-element--affiliated-re'.
3239 TRANS-LIST is an alist where key is the keyword and value the
3240 property name it should be translated to, without the colons. It
3241 defaults to `org-element-keyword-translation-alist'.
3243 CONSED is a list of strings. Any keyword belonging to that list
3244 will have its value consed. The check is done after keyword
3245 translation. It defaults to `org-element-multiple-keywords'.
3247 PARSED is a list of strings. Any keyword member of this list
3248 will have its value parsed. The check is done after keyword
3249 translation. If a keyword is a member of both CONSED and PARSED,
3250 it's value will be a list of parsed strings. It defaults to
3251 `org-element-parsed-keywords'.
3253 DUALS is a list of strings. Any keyword member of this list can
3254 have two parts: one mandatory and one optional. Its value is
3255 a cons cell whose CAR is the former, and the CDR the latter. If
3256 a keyword is a member of both PARSED and DUALS, both values will
3257 be parsed. It defaults to `org-element-dual-keywords'.
3259 Return a list whose CAR is the position at the first of them and
3260 CDR a plist of keywords and values."
3268 ;; RESTRICT is the list of objects allowed in parsed
3269 ;; keywords value.
3271 output)
3275 ;; Apply translation to RAW-KWD. From there, KWD is
3276 ;; the official keyword.
3278 ;; Find main value for any keyword.
3284 ;; If KWD is a dual keyword, find its secondary
3285 ;; value. Maybe parse it.
3291 ;; Attribute a property name to KWD.
3293 ;; Now set final shape for VALUE.
3297 ;; VALUE is mandatory. Set it to nil if there is none.
3299 ;; Attributes are always consed.
3302 ;; Eventually store the new value in OUTPUT.
3308 \f
3309 ;;; The Org Parser
3310 ;;
3311 ;; The two major functions here are `org-element-parse-buffer', which
3312 ;; parses Org syntax inside the current buffer, taking into account
3313 ;; region, narrowing, or even visibility if specified, and
3314 ;; `org-element-parse-secondary-string', which parses objects within
3315 ;; a given string.
3316 ;;
3317 ;; The (almost) almighty `org-element-map' allows to apply a function
3318 ;; on elements or objects matching some type, and accumulate the
3319 ;; resulting values. In an export situation, it also skips unneeded
3320 ;; parts of the parse tree.
3323 "Recursively parse the buffer and return structure.
3324 If narrowing is in effect, only parse the visible part of the
3325 buffer.
3327 Optional argument GRANULARITY determines the depth of the
3328 recursion. It can be set to the following symbols:
3330 `headline' Only parse headlines.
3331 `greater-element' Don't recurse into greater elements excepted
3332 headlines and sections. Thus, elements
3333 parsed are the top-level ones.
3334 `element' Parse everything but objects and plain text.
3335 `object' Parse the complete buffer (default).
3337 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3338 elements.
3340 Assume buffer is in Org mode."
3346 ;; Start in `section' mode so text before the first
3347 ;; headline belongs to a section.
3351 "Recursively parse objects in STRING and return structure.
3353 RESTRICTION, when non-nil, is a symbol limiting the object types
3354 that will be looked after."
3360 "Map a function on selected elements or objects.
3362 DATA is the parsed tree, as returned by, i.e,
3363 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3364 of elements or objects types. FUN is the function called on the
3365 matching element or object. It must accept one arguments: the
3366 element or object itself.
3368 When optional argument INFO is non-nil, it should be a plist
3369 holding export options. In that case, parts of the parse tree
3370 not exportable according to that property list will be skipped.
3372 When optional argument FIRST-MATCH is non-nil, stop at the first
3373 match for which FUN doesn't return nil, and return that value.
3375 Optional argument NO-RECURSION is a symbol or a list of symbols
3376 representing elements or objects types. `org-element-map' won't
3377 enter any recursive element or object whose type belongs to that
3378 list. Though, FUN can still be applied on them.
3380 Nil values returned from FUN do not appear in the results."
3381 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3384 ;; Recursion depth is determined by --CATEGORY.
3391 ;; If one object is found, the function
3392 ;; has to recurse into every object.
3395 ;; If one regular element is found, the
3396 ;; function has to recurse, at lest, into
3397 ;; every element it encounters.
3400 types)
3401 category)))
3402 --acc
3403 --walk-tree
3407 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3408 ;; holding contextual information.
3412 ;; Ignored element in an export context.
3414 ;; Secondary string: only objects can be found there.
3417 ;; Unconditionally enter parse trees.
3421 ;; Check if TYPE is matching among TYPES. If so,
3422 ;; apply FUN to --DATA and accumulate return value
3423 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3429 ;; If --DATA has a secondary string that can contain
3430 ;; objects with their type among TYPES, look into it.
3437 ;; Determine if a recursion into --DATA is possible.
3439 ;; --TYPE is explicitly removed from recursion.
3441 ;; --DATA has no contents.
3443 ;; Looking for greater elements but --DATA is simply
3444 ;; an element or an object.
3447 ;; Looking for elements but --DATA is an object.
3450 ;; In any other case, map contents.
3454 ;; Return value in a proper order.
3457 ;; The following functions are internal parts of the parser.
3458 ;;
3459 ;; The first one, `org-element-parse-elements' acts at the element's
3460 ;; level.
3461 ;;
3462 ;; The second one, `org-element-parse-objects' applies on all objects
3463 ;; of a paragraph or a secondary string. It uses
3464 ;; `org-element-get-candidates' to optimize the search of the next
3465 ;; object in the buffer.
3466 ;;
3467 ;; More precisely, that function looks for every allowed object type
3468 ;; first. Then, it discards failed searches, keeps further matches,
3469 ;; and searches again types matched behind point, for subsequent
3470 ;; calls. Thus, searching for a given type fails only once, and every
3471 ;; object is searched only once at top level (but sometimes more for
3472 ;; nested types).
3476 "Parse elements between BEG and END positions.
3478 SPECIAL prioritize some elements over the others. It can be set
3479 to `quote-section', `section' `item' or `table-row'.
3481 When value is `item', STRUCTURE will be used as the current list
3482 structure.
3484 GRANULARITY determines the depth of the recursion. See
3485 `org-element-parse-buffer' for more information.
3487 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3488 elements.
3490 Elements are accumulated into ACC."
3495 ;; When parsing only headlines, skip any text before first one.
3498 ;; Main loop start.
3500 ;; Find current element's type and parse it accordingly to
3501 ;; its category.
3503 granularity special structure))
3506 ;; Set ACC as parent of current element. It will be
3507 ;; completed by side-effect. If the element contains any
3508 ;; secondary string, also set `:parent' property of every
3509 ;; object within it as current element.
3518 sec-value)))))
3521 acc
3524 ;; Case 1. Simply accumulate element if VISIBLE-ONLY is
3525 ;; true and element is hidden or if it has no contents
3526 ;; anyway.
3529 ;; Case 2. Greater element: parse it between
3530 ;; `contents-begin' and `contents-end'. Make sure
3531 ;; GRANULARITY allows the recursion, or ELEMENT is an
3532 ;; headline, in which case going inside is mandatory, in
3533 ;; order to get sub-level headings.
3541 ;; Possibly switch to a special mode.
3549 granularity visible-only element))
3550 ;; Case 3. ELEMENT has contents. Parse objects inside,
3551 ;; if GRANULARITY allows it.
3556 ;; Case 4. Else, just accumulate ELEMENT.
3558 ;; Return result.
3559 acc))
3562 "Parse objects between BEG and END and return recursive structure.
3564 Objects are accumulated in ACC.
3566 RESTRICTION is a list of object types which are allowed in the
3567 current object."
3571 ;; Return the parsing function associated to the nearest
3572 ;; object among list of candidates CAND.
3579 next-object candidates)
3583 end restriction candidates))
3585 ;; Set ACC as parent of current element. It will be completed
3586 ;; by side-effect.
3588 ;; 1. Text before any object. Untabify it.
3597 ;; 2. Object...
3602 cont-beg)
3603 ;; ... recursive. The CONT-BEG check is for
3604 ;; links, as some of them might not be recursive
3605 ;; (i.e. plain links).
3608 cont-beg
3612 ;; Restrict allowed objects.
3614 next-object)))
3617 ;; If the object contains any secondary string, also set
3618 ;; `:parent' property of every object within it as current
3619 ;; object.
3621 org-element-secondary-value-alist)))
3629 :parent
3630 complete-next-object)))
3631 sec-value)))))
3633 ;; 3. Text after last object. Untabify it.
3641 ;; Result.
3642 acc)))
3645 "Return an alist of candidates for the next object.
3647 LIMIT bounds the search, and RESTRICTION narrows candidates to
3648 some object types.
3650 Return value is an alist whose CAR is position and CDR the object
3651 type, as a symbol.
3653 OBJECTS is the previous candidates alist."
3655 ;; If no previous result, search every object type in RESTRICTION.
3656 ;; Otherwise, keep potential candidates (old objects located after
3657 ;; point) and ask to search again those which had matched before.
3662 objects))
3663 ;; Call the appropriate successor function for each type to search
3664 ;; and accumulate matches.
3671 type))))
3674 types-to-search)
3675 ;; Return alist.
3676 next-candidates))
3679 \f
3680 ;;; Towards A Bijective Process
3681 ;;
3682 ;; The parse tree obtained with `org-element-parse-buffer' is really
3683 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3684 ;; interpreted and expanded into a string with canonical Org syntax.
3685 ;; Hence `org-element-interpret-data'.
3686 ;;
3687 ;; The function relies internally on
3688 ;; `org-element-interpret--affiliated-keywords'.
3691 "Interpret DATA as Org syntax.
3693 DATA is a parse tree, an element, an object or a secondary string
3694 to interpret.
3696 Optional argument PARENT is used for recursive calls. It contains
3697 the element or object containing data, or nil.
3699 Return Org syntax as a string."
3703 ;; Secondary string.
3708 ;; Full Org document.
3713 ;; Plain text.
3715 ;; Element/Object without contents.
3718 data nil))
3719 ;; Element/Object with contents.
3729 ;; Elements directly containing objects must
3730 ;; have their indentation normalized first.
3732 data
3733 ;; When normalizing first paragraph of an
3734 ;; item or a footnote-definition, ignore
3735 ;; first line's indentation.
3742 data
3744 contents)))))))
3746 ;; Build white spaces. If no `:post-blank' property is
3747 ;; specified, assume its value is 0.
3757 "Return ELEMENT's affiliated keywords as Org syntax.
3758 If there is no affiliated keyword, return the empty string."
3768 ": "
3771 value)
3779 ;; All attribute keywords can have multiple lines.
3782 value
3785 ;; List all ELEMENT's properties matching an attribute line or an
3786 ;; affiliated keyword, but ignore translated keywords since they
3787 ;; cannot belong to the property list.
3794 org-element-keyword-translation-alist)))))
3795 collect prop)
3798 ;; Because interpretation of the parse tree must return the same
3799 ;; number of blank lines between elements and the same number of white
3800 ;; space after objects, some special care must be given to white
3801 ;; spaces.
3802 ;;
3803 ;; The first function, `org-element-normalize-string', ensures any
3804 ;; string different from the empty string will end with a single
3805 ;; newline character.
3806 ;;
3807 ;; The second function, `org-element-normalize-contents', removes
3808 ;; global indentation from the contents of the current element.
3811 "Ensure string S ends with a single newline character.
3813 If S isn't a string return it unchanged. If S is the empty
3814 string, return it. Otherwise, return a new string with a single
3815 newline character at its end."
3823 "Normalize plain text in ELEMENT's contents.
3825 ELEMENT must only contain plain text and objects.
3827 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3828 indentation to compute maximal common indentation.
3830 Return the normalized element that is element with global
3831 indentation removed from its contents. The function assumes that
3832 indentation is not done with TAB characters."
3834 collect-inds ; for byte-compiler
3837 ;; Return list of indentations within BLOB. This is done by
3838 ;; walking recursively BLOB and updating IND-LIST along the
3839 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3840 ;; been seen yet. It is required as this string is the only
3841 ;; one whose indentation doesn't happen after a newline
3842 ;; character.
3850 ;; An indentation of zero means no string will be
3851 ;; modified. Quit the process.
3857 ;; Avoid matching blank or empty lines.
3865 ;; Collect indentation list in ELEMENT. Possibly remove first
3866 ;; value if IGNORE-FIRST is non-nil.
3869 ;; Build ELEMENT back, replacing each string with the same
3870 ;; string minus common indentation.
3875 ;; Return BLOB with all its strings indentation
3876 ;; shortened from MCI white spaces. FIRST-FLAG is
3877 ;; non-nil when the first string hasn't been seen
3878 ;; yet.
3893 org-element-recursive-objects)
3900 \f
3901 ;;; The Toolbox
3902 ;;
3903 ;; The first move is to implement a way to obtain the smallest element
3904 ;; containing point. This is the job of `org-element-at-point'. It
3905 ;; basically jumps back to the beginning of section containing point
3906 ;; and moves, element after element, with
3907 ;; `org-element-current-element' until the container is found.
3908 ;;
3909 ;; At a deeper level, `org-element-context' lists all elements and
3910 ;; objects containing point.
3911 ;;
3912 ;; Note: When using `org-element-at-point', secondary values are never
3913 ;; parsed since the function focuses on elements, not on objects.
3916 "Determine closest element around point.
3918 Return value is a list like (TYPE PROPS) where TYPE is the type
3919 of the element and PROPS a plist of properties associated to the
3920 element. Possible types are defined in
3921 `org-element-all-elements'.
3923 As a special case, if point is at the very beginning of a list or
3924 sub-list, returned element will be that list instead of the first
3925 item. In the same way, if point is at the beginning of the first
3926 row of a table, returned element will be the table instead of the
3927 first row.
3929 If optional argument KEEP-TRAIL is non-nil, the function returns
3930 a list of of elements leading to element at point. The list's
3931 CAR is always the element at point. Following positions contain
3932 element's siblings, then parents, siblings of parents, until the
3933 first element of current section."
3935 ;; If at an headline, parse it. It is the sole element that
3936 ;; doesn't require to know about context. Be sure to disallow
3937 ;; secondary string parsing, though.
3943 ;; Otherwise move at the beginning of the section containing
3944 ;; point.
3952 ;; Parse successively each element, skipping those ending
3953 ;; before original position.
3961 ;; 1. Skip any element ending before point or at point.
3966 ;; 2. An element containing point is always the element at
3967 ;; point.
3970 ;; 3. At any other greater element type, if point is
3971 ;; within contents, move into it. Otherwise, return
3972 ;; that element.
3989 "Return list of all elements and objects around point.
3991 Return value is a list like (TYPE PROPS) where TYPE is the type
3992 of the element or object and PROPS a plist of properties
3993 associated to it. Possible types are defined in
3994 `org-element-all-elements' and `org-element-all-objects'.
3996 All elements and objects returned belong to the current section
3997 and are ordered from closest to farthest."
4000 ;; Remove elements not containing point from trail.
4008 ;; Check if point is inside an element containing objects or at
4009 ;; a secondary string. In that case, move to beginning of the
4010 ;; element or secondary string and set END to the other side.
4019 (<= origin
4020 ;; `1+' is required so some
4021 ;; successors can match
4022 ;; properly their object.
4036 elements
4040 end restriction candidates))
4042 candidates)))
4043 ;; If ORIGIN is before next object in element, there's
4044 ;; no point in looking further.
4053 ;; ORIGIN is after OBJECT, so skip it.
4056 ;; ORIGIN is within a non-recursive object or at an
4057 ;; object boundaries: Return that object.
4060 ;; Otherwise, move within current object and restrict
4061 ;; search to the end of its contents.
4065 elements))))))
4068 ;; Once the local structure around point is well understood, it's easy
4069 ;; to implement some replacements for `forward-paragraph'
4070 ;; `backward-paragraph', namely `org-element-forward' and
4071 ;; `org-element-backward'.
4072 ;;
4073 ;; Also, `org-transpose-elements' mimics the behaviour of
4074 ;; `transpose-words', at the element's level, whereas
4075 ;; `org-element-drag-forward', `org-element-drag-backward', and
4076 ;; `org-element-up' generalize, respectively, functions
4077 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
4078 ;;
4079 ;; `org-element-unindent-buffer' will, as its name almost suggests,
4080 ;; smartly remove global indentation from buffer, making it possible
4081 ;; to use Org indent mode on a file created with hard indentation.
4082 ;;
4083 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
4084 ;; internally by some of the previously cited tools.
4087 "Non-nil when elements ELEM-A and ELEM-B are nested."
4096 "Swap elements ELEM-A and ELEM-B.
4097 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4098 end of ELEM-A."
4100 ;; There are two special cases when an element doesn't start at bol:
4101 ;; the first paragraph in an item or in a footnote definition.
4103 ;; Only a paragraph without any affiliated keyword can be moved at
4104 ;; ELEM-A position in such a situation. Note that the case of
4105 ;; a footnote definition is impossible: it cannot contain two
4106 ;; paragraphs in a row because it cannot contain a blank line.
4112 ;; In a special situation, ELEM-A will have no indentation. We'll
4113 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4127 ;; Store overlays responsible for visibility status. We
4128 ;; also need to store their boundaries as they will be
4129 ;; removed from buffer.
4136 ;; Get contents.
4144 ;; Restore ex ELEM-A overlays.
4154 ;; Restore ex ELEM-B overlays.
4163 "Move forward by one element.
4164 Move to the next element at the same level, when possible."
4177 return prev)))
4185 "Move backward by one element.
4186 Move to the previous element at the same level, when possible."
4189 ;; At an headline, move to the previous one, if any, or stay
4190 ;; here.
4201 ;; Move to beginning of current element if point isn't there
4202 ;; already.
4208 "Move to upper element."
4218 return prev)))
4225 "Move to inner element."
4233 ;; If contents are hidden, first disclose them.
4239 "Move backward element at point."
4245 ;; Error out if no previous element or previous element is
4246 ;; a parent of the current one.
4255 "Move forward element at point."
4268 ;; Compute new position of point: it's shifted by NEXT-ELEM
4269 ;; body's length (without final blanks) and by the length of
4270 ;; blanks between ELEM and NEXT-ELEM.
4275 ;; Small correction if buffer doesn't end
4276 ;; with a newline character.
4289 "Put point at beginning of this element, mark at end.
4291 Interactively, if this command is repeated or (in Transient Mark
4292 mode) if the mark is active, it marks the next element after the
4293 ones already marked."
4308 "Narrow buffer to current element."
4326 "Transpose current and previous elements, keeping blank lines between.
4327 Point is moved after both elements."
4335 "Un-indent the visible part of the buffer.
4336 Relative indentation (between items, inside blocks, etc.) isn't
4337 modified."
4342 unindent-tree ; For byte-compiler.
4360 "Fill element at point, when applicable.
4362 This function only applies to paragraph, comment blocks, example
4363 blocks and fixed-width areas. Also, as a special case, re-align
4364 table when point is at one.
4366 If JUSTIFY is non-nil (interactively, with prefix argument),
4367 justify as well. If `sentence-end-double-space' is non-nil, then
4368 period followed by one space does not end a sentence, so don't
4369 break a line there. The variable `fill-column' controls the
4370 width for filling."
4373 ;; Align Org tables, leave table.el tables as-is.
4377 t)
4378 ;; Elements that may contain `line-break' type objects.
4382 ;; Do nothing if point is at an affiliated keyword or at
4383 ;; verse block markers.
4385 ;; At a verse block, first narrow to current "paragraph"
4386 ;; and set current element to that paragraph.
4399 ;; Fill paragraph, taking line breaks into consideration.
4400 ;; For that, slice the paragraph using line breaks as
4401 ;; separators, and fill the parts in reverse order to
4402 ;; avoid messing with markers.
4409 ;; Find the list of ending positions for line breaks
4410 ;; in the current paragraph. Add paragraph beginning
4411 ;; to include first slice.
4416 beg end nil org-element-all-objects)
4417 'line-break
4419 ;; Elements whose contents should be filled as plain text.
4433 ;; Ignore every other element.
4438 ;;; org-element.el ends here