| blob | 5aa9a01bf1c3d936f96b9551adc3e0d541128204 |
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 file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. 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-elements' 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 ;; Since OLD is going to be changed into NEW by side-effect, first
397 ;; make sure that every element or object within NEW has OLD as
398 ;; parent.
401 ;; Transfer contents.
403 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
404 ;; with NEW's.
407 ;; Transfer type.
411 "Append elements to the contents of another element.
413 PARENT is an element or object. CHILDREN can be elements,
414 objects, or a strings.
416 The function takes care of setting `:parent' property for CHILD.
417 Return parent element."
419 ;; Link every child to PARENT.
423 children)
424 ;; Add CHILDREN at the end of PARENT contents.
426 parent
428 ;; Return modified PARENT element.
429 parent))
432 \f
433 ;;; Greater elements
434 ;;
435 ;; For each greater element type, we define a parser and an
436 ;; interpreter.
437 ;;
438 ;; A parser returns the element or object as the list described above.
439 ;; Most of them accepts no argument. Though, exceptions exist. Hence
440 ;; every element containing a secondary string (see
441 ;; `org-element-secondary-value-alist') will accept an optional
442 ;; argument to toggle parsing of that secondary string. Moreover,
443 ;; `item' parser requires current list's structure as its first
444 ;; element.
445 ;;
446 ;; An interpreter accepts two arguments: the list representation of
447 ;; the element or object, and its contents. The latter may be nil,
448 ;; depending on the element or object considered. It returns the
449 ;; appropriate Org syntax, as a string.
450 ;;
451 ;; Parsing functions must follow the naming convention:
452 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
453 ;; defined in `org-element-greater-elements'.
454 ;;
455 ;; Similarly, interpreting functions must follow the naming
456 ;; convention: org-element-TYPE-interpreter.
457 ;;
458 ;; With the exception of `headline' and `item' types, greater elements
459 ;; cannot contain other greater elements of their own type.
460 ;;
461 ;; Beside implementing a parser and an interpreter, adding a new
462 ;; greater element requires to tweak `org-element--current-element'.
463 ;; Moreover, the newly defined type must be added to both
464 ;; `org-element-all-elements' and `org-element-greater-elements'.
467 ;;;; Center Block
470 "Parse a center block.
472 LIMIT bounds the search.
474 Return a list whose CAR is `center-block' and CDR is a plist
475 containing `:begin', `:end', `:hiddenp', `:contents-begin',
476 `:contents-end' and `:post-blank' keywords.
478 Assume point is at the beginning of the block."
482 ;; Incomplete block: parse it as a paragraph.
487 ;; Empty blocks have no contents.
501 :end end
502 :hiddenp hidden
503 :contents-begin contents-begin
504 :contents-end contents-end
509 "Interpret CENTER-BLOCK element as Org syntax.
510 CONTENTS is the contents of the element."
514 ;;;; Drawer
517 "Parse a drawer.
519 LIMIT bounds the search.
521 Return a list whose CAR is `drawer' and CDR is a plist containing
522 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
523 `:contents-end' and `:post-blank' keywords.
525 Assume point is at beginning of drawer."
528 ;; Incomplete drawer: parse it as a paragraph.
537 ;; Empty drawers have no contents.
551 :end end
552 :drawer-name name
553 :hiddenp hidden
554 :contents-begin contents-begin
555 :contents-end contents-end
560 "Interpret DRAWER element as Org syntax.
561 CONTENTS is the contents of the element."
564 contents))
567 ;;;; Dynamic Block
570 "Parse a dynamic block.
572 LIMIT bounds the search.
574 Return a list whose CAR is `dynamic-block' and CDR is a plist
575 containing `:block-name', `:begin', `:end', `:hiddenp',
576 `:contents-begin', `:contents-end', `:arguments' and
577 `:post-blank' keywords.
579 Assume point is at beginning of dynamic block."
582 ;; Incomplete block: parse it as a paragraph.
591 ;; Empty blocks have no contents.
605 :end end
606 :block-name name
607 :arguments arguments
608 :hiddenp hidden
609 :contents-begin contents-begin
610 :contents-end contents-end
615 "Interpret DYNAMIC-BLOCK element as Org syntax.
616 CONTENTS is the contents of the element."
621 contents))
624 ;;;; Footnote Definition
627 "Parse a footnote definition.
629 LIMIT bounds the search.
631 Return a list whose CAR is `footnote-definition' and CDR is
632 a plist containing `:label', `:begin' `:end', `:contents-begin',
633 `:contents-end' and `:post-blank' keywords.
635 Assume point is at the beginning of the footnote definition."
660 :begin begin
661 :end end
662 :contents-begin contents-begin
663 :contents-end contents-end
668 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
669 CONTENTS is the contents of the footnote-definition."
671 " "
672 contents))
675 ;;;; Headline
678 "Parse an headline.
680 Return a list whose CAR is `headline' and CDR is a plist
681 containing `:raw-value', `:title', `:begin', `:end',
682 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
683 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
684 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
685 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
686 keywords.
688 The plist also contains any property set in the property drawer,
689 with its name in lowercase, the underscores replaced with hyphens
690 and colons at the beginning (i.e. `:custom-id').
692 When RAW-SECONDARY-P is non-nil, headline's title will not be
693 parsed as a secondary string, but as a plain string instead.
695 Assume point is at beginning of the headline."
714 ;; Normalize property names: ":SOME_PROP:" becomes
715 ;; ":some-prop".
727 plist))
745 ;; Clean RAW-VALUE from any quote or comment string.
750 ""
751 raw-value)))
752 ;; Clean TAGS from archive tag, if any.
758 :begin begin
759 :end end
760 :pre-blank
763 :hiddenp hidden
764 :contents-begin contents-begin
765 :contents-end contents-end
766 :level level
768 :tags tags
769 :todo-keyword todo
770 :todo-type todo-type
771 :scheduled scheduled
772 :deadline deadline
773 :timestamp timestamp
774 :clock clock
780 end)
781 :footnote-section-p footnote-section-p
782 :archivedp archivedp
783 :commentedp commentedp
785 standard-props))))
787 headline :title
793 "Interpret HEADLINE element as Org syntax.
794 CONTENTS is the contents of the element."
821 ;; Align tags.
829 ? )
830 tags))
834 tags))))
836 contents)))
839 ;;;; Inlinetask
842 "Parse an inline task.
844 Return a list whose CAR is `inlinetask' and CDR is a plist
845 containing `:title', `:begin', `:end', `:hiddenp',
846 `:contents-begin' and `:contents-end', `:level', `:priority',
847 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
848 `:scheduled', `:deadline', `:timestamp', `:clock' and
849 `:post-blank' keywords.
851 The plist also contains any property set in the property drawer,
852 with its name in lowercase, the underscores replaced with hyphens
853 and colons at the beginning (i.e. `:custom-id').
855 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
856 title will not be parsed as a secondary string, but as a plain
857 string instead.
859 Assume point is at beginning of the inline task."
870 ;; Normalize property names: ":SOME_PROP:" becomes
871 ;; ":some-prop".
883 plist))
907 :begin begin
908 :end end
909 :hiddenp hidden
910 :contents-begin contents-begin
911 :contents-end contents-end
914 :tags tags
915 :todo-keyword todo
916 :todo-type todo-type
917 :scheduled scheduled
918 :deadline deadline
919 :timestamp timestamp
920 :clock clock
922 standard-props
925 inlinetask :title
928 raw-value
930 inlinetask))))))
933 "Interpret INLINETASK element as Org syntax.
934 CONTENTS is the contents of inlinetask."
949 ;; Align tags.
957 ? )
958 tags))
962 tags))))
963 ;; Prefer degenerate inlinetasks when there are no
964 ;; contents.
967 contents
971 ;;;; Item
974 "Parse an item.
976 STRUCT is the structure of the plain list.
978 Return a list whose CAR is `item' and CDR is a plist containing
979 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
980 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
981 `:post-blank' keywords.
983 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
984 any, will not be parsed as a secondary string, but as a plain
985 string instead.
987 Assume point is at the beginning of the item."
1011 ;; Ignore tags in un-ordered lists: they are just
1012 ;; a part of item's body.
1018 ;; If first line isn't empty, contents really start
1019 ;; at the text after item's meta-data.
1030 :begin begin
1031 :end end
1032 ;; CONTENTS-BEGIN and CONTENTS-END may be
1033 ;; mixed up in the case of an empty item
1034 ;; separated from the next by a blank line.
1035 ;; Thus ensure the former is always the
1036 ;; smallest.
1039 :checkbox checkbox
1040 :counter counter
1041 :hiddenp hidden
1042 :structure struct
1045 item :tag
1053 "Interpret ITEM element as Org syntax.
1054 CONTENTS is the contents of the element."
1060 ;; Compute indentation.
1065 ;; Indent contents.
1067 bullet
1080 ;;;; Plain List
1083 "Parse a plain list.
1085 Optional argument STRUCTURE, when non-nil, is the structure of
1086 the plain list being parsed.
1088 Return a list whose CAR is `plain-list' and CDR is a plist
1089 containing `:type', `:begin', `:end', `:contents-begin' and
1090 `:contents-end', `:structure' and `:post-blank' keywords.
1092 Assume point is at the beginning of the list."
1107 ;; Return value.
1111 :begin begin
1112 :end end
1113 :contents-begin contents-begin
1114 :contents-end contents-end
1115 :structure struct
1120 "Interpret PLAIN-LIST element as Org syntax.
1121 CONTENTS is the contents of the element."
1129 ;;;; Quote Block
1132 "Parse a quote block.
1134 LIMIT bounds the search.
1136 Return a list whose CAR is `quote-block' and CDR is a plist
1137 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1138 `:contents-end' and `:post-blank' keywords.
1140 Assume point is at the beginning of the block."
1144 ;; Incomplete block: parse it as a paragraph.
1150 ;; Empty blocks have no contents.
1164 :end end
1165 :hiddenp hidden
1166 :contents-begin contents-begin
1167 :contents-end contents-end
1172 "Interpret QUOTE-BLOCK element as Org syntax.
1173 CONTENTS is the contents of the element."
1177 ;;;; Section
1180 "Parse a section.
1182 LIMIT bounds the search.
1184 Return a list whose CAR is `section' and CDR is a plist
1185 containing `:begin', `:end', `:contents-begin', `contents-end'
1186 and `:post-blank' keywords."
1188 ;; Beginning of section is the beginning of the first non-blank
1189 ;; line after previous headline.
1198 :end end
1199 :contents-begin begin
1200 :contents-end pos-before-blank
1204 "Interpret SECTION element as Org syntax.
1205 CONTENTS is the contents of the element."
1206 contents)
1209 ;;;; Special Block
1212 "Parse a special block.
1214 LIMIT bounds the search.
1216 Return a list whose CAR is `special-block' and CDR is a plist
1217 containing `:type', `:begin', `:end', `:hiddenp',
1218 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1220 Assume point is at the beginning of the block."
1226 ;; Incomplete block: parse it as a paragraph.
1232 ;; Empty blocks have no contents.
1246 :begin begin
1247 :end end
1248 :hiddenp hidden
1249 :contents-begin contents-begin
1250 :contents-end contents-end
1255 "Interpret SPECIAL-BLOCK element as Org syntax.
1256 CONTENTS is the contents of the element."
1261 \f
1262 ;;; Elements
1263 ;;
1264 ;; For each element, a parser and an interpreter are also defined.
1265 ;; Both follow the same naming convention used for greater elements.
1266 ;;
1267 ;; Also, as for greater elements, adding a new element type is done
1268 ;; through the following steps: implement a parser and an interpreter,
1269 ;; tweak `org-element--current-element' so that it recognizes the new
1270 ;; type and add that new type to `org-element-all-elements'.
1271 ;;
1272 ;; As a special case, when the newly defined type is a block type,
1273 ;; `org-element-block-name-alist' has to be modified accordingly.
1276 ;;;; Babel Call
1279 "Parse a babel call.
1281 LIMIT bounds the search.
1283 Return a list whose CAR is `babel-call' and CDR is a plist
1284 containing `:begin', `:end', `:info' and `:post-blank' as
1285 keywords."
1296 :end end
1297 :info info
1301 "Interpret BABEL-CALL element as Org syntax.
1302 CONTENTS is nil."
1308 ;; Remove redundant square brackets.
1313 ;;;; Clock
1316 "Parse a clock.
1318 LIMIT bounds the search.
1320 Return a list whose CAR is `clock' and CDR is a plist containing
1321 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1322 as keywords."
1341 :value value
1342 :time time
1343 :begin begin
1344 :end end
1348 "Interpret CLOCK element as Org syntax.
1349 CONTENTS is nil."
1356 "%2s:%02s"
1360 ;;;; Comment
1363 "Parse a comment.
1365 LIMIT bounds the search.
1367 Return a list whose CAR is `comment' and CDR is a plist
1368 containing `:begin', `:end', `:value' and `:post-blank'
1369 keywords.
1371 Assume point is at comment beginning."
1380 ;; Get comments ending.
1383 ;; Accumulate lines without leading hash and first
1384 ;; whitespace.
1398 :end end
1399 :value value
1404 "Interpret COMMENT element as Org syntax.
1405 CONTENTS is nil."
1409 ;;;; Comment Block
1412 "Parse an export block.
1414 LIMIT bounds the search.
1416 Return a list whose CAR is `comment-block' and CDR is a plist
1417 containing `:begin', `:end', `:hiddenp', `:value' and
1418 `:post-blank' keywords.
1420 Assume point is at comment block beginning."
1424 ;; Incomplete block: parse it as a paragraph.
1438 contents-begin contents-end)))
1442 :end end
1443 :value value
1444 :hiddenp hidden
1449 "Interpret COMMENT-BLOCK element as Org syntax.
1450 CONTENTS is nil."
1455 ;;;; Example Block
1458 "Parse an example block.
1460 LIMIT bounds the search.
1462 Return a list whose CAR is `example-block' and CDR is a plist
1463 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1464 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1465 `:switches', `:value' and `:post-blank' keywords."
1469 ;; Incomplete block: parse it as a paragraph.
1476 ;; Switches analysis
1481 ;; Should labels be retained in (or stripped from) example
1482 ;; blocks?
1487 ;; What should code-references use - labels or
1488 ;; line-numbers?
1495 ;; Standard block parsing.
1509 :end end
1510 :value value
1511 :switches switches
1512 :number-lines number-lines
1513 :preserve-indent preserve-indent
1514 :retain-labels retain-labels
1515 :use-labels use-labels
1516 :label-fmt label-fmt
1517 :hiddenp hidden
1522 "Interpret EXAMPLE-BLOCK element as Org syntax.
1523 CONTENTS is nil."
1531 ;;;; Export Block
1534 "Parse an export block.
1536 LIMIT bounds the search.
1538 Return a list whose CAR is `export-block' and CDR is a plist
1539 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1540 `:post-blank' keywords.
1542 Assume point is at export-block beginning."
1548 ;; Incomplete block: parse it as a paragraph.
1562 contents-end)))
1566 :end end
1567 :type type
1568 :value value
1569 :hiddenp hidden
1574 "Interpret EXPORT-BLOCK element as Org syntax.
1575 CONTENTS is nil."
1582 ;;;; Fixed-width
1585 "Parse a fixed-width section.
1587 LIMIT bounds the search.
1589 Return a list whose CAR is `fixed-width' and CDR is a plist
1590 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1592 Assume point is at the beginning of the fixed-width area."
1596 value
1601 ;; Accumulate text without starting colons.
1614 :end end
1615 :value value
1620 "Interpret FIXED-WIDTH element as Org syntax.
1621 CONTENTS is nil."
1626 ;;;; Horizontal Rule
1629 "Parse an horizontal rule.
1631 LIMIT bounds the search.
1633 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1634 containing `:begin', `:end' and `:post-blank' keywords."
1644 :end end
1649 "Interpret HORIZONTAL-RULE element as Org syntax.
1650 CONTENTS is nil."
1654 ;;;; Keyword
1657 "Parse a keyword at point.
1659 LIMIT bounds the search.
1661 Return a list whose CAR is `keyword' and CDR is a plist
1662 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1663 keywords."
1676 :value value
1677 :begin begin
1678 :end end
1682 "Interpret KEYWORD element as Org syntax.
1683 CONTENTS is nil."
1689 ;;;; Latex Environment
1692 "Parse a LaTeX environment.
1694 LIMIT bounds the search.
1696 Return a list whose CAR is `latex-environment' and CDR is a plist
1697 containing `:begin', `:end', `:value' and `:post-blank'
1698 keywords.
1700 Assume point is at the beginning of the latex environment."
1718 :end end
1719 :value value
1724 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1725 CONTENTS is nil."
1729 ;;;; Paragraph
1732 "Parse a paragraph.
1734 LIMIT bounds the search.
1736 Return a list whose CAR is `paragraph' and CDR is a plist
1737 containing `:begin', `:end', `:contents-begin' and
1738 `:contents-end' and `:post-blank' keywords.
1740 Assume point is at the beginning of the paragraph."
1743 ;; beginning of an item or a footnote reference. In that
1744 ;; case, we mustn't look for affiliated keywords since they
1745 ;; belong to the container.
1757 ;; Skip non-existent or incomplete drawer.
1765 ;; Stop at comments.
1769 ;; Skip incomplete dynamic blocks.
1776 ;; Skip incomplete blocks.
1784 limit t))))
1785 ;; Skip incomplete latex environments.
1793 limit t))))
1794 ;; Skip ill-formed keywords.
1808 :end end
1809 :contents-begin contents-begin
1810 :contents-end contents-end
1815 "Interpret PARAGRAPH element as Org syntax.
1816 CONTENTS is the contents of the element."
1817 contents)
1820 ;;;; Planning
1823 "Parse a planning.
1825 LIMIT bounds the search.
1827 Return a list whose CAR is `planning' and CDR is a plist
1828 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1829 and `:post-blank' keywords."
1838 closed deadline scheduled)
1852 :deadline deadline
1853 :scheduled scheduled
1854 :begin begin
1855 :end end
1859 "Interpret PLANNING element as Org syntax.
1860 CONTENTS is nil."
1862 'identity
1874 ;;;; Property Drawer
1877 "Parse a property drawer.
1879 LIMIT bounds the search.
1881 Return a list whose CAR is `property-drawer' and CDR is a plist
1882 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1883 `:contents-end', `:properties' and `:post-blank' keywords.
1885 Assume point is at the beginning of the property drawer."
1899 val))
1901 val))
1909 :end end
1910 :hiddenp hidden
1911 :properties properties
1915 "Interpret PROPERTY-DRAWER element as Org syntax.
1916 CONTENTS is nil."
1926 ;;;; Quote Section
1929 "Parse a quote section.
1931 LIMIT bounds the search.
1933 Return a list whose CAR is `quote-section' and CDR is a plist
1934 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1936 Assume point is at beginning of the section."
1947 :end end
1948 :value value
1952 "Interpret QUOTE-SECTION element as Org syntax.
1953 CONTENTS is nil."
1957 ;;;; Src Block
1960 "Parse a src block.
1962 LIMIT bounds the search.
1964 Return a list whose CAR is `src-block' and CDR is a plist
1965 containing `:language', `:switches', `:parameters', `:begin',
1966 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1967 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1968 `:post-blank' keywords.
1970 Assume point is at the beginning of the block."
1973 ;; Incomplete block: parse it as a paragraph.
1978 ;; Get beginning position.
1980 ;; Get language as a string.
1989 ;; Get switches.
1991 ;; Get parameters.
1993 ;; Switches analysis
2001 ;; Should labels be retained in (or stripped from)
2002 ;; src blocks?
2007 ;; What should code-references use - labels or
2008 ;; line-numbers?
2012 ;; Get visibility status.
2014 ;; Retrieve code.
2019 ;; Get position after ending blank lines.
2029 :begin begin
2030 :end end
2031 :number-lines number-lines
2032 :preserve-indent preserve-indent
2033 :retain-labels retain-labels
2034 :use-labels use-labels
2035 :label-fmt label-fmt
2036 :hiddenp hidden
2037 :value value
2042 "Interpret SRC-BLOCK element as Org syntax.
2043 CONTENTS is nil."
2063 value
2067 ;;;; Table
2070 "Parse a table at point.
2072 LIMIT bounds the search.
2074 Return a list whose CAR is `table' and CDR is a plist containing
2075 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2076 `:contents-end', `:value' and `:post-blank' keywords.
2078 Assume point is at the beginning of the table."
2090 acc))
2097 :end end
2098 :type type
2099 :tblfm tblfm
2100 ;; Only `org' tables have contents. `table.el' tables
2101 ;; use a `:value' property to store raw table as
2102 ;; a string.
2107 table-begin table-end))
2112 "Interpret TABLE element as Org syntax.
2113 CONTENTS is nil."
2124 ;;;; Table Row
2127 "Parse table row at point.
2129 LIMIT bounds the search.
2131 Return a list whose CAR is `table-row' and CDR is a plist
2132 containing `:begin', `:end', `:contents-begin', `:contents-end',
2133 `:type' and `:post-blank' keywords."
2137 ;; A table rule has no contents. In that case, ensure
2138 ;; CONTENTS-BEGIN matches CONTENTS-END.
2150 :begin begin
2151 :end end
2152 :contents-begin contents-begin
2153 :contents-end contents-end
2157 "Interpret TABLE-ROW element as Org syntax.
2158 CONTENTS is the contents of the table row."
2163 ;;;; Verse Block
2166 "Parse a verse block.
2168 LIMIT bounds the search.
2170 Return a list whose CAR is `verse-block' and CDR is a plist
2171 containing `:begin', `:end', `:contents-begin', `:contents-end',
2172 `:hiddenp' and `:post-blank' keywords.
2174 Assume point is at beginning of the block."
2178 ;; Incomplete block: parse it as a paragraph.
2194 :end end
2195 :contents-begin contents-begin
2196 :contents-end contents-end
2197 :hiddenp hidden
2202 "Interpret VERSE-BLOCK element as Org syntax.
2203 CONTENTS is verse block contents."
2207 \f
2208 ;;; Objects
2209 ;;
2210 ;; Unlike to elements, interstices can be found between objects.
2211 ;; That's why, along with the parser, successor functions are provided
2212 ;; for each object. Some objects share the same successor (i.e. `code'
2213 ;; and `verbatim' objects).
2214 ;;
2215 ;; A successor must accept a single argument bounding the search. It
2216 ;; will return either a cons cell whose CAR is the object's type, as
2217 ;; a symbol, and CDR the position of its next occurrence, or nil.
2218 ;;
2219 ;; Successors follow the naming convention:
2220 ;; org-element-NAME-successor, where NAME is the name of the
2221 ;; successor, as defined in `org-element-all-successors'.
2222 ;;
2223 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2224 ;; object types they can contain will be specified in
2225 ;; `org-element-object-restrictions'.
2226 ;;
2227 ;; Adding a new type of object is simple. Implement a successor,
2228 ;; a parser, and an interpreter for it, all following the naming
2229 ;; convention. Register type in `org-element-all-objects' and
2230 ;; successor in `org-element-all-successors'. Maybe tweak
2231 ;; restrictions about it, and that's it.
2234 ;;;; Bold
2237 "Parse bold object at point.
2239 Return a list whose CAR is `bold' and CDR is a plist with
2240 `:begin', `:end', `:contents-begin' and `:contents-end' and
2241 `:post-blank' keywords.
2243 Assume point is at the first star marker."
2255 :end end
2256 :contents-begin contents-begin
2257 :contents-end contents-end
2261 "Interpret BOLD object as Org syntax.
2262 CONTENTS is the contents of the object."
2266 "Search for the next text-markup object.
2268 LIMIT bounds the search.
2270 Return value is a cons cell whose CAR is a symbol among `bold',
2271 `italic', `underline', `strike-through', `code' and `verbatim'
2272 and CDR is beginning position."
2288 ;;;; Code
2291 "Parse code object at point.
2293 Return a list whose CAR is `code' and CDR is a plist with
2294 `:value', `:begin', `:end' and `:post-blank' keywords.
2296 Assume point is at the first tilde marker."
2307 :begin begin
2308 :end end
2312 "Interpret CODE object as Org syntax.
2313 CONTENTS is nil."
2317 ;;;; Entity
2320 "Parse entity at point.
2322 Return a list whose CAR is `entity' and CDR a plist with
2323 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2324 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2325 keywords.
2327 Assume point is at the beginning of the entity."
2329 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2345 :begin begin
2346 :end end
2347 :use-brackets-p bracketsp
2351 "Interpret ENTITY object as Org syntax.
2352 CONTENTS is nil."
2358 "Search for the next latex-fragment or entity object.
2360 LIMIT bounds the search.
2362 Return value is a cons cell whose CAR is `entity' or
2363 `latex-fragment' and CDR is beginning position."
2367 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2374 limit t)
2377 ;; Determine if it's a real entity or a LaTeX command.
2380 ;; No entity nor command: point is at a LaTeX fragment.
2381 ;; Determine its type to get the correct beginning position.
2389 matchers)
2393 ;;;; Export Snippet
2396 "Parse export snippet at point.
2398 Return a list whose CAR is `export-snippet' and CDR a plist with
2399 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2400 keywords.
2402 Assume point is at the beginning of the snippet."
2414 :value value
2415 :begin begin
2416 :end end
2420 "Interpret EXPORT-SNIPPET object as Org syntax.
2421 CONTENTS is nil."
2427 "Search for the next export-snippet object.
2429 LIMIT bounds the search.
2431 Return value is a cons cell whose CAR is `export-snippet' and CDR
2432 its beginning position."
2441 ;;;; Footnote Reference
2444 "Parse footnote reference at point.
2446 Return a list whose CAR is `footnote-reference' and CDR a plist
2447 with `:label', `:type', `:inline-definition', `:begin', `:end'
2448 and `:post-blank' as keywords."
2470 :type type
2471 :begin begin
2472 :end end
2475 footnote-reference :inline-definition
2480 footnote-reference))))))
2483 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2484 CONTENTS is nil."
2494 "Search for the next footnote-reference object.
2496 LIMIT bounds the search.
2498 Return value is a cons cell whose CAR is `footnote-reference' and
2499 CDR is beginning position."
2513 ;;;; Inline Babel Call
2516 "Parse inline babel call at point.
2518 Return a list whose CAR is `inline-babel-call' and CDR a plist
2519 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2521 Assume point is at the beginning of the babel call."
2532 :end end
2533 :info info
2537 "Interpret INLINE-BABEL-CALL object as Org syntax.
2538 CONTENTS is nil."
2544 ;; Remove redundant square brackets.
2547 main-source)
2551 "Search for the next inline-babel-call object.
2553 LIMIT bounds the search.
2555 Return value is a cons cell whose CAR is `inline-babel-call' and
2556 CDR is beginning position."
2558 ;; Use a simplified version of
2559 ;; `org-babel-inline-lob-one-liner-regexp'.
2562 limit t)
2566 ;;;; Inline Src Block
2569 "Parse inline source block at point.
2571 LIMIT bounds the search.
2573 Return a list whose CAR is `inline-src-block' and CDR a plist
2574 with `:begin', `:end', `:language', `:value', `:parameters' and
2575 `:post-blank' as keywords.
2577 Assume point is at the beginning of the inline src block."
2590 :value value
2591 :parameters parameters
2592 :begin begin
2593 :end end
2597 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2598 CONTENTS is nil."
2603 language
2605 body)))
2608 "Search for the next inline-babel-call element.
2610 LIMIT bounds the search.
2612 Return value is a cons cell whose CAR is `inline-babel-call' and
2613 CDR is beginning position."
2619 ;;;; Italic
2622 "Parse italic object at point.
2624 Return a list whose CAR is `italic' and CDR is a plist with
2625 `:begin', `:end', `:contents-begin' and `:contents-end' and
2626 `:post-blank' keywords.
2628 Assume point is at the first slash marker."
2640 :end end
2641 :contents-begin contents-begin
2642 :contents-end contents-end
2646 "Interpret ITALIC object as Org syntax.
2647 CONTENTS is the contents of the object."
2651 ;;;; Latex Fragment
2654 "Parse latex fragment at point.
2656 Return a list whose CAR is `latex-fragment' and CDR a plist with
2657 `:value', `:begin', `:end', and `:post-blank' as keywords.
2659 Assume point is at the beginning of the latex fragment."
2673 ;; None found: it's a macro.
2682 :begin begin
2683 :end end
2687 "Interpret LATEX-FRAGMENT object as Org syntax.
2688 CONTENTS is nil."
2691 ;;;; Line Break
2694 "Parse line break at point.
2696 Return a list whose CAR is `line-break', and CDR a plist with
2697 `:begin', `:end' and `:post-blank' keywords.
2699 Assume point is at the beginning of the line break."
2703 "Interpret LINE-BREAK object as Org syntax.
2704 CONTENTS is nil."
2708 "Search for the next line-break object.
2710 LIMIT bounds the search.
2712 Return value is a cons cell whose CAR is `line-break' and CDR is
2713 beginning position."
2717 ;; A line break can only happen on a non-empty line.
2722 ;;;; Link
2725 "Parse link at point.
2727 Return a list whose CAR is `link' and CDR a plist with `:type',
2728 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2729 `:contents-end' and `:post-blank' as keywords.
2731 Assume point is at the beginning of the link."
2734 end contents-begin contents-end link-end post-blank path type
2735 raw-link link)
2737 ;; Type 1: Text targeted from a radio target.
2742 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2747 ;; RAW-LINK is the original link.
2752 ;; Determine TYPE of link and set PATH accordingly.
2754 ;; File type.
2757 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2760 ;; Id type: PATH is the id.
2763 ;; Code-ref type: PATH is the name of the reference.
2766 ;; Custom-id type: PATH is the name of the custom id.
2769 ;; Fuzzy type: Internal link either matches a target, an
2770 ;; headline name or nothing. PATH is the target or
2771 ;; headline's name.
2773 ;; Type 3: Plain link, i.e. http://orgmode.org
2779 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2786 ;; In any case, deduce end point after trailing white space from
2787 ;; LINK-END variable.
2792 :path path
2794 :begin begin
2795 :end end
2796 :contents-begin contents-begin
2797 :contents-end contents-end
2801 "Interpret LINK object as Org syntax.
2802 CONTENTS is the contents of the object, or nil."
2807 raw-link
2811 "Search for the next link object.
2813 LIMIT bounds the search.
2815 Return value is a cons cell whose CAR is `link' and CDR is
2816 beginning position."
2825 ;;;; Macro
2828 "Parse macro at point.
2830 Return a list whose CAR is `macro' and CDR a plist with `:key',
2831 `:args', `:begin', `:end', `:value' and `:post-blank' as
2832 keywords.
2834 Assume point is at the macro."
2848 ;; Repair bad splits.
2856 :value value
2857 :args args
2858 :begin begin
2859 :end end
2863 "Interpret MACRO object as Org syntax.
2864 CONTENTS is nil."
2868 "Search for the next macro object.
2870 LIMIT bounds the search.
2872 Return value is cons cell whose CAR is `macro' and CDR is
2873 beginning position."
2877 limit t)
2881 ;;;; Radio-target
2884 "Parse radio target at point.
2886 Return a list whose CAR is `radio-target' and CDR a plist with
2887 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2888 and `:post-blank' as keywords.
2890 Assume point is at the radio target."
2902 :end end
2903 :contents-begin contents-begin
2904 :contents-end contents-end
2905 :post-blank post-blank
2909 "Interpret TARGET object as Org syntax.
2910 CONTENTS is the contents of the object."
2914 "Search for the next radio-target object.
2916 LIMIT bounds the search.
2918 Return value is a cons cell whose CAR is `radio-target' and CDR
2919 is beginning position."
2925 ;;;; Statistics Cookie
2928 "Parse statistics cookie at point.
2930 Return a list whose CAR is `statistics-cookie', and CDR a plist
2931 with `:begin', `:end', `:value' and `:post-blank' keywords.
2933 Assume point is at the beginning of the statistics-cookie."
2944 :end end
2945 :value value
2949 "Interpret STATISTICS-COOKIE object as Org syntax.
2950 CONTENTS is nil."
2954 "Search for the next statistics cookie object.
2956 LIMIT bounds the search.
2958 Return value is a cons cell whose CAR is `statistics-cookie' and
2959 CDR is beginning position."
2965 ;;;; Strike-Through
2968 "Parse strike-through object at point.
2970 Return a list whose CAR is `strike-through' and CDR is a plist
2971 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2972 `:post-blank' keywords.
2974 Assume point is at the first plus sign marker."
2986 :end end
2987 :contents-begin contents-begin
2988 :contents-end contents-end
2992 "Interpret STRIKE-THROUGH object as Org syntax.
2993 CONTENTS is the contents of the object."
2997 ;;;; Subscript
3000 "Parse subscript at point.
3002 Return a list whose CAR is `subscript' and CDR a plist with
3003 `:begin', `:end', `:contents-begin', `:contents-end',
3004 `:use-brackets-p' and `:post-blank' as keywords.
3006 Assume point is at the underscore."
3010 t
3021 :end end
3022 :use-brackets-p bracketsp
3023 :contents-begin contents-begin
3024 :contents-end contents-end
3028 "Interpret SUBSCRIPT object as Org syntax.
3029 CONTENTS is the contents of the object."
3032 contents))
3035 "Search for the next sub/superscript object.
3037 LIMIT bounds the search.
3039 Return value is a cons cell whose CAR is either `subscript' or
3040 `superscript' and CDR is beginning position."
3047 ;;;; Superscript
3050 "Parse superscript at point.
3052 Return a list whose CAR is `superscript' and CDR a plist with
3053 `:begin', `:end', `:contents-begin', `:contents-end',
3054 `:use-brackets-p' and `:post-blank' as keywords.
3056 Assume point is at the caret."
3070 :end end
3071 :use-brackets-p bracketsp
3072 :contents-begin contents-begin
3073 :contents-end contents-end
3077 "Interpret SUPERSCRIPT object as Org syntax.
3078 CONTENTS is the contents of the object."
3081 contents))
3084 ;;;; Table Cell
3087 "Parse table cell at point.
3089 Return a list whose CAR is `table-cell' and CDR is a plist
3090 containing `:begin', `:end', `:contents-begin', `:contents-end'
3091 and `:post-blank' keywords."
3099 :end end
3100 :contents-begin contents-begin
3101 :contents-end contents-end
3105 "Interpret TABLE-CELL element as Org syntax.
3106 CONTENTS is the contents of the cell, or nil."
3110 "Search for the next table-cell object.
3112 LIMIT bounds the search.
3114 Return value is a cons cell whose CAR is `table-cell' and CDR is
3115 beginning position."
3119 ;;;; Target
3122 "Parse target at point.
3124 Return a list whose CAR is `target' and CDR a plist with
3125 `:begin', `:end', `:value' and `:post-blank' as keywords.
3127 Assume point is at the target."
3137 :end end
3138 :value value
3142 "Interpret TARGET object as Org syntax.
3143 CONTENTS is nil."
3147 "Search for the next target object.
3149 LIMIT bounds the search.
3151 Return value is a cons cell whose CAR is `target' and CDR is
3152 beginning position."
3158 ;;;; Timestamp
3161 "Parse time stamp at point.
3163 Return a list whose CAR is `timestamp', and CDR a plist with
3164 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3166 Assume point is at the beginning of the timestamp."
3185 :value main-value
3186 :range-end range-end
3187 :begin begin
3188 :end end
3192 "Interpret TIMESTAMP object as Org syntax.
3193 CONTENTS is nil."
3202 range-end)))))))
3205 "Search for the next timestamp object.
3207 LIMIT bounds the search.
3209 Return value is a cons cell whose CAR is `timestamp' and CDR is
3210 beginning position."
3218 limit t)
3222 ;;;; Underline
3225 "Parse underline object at point.
3227 Return a list whose CAR is `underline' and CDR is a plist with
3228 `:begin', `:end', `:contents-begin' and `:contents-end' and
3229 `:post-blank' keywords.
3231 Assume point is at the first underscore marker."
3243 :end end
3244 :contents-begin contents-begin
3245 :contents-end contents-end
3249 "Interpret UNDERLINE object as Org syntax.
3250 CONTENTS is the contents of the object."
3254 ;;;; Verbatim
3257 "Parse verbatim object at point.
3259 Return a list whose CAR is `verbatim' and CDR is a plist with
3260 `:value', `:begin', `:end' and `:post-blank' keywords.
3262 Assume point is at the first equal sign marker."
3273 :begin begin
3274 :end end
3278 "Interpret VERBATIM object as Org syntax.
3279 CONTENTS is nil."
3283 \f
3284 ;;; Parsing Element Starting At Point
3285 ;;
3286 ;; `org-element--current-element' is the core function of this section.
3287 ;; It returns the Lisp representation of the element starting at
3288 ;; point.
3289 ;;
3290 ;; `org-element--current-element' makes use of special modes. They
3291 ;; are activated for fixed element chaining (i.e. `plain-list' >
3292 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3293 ;; `section'). Special modes are: `first-section', `section',
3294 ;; `quote-section', `item' and `table-row'.
3298 "Parse the element starting at point.
3300 LIMIT bounds the search.
3302 Return value is a list like (TYPE PROPS) where TYPE is the type
3303 of the element and PROPS a plist of properties associated to the
3304 element.
3306 Possible types are defined in `org-element-all-elements'.
3308 Optional argument GRANULARITY determines the depth of the
3309 recursion. Allowed values are `headline', `greater-element',
3310 `element', `object' or nil. When it is broader than `object' (or
3311 nil), secondary values will not be parsed, since they only
3312 contain objects.
3314 Optional argument SPECIAL, when non-nil, can be either
3315 `first-section', `section', `quote-section', `table-row' and
3316 `item'.
3318 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3319 be computed.
3321 This function assumes point is always at the beginning of the
3322 element it has to parse."
3324 ;; If point is at an affiliated keyword, try moving to the
3325 ;; beginning of the associated element. If none is found, the
3326 ;; keyword is orphaned and will be treated as plain text.
3332 ;; Determine if parsing depth allows for secondary strings
3333 ;; parsing. It only applies to elements referenced in
3334 ;; `org-element-secondary-value-alist'.
3337 ;; Item.
3340 ;; Table Row.
3342 ;; Headline.
3345 ;; Sections (must be checked after headline).
3351 limit)))
3352 ;; When not at bol, point is at the beginning of an item or
3353 ;; a footnote definition: next item is always a paragraph.
3355 ;; Planning and Clock.
3360 ;; Inlinetask.
3363 ;; LaTeX Environment.
3369 nil t))
3372 ;; Drawer and Property Drawer.
3382 ;; Fixed Width
3385 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3386 ;; Keywords.
3395 org-element-block-name-alist)))
3410 ;; Footnote Definition.
3413 ;; Horizontal Rule.
3416 ;; Table.
3418 ;; List.
3421 ;; Default element: Paragraph.
3425 ;; Most elements can have affiliated keywords. When looking for an
3426 ;; element beginning, we want to move before them, as they belong to
3427 ;; that element, and, in the meantime, collect information they give
3428 ;; into appropriate properties. Hence the following function.
3429 ;;
3430 ;; Usage of optional arguments may not be obvious at first glance:
3431 ;;
3432 ;; - TRANS-LIST is used to polish keywords names that have evolved
3433 ;; during Org history. In example, even though =result= and
3434 ;; =results= coexist, we want to have them under the same =result=
3435 ;; property. It's also true for "srcname" and "name", where the
3436 ;; latter seems to be preferred nowadays (thus the "name" property).
3437 ;;
3438 ;; - CONSED allows to regroup multi-lines keywords under the same
3439 ;; property, while preserving their own identity. This is mostly
3440 ;; used for "attr_latex" and al.
3441 ;;
3442 ;; - PARSED prepares a keyword value for export. This is useful for
3443 ;; "caption". Objects restrictions for such keywords are defined in
3444 ;; `org-element-object-restrictions'.
3445 ;;
3446 ;; - DUALS is used to take care of keywords accepting a main and an
3447 ;; optional secondary values. For example "results" has its
3448 ;; source's name as the main value, and may have an hash string in
3449 ;; optional square brackets as the secondary one.
3450 ;;
3451 ;; A keyword may belong to more than one category.
3455 "Collect affiliated keywords before point.
3457 Optional argument KEY-RE is a regexp matching keywords, which
3458 puts matched keyword in group 1. It defaults to
3459 `org-element--affiliated-re'.
3461 TRANS-LIST is an alist where key is the keyword and value the
3462 property name it should be translated to, without the colons. It
3463 defaults to `org-element-keyword-translation-alist'.
3465 CONSED is a list of strings. Any keyword belonging to that list
3466 will have its value consed. The check is done after keyword
3467 translation. It defaults to `org-element-multiple-keywords'.
3469 PARSED is a list of strings. Any keyword member of this list
3470 will have its value parsed. The check is done after keyword
3471 translation. If a keyword is a member of both CONSED and PARSED,
3472 it's value will be a list of parsed strings. It defaults to
3473 `org-element-parsed-keywords'.
3475 DUALS is a list of strings. Any keyword member of this list can
3476 have two parts: one mandatory and one optional. Its value is
3477 a cons cell whose CAR is the former, and the CDR the latter. If
3478 a keyword is a member of both PARSED and DUALS, both values will
3479 be parsed. It defaults to `org-element-dual-keywords'.
3481 Return a list whose CAR is the position at the first of them and
3482 CDR a plist of keywords and values."
3490 ;; RESTRICT is the list of objects allowed in parsed
3491 ;; keywords value.
3493 output)
3497 ;; Apply translation to RAW-KWD. From there, KWD is
3498 ;; the official keyword.
3500 ;; Find main value for any keyword.
3506 ;; If KWD is a dual keyword, find its secondary
3507 ;; value. Maybe parse it.
3513 ;; Attribute a property name to KWD.
3515 ;; Now set final shape for VALUE.
3519 ;; VALUE is mandatory. Set it to nil if there is none.
3521 ;; Attributes are always consed.
3524 ;; Eventually store the new value in OUTPUT.
3530 \f
3531 ;;; The Org Parser
3532 ;;
3533 ;; The two major functions here are `org-element-parse-buffer', which
3534 ;; parses Org syntax inside the current buffer, taking into account
3535 ;; region, narrowing, or even visibility if specified, and
3536 ;; `org-element-parse-secondary-string', which parses objects within
3537 ;; a given string.
3538 ;;
3539 ;; The (almost) almighty `org-element-map' allows to apply a function
3540 ;; on elements or objects matching some type, and accumulate the
3541 ;; resulting values. In an export situation, it also skips unneeded
3542 ;; parts of the parse tree.
3545 "Recursively parse the buffer and return structure.
3546 If narrowing is in effect, only parse the visible part of the
3547 buffer.
3549 Optional argument GRANULARITY determines the depth of the
3550 recursion. It can be set to the following symbols:
3552 `headline' Only parse headlines.
3553 `greater-element' Don't recurse into greater elements excepted
3554 headlines and sections. Thus, elements
3555 parsed are the top-level ones.
3556 `element' Parse everything but objects and plain text.
3557 `object' Parse the complete buffer (default).
3559 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3560 elements.
3562 Assume buffer is in Org mode."
3568 ;; Start in `first-section' mode so text before the first
3569 ;; headline belongs to a section.
3573 "Recursively parse objects in STRING and return structure.
3575 RESTRICTION is a symbol limiting the object types that will be
3576 looked after.
3578 Optional argument PARENT, when non-nil, is the element or object
3579 containing the secondary string. It is used to set correctly
3580 `:parent' property within the string."
3586 secondary))))
3589 "Map a function on selected elements or objects.
3591 DATA is the parsed tree, as returned by, i.e,
3592 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3593 of elements or objects types. FUN is the function called on the
3594 matching element or object. It must accept one arguments: the
3595 element or object itself.
3597 When optional argument INFO is non-nil, it should be a plist
3598 holding export options. In that case, parts of the parse tree
3599 not exportable according to that property list will be skipped.
3601 When optional argument FIRST-MATCH is non-nil, stop at the first
3602 match for which FUN doesn't return nil, and return that value.
3604 Optional argument NO-RECURSION is a symbol or a list of symbols
3605 representing elements or objects types. `org-element-map' won't
3606 enter any recursive element or object whose type belongs to that
3607 list. Though, FUN can still be applied on them.
3609 Nil values returned from FUN do not appear in the results."
3610 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3613 ;; Recursion depth is determined by --CATEGORY.
3620 ;; If one object is found, the function
3621 ;; has to recurse into every object.
3624 ;; If one regular element is found, the
3625 ;; function has to recurse, at least,
3626 ;; into every element it encounters.
3629 types)
3630 category)))
3631 --acc
3632 --walk-tree
3636 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3637 ;; holding contextual information.
3641 ;; Ignored element in an export context.
3643 ;; Secondary string: only objects can be found there.
3646 ;; Unconditionally enter parse trees.
3650 ;; Check if TYPE is matching among TYPES. If so,
3651 ;; apply FUN to --DATA and accumulate return value
3652 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3658 ;; If --DATA has a secondary string that can contain
3659 ;; objects with their type among TYPES, look into it.
3666 ;; Determine if a recursion into --DATA is possible.
3668 ;; --TYPE is explicitly removed from recursion.
3670 ;; --DATA has no contents.
3672 ;; Looking for greater elements but --DATA is simply
3673 ;; an element or an object.
3676 ;; Looking for elements but --DATA is an object.
3679 ;; In any other case, map contents.
3683 ;; Return value in a proper order.
3686 ;; The following functions are internal parts of the parser.
3687 ;;
3688 ;; The first one, `org-element--parse-elements' acts at the element's
3689 ;; level.
3690 ;;
3691 ;; The second one, `org-element--parse-objects' applies on all objects
3692 ;; of a paragraph or a secondary string. It uses
3693 ;; `org-element--get-next-object-candidates' to optimize the search of
3694 ;; the next object in the buffer.
3695 ;;
3696 ;; More precisely, that function looks for every allowed object type
3697 ;; first. Then, it discards failed searches, keeps further matches,
3698 ;; and searches again types matched behind point, for subsequent
3699 ;; calls. Thus, searching for a given type fails only once, and every
3700 ;; object is searched only once at top level (but sometimes more for
3701 ;; nested types).
3705 "Parse elements between BEG and END positions.
3707 SPECIAL prioritize some elements over the others. It can be set
3708 to `first-section', `quote-section', `section' `item' or
3709 `table-row'.
3711 When value is `item', STRUCTURE will be used as the current list
3712 structure.
3714 GRANULARITY determines the depth of the recursion. See
3715 `org-element-parse-buffer' for more information.
3717 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3718 elements.
3720 Elements are accumulated into ACC."
3723 ;; When parsing only headlines, skip any text before first one.
3726 ;; Main loop start.
3728 ;; Find current element's type and parse it accordingly to
3729 ;; its category.
3731 end granularity special structure))
3735 ;; Fill ELEMENT contents by side-effect.
3737 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3738 ;; no contents, don't modify it.
3741 ;; Greater element: parse it between `contents-begin' and
3742 ;; `contents-end'. Make sure GRANULARITY allows the
3743 ;; recursion, or ELEMENT is an headline, in which case going
3744 ;; inside is mandatory, in order to get sub-level headings.
3752 ;; Possibly switch to a special mode.
3760 granularity visible-only element))
3761 ;; ELEMENT has contents. Parse objects inside, if
3762 ;; GRANULARITY allows it.
3768 ;; Return result.
3769 acc))
3772 "Parse objects between BEG and END and return recursive structure.
3774 Objects are accumulated in ACC.
3776 RESTRICTION is a list of object types which are allowed in the
3777 current object."
3783 end restriction candidates)))
3790 ;; 1. Text before any object. Untabify it.
3795 acc
3799 ;; 2. Object...
3802 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3803 ;; a recursive type.
3808 cont-beg
3815 ;; 3. Text after last object. Untabify it.
3819 acc
3823 ;; Result.
3824 acc)))
3827 "Return an alist of candidates for the next object.
3829 LIMIT bounds the search, and RESTRICTION narrows candidates to
3830 some object types.
3832 Return value is an alist whose CAR is position and CDR the object
3833 type, as a symbol.
3835 OBJECTS is the previous candidates alist."
3837 ;; If no previous result, search every object type in RESTRICTION.
3838 ;; Otherwise, keep potential candidates (old objects located after
3839 ;; point) and ask to search again those which had matched before.
3844 objects))
3845 ;; Call the appropriate successor function for each type to search
3846 ;; and accumulate matches.
3853 type))))
3856 types-to-search)
3857 ;; Return alist.
3858 next-candidates))
3861 \f
3862 ;;; Towards A Bijective Process
3863 ;;
3864 ;; The parse tree obtained with `org-element-parse-buffer' is really
3865 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3866 ;; interpreted and expanded into a string with canonical Org syntax.
3867 ;; Hence `org-element-interpret-data'.
3868 ;;
3869 ;; The function relies internally on
3870 ;; `org-element--interpret-affiliated-keywords'.
3872 ;;;###autoload
3874 "Interpret DATA as Org syntax.
3876 DATA is a parse tree, an element, an object or a secondary string
3877 to interpret.
3879 Optional argument PARENT is used for recursive calls. It contains
3880 the element or object containing data, or nil.
3882 Return Org syntax as a string."
3886 ;; Secondary string.
3891 ;; Full Org document.
3896 ;; Plain text.
3898 ;; Element/Object without contents.
3901 data nil))
3902 ;; Element/Object with contents.
3912 ;; Elements directly containing objects must
3913 ;; have their indentation normalized first.
3915 data
3916 ;; When normalizing first paragraph of an
3917 ;; item or a footnote-definition, ignore
3918 ;; first line's indentation.
3925 data
3927 contents)))))))
3929 ;; Build white spaces. If no `:post-blank' property is
3930 ;; specified, assume its value is 0.
3940 "Return ELEMENT's affiliated keywords as Org syntax.
3941 If there is no affiliated keyword, return the empty string."
3951 ": "
3954 value)
3962 ;; All attribute keywords can have multiple lines.
3965 value
3968 ;; List all ELEMENT's properties matching an attribute line or an
3969 ;; affiliated keyword, but ignore translated keywords since they
3970 ;; cannot belong to the property list.
3977 org-element-keyword-translation-alist)))))
3978 collect prop)
3981 ;; Because interpretation of the parse tree must return the same
3982 ;; number of blank lines between elements and the same number of white
3983 ;; space after objects, some special care must be given to white
3984 ;; spaces.
3985 ;;
3986 ;; The first function, `org-element-normalize-string', ensures any
3987 ;; string different from the empty string will end with a single
3988 ;; newline character.
3989 ;;
3990 ;; The second function, `org-element-normalize-contents', removes
3991 ;; global indentation from the contents of the current element.
3994 "Ensure string S ends with a single newline character.
3996 If S isn't a string return it unchanged. If S is the empty
3997 string, return it. Otherwise, return a new string with a single
3998 newline character at its end."
4006 "Normalize plain text in ELEMENT's contents.
4008 ELEMENT must only contain plain text and objects.
4010 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4011 indentation to compute maximal common indentation.
4013 Return the normalized element that is element with global
4014 indentation removed from its contents. The function assumes that
4015 indentation is not done with TAB characters."
4017 collect-inds ; for byte-compiler
4020 ;; Return list of indentations within BLOB. This is done by
4021 ;; walking recursively BLOB and updating IND-LIST along the
4022 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4023 ;; been seen yet. It is required as this string is the only
4024 ;; one whose indentation doesn't happen after a newline
4025 ;; character.
4033 ;; An indentation of zero means no string will be
4034 ;; modified. Quit the process.
4040 ;; Avoid matching blank or empty lines.
4048 ;; Collect indentation list in ELEMENT. Possibly remove first
4049 ;; value if IGNORE-FIRST is non-nil.
4052 ;; Build ELEMENT back, replacing each string with the same
4053 ;; string minus common indentation.
4058 ;; Return BLOB with all its strings indentation
4059 ;; shortened from MCI white spaces. FIRST-FLAG is
4060 ;; non-nil when the first string hasn't been seen
4061 ;; yet.
4075 org-element-recursive-objects)
4079 blob))))
4083 \f
4084 ;;; The Toolbox
4085 ;;
4086 ;; The first move is to implement a way to obtain the smallest element
4087 ;; containing point. This is the job of `org-element-at-point'. It
4088 ;; basically jumps back to the beginning of section containing point
4089 ;; and moves, element after element, with
4090 ;; `org-element--current-element' until the container is found. Note:
4091 ;; When using `org-element-at-point', secondary values are never
4092 ;; parsed since the function focuses on elements, not on objects.
4093 ;;
4094 ;; At a deeper level, `org-element-context' lists all elements and
4095 ;; objects containing point.
4096 ;;
4097 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4098 ;; internally by navigation and manipulation tools.
4100 ;;;###autoload
4102 "Determine closest element around point.
4104 Return value is a list like (TYPE PROPS) where TYPE is the type
4105 of the element and PROPS a plist of properties associated to the
4106 element.
4108 Possible types are defined in `org-element-all-elements'.
4109 Properties depend on element or object type, but always
4110 include :begin, :end, :parent and :post-blank properties.
4112 As a special case, if point is at the very beginning of a list or
4113 sub-list, returned element will be that list instead of the first
4114 item. In the same way, if point is at the beginning of the first
4115 row of a table, returned element will be the table instead of the
4116 first row.
4118 If optional argument KEEP-TRAIL is non-nil, the function returns
4119 a list of of elements leading to element at point. The list's
4120 CAR is always the element at point. Following positions contain
4121 element's siblings, then parents, siblings of parents, until the
4122 first element of current section."
4124 ;; If at an headline, parse it. It is the sole element that
4125 ;; doesn't require to know about context. Be sure to disallow
4126 ;; secondary string parsing, though.
4132 ;; Otherwise move at the beginning of the section containing
4133 ;; point.
4137 element type special-flag trail struct prevs parent)
4145 ;; Parse successively each element, skipping those ending
4146 ;; before original position.
4155 ;; 1. Skip any element ending before point. Also skip
4156 ;; element ending at point when we're sure that another
4157 ;; element has started.
4162 ;; 2. An element containing point is always the element at
4163 ;; point.
4166 ;; 3. At any other greater element type, if point is
4167 ;; within contents, move into it.
4172 ;; Create an anchor for tables and plain lists:
4173 ;; when point is at the very beginning of these
4174 ;; elements, ignoring affiliated keywords,
4175 ;; target them instead of their contents.
4177 ;; When point is at contents end, do not move
4178 ;; into elements with an explicit ending, but
4179 ;; return that element instead.
4183 drawer dynamic-block inlinetask item
4184 plain-list quote-block special-block))))
4196 ;;;###autoload
4198 "Return closest element or object around point.
4200 Return value is a list like (TYPE PROPS) where TYPE is the type
4201 of the element or object and PROPS a plist of properties
4202 associated to it.
4204 Possible types are defined in `org-element-all-elements' and
4205 `org-element-all-objects'. Properties depend on element or
4206 object type, but always include :begin, :end, :parent
4207 and :post-blank properties."
4212 end)
4213 ;; Check if point is inside an element containing objects or at
4214 ;; a secondary string. In that case, move to beginning of the
4215 ;; element or secondary string and set END to the other side.
4224 (<= origin
4225 ;; `1+' is required so some
4226 ;; successors can match
4227 ;; properly their object.
4241 element
4244 candidates)
4247 end restriction candidates))
4249 candidates)))
4250 ;; If ORIGIN is before next object in element, there's
4251 ;; no point in looking further.
4260 ;; ORIGIN is after OBJECT, so skip it.
4263 ;; ORIGIN is within a non-recursive object or at an
4264 ;; object boundaries: Return that object.
4268 ;; Otherwise, move within current object and restrict
4269 ;; search to the end of its contents.
4273 parent))))))
4276 "Non-nil when elements ELEM-A and ELEM-B are nested."
4285 "Swap elements ELEM-A and ELEM-B.
4286 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4287 end of ELEM-A."
4289 ;; There are two special cases when an element doesn't start at bol:
4290 ;; the first paragraph in an item or in a footnote definition.
4292 ;; Only a paragraph without any affiliated keyword can be moved at
4293 ;; ELEM-A position in such a situation. Note that the case of
4294 ;; a footnote definition is impossible: it cannot contain two
4295 ;; paragraphs in a row because it cannot contain a blank line.
4301 ;; In a special situation, ELEM-A will have no indentation. We'll
4302 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4316 ;; Store overlays responsible for visibility status. We
4317 ;; also need to store their boundaries as they will be
4318 ;; removed from buffer.
4325 ;; Get contents.
4333 ;; Restore ex ELEM-A overlays.
4342 ;; Restore ex ELEM-B overlays.
4351 ;;; org-element.el ends here