| blob | 254af3c6975b286bbf88992d000442a06d33c94c |
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', `:value', `:post-blank' and
1496 `:post-affiliated' as keywords."
1511 :end end
1512 :value value
1518 "Interpret BABEL-CALL element as Org syntax.
1519 CONTENTS is nil."
1523 ;;;; Clock
1526 "Parse a clock.
1528 LIMIT bounds the search.
1530 Return a list whose CAR is `clock' and CDR is a plist containing
1531 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1532 as keywords."
1552 :value value
1553 :duration duration
1554 :begin begin
1555 :end end
1559 "Interpret CLOCK element as Org syntax.
1560 CONTENTS is nil."
1568 "%2s:%02s"
1572 ;;;; Comment
1575 "Parse a comment.
1577 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1578 the buffer position at the beginning of the first affiliated
1579 keyword and CDR is a plist of affiliated keywords along with
1580 their value.
1582 Return a list whose CAR is `comment' and CDR is a plist
1583 containing `:begin', `:end', `:value', `:post-blank',
1584 `:post-affiliated' keywords.
1586 Assume point is at comment beginning."
1595 ;; Get comments ending.
1598 ;; Accumulate lines without leading hash and first
1599 ;; whitespace.
1614 :end end
1615 :value value
1621 "Interpret COMMENT element as Org syntax.
1622 CONTENTS is nil."
1626 ;;;; Comment Block
1629 "Parse an export block.
1631 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1632 the buffer position at the beginning of the first affiliated
1633 keyword and CDR is a plist of affiliated keywords along with
1634 their value.
1636 Return a list whose CAR is `comment-block' and CDR is a plist
1637 containing `:begin', `:end', `:value', `:post-blank' and
1638 `:post-affiliated' keywords.
1640 Assume point is at comment block beginning."
1644 ;; Incomplete block: parse it as a paragraph.
1658 contents-begin contents-end)))
1662 :end end
1663 :value value
1669 "Interpret COMMENT-BLOCK element as Org syntax.
1670 CONTENTS is nil."
1675 ;;;; Diary Sexp
1678 "Parse a diary sexp.
1680 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1681 the buffer position at the beginning of the first affiliated
1682 keyword and CDR is a plist of affiliated keywords along with
1683 their value.
1685 Return a list whose CAR is `diary-sexp' and CDR is a plist
1686 containing `:begin', `:end', `:value', `:post-blank' and
1687 `:post-affiliated' keywords."
1700 :begin begin
1701 :end end
1707 "Interpret DIARY-SEXP as Org syntax.
1708 CONTENTS is nil."
1712 ;;;; Example Block
1715 "Parse an example block.
1717 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1718 the buffer position at the beginning of the first affiliated
1719 keyword and CDR is a plist of affiliated keywords along with
1720 their value.
1722 Return a list whose CAR is `example-block' and CDR is a plist
1723 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1724 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1725 `:value', `:post-blank' and `:post-affiliated' keywords."
1729 ;; Incomplete block: parse it as a paragraph.
1737 ;; Switches analysis
1744 ;; Should labels be retained in (or stripped from) example
1745 ;; blocks?
1750 ;; What should code-references use - labels or
1751 ;; line-numbers?
1760 ;; Standard block parsing.
1768 contents-begin contents-end))
1769 block-ind))
1779 :end end
1780 :value value
1781 :switches switches
1782 :number-lines number-lines
1783 :preserve-indent preserve-indent
1784 :retain-labels retain-labels
1785 :use-labels use-labels
1786 :label-fmt label-fmt
1792 "Interpret EXAMPLE-BLOCK element as Org syntax.
1793 CONTENTS is nil."
1800 value
1805 ;;;; Export Block
1808 "Parse an export block.
1810 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1811 the buffer position at the beginning of the first affiliated
1812 keyword and CDR is a plist of affiliated keywords along with
1813 their value.
1815 Return a list whose CAR is `export-block' and CDR is a plist
1816 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1817 `:post-affiliated' keywords.
1819 Assume point is at export-block beginning."
1826 ;; Incomplete block: parse it as a paragraph.
1840 contents-end)))
1844 :end end
1845 :type type
1846 :value value
1852 "Interpret EXPORT-BLOCK element as Org syntax.
1853 CONTENTS is nil."
1860 ;;;; Fixed-width
1863 "Parse a fixed-width section.
1865 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1866 the buffer position at the beginning of the first affiliated
1867 keyword and CDR is a plist of affiliated keywords along with
1868 their value.
1870 Return a list whose CAR is `fixed-width' and CDR is a plist
1871 containing `:begin', `:end', `:value', `:post-blank' and
1872 `:post-affiliated' keywords.
1874 Assume point is at the beginning of the fixed-width area."
1878 value
1883 ;; Accumulate text without starting colons.
1897 :end end
1898 :value value
1904 "Interpret FIXED-WIDTH element as Org syntax.
1905 CONTENTS is nil."
1913 ;;;; Horizontal Rule
1916 "Parse an horizontal rule.
1918 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1919 the buffer position at the beginning of the first affiliated
1920 keyword and CDR is a plist of affiliated keywords along with
1921 their value.
1923 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1924 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1925 keywords."
1936 :end end
1942 "Interpret HORIZONTAL-RULE element as Org syntax.
1943 CONTENTS is nil."
1947 ;;;; Keyword
1950 "Parse a keyword at point.
1952 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1953 the buffer position at the beginning of the first affiliated
1954 keyword and CDR is a plist of affiliated keywords along with
1955 their value.
1957 Return a list whose CAR is `keyword' and CDR is a plist
1958 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1959 `:post-affiliated' keywords."
1974 :value value
1975 :begin begin
1976 :end end
1982 "Interpret KEYWORD element as Org syntax.
1983 CONTENTS is nil."
1989 ;;;; Latex Environment
1992 "Parse a LaTeX environment.
1994 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1995 the buffer position at the beginning of the first affiliated
1996 keyword and CDR is a plist of affiliated keywords along with
1997 their value.
1999 Return a list whose CAR is `latex-environment' and CDR is a plist
2000 containing `:begin', `:end', `:value', `:post-blank' and
2001 `:post-affiliated' keywords.
2003 Assume point is at the beginning of the latex environment."
2010 limit t))
2011 ;; Incomplete latex environment: parse it as a paragraph.
2022 :end end
2023 :value value
2029 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2030 CONTENTS is nil."
2034 ;;;; Node Property
2037 "Parse a node-property at point.
2039 LIMIT bounds the search.
2041 Return a list whose CAR is `node-property' and CDR is a plist
2042 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2043 keywords."
2055 :value value
2056 :begin begin
2057 :end end
2061 "Interpret NODE-PROPERTY element as Org syntax.
2062 CONTENTS is nil."
2068 ;;;; Paragraph
2071 "Parse a paragraph.
2073 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2074 the buffer position at the beginning of the first affiliated
2075 keyword and CDR is a plist of affiliated keywords along with
2076 their value.
2078 Return a list whose CAR is `paragraph' and CDR is a plist
2079 containing `:begin', `:end', `:contents-begin' and
2080 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2082 Assume point is at the beginning of the paragraph."
2091 limit
2092 ;; A matching `org-element-paragraph-separate' is not
2093 ;; necessarily the end of the paragraph. In
2094 ;; particular, lines starting with # or : as a first
2095 ;; non-space character are ambiguous. We have check
2096 ;; if they are valid Org syntax (i.e. not an
2097 ;; incomplete keyword).
2101 ;; There's no ambiguity for other symbols or
2102 ;; empty lines: stop here.
2104 ;; Stop at valid fixed-width areas.
2106 ;; Stop at drawers.
2111 ;; Stop at valid comments.
2113 ;; Stop at valid dynamic blocks.
2118 ;; Stop at valid blocks.
2125 limit t)))
2126 ;; Stop at valid latex environments.
2134 limit t)))
2135 ;; Stop at valid keywords.
2137 ;; Skip everything else.
2155 :end end
2156 :contents-begin contents-begin
2157 :contents-end contents-end
2163 "Interpret PARAGRAPH element as Org syntax.
2164 CONTENTS is the contents of the element."
2165 contents)
2168 ;;;; Planning
2171 "Parse a planning.
2173 LIMIT bounds the search.
2175 Return a list whose CAR is `planning' and CDR is a plist
2176 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2177 and `:post-blank' keywords."
2187 closed deadline scheduled)
2199 :deadline deadline
2200 :scheduled scheduled
2201 :begin begin
2202 :end end
2206 "Interpret PLANNING element as Org syntax.
2207 CONTENTS is nil."
2209 'identity
2226 ;;;; Quote Section
2229 "Parse a quote section.
2231 LIMIT bounds the search.
2233 Return a list whose CAR is `quote-section' and CDR is a plist
2234 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2236 Assume point is at beginning of the section."
2247 :end end
2248 :value value
2252 "Interpret QUOTE-SECTION element as Org syntax.
2253 CONTENTS is nil."
2257 ;;;; Src Block
2260 "Parse a src block.
2262 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2263 the buffer position at the beginning of the first affiliated
2264 keyword and CDR is a plist of affiliated keywords along with
2265 their value.
2267 Return a list whose CAR is `src-block' and CDR is a plist
2268 containing `:language', `:switches', `:parameters', `:begin',
2269 `:end', `:number-lines', `:retain-labels', `:use-labels',
2270 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2271 `:post-affiliated' keywords.
2273 Assume point is at the beginning of the block."
2276 limit t)))
2277 ;; Incomplete block: parse it as a paragraph.
2283 ;; Get language as a string.
2292 ;; Get switches.
2294 ;; Get parameters.
2296 ;; Switches analysis
2307 ;; Should labels be retained in (or stripped from)
2308 ;; src blocks?
2313 ;; What should code-references use - labels or
2314 ;; line-numbers?
2319 ;; Indentation.
2321 ;; Retrieve code.
2326 block-ind))
2330 ;; Get position after ending blank lines.
2341 :begin begin
2342 :end end
2343 :number-lines number-lines
2344 :preserve-indent preserve-indent
2345 :retain-labels retain-labels
2346 :use-labels use-labels
2347 :label-fmt label-fmt
2348 :value value
2354 "Interpret SRC-BLOCK element as Org syntax.
2355 CONTENTS is nil."
2364 val)
2378 ;;;; Table
2381 "Parse a table at point.
2383 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2384 the buffer position at the beginning of the first affiliated
2385 keyword and CDR is a plist of affiliated keywords along with
2386 their value.
2388 Return a list whose CAR is `table' and CDR is a plist containing
2389 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2390 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2391 keywords.
2393 Assume point is at the beginning of the table."
2407 acc))
2415 :end end
2416 :type type
2417 :tblfm tblfm
2418 ;; Only `org' tables have contents. `table.el' tables
2419 ;; use a `:value' property to store raw table as
2420 ;; a string.
2425 table-begin table-end))
2431 "Interpret TABLE element as Org syntax.
2432 CONTENTS is nil."
2443 ;;;; Table Row
2446 "Parse table row at point.
2448 LIMIT bounds the search.
2450 Return a list whose CAR is `table-row' and CDR is a plist
2451 containing `:begin', `:end', `:contents-begin', `:contents-end',
2452 `:type' and `:post-blank' keywords."
2456 ;; A table rule has no contents. In that case, ensure
2457 ;; CONTENTS-BEGIN matches CONTENTS-END.
2469 :begin begin
2470 :end end
2471 :contents-begin contents-begin
2472 :contents-end contents-end
2476 "Interpret TABLE-ROW element as Org syntax.
2477 CONTENTS is the contents of the table row."
2482 ;;;; Verse Block
2485 "Parse a verse block.
2487 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2488 the buffer position at the beginning of the first affiliated
2489 keyword and CDR is a plist of affiliated keywords along with
2490 their value.
2492 Return a list whose CAR is `verse-block' and CDR is a plist
2493 containing `:begin', `:end', `:contents-begin', `:contents-end',
2494 `:post-blank' and `:post-affiliated' keywords.
2496 Assume point is at beginning of the block."
2500 ;; Incomplete block: parse it as a paragraph.
2516 :end end
2517 :contents-begin contents-begin
2518 :contents-end contents-end
2524 "Interpret VERSE-BLOCK element as Org syntax.
2525 CONTENTS is verse block contents."
2529 \f
2530 ;;; Objects
2531 ;;
2532 ;; Unlike to elements, interstices can be found between objects.
2533 ;; That's why, along with the parser, successor functions are provided
2534 ;; for each object. Some objects share the same successor (i.e. `code'
2535 ;; and `verbatim' objects).
2536 ;;
2537 ;; A successor must accept a single argument bounding the search. It
2538 ;; will return either a cons cell whose CAR is the object's type, as
2539 ;; a symbol, and CDR the position of its next occurrence, or nil.
2540 ;;
2541 ;; Successors follow the naming convention:
2542 ;; org-element-NAME-successor, where NAME is the name of the
2543 ;; successor, as defined in `org-element-all-successors'.
2544 ;;
2545 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2546 ;; object types they can contain will be specified in
2547 ;; `org-element-object-restrictions'.
2548 ;;
2549 ;; Adding a new type of object is simple. Implement a successor,
2550 ;; a parser, and an interpreter for it, all following the naming
2551 ;; convention. Register type in `org-element-all-objects' and
2552 ;; successor in `org-element-all-successors'. Maybe tweak
2553 ;; restrictions about it, and that's it.
2556 ;;;; Bold
2559 "Parse bold object at point.
2561 Return a list whose CAR is `bold' and CDR is a plist with
2562 `:begin', `:end', `:contents-begin' and `:contents-end' and
2563 `:post-blank' keywords.
2565 Assume point is at the first star marker."
2577 :end end
2578 :contents-begin contents-begin
2579 :contents-end contents-end
2583 "Interpret BOLD object as Org syntax.
2584 CONTENTS is the contents of the object."
2588 "Search for the next text-markup object.
2590 Return value is a cons cell whose CAR is a symbol among `bold',
2591 `italic', `underline', `strike-through', `code' and `verbatim'
2592 and CDR is beginning position."
2608 ;;;; Code
2611 "Parse code object at point.
2613 Return a list whose CAR is `code' and CDR is a plist with
2614 `:value', `:begin', `:end' and `:post-blank' keywords.
2616 Assume point is at the first tilde marker."
2627 :begin begin
2628 :end end
2632 "Interpret CODE object as Org syntax.
2633 CONTENTS is nil."
2637 ;;;; Entity
2640 "Parse entity at point.
2642 Return a list whose CAR is `entity' and CDR a plist with
2643 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2644 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2645 keywords.
2647 Assume point is at the beginning of the entity."
2649 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2665 :begin begin
2666 :end end
2667 :use-brackets-p bracketsp
2671 "Interpret ENTITY object as Org syntax.
2672 CONTENTS is nil."
2678 "Search for the next latex-fragment or entity object.
2680 Return value is a cons cell whose CAR is `entity' or
2681 `latex-fragment' and CDR is beginning position."
2685 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2692 ;; Determine if it's a real entity or a LaTeX command.
2695 ;; No entity nor command: point is at a LaTeX fragment.
2696 ;; Determine its type to get the correct beginning position.
2705 ;;;; Export Snippet
2708 "Parse export snippet at point.
2710 Return a list whose CAR is `export-snippet' and CDR a plist with
2711 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2712 keywords.
2714 Assume point is at the beginning of the snippet."
2726 :value value
2727 :begin begin
2728 :end end
2732 "Interpret EXPORT-SNIPPET object as Org syntax.
2733 CONTENTS is nil."
2739 "Search for the next export-snippet object.
2741 Return value is a cons cell whose CAR is `export-snippet' and CDR
2742 its beginning position."
2751 ;;;; Footnote Reference
2754 "Parse footnote reference at point.
2756 Return a list whose CAR is `footnote-reference' and CDR a plist
2757 with `:label', `:type', `:inline-definition', `:begin', `:end'
2758 and `:post-blank' as keywords."
2780 :type type
2781 :begin begin
2782 :end end
2785 footnote-reference :inline-definition
2790 footnote-reference))))))
2793 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2794 CONTENTS is nil."
2804 "Search for the next footnote-reference object.
2806 Return value is a cons cell whose CAR is `footnote-reference' and
2807 CDR is beginning position."
2821 ;;;; Inline Babel Call
2824 "Parse inline babel call at point.
2826 Return a list whose CAR is `inline-babel-call' and CDR a plist
2827 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2829 Assume point is at the beginning of the babel call."
2841 :end end
2842 :value value
2846 "Interpret INLINE-BABEL-CALL object as Org syntax.
2847 CONTENTS is nil."
2851 "Search for the next inline-babel-call object.
2853 Return value is a cons cell whose CAR is `inline-babel-call' and
2854 CDR is beginning position."
2856 ;; Use a simplified version of
2857 ;; `org-babel-inline-lob-one-liner-regexp'.
2860 nil t)
2864 ;;;; Inline Src Block
2867 "Parse inline source block at point.
2869 Return a list whose CAR is `inline-src-block' and CDR a plist
2870 with `:begin', `:end', `:language', `:value', `:parameters' and
2871 `:post-blank' as keywords.
2873 Assume point is at the beginning of the inline src block."
2886 :value value
2887 :parameters parameters
2888 :begin begin
2889 :end end
2893 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2894 CONTENTS is nil."
2899 language
2901 body)))
2904 "Search for the next inline-babel-call element.
2906 Return value is a cons cell whose CAR is `inline-babel-call' and
2907 CDR is beginning position."
2913 ;;;; Italic
2916 "Parse italic object at point.
2918 Return a list whose CAR is `italic' and CDR is a plist with
2919 `:begin', `:end', `:contents-begin' and `:contents-end' and
2920 `:post-blank' keywords.
2922 Assume point is at the first slash marker."
2934 :end end
2935 :contents-begin contents-begin
2936 :contents-end contents-end
2940 "Interpret ITALIC object as Org syntax.
2941 CONTENTS is the contents of the object."
2945 ;;;; Latex Fragment
2948 "Parse LaTeX fragment at point.
2950 Return a list whose CAR is `latex-fragment' and CDR a plist with
2951 `:value', `:begin', `:end', and `:post-blank' as keywords.
2953 Assume point is at the beginning of the LaTeX fragment."
2966 ;; None found: it's a macro.
2975 :begin begin
2976 :end end
2980 "Interpret LATEX-FRAGMENT object as Org syntax.
2981 CONTENTS is nil."
2984 ;;;; Line Break
2987 "Parse line break at point.
2989 Return a list whose CAR is `line-break', and CDR a plist with
2990 `:begin', `:end' and `:post-blank' keywords.
2992 Assume point is at the beginning of the line break."
2999 "Interpret LINE-BREAK object as Org syntax.
3000 CONTENTS is nil."
3004 "Search for the next line-break object.
3006 Return value is a cons cell whose CAR is `line-break' and CDR is
3007 beginning position."
3011 ;; A line break can only happen on a non-empty line.
3016 ;;;; Link
3019 "Parse link at point.
3021 Return a list whose CAR is `link' and CDR a plist with `:type',
3022 `:path', `:raw-link', `:application', `:search-option', `:begin',
3023 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3024 keywords.
3026 Assume point is at the beginning of the link."
3029 end contents-begin contents-end link-end post-blank path type
3030 raw-link link search-option application)
3032 ;; Type 1: Text targeted from a radio target.
3037 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3042 ;; RAW-LINK is the original link. Expand any
3043 ;; abbreviation in it.
3047 ;; Determine TYPE of link and set PATH accordingly.
3049 ;; File type.
3053 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3056 ;; Id type: PATH is the id.
3059 ;; Code-ref type: PATH is the name of the reference.
3062 ;; Custom-id type: PATH is the name of the custom id.
3065 ;; Fuzzy type: Internal link either matches a target, an
3066 ;; headline name or nothing. PATH is the target or
3067 ;; headline's name.
3069 ;; Type 3: Plain link, i.e. http://orgmode.org
3075 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3082 ;; In any case, deduce end point after trailing white space from
3083 ;; LINK-END variable.
3086 ;; Extract search option and opening application out of
3087 ;; "file"-type links.
3089 ;; Application.
3094 ;; Extract search option from PATH.
3098 ;; Make sure TYPE always reports "file".
3102 :path path
3104 :application application
3105 :search-option search-option
3106 :begin begin
3107 :end end
3108 :contents-begin contents-begin
3109 :contents-end contents-end
3113 "Interpret LINK object as Org syntax.
3114 CONTENTS is the contents of the object, or nil."
3119 raw-link
3123 "Search for the next link object.
3125 Return value is a cons cell whose CAR is `link' and CDR is
3126 beginning position."
3135 "Search for the next plain link object.
3137 Return value is a cons cell whose CAR is `link' and CDR is
3138 beginning position."
3143 ;;;; Macro
3146 "Parse macro at point.
3148 Return a list whose CAR is `macro' and CDR a plist with `:key',
3149 `:args', `:begin', `:end', `:value' and `:post-blank' as
3150 keywords.
3152 Assume point is at the macro."
3163 ;; Do not use `org-split-string' since empty
3164 ;; strings are meaningful here.
3172 args nil t)
3176 :value value
3177 :args args
3178 :begin begin
3179 :end end
3183 "Interpret MACRO object as Org syntax.
3184 CONTENTS is nil."
3188 "Search for the next macro object.
3190 Return value is cons cell whose CAR is `macro' and CDR is
3191 beginning position."
3195 nil t)
3199 ;;;; Radio-target
3202 "Parse radio target at point.
3204 Return a list whose CAR is `radio-target' and CDR a plist with
3205 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3206 and `:post-blank' as keywords.
3208 Assume point is at the radio target."
3220 :end end
3221 :contents-begin contents-begin
3222 :contents-end contents-end
3223 :post-blank post-blank
3227 "Interpret TARGET object as Org syntax.
3228 CONTENTS is the contents of the object."
3232 "Search for the next radio-target object.
3234 Return value is a cons cell whose CAR is `radio-target' and CDR
3235 is beginning position."
3241 ;;;; Statistics Cookie
3244 "Parse statistics cookie at point.
3246 Return a list whose CAR is `statistics-cookie', and CDR a plist
3247 with `:begin', `:end', `:value' and `:post-blank' keywords.
3249 Assume point is at the beginning of the statistics-cookie."
3260 :end end
3261 :value value
3265 "Interpret STATISTICS-COOKIE object as Org syntax.
3266 CONTENTS is nil."
3270 "Search for the next statistics cookie object.
3272 Return value is a cons cell whose CAR is `statistics-cookie' and
3273 CDR is beginning position."
3279 ;;;; Strike-Through
3282 "Parse strike-through object at point.
3284 Return a list whose CAR is `strike-through' and CDR is a plist
3285 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3286 `:post-blank' keywords.
3288 Assume point is at the first plus sign marker."
3300 :end end
3301 :contents-begin contents-begin
3302 :contents-end contents-end
3306 "Interpret STRIKE-THROUGH object as Org syntax.
3307 CONTENTS is the contents of the object."
3311 ;;;; Subscript
3314 "Parse subscript at point.
3316 Return a list whose CAR is `subscript' and CDR a plist with
3317 `:begin', `:end', `:contents-begin', `:contents-end',
3318 `:use-brackets-p' and `:post-blank' as keywords.
3320 Assume point is at the underscore."
3324 t
3335 :end end
3336 :use-brackets-p bracketsp
3337 :contents-begin contents-begin
3338 :contents-end contents-end
3342 "Interpret SUBSCRIPT object as Org syntax.
3343 CONTENTS is the contents of the object."
3346 contents))
3349 "Search for the next sub/superscript object.
3351 Return value is a cons cell whose CAR is either `subscript' or
3352 `superscript' and CDR is beginning position."
3360 ;;;; Superscript
3363 "Parse superscript at point.
3365 Return a list whose CAR is `superscript' and CDR a plist with
3366 `:begin', `:end', `:contents-begin', `:contents-end',
3367 `:use-brackets-p' and `:post-blank' as keywords.
3369 Assume point is at the caret."
3383 :end end
3384 :use-brackets-p bracketsp
3385 :contents-begin contents-begin
3386 :contents-end contents-end
3390 "Interpret SUPERSCRIPT object as Org syntax.
3391 CONTENTS is the contents of the object."
3394 contents))
3397 ;;;; Table Cell
3400 "Parse table cell at point.
3402 Return a list whose CAR is `table-cell' and CDR is a plist
3403 containing `:begin', `:end', `:contents-begin', `:contents-end'
3404 and `:post-blank' keywords."
3412 :end end
3413 :contents-begin contents-begin
3414 :contents-end contents-end
3418 "Interpret TABLE-CELL element as Org syntax.
3419 CONTENTS is the contents of the cell, or nil."
3423 "Search for the next table-cell object.
3425 Return value is a cons cell whose CAR is `table-cell' and CDR is
3426 beginning position."
3430 ;;;; Target
3433 "Parse target at point.
3435 Return a list whose CAR is `target' and CDR a plist with
3436 `:begin', `:end', `:value' and `:post-blank' as keywords.
3438 Assume point is at the target."
3448 :end end
3449 :value value
3453 "Interpret TARGET object as Org syntax.
3454 CONTENTS is nil."
3458 "Search for the next target object.
3460 Return value is a cons cell whose CAR is `target' and CDR is
3461 beginning position."
3467 ;;;; Timestamp
3470 "Parse time stamp at point.
3472 Return a list whose CAR is `timestamp', and CDR a plist with
3473 `:type', `:raw-value', `:year-start', `:month-start',
3474 `:day-start', `:hour-start', `:minute-start', `:year-end',
3475 `:month-end', `:day-end', `:hour-end', `:minute-end',
3476 `:repeater-type', `:repeater-value', `:repeater-unit',
3477 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3478 `:end', `:value' and `:post-blank' keywords.
3480 Assume point is at the beginning of the timestamp."
3498 date-start)
3509 raw-value)
3511 :repeater-type
3517 :repeater-unit
3526 :warning-unit
3529 year-start month-start day-start hour-start minute-start year-end
3530 month-end day-end hour-end minute-end)
3531 ;; Parse date-start.
3539 ;; Compute date-end. It can be provided directly in time-stamp,
3540 ;; or extracted from time range. Otherwise, it defaults to the
3541 ;; same values as date-start.
3551 :raw-value raw-value
3552 :year-start year-start
3553 :month-start month-start
3554 :day-start day-start
3555 :hour-start hour-start
3556 :minute-start minute-start
3557 :year-end year-end
3558 :month-end month-end
3559 :day-end day-end
3560 :hour-end hour-end
3561 :minute-end minute-end
3562 :begin begin
3563 :end end
3565 repeater-props
3566 warning-props)))))
3569 "Interpret TIMESTAMP object as Org syntax.
3570 CONTENTS is nil."
3571 ;; Use `:raw-value' if specified.
3573 ;; Otherwise, build timestamp string.
3592 ;; Build an Org timestamp string from TIME. ACTIVEP is
3593 ;; non-nil when time stamp is active. If WITH-TIME-P is
3594 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3595 ;; specify a time range in the timestamp. REPEAT-STRING
3596 ;; is the repeater string, if any.
3600 org-time-stamp-formats)
3601 time)))
3607 nil nil ts)))
3612 " "
3613 s
3615 ;; Return value.
3616 ts)))
3628 build-ts-string
3647 0
3655 "--"
3667 "Search for the next timestamp object.
3669 Return value is a cons cell whose CAR is `timestamp' and CDR is
3670 beginning position."
3678 nil t)
3682 ;;;; Underline
3685 "Parse underline object at point.
3687 Return a list whose CAR is `underline' and CDR is a plist with
3688 `:begin', `:end', `:contents-begin' and `:contents-end' and
3689 `:post-blank' keywords.
3691 Assume point is at the first underscore marker."
3703 :end end
3704 :contents-begin contents-begin
3705 :contents-end contents-end
3709 "Interpret UNDERLINE object as Org syntax.
3710 CONTENTS is the contents of the object."
3714 ;;;; Verbatim
3717 "Parse verbatim object at point.
3719 Return a list whose CAR is `verbatim' and CDR is a plist with
3720 `:value', `:begin', `:end' and `:post-blank' keywords.
3722 Assume point is at the first equal sign marker."
3733 :begin begin
3734 :end end
3738 "Interpret VERBATIM object as Org syntax.
3739 CONTENTS is nil."
3743 \f
3744 ;;; Parsing Element Starting At Point
3745 ;;
3746 ;; `org-element--current-element' is the core function of this section.
3747 ;; It returns the Lisp representation of the element starting at
3748 ;; point.
3749 ;;
3750 ;; `org-element--current-element' makes use of special modes. They
3751 ;; are activated for fixed element chaining (i.e. `plain-list' >
3752 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3753 ;; `section'). Special modes are: `first-section', `item',
3754 ;; `node-property', `quote-section', `section' and `table-row'.
3758 "Parse the element starting at point.
3760 Return value is a list like (TYPE PROPS) where TYPE is the type
3761 of the element and PROPS a plist of properties associated to the
3762 element.
3764 Possible types are defined in `org-element-all-elements'.
3766 LIMIT bounds the search.
3768 Optional argument GRANULARITY determines the depth of the
3769 recursion. Allowed values are `headline', `greater-element',
3770 `element', `object' or nil. When it is broader than `object' (or
3771 nil), secondary values will not be parsed, since they only
3772 contain objects.
3774 Optional argument SPECIAL, when non-nil, can be either
3775 `first-section', `item', `node-property', `quote-section',
3776 `section', and `table-row'.
3778 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3779 be computed.
3781 This function assumes point is always at the beginning of the
3782 element it has to parse."
3785 ;; Determine if parsing depth allows for secondary strings
3786 ;; parsing. It only applies to elements referenced in
3787 ;; `org-element-secondary-value-alist'.
3790 ;; Item.
3793 ;; Table Row.
3795 ;; Node Property.
3797 ;; Headline.
3800 ;; Sections (must be checked after headline).
3806 limit)))
3807 ;; When not at bol, point is at the beginning of an item or
3808 ;; a footnote definition: next item is always a paragraph.
3810 ;; Planning and Clock.
3815 ;; Inlinetask.
3818 ;; From there, elements can have affiliated keywords.
3821 ;; Jumping over affiliated keywords put point off-limits.
3822 ;; Parse them as regular keywords.
3826 ;; LaTeX Environment.
3830 ;; Drawer and Property Drawer.
3835 ;; Fixed Width
3838 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3839 ;; Keywords.
3848 org-element-block-name-alist)))
3863 ;; Footnote Definition.
3866 ;; Horizontal Rule.
3869 ;; Diary Sexp.
3872 ;; Table.
3874 ;; List.
3877 limit affiliated
3879 ;; Default element: Paragraph.
3883 ;; Most elements can have affiliated keywords. When looking for an
3884 ;; element beginning, we want to move before them, as they belong to
3885 ;; that element, and, in the meantime, collect information they give
3886 ;; into appropriate properties. Hence the following function.
3889 "Collect affiliated keywords from point down to LIMIT.
3891 Return a list whose CAR is the position at the first of them and
3892 CDR a plist of keywords and values and move point to the
3893 beginning of the first line after them.
3895 As a special case, if element doesn't start at the beginning of
3896 the line (i.e. a paragraph starting an item), CAR is current
3897 position of point and CDR is nil."
3901 ;; RESTRICT is the list of objects allowed in parsed
3902 ;; keywords value.
3904 output)
3907 ;; Apply translation to RAW-KWD. From there, KWD is
3908 ;; the official keyword.
3910 org-element-keyword-translation-alist))
3911 raw-kwd))
3912 ;; Find main value for any keyword.
3918 ;; PARSEDP is non-nil when keyword should have its
3919 ;; value parsed.
3921 ;; If KWD is a dual keyword, find its secondary
3922 ;; value. Maybe parse it.
3929 ;; Attribute a property name to KWD.
3931 ;; Now set final shape for VALUE.
3937 ;; Attributes can always appear on multiple lines.
3940 ;; Eventually store the new value in OUTPUT.
3942 ;; Move to next keyword.
3944 ;; If affiliated keywords are orphaned: move back to first one.
3945 ;; They will be parsed as a paragraph.
3947 ;; Return value.
3951 \f
3952 ;;; The Org Parser
3953 ;;
3954 ;; The two major functions here are `org-element-parse-buffer', which
3955 ;; parses Org syntax inside the current buffer, taking into account
3956 ;; region, narrowing, or even visibility if specified, and
3957 ;; `org-element-parse-secondary-string', which parses objects within
3958 ;; a given string.
3959 ;;
3960 ;; The (almost) almighty `org-element-map' allows to apply a function
3961 ;; on elements or objects matching some type, and accumulate the
3962 ;; resulting values. In an export situation, it also skips unneeded
3963 ;; parts of the parse tree.
3966 "Recursively parse the buffer and return structure.
3967 If narrowing is in effect, only parse the visible part of the
3968 buffer.
3970 Optional argument GRANULARITY determines the depth of the
3971 recursion. It can be set to the following symbols:
3973 `headline' Only parse headlines.
3974 `greater-element' Don't recurse into greater elements excepted
3975 headlines and sections. Thus, elements
3976 parsed are the top-level ones.
3977 `element' Parse everything but objects and plain text.
3978 `object' Parse the complete buffer (default).
3980 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3981 elements.
3983 An element or an objects is represented as a list with the
3984 pattern (TYPE PROPERTIES CONTENTS), where :
3986 TYPE is a symbol describing the element or object. See
3987 `org-element-all-elements' and `org-element-all-objects' for an
3988 exhaustive list of such symbols. One can retrieve it with
3989 `org-element-type' function.
3991 PROPERTIES is the list of attributes attached to the element or
3992 object, as a plist. Although most of them are specific to the
3993 element or object type, all types share `:begin', `:end',
3994 `:post-blank' and `:parent' properties, which respectively
3995 refer to buffer position where the element or object starts,
3996 ends, the number of white spaces or blank lines after it, and
3997 the element or object containing it. Properties values can be
3998 obtained by using `org-element-property' function.
4000 CONTENTS is a list of elements, objects or raw strings
4001 contained in the current element or object, when applicable.
4002 One can access them with `org-element-contents' function.
4004 The Org buffer has `org-data' as type and nil as properties.
4005 `org-element-map' function can be used to find specific elements
4006 or objects within the parse tree.
4008 This function assumes that current major mode is `org-mode'."
4014 ;; Start in `first-section' mode so text before the first
4015 ;; headline belongs to a section.
4019 "Recursively parse objects in STRING and return structure.
4021 RESTRICTION is a symbol limiting the object types that will be
4022 looked after.
4024 Optional argument PARENT, when non-nil, is the element or object
4025 containing the secondary string. It is used to set correctly
4026 `:parent' property within the string."
4027 ;; Copy buffer-local variables listed in
4028 ;; `org-element-object-variables' into temporary buffer. This is
4029 ;; required since object parsing is dependent on these variables.
4033 org-element-object-variables))))
4041 secondary))
4042 secondary))))
4046 "Map a function on selected elements or objects.
4048 DATA is a parse tree, an element, an object, a string, or a list
4049 of such constructs. TYPES is a symbol or list of symbols of
4050 elements or objects types (see `org-element-all-elements' and
4051 `org-element-all-objects' for a complete list of types). FUN is
4052 the function called on the matching element or object. It has to
4053 accept one argument: the element or object itself.
4055 When optional argument INFO is non-nil, it should be a plist
4056 holding export options. In that case, parts of the parse tree
4057 not exportable according to that property list will be skipped.
4059 When optional argument FIRST-MATCH is non-nil, stop at the first
4060 match for which FUN doesn't return nil, and return that value.
4062 Optional argument NO-RECURSION is a symbol or a list of symbols
4063 representing elements or objects types. `org-element-map' won't
4064 enter any recursive element or object whose type belongs to that
4065 list. Though, FUN can still be applied on them.
4067 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4068 apply to matching objects within parsed affiliated keywords (see
4069 `org-element-parsed-keywords').
4071 Nil values returned from FUN do not appear in the results.
4074 Examples:
4075 ---------
4077 Assuming TREE is a variable containing an Org buffer parse tree,
4078 the following example will return a flat list of all `src-block'
4079 and `example-block' elements in it:
4081 \(org-element-map tree '(example-block src-block) 'identity)
4083 The following snippet will find the first headline with a level
4086 \(org-element-map tree 'headline
4087 \(lambda (hl)
4088 \(and (= (org-element-property :level hl) 1)
4090 \(org-element-property :begin hl)))
4091 nil t)
4093 The next example will return a flat list of all `plain-list' type
4094 elements in TREE that are not a sub-list themselves:
4096 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4098 Eventually, this example will return a flat list of all `bold'
4099 type objects containing a `latex-snippet' type object, even
4100 looking into captions:
4102 \(org-element-map tree 'bold
4103 \(lambda (b)
4104 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4105 nil nil nil t)"
4106 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4109 ;; Recursion depth is determined by --CATEGORY.
4116 ;; If one object is found, the function
4117 ;; has to recurse into every object.
4120 ;; If one regular element is found, the
4121 ;; function has to recurse, at least,
4122 ;; into every element it encounters.
4125 types)
4126 category)))
4127 ;; Compute properties for affiliated keywords if necessary.
4132 org-element-affiliated-keywords)))
4133 --acc
4134 --walk-tree
4138 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4139 ;; holding contextual information.
4143 ;; Ignored element in an export context.
4145 ;; List of elements or objects.
4147 ;; Unconditionally enter parse trees.
4151 ;; Check if TYPE is matching among TYPES. If so,
4152 ;; apply FUN to --DATA and accumulate return value
4153 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4159 ;; If --DATA has a secondary string that can contain
4160 ;; objects with their type among TYPES, look into it.
4167 ;; If --DATA has any affiliated keywords and
4168 ;; WITH-AFFILIATED is non-nil, look for objects in
4169 ;; them.
4177 ;; Pay attention to the type of value.
4178 ;; Preserve order for multiple keywords.
4194 --affiliated-alist))
4195 ;; Determine if a recursion into --DATA is possible.
4197 ;; --TYPE is explicitly removed from recursion.
4199 ;; --DATA has no contents.
4201 ;; Looking for greater elements but --DATA is simply
4202 ;; an element or an object.
4205 ;; Looking for elements but --DATA is an object.
4208 ;; In any other case, map contents.
4212 ;; Return value in a proper order.
4216 ;; The following functions are internal parts of the parser.
4217 ;;
4218 ;; The first one, `org-element--parse-elements' acts at the element's
4219 ;; level.
4220 ;;
4221 ;; The second one, `org-element--parse-objects' applies on all objects
4222 ;; of a paragraph or a secondary string. It uses
4223 ;; `org-element--get-next-object-candidates' to optimize the search of
4224 ;; the next object in the buffer.
4225 ;;
4226 ;; More precisely, that function looks for every allowed object type
4227 ;; first. Then, it discards failed searches, keeps further matches,
4228 ;; and searches again types matched behind point, for subsequent
4229 ;; calls. Thus, searching for a given type fails only once, and every
4230 ;; object is searched only once at top level (but sometimes more for
4231 ;; nested types).
4235 "Parse elements between BEG and END positions.
4237 SPECIAL prioritize some elements over the others. It can be set
4238 to `first-section', `quote-section', `section' `item' or
4239 `table-row'.
4241 When value is `item', STRUCTURE will be used as the current list
4242 structure.
4244 GRANULARITY determines the depth of the recursion. See
4245 `org-element-parse-buffer' for more information.
4247 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4248 elements.
4250 Elements are accumulated into ACC."
4253 ;; Visible only: skip invisible parts at the beginning of the
4254 ;; element.
4257 ;; When parsing only headlines, skip any text before first one.
4260 ;; Main loop start.
4262 ;; Find current element's type and parse it accordingly to
4263 ;; its category.
4265 end granularity special structure))
4269 ;; Visible only: skip invisible parts between siblings.
4272 ;; Fill ELEMENT contents by side-effect.
4274 ;; If element has no contents, don't modify it.
4276 ;; Greater element: parse it between `contents-begin' and
4277 ;; `contents-end'. Make sure GRANULARITY allows the
4278 ;; recursion, or ELEMENT is a headline, in which case going
4279 ;; inside is mandatory, in order to get sub-level headings.
4287 ;; Possibly switch to a special mode.
4297 granularity visible-only element))
4298 ;; ELEMENT has contents. Parse objects inside, if
4299 ;; GRANULARITY allows it.
4305 ;; Return result.
4306 acc))
4309 "Parse objects between BEG and END and return recursive structure.
4311 Objects are accumulated in ACC.
4313 RESTRICTION is a list of object successors which are allowed in
4314 the current object."
4323 restriction candidates)))
4330 ;; 1. Text before any object. Untabify it.
4335 acc
4339 ;; 2. Object...
4342 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4343 ;; a recursive type.
4351 ;; 3. Text after last object. Untabify it.
4355 acc
4359 ;; Result.
4360 acc))))
4363 "Return an alist of candidates for the next object.
4365 RESTRICTION is a list of object types, as symbols. Only
4366 candidates with such types are looked after.
4368 OBJECTS is the previous candidates alist. If it is set to
4369 `initial', no search has been done before, and all symbols in
4370 RESTRICTION should be looked after.
4372 Return value is an alist whose CAR is the object type and CDR its
4373 beginning position."
4375 nil
4377 ;; When searching for the first time, look for every successor
4378 ;; allowed in RESTRICTION.
4382 restriction)
4383 ;; Focus on objects returned during last search. Keep those
4384 ;; still after point. Search again objects before it.
4390 type)))
4393 objects))))
4396 \f
4397 ;;; Towards A Bijective Process
4398 ;;
4399 ;; The parse tree obtained with `org-element-parse-buffer' is really
4400 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4401 ;; interpreted and expanded into a string with canonical Org syntax.
4402 ;; Hence `org-element-interpret-data'.
4403 ;;
4404 ;; The function relies internally on
4405 ;; `org-element--interpret-affiliated-keywords'.
4407 ;;;###autoload
4409 "Interpret DATA as Org syntax.
4411 DATA is a parse tree, an element, an object or a secondary string
4412 to interpret.
4414 Optional argument PARENT is used for recursive calls. It contains
4415 the element or object containing data, or nil.
4417 Return Org syntax as a string."
4421 ;; Secondary string.
4426 ;; Full Org document.
4431 ;; Plain text: remove `:parent' text property from output.
4433 ;; Element/Object without contents.
4436 data nil))
4437 ;; Element/Object with contents.
4447 ;; Elements directly containing objects must
4448 ;; have their indentation normalized first.
4450 data
4451 ;; When normalizing first paragraph of an
4452 ;; item or a footnote-definition, ignore
4453 ;; first line's indentation.
4460 data
4462 contents)))))))
4464 ;; Build white spaces. If no `:post-blank' property is
4465 ;; specified, assume its value is 0.
4475 "Return ELEMENT's affiliated keywords as Org syntax.
4476 If there is no affiliated keyword, return the empty string."
4486 ": "
4489 value)
4497 ;; All attribute keywords can have multiple lines.
4503 ;; List all ELEMENT's properties matching an attribute line or an
4504 ;; affiliated keyword, but ignore translated keywords since they
4505 ;; cannot belong to the property list.
4512 org-element-keyword-translation-alist)))))
4513 collect prop)
4516 ;; Because interpretation of the parse tree must return the same
4517 ;; number of blank lines between elements and the same number of white
4518 ;; space after objects, some special care must be given to white
4519 ;; spaces.
4520 ;;
4521 ;; The first function, `org-element-normalize-string', ensures any
4522 ;; string different from the empty string will end with a single
4523 ;; newline character.
4524 ;;
4525 ;; The second function, `org-element-normalize-contents', removes
4526 ;; global indentation from the contents of the current element.
4529 "Ensure string S ends with a single newline character.
4531 If S isn't a string return it unchanged. If S is the empty
4532 string, return it. Otherwise, return a new string with a single
4533 newline character at its end."
4541 "Normalize plain text in ELEMENT's contents.
4543 ELEMENT must only contain plain text and objects.
4545 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4546 indentation to compute maximal common indentation.
4548 Return the normalized element that is element with global
4549 indentation removed from its contents. The function assumes that
4550 indentation is not done with TAB characters."
4552 collect-inds ; for byte-compiler
4555 ;; Return list of indentations within BLOB. This is done by
4556 ;; walking recursively BLOB and updating IND-LIST along the
4557 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4558 ;; been seen yet. It is required as this string is the only
4559 ;; one whose indentation doesn't happen after a newline
4560 ;; character.
4568 ;; An indentation of zero means no string will be
4569 ;; modified. Quit the process.
4575 ;; Avoid matching blank or empty lines.
4583 ;; Collect indentation list in ELEMENT. Possibly remove first
4584 ;; value if IGNORE-FIRST is non-nil.
4587 ;; Build ELEMENT back, replacing each string with the same
4588 ;; string minus common indentation.
4593 ;; Return BLOB with all its strings indentation
4594 ;; shortened from MCI white spaces. FIRST-FLAG is
4595 ;; non-nil when the first string hasn't been seen
4596 ;; yet.
4610 org-element-recursive-objects)
4614 blob))))
4618 \f
4619 ;;; The Toolbox
4620 ;;
4621 ;; The first move is to implement a way to obtain the smallest element
4622 ;; containing point. This is the job of `org-element-at-point'. It
4623 ;; basically jumps back to the beginning of section containing point
4624 ;; and moves, element after element, with
4625 ;; `org-element--current-element' until the container is found. Note:
4626 ;; When using `org-element-at-point', secondary values are never
4627 ;; parsed since the function focuses on elements, not on objects.
4628 ;;
4629 ;; At a deeper level, `org-element-context' lists all elements and
4630 ;; objects containing point.
4631 ;;
4632 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4633 ;; internally by navigation and manipulation tools.
4635 ;;;###autoload
4637 "Determine closest element around point.
4639 Return value is a list like (TYPE PROPS) where TYPE is the type
4640 of the element and PROPS a plist of properties associated to the
4641 element.
4643 Possible types are defined in `org-element-all-elements'.
4644 Properties depend on element or object type, but always include
4645 `:begin', `:end', `:parent' and `:post-blank' properties.
4647 As a special case, if point is at the very beginning of a list or
4648 sub-list, returned element will be that list instead of the first
4649 item. In the same way, if point is at the beginning of the first
4650 row of a table, returned element will be the table instead of the
4651 first row.
4653 If optional argument KEEP-TRAIL is non-nil, the function returns
4654 a list of elements leading to element at point. The list's CAR
4655 is always the element at point. The following positions contain
4656 element's siblings, then parents, siblings of parents, until the
4657 first element of current section."
4659 ;; If at a headline, parse it. It is the sole element that
4660 ;; doesn't require to know about context. Be sure to disallow
4661 ;; secondary string parsing, though.
4667 ;; Otherwise move at the beginning of the section containing
4668 ;; point.
4673 element type special-flag trail struct prevs parent)
4676 ;; In empty lines at buffer's beginning, return nil.
4685 ;; In blank lines just after the headline, point still
4686 ;; belongs to the headline.
4695 ;; Parse successively each element, skipping those ending
4696 ;; before original position.
4704 ;; 1. Skip any element ending before point. Also skip
4705 ;; element ending at point when we're sure that another
4706 ;; element has started.
4711 ;; 2. An element containing point is always the element at
4712 ;; point.
4715 ;; 3. At any other greater element type, if point is
4716 ;; within contents, move into it.
4721 ;; Create an anchor for tables and plain lists:
4722 ;; when point is at the very beginning of these
4723 ;; elements, ignoring affiliated keywords,
4724 ;; target them instead of their contents.
4726 ;; When point is at contents end, do not move
4727 ;; into elements with an explicit ending, but
4728 ;; return that element instead.
4732 drawer dynamic-block inlinetask
4733 property-drawer quote-block
4734 special-block))
4735 ;; Corner case: if a list ends at the
4736 ;; end of a buffer without a final new
4737 ;; line, return last element in last
4738 ;; item instead.
4756 ;;;###autoload
4758 "Return closest element or object around point.
4760 Return value is a list like (TYPE PROPS) where TYPE is the type
4761 of the element or object and PROPS a plist of properties
4762 associated to it.
4764 Possible types are defined in `org-element-all-elements' and
4765 `org-element-all-objects'. Properties depend on element or
4766 object type, but always include `:begin', `:end', `:parent' and
4767 `:post-blank'.
4769 Optional argument ELEMENT, when non-nil, is the closest element
4770 containing point, as returned by `org-element-at-point'.
4771 Providing it allows for quicker computation."
4777 context)
4778 ;; Check if point is inside an element containing objects or at
4779 ;; a secondary string. In that case, narrow buffer to the
4780 ;; containing area. Otherwise, return ELEMENT.
4782 ;; At a parsed affiliated keyword, check if we're inside main
4783 ;; or dual value.
4798 ;; Also change type to retrieve correct restrictions.
4800 ;; At an item, objects can only be located within tag, if any.
4810 ;; At an headline or inlinetask, objects are located within
4811 ;; their title.
4818 ;; At a paragraph, a table-row or a verse block, objects are
4819 ;; located within their contents.
4823 ;; CBEG is nil for table rules.
4827 ;; At a parsed keyword, objects are located within value.
4830 org-element-document-properties))
4845 restriction candidates))
4847 candidates)))
4848 ;; If ORIGIN is before next object in element, there's
4849 ;; no point in looking further.
4859 ;; ORIGIN is after OBJECT, so skip it.
4861 ;; ORIGIN is within a non-recursive object or at
4862 ;; an object boundaries: Return that object.
4866 ;; Otherwise, move within current object and
4867 ;; restrict search to the end of its contents.
4874 parent))))))
4877 "Non-nil when elements ELEM-A and ELEM-B are nested."
4886 "Swap elements ELEM-A and ELEM-B.
4887 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4888 end of ELEM-A."
4890 ;; There are two special cases when an element doesn't start at bol:
4891 ;; the first paragraph in an item or in a footnote definition.
4893 ;; Only a paragraph without any affiliated keyword can be moved at
4894 ;; ELEM-A position in such a situation. Note that the case of
4895 ;; a footnote definition is impossible: it cannot contain two
4896 ;; paragraphs in a row because it cannot contain a blank line.
4902 ;; In a special situation, ELEM-A will have no indentation. We'll
4903 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4917 ;; Store overlays responsible for visibility status. We
4918 ;; also need to store their boundaries as they will be
4919 ;; removed from buffer.
4926 ;; Get contents.
4934 ;; Restore ex ELEM-A overlays.
4943 ;; Restore ex ELEM-B overlays.
4951 "Remove maximum common indentation in string S and return it.
4952 When optional argument N is a positive integer, remove exactly
4953 that much characters from indentation, if possible, or return
4954 S as-is otherwise. Unlike to `org-remove-indentation', this
4955 function doesn't call `untabify' on S."
4960 ;; Find maximum common indentation, if not specified.
4968 min-ind)))
4970 ;; Remove exactly N indentation, but give up if not possible.
4982 ;; Local variables:
4983 ;; generated-autoload-file: "org-loaddefs.el"
4984 ;; End:
4986 ;;; org-element.el ends here