| blob | 329d00a4d558706a1097dd3ecd4814eba1704fa7 |
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 "Remove maximum common indentation in string S and return it.
1716 When optional argument N is a positive integer, remove exactly
1717 that much characters from indentation, if possible, or return
1718 S as-is otherwise. Unlike to `org-remove-indentation', this
1719 function doesn't call `untabify' on S."
1724 ;; Find maximum common indentation, if not specified.
1732 min-ind)))
1734 ;; Remove exactly N indentation, but give up if not possible.
1744 "Parse an example block.
1746 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1747 the buffer position at the beginning of the first affiliated
1748 keyword and CDR is a plist of affiliated keywords along with
1749 their value.
1751 Return a list whose CAR is `example-block' and CDR is a plist
1752 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1753 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1754 `:value', `:post-blank' and `:post-affiliated' keywords."
1758 ;; Incomplete block: parse it as a paragraph.
1766 ;; Switches analysis
1774 ;; Should labels be retained in (or stripped from) example
1775 ;; blocks?
1780 ;; What should code-references use - labels or
1781 ;; line-numbers?
1790 ;; Standard block parsing.
1798 contents-begin contents-end))
1809 :end end
1810 :value value
1811 :switches switches
1812 :number-lines number-lines
1813 :preserve-indent preserve-indent
1814 :retain-labels retain-labels
1815 :use-labels use-labels
1816 :label-fmt label-fmt
1822 "Interpret EXAMPLE-BLOCK element as Org syntax.
1823 CONTENTS is nil."
1831 ;;;; Export Block
1834 "Parse an export block.
1836 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1837 the buffer position at the beginning of the first affiliated
1838 keyword and CDR is a plist of affiliated keywords along with
1839 their value.
1841 Return a list whose CAR is `export-block' and CDR is a plist
1842 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1843 `:post-affiliated' keywords.
1845 Assume point is at export-block beginning."
1852 ;; Incomplete block: parse it as a paragraph.
1866 contents-end)))
1870 :end end
1871 :type type
1872 :value value
1878 "Interpret EXPORT-BLOCK element as Org syntax.
1879 CONTENTS is nil."
1886 ;;;; Fixed-width
1889 "Parse a fixed-width section.
1891 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1892 the buffer position at the beginning of the first affiliated
1893 keyword and CDR is a plist of affiliated keywords along with
1894 their value.
1896 Return a list whose CAR is `fixed-width' and CDR is a plist
1897 containing `:begin', `:end', `:value', `:post-blank' and
1898 `:post-affiliated' keywords.
1900 Assume point is at the beginning of the fixed-width area."
1904 value
1909 ;; Accumulate text without starting colons.
1923 :end end
1924 :value value
1930 "Interpret FIXED-WIDTH element as Org syntax.
1931 CONTENTS is nil."
1939 ;;;; Horizontal Rule
1942 "Parse an horizontal rule.
1944 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1945 the buffer position at the beginning of the first affiliated
1946 keyword and CDR is a plist of affiliated keywords along with
1947 their value.
1949 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1950 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1951 keywords."
1962 :end end
1968 "Interpret HORIZONTAL-RULE element as Org syntax.
1969 CONTENTS is nil."
1973 ;;;; Keyword
1976 "Parse a keyword at point.
1978 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1979 the buffer position at the beginning of the first affiliated
1980 keyword and CDR is a plist of affiliated keywords along with
1981 their value.
1983 Return a list whose CAR is `keyword' and CDR is a plist
1984 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1985 `:post-affiliated' keywords."
2000 :value value
2001 :begin begin
2002 :end end
2008 "Interpret KEYWORD element as Org syntax.
2009 CONTENTS is nil."
2015 ;;;; Latex Environment
2018 "Parse a LaTeX environment.
2020 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2021 the buffer position at the beginning of the first affiliated
2022 keyword and CDR is a plist of affiliated keywords along with
2023 their value.
2025 Return a list whose CAR is `latex-environment' and CDR is a plist
2026 containing `:begin', `:end', `:value', `:post-blank' and
2027 `:post-affiliated' keywords.
2029 Assume point is at the beginning of the latex environment."
2036 limit t))
2037 ;; Incomplete latex environment: parse it as a paragraph.
2048 :end end
2049 :value value
2055 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2056 CONTENTS is nil."
2060 ;;;; Node Property
2063 "Parse a node-property at point.
2065 LIMIT bounds the search.
2067 Return a list whose CAR is `node-property' and CDR is a plist
2068 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2069 keywords."
2081 :value value
2082 :begin begin
2083 :end end
2087 "Interpret NODE-PROPERTY element as Org syntax.
2088 CONTENTS is nil."
2094 ;;;; Paragraph
2097 "Parse a paragraph.
2099 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2100 the buffer position at the beginning of the first affiliated
2101 keyword and CDR is a plist of affiliated keywords along with
2102 their value.
2104 Return a list whose CAR is `paragraph' and CDR is a plist
2105 containing `:begin', `:end', `:contents-begin' and
2106 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2108 Assume point is at the beginning of the paragraph."
2117 limit
2118 ;; A matching `org-element-paragraph-separate' is not
2119 ;; necessarily the end of the paragraph. In
2120 ;; particular, lines starting with # or : as a first
2121 ;; non-space character are ambiguous. We have check
2122 ;; if they are valid Org syntax (i.e. not an
2123 ;; incomplete keyword).
2127 ;; There's no ambiguity for other symbols or
2128 ;; empty lines: stop here.
2130 ;; Stop at valid fixed-width areas.
2132 ;; Stop at drawers.
2137 ;; Stop at valid comments.
2139 ;; Stop at valid dynamic blocks.
2144 ;; Stop at valid blocks.
2151 limit t)))
2152 ;; Stop at valid latex environments.
2160 limit t)))
2161 ;; Stop at valid keywords.
2163 ;; Skip everything else.
2181 :end end
2182 :contents-begin contents-begin
2183 :contents-end contents-end
2189 "Interpret PARAGRAPH element as Org syntax.
2190 CONTENTS is the contents of the element."
2191 contents)
2194 ;;;; Planning
2197 "Parse a planning.
2199 LIMIT bounds the search.
2201 Return a list whose CAR is `planning' and CDR is a plist
2202 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2203 and `:post-blank' keywords."
2213 closed deadline scheduled)
2225 :deadline deadline
2226 :scheduled scheduled
2227 :begin begin
2228 :end end
2232 "Interpret PLANNING element as Org syntax.
2233 CONTENTS is nil."
2235 'identity
2252 ;;;; Quote Section
2255 "Parse a quote section.
2257 LIMIT bounds the search.
2259 Return a list whose CAR is `quote-section' and CDR is a plist
2260 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2262 Assume point is at beginning of the section."
2273 :end end
2274 :value value
2278 "Interpret QUOTE-SECTION element as Org syntax.
2279 CONTENTS is nil."
2283 ;;;; Src Block
2286 "Parse a src block.
2288 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2289 the buffer position at the beginning of the first affiliated
2290 keyword and CDR is a plist of affiliated keywords along with
2291 their value.
2293 Return a list whose CAR is `src-block' and CDR is a plist
2294 containing `:language', `:switches', `:parameters', `:begin',
2295 `:end', `:number-lines', `:retain-labels', `:use-labels',
2296 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2297 `:post-affiliated' keywords.
2299 Assume point is at the beginning of the block."
2302 limit t)))
2303 ;; Incomplete block: parse it as a paragraph.
2309 ;; Get language as a string.
2318 ;; Get switches.
2320 ;; Get parameters.
2322 ;; Switches analysis
2334 ;; Should labels be retained in (or stripped from)
2335 ;; src blocks?
2340 ;; What should code-references use - labels or
2341 ;; line-numbers?
2346 ;; Indentation.
2348 ;; Retrieve code.
2357 ;; Get position after ending blank lines.
2368 :begin begin
2369 :end end
2370 :number-lines number-lines
2371 :preserve-indent preserve-indent
2372 :retain-labels retain-labels
2373 :use-labels use-labels
2374 :label-fmt label-fmt
2375 :value value
2381 "Interpret SRC-BLOCK element as Org syntax.
2382 CONTENTS is nil."
2403 ;;;; Table
2406 "Parse a table at point.
2408 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2409 the buffer position at the beginning of the first affiliated
2410 keyword and CDR is a plist of affiliated keywords along with
2411 their value.
2413 Return a list whose CAR is `table' and CDR is a plist containing
2414 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2415 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2416 keywords.
2418 Assume point is at the beginning of the table."
2432 acc))
2440 :end end
2441 :type type
2442 :tblfm tblfm
2443 ;; Only `org' tables have contents. `table.el' tables
2444 ;; use a `:value' property to store raw table as
2445 ;; a string.
2450 table-begin table-end))
2456 "Interpret TABLE element as Org syntax.
2457 CONTENTS is nil."
2468 ;;;; Table Row
2471 "Parse table row at point.
2473 LIMIT bounds the search.
2475 Return a list whose CAR is `table-row' and CDR is a plist
2476 containing `:begin', `:end', `:contents-begin', `:contents-end',
2477 `:type' and `:post-blank' keywords."
2481 ;; A table rule has no contents. In that case, ensure
2482 ;; CONTENTS-BEGIN matches CONTENTS-END.
2494 :begin begin
2495 :end end
2496 :contents-begin contents-begin
2497 :contents-end contents-end
2501 "Interpret TABLE-ROW element as Org syntax.
2502 CONTENTS is the contents of the table row."
2507 ;;;; Verse Block
2510 "Parse a verse block.
2512 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2513 the buffer position at the beginning of the first affiliated
2514 keyword and CDR is a plist of affiliated keywords along with
2515 their value.
2517 Return a list whose CAR is `verse-block' and CDR is a plist
2518 containing `:begin', `:end', `:contents-begin', `:contents-end',
2519 `:post-blank' and `:post-affiliated' keywords.
2521 Assume point is at beginning of the block."
2525 ;; Incomplete block: parse it as a paragraph.
2541 :end end
2542 :contents-begin contents-begin
2543 :contents-end contents-end
2549 "Interpret VERSE-BLOCK element as Org syntax.
2550 CONTENTS is verse block contents."
2554 \f
2555 ;;; Objects
2556 ;;
2557 ;; Unlike to elements, interstices can be found between objects.
2558 ;; That's why, along with the parser, successor functions are provided
2559 ;; for each object. Some objects share the same successor (i.e. `code'
2560 ;; and `verbatim' objects).
2561 ;;
2562 ;; A successor must accept a single argument bounding the search. It
2563 ;; will return either a cons cell whose CAR is the object's type, as
2564 ;; a symbol, and CDR the position of its next occurrence, or nil.
2565 ;;
2566 ;; Successors follow the naming convention:
2567 ;; org-element-NAME-successor, where NAME is the name of the
2568 ;; successor, as defined in `org-element-all-successors'.
2569 ;;
2570 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2571 ;; object types they can contain will be specified in
2572 ;; `org-element-object-restrictions'.
2573 ;;
2574 ;; Adding a new type of object is simple. Implement a successor,
2575 ;; a parser, and an interpreter for it, all following the naming
2576 ;; convention. Register type in `org-element-all-objects' and
2577 ;; successor in `org-element-all-successors'. Maybe tweak
2578 ;; restrictions about it, and that's it.
2581 ;;;; Bold
2584 "Parse bold object at point.
2586 Return a list whose CAR is `bold' and CDR is a plist with
2587 `:begin', `:end', `:contents-begin' and `:contents-end' and
2588 `:post-blank' keywords.
2590 Assume point is at the first star marker."
2602 :end end
2603 :contents-begin contents-begin
2604 :contents-end contents-end
2608 "Interpret BOLD object as Org syntax.
2609 CONTENTS is the contents of the object."
2613 "Search for the next text-markup object.
2615 Return value is a cons cell whose CAR is a symbol among `bold',
2616 `italic', `underline', `strike-through', `code' and `verbatim'
2617 and CDR is beginning position."
2633 ;;;; Code
2636 "Parse code object at point.
2638 Return a list whose CAR is `code' and CDR is a plist with
2639 `:value', `:begin', `:end' and `:post-blank' keywords.
2641 Assume point is at the first tilde marker."
2652 :begin begin
2653 :end end
2657 "Interpret CODE object as Org syntax.
2658 CONTENTS is nil."
2662 ;;;; Entity
2665 "Parse entity at point.
2667 Return a list whose CAR is `entity' and CDR a plist with
2668 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2669 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2670 keywords.
2672 Assume point is at the beginning of the entity."
2674 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2690 :begin begin
2691 :end end
2692 :use-brackets-p bracketsp
2696 "Interpret ENTITY object as Org syntax.
2697 CONTENTS is nil."
2703 "Search for the next latex-fragment or entity object.
2705 Return value is a cons cell whose CAR is `entity' or
2706 `latex-fragment' and CDR is beginning position."
2710 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2717 ;; Determine if it's a real entity or a LaTeX command.
2720 ;; No entity nor command: point is at a LaTeX fragment.
2721 ;; Determine its type to get the correct beginning position.
2730 ;;;; Export Snippet
2733 "Parse export snippet at point.
2735 Return a list whose CAR is `export-snippet' and CDR a plist with
2736 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2737 keywords.
2739 Assume point is at the beginning of the snippet."
2751 :value value
2752 :begin begin
2753 :end end
2757 "Interpret EXPORT-SNIPPET object as Org syntax.
2758 CONTENTS is nil."
2764 "Search for the next export-snippet object.
2766 Return value is a cons cell whose CAR is `export-snippet' and CDR
2767 its beginning position."
2776 ;;;; Footnote Reference
2779 "Parse footnote reference at point.
2781 Return a list whose CAR is `footnote-reference' and CDR a plist
2782 with `:label', `:type', `:inline-definition', `:begin', `:end'
2783 and `:post-blank' as keywords."
2805 :type type
2806 :begin begin
2807 :end end
2810 footnote-reference :inline-definition
2815 footnote-reference))))))
2818 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2819 CONTENTS is nil."
2829 "Search for the next footnote-reference object.
2831 Return value is a cons cell whose CAR is `footnote-reference' and
2832 CDR is beginning position."
2846 ;;;; Inline Babel Call
2849 "Parse inline babel call at point.
2851 Return a list whose CAR is `inline-babel-call' and CDR a plist
2852 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2854 Assume point is at the beginning of the babel call."
2866 :end end
2867 :value value
2871 "Interpret INLINE-BABEL-CALL object as Org syntax.
2872 CONTENTS is nil."
2876 "Search for the next inline-babel-call object.
2878 Return value is a cons cell whose CAR is `inline-babel-call' and
2879 CDR is beginning position."
2881 ;; Use a simplified version of
2882 ;; `org-babel-inline-lob-one-liner-regexp'.
2885 nil t)
2889 ;;;; Inline Src Block
2892 "Parse inline source block at point.
2894 Return a list whose CAR is `inline-src-block' and CDR a plist
2895 with `:begin', `:end', `:language', `:value', `:parameters' and
2896 `:post-blank' as keywords.
2898 Assume point is at the beginning of the inline src block."
2911 :value value
2912 :parameters parameters
2913 :begin begin
2914 :end end
2918 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2919 CONTENTS is nil."
2924 language
2926 body)))
2929 "Search for the next inline-babel-call element.
2931 Return value is a cons cell whose CAR is `inline-babel-call' and
2932 CDR is beginning position."
2938 ;;;; Italic
2941 "Parse italic object at point.
2943 Return a list whose CAR is `italic' and CDR is a plist with
2944 `:begin', `:end', `:contents-begin' and `:contents-end' and
2945 `:post-blank' keywords.
2947 Assume point is at the first slash marker."
2959 :end end
2960 :contents-begin contents-begin
2961 :contents-end contents-end
2965 "Interpret ITALIC object as Org syntax.
2966 CONTENTS is the contents of the object."
2970 ;;;; Latex Fragment
2973 "Parse LaTeX fragment at point.
2975 Return a list whose CAR is `latex-fragment' and CDR a plist with
2976 `:value', `:begin', `:end', and `:post-blank' as keywords.
2978 Assume point is at the beginning of the LaTeX fragment."
2991 ;; None found: it's a macro.
3000 :begin begin
3001 :end end
3005 "Interpret LATEX-FRAGMENT object as Org syntax.
3006 CONTENTS is nil."
3009 ;;;; Line Break
3012 "Parse line break at point.
3014 Return a list whose CAR is `line-break', and CDR a plist with
3015 `:begin', `:end' and `:post-blank' keywords.
3017 Assume point is at the beginning of the line break."
3024 "Interpret LINE-BREAK object as Org syntax.
3025 CONTENTS is nil."
3029 "Search for the next line-break object.
3031 Return value is a cons cell whose CAR is `line-break' and CDR is
3032 beginning position."
3036 ;; A line break can only happen on a non-empty line.
3041 ;;;; Link
3044 "Parse link at point.
3046 Return a list whose CAR is `link' and CDR a plist with `:type',
3047 `:path', `:raw-link', `:application', `:search-option', `:begin',
3048 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3049 keywords.
3051 Assume point is at the beginning of the link."
3054 end contents-begin contents-end link-end post-blank path type
3055 raw-link link search-option application)
3057 ;; Type 1: Text targeted from a radio target.
3062 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3067 ;; RAW-LINK is the original link. Expand any
3068 ;; abbreviation in it.
3072 ;; Determine TYPE of link and set PATH accordingly.
3074 ;; File type.
3078 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3081 ;; Id type: PATH is the id.
3084 ;; Code-ref type: PATH is the name of the reference.
3087 ;; Custom-id type: PATH is the name of the custom id.
3090 ;; Fuzzy type: Internal link either matches a target, an
3091 ;; headline name or nothing. PATH is the target or
3092 ;; headline's name.
3094 ;; Type 3: Plain link, i.e. http://orgmode.org
3100 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3107 ;; In any case, deduce end point after trailing white space from
3108 ;; LINK-END variable.
3111 ;; Extract search option and opening application out of
3112 ;; "file"-type links.
3114 ;; Application.
3119 ;; Extract search option from PATH.
3123 ;; Make sure TYPE always reports "file".
3127 :path path
3129 :application application
3130 :search-option search-option
3131 :begin begin
3132 :end end
3133 :contents-begin contents-begin
3134 :contents-end contents-end
3138 "Interpret LINK object as Org syntax.
3139 CONTENTS is the contents of the object, or nil."
3144 raw-link
3148 "Search for the next link object.
3150 Return value is a cons cell whose CAR is `link' and CDR is
3151 beginning position."
3160 "Search for the next plain link object.
3162 Return value is a cons cell whose CAR is `link' and CDR is
3163 beginning position."
3168 ;;;; Macro
3171 "Parse macro at point.
3173 Return a list whose CAR is `macro' and CDR a plist with `:key',
3174 `:args', `:begin', `:end', `:value' and `:post-blank' as
3175 keywords.
3177 Assume point is at the macro."
3188 ;; Do not use `org-split-string' since empty
3189 ;; strings are meaningful here.
3197 args nil t)
3201 :value value
3202 :args args
3203 :begin begin
3204 :end end
3208 "Interpret MACRO object as Org syntax.
3209 CONTENTS is nil."
3213 "Search for the next macro object.
3215 Return value is cons cell whose CAR is `macro' and CDR is
3216 beginning position."
3220 nil t)
3224 ;;;; Radio-target
3227 "Parse radio target at point.
3229 Return a list whose CAR is `radio-target' and CDR a plist with
3230 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3231 and `:post-blank' as keywords.
3233 Assume point is at the radio target."
3245 :end end
3246 :contents-begin contents-begin
3247 :contents-end contents-end
3248 :post-blank post-blank
3252 "Interpret TARGET object as Org syntax.
3253 CONTENTS is the contents of the object."
3257 "Search for the next radio-target object.
3259 Return value is a cons cell whose CAR is `radio-target' and CDR
3260 is beginning position."
3266 ;;;; Statistics Cookie
3269 "Parse statistics cookie at point.
3271 Return a list whose CAR is `statistics-cookie', and CDR a plist
3272 with `:begin', `:end', `:value' and `:post-blank' keywords.
3274 Assume point is at the beginning of the statistics-cookie."
3285 :end end
3286 :value value
3290 "Interpret STATISTICS-COOKIE object as Org syntax.
3291 CONTENTS is nil."
3295 "Search for the next statistics cookie object.
3297 Return value is a cons cell whose CAR is `statistics-cookie' and
3298 CDR is beginning position."
3304 ;;;; Strike-Through
3307 "Parse strike-through object at point.
3309 Return a list whose CAR is `strike-through' and CDR is a plist
3310 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3311 `:post-blank' keywords.
3313 Assume point is at the first plus sign marker."
3325 :end end
3326 :contents-begin contents-begin
3327 :contents-end contents-end
3331 "Interpret STRIKE-THROUGH object as Org syntax.
3332 CONTENTS is the contents of the object."
3336 ;;;; Subscript
3339 "Parse subscript at point.
3341 Return a list whose CAR is `subscript' and CDR a plist with
3342 `:begin', `:end', `:contents-begin', `:contents-end',
3343 `:use-brackets-p' and `:post-blank' as keywords.
3345 Assume point is at the underscore."
3349 t
3360 :end end
3361 :use-brackets-p bracketsp
3362 :contents-begin contents-begin
3363 :contents-end contents-end
3367 "Interpret SUBSCRIPT object as Org syntax.
3368 CONTENTS is the contents of the object."
3371 contents))
3374 "Search for the next sub/superscript object.
3376 Return value is a cons cell whose CAR is either `subscript' or
3377 `superscript' and CDR is beginning position."
3385 ;;;; Superscript
3388 "Parse superscript at point.
3390 Return a list whose CAR is `superscript' and CDR a plist with
3391 `:begin', `:end', `:contents-begin', `:contents-end',
3392 `:use-brackets-p' and `:post-blank' as keywords.
3394 Assume point is at the caret."
3408 :end end
3409 :use-brackets-p bracketsp
3410 :contents-begin contents-begin
3411 :contents-end contents-end
3415 "Interpret SUPERSCRIPT object as Org syntax.
3416 CONTENTS is the contents of the object."
3419 contents))
3422 ;;;; Table Cell
3425 "Parse table cell at point.
3427 Return a list whose CAR is `table-cell' and CDR is a plist
3428 containing `:begin', `:end', `:contents-begin', `:contents-end'
3429 and `:post-blank' keywords."
3437 :end end
3438 :contents-begin contents-begin
3439 :contents-end contents-end
3443 "Interpret TABLE-CELL element as Org syntax.
3444 CONTENTS is the contents of the cell, or nil."
3448 "Search for the next table-cell object.
3450 Return value is a cons cell whose CAR is `table-cell' and CDR is
3451 beginning position."
3455 ;;;; Target
3458 "Parse target at point.
3460 Return a list whose CAR is `target' and CDR a plist with
3461 `:begin', `:end', `:value' and `:post-blank' as keywords.
3463 Assume point is at the target."
3473 :end end
3474 :value value
3478 "Interpret TARGET object as Org syntax.
3479 CONTENTS is nil."
3483 "Search for the next target object.
3485 Return value is a cons cell whose CAR is `target' and CDR is
3486 beginning position."
3492 ;;;; Timestamp
3495 "Parse time stamp at point.
3497 Return a list whose CAR is `timestamp', and CDR a plist with
3498 `:type', `:raw-value', `:year-start', `:month-start',
3499 `:day-start', `:hour-start', `:minute-start', `:year-end',
3500 `:month-end', `:day-end', `:hour-end', `:minute-end',
3501 `:repeater-type', `:repeater-value', `:repeater-unit',
3502 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3503 `:end', `:value' and `:post-blank' keywords.
3505 Assume point is at the beginning of the timestamp."
3523 date-start)
3534 raw-value)
3536 :repeater-type
3542 :repeater-unit
3551 :warning-unit
3554 year-start month-start day-start hour-start minute-start year-end
3555 month-end day-end hour-end minute-end)
3556 ;; Parse date-start.
3564 ;; Compute date-end. It can be provided directly in time-stamp,
3565 ;; or extracted from time range. Otherwise, it defaults to the
3566 ;; same values as date-start.
3576 :raw-value raw-value
3577 :year-start year-start
3578 :month-start month-start
3579 :day-start day-start
3580 :hour-start hour-start
3581 :minute-start minute-start
3582 :year-end year-end
3583 :month-end month-end
3584 :day-end day-end
3585 :hour-end hour-end
3586 :minute-end minute-end
3587 :begin begin
3588 :end end
3590 repeater-props
3591 warning-props)))))
3594 "Interpret TIMESTAMP object as Org syntax.
3595 CONTENTS is nil."
3596 ;; Use `:raw-value' if specified.
3598 ;; Otherwise, build timestamp string.
3617 ;; Build an Org timestamp string from TIME. ACTIVEP is
3618 ;; non-nil when time stamp is active. If WITH-TIME-P is
3619 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3620 ;; specify a time range in the timestamp. REPEAT-STRING
3621 ;; is the repeater string, if any.
3625 org-time-stamp-formats)
3626 time)))
3632 nil nil ts)))
3637 " "
3638 s
3640 ;; Return value.
3641 ts)))
3653 build-ts-string
3672 0
3680 "--"
3692 "Search for the next timestamp object.
3694 Return value is a cons cell whose CAR is `timestamp' and CDR is
3695 beginning position."
3703 nil t)
3707 ;;;; Underline
3710 "Parse underline object at point.
3712 Return a list whose CAR is `underline' and CDR is a plist with
3713 `:begin', `:end', `:contents-begin' and `:contents-end' and
3714 `:post-blank' keywords.
3716 Assume point is at the first underscore marker."
3728 :end end
3729 :contents-begin contents-begin
3730 :contents-end contents-end
3734 "Interpret UNDERLINE object as Org syntax.
3735 CONTENTS is the contents of the object."
3739 ;;;; Verbatim
3742 "Parse verbatim object at point.
3744 Return a list whose CAR is `verbatim' and CDR is a plist with
3745 `:value', `:begin', `:end' and `:post-blank' keywords.
3747 Assume point is at the first equal sign marker."
3758 :begin begin
3759 :end end
3763 "Interpret VERBATIM object as Org syntax.
3764 CONTENTS is nil."
3768 \f
3769 ;;; Parsing Element Starting At Point
3770 ;;
3771 ;; `org-element--current-element' is the core function of this section.
3772 ;; It returns the Lisp representation of the element starting at
3773 ;; point.
3774 ;;
3775 ;; `org-element--current-element' makes use of special modes. They
3776 ;; are activated for fixed element chaining (i.e. `plain-list' >
3777 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3778 ;; `section'). Special modes are: `first-section', `item',
3779 ;; `node-property', `quote-section', `section' and `table-row'.
3783 "Parse the element starting at point.
3785 Return value is a list like (TYPE PROPS) where TYPE is the type
3786 of the element and PROPS a plist of properties associated to the
3787 element.
3789 Possible types are defined in `org-element-all-elements'.
3791 LIMIT bounds the search.
3793 Optional argument GRANULARITY determines the depth of the
3794 recursion. Allowed values are `headline', `greater-element',
3795 `element', `object' or nil. When it is broader than `object' (or
3796 nil), secondary values will not be parsed, since they only
3797 contain objects.
3799 Optional argument SPECIAL, when non-nil, can be either
3800 `first-section', `item', `node-property', `quote-section',
3801 `section', and `table-row'.
3803 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3804 be computed.
3806 This function assumes point is always at the beginning of the
3807 element it has to parse."
3810 ;; Determine if parsing depth allows for secondary strings
3811 ;; parsing. It only applies to elements referenced in
3812 ;; `org-element-secondary-value-alist'.
3815 ;; Item.
3818 ;; Table Row.
3820 ;; Node Property.
3822 ;; Headline.
3825 ;; Sections (must be checked after headline).
3831 limit)))
3832 ;; When not at bol, point is at the beginning of an item or
3833 ;; a footnote definition: next item is always a paragraph.
3835 ;; Planning and Clock.
3840 ;; Inlinetask.
3843 ;; From there, elements can have affiliated keywords.
3846 ;; Jumping over affiliated keywords put point off-limits.
3847 ;; Parse them as regular keywords.
3851 ;; LaTeX Environment.
3855 ;; Drawer and Property Drawer.
3860 ;; Fixed Width
3863 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3864 ;; Keywords.
3873 org-element-block-name-alist)))
3888 ;; Footnote Definition.
3891 ;; Horizontal Rule.
3894 ;; Diary Sexp.
3897 ;; Table.
3899 ;; List.
3902 limit affiliated
3904 ;; Default element: Paragraph.
3908 ;; Most elements can have affiliated keywords. When looking for an
3909 ;; element beginning, we want to move before them, as they belong to
3910 ;; that element, and, in the meantime, collect information they give
3911 ;; into appropriate properties. Hence the following function.
3914 "Collect affiliated keywords from point down to LIMIT.
3916 Return a list whose CAR is the position at the first of them and
3917 CDR a plist of keywords and values and move point to the
3918 beginning of the first line after them.
3920 As a special case, if element doesn't start at the beginning of
3921 the line (i.e. a paragraph starting an item), CAR is current
3922 position of point and CDR is nil."
3926 ;; RESTRICT is the list of objects allowed in parsed
3927 ;; keywords value.
3929 output)
3932 ;; Apply translation to RAW-KWD. From there, KWD is
3933 ;; the official keyword.
3935 org-element-keyword-translation-alist))
3936 raw-kwd))
3937 ;; Find main value for any keyword.
3943 ;; PARSEDP is non-nil when keyword should have its
3944 ;; value parsed.
3946 ;; If KWD is a dual keyword, find its secondary
3947 ;; value. Maybe parse it.
3954 ;; Attribute a property name to KWD.
3956 ;; Now set final shape for VALUE.
3962 ;; Attributes can always appear on multiple lines.
3965 ;; Eventually store the new value in OUTPUT.
3967 ;; Move to next keyword.
3969 ;; If affiliated keywords are orphaned: move back to first one.
3970 ;; They will be parsed as a paragraph.
3972 ;; Return value.
3976 \f
3977 ;;; The Org Parser
3978 ;;
3979 ;; The two major functions here are `org-element-parse-buffer', which
3980 ;; parses Org syntax inside the current buffer, taking into account
3981 ;; region, narrowing, or even visibility if specified, and
3982 ;; `org-element-parse-secondary-string', which parses objects within
3983 ;; a given string.
3984 ;;
3985 ;; The (almost) almighty `org-element-map' allows to apply a function
3986 ;; on elements or objects matching some type, and accumulate the
3987 ;; resulting values. In an export situation, it also skips unneeded
3988 ;; parts of the parse tree.
3991 "Recursively parse the buffer and return structure.
3992 If narrowing is in effect, only parse the visible part of the
3993 buffer.
3995 Optional argument GRANULARITY determines the depth of the
3996 recursion. It can be set to the following symbols:
3998 `headline' Only parse headlines.
3999 `greater-element' Don't recurse into greater elements excepted
4000 headlines and sections. Thus, elements
4001 parsed are the top-level ones.
4002 `element' Parse everything but objects and plain text.
4003 `object' Parse the complete buffer (default).
4005 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4006 elements.
4008 An element or an objects is represented as a list with the
4009 pattern (TYPE PROPERTIES CONTENTS), where :
4011 TYPE is a symbol describing the element or object. See
4012 `org-element-all-elements' and `org-element-all-objects' for an
4013 exhaustive list of such symbols. One can retrieve it with
4014 `org-element-type' function.
4016 PROPERTIES is the list of attributes attached to the element or
4017 object, as a plist. Although most of them are specific to the
4018 element or object type, all types share `:begin', `:end',
4019 `:post-blank' and `:parent' properties, which respectively
4020 refer to buffer position where the element or object starts,
4021 ends, the number of white spaces or blank lines after it, and
4022 the element or object containing it. Properties values can be
4023 obtained by using `org-element-property' function.
4025 CONTENTS is a list of elements, objects or raw strings
4026 contained in the current element or object, when applicable.
4027 One can access them with `org-element-contents' function.
4029 The Org buffer has `org-data' as type and nil as properties.
4030 `org-element-map' function can be used to find specific elements
4031 or objects within the parse tree.
4033 This function assumes that current major mode is `org-mode'."
4039 ;; Start in `first-section' mode so text before the first
4040 ;; headline belongs to a section.
4044 "Recursively parse objects in STRING and return structure.
4046 RESTRICTION is a symbol limiting the object types that will be
4047 looked after.
4049 Optional argument PARENT, when non-nil, is the element or object
4050 containing the secondary string. It is used to set correctly
4051 `:parent' property within the string."
4052 ;; Copy buffer-local variables listed in
4053 ;; `org-element-object-variables' into temporary buffer. This is
4054 ;; required since object parsing is dependent on these variables.
4058 org-element-object-variables))))
4066 secondary))
4067 secondary))))
4071 "Map a function on selected elements or objects.
4073 DATA is a parse tree, an element, an object, a string, or a list
4074 of such constructs. TYPES is a symbol or list of symbols of
4075 elements or objects types (see `org-element-all-elements' and
4076 `org-element-all-objects' for a complete list of types). FUN is
4077 the function called on the matching element or object. It has to
4078 accept one argument: the element or object itself.
4080 When optional argument INFO is non-nil, it should be a plist
4081 holding export options. In that case, parts of the parse tree
4082 not exportable according to that property list will be skipped.
4084 When optional argument FIRST-MATCH is non-nil, stop at the first
4085 match for which FUN doesn't return nil, and return that value.
4087 Optional argument NO-RECURSION is a symbol or a list of symbols
4088 representing elements or objects types. `org-element-map' won't
4089 enter any recursive element or object whose type belongs to that
4090 list. Though, FUN can still be applied on them.
4092 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4093 apply to matching objects within parsed affiliated keywords (see
4094 `org-element-parsed-keywords').
4096 Nil values returned from FUN do not appear in the results.
4099 Examples:
4100 ---------
4102 Assuming TREE is a variable containing an Org buffer parse tree,
4103 the following example will return a flat list of all `src-block'
4104 and `example-block' elements in it:
4106 \(org-element-map tree '(example-block src-block) 'identity)
4108 The following snippet will find the first headline with a level
4111 \(org-element-map tree 'headline
4112 \(lambda (hl)
4113 \(and (= (org-element-property :level hl) 1)
4115 \(org-element-property :begin hl)))
4116 nil t)
4118 The next example will return a flat list of all `plain-list' type
4119 elements in TREE that are not a sub-list themselves:
4121 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4123 Eventually, this example will return a flat list of all `bold'
4124 type objects containing a `latex-snippet' type object, even
4125 looking into captions:
4127 \(org-element-map tree 'bold
4128 \(lambda (b)
4129 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4130 nil nil nil t)"
4131 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4134 ;; Recursion depth is determined by --CATEGORY.
4141 ;; If one object is found, the function
4142 ;; has to recurse into every object.
4145 ;; If one regular element is found, the
4146 ;; function has to recurse, at least,
4147 ;; into every element it encounters.
4150 types)
4151 category)))
4152 ;; Compute properties for affiliated keywords if necessary.
4157 org-element-affiliated-keywords)))
4158 --acc
4159 --walk-tree
4163 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4164 ;; holding contextual information.
4168 ;; Ignored element in an export context.
4170 ;; List of elements or objects.
4172 ;; Unconditionally enter parse trees.
4176 ;; Check if TYPE is matching among TYPES. If so,
4177 ;; apply FUN to --DATA and accumulate return value
4178 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4184 ;; If --DATA has a secondary string that can contain
4185 ;; objects with their type among TYPES, look into it.
4192 ;; If --DATA has any affiliated keywords and
4193 ;; WITH-AFFILIATED is non-nil, look for objects in
4194 ;; them.
4202 ;; Pay attention to the type of value.
4203 ;; Preserve order for multiple keywords.
4219 --affiliated-alist))
4220 ;; Determine if a recursion into --DATA is possible.
4222 ;; --TYPE is explicitly removed from recursion.
4224 ;; --DATA has no contents.
4226 ;; Looking for greater elements but --DATA is simply
4227 ;; an element or an object.
4230 ;; Looking for elements but --DATA is an object.
4233 ;; In any other case, map contents.
4237 ;; Return value in a proper order.
4241 ;; The following functions are internal parts of the parser.
4242 ;;
4243 ;; The first one, `org-element--parse-elements' acts at the element's
4244 ;; level.
4245 ;;
4246 ;; The second one, `org-element--parse-objects' applies on all objects
4247 ;; of a paragraph or a secondary string. It uses
4248 ;; `org-element--get-next-object-candidates' to optimize the search of
4249 ;; the next object in the buffer.
4250 ;;
4251 ;; More precisely, that function looks for every allowed object type
4252 ;; first. Then, it discards failed searches, keeps further matches,
4253 ;; and searches again types matched behind point, for subsequent
4254 ;; calls. Thus, searching for a given type fails only once, and every
4255 ;; object is searched only once at top level (but sometimes more for
4256 ;; nested types).
4260 "Parse elements between BEG and END positions.
4262 SPECIAL prioritize some elements over the others. It can be set
4263 to `first-section', `quote-section', `section' `item' or
4264 `table-row'.
4266 When value is `item', STRUCTURE will be used as the current list
4267 structure.
4269 GRANULARITY determines the depth of the recursion. See
4270 `org-element-parse-buffer' for more information.
4272 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4273 elements.
4275 Elements are accumulated into ACC."
4278 ;; Visible only: skip invisible parts at the beginning of the
4279 ;; element.
4282 ;; When parsing only headlines, skip any text before first one.
4285 ;; Main loop start.
4287 ;; Find current element's type and parse it accordingly to
4288 ;; its category.
4290 end granularity special structure))
4294 ;; Visible only: skip invisible parts between siblings.
4297 ;; Fill ELEMENT contents by side-effect.
4299 ;; If element has no contents, don't modify it.
4301 ;; Greater element: parse it between `contents-begin' and
4302 ;; `contents-end'. Make sure GRANULARITY allows the
4303 ;; recursion, or ELEMENT is a headline, in which case going
4304 ;; inside is mandatory, in order to get sub-level headings.
4312 ;; Possibly switch to a special mode.
4322 granularity visible-only element))
4323 ;; ELEMENT has contents. Parse objects inside, if
4324 ;; GRANULARITY allows it.
4330 ;; Return result.
4331 acc))
4334 "Parse objects between BEG and END and return recursive structure.
4336 Objects are accumulated in ACC.
4338 RESTRICTION is a list of object successors which are allowed in
4339 the current object."
4348 restriction candidates)))
4355 ;; 1. Text before any object. Untabify it.
4360 acc
4364 ;; 2. Object...
4367 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4368 ;; a recursive type.
4376 ;; 3. Text after last object. Untabify it.
4380 acc
4384 ;; Result.
4385 acc))))
4388 "Return an alist of candidates for the next object.
4390 RESTRICTION is a list of object types, as symbols. Only
4391 candidates with such types are looked after.
4393 OBJECTS is the previous candidates alist. If it is set to
4394 `initial', no search has been done before, and all symbols in
4395 RESTRICTION should be looked after.
4397 Return value is an alist whose CAR is the object type and CDR its
4398 beginning position."
4400 nil
4402 ;; When searching for the first time, look for every successor
4403 ;; allowed in RESTRICTION.
4407 restriction)
4408 ;; Focus on objects returned during last search. Keep those
4409 ;; still after point. Search again objects before it.
4415 type)))
4418 objects))))
4421 \f
4422 ;;; Towards A Bijective Process
4423 ;;
4424 ;; The parse tree obtained with `org-element-parse-buffer' is really
4425 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4426 ;; interpreted and expanded into a string with canonical Org syntax.
4427 ;; Hence `org-element-interpret-data'.
4428 ;;
4429 ;; The function relies internally on
4430 ;; `org-element--interpret-affiliated-keywords'.
4432 ;;;###autoload
4434 "Interpret DATA as Org syntax.
4436 DATA is a parse tree, an element, an object or a secondary string
4437 to interpret.
4439 Optional argument PARENT is used for recursive calls. It contains
4440 the element or object containing data, or nil.
4442 Return Org syntax as a string."
4446 ;; Secondary string.
4451 ;; Full Org document.
4456 ;; Plain text: remove `:parent' text property from output.
4458 ;; Element/Object without contents.
4461 data nil))
4462 ;; Element/Object with contents.
4472 ;; Elements directly containing objects must
4473 ;; have their indentation normalized first.
4475 data
4476 ;; When normalizing first paragraph of an
4477 ;; item or a footnote-definition, ignore
4478 ;; first line's indentation.
4485 data
4487 contents)))))))
4489 ;; Build white spaces. If no `:post-blank' property is
4490 ;; specified, assume its value is 0.
4500 "Return ELEMENT's affiliated keywords as Org syntax.
4501 If there is no affiliated keyword, return the empty string."
4511 ": "
4514 value)
4522 ;; All attribute keywords can have multiple lines.
4528 ;; List all ELEMENT's properties matching an attribute line or an
4529 ;; affiliated keyword, but ignore translated keywords since they
4530 ;; cannot belong to the property list.
4537 org-element-keyword-translation-alist)))))
4538 collect prop)
4541 ;; Because interpretation of the parse tree must return the same
4542 ;; number of blank lines between elements and the same number of white
4543 ;; space after objects, some special care must be given to white
4544 ;; spaces.
4545 ;;
4546 ;; The first function, `org-element-normalize-string', ensures any
4547 ;; string different from the empty string will end with a single
4548 ;; newline character.
4549 ;;
4550 ;; The second function, `org-element-normalize-contents', removes
4551 ;; global indentation from the contents of the current element.
4554 "Ensure string S ends with a single newline character.
4556 If S isn't a string return it unchanged. If S is the empty
4557 string, return it. Otherwise, return a new string with a single
4558 newline character at its end."
4566 "Normalize plain text in ELEMENT's contents.
4568 ELEMENT must only contain plain text and objects.
4570 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4571 indentation to compute maximal common indentation.
4573 Return the normalized element that is element with global
4574 indentation removed from its contents. The function assumes that
4575 indentation is not done with TAB characters."
4577 collect-inds ; for byte-compiler
4580 ;; Return list of indentations within BLOB. This is done by
4581 ;; walking recursively BLOB and updating IND-LIST along the
4582 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4583 ;; been seen yet. It is required as this string is the only
4584 ;; one whose indentation doesn't happen after a newline
4585 ;; character.
4593 ;; An indentation of zero means no string will be
4594 ;; modified. Quit the process.
4600 ;; Avoid matching blank or empty lines.
4608 ;; Collect indentation list in ELEMENT. Possibly remove first
4609 ;; value if IGNORE-FIRST is non-nil.
4612 ;; Build ELEMENT back, replacing each string with the same
4613 ;; string minus common indentation.
4618 ;; Return BLOB with all its strings indentation
4619 ;; shortened from MCI white spaces. FIRST-FLAG is
4620 ;; non-nil when the first string hasn't been seen
4621 ;; yet.
4635 org-element-recursive-objects)
4639 blob))))
4643 \f
4644 ;;; The Toolbox
4645 ;;
4646 ;; The first move is to implement a way to obtain the smallest element
4647 ;; containing point. This is the job of `org-element-at-point'. It
4648 ;; basically jumps back to the beginning of section containing point
4649 ;; and moves, element after element, with
4650 ;; `org-element--current-element' until the container is found. Note:
4651 ;; When using `org-element-at-point', secondary values are never
4652 ;; parsed since the function focuses on elements, not on objects.
4653 ;;
4654 ;; At a deeper level, `org-element-context' lists all elements and
4655 ;; objects containing point.
4656 ;;
4657 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4658 ;; internally by navigation and manipulation tools.
4660 ;;;###autoload
4662 "Determine closest element around point.
4664 Return value is a list like (TYPE PROPS) where TYPE is the type
4665 of the element and PROPS a plist of properties associated to the
4666 element.
4668 Possible types are defined in `org-element-all-elements'.
4669 Properties depend on element or object type, but always include
4670 `:begin', `:end', `:parent' and `:post-blank' properties.
4672 As a special case, if point is at the very beginning of a list or
4673 sub-list, returned element will be that list instead of the first
4674 item. In the same way, if point is at the beginning of the first
4675 row of a table, returned element will be the table instead of the
4676 first row.
4678 If optional argument KEEP-TRAIL is non-nil, the function returns
4679 a list of elements leading to element at point. The list's CAR
4680 is always the element at point. The following positions contain
4681 element's siblings, then parents, siblings of parents, until the
4682 first element of current section."
4684 ;; If at a headline, parse it. It is the sole element that
4685 ;; doesn't require to know about context. Be sure to disallow
4686 ;; secondary string parsing, though.
4692 ;; Otherwise move at the beginning of the section containing
4693 ;; point.
4698 element type special-flag trail struct prevs parent)
4701 ;; In empty lines at buffer's beginning, return nil.
4710 ;; In blank lines just after the headline, point still
4711 ;; belongs to the headline.
4720 ;; Parse successively each element, skipping those ending
4721 ;; before original position.
4729 ;; 1. Skip any element ending before point. Also skip
4730 ;; element ending at point when we're sure that another
4731 ;; element has started.
4736 ;; 2. An element containing point is always the element at
4737 ;; point.
4740 ;; 3. At any other greater element type, if point is
4741 ;; within contents, move into it.
4746 ;; Create an anchor for tables and plain lists:
4747 ;; when point is at the very beginning of these
4748 ;; elements, ignoring affiliated keywords,
4749 ;; target them instead of their contents.
4751 ;; When point is at contents end, do not move
4752 ;; into elements with an explicit ending, but
4753 ;; return that element instead.
4757 drawer dynamic-block inlinetask
4758 property-drawer quote-block
4759 special-block))
4760 ;; Corner case: if a list ends at the
4761 ;; end of a buffer without a final new
4762 ;; line, return last element in last
4763 ;; item instead.
4781 ;;;###autoload
4783 "Return closest element or object around point.
4785 Return value is a list like (TYPE PROPS) where TYPE is the type
4786 of the element or object and PROPS a plist of properties
4787 associated to it.
4789 Possible types are defined in `org-element-all-elements' and
4790 `org-element-all-objects'. Properties depend on element or
4791 object type, but always include `:begin', `:end', `:parent' and
4792 `:post-blank'.
4794 Optional argument ELEMENT, when non-nil, is the closest element
4795 containing point, as returned by `org-element-at-point'.
4796 Providing it allows for quicker computation."
4802 context)
4803 ;; Check if point is inside an element containing objects or at
4804 ;; a secondary string. In that case, narrow buffer to the
4805 ;; containing area. Otherwise, return ELEMENT.
4807 ;; At a parsed affiliated keyword, check if we're inside main
4808 ;; or dual value.
4823 ;; Also change type to retrieve correct restrictions.
4825 ;; At an item, objects can only be located within tag, if any.
4835 ;; At an headline or inlinetask, objects are located within
4836 ;; their title.
4843 ;; At a paragraph, a table-row or a verse block, objects are
4844 ;; located within their contents.
4848 ;; CBEG is nil for table rules.
4852 ;; At a parsed keyword, objects are located within value.
4855 org-element-document-properties))
4870 restriction candidates))
4872 candidates)))
4873 ;; If ORIGIN is before next object in element, there's
4874 ;; no point in looking further.
4884 ;; ORIGIN is after OBJECT, so skip it.
4886 ;; ORIGIN is within a non-recursive object or at
4887 ;; an object boundaries: Return that object.
4891 ;; Otherwise, move within current object and
4892 ;; restrict search to the end of its contents.
4899 parent))))))
4902 "Non-nil when elements ELEM-A and ELEM-B are nested."
4911 "Swap elements ELEM-A and ELEM-B.
4912 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4913 end of ELEM-A."
4915 ;; There are two special cases when an element doesn't start at bol:
4916 ;; the first paragraph in an item or in a footnote definition.
4918 ;; Only a paragraph without any affiliated keyword can be moved at
4919 ;; ELEM-A position in such a situation. Note that the case of
4920 ;; a footnote definition is impossible: it cannot contain two
4921 ;; paragraphs in a row because it cannot contain a blank line.
4927 ;; In a special situation, ELEM-A will have no indentation. We'll
4928 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4942 ;; Store overlays responsible for visibility status. We
4943 ;; also need to store their boundaries as they will be
4944 ;; removed from buffer.
4951 ;; Get contents.
4959 ;; Restore ex ELEM-A overlays.
4968 ;; Restore ex ELEM-B overlays.
4977 ;; Local variables:
4978 ;; generated-autoload-file: "org-loaddefs.el"
4979 ;; End:
4981 ;;; org-element.el ends here