| blob | bbd5d7db6dd4eb7e3bfe5b9da1f9e441ef96d998 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (e.g. 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'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block quote-section section
180 special-block src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 inline-src-block latex-or-entity line-break macro plain-link
192 radio-target statistics-cookie sub/superscript table-cell target
193 text-markup timestamp)
202 "Alist of translations between object type and successor name.
203 Sharing the same successor comes handy when, for example, the
208 inline-src-block italic line-break latex-fragment link macro
209 radio-target statistics-cookie strike-through subscript superscript
210 table-cell target timestamp underline verbatim)
215 table-cell underline)
225 "Alist between block names and the associated parsing function.
226 Names must be uppercase. Any block whose name has no association
232 Only these types can accept search options and an explicit
238 "List of affiliated keywords as strings.
246 "Alist of usual translations for keywords.
247 The key is the old name and the value the new one. The property
251 "List of affiliated keywords that can occur more than once in an element.
253 Their value will be consed into a list of strings, which will be
254 returned as the value of the property.
256 This list is checked after translations have been applied. See
257 `org-element-keyword-translation-alist'.
263 "List of affiliated keywords whose value can be parsed.
265 Their value will be stored as a secondary string: a list of
266 strings and objects.
268 This list is checked after translations have been applied. See
272 "List of affiliated keywords which can have a secondary value.
274 In Org syntax, they can be written with optional square brackets
275 before the colons. For example, RESULTS keyword can be
276 associated to a hash value with the following:
278 #+RESULTS[hash-string]: some-source
280 This list is checked after translations have been applied. See
284 "List of properties associated to the whole document.
285 Any keyword in this list will have its value parsed and stored as
291 ;; Dual affiliated keywords.
295 ;; Regular affiliated keywords.
301 org-element-affiliated-keywords)))
303 ;; Export attributes.
305 "Regexp matching any affiliated keyword.
307 Keyword name is put in match group 1. Moreover, if keyword
308 belongs to `org-element-dual-keywords', put the dual value in
309 match group 2.
324 ;; Ignore all links excepted plain links in a link description.
325 ;; Also ignore radio-targets and line breaks.
329 ;; Remove any variable object from radio target as it would
330 ;; prevent it from being properly recognized.
335 ;; Ignore inline babel call and inline src block as formulas are
336 ;; possible. Also ignore line breaks and statistics cookies.
342 "Alist of objects restrictions.
344 CAR is an element or object type containing objects and CDR is
345 a list of successors that will be called within an element or
346 object of such type.
348 For example, in a `radio-target' object, one can only find
349 entities, latex-fragments, subscript, superscript and text
350 markup.
352 This alist also applies to secondary string. For example, an
353 `headline' type element doesn't directly contain objects, but
364 \f
365 ;;; Accessors and Setters
366 ;;
367 ;; Provide four accessors: `org-element-type', `org-element-property'
368 ;; `org-element-contents' and `org-element-restriction'.
369 ;;
370 ;; Setter functions allow to modify elements by side effect. There is
371 ;; `org-element-put-property', `org-element-set-contents',
372 ;; `org-element-set-element' and `org-element-adopt-element'. Note
373 ;; that `org-element-set-element' and `org-element-adopt-elements' are
374 ;; higher level functions since also update `:parent' property.
377 "Return type of ELEMENT.
379 The function returns the type of the element or object provided.
380 It can also return the following special value:
381 `plain-text' for a string
382 `org-data' for a complete document
383 nil in any other case."
389 "Extract the value from the PROPERTY of an ELEMENT."
394 "Extract contents from an ELEMENT."
400 "Return restriction associated to ELEMENT.
401 ELEMENT can be an element, an object or a symbol representing an
402 element or object type."
404 org-element-object-restrictions)))
407 "In ELEMENT set PROPERTY to VALUE.
408 Return modified element."
411 element))
414 "Set ELEMENT contents to CONTENTS.
415 Return modified element."
422 "Replace element or object OLD with element or object NEW.
423 The function takes care of setting `:parent' property for NEW."
424 ;; Since OLD is going to be changed into NEW by side-effect, first
425 ;; make sure that every element or object within NEW has OLD as
426 ;; parent.
429 ;; Transfer contents.
431 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
432 ;; with NEW's.
435 ;; Transfer type.
439 "Append elements to the contents of another element.
441 PARENT is an element or object. CHILDREN can be elements,
442 objects, or a strings.
444 The function takes care of setting `:parent' property for CHILD.
445 Return parent element."
446 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
447 ;; string: parent is the list itself.
450 children)
451 ;; Add CHILDREN at the end of PARENT contents.
454 parent
456 ;; Return modified PARENT element.
460 \f
461 ;;; Greater elements
462 ;;
463 ;; For each greater element type, we define a parser and an
464 ;; interpreter.
465 ;;
466 ;; A parser returns the element or object as the list described above.
467 ;; Most of them accepts no argument. Though, exceptions exist. Hence
468 ;; every element containing a secondary string (see
469 ;; `org-element-secondary-value-alist') will accept an optional
470 ;; argument to toggle parsing of that secondary string. Moreover,
471 ;; `item' parser requires current list's structure as its first
472 ;; element.
473 ;;
474 ;; An interpreter accepts two arguments: the list representation of
475 ;; the element or object, and its contents. The latter may be nil,
476 ;; depending on the element or object considered. It returns the
477 ;; appropriate Org syntax, as a string.
478 ;;
479 ;; Parsing functions must follow the naming convention:
480 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
481 ;; defined in `org-element-greater-elements'.
482 ;;
483 ;; Similarly, interpreting functions must follow the naming
484 ;; convention: org-element-TYPE-interpreter.
485 ;;
486 ;; With the exception of `headline' and `item' types, greater elements
487 ;; cannot contain other greater elements of their own type.
488 ;;
489 ;; Beside implementing a parser and an interpreter, adding a new
490 ;; greater element requires to tweak `org-element--current-element'.
491 ;; Moreover, the newly defined type must be added to both
492 ;; `org-element-all-elements' and `org-element-greater-elements'.
495 ;;;; Center Block
498 "Parse a center block.
500 LIMIT bounds the search. AFFILIATED is a list of which CAR is
501 the buffer position at the beginning of the first affiliated
502 keyword and CDR is a plist of affiliated keywords along with
503 their value.
505 Return a list whose CAR is `center-block' and CDR is a plist
506 containing `:begin', `:end', `:hiddenp', `:contents-begin',
507 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
509 Assume point is at the beginning of the block."
513 ;; Incomplete block: parse it as a paragraph.
518 ;; Empty blocks have no contents.
533 :end end
534 :hiddenp hidden
535 :contents-begin contents-begin
536 :contents-end contents-end
542 "Interpret CENTER-BLOCK element as Org syntax.
543 CONTENTS is the contents of the element."
547 ;;;; Drawer
550 "Parse a drawer.
552 LIMIT bounds the search. AFFILIATED is a list of which CAR is
553 the buffer position at the beginning of the first affiliated
554 keyword and CDR is a plist of affiliated keywords along with
555 their value.
557 Return a list whose CAR is `drawer' and CDR is a plist containing
558 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
559 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
561 Assume point is at beginning of drawer."
564 ;; Incomplete drawer: parse it as a paragraph.
572 ;; Empty drawers have no contents.
586 :end end
587 :drawer-name name
588 :hiddenp hidden
589 :contents-begin contents-begin
590 :contents-end contents-end
596 "Interpret DRAWER element as Org syntax.
597 CONTENTS is the contents of the element."
600 contents))
603 ;;;; Dynamic Block
606 "Parse a dynamic block.
608 LIMIT bounds the search. AFFILIATED is a list of which CAR is
609 the buffer position at the beginning of the first affiliated
610 keyword and CDR is a plist of affiliated keywords along with
611 their value.
613 Return a list whose CAR is `dynamic-block' and CDR is a plist
614 containing `:block-name', `:begin', `:end', `:hiddenp',
615 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
616 and `:post-affiliated' keywords.
618 Assume point is at beginning of dynamic block."
622 ;; Incomplete block: parse it as a paragraph.
631 ;; Empty blocks have no contents.
645 :end end
646 :block-name name
647 :arguments arguments
648 :hiddenp hidden
649 :contents-begin contents-begin
650 :contents-end contents-end
656 "Interpret DYNAMIC-BLOCK element as Org syntax.
657 CONTENTS is the contents of the element."
662 contents))
665 ;;;; Footnote Definition
668 "Parse a footnote definition.
670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
671 the buffer position at the beginning of the first affiliated
672 keyword and CDR is a plist of affiliated keywords along with
673 their value.
675 Return a list whose CAR is `footnote-definition' and CDR is
676 a plist containing `:label', `:begin' `:end', `:contents-begin',
677 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
679 Assume point is at the beginning of the footnote definition."
707 :begin begin
708 :end end
709 :contents-begin contents-begin
710 :contents-end contents-end
716 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
717 CONTENTS is the contents of the footnote-definition."
719 " "
720 contents))
723 ;;;; Headline
726 "Parse a headline.
728 Return a list whose CAR is `headline' and CDR is a plist
729 containing `:raw-value', `:title', `:alt-title', `:begin',
730 `:end', `:pre-blank', `:hiddenp', `:contents-begin',
731 `:contents-end', `:level', `:priority', `:tags',
732 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
733 `:closed', `:quotedp', `:archivedp', `:commentedp',
734 `:footnote-section-p' and `:post-blank' keywords.
736 The plist also contains any property set in the property drawer,
737 with its name in upper cases and colons added at the
738 beginning (e.g., `:CUSTOM_ID').
740 LIMIT is a buffer position bounding the search.
742 When RAW-SECONDARY-P is non-nil, headline's title will not be
743 parsed as a secondary string, but as a plain string instead.
745 Assume point is at beginning of the headline."
758 raw-value)))
762 raw-value)))
766 ;; Upcase property names. It avoids confusion between
767 ;; properties obtained through property drawer and default
768 ;; properties from the parser (e.g. `:end' and :END:)
778 plist))
780 ;; Read time properties on the line below the headline.
786 org-keyword-time-not-clock-regexp end t)
796 plist))))
809 ;; Clean RAW-VALUE from any quote or comment string.
817 ""
818 raw-value))))
819 ;; Clean TAGS from archive tag, if any.
825 :begin begin
826 :end end
827 :pre-blank
830 :hiddenp hidden
831 :contents-begin contents-begin
832 :contents-end contents-end
833 :level level
835 :tags tags
836 :todo-keyword todo
837 :todo-type todo-type
840 end)
841 :footnote-section-p footnote-section-p
842 :archivedp archivedp
843 :commentedp commentedp
845 time-props
846 standard-props))))
850 headline :alt-title
855 headline :title
861 "Interpret HEADLINE element as Org syntax.
862 CONTENTS is the contents of the element."
889 ;; Align tags.
897 ? )
898 tags))
902 tags))))
904 contents)))
907 ;;;; Inlinetask
910 "Parse an inline task.
912 Return a list whose CAR is `inlinetask' and CDR is a plist
913 containing `:title', `:begin', `:end', `:hiddenp',
914 `:contents-begin' and `:contents-end', `:level', `:priority',
915 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
916 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
918 The plist also contains any property set in the property drawer,
919 with its name in upper cases and colons added at the
920 beginning (e.g., `:CUSTOM_ID').
922 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
923 title will not be parsed as a secondary string, but as a plain
924 string instead.
926 Assume point is at beginning of the inline task."
936 ;; Upcase property names. It avoids confusion between
937 ;; properties obtained through property drawer and default
938 ;; properties from the parser (e.g. `:end' and :END:)
948 plist))
950 ;; Read time properties on the line below the inlinetask
951 ;; opening string.
957 org-keyword-time-not-clock-regexp end t)
967 plist))))
987 :begin begin
988 :end end
989 :hiddenp hidden
990 :contents-begin contents-begin
991 :contents-end contents-end
994 :tags tags
995 :todo-keyword todo
996 :todo-type todo-type
998 time-props
999 standard-props))))
1001 inlinetask :title
1004 raw-value
1006 inlinetask))))))
1009 "Interpret INLINETASK element as Org syntax.
1010 CONTENTS is the contents of inlinetask."
1025 ;; Align tags.
1033 ? )
1034 tags))
1038 tags))))
1039 ;; Prefer degenerate inlinetasks when there are no
1040 ;; contents.
1043 contents
1047 ;;;; Item
1050 "Parse an item.
1052 STRUCT is the structure of the plain list.
1054 Return a list whose CAR is `item' and CDR is a plist containing
1055 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1056 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1057 `:post-blank' keywords.
1059 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1060 any, will not be parsed as a secondary string, but as a plain
1061 string instead.
1063 Assume point is at the beginning of the item."
1087 ;; Ignore tags in un-ordered lists: they are just
1088 ;; a part of item's body.
1094 ;; If first line isn't empty, contents really start
1095 ;; at the text after item's meta-data.
1106 :begin begin
1107 :end end
1108 ;; CONTENTS-BEGIN and CONTENTS-END may be
1109 ;; mixed up in the case of an empty item
1110 ;; separated from the next by a blank line.
1111 ;; Thus ensure the former is always the
1112 ;; smallest.
1115 :checkbox checkbox
1116 :counter counter
1117 :hiddenp hidden
1118 :structure struct
1121 item :tag
1129 "Interpret ITEM element as Org syntax.
1130 CONTENTS is the contents of the element."
1140 ;; Compute indentation.
1145 ;; Indent contents.
1147 bullet
1161 ;;;; Plain List
1164 ;; Return structure of list at point. Internal function. See
1165 ;; `org-list-struct' for details.
1173 items struct)
1178 ;; At limit: end all items.
1187 ;; At list end: end all items.
1192 ;; At a new item: end previous sibling.
1204 ind
1205 bullet
1208 ;; Description tag.
1212 ;; Ending position, unknown so far.
1213 nil)))
1214 items))
1216 ;; Skip empty lines.
1218 ;; Skip inline tasks and blank lines along the way.
1225 ;; At some text line. Check if it ends any previous item.
1237 ;; Skip blocks (any type) and drawers contents.
1243 limit t)))
1249 "Parse a plain list.
1251 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1252 the buffer position at the beginning of the first affiliated
1253 keyword and CDR is a plist of affiliated keywords along with
1254 their value. STRUCTURE is the structure of the plain list being
1255 parsed.
1257 Return a list whose CAR is `plain-list' and CDR is a plist
1258 containing `:type', `:begin', `:end', `:contents-begin' and
1259 `:contents-end', `:structure', `:post-blank' and
1260 `:post-affiliated' keywords.
1262 Assume point is at the beginning of the list."
1275 ;; Return value.
1279 :begin begin
1280 :end end
1281 :contents-begin contents-begin
1282 :contents-end contents-end
1283 :structure struct
1289 "Interpret PLAIN-LIST element as Org syntax.
1290 CONTENTS is the contents of the element."
1298 ;;;; Property Drawer
1301 "Parse a property drawer.
1303 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1304 the buffer position at the beginning of the first affiliated
1305 keyword and CDR is a plist of affiliated keywords along with
1306 their value.
1308 Return a list whose CAR is `property-drawer' and CDR is a plist
1309 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1310 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1312 Assume point is at the beginning of the property drawer."
1317 ;; Incomplete drawer: parse it as a paragraph.
1336 :end end
1337 :hiddenp hidden
1338 :contents-begin contents-begin
1339 :contents-end contents-end
1345 "Interpret PROPERTY-DRAWER element as Org syntax.
1346 CONTENTS is the properties within the drawer."
1350 ;;;; Quote Block
1353 "Parse a quote block.
1355 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1356 the buffer position at the beginning of the first affiliated
1357 keyword and CDR is a plist of affiliated keywords along with
1358 their value.
1360 Return a list whose CAR is `quote-block' and CDR is a plist
1361 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1362 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1364 Assume point is at the beginning of the block."
1368 ;; Incomplete block: parse it as a paragraph.
1374 ;; Empty blocks have no contents.
1388 :end end
1389 :hiddenp hidden
1390 :contents-begin contents-begin
1391 :contents-end contents-end
1397 "Interpret QUOTE-BLOCK element as Org syntax.
1398 CONTENTS is the contents of the element."
1402 ;;;; Section
1405 "Parse a section.
1407 LIMIT bounds the search.
1409 Return a list whose CAR is `section' and CDR is a plist
1410 containing `:begin', `:end', `:contents-begin', `contents-end'
1411 and `:post-blank' keywords."
1413 ;; Beginning of section is the beginning of the first non-blank
1414 ;; line after previous headline.
1423 :end end
1424 :contents-begin begin
1425 :contents-end pos-before-blank
1429 "Interpret SECTION element as Org syntax.
1430 CONTENTS is the contents of the element."
1431 contents)
1434 ;;;; Special Block
1437 "Parse a special block.
1439 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1440 the buffer position at the beginning of the first affiliated
1441 keyword and CDR is a plist of affiliated keywords along with
1442 their value.
1444 Return a list whose CAR is `special-block' and CDR is a plist
1445 containing `:type', `:begin', `:end', `:hiddenp',
1446 `:contents-begin', `:contents-end', `:post-blank' and
1447 `:post-affiliated' keywords.
1449 Assume point is at the beginning of the block."
1456 limit t)))
1457 ;; Incomplete block: parse it as a paragraph.
1463 ;; Empty blocks have no contents.
1477 :begin begin
1478 :end end
1479 :hiddenp hidden
1480 :contents-begin contents-begin
1481 :contents-end contents-end
1487 "Interpret SPECIAL-BLOCK element as Org syntax.
1488 CONTENTS is the contents of the element."
1493 \f
1494 ;;; Elements
1495 ;;
1496 ;; For each element, a parser and an interpreter are also defined.
1497 ;; Both follow the same naming convention used for greater elements.
1498 ;;
1499 ;; Also, as for greater elements, adding a new element type is done
1500 ;; through the following steps: implement a parser and an interpreter,
1501 ;; tweak `org-element--current-element' so that it recognizes the new
1502 ;; type and add that new type to `org-element-all-elements'.
1503 ;;
1504 ;; As a special case, when the newly defined type is a block type,
1505 ;; `org-element-block-name-alist' has to be modified accordingly.
1508 ;;;; Babel Call
1511 "Parse a babel call.
1513 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1514 the buffer position at the beginning of the first affiliated
1515 keyword and CDR is a plist of affiliated keywords along with
1516 their value.
1518 Return a list whose CAR is `babel-call' and CDR is a plist
1519 containing `:begin', `:end', `:info', `:post-blank' and
1520 `:post-affiliated' as keywords."
1533 :end end
1534 :info info
1540 "Interpret BABEL-CALL element as Org syntax.
1541 CONTENTS is nil."
1547 ;; Remove redundant square brackets.
1552 ;;;; Clock
1555 "Parse a clock.
1557 LIMIT bounds the search.
1559 Return a list whose CAR is `clock' and CDR is a plist containing
1560 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1561 as keywords."
1581 :value value
1582 :duration duration
1583 :begin begin
1584 :end end
1588 "Interpret CLOCK element as Org syntax.
1589 CONTENTS is nil."
1597 "%2s:%02s"
1601 ;;;; Comment
1604 "Parse a comment.
1606 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1607 the buffer position at the beginning of the first affiliated
1608 keyword and CDR is a plist of affiliated keywords along with
1609 their value.
1611 Return a list whose CAR is `comment' and CDR is a plist
1612 containing `:begin', `:end', `:value', `:post-blank',
1613 `:post-affiliated' keywords.
1615 Assume point is at comment beginning."
1624 ;; Get comments ending.
1627 ;; Accumulate lines without leading hash and first
1628 ;; whitespace.
1642 :end end
1643 :value value
1649 "Interpret COMMENT element as Org syntax.
1650 CONTENTS is nil."
1654 ;;;; Comment Block
1657 "Parse an export block.
1659 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1660 the buffer position at the beginning of the first affiliated
1661 keyword and CDR is a plist of affiliated keywords along with
1662 their value.
1664 Return a list whose CAR is `comment-block' and CDR is a plist
1665 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1666 and `:post-affiliated' keywords.
1668 Assume point is at comment block beginning."
1672 ;; Incomplete block: parse it as a paragraph.
1686 contents-begin contents-end)))
1690 :end end
1691 :value value
1692 :hiddenp hidden
1698 "Interpret COMMENT-BLOCK element as Org syntax.
1699 CONTENTS is nil."
1704 ;;;; Diary Sexp
1707 "Parse a diary sexp.
1709 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1710 the buffer position at the beginning of the first affiliated
1711 keyword and CDR is a plist of affiliated keywords along with
1712 their value.
1714 Return a list whose CAR is `diary-sexp' and CDR is a plist
1715 containing `:begin', `:end', `:value', `:post-blank' and
1716 `:post-affiliated' keywords."
1728 :begin begin
1729 :end end
1735 "Interpret DIARY-SEXP as Org syntax.
1736 CONTENTS is nil."
1740 ;;;; Example Block
1743 "Remove maximum common indentation in string S and return it.
1744 When optional argument N is a positive integer, remove exactly
1745 that much characters from indentation, if possible, or return
1746 S as-is otherwise. Unlike to `org-remove-indentation', this
1747 function doesn't call `untabify' on S."
1752 ;; Find maximum common indentation, if not specified.
1760 min-ind)))
1762 ;; Remove exactly N indentation, but give up if not possible.
1772 "Parse an example block.
1774 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1775 the buffer position at the beginning of the first affiliated
1776 keyword and CDR is a plist of affiliated keywords along with
1777 their value.
1779 Return a list whose CAR is `example-block' and CDR is a plist
1780 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1781 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1782 `:switches', `:value', `:post-blank' and `:post-affiliated'
1783 keywords."
1787 ;; Incomplete block: parse it as a paragraph.
1795 ;; Switches analysis
1803 ;; Should labels be retained in (or stripped from) example
1804 ;; blocks?
1809 ;; What should code-references use - labels or
1810 ;; line-numbers?
1819 ;; Standard block parsing.
1828 contents-begin contents-end))
1838 :end end
1839 :value value
1840 :switches switches
1841 :number-lines number-lines
1842 :preserve-indent preserve-indent
1843 :retain-labels retain-labels
1844 :use-labels use-labels
1845 :label-fmt label-fmt
1846 :hiddenp hidden
1852 "Interpret EXAMPLE-BLOCK element as Org syntax.
1853 CONTENTS is nil."
1861 ;;;; Export Block
1864 "Parse an export block.
1866 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1867 the buffer position at the beginning of the first affiliated
1868 keyword and CDR is a plist of affiliated keywords along with
1869 their value.
1871 Return a list whose CAR is `export-block' and CDR is a plist
1872 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1873 `:post-blank' and `:post-affiliated' keywords.
1875 Assume point is at export-block beginning."
1882 ;; Incomplete block: parse it as a paragraph.
1896 contents-end)))
1900 :end end
1901 :type type
1902 :value value
1903 :hiddenp hidden
1909 "Interpret EXPORT-BLOCK element as Org syntax.
1910 CONTENTS is nil."
1917 ;;;; Fixed-width
1920 "Parse a fixed-width section.
1922 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1923 the buffer position at the beginning of the first affiliated
1924 keyword and CDR is a plist of affiliated keywords along with
1925 their value.
1927 Return a list whose CAR is `fixed-width' and CDR is a plist
1928 containing `:begin', `:end', `:value', `:post-blank' and
1929 `:post-affiliated' keywords.
1931 Assume point is at the beginning of the fixed-width area."
1935 value
1940 ;; Accumulate text without starting colons.
1953 :end end
1954 :value value
1960 "Interpret FIXED-WIDTH element as Org syntax.
1961 CONTENTS is nil."
1969 ;;;; Horizontal Rule
1972 "Parse an horizontal rule.
1974 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1975 the buffer position at the beginning of the first affiliated
1976 keyword and CDR is a plist of affiliated keywords along with
1977 their value.
1979 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1980 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1981 keywords."
1991 :end end
1997 "Interpret HORIZONTAL-RULE element as Org syntax.
1998 CONTENTS is nil."
2002 ;;;; Keyword
2005 "Parse a keyword at point.
2007 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2008 the buffer position at the beginning of the first affiliated
2009 keyword and CDR is a plist of affiliated keywords along with
2010 their value.
2012 Return a list whose CAR is `keyword' and CDR is a plist
2013 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2014 `:post-affiliated' keywords."
2028 :value value
2029 :begin begin
2030 :end end
2036 "Interpret KEYWORD element as Org syntax.
2037 CONTENTS is nil."
2043 ;;;; Latex Environment
2046 "Parse a LaTeX environment.
2048 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2049 the buffer position at the beginning of the first affiliated
2050 keyword and CDR is a plist of affiliated keywords along with
2051 their value.
2053 Return a list whose CAR is `latex-environment' and CDR is a plist
2054 containing `:begin', `:end', `:value', `:post-blank' and
2055 `:post-affiliated' keywords.
2057 Assume point is at the beginning of the latex environment."
2064 limit t))
2065 ;; Incomplete latex environment: parse it as a paragraph.
2075 :end end
2076 :value value
2082 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2083 CONTENTS is nil."
2087 ;;;; Node Property
2090 "Parse a node-property at point.
2092 LIMIT bounds the search.
2094 Return a list whose CAR is `node-property' and CDR is a plist
2095 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2096 keywords."
2108 :value value
2109 :begin begin
2110 :end end
2114 "Interpret NODE-PROPERTY element as Org syntax.
2115 CONTENTS is nil."
2121 ;;;; Paragraph
2124 "Parse a paragraph.
2126 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2127 the buffer position at the beginning of the first affiliated
2128 keyword and CDR is a plist of affiliated keywords along with
2129 their value.
2131 Return a list whose CAR is `paragraph' and CDR is a plist
2132 containing `:begin', `:end', `:contents-begin' and
2133 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2135 Assume point is at the beginning of the paragraph."
2144 limit
2145 ;; A matching `org-element-paragraph-separate' is not
2146 ;; necessarily the end of the paragraph. In
2147 ;; particular, lines starting with # or : as a first
2148 ;; non-space character are ambiguous. We have to
2149 ;; check if they are valid Org syntax (e.g., not an
2150 ;; incomplete keyword).
2154 ;; There's no ambiguity for other symbols or
2155 ;; empty lines: stop here.
2157 ;; Stop at valid fixed-width areas.
2159 ;; Stop at drawers.
2164 ;; Stop at valid comments.
2166 ;; Stop at valid dynamic blocks.
2171 ;; Stop at valid blocks.
2178 limit t)))
2179 ;; Stop at valid latex environments.
2187 limit t)))
2188 ;; Stop at valid keywords.
2190 ;; Skip everything else.
2207 :end end
2208 :contents-begin contents-begin
2209 :contents-end contents-end
2215 "Interpret PARAGRAPH element as Org syntax.
2216 CONTENTS is the contents of the element."
2217 contents)
2220 ;;;; Planning
2223 "Parse a planning.
2225 LIMIT bounds the search.
2227 Return a list whose CAR is `planning' and CDR is a plist
2228 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2229 and `:post-blank' keywords."
2239 closed deadline scheduled)
2251 :deadline deadline
2252 :scheduled scheduled
2253 :begin begin
2254 :end end
2258 "Interpret PLANNING element as Org syntax.
2259 CONTENTS is nil."
2261 'identity
2278 ;;;; Quote Section
2281 "Parse a quote section.
2283 LIMIT bounds the search.
2285 Return a list whose CAR is `quote-section' and CDR is a plist
2286 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2288 Assume point is at beginning of the section."
2299 :end end
2300 :value value
2304 "Interpret QUOTE-SECTION element as Org syntax.
2305 CONTENTS is nil."
2309 ;;;; Src Block
2312 "Parse a src block.
2314 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2315 the buffer position at the beginning of the first affiliated
2316 keyword and CDR is a plist of affiliated keywords along with
2317 their value.
2319 Return a list whose CAR is `src-block' and CDR is a plist
2320 containing `:language', `:switches', `:parameters', `:begin',
2321 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2322 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2323 `:post-blank' and `:post-affiliated' keywords.
2325 Assume point is at the beginning of the block."
2328 limit t)))
2329 ;; Incomplete block: parse it as a paragraph.
2335 ;; Get language as a string.
2344 ;; Get switches.
2346 ;; Get parameters.
2348 ;; Switches analysis
2360 ;; Should labels be retained in (or stripped from)
2361 ;; src blocks?
2366 ;; What should code-references use - labels or
2367 ;; line-numbers?
2372 ;; Indentation.
2374 ;; Get visibility status.
2376 ;; Retrieve code.
2385 ;; Get position after ending blank lines.
2395 :begin begin
2396 :end end
2397 :number-lines number-lines
2398 :preserve-indent preserve-indent
2399 :retain-labels retain-labels
2400 :use-labels use-labels
2401 :label-fmt label-fmt
2402 :hiddenp hidden
2403 :value value
2409 "Interpret SRC-BLOCK element as Org syntax.
2410 CONTENTS is nil."
2431 ;;;; Table
2434 "Parse a table at point.
2436 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2437 the buffer position at the beginning of the first affiliated
2438 keyword and CDR is a plist of affiliated keywords along with
2439 their value.
2441 Return a list whose CAR is `table' and CDR is a plist containing
2442 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2443 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2444 keywords.
2446 Assume point is at the beginning of the table."
2460 acc))
2467 :end end
2468 :type type
2469 :tblfm tblfm
2470 ;; Only `org' tables have contents. `table.el' tables
2471 ;; use a `:value' property to store raw table as
2472 ;; a string.
2477 table-begin table-end))
2483 "Interpret TABLE element as Org syntax.
2484 CONTENTS is nil."
2495 ;;;; Table Row
2498 "Parse table row at point.
2500 LIMIT bounds the search.
2502 Return a list whose CAR is `table-row' and CDR is a plist
2503 containing `:begin', `:end', `:contents-begin', `:contents-end',
2504 `:type' and `:post-blank' keywords."
2508 ;; A table rule has no contents. In that case, ensure
2509 ;; CONTENTS-BEGIN matches CONTENTS-END.
2521 :begin begin
2522 :end end
2523 :contents-begin contents-begin
2524 :contents-end contents-end
2528 "Interpret TABLE-ROW element as Org syntax.
2529 CONTENTS is the contents of the table row."
2534 ;;;; Verse Block
2537 "Parse a verse block.
2539 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2540 the buffer position at the beginning of the first affiliated
2541 keyword and CDR is a plist of affiliated keywords along with
2542 their value.
2544 Return a list whose CAR is `verse-block' and CDR is a plist
2545 containing `:begin', `:end', `:contents-begin', `:contents-end',
2546 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2548 Assume point is at beginning of the block."
2552 ;; Incomplete block: parse it as a paragraph.
2568 :end end
2569 :contents-begin contents-begin
2570 :contents-end contents-end
2571 :hiddenp hidden
2577 "Interpret VERSE-BLOCK element as Org syntax.
2578 CONTENTS is verse block contents."
2582 \f
2583 ;;; Objects
2584 ;;
2585 ;; Unlike to elements, interstices can be found between objects.
2586 ;; That's why, along with the parser, successor functions are provided
2587 ;; for each object. Some objects share the same successor (e.g.,
2588 ;; `code' and `verbatim' objects).
2589 ;;
2590 ;; A successor must accept a single argument bounding the search. It
2591 ;; will return either a cons cell whose CAR is the object's type, as
2592 ;; a symbol, and CDR the position of its next occurrence, or nil.
2593 ;;
2594 ;; Successors follow the naming convention:
2595 ;; org-element-NAME-successor, where NAME is the name of the
2596 ;; successor, as defined in `org-element-all-successors'.
2597 ;;
2598 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2599 ;; object types they can contain will be specified in
2600 ;; `org-element-object-restrictions'.
2601 ;;
2602 ;; Adding a new type of object is simple. Implement a successor,
2603 ;; a parser, and an interpreter for it, all following the naming
2604 ;; convention. Register type in `org-element-all-objects' and
2605 ;; successor in `org-element-all-successors'. Maybe tweak
2606 ;; restrictions about it, and that's it.
2609 ;;;; Bold
2612 "Parse bold object at point.
2614 Return a list whose CAR is `bold' and CDR is a plist with
2615 `:begin', `:end', `:contents-begin' and `:contents-end' and
2616 `:post-blank' keywords.
2618 Assume point is at the first star marker."
2630 :end end
2631 :contents-begin contents-begin
2632 :contents-end contents-end
2636 "Interpret BOLD object as Org syntax.
2637 CONTENTS is the contents of the object."
2641 "Search for the next text-markup object.
2643 Return value is a cons cell whose CAR is a symbol among `bold',
2644 `italic', `underline', `strike-through', `code' and `verbatim'
2645 and CDR is beginning position."
2661 ;;;; Code
2664 "Parse code object at point.
2666 Return a list whose CAR is `code' and CDR is a plist with
2667 `:value', `:begin', `:end' and `:post-blank' keywords.
2669 Assume point is at the first tilde marker."
2680 :begin begin
2681 :end end
2685 "Interpret CODE object as Org syntax.
2686 CONTENTS is nil."
2690 ;;;; Entity
2693 "Parse entity at point.
2695 Return a list whose CAR is `entity' and CDR a plist with
2696 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2697 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2698 keywords.
2700 Assume point is at the beginning of the entity."
2702 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2718 :begin begin
2719 :end end
2720 :use-brackets-p bracketsp
2724 "Interpret ENTITY object as Org syntax.
2725 CONTENTS is nil."
2731 "Search for the next latex-fragment or entity object.
2733 Return value is a cons cell whose CAR is `entity' or
2734 `latex-fragment' and CDR is beginning position."
2738 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2745 ;; Determine if it's a real entity or a LaTeX command.
2748 ;; No entity nor command: point is at a LaTeX fragment.
2749 ;; Determine its type to get the correct beginning position.
2758 ;;;; Export Snippet
2761 "Parse export snippet at point.
2763 Return a list whose CAR is `export-snippet' and CDR a plist with
2764 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2765 keywords.
2767 Assume point is at the beginning of the snippet."
2779 :value value
2780 :begin begin
2781 :end end
2785 "Interpret EXPORT-SNIPPET object as Org syntax.
2786 CONTENTS is nil."
2792 "Search for the next export-snippet object.
2794 Return value is a cons cell whose CAR is `export-snippet' and CDR
2795 its beginning position."
2804 ;;;; Footnote Reference
2807 "Parse footnote reference at point.
2809 Return a list whose CAR is `footnote-reference' and CDR a plist
2810 with `:label', `:type', `:inline-definition', `:begin', `:end'
2811 and `:post-blank' as keywords."
2833 :type type
2834 :begin begin
2835 :end end
2838 footnote-reference :inline-definition
2843 footnote-reference))))))
2846 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2847 CONTENTS is nil."
2857 "Search for the next footnote-reference object.
2859 Return value is a cons cell whose CAR is `footnote-reference' and
2860 CDR is beginning position."
2874 ;;;; Inline Babel Call
2877 "Parse inline babel call at point.
2879 Return a list whose CAR is `inline-babel-call' and CDR a plist
2880 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2882 Assume point is at the beginning of the babel call."
2893 :end end
2894 :info info
2898 "Interpret INLINE-BABEL-CALL object as Org syntax.
2899 CONTENTS is nil."
2905 ;; Remove redundant square brackets.
2908 main-source)
2912 "Search for the next inline-babel-call object.
2914 Return value is a cons cell whose CAR is `inline-babel-call' and
2915 CDR is beginning position."
2921 ;;;; Inline Src Block
2924 "Parse inline source block at point.
2926 Return a list whose CAR is `inline-src-block' and CDR a plist
2927 with `:begin', `:end', `:language', `:value', `:parameters' and
2928 `:post-blank' as keywords.
2930 Assume point is at the beginning of the inline src block."
2943 :value value
2944 :parameters parameters
2945 :begin begin
2946 :end end
2950 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2951 CONTENTS is nil."
2956 language
2958 body)))
2961 "Search for the next inline-babel-call element.
2963 Return value is a cons cell whose CAR is `inline-babel-call' and
2964 CDR is beginning position."
2970 ;;;; Italic
2973 "Parse italic object at point.
2975 Return a list whose CAR is `italic' and CDR is a plist with
2976 `:begin', `:end', `:contents-begin' and `:contents-end' and
2977 `:post-blank' keywords.
2979 Assume point is at the first slash marker."
2991 :end end
2992 :contents-begin contents-begin
2993 :contents-end contents-end
2997 "Interpret ITALIC object as Org syntax.
2998 CONTENTS is the contents of the object."
3002 ;;;; Latex Fragment
3005 "Parse LaTeX fragment at point.
3007 Return a list whose CAR is `latex-fragment' and CDR a plist with
3008 `:value', `:begin', `:end', and `:post-blank' as keywords.
3010 Assume point is at the beginning of the LaTeX fragment."
3023 ;; None found: it's a macro.
3032 :begin begin
3033 :end end
3037 "Interpret LATEX-FRAGMENT object as Org syntax.
3038 CONTENTS is nil."
3041 ;;;; Line Break
3044 "Parse line break at point.
3046 Return a list whose CAR is `line-break', and CDR a plist with
3047 `:begin', `:end' and `:post-blank' keywords.
3049 Assume point is at the beginning of the line break."
3056 "Interpret LINE-BREAK object as Org syntax.
3057 CONTENTS is nil."
3061 "Search for the next line-break object.
3063 Return value is a cons cell whose CAR is `line-break' and CDR is
3064 beginning position."
3068 ;; A line break can only happen on a non-empty line.
3073 ;;;; Link
3076 "Parse link at point.
3078 Return a list whose CAR is `link' and CDR a plist with `:type',
3079 `:path', `:raw-link', `:application', `:search-option', `:begin',
3080 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3081 keywords.
3083 Assume point is at the beginning of the link."
3086 end contents-begin contents-end link-end post-blank path type
3087 raw-link link search-option application)
3089 ;; Type 1: Text targeted from a radio target.
3096 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3101 ;; RAW-LINK is the original link. Expand any
3102 ;; abbreviation in it.
3106 ;; Determine TYPE of link and set PATH accordingly.
3108 ;; File type.
3112 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3115 ;; According to RFC 3986, extra whitespace should be
3116 ;; ignored when a URI is extracted.
3119 ;; Id type: PATH is the id.
3122 ;; Code-ref type: PATH is the name of the reference.
3125 ;; Custom-id type: PATH is the name of the custom id.
3128 ;; Fuzzy type: Internal link either matches a target, an
3129 ;; headline name or nothing. PATH is the target or
3130 ;; headline's name.
3132 ;; Type 3: Plain link, e.g., http://orgmode.org
3138 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3145 ;; In any case, deduce end point after trailing white space from
3146 ;; LINK-END variable.
3149 ;; Special "file" type link processing.
3151 ;; Extract opening application and search option.
3159 ;; Normalize URI.
3163 ;; Make sure TYPE always reports "file".
3167 :path path
3169 :application application
3170 :search-option search-option
3171 :begin begin
3172 :end end
3173 :contents-begin contents-begin
3174 :contents-end contents-end
3178 "Interpret LINK object as Org syntax.
3179 CONTENTS is the contents of the object, or nil."
3184 raw-link
3188 "Search for the next link object.
3190 Return value is a cons cell whose CAR is `link' and CDR is
3191 beginning position."
3200 "Search for the next plain link object.
3202 Return value is a cons cell whose CAR is `link' and CDR is
3203 beginning position."
3208 ;;;; Macro
3211 "Parse macro at point.
3213 Return a list whose CAR is `macro' and CDR a plist with `:key',
3214 `:args', `:begin', `:end', `:value' and `:post-blank' as
3215 keywords.
3217 Assume point is at the macro."
3228 ;; Do not use `org-split-string' since empty
3229 ;; strings are meaningful here.
3237 args nil t)
3241 :value value
3242 :args args
3243 :begin begin
3244 :end end
3248 "Interpret MACRO object as Org syntax.
3249 CONTENTS is nil."
3253 "Search for the next macro object.
3255 Return value is cons cell whose CAR is `macro' and CDR is
3256 beginning position."
3260 nil t)
3264 ;;;; Radio-target
3267 "Parse radio target at point.
3269 Return a list whose CAR is `radio-target' and CDR a plist with
3270 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3271 and `:post-blank' as keywords.
3273 Assume point is at the radio target."
3285 :end end
3286 :contents-begin contents-begin
3287 :contents-end contents-end
3288 :post-blank post-blank
3292 "Interpret TARGET object as Org syntax.
3293 CONTENTS is the contents of the object."
3297 "Search for the next radio-target object.
3299 Return value is a cons cell whose CAR is `radio-target' and CDR
3300 is beginning position."
3306 ;;;; Statistics Cookie
3309 "Parse statistics cookie at point.
3311 Return a list whose CAR is `statistics-cookie', and CDR a plist
3312 with `:begin', `:end', `:value' and `:post-blank' keywords.
3314 Assume point is at the beginning of the statistics-cookie."
3325 :end end
3326 :value value
3330 "Interpret STATISTICS-COOKIE object as Org syntax.
3331 CONTENTS is nil."
3335 "Search for the next statistics cookie object.
3337 Return value is a cons cell whose CAR is `statistics-cookie' and
3338 CDR is beginning position."
3344 ;;;; Strike-Through
3347 "Parse strike-through object at point.
3349 Return a list whose CAR is `strike-through' and CDR is a plist
3350 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3351 `:post-blank' keywords.
3353 Assume point is at the first plus sign marker."
3365 :end end
3366 :contents-begin contents-begin
3367 :contents-end contents-end
3371 "Interpret STRIKE-THROUGH object as Org syntax.
3372 CONTENTS is the contents of the object."
3376 ;;;; Subscript
3379 "Parse subscript at point.
3381 Return a list whose CAR is `subscript' and CDR a plist with
3382 `:begin', `:end', `:contents-begin', `:contents-end',
3383 `:use-brackets-p' and `:post-blank' as keywords.
3385 Assume point is at the underscore."
3389 t
3400 :end end
3401 :use-brackets-p bracketsp
3402 :contents-begin contents-begin
3403 :contents-end contents-end
3407 "Interpret SUBSCRIPT object as Org syntax.
3408 CONTENTS is the contents of the object."
3411 contents))
3414 "Search for the next sub/superscript object.
3416 Return value is a cons cell whose CAR is either `subscript' or
3417 `superscript' and CDR is beginning position."
3425 ;;;; Superscript
3428 "Parse superscript at point.
3430 Return a list whose CAR is `superscript' and CDR a plist with
3431 `:begin', `:end', `:contents-begin', `:contents-end',
3432 `:use-brackets-p' and `:post-blank' as keywords.
3434 Assume point is at the caret."
3448 :end end
3449 :use-brackets-p bracketsp
3450 :contents-begin contents-begin
3451 :contents-end contents-end
3455 "Interpret SUPERSCRIPT object as Org syntax.
3456 CONTENTS is the contents of the object."
3459 contents))
3462 ;;;; Table Cell
3465 "Parse table cell at point.
3467 Return a list whose CAR is `table-cell' and CDR is a plist
3468 containing `:begin', `:end', `:contents-begin', `:contents-end'
3469 and `:post-blank' keywords."
3477 :end end
3478 :contents-begin contents-begin
3479 :contents-end contents-end
3483 "Interpret TABLE-CELL element as Org syntax.
3484 CONTENTS is the contents of the cell, or nil."
3488 "Search for the next table-cell object.
3490 Return value is a cons cell whose CAR is `table-cell' and CDR is
3491 beginning position."
3495 ;;;; Target
3498 "Parse target at point.
3500 Return a list whose CAR is `target' and CDR a plist with
3501 `:begin', `:end', `:value' and `:post-blank' as keywords.
3503 Assume point is at the target."
3513 :end end
3514 :value value
3518 "Interpret TARGET object as Org syntax.
3519 CONTENTS is nil."
3523 "Search for the next target object.
3525 Return value is a cons cell whose CAR is `target' and CDR is
3526 beginning position."
3532 ;;;; Timestamp
3535 "Parse time stamp at point.
3537 Return a list whose CAR is `timestamp', and CDR a plist with
3538 `:type', `:raw-value', `:year-start', `:month-start',
3539 `:day-start', `:hour-start', `:minute-start', `:year-end',
3540 `:month-end', `:day-end', `:hour-end', `:minute-end',
3541 `:repeater-type', `:repeater-value', `:repeater-unit',
3542 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3543 `:end' and `:post-blank' keywords.
3545 Assume point is at the beginning of the timestamp."
3563 date-start)
3574 raw-value)
3576 :repeater-type
3582 :repeater-unit
3591 :warning-unit
3594 year-start month-start day-start hour-start minute-start year-end
3595 month-end day-end hour-end minute-end)
3596 ;; Parse date-start.
3604 ;; Compute date-end. It can be provided directly in time-stamp,
3605 ;; or extracted from time range. Otherwise, it defaults to the
3606 ;; same values as date-start.
3616 :raw-value raw-value
3617 :year-start year-start
3618 :month-start month-start
3619 :day-start day-start
3620 :hour-start hour-start
3621 :minute-start minute-start
3622 :year-end year-end
3623 :month-end month-end
3624 :day-end day-end
3625 :hour-end hour-end
3626 :minute-end minute-end
3627 :begin begin
3628 :end end
3630 repeater-props
3631 warning-props)))))
3634 "Interpret TIMESTAMP object as Org syntax.
3635 CONTENTS is nil."
3636 ;; Use `:raw-value' if specified.
3638 ;; Otherwise, build timestamp string.
3657 ;; Build an Org timestamp string from TIME. ACTIVEP is
3658 ;; non-nil when time stamp is active. If WITH-TIME-P is
3659 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3660 ;; specify a time range in the timestamp. REPEAT-STRING
3661 ;; is the repeater string, if any.
3665 org-time-stamp-formats)
3666 time)))
3672 nil nil ts)))
3677 " "
3678 s
3680 ;; Return value.
3681 ts)))
3693 build-ts-string
3712 0
3720 "--"
3732 "Search for the next timestamp object.
3734 Return value is a cons cell whose CAR is `timestamp' and CDR is
3735 beginning position."
3743 nil t)
3747 ;;;; Underline
3750 "Parse underline object at point.
3752 Return a list whose CAR is `underline' and CDR is a plist with
3753 `:begin', `:end', `:contents-begin' and `:contents-end' and
3754 `:post-blank' keywords.
3756 Assume point is at the first underscore marker."
3768 :end end
3769 :contents-begin contents-begin
3770 :contents-end contents-end
3774 "Interpret UNDERLINE object as Org syntax.
3775 CONTENTS is the contents of the object."
3779 ;;;; Verbatim
3782 "Parse verbatim object at point.
3784 Return a list whose CAR is `verbatim' and CDR is a plist with
3785 `:value', `:begin', `:end' and `:post-blank' keywords.
3787 Assume point is at the first equal sign marker."
3798 :begin begin
3799 :end end
3803 "Interpret VERBATIM object as Org syntax.
3804 CONTENTS is nil."
3808 \f
3809 ;;; Parsing Element Starting At Point
3810 ;;
3811 ;; `org-element--current-element' is the core function of this section.
3812 ;; It returns the Lisp representation of the element starting at
3813 ;; point.
3814 ;;
3815 ;; `org-element--current-element' makes use of special modes. They
3816 ;; are activated for fixed element chaining (e.g., `plain-list' >
3817 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3818 ;; `section'). Special modes are: `first-section', `item',
3819 ;; `node-property', `quote-section', `section' and `table-row'.
3823 "Parse the element starting at point.
3825 Return value is a list like (TYPE PROPS) where TYPE is the type
3826 of the element and PROPS a plist of properties associated to the
3827 element.
3829 Possible types are defined in `org-element-all-elements'.
3831 LIMIT bounds the search.
3833 Optional argument GRANULARITY determines the depth of the
3834 recursion. Allowed values are `headline', `greater-element',
3835 `element', `object' or nil. When it is broader than `object' (or
3836 nil), secondary values will not be parsed, since they only
3837 contain objects.
3839 Optional argument SPECIAL, when non-nil, can be either
3840 `first-section', `item', `node-property', `quote-section',
3841 `section', and `table-row'.
3843 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3844 be computed.
3846 This function assumes point is always at the beginning of the
3847 element it has to parse."
3850 ;; Determine if parsing depth allows for secondary strings
3851 ;; parsing. It only applies to elements referenced in
3852 ;; `org-element-secondary-value-alist'.
3855 ;; Item.
3858 ;; Table Row.
3860 ;; Node Property.
3862 ;; Headline.
3865 ;; Sections (must be checked after headline).
3871 limit)))
3872 ;; When not at bol, point is at the beginning of an item or
3873 ;; a footnote definition: next item is always a paragraph.
3875 ;; Planning and Clock.
3880 ;; Inlinetask.
3883 ;; From there, elements can have affiliated keywords.
3886 ;; Jumping over affiliated keywords put point off-limits.
3887 ;; Parse them as regular keywords.
3891 ;; LaTeX Environment.
3894 ;; Drawer and Property Drawer.
3899 ;; Fixed Width
3902 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3903 ;; Keywords.
3912 org-element-block-name-alist)))
3927 ;; Footnote Definition.
3930 ;; Horizontal Rule.
3933 ;; Diary Sexp.
3936 ;; Table.
3938 ;; List.
3941 limit affiliated
3943 ;; Default element: Paragraph.
3947 ;; Most elements can have affiliated keywords. When looking for an
3948 ;; element beginning, we want to move before them, as they belong to
3949 ;; that element, and, in the meantime, collect information they give
3950 ;; into appropriate properties. Hence the following function.
3953 "Collect affiliated keywords from point down to LIMIT.
3955 Return a list whose CAR is the position at the first of them and
3956 CDR a plist of keywords and values and move point to the
3957 beginning of the first line after them.
3959 As a special case, if element doesn't start at the beginning of
3960 the line (e.g., a paragraph starting an item), CAR is current
3961 position of point and CDR is nil."
3965 ;; RESTRICT is the list of objects allowed in parsed
3966 ;; keywords value.
3968 output)
3971 ;; Apply translation to RAW-KWD. From there, KWD is
3972 ;; the official keyword.
3974 org-element-keyword-translation-alist))
3975 raw-kwd))
3976 ;; Find main value for any keyword.
3982 ;; PARSEDP is non-nil when keyword should have its
3983 ;; value parsed.
3985 ;; If KWD is a dual keyword, find its secondary
3986 ;; value. Maybe parse it.
3993 ;; Attribute a property name to KWD.
3995 ;; Now set final shape for VALUE.
4001 ;; Attributes can always appear on multiple lines.
4004 ;; Eventually store the new value in OUTPUT.
4006 ;; Move to next keyword.
4008 ;; If affiliated keywords are orphaned: move back to first one.
4009 ;; They will be parsed as a paragraph.
4011 ;; Return value.
4015 \f
4016 ;;; The Org Parser
4017 ;;
4018 ;; The two major functions here are `org-element-parse-buffer', which
4019 ;; parses Org syntax inside the current buffer, taking into account
4020 ;; region, narrowing, or even visibility if specified, and
4021 ;; `org-element-parse-secondary-string', which parses objects within
4022 ;; a given string.
4023 ;;
4024 ;; The (almost) almighty `org-element-map' allows to apply a function
4025 ;; on elements or objects matching some type, and accumulate the
4026 ;; resulting values. In an export situation, it also skips unneeded
4027 ;; parts of the parse tree.
4030 "Recursively parse the buffer and return structure.
4031 If narrowing is in effect, only parse the visible part of the
4032 buffer.
4034 Optional argument GRANULARITY determines the depth of the
4035 recursion. It can be set to the following symbols:
4037 `headline' Only parse headlines.
4038 `greater-element' Don't recurse into greater elements excepted
4039 headlines and sections. Thus, elements
4040 parsed are the top-level ones.
4041 `element' Parse everything but objects and plain text.
4042 `object' Parse the complete buffer (default).
4044 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4045 elements.
4047 An element or an objects is represented as a list with the
4048 pattern (TYPE PROPERTIES CONTENTS), where :
4050 TYPE is a symbol describing the element or object. See
4051 `org-element-all-elements' and `org-element-all-objects' for an
4052 exhaustive list of such symbols. One can retrieve it with
4053 `org-element-type' function.
4055 PROPERTIES is the list of attributes attached to the element or
4056 object, as a plist. Although most of them are specific to the
4057 element or object type, all types share `:begin', `:end',
4058 `:post-blank' and `:parent' properties, which respectively
4059 refer to buffer position where the element or object starts,
4060 ends, the number of white spaces or blank lines after it, and
4061 the element or object containing it. Properties values can be
4062 obtained by using `org-element-property' function.
4064 CONTENTS is a list of elements, objects or raw strings
4065 contained in the current element or object, when applicable.
4066 One can access them with `org-element-contents' function.
4068 The Org buffer has `org-data' as type and nil as properties.
4069 `org-element-map' function can be used to find specific elements
4070 or objects within the parse tree.
4072 This function assumes that current major mode is `org-mode'."
4078 ;; Start in `first-section' mode so text before the first
4079 ;; headline belongs to a section.
4083 "Recursively parse objects in STRING and return structure.
4085 RESTRICTION is a symbol limiting the object types that will be
4086 looked after.
4088 Optional argument PARENT, when non-nil, is the element or object
4089 containing the secondary string. It is used to set correctly
4090 `:parent' property within the string."
4103 secondary))))
4107 "Map a function on selected elements or objects.
4109 DATA is a parse tree, an element, an object, a string, or a list
4110 of such constructs. TYPES is a symbol or list of symbols of
4111 elements or objects types (see `org-element-all-elements' and
4112 `org-element-all-objects' for a complete list of types). FUN is
4113 the function called on the matching element or object. It has to
4114 accept one argument: the element or object itself.
4116 When optional argument INFO is non-nil, it should be a plist
4117 holding export options. In that case, parts of the parse tree
4118 not exportable according to that property list will be skipped.
4120 When optional argument FIRST-MATCH is non-nil, stop at the first
4121 match for which FUN doesn't return nil, and return that value.
4123 Optional argument NO-RECURSION is a symbol or a list of symbols
4124 representing elements or objects types. `org-element-map' won't
4125 enter any recursive element or object whose type belongs to that
4126 list. Though, FUN can still be applied on them.
4128 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4129 apply to matching objects within parsed affiliated keywords (see
4130 `org-element-parsed-keywords').
4132 Nil values returned from FUN do not appear in the results.
4135 Examples:
4136 ---------
4138 Assuming TREE is a variable containing an Org buffer parse tree,
4139 the following example will return a flat list of all `src-block'
4140 and `example-block' elements in it:
4142 \(org-element-map tree '(example-block src-block) 'identity)
4144 The following snippet will find the first headline with a level
4147 \(org-element-map tree 'headline
4148 \(lambda (hl)
4149 \(and (= (org-element-property :level hl) 1)
4151 \(org-element-property :begin hl)))
4152 nil t)
4154 The next example will return a flat list of all `plain-list' type
4155 elements in TREE that are not a sub-list themselves:
4157 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4159 Eventually, this example will return a flat list of all `bold'
4160 type objects containing a `latex-snippet' type object, even
4161 looking into captions:
4163 \(org-element-map tree 'bold
4164 \(lambda (b)
4165 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4166 nil nil nil t)"
4167 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4170 ;; Recursion depth is determined by --CATEGORY.
4177 ;; If one object is found, the function
4178 ;; has to recurse into every object.
4181 ;; If one regular element is found, the
4182 ;; function has to recurse, at least,
4183 ;; into every element it encounters.
4186 types)
4187 category)))
4188 ;; Compute properties for affiliated keywords if necessary.
4193 org-element-affiliated-keywords)))
4194 --acc
4195 --walk-tree
4199 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4200 ;; holding contextual information.
4204 ;; Ignored element in an export context.
4206 ;; List of elements or objects.
4208 ;; Unconditionally enter parse trees.
4212 ;; Check if TYPE is matching among TYPES. If so,
4213 ;; apply FUN to --DATA and accumulate return value
4214 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4220 ;; If --DATA has a secondary string that can contain
4221 ;; objects with their type among TYPES, look into it.
4228 ;; If --DATA has any affiliated keywords and
4229 ;; WITH-AFFILIATED is non-nil, look for objects in
4230 ;; them.
4238 ;; Pay attention to the type of value.
4239 ;; Preserve order for multiple keywords.
4255 --affiliated-alist))
4256 ;; Determine if a recursion into --DATA is possible.
4258 ;; --TYPE is explicitly removed from recursion.
4260 ;; --DATA has no contents.
4262 ;; Looking for greater elements but --DATA is simply
4263 ;; an element or an object.
4266 ;; Looking for elements but --DATA is an object.
4269 ;; In any other case, map contents.
4273 ;; Return value in a proper order.
4277 ;; The following functions are internal parts of the parser.
4278 ;;
4279 ;; The first one, `org-element--parse-elements' acts at the element's
4280 ;; level.
4281 ;;
4282 ;; The second one, `org-element--parse-objects' applies on all objects
4283 ;; of a paragraph or a secondary string. It uses
4284 ;; `org-element--get-next-object-candidates' to optimize the search of
4285 ;; the next object in the buffer.
4286 ;;
4287 ;; More precisely, that function looks for every allowed object type
4288 ;; first. Then, it discards failed searches, keeps further matches,
4289 ;; and searches again types matched behind point, for subsequent
4290 ;; calls. Thus, searching for a given type fails only once, and every
4291 ;; object is searched only once at top level (but sometimes more for
4292 ;; nested types).
4296 "Parse elements between BEG and END positions.
4298 SPECIAL prioritize some elements over the others. It can be set
4299 to `first-section', `quote-section', `section' `item' or
4300 `table-row'.
4302 When value is `item', STRUCTURE will be used as the current list
4303 structure.
4305 GRANULARITY determines the depth of the recursion. See
4306 `org-element-parse-buffer' for more information.
4308 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4309 elements.
4311 Elements are accumulated into ACC."
4314 ;; Visible only: skip invisible parts at the beginning of the
4315 ;; element.
4318 ;; When parsing only headlines, skip any text before first one.
4321 ;; Main loop start.
4323 ;; Find current element's type and parse it accordingly to
4324 ;; its category.
4326 end granularity special structure))
4330 ;; Visible only: skip invisible parts between siblings.
4333 ;; Fill ELEMENT contents by side-effect.
4335 ;; If element has no contents, don't modify it.
4337 ;; Greater element: parse it between `contents-begin' and
4338 ;; `contents-end'. Make sure GRANULARITY allows the
4339 ;; recursion, or ELEMENT is a headline, in which case going
4340 ;; inside is mandatory, in order to get sub-level headings.
4348 ;; Possibly switch to a special mode.
4358 granularity visible-only element))
4359 ;; ELEMENT has contents. Parse objects inside, if
4360 ;; GRANULARITY allows it.
4366 ;; Return result.
4367 acc))
4370 "Parse objects between BEG and END and return recursive structure.
4372 Objects are accumulated in ACC.
4374 RESTRICTION is a list of object successors which are allowed in
4375 the current object."
4384 restriction candidates)))
4391 ;; 1. Text before any object. Untabify it.
4396 acc
4400 ;; 2. Object...
4403 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4404 ;; a recursive type.
4412 ;; 3. Text after last object. Untabify it.
4416 acc
4420 ;; Result.
4421 acc))))
4424 "Return an alist of candidates for the next object.
4426 RESTRICTION is a list of object types, as symbols. Only
4427 candidates with such types are looked after.
4429 OBJECTS is the previous candidates alist. If it is set to
4430 `initial', no search has been done before, and all symbols in
4431 RESTRICTION should be looked after.
4433 Return value is an alist whose CAR is the object type and CDR its
4434 beginning position."
4436 nil
4438 ;; When searching for the first time, look for every successor
4439 ;; allowed in RESTRICTION.
4443 restriction)
4444 ;; Focus on objects returned during last search. Keep those
4445 ;; still after point. Search again objects before it.
4451 type)))
4454 objects))))
4457 \f
4458 ;;; Towards A Bijective Process
4459 ;;
4460 ;; The parse tree obtained with `org-element-parse-buffer' is really
4461 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4462 ;; interpreted and expanded into a string with canonical Org syntax.
4463 ;; Hence `org-element-interpret-data'.
4464 ;;
4465 ;; The function relies internally on
4466 ;; `org-element--interpret-affiliated-keywords'.
4468 ;;;###autoload
4470 "Interpret DATA as Org syntax.
4472 DATA is a parse tree, an element, an object or a secondary string
4473 to interpret.
4475 Optional argument PARENT is used for recursive calls. It contains
4476 the element or object containing data, or nil.
4478 Return Org syntax as a string."
4482 ;; Secondary string.
4487 ;; Full Org document.
4492 ;; Plain text: return it.
4494 ;; Element/Object without contents.
4497 data nil))
4498 ;; Element/Object with contents.
4508 ;; Elements directly containing objects must
4509 ;; have their indentation normalized first.
4511 data
4512 ;; When normalizing first paragraph of an
4513 ;; item or a footnote-definition, ignore
4514 ;; first line's indentation.
4521 data
4523 contents)))))))
4525 ;; Build white spaces. If no `:post-blank' property is
4526 ;; specified, assume its value is 0.
4536 "Return ELEMENT's affiliated keywords as Org syntax.
4537 If there is no affiliated keyword, return the empty string."
4547 ": "
4550 value)
4558 ;; All attribute keywords can have multiple lines.
4564 ;; List all ELEMENT's properties matching an attribute line or an
4565 ;; affiliated keyword, but ignore translated keywords since they
4566 ;; cannot belong to the property list.
4573 org-element-keyword-translation-alist)))))
4574 collect prop)
4577 ;; Because interpretation of the parse tree must return the same
4578 ;; number of blank lines between elements and the same number of white
4579 ;; space after objects, some special care must be given to white
4580 ;; spaces.
4581 ;;
4582 ;; The first function, `org-element-normalize-string', ensures any
4583 ;; string different from the empty string will end with a single
4584 ;; newline character.
4585 ;;
4586 ;; The second function, `org-element-normalize-contents', removes
4587 ;; global indentation from the contents of the current element.
4590 "Ensure string S ends with a single newline character.
4592 If S isn't a string return it unchanged. If S is the empty
4593 string, return it. Otherwise, return a new string with a single
4594 newline character at its end."
4602 "Normalize plain text in ELEMENT's contents.
4604 ELEMENT must only contain plain text and objects.
4606 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4607 indentation to compute maximal common indentation.
4609 Return the normalized element that is element with global
4610 indentation removed from its contents. The function assumes that
4611 indentation is not done with TAB characters."
4613 find-min-ind ; For byte-compiler.
4615 ;; Return minimal common indentation within BLOB. This is
4616 ;; done by walking recursively BLOB and updating MIN-IND
4617 ;; along the way. FIRST-FLAG is non-nil when the first
4618 ;; string hasn't been seen yet. It is required as this
4619 ;; string is the only one whose indentation doesn't happen
4620 ;; after a newline character.
4627 ;; An indentation of zero means no string will be
4628 ;; modified. Quit the process.
4638 ;; Find minimal indentation in ELEMENT.
4641 ;; Build ELEMENT back, replacing each string with the same
4642 ;; string minus common indentation.
4647 ;; Return BLOB with all its strings indentation
4648 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4649 ;; is non-nil when the first string hasn't been seen
4650 ;; yet.
4665 org-element-recursive-objects)
4669 blob))))
4673 \f
4674 ;;; The Toolbox
4675 ;;
4676 ;; The first move is to implement a way to obtain the smallest element
4677 ;; containing point. This is the job of `org-element-at-point'. It
4678 ;; basically jumps back to the beginning of section containing point
4679 ;; and moves, element after element, with
4680 ;; `org-element--current-element' until the container is found. Note:
4681 ;; When using `org-element-at-point', secondary values are never
4682 ;; parsed since the function focuses on elements, not on objects.
4683 ;;
4684 ;; At a deeper level, `org-element-context' lists all elements and
4685 ;; objects containing point.
4686 ;;
4687 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4688 ;; internally by navigation and manipulation tools.
4690 ;;;###autoload
4692 "Determine closest element around point.
4694 Return value is a list like (TYPE PROPS) where TYPE is the type
4695 of the element and PROPS a plist of properties associated to the
4696 element.
4698 Possible types are defined in `org-element-all-elements'.
4699 Properties depend on element or object type, but always include
4700 `:begin', `:end', `:parent' and `:post-blank' properties.
4702 As a special case, if point is at the very beginning of a list or
4703 sub-list, returned element will be that list instead of the first
4704 item. In the same way, if point is at the beginning of the first
4705 row of a table, returned element will be the table instead of the
4706 first row.
4708 If optional argument KEEP-TRAIL is non-nil, the function returns
4709 a list of elements leading to element at point. The list's CAR
4710 is always the element at point. The following positions contain
4711 element's siblings, then parents, siblings of parents, until the
4712 first element of current section."
4714 ;; If at a headline, parse it. It is the sole element that
4715 ;; doesn't require to know about context. Be sure to disallow
4716 ;; secondary string parsing, though.
4722 ;; Otherwise move at the beginning of the section containing
4723 ;; point.
4728 element type special-flag trail struct prevs parent)
4731 ;; In empty lines at buffer's beginning, return nil.
4740 ;; In blank lines just after the headline, point still
4741 ;; belongs to the headline.
4750 ;; Parse successively each element, skipping those ending
4751 ;; before original position.
4759 ;; 1. Skip any element ending before point. Also skip
4760 ;; element ending at point when we're sure that another
4761 ;; element has started.
4766 ;; 2. An element containing point is always the element at
4767 ;; point.
4770 ;; 3. At any other greater element type, if point is
4771 ;; within contents, move into it.
4776 ;; Create an anchor for tables and plain lists:
4777 ;; when point is at the very beginning of these
4778 ;; elements, ignoring affiliated keywords,
4779 ;; target them instead of their contents.
4781 ;; When point is at contents end, do not move
4782 ;; into elements with an explicit ending, but
4783 ;; return that element instead.
4787 drawer dynamic-block inlinetask
4788 property-drawer quote-block
4789 special-block))
4790 ;; Corner case: if a list ends at the
4791 ;; end of a buffer without a final new
4792 ;; line, return last element in last
4793 ;; item instead.
4811 ;;;###autoload
4813 "Return closest element or object around point.
4815 Return value is a list like (TYPE PROPS) where TYPE is the type
4816 of the element or object and PROPS a plist of properties
4817 associated to it.
4819 Possible types are defined in `org-element-all-elements' and
4820 `org-element-all-objects'. Properties depend on element or
4821 object type, but always include `:begin', `:end', `:parent' and
4822 `:post-blank'.
4824 Optional argument ELEMENT, when non-nil, is the closest element
4825 containing point, as returned by `org-element-at-point'.
4826 Providing it allows for quicker computation."
4832 context)
4833 ;; Check if point is inside an element containing objects or at
4834 ;; a secondary string. In that case, narrow buffer to the
4835 ;; containing area. Otherwise, return ELEMENT.
4837 ;; At a parsed affiliated keyword, check if we're inside main
4838 ;; or dual value.
4845 org-element-parsed-keywords))
4854 ;; Also change type to retrieve correct restrictions.
4856 ;; At an item, objects can only be located within tag, if any.
4866 ;; At an headline or inlinetask, objects are located within
4867 ;; their title.
4874 ;; At a paragraph, a table-row or a verse block, objects are
4875 ;; located within their contents.
4879 ;; CBEG is nil for table rules.
4883 ;; At a parsed keyword, objects are located within value.
4886 org-element-document-properties))
4893 ;; At a planning line, if point is at a timestamp, return it,
4894 ;; otherwise, return element.
4911 restriction candidates))
4913 candidates)))
4914 ;; If ORIGIN is before next object in element, there's
4915 ;; no point in looking further.
4925 ;; ORIGIN is after OBJECT, so skip it.
4927 ;; ORIGIN is within a non-recursive object or at
4928 ;; an object boundaries: Return that object.
4932 ;; Otherwise, move within current object and
4933 ;; restrict search to the end of its contents.
4940 parent))))))
4943 "Non-nil when elements ELEM-A and ELEM-B are nested."
4952 "Swap elements ELEM-A and ELEM-B.
4953 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4954 end of ELEM-A."
4956 ;; There are two special cases when an element doesn't start at bol:
4957 ;; the first paragraph in an item or in a footnote definition.
4959 ;; Only a paragraph without any affiliated keyword can be moved at
4960 ;; ELEM-A position in such a situation. Note that the case of
4961 ;; a footnote definition is impossible: it cannot contain two
4962 ;; paragraphs in a row because it cannot contain a blank line.
4968 ;; In a special situation, ELEM-A will have no indentation. We'll
4969 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4983 ;; Store overlays responsible for visibility status. We
4984 ;; also need to store their boundaries as they will be
4985 ;; removed from buffer.
4992 ;; Get contents.
5000 ;; Restore ex ELEM-A overlays.
5009 ;; Restore ex ELEM-B overlays.
5018 ;; Local variables:
5019 ;; generated-autoload-file: "org-loaddefs.el"
5020 ;; End:
5022 ;;; org-element.el ends here