| blob | 53499c06f3634d2787aa81a8823c6295c856db63 |
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 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 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
290 inline-src-block latex-or-entity line-break link macro
291 radio-target sub/superscript target text-markup
292 timestamp)
294 radio-target statistics-cookie sub/superscript target text-markup
295 timestamp)
306 inline-src-block latex-or-entity line-break link macro
307 radio-target statistics-cookie sub/superscript target text-markup
308 timestamp)
311 latex-or-entity link radio-target sub/superscript target
312 text-markup timestamp)
323 latex-or-entity line-break link macro radio-target
325 "Alist of objects restrictions.
327 CAR is an element or object type containing objects and CDR is
328 a list of successors that will be called within an element or
329 object of such type.
331 For example, in a `radio-target' object, one can only find
332 entities, export snippets, latex-fragments, subscript and
333 superscript.
335 This alist also applies to secondary string. For example, an
336 `headline' type element doesn't directly contain objects, but
347 \f
348 ;;; Accessors and Setters
349 ;;
350 ;; Provide four accessors: `org-element-type', `org-element-property'
351 ;; `org-element-contents' and `org-element-restriction'.
352 ;;
353 ;; Setter functions allow to modify elements by side effect. There is
354 ;; `org-element-put-property', `org-element-set-contents',
355 ;; `org-element-set-element' and `org-element-adopt-element'. Note
356 ;; that `org-element-set-element' and `org-element-adopt-elements' are
357 ;; higher level functions since also update `:parent' property.
360 "Return type of ELEMENT.
362 The function returns the type of the element or object provided.
363 It can also return the following special value:
364 `plain-text' for a string
365 `org-data' for a complete document
366 nil in any other case."
372 "Extract the value from the PROPERTY of an ELEMENT."
376 "Extract contents from an ELEMENT."
380 "Return restriction associated to ELEMENT.
381 ELEMENT can be an element, an object or a symbol representing an
382 element or object type."
384 org-element-object-restrictions)))
387 "In ELEMENT set PROPERTY to VALUE.
388 Return modified element."
391 element)
394 "Set ELEMENT contents to CONTENTS.
395 Return modified element."
401 "Replace element or object OLD with element or object NEW.
402 The function takes care of setting `:parent' property for NEW."
403 ;; Since OLD is going to be changed into NEW by side-effect, first
404 ;; make sure that every element or object within NEW has OLD as
405 ;; parent.
408 ;; Transfer contents.
410 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
411 ;; with NEW's.
414 ;; Transfer type.
418 "Append elements to the contents of another element.
420 PARENT is an element or object. CHILDREN can be elements,
421 objects, or a strings.
423 The function takes care of setting `:parent' property for CHILD.
424 Return parent element."
426 ;; Link every child to PARENT.
430 children)
431 ;; Add CHILDREN at the end of PARENT contents.
433 parent
435 ;; Return modified PARENT element.
436 parent))
439 \f
440 ;;; Greater elements
441 ;;
442 ;; For each greater element type, we define a parser and an
443 ;; interpreter.
444 ;;
445 ;; A parser returns the element or object as the list described above.
446 ;; Most of them accepts no argument. Though, exceptions exist. Hence
447 ;; every element containing a secondary string (see
448 ;; `org-element-secondary-value-alist') will accept an optional
449 ;; argument to toggle parsing of that secondary string. Moreover,
450 ;; `item' parser requires current list's structure as its first
451 ;; element.
452 ;;
453 ;; An interpreter accepts two arguments: the list representation of
454 ;; the element or object, and its contents. The latter may be nil,
455 ;; depending on the element or object considered. It returns the
456 ;; appropriate Org syntax, as a string.
457 ;;
458 ;; Parsing functions must follow the naming convention:
459 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
460 ;; defined in `org-element-greater-elements'.
461 ;;
462 ;; Similarly, interpreting functions must follow the naming
463 ;; convention: org-element-TYPE-interpreter.
464 ;;
465 ;; With the exception of `headline' and `item' types, greater elements
466 ;; cannot contain other greater elements of their own type.
467 ;;
468 ;; Beside implementing a parser and an interpreter, adding a new
469 ;; greater element requires to tweak `org-element--current-element'.
470 ;; Moreover, the newly defined type must be added to both
471 ;; `org-element-all-elements' and `org-element-greater-elements'.
474 ;;;; Center Block
477 "Parse a center block.
479 LIMIT bounds the search. AFFILIATED is a list of which CAR is
480 the buffer position at the beginning of the first affiliated
481 keyword and CDR is a plist of affiliated keywords along with
482 their value.
484 Return a list whose CAR is `center-block' and CDR is a plist
485 containing `:begin', `:end', `:hiddenp', `:contents-begin',
486 `:contents-end' and `:post-blank' keywords.
488 Assume point is at the beginning of the block."
492 ;; Incomplete block: parse it as a paragraph.
496 ;; Empty blocks have no contents.
510 :end end
511 :hiddenp hidden
512 :contents-begin contents-begin
513 :contents-end contents-end
518 "Interpret CENTER-BLOCK element as Org syntax.
519 CONTENTS is the contents of the element."
523 ;;;; Drawer
526 "Parse a drawer.
528 LIMIT bounds the search. AFFILIATED is a list of which CAR is
529 the buffer position at the beginning of the first affiliated
530 keyword and CDR is a plist of affiliated keywords along with
531 their value.
533 Return a list whose CAR is `drawer' and CDR is a plist containing
534 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
535 `:contents-end' and `:post-blank' keywords.
537 Assume point is at beginning of drawer."
540 ;; Incomplete drawer: parse it as a paragraph.
547 ;; Empty drawers have no contents.
561 :end end
562 :drawer-name name
563 :hiddenp hidden
564 :contents-begin contents-begin
565 :contents-end contents-end
570 "Interpret DRAWER element as Org syntax.
571 CONTENTS is the contents of the element."
574 contents))
577 ;;;; Dynamic Block
580 "Parse a dynamic block.
582 LIMIT bounds the search. AFFILIATED is a list of which CAR is
583 the buffer position at the beginning of the first affiliated
584 keyword and CDR is a plist of affiliated keywords along with
585 their value.
587 Return a list whose CAR is `dynamic-block' and CDR is a plist
588 containing `:block-name', `:begin', `:end', `:hiddenp',
589 `:contents-begin', `:contents-end', `:arguments' and
590 `:post-blank' keywords.
592 Assume point is at beginning of dynamic block."
596 ;; Incomplete block: parse it as a paragraph.
604 ;; Empty blocks have no contents.
618 :end end
619 :block-name name
620 :arguments arguments
621 :hiddenp hidden
622 :contents-begin contents-begin
623 :contents-end contents-end
628 "Interpret DYNAMIC-BLOCK element as Org syntax.
629 CONTENTS is the contents of the element."
634 contents))
637 ;;;; Footnote Definition
640 "Parse a footnote definition.
642 LIMIT bounds the search. AFFILIATED is a list of which CAR is
643 the buffer position at the beginning of the first affiliated
644 keyword and CDR is a plist of affiliated keywords along with
645 their value.
647 Return a list whose CAR is `footnote-definition' and CDR is
648 a plist containing `:label', `:begin' `:end', `:contents-begin',
649 `:contents-end' and `:post-blank' keywords.
651 Assume point is at the beginning of the footnote definition."
675 :begin begin
676 :end end
677 :contents-begin contents-begin
678 :contents-end contents-end
683 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
684 CONTENTS is the contents of the footnote-definition."
686 " "
687 contents))
690 ;;;; Headline
693 "Parse an headline.
695 Return a list whose CAR is `headline' and CDR is a plist
696 containing `:raw-value', `:title', `:begin', `:end',
697 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
698 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
699 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
700 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
701 keywords.
703 The plist also contains any property set in the property drawer,
704 with its name in lowercase, the underscores replaced with hyphens
705 and colons at the beginning (i.e. `:custom-id').
707 When RAW-SECONDARY-P is non-nil, headline's title will not be
708 parsed as a secondary string, but as a plain string instead.
710 Assume point is at beginning of the headline."
723 raw-value)))
727 raw-value)))
731 ;; Normalize property names: ":SOME_PROP:" becomes
732 ;; ":some-prop".
744 plist))
762 ;; Clean RAW-VALUE from any quote or comment string.
770 ""
771 raw-value))))
772 ;; Clean TAGS from archive tag, if any.
778 :begin begin
779 :end end
780 :pre-blank
783 :hiddenp hidden
784 :contents-begin contents-begin
785 :contents-end contents-end
786 :level level
788 :tags tags
789 :todo-keyword todo
790 :todo-type todo-type
791 :scheduled scheduled
792 :deadline deadline
793 :timestamp timestamp
794 :clock clock
800 end)
801 :footnote-section-p footnote-section-p
802 :archivedp archivedp
803 :commentedp commentedp
805 standard-props))))
807 headline :title
813 "Interpret HEADLINE element as Org syntax.
814 CONTENTS is the contents of the element."
841 ;; Align tags.
849 ? )
850 tags))
854 tags))))
856 contents)))
859 ;;;; Inlinetask
862 "Parse an inline task.
864 Return a list whose CAR is `inlinetask' and CDR is a plist
865 containing `:title', `:begin', `:end', `:hiddenp',
866 `:contents-begin' and `:contents-end', `:level', `:priority',
867 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
868 `:scheduled', `:deadline', `:timestamp', `:clock' and
869 `:post-blank' keywords.
871 The plist also contains any property set in the property drawer,
872 with its name in lowercase, the underscores replaced with hyphens
873 and colons at the beginning (i.e. `:custom-id').
875 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
876 title will not be parsed as a secondary string, but as a plain
877 string instead.
879 Assume point is at beginning of the inline task."
890 ;; Normalize property names: ":SOME_PROP:" becomes
891 ;; ":some-prop".
903 plist))
927 :begin begin
928 :end end
929 :hiddenp hidden
930 :contents-begin contents-begin
931 :contents-end contents-end
934 :tags tags
935 :todo-keyword todo
936 :todo-type todo-type
937 :scheduled scheduled
938 :deadline deadline
939 :timestamp timestamp
940 :clock clock
942 standard-props
945 inlinetask :title
948 raw-value
950 inlinetask))))))
953 "Interpret INLINETASK element as Org syntax.
954 CONTENTS is the contents of inlinetask."
969 ;; Align tags.
977 ? )
978 tags))
982 tags))))
983 ;; Prefer degenerate inlinetasks when there are no
984 ;; contents.
987 contents
991 ;;;; Item
994 "Parse an item.
996 STRUCT is the structure of the plain list.
998 Return a list whose CAR is `item' and CDR is a plist containing
999 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1000 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1001 `:post-blank' keywords.
1003 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1004 any, will not be parsed as a secondary string, but as a plain
1005 string instead.
1007 Assume point is at the beginning of the item."
1031 ;; Ignore tags in un-ordered lists: they are just
1032 ;; a part of item's body.
1038 ;; If first line isn't empty, contents really start
1039 ;; at the text after item's meta-data.
1050 :begin begin
1051 :end end
1052 ;; CONTENTS-BEGIN and CONTENTS-END may be
1053 ;; mixed up in the case of an empty item
1054 ;; separated from the next by a blank line.
1055 ;; Thus ensure the former is always the
1056 ;; smallest.
1059 :checkbox checkbox
1060 :counter counter
1061 :hiddenp hidden
1062 :structure struct
1065 item :tag
1073 "Interpret ITEM element as Org syntax.
1074 CONTENTS is the contents of the element."
1080 ;; Compute indentation.
1085 ;; Indent contents.
1087 bullet
1100 ;;;; Plain List
1103 "Parse a plain list.
1105 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1106 the buffer position at the beginning of the first affiliated
1107 keyword and CDR is a plist of affiliated keywords along with
1108 their value. STRUCTURE is the structure of the plain list being
1109 parsed.
1111 Return a list whose CAR is `plain-list' and CDR is a plist
1112 containing `:type', `:begin', `:end', `:contents-begin' and
1113 `:contents-end', `:structure' and `:post-blank' keywords.
1115 Assume point is at the beginning of the list."
1129 ;; Return value.
1133 :begin begin
1134 :end end
1135 :contents-begin contents-begin
1136 :contents-end contents-end
1137 :structure struct
1142 "Interpret PLAIN-LIST element as Org syntax.
1143 CONTENTS is the contents of the element."
1151 ;;;; Property Drawer
1154 "Parse a property drawer.
1156 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1157 the buffer position at the beginning of the first affiliated
1158 keyword and CDR is a plist of affiliated keywords along with
1159 their value.
1161 Return a list whose CAR is `property-drawer' and CDR is a plist
1162 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1163 `:contents-end' and `:post-blank' keywords.
1165 Assume point is at the beginning of the property drawer."
1170 ;; Incomplete drawer: parse it as a paragraph.
1188 :end end
1189 :hiddenp hidden
1190 :contents-begin contents-begin
1191 :contents-end contents-end
1196 "Interpret PROPERTY-DRAWER element as Org syntax.
1197 CONTENTS is the properties within the drawer."
1201 ;;;; Quote Block
1204 "Parse a quote block.
1206 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1207 the buffer position at the beginning of the first affiliated
1208 keyword and CDR is a plist of affiliated keywords along with
1209 their value.
1211 Return a list whose CAR is `quote-block' and CDR is a plist
1212 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1213 `:contents-end' and `:post-blank' keywords.
1215 Assume point is at the beginning of the block."
1219 ;; Incomplete block: parse it as a paragraph.
1224 ;; Empty blocks have no contents.
1238 :end end
1239 :hiddenp hidden
1240 :contents-begin contents-begin
1241 :contents-end contents-end
1246 "Interpret QUOTE-BLOCK element as Org syntax.
1247 CONTENTS is the contents of the element."
1251 ;;;; Section
1254 "Parse a section.
1256 LIMIT bounds the search.
1258 Return a list whose CAR is `section' and CDR is a plist
1259 containing `:begin', `:end', `:contents-begin', `contents-end'
1260 and `:post-blank' keywords."
1262 ;; Beginning of section is the beginning of the first non-blank
1263 ;; line after previous headline.
1272 :end end
1273 :contents-begin begin
1274 :contents-end pos-before-blank
1278 "Interpret SECTION element as Org syntax.
1279 CONTENTS is the contents of the element."
1280 contents)
1283 ;;;; Special Block
1286 "Parse a special block.
1288 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1289 the buffer position at the beginning of the first affiliated
1290 keyword and CDR is a plist of affiliated keywords along with
1291 their value.
1293 Return a list whose CAR is `special-block' and CDR is a plist
1294 containing `:type', `:begin', `:end', `:hiddenp',
1295 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1297 Assume point is at the beginning of the block."
1304 ;; Incomplete block: parse it as a paragraph.
1309 ;; Empty blocks have no contents.
1323 :begin begin
1324 :end end
1325 :hiddenp hidden
1326 :contents-begin contents-begin
1327 :contents-end contents-end
1332 "Interpret SPECIAL-BLOCK element as Org syntax.
1333 CONTENTS is the contents of the element."
1338 \f
1339 ;;; Elements
1340 ;;
1341 ;; For each element, a parser and an interpreter are also defined.
1342 ;; Both follow the same naming convention used for greater elements.
1343 ;;
1344 ;; Also, as for greater elements, adding a new element type is done
1345 ;; through the following steps: implement a parser and an interpreter,
1346 ;; tweak `org-element--current-element' so that it recognizes the new
1347 ;; type and add that new type to `org-element-all-elements'.
1348 ;;
1349 ;; As a special case, when the newly defined type is a block type,
1350 ;; `org-element-block-name-alist' has to be modified accordingly.
1353 ;;;; Babel Call
1356 "Parse a babel call.
1358 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1359 the buffer position at the beginning of the first affiliated
1360 keyword and CDR is a plist of affiliated keywords along with
1361 their value.
1363 Return a list whose CAR is `babel-call' and CDR is a plist
1364 containing `:begin', `:end', `:info' and `:post-blank' as
1365 keywords."
1377 :end end
1378 :info info
1383 "Interpret BABEL-CALL element as Org syntax.
1384 CONTENTS is nil."
1390 ;; Remove redundant square brackets.
1395 ;;;; Clock
1398 "Parse a clock.
1400 LIMIT bounds the search.
1402 Return a list whose CAR is `clock' and CDR is a plist containing
1403 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1404 as keywords."
1423 :value value
1424 :time time
1425 :begin begin
1426 :end end
1430 "Interpret CLOCK element as Org syntax.
1431 CONTENTS is nil."
1438 "%2s:%02s"
1442 ;;;; Comment
1445 "Parse a comment.
1447 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1448 the buffer position at the beginning of the first affiliated
1449 keyword and CDR is a plist of affiliated keywords along with
1450 their value.
1452 Return a list whose CAR is `comment' and CDR is a plist
1453 containing `:begin', `:end', `:value' and `:post-blank'
1454 keywords.
1456 Assume point is at comment beginning."
1464 ;; Get comments ending.
1467 ;; Accumulate lines without leading hash and first
1468 ;; whitespace.
1482 :end end
1483 :value value
1488 "Interpret COMMENT element as Org syntax.
1489 CONTENTS is nil."
1493 ;;;; Comment Block
1496 "Parse an export block.
1498 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1499 the buffer position at the beginning of the first affiliated
1500 keyword and CDR is a plist of affiliated keywords along with
1501 their value.
1503 Return a list whose CAR is `comment-block' and CDR is a plist
1504 containing `:begin', `:end', `:hiddenp', `:value' and
1505 `:post-blank' keywords.
1507 Assume point is at comment block beginning."
1511 ;; Incomplete block: parse it as a paragraph.
1524 contents-begin contents-end)))
1528 :end end
1529 :value value
1530 :hiddenp hidden
1535 "Interpret COMMENT-BLOCK element as Org syntax.
1536 CONTENTS is nil."
1541 ;;;; Example Block
1544 "Parse an example block.
1546 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1547 the buffer position at the beginning of the first affiliated
1548 keyword and CDR is a plist of affiliated keywords along with
1549 their value.
1551 Return a list whose CAR is `example-block' and CDR is a plist
1552 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1553 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1554 `:switches', `:value' and `:post-blank' keywords."
1558 ;; Incomplete block: parse it as a paragraph.
1565 ;; Switches analysis
1570 ;; Should labels be retained in (or stripped from) example
1571 ;; blocks?
1576 ;; What should code-references use - labels or
1577 ;; line-numbers?
1584 ;; Standard block parsing.
1597 :end end
1598 :value value
1599 :switches switches
1600 :number-lines number-lines
1601 :preserve-indent preserve-indent
1602 :retain-labels retain-labels
1603 :use-labels use-labels
1604 :label-fmt label-fmt
1605 :hiddenp hidden
1610 "Interpret EXAMPLE-BLOCK element as Org syntax.
1611 CONTENTS is nil."
1619 ;;;; Export Block
1622 "Parse an export block.
1624 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1625 the buffer position at the beginning of the first affiliated
1626 keyword and CDR is a plist of affiliated keywords along with
1627 their value.
1629 Return a list whose CAR is `export-block' and CDR is a plist
1630 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1631 `:post-blank' keywords.
1633 Assume point is at export-block beginning."
1640 ;; Incomplete block: parse it as a paragraph.
1653 contents-end)))
1657 :end end
1658 :type type
1659 :value value
1660 :hiddenp hidden
1665 "Interpret EXPORT-BLOCK element as Org syntax.
1666 CONTENTS is nil."
1673 ;;;; Fixed-width
1676 "Parse a fixed-width section.
1678 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1679 the buffer position at the beginning of the first affiliated
1680 keyword and CDR is a plist of affiliated keywords along with
1681 their value.
1683 Return a list whose CAR is `fixed-width' and CDR is a plist
1684 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1686 Assume point is at the beginning of the fixed-width area."
1689 value
1694 ;; Accumulate text without starting colons.
1707 :end end
1708 :value value
1713 "Interpret FIXED-WIDTH element as Org syntax.
1714 CONTENTS is nil."
1719 ;;;; Horizontal Rule
1722 "Parse an horizontal rule.
1724 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1725 the buffer position at the beginning of the first affiliated
1726 keyword and CDR is a plist of affiliated keywords along with
1727 their value.
1729 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1730 containing `:begin', `:end' and `:post-blank' keywords."
1739 :end end
1744 "Interpret HORIZONTAL-RULE element as Org syntax.
1745 CONTENTS is nil."
1749 ;;;; Keyword
1752 "Parse a keyword at point.
1754 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1755 the buffer position at the beginning of the first affiliated
1756 keyword and CDR is a plist of affiliated keywords along with
1757 their value.
1759 Return a list whose CAR is `keyword' and CDR is a plist
1760 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1761 keywords."
1775 :value value
1776 :begin begin
1777 :end end
1782 "Interpret KEYWORD element as Org syntax.
1783 CONTENTS is nil."
1789 ;;;; Latex Environment
1792 "Parse a LaTeX environment.
1794 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1795 the buffer position at the beginning of the first affiliated
1796 keyword and CDR is a plist of affiliated keywords along with
1797 their value.
1799 Return a list whose CAR is `latex-environment' and CDR is a plist
1800 containing `:begin', `:end', `:value' and `:post-blank'
1801 keywords.
1803 Assume point is at the beginning of the latex environment."
1821 :end end
1822 :value value
1827 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1828 CONTENTS is nil."
1832 ;;;; Node Property
1835 "Parse a node-property at point.
1837 LIMIT bounds the search.
1839 Return a list whose CAR is `node-property' and CDR is a plist
1840 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1841 keywords."
1853 :value value
1854 :begin begin
1855 :end end
1859 "Interpret NODE-PROPERTY element as Org syntax.
1860 CONTENTS is nil."
1866 ;;;; Paragraph
1869 "Parse a paragraph.
1871 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1872 the buffer position at the beginning of the first affiliated
1873 keyword and CDR is a plist of affiliated keywords along with
1874 their value.
1876 Return a list whose CAR is `paragraph' and CDR is a plist
1877 containing `:begin', `:end', `:contents-begin' and
1878 `:contents-end' and `:post-blank' keywords.
1880 Assume point is at the beginning of the paragraph."
1889 limit
1890 ;; A matching `org-element-paragraph-separate' is not
1891 ;; necessarily the end of the paragraph. In
1892 ;; particular, lines starting with # or : as a first
1893 ;; non-space character are ambiguous. We have check
1894 ;; if they are valid Org syntax (i.e. not an
1895 ;; incomplete keyword).
1899 ;; There's no ambiguity for other symbols or
1900 ;; empty lines: stop here.
1902 ;; Stop at valid fixed-width areas.
1904 ;; Stop at drawers.
1909 ;; Stop at valid comments.
1911 ;; Stop at valid dynamic blocks.
1916 ;; Stop at valid blocks.
1923 limit t)))
1924 ;; Stop at valid latex environments.
1931 limit t)))
1932 ;; Stop at valid keywords.
1934 ;; Skip everything else.
1951 :end end
1952 :contents-begin contents-begin
1953 :contents-end contents-end
1958 "Interpret PARAGRAPH element as Org syntax.
1959 CONTENTS is the contents of the element."
1960 contents)
1963 ;;;; Planning
1966 "Parse a planning.
1968 LIMIT bounds the search.
1970 Return a list whose CAR is `planning' and CDR is a plist
1971 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1972 and `:post-blank' keywords."
1981 closed deadline scheduled)
1995 :deadline deadline
1996 :scheduled scheduled
1997 :begin begin
1998 :end end
2002 "Interpret PLANNING element as Org syntax.
2003 CONTENTS is nil."
2005 'identity
2017 ;;;; Quote Section
2020 "Parse a quote section.
2022 LIMIT bounds the search.
2024 Return a list whose CAR is `quote-section' and CDR is a plist
2025 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2027 Assume point is at beginning of the section."
2038 :end end
2039 :value value
2043 "Interpret QUOTE-SECTION element as Org syntax.
2044 CONTENTS is nil."
2048 ;;;; Src Block
2051 "Parse a src block.
2053 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2054 the buffer position at the beginning of the first affiliated
2055 keyword and CDR is a plist of affiliated keywords along with
2056 their value.
2058 Return a list whose CAR is `src-block' and CDR is a plist
2059 containing `:language', `:switches', `:parameters', `:begin',
2060 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2061 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2062 `:post-blank' keywords.
2064 Assume point is at the beginning of the block."
2067 limit t)))
2068 ;; Incomplete block: parse it as a paragraph.
2073 ;; Get language as a string.
2082 ;; Get switches.
2084 ;; Get parameters.
2086 ;; Switches analysis
2094 ;; Should labels be retained in (or stripped from)
2095 ;; src blocks?
2100 ;; What should code-references use - labels or
2101 ;; line-numbers?
2105 ;; Get visibility status.
2107 ;; Retrieve code.
2112 ;; Get position after ending blank lines.
2122 :begin begin
2123 :end end
2124 :number-lines number-lines
2125 :preserve-indent preserve-indent
2126 :retain-labels retain-labels
2127 :use-labels use-labels
2128 :label-fmt label-fmt
2129 :hiddenp hidden
2130 :value value
2135 "Interpret SRC-BLOCK element as Org syntax.
2136 CONTENTS is nil."
2156 value
2160 ;;;; Table
2163 "Parse a table at point.
2165 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2166 the buffer position at the beginning of the first affiliated
2167 keyword and CDR is a plist of affiliated keywords along with
2168 their value.
2170 Return a list whose CAR is `table' and CDR is a plist containing
2171 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2172 `:contents-end', `:value' and `:post-blank' keywords.
2174 Assume point is at the beginning of the table."
2186 acc))
2193 :end end
2194 :type type
2195 :tblfm tblfm
2196 ;; Only `org' tables have contents. `table.el' tables
2197 ;; use a `:value' property to store raw table as
2198 ;; a string.
2203 table-begin table-end))
2208 "Interpret TABLE element as Org syntax.
2209 CONTENTS is nil."
2220 ;;;; Table Row
2223 "Parse table row at point.
2225 LIMIT bounds the search.
2227 Return a list whose CAR is `table-row' and CDR is a plist
2228 containing `:begin', `:end', `:contents-begin', `:contents-end',
2229 `:type' and `:post-blank' keywords."
2233 ;; A table rule has no contents. In that case, ensure
2234 ;; CONTENTS-BEGIN matches CONTENTS-END.
2246 :begin begin
2247 :end end
2248 :contents-begin contents-begin
2249 :contents-end contents-end
2253 "Interpret TABLE-ROW element as Org syntax.
2254 CONTENTS is the contents of the table row."
2259 ;;;; Verse Block
2262 "Parse a verse block.
2264 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2265 the buffer position at the beginning of the first affiliated
2266 keyword and CDR is a plist of affiliated keywords along with
2267 their value.
2269 Return a list whose CAR is `verse-block' and CDR is a plist
2270 containing `:begin', `:end', `:contents-begin', `:contents-end',
2271 `:hiddenp' and `:post-blank' keywords.
2273 Assume point is at beginning of the block."
2277 ;; Incomplete block: parse it as a paragraph.
2292 :end end
2293 :contents-begin contents-begin
2294 :contents-end contents-end
2295 :hiddenp hidden
2300 "Interpret VERSE-BLOCK element as Org syntax.
2301 CONTENTS is verse block contents."
2305 \f
2306 ;;; Objects
2307 ;;
2308 ;; Unlike to elements, interstices can be found between objects.
2309 ;; That's why, along with the parser, successor functions are provided
2310 ;; for each object. Some objects share the same successor (i.e. `code'
2311 ;; and `verbatim' objects).
2312 ;;
2313 ;; A successor must accept a single argument bounding the search. It
2314 ;; will return either a cons cell whose CAR is the object's type, as
2315 ;; a symbol, and CDR the position of its next occurrence, or nil.
2316 ;;
2317 ;; Successors follow the naming convention:
2318 ;; org-element-NAME-successor, where NAME is the name of the
2319 ;; successor, as defined in `org-element-all-successors'.
2320 ;;
2321 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2322 ;; object types they can contain will be specified in
2323 ;; `org-element-object-restrictions'.
2324 ;;
2325 ;; Adding a new type of object is simple. Implement a successor,
2326 ;; a parser, and an interpreter for it, all following the naming
2327 ;; convention. Register type in `org-element-all-objects' and
2328 ;; successor in `org-element-all-successors'. Maybe tweak
2329 ;; restrictions about it, and that's it.
2332 ;;;; Bold
2335 "Parse bold object at point.
2337 Return a list whose CAR is `bold' and CDR is a plist with
2338 `:begin', `:end', `:contents-begin' and `:contents-end' and
2339 `:post-blank' keywords.
2341 Assume point is at the first star marker."
2353 :end end
2354 :contents-begin contents-begin
2355 :contents-end contents-end
2359 "Interpret BOLD object as Org syntax.
2360 CONTENTS is the contents of the object."
2364 "Search for the next text-markup object.
2366 LIMIT bounds the search.
2368 Return value is a cons cell whose CAR is a symbol among `bold',
2369 `italic', `underline', `strike-through', `code' and `verbatim'
2370 and CDR is beginning position."
2386 ;;;; Code
2389 "Parse code object at point.
2391 Return a list whose CAR is `code' and CDR is a plist with
2392 `:value', `:begin', `:end' and `:post-blank' keywords.
2394 Assume point is at the first tilde marker."
2405 :begin begin
2406 :end end
2410 "Interpret CODE object as Org syntax.
2411 CONTENTS is nil."
2415 ;;;; Entity
2418 "Parse entity at point.
2420 Return a list whose CAR is `entity' and CDR a plist with
2421 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2422 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2423 keywords.
2425 Assume point is at the beginning of the entity."
2427 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2443 :begin begin
2444 :end end
2445 :use-brackets-p bracketsp
2449 "Interpret ENTITY object as Org syntax.
2450 CONTENTS is nil."
2456 "Search for the next latex-fragment or entity object.
2458 LIMIT bounds the search.
2460 Return value is a cons cell whose CAR is `entity' or
2461 `latex-fragment' and CDR is beginning position."
2465 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2472 limit t)
2475 ;; Determine if it's a real entity or a LaTeX command.
2478 ;; No entity nor command: point is at a LaTeX fragment.
2479 ;; Determine its type to get the correct beginning position.
2487 matchers)
2491 ;;;; Export Snippet
2494 "Parse export snippet at point.
2496 Return a list whose CAR is `export-snippet' and CDR a plist with
2497 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2498 keywords.
2500 Assume point is at the beginning of the snippet."
2512 :value value
2513 :begin begin
2514 :end end
2518 "Interpret EXPORT-SNIPPET object as Org syntax.
2519 CONTENTS is nil."
2525 "Search for the next export-snippet object.
2527 LIMIT bounds the search.
2529 Return value is a cons cell whose CAR is `export-snippet' and CDR
2530 its beginning position."
2539 ;;;; Footnote Reference
2542 "Parse footnote reference at point.
2544 Return a list whose CAR is `footnote-reference' and CDR a plist
2545 with `:label', `:type', `:inline-definition', `:begin', `:end'
2546 and `:post-blank' as keywords."
2568 :type type
2569 :begin begin
2570 :end end
2573 footnote-reference :inline-definition
2578 footnote-reference))))))
2581 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2582 CONTENTS is nil."
2592 "Search for the next footnote-reference object.
2594 LIMIT bounds the search.
2596 Return value is a cons cell whose CAR is `footnote-reference' and
2597 CDR is beginning position."
2611 ;;;; Inline Babel Call
2614 "Parse inline babel call at point.
2616 Return a list whose CAR is `inline-babel-call' and CDR a plist
2617 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2619 Assume point is at the beginning of the babel call."
2630 :end end
2631 :info info
2635 "Interpret INLINE-BABEL-CALL object as Org syntax.
2636 CONTENTS is nil."
2642 ;; Remove redundant square brackets.
2645 main-source)
2649 "Search for the next inline-babel-call object.
2651 LIMIT bounds the search.
2653 Return value is a cons cell whose CAR is `inline-babel-call' and
2654 CDR is beginning position."
2656 ;; Use a simplified version of
2657 ;; `org-babel-inline-lob-one-liner-regexp'.
2660 limit t)
2664 ;;;; Inline Src Block
2667 "Parse inline source block at point.
2669 LIMIT bounds the search.
2671 Return a list whose CAR is `inline-src-block' and CDR a plist
2672 with `:begin', `:end', `:language', `:value', `:parameters' and
2673 `:post-blank' as keywords.
2675 Assume point is at the beginning of the inline src block."
2688 :value value
2689 :parameters parameters
2690 :begin begin
2691 :end end
2695 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2696 CONTENTS is nil."
2701 language
2703 body)))
2706 "Search for the next inline-babel-call element.
2708 LIMIT bounds the search.
2710 Return value is a cons cell whose CAR is `inline-babel-call' and
2711 CDR is beginning position."
2717 ;;;; Italic
2720 "Parse italic object at point.
2722 Return a list whose CAR is `italic' and CDR is a plist with
2723 `:begin', `:end', `:contents-begin' and `:contents-end' and
2724 `:post-blank' keywords.
2726 Assume point is at the first slash marker."
2738 :end end
2739 :contents-begin contents-begin
2740 :contents-end contents-end
2744 "Interpret ITALIC object as Org syntax.
2745 CONTENTS is the contents of the object."
2749 ;;;; Latex Fragment
2752 "Parse latex fragment at point.
2754 Return a list whose CAR is `latex-fragment' and CDR a plist with
2755 `:value', `:begin', `:end', and `:post-blank' as keywords.
2757 Assume point is at the beginning of the latex fragment."
2771 ;; None found: it's a macro.
2780 :begin begin
2781 :end end
2785 "Interpret LATEX-FRAGMENT object as Org syntax.
2786 CONTENTS is nil."
2789 ;;;; Line Break
2792 "Parse line break at point.
2794 Return a list whose CAR is `line-break', and CDR a plist with
2795 `:begin', `:end' and `:post-blank' keywords.
2797 Assume point is at the beginning of the line break."
2801 "Interpret LINE-BREAK object as Org syntax.
2802 CONTENTS is nil."
2806 "Search for the next line-break object.
2808 LIMIT bounds the search.
2810 Return value is a cons cell whose CAR is `line-break' and CDR is
2811 beginning position."
2815 ;; A line break can only happen on a non-empty line.
2820 ;;;; Link
2823 "Parse link at point.
2825 Return a list whose CAR is `link' and CDR a plist with `:type',
2826 `:path', `:raw-link', `:application', `:search-option', `:begin',
2827 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2828 keywords.
2830 Assume point is at the beginning of the link."
2833 end contents-begin contents-end link-end post-blank path type
2834 raw-link link search-option application)
2836 ;; Type 1: Text targeted from a radio target.
2841 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2846 ;; RAW-LINK is the original link.
2851 ;; Determine TYPE of link and set PATH accordingly.
2853 ;; File type.
2856 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2859 ;; Id type: PATH is the id.
2862 ;; Code-ref type: PATH is the name of the reference.
2865 ;; Custom-id type: PATH is the name of the custom id.
2868 ;; Fuzzy type: Internal link either matches a target, an
2869 ;; headline name or nothing. PATH is the target or
2870 ;; headline's name.
2872 ;; Type 3: Plain link, i.e. http://orgmode.org
2878 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2885 ;; In any case, deduce end point after trailing white space from
2886 ;; LINK-END variable.
2889 ;; Extract search option and opening application out of
2890 ;; "file"-type links.
2892 ;; Application.
2897 ;; Extract search option from PATH.
2901 ;; Make sure TYPE always report "file".
2905 :path path
2907 :application application
2908 :search-option search-option
2909 :begin begin
2910 :end end
2911 :contents-begin contents-begin
2912 :contents-end contents-end
2916 "Interpret LINK object as Org syntax.
2917 CONTENTS is the contents of the object, or nil."
2922 raw-link
2926 "Search for the next link object.
2928 LIMIT bounds the search.
2930 Return value is a cons cell whose CAR is `link' and CDR is
2931 beginning position."
2940 ;;;; Macro
2943 "Parse macro at point.
2945 Return a list whose CAR is `macro' and CDR a plist with `:key',
2946 `:args', `:begin', `:end', `:value' and `:post-blank' as
2947 keywords.
2949 Assume point is at the macro."
2963 ;; Repair bad splits.
2971 :value value
2972 :args args
2973 :begin begin
2974 :end end
2978 "Interpret MACRO object as Org syntax.
2979 CONTENTS is nil."
2983 "Search for the next macro object.
2985 LIMIT bounds the search.
2987 Return value is cons cell whose CAR is `macro' and CDR is
2988 beginning position."
2992 limit t)
2996 ;;;; Radio-target
2999 "Parse radio target at point.
3001 Return a list whose CAR is `radio-target' and CDR a plist with
3002 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3003 and `:post-blank' as keywords.
3005 Assume point is at the radio target."
3017 :end end
3018 :contents-begin contents-begin
3019 :contents-end contents-end
3020 :post-blank post-blank
3024 "Interpret TARGET object as Org syntax.
3025 CONTENTS is the contents of the object."
3029 "Search for the next radio-target object.
3031 LIMIT bounds the search.
3033 Return value is a cons cell whose CAR is `radio-target' and CDR
3034 is beginning position."
3040 ;;;; Statistics Cookie
3043 "Parse statistics cookie at point.
3045 Return a list whose CAR is `statistics-cookie', and CDR a plist
3046 with `:begin', `:end', `:value' and `:post-blank' keywords.
3048 Assume point is at the beginning of the statistics-cookie."
3059 :end end
3060 :value value
3064 "Interpret STATISTICS-COOKIE object as Org syntax.
3065 CONTENTS is nil."
3069 "Search for the next statistics cookie object.
3071 LIMIT bounds the search.
3073 Return value is a cons cell whose CAR is `statistics-cookie' and
3074 CDR is beginning position."
3080 ;;;; Strike-Through
3083 "Parse strike-through object at point.
3085 Return a list whose CAR is `strike-through' and CDR is a plist
3086 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3087 `:post-blank' keywords.
3089 Assume point is at the first plus sign marker."
3101 :end end
3102 :contents-begin contents-begin
3103 :contents-end contents-end
3107 "Interpret STRIKE-THROUGH object as Org syntax.
3108 CONTENTS is the contents of the object."
3112 ;;;; Subscript
3115 "Parse subscript at point.
3117 Return a list whose CAR is `subscript' and CDR a plist with
3118 `:begin', `:end', `:contents-begin', `:contents-end',
3119 `:use-brackets-p' and `:post-blank' as keywords.
3121 Assume point is at the underscore."
3125 t
3136 :end end
3137 :use-brackets-p bracketsp
3138 :contents-begin contents-begin
3139 :contents-end contents-end
3143 "Interpret SUBSCRIPT object as Org syntax.
3144 CONTENTS is the contents of the object."
3147 contents))
3150 "Search for the next sub/superscript object.
3152 LIMIT bounds the search.
3154 Return value is a cons cell whose CAR is either `subscript' or
3155 `superscript' and CDR is beginning position."
3162 ;;;; Superscript
3165 "Parse superscript at point.
3167 Return a list whose CAR is `superscript' and CDR a plist with
3168 `:begin', `:end', `:contents-begin', `:contents-end',
3169 `:use-brackets-p' and `:post-blank' as keywords.
3171 Assume point is at the caret."
3185 :end end
3186 :use-brackets-p bracketsp
3187 :contents-begin contents-begin
3188 :contents-end contents-end
3192 "Interpret SUPERSCRIPT object as Org syntax.
3193 CONTENTS is the contents of the object."
3196 contents))
3199 ;;;; Table Cell
3202 "Parse table cell at point.
3204 Return a list whose CAR is `table-cell' and CDR is a plist
3205 containing `:begin', `:end', `:contents-begin', `:contents-end'
3206 and `:post-blank' keywords."
3214 :end end
3215 :contents-begin contents-begin
3216 :contents-end contents-end
3220 "Interpret TABLE-CELL element as Org syntax.
3221 CONTENTS is the contents of the cell, or nil."
3225 "Search for the next table-cell object.
3227 LIMIT bounds the search.
3229 Return value is a cons cell whose CAR is `table-cell' and CDR is
3230 beginning position."
3234 ;;;; Target
3237 "Parse target at point.
3239 Return a list whose CAR is `target' and CDR a plist with
3240 `:begin', `:end', `:value' and `:post-blank' as keywords.
3242 Assume point is at the target."
3252 :end end
3253 :value value
3257 "Interpret TARGET object as Org syntax.
3258 CONTENTS is nil."
3262 "Search for the next target object.
3264 LIMIT bounds the search.
3266 Return value is a cons cell whose CAR is `target' and CDR is
3267 beginning position."
3273 ;;;; Timestamp
3276 "Parse time stamp at point.
3278 Return a list whose CAR is `timestamp', and CDR a plist with
3279 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3281 Assume point is at the beginning of the timestamp."
3300 :value main-value
3301 :range-end range-end
3302 :begin begin
3303 :end end
3307 "Interpret TIMESTAMP object as Org syntax.
3308 CONTENTS is nil."
3317 range-end)))))))
3320 "Search for the next timestamp object.
3322 LIMIT bounds the search.
3324 Return value is a cons cell whose CAR is `timestamp' and CDR is
3325 beginning position."
3333 limit t)
3337 ;;;; Underline
3340 "Parse underline object at point.
3342 Return a list whose CAR is `underline' and CDR is a plist with
3343 `:begin', `:end', `:contents-begin' and `:contents-end' and
3344 `:post-blank' keywords.
3346 Assume point is at the first underscore marker."
3358 :end end
3359 :contents-begin contents-begin
3360 :contents-end contents-end
3364 "Interpret UNDERLINE object as Org syntax.
3365 CONTENTS is the contents of the object."
3369 ;;;; Verbatim
3372 "Parse verbatim object at point.
3374 Return a list whose CAR is `verbatim' and CDR is a plist with
3375 `:value', `:begin', `:end' and `:post-blank' keywords.
3377 Assume point is at the first equal sign marker."
3388 :begin begin
3389 :end end
3393 "Interpret VERBATIM object as Org syntax.
3394 CONTENTS is nil."
3398 \f
3399 ;;; Parsing Element Starting At Point
3400 ;;
3401 ;; `org-element--current-element' is the core function of this section.
3402 ;; It returns the Lisp representation of the element starting at
3403 ;; point.
3404 ;;
3405 ;; `org-element--current-element' makes use of special modes. They
3406 ;; are activated for fixed element chaining (i.e. `plain-list' >
3407 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3408 ;; `section'). Special modes are: `first-section', `item',
3409 ;; `node-property', `quote-section', `section' and `table-row'.
3413 "Parse the element starting at point.
3415 LIMIT bounds the search.
3417 Return value is a list like (TYPE PROPS) where TYPE is the type
3418 of the element and PROPS a plist of properties associated to the
3419 element.
3421 Possible types are defined in `org-element-all-elements'.
3423 Optional argument GRANULARITY determines the depth of the
3424 recursion. Allowed values are `headline', `greater-element',
3425 `element', `object' or nil. When it is broader than `object' (or
3426 nil), secondary values will not be parsed, since they only
3427 contain objects.
3429 Optional argument SPECIAL, when non-nil, can be either
3430 `first-section', `item', `node-property', `quote-section',
3431 `section', and `table-row'.
3433 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3434 be computed.
3436 This function assumes point is always at the beginning of the
3437 element it has to parse."
3440 ;; Determine if parsing depth allows for secondary strings
3441 ;; parsing. It only applies to elements referenced in
3442 ;; `org-element-secondary-value-alist'.
3445 ;; Item.
3448 ;; Table Row.
3450 ;; Node Property.
3452 ;; Headline.
3455 ;; Sections (must be checked after headline).
3461 limit)))
3462 ;; When not at bol, point is at the beginning of an item or
3463 ;; a footnote definition: next item is always a paragraph.
3465 ;; Planning and Clock.
3470 ;; Inlinetask.
3473 ;; From there, elements can have affiliated keywords.
3476 ;; LaTeX Environment.
3482 nil t))
3485 ;; Drawer and Property Drawer.
3495 ;; Fixed Width
3498 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3499 ;; Keywords.
3508 org-element-block-name-alist)))
3523 ;; Footnote Definition.
3526 ;; Horizontal Rule.
3529 ;; Table.
3531 ;; List.
3535 ;; Default element: Paragraph.
3539 ;; Most elements can have affiliated keywords. When looking for an
3540 ;; element beginning, we want to move before them, as they belong to
3541 ;; that element, and, in the meantime, collect information they give
3542 ;; into appropriate properties. Hence the following function.
3545 "Collect affiliated keywords from point.
3547 Return a list whose CAR is the position at the first of them and
3548 CDR a plist of keywords and values and move point to the
3549 beginning of the first line after them.
3551 As a special case, if element doesn't start at the beginning of
3552 the line (i.e. a paragraph starting an item), CAR is current
3553 position of point and CDR is nil."
3557 ;; RESTRICT is the list of objects allowed in parsed
3558 ;; keywords value.
3560 output)
3563 ;; Apply translation to RAW-KWD. From there, KWD is
3564 ;; the official keyword.
3566 org-element-keyword-translation-alist))
3567 raw-kwd))
3568 ;; Find main value for any keyword.
3574 ;; PARSEDP is non-nil when keyword should have its
3575 ;; value parsed.
3577 ;; If KWD is a dual keyword, find its secondary
3578 ;; value. Maybe parse it.
3585 ;; Attribute a property name to KWD.
3587 ;; Now set final shape for VALUE.
3592 ;; Attributes can always appear on multiple lines.
3595 ;; Eventually store the new value in OUTPUT.
3597 ;; Move to next keyword.
3599 ;; If affiliated keywords are orphaned: move back to first one.
3600 ;; They will be parsed as a paragraph.
3602 ;; Return value.
3606 \f
3607 ;;; The Org Parser
3608 ;;
3609 ;; The two major functions here are `org-element-parse-buffer', which
3610 ;; parses Org syntax inside the current buffer, taking into account
3611 ;; region, narrowing, or even visibility if specified, and
3612 ;; `org-element-parse-secondary-string', which parses objects within
3613 ;; a given string.
3614 ;;
3615 ;; The (almost) almighty `org-element-map' allows to apply a function
3616 ;; on elements or objects matching some type, and accumulate the
3617 ;; resulting values. In an export situation, it also skips unneeded
3618 ;; parts of the parse tree.
3621 "Recursively parse the buffer and return structure.
3622 If narrowing is in effect, only parse the visible part of the
3623 buffer.
3625 Optional argument GRANULARITY determines the depth of the
3626 recursion. It can be set to the following symbols:
3628 `headline' Only parse headlines.
3629 `greater-element' Don't recurse into greater elements excepted
3630 headlines and sections. Thus, elements
3631 parsed are the top-level ones.
3632 `element' Parse everything but objects and plain text.
3633 `object' Parse the complete buffer (default).
3635 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3636 elements.
3638 Assume buffer is in Org mode."
3644 ;; Start in `first-section' mode so text before the first
3645 ;; headline belongs to a section.
3649 "Recursively parse objects in STRING and return structure.
3651 RESTRICTION is a symbol limiting the object types that will be
3652 looked after.
3654 Optional argument PARENT, when non-nil, is the element or object
3655 containing the secondary string. It is used to set correctly
3656 `:parent' property within the string."
3662 secondary))))
3665 "Map a function on selected elements or objects.
3667 DATA is the parsed tree, as returned by, i.e,
3668 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3669 of elements or objects types. FUN is the function called on the
3670 matching element or object. It must accept one arguments: the
3671 element or object itself.
3673 When optional argument INFO is non-nil, it should be a plist
3674 holding export options. In that case, parts of the parse tree
3675 not exportable according to that property list will be skipped.
3677 When optional argument FIRST-MATCH is non-nil, stop at the first
3678 match for which FUN doesn't return nil, and return that value.
3680 Optional argument NO-RECURSION is a symbol or a list of symbols
3681 representing elements or objects types. `org-element-map' won't
3682 enter any recursive element or object whose type belongs to that
3683 list. Though, FUN can still be applied on them.
3685 Nil values returned from FUN do not appear in the results."
3686 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3689 ;; Recursion depth is determined by --CATEGORY.
3696 ;; If one object is found, the function
3697 ;; has to recurse into every object.
3700 ;; If one regular element is found, the
3701 ;; function has to recurse, at least,
3702 ;; into every element it encounters.
3705 types)
3706 category)))
3707 --acc
3708 --walk-tree
3712 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3713 ;; holding contextual information.
3717 ;; Ignored element in an export context.
3719 ;; Secondary string: only objects can be found there.
3722 ;; Unconditionally enter parse trees.
3726 ;; Check if TYPE is matching among TYPES. If so,
3727 ;; apply FUN to --DATA and accumulate return value
3728 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3734 ;; If --DATA has a secondary string that can contain
3735 ;; objects with their type among TYPES, look into it.
3742 ;; Determine if a recursion into --DATA is possible.
3744 ;; --TYPE is explicitly removed from recursion.
3746 ;; --DATA has no contents.
3748 ;; Looking for greater elements but --DATA is simply
3749 ;; an element or an object.
3752 ;; Looking for elements but --DATA is an object.
3755 ;; In any other case, map contents.
3759 ;; Return value in a proper order.
3762 ;; The following functions are internal parts of the parser.
3763 ;;
3764 ;; The first one, `org-element--parse-elements' acts at the element's
3765 ;; level.
3766 ;;
3767 ;; The second one, `org-element--parse-objects' applies on all objects
3768 ;; of a paragraph or a secondary string. It uses
3769 ;; `org-element--get-next-object-candidates' to optimize the search of
3770 ;; the next object in the buffer.
3771 ;;
3772 ;; More precisely, that function looks for every allowed object type
3773 ;; first. Then, it discards failed searches, keeps further matches,
3774 ;; and searches again types matched behind point, for subsequent
3775 ;; calls. Thus, searching for a given type fails only once, and every
3776 ;; object is searched only once at top level (but sometimes more for
3777 ;; nested types).
3781 "Parse elements between BEG and END positions.
3783 SPECIAL prioritize some elements over the others. It can be set
3784 to `first-section', `quote-section', `section' `item' or
3785 `table-row'.
3787 When value is `item', STRUCTURE will be used as the current list
3788 structure.
3790 GRANULARITY determines the depth of the recursion. See
3791 `org-element-parse-buffer' for more information.
3793 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3794 elements.
3796 Elements are accumulated into ACC."
3799 ;; When parsing only headlines, skip any text before first one.
3802 ;; Main loop start.
3804 ;; Find current element's type and parse it accordingly to
3805 ;; its category.
3807 end granularity special structure))
3811 ;; Fill ELEMENT contents by side-effect.
3813 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3814 ;; no contents, don't modify it.
3817 ;; Greater element: parse it between `contents-begin' and
3818 ;; `contents-end'. Make sure GRANULARITY allows the
3819 ;; recursion, or ELEMENT is an headline, in which case going
3820 ;; inside is mandatory, in order to get sub-level headings.
3828 ;; Possibly switch to a special mode.
3837 granularity visible-only element))
3838 ;; ELEMENT has contents. Parse objects inside, if
3839 ;; GRANULARITY allows it.
3845 ;; Return result.
3846 acc))
3849 "Parse objects between BEG and END and return recursive structure.
3851 Objects are accumulated in ACC.
3853 RESTRICTION is a list of object types which are allowed in the
3854 current object."
3860 end restriction candidates)))
3867 ;; 1. Text before any object. Untabify it.
3872 acc
3876 ;; 2. Object...
3879 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3880 ;; a recursive type.
3885 cont-beg
3892 ;; 3. Text after last object. Untabify it.
3896 acc
3900 ;; Result.
3901 acc)))
3904 "Return an alist of candidates for the next object.
3906 LIMIT bounds the search, and RESTRICTION narrows candidates to
3907 some object types.
3909 Return value is an alist whose CAR is position and CDR the object
3910 type, as a symbol.
3912 OBJECTS is the previous candidates alist."
3914 ;; If no previous result, search every object type in RESTRICTION.
3915 ;; Otherwise, keep potential candidates (old objects located after
3916 ;; point) and ask to search again those which had matched before.
3921 objects))
3922 ;; Call the appropriate successor function for each type to search
3923 ;; and accumulate matches.
3930 type))))
3933 types-to-search)
3934 ;; Return alist.
3935 next-candidates))
3938 \f
3939 ;;; Towards A Bijective Process
3940 ;;
3941 ;; The parse tree obtained with `org-element-parse-buffer' is really
3942 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3943 ;; interpreted and expanded into a string with canonical Org syntax.
3944 ;; Hence `org-element-interpret-data'.
3945 ;;
3946 ;; The function relies internally on
3947 ;; `org-element--interpret-affiliated-keywords'.
3949 ;;;###autoload
3951 "Interpret DATA as Org syntax.
3953 DATA is a parse tree, an element, an object or a secondary string
3954 to interpret.
3956 Optional argument PARENT is used for recursive calls. It contains
3957 the element or object containing data, or nil.
3959 Return Org syntax as a string."
3963 ;; Secondary string.
3968 ;; Full Org document.
3973 ;; Plain text.
3975 ;; Element/Object without contents.
3978 data nil))
3979 ;; Element/Object with contents.
3989 ;; Elements directly containing objects must
3990 ;; have their indentation normalized first.
3992 data
3993 ;; When normalizing first paragraph of an
3994 ;; item or a footnote-definition, ignore
3995 ;; first line's indentation.
4002 data
4004 contents)))))))
4006 ;; Build white spaces. If no `:post-blank' property is
4007 ;; specified, assume its value is 0.
4017 "Return ELEMENT's affiliated keywords as Org syntax.
4018 If there is no affiliated keyword, return the empty string."
4028 ": "
4031 value)
4039 ;; All attribute keywords can have multiple lines.
4045 ;; List all ELEMENT's properties matching an attribute line or an
4046 ;; affiliated keyword, but ignore translated keywords since they
4047 ;; cannot belong to the property list.
4054 org-element-keyword-translation-alist)))))
4055 collect prop)
4058 ;; Because interpretation of the parse tree must return the same
4059 ;; number of blank lines between elements and the same number of white
4060 ;; space after objects, some special care must be given to white
4061 ;; spaces.
4062 ;;
4063 ;; The first function, `org-element-normalize-string', ensures any
4064 ;; string different from the empty string will end with a single
4065 ;; newline character.
4066 ;;
4067 ;; The second function, `org-element-normalize-contents', removes
4068 ;; global indentation from the contents of the current element.
4071 "Ensure string S ends with a single newline character.
4073 If S isn't a string return it unchanged. If S is the empty
4074 string, return it. Otherwise, return a new string with a single
4075 newline character at its end."
4083 "Normalize plain text in ELEMENT's contents.
4085 ELEMENT must only contain plain text and objects.
4087 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4088 indentation to compute maximal common indentation.
4090 Return the normalized element that is element with global
4091 indentation removed from its contents. The function assumes that
4092 indentation is not done with TAB characters."
4094 collect-inds ; for byte-compiler
4097 ;; Return list of indentations within BLOB. This is done by
4098 ;; walking recursively BLOB and updating IND-LIST along the
4099 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4100 ;; been seen yet. It is required as this string is the only
4101 ;; one whose indentation doesn't happen after a newline
4102 ;; character.
4110 ;; An indentation of zero means no string will be
4111 ;; modified. Quit the process.
4117 ;; Avoid matching blank or empty lines.
4125 ;; Collect indentation list in ELEMENT. Possibly remove first
4126 ;; value if IGNORE-FIRST is non-nil.
4129 ;; Build ELEMENT back, replacing each string with the same
4130 ;; string minus common indentation.
4135 ;; Return BLOB with all its strings indentation
4136 ;; shortened from MCI white spaces. FIRST-FLAG is
4137 ;; non-nil when the first string hasn't been seen
4138 ;; yet.
4152 org-element-recursive-objects)
4156 blob))))
4160 \f
4161 ;;; The Toolbox
4162 ;;
4163 ;; The first move is to implement a way to obtain the smallest element
4164 ;; containing point. This is the job of `org-element-at-point'. It
4165 ;; basically jumps back to the beginning of section containing point
4166 ;; and moves, element after element, with
4167 ;; `org-element--current-element' until the container is found. Note:
4168 ;; When using `org-element-at-point', secondary values are never
4169 ;; parsed since the function focuses on elements, not on objects.
4170 ;;
4171 ;; At a deeper level, `org-element-context' lists all elements and
4172 ;; objects containing point.
4173 ;;
4174 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4175 ;; internally by navigation and manipulation tools.
4177 ;;;###autoload
4179 "Determine closest element around point.
4181 Return value is a list like (TYPE PROPS) where TYPE is the type
4182 of the element and PROPS a plist of properties associated to the
4183 element.
4185 Possible types are defined in `org-element-all-elements'.
4186 Properties depend on element or object type, but always
4187 include :begin, :end, :parent and :post-blank properties.
4189 As a special case, if point is at the very beginning of a list or
4190 sub-list, returned element will be that list instead of the first
4191 item. In the same way, if point is at the beginning of the first
4192 row of a table, returned element will be the table instead of the
4193 first row.
4195 If optional argument KEEP-TRAIL is non-nil, the function returns
4196 a list of of elements leading to element at point. The list's
4197 CAR is always the element at point. Following positions contain
4198 element's siblings, then parents, siblings of parents, until the
4199 first element of current section."
4201 ;; If at an headline, parse it. It is the sole element that
4202 ;; doesn't require to know about context. Be sure to disallow
4203 ;; secondary string parsing, though.
4209 ;; Otherwise move at the beginning of the section containing
4210 ;; point.
4214 element type special-flag trail struct prevs parent)
4222 ;; Parse successively each element, skipping those ending
4223 ;; before original position.
4232 ;; 1. Skip any element ending before point. Also skip
4233 ;; element ending at point when we're sure that another
4234 ;; element has started.
4239 ;; 2. An element containing point is always the element at
4240 ;; point.
4243 ;; 3. At any other greater element type, if point is
4244 ;; within contents, move into it.
4249 ;; Create an anchor for tables and plain lists:
4250 ;; when point is at the very beginning of these
4251 ;; elements, ignoring affiliated keywords,
4252 ;; target them instead of their contents.
4254 ;; When point is at contents end, do not move
4255 ;; into elements with an explicit ending, but
4256 ;; return that element instead.
4260 drawer dynamic-block inlinetask item
4261 plain-list property-drawer quote-block
4262 special-block))))
4275 ;;;###autoload
4277 "Return closest element or object around point.
4279 Return value is a list like (TYPE PROPS) where TYPE is the type
4280 of the element or object and PROPS a plist of properties
4281 associated to it.
4283 Possible types are defined in `org-element-all-elements' and
4284 `org-element-all-objects'. Properties depend on element or
4285 object type, but always include :begin, :end, :parent
4286 and :post-blank properties."
4291 end)
4292 ;; Check if point is inside an element containing objects or at
4293 ;; a secondary string. In that case, move to beginning of the
4294 ;; element or secondary string and set END to the other side.
4303 (<= origin
4304 ;; `1+' is required so some
4305 ;; successors can match
4306 ;; properly their object.
4320 element
4323 candidates)
4326 end restriction candidates))
4328 candidates)))
4329 ;; If ORIGIN is before next object in element, there's
4330 ;; no point in looking further.
4339 ;; ORIGIN is after OBJECT, so skip it.
4342 ;; ORIGIN is within a non-recursive object or at an
4343 ;; object boundaries: Return that object.
4347 ;; Otherwise, move within current object and restrict
4348 ;; search to the end of its contents.
4352 parent))))))
4355 "Non-nil when elements ELEM-A and ELEM-B are nested."
4364 "Swap elements ELEM-A and ELEM-B.
4365 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4366 end of ELEM-A."
4368 ;; There are two special cases when an element doesn't start at bol:
4369 ;; the first paragraph in an item or in a footnote definition.
4371 ;; Only a paragraph without any affiliated keyword can be moved at
4372 ;; ELEM-A position in such a situation. Note that the case of
4373 ;; a footnote definition is impossible: it cannot contain two
4374 ;; paragraphs in a row because it cannot contain a blank line.
4380 ;; In a special situation, ELEM-A will have no indentation. We'll
4381 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4395 ;; Store overlays responsible for visibility status. We
4396 ;; also need to store their boundaries as they will be
4397 ;; removed from buffer.
4404 ;; Get contents.
4412 ;; Restore ex ELEM-A overlays.
4421 ;; Restore ex ELEM-B overlays.
4430 ;;; org-element.el ends here