| blob | 1fc26f7ca572e11ab320aa02ab51dfe9e23f77c8 |
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', `:contents-begin', `:contents-end',
497 `: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.
522 :end end
523 :contents-begin contents-begin
524 :contents-end contents-end
530 "Interpret CENTER-BLOCK element as Org syntax.
531 CONTENTS is the contents of the element."
535 ;;;; Drawer
538 "Parse a drawer.
540 LIMIT bounds the search. AFFILIATED is a list of which CAR is
541 the buffer position at the beginning of the first affiliated
542 keyword and CDR is a plist of affiliated keywords along with
543 their value.
545 Return a list whose CAR is `drawer' and CDR is a plist containing
546 `:drawer-name', `:begin', `:end', `:contents-begin',
547 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
549 Assume point is at beginning of drawer."
552 ;; Incomplete drawer: parse it as a paragraph.
560 ;; Empty drawers have no contents.
574 :end end
575 :drawer-name name
576 :contents-begin contents-begin
577 :contents-end contents-end
583 "Interpret DRAWER element as Org syntax.
584 CONTENTS is the contents of the element."
587 contents))
590 ;;;; Dynamic Block
593 "Parse a dynamic block.
595 LIMIT bounds the search. AFFILIATED is a list of which CAR is
596 the buffer position at the beginning of the first affiliated
597 keyword and CDR is a plist of affiliated keywords along with
598 their value.
600 Return a list whose CAR is `dynamic-block' and CDR is a plist
601 containing `:block-name', `:begin', `:end', `:contents-begin',
602 `:contents-end', `:arguments', `:post-blank' and
603 `:post-affiliated' keywords.
605 Assume point is at beginning of dynamic block."
609 ;; Incomplete block: parse it as a paragraph.
618 ;; Empty blocks have no contents.
632 :end end
633 :block-name name
634 :arguments arguments
635 :contents-begin contents-begin
636 :contents-end contents-end
642 "Interpret DYNAMIC-BLOCK element as Org syntax.
643 CONTENTS is the contents of the element."
648 contents))
651 ;;;; Footnote Definition
654 "Parse a footnote definition.
656 LIMIT bounds the search. AFFILIATED is a list of which CAR is
657 the buffer position at the beginning of the first affiliated
658 keyword and CDR is a plist of affiliated keywords along with
659 their value.
661 Return a list whose CAR is `footnote-definition' and CDR is
662 a plist containing `:label', `:begin' `:end', `:contents-begin',
663 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
665 Assume point is at the beginning of the footnote definition."
694 :begin begin
695 :end end
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
704 CONTENTS is the contents of the footnote-definition."
706 " "
707 contents))
710 ;;;; Headline
713 "Parse a headline.
715 Return a list whose CAR is `headline' and CDR is a plist
716 containing `:raw-value', `:title', `:alt-title', `:begin',
717 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
718 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
719 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
720 `:commentedp' and `:footnote-section-p' keywords.
722 The plist also contains any property set in the property drawer,
723 with its name in upper cases and colons added at the
724 beginning (i.e. `:CUSTOM_ID').
726 When RAW-SECONDARY-P is non-nil, headline's title will not be
727 parsed as a secondary string, but as a plain string instead.
729 Assume point is at beginning of the headline."
742 raw-value)))
746 raw-value)))
750 ;; Upcase property names. It avoids confusion between
751 ;; properties obtained through property drawer and default
752 ;; properties from the parser (e.g. `:end' and :END:)
762 plist))
764 ;; Read time properties on the line below the headline.
770 org-keyword-time-not-clock-regexp end t)
780 plist))))
792 ;; Clean RAW-VALUE from any quote or comment string.
800 ""
801 raw-value))))
802 ;; Clean TAGS from archive tag, if any.
808 :begin begin
809 :end end
810 :pre-blank
813 :contents-begin contents-begin
814 :contents-end contents-end
815 :level level
817 :tags tags
818 :todo-keyword todo
819 :todo-type todo-type
825 end)
826 :footnote-section-p footnote-section-p
827 :archivedp archivedp
828 :commentedp commentedp
830 time-props
831 standard-props))))
835 headline :alt-title
840 headline :title
846 "Interpret HEADLINE element as Org syntax.
847 CONTENTS is the contents of the element."
874 ;; Align tags.
882 ? )
883 tags))
887 tags))))
889 contents)))
892 ;;;; Inlinetask
895 "Parse an inline task.
897 Return a list whose CAR is `inlinetask' and CDR is a plist
898 containing `:title', `:begin', `:end', `:contents-begin' and
899 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
900 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
901 `:closed' and `:post-blank' keywords.
903 The plist also contains any property set in the property drawer,
904 with its name in upper cases and colons added at the
905 beginning (i.e. `:CUSTOM_ID').
907 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
908 title will not be parsed as a secondary string, but as a plain
909 string instead.
911 Assume point is at beginning of the inline task."
921 ;; Upcase property names. It avoids confusion between
922 ;; properties obtained through property drawer and default
923 ;; properties from the parser (e.g. `:end' and :END:)
933 plist))
935 ;; Read time properties on the line below the inlinetask
936 ;; opening string.
942 org-keyword-time-not-clock-regexp end t)
952 plist))))
971 :begin begin
972 :end end
973 :contents-begin contents-begin
974 :contents-end contents-end
977 :tags tags
978 :todo-keyword todo
979 :todo-type todo-type
981 time-props
982 standard-props))))
984 inlinetask :title
987 raw-value
989 inlinetask))))))
992 "Interpret INLINETASK element as Org syntax.
993 CONTENTS is the contents of inlinetask."
1008 ;; Align tags.
1016 ? )
1017 tags))
1021 tags))))
1022 ;; Prefer degenerate inlinetasks when there are no
1023 ;; contents.
1026 contents
1030 ;;;; Item
1033 "Parse an item.
1035 STRUCT is the structure of the plain list.
1037 Return a list whose CAR is `item' and CDR is a plist containing
1038 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1039 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1040 keywords.
1042 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1043 any, will not be parsed as a secondary string, but as a plain
1044 string instead.
1046 Assume point is at the beginning of the item."
1070 ;; Ignore tags in un-ordered lists: they are just
1071 ;; a part of item's body.
1077 ;; If first line isn't empty, contents really start
1078 ;; at the text after item's meta-data.
1087 :begin begin
1088 :end end
1089 ;; CONTENTS-BEGIN and CONTENTS-END may be
1090 ;; mixed up in the case of an empty item
1091 ;; separated from the next by a blank line.
1092 ;; Thus ensure the former is always the
1093 ;; smallest.
1096 :checkbox checkbox
1097 :counter counter
1098 :structure struct
1101 item :tag
1109 "Interpret ITEM element as Org syntax.
1110 CONTENTS is the contents of the element."
1120 ;; Compute indentation.
1125 ;; Indent contents.
1127 bullet
1141 ;;;; Plain List
1144 ;; Return structure of list at point. Internal function. See
1145 ;; `org-list-struct' for details.
1153 items struct)
1158 ;; At limit: end all items.
1167 ;; At list end: end all items.
1172 ;; At a new item: end previous sibling.
1184 ind
1185 bullet
1188 ;; Description tag.
1192 ;; Ending position, unknown so far.
1193 nil)))
1194 items))
1196 ;; Skip empty lines.
1198 ;; Skip inline tasks and blank lines along the way.
1205 ;; At some text line. Check if it ends any previous item.
1217 ;; Skip blocks (any type) and drawers contents.
1223 limit t)))
1229 "Parse a plain list.
1231 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1232 the buffer position at the beginning of the first affiliated
1233 keyword and CDR is a plist of affiliated keywords along with
1234 their value. STRUCTURE is the structure of the plain list being
1235 parsed.
1237 Return a list whose CAR is `plain-list' and CDR is a plist
1238 containing `:type', `:begin', `:end', `:contents-begin' and
1239 `:contents-end', `:structure', `:post-blank' and
1240 `:post-affiliated' keywords.
1242 Assume point is at the beginning of the list."
1255 ;; Return value.
1259 :begin begin
1260 :end end
1261 :contents-begin contents-begin
1262 :contents-end contents-end
1263 :structure struct
1269 "Interpret PLAIN-LIST element as Org syntax.
1270 CONTENTS is the contents of the element."
1278 ;;;; Property Drawer
1281 "Parse a property drawer.
1283 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1284 the buffer position at the beginning of the first affiliated
1285 keyword and CDR is a plist of affiliated keywords along with
1286 their value.
1288 Return a list whose CAR is `property-drawer' and CDR is a plist
1289 containing `:begin', `:end', `:contents-begin', `:contents-end',
1290 `:post-blank' and `:post-affiliated' keywords.
1292 Assume point is at the beginning of the property drawer."
1297 ;; Incomplete drawer: parse it as a paragraph.
1316 :end end
1317 :contents-begin contents-begin
1318 :contents-end contents-end
1324 "Interpret PROPERTY-DRAWER element as Org syntax.
1325 CONTENTS is the properties within the drawer."
1329 ;;;; Quote Block
1332 "Parse a quote block.
1334 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1335 the buffer position at the beginning of the first affiliated
1336 keyword and CDR is a plist of affiliated keywords along with
1337 their value.
1339 Return a list whose CAR is `quote-block' and CDR is a plist
1340 containing `:begin', `:end', `:contents-begin', `:contents-end',
1341 `:post-blank' and `:post-affiliated' keywords.
1343 Assume point is at the beginning of the block."
1347 ;; Incomplete block: parse it as a paragraph.
1353 ;; Empty blocks have no contents.
1367 :end end
1368 :contents-begin contents-begin
1369 :contents-end contents-end
1375 "Interpret QUOTE-BLOCK element as Org syntax.
1376 CONTENTS is the contents of the element."
1380 ;;;; Section
1383 "Parse a section.
1385 LIMIT bounds the search.
1387 Return a list whose CAR is `section' and CDR is a plist
1388 containing `:begin', `:end', `:contents-begin', `contents-end'
1389 and `:post-blank' keywords."
1391 ;; Beginning of section is the beginning of the first non-blank
1392 ;; line after previous headline.
1401 :end end
1402 :contents-begin begin
1403 :contents-end pos-before-blank
1407 "Interpret SECTION element as Org syntax.
1408 CONTENTS is the contents of the element."
1409 contents)
1412 ;;;; Special Block
1415 "Parse a special block.
1417 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1418 the buffer position at the beginning of the first affiliated
1419 keyword and CDR is a plist of affiliated keywords along with
1420 their value.
1422 Return a list whose CAR is `special-block' and CDR is a plist
1423 containing `:type', `:begin', `:end', `:contents-begin',
1424 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1426 Assume point is at the beginning of the block."
1433 limit t)))
1434 ;; Incomplete block: parse it as a paragraph.
1440 ;; Empty blocks have no contents.
1454 :begin begin
1455 :end end
1456 :contents-begin contents-begin
1457 :contents-end contents-end
1463 "Interpret SPECIAL-BLOCK element as Org syntax.
1464 CONTENTS is the contents of the element."
1469 \f
1470 ;;; Elements
1471 ;;
1472 ;; For each element, a parser and an interpreter are also defined.
1473 ;; Both follow the same naming convention used for greater elements.
1474 ;;
1475 ;; Also, as for greater elements, adding a new element type is done
1476 ;; through the following steps: implement a parser and an interpreter,
1477 ;; tweak `org-element--current-element' so that it recognizes the new
1478 ;; type and add that new type to `org-element-all-elements'.
1479 ;;
1480 ;; As a special case, when the newly defined type is a block type,
1481 ;; `org-element-block-name-alist' has to be modified accordingly.
1484 ;;;; Babel Call
1487 "Parse a babel call.
1489 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1490 the buffer position at the beginning of the first affiliated
1491 keyword and CDR is a plist of affiliated keywords along with
1492 their value.
1494 Return a list whose CAR is `babel-call' and CDR is a plist
1495 containing `:begin', `:end', `:info', `:post-blank' and
1496 `:post-affiliated' as keywords."
1510 :end end
1511 :info info
1517 "Interpret BABEL-CALL element as Org syntax.
1518 CONTENTS is nil."
1524 ;; Remove redundant square brackets.
1529 ;;;; Clock
1532 "Parse a clock.
1534 LIMIT bounds the search.
1536 Return a list whose CAR is `clock' and CDR is a plist containing
1537 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1538 as keywords."
1558 :value value
1559 :duration duration
1560 :begin begin
1561 :end end
1565 "Interpret CLOCK element as Org syntax.
1566 CONTENTS is nil."
1574 "%2s:%02s"
1578 ;;;; Comment
1581 "Parse a comment.
1583 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1584 the buffer position at the beginning of the first affiliated
1585 keyword and CDR is a plist of affiliated keywords along with
1586 their value.
1588 Return a list whose CAR is `comment' and CDR is a plist
1589 containing `:begin', `:end', `:value', `:post-blank',
1590 `:post-affiliated' keywords.
1592 Assume point is at comment beginning."
1601 ;; Get comments ending.
1604 ;; Accumulate lines without leading hash and first
1605 ;; whitespace.
1620 :end end
1621 :value value
1627 "Interpret COMMENT element as Org syntax.
1628 CONTENTS is nil."
1632 ;;;; Comment Block
1635 "Parse an export block.
1637 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1638 the buffer position at the beginning of the first affiliated
1639 keyword and CDR is a plist of affiliated keywords along with
1640 their value.
1642 Return a list whose CAR is `comment-block' and CDR is a plist
1643 containing `:begin', `:end', `:value', `:post-blank' and
1644 `:post-affiliated' keywords.
1646 Assume point is at comment block beginning."
1650 ;; Incomplete block: parse it as a paragraph.
1664 contents-begin contents-end)))
1668 :end end
1669 :value value
1675 "Interpret COMMENT-BLOCK element as Org syntax.
1676 CONTENTS is nil."
1681 ;;;; Diary Sexp
1684 "Parse a diary sexp.
1686 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1687 the buffer position at the beginning of the first affiliated
1688 keyword and CDR is a plist of affiliated keywords along with
1689 their value.
1691 Return a list whose CAR is `diary-sexp' and CDR is a plist
1692 containing `:begin', `:end', `:value', `:post-blank' and
1693 `:post-affiliated' keywords."
1706 :begin begin
1707 :end end
1713 "Interpret DIARY-SEXP as Org syntax.
1714 CONTENTS is nil."
1718 ;;;; Example Block
1721 "Remove maximum common indentation in string S and return it.
1722 When optional argument N is a positive integer, remove exactly
1723 that much characters from indentation, if possible, or return
1724 S as-is otherwise. Unlike to `org-remove-indentation', this
1725 function doesn't call `untabify' on S."
1730 ;; Find maximum common indentation, if not specified.
1738 min-ind)))
1740 ;; Remove exactly N indentation, but give up if not possible.
1750 "Parse an example block.
1752 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1753 the buffer position at the beginning of the first affiliated
1754 keyword and CDR is a plist of affiliated keywords along with
1755 their value.
1757 Return a list whose CAR is `example-block' and CDR is a plist
1758 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1759 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1760 `:value', `:post-blank' and `:post-affiliated' keywords."
1764 ;; Incomplete block: parse it as a paragraph.
1772 ;; Switches analysis
1780 ;; Should labels be retained in (or stripped from) example
1781 ;; blocks?
1786 ;; What should code-references use - labels or
1787 ;; line-numbers?
1796 ;; Standard block parsing.
1804 contents-begin contents-end))
1815 :end end
1816 :value value
1817 :switches switches
1818 :number-lines number-lines
1819 :preserve-indent preserve-indent
1820 :retain-labels retain-labels
1821 :use-labels use-labels
1822 :label-fmt label-fmt
1828 "Interpret EXAMPLE-BLOCK element as Org syntax.
1829 CONTENTS is nil."
1837 ;;;; Export Block
1840 "Parse an export block.
1842 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1843 the buffer position at the beginning of the first affiliated
1844 keyword and CDR is a plist of affiliated keywords along with
1845 their value.
1847 Return a list whose CAR is `export-block' and CDR is a plist
1848 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1849 `:post-affiliated' keywords.
1851 Assume point is at export-block beginning."
1858 ;; Incomplete block: parse it as a paragraph.
1872 contents-end)))
1876 :end end
1877 :type type
1878 :value value
1884 "Interpret EXPORT-BLOCK element as Org syntax.
1885 CONTENTS is nil."
1892 ;;;; Fixed-width
1895 "Parse a fixed-width section.
1897 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1898 the buffer position at the beginning of the first affiliated
1899 keyword and CDR is a plist of affiliated keywords along with
1900 their value.
1902 Return a list whose CAR is `fixed-width' and CDR is a plist
1903 containing `:begin', `:end', `:value', `:post-blank' and
1904 `:post-affiliated' keywords.
1906 Assume point is at the beginning of the fixed-width area."
1910 value
1915 ;; Accumulate text without starting colons.
1929 :end end
1930 :value value
1936 "Interpret FIXED-WIDTH element as Org syntax.
1937 CONTENTS is nil."
1945 ;;;; Horizontal Rule
1948 "Parse an horizontal rule.
1950 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1951 the buffer position at the beginning of the first affiliated
1952 keyword and CDR is a plist of affiliated keywords along with
1953 their value.
1955 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1956 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1957 keywords."
1968 :end end
1974 "Interpret HORIZONTAL-RULE element as Org syntax.
1975 CONTENTS is nil."
1979 ;;;; Keyword
1982 "Parse a keyword at point.
1984 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1985 the buffer position at the beginning of the first affiliated
1986 keyword and CDR is a plist of affiliated keywords along with
1987 their value.
1989 Return a list whose CAR is `keyword' and CDR is a plist
1990 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1991 `:post-affiliated' keywords."
2006 :value value
2007 :begin begin
2008 :end end
2014 "Interpret KEYWORD element as Org syntax.
2015 CONTENTS is nil."
2021 ;;;; Latex Environment
2024 "Parse a LaTeX environment.
2026 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2027 the buffer position at the beginning of the first affiliated
2028 keyword and CDR is a plist of affiliated keywords along with
2029 their value.
2031 Return a list whose CAR is `latex-environment' and CDR is a plist
2032 containing `:begin', `:end', `:value', `:post-blank' and
2033 `:post-affiliated' keywords.
2035 Assume point is at the beginning of the latex environment."
2042 limit t))
2043 ;; Incomplete latex environment: parse it as a paragraph.
2054 :end end
2055 :value value
2061 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2062 CONTENTS is nil."
2066 ;;;; Node Property
2069 "Parse a node-property at point.
2071 LIMIT bounds the search.
2073 Return a list whose CAR is `node-property' and CDR is a plist
2074 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2075 keywords."
2087 :value value
2088 :begin begin
2089 :end end
2093 "Interpret NODE-PROPERTY element as Org syntax.
2094 CONTENTS is nil."
2100 ;;;; Paragraph
2103 "Parse a paragraph.
2105 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2106 the buffer position at the beginning of the first affiliated
2107 keyword and CDR is a plist of affiliated keywords along with
2108 their value.
2110 Return a list whose CAR is `paragraph' and CDR is a plist
2111 containing `:begin', `:end', `:contents-begin' and
2112 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2114 Assume point is at the beginning of the paragraph."
2123 limit
2124 ;; A matching `org-element-paragraph-separate' is not
2125 ;; necessarily the end of the paragraph. In
2126 ;; particular, lines starting with # or : as a first
2127 ;; non-space character are ambiguous. We have check
2128 ;; if they are valid Org syntax (i.e. not an
2129 ;; incomplete keyword).
2133 ;; There's no ambiguity for other symbols or
2134 ;; empty lines: stop here.
2136 ;; Stop at valid fixed-width areas.
2138 ;; Stop at drawers.
2143 ;; Stop at valid comments.
2145 ;; Stop at valid dynamic blocks.
2150 ;; Stop at valid blocks.
2157 limit t)))
2158 ;; Stop at valid latex environments.
2166 limit t)))
2167 ;; Stop at valid keywords.
2169 ;; Skip everything else.
2187 :end end
2188 :contents-begin contents-begin
2189 :contents-end contents-end
2195 "Interpret PARAGRAPH element as Org syntax.
2196 CONTENTS is the contents of the element."
2197 contents)
2200 ;;;; Planning
2203 "Parse a planning.
2205 LIMIT bounds the search.
2207 Return a list whose CAR is `planning' and CDR is a plist
2208 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2209 and `:post-blank' keywords."
2219 closed deadline scheduled)
2231 :deadline deadline
2232 :scheduled scheduled
2233 :begin begin
2234 :end end
2238 "Interpret PLANNING element as Org syntax.
2239 CONTENTS is nil."
2241 'identity
2258 ;;;; Quote Section
2261 "Parse a quote section.
2263 LIMIT bounds the search.
2265 Return a list whose CAR is `quote-section' and CDR is a plist
2266 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2268 Assume point is at beginning of the section."
2279 :end end
2280 :value value
2284 "Interpret QUOTE-SECTION element as Org syntax.
2285 CONTENTS is nil."
2289 ;;;; Src Block
2292 "Parse a src block.
2294 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2295 the buffer position at the beginning of the first affiliated
2296 keyword and CDR is a plist of affiliated keywords along with
2297 their value.
2299 Return a list whose CAR is `src-block' and CDR is a plist
2300 containing `:language', `:switches', `:parameters', `:begin',
2301 `:end', `:number-lines', `:retain-labels', `:use-labels',
2302 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2303 `:post-affiliated' keywords.
2305 Assume point is at the beginning of the block."
2308 limit t)))
2309 ;; Incomplete block: parse it as a paragraph.
2315 ;; Get language as a string.
2324 ;; Get switches.
2326 ;; Get parameters.
2328 ;; Switches analysis
2340 ;; Should labels be retained in (or stripped from)
2341 ;; src blocks?
2346 ;; What should code-references use - labels or
2347 ;; line-numbers?
2352 ;; Indentation.
2354 ;; Retrieve code.
2363 ;; Get position after ending blank lines.
2374 :begin begin
2375 :end end
2376 :number-lines number-lines
2377 :preserve-indent preserve-indent
2378 :retain-labels retain-labels
2379 :use-labels use-labels
2380 :label-fmt label-fmt
2381 :value value
2387 "Interpret SRC-BLOCK element as Org syntax.
2388 CONTENTS is nil."
2409 ;;;; Table
2412 "Parse a table at point.
2414 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2415 the buffer position at the beginning of the first affiliated
2416 keyword and CDR is a plist of affiliated keywords along with
2417 their value.
2419 Return a list whose CAR is `table' and CDR is a plist containing
2420 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2421 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2422 keywords.
2424 Assume point is at the beginning of the table."
2438 acc))
2446 :end end
2447 :type type
2448 :tblfm tblfm
2449 ;; Only `org' tables have contents. `table.el' tables
2450 ;; use a `:value' property to store raw table as
2451 ;; a string.
2456 table-begin table-end))
2462 "Interpret TABLE element as Org syntax.
2463 CONTENTS is nil."
2474 ;;;; Table Row
2477 "Parse table row at point.
2479 LIMIT bounds the search.
2481 Return a list whose CAR is `table-row' and CDR is a plist
2482 containing `:begin', `:end', `:contents-begin', `:contents-end',
2483 `:type' and `:post-blank' keywords."
2487 ;; A table rule has no contents. In that case, ensure
2488 ;; CONTENTS-BEGIN matches CONTENTS-END.
2500 :begin begin
2501 :end end
2502 :contents-begin contents-begin
2503 :contents-end contents-end
2507 "Interpret TABLE-ROW element as Org syntax.
2508 CONTENTS is the contents of the table row."
2513 ;;;; Verse Block
2516 "Parse a verse block.
2518 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2519 the buffer position at the beginning of the first affiliated
2520 keyword and CDR is a plist of affiliated keywords along with
2521 their value.
2523 Return a list whose CAR is `verse-block' and CDR is a plist
2524 containing `:begin', `:end', `:contents-begin', `:contents-end',
2525 `:post-blank' and `:post-affiliated' keywords.
2527 Assume point is at beginning of the block."
2531 ;; Incomplete block: parse it as a paragraph.
2547 :end end
2548 :contents-begin contents-begin
2549 :contents-end contents-end
2555 "Interpret VERSE-BLOCK element as Org syntax.
2556 CONTENTS is verse block contents."
2560 \f
2561 ;;; Objects
2562 ;;
2563 ;; Unlike to elements, interstices can be found between objects.
2564 ;; That's why, along with the parser, successor functions are provided
2565 ;; for each object. Some objects share the same successor (i.e. `code'
2566 ;; and `verbatim' objects).
2567 ;;
2568 ;; A successor must accept a single argument bounding the search. It
2569 ;; will return either a cons cell whose CAR is the object's type, as
2570 ;; a symbol, and CDR the position of its next occurrence, or nil.
2571 ;;
2572 ;; Successors follow the naming convention:
2573 ;; org-element-NAME-successor, where NAME is the name of the
2574 ;; successor, as defined in `org-element-all-successors'.
2575 ;;
2576 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2577 ;; object types they can contain will be specified in
2578 ;; `org-element-object-restrictions'.
2579 ;;
2580 ;; Adding a new type of object is simple. Implement a successor,
2581 ;; a parser, and an interpreter for it, all following the naming
2582 ;; convention. Register type in `org-element-all-objects' and
2583 ;; successor in `org-element-all-successors'. Maybe tweak
2584 ;; restrictions about it, and that's it.
2587 ;;;; Bold
2590 "Parse bold object at point.
2592 Return a list whose CAR is `bold' and CDR is a plist with
2593 `:begin', `:end', `:contents-begin' and `:contents-end' and
2594 `:post-blank' keywords.
2596 Assume point is at the first star marker."
2608 :end end
2609 :contents-begin contents-begin
2610 :contents-end contents-end
2614 "Interpret BOLD object as Org syntax.
2615 CONTENTS is the contents of the object."
2619 "Search for the next text-markup object.
2621 Return value is a cons cell whose CAR is a symbol among `bold',
2622 `italic', `underline', `strike-through', `code' and `verbatim'
2623 and CDR is beginning position."
2639 ;;;; Code
2642 "Parse code object at point.
2644 Return a list whose CAR is `code' and CDR is a plist with
2645 `:value', `:begin', `:end' and `:post-blank' keywords.
2647 Assume point is at the first tilde marker."
2658 :begin begin
2659 :end end
2663 "Interpret CODE object as Org syntax.
2664 CONTENTS is nil."
2668 ;;;; Entity
2671 "Parse entity at point.
2673 Return a list whose CAR is `entity' and CDR a plist with
2674 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2675 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2676 keywords.
2678 Assume point is at the beginning of the entity."
2680 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2696 :begin begin
2697 :end end
2698 :use-brackets-p bracketsp
2702 "Interpret ENTITY object as Org syntax.
2703 CONTENTS is nil."
2709 "Search for the next latex-fragment or entity object.
2711 Return value is a cons cell whose CAR is `entity' or
2712 `latex-fragment' and CDR is beginning position."
2717 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2724 nil t)
2727 ;; Determine if it's a real entity or a LaTeX command.
2730 ;; No entity nor command: point is at a LaTeX fragment.
2731 ;; Determine its type to get the correct beginning position.
2739 matchers)
2743 ;;;; Export Snippet
2746 "Parse export snippet at point.
2748 Return a list whose CAR is `export-snippet' and CDR a plist with
2749 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2750 keywords.
2752 Assume point is at the beginning of the snippet."
2764 :value value
2765 :begin begin
2766 :end end
2770 "Interpret EXPORT-SNIPPET object as Org syntax.
2771 CONTENTS is nil."
2777 "Search for the next export-snippet object.
2779 Return value is a cons cell whose CAR is `export-snippet' and CDR
2780 its beginning position."
2789 ;;;; Footnote Reference
2792 "Parse footnote reference at point.
2794 Return a list whose CAR is `footnote-reference' and CDR a plist
2795 with `:label', `:type', `:inline-definition', `:begin', `:end'
2796 and `:post-blank' as keywords."
2818 :type type
2819 :begin begin
2820 :end end
2823 footnote-reference :inline-definition
2828 footnote-reference))))))
2831 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2832 CONTENTS is nil."
2842 "Search for the next footnote-reference object.
2844 Return value is a cons cell whose CAR is `footnote-reference' and
2845 CDR is beginning position."
2859 ;;;; Inline Babel Call
2862 "Parse inline babel call at point.
2864 Return a list whose CAR is `inline-babel-call' and CDR a plist
2865 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2867 Assume point is at the beginning of the babel call."
2878 :end end
2879 :info info
2883 "Interpret INLINE-BABEL-CALL object as Org syntax.
2884 CONTENTS is nil."
2890 ;; Remove redundant square brackets.
2893 main-source)
2897 "Search for the next inline-babel-call object.
2899 Return value is a cons cell whose CAR is `inline-babel-call' and
2900 CDR is beginning position."
2902 ;; Use a simplified version of
2903 ;; `org-babel-inline-lob-one-liner-regexp'.
2906 nil t)
2910 ;;;; Inline Src Block
2913 "Parse inline source block at point.
2915 Return a list whose CAR is `inline-src-block' and CDR a plist
2916 with `:begin', `:end', `:language', `:value', `:parameters' and
2917 `:post-blank' as keywords.
2919 Assume point is at the beginning of the inline src block."
2932 :value value
2933 :parameters parameters
2934 :begin begin
2935 :end end
2939 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2940 CONTENTS is nil."
2945 language
2947 body)))
2950 "Search for the next inline-babel-call element.
2952 Return value is a cons cell whose CAR is `inline-babel-call' and
2953 CDR is beginning position."
2959 ;;;; Italic
2962 "Parse italic object at point.
2964 Return a list whose CAR is `italic' and CDR is a plist with
2965 `:begin', `:end', `:contents-begin' and `:contents-end' and
2966 `:post-blank' keywords.
2968 Assume point is at the first slash marker."
2980 :end end
2981 :contents-begin contents-begin
2982 :contents-end contents-end
2986 "Interpret ITALIC object as Org syntax.
2987 CONTENTS is the contents of the object."
2991 ;;;; Latex Fragment
2994 "Parse latex fragment at point.
2996 Return a list whose CAR is `latex-fragment' and CDR a plist with
2997 `:value', `:begin', `:end', and `:post-blank' as keywords.
2999 Assume point is at the beginning of the latex fragment."
3013 ;; None found: it's a macro.
3022 :begin begin
3023 :end end
3027 "Interpret LATEX-FRAGMENT object as Org syntax.
3028 CONTENTS is nil."
3031 ;;;; Line Break
3034 "Parse line break at point.
3036 Return a list whose CAR is `line-break', and CDR a plist with
3037 `:begin', `:end' and `:post-blank' keywords.
3039 Assume point is at the beginning of the line break."
3046 "Interpret LINE-BREAK object as Org syntax.
3047 CONTENTS is nil."
3051 "Search for the next line-break object.
3053 Return value is a cons cell whose CAR is `line-break' and CDR is
3054 beginning position."
3058 ;; A line break can only happen on a non-empty line.
3063 ;;;; Link
3066 "Parse link at point.
3068 Return a list whose CAR is `link' and CDR a plist with `:type',
3069 `:path', `:raw-link', `:application', `:search-option', `:begin',
3070 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3071 keywords.
3073 Assume point is at the beginning of the link."
3076 end contents-begin contents-end link-end post-blank path type
3077 raw-link link search-option application)
3079 ;; Type 1: Text targeted from a radio target.
3084 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3089 ;; RAW-LINK is the original link. Expand any
3090 ;; abbreviation in it.
3094 ;; Determine TYPE of link and set PATH accordingly.
3096 ;; File type.
3100 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3103 ;; Id type: PATH is the id.
3106 ;; Code-ref type: PATH is the name of the reference.
3109 ;; Custom-id type: PATH is the name of the custom id.
3112 ;; Fuzzy type: Internal link either matches a target, an
3113 ;; headline name or nothing. PATH is the target or
3114 ;; headline's name.
3116 ;; Type 3: Plain link, i.e. http://orgmode.org
3122 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3129 ;; In any case, deduce end point after trailing white space from
3130 ;; LINK-END variable.
3133 ;; Extract search option and opening application out of
3134 ;; "file"-type links.
3136 ;; Application.
3141 ;; Extract search option from PATH.
3145 ;; Make sure TYPE always reports "file".
3149 :path path
3151 :application application
3152 :search-option search-option
3153 :begin begin
3154 :end end
3155 :contents-begin contents-begin
3156 :contents-end contents-end
3160 "Interpret LINK object as Org syntax.
3161 CONTENTS is the contents of the object, or nil."
3166 raw-link
3170 "Search for the next link object.
3172 Return value is a cons cell whose CAR is `link' and CDR is
3173 beginning position."
3182 "Search for the next plain link object.
3184 Return value is a cons cell whose CAR is `link' and CDR is
3185 beginning position."
3190 ;;;; Macro
3193 "Parse macro at point.
3195 Return a list whose CAR is `macro' and CDR a plist with `:key',
3196 `:args', `:begin', `:end', `:value' and `:post-blank' as
3197 keywords.
3199 Assume point is at the macro."
3210 ;; Do not use `org-split-string' since empty
3211 ;; strings are meaningful here.
3219 args nil t)
3223 :value value
3224 :args args
3225 :begin begin
3226 :end end
3230 "Interpret MACRO object as Org syntax.
3231 CONTENTS is nil."
3235 "Search for the next macro object.
3237 Return value is cons cell whose CAR is `macro' and CDR is
3238 beginning position."
3242 nil t)
3246 ;;;; Radio-target
3249 "Parse radio target at point.
3251 Return a list whose CAR is `radio-target' and CDR a plist with
3252 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3253 and `:post-blank' as keywords.
3255 Assume point is at the radio target."
3267 :end end
3268 :contents-begin contents-begin
3269 :contents-end contents-end
3270 :post-blank post-blank
3274 "Interpret TARGET object as Org syntax.
3275 CONTENTS is the contents of the object."
3279 "Search for the next radio-target object.
3281 Return value is a cons cell whose CAR is `radio-target' and CDR
3282 is beginning position."
3288 ;;;; Statistics Cookie
3291 "Parse statistics cookie at point.
3293 Return a list whose CAR is `statistics-cookie', and CDR a plist
3294 with `:begin', `:end', `:value' and `:post-blank' keywords.
3296 Assume point is at the beginning of the statistics-cookie."
3307 :end end
3308 :value value
3312 "Interpret STATISTICS-COOKIE object as Org syntax.
3313 CONTENTS is nil."
3317 "Search for the next statistics cookie object.
3319 Return value is a cons cell whose CAR is `statistics-cookie' and
3320 CDR is beginning position."
3326 ;;;; Strike-Through
3329 "Parse strike-through object at point.
3331 Return a list whose CAR is `strike-through' and CDR is a plist
3332 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3333 `:post-blank' keywords.
3335 Assume point is at the first plus sign marker."
3347 :end end
3348 :contents-begin contents-begin
3349 :contents-end contents-end
3353 "Interpret STRIKE-THROUGH object as Org syntax.
3354 CONTENTS is the contents of the object."
3358 ;;;; Subscript
3361 "Parse subscript at point.
3363 Return a list whose CAR is `subscript' and CDR a plist with
3364 `:begin', `:end', `:contents-begin', `:contents-end',
3365 `:use-brackets-p' and `:post-blank' as keywords.
3367 Assume point is at the underscore."
3371 t
3382 :end end
3383 :use-brackets-p bracketsp
3384 :contents-begin contents-begin
3385 :contents-end contents-end
3389 "Interpret SUBSCRIPT object as Org syntax.
3390 CONTENTS is the contents of the object."
3393 contents))
3396 "Search for the next sub/superscript object.
3398 Return value is a cons cell whose CAR is either `subscript' or
3399 `superscript' and CDR is beginning position."
3407 ;;;; Superscript
3410 "Parse superscript at point.
3412 Return a list whose CAR is `superscript' and CDR a plist with
3413 `:begin', `:end', `:contents-begin', `:contents-end',
3414 `:use-brackets-p' and `:post-blank' as keywords.
3416 Assume point is at the caret."
3430 :end end
3431 :use-brackets-p bracketsp
3432 :contents-begin contents-begin
3433 :contents-end contents-end
3437 "Interpret SUPERSCRIPT object as Org syntax.
3438 CONTENTS is the contents of the object."
3441 contents))
3444 ;;;; Table Cell
3447 "Parse table cell at point.
3449 Return a list whose CAR is `table-cell' and CDR is a plist
3450 containing `:begin', `:end', `:contents-begin', `:contents-end'
3451 and `:post-blank' keywords."
3459 :end end
3460 :contents-begin contents-begin
3461 :contents-end contents-end
3465 "Interpret TABLE-CELL element as Org syntax.
3466 CONTENTS is the contents of the cell, or nil."
3470 "Search for the next table-cell object.
3472 Return value is a cons cell whose CAR is `table-cell' and CDR is
3473 beginning position."
3477 ;;;; Target
3480 "Parse target at point.
3482 Return a list whose CAR is `target' and CDR a plist with
3483 `:begin', `:end', `:value' and `:post-blank' as keywords.
3485 Assume point is at the target."
3495 :end end
3496 :value value
3500 "Interpret TARGET object as Org syntax.
3501 CONTENTS is nil."
3505 "Search for the next target object.
3507 Return value is a cons cell whose CAR is `target' and CDR is
3508 beginning position."
3514 ;;;; Timestamp
3517 "Parse time stamp at point.
3519 Return a list whose CAR is `timestamp', and CDR a plist with
3520 `:type', `:raw-value', `:year-start', `:month-start',
3521 `:day-start', `:hour-start', `:minute-start', `:year-end',
3522 `:month-end', `:day-end', `:hour-end', `:minute-end',
3523 `:repeater-type', `:repeater-value', `:repeater-unit',
3524 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3525 `:end', `:value' and `:post-blank' keywords.
3527 Assume point is at the beginning of the timestamp."
3545 date-start)
3556 raw-value)
3558 :repeater-type
3564 :repeater-unit
3573 :warning-unit
3576 year-start month-start day-start hour-start minute-start year-end
3577 month-end day-end hour-end minute-end)
3578 ;; Parse date-start.
3586 ;; Compute date-end. It can be provided directly in time-stamp,
3587 ;; or extracted from time range. Otherwise, it defaults to the
3588 ;; same values as date-start.
3598 :raw-value raw-value
3599 :year-start year-start
3600 :month-start month-start
3601 :day-start day-start
3602 :hour-start hour-start
3603 :minute-start minute-start
3604 :year-end year-end
3605 :month-end month-end
3606 :day-end day-end
3607 :hour-end hour-end
3608 :minute-end minute-end
3609 :begin begin
3610 :end end
3612 repeater-props
3613 warning-props)))))
3616 "Interpret TIMESTAMP object as Org syntax.
3617 CONTENTS is nil."
3618 ;; Use `:raw-value' if specified.
3620 ;; Otherwise, build timestamp string.
3639 ;; Build an Org timestamp string from TIME. ACTIVEP is
3640 ;; non-nil when time stamp is active. If WITH-TIME-P is
3641 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3642 ;; specify a time range in the timestamp. REPEAT-STRING
3643 ;; is the repeater string, if any.
3647 org-time-stamp-formats)
3648 time)))
3654 nil nil ts)))
3659 " "
3660 s
3662 ;; Return value.
3663 ts)))
3675 build-ts-string
3694 0
3702 "--"
3714 "Search for the next timestamp object.
3716 Return value is a cons cell whose CAR is `timestamp' and CDR is
3717 beginning position."
3725 nil t)
3729 ;;;; Underline
3732 "Parse underline object at point.
3734 Return a list whose CAR is `underline' and CDR is a plist with
3735 `:begin', `:end', `:contents-begin' and `:contents-end' and
3736 `:post-blank' keywords.
3738 Assume point is at the first underscore marker."
3750 :end end
3751 :contents-begin contents-begin
3752 :contents-end contents-end
3756 "Interpret UNDERLINE object as Org syntax.
3757 CONTENTS is the contents of the object."
3761 ;;;; Verbatim
3764 "Parse verbatim object at point.
3766 Return a list whose CAR is `verbatim' and CDR is a plist with
3767 `:value', `:begin', `:end' and `:post-blank' keywords.
3769 Assume point is at the first equal sign marker."
3780 :begin begin
3781 :end end
3785 "Interpret VERBATIM object as Org syntax.
3786 CONTENTS is nil."
3790 \f
3791 ;;; Parsing Element Starting At Point
3792 ;;
3793 ;; `org-element--current-element' is the core function of this section.
3794 ;; It returns the Lisp representation of the element starting at
3795 ;; point.
3796 ;;
3797 ;; `org-element--current-element' makes use of special modes. They
3798 ;; are activated for fixed element chaining (i.e. `plain-list' >
3799 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3800 ;; `section'). Special modes are: `first-section', `item',
3801 ;; `node-property', `quote-section', `section' and `table-row'.
3805 "Parse the element starting at point.
3807 Return value is a list like (TYPE PROPS) where TYPE is the type
3808 of the element and PROPS a plist of properties associated to the
3809 element.
3811 Possible types are defined in `org-element-all-elements'.
3813 LIMIT bounds the search.
3815 Optional argument GRANULARITY determines the depth of the
3816 recursion. Allowed values are `headline', `greater-element',
3817 `element', `object' or nil. When it is broader than `object' (or
3818 nil), secondary values will not be parsed, since they only
3819 contain objects.
3821 Optional argument SPECIAL, when non-nil, can be either
3822 `first-section', `item', `node-property', `quote-section',
3823 `section', and `table-row'.
3825 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3826 be computed.
3828 This function assumes point is always at the beginning of the
3829 element it has to parse."
3832 ;; Determine if parsing depth allows for secondary strings
3833 ;; parsing. It only applies to elements referenced in
3834 ;; `org-element-secondary-value-alist'.
3837 ;; Item.
3840 ;; Table Row.
3842 ;; Node Property.
3844 ;; Headline.
3847 ;; Sections (must be checked after headline).
3853 limit)))
3854 ;; When not at bol, point is at the beginning of an item or
3855 ;; a footnote definition: next item is always a paragraph.
3857 ;; Planning and Clock.
3862 ;; Inlinetask.
3865 ;; From there, elements can have affiliated keywords.
3868 ;; Jumping over affiliated keywords put point off-limits.
3869 ;; Parse them as regular keywords.
3873 ;; LaTeX Environment.
3877 ;; Drawer and Property Drawer.
3882 ;; Fixed Width
3885 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3886 ;; Keywords.
3895 org-element-block-name-alist)))
3910 ;; Footnote Definition.
3913 ;; Horizontal Rule.
3916 ;; Diary Sexp.
3919 ;; Table.
3921 ;; List.
3924 limit affiliated
3926 ;; Default element: Paragraph.
3930 ;; Most elements can have affiliated keywords. When looking for an
3931 ;; element beginning, we want to move before them, as they belong to
3932 ;; that element, and, in the meantime, collect information they give
3933 ;; into appropriate properties. Hence the following function.
3936 "Collect affiliated keywords from point down to LIMIT.
3938 Return a list whose CAR is the position at the first of them and
3939 CDR a plist of keywords and values and move point to the
3940 beginning of the first line after them.
3942 As a special case, if element doesn't start at the beginning of
3943 the line (i.e. a paragraph starting an item), CAR is current
3944 position of point and CDR is nil."
3948 ;; RESTRICT is the list of objects allowed in parsed
3949 ;; keywords value.
3951 output)
3954 ;; Apply translation to RAW-KWD. From there, KWD is
3955 ;; the official keyword.
3957 org-element-keyword-translation-alist))
3958 raw-kwd))
3959 ;; Find main value for any keyword.
3965 ;; PARSEDP is non-nil when keyword should have its
3966 ;; value parsed.
3968 ;; If KWD is a dual keyword, find its secondary
3969 ;; value. Maybe parse it.
3976 ;; Attribute a property name to KWD.
3978 ;; Now set final shape for VALUE.
3984 ;; Attributes can always appear on multiple lines.
3987 ;; Eventually store the new value in OUTPUT.
3989 ;; Move to next keyword.
3991 ;; If affiliated keywords are orphaned: move back to first one.
3992 ;; They will be parsed as a paragraph.
3994 ;; Return value.
3998 \f
3999 ;;; The Org Parser
4000 ;;
4001 ;; The two major functions here are `org-element-parse-buffer', which
4002 ;; parses Org syntax inside the current buffer, taking into account
4003 ;; region, narrowing, or even visibility if specified, and
4004 ;; `org-element-parse-secondary-string', which parses objects within
4005 ;; a given string.
4006 ;;
4007 ;; The (almost) almighty `org-element-map' allows to apply a function
4008 ;; on elements or objects matching some type, and accumulate the
4009 ;; resulting values. In an export situation, it also skips unneeded
4010 ;; parts of the parse tree.
4013 "Recursively parse the buffer and return structure.
4014 If narrowing is in effect, only parse the visible part of the
4015 buffer.
4017 Optional argument GRANULARITY determines the depth of the
4018 recursion. It can be set to the following symbols:
4020 `headline' Only parse headlines.
4021 `greater-element' Don't recurse into greater elements excepted
4022 headlines and sections. Thus, elements
4023 parsed are the top-level ones.
4024 `element' Parse everything but objects and plain text.
4025 `object' Parse the complete buffer (default).
4027 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4028 elements.
4030 An element or an objects is represented as a list with the
4031 pattern (TYPE PROPERTIES CONTENTS), where :
4033 TYPE is a symbol describing the element or object. See
4034 `org-element-all-elements' and `org-element-all-objects' for an
4035 exhaustive list of such symbols. One can retrieve it with
4036 `org-element-type' function.
4038 PROPERTIES is the list of attributes attached to the element or
4039 object, as a plist. Although most of them are specific to the
4040 element or object type, all types share `:begin', `:end',
4041 `:post-blank' and `:parent' properties, which respectively
4042 refer to buffer position where the element or object starts,
4043 ends, the number of white spaces or blank lines after it, and
4044 the element or object containing it. Properties values can be
4045 obtained by using `org-element-property' function.
4047 CONTENTS is a list of elements, objects or raw strings
4048 contained in the current element or object, when applicable.
4049 One can access them with `org-element-contents' function.
4051 The Org buffer has `org-data' as type and nil as properties.
4052 `org-element-map' function can be used to find specific elements
4053 or objects within the parse tree.
4055 This function assumes that current major mode is `org-mode'."
4061 ;; Start in `first-section' mode so text before the first
4062 ;; headline belongs to a section.
4066 "Recursively parse objects in STRING and return structure.
4068 RESTRICTION is a symbol limiting the object types that will be
4069 looked after.
4071 Optional argument PARENT, when non-nil, is the element or object
4072 containing the secondary string. It is used to set correctly
4073 `:parent' property within the string."
4074 ;; Copy buffer-local variables listed in
4075 ;; `org-element-object-variables' into temporary buffer. This is
4076 ;; required since object parsing is dependent on these variables.
4080 org-element-object-variables))))
4088 secondary))
4089 secondary))))
4093 "Map a function on selected elements or objects.
4095 DATA is a parse tree, an element, an object, a string, or a list
4096 of such constructs. TYPES is a symbol or list of symbols of
4097 elements or objects types (see `org-element-all-elements' and
4098 `org-element-all-objects' for a complete list of types). FUN is
4099 the function called on the matching element or object. It has to
4100 accept one argument: the element or object itself.
4102 When optional argument INFO is non-nil, it should be a plist
4103 holding export options. In that case, parts of the parse tree
4104 not exportable according to that property list will be skipped.
4106 When optional argument FIRST-MATCH is non-nil, stop at the first
4107 match for which FUN doesn't return nil, and return that value.
4109 Optional argument NO-RECURSION is a symbol or a list of symbols
4110 representing elements or objects types. `org-element-map' won't
4111 enter any recursive element or object whose type belongs to that
4112 list. Though, FUN can still be applied on them.
4114 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4115 apply to matching objects within parsed affiliated keywords (see
4116 `org-element-parsed-keywords').
4118 Nil values returned from FUN do not appear in the results.
4121 Examples:
4122 ---------
4124 Assuming TREE is a variable containing an Org buffer parse tree,
4125 the following example will return a flat list of all `src-block'
4126 and `example-block' elements in it:
4128 \(org-element-map tree '(example-block src-block) 'identity)
4130 The following snippet will find the first headline with a level
4133 \(org-element-map tree 'headline
4134 \(lambda (hl)
4135 \(and (= (org-element-property :level hl) 1)
4137 \(org-element-property :begin hl)))
4138 nil t)
4140 The next example will return a flat list of all `plain-list' type
4141 elements in TREE that are not a sub-list themselves:
4143 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4145 Eventually, this example will return a flat list of all `bold'
4146 type objects containing a `latex-snippet' type object, even
4147 looking into captions:
4149 \(org-element-map tree 'bold
4150 \(lambda (b)
4151 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4152 nil nil nil t)"
4153 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4156 ;; Recursion depth is determined by --CATEGORY.
4163 ;; If one object is found, the function
4164 ;; has to recurse into every object.
4167 ;; If one regular element is found, the
4168 ;; function has to recurse, at least,
4169 ;; into every element it encounters.
4172 types)
4173 category)))
4174 ;; Compute properties for affiliated keywords if necessary.
4179 org-element-affiliated-keywords)))
4180 --acc
4181 --walk-tree
4185 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4186 ;; holding contextual information.
4190 ;; Ignored element in an export context.
4192 ;; List of elements or objects.
4194 ;; Unconditionally enter parse trees.
4198 ;; Check if TYPE is matching among TYPES. If so,
4199 ;; apply FUN to --DATA and accumulate return value
4200 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4206 ;; If --DATA has a secondary string that can contain
4207 ;; objects with their type among TYPES, look into it.
4214 ;; If --DATA has any affiliated keywords and
4215 ;; WITH-AFFILIATED is non-nil, look for objects in
4216 ;; them.
4224 ;; Pay attention to the type of value.
4225 ;; Preserve order for multiple keywords.
4241 --affiliated-alist))
4242 ;; Determine if a recursion into --DATA is possible.
4244 ;; --TYPE is explicitly removed from recursion.
4246 ;; --DATA has no contents.
4248 ;; Looking for greater elements but --DATA is simply
4249 ;; an element or an object.
4252 ;; Looking for elements but --DATA is an object.
4255 ;; In any other case, map contents.
4259 ;; Return value in a proper order.
4263 ;; The following functions are internal parts of the parser.
4264 ;;
4265 ;; The first one, `org-element--parse-elements' acts at the element's
4266 ;; level.
4267 ;;
4268 ;; The second one, `org-element--parse-objects' applies on all objects
4269 ;; of a paragraph or a secondary string. It uses
4270 ;; `org-element--get-next-object-candidates' to optimize the search of
4271 ;; the next object in the buffer.
4272 ;;
4273 ;; More precisely, that function looks for every allowed object type
4274 ;; first. Then, it discards failed searches, keeps further matches,
4275 ;; and searches again types matched behind point, for subsequent
4276 ;; calls. Thus, searching for a given type fails only once, and every
4277 ;; object is searched only once at top level (but sometimes more for
4278 ;; nested types).
4282 "Parse elements between BEG and END positions.
4284 SPECIAL prioritize some elements over the others. It can be set
4285 to `first-section', `quote-section', `section' `item' or
4286 `table-row'.
4288 When value is `item', STRUCTURE will be used as the current list
4289 structure.
4291 GRANULARITY determines the depth of the recursion. See
4292 `org-element-parse-buffer' for more information.
4294 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4295 elements.
4297 Elements are accumulated into ACC."
4300 ;; Visible only: skip invisible parts at the beginning of the
4301 ;; element.
4304 ;; When parsing only headlines, skip any text before first one.
4307 ;; Main loop start.
4309 ;; Find current element's type and parse it accordingly to
4310 ;; its category.
4312 end granularity special structure))
4316 ;; Visible only: skip invisible parts between siblings.
4319 ;; Fill ELEMENT contents by side-effect.
4321 ;; If element has no contents, don't modify it.
4323 ;; Greater element: parse it between `contents-begin' and
4324 ;; `contents-end'. Make sure GRANULARITY allows the
4325 ;; recursion, or ELEMENT is a headline, in which case going
4326 ;; inside is mandatory, in order to get sub-level headings.
4334 ;; Possibly switch to a special mode.
4344 granularity visible-only element))
4345 ;; ELEMENT has contents. Parse objects inside, if
4346 ;; GRANULARITY allows it.
4352 ;; Return result.
4353 acc))
4356 "Parse objects between BEG and END and return recursive structure.
4358 Objects are accumulated in ACC.
4360 RESTRICTION is a list of object successors which are allowed in
4361 the current object."
4370 restriction candidates)))
4377 ;; 1. Text before any object. Untabify it.
4382 acc
4386 ;; 2. Object...
4389 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4390 ;; a recursive type.
4398 ;; 3. Text after last object. Untabify it.
4402 acc
4406 ;; Result.
4407 acc))))
4410 "Return an alist of candidates for the next object.
4412 RESTRICTION is a list of object types, as symbols. Only
4413 candidates with such types are looked after.
4415 OBJECTS is the previous candidates alist. If it is set to
4416 `initial', no search has been done before, and all symbols in
4417 RESTRICTION should be looked after.
4419 Return value is an alist whose CAR is the object type and CDR its
4420 beginning position."
4422 nil
4424 ;; When searching for the first time, look for every successor
4425 ;; allowed in RESTRICTION.
4429 restriction)
4430 ;; Focus on objects returned during last search. Keep those
4431 ;; still after point. Search again objects before it.
4437 type)))
4440 objects))))
4443 \f
4444 ;;; Towards A Bijective Process
4445 ;;
4446 ;; The parse tree obtained with `org-element-parse-buffer' is really
4447 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4448 ;; interpreted and expanded into a string with canonical Org syntax.
4449 ;; Hence `org-element-interpret-data'.
4450 ;;
4451 ;; The function relies internally on
4452 ;; `org-element--interpret-affiliated-keywords'.
4454 ;;;###autoload
4456 "Interpret DATA as Org syntax.
4458 DATA is a parse tree, an element, an object or a secondary string
4459 to interpret.
4461 Optional argument PARENT is used for recursive calls. It contains
4462 the element or object containing data, or nil.
4464 Return Org syntax as a string."
4468 ;; Secondary string.
4473 ;; Full Org document.
4478 ;; Plain text: remove `:parent' text property from output.
4480 ;; Element/Object without contents.
4483 data nil))
4484 ;; Element/Object with contents.
4494 ;; Elements directly containing objects must
4495 ;; have their indentation normalized first.
4497 data
4498 ;; When normalizing first paragraph of an
4499 ;; item or a footnote-definition, ignore
4500 ;; first line's indentation.
4507 data
4509 contents)))))))
4511 ;; Build white spaces. If no `:post-blank' property is
4512 ;; specified, assume its value is 0.
4522 "Return ELEMENT's affiliated keywords as Org syntax.
4523 If there is no affiliated keyword, return the empty string."
4533 ": "
4536 value)
4544 ;; All attribute keywords can have multiple lines.
4550 ;; List all ELEMENT's properties matching an attribute line or an
4551 ;; affiliated keyword, but ignore translated keywords since they
4552 ;; cannot belong to the property list.
4559 org-element-keyword-translation-alist)))))
4560 collect prop)
4563 ;; Because interpretation of the parse tree must return the same
4564 ;; number of blank lines between elements and the same number of white
4565 ;; space after objects, some special care must be given to white
4566 ;; spaces.
4567 ;;
4568 ;; The first function, `org-element-normalize-string', ensures any
4569 ;; string different from the empty string will end with a single
4570 ;; newline character.
4571 ;;
4572 ;; The second function, `org-element-normalize-contents', removes
4573 ;; global indentation from the contents of the current element.
4576 "Ensure string S ends with a single newline character.
4578 If S isn't a string return it unchanged. If S is the empty
4579 string, return it. Otherwise, return a new string with a single
4580 newline character at its end."
4588 "Normalize plain text in ELEMENT's contents.
4590 ELEMENT must only contain plain text and objects.
4592 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4593 indentation to compute maximal common indentation.
4595 Return the normalized element that is element with global
4596 indentation removed from its contents. The function assumes that
4597 indentation is not done with TAB characters."
4599 collect-inds ; for byte-compiler
4602 ;; Return list of indentations within BLOB. This is done by
4603 ;; walking recursively BLOB and updating IND-LIST along the
4604 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4605 ;; been seen yet. It is required as this string is the only
4606 ;; one whose indentation doesn't happen after a newline
4607 ;; character.
4615 ;; An indentation of zero means no string will be
4616 ;; modified. Quit the process.
4622 ;; Avoid matching blank or empty lines.
4630 ;; Collect indentation list in ELEMENT. Possibly remove first
4631 ;; value if IGNORE-FIRST is non-nil.
4634 ;; Build ELEMENT back, replacing each string with the same
4635 ;; string minus common indentation.
4640 ;; Return BLOB with all its strings indentation
4641 ;; shortened from MCI white spaces. FIRST-FLAG is
4642 ;; non-nil when the first string hasn't been seen
4643 ;; yet.
4657 org-element-recursive-objects)
4661 blob))))
4665 \f
4666 ;;; The Toolbox
4667 ;;
4668 ;; The first move is to implement a way to obtain the smallest element
4669 ;; containing point. This is the job of `org-element-at-point'. It
4670 ;; basically jumps back to the beginning of section containing point
4671 ;; and moves, element after element, with
4672 ;; `org-element--current-element' until the container is found. Note:
4673 ;; When using `org-element-at-point', secondary values are never
4674 ;; parsed since the function focuses on elements, not on objects.
4675 ;;
4676 ;; At a deeper level, `org-element-context' lists all elements and
4677 ;; objects containing point.
4678 ;;
4679 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4680 ;; internally by navigation and manipulation tools.
4682 ;;;###autoload
4684 "Determine closest element around point.
4686 Return value is a list like (TYPE PROPS) where TYPE is the type
4687 of the element and PROPS a plist of properties associated to the
4688 element.
4690 Possible types are defined in `org-element-all-elements'.
4691 Properties depend on element or object type, but always include
4692 `:begin', `:end', `:parent' and `:post-blank' properties.
4694 As a special case, if point is at the very beginning of a list or
4695 sub-list, returned element will be that list instead of the first
4696 item. In the same way, if point is at the beginning of the first
4697 row of a table, returned element will be the table instead of the
4698 first row.
4700 If optional argument KEEP-TRAIL is non-nil, the function returns
4701 a list of elements leading to element at point. The list's CAR
4702 is always the element at point. The following positions contain
4703 element's siblings, then parents, siblings of parents, until the
4704 first element of current section."
4706 ;; If at a headline, parse it. It is the sole element that
4707 ;; doesn't require to know about context. Be sure to disallow
4708 ;; secondary string parsing, though.
4714 ;; Otherwise move at the beginning of the section containing
4715 ;; point.
4720 element type special-flag trail struct prevs parent)
4723 ;; In empty lines at buffer's beginning, return nil.
4732 ;; In blank lines just after the headline, point still
4733 ;; belongs to the headline.
4742 ;; Parse successively each element, skipping those ending
4743 ;; before original position.
4751 ;; 1. Skip any element ending before point. Also skip
4752 ;; element ending at point when we're sure that another
4753 ;; element has started.
4758 ;; 2. An element containing point is always the element at
4759 ;; point.
4762 ;; 3. At any other greater element type, if point is
4763 ;; within contents, move into it.
4768 ;; Create an anchor for tables and plain lists:
4769 ;; when point is at the very beginning of these
4770 ;; elements, ignoring affiliated keywords,
4771 ;; target them instead of their contents.
4773 ;; When point is at contents end, do not move
4774 ;; into elements with an explicit ending, but
4775 ;; return that element instead.
4779 drawer dynamic-block inlinetask
4780 property-drawer quote-block
4781 special-block))
4782 ;; Corner case: if a list ends at the
4783 ;; end of a buffer without a final new
4784 ;; line, return last element in last
4785 ;; item instead.
4803 ;;;###autoload
4805 "Return closest element or object around point.
4807 Return value is a list like (TYPE PROPS) where TYPE is the type
4808 of the element or object and PROPS a plist of properties
4809 associated to it.
4811 Possible types are defined in `org-element-all-elements' and
4812 `org-element-all-objects'. Properties depend on element or
4813 object type, but always include `:begin', `:end', `:parent' and
4814 `:post-blank'.
4816 Optional argument ELEMENT, when non-nil, is the closest element
4817 containing point, as returned by `org-element-at-point'.
4818 Providing it allows for quicker computation."
4824 context)
4825 ;; Check if point is inside an element containing objects or at
4826 ;; a secondary string. In that case, narrow buffer to the
4827 ;; containing area. Otherwise, return ELEMENT.
4829 ;; At a parsed affiliated keyword, check if we're inside main
4830 ;; or dual value.
4845 ;; Also change type to retrieve correct restrictions.
4847 ;; At an item, objects can only be located within tag, if any.
4857 ;; At an headline or inlinetask, objects are located within
4858 ;; their title.
4865 ;; At a paragraph, a table-row or a verse block, objects are
4866 ;; located within their contents.
4870 ;; CBEG is nil for table rules.
4874 ;; At a parsed keyword, objects are located within value.
4877 org-element-document-properties))
4892 restriction candidates))
4894 candidates)))
4895 ;; If ORIGIN is before next object in element, there's
4896 ;; no point in looking further.
4906 ;; ORIGIN is after OBJECT, so skip it.
4908 ;; ORIGIN is within a non-recursive object or at
4909 ;; an object boundaries: Return that object.
4913 ;; Otherwise, move within current object and
4914 ;; restrict search to the end of its contents.
4921 parent))))))
4924 "Non-nil when elements ELEM-A and ELEM-B are nested."
4933 "Swap elements ELEM-A and ELEM-B.
4934 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4935 end of ELEM-A."
4937 ;; There are two special cases when an element doesn't start at bol:
4938 ;; the first paragraph in an item or in a footnote definition.
4940 ;; Only a paragraph without any affiliated keyword can be moved at
4941 ;; ELEM-A position in such a situation. Note that the case of
4942 ;; a footnote definition is impossible: it cannot contain two
4943 ;; paragraphs in a row because it cannot contain a blank line.
4949 ;; In a special situation, ELEM-A will have no indentation. We'll
4950 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4964 ;; Store overlays responsible for visibility status. We
4965 ;; also need to store their boundaries as they will be
4966 ;; removed from buffer.
4973 ;; Get contents.
4981 ;; Restore ex ELEM-A overlays.
4990 ;; Restore ex ELEM-B overlays.
4999 ;; Local variables:
5000 ;; generated-autoload-file: "org-loaddefs.el"
5001 ;; End:
5003 ;;; org-element.el ends here