| blob | fc835e51546acbcd57b5c9e9be538c21b122928c |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 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', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'. A simple cache mechanism is also
115 ;; provided for these functions.
118 ;;; Code:
125 \f
126 ;;; Definitions And Rules
127 ;;
128 ;; Define elements, greater elements and specify recursive objects,
129 ;; along with the affiliated keywords recognized. Also set up
130 ;; restrictions on recursive objects combinations.
131 ;;
132 ;; These variables really act as a control center for the parsing
133 ;; process.
137 ;; Headlines, inlinetasks.
139 ;; Footnote definitions.
141 ;; Diary sexps.
144 ;; Empty lines.
146 ;; Tables (any type).
148 ;; Blocks (any type), Babel calls and keywords. Note: this
149 ;; is only an indication and need some thorough check.
151 ;; Drawers (any type) and fixed-width areas. This is also
152 ;; only an indication.
154 ;; Horizontal rules.
156 ;; LaTeX environments.
158 ;; Planning and Clock lines.
160 org-deadline-string
161 org-closed-string
162 org-clock-string))
164 ;; Lists.
171 "Regexp to separate paragraphs in an Org buffer.
173 is not sufficient to know if point is at a paragraph ending. See
178 dynamic-block example-block export-block fixed-width
179 footnote-definition headline horizontal-rule inlinetask item
180 keyword latex-environment node-property paragraph plain-list
181 planning property-drawer quote-block quote-section section
182 special-block src-block table table-row verse-block)
187 item plain-list property-drawer quote-block section
188 special-block table)
193 latex-or-entity line-break link macro plain-link radio-target
194 statistics-cookie sub/superscript table-cell target
195 text-markup timestamp)
204 "Alist of translations between object type and successor name.
205 Sharing the same successor comes handy when, for example, the
210 inline-src-block italic line-break latex-fragment link macro
211 radio-target statistics-cookie strike-through subscript superscript
212 table-cell target timestamp underline verbatim)
217 table-cell underline)
227 "Alist between block names and the associated parsing function.
228 Names must be uppercase. Any block whose name has no association
234 Only these types can accept search options and an explicit
240 "List of affiliated keywords as strings.
248 "Alist of usual translations for keywords.
249 The key is the old name and the value the new one. The property
253 "List of affiliated keywords that can occur more than once in an element.
255 Their value will be consed into a list of strings, which will be
256 returned as the value of the property.
258 This list is checked after translations have been applied. See
259 `org-element-keyword-translation-alist'.
265 "List of affiliated keywords whose value can be parsed.
267 Their value will be stored as a secondary string: a list of
268 strings and objects.
270 This list is checked after translations have been applied. See
274 "List of affiliated keywords which can have a secondary value.
276 In Org syntax, they can be written with optional square brackets
277 before the colons. For example, RESULTS keyword can be
278 associated to a hash value with the following:
280 #+RESULTS[hash-string]: some-source
282 This list is checked after translations have been applied. See
286 "List of properties associated to the whole document.
287 Any keyword in this list will have its value parsed and stored as
293 ;; Dual affiliated keywords.
297 ;; Regular affiliated keywords.
303 org-element-affiliated-keywords)))
305 ;; Export attributes.
307 "Regexp matching any affiliated keyword.
309 Keyword name is put in match group 1. Moreover, if keyword
310 belongs to `org-element-dual-keywords', put the dual value in
311 match group 2.
326 ;; Ignore all links excepted plain links in a link description.
327 ;; Also ignore radio-targets and line breaks.
331 ;; Remove any variable object from radio target as it would
332 ;; prevent it from being properly recognized.
337 ;; Ignore inline babel call and inline src block as formulas are
338 ;; possible. Also ignore line breaks and statistics cookies.
344 "Alist of objects restrictions.
346 CAR is an element or object type containing objects and CDR is
347 a list of successors that will be called within an element or
348 object of such type.
350 For example, in a `radio-target' object, one can only find
351 entities, latex-fragments, subscript and superscript.
353 This alist also applies to secondary string. For example, an
354 `headline' type element doesn't directly contain objects, but
365 "List of buffer-local variables used when parsing objects.
366 These variables are copied to the temporary buffer created by
370 \f
371 ;;; Accessors and Setters
372 ;;
373 ;; Provide four accessors: `org-element-type', `org-element-property'
374 ;; `org-element-contents' and `org-element-restriction'.
375 ;;
376 ;; Setter functions allow to modify elements by side effect. There is
377 ;; `org-element-put-property', `org-element-set-contents'. These
378 ;; low-level functions are useful to build a parse tree.
379 ;;
380 ;; `org-element-adopt-element', `org-element-set-element',
381 ;; `org-element-extract-element' and `org-element-insert-before' are
382 ;; high-level functions useful to modify a parse tree.
383 ;;
384 ;; `org-element-secondary-p' is a predicate used to know if a given
385 ;; object belongs to a secondary string.
388 "Return type of ELEMENT.
390 The function returns the type of the element or object provided.
391 It can also return the following special value:
392 `plain-text' for a string
393 `org-data' for a complete document
394 nil in any other case."
400 "Extract the value from the PROPERTY of an ELEMENT."
405 "Extract contents from an ELEMENT."
411 "Return restriction associated to ELEMENT.
412 ELEMENT can be an element, an object or a symbol representing an
413 element or object type."
415 org-element-object-restrictions)))
418 "In ELEMENT set PROPERTY to VALUE.
419 Return modified element."
422 element))
425 "Set ELEMENT contents to CONTENTS.
426 Return modified element."
433 "Non-nil when OBJECT belongs to a secondary string.
434 Return value is the property name, as a keyword, or nil."
437 org-element-secondary-value-alist))))
440 property)))
443 "Append elements to the contents of another element.
445 PARENT is an element or object. CHILDREN can be elements,
446 objects, or a strings.
448 The function takes care of setting `:parent' property for CHILD.
449 Return parent element."
450 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
451 ;; string: parent is the list itself.
454 children)
455 ;; Add CHILDREN at the end of PARENT contents.
458 parent
460 ;; Return modified PARENT element.
464 "Extract ELEMENT from parse tree.
465 Remove element from the parse tree by side-effect, and return it
466 with its `:parent' property stripped out."
471 parent secondary
474 parent
476 ;; Return ELEMENT with its :parent removed.
480 "Insert ELEMENT before LOCATION in parse tree.
481 LOCATION is an element, object or string within the parse tree.
482 Parse tree is modified by side effect."
487 ;; Special case: LOCATION is the first element of an
488 ;; independent secondary string (e.g. :title property). Add
489 ;; ELEMENT in-place.
493 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
503 ;; Store SIBLINGS at appropriate place in parse tree.
508 ;; Set appropriate :parent property.
512 "Replace element or object OLD with element or object NEW.
513 The function takes care of setting `:parent' property for NEW."
514 ;; Ensure OLD and NEW have the same parent.
518 ;; We cannot replace OLD with NEW since one of them is not an
519 ;; object or element. We take the long path.
522 ;; Since OLD is going to be changed into NEW by side-effect, first
523 ;; make sure that every element or object within NEW has OLD as
524 ;; parent.
527 ;; Transfer contents.
529 ;; Overwrite OLD's properties with NEW's.
531 ;; Transfer type.
535 \f
536 ;;; Greater elements
537 ;;
538 ;; For each greater element type, we define a parser and an
539 ;; interpreter.
540 ;;
541 ;; A parser returns the element or object as the list described above.
542 ;; Most of them accepts no argument. Though, exceptions exist. Hence
543 ;; every element containing a secondary string (see
544 ;; `org-element-secondary-value-alist') will accept an optional
545 ;; argument to toggle parsing of that secondary string. Moreover,
546 ;; `item' parser requires current list's structure as its first
547 ;; element.
548 ;;
549 ;; An interpreter accepts two arguments: the list representation of
550 ;; the element or object, and its contents. The latter may be nil,
551 ;; depending on the element or object considered. It returns the
552 ;; appropriate Org syntax, as a string.
553 ;;
554 ;; Parsing functions must follow the naming convention:
555 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
556 ;; defined in `org-element-greater-elements'.
557 ;;
558 ;; Similarly, interpreting functions must follow the naming
559 ;; convention: org-element-TYPE-interpreter.
560 ;;
561 ;; With the exception of `headline' and `item' types, greater elements
562 ;; cannot contain other greater elements of their own type.
563 ;;
564 ;; Beside implementing a parser and an interpreter, adding a new
565 ;; greater element requires to tweak `org-element--current-element'.
566 ;; Moreover, the newly defined type must be added to both
567 ;; `org-element-all-elements' and `org-element-greater-elements'.
570 ;;;; Center Block
573 "Parse a center block.
575 LIMIT bounds the search. AFFILIATED is a list of which CAR is
576 the buffer position at the beginning of the first affiliated
577 keyword and CDR is a plist of affiliated keywords along with
578 their value.
580 Return a list whose CAR is `center-block' and CDR is a plist
581 containing `:begin', `:end', `:contents-begin', `:contents-end',
582 `:post-blank' and `:post-affiliated' keywords.
584 Assume point is at the beginning of the block."
588 ;; Incomplete block: parse it as a paragraph.
593 ;; Empty blocks have no contents.
607 :end end
608 :contents-begin contents-begin
609 :contents-end contents-end
615 "Interpret CENTER-BLOCK element as Org syntax.
616 CONTENTS is the contents of the element."
620 ;;;; Drawer
623 "Parse a drawer.
625 LIMIT bounds the search. AFFILIATED is a list of which CAR is
626 the buffer position at the beginning of the first affiliated
627 keyword and CDR is a plist of affiliated keywords along with
628 their value.
630 Return a list whose CAR is `drawer' and CDR is a plist containing
631 `:drawer-name', `:begin', `:end', `:contents-begin',
632 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
634 Assume point is at beginning of drawer."
637 ;; Incomplete drawer: parse it as a paragraph.
645 ;; Empty drawers have no contents.
658 :end end
659 :drawer-name name
660 :contents-begin contents-begin
661 :contents-end contents-end
667 "Interpret DRAWER element as Org syntax.
668 CONTENTS is the contents of the element."
671 contents))
674 ;;;; Dynamic Block
677 "Parse a dynamic block.
679 LIMIT bounds the search. AFFILIATED is a list of which CAR is
680 the buffer position at the beginning of the first affiliated
681 keyword and CDR is a plist of affiliated keywords along with
682 their value.
684 Return a list whose CAR is `dynamic-block' and CDR is a plist
685 containing `:block-name', `:begin', `:end', `:contents-begin',
686 `:contents-end', `:arguments', `:post-blank' and
687 `:post-affiliated' keywords.
689 Assume point is at beginning of dynamic block."
693 ;; Incomplete block: parse it as a paragraph.
702 ;; Empty blocks have no contents.
715 :end end
716 :block-name name
717 :arguments arguments
718 :contents-begin contents-begin
719 :contents-end contents-end
725 "Interpret DYNAMIC-BLOCK element as Org syntax.
726 CONTENTS is the contents of the element."
731 contents))
734 ;;;; Footnote Definition
737 "Parse a footnote definition.
739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
740 the buffer position at the beginning of the first affiliated
741 keyword and CDR is a plist of affiliated keywords along with
742 their value.
744 Return a list whose CAR is `footnote-definition' and CDR is
745 a plist containing `:label', `:begin' `:end', `:contents-begin',
746 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
748 Assume point is at the beginning of the footnote definition."
776 :begin begin
777 :end end
778 :contents-begin contents-begin
779 :contents-end contents-end
785 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
786 CONTENTS is the contents of the footnote-definition."
788 " "
789 contents))
792 ;;;; Headline
795 "Parse a headline.
797 Return a list whose CAR is `headline' and CDR is a plist
798 containing `:raw-value', `:title', `:alt-title', `:begin',
799 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
800 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
801 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
802 `:commentedp' and `:footnote-section-p' keywords.
804 The plist also contains any property set in the property drawer,
805 with its name in upper cases and colons added at the
806 beginning (i.e. `:CUSTOM_ID').
808 When RAW-SECONDARY-P is non-nil, headline's title will not be
809 parsed as a secondary string, but as a plain string instead.
811 Assume point is at beginning of the headline."
824 raw-value)))
828 raw-value)))
832 ;; Upcase property names. It avoids confusion between
833 ;; properties obtained through property drawer and default
834 ;; properties from the parser (e.g. `:end' and :END:)
844 plist))
846 ;; Read time properties on the line below the headline.
852 org-keyword-time-not-clock-regexp end t)
862 plist))))
874 ;; Clean RAW-VALUE from any quote or comment string.
882 ""
883 raw-value))))
884 ;; Clean TAGS from archive tag, if any.
890 :begin begin
891 :end end
892 :pre-blank
895 :contents-begin contents-begin
896 :contents-end contents-end
897 :level level
899 :tags tags
900 :todo-keyword todo
901 :todo-type todo-type
907 end)
908 :footnote-section-p footnote-section-p
909 :archivedp archivedp
910 :commentedp commentedp
912 time-props
913 standard-props))))
917 headline :alt-title
922 headline :title
928 "Interpret HEADLINE element as Org syntax.
929 CONTENTS is the contents of the element."
956 ;; Align tags.
964 ? )
965 tags))
969 tags))))
971 contents)))
974 ;;;; Inlinetask
977 "Parse an inline task.
979 Return a list whose CAR is `inlinetask' and CDR is a plist
980 containing `:title', `:begin', `:end', `:contents-begin' and
981 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
982 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
983 `:closed' and `:post-blank' keywords.
985 The plist also contains any property set in the property drawer,
986 with its name in upper cases and colons added at the
987 beginning (i.e. `:CUSTOM_ID').
989 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
990 title will not be parsed as a secondary string, but as a plain
991 string instead.
993 Assume point is at beginning of the inline task."
1003 ;; Upcase property names. It avoids confusion between
1004 ;; properties obtained through property drawer and default
1005 ;; properties from the parser (e.g. `:end' and :END:)
1015 plist))
1017 ;; Read time properties on the line below the inlinetask
1018 ;; opening string.
1024 org-keyword-time-not-clock-regexp end t)
1034 plist))))
1052 :begin begin
1053 :end end
1054 :contents-begin contents-begin
1055 :contents-end contents-end
1058 :tags tags
1059 :todo-keyword todo
1060 :todo-type todo-type
1062 time-props
1063 standard-props))))
1065 inlinetask :title
1068 raw-value
1070 inlinetask))))))
1073 "Interpret INLINETASK element as Org syntax.
1074 CONTENTS is the contents of inlinetask."
1089 ;; Align tags.
1097 ? )
1098 tags))
1102 tags))))
1103 ;; Prefer degenerate inlinetasks when there are no
1104 ;; contents.
1107 contents
1111 ;;;; Item
1114 "Parse an item.
1116 STRUCT is the structure of the plain list.
1118 Return a list whose CAR is `item' and CDR is a plist containing
1119 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1120 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1121 keywords.
1123 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1124 any, will not be parsed as a secondary string, but as a plain
1125 string instead.
1127 Assume point is at the beginning of the item."
1151 ;; Ignore tags in un-ordered lists: they are just
1152 ;; a part of item's body.
1158 ;; If first line isn't empty, contents really start
1159 ;; at the text after item's meta-data.
1168 :begin begin
1169 :end end
1170 ;; CONTENTS-BEGIN and CONTENTS-END may be
1171 ;; mixed up in the case of an empty item
1172 ;; separated from the next by a blank line.
1173 ;; Thus ensure the former is always the
1174 ;; smallest.
1177 :checkbox checkbox
1178 :counter counter
1179 :structure struct
1182 item :tag
1190 "Interpret ITEM element as Org syntax.
1191 CONTENTS is the contents of the element."
1201 ;; Compute indentation.
1206 ;; Indent contents.
1208 bullet
1222 ;;;; Plain List
1225 ;; Return structure of list at point. Internal function. See
1226 ;; `org-list-struct' for details.
1231 items struct)
1236 ;; At limit: end all items.
1245 ;; At list end: end all items.
1250 ;; At a new item: end previous sibling.
1262 ind
1263 bullet
1266 ;; Description tag.
1270 ;; Ending position, unknown so far.
1271 nil)))
1272 items))
1274 ;; Skip empty lines.
1276 ;; Skip inline tasks and blank lines along the way.
1283 ;; At some text line. Check if it ends any previous item.
1295 ;; Skip blocks (any type) and drawers contents.
1301 limit t)))
1307 "Parse a plain list.
1309 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1310 the buffer position at the beginning of the first affiliated
1311 keyword and CDR is a plist of affiliated keywords along with
1312 their value. STRUCTURE is the structure of the plain list being
1313 parsed.
1315 Return a list whose CAR is `plain-list' and CDR is a plist
1316 containing `:type', `:begin', `:end', `:contents-begin' and
1317 `:contents-end', `:structure', `:post-blank' and
1318 `:post-affiliated' keywords.
1320 Assume point is at the beginning of the list."
1334 pos))
1338 ;; Return value.
1342 :begin begin
1343 :end end
1344 :contents-begin contents-begin
1345 :contents-end contents-end
1346 :structure struct
1352 "Interpret PLAIN-LIST element as Org syntax.
1353 CONTENTS is the contents of the element."
1361 ;;;; Property Drawer
1364 "Parse a property drawer.
1366 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1367 the buffer position at the beginning of the first affiliated
1368 keyword and CDR is a plist of affiliated keywords along with
1369 their value.
1371 Return a list whose CAR is `property-drawer' and CDR is a plist
1372 containing `:begin', `:end', `:contents-begin', `:contents-end',
1373 `:post-blank' and `:post-affiliated' keywords.
1375 Assume point is at the beginning of the property drawer."
1380 ;; Incomplete drawer: parse it as a paragraph.
1398 :end end
1399 :contents-begin contents-begin
1400 :contents-end contents-end
1406 "Interpret PROPERTY-DRAWER element as Org syntax.
1407 CONTENTS is the properties within the drawer."
1411 ;;;; Quote Block
1414 "Parse a quote block.
1416 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1417 the buffer position at the beginning of the first affiliated
1418 keyword and CDR is a plist of affiliated keywords along with
1419 their value.
1421 Return a list whose CAR is `quote-block' and CDR is a plist
1422 containing `:begin', `:end', `:contents-begin', `:contents-end',
1423 `:post-blank' and `:post-affiliated' keywords.
1425 Assume point is at the beginning of the block."
1429 ;; Incomplete block: parse it as a paragraph.
1435 ;; Empty blocks have no contents.
1448 :end end
1449 :contents-begin contents-begin
1450 :contents-end contents-end
1456 "Interpret QUOTE-BLOCK element as Org syntax.
1457 CONTENTS is the contents of the element."
1461 ;;;; Section
1464 "Parse a section.
1466 LIMIT bounds the search.
1468 Return a list whose CAR is `section' and CDR is a plist
1469 containing `:begin', `:end', `:contents-begin', `contents-end'
1470 and `:post-blank' keywords."
1472 ;; Beginning of section is the beginning of the first non-blank
1473 ;; line after previous headline.
1482 :end end
1483 :contents-begin begin
1484 :contents-end pos-before-blank
1488 "Interpret SECTION element as Org syntax.
1489 CONTENTS is the contents of the element."
1490 contents)
1493 ;;;; Special Block
1496 "Parse a special 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 `special-block' and CDR is a plist
1504 containing `:type', `:begin', `:end', `:contents-begin',
1505 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1507 Assume point is at the beginning of the block."
1514 limit t)))
1515 ;; Incomplete block: parse it as a paragraph.
1521 ;; Empty blocks have no contents.
1534 :begin begin
1535 :end end
1536 :contents-begin contents-begin
1537 :contents-end contents-end
1543 "Interpret SPECIAL-BLOCK element as Org syntax.
1544 CONTENTS is the contents of the element."
1549 \f
1550 ;;; Elements
1551 ;;
1552 ;; For each element, a parser and an interpreter are also defined.
1553 ;; Both follow the same naming convention used for greater elements.
1554 ;;
1555 ;; Also, as for greater elements, adding a new element type is done
1556 ;; through the following steps: implement a parser and an interpreter,
1557 ;; tweak `org-element--current-element' so that it recognizes the new
1558 ;; type and add that new type to `org-element-all-elements'.
1559 ;;
1560 ;; As a special case, when the newly defined type is a block type,
1561 ;; `org-element-block-name-alist' has to be modified accordingly.
1564 ;;;; Babel Call
1567 "Parse a babel call.
1569 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1570 the buffer position at the beginning of the first affiliated
1571 keyword and CDR is a plist of affiliated keywords along with
1572 their value.
1574 Return a list whose CAR is `babel-call' and CDR is a plist
1575 containing `:begin', `:end', `:value', `:post-blank' and
1576 `:post-affiliated' as keywords."
1590 :end end
1591 :value value
1597 "Interpret BABEL-CALL element as Org syntax.
1598 CONTENTS is nil."
1602 ;;;; Clock
1605 "Parse a clock.
1607 LIMIT bounds the search.
1609 Return a list whose CAR is `clock' and CDR is a plist containing
1610 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1611 as keywords."
1631 :value value
1632 :duration duration
1633 :begin begin
1634 :end end
1638 "Interpret CLOCK element as Org syntax.
1639 CONTENTS is nil."
1647 "%2s:%02s"
1651 ;;;; Comment
1654 "Parse a comment.
1656 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1657 the buffer position at the beginning of the first affiliated
1658 keyword and CDR is a plist of affiliated keywords along with
1659 their value.
1661 Return a list whose CAR is `comment' and CDR is a plist
1662 containing `:begin', `:end', `:value', `:post-blank',
1663 `:post-affiliated' keywords.
1665 Assume point is at comment beginning."
1674 ;; Get comments ending.
1677 ;; Accumulate lines without leading hash and first
1678 ;; whitespace.
1692 :end end
1693 :value value
1699 "Interpret COMMENT element as Org syntax.
1700 CONTENTS is nil."
1704 ;;;; Comment Block
1707 "Parse an export block.
1709 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1710 the buffer position at the beginning of the first affiliated
1711 keyword and CDR is a plist of affiliated keywords along with
1712 their value.
1714 Return a list whose CAR is `comment-block' and CDR is a plist
1715 containing `:begin', `:end', `:value', `:post-blank' and
1716 `:post-affiliated' keywords.
1718 Assume point is at comment block beginning."
1722 ;; Incomplete block: parse it as a paragraph.
1735 contents-begin contents-end)))
1739 :end end
1740 :value value
1746 "Interpret COMMENT-BLOCK element as Org syntax.
1747 CONTENTS is nil."
1752 ;;;; Diary Sexp
1755 "Parse a diary sexp.
1757 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1758 the buffer position at the beginning of the first affiliated
1759 keyword and CDR is a plist of affiliated keywords along with
1760 their value.
1762 Return a list whose CAR is `diary-sexp' and CDR is a plist
1763 containing `:begin', `:end', `:value', `:post-blank' and
1764 `:post-affiliated' keywords."
1776 :begin begin
1777 :end end
1783 "Interpret DIARY-SEXP as Org syntax.
1784 CONTENTS is nil."
1788 ;;;; Example Block
1791 "Parse an example block.
1793 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1794 the buffer position at the beginning of the first affiliated
1795 keyword and CDR is a plist of affiliated keywords along with
1796 their value.
1798 Return a list whose CAR is `example-block' and CDR is a plist
1799 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1800 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1801 `:value', `:post-blank' and `:post-affiliated' keywords."
1805 ;; Incomplete block: parse it as a paragraph.
1813 ;; Switches analysis
1820 ;; Should labels be retained in (or stripped from) example
1821 ;; blocks?
1826 ;; What should code-references use - labels or
1827 ;; line-numbers?
1836 ;; Standard block parsing.
1844 contents-begin contents-end))
1845 block-ind))
1854 :end end
1855 :value value
1856 :switches switches
1857 :number-lines number-lines
1858 :preserve-indent preserve-indent
1859 :retain-labels retain-labels
1860 :use-labels use-labels
1861 :label-fmt label-fmt
1867 "Interpret EXAMPLE-BLOCK element as Org syntax.
1868 CONTENTS is nil."
1875 value
1880 ;;;; Export Block
1883 "Parse an export block.
1885 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1886 the buffer position at the beginning of the first affiliated
1887 keyword and CDR is a plist of affiliated keywords along with
1888 their value.
1890 Return a list whose CAR is `export-block' and CDR is a plist
1891 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1892 `:post-affiliated' keywords.
1894 Assume point is at export-block beginning."
1901 ;; Incomplete block: parse it as a paragraph.
1914 contents-end)))
1918 :end end
1919 :type type
1920 :value value
1926 "Interpret EXPORT-BLOCK element as Org syntax.
1927 CONTENTS is nil."
1934 ;;;; Fixed-width
1937 "Parse a fixed-width section.
1939 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1940 the buffer position at the beginning of the first affiliated
1941 keyword and CDR is a plist of affiliated keywords along with
1942 their value.
1944 Return a list whose CAR is `fixed-width' and CDR is a plist
1945 containing `:begin', `:end', `:value', `:post-blank' and
1946 `:post-affiliated' keywords.
1948 Assume point is at the beginning of the fixed-width area."
1952 value
1957 ;; Accumulate text without starting colons.
1970 :end end
1971 :value value
1977 "Interpret FIXED-WIDTH element as Org syntax.
1978 CONTENTS is nil."
1986 ;;;; Horizontal Rule
1989 "Parse an horizontal rule.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1997 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1998 keywords."
2008 :end end
2014 "Interpret HORIZONTAL-RULE element as Org syntax.
2015 CONTENTS is nil."
2019 ;;;; Keyword
2022 "Parse a keyword at point.
2024 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2025 the buffer position at the beginning of the first affiliated
2026 keyword and CDR is a plist of affiliated keywords along with
2027 their value.
2029 Return a list whose CAR is `keyword' and CDR is a plist
2030 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2031 `:post-affiliated' keywords."
2033 ;; An orphaned affiliated keyword is considered as a regular
2034 ;; keyword. In this case AFFILIATED is nil, so we take care of
2035 ;; this corner case.
2048 :value value
2049 :begin begin
2050 :end end
2056 "Interpret KEYWORD element as Org syntax.
2057 CONTENTS is nil."
2063 ;;;; Latex Environment
2066 "Parse a LaTeX environment.
2068 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2069 the buffer position at the beginning of the first affiliated
2070 keyword and CDR is a plist of affiliated keywords along with
2071 their value.
2073 Return a list whose CAR is `latex-environment' and CDR is a plist
2074 containing `:begin', `:end', `:value', `:post-blank' and
2075 `:post-affiliated' keywords.
2077 Assume point is at the beginning of the latex environment."
2084 limit t))
2085 ;; Incomplete latex environment: parse it as a paragraph.
2095 :end end
2096 :value value
2102 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2103 CONTENTS is nil."
2107 ;;;; Node Property
2110 "Parse a node-property at point.
2112 LIMIT bounds the search.
2114 Return a list whose CAR is `node-property' and CDR is a plist
2115 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2116 keywords."
2128 :value value
2129 :begin begin
2130 :end end
2134 "Interpret NODE-PROPERTY element as Org syntax.
2135 CONTENTS is nil."
2141 ;;;; Paragraph
2144 "Parse a paragraph.
2146 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2147 the buffer position at the beginning of the first affiliated
2148 keyword and CDR is a plist of affiliated keywords along with
2149 their value.
2151 Return a list whose CAR is `paragraph' and CDR is a plist
2152 containing `:begin', `:end', `:contents-begin' and
2153 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2155 Assume point is at the beginning of the paragraph."
2164 limit
2165 ;; A matching `org-element-paragraph-separate' is not
2166 ;; necessarily the end of the paragraph. In
2167 ;; particular, lines starting with # or : as a first
2168 ;; non-space character are ambiguous. We have check
2169 ;; if they are valid Org syntax (i.e. not an
2170 ;; incomplete keyword).
2174 ;; There's no ambiguity for other symbols or
2175 ;; empty lines: stop here.
2177 ;; Stop at valid fixed-width areas.
2179 ;; Stop at drawers.
2184 ;; Stop at valid comments.
2186 ;; Stop at valid dynamic blocks.
2191 ;; Stop at valid blocks.
2198 limit t)))
2199 ;; Stop at valid latex environments.
2207 limit t)))
2208 ;; Stop at valid keywords.
2210 ;; Skip everything else.
2227 :end end
2228 :contents-begin contents-begin
2229 :contents-end contents-end
2235 "Interpret PARAGRAPH element as Org syntax.
2236 CONTENTS is the contents of the element."
2237 contents)
2240 ;;;; Planning
2243 "Parse a planning.
2245 LIMIT bounds the search.
2247 Return a list whose CAR is `planning' and CDR is a plist
2248 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2249 and `:post-blank' keywords."
2259 closed deadline scheduled)
2271 :deadline deadline
2272 :scheduled scheduled
2273 :begin begin
2274 :end end
2278 "Interpret PLANNING element as Org syntax.
2279 CONTENTS is nil."
2281 'identity
2298 ;;;; Quote Section
2301 "Parse a quote section.
2303 LIMIT bounds the search.
2305 Return a list whose CAR is `quote-section' and CDR is a plist
2306 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2308 Assume point is at beginning of the section."
2319 :end end
2320 :value value
2324 "Interpret QUOTE-SECTION element as Org syntax.
2325 CONTENTS is nil."
2329 ;;;; Src Block
2332 "Parse a src block.
2334 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2335 the buffer position at the beginning of the first affiliated
2336 keyword and CDR is a plist of affiliated keywords along with
2337 their value.
2339 Return a list whose CAR is `src-block' and CDR is a plist
2340 containing `:language', `:switches', `:parameters', `:begin',
2341 `:end', `:number-lines', `:retain-labels', `:use-labels',
2342 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2343 `:post-affiliated' keywords.
2345 Assume point is at the beginning of the block."
2348 limit t)))
2349 ;; Incomplete block: parse it as a paragraph.
2355 ;; Get language as a string.
2364 ;; Get switches.
2366 ;; Get parameters.
2368 ;; Switches analysis
2379 ;; Should labels be retained in (or stripped from)
2380 ;; src blocks?
2385 ;; What should code-references use - labels or
2386 ;; line-numbers?
2391 ;; Indentation.
2393 ;; Retrieve code.
2398 block-ind))
2402 ;; Get position after ending blank lines.
2412 :begin begin
2413 :end end
2414 :number-lines number-lines
2415 :preserve-indent preserve-indent
2416 :retain-labels retain-labels
2417 :use-labels use-labels
2418 :label-fmt label-fmt
2419 :value value
2425 "Interpret SRC-BLOCK element as Org syntax.
2426 CONTENTS is nil."
2435 val)
2449 ;;;; Table
2452 "Parse a table at point.
2454 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2455 the buffer position at the beginning of the first affiliated
2456 keyword and CDR is a plist of affiliated keywords along with
2457 their value.
2459 Return a list whose CAR is `table' and CDR is a plist containing
2460 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2461 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2462 keywords.
2464 Assume point is at the beginning of the table."
2478 acc))
2485 :end end
2486 :type type
2487 :tblfm tblfm
2488 ;; Only `org' tables have contents. `table.el' tables
2489 ;; use a `:value' property to store raw table as
2490 ;; a string.
2495 table-begin table-end))
2501 "Interpret TABLE element as Org syntax.
2502 CONTENTS is nil."
2513 ;;;; Table Row
2516 "Parse table row at point.
2518 LIMIT bounds the search.
2520 Return a list whose CAR is `table-row' and CDR is a plist
2521 containing `:begin', `:end', `:contents-begin', `:contents-end',
2522 `:type' and `:post-blank' keywords."
2526 ;; A table rule has no contents. In that case, ensure
2527 ;; CONTENTS-BEGIN matches CONTENTS-END.
2539 :begin begin
2540 :end end
2541 :contents-begin contents-begin
2542 :contents-end contents-end
2546 "Interpret TABLE-ROW element as Org syntax.
2547 CONTENTS is the contents of the table row."
2552 ;;;; Verse Block
2555 "Parse a verse block.
2557 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2558 the buffer position at the beginning of the first affiliated
2559 keyword and CDR is a plist of affiliated keywords along with
2560 their value.
2562 Return a list whose CAR is `verse-block' and CDR is a plist
2563 containing `:begin', `:end', `:contents-begin', `:contents-end',
2564 `:post-blank' and `:post-affiliated' keywords.
2566 Assume point is at beginning of the block."
2570 ;; Incomplete block: parse it as a paragraph.
2585 :end end
2586 :contents-begin contents-begin
2587 :contents-end contents-end
2593 "Interpret VERSE-BLOCK element as Org syntax.
2594 CONTENTS is verse block contents."
2598 \f
2599 ;;; Objects
2600 ;;
2601 ;; Unlike to elements, interstices can be found between objects.
2602 ;; That's why, along with the parser, successor functions are provided
2603 ;; for each object. Some objects share the same successor (i.e. `code'
2604 ;; and `verbatim' objects).
2605 ;;
2606 ;; A successor must accept a single argument bounding the search. It
2607 ;; will return either a cons cell whose CAR is the object's type, as
2608 ;; a symbol, and CDR the position of its next occurrence, or nil.
2609 ;;
2610 ;; Successors follow the naming convention:
2611 ;; org-element-NAME-successor, where NAME is the name of the
2612 ;; successor, as defined in `org-element-all-successors'.
2613 ;;
2614 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2615 ;; object types they can contain will be specified in
2616 ;; `org-element-object-restrictions'.
2617 ;;
2618 ;; Adding a new type of object is simple. Implement a successor,
2619 ;; a parser, and an interpreter for it, all following the naming
2620 ;; convention. Register type in `org-element-all-objects' and
2621 ;; successor in `org-element-all-successors'. Maybe tweak
2622 ;; restrictions about it, and that's it.
2625 ;;;; Bold
2628 "Parse bold object at point.
2630 Return a list whose CAR is `bold' and CDR is a plist with
2631 `:begin', `:end', `:contents-begin' and `:contents-end' and
2632 `:post-blank' keywords.
2634 Assume point is at the first star marker."
2646 :end end
2647 :contents-begin contents-begin
2648 :contents-end contents-end
2652 "Interpret BOLD object as Org syntax.
2653 CONTENTS is the contents of the object."
2657 "Search for the next text-markup object.
2659 Return value is a cons cell whose CAR is a symbol among `bold',
2660 `italic', `underline', `strike-through', `code' and `verbatim'
2661 and CDR is beginning position."
2677 ;;;; Code
2680 "Parse code object at point.
2682 Return a list whose CAR is `code' and CDR is a plist with
2683 `:value', `:begin', `:end' and `:post-blank' keywords.
2685 Assume point is at the first tilde marker."
2696 :begin begin
2697 :end end
2701 "Interpret CODE object as Org syntax.
2702 CONTENTS is nil."
2706 ;;;; Entity
2709 "Parse entity at point.
2711 Return a list whose CAR is `entity' and CDR a plist with
2712 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2713 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2714 keywords.
2716 Assume point is at the beginning of the entity."
2718 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2734 :begin begin
2735 :end end
2736 :use-brackets-p bracketsp
2740 "Interpret ENTITY object as Org syntax.
2741 CONTENTS is nil."
2747 "Search for the next latex-fragment or entity object.
2749 Return value is a cons cell whose CAR is `entity' or
2750 `latex-fragment' and CDR is beginning position."
2754 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2761 ;; Determine if it's a real entity or a LaTeX command.
2764 ;; No entity nor command: point is at a LaTeX fragment.
2765 ;; Determine its type to get the correct beginning position.
2774 ;;;; Export Snippet
2777 "Parse export snippet at point.
2779 Return a list whose CAR is `export-snippet' and CDR a plist with
2780 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2781 keywords.
2783 Assume point is at the beginning of the snippet."
2795 :value value
2796 :begin begin
2797 :end end
2801 "Interpret EXPORT-SNIPPET object as Org syntax.
2802 CONTENTS is nil."
2808 "Search for the next export-snippet object.
2810 Return value is a cons cell whose CAR is `export-snippet' and CDR
2811 its beginning position."
2820 ;;;; Footnote Reference
2823 "Parse footnote reference at point.
2825 Return a list whose CAR is `footnote-reference' and CDR a plist
2826 with `:label', `:type', `:inline-definition', `:begin', `:end'
2827 and `:post-blank' as keywords."
2849 :type type
2850 :begin begin
2851 :end end
2854 footnote-reference :inline-definition
2859 footnote-reference))))))
2862 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2863 CONTENTS is nil."
2873 "Search for the next footnote-reference object.
2875 Return value is a cons cell whose CAR is `footnote-reference' and
2876 CDR is beginning position."
2890 ;;;; Inline Babel Call
2893 "Parse inline babel call at point.
2895 Return a list whose CAR is `inline-babel-call' and CDR a plist
2896 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2898 Assume point is at the beginning of the babel call."
2910 :end end
2911 :value value
2915 "Interpret INLINE-BABEL-CALL object as Org syntax.
2916 CONTENTS is nil."
2920 "Search for the next inline-babel-call object.
2922 Return value is a cons cell whose CAR is `inline-babel-call' and
2923 CDR is beginning position."
2929 ;;;; Inline Src Block
2932 "Parse inline source block at point.
2934 Return a list whose CAR is `inline-src-block' and CDR a plist
2935 with `:begin', `:end', `:language', `:value', `:parameters' and
2936 `:post-blank' as keywords.
2938 Assume point is at the beginning of the inline src block."
2951 :value value
2952 :parameters parameters
2953 :begin begin
2954 :end end
2958 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2959 CONTENTS is nil."
2964 language
2966 body)))
2969 "Search for the next inline-babel-call element.
2971 Return value is a cons cell whose CAR is `inline-babel-call' and
2972 CDR is beginning position."
2978 ;;;; Italic
2981 "Parse italic object at point.
2983 Return a list whose CAR is `italic' and CDR is a plist with
2984 `:begin', `:end', `:contents-begin' and `:contents-end' and
2985 `:post-blank' keywords.
2987 Assume point is at the first slash marker."
2999 :end end
3000 :contents-begin contents-begin
3001 :contents-end contents-end
3005 "Interpret ITALIC object as Org syntax.
3006 CONTENTS is the contents of the object."
3010 ;;;; Latex Fragment
3013 "Parse LaTeX fragment at point.
3015 Return a list whose CAR is `latex-fragment' and CDR a plist with
3016 `:value', `:begin', `:end', and `:post-blank' as keywords.
3018 Assume point is at the beginning of the LaTeX fragment."
3031 ;; None found: it's a macro.
3040 :begin begin
3041 :end end
3045 "Interpret LATEX-FRAGMENT object as Org syntax.
3046 CONTENTS is nil."
3049 ;;;; Line Break
3052 "Parse line break at point.
3054 Return a list whose CAR is `line-break', and CDR a plist with
3055 `:begin', `:end' and `:post-blank' keywords.
3057 Assume point is at the beginning of the line break."
3064 "Interpret LINE-BREAK object as Org syntax.
3065 CONTENTS is nil."
3069 "Search for the next line-break object.
3071 Return value is a cons cell whose CAR is `line-break' and CDR is
3072 beginning position."
3076 ;; A line break can only happen on a non-empty line.
3081 ;;;; Link
3084 "Parse link at point.
3086 Return a list whose CAR is `link' and CDR a plist with `:type',
3087 `:path', `:raw-link', `:application', `:search-option', `:begin',
3088 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3089 keywords.
3091 Assume point is at the beginning of the link."
3094 end contents-begin contents-end link-end post-blank path type
3095 raw-link link search-option application)
3097 ;; Type 1: Text targeted from a radio target.
3102 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3107 ;; RAW-LINK is the original link. Expand any
3108 ;; abbreviation in it.
3112 ;; Determine TYPE of link and set PATH accordingly.
3114 ;; File type.
3118 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3121 ;; Id type: PATH is the id.
3124 ;; Code-ref type: PATH is the name of the reference.
3127 ;; Custom-id type: PATH is the name of the custom id.
3130 ;; Fuzzy type: Internal link either matches a target, an
3131 ;; headline name or nothing. PATH is the target or
3132 ;; headline's name.
3134 ;; Type 3: Plain link, i.e. http://orgmode.org
3140 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3147 ;; In any case, deduce end point after trailing white space from
3148 ;; LINK-END variable.
3151 ;; Extract search option and opening application out of
3152 ;; "file"-type links.
3154 ;; Application.
3159 ;; Extract search option from PATH.
3163 ;; Make sure TYPE always reports "file".
3167 :path path
3169 :application application
3170 :search-option search-option
3171 :begin begin
3172 :end end
3173 :contents-begin contents-begin
3174 :contents-end contents-end
3178 "Interpret LINK object as Org syntax.
3179 CONTENTS is the contents of the object, or nil."
3184 raw-link
3188 "Search for the next link object.
3190 Return value is a cons cell whose CAR is `link' and CDR is
3191 beginning position."
3200 "Search for the next plain link object.
3202 Return value is a cons cell whose CAR is `link' and CDR is
3203 beginning position."
3208 ;;;; Macro
3211 "Parse macro at point.
3213 Return a list whose CAR is `macro' and CDR a plist with `:key',
3214 `:args', `:begin', `:end', `:value' and `:post-blank' as
3215 keywords.
3217 Assume point is at the macro."
3228 ;; Do not use `org-split-string' since empty
3229 ;; strings are meaningful here.
3237 args nil t)
3241 :value value
3242 :args args
3243 :begin begin
3244 :end end
3248 "Interpret MACRO object as Org syntax.
3249 CONTENTS is nil."
3253 "Search for the next macro object.
3255 Return value is cons cell whose CAR is `macro' and CDR is
3256 beginning position."
3260 nil t)
3264 ;;;; Radio-target
3267 "Parse radio target at point.
3269 Return a list whose CAR is `radio-target' and CDR a plist with
3270 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3271 and `:post-blank' as keywords.
3273 Assume point is at the radio target."
3285 :end end
3286 :contents-begin contents-begin
3287 :contents-end contents-end
3288 :post-blank post-blank
3292 "Interpret TARGET object as Org syntax.
3293 CONTENTS is the contents of the object."
3297 "Search for the next radio-target object.
3299 Return value is a cons cell whose CAR is `radio-target' and CDR
3300 is beginning position."
3306 ;;;; Statistics Cookie
3309 "Parse statistics cookie at point.
3311 Return a list whose CAR is `statistics-cookie', and CDR a plist
3312 with `:begin', `:end', `:value' and `:post-blank' keywords.
3314 Assume point is at the beginning of the statistics-cookie."
3325 :end end
3326 :value value
3330 "Interpret STATISTICS-COOKIE object as Org syntax.
3331 CONTENTS is nil."
3335 "Search for the next statistics cookie object.
3337 Return value is a cons cell whose CAR is `statistics-cookie' and
3338 CDR is beginning position."
3344 ;;;; Strike-Through
3347 "Parse strike-through object at point.
3349 Return a list whose CAR is `strike-through' and CDR is a plist
3350 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3351 `:post-blank' keywords.
3353 Assume point is at the first plus sign marker."
3365 :end end
3366 :contents-begin contents-begin
3367 :contents-end contents-end
3371 "Interpret STRIKE-THROUGH object as Org syntax.
3372 CONTENTS is the contents of the object."
3376 ;;;; Subscript
3379 "Parse subscript at point.
3381 Return a list whose CAR is `subscript' and CDR a plist with
3382 `:begin', `:end', `:contents-begin', `:contents-end',
3383 `:use-brackets-p' and `:post-blank' as keywords.
3385 Assume point is at the underscore."
3399 :end end
3400 :use-brackets-p bracketsp
3401 :contents-begin contents-begin
3402 :contents-end contents-end
3406 "Interpret SUBSCRIPT object as Org syntax.
3407 CONTENTS is the contents of the object."
3410 contents))
3413 "Search for the next sub/superscript object.
3415 Return value is a cons cell whose CAR is either `subscript' or
3416 `superscript' and CDR is beginning position."
3424 ;;;; Superscript
3427 "Parse superscript at point.
3429 Return a list whose CAR is `superscript' and CDR a plist with
3430 `:begin', `:end', `:contents-begin', `:contents-end',
3431 `:use-brackets-p' and `:post-blank' as keywords.
3433 Assume point is at the caret."
3447 :end end
3448 :use-brackets-p bracketsp
3449 :contents-begin contents-begin
3450 :contents-end contents-end
3454 "Interpret SUPERSCRIPT object as Org syntax.
3455 CONTENTS is the contents of the object."
3458 contents))
3461 ;;;; Table Cell
3464 "Parse table cell at point.
3466 Return a list whose CAR is `table-cell' and CDR is a plist
3467 containing `:begin', `:end', `:contents-begin', `:contents-end'
3468 and `:post-blank' keywords."
3476 :end end
3477 :contents-begin contents-begin
3478 :contents-end contents-end
3482 "Interpret TABLE-CELL element as Org syntax.
3483 CONTENTS is the contents of the cell, or nil."
3487 "Search for the next table-cell object.
3489 Return value is a cons cell whose CAR is `table-cell' and CDR is
3490 beginning position."
3494 ;;;; Target
3497 "Parse target at point.
3499 Return a list whose CAR is `target' and CDR a plist with
3500 `:begin', `:end', `:value' and `:post-blank' as keywords.
3502 Assume point is at the target."
3512 :end end
3513 :value value
3517 "Interpret TARGET object as Org syntax.
3518 CONTENTS is nil."
3522 "Search for the next target object.
3524 Return value is a cons cell whose CAR is `target' and CDR is
3525 beginning position."
3531 ;;;; Timestamp
3534 "Parse time stamp at point.
3536 Return a list whose CAR is `timestamp', and CDR a plist with
3537 `:type', `:raw-value', `:year-start', `:month-start',
3538 `:day-start', `:hour-start', `:minute-start', `:year-end',
3539 `:month-end', `:day-end', `:hour-end', `:minute-end',
3540 `:repeater-type', `:repeater-value', `:repeater-unit',
3541 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3542 `:end', `:value' and `:post-blank' keywords.
3544 Assume point is at the beginning of the timestamp."
3562 date-start)
3573 raw-value)
3575 :repeater-type
3581 :repeater-unit
3590 :warning-unit
3593 year-start month-start day-start hour-start minute-start year-end
3594 month-end day-end hour-end minute-end)
3595 ;; Parse date-start.
3603 ;; Compute date-end. It can be provided directly in time-stamp,
3604 ;; or extracted from time range. Otherwise, it defaults to the
3605 ;; same values as date-start.
3615 :raw-value raw-value
3616 :year-start year-start
3617 :month-start month-start
3618 :day-start day-start
3619 :hour-start hour-start
3620 :minute-start minute-start
3621 :year-end year-end
3622 :month-end month-end
3623 :day-end day-end
3624 :hour-end hour-end
3625 :minute-end minute-end
3626 :begin begin
3627 :end end
3629 repeater-props
3630 warning-props)))))
3633 "Interpret TIMESTAMP object as Org syntax.
3634 CONTENTS is nil."
3653 ;; Build an Org timestamp string from TIME. ACTIVEP is
3654 ;; non-nil when time stamp is active. If WITH-TIME-P is
3655 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3656 ;; specify a time range in the timestamp. REPEAT-STRING is
3657 ;; the repeater string, if any.
3661 org-time-stamp-formats)
3662 time)))
3668 nil nil ts)))
3673 " "
3674 s
3676 ;; Return value.
3677 ts)))
3689 build-ts-string
3708 0
3716 "--"
3728 "Search for the next timestamp object.
3730 Return value is a cons cell whose CAR is `timestamp' and CDR is
3731 beginning position."
3739 nil t)
3743 ;;;; Underline
3746 "Parse underline object at point.
3748 Return a list whose CAR is `underline' and CDR is a plist with
3749 `:begin', `:end', `:contents-begin' and `:contents-end' and
3750 `:post-blank' keywords.
3752 Assume point is at the first underscore marker."
3764 :end end
3765 :contents-begin contents-begin
3766 :contents-end contents-end
3770 "Interpret UNDERLINE object as Org syntax.
3771 CONTENTS is the contents of the object."
3775 ;;;; Verbatim
3778 "Parse verbatim object at point.
3780 Return a list whose CAR is `verbatim' and CDR is a plist with
3781 `:value', `:begin', `:end' and `:post-blank' keywords.
3783 Assume point is at the first equal sign marker."
3794 :begin begin
3795 :end end
3799 "Interpret VERBATIM object as Org syntax.
3800 CONTENTS is nil."
3804 \f
3805 ;;; Parsing Element Starting At Point
3806 ;;
3807 ;; `org-element--current-element' is the core function of this section.
3808 ;; It returns the Lisp representation of the element starting at
3809 ;; point.
3810 ;;
3811 ;; `org-element--current-element' makes use of special modes. They
3812 ;; are activated for fixed element chaining (i.e. `plain-list' >
3813 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3814 ;; `section'). Special modes are: `first-section', `item',
3815 ;; `node-property', `quote-section', `section' and `table-row'.
3819 "Parse the element starting at point.
3821 Return value is a list like (TYPE PROPS) where TYPE is the type
3822 of the element and PROPS a plist of properties associated to the
3823 element.
3825 Possible types are defined in `org-element-all-elements'.
3827 LIMIT bounds the search.
3829 Optional argument GRANULARITY determines the depth of the
3830 recursion. Allowed values are `headline', `greater-element',
3831 `element', `object' or nil. When it is broader than `object' (or
3832 nil), secondary values will not be parsed, since they only
3833 contain objects.
3835 Optional argument SPECIAL, when non-nil, can be either
3836 `first-section', `item', `node-property', `quote-section',
3837 `section', and `table-row'.
3839 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3840 be computed.
3842 This function assumes point is always at the beginning of the
3843 element it has to parse."
3846 ;; Determine if parsing depth allows for secondary strings
3847 ;; parsing. It only applies to elements referenced in
3848 ;; `org-element-secondary-value-alist'.
3851 ;; Item.
3854 ;; Table Row.
3856 ;; Node Property.
3858 ;; Headline.
3861 ;; Sections (must be checked after headline).
3867 limit)))
3868 ;; When not at bol, point is at the beginning of an item or
3869 ;; a footnote definition: next item is always a paragraph.
3871 ;; Planning and Clock.
3876 ;; Inlinetask.
3879 ;; From there, elements can have affiliated keywords.
3882 ;; Jumping over affiliated keywords put point off-limits.
3883 ;; Parse them as regular keywords.
3887 ;; LaTeX Environment.
3891 ;; Drawer and Property Drawer.
3896 ;; Fixed Width
3899 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3900 ;; Keywords.
3909 org-element-block-name-alist)))
3924 ;; Footnote Definition.
3927 ;; Horizontal Rule.
3930 ;; Diary Sexp.
3933 ;; Table.
3935 ;; List.
3938 limit affiliated
3940 ;; Default element: Paragraph.
3944 ;; Most elements can have affiliated keywords. When looking for an
3945 ;; element beginning, we want to move before them, as they belong to
3946 ;; that element, and, in the meantime, collect information they give
3947 ;; into appropriate properties. Hence the following function.
3950 "Collect affiliated keywords from point down to LIMIT.
3952 Return a list whose CAR is the position at the first of them and
3953 CDR a plist of keywords and values and move point to the
3954 beginning of the first line after them.
3956 As a special case, if element doesn't start at the beginning of
3957 the line (i.e. a paragraph starting an item), CAR is current
3958 position of point and CDR is nil."
3962 ;; RESTRICT is the list of objects allowed in parsed
3963 ;; keywords value.
3965 output)
3968 ;; Apply translation to RAW-KWD. From there, KWD is
3969 ;; the official keyword.
3971 org-element-keyword-translation-alist))
3972 raw-kwd))
3973 ;; Find main value for any keyword.
3979 ;; PARSEDP is non-nil when keyword should have its
3980 ;; value parsed.
3982 ;; If KWD is a dual keyword, find its secondary
3983 ;; value. Maybe parse it.
3990 ;; Attribute a property name to KWD.
3992 ;; Now set final shape for VALUE.
3998 ;; Attributes can always appear on multiple lines.
4001 ;; Eventually store the new value in OUTPUT.
4003 ;; Move to next keyword.
4005 ;; If affiliated keywords are orphaned: move back to first one.
4006 ;; They will be parsed as a paragraph.
4008 ;; Return value.
4012 \f
4013 ;;; The Org Parser
4014 ;;
4015 ;; The two major functions here are `org-element-parse-buffer', which
4016 ;; parses Org syntax inside the current buffer, taking into account
4017 ;; region, narrowing, or even visibility if specified, and
4018 ;; `org-element-parse-secondary-string', which parses objects within
4019 ;; a given string.
4020 ;;
4021 ;; The (almost) almighty `org-element-map' allows to apply a function
4022 ;; on elements or objects matching some type, and accumulate the
4023 ;; resulting values. In an export situation, it also skips unneeded
4024 ;; parts of the parse tree.
4027 "Recursively parse the buffer and return structure.
4028 If narrowing is in effect, only parse the visible part of the
4029 buffer.
4031 Optional argument GRANULARITY determines the depth of the
4032 recursion. It can be set to the following symbols:
4034 `headline' Only parse headlines.
4035 `greater-element' Don't recurse into greater elements excepted
4036 headlines and sections. Thus, elements
4037 parsed are the top-level ones.
4038 `element' Parse everything but objects and plain text.
4039 `object' Parse the complete buffer (default).
4041 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4042 elements.
4044 An element or an objects is represented as a list with the
4045 pattern (TYPE PROPERTIES CONTENTS), where :
4047 TYPE is a symbol describing the element or object. See
4048 `org-element-all-elements' and `org-element-all-objects' for an
4049 exhaustive list of such symbols. One can retrieve it with
4050 `org-element-type' function.
4052 PROPERTIES is the list of attributes attached to the element or
4053 object, as a plist. Although most of them are specific to the
4054 element or object type, all types share `:begin', `:end',
4055 `:post-blank' and `:parent' properties, which respectively
4056 refer to buffer position where the element or object starts,
4057 ends, the number of white spaces or blank lines after it, and
4058 the element or object containing it. Properties values can be
4059 obtained by using `org-element-property' function.
4061 CONTENTS is a list of elements, objects or raw strings
4062 contained in the current element or object, when applicable.
4063 One can access them with `org-element-contents' function.
4065 The Org buffer has `org-data' as type and nil as properties.
4066 `org-element-map' function can be used to find specific elements
4067 or objects within the parse tree.
4069 This function assumes that current major mode is `org-mode'."
4075 ;; Start in `first-section' mode so text before the first
4076 ;; headline belongs to a section.
4080 "Recursively parse objects in STRING and return structure.
4082 RESTRICTION is a symbol limiting the object types that will be
4083 looked after.
4085 Optional argument PARENT, when non-nil, is the element or object
4086 containing the secondary string. It is used to set correctly
4087 `:parent' property within the string."
4088 ;; Copy buffer-local variables listed in
4089 ;; `org-element-object-variables' into temporary buffer. This is
4090 ;; required since object parsing is dependent on these variables.
4094 org-element-object-variables))))
4102 secondary))
4103 secondary))))
4107 "Map a function on selected elements or objects.
4109 DATA is a parse tree, an element, an object, a string, or a list
4110 of such constructs. TYPES is a symbol or list of symbols of
4111 elements or objects types (see `org-element-all-elements' and
4112 `org-element-all-objects' for a complete list of types). FUN is
4113 the function called on the matching element or object. It has to
4114 accept one argument: the element or object itself.
4116 When optional argument INFO is non-nil, it should be a plist
4117 holding export options. In that case, parts of the parse tree
4118 not exportable according to that property list will be skipped.
4120 When optional argument FIRST-MATCH is non-nil, stop at the first
4121 match for which FUN doesn't return nil, and return that value.
4123 Optional argument NO-RECURSION is a symbol or a list of symbols
4124 representing elements or objects types. `org-element-map' won't
4125 enter any recursive element or object whose type belongs to that
4126 list. Though, FUN can still be applied on them.
4128 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4129 apply to matching objects within parsed affiliated keywords (see
4130 `org-element-parsed-keywords').
4132 Nil values returned from FUN do not appear in the results.
4135 Examples:
4136 ---------
4138 Assuming TREE is a variable containing an Org buffer parse tree,
4139 the following example will return a flat list of all `src-block'
4140 and `example-block' elements in it:
4142 \(org-element-map tree '(example-block src-block) 'identity)
4144 The following snippet will find the first headline with a level
4147 \(org-element-map tree 'headline
4148 \(lambda (hl)
4149 \(and (= (org-element-property :level hl) 1)
4151 \(org-element-property :begin hl)))
4152 nil t)
4154 The next example will return a flat list of all `plain-list' type
4155 elements in TREE that are not a sub-list themselves:
4157 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4159 Eventually, this example will return a flat list of all `bold'
4160 type objects containing a `latex-snippet' type object, even
4161 looking into captions:
4163 \(org-element-map tree 'bold
4164 \(lambda (b)
4165 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4166 nil nil nil t)"
4167 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4170 ;; Recursion depth is determined by --CATEGORY.
4177 ;; If one object is found, the function
4178 ;; has to recurse into every object.
4181 ;; If one regular element is found, the
4182 ;; function has to recurse, at least,
4183 ;; into every element it encounters.
4186 types)
4187 category)))
4188 ;; Compute properties for affiliated keywords if necessary.
4193 org-element-affiliated-keywords)))
4194 --acc
4195 --walk-tree
4199 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4200 ;; holding contextual information.
4204 ;; Ignored element in an export context.
4206 ;; List of elements or objects.
4208 ;; Unconditionally enter parse trees.
4212 ;; Check if TYPE is matching among TYPES. If so,
4213 ;; apply FUN to --DATA and accumulate return value
4214 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4220 ;; If --DATA has a secondary string that can contain
4221 ;; objects with their type among TYPES, look into it.
4228 ;; If --DATA has any affiliated keywords and
4229 ;; WITH-AFFILIATED is non-nil, look for objects in
4230 ;; them.
4238 ;; Pay attention to the type of value.
4239 ;; Preserve order for multiple keywords.
4255 --affiliated-alist))
4256 ;; Determine if a recursion into --DATA is possible.
4258 ;; --TYPE is explicitly removed from recursion.
4260 ;; --DATA has no contents.
4262 ;; Looking for greater elements but --DATA is simply
4263 ;; an element or an object.
4266 ;; Looking for elements but --DATA is an object.
4269 ;; In any other case, map contents.
4273 ;; Return value in a proper order.
4277 ;; The following functions are internal parts of the parser.
4278 ;;
4279 ;; The first one, `org-element--parse-elements' acts at the element's
4280 ;; level.
4281 ;;
4282 ;; The second one, `org-element--parse-objects' applies on all objects
4283 ;; of a paragraph or a secondary string. It uses
4284 ;; `org-element--get-next-object-candidates' to optimize the search of
4285 ;; the next object in the buffer.
4286 ;;
4287 ;; More precisely, that function looks for every allowed object type
4288 ;; first. Then, it discards failed searches, keeps further matches,
4289 ;; and searches again types matched behind point, for subsequent
4290 ;; calls. Thus, searching for a given type fails only once, and every
4291 ;; object is searched only once at top level (but sometimes more for
4292 ;; nested types).
4296 "Parse elements between BEG and END positions.
4298 SPECIAL prioritize some elements over the others. It can be set
4299 to `first-section', `quote-section', `section' `item' or
4300 `table-row'.
4302 When value is `item', STRUCTURE will be used as the current list
4303 structure.
4305 GRANULARITY determines the depth of the recursion. See
4306 `org-element-parse-buffer' for more information.
4308 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4309 elements.
4311 Elements are accumulated into ACC."
4314 ;; Visible only: skip invisible parts at the beginning of the
4315 ;; element.
4318 ;; When parsing only headlines, skip any text before first one.
4321 ;; Main loop start.
4323 ;; Find current element's type and parse it accordingly to
4324 ;; its category.
4326 end granularity special structure))
4330 ;; Visible only: skip invisible parts between siblings.
4333 ;; Fill ELEMENT contents by side-effect.
4335 ;; If element has no contents, don't modify it.
4337 ;; Greater element: parse it between `contents-begin' and
4338 ;; `contents-end'. Make sure GRANULARITY allows the
4339 ;; recursion, or ELEMENT is a headline, in which case going
4340 ;; inside is mandatory, in order to get sub-level headings.
4348 ;; Possibly switch to a special mode.
4358 granularity visible-only element))
4359 ;; ELEMENT has contents. Parse objects inside, if
4360 ;; GRANULARITY allows it.
4366 ;; Return result.
4367 acc))
4370 "Parse objects between BEG and END and return recursive structure.
4372 Objects are accumulated in ACC.
4374 RESTRICTION is a list of object successors which are allowed in
4375 the current object."
4384 restriction candidates)))
4391 ;; 1. Text before any object. Untabify it.
4396 acc
4400 ;; 2. Object...
4403 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4404 ;; a recursive type.
4412 ;; 3. Text after last object. Untabify it.
4416 acc
4420 ;; Result.
4421 acc))))
4424 "Return an alist of candidates for the next object.
4426 RESTRICTION is a list of object types, as symbols. Only
4427 candidates with such types are looked after.
4429 OBJECTS is the previous candidates alist. If it is set to
4430 `initial', no search has been done before, and all symbols in
4431 RESTRICTION should be looked after.
4433 Return value is an alist whose CAR is the object type and CDR its
4434 beginning position."
4436 nil
4438 ;; When searching for the first time, look for every successor
4439 ;; allowed in RESTRICTION.
4443 restriction)
4444 ;; Focus on objects returned during last search. Keep those
4445 ;; still after point. Search again objects before it.
4451 type)))
4454 objects))))
4457 \f
4458 ;;; Towards A Bijective Process
4459 ;;
4460 ;; The parse tree obtained with `org-element-parse-buffer' is really
4461 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4462 ;; interpreted and expanded into a string with canonical Org syntax.
4463 ;; Hence `org-element-interpret-data'.
4464 ;;
4465 ;; The function relies internally on
4466 ;; `org-element--interpret-affiliated-keywords'.
4468 ;;;###autoload
4470 "Interpret DATA as Org syntax.
4472 DATA is a parse tree, an element, an object or a secondary string
4473 to interpret.
4475 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4476 new types that should be treated as objects. An unknown type not
4477 belonging to this list is seen as a pseudo-element instead. Both
4478 pseudo-objects and pseudo-elements are transparent entities, i.e.
4479 only their contents are interpreted.
4481 Return Org syntax as a string."
4485 "Interpret DATA as Org syntax.
4487 DATA is a parse tree, an element, an object or a secondary string
4488 to interpret. PARENT is used for recursive calls. It contains
4489 the element or object containing data, or nil. PSEUDO-OBJECTS
4490 are list of symbols defining new element or object types.
4491 Unknown types that don't belong to this list are treated as
4492 pseudo-elements instead.
4494 Return Org syntax as a string."
4496 ;; Find interpreter for current object or element. If it
4497 ;; doesn't exist (e.g. this is a pseudo object or element),
4498 ;; return contents, if any.
4504 ;; Secondary string.
4510 ;; Full Org document.
4516 ;; Plain text: remove `:parent' text property from output.
4518 ;; Element or object without contents.
4520 ;; Element or object with contents.
4523 ;; Recursively interpret contents.
4529 data
4530 ;; Fix indentation of elements containing
4531 ;; objects. We ignore `table-row' elements
4532 ;; as they are one line long anyway.
4534 data
4535 ;; When normalizing first paragraph of an
4536 ;; item or a footnote-definition, ignore
4537 ;; first line's indentation.
4544 ;; Build white spaces. If no `:post-blank' property is
4545 ;; specified, assume its value is 0.
4556 "Return ELEMENT's affiliated keywords as Org syntax.
4557 If there is no affiliated keyword, return the empty string."
4567 ": "
4570 value)
4578 ;; All attribute keywords can have multiple lines.
4584 ;; List all ELEMENT's properties matching an attribute line or an
4585 ;; affiliated keyword, but ignore translated keywords since they
4586 ;; cannot belong to the property list.
4593 org-element-keyword-translation-alist)))))
4594 collect prop)
4597 ;; Because interpretation of the parse tree must return the same
4598 ;; number of blank lines between elements and the same number of white
4599 ;; space after objects, some special care must be given to white
4600 ;; spaces.
4601 ;;
4602 ;; The first function, `org-element-normalize-string', ensures any
4603 ;; string different from the empty string will end with a single
4604 ;; newline character.
4605 ;;
4606 ;; The second function, `org-element-normalize-contents', removes
4607 ;; global indentation from the contents of the current element.
4610 "Ensure string S ends with a single newline character.
4612 If S isn't a string return it unchanged. If S is the empty
4613 string, return it. Otherwise, return a new string with a single
4614 newline character at its end."
4622 "Normalize plain text in ELEMENT's contents.
4624 ELEMENT must only contain plain text and objects.
4626 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4627 indentation to compute maximal common indentation.
4629 Return the normalized element that is element with global
4630 indentation removed from its contents. The function assumes that
4631 indentation is not done with TAB characters."
4633 collect-inds ; for byte-compiler
4636 ;; Return list of indentations within BLOB. This is done by
4637 ;; walking recursively BLOB and updating IND-LIST along the
4638 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4639 ;; been seen yet. It is required as this string is the only
4640 ;; one whose indentation doesn't happen after a newline
4641 ;; character.
4649 ;; An indentation of zero means no string will be
4650 ;; modified. Quit the process.
4656 ;; Avoid matching blank or empty lines.
4664 ;; Collect indentation list in ELEMENT. Possibly remove first
4665 ;; value if IGNORE-FIRST is non-nil.
4668 ;; Build ELEMENT back, replacing each string with the same
4669 ;; string minus common indentation.
4674 ;; Return BLOB with all its strings indentation
4675 ;; shortened from MCI white spaces. FIRST-FLAG is
4676 ;; non-nil when the first string hasn't been seen
4677 ;; yet.
4691 org-element-recursive-objects)
4695 blob))))
4699 \f
4700 ;;; The Toolbox
4701 ;;
4702 ;; The first move is to implement a way to obtain the smallest element
4703 ;; containing point. This is the job of `org-element-at-point'. It
4704 ;; basically jumps back to the beginning of section containing point
4705 ;; and proceed, one element after the other, with
4706 ;; `org-element--current-element' until the container is found. Note:
4707 ;; When using `org-element-at-point', secondary values are never
4708 ;; parsed since the function focuses on elements, not on objects.
4709 ;;
4710 ;; At a deeper level, `org-element-context' lists all elements and
4711 ;; objects containing point.
4712 ;;
4713 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4714 ;; internally by navigation and manipulation tools.
4717 ;;;###autoload
4719 "Determine closest element around point.
4721 Return value is a list like (TYPE PROPS) where TYPE is the type
4722 of the element and PROPS a plist of properties associated to the
4723 element.
4725 Possible types are defined in `org-element-all-elements'.
4726 Properties depend on element or object type, but always include
4727 `:begin', `:end', `:parent' and `:post-blank' properties.
4729 As a special case, if point is at the very beginning of the first
4730 item in a list or sub-list, returned element will be that list
4731 instead of the item. Likewise, if point is at the beginning of
4732 the first row of a table, returned element will be the table
4733 instead of the first row.
4735 When point is at the end of the buffer, return the innermost
4736 element ending there."
4743 ;; Within blank lines at the beginning of buffer, return nil.
4745 ;; Within blank lines right after a headline, return that
4746 ;; headline.
4750 ;; Otherwise use cache in order to approximate current element.
4755 ;; Nothing in cache before point: start parsing from first
4756 ;; element following headline above, or first element in
4757 ;; buffer.
4763 ;; Cache returned exact match: return it.
4765 ;; There's a headline between cached value and ORIGIN:
4766 ;; cached value is invalid. Start parsing from first
4767 ;; element following the headline.
4773 ;; Check if CACHED or any of its ancestors contain point.
4774 ;;
4775 ;; If there is such an element, we inspect it in order to
4776 ;; know if we return it or if we need to parse its contents.
4777 ;; Otherwise, we just start parsing from current location,
4778 ;; which is right after the top-most element containing
4779 ;; CACHED.
4780 ;;
4781 ;; As a special case, if ORIGIN is at the end of the buffer,
4782 ;; we want to return the innermost element ending there.
4783 ;;
4784 ;; Also, if we find an ancestor and discover that we need to
4785 ;; parse its contents, make sure we don't start from
4786 ;; `:contents-begin', as we would otherwise go past CACHED
4787 ;; again. Instead, in that situation, we will resume
4788 ;; parsing from NEXT, which is located after CACHED or its
4789 ;; higher ancestor not containing point.
4794 begin))
4802 ;; Parse successively each element until we reach ORIGIN.
4807 parent special-flag)
4811 end 'element special-flag
4818 ;; Special case: ORIGIN is at the end of the buffer and
4819 ;; CACHED ends here. No element can start after it, but
4820 ;; more than one may end there. Arbitrarily, we choose
4821 ;; to return the innermost of such elements.
4834 parent element
4835 end cend))))
4836 ;; Skip any element ending before point. Also skip
4837 ;; element ending at point since we're sure that another
4838 ;; element begins after it.
4840 ;; A non-greater element contains point: return it.
4843 ;; Otherwise, we have to decide if ELEMENT really
4844 ;; contains ORIGIN. In that case we start parsing from
4845 ;; contents' beginning. Otherwise we return UP as it is
4846 ;; the smallest element containing ORIGIN.
4847 ;;
4848 ;; There is a special cases to consider, though. If
4849 ;; ORIGIN is at contents' beginning but it is also at
4850 ;; the beginning of the first item in a list or a table.
4851 ;; In that case, we need to create an anchor for that
4852 ;; list or table, so return it.
4864 parent element
4865 end cend))))))
4866 ;; Continue parsing buffer contents from new position.
4869 ;;;###autoload
4871 "Return closest element or object around point.
4873 Return value is a list like (TYPE PROPS) where TYPE is the type
4874 of the element or object and PROPS a plist of properties
4875 associated to it.
4877 Possible types are defined in `org-element-all-elements' and
4878 `org-element-all-objects'. Properties depend on element or
4879 object type, but always include `:begin', `:end', `:parent' and
4880 `:post-blank'.
4882 Optional argument ELEMENT, when non-nil, is the closest element
4883 containing point, as returned by `org-element-at-point'.
4884 Providing it allows for quicker computation."
4890 ;; If point is inside an element containing objects or
4891 ;; a secondary string, narrow buffer to the container and
4892 ;; proceed with parsing. Otherwise, return ELEMENT.
4894 ;; At a parsed affiliated keyword, check if we're inside main
4895 ;; or dual value.
4902 org-element-parsed-keywords))
4911 ;; Also change type to retrieve correct restrictions.
4913 ;; At an item, objects can only be located within tag, if any.
4923 ;; At an headline or inlinetask, objects are in title.
4930 ;; At a paragraph, a table-row or a verse block, objects are
4931 ;; located within their contents.
4935 ;; CBEG is nil for table rules.
4939 ;; At a parsed keyword, objects are located within value.
4942 org-element-document-properties))
4949 ;; All other locations cannot contain objects: bail out.
4956 objects-data next update-cache-flag)
4960 ;; Get list of next object candidates in CANDIDATES.
4961 ;; When entering for the first time PARENT, grab it
4962 ;; from cache, if available, or compute it. Then,
4963 ;; for each subsequent iteration in PARENT, always
4964 ;; compute it since we're beyond cache anyway.
4969 cache))))
4973 restriction candidates))
4975 ;; Compare ORIGIN with next object starting position,
4976 ;; if any.
4977 ;;
4978 ;; If ORIGIN is lesser or if there is no object
4979 ;; following, look for a previous object that might
4980 ;; contain it in cache. If there is no cache, we
4981 ;; didn't miss any object so simply return PARENT.
4982 ;;
4983 ;; If ORIGIN is greater or equal, parse next
4984 ;; candidate for further processing.
4988 candidates))))
4994 ;; Object ends before ORIGIN and we
4995 ;; know next one in cache starts
4996 ;; after it: bail out.
5004 ;; Process NEXT to know if we need to skip it, return
5005 ;; it or move into it.
5010 ;; ORIGIN is after NEXT, so skip it.
5012 ;; ORIGIN is within a non-recursive next or
5013 ;; at an object boundaries: Return that object.
5017 ;; Otherwise, move into NEXT and reset flags as we
5018 ;; shift parent.
5024 next nil
5025 objects-data nil
5027 ;; Store results in cache, if applicable.
5031 "Non-nil when elements ELEM-A and ELEM-B are nested."
5040 "Swap elements ELEM-A and ELEM-B.
5041 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5042 end of ELEM-A."
5044 ;; There are two special cases when an element doesn't start at bol:
5045 ;; the first paragraph in an item or in a footnote definition.
5047 ;; Only a paragraph without any affiliated keyword can be moved at
5048 ;; ELEM-A position in such a situation. Note that the case of
5049 ;; a footnote definition is impossible: it cannot contain two
5050 ;; paragraphs in a row because it cannot contain a blank line.
5056 ;; In a special situation, ELEM-A will have no indentation. We'll
5057 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5071 ;; Store overlays responsible for visibility status. We
5072 ;; also need to store their boundaries as they will be
5073 ;; removed from buffer.
5080 ;; Get contents.
5088 ;; Restore ex ELEM-A overlays.
5097 ;; Restore ex ELEM-B overlays.
5105 "Remove maximum common indentation in string S and return it.
5106 When optional argument N is a positive integer, remove exactly
5107 that much characters from indentation, if possible, or return
5108 S as-is otherwise. Unlike to `org-remove-indentation', this
5109 function doesn't call `untabify' on S."
5114 ;; Find maximum common indentation, if not specified.
5122 min-ind)))
5124 ;; Remove exactly N indentation, but give up if not possible.
5134 \f
5135 ;;; Cache
5136 ;;
5137 ;; Both functions `org-element-at-point' and `org-element-context'
5138 ;; benefit from a simple caching mechanism.
5139 ;;
5140 ;; Three public functions are provided: `org-element-cache-put',
5141 ;; `org-element-cache-get' and `org-element-cache-reset'.
5142 ;;
5143 ;; Cache is enabled by default, but can be disabled globally with
5144 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time' and
5145 ;; `org-element-cache-merge-changes-threshold' can be tweaked to
5146 ;; control caching behaviour.
5150 "Non nil when Org parser should cache its results.
5154 "Number of characters triggering cache syncing.
5156 The cache mechanism only stores one buffer modification at any
5157 given time. When another change happens, it replaces it with
5158 a change containing both the stored modification and the current
5159 one. This is a trade-off, as merging them prevents another
5160 syncing, but every element between them is then lost.
5162 This variable determines the maximum size, in characters, we
5166 "Number of seconds of idle time wait before syncing buffer cache.
5167 Syncing also happens when current modification is too distant
5168 from the stored one (for more information, see
5172 ;;;; Data Structure
5175 "AVL tree used to cache elements.
5176 Each node of the tree contains an element. Comparison is done
5177 with `org-element--cache-compare'. This cache is used in
5181 "Hash table used as to cache objects.
5182 Key is an element, as returned by `org-element-at-point', and
5183 value is an alist where each association is:
5185 \(POS CANDIDATES . OBJECTS)
5187 where POS is a buffer position, CANDIDATES is the last know list
5188 of successors (see `org-element--get-next-object-candidates') in
5189 container starting at POS and OBJECTS is a list of objects known
5190 to live within that container, from farthest to closest.
5193 at, respectively, positions 1, 7 and 8,
5197 If the paragraph is completely parsed, OBJECTS-DATA will be
5199 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
5200 \(8 nil ENTITY-OBJECT))
5202 whereas in a partially parsed paragraph, it could be
5204 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
5209 "Non-nil when element A is located before element B."
5213 ;; Items and plain lists on the one hand, table rows and
5214 ;; tables on the other hand can start at the same position.
5215 ;; In this case, the parent element is always before its child
5216 ;; in the buffer.
5222 "Return root value in cache.
5223 This function assumes `org-element--cache' is a valid AVL tree."
5227 ;;;; Staging Buffer Changes
5230 "Contains data about cache validity for current buffer.
5232 Value is a vector of seven elements,
5234 [ACTIVEP BEGIN END OFFSET TIMER PREVIOUS-STATE]
5236 ACTIVEP is a boolean non-nil when changes described in the other
5237 slots are valid for current buffer.
5239 BEGIN and END are the beginning and ending position of the area
5240 for which cache cannot be trusted.
5242 OFFSET it an integer specifying the number to add to position of
5243 elements after that area.
5245 TIMER is a timer used to apply these changes to cache when Emacs
5246 is idle.
5248 PREVIOUS-STATE is a symbol referring to the state of the buffer
5249 before a change happens. It is used to know if sensitive
5250 areas (block boundaries, headlines) were modified. It can be set
5259 "Regexp matching an element opening line.
5260 When such a line is modified, modifications may propagate after
5261 modified area. In that situation, every element between that
5270 "Regexp matching an element closing line.
5271 When such a line is modified, modifications may propagate before
5272 modified area. In that situation, every element between that
5276 "Non-nil when changes are not integrated in cache yet."
5281 "Push change to current buffer staging area.
5282 BEG and END and the beginning and ending position of the
5283 modification area. OFFSET is the size of the change, as an
5284 integer."
5292 nil
5293 #'org-element--cache-sync
5298 "Remove any cache change set for current buffer."
5304 "Request extension of area going to be modified if needed.
5305 BEG and END are the beginning and end of the range of changed
5306 text. See `before-change-functions' for more information."
5314 ;; A sensitive line is a headline or a block (or drawer,
5315 ;; or latex-environment) boundary. Inserting one can
5316 ;; modify buffer drastically both above and below that
5317 ;; line, possibly making cache invalid. Therefore, we
5318 ;; need to pay special attention to changes happening to
5319 ;; them.
5323 org-element--cache-opening-line)))
5336 "Update buffer modifications for current buffer.
5338 BEG and END are the beginning and end of the range of changed
5339 text, and the length in bytes of the pre-change text replaced by
5340 that range. See `after-change-functions' for more information.
5342 If there are already pending changes, try to merge them into
5343 a bigger change record. If that's not possible, the function
5344 will first synchronize cache with previous change and store the
5345 new one."
5355 ;; Determine if modified area needs to be extended,
5356 ;; according to both previous and current state. We make
5357 ;; a special case for headline editing: if a headline is
5358 ;; modified but not removed, do not extend.
5363 org-element--cache-opening-line)))
5374 ;; Effectively extend modified area.
5377 ;; Headline above is inclusive.
5381 ;; Headline below is exclusive.
5383 ;; Store changes.
5386 ;; No pending changes. Store the new ones.
5393 ;; If we cannot merge two change sets (i.e. they
5394 ;; modify distinct buffer parts) first apply current
5395 ;; change set and store new one. This way, there is
5396 ;; never more than one pending change set, which
5397 ;; avoids handling costly merges.
5401 ;; Change sets can be merged. We can expand the area
5402 ;; that requires an update, and postpone the sync.
5411 ;;;; Synchronization
5414 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5416 Properties containing buffer positions are `:begin', `:end',
5417 `:contents-begin', `:contents-end' and `:structure'. When
5418 optional argument PROPS is a list of keywords, only shift
5419 properties provided in that list.
5421 Properties are modified by side-effect. Return ELEMENT."
5423 ;; Shift :structure property for the first plain list only: it is
5424 ;; the only one that really matters and it prevents from shifting
5425 ;; it more than once.
5437 element)
5440 "Synchronize cache with recent modification in BUFFER.
5441 Elements ending before modification area are kept in cache.
5442 Elements starting after modification area have their position
5443 shifted by the size of the modification. Every other element is
5444 removed from the cache."
5451 ;; END is the beginning position of the first element
5452 ;; in cache that isn't removed but needs to be
5453 ;; shifted. It will be updated during phase 1.
5455 ;; Phase 1.
5456 ;;
5457 ;; Delete, in ascending order, all elements starting after
5458 ;; BEG, but before END.
5459 ;;
5460 ;; BEG is the position of the first element in cache to
5461 ;; remove. It takes into consideration partially modified
5462 ;; elements (starting before changes but ending after
5463 ;; them). Though, it preserves greater elements that are
5464 ;; not affected when changes alter only their contents.
5465 ;;
5466 ;; END is updated when necessary to include elements
5467 ;; starting after modifications but included in an element
5468 ;; altered by modifications.
5469 ;;
5470 ;; At each iteration, we start again at tree root since
5471 ;; a deletion modifies structure of the balanced tree.
5482 drawer dynamic-block inlinetask
5483 property-drawer quote-block
5484 special-block))
5486 beg)
5488 end))
5489 ;; UP is a greater element that is
5490 ;; wrapped around the changes. We
5491 ;; only need to extend its ending
5492 ;; boundaries and those of all its
5493 ;; parents.
5504 ;; We're at top level element containing
5505 ;; ELEMENT: if it's altered by buffer
5506 ;; modifications, it is first element in
5507 ;; cache to be removed. Otherwise, that
5508 ;; first element is the following one.
5513 ;; DATA will contain the closest element from
5514 ;; BEG, always after it.
5526 node nil)))))
5528 ;; No DATA is found so there's no element left
5529 ;; after BEG. Bail out.
5531 ;; Element starts after END, it is the first
5532 ;; one that needn't be removed from cache.
5533 ;; Move to second phase.
5535 ;; Remove element. Extend END so that all
5536 ;; elements it may contain are also removed.
5541 ;; Phase 2.
5542 ;;
5543 ;; Shift all elements starting after END by OFFSET (for an
5544 ;; offset different from 0).
5545 ;;
5546 ;; Increasing all beginning positions by OFFSET doesn't
5547 ;; alter tree structure, so elements are modified by
5548 ;; side-effect.
5549 ;;
5550 ;; We change all elements in decreasing order and make
5551 ;; sure to quit at the first element in cache starting
5552 ;; before END.
5559 ;; Shift element.
5561 ;; Shift associated objects data, if any.
5569 object offset)))))
5571 ;; Eventually signal cache as up-to-date.
5575 ;;;; Public Functions
5578 "Return cached data relative to KEY.
5580 KEY is either a number or an Org element, as returned by
5581 `org-element-at-point'. If KEY is a number, return closest
5582 cached data before or at position KEY. Otherwise, return cached
5583 objects contained in element KEY.
5585 In any case, return nil if no data is found, or if caching is not
5586 allowed.
5588 If changes are pending in current buffer, first synchronize the
5589 cache, unless optional argument IGNORE-CHANGES is non-nil."
5591 ;; If there are pending changes, first sync them.
5606 ;; When KEY is at the beginning of a table or list,
5607 ;; make sure to return it instead of the first row or
5608 ;; item.
5612 beg))
5616 last)))))
5619 "Store DATA in current buffer's cache, if allowed.
5620 If optional argument ELEMENT is non-nil, store DATA as objects
5621 relative to it. Otherwise, store DATA as an element. Nothing
5622 will be stored if `org-element-use-cache' is nil. Return DATA."
5629 ;;;###autoload
5631 "Reset cache in current buffer.
5632 When optional argument ALL is non-nil, reset cache in all Org
5633 buffers. This function will do nothing if
5634 `org-element-use-cache' is nil."
5646 'org-element--cache-objects
5658 ;; Local variables:
5659 ;; generated-autoload-file: "org-loaddefs.el"
5660 ;; End:
5662 ;;; org-element.el ends here