| blob | 8f460471d5b67944857de27835a38aa934a79a6e |
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 defines Org syntax, while the second
89 ;; one provide accessors and setters functions.
90 ;;
91 ;; The next part implements a parser and an interpreter for each
92 ;; element and object type in Org syntax.
93 ;;
94 ;; The following part creates a fully recursive buffer parser. It
95 ;; also provides a tool to map a function to elements or objects
96 ;; matching some criteria in the parse tree. Functions of interest
97 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
98 ;; extent, `org-element-parse-secondary-string'.
99 ;;
100 ;; The penultimate part is the cradle of an interpreter for the
101 ;; obtained parse tree: `org-element-interpret-data'.
102 ;;
103 ;; The library ends by furnishing a set of interactive tools for
104 ;; element's navigation and manipulation, mostly based on
105 ;; `org-element-at-point' function, and a way to give information
106 ;; about document structure around point with `org-element-context'.
109 ;;; Code:
116 \f
117 ;;; Definitions And Rules
118 ;;
119 ;; Define elements, greater elements and specify recursive objects,
120 ;; along with the affiliated keywords recognized. Also set up
121 ;; restrictions on recursive objects combinations.
122 ;;
123 ;; These variables really act as a control center for the parsing
124 ;; 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)
201 "Alist between block names and the associated parsing function.
202 Names must be uppercase. Any block whose name has no association
208 "List of affiliated keywords as strings.
214 ;; Regular affiliated keywords.
217 "Regexp matching any affiliated keyword.
219 Keyword name is put in match group 1. Moreover, if keyword
220 belongs to `org-element-dual-keywords', put the dual value in
221 match group 2.
229 "Alist of usual translations for keywords.
230 The key is the old name and the value the new one. The property
234 "List of affiliated keywords that can occur more that once in an element.
236 Their value will be consed into a list of strings, which will be
237 returned as the value of the property.
239 This list is checked after translations have been applied. See
240 `org-element-keyword-translation-alist'.
246 "List of keywords whose value can be parsed.
248 Their value will be stored as a secondary string: a list of
249 strings and objects.
251 This list is checked after translations have been applied. See
255 "List of keywords which can have a secondary value.
257 In Org syntax, they can be written with optional square brackets
258 before the colons. For example, results keyword can be
259 associated to a hash value with the following:
261 #+RESULTS[hash-string]: some-source
263 This list is checked after translations have been applied. See
270 inline-src-block latex-or-entity line-break link macro
271 radio-target sub/superscript target text-markup
272 timestamp)
274 radio-target statistics-cookie sub/superscript target text-markup
275 timestamp)
287 inline-src-block latex-or-entity line-break link macro
288 radio-target statistics-cookie sub/superscript target text-markup
289 timestamp)
292 latex-or-entity link radio-target sub/superscript target
293 text-markup timestamp)
304 latex-or-entity line-break link macro radio-target
306 "Alist of objects restrictions.
308 CAR is an element or object type containing objects and CDR is
309 a list of successors that will be called within an element or
310 object of such type.
312 For example, in a `radio-target' object, one can only find
313 entities, export snippets, latex-fragments, subscript and
314 superscript.
316 This alist also applies to secondary string. For example, an
317 `headline' type element doesn't directly contain objects, but
328 \f
329 ;;; Accessors and Setters
330 ;;
331 ;; Provide four accessors: `org-element-type', `org-element-property'
332 ;; `org-element-contents' and `org-element-restriction'.
333 ;;
334 ;; Setter functions allow to modify elements by side effect. There is
335 ;; `org-element-put-property', `org-element-set-contents',
336 ;; `org-element-set-element' and `org-element-adopt-element'. Note
337 ;; that `org-element-set-element' and `org-element-adopt-element' are
338 ;; higher level functions since also update `:parent' property.
341 "Return type of ELEMENT.
343 The function returns the type of the element or object provided.
344 It can also return the following special value:
345 `plain-text' for a string
346 `org-data' for a complete document
347 nil in any other case."
353 "Extract the value from the PROPERTY of an ELEMENT."
357 "Extract contents from an ELEMENT."
361 "Return restriction associated to ELEMENT.
362 ELEMENT can be an element, an object or a symbol representing an
363 element or object type."
365 org-element-object-restrictions)))
368 "In ELEMENT set PROPERTY to VALUE.
369 Return modified element."
372 element)
375 "Set ELEMENT contents to CONTENTS.
376 Return modified element."
382 "Replace element or object OLD with element or object NEW.
383 The function takes care of setting `:parent' property for NEW."
384 ;; OLD can belong to the contents of PARENT or to its secondary
385 ;; string.
388 org-element-secondary-value-alist)))
391 ;; Make sure NEW has correct `:parent' property.
393 ;; Replace OLD with NEW in PARENT.
397 "Add an element to the contents of another element.
399 PARENT is an element or object. CHILD is an element, an object,
400 or a string.
402 CHILD is added at the beginning of PARENT contents, unless the
403 optional argument APPEND is non-nil, in which case CHILD is added
404 at the end.
406 The function takes care of setting `:parent' property for CHILD.
407 Return parent element."
411 parent
413 ;; Link the CHILD element with PARENT.
415 ;; Return the parent element.
416 parent))
419 \f
420 ;;; Greater elements
421 ;;
422 ;; For each greater element type, we define a parser and an
423 ;; interpreter.
424 ;;
425 ;; A parser returns the element or object as the list described above.
426 ;; Most of them accepts no argument. Though, exceptions exist. Hence
427 ;; every element containing a secondary string (see
428 ;; `org-element-secondary-value-alist') will accept an optional
429 ;; argument to toggle parsing of that secondary string. Moreover,
430 ;; `item' parser requires current list's structure as its first
431 ;; element.
432 ;;
433 ;; An interpreter accepts two arguments: the list representation of
434 ;; the element or object, and its contents. The latter may be nil,
435 ;; depending on the element or object considered. It returns the
436 ;; appropriate Org syntax, as a string.
437 ;;
438 ;; Parsing functions must follow the naming convention:
439 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
440 ;; defined in `org-element-greater-elements'.
441 ;;
442 ;; Similarly, interpreting functions must follow the naming
443 ;; convention: org-element-TYPE-interpreter.
444 ;;
445 ;; With the exception of `headline' and `item' types, greater elements
446 ;; cannot contain other greater elements of their own type.
447 ;;
448 ;; Beside implementing a parser and an interpreter, adding a new
449 ;; greater element requires to tweak `org-element--current-element'.
450 ;; Moreover, the newly defined type must be added to both
451 ;; `org-element-all-elements' and `org-element-greater-elements'.
454 ;;;; Center Block
457 "Parse a center block.
459 LIMIT bounds the search.
461 Return a list whose CAR is `center-block' and CDR is a plist
462 containing `:begin', `:end', `:hiddenp', `:contents-begin',
463 `:contents-end' and `:post-blank' keywords.
465 Assume point is at the beginning of the block."
469 ;; Incomplete-block: parse it as a comment.
485 :end end
486 :hiddenp hidden
487 :contents-begin contents-begin
488 :contents-end contents-end
493 "Interpret CENTER-BLOCK element as Org syntax.
494 CONTENTS is the contents of the element."
498 ;;;; Drawer
501 "Parse a drawer.
503 LIMIT bounds the search.
505 Return a list whose CAR is `drawer' and CDR is a plist containing
506 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
507 `:contents-end' and `:post-blank' keywords.
509 Assume point is at beginning of drawer."
526 :end end
527 :drawer-name name
528 :hiddenp hidden
529 :contents-begin contents-begin
530 :contents-end contents-end
535 "Interpret DRAWER element as Org syntax.
536 CONTENTS is the contents of the element."
539 contents))
542 ;;;; Dynamic Block
545 "Parse a dynamic block.
547 LIMIT bounds the search.
549 Return a list whose CAR is `dynamic-block' and CDR is a plist
550 containing `:block-name', `:begin', `:end', `:hiddenp',
551 `:contents-begin', `:contents-end', `:arguments' and
552 `:post-blank' keywords.
554 Assume point is at beginning of dynamic block."
557 ;; Incomplete block: parse it as a comment.
576 :end end
577 :block-name name
578 :arguments arguments
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
586 "Interpret DYNAMIC-BLOCK element as Org syntax.
587 CONTENTS is the contents of the element."
592 contents))
595 ;;;; Footnote Definition
598 "Parse a footnote definition.
600 LIMIT bounds the search.
602 Return a list whose CAR is `footnote-definition' and CDR is
603 a plist containing `:label', `:begin' `:end', `:contents-begin',
604 `:contents-end' and `:post-blank' keywords.
606 Assume point is at the beginning of the footnote definition."
628 :begin begin
629 :end end
630 :contents-begin contents-begin
631 :contents-end contents-end
636 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
637 CONTENTS is the contents of the footnote-definition."
639 " "
640 contents))
643 ;;;; Headline
646 "Parse an headline.
648 Return a list whose CAR is `headline' and CDR is a plist
649 containing `:raw-value', `:title', `:begin', `:end',
650 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
651 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
652 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
653 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
654 keywords.
656 The plist also contains any property set in the property drawer,
657 with its name in lowercase, the underscores replaced with hyphens
658 and colons at the beginning (i.e. `:custom-id').
660 When RAW-SECONDARY-P is non-nil, headline's title will not be
661 parsed as a secondary string, but as a plain string instead.
663 Assume point is at beginning of the headline."
693 plist))
709 ;; Clean RAW-VALUE from any quote or comment string.
714 ""
715 raw-value)))
716 ;; Clean TAGS from archive tag, if any.
722 :begin begin
723 :end end
725 :hiddenp hidden
726 :contents-begin contents-begin
727 :contents-end contents-end
728 :level level
730 :tags tags
731 :todo-keyword todo
732 :todo-type todo-type
733 :scheduled scheduled
734 :deadline deadline
735 :timestamp timestamp
736 :clock clock
738 :footnote-section-p footnote-section-p
739 :archivedp archivedp
740 :commentedp commentedp
742 standard-props))))
744 headline :title
750 "Interpret HEADLINE element as Org syntax.
751 CONTENTS is the contents of the element."
778 ;; Align tags.
786 ? )
787 tags))
791 tags))))
793 contents)))
796 ;;;; Inlinetask
799 "Parse an inline task.
801 Return a list whose CAR is `inlinetask' and CDR is a plist
802 containing `:title', `:begin', `:end', `:hiddenp',
803 `:contents-begin' and `:contents-end', `:level', `:priority',
804 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
805 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
807 The plist also contains any property set in the property drawer,
808 with its name in lowercase, the underscores replaced with hyphens
809 and colons at the beginning (i.e. `:custom-id').
811 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
812 title will not be parsed as a secondary string, but as a plain
813 string instead.
815 Assume point is at beginning of the inline task."
836 plist))
845 ;; In the case of a single line task, CONTENTS-BEGIN and
846 ;; CONTENTS-END might overlap.
856 :end end
858 :contents-begin contents-begin
859 :contents-end contents-end
862 :tags tags
863 :todo-keyword todo
864 :todo-type todo-type
865 :scheduled scheduled
866 :deadline deadline
867 :timestamp timestamp
868 :clock clock
870 standard-props
873 inlinetask :title
878 inlinetask))))))
881 "Interpret INLINETASK element as Org syntax.
882 CONTENTS is the contents of inlinetask."
897 ;; Align tags.
905 ? )
906 tags))
910 tags))))
911 ;; Prefer degenerate inlinetasks when there are no
912 ;; contents.
915 contents
919 ;;;; Item
922 "Parse an item.
924 STRUCT is the structure of the plain list.
926 Return a list whose CAR is `item' and CDR is a plist containing
927 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
928 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
929 `:post-blank' keywords.
931 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
932 any, will not be parsed as a secondary string, but as a plain
933 string instead.
935 Assume point is at the beginning of the item."
956 ;; If first line isn't empty,
957 ;; contents really start at the text
958 ;; after item's meta-data.
971 :begin begin
972 :end end
973 ;; CONTENTS-BEGIN and CONTENTS-END may be
974 ;; mixed up in the case of an empty item
975 ;; separated from the next by a blank line.
976 ;; Thus ensure the former is always the
977 ;; smallest.
980 :checkbox checkbox
981 :counter counter
982 :hiddenp hidden
983 :structure struct
986 item :tag
994 "Interpret ITEM element as Org syntax.
995 CONTENTS is the contents of the element."
1009 num
1016 ;; Compute indentation.
1021 ;; Indent contents.
1023 bullet
1036 ;;;; Plain List
1039 "Parse a plain list.
1041 Optional argument STRUCTURE, when non-nil, is the structure of
1042 the plain list being parsed.
1044 Return a list whose CAR is `plain-list' and CDR is a plist
1045 containing `:type', `:begin', `:end', `:contents-begin' and
1046 `:contents-end', `:structure' and `:post-blank' keywords.
1048 Assume point is at the beginning of the list."
1061 ;; Blank lines below list belong to the top-level list only.
1066 ;; Return value.
1070 :begin begin
1071 :end end
1072 :contents-begin contents-begin
1073 :contents-end contents-end
1074 :structure struct
1079 "Interpret PLAIN-LIST element as Org syntax.
1080 CONTENTS is the contents of the element."
1081 contents)
1084 ;;;; Quote Block
1087 "Parse a quote block.
1089 LIMIT bounds the search.
1091 Return a list whose CAR is `quote-block' and CDR is a plist
1092 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1093 `:contents-end' and `:post-blank' keywords.
1095 Assume point is at the beginning of the block."
1099 ;; Incomplete block: parse it as a comment.
1115 :end end
1116 :hiddenp hidden
1117 :contents-begin contents-begin
1118 :contents-end contents-end
1123 "Interpret QUOTE-BLOCK element as Org syntax.
1124 CONTENTS is the contents of the element."
1128 ;;;; Section
1131 "Parse a section.
1133 LIMIT bounds the search.
1135 Return a list whose CAR is `section' and CDR is a plist
1136 containing `:begin', `:end', `:contents-begin', `contents-end'
1137 and `:post-blank' keywords."
1139 ;; Beginning of section is the beginning of the first non-blank
1140 ;; line after previous headline.
1149 :end end
1150 :contents-begin begin
1151 :contents-end pos-before-blank
1155 "Interpret SECTION element as Org syntax.
1156 CONTENTS is the contents of the element."
1157 contents)
1160 ;;;; Special Block
1163 "Parse a special block.
1165 LIMIT bounds the search.
1167 Return a list whose CAR is `special-block' and CDR is a plist
1168 containing `:type', `:begin', `:end', `:hiddenp',
1169 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1171 Assume point is at the beginning of the block."
1177 ;; Incomplete block: parse it as a comment.
1193 :begin begin
1194 :end end
1195 :hiddenp hidden
1196 :contents-begin contents-begin
1197 :contents-end contents-end
1202 "Interpret SPECIAL-BLOCK element as Org syntax.
1203 CONTENTS is the contents of the element."
1208 \f
1209 ;;; Elements
1210 ;;
1211 ;; For each element, a parser and an interpreter are also defined.
1212 ;; Both follow the same naming convention used for greater elements.
1213 ;;
1214 ;; Also, as for greater elements, adding a new element type is done
1215 ;; through the following steps: implement a parser and an interpreter,
1216 ;; tweak `org-element--current-element' so that it recognizes the new
1217 ;; type and add that new type to `org-element-all-elements'.
1218 ;;
1219 ;; As a special case, when the newly defined type is a block type,
1220 ;; `org-element-block-name-alist' has to be modified accordingly.
1223 ;;;; Babel Call
1226 "Parse a babel call.
1228 LIMIT bounds the search.
1230 Return a list whose CAR is `babel-call' and CDR is a plist
1231 containing `:begin', `:end', `:info' and `:post-blank' as
1232 keywords."
1243 :end end
1244 :info info
1248 "Interpret BABEL-CALL element as Org syntax.
1249 CONTENTS is nil."
1255 ;; Remove redundant square brackets.
1260 ;;;; Clock
1263 "Parse a clock.
1265 LIMIT bounds the search.
1267 Return a list whose CAR is `clock' and CDR is a plist containing
1268 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1269 as keywords."
1288 :value value
1289 :time time
1290 :begin begin
1291 :end end
1295 "Interpret CLOCK element as Org syntax.
1296 CONTENTS is nil."
1303 "%2s:%02s"
1307 ;;;; Comment
1310 "Parse a comment.
1312 LIMIT bounds the search.
1314 Return a list whose CAR is `comment' and CDR is a plist
1315 containing `:begin', `:end', `:value' and `:post-blank'
1316 keywords.
1318 Assume point is at comment beginning."
1322 ;; Match first line with a loose regexp since it might as
1323 ;; well be an ill-defined keyword.
1329 ;; Get comments ending.
1333 ;; Accumulate lines without leading hash and plus sign
1334 ;; if any. First whitespace is also ignored.
1347 :end end
1348 :value value
1353 "Interpret COMMENT element as Org syntax.
1354 CONTENTS is nil."
1358 ;;;; Comment Block
1361 "Parse an export block.
1363 LIMIT bounds the search.
1365 Return a list whose CAR is `comment-block' and CDR is a plist
1366 containing `:begin', `:end', `:hiddenp', `:value' and
1367 `:post-blank' keywords.
1369 Assume point is at comment block beginning."
1373 ;; Incomplete block: parse it as a comment.
1387 contents-begin contents-end)))
1391 :end end
1392 :value value
1393 :hiddenp hidden
1398 "Interpret COMMENT-BLOCK element as Org syntax.
1399 CONTENTS is nil."
1404 ;;;; Example Block
1407 "Parse an example block.
1409 LIMIT bounds the search.
1411 Return a list whose CAR is `example-block' and CDR is a plist
1412 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1413 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1414 `:switches', `:value' and `:post-blank' keywords."
1418 ;; Incomplete block: parse it as a comment.
1425 ;; Switches analysis
1430 ;; Should labels be retained in (or stripped from) example
1431 ;; blocks?
1436 ;; What should code-references use - labels or
1437 ;; line-numbers?
1444 ;; Standard block parsing.
1458 :end end
1459 :value value
1460 :switches switches
1461 :number-lines number-lines
1462 :preserve-indent preserve-indent
1463 :retain-labels retain-labels
1464 :use-labels use-labels
1465 :label-fmt label-fmt
1466 :hiddenp hidden
1471 "Interpret EXAMPLE-BLOCK element as Org syntax.
1472 CONTENTS is nil."
1480 ;;;; Export Block
1483 "Parse an export block.
1485 LIMIT bounds the search.
1487 Return a list whose CAR is `export-block' and CDR is a plist
1488 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1489 `:post-blank' keywords.
1491 Assume point is at export-block beginning."
1497 ;; Incomplete block: parse it as a comment.
1511 contents-end)))
1515 :end end
1516 :type type
1517 :value value
1518 :hiddenp hidden
1523 "Interpret EXPORT-BLOCK element as Org syntax.
1524 CONTENTS is nil."
1531 ;;;; Fixed-width
1534 "Parse a fixed-width section.
1536 LIMIT bounds the search.
1538 Return a list whose CAR is `fixed-width' and CDR is a plist
1539 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1541 Assume point is at the beginning of the fixed-width area."
1545 value
1550 ;; Accumulate text without starting colons.
1563 :end end
1564 :value value
1569 "Interpret FIXED-WIDTH element as Org syntax.
1570 CONTENTS is nil."
1575 ;;;; Horizontal Rule
1578 "Parse an horizontal rule.
1580 LIMIT bounds the search.
1582 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1583 containing `:begin', `:end' and `:post-blank' keywords."
1593 :end end
1598 "Interpret HORIZONTAL-RULE element as Org syntax.
1599 CONTENTS is nil."
1603 ;;;; Keyword
1606 "Parse a keyword at point.
1608 LIMIT bounds the search.
1610 Return a list whose CAR is `keyword' and CDR is a plist
1611 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1612 keywords."
1625 :value value
1626 :begin begin
1627 :end end
1631 "Interpret KEYWORD element as Org syntax.
1632 CONTENTS is nil."
1638 ;;;; Latex Environment
1641 "Parse a LaTeX environment.
1643 LIMIT bounds the search.
1645 Return a list whose CAR is `latex-environment' and CDR is a plist
1646 containing `:begin', `:end', `:value' and `:post-blank'
1647 keywords.
1649 Assume point is at the beginning of the latex environment."
1667 :end end
1668 :value value
1673 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1674 CONTENTS is nil."
1678 ;;;; Paragraph
1681 "Parse a paragraph.
1683 LIMIT bounds the search.
1685 Return a list whose CAR is `paragraph' and CDR is a plist
1686 containing `:begin', `:end', `:contents-begin' and
1687 `:contents-end' and `:post-blank' keywords.
1689 Assume point is at the beginning of the paragraph."
1697 limit
1705 ;; If paragraph has no affiliated keywords, it may not begin
1706 ;; at beginning of line if it starts an item.
1709 :end end
1710 :contents-begin contents-begin
1711 :contents-end contents-end
1716 "Interpret PARAGRAPH element as Org syntax.
1717 CONTENTS is the contents of the element."
1718 contents)
1721 ;;;; Planning
1724 "Parse a planning.
1726 LIMIT bounds the search.
1728 Return a list whose CAR is `planning' and CDR is a plist
1729 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1730 and `:post-blank' keywords."
1739 closed deadline scheduled)
1753 :deadline deadline
1754 :scheduled scheduled
1755 :begin begin
1756 :end end
1760 "Interpret PLANNING element as Org syntax.
1761 CONTENTS is nil."
1763 'identity
1775 ;;;; Property Drawer
1778 "Parse a property drawer.
1780 LIMIT bounds the search.
1782 Return a list whose CAR is `property-drawer' and CDR is a plist
1783 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1784 `:contents-end', `:properties' and `:post-blank' keywords.
1786 Assume point is at the beginning of the property drawer."
1800 val))
1802 val))
1810 :end end
1811 :hiddenp hidden
1812 :properties properties
1816 "Interpret PROPERTY-DRAWER element as Org syntax.
1817 CONTENTS is nil."
1827 ;;;; Quote Section
1830 "Parse a quote section.
1832 LIMIT bounds the search.
1834 Return a list whose CAR is `quote-section' and CDR is a plist
1835 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1837 Assume point is at beginning of the section."
1848 :end end
1849 :value value
1853 "Interpret QUOTE-SECTION element as Org syntax.
1854 CONTENTS is nil."
1858 ;;;; Src Block
1861 "Parse a src block.
1863 LIMIT bounds the search.
1865 Return a list whose CAR is `src-block' and CDR is a plist
1866 containing `:language', `:switches', `:parameters', `:begin',
1867 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1868 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1869 `:post-blank' keywords.
1871 Assume point is at the beginning of the block."
1874 ;; Incomplete block: parse it as a comment.
1879 ;; Get beginning position.
1881 ;; Get language as a string.
1890 ;; Get switches.
1892 ;; Get parameters.
1894 ;; Switches analysis
1902 ;; Should labels be retained in (or stripped from)
1903 ;; src blocks?
1908 ;; What should code-references use - labels or
1909 ;; line-numbers?
1913 ;; Get visibility status.
1915 ;; Retrieve code.
1920 ;; Get position after ending blank lines.
1930 :begin begin
1931 :end end
1932 :number-lines number-lines
1933 :preserve-indent preserve-indent
1934 :retain-labels retain-labels
1935 :use-labels use-labels
1936 :label-fmt label-fmt
1937 :hiddenp hidden
1938 :value value
1943 "Interpret SRC-BLOCK element as Org syntax.
1944 CONTENTS is nil."
1964 value
1968 ;;;; Table
1971 "Parse a table at point.
1973 LIMIT bounds the search.
1975 Return a list whose CAR is `table' and CDR is a plist containing
1976 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1977 `:contents-end', `:value' and `:post-blank' keywords.
1979 Assume point is at the beginning of the table."
1991 acc))
1998 :end end
1999 :type type
2000 :tblfm tblfm
2001 ;; Only `org' tables have contents. `table.el' tables
2002 ;; use a `:value' property to store raw table as
2003 ;; a string.
2008 table-begin table-end))
2013 "Interpret TABLE element as Org syntax.
2014 CONTENTS is nil."
2025 ;;;; Table Row
2028 "Parse table row at point.
2030 LIMIT bounds the search.
2032 Return a list whose CAR is `table-row' and CDR is a plist
2033 containing `:begin', `:end', `:contents-begin', `:contents-end',
2034 `:type' and `:post-blank' keywords."
2038 ;; A table rule has no contents. In that case, ensure
2039 ;; CONTENTS-BEGIN matches CONTENTS-END.
2051 :begin begin
2052 :end end
2053 :contents-begin contents-begin
2054 :contents-end contents-end
2058 "Interpret TABLE-ROW element as Org syntax.
2059 CONTENTS is the contents of the table row."
2064 ;;;; Verse Block
2067 "Parse a verse block.
2069 LIMIT bounds the search.
2071 Return a list whose CAR is `verse-block' and CDR is a plist
2072 containing `:begin', `:end', `:contents-begin', `:contents-end',
2073 `:hiddenp' and `:post-blank' keywords.
2075 Assume point is at beginning of the block."
2079 ;; Incomplete block: parse it as a comment.
2095 :end end
2096 :contents-begin contents-begin
2097 :contents-end contents-end
2098 :hiddenp hidden
2103 "Interpret VERSE-BLOCK element as Org syntax.
2104 CONTENTS is verse block contents."
2108 \f
2109 ;;; Objects
2110 ;;
2111 ;; Unlike to elements, interstices can be found between objects.
2112 ;; That's why, along with the parser, successor functions are provided
2113 ;; for each object. Some objects share the same successor (i.e. `code'
2114 ;; and `verbatim' objects).
2115 ;;
2116 ;; A successor must accept a single argument bounding the search. It
2117 ;; will return either a cons cell whose CAR is the object's type, as
2118 ;; a symbol, and CDR the position of its next occurrence, or nil.
2119 ;;
2120 ;; Successors follow the naming convention:
2121 ;; org-element-NAME-successor, where NAME is the name of the
2122 ;; successor, as defined in `org-element-all-successors'.
2123 ;;
2124 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
2125 ;; object types they can contain will be specified in
2126 ;; `org-element-object-restrictions'.
2127 ;;
2128 ;; Adding a new type of object is simple. Implement a successor,
2129 ;; a parser, and an interpreter for it, all following the naming
2130 ;; convention. Register type in `org-element-all-objects' and
2131 ;; successor in `org-element-all-successors'. Maybe tweak
2132 ;; restrictions about it, and that's it.
2135 ;;;; Bold
2138 "Parse bold object at point.
2140 Return a list whose CAR is `bold' and CDR is a plist with
2141 `:begin', `:end', `:contents-begin' and `:contents-end' and
2142 `:post-blank' keywords.
2144 Assume point is at the first star marker."
2156 :end end
2157 :contents-begin contents-begin
2158 :contents-end contents-end
2162 "Interpret BOLD object as Org syntax.
2163 CONTENTS is the contents of the object."
2167 "Search for the next text-markup object.
2169 LIMIT bounds the search.
2171 LIMIT bounds the search.
2173 Return value is a cons cell whose CAR is a symbol among `bold',
2174 `italic', `underline', `strike-through', `code' and `verbatim'
2175 and CDR is beginning position."
2191 ;;;; Code
2194 "Parse code object at point.
2196 Return a list whose CAR is `code' and CDR is a plist with
2197 `:value', `:begin', `:end' and `:post-blank' keywords.
2199 Assume point is at the first tilde marker."
2210 :begin begin
2211 :end end
2215 "Interpret CODE object as Org syntax.
2216 CONTENTS is nil."
2220 ;;;; Entity
2223 "Parse entity at point.
2225 Return a list whose CAR is `entity' and CDR a plist with
2226 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2227 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2228 keywords.
2230 Assume point is at the beginning of the entity."
2232 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2248 :begin begin
2249 :end end
2250 :use-brackets-p bracketsp
2254 "Interpret ENTITY object as Org syntax.
2255 CONTENTS is nil."
2261 "Search for the next latex-fragment or entity object.
2263 LIMIT bounds the search.
2265 Return value is a cons cell whose CAR is `entity' or
2266 `latex-fragment' and CDR is beginning position."
2269 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2276 limit t)
2279 ;; Determine if it's a real entity or a LaTeX command.
2282 ;; No entity nor command: point is at a LaTeX fragment.
2283 ;; Determine its type to get the correct beginning position.
2291 matchers)
2295 ;;;; Export Snippet
2298 "Parse export snippet at point.
2300 Return a list whose CAR is `export-snippet' and CDR a plist with
2301 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2302 keywords.
2304 Assume point is at the beginning of the snippet."
2316 :value value
2317 :begin begin
2318 :end end
2322 "Interpret EXPORT-SNIPPET object as Org syntax.
2323 CONTENTS is nil."
2329 "Search for the next export-snippet object.
2331 LIMIT bounds the search.
2333 Return value is a cons cell whose CAR is `export-snippet' and CDR
2334 its beginning position."
2343 ;;;; Footnote Reference
2346 "Parse footnote reference at point.
2348 Return a list whose CAR is `footnote-reference' and CDR a plist
2349 with `:label', `:type', `:inline-definition', `:begin', `:end'
2350 and `:post-blank' as keywords."
2372 :type type
2373 :begin begin
2374 :end end
2377 footnote-reference :inline-definition
2382 footnote-reference))))))
2385 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2386 CONTENTS is nil."
2396 "Search for the next footnote-reference object.
2398 LIMIT bounds the search.
2400 Return value is a cons cell whose CAR is `footnote-reference' and
2401 CDR is beginning position."
2415 ;;;; Inline Babel Call
2418 "Parse inline babel call at point.
2420 Return a list whose CAR is `inline-babel-call' and CDR a plist
2421 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2423 Assume point is at the beginning of the babel call."
2434 :end end
2435 :info info
2439 "Interpret INLINE-BABEL-CALL object as Org syntax.
2440 CONTENTS is nil."
2446 ;; Remove redundant square brackets.
2449 main-source)
2453 "Search for the next inline-babel-call object.
2455 LIMIT bounds the search.
2457 Return value is a cons cell whose CAR is `inline-babel-call' and
2458 CDR is beginning position."
2460 ;; Use a simplified version of
2461 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2463 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2464 limit t)
2468 ;;;; Inline Src Block
2471 "Parse inline source block at point.
2473 LIMIT bounds the search.
2475 Return a list whose CAR is `inline-src-block' and CDR a plist
2476 with `:begin', `:end', `:language', `:value', `:parameters' and
2477 `:post-blank' as keywords.
2479 Assume point is at the beginning of the inline src block."
2492 :value value
2493 :parameters parameters
2494 :begin begin
2495 :end end
2499 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2500 CONTENTS is nil."
2505 language
2507 body)))
2510 "Search for the next inline-babel-call element.
2512 LIMIT bounds the search.
2514 Return value is a cons cell whose CAR is `inline-babel-call' and
2515 CDR is beginning position."
2520 ;;;; Italic
2523 "Parse italic object at point.
2525 Return a list whose CAR is `italic' and CDR is a plist with
2526 `:begin', `:end', `:contents-begin' and `:contents-end' and
2527 `:post-blank' keywords.
2529 Assume point is at the first slash marker."
2541 :end end
2542 :contents-begin contents-begin
2543 :contents-end contents-end
2547 "Interpret ITALIC object as Org syntax.
2548 CONTENTS is the contents of the object."
2552 ;;;; Latex Fragment
2555 "Parse latex fragment at point.
2557 Return a list whose CAR is `latex-fragment' and CDR a plist with
2558 `:value', `:begin', `:end', and `:post-blank' as keywords.
2560 Assume point is at the beginning of the latex fragment."
2574 ;; None found: it's a macro.
2583 :begin begin
2584 :end end
2588 "Interpret LATEX-FRAGMENT object as Org syntax.
2589 CONTENTS is nil."
2592 ;;;; Line Break
2595 "Parse line break at point.
2597 Return a list whose CAR is `line-break', and CDR a plist with
2598 `:begin', `:end' and `:post-blank' keywords.
2600 Assume point is at the beginning of the line break."
2604 "Interpret LINE-BREAK object as Org syntax.
2605 CONTENTS is nil."
2609 "Search for the next line-break object.
2611 LIMIT bounds the search.
2613 Return value is a cons cell whose CAR is `line-break' and CDR is
2614 beginning position."
2618 ;; A line break can only happen on a non-empty line.
2623 ;;;; Link
2626 "Parse link at point.
2628 Return a list whose CAR is `link' and CDR a plist with `:type',
2629 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2630 `:contents-end' and `:post-blank' as keywords.
2632 Assume point is at the beginning of the link."
2635 end contents-begin contents-end link-end post-blank path type
2636 raw-link link)
2638 ;; Type 1: Text targeted from a radio target.
2643 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2648 ;; RAW-LINK is the original link.
2653 ;; Determine TYPE of link and set PATH accordingly.
2655 ;; File type.
2658 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2661 ;; Id type: PATH is the id.
2664 ;; Code-ref type: PATH is the name of the reference.
2667 ;; Custom-id type: PATH is the name of the custom id.
2670 ;; Fuzzy type: Internal link either matches a target, an
2671 ;; headline name or nothing. PATH is the target or
2672 ;; headline's name.
2674 ;; Type 3: Plain link, i.e. http://orgmode.org
2680 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2687 ;; In any case, deduce end point after trailing white space from
2688 ;; LINK-END variable.
2693 :path path
2695 :begin begin
2696 :end end
2697 :contents-begin contents-begin
2698 :contents-end contents-end
2702 "Interpret LINK object as Org syntax.
2703 CONTENTS is the contents of the object, or nil."
2708 raw-link
2712 "Search for the next link object.
2714 LIMIT bounds the search.
2716 Return value is a cons cell whose CAR is `link' and CDR is
2717 beginning position."
2726 ;;;; Macro
2729 "Parse macro at point.
2731 Return a list whose CAR is `macro' and CDR a plist with `:key',
2732 `:args', `:begin', `:end', `:value' and `:post-blank' as
2733 keywords.
2735 Assume point is at the macro."
2749 ;; Repair bad splits.
2757 :value value
2758 :args args
2759 :begin begin
2760 :end end
2764 "Interpret MACRO object as Org syntax.
2765 CONTENTS is nil."
2769 "Search for the next macro object.
2771 LIMIT bounds the search.
2773 Return value is cons cell whose CAR is `macro' and CDR is
2774 beginning position."
2778 limit t)
2782 ;;;; Radio-target
2785 "Parse radio target at point.
2787 Return a list whose CAR is `radio-target' and CDR a plist with
2788 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2789 and `:post-blank' as keywords.
2791 Assume point is at the radio target."
2803 :end end
2804 :contents-begin contents-begin
2805 :contents-end contents-end
2806 :post-blank post-blank
2810 "Interpret TARGET object as Org syntax.
2811 CONTENTS is the contents of the object."
2815 "Search for the next radio-target object.
2817 LIMIT bounds the search.
2819 Return value is a cons cell whose CAR is `radio-target' and CDR
2820 is beginning position."
2826 ;;;; Statistics Cookie
2829 "Parse statistics cookie at point.
2831 Return a list whose CAR is `statistics-cookie', and CDR a plist
2832 with `:begin', `:end', `:value' and `:post-blank' keywords.
2834 Assume point is at the beginning of the statistics-cookie."
2845 :end end
2846 :value value
2850 "Interpret STATISTICS-COOKIE object as Org syntax.
2851 CONTENTS is nil."
2855 "Search for the next statistics cookie object.
2857 LIMIT bounds the search.
2859 Return value is a cons cell whose CAR is `statistics-cookie' and
2860 CDR is beginning position."
2866 ;;;; Strike-Through
2869 "Parse strike-through object at point.
2871 Return a list whose CAR is `strike-through' and CDR is a plist
2872 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2873 `:post-blank' keywords.
2875 Assume point is at the first plus sign marker."
2887 :end end
2888 :contents-begin contents-begin
2889 :contents-end contents-end
2893 "Interpret STRIKE-THROUGH object as Org syntax.
2894 CONTENTS is the contents of the object."
2898 ;;;; Subscript
2901 "Parse subscript at point.
2903 Return a list whose CAR is `subscript' and CDR a plist with
2904 `:begin', `:end', `:contents-begin', `:contents-end',
2905 `:use-brackets-p' and `:post-blank' as keywords.
2907 Assume point is at the underscore."
2911 t
2922 :end end
2923 :use-brackets-p bracketsp
2924 :contents-begin contents-begin
2925 :contents-end contents-end
2929 "Interpret SUBSCRIPT object as Org syntax.
2930 CONTENTS is the contents of the object."
2933 contents))
2936 "Search for the next sub/superscript object.
2938 LIMIT bounds the search.
2940 Return value is a cons cell whose CAR is either `subscript' or
2941 `superscript' and CDR is beginning position."
2948 ;;;; Superscript
2951 "Parse superscript at point.
2953 Return a list whose CAR is `superscript' and CDR a plist with
2954 `:begin', `:end', `:contents-begin', `:contents-end',
2955 `:use-brackets-p' and `:post-blank' as keywords.
2957 Assume point is at the caret."
2971 :end end
2972 :use-brackets-p bracketsp
2973 :contents-begin contents-begin
2974 :contents-end contents-end
2978 "Interpret SUPERSCRIPT object as Org syntax.
2979 CONTENTS is the contents of the object."
2982 contents))
2985 ;;;; Table Cell
2988 "Parse table cell at point.
2990 Return a list whose CAR is `table-cell' and CDR is a plist
2991 containing `:begin', `:end', `:contents-begin', `:contents-end'
2992 and `:post-blank' keywords."
3000 :end end
3001 :contents-begin contents-begin
3002 :contents-end contents-end
3006 "Interpret TABLE-CELL element as Org syntax.
3007 CONTENTS is the contents of the cell, or nil."
3011 "Search for the next table-cell object.
3013 LIMIT bounds the search.
3015 Return value is a cons cell whose CAR is `table-cell' and CDR is
3016 beginning position."
3020 ;;;; Target
3023 "Parse target at point.
3025 Return a list whose CAR is `target' and CDR a plist with
3026 `:begin', `:end', `:value' and `:post-blank' as keywords.
3028 Assume point is at the target."
3038 :end end
3039 :value value
3043 "Interpret TARGET object as Org syntax.
3044 CONTENTS is nil."
3048 "Search for the next target object.
3050 LIMIT bounds the search.
3052 Return value is a cons cell whose CAR is `target' and CDR is
3053 beginning position."
3059 ;;;; Timestamp
3062 "Parse time stamp at point.
3064 Return a list whose CAR is `timestamp', and CDR a plist with
3065 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3067 Assume point is at the beginning of the timestamp."
3086 :value main-value
3087 :range-end range-end
3088 :begin begin
3089 :end end
3093 "Interpret TIMESTAMP object as Org syntax.
3094 CONTENTS is nil."
3103 range-end)))))))
3106 "Search for the next timestamp object.
3108 LIMIT bounds the search.
3110 Return value is a cons cell whose CAR is `timestamp' and CDR is
3111 beginning position."
3119 limit t)
3123 ;;;; Underline
3126 "Parse underline object at point.
3128 Return a list whose CAR is `underline' and CDR is a plist with
3129 `:begin', `:end', `:contents-begin' and `:contents-end' and
3130 `:post-blank' keywords.
3132 Assume point is at the first underscore marker."
3144 :end end
3145 :contents-begin contents-begin
3146 :contents-end contents-end
3150 "Interpret UNDERLINE object as Org syntax.
3151 CONTENTS is the contents of the object."
3155 ;;;; Verbatim
3158 "Parse verbatim object at point.
3160 Return a list whose CAR is `verbatim' and CDR is a plist with
3161 `:value', `:begin', `:end' and `:post-blank' keywords.
3163 Assume point is at the first equal sign marker."
3174 :begin begin
3175 :end end
3179 "Interpret VERBATIM object as Org syntax.
3180 CONTENTS is nil."
3184 \f
3185 ;;; Parsing Element Starting At Point
3186 ;;
3187 ;; `org-element--current-element' is the core function of this section.
3188 ;; It returns the Lisp representation of the element starting at
3189 ;; point.
3190 ;;
3191 ;; `org-element--current-element' makes use of special modes. They
3192 ;; are activated for fixed element chaining (i.e. `plain-list' >
3193 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3194 ;; `section'). Special modes are: `first-section', `section',
3195 ;; `quote-section', `item' and `table-row'.
3199 "Parse the element starting at point.
3201 LIMIT bounds the search.
3203 Return value is a list like (TYPE PROPS) where TYPE is the type
3204 of the element and PROPS a plist of properties associated to the
3205 element.
3207 Possible types are defined in `org-element-all-elements'.
3209 Optional argument GRANULARITY determines the depth of the
3210 recursion. Allowed values are `headline', `greater-element',
3211 `element', `object' or nil. When it is broader than `object' (or
3212 nil), secondary values will not be parsed, since they only
3213 contain objects.
3215 Optional argument SPECIAL, when non-nil, can be either
3216 `first-section', `section', `quote-section', `table-row' and
3217 `item'.
3219 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3220 be computed.
3222 This function assumes point is always at the beginning of the
3223 element it has to parse."
3225 ;; If point is at an affiliated keyword, try moving to the
3226 ;; beginning of the associated element. If none is found, the
3227 ;; keyword is orphaned and will be treated as plain text.
3233 ;; Determine if parsing depth allows for secondary strings
3234 ;; parsing. It only applies to elements referenced in
3235 ;; `org-element-secondary-value-alist'.
3238 ;; Item.
3241 ;; Quote Section.
3243 ;; Table Row.
3245 ;; Headline.
3248 ;; Section (must be checked after headline).
3253 limit)))
3254 ;; Planning and Clock.
3259 ;; Inlinetask.
3262 ;; LaTeX Environment.
3268 nil t))
3271 ;; Drawer and Property Drawer.
3281 ;; Fixed Width
3284 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3285 ;; Keywords.
3294 org-element-block-name-alist)))
3306 ;; Ill-formed syntax is considered as a comment.
3310 ;; Comments.
3312 ;; Footnote Definition.
3315 ;; Horizontal Rule.
3318 ;; Table.
3320 ;; List.
3323 ;; Default element: Paragraph.
3327 ;; Most elements can have affiliated keywords. When looking for an
3328 ;; element beginning, we want to move before them, as they belong to
3329 ;; that element, and, in the meantime, collect information they give
3330 ;; into appropriate properties. Hence the following function.
3331 ;;
3332 ;; Usage of optional arguments may not be obvious at first glance:
3333 ;;
3334 ;; - TRANS-LIST is used to polish keywords names that have evolved
3335 ;; during Org history. In example, even though =result= and
3336 ;; =results= coexist, we want to have them under the same =result=
3337 ;; property. It's also true for "srcname" and "name", where the
3338 ;; latter seems to be preferred nowadays (thus the "name" property).
3339 ;;
3340 ;; - CONSED allows to regroup multi-lines keywords under the same
3341 ;; property, while preserving their own identity. This is mostly
3342 ;; used for "attr_latex" and al.
3343 ;;
3344 ;; - PARSED prepares a keyword value for export. This is useful for
3345 ;; "caption". Objects restrictions for such keywords are defined in
3346 ;; `org-element-object-restrictions'.
3347 ;;
3348 ;; - DUALS is used to take care of keywords accepting a main and an
3349 ;; optional secondary values. For example "results" has its
3350 ;; source's name as the main value, and may have an hash string in
3351 ;; optional square brackets as the secondary one.
3352 ;;
3353 ;; A keyword may belong to more than one category.
3357 "Collect affiliated keywords before point.
3359 Optional argument KEY-RE is a regexp matching keywords, which
3360 puts matched keyword in group 1. It defaults to
3361 `org-element--affiliated-re'.
3363 TRANS-LIST is an alist where key is the keyword and value the
3364 property name it should be translated to, without the colons. It
3365 defaults to `org-element-keyword-translation-alist'.
3367 CONSED is a list of strings. Any keyword belonging to that list
3368 will have its value consed. The check is done after keyword
3369 translation. It defaults to `org-element-multiple-keywords'.
3371 PARSED is a list of strings. Any keyword member of this list
3372 will have its value parsed. The check is done after keyword
3373 translation. If a keyword is a member of both CONSED and PARSED,
3374 it's value will be a list of parsed strings. It defaults to
3375 `org-element-parsed-keywords'.
3377 DUALS is a list of strings. Any keyword member of this list can
3378 have two parts: one mandatory and one optional. Its value is
3379 a cons cell whose CAR is the former, and the CDR the latter. If
3380 a keyword is a member of both PARSED and DUALS, both values will
3381 be parsed. It defaults to `org-element-dual-keywords'.
3383 Return a list whose CAR is the position at the first of them and
3384 CDR a plist of keywords and values."
3392 ;; RESTRICT is the list of objects allowed in parsed
3393 ;; keywords value.
3395 output)
3399 ;; Apply translation to RAW-KWD. From there, KWD is
3400 ;; the official keyword.
3402 ;; Find main value for any keyword.
3408 ;; If KWD is a dual keyword, find its secondary
3409 ;; value. Maybe parse it.
3415 ;; Attribute a property name to KWD.
3417 ;; Now set final shape for VALUE.
3421 ;; VALUE is mandatory. Set it to nil if there is none.
3423 ;; Attributes are always consed.
3426 ;; Eventually store the new value in OUTPUT.
3432 \f
3433 ;;; The Org Parser
3434 ;;
3435 ;; The two major functions here are `org-element-parse-buffer', which
3436 ;; parses Org syntax inside the current buffer, taking into account
3437 ;; region, narrowing, or even visibility if specified, and
3438 ;; `org-element-parse-secondary-string', which parses objects within
3439 ;; a given string.
3440 ;;
3441 ;; The (almost) almighty `org-element-map' allows to apply a function
3442 ;; on elements or objects matching some type, and accumulate the
3443 ;; resulting values. In an export situation, it also skips unneeded
3444 ;; parts of the parse tree.
3447 "Recursively parse the buffer and return structure.
3448 If narrowing is in effect, only parse the visible part of the
3449 buffer.
3451 Optional argument GRANULARITY determines the depth of the
3452 recursion. It can be set to the following symbols:
3454 `headline' Only parse headlines.
3455 `greater-element' Don't recurse into greater elements excepted
3456 headlines and sections. Thus, elements
3457 parsed are the top-level ones.
3458 `element' Parse everything but objects and plain text.
3459 `object' Parse the complete buffer (default).
3461 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3462 elements.
3464 Assume buffer is in Org mode."
3470 ;; Start in `first-section' mode so text before the first
3471 ;; headline belongs to a section.
3475 "Recursively parse objects in STRING and return structure.
3477 RESTRICTION is a symbol limiting the object types that will be
3478 looked after.
3480 Optional argument PARENT, when non-nil, is the element or object
3481 containing the secondary string. It is used to set correctly
3482 `:parent' property within the string."
3488 secondary))))
3491 "Map a function on selected elements or objects.
3493 DATA is the parsed tree, as returned by, i.e,
3494 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3495 of elements or objects types. FUN is the function called on the
3496 matching element or object. It must accept one arguments: the
3497 element or object itself.
3499 When optional argument INFO is non-nil, it should be a plist
3500 holding export options. In that case, parts of the parse tree
3501 not exportable according to that property list will be skipped.
3503 When optional argument FIRST-MATCH is non-nil, stop at the first
3504 match for which FUN doesn't return nil, and return that value.
3506 Optional argument NO-RECURSION is a symbol or a list of symbols
3507 representing elements or objects types. `org-element-map' won't
3508 enter any recursive element or object whose type belongs to that
3509 list. Though, FUN can still be applied on them.
3511 Nil values returned from FUN do not appear in the results."
3512 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3515 ;; Recursion depth is determined by --CATEGORY.
3522 ;; If one object is found, the function
3523 ;; has to recurse into every object.
3526 ;; If one regular element is found, the
3527 ;; function has to recurse, at lest, into
3528 ;; every element it encounters.
3531 types)
3532 category)))
3533 --acc
3534 --walk-tree
3538 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3539 ;; holding contextual information.
3543 ;; Ignored element in an export context.
3545 ;; Secondary string: only objects can be found there.
3548 ;; Unconditionally enter parse trees.
3552 ;; Check if TYPE is matching among TYPES. If so,
3553 ;; apply FUN to --DATA and accumulate return value
3554 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3560 ;; If --DATA has a secondary string that can contain
3561 ;; objects with their type among TYPES, look into it.
3568 ;; Determine if a recursion into --DATA is possible.
3570 ;; --TYPE is explicitly removed from recursion.
3572 ;; --DATA has no contents.
3574 ;; Looking for greater elements but --DATA is simply
3575 ;; an element or an object.
3578 ;; Looking for elements but --DATA is an object.
3581 ;; In any other case, map contents.
3585 ;; Return value in a proper order.
3588 ;; The following functions are internal parts of the parser.
3589 ;;
3590 ;; The first one, `org-element--parse-elements' acts at the element's
3591 ;; level.
3592 ;;
3593 ;; The second one, `org-element--parse-objects' applies on all objects
3594 ;; of a paragraph or a secondary string. It uses
3595 ;; `org-element--get-next-object-candidates' to optimize the search of
3596 ;; the next object in the buffer.
3597 ;;
3598 ;; More precisely, that function looks for every allowed object type
3599 ;; first. Then, it discards failed searches, keeps further matches,
3600 ;; and searches again types matched behind point, for subsequent
3601 ;; calls. Thus, searching for a given type fails only once, and every
3602 ;; object is searched only once at top level (but sometimes more for
3603 ;; nested types).
3607 "Parse elements between BEG and END positions.
3609 SPECIAL prioritize some elements over the others. It can be set
3610 to `first-section', `quote-section', `section' `item' or
3611 `table-row'.
3613 When value is `item', STRUCTURE will be used as the current list
3614 structure.
3616 GRANULARITY determines the depth of the recursion. See
3617 `org-element-parse-buffer' for more information.
3619 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3620 elements.
3622 Elements are accumulated into ACC."
3625 ;; When parsing only headlines, skip any text before first one.
3628 ;; Main loop start.
3630 ;; Find current element's type and parse it accordingly to
3631 ;; its category.
3633 end granularity special structure))
3637 ;; Fill ELEMENT contents by side-effect.
3639 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3640 ;; no contents, don't modify it.
3643 ;; Greater element: parse it between `contents-begin' and
3644 ;; `contents-end'. Make sure GRANULARITY allows the
3645 ;; recursion, or ELEMENT is an headline, in which case going
3646 ;; inside is mandatory, in order to get sub-level headings.
3654 ;; Possibly switch to a special mode.
3662 granularity visible-only element))
3663 ;; ELEMENT has contents. Parse objects inside, if
3664 ;; GRANULARITY allows it.
3670 ;; Return result.
3671 acc))
3674 "Parse objects between BEG and END and return recursive structure.
3676 Objects are accumulated in ACC.
3678 RESTRICTION is a list of object types which are allowed in the
3679 current object."
3685 end restriction candidates)))
3692 ;; 1. Text before any object. Untabify it.
3697 acc
3701 ;; 2. Object...
3704 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3705 ;; a recursive type.
3710 cont-beg
3717 ;; 3. Text after last object. Untabify it.
3721 acc
3725 ;; Result.
3726 acc)))
3729 "Return an alist of candidates for the next object.
3731 LIMIT bounds the search, and RESTRICTION narrows candidates to
3732 some object types.
3734 Return value is an alist whose CAR is position and CDR the object
3735 type, as a symbol.
3737 OBJECTS is the previous candidates alist."
3739 ;; If no previous result, search every object type in RESTRICTION.
3740 ;; Otherwise, keep potential candidates (old objects located after
3741 ;; point) and ask to search again those which had matched before.
3746 objects))
3747 ;; Call the appropriate successor function for each type to search
3748 ;; and accumulate matches.
3755 type))))
3758 types-to-search)
3759 ;; Return alist.
3760 next-candidates))
3763 \f
3764 ;;; Towards A Bijective Process
3765 ;;
3766 ;; The parse tree obtained with `org-element-parse-buffer' is really
3767 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3768 ;; interpreted and expanded into a string with canonical Org syntax.
3769 ;; Hence `org-element-interpret-data'.
3770 ;;
3771 ;; The function relies internally on
3772 ;; `org-element--interpret-affiliated-keywords'.
3775 "Interpret DATA as Org syntax.
3777 DATA is a parse tree, an element, an object or a secondary string
3778 to interpret.
3780 Optional argument PARENT is used for recursive calls. It contains
3781 the element or object containing data, or nil.
3783 Return Org syntax as a string."
3787 ;; Secondary string.
3792 ;; Full Org document.
3797 ;; Plain text.
3799 ;; Element/Object without contents.
3802 data nil))
3803 ;; Element/Object with contents.
3813 ;; Elements directly containing objects must
3814 ;; have their indentation normalized first.
3816 data
3817 ;; When normalizing first paragraph of an
3818 ;; item or a footnote-definition, ignore
3819 ;; first line's indentation.
3826 data
3828 contents)))))))
3830 ;; Build white spaces. If no `:post-blank' property is
3831 ;; specified, assume its value is 0.
3841 "Return ELEMENT's affiliated keywords as Org syntax.
3842 If there is no affiliated keyword, return the empty string."
3852 ": "
3855 value)
3863 ;; All attribute keywords can have multiple lines.
3866 value
3869 ;; List all ELEMENT's properties matching an attribute line or an
3870 ;; affiliated keyword, but ignore translated keywords since they
3871 ;; cannot belong to the property list.
3878 org-element-keyword-translation-alist)))))
3879 collect prop)
3882 ;; Because interpretation of the parse tree must return the same
3883 ;; number of blank lines between elements and the same number of white
3884 ;; space after objects, some special care must be given to white
3885 ;; spaces.
3886 ;;
3887 ;; The first function, `org-element-normalize-string', ensures any
3888 ;; string different from the empty string will end with a single
3889 ;; newline character.
3890 ;;
3891 ;; The second function, `org-element-normalize-contents', removes
3892 ;; global indentation from the contents of the current element.
3895 "Ensure string S ends with a single newline character.
3897 If S isn't a string return it unchanged. If S is the empty
3898 string, return it. Otherwise, return a new string with a single
3899 newline character at its end."
3907 "Normalize plain text in ELEMENT's contents.
3909 ELEMENT must only contain plain text and objects.
3911 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3912 indentation to compute maximal common indentation.
3914 Return the normalized element that is element with global
3915 indentation removed from its contents. The function assumes that
3916 indentation is not done with TAB characters."
3918 collect-inds ; for byte-compiler
3921 ;; Return list of indentations within BLOB. This is done by
3922 ;; walking recursively BLOB and updating IND-LIST along the
3923 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3924 ;; been seen yet. It is required as this string is the only
3925 ;; one whose indentation doesn't happen after a newline
3926 ;; character.
3934 ;; An indentation of zero means no string will be
3935 ;; modified. Quit the process.
3941 ;; Avoid matching blank or empty lines.
3949 ;; Collect indentation list in ELEMENT. Possibly remove first
3950 ;; value if IGNORE-FIRST is non-nil.
3953 ;; Build ELEMENT back, replacing each string with the same
3954 ;; string minus common indentation.
3959 ;; Return BLOB with all its strings indentation
3960 ;; shortened from MCI white spaces. FIRST-FLAG is
3961 ;; non-nil when the first string hasn't been seen
3962 ;; yet.
3976 org-element-recursive-objects)
3980 blob))))
3984 \f
3985 ;;; The Toolbox
3986 ;;
3987 ;; The first move is to implement a way to obtain the smallest element
3988 ;; containing point. This is the job of `org-element-at-point'. It
3989 ;; basically jumps back to the beginning of section containing point
3990 ;; and moves, element after element, with
3991 ;; `org-element--current-element' until the container is found.
3992 ;;
3993 ;; At a deeper level, `org-element-context' lists all elements and
3994 ;; objects containing point.
3995 ;;
3996 ;; Note: When using `org-element-at-point', secondary values are never
3997 ;; parsed since the function focuses on elements, not on objects.
4000 "Determine closest element around point.
4002 Return value is a list like (TYPE PROPS) where TYPE is the type
4003 of the element and PROPS a plist of properties associated to the
4004 element. Possible types are defined in
4005 `org-element-all-elements'.
4007 As a special case, if point is at the very beginning of a list or
4008 sub-list, returned element will be that list instead of the first
4009 item. In the same way, if point is at the beginning of the first
4010 row of a table, returned element will be the table instead of the
4011 first row.
4013 If optional argument KEEP-TRAIL is non-nil, the function returns
4014 a list of of elements leading to element at point. The list's
4015 CAR is always the element at point. Following positions contain
4016 element's siblings, then parents, siblings of parents, until the
4017 first element of current section."
4019 ;; If at an headline, parse it. It is the sole element that
4020 ;; doesn't require to know about context. Be sure to disallow
4021 ;; secondary string parsing, though.
4027 ;; Otherwise move at the beginning of the section containing
4028 ;; point.
4031 element type special-flag trail struct prevs)
4038 ;; Parse successively each element, skipping those ending
4039 ;; before original position.
4047 ;; 1. Skip any element ending before point or at point.
4052 ;; 2. An element containing point is always the element at
4053 ;; point.
4056 ;; 3. At any other greater element type, if point is
4057 ;; within contents, move into it. Otherwise, return
4058 ;; that element.
4075 "Return list of all elements and objects around point.
4077 Return value is a list like (TYPE PROPS) where TYPE is the type
4078 of the element or object and PROPS a plist of properties
4079 associated to it. Possible types are defined in
4080 `org-element-all-elements' and `org-element-all-objects'.
4082 All elements and objects returned belong to the current section
4083 and are ordered from closest to farthest."
4086 ;; Remove elements not containing point from trail.
4094 ;; Check if point is inside an element containing objects or at
4095 ;; a secondary string. In that case, move to beginning of the
4096 ;; element or secondary string and set END to the other side.
4105 (<= origin
4106 ;; `1+' is required so some
4107 ;; successors can match
4108 ;; properly their object.
4122 elements
4126 end restriction candidates))
4128 candidates)))
4129 ;; If ORIGIN is before next object in element, there's
4130 ;; no point in looking further.
4139 ;; ORIGIN is after OBJECT, so skip it.
4142 ;; ORIGIN is within a non-recursive object or at an
4143 ;; object boundaries: Return that object.
4146 ;; Otherwise, move within current object and restrict
4147 ;; search to the end of its contents.
4151 elements))))))
4154 ;; Once the local structure around point is well understood, it's easy
4155 ;; to implement some replacements for `forward-paragraph'
4156 ;; `backward-paragraph', namely `org-element-forward' and
4157 ;; `org-element-backward'.
4158 ;;
4159 ;; Also, `org-transpose-elements' mimics the behaviour of
4160 ;; `transpose-words', at the element's level, whereas
4161 ;; `org-element-drag-forward', `org-element-drag-backward', and
4162 ;; `org-element-up' generalize, respectively, functions
4163 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
4164 ;;
4165 ;; `org-element-unindent-buffer' will, as its name almost suggests,
4166 ;; smartly remove global indentation from buffer, making it possible
4167 ;; to use Org indent mode on a file created with hard indentation.
4168 ;;
4169 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
4170 ;; internally by some of the previously cited tools.
4173 "Non-nil when elements ELEM-A and ELEM-B are nested."
4182 "Swap elements ELEM-A and ELEM-B.
4183 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4184 end of ELEM-A."
4186 ;; There are two special cases when an element doesn't start at bol:
4187 ;; the first paragraph in an item or in a footnote definition.
4189 ;; Only a paragraph without any affiliated keyword can be moved at
4190 ;; ELEM-A position in such a situation. Note that the case of
4191 ;; a footnote definition is impossible: it cannot contain two
4192 ;; paragraphs in a row because it cannot contain a blank line.
4198 ;; In a special situation, ELEM-A will have no indentation. We'll
4199 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4213 ;; Store overlays responsible for visibility status. We
4214 ;; also need to store their boundaries as they will be
4215 ;; removed from buffer.
4222 ;; Get contents.
4230 ;; Restore ex ELEM-A overlays.
4240 ;; Restore ex ELEM-B overlays.
4249 "Move forward by one element.
4250 Move to the next element at the same level, when possible."
4263 return prev)))
4271 "Move backward by one element.
4272 Move to the previous element at the same level, when possible."
4275 ;; At an headline, move to the previous one, if any, or stay
4276 ;; here.
4287 ;; Move to beginning of current element if point isn't there
4288 ;; already.
4294 "Move to upper element."
4304 return prev)))
4311 "Move to inner element."
4319 ;; If contents are hidden, first disclose them.
4325 "Move backward element at point."
4331 ;; Error out if no previous element or previous element is
4332 ;; a parent of the current one.
4341 "Move forward element at point."
4354 ;; Compute new position of point: it's shifted by NEXT-ELEM
4355 ;; body's length (without final blanks) and by the length of
4356 ;; blanks between ELEM and NEXT-ELEM.
4361 ;; Small correction if buffer doesn't end
4362 ;; with a newline character.
4375 "Put point at beginning of this element, mark at end.
4377 Interactively, if this command is repeated or (in Transient Mark
4378 mode) if the mark is active, it marks the next element after the
4379 ones already marked."
4394 "Narrow buffer to current element."
4412 "Transpose current and previous elements, keeping blank lines between.
4413 Point is moved after both elements."
4421 "Un-indent the visible part of the buffer.
4422 Relative indentation (between items, inside blocks, etc.) isn't
4423 modified."
4428 unindent-tree ; For byte-compiler.
4446 "Fill element at point, when applicable.
4448 This function only applies to paragraph, comment blocks, example
4449 blocks and fixed-width areas. Also, as a special case, re-align
4450 table when point is at one.
4452 If JUSTIFY is non-nil (interactively, with prefix argument),
4453 justify as well. If `sentence-end-double-space' is non-nil, then
4454 period followed by one space does not end a sentence, so don't
4455 break a line there. The variable `fill-column' controls the
4456 width for filling."
4459 ;; Align Org tables, leave table.el tables as-is.
4463 t)
4464 ;; Elements that may contain `line-break' type objects.
4468 ;; Do nothing if point is at an affiliated keyword or at
4469 ;; verse block markers.
4471 ;; At a verse block, first narrow to current "paragraph"
4472 ;; and set current element to that paragraph.
4485 ;; Fill paragraph, taking line breaks into consideration.
4486 ;; For that, slice the paragraph using line breaks as
4487 ;; separators, and fill the parts in reverse order to
4488 ;; avoid messing with markers.
4495 ;; Find the list of ending positions for line breaks
4496 ;; in the current paragraph. Add paragraph beginning
4497 ;; to include first slice.
4502 beg end nil org-element-all-objects)
4503 'line-break
4505 ;; Elements whose contents should be filled as plain text.
4519 ;; Ignore every other element.
4524 ;;; org-element.el ends here