| blob | 24988e87f2193eb809efbda2b8a4fb1e9a03edd9 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
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 plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1127 ;; Compute indentation.
1132 ;; Indent contents.
1134 bullet
1147 ;;;; Plain List
1150 "Parse a plain list.
1152 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1153 the buffer position at the beginning of the first affiliated
1154 keyword and CDR is a plist of affiliated keywords along with
1155 their value. STRUCTURE is the structure of the plain list being
1156 parsed.
1158 Return a list whose CAR is `plain-list' and CDR is a plist
1159 containing `:type', `:begin', `:end', `:contents-begin' and
1160 `:contents-end', `:structure', `:post-blank' and
1161 `:post-affiliated' keywords.
1163 Assume point is at the beginning of the list."
1178 ;; Return value.
1182 :begin begin
1183 :end end
1184 :contents-begin contents-begin
1185 :contents-end contents-end
1186 :structure struct
1192 "Interpret PLAIN-LIST element as Org syntax.
1193 CONTENTS is the contents of the element."
1201 ;;;; Property Drawer
1204 "Parse a property drawer.
1206 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1207 the buffer position at the beginning of the first affiliated
1208 keyword and CDR is a plist of affiliated keywords along with
1209 their value.
1211 Return a list whose CAR is `property-drawer' and CDR is a plist
1212 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1213 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1215 Assume point is at the beginning of the property drawer."
1220 ;; Incomplete drawer: parse it as a paragraph.
1240 :end end
1241 :hiddenp hidden
1242 :contents-begin contents-begin
1243 :contents-end contents-end
1249 "Interpret PROPERTY-DRAWER element as Org syntax.
1250 CONTENTS is the properties within the drawer."
1254 ;;;; Quote Block
1257 "Parse a quote block.
1259 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1260 the buffer position at the beginning of the first affiliated
1261 keyword and CDR is a plist of affiliated keywords along with
1262 their value.
1264 Return a list whose CAR is `quote-block' and CDR is a plist
1265 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1266 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1268 Assume point is at the beginning of the block."
1272 ;; Incomplete block: parse it as a paragraph.
1278 ;; Empty blocks have no contents.
1293 :end end
1294 :hiddenp hidden
1295 :contents-begin contents-begin
1296 :contents-end contents-end
1302 "Interpret QUOTE-BLOCK element as Org syntax.
1303 CONTENTS is the contents of the element."
1307 ;;;; Section
1310 "Parse a section.
1312 LIMIT bounds the search.
1314 Return a list whose CAR is `section' and CDR is a plist
1315 containing `:begin', `:end', `:contents-begin', `contents-end'
1316 and `:post-blank' keywords."
1318 ;; Beginning of section is the beginning of the first non-blank
1319 ;; line after previous headline.
1328 :end end
1329 :contents-begin begin
1330 :contents-end pos-before-blank
1334 "Interpret SECTION element as Org syntax.
1335 CONTENTS is the contents of the element."
1336 contents)
1339 ;;;; Special Block
1342 "Parse a special block.
1344 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1345 the buffer position at the beginning of the first affiliated
1346 keyword and CDR is a plist of affiliated keywords along with
1347 their value.
1349 Return a list whose CAR is `special-block' and CDR is a plist
1350 containing `:type', `:begin', `:end', `:hiddenp',
1351 `:contents-begin', `:contents-end', `:post-blank' and
1352 `:post-affiliated' keywords.
1354 Assume point is at the beginning of the block."
1361 ;; Incomplete block: parse it as a paragraph.
1367 ;; Empty blocks have no contents.
1382 :begin begin
1383 :end end
1384 :hiddenp hidden
1385 :contents-begin contents-begin
1386 :contents-end contents-end
1392 "Interpret SPECIAL-BLOCK element as Org syntax.
1393 CONTENTS is the contents of the element."
1398 \f
1399 ;;; Elements
1400 ;;
1401 ;; For each element, a parser and an interpreter are also defined.
1402 ;; Both follow the same naming convention used for greater elements.
1403 ;;
1404 ;; Also, as for greater elements, adding a new element type is done
1405 ;; through the following steps: implement a parser and an interpreter,
1406 ;; tweak `org-element--current-element' so that it recognizes the new
1407 ;; type and add that new type to `org-element-all-elements'.
1408 ;;
1409 ;; As a special case, when the newly defined type is a block type,
1410 ;; `org-element-block-name-alist' has to be modified accordingly.
1413 ;;;; Babel Call
1416 "Parse a babel call.
1418 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1419 the buffer position at the beginning of the first affiliated
1420 keyword and CDR is a plist of affiliated keywords along with
1421 their value.
1423 Return a list whose CAR is `babel-call' and CDR is a plist
1424 containing `:begin', `:end', `:info', `:post-blank' and
1425 `:post-affiliated' as keywords."
1439 :end end
1440 :info info
1446 "Interpret BABEL-CALL element as Org syntax.
1447 CONTENTS is nil."
1453 ;; Remove redundant square brackets.
1458 ;;;; Clock
1461 "Parse a clock.
1463 LIMIT bounds the search.
1465 Return a list whose CAR is `clock' and CDR is a plist containing
1466 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1467 as keywords."
1487 :value value
1488 :duration duration
1489 :begin begin
1490 :end end
1494 "Interpret CLOCK element as Org syntax.
1495 CONTENTS is nil."
1503 "%2s:%02s"
1507 ;;;; Comment
1510 "Parse a comment.
1512 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1513 the buffer position at the beginning of the first affiliated
1514 keyword and CDR is a plist of affiliated keywords along with
1515 their value.
1517 Return a list whose CAR is `comment' and CDR is a plist
1518 containing `:begin', `:end', `:value', `:post-blank',
1519 `:post-affiliated' keywords.
1521 Assume point is at comment beginning."
1530 ;; Get comments ending.
1533 ;; Accumulate lines without leading hash and first
1534 ;; whitespace.
1549 :end end
1550 :value value
1556 "Interpret COMMENT element as Org syntax.
1557 CONTENTS is nil."
1561 ;;;; Comment Block
1564 "Parse an export block.
1566 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1567 the buffer position at the beginning of the first affiliated
1568 keyword and CDR is a plist of affiliated keywords along with
1569 their value.
1571 Return a list whose CAR is `comment-block' and CDR is a plist
1572 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1573 and `:post-affiliated' keywords.
1575 Assume point is at comment block beginning."
1579 ;; Incomplete block: parse it as a paragraph.
1594 contents-begin contents-end)))
1598 :end end
1599 :value value
1600 :hiddenp hidden
1606 "Interpret COMMENT-BLOCK element as Org syntax.
1607 CONTENTS is nil."
1612 ;;;; Diary Sexp
1615 "Parse a diary sexp.
1617 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1618 the buffer position at the beginning of the first affiliated
1619 keyword and CDR is a plist of affiliated keywords along with
1620 their value.
1622 Return a list whose CAR is `diary-sexp' and CDR is a plist
1623 containing `:begin', `:end', `:value', `:post-blank' and
1624 `:post-affiliated' keywords."
1637 :begin begin
1638 :end end
1644 "Interpret DIARY-SEXP as Org syntax.
1645 CONTENTS is nil."
1649 ;;;; Example Block
1652 "Parse an example block.
1654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and CDR is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose CAR is `example-block' and CDR is a plist
1660 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1661 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1662 `:switches', `:value', `:post-blank' and `:post-affiliated'
1663 keywords."
1667 ;; Incomplete block: parse it as a paragraph.
1674 ;; Switches analysis
1679 ;; Should labels be retained in (or stripped from) example
1680 ;; blocks?
1685 ;; What should code-references use - labels or
1686 ;; line-numbers?
1693 ;; Standard block parsing.
1700 contents-begin contents-end)))
1710 :end end
1711 :value value
1712 :switches switches
1713 :number-lines number-lines
1714 :preserve-indent preserve-indent
1715 :retain-labels retain-labels
1716 :use-labels use-labels
1717 :label-fmt label-fmt
1718 :hiddenp hidden
1724 "Interpret EXAMPLE-BLOCK element as Org syntax.
1725 CONTENTS is nil."
1734 ;;;; Export Block
1737 "Parse an export block.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `export-block' and CDR is a plist
1745 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1746 `:post-blank' and `:post-affiliated' keywords.
1748 Assume point is at export-block beginning."
1755 ;; Incomplete block: parse it as a paragraph.
1770 contents-end)))
1774 :end end
1775 :type type
1776 :value value
1777 :hiddenp hidden
1783 "Interpret EXPORT-BLOCK element as Org syntax.
1784 CONTENTS is nil."
1791 ;;;; Fixed-width
1794 "Parse a fixed-width section.
1796 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1797 the buffer position at the beginning of the first affiliated
1798 keyword and CDR is a plist of affiliated keywords along with
1799 their value.
1801 Return a list whose CAR is `fixed-width' and CDR is a plist
1802 containing `:begin', `:end', `:value', `:post-blank' and
1803 `:post-affiliated' keywords.
1805 Assume point is at the beginning of the fixed-width area."
1809 value
1814 ;; Accumulate text without starting colons.
1828 :end end
1829 :value value
1835 "Interpret FIXED-WIDTH element as Org syntax.
1836 CONTENTS is nil."
1844 ;;;; Horizontal Rule
1847 "Parse an horizontal rule.
1849 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1850 the buffer position at the beginning of the first affiliated
1851 keyword and CDR is a plist of affiliated keywords along with
1852 their value.
1854 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1855 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1856 keywords."
1867 :end end
1873 "Interpret HORIZONTAL-RULE element as Org syntax.
1874 CONTENTS is nil."
1878 ;;;; Keyword
1881 "Parse a keyword at point.
1883 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1884 the buffer position at the beginning of the first affiliated
1885 keyword and CDR is a plist of affiliated keywords along with
1886 their value.
1888 Return a list whose CAR is `keyword' and CDR is a plist
1889 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1890 `:post-affiliated' keywords."
1905 :value value
1906 :begin begin
1907 :end end
1913 "Interpret KEYWORD element as Org syntax.
1914 CONTENTS is nil."
1920 ;;;; Latex Environment
1923 "Parse a LaTeX environment.
1925 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1926 the buffer position at the beginning of the first affiliated
1927 keyword and CDR is a plist of affiliated keywords along with
1928 their value.
1930 Return a list whose CAR is `latex-environment' and CDR is a plist
1931 containing `:begin', `:end', `:value', `:post-blank' and
1932 `:post-affiliated' keywords.
1934 Assume point is at the beginning of the latex environment."
1941 limit t))
1942 ;; 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."
2955 "Interpret LINE-BREAK object as Org syntax.
2956 CONTENTS is nil."
2960 "Search for the next line-break object.
2962 LIMIT bounds the search.
2964 Return value is a cons cell whose CAR is `line-break' and CDR is
2965 beginning position."
2969 ;; A line break can only happen on a non-empty line.
2974 ;;;; Link
2977 "Parse link at point.
2979 Return a list whose CAR is `link' and CDR a plist with `:type',
2980 `:path', `:raw-link', `:application', `:search-option', `:begin',
2981 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2982 keywords.
2984 Assume point is at the beginning of the link."
2987 end contents-begin contents-end link-end post-blank path type
2988 raw-link link search-option application)
2990 ;; Type 1: Text targeted from a radio target.
2995 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3000 ;; RAW-LINK is the original link. Expand any
3001 ;; abbreviation in it.
3006 ;; Determine TYPE of link and set PATH accordingly.
3008 ;; File type.
3011 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3014 ;; Id type: PATH is the id.
3017 ;; Code-ref type: PATH is the name of the reference.
3020 ;; Custom-id type: PATH is the name of the custom id.
3023 ;; Fuzzy type: Internal link either matches a target, an
3024 ;; headline name or nothing. PATH is the target or
3025 ;; headline's name.
3027 ;; Type 3: Plain link, i.e. http://orgmode.org
3033 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3040 ;; In any case, deduce end point after trailing white space from
3041 ;; LINK-END variable.
3044 ;; Extract search option and opening application out of
3045 ;; "file"-type links.
3047 ;; Application.
3052 ;; Extract search option from PATH.
3056 ;; Make sure TYPE always report "file".
3060 :path path
3062 :application application
3063 :search-option search-option
3064 :begin begin
3065 :end end
3066 :contents-begin contents-begin
3067 :contents-end contents-end
3071 "Interpret LINK object as Org syntax.
3072 CONTENTS is the contents of the object, or nil."
3077 raw-link
3081 "Search for the next link object.
3083 LIMIT bounds the search.
3085 Return value is a cons cell whose CAR is `link' and CDR is
3086 beginning position."
3095 "Search for the next plain link object.
3097 LIMIT bounds the search.
3099 Return value is a cons cell whose CAR is `link' and CDR is
3100 beginning position."
3105 ;;;; Macro
3108 "Parse macro at point.
3110 Return a list whose CAR is `macro' and CDR a plist with `:key',
3111 `:args', `:begin', `:end', `:value' and `:post-blank' as
3112 keywords.
3114 Assume point is at the macro."
3125 ;; Do not use `org-split-string' since empty
3126 ;; strings are meaningful here.
3134 args nil t)
3138 :value value
3139 :args args
3140 :begin begin
3141 :end end
3145 "Interpret MACRO object as Org syntax.
3146 CONTENTS is nil."
3150 "Search for the next macro object.
3152 LIMIT bounds the search.
3154 Return value is cons cell whose CAR is `macro' and CDR is
3155 beginning position."
3159 limit t)
3163 ;;;; Radio-target
3166 "Parse radio target at point.
3168 Return a list whose CAR is `radio-target' and CDR a plist with
3169 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3170 and `:post-blank' as keywords.
3172 Assume point is at the radio target."
3184 :end end
3185 :contents-begin contents-begin
3186 :contents-end contents-end
3187 :post-blank post-blank
3191 "Interpret TARGET object as Org syntax.
3192 CONTENTS is the contents of the object."
3196 "Search for the next radio-target object.
3198 LIMIT bounds the search.
3200 Return value is a cons cell whose CAR is `radio-target' and CDR
3201 is beginning position."
3207 ;;;; Statistics Cookie
3210 "Parse statistics cookie at point.
3212 Return a list whose CAR is `statistics-cookie', and CDR a plist
3213 with `:begin', `:end', `:value' and `:post-blank' keywords.
3215 Assume point is at the beginning of the statistics-cookie."
3226 :end end
3227 :value value
3231 "Interpret STATISTICS-COOKIE object as Org syntax.
3232 CONTENTS is nil."
3236 "Search for the next statistics cookie object.
3238 LIMIT bounds the search.
3240 Return value is a cons cell whose CAR is `statistics-cookie' and
3241 CDR is beginning position."
3247 ;;;; Strike-Through
3250 "Parse strike-through object at point.
3252 Return a list whose CAR is `strike-through' and CDR is a plist
3253 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3254 `:post-blank' keywords.
3256 Assume point is at the first plus sign marker."
3268 :end end
3269 :contents-begin contents-begin
3270 :contents-end contents-end
3274 "Interpret STRIKE-THROUGH object as Org syntax.
3275 CONTENTS is the contents of the object."
3279 ;;;; Subscript
3282 "Parse subscript at point.
3284 Return a list whose CAR is `subscript' and CDR a plist with
3285 `:begin', `:end', `:contents-begin', `:contents-end',
3286 `:use-brackets-p' and `:post-blank' as keywords.
3288 Assume point is at the underscore."
3292 t
3303 :end end
3304 :use-brackets-p bracketsp
3305 :contents-begin contents-begin
3306 :contents-end contents-end
3310 "Interpret SUBSCRIPT object as Org syntax.
3311 CONTENTS is the contents of the object."
3314 contents))
3317 "Search for the next sub/superscript object.
3319 LIMIT bounds the search.
3321 Return value is a cons cell whose CAR is either `subscript' or
3322 `superscript' and CDR is beginning position."
3330 ;;;; Superscript
3333 "Parse superscript at point.
3335 Return a list whose CAR is `superscript' and CDR a plist with
3336 `:begin', `:end', `:contents-begin', `:contents-end',
3337 `:use-brackets-p' and `:post-blank' as keywords.
3339 Assume point is at the caret."
3353 :end end
3354 :use-brackets-p bracketsp
3355 :contents-begin contents-begin
3356 :contents-end contents-end
3360 "Interpret SUPERSCRIPT object as Org syntax.
3361 CONTENTS is the contents of the object."
3364 contents))
3367 ;;;; Table Cell
3370 "Parse table cell at point.
3372 Return a list whose CAR is `table-cell' and CDR is a plist
3373 containing `:begin', `:end', `:contents-begin', `:contents-end'
3374 and `:post-blank' keywords."
3382 :end end
3383 :contents-begin contents-begin
3384 :contents-end contents-end
3388 "Interpret TABLE-CELL element as Org syntax.
3389 CONTENTS is the contents of the cell, or nil."
3393 "Search for the next table-cell object.
3395 LIMIT bounds the search.
3397 Return value is a cons cell whose CAR is `table-cell' and CDR is
3398 beginning position."
3402 ;;;; Target
3405 "Parse target at point.
3407 Return a list whose CAR is `target' and CDR a plist with
3408 `:begin', `:end', `:value' and `:post-blank' as keywords.
3410 Assume point is at the target."
3420 :end end
3421 :value value
3425 "Interpret TARGET object as Org syntax.
3426 CONTENTS is nil."
3430 "Search for the next target object.
3432 LIMIT bounds the search.
3434 Return value is a cons cell whose CAR is `target' and CDR is
3435 beginning position."
3441 ;;;; Timestamp
3444 "Parse time stamp at point.
3446 Return a list whose CAR is `timestamp', and CDR a plist with
3447 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3449 Assume point is at the beginning of the timestamp."
3467 date-start)
3478 raw-value)
3480 :repeater-type
3486 :repeater-unit
3489 year-start month-start day-start hour-start minute-start year-end
3490 month-end day-end hour-end minute-end)
3491 ;; Parse date-start.
3499 ;; Compute date-end. It can be provided directly in time-stamp,
3500 ;; or extracted from time range. Otherwise, it defaults to the
3501 ;; same values as date-start.
3511 :raw-value raw-value
3512 :year-start year-start
3513 :month-start month-start
3514 :day-start day-start
3515 :hour-start hour-start
3516 :minute-start minute-start
3517 :year-end year-end
3518 :month-end month-end
3519 :day-end day-end
3520 :hour-end hour-end
3521 :minute-end minute-end
3522 :begin begin
3523 :end end
3525 repeater-props)))))
3528 "Interpret TIMESTAMP object as Org syntax.
3529 CONTENTS is nil."
3530 ;; Use `:raw-value' if specified.
3532 ;; Otherwise, build timestamp string.
3542 ;; Build an Org timestamp string from TIME. ACTIVEP is
3543 ;; non-nil when time stamp is active. If WITH-TIME-P is
3544 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3545 ;; specify a time range in the timestamp. REPEAT-STRING
3546 ;; is the repeater string, if any.
3550 org-time-stamp-formats)
3551 time)))
3557 nil nil ts)))
3561 " "
3562 repeat-string
3564 ;; Return value.
3565 ts)))
3577 build-ts-string
3596 0
3604 "--"
3616 "Search for the next timestamp object.
3618 LIMIT bounds the search.
3620 Return value is a cons cell whose CAR is `timestamp' and CDR is
3621 beginning position."
3629 limit t)
3633 ;;;; Underline
3636 "Parse underline object at point.
3638 Return a list whose CAR is `underline' and CDR is a plist with
3639 `:begin', `:end', `:contents-begin' and `:contents-end' and
3640 `:post-blank' keywords.
3642 Assume point is at the first underscore marker."
3654 :end end
3655 :contents-begin contents-begin
3656 :contents-end contents-end
3660 "Interpret UNDERLINE object as Org syntax.
3661 CONTENTS is the contents of the object."
3665 ;;;; Verbatim
3668 "Parse verbatim object at point.
3670 Return a list whose CAR is `verbatim' and CDR is a plist with
3671 `:value', `:begin', `:end' and `:post-blank' keywords.
3673 Assume point is at the first equal sign marker."
3684 :begin begin
3685 :end end
3689 "Interpret VERBATIM object as Org syntax.
3690 CONTENTS is nil."
3694 \f
3695 ;;; Parsing Element Starting At Point
3696 ;;
3697 ;; `org-element--current-element' is the core function of this section.
3698 ;; It returns the Lisp representation of the element starting at
3699 ;; point.
3700 ;;
3701 ;; `org-element--current-element' makes use of special modes. They
3702 ;; are activated for fixed element chaining (i.e. `plain-list' >
3703 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3704 ;; `section'). Special modes are: `first-section', `item',
3705 ;; `node-property', `quote-section', `section' and `table-row'.
3709 "Parse the element starting at point.
3711 LIMIT bounds the search.
3713 Return value is a list like (TYPE PROPS) where TYPE is the type
3714 of the element and PROPS a plist of properties associated to the
3715 element.
3717 Possible types are defined in `org-element-all-elements'.
3719 Optional argument GRANULARITY determines the depth of the
3720 recursion. Allowed values are `headline', `greater-element',
3721 `element', `object' or nil. When it is broader than `object' (or
3722 nil), secondary values will not be parsed, since they only
3723 contain objects.
3725 Optional argument SPECIAL, when non-nil, can be either
3726 `first-section', `item', `node-property', `quote-section',
3727 `section', and `table-row'.
3729 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3730 be computed.
3732 This function assumes point is always at the beginning of the
3733 element it has to parse."
3736 ;; Determine if parsing depth allows for secondary strings
3737 ;; parsing. It only applies to elements referenced in
3738 ;; `org-element-secondary-value-alist'.
3741 ;; Item.
3744 ;; Table Row.
3746 ;; Node Property.
3748 ;; Headline.
3751 ;; Sections (must be checked after headline).
3757 limit)))
3758 ;; When not at bol, point is at the beginning of an item or
3759 ;; a footnote definition: next item is always a paragraph.
3761 ;; Planning and Clock.
3766 ;; Inlinetask.
3769 ;; From there, elements can have affiliated keywords.
3772 ;; Jumping over affiliated keywords put point off-limits.
3773 ;; Parse them as regular keywords.
3777 ;; LaTeX Environment.
3781 ;; Drawer and Property Drawer.
3786 ;; Fixed Width
3789 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3790 ;; Keywords.
3799 org-element-block-name-alist)))
3814 ;; Footnote Definition.
3817 ;; Horizontal Rule.
3820 ;; Diary Sexp.
3823 ;; Table.
3825 ;; List.
3829 ;; Default element: Paragraph.
3833 ;; Most elements can have affiliated keywords. When looking for an
3834 ;; element beginning, we want to move before them, as they belong to
3835 ;; that element, and, in the meantime, collect information they give
3836 ;; into appropriate properties. Hence the following function.
3839 "Collect affiliated keywords from point down to LIMIT.
3841 Return a list whose CAR is the position at the first of them and
3842 CDR a plist of keywords and values and move point to the
3843 beginning of the first line after them.
3845 As a special case, if element doesn't start at the beginning of
3846 the line (i.e. a paragraph starting an item), CAR is current
3847 position of point and CDR is nil."
3851 ;; RESTRICT is the list of objects allowed in parsed
3852 ;; keywords value.
3854 output)
3857 ;; Apply translation to RAW-KWD. From there, KWD is
3858 ;; the official keyword.
3860 org-element-keyword-translation-alist))
3861 raw-kwd))
3862 ;; Find main value for any keyword.
3868 ;; PARSEDP is non-nil when keyword should have its
3869 ;; value parsed.
3871 ;; If KWD is a dual keyword, find its secondary
3872 ;; value. Maybe parse it.
3879 ;; Attribute a property name to KWD.
3881 ;; Now set final shape for VALUE.
3887 ;; Attributes can always appear on multiple lines.
3890 ;; Eventually store the new value in OUTPUT.
3892 ;; Move to next keyword.
3894 ;; If affiliated keywords are orphaned: move back to first one.
3895 ;; They will be parsed as a paragraph.
3897 ;; Return value.
3901 \f
3902 ;;; The Org Parser
3903 ;;
3904 ;; The two major functions here are `org-element-parse-buffer', which
3905 ;; parses Org syntax inside the current buffer, taking into account
3906 ;; region, narrowing, or even visibility if specified, and
3907 ;; `org-element-parse-secondary-string', which parses objects within
3908 ;; a given string.
3909 ;;
3910 ;; The (almost) almighty `org-element-map' allows to apply a function
3911 ;; on elements or objects matching some type, and accumulate the
3912 ;; resulting values. In an export situation, it also skips unneeded
3913 ;; parts of the parse tree.
3916 "Recursively parse the buffer and return structure.
3917 If narrowing is in effect, only parse the visible part of the
3918 buffer.
3920 Optional argument GRANULARITY determines the depth of the
3921 recursion. It can be set to the following symbols:
3923 `headline' Only parse headlines.
3924 `greater-element' Don't recurse into greater elements excepted
3925 headlines and sections. Thus, elements
3926 parsed are the top-level ones.
3927 `element' Parse everything but objects and plain text.
3928 `object' Parse the complete buffer (default).
3930 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3931 elements.
3933 An element or an objects is represented as a list with the
3934 pattern (TYPE PROPERTIES CONTENTS), where :
3936 TYPE is a symbol describing the element or object. See
3937 `org-element-all-elements' and `org-element-all-objects' for an
3938 exhaustive list of such symbols. One can retrieve it with
3939 `org-element-type' function.
3941 PROPERTIES is the list of attributes attached to the element or
3942 object, as a plist. Although most of them are specific to the
3943 element or object type, all types share `:begin', `:end',
3944 `:post-blank' and `:parent' properties, which respectively
3945 refer to buffer position where the element or object starts,
3946 ends, the number of white spaces or blank lines after it, and
3947 the element or object containing it. Properties values can be
3948 obtained by using `org-element-property' function.
3950 CONTENTS is a list of elements, objects or raw strings
3951 contained in the current element or object, when applicable.
3952 One can access them with `org-element-contents' function.
3954 The Org buffer has `org-data' as type and nil as properties.
3955 `org-element-map' function can be used to find specific elements
3956 or objects within the parse tree.
3958 This function assumes that current major mode is `org-mode'."
3964 ;; Start in `first-section' mode so text before the first
3965 ;; headline belongs to a section.
3969 "Recursively parse objects in STRING and return structure.
3971 RESTRICTION is a symbol limiting the object types that will be
3972 looked after.
3974 Optional argument PARENT, when non-nil, is the element or object
3975 containing the secondary string. It is used to set correctly
3976 `:parent' property within the string."
3977 ;; Copy buffer-local variables listed in
3978 ;; `org-element-object-variables' into temporary buffer. This is
3979 ;; required since object parsing is dependent on these variables.
3983 org-element-object-variables))))
3991 secondary))
3992 secondary))))
3996 "Map a function on selected elements or objects.
3998 DATA is a parse tree, an element, an object, a string, or a list
3999 of such constructs. TYPES is a symbol or list of symbols of
4000 elements or objects types (see `org-element-all-elements' and
4001 `org-element-all-objects' for a complete list of types). FUN is
4002 the function called on the matching element or object. It has to
4003 accept one argument: the element or object itself.
4005 When optional argument INFO is non-nil, it should be a plist
4006 holding export options. In that case, parts of the parse tree
4007 not exportable according to that property list will be skipped.
4009 When optional argument FIRST-MATCH is non-nil, stop at the first
4010 match for which FUN doesn't return nil, and return that value.
4012 Optional argument NO-RECURSION is a symbol or a list of symbols
4013 representing elements or objects types. `org-element-map' won't
4014 enter any recursive element or object whose type belongs to that
4015 list. Though, FUN can still be applied on them.
4017 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4018 apply to matching objects within parsed affiliated keywords (see
4019 `org-element-parsed-keywords').
4021 Nil values returned from FUN do not appear in the results.
4024 Examples:
4025 ---------
4027 Assuming TREE is a variable containing an Org buffer parse tree,
4028 the following example will return a flat list of all `src-block'
4029 and `example-block' elements in it:
4031 \(org-element-map tree '(example-block src-block) 'identity)
4033 The following snippet will find the first headline with a level
4036 \(org-element-map tree 'headline
4037 \(lambda (hl)
4038 \(and (= (org-element-property :level hl) 1)
4040 \(org-element-property :begin hl)))
4041 nil t)
4043 The next example will return a flat list of all `plain-list' type
4044 elements in TREE that are not a sub-list themselves:
4046 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4048 Eventually, this example will return a flat list of all `bold'
4049 type objects containing a `latex-snippet' type object, even
4050 looking into captions:
4052 \(org-element-map tree 'bold
4053 \(lambda (b)
4054 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4055 nil nil nil t)"
4056 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4059 ;; Recursion depth is determined by --CATEGORY.
4066 ;; If one object is found, the function
4067 ;; has to recurse into every object.
4070 ;; If one regular element is found, the
4071 ;; function has to recurse, at least,
4072 ;; into every element it encounters.
4075 types)
4076 category)))
4077 ;; Compute properties for affiliated keywords if necessary.
4082 org-element-affiliated-keywords)))
4083 --acc
4084 --walk-tree
4088 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4089 ;; holding contextual information.
4093 ;; Ignored element in an export context.
4095 ;; List of elements or objects.
4097 ;; Unconditionally enter parse trees.
4101 ;; Check if TYPE is matching among TYPES. If so,
4102 ;; apply FUN to --DATA and accumulate return value
4103 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4109 ;; If --DATA has a secondary string that can contain
4110 ;; objects with their type among TYPES, look into it.
4117 ;; If --DATA has any affiliated keywords and
4118 ;; WITH-AFFILIATED is non-nil, look for objects in
4119 ;; them.
4127 ;; Pay attention to the type of value.
4128 ;; Preserve order for multiple keywords.
4144 --affiliated-alist))
4145 ;; Determine if a recursion into --DATA is possible.
4147 ;; --TYPE is explicitly removed from recursion.
4149 ;; --DATA has no contents.
4151 ;; Looking for greater elements but --DATA is simply
4152 ;; an element or an object.
4155 ;; Looking for elements but --DATA is an object.
4158 ;; In any other case, map contents.
4162 ;; Return value in a proper order.
4166 ;; The following functions are internal parts of the parser.
4167 ;;
4168 ;; The first one, `org-element--parse-elements' acts at the element's
4169 ;; level.
4170 ;;
4171 ;; The second one, `org-element--parse-objects' applies on all objects
4172 ;; of a paragraph or a secondary string. It uses
4173 ;; `org-element--get-next-object-candidates' to optimize the search of
4174 ;; the next object in the buffer.
4175 ;;
4176 ;; More precisely, that function looks for every allowed object type
4177 ;; first. Then, it discards failed searches, keeps further matches,
4178 ;; and searches again types matched behind point, for subsequent
4179 ;; calls. Thus, searching for a given type fails only once, and every
4180 ;; object is searched only once at top level (but sometimes more for
4181 ;; nested types).
4185 "Parse elements between BEG and END positions.
4187 SPECIAL prioritize some elements over the others. It can be set
4188 to `first-section', `quote-section', `section' `item' or
4189 `table-row'.
4191 When value is `item', STRUCTURE will be used as the current list
4192 structure.
4194 GRANULARITY determines the depth of the recursion. See
4195 `org-element-parse-buffer' for more information.
4197 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4198 elements.
4200 Elements are accumulated into ACC."
4203 ;; Visible only: skip invisible parts at the beginning of the
4204 ;; element.
4207 ;; When parsing only headlines, skip any text before first one.
4210 ;; Main loop start.
4212 ;; Find current element's type and parse it accordingly to
4213 ;; its category.
4215 end granularity special structure))
4219 ;; Visible only: skip invisible parts between siblings.
4222 ;; Fill ELEMENT contents by side-effect.
4224 ;; If element has no contents, don't modify it.
4226 ;; Greater element: parse it between `contents-begin' and
4227 ;; `contents-end'. Make sure GRANULARITY allows the
4228 ;; recursion, or ELEMENT is a headline, in which case going
4229 ;; inside is mandatory, in order to get sub-level headings.
4237 ;; Possibly switch to a special mode.
4247 granularity visible-only element))
4248 ;; ELEMENT has contents. Parse objects inside, if
4249 ;; GRANULARITY allows it.
4255 ;; Return result.
4256 acc))
4259 "Parse objects between BEG and END and return recursive structure.
4261 Objects are accumulated in ACC.
4263 RESTRICTION is a list of object successors which are allowed in
4264 the current object."
4270 end restriction candidates)))
4277 ;; 1. Text before any object. Untabify it.
4282 acc
4286 ;; 2. Object...
4289 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4290 ;; a recursive type.
4295 cont-beg
4302 ;; 3. Text after last object. Untabify it.
4306 acc
4310 ;; Result.
4311 acc)))
4314 "Return an alist of candidates for the next object.
4316 LIMIT bounds the search, and RESTRICTION narrows candidates to
4317 some object successors.
4319 OBJECTS is the previous candidates alist. If it is set to
4320 `initial', no search has been done before, and all symbols in
4321 RESTRICTION should be looked after.
4323 Return value is an alist whose CAR is the object type and CDR its
4324 beginning position."
4326 nil
4328 ;; When searching for the first time, look for every successor
4329 ;; allowed in RESTRICTION.
4333 restriction)
4334 ;; Focus on objects returned during last search. Keep those
4335 ;; still after point. Search again objects before it.
4341 type)))
4344 limit)))))
4345 objects))))
4348 \f
4349 ;;; Towards A Bijective Process
4350 ;;
4351 ;; The parse tree obtained with `org-element-parse-buffer' is really
4352 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4353 ;; interpreted and expanded into a string with canonical Org syntax.
4354 ;; Hence `org-element-interpret-data'.
4355 ;;
4356 ;; The function relies internally on
4357 ;; `org-element--interpret-affiliated-keywords'.
4359 ;;;###autoload
4361 "Interpret DATA as Org syntax.
4363 DATA is a parse tree, an element, an object or a secondary string
4364 to interpret.
4366 Optional argument PARENT is used for recursive calls. It contains
4367 the element or object containing data, or nil.
4369 Return Org syntax as a string."
4373 ;; Secondary string.
4378 ;; Full Org document.
4383 ;; Plain text: remove `:parent' text property from output.
4385 ;; Element/Object without contents.
4388 data nil))
4389 ;; Element/Object with contents.
4399 ;; Elements directly containing objects must
4400 ;; have their indentation normalized first.
4402 data
4403 ;; When normalizing first paragraph of an
4404 ;; item or a footnote-definition, ignore
4405 ;; first line's indentation.
4412 data
4414 contents)))))))
4416 ;; Build white spaces. If no `:post-blank' property is
4417 ;; specified, assume its value is 0.
4427 "Return ELEMENT's affiliated keywords as Org syntax.
4428 If there is no affiliated keyword, return the empty string."
4438 ": "
4441 value)
4449 ;; All attribute keywords can have multiple lines.
4455 ;; List all ELEMENT's properties matching an attribute line or an
4456 ;; affiliated keyword, but ignore translated keywords since they
4457 ;; cannot belong to the property list.
4464 org-element-keyword-translation-alist)))))
4465 collect prop)
4468 ;; Because interpretation of the parse tree must return the same
4469 ;; number of blank lines between elements and the same number of white
4470 ;; space after objects, some special care must be given to white
4471 ;; spaces.
4472 ;;
4473 ;; The first function, `org-element-normalize-string', ensures any
4474 ;; string different from the empty string will end with a single
4475 ;; newline character.
4476 ;;
4477 ;; The second function, `org-element-normalize-contents', removes
4478 ;; global indentation from the contents of the current element.
4481 "Ensure string S ends with a single newline character.
4483 If S isn't a string return it unchanged. If S is the empty
4484 string, return it. Otherwise, return a new string with a single
4485 newline character at its end."
4493 "Normalize plain text in ELEMENT's contents.
4495 ELEMENT must only contain plain text and objects.
4497 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4498 indentation to compute maximal common indentation.
4500 Return the normalized element that is element with global
4501 indentation removed from its contents. The function assumes that
4502 indentation is not done with TAB characters."
4504 collect-inds ; for byte-compiler
4507 ;; Return list of indentations within BLOB. This is done by
4508 ;; walking recursively BLOB and updating IND-LIST along the
4509 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4510 ;; been seen yet. It is required as this string is the only
4511 ;; one whose indentation doesn't happen after a newline
4512 ;; character.
4520 ;; An indentation of zero means no string will be
4521 ;; modified. Quit the process.
4527 ;; Avoid matching blank or empty lines.
4535 ;; Collect indentation list in ELEMENT. Possibly remove first
4536 ;; value if IGNORE-FIRST is non-nil.
4539 ;; Build ELEMENT back, replacing each string with the same
4540 ;; string minus common indentation.
4545 ;; Return BLOB with all its strings indentation
4546 ;; shortened from MCI white spaces. FIRST-FLAG is
4547 ;; non-nil when the first string hasn't been seen
4548 ;; yet.
4562 org-element-recursive-objects)
4566 blob))))
4570 \f
4571 ;;; The Toolbox
4572 ;;
4573 ;; The first move is to implement a way to obtain the smallest element
4574 ;; containing point. This is the job of `org-element-at-point'. It
4575 ;; basically jumps back to the beginning of section containing point
4576 ;; and moves, element after element, with
4577 ;; `org-element--current-element' until the container is found. Note:
4578 ;; When using `org-element-at-point', secondary values are never
4579 ;; parsed since the function focuses on elements, not on objects.
4580 ;;
4581 ;; At a deeper level, `org-element-context' lists all elements and
4582 ;; objects containing point.
4583 ;;
4584 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4585 ;; internally by navigation and manipulation tools.
4587 ;;;###autoload
4589 "Determine closest element around point.
4591 Return value is a list like (TYPE PROPS) where TYPE is the type
4592 of the element and PROPS a plist of properties associated to the
4593 element.
4595 Possible types are defined in `org-element-all-elements'.
4596 Properties depend on element or object type, but always include
4597 `:begin', `:end', `:parent' and `:post-blank' properties.
4599 As a special case, if point is at the very beginning of a list or
4600 sub-list, returned element will be that list instead of the first
4601 item. In the same way, if point is at the beginning of the first
4602 row of a table, returned element will be the table instead of the
4603 first row.
4605 If optional argument KEEP-TRAIL is non-nil, the function returns
4606 a list of elements leading to element at point. The list's CAR
4607 is always the element at point. The following positions contain
4608 element's siblings, then parents, siblings of parents, until the
4609 first element of current section."
4611 ;; If at a headline, parse it. It is the sole element that
4612 ;; doesn't require to know about context. Be sure to disallow
4613 ;; secondary string parsing, though.
4619 ;; Otherwise move at the beginning of the section containing
4620 ;; point.
4625 element type special-flag trail struct prevs parent)
4628 ;; In empty lines at buffer's beginning, return nil.
4637 ;; In blank lines just after the headline, point still
4638 ;; belongs to the headline.
4646 ;; Parse successively each element, skipping those ending
4647 ;; before original position.
4655 ;; 1. Skip any element ending before point. Also skip
4656 ;; element ending at point when we're sure that another
4657 ;; element has started.
4662 ;; 2. An element containing point is always the element at
4663 ;; point.
4666 ;; 3. At any other greater element type, if point is
4667 ;; within contents, move into it.
4672 ;; Create an anchor for tables and plain lists:
4673 ;; when point is at the very beginning of these
4674 ;; elements, ignoring affiliated keywords,
4675 ;; target them instead of their contents.
4677 ;; When point is at contents end, do not move
4678 ;; into elements with an explicit ending, but
4679 ;; return that element instead.
4683 drawer dynamic-block inlinetask item
4684 plain-list property-drawer quote-block
4685 special-block))))
4700 ;;;###autoload
4702 "Return closest element or object around point.
4704 Return value is a list like (TYPE PROPS) where TYPE is the type
4705 of the element or object and PROPS a plist of properties
4706 associated to it.
4708 Possible types are defined in `org-element-all-elements' and
4709 `org-element-all-objects'. Properties depend on element or
4710 object type, but always include `:begin', `:end', `:parent' and
4711 `:post-blank'.
4713 Optional argument ELEMENT, when non-nil, is the closest element
4714 containing point, as returned by `org-element-at-point'.
4715 Providing it allows for quicker computation."
4720 end)
4721 ;; Check if point is inside an element containing objects or at
4722 ;; a secondary string. In that case, move to beginning of the
4723 ;; element or secondary string and set END to the other side.
4730 org-element-parsed-keywords))
4731 ;; We're at an affiliated keyword. Change
4732 ;; type to retrieve correct restrictions.
4734 ;; Determine if we're at main or dual value.
4748 (<= origin
4749 ;; `1+' is required so some
4750 ;; successors can match
4751 ;; properly their object.
4773 element
4779 end restriction candidates))
4781 candidates)))
4782 ;; If ORIGIN is before next object in element, there's
4783 ;; no point in looking further.
4793 ;; ORIGIN is after OBJECT, so skip it.
4799 ;; ORIGIN is within a non-recursive object or at
4800 ;; an object boundaries: Return that object.
4804 ;; Otherwise, move within current object and
4805 ;; restrict search to the end of its contents.
4810 candidates 'initial
4811 end cend)))))))
4812 parent))))))
4815 "Non-nil when elements ELEM-A and ELEM-B are nested."
4824 "Swap elements ELEM-A and ELEM-B.
4825 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4826 end of ELEM-A."
4828 ;; There are two special cases when an element doesn't start at bol:
4829 ;; the first paragraph in an item or in a footnote definition.
4831 ;; Only a paragraph without any affiliated keyword can be moved at
4832 ;; ELEM-A position in such a situation. Note that the case of
4833 ;; a footnote definition is impossible: it cannot contain two
4834 ;; paragraphs in a row because it cannot contain a blank line.
4840 ;; In a special situation, ELEM-A will have no indentation. We'll
4841 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4855 ;; Store overlays responsible for visibility status. We
4856 ;; also need to store their boundaries as they will be
4857 ;; removed from buffer.
4864 ;; Get contents.
4872 ;; Restore ex ELEM-A overlays.
4881 ;; Restore ex ELEM-B overlays.
4890 ;; Local variables:
4891 ;; generated-autoload-file: "org-loaddefs.el"
4892 ;; End:
4894 ;;; org-element.el ends here