| blob | 7050b75acecea195513e15ab6463f3019c6d09c6 |
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 and keywords. Note: this
148 ;; is only an indication and need some thorough check.
150 ;; Drawers (any type) and fixed-width areas. This is also
151 ;; only an indication.
153 ;; Horizontal rules.
155 ;; LaTeX environments.
157 ;; Planning and Clock lines.
159 org-deadline-string
160 org-closed-string
161 org-clock-string))
163 ;; Lists.
170 "Regexp to separate paragraphs in an Org buffer.
172 is not sufficient to know if point is at a paragraph ending. See
177 dynamic-block example-block export-block fixed-width
178 footnote-definition headline horizontal-rule inlinetask item
179 keyword latex-environment node-property paragraph plain-list
180 planning property-drawer quote-block quote-section section
181 special-block src-block table table-row verse-block)
186 item plain-list property-drawer quote-block section
187 special-block table)
192 latex-or-entity line-break link macro plain-link radio-target
193 statistics-cookie sub/superscript table-cell target
194 text-markup timestamp)
203 "Alist of translations between object type and successor name.
204 Sharing the same successor comes handy when, for example, the
209 inline-src-block italic line-break latex-fragment link macro
210 radio-target statistics-cookie strike-through subscript superscript
211 table-cell target timestamp underline verbatim)
216 table-cell underline)
226 "Alist between block names and the associated parsing function.
227 Names must be uppercase. Any block whose name has no association
233 Only these types can accept search options and an explicit
239 "List of affiliated keywords as strings.
245 ;; Regular affiliated keywords.
248 "Regexp matching any affiliated keyword.
250 Keyword name is put in match group 1. Moreover, if keyword
251 belongs to `org-element-dual-keywords', put the dual value in
252 match group 2.
260 "Alist of usual translations for keywords.
261 The key is the old name and the value the new one. The property
265 "List of affiliated keywords that can occur more than once in an element.
267 Their value will be consed into a list of strings, which will be
268 returned as the value of the property.
270 This list is checked after translations have been applied. See
271 `org-element-keyword-translation-alist'.
277 "List of affiliated keywords whose value can be parsed.
279 Their value will be stored as a secondary string: a list of
280 strings and objects.
282 This list is checked after translations have been applied. See
286 "List of affiliated keywords which can have a secondary value.
288 In Org syntax, they can be written with optional square brackets
289 before the colons. For example, RESULTS keyword can be
290 associated to a hash value with the following:
292 #+RESULTS[hash-string]: some-source
294 This list is checked after translations have been applied. See
298 "List of properties associated to the whole document.
299 Any keyword in this list will have its value parsed and stored as
313 ;; Ignore all links excepted plain links in a link description.
314 ;; Also ignore radio-targets and line breaks.
318 ;; Remove any variable object from radio target as it would
319 ;; prevent it from being properly recognized.
324 ;; Ignore inline babel call and inline src block as formulas are
325 ;; possible. Also ignore line breaks and statistics cookies.
331 "Alist of objects restrictions.
333 CAR is an element or object type containing objects and CDR is
334 a list of successors that will be called within an element or
335 object of such type.
337 For example, in a `radio-target' object, one can only find
338 entities, latex-fragments, subscript and superscript.
340 This alist also applies to secondary string. For example, an
341 `headline' type element doesn't directly contain objects, but
352 "List of buffer-local variables used when parsing objects.
353 These variables are copied to the temporary buffer created by
357 \f
358 ;;; Accessors and Setters
359 ;;
360 ;; Provide four accessors: `org-element-type', `org-element-property'
361 ;; `org-element-contents' and `org-element-restriction'.
362 ;;
363 ;; Setter functions allow to modify elements by side effect. There is
364 ;; `org-element-put-property', `org-element-set-contents',
365 ;; `org-element-set-element' and `org-element-adopt-element'. Note
366 ;; that `org-element-set-element' and `org-element-adopt-elements' are
367 ;; higher level functions since also update `:parent' property.
370 "Return type of ELEMENT.
372 The function returns the type of the element or object provided.
373 It can also return the following special value:
374 `plain-text' for a string
375 `org-data' for a complete document
376 nil in any other case."
382 "Extract the value from the PROPERTY of an ELEMENT."
387 "Extract contents from an ELEMENT."
393 "Return restriction associated to ELEMENT.
394 ELEMENT can be an element, an object or a symbol representing an
395 element or object type."
397 org-element-object-restrictions)))
400 "In ELEMENT set PROPERTY to VALUE.
401 Return modified element."
404 element))
407 "Set ELEMENT contents to CONTENTS.
408 Return modified element."
415 "Replace element or object OLD with element or object NEW.
416 The function takes care of setting `:parent' property for NEW."
417 ;; Since OLD is going to be changed into NEW by side-effect, first
418 ;; make sure that every element or object within NEW has OLD as
419 ;; parent.
422 ;; Transfer contents.
424 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
425 ;; with NEW's.
428 ;; Transfer type.
432 "Append elements to the contents of another element.
434 PARENT is an element or object. CHILDREN can be elements,
435 objects, or a strings.
437 The function takes care of setting `:parent' property for CHILD.
438 Return parent element."
439 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
440 ;; string: parent is the list itself.
443 children)
444 ;; Add CHILDREN at the end of PARENT contents.
447 parent
449 ;; Return modified PARENT element.
453 \f
454 ;;; Greater elements
455 ;;
456 ;; For each greater element type, we define a parser and an
457 ;; interpreter.
458 ;;
459 ;; A parser returns the element or object as the list described above.
460 ;; Most of them accepts no argument. Though, exceptions exist. Hence
461 ;; every element containing a secondary string (see
462 ;; `org-element-secondary-value-alist') will accept an optional
463 ;; argument to toggle parsing of that secondary string. Moreover,
464 ;; `item' parser requires current list's structure as its first
465 ;; element.
466 ;;
467 ;; An interpreter accepts two arguments: the list representation of
468 ;; the element or object, and its contents. The latter may be nil,
469 ;; depending on the element or object considered. It returns the
470 ;; appropriate Org syntax, as a string.
471 ;;
472 ;; Parsing functions must follow the naming convention:
473 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
474 ;; defined in `org-element-greater-elements'.
475 ;;
476 ;; Similarly, interpreting functions must follow the naming
477 ;; convention: org-element-TYPE-interpreter.
478 ;;
479 ;; With the exception of `headline' and `item' types, greater elements
480 ;; cannot contain other greater elements of their own type.
481 ;;
482 ;; Beside implementing a parser and an interpreter, adding a new
483 ;; greater element requires to tweak `org-element--current-element'.
484 ;; Moreover, the newly defined type must be added to both
485 ;; `org-element-all-elements' and `org-element-greater-elements'.
488 ;;;; Center Block
491 "Parse a center block.
493 LIMIT bounds the search. AFFILIATED is a list of which CAR is
494 the buffer position at the beginning of the first affiliated
495 keyword and CDR is a plist of affiliated keywords along with
496 their value.
498 Return a list whose CAR is `center-block' and CDR is a plist
499 containing `:begin', `:end', `:contents-begin', `:contents-end',
500 `:post-blank' and `:post-affiliated' keywords.
502 Assume point is at the beginning of the block."
506 ;; Incomplete block: parse it as a paragraph.
511 ;; Empty blocks have no contents.
525 :end end
526 :contents-begin contents-begin
527 :contents-end contents-end
533 "Interpret CENTER-BLOCK element as Org syntax.
534 CONTENTS is the contents of the element."
538 ;;;; Drawer
541 "Parse a drawer.
543 LIMIT bounds the search. AFFILIATED is a list of which CAR is
544 the buffer position at the beginning of the first affiliated
545 keyword and CDR is a plist of affiliated keywords along with
546 their value.
548 Return a list whose CAR is `drawer' and CDR is a plist containing
549 `:drawer-name', `:begin', `:end', `:contents-begin',
550 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
552 Assume point is at beginning of drawer."
555 ;; Incomplete drawer: parse it as a paragraph.
563 ;; Empty drawers have no contents.
576 :end end
577 :drawer-name name
578 :contents-begin contents-begin
579 :contents-end contents-end
585 "Interpret DRAWER element as Org syntax.
586 CONTENTS is the contents of the element."
589 contents))
592 ;;;; Dynamic Block
595 "Parse a dynamic block.
597 LIMIT bounds the search. AFFILIATED is a list of which CAR is
598 the buffer position at the beginning of the first affiliated
599 keyword and CDR is a plist of affiliated keywords along with
600 their value.
602 Return a list whose CAR is `dynamic-block' and CDR is a plist
603 containing `:block-name', `:begin', `:end', `:contents-begin',
604 `:contents-end', `:arguments', `:post-blank' and
605 `:post-affiliated' keywords.
607 Assume point is at beginning of dynamic block."
611 ;; Incomplete block: parse it as a paragraph.
620 ;; Empty blocks have no contents.
633 :end end
634 :block-name name
635 :arguments arguments
636 :contents-begin contents-begin
637 :contents-end contents-end
643 "Interpret DYNAMIC-BLOCK element as Org syntax.
644 CONTENTS is the contents of the element."
649 contents))
652 ;;;; Footnote Definition
655 "Parse a footnote definition.
657 LIMIT bounds the search. AFFILIATED is a list of which CAR is
658 the buffer position at the beginning of the first affiliated
659 keyword and CDR is a plist of affiliated keywords along with
660 their value.
662 Return a list whose CAR is `footnote-definition' and CDR is
663 a plist containing `:label', `:begin' `:end', `:contents-begin',
664 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
666 Assume point is at the beginning of the footnote definition."
694 :begin begin
695 :end end
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
704 CONTENTS is the contents of the footnote-definition."
706 " "
707 contents))
710 ;;;; Headline
713 "Parse a headline.
715 Return a list whose CAR is `headline' and CDR is a plist
716 containing `:raw-value', `:title', `:alt-title', `:begin',
717 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
718 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
719 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
720 `:commentedp' and `:footnote-section-p' keywords.
722 The plist also contains any property set in the property drawer,
723 with its name in upper cases and colons added at the
724 beginning (i.e. `:CUSTOM_ID').
726 When RAW-SECONDARY-P is non-nil, headline's title will not be
727 parsed as a secondary string, but as a plain string instead.
729 Assume point is at beginning of the headline."
742 raw-value)))
746 raw-value)))
750 ;; Upcase property names. It avoids confusion between
751 ;; properties obtained through property drawer and default
752 ;; properties from the parser (e.g. `:end' and :END:)
762 plist))
764 ;; Read time properties on the line below the headline.
770 org-keyword-time-not-clock-regexp end t)
780 plist))))
792 ;; Clean RAW-VALUE from any quote or comment string.
800 ""
801 raw-value))))
802 ;; Clean TAGS from archive tag, if any.
808 :begin begin
809 :end end
810 :pre-blank
813 :contents-begin contents-begin
814 :contents-end contents-end
815 :level level
817 :tags tags
818 :todo-keyword todo
819 :todo-type todo-type
825 end)
826 :footnote-section-p footnote-section-p
827 :archivedp archivedp
828 :commentedp commentedp
830 time-props
831 standard-props))))
835 headline :alt-title
840 headline :title
846 "Interpret HEADLINE element as Org syntax.
847 CONTENTS is the contents of the element."
874 ;; Align tags.
882 ? )
883 tags))
887 tags))))
889 contents)))
892 ;;;; Inlinetask
895 "Parse an inline task.
897 Return a list whose CAR is `inlinetask' and CDR is a plist
898 containing `:title', `:begin', `:end', `:contents-begin' and
899 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
900 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
901 `:closed' and `:post-blank' keywords.
903 The plist also contains any property set in the property drawer,
904 with its name in upper cases and colons added at the
905 beginning (i.e. `:CUSTOM_ID').
907 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
908 title will not be parsed as a secondary string, but as a plain
909 string instead.
911 Assume point is at beginning of the inline task."
921 ;; Upcase property names. It avoids confusion between
922 ;; properties obtained through property drawer and default
923 ;; properties from the parser (e.g. `:end' and :END:)
933 plist))
935 ;; Read time properties on the line below the inlinetask
936 ;; opening string.
942 org-keyword-time-not-clock-regexp end t)
952 plist))))
970 :begin begin
971 :end end
972 :contents-begin contents-begin
973 :contents-end contents-end
976 :tags tags
977 :todo-keyword todo
978 :todo-type todo-type
980 time-props
981 standard-props))))
983 inlinetask :title
986 raw-value
988 inlinetask))))))
991 "Interpret INLINETASK element as Org syntax.
992 CONTENTS is the contents of inlinetask."
1007 ;; Align tags.
1015 ? )
1016 tags))
1020 tags))))
1021 ;; Prefer degenerate inlinetasks when there are no
1022 ;; contents.
1025 contents
1029 ;;;; Item
1032 "Parse an item.
1034 STRUCT is the structure of the plain list.
1036 Return a list whose CAR is `item' and CDR is a plist containing
1037 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1038 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1039 keywords.
1041 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1042 any, will not be parsed as a secondary string, but as a plain
1043 string instead.
1045 Assume point is at the beginning of the item."
1069 ;; Ignore tags in un-ordered lists: they are just
1070 ;; a part of item's body.
1076 ;; If first line isn't empty, contents really start
1077 ;; at the text after item's meta-data.
1086 :begin begin
1087 :end end
1088 ;; CONTENTS-BEGIN and CONTENTS-END may be
1089 ;; mixed up in the case of an empty item
1090 ;; separated from the next by a blank line.
1091 ;; Thus ensure the former is always the
1092 ;; smallest.
1095 :checkbox checkbox
1096 :counter counter
1097 :structure struct
1100 item :tag
1108 "Interpret ITEM element as Org syntax.
1109 CONTENTS is the contents of the element."
1119 ;; Compute indentation.
1124 ;; Indent contents.
1126 bullet
1140 ;;;; Plain List
1143 ;; Return structure of list at point. Internal function. See
1144 ;; `org-list-struct' for details.
1149 items struct)
1154 ;; At limit: end all items.
1163 ;; At list end: end all items.
1168 ;; At a new item: end previous sibling.
1180 ind
1181 bullet
1184 ;; Description tag.
1188 ;; Ending position, unknown so far.
1189 nil)))
1190 items))
1192 ;; Skip empty lines.
1194 ;; Skip inline tasks and blank lines along the way.
1201 ;; At some text line. Check if it ends any previous item.
1213 ;; Skip blocks (any type) and drawers contents.
1219 limit t)))
1225 "Parse a plain list.
1227 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1228 the buffer position at the beginning of the first affiliated
1229 keyword and CDR is a plist of affiliated keywords along with
1230 their value. STRUCTURE is the structure of the plain list being
1231 parsed.
1233 Return a list whose CAR is `plain-list' and CDR is a plist
1234 containing `:type', `:begin', `:end', `:contents-begin' and
1235 `:contents-end', `:structure', `:post-blank' and
1236 `:post-affiliated' keywords.
1238 Assume point is at the beginning of the list."
1252 pos))
1256 ;; Return value.
1260 :begin begin
1261 :end end
1262 :contents-begin contents-begin
1263 :contents-end contents-end
1264 :structure struct
1270 "Interpret PLAIN-LIST element as Org syntax.
1271 CONTENTS is the contents of the element."
1279 ;;;; Property Drawer
1282 "Parse a property drawer.
1284 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1285 the buffer position at the beginning of the first affiliated
1286 keyword and CDR is a plist of affiliated keywords along with
1287 their value.
1289 Return a list whose CAR is `property-drawer' and CDR is a plist
1290 containing `:begin', `:end', `:contents-begin', `:contents-end',
1291 `:post-blank' and `:post-affiliated' keywords.
1293 Assume point is at the beginning of the property drawer."
1298 ;; Incomplete drawer: parse it as a paragraph.
1316 :end end
1317 :contents-begin contents-begin
1318 :contents-end contents-end
1324 "Interpret PROPERTY-DRAWER element as Org syntax.
1325 CONTENTS is the properties within the drawer."
1329 ;;;; Quote Block
1332 "Parse a quote block.
1334 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1335 the buffer position at the beginning of the first affiliated
1336 keyword and CDR is a plist of affiliated keywords along with
1337 their value.
1339 Return a list whose CAR is `quote-block' and CDR is a plist
1340 containing `:begin', `:end', `:contents-begin', `:contents-end',
1341 `:post-blank' and `:post-affiliated' keywords.
1343 Assume point is at the beginning of the block."
1347 ;; Incomplete block: parse it as a paragraph.
1353 ;; Empty blocks have no contents.
1366 :end end
1367 :contents-begin contents-begin
1368 :contents-end contents-end
1374 "Interpret QUOTE-BLOCK element as Org syntax.
1375 CONTENTS is the contents of the element."
1379 ;;;; Section
1382 "Parse a section.
1384 LIMIT bounds the search.
1386 Return a list whose CAR is `section' and CDR is a plist
1387 containing `:begin', `:end', `:contents-begin', `contents-end'
1388 and `:post-blank' keywords."
1390 ;; Beginning of section is the beginning of the first non-blank
1391 ;; line after previous headline.
1400 :end end
1401 :contents-begin begin
1402 :contents-end pos-before-blank
1406 "Interpret SECTION element as Org syntax.
1407 CONTENTS is the contents of the element."
1408 contents)
1411 ;;;; Special Block
1414 "Parse a special 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 `special-block' and CDR is a plist
1422 containing `:type', `:begin', `:end', `:contents-begin',
1423 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1425 Assume point is at the beginning of the block."
1432 limit t)))
1433 ;; Incomplete block: parse it as a paragraph.
1439 ;; Empty blocks have no contents.
1452 :begin begin
1453 :end end
1454 :contents-begin contents-begin
1455 :contents-end contents-end
1461 "Interpret SPECIAL-BLOCK element as Org syntax.
1462 CONTENTS is the contents of the element."
1467 \f
1468 ;;; Elements
1469 ;;
1470 ;; For each element, a parser and an interpreter are also defined.
1471 ;; Both follow the same naming convention used for greater elements.
1472 ;;
1473 ;; Also, as for greater elements, adding a new element type is done
1474 ;; through the following steps: implement a parser and an interpreter,
1475 ;; tweak `org-element--current-element' so that it recognizes the new
1476 ;; type and add that new type to `org-element-all-elements'.
1477 ;;
1478 ;; As a special case, when the newly defined type is a block type,
1479 ;; `org-element-block-name-alist' has to be modified accordingly.
1482 ;;;; Babel Call
1485 "Parse a babel call.
1487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1488 the buffer position at the beginning of the first affiliated
1489 keyword and CDR is a plist of affiliated keywords along with
1490 their value.
1492 Return a list whose CAR is `babel-call' and CDR is a plist
1493 containing `:begin', `:end', `:value', `:post-blank' and
1494 `:post-affiliated' as keywords."
1508 :end end
1509 :value value
1515 "Interpret BABEL-CALL element as Org syntax.
1516 CONTENTS is nil."
1520 ;;;; Clock
1523 "Parse a clock.
1525 LIMIT bounds the search.
1527 Return a list whose CAR is `clock' and CDR is a plist containing
1528 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1529 as keywords."
1549 :value value
1550 :duration duration
1551 :begin begin
1552 :end end
1556 "Interpret CLOCK element as Org syntax.
1557 CONTENTS is nil."
1565 "%2s:%02s"
1569 ;;;; Comment
1572 "Parse a comment.
1574 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1575 the buffer position at the beginning of the first affiliated
1576 keyword and CDR is a plist of affiliated keywords along with
1577 their value.
1579 Return a list whose CAR is `comment' and CDR is a plist
1580 containing `:begin', `:end', `:value', `:post-blank',
1581 `:post-affiliated' keywords.
1583 Assume point is at comment beginning."
1592 ;; Get comments ending.
1595 ;; Accumulate lines without leading hash and first
1596 ;; whitespace.
1610 :end end
1611 :value value
1617 "Interpret COMMENT element as Org syntax.
1618 CONTENTS is nil."
1622 ;;;; Comment Block
1625 "Parse an export block.
1627 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1628 the buffer position at the beginning of the first affiliated
1629 keyword and CDR is a plist of affiliated keywords along with
1630 their value.
1632 Return a list whose CAR is `comment-block' and CDR is a plist
1633 containing `:begin', `:end', `:value', `:post-blank' and
1634 `:post-affiliated' keywords.
1636 Assume point is at comment block beginning."
1640 ;; Incomplete block: parse it as a paragraph.
1653 contents-begin contents-end)))
1657 :end end
1658 :value value
1664 "Interpret COMMENT-BLOCK element as Org syntax.
1665 CONTENTS is nil."
1670 ;;;; Diary Sexp
1673 "Parse a diary sexp.
1675 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1676 the buffer position at the beginning of the first affiliated
1677 keyword and CDR is a plist of affiliated keywords along with
1678 their value.
1680 Return a list whose CAR is `diary-sexp' and CDR is a plist
1681 containing `:begin', `:end', `:value', `:post-blank' and
1682 `:post-affiliated' keywords."
1694 :begin begin
1695 :end end
1701 "Interpret DIARY-SEXP as Org syntax.
1702 CONTENTS is nil."
1706 ;;;; Example Block
1709 "Parse an example block.
1711 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1712 the buffer position at the beginning of the first affiliated
1713 keyword and CDR is a plist of affiliated keywords along with
1714 their value.
1716 Return a list whose CAR is `example-block' and CDR is a plist
1717 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1718 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1719 `:value', `:post-blank' and `:post-affiliated' keywords."
1723 ;; Incomplete block: parse it as a paragraph.
1731 ;; Switches analysis
1738 ;; Should labels be retained in (or stripped from) example
1739 ;; blocks?
1744 ;; What should code-references use - labels or
1745 ;; line-numbers?
1754 ;; Standard block parsing.
1762 contents-begin contents-end))
1763 block-ind))
1772 :end end
1773 :value value
1774 :switches switches
1775 :number-lines number-lines
1776 :preserve-indent preserve-indent
1777 :retain-labels retain-labels
1778 :use-labels use-labels
1779 :label-fmt label-fmt
1785 "Interpret EXAMPLE-BLOCK element as Org syntax.
1786 CONTENTS is nil."
1793 value
1798 ;;;; Export Block
1801 "Parse an export block.
1803 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1804 the buffer position at the beginning of the first affiliated
1805 keyword and CDR is a plist of affiliated keywords along with
1806 their value.
1808 Return a list whose CAR is `export-block' and CDR is a plist
1809 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1810 `:post-affiliated' keywords.
1812 Assume point is at export-block beginning."
1819 ;; Incomplete block: parse it as a paragraph.
1832 contents-end)))
1836 :end end
1837 :type type
1838 :value value
1844 "Interpret EXPORT-BLOCK element as Org syntax.
1845 CONTENTS is nil."
1852 ;;;; Fixed-width
1855 "Parse a fixed-width section.
1857 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1858 the buffer position at the beginning of the first affiliated
1859 keyword and CDR is a plist of affiliated keywords along with
1860 their value.
1862 Return a list whose CAR is `fixed-width' and CDR is a plist
1863 containing `:begin', `:end', `:value', `:post-blank' and
1864 `:post-affiliated' keywords.
1866 Assume point is at the beginning of the fixed-width area."
1870 value
1875 ;; Accumulate text without starting colons.
1888 :end end
1889 :value value
1895 "Interpret FIXED-WIDTH element as Org syntax.
1896 CONTENTS is nil."
1904 ;;;; Horizontal Rule
1907 "Parse an horizontal rule.
1909 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1910 the buffer position at the beginning of the first affiliated
1911 keyword and CDR is a plist of affiliated keywords along with
1912 their value.
1914 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1915 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1916 keywords."
1926 :end end
1932 "Interpret HORIZONTAL-RULE element as Org syntax.
1933 CONTENTS is nil."
1937 ;;;; Keyword
1940 "Parse a keyword at point.
1942 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1943 the buffer position at the beginning of the first affiliated
1944 keyword and CDR is a plist of affiliated keywords along with
1945 their value.
1947 Return a list whose CAR is `keyword' and CDR is a plist
1948 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1949 `:post-affiliated' keywords."
1963 :value value
1964 :begin begin
1965 :end end
1971 "Interpret KEYWORD element as Org syntax.
1972 CONTENTS is nil."
1978 ;;;; Latex Environment
1981 "Parse a LaTeX environment.
1983 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1984 the buffer position at the beginning of the first affiliated
1985 keyword and CDR is a plist of affiliated keywords along with
1986 their value.
1988 Return a list whose CAR is `latex-environment' and CDR is a plist
1989 containing `:begin', `:end', `:value', `:post-blank' and
1990 `:post-affiliated' keywords.
1992 Assume point is at the beginning of the latex environment."
1999 limit t))
2000 ;; Incomplete latex environment: parse it as a paragraph.
2010 :end end
2011 :value value
2017 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2018 CONTENTS is nil."
2022 ;;;; Node Property
2025 "Parse a node-property at point.
2027 LIMIT bounds the search.
2029 Return a list whose CAR is `node-property' and CDR is a plist
2030 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2031 keywords."
2043 :value value
2044 :begin begin
2045 :end end
2049 "Interpret NODE-PROPERTY element as Org syntax.
2050 CONTENTS is nil."
2056 ;;;; Paragraph
2059 "Parse a paragraph.
2061 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2062 the buffer position at the beginning of the first affiliated
2063 keyword and CDR is a plist of affiliated keywords along with
2064 their value.
2066 Return a list whose CAR is `paragraph' and CDR is a plist
2067 containing `:begin', `:end', `:contents-begin' and
2068 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2070 Assume point is at the beginning of the paragraph."
2079 limit
2080 ;; A matching `org-element-paragraph-separate' is not
2081 ;; necessarily the end of the paragraph. In
2082 ;; particular, lines starting with # or : as a first
2083 ;; non-space character are ambiguous. We have check
2084 ;; if they are valid Org syntax (i.e. not an
2085 ;; incomplete keyword).
2089 ;; There's no ambiguity for other symbols or
2090 ;; empty lines: stop here.
2092 ;; Stop at valid fixed-width areas.
2094 ;; Stop at drawers.
2099 ;; Stop at valid comments.
2101 ;; Stop at valid dynamic blocks.
2106 ;; Stop at valid blocks.
2113 limit t)))
2114 ;; Stop at valid latex environments.
2122 limit t)))
2123 ;; Stop at valid keywords.
2125 ;; Skip everything else.
2142 :end end
2143 :contents-begin contents-begin
2144 :contents-end contents-end
2150 "Interpret PARAGRAPH element as Org syntax.
2151 CONTENTS is the contents of the element."
2152 contents)
2155 ;;;; Planning
2158 "Parse a planning.
2160 LIMIT bounds the search.
2162 Return a list whose CAR is `planning' and CDR is a plist
2163 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2164 and `:post-blank' keywords."
2174 closed deadline scheduled)
2186 :deadline deadline
2187 :scheduled scheduled
2188 :begin begin
2189 :end end
2193 "Interpret PLANNING element as Org syntax.
2194 CONTENTS is nil."
2196 'identity
2213 ;;;; Quote Section
2216 "Parse a quote section.
2218 LIMIT bounds the search.
2220 Return a list whose CAR is `quote-section' and CDR is a plist
2221 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2223 Assume point is at beginning of the section."
2234 :end end
2235 :value value
2239 "Interpret QUOTE-SECTION element as Org syntax.
2240 CONTENTS is nil."
2244 ;;;; Src Block
2247 "Parse a src block.
2249 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2250 the buffer position at the beginning of the first affiliated
2251 keyword and CDR is a plist of affiliated keywords along with
2252 their value.
2254 Return a list whose CAR is `src-block' and CDR is a plist
2255 containing `:language', `:switches', `:parameters', `:begin',
2256 `:end', `:number-lines', `:retain-labels', `:use-labels',
2257 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2258 `:post-affiliated' keywords.
2260 Assume point is at the beginning of the block."
2263 limit t)))
2264 ;; Incomplete block: parse it as a paragraph.
2270 ;; Get language as a string.
2279 ;; Get switches.
2281 ;; Get parameters.
2283 ;; Switches analysis
2294 ;; Should labels be retained in (or stripped from)
2295 ;; src blocks?
2300 ;; What should code-references use - labels or
2301 ;; line-numbers?
2306 ;; Indentation.
2308 ;; Retrieve code.
2313 block-ind))
2317 ;; Get position after ending blank lines.
2327 :begin begin
2328 :end end
2329 :number-lines number-lines
2330 :preserve-indent preserve-indent
2331 :retain-labels retain-labels
2332 :use-labels use-labels
2333 :label-fmt label-fmt
2334 :value value
2340 "Interpret SRC-BLOCK element as Org syntax.
2341 CONTENTS is nil."
2350 val)
2364 ;;;; Table
2367 "Parse a table at point.
2369 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2370 the buffer position at the beginning of the first affiliated
2371 keyword and CDR is a plist of affiliated keywords along with
2372 their value.
2374 Return a list whose CAR is `table' and CDR is a plist containing
2375 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2376 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2377 keywords.
2379 Assume point is at the beginning of the table."
2393 acc))
2400 :end end
2401 :type type
2402 :tblfm tblfm
2403 ;; Only `org' tables have contents. `table.el' tables
2404 ;; use a `:value' property to store raw table as
2405 ;; a string.
2410 table-begin table-end))
2416 "Interpret TABLE element as Org syntax.
2417 CONTENTS is nil."
2428 ;;;; Table Row
2431 "Parse table row at point.
2433 LIMIT bounds the search.
2435 Return a list whose CAR is `table-row' and CDR is a plist
2436 containing `:begin', `:end', `:contents-begin', `:contents-end',
2437 `:type' and `:post-blank' keywords."
2441 ;; A table rule has no contents. In that case, ensure
2442 ;; CONTENTS-BEGIN matches CONTENTS-END.
2454 :begin begin
2455 :end end
2456 :contents-begin contents-begin
2457 :contents-end contents-end
2461 "Interpret TABLE-ROW element as Org syntax.
2462 CONTENTS is the contents of the table row."
2467 ;;;; Verse Block
2470 "Parse a verse block.
2472 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2473 the buffer position at the beginning of the first affiliated
2474 keyword and CDR is a plist of affiliated keywords along with
2475 their value.
2477 Return a list whose CAR is `verse-block' and CDR is a plist
2478 containing `:begin', `:end', `:contents-begin', `:contents-end',
2479 `:post-blank' and `:post-affiliated' keywords.
2481 Assume point is at beginning of the block."
2485 ;; Incomplete block: parse it as a paragraph.
2500 :end end
2501 :contents-begin contents-begin
2502 :contents-end contents-end
2508 "Interpret VERSE-BLOCK element as Org syntax.
2509 CONTENTS is verse block contents."
2513 \f
2514 ;;; Objects
2515 ;;
2516 ;; Unlike to elements, interstices can be found between objects.
2517 ;; That's why, along with the parser, successor functions are provided
2518 ;; for each object. Some objects share the same successor (i.e. `code'
2519 ;; and `verbatim' objects).
2520 ;;
2521 ;; A successor must accept a single argument bounding the search. It
2522 ;; will return either a cons cell whose CAR is the object's type, as
2523 ;; a symbol, and CDR the position of its next occurrence, or nil.
2524 ;;
2525 ;; Successors follow the naming convention:
2526 ;; org-element-NAME-successor, where NAME is the name of the
2527 ;; successor, as defined in `org-element-all-successors'.
2528 ;;
2529 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2530 ;; object types they can contain will be specified in
2531 ;; `org-element-object-restrictions'.
2532 ;;
2533 ;; Adding a new type of object is simple. Implement a successor,
2534 ;; a parser, and an interpreter for it, all following the naming
2535 ;; convention. Register type in `org-element-all-objects' and
2536 ;; successor in `org-element-all-successors'. Maybe tweak
2537 ;; restrictions about it, and that's it.
2540 ;;;; Bold
2543 "Parse bold object at point.
2545 Return a list whose CAR is `bold' and CDR is a plist with
2546 `:begin', `:end', `:contents-begin' and `:contents-end' and
2547 `:post-blank' keywords.
2549 Assume point is at the first star marker."
2561 :end end
2562 :contents-begin contents-begin
2563 :contents-end contents-end
2567 "Interpret BOLD object as Org syntax.
2568 CONTENTS is the contents of the object."
2572 "Search for the next text-markup object.
2574 Return value is a cons cell whose CAR is a symbol among `bold',
2575 `italic', `underline', `strike-through', `code' and `verbatim'
2576 and CDR is beginning position."
2592 ;;;; Code
2595 "Parse code object at point.
2597 Return a list whose CAR is `code' and CDR is a plist with
2598 `:value', `:begin', `:end' and `:post-blank' keywords.
2600 Assume point is at the first tilde marker."
2611 :begin begin
2612 :end end
2616 "Interpret CODE object as Org syntax.
2617 CONTENTS is nil."
2621 ;;;; Entity
2624 "Parse entity at point.
2626 Return a list whose CAR is `entity' and CDR a plist with
2627 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2628 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2629 keywords.
2631 Assume point is at the beginning of the entity."
2633 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2649 :begin begin
2650 :end end
2651 :use-brackets-p bracketsp
2655 "Interpret ENTITY object as Org syntax.
2656 CONTENTS is nil."
2662 "Search for the next latex-fragment or entity object.
2664 Return value is a cons cell whose CAR is `entity' or
2665 `latex-fragment' and CDR is beginning position."
2669 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2676 ;; Determine if it's a real entity or a LaTeX command.
2679 ;; No entity nor command: point is at a LaTeX fragment.
2680 ;; Determine its type to get the correct beginning position.
2689 ;;;; Export Snippet
2692 "Parse export snippet at point.
2694 Return a list whose CAR is `export-snippet' and CDR a plist with
2695 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2696 keywords.
2698 Assume point is at the beginning of the snippet."
2710 :value value
2711 :begin begin
2712 :end end
2716 "Interpret EXPORT-SNIPPET object as Org syntax.
2717 CONTENTS is nil."
2723 "Search for the next export-snippet object.
2725 Return value is a cons cell whose CAR is `export-snippet' and CDR
2726 its beginning position."
2735 ;;;; Footnote Reference
2738 "Parse footnote reference at point.
2740 Return a list whose CAR is `footnote-reference' and CDR a plist
2741 with `:label', `:type', `:inline-definition', `:begin', `:end'
2742 and `:post-blank' as keywords."
2764 :type type
2765 :begin begin
2766 :end end
2769 footnote-reference :inline-definition
2774 footnote-reference))))))
2777 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2778 CONTENTS is nil."
2788 "Search for the next footnote-reference object.
2790 Return value is a cons cell whose CAR is `footnote-reference' and
2791 CDR is beginning position."
2805 ;;;; Inline Babel Call
2808 "Parse inline babel call at point.
2810 Return a list whose CAR is `inline-babel-call' and CDR a plist
2811 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2813 Assume point is at the beginning of the babel call."
2825 :end end
2826 :value value
2830 "Interpret INLINE-BABEL-CALL object as Org syntax.
2831 CONTENTS is nil."
2835 "Search for the next inline-babel-call object.
2837 Return value is a cons cell whose CAR is `inline-babel-call' and
2838 CDR is beginning position."
2840 ;; Use a simplified version of
2841 ;; `org-babel-inline-lob-one-liner-regexp'.
2844 nil t)
2848 ;;;; Inline Src Block
2851 "Parse inline source block at point.
2853 Return a list whose CAR is `inline-src-block' and CDR a plist
2854 with `:begin', `:end', `:language', `:value', `:parameters' and
2855 `:post-blank' as keywords.
2857 Assume point is at the beginning of the inline src block."
2870 :value value
2871 :parameters parameters
2872 :begin begin
2873 :end end
2877 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2878 CONTENTS is nil."
2883 language
2885 body)))
2888 "Search for the next inline-babel-call element.
2890 Return value is a cons cell whose CAR is `inline-babel-call' and
2891 CDR is beginning position."
2897 ;;;; Italic
2900 "Parse italic object at point.
2902 Return a list whose CAR is `italic' and CDR is a plist with
2903 `:begin', `:end', `:contents-begin' and `:contents-end' and
2904 `:post-blank' keywords.
2906 Assume point is at the first slash marker."
2918 :end end
2919 :contents-begin contents-begin
2920 :contents-end contents-end
2924 "Interpret ITALIC object as Org syntax.
2925 CONTENTS is the contents of the object."
2929 ;;;; Latex Fragment
2932 "Parse LaTeX fragment at point.
2934 Return a list whose CAR is `latex-fragment' and CDR a plist with
2935 `:value', `:begin', `:end', and `:post-blank' as keywords.
2937 Assume point is at the beginning of the LaTeX fragment."
2950 ;; None found: it's a macro.
2959 :begin begin
2960 :end end
2964 "Interpret LATEX-FRAGMENT object as Org syntax.
2965 CONTENTS is nil."
2968 ;;;; Line Break
2971 "Parse line break at point.
2973 Return a list whose CAR is `line-break', and CDR a plist with
2974 `:begin', `:end' and `:post-blank' keywords.
2976 Assume point is at the beginning of the line break."
2983 "Interpret LINE-BREAK object as Org syntax.
2984 CONTENTS is nil."
2988 "Search for the next line-break object.
2990 Return value is a cons cell whose CAR is `line-break' and CDR is
2991 beginning position."
2995 ;; A line break can only happen on a non-empty line.
3000 ;;;; Link
3003 "Parse link at point.
3005 Return a list whose CAR is `link' and CDR a plist with `:type',
3006 `:path', `:raw-link', `:application', `:search-option', `:begin',
3007 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3008 keywords.
3010 Assume point is at the beginning of the link."
3013 end contents-begin contents-end link-end post-blank path type
3014 raw-link link search-option application)
3016 ;; Type 1: Text targeted from a radio target.
3021 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3026 ;; RAW-LINK is the original link. Expand any
3027 ;; abbreviation in it.
3031 ;; Determine TYPE of link and set PATH accordingly.
3033 ;; File type.
3037 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3040 ;; Id type: PATH is the id.
3043 ;; Code-ref type: PATH is the name of the reference.
3046 ;; Custom-id type: PATH is the name of the custom id.
3049 ;; Fuzzy type: Internal link either matches a target, an
3050 ;; headline name or nothing. PATH is the target or
3051 ;; headline's name.
3053 ;; Type 3: Plain link, i.e. http://orgmode.org
3059 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3066 ;; In any case, deduce end point after trailing white space from
3067 ;; LINK-END variable.
3070 ;; Extract search option and opening application out of
3071 ;; "file"-type links.
3073 ;; Application.
3078 ;; Extract search option from PATH.
3082 ;; Make sure TYPE always reports "file".
3086 :path path
3088 :application application
3089 :search-option search-option
3090 :begin begin
3091 :end end
3092 :contents-begin contents-begin
3093 :contents-end contents-end
3097 "Interpret LINK object as Org syntax.
3098 CONTENTS is the contents of the object, or nil."
3103 raw-link
3107 "Search for the next link object.
3109 Return value is a cons cell whose CAR is `link' and CDR is
3110 beginning position."
3119 "Search for the next plain link object.
3121 Return value is a cons cell whose CAR is `link' and CDR is
3122 beginning position."
3127 ;;;; Macro
3130 "Parse macro at point.
3132 Return a list whose CAR is `macro' and CDR a plist with `:key',
3133 `:args', `:begin', `:end', `:value' and `:post-blank' as
3134 keywords.
3136 Assume point is at the macro."
3147 ;; Do not use `org-split-string' since empty
3148 ;; strings are meaningful here.
3156 args nil t)
3160 :value value
3161 :args args
3162 :begin begin
3163 :end end
3167 "Interpret MACRO object as Org syntax.
3168 CONTENTS is nil."
3172 "Search for the next macro object.
3174 Return value is cons cell whose CAR is `macro' and CDR is
3175 beginning position."
3179 nil t)
3183 ;;;; Radio-target
3186 "Parse radio target at point.
3188 Return a list whose CAR is `radio-target' and CDR a plist with
3189 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3190 and `:post-blank' as keywords.
3192 Assume point is at the radio target."
3204 :end end
3205 :contents-begin contents-begin
3206 :contents-end contents-end
3207 :post-blank post-blank
3211 "Interpret TARGET object as Org syntax.
3212 CONTENTS is the contents of the object."
3216 "Search for the next radio-target object.
3218 Return value is a cons cell whose CAR is `radio-target' and CDR
3219 is beginning position."
3225 ;;;; Statistics Cookie
3228 "Parse statistics cookie at point.
3230 Return a list whose CAR is `statistics-cookie', and CDR a plist
3231 with `:begin', `:end', `:value' and `:post-blank' keywords.
3233 Assume point is at the beginning of the statistics-cookie."
3244 :end end
3245 :value value
3249 "Interpret STATISTICS-COOKIE object as Org syntax.
3250 CONTENTS is nil."
3254 "Search for the next statistics cookie object.
3256 Return value is a cons cell whose CAR is `statistics-cookie' and
3257 CDR is beginning position."
3263 ;;;; Strike-Through
3266 "Parse strike-through object at point.
3268 Return a list whose CAR is `strike-through' and CDR is a plist
3269 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3270 `:post-blank' keywords.
3272 Assume point is at the first plus sign marker."
3284 :end end
3285 :contents-begin contents-begin
3286 :contents-end contents-end
3290 "Interpret STRIKE-THROUGH object as Org syntax.
3291 CONTENTS is the contents of the object."
3295 ;;;; Subscript
3298 "Parse subscript at point.
3300 Return a list whose CAR is `subscript' and CDR a plist with
3301 `:begin', `:end', `:contents-begin', `:contents-end',
3302 `:use-brackets-p' and `:post-blank' as keywords.
3304 Assume point is at the underscore."
3308 t
3319 :end end
3320 :use-brackets-p bracketsp
3321 :contents-begin contents-begin
3322 :contents-end contents-end
3326 "Interpret SUBSCRIPT object as Org syntax.
3327 CONTENTS is the contents of the object."
3330 contents))
3333 "Search for the next sub/superscript object.
3335 Return value is a cons cell whose CAR is either `subscript' or
3336 `superscript' and CDR is beginning position."
3344 ;;;; Superscript
3347 "Parse superscript at point.
3349 Return a list whose CAR is `superscript' and CDR a plist with
3350 `:begin', `:end', `:contents-begin', `:contents-end',
3351 `:use-brackets-p' and `:post-blank' as keywords.
3353 Assume point is at the caret."
3367 :end end
3368 :use-brackets-p bracketsp
3369 :contents-begin contents-begin
3370 :contents-end contents-end
3374 "Interpret SUPERSCRIPT object as Org syntax.
3375 CONTENTS is the contents of the object."
3378 contents))
3381 ;;;; Table Cell
3384 "Parse table cell at point.
3386 Return a list whose CAR is `table-cell' and CDR is a plist
3387 containing `:begin', `:end', `:contents-begin', `:contents-end'
3388 and `:post-blank' keywords."
3396 :end end
3397 :contents-begin contents-begin
3398 :contents-end contents-end
3402 "Interpret TABLE-CELL element as Org syntax.
3403 CONTENTS is the contents of the cell, or nil."
3407 "Search for the next table-cell object.
3409 Return value is a cons cell whose CAR is `table-cell' and CDR is
3410 beginning position."
3414 ;;;; Target
3417 "Parse target at point.
3419 Return a list whose CAR is `target' and CDR a plist with
3420 `:begin', `:end', `:value' and `:post-blank' as keywords.
3422 Assume point is at the target."
3432 :end end
3433 :value value
3437 "Interpret TARGET object as Org syntax.
3438 CONTENTS is nil."
3442 "Search for the next target object.
3444 Return value is a cons cell whose CAR is `target' and CDR is
3445 beginning position."
3451 ;;;; Timestamp
3454 "Parse time stamp at point.
3456 Return a list whose CAR is `timestamp', and CDR a plist with
3457 `:type', `:raw-value', `:year-start', `:month-start',
3458 `:day-start', `:hour-start', `:minute-start', `:year-end',
3459 `:month-end', `:day-end', `:hour-end', `:minute-end',
3460 `:repeater-type', `:repeater-value', `:repeater-unit',
3461 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3462 `:end', `:value' and `:post-blank' keywords.
3464 Assume point is at the beginning of the timestamp."
3482 date-start)
3493 raw-value)
3495 :repeater-type
3501 :repeater-unit
3510 :warning-unit
3513 year-start month-start day-start hour-start minute-start year-end
3514 month-end day-end hour-end minute-end)
3515 ;; Parse date-start.
3523 ;; Compute date-end. It can be provided directly in time-stamp,
3524 ;; or extracted from time range. Otherwise, it defaults to the
3525 ;; same values as date-start.
3535 :raw-value raw-value
3536 :year-start year-start
3537 :month-start month-start
3538 :day-start day-start
3539 :hour-start hour-start
3540 :minute-start minute-start
3541 :year-end year-end
3542 :month-end month-end
3543 :day-end day-end
3544 :hour-end hour-end
3545 :minute-end minute-end
3546 :begin begin
3547 :end end
3549 repeater-props
3550 warning-props)))))
3553 "Interpret TIMESTAMP object as Org syntax.
3554 CONTENTS is nil."
3573 ;; Build an Org timestamp string from TIME. ACTIVEP is
3574 ;; non-nil when time stamp is active. If WITH-TIME-P is
3575 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3576 ;; specify a time range in the timestamp. REPEAT-STRING is
3577 ;; the repeater string, if any.
3581 org-time-stamp-formats)
3582 time)))
3588 nil nil ts)))
3593 " "
3594 s
3596 ;; Return value.
3597 ts)))
3609 build-ts-string
3628 0
3636 "--"
3648 "Search for the next timestamp object.
3650 Return value is a cons cell whose CAR is `timestamp' and CDR is
3651 beginning position."
3659 nil t)
3663 ;;;; Underline
3666 "Parse underline object at point.
3668 Return a list whose CAR is `underline' and CDR is a plist with
3669 `:begin', `:end', `:contents-begin' and `:contents-end' and
3670 `:post-blank' keywords.
3672 Assume point is at the first underscore marker."
3684 :end end
3685 :contents-begin contents-begin
3686 :contents-end contents-end
3690 "Interpret UNDERLINE object as Org syntax.
3691 CONTENTS is the contents of the object."
3695 ;;;; Verbatim
3698 "Parse verbatim object at point.
3700 Return a list whose CAR is `verbatim' and CDR is a plist with
3701 `:value', `:begin', `:end' and `:post-blank' keywords.
3703 Assume point is at the first equal sign marker."
3714 :begin begin
3715 :end end
3719 "Interpret VERBATIM object as Org syntax.
3720 CONTENTS is nil."
3724 \f
3725 ;;; Parsing Element Starting At Point
3726 ;;
3727 ;; `org-element--current-element' is the core function of this section.
3728 ;; It returns the Lisp representation of the element starting at
3729 ;; point.
3730 ;;
3731 ;; `org-element--current-element' makes use of special modes. They
3732 ;; are activated for fixed element chaining (i.e. `plain-list' >
3733 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3734 ;; `section'). Special modes are: `first-section', `item',
3735 ;; `node-property', `quote-section', `section' and `table-row'.
3739 "Parse the element starting at point.
3741 Return value is a list like (TYPE PROPS) where TYPE is the type
3742 of the element and PROPS a plist of properties associated to the
3743 element.
3745 Possible types are defined in `org-element-all-elements'.
3747 LIMIT bounds the search.
3749 Optional argument GRANULARITY determines the depth of the
3750 recursion. Allowed values are `headline', `greater-element',
3751 `element', `object' or nil. When it is broader than `object' (or
3752 nil), secondary values will not be parsed, since they only
3753 contain objects.
3755 Optional argument SPECIAL, when non-nil, can be either
3756 `first-section', `item', `node-property', `quote-section',
3757 `section', and `table-row'.
3759 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3760 be computed.
3762 This function assumes point is always at the beginning of the
3763 element it has to parse."
3766 ;; Determine if parsing depth allows for secondary strings
3767 ;; parsing. It only applies to elements referenced in
3768 ;; `org-element-secondary-value-alist'.
3771 ;; Item.
3774 ;; Table Row.
3776 ;; Node Property.
3778 ;; Headline.
3781 ;; Sections (must be checked after headline).
3787 limit)))
3788 ;; When not at bol, point is at the beginning of an item or
3789 ;; a footnote definition: next item is always a paragraph.
3791 ;; Planning and Clock.
3796 ;; Inlinetask.
3799 ;; From there, elements can have affiliated keywords.
3802 ;; Jumping over affiliated keywords put point off-limits.
3803 ;; Parse them as regular keywords.
3807 ;; LaTeX Environment.
3811 ;; Drawer and Property Drawer.
3816 ;; Fixed Width
3819 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3820 ;; Keywords.
3829 org-element-block-name-alist)))
3844 ;; Footnote Definition.
3847 ;; Horizontal Rule.
3850 ;; Diary Sexp.
3853 ;; Table.
3855 ;; List.
3858 limit affiliated
3860 ;; Default element: Paragraph.
3864 ;; Most elements can have affiliated keywords. When looking for an
3865 ;; element beginning, we want to move before them, as they belong to
3866 ;; that element, and, in the meantime, collect information they give
3867 ;; into appropriate properties. Hence the following function.
3870 "Collect affiliated keywords from point down to LIMIT.
3872 Return a list whose CAR is the position at the first of them and
3873 CDR a plist of keywords and values and move point to the
3874 beginning of the first line after them.
3876 As a special case, if element doesn't start at the beginning of
3877 the line (i.e. a paragraph starting an item), CAR is current
3878 position of point and CDR is nil."
3882 ;; RESTRICT is the list of objects allowed in parsed
3883 ;; keywords value.
3885 output)
3888 ;; Apply translation to RAW-KWD. From there, KWD is
3889 ;; the official keyword.
3891 org-element-keyword-translation-alist))
3892 raw-kwd))
3893 ;; Find main value for any keyword.
3899 ;; PARSEDP is non-nil when keyword should have its
3900 ;; value parsed.
3902 ;; If KWD is a dual keyword, find its secondary
3903 ;; value. Maybe parse it.
3910 ;; Attribute a property name to KWD.
3912 ;; Now set final shape for VALUE.
3918 ;; Attributes can always appear on multiple lines.
3921 ;; Eventually store the new value in OUTPUT.
3923 ;; Move to next keyword.
3925 ;; If affiliated keywords are orphaned: move back to first one.
3926 ;; They will be parsed as a paragraph.
3928 ;; Return value.
3932 \f
3933 ;;; The Org Parser
3934 ;;
3935 ;; The two major functions here are `org-element-parse-buffer', which
3936 ;; parses Org syntax inside the current buffer, taking into account
3937 ;; region, narrowing, or even visibility if specified, and
3938 ;; `org-element-parse-secondary-string', which parses objects within
3939 ;; a given string.
3940 ;;
3941 ;; The (almost) almighty `org-element-map' allows to apply a function
3942 ;; on elements or objects matching some type, and accumulate the
3943 ;; resulting values. In an export situation, it also skips unneeded
3944 ;; parts of the parse tree.
3947 "Recursively parse the buffer and return structure.
3948 If narrowing is in effect, only parse the visible part of the
3949 buffer.
3951 Optional argument GRANULARITY determines the depth of the
3952 recursion. It can be set to the following symbols:
3954 `headline' Only parse headlines.
3955 `greater-element' Don't recurse into greater elements excepted
3956 headlines and sections. Thus, elements
3957 parsed are the top-level ones.
3958 `element' Parse everything but objects and plain text.
3959 `object' Parse the complete buffer (default).
3961 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3962 elements.
3964 An element or an objects is represented as a list with the
3965 pattern (TYPE PROPERTIES CONTENTS), where :
3967 TYPE is a symbol describing the element or object. See
3968 `org-element-all-elements' and `org-element-all-objects' for an
3969 exhaustive list of such symbols. One can retrieve it with
3970 `org-element-type' function.
3972 PROPERTIES is the list of attributes attached to the element or
3973 object, as a plist. Although most of them are specific to the
3974 element or object type, all types share `:begin', `:end',
3975 `:post-blank' and `:parent' properties, which respectively
3976 refer to buffer position where the element or object starts,
3977 ends, the number of white spaces or blank lines after it, and
3978 the element or object containing it. Properties values can be
3979 obtained by using `org-element-property' function.
3981 CONTENTS is a list of elements, objects or raw strings
3982 contained in the current element or object, when applicable.
3983 One can access them with `org-element-contents' function.
3985 The Org buffer has `org-data' as type and nil as properties.
3986 `org-element-map' function can be used to find specific elements
3987 or objects within the parse tree.
3989 This function assumes that current major mode is `org-mode'."
3995 ;; Start in `first-section' mode so text before the first
3996 ;; headline belongs to a section.
4000 "Recursively parse objects in STRING and return structure.
4002 RESTRICTION is a symbol limiting the object types that will be
4003 looked after.
4005 Optional argument PARENT, when non-nil, is the element or object
4006 containing the secondary string. It is used to set correctly
4007 `:parent' property within the string."
4008 ;; Copy buffer-local variables listed in
4009 ;; `org-element-object-variables' into temporary buffer. This is
4010 ;; required since object parsing is dependent on these variables.
4014 org-element-object-variables))))
4022 secondary))
4023 secondary))))
4027 "Map a function on selected elements or objects.
4029 DATA is a parse tree, an element, an object, a string, or a list
4030 of such constructs. TYPES is a symbol or list of symbols of
4031 elements or objects types (see `org-element-all-elements' and
4032 `org-element-all-objects' for a complete list of types). FUN is
4033 the function called on the matching element or object. It has to
4034 accept one argument: the element or object itself.
4036 When optional argument INFO is non-nil, it should be a plist
4037 holding export options. In that case, parts of the parse tree
4038 not exportable according to that property list will be skipped.
4040 When optional argument FIRST-MATCH is non-nil, stop at the first
4041 match for which FUN doesn't return nil, and return that value.
4043 Optional argument NO-RECURSION is a symbol or a list of symbols
4044 representing elements or objects types. `org-element-map' won't
4045 enter any recursive element or object whose type belongs to that
4046 list. Though, FUN can still be applied on them.
4048 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4049 apply to matching objects within parsed affiliated keywords (see
4050 `org-element-parsed-keywords').
4052 Nil values returned from FUN do not appear in the results.
4055 Examples:
4056 ---------
4058 Assuming TREE is a variable containing an Org buffer parse tree,
4059 the following example will return a flat list of all `src-block'
4060 and `example-block' elements in it:
4062 \(org-element-map tree '(example-block src-block) 'identity)
4064 The following snippet will find the first headline with a level
4067 \(org-element-map tree 'headline
4068 \(lambda (hl)
4069 \(and (= (org-element-property :level hl) 1)
4071 \(org-element-property :begin hl)))
4072 nil t)
4074 The next example will return a flat list of all `plain-list' type
4075 elements in TREE that are not a sub-list themselves:
4077 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4079 Eventually, this example will return a flat list of all `bold'
4080 type objects containing a `latex-snippet' type object, even
4081 looking into captions:
4083 \(org-element-map tree 'bold
4084 \(lambda (b)
4085 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4086 nil nil nil t)"
4087 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4090 ;; Recursion depth is determined by --CATEGORY.
4097 ;; If one object is found, the function
4098 ;; has to recurse into every object.
4101 ;; If one regular element is found, the
4102 ;; function has to recurse, at least,
4103 ;; into every element it encounters.
4106 types)
4107 category)))
4108 ;; Compute properties for affiliated keywords if necessary.
4113 org-element-affiliated-keywords)))
4114 --acc
4115 --walk-tree
4119 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4120 ;; holding contextual information.
4124 ;; Ignored element in an export context.
4126 ;; List of elements or objects.
4128 ;; Unconditionally enter parse trees.
4132 ;; Check if TYPE is matching among TYPES. If so,
4133 ;; apply FUN to --DATA and accumulate return value
4134 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4140 ;; If --DATA has a secondary string that can contain
4141 ;; objects with their type among TYPES, look into it.
4148 ;; If --DATA has any affiliated keywords and
4149 ;; WITH-AFFILIATED is non-nil, look for objects in
4150 ;; them.
4158 ;; Pay attention to the type of value.
4159 ;; Preserve order for multiple keywords.
4175 --affiliated-alist))
4176 ;; Determine if a recursion into --DATA is possible.
4178 ;; --TYPE is explicitly removed from recursion.
4180 ;; --DATA has no contents.
4182 ;; Looking for greater elements but --DATA is simply
4183 ;; an element or an object.
4186 ;; Looking for elements but --DATA is an object.
4189 ;; In any other case, map contents.
4193 ;; Return value in a proper order.
4197 ;; The following functions are internal parts of the parser.
4198 ;;
4199 ;; The first one, `org-element--parse-elements' acts at the element's
4200 ;; level.
4201 ;;
4202 ;; The second one, `org-element--parse-objects' applies on all objects
4203 ;; of a paragraph or a secondary string. It uses
4204 ;; `org-element--get-next-object-candidates' to optimize the search of
4205 ;; the next object in the buffer.
4206 ;;
4207 ;; More precisely, that function looks for every allowed object type
4208 ;; first. Then, it discards failed searches, keeps further matches,
4209 ;; and searches again types matched behind point, for subsequent
4210 ;; calls. Thus, searching for a given type fails only once, and every
4211 ;; object is searched only once at top level (but sometimes more for
4212 ;; nested types).
4216 "Parse elements between BEG and END positions.
4218 SPECIAL prioritize some elements over the others. It can be set
4219 to `first-section', `quote-section', `section' `item' or
4220 `table-row'.
4222 When value is `item', STRUCTURE will be used as the current list
4223 structure.
4225 GRANULARITY determines the depth of the recursion. See
4226 `org-element-parse-buffer' for more information.
4228 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4229 elements.
4231 Elements are accumulated into ACC."
4234 ;; Visible only: skip invisible parts at the beginning of the
4235 ;; element.
4238 ;; When parsing only headlines, skip any text before first one.
4241 ;; Main loop start.
4243 ;; Find current element's type and parse it accordingly to
4244 ;; its category.
4246 end granularity special structure))
4250 ;; Visible only: skip invisible parts between siblings.
4253 ;; Fill ELEMENT contents by side-effect.
4255 ;; If element has no contents, don't modify it.
4257 ;; Greater element: parse it between `contents-begin' and
4258 ;; `contents-end'. Make sure GRANULARITY allows the
4259 ;; recursion, or ELEMENT is a headline, in which case going
4260 ;; inside is mandatory, in order to get sub-level headings.
4268 ;; Possibly switch to a special mode.
4278 granularity visible-only element))
4279 ;; ELEMENT has contents. Parse objects inside, if
4280 ;; GRANULARITY allows it.
4286 ;; Return result.
4287 acc))
4290 "Parse objects between BEG and END and return recursive structure.
4292 Objects are accumulated in ACC.
4294 RESTRICTION is a list of object successors which are allowed in
4295 the current object."
4304 restriction candidates)))
4311 ;; 1. Text before any object. Untabify it.
4316 acc
4320 ;; 2. Object...
4323 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4324 ;; a recursive type.
4332 ;; 3. Text after last object. Untabify it.
4336 acc
4340 ;; Result.
4341 acc))))
4344 "Return an alist of candidates for the next object.
4346 RESTRICTION is a list of object types, as symbols. Only
4347 candidates with such types are looked after.
4349 OBJECTS is the previous candidates alist. If it is set to
4350 `initial', no search has been done before, and all symbols in
4351 RESTRICTION should be looked after.
4353 Return value is an alist whose CAR is the object type and CDR its
4354 beginning position."
4356 nil
4358 ;; When searching for the first time, look for every successor
4359 ;; allowed in RESTRICTION.
4363 restriction)
4364 ;; Focus on objects returned during last search. Keep those
4365 ;; still after point. Search again objects before it.
4371 type)))
4374 objects))))
4377 \f
4378 ;;; Towards A Bijective Process
4379 ;;
4380 ;; The parse tree obtained with `org-element-parse-buffer' is really
4381 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4382 ;; interpreted and expanded into a string with canonical Org syntax.
4383 ;; Hence `org-element-interpret-data'.
4384 ;;
4385 ;; The function relies internally on
4386 ;; `org-element--interpret-affiliated-keywords'.
4388 ;;;###autoload
4390 "Interpret DATA as Org syntax.
4392 DATA is a parse tree, an element, an object or a secondary string
4393 to interpret.
4395 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4396 new types that should be treated as objects. An unknown type not
4397 belonging to this list is seen as a pseudo-element instead. Both
4398 pseudo-objects and pseudo-elements are transparent entities, i.e.
4399 only their contents are interpreted.
4401 Return Org syntax as a string."
4405 "Interpret DATA as Org syntax.
4407 DATA is a parse tree, an element, an object or a secondary string
4408 to interpret. PARENT is used for recursive calls. It contains
4409 the element or object containing data, or nil. PSEUDO-OBJECTS
4410 are list of symbols defining new element or object types.
4411 Unknown types that don't belong to this list are treated as
4412 pseudo-elements instead.
4414 Return Org syntax as a string."
4416 ;; Find interpreter for current object or element. If it
4417 ;; doesn't exist (e.g. this is a pseudo object or element),
4418 ;; return contents, if any.
4424 ;; Secondary string.
4430 ;; Full Org document.
4436 ;; Plain text: remove `:parent' text property from output.
4438 ;; Element or object without contents.
4440 ;; Element or object with contents.
4443 ;; Recursively interpret contents.
4449 data
4450 ;; Fix indentation of elements containing
4451 ;; objects. We ignore `table-row' elements
4452 ;; as they are one line long anyway.
4454 data
4455 ;; When normalizing first paragraph of an
4456 ;; item or a footnote-definition, ignore
4457 ;; first line's indentation.
4464 ;; Build white spaces. If no `:post-blank' property is
4465 ;; specified, assume its value is 0.
4476 "Return ELEMENT's affiliated keywords as Org syntax.
4477 If there is no affiliated keyword, return the empty string."
4487 ": "
4490 value)
4498 ;; All attribute keywords can have multiple lines.
4504 ;; List all ELEMENT's properties matching an attribute line or an
4505 ;; affiliated keyword, but ignore translated keywords since they
4506 ;; cannot belong to the property list.
4513 org-element-keyword-translation-alist)))))
4514 collect prop)
4517 ;; Because interpretation of the parse tree must return the same
4518 ;; number of blank lines between elements and the same number of white
4519 ;; space after objects, some special care must be given to white
4520 ;; spaces.
4521 ;;
4522 ;; The first function, `org-element-normalize-string', ensures any
4523 ;; string different from the empty string will end with a single
4524 ;; newline character.
4525 ;;
4526 ;; The second function, `org-element-normalize-contents', removes
4527 ;; global indentation from the contents of the current element.
4530 "Ensure string S ends with a single newline character.
4532 If S isn't a string return it unchanged. If S is the empty
4533 string, return it. Otherwise, return a new string with a single
4534 newline character at its end."
4542 "Normalize plain text in ELEMENT's contents.
4544 ELEMENT must only contain plain text and objects.
4546 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4547 indentation to compute maximal common indentation.
4549 Return the normalized element that is element with global
4550 indentation removed from its contents. The function assumes that
4551 indentation is not done with TAB characters."
4553 collect-inds ; for byte-compiler
4556 ;; Return list of indentations within BLOB. This is done by
4557 ;; walking recursively BLOB and updating IND-LIST along the
4558 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4559 ;; been seen yet. It is required as this string is the only
4560 ;; one whose indentation doesn't happen after a newline
4561 ;; character.
4569 ;; An indentation of zero means no string will be
4570 ;; modified. Quit the process.
4576 ;; Avoid matching blank or empty lines.
4584 ;; Collect indentation list in ELEMENT. Possibly remove first
4585 ;; value if IGNORE-FIRST is non-nil.
4588 ;; Build ELEMENT back, replacing each string with the same
4589 ;; string minus common indentation.
4594 ;; Return BLOB with all its strings indentation
4595 ;; shortened from MCI white spaces. FIRST-FLAG is
4596 ;; non-nil when the first string hasn't been seen
4597 ;; yet.
4611 org-element-recursive-objects)
4615 blob))))
4619 \f
4620 ;;; The Toolbox
4621 ;;
4622 ;; The first move is to implement a way to obtain the smallest element
4623 ;; containing point. This is the job of `org-element-at-point'. It
4624 ;; basically jumps back to the beginning of section containing point
4625 ;; and proceed, one element after the other, with
4626 ;; `org-element--current-element' until the container is found. Note:
4627 ;; When using `org-element-at-point', secondary values are never
4628 ;; parsed since the function focuses on elements, not on objects.
4629 ;;
4630 ;; At a deeper level, `org-element-context' lists all elements and
4631 ;; objects containing point.
4632 ;;
4633 ;; Both functions benefit from a simple caching mechanism. It is
4634 ;; enabled by default, but can be disabled globally with
4635 ;; `org-element-use-cache'. Also `org-element-cache-reset' clears or
4636 ;; initializes cache for current buffer. Values are retrieved and put
4637 ;; into cache with respectively, `org-element-cache-get' and
4638 ;; `org-element-cache-put'. `org-element--cache-sync-idle-time' and
4639 ;; `org-element--cache-merge-changes-threshold' are used internally to
4640 ;; control caching behaviour.
4641 ;;
4642 ;; Eventually `org-element-nested-p' and `org-element-swap-A-B' may be
4643 ;; used internally by navigation and manipulation tools.
4649 "Hash table used as a cache for parser.
4650 Key is a buffer position and value is a cons cell with the
4651 pattern:
4653 \(ELEMENT . OBJECTS-DATA)
4655 where ELEMENT is the element starting at the key and OBJECTS-DATA
4656 is an alist where each association is:
4658 \(POS CANDIDATES . OBJECTS)
4660 where POS is a buffer position, CANDIDATES is the last know list
4661 of successors (see `org-element--get-next-object-candidates') in
4662 container starting at POS and OBJECTS is a list of objects known
4663 to live within that container, from farthest to closest.
4666 at, respectively, positions 1, 7 and 8,
4670 If the paragraph is completely parsed, OBJECTS-DATA will be
4672 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
4673 \(8 nil ENTITY-OBJECT))
4675 whereas in a partially parsed paragraph, it could be
4677 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
4679 This cache is used in both `org-element-at-point' and
4680 `org-element-context'. The former uses ELEMENT only and the
4684 "Number of seconds of idle time wait before syncing buffer cache.
4685 Syncing also happens when current modification is too distant
4686 from the stored one (for more information, see
4690 "Number of characters triggering cache syncing.
4692 The cache mechanism only stores one buffer modification at any
4693 given time. When another change happens, it replaces it with
4694 a change containing both the stored modification and the current
4695 one. This is a trade-off, as merging them prevents another
4696 syncing, but every element between them is then lost.
4698 This variable determines the maximum size, in characters, we
4702 "Contains data about cache validity for current buffer.
4704 Value is a vector of seven elements,
4706 [ACTIVEP BEGIN END OFFSET TIMER PREVIOUS-STATE]
4708 ACTIVEP is a boolean non-nil when changes described in the other
4709 slots are valid for current buffer.
4711 BEGIN and END are the beginning and ending position of the area
4712 for which cache cannot be trusted.
4714 OFFSET it an integer specifying the number to add to position of
4715 elements after that area.
4717 TIMER is a timer used to apply these changes to cache when Emacs
4718 is idle.
4720 PREVIOUS-STATE is a symbol referring to the state of the buffer
4721 before a change happens. It is used to know if sensitive
4722 areas (block boundaries, headlines) were modified. It can be set
4725 ;;;###autoload
4727 "Reset cache in current buffer.
4728 When optional argument ALL is non-nil, reset cache in all Org
4729 buffers. This function will do nothing if
4730 `org-element-use-cache' is nil."
4747 "Non-nil when changes are not integrated in cache yet."
4752 "Push change to current buffer staging area.
4753 BEG and END and the beginning and ending position of the
4754 modification area. OFFSET is the size of the change, as an
4755 integer."
4763 nil
4764 #'org-element--cache-sync
4769 "Remove any cache change set for current buffer."
4775 "Return expected key for ELEMENT in cache."
4780 begin))
4781 ;; Special key for first item (resp. table-row) in a plain
4782 ;; list (resp. table).
4784 begin)))
4787 "Return data stored at key POS in current buffer cache.
4788 When optional argument TYPE is `element', retrieve the element
4789 starting at POS. When it is `objects', return the list of object
4790 types along with their beginning position within that element.
4791 Otherwise, return the full data. In any case, return nil if no
4792 data is found, or if caching is not allowed."
4794 ;; If there are pending changes, first sync them.
4804 "Store data in current buffer's cache, if allowed.
4805 POS is a buffer position, which will be used as a key. DATA is
4806 the value to store. Nothing will be stored if
4807 `org-element-use-cache' is nil. Return DATA in any case."
4813 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4814 Properties containing buffer positions are `:begin', `:end',
4815 `:contents-begin', `:contents-end' and `:structure'. They are
4816 modified by side-effect. Return modified element."
4818 ;; Shift :structure property for the first plain list only: it is
4819 ;; the only one that really matters and it prevents from shifting
4820 ;; it more than once.
4832 element)
4840 "Regexp matching an element opening line.
4841 When such a line is modified, modifications may propagate after
4842 modified area. In that situation, every element between that
4851 "Regexp matching an element closing line.
4852 When such a line is modified, modifications may propagate before
4853 modified area. In that situation, every element between that
4857 "Request extension of area going to be modified if needed.
4858 BEG and END are the beginning and end of the range of changed
4859 text. See `before-change-functions' for more information."
4867 ;; A sensitive line is a headline or a block (or drawer,
4868 ;; or latex-environment) boundary. Inserting one can
4869 ;; modify buffer drastically both above and below that
4870 ;; line, possibly making cache invalid. Therefore, we
4871 ;; need to pay special attention to changes happening to
4872 ;; them.
4876 org-element--cache-opening-line)))
4889 "Update buffer modifications for current buffer.
4891 BEG and END are the beginning and end of the range of changed
4892 text, and the length in bytes of the pre-change text replaced by
4893 that range. See `after-change-functions' for more information.
4895 If there are already pending changes, try to merge them into
4896 a bigger change record. If that's not possible, the function
4897 will first synchronize cache with previous change and store the
4898 new one."
4908 ;; Determine if modified area needs to be extended,
4909 ;; according to both previous and current state. We make
4910 ;; a special case for headline editing: if a headline is
4911 ;; modified but not removed, do not extend.
4916 org-element--cache-opening-line)))
4927 ;; Effectively extend modified area.
4930 ;; Headline above is inclusive.
4934 ;; Headline below is exclusive.
4936 ;; Store changes.
4939 ;; No pending changes. Store the new ones.
4946 ;; If we cannot merge two change sets (i.e. they
4947 ;; modify distinct buffer parts) first apply current
4948 ;; change set and store new one. This way, there is
4949 ;; never more than one pending change set, which
4950 ;; avoids handling costly merges.
4954 ;; Change sets can be merged. We can expand the area
4955 ;; that requires an update, and postpone the sync.
4964 "Synchronize cache with recent modification in BUFFER.
4965 Elements ending before modification area are kept in cache.
4966 Elements starting after modification area have their position
4967 shifted by the size of the modification. Every other element is
4968 removed from the cache."
4976 new-keys)
4982 ;; Shift every element starting after END by OFFSET.
4983 ;; We also need to shift keys, since they refer to
4984 ;; buffer positions.
4985 ;;
4986 ;; Upon shifting a key a conflict can occur if the
4987 ;; shifted key also refers to some element in the
4988 ;; cache. In this case, we temporarily associate
4989 ;; both elements, as a cons cell, to the shifted key,
4990 ;; following the pattern (SHIFTED . CURRENT).
4991 ;;
4992 ;; Such a conflict can only occur if shifted key hash
4993 ;; hasn't been processed by `maphash' yet.
4997 ;; Shift element part.
4999 ;; Shift objects part.
5006 ;; Shift key-value pair.
5009 ;; Put new value to shifted key.
5010 ;;
5011 ;; If one already exists, do not overwrite it:
5012 ;; store it as the car of a cons cell instead,
5013 ;; and handle it when `maphash' reaches
5014 ;; NEW-KEY.
5015 ;;
5016 ;; If there is no element stored at NEW-KEY or
5017 ;; if NEW-KEY is going to be removed anyway
5018 ;; (i.e., it is before END), just store new
5019 ;; value there and make sure it will not be
5020 ;; processed again by storing NEW-KEY in
5021 ;; NEW-KEYS.
5026 value-to-shift)
5027 org-element--cache)
5028 ;; If current value contains two elements, car
5029 ;; should be the new value, since cdr has been
5030 ;; shifted already.
5034 ;; Remove every element between BEG and END, since
5035 ;; this is where changes happened.
5037 ;; Preserve any element ending before BEG. If it
5038 ;; overlaps the BEG-END area, remove it.
5043 ;; Special case: footnote definitions and plain
5044 ;; lists can end with blank lines. Modifying
5045 ;; those can also alter last element inside. We
5046 ;; must therefore remove them from cache.
5056 org-element--cache)
5057 ;; Signal cache as up-to-date.
5060 ;;;###autoload
5062 "Determine closest element around point.
5064 Return value is a list like (TYPE PROPS) where TYPE is the type
5065 of the element and PROPS a plist of properties associated to the
5066 element.
5068 Possible types are defined in `org-element-all-elements'.
5069 Properties depend on element or object type, but always include
5070 `:begin', `:end', `:parent' and `:post-blank' properties.
5072 As a special case, if point is at the very beginning of a list or
5073 sub-list, returned element will be that list instead of the first
5074 item. In the same way, if point is at the beginning of the first
5075 row of a table, returned element will be the table instead of the
5076 first row."
5092 ;; Opportunistic shortcut. Instead of going back to
5093 ;; headline above (or beginning of buffer) and descending
5094 ;; again, first try to find a known element above current
5095 ;; position. Give up after 3 tries or when we hit
5096 ;; a headline (or beginning of buffer).
5104 ;; An element cannot start at a headline, so check
5105 ;; first non-blank line below.
5109 ;; At an affiliated keyword, make sure to move to
5110 ;; the first one.
5115 ;; At a fixed width area or a property drawer, reach
5116 ;; the beginning of the element.
5121 ;; Tough luck: we're back at a headline above. Move to
5122 ;; beginning of section.
5128 ;; Search successful: we know an element before point
5129 ;; which is not an headline. If it has a common
5130 ;; ancestor with ORIGIN, set this ancestor as the
5131 ;; current parent and the element as the one to check.
5132 ;; Otherwise, move at top level and start parsing right
5133 ;; after its broader ancestor.
5140 end cache-end)
5151 ;; Opportunistic search failed. Move back to beginning of
5152 ;; section in current headline, if any, or to first non-empty
5153 ;; line in buffer otherwise.
5158 ;; Now we are at the beginning of an element, start parsing.
5163 ;; Parse successively each element, skipping those ending
5164 ;; before original position.
5171 ;; First item (resp. row) in
5172 ;; plain list (resp. table) gets
5173 ;; a special key in cache.
5184 ;; When changes happened in the middle of
5185 ;; a list, its structure ends up being
5186 ;; invalid. Therefore, we make sure to use
5187 ;; a valid one.
5194 ;; 1. Skip any element ending before point. Also skip
5195 ;; element ending at point when we're sure that
5196 ;; another element has started.
5202 ;; 2. An element containing point is always the element at
5203 ;; point.
5206 ;; 3. At any other greater element type, if point is
5207 ;; within contents, move into it.
5212 ;; Create an anchor for tables and plain
5213 ;; lists: when point is at the very beginning
5214 ;; of these elements, ignoring affiliated
5215 ;; keywords, target them instead of their
5216 ;; contents.
5218 ;; When point is at contents end, do not move
5219 ;; into elements with an explicit ending, but
5220 ;; return that element instead.
5224 drawer dynamic-block inlinetask
5225 property-drawer quote-block
5226 special-block))
5227 ;; Corner case: if a list ends at
5228 ;; the end of a buffer without
5229 ;; a final new line, return last
5230 ;; element in last item instead.
5247 ;;;###autoload
5249 "Return closest element or object around point.
5251 Return value is a list like (TYPE PROPS) where TYPE is the type
5252 of the element or object and PROPS a plist of properties
5253 associated to it.
5255 Possible types are defined in `org-element-all-elements' and
5256 `org-element-all-objects'. Properties depend on element or
5257 object type, but always include `:begin', `:end', `:parent' and
5258 `:post-blank'.
5260 Optional argument ELEMENT, when non-nil, is the closest element
5261 containing point, as returned by `org-element-at-point'.
5262 Providing it allows for quicker computation."
5268 ;; If point is inside an element containing objects or
5269 ;; a secondary string, narrow buffer to the container and
5270 ;; proceed with parsing. Otherwise, return ELEMENT.
5272 ;; At a parsed affiliated keyword, check if we're inside main
5273 ;; or dual value.
5280 org-element-parsed-keywords))
5289 ;; Also change type to retrieve correct restrictions.
5291 ;; At an item, objects can only be located within tag, if any.
5301 ;; At an headline or inlinetask, objects are in title.
5308 ;; At a paragraph, a table-row or a verse block, objects are
5309 ;; located within their contents.
5313 ;; CBEG is nil for table rules.
5317 ;; At a parsed keyword, objects are located within value.
5320 org-element-document-properties))
5327 ;; All other locations cannot contain objects: bail out.
5335 objects-data next update-cache-flag)
5339 ;; Get list of next object candidates in CANDIDATES.
5340 ;; When entering for the first time PARENT, grab it
5341 ;; from cache, if available, or compute it. Then,
5342 ;; for each subsequent iteration in PARENT, always
5343 ;; compute it since we're beyond cache anyway.
5348 cache))))
5352 restriction candidates))
5356 ;; Compare ORIGIN with next object starting position,
5357 ;; if any.
5358 ;;
5359 ;; If ORIGIN is lesser or if there is no object
5360 ;; following, look for a previous object that might
5361 ;; contain it in cache. If there is no cache, we
5362 ;; didn't miss any object so simply return PARENT.
5363 ;;
5364 ;; If ORIGIN is greater or equal, parse next
5365 ;; candidate for further processing.
5369 candidates))))
5375 ;; Object ends before ORIGIN and we
5376 ;; know next one in cache starts
5377 ;; after it: bail out.
5387 ;; Process NEXT to know if we need to skip it, return
5388 ;; it or move into it.
5393 ;; ORIGIN is after NEXT, so skip it.
5395 ;; ORIGIN is within a non-recursive next or
5396 ;; at an object boundaries: Return that object.
5400 ;; Otherwise, move into NEXT and reset flags as we
5401 ;; shift parent.
5407 next nil
5408 objects-data nil
5410 ;; Update cache if required.
5415 "Non-nil when elements ELEM-A and ELEM-B are nested."
5424 "Swap elements ELEM-A and ELEM-B.
5425 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5426 end of ELEM-A."
5428 ;; There are two special cases when an element doesn't start at bol:
5429 ;; the first paragraph in an item or in a footnote definition.
5431 ;; Only a paragraph without any affiliated keyword can be moved at
5432 ;; ELEM-A position in such a situation. Note that the case of
5433 ;; a footnote definition is impossible: it cannot contain two
5434 ;; paragraphs in a row because it cannot contain a blank line.
5440 ;; In a special situation, ELEM-A will have no indentation. We'll
5441 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5455 ;; Store overlays responsible for visibility status. We
5456 ;; also need to store their boundaries as they will be
5457 ;; removed from buffer.
5464 ;; Get contents.
5472 ;; Restore ex ELEM-A overlays.
5481 ;; Restore ex ELEM-B overlays.
5489 "Remove maximum common indentation in string S and return it.
5490 When optional argument N is a positive integer, remove exactly
5491 that much characters from indentation, if possible, or return
5492 S as-is otherwise. Unlike to `org-remove-indentation', this
5493 function doesn't call `untabify' on S."
5498 ;; Find maximum common indentation, if not specified.
5506 min-ind)))
5508 ;; Remove exactly N indentation, but give up if not possible.
5520 ;; Local variables:
5521 ;; generated-autoload-file: "org-loaddefs.el"
5522 ;; End:
5524 ;;; org-element.el ends here