| blob | 94d2600f831f675dfc437fcb823862d064e346b8 |
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 (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `example-block', `export-block', `fixed-width',
50 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
51 ;; `paragraph', `planning', `quote-section', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (i.e. an item tag or an headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements
75 ;; and elements containing objects will also have `:contents-begin'
76 ;; and `:contents-end' properties to delimit contents.
77 ;;
78 ;; Lisp-wise, an element or an object can be represented as a list.
79 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
80 ;; TYPE is a symbol describing the Org element or object.
81 ;; PROPERTIES is the property list attached to it. See docstring of
82 ;; appropriate parsing function to get an exhaustive
83 ;; list.
84 ;; CONTENTS is a list of elements, objects or raw strings contained
85 ;; in the current element or object, when applicable.
86 ;;
87 ;; An Org buffer is a nested list of such elements and objects, whose
88 ;; type is `org-data' and properties is nil.
89 ;;
90 ;; The first part of this file defines Org syntax, while the second
91 ;; one provide accessors and setters functions.
92 ;;
93 ;; The next part implements a parser and an interpreter for each
94 ;; element and object type in Org syntax.
95 ;;
96 ;; The following part creates a fully recursive buffer parser. It
97 ;; also provides a tool to map a function to elements or objects
98 ;; matching some criteria in the parse tree. Functions of interest
99 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
100 ;; extent, `org-element-parse-secondary-string'.
101 ;;
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
104 ;;
105 ;; The library ends by furnishing `org-element-at-point' function, and
106 ;; a way to give information about document structure around point
107 ;; with `org-element-context'.
110 ;;; Code:
116 \f
117 ;;; Definitions And Rules
118 ;;
119 ;; Define elements, greater elements and specify recursive objects,
120 ;; along with the affiliated keywords recognized. Also set up
121 ;; restrictions on recursive objects combinations.
122 ;;
123 ;; These variables really act as a control center for the parsing
124 ;; process.
128 ;; Headlines, inlinetasks.
130 ;; Footnote definitions.
133 ;; Empty lines.
135 ;; Tables (any type).
137 ;; Blocks (any type), Babel calls, drawers (any type),
138 ;; fixed-width areas and keywords. Note: this is only an
139 ;; indication and need some thorough check.
141 ;; Horizontal rules.
143 ;; LaTeX environments.
145 ;; Planning and Clock lines.
147 org-deadline-string
148 org-closed-string
149 org-clock-string))
151 ;; Lists.
158 "Regexp to separate paragraphs in an Org buffer.
160 is not sufficient to know if point is at a paragraph ending. See
165 example-block export-block fixed-width footnote-definition
166 headline horizontal-rule inlinetask item keyword
167 latex-environment node-property paragraph plain-list planning
168 property-drawer quote-block quote-section section special-block
169 src-block table table-row verse-block)
174 item plain-list property-drawer quote-block section
175 special-block table)
180 latex-or-entity line-break link macro radio-target
181 statistics-cookie sub/superscript table-cell target
182 text-markup timestamp)
191 "Alist of translations between object type and successor name.
193 Sharing the same successor comes handy when, for example, the
198 inline-src-block italic line-break latex-fragment link macro
199 radio-target statistics-cookie strike-through subscript superscript
200 table-cell target timestamp underline verbatim)
205 table-cell underline)
215 "Alist between block names and the associated parsing function.
216 Names must be uppercase. Any block whose name has no association
222 Only these types can accept search options and an explicit
228 "List of affiliated keywords as strings.
234 ;; Regular affiliated keywords.
237 "Regexp matching any affiliated keyword.
239 Keyword name is put in match group 1. Moreover, if keyword
240 belongs to `org-element-dual-keywords', put the dual value in
241 match group 2.
249 "Alist of usual translations for keywords.
250 The key is the old name and the value the new one. The property
254 "List of affiliated keywords that can occur more than once in an element.
256 Their value will be consed into a list of strings, which will be
257 returned as the value of the property.
259 This list is checked after translations have been applied. See
260 `org-element-keyword-translation-alist'.
266 "List of affiliated keywords whose value can be parsed.
268 Their value will be stored as a secondary string: a list of
269 strings and objects.
271 This list is checked after translations have been applied. See
275 "List of affiliated keywords which can have a secondary value.
277 In Org syntax, they can be written with optional square brackets
278 before the colons. For example, RESULTS keyword can be
279 associated to a hash value with the following:
281 #+RESULTS[hash-string]: some-source
283 This list is checked after translations have been applied. See
287 "List of properties associated to the whole document.
288 Any keyword in this list will have its value parsed and stored as
295 inline-src-block latex-or-entity line-break link macro
296 radio-target sub/superscript target text-markup
297 timestamp)
299 radio-target statistics-cookie sub/superscript target text-markup
300 timestamp)
311 inline-src-block latex-or-entity line-break link macro
312 radio-target statistics-cookie sub/superscript target text-markup
313 timestamp)
316 latex-or-entity link radio-target sub/superscript target
317 text-markup timestamp)
328 latex-or-entity line-break link macro radio-target
330 "Alist of objects restrictions.
332 CAR is an element or object type containing objects and CDR is
333 a list of successors that will be called within an element or
334 object of such type.
336 For example, in a `radio-target' object, one can only find
337 entities, export snippets, latex-fragments, subscript and
338 superscript.
340 This alist also applies to secondary string. For example, an
341 `headline' type element doesn't directly contain objects, but
352 \f
353 ;;; Accessors and Setters
354 ;;
355 ;; Provide four accessors: `org-element-type', `org-element-property'
356 ;; `org-element-contents' and `org-element-restriction'.
357 ;;
358 ;; Setter functions allow to modify elements by side effect. There is
359 ;; `org-element-put-property', `org-element-set-contents',
360 ;; `org-element-set-element' and `org-element-adopt-element'. Note
361 ;; that `org-element-set-element' and `org-element-adopt-elements' are
362 ;; higher level functions since also update `:parent' property.
365 "Return type of ELEMENT.
367 The function returns the type of the element or object provided.
368 It can also return the following special value:
369 `plain-text' for a string
370 `org-data' for a complete document
371 nil in any other case."
377 "Extract the value from the PROPERTY of an ELEMENT."
381 "Extract contents from an ELEMENT."
385 "Return restriction associated to ELEMENT.
386 ELEMENT can be an element, an object or a symbol representing an
387 element or object type."
389 org-element-object-restrictions)))
392 "In ELEMENT set PROPERTY to VALUE.
393 Return modified element."
396 element)
399 "Set ELEMENT contents to CONTENTS.
400 Return modified element."
406 "Replace element or object OLD with element or object NEW.
407 The function takes care of setting `:parent' property for NEW."
408 ;; Since OLD is going to be changed into NEW by side-effect, first
409 ;; make sure that every element or object within NEW has OLD as
410 ;; parent.
413 ;; Transfer contents.
415 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
416 ;; with NEW's.
419 ;; Transfer type.
423 "Append elements to the contents of another element.
425 PARENT is an element or object. CHILDREN can be elements,
426 objects, or a strings.
428 The function takes care of setting `:parent' property for CHILD.
429 Return parent element."
431 ;; Link every child to PARENT.
435 children)
436 ;; Add CHILDREN at the end of PARENT contents.
438 parent
440 ;; Return modified PARENT element.
441 parent))
444 \f
445 ;;; Greater elements
446 ;;
447 ;; For each greater element type, we define a parser and an
448 ;; interpreter.
449 ;;
450 ;; A parser returns the element or object as the list described above.
451 ;; Most of them accepts no argument. Though, exceptions exist. Hence
452 ;; every element containing a secondary string (see
453 ;; `org-element-secondary-value-alist') will accept an optional
454 ;; argument to toggle parsing of that secondary string. Moreover,
455 ;; `item' parser requires current list's structure as its first
456 ;; element.
457 ;;
458 ;; An interpreter accepts two arguments: the list representation of
459 ;; the element or object, and its contents. The latter may be nil,
460 ;; depending on the element or object considered. It returns the
461 ;; appropriate Org syntax, as a string.
462 ;;
463 ;; Parsing functions must follow the naming convention:
464 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
465 ;; defined in `org-element-greater-elements'.
466 ;;
467 ;; Similarly, interpreting functions must follow the naming
468 ;; convention: org-element-TYPE-interpreter.
469 ;;
470 ;; With the exception of `headline' and `item' types, greater elements
471 ;; cannot contain other greater elements of their own type.
472 ;;
473 ;; Beside implementing a parser and an interpreter, adding a new
474 ;; greater element requires to tweak `org-element--current-element'.
475 ;; Moreover, the newly defined type must be added to both
476 ;; `org-element-all-elements' and `org-element-greater-elements'.
479 ;;;; Center Block
482 "Parse a center block.
484 LIMIT bounds the search. AFFILIATED is a list of which CAR is
485 the buffer position at the beginning of the first affiliated
486 keyword and CDR is a plist of affiliated keywords along with
487 their value.
489 Return a list whose CAR is `center-block' and CDR is a plist
490 containing `:begin', `:end', `:hiddenp', `:contents-begin',
491 `:contents-end' and `:post-blank' keywords.
493 Assume point is at the beginning of the block."
497 ;; Incomplete block: parse it as a paragraph.
501 ;; Empty blocks have no contents.
515 :end end
516 :hiddenp hidden
517 :contents-begin contents-begin
518 :contents-end contents-end
523 "Interpret CENTER-BLOCK element as Org syntax.
524 CONTENTS is the contents of the element."
528 ;;;; Drawer
531 "Parse a drawer.
533 LIMIT bounds the search. AFFILIATED is a list of which CAR is
534 the buffer position at the beginning of the first affiliated
535 keyword and CDR is a plist of affiliated keywords along with
536 their value.
538 Return a list whose CAR is `drawer' and CDR is a plist containing
539 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
540 `:contents-end' and `:post-blank' keywords.
542 Assume point is at beginning of drawer."
545 ;; Incomplete drawer: parse it as a paragraph.
552 ;; Empty drawers have no contents.
566 :end end
567 :drawer-name name
568 :hiddenp hidden
569 :contents-begin contents-begin
570 :contents-end contents-end
575 "Interpret DRAWER element as Org syntax.
576 CONTENTS is the contents of the element."
579 contents))
582 ;;;; Dynamic Block
585 "Parse a dynamic block.
587 LIMIT bounds the search. AFFILIATED is a list of which CAR is
588 the buffer position at the beginning of the first affiliated
589 keyword and CDR is a plist of affiliated keywords along with
590 their value.
592 Return a list whose CAR is `dynamic-block' and CDR is a plist
593 containing `:block-name', `:begin', `:end', `:hiddenp',
594 `:contents-begin', `:contents-end', `:arguments' and
595 `:post-blank' keywords.
597 Assume point is at beginning of dynamic block."
601 ;; Incomplete block: parse it as a paragraph.
609 ;; Empty blocks have no contents.
623 :end end
624 :block-name name
625 :arguments arguments
626 :hiddenp hidden
627 :contents-begin contents-begin
628 :contents-end contents-end
633 "Interpret DYNAMIC-BLOCK element as Org syntax.
634 CONTENTS is the contents of the element."
639 contents))
642 ;;;; Footnote Definition
645 "Parse a footnote definition.
647 LIMIT bounds the search. AFFILIATED is a list of which CAR is
648 the buffer position at the beginning of the first affiliated
649 keyword and CDR is a plist of affiliated keywords along with
650 their value.
652 Return a list whose CAR is `footnote-definition' and CDR is
653 a plist containing `:label', `:begin' `:end', `:contents-begin',
654 `:contents-end' and `:post-blank' keywords.
656 Assume point is at the beginning of the footnote definition."
680 :begin begin
681 :end end
682 :contents-begin contents-begin
683 :contents-end contents-end
688 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
689 CONTENTS is the contents of the footnote-definition."
691 " "
692 contents))
695 ;;;; Headline
698 "Parse an headline.
700 Return a list whose CAR is `headline' and CDR is a plist
701 containing `:raw-value', `:title', `:begin', `:end',
702 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
703 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
704 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
705 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
706 keywords.
708 The plist also contains any property set in the property drawer,
709 with its name in lowercase, the underscores replaced with hyphens
710 and colons at the beginning (i.e. `:custom-id').
712 When RAW-SECONDARY-P is non-nil, headline's title will not be
713 parsed as a secondary string, but as a plain string instead.
715 Assume point is at beginning of the headline."
728 raw-value)))
732 raw-value)))
736 ;; Normalize property names: ":SOME_PROP:" becomes
737 ;; ":some-prop".
749 plist))
767 ;; Clean RAW-VALUE from any quote or comment string.
775 ""
776 raw-value))))
777 ;; Clean TAGS from archive tag, if any.
783 :begin begin
784 :end end
785 :pre-blank
788 :hiddenp hidden
789 :contents-begin contents-begin
790 :contents-end contents-end
791 :level level
793 :tags tags
794 :todo-keyword todo
795 :todo-type todo-type
796 :scheduled scheduled
797 :deadline deadline
798 :timestamp timestamp
799 :clock clock
805 end)
806 :footnote-section-p footnote-section-p
807 :archivedp archivedp
808 :commentedp commentedp
810 standard-props))))
812 headline :title
818 "Interpret HEADLINE element as Org syntax.
819 CONTENTS is the contents of the element."
846 ;; Align tags.
854 ? )
855 tags))
859 tags))))
861 contents)))
864 ;;;; Inlinetask
867 "Parse an inline task.
869 Return a list whose CAR is `inlinetask' and CDR is a plist
870 containing `:title', `:begin', `:end', `:hiddenp',
871 `:contents-begin' and `:contents-end', `:level', `:priority',
872 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
873 `:scheduled', `:deadline', `:timestamp', `:clock' and
874 `:post-blank' keywords.
876 The plist also contains any property set in the property drawer,
877 with its name in lowercase, the underscores replaced with hyphens
878 and colons at the beginning (i.e. `:custom-id').
880 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
881 title will not be parsed as a secondary string, but as a plain
882 string instead.
884 Assume point is at beginning of the inline task."
895 ;; Normalize property names: ":SOME_PROP:" becomes
896 ;; ":some-prop".
908 plist))
932 :begin begin
933 :end end
934 :hiddenp hidden
935 :contents-begin contents-begin
936 :contents-end contents-end
939 :tags tags
940 :todo-keyword todo
941 :todo-type todo-type
942 :scheduled scheduled
943 :deadline deadline
944 :timestamp timestamp
945 :clock clock
947 standard-props
950 inlinetask :title
953 raw-value
955 inlinetask))))))
958 "Interpret INLINETASK element as Org syntax.
959 CONTENTS is the contents of inlinetask."
974 ;; Align tags.
982 ? )
983 tags))
987 tags))))
988 ;; Prefer degenerate inlinetasks when there are no
989 ;; contents.
992 contents
996 ;;;; Item
999 "Parse an item.
1001 STRUCT is the structure of the plain list.
1003 Return a list whose CAR is `item' and CDR is a plist containing
1004 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1005 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1006 `:post-blank' keywords.
1008 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1009 any, will not be parsed as a secondary string, but as a plain
1010 string instead.
1012 Assume point is at the beginning of the item."
1036 ;; Ignore tags in un-ordered lists: they are just
1037 ;; a part of item's body.
1043 ;; If first line isn't empty, contents really start
1044 ;; at the text after item's meta-data.
1055 :begin begin
1056 :end end
1057 ;; CONTENTS-BEGIN and CONTENTS-END may be
1058 ;; mixed up in the case of an empty item
1059 ;; separated from the next by a blank line.
1060 ;; Thus ensure the former is always the
1061 ;; smallest.
1064 :checkbox checkbox
1065 :counter counter
1066 :hiddenp hidden
1067 :structure struct
1070 item :tag
1078 "Interpret ITEM element as Org syntax.
1079 CONTENTS is the contents of the element."
1085 ;; Compute indentation.
1090 ;; Indent contents.
1092 bullet
1105 ;;;; Plain List
1108 "Parse a plain list.
1110 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1111 the buffer position at the beginning of the first affiliated
1112 keyword and CDR is a plist of affiliated keywords along with
1113 their value. STRUCTURE is the structure of the plain list being
1114 parsed.
1116 Return a list whose CAR is `plain-list' and CDR is a plist
1117 containing `:type', `:begin', `:end', `:contents-begin' and
1118 `:contents-end', `:structure' and `:post-blank' keywords.
1120 Assume point is at the beginning of the list."
1134 ;; Return value.
1138 :begin begin
1139 :end end
1140 :contents-begin contents-begin
1141 :contents-end contents-end
1142 :structure struct
1147 "Interpret PLAIN-LIST element as Org syntax.
1148 CONTENTS is the contents of the element."
1156 ;;;; Property Drawer
1159 "Parse a property drawer.
1161 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1162 the buffer position at the beginning of the first affiliated
1163 keyword and CDR is a plist of affiliated keywords along with
1164 their value.
1166 Return a list whose CAR is `property-drawer' and CDR is a plist
1167 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1168 `:contents-end' and `:post-blank' keywords.
1170 Assume point is at the beginning of the property drawer."
1175 ;; Incomplete drawer: parse it as a paragraph.
1193 :end end
1194 :hiddenp hidden
1195 :contents-begin contents-begin
1196 :contents-end contents-end
1201 "Interpret PROPERTY-DRAWER element as Org syntax.
1202 CONTENTS is the properties within the drawer."
1206 ;;;; Quote Block
1209 "Parse a quote block.
1211 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1212 the buffer position at the beginning of the first affiliated
1213 keyword and CDR is a plist of affiliated keywords along with
1214 their value.
1216 Return a list whose CAR is `quote-block' and CDR is a plist
1217 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1218 `:contents-end' and `:post-blank' keywords.
1220 Assume point is at the beginning of the block."
1224 ;; Incomplete block: parse it as a paragraph.
1229 ;; Empty blocks have no contents.
1243 :end end
1244 :hiddenp hidden
1245 :contents-begin contents-begin
1246 :contents-end contents-end
1251 "Interpret QUOTE-BLOCK element as Org syntax.
1252 CONTENTS is the contents of the element."
1256 ;;;; Section
1259 "Parse a section.
1261 LIMIT bounds the search.
1263 Return a list whose CAR is `section' and CDR is a plist
1264 containing `:begin', `:end', `:contents-begin', `contents-end'
1265 and `:post-blank' keywords."
1267 ;; Beginning of section is the beginning of the first non-blank
1268 ;; line after previous headline.
1277 :end end
1278 :contents-begin begin
1279 :contents-end pos-before-blank
1283 "Interpret SECTION element as Org syntax.
1284 CONTENTS is the contents of the element."
1285 contents)
1288 ;;;; Special Block
1291 "Parse a special block.
1293 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1294 the buffer position at the beginning of the first affiliated
1295 keyword and CDR is a plist of affiliated keywords along with
1296 their value.
1298 Return a list whose CAR is `special-block' and CDR is a plist
1299 containing `:type', `:begin', `:end', `:hiddenp',
1300 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1302 Assume point is at the beginning of the block."
1309 ;; Incomplete block: parse it as a paragraph.
1314 ;; Empty blocks have no contents.
1328 :begin begin
1329 :end end
1330 :hiddenp hidden
1331 :contents-begin contents-begin
1332 :contents-end contents-end
1337 "Interpret SPECIAL-BLOCK element as Org syntax.
1338 CONTENTS is the contents of the element."
1343 \f
1344 ;;; Elements
1345 ;;
1346 ;; For each element, a parser and an interpreter are also defined.
1347 ;; Both follow the same naming convention used for greater elements.
1348 ;;
1349 ;; Also, as for greater elements, adding a new element type is done
1350 ;; through the following steps: implement a parser and an interpreter,
1351 ;; tweak `org-element--current-element' so that it recognizes the new
1352 ;; type and add that new type to `org-element-all-elements'.
1353 ;;
1354 ;; As a special case, when the newly defined type is a block type,
1355 ;; `org-element-block-name-alist' has to be modified accordingly.
1358 ;;;; Babel Call
1361 "Parse a babel call.
1363 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1364 the buffer position at the beginning of the first affiliated
1365 keyword and CDR is a plist of affiliated keywords along with
1366 their value.
1368 Return a list whose CAR is `babel-call' and CDR is a plist
1369 containing `:begin', `:end', `:info' and `:post-blank' as
1370 keywords."
1382 :end end
1383 :info info
1388 "Interpret BABEL-CALL element as Org syntax.
1389 CONTENTS is nil."
1395 ;; Remove redundant square brackets.
1400 ;;;; Clock
1403 "Parse a clock.
1405 LIMIT bounds the search.
1407 Return a list whose CAR is `clock' and CDR is a plist containing
1408 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1409 as keywords."
1428 :value value
1429 :time time
1430 :begin begin
1431 :end end
1435 "Interpret CLOCK element as Org syntax.
1436 CONTENTS is nil."
1443 "%2s:%02s"
1447 ;;;; Comment
1450 "Parse a comment.
1452 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1453 the buffer position at the beginning of the first affiliated
1454 keyword and CDR is a plist of affiliated keywords along with
1455 their value.
1457 Return a list whose CAR is `comment' and CDR is a plist
1458 containing `:begin', `:end', `:value' and `:post-blank'
1459 keywords.
1461 Assume point is at comment beginning."
1469 ;; Get comments ending.
1472 ;; Accumulate lines without leading hash and first
1473 ;; whitespace.
1487 :end end
1488 :value value
1493 "Interpret COMMENT element as Org syntax.
1494 CONTENTS is nil."
1498 ;;;; Comment Block
1501 "Parse an export block.
1503 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1504 the buffer position at the beginning of the first affiliated
1505 keyword and CDR is a plist of affiliated keywords along with
1506 their value.
1508 Return a list whose CAR is `comment-block' and CDR is a plist
1509 containing `:begin', `:end', `:hiddenp', `:value' and
1510 `:post-blank' keywords.
1512 Assume point is at comment block beginning."
1516 ;; Incomplete block: parse it as a paragraph.
1529 contents-begin contents-end)))
1533 :end end
1534 :value value
1535 :hiddenp hidden
1540 "Interpret COMMENT-BLOCK element as Org syntax.
1541 CONTENTS is nil."
1546 ;;;; Example Block
1549 "Parse an example block.
1551 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1552 the buffer position at the beginning of the first affiliated
1553 keyword and CDR is a plist of affiliated keywords along with
1554 their value.
1556 Return a list whose CAR is `example-block' and CDR is a plist
1557 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1558 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1559 `:switches', `:value' and `:post-blank' keywords."
1563 ;; Incomplete block: parse it as a paragraph.
1570 ;; Switches analysis
1575 ;; Should labels be retained in (or stripped from) example
1576 ;; blocks?
1581 ;; What should code-references use - labels or
1582 ;; line-numbers?
1589 ;; Standard block parsing.
1602 :end end
1603 :value value
1604 :switches switches
1605 :number-lines number-lines
1606 :preserve-indent preserve-indent
1607 :retain-labels retain-labels
1608 :use-labels use-labels
1609 :label-fmt label-fmt
1610 :hiddenp hidden
1615 "Interpret EXAMPLE-BLOCK element as Org syntax.
1616 CONTENTS is nil."
1624 ;;;; Export Block
1627 "Parse an export block.
1629 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1630 the buffer position at the beginning of the first affiliated
1631 keyword and CDR is a plist of affiliated keywords along with
1632 their value.
1634 Return a list whose CAR is `export-block' and CDR is a plist
1635 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1636 `:post-blank' keywords.
1638 Assume point is at export-block beginning."
1645 ;; Incomplete block: parse it as a paragraph.
1658 contents-end)))
1662 :end end
1663 :type type
1664 :value value
1665 :hiddenp hidden
1670 "Interpret EXPORT-BLOCK element as Org syntax.
1671 CONTENTS is nil."
1678 ;;;; Fixed-width
1681 "Parse a fixed-width section.
1683 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1684 the buffer position at the beginning of the first affiliated
1685 keyword and CDR is a plist of affiliated keywords along with
1686 their value.
1688 Return a list whose CAR is `fixed-width' and CDR is a plist
1689 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1691 Assume point is at the beginning of the fixed-width area."
1694 value
1699 ;; Accumulate text without starting colons.
1712 :end end
1713 :value value
1718 "Interpret FIXED-WIDTH element as Org syntax.
1719 CONTENTS is nil."
1724 ;;;; Horizontal Rule
1727 "Parse an horizontal rule.
1729 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1730 the buffer position at the beginning of the first affiliated
1731 keyword and CDR is a plist of affiliated keywords along with
1732 their value.
1734 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1735 containing `:begin', `:end' and `:post-blank' keywords."
1744 :end end
1749 "Interpret HORIZONTAL-RULE element as Org syntax.
1750 CONTENTS is nil."
1754 ;;;; Keyword
1757 "Parse a keyword at point.
1759 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1760 the buffer position at the beginning of the first affiliated
1761 keyword and CDR is a plist of affiliated keywords along with
1762 their value.
1764 Return a list whose CAR is `keyword' and CDR is a plist
1765 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1766 keywords."
1780 :value value
1781 :begin begin
1782 :end end
1787 "Interpret KEYWORD element as Org syntax.
1788 CONTENTS is nil."
1794 ;;;; Latex Environment
1797 "Parse a LaTeX environment.
1799 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1800 the buffer position at the beginning of the first affiliated
1801 keyword and CDR is a plist of affiliated keywords along with
1802 their value.
1804 Return a list whose CAR is `latex-environment' and CDR is a plist
1805 containing `:begin', `:end', `:value' and `:post-blank'
1806 keywords.
1808 Assume point is at the beginning of the latex environment."
1826 :end end
1827 :value value
1832 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1833 CONTENTS is nil."
1837 ;;;; Node Property
1840 "Parse a node-property at point.
1842 LIMIT bounds the search.
1844 Return a list whose CAR is `node-property' and CDR is a plist
1845 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1846 keywords."
1858 :value value
1859 :begin begin
1860 :end end
1864 "Interpret NODE-PROPERTY element as Org syntax.
1865 CONTENTS is nil."
1871 ;;;; Paragraph
1874 "Parse a paragraph.
1876 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1877 the buffer position at the beginning of the first affiliated
1878 keyword and CDR is a plist of affiliated keywords along with
1879 their value.
1881 Return a list whose CAR is `paragraph' and CDR is a plist
1882 containing `:begin', `:end', `:contents-begin' and
1883 `:contents-end' and `:post-blank' keywords.
1885 Assume point is at the beginning of the paragraph."
1894 limit
1895 ;; A matching `org-element-paragraph-separate' is not
1896 ;; necessarily the end of the paragraph. In
1897 ;; particular, lines starting with # or : as a first
1898 ;; non-space character are ambiguous. We have check
1899 ;; if they are valid Org syntax (i.e. not an
1900 ;; incomplete keyword).
1904 ;; There's no ambiguity for other symbols or
1905 ;; empty lines: stop here.
1907 ;; Stop at valid fixed-width areas.
1909 ;; Stop at drawers.
1914 ;; Stop at valid comments.
1916 ;; Stop at valid dynamic blocks.
1921 ;; Stop at valid blocks.
1928 limit t)))
1929 ;; Stop at valid latex environments.
1936 limit t)))
1937 ;; Stop at valid keywords.
1939 ;; Skip everything else.
1956 :end end
1957 :contents-begin contents-begin
1958 :contents-end contents-end
1963 "Interpret PARAGRAPH element as Org syntax.
1964 CONTENTS is the contents of the element."
1965 contents)
1968 ;;;; Planning
1971 "Parse a planning.
1973 LIMIT bounds the search.
1975 Return a list whose CAR is `planning' and CDR is a plist
1976 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1977 and `:post-blank' keywords."
1986 closed deadline scheduled)
2000 :deadline deadline
2001 :scheduled scheduled
2002 :begin begin
2003 :end end
2007 "Interpret PLANNING element as Org syntax.
2008 CONTENTS is nil."
2010 'identity
2022 ;;;; Quote Section
2025 "Parse a quote section.
2027 LIMIT bounds the search.
2029 Return a list whose CAR is `quote-section' and CDR is a plist
2030 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2032 Assume point is at beginning of the section."
2043 :end end
2044 :value value
2048 "Interpret QUOTE-SECTION element as Org syntax.
2049 CONTENTS is nil."
2053 ;;;; Src Block
2056 "Parse a src block.
2058 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2059 the buffer position at the beginning of the first affiliated
2060 keyword and CDR is a plist of affiliated keywords along with
2061 their value.
2063 Return a list whose CAR is `src-block' and CDR is a plist
2064 containing `:language', `:switches', `:parameters', `:begin',
2065 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2066 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2067 `:post-blank' keywords.
2069 Assume point is at the beginning of the block."
2072 limit t)))
2073 ;; Incomplete block: parse it as a paragraph.
2078 ;; Get language as a string.
2087 ;; Get switches.
2089 ;; Get parameters.
2091 ;; Switches analysis
2099 ;; Should labels be retained in (or stripped from)
2100 ;; src blocks?
2105 ;; What should code-references use - labels or
2106 ;; line-numbers?
2110 ;; Get visibility status.
2112 ;; Retrieve code.
2117 ;; Get position after ending blank lines.
2127 :begin begin
2128 :end end
2129 :number-lines number-lines
2130 :preserve-indent preserve-indent
2131 :retain-labels retain-labels
2132 :use-labels use-labels
2133 :label-fmt label-fmt
2134 :hiddenp hidden
2135 :value value
2140 "Interpret SRC-BLOCK element as Org syntax.
2141 CONTENTS is nil."
2161 value
2165 ;;;; Table
2168 "Parse a table at point.
2170 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2171 the buffer position at the beginning of the first affiliated
2172 keyword and CDR is a plist of affiliated keywords along with
2173 their value.
2175 Return a list whose CAR is `table' and CDR is a plist containing
2176 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2177 `:contents-end', `:value' and `:post-blank' keywords.
2179 Assume point is at the beginning of the table."
2191 acc))
2198 :end end
2199 :type type
2200 :tblfm tblfm
2201 ;; Only `org' tables have contents. `table.el' tables
2202 ;; use a `:value' property to store raw table as
2203 ;; a string.
2208 table-begin table-end))
2213 "Interpret TABLE element as Org syntax.
2214 CONTENTS is nil."
2225 ;;;; Table Row
2228 "Parse table row at point.
2230 LIMIT bounds the search.
2232 Return a list whose CAR is `table-row' and CDR is a plist
2233 containing `:begin', `:end', `:contents-begin', `:contents-end',
2234 `:type' and `:post-blank' keywords."
2238 ;; A table rule has no contents. In that case, ensure
2239 ;; CONTENTS-BEGIN matches CONTENTS-END.
2251 :begin begin
2252 :end end
2253 :contents-begin contents-begin
2254 :contents-end contents-end
2258 "Interpret TABLE-ROW element as Org syntax.
2259 CONTENTS is the contents of the table row."
2264 ;;;; Verse Block
2267 "Parse a verse block.
2269 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2270 the buffer position at the beginning of the first affiliated
2271 keyword and CDR is a plist of affiliated keywords along with
2272 their value.
2274 Return a list whose CAR is `verse-block' and CDR is a plist
2275 containing `:begin', `:end', `:contents-begin', `:contents-end',
2276 `:hiddenp' and `:post-blank' keywords.
2278 Assume point is at beginning of the block."
2282 ;; Incomplete block: parse it as a paragraph.
2297 :end end
2298 :contents-begin contents-begin
2299 :contents-end contents-end
2300 :hiddenp hidden
2305 "Interpret VERSE-BLOCK element as Org syntax.
2306 CONTENTS is verse block contents."
2310 \f
2311 ;;; Objects
2312 ;;
2313 ;; Unlike to elements, interstices can be found between objects.
2314 ;; That's why, along with the parser, successor functions are provided
2315 ;; for each object. Some objects share the same successor (i.e. `code'
2316 ;; and `verbatim' objects).
2317 ;;
2318 ;; A successor must accept a single argument bounding the search. It
2319 ;; will return either a cons cell whose CAR is the object's type, as
2320 ;; a symbol, and CDR the position of its next occurrence, or nil.
2321 ;;
2322 ;; Successors follow the naming convention:
2323 ;; org-element-NAME-successor, where NAME is the name of the
2324 ;; successor, as defined in `org-element-all-successors'.
2325 ;;
2326 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2327 ;; object types they can contain will be specified in
2328 ;; `org-element-object-restrictions'.
2329 ;;
2330 ;; Adding a new type of object is simple. Implement a successor,
2331 ;; a parser, and an interpreter for it, all following the naming
2332 ;; convention. Register type in `org-element-all-objects' and
2333 ;; successor in `org-element-all-successors'. Maybe tweak
2334 ;; restrictions about it, and that's it.
2337 ;;;; Bold
2340 "Parse bold object at point.
2342 Return a list whose CAR is `bold' and CDR is a plist with
2343 `:begin', `:end', `:contents-begin' and `:contents-end' and
2344 `:post-blank' keywords.
2346 Assume point is at the first star marker."
2358 :end end
2359 :contents-begin contents-begin
2360 :contents-end contents-end
2364 "Interpret BOLD object as Org syntax.
2365 CONTENTS is the contents of the object."
2369 "Search for the next text-markup object.
2371 LIMIT bounds the search.
2373 Return value is a cons cell whose CAR is a symbol among `bold',
2374 `italic', `underline', `strike-through', `code' and `verbatim'
2375 and CDR is beginning position."
2391 ;;;; Code
2394 "Parse code object at point.
2396 Return a list whose CAR is `code' and CDR is a plist with
2397 `:value', `:begin', `:end' and `:post-blank' keywords.
2399 Assume point is at the first tilde marker."
2410 :begin begin
2411 :end end
2415 "Interpret CODE object as Org syntax.
2416 CONTENTS is nil."
2420 ;;;; Entity
2423 "Parse entity at point.
2425 Return a list whose CAR is `entity' and CDR a plist with
2426 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2427 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2428 keywords.
2430 Assume point is at the beginning of the entity."
2432 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2448 :begin begin
2449 :end end
2450 :use-brackets-p bracketsp
2454 "Interpret ENTITY object as Org syntax.
2455 CONTENTS is nil."
2461 "Search for the next latex-fragment or entity object.
2463 LIMIT bounds the search.
2465 Return value is a cons cell whose CAR is `entity' or
2466 `latex-fragment' and CDR is beginning position."
2470 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2477 limit t)
2480 ;; Determine if it's a real entity or a LaTeX command.
2483 ;; No entity nor command: point is at a LaTeX fragment.
2484 ;; Determine its type to get the correct beginning position.
2492 matchers)
2496 ;;;; Export Snippet
2499 "Parse export snippet at point.
2501 Return a list whose CAR is `export-snippet' and CDR a plist with
2502 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2503 keywords.
2505 Assume point is at the beginning of the snippet."
2517 :value value
2518 :begin begin
2519 :end end
2523 "Interpret EXPORT-SNIPPET object as Org syntax.
2524 CONTENTS is nil."
2530 "Search for the next export-snippet object.
2532 LIMIT bounds the search.
2534 Return value is a cons cell whose CAR is `export-snippet' and CDR
2535 its beginning position."
2544 ;;;; Footnote Reference
2547 "Parse footnote reference at point.
2549 Return a list whose CAR is `footnote-reference' and CDR a plist
2550 with `:label', `:type', `:inline-definition', `:begin', `:end'
2551 and `:post-blank' as keywords."
2573 :type type
2574 :begin begin
2575 :end end
2578 footnote-reference :inline-definition
2583 footnote-reference))))))
2586 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2587 CONTENTS is nil."
2597 "Search for the next footnote-reference object.
2599 LIMIT bounds the search.
2601 Return value is a cons cell whose CAR is `footnote-reference' and
2602 CDR is beginning position."
2616 ;;;; Inline Babel Call
2619 "Parse inline babel call at point.
2621 Return a list whose CAR is `inline-babel-call' and CDR a plist
2622 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2624 Assume point is at the beginning of the babel call."
2635 :end end
2636 :info info
2640 "Interpret INLINE-BABEL-CALL object as Org syntax.
2641 CONTENTS is nil."
2647 ;; Remove redundant square brackets.
2650 main-source)
2654 "Search for the next inline-babel-call object.
2656 LIMIT bounds the search.
2658 Return value is a cons cell whose CAR is `inline-babel-call' and
2659 CDR is beginning position."
2661 ;; Use a simplified version of
2662 ;; `org-babel-inline-lob-one-liner-regexp'.
2665 limit t)
2669 ;;;; Inline Src Block
2672 "Parse inline source block at point.
2674 LIMIT bounds the search.
2676 Return a list whose CAR is `inline-src-block' and CDR a plist
2677 with `:begin', `:end', `:language', `:value', `:parameters' and
2678 `:post-blank' as keywords.
2680 Assume point is at the beginning of the inline src block."
2693 :value value
2694 :parameters parameters
2695 :begin begin
2696 :end end
2700 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2701 CONTENTS is nil."
2706 language
2708 body)))
2711 "Search for the next inline-babel-call element.
2713 LIMIT bounds the search.
2715 Return value is a cons cell whose CAR is `inline-babel-call' and
2716 CDR is beginning position."
2722 ;;;; Italic
2725 "Parse italic object at point.
2727 Return a list whose CAR is `italic' and CDR is a plist with
2728 `:begin', `:end', `:contents-begin' and `:contents-end' and
2729 `:post-blank' keywords.
2731 Assume point is at the first slash marker."
2743 :end end
2744 :contents-begin contents-begin
2745 :contents-end contents-end
2749 "Interpret ITALIC object as Org syntax.
2750 CONTENTS is the contents of the object."
2754 ;;;; Latex Fragment
2757 "Parse latex fragment at point.
2759 Return a list whose CAR is `latex-fragment' and CDR a plist with
2760 `:value', `:begin', `:end', and `:post-blank' as keywords.
2762 Assume point is at the beginning of the latex fragment."
2776 ;; None found: it's a macro.
2785 :begin begin
2786 :end end
2790 "Interpret LATEX-FRAGMENT object as Org syntax.
2791 CONTENTS is nil."
2794 ;;;; Line Break
2797 "Parse line break at point.
2799 Return a list whose CAR is `line-break', and CDR a plist with
2800 `:begin', `:end' and `:post-blank' keywords.
2802 Assume point is at the beginning of the line break."
2806 "Interpret LINE-BREAK object as Org syntax.
2807 CONTENTS is nil."
2811 "Search for the next line-break object.
2813 LIMIT bounds the search.
2815 Return value is a cons cell whose CAR is `line-break' and CDR is
2816 beginning position."
2820 ;; A line break can only happen on a non-empty line.
2825 ;;;; Link
2828 "Parse link at point.
2830 Return a list whose CAR is `link' and CDR a plist with `:type',
2831 `:path', `:raw-link', `:application', `:search-option', `:begin',
2832 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2833 keywords.
2835 Assume point is at the beginning of the link."
2838 end contents-begin contents-end link-end post-blank path type
2839 raw-link link search-option application)
2841 ;; Type 1: Text targeted from a radio target.
2846 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2851 ;; RAW-LINK is the original link.
2856 ;; Determine TYPE of link and set PATH accordingly.
2858 ;; File type.
2861 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2864 ;; Id type: PATH is the id.
2867 ;; Code-ref type: PATH is the name of the reference.
2870 ;; Custom-id type: PATH is the name of the custom id.
2873 ;; Fuzzy type: Internal link either matches a target, an
2874 ;; headline name or nothing. PATH is the target or
2875 ;; headline's name.
2877 ;; Type 3: Plain link, i.e. http://orgmode.org
2883 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2890 ;; In any case, deduce end point after trailing white space from
2891 ;; LINK-END variable.
2894 ;; Extract search option and opening application out of
2895 ;; "file"-type links.
2897 ;; Application.
2902 ;; Extract search option from PATH.
2906 ;; Make sure TYPE always report "file".
2910 :path path
2912 :application application
2913 :search-option search-option
2914 :begin begin
2915 :end end
2916 :contents-begin contents-begin
2917 :contents-end contents-end
2921 "Interpret LINK object as Org syntax.
2922 CONTENTS is the contents of the object, or nil."
2927 raw-link
2931 "Search for the next link object.
2933 LIMIT bounds the search.
2935 Return value is a cons cell whose CAR is `link' and CDR is
2936 beginning position."
2945 ;;;; Macro
2948 "Parse macro at point.
2950 Return a list whose CAR is `macro' and CDR a plist with `:key',
2951 `:args', `:begin', `:end', `:value' and `:post-blank' as
2952 keywords.
2954 Assume point is at the macro."
2968 ;; Repair bad splits.
2976 :value value
2977 :args args
2978 :begin begin
2979 :end end
2983 "Interpret MACRO object as Org syntax.
2984 CONTENTS is nil."
2988 "Search for the next macro object.
2990 LIMIT bounds the search.
2992 Return value is cons cell whose CAR is `macro' and CDR is
2993 beginning position."
2997 limit t)
3001 ;;;; Radio-target
3004 "Parse radio target at point.
3006 Return a list whose CAR is `radio-target' and CDR a plist with
3007 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3008 and `:post-blank' as keywords.
3010 Assume point is at the radio target."
3022 :end end
3023 :contents-begin contents-begin
3024 :contents-end contents-end
3025 :post-blank post-blank
3029 "Interpret TARGET object as Org syntax.
3030 CONTENTS is the contents of the object."
3034 "Search for the next radio-target object.
3036 LIMIT bounds the search.
3038 Return value is a cons cell whose CAR is `radio-target' and CDR
3039 is beginning position."
3045 ;;;; Statistics Cookie
3048 "Parse statistics cookie at point.
3050 Return a list whose CAR is `statistics-cookie', and CDR a plist
3051 with `:begin', `:end', `:value' and `:post-blank' keywords.
3053 Assume point is at the beginning of the statistics-cookie."
3064 :end end
3065 :value value
3069 "Interpret STATISTICS-COOKIE object as Org syntax.
3070 CONTENTS is nil."
3074 "Search for the next statistics cookie object.
3076 LIMIT bounds the search.
3078 Return value is a cons cell whose CAR is `statistics-cookie' and
3079 CDR is beginning position."
3085 ;;;; Strike-Through
3088 "Parse strike-through object at point.
3090 Return a list whose CAR is `strike-through' and CDR is a plist
3091 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3092 `:post-blank' keywords.
3094 Assume point is at the first plus sign marker."
3106 :end end
3107 :contents-begin contents-begin
3108 :contents-end contents-end
3112 "Interpret STRIKE-THROUGH object as Org syntax.
3113 CONTENTS is the contents of the object."
3117 ;;;; Subscript
3120 "Parse subscript at point.
3122 Return a list whose CAR is `subscript' and CDR a plist with
3123 `:begin', `:end', `:contents-begin', `:contents-end',
3124 `:use-brackets-p' and `:post-blank' as keywords.
3126 Assume point is at the underscore."
3130 t
3141 :end end
3142 :use-brackets-p bracketsp
3143 :contents-begin contents-begin
3144 :contents-end contents-end
3148 "Interpret SUBSCRIPT object as Org syntax.
3149 CONTENTS is the contents of the object."
3152 contents))
3155 "Search for the next sub/superscript object.
3157 LIMIT bounds the search.
3159 Return value is a cons cell whose CAR is either `subscript' or
3160 `superscript' and CDR is beginning position."
3167 ;;;; Superscript
3170 "Parse superscript at point.
3172 Return a list whose CAR is `superscript' and CDR a plist with
3173 `:begin', `:end', `:contents-begin', `:contents-end',
3174 `:use-brackets-p' and `:post-blank' as keywords.
3176 Assume point is at the caret."
3190 :end end
3191 :use-brackets-p bracketsp
3192 :contents-begin contents-begin
3193 :contents-end contents-end
3197 "Interpret SUPERSCRIPT object as Org syntax.
3198 CONTENTS is the contents of the object."
3201 contents))
3204 ;;;; Table Cell
3207 "Parse table cell at point.
3209 Return a list whose CAR is `table-cell' and CDR is a plist
3210 containing `:begin', `:end', `:contents-begin', `:contents-end'
3211 and `:post-blank' keywords."
3219 :end end
3220 :contents-begin contents-begin
3221 :contents-end contents-end
3225 "Interpret TABLE-CELL element as Org syntax.
3226 CONTENTS is the contents of the cell, or nil."
3230 "Search for the next table-cell object.
3232 LIMIT bounds the search.
3234 Return value is a cons cell whose CAR is `table-cell' and CDR is
3235 beginning position."
3239 ;;;; Target
3242 "Parse target at point.
3244 Return a list whose CAR is `target' and CDR a plist with
3245 `:begin', `:end', `:value' and `:post-blank' as keywords.
3247 Assume point is at the target."
3257 :end end
3258 :value value
3262 "Interpret TARGET object as Org syntax.
3263 CONTENTS is nil."
3267 "Search for the next target object.
3269 LIMIT bounds the search.
3271 Return value is a cons cell whose CAR is `target' and CDR is
3272 beginning position."
3278 ;;;; Timestamp
3281 "Parse time stamp at point.
3283 Return a list whose CAR is `timestamp', and CDR a plist with
3284 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3286 Assume point is at the beginning of the timestamp."
3305 :value main-value
3306 :range-end range-end
3307 :begin begin
3308 :end end
3312 "Interpret TIMESTAMP object as Org syntax.
3313 CONTENTS is nil."
3322 range-end)))))))
3325 "Search for the next timestamp object.
3327 LIMIT bounds the search.
3329 Return value is a cons cell whose CAR is `timestamp' and CDR is
3330 beginning position."
3338 limit t)
3342 ;;;; Underline
3345 "Parse underline object at point.
3347 Return a list whose CAR is `underline' and CDR is a plist with
3348 `:begin', `:end', `:contents-begin' and `:contents-end' and
3349 `:post-blank' keywords.
3351 Assume point is at the first underscore marker."
3363 :end end
3364 :contents-begin contents-begin
3365 :contents-end contents-end
3369 "Interpret UNDERLINE object as Org syntax.
3370 CONTENTS is the contents of the object."
3374 ;;;; Verbatim
3377 "Parse verbatim object at point.
3379 Return a list whose CAR is `verbatim' and CDR is a plist with
3380 `:value', `:begin', `:end' and `:post-blank' keywords.
3382 Assume point is at the first equal sign marker."
3393 :begin begin
3394 :end end
3398 "Interpret VERBATIM object as Org syntax.
3399 CONTENTS is nil."
3403 \f
3404 ;;; Parsing Element Starting At Point
3405 ;;
3406 ;; `org-element--current-element' is the core function of this section.
3407 ;; It returns the Lisp representation of the element starting at
3408 ;; point.
3409 ;;
3410 ;; `org-element--current-element' makes use of special modes. They
3411 ;; are activated for fixed element chaining (i.e. `plain-list' >
3412 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3413 ;; `section'). Special modes are: `first-section', `item',
3414 ;; `node-property', `quote-section', `section' and `table-row'.
3418 "Parse the element starting at point.
3420 LIMIT bounds the search.
3422 Return value is a list like (TYPE PROPS) where TYPE is the type
3423 of the element and PROPS a plist of properties associated to the
3424 element.
3426 Possible types are defined in `org-element-all-elements'.
3428 Optional argument GRANULARITY determines the depth of the
3429 recursion. Allowed values are `headline', `greater-element',
3430 `element', `object' or nil. When it is broader than `object' (or
3431 nil), secondary values will not be parsed, since they only
3432 contain objects.
3434 Optional argument SPECIAL, when non-nil, can be either
3435 `first-section', `item', `node-property', `quote-section',
3436 `section', and `table-row'.
3438 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3439 be computed.
3441 This function assumes point is always at the beginning of the
3442 element it has to parse."
3445 ;; Determine if parsing depth allows for secondary strings
3446 ;; parsing. It only applies to elements referenced in
3447 ;; `org-element-secondary-value-alist'.
3450 ;; Item.
3453 ;; Table Row.
3455 ;; Node Property.
3457 ;; Headline.
3460 ;; Sections (must be checked after headline).
3466 limit)))
3467 ;; When not at bol, point is at the beginning of an item or
3468 ;; a footnote definition: next item is always a paragraph.
3470 ;; Planning and Clock.
3475 ;; Inlinetask.
3478 ;; From there, elements can have affiliated keywords.
3481 ;; LaTeX Environment.
3487 nil t))
3490 ;; Drawer and Property Drawer.
3500 ;; Fixed Width
3503 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3504 ;; Keywords.
3513 org-element-block-name-alist)))
3528 ;; Footnote Definition.
3531 ;; Horizontal Rule.
3534 ;; Table.
3536 ;; List.
3540 ;; Default element: Paragraph.
3544 ;; Most elements can have affiliated keywords. When looking for an
3545 ;; element beginning, we want to move before them, as they belong to
3546 ;; that element, and, in the meantime, collect information they give
3547 ;; into appropriate properties. Hence the following function.
3550 "Collect affiliated keywords from point.
3552 Return a list whose CAR is the position at the first of them and
3553 CDR a plist of keywords and values and move point to the
3554 beginning of the first line after them.
3556 As a special case, if element doesn't start at the beginning of
3557 the line (i.e. a paragraph starting an item), CAR is current
3558 position of point and CDR is nil."
3562 ;; RESTRICT is the list of objects allowed in parsed
3563 ;; keywords value.
3565 output)
3568 ;; Apply translation to RAW-KWD. From there, KWD is
3569 ;; the official keyword.
3571 org-element-keyword-translation-alist))
3572 raw-kwd))
3573 ;; Find main value for any keyword.
3579 ;; PARSEDP is non-nil when keyword should have its
3580 ;; value parsed.
3582 ;; If KWD is a dual keyword, find its secondary
3583 ;; value. Maybe parse it.
3590 ;; Attribute a property name to KWD.
3592 ;; Now set final shape for VALUE.
3597 ;; Attributes can always appear on multiple lines.
3600 ;; Eventually store the new value in OUTPUT.
3602 ;; Move to next keyword.
3604 ;; If affiliated keywords are orphaned: move back to first one.
3605 ;; They will be parsed as a paragraph.
3607 ;; Return value.
3611 \f
3612 ;;; The Org Parser
3613 ;;
3614 ;; The two major functions here are `org-element-parse-buffer', which
3615 ;; parses Org syntax inside the current buffer, taking into account
3616 ;; region, narrowing, or even visibility if specified, and
3617 ;; `org-element-parse-secondary-string', which parses objects within
3618 ;; a given string.
3619 ;;
3620 ;; The (almost) almighty `org-element-map' allows to apply a function
3621 ;; on elements or objects matching some type, and accumulate the
3622 ;; resulting values. In an export situation, it also skips unneeded
3623 ;; parts of the parse tree.
3626 "Recursively parse the buffer and return structure.
3627 If narrowing is in effect, only parse the visible part of the
3628 buffer.
3630 Optional argument GRANULARITY determines the depth of the
3631 recursion. It can be set to the following symbols:
3633 `headline' Only parse headlines.
3634 `greater-element' Don't recurse into greater elements excepted
3635 headlines and sections. Thus, elements
3636 parsed are the top-level ones.
3637 `element' Parse everything but objects and plain text.
3638 `object' Parse the complete buffer (default).
3640 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3641 elements.
3643 Assume buffer is in Org mode."
3649 ;; Start in `first-section' mode so text before the first
3650 ;; headline belongs to a section.
3654 "Recursively parse objects in STRING and return structure.
3656 RESTRICTION is a symbol limiting the object types that will be
3657 looked after.
3659 Optional argument PARENT, when non-nil, is the element or object
3660 containing the secondary string. It is used to set correctly
3661 `:parent' property within the string."
3667 secondary))))
3670 "Map a function on selected elements or objects.
3672 DATA is the parsed tree, as returned by, i.e,
3673 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3674 of elements or objects types. FUN is the function called on the
3675 matching element or object. It must accept one arguments: the
3676 element or object itself.
3678 When optional argument INFO is non-nil, it should be a plist
3679 holding export options. In that case, parts of the parse tree
3680 not exportable according to that property list will be skipped.
3682 When optional argument FIRST-MATCH is non-nil, stop at the first
3683 match for which FUN doesn't return nil, and return that value.
3685 Optional argument NO-RECURSION is a symbol or a list of symbols
3686 representing elements or objects types. `org-element-map' won't
3687 enter any recursive element or object whose type belongs to that
3688 list. Though, FUN can still be applied on them.
3690 Nil values returned from FUN do not appear in the results."
3691 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3694 ;; Recursion depth is determined by --CATEGORY.
3701 ;; If one object is found, the function
3702 ;; has to recurse into every object.
3705 ;; If one regular element is found, the
3706 ;; function has to recurse, at least,
3707 ;; into every element it encounters.
3710 types)
3711 category)))
3712 --acc
3713 --walk-tree
3717 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3718 ;; holding contextual information.
3722 ;; Ignored element in an export context.
3724 ;; Secondary string: only objects can be found there.
3727 ;; Unconditionally enter parse trees.
3731 ;; Check if TYPE is matching among TYPES. If so,
3732 ;; apply FUN to --DATA and accumulate return value
3733 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3739 ;; If --DATA has a secondary string that can contain
3740 ;; objects with their type among TYPES, look into it.
3747 ;; Determine if a recursion into --DATA is possible.
3749 ;; --TYPE is explicitly removed from recursion.
3751 ;; --DATA has no contents.
3753 ;; Looking for greater elements but --DATA is simply
3754 ;; an element or an object.
3757 ;; Looking for elements but --DATA is an object.
3760 ;; In any other case, map contents.
3764 ;; Return value in a proper order.
3767 ;; The following functions are internal parts of the parser.
3768 ;;
3769 ;; The first one, `org-element--parse-elements' acts at the element's
3770 ;; level.
3771 ;;
3772 ;; The second one, `org-element--parse-objects' applies on all objects
3773 ;; of a paragraph or a secondary string. It uses
3774 ;; `org-element--get-next-object-candidates' to optimize the search of
3775 ;; the next object in the buffer.
3776 ;;
3777 ;; More precisely, that function looks for every allowed object type
3778 ;; first. Then, it discards failed searches, keeps further matches,
3779 ;; and searches again types matched behind point, for subsequent
3780 ;; calls. Thus, searching for a given type fails only once, and every
3781 ;; object is searched only once at top level (but sometimes more for
3782 ;; nested types).
3786 "Parse elements between BEG and END positions.
3788 SPECIAL prioritize some elements over the others. It can be set
3789 to `first-section', `quote-section', `section' `item' or
3790 `table-row'.
3792 When value is `item', STRUCTURE will be used as the current list
3793 structure.
3795 GRANULARITY determines the depth of the recursion. See
3796 `org-element-parse-buffer' for more information.
3798 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3799 elements.
3801 Elements are accumulated into ACC."
3804 ;; When parsing only headlines, skip any text before first one.
3807 ;; Main loop start.
3809 ;; Find current element's type and parse it accordingly to
3810 ;; its category.
3812 end granularity special structure))
3816 ;; Fill ELEMENT contents by side-effect.
3818 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3819 ;; no contents, don't modify it.
3822 ;; Greater element: parse it between `contents-begin' and
3823 ;; `contents-end'. Make sure GRANULARITY allows the
3824 ;; recursion, or ELEMENT is an headline, in which case going
3825 ;; inside is mandatory, in order to get sub-level headings.
3833 ;; Possibly switch to a special mode.
3842 granularity visible-only element))
3843 ;; ELEMENT has contents. Parse objects inside, if
3844 ;; GRANULARITY allows it.
3850 ;; Return result.
3851 acc))
3854 "Parse objects between BEG and END and return recursive structure.
3856 Objects are accumulated in ACC.
3858 RESTRICTION is a list of object types which are allowed in the
3859 current object."
3865 end restriction candidates)))
3872 ;; 1. Text before any object. Untabify it.
3877 acc
3881 ;; 2. Object...
3884 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3885 ;; a recursive type.
3890 cont-beg
3897 ;; 3. Text after last object. Untabify it.
3901 acc
3905 ;; Result.
3906 acc)))
3909 "Return an alist of candidates for the next object.
3911 LIMIT bounds the search, and RESTRICTION narrows candidates to
3912 some object types.
3914 Return value is an alist whose CAR is position and CDR the object
3915 type, as a symbol.
3917 OBJECTS is the previous candidates alist."
3919 ;; If no previous result, search every object type in RESTRICTION.
3920 ;; Otherwise, keep potential candidates (old objects located after
3921 ;; point) and ask to search again those which had matched before.
3926 objects))
3927 ;; Call the appropriate successor function for each type to search
3928 ;; and accumulate matches.
3935 type))))
3938 types-to-search)
3939 ;; Return alist.
3940 next-candidates))
3943 \f
3944 ;;; Towards A Bijective Process
3945 ;;
3946 ;; The parse tree obtained with `org-element-parse-buffer' is really
3947 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3948 ;; interpreted and expanded into a string with canonical Org syntax.
3949 ;; Hence `org-element-interpret-data'.
3950 ;;
3951 ;; The function relies internally on
3952 ;; `org-element--interpret-affiliated-keywords'.
3954 ;;;###autoload
3956 "Interpret DATA as Org syntax.
3958 DATA is a parse tree, an element, an object or a secondary string
3959 to interpret.
3961 Optional argument PARENT is used for recursive calls. It contains
3962 the element or object containing data, or nil.
3964 Return Org syntax as a string."
3968 ;; Secondary string.
3973 ;; Full Org document.
3978 ;; Plain text.
3980 ;; Element/Object without contents.
3983 data nil))
3984 ;; Element/Object with contents.
3994 ;; Elements directly containing objects must
3995 ;; have their indentation normalized first.
3997 data
3998 ;; When normalizing first paragraph of an
3999 ;; item or a footnote-definition, ignore
4000 ;; first line's indentation.
4007 data
4009 contents)))))))
4011 ;; Build white spaces. If no `:post-blank' property is
4012 ;; specified, assume its value is 0.
4022 "Return ELEMENT's affiliated keywords as Org syntax.
4023 If there is no affiliated keyword, return the empty string."
4033 ": "
4036 value)
4044 ;; All attribute keywords can have multiple lines.
4050 ;; List all ELEMENT's properties matching an attribute line or an
4051 ;; affiliated keyword, but ignore translated keywords since they
4052 ;; cannot belong to the property list.
4059 org-element-keyword-translation-alist)))))
4060 collect prop)
4063 ;; Because interpretation of the parse tree must return the same
4064 ;; number of blank lines between elements and the same number of white
4065 ;; space after objects, some special care must be given to white
4066 ;; spaces.
4067 ;;
4068 ;; The first function, `org-element-normalize-string', ensures any
4069 ;; string different from the empty string will end with a single
4070 ;; newline character.
4071 ;;
4072 ;; The second function, `org-element-normalize-contents', removes
4073 ;; global indentation from the contents of the current element.
4076 "Ensure string S ends with a single newline character.
4078 If S isn't a string return it unchanged. If S is the empty
4079 string, return it. Otherwise, return a new string with a single
4080 newline character at its end."
4088 "Normalize plain text in ELEMENT's contents.
4090 ELEMENT must only contain plain text and objects.
4092 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4093 indentation to compute maximal common indentation.
4095 Return the normalized element that is element with global
4096 indentation removed from its contents. The function assumes that
4097 indentation is not done with TAB characters."
4099 collect-inds ; for byte-compiler
4102 ;; Return list of indentations within BLOB. This is done by
4103 ;; walking recursively BLOB and updating IND-LIST along the
4104 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4105 ;; been seen yet. It is required as this string is the only
4106 ;; one whose indentation doesn't happen after a newline
4107 ;; character.
4115 ;; An indentation of zero means no string will be
4116 ;; modified. Quit the process.
4122 ;; Avoid matching blank or empty lines.
4130 ;; Collect indentation list in ELEMENT. Possibly remove first
4131 ;; value if IGNORE-FIRST is non-nil.
4134 ;; Build ELEMENT back, replacing each string with the same
4135 ;; string minus common indentation.
4140 ;; Return BLOB with all its strings indentation
4141 ;; shortened from MCI white spaces. FIRST-FLAG is
4142 ;; non-nil when the first string hasn't been seen
4143 ;; yet.
4157 org-element-recursive-objects)
4161 blob))))
4165 \f
4166 ;;; The Toolbox
4167 ;;
4168 ;; The first move is to implement a way to obtain the smallest element
4169 ;; containing point. This is the job of `org-element-at-point'. It
4170 ;; basically jumps back to the beginning of section containing point
4171 ;; and moves, element after element, with
4172 ;; `org-element--current-element' until the container is found. Note:
4173 ;; When using `org-element-at-point', secondary values are never
4174 ;; parsed since the function focuses on elements, not on objects.
4175 ;;
4176 ;; At a deeper level, `org-element-context' lists all elements and
4177 ;; objects containing point.
4178 ;;
4179 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4180 ;; internally by navigation and manipulation tools.
4182 ;;;###autoload
4184 "Determine closest element around point.
4186 Return value is a list like (TYPE PROPS) where TYPE is the type
4187 of the element and PROPS a plist of properties associated to the
4188 element.
4190 Possible types are defined in `org-element-all-elements'.
4191 Properties depend on element or object type, but always
4192 include :begin, :end, :parent and :post-blank properties.
4194 As a special case, if point is at the very beginning of a list or
4195 sub-list, returned element will be that list instead of the first
4196 item. In the same way, if point is at the beginning of the first
4197 row of a table, returned element will be the table instead of the
4198 first row.
4200 If optional argument KEEP-TRAIL is non-nil, the function returns
4201 a list of of elements leading to element at point. The list's
4202 CAR is always the element at point. Following positions contain
4203 element's siblings, then parents, siblings of parents, until the
4204 first element of current section."
4206 ;; If at an headline, parse it. It is the sole element that
4207 ;; doesn't require to know about context. Be sure to disallow
4208 ;; secondary string parsing, though.
4214 ;; Otherwise move at the beginning of the section containing
4215 ;; point.
4219 element type special-flag trail struct prevs parent)
4227 ;; Parse successively each element, skipping those ending
4228 ;; before original position.
4237 ;; 1. Skip any element ending before point. Also skip
4238 ;; element ending at point when we're sure that another
4239 ;; element has started.
4244 ;; 2. An element containing point is always the element at
4245 ;; point.
4248 ;; 3. At any other greater element type, if point is
4249 ;; within contents, move into it.
4254 ;; Create an anchor for tables and plain lists:
4255 ;; when point is at the very beginning of these
4256 ;; elements, ignoring affiliated keywords,
4257 ;; target them instead of their contents.
4259 ;; When point is at contents end, do not move
4260 ;; into elements with an explicit ending, but
4261 ;; return that element instead.
4265 drawer dynamic-block inlinetask item
4266 plain-list property-drawer quote-block
4267 special-block))))
4280 ;;;###autoload
4282 "Return closest element or object around point.
4284 Return value is a list like (TYPE PROPS) where TYPE is the type
4285 of the element or object and PROPS a plist of properties
4286 associated to it.
4288 Possible types are defined in `org-element-all-elements' and
4289 `org-element-all-objects'. Properties depend on element or
4290 object type, but always include :begin, :end, :parent
4291 and :post-blank properties."
4296 end)
4297 ;; Check if point is inside an element containing objects or at
4298 ;; a secondary string. In that case, move to beginning of the
4299 ;; element or secondary string and set END to the other side.
4308 (<= origin
4309 ;; `1+' is required so some
4310 ;; successors can match
4311 ;; properly their object.
4325 element
4328 candidates)
4331 end restriction candidates))
4333 candidates)))
4334 ;; If ORIGIN is before next object in element, there's
4335 ;; no point in looking further.
4344 ;; ORIGIN is after OBJECT, so skip it.
4347 ;; ORIGIN is within a non-recursive object or at an
4348 ;; object boundaries: Return that object.
4352 ;; Otherwise, move within current object and restrict
4353 ;; search to the end of its contents.
4357 parent))))))
4360 "Non-nil when elements ELEM-A and ELEM-B are nested."
4369 "Swap elements ELEM-A and ELEM-B.
4370 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4371 end of ELEM-A."
4373 ;; There are two special cases when an element doesn't start at bol:
4374 ;; the first paragraph in an item or in a footnote definition.
4376 ;; Only a paragraph without any affiliated keyword can be moved at
4377 ;; ELEM-A position in such a situation. Note that the case of
4378 ;; a footnote definition is impossible: it cannot contain two
4379 ;; paragraphs in a row because it cannot contain a blank line.
4385 ;; In a special situation, ELEM-A will have no indentation. We'll
4386 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4400 ;; Store overlays responsible for visibility status. We
4401 ;; also need to store their boundaries as they will be
4402 ;; removed from buffer.
4409 ;; Get contents.
4417 ;; Restore ex ELEM-A overlays.
4426 ;; Restore ex ELEM-B overlays.
4435 ;;; org-element.el ends here