| blob | 57e26ffb5cd630c634f6f0bf9060d0f3c44576e3 |
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:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; These variables really act as a control center for the parsing
132 ;; process.
136 ;; Headlines, inlinetasks.
138 ;; Footnote definitions.
140 ;; Diary sexps.
143 ;; Empty lines.
145 ;; Tables (any type).
147 ;; Blocks (any type), Babel calls, drawers (any type),
148 ;; fixed-width areas and keywords. Note: this is only an
149 ;; indication and need some thorough check.
151 ;; Horizontal rules.
153 ;; LaTeX environments.
155 ;; Planning and Clock lines.
157 org-deadline-string
158 org-closed-string
159 org-clock-string))
161 ;; Lists.
168 "Regexp to separate paragraphs in an Org buffer.
170 is not sufficient to know if point is at a paragraph ending. See
175 dynamic-block example-block export-block fixed-width
176 footnote-definition headline horizontal-rule inlinetask item
177 keyword latex-environment node-property paragraph plain-list
178 planning property-drawer quote-block quote-section section
179 special-block src-block table table-row verse-block)
184 item plain-list property-drawer quote-block section
185 special-block table)
190 latex-or-entity line-break link macro plain-link radio-target
191 statistics-cookie sub/superscript table-cell target
192 text-markup timestamp)
201 "Alist of translations between object type and successor name.
202 Sharing the same successor comes handy when, for example, the
207 inline-src-block italic line-break latex-fragment link macro
208 radio-target statistics-cookie strike-through subscript superscript
209 table-cell target timestamp underline verbatim)
214 table-cell underline)
224 "Alist between block names and the associated parsing function.
225 Names must be uppercase. Any block whose name has no association
231 Only these types can accept search options and an explicit
237 "List of affiliated keywords as strings.
243 ;; Regular affiliated keywords.
246 "Regexp matching any affiliated keyword.
248 Keyword name is put in match group 1. Moreover, if keyword
249 belongs to `org-element-dual-keywords', put the dual value in
250 match group 2.
258 "Alist of usual translations for keywords.
259 The key is the old name and the value the new one. The property
263 "List of affiliated keywords that can occur more than once in an element.
265 Their value will be consed into a list of strings, which will be
266 returned as the value of the property.
268 This list is checked after translations have been applied. See
269 `org-element-keyword-translation-alist'.
275 "List of affiliated keywords whose value can be parsed.
277 Their value will be stored as a secondary string: a list of
278 strings and objects.
280 This list is checked after translations have been applied. See
284 "List of affiliated keywords which can have a secondary value.
286 In Org syntax, they can be written with optional square brackets
287 before the colons. For example, RESULTS keyword can be
288 associated to a hash value with the following:
290 #+RESULTS[hash-string]: some-source
292 This list is checked after translations have been applied. See
296 "List of properties associated to the whole document.
297 Any keyword in this list will have its value parsed and stored as
311 ;; Ignore all links excepted plain links in a link description.
312 ;; Also ignore radio-targets and line breaks.
316 ;; Remove any variable object from radio target as it would
317 ;; prevent it from being properly recognized.
322 ;; Ignore inline babel call and inline src block as formulas are
323 ;; possible. Also ignore line breaks and statistics cookies.
329 "Alist of objects restrictions.
331 CAR is an element or object type containing objects and CDR is
332 a list of successors that will be called within an element or
333 object of such type.
335 For example, in a `radio-target' object, one can only find
336 entities, latex-fragments, subscript and superscript.
338 This alist also applies to secondary string. For example, an
339 `headline' type element doesn't directly contain objects, but
350 "List of buffer-local variables used when parsing objects.
351 These variables are copied to the temporary buffer created by
355 \f
356 ;;; Accessors and Setters
357 ;;
358 ;; Provide four accessors: `org-element-type', `org-element-property'
359 ;; `org-element-contents' and `org-element-restriction'.
360 ;;
361 ;; Setter functions allow to modify elements by side effect. There is
362 ;; `org-element-put-property', `org-element-set-contents',
363 ;; `org-element-set-element' and `org-element-adopt-element'. Note
364 ;; that `org-element-set-element' and `org-element-adopt-elements' are
365 ;; higher level functions since also update `:parent' property.
368 "Return type of ELEMENT.
370 The function returns the type of the element or object provided.
371 It can also return the following special value:
372 `plain-text' for a string
373 `org-data' for a complete document
374 nil in any other case."
380 "Extract the value from the PROPERTY of an ELEMENT."
385 "Extract contents from an ELEMENT."
391 "Return restriction associated to ELEMENT.
392 ELEMENT can be an element, an object or a symbol representing an
393 element or object type."
395 org-element-object-restrictions)))
398 "In ELEMENT set PROPERTY to VALUE.
399 Return modified element."
402 element))
405 "Set ELEMENT contents to CONTENTS.
406 Return modified element."
413 "Replace element or object OLD with element or object NEW.
414 The function takes care of setting `:parent' property for NEW."
415 ;; Since OLD is going to be changed into NEW by side-effect, first
416 ;; make sure that every element or object within NEW has OLD as
417 ;; parent.
420 ;; Transfer contents.
422 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
423 ;; with NEW's.
426 ;; Transfer type.
430 "Append elements to the contents of another element.
432 PARENT is an element or object. CHILDREN can be elements,
433 objects, or a strings.
435 The function takes care of setting `:parent' property for CHILD.
436 Return parent element."
437 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
438 ;; string: parent is the list itself.
441 children)
442 ;; Add CHILDREN at the end of PARENT contents.
445 parent
447 ;; Return modified PARENT element.
451 \f
452 ;;; Greater elements
453 ;;
454 ;; For each greater element type, we define a parser and an
455 ;; interpreter.
456 ;;
457 ;; A parser returns the element or object as the list described above.
458 ;; Most of them accepts no argument. Though, exceptions exist. Hence
459 ;; every element containing a secondary string (see
460 ;; `org-element-secondary-value-alist') will accept an optional
461 ;; argument to toggle parsing of that secondary string. Moreover,
462 ;; `item' parser requires current list's structure as its first
463 ;; element.
464 ;;
465 ;; An interpreter accepts two arguments: the list representation of
466 ;; the element or object, and its contents. The latter may be nil,
467 ;; depending on the element or object considered. It returns the
468 ;; appropriate Org syntax, as a string.
469 ;;
470 ;; Parsing functions must follow the naming convention:
471 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
472 ;; defined in `org-element-greater-elements'.
473 ;;
474 ;; Similarly, interpreting functions must follow the naming
475 ;; convention: org-element-TYPE-interpreter.
476 ;;
477 ;; With the exception of `headline' and `item' types, greater elements
478 ;; cannot contain other greater elements of their own type.
479 ;;
480 ;; Beside implementing a parser and an interpreter, adding a new
481 ;; greater element requires to tweak `org-element--current-element'.
482 ;; Moreover, the newly defined type must be added to both
483 ;; `org-element-all-elements' and `org-element-greater-elements'.
486 ;;;; Center Block
489 "Parse a center block.
491 LIMIT bounds the search. AFFILIATED is a list of which CAR is
492 the buffer position at the beginning of the first affiliated
493 keyword and CDR is a plist of affiliated keywords along with
494 their value.
496 Return a list whose CAR is `center-block' and CDR is a plist
497 containing `:begin', `:end', `:contents-begin', `:contents-end',
498 `:post-blank' and `:post-affiliated' keywords.
500 Assume point is at the beginning of the block."
504 ;; Incomplete block: parse it as a paragraph.
509 ;; Empty blocks have no contents.
523 :end end
524 :contents-begin contents-begin
525 :contents-end contents-end
531 "Interpret CENTER-BLOCK element as Org syntax.
532 CONTENTS is the contents of the element."
536 ;;;; Drawer
539 "Parse a drawer.
541 LIMIT bounds the search. AFFILIATED is a list of which CAR is
542 the buffer position at the beginning of the first affiliated
543 keyword and CDR is a plist of affiliated keywords along with
544 their value.
546 Return a list whose CAR is `drawer' and CDR is a plist containing
547 `:drawer-name', `:begin', `:end', `:contents-begin',
548 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
550 Assume point is at beginning of drawer."
553 ;; Incomplete drawer: parse it as a paragraph.
561 ;; Empty drawers have no contents.
574 :end end
575 :drawer-name name
576 :contents-begin contents-begin
577 :contents-end contents-end
583 "Interpret DRAWER element as Org syntax.
584 CONTENTS is the contents of the element."
587 contents))
590 ;;;; Dynamic Block
593 "Parse a dynamic block.
595 LIMIT bounds the search. AFFILIATED is a list of which CAR is
596 the buffer position at the beginning of the first affiliated
597 keyword and CDR is a plist of affiliated keywords along with
598 their value.
600 Return a list whose CAR is `dynamic-block' and CDR is a plist
601 containing `:block-name', `:begin', `:end', `:contents-begin',
602 `:contents-end', `:arguments', `:post-blank' and
603 `:post-affiliated' keywords.
605 Assume point is at beginning of dynamic block."
609 ;; Incomplete block: parse it as a paragraph.
618 ;; Empty blocks have no contents.
631 :end end
632 :block-name name
633 :arguments arguments
634 :contents-begin contents-begin
635 :contents-end contents-end
641 "Interpret DYNAMIC-BLOCK element as Org syntax.
642 CONTENTS is the contents of the element."
647 contents))
650 ;;;; Footnote Definition
653 "Parse a footnote definition.
655 LIMIT bounds the search. AFFILIATED is a list of which CAR is
656 the buffer position at the beginning of the first affiliated
657 keyword and CDR is a plist of affiliated keywords along with
658 their value.
660 Return a list whose CAR is `footnote-definition' and CDR is
661 a plist containing `:label', `:begin' `:end', `:contents-begin',
662 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
664 Assume point is at the beginning of the footnote definition."
692 :begin begin
693 :end end
694 :contents-begin contents-begin
695 :contents-end contents-end
701 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
702 CONTENTS is the contents of the footnote-definition."
704 " "
705 contents))
708 ;;;; Headline
711 "Parse a headline.
713 Return a list whose CAR is `headline' and CDR is a plist
714 containing `:raw-value', `:title', `:alt-title', `:begin',
715 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
716 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
717 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
718 `:commentedp' and `:footnote-section-p' keywords.
720 The plist also contains any property set in the property drawer,
721 with its name in upper cases and colons added at the
722 beginning (i.e. `:CUSTOM_ID').
724 When RAW-SECONDARY-P is non-nil, headline's title will not be
725 parsed as a secondary string, but as a plain string instead.
727 Assume point is at beginning of the headline."
740 raw-value)))
744 raw-value)))
748 ;; Upcase property names. It avoids confusion between
749 ;; properties obtained through property drawer and default
750 ;; properties from the parser (e.g. `:end' and :END:)
760 plist))
762 ;; Read time properties on the line below the headline.
768 org-keyword-time-not-clock-regexp end t)
778 plist))))
790 ;; Clean RAW-VALUE from any quote or comment string.
798 ""
799 raw-value))))
800 ;; Clean TAGS from archive tag, if any.
806 :begin begin
807 :end end
808 :pre-blank
811 :contents-begin contents-begin
812 :contents-end contents-end
813 :level level
815 :tags tags
816 :todo-keyword todo
817 :todo-type todo-type
823 end)
824 :footnote-section-p footnote-section-p
825 :archivedp archivedp
826 :commentedp commentedp
828 time-props
829 standard-props))))
833 headline :alt-title
838 headline :title
844 "Interpret HEADLINE element as Org syntax.
845 CONTENTS is the contents of the element."
872 ;; Align tags.
880 ? )
881 tags))
885 tags))))
887 contents)))
890 ;;;; Inlinetask
893 "Parse an inline task.
895 Return a list whose CAR is `inlinetask' and CDR is a plist
896 containing `:title', `:begin', `:end', `:contents-begin' and
897 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
898 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
899 `:closed' and `:post-blank' keywords.
901 The plist also contains any property set in the property drawer,
902 with its name in upper cases and colons added at the
903 beginning (i.e. `:CUSTOM_ID').
905 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
906 title will not be parsed as a secondary string, but as a plain
907 string instead.
909 Assume point is at beginning of the inline task."
919 ;; Upcase property names. It avoids confusion between
920 ;; properties obtained through property drawer and default
921 ;; properties from the parser (e.g. `:end' and :END:)
931 plist))
933 ;; Read time properties on the line below the inlinetask
934 ;; opening string.
940 org-keyword-time-not-clock-regexp end t)
950 plist))))
968 :begin begin
969 :end end
970 :contents-begin contents-begin
971 :contents-end contents-end
974 :tags tags
975 :todo-keyword todo
976 :todo-type todo-type
978 time-props
979 standard-props))))
981 inlinetask :title
984 raw-value
986 inlinetask))))))
989 "Interpret INLINETASK element as Org syntax.
990 CONTENTS is the contents of inlinetask."
1005 ;; Align tags.
1013 ? )
1014 tags))
1018 tags))))
1019 ;; Prefer degenerate inlinetasks when there are no
1020 ;; contents.
1023 contents
1027 ;;;; Item
1030 "Parse an item.
1032 STRUCT is the structure of the plain list.
1034 Return a list whose CAR is `item' and CDR is a plist containing
1035 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1036 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1037 keywords.
1039 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1040 any, will not be parsed as a secondary string, but as a plain
1041 string instead.
1043 Assume point is at the beginning of the item."
1067 ;; Ignore tags in un-ordered lists: they are just
1068 ;; a part of item's body.
1074 ;; If first line isn't empty, contents really start
1075 ;; at the text after item's meta-data.
1084 :begin begin
1085 :end end
1086 ;; CONTENTS-BEGIN and CONTENTS-END may be
1087 ;; mixed up in the case of an empty item
1088 ;; separated from the next by a blank line.
1089 ;; Thus ensure the former is always the
1090 ;; smallest.
1093 :checkbox checkbox
1094 :counter counter
1095 :structure struct
1098 item :tag
1106 "Interpret ITEM element as Org syntax.
1107 CONTENTS is the contents of the element."
1117 ;; Compute indentation.
1122 ;; Indent contents.
1124 bullet
1138 ;;;; Plain List
1141 ;; Return structure of list at point. Internal function. See
1142 ;; `org-list-struct' for details.
1147 items struct)
1152 ;; At limit: end all items.
1161 ;; At list end: end all items.
1166 ;; At a new item: end previous sibling.
1178 ind
1179 bullet
1182 ;; Description tag.
1186 ;; Ending position, unknown so far.
1187 nil)))
1188 items))
1190 ;; Skip empty lines.
1192 ;; Skip inline tasks and blank lines along the way.
1199 ;; At some text line. Check if it ends any previous item.
1211 ;; Skip blocks (any type) and drawers contents.
1217 limit t)))
1223 "Parse a plain list.
1225 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1226 the buffer position at the beginning of the first affiliated
1227 keyword and CDR is a plist of affiliated keywords along with
1228 their value. STRUCTURE is the structure of the plain list being
1229 parsed.
1231 Return a list whose CAR is `plain-list' and CDR is a plist
1232 containing `:type', `:begin', `:end', `:contents-begin' and
1233 `:contents-end', `:structure', `:post-blank' and
1234 `:post-affiliated' keywords.
1236 Assume point is at the beginning of the list."
1250 pos))
1254 ;; Return value.
1258 :begin begin
1259 :end end
1260 :contents-begin contents-begin
1261 :contents-end contents-end
1262 :structure struct
1268 "Interpret PLAIN-LIST element as Org syntax.
1269 CONTENTS is the contents of the element."
1277 ;;;; Property Drawer
1280 "Parse a property drawer.
1282 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1283 the buffer position at the beginning of the first affiliated
1284 keyword and CDR is a plist of affiliated keywords along with
1285 their value.
1287 Return a list whose CAR is `property-drawer' and CDR is a plist
1288 containing `:begin', `:end', `:contents-begin', `:contents-end',
1289 `:post-blank' and `:post-affiliated' keywords.
1291 Assume point is at the beginning of the property drawer."
1296 ;; Incomplete drawer: parse it as a paragraph.
1314 :end end
1315 :contents-begin contents-begin
1316 :contents-end contents-end
1322 "Interpret PROPERTY-DRAWER element as Org syntax.
1323 CONTENTS is the properties within the drawer."
1327 ;;;; Quote Block
1330 "Parse a quote block.
1332 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1333 the buffer position at the beginning of the first affiliated
1334 keyword and CDR is a plist of affiliated keywords along with
1335 their value.
1337 Return a list whose CAR is `quote-block' and CDR is a plist
1338 containing `:begin', `:end', `:contents-begin', `:contents-end',
1339 `:post-blank' and `:post-affiliated' keywords.
1341 Assume point is at the beginning of the block."
1345 ;; Incomplete block: parse it as a paragraph.
1351 ;; Empty blocks have no contents.
1364 :end end
1365 :contents-begin contents-begin
1366 :contents-end contents-end
1372 "Interpret QUOTE-BLOCK element as Org syntax.
1373 CONTENTS is the contents of the element."
1377 ;;;; Section
1380 "Parse a section.
1382 LIMIT bounds the search.
1384 Return a list whose CAR is `section' and CDR is a plist
1385 containing `:begin', `:end', `:contents-begin', `contents-end'
1386 and `:post-blank' keywords."
1388 ;; Beginning of section is the beginning of the first non-blank
1389 ;; line after previous headline.
1398 :end end
1399 :contents-begin begin
1400 :contents-end pos-before-blank
1404 "Interpret SECTION element as Org syntax.
1405 CONTENTS is the contents of the element."
1406 contents)
1409 ;;;; Special Block
1412 "Parse a special block.
1414 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1415 the buffer position at the beginning of the first affiliated
1416 keyword and CDR is a plist of affiliated keywords along with
1417 their value.
1419 Return a list whose CAR is `special-block' and CDR is a plist
1420 containing `:type', `:begin', `:end', `:contents-begin',
1421 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1423 Assume point is at the beginning of the block."
1430 limit t)))
1431 ;; Incomplete block: parse it as a paragraph.
1437 ;; Empty blocks have no contents.
1450 :begin begin
1451 :end end
1452 :contents-begin contents-begin
1453 :contents-end contents-end
1459 "Interpret SPECIAL-BLOCK element as Org syntax.
1460 CONTENTS is the contents of the element."
1465 \f
1466 ;;; Elements
1467 ;;
1468 ;; For each element, a parser and an interpreter are also defined.
1469 ;; Both follow the same naming convention used for greater elements.
1470 ;;
1471 ;; Also, as for greater elements, adding a new element type is done
1472 ;; through the following steps: implement a parser and an interpreter,
1473 ;; tweak `org-element--current-element' so that it recognizes the new
1474 ;; type and add that new type to `org-element-all-elements'.
1475 ;;
1476 ;; As a special case, when the newly defined type is a block type,
1477 ;; `org-element-block-name-alist' has to be modified accordingly.
1480 ;;;; Babel Call
1483 "Parse a babel call.
1485 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1486 the buffer position at the beginning of the first affiliated
1487 keyword and CDR is a plist of affiliated keywords along with
1488 their value.
1490 Return a list whose CAR is `babel-call' and CDR is a plist
1491 containing `:begin', `:end', `:value', `:post-blank' and
1492 `:post-affiliated' as keywords."
1506 :end end
1507 :value value
1513 "Interpret BABEL-CALL element as Org syntax.
1514 CONTENTS is nil."
1518 ;;;; Clock
1521 "Parse a clock.
1523 LIMIT bounds the search.
1525 Return a list whose CAR is `clock' and CDR is a plist containing
1526 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1527 as keywords."
1547 :value value
1548 :duration duration
1549 :begin begin
1550 :end end
1554 "Interpret CLOCK element as Org syntax.
1555 CONTENTS is nil."
1563 "%2s:%02s"
1567 ;;;; Comment
1570 "Parse a comment.
1572 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1573 the buffer position at the beginning of the first affiliated
1574 keyword and CDR is a plist of affiliated keywords along with
1575 their value.
1577 Return a list whose CAR is `comment' and CDR is a plist
1578 containing `:begin', `:end', `:value', `:post-blank',
1579 `:post-affiliated' keywords.
1581 Assume point is at comment beginning."
1590 ;; Get comments ending.
1593 ;; Accumulate lines without leading hash and first
1594 ;; whitespace.
1608 :end end
1609 :value value
1615 "Interpret COMMENT element as Org syntax.
1616 CONTENTS is nil."
1620 ;;;; Comment Block
1623 "Parse an export block.
1625 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1626 the buffer position at the beginning of the first affiliated
1627 keyword and CDR is a plist of affiliated keywords along with
1628 their value.
1630 Return a list whose CAR is `comment-block' and CDR is a plist
1631 containing `:begin', `:end', `:value', `:post-blank' and
1632 `:post-affiliated' keywords.
1634 Assume point is at comment block beginning."
1638 ;; Incomplete block: parse it as a paragraph.
1651 contents-begin contents-end)))
1655 :end end
1656 :value value
1662 "Interpret COMMENT-BLOCK element as Org syntax.
1663 CONTENTS is nil."
1668 ;;;; Diary Sexp
1671 "Parse a diary sexp.
1673 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1674 the buffer position at the beginning of the first affiliated
1675 keyword and CDR is a plist of affiliated keywords along with
1676 their value.
1678 Return a list whose CAR is `diary-sexp' and CDR is a plist
1679 containing `:begin', `:end', `:value', `:post-blank' and
1680 `:post-affiliated' keywords."
1692 :begin begin
1693 :end end
1699 "Interpret DIARY-SEXP as Org syntax.
1700 CONTENTS is nil."
1704 ;;;; Example Block
1707 "Parse an example 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 `example-block' and CDR is a plist
1715 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1716 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1717 `:value', `:post-blank' and `:post-affiliated' keywords."
1721 ;; Incomplete block: parse it as a paragraph.
1729 ;; Switches analysis
1736 ;; Should labels be retained in (or stripped from) example
1737 ;; blocks?
1742 ;; What should code-references use - labels or
1743 ;; line-numbers?
1752 ;; Standard block parsing.
1760 contents-begin contents-end))
1761 block-ind))
1770 :end end
1771 :value value
1772 :switches switches
1773 :number-lines number-lines
1774 :preserve-indent preserve-indent
1775 :retain-labels retain-labels
1776 :use-labels use-labels
1777 :label-fmt label-fmt
1783 "Interpret EXAMPLE-BLOCK element as Org syntax.
1784 CONTENTS is nil."
1791 value
1796 ;;;; Export Block
1799 "Parse an export block.
1801 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1802 the buffer position at the beginning of the first affiliated
1803 keyword and CDR is a plist of affiliated keywords along with
1804 their value.
1806 Return a list whose CAR is `export-block' and CDR is a plist
1807 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1808 `:post-affiliated' keywords.
1810 Assume point is at export-block beginning."
1817 ;; Incomplete block: parse it as a paragraph.
1830 contents-end)))
1834 :end end
1835 :type type
1836 :value value
1842 "Interpret EXPORT-BLOCK element as Org syntax.
1843 CONTENTS is nil."
1850 ;;;; Fixed-width
1853 "Parse a fixed-width section.
1855 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1856 the buffer position at the beginning of the first affiliated
1857 keyword and CDR is a plist of affiliated keywords along with
1858 their value.
1860 Return a list whose CAR is `fixed-width' and CDR is a plist
1861 containing `:begin', `:end', `:value', `:post-blank' and
1862 `:post-affiliated' keywords.
1864 Assume point is at the beginning of the fixed-width area."
1868 value
1873 ;; Accumulate text without starting colons.
1886 :end end
1887 :value value
1893 "Interpret FIXED-WIDTH element as Org syntax.
1894 CONTENTS is nil."
1902 ;;;; Horizontal Rule
1905 "Parse an horizontal rule.
1907 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1908 the buffer position at the beginning of the first affiliated
1909 keyword and CDR is a plist of affiliated keywords along with
1910 their value.
1912 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1913 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1914 keywords."
1924 :end end
1930 "Interpret HORIZONTAL-RULE element as Org syntax.
1931 CONTENTS is nil."
1935 ;;;; Keyword
1938 "Parse a keyword at point.
1940 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1941 the buffer position at the beginning of the first affiliated
1942 keyword and CDR is a plist of affiliated keywords along with
1943 their value.
1945 Return a list whose CAR is `keyword' and CDR is a plist
1946 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1947 `:post-affiliated' keywords."
1961 :value value
1962 :begin begin
1963 :end end
1969 "Interpret KEYWORD element as Org syntax.
1970 CONTENTS is nil."
1976 ;;;; Latex Environment
1979 "Parse a LaTeX environment.
1981 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1982 the buffer position at the beginning of the first affiliated
1983 keyword and CDR is a plist of affiliated keywords along with
1984 their value.
1986 Return a list whose CAR is `latex-environment' and CDR is a plist
1987 containing `:begin', `:end', `:value', `:post-blank' and
1988 `:post-affiliated' keywords.
1990 Assume point is at the beginning of the latex environment."
1997 limit t))
1998 ;; Incomplete latex environment: parse it as a paragraph.
2008 :end end
2009 :value value
2015 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2016 CONTENTS is nil."
2020 ;;;; Node Property
2023 "Parse a node-property at point.
2025 LIMIT bounds the search.
2027 Return a list whose CAR is `node-property' and CDR is a plist
2028 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2029 keywords."
2041 :value value
2042 :begin begin
2043 :end end
2047 "Interpret NODE-PROPERTY element as Org syntax.
2048 CONTENTS is nil."
2054 ;;;; Paragraph
2057 "Parse a paragraph.
2059 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2060 the buffer position at the beginning of the first affiliated
2061 keyword and CDR is a plist of affiliated keywords along with
2062 their value.
2064 Return a list whose CAR is `paragraph' and CDR is a plist
2065 containing `:begin', `:end', `:contents-begin' and
2066 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2068 Assume point is at the beginning of the paragraph."
2077 limit
2078 ;; A matching `org-element-paragraph-separate' is not
2079 ;; necessarily the end of the paragraph. In
2080 ;; particular, lines starting with # or : as a first
2081 ;; non-space character are ambiguous. We have check
2082 ;; if they are valid Org syntax (i.e. not an
2083 ;; incomplete keyword).
2087 ;; There's no ambiguity for other symbols or
2088 ;; empty lines: stop here.
2090 ;; Stop at valid fixed-width areas.
2092 ;; Stop at drawers.
2097 ;; Stop at valid comments.
2099 ;; Stop at valid dynamic blocks.
2104 ;; Stop at valid blocks.
2111 limit t)))
2112 ;; Stop at valid latex environments.
2120 limit t)))
2121 ;; Stop at valid keywords.
2123 ;; Skip everything else.
2140 :end end
2141 :contents-begin contents-begin
2142 :contents-end contents-end
2148 "Interpret PARAGRAPH element as Org syntax.
2149 CONTENTS is the contents of the element."
2150 contents)
2153 ;;;; Planning
2156 "Parse a planning.
2158 LIMIT bounds the search.
2160 Return a list whose CAR is `planning' and CDR is a plist
2161 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2162 and `:post-blank' keywords."
2172 closed deadline scheduled)
2184 :deadline deadline
2185 :scheduled scheduled
2186 :begin begin
2187 :end end
2191 "Interpret PLANNING element as Org syntax.
2192 CONTENTS is nil."
2194 'identity
2211 ;;;; Quote Section
2214 "Parse a quote section.
2216 LIMIT bounds the search.
2218 Return a list whose CAR is `quote-section' and CDR is a plist
2219 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2221 Assume point is at beginning of the section."
2232 :end end
2233 :value value
2237 "Interpret QUOTE-SECTION element as Org syntax.
2238 CONTENTS is nil."
2242 ;;;; Src Block
2245 "Parse a src block.
2247 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2248 the buffer position at the beginning of the first affiliated
2249 keyword and CDR is a plist of affiliated keywords along with
2250 their value.
2252 Return a list whose CAR is `src-block' and CDR is a plist
2253 containing `:language', `:switches', `:parameters', `:begin',
2254 `:end', `:number-lines', `:retain-labels', `:use-labels',
2255 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2256 `:post-affiliated' keywords.
2258 Assume point is at the beginning of the block."
2261 limit t)))
2262 ;; Incomplete block: parse it as a paragraph.
2268 ;; Get language as a string.
2277 ;; Get switches.
2279 ;; Get parameters.
2281 ;; Switches analysis
2292 ;; Should labels be retained in (or stripped from)
2293 ;; src blocks?
2298 ;; What should code-references use - labels or
2299 ;; line-numbers?
2304 ;; Indentation.
2306 ;; Retrieve code.
2311 block-ind))
2315 ;; Get position after ending blank lines.
2325 :begin begin
2326 :end end
2327 :number-lines number-lines
2328 :preserve-indent preserve-indent
2329 :retain-labels retain-labels
2330 :use-labels use-labels
2331 :label-fmt label-fmt
2332 :value value
2338 "Interpret SRC-BLOCK element as Org syntax.
2339 CONTENTS is nil."
2348 val)
2362 ;;;; Table
2365 "Parse a table at point.
2367 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2368 the buffer position at the beginning of the first affiliated
2369 keyword and CDR is a plist of affiliated keywords along with
2370 their value.
2372 Return a list whose CAR is `table' and CDR is a plist containing
2373 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2374 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2375 keywords.
2377 Assume point is at the beginning of the table."
2391 acc))
2398 :end end
2399 :type type
2400 :tblfm tblfm
2401 ;; Only `org' tables have contents. `table.el' tables
2402 ;; use a `:value' property to store raw table as
2403 ;; a string.
2408 table-begin table-end))
2414 "Interpret TABLE element as Org syntax.
2415 CONTENTS is nil."
2426 ;;;; Table Row
2429 "Parse table row at point.
2431 LIMIT bounds the search.
2433 Return a list whose CAR is `table-row' and CDR is a plist
2434 containing `:begin', `:end', `:contents-begin', `:contents-end',
2435 `:type' and `:post-blank' keywords."
2439 ;; A table rule has no contents. In that case, ensure
2440 ;; CONTENTS-BEGIN matches CONTENTS-END.
2452 :begin begin
2453 :end end
2454 :contents-begin contents-begin
2455 :contents-end contents-end
2459 "Interpret TABLE-ROW element as Org syntax.
2460 CONTENTS is the contents of the table row."
2465 ;;;; Verse Block
2468 "Parse a verse block.
2470 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2471 the buffer position at the beginning of the first affiliated
2472 keyword and CDR is a plist of affiliated keywords along with
2473 their value.
2475 Return a list whose CAR is `verse-block' and CDR is a plist
2476 containing `:begin', `:end', `:contents-begin', `:contents-end',
2477 `:post-blank' and `:post-affiliated' keywords.
2479 Assume point is at beginning of the block."
2483 ;; Incomplete block: parse it as a paragraph.
2498 :end end
2499 :contents-begin contents-begin
2500 :contents-end contents-end
2506 "Interpret VERSE-BLOCK element as Org syntax.
2507 CONTENTS is verse block contents."
2511 \f
2512 ;;; Objects
2513 ;;
2514 ;; Unlike to elements, interstices can be found between objects.
2515 ;; That's why, along with the parser, successor functions are provided
2516 ;; for each object. Some objects share the same successor (i.e. `code'
2517 ;; and `verbatim' objects).
2518 ;;
2519 ;; A successor must accept a single argument bounding the search. It
2520 ;; will return either a cons cell whose CAR is the object's type, as
2521 ;; a symbol, and CDR the position of its next occurrence, or nil.
2522 ;;
2523 ;; Successors follow the naming convention:
2524 ;; org-element-NAME-successor, where NAME is the name of the
2525 ;; successor, as defined in `org-element-all-successors'.
2526 ;;
2527 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2528 ;; object types they can contain will be specified in
2529 ;; `org-element-object-restrictions'.
2530 ;;
2531 ;; Adding a new type of object is simple. Implement a successor,
2532 ;; a parser, and an interpreter for it, all following the naming
2533 ;; convention. Register type in `org-element-all-objects' and
2534 ;; successor in `org-element-all-successors'. Maybe tweak
2535 ;; restrictions about it, and that's it.
2538 ;;;; Bold
2541 "Parse bold object at point.
2543 Return a list whose CAR is `bold' and CDR is a plist with
2544 `:begin', `:end', `:contents-begin' and `:contents-end' and
2545 `:post-blank' keywords.
2547 Assume point is at the first star marker."
2559 :end end
2560 :contents-begin contents-begin
2561 :contents-end contents-end
2565 "Interpret BOLD object as Org syntax.
2566 CONTENTS is the contents of the object."
2570 "Search for the next text-markup object.
2572 Return value is a cons cell whose CAR is a symbol among `bold',
2573 `italic', `underline', `strike-through', `code' and `verbatim'
2574 and CDR is beginning position."
2590 ;;;; Code
2593 "Parse code object at point.
2595 Return a list whose CAR is `code' and CDR is a plist with
2596 `:value', `:begin', `:end' and `:post-blank' keywords.
2598 Assume point is at the first tilde marker."
2609 :begin begin
2610 :end end
2614 "Interpret CODE object as Org syntax.
2615 CONTENTS is nil."
2619 ;;;; Entity
2622 "Parse entity at point.
2624 Return a list whose CAR is `entity' and CDR a plist with
2625 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2626 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2627 keywords.
2629 Assume point is at the beginning of the entity."
2631 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2647 :begin begin
2648 :end end
2649 :use-brackets-p bracketsp
2653 "Interpret ENTITY object as Org syntax.
2654 CONTENTS is nil."
2660 "Search for the next latex-fragment or entity object.
2662 Return value is a cons cell whose CAR is `entity' or
2663 `latex-fragment' and CDR is beginning position."
2667 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2674 ;; Determine if it's a real entity or a LaTeX command.
2677 ;; No entity nor command: point is at a LaTeX fragment.
2678 ;; Determine its type to get the correct beginning position.
2687 ;;;; Export Snippet
2690 "Parse export snippet at point.
2692 Return a list whose CAR is `export-snippet' and CDR a plist with
2693 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2694 keywords.
2696 Assume point is at the beginning of the snippet."
2708 :value value
2709 :begin begin
2710 :end end
2714 "Interpret EXPORT-SNIPPET object as Org syntax.
2715 CONTENTS is nil."
2721 "Search for the next export-snippet object.
2723 Return value is a cons cell whose CAR is `export-snippet' and CDR
2724 its beginning position."
2733 ;;;; Footnote Reference
2736 "Parse footnote reference at point.
2738 Return a list whose CAR is `footnote-reference' and CDR a plist
2739 with `:label', `:type', `:inline-definition', `:begin', `:end'
2740 and `:post-blank' as keywords."
2762 :type type
2763 :begin begin
2764 :end end
2767 footnote-reference :inline-definition
2772 footnote-reference))))))
2775 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2776 CONTENTS is nil."
2786 "Search for the next footnote-reference object.
2788 Return value is a cons cell whose CAR is `footnote-reference' and
2789 CDR is beginning position."
2803 ;;;; Inline Babel Call
2806 "Parse inline babel call at point.
2808 Return a list whose CAR is `inline-babel-call' and CDR a plist
2809 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2811 Assume point is at the beginning of the babel call."
2823 :end end
2824 :value value
2828 "Interpret INLINE-BABEL-CALL object as Org syntax.
2829 CONTENTS is nil."
2833 "Search for the next inline-babel-call object.
2835 Return value is a cons cell whose CAR is `inline-babel-call' and
2836 CDR is beginning position."
2838 ;; Use a simplified version of
2839 ;; `org-babel-inline-lob-one-liner-regexp'.
2842 nil t)
2846 ;;;; Inline Src Block
2849 "Parse inline source block at point.
2851 Return a list whose CAR is `inline-src-block' and CDR a plist
2852 with `:begin', `:end', `:language', `:value', `:parameters' and
2853 `:post-blank' as keywords.
2855 Assume point is at the beginning of the inline src block."
2868 :value value
2869 :parameters parameters
2870 :begin begin
2871 :end end
2875 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2876 CONTENTS is nil."
2881 language
2883 body)))
2886 "Search for the next inline-babel-call element.
2888 Return value is a cons cell whose CAR is `inline-babel-call' and
2889 CDR is beginning position."
2895 ;;;; Italic
2898 "Parse italic object at point.
2900 Return a list whose CAR is `italic' and CDR is a plist with
2901 `:begin', `:end', `:contents-begin' and `:contents-end' and
2902 `:post-blank' keywords.
2904 Assume point is at the first slash marker."
2916 :end end
2917 :contents-begin contents-begin
2918 :contents-end contents-end
2922 "Interpret ITALIC object as Org syntax.
2923 CONTENTS is the contents of the object."
2927 ;;;; Latex Fragment
2930 "Parse LaTeX fragment at point.
2932 Return a list whose CAR is `latex-fragment' and CDR a plist with
2933 `:value', `:begin', `:end', and `:post-blank' as keywords.
2935 Assume point is at the beginning of the LaTeX fragment."
2948 ;; None found: it's a macro.
2957 :begin begin
2958 :end end
2962 "Interpret LATEX-FRAGMENT object as Org syntax.
2963 CONTENTS is nil."
2966 ;;;; Line Break
2969 "Parse line break at point.
2971 Return a list whose CAR is `line-break', and CDR a plist with
2972 `:begin', `:end' and `:post-blank' keywords.
2974 Assume point is at the beginning of the line break."
2981 "Interpret LINE-BREAK object as Org syntax.
2982 CONTENTS is nil."
2986 "Search for the next line-break object.
2988 Return value is a cons cell whose CAR is `line-break' and CDR is
2989 beginning position."
2993 ;; A line break can only happen on a non-empty line.
2998 ;;;; Link
3001 "Parse link at point.
3003 Return a list whose CAR is `link' and CDR a plist with `:type',
3004 `:path', `:raw-link', `:application', `:search-option', `:begin',
3005 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3006 keywords.
3008 Assume point is at the beginning of the link."
3011 end contents-begin contents-end link-end post-blank path type
3012 raw-link link search-option application)
3014 ;; Type 1: Text targeted from a radio target.
3019 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3024 ;; RAW-LINK is the original link. Expand any
3025 ;; abbreviation in it.
3029 ;; Determine TYPE of link and set PATH accordingly.
3031 ;; File type.
3035 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3038 ;; Id type: PATH is the id.
3041 ;; Code-ref type: PATH is the name of the reference.
3044 ;; Custom-id type: PATH is the name of the custom id.
3047 ;; Fuzzy type: Internal link either matches a target, an
3048 ;; headline name or nothing. PATH is the target or
3049 ;; headline's name.
3051 ;; Type 3: Plain link, i.e. http://orgmode.org
3057 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3064 ;; In any case, deduce end point after trailing white space from
3065 ;; LINK-END variable.
3068 ;; Extract search option and opening application out of
3069 ;; "file"-type links.
3071 ;; Application.
3076 ;; Extract search option from PATH.
3080 ;; Make sure TYPE always reports "file".
3084 :path path
3086 :application application
3087 :search-option search-option
3088 :begin begin
3089 :end end
3090 :contents-begin contents-begin
3091 :contents-end contents-end
3095 "Interpret LINK object as Org syntax.
3096 CONTENTS is the contents of the object, or nil."
3101 raw-link
3105 "Search for the next link object.
3107 Return value is a cons cell whose CAR is `link' and CDR is
3108 beginning position."
3117 "Search for the next plain link object.
3119 Return value is a cons cell whose CAR is `link' and CDR is
3120 beginning position."
3125 ;;;; Macro
3128 "Parse macro at point.
3130 Return a list whose CAR is `macro' and CDR a plist with `:key',
3131 `:args', `:begin', `:end', `:value' and `:post-blank' as
3132 keywords.
3134 Assume point is at the macro."
3145 ;; Do not use `org-split-string' since empty
3146 ;; strings are meaningful here.
3154 args nil t)
3158 :value value
3159 :args args
3160 :begin begin
3161 :end end
3165 "Interpret MACRO object as Org syntax.
3166 CONTENTS is nil."
3170 "Search for the next macro object.
3172 Return value is cons cell whose CAR is `macro' and CDR is
3173 beginning position."
3177 nil t)
3181 ;;;; Radio-target
3184 "Parse radio target at point.
3186 Return a list whose CAR is `radio-target' and CDR a plist with
3187 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3188 and `:post-blank' as keywords.
3190 Assume point is at the radio target."
3202 :end end
3203 :contents-begin contents-begin
3204 :contents-end contents-end
3205 :post-blank post-blank
3209 "Interpret TARGET object as Org syntax.
3210 CONTENTS is the contents of the object."
3214 "Search for the next radio-target object.
3216 Return value is a cons cell whose CAR is `radio-target' and CDR
3217 is beginning position."
3223 ;;;; Statistics Cookie
3226 "Parse statistics cookie at point.
3228 Return a list whose CAR is `statistics-cookie', and CDR a plist
3229 with `:begin', `:end', `:value' and `:post-blank' keywords.
3231 Assume point is at the beginning of the statistics-cookie."
3242 :end end
3243 :value value
3247 "Interpret STATISTICS-COOKIE object as Org syntax.
3248 CONTENTS is nil."
3252 "Search for the next statistics cookie object.
3254 Return value is a cons cell whose CAR is `statistics-cookie' and
3255 CDR is beginning position."
3261 ;;;; Strike-Through
3264 "Parse strike-through object at point.
3266 Return a list whose CAR is `strike-through' and CDR is a plist
3267 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3268 `:post-blank' keywords.
3270 Assume point is at the first plus sign marker."
3282 :end end
3283 :contents-begin contents-begin
3284 :contents-end contents-end
3288 "Interpret STRIKE-THROUGH object as Org syntax.
3289 CONTENTS is the contents of the object."
3293 ;;;; Subscript
3296 "Parse subscript at point.
3298 Return a list whose CAR is `subscript' and CDR a plist with
3299 `:begin', `:end', `:contents-begin', `:contents-end',
3300 `:use-brackets-p' and `:post-blank' as keywords.
3302 Assume point is at the underscore."
3306 t
3317 :end end
3318 :use-brackets-p bracketsp
3319 :contents-begin contents-begin
3320 :contents-end contents-end
3324 "Interpret SUBSCRIPT object as Org syntax.
3325 CONTENTS is the contents of the object."
3328 contents))
3331 "Search for the next sub/superscript object.
3333 Return value is a cons cell whose CAR is either `subscript' or
3334 `superscript' and CDR is beginning position."
3342 ;;;; Superscript
3345 "Parse superscript at point.
3347 Return a list whose CAR is `superscript' and CDR a plist with
3348 `:begin', `:end', `:contents-begin', `:contents-end',
3349 `:use-brackets-p' and `:post-blank' as keywords.
3351 Assume point is at the caret."
3365 :end end
3366 :use-brackets-p bracketsp
3367 :contents-begin contents-begin
3368 :contents-end contents-end
3372 "Interpret SUPERSCRIPT object as Org syntax.
3373 CONTENTS is the contents of the object."
3376 contents))
3379 ;;;; Table Cell
3382 "Parse table cell at point.
3384 Return a list whose CAR is `table-cell' and CDR is a plist
3385 containing `:begin', `:end', `:contents-begin', `:contents-end'
3386 and `:post-blank' keywords."
3394 :end end
3395 :contents-begin contents-begin
3396 :contents-end contents-end
3400 "Interpret TABLE-CELL element as Org syntax.
3401 CONTENTS is the contents of the cell, or nil."
3405 "Search for the next table-cell object.
3407 Return value is a cons cell whose CAR is `table-cell' and CDR is
3408 beginning position."
3412 ;;;; Target
3415 "Parse target at point.
3417 Return a list whose CAR is `target' and CDR a plist with
3418 `:begin', `:end', `:value' and `:post-blank' as keywords.
3420 Assume point is at the target."
3430 :end end
3431 :value value
3435 "Interpret TARGET object as Org syntax.
3436 CONTENTS is nil."
3440 "Search for the next target object.
3442 Return value is a cons cell whose CAR is `target' and CDR is
3443 beginning position."
3449 ;;;; Timestamp
3452 "Parse time stamp at point.
3454 Return a list whose CAR is `timestamp', and CDR a plist with
3455 `:type', `:raw-value', `:year-start', `:month-start',
3456 `:day-start', `:hour-start', `:minute-start', `:year-end',
3457 `:month-end', `:day-end', `:hour-end', `:minute-end',
3458 `:repeater-type', `:repeater-value', `:repeater-unit',
3459 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3460 `:end', `:value' and `:post-blank' keywords.
3462 Assume point is at the beginning of the timestamp."
3480 date-start)
3491 raw-value)
3493 :repeater-type
3499 :repeater-unit
3508 :warning-unit
3511 year-start month-start day-start hour-start minute-start year-end
3512 month-end day-end hour-end minute-end)
3513 ;; Parse date-start.
3521 ;; Compute date-end. It can be provided directly in time-stamp,
3522 ;; or extracted from time range. Otherwise, it defaults to the
3523 ;; same values as date-start.
3533 :raw-value raw-value
3534 :year-start year-start
3535 :month-start month-start
3536 :day-start day-start
3537 :hour-start hour-start
3538 :minute-start minute-start
3539 :year-end year-end
3540 :month-end month-end
3541 :day-end day-end
3542 :hour-end hour-end
3543 :minute-end minute-end
3544 :begin begin
3545 :end end
3547 repeater-props
3548 warning-props)))))
3551 "Interpret TIMESTAMP object as Org syntax.
3552 CONTENTS is nil."
3571 ;; Build an Org timestamp string from TIME. ACTIVEP is
3572 ;; non-nil when time stamp is active. If WITH-TIME-P is
3573 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3574 ;; specify a time range in the timestamp. REPEAT-STRING is
3575 ;; the repeater string, if any.
3579 org-time-stamp-formats)
3580 time)))
3586 nil nil ts)))
3591 " "
3592 s
3594 ;; Return value.
3595 ts)))
3607 build-ts-string
3626 0
3634 "--"
3646 "Search for the next timestamp object.
3648 Return value is a cons cell whose CAR is `timestamp' and CDR is
3649 beginning position."
3657 nil t)
3661 ;;;; Underline
3664 "Parse underline object at point.
3666 Return a list whose CAR is `underline' and CDR is a plist with
3667 `:begin', `:end', `:contents-begin' and `:contents-end' and
3668 `:post-blank' keywords.
3670 Assume point is at the first underscore marker."
3682 :end end
3683 :contents-begin contents-begin
3684 :contents-end contents-end
3688 "Interpret UNDERLINE object as Org syntax.
3689 CONTENTS is the contents of the object."
3693 ;;;; Verbatim
3696 "Parse verbatim object at point.
3698 Return a list whose CAR is `verbatim' and CDR is a plist with
3699 `:value', `:begin', `:end' and `:post-blank' keywords.
3701 Assume point is at the first equal sign marker."
3712 :begin begin
3713 :end end
3717 "Interpret VERBATIM object as Org syntax.
3718 CONTENTS is nil."
3722 \f
3723 ;;; Parsing Element Starting At Point
3724 ;;
3725 ;; `org-element--current-element' is the core function of this section.
3726 ;; It returns the Lisp representation of the element starting at
3727 ;; point.
3728 ;;
3729 ;; `org-element--current-element' makes use of special modes. They
3730 ;; are activated for fixed element chaining (i.e. `plain-list' >
3731 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3732 ;; `section'). Special modes are: `first-section', `item',
3733 ;; `node-property', `quote-section', `section' and `table-row'.
3737 "Parse the element starting at point.
3739 Return value is a list like (TYPE PROPS) where TYPE is the type
3740 of the element and PROPS a plist of properties associated to the
3741 element.
3743 Possible types are defined in `org-element-all-elements'.
3745 LIMIT bounds the search.
3747 Optional argument GRANULARITY determines the depth of the
3748 recursion. Allowed values are `headline', `greater-element',
3749 `element', `object' or nil. When it is broader than `object' (or
3750 nil), secondary values will not be parsed, since they only
3751 contain objects.
3753 Optional argument SPECIAL, when non-nil, can be either
3754 `first-section', `item', `node-property', `quote-section',
3755 `section', and `table-row'.
3757 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3758 be computed.
3760 This function assumes point is always at the beginning of the
3761 element it has to parse."
3764 ;; Determine if parsing depth allows for secondary strings
3765 ;; parsing. It only applies to elements referenced in
3766 ;; `org-element-secondary-value-alist'.
3769 ;; Item.
3772 ;; Table Row.
3774 ;; Node Property.
3776 ;; Headline.
3779 ;; Sections (must be checked after headline).
3785 limit)))
3786 ;; When not at bol, point is at the beginning of an item or
3787 ;; a footnote definition: next item is always a paragraph.
3789 ;; Planning and Clock.
3794 ;; Inlinetask.
3797 ;; From there, elements can have affiliated keywords.
3800 ;; Jumping over affiliated keywords put point off-limits.
3801 ;; Parse them as regular keywords.
3805 ;; LaTeX Environment.
3809 ;; Drawer and Property Drawer.
3814 ;; Fixed Width
3817 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3818 ;; Keywords.
3827 org-element-block-name-alist)))
3842 ;; Footnote Definition.
3845 ;; Horizontal Rule.
3848 ;; Diary Sexp.
3851 ;; Table.
3853 ;; List.
3856 limit affiliated
3858 ;; Default element: Paragraph.
3862 ;; Most elements can have affiliated keywords. When looking for an
3863 ;; element beginning, we want to move before them, as they belong to
3864 ;; that element, and, in the meantime, collect information they give
3865 ;; into appropriate properties. Hence the following function.
3868 "Collect affiliated keywords from point down to LIMIT.
3870 Return a list whose CAR is the position at the first of them and
3871 CDR a plist of keywords and values and move point to the
3872 beginning of the first line after them.
3874 As a special case, if element doesn't start at the beginning of
3875 the line (i.e. a paragraph starting an item), CAR is current
3876 position of point and CDR is nil."
3880 ;; RESTRICT is the list of objects allowed in parsed
3881 ;; keywords value.
3883 output)
3886 ;; Apply translation to RAW-KWD. From there, KWD is
3887 ;; the official keyword.
3889 org-element-keyword-translation-alist))
3890 raw-kwd))
3891 ;; Find main value for any keyword.
3897 ;; PARSEDP is non-nil when keyword should have its
3898 ;; value parsed.
3900 ;; If KWD is a dual keyword, find its secondary
3901 ;; value. Maybe parse it.
3908 ;; Attribute a property name to KWD.
3910 ;; Now set final shape for VALUE.
3916 ;; Attributes can always appear on multiple lines.
3919 ;; Eventually store the new value in OUTPUT.
3921 ;; Move to next keyword.
3923 ;; If affiliated keywords are orphaned: move back to first one.
3924 ;; They will be parsed as a paragraph.
3926 ;; Return value.
3930 \f
3931 ;;; The Org Parser
3932 ;;
3933 ;; The two major functions here are `org-element-parse-buffer', which
3934 ;; parses Org syntax inside the current buffer, taking into account
3935 ;; region, narrowing, or even visibility if specified, and
3936 ;; `org-element-parse-secondary-string', which parses objects within
3937 ;; a given string.
3938 ;;
3939 ;; The (almost) almighty `org-element-map' allows to apply a function
3940 ;; on elements or objects matching some type, and accumulate the
3941 ;; resulting values. In an export situation, it also skips unneeded
3942 ;; parts of the parse tree.
3945 "Recursively parse the buffer and return structure.
3946 If narrowing is in effect, only parse the visible part of the
3947 buffer.
3949 Optional argument GRANULARITY determines the depth of the
3950 recursion. It can be set to the following symbols:
3952 `headline' Only parse headlines.
3953 `greater-element' Don't recurse into greater elements excepted
3954 headlines and sections. Thus, elements
3955 parsed are the top-level ones.
3956 `element' Parse everything but objects and plain text.
3957 `object' Parse the complete buffer (default).
3959 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3960 elements.
3962 An element or an objects is represented as a list with the
3963 pattern (TYPE PROPERTIES CONTENTS), where :
3965 TYPE is a symbol describing the element or object. See
3966 `org-element-all-elements' and `org-element-all-objects' for an
3967 exhaustive list of such symbols. One can retrieve it with
3968 `org-element-type' function.
3970 PROPERTIES is the list of attributes attached to the element or
3971 object, as a plist. Although most of them are specific to the
3972 element or object type, all types share `:begin', `:end',
3973 `:post-blank' and `:parent' properties, which respectively
3974 refer to buffer position where the element or object starts,
3975 ends, the number of white spaces or blank lines after it, and
3976 the element or object containing it. Properties values can be
3977 obtained by using `org-element-property' function.
3979 CONTENTS is a list of elements, objects or raw strings
3980 contained in the current element or object, when applicable.
3981 One can access them with `org-element-contents' function.
3983 The Org buffer has `org-data' as type and nil as properties.
3984 `org-element-map' function can be used to find specific elements
3985 or objects within the parse tree.
3987 This function assumes that current major mode is `org-mode'."
3993 ;; Start in `first-section' mode so text before the first
3994 ;; headline belongs to a section.
3998 "Recursively parse objects in STRING and return structure.
4000 RESTRICTION is a symbol limiting the object types that will be
4001 looked after.
4003 Optional argument PARENT, when non-nil, is the element or object
4004 containing the secondary string. It is used to set correctly
4005 `:parent' property within the string."
4006 ;; Copy buffer-local variables listed in
4007 ;; `org-element-object-variables' into temporary buffer. This is
4008 ;; required since object parsing is dependent on these variables.
4012 org-element-object-variables))))
4020 secondary))
4021 secondary))))
4025 "Map a function on selected elements or objects.
4027 DATA is a parse tree, an element, an object, a string, or a list
4028 of such constructs. TYPES is a symbol or list of symbols of
4029 elements or objects types (see `org-element-all-elements' and
4030 `org-element-all-objects' for a complete list of types). FUN is
4031 the function called on the matching element or object. It has to
4032 accept one argument: the element or object itself.
4034 When optional argument INFO is non-nil, it should be a plist
4035 holding export options. In that case, parts of the parse tree
4036 not exportable according to that property list will be skipped.
4038 When optional argument FIRST-MATCH is non-nil, stop at the first
4039 match for which FUN doesn't return nil, and return that value.
4041 Optional argument NO-RECURSION is a symbol or a list of symbols
4042 representing elements or objects types. `org-element-map' won't
4043 enter any recursive element or object whose type belongs to that
4044 list. Though, FUN can still be applied on them.
4046 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4047 apply to matching objects within parsed affiliated keywords (see
4048 `org-element-parsed-keywords').
4050 Nil values returned from FUN do not appear in the results.
4053 Examples:
4054 ---------
4056 Assuming TREE is a variable containing an Org buffer parse tree,
4057 the following example will return a flat list of all `src-block'
4058 and `example-block' elements in it:
4060 \(org-element-map tree '(example-block src-block) 'identity)
4062 The following snippet will find the first headline with a level
4065 \(org-element-map tree 'headline
4066 \(lambda (hl)
4067 \(and (= (org-element-property :level hl) 1)
4069 \(org-element-property :begin hl)))
4070 nil t)
4072 The next example will return a flat list of all `plain-list' type
4073 elements in TREE that are not a sub-list themselves:
4075 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4077 Eventually, this example will return a flat list of all `bold'
4078 type objects containing a `latex-snippet' type object, even
4079 looking into captions:
4081 \(org-element-map tree 'bold
4082 \(lambda (b)
4083 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4084 nil nil nil t)"
4085 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4088 ;; Recursion depth is determined by --CATEGORY.
4095 ;; If one object is found, the function
4096 ;; has to recurse into every object.
4099 ;; If one regular element is found, the
4100 ;; function has to recurse, at least,
4101 ;; into every element it encounters.
4104 types)
4105 category)))
4106 ;; Compute properties for affiliated keywords if necessary.
4111 org-element-affiliated-keywords)))
4112 --acc
4113 --walk-tree
4117 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4118 ;; holding contextual information.
4122 ;; Ignored element in an export context.
4124 ;; List of elements or objects.
4126 ;; Unconditionally enter parse trees.
4130 ;; Check if TYPE is matching among TYPES. If so,
4131 ;; apply FUN to --DATA and accumulate return value
4132 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4138 ;; If --DATA has a secondary string that can contain
4139 ;; objects with their type among TYPES, look into it.
4146 ;; If --DATA has any affiliated keywords and
4147 ;; WITH-AFFILIATED is non-nil, look for objects in
4148 ;; them.
4156 ;; Pay attention to the type of value.
4157 ;; Preserve order for multiple keywords.
4173 --affiliated-alist))
4174 ;; Determine if a recursion into --DATA is possible.
4176 ;; --TYPE is explicitly removed from recursion.
4178 ;; --DATA has no contents.
4180 ;; Looking for greater elements but --DATA is simply
4181 ;; an element or an object.
4184 ;; Looking for elements but --DATA is an object.
4187 ;; In any other case, map contents.
4191 ;; Return value in a proper order.
4195 ;; The following functions are internal parts of the parser.
4196 ;;
4197 ;; The first one, `org-element--parse-elements' acts at the element's
4198 ;; level.
4199 ;;
4200 ;; The second one, `org-element--parse-objects' applies on all objects
4201 ;; of a paragraph or a secondary string. It uses
4202 ;; `org-element--get-next-object-candidates' to optimize the search of
4203 ;; the next object in the buffer.
4204 ;;
4205 ;; More precisely, that function looks for every allowed object type
4206 ;; first. Then, it discards failed searches, keeps further matches,
4207 ;; and searches again types matched behind point, for subsequent
4208 ;; calls. Thus, searching for a given type fails only once, and every
4209 ;; object is searched only once at top level (but sometimes more for
4210 ;; nested types).
4214 "Parse elements between BEG and END positions.
4216 SPECIAL prioritize some elements over the others. It can be set
4217 to `first-section', `quote-section', `section' `item' or
4218 `table-row'.
4220 When value is `item', STRUCTURE will be used as the current list
4221 structure.
4223 GRANULARITY determines the depth of the recursion. See
4224 `org-element-parse-buffer' for more information.
4226 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4227 elements.
4229 Elements are accumulated into ACC."
4232 ;; Visible only: skip invisible parts at the beginning of the
4233 ;; element.
4236 ;; When parsing only headlines, skip any text before first one.
4239 ;; Main loop start.
4241 ;; Find current element's type and parse it accordingly to
4242 ;; its category.
4244 end granularity special structure))
4248 ;; Visible only: skip invisible parts between siblings.
4251 ;; Fill ELEMENT contents by side-effect.
4253 ;; If element has no contents, don't modify it.
4255 ;; Greater element: parse it between `contents-begin' and
4256 ;; `contents-end'. Make sure GRANULARITY allows the
4257 ;; recursion, or ELEMENT is a headline, in which case going
4258 ;; inside is mandatory, in order to get sub-level headings.
4266 ;; Possibly switch to a special mode.
4276 granularity visible-only element))
4277 ;; ELEMENT has contents. Parse objects inside, if
4278 ;; GRANULARITY allows it.
4284 ;; Return result.
4285 acc))
4288 "Parse objects between BEG and END and return recursive structure.
4290 Objects are accumulated in ACC.
4292 RESTRICTION is a list of object successors which are allowed in
4293 the current object."
4302 restriction candidates)))
4309 ;; 1. Text before any object. Untabify it.
4314 acc
4318 ;; 2. Object...
4321 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4322 ;; a recursive type.
4330 ;; 3. Text after last object. Untabify it.
4334 acc
4338 ;; Result.
4339 acc))))
4342 "Return an alist of candidates for the next object.
4344 RESTRICTION is a list of object types, as symbols. Only
4345 candidates with such types are looked after.
4347 OBJECTS is the previous candidates alist. If it is set to
4348 `initial', no search has been done before, and all symbols in
4349 RESTRICTION should be looked after.
4351 Return value is an alist whose CAR is the object type and CDR its
4352 beginning position."
4354 nil
4356 ;; When searching for the first time, look for every successor
4357 ;; allowed in RESTRICTION.
4361 restriction)
4362 ;; Focus on objects returned during last search. Keep those
4363 ;; still after point. Search again objects before it.
4369 type)))
4372 objects))))
4375 \f
4376 ;;; Towards A Bijective Process
4377 ;;
4378 ;; The parse tree obtained with `org-element-parse-buffer' is really
4379 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4380 ;; interpreted and expanded into a string with canonical Org syntax.
4381 ;; Hence `org-element-interpret-data'.
4382 ;;
4383 ;; The function relies internally on
4384 ;; `org-element--interpret-affiliated-keywords'.
4386 ;;;###autoload
4388 "Interpret DATA as Org syntax.
4390 DATA is a parse tree, an element, an object or a secondary string
4391 to interpret.
4393 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4394 new types that should be treated as objects. An unknown type not
4395 belonging to this list is seen as a pseudo-element instead. Both
4396 pseudo-objects and pseudo-elements are transparent entities, i.e.
4397 only their contents are interpreted.
4399 Return Org syntax as a string."
4403 "Interpret DATA as Org syntax.
4405 DATA is a parse tree, an element, an object or a secondary string
4406 to interpret. PARENT is used for recursive calls. It contains
4407 the element or object containing data, or nil. PSEUDO-OBJECTS
4408 are list of symbols defining new element or object types.
4409 Unknown types that don't belong to this list are treated as
4410 pseudo-elements instead.
4412 Return Org syntax as a string."
4414 ;; Find interpreter for current object or element. If it
4415 ;; doesn't exist (e.g. this is a pseudo object or element),
4416 ;; return contents, if any.
4422 ;; Secondary string.
4428 ;; Full Org document.
4434 ;; Plain text: remove `:parent' text property from output.
4436 ;; Element or object without contents.
4438 ;; Element or object with contents.
4441 ;; Recursively interpret contents.
4447 data
4448 ;; Fix indentation of elements containing
4449 ;; objects. We ignore `table-row' elements
4450 ;; as they are one line long anyway.
4452 data
4453 ;; When normalizing first paragraph of an
4454 ;; item or a footnote-definition, ignore
4455 ;; first line's indentation.
4462 ;; Build white spaces. If no `:post-blank' property is
4463 ;; specified, assume its value is 0.
4474 "Return ELEMENT's affiliated keywords as Org syntax.
4475 If there is no affiliated keyword, return the empty string."
4485 ": "
4488 value)
4496 ;; All attribute keywords can have multiple lines.
4502 ;; List all ELEMENT's properties matching an attribute line or an
4503 ;; affiliated keyword, but ignore translated keywords since they
4504 ;; cannot belong to the property list.
4511 org-element-keyword-translation-alist)))))
4512 collect prop)
4515 ;; Because interpretation of the parse tree must return the same
4516 ;; number of blank lines between elements and the same number of white
4517 ;; space after objects, some special care must be given to white
4518 ;; spaces.
4519 ;;
4520 ;; The first function, `org-element-normalize-string', ensures any
4521 ;; string different from the empty string will end with a single
4522 ;; newline character.
4523 ;;
4524 ;; The second function, `org-element-normalize-contents', removes
4525 ;; global indentation from the contents of the current element.
4528 "Ensure string S ends with a single newline character.
4530 If S isn't a string return it unchanged. If S is the empty
4531 string, return it. Otherwise, return a new string with a single
4532 newline character at its end."
4540 "Normalize plain text in ELEMENT's contents.
4542 ELEMENT must only contain plain text and objects.
4544 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4545 indentation to compute maximal common indentation.
4547 Return the normalized element that is element with global
4548 indentation removed from its contents. The function assumes that
4549 indentation is not done with TAB characters."
4551 collect-inds ; for byte-compiler
4554 ;; Return list of indentations within BLOB. This is done by
4555 ;; walking recursively BLOB and updating IND-LIST along the
4556 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4557 ;; been seen yet. It is required as this string is the only
4558 ;; one whose indentation doesn't happen after a newline
4559 ;; character.
4567 ;; An indentation of zero means no string will be
4568 ;; modified. Quit the process.
4574 ;; Avoid matching blank or empty lines.
4582 ;; Collect indentation list in ELEMENT. Possibly remove first
4583 ;; value if IGNORE-FIRST is non-nil.
4586 ;; Build ELEMENT back, replacing each string with the same
4587 ;; string minus common indentation.
4592 ;; Return BLOB with all its strings indentation
4593 ;; shortened from MCI white spaces. FIRST-FLAG is
4594 ;; non-nil when the first string hasn't been seen
4595 ;; yet.
4609 org-element-recursive-objects)
4613 blob))))
4617 \f
4618 ;;; The Toolbox
4619 ;;
4620 ;; The first move is to implement a way to obtain the smallest element
4621 ;; containing point. This is the job of `org-element-at-point'. It
4622 ;; basically jumps back to the beginning of section containing point
4623 ;; and proceed, one element after the other, with
4624 ;; `org-element--current-element' until the container is found. Note:
4625 ;; When using `org-element-at-point', secondary values are never
4626 ;; parsed since the function focuses on elements, not on objects.
4627 ;;
4628 ;; At a deeper level, `org-element-context' lists all elements and
4629 ;; objects containing point.
4630 ;;
4631 ;; Both functions benefit from a simple caching mechanism. It is
4632 ;; enabled by default, but can be disabled globally with
4633 ;; `org-element-use-cache'. Also `org-element-cache-reset' clears or
4634 ;; initializes cache for current buffer. Values are retrieved and put
4635 ;; into cache with respectively, `org-element-cache-get' and
4636 ;; `org-element-cache-put'. `org-element--cache-sync-idle-time' and
4637 ;; `org-element--cache-merge-changes-threshold' are used internally to
4638 ;; control caching behaviour.
4639 ;;
4640 ;; Eventually `org-element-nested-p' and `org-element-swap-A-B' may be
4641 ;; used internally by navigation and manipulation tools.
4647 "Hash table used as a cache for parser.
4648 Key is a buffer position and value is a cons cell with the
4649 pattern:
4651 \(ELEMENT . OBJECTS-DATA)
4653 where ELEMENT is the element starting at the key and OBJECTS-DATA
4654 is an alist where each association is:
4656 \(POS CANDIDATES . OBJECTS)
4658 where POS is a buffer position, CANDIDATES is the last know list
4659 of successors (see `org-element--get-next-object-candidates') in
4660 container starting at POS and OBJECTS is a list of objects known
4661 to live within that container, from farthest to closest.
4664 at, respectively, positions 1, 7 and 8,
4668 If the paragraph is completely parsed, OBJECTS-DATA will be
4670 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
4671 \(8 nil ENTITY-OBJECT))
4673 whereas in a partially parsed paragraph, it could be
4675 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
4677 This cache is used in both `org-element-at-point' and
4678 `org-element-context'. The former uses ELEMENT only and the
4682 "Number of seconds of idle time wait before syncing buffer cache.
4683 Syncing also happens when current modification is too distant
4684 from the stored one (for more information, see
4688 "Number of characters triggering cache syncing.
4690 The cache mechanism only stores one buffer modification at any
4691 given time. When another change happens, it replaces it with
4692 a change containing both the stored modification and the current
4693 one. This is a trade-off, as merging them prevents another
4694 syncing, but every element between them is then lost.
4696 This variable determines the maximum size, in characters, we
4700 "Contains data about cache validity for current buffer.
4702 Value is a vector of seven elements,
4704 [ACTIVEP BEGIN END OFFSET TIMER PREVIOUS-STATE]
4706 ACTIVEP is a boolean non-nil when changes described in the other
4707 slots are valid for current buffer.
4709 BEGIN and END are the beginning and ending position of the area
4710 for which cache cannot be trusted.
4712 OFFSET it an integer specifying the number to add to position of
4713 elements after that area.
4715 TIMER is a timer used to apply these changes to cache when Emacs
4716 is idle.
4718 PREVIOUS-STATE is a symbol referring to the state of the buffer
4719 before a change happens. It is used to know if sensitive
4720 areas (block boundaries, headlines) were modified. It can be set
4723 ;;;###autoload
4725 "Reset cache in current buffer.
4726 When optional argument ALL is non-nil, reset cache in all Org
4727 buffers. This function will do nothing if
4728 `org-element-use-cache' is nil."
4745 "Non-nil when changes are not integrated in cache yet."
4750 "Push change to current buffer staging area.
4751 BEG and END and the beginning and ending position of the
4752 modification area. OFFSET is the size of the change, as an
4753 integer."
4761 nil
4762 #'org-element--cache-sync
4767 "Remove any cache change set for current buffer."
4773 "Return expected key for ELEMENT in cache."
4778 begin))
4779 ;; Special key for first item (resp. table-row) in a plain
4780 ;; list (resp. table).
4782 begin)))
4785 "Return data stored at key POS in current buffer cache.
4786 When optional argument TYPE is `element', retrieve the element
4787 starting at POS. When it is `objects', return the list of object
4788 types along with their beginning position within that element.
4789 Otherwise, return the full data. In any case, return nil if no
4790 data is found, or if caching is not allowed."
4792 ;; If there are pending changes, first sync them.
4802 "Store data in current buffer's cache, if allowed.
4803 POS is a buffer position, which will be used as a key. DATA is
4804 the value to store. Nothing will be stored if
4805 `org-element-use-cache' is nil. Return DATA in any case."
4811 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4812 Properties containing buffer positions are `:begin', `:end',
4813 `:contents-begin', `:contents-end' and `:structure'. They are
4814 modified by side-effect. Return modified element."
4816 ;; Shift :structure property for the first plain list only: it is
4817 ;; the only one that really matters and it prevents from shifting
4818 ;; it more than once.
4830 element)
4838 "Regexp matching an element opening line.
4839 When such a line is modified, modifications may propagate after
4840 modified area. In that situation, every element between that
4849 "Regexp matching an element closing line.
4850 When such a line is modified, modifications may propagate before
4851 modified area. In that situation, every element between that
4855 "Request extension of area going to be modified if needed.
4856 BEG and END are the beginning and end of the range of changed
4857 text. See `before-change-functions' for more information."
4865 ;; A sensitive line is a headline or a block (or drawer,
4866 ;; or latex-environment) boundary. Inserting one can
4867 ;; modify buffer drastically both above and below that
4868 ;; line, possibly making cache invalid. Therefore, we
4869 ;; need to pay special attention to changes happening to
4870 ;; them.
4874 org-element--cache-opening-line)))
4887 "Update buffer modifications for current buffer.
4889 BEG and END are the beginning and end of the range of changed
4890 text, and the length in bytes of the pre-change text replaced by
4891 that range. See `after-change-functions' for more information.
4893 If there are already pending changes, try to merge them into
4894 a bigger change record. If that's not possible, the function
4895 will first synchronize cache with previous change and store the
4896 new one."
4906 ;; Determine if modified area needs to be extended,
4907 ;; according to both previous and current state. We make
4908 ;; a special case for headline editing: if a headline is
4909 ;; modified but not removed, do not extend.
4914 org-element--cache-opening-line)))
4925 ;; Effectively extend modified area.
4928 ;; Headline above is inclusive.
4932 ;; Headline below is exclusive.
4934 ;; Store changes.
4937 ;; No pending changes. Store the new ones.
4944 ;; If we cannot merge two change sets (i.e. they
4945 ;; modify distinct buffer parts) first apply current
4946 ;; change set and store new one. This way, there is
4947 ;; never more than one pending change set, which
4948 ;; avoids handling costly merges.
4952 ;; Change sets can be merged. We can expand the area
4953 ;; that requires an update, and postpone the sync.
4962 "Synchronize cache with recent modification in BUFFER.
4963 Elements ending before modification area are kept in cache.
4964 Elements starting after modification area have their position
4965 shifted by the size of the modification. Every other element is
4966 removed from the cache."
4974 new-keys)
4980 ;; Shift every element starting after END by OFFSET.
4981 ;; We also need to shift keys, since they refer to
4982 ;; buffer positions.
4983 ;;
4984 ;; Upon shifting a key a conflict can occur if the
4985 ;; shifted key also refers to some element in the
4986 ;; cache. In this case, we temporarily associate
4987 ;; both elements, as a cons cell, to the shifted key,
4988 ;; following the pattern (SHIFTED . CURRENT).
4989 ;;
4990 ;; Such a conflict can only occur if shifted key hash
4991 ;; hasn't been processed by `maphash' yet.
4995 ;; Shift element part.
4997 ;; Shift objects part.
5004 ;; Shift key-value pair.
5007 ;; Put new value to shifted key.
5008 ;;
5009 ;; If one already exists, do not overwrite it:
5010 ;; store it as the car of a cons cell instead,
5011 ;; and handle it when `maphash' reaches
5012 ;; NEW-KEY.
5013 ;;
5014 ;; If there is no element stored at NEW-KEY or
5015 ;; if NEW-KEY is going to be removed anyway
5016 ;; (i.e., it is before END), just store new
5017 ;; value there and make sure it will not be
5018 ;; processed again by storing NEW-KEY in
5019 ;; NEW-KEYS.
5024 value-to-shift)
5025 org-element--cache)
5026 ;; If current value contains two elements, car
5027 ;; should be the new value, since cdr has been
5028 ;; shifted already.
5032 ;; Remove every element between BEG and END, since
5033 ;; this is where changes happened.
5035 ;; Preserve any element ending before BEG. If it
5036 ;; overlaps the BEG-END area, remove it.
5041 ;; Special case: footnote definitions and plain
5042 ;; lists can end with blank lines. Modifying
5043 ;; those can also alter last element inside. We
5044 ;; must therefore remove them from cache.
5054 org-element--cache)
5055 ;; Signal cache as up-to-date.
5058 ;;;###autoload
5060 "Determine closest element around point.
5062 Return value is a list like (TYPE PROPS) where TYPE is the type
5063 of the element and PROPS a plist of properties associated to the
5064 element.
5066 Possible types are defined in `org-element-all-elements'.
5067 Properties depend on element or object type, but always include
5068 `:begin', `:end', `:parent' and `:post-blank' properties.
5070 As a special case, if point is at the very beginning of a list or
5071 sub-list, returned element will be that list instead of the first
5072 item. In the same way, if point is at the beginning of the first
5073 row of a table, returned element will be the table instead of the
5074 first row.
5076 If optional argument KEEP-TRAIL is non-nil, the function returns
5077 a list of elements leading to element at point. The list's CAR
5078 is always the element at point. The following positions contain
5079 element's siblings, then parents, siblings of parents, until the
5080 first element of current section."
5082 ;; If at a headline, parse it. It is the sole element that
5083 ;; doesn't require to know about context. Be sure to disallow
5084 ;; secondary string parsing, though.
5095 ;; Otherwise move at the beginning of the section containing
5096 ;; point.
5100 ;; In empty lines at buffer's beginning, return nil.
5108 ;; In blank lines just after the headline, point still
5109 ;; belongs to the headline.
5124 element type special-flag trail struct parent)
5125 ;; Parse successively each element, skipping those ending
5126 ;; before original position.
5131 ;; First item (resp. row) in plain
5132 ;; list (resp. table) gets
5133 ;; a special key in cache.
5143 element))
5144 ;; When changes happened in the middle of a list,
5145 ;; its structure ends up being invalid.
5146 ;; Therefore, we make sure to use a valid one.
5154 ;; 1. Skip any element ending before point. Also skip
5155 ;; element ending at point when we're sure that
5156 ;; another element has started.
5161 ;; 2. An element containing point is always the element at
5162 ;; point.
5165 ;; 3. At any other greater element type, if point is
5166 ;; within contents, move into it.
5171 ;; Create an anchor for tables and plain
5172 ;; lists: when point is at the very beginning
5173 ;; of these elements, ignoring affiliated
5174 ;; keywords, target them instead of their
5175 ;; contents.
5177 ;; When point is at contents end, do not move
5178 ;; into elements with an explicit ending, but
5179 ;; return that element instead.
5183 drawer dynamic-block inlinetask
5184 property-drawer quote-block
5185 special-block))
5186 ;; Corner case: if a list ends at
5187 ;; the end of a buffer without
5188 ;; a final new line, return last
5189 ;; element in last item instead.
5207 ;;;###autoload
5209 "Return closest element or object around point.
5211 Return value is a list like (TYPE PROPS) where TYPE is the type
5212 of the element or object and PROPS a plist of properties
5213 associated to it.
5215 Possible types are defined in `org-element-all-elements' and
5216 `org-element-all-objects'. Properties depend on element or
5217 object type, but always include `:begin', `:end', `:parent' and
5218 `:post-blank'.
5220 Optional argument ELEMENT, when non-nil, is the closest element
5221 containing point, as returned by `org-element-at-point'.
5222 Providing it allows for quicker computation."
5228 ;; If point is inside an element containing objects or
5229 ;; a secondary string, narrow buffer to the container and
5230 ;; proceed with parsing. Otherwise, return ELEMENT.
5232 ;; At a parsed affiliated keyword, check if we're inside main
5233 ;; or dual value.
5240 org-element-parsed-keywords))
5249 ;; Also change type to retrieve correct restrictions.
5251 ;; At an item, objects can only be located within tag, if any.
5261 ;; At an headline or inlinetask, objects are in title.
5268 ;; At a paragraph, a table-row or a verse block, objects are
5269 ;; located within their contents.
5273 ;; CBEG is nil for table rules.
5277 ;; At a parsed keyword, objects are located within value.
5280 org-element-document-properties))
5287 ;; All other locations cannot contain objects: bail out.
5295 objects-data next update-cache-flag)
5299 ;; Get list of next object candidates in CANDIDATES.
5300 ;; When entering for the first time PARENT, grab it
5301 ;; from cache, if available, or compute it. Then,
5302 ;; for each subsequent iteration in PARENT, always
5303 ;; compute it since we're beyond cache anyway.
5308 cache))))
5312 restriction candidates))
5316 ;; Compare ORIGIN with next object starting position,
5317 ;; if any.
5318 ;;
5319 ;; If ORIGIN is lesser or if there is no object
5320 ;; following, look for a previous object that might
5321 ;; contain it in cache. If there is no cache, we
5322 ;; didn't miss any object so simply return PARENT.
5323 ;;
5324 ;; If ORIGIN is greater or equal, parse next
5325 ;; candidate for further processing.
5329 candidates))))
5335 ;; Object ends before ORIGIN and we
5336 ;; know next one in cache starts
5337 ;; after it: bail out.
5347 ;; Process NEXT to know if we need to skip it, return
5348 ;; it or move into it.
5353 ;; ORIGIN is after NEXT, so skip it.
5355 ;; ORIGIN is within a non-recursive next or
5356 ;; at an object boundaries: Return that object.
5360 ;; Otherwise, move into NEXT and reset flags as we
5361 ;; shift parent.
5367 next nil
5368 objects-data nil
5370 ;; Update cache if required.
5375 "Non-nil when elements ELEM-A and ELEM-B are nested."
5384 "Swap elements ELEM-A and ELEM-B.
5385 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5386 end of ELEM-A."
5388 ;; There are two special cases when an element doesn't start at bol:
5389 ;; the first paragraph in an item or in a footnote definition.
5391 ;; Only a paragraph without any affiliated keyword can be moved at
5392 ;; ELEM-A position in such a situation. Note that the case of
5393 ;; a footnote definition is impossible: it cannot contain two
5394 ;; paragraphs in a row because it cannot contain a blank line.
5400 ;; In a special situation, ELEM-A will have no indentation. We'll
5401 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5415 ;; Store overlays responsible for visibility status. We
5416 ;; also need to store their boundaries as they will be
5417 ;; removed from buffer.
5424 ;; Get contents.
5432 ;; Restore ex ELEM-A overlays.
5441 ;; Restore ex ELEM-B overlays.
5449 "Remove maximum common indentation in string S and return it.
5450 When optional argument N is a positive integer, remove exactly
5451 that much characters from indentation, if possible, or return
5452 S as-is otherwise. Unlike to `org-remove-indentation', this
5453 function doesn't call `untabify' on S."
5458 ;; Find maximum common indentation, if not specified.
5466 min-ind)))
5468 ;; Remove exactly N indentation, but give up if not possible.
5480 ;; Local variables:
5481 ;; generated-autoload-file: "org-loaddefs.el"
5482 ;; End:
5484 ;;; org-element.el ends here