| blob | 88748ae35c4c4a90f61e3ca1dc0b76e11c2ed1f8 |
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:
125 \f
126 ;;; Definitions And Rules
127 ;;
128 ;; Define elements, greater elements and specify recursive objects,
129 ;; along with the affiliated keywords recognized. Also set up
130 ;; restrictions on recursive objects combinations.
131 ;;
132 ;; These variables really act as a control center for the parsing
133 ;; process.
137 ;; Headlines, inlinetasks.
139 ;; Footnote definitions.
141 ;; Diary sexps.
144 ;; Empty lines.
146 ;; Tables (any type).
148 ;; Blocks (any type), Babel calls, drawers (any type),
149 ;; fixed-width areas and keywords. Note: this is only an
150 ;; indication and need some thorough check.
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 latex-or-entity line-break link macro radio-target
192 statistics-cookie sub/superscript table-cell target
193 text-markup timestamp)
202 "Alist of translations between object type and successor name.
204 Sharing the same successor comes handy when, for example, the
209 inline-src-block italic line-break latex-fragment link macro
210 radio-target statistics-cookie strike-through subscript superscript
211 table-cell target timestamp underline verbatim)
216 table-cell underline)
226 "Alist between block names and the associated parsing function.
227 Names must be uppercase. Any block whose name has no association
233 Only these types can accept search options and an explicit
239 "List of affiliated keywords as strings.
245 ;; Regular affiliated keywords.
248 "Regexp matching any affiliated keyword.
250 Keyword name is put in match group 1. Moreover, if keyword
251 belongs to `org-element-dual-keywords', put the dual value in
252 match group 2.
260 "Alist of usual translations for keywords.
261 The key is the old name and the value the new one. The property
265 "List of affiliated keywords that can occur more than once in an element.
267 Their value will be consed into a list of strings, which will be
268 returned as the value of the property.
270 This list is checked after translations have been applied. See
271 `org-element-keyword-translation-alist'.
277 "List of affiliated keywords whose value can be parsed.
279 Their value will be stored as a secondary string: a list of
280 strings and objects.
282 This list is checked after translations have been applied. See
286 "List of affiliated keywords which can have a secondary value.
288 In Org syntax, they can be written with optional square brackets
289 before the colons. For example, RESULTS keyword can be
290 associated to a hash value with the following:
292 #+RESULTS[hash-string]: some-source
294 This list is checked after translations have been applied. See
298 "List of properties associated to the whole document.
299 Any keyword in this list will have its value parsed and stored as
306 inline-src-block latex-or-entity line-break link macro
307 radio-target sub/superscript target text-markup
308 timestamp)
310 radio-target statistics-cookie sub/superscript target text-markup
311 timestamp)
323 inline-src-block latex-or-entity line-break link macro
324 radio-target statistics-cookie sub/superscript target text-markup
325 timestamp)
328 latex-or-entity link radio-target sub/superscript target
329 text-markup timestamp)
340 latex-or-entity line-break link macro radio-target
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, export snippets, latex-fragments, subscript and
350 superscript.
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.
587 :end end
588 :drawer-name name
589 :hiddenp hidden
590 :contents-begin contents-begin
591 :contents-end contents-end
597 "Interpret DRAWER element as Org syntax.
598 CONTENTS is the contents of the element."
601 contents))
604 ;;;; Dynamic Block
607 "Parse a dynamic block.
609 LIMIT bounds the search. AFFILIATED is a list of which CAR is
610 the buffer position at the beginning of the first affiliated
611 keyword and CDR is a plist of affiliated keywords along with
612 their value.
614 Return a list whose CAR is `dynamic-block' and CDR is a plist
615 containing `:block-name', `:begin', `:end', `:hiddenp',
616 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
617 and `:post-affiliated' keywords.
619 Assume point is at beginning of dynamic block."
623 ;; Incomplete block: parse it as a paragraph.
632 ;; Empty blocks have no contents.
647 :end end
648 :block-name name
649 :arguments arguments
650 :hiddenp hidden
651 :contents-begin contents-begin
652 :contents-end contents-end
658 "Interpret DYNAMIC-BLOCK element as Org syntax.
659 CONTENTS is the contents of the element."
664 contents))
667 ;;;; Footnote Definition
670 "Parse a footnote definition.
672 LIMIT bounds the search. AFFILIATED is a list of which CAR is
673 the buffer position at the beginning of the first affiliated
674 keyword and CDR is a plist of affiliated keywords along with
675 their value.
677 Return a list whose CAR is `footnote-definition' and CDR is
678 a plist containing `:label', `:begin' `:end', `:contents-begin',
679 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
681 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 an headline.
728 Return a list whose CAR is `headline' and CDR is a plist
729 containing `:raw-value', `:title', `:begin', `:end',
730 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
731 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
732 `:scheduled', `:deadline', `:closed', `:clockedp', `:quotedp',
733 `:archivedp', `:commentedp' and `:footnote-section-p' keywords.
735 The plist also contains any property set in the property drawer,
736 with its name in lowercase, the underscores replaced with hyphens
737 and colons at the beginning (i.e. `:custom-id').
739 When RAW-SECONDARY-P is non-nil, headline's title will not be
740 parsed as a secondary string, but as a plain string instead.
742 Assume point is at beginning of the headline."
755 raw-value)))
759 raw-value)))
763 ;; Normalize property names: ":SOME_PROP:" becomes
764 ;; ":some-prop".
776 plist))
778 ;; Read time properties on the line below the headline.
784 org-keyword-time-not-clock-regexp end t)
794 plist))))
814 ;; Clean RAW-VALUE from any quote or comment string.
822 ""
823 raw-value))))
824 ;; Clean TAGS from archive tag, if any.
830 :begin begin
831 :end end
832 :pre-blank
835 :hiddenp hidden
836 :contents-begin contents-begin
837 :contents-end contents-end
838 :level level
840 :tags tags
841 :todo-keyword todo
842 :todo-type todo-type
848 end)
849 :footnote-section-p footnote-section-p
850 :archivedp archivedp
851 :clockedp clockedp
852 :commentedp commentedp
854 time-props
855 standard-props))))
857 headline :title
863 "Interpret HEADLINE element as Org syntax.
864 CONTENTS is the contents of the element."
891 ;; Align tags.
899 ? )
900 tags))
904 tags))))
906 contents)))
909 ;;;; Inlinetask
912 "Parse an inline task.
914 Return a list whose CAR is `inlinetask' and CDR is a plist
915 containing `:title', `:begin', `:end', `:hiddenp',
916 `:contents-begin' and `:contents-end', `:level', `:priority',
917 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
918 `:scheduled', `:deadline', `:clockedp', `:closed' and
919 `:post-blank' keywords.
921 The plist also contains any property set in the property drawer,
922 with its name in lowercase, the underscores replaced with hyphens
923 and colons at the beginning (i.e. `:custom-id').
925 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
926 title will not be parsed as a secondary string, but as a plain
927 string instead.
929 Assume point is at beginning of the inline task."
939 ;; Normalize property names: ":SOME_PROP:" becomes
940 ;; ":some-prop".
952 plist))
954 ;; Read time properties on the line below the inlinetask
955 ;; opening string.
961 org-keyword-time-not-clock-regexp end t)
971 plist))))
996 :begin begin
997 :end end
998 :hiddenp hidden
999 :contents-begin contents-begin
1000 :contents-end contents-end
1003 :tags tags
1004 :todo-keyword todo
1005 :todo-type todo-type
1006 :clockedp clockedp
1008 time-props
1009 standard-props))))
1011 inlinetask :title
1014 raw-value
1016 inlinetask))))))
1019 "Interpret INLINETASK element as Org syntax.
1020 CONTENTS is the contents of inlinetask."
1035 ;; Align tags.
1043 ? )
1044 tags))
1048 tags))))
1049 ;; Prefer degenerate inlinetasks when there are no
1050 ;; contents.
1053 contents
1057 ;;;; Item
1060 "Parse an item.
1062 STRUCT is the structure of the plain list.
1064 Return a list whose CAR is `item' and CDR is a plist containing
1065 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1066 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1067 `:post-blank' keywords.
1069 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1070 any, will not be parsed as a secondary string, but as a plain
1071 string instead.
1073 Assume point is at the beginning of the item."
1097 ;; Ignore tags in un-ordered lists: they are just
1098 ;; a part of item's body.
1104 ;; If first line isn't empty, contents really start
1105 ;; at the text after item's meta-data.
1116 :begin begin
1117 :end end
1118 ;; CONTENTS-BEGIN and CONTENTS-END may be
1119 ;; mixed up in the case of an empty item
1120 ;; separated from the next by a blank line.
1121 ;; Thus ensure the former is always the
1122 ;; smallest.
1125 :checkbox checkbox
1126 :counter counter
1127 :hiddenp hidden
1128 :structure struct
1131 item :tag
1139 "Interpret ITEM element as Org syntax.
1140 CONTENTS is the contents of the element."
1146 ;; Compute indentation.
1151 ;; Indent contents.
1153 bullet
1166 ;;;; Plain List
1169 "Parse a plain list.
1171 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1172 the buffer position at the beginning of the first affiliated
1173 keyword and CDR is a plist of affiliated keywords along with
1174 their value. STRUCTURE is the structure of the plain list being
1175 parsed.
1177 Return a list whose CAR is `plain-list' and CDR is a plist
1178 containing `:type', `:begin', `:end', `:contents-begin' and
1179 `:contents-end', `:structure', `:post-blank' and
1180 `:post-affiliated' keywords.
1182 Assume point is at the beginning of the list."
1197 ;; Return value.
1201 :begin begin
1202 :end end
1203 :contents-begin contents-begin
1204 :contents-end contents-end
1205 :structure struct
1211 "Interpret PLAIN-LIST element as Org syntax.
1212 CONTENTS is the contents of the element."
1220 ;;;; Property Drawer
1223 "Parse a property drawer.
1225 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1226 the buffer position at the beginning of the first affiliated
1227 keyword and CDR is a plist of affiliated keywords along with
1228 their value.
1230 Return a list whose CAR is `property-drawer' and CDR is a plist
1231 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1232 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1234 Assume point is at the beginning of the property drawer."
1239 ;; Incomplete drawer: parse it as a paragraph.
1259 :end end
1260 :hiddenp hidden
1261 :contents-begin contents-begin
1262 :contents-end contents-end
1268 "Interpret PROPERTY-DRAWER element as Org syntax.
1269 CONTENTS is the properties within the drawer."
1273 ;;;; Quote Block
1276 "Parse a quote block.
1278 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1279 the buffer position at the beginning of the first affiliated
1280 keyword and CDR is a plist of affiliated keywords along with
1281 their value.
1283 Return a list whose CAR is `quote-block' and CDR is a plist
1284 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1285 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1287 Assume point is at the beginning of the block."
1291 ;; Incomplete block: parse it as a paragraph.
1297 ;; Empty blocks have no contents.
1312 :end end
1313 :hiddenp hidden
1314 :contents-begin contents-begin
1315 :contents-end contents-end
1321 "Interpret QUOTE-BLOCK element as Org syntax.
1322 CONTENTS is the contents of the element."
1326 ;;;; Section
1329 "Parse a section.
1331 LIMIT bounds the search.
1333 Return a list whose CAR is `section' and CDR is a plist
1334 containing `:begin', `:end', `:contents-begin', `contents-end'
1335 and `:post-blank' keywords."
1337 ;; Beginning of section is the beginning of the first non-blank
1338 ;; line after previous headline.
1347 :end end
1348 :contents-begin begin
1349 :contents-end pos-before-blank
1353 "Interpret SECTION element as Org syntax.
1354 CONTENTS is the contents of the element."
1355 contents)
1358 ;;;; Special Block
1361 "Parse a special block.
1363 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1364 the buffer position at the beginning of the first affiliated
1365 keyword and CDR is a plist of affiliated keywords along with
1366 their value.
1368 Return a list whose CAR is `special-block' and CDR is a plist
1369 containing `:type', `:begin', `:end', `:hiddenp',
1370 `:contents-begin', `:contents-end', `:post-blank' and
1371 `:post-affiliated' keywords.
1373 Assume point is at the beginning of the block."
1380 ;; Incomplete block: parse it as a paragraph.
1386 ;; Empty blocks have no contents.
1401 :begin begin
1402 :end end
1403 :hiddenp hidden
1404 :contents-begin contents-begin
1405 :contents-end contents-end
1411 "Interpret SPECIAL-BLOCK element as Org syntax.
1412 CONTENTS is the contents of the element."
1417 \f
1418 ;;; Elements
1419 ;;
1420 ;; For each element, a parser and an interpreter are also defined.
1421 ;; Both follow the same naming convention used for greater elements.
1422 ;;
1423 ;; Also, as for greater elements, adding a new element type is done
1424 ;; through the following steps: implement a parser and an interpreter,
1425 ;; tweak `org-element--current-element' so that it recognizes the new
1426 ;; type and add that new type to `org-element-all-elements'.
1427 ;;
1428 ;; As a special case, when the newly defined type is a block type,
1429 ;; `org-element-block-name-alist' has to be modified accordingly.
1432 ;;;; Babel Call
1435 "Parse a babel call.
1437 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1438 the buffer position at the beginning of the first affiliated
1439 keyword and CDR is a plist of affiliated keywords along with
1440 their value.
1442 Return a list whose CAR is `babel-call' and CDR is a plist
1443 containing `:begin', `:end', `:info', `:post-blank' and
1444 `:post-affiliated' as keywords."
1458 :end end
1459 :info info
1465 "Interpret BABEL-CALL element as Org syntax.
1466 CONTENTS is nil."
1472 ;; Remove redundant square brackets.
1477 ;;;; Clock
1480 "Parse a clock.
1482 LIMIT bounds the search.
1484 Return a list whose CAR is `clock' and CDR is a plist containing
1485 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1486 as keywords."
1506 :value value
1507 :duration duration
1508 :begin begin
1509 :end end
1513 "Interpret CLOCK element as Org syntax.
1514 CONTENTS is nil."
1522 "%2s:%02s"
1526 ;;;; Comment
1529 "Parse a comment.
1531 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1532 the buffer position at the beginning of the first affiliated
1533 keyword and CDR is a plist of affiliated keywords along with
1534 their value.
1536 Return a list whose CAR is `comment' and CDR is a plist
1537 containing `:begin', `:end', `:value', `:post-blank',
1538 `:post-affiliated' keywords.
1540 Assume point is at comment beginning."
1549 ;; Get comments ending.
1552 ;; Accumulate lines without leading hash and first
1553 ;; whitespace.
1568 :end end
1569 :value value
1575 "Interpret COMMENT element as Org syntax.
1576 CONTENTS is nil."
1580 ;;;; Comment Block
1583 "Parse an export block.
1585 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1586 the buffer position at the beginning of the first affiliated
1587 keyword and CDR is a plist of affiliated keywords along with
1588 their value.
1590 Return a list whose CAR is `comment-block' and CDR is a plist
1591 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1592 and `:post-affiliated' keywords.
1594 Assume point is at comment block beginning."
1598 ;; Incomplete block: parse it as a paragraph.
1613 contents-begin contents-end)))
1617 :end end
1618 :value value
1619 :hiddenp hidden
1625 "Interpret COMMENT-BLOCK element as Org syntax.
1626 CONTENTS is nil."
1631 ;;;; Diary Sexp
1634 "Parse a diary sexp.
1636 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1637 the buffer position at the beginning of the first affiliated
1638 keyword and CDR is a plist of affiliated keywords along with
1639 their value.
1641 Return a list whose CAR is `diary-sexp' and CDR is a plist
1642 containing `:begin', `:end', `:value', `:post-blank' and
1643 `:post-affiliated' keywords."
1656 :begin begin
1657 :end end
1663 "Interpret DIARY-SEXP as Org syntax.
1664 CONTENTS is nil."
1668 ;;;; Example Block
1671 "Parse an example block.
1673 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1674 the buffer position at the beginning of the first affiliated
1675 keyword and CDR is a plist of affiliated keywords along with
1676 their value.
1678 Return a list whose CAR is `example-block' and CDR is a plist
1679 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1680 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1681 `:switches', `:value', `:post-blank' and `:post-affiliated'
1682 keywords."
1686 ;; Incomplete block: parse it as a paragraph.
1693 ;; Switches analysis
1698 ;; Should labels be retained in (or stripped from) example
1699 ;; blocks?
1704 ;; What should code-references use - labels or
1705 ;; line-numbers?
1712 ;; Standard block parsing.
1719 contents-begin contents-end)))
1729 :end end
1730 :value value
1731 :switches switches
1732 :number-lines number-lines
1733 :preserve-indent preserve-indent
1734 :retain-labels retain-labels
1735 :use-labels use-labels
1736 :label-fmt label-fmt
1737 :hiddenp hidden
1743 "Interpret EXAMPLE-BLOCK element as Org syntax.
1744 CONTENTS is nil."
1753 ;;;; Export Block
1756 "Parse an export block.
1758 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1759 the buffer position at the beginning of the first affiliated
1760 keyword and CDR is a plist of affiliated keywords along with
1761 their value.
1763 Return a list whose CAR is `export-block' and CDR is a plist
1764 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1765 `:post-blank' and `:post-affiliated' keywords.
1767 Assume point is at export-block beginning."
1774 ;; Incomplete block: parse it as a paragraph.
1789 contents-end)))
1793 :end end
1794 :type type
1795 :value value
1796 :hiddenp hidden
1802 "Interpret EXPORT-BLOCK element as Org syntax.
1803 CONTENTS is nil."
1810 ;;;; Fixed-width
1813 "Parse a fixed-width section.
1815 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1816 the buffer position at the beginning of the first affiliated
1817 keyword and CDR is a plist of affiliated keywords along with
1818 their value.
1820 Return a list whose CAR is `fixed-width' and CDR is a plist
1821 containing `:begin', `:end', `:value', `:post-blank' and
1822 `:post-affiliated' keywords.
1824 Assume point is at the beginning of the fixed-width area."
1828 value
1833 ;; Accumulate text without starting colons.
1847 :end end
1848 :value value
1854 "Interpret FIXED-WIDTH element as Org syntax.
1855 CONTENTS is nil."
1860 ;;;; Horizontal Rule
1863 "Parse an horizontal rule.
1865 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1866 the buffer position at the beginning of the first affiliated
1867 keyword and CDR is a plist of affiliated keywords along with
1868 their value.
1870 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1871 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1872 keywords."
1883 :end end
1889 "Interpret HORIZONTAL-RULE element as Org syntax.
1890 CONTENTS is nil."
1894 ;;;; Keyword
1897 "Parse a keyword at point.
1899 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1900 the buffer position at the beginning of the first affiliated
1901 keyword and CDR is a plist of affiliated keywords along with
1902 their value.
1904 Return a list whose CAR is `keyword' and CDR is a plist
1905 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1906 `:post-affiliated' keywords."
1921 :value value
1922 :begin begin
1923 :end end
1929 "Interpret KEYWORD element as Org syntax.
1930 CONTENTS is nil."
1936 ;;;; Latex Environment
1939 "Parse a LaTeX environment.
1941 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1942 the buffer position at the beginning of the first affiliated
1943 keyword and CDR is a plist of affiliated keywords along with
1944 their value.
1946 Return a list whose CAR is `latex-environment' and CDR is a plist
1947 containing `:begin', `:end', `:value', `:post-blank' and
1948 `:post-affiliated' keywords.
1950 Assume point is at the beginning of the latex environment."
1957 limit t))
1958 ;; Incomplete latex environment: parse it as a paragraph.
1970 :end end
1971 :value value
1977 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1978 CONTENTS is nil."
1982 ;;;; Node Property
1985 "Parse a node-property at point.
1987 LIMIT bounds the search.
1989 Return a list whose CAR is `node-property' and CDR is a plist
1990 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1991 keywords."
2003 :value value
2004 :begin begin
2005 :end end
2009 "Interpret NODE-PROPERTY element as Org syntax.
2010 CONTENTS is nil."
2016 ;;;; Paragraph
2019 "Parse a paragraph.
2021 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2022 the buffer position at the beginning of the first affiliated
2023 keyword and CDR is a plist of affiliated keywords along with
2024 their value.
2026 Return a list whose CAR is `paragraph' and CDR is a plist
2027 containing `:begin', `:end', `:contents-begin' and
2028 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2030 Assume point is at the beginning of the paragraph."
2039 limit
2040 ;; A matching `org-element-paragraph-separate' is not
2041 ;; necessarily the end of the paragraph. In
2042 ;; particular, lines starting with # or : as a first
2043 ;; non-space character are ambiguous. We have check
2044 ;; if they are valid Org syntax (i.e. not an
2045 ;; incomplete keyword).
2049 ;; There's no ambiguity for other symbols or
2050 ;; empty lines: stop here.
2052 ;; Stop at valid fixed-width areas.
2054 ;; Stop at drawers.
2059 ;; Stop at valid comments.
2061 ;; Stop at valid dynamic blocks.
2066 ;; Stop at valid blocks.
2073 limit t)))
2074 ;; Stop at valid latex environments.
2081 limit t)))
2082 ;; Stop at valid keywords.
2084 ;; Skip everything else.
2102 :end end
2103 :contents-begin contents-begin
2104 :contents-end contents-end
2110 "Interpret PARAGRAPH element as Org syntax.
2111 CONTENTS is the contents of the element."
2112 contents)
2115 ;;;; Planning
2118 "Parse a planning.
2120 LIMIT bounds the search.
2122 Return a list whose CAR is `planning' and CDR is a plist
2123 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2124 and `:post-blank' keywords."
2134 closed deadline scheduled)
2146 :deadline deadline
2147 :scheduled scheduled
2148 :begin begin
2149 :end end
2153 "Interpret PLANNING element as Org syntax.
2154 CONTENTS is nil."
2156 'identity
2173 ;;;; Quote Section
2176 "Parse a quote section.
2178 LIMIT bounds the search.
2180 Return a list whose CAR is `quote-section' and CDR is a plist
2181 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2183 Assume point is at beginning of the section."
2194 :end end
2195 :value value
2199 "Interpret QUOTE-SECTION element as Org syntax.
2200 CONTENTS is nil."
2204 ;;;; Src Block
2207 "Parse a src block.
2209 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2210 the buffer position at the beginning of the first affiliated
2211 keyword and CDR is a plist of affiliated keywords along with
2212 their value.
2214 Return a list whose CAR is `src-block' and CDR is a plist
2215 containing `:language', `:switches', `:parameters', `:begin',
2216 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2217 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2218 `:post-blank' and `:post-affiliated' keywords.
2220 Assume point is at the beginning of the block."
2223 limit t)))
2224 ;; Incomplete block: parse it as a paragraph.
2230 ;; Get language as a string.
2239 ;; Get switches.
2241 ;; Get parameters.
2243 ;; Switches analysis
2251 ;; Should labels be retained in (or stripped from)
2252 ;; src blocks?
2257 ;; What should code-references use - labels or
2258 ;; line-numbers?
2262 ;; Get visibility status.
2264 ;; Retrieve code.
2270 ;; Get position after ending blank lines.
2281 :begin begin
2282 :end end
2283 :number-lines number-lines
2284 :preserve-indent preserve-indent
2285 :retain-labels retain-labels
2286 :use-labels use-labels
2287 :label-fmt label-fmt
2288 :hiddenp hidden
2289 :value value
2295 "Interpret SRC-BLOCK element as Org syntax.
2296 CONTENTS is nil."
2319 ;;;; Table
2322 "Parse a table at point.
2324 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2325 the buffer position at the beginning of the first affiliated
2326 keyword and CDR is a plist of affiliated keywords along with
2327 their value.
2329 Return a list whose CAR is `table' and CDR is a plist containing
2330 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2331 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2332 keywords.
2334 Assume point is at the beginning of the table."
2348 acc))
2356 :end end
2357 :type type
2358 :tblfm tblfm
2359 ;; Only `org' tables have contents. `table.el' tables
2360 ;; use a `:value' property to store raw table as
2361 ;; a string.
2366 table-begin table-end))
2372 "Interpret TABLE element as Org syntax.
2373 CONTENTS is nil."
2384 ;;;; Table Row
2387 "Parse table row at point.
2389 LIMIT bounds the search.
2391 Return a list whose CAR is `table-row' and CDR is a plist
2392 containing `:begin', `:end', `:contents-begin', `:contents-end',
2393 `:type' and `:post-blank' keywords."
2397 ;; A table rule has no contents. In that case, ensure
2398 ;; CONTENTS-BEGIN matches CONTENTS-END.
2410 :begin begin
2411 :end end
2412 :contents-begin contents-begin
2413 :contents-end contents-end
2417 "Interpret TABLE-ROW element as Org syntax.
2418 CONTENTS is the contents of the table row."
2423 ;;;; Verse Block
2426 "Parse a verse block.
2428 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2429 the buffer position at the beginning of the first affiliated
2430 keyword and CDR is a plist of affiliated keywords along with
2431 their value.
2433 Return a list whose CAR is `verse-block' and CDR is a plist
2434 containing `:begin', `:end', `:contents-begin', `:contents-end',
2435 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2437 Assume point is at beginning of the block."
2441 ;; Incomplete block: parse it as a paragraph.
2458 :end end
2459 :contents-begin contents-begin
2460 :contents-end contents-end
2461 :hiddenp hidden
2467 "Interpret VERSE-BLOCK element as Org syntax.
2468 CONTENTS is verse block contents."
2472 \f
2473 ;;; Objects
2474 ;;
2475 ;; Unlike to elements, interstices can be found between objects.
2476 ;; That's why, along with the parser, successor functions are provided
2477 ;; for each object. Some objects share the same successor (i.e. `code'
2478 ;; and `verbatim' objects).
2479 ;;
2480 ;; A successor must accept a single argument bounding the search. It
2481 ;; will return either a cons cell whose CAR is the object's type, as
2482 ;; a symbol, and CDR the position of its next occurrence, or nil.
2483 ;;
2484 ;; Successors follow the naming convention:
2485 ;; org-element-NAME-successor, where NAME is the name of the
2486 ;; successor, as defined in `org-element-all-successors'.
2487 ;;
2488 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2489 ;; object types they can contain will be specified in
2490 ;; `org-element-object-restrictions'.
2491 ;;
2492 ;; Adding a new type of object is simple. Implement a successor,
2493 ;; a parser, and an interpreter for it, all following the naming
2494 ;; convention. Register type in `org-element-all-objects' and
2495 ;; successor in `org-element-all-successors'. Maybe tweak
2496 ;; restrictions about it, and that's it.
2499 ;;;; Bold
2502 "Parse bold object at point.
2504 Return a list whose CAR is `bold' and CDR is a plist with
2505 `:begin', `:end', `:contents-begin' and `:contents-end' and
2506 `:post-blank' keywords.
2508 Assume point is at the first star marker."
2520 :end end
2521 :contents-begin contents-begin
2522 :contents-end contents-end
2526 "Interpret BOLD object as Org syntax.
2527 CONTENTS is the contents of the object."
2531 "Search for the next text-markup object.
2533 LIMIT bounds the search.
2535 Return value is a cons cell whose CAR is a symbol among `bold',
2536 `italic', `underline', `strike-through', `code' and `verbatim'
2537 and CDR is beginning position."
2553 ;;;; Code
2556 "Parse code object at point.
2558 Return a list whose CAR is `code' and CDR is a plist with
2559 `:value', `:begin', `:end' and `:post-blank' keywords.
2561 Assume point is at the first tilde marker."
2572 :begin begin
2573 :end end
2577 "Interpret CODE object as Org syntax.
2578 CONTENTS is nil."
2582 ;;;; Entity
2585 "Parse entity at point.
2587 Return a list whose CAR is `entity' and CDR a plist with
2588 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2589 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2590 keywords.
2592 Assume point is at the beginning of the entity."
2594 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2610 :begin begin
2611 :end end
2612 :use-brackets-p bracketsp
2616 "Interpret ENTITY object as Org syntax.
2617 CONTENTS is nil."
2623 "Search for the next latex-fragment or entity object.
2625 LIMIT bounds the search.
2627 Return value is a cons cell whose CAR is `entity' or
2628 `latex-fragment' and CDR is beginning position."
2633 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2640 limit t)
2643 ;; Determine if it's a real entity or a LaTeX command.
2646 ;; No entity nor command: point is at a LaTeX fragment.
2647 ;; Determine its type to get the correct beginning position.
2655 matchers)
2659 ;;;; Export Snippet
2662 "Parse export snippet at point.
2664 Return a list whose CAR is `export-snippet' and CDR a plist with
2665 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2666 keywords.
2668 Assume point is at the beginning of the snippet."
2680 :value value
2681 :begin begin
2682 :end end
2686 "Interpret EXPORT-SNIPPET object as Org syntax.
2687 CONTENTS is nil."
2693 "Search for the next export-snippet object.
2695 LIMIT bounds the search.
2697 Return value is a cons cell whose CAR is `export-snippet' and CDR
2698 its beginning position."
2707 ;;;; Footnote Reference
2710 "Parse footnote reference at point.
2712 Return a list whose CAR is `footnote-reference' and CDR a plist
2713 with `:label', `:type', `:inline-definition', `:begin', `:end'
2714 and `:post-blank' as keywords."
2736 :type type
2737 :begin begin
2738 :end end
2741 footnote-reference :inline-definition
2746 footnote-reference))))))
2749 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2750 CONTENTS is nil."
2760 "Search for the next footnote-reference object.
2762 LIMIT bounds the search.
2764 Return value is a cons cell whose CAR is `footnote-reference' and
2765 CDR is beginning position."
2779 ;;;; Inline Babel Call
2782 "Parse inline babel call at point.
2784 Return a list whose CAR is `inline-babel-call' and CDR a plist
2785 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2787 Assume point is at the beginning of the babel call."
2798 :end end
2799 :info info
2803 "Interpret INLINE-BABEL-CALL object as Org syntax.
2804 CONTENTS is nil."
2810 ;; Remove redundant square brackets.
2813 main-source)
2817 "Search for the next inline-babel-call object.
2819 LIMIT bounds the search.
2821 Return value is a cons cell whose CAR is `inline-babel-call' and
2822 CDR is beginning position."
2824 ;; Use a simplified version of
2825 ;; `org-babel-inline-lob-one-liner-regexp'.
2828 limit t)
2832 ;;;; Inline Src Block
2835 "Parse inline source block at point.
2837 LIMIT bounds the search.
2839 Return a list whose CAR is `inline-src-block' and CDR a plist
2840 with `:begin', `:end', `:language', `:value', `:parameters' and
2841 `:post-blank' as keywords.
2843 Assume point is at the beginning of the inline src block."
2856 :value value
2857 :parameters parameters
2858 :begin begin
2859 :end end
2863 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2864 CONTENTS is nil."
2869 language
2871 body)))
2874 "Search for the next inline-babel-call element.
2876 LIMIT bounds the search.
2878 Return value is a cons cell whose CAR is `inline-babel-call' and
2879 CDR is beginning position."
2885 ;;;; Italic
2888 "Parse italic object at point.
2890 Return a list whose CAR is `italic' and CDR is a plist with
2891 `:begin', `:end', `:contents-begin' and `:contents-end' and
2892 `:post-blank' keywords.
2894 Assume point is at the first slash marker."
2906 :end end
2907 :contents-begin contents-begin
2908 :contents-end contents-end
2912 "Interpret ITALIC object as Org syntax.
2913 CONTENTS is the contents of the object."
2917 ;;;; Latex Fragment
2920 "Parse latex fragment at point.
2922 Return a list whose CAR is `latex-fragment' and CDR a plist with
2923 `:value', `:begin', `:end', and `:post-blank' as keywords.
2925 Assume point is at the beginning of the latex fragment."
2939 ;; None found: it's a macro.
2948 :begin begin
2949 :end end
2953 "Interpret LATEX-FRAGMENT object as Org syntax.
2954 CONTENTS is nil."
2957 ;;;; Line Break
2960 "Parse line break at point.
2962 Return a list whose CAR is `line-break', and CDR a plist with
2963 `:begin', `:end' and `:post-blank' keywords.
2965 Assume point is at the beginning of the line break."
2969 "Interpret LINE-BREAK object as Org syntax.
2970 CONTENTS is nil."
2974 "Search for the next line-break object.
2976 LIMIT bounds the search.
2978 Return value is a cons cell whose CAR is `line-break' and CDR is
2979 beginning position."
2983 ;; A line break can only happen on a non-empty line.
2988 ;;;; Link
2991 "Parse link at point.
2993 Return a list whose CAR is `link' and CDR a plist with `:type',
2994 `:path', `:raw-link', `:application', `:search-option', `:begin',
2995 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2996 keywords.
2998 Assume point is at the beginning of the link."
3001 end contents-begin contents-end link-end post-blank path type
3002 raw-link link search-option application)
3004 ;; Type 1: Text targeted from a radio target.
3009 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3014 ;; RAW-LINK is the original link.
3019 ;; Determine TYPE of link and set PATH accordingly.
3021 ;; File type.
3024 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3027 ;; Id type: PATH is the id.
3030 ;; Code-ref type: PATH is the name of the reference.
3033 ;; Custom-id type: PATH is the name of the custom id.
3036 ;; Fuzzy type: Internal link either matches a target, an
3037 ;; headline name or nothing. PATH is the target or
3038 ;; headline's name.
3040 ;; Type 3: Plain link, i.e. http://orgmode.org
3046 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3053 ;; In any case, deduce end point after trailing white space from
3054 ;; LINK-END variable.
3057 ;; Extract search option and opening application out of
3058 ;; "file"-type links.
3060 ;; Application.
3065 ;; Extract search option from PATH.
3069 ;; Make sure TYPE always report "file".
3073 :path path
3075 :application application
3076 :search-option search-option
3077 :begin begin
3078 :end end
3079 :contents-begin contents-begin
3080 :contents-end contents-end
3084 "Interpret LINK object as Org syntax.
3085 CONTENTS is the contents of the object, or nil."
3090 raw-link
3094 "Search for the next link object.
3096 LIMIT bounds the search.
3098 Return value is a cons cell whose CAR is `link' and CDR is
3099 beginning position."
3108 ;;;; Macro
3111 "Parse macro at point.
3113 Return a list whose CAR is `macro' and CDR a plist with `:key',
3114 `:args', `:begin', `:end', `:value' and `:post-blank' as
3115 keywords.
3117 Assume point is at the macro."
3131 ;; Repair bad splits.
3139 :value value
3140 :args args
3141 :begin begin
3142 :end end
3146 "Interpret MACRO object as Org syntax.
3147 CONTENTS is nil."
3151 "Search for the next macro object.
3153 LIMIT bounds the search.
3155 Return value is cons cell whose CAR is `macro' and CDR is
3156 beginning position."
3160 limit t)
3164 ;;;; Radio-target
3167 "Parse radio target at point.
3169 Return a list whose CAR is `radio-target' and CDR a plist with
3170 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3171 and `:post-blank' as keywords.
3173 Assume point is at the radio target."
3185 :end end
3186 :contents-begin contents-begin
3187 :contents-end contents-end
3188 :post-blank post-blank
3192 "Interpret TARGET object as Org syntax.
3193 CONTENTS is the contents of the object."
3197 "Search for the next radio-target object.
3199 LIMIT bounds the search.
3201 Return value is a cons cell whose CAR is `radio-target' and CDR
3202 is beginning position."
3208 ;;;; Statistics Cookie
3211 "Parse statistics cookie at point.
3213 Return a list whose CAR is `statistics-cookie', and CDR a plist
3214 with `:begin', `:end', `:value' and `:post-blank' keywords.
3216 Assume point is at the beginning of the statistics-cookie."
3227 :end end
3228 :value value
3232 "Interpret STATISTICS-COOKIE object as Org syntax.
3233 CONTENTS is nil."
3237 "Search for the next statistics cookie object.
3239 LIMIT bounds the search.
3241 Return value is a cons cell whose CAR is `statistics-cookie' and
3242 CDR is beginning position."
3248 ;;;; Strike-Through
3251 "Parse strike-through object at point.
3253 Return a list whose CAR is `strike-through' and CDR is a plist
3254 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3255 `:post-blank' keywords.
3257 Assume point is at the first plus sign marker."
3269 :end end
3270 :contents-begin contents-begin
3271 :contents-end contents-end
3275 "Interpret STRIKE-THROUGH object as Org syntax.
3276 CONTENTS is the contents of the object."
3280 ;;;; Subscript
3283 "Parse subscript at point.
3285 Return a list whose CAR is `subscript' and CDR a plist with
3286 `:begin', `:end', `:contents-begin', `:contents-end',
3287 `:use-brackets-p' and `:post-blank' as keywords.
3289 Assume point is at the underscore."
3293 t
3304 :end end
3305 :use-brackets-p bracketsp
3306 :contents-begin contents-begin
3307 :contents-end contents-end
3311 "Interpret SUBSCRIPT object as Org syntax.
3312 CONTENTS is the contents of the object."
3315 contents))
3318 "Search for the next sub/superscript object.
3320 LIMIT bounds the search.
3322 Return value is a cons cell whose CAR is either `subscript' or
3323 `superscript' and CDR is beginning position."
3331 ;;;; Superscript
3334 "Parse superscript at point.
3336 Return a list whose CAR is `superscript' and CDR a plist with
3337 `:begin', `:end', `:contents-begin', `:contents-end',
3338 `:use-brackets-p' and `:post-blank' as keywords.
3340 Assume point is at the caret."
3354 :end end
3355 :use-brackets-p bracketsp
3356 :contents-begin contents-begin
3357 :contents-end contents-end
3361 "Interpret SUPERSCRIPT object as Org syntax.
3362 CONTENTS is the contents of the object."
3365 contents))
3368 ;;;; Table Cell
3371 "Parse table cell at point.
3373 Return a list whose CAR is `table-cell' and CDR is a plist
3374 containing `:begin', `:end', `:contents-begin', `:contents-end'
3375 and `:post-blank' keywords."
3383 :end end
3384 :contents-begin contents-begin
3385 :contents-end contents-end
3389 "Interpret TABLE-CELL element as Org syntax.
3390 CONTENTS is the contents of the cell, or nil."
3394 "Search for the next table-cell object.
3396 LIMIT bounds the search.
3398 Return value is a cons cell whose CAR is `table-cell' and CDR is
3399 beginning position."
3403 ;;;; Target
3406 "Parse target at point.
3408 Return a list whose CAR is `target' and CDR a plist with
3409 `:begin', `:end', `:value' and `:post-blank' as keywords.
3411 Assume point is at the target."
3421 :end end
3422 :value value
3426 "Interpret TARGET object as Org syntax.
3427 CONTENTS is nil."
3431 "Search for the next target object.
3433 LIMIT bounds the search.
3435 Return value is a cons cell whose CAR is `target' and CDR is
3436 beginning position."
3442 ;;;; Timestamp
3445 "Parse time stamp at point.
3447 Return a list whose CAR is `timestamp', and CDR a plist with
3448 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3450 Assume point is at the beginning of the timestamp."
3473 raw-value)
3475 :repeater-type
3481 :repeater-unit
3484 time-range year-start month-start day-start hour-start minute-start
3485 year-end month-end day-end hour-end minute-end)
3486 ;; Extract time range, if any, and remove it from date start.
3491 date-start)
3496 ;; Parse date-start.
3504 ;; Compute date-end. It can be provided directly in time-stamp,
3505 ;; or extracted from time range. Otherwise, it defaults to the
3506 ;; same values as date-start.
3516 :raw-value raw-value
3517 :year-start year-start
3518 :month-start month-start
3519 :day-start day-start
3520 :hour-start hour-start
3521 :minute-start minute-start
3522 :year-end year-end
3523 :month-end month-end
3524 :day-end day-end
3525 :hour-end hour-end
3526 :minute-end minute-end
3527 :begin begin
3528 :end end
3530 repeater-props)))))
3533 "Interpret TIMESTAMP object as Org syntax.
3534 CONTENTS is nil."
3535 ;; Use `:raw-value' if specified.
3537 ;; Otherwise, build timestamp string.
3539 ;; Build an Org timestamp string from TIME. ACTIVEP is
3540 ;; non-nil when time stamp is active. If WITH-TIME-P is
3541 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3542 ;; specify a time range in the timestamp. REPEAT-STRING
3543 ;; is the repeater string, if any.
3548 org-time-stamp-formats)
3549 time)))
3555 nil nil ts)))
3559 " "
3560 repeat-string
3562 ;; Return value.
3563 ts)))
3575 build-ts-string
3598 0
3606 "--"
3618 "Search for the next timestamp object.
3620 LIMIT bounds the search.
3622 Return value is a cons cell whose CAR is `timestamp' and CDR is
3623 beginning position."
3631 limit t)
3635 ;;;; Underline
3638 "Parse underline object at point.
3640 Return a list whose CAR is `underline' and CDR is a plist with
3641 `:begin', `:end', `:contents-begin' and `:contents-end' and
3642 `:post-blank' keywords.
3644 Assume point is at the first underscore marker."
3656 :end end
3657 :contents-begin contents-begin
3658 :contents-end contents-end
3662 "Interpret UNDERLINE object as Org syntax.
3663 CONTENTS is the contents of the object."
3667 ;;;; Verbatim
3670 "Parse verbatim object at point.
3672 Return a list whose CAR is `verbatim' and CDR is a plist with
3673 `:value', `:begin', `:end' and `:post-blank' keywords.
3675 Assume point is at the first equal sign marker."
3686 :begin begin
3687 :end end
3691 "Interpret VERBATIM object as Org syntax.
3692 CONTENTS is nil."
3696 \f
3697 ;;; Parsing Element Starting At Point
3698 ;;
3699 ;; `org-element--current-element' is the core function of this section.
3700 ;; It returns the Lisp representation of the element starting at
3701 ;; point.
3702 ;;
3703 ;; `org-element--current-element' makes use of special modes. They
3704 ;; are activated for fixed element chaining (i.e. `plain-list' >
3705 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3706 ;; `section'). Special modes are: `first-section', `item',
3707 ;; `node-property', `quote-section', `section' and `table-row'.
3711 "Parse the element starting at point.
3713 LIMIT bounds the search.
3715 Return value is a list like (TYPE PROPS) where TYPE is the type
3716 of the element and PROPS a plist of properties associated to the
3717 element.
3719 Possible types are defined in `org-element-all-elements'.
3721 Optional argument GRANULARITY determines the depth of the
3722 recursion. Allowed values are `headline', `greater-element',
3723 `element', `object' or nil. When it is broader than `object' (or
3724 nil), secondary values will not be parsed, since they only
3725 contain objects.
3727 Optional argument SPECIAL, when non-nil, can be either
3728 `first-section', `item', `node-property', `quote-section',
3729 `section', and `table-row'.
3731 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3732 be computed.
3734 This function assumes point is always at the beginning of the
3735 element it has to parse."
3738 ;; Determine if parsing depth allows for secondary strings
3739 ;; parsing. It only applies to elements referenced in
3740 ;; `org-element-secondary-value-alist'.
3743 ;; Item.
3746 ;; Table Row.
3748 ;; Node Property.
3750 ;; Headline.
3753 ;; Sections (must be checked after headline).
3759 limit)))
3760 ;; When not at bol, point is at the beginning of an item or
3761 ;; a footnote definition: next item is always a paragraph.
3763 ;; Planning and Clock.
3768 ;; Inlinetask.
3771 ;; From there, elements can have affiliated keywords.
3774 ;; LaTeX Environment.
3777 ;; Drawer and Property Drawer.
3782 ;; Fixed Width
3785 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3786 ;; Keywords.
3795 org-element-block-name-alist)))
3810 ;; Footnote Definition.
3813 ;; Horizontal Rule.
3816 ;; Diary Sexp.
3819 ;; Table.
3821 ;; List.
3825 ;; Default element: Paragraph.
3829 ;; Most elements can have affiliated keywords. When looking for an
3830 ;; element beginning, we want to move before them, as they belong to
3831 ;; that element, and, in the meantime, collect information they give
3832 ;; into appropriate properties. Hence the following function.
3835 "Collect affiliated keywords from point.
3837 Return a list whose CAR is the position at the first of them and
3838 CDR a plist of keywords and values and move point to the
3839 beginning of the first line after them.
3841 As a special case, if element doesn't start at the beginning of
3842 the line (i.e. a paragraph starting an item), CAR is current
3843 position of point and CDR is nil."
3847 ;; RESTRICT is the list of objects allowed in parsed
3848 ;; keywords value.
3850 output)
3853 ;; Apply translation to RAW-KWD. From there, KWD is
3854 ;; the official keyword.
3856 org-element-keyword-translation-alist))
3857 raw-kwd))
3858 ;; Find main value for any keyword.
3864 ;; PARSEDP is non-nil when keyword should have its
3865 ;; value parsed.
3867 ;; If KWD is a dual keyword, find its secondary
3868 ;; value. Maybe parse it.
3875 ;; Attribute a property name to KWD.
3877 ;; Now set final shape for VALUE.
3883 ;; Attributes can always appear on multiple lines.
3886 ;; Eventually store the new value in OUTPUT.
3888 ;; Move to next keyword.
3890 ;; If affiliated keywords are orphaned: move back to first one.
3891 ;; They will be parsed as a paragraph.
3893 ;; Return value.
3897 \f
3898 ;;; The Org Parser
3899 ;;
3900 ;; The two major functions here are `org-element-parse-buffer', which
3901 ;; parses Org syntax inside the current buffer, taking into account
3902 ;; region, narrowing, or even visibility if specified, and
3903 ;; `org-element-parse-secondary-string', which parses objects within
3904 ;; a given string.
3905 ;;
3906 ;; The (almost) almighty `org-element-map' allows to apply a function
3907 ;; on elements or objects matching some type, and accumulate the
3908 ;; resulting values. In an export situation, it also skips unneeded
3909 ;; parts of the parse tree.
3912 "Recursively parse the buffer and return structure.
3913 If narrowing is in effect, only parse the visible part of the
3914 buffer.
3916 Optional argument GRANULARITY determines the depth of the
3917 recursion. It can be set to the following symbols:
3919 `headline' Only parse headlines.
3920 `greater-element' Don't recurse into greater elements excepted
3921 headlines and sections. Thus, elements
3922 parsed are the top-level ones.
3923 `element' Parse everything but objects and plain text.
3924 `object' Parse the complete buffer (default).
3926 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3927 elements.
3929 Assume buffer is in Org mode."
3935 ;; Start in `first-section' mode so text before the first
3936 ;; headline belongs to a section.
3940 "Recursively parse objects in STRING and return structure.
3942 RESTRICTION is a symbol limiting the object types that will be
3943 looked after.
3945 Optional argument PARENT, when non-nil, is the element or object
3946 containing the secondary string. It is used to set correctly
3947 `:parent' property within the string."
3954 secondary))
3955 secondary)))
3959 "Map a function on selected elements or objects.
3961 DATA is the parsed tree, as returned by, i.e,
3962 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3963 of elements or objects types. FUN is the function called on the
3964 matching element or object. It must accept one argument: the
3965 element or object itself.
3967 When optional argument INFO is non-nil, it should be a plist
3968 holding export options. In that case, parts of the parse tree
3969 not exportable according to that property list will be skipped.
3971 When optional argument FIRST-MATCH is non-nil, stop at the first
3972 match for which FUN doesn't return nil, and return that value.
3974 Optional argument NO-RECURSION is a symbol or a list of symbols
3975 representing elements or objects types. `org-element-map' won't
3976 enter any recursive element or object whose type belongs to that
3977 list. Though, FUN can still be applied on them.
3979 When optional argument WITH-AFFILIATED is non-nil, also move into
3980 affiliated keywords to find objects.
3982 Nil values returned from FUN do not appear in the results."
3983 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3986 ;; Recursion depth is determined by --CATEGORY.
3993 ;; If one object is found, the function
3994 ;; has to recurse into every object.
3997 ;; If one regular element is found, the
3998 ;; function has to recurse, at least,
3999 ;; into every element it encounters.
4002 types)
4003 category)))
4004 ;; Compute properties for affiliated keywords if necessary.
4009 org-element-affiliated-keywords)))
4010 --acc
4011 --walk-tree
4015 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4016 ;; holding contextual information.
4020 ;; Ignored element in an export context.
4022 ;; Secondary string: only objects can be found there.
4025 ;; Unconditionally enter parse trees.
4029 ;; Check if TYPE is matching among TYPES. If so,
4030 ;; apply FUN to --DATA and accumulate return value
4031 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4037 ;; If --DATA has a secondary string that can contain
4038 ;; objects with their type among TYPES, look into it.
4045 ;; If --DATA has any affiliated keywords and
4046 ;; WITH-AFFILIATED is non-nil, look for objects in
4047 ;; them.
4055 ;; Pay attention to the type of value.
4056 ;; Preserve order for multiple keywords.
4072 --affiliated-alist))
4073 ;; Determine if a recursion into --DATA is possible.
4075 ;; --TYPE is explicitly removed from recursion.
4077 ;; --DATA has no contents.
4079 ;; Looking for greater elements but --DATA is simply
4080 ;; an element or an object.
4083 ;; Looking for elements but --DATA is an object.
4086 ;; In any other case, map contents.
4090 ;; Return value in a proper order.
4093 ;; The following functions are internal parts of the parser.
4094 ;;
4095 ;; The first one, `org-element--parse-elements' acts at the element's
4096 ;; level.
4097 ;;
4098 ;; The second one, `org-element--parse-objects' applies on all objects
4099 ;; of a paragraph or a secondary string. It uses
4100 ;; `org-element--get-next-object-candidates' to optimize the search of
4101 ;; the next object in the buffer.
4102 ;;
4103 ;; More precisely, that function looks for every allowed object type
4104 ;; first. Then, it discards failed searches, keeps further matches,
4105 ;; and searches again types matched behind point, for subsequent
4106 ;; calls. Thus, searching for a given type fails only once, and every
4107 ;; object is searched only once at top level (but sometimes more for
4108 ;; nested types).
4112 "Parse elements between BEG and END positions.
4114 SPECIAL prioritize some elements over the others. It can be set
4115 to `first-section', `quote-section', `section' `item' or
4116 `table-row'.
4118 When value is `item', STRUCTURE will be used as the current list
4119 structure.
4121 GRANULARITY determines the depth of the recursion. See
4122 `org-element-parse-buffer' for more information.
4124 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4125 elements.
4127 Elements are accumulated into ACC."
4130 ;; When parsing only headlines, skip any text before first one.
4133 ;; Main loop start.
4135 ;; Find current element's type and parse it accordingly to
4136 ;; its category.
4138 end granularity special structure))
4142 ;; Fill ELEMENT contents by side-effect.
4144 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4145 ;; no contents, don't modify it.
4148 ;; Greater element: parse it between `contents-begin' and
4149 ;; `contents-end'. Make sure GRANULARITY allows the
4150 ;; recursion, or ELEMENT is an headline, in which case going
4151 ;; inside is mandatory, in order to get sub-level headings.
4159 ;; Possibly switch to a special mode.
4168 granularity visible-only element))
4169 ;; ELEMENT has contents. Parse objects inside, if
4170 ;; GRANULARITY allows it.
4176 ;; Return result.
4177 acc))
4180 "Parse objects between BEG and END and return recursive structure.
4182 Objects are accumulated in ACC.
4184 RESTRICTION is a list of object types which are allowed in the
4185 current object."
4191 end restriction candidates)))
4198 ;; 1. Text before any object. Untabify it.
4203 acc
4207 ;; 2. Object...
4210 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4211 ;; a recursive type.
4216 cont-beg
4223 ;; 3. Text after last object. Untabify it.
4227 acc
4231 ;; Result.
4232 acc)))
4235 "Return an alist of candidates for the next object.
4237 LIMIT bounds the search, and RESTRICTION narrows candidates to
4238 some object types.
4240 Return value is an alist whose CAR is position and CDR the object
4241 type, as a symbol.
4243 OBJECTS is the previous candidates alist."
4244 ;; Filter out any object found but not belonging to RESTRICTION.
4250 type)
4251 restriction)))
4252 objects))
4254 ;; If no previous result, search every object type in RESTRICTION.
4255 ;; Otherwise, keep potential candidates (old objects located after
4256 ;; point) and ask to search again those which had matched before.
4261 objects))
4262 ;; Call the appropriate successor function for each type to search
4263 ;; and accumulate matches.
4270 type))))
4273 types-to-search)
4274 ;; Return alist.
4275 next-candidates))
4278 \f
4279 ;;; Towards A Bijective Process
4280 ;;
4281 ;; The parse tree obtained with `org-element-parse-buffer' is really
4282 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4283 ;; interpreted and expanded into a string with canonical Org syntax.
4284 ;; Hence `org-element-interpret-data'.
4285 ;;
4286 ;; The function relies internally on
4287 ;; `org-element--interpret-affiliated-keywords'.
4289 ;;;###autoload
4291 "Interpret DATA as Org syntax.
4293 DATA is a parse tree, an element, an object or a secondary string
4294 to interpret.
4296 Optional argument PARENT is used for recursive calls. It contains
4297 the element or object containing data, or nil.
4299 Return Org syntax as a string."
4303 ;; Secondary string.
4308 ;; Full Org document.
4313 ;; Plain text.
4315 ;; Element/Object without contents.
4318 data nil))
4319 ;; Element/Object with contents.
4329 ;; Elements directly containing objects must
4330 ;; have their indentation normalized first.
4332 data
4333 ;; When normalizing first paragraph of an
4334 ;; item or a footnote-definition, ignore
4335 ;; first line's indentation.
4342 data
4344 contents)))))))
4346 ;; Build white spaces. If no `:post-blank' property is
4347 ;; specified, assume its value is 0.
4357 "Return ELEMENT's affiliated keywords as Org syntax.
4358 If there is no affiliated keyword, return the empty string."
4368 ": "
4371 value)
4379 ;; All attribute keywords can have multiple lines.
4385 ;; List all ELEMENT's properties matching an attribute line or an
4386 ;; affiliated keyword, but ignore translated keywords since they
4387 ;; cannot belong to the property list.
4394 org-element-keyword-translation-alist)))))
4395 collect prop)
4398 ;; Because interpretation of the parse tree must return the same
4399 ;; number of blank lines between elements and the same number of white
4400 ;; space after objects, some special care must be given to white
4401 ;; spaces.
4402 ;;
4403 ;; The first function, `org-element-normalize-string', ensures any
4404 ;; string different from the empty string will end with a single
4405 ;; newline character.
4406 ;;
4407 ;; The second function, `org-element-normalize-contents', removes
4408 ;; global indentation from the contents of the current element.
4411 "Ensure string S ends with a single newline character.
4413 If S isn't a string return it unchanged. If S is the empty
4414 string, return it. Otherwise, return a new string with a single
4415 newline character at its end."
4423 "Normalize plain text in ELEMENT's contents.
4425 ELEMENT must only contain plain text and objects.
4427 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4428 indentation to compute maximal common indentation.
4430 Return the normalized element that is element with global
4431 indentation removed from its contents. The function assumes that
4432 indentation is not done with TAB characters."
4434 collect-inds ; for byte-compiler
4437 ;; Return list of indentations within BLOB. This is done by
4438 ;; walking recursively BLOB and updating IND-LIST along the
4439 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4440 ;; been seen yet. It is required as this string is the only
4441 ;; one whose indentation doesn't happen after a newline
4442 ;; character.
4450 ;; An indentation of zero means no string will be
4451 ;; modified. Quit the process.
4457 ;; Avoid matching blank or empty lines.
4465 ;; Collect indentation list in ELEMENT. Possibly remove first
4466 ;; value if IGNORE-FIRST is non-nil.
4469 ;; Build ELEMENT back, replacing each string with the same
4470 ;; string minus common indentation.
4475 ;; Return BLOB with all its strings indentation
4476 ;; shortened from MCI white spaces. FIRST-FLAG is
4477 ;; non-nil when the first string hasn't been seen
4478 ;; yet.
4492 org-element-recursive-objects)
4496 blob))))
4500 \f
4501 ;;; The Toolbox
4502 ;;
4503 ;; The first move is to implement a way to obtain the smallest element
4504 ;; containing point. This is the job of `org-element-at-point'. It
4505 ;; basically jumps back to the beginning of section containing point
4506 ;; and moves, element after element, with
4507 ;; `org-element--current-element' until the container is found. Note:
4508 ;; When using `org-element-at-point', secondary values are never
4509 ;; parsed since the function focuses on elements, not on objects.
4510 ;;
4511 ;; At a deeper level, `org-element-context' lists all elements and
4512 ;; objects containing point.
4513 ;;
4514 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4515 ;; internally by navigation and manipulation tools.
4517 ;;;###autoload
4519 "Determine closest element around point.
4521 Return value is a list like (TYPE PROPS) where TYPE is the type
4522 of the element and PROPS a plist of properties associated to the
4523 element.
4525 Possible types are defined in `org-element-all-elements'.
4526 Properties depend on element or object type, but always
4527 include :begin, :end, :parent and :post-blank properties.
4529 As a special case, if point is at the very beginning of a list or
4530 sub-list, returned element will be that list instead of the first
4531 item. In the same way, if point is at the beginning of the first
4532 row of a table, returned element will be the table instead of the
4533 first row.
4535 If optional argument KEEP-TRAIL is non-nil, the function returns
4536 a list of of elements leading to element at point. The list's
4537 CAR is always the element at point. Following positions contain
4538 element's siblings, then parents, siblings of parents, until the
4539 first element of current section."
4541 ;; If at an headline, parse it. It is the sole element that
4542 ;; doesn't require to know about context. Be sure to disallow
4543 ;; secondary string parsing, though.
4549 ;; Otherwise move at the beginning of the section containing
4550 ;; point.
4554 element type special-flag trail struct prevs parent)
4562 ;; Parse successively each element, skipping those ending
4563 ;; before original position.
4572 ;; 1. Skip any element ending before point. Also skip
4573 ;; element ending at point when we're sure that another
4574 ;; element has started.
4579 ;; 2. An element containing point is always the element at
4580 ;; point.
4583 ;; 3. At any other greater element type, if point is
4584 ;; within contents, move into it.
4589 ;; Create an anchor for tables and plain lists:
4590 ;; when point is at the very beginning of these
4591 ;; elements, ignoring affiliated keywords,
4592 ;; target them instead of their contents.
4594 ;; When point is at contents end, do not move
4595 ;; into elements with an explicit ending, but
4596 ;; return that element instead.
4600 drawer dynamic-block inlinetask item
4601 plain-list property-drawer quote-block
4602 special-block))))
4615 ;;;###autoload
4617 "Return closest element or object around point.
4619 Return value is a list like (TYPE PROPS) where TYPE is the type
4620 of the element or object and PROPS a plist of properties
4621 associated to it.
4623 Possible types are defined in `org-element-all-elements' and
4624 `org-element-all-objects'. Properties depend on element or
4625 object type, but always include :begin, :end, :parent
4626 and :post-blank properties."
4631 end)
4632 ;; Check if point is inside an element containing objects or at
4633 ;; a secondary string. In that case, move to beginning of the
4634 ;; element or secondary string and set END to the other side.
4641 org-element-parsed-keywords))
4642 ;; We're at an affiliated keyword. Change
4643 ;; type to retrieve correct restrictions.
4645 ;; Determine if we're at main or dual value.
4659 (<= origin
4660 ;; `1+' is required so some
4661 ;; successors can match
4662 ;; properly their object.
4683 element
4686 candidates)
4689 end restriction candidates))
4691 candidates)))
4692 ;; If ORIGIN is before next object in element, there's
4693 ;; no point in looking further.
4702 ;; ORIGIN is after OBJECT, so skip it.
4705 ;; ORIGIN is within a non-recursive object or at an
4706 ;; object boundaries: Return that object.
4710 ;; Otherwise, move within current object and restrict
4711 ;; search to the end of its contents.
4716 end cend)))))))
4717 parent))))))
4720 "Non-nil when elements ELEM-A and ELEM-B are nested."
4729 "Swap elements ELEM-A and ELEM-B.
4730 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4731 end of ELEM-A."
4733 ;; There are two special cases when an element doesn't start at bol:
4734 ;; the first paragraph in an item or in a footnote definition.
4736 ;; Only a paragraph without any affiliated keyword can be moved at
4737 ;; ELEM-A position in such a situation. Note that the case of
4738 ;; a footnote definition is impossible: it cannot contain two
4739 ;; paragraphs in a row because it cannot contain a blank line.
4745 ;; In a special situation, ELEM-A will have no indentation. We'll
4746 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4760 ;; Store overlays responsible for visibility status. We
4761 ;; also need to store their boundaries as they will be
4762 ;; removed from buffer.
4769 ;; Get contents.
4777 ;; Restore ex ELEM-A overlays.
4786 ;; Restore ex ELEM-B overlays.
4795 ;; Local variables:
4796 ;; generated-autoload-file: "org-loaddefs.el"
4797 ;; End:
4799 ;;; org-element.el ends here