| blob | 21628b5029f2631c9eddd5759489c47d2dcee998 |
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.
1516 :end end
1517 :value value
1518 :switches switches
1519 :number-lines number-lines
1520 :preserve-indent preserve-indent
1521 :retain-labels retain-labels
1522 :use-labels use-labels
1523 :label-fmt label-fmt
1524 :hiddenp hidden
1529 "Interpret EXAMPLE-BLOCK element as Org syntax.
1530 CONTENTS is nil."
1538 ;;;; Export Block
1541 "Parse an export block.
1543 LIMIT bounds the search.
1545 Return a list whose CAR is `export-block' and CDR is a plist
1546 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1547 `:post-blank' keywords.
1549 Assume point is at export-block beginning."
1556 ;; Incomplete block: parse it as a paragraph.
1570 contents-end)))
1574 :end end
1575 :type type
1576 :value value
1577 :hiddenp hidden
1582 "Interpret EXPORT-BLOCK element as Org syntax.
1583 CONTENTS is nil."
1590 ;;;; Fixed-width
1593 "Parse a fixed-width section.
1595 LIMIT bounds the search.
1597 Return a list whose CAR is `fixed-width' and CDR is a plist
1598 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1600 Assume point is at the beginning of the fixed-width area."
1604 value
1609 ;; Accumulate text without starting colons.
1622 :end end
1623 :value value
1628 "Interpret FIXED-WIDTH element as Org syntax.
1629 CONTENTS is nil."
1634 ;;;; Horizontal Rule
1637 "Parse an horizontal rule.
1639 LIMIT bounds the search.
1641 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1642 containing `:begin', `:end' and `:post-blank' keywords."
1652 :end end
1657 "Interpret HORIZONTAL-RULE element as Org syntax.
1658 CONTENTS is nil."
1662 ;;;; Keyword
1665 "Parse a keyword at point.
1667 LIMIT bounds the search.
1669 Return a list whose CAR is `keyword' and CDR is a plist
1670 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1671 keywords."
1684 :value value
1685 :begin begin
1686 :end end
1690 "Interpret KEYWORD element as Org syntax.
1691 CONTENTS is nil."
1697 ;;;; Latex Environment
1700 "Parse a LaTeX environment.
1702 LIMIT bounds the search.
1704 Return a list whose CAR is `latex-environment' and CDR is a plist
1705 containing `:begin', `:end', `:value' and `:post-blank'
1706 keywords.
1708 Assume point is at the beginning of the latex environment."
1727 :end end
1728 :value value
1733 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1734 CONTENTS is nil."
1738 ;;;; Paragraph
1741 "Parse a paragraph.
1743 LIMIT bounds the search.
1745 Return a list whose CAR is `paragraph' and CDR is a plist
1746 containing `:begin', `:end', `:contents-begin' and
1747 `:contents-end' and `:post-blank' keywords.
1749 Assume point is at the beginning of the paragraph."
1752 ;; INNER-PAR-P is non-nil when paragraph is at the
1753 ;; beginning of an item or a footnote reference. In that
1754 ;; case, we mustn't look for affiliated keywords since they
1755 ;; belong to the container.
1765 limit
1766 ;; A matching `org-element-paragraph-separate' is not
1767 ;; necessarily the end of the paragraph. In
1768 ;; particular, lines starting with # or : as a first
1769 ;; non-space character are ambiguous. We have check
1770 ;; if they are valid Org syntax (i.e. not an
1771 ;; incomplete keyword).
1775 ;; There's no ambiguity for other symbols or
1776 ;; empty lines: stop here.
1778 ;; Stop at valid fixed-width areas.
1780 ;; Stop at drawers.
1785 ;; Stop at valid comments.
1787 ;; Stop at valid dynamic blocks.
1792 ;; Stop at valid blocks.
1799 limit t)))
1800 ;; Stop at valid latex environments.
1807 limit t)))
1808 ;; Stop at valid keywords.
1810 ;; Skip everything else.
1827 :end end
1828 :contents-begin contents-begin
1829 :contents-end contents-end
1834 "Interpret PARAGRAPH element as Org syntax.
1835 CONTENTS is the contents of the element."
1836 contents)
1839 ;;;; Planning
1842 "Parse a planning.
1844 LIMIT bounds the search.
1846 Return a list whose CAR is `planning' and CDR is a plist
1847 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1848 and `:post-blank' keywords."
1857 closed deadline scheduled)
1871 :deadline deadline
1872 :scheduled scheduled
1873 :begin begin
1874 :end end
1878 "Interpret PLANNING element as Org syntax.
1879 CONTENTS is nil."
1881 'identity
1893 ;;;; Property Drawer
1896 "Parse a property drawer.
1898 LIMIT bounds the search.
1900 Return a list whose CAR is `property-drawer' and CDR is a plist
1901 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1902 `:contents-end', `:properties' and `:post-blank' keywords.
1904 Assume point is at the beginning of the property drawer."
1918 val))
1920 val))
1928 :end end
1929 :hiddenp hidden
1930 :properties properties
1934 "Interpret PROPERTY-DRAWER element as Org syntax.
1935 CONTENTS is nil."
1945 ;;;; Quote Section
1948 "Parse a quote section.
1950 LIMIT bounds the search.
1952 Return a list whose CAR is `quote-section' and CDR is a plist
1953 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1955 Assume point is at beginning of the section."
1966 :end end
1967 :value value
1971 "Interpret QUOTE-SECTION element as Org syntax.
1972 CONTENTS is nil."
1976 ;;;; Src Block
1979 "Parse a src block.
1981 LIMIT bounds the search.
1983 Return a list whose CAR is `src-block' and CDR is a plist
1984 containing `:language', `:switches', `:parameters', `:begin',
1985 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1986 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1987 `:post-blank' keywords.
1989 Assume point is at the beginning of the block."
1992 limit t)))
1993 ;; Incomplete block: parse it as a paragraph.
1998 ;; Get beginning position.
2000 ;; Get language as a string.
2009 ;; Get switches.
2011 ;; Get parameters.
2013 ;; Switches analysis
2021 ;; Should labels be retained in (or stripped from)
2022 ;; src blocks?
2027 ;; What should code-references use - labels or
2028 ;; line-numbers?
2032 ;; Get visibility status.
2034 ;; Retrieve code.
2039 ;; Get position after ending blank lines.
2049 :begin begin
2050 :end end
2051 :number-lines number-lines
2052 :preserve-indent preserve-indent
2053 :retain-labels retain-labels
2054 :use-labels use-labels
2055 :label-fmt label-fmt
2056 :hiddenp hidden
2057 :value value
2062 "Interpret SRC-BLOCK element as Org syntax.
2063 CONTENTS is nil."
2083 value
2087 ;;;; Table
2090 "Parse a table at point.
2092 LIMIT bounds the search.
2094 Return a list whose CAR is `table' and CDR is a plist containing
2095 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2096 `:contents-end', `:value' and `:post-blank' keywords.
2098 Assume point is at the beginning of the table."
2110 acc))
2117 :end end
2118 :type type
2119 :tblfm tblfm
2120 ;; Only `org' tables have contents. `table.el' tables
2121 ;; use a `:value' property to store raw table as
2122 ;; a string.
2127 table-begin table-end))
2132 "Interpret TABLE element as Org syntax.
2133 CONTENTS is nil."
2144 ;;;; Table Row
2147 "Parse table row at point.
2149 LIMIT bounds the search.
2151 Return a list whose CAR is `table-row' and CDR is a plist
2152 containing `:begin', `:end', `:contents-begin', `:contents-end',
2153 `:type' and `:post-blank' keywords."
2157 ;; A table rule has no contents. In that case, ensure
2158 ;; CONTENTS-BEGIN matches CONTENTS-END.
2170 :begin begin
2171 :end end
2172 :contents-begin contents-begin
2173 :contents-end contents-end
2177 "Interpret TABLE-ROW element as Org syntax.
2178 CONTENTS is the contents of the table row."
2183 ;;;; Verse Block
2186 "Parse a verse block.
2188 LIMIT bounds the search.
2190 Return a list whose CAR is `verse-block' and CDR is a plist
2191 containing `:begin', `:end', `:contents-begin', `:contents-end',
2192 `:hiddenp' and `:post-blank' keywords.
2194 Assume point is at beginning of the block."
2198 ;; Incomplete block: parse it as a paragraph.
2214 :end end
2215 :contents-begin contents-begin
2216 :contents-end contents-end
2217 :hiddenp hidden
2222 "Interpret VERSE-BLOCK element as Org syntax.
2223 CONTENTS is verse block contents."
2227 \f
2228 ;;; Objects
2229 ;;
2230 ;; Unlike to elements, interstices can be found between objects.
2231 ;; That's why, along with the parser, successor functions are provided
2232 ;; for each object. Some objects share the same successor (i.e. `code'
2233 ;; and `verbatim' objects).
2234 ;;
2235 ;; A successor must accept a single argument bounding the search. It
2236 ;; will return either a cons cell whose CAR is the object's type, as
2237 ;; a symbol, and CDR the position of its next occurrence, or nil.
2238 ;;
2239 ;; Successors follow the naming convention:
2240 ;; org-element-NAME-successor, where NAME is the name of the
2241 ;; successor, as defined in `org-element-all-successors'.
2242 ;;
2243 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2244 ;; object types they can contain will be specified in
2245 ;; `org-element-object-restrictions'.
2246 ;;
2247 ;; Adding a new type of object is simple. Implement a successor,
2248 ;; a parser, and an interpreter for it, all following the naming
2249 ;; convention. Register type in `org-element-all-objects' and
2250 ;; successor in `org-element-all-successors'. Maybe tweak
2251 ;; restrictions about it, and that's it.
2254 ;;;; Bold
2257 "Parse bold object at point.
2259 Return a list whose CAR is `bold' and CDR is a plist with
2260 `:begin', `:end', `:contents-begin' and `:contents-end' and
2261 `:post-blank' keywords.
2263 Assume point is at the first star marker."
2275 :end end
2276 :contents-begin contents-begin
2277 :contents-end contents-end
2281 "Interpret BOLD object as Org syntax.
2282 CONTENTS is the contents of the object."
2286 "Search for the next text-markup object.
2288 LIMIT bounds the search.
2290 Return value is a cons cell whose CAR is a symbol among `bold',
2291 `italic', `underline', `strike-through', `code' and `verbatim'
2292 and CDR is beginning position."
2308 ;;;; Code
2311 "Parse code object at point.
2313 Return a list whose CAR is `code' and CDR is a plist with
2314 `:value', `:begin', `:end' and `:post-blank' keywords.
2316 Assume point is at the first tilde marker."
2327 :begin begin
2328 :end end
2332 "Interpret CODE object as Org syntax.
2333 CONTENTS is nil."
2337 ;;;; Entity
2340 "Parse entity at point.
2342 Return a list whose CAR is `entity' and CDR a plist with
2343 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2344 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2345 keywords.
2347 Assume point is at the beginning of the entity."
2349 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2365 :begin begin
2366 :end end
2367 :use-brackets-p bracketsp
2371 "Interpret ENTITY object as Org syntax.
2372 CONTENTS is nil."
2378 "Search for the next latex-fragment or entity object.
2380 LIMIT bounds the search.
2382 Return value is a cons cell whose CAR is `entity' or
2383 `latex-fragment' and CDR is beginning position."
2387 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2394 limit t)
2397 ;; Determine if it's a real entity or a LaTeX command.
2400 ;; No entity nor command: point is at a LaTeX fragment.
2401 ;; Determine its type to get the correct beginning position.
2409 matchers)
2413 ;;;; Export Snippet
2416 "Parse export snippet at point.
2418 Return a list whose CAR is `export-snippet' and CDR a plist with
2419 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2420 keywords.
2422 Assume point is at the beginning of the snippet."
2434 :value value
2435 :begin begin
2436 :end end
2440 "Interpret EXPORT-SNIPPET object as Org syntax.
2441 CONTENTS is nil."
2447 "Search for the next export-snippet object.
2449 LIMIT bounds the search.
2451 Return value is a cons cell whose CAR is `export-snippet' and CDR
2452 its beginning position."
2461 ;;;; Footnote Reference
2464 "Parse footnote reference at point.
2466 Return a list whose CAR is `footnote-reference' and CDR a plist
2467 with `:label', `:type', `:inline-definition', `:begin', `:end'
2468 and `:post-blank' as keywords."
2490 :type type
2491 :begin begin
2492 :end end
2495 footnote-reference :inline-definition
2500 footnote-reference))))))
2503 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2504 CONTENTS is nil."
2514 "Search for the next footnote-reference object.
2516 LIMIT bounds the search.
2518 Return value is a cons cell whose CAR is `footnote-reference' and
2519 CDR is beginning position."
2533 ;;;; Inline Babel Call
2536 "Parse inline babel call at point.
2538 Return a list whose CAR is `inline-babel-call' and CDR a plist
2539 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2541 Assume point is at the beginning of the babel call."
2552 :end end
2553 :info info
2557 "Interpret INLINE-BABEL-CALL object as Org syntax.
2558 CONTENTS is nil."
2564 ;; Remove redundant square brackets.
2567 main-source)
2571 "Search for the next inline-babel-call object.
2573 LIMIT bounds the search.
2575 Return value is a cons cell whose CAR is `inline-babel-call' and
2576 CDR is beginning position."
2578 ;; Use a simplified version of
2579 ;; `org-babel-inline-lob-one-liner-regexp'.
2582 limit t)
2586 ;;;; Inline Src Block
2589 "Parse inline source block at point.
2591 LIMIT bounds the search.
2593 Return a list whose CAR is `inline-src-block' and CDR a plist
2594 with `:begin', `:end', `:language', `:value', `:parameters' and
2595 `:post-blank' as keywords.
2597 Assume point is at the beginning of the inline src block."
2610 :value value
2611 :parameters parameters
2612 :begin begin
2613 :end end
2617 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2618 CONTENTS is nil."
2623 language
2625 body)))
2628 "Search for the next inline-babel-call element.
2630 LIMIT bounds the search.
2632 Return value is a cons cell whose CAR is `inline-babel-call' and
2633 CDR is beginning position."
2639 ;;;; Italic
2642 "Parse italic object at point.
2644 Return a list whose CAR is `italic' and CDR is a plist with
2645 `:begin', `:end', `:contents-begin' and `:contents-end' and
2646 `:post-blank' keywords.
2648 Assume point is at the first slash marker."
2660 :end end
2661 :contents-begin contents-begin
2662 :contents-end contents-end
2666 "Interpret ITALIC object as Org syntax.
2667 CONTENTS is the contents of the object."
2671 ;;;; Latex Fragment
2674 "Parse latex fragment at point.
2676 Return a list whose CAR is `latex-fragment' and CDR a plist with
2677 `:value', `:begin', `:end', and `:post-blank' as keywords.
2679 Assume point is at the beginning of the latex fragment."
2693 ;; None found: it's a macro.
2702 :begin begin
2703 :end end
2707 "Interpret LATEX-FRAGMENT object as Org syntax.
2708 CONTENTS is nil."
2711 ;;;; Line Break
2714 "Parse line break at point.
2716 Return a list whose CAR is `line-break', and CDR a plist with
2717 `:begin', `:end' and `:post-blank' keywords.
2719 Assume point is at the beginning of the line break."
2723 "Interpret LINE-BREAK object as Org syntax.
2724 CONTENTS is nil."
2728 "Search for the next line-break object.
2730 LIMIT bounds the search.
2732 Return value is a cons cell whose CAR is `line-break' and CDR is
2733 beginning position."
2737 ;; A line break can only happen on a non-empty line.
2742 ;;;; Link
2745 "Parse link at point.
2747 Return a list whose CAR is `link' and CDR a plist with `:type',
2748 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2749 `:contents-end' and `:post-blank' as keywords.
2751 Assume point is at the beginning of the link."
2754 end contents-begin contents-end link-end post-blank path type
2755 raw-link link)
2757 ;; Type 1: Text targeted from a radio target.
2762 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2767 ;; RAW-LINK is the original link.
2772 ;; Determine TYPE of link and set PATH accordingly.
2774 ;; File type.
2777 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2780 ;; Id type: PATH is the id.
2783 ;; Code-ref type: PATH is the name of the reference.
2786 ;; Custom-id type: PATH is the name of the custom id.
2789 ;; Fuzzy type: Internal link either matches a target, an
2790 ;; headline name or nothing. PATH is the target or
2791 ;; headline's name.
2793 ;; Type 3: Plain link, i.e. http://orgmode.org
2799 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2806 ;; In any case, deduce end point after trailing white space from
2807 ;; LINK-END variable.
2812 :path path
2814 :begin begin
2815 :end end
2816 :contents-begin contents-begin
2817 :contents-end contents-end
2821 "Interpret LINK object as Org syntax.
2822 CONTENTS is the contents of the object, or nil."
2827 raw-link
2831 "Search for the next link object.
2833 LIMIT bounds the search.
2835 Return value is a cons cell whose CAR is `link' and CDR is
2836 beginning position."
2845 ;;;; Macro
2848 "Parse macro at point.
2850 Return a list whose CAR is `macro' and CDR a plist with `:key',
2851 `:args', `:begin', `:end', `:value' and `:post-blank' as
2852 keywords.
2854 Assume point is at the macro."
2868 ;; Repair bad splits.
2876 :value value
2877 :args args
2878 :begin begin
2879 :end end
2883 "Interpret MACRO object as Org syntax.
2884 CONTENTS is nil."
2888 "Search for the next macro object.
2890 LIMIT bounds the search.
2892 Return value is cons cell whose CAR is `macro' and CDR is
2893 beginning position."
2897 limit t)
2901 ;;;; Radio-target
2904 "Parse radio target at point.
2906 Return a list whose CAR is `radio-target' and CDR a plist with
2907 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2908 and `:post-blank' as keywords.
2910 Assume point is at the radio target."
2922 :end end
2923 :contents-begin contents-begin
2924 :contents-end contents-end
2925 :post-blank post-blank
2929 "Interpret TARGET object as Org syntax.
2930 CONTENTS is the contents of the object."
2934 "Search for the next radio-target object.
2936 LIMIT bounds the search.
2938 Return value is a cons cell whose CAR is `radio-target' and CDR
2939 is beginning position."
2945 ;;;; Statistics Cookie
2948 "Parse statistics cookie at point.
2950 Return a list whose CAR is `statistics-cookie', and CDR a plist
2951 with `:begin', `:end', `:value' and `:post-blank' keywords.
2953 Assume point is at the beginning of the statistics-cookie."
2964 :end end
2965 :value value
2969 "Interpret STATISTICS-COOKIE object as Org syntax.
2970 CONTENTS is nil."
2974 "Search for the next statistics cookie object.
2976 LIMIT bounds the search.
2978 Return value is a cons cell whose CAR is `statistics-cookie' and
2979 CDR is beginning position."
2985 ;;;; Strike-Through
2988 "Parse strike-through object at point.
2990 Return a list whose CAR is `strike-through' and CDR is a plist
2991 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2992 `:post-blank' keywords.
2994 Assume point is at the first plus sign marker."
3006 :end end
3007 :contents-begin contents-begin
3008 :contents-end contents-end
3012 "Interpret STRIKE-THROUGH object as Org syntax.
3013 CONTENTS is the contents of the object."
3017 ;;;; Subscript
3020 "Parse subscript at point.
3022 Return a list whose CAR is `subscript' and CDR a plist with
3023 `:begin', `:end', `:contents-begin', `:contents-end',
3024 `:use-brackets-p' and `:post-blank' as keywords.
3026 Assume point is at the underscore."
3030 t
3041 :end end
3042 :use-brackets-p bracketsp
3043 :contents-begin contents-begin
3044 :contents-end contents-end
3048 "Interpret SUBSCRIPT object as Org syntax.
3049 CONTENTS is the contents of the object."
3052 contents))
3055 "Search for the next sub/superscript object.
3057 LIMIT bounds the search.
3059 Return value is a cons cell whose CAR is either `subscript' or
3060 `superscript' and CDR is beginning position."
3067 ;;;; Superscript
3070 "Parse superscript at point.
3072 Return a list whose CAR is `superscript' and CDR a plist with
3073 `:begin', `:end', `:contents-begin', `:contents-end',
3074 `:use-brackets-p' and `:post-blank' as keywords.
3076 Assume point is at the caret."
3090 :end end
3091 :use-brackets-p bracketsp
3092 :contents-begin contents-begin
3093 :contents-end contents-end
3097 "Interpret SUPERSCRIPT object as Org syntax.
3098 CONTENTS is the contents of the object."
3101 contents))
3104 ;;;; Table Cell
3107 "Parse table cell at point.
3109 Return a list whose CAR is `table-cell' and CDR is a plist
3110 containing `:begin', `:end', `:contents-begin', `:contents-end'
3111 and `:post-blank' keywords."
3119 :end end
3120 :contents-begin contents-begin
3121 :contents-end contents-end
3125 "Interpret TABLE-CELL element as Org syntax.
3126 CONTENTS is the contents of the cell, or nil."
3130 "Search for the next table-cell object.
3132 LIMIT bounds the search.
3134 Return value is a cons cell whose CAR is `table-cell' and CDR is
3135 beginning position."
3139 ;;;; Target
3142 "Parse target at point.
3144 Return a list whose CAR is `target' and CDR a plist with
3145 `:begin', `:end', `:value' and `:post-blank' as keywords.
3147 Assume point is at the target."
3157 :end end
3158 :value value
3162 "Interpret TARGET object as Org syntax.
3163 CONTENTS is nil."
3167 "Search for the next target object.
3169 LIMIT bounds the search.
3171 Return value is a cons cell whose CAR is `target' and CDR is
3172 beginning position."
3178 ;;;; Timestamp
3181 "Parse time stamp at point.
3183 Return a list whose CAR is `timestamp', and CDR a plist with
3184 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3186 Assume point is at the beginning of the timestamp."
3205 :value main-value
3206 :range-end range-end
3207 :begin begin
3208 :end end
3212 "Interpret TIMESTAMP object as Org syntax.
3213 CONTENTS is nil."
3222 range-end)))))))
3225 "Search for the next timestamp object.
3227 LIMIT bounds the search.
3229 Return value is a cons cell whose CAR is `timestamp' and CDR is
3230 beginning position."
3238 limit t)
3242 ;;;; Underline
3245 "Parse underline object at point.
3247 Return a list whose CAR is `underline' and CDR is a plist with
3248 `:begin', `:end', `:contents-begin' and `:contents-end' and
3249 `:post-blank' keywords.
3251 Assume point is at the first underscore marker."
3263 :end end
3264 :contents-begin contents-begin
3265 :contents-end contents-end
3269 "Interpret UNDERLINE object as Org syntax.
3270 CONTENTS is the contents of the object."
3274 ;;;; Verbatim
3277 "Parse verbatim object at point.
3279 Return a list whose CAR is `verbatim' and CDR is a plist with
3280 `:value', `:begin', `:end' and `:post-blank' keywords.
3282 Assume point is at the first equal sign marker."
3293 :begin begin
3294 :end end
3298 "Interpret VERBATIM object as Org syntax.
3299 CONTENTS is nil."
3303 \f
3304 ;;; Parsing Element Starting At Point
3305 ;;
3306 ;; `org-element--current-element' is the core function of this section.
3307 ;; It returns the Lisp representation of the element starting at
3308 ;; point.
3309 ;;
3310 ;; `org-element--current-element' makes use of special modes. They
3311 ;; are activated for fixed element chaining (i.e. `plain-list' >
3312 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3313 ;; `section'). Special modes are: `first-section', `section',
3314 ;; `quote-section', `item' and `table-row'.
3318 "Parse the element starting at point.
3320 LIMIT bounds the search.
3322 Return value is a list like (TYPE PROPS) where TYPE is the type
3323 of the element and PROPS a plist of properties associated to the
3324 element.
3326 Possible types are defined in `org-element-all-elements'.
3328 Optional argument GRANULARITY determines the depth of the
3329 recursion. Allowed values are `headline', `greater-element',
3330 `element', `object' or nil. When it is broader than `object' (or
3331 nil), secondary values will not be parsed, since they only
3332 contain objects.
3334 Optional argument SPECIAL, when non-nil, can be either
3335 `first-section', `section', `quote-section', `table-row' and
3336 `item'.
3338 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3339 be computed.
3341 This function assumes point is always at the beginning of the
3342 element it has to parse."
3344 ;; If point is at an affiliated keyword, try moving to the
3345 ;; beginning of the associated element. If none is found, the
3346 ;; keyword is orphaned and will be treated as plain text.
3352 ;; Determine if parsing depth allows for secondary strings
3353 ;; parsing. It only applies to elements referenced in
3354 ;; `org-element-secondary-value-alist'.
3357 ;; Item.
3360 ;; Table Row.
3362 ;; Headline.
3365 ;; Sections (must be checked after headline).
3371 limit)))
3372 ;; When not at bol, point is at the beginning of an item or
3373 ;; a footnote definition: next item is always a paragraph.
3375 ;; Planning and Clock.
3380 ;; Inlinetask.
3383 ;; LaTeX Environment.
3389 nil t))
3392 ;; Drawer and Property Drawer.
3402 ;; Fixed Width
3405 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3406 ;; Keywords.
3415 org-element-block-name-alist)))
3430 ;; Footnote Definition.
3433 ;; Horizontal Rule.
3436 ;; Table.
3438 ;; List.
3441 ;; Default element: Paragraph.
3445 ;; Most elements can have affiliated keywords. When looking for an
3446 ;; element beginning, we want to move before them, as they belong to
3447 ;; that element, and, in the meantime, collect information they give
3448 ;; into appropriate properties. Hence the following function.
3449 ;;
3450 ;; Usage of optional arguments may not be obvious at first glance:
3451 ;;
3452 ;; - TRANS-LIST is used to polish keywords names that have evolved
3453 ;; during Org history. In example, even though =result= and
3454 ;; =results= coexist, we want to have them under the same =result=
3455 ;; property. It's also true for "srcname" and "name", where the
3456 ;; latter seems to be preferred nowadays (thus the "name" property).
3457 ;;
3458 ;; - CONSED allows to regroup multi-lines keywords under the same
3459 ;; property, while preserving their own identity. This is mostly
3460 ;; used for "attr_latex" and al.
3461 ;;
3462 ;; - PARSED prepares a keyword value for export. This is useful for
3463 ;; "caption". Objects restrictions for such keywords are defined in
3464 ;; `org-element-object-restrictions'.
3465 ;;
3466 ;; - DUALS is used to take care of keywords accepting a main and an
3467 ;; optional secondary values. For example "results" has its
3468 ;; source's name as the main value, and may have an hash string in
3469 ;; optional square brackets as the secondary one.
3470 ;;
3471 ;; A keyword may belong to more than one category.
3475 "Collect affiliated keywords before point.
3477 Optional argument KEY-RE is a regexp matching keywords, which
3478 puts matched keyword in group 1. It defaults to
3479 `org-element--affiliated-re'.
3481 TRANS-LIST is an alist where key is the keyword and value the
3482 property name it should be translated to, without the colons. It
3483 defaults to `org-element-keyword-translation-alist'.
3485 CONSED is a list of strings. Any keyword belonging to that list
3486 will have its value consed. The check is done after keyword
3487 translation. It defaults to `org-element-multiple-keywords'.
3489 PARSED is a list of strings. Any keyword member of this list
3490 will have its value parsed. The check is done after keyword
3491 translation. If a keyword is a member of both CONSED and PARSED,
3492 it's value will be a list of parsed strings. It defaults to
3493 `org-element-parsed-keywords'.
3495 DUALS is a list of strings. Any keyword member of this list can
3496 have two parts: one mandatory and one optional. Its value is
3497 a cons cell whose CAR is the former, and the CDR the latter. If
3498 a keyword is a member of both PARSED and DUALS, both values will
3499 be parsed. It defaults to `org-element-dual-keywords'.
3501 Return a list whose CAR is the position at the first of them and
3502 CDR a plist of keywords and values."
3510 ;; RESTRICT is the list of objects allowed in parsed
3511 ;; keywords value.
3513 output)
3517 ;; Apply translation to RAW-KWD. From there, KWD is
3518 ;; the official keyword.
3520 ;; Find main value for any keyword.
3526 ;; If KWD is a dual keyword, find its secondary
3527 ;; value. Maybe parse it.
3533 ;; Attribute a property name to KWD.
3535 ;; Now set final shape for VALUE.
3539 ;; VALUE is mandatory. Set it to nil if there is none.
3541 ;; Attributes are always consed.
3544 ;; Eventually store the new value in OUTPUT.
3550 \f
3551 ;;; The Org Parser
3552 ;;
3553 ;; The two major functions here are `org-element-parse-buffer', which
3554 ;; parses Org syntax inside the current buffer, taking into account
3555 ;; region, narrowing, or even visibility if specified, and
3556 ;; `org-element-parse-secondary-string', which parses objects within
3557 ;; a given string.
3558 ;;
3559 ;; The (almost) almighty `org-element-map' allows to apply a function
3560 ;; on elements or objects matching some type, and accumulate the
3561 ;; resulting values. In an export situation, it also skips unneeded
3562 ;; parts of the parse tree.
3565 "Recursively parse the buffer and return structure.
3566 If narrowing is in effect, only parse the visible part of the
3567 buffer.
3569 Optional argument GRANULARITY determines the depth of the
3570 recursion. It can be set to the following symbols:
3572 `headline' Only parse headlines.
3573 `greater-element' Don't recurse into greater elements excepted
3574 headlines and sections. Thus, elements
3575 parsed are the top-level ones.
3576 `element' Parse everything but objects and plain text.
3577 `object' Parse the complete buffer (default).
3579 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3580 elements.
3582 Assume buffer is in Org mode."
3588 ;; Start in `first-section' mode so text before the first
3589 ;; headline belongs to a section.
3593 "Recursively parse objects in STRING and return structure.
3595 RESTRICTION is a symbol limiting the object types that will be
3596 looked after.
3598 Optional argument PARENT, when non-nil, is the element or object
3599 containing the secondary string. It is used to set correctly
3600 `:parent' property within the string."
3606 secondary))))
3609 "Map a function on selected elements or objects.
3611 DATA is the parsed tree, as returned by, i.e,
3612 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3613 of elements or objects types. FUN is the function called on the
3614 matching element or object. It must accept one arguments: the
3615 element or object itself.
3617 When optional argument INFO is non-nil, it should be a plist
3618 holding export options. In that case, parts of the parse tree
3619 not exportable according to that property list will be skipped.
3621 When optional argument FIRST-MATCH is non-nil, stop at the first
3622 match for which FUN doesn't return nil, and return that value.
3624 Optional argument NO-RECURSION is a symbol or a list of symbols
3625 representing elements or objects types. `org-element-map' won't
3626 enter any recursive element or object whose type belongs to that
3627 list. Though, FUN can still be applied on them.
3629 Nil values returned from FUN do not appear in the results."
3630 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3633 ;; Recursion depth is determined by --CATEGORY.
3640 ;; If one object is found, the function
3641 ;; has to recurse into every object.
3644 ;; If one regular element is found, the
3645 ;; function has to recurse, at least,
3646 ;; into every element it encounters.
3649 types)
3650 category)))
3651 --acc
3652 --walk-tree
3656 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3657 ;; holding contextual information.
3661 ;; Ignored element in an export context.
3663 ;; Secondary string: only objects can be found there.
3666 ;; Unconditionally enter parse trees.
3670 ;; Check if TYPE is matching among TYPES. If so,
3671 ;; apply FUN to --DATA and accumulate return value
3672 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3678 ;; If --DATA has a secondary string that can contain
3679 ;; objects with their type among TYPES, look into it.
3686 ;; Determine if a recursion into --DATA is possible.
3688 ;; --TYPE is explicitly removed from recursion.
3690 ;; --DATA has no contents.
3692 ;; Looking for greater elements but --DATA is simply
3693 ;; an element or an object.
3696 ;; Looking for elements but --DATA is an object.
3699 ;; In any other case, map contents.
3703 ;; Return value in a proper order.
3706 ;; The following functions are internal parts of the parser.
3707 ;;
3708 ;; The first one, `org-element--parse-elements' acts at the element's
3709 ;; level.
3710 ;;
3711 ;; The second one, `org-element--parse-objects' applies on all objects
3712 ;; of a paragraph or a secondary string. It uses
3713 ;; `org-element--get-next-object-candidates' to optimize the search of
3714 ;; the next object in the buffer.
3715 ;;
3716 ;; More precisely, that function looks for every allowed object type
3717 ;; first. Then, it discards failed searches, keeps further matches,
3718 ;; and searches again types matched behind point, for subsequent
3719 ;; calls. Thus, searching for a given type fails only once, and every
3720 ;; object is searched only once at top level (but sometimes more for
3721 ;; nested types).
3725 "Parse elements between BEG and END positions.
3727 SPECIAL prioritize some elements over the others. It can be set
3728 to `first-section', `quote-section', `section' `item' or
3729 `table-row'.
3731 When value is `item', STRUCTURE will be used as the current list
3732 structure.
3734 GRANULARITY determines the depth of the recursion. See
3735 `org-element-parse-buffer' for more information.
3737 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3738 elements.
3740 Elements are accumulated into ACC."
3743 ;; When parsing only headlines, skip any text before first one.
3746 ;; Main loop start.
3748 ;; Find current element's type and parse it accordingly to
3749 ;; its category.
3751 end granularity special structure))
3755 ;; Fill ELEMENT contents by side-effect.
3757 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3758 ;; no contents, don't modify it.
3761 ;; Greater element: parse it between `contents-begin' and
3762 ;; `contents-end'. Make sure GRANULARITY allows the
3763 ;; recursion, or ELEMENT is an headline, in which case going
3764 ;; inside is mandatory, in order to get sub-level headings.
3772 ;; Possibly switch to a special mode.
3780 granularity visible-only element))
3781 ;; ELEMENT has contents. Parse objects inside, if
3782 ;; GRANULARITY allows it.
3788 ;; Return result.
3789 acc))
3792 "Parse objects between BEG and END and return recursive structure.
3794 Objects are accumulated in ACC.
3796 RESTRICTION is a list of object types which are allowed in the
3797 current object."
3803 end restriction candidates)))
3810 ;; 1. Text before any object. Untabify it.
3815 acc
3819 ;; 2. Object...
3822 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3823 ;; a recursive type.
3828 cont-beg
3835 ;; 3. Text after last object. Untabify it.
3839 acc
3843 ;; Result.
3844 acc)))
3847 "Return an alist of candidates for the next object.
3849 LIMIT bounds the search, and RESTRICTION narrows candidates to
3850 some object types.
3852 Return value is an alist whose CAR is position and CDR the object
3853 type, as a symbol.
3855 OBJECTS is the previous candidates alist."
3857 ;; If no previous result, search every object type in RESTRICTION.
3858 ;; Otherwise, keep potential candidates (old objects located after
3859 ;; point) and ask to search again those which had matched before.
3864 objects))
3865 ;; Call the appropriate successor function for each type to search
3866 ;; and accumulate matches.
3873 type))))
3876 types-to-search)
3877 ;; Return alist.
3878 next-candidates))
3881 \f
3882 ;;; Towards A Bijective Process
3883 ;;
3884 ;; The parse tree obtained with `org-element-parse-buffer' is really
3885 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3886 ;; interpreted and expanded into a string with canonical Org syntax.
3887 ;; Hence `org-element-interpret-data'.
3888 ;;
3889 ;; The function relies internally on
3890 ;; `org-element--interpret-affiliated-keywords'.
3892 ;;;###autoload
3894 "Interpret DATA as Org syntax.
3896 DATA is a parse tree, an element, an object or a secondary string
3897 to interpret.
3899 Optional argument PARENT is used for recursive calls. It contains
3900 the element or object containing data, or nil.
3902 Return Org syntax as a string."
3906 ;; Secondary string.
3911 ;; Full Org document.
3916 ;; Plain text.
3918 ;; Element/Object without contents.
3921 data nil))
3922 ;; Element/Object with contents.
3932 ;; Elements directly containing objects must
3933 ;; have their indentation normalized first.
3935 data
3936 ;; When normalizing first paragraph of an
3937 ;; item or a footnote-definition, ignore
3938 ;; first line's indentation.
3945 data
3947 contents)))))))
3949 ;; Build white spaces. If no `:post-blank' property is
3950 ;; specified, assume its value is 0.
3960 "Return ELEMENT's affiliated keywords as Org syntax.
3961 If there is no affiliated keyword, return the empty string."
3971 ": "
3974 value)
3982 ;; All attribute keywords can have multiple lines.
3985 value
3988 ;; List all ELEMENT's properties matching an attribute line or an
3989 ;; affiliated keyword, but ignore translated keywords since they
3990 ;; cannot belong to the property list.
3997 org-element-keyword-translation-alist)))))
3998 collect prop)
4001 ;; Because interpretation of the parse tree must return the same
4002 ;; number of blank lines between elements and the same number of white
4003 ;; space after objects, some special care must be given to white
4004 ;; spaces.
4005 ;;
4006 ;; The first function, `org-element-normalize-string', ensures any
4007 ;; string different from the empty string will end with a single
4008 ;; newline character.
4009 ;;
4010 ;; The second function, `org-element-normalize-contents', removes
4011 ;; global indentation from the contents of the current element.
4014 "Ensure string S ends with a single newline character.
4016 If S isn't a string return it unchanged. If S is the empty
4017 string, return it. Otherwise, return a new string with a single
4018 newline character at its end."
4026 "Normalize plain text in ELEMENT's contents.
4028 ELEMENT must only contain plain text and objects.
4030 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4031 indentation to compute maximal common indentation.
4033 Return the normalized element that is element with global
4034 indentation removed from its contents. The function assumes that
4035 indentation is not done with TAB characters."
4037 collect-inds ; for byte-compiler
4040 ;; Return list of indentations within BLOB. This is done by
4041 ;; walking recursively BLOB and updating IND-LIST along the
4042 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4043 ;; been seen yet. It is required as this string is the only
4044 ;; one whose indentation doesn't happen after a newline
4045 ;; character.
4053 ;; An indentation of zero means no string will be
4054 ;; modified. Quit the process.
4060 ;; Avoid matching blank or empty lines.
4068 ;; Collect indentation list in ELEMENT. Possibly remove first
4069 ;; value if IGNORE-FIRST is non-nil.
4072 ;; Build ELEMENT back, replacing each string with the same
4073 ;; string minus common indentation.
4078 ;; Return BLOB with all its strings indentation
4079 ;; shortened from MCI white spaces. FIRST-FLAG is
4080 ;; non-nil when the first string hasn't been seen
4081 ;; yet.
4095 org-element-recursive-objects)
4099 blob))))
4103 \f
4104 ;;; The Toolbox
4105 ;;
4106 ;; The first move is to implement a way to obtain the smallest element
4107 ;; containing point. This is the job of `org-element-at-point'. It
4108 ;; basically jumps back to the beginning of section containing point
4109 ;; and moves, element after element, with
4110 ;; `org-element--current-element' until the container is found. Note:
4111 ;; When using `org-element-at-point', secondary values are never
4112 ;; parsed since the function focuses on elements, not on objects.
4113 ;;
4114 ;; At a deeper level, `org-element-context' lists all elements and
4115 ;; objects containing point.
4116 ;;
4117 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4118 ;; internally by navigation and manipulation tools.
4120 ;;;###autoload
4122 "Determine closest element around point.
4124 Return value is a list like (TYPE PROPS) where TYPE is the type
4125 of the element and PROPS a plist of properties associated to the
4126 element.
4128 Possible types are defined in `org-element-all-elements'.
4129 Properties depend on element or object type, but always
4130 include :begin, :end, :parent and :post-blank properties.
4132 As a special case, if point is at the very beginning of a list or
4133 sub-list, returned element will be that list instead of the first
4134 item. In the same way, if point is at the beginning of the first
4135 row of a table, returned element will be the table instead of the
4136 first row.
4138 If optional argument KEEP-TRAIL is non-nil, the function returns
4139 a list of of elements leading to element at point. The list's
4140 CAR is always the element at point. Following positions contain
4141 element's siblings, then parents, siblings of parents, until the
4142 first element of current section."
4144 ;; If at an headline, parse it. It is the sole element that
4145 ;; doesn't require to know about context. Be sure to disallow
4146 ;; secondary string parsing, though.
4152 ;; Otherwise move at the beginning of the section containing
4153 ;; point.
4157 element type special-flag trail struct prevs parent)
4165 ;; Parse successively each element, skipping those ending
4166 ;; before original position.
4175 ;; 1. Skip any element ending before point. Also skip
4176 ;; element ending at point when we're sure that another
4177 ;; element has started.
4182 ;; 2. An element containing point is always the element at
4183 ;; point.
4186 ;; 3. At any other greater element type, if point is
4187 ;; within contents, move into it.
4192 ;; Create an anchor for tables and plain lists:
4193 ;; when point is at the very beginning of these
4194 ;; elements, ignoring affiliated keywords,
4195 ;; target them instead of their contents.
4197 ;; When point is at contents end, do not move
4198 ;; into elements with an explicit ending, but
4199 ;; return that element instead.
4203 drawer dynamic-block inlinetask item
4204 plain-list quote-block special-block))))
4216 ;;;###autoload
4218 "Return closest element or object around point.
4220 Return value is a list like (TYPE PROPS) where TYPE is the type
4221 of the element or object and PROPS a plist of properties
4222 associated to it.
4224 Possible types are defined in `org-element-all-elements' and
4225 `org-element-all-objects'. Properties depend on element or
4226 object type, but always include :begin, :end, :parent
4227 and :post-blank properties."
4232 end)
4233 ;; Check if point is inside an element containing objects or at
4234 ;; a secondary string. In that case, move to beginning of the
4235 ;; element or secondary string and set END to the other side.
4244 (<= origin
4245 ;; `1+' is required so some
4246 ;; successors can match
4247 ;; properly their object.
4261 element
4264 candidates)
4267 end restriction candidates))
4269 candidates)))
4270 ;; If ORIGIN is before next object in element, there's
4271 ;; no point in looking further.
4280 ;; ORIGIN is after OBJECT, so skip it.
4283 ;; ORIGIN is within a non-recursive object or at an
4284 ;; object boundaries: Return that object.
4288 ;; Otherwise, move within current object and restrict
4289 ;; search to the end of its contents.
4293 parent))))))
4296 "Non-nil when elements ELEM-A and ELEM-B are nested."
4305 "Swap elements ELEM-A and ELEM-B.
4306 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4307 end of ELEM-A."
4309 ;; There are two special cases when an element doesn't start at bol:
4310 ;; the first paragraph in an item or in a footnote definition.
4312 ;; Only a paragraph without any affiliated keyword can be moved at
4313 ;; ELEM-A position in such a situation. Note that the case of
4314 ;; a footnote definition is impossible: it cannot contain two
4315 ;; paragraphs in a row because it cannot contain a blank line.
4321 ;; In a special situation, ELEM-A will have no indentation. We'll
4322 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4336 ;; Store overlays responsible for visibility status. We
4337 ;; also need to store their boundaries as they will be
4338 ;; removed from buffer.
4345 ;; Get contents.
4353 ;; Restore ex ELEM-A overlays.
4362 ;; Restore ex ELEM-B overlays.
4371 ;;; org-element.el ends here