| blob | fe4a18405ab1d7e1f51bd3873d62cf7428f59609 |
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."
583 ;; Incomplete block: parse it as a paragraph.
592 ;; Empty blocks have no contents.
606 :end end
607 :block-name name
608 :arguments arguments
609 :hiddenp hidden
610 :contents-begin contents-begin
611 :contents-end contents-end
616 "Interpret DYNAMIC-BLOCK element as Org syntax.
617 CONTENTS is the contents of the element."
622 contents))
625 ;;;; Footnote Definition
628 "Parse a footnote definition.
630 LIMIT bounds the search.
632 Return a list whose CAR is `footnote-definition' and CDR is
633 a plist containing `:label', `:begin' `:end', `:contents-begin',
634 `:contents-end' and `:post-blank' keywords.
636 Assume point is at the beginning of the footnote definition."
661 :begin begin
662 :end end
663 :contents-begin contents-begin
664 :contents-end contents-end
669 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
670 CONTENTS is the contents of the footnote-definition."
672 " "
673 contents))
676 ;;;; Headline
679 "Parse an headline.
681 Return a list whose CAR is `headline' and CDR is a plist
682 containing `:raw-value', `:title', `:begin', `:end',
683 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
684 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
685 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
686 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
687 keywords.
689 The plist also contains any property set in the property drawer,
690 with its name in lowercase, the underscores replaced with hyphens
691 and colons at the beginning (i.e. `:custom-id').
693 When RAW-SECONDARY-P is non-nil, headline's title will not be
694 parsed as a secondary string, but as a plain string instead.
696 Assume point is at beginning of the headline."
709 raw-value)))
713 raw-value)))
717 ;; Normalize property names: ":SOME_PROP:" becomes
718 ;; ":some-prop".
730 plist))
748 ;; Clean RAW-VALUE from any quote or comment string.
756 ""
757 raw-value))))
758 ;; Clean TAGS from archive tag, if any.
764 :begin begin
765 :end end
766 :pre-blank
769 :hiddenp hidden
770 :contents-begin contents-begin
771 :contents-end contents-end
772 :level level
774 :tags tags
775 :todo-keyword todo
776 :todo-type todo-type
777 :scheduled scheduled
778 :deadline deadline
779 :timestamp timestamp
780 :clock clock
786 end)
787 :footnote-section-p footnote-section-p
788 :archivedp archivedp
789 :commentedp commentedp
791 standard-props))))
793 headline :title
799 "Interpret HEADLINE element as Org syntax.
800 CONTENTS is the contents of the element."
827 ;; Align tags.
835 ? )
836 tags))
840 tags))))
842 contents)))
845 ;;;; Inlinetask
848 "Parse an inline task.
850 Return a list whose CAR is `inlinetask' and CDR is a plist
851 containing `:title', `:begin', `:end', `:hiddenp',
852 `:contents-begin' and `:contents-end', `:level', `:priority',
853 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
854 `:scheduled', `:deadline', `:timestamp', `:clock' and
855 `:post-blank' keywords.
857 The plist also contains any property set in the property drawer,
858 with its name in lowercase, the underscores replaced with hyphens
859 and colons at the beginning (i.e. `:custom-id').
861 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
862 title will not be parsed as a secondary string, but as a plain
863 string instead.
865 Assume point is at beginning of the inline task."
876 ;; Normalize property names: ":SOME_PROP:" becomes
877 ;; ":some-prop".
889 plist))
913 :begin begin
914 :end end
915 :hiddenp hidden
916 :contents-begin contents-begin
917 :contents-end contents-end
920 :tags tags
921 :todo-keyword todo
922 :todo-type todo-type
923 :scheduled scheduled
924 :deadline deadline
925 :timestamp timestamp
926 :clock clock
928 standard-props
931 inlinetask :title
934 raw-value
936 inlinetask))))))
939 "Interpret INLINETASK element as Org syntax.
940 CONTENTS is the contents of inlinetask."
955 ;; Align tags.
963 ? )
964 tags))
968 tags))))
969 ;; Prefer degenerate inlinetasks when there are no
970 ;; contents.
973 contents
977 ;;;; Item
980 "Parse an item.
982 STRUCT is the structure of the plain list.
984 Return a list whose CAR is `item' and CDR is a plist containing
985 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
986 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
987 `:post-blank' keywords.
989 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
990 any, will not be parsed as a secondary string, but as a plain
991 string instead.
993 Assume point is at the beginning of the item."
1017 ;; Ignore tags in un-ordered lists: they are just
1018 ;; a part of item's body.
1024 ;; If first line isn't empty, contents really start
1025 ;; at the text after item's meta-data.
1036 :begin begin
1037 :end end
1038 ;; CONTENTS-BEGIN and CONTENTS-END may be
1039 ;; mixed up in the case of an empty item
1040 ;; separated from the next by a blank line.
1041 ;; Thus ensure the former is always the
1042 ;; smallest.
1045 :checkbox checkbox
1046 :counter counter
1047 :hiddenp hidden
1048 :structure struct
1051 item :tag
1059 "Interpret ITEM element as Org syntax.
1060 CONTENTS is the contents of the element."
1066 ;; Compute indentation.
1071 ;; Indent contents.
1073 bullet
1086 ;;;; Plain List
1089 "Parse a plain list.
1091 Optional argument STRUCTURE, when non-nil, is the structure of
1092 the plain list being parsed.
1094 Return a list whose CAR is `plain-list' and CDR is a plist
1095 containing `:type', `:begin', `:end', `:contents-begin' and
1096 `:contents-end', `:structure' and `:post-blank' keywords.
1098 Assume point is at the beginning of the list."
1113 ;; Return value.
1117 :begin begin
1118 :end end
1119 :contents-begin contents-begin
1120 :contents-end contents-end
1121 :structure struct
1126 "Interpret PLAIN-LIST element as Org syntax.
1127 CONTENTS is the contents of the element."
1135 ;;;; Quote Block
1138 "Parse a quote block.
1140 LIMIT bounds the search.
1142 Return a list whose CAR is `quote-block' and CDR is a plist
1143 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1144 `:contents-end' and `:post-blank' keywords.
1146 Assume point is at the beginning of the block."
1150 ;; Incomplete block: parse it as a paragraph.
1156 ;; Empty blocks have no contents.
1170 :end end
1171 :hiddenp hidden
1172 :contents-begin contents-begin
1173 :contents-end contents-end
1178 "Interpret QUOTE-BLOCK element as Org syntax.
1179 CONTENTS is the contents of the element."
1183 ;;;; Section
1186 "Parse a section.
1188 LIMIT bounds the search.
1190 Return a list whose CAR is `section' and CDR is a plist
1191 containing `:begin', `:end', `:contents-begin', `contents-end'
1192 and `:post-blank' keywords."
1194 ;; Beginning of section is the beginning of the first non-blank
1195 ;; line after previous headline.
1204 :end end
1205 :contents-begin begin
1206 :contents-end pos-before-blank
1210 "Interpret SECTION element as Org syntax.
1211 CONTENTS is the contents of the element."
1212 contents)
1215 ;;;; Special Block
1218 "Parse a special block.
1220 LIMIT bounds the search.
1222 Return a list whose CAR is `special-block' and CDR is a plist
1223 containing `:type', `:begin', `:end', `:hiddenp',
1224 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1226 Assume point is at the beginning of the block."
1233 ;; Incomplete block: parse it as a paragraph.
1239 ;; Empty blocks have no contents.
1253 :begin begin
1254 :end end
1255 :hiddenp hidden
1256 :contents-begin contents-begin
1257 :contents-end contents-end
1262 "Interpret SPECIAL-BLOCK element as Org syntax.
1263 CONTENTS is the contents of the element."
1268 \f
1269 ;;; Elements
1270 ;;
1271 ;; For each element, a parser and an interpreter are also defined.
1272 ;; Both follow the same naming convention used for greater elements.
1273 ;;
1274 ;; Also, as for greater elements, adding a new element type is done
1275 ;; through the following steps: implement a parser and an interpreter,
1276 ;; tweak `org-element--current-element' so that it recognizes the new
1277 ;; type and add that new type to `org-element-all-elements'.
1278 ;;
1279 ;; As a special case, when the newly defined type is a block type,
1280 ;; `org-element-block-name-alist' has to be modified accordingly.
1283 ;;;; Babel Call
1286 "Parse a babel call.
1288 LIMIT bounds the search.
1290 Return a list whose CAR is `babel-call' and CDR is a plist
1291 containing `:begin', `:end', `:info' and `:post-blank' as
1292 keywords."
1303 :end end
1304 :info info
1308 "Interpret BABEL-CALL element as Org syntax.
1309 CONTENTS is nil."
1315 ;; Remove redundant square brackets.
1320 ;;;; Clock
1323 "Parse a clock.
1325 LIMIT bounds the search.
1327 Return a list whose CAR is `clock' and CDR is a plist containing
1328 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1329 as keywords."
1348 :value value
1349 :time time
1350 :begin begin
1351 :end end
1355 "Interpret CLOCK element as Org syntax.
1356 CONTENTS is nil."
1363 "%2s:%02s"
1367 ;;;; Comment
1370 "Parse a comment.
1372 LIMIT bounds the search.
1374 Return a list whose CAR is `comment' and CDR is a plist
1375 containing `:begin', `:end', `:value' and `:post-blank'
1376 keywords.
1378 Assume point is at comment beginning."
1387 ;; Get comments ending.
1390 ;; Accumulate lines without leading hash and first
1391 ;; whitespace.
1405 :end end
1406 :value value
1411 "Interpret COMMENT element as Org syntax.
1412 CONTENTS is nil."
1416 ;;;; Comment Block
1419 "Parse an export block.
1421 LIMIT bounds the search.
1423 Return a list whose CAR is `comment-block' and CDR is a plist
1424 containing `:begin', `:end', `:hiddenp', `:value' and
1425 `:post-blank' keywords.
1427 Assume point is at comment block beginning."
1431 ;; Incomplete block: parse it as a paragraph.
1445 contents-begin contents-end)))
1449 :end end
1450 :value value
1451 :hiddenp hidden
1456 "Interpret COMMENT-BLOCK element as Org syntax.
1457 CONTENTS is nil."
1462 ;;;; Example Block
1465 "Parse an example block.
1467 LIMIT bounds the search.
1469 Return a list whose CAR is `example-block' and CDR is a plist
1470 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1471 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1472 `:switches', `:value' and `:post-blank' keywords."
1476 ;; Incomplete block: parse it as a paragraph.
1483 ;; Switches analysis
1488 ;; Should labels be retained in (or stripped from) example
1489 ;; blocks?
1494 ;; What should code-references use - labels or
1495 ;; line-numbers?
1502 ;; Standard block parsing.
1509 contents-begin contents-end)))
1518 :end end
1519 :value value
1520 :switches switches
1521 :number-lines number-lines
1522 :preserve-indent preserve-indent
1523 :retain-labels retain-labels
1524 :use-labels use-labels
1525 :label-fmt label-fmt
1526 :hiddenp hidden
1531 "Interpret EXAMPLE-BLOCK element as Org syntax.
1532 CONTENTS is nil."
1541 ;;;; Export Block
1544 "Parse an export block.
1546 LIMIT bounds the search.
1548 Return a list whose CAR is `export-block' and CDR is a plist
1549 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1550 `:post-blank' keywords.
1552 Assume point is at export-block beginning."
1559 ;; Incomplete block: parse it as a paragraph.
1573 contents-end)))
1577 :end end
1578 :type type
1579 :value value
1580 :hiddenp hidden
1585 "Interpret EXPORT-BLOCK element as Org syntax.
1586 CONTENTS is nil."
1593 ;;;; Fixed-width
1596 "Parse a fixed-width section.
1598 LIMIT bounds the search.
1600 Return a list whose CAR is `fixed-width' and CDR is a plist
1601 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1603 Assume point is at the beginning of the fixed-width area."
1607 value
1612 ;; Accumulate text without starting colons.
1625 :end end
1626 :value value
1631 "Interpret FIXED-WIDTH element as Org syntax.
1632 CONTENTS is nil."
1637 ;;;; Horizontal Rule
1640 "Parse an horizontal rule.
1642 LIMIT bounds the search.
1644 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1645 containing `:begin', `:end' and `:post-blank' keywords."
1655 :end end
1660 "Interpret HORIZONTAL-RULE element as Org syntax.
1661 CONTENTS is nil."
1665 ;;;; Keyword
1668 "Parse a keyword at point.
1670 LIMIT bounds the search.
1672 Return a list whose CAR is `keyword' and CDR is a plist
1673 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1674 keywords."
1687 :value value
1688 :begin begin
1689 :end end
1693 "Interpret KEYWORD element as Org syntax.
1694 CONTENTS is nil."
1700 ;;;; Latex Environment
1703 "Parse a LaTeX environment.
1705 LIMIT bounds the search.
1707 Return a list whose CAR is `latex-environment' and CDR is a plist
1708 containing `:begin', `:end', `:value' and `:post-blank'
1709 keywords.
1711 Assume point is at the beginning of the latex environment."
1730 :end end
1731 :value value
1736 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1737 CONTENTS is nil."
1741 ;;;; Paragraph
1744 "Parse a paragraph.
1746 LIMIT bounds the search.
1748 Return a list whose CAR is `paragraph' and CDR is a plist
1749 containing `:begin', `:end', `:contents-begin' and
1750 `:contents-end' and `:post-blank' keywords.
1752 Assume point is at the beginning of the paragraph."
1755 ;; INNER-PAR-P is non-nil when paragraph is at the
1756 ;; beginning of an item or a footnote reference. In that
1757 ;; case, we mustn't look for affiliated keywords since they
1758 ;; belong to the container.
1768 limit
1769 ;; A matching `org-element-paragraph-separate' is not
1770 ;; necessarily the end of the paragraph. In
1771 ;; particular, lines starting with # or : as a first
1772 ;; non-space character are ambiguous. We have check
1773 ;; if they are valid Org syntax (i.e. not an
1774 ;; incomplete keyword).
1778 ;; There's no ambiguity for other symbols or
1779 ;; empty lines: stop here.
1781 ;; Stop at valid fixed-width areas.
1783 ;; Stop at drawers.
1788 ;; Stop at valid comments.
1790 ;; Stop at valid dynamic blocks.
1795 ;; Stop at valid blocks.
1802 limit t)))
1803 ;; Stop at valid latex environments.
1810 limit t)))
1811 ;; Stop at valid keywords.
1813 ;; Skip everything else.
1830 :end end
1831 :contents-begin contents-begin
1832 :contents-end contents-end
1837 "Interpret PARAGRAPH element as Org syntax.
1838 CONTENTS is the contents of the element."
1839 contents)
1842 ;;;; Planning
1845 "Parse a planning.
1847 LIMIT bounds the search.
1849 Return a list whose CAR is `planning' and CDR is a plist
1850 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1851 and `:post-blank' keywords."
1860 closed deadline scheduled)
1874 :deadline deadline
1875 :scheduled scheduled
1876 :begin begin
1877 :end end
1881 "Interpret PLANNING element as Org syntax.
1882 CONTENTS is nil."
1884 'identity
1896 ;;;; Property Drawer
1899 "Parse a property drawer.
1901 LIMIT bounds the search.
1903 Return a list whose CAR is `property-drawer' and CDR is a plist
1904 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1905 `:contents-end', `:properties' and `:post-blank' keywords.
1907 Assume point is at the beginning of the property drawer."
1921 val))
1923 val))
1931 :end end
1932 :hiddenp hidden
1933 :properties properties
1937 "Interpret PROPERTY-DRAWER element as Org syntax.
1938 CONTENTS is nil."
1948 ;;;; Quote Section
1951 "Parse a quote section.
1953 LIMIT bounds the search.
1955 Return a list whose CAR is `quote-section' and CDR is a plist
1956 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1958 Assume point is at beginning of the section."
1969 :end end
1970 :value value
1974 "Interpret QUOTE-SECTION element as Org syntax.
1975 CONTENTS is nil."
1979 ;;;; Src Block
1982 "Parse a src block.
1984 LIMIT bounds the search.
1986 Return a list whose CAR is `src-block' and CDR is a plist
1987 containing `:language', `:switches', `:parameters', `:begin',
1988 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1989 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1990 `:post-blank' keywords.
1992 Assume point is at the beginning of the block."
1995 limit t)))
1996 ;; Incomplete block: parse it as a paragraph.
2001 ;; Get beginning position.
2003 ;; Get language as a string.
2012 ;; Get switches.
2014 ;; Get parameters.
2016 ;; Switches analysis
2024 ;; Should labels be retained in (or stripped from)
2025 ;; src blocks?
2030 ;; What should code-references use - labels or
2031 ;; line-numbers?
2035 ;; Get visibility status.
2037 ;; Retrieve code.
2043 ;; Get position after ending blank lines.
2053 :begin begin
2054 :end end
2055 :number-lines number-lines
2056 :preserve-indent preserve-indent
2057 :retain-labels retain-labels
2058 :use-labels use-labels
2059 :label-fmt label-fmt
2060 :hiddenp hidden
2061 :value value
2066 "Interpret SRC-BLOCK element as Org syntax.
2067 CONTENTS is nil."
2091 ;;;; Table
2094 "Parse a table at point.
2096 LIMIT bounds the search.
2098 Return a list whose CAR is `table' and CDR is a plist containing
2099 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2100 `:contents-end', `:value' and `:post-blank' keywords.
2102 Assume point is at the beginning of the table."
2114 acc))
2121 :end end
2122 :type type
2123 :tblfm tblfm
2124 ;; Only `org' tables have contents. `table.el' tables
2125 ;; use a `:value' property to store raw table as
2126 ;; a string.
2131 table-begin table-end))
2136 "Interpret TABLE element as Org syntax.
2137 CONTENTS is nil."
2148 ;;;; Table Row
2151 "Parse table row at point.
2153 LIMIT bounds the search.
2155 Return a list whose CAR is `table-row' and CDR is a plist
2156 containing `:begin', `:end', `:contents-begin', `:contents-end',
2157 `:type' and `:post-blank' keywords."
2161 ;; A table rule has no contents. In that case, ensure
2162 ;; CONTENTS-BEGIN matches CONTENTS-END.
2174 :begin begin
2175 :end end
2176 :contents-begin contents-begin
2177 :contents-end contents-end
2181 "Interpret TABLE-ROW element as Org syntax.
2182 CONTENTS is the contents of the table row."
2187 ;;;; Verse Block
2190 "Parse a verse block.
2192 LIMIT bounds the search.
2194 Return a list whose CAR is `verse-block' and CDR is a plist
2195 containing `:begin', `:end', `:contents-begin', `:contents-end',
2196 `:hiddenp' and `:post-blank' keywords.
2198 Assume point is at beginning of the block."
2202 ;; Incomplete block: parse it as a paragraph.
2218 :end end
2219 :contents-begin contents-begin
2220 :contents-end contents-end
2221 :hiddenp hidden
2226 "Interpret VERSE-BLOCK element as Org syntax.
2227 CONTENTS is verse block contents."
2231 \f
2232 ;;; Objects
2233 ;;
2234 ;; Unlike to elements, interstices can be found between objects.
2235 ;; That's why, along with the parser, successor functions are provided
2236 ;; for each object. Some objects share the same successor (i.e. `code'
2237 ;; and `verbatim' objects).
2238 ;;
2239 ;; A successor must accept a single argument bounding the search. It
2240 ;; will return either a cons cell whose CAR is the object's type, as
2241 ;; a symbol, and CDR the position of its next occurrence, or nil.
2242 ;;
2243 ;; Successors follow the naming convention:
2244 ;; org-element-NAME-successor, where NAME is the name of the
2245 ;; successor, as defined in `org-element-all-successors'.
2246 ;;
2247 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2248 ;; object types they can contain will be specified in
2249 ;; `org-element-object-restrictions'.
2250 ;;
2251 ;; Adding a new type of object is simple. Implement a successor,
2252 ;; a parser, and an interpreter for it, all following the naming
2253 ;; convention. Register type in `org-element-all-objects' and
2254 ;; successor in `org-element-all-successors'. Maybe tweak
2255 ;; restrictions about it, and that's it.
2258 ;;;; Bold
2261 "Parse bold object at point.
2263 Return a list whose CAR is `bold' and CDR is a plist with
2264 `:begin', `:end', `:contents-begin' and `:contents-end' and
2265 `:post-blank' keywords.
2267 Assume point is at the first star marker."
2279 :end end
2280 :contents-begin contents-begin
2281 :contents-end contents-end
2285 "Interpret BOLD object as Org syntax.
2286 CONTENTS is the contents of the object."
2290 "Search for the next text-markup object.
2292 LIMIT bounds the search.
2294 Return value is a cons cell whose CAR is a symbol among `bold',
2295 `italic', `underline', `strike-through', `code' and `verbatim'
2296 and CDR is beginning position."
2312 ;;;; Code
2315 "Parse code object at point.
2317 Return a list whose CAR is `code' and CDR is a plist with
2318 `:value', `:begin', `:end' and `:post-blank' keywords.
2320 Assume point is at the first tilde marker."
2331 :begin begin
2332 :end end
2336 "Interpret CODE object as Org syntax.
2337 CONTENTS is nil."
2341 ;;;; Entity
2344 "Parse entity at point.
2346 Return a list whose CAR is `entity' and CDR a plist with
2347 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2348 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2349 keywords.
2351 Assume point is at the beginning of the entity."
2353 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2369 :begin begin
2370 :end end
2371 :use-brackets-p bracketsp
2375 "Interpret ENTITY object as Org syntax.
2376 CONTENTS is nil."
2382 "Search for the next latex-fragment or entity object.
2384 LIMIT bounds the search.
2386 Return value is a cons cell whose CAR is `entity' or
2387 `latex-fragment' and CDR is beginning position."
2391 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2398 limit t)
2401 ;; Determine if it's a real entity or a LaTeX command.
2404 ;; No entity nor command: point is at a LaTeX fragment.
2405 ;; Determine its type to get the correct beginning position.
2413 matchers)
2417 ;;;; Export Snippet
2420 "Parse export snippet at point.
2422 Return a list whose CAR is `export-snippet' and CDR a plist with
2423 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2424 keywords.
2426 Assume point is at the beginning of the snippet."
2438 :value value
2439 :begin begin
2440 :end end
2444 "Interpret EXPORT-SNIPPET object as Org syntax.
2445 CONTENTS is nil."
2451 "Search for the next export-snippet object.
2453 LIMIT bounds the search.
2455 Return value is a cons cell whose CAR is `export-snippet' and CDR
2456 its beginning position."
2465 ;;;; Footnote Reference
2468 "Parse footnote reference at point.
2470 Return a list whose CAR is `footnote-reference' and CDR a plist
2471 with `:label', `:type', `:inline-definition', `:begin', `:end'
2472 and `:post-blank' as keywords."
2494 :type type
2495 :begin begin
2496 :end end
2499 footnote-reference :inline-definition
2504 footnote-reference))))))
2507 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2508 CONTENTS is nil."
2518 "Search for the next footnote-reference object.
2520 LIMIT bounds the search.
2522 Return value is a cons cell whose CAR is `footnote-reference' and
2523 CDR is beginning position."
2537 ;;;; Inline Babel Call
2540 "Parse inline babel call at point.
2542 Return a list whose CAR is `inline-babel-call' and CDR a plist
2543 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2545 Assume point is at the beginning of the babel call."
2556 :end end
2557 :info info
2561 "Interpret INLINE-BABEL-CALL object as Org syntax.
2562 CONTENTS is nil."
2568 ;; Remove redundant square brackets.
2571 main-source)
2575 "Search for the next inline-babel-call object.
2577 LIMIT bounds the search.
2579 Return value is a cons cell whose CAR is `inline-babel-call' and
2580 CDR is beginning position."
2582 ;; Use a simplified version of
2583 ;; `org-babel-inline-lob-one-liner-regexp'.
2586 limit t)
2590 ;;;; Inline Src Block
2593 "Parse inline source block at point.
2595 LIMIT bounds the search.
2597 Return a list whose CAR is `inline-src-block' and CDR a plist
2598 with `:begin', `:end', `:language', `:value', `:parameters' and
2599 `:post-blank' as keywords.
2601 Assume point is at the beginning of the inline src block."
2614 :value value
2615 :parameters parameters
2616 :begin begin
2617 :end end
2621 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2622 CONTENTS is nil."
2627 language
2629 body)))
2632 "Search for the next inline-babel-call element.
2634 LIMIT bounds the search.
2636 Return value is a cons cell whose CAR is `inline-babel-call' and
2637 CDR is beginning position."
2643 ;;;; Italic
2646 "Parse italic object at point.
2648 Return a list whose CAR is `italic' and CDR is a plist with
2649 `:begin', `:end', `:contents-begin' and `:contents-end' and
2650 `:post-blank' keywords.
2652 Assume point is at the first slash marker."
2664 :end end
2665 :contents-begin contents-begin
2666 :contents-end contents-end
2670 "Interpret ITALIC object as Org syntax.
2671 CONTENTS is the contents of the object."
2675 ;;;; Latex Fragment
2678 "Parse latex fragment at point.
2680 Return a list whose CAR is `latex-fragment' and CDR a plist with
2681 `:value', `:begin', `:end', and `:post-blank' as keywords.
2683 Assume point is at the beginning of the latex fragment."
2697 ;; None found: it's a macro.
2706 :begin begin
2707 :end end
2711 "Interpret LATEX-FRAGMENT object as Org syntax.
2712 CONTENTS is nil."
2715 ;;;; Line Break
2718 "Parse line break at point.
2720 Return a list whose CAR is `line-break', and CDR a plist with
2721 `:begin', `:end' and `:post-blank' keywords.
2723 Assume point is at the beginning of the line break."
2727 "Interpret LINE-BREAK object as Org syntax.
2728 CONTENTS is nil."
2732 "Search for the next line-break object.
2734 LIMIT bounds the search.
2736 Return value is a cons cell whose CAR is `line-break' and CDR is
2737 beginning position."
2741 ;; A line break can only happen on a non-empty line.
2746 ;;;; Link
2749 "Parse link at point.
2751 Return a list whose CAR is `link' and CDR a plist with `:type',
2752 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2753 `:contents-end' and `:post-blank' as keywords.
2755 Assume point is at the beginning of the link."
2758 end contents-begin contents-end link-end post-blank path type
2759 raw-link link)
2761 ;; Type 1: Text targeted from a radio target.
2766 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2771 ;; RAW-LINK is the original link.
2776 ;; Determine TYPE of link and set PATH accordingly.
2778 ;; File type.
2781 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2784 ;; Id type: PATH is the id.
2787 ;; Code-ref type: PATH is the name of the reference.
2790 ;; Custom-id type: PATH is the name of the custom id.
2793 ;; Fuzzy type: Internal link either matches a target, an
2794 ;; headline name or nothing. PATH is the target or
2795 ;; headline's name.
2797 ;; Type 3: Plain link, i.e. http://orgmode.org
2803 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2810 ;; In any case, deduce end point after trailing white space from
2811 ;; LINK-END variable.
2816 :path path
2818 :begin begin
2819 :end end
2820 :contents-begin contents-begin
2821 :contents-end contents-end
2825 "Interpret LINK object as Org syntax.
2826 CONTENTS is the contents of the object, or nil."
2831 raw-link
2835 "Search for the next link object.
2837 LIMIT bounds the search.
2839 Return value is a cons cell whose CAR is `link' and CDR is
2840 beginning position."
2849 ;;;; Macro
2852 "Parse macro at point.
2854 Return a list whose CAR is `macro' and CDR a plist with `:key',
2855 `:args', `:begin', `:end', `:value' and `:post-blank' as
2856 keywords.
2858 Assume point is at the macro."
2872 ;; Repair bad splits.
2880 :value value
2881 :args args
2882 :begin begin
2883 :end end
2887 "Interpret MACRO object as Org syntax.
2888 CONTENTS is nil."
2892 "Search for the next macro object.
2894 LIMIT bounds the search.
2896 Return value is cons cell whose CAR is `macro' and CDR is
2897 beginning position."
2901 limit t)
2905 ;;;; Radio-target
2908 "Parse radio target at point.
2910 Return a list whose CAR is `radio-target' and CDR a plist with
2911 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2912 and `:post-blank' as keywords.
2914 Assume point is at the radio target."
2926 :end end
2927 :contents-begin contents-begin
2928 :contents-end contents-end
2929 :post-blank post-blank
2933 "Interpret TARGET object as Org syntax.
2934 CONTENTS is the contents of the object."
2938 "Search for the next radio-target object.
2940 LIMIT bounds the search.
2942 Return value is a cons cell whose CAR is `radio-target' and CDR
2943 is beginning position."
2949 ;;;; Statistics Cookie
2952 "Parse statistics cookie at point.
2954 Return a list whose CAR is `statistics-cookie', and CDR a plist
2955 with `:begin', `:end', `:value' and `:post-blank' keywords.
2957 Assume point is at the beginning of the statistics-cookie."
2968 :end end
2969 :value value
2973 "Interpret STATISTICS-COOKIE object as Org syntax.
2974 CONTENTS is nil."
2978 "Search for the next statistics cookie object.
2980 LIMIT bounds the search.
2982 Return value is a cons cell whose CAR is `statistics-cookie' and
2983 CDR is beginning position."
2989 ;;;; Strike-Through
2992 "Parse strike-through object at point.
2994 Return a list whose CAR is `strike-through' and CDR is a plist
2995 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2996 `:post-blank' keywords.
2998 Assume point is at the first plus sign marker."
3010 :end end
3011 :contents-begin contents-begin
3012 :contents-end contents-end
3016 "Interpret STRIKE-THROUGH object as Org syntax.
3017 CONTENTS is the contents of the object."
3021 ;;;; Subscript
3024 "Parse subscript at point.
3026 Return a list whose CAR is `subscript' and CDR a plist with
3027 `:begin', `:end', `:contents-begin', `:contents-end',
3028 `:use-brackets-p' and `:post-blank' as keywords.
3030 Assume point is at the underscore."
3034 t
3045 :end end
3046 :use-brackets-p bracketsp
3047 :contents-begin contents-begin
3048 :contents-end contents-end
3052 "Interpret SUBSCRIPT object as Org syntax.
3053 CONTENTS is the contents of the object."
3056 contents))
3059 "Search for the next sub/superscript object.
3061 LIMIT bounds the search.
3063 Return value is a cons cell whose CAR is either `subscript' or
3064 `superscript' and CDR is beginning position."
3071 ;;;; Superscript
3074 "Parse superscript at point.
3076 Return a list whose CAR is `superscript' and CDR a plist with
3077 `:begin', `:end', `:contents-begin', `:contents-end',
3078 `:use-brackets-p' and `:post-blank' as keywords.
3080 Assume point is at the caret."
3094 :end end
3095 :use-brackets-p bracketsp
3096 :contents-begin contents-begin
3097 :contents-end contents-end
3101 "Interpret SUPERSCRIPT object as Org syntax.
3102 CONTENTS is the contents of the object."
3105 contents))
3108 ;;;; Table Cell
3111 "Parse table cell at point.
3113 Return a list whose CAR is `table-cell' and CDR is a plist
3114 containing `:begin', `:end', `:contents-begin', `:contents-end'
3115 and `:post-blank' keywords."
3123 :end end
3124 :contents-begin contents-begin
3125 :contents-end contents-end
3129 "Interpret TABLE-CELL element as Org syntax.
3130 CONTENTS is the contents of the cell, or nil."
3134 "Search for the next table-cell object.
3136 LIMIT bounds the search.
3138 Return value is a cons cell whose CAR is `table-cell' and CDR is
3139 beginning position."
3143 ;;;; Target
3146 "Parse target at point.
3148 Return a list whose CAR is `target' and CDR a plist with
3149 `:begin', `:end', `:value' and `:post-blank' as keywords.
3151 Assume point is at the target."
3161 :end end
3162 :value value
3166 "Interpret TARGET object as Org syntax.
3167 CONTENTS is nil."
3171 "Search for the next target object.
3173 LIMIT bounds the search.
3175 Return value is a cons cell whose CAR is `target' and CDR is
3176 beginning position."
3182 ;;;; Timestamp
3185 "Parse time stamp at point.
3187 Return a list whose CAR is `timestamp', and CDR a plist with
3188 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3190 Assume point is at the beginning of the timestamp."
3209 :value main-value
3210 :range-end range-end
3211 :begin begin
3212 :end end
3216 "Interpret TIMESTAMP object as Org syntax.
3217 CONTENTS is nil."
3226 range-end)))))))
3229 "Search for the next timestamp object.
3231 LIMIT bounds the search.
3233 Return value is a cons cell whose CAR is `timestamp' and CDR is
3234 beginning position."
3242 limit t)
3246 ;;;; Underline
3249 "Parse underline object at point.
3251 Return a list whose CAR is `underline' and CDR is a plist with
3252 `:begin', `:end', `:contents-begin' and `:contents-end' and
3253 `:post-blank' keywords.
3255 Assume point is at the first underscore marker."
3267 :end end
3268 :contents-begin contents-begin
3269 :contents-end contents-end
3273 "Interpret UNDERLINE object as Org syntax.
3274 CONTENTS is the contents of the object."
3278 ;;;; Verbatim
3281 "Parse verbatim object at point.
3283 Return a list whose CAR is `verbatim' and CDR is a plist with
3284 `:value', `:begin', `:end' and `:post-blank' keywords.
3286 Assume point is at the first equal sign marker."
3297 :begin begin
3298 :end end
3302 "Interpret VERBATIM object as Org syntax.
3303 CONTENTS is nil."
3307 \f
3308 ;;; Parsing Element Starting At Point
3309 ;;
3310 ;; `org-element--current-element' is the core function of this section.
3311 ;; It returns the Lisp representation of the element starting at
3312 ;; point.
3313 ;;
3314 ;; `org-element--current-element' makes use of special modes. They
3315 ;; are activated for fixed element chaining (i.e. `plain-list' >
3316 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3317 ;; `section'). Special modes are: `first-section', `section',
3318 ;; `quote-section', `item' and `table-row'.
3322 "Parse the element starting at point.
3324 LIMIT bounds the search.
3326 Return value is a list like (TYPE PROPS) where TYPE is the type
3327 of the element and PROPS a plist of properties associated to the
3328 element.
3330 Possible types are defined in `org-element-all-elements'.
3332 Optional argument GRANULARITY determines the depth of the
3333 recursion. Allowed values are `headline', `greater-element',
3334 `element', `object' or nil. When it is broader than `object' (or
3335 nil), secondary values will not be parsed, since they only
3336 contain objects.
3338 Optional argument SPECIAL, when non-nil, can be either
3339 `first-section', `section', `quote-section', `table-row' and
3340 `item'.
3342 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3343 be computed.
3345 This function assumes point is always at the beginning of the
3346 element it has to parse."
3348 ;; If point is at an affiliated keyword, try moving to the
3349 ;; beginning of the associated element. If none is found, the
3350 ;; keyword is orphaned and will be treated as plain text.
3356 ;; Determine if parsing depth allows for secondary strings
3357 ;; parsing. It only applies to elements referenced in
3358 ;; `org-element-secondary-value-alist'.
3361 ;; Item.
3364 ;; Table Row.
3366 ;; Headline.
3369 ;; Sections (must be checked after headline).
3375 limit)))
3376 ;; When not at bol, point is at the beginning of an item or
3377 ;; a footnote definition: next item is always a paragraph.
3379 ;; Planning and Clock.
3384 ;; Inlinetask.
3387 ;; LaTeX Environment.
3393 nil t))
3396 ;; Drawer and Property Drawer.
3406 ;; Fixed Width
3409 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3410 ;; Keywords.
3419 org-element-block-name-alist)))
3434 ;; Footnote Definition.
3437 ;; Horizontal Rule.
3440 ;; Table.
3442 ;; List.
3445 ;; Default element: Paragraph.
3449 ;; Most elements can have affiliated keywords. When looking for an
3450 ;; element beginning, we want to move before them, as they belong to
3451 ;; that element, and, in the meantime, collect information they give
3452 ;; into appropriate properties. Hence the following function.
3453 ;;
3454 ;; Usage of optional arguments may not be obvious at first glance:
3455 ;;
3456 ;; - TRANS-LIST is used to polish keywords names that have evolved
3457 ;; during Org history. In example, even though =result= and
3458 ;; =results= coexist, we want to have them under the same =result=
3459 ;; property. It's also true for "srcname" and "name", where the
3460 ;; latter seems to be preferred nowadays (thus the "name" property).
3461 ;;
3462 ;; - CONSED allows to regroup multi-lines keywords under the same
3463 ;; property, while preserving their own identity. This is mostly
3464 ;; used for "attr_latex" and al.
3465 ;;
3466 ;; - PARSED prepares a keyword value for export. This is useful for
3467 ;; "caption". Objects restrictions for such keywords are defined in
3468 ;; `org-element-object-restrictions'.
3469 ;;
3470 ;; - DUALS is used to take care of keywords accepting a main and an
3471 ;; optional secondary values. For example "results" has its
3472 ;; source's name as the main value, and may have an hash string in
3473 ;; optional square brackets as the secondary one.
3474 ;;
3475 ;; A keyword may belong to more than one category.
3479 "Collect affiliated keywords before point.
3481 Optional argument KEY-RE is a regexp matching keywords, which
3482 puts matched keyword in group 1. It defaults to
3483 `org-element--affiliated-re'.
3485 TRANS-LIST is an alist where key is the keyword and value the
3486 property name it should be translated to, without the colons. It
3487 defaults to `org-element-keyword-translation-alist'.
3489 CONSED is a list of strings. Any keyword belonging to that list
3490 will have its value consed. The check is done after keyword
3491 translation. It defaults to `org-element-multiple-keywords'.
3493 PARSED is a list of strings. Any keyword member of this list
3494 will have its value parsed. The check is done after keyword
3495 translation. If a keyword is a member of both CONSED and PARSED,
3496 it's value will be a list of parsed strings. It defaults to
3497 `org-element-parsed-keywords'.
3499 DUALS is a list of strings. Any keyword member of this list can
3500 have two parts: one mandatory and one optional. Its value is
3501 a cons cell whose CAR is the former, and the CDR the latter. If
3502 a keyword is a member of both PARSED and DUALS, both values will
3503 be parsed. It defaults to `org-element-dual-keywords'.
3505 Return a list whose CAR is the position at the first of them and
3506 CDR a plist of keywords and values."
3514 ;; RESTRICT is the list of objects allowed in parsed
3515 ;; keywords value.
3517 output)
3521 ;; Apply translation to RAW-KWD. From there, KWD is
3522 ;; the official keyword.
3524 ;; Find main value for any keyword.
3530 ;; If KWD is a dual keyword, find its secondary
3531 ;; value. Maybe parse it.
3537 ;; Attribute a property name to KWD.
3539 ;; Now set final shape for VALUE.
3543 ;; VALUE is mandatory. Set it to nil if there is none.
3545 ;; Attributes are always consed.
3548 ;; Eventually store the new value in OUTPUT.
3554 \f
3555 ;;; The Org Parser
3556 ;;
3557 ;; The two major functions here are `org-element-parse-buffer', which
3558 ;; parses Org syntax inside the current buffer, taking into account
3559 ;; region, narrowing, or even visibility if specified, and
3560 ;; `org-element-parse-secondary-string', which parses objects within
3561 ;; a given string.
3562 ;;
3563 ;; The (almost) almighty `org-element-map' allows to apply a function
3564 ;; on elements or objects matching some type, and accumulate the
3565 ;; resulting values. In an export situation, it also skips unneeded
3566 ;; parts of the parse tree.
3569 "Recursively parse the buffer and return structure.
3570 If narrowing is in effect, only parse the visible part of the
3571 buffer.
3573 Optional argument GRANULARITY determines the depth of the
3574 recursion. It can be set to the following symbols:
3576 `headline' Only parse headlines.
3577 `greater-element' Don't recurse into greater elements excepted
3578 headlines and sections. Thus, elements
3579 parsed are the top-level ones.
3580 `element' Parse everything but objects and plain text.
3581 `object' Parse the complete buffer (default).
3583 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3584 elements.
3586 Assume buffer is in Org mode."
3592 ;; Start in `first-section' mode so text before the first
3593 ;; headline belongs to a section.
3597 "Recursively parse objects in STRING and return structure.
3599 RESTRICTION is a symbol limiting the object types that will be
3600 looked after.
3602 Optional argument PARENT, when non-nil, is the element or object
3603 containing the secondary string. It is used to set correctly
3604 `:parent' property within the string."
3610 secondary))))
3613 "Map a function on selected elements or objects.
3615 DATA is the parsed tree, as returned by, i.e,
3616 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3617 of elements or objects types. FUN is the function called on the
3618 matching element or object. It must accept one arguments: the
3619 element or object itself.
3621 When optional argument INFO is non-nil, it should be a plist
3622 holding export options. In that case, parts of the parse tree
3623 not exportable according to that property list will be skipped.
3625 When optional argument FIRST-MATCH is non-nil, stop at the first
3626 match for which FUN doesn't return nil, and return that value.
3628 Optional argument NO-RECURSION is a symbol or a list of symbols
3629 representing elements or objects types. `org-element-map' won't
3630 enter any recursive element or object whose type belongs to that
3631 list. Though, FUN can still be applied on them.
3633 Nil values returned from FUN do not appear in the results."
3634 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3637 ;; Recursion depth is determined by --CATEGORY.
3644 ;; If one object is found, the function
3645 ;; has to recurse into every object.
3648 ;; If one regular element is found, the
3649 ;; function has to recurse, at least,
3650 ;; into every element it encounters.
3653 types)
3654 category)))
3655 --acc
3656 --walk-tree
3660 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3661 ;; holding contextual information.
3665 ;; Ignored element in an export context.
3667 ;; Secondary string: only objects can be found there.
3670 ;; Unconditionally enter parse trees.
3674 ;; Check if TYPE is matching among TYPES. If so,
3675 ;; apply FUN to --DATA and accumulate return value
3676 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3682 ;; If --DATA has a secondary string that can contain
3683 ;; objects with their type among TYPES, look into it.
3690 ;; Determine if a recursion into --DATA is possible.
3692 ;; --TYPE is explicitly removed from recursion.
3694 ;; --DATA has no contents.
3696 ;; Looking for greater elements but --DATA is simply
3697 ;; an element or an object.
3700 ;; Looking for elements but --DATA is an object.
3703 ;; In any other case, map contents.
3707 ;; Return value in a proper order.
3710 ;; The following functions are internal parts of the parser.
3711 ;;
3712 ;; The first one, `org-element--parse-elements' acts at the element's
3713 ;; level.
3714 ;;
3715 ;; The second one, `org-element--parse-objects' applies on all objects
3716 ;; of a paragraph or a secondary string. It uses
3717 ;; `org-element--get-next-object-candidates' to optimize the search of
3718 ;; the next object in the buffer.
3719 ;;
3720 ;; More precisely, that function looks for every allowed object type
3721 ;; first. Then, it discards failed searches, keeps further matches,
3722 ;; and searches again types matched behind point, for subsequent
3723 ;; calls. Thus, searching for a given type fails only once, and every
3724 ;; object is searched only once at top level (but sometimes more for
3725 ;; nested types).
3729 "Parse elements between BEG and END positions.
3731 SPECIAL prioritize some elements over the others. It can be set
3732 to `first-section', `quote-section', `section' `item' or
3733 `table-row'.
3735 When value is `item', STRUCTURE will be used as the current list
3736 structure.
3738 GRANULARITY determines the depth of the recursion. See
3739 `org-element-parse-buffer' for more information.
3741 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3742 elements.
3744 Elements are accumulated into ACC."
3747 ;; When parsing only headlines, skip any text before first one.
3750 ;; Main loop start.
3752 ;; Find current element's type and parse it accordingly to
3753 ;; its category.
3755 end granularity special structure))
3759 ;; Fill ELEMENT contents by side-effect.
3761 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3762 ;; no contents, don't modify it.
3765 ;; Greater element: parse it between `contents-begin' and
3766 ;; `contents-end'. Make sure GRANULARITY allows the
3767 ;; recursion, or ELEMENT is an headline, in which case going
3768 ;; inside is mandatory, in order to get sub-level headings.
3776 ;; Possibly switch to a special mode.
3784 granularity visible-only element))
3785 ;; ELEMENT has contents. Parse objects inside, if
3786 ;; GRANULARITY allows it.
3792 ;; Return result.
3793 acc))
3796 "Parse objects between BEG and END and return recursive structure.
3798 Objects are accumulated in ACC.
3800 RESTRICTION is a list of object types which are allowed in the
3801 current object."
3807 end restriction candidates)))
3814 ;; 1. Text before any object. Untabify it.
3819 acc
3823 ;; 2. Object...
3826 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3827 ;; a recursive type.
3832 cont-beg
3839 ;; 3. Text after last object. Untabify it.
3843 acc
3847 ;; Result.
3848 acc)))
3851 "Return an alist of candidates for the next object.
3853 LIMIT bounds the search, and RESTRICTION narrows candidates to
3854 some object types.
3856 Return value is an alist whose CAR is position and CDR the object
3857 type, as a symbol.
3859 OBJECTS is the previous candidates alist."
3860 ;; Filter out any object found but not belonging to RESTRICTION.
3862 objects))
3864 ;; If no previous result, search every object type in RESTRICTION.
3865 ;; Otherwise, keep potential candidates (old objects located after
3866 ;; point) and ask to search again those which had matched before.
3871 objects))
3872 ;; Call the appropriate successor function for each type to search
3873 ;; and accumulate matches.
3880 type))))
3883 types-to-search)
3884 ;; Return alist.
3885 next-candidates))
3888 \f
3889 ;;; Towards A Bijective Process
3890 ;;
3891 ;; The parse tree obtained with `org-element-parse-buffer' is really
3892 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3893 ;; interpreted and expanded into a string with canonical Org syntax.
3894 ;; Hence `org-element-interpret-data'.
3895 ;;
3896 ;; The function relies internally on
3897 ;; `org-element--interpret-affiliated-keywords'.
3899 ;;;###autoload
3901 "Interpret DATA as Org syntax.
3903 DATA is a parse tree, an element, an object or a secondary string
3904 to interpret.
3906 Optional argument PARENT is used for recursive calls. It contains
3907 the element or object containing data, or nil.
3909 Return Org syntax as a string."
3913 ;; Secondary string.
3918 ;; Full Org document.
3923 ;; Plain text.
3925 ;; Element/Object without contents.
3928 data nil))
3929 ;; Element/Object with contents.
3939 ;; Elements directly containing objects must
3940 ;; have their indentation normalized first.
3942 data
3943 ;; When normalizing first paragraph of an
3944 ;; item or a footnote-definition, ignore
3945 ;; first line's indentation.
3952 data
3954 contents)))))))
3956 ;; Build white spaces. If no `:post-blank' property is
3957 ;; specified, assume its value is 0.
3967 "Return ELEMENT's affiliated keywords as Org syntax.
3968 If there is no affiliated keyword, return the empty string."
3978 ": "
3981 value)
3989 ;; All attribute keywords can have multiple lines.
3992 value
3995 ;; List all ELEMENT's properties matching an attribute line or an
3996 ;; affiliated keyword, but ignore translated keywords since they
3997 ;; cannot belong to the property list.
4004 org-element-keyword-translation-alist)))))
4005 collect prop)
4008 ;; Because interpretation of the parse tree must return the same
4009 ;; number of blank lines between elements and the same number of white
4010 ;; space after objects, some special care must be given to white
4011 ;; spaces.
4012 ;;
4013 ;; The first function, `org-element-normalize-string', ensures any
4014 ;; string different from the empty string will end with a single
4015 ;; newline character.
4016 ;;
4017 ;; The second function, `org-element-normalize-contents', removes
4018 ;; global indentation from the contents of the current element.
4021 "Ensure string S ends with a single newline character.
4023 If S isn't a string return it unchanged. If S is the empty
4024 string, return it. Otherwise, return a new string with a single
4025 newline character at its end."
4033 "Normalize plain text in ELEMENT's contents.
4035 ELEMENT must only contain plain text and objects.
4037 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4038 indentation to compute maximal common indentation.
4040 Return the normalized element that is element with global
4041 indentation removed from its contents. The function assumes that
4042 indentation is not done with TAB characters."
4044 collect-inds ; for byte-compiler
4047 ;; Return list of indentations within BLOB. This is done by
4048 ;; walking recursively BLOB and updating IND-LIST along the
4049 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4050 ;; been seen yet. It is required as this string is the only
4051 ;; one whose indentation doesn't happen after a newline
4052 ;; character.
4060 ;; An indentation of zero means no string will be
4061 ;; modified. Quit the process.
4067 ;; Avoid matching blank or empty lines.
4075 ;; Collect indentation list in ELEMENT. Possibly remove first
4076 ;; value if IGNORE-FIRST is non-nil.
4079 ;; Build ELEMENT back, replacing each string with the same
4080 ;; string minus common indentation.
4085 ;; Return BLOB with all its strings indentation
4086 ;; shortened from MCI white spaces. FIRST-FLAG is
4087 ;; non-nil when the first string hasn't been seen
4088 ;; yet.
4102 org-element-recursive-objects)
4106 blob))))
4110 \f
4111 ;;; The Toolbox
4112 ;;
4113 ;; The first move is to implement a way to obtain the smallest element
4114 ;; containing point. This is the job of `org-element-at-point'. It
4115 ;; basically jumps back to the beginning of section containing point
4116 ;; and moves, element after element, with
4117 ;; `org-element--current-element' until the container is found. Note:
4118 ;; When using `org-element-at-point', secondary values are never
4119 ;; parsed since the function focuses on elements, not on objects.
4120 ;;
4121 ;; At a deeper level, `org-element-context' lists all elements and
4122 ;; objects containing point.
4123 ;;
4124 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4125 ;; internally by navigation and manipulation tools.
4127 ;;;###autoload
4129 "Determine closest element around point.
4131 Return value is a list like (TYPE PROPS) where TYPE is the type
4132 of the element and PROPS a plist of properties associated to the
4133 element.
4135 Possible types are defined in `org-element-all-elements'.
4136 Properties depend on element or object type, but always
4137 include :begin, :end, :parent and :post-blank properties.
4139 As a special case, if point is at the very beginning of a list or
4140 sub-list, returned element will be that list instead of the first
4141 item. In the same way, if point is at the beginning of the first
4142 row of a table, returned element will be the table instead of the
4143 first row.
4145 If optional argument KEEP-TRAIL is non-nil, the function returns
4146 a list of of elements leading to element at point. The list's
4147 CAR is always the element at point. Following positions contain
4148 element's siblings, then parents, siblings of parents, until the
4149 first element of current section."
4151 ;; If at an headline, parse it. It is the sole element that
4152 ;; doesn't require to know about context. Be sure to disallow
4153 ;; secondary string parsing, though.
4159 ;; Otherwise move at the beginning of the section containing
4160 ;; point.
4164 element type special-flag trail struct prevs parent)
4172 ;; Parse successively each element, skipping those ending
4173 ;; before original position.
4182 ;; 1. Skip any element ending before point. Also skip
4183 ;; element ending at point when we're sure that another
4184 ;; element has started.
4189 ;; 2. An element containing point is always the element at
4190 ;; point.
4193 ;; 3. At any other greater element type, if point is
4194 ;; within contents, move into it.
4199 ;; Create an anchor for tables and plain lists:
4200 ;; when point is at the very beginning of these
4201 ;; elements, ignoring affiliated keywords,
4202 ;; target them instead of their contents.
4204 ;; When point is at contents end, do not move
4205 ;; into elements with an explicit ending, but
4206 ;; return that element instead.
4210 drawer dynamic-block inlinetask item
4211 plain-list quote-block special-block))))
4223 ;;;###autoload
4225 "Return closest element or object around point.
4227 Return value is a list like (TYPE PROPS) where TYPE is the type
4228 of the element or object and PROPS a plist of properties
4229 associated to it.
4231 Possible types are defined in `org-element-all-elements' and
4232 `org-element-all-objects'. Properties depend on element or
4233 object type, but always include :begin, :end, :parent
4234 and :post-blank properties."
4239 end)
4240 ;; Check if point is inside an element containing objects or at
4241 ;; a secondary string. In that case, move to beginning of the
4242 ;; element or secondary string and set END to the other side.
4251 (<= origin
4252 ;; `1+' is required so some
4253 ;; successors can match
4254 ;; properly their object.
4268 element
4271 candidates)
4274 end restriction candidates))
4276 candidates)))
4277 ;; If ORIGIN is before next object in element, there's
4278 ;; no point in looking further.
4287 ;; ORIGIN is after OBJECT, so skip it.
4290 ;; ORIGIN is within a non-recursive object or at an
4291 ;; object boundaries: Return that object.
4295 ;; Otherwise, move within current object and restrict
4296 ;; search to the end of its contents.
4301 end cend)))))))
4302 parent))))))
4305 "Non-nil when elements ELEM-A and ELEM-B are nested."
4314 "Swap elements ELEM-A and ELEM-B.
4315 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4316 end of ELEM-A."
4318 ;; There are two special cases when an element doesn't start at bol:
4319 ;; the first paragraph in an item or in a footnote definition.
4321 ;; Only a paragraph without any affiliated keyword can be moved at
4322 ;; ELEM-A position in such a situation. Note that the case of
4323 ;; a footnote definition is impossible: it cannot contain two
4324 ;; paragraphs in a row because it cannot contain a blank line.
4330 ;; In a special situation, ELEM-A will have no indentation. We'll
4331 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4345 ;; Store overlays responsible for visibility status. We
4346 ;; also need to store their boundaries as they will be
4347 ;; removed from buffer.
4354 ;; Get contents.
4362 ;; Restore ex ELEM-A overlays.
4371 ;; Restore ex ELEM-B overlays.
4380 ;; Local variables:
4381 ;; generated-autoload-file: "org-loaddefs.el"
4382 ;; End:
4384 ;;; org-element.el ends here