| blob | ba2461a9e3a1129452802f09c528ff1e2d13ec71 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1127 ;; Compute indentation.
1132 ;; Indent contents.
1134 bullet
1147 ;;;; Plain List
1150 "Parse a plain list.
1152 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1153 the buffer position at the beginning of the first affiliated
1154 keyword and CDR is a plist of affiliated keywords along with
1155 their value. STRUCTURE is the structure of the plain list being
1156 parsed.
1158 Return a list whose CAR is `plain-list' and CDR is a plist
1159 containing `:type', `:begin', `:end', `:contents-begin' and
1160 `:contents-end', `:structure', `:post-blank' and
1161 `:post-affiliated' keywords.
1163 Assume point is at the beginning of the list."
1178 ;; Return value.
1182 :begin begin
1183 :end end
1184 :contents-begin contents-begin
1185 :contents-end contents-end
1186 :structure struct
1192 "Interpret PLAIN-LIST element as Org syntax.
1193 CONTENTS is the contents of the element."
1201 ;;;; Property Drawer
1204 "Parse a property drawer.
1206 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1207 the buffer position at the beginning of the first affiliated
1208 keyword and CDR is a plist of affiliated keywords along with
1209 their value.
1211 Return a list whose CAR is `property-drawer' and CDR is a plist
1212 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1213 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1215 Assume point is at the beginning of the property drawer."
1220 ;; Incomplete drawer: parse it as a paragraph.
1240 :end end
1241 :hiddenp hidden
1242 :contents-begin contents-begin
1243 :contents-end contents-end
1249 "Interpret PROPERTY-DRAWER element as Org syntax.
1250 CONTENTS is the properties within the drawer."
1254 ;;;; Quote Block
1257 "Parse a quote block.
1259 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1260 the buffer position at the beginning of the first affiliated
1261 keyword and CDR is a plist of affiliated keywords along with
1262 their value.
1264 Return a list whose CAR is `quote-block' and CDR is a plist
1265 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1266 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1268 Assume point is at the beginning of the block."
1272 ;; Incomplete block: parse it as a paragraph.
1278 ;; Empty blocks have no contents.
1293 :end end
1294 :hiddenp hidden
1295 :contents-begin contents-begin
1296 :contents-end contents-end
1302 "Interpret QUOTE-BLOCK element as Org syntax.
1303 CONTENTS is the contents of the element."
1307 ;;;; Section
1310 "Parse a section.
1312 LIMIT bounds the search.
1314 Return a list whose CAR is `section' and CDR is a plist
1315 containing `:begin', `:end', `:contents-begin', `contents-end'
1316 and `:post-blank' keywords."
1318 ;; Beginning of section is the beginning of the first non-blank
1319 ;; line after previous headline.
1328 :end end
1329 :contents-begin begin
1330 :contents-end pos-before-blank
1334 "Interpret SECTION element as Org syntax.
1335 CONTENTS is the contents of the element."
1336 contents)
1339 ;;;; Special Block
1342 "Parse a special block.
1344 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1345 the buffer position at the beginning of the first affiliated
1346 keyword and CDR is a plist of affiliated keywords along with
1347 their value.
1349 Return a list whose CAR is `special-block' and CDR is a plist
1350 containing `:type', `:begin', `:end', `:hiddenp',
1351 `:contents-begin', `:contents-end', `:post-blank' and
1352 `:post-affiliated' keywords.
1354 Assume point is at the beginning of the block."
1361 ;; Incomplete block: parse it as a paragraph.
1367 ;; Empty blocks have no contents.
1382 :begin begin
1383 :end end
1384 :hiddenp hidden
1385 :contents-begin contents-begin
1386 :contents-end contents-end
1392 "Interpret SPECIAL-BLOCK element as Org syntax.
1393 CONTENTS is the contents of the element."
1398 \f
1399 ;;; Elements
1400 ;;
1401 ;; For each element, a parser and an interpreter are also defined.
1402 ;; Both follow the same naming convention used for greater elements.
1403 ;;
1404 ;; Also, as for greater elements, adding a new element type is done
1405 ;; through the following steps: implement a parser and an interpreter,
1406 ;; tweak `org-element--current-element' so that it recognizes the new
1407 ;; type and add that new type to `org-element-all-elements'.
1408 ;;
1409 ;; As a special case, when the newly defined type is a block type,
1410 ;; `org-element-block-name-alist' has to be modified accordingly.
1413 ;;;; Babel Call
1416 "Parse a babel call.
1418 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1419 the buffer position at the beginning of the first affiliated
1420 keyword and CDR is a plist of affiliated keywords along with
1421 their value.
1423 Return a list whose CAR is `babel-call' and CDR is a plist
1424 containing `:begin', `:end', `:info', `:post-blank' and
1425 `:post-affiliated' as keywords."
1439 :end end
1440 :info info
1446 "Interpret BABEL-CALL element as Org syntax.
1447 CONTENTS is nil."
1453 ;; Remove redundant square brackets.
1458 ;;;; Clock
1461 "Parse a clock.
1463 LIMIT bounds the search.
1465 Return a list whose CAR is `clock' and CDR is a plist containing
1466 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1467 as keywords."
1487 :value value
1488 :duration duration
1489 :begin begin
1490 :end end
1494 "Interpret CLOCK element as Org syntax.
1495 CONTENTS is nil."
1503 "%2s:%02s"
1507 ;;;; Comment
1510 "Parse a comment.
1512 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1513 the buffer position at the beginning of the first affiliated
1514 keyword and CDR is a plist of affiliated keywords along with
1515 their value.
1517 Return a list whose CAR is `comment' and CDR is a plist
1518 containing `:begin', `:end', `:value', `:post-blank',
1519 `:post-affiliated' keywords.
1521 Assume point is at comment beginning."
1530 ;; Get comments ending.
1533 ;; Accumulate lines without leading hash and first
1534 ;; whitespace.
1549 :end end
1550 :value value
1556 "Interpret COMMENT element as Org syntax.
1557 CONTENTS is nil."
1561 ;;;; Comment Block
1564 "Parse an export block.
1566 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1567 the buffer position at the beginning of the first affiliated
1568 keyword and CDR is a plist of affiliated keywords along with
1569 their value.
1571 Return a list whose CAR is `comment-block' and CDR is a plist
1572 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1573 and `:post-affiliated' keywords.
1575 Assume point is at comment block beginning."
1579 ;; Incomplete block: parse it as a paragraph.
1594 contents-begin contents-end)))
1598 :end end
1599 :value value
1600 :hiddenp hidden
1606 "Interpret COMMENT-BLOCK element as Org syntax.
1607 CONTENTS is nil."
1612 ;;;; Diary Sexp
1615 "Parse a diary sexp.
1617 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1618 the buffer position at the beginning of the first affiliated
1619 keyword and CDR is a plist of affiliated keywords along with
1620 their value.
1622 Return a list whose CAR is `diary-sexp' and CDR is a plist
1623 containing `:begin', `:end', `:value', `:post-blank' and
1624 `:post-affiliated' keywords."
1637 :begin begin
1638 :end end
1644 "Interpret DIARY-SEXP as Org syntax.
1645 CONTENTS is nil."
1649 ;;;; Example Block
1652 "Parse an example block.
1654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and CDR is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose CAR is `example-block' and CDR is a plist
1660 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1661 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1662 `:switches', `:value', `:post-blank' and `:post-affiliated'
1663 keywords."
1667 ;; Incomplete block: parse it as a paragraph.
1674 ;; Switches analysis
1679 ;; Should labels be retained in (or stripped from) example
1680 ;; blocks?
1685 ;; What should code-references use - labels or
1686 ;; line-numbers?
1693 ;; Standard block parsing.
1700 contents-begin contents-end)))
1710 :end end
1711 :value value
1712 :switches switches
1713 :number-lines number-lines
1714 :preserve-indent preserve-indent
1715 :retain-labels retain-labels
1716 :use-labels use-labels
1717 :label-fmt label-fmt
1718 :hiddenp hidden
1724 "Interpret EXAMPLE-BLOCK element as Org syntax.
1725 CONTENTS is nil."
1734 ;;;; Export Block
1737 "Parse an export block.
1739 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1740 the buffer position at the beginning of the first affiliated
1741 keyword and CDR is a plist of affiliated keywords along with
1742 their value.
1744 Return a list whose CAR is `export-block' and CDR is a plist
1745 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1746 `:post-blank' and `:post-affiliated' keywords.
1748 Assume point is at export-block beginning."
1755 ;; Incomplete block: parse it as a paragraph.
1770 contents-end)))
1774 :end end
1775 :type type
1776 :value value
1777 :hiddenp hidden
1783 "Interpret EXPORT-BLOCK element as Org syntax.
1784 CONTENTS is nil."
1791 ;;;; Fixed-width
1794 "Parse a fixed-width section.
1796 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1797 the buffer position at the beginning of the first affiliated
1798 keyword and CDR is a plist of affiliated keywords along with
1799 their value.
1801 Return a list whose CAR is `fixed-width' and CDR is a plist
1802 containing `:begin', `:end', `:value', `:post-blank' and
1803 `:post-affiliated' keywords.
1805 Assume point is at the beginning of the fixed-width area."
1809 value
1814 ;; Accumulate text without starting colons.
1828 :end end
1829 :value value
1835 "Interpret FIXED-WIDTH element as Org syntax.
1836 CONTENTS is nil."
1841 ;;;; Horizontal Rule
1844 "Parse an horizontal rule.
1846 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1847 the buffer position at the beginning of the first affiliated
1848 keyword and CDR is a plist of affiliated keywords along with
1849 their value.
1851 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1852 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1853 keywords."
1864 :end end
1870 "Interpret HORIZONTAL-RULE element as Org syntax.
1871 CONTENTS is nil."
1875 ;;;; Keyword
1878 "Parse a keyword at point.
1880 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1881 the buffer position at the beginning of the first affiliated
1882 keyword and CDR is a plist of affiliated keywords along with
1883 their value.
1885 Return a list whose CAR is `keyword' and CDR is a plist
1886 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1887 `:post-affiliated' keywords."
1902 :value value
1903 :begin begin
1904 :end end
1910 "Interpret KEYWORD element as Org syntax.
1911 CONTENTS is nil."
1917 ;;;; Latex Environment
1920 "Parse a LaTeX environment.
1922 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1923 the buffer position at the beginning of the first affiliated
1924 keyword and CDR is a plist of affiliated keywords along with
1925 their value.
1927 Return a list whose CAR is `latex-environment' and CDR is a plist
1928 containing `:begin', `:end', `:value', `:post-blank' and
1929 `:post-affiliated' keywords.
1931 Assume point is at the beginning of the latex environment."
1938 limit t))
1939 ;; Incomplete latex environment: parse it as a paragraph.
1950 :end end
1951 :value value
1957 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1958 CONTENTS is nil."
1962 ;;;; Node Property
1965 "Parse a node-property at point.
1967 LIMIT bounds the search.
1969 Return a list whose CAR is `node-property' and CDR is a plist
1970 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1971 keywords."
1983 :value value
1984 :begin begin
1985 :end end
1989 "Interpret NODE-PROPERTY element as Org syntax.
1990 CONTENTS is nil."
1996 ;;;; Paragraph
1999 "Parse a paragraph.
2001 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2002 the buffer position at the beginning of the first affiliated
2003 keyword and CDR is a plist of affiliated keywords along with
2004 their value.
2006 Return a list whose CAR is `paragraph' and CDR is a plist
2007 containing `:begin', `:end', `:contents-begin' and
2008 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2010 Assume point is at the beginning of the paragraph."
2019 limit
2020 ;; A matching `org-element-paragraph-separate' is not
2021 ;; necessarily the end of the paragraph. In
2022 ;; particular, lines starting with # or : as a first
2023 ;; non-space character are ambiguous. We have check
2024 ;; if they are valid Org syntax (i.e. not an
2025 ;; incomplete keyword).
2029 ;; There's no ambiguity for other symbols or
2030 ;; empty lines: stop here.
2032 ;; Stop at valid fixed-width areas.
2034 ;; Stop at drawers.
2039 ;; Stop at valid comments.
2041 ;; Stop at valid dynamic blocks.
2046 ;; Stop at valid blocks.
2053 limit t)))
2054 ;; Stop at valid latex environments.
2061 limit t)))
2062 ;; Stop at valid keywords.
2064 ;; Skip everything else.
2082 :end end
2083 :contents-begin contents-begin
2084 :contents-end contents-end
2090 "Interpret PARAGRAPH element as Org syntax.
2091 CONTENTS is the contents of the element."
2092 contents)
2095 ;;;; Planning
2098 "Parse a planning.
2100 LIMIT bounds the search.
2102 Return a list whose CAR is `planning' and CDR is a plist
2103 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2104 and `:post-blank' keywords."
2114 closed deadline scheduled)
2126 :deadline deadline
2127 :scheduled scheduled
2128 :begin begin
2129 :end end
2133 "Interpret PLANNING element as Org syntax.
2134 CONTENTS is nil."
2136 'identity
2153 ;;;; Quote Section
2156 "Parse a quote section.
2158 LIMIT bounds the search.
2160 Return a list whose CAR is `quote-section' and CDR is a plist
2161 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2163 Assume point is at beginning of the section."
2174 :end end
2175 :value value
2179 "Interpret QUOTE-SECTION element as Org syntax.
2180 CONTENTS is nil."
2184 ;;;; Src Block
2187 "Parse a src block.
2189 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2190 the buffer position at the beginning of the first affiliated
2191 keyword and CDR is a plist of affiliated keywords along with
2192 their value.
2194 Return a list whose CAR is `src-block' and CDR is a plist
2195 containing `:language', `:switches', `:parameters', `:begin',
2196 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2197 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2198 `:post-blank' and `:post-affiliated' keywords.
2200 Assume point is at the beginning of the block."
2203 limit t)))
2204 ;; Incomplete block: parse it as a paragraph.
2210 ;; Get language as a string.
2219 ;; Get switches.
2221 ;; Get parameters.
2223 ;; Switches analysis
2231 ;; Should labels be retained in (or stripped from)
2232 ;; src blocks?
2237 ;; What should code-references use - labels or
2238 ;; line-numbers?
2242 ;; Get visibility status.
2244 ;; Retrieve code.
2250 ;; Get position after ending blank lines.
2261 :begin begin
2262 :end end
2263 :number-lines number-lines
2264 :preserve-indent preserve-indent
2265 :retain-labels retain-labels
2266 :use-labels use-labels
2267 :label-fmt label-fmt
2268 :hiddenp hidden
2269 :value value
2275 "Interpret SRC-BLOCK element as Org syntax.
2276 CONTENTS is nil."
2299 ;;;; Table
2302 "Parse a table at point.
2304 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2305 the buffer position at the beginning of the first affiliated
2306 keyword and CDR is a plist of affiliated keywords along with
2307 their value.
2309 Return a list whose CAR is `table' and CDR is a plist containing
2310 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2311 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2312 keywords.
2314 Assume point is at the beginning of the table."
2328 acc))
2336 :end end
2337 :type type
2338 :tblfm tblfm
2339 ;; Only `org' tables have contents. `table.el' tables
2340 ;; use a `:value' property to store raw table as
2341 ;; a string.
2346 table-begin table-end))
2352 "Interpret TABLE element as Org syntax.
2353 CONTENTS is nil."
2364 ;;;; Table Row
2367 "Parse table row at point.
2369 LIMIT bounds the search.
2371 Return a list whose CAR is `table-row' and CDR is a plist
2372 containing `:begin', `:end', `:contents-begin', `:contents-end',
2373 `:type' and `:post-blank' keywords."
2377 ;; A table rule has no contents. In that case, ensure
2378 ;; CONTENTS-BEGIN matches CONTENTS-END.
2390 :begin begin
2391 :end end
2392 :contents-begin contents-begin
2393 :contents-end contents-end
2397 "Interpret TABLE-ROW element as Org syntax.
2398 CONTENTS is the contents of the table row."
2403 ;;;; Verse Block
2406 "Parse a verse block.
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 `verse-block' and CDR is a plist
2414 containing `:begin', `:end', `:contents-begin', `:contents-end',
2415 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2417 Assume point is at beginning of the block."
2421 ;; Incomplete block: parse it as a paragraph.
2438 :end end
2439 :contents-begin contents-begin
2440 :contents-end contents-end
2441 :hiddenp hidden
2447 "Interpret VERSE-BLOCK element as Org syntax.
2448 CONTENTS is verse block contents."
2452 \f
2453 ;;; Objects
2454 ;;
2455 ;; Unlike to elements, interstices can be found between objects.
2456 ;; That's why, along with the parser, successor functions are provided
2457 ;; for each object. Some objects share the same successor (i.e. `code'
2458 ;; and `verbatim' objects).
2459 ;;
2460 ;; A successor must accept a single argument bounding the search. It
2461 ;; will return either a cons cell whose CAR is the object's type, as
2462 ;; a symbol, and CDR the position of its next occurrence, or nil.
2463 ;;
2464 ;; Successors follow the naming convention:
2465 ;; org-element-NAME-successor, where NAME is the name of the
2466 ;; successor, as defined in `org-element-all-successors'.
2467 ;;
2468 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2469 ;; object types they can contain will be specified in
2470 ;; `org-element-object-restrictions'.
2471 ;;
2472 ;; Adding a new type of object is simple. Implement a successor,
2473 ;; a parser, and an interpreter for it, all following the naming
2474 ;; convention. Register type in `org-element-all-objects' and
2475 ;; successor in `org-element-all-successors'. Maybe tweak
2476 ;; restrictions about it, and that's it.
2479 ;;;; Bold
2482 "Parse bold object at point.
2484 Return a list whose CAR is `bold' and CDR is a plist with
2485 `:begin', `:end', `:contents-begin' and `:contents-end' and
2486 `:post-blank' keywords.
2488 Assume point is at the first star marker."
2500 :end end
2501 :contents-begin contents-begin
2502 :contents-end contents-end
2506 "Interpret BOLD object as Org syntax.
2507 CONTENTS is the contents of the object."
2511 "Search for the next text-markup object.
2513 LIMIT bounds the search.
2515 Return value is a cons cell whose CAR is a symbol among `bold',
2516 `italic', `underline', `strike-through', `code' and `verbatim'
2517 and CDR is beginning position."
2533 ;;;; Code
2536 "Parse code object at point.
2538 Return a list whose CAR is `code' and CDR is a plist with
2539 `:value', `:begin', `:end' and `:post-blank' keywords.
2541 Assume point is at the first tilde marker."
2552 :begin begin
2553 :end end
2557 "Interpret CODE object as Org syntax.
2558 CONTENTS is nil."
2562 ;;;; Entity
2565 "Parse entity at point.
2567 Return a list whose CAR is `entity' and CDR a plist with
2568 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2569 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2570 keywords.
2572 Assume point is at the beginning of the entity."
2574 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2590 :begin begin
2591 :end end
2592 :use-brackets-p bracketsp
2596 "Interpret ENTITY object as Org syntax.
2597 CONTENTS is nil."
2603 "Search for the next latex-fragment or entity object.
2605 LIMIT bounds the search.
2607 Return value is a cons cell whose CAR is `entity' or
2608 `latex-fragment' and CDR is beginning position."
2613 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2620 limit t)
2623 ;; Determine if it's a real entity or a LaTeX command.
2626 ;; No entity nor command: point is at a LaTeX fragment.
2627 ;; Determine its type to get the correct beginning position.
2635 matchers)
2639 ;;;; Export Snippet
2642 "Parse export snippet at point.
2644 Return a list whose CAR is `export-snippet' and CDR a plist with
2645 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2646 keywords.
2648 Assume point is at the beginning of the snippet."
2660 :value value
2661 :begin begin
2662 :end end
2666 "Interpret EXPORT-SNIPPET object as Org syntax.
2667 CONTENTS is nil."
2673 "Search for the next export-snippet object.
2675 LIMIT bounds the search.
2677 Return value is a cons cell whose CAR is `export-snippet' and CDR
2678 its beginning position."
2687 ;;;; Footnote Reference
2690 "Parse footnote reference at point.
2692 Return a list whose CAR is `footnote-reference' and CDR a plist
2693 with `:label', `:type', `:inline-definition', `:begin', `:end'
2694 and `:post-blank' as keywords."
2716 :type type
2717 :begin begin
2718 :end end
2721 footnote-reference :inline-definition
2726 footnote-reference))))))
2729 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2730 CONTENTS is nil."
2740 "Search for the next footnote-reference object.
2742 LIMIT bounds the search.
2744 Return value is a cons cell whose CAR is `footnote-reference' and
2745 CDR is beginning position."
2759 ;;;; Inline Babel Call
2762 "Parse inline babel call at point.
2764 Return a list whose CAR is `inline-babel-call' and CDR a plist
2765 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2767 Assume point is at the beginning of the babel call."
2778 :end end
2779 :info info
2783 "Interpret INLINE-BABEL-CALL object as Org syntax.
2784 CONTENTS is nil."
2790 ;; Remove redundant square brackets.
2793 main-source)
2797 "Search for the next inline-babel-call object.
2799 LIMIT bounds the search.
2801 Return value is a cons cell whose CAR is `inline-babel-call' and
2802 CDR is beginning position."
2804 ;; Use a simplified version of
2805 ;; `org-babel-inline-lob-one-liner-regexp'.
2808 limit t)
2812 ;;;; Inline Src Block
2815 "Parse inline source block at point.
2817 LIMIT bounds the search.
2819 Return a list whose CAR is `inline-src-block' and CDR a plist
2820 with `:begin', `:end', `:language', `:value', `:parameters' and
2821 `:post-blank' as keywords.
2823 Assume point is at the beginning of the inline src block."
2836 :value value
2837 :parameters parameters
2838 :begin begin
2839 :end end
2843 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2844 CONTENTS is nil."
2849 language
2851 body)))
2854 "Search for the next inline-babel-call element.
2856 LIMIT bounds the search.
2858 Return value is a cons cell whose CAR is `inline-babel-call' and
2859 CDR is beginning position."
2865 ;;;; Italic
2868 "Parse italic object at point.
2870 Return a list whose CAR is `italic' and CDR is a plist with
2871 `:begin', `:end', `:contents-begin' and `:contents-end' and
2872 `:post-blank' keywords.
2874 Assume point is at the first slash marker."
2886 :end end
2887 :contents-begin contents-begin
2888 :contents-end contents-end
2892 "Interpret ITALIC object as Org syntax.
2893 CONTENTS is the contents of the object."
2897 ;;;; Latex Fragment
2900 "Parse latex fragment at point.
2902 Return a list whose CAR is `latex-fragment' and CDR a plist with
2903 `:value', `:begin', `:end', and `:post-blank' as keywords.
2905 Assume point is at the beginning of the latex fragment."
2919 ;; None found: it's a macro.
2928 :begin begin
2929 :end end
2933 "Interpret LATEX-FRAGMENT object as Org syntax.
2934 CONTENTS is nil."
2937 ;;;; Line Break
2940 "Parse line break at point.
2942 Return a list whose CAR is `line-break', and CDR a plist with
2943 `:begin', `:end' and `:post-blank' keywords.
2945 Assume point is at the beginning of the line break."
2952 "Interpret LINE-BREAK object as Org syntax.
2953 CONTENTS is nil."
2957 "Search for the next line-break object.
2959 LIMIT bounds the search.
2961 Return value is a cons cell whose CAR is `line-break' and CDR is
2962 beginning position."
2966 ;; A line break can only happen on a non-empty line.
2971 ;;;; Link
2974 "Parse link at point.
2976 Return a list whose CAR is `link' and CDR a plist with `:type',
2977 `:path', `:raw-link', `:application', `:search-option', `:begin',
2978 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2979 keywords.
2981 Assume point is at the beginning of the link."
2984 end contents-begin contents-end link-end post-blank path type
2985 raw-link link search-option application)
2987 ;; Type 1: Text targeted from a radio target.
2992 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2997 ;; RAW-LINK is the original link. Expand any
2998 ;; abbreviation in it.
3003 ;; Determine TYPE of link and set PATH accordingly.
3005 ;; File type.
3008 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3011 ;; Id type: PATH is the id.
3014 ;; Code-ref type: PATH is the name of the reference.
3017 ;; Custom-id type: PATH is the name of the custom id.
3020 ;; Fuzzy type: Internal link either matches a target, an
3021 ;; headline name or nothing. PATH is the target or
3022 ;; headline's name.
3024 ;; Type 3: Plain link, i.e. http://orgmode.org
3030 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3037 ;; In any case, deduce end point after trailing white space from
3038 ;; LINK-END variable.
3041 ;; Extract search option and opening application out of
3042 ;; "file"-type links.
3044 ;; Application.
3049 ;; Extract search option from PATH.
3053 ;; Make sure TYPE always report "file".
3057 :path path
3059 :application application
3060 :search-option search-option
3061 :begin begin
3062 :end end
3063 :contents-begin contents-begin
3064 :contents-end contents-end
3068 "Interpret LINK object as Org syntax.
3069 CONTENTS is the contents of the object, or nil."
3074 raw-link
3078 "Search for the next link object.
3080 LIMIT bounds the search.
3082 Return value is a cons cell whose CAR is `link' and CDR is
3083 beginning position."
3092 "Search for the next plain link object.
3094 LIMIT bounds the search.
3096 Return value is a cons cell whose CAR is `link' and CDR is
3097 beginning position."
3102 ;;;; Macro
3105 "Parse macro at point.
3107 Return a list whose CAR is `macro' and CDR a plist with `:key',
3108 `:args', `:begin', `:end', `:value' and `:post-blank' as
3109 keywords.
3111 Assume point is at the macro."
3122 ;; Do not use `org-split-string' since empty
3123 ;; strings are meaningful here.
3127 ;; Repair bad splits, when comma is protected,
3128 ;; and thus not a real separator.
3136 :value value
3137 :args args
3138 :begin begin
3139 :end end
3143 "Interpret MACRO object as Org syntax.
3144 CONTENTS is nil."
3148 "Search for the next macro object.
3150 LIMIT bounds the search.
3152 Return value is cons cell whose CAR is `macro' and CDR is
3153 beginning position."
3157 limit t)
3161 ;;;; Radio-target
3164 "Parse radio target at point.
3166 Return a list whose CAR is `radio-target' and CDR a plist with
3167 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3168 and `:post-blank' as keywords.
3170 Assume point is at the radio target."
3182 :end end
3183 :contents-begin contents-begin
3184 :contents-end contents-end
3185 :post-blank post-blank
3189 "Interpret TARGET object as Org syntax.
3190 CONTENTS is the contents of the object."
3194 "Search for the next radio-target object.
3196 LIMIT bounds the search.
3198 Return value is a cons cell whose CAR is `radio-target' and CDR
3199 is beginning position."
3205 ;;;; Statistics Cookie
3208 "Parse statistics cookie at point.
3210 Return a list whose CAR is `statistics-cookie', and CDR a plist
3211 with `:begin', `:end', `:value' and `:post-blank' keywords.
3213 Assume point is at the beginning of the statistics-cookie."
3224 :end end
3225 :value value
3229 "Interpret STATISTICS-COOKIE object as Org syntax.
3230 CONTENTS is nil."
3234 "Search for the next statistics cookie object.
3236 LIMIT bounds the search.
3238 Return value is a cons cell whose CAR is `statistics-cookie' and
3239 CDR is beginning position."
3245 ;;;; Strike-Through
3248 "Parse strike-through object at point.
3250 Return a list whose CAR is `strike-through' and CDR is a plist
3251 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3252 `:post-blank' keywords.
3254 Assume point is at the first plus sign marker."
3266 :end end
3267 :contents-begin contents-begin
3268 :contents-end contents-end
3272 "Interpret STRIKE-THROUGH object as Org syntax.
3273 CONTENTS is the contents of the object."
3277 ;;;; Subscript
3280 "Parse subscript at point.
3282 Return a list whose CAR is `subscript' and CDR a plist with
3283 `:begin', `:end', `:contents-begin', `:contents-end',
3284 `:use-brackets-p' and `:post-blank' as keywords.
3286 Assume point is at the underscore."
3290 t
3301 :end end
3302 :use-brackets-p bracketsp
3303 :contents-begin contents-begin
3304 :contents-end contents-end
3308 "Interpret SUBSCRIPT object as Org syntax.
3309 CONTENTS is the contents of the object."
3312 contents))
3315 "Search for the next sub/superscript object.
3317 LIMIT bounds the search.
3319 Return value is a cons cell whose CAR is either `subscript' or
3320 `superscript' and CDR is beginning position."
3328 ;;;; Superscript
3331 "Parse superscript at point.
3333 Return a list whose CAR is `superscript' and CDR a plist with
3334 `:begin', `:end', `:contents-begin', `:contents-end',
3335 `:use-brackets-p' and `:post-blank' as keywords.
3337 Assume point is at the caret."
3351 :end end
3352 :use-brackets-p bracketsp
3353 :contents-begin contents-begin
3354 :contents-end contents-end
3358 "Interpret SUPERSCRIPT object as Org syntax.
3359 CONTENTS is the contents of the object."
3362 contents))
3365 ;;;; Table Cell
3368 "Parse table cell at point.
3370 Return a list whose CAR is `table-cell' and CDR is a plist
3371 containing `:begin', `:end', `:contents-begin', `:contents-end'
3372 and `:post-blank' keywords."
3380 :end end
3381 :contents-begin contents-begin
3382 :contents-end contents-end
3386 "Interpret TABLE-CELL element as Org syntax.
3387 CONTENTS is the contents of the cell, or nil."
3391 "Search for the next table-cell object.
3393 LIMIT bounds the search.
3395 Return value is a cons cell whose CAR is `table-cell' and CDR is
3396 beginning position."
3400 ;;;; Target
3403 "Parse target at point.
3405 Return a list whose CAR is `target' and CDR a plist with
3406 `:begin', `:end', `:value' and `:post-blank' as keywords.
3408 Assume point is at the target."
3418 :end end
3419 :value value
3423 "Interpret TARGET object as Org syntax.
3424 CONTENTS is nil."
3428 "Search for the next target object.
3430 LIMIT bounds the search.
3432 Return value is a cons cell whose CAR is `target' and CDR is
3433 beginning position."
3439 ;;;; Timestamp
3442 "Parse time stamp at point.
3444 Return a list whose CAR is `timestamp', and CDR a plist with
3445 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3447 Assume point is at the beginning of the timestamp."
3465 date-start)
3476 raw-value)
3478 :repeater-type
3484 :repeater-unit
3487 year-start month-start day-start hour-start minute-start year-end
3488 month-end day-end hour-end minute-end)
3489 ;; Parse date-start.
3497 ;; Compute date-end. It can be provided directly in time-stamp,
3498 ;; or extracted from time range. Otherwise, it defaults to the
3499 ;; same values as date-start.
3509 :raw-value raw-value
3510 :year-start year-start
3511 :month-start month-start
3512 :day-start day-start
3513 :hour-start hour-start
3514 :minute-start minute-start
3515 :year-end year-end
3516 :month-end month-end
3517 :day-end day-end
3518 :hour-end hour-end
3519 :minute-end minute-end
3520 :begin begin
3521 :end end
3523 repeater-props)))))
3526 "Interpret TIMESTAMP object as Org syntax.
3527 CONTENTS is nil."
3528 ;; Use `:raw-value' if specified.
3530 ;; Otherwise, build timestamp string.
3540 ;; Build an Org timestamp string from TIME. ACTIVEP is
3541 ;; non-nil when time stamp is active. If WITH-TIME-P is
3542 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3543 ;; specify a time range in the timestamp. REPEAT-STRING
3544 ;; is the repeater string, if any.
3548 org-time-stamp-formats)
3549 time)))
3555 nil nil ts)))
3559 " "
3560 repeat-string
3562 ;; Return value.
3563 ts)))
3575 build-ts-string
3594 0
3602 "--"
3614 "Search for the next timestamp object.
3616 LIMIT bounds the search.
3618 Return value is a cons cell whose CAR is `timestamp' and CDR is
3619 beginning position."
3627 limit t)
3631 ;;;; Underline
3634 "Parse underline object at point.
3636 Return a list whose CAR is `underline' and CDR is a plist with
3637 `:begin', `:end', `:contents-begin' and `:contents-end' and
3638 `:post-blank' keywords.
3640 Assume point is at the first underscore marker."
3652 :end end
3653 :contents-begin contents-begin
3654 :contents-end contents-end
3658 "Interpret UNDERLINE object as Org syntax.
3659 CONTENTS is the contents of the object."
3663 ;;;; Verbatim
3666 "Parse verbatim object at point.
3668 Return a list whose CAR is `verbatim' and CDR is a plist with
3669 `:value', `:begin', `:end' and `:post-blank' keywords.
3671 Assume point is at the first equal sign marker."
3682 :begin begin
3683 :end end
3687 "Interpret VERBATIM object as Org syntax.
3688 CONTENTS is nil."
3692 \f
3693 ;;; Parsing Element Starting At Point
3694 ;;
3695 ;; `org-element--current-element' is the core function of this section.
3696 ;; It returns the Lisp representation of the element starting at
3697 ;; point.
3698 ;;
3699 ;; `org-element--current-element' makes use of special modes. They
3700 ;; are activated for fixed element chaining (i.e. `plain-list' >
3701 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3702 ;; `section'). Special modes are: `first-section', `item',
3703 ;; `node-property', `quote-section', `section' and `table-row'.
3707 "Parse the element starting at point.
3709 LIMIT bounds the search.
3711 Return value is a list like (TYPE PROPS) where TYPE is the type
3712 of the element and PROPS a plist of properties associated to the
3713 element.
3715 Possible types are defined in `org-element-all-elements'.
3717 Optional argument GRANULARITY determines the depth of the
3718 recursion. Allowed values are `headline', `greater-element',
3719 `element', `object' or nil. When it is broader than `object' (or
3720 nil), secondary values will not be parsed, since they only
3721 contain objects.
3723 Optional argument SPECIAL, when non-nil, can be either
3724 `first-section', `item', `node-property', `quote-section',
3725 `section', and `table-row'.
3727 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3728 be computed.
3730 This function assumes point is always at the beginning of the
3731 element it has to parse."
3734 ;; Determine if parsing depth allows for secondary strings
3735 ;; parsing. It only applies to elements referenced in
3736 ;; `org-element-secondary-value-alist'.
3739 ;; Item.
3742 ;; Table Row.
3744 ;; Node Property.
3746 ;; Headline.
3749 ;; Sections (must be checked after headline).
3755 limit)))
3756 ;; When not at bol, point is at the beginning of an item or
3757 ;; a footnote definition: next item is always a paragraph.
3759 ;; Planning and Clock.
3764 ;; Inlinetask.
3767 ;; From there, elements can have affiliated keywords.
3770 ;; Jumping over affiliated keywords put point off-limits.
3771 ;; Parse them as regular keywords.
3775 ;; LaTeX Environment.
3778 ;; Drawer and Property Drawer.
3783 ;; Fixed Width
3786 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3787 ;; Keywords.
3796 org-element-block-name-alist)))
3811 ;; Footnote Definition.
3814 ;; Horizontal Rule.
3817 ;; Diary Sexp.
3820 ;; Table.
3822 ;; List.
3826 ;; Default element: Paragraph.
3830 ;; Most elements can have affiliated keywords. When looking for an
3831 ;; element beginning, we want to move before them, as they belong to
3832 ;; that element, and, in the meantime, collect information they give
3833 ;; into appropriate properties. Hence the following function.
3836 "Collect affiliated keywords from point down to LIMIT.
3838 Return a list whose CAR is the position at the first of them and
3839 CDR a plist of keywords and values and move point to the
3840 beginning of the first line after them.
3842 As a special case, if element doesn't start at the beginning of
3843 the line (i.e. a paragraph starting an item), CAR is current
3844 position of point and CDR is nil."
3848 ;; RESTRICT is the list of objects allowed in parsed
3849 ;; keywords value.
3851 output)
3854 ;; Apply translation to RAW-KWD. From there, KWD is
3855 ;; the official keyword.
3857 org-element-keyword-translation-alist))
3858 raw-kwd))
3859 ;; Find main value for any keyword.
3865 ;; PARSEDP is non-nil when keyword should have its
3866 ;; value parsed.
3868 ;; If KWD is a dual keyword, find its secondary
3869 ;; value. Maybe parse it.
3876 ;; Attribute a property name to KWD.
3878 ;; Now set final shape for VALUE.
3884 ;; Attributes can always appear on multiple lines.
3887 ;; Eventually store the new value in OUTPUT.
3889 ;; Move to next keyword.
3891 ;; If affiliated keywords are orphaned: move back to first one.
3892 ;; They will be parsed as a paragraph.
3894 ;; Return value.
3898 \f
3899 ;;; The Org Parser
3900 ;;
3901 ;; The two major functions here are `org-element-parse-buffer', which
3902 ;; parses Org syntax inside the current buffer, taking into account
3903 ;; region, narrowing, or even visibility if specified, and
3904 ;; `org-element-parse-secondary-string', which parses objects within
3905 ;; a given string.
3906 ;;
3907 ;; The (almost) almighty `org-element-map' allows to apply a function
3908 ;; on elements or objects matching some type, and accumulate the
3909 ;; resulting values. In an export situation, it also skips unneeded
3910 ;; parts of the parse tree.
3913 "Recursively parse the buffer and return structure.
3914 If narrowing is in effect, only parse the visible part of the
3915 buffer.
3917 Optional argument GRANULARITY determines the depth of the
3918 recursion. It can be set to the following symbols:
3920 `headline' Only parse headlines.
3921 `greater-element' Don't recurse into greater elements excepted
3922 headlines and sections. Thus, elements
3923 parsed are the top-level ones.
3924 `element' Parse everything but objects and plain text.
3925 `object' Parse the complete buffer (default).
3927 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3928 elements.
3930 An element or an objects is represented as a list with the
3931 pattern (TYPE PROPERTIES CONTENTS), where :
3933 TYPE is a symbol describing the element or object. See
3934 `org-element-all-elements' and `org-element-all-objects' for an
3935 exhaustive list of such symbols. One can retrieve it with
3936 `org-element-type' function.
3938 PROPERTIES is the list of attributes attached to the element or
3939 object, as a plist. Although most of them are specific to the
3940 element or object type, all types share `:begin', `:end',
3941 `:post-blank' and `:parent' properties, which respectively
3942 refer to buffer position where the element or object starts,
3943 ends, the number of white spaces or blank lines after it, and
3944 the element or object containing it. Properties values can be
3945 obtained by using `org-element-property' function.
3947 CONTENTS is a list of elements, objects or raw strings
3948 contained in the current element or object, when applicable.
3949 One can access them with `org-element-contents' function.
3951 The Org buffer has `org-data' as type and nil as properties.
3952 `org-element-map' function can be used to find specific elements
3953 or objects within the parse tree.
3955 This function assumes that current major mode is `org-mode'."
3961 ;; Start in `first-section' mode so text before the first
3962 ;; headline belongs to a section.
3966 "Recursively parse objects in STRING and return structure.
3968 RESTRICTION is a symbol limiting the object types that will be
3969 looked after.
3971 Optional argument PARENT, when non-nil, is the element or object
3972 containing the secondary string. It is used to set correctly
3973 `:parent' property within the string."
3974 ;; Copy buffer-local variables listed in
3975 ;; `org-element-object-variables' into temporary buffer. This is
3976 ;; required since object parsing is dependent on these variables.
3980 org-element-object-variables))))
3988 secondary))
3989 secondary))))
3993 "Map a function on selected elements or objects.
3995 DATA is a parse tree, an element, an object, a string, or a list
3996 of such constructs. TYPES is a symbol or list of symbols of
3997 elements or objects types (see `org-element-all-elements' and
3998 `org-element-all-objects' for a complete list of types). FUN is
3999 the function called on the matching element or object. It has to
4000 accept one argument: the element or object itself.
4002 When optional argument INFO is non-nil, it should be a plist
4003 holding export options. In that case, parts of the parse tree
4004 not exportable according to that property list will be skipped.
4006 When optional argument FIRST-MATCH is non-nil, stop at the first
4007 match for which FUN doesn't return nil, and return that value.
4009 Optional argument NO-RECURSION is a symbol or a list of symbols
4010 representing elements or objects types. `org-element-map' won't
4011 enter any recursive element or object whose type belongs to that
4012 list. Though, FUN can still be applied on them.
4014 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4015 apply to matching objects within parsed affiliated keywords (see
4016 `org-element-parsed-keywords').
4018 Nil values returned from FUN do not appear in the results.
4021 Examples:
4022 ---------
4024 Assuming TREE is a variable containing an Org buffer parse tree,
4025 the following example will return a flat list of all `src-block'
4026 and `example-block' elements in it:
4028 \(org-element-map tree '(example-block src-block) 'identity)
4030 The following snippet will find the first headline with a level
4033 \(org-element-map tree 'headline
4034 \(lambda (hl)
4035 \(and (= (org-element-property :level hl) 1)
4037 \(org-element-property :begin hl)))
4038 nil t)
4040 The next example will return a flat list of all `plain-list' type
4041 elements in TREE that are not a sub-list themselves:
4043 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4045 Eventually, this example will return a flat list of all `bold'
4046 type objects containing a `latex-snippet' type object, even
4047 looking into captions:
4049 \(org-element-map tree 'bold
4050 \(lambda (b)
4051 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4052 nil nil nil t)"
4053 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4056 ;; Recursion depth is determined by --CATEGORY.
4063 ;; If one object is found, the function
4064 ;; has to recurse into every object.
4067 ;; If one regular element is found, the
4068 ;; function has to recurse, at least,
4069 ;; into every element it encounters.
4072 types)
4073 category)))
4074 ;; Compute properties for affiliated keywords if necessary.
4079 org-element-affiliated-keywords)))
4080 --acc
4081 --walk-tree
4085 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4086 ;; holding contextual information.
4090 ;; Ignored element in an export context.
4092 ;; List of elements or objects.
4094 ;; Unconditionally enter parse trees.
4098 ;; Check if TYPE is matching among TYPES. If so,
4099 ;; apply FUN to --DATA and accumulate return value
4100 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4106 ;; If --DATA has a secondary string that can contain
4107 ;; objects with their type among TYPES, look into it.
4114 ;; If --DATA has any affiliated keywords and
4115 ;; WITH-AFFILIATED is non-nil, look for objects in
4116 ;; them.
4124 ;; Pay attention to the type of value.
4125 ;; Preserve order for multiple keywords.
4141 --affiliated-alist))
4142 ;; Determine if a recursion into --DATA is possible.
4144 ;; --TYPE is explicitly removed from recursion.
4146 ;; --DATA has no contents.
4148 ;; Looking for greater elements but --DATA is simply
4149 ;; an element or an object.
4152 ;; Looking for elements but --DATA is an object.
4155 ;; In any other case, map contents.
4159 ;; Return value in a proper order.
4163 ;; The following functions are internal parts of the parser.
4164 ;;
4165 ;; The first one, `org-element--parse-elements' acts at the element's
4166 ;; level.
4167 ;;
4168 ;; The second one, `org-element--parse-objects' applies on all objects
4169 ;; of a paragraph or a secondary string. It uses
4170 ;; `org-element--get-next-object-candidates' to optimize the search of
4171 ;; the next object in the buffer.
4172 ;;
4173 ;; More precisely, that function looks for every allowed object type
4174 ;; first. Then, it discards failed searches, keeps further matches,
4175 ;; and searches again types matched behind point, for subsequent
4176 ;; calls. Thus, searching for a given type fails only once, and every
4177 ;; object is searched only once at top level (but sometimes more for
4178 ;; nested types).
4182 "Parse elements between BEG and END positions.
4184 SPECIAL prioritize some elements over the others. It can be set
4185 to `first-section', `quote-section', `section' `item' or
4186 `table-row'.
4188 When value is `item', STRUCTURE will be used as the current list
4189 structure.
4191 GRANULARITY determines the depth of the recursion. See
4192 `org-element-parse-buffer' for more information.
4194 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4195 elements.
4197 Elements are accumulated into ACC."
4200 ;; When parsing only headlines, skip any text before first one.
4203 ;; Main loop start.
4205 ;; Find current element's type and parse it accordingly to
4206 ;; its category.
4208 end granularity special structure))
4212 ;; Fill ELEMENT contents by side-effect.
4214 ;; If VISIBLE-ONLY is true and element is hidden or if it has
4215 ;; no contents, don't modify it.
4218 ;; Greater element: parse it between `contents-begin' and
4219 ;; `contents-end'. Make sure GRANULARITY allows the
4220 ;; recursion, or ELEMENT is a headline, in which case going
4221 ;; inside is mandatory, in order to get sub-level headings.
4229 ;; Possibly switch to a special mode.
4239 granularity visible-only element))
4240 ;; ELEMENT has contents. Parse objects inside, if
4241 ;; GRANULARITY allows it.
4247 ;; Return result.
4248 acc))
4251 "Parse objects between BEG and END and return recursive structure.
4253 Objects are accumulated in ACC.
4255 RESTRICTION is a list of object successors which are allowed in
4256 the current object."
4262 end restriction candidates)))
4269 ;; 1. Text before any object. Untabify it.
4274 acc
4278 ;; 2. Object...
4281 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4282 ;; a recursive type.
4287 cont-beg
4294 ;; 3. Text after last object. Untabify it.
4298 acc
4302 ;; Result.
4303 acc)))
4306 "Return an alist of candidates for the next object.
4308 LIMIT bounds the search, and RESTRICTION narrows candidates to
4309 some object successors.
4311 OBJECTS is the previous candidates alist. If it is set to
4312 `initial', no search has been done before, and all symbols in
4313 RESTRICTION should be looked after.
4315 Return value is an alist whose CAR is the object type and CDR its
4316 beginning position."
4318 nil
4320 ;; When searching for the first time, look for every successor
4321 ;; allowed in RESTRICTION.
4325 restriction)
4326 ;; Focus on objects returned during last search. Keep those
4327 ;; still after point. Search again objects before it.
4333 type)))
4336 limit)))))
4337 objects))))
4340 \f
4341 ;;; Towards A Bijective Process
4342 ;;
4343 ;; The parse tree obtained with `org-element-parse-buffer' is really
4344 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4345 ;; interpreted and expanded into a string with canonical Org syntax.
4346 ;; Hence `org-element-interpret-data'.
4347 ;;
4348 ;; The function relies internally on
4349 ;; `org-element--interpret-affiliated-keywords'.
4351 ;;;###autoload
4353 "Interpret DATA as Org syntax.
4355 DATA is a parse tree, an element, an object or a secondary string
4356 to interpret.
4358 Optional argument PARENT is used for recursive calls. It contains
4359 the element or object containing data, or nil.
4361 Return Org syntax as a string."
4365 ;; Secondary string.
4370 ;; Full Org document.
4375 ;; Plain text: remove `:parent' text property from output.
4377 ;; Element/Object without contents.
4380 data nil))
4381 ;; Element/Object with contents.
4391 ;; Elements directly containing objects must
4392 ;; have their indentation normalized first.
4394 data
4395 ;; When normalizing first paragraph of an
4396 ;; item or a footnote-definition, ignore
4397 ;; first line's indentation.
4404 data
4406 contents)))))))
4408 ;; Build white spaces. If no `:post-blank' property is
4409 ;; specified, assume its value is 0.
4419 "Return ELEMENT's affiliated keywords as Org syntax.
4420 If there is no affiliated keyword, return the empty string."
4430 ": "
4433 value)
4441 ;; All attribute keywords can have multiple lines.
4447 ;; List all ELEMENT's properties matching an attribute line or an
4448 ;; affiliated keyword, but ignore translated keywords since they
4449 ;; cannot belong to the property list.
4456 org-element-keyword-translation-alist)))))
4457 collect prop)
4460 ;; Because interpretation of the parse tree must return the same
4461 ;; number of blank lines between elements and the same number of white
4462 ;; space after objects, some special care must be given to white
4463 ;; spaces.
4464 ;;
4465 ;; The first function, `org-element-normalize-string', ensures any
4466 ;; string different from the empty string will end with a single
4467 ;; newline character.
4468 ;;
4469 ;; The second function, `org-element-normalize-contents', removes
4470 ;; global indentation from the contents of the current element.
4473 "Ensure string S ends with a single newline character.
4475 If S isn't a string return it unchanged. If S is the empty
4476 string, return it. Otherwise, return a new string with a single
4477 newline character at its end."
4485 "Normalize plain text in ELEMENT's contents.
4487 ELEMENT must only contain plain text and objects.
4489 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4490 indentation to compute maximal common indentation.
4492 Return the normalized element that is element with global
4493 indentation removed from its contents. The function assumes that
4494 indentation is not done with TAB characters."
4496 collect-inds ; for byte-compiler
4499 ;; Return list of indentations within BLOB. This is done by
4500 ;; walking recursively BLOB and updating IND-LIST along the
4501 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4502 ;; been seen yet. It is required as this string is the only
4503 ;; one whose indentation doesn't happen after a newline
4504 ;; character.
4512 ;; An indentation of zero means no string will be
4513 ;; modified. Quit the process.
4519 ;; Avoid matching blank or empty lines.
4527 ;; Collect indentation list in ELEMENT. Possibly remove first
4528 ;; value if IGNORE-FIRST is non-nil.
4531 ;; Build ELEMENT back, replacing each string with the same
4532 ;; string minus common indentation.
4537 ;; Return BLOB with all its strings indentation
4538 ;; shortened from MCI white spaces. FIRST-FLAG is
4539 ;; non-nil when the first string hasn't been seen
4540 ;; yet.
4554 org-element-recursive-objects)
4558 blob))))
4562 \f
4563 ;;; The Toolbox
4564 ;;
4565 ;; The first move is to implement a way to obtain the smallest element
4566 ;; containing point. This is the job of `org-element-at-point'. It
4567 ;; basically jumps back to the beginning of section containing point
4568 ;; and moves, element after element, with
4569 ;; `org-element--current-element' until the container is found. Note:
4570 ;; When using `org-element-at-point', secondary values are never
4571 ;; parsed since the function focuses on elements, not on objects.
4572 ;;
4573 ;; At a deeper level, `org-element-context' lists all elements and
4574 ;; objects containing point.
4575 ;;
4576 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4577 ;; internally by navigation and manipulation tools.
4579 ;;;###autoload
4581 "Determine closest element around point.
4583 Return value is a list like (TYPE PROPS) where TYPE is the type
4584 of the element and PROPS a plist of properties associated to the
4585 element.
4587 Possible types are defined in `org-element-all-elements'.
4588 Properties depend on element or object type, but always include
4589 `:begin', `:end', `:parent' and `:post-blank' properties.
4591 As a special case, if point is at the very beginning of a list or
4592 sub-list, returned element will be that list instead of the first
4593 item. In the same way, if point is at the beginning of the first
4594 row of a table, returned element will be the table instead of the
4595 first row.
4597 If optional argument KEEP-TRAIL is non-nil, the function returns
4598 a list of elements leading to element at point. The list's CAR
4599 is always the element at point. The following positions contain
4600 element's siblings, then parents, siblings of parents, until the
4601 first element of current section."
4603 ;; If at a headline, parse it. It is the sole element that
4604 ;; doesn't require to know about context. Be sure to disallow
4605 ;; secondary string parsing, though.
4611 ;; Otherwise move at the beginning of the section containing
4612 ;; point.
4617 element type special-flag trail struct prevs parent)
4620 ;; In empty lines at buffer's beginning, return nil.
4629 ;; In blank lines just after the headline, point still
4630 ;; belongs to the headline.
4638 ;; Parse successively each element, skipping those ending
4639 ;; before original position.
4647 ;; 1. Skip any element ending before point. Also skip
4648 ;; element ending at point when we're sure that another
4649 ;; element has started.
4654 ;; 2. An element containing point is always the element at
4655 ;; point.
4658 ;; 3. At any other greater element type, if point is
4659 ;; within contents, move into it.
4664 ;; Create an anchor for tables and plain lists:
4665 ;; when point is at the very beginning of these
4666 ;; elements, ignoring affiliated keywords,
4667 ;; target them instead of their contents.
4669 ;; When point is at contents end, do not move
4670 ;; into elements with an explicit ending, but
4671 ;; return that element instead.
4675 drawer dynamic-block inlinetask item
4676 plain-list property-drawer quote-block
4677 special-block))))
4692 ;;;###autoload
4694 "Return closest element or object around point.
4696 Return value is a list like (TYPE PROPS) where TYPE is the type
4697 of the element or object and PROPS a plist of properties
4698 associated to it.
4700 Possible types are defined in `org-element-all-elements' and
4701 `org-element-all-objects'. Properties depend on element or
4702 object type, but always include `:begin', `:end', `:parent' and
4703 `:post-blank'.
4705 Optional argument ELEMENT, when non-nil, is the closest element
4706 containing point, as returned by `org-element-at-point'.
4707 Providing it allows for quicker computation."
4712 end)
4713 ;; Check if point is inside an element containing objects or at
4714 ;; a secondary string. In that case, move to beginning of the
4715 ;; element or secondary string and set END to the other side.
4722 org-element-parsed-keywords))
4723 ;; We're at an affiliated keyword. Change
4724 ;; type to retrieve correct restrictions.
4726 ;; Determine if we're at main or dual value.
4740 (<= origin
4741 ;; `1+' is required so some
4742 ;; successors can match
4743 ;; properly their object.
4765 element
4771 end restriction candidates))
4773 candidates)))
4774 ;; If ORIGIN is before next object in element, there's
4775 ;; no point in looking further.
4785 ;; ORIGIN is after OBJECT, so skip it.
4791 ;; ORIGIN is within a non-recursive object or at
4792 ;; an object boundaries: Return that object.
4796 ;; Otherwise, move within current object and
4797 ;; restrict search to the end of its contents.
4802 candidates 'initial
4803 end cend)))))))
4804 parent))))))
4807 "Non-nil when elements ELEM-A and ELEM-B are nested."
4816 "Swap elements ELEM-A and ELEM-B.
4817 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4818 end of ELEM-A."
4820 ;; There are two special cases when an element doesn't start at bol:
4821 ;; the first paragraph in an item or in a footnote definition.
4823 ;; Only a paragraph without any affiliated keyword can be moved at
4824 ;; ELEM-A position in such a situation. Note that the case of
4825 ;; a footnote definition is impossible: it cannot contain two
4826 ;; paragraphs in a row because it cannot contain a blank line.
4832 ;; In a special situation, ELEM-A will have no indentation. We'll
4833 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4847 ;; Store overlays responsible for visibility status. We
4848 ;; also need to store their boundaries as they will be
4849 ;; removed from buffer.
4856 ;; Get contents.
4864 ;; Restore ex ELEM-A overlays.
4873 ;; Restore ex ELEM-B overlays.
4882 ;; Local variables:
4883 ;; generated-autoload-file: "org-loaddefs.el"
4884 ;; End:
4886 ;;; org-element.el ends here