| blob | b8e8082981731b7b05c662dcd891404454df9521 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 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."
3389 t
3400 :end end
3401 :use-brackets-p bracketsp
3402 :contents-begin contents-begin
3403 :contents-end contents-end
3407 "Interpret SUBSCRIPT object as Org syntax.
3408 CONTENTS is the contents of the object."
3411 contents))
3414 "Search for the next sub/superscript object.
3416 Return value is a cons cell whose CAR is either `subscript' or
3417 `superscript' and CDR is beginning position."
3425 ;;;; Superscript
3428 "Parse superscript at point.
3430 Return a list whose CAR is `superscript' and CDR a plist with
3431 `:begin', `:end', `:contents-begin', `:contents-end',
3432 `:use-brackets-p' and `:post-blank' as keywords.
3434 Assume point is at the caret."
3448 :end end
3449 :use-brackets-p bracketsp
3450 :contents-begin contents-begin
3451 :contents-end contents-end
3455 "Interpret SUPERSCRIPT object as Org syntax.
3456 CONTENTS is the contents of the object."
3459 contents))
3462 ;;;; Table Cell
3465 "Parse table cell at point.
3467 Return a list whose CAR is `table-cell' and CDR is a plist
3468 containing `:begin', `:end', `:contents-begin', `:contents-end'
3469 and `:post-blank' keywords."
3477 :end end
3478 :contents-begin contents-begin
3479 :contents-end contents-end
3483 "Interpret TABLE-CELL element as Org syntax.
3484 CONTENTS is the contents of the cell, or nil."
3488 "Search for the next table-cell object.
3490 Return value is a cons cell whose CAR is `table-cell' and CDR is
3491 beginning position."
3495 ;;;; Target
3498 "Parse target at point.
3500 Return a list whose CAR is `target' and CDR a plist with
3501 `:begin', `:end', `:value' and `:post-blank' as keywords.
3503 Assume point is at the target."
3513 :end end
3514 :value value
3518 "Interpret TARGET object as Org syntax.
3519 CONTENTS is nil."
3523 "Search for the next target object.
3525 Return value is a cons cell whose CAR is `target' and CDR is
3526 beginning position."
3532 ;;;; Timestamp
3535 "Parse time stamp at point.
3537 Return a list whose CAR is `timestamp', and CDR a plist with
3538 `:type', `:raw-value', `:year-start', `:month-start',
3539 `:day-start', `:hour-start', `:minute-start', `:year-end',
3540 `:month-end', `:day-end', `:hour-end', `:minute-end',
3541 `:repeater-type', `:repeater-value', `:repeater-unit',
3542 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3543 `:end', `:value' and `:post-blank' keywords.
3545 Assume point is at the beginning of the timestamp."
3563 date-start)
3574 raw-value)
3576 :repeater-type
3582 :repeater-unit
3591 :warning-unit
3594 year-start month-start day-start hour-start minute-start year-end
3595 month-end day-end hour-end minute-end)
3596 ;; Parse date-start.
3604 ;; Compute date-end. It can be provided directly in time-stamp,
3605 ;; or extracted from time range. Otherwise, it defaults to the
3606 ;; same values as date-start.
3616 :raw-value raw-value
3617 :year-start year-start
3618 :month-start month-start
3619 :day-start day-start
3620 :hour-start hour-start
3621 :minute-start minute-start
3622 :year-end year-end
3623 :month-end month-end
3624 :day-end day-end
3625 :hour-end hour-end
3626 :minute-end minute-end
3627 :begin begin
3628 :end end
3630 repeater-props
3631 warning-props)))))
3634 "Interpret TIMESTAMP object as Org syntax.
3635 CONTENTS is nil."
3654 ;; Build an Org timestamp string from TIME. ACTIVEP is
3655 ;; non-nil when time stamp is active. If WITH-TIME-P is
3656 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3657 ;; specify a time range in the timestamp. REPEAT-STRING is
3658 ;; the repeater string, if any.
3662 org-time-stamp-formats)
3663 time)))
3669 nil nil ts)))
3674 " "
3675 s
3677 ;; Return value.
3678 ts)))
3690 build-ts-string
3709 0
3717 "--"
3729 "Search for the next timestamp object.
3731 Return value is a cons cell whose CAR is `timestamp' and CDR is
3732 beginning position."
3740 nil t)
3744 ;;;; Underline
3747 "Parse underline object at point.
3749 Return a list whose CAR is `underline' and CDR is a plist with
3750 `:begin', `:end', `:contents-begin' and `:contents-end' and
3751 `:post-blank' keywords.
3753 Assume point is at the first underscore marker."
3765 :end end
3766 :contents-begin contents-begin
3767 :contents-end contents-end
3771 "Interpret UNDERLINE object as Org syntax.
3772 CONTENTS is the contents of the object."
3776 ;;;; Verbatim
3779 "Parse verbatim object at point.
3781 Return a list whose CAR is `verbatim' and CDR is a plist with
3782 `:value', `:begin', `:end' and `:post-blank' keywords.
3784 Assume point is at the first equal sign marker."
3795 :begin begin
3796 :end end
3800 "Interpret VERBATIM object as Org syntax.
3801 CONTENTS is nil."
3805 \f
3806 ;;; Parsing Element Starting At Point
3807 ;;
3808 ;; `org-element--current-element' is the core function of this section.
3809 ;; It returns the Lisp representation of the element starting at
3810 ;; point.
3811 ;;
3812 ;; `org-element--current-element' makes use of special modes. They
3813 ;; are activated for fixed element chaining (i.e. `plain-list' >
3814 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3815 ;; `section'). Special modes are: `first-section', `item',
3816 ;; `node-property', `quote-section', `section' and `table-row'.
3820 "Parse the element starting at point.
3822 Return value is a list like (TYPE PROPS) where TYPE is the type
3823 of the element and PROPS a plist of properties associated to the
3824 element.
3826 Possible types are defined in `org-element-all-elements'.
3828 LIMIT bounds the search.
3830 Optional argument GRANULARITY determines the depth of the
3831 recursion. Allowed values are `headline', `greater-element',
3832 `element', `object' or nil. When it is broader than `object' (or
3833 nil), secondary values will not be parsed, since they only
3834 contain objects.
3836 Optional argument SPECIAL, when non-nil, can be either
3837 `first-section', `item', `node-property', `quote-section',
3838 `section', and `table-row'.
3840 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3841 be computed.
3843 This function assumes point is always at the beginning of the
3844 element it has to parse."
3847 ;; Determine if parsing depth allows for secondary strings
3848 ;; parsing. It only applies to elements referenced in
3849 ;; `org-element-secondary-value-alist'.
3852 ;; Item.
3855 ;; Table Row.
3857 ;; Node Property.
3859 ;; Headline.
3862 ;; Sections (must be checked after headline).
3868 limit)))
3869 ;; When not at bol, point is at the beginning of an item or
3870 ;; a footnote definition: next item is always a paragraph.
3872 ;; Planning and Clock.
3877 ;; Inlinetask.
3880 ;; From there, elements can have affiliated keywords.
3883 ;; Jumping over affiliated keywords put point off-limits.
3884 ;; Parse them as regular keywords.
3888 ;; LaTeX Environment.
3892 ;; Drawer and Property Drawer.
3897 ;; Fixed Width
3900 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3901 ;; Keywords.
3910 org-element-block-name-alist)))
3925 ;; Footnote Definition.
3928 ;; Horizontal Rule.
3931 ;; Diary Sexp.
3934 ;; Table.
3936 ;; List.
3939 limit affiliated
3941 ;; Default element: Paragraph.
3945 ;; Most elements can have affiliated keywords. When looking for an
3946 ;; element beginning, we want to move before them, as they belong to
3947 ;; that element, and, in the meantime, collect information they give
3948 ;; into appropriate properties. Hence the following function.
3951 "Collect affiliated keywords from point down to LIMIT.
3953 Return a list whose CAR is the position at the first of them and
3954 CDR a plist of keywords and values and move point to the
3955 beginning of the first line after them.
3957 As a special case, if element doesn't start at the beginning of
3958 the line (i.e. a paragraph starting an item), CAR is current
3959 position of point and CDR is nil."
3963 ;; RESTRICT is the list of objects allowed in parsed
3964 ;; keywords value.
3966 output)
3969 ;; Apply translation to RAW-KWD. From there, KWD is
3970 ;; the official keyword.
3972 org-element-keyword-translation-alist))
3973 raw-kwd))
3974 ;; Find main value for any keyword.
3980 ;; PARSEDP is non-nil when keyword should have its
3981 ;; value parsed.
3983 ;; If KWD is a dual keyword, find its secondary
3984 ;; value. Maybe parse it.
3991 ;; Attribute a property name to KWD.
3993 ;; Now set final shape for VALUE.
3999 ;; Attributes can always appear on multiple lines.
4002 ;; Eventually store the new value in OUTPUT.
4004 ;; Move to next keyword.
4006 ;; If affiliated keywords are orphaned: move back to first one.
4007 ;; They will be parsed as a paragraph.
4009 ;; Return value.
4013 \f
4014 ;;; The Org Parser
4015 ;;
4016 ;; The two major functions here are `org-element-parse-buffer', which
4017 ;; parses Org syntax inside the current buffer, taking into account
4018 ;; region, narrowing, or even visibility if specified, and
4019 ;; `org-element-parse-secondary-string', which parses objects within
4020 ;; a given string.
4021 ;;
4022 ;; The (almost) almighty `org-element-map' allows to apply a function
4023 ;; on elements or objects matching some type, and accumulate the
4024 ;; resulting values. In an export situation, it also skips unneeded
4025 ;; parts of the parse tree.
4028 "Recursively parse the buffer and return structure.
4029 If narrowing is in effect, only parse the visible part of the
4030 buffer.
4032 Optional argument GRANULARITY determines the depth of the
4033 recursion. It can be set to the following symbols:
4035 `headline' Only parse headlines.
4036 `greater-element' Don't recurse into greater elements excepted
4037 headlines and sections. Thus, elements
4038 parsed are the top-level ones.
4039 `element' Parse everything but objects and plain text.
4040 `object' Parse the complete buffer (default).
4042 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4043 elements.
4045 An element or an objects is represented as a list with the
4046 pattern (TYPE PROPERTIES CONTENTS), where :
4048 TYPE is a symbol describing the element or object. See
4049 `org-element-all-elements' and `org-element-all-objects' for an
4050 exhaustive list of such symbols. One can retrieve it with
4051 `org-element-type' function.
4053 PROPERTIES is the list of attributes attached to the element or
4054 object, as a plist. Although most of them are specific to the
4055 element or object type, all types share `:begin', `:end',
4056 `:post-blank' and `:parent' properties, which respectively
4057 refer to buffer position where the element or object starts,
4058 ends, the number of white spaces or blank lines after it, and
4059 the element or object containing it. Properties values can be
4060 obtained by using `org-element-property' function.
4062 CONTENTS is a list of elements, objects or raw strings
4063 contained in the current element or object, when applicable.
4064 One can access them with `org-element-contents' function.
4066 The Org buffer has `org-data' as type and nil as properties.
4067 `org-element-map' function can be used to find specific elements
4068 or objects within the parse tree.
4070 This function assumes that current major mode is `org-mode'."
4076 ;; Start in `first-section' mode so text before the first
4077 ;; headline belongs to a section.
4081 "Recursively parse objects in STRING and return structure.
4083 RESTRICTION is a symbol limiting the object types that will be
4084 looked after.
4086 Optional argument PARENT, when non-nil, is the element or object
4087 containing the secondary string. It is used to set correctly
4088 `:parent' property within the string."
4089 ;; Copy buffer-local variables listed in
4090 ;; `org-element-object-variables' into temporary buffer. This is
4091 ;; required since object parsing is dependent on these variables.
4095 org-element-object-variables))))
4103 secondary))
4104 secondary))))
4108 "Map a function on selected elements or objects.
4110 DATA is a parse tree, an element, an object, a string, or a list
4111 of such constructs. TYPES is a symbol or list of symbols of
4112 elements or objects types (see `org-element-all-elements' and
4113 `org-element-all-objects' for a complete list of types). FUN is
4114 the function called on the matching element or object. It has to
4115 accept one argument: the element or object itself.
4117 When optional argument INFO is non-nil, it should be a plist
4118 holding export options. In that case, parts of the parse tree
4119 not exportable according to that property list will be skipped.
4121 When optional argument FIRST-MATCH is non-nil, stop at the first
4122 match for which FUN doesn't return nil, and return that value.
4124 Optional argument NO-RECURSION is a symbol or a list of symbols
4125 representing elements or objects types. `org-element-map' won't
4126 enter any recursive element or object whose type belongs to that
4127 list. Though, FUN can still be applied on them.
4129 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4130 apply to matching objects within parsed affiliated keywords (see
4131 `org-element-parsed-keywords').
4133 Nil values returned from FUN do not appear in the results.
4136 Examples:
4137 ---------
4139 Assuming TREE is a variable containing an Org buffer parse tree,
4140 the following example will return a flat list of all `src-block'
4141 and `example-block' elements in it:
4143 \(org-element-map tree '(example-block src-block) 'identity)
4145 The following snippet will find the first headline with a level
4148 \(org-element-map tree 'headline
4149 \(lambda (hl)
4150 \(and (= (org-element-property :level hl) 1)
4152 \(org-element-property :begin hl)))
4153 nil t)
4155 The next example will return a flat list of all `plain-list' type
4156 elements in TREE that are not a sub-list themselves:
4158 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4160 Eventually, this example will return a flat list of all `bold'
4161 type objects containing a `latex-snippet' type object, even
4162 looking into captions:
4164 \(org-element-map tree 'bold
4165 \(lambda (b)
4166 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4167 nil nil nil t)"
4168 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4171 ;; Recursion depth is determined by --CATEGORY.
4178 ;; If one object is found, the function
4179 ;; has to recurse into every object.
4182 ;; If one regular element is found, the
4183 ;; function has to recurse, at least,
4184 ;; into every element it encounters.
4187 types)
4188 category)))
4189 ;; Compute properties for affiliated keywords if necessary.
4194 org-element-affiliated-keywords)))
4195 --acc
4196 --walk-tree
4200 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4201 ;; holding contextual information.
4205 ;; Ignored element in an export context.
4207 ;; List of elements or objects.
4209 ;; Unconditionally enter parse trees.
4213 ;; Check if TYPE is matching among TYPES. If so,
4214 ;; apply FUN to --DATA and accumulate return value
4215 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4221 ;; If --DATA has a secondary string that can contain
4222 ;; objects with their type among TYPES, look into it.
4229 ;; If --DATA has any affiliated keywords and
4230 ;; WITH-AFFILIATED is non-nil, look for objects in
4231 ;; them.
4239 ;; Pay attention to the type of value.
4240 ;; Preserve order for multiple keywords.
4256 --affiliated-alist))
4257 ;; Determine if a recursion into --DATA is possible.
4259 ;; --TYPE is explicitly removed from recursion.
4261 ;; --DATA has no contents.
4263 ;; Looking for greater elements but --DATA is simply
4264 ;; an element or an object.
4267 ;; Looking for elements but --DATA is an object.
4270 ;; In any other case, map contents.
4274 ;; Return value in a proper order.
4278 ;; The following functions are internal parts of the parser.
4279 ;;
4280 ;; The first one, `org-element--parse-elements' acts at the element's
4281 ;; level.
4282 ;;
4283 ;; The second one, `org-element--parse-objects' applies on all objects
4284 ;; of a paragraph or a secondary string. It uses
4285 ;; `org-element--get-next-object-candidates' to optimize the search of
4286 ;; the next object in the buffer.
4287 ;;
4288 ;; More precisely, that function looks for every allowed object type
4289 ;; first. Then, it discards failed searches, keeps further matches,
4290 ;; and searches again types matched behind point, for subsequent
4291 ;; calls. Thus, searching for a given type fails only once, and every
4292 ;; object is searched only once at top level (but sometimes more for
4293 ;; nested types).
4297 "Parse elements between BEG and END positions.
4299 SPECIAL prioritize some elements over the others. It can be set
4300 to `first-section', `quote-section', `section' `item' or
4301 `table-row'.
4303 When value is `item', STRUCTURE will be used as the current list
4304 structure.
4306 GRANULARITY determines the depth of the recursion. See
4307 `org-element-parse-buffer' for more information.
4309 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4310 elements.
4312 Elements are accumulated into ACC."
4315 ;; Visible only: skip invisible parts at the beginning of the
4316 ;; element.
4319 ;; When parsing only headlines, skip any text before first one.
4322 ;; Main loop start.
4324 ;; Find current element's type and parse it accordingly to
4325 ;; its category.
4327 end granularity special structure))
4331 ;; Visible only: skip invisible parts between siblings.
4334 ;; Fill ELEMENT contents by side-effect.
4336 ;; If element has no contents, don't modify it.
4338 ;; Greater element: parse it between `contents-begin' and
4339 ;; `contents-end'. Make sure GRANULARITY allows the
4340 ;; recursion, or ELEMENT is a headline, in which case going
4341 ;; inside is mandatory, in order to get sub-level headings.
4349 ;; Possibly switch to a special mode.
4359 granularity visible-only element))
4360 ;; ELEMENT has contents. Parse objects inside, if
4361 ;; GRANULARITY allows it.
4367 ;; Return result.
4368 acc))
4371 "Parse objects between BEG and END and return recursive structure.
4373 Objects are accumulated in ACC.
4375 RESTRICTION is a list of object successors which are allowed in
4376 the current object."
4385 restriction candidates)))
4392 ;; 1. Text before any object. Untabify it.
4397 acc
4401 ;; 2. Object...
4404 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4405 ;; a recursive type.
4413 ;; 3. Text after last object. Untabify it.
4417 acc
4421 ;; Result.
4422 acc))))
4425 "Return an alist of candidates for the next object.
4427 RESTRICTION is a list of object types, as symbols. Only
4428 candidates with such types are looked after.
4430 OBJECTS is the previous candidates alist. If it is set to
4431 `initial', no search has been done before, and all symbols in
4432 RESTRICTION should be looked after.
4434 Return value is an alist whose CAR is the object type and CDR its
4435 beginning position."
4437 nil
4439 ;; When searching for the first time, look for every successor
4440 ;; allowed in RESTRICTION.
4444 restriction)
4445 ;; Focus on objects returned during last search. Keep those
4446 ;; still after point. Search again objects before it.
4452 type)))
4455 objects))))
4458 \f
4459 ;;; Towards A Bijective Process
4460 ;;
4461 ;; The parse tree obtained with `org-element-parse-buffer' is really
4462 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4463 ;; interpreted and expanded into a string with canonical Org syntax.
4464 ;; Hence `org-element-interpret-data'.
4465 ;;
4466 ;; The function relies internally on
4467 ;; `org-element--interpret-affiliated-keywords'.
4469 ;;;###autoload
4471 "Interpret DATA as Org syntax.
4473 DATA is a parse tree, an element, an object or a secondary string
4474 to interpret.
4476 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4477 new types that should be treated as objects. An unknown type not
4478 belonging to this list is seen as a pseudo-element instead. Both
4479 pseudo-objects and pseudo-elements are transparent entities, i.e.
4480 only their contents are interpreted.
4482 Return Org syntax as a string."
4486 "Interpret DATA as Org syntax.
4488 DATA is a parse tree, an element, an object or a secondary string
4489 to interpret. PARENT is used for recursive calls. It contains
4490 the element or object containing data, or nil. PSEUDO-OBJECTS
4491 are list of symbols defining new element or object types.
4492 Unknown types that don't belong to this list are treated as
4493 pseudo-elements instead.
4495 Return Org syntax as a string."
4497 ;; Find interpreter for current object or element. If it
4498 ;; doesn't exist (e.g. this is a pseudo object or element),
4499 ;; return contents, if any.
4505 ;; Secondary string.
4511 ;; Full Org document.
4517 ;; Plain text: remove `:parent' text property from output.
4519 ;; Element or object without contents.
4521 ;; Element or object with contents.
4524 ;; Recursively interpret contents.
4530 data
4531 ;; Fix indentation of elements containing
4532 ;; objects. We ignore `table-row' elements
4533 ;; as they are one line long anyway.
4535 data
4536 ;; When normalizing first paragraph of an
4537 ;; item or a footnote-definition, ignore
4538 ;; first line's indentation.
4545 ;; Build white spaces. If no `:post-blank' property is
4546 ;; specified, assume its value is 0.
4557 "Return ELEMENT's affiliated keywords as Org syntax.
4558 If there is no affiliated keyword, return the empty string."
4568 ": "
4571 value)
4579 ;; All attribute keywords can have multiple lines.
4585 ;; List all ELEMENT's properties matching an attribute line or an
4586 ;; affiliated keyword, but ignore translated keywords since they
4587 ;; cannot belong to the property list.
4594 org-element-keyword-translation-alist)))))
4595 collect prop)
4598 ;; Because interpretation of the parse tree must return the same
4599 ;; number of blank lines between elements and the same number of white
4600 ;; space after objects, some special care must be given to white
4601 ;; spaces.
4602 ;;
4603 ;; The first function, `org-element-normalize-string', ensures any
4604 ;; string different from the empty string will end with a single
4605 ;; newline character.
4606 ;;
4607 ;; The second function, `org-element-normalize-contents', removes
4608 ;; global indentation from the contents of the current element.
4611 "Ensure string S ends with a single newline character.
4613 If S isn't a string return it unchanged. If S is the empty
4614 string, return it. Otherwise, return a new string with a single
4615 newline character at its end."
4623 "Normalize plain text in ELEMENT's contents.
4625 ELEMENT must only contain plain text and objects.
4627 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4628 indentation to compute maximal common indentation.
4630 Return the normalized element that is element with global
4631 indentation removed from its contents. The function assumes that
4632 indentation is not done with TAB characters."
4634 collect-inds ; for byte-compiler
4637 ;; Return list of indentations within BLOB. This is done by
4638 ;; walking recursively BLOB and updating IND-LIST along the
4639 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4640 ;; been seen yet. It is required as this string is the only
4641 ;; one whose indentation doesn't happen after a newline
4642 ;; character.
4650 ;; An indentation of zero means no string will be
4651 ;; modified. Quit the process.
4657 ;; Avoid matching blank or empty lines.
4665 ;; Collect indentation list in ELEMENT. Possibly remove first
4666 ;; value if IGNORE-FIRST is non-nil.
4669 ;; Build ELEMENT back, replacing each string with the same
4670 ;; string minus common indentation.
4675 ;; Return BLOB with all its strings indentation
4676 ;; shortened from MCI white spaces. FIRST-FLAG is
4677 ;; non-nil when the first string hasn't been seen
4678 ;; yet.
4692 org-element-recursive-objects)
4696 blob))))
4700 \f
4701 ;;; The Toolbox
4702 ;;
4703 ;; The first move is to implement a way to obtain the smallest element
4704 ;; containing point. This is the job of `org-element-at-point'. It
4705 ;; basically jumps back to the beginning of section containing point
4706 ;; and proceed, one element after the other, with
4707 ;; `org-element--current-element' until the container is found. Note:
4708 ;; When using `org-element-at-point', secondary values are never
4709 ;; parsed since the function focuses on elements, not on objects.
4710 ;;
4711 ;; At a deeper level, `org-element-context' lists all elements and
4712 ;; objects containing point.
4713 ;;
4714 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4715 ;; internally by navigation and manipulation tools.
4718 ;;;###autoload
4720 "Determine closest element around point.
4722 Return value is a list like (TYPE PROPS) where TYPE is the type
4723 of the element and PROPS a plist of properties associated to the
4724 element.
4726 Possible types are defined in `org-element-all-elements'.
4727 Properties depend on element or object type, but always include
4728 `:begin', `:end', `:parent' and `:post-blank' properties.
4730 As a special case, if point is at the very beginning of the first
4731 item in a list or sub-list, returned element will be that list
4732 instead of the item. Likewise, if point is at the beginning of
4733 the first row of a table, returned element will be the table
4734 instead of the first row.
4736 When point is at the end of the buffer, return the innermost
4737 element ending there."
4744 ;; Within blank lines at the beginning of buffer, return nil.
4746 ;; Within blank lines right after a headline, return that
4747 ;; headline.
4751 ;; Otherwise use cache in order to approximate current element.
4756 ;; Nothing in cache before point: start parsing from first
4757 ;; element following headline above, or first element in
4758 ;; buffer.
4764 ;; Cache returned exact match: return it.
4766 ;; There's a headline between cached value and ORIGIN:
4767 ;; cached value is invalid. Start parsing from first
4768 ;; element following the headline.
4774 ;; Check if CACHED or any of its ancestors contain point.
4775 ;;
4776 ;; If there is such an element, we inspect it in order to
4777 ;; know if we return it or if we need to parse its contents.
4778 ;; Otherwise, we just start parsing from current location,
4779 ;; which is right after the top-most element containing
4780 ;; CACHED.
4781 ;;
4782 ;; As a special case, if ORIGIN is at the end of the buffer,
4783 ;; we want to return the innermost element ending there.
4784 ;;
4785 ;; Also, if we find an ancestor and discover that we need to
4786 ;; parse its contents, make sure we don't start from
4787 ;; `:contents-begin', as we would otherwise go past CACHED
4788 ;; again. Instead, in that situation, we will resume
4789 ;; parsing from NEXT, which is located after CACHED or its
4790 ;; higher ancestor not containing point.
4794 begin))
4803 ;; Parse successively each element until we reach ORIGIN.
4809 parent special-flag)
4813 end 'element special-flag
4820 ;; Special case: ORIGIN is at the end of the buffer and
4821 ;; CACHED ends here. No element can start after it, but
4822 ;; more than one may end there. Arbitrarily, we choose
4823 ;; to return the innermost of such elements.
4836 parent element
4837 end cend))))
4838 ;; Skip any element ending before point. Also skip
4839 ;; element ending at point since we're sure that another
4840 ;; element begins after it.
4842 ;; A non-greater element contains point: return it.
4845 ;; Otherwise, we have to decide if ELEMENT really
4846 ;; contains ORIGIN. In that case we start parsing from
4847 ;; contents' beginning. Otherwise we return UP as it is
4848 ;; the smallest element containing ORIGIN.
4849 ;;
4850 ;; There is a special cases to consider, though. If
4851 ;; ORIGIN is at contents' beginning but it is also at
4852 ;; the beginning of the first item in a list or a table.
4853 ;; In that case, we need to create an anchor for that
4854 ;; list or table, so return it.
4866 parent element
4867 end cend))))))
4868 ;; Continue parsing buffer contents from new position.
4871 ;;;###autoload
4873 "Return closest element or object around point.
4875 Return value is a list like (TYPE PROPS) where TYPE is the type
4876 of the element or object and PROPS a plist of properties
4877 associated to it.
4879 Possible types are defined in `org-element-all-elements' and
4880 `org-element-all-objects'. Properties depend on element or
4881 object type, but always include `:begin', `:end', `:parent' and
4882 `:post-blank'.
4884 Optional argument ELEMENT, when non-nil, is the closest element
4885 containing point, as returned by `org-element-at-point'.
4886 Providing it allows for quicker computation."
4892 ;; If point is inside an element containing objects or
4893 ;; a secondary string, narrow buffer to the container and
4894 ;; proceed with parsing. Otherwise, return ELEMENT.
4896 ;; At a parsed affiliated keyword, check if we're inside main
4897 ;; or dual value.
4904 org-element-parsed-keywords))
4913 ;; Also change type to retrieve correct restrictions.
4915 ;; At an item, objects can only be located within tag, if any.
4925 ;; At an headline or inlinetask, objects are in title.
4932 ;; At a paragraph, a table-row or a verse block, objects are
4933 ;; located within their contents.
4937 ;; CBEG is nil for table rules.
4941 ;; At a parsed keyword, objects are located within value.
4944 org-element-document-properties))
4951 ;; All other locations cannot contain objects: bail out.
4958 objects-data next update-cache-flag)
4962 ;; Get list of next object candidates in CANDIDATES.
4963 ;; When entering for the first time PARENT, grab it
4964 ;; from cache, if available, or compute it. Then,
4965 ;; for each subsequent iteration in PARENT, always
4966 ;; compute it since we're beyond cache anyway.
4971 cache))))
4975 restriction candidates))
4977 ;; Compare ORIGIN with next object starting position,
4978 ;; if any.
4979 ;;
4980 ;; If ORIGIN is lesser or if there is no object
4981 ;; following, look for a previous object that might
4982 ;; contain it in cache. If there is no cache, we
4983 ;; didn't miss any object so simply return PARENT.
4984 ;;
4985 ;; If ORIGIN is greater or equal, parse next
4986 ;; candidate for further processing.
4990 candidates))))
4996 ;; Object ends before ORIGIN and we
4997 ;; know next one in cache starts
4998 ;; after it: bail out.
5006 ;; Process NEXT to know if we need to skip it, return
5007 ;; it or move into it.
5012 ;; ORIGIN is after NEXT, so skip it.
5014 ;; ORIGIN is within a non-recursive next or
5015 ;; at an object boundaries: Return that object.
5019 ;; Otherwise, move into NEXT and reset flags as we
5020 ;; shift parent.
5026 next nil
5027 objects-data nil
5029 ;; Store results in cache, if applicable.
5033 "Non-nil when elements ELEM-A and ELEM-B are nested."
5042 "Swap elements ELEM-A and ELEM-B.
5043 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5044 end of ELEM-A."
5046 ;; There are two special cases when an element doesn't start at bol:
5047 ;; the first paragraph in an item or in a footnote definition.
5049 ;; Only a paragraph without any affiliated keyword can be moved at
5050 ;; ELEM-A position in such a situation. Note that the case of
5051 ;; a footnote definition is impossible: it cannot contain two
5052 ;; paragraphs in a row because it cannot contain a blank line.
5058 ;; In a special situation, ELEM-A will have no indentation. We'll
5059 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5073 ;; Store overlays responsible for visibility status. We
5074 ;; also need to store their boundaries as they will be
5075 ;; removed from buffer.
5082 ;; Get contents.
5090 ;; Restore ex ELEM-A overlays.
5099 ;; Restore ex ELEM-B overlays.
5107 "Remove maximum common indentation in string S and return it.
5108 When optional argument N is a positive integer, remove exactly
5109 that much characters from indentation, if possible, or return
5110 S as-is otherwise. Unlike to `org-remove-indentation', this
5111 function doesn't call `untabify' on S."
5116 ;; Find maximum common indentation, if not specified.
5124 min-ind)))
5126 ;; Remove exactly N indentation, but give up if not possible.
5136 \f
5137 ;;; Cache
5138 ;;
5139 ;; Both functions `org-element-at-point' and `org-element-context'
5140 ;; benefit from a simple caching mechanism.
5141 ;;
5142 ;; Three public functions are provided: `org-element-cache-put',
5143 ;; `org-element-cache-get' and `org-element-cache-reset'.
5144 ;;
5145 ;; Cache is enabled by default, but can be disabled globally with
5146 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time' and
5147 ;; `org-element-cache-merge-changes-threshold' can be tweaked to
5148 ;; control caching behaviour.
5152 "Non nil when Org parser should cache its results.
5156 "Number of characters triggering cache syncing.
5158 The cache mechanism only stores one buffer modification at any
5159 given time. When another change happens, it replaces it with
5160 a change containing both the stored modification and the current
5161 one. This is a trade-off, as merging them prevents another
5162 syncing, but every element between them is then lost.
5164 This variable determines the maximum size, in characters, we
5168 "Number of seconds of idle time wait before syncing buffer cache.
5169 Syncing also happens when current modification is too distant
5170 from the stored one (for more information, see
5174 ;;;; Data Structure
5177 "AVL tree used to cache elements.
5178 Each node of the tree contains an element. Comparison is done
5179 with `org-element--cache-compare'. This cache is used in
5183 "Hash table used as to cache objects.
5184 Key is an element, as returned by `org-element-at-point', and
5185 value is an alist where each association is:
5187 \(POS CANDIDATES . OBJECTS)
5189 where POS is a buffer position, CANDIDATES is the last know list
5190 of successors (see `org-element--get-next-object-candidates') in
5191 container starting at POS and OBJECTS is a list of objects known
5192 to live within that container, from farthest to closest.
5195 at, respectively, positions 1, 7 and 8,
5199 If the paragraph is completely parsed, OBJECTS-DATA will be
5201 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
5202 \(8 nil ENTITY-OBJECT))
5204 whereas in a partially parsed paragraph, it could be
5206 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
5211 "Non-nil when element A is located before element B."
5215 ;; Items and plain lists on the one hand, table rows and
5216 ;; tables on the other hand can start at the same position.
5217 ;; In this case, the parent element is always before its child
5218 ;; in the buffer.
5224 ;;;; Staging Buffer Changes
5227 "Contains data about cache validity for current buffer.
5229 Value is a vector of seven elements,
5231 [ACTIVEP BEGIN END OFFSET TIMER PREVIOUS-STATE]
5233 ACTIVEP is a boolean non-nil when changes described in the other
5234 slots are valid for current buffer.
5236 BEGIN and END are the beginning and ending position of the area
5237 for which cache cannot be trusted.
5239 OFFSET it an integer specifying the number to add to position of
5240 elements after that area.
5242 TIMER is a timer used to apply these changes to cache when Emacs
5243 is idle.
5245 PREVIOUS-STATE is a symbol referring to the state of the buffer
5246 before a change happens. It is used to know if sensitive
5247 areas (block boundaries, headlines) were modified. It can be set
5256 "Regexp matching an element opening line.
5257 When such a line is modified, modifications may propagate after
5258 modified area. In that situation, every element between that
5267 "Regexp matching an element closing line.
5268 When such a line is modified, modifications may propagate before
5269 modified area. In that situation, every element between that
5273 "Non-nil when changes are not integrated in cache yet."
5278 "Push change to current buffer staging area.
5279 BEG and END and the beginning and ending position of the
5280 modification area. OFFSET is the size of the change, as an
5281 integer."
5289 nil
5290 #'org-element--cache-sync
5295 "Remove any cache change set for current buffer."
5301 "Request extension of area going to be modified if needed.
5302 BEG and END are the beginning and end of the range of changed
5303 text. See `before-change-functions' for more information."
5311 ;; A sensitive line is a headline or a block (or drawer,
5312 ;; or latex-environment) boundary. Inserting one can
5313 ;; modify buffer drastically both above and below that
5314 ;; line, possibly making cache invalid. Therefore, we
5315 ;; need to pay special attention to changes happening to
5316 ;; them.
5320 org-element--cache-opening-line)))
5333 "Update buffer modifications for current buffer.
5335 BEG and END are the beginning and end of the range of changed
5336 text, and the length in bytes of the pre-change text replaced by
5337 that range. See `after-change-functions' for more information.
5339 If there are already pending changes, try to merge them into
5340 a bigger change record. If that's not possible, the function
5341 will first synchronize cache with previous change and store the
5342 new one."
5352 ;; Determine if modified area needs to be extended,
5353 ;; according to both previous and current state. We make
5354 ;; a special case for headline editing: if a headline is
5355 ;; modified but not removed, do not extend.
5360 org-element--cache-opening-line)))
5371 ;; Effectively extend modified area.
5374 ;; Headline above is inclusive.
5378 ;; Headline below is exclusive.
5380 ;; Store changes.
5383 ;; No pending changes. Store the new ones.
5390 ;; If we cannot merge two change sets (i.e. they
5391 ;; modify distinct buffer parts) first apply current
5392 ;; change set and store new one. This way, there is
5393 ;; never more than one pending change set, which
5394 ;; avoids handling costly merges.
5398 ;; Change sets can be merged. We can expand the area
5399 ;; that requires an update, and postpone the sync.
5408 ;;;; Synchronization
5411 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5413 Properties containing buffer positions are `:begin', `:end',
5414 `:contents-begin', `:contents-end' and `:structure'. When
5415 optional argument PROPS is a list of keywords, only shift
5416 properties provided in that list.
5418 Properties are modified by side-effect. Return ELEMENT."
5420 ;; Shift :structure property for the first plain list only: it is
5421 ;; the only one that really matters and it prevents from shifting
5422 ;; it more than once.
5434 element)
5437 "Synchronize cache with recent modification in BUFFER.
5438 Elements ending before modification area are kept in cache.
5439 Elements starting after modification area have their position
5440 shifted by the size of the modification. Every other element is
5441 removed from the cache."
5448 ;; END is the beginning position of the first element
5449 ;; in cache that isn't removed but needs to be
5450 ;; shifted. It will be updated during phase 1.
5452 ;; Phase 1.
5453 ;;
5454 ;; Delete, in ascending order, all elements starting after
5455 ;; BEG, but before END.
5456 ;;
5457 ;; BEG is the position of the first element in cache to
5458 ;; remove. It takes into consideration partially modified
5459 ;; elements (starting before changes but ending after
5460 ;; them). Though, it preserves greater elements that are
5461 ;; not affected when changes alter only their contents.
5462 ;;
5463 ;; END is updated when necessary to include elements
5464 ;; starting after modifications but included in an element
5465 ;; altered by modifications.
5466 ;;
5467 ;; At each iteration, we start again at tree root since
5468 ;; a deletion modifies structure of the balanced tree.
5479 drawer dynamic-block inlinetask
5480 property-drawer quote-block
5481 special-block))
5483 beg)
5485 end))
5486 ;; UP is a greater element that is
5487 ;; wrapped around the changes. We
5488 ;; only need to extend its ending
5489 ;; boundaries and those of all its
5490 ;; parents.
5501 ;; We're at top level element containing
5502 ;; ELEMENT: if it's altered by buffer
5503 ;; modifications, it is first element in
5504 ;; cache to be removed. Otherwise, that
5505 ;; first element is the following one.
5510 ;; DATA will contain the closest element from
5511 ;; BEG, always after it.
5523 node nil)))))
5525 ;; No DATA is found so there's no element left
5526 ;; after BEG. Bail out.
5528 ;; Element starts after END, it is the first
5529 ;; one that needn't be removed from cache.
5530 ;; Move to second phase.
5532 ;; Remove element. Extend END so that all
5533 ;; elements it may contain are also removed.
5538 ;; Phase 2.
5539 ;;
5540 ;; Shift all elements starting after END by OFFSET (for an
5541 ;; offset different from 0).
5542 ;;
5543 ;; Increasing all beginning positions by OFFSET doesn't
5544 ;; alter tree structure, so elements are modified by
5545 ;; side-effect.
5546 ;;
5547 ;; We change all elements in decreasing order and make
5548 ;; sure to quit at the first element in cache starting
5549 ;; before END.
5556 ;; Shift element.
5558 ;; Shift associated objects data, if any.
5566 object offset)))))
5568 ;; Eventually signal cache as up-to-date.
5572 ;;;; Public Functions
5575 "Return cached data relative to KEY.
5577 KEY is either a number or an Org element, as returned by
5578 `org-element-at-point'. If KEY is a number, return closest
5579 cached data before or at position KEY. Otherwise, return cached
5580 objects contained in element KEY.
5582 In any case, return nil if no data is found, or if caching is not
5583 allowed.
5585 If changes are pending in current buffer, first synchronize the
5586 cache, unless optional argument IGNORE-CHANGES is non-nil."
5588 ;; If there are pending changes, first sync them.
5608 last)))))
5611 "Store DATA in current buffer's cache, if allowed.
5612 If optional argument ELEMENT is non-nil, store DATA as objects
5613 relative to it. Otherwise, store DATA as an element. Nothing
5614 will be stored if `org-element-use-cache' is nil. Return DATA."
5621 ;;;###autoload
5623 "Reset cache in current buffer.
5624 When optional argument ALL is non-nil, reset cache in all Org
5625 buffers. This function will do nothing if
5626 `org-element-use-cache' is nil."
5638 'org-element--cache-objects
5650 ;; Local variables:
5651 ;; generated-autoload-file: "org-loaddefs.el"
5652 ;; End:
5654 ;;; org-element.el ends here