| blob | b7cdc4428cb14a5e225ade43bc9f20fab8d0de7d |
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 `org-element-at-point' function, and
104 ;; a way to give information about document structure around point
105 ;; with `org-element-context'.
108 ;;; Code:
115 \f
116 ;;; Definitions And Rules
117 ;;
118 ;; Define elements, greater elements and specify recursive objects,
119 ;; along with the affiliated keywords recognized. Also set up
120 ;; restrictions on recursive objects combinations.
121 ;;
122 ;; These variables really act as a control center for the parsing
123 ;; process.
127 ;; Headlines, inlinetasks.
129 ;; Footnote definitions.
132 ;; Empty lines.
134 ;; Tables (any type).
136 ;; Blocks (any type), Babel calls, drawers (any type),
137 ;; fixed-width areas and keywords. Note: this is only an
138 ;; indication and need some thorough check.
140 ;; Horizontal rules.
142 ;; LaTeX environments.
144 ;; Planning and Clock lines.
146 org-deadline-string
147 org-closed-string
148 org-clock-string))
150 ;; Lists.
157 "Regexp to separate paragraphs in an Org buffer.
159 is not sufficient to know if point is at a paragraph ending. See
164 export-block fixed-width footnote-definition headline
165 horizontal-rule inlinetask item keyword latex-environment
166 babel-call paragraph plain-list planning property-drawer
167 quote-block quote-section section special-block src-block table
168 table-row verse-block)
173 item plain-list quote-block section special-block table)
178 latex-or-entity line-break link macro radio-target
179 statistics-cookie sub/superscript table-cell target
180 text-markup timestamp)
189 "Alist of translations between object type and successor name.
191 Sharing the same successor comes handy when, for example, the
196 inline-src-block italic line-break latex-fragment link macro
197 radio-target statistics-cookie strike-through subscript superscript
198 table-cell target timestamp underline verbatim)
203 table-cell underline)
213 "Alist between block names and the associated parsing function.
214 Names must be uppercase. Any block whose name has no association
220 "List of affiliated keywords as strings.
226 ;; Regular affiliated keywords.
229 "Regexp matching any affiliated keyword.
231 Keyword name is put in match group 1. Moreover, if keyword
232 belongs to `org-element-dual-keywords', put the dual value in
233 match group 2.
241 "Alist of usual translations for keywords.
242 The key is the old name and the value the new one. The property
246 "List of affiliated keywords that can occur more that once in an element.
248 Their value will be consed into a list of strings, which will be
249 returned as the value of the property.
251 This list is checked after translations have been applied. See
252 `org-element-keyword-translation-alist'.
258 "List of keywords whose value can be parsed.
260 Their value will be stored as a secondary string: a list of
261 strings and objects.
263 This list is checked after translations have been applied. See
267 "List of keywords which can have a secondary value.
269 In Org syntax, they can be written with optional square brackets
270 before the colons. For example, results keyword can be
271 associated to a hash value with the following:
273 #+RESULTS[hash-string]: some-source
275 This list is checked after translations have been applied. See
282 inline-src-block latex-or-entity line-break link macro
283 radio-target sub/superscript target text-markup
284 timestamp)
286 radio-target statistics-cookie sub/superscript target text-markup
287 timestamp)
299 inline-src-block latex-or-entity line-break link macro
300 radio-target statistics-cookie sub/superscript target text-markup
301 timestamp)
304 latex-or-entity link radio-target sub/superscript target
305 text-markup timestamp)
316 latex-or-entity line-break link macro radio-target
318 "Alist of objects restrictions.
320 CAR is an element or object type containing objects and CDR is
321 a list of successors that will be called within an element or
322 object of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, export snippets, latex-fragments, subscript and
326 superscript.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
340 \f
341 ;;; Accessors and Setters
342 ;;
343 ;; Provide four accessors: `org-element-type', `org-element-property'
344 ;; `org-element-contents' and `org-element-restriction'.
345 ;;
346 ;; Setter functions allow to modify elements by side effect. There is
347 ;; `org-element-put-property', `org-element-set-contents',
348 ;; `org-element-set-element' and `org-element-adopt-element'. Note
349 ;; that `org-element-set-element' and `org-element-adopt-element' are
350 ;; higher level functions since also update `:parent' property.
353 "Return type of ELEMENT.
355 The function returns the type of the element or object provided.
356 It can also return the following special value:
357 `plain-text' for a string
358 `org-data' for a complete document
359 nil in any other case."
365 "Extract the value from the PROPERTY of an ELEMENT."
369 "Extract contents from an ELEMENT."
373 "Return restriction associated to ELEMENT.
374 ELEMENT can be an element, an object or a symbol representing an
375 element or object type."
377 org-element-object-restrictions)))
380 "In ELEMENT set PROPERTY to VALUE.
381 Return modified element."
384 element)
387 "Set ELEMENT contents to CONTENTS.
388 Return modified element."
394 "Replace element or object OLD with element or object NEW.
395 The function takes care of setting `:parent' property for NEW."
396 ;; OLD can belong to the contents of PARENT or to its secondary
397 ;; string.
400 org-element-secondary-value-alist)))
403 ;; Make sure NEW has correct `:parent' property.
405 ;; Replace OLD with NEW in PARENT.
409 "Add an element to the contents of another element.
411 PARENT is an element or object. CHILD is an element, an object,
412 or a string.
414 CHILD is added at the beginning of PARENT contents, unless the
415 optional argument APPEND is non-nil, in which case CHILD is added
416 at the end.
418 The function takes care of setting `:parent' property for CHILD.
419 Return parent element."
423 parent
425 ;; Link the CHILD element with PARENT.
427 ;; Return the parent element.
428 parent))
431 \f
432 ;;; Greater elements
433 ;;
434 ;; For each greater element type, we define a parser and an
435 ;; interpreter.
436 ;;
437 ;; A parser returns the element or object as the list described above.
438 ;; Most of them accepts no argument. Though, exceptions exist. Hence
439 ;; every element containing a secondary string (see
440 ;; `org-element-secondary-value-alist') will accept an optional
441 ;; argument to toggle parsing of that secondary string. Moreover,
442 ;; `item' parser requires current list's structure as its first
443 ;; element.
444 ;;
445 ;; An interpreter accepts two arguments: the list representation of
446 ;; the element or object, and its contents. The latter may be nil,
447 ;; depending on the element or object considered. It returns the
448 ;; appropriate Org syntax, as a string.
449 ;;
450 ;; Parsing functions must follow the naming convention:
451 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
452 ;; defined in `org-element-greater-elements'.
453 ;;
454 ;; Similarly, interpreting functions must follow the naming
455 ;; convention: org-element-TYPE-interpreter.
456 ;;
457 ;; With the exception of `headline' and `item' types, greater elements
458 ;; cannot contain other greater elements of their own type.
459 ;;
460 ;; Beside implementing a parser and an interpreter, adding a new
461 ;; greater element requires to tweak `org-element--current-element'.
462 ;; Moreover, the newly defined type must be added to both
463 ;; `org-element-all-elements' and `org-element-greater-elements'.
466 ;;;; Center Block
469 "Parse a center block.
471 LIMIT bounds the search.
473 Return a list whose CAR is `center-block' and CDR is a plist
474 containing `:begin', `:end', `:hiddenp', `:contents-begin',
475 `:contents-end' and `:post-blank' keywords.
477 Assume point is at the beginning of the block."
481 ;; Incomplete block: parse it as a comment.
486 ;; Empty blocks have no contents.
500 :end end
501 :hiddenp hidden
502 :contents-begin contents-begin
503 :contents-end contents-end
508 "Interpret CENTER-BLOCK element as Org syntax.
509 CONTENTS is the contents of the element."
513 ;;;; Drawer
516 "Parse a drawer.
518 LIMIT bounds the search.
520 Return a list whose CAR is `drawer' and CDR is a plist containing
521 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
522 `:contents-end' and `:post-blank' keywords.
524 Assume point is at beginning of drawer."
527 ;; Incomplete drawer: parse it as a paragraph.
536 ;; Empty drawers have no contents.
550 :end end
551 :drawer-name name
552 :hiddenp hidden
553 :contents-begin contents-begin
554 :contents-end contents-end
559 "Interpret DRAWER element as Org syntax.
560 CONTENTS is the contents of the element."
563 contents))
566 ;;;; Dynamic Block
569 "Parse a dynamic block.
571 LIMIT bounds the search.
573 Return a list whose CAR is `dynamic-block' and CDR is a plist
574 containing `:block-name', `:begin', `:end', `:hiddenp',
575 `:contents-begin', `:contents-end', `:arguments' and
576 `:post-blank' keywords.
578 Assume point is at beginning of dynamic block."
581 ;; Incomplete block: parse it as a comment.
590 ;; Empty blocks have no contents.
604 :end end
605 :block-name name
606 :arguments arguments
607 :hiddenp hidden
608 :contents-begin contents-begin
609 :contents-end contents-end
614 "Interpret DYNAMIC-BLOCK element as Org syntax.
615 CONTENTS is the contents of the element."
620 contents))
623 ;;;; Footnote Definition
626 "Parse a footnote definition.
628 LIMIT bounds the search.
630 Return a list whose CAR is `footnote-definition' and CDR is
631 a plist containing `:label', `:begin' `:end', `:contents-begin',
632 `:contents-end' and `:post-blank' keywords.
634 Assume point is at the beginning of the footnote definition."
659 :begin begin
660 :end end
661 :contents-begin contents-begin
662 :contents-end contents-end
667 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
668 CONTENTS is the contents of the footnote-definition."
670 " "
671 contents))
674 ;;;; Headline
677 "Parse an headline.
679 Return a list whose CAR is `headline' and CDR is a plist
680 containing `:raw-value', `:title', `:begin', `:end',
681 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
682 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
683 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
684 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
685 keywords.
687 The plist also contains any property set in the property drawer,
688 with its name in lowercase, the underscores replaced with hyphens
689 and colons at the beginning (i.e. `:custom-id').
691 When RAW-SECONDARY-P is non-nil, headline's title will not be
692 parsed as a secondary string, but as a plain string instead.
694 Assume point is at beginning of the headline."
713 ;; Normalize property names: ":SOME_PROP:" becomes
714 ;; ":some-prop".
726 plist))
744 ;; Clean RAW-VALUE from any quote or comment string.
749 ""
750 raw-value)))
751 ;; Clean TAGS from archive tag, if any.
757 :begin begin
758 :end end
759 :pre-blank
762 :hiddenp hidden
763 :contents-begin contents-begin
764 :contents-end contents-end
765 :level level
767 :tags tags
768 :todo-keyword todo
769 :todo-type todo-type
770 :scheduled scheduled
771 :deadline deadline
772 :timestamp timestamp
773 :clock clock
779 end)
780 :footnote-section-p footnote-section-p
781 :archivedp archivedp
782 :commentedp commentedp
784 standard-props))))
786 headline :title
792 "Interpret HEADLINE element as Org syntax.
793 CONTENTS is the contents of the element."
820 ;; Align tags.
828 ? )
829 tags))
833 tags))))
835 contents)))
838 ;;;; Inlinetask
841 "Parse an inline task.
843 Return a list whose CAR is `inlinetask' and CDR is a plist
844 containing `:title', `:begin', `:end', `:hiddenp',
845 `:contents-begin' and `:contents-end', `:level', `:priority',
846 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
847 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
849 The plist also contains any property set in the property drawer,
850 with its name in lowercase, the underscores replaced with hyphens
851 and colons at the beginning (i.e. `:custom-id').
853 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
854 title will not be parsed as a secondary string, but as a plain
855 string instead.
857 Assume point is at beginning of the inline task."
867 ;; Normalize property names: ":SOME_PROP:" becomes
868 ;; ":some-prop".
880 plist))
904 :end end
905 :hiddenp hidden
906 :contents-begin contents-begin
907 :contents-end contents-end
910 :tags tags
911 :todo-keyword todo
912 :todo-type todo-type
913 :scheduled scheduled
914 :deadline deadline
915 :timestamp timestamp
916 :clock clock
918 standard-props
921 inlinetask :title
926 inlinetask))))))
929 "Interpret INLINETASK element as Org syntax.
930 CONTENTS is the contents of inlinetask."
945 ;; Align tags.
953 ? )
954 tags))
958 tags))))
959 ;; Prefer degenerate inlinetasks when there are no
960 ;; contents.
963 contents
967 ;;;; Item
970 "Parse an item.
972 STRUCT is the structure of the plain list.
974 Return a list whose CAR is `item' and CDR is a plist containing
975 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
976 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
977 `:post-blank' keywords.
979 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
980 any, will not be parsed as a secondary string, but as a plain
981 string instead.
983 Assume point is at the beginning of the item."
1006 ;; If first line isn't empty,
1007 ;; contents really start at the text
1008 ;; after item's meta-data.
1021 :begin begin
1022 :end end
1023 ;; CONTENTS-BEGIN and CONTENTS-END may be
1024 ;; mixed up in the case of an empty item
1025 ;; separated from the next by a blank line.
1026 ;; Thus ensure the former is always the
1027 ;; smallest.
1030 :checkbox checkbox
1031 :counter counter
1032 :hiddenp hidden
1033 :structure struct
1036 item :tag
1044 "Interpret ITEM element as Org syntax.
1045 CONTENTS is the contents of the element."
1051 ;; Compute indentation.
1056 ;; Indent contents.
1058 bullet
1071 ;;;; Plain List
1074 "Parse a plain list.
1076 Optional argument STRUCTURE, when non-nil, is the structure of
1077 the plain list being parsed.
1079 Return a list whose CAR is `plain-list' and CDR is a plist
1080 containing `:type', `:begin', `:end', `:contents-begin' and
1081 `:contents-end', `:structure' and `:post-blank' keywords.
1083 Assume point is at the beginning of the list."
1098 ;; Return value.
1102 :begin begin
1103 :end end
1104 :contents-begin contents-begin
1105 :contents-end contents-end
1106 :structure struct
1111 "Interpret PLAIN-LIST element as Org syntax.
1112 CONTENTS is the contents of the element."
1120 ;;;; Quote Block
1123 "Parse a quote block.
1125 LIMIT bounds the search.
1127 Return a list whose CAR is `quote-block' and CDR is a plist
1128 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1129 `:contents-end' and `:post-blank' keywords.
1131 Assume point is at the beginning of the block."
1135 ;; Incomplete block: parse it as a comment.
1141 ;; Empty blocks have no contents.
1155 :end end
1156 :hiddenp hidden
1157 :contents-begin contents-begin
1158 :contents-end contents-end
1163 "Interpret QUOTE-BLOCK element as Org syntax.
1164 CONTENTS is the contents of the element."
1168 ;;;; Section
1171 "Parse a section.
1173 LIMIT bounds the search.
1175 Return a list whose CAR is `section' and CDR is a plist
1176 containing `:begin', `:end', `:contents-begin', `contents-end'
1177 and `:post-blank' keywords."
1179 ;; Beginning of section is the beginning of the first non-blank
1180 ;; line after previous headline.
1189 :end end
1190 :contents-begin begin
1191 :contents-end pos-before-blank
1195 "Interpret SECTION element as Org syntax.
1196 CONTENTS is the contents of the element."
1197 contents)
1200 ;;;; Special Block
1203 "Parse a special block.
1205 LIMIT bounds the search.
1207 Return a list whose CAR is `special-block' and CDR is a plist
1208 containing `:type', `:begin', `:end', `:hiddenp',
1209 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1211 Assume point is at the beginning of the block."
1217 ;; Incomplete block: parse it as a comment.
1223 ;; Empty blocks have no contents.
1237 :begin begin
1238 :end end
1239 :hiddenp hidden
1240 :contents-begin contents-begin
1241 :contents-end contents-end
1246 "Interpret SPECIAL-BLOCK element as Org syntax.
1247 CONTENTS is the contents of the element."
1252 \f
1253 ;;; Elements
1254 ;;
1255 ;; For each element, a parser and an interpreter are also defined.
1256 ;; Both follow the same naming convention used for greater elements.
1257 ;;
1258 ;; Also, as for greater elements, adding a new element type is done
1259 ;; through the following steps: implement a parser and an interpreter,
1260 ;; tweak `org-element--current-element' so that it recognizes the new
1261 ;; type and add that new type to `org-element-all-elements'.
1262 ;;
1263 ;; As a special case, when the newly defined type is a block type,
1264 ;; `org-element-block-name-alist' has to be modified accordingly.
1267 ;;;; Babel Call
1270 "Parse a babel call.
1272 LIMIT bounds the search.
1274 Return a list whose CAR is `babel-call' and CDR is a plist
1275 containing `:begin', `:end', `:info' and `:post-blank' as
1276 keywords."
1287 :end end
1288 :info info
1292 "Interpret BABEL-CALL element as Org syntax.
1293 CONTENTS is nil."
1299 ;; Remove redundant square brackets.
1304 ;;;; Clock
1307 "Parse a clock.
1309 LIMIT bounds the search.
1311 Return a list whose CAR is `clock' and CDR is a plist containing
1312 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1313 as keywords."
1332 :value value
1333 :time time
1334 :begin begin
1335 :end end
1339 "Interpret CLOCK element as Org syntax.
1340 CONTENTS is nil."
1347 "%2s:%02s"
1351 ;;;; Comment
1354 "Parse a comment.
1356 LIMIT bounds the search.
1358 Return a list whose CAR is `comment' and CDR is a plist
1359 containing `:begin', `:end', `:value' and `:post-blank'
1360 keywords.
1362 Assume point is at comment beginning."
1371 ;; Get comments ending.
1374 ;; Accumulate lines without leading hash and first
1375 ;; whitespace.
1389 :end end
1390 :value value
1395 "Interpret COMMENT element as Org syntax.
1396 CONTENTS is nil."
1400 ;;;; Comment Block
1403 "Parse an export block.
1405 LIMIT bounds the search.
1407 Return a list whose CAR is `comment-block' and CDR is a plist
1408 containing `:begin', `:end', `:hiddenp', `:value' and
1409 `:post-blank' keywords.
1411 Assume point is at comment block beginning."
1415 ;; Incomplete block: parse it as a comment.
1429 contents-begin contents-end)))
1433 :end end
1434 :value value
1435 :hiddenp hidden
1440 "Interpret COMMENT-BLOCK element as Org syntax.
1441 CONTENTS is nil."
1446 ;;;; Example Block
1449 "Parse an example block.
1451 LIMIT bounds the search.
1453 Return a list whose CAR is `example-block' and CDR is a plist
1454 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1455 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1456 `:switches', `:value' and `:post-blank' keywords."
1460 ;; Incomplete block: parse it as a comment.
1467 ;; Switches analysis
1472 ;; Should labels be retained in (or stripped from) example
1473 ;; blocks?
1478 ;; What should code-references use - labels or
1479 ;; line-numbers?
1486 ;; Standard block parsing.
1500 :end end
1501 :value value
1502 :switches switches
1503 :number-lines number-lines
1504 :preserve-indent preserve-indent
1505 :retain-labels retain-labels
1506 :use-labels use-labels
1507 :label-fmt label-fmt
1508 :hiddenp hidden
1513 "Interpret EXAMPLE-BLOCK element as Org syntax.
1514 CONTENTS is nil."
1522 ;;;; Export Block
1525 "Parse an export block.
1527 LIMIT bounds the search.
1529 Return a list whose CAR is `export-block' and CDR is a plist
1530 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1531 `:post-blank' keywords.
1533 Assume point is at export-block beginning."
1539 ;; Incomplete block: parse it as a comment.
1553 contents-end)))
1557 :end end
1558 :type type
1559 :value value
1560 :hiddenp hidden
1565 "Interpret EXPORT-BLOCK element as Org syntax.
1566 CONTENTS is nil."
1573 ;;;; Fixed-width
1576 "Parse a fixed-width section.
1578 LIMIT bounds the search.
1580 Return a list whose CAR is `fixed-width' and CDR is a plist
1581 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1583 Assume point is at the beginning of the fixed-width area."
1587 value
1592 ;; Accumulate text without starting colons.
1605 :end end
1606 :value value
1611 "Interpret FIXED-WIDTH element as Org syntax.
1612 CONTENTS is nil."
1617 ;;;; Horizontal Rule
1620 "Parse an horizontal rule.
1622 LIMIT bounds the search.
1624 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1625 containing `:begin', `:end' and `:post-blank' keywords."
1635 :end end
1640 "Interpret HORIZONTAL-RULE element as Org syntax.
1641 CONTENTS is nil."
1645 ;;;; Keyword
1648 "Parse a keyword at point.
1650 LIMIT bounds the search.
1652 Return a list whose CAR is `keyword' and CDR is a plist
1653 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1654 keywords."
1667 :value value
1668 :begin begin
1669 :end end
1673 "Interpret KEYWORD element as Org syntax.
1674 CONTENTS is nil."
1680 ;;;; Latex Environment
1683 "Parse a LaTeX environment.
1685 LIMIT bounds the search.
1687 Return a list whose CAR is `latex-environment' and CDR is a plist
1688 containing `:begin', `:end', `:value' and `:post-blank'
1689 keywords.
1691 Assume point is at the beginning of the latex environment."
1709 :end end
1710 :value value
1715 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1716 CONTENTS is nil."
1720 ;;;; Paragraph
1723 "Parse a paragraph.
1725 LIMIT bounds the search.
1727 Return a list whose CAR is `paragraph' and CDR is a plist
1728 containing `:begin', `:end', `:contents-begin' and
1729 `:contents-end' and `:post-blank' keywords.
1731 Assume point is at the beginning of the paragraph."
1742 ;; Skip non-existent or incomplete drawer.
1750 ;; Stop at comments.
1754 ;; Skip incomplete dynamic blocks.
1761 ;; Skip incomplete blocks.
1769 limit t))))
1770 ;; Skip ill-formed keywords.
1782 ;; If paragraph has no affiliated keywords, it may not begin
1783 ;; at beginning of line if it starts an item.
1786 :end end
1787 :contents-begin contents-begin
1788 :contents-end contents-end
1793 "Interpret PARAGRAPH element as Org syntax.
1794 CONTENTS is the contents of the element."
1795 contents)
1798 ;;;; Planning
1801 "Parse a planning.
1803 LIMIT bounds the search.
1805 Return a list whose CAR is `planning' and CDR is a plist
1806 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1807 and `:post-blank' keywords."
1816 closed deadline scheduled)
1830 :deadline deadline
1831 :scheduled scheduled
1832 :begin begin
1833 :end end
1837 "Interpret PLANNING element as Org syntax.
1838 CONTENTS is nil."
1840 'identity
1852 ;;;; Property Drawer
1855 "Parse a property drawer.
1857 LIMIT bounds the search.
1859 Return a list whose CAR is `property-drawer' and CDR is a plist
1860 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1861 `:contents-end', `:properties' and `:post-blank' keywords.
1863 Assume point is at the beginning of the property drawer."
1877 val))
1879 val))
1887 :end end
1888 :hiddenp hidden
1889 :properties properties
1893 "Interpret PROPERTY-DRAWER element as Org syntax.
1894 CONTENTS is nil."
1904 ;;;; Quote Section
1907 "Parse a quote section.
1909 LIMIT bounds the search.
1911 Return a list whose CAR is `quote-section' and CDR is a plist
1912 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1914 Assume point is at beginning of the section."
1925 :end end
1926 :value value
1930 "Interpret QUOTE-SECTION element as Org syntax.
1931 CONTENTS is nil."
1935 ;;;; Src Block
1938 "Parse a src block.
1940 LIMIT bounds the search.
1942 Return a list whose CAR is `src-block' and CDR is a plist
1943 containing `:language', `:switches', `:parameters', `:begin',
1944 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1945 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1946 `:post-blank' keywords.
1948 Assume point is at the beginning of the block."
1951 ;; Incomplete block: parse it as a comment.
1956 ;; Get beginning position.
1958 ;; Get language as a string.
1967 ;; Get switches.
1969 ;; Get parameters.
1971 ;; Switches analysis
1979 ;; Should labels be retained in (or stripped from)
1980 ;; src blocks?
1985 ;; What should code-references use - labels or
1986 ;; line-numbers?
1990 ;; Get visibility status.
1992 ;; Retrieve code.
1997 ;; Get position after ending blank lines.
2007 :begin begin
2008 :end end
2009 :number-lines number-lines
2010 :preserve-indent preserve-indent
2011 :retain-labels retain-labels
2012 :use-labels use-labels
2013 :label-fmt label-fmt
2014 :hiddenp hidden
2015 :value value
2020 "Interpret SRC-BLOCK element as Org syntax.
2021 CONTENTS is nil."
2041 value
2045 ;;;; Table
2048 "Parse a table at point.
2050 LIMIT bounds the search.
2052 Return a list whose CAR is `table' and CDR is a plist containing
2053 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2054 `:contents-end', `:value' and `:post-blank' keywords.
2056 Assume point is at the beginning of the table."
2068 acc))
2075 :end end
2076 :type type
2077 :tblfm tblfm
2078 ;; Only `org' tables have contents. `table.el' tables
2079 ;; use a `:value' property to store raw table as
2080 ;; a string.
2085 table-begin table-end))
2090 "Interpret TABLE element as Org syntax.
2091 CONTENTS is nil."
2102 ;;;; Table Row
2105 "Parse table row at point.
2107 LIMIT bounds the search.
2109 Return a list whose CAR is `table-row' and CDR is a plist
2110 containing `:begin', `:end', `:contents-begin', `:contents-end',
2111 `:type' and `:post-blank' keywords."
2115 ;; A table rule has no contents. In that case, ensure
2116 ;; CONTENTS-BEGIN matches CONTENTS-END.
2128 :begin begin
2129 :end end
2130 :contents-begin contents-begin
2131 :contents-end contents-end
2135 "Interpret TABLE-ROW element as Org syntax.
2136 CONTENTS is the contents of the table row."
2141 ;;;; Verse Block
2144 "Parse a verse block.
2146 LIMIT bounds the search.
2148 Return a list whose CAR is `verse-block' and CDR is a plist
2149 containing `:begin', `:end', `:contents-begin', `:contents-end',
2150 `:hiddenp' and `:post-blank' keywords.
2152 Assume point is at beginning of the block."
2156 ;; Incomplete block: parse it as a comment.
2172 :end end
2173 :contents-begin contents-begin
2174 :contents-end contents-end
2175 :hiddenp hidden
2180 "Interpret VERSE-BLOCK element as Org syntax.
2181 CONTENTS is verse block contents."
2185 \f
2186 ;;; Objects
2187 ;;
2188 ;; Unlike to elements, interstices can be found between objects.
2189 ;; That's why, along with the parser, successor functions are provided
2190 ;; for each object. Some objects share the same successor (i.e. `code'
2191 ;; and `verbatim' objects).
2192 ;;
2193 ;; A successor must accept a single argument bounding the search. It
2194 ;; will return either a cons cell whose CAR is the object's type, as
2195 ;; a symbol, and CDR the position of its next occurrence, or nil.
2196 ;;
2197 ;; Successors follow the naming convention:
2198 ;; org-element-NAME-successor, where NAME is the name of the
2199 ;; successor, as defined in `org-element-all-successors'.
2200 ;;
2201 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2202 ;; object types they can contain will be specified in
2203 ;; `org-element-object-restrictions'.
2204 ;;
2205 ;; Adding a new type of object is simple. Implement a successor,
2206 ;; a parser, and an interpreter for it, all following the naming
2207 ;; convention. Register type in `org-element-all-objects' and
2208 ;; successor in `org-element-all-successors'. Maybe tweak
2209 ;; restrictions about it, and that's it.
2212 ;;;; Bold
2215 "Parse bold object at point.
2217 Return a list whose CAR is `bold' and CDR is a plist with
2218 `:begin', `:end', `:contents-begin' and `:contents-end' and
2219 `:post-blank' keywords.
2221 Assume point is at the first star marker."
2233 :end end
2234 :contents-begin contents-begin
2235 :contents-end contents-end
2239 "Interpret BOLD object as Org syntax.
2240 CONTENTS is the contents of the object."
2244 "Search for the next text-markup object.
2246 LIMIT bounds the search.
2248 Return value is a cons cell whose CAR is a symbol among `bold',
2249 `italic', `underline', `strike-through', `code' and `verbatim'
2250 and CDR is beginning position."
2266 ;;;; Code
2269 "Parse code object at point.
2271 Return a list whose CAR is `code' and CDR is a plist with
2272 `:value', `:begin', `:end' and `:post-blank' keywords.
2274 Assume point is at the first tilde marker."
2285 :begin begin
2286 :end end
2290 "Interpret CODE object as Org syntax.
2291 CONTENTS is nil."
2295 ;;;; Entity
2298 "Parse entity at point.
2300 Return a list whose CAR is `entity' and CDR a plist with
2301 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2302 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2303 keywords.
2305 Assume point is at the beginning of the entity."
2307 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2323 :begin begin
2324 :end end
2325 :use-brackets-p bracketsp
2329 "Interpret ENTITY object as Org syntax.
2330 CONTENTS is nil."
2336 "Search for the next latex-fragment or entity object.
2338 LIMIT bounds the search.
2340 Return value is a cons cell whose CAR is `entity' or
2341 `latex-fragment' and CDR is beginning position."
2344 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2351 limit t)
2354 ;; Determine if it's a real entity or a LaTeX command.
2357 ;; No entity nor command: point is at a LaTeX fragment.
2358 ;; Determine its type to get the correct beginning position.
2366 matchers)
2370 ;;;; Export Snippet
2373 "Parse export snippet at point.
2375 Return a list whose CAR is `export-snippet' and CDR a plist with
2376 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2377 keywords.
2379 Assume point is at the beginning of the snippet."
2391 :value value
2392 :begin begin
2393 :end end
2397 "Interpret EXPORT-SNIPPET object as Org syntax.
2398 CONTENTS is nil."
2404 "Search for the next export-snippet object.
2406 LIMIT bounds the search.
2408 Return value is a cons cell whose CAR is `export-snippet' and CDR
2409 its beginning position."
2418 ;;;; Footnote Reference
2421 "Parse footnote reference at point.
2423 Return a list whose CAR is `footnote-reference' and CDR a plist
2424 with `:label', `:type', `:inline-definition', `:begin', `:end'
2425 and `:post-blank' as keywords."
2447 :type type
2448 :begin begin
2449 :end end
2452 footnote-reference :inline-definition
2457 footnote-reference))))))
2460 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2461 CONTENTS is nil."
2471 "Search for the next footnote-reference object.
2473 LIMIT bounds the search.
2475 Return value is a cons cell whose CAR is `footnote-reference' and
2476 CDR is beginning position."
2490 ;;;; Inline Babel Call
2493 "Parse inline babel call at point.
2495 Return a list whose CAR is `inline-babel-call' and CDR a plist
2496 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2498 Assume point is at the beginning of the babel call."
2509 :end end
2510 :info info
2514 "Interpret INLINE-BABEL-CALL object as Org syntax.
2515 CONTENTS is nil."
2521 ;; Remove redundant square brackets.
2524 main-source)
2528 "Search for the next inline-babel-call object.
2530 LIMIT bounds the search.
2532 Return value is a cons cell whose CAR is `inline-babel-call' and
2533 CDR is beginning position."
2535 ;; Use a simplified version of
2536 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2538 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2539 limit t)
2543 ;;;; Inline Src Block
2546 "Parse inline source block at point.
2548 LIMIT bounds the search.
2550 Return a list whose CAR is `inline-src-block' and CDR a plist
2551 with `:begin', `:end', `:language', `:value', `:parameters' and
2552 `:post-blank' as keywords.
2554 Assume point is at the beginning of the inline src block."
2567 :value value
2568 :parameters parameters
2569 :begin begin
2570 :end end
2574 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2575 CONTENTS is nil."
2580 language
2582 body)))
2585 "Search for the next inline-babel-call element.
2587 LIMIT bounds the search.
2589 Return value is a cons cell whose CAR is `inline-babel-call' and
2590 CDR is beginning position."
2595 ;;;; Italic
2598 "Parse italic object at point.
2600 Return a list whose CAR is `italic' and CDR is a plist with
2601 `:begin', `:end', `:contents-begin' and `:contents-end' and
2602 `:post-blank' keywords.
2604 Assume point is at the first slash marker."
2616 :end end
2617 :contents-begin contents-begin
2618 :contents-end contents-end
2622 "Interpret ITALIC object as Org syntax.
2623 CONTENTS is the contents of the object."
2627 ;;;; Latex Fragment
2630 "Parse latex fragment at point.
2632 Return a list whose CAR is `latex-fragment' and CDR a plist with
2633 `:value', `:begin', `:end', and `:post-blank' as keywords.
2635 Assume point is at the beginning of the latex fragment."
2649 ;; None found: it's a macro.
2658 :begin begin
2659 :end end
2663 "Interpret LATEX-FRAGMENT object as Org syntax.
2664 CONTENTS is nil."
2667 ;;;; Line Break
2670 "Parse line break at point.
2672 Return a list whose CAR is `line-break', and CDR a plist with
2673 `:begin', `:end' and `:post-blank' keywords.
2675 Assume point is at the beginning of the line break."
2679 "Interpret LINE-BREAK object as Org syntax.
2680 CONTENTS is nil."
2684 "Search for the next line-break object.
2686 LIMIT bounds the search.
2688 Return value is a cons cell whose CAR is `line-break' and CDR is
2689 beginning position."
2693 ;; A line break can only happen on a non-empty line.
2698 ;;;; Link
2701 "Parse link at point.
2703 Return a list whose CAR is `link' and CDR a plist with `:type',
2704 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2705 `:contents-end' and `:post-blank' as keywords.
2707 Assume point is at the beginning of the link."
2710 end contents-begin contents-end link-end post-blank path type
2711 raw-link link)
2713 ;; Type 1: Text targeted from a radio target.
2718 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2723 ;; RAW-LINK is the original link.
2728 ;; Determine TYPE of link and set PATH accordingly.
2730 ;; File type.
2733 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2736 ;; Id type: PATH is the id.
2739 ;; Code-ref type: PATH is the name of the reference.
2742 ;; Custom-id type: PATH is the name of the custom id.
2745 ;; Fuzzy type: Internal link either matches a target, an
2746 ;; headline name or nothing. PATH is the target or
2747 ;; headline's name.
2749 ;; Type 3: Plain link, i.e. http://orgmode.org
2755 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2762 ;; In any case, deduce end point after trailing white space from
2763 ;; LINK-END variable.
2768 :path path
2770 :begin begin
2771 :end end
2772 :contents-begin contents-begin
2773 :contents-end contents-end
2777 "Interpret LINK object as Org syntax.
2778 CONTENTS is the contents of the object, or nil."
2783 raw-link
2787 "Search for the next link object.
2789 LIMIT bounds the search.
2791 Return value is a cons cell whose CAR is `link' and CDR is
2792 beginning position."
2801 ;;;; Macro
2804 "Parse macro at point.
2806 Return a list whose CAR is `macro' and CDR a plist with `:key',
2807 `:args', `:begin', `:end', `:value' and `:post-blank' as
2808 keywords.
2810 Assume point is at the macro."
2824 ;; Repair bad splits.
2832 :value value
2833 :args args
2834 :begin begin
2835 :end end
2839 "Interpret MACRO object as Org syntax.
2840 CONTENTS is nil."
2844 "Search for the next macro object.
2846 LIMIT bounds the search.
2848 Return value is cons cell whose CAR is `macro' and CDR is
2849 beginning position."
2853 limit t)
2857 ;;;; Radio-target
2860 "Parse radio target at point.
2862 Return a list whose CAR is `radio-target' and CDR a plist with
2863 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2864 and `:post-blank' as keywords.
2866 Assume point is at the radio target."
2878 :end end
2879 :contents-begin contents-begin
2880 :contents-end contents-end
2881 :post-blank post-blank
2885 "Interpret TARGET object as Org syntax.
2886 CONTENTS is the contents of the object."
2890 "Search for the next radio-target object.
2892 LIMIT bounds the search.
2894 Return value is a cons cell whose CAR is `radio-target' and CDR
2895 is beginning position."
2901 ;;;; Statistics Cookie
2904 "Parse statistics cookie at point.
2906 Return a list whose CAR is `statistics-cookie', and CDR a plist
2907 with `:begin', `:end', `:value' and `:post-blank' keywords.
2909 Assume point is at the beginning of the statistics-cookie."
2920 :end end
2921 :value value
2925 "Interpret STATISTICS-COOKIE object as Org syntax.
2926 CONTENTS is nil."
2930 "Search for the next statistics cookie object.
2932 LIMIT bounds the search.
2934 Return value is a cons cell whose CAR is `statistics-cookie' and
2935 CDR is beginning position."
2941 ;;;; Strike-Through
2944 "Parse strike-through object at point.
2946 Return a list whose CAR is `strike-through' and CDR is a plist
2947 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2948 `:post-blank' keywords.
2950 Assume point is at the first plus sign marker."
2962 :end end
2963 :contents-begin contents-begin
2964 :contents-end contents-end
2968 "Interpret STRIKE-THROUGH object as Org syntax.
2969 CONTENTS is the contents of the object."
2973 ;;;; Subscript
2976 "Parse subscript at point.
2978 Return a list whose CAR is `subscript' and CDR a plist with
2979 `:begin', `:end', `:contents-begin', `:contents-end',
2980 `:use-brackets-p' and `:post-blank' as keywords.
2982 Assume point is at the underscore."
2986 t
2997 :end end
2998 :use-brackets-p bracketsp
2999 :contents-begin contents-begin
3000 :contents-end contents-end
3004 "Interpret SUBSCRIPT object as Org syntax.
3005 CONTENTS is the contents of the object."
3008 contents))
3011 "Search for the next sub/superscript object.
3013 LIMIT bounds the search.
3015 Return value is a cons cell whose CAR is either `subscript' or
3016 `superscript' and CDR is beginning position."
3023 ;;;; Superscript
3026 "Parse superscript at point.
3028 Return a list whose CAR is `superscript' and CDR a plist with
3029 `:begin', `:end', `:contents-begin', `:contents-end',
3030 `:use-brackets-p' and `:post-blank' as keywords.
3032 Assume point is at the caret."
3046 :end end
3047 :use-brackets-p bracketsp
3048 :contents-begin contents-begin
3049 :contents-end contents-end
3053 "Interpret SUPERSCRIPT object as Org syntax.
3054 CONTENTS is the contents of the object."
3057 contents))
3060 ;;;; Table Cell
3063 "Parse table cell at point.
3065 Return a list whose CAR is `table-cell' and CDR is a plist
3066 containing `:begin', `:end', `:contents-begin', `:contents-end'
3067 and `:post-blank' keywords."
3075 :end end
3076 :contents-begin contents-begin
3077 :contents-end contents-end
3081 "Interpret TABLE-CELL element as Org syntax.
3082 CONTENTS is the contents of the cell, or nil."
3086 "Search for the next table-cell object.
3088 LIMIT bounds the search.
3090 Return value is a cons cell whose CAR is `table-cell' and CDR is
3091 beginning position."
3095 ;;;; Target
3098 "Parse target at point.
3100 Return a list whose CAR is `target' and CDR a plist with
3101 `:begin', `:end', `:value' and `:post-blank' as keywords.
3103 Assume point is at the target."
3113 :end end
3114 :value value
3118 "Interpret TARGET object as Org syntax.
3119 CONTENTS is nil."
3123 "Search for the next target object.
3125 LIMIT bounds the search.
3127 Return value is a cons cell whose CAR is `target' and CDR is
3128 beginning position."
3134 ;;;; Timestamp
3137 "Parse time stamp at point.
3139 Return a list whose CAR is `timestamp', and CDR a plist with
3140 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3142 Assume point is at the beginning of the timestamp."
3161 :value main-value
3162 :range-end range-end
3163 :begin begin
3164 :end end
3168 "Interpret TIMESTAMP object as Org syntax.
3169 CONTENTS is nil."
3178 range-end)))))))
3181 "Search for the next timestamp object.
3183 LIMIT bounds the search.
3185 Return value is a cons cell whose CAR is `timestamp' and CDR is
3186 beginning position."
3194 limit t)
3198 ;;;; Underline
3201 "Parse underline object at point.
3203 Return a list whose CAR is `underline' and CDR is a plist with
3204 `:begin', `:end', `:contents-begin' and `:contents-end' and
3205 `:post-blank' keywords.
3207 Assume point is at the first underscore marker."
3219 :end end
3220 :contents-begin contents-begin
3221 :contents-end contents-end
3225 "Interpret UNDERLINE object as Org syntax.
3226 CONTENTS is the contents of the object."
3230 ;;;; Verbatim
3233 "Parse verbatim object at point.
3235 Return a list whose CAR is `verbatim' and CDR is a plist with
3236 `:value', `:begin', `:end' and `:post-blank' keywords.
3238 Assume point is at the first equal sign marker."
3249 :begin begin
3250 :end end
3254 "Interpret VERBATIM object as Org syntax.
3255 CONTENTS is nil."
3259 \f
3260 ;;; Parsing Element Starting At Point
3261 ;;
3262 ;; `org-element--current-element' is the core function of this section.
3263 ;; It returns the Lisp representation of the element starting at
3264 ;; point.
3265 ;;
3266 ;; `org-element--current-element' makes use of special modes. They
3267 ;; are activated for fixed element chaining (i.e. `plain-list' >
3268 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3269 ;; `section'). Special modes are: `first-section', `section',
3270 ;; `quote-section', `item' and `table-row'.
3274 "Parse the element starting at point.
3276 LIMIT bounds the search.
3278 Return value is a list like (TYPE PROPS) where TYPE is the type
3279 of the element and PROPS a plist of properties associated to the
3280 element.
3282 Possible types are defined in `org-element-all-elements'.
3284 Optional argument GRANULARITY determines the depth of the
3285 recursion. Allowed values are `headline', `greater-element',
3286 `element', `object' or nil. When it is broader than `object' (or
3287 nil), secondary values will not be parsed, since they only
3288 contain objects.
3290 Optional argument SPECIAL, when non-nil, can be either
3291 `first-section', `section', `quote-section', `table-row' and
3292 `item'.
3294 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3295 be computed.
3297 This function assumes point is always at the beginning of the
3298 element it has to parse."
3300 ;; If point is at an affiliated keyword, try moving to the
3301 ;; beginning of the associated element. If none is found, the
3302 ;; keyword is orphaned and will be treated as plain text.
3308 ;; Determine if parsing depth allows for secondary strings
3309 ;; parsing. It only applies to elements referenced in
3310 ;; `org-element-secondary-value-alist'.
3313 ;; Item.
3316 ;; Quote Section.
3318 ;; Table Row.
3320 ;; Headline.
3323 ;; Section (must be checked after headline).
3328 limit)))
3329 ;; Planning and Clock.
3334 ;; Inlinetask.
3337 ;; LaTeX Environment.
3343 nil t))
3346 ;; Drawer and Property Drawer.
3356 ;; Fixed Width
3359 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3360 ;; Keywords.
3369 org-element-block-name-alist)))
3384 ;; Footnote Definition.
3387 ;; Horizontal Rule.
3390 ;; Table.
3392 ;; List.
3395 ;; Default element: Paragraph.
3399 ;; Most elements can have affiliated keywords. When looking for an
3400 ;; element beginning, we want to move before them, as they belong to
3401 ;; that element, and, in the meantime, collect information they give
3402 ;; into appropriate properties. Hence the following function.
3403 ;;
3404 ;; Usage of optional arguments may not be obvious at first glance:
3405 ;;
3406 ;; - TRANS-LIST is used to polish keywords names that have evolved
3407 ;; during Org history. In example, even though =result= and
3408 ;; =results= coexist, we want to have them under the same =result=
3409 ;; property. It's also true for "srcname" and "name", where the
3410 ;; latter seems to be preferred nowadays (thus the "name" property).
3411 ;;
3412 ;; - CONSED allows to regroup multi-lines keywords under the same
3413 ;; property, while preserving their own identity. This is mostly
3414 ;; used for "attr_latex" and al.
3415 ;;
3416 ;; - PARSED prepares a keyword value for export. This is useful for
3417 ;; "caption". Objects restrictions for such keywords are defined in
3418 ;; `org-element-object-restrictions'.
3419 ;;
3420 ;; - DUALS is used to take care of keywords accepting a main and an
3421 ;; optional secondary values. For example "results" has its
3422 ;; source's name as the main value, and may have an hash string in
3423 ;; optional square brackets as the secondary one.
3424 ;;
3425 ;; A keyword may belong to more than one category.
3429 "Collect affiliated keywords before point.
3431 Optional argument KEY-RE is a regexp matching keywords, which
3432 puts matched keyword in group 1. It defaults to
3433 `org-element--affiliated-re'.
3435 TRANS-LIST is an alist where key is the keyword and value the
3436 property name it should be translated to, without the colons. It
3437 defaults to `org-element-keyword-translation-alist'.
3439 CONSED is a list of strings. Any keyword belonging to that list
3440 will have its value consed. The check is done after keyword
3441 translation. It defaults to `org-element-multiple-keywords'.
3443 PARSED is a list of strings. Any keyword member of this list
3444 will have its value parsed. The check is done after keyword
3445 translation. If a keyword is a member of both CONSED and PARSED,
3446 it's value will be a list of parsed strings. It defaults to
3447 `org-element-parsed-keywords'.
3449 DUALS is a list of strings. Any keyword member of this list can
3450 have two parts: one mandatory and one optional. Its value is
3451 a cons cell whose CAR is the former, and the CDR the latter. If
3452 a keyword is a member of both PARSED and DUALS, both values will
3453 be parsed. It defaults to `org-element-dual-keywords'.
3455 Return a list whose CAR is the position at the first of them and
3456 CDR a plist of keywords and values."
3464 ;; RESTRICT is the list of objects allowed in parsed
3465 ;; keywords value.
3467 output)
3471 ;; Apply translation to RAW-KWD. From there, KWD is
3472 ;; the official keyword.
3474 ;; Find main value for any keyword.
3480 ;; If KWD is a dual keyword, find its secondary
3481 ;; value. Maybe parse it.
3487 ;; Attribute a property name to KWD.
3489 ;; Now set final shape for VALUE.
3493 ;; VALUE is mandatory. Set it to nil if there is none.
3495 ;; Attributes are always consed.
3498 ;; Eventually store the new value in OUTPUT.
3504 \f
3505 ;;; The Org Parser
3506 ;;
3507 ;; The two major functions here are `org-element-parse-buffer', which
3508 ;; parses Org syntax inside the current buffer, taking into account
3509 ;; region, narrowing, or even visibility if specified, and
3510 ;; `org-element-parse-secondary-string', which parses objects within
3511 ;; a given string.
3512 ;;
3513 ;; The (almost) almighty `org-element-map' allows to apply a function
3514 ;; on elements or objects matching some type, and accumulate the
3515 ;; resulting values. In an export situation, it also skips unneeded
3516 ;; parts of the parse tree.
3519 "Recursively parse the buffer and return structure.
3520 If narrowing is in effect, only parse the visible part of the
3521 buffer.
3523 Optional argument GRANULARITY determines the depth of the
3524 recursion. It can be set to the following symbols:
3526 `headline' Only parse headlines.
3527 `greater-element' Don't recurse into greater elements excepted
3528 headlines and sections. Thus, elements
3529 parsed are the top-level ones.
3530 `element' Parse everything but objects and plain text.
3531 `object' Parse the complete buffer (default).
3533 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3534 elements.
3536 Assume buffer is in Org mode."
3542 ;; Start in `first-section' mode so text before the first
3543 ;; headline belongs to a section.
3547 "Recursively parse objects in STRING and return structure.
3549 RESTRICTION is a symbol limiting the object types that will be
3550 looked after.
3552 Optional argument PARENT, when non-nil, is the element or object
3553 containing the secondary string. It is used to set correctly
3554 `:parent' property within the string."
3560 secondary))))
3563 "Map a function on selected elements or objects.
3565 DATA is the parsed tree, as returned by, i.e,
3566 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3567 of elements or objects types. FUN is the function called on the
3568 matching element or object. It must accept one arguments: the
3569 element or object itself.
3571 When optional argument INFO is non-nil, it should be a plist
3572 holding export options. In that case, parts of the parse tree
3573 not exportable according to that property list will be skipped.
3575 When optional argument FIRST-MATCH is non-nil, stop at the first
3576 match for which FUN doesn't return nil, and return that value.
3578 Optional argument NO-RECURSION is a symbol or a list of symbols
3579 representing elements or objects types. `org-element-map' won't
3580 enter any recursive element or object whose type belongs to that
3581 list. Though, FUN can still be applied on them.
3583 Nil values returned from FUN do not appear in the results."
3584 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3587 ;; Recursion depth is determined by --CATEGORY.
3594 ;; If one object is found, the function
3595 ;; has to recurse into every object.
3598 ;; If one regular element is found, the
3599 ;; function has to recurse, at lest, into
3600 ;; every element it encounters.
3603 types)
3604 category)))
3605 --acc
3606 --walk-tree
3610 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3611 ;; holding contextual information.
3615 ;; Ignored element in an export context.
3617 ;; Secondary string: only objects can be found there.
3620 ;; Unconditionally enter parse trees.
3624 ;; Check if TYPE is matching among TYPES. If so,
3625 ;; apply FUN to --DATA and accumulate return value
3626 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3632 ;; If --DATA has a secondary string that can contain
3633 ;; objects with their type among TYPES, look into it.
3640 ;; Determine if a recursion into --DATA is possible.
3642 ;; --TYPE is explicitly removed from recursion.
3644 ;; --DATA has no contents.
3646 ;; Looking for greater elements but --DATA is simply
3647 ;; an element or an object.
3650 ;; Looking for elements but --DATA is an object.
3653 ;; In any other case, map contents.
3657 ;; Return value in a proper order.
3660 ;; The following functions are internal parts of the parser.
3661 ;;
3662 ;; The first one, `org-element--parse-elements' acts at the element's
3663 ;; level.
3664 ;;
3665 ;; The second one, `org-element--parse-objects' applies on all objects
3666 ;; of a paragraph or a secondary string. It uses
3667 ;; `org-element--get-next-object-candidates' to optimize the search of
3668 ;; the next object in the buffer.
3669 ;;
3670 ;; More precisely, that function looks for every allowed object type
3671 ;; first. Then, it discards failed searches, keeps further matches,
3672 ;; and searches again types matched behind point, for subsequent
3673 ;; calls. Thus, searching for a given type fails only once, and every
3674 ;; object is searched only once at top level (but sometimes more for
3675 ;; nested types).
3679 "Parse elements between BEG and END positions.
3681 SPECIAL prioritize some elements over the others. It can be set
3682 to `first-section', `quote-section', `section' `item' or
3683 `table-row'.
3685 When value is `item', STRUCTURE will be used as the current list
3686 structure.
3688 GRANULARITY determines the depth of the recursion. See
3689 `org-element-parse-buffer' for more information.
3691 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3692 elements.
3694 Elements are accumulated into ACC."
3697 ;; When parsing only headlines, skip any text before first one.
3700 ;; Main loop start.
3702 ;; Find current element's type and parse it accordingly to
3703 ;; its category.
3705 end granularity special structure))
3709 ;; Fill ELEMENT contents by side-effect.
3711 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3712 ;; no contents, don't modify it.
3715 ;; Greater element: parse it between `contents-begin' and
3716 ;; `contents-end'. Make sure GRANULARITY allows the
3717 ;; recursion, or ELEMENT is an headline, in which case going
3718 ;; inside is mandatory, in order to get sub-level headings.
3726 ;; Possibly switch to a special mode.
3734 granularity visible-only element))
3735 ;; ELEMENT has contents. Parse objects inside, if
3736 ;; GRANULARITY allows it.
3742 ;; Return result.
3743 acc))
3746 "Parse objects between BEG and END and return recursive structure.
3748 Objects are accumulated in ACC.
3750 RESTRICTION is a list of object types which are allowed in the
3751 current object."
3757 end restriction candidates)))
3764 ;; 1. Text before any object. Untabify it.
3769 acc
3773 ;; 2. Object...
3776 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3777 ;; a recursive type.
3782 cont-beg
3789 ;; 3. Text after last object. Untabify it.
3793 acc
3797 ;; Result.
3798 acc)))
3801 "Return an alist of candidates for the next object.
3803 LIMIT bounds the search, and RESTRICTION narrows candidates to
3804 some object types.
3806 Return value is an alist whose CAR is position and CDR the object
3807 type, as a symbol.
3809 OBJECTS is the previous candidates alist."
3811 ;; If no previous result, search every object type in RESTRICTION.
3812 ;; Otherwise, keep potential candidates (old objects located after
3813 ;; point) and ask to search again those which had matched before.
3818 objects))
3819 ;; Call the appropriate successor function for each type to search
3820 ;; and accumulate matches.
3827 type))))
3830 types-to-search)
3831 ;; Return alist.
3832 next-candidates))
3835 \f
3836 ;;; Towards A Bijective Process
3837 ;;
3838 ;; The parse tree obtained with `org-element-parse-buffer' is really
3839 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3840 ;; interpreted and expanded into a string with canonical Org syntax.
3841 ;; Hence `org-element-interpret-data'.
3842 ;;
3843 ;; The function relies internally on
3844 ;; `org-element--interpret-affiliated-keywords'.
3847 "Interpret DATA as Org syntax.
3849 DATA is a parse tree, an element, an object or a secondary string
3850 to interpret.
3852 Optional argument PARENT is used for recursive calls. It contains
3853 the element or object containing data, or nil.
3855 Return Org syntax as a string."
3859 ;; Secondary string.
3864 ;; Full Org document.
3869 ;; Plain text.
3871 ;; Element/Object without contents.
3874 data nil))
3875 ;; Element/Object with contents.
3885 ;; Elements directly containing objects must
3886 ;; have their indentation normalized first.
3888 data
3889 ;; When normalizing first paragraph of an
3890 ;; item or a footnote-definition, ignore
3891 ;; first line's indentation.
3898 data
3900 contents)))))))
3902 ;; Build white spaces. If no `:post-blank' property is
3903 ;; specified, assume its value is 0.
3913 "Return ELEMENT's affiliated keywords as Org syntax.
3914 If there is no affiliated keyword, return the empty string."
3924 ": "
3927 value)
3935 ;; All attribute keywords can have multiple lines.
3938 value
3941 ;; List all ELEMENT's properties matching an attribute line or an
3942 ;; affiliated keyword, but ignore translated keywords since they
3943 ;; cannot belong to the property list.
3950 org-element-keyword-translation-alist)))))
3951 collect prop)
3954 ;; Because interpretation of the parse tree must return the same
3955 ;; number of blank lines between elements and the same number of white
3956 ;; space after objects, some special care must be given to white
3957 ;; spaces.
3958 ;;
3959 ;; The first function, `org-element-normalize-string', ensures any
3960 ;; string different from the empty string will end with a single
3961 ;; newline character.
3962 ;;
3963 ;; The second function, `org-element-normalize-contents', removes
3964 ;; global indentation from the contents of the current element.
3967 "Ensure string S ends with a single newline character.
3969 If S isn't a string return it unchanged. If S is the empty
3970 string, return it. Otherwise, return a new string with a single
3971 newline character at its end."
3979 "Normalize plain text in ELEMENT's contents.
3981 ELEMENT must only contain plain text and objects.
3983 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3984 indentation to compute maximal common indentation.
3986 Return the normalized element that is element with global
3987 indentation removed from its contents. The function assumes that
3988 indentation is not done with TAB characters."
3990 collect-inds ; for byte-compiler
3993 ;; Return list of indentations within BLOB. This is done by
3994 ;; walking recursively BLOB and updating IND-LIST along the
3995 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3996 ;; been seen yet. It is required as this string is the only
3997 ;; one whose indentation doesn't happen after a newline
3998 ;; character.
4006 ;; An indentation of zero means no string will be
4007 ;; modified. Quit the process.
4013 ;; Avoid matching blank or empty lines.
4021 ;; Collect indentation list in ELEMENT. Possibly remove first
4022 ;; value if IGNORE-FIRST is non-nil.
4025 ;; Build ELEMENT back, replacing each string with the same
4026 ;; string minus common indentation.
4031 ;; Return BLOB with all its strings indentation
4032 ;; shortened from MCI white spaces. FIRST-FLAG is
4033 ;; non-nil when the first string hasn't been seen
4034 ;; yet.
4048 org-element-recursive-objects)
4052 blob))))
4056 \f
4057 ;;; The Toolbox
4058 ;;
4059 ;; The first move is to implement a way to obtain the smallest element
4060 ;; containing point. This is the job of `org-element-at-point'. It
4061 ;; basically jumps back to the beginning of section containing point
4062 ;; and moves, element after element, with
4063 ;; `org-element--current-element' until the container is found. Note:
4064 ;; When using `org-element-at-point', secondary values are never
4065 ;; parsed since the function focuses on elements, not on objects.
4066 ;;
4067 ;; At a deeper level, `org-element-context' lists all elements and
4068 ;; objects containing point.
4069 ;;
4070 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4071 ;; internally by navigation and manipulation tools.
4073 ;;;###autoload
4075 "Determine closest element around point.
4077 Return value is a list like (TYPE PROPS) where TYPE is the type
4078 of the element and PROPS a plist of properties associated to the
4079 element.
4081 Possible types are defined in `org-element-all-elements'.
4082 Properties depend on element or object type, but always
4083 include :begin, :end, :parent and :post-blank properties.
4085 As a special case, if point is at the very beginning of a list or
4086 sub-list, returned element will be that list instead of the first
4087 item. In the same way, if point is at the beginning of the first
4088 row of a table, returned element will be the table instead of the
4089 first row.
4091 If optional argument KEEP-TRAIL is non-nil, the function returns
4092 a list of of elements leading to element at point. The list's
4093 CAR is always the element at point. Following positions contain
4094 element's siblings, then parents, siblings of parents, until the
4095 first element of current section."
4097 ;; If at an headline, parse it. It is the sole element that
4098 ;; doesn't require to know about context. Be sure to disallow
4099 ;; secondary string parsing, though.
4105 ;; Otherwise move at the beginning of the section containing
4106 ;; point.
4110 element type special-flag trail struct prevs parent)
4118 ;; Parse successively each element, skipping those ending
4119 ;; before original position.
4128 ;; 1. Skip any element ending before point. Also skip
4129 ;; element ending at point when we're sure that another
4130 ;; element has started.
4135 ;; 2. An element containing point is always the element at
4136 ;; point.
4139 ;; 3. At any other greater element type, if point is
4140 ;; within contents, move into it.
4145 ;; Create an anchor for tables and plain lists:
4146 ;; when point is at the very beginning of these
4147 ;; elements, ignoring affiliated keywords,
4148 ;; target them instead of their contents.
4150 ;; When point is at contents end, do not move
4151 ;; into elements with an explicit ending, but
4152 ;; return that element instead.
4156 drawer dynamic-block inlinetask item
4157 plain-list quote-block special-block))))
4170 "Return closest element or object around point.
4172 Return value is a list like (TYPE PROPS) where TYPE is the type
4173 of the element or object and PROPS a plist of properties
4174 associated to it.
4176 Possible types are defined in `org-element-all-elements' and
4177 `org-element-all-objects'. Properties depend on element or
4178 object type, but always include :begin, :end, :parent
4179 and :post-blank properties."
4184 end)
4185 ;; Check if point is inside an element containing objects or at
4186 ;; a secondary string. In that case, move to beginning of the
4187 ;; element or secondary string and set END to the other side.
4196 (<= origin
4197 ;; `1+' is required so some
4198 ;; successors can match
4199 ;; properly their object.
4213 element
4216 candidates)
4219 end restriction candidates))
4221 candidates)))
4222 ;; If ORIGIN is before next object in element, there's
4223 ;; no point in looking further.
4232 ;; ORIGIN is after OBJECT, so skip it.
4235 ;; ORIGIN is within a non-recursive object or at an
4236 ;; object boundaries: Return that object.
4240 ;; Otherwise, move within current object and restrict
4241 ;; search to the end of its contents.
4245 parent))))))
4248 "Non-nil when elements ELEM-A and ELEM-B are nested."
4257 "Swap elements ELEM-A and ELEM-B.
4258 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4259 end of ELEM-A."
4261 ;; There are two special cases when an element doesn't start at bol:
4262 ;; the first paragraph in an item or in a footnote definition.
4264 ;; Only a paragraph without any affiliated keyword can be moved at
4265 ;; ELEM-A position in such a situation. Note that the case of
4266 ;; a footnote definition is impossible: it cannot contain two
4267 ;; paragraphs in a row because it cannot contain a blank line.
4273 ;; In a special situation, ELEM-A will have no indentation. We'll
4274 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4288 ;; Store overlays responsible for visibility status. We
4289 ;; also need to store their boundaries as they will be
4290 ;; removed from buffer.
4297 ;; Get contents.
4305 ;; Restore ex ELEM-A overlays.
4314 ;; Restore ex ELEM-B overlays.
4323 ;;; org-element.el ends here