| blob | 508b5fdcb340d8f3ef676fba6985f05ca4e4446e |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 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 an 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, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
202 Sharing the same successor comes handy when, for example, the
207 inline-src-block italic line-break latex-fragment link macro
208 radio-target statistics-cookie strike-through subscript superscript
209 table-cell target timestamp underline verbatim)
214 table-cell underline)
224 "Alist between block names and the associated parsing function.
225 Names must be uppercase. Any block whose name has no association
231 Only these types can accept search options and an explicit
237 "List of affiliated keywords as strings.
243 ;; Regular affiliated keywords.
246 "Regexp matching any affiliated keyword.
248 Keyword name is put in match group 1. Moreover, if keyword
249 belongs to `org-element-dual-keywords', put the dual value in
250 match group 2.
258 "Alist of usual translations for keywords.
259 The key is the old name and the value the new one. The property
263 "List of affiliated keywords that can occur more than once in an element.
265 Their value will be consed into a list of strings, which will be
266 returned as the value of the property.
268 This list is checked after translations have been applied. See
269 `org-element-keyword-translation-alist'.
275 "List of affiliated keywords whose value can be parsed.
277 Their value will be stored as a secondary string: a list of
278 strings and objects.
280 This list is checked after translations have been applied. See
284 "List of affiliated keywords which can have a secondary value.
286 In Org syntax, they can be written with optional square brackets
287 before the colons. For example, RESULTS keyword can be
288 associated to a hash value with the following:
290 #+RESULTS[hash-string]: some-source
292 This list is checked after translations have been applied. See
296 "List of properties associated to the whole document.
297 Any keyword in this list will have its value parsed and stored as
304 inline-src-block latex-or-entity line-break link macro
305 radio-target sub/superscript target text-markup
306 timestamp)
308 radio-target statistics-cookie sub/superscript target text-markup
309 timestamp)
321 inline-src-block latex-or-entity line-break link macro
322 radio-target statistics-cookie sub/superscript target text-markup
323 timestamp)
326 latex-or-entity link radio-target sub/superscript target
327 text-markup timestamp)
338 latex-or-entity line-break link macro radio-target
340 "Alist of objects restrictions.
342 CAR is an element or object type containing objects and CDR is
343 a list of successors that will be called within an element or
344 object of such type.
346 For example, in a `radio-target' object, one can only find
347 entities, export snippets, latex-fragments, subscript and
348 superscript.
350 This alist also applies to secondary string. For example, an
351 `headline' type element doesn't directly contain objects, but
362 \f
363 ;;; Accessors and Setters
364 ;;
365 ;; Provide four accessors: `org-element-type', `org-element-property'
366 ;; `org-element-contents' and `org-element-restriction'.
367 ;;
368 ;; Setter functions allow to modify elements by side effect. There is
369 ;; `org-element-put-property', `org-element-set-contents',
370 ;; `org-element-set-element' and `org-element-adopt-element'. Note
371 ;; that `org-element-set-element' and `org-element-adopt-elements' are
372 ;; higher level functions since also update `:parent' property.
375 "Return type of ELEMENT.
377 The function returns the type of the element or object provided.
378 It can also return the following special value:
379 `plain-text' for a string
380 `org-data' for a complete document
381 nil in any other case."
387 "Extract the value from the PROPERTY of an ELEMENT."
392 "Extract contents from an ELEMENT."
398 "Return restriction associated to ELEMENT.
399 ELEMENT can be an element, an object or a symbol representing an
400 element or object type."
402 org-element-object-restrictions)))
405 "In ELEMENT set PROPERTY to VALUE.
406 Return modified element."
409 element))
412 "Set ELEMENT contents to CONTENTS.
413 Return modified element."
420 "Replace element or object OLD with element or object NEW.
421 The function takes care of setting `:parent' property for NEW."
422 ;; Since OLD is going to be changed into NEW by side-effect, first
423 ;; make sure that every element or object within NEW has OLD as
424 ;; parent.
427 ;; Transfer contents.
429 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
430 ;; with NEW's.
433 ;; Transfer type.
437 "Append elements to the contents of another element.
439 PARENT is an element or object. CHILDREN can be elements,
440 objects, or a strings.
442 The function takes care of setting `:parent' property for CHILD.
443 Return parent element."
444 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
445 ;; string: parent is the list itself.
448 children)
449 ;; Add CHILDREN at the end of PARENT contents.
452 parent
454 ;; Return modified PARENT element.
458 \f
459 ;;; Greater elements
460 ;;
461 ;; For each greater element type, we define a parser and an
462 ;; interpreter.
463 ;;
464 ;; A parser returns the element or object as the list described above.
465 ;; Most of them accepts no argument. Though, exceptions exist. Hence
466 ;; every element containing a secondary string (see
467 ;; `org-element-secondary-value-alist') will accept an optional
468 ;; argument to toggle parsing of that secondary string. Moreover,
469 ;; `item' parser requires current list's structure as its first
470 ;; element.
471 ;;
472 ;; An interpreter accepts two arguments: the list representation of
473 ;; the element or object, and its contents. The latter may be nil,
474 ;; depending on the element or object considered. It returns the
475 ;; appropriate Org syntax, as a string.
476 ;;
477 ;; Parsing functions must follow the naming convention:
478 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
479 ;; defined in `org-element-greater-elements'.
480 ;;
481 ;; Similarly, interpreting functions must follow the naming
482 ;; convention: org-element-TYPE-interpreter.
483 ;;
484 ;; With the exception of `headline' and `item' types, greater elements
485 ;; cannot contain other greater elements of their own type.
486 ;;
487 ;; Beside implementing a parser and an interpreter, adding a new
488 ;; greater element requires to tweak `org-element--current-element'.
489 ;; Moreover, the newly defined type must be added to both
490 ;; `org-element-all-elements' and `org-element-greater-elements'.
493 ;;;; Center Block
496 "Parse a center block.
498 LIMIT bounds the search. AFFILIATED is a list of which CAR is
499 the buffer position at the beginning of the first affiliated
500 keyword and CDR is a plist of affiliated keywords along with
501 their value.
503 Return a list whose CAR is `center-block' and CDR is a plist
504 containing `:begin', `:end', `:hiddenp', `:contents-begin',
505 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
507 Assume point is at the beginning of the block."
511 ;; Incomplete block: parse it as a paragraph.
516 ;; Empty blocks have no contents.
531 :end end
532 :hiddenp hidden
533 :contents-begin contents-begin
534 :contents-end contents-end
540 "Interpret CENTER-BLOCK element as Org syntax.
541 CONTENTS is the contents of the element."
545 ;;;; Drawer
548 "Parse a drawer.
550 LIMIT bounds the search. AFFILIATED is a list of which CAR is
551 the buffer position at the beginning of the first affiliated
552 keyword and CDR is a plist of affiliated keywords along with
553 their value.
555 Return a list whose CAR is `drawer' and CDR is a plist containing
556 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
557 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
559 Assume point is at beginning of drawer."
562 ;; Incomplete drawer: parse it as a paragraph.
570 ;; Empty drawers have no contents.
585 :end end
586 :drawer-name name
587 :hiddenp hidden
588 :contents-begin contents-begin
589 :contents-end contents-end
595 "Interpret DRAWER element as Org syntax.
596 CONTENTS is the contents of the element."
599 contents))
602 ;;;; Dynamic Block
605 "Parse a dynamic block.
607 LIMIT bounds the search. AFFILIATED is a list of which CAR is
608 the buffer position at the beginning of the first affiliated
609 keyword and CDR is a plist of affiliated keywords along with
610 their value.
612 Return a list whose CAR is `dynamic-block' and CDR is a plist
613 containing `:block-name', `:begin', `:end', `:hiddenp',
614 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
615 and `:post-affiliated' keywords.
617 Assume point is at beginning of dynamic block."
621 ;; Incomplete block: parse it as a paragraph.
630 ;; 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."
705 :begin begin
706 :end end
707 :contents-begin contents-begin
708 :contents-end contents-end
714 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
715 CONTENTS is the contents of the footnote-definition."
717 " "
718 contents))
721 ;;;; Headline
724 "Parse an headline.
726 Return a list whose CAR is `headline' and CDR is a plist
727 containing `:raw-value', `:title', `:begin', `:end',
728 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
729 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
730 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
731 `:commentedp' and `:footnote-section-p' keywords.
733 The plist also contains any property set in the property drawer,
734 with its name in lowercase, the underscores replaced with hyphens
735 and colons at the beginning (i.e. `:custom-id').
737 When RAW-SECONDARY-P is non-nil, headline's title will not be
738 parsed as a secondary string, but as a plain string instead.
740 Assume point is at beginning of the headline."
753 raw-value)))
757 raw-value)))
761 ;; Normalize property names: ":SOME_PROP:" becomes
762 ;; ":some-prop".
774 plist))
776 ;; Read time properties on the line below the headline.
782 org-keyword-time-not-clock-regexp end t)
792 plist))))
805 ;; Clean RAW-VALUE from any quote or comment string.
813 ""
814 raw-value))))
815 ;; Clean TAGS from archive tag, if any.
821 :begin begin
822 :end end
823 :pre-blank
826 :hiddenp hidden
827 :contents-begin contents-begin
828 :contents-end contents-end
829 :level level
831 :tags tags
832 :todo-keyword todo
833 :todo-type todo-type
839 end)
840 :footnote-section-p footnote-section-p
841 :archivedp archivedp
842 :commentedp commentedp
844 time-props
845 standard-props))))
847 headline :title
853 "Interpret HEADLINE element as Org syntax.
854 CONTENTS is the contents of the element."
881 ;; Align tags.
889 ? )
890 tags))
894 tags))))
896 contents)))
899 ;;;; Inlinetask
902 "Parse an inline task.
904 Return a list whose CAR is `inlinetask' and CDR is a plist
905 containing `:title', `:begin', `:end', `:hiddenp',
906 `:contents-begin' and `:contents-end', `:level', `:priority',
907 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
908 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
910 The plist also contains any property set in the property drawer,
911 with its name in lowercase, the underscores replaced with hyphens
912 and colons at the beginning (i.e. `:custom-id').
914 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
915 title will not be parsed as a secondary string, but as a plain
916 string instead.
918 Assume point is at beginning of the inline task."
928 ;; Normalize property names: ":SOME_PROP:" becomes
929 ;; ":some-prop".
941 plist))
943 ;; Read time properties on the line below the inlinetask
944 ;; opening string.
950 org-keyword-time-not-clock-regexp end t)
960 plist))))
980 :begin begin
981 :end end
982 :hiddenp hidden
983 :contents-begin contents-begin
984 :contents-end contents-end
987 :tags tags
988 :todo-keyword todo
989 :todo-type todo-type
991 time-props
992 standard-props))))
994 inlinetask :title
997 raw-value
999 inlinetask))))))
1002 "Interpret INLINETASK element as Org syntax.
1003 CONTENTS is the contents of inlinetask."
1018 ;; Align tags.
1026 ? )
1027 tags))
1031 tags))))
1032 ;; Prefer degenerate inlinetasks when there are no
1033 ;; contents.
1036 contents
1040 ;;;; Item
1043 "Parse an item.
1045 STRUCT is the structure of the plain list.
1047 Return a list whose CAR is `item' and CDR is a plist containing
1048 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1049 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1050 `:post-blank' keywords.
1052 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1053 any, will not be parsed as a secondary string, but as a plain
1054 string instead.
1056 Assume point is at the beginning of the item."
1080 ;; Ignore tags in un-ordered lists: they are just
1081 ;; a part of item's body.
1087 ;; If first line isn't empty, contents really start
1088 ;; at the text after item's meta-data.
1099 :begin begin
1100 :end end
1101 ;; CONTENTS-BEGIN and CONTENTS-END may be
1102 ;; mixed up in the case of an empty item
1103 ;; separated from the next by a blank line.
1104 ;; Thus ensure the former is always the
1105 ;; smallest.
1108 :checkbox checkbox
1109 :counter counter
1110 :hiddenp hidden
1111 :structure struct
1114 item :tag
1122 "Interpret ITEM element as Org syntax.
1123 CONTENTS is the contents of the element."
1129 ;; Compute indentation.
1134 ;; Indent contents.
1136 bullet
1149 ;;;; Plain List
1152 "Parse a plain list.
1154 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1155 the buffer position at the beginning of the first affiliated
1156 keyword and CDR is a plist of affiliated keywords along with
1157 their value. STRUCTURE is the structure of the plain list being
1158 parsed.
1160 Return a list whose CAR is `plain-list' and CDR is a plist
1161 containing `:type', `:begin', `:end', `:contents-begin' and
1162 `:contents-end', `:structure', `:post-blank' and
1163 `:post-affiliated' keywords.
1165 Assume point is at the beginning of the list."
1180 ;; Return value.
1184 :begin begin
1185 :end end
1186 :contents-begin contents-begin
1187 :contents-end contents-end
1188 :structure struct
1194 "Interpret PLAIN-LIST element as Org syntax.
1195 CONTENTS is the contents of the element."
1203 ;;;; Property Drawer
1206 "Parse a property drawer.
1208 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1209 the buffer position at the beginning of the first affiliated
1210 keyword and CDR is a plist of affiliated keywords along with
1211 their value.
1213 Return a list whose CAR is `property-drawer' and CDR is a plist
1214 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1215 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1217 Assume point is at the beginning of the property drawer."
1222 ;; Incomplete drawer: parse it as a paragraph.
1242 :end end
1243 :hiddenp hidden
1244 :contents-begin contents-begin
1245 :contents-end contents-end
1251 "Interpret PROPERTY-DRAWER element as Org syntax.
1252 CONTENTS is the properties within the drawer."
1256 ;;;; Quote Block
1259 "Parse a quote block.
1261 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1262 the buffer position at the beginning of the first affiliated
1263 keyword and CDR is a plist of affiliated keywords along with
1264 their value.
1266 Return a list whose CAR is `quote-block' and CDR is a plist
1267 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1268 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1270 Assume point is at the beginning of the block."
1274 ;; Incomplete block: parse it as a paragraph.
1280 ;; Empty blocks have no contents.
1295 :end end
1296 :hiddenp hidden
1297 :contents-begin contents-begin
1298 :contents-end contents-end
1304 "Interpret QUOTE-BLOCK element as Org syntax.
1305 CONTENTS is the contents of the element."
1309 ;;;; Section
1312 "Parse a section.
1314 LIMIT bounds the search.
1316 Return a list whose CAR is `section' and CDR is a plist
1317 containing `:begin', `:end', `:contents-begin', `contents-end'
1318 and `:post-blank' keywords."
1320 ;; Beginning of section is the beginning of the first non-blank
1321 ;; line after previous headline.
1330 :end end
1331 :contents-begin begin
1332 :contents-end pos-before-blank
1336 "Interpret SECTION element as Org syntax.
1337 CONTENTS is the contents of the element."
1338 contents)
1341 ;;;; Special Block
1344 "Parse a special block.
1346 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1347 the buffer position at the beginning of the first affiliated
1348 keyword and CDR is a plist of affiliated keywords along with
1349 their value.
1351 Return a list whose CAR is `special-block' and CDR is a plist
1352 containing `:type', `:begin', `:end', `:hiddenp',
1353 `:contents-begin', `:contents-end', `:post-blank' and
1354 `:post-affiliated' keywords.
1356 Assume point is at the beginning of the block."
1363 ;; Incomplete block: parse it as a paragraph.
1369 ;; Empty blocks have no contents.
1384 :begin begin
1385 :end end
1386 :hiddenp hidden
1387 :contents-begin contents-begin
1388 :contents-end contents-end
1394 "Interpret SPECIAL-BLOCK element as Org syntax.
1395 CONTENTS is the contents of the element."
1400 \f
1401 ;;; Elements
1402 ;;
1403 ;; For each element, a parser and an interpreter are also defined.
1404 ;; Both follow the same naming convention used for greater elements.
1405 ;;
1406 ;; Also, as for greater elements, adding a new element type is done
1407 ;; through the following steps: implement a parser and an interpreter,
1408 ;; tweak `org-element--current-element' so that it recognizes the new
1409 ;; type and add that new type to `org-element-all-elements'.
1410 ;;
1411 ;; As a special case, when the newly defined type is a block type,
1412 ;; `org-element-block-name-alist' has to be modified accordingly.
1415 ;;;; Babel Call
1418 "Parse a babel call.
1420 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1421 the buffer position at the beginning of the first affiliated
1422 keyword and CDR is a plist of affiliated keywords along with
1423 their value.
1425 Return a list whose CAR is `babel-call' and CDR is a plist
1426 containing `:begin', `:end', `:info', `:post-blank' and
1427 `:post-affiliated' as keywords."
1441 :end end
1442 :info info
1448 "Interpret BABEL-CALL element as Org syntax.
1449 CONTENTS is nil."
1455 ;; Remove redundant square brackets.
1460 ;;;; Clock
1463 "Parse a clock.
1465 LIMIT bounds the search.
1467 Return a list whose CAR is `clock' and CDR is a plist containing
1468 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1469 as keywords."
1489 :value value
1490 :duration duration
1491 :begin begin
1492 :end end
1496 "Interpret CLOCK element as Org syntax.
1497 CONTENTS is nil."
1505 "%2s:%02s"
1509 ;;;; Comment
1512 "Parse a comment.
1514 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1515 the buffer position at the beginning of the first affiliated
1516 keyword and CDR is a plist of affiliated keywords along with
1517 their value.
1519 Return a list whose CAR is `comment' and CDR is a plist
1520 containing `:begin', `:end', `:value', `:post-blank',
1521 `:post-affiliated' keywords.
1523 Assume point is at comment beginning."
1532 ;; Get comments ending.
1535 ;; Accumulate lines without leading hash and first
1536 ;; whitespace.
1551 :end end
1552 :value value
1558 "Interpret COMMENT element as Org syntax.
1559 CONTENTS is nil."
1563 ;;;; Comment Block
1566 "Parse an export block.
1568 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1569 the buffer position at the beginning of the first affiliated
1570 keyword and CDR is a plist of affiliated keywords along with
1571 their value.
1573 Return a list whose CAR is `comment-block' and CDR is a plist
1574 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1575 and `:post-affiliated' keywords.
1577 Assume point is at comment block beginning."
1581 ;; Incomplete block: parse it as a paragraph.
1596 contents-begin contents-end)))
1600 :end end
1601 :value value
1602 :hiddenp hidden
1608 "Interpret COMMENT-BLOCK element as Org syntax.
1609 CONTENTS is nil."
1614 ;;;; Diary Sexp
1617 "Parse a diary sexp.
1619 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1620 the buffer position at the beginning of the first affiliated
1621 keyword and CDR is a plist of affiliated keywords along with
1622 their value.
1624 Return a list whose CAR is `diary-sexp' and CDR is a plist
1625 containing `:begin', `:end', `:value', `:post-blank' and
1626 `:post-affiliated' keywords."
1639 :begin begin
1640 :end end
1646 "Interpret DIARY-SEXP as Org syntax.
1647 CONTENTS is nil."
1651 ;;;; Example Block
1654 "Parse an example block.
1656 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1657 the buffer position at the beginning of the first affiliated
1658 keyword and CDR is a plist of affiliated keywords along with
1659 their value.
1661 Return a list whose CAR is `example-block' and CDR is a plist
1662 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1663 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1664 `:switches', `:value', `:post-blank' and `:post-affiliated'
1665 keywords."
1669 ;; Incomplete block: parse it as a paragraph.
1676 ;; Switches analysis
1681 ;; Should labels be retained in (or stripped from) example
1682 ;; blocks?
1687 ;; What should code-references use - labels or
1688 ;; line-numbers?
1695 ;; Standard block parsing.
1702 contents-begin contents-end)))
1712 :end end
1713 :value value
1714 :switches switches
1715 :number-lines number-lines
1716 :preserve-indent preserve-indent
1717 :retain-labels retain-labels
1718 :use-labels use-labels
1719 :label-fmt label-fmt
1720 :hiddenp hidden
1726 "Interpret EXAMPLE-BLOCK element as Org syntax.
1727 CONTENTS is nil."
1736 ;;;; Export Block
1739 "Parse an export block.
1741 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1742 the buffer position at the beginning of the first affiliated
1743 keyword and CDR is a plist of affiliated keywords along with
1744 their value.
1746 Return a list whose CAR is `export-block' and CDR is a plist
1747 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1748 `:post-blank' and `:post-affiliated' keywords.
1750 Assume point is at export-block beginning."
1757 ;; Incomplete block: parse it as a paragraph.
1772 contents-end)))
1776 :end end
1777 :type type
1778 :value value
1779 :hiddenp hidden
1785 "Interpret EXPORT-BLOCK element as Org syntax.
1786 CONTENTS is nil."
1793 ;;;; Fixed-width
1796 "Parse a fixed-width section.
1798 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1799 the buffer position at the beginning of the first affiliated
1800 keyword and CDR is a plist of affiliated keywords along with
1801 their value.
1803 Return a list whose CAR is `fixed-width' and CDR is a plist
1804 containing `:begin', `:end', `:value', `:post-blank' and
1805 `:post-affiliated' keywords.
1807 Assume point is at the beginning of the fixed-width area."
1811 value
1816 ;; Accumulate text without starting colons.
1830 :end end
1831 :value value
1837 "Interpret FIXED-WIDTH element as Org syntax.
1838 CONTENTS is nil."
1843 ;;;; Horizontal Rule
1846 "Parse an horizontal rule.
1848 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1849 the buffer position at the beginning of the first affiliated
1850 keyword and CDR is a plist of affiliated keywords along with
1851 their value.
1853 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1854 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1855 keywords."
1866 :end end
1872 "Interpret HORIZONTAL-RULE element as Org syntax.
1873 CONTENTS is nil."
1877 ;;;; Keyword
1880 "Parse a keyword at point.
1882 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1883 the buffer position at the beginning of the first affiliated
1884 keyword and CDR is a plist of affiliated keywords along with
1885 their value.
1887 Return a list whose CAR is `keyword' and CDR is a plist
1888 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1889 `:post-affiliated' keywords."
1904 :value value
1905 :begin begin
1906 :end end
1912 "Interpret KEYWORD element as Org syntax.
1913 CONTENTS is nil."
1919 ;;;; Latex Environment
1922 "Parse a LaTeX environment.
1924 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1925 the buffer position at the beginning of the first affiliated
1926 keyword and CDR is a plist of affiliated keywords along with
1927 their value.
1929 Return a list whose CAR is `latex-environment' and CDR is a plist
1930 containing `:begin', `:end', `:value', `:post-blank' and
1931 `:post-affiliated' keywords.
1933 Assume point is at the beginning of the latex environment."
1940 limit t))
1941 ;; Incomplete latex environment: parse it as a paragraph.
1953 :end end
1954 :value value
1960 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1961 CONTENTS is nil."
1965 ;;;; Node Property
1968 "Parse a node-property at point.
1970 LIMIT bounds the search.
1972 Return a list whose CAR is `node-property' and CDR is a plist
1973 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1974 keywords."
1986 :value value
1987 :begin begin
1988 :end end
1992 "Interpret NODE-PROPERTY element as Org syntax.
1993 CONTENTS is nil."
1999 ;;;; Paragraph
2002 "Parse a paragraph.
2004 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2005 the buffer position at the beginning of the first affiliated
2006 keyword and CDR is a plist of affiliated keywords along with
2007 their value.
2009 Return a list whose CAR is `paragraph' and CDR is a plist
2010 containing `:begin', `:end', `:contents-begin' and
2011 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2013 Assume point is at the beginning of the paragraph."
2022 limit
2023 ;; A matching `org-element-paragraph-separate' is not
2024 ;; necessarily the end of the paragraph. In
2025 ;; particular, lines starting with # or : as a first
2026 ;; non-space character are ambiguous. We have check
2027 ;; if they are valid Org syntax (i.e. not an
2028 ;; incomplete keyword).
2032 ;; There's no ambiguity for other symbols or
2033 ;; empty lines: stop here.
2035 ;; Stop at valid fixed-width areas.
2037 ;; Stop at drawers.
2042 ;; Stop at valid comments.
2044 ;; Stop at valid dynamic blocks.
2049 ;; Stop at valid blocks.
2056 limit t)))
2057 ;; Stop at valid latex environments.
2064 limit t)))
2065 ;; Stop at valid keywords.
2067 ;; Skip everything else.
2085 :end end
2086 :contents-begin contents-begin
2087 :contents-end contents-end
2093 "Interpret PARAGRAPH element as Org syntax.
2094 CONTENTS is the contents of the element."
2095 contents)
2098 ;;;; Planning
2101 "Parse a planning.
2103 LIMIT bounds the search.
2105 Return a list whose CAR is `planning' and CDR is a plist
2106 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2107 and `:post-blank' keywords."
2117 closed deadline scheduled)
2129 :deadline deadline
2130 :scheduled scheduled
2131 :begin begin
2132 :end end
2136 "Interpret PLANNING element as Org syntax.
2137 CONTENTS is nil."
2139 'identity
2156 ;;;; Quote Section
2159 "Parse a quote section.
2161 LIMIT bounds the search.
2163 Return a list whose CAR is `quote-section' and CDR is a plist
2164 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2166 Assume point is at beginning of the section."
2177 :end end
2178 :value value
2182 "Interpret QUOTE-SECTION element as Org syntax.
2183 CONTENTS is nil."
2187 ;;;; Src Block
2190 "Parse a src block.
2192 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2193 the buffer position at the beginning of the first affiliated
2194 keyword and CDR is a plist of affiliated keywords along with
2195 their value.
2197 Return a list whose CAR is `src-block' and CDR is a plist
2198 containing `:language', `:switches', `:parameters', `:begin',
2199 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2200 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2201 `:post-blank' and `:post-affiliated' keywords.
2203 Assume point is at the beginning of the block."
2206 limit t)))
2207 ;; Incomplete block: parse it as a paragraph.
2213 ;; Get language as a string.
2222 ;; Get switches.
2224 ;; Get parameters.
2226 ;; Switches analysis
2234 ;; Should labels be retained in (or stripped from)
2235 ;; src blocks?
2240 ;; What should code-references use - labels or
2241 ;; line-numbers?
2245 ;; Get visibility status.
2247 ;; Retrieve code.
2253 ;; Get position after ending blank lines.
2264 :begin begin
2265 :end end
2266 :number-lines number-lines
2267 :preserve-indent preserve-indent
2268 :retain-labels retain-labels
2269 :use-labels use-labels
2270 :label-fmt label-fmt
2271 :hiddenp hidden
2272 :value value
2278 "Interpret SRC-BLOCK element as Org syntax.
2279 CONTENTS is nil."
2302 ;;;; Table
2305 "Parse a table at point.
2307 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2308 the buffer position at the beginning of the first affiliated
2309 keyword and CDR is a plist of affiliated keywords along with
2310 their value.
2312 Return a list whose CAR is `table' and CDR is a plist containing
2313 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2314 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2315 keywords.
2317 Assume point is at the beginning of the table."
2331 acc))
2339 :end end
2340 :type type
2341 :tblfm tblfm
2342 ;; Only `org' tables have contents. `table.el' tables
2343 ;; use a `:value' property to store raw table as
2344 ;; a string.
2349 table-begin table-end))
2355 "Interpret TABLE element as Org syntax.
2356 CONTENTS is nil."
2367 ;;;; Table Row
2370 "Parse table row at point.
2372 LIMIT bounds the search.
2374 Return a list whose CAR is `table-row' and CDR is a plist
2375 containing `:begin', `:end', `:contents-begin', `:contents-end',
2376 `:type' and `:post-blank' keywords."
2380 ;; A table rule has no contents. In that case, ensure
2381 ;; CONTENTS-BEGIN matches CONTENTS-END.
2393 :begin begin
2394 :end end
2395 :contents-begin contents-begin
2396 :contents-end contents-end
2400 "Interpret TABLE-ROW element as Org syntax.
2401 CONTENTS is the contents of the table row."
2406 ;;;; Verse Block
2409 "Parse a verse block.
2411 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2412 the buffer position at the beginning of the first affiliated
2413 keyword and CDR is a plist of affiliated keywords along with
2414 their value.
2416 Return a list whose CAR is `verse-block' and CDR is a plist
2417 containing `:begin', `:end', `:contents-begin', `:contents-end',
2418 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2420 Assume point is at beginning of the block."
2424 ;; Incomplete block: parse it as a paragraph.
2441 :end end
2442 :contents-begin contents-begin
2443 :contents-end contents-end
2444 :hiddenp hidden
2450 "Interpret VERSE-BLOCK element as Org syntax.
2451 CONTENTS is verse block contents."
2455 \f
2456 ;;; Objects
2457 ;;
2458 ;; Unlike to elements, interstices can be found between objects.
2459 ;; That's why, along with the parser, successor functions are provided
2460 ;; for each object. Some objects share the same successor (i.e. `code'
2461 ;; and `verbatim' objects).
2462 ;;
2463 ;; A successor must accept a single argument bounding the search. It
2464 ;; will return either a cons cell whose CAR is the object's type, as
2465 ;; a symbol, and CDR the position of its next occurrence, or nil.
2466 ;;
2467 ;; Successors follow the naming convention:
2468 ;; org-element-NAME-successor, where NAME is the name of the
2469 ;; successor, as defined in `org-element-all-successors'.
2470 ;;
2471 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2472 ;; object types they can contain will be specified in
2473 ;; `org-element-object-restrictions'.
2474 ;;
2475 ;; Adding a new type of object is simple. Implement a successor,
2476 ;; a parser, and an interpreter for it, all following the naming
2477 ;; convention. Register type in `org-element-all-objects' and
2478 ;; successor in `org-element-all-successors'. Maybe tweak
2479 ;; restrictions about it, and that's it.
2482 ;;;; Bold
2485 "Parse bold object at point.
2487 Return a list whose CAR is `bold' and CDR is a plist with
2488 `:begin', `:end', `:contents-begin' and `:contents-end' and
2489 `:post-blank' keywords.
2491 Assume point is at the first star marker."
2503 :end end
2504 :contents-begin contents-begin
2505 :contents-end contents-end
2509 "Interpret BOLD object as Org syntax.
2510 CONTENTS is the contents of the object."
2514 "Search for the next text-markup object.
2516 LIMIT bounds the search.
2518 Return value is a cons cell whose CAR is a symbol among `bold',
2519 `italic', `underline', `strike-through', `code' and `verbatim'
2520 and CDR is beginning position."
2536 ;;;; Code
2539 "Parse code object at point.
2541 Return a list whose CAR is `code' and CDR is a plist with
2542 `:value', `:begin', `:end' and `:post-blank' keywords.
2544 Assume point is at the first tilde marker."
2555 :begin begin
2556 :end end
2560 "Interpret CODE object as Org syntax.
2561 CONTENTS is nil."
2565 ;;;; Entity
2568 "Parse entity at point.
2570 Return a list whose CAR is `entity' and CDR a plist with
2571 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2572 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2573 keywords.
2575 Assume point is at the beginning of the entity."
2577 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2593 :begin begin
2594 :end end
2595 :use-brackets-p bracketsp
2599 "Interpret ENTITY object as Org syntax.
2600 CONTENTS is nil."
2606 "Search for the next latex-fragment or entity object.
2608 LIMIT bounds the search.
2610 Return value is a cons cell whose CAR is `entity' or
2611 `latex-fragment' and CDR is beginning position."
2616 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2623 limit t)
2626 ;; Determine if it's a real entity or a LaTeX command.
2629 ;; No entity nor command: point is at a LaTeX fragment.
2630 ;; Determine its type to get the correct beginning position.
2638 matchers)
2642 ;;;; Export Snippet
2645 "Parse export snippet at point.
2647 Return a list whose CAR is `export-snippet' and CDR a plist with
2648 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2649 keywords.
2651 Assume point is at the beginning of the snippet."
2663 :value value
2664 :begin begin
2665 :end end
2669 "Interpret EXPORT-SNIPPET object as Org syntax.
2670 CONTENTS is nil."
2676 "Search for the next export-snippet object.
2678 LIMIT bounds the search.
2680 Return value is a cons cell whose CAR is `export-snippet' and CDR
2681 its beginning position."
2690 ;;;; Footnote Reference
2693 "Parse footnote reference at point.
2695 Return a list whose CAR is `footnote-reference' and CDR a plist
2696 with `:label', `:type', `:inline-definition', `:begin', `:end'
2697 and `:post-blank' as keywords."
2719 :type type
2720 :begin begin
2721 :end end
2724 footnote-reference :inline-definition
2729 footnote-reference))))))
2732 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2733 CONTENTS is nil."
2743 "Search for the next footnote-reference object.
2745 LIMIT bounds the search.
2747 Return value is a cons cell whose CAR is `footnote-reference' and
2748 CDR is beginning position."
2762 ;;;; Inline Babel Call
2765 "Parse inline babel call at point.
2767 Return a list whose CAR is `inline-babel-call' and CDR a plist
2768 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2770 Assume point is at the beginning of the babel call."
2781 :end end
2782 :info info
2786 "Interpret INLINE-BABEL-CALL object as Org syntax.
2787 CONTENTS is nil."
2793 ;; Remove redundant square brackets.
2796 main-source)
2800 "Search for the next inline-babel-call object.
2802 LIMIT bounds the search.
2804 Return value is a cons cell whose CAR is `inline-babel-call' and
2805 CDR is beginning position."
2807 ;; Use a simplified version of
2808 ;; `org-babel-inline-lob-one-liner-regexp'.
2811 limit t)
2815 ;;;; Inline Src Block
2818 "Parse inline source block at point.
2820 LIMIT bounds the search.
2822 Return a list whose CAR is `inline-src-block' and CDR a plist
2823 with `:begin', `:end', `:language', `:value', `:parameters' and
2824 `:post-blank' as keywords.
2826 Assume point is at the beginning of the inline src block."
2839 :value value
2840 :parameters parameters
2841 :begin begin
2842 :end end
2846 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2847 CONTENTS is nil."
2852 language
2854 body)))
2857 "Search for the next inline-babel-call element.
2859 LIMIT bounds the search.
2861 Return value is a cons cell whose CAR is `inline-babel-call' and
2862 CDR is beginning position."
2868 ;;;; Italic
2871 "Parse italic object at point.
2873 Return a list whose CAR is `italic' and CDR is a plist with
2874 `:begin', `:end', `:contents-begin' and `:contents-end' and
2875 `:post-blank' keywords.
2877 Assume point is at the first slash marker."
2889 :end end
2890 :contents-begin contents-begin
2891 :contents-end contents-end
2895 "Interpret ITALIC object as Org syntax.
2896 CONTENTS is the contents of the object."
2900 ;;;; Latex Fragment
2903 "Parse latex fragment at point.
2905 Return a list whose CAR is `latex-fragment' and CDR a plist with
2906 `:value', `:begin', `:end', and `:post-blank' as keywords.
2908 Assume point is at the beginning of the latex fragment."
2922 ;; None found: it's a macro.
2931 :begin begin
2932 :end end
2936 "Interpret LATEX-FRAGMENT object as Org syntax.
2937 CONTENTS is nil."
2940 ;;;; Line Break
2943 "Parse line break at point.
2945 Return a list whose CAR is `line-break', and CDR a plist with
2946 `:begin', `:end' and `:post-blank' keywords.
2948 Assume point is at the beginning of the line break."
2952 "Interpret LINE-BREAK object as Org syntax.
2953 CONTENTS is nil."
2957 "Search for the next line-break object.
2959 LIMIT bounds the search.
2961 Return value is a cons cell whose CAR is `line-break' and CDR is
2962 beginning position."
2966 ;; A line break can only happen on a non-empty line.
2971 ;;;; Link
2974 "Parse link at point.
2976 Return a list whose CAR is `link' and CDR a plist with `:type',
2977 `:path', `:raw-link', `:application', `:search-option', `:begin',
2978 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2979 keywords.
2981 Assume point is at the beginning of the link."
2984 end contents-begin contents-end link-end post-blank path type
2985 raw-link link search-option application)
2987 ;; Type 1: Text targeted from a radio target.
2992 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2997 ;; RAW-LINK is the original link.
3002 ;; Determine TYPE of link and set PATH accordingly.
3004 ;; File type.
3007 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3010 ;; Id type: PATH is the id.
3013 ;; Code-ref type: PATH is the name of the reference.
3016 ;; Custom-id type: PATH is the name of the custom id.
3019 ;; Fuzzy type: Internal link either matches a target, an
3020 ;; headline name or nothing. PATH is the target or
3021 ;; headline's name.
3023 ;; Type 3: Plain link, i.e. http://orgmode.org
3029 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3036 ;; In any case, deduce end point after trailing white space from
3037 ;; LINK-END variable.
3040 ;; Extract search option and opening application out of
3041 ;; "file"-type links.
3043 ;; Application.
3048 ;; Extract search option from PATH.
3052 ;; Make sure TYPE always report "file".
3056 :path path
3058 :application application
3059 :search-option search-option
3060 :begin begin
3061 :end end
3062 :contents-begin contents-begin
3063 :contents-end contents-end
3067 "Interpret LINK object as Org syntax.
3068 CONTENTS is the contents of the object, or nil."
3073 raw-link
3077 "Search for the next link object.
3079 LIMIT bounds the search.
3081 Return value is a cons cell whose CAR is `link' and CDR is
3082 beginning position."
3091 ;;;; Macro
3094 "Parse macro at point.
3096 Return a list whose CAR is `macro' and CDR a plist with `:key',
3097 `:args', `:begin', `:end', `:value' and `:post-blank' as
3098 keywords.
3100 Assume point is at the macro."
3114 ;; Repair bad splits.
3122 :value value
3123 :args args
3124 :begin begin
3125 :end end
3129 "Interpret MACRO object as Org syntax.
3130 CONTENTS is nil."
3134 "Search for the next macro object.
3136 LIMIT bounds the search.
3138 Return value is cons cell whose CAR is `macro' and CDR is
3139 beginning position."
3143 limit t)
3147 ;;;; Radio-target
3150 "Parse radio target at point.
3152 Return a list whose CAR is `radio-target' and CDR a plist with
3153 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3154 and `:post-blank' as keywords.
3156 Assume point is at the radio target."
3168 :end end
3169 :contents-begin contents-begin
3170 :contents-end contents-end
3171 :post-blank post-blank
3175 "Interpret TARGET object as Org syntax.
3176 CONTENTS is the contents of the object."
3180 "Search for the next radio-target object.
3182 LIMIT bounds the search.
3184 Return value is a cons cell whose CAR is `radio-target' and CDR
3185 is beginning position."
3191 ;;;; Statistics Cookie
3194 "Parse statistics cookie at point.
3196 Return a list whose CAR is `statistics-cookie', and CDR a plist
3197 with `:begin', `:end', `:value' and `:post-blank' keywords.
3199 Assume point is at the beginning of the statistics-cookie."
3210 :end end
3211 :value value
3215 "Interpret STATISTICS-COOKIE object as Org syntax.
3216 CONTENTS is nil."
3220 "Search for the next statistics cookie object.
3222 LIMIT bounds the search.
3224 Return value is a cons cell whose CAR is `statistics-cookie' and
3225 CDR is beginning position."
3231 ;;;; Strike-Through
3234 "Parse strike-through object at point.
3236 Return a list whose CAR is `strike-through' and CDR is a plist
3237 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3238 `:post-blank' keywords.
3240 Assume point is at the first plus sign marker."
3252 :end end
3253 :contents-begin contents-begin
3254 :contents-end contents-end
3258 "Interpret STRIKE-THROUGH object as Org syntax.
3259 CONTENTS is the contents of the object."
3263 ;;;; Subscript
3266 "Parse subscript at point.
3268 Return a list whose CAR is `subscript' and CDR a plist with
3269 `:begin', `:end', `:contents-begin', `:contents-end',
3270 `:use-brackets-p' and `:post-blank' as keywords.
3272 Assume point is at the underscore."
3276 t
3287 :end end
3288 :use-brackets-p bracketsp
3289 :contents-begin contents-begin
3290 :contents-end contents-end
3294 "Interpret SUBSCRIPT object as Org syntax.
3295 CONTENTS is the contents of the object."
3298 contents))
3301 "Search for the next sub/superscript object.
3303 LIMIT bounds the search.
3305 Return value is a cons cell whose CAR is either `subscript' or
3306 `superscript' and CDR is beginning position."
3314 ;;;; Superscript
3317 "Parse superscript at point.
3319 Return a list whose CAR is `superscript' and CDR a plist with
3320 `:begin', `:end', `:contents-begin', `:contents-end',
3321 `:use-brackets-p' and `:post-blank' as keywords.
3323 Assume point is at the caret."
3337 :end end
3338 :use-brackets-p bracketsp
3339 :contents-begin contents-begin
3340 :contents-end contents-end
3344 "Interpret SUPERSCRIPT object as Org syntax.
3345 CONTENTS is the contents of the object."
3348 contents))
3351 ;;;; Table Cell
3354 "Parse table cell at point.
3356 Return a list whose CAR is `table-cell' and CDR is a plist
3357 containing `:begin', `:end', `:contents-begin', `:contents-end'
3358 and `:post-blank' keywords."
3366 :end end
3367 :contents-begin contents-begin
3368 :contents-end contents-end
3372 "Interpret TABLE-CELL element as Org syntax.
3373 CONTENTS is the contents of the cell, or nil."
3377 "Search for the next table-cell object.
3379 LIMIT bounds the search.
3381 Return value is a cons cell whose CAR is `table-cell' and CDR is
3382 beginning position."
3386 ;;;; Target
3389 "Parse target at point.
3391 Return a list whose CAR is `target' and CDR a plist with
3392 `:begin', `:end', `:value' and `:post-blank' as keywords.
3394 Assume point is at the target."
3404 :end end
3405 :value value
3409 "Interpret TARGET object as Org syntax.
3410 CONTENTS is nil."
3414 "Search for the next target object.
3416 LIMIT bounds the search.
3418 Return value is a cons cell whose CAR is `target' and CDR is
3419 beginning position."
3425 ;;;; Timestamp
3428 "Parse time stamp at point.
3430 Return a list whose CAR is `timestamp', and CDR a plist with
3431 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3433 Assume point is at the beginning of the timestamp."
3455 raw-value)
3457 :repeater-type
3463 :repeater-unit
3466 time-range year-start month-start day-start hour-start minute-start
3467 year-end month-end day-end hour-end minute-end)
3468 ;; Extract time range, if any, and remove it from date start.
3473 date-start)
3478 ;; Parse date-start.
3486 ;; Compute date-end. It can be provided directly in time-stamp,
3487 ;; or extracted from time range. Otherwise, it defaults to the
3488 ;; same values as date-start.
3498 :raw-value raw-value
3499 :year-start year-start
3500 :month-start month-start
3501 :day-start day-start
3502 :hour-start hour-start
3503 :minute-start minute-start
3504 :year-end year-end
3505 :month-end month-end
3506 :day-end day-end
3507 :hour-end hour-end
3508 :minute-end minute-end
3509 :begin begin
3510 :end end
3512 repeater-props)))))
3515 "Interpret TIMESTAMP object as Org syntax.
3516 CONTENTS is nil."
3517 ;; Use `:raw-value' if specified.
3519 ;; Otherwise, build timestamp string.
3521 ;; Build an Org timestamp string from TIME. ACTIVEP is
3522 ;; non-nil when time stamp is active. If WITH-TIME-P is
3523 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3524 ;; specify a time range in the timestamp. REPEAT-STRING
3525 ;; is the repeater string, if any.
3530 org-time-stamp-formats)
3531 time)))
3537 nil nil ts)))
3541 " "
3542 repeat-string
3544 ;; Return value.
3545 ts)))
3557 build-ts-string
3580 0
3588 "--"
3600 "Search for the next timestamp object.
3602 LIMIT bounds the search.
3604 Return value is a cons cell whose CAR is `timestamp' and CDR is
3605 beginning position."
3613 limit t)
3617 ;;;; Underline
3620 "Parse underline object at point.
3622 Return a list whose CAR is `underline' and CDR is a plist with
3623 `:begin', `:end', `:contents-begin' and `:contents-end' and
3624 `:post-blank' keywords.
3626 Assume point is at the first underscore marker."
3638 :end end
3639 :contents-begin contents-begin
3640 :contents-end contents-end
3644 "Interpret UNDERLINE object as Org syntax.
3645 CONTENTS is the contents of the object."
3649 ;;;; Verbatim
3652 "Parse verbatim object at point.
3654 Return a list whose CAR is `verbatim' and CDR is a plist with
3655 `:value', `:begin', `:end' and `:post-blank' keywords.
3657 Assume point is at the first equal sign marker."
3668 :begin begin
3669 :end end
3673 "Interpret VERBATIM object as Org syntax.
3674 CONTENTS is nil."
3678 \f
3679 ;;; Parsing Element Starting At Point
3680 ;;
3681 ;; `org-element--current-element' is the core function of this section.
3682 ;; It returns the Lisp representation of the element starting at
3683 ;; point.
3684 ;;
3685 ;; `org-element--current-element' makes use of special modes. They
3686 ;; are activated for fixed element chaining (i.e. `plain-list' >
3687 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3688 ;; `section'). Special modes are: `first-section', `item',
3689 ;; `node-property', `quote-section', `section' and `table-row'.
3693 "Parse the element starting at point.
3695 LIMIT bounds the search.
3697 Return value is a list like (TYPE PROPS) where TYPE is the type
3698 of the element and PROPS a plist of properties associated to the
3699 element.
3701 Possible types are defined in `org-element-all-elements'.
3703 Optional argument GRANULARITY determines the depth of the
3704 recursion. Allowed values are `headline', `greater-element',
3705 `element', `object' or nil. When it is broader than `object' (or
3706 nil), secondary values will not be parsed, since they only
3707 contain objects.
3709 Optional argument SPECIAL, when non-nil, can be either
3710 `first-section', `item', `node-property', `quote-section',
3711 `section', and `table-row'.
3713 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3714 be computed.
3716 This function assumes point is always at the beginning of the
3717 element it has to parse."
3720 ;; Determine if parsing depth allows for secondary strings
3721 ;; parsing. It only applies to elements referenced in
3722 ;; `org-element-secondary-value-alist'.
3725 ;; Item.
3728 ;; Table Row.
3730 ;; Node Property.
3732 ;; Headline.
3735 ;; Sections (must be checked after headline).
3741 limit)))
3742 ;; When not at bol, point is at the beginning of an item or
3743 ;; a footnote definition: next item is always a paragraph.
3745 ;; Planning and Clock.
3750 ;; Inlinetask.
3753 ;; From there, elements can have affiliated keywords.
3756 ;; LaTeX Environment.
3759 ;; Drawer and Property Drawer.
3764 ;; Fixed Width
3767 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3768 ;; Keywords.
3777 org-element-block-name-alist)))
3792 ;; Footnote Definition.
3795 ;; Horizontal Rule.
3798 ;; Diary Sexp.
3801 ;; Table.
3803 ;; List.
3807 ;; Default element: Paragraph.
3811 ;; Most elements can have affiliated keywords. When looking for an
3812 ;; element beginning, we want to move before them, as they belong to
3813 ;; that element, and, in the meantime, collect information they give
3814 ;; into appropriate properties. Hence the following function.
3817 "Collect affiliated keywords from point.
3819 Return a list whose CAR is the position at the first of them and
3820 CDR a plist of keywords and values and move point to the
3821 beginning of the first line after them.
3823 As a special case, if element doesn't start at the beginning of
3824 the line (i.e. a paragraph starting an item), CAR is current
3825 position of point and CDR is nil."
3829 ;; RESTRICT is the list of objects allowed in parsed
3830 ;; keywords value.
3832 output)
3835 ;; Apply translation to RAW-KWD. From there, KWD is
3836 ;; the official keyword.
3838 org-element-keyword-translation-alist))
3839 raw-kwd))
3840 ;; Find main value for any keyword.
3846 ;; PARSEDP is non-nil when keyword should have its
3847 ;; value parsed.
3849 ;; If KWD is a dual keyword, find its secondary
3850 ;; value. Maybe parse it.
3857 ;; Attribute a property name to KWD.
3859 ;; Now set final shape for VALUE.
3865 ;; Attributes can always appear on multiple lines.
3868 ;; Eventually store the new value in OUTPUT.
3870 ;; Move to next keyword.
3872 ;; If affiliated keywords are orphaned: move back to first one.
3873 ;; They will be parsed as a paragraph.
3875 ;; Return value.
3879 \f
3880 ;;; The Org Parser
3881 ;;
3882 ;; The two major functions here are `org-element-parse-buffer', which
3883 ;; parses Org syntax inside the current buffer, taking into account
3884 ;; region, narrowing, or even visibility if specified, and
3885 ;; `org-element-parse-secondary-string', which parses objects within
3886 ;; a given string.
3887 ;;
3888 ;; The (almost) almighty `org-element-map' allows to apply a function
3889 ;; on elements or objects matching some type, and accumulate the
3890 ;; resulting values. In an export situation, it also skips unneeded
3891 ;; parts of the parse tree.
3894 "Recursively parse the buffer and return structure.
3895 If narrowing is in effect, only parse the visible part of the
3896 buffer.
3898 Optional argument GRANULARITY determines the depth of the
3899 recursion. It can be set to the following symbols:
3901 `headline' Only parse headlines.
3902 `greater-element' Don't recurse into greater elements excepted
3903 headlines and sections. Thus, elements
3904 parsed are the top-level ones.
3905 `element' Parse everything but objects and plain text.
3906 `object' Parse the complete buffer (default).
3908 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3909 elements.
3911 Assume buffer is in Org mode."
3917 ;; Start in `first-section' mode so text before the first
3918 ;; headline belongs to a section.
3922 "Recursively parse objects in STRING and return structure.
3924 RESTRICTION is a symbol limiting the object types that will be
3925 looked after.
3927 Optional argument PARENT, when non-nil, is the element or object
3928 containing the secondary string. It is used to set correctly
3929 `:parent' property within the string."
3936 secondary))
3937 secondary)))
3941 "Map a function on selected elements or objects.
3943 DATA is the parsed tree, as returned by, i.e,
3944 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3945 of elements or objects types. FUN is the function called on the
3946 matching element or object. It must accept one argument: the
3947 element or object itself.
3949 When optional argument INFO is non-nil, it should be a plist
3950 holding export options. In that case, parts of the parse tree
3951 not exportable according to that property list will be skipped.
3953 When optional argument FIRST-MATCH is non-nil, stop at the first
3954 match for which FUN doesn't return nil, and return that value.
3956 Optional argument NO-RECURSION is a symbol or a list of symbols
3957 representing elements or objects types. `org-element-map' won't
3958 enter any recursive element or object whose type belongs to that
3959 list. Though, FUN can still be applied on them.
3961 When optional argument WITH-AFFILIATED is non-nil, also move into
3962 affiliated keywords to find objects.
3964 Nil values returned from FUN do not appear in the results."
3965 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3968 ;; Recursion depth is determined by --CATEGORY.
3975 ;; If one object is found, the function
3976 ;; has to recurse into every object.
3979 ;; If one regular element is found, the
3980 ;; function has to recurse, at least,
3981 ;; into every element it encounters.
3984 types)
3985 category)))
3986 ;; Compute properties for affiliated keywords if necessary.
3991 org-element-affiliated-keywords)))
3992 --acc
3993 --walk-tree
3997 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3998 ;; holding contextual information.
4002 ;; Ignored element in an export context.
4004 ;; Secondary string: only objects can be found there.
4007 ;; Unconditionally enter parse trees.
4011 ;; Check if TYPE is matching among TYPES. If so,
4012 ;; apply FUN to --DATA and accumulate return value
4013 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4019 ;; If --DATA has a secondary string that can contain
4020 ;; objects with their type among TYPES, look into it.
4027 ;; If --DATA has any affiliated keywords and
4028 ;; WITH-AFFILIATED is non-nil, look for objects in
4029 ;; them.
4037 ;; Pay attention to the type of value.
4038 ;; Preserve order for multiple keywords.
4054 --affiliated-alist))
4055 ;; Determine if a recursion into --DATA is possible.
4057 ;; --TYPE is explicitly removed from recursion.
4059 ;; --DATA has no contents.
4061 ;; Looking for greater elements but --DATA is simply
4062 ;; an element or an object.
4065 ;; Looking for elements but --DATA is an object.
4068 ;; In any other case, map contents.
4072 ;; Return value in a proper order.
4075 ;; The following functions are internal parts of the parser.
4076 ;;
4077 ;; The first one, `org-element--parse-elements' acts at the element's
4078 ;; level.
4079 ;;
4080 ;; The second one, `org-element--parse-objects' applies on all objects
4081 ;; of a paragraph or a secondary string. It uses
4082 ;; `org-element--get-next-object-candidates' to optimize the search of
4083 ;; the next object in the buffer.
4084 ;;
4085 ;; More precisely, that function looks for every allowed object type
4086 ;; first. Then, it discards failed searches, keeps further matches,
4087 ;; and searches again types matched behind point, for subsequent
4088 ;; calls. Thus, searching for a given type fails only once, and every
4089 ;; object is searched only once at top level (but sometimes more for
4090 ;; nested types).
4094 "Parse elements between BEG and END positions.
4096 SPECIAL prioritize some elements over the others. It can be set
4097 to `first-section', `quote-section', `section' `item' or
4098 `table-row'.
4100 When value is `item', STRUCTURE will be used as the current list
4101 structure.
4103 GRANULARITY determines the depth of the recursion. See
4104 `org-element-parse-buffer' for more information.
4106 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4107 elements.
4109 Elements are accumulated into ACC."
4112 ;; When parsing only headlines, skip any text before first one.
4115 ;; Main loop start.
4117 ;; Find current element's type and parse it accordingly to
4118 ;; its category.
4120 end granularity special structure))
4124 ;; Fill ELEMENT contents by side-effect.
4126 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4127 ;; no contents, don't modify it.
4130 ;; Greater element: parse it between `contents-begin' and
4131 ;; `contents-end'. Make sure GRANULARITY allows the
4132 ;; recursion, or ELEMENT is an headline, in which case going
4133 ;; inside is mandatory, in order to get sub-level headings.
4141 ;; Possibly switch to a special mode.
4150 granularity visible-only element))
4151 ;; ELEMENT has contents. Parse objects inside, if
4152 ;; GRANULARITY allows it.
4158 ;; Return result.
4159 acc))
4162 "Parse objects between BEG and END and return recursive structure.
4164 Objects are accumulated in ACC.
4166 RESTRICTION is a list of object types which are allowed in the
4167 current object."
4173 end restriction candidates)))
4180 ;; 1. Text before any object. Untabify it.
4185 acc
4189 ;; 2. Object...
4192 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4193 ;; a recursive type.
4198 cont-beg
4205 ;; 3. Text after last object. Untabify it.
4209 acc
4213 ;; Result.
4214 acc)))
4217 "Return an alist of candidates for the next object.
4219 LIMIT bounds the search, and RESTRICTION narrows candidates to
4220 some object types.
4222 Return value is an alist whose CAR is position and CDR the object
4223 type, as a symbol.
4225 OBJECTS is the previous candidates alist."
4226 ;; Filter out any object found but not belonging to RESTRICTION.
4232 type)
4233 restriction)))
4234 objects))
4236 ;; If no previous result, search every object type in RESTRICTION.
4237 ;; Otherwise, keep potential candidates (old objects located after
4238 ;; point) and ask to search again those which had matched before.
4243 objects))
4244 ;; Call the appropriate successor function for each type to search
4245 ;; and accumulate matches.
4252 type))))
4255 types-to-search)
4256 ;; Return alist.
4257 next-candidates))
4260 \f
4261 ;;; Towards A Bijective Process
4262 ;;
4263 ;; The parse tree obtained with `org-element-parse-buffer' is really
4264 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4265 ;; interpreted and expanded into a string with canonical Org syntax.
4266 ;; Hence `org-element-interpret-data'.
4267 ;;
4268 ;; The function relies internally on
4269 ;; `org-element--interpret-affiliated-keywords'.
4271 ;;;###autoload
4273 "Interpret DATA as Org syntax.
4275 DATA is a parse tree, an element, an object or a secondary string
4276 to interpret.
4278 Optional argument PARENT is used for recursive calls. It contains
4279 the element or object containing data, or nil.
4281 Return Org syntax as a string."
4285 ;; Secondary string.
4290 ;; Full Org document.
4295 ;; Plain text: remove `:parent' text property from output.
4297 ;; Element/Object without contents.
4300 data nil))
4301 ;; Element/Object with contents.
4311 ;; Elements directly containing objects must
4312 ;; have their indentation normalized first.
4314 data
4315 ;; When normalizing first paragraph of an
4316 ;; item or a footnote-definition, ignore
4317 ;; first line's indentation.
4324 data
4326 contents)))))))
4328 ;; Build white spaces. If no `:post-blank' property is
4329 ;; specified, assume its value is 0.
4339 "Return ELEMENT's affiliated keywords as Org syntax.
4340 If there is no affiliated keyword, return the empty string."
4350 ": "
4353 value)
4361 ;; All attribute keywords can have multiple lines.
4367 ;; List all ELEMENT's properties matching an attribute line or an
4368 ;; affiliated keyword, but ignore translated keywords since they
4369 ;; cannot belong to the property list.
4376 org-element-keyword-translation-alist)))))
4377 collect prop)
4380 ;; Because interpretation of the parse tree must return the same
4381 ;; number of blank lines between elements and the same number of white
4382 ;; space after objects, some special care must be given to white
4383 ;; spaces.
4384 ;;
4385 ;; The first function, `org-element-normalize-string', ensures any
4386 ;; string different from the empty string will end with a single
4387 ;; newline character.
4388 ;;
4389 ;; The second function, `org-element-normalize-contents', removes
4390 ;; global indentation from the contents of the current element.
4393 "Ensure string S ends with a single newline character.
4395 If S isn't a string return it unchanged. If S is the empty
4396 string, return it. Otherwise, return a new string with a single
4397 newline character at its end."
4405 "Normalize plain text in ELEMENT's contents.
4407 ELEMENT must only contain plain text and objects.
4409 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4410 indentation to compute maximal common indentation.
4412 Return the normalized element that is element with global
4413 indentation removed from its contents. The function assumes that
4414 indentation is not done with TAB characters."
4416 collect-inds ; for byte-compiler
4419 ;; Return list of indentations within BLOB. This is done by
4420 ;; walking recursively BLOB and updating IND-LIST along the
4421 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4422 ;; been seen yet. It is required as this string is the only
4423 ;; one whose indentation doesn't happen after a newline
4424 ;; character.
4432 ;; An indentation of zero means no string will be
4433 ;; modified. Quit the process.
4439 ;; Avoid matching blank or empty lines.
4447 ;; Collect indentation list in ELEMENT. Possibly remove first
4448 ;; value if IGNORE-FIRST is non-nil.
4451 ;; Build ELEMENT back, replacing each string with the same
4452 ;; string minus common indentation.
4457 ;; Return BLOB with all its strings indentation
4458 ;; shortened from MCI white spaces. FIRST-FLAG is
4459 ;; non-nil when the first string hasn't been seen
4460 ;; yet.
4474 org-element-recursive-objects)
4478 blob))))
4482 \f
4483 ;;; The Toolbox
4484 ;;
4485 ;; The first move is to implement a way to obtain the smallest element
4486 ;; containing point. This is the job of `org-element-at-point'. It
4487 ;; basically jumps back to the beginning of section containing point
4488 ;; and moves, element after element, with
4489 ;; `org-element--current-element' until the container is found. Note:
4490 ;; When using `org-element-at-point', secondary values are never
4491 ;; parsed since the function focuses on elements, not on objects.
4492 ;;
4493 ;; At a deeper level, `org-element-context' lists all elements and
4494 ;; objects containing point.
4495 ;;
4496 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4497 ;; internally by navigation and manipulation tools.
4499 ;;;###autoload
4501 "Determine closest element around point.
4503 Return value is a list like (TYPE PROPS) where TYPE is the type
4504 of the element and PROPS a plist of properties associated to the
4505 element.
4507 Possible types are defined in `org-element-all-elements'.
4508 Properties depend on element or object type, but always
4509 include :begin, :end, :parent and :post-blank properties.
4511 As a special case, if point is at the very beginning of a list or
4512 sub-list, returned element will be that list instead of the first
4513 item. In the same way, if point is at the beginning of the first
4514 row of a table, returned element will be the table instead of the
4515 first row.
4517 If optional argument KEEP-TRAIL is non-nil, the function returns
4518 a list of of elements leading to element at point. The list's
4519 CAR is always the element at point. Following positions contain
4520 element's siblings, then parents, siblings of parents, until the
4521 first element of current section."
4523 ;; If at an headline, parse it. It is the sole element that
4524 ;; doesn't require to know about context. Be sure to disallow
4525 ;; secondary string parsing, though.
4531 ;; Otherwise move at the beginning of the section containing
4532 ;; point.
4536 element type special-flag trail struct prevs parent)
4544 ;; Parse successively each element, skipping those ending
4545 ;; before original position.
4554 ;; 1. Skip any element ending before point. Also skip
4555 ;; element ending at point when we're sure that another
4556 ;; element has started.
4561 ;; 2. An element containing point is always the element at
4562 ;; point.
4565 ;; 3. At any other greater element type, if point is
4566 ;; within contents, move into it.
4571 ;; Create an anchor for tables and plain lists:
4572 ;; when point is at the very beginning of these
4573 ;; elements, ignoring affiliated keywords,
4574 ;; target them instead of their contents.
4576 ;; When point is at contents end, do not move
4577 ;; into elements with an explicit ending, but
4578 ;; return that element instead.
4582 drawer dynamic-block inlinetask item
4583 plain-list property-drawer quote-block
4584 special-block))))
4597 ;;;###autoload
4599 "Return closest element or object around point.
4601 Return value is a list like (TYPE PROPS) where TYPE is the type
4602 of the element or object and PROPS a plist of properties
4603 associated to it.
4605 Possible types are defined in `org-element-all-elements' and
4606 `org-element-all-objects'. Properties depend on element or
4607 object type, but always include :begin, :end, :parent
4608 and :post-blank properties."
4613 end)
4614 ;; Check if point is inside an element containing objects or at
4615 ;; a secondary string. In that case, move to beginning of the
4616 ;; element or secondary string and set END to the other side.
4623 org-element-parsed-keywords))
4624 ;; We're at an affiliated keyword. Change
4625 ;; type to retrieve correct restrictions.
4627 ;; Determine if we're at main or dual value.
4641 (<= origin
4642 ;; `1+' is required so some
4643 ;; successors can match
4644 ;; properly their object.
4665 element
4668 candidates)
4671 end restriction candidates))
4673 candidates)))
4674 ;; If ORIGIN is before next object in element, there's
4675 ;; no point in looking further.
4684 ;; ORIGIN is after OBJECT, so skip it.
4687 ;; ORIGIN is within a non-recursive object or at an
4688 ;; object boundaries: Return that object.
4692 ;; Otherwise, move within current object and restrict
4693 ;; search to the end of its contents.
4698 end cend)))))))
4699 parent))))))
4702 "Non-nil when elements ELEM-A and ELEM-B are nested."
4711 "Swap elements ELEM-A and ELEM-B.
4712 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4713 end of ELEM-A."
4715 ;; There are two special cases when an element doesn't start at bol:
4716 ;; the first paragraph in an item or in a footnote definition.
4718 ;; Only a paragraph without any affiliated keyword can be moved at
4719 ;; ELEM-A position in such a situation. Note that the case of
4720 ;; a footnote definition is impossible: it cannot contain two
4721 ;; paragraphs in a row because it cannot contain a blank line.
4727 ;; In a special situation, ELEM-A will have no indentation. We'll
4728 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4742 ;; Store overlays responsible for visibility status. We
4743 ;; also need to store their boundaries as they will be
4744 ;; removed from buffer.
4751 ;; Get contents.
4759 ;; Restore ex ELEM-A overlays.
4768 ;; Restore ex ELEM-B overlays.
4777 ;; Local variables:
4778 ;; generated-autoload-file: "org-loaddefs.el"
4779 ;; End:
4781 ;;; org-element.el ends here