| blob | 80da2b04705f7c8654e84bfa12e5511f239e5b12 |
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.
127 ;; Headlines and inlinetasks.
129 ;; Comments, blocks (any type), keywords and babel calls.
131 ;; Lists.
133 ;; Fixed-width, drawers (any type) and tables.
135 ;; Footnote definitions.
137 ;; Horizontal rules.
139 ;; LaTeX environments.
141 ;; Planning and Clock lines.
151 export-block fixed-width footnote-definition headline
152 horizontal-rule inlinetask item keyword latex-environment
153 babel-call paragraph plain-list planning property-drawer
154 quote-block quote-section section special-block src-block table
155 table-row verse-block)
160 item plain-list quote-block section special-block table)
165 latex-or-entity line-break link macro radio-target
166 statistics-cookie sub/superscript table-cell target
167 text-markup timestamp)
176 "Alist of translations between object type and successor name.
178 Sharing the same successor comes handy when, for example, the
183 inline-src-block italic line-break latex-fragment link macro
184 radio-target statistics-cookie strike-through subscript superscript
185 table-cell target timestamp underline verbatim)
190 table-cell underline)
205 "Alist between block names and the associated parsing function.
206 Names must be uppercase. Any block whose name has no association
212 "List of affiliated keywords as strings.
218 ;; Regular affiliated keywords.
221 "Regexp matching any affiliated keyword.
223 Keyword name is put in match group 1. Moreover, if keyword
224 belongs to `org-element-dual-keywords', put the dual value in
225 match group 2.
233 "Alist of usual translations for keywords.
234 The key is the old name and the value the new one. The property
238 "List of affiliated keywords that can occur more that once in an element.
240 Their value will be consed into a list of strings, which will be
241 returned as the value of the property.
243 This list is checked after translations have been applied. See
244 `org-element-keyword-translation-alist'.
250 "List of keywords whose value can be parsed.
252 Their value will be stored as a secondary string: a list of
253 strings and objects.
255 This list is checked after translations have been applied. See
259 "List of keywords which can have a secondary value.
261 In Org syntax, they can be written with optional square brackets
262 before the colons. For example, results keyword can be
263 associated to a hash value with the following:
265 #+RESULTS[hash-string]: some-source
267 This list is checked after translations have been applied. See
274 inline-src-block latex-or-entity line-break link macro
275 radio-target sub/superscript target text-markup
276 timestamp)
278 radio-target statistics-cookie sub/superscript target text-markup
279 timestamp)
291 inline-src-block latex-or-entity line-break link macro
292 radio-target statistics-cookie sub/superscript target text-markup
293 timestamp)
296 latex-or-entity link radio-target sub/superscript target
297 text-markup timestamp)
308 latex-or-entity line-break link macro radio-target
310 "Alist of objects restrictions.
312 CAR is an element or object type containing objects and CDR is
313 a list of successors that will be called within an element or
314 object of such type.
316 For example, in a `radio-target' object, one can only find
317 entities, export snippets, latex-fragments, subscript and
318 superscript.
320 This alist also applies to secondary string. For example, an
321 `headline' type element doesn't directly contain objects, but
332 \f
333 ;;; Accessors and Setters
334 ;;
335 ;; Provide four accessors: `org-element-type', `org-element-property'
336 ;; `org-element-contents' and `org-element-restriction'.
337 ;;
338 ;; Setter functions allow to modify elements by side effect. There is
339 ;; `org-element-put-property', `org-element-set-contents',
340 ;; `org-element-set-element' and `org-element-adopt-element'. Note
341 ;; that `org-element-set-element' and `org-element-adopt-element' are
342 ;; higher level functions since also update `:parent' property.
345 "Return type of ELEMENT.
347 The function returns the type of the element or object provided.
348 It can also return the following special value:
349 `plain-text' for a string
350 `org-data' for a complete document
351 nil in any other case."
357 "Extract the value from the PROPERTY of an ELEMENT."
361 "Extract contents from an ELEMENT."
365 "Return restriction associated to ELEMENT.
366 ELEMENT can be an element, an object or a symbol representing an
367 element or object type."
369 org-element-object-restrictions)))
372 "In ELEMENT set PROPERTY to VALUE.
373 Return modified element."
376 element)
379 "Set ELEMENT contents to CONTENTS.
380 Return modified element."
386 "Replace element or object OLD with element or object NEW.
387 The function takes care of setting `:parent' property for NEW."
388 ;; OLD can belong to the contents of PARENT or to its secondary
389 ;; string.
392 org-element-secondary-value-alist)))
395 ;; Make sure NEW has correct `:parent' property.
397 ;; Replace OLD with NEW in PARENT.
401 "Add an element to the contents of another element.
403 PARENT is an element or object. CHILD is an element, an object,
404 or a string.
406 CHILD is added at the beginning of PARENT contents, unless the
407 optional argument APPEND is non-nil, in which case CHILD is added
408 at the end.
410 The function takes care of setting `:parent' property for CHILD.
411 Return parent element."
415 parent
417 ;; Link the CHILD element with PARENT.
419 ;; Return the parent element.
420 parent))
423 \f
424 ;;; Greater elements
425 ;;
426 ;; For each greater element type, we define a parser and an
427 ;; interpreter.
428 ;;
429 ;; A parser returns the element or object as the list described above.
430 ;; Most of them accepts no argument. Though, exceptions exist. Hence
431 ;; every element containing a secondary string (see
432 ;; `org-element-secondary-value-alist') will accept an optional
433 ;; argument to toggle parsing of that secondary string. Moreover,
434 ;; `item' parser requires current list's structure as its first
435 ;; element.
436 ;;
437 ;; An interpreter accepts two arguments: the list representation of
438 ;; the element or object, and its contents. The latter may be nil,
439 ;; depending on the element or object considered. It returns the
440 ;; appropriate Org syntax, as a string.
441 ;;
442 ;; Parsing functions must follow the naming convention:
443 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
444 ;; defined in `org-element-greater-elements'.
445 ;;
446 ;; Similarly, interpreting functions must follow the naming
447 ;; convention: org-element-TYPE-interpreter.
448 ;;
449 ;; With the exception of `headline' and `item' types, greater elements
450 ;; cannot contain other greater elements of their own type.
451 ;;
452 ;; Beside implementing a parser and an interpreter, adding a new
453 ;; greater element requires to tweak `org-element-current-element'.
454 ;; Moreover, the newly defined type must be added to both
455 ;; `org-element-all-elements' and `org-element-greater-elements'.
458 ;;;; Center Block
461 "Parse a center block.
463 LIMIT bounds the search.
465 Return a list whose CAR is `center-block' and CDR is a plist
466 containing `:begin', `:end', `:hiddenp', `:contents-begin',
467 `:contents-end' and `:post-blank' keywords.
469 Assume point is at the beginning of the block."
473 ;; Incomplete-block: parse it as a comment.
489 :end end
490 :hiddenp hidden
491 :contents-begin contents-begin
492 :contents-end contents-end
497 "Interpret CENTER-BLOCK element as Org syntax.
498 CONTENTS is the contents of the element."
502 ;;;; Drawer
505 "Parse a drawer.
507 LIMIT bounds the search.
509 Return a list whose CAR is `drawer' and CDR is a plist containing
510 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
511 `:contents-end' and `:post-blank' keywords.
513 Assume point is at beginning of drawer."
530 :end end
531 :drawer-name name
532 :hiddenp hidden
533 :contents-begin contents-begin
534 :contents-end contents-end
539 "Interpret DRAWER element as Org syntax.
540 CONTENTS is the contents of the element."
543 contents))
546 ;;;; Dynamic Block
549 "Parse a dynamic block.
551 LIMIT bounds the search.
553 Return a list whose CAR is `dynamic-block' and CDR is a plist
554 containing `:block-name', `:begin', `:end', `:hiddenp',
555 `:contents-begin', `:contents-end', `:arguments' and
556 `:post-blank' keywords.
558 Assume point is at beginning of dynamic block."
561 ;; Incomplete block: parse it as a comment.
580 :end end
581 :block-name name
582 :arguments arguments
583 :hiddenp hidden
584 :contents-begin contents-begin
585 :contents-end contents-end
590 "Interpret DYNAMIC-BLOCK element as Org syntax.
591 CONTENTS is the contents of the element."
596 contents))
599 ;;;; Footnote Definition
602 "Parse a footnote definition.
604 LIMIT bounds the search.
606 Return a list whose CAR is `footnote-definition' and CDR is
607 a plist containing `:label', `:begin' `:end', `:contents-begin',
608 `:contents-end' and `:post-blank' keywords.
610 Assume point is at the beginning of the footnote definition."
632 :begin begin
633 :end end
634 :contents-begin contents-begin
635 :contents-end contents-end
640 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
641 CONTENTS is the contents of the footnote-definition."
643 " "
644 contents))
647 ;;;; Headline
650 "Parse an headline.
652 Return a list whose CAR is `headline' and CDR is a plist
653 containing `:raw-value', `:title', `:begin', `:end',
654 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
655 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
656 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
657 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
658 keywords.
660 The plist also contains any property set in the property drawer,
661 with its name in lowercase, the underscores replaced with hyphens
662 and colons at the beginning (i.e. `:custom-id').
664 When RAW-SECONDARY-P is non-nil, headline's title will not be
665 parsed as a secondary string, but as a plain string instead.
667 Assume point is at beginning of the headline."
697 plist))
713 ;; Clean RAW-VALUE from any quote or comment string.
718 ""
719 raw-value)))
720 ;; Clean TAGS from archive tag, if any.
726 :begin begin
727 :end end
729 :hiddenp hidden
730 :contents-begin contents-begin
731 :contents-end contents-end
732 :level level
734 :tags tags
735 :todo-keyword todo
736 :todo-type todo-type
737 :scheduled scheduled
738 :deadline deadline
739 :timestamp timestamp
740 :clock clock
742 :footnote-section-p footnote-section-p
743 :archivedp archivedp
744 :commentedp commentedp
746 standard-props))))
748 headline :title
754 "Interpret HEADLINE element as Org syntax.
755 CONTENTS is the contents of the element."
782 ;; Align tags.
790 ? )
791 tags))
795 tags))))
797 contents)))
800 ;;;; Inlinetask
803 "Parse an inline task.
805 Return a list whose CAR is `inlinetask' and CDR is a plist
806 containing `:title', `:begin', `:end', `:hiddenp',
807 `:contents-begin' and `:contents-end', `:level', `:priority',
808 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
809 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
811 The plist also contains any property set in the property drawer,
812 with its name in lowercase, the underscores replaced with hyphens
813 and colons at the beginning (i.e. `:custom-id').
815 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
816 title will not be parsed as a secondary string, but as a plain
817 string instead.
819 Assume point is at beginning of the inline task."
840 plist))
849 ;; In the case of a single line task, CONTENTS-BEGIN and
850 ;; CONTENTS-END might overlap.
860 :end end
862 :contents-begin contents-begin
863 :contents-end contents-end
866 :tags tags
867 :todo-keyword todo
868 :todo-type todo-type
869 :scheduled scheduled
870 :deadline deadline
871 :timestamp timestamp
872 :clock clock
874 standard-props)
877 inlinetask :title
882 inlinetask))))))
885 "Interpret INLINETASK element as Org syntax.
886 CONTENTS is the contents of inlinetask."
901 ;; Align tags.
909 ? )
910 tags))
914 tags))))
915 ;; Prefer degenerate inlinetasks when there are no
916 ;; contents.
919 contents
923 ;;;; Item
926 "Parse an item.
928 STRUCT is the structure of the plain list.
930 Return a list whose CAR is `item' and CDR is a plist containing
931 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
932 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
933 `:post-blank' keywords.
935 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
936 any, will not be parsed as a secondary string, but as a plain
937 string instead.
939 Assume point is at the beginning of the item."
960 ;; If first line isn't empty,
961 ;; contents really start at the text
962 ;; after item's meta-data.
975 :begin begin
976 :end end
977 ;; CONTENTS-BEGIN and CONTENTS-END may be
978 ;; mixed up in the case of an empty item
979 ;; separated from the next by a blank line.
980 ;; Thus ensure the former is always the
981 ;; smallest.
984 :checkbox checkbox
985 :counter counter
986 :hiddenp hidden
987 :structure struct
990 item :tag
998 "Interpret ITEM element as Org syntax.
999 CONTENTS is the contents of the element."
1013 num
1020 ;; Compute indentation.
1025 ;; Indent contents.
1027 bullet
1040 ;;;; Plain List
1043 "Parse a plain list.
1045 Optional argument STRUCTURE, when non-nil, is the structure of
1046 the plain list being parsed.
1048 Return a list whose CAR is `plain-list' and CDR is a plist
1049 containing `:type', `:begin', `:end', `:contents-begin' and
1050 `:contents-end', `:structure' and `:post-blank' keywords.
1052 Assume point is at the beginning of the list."
1065 ;; Blank lines below list belong to the top-level list only.
1070 ;; Return value.
1074 :begin begin
1075 :end end
1076 :contents-begin contents-begin
1077 :contents-end contents-end
1078 :structure struct
1083 "Interpret PLAIN-LIST element as Org syntax.
1084 CONTENTS is the contents of the element."
1085 contents)
1088 ;;;; Quote Block
1091 "Parse a quote block.
1093 LIMIT bounds the search.
1095 Return a list whose CAR is `quote-block' and CDR is a plist
1096 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1097 `:contents-end' and `:post-blank' keywords.
1099 Assume point is at the beginning of the block."
1103 ;; Incomplete block: parse it as a comment.
1119 :end end
1120 :hiddenp hidden
1121 :contents-begin contents-begin
1122 :contents-end contents-end
1127 "Interpret QUOTE-BLOCK element as Org syntax.
1128 CONTENTS is the contents of the element."
1132 ;;;; Section
1135 "Parse a section.
1137 LIMIT bounds the search.
1139 Return a list whose CAR is `section' and CDR is a plist
1140 containing `:begin', `:end', `:contents-begin', `contents-end'
1141 and `:post-blank' keywords."
1143 ;; Beginning of section is the beginning of the first non-blank
1144 ;; line after previous headline.
1153 :end end
1154 :contents-begin begin
1155 :contents-end pos-before-blank
1159 "Interpret SECTION element as Org syntax.
1160 CONTENTS is the contents of the element."
1161 contents)
1164 ;;;; Special Block
1167 "Parse a special block.
1169 LIMIT bounds the search.
1171 Return a list whose CAR is `special-block' and CDR is a plist
1172 containing `:type', `:begin', `:end', `:hiddenp',
1173 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1175 Assume point is at the beginning of the block."
1181 ;; Incomplete block: parse it as a comment.
1197 :begin begin
1198 :end end
1199 :hiddenp hidden
1200 :contents-begin contents-begin
1201 :contents-end contents-end
1206 "Interpret SPECIAL-BLOCK element as Org syntax.
1207 CONTENTS is the contents of the element."
1212 \f
1213 ;;; Elements
1214 ;;
1215 ;; For each element, a parser and an interpreter are also defined.
1216 ;; Both follow the same naming convention used for greater elements.
1217 ;;
1218 ;; Also, as for greater elements, adding a new element type is done
1219 ;; through the following steps: implement a parser and an interpreter,
1220 ;; tweak `org-element-current-element' so that it recognizes the new
1221 ;; type and add that new type to `org-element-all-elements'.
1222 ;;
1223 ;; As a special case, when the newly defined type is a block type,
1224 ;; `org-element-block-name-alist' has to be modified accordingly.
1227 ;;;; Babel Call
1230 "Parse a babel call.
1232 LIMIT bounds the search.
1234 Return a list whose CAR is `babel-call' and CDR is a plist
1235 containing `:begin', `:end', `:info' and `:post-blank' as
1236 keywords."
1247 :end end
1248 :info info
1252 "Interpret BABEL-CALL element as Org syntax.
1253 CONTENTS is nil."
1259 ;; Remove redundant square brackets.
1264 ;;;; Clock
1267 "Parse a clock.
1269 LIMIT bounds the search.
1271 Return a list whose CAR is `clock' and CDR is a plist containing
1272 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1273 as keywords."
1292 :value value
1293 :time time
1294 :begin begin
1295 :end end
1299 "Interpret CLOCK element as Org syntax.
1300 CONTENTS is nil."
1307 "%2s:%02s"
1311 ;;;; Comment
1314 "Parse a comment.
1316 LIMIT bounds the search.
1318 Return a list whose CAR is `comment' and CDR is a plist
1319 containing `:begin', `:end', `:value' and `:post-blank'
1320 keywords.
1322 Assume point is at comment beginning."
1326 ;; Match first line with a loose regexp since it might as
1327 ;; well be an ill-defined keyword.
1333 ;; Get comments ending.
1337 ;; Accumulate lines without leading hash and plus sign
1338 ;; if any. First whitespace is also ignored.
1351 :end end
1352 :value value
1357 "Interpret COMMENT element as Org syntax.
1358 CONTENTS is nil."
1362 ;;;; Comment Block
1365 "Parse an export block.
1367 LIMIT bounds the search.
1369 Return a list whose CAR is `comment-block' and CDR is a plist
1370 containing `:begin', `:end', `:hiddenp', `:value' and
1371 `:post-blank' keywords.
1373 Assume point is at comment block beginning."
1377 ;; Incomplete block: parse it as a comment.
1391 contents-begin contents-end)))
1395 :end end
1396 :value value
1397 :hiddenp hidden
1402 "Interpret COMMENT-BLOCK element as Org syntax.
1403 CONTENTS is nil."
1408 ;;;; Example Block
1411 "Parse an example block.
1413 LIMIT bounds the search.
1415 Return a list whose CAR is `example-block' and CDR is a plist
1416 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1417 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1418 `:switches', `:value' and `:post-blank' keywords."
1422 ;; Incomplete block: parse it as a comment.
1429 ;; Switches analysis
1434 ;; Should labels be retained in (or stripped from) example
1435 ;; blocks?
1440 ;; What should code-references use - labels or
1441 ;; line-numbers?
1448 ;; Standard block parsing.
1462 :end end
1463 :value value
1464 :switches switches
1465 :number-lines number-lines
1466 :preserve-indent preserve-indent
1467 :retain-labels retain-labels
1468 :use-labels use-labels
1469 :label-fmt label-fmt
1470 :hiddenp hidden
1475 "Interpret EXAMPLE-BLOCK element as Org syntax.
1476 CONTENTS is nil."
1484 ;;;; Export Block
1487 "Parse an export block.
1489 LIMIT bounds the search.
1491 Return a list whose CAR is `export-block' and CDR is a plist
1492 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1493 `:post-blank' keywords.
1495 Assume point is at export-block beginning."
1501 ;; Incomplete block: parse it as a comment.
1515 contents-end)))
1519 :end end
1520 :type type
1521 :value value
1522 :hiddenp hidden
1527 "Interpret EXPORT-BLOCK element as Org syntax.
1528 CONTENTS is nil."
1535 ;;;; Fixed-width
1538 "Parse a fixed-width section.
1540 LIMIT bounds the search.
1542 Return a list whose CAR is `fixed-width' and CDR is a plist
1543 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1545 Assume point is at the beginning of the fixed-width area."
1549 value
1554 ;; Accumulate text without starting colons.
1567 :end end
1568 :value value
1573 "Interpret FIXED-WIDTH element as Org syntax.
1574 CONTENTS is nil."
1579 ;;;; Horizontal Rule
1582 "Parse an horizontal rule.
1584 LIMIT bounds the search.
1586 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1587 containing `:begin', `:end' and `:post-blank' keywords."
1597 :end end
1602 "Interpret HORIZONTAL-RULE element as Org syntax.
1603 CONTENTS is nil."
1607 ;;;; Keyword
1610 "Parse a keyword at point.
1612 LIMIT bounds the search.
1614 Return a list whose CAR is `keyword' and CDR is a plist
1615 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1616 keywords."
1629 :value value
1630 :begin begin
1631 :end end
1635 "Interpret KEYWORD element as Org syntax.
1636 CONTENTS is nil."
1642 ;;;; Latex Environment
1645 "Parse a LaTeX environment.
1647 LIMIT bounds the search.
1649 Return a list whose CAR is `latex-environment' and CDR is a plist
1650 containing `:begin', `:end', `:value' and `:post-blank'
1651 keywords.
1653 Assume point is at the beginning of the latex environment."
1671 :end end
1672 :value value
1677 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1678 CONTENTS is nil."
1682 ;;;; Paragraph
1685 "Parse a paragraph.
1687 LIMIT bounds the search.
1689 Return a list whose CAR is `paragraph' and CDR is a plist
1690 containing `:begin', `:end', `:contents-begin' and
1691 `:contents-end' and `:post-blank' keywords.
1693 Assume point is at the beginning of the paragraph."
1701 limit
1709 ;; If paragraph has no affiliated keywords, it may not begin
1710 ;; at beginning of line if it starts an item.
1713 :end end
1714 :contents-begin contents-begin
1715 :contents-end contents-end
1720 "Interpret PARAGRAPH element as Org syntax.
1721 CONTENTS is the contents of the element."
1722 contents)
1725 ;;;; Planning
1728 "Parse a planning.
1730 LIMIT bounds the search.
1732 Return a list whose CAR is `planning' and CDR is a plist
1733 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1734 and `:post-blank' keywords."
1743 closed deadline scheduled)
1757 :deadline deadline
1758 :scheduled scheduled
1759 :begin begin
1760 :end end
1764 "Interpret PLANNING element as Org syntax.
1765 CONTENTS is nil."
1767 'identity
1779 ;;;; Property Drawer
1782 "Parse a property drawer.
1784 LIMIT bounds the search.
1786 Return a list whose CAR is `property-drawer' and CDR is a plist
1787 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1788 `:contents-end', `:properties' and `:post-blank' keywords.
1790 Assume point is at the beginning of the property drawer."
1804 val))
1806 val))
1814 :end end
1815 :hiddenp hidden
1816 :properties properties
1820 "Interpret PROPERTY-DRAWER element as Org syntax.
1821 CONTENTS is nil."
1831 ;;;; Quote Section
1834 "Parse a quote section.
1836 LIMIT bounds the search.
1838 Return a list whose CAR is `quote-section' and CDR is a plist
1839 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1841 Assume point is at beginning of the section."
1852 :end end
1853 :value value
1857 "Interpret QUOTE-SECTION element as Org syntax.
1858 CONTENTS is nil."
1862 ;;;; Src Block
1865 "Parse a src block.
1867 LIMIT bounds the search.
1869 Return a list whose CAR is `src-block' and CDR is a plist
1870 containing `:language', `:switches', `:parameters', `:begin',
1871 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1872 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1873 `:post-blank' keywords.
1875 Assume point is at the beginning of the block."
1878 ;; Incomplete block: parse it as a comment.
1883 ;; Get beginning position.
1885 ;; Get language as a string.
1894 ;; Get switches.
1896 ;; Get parameters.
1898 ;; Switches analysis
1906 ;; Should labels be retained in (or stripped from)
1907 ;; src blocks?
1912 ;; What should code-references use - labels or
1913 ;; line-numbers?
1917 ;; Get visibility status.
1919 ;; Retrieve code.
1924 ;; Get position after ending blank lines.
1934 :begin begin
1935 :end end
1936 :number-lines number-lines
1937 :preserve-indent preserve-indent
1938 :retain-labels retain-labels
1939 :use-labels use-labels
1940 :label-fmt label-fmt
1941 :hiddenp hidden
1942 :value value
1947 "Interpret SRC-BLOCK element as Org syntax.
1948 CONTENTS is nil."
1968 value
1972 ;;;; Table
1975 "Parse a table at point.
1977 LIMIT bounds the search.
1979 Return a list whose CAR is `table' and CDR is a plist containing
1980 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
1981 `:contents-end', `:value' and `:post-blank' keywords.
1983 Assume point is at the beginning of the table."
1995 acc))
2002 :end end
2003 :type type
2004 :tblfm tblfm
2005 ;; Only `org' tables have contents. `table.el' tables
2006 ;; use a `:value' property to store raw table as
2007 ;; a string.
2012 table-begin table-end))
2017 "Interpret TABLE element as Org syntax.
2018 CONTENTS is nil."
2029 ;;;; Table Row
2032 "Parse table row at point.
2034 LIMIT bounds the search.
2036 Return a list whose CAR is `table-row' and CDR is a plist
2037 containing `:begin', `:end', `:contents-begin', `:contents-end',
2038 `:type' and `:post-blank' keywords."
2042 ;; A table rule has no contents. In that case, ensure
2043 ;; CONTENTS-BEGIN matches CONTENTS-END.
2055 :begin begin
2056 :end end
2057 :contents-begin contents-begin
2058 :contents-end contents-end
2062 "Interpret TABLE-ROW element as Org syntax.
2063 CONTENTS is the contents of the table row."
2068 ;;;; Verse Block
2071 "Parse a verse block.
2073 LIMIT bounds the search.
2075 Return a list whose CAR is `verse-block' and CDR is a plist
2076 containing `:begin', `:end', `:contents-begin', `:contents-end',
2077 `:hiddenp' and `:post-blank' keywords.
2079 Assume point is at beginning of the block."
2083 ;; Incomplete block: parse it as a comment.
2099 :end end
2100 :contents-begin contents-begin
2101 :contents-end contents-end
2102 :hiddenp hidden
2107 "Interpret VERSE-BLOCK element as Org syntax.
2108 CONTENTS is verse block contents."
2112 \f
2113 ;;; Objects
2114 ;;
2115 ;; Unlike to elements, interstices can be found between objects.
2116 ;; That's why, along with the parser, successor functions are provided
2117 ;; for each object. Some objects share the same successor (i.e. `code'
2118 ;; and `verbatim' objects).
2119 ;;
2120 ;; A successor must accept a single argument bounding the search. It
2121 ;; will return either a cons cell whose CAR is the object's type, as
2122 ;; a symbol, and CDR the position of its next occurrence, or nil.
2123 ;;
2124 ;; Successors follow the naming convention:
2125 ;; org-element-NAME-successor, where NAME is the name of the
2126 ;; successor, as defined in `org-element-all-successors'.
2127 ;;
2128 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
2129 ;; object types they can contain will be specified in
2130 ;; `org-element-object-restrictions'.
2131 ;;
2132 ;; Adding a new type of object is simple. Implement a successor,
2133 ;; a parser, and an interpreter for it, all following the naming
2134 ;; convention. Register type in `org-element-all-objects' and
2135 ;; successor in `org-element-all-successors'. Maybe tweak
2136 ;; restrictions about it, and that's it.
2139 ;;;; Bold
2142 "Parse bold object at point.
2144 Return a list whose CAR is `bold' and CDR is a plist with
2145 `:begin', `:end', `:contents-begin' and `:contents-end' and
2146 `:post-blank' keywords.
2148 Assume point is at the first star marker."
2160 :end end
2161 :contents-begin contents-begin
2162 :contents-end contents-end
2166 "Interpret BOLD object as Org syntax.
2167 CONTENTS is the contents of the object."
2171 "Search for the next text-markup object.
2173 LIMIT bounds the search.
2175 LIMIT bounds the search.
2177 Return value is a cons cell whose CAR is a symbol among `bold',
2178 `italic', `underline', `strike-through', `code' and `verbatim'
2179 and CDR is beginning position."
2195 ;;;; Code
2198 "Parse code object at point.
2200 Return a list whose CAR is `code' and CDR is a plist with
2201 `:value', `:begin', `:end' and `:post-blank' keywords.
2203 Assume point is at the first tilde marker."
2214 :begin begin
2215 :end end
2219 "Interpret CODE object as Org syntax.
2220 CONTENTS is nil."
2224 ;;;; Entity
2227 "Parse entity at point.
2229 Return a list whose CAR is `entity' and CDR a plist with
2230 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2231 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2232 keywords.
2234 Assume point is at the beginning of the entity."
2236 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2252 :begin begin
2253 :end end
2254 :use-brackets-p bracketsp
2258 "Interpret ENTITY object as Org syntax.
2259 CONTENTS is nil."
2265 "Search for the next latex-fragment or entity object.
2267 LIMIT bounds the search.
2269 Return value is a cons cell whose CAR is `entity' or
2270 `latex-fragment' and CDR is beginning position."
2273 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2280 limit t)
2283 ;; Determine if it's a real entity or a LaTeX command.
2286 ;; No entity nor command: point is at a LaTeX fragment.
2287 ;; Determine its type to get the correct beginning position.
2295 matchers)
2299 ;;;; Export Snippet
2302 "Parse export snippet at point.
2304 Return a list whose CAR is `export-snippet' and CDR a plist with
2305 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2306 keywords.
2308 Assume point is at the beginning of the snippet."
2320 :value value
2321 :begin begin
2322 :end end
2326 "Interpret EXPORT-SNIPPET object as Org syntax.
2327 CONTENTS is nil."
2333 "Search for the next export-snippet object.
2335 LIMIT bounds the search.
2337 Return value is a cons cell whose CAR is `export-snippet' and CDR
2338 its beginning position."
2347 ;;;; Footnote Reference
2350 "Parse footnote reference at point.
2352 Return a list whose CAR is `footnote-reference' and CDR a plist
2353 with `:label', `:type', `:inline-definition', `:begin', `:end'
2354 and `:post-blank' as keywords."
2376 :type type
2377 :begin begin
2378 :end end
2381 footnote-reference :inline-definition
2386 footnote-reference))))))
2389 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2390 CONTENTS is nil."
2400 "Search for the next footnote-reference object.
2402 LIMIT bounds the search.
2404 Return value is a cons cell whose CAR is `footnote-reference' and
2405 CDR is beginning position."
2419 ;;;; Inline Babel Call
2422 "Parse inline babel call at point.
2424 Return a list whose CAR is `inline-babel-call' and CDR a plist
2425 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2427 Assume point is at the beginning of the babel call."
2438 :end end
2439 :info info
2443 "Interpret INLINE-BABEL-CALL object as Org syntax.
2444 CONTENTS is nil."
2450 ;; Remove redundant square brackets.
2453 main-source)
2457 "Search for the next inline-babel-call object.
2459 LIMIT bounds the search.
2461 Return value is a cons cell whose CAR is `inline-babel-call' and
2462 CDR is beginning position."
2464 ;; Use a simplified version of
2465 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2467 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2468 limit t)
2472 ;;;; Inline Src Block
2475 "Parse inline source block at point.
2477 LIMIT bounds the search.
2479 Return a list whose CAR is `inline-src-block' and CDR a plist
2480 with `:begin', `:end', `:language', `:value', `:parameters' and
2481 `:post-blank' as keywords.
2483 Assume point is at the beginning of the inline src block."
2496 :value value
2497 :parameters parameters
2498 :begin begin
2499 :end end
2503 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2504 CONTENTS is nil."
2509 language
2511 body)))
2514 "Search for the next inline-babel-call element.
2516 LIMIT bounds the search.
2518 Return value is a cons cell whose CAR is `inline-babel-call' and
2519 CDR is beginning position."
2524 ;;;; Italic
2527 "Parse italic object at point.
2529 Return a list whose CAR is `italic' and CDR is a plist with
2530 `:begin', `:end', `:contents-begin' and `:contents-end' and
2531 `:post-blank' keywords.
2533 Assume point is at the first slash marker."
2545 :end end
2546 :contents-begin contents-begin
2547 :contents-end contents-end
2551 "Interpret ITALIC object as Org syntax.
2552 CONTENTS is the contents of the object."
2556 ;;;; Latex Fragment
2559 "Parse latex fragment at point.
2561 Return a list whose CAR is `latex-fragment' and CDR a plist with
2562 `:value', `:begin', `:end', and `:post-blank' as keywords.
2564 Assume point is at the beginning of the latex fragment."
2578 ;; None found: it's a macro.
2587 :begin begin
2588 :end end
2592 "Interpret LATEX-FRAGMENT object as Org syntax.
2593 CONTENTS is nil."
2596 ;;;; Line Break
2599 "Parse line break at point.
2601 Return a list whose CAR is `line-break', and CDR a plist with
2602 `:begin', `:end' and `:post-blank' keywords.
2604 Assume point is at the beginning of the line break."
2608 "Interpret LINE-BREAK object as Org syntax.
2609 CONTENTS is nil."
2613 "Search for the next line-break object.
2615 LIMIT bounds the search.
2617 Return value is a cons cell whose CAR is `line-break' and CDR is
2618 beginning position."
2622 ;; A line break can only happen on a non-empty line.
2627 ;;;; Link
2630 "Parse link at point.
2632 Return a list whose CAR is `link' and CDR a plist with `:type',
2633 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2634 `:contents-end' and `:post-blank' as keywords.
2636 Assume point is at the beginning of the link."
2639 end contents-begin contents-end link-end post-blank path type
2640 raw-link link)
2642 ;; Type 1: Text targeted from a radio target.
2647 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2652 ;; RAW-LINK is the original link.
2657 ;; Determine TYPE of link and set PATH accordingly.
2659 ;; File type.
2662 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2665 ;; Id type: PATH is the id.
2668 ;; Code-ref type: PATH is the name of the reference.
2671 ;; Custom-id type: PATH is the name of the custom id.
2674 ;; Fuzzy type: Internal link either matches a target, an
2675 ;; headline name or nothing. PATH is the target or
2676 ;; headline's name.
2678 ;; Type 3: Plain link, i.e. http://orgmode.org
2684 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2691 ;; In any case, deduce end point after trailing white space from
2692 ;; LINK-END variable.
2697 :path path
2699 :begin begin
2700 :end end
2701 :contents-begin contents-begin
2702 :contents-end contents-end
2706 "Interpret LINK object as Org syntax.
2707 CONTENTS is the contents of the object, or nil."
2712 raw-link
2716 "Search for the next link object.
2718 LIMIT bounds the search.
2720 Return value is a cons cell whose CAR is `link' and CDR is
2721 beginning position."
2730 ;;;; Macro
2733 "Parse macro at point.
2735 Return a list whose CAR is `macro' and CDR a plist with `:key',
2736 `:args', `:begin', `:end', `:value' and `:post-blank' as
2737 keywords.
2739 Assume point is at the macro."
2753 ;; Repair bad splits.
2761 :value value
2762 :args args
2763 :begin begin
2764 :end end
2768 "Interpret MACRO object as Org syntax.
2769 CONTENTS is nil."
2773 "Search for the next macro object.
2775 LIMIT bounds the search.
2777 Return value is cons cell whose CAR is `macro' and CDR is
2778 beginning position."
2782 limit t)
2786 ;;;; Radio-target
2789 "Parse radio target at point.
2791 Return a list whose CAR is `radio-target' and CDR a plist with
2792 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2793 and `:post-blank' as keywords.
2795 Assume point is at the radio target."
2807 :end end
2808 :contents-begin contents-begin
2809 :contents-end contents-end
2810 :post-blank post-blank
2814 "Interpret TARGET object as Org syntax.
2815 CONTENTS is the contents of the object."
2819 "Search for the next radio-target object.
2821 LIMIT bounds the search.
2823 Return value is a cons cell whose CAR is `radio-target' and CDR
2824 is beginning position."
2830 ;;;; Statistics Cookie
2833 "Parse statistics cookie at point.
2835 Return a list whose CAR is `statistics-cookie', and CDR a plist
2836 with `:begin', `:end', `:value' and `:post-blank' keywords.
2838 Assume point is at the beginning of the statistics-cookie."
2849 :end end
2850 :value value
2854 "Interpret STATISTICS-COOKIE object as Org syntax.
2855 CONTENTS is nil."
2859 "Search for the next statistics cookie object.
2861 LIMIT bounds the search.
2863 Return value is a cons cell whose CAR is `statistics-cookie' and
2864 CDR is beginning position."
2870 ;;;; Strike-Through
2873 "Parse strike-through object at point.
2875 Return a list whose CAR is `strike-through' and CDR is a plist
2876 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2877 `:post-blank' keywords.
2879 Assume point is at the first plus sign marker."
2891 :end end
2892 :contents-begin contents-begin
2893 :contents-end contents-end
2897 "Interpret STRIKE-THROUGH object as Org syntax.
2898 CONTENTS is the contents of the object."
2902 ;;;; Subscript
2905 "Parse subscript at point.
2907 Return a list whose CAR is `subscript' and CDR a plist with
2908 `:begin', `:end', `:contents-begin', `:contents-end',
2909 `:use-brackets-p' and `:post-blank' as keywords.
2911 Assume point is at the underscore."
2915 t
2926 :end end
2927 :use-brackets-p bracketsp
2928 :contents-begin contents-begin
2929 :contents-end contents-end
2933 "Interpret SUBSCRIPT object as Org syntax.
2934 CONTENTS is the contents of the object."
2937 contents))
2940 "Search for the next sub/superscript object.
2942 LIMIT bounds the search.
2944 Return value is a cons cell whose CAR is either `subscript' or
2945 `superscript' and CDR is beginning position."
2952 ;;;; Superscript
2955 "Parse superscript at point.
2957 Return a list whose CAR is `superscript' and CDR a plist with
2958 `:begin', `:end', `:contents-begin', `:contents-end',
2959 `:use-brackets-p' and `:post-blank' as keywords.
2961 Assume point is at the caret."
2975 :end end
2976 :use-brackets-p bracketsp
2977 :contents-begin contents-begin
2978 :contents-end contents-end
2982 "Interpret SUPERSCRIPT object as Org syntax.
2983 CONTENTS is the contents of the object."
2986 contents))
2989 ;;;; Table Cell
2992 "Parse table cell at point.
2994 Return a list whose CAR is `table-cell' and CDR is a plist
2995 containing `:begin', `:end', `:contents-begin', `:contents-end'
2996 and `:post-blank' keywords."
3004 :end end
3005 :contents-begin contents-begin
3006 :contents-end contents-end
3010 "Interpret TABLE-CELL element as Org syntax.
3011 CONTENTS is the contents of the cell, or nil."
3015 "Search for the next table-cell object.
3017 LIMIT bounds the search.
3019 Return value is a cons cell whose CAR is `table-cell' and CDR is
3020 beginning position."
3024 ;;;; Target
3027 "Parse target at point.
3029 Return a list whose CAR is `target' and CDR a plist with
3030 `:begin', `:end', `:value' and `:post-blank' as keywords.
3032 Assume point is at the target."
3042 :end end
3043 :value value
3047 "Interpret TARGET object as Org syntax.
3048 CONTENTS is nil."
3052 "Search for the next target object.
3054 LIMIT bounds the search.
3056 Return value is a cons cell whose CAR is `target' and CDR is
3057 beginning position."
3063 ;;;; Timestamp
3066 "Parse time stamp at point.
3068 Return a list whose CAR is `timestamp', and CDR a plist with
3069 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3071 Assume point is at the beginning of the timestamp."
3090 :value main-value
3091 :range-end range-end
3092 :begin begin
3093 :end end
3097 "Interpret TIMESTAMP object as Org syntax.
3098 CONTENTS is nil."
3107 range-end)))))))
3110 "Search for the next timestamp object.
3112 LIMIT bounds the search.
3114 Return value is a cons cell whose CAR is `timestamp' and CDR is
3115 beginning position."
3123 limit t)
3127 ;;;; Underline
3130 "Parse underline object at point.
3132 Return a list whose CAR is `underline' and CDR is a plist with
3133 `:begin', `:end', `:contents-begin' and `:contents-end' and
3134 `:post-blank' keywords.
3136 Assume point is at the first underscore marker."
3148 :end end
3149 :contents-begin contents-begin
3150 :contents-end contents-end
3154 "Interpret UNDERLINE object as Org syntax.
3155 CONTENTS is the contents of the object."
3159 ;;;; Verbatim
3162 "Parse verbatim object at point.
3164 Return a list whose CAR is `verbatim' and CDR is a plist with
3165 `:value', `:begin', `:end' and `:post-blank' keywords.
3167 Assume point is at the first equal sign marker."
3178 :begin begin
3179 :end end
3183 "Interpret VERBATIM object as Org syntax.
3184 CONTENTS is nil."
3188 \f
3189 ;;; Parsing Element Starting At Point
3190 ;;
3191 ;; `org-element-current-element' is the core function of this section.
3192 ;; It returns the Lisp representation of the element starting at
3193 ;; point.
3194 ;;
3195 ;; `org-element-current-element' makes use of special modes. They are
3196 ;; activated for fixed element chaining (i.e. `plain-list' > `item')
3197 ;; or fixed conditional element chaining (i.e. `headline' >
3198 ;; `section'). Special modes are: `section', `quote-section', `item'
3199 ;; and `table-row'.
3203 "Parse the element starting at point.
3205 LIMIT bounds the search.
3207 Return value is a list like (TYPE PROPS) where TYPE is the type
3208 of the element and PROPS a plist of properties associated to the
3209 element.
3211 Possible types are defined in `org-element-all-elements'.
3213 Optional argument GRANULARITY determines the depth of the
3214 recursion. Allowed values are `headline', `greater-element',
3215 `element', `object' or nil. When it is broader than `object' (or
3216 nil), secondary values will not be parsed, since they only
3217 contain objects.
3219 Optional argument SPECIAL, when non-nil, can be either `section',
3220 `quote-section', `table-row' and `item'.
3222 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3223 be computed.
3225 This function assumes point is always at the beginning of the
3226 element it has to parse."
3228 ;; If point is at an affiliated keyword, try moving to the
3229 ;; beginning of the associated element. If none is found, the
3230 ;; keyword is orphaned and will be treated as plain text.
3236 ;; Determine if parsing depth allows for secondary strings
3237 ;; parsing. It only applies to elements referenced in
3238 ;; `org-element-secondary-value-alist'.
3241 ;; Item.
3244 ;; Quote Section.
3246 ;; Table Row.
3248 ;; Headline.
3251 ;; Section (must be checked after headline).
3253 ;; Planning and Clock.
3258 ;; Inlinetask.
3261 ;; LaTeX Environment.
3267 nil t))
3270 ;; Drawer and Property Drawer.
3280 ;; Fixed Width
3283 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3284 ;; Keywords.
3293 org-element-block-name-alist)))
3305 ;; Ill-formed syntax is considered as a comment.
3309 ;; Comments.
3311 ;; Footnote Definition.
3314 ;; Horizontal Rule.
3317 ;; Table.
3319 ;; List.
3322 ;; Default element: Paragraph.
3326 ;; Most elements can have affiliated keywords. When looking for an
3327 ;; element beginning, we want to move before them, as they belong to
3328 ;; that element, and, in the meantime, collect information they give
3329 ;; into appropriate properties. Hence the following function.
3330 ;;
3331 ;; Usage of optional arguments may not be obvious at first glance:
3332 ;;
3333 ;; - TRANS-LIST is used to polish keywords names that have evolved
3334 ;; during Org history. In example, even though =result= and
3335 ;; =results= coexist, we want to have them under the same =result=
3336 ;; property. It's also true for "srcname" and "name", where the
3337 ;; latter seems to be preferred nowadays (thus the "name" property).
3338 ;;
3339 ;; - CONSED allows to regroup multi-lines keywords under the same
3340 ;; property, while preserving their own identity. This is mostly
3341 ;; used for "attr_latex" and al.
3342 ;;
3343 ;; - PARSED prepares a keyword value for export. This is useful for
3344 ;; "caption". Objects restrictions for such keywords are defined in
3345 ;; `org-element-object-restrictions'.
3346 ;;
3347 ;; - DUALS is used to take care of keywords accepting a main and an
3348 ;; optional secondary values. For example "results" has its
3349 ;; source's name as the main value, and may have an hash string in
3350 ;; optional square brackets as the secondary one.
3351 ;;
3352 ;; A keyword may belong to more than one category.
3356 "Collect affiliated keywords before point.
3358 Optional argument KEY-RE is a regexp matching keywords, which
3359 puts matched keyword in group 1. It defaults to
3360 `org-element--affiliated-re'.
3362 TRANS-LIST is an alist where key is the keyword and value the
3363 property name it should be translated to, without the colons. It
3364 defaults to `org-element-keyword-translation-alist'.
3366 CONSED is a list of strings. Any keyword belonging to that list
3367 will have its value consed. The check is done after keyword
3368 translation. It defaults to `org-element-multiple-keywords'.
3370 PARSED is a list of strings. Any keyword member of this list
3371 will have its value parsed. The check is done after keyword
3372 translation. If a keyword is a member of both CONSED and PARSED,
3373 it's value will be a list of parsed strings. It defaults to
3374 `org-element-parsed-keywords'.
3376 DUALS is a list of strings. Any keyword member of this list can
3377 have two parts: one mandatory and one optional. Its value is
3378 a cons cell whose CAR is the former, and the CDR the latter. If
3379 a keyword is a member of both PARSED and DUALS, both values will
3380 be parsed. It defaults to `org-element-dual-keywords'.
3382 Return a list whose CAR is the position at the first of them and
3383 CDR a plist of keywords and values."
3391 ;; RESTRICT is the list of objects allowed in parsed
3392 ;; keywords value.
3394 output)
3398 ;; Apply translation to RAW-KWD. From there, KWD is
3399 ;; the official keyword.
3401 ;; Find main value for any keyword.
3407 ;; If KWD is a dual keyword, find its secondary
3408 ;; value. Maybe parse it.
3414 ;; Attribute a property name to KWD.
3416 ;; Now set final shape for VALUE.
3420 ;; VALUE is mandatory. Set it to nil if there is none.
3422 ;; Attributes are always consed.
3425 ;; Eventually store the new value in OUTPUT.
3431 \f
3432 ;;; The Org Parser
3433 ;;
3434 ;; The two major functions here are `org-element-parse-buffer', which
3435 ;; parses Org syntax inside the current buffer, taking into account
3436 ;; region, narrowing, or even visibility if specified, and
3437 ;; `org-element-parse-secondary-string', which parses objects within
3438 ;; a given string.
3439 ;;
3440 ;; The (almost) almighty `org-element-map' allows to apply a function
3441 ;; on elements or objects matching some type, and accumulate the
3442 ;; resulting values. In an export situation, it also skips unneeded
3443 ;; parts of the parse tree.
3446 "Recursively parse the buffer and return structure.
3447 If narrowing is in effect, only parse the visible part of the
3448 buffer.
3450 Optional argument GRANULARITY determines the depth of the
3451 recursion. It can be set to the following symbols:
3453 `headline' Only parse headlines.
3454 `greater-element' Don't recurse into greater elements excepted
3455 headlines and sections. Thus, elements
3456 parsed are the top-level ones.
3457 `element' Parse everything but objects and plain text.
3458 `object' Parse the complete buffer (default).
3460 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3461 elements.
3463 Assume buffer is in Org mode."
3469 ;; Start in `section' mode so text before the first
3470 ;; headline belongs to a section.
3474 "Recursively parse objects in STRING and return structure.
3476 RESTRICTION is a symbol limiting the object types that will be
3477 looked after.
3479 Optional argument PARENT, when non-nil, is the element or object
3480 containing the secondary string. It is used to set correctly
3481 `:parent' property within the string."
3487 secondary))))
3490 "Map a function on selected elements or objects.
3492 DATA is the parsed tree, as returned by, i.e,
3493 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3494 of elements or objects types. FUN is the function called on the
3495 matching element or object. It must accept one arguments: the
3496 element or object itself.
3498 When optional argument INFO is non-nil, it should be a plist
3499 holding export options. In that case, parts of the parse tree
3500 not exportable according to that property list will be skipped.
3502 When optional argument FIRST-MATCH is non-nil, stop at the first
3503 match for which FUN doesn't return nil, and return that value.
3505 Optional argument NO-RECURSION is a symbol or a list of symbols
3506 representing elements or objects types. `org-element-map' won't
3507 enter any recursive element or object whose type belongs to that
3508 list. Though, FUN can still be applied on them.
3510 Nil values returned from FUN do not appear in the results."
3511 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3514 ;; Recursion depth is determined by --CATEGORY.
3521 ;; If one object is found, the function
3522 ;; has to recurse into every object.
3525 ;; If one regular element is found, the
3526 ;; function has to recurse, at lest, into
3527 ;; every element it encounters.
3530 types)
3531 category)))
3532 --acc
3533 --walk-tree
3537 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3538 ;; holding contextual information.
3542 ;; Ignored element in an export context.
3544 ;; Secondary string: only objects can be found there.
3547 ;; Unconditionally enter parse trees.
3551 ;; Check if TYPE is matching among TYPES. If so,
3552 ;; apply FUN to --DATA and accumulate return value
3553 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3559 ;; If --DATA has a secondary string that can contain
3560 ;; objects with their type among TYPES, look into it.
3567 ;; Determine if a recursion into --DATA is possible.
3569 ;; --TYPE is explicitly removed from recursion.
3571 ;; --DATA has no contents.
3573 ;; Looking for greater elements but --DATA is simply
3574 ;; an element or an object.
3577 ;; Looking for elements but --DATA is an object.
3580 ;; In any other case, map contents.
3584 ;; Return value in a proper order.
3587 ;; The following functions are internal parts of the parser.
3588 ;;
3589 ;; The first one, `org-element-parse-elements' acts at the element's
3590 ;; level.
3591 ;;
3592 ;; The second one, `org-element-parse-objects' applies on all objects
3593 ;; of a paragraph or a secondary string. It uses
3594 ;; `org-element-get-candidates' to optimize the search of the next
3595 ;; object in the buffer.
3596 ;;
3597 ;; More precisely, that function looks for every allowed object type
3598 ;; first. Then, it discards failed searches, keeps further matches,
3599 ;; and searches again types matched behind point, for subsequent
3600 ;; calls. Thus, searching for a given type fails only once, and every
3601 ;; object is searched only once at top level (but sometimes more for
3602 ;; nested types).
3606 "Parse elements between BEG and END positions.
3608 SPECIAL prioritize some elements over the others. It can be set
3609 to `quote-section', `section' `item' or `table-row'.
3611 When value is `item', STRUCTURE will be used as the current list
3612 structure.
3614 GRANULARITY determines the depth of the recursion. See
3615 `org-element-parse-buffer' for more information.
3617 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3618 elements.
3620 Elements are accumulated into ACC."
3623 ;; When parsing only headlines, skip any text before first one.
3626 ;; Main loop start.
3628 ;; Find current element's type and parse it accordingly to
3629 ;; its category.
3631 end granularity special structure))
3635 ;; Fill ELEMENT contents by side-effect.
3637 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3638 ;; no contents, don't modify it.
3641 ;; Greater element: parse it between `contents-begin' and
3642 ;; `contents-end'. Make sure GRANULARITY allows the
3643 ;; recursion, or ELEMENT is an headline, in which case going
3644 ;; inside is mandatory, in order to get sub-level headings.
3652 ;; Possibly switch to a special mode.
3660 granularity visible-only element))
3661 ;; ELEMENT has contents. Parse objects inside, if
3662 ;; GRANULARITY allows it.
3668 ;; Return result.
3669 acc))
3672 "Parse objects between BEG and END and return recursive structure.
3674 Objects are accumulated in ACC.
3676 RESTRICTION is a list of object types which are allowed in the
3677 current object."
3683 end restriction candidates)))
3690 ;; 1. Text before any object. Untabify it.
3695 acc
3699 ;; 2. Object...
3702 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3703 ;; a recursive type.
3708 cont-beg
3715 ;; 3. Text after last object. Untabify it.
3719 acc
3723 ;; Result.
3724 acc)))
3727 "Return an alist of candidates for the next object.
3729 LIMIT bounds the search, and RESTRICTION narrows candidates to
3730 some object types.
3732 Return value is an alist whose CAR is position and CDR the object
3733 type, as a symbol.
3735 OBJECTS is the previous candidates alist."
3737 ;; If no previous result, search every object type in RESTRICTION.
3738 ;; Otherwise, keep potential candidates (old objects located after
3739 ;; point) and ask to search again those which had matched before.
3744 objects))
3745 ;; Call the appropriate successor function for each type to search
3746 ;; and accumulate matches.
3753 type))))
3756 types-to-search)
3757 ;; Return alist.
3758 next-candidates))
3761 \f
3762 ;;; Towards A Bijective Process
3763 ;;
3764 ;; The parse tree obtained with `org-element-parse-buffer' is really
3765 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3766 ;; interpreted and expanded into a string with canonical Org syntax.
3767 ;; Hence `org-element-interpret-data'.
3768 ;;
3769 ;; The function relies internally on
3770 ;; `org-element-interpret--affiliated-keywords'.
3773 "Interpret DATA as Org syntax.
3775 DATA is a parse tree, an element, an object or a secondary string
3776 to interpret.
3778 Optional argument PARENT is used for recursive calls. It contains
3779 the element or object containing data, or nil.
3781 Return Org syntax as a string."
3785 ;; Secondary string.
3790 ;; Full Org document.
3795 ;; Plain text.
3797 ;; Element/Object without contents.
3800 data nil))
3801 ;; Element/Object with contents.
3811 ;; Elements directly containing objects must
3812 ;; have their indentation normalized first.
3814 data
3815 ;; When normalizing first paragraph of an
3816 ;; item or a footnote-definition, ignore
3817 ;; first line's indentation.
3824 data
3826 contents)))))))
3828 ;; Build white spaces. If no `:post-blank' property is
3829 ;; specified, assume its value is 0.
3839 "Return ELEMENT's affiliated keywords as Org syntax.
3840 If there is no affiliated keyword, return the empty string."
3850 ": "
3853 value)
3861 ;; All attribute keywords can have multiple lines.
3864 value
3867 ;; List all ELEMENT's properties matching an attribute line or an
3868 ;; affiliated keyword, but ignore translated keywords since they
3869 ;; cannot belong to the property list.
3876 org-element-keyword-translation-alist)))))
3877 collect prop)
3880 ;; Because interpretation of the parse tree must return the same
3881 ;; number of blank lines between elements and the same number of white
3882 ;; space after objects, some special care must be given to white
3883 ;; spaces.
3884 ;;
3885 ;; The first function, `org-element-normalize-string', ensures any
3886 ;; string different from the empty string will end with a single
3887 ;; newline character.
3888 ;;
3889 ;; The second function, `org-element-normalize-contents', removes
3890 ;; global indentation from the contents of the current element.
3893 "Ensure string S ends with a single newline character.
3895 If S isn't a string return it unchanged. If S is the empty
3896 string, return it. Otherwise, return a new string with a single
3897 newline character at its end."
3905 "Normalize plain text in ELEMENT's contents.
3907 ELEMENT must only contain plain text and objects.
3909 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3910 indentation to compute maximal common indentation.
3912 Return the normalized element that is element with global
3913 indentation removed from its contents. The function assumes that
3914 indentation is not done with TAB characters."
3916 collect-inds ; for byte-compiler
3919 ;; Return list of indentations within BLOB. This is done by
3920 ;; walking recursively BLOB and updating IND-LIST along the
3921 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3922 ;; been seen yet. It is required as this string is the only
3923 ;; one whose indentation doesn't happen after a newline
3924 ;; character.
3932 ;; An indentation of zero means no string will be
3933 ;; modified. Quit the process.
3939 ;; Avoid matching blank or empty lines.
3947 ;; Collect indentation list in ELEMENT. Possibly remove first
3948 ;; value if IGNORE-FIRST is non-nil.
3951 ;; Build ELEMENT back, replacing each string with the same
3952 ;; string minus common indentation.
3957 ;; Return BLOB with all its strings indentation
3958 ;; shortened from MCI white spaces. FIRST-FLAG is
3959 ;; non-nil when the first string hasn't been seen
3960 ;; yet.
3974 org-element-recursive-objects)
3978 blob))))
3982 \f
3983 ;;; The Toolbox
3984 ;;
3985 ;; The first move is to implement a way to obtain the smallest element
3986 ;; containing point. This is the job of `org-element-at-point'. It
3987 ;; basically jumps back to the beginning of section containing point
3988 ;; and moves, element after element, with
3989 ;; `org-element-current-element' until the container is found.
3990 ;;
3991 ;; At a deeper level, `org-element-context' lists all elements and
3992 ;; objects containing point.
3993 ;;
3994 ;; Note: When using `org-element-at-point', secondary values are never
3995 ;; parsed since the function focuses on elements, not on objects.
3998 "Determine closest element around point.
4000 Return value is a list like (TYPE PROPS) where TYPE is the type
4001 of the element and PROPS a plist of properties associated to the
4002 element. Possible types are defined in
4003 `org-element-all-elements'.
4005 As a special case, if point is at the very beginning of a list or
4006 sub-list, returned element will be that list instead of the first
4007 item. In the same way, if point is at the beginning of the first
4008 row of a table, returned element will be the table instead of the
4009 first row.
4011 If optional argument KEEP-TRAIL is non-nil, the function returns
4012 a list of of elements leading to element at point. The list's
4013 CAR is always the element at point. Following positions contain
4014 element's siblings, then parents, siblings of parents, until the
4015 first element of current section."
4017 ;; If at an headline, parse it. It is the sole element that
4018 ;; doesn't require to know about context. Be sure to disallow
4019 ;; secondary string parsing, though.
4025 ;; Otherwise move at the beginning of the section containing
4026 ;; point.
4029 element type special-flag trail struct prevs)
4036 ;; Parse successively each element, skipping those ending
4037 ;; before original position.
4045 ;; 1. Skip any element ending before point or at point.
4050 ;; 2. An element containing point is always the element at
4051 ;; point.
4054 ;; 3. At any other greater element type, if point is
4055 ;; within contents, move into it. Otherwise, return
4056 ;; that element.
4073 "Return list of all elements and objects around point.
4075 Return value is a list like (TYPE PROPS) where TYPE is the type
4076 of the element or object and PROPS a plist of properties
4077 associated to it. Possible types are defined in
4078 `org-element-all-elements' and `org-element-all-objects'.
4080 All elements and objects returned belong to the current section
4081 and are ordered from closest to farthest."
4084 ;; Remove elements not containing point from trail.
4092 ;; Check if point is inside an element containing objects or at
4093 ;; a secondary string. In that case, move to beginning of the
4094 ;; element or secondary string and set END to the other side.
4103 (<= origin
4104 ;; `1+' is required so some
4105 ;; successors can match
4106 ;; properly their object.
4120 elements
4124 end restriction candidates))
4126 candidates)))
4127 ;; If ORIGIN is before next object in element, there's
4128 ;; no point in looking further.
4137 ;; ORIGIN is after OBJECT, so skip it.
4140 ;; ORIGIN is within a non-recursive object or at an
4141 ;; object boundaries: Return that object.
4144 ;; Otherwise, move within current object and restrict
4145 ;; search to the end of its contents.
4149 elements))))))
4152 ;; Once the local structure around point is well understood, it's easy
4153 ;; to implement some replacements for `forward-paragraph'
4154 ;; `backward-paragraph', namely `org-element-forward' and
4155 ;; `org-element-backward'.
4156 ;;
4157 ;; Also, `org-transpose-elements' mimics the behaviour of
4158 ;; `transpose-words', at the element's level, whereas
4159 ;; `org-element-drag-forward', `org-element-drag-backward', and
4160 ;; `org-element-up' generalize, respectively, functions
4161 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
4162 ;;
4163 ;; `org-element-unindent-buffer' will, as its name almost suggests,
4164 ;; smartly remove global indentation from buffer, making it possible
4165 ;; to use Org indent mode on a file created with hard indentation.
4166 ;;
4167 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
4168 ;; internally by some of the previously cited tools.
4171 "Non-nil when elements ELEM-A and ELEM-B are nested."
4180 "Swap elements ELEM-A and ELEM-B.
4181 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4182 end of ELEM-A."
4184 ;; There are two special cases when an element doesn't start at bol:
4185 ;; the first paragraph in an item or in a footnote definition.
4187 ;; Only a paragraph without any affiliated keyword can be moved at
4188 ;; ELEM-A position in such a situation. Note that the case of
4189 ;; a footnote definition is impossible: it cannot contain two
4190 ;; paragraphs in a row because it cannot contain a blank line.
4196 ;; In a special situation, ELEM-A will have no indentation. We'll
4197 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4211 ;; Store overlays responsible for visibility status. We
4212 ;; also need to store their boundaries as they will be
4213 ;; removed from buffer.
4220 ;; Get contents.
4228 ;; Restore ex ELEM-A overlays.
4238 ;; Restore ex ELEM-B overlays.
4247 "Move forward by one element.
4248 Move to the next element at the same level, when possible."
4261 return prev)))
4269 "Move backward by one element.
4270 Move to the previous element at the same level, when possible."
4273 ;; At an headline, move to the previous one, if any, or stay
4274 ;; here.
4285 ;; Move to beginning of current element if point isn't there
4286 ;; already.
4292 "Move to upper element."
4302 return prev)))
4309 "Move to inner element."
4317 ;; If contents are hidden, first disclose them.
4323 "Move backward element at point."
4329 ;; Error out if no previous element or previous element is
4330 ;; a parent of the current one.
4339 "Move forward element at point."
4352 ;; Compute new position of point: it's shifted by NEXT-ELEM
4353 ;; body's length (without final blanks) and by the length of
4354 ;; blanks between ELEM and NEXT-ELEM.
4359 ;; Small correction if buffer doesn't end
4360 ;; with a newline character.
4373 "Put point at beginning of this element, mark at end.
4375 Interactively, if this command is repeated or (in Transient Mark
4376 mode) if the mark is active, it marks the next element after the
4377 ones already marked."
4392 "Narrow buffer to current element."
4410 "Transpose current and previous elements, keeping blank lines between.
4411 Point is moved after both elements."
4419 "Un-indent the visible part of the buffer.
4420 Relative indentation (between items, inside blocks, etc.) isn't
4421 modified."
4426 unindent-tree ; For byte-compiler.
4444 "Fill element at point, when applicable.
4446 This function only applies to paragraph, comment blocks, example
4447 blocks and fixed-width areas. Also, as a special case, re-align
4448 table when point is at one.
4450 If JUSTIFY is non-nil (interactively, with prefix argument),
4451 justify as well. If `sentence-end-double-space' is non-nil, then
4452 period followed by one space does not end a sentence, so don't
4453 break a line there. The variable `fill-column' controls the
4454 width for filling."
4457 ;; Align Org tables, leave table.el tables as-is.
4461 t)
4462 ;; Elements that may contain `line-break' type objects.
4466 ;; Do nothing if point is at an affiliated keyword or at
4467 ;; verse block markers.
4469 ;; At a verse block, first narrow to current "paragraph"
4470 ;; and set current element to that paragraph.
4483 ;; Fill paragraph, taking line breaks into consideration.
4484 ;; For that, slice the paragraph using line breaks as
4485 ;; separators, and fill the parts in reverse order to
4486 ;; avoid messing with markers.
4493 ;; Find the list of ending positions for line breaks
4494 ;; in the current paragraph. Add paragraph beginning
4495 ;; to include first slice.
4500 beg end nil org-element-all-objects)
4501 'line-break
4503 ;; Elements whose contents should be filled as plain text.
4517 ;; Ignore every other element.
4522 ;;; org-element.el ends here