95b775060debeabad768c09adf9c43f20a16dd69
| blob | 95b775060debeabad768c09adf9c43f20a16dd69 |
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.
1150 items struct)
1155 ;; At limit: end all items.
1164 ;; At list end: end all items.
1169 ;; At a new item: end previous sibling.
1181 ind
1182 bullet
1185 ;; Description tag.
1189 ;; Ending position, unknown so far.
1190 nil)))
1191 items))
1193 ;; Skip empty lines.
1195 ;; Skip inline tasks and blank lines along the way.
1202 ;; At some text line. Check if it ends any previous item.
1214 ;; Skip blocks (any type) and drawers contents.
1220 limit t)))
1226 "Parse a plain list.
1228 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1229 the buffer position at the beginning of the first affiliated
1230 keyword and CDR is a plist of affiliated keywords along with
1231 their value. STRUCTURE is the structure of the plain list being
1232 parsed.
1234 Return a list whose CAR is `plain-list' and CDR is a plist
1235 containing `:type', `:begin', `:end', `:contents-begin' and
1236 `:contents-end', `:structure', `:post-blank' and
1237 `:post-affiliated' keywords.
1239 Assume point is at the beginning of the list."
1252 ;; Return value.
1256 :begin begin
1257 :end end
1258 :contents-begin contents-begin
1259 :contents-end contents-end
1260 :structure struct
1266 "Interpret PLAIN-LIST element as Org syntax.
1267 CONTENTS is the contents of the element."
1275 ;;;; Property Drawer
1278 "Parse a property drawer.
1280 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1281 the buffer position at the beginning of the first affiliated
1282 keyword and CDR is a plist of affiliated keywords along with
1283 their value.
1285 Return a list whose CAR is `property-drawer' and CDR is a plist
1286 containing `:begin', `:end', `:contents-begin', `:contents-end',
1287 `:post-blank' and `:post-affiliated' keywords.
1289 Assume point is at the beginning of the property drawer."
1294 ;; Incomplete drawer: parse it as a paragraph.
1313 :end end
1314 :contents-begin contents-begin
1315 :contents-end contents-end
1321 "Interpret PROPERTY-DRAWER element as Org syntax.
1322 CONTENTS is the properties within the drawer."
1326 ;;;; Quote Block
1329 "Parse a quote block.
1331 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1332 the buffer position at the beginning of the first affiliated
1333 keyword and CDR is a plist of affiliated keywords along with
1334 their value.
1336 Return a list whose CAR is `quote-block' and CDR is a plist
1337 containing `:begin', `:end', `:contents-begin', `:contents-end',
1338 `:post-blank' and `:post-affiliated' keywords.
1340 Assume point is at the beginning of the block."
1344 ;; Incomplete block: parse it as a paragraph.
1350 ;; Empty blocks have no contents.
1364 :end end
1365 :contents-begin contents-begin
1366 :contents-end contents-end
1372 "Interpret QUOTE-BLOCK element as Org syntax.
1373 CONTENTS is the contents of the element."
1377 ;;;; Section
1380 "Parse a section.
1382 LIMIT bounds the search.
1384 Return a list whose CAR is `section' and CDR is a plist
1385 containing `:begin', `:end', `:contents-begin', `contents-end'
1386 and `:post-blank' keywords."
1388 ;; Beginning of section is the beginning of the first non-blank
1389 ;; line after previous headline.
1398 :end end
1399 :contents-begin begin
1400 :contents-end pos-before-blank
1404 "Interpret SECTION element as Org syntax.
1405 CONTENTS is the contents of the element."
1406 contents)
1409 ;;;; Special Block
1412 "Parse a special block.
1414 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1415 the buffer position at the beginning of the first affiliated
1416 keyword and CDR is a plist of affiliated keywords along with
1417 their value.
1419 Return a list whose CAR is `special-block' and CDR is a plist
1420 containing `:type', `:begin', `:end', `:contents-begin',
1421 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1423 Assume point is at the beginning of the block."
1430 limit t)))
1431 ;; Incomplete block: parse it as a paragraph.
1437 ;; Empty blocks have no contents.
1451 :begin begin
1452 :end end
1453 :contents-begin contents-begin
1454 :contents-end contents-end
1460 "Interpret SPECIAL-BLOCK element as Org syntax.
1461 CONTENTS is the contents of the element."
1466 \f
1467 ;;; Elements
1468 ;;
1469 ;; For each element, a parser and an interpreter are also defined.
1470 ;; Both follow the same naming convention used for greater elements.
1471 ;;
1472 ;; Also, as for greater elements, adding a new element type is done
1473 ;; through the following steps: implement a parser and an interpreter,
1474 ;; tweak `org-element--current-element' so that it recognizes the new
1475 ;; type and add that new type to `org-element-all-elements'.
1476 ;;
1477 ;; As a special case, when the newly defined type is a block type,
1478 ;; `org-element-block-name-alist' has to be modified accordingly.
1481 ;;;; Babel Call
1484 "Parse a babel call.
1486 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1487 the buffer position at the beginning of the first affiliated
1488 keyword and CDR is a plist of affiliated keywords along with
1489 their value.
1491 Return a list whose CAR is `babel-call' and CDR is a plist
1492 containing `:begin', `:end', `:value', `:post-blank' and
1493 `:post-affiliated' as keywords."
1508 :end end
1509 :value value
1515 "Interpret BABEL-CALL element as Org syntax.
1516 CONTENTS is nil."
1520 ;;;; Clock
1523 "Parse a clock.
1525 LIMIT bounds the search.
1527 Return a list whose CAR is `clock' and CDR is a plist containing
1528 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1529 as keywords."
1549 :value value
1550 :duration duration
1551 :begin begin
1552 :end end
1556 "Interpret CLOCK element as Org syntax.
1557 CONTENTS is nil."
1565 "%2s:%02s"
1569 ;;;; Comment
1572 "Parse a comment.
1574 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1575 the buffer position at the beginning of the first affiliated
1576 keyword and CDR is a plist of affiliated keywords along with
1577 their value.
1579 Return a list whose CAR is `comment' and CDR is a plist
1580 containing `:begin', `:end', `:value', `:post-blank',
1581 `:post-affiliated' keywords.
1583 Assume point is at comment beginning."
1592 ;; Get comments ending.
1595 ;; Accumulate lines without leading hash and first
1596 ;; whitespace.
1611 :end end
1612 :value value
1618 "Interpret COMMENT element as Org syntax.
1619 CONTENTS is nil."
1623 ;;;; Comment Block
1626 "Parse an export block.
1628 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1629 the buffer position at the beginning of the first affiliated
1630 keyword and CDR is a plist of affiliated keywords along with
1631 their value.
1633 Return a list whose CAR is `comment-block' and CDR is a plist
1634 containing `:begin', `:end', `:value', `:post-blank' and
1635 `:post-affiliated' keywords.
1637 Assume point is at comment block beginning."
1641 ;; Incomplete block: parse it as a paragraph.
1655 contents-begin contents-end)))
1659 :end end
1660 :value value
1666 "Interpret COMMENT-BLOCK element as Org syntax.
1667 CONTENTS is nil."
1672 ;;;; Diary Sexp
1675 "Parse a diary sexp.
1677 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1678 the buffer position at the beginning of the first affiliated
1679 keyword and CDR is a plist of affiliated keywords along with
1680 their value.
1682 Return a list whose CAR is `diary-sexp' and CDR is a plist
1683 containing `:begin', `:end', `:value', `:post-blank' and
1684 `:post-affiliated' keywords."
1697 :begin begin
1698 :end end
1704 "Interpret DIARY-SEXP as Org syntax.
1705 CONTENTS is nil."
1709 ;;;; Example Block
1712 "Parse an example block.
1714 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1715 the buffer position at the beginning of the first affiliated
1716 keyword and CDR is a plist of affiliated keywords along with
1717 their value.
1719 Return a list whose CAR is `example-block' and CDR is a plist
1720 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1721 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1722 `:value', `:post-blank' and `:post-affiliated' keywords."
1726 ;; Incomplete block: parse it as a paragraph.
1734 ;; Switches analysis
1741 ;; Should labels be retained in (or stripped from) example
1742 ;; blocks?
1747 ;; What should code-references use - labels or
1748 ;; line-numbers?
1757 ;; Standard block parsing.
1765 contents-begin contents-end))
1766 block-ind))
1776 :end end
1777 :value value
1778 :switches switches
1779 :number-lines number-lines
1780 :preserve-indent preserve-indent
1781 :retain-labels retain-labels
1782 :use-labels use-labels
1783 :label-fmt label-fmt
1789 "Interpret EXAMPLE-BLOCK element as Org syntax.
1790 CONTENTS is nil."
1797 value
1802 ;;;; Export Block
1805 "Parse an export block.
1807 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1808 the buffer position at the beginning of the first affiliated
1809 keyword and CDR is a plist of affiliated keywords along with
1810 their value.
1812 Return a list whose CAR is `export-block' and CDR is a plist
1813 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1814 `:post-affiliated' keywords.
1816 Assume point is at export-block beginning."
1823 ;; Incomplete block: parse it as a paragraph.
1837 contents-end)))
1841 :end end
1842 :type type
1843 :value value
1849 "Interpret EXPORT-BLOCK element as Org syntax.
1850 CONTENTS is nil."
1857 ;;;; Fixed-width
1860 "Parse a fixed-width section.
1862 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1863 the buffer position at the beginning of the first affiliated
1864 keyword and CDR is a plist of affiliated keywords along with
1865 their value.
1867 Return a list whose CAR is `fixed-width' and CDR is a plist
1868 containing `:begin', `:end', `:value', `:post-blank' and
1869 `:post-affiliated' keywords.
1871 Assume point is at the beginning of the fixed-width area."
1875 value
1880 ;; Accumulate text without starting colons.
1894 :end end
1895 :value value
1901 "Interpret FIXED-WIDTH element as Org syntax.
1902 CONTENTS is nil."
1910 ;;;; Horizontal Rule
1913 "Parse an horizontal rule.
1915 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1916 the buffer position at the beginning of the first affiliated
1917 keyword and CDR is a plist of affiliated keywords along with
1918 their value.
1920 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1921 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1922 keywords."
1933 :end end
1939 "Interpret HORIZONTAL-RULE element as Org syntax.
1940 CONTENTS is nil."
1944 ;;;; Keyword
1947 "Parse a keyword at point.
1949 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1950 the buffer position at the beginning of the first affiliated
1951 keyword and CDR is a plist of affiliated keywords along with
1952 their value.
1954 Return a list whose CAR is `keyword' and CDR is a plist
1955 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1956 `:post-affiliated' keywords."
1971 :value value
1972 :begin begin
1973 :end end
1979 "Interpret KEYWORD element as Org syntax.
1980 CONTENTS is nil."
1986 ;;;; Latex Environment
1989 "Parse a LaTeX environment.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1994 their value.
1996 Return a list whose CAR is `latex-environment' and CDR is a plist
1997 containing `:begin', `:end', `:value', `:post-blank' and
1998 `:post-affiliated' keywords.
2000 Assume point is at the beginning of the latex environment."
2007 limit t))
2008 ;; Incomplete latex environment: parse it as a paragraph.
2019 :end end
2020 :value value
2026 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2027 CONTENTS is nil."
2031 ;;;; Node Property
2034 "Parse a node-property at point.
2036 LIMIT bounds the search.
2038 Return a list whose CAR is `node-property' and CDR is a plist
2039 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2040 keywords."
2052 :value value
2053 :begin begin
2054 :end end
2058 "Interpret NODE-PROPERTY element as Org syntax.
2059 CONTENTS is nil."
2065 ;;;; Paragraph
2068 "Parse a paragraph.
2070 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2071 the buffer position at the beginning of the first affiliated
2072 keyword and CDR is a plist of affiliated keywords along with
2073 their value.
2075 Return a list whose CAR is `paragraph' and CDR is a plist
2076 containing `:begin', `:end', `:contents-begin' and
2077 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2079 Assume point is at the beginning of the paragraph."
2088 limit
2089 ;; A matching `org-element-paragraph-separate' is not
2090 ;; necessarily the end of the paragraph. In
2091 ;; particular, lines starting with # or : as a first
2092 ;; non-space character are ambiguous. We have check
2093 ;; if they are valid Org syntax (i.e. not an
2094 ;; incomplete keyword).
2098 ;; There's no ambiguity for other symbols or
2099 ;; empty lines: stop here.
2101 ;; Stop at valid fixed-width areas.
2103 ;; Stop at drawers.
2108 ;; Stop at valid comments.
2110 ;; Stop at valid dynamic blocks.
2115 ;; Stop at valid blocks.
2122 limit t)))
2123 ;; Stop at valid latex environments.
2131 limit t)))
2132 ;; Stop at valid keywords.
2134 ;; Skip everything else.
2152 :end end
2153 :contents-begin contents-begin
2154 :contents-end contents-end
2160 "Interpret PARAGRAPH element as Org syntax.
2161 CONTENTS is the contents of the element."
2162 contents)
2165 ;;;; Planning
2168 "Parse a planning.
2170 LIMIT bounds the search.
2172 Return a list whose CAR is `planning' and CDR is a plist
2173 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2174 and `:post-blank' keywords."
2184 closed deadline scheduled)
2196 :deadline deadline
2197 :scheduled scheduled
2198 :begin begin
2199 :end end
2203 "Interpret PLANNING element as Org syntax.
2204 CONTENTS is nil."
2206 'identity
2223 ;;;; Quote Section
2226 "Parse a quote section.
2228 LIMIT bounds the search.
2230 Return a list whose CAR is `quote-section' and CDR is a plist
2231 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2233 Assume point is at beginning of the section."
2244 :end end
2245 :value value
2249 "Interpret QUOTE-SECTION element as Org syntax.
2250 CONTENTS is nil."
2254 ;;;; Src Block
2257 "Parse a src block.
2259 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2260 the buffer position at the beginning of the first affiliated
2261 keyword and CDR is a plist of affiliated keywords along with
2262 their value.
2264 Return a list whose CAR is `src-block' and CDR is a plist
2265 containing `:language', `:switches', `:parameters', `:begin',
2266 `:end', `:number-lines', `:retain-labels', `:use-labels',
2267 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2268 `:post-affiliated' keywords.
2270 Assume point is at the beginning of the block."
2273 limit t)))
2274 ;; Incomplete block: parse it as a paragraph.
2280 ;; Get language as a string.
2289 ;; Get switches.
2291 ;; Get parameters.
2293 ;; Switches analysis
2304 ;; Should labels be retained in (or stripped from)
2305 ;; src blocks?
2310 ;; What should code-references use - labels or
2311 ;; line-numbers?
2316 ;; Indentation.
2318 ;; Retrieve code.
2323 block-ind))
2327 ;; Get position after ending blank lines.
2338 :begin begin
2339 :end end
2340 :number-lines number-lines
2341 :preserve-indent preserve-indent
2342 :retain-labels retain-labels
2343 :use-labels use-labels
2344 :label-fmt label-fmt
2345 :value value
2351 "Interpret SRC-BLOCK element as Org syntax.
2352 CONTENTS is nil."
2361 val)
2375 ;;;; Table
2378 "Parse a table at point.
2380 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2381 the buffer position at the beginning of the first affiliated
2382 keyword and CDR is a plist of affiliated keywords along with
2383 their value.
2385 Return a list whose CAR is `table' and CDR is a plist containing
2386 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2387 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2388 keywords.
2390 Assume point is at the beginning of the table."
2404 acc))
2412 :end end
2413 :type type
2414 :tblfm tblfm
2415 ;; Only `org' tables have contents. `table.el' tables
2416 ;; use a `:value' property to store raw table as
2417 ;; a string.
2422 table-begin table-end))
2428 "Interpret TABLE element as Org syntax.
2429 CONTENTS is nil."
2440 ;;;; Table Row
2443 "Parse table row at point.
2445 LIMIT bounds the search.
2447 Return a list whose CAR is `table-row' and CDR is a plist
2448 containing `:begin', `:end', `:contents-begin', `:contents-end',
2449 `:type' and `:post-blank' keywords."
2453 ;; A table rule has no contents. In that case, ensure
2454 ;; CONTENTS-BEGIN matches CONTENTS-END.
2466 :begin begin
2467 :end end
2468 :contents-begin contents-begin
2469 :contents-end contents-end
2473 "Interpret TABLE-ROW element as Org syntax.
2474 CONTENTS is the contents of the table row."
2479 ;;;; Verse Block
2482 "Parse a verse block.
2484 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2485 the buffer position at the beginning of the first affiliated
2486 keyword and CDR is a plist of affiliated keywords along with
2487 their value.
2489 Return a list whose CAR is `verse-block' and CDR is a plist
2490 containing `:begin', `:end', `:contents-begin', `:contents-end',
2491 `:post-blank' and `:post-affiliated' keywords.
2493 Assume point is at beginning of the block."
2497 ;; Incomplete block: parse it as a paragraph.
2513 :end end
2514 :contents-begin contents-begin
2515 :contents-end contents-end
2521 "Interpret VERSE-BLOCK element as Org syntax.
2522 CONTENTS is verse block contents."
2526 \f
2527 ;;; Objects
2528 ;;
2529 ;; Unlike to elements, interstices can be found between objects.
2530 ;; That's why, along with the parser, successor functions are provided
2531 ;; for each object. Some objects share the same successor (i.e. `code'
2532 ;; and `verbatim' objects).
2533 ;;
2534 ;; A successor must accept a single argument bounding the search. It
2535 ;; will return either a cons cell whose CAR is the object's type, as
2536 ;; a symbol, and CDR the position of its next occurrence, or nil.
2537 ;;
2538 ;; Successors follow the naming convention:
2539 ;; org-element-NAME-successor, where NAME is the name of the
2540 ;; successor, as defined in `org-element-all-successors'.
2541 ;;
2542 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2543 ;; object types they can contain will be specified in
2544 ;; `org-element-object-restrictions'.
2545 ;;
2546 ;; Adding a new type of object is simple. Implement a successor,
2547 ;; a parser, and an interpreter for it, all following the naming
2548 ;; convention. Register type in `org-element-all-objects' and
2549 ;; successor in `org-element-all-successors'. Maybe tweak
2550 ;; restrictions about it, and that's it.
2553 ;;;; Bold
2556 "Parse bold object at point.
2558 Return a list whose CAR is `bold' and CDR is a plist with
2559 `:begin', `:end', `:contents-begin' and `:contents-end' and
2560 `:post-blank' keywords.
2562 Assume point is at the first star marker."
2574 :end end
2575 :contents-begin contents-begin
2576 :contents-end contents-end
2580 "Interpret BOLD object as Org syntax.
2581 CONTENTS is the contents of the object."
2585 "Search for the next text-markup object.
2587 Return value is a cons cell whose CAR is a symbol among `bold',
2588 `italic', `underline', `strike-through', `code' and `verbatim'
2589 and CDR is beginning position."
2605 ;;;; Code
2608 "Parse code object at point.
2610 Return a list whose CAR is `code' and CDR is a plist with
2611 `:value', `:begin', `:end' and `:post-blank' keywords.
2613 Assume point is at the first tilde marker."
2624 :begin begin
2625 :end end
2629 "Interpret CODE object as Org syntax.
2630 CONTENTS is nil."
2634 ;;;; Entity
2637 "Parse entity at point.
2639 Return a list whose CAR is `entity' and CDR a plist with
2640 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2641 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2642 keywords.
2644 Assume point is at the beginning of the entity."
2646 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2662 :begin begin
2663 :end end
2664 :use-brackets-p bracketsp
2668 "Interpret ENTITY object as Org syntax.
2669 CONTENTS is nil."
2675 "Search for the next latex-fragment or entity object.
2677 Return value is a cons cell whose CAR is `entity' or
2678 `latex-fragment' and CDR is beginning position."
2682 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2689 ;; Determine if it's a real entity or a LaTeX command.
2692 ;; No entity nor command: point is at a LaTeX fragment.
2693 ;; Determine its type to get the correct beginning position.
2702 ;;;; Export Snippet
2705 "Parse export snippet at point.
2707 Return a list whose CAR is `export-snippet' and CDR a plist with
2708 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2709 keywords.
2711 Assume point is at the beginning of the snippet."
2723 :value value
2724 :begin begin
2725 :end end
2729 "Interpret EXPORT-SNIPPET object as Org syntax.
2730 CONTENTS is nil."
2736 "Search for the next export-snippet object.
2738 Return value is a cons cell whose CAR is `export-snippet' and CDR
2739 its beginning position."
2748 ;;;; Footnote Reference
2751 "Parse footnote reference at point.
2753 Return a list whose CAR is `footnote-reference' and CDR a plist
2754 with `:label', `:type', `:inline-definition', `:begin', `:end'
2755 and `:post-blank' as keywords."
2777 :type type
2778 :begin begin
2779 :end end
2782 footnote-reference :inline-definition
2787 footnote-reference))))))
2790 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2791 CONTENTS is nil."
2801 "Search for the next footnote-reference object.
2803 Return value is a cons cell whose CAR is `footnote-reference' and
2804 CDR is beginning position."
2818 ;;;; Inline Babel Call
2821 "Parse inline babel call at point.
2823 Return a list whose CAR is `inline-babel-call' and CDR a plist
2824 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2826 Assume point is at the beginning of the babel call."
2838 :end end
2839 :value value
2843 "Interpret INLINE-BABEL-CALL object as Org syntax.
2844 CONTENTS is nil."
2848 "Search for the next inline-babel-call object.
2850 Return value is a cons cell whose CAR is `inline-babel-call' and
2851 CDR is beginning position."
2853 ;; Use a simplified version of
2854 ;; `org-babel-inline-lob-one-liner-regexp'.
2857 nil t)
2861 ;;;; Inline Src Block
2864 "Parse inline source block at point.
2866 Return a list whose CAR is `inline-src-block' and CDR a plist
2867 with `:begin', `:end', `:language', `:value', `:parameters' and
2868 `:post-blank' as keywords.
2870 Assume point is at the beginning of the inline src block."
2883 :value value
2884 :parameters parameters
2885 :begin begin
2886 :end end
2890 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2891 CONTENTS is nil."
2896 language
2898 body)))
2901 "Search for the next inline-babel-call element.
2903 Return value is a cons cell whose CAR is `inline-babel-call' and
2904 CDR is beginning position."
2910 ;;;; Italic
2913 "Parse italic object at point.
2915 Return a list whose CAR is `italic' and CDR is a plist with
2916 `:begin', `:end', `:contents-begin' and `:contents-end' and
2917 `:post-blank' keywords.
2919 Assume point is at the first slash marker."
2931 :end end
2932 :contents-begin contents-begin
2933 :contents-end contents-end
2937 "Interpret ITALIC object as Org syntax.
2938 CONTENTS is the contents of the object."
2942 ;;;; Latex Fragment
2945 "Parse LaTeX fragment at point.
2947 Return a list whose CAR is `latex-fragment' and CDR a plist with
2948 `:value', `:begin', `:end', and `:post-blank' as keywords.
2950 Assume point is at the beginning of the LaTeX fragment."
2963 ;; None found: it's a macro.
2972 :begin begin
2973 :end end
2977 "Interpret LATEX-FRAGMENT object as Org syntax.
2978 CONTENTS is nil."
2981 ;;;; Line Break
2984 "Parse line break at point.
2986 Return a list whose CAR is `line-break', and CDR a plist with
2987 `:begin', `:end' and `:post-blank' keywords.
2989 Assume point is at the beginning of the line break."
2996 "Interpret LINE-BREAK object as Org syntax.
2997 CONTENTS is nil."
3001 "Search for the next line-break object.
3003 Return value is a cons cell whose CAR is `line-break' and CDR is
3004 beginning position."
3008 ;; A line break can only happen on a non-empty line.
3013 ;;;; Link
3016 "Parse link at point.
3018 Return a list whose CAR is `link' and CDR a plist with `:type',
3019 `:path', `:raw-link', `:application', `:search-option', `:begin',
3020 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3021 keywords.
3023 Assume point is at the beginning of the link."
3026 end contents-begin contents-end link-end post-blank path type
3027 raw-link link search-option application)
3029 ;; Type 1: Text targeted from a radio target.
3034 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3039 ;; RAW-LINK is the original link. Expand any
3040 ;; abbreviation in it.
3044 ;; Determine TYPE of link and set PATH accordingly.
3046 ;; File type.
3050 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3053 ;; Id type: PATH is the id.
3056 ;; Code-ref type: PATH is the name of the reference.
3059 ;; Custom-id type: PATH is the name of the custom id.
3062 ;; Fuzzy type: Internal link either matches a target, an
3063 ;; headline name or nothing. PATH is the target or
3064 ;; headline's name.
3066 ;; Type 3: Plain link, i.e. http://orgmode.org
3072 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3079 ;; In any case, deduce end point after trailing white space from
3080 ;; LINK-END variable.
3083 ;; Extract search option and opening application out of
3084 ;; "file"-type links.
3086 ;; Application.
3091 ;; Extract search option from PATH.
3095 ;; Make sure TYPE always reports "file".
3099 :path path
3101 :application application
3102 :search-option search-option
3103 :begin begin
3104 :end end
3105 :contents-begin contents-begin
3106 :contents-end contents-end
3110 "Interpret LINK object as Org syntax.
3111 CONTENTS is the contents of the object, or nil."
3116 raw-link
3120 "Search for the next link object.
3122 Return value is a cons cell whose CAR is `link' and CDR is
3123 beginning position."
3132 "Search for the next plain link object.
3134 Return value is a cons cell whose CAR is `link' and CDR is
3135 beginning position."
3140 ;;;; Macro
3143 "Parse macro at point.
3145 Return a list whose CAR is `macro' and CDR a plist with `:key',
3146 `:args', `:begin', `:end', `:value' and `:post-blank' as
3147 keywords.
3149 Assume point is at the macro."
3160 ;; Do not use `org-split-string' since empty
3161 ;; strings are meaningful here.
3169 args nil t)
3173 :value value
3174 :args args
3175 :begin begin
3176 :end end
3180 "Interpret MACRO object as Org syntax.
3181 CONTENTS is nil."
3185 "Search for the next macro object.
3187 Return value is cons cell whose CAR is `macro' and CDR is
3188 beginning position."
3192 nil t)
3196 ;;;; Radio-target
3199 "Parse radio target at point.
3201 Return a list whose CAR is `radio-target' and CDR a plist with
3202 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3203 and `:post-blank' as keywords.
3205 Assume point is at the radio target."
3217 :end end
3218 :contents-begin contents-begin
3219 :contents-end contents-end
3220 :post-blank post-blank
3224 "Interpret TARGET object as Org syntax.
3225 CONTENTS is the contents of the object."
3229 "Search for the next radio-target object.
3231 Return value is a cons cell whose CAR is `radio-target' and CDR
3232 is beginning position."
3238 ;;;; Statistics Cookie
3241 "Parse statistics cookie at point.
3243 Return a list whose CAR is `statistics-cookie', and CDR a plist
3244 with `:begin', `:end', `:value' and `:post-blank' keywords.
3246 Assume point is at the beginning of the statistics-cookie."
3257 :end end
3258 :value value
3262 "Interpret STATISTICS-COOKIE object as Org syntax.
3263 CONTENTS is nil."
3267 "Search for the next statistics cookie object.
3269 Return value is a cons cell whose CAR is `statistics-cookie' and
3270 CDR is beginning position."
3276 ;;;; Strike-Through
3279 "Parse strike-through object at point.
3281 Return a list whose CAR is `strike-through' and CDR is a plist
3282 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3283 `:post-blank' keywords.
3285 Assume point is at the first plus sign marker."
3297 :end end
3298 :contents-begin contents-begin
3299 :contents-end contents-end
3303 "Interpret STRIKE-THROUGH object as Org syntax.
3304 CONTENTS is the contents of the object."
3308 ;;;; Subscript
3311 "Parse subscript at point.
3313 Return a list whose CAR is `subscript' and CDR a plist with
3314 `:begin', `:end', `:contents-begin', `:contents-end',
3315 `:use-brackets-p' and `:post-blank' as keywords.
3317 Assume point is at the underscore."
3321 t
3332 :end end
3333 :use-brackets-p bracketsp
3334 :contents-begin contents-begin
3335 :contents-end contents-end
3339 "Interpret SUBSCRIPT object as Org syntax.
3340 CONTENTS is the contents of the object."
3343 contents))
3346 "Search for the next sub/superscript object.
3348 Return value is a cons cell whose CAR is either `subscript' or
3349 `superscript' and CDR is beginning position."
3357 ;;;; Superscript
3360 "Parse superscript at point.
3362 Return a list whose CAR is `superscript' and CDR a plist with
3363 `:begin', `:end', `:contents-begin', `:contents-end',
3364 `:use-brackets-p' and `:post-blank' as keywords.
3366 Assume point is at the caret."
3380 :end end
3381 :use-brackets-p bracketsp
3382 :contents-begin contents-begin
3383 :contents-end contents-end
3387 "Interpret SUPERSCRIPT object as Org syntax.
3388 CONTENTS is the contents of the object."
3391 contents))
3394 ;;;; Table Cell
3397 "Parse table cell at point.
3399 Return a list whose CAR is `table-cell' and CDR is a plist
3400 containing `:begin', `:end', `:contents-begin', `:contents-end'
3401 and `:post-blank' keywords."
3409 :end end
3410 :contents-begin contents-begin
3411 :contents-end contents-end
3415 "Interpret TABLE-CELL element as Org syntax.
3416 CONTENTS is the contents of the cell, or nil."
3420 "Search for the next table-cell object.
3422 Return value is a cons cell whose CAR is `table-cell' and CDR is
3423 beginning position."
3427 ;;;; Target
3430 "Parse target at point.
3432 Return a list whose CAR is `target' and CDR a plist with
3433 `:begin', `:end', `:value' and `:post-blank' as keywords.
3435 Assume point is at the target."
3445 :end end
3446 :value value
3450 "Interpret TARGET object as Org syntax.
3451 CONTENTS is nil."
3455 "Search for the next target object.
3457 Return value is a cons cell whose CAR is `target' and CDR is
3458 beginning position."
3464 ;;;; Timestamp
3467 "Parse time stamp at point.
3469 Return a list whose CAR is `timestamp', and CDR a plist with
3470 `:type', `:raw-value', `:year-start', `:month-start',
3471 `:day-start', `:hour-start', `:minute-start', `:year-end',
3472 `:month-end', `:day-end', `:hour-end', `:minute-end',
3473 `:repeater-type', `:repeater-value', `:repeater-unit',
3474 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3475 `:end', `:value' and `:post-blank' keywords.
3477 Assume point is at the beginning of the timestamp."
3495 date-start)
3506 raw-value)
3508 :repeater-type
3514 :repeater-unit
3523 :warning-unit
3526 year-start month-start day-start hour-start minute-start year-end
3527 month-end day-end hour-end minute-end)
3528 ;; Parse date-start.
3536 ;; Compute date-end. It can be provided directly in time-stamp,
3537 ;; or extracted from time range. Otherwise, it defaults to the
3538 ;; same values as date-start.
3548 :raw-value raw-value
3549 :year-start year-start
3550 :month-start month-start
3551 :day-start day-start
3552 :hour-start hour-start
3553 :minute-start minute-start
3554 :year-end year-end
3555 :month-end month-end
3556 :day-end day-end
3557 :hour-end hour-end
3558 :minute-end minute-end
3559 :begin begin
3560 :end end
3562 repeater-props
3563 warning-props)))))
3566 "Interpret TIMESTAMP object as Org syntax.
3567 CONTENTS is nil."
3568 ;; Use `:raw-value' if specified.
3570 ;; Otherwise, build timestamp string.
3589 ;; Build an Org timestamp string from TIME. ACTIVEP is
3590 ;; non-nil when time stamp is active. If WITH-TIME-P is
3591 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3592 ;; specify a time range in the timestamp. REPEAT-STRING
3593 ;; is the repeater string, if any.
3597 org-time-stamp-formats)
3598 time)))
3604 nil nil ts)))
3609 " "
3610 s
3612 ;; Return value.
3613 ts)))
3625 build-ts-string
3644 0
3652 "--"
3664 "Search for the next timestamp object.
3666 Return value is a cons cell whose CAR is `timestamp' and CDR is
3667 beginning position."
3675 nil t)
3679 ;;;; Underline
3682 "Parse underline object at point.
3684 Return a list whose CAR is `underline' and CDR is a plist with
3685 `:begin', `:end', `:contents-begin' and `:contents-end' and
3686 `:post-blank' keywords.
3688 Assume point is at the first underscore marker."
3700 :end end
3701 :contents-begin contents-begin
3702 :contents-end contents-end
3706 "Interpret UNDERLINE object as Org syntax.
3707 CONTENTS is the contents of the object."
3711 ;;;; Verbatim
3714 "Parse verbatim object at point.
3716 Return a list whose CAR is `verbatim' and CDR is a plist with
3717 `:value', `:begin', `:end' and `:post-blank' keywords.
3719 Assume point is at the first equal sign marker."
3730 :begin begin
3731 :end end
3735 "Interpret VERBATIM object as Org syntax.
3736 CONTENTS is nil."
3740 \f
3741 ;;; Parsing Element Starting At Point
3742 ;;
3743 ;; `org-element--current-element' is the core function of this section.
3744 ;; It returns the Lisp representation of the element starting at
3745 ;; point.
3746 ;;
3747 ;; `org-element--current-element' makes use of special modes. They
3748 ;; are activated for fixed element chaining (i.e. `plain-list' >
3749 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3750 ;; `section'). Special modes are: `first-section', `item',
3751 ;; `node-property', `quote-section', `section' and `table-row'.
3755 "Parse the element starting at point.
3757 Return value is a list like (TYPE PROPS) where TYPE is the type
3758 of the element and PROPS a plist of properties associated to the
3759 element.
3761 Possible types are defined in `org-element-all-elements'.
3763 LIMIT bounds the search.
3765 Optional argument GRANULARITY determines the depth of the
3766 recursion. Allowed values are `headline', `greater-element',
3767 `element', `object' or nil. When it is broader than `object' (or
3768 nil), secondary values will not be parsed, since they only
3769 contain objects.
3771 Optional argument SPECIAL, when non-nil, can be either
3772 `first-section', `item', `node-property', `quote-section',
3773 `section', and `table-row'.
3775 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3776 be computed.
3778 This function assumes point is always at the beginning of the
3779 element it has to parse."
3782 ;; Determine if parsing depth allows for secondary strings
3783 ;; parsing. It only applies to elements referenced in
3784 ;; `org-element-secondary-value-alist'.
3787 ;; Item.
3790 ;; Table Row.
3792 ;; Node Property.
3794 ;; Headline.
3797 ;; Sections (must be checked after headline).
3803 limit)))
3804 ;; When not at bol, point is at the beginning of an item or
3805 ;; a footnote definition: next item is always a paragraph.
3807 ;; Planning and Clock.
3812 ;; Inlinetask.
3815 ;; From there, elements can have affiliated keywords.
3818 ;; Jumping over affiliated keywords put point off-limits.
3819 ;; Parse them as regular keywords.
3823 ;; LaTeX Environment.
3827 ;; Drawer and Property Drawer.
3832 ;; Fixed Width
3835 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3836 ;; Keywords.
3845 org-element-block-name-alist)))
3860 ;; Footnote Definition.
3863 ;; Horizontal Rule.
3866 ;; Diary Sexp.
3869 ;; Table.
3871 ;; List.
3874 limit affiliated
3876 ;; Default element: Paragraph.
3880 ;; Most elements can have affiliated keywords. When looking for an
3881 ;; element beginning, we want to move before them, as they belong to
3882 ;; that element, and, in the meantime, collect information they give
3883 ;; into appropriate properties. Hence the following function.
3886 "Collect affiliated keywords from point down to LIMIT.
3888 Return a list whose CAR is the position at the first of them and
3889 CDR a plist of keywords and values and move point to the
3890 beginning of the first line after them.
3892 As a special case, if element doesn't start at the beginning of
3893 the line (i.e. a paragraph starting an item), CAR is current
3894 position of point and CDR is nil."
3898 ;; RESTRICT is the list of objects allowed in parsed
3899 ;; keywords value.
3901 output)
3904 ;; Apply translation to RAW-KWD. From there, KWD is
3905 ;; the official keyword.
3907 org-element-keyword-translation-alist))
3908 raw-kwd))
3909 ;; Find main value for any keyword.
3915 ;; PARSEDP is non-nil when keyword should have its
3916 ;; value parsed.
3918 ;; If KWD is a dual keyword, find its secondary
3919 ;; value. Maybe parse it.
3926 ;; Attribute a property name to KWD.
3928 ;; Now set final shape for VALUE.
3934 ;; Attributes can always appear on multiple lines.
3937 ;; Eventually store the new value in OUTPUT.
3939 ;; Move to next keyword.
3941 ;; If affiliated keywords are orphaned: move back to first one.
3942 ;; They will be parsed as a paragraph.
3944 ;; Return value.
3948 \f
3949 ;;; The Org Parser
3950 ;;
3951 ;; The two major functions here are `org-element-parse-buffer', which
3952 ;; parses Org syntax inside the current buffer, taking into account
3953 ;; region, narrowing, or even visibility if specified, and
3954 ;; `org-element-parse-secondary-string', which parses objects within
3955 ;; a given string.
3956 ;;
3957 ;; The (almost) almighty `org-element-map' allows to apply a function
3958 ;; on elements or objects matching some type, and accumulate the
3959 ;; resulting values. In an export situation, it also skips unneeded
3960 ;; parts of the parse tree.
3963 "Recursively parse the buffer and return structure.
3964 If narrowing is in effect, only parse the visible part of the
3965 buffer.
3967 Optional argument GRANULARITY determines the depth of the
3968 recursion. It can be set to the following symbols:
3970 `headline' Only parse headlines.
3971 `greater-element' Don't recurse into greater elements excepted
3972 headlines and sections. Thus, elements
3973 parsed are the top-level ones.
3974 `element' Parse everything but objects and plain text.
3975 `object' Parse the complete buffer (default).
3977 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3978 elements.
3980 An element or an objects is represented as a list with the
3981 pattern (TYPE PROPERTIES CONTENTS), where :
3983 TYPE is a symbol describing the element or object. See
3984 `org-element-all-elements' and `org-element-all-objects' for an
3985 exhaustive list of such symbols. One can retrieve it with
3986 `org-element-type' function.
3988 PROPERTIES is the list of attributes attached to the element or
3989 object, as a plist. Although most of them are specific to the
3990 element or object type, all types share `:begin', `:end',
3991 `:post-blank' and `:parent' properties, which respectively
3992 refer to buffer position where the element or object starts,
3993 ends, the number of white spaces or blank lines after it, and
3994 the element or object containing it. Properties values can be
3995 obtained by using `org-element-property' function.
3997 CONTENTS is a list of elements, objects or raw strings
3998 contained in the current element or object, when applicable.
3999 One can access them with `org-element-contents' function.
4001 The Org buffer has `org-data' as type and nil as properties.
4002 `org-element-map' function can be used to find specific elements
4003 or objects within the parse tree.
4005 This function assumes that current major mode is `org-mode'."
4011 ;; Start in `first-section' mode so text before the first
4012 ;; headline belongs to a section.
4016 "Recursively parse objects in STRING and return structure.
4018 RESTRICTION is a symbol limiting the object types that will be
4019 looked after.
4021 Optional argument PARENT, when non-nil, is the element or object
4022 containing the secondary string. It is used to set correctly
4023 `:parent' property within the string."
4024 ;; Copy buffer-local variables listed in
4025 ;; `org-element-object-variables' into temporary buffer. This is
4026 ;; required since object parsing is dependent on these variables.
4030 org-element-object-variables))))
4038 secondary))
4039 secondary))))
4043 "Map a function on selected elements or objects.
4045 DATA is a parse tree, an element, an object, a string, or a list
4046 of such constructs. TYPES is a symbol or list of symbols of
4047 elements or objects types (see `org-element-all-elements' and
4048 `org-element-all-objects' for a complete list of types). FUN is
4049 the function called on the matching element or object. It has to
4050 accept one argument: the element or object itself.
4052 When optional argument INFO is non-nil, it should be a plist
4053 holding export options. In that case, parts of the parse tree
4054 not exportable according to that property list will be skipped.
4056 When optional argument FIRST-MATCH is non-nil, stop at the first
4057 match for which FUN doesn't return nil, and return that value.
4059 Optional argument NO-RECURSION is a symbol or a list of symbols
4060 representing elements or objects types. `org-element-map' won't
4061 enter any recursive element or object whose type belongs to that
4062 list. Though, FUN can still be applied on them.
4064 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4065 apply to matching objects within parsed affiliated keywords (see
4066 `org-element-parsed-keywords').
4068 Nil values returned from FUN do not appear in the results.
4071 Examples:
4072 ---------
4074 Assuming TREE is a variable containing an Org buffer parse tree,
4075 the following example will return a flat list of all `src-block'
4076 and `example-block' elements in it:
4078 \(org-element-map tree '(example-block src-block) 'identity)
4080 The following snippet will find the first headline with a level
4083 \(org-element-map tree 'headline
4084 \(lambda (hl)
4085 \(and (= (org-element-property :level hl) 1)
4087 \(org-element-property :begin hl)))
4088 nil t)
4090 The next example will return a flat list of all `plain-list' type
4091 elements in TREE that are not a sub-list themselves:
4093 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4095 Eventually, this example will return a flat list of all `bold'
4096 type objects containing a `latex-snippet' type object, even
4097 looking into captions:
4099 \(org-element-map tree 'bold
4100 \(lambda (b)
4101 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4102 nil nil nil t)"
4103 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4106 ;; Recursion depth is determined by --CATEGORY.
4113 ;; If one object is found, the function
4114 ;; has to recurse into every object.
4117 ;; If one regular element is found, the
4118 ;; function has to recurse, at least,
4119 ;; into every element it encounters.
4122 types)
4123 category)))
4124 ;; Compute properties for affiliated keywords if necessary.
4129 org-element-affiliated-keywords)))
4130 --acc
4131 --walk-tree
4135 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4136 ;; holding contextual information.
4140 ;; Ignored element in an export context.
4142 ;; List of elements or objects.
4144 ;; Unconditionally enter parse trees.
4148 ;; Check if TYPE is matching among TYPES. If so,
4149 ;; apply FUN to --DATA and accumulate return value
4150 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4156 ;; If --DATA has a secondary string that can contain
4157 ;; objects with their type among TYPES, look into it.
4164 ;; If --DATA has any affiliated keywords and
4165 ;; WITH-AFFILIATED is non-nil, look for objects in
4166 ;; them.
4174 ;; Pay attention to the type of value.
4175 ;; Preserve order for multiple keywords.
4191 --affiliated-alist))
4192 ;; Determine if a recursion into --DATA is possible.
4194 ;; --TYPE is explicitly removed from recursion.
4196 ;; --DATA has no contents.
4198 ;; Looking for greater elements but --DATA is simply
4199 ;; an element or an object.
4202 ;; Looking for elements but --DATA is an object.
4205 ;; In any other case, map contents.
4209 ;; Return value in a proper order.
4213 ;; The following functions are internal parts of the parser.
4214 ;;
4215 ;; The first one, `org-element--parse-elements' acts at the element's
4216 ;; level.
4217 ;;
4218 ;; The second one, `org-element--parse-objects' applies on all objects
4219 ;; of a paragraph or a secondary string. It uses
4220 ;; `org-element--get-next-object-candidates' to optimize the search of
4221 ;; the next object in the buffer.
4222 ;;
4223 ;; More precisely, that function looks for every allowed object type
4224 ;; first. Then, it discards failed searches, keeps further matches,
4225 ;; and searches again types matched behind point, for subsequent
4226 ;; calls. Thus, searching for a given type fails only once, and every
4227 ;; object is searched only once at top level (but sometimes more for
4228 ;; nested types).
4232 "Parse elements between BEG and END positions.
4234 SPECIAL prioritize some elements over the others. It can be set
4235 to `first-section', `quote-section', `section' `item' or
4236 `table-row'.
4238 When value is `item', STRUCTURE will be used as the current list
4239 structure.
4241 GRANULARITY determines the depth of the recursion. See
4242 `org-element-parse-buffer' for more information.
4244 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4245 elements.
4247 Elements are accumulated into ACC."
4250 ;; Visible only: skip invisible parts at the beginning of the
4251 ;; element.
4254 ;; When parsing only headlines, skip any text before first one.
4257 ;; Main loop start.
4259 ;; Find current element's type and parse it accordingly to
4260 ;; its category.
4262 end granularity special structure))
4266 ;; Visible only: skip invisible parts between siblings.
4269 ;; Fill ELEMENT contents by side-effect.
4271 ;; If element has no contents, don't modify it.
4273 ;; Greater element: parse it between `contents-begin' and
4274 ;; `contents-end'. Make sure GRANULARITY allows the
4275 ;; recursion, or ELEMENT is a headline, in which case going
4276 ;; inside is mandatory, in order to get sub-level headings.
4284 ;; Possibly switch to a special mode.
4294 granularity visible-only element))
4295 ;; ELEMENT has contents. Parse objects inside, if
4296 ;; GRANULARITY allows it.
4302 ;; Return result.
4303 acc))
4306 "Parse objects between BEG and END and return recursive structure.
4308 Objects are accumulated in ACC.
4310 RESTRICTION is a list of object successors which are allowed in
4311 the current object."
4320 restriction candidates)))
4327 ;; 1. Text before any object. Untabify it.
4332 acc
4336 ;; 2. Object...
4339 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4340 ;; a recursive type.
4348 ;; 3. Text after last object. Untabify it.
4352 acc
4356 ;; Result.
4357 acc))))
4360 "Return an alist of candidates for the next object.
4362 RESTRICTION is a list of object types, as symbols. Only
4363 candidates with such types are looked after.
4365 OBJECTS is the previous candidates alist. If it is set to
4366 `initial', no search has been done before, and all symbols in
4367 RESTRICTION should be looked after.
4369 Return value is an alist whose CAR is the object type and CDR its
4370 beginning position."
4372 nil
4374 ;; When searching for the first time, look for every successor
4375 ;; allowed in RESTRICTION.
4379 restriction)
4380 ;; Focus on objects returned during last search. Keep those
4381 ;; still after point. Search again objects before it.
4387 type)))
4390 objects))))
4393 \f
4394 ;;; Towards A Bijective Process
4395 ;;
4396 ;; The parse tree obtained with `org-element-parse-buffer' is really
4397 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4398 ;; interpreted and expanded into a string with canonical Org syntax.
4399 ;; Hence `org-element-interpret-data'.
4400 ;;
4401 ;; The function relies internally on
4402 ;; `org-element--interpret-affiliated-keywords'.
4404 ;;;###autoload
4406 "Interpret DATA as Org syntax.
4408 DATA is a parse tree, an element, an object or a secondary string
4409 to interpret.
4411 Optional argument PARENT is used for recursive calls. It contains
4412 the element or object containing data, or nil.
4414 Return Org syntax as a string."
4418 ;; Secondary string.
4423 ;; Full Org document.
4428 ;; Plain text: remove `:parent' text property from output.
4430 ;; Element/Object without contents.
4433 data nil))
4434 ;; Element/Object with contents.
4444 ;; Elements directly containing objects must
4445 ;; have their indentation normalized first.
4447 data
4448 ;; When normalizing first paragraph of an
4449 ;; item or a footnote-definition, ignore
4450 ;; first line's indentation.
4457 data
4459 contents)))))))
4461 ;; Build white spaces. If no `:post-blank' property is
4462 ;; specified, assume its value is 0.
4472 "Return ELEMENT's affiliated keywords as Org syntax.
4473 If there is no affiliated keyword, return the empty string."
4483 ": "
4486 value)
4494 ;; All attribute keywords can have multiple lines.
4500 ;; List all ELEMENT's properties matching an attribute line or an
4501 ;; affiliated keyword, but ignore translated keywords since they
4502 ;; cannot belong to the property list.
4509 org-element-keyword-translation-alist)))))
4510 collect prop)
4513 ;; Because interpretation of the parse tree must return the same
4514 ;; number of blank lines between elements and the same number of white
4515 ;; space after objects, some special care must be given to white
4516 ;; spaces.
4517 ;;
4518 ;; The first function, `org-element-normalize-string', ensures any
4519 ;; string different from the empty string will end with a single
4520 ;; newline character.
4521 ;;
4522 ;; The second function, `org-element-normalize-contents', removes
4523 ;; global indentation from the contents of the current element.
4526 "Ensure string S ends with a single newline character.
4528 If S isn't a string return it unchanged. If S is the empty
4529 string, return it. Otherwise, return a new string with a single
4530 newline character at its end."
4538 "Normalize plain text in ELEMENT's contents.
4540 ELEMENT must only contain plain text and objects.
4542 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4543 indentation to compute maximal common indentation.
4545 Return the normalized element that is element with global
4546 indentation removed from its contents. The function assumes that
4547 indentation is not done with TAB characters."
4549 collect-inds ; for byte-compiler
4552 ;; Return list of indentations within BLOB. This is done by
4553 ;; walking recursively BLOB and updating IND-LIST along the
4554 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4555 ;; been seen yet. It is required as this string is the only
4556 ;; one whose indentation doesn't happen after a newline
4557 ;; character.
4565 ;; An indentation of zero means no string will be
4566 ;; modified. Quit the process.
4572 ;; Avoid matching blank or empty lines.
4580 ;; Collect indentation list in ELEMENT. Possibly remove first
4581 ;; value if IGNORE-FIRST is non-nil.
4584 ;; Build ELEMENT back, replacing each string with the same
4585 ;; string minus common indentation.
4590 ;; Return BLOB with all its strings indentation
4591 ;; shortened from MCI white spaces. FIRST-FLAG is
4592 ;; non-nil when the first string hasn't been seen
4593 ;; yet.
4607 org-element-recursive-objects)
4611 blob))))
4615 \f
4616 ;;; The Toolbox
4617 ;;
4618 ;; The first move is to implement a way to obtain the smallest element
4619 ;; containing point. This is the job of `org-element-at-point'. It
4620 ;; basically jumps back to the beginning of section containing point
4621 ;; and moves, element after element, with
4622 ;; `org-element--current-element' until the container is found. Note:
4623 ;; When using `org-element-at-point', secondary values are never
4624 ;; parsed since the function focuses on elements, not on objects.
4625 ;;
4626 ;; At a deeper level, `org-element-context' lists all elements and
4627 ;; objects containing point.
4628 ;;
4629 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4630 ;; internally by navigation and manipulation tools.
4632 ;;;###autoload
4634 "Determine closest element around point.
4636 Return value is a list like (TYPE PROPS) where TYPE is the type
4637 of the element and PROPS a plist of properties associated to the
4638 element.
4640 Possible types are defined in `org-element-all-elements'.
4641 Properties depend on element or object type, but always include
4642 `:begin', `:end', `:parent' and `:post-blank' properties.
4644 As a special case, if point is at the very beginning of a list or
4645 sub-list, returned element will be that list instead of the first
4646 item. In the same way, if point is at the beginning of the first
4647 row of a table, returned element will be the table instead of the
4648 first row.
4650 If optional argument KEEP-TRAIL is non-nil, the function returns
4651 a list of elements leading to element at point. The list's CAR
4652 is always the element at point. The following positions contain
4653 element's siblings, then parents, siblings of parents, until the
4654 first element of current section."
4656 ;; If at a headline, parse it. It is the sole element that
4657 ;; doesn't require to know about context. Be sure to disallow
4658 ;; secondary string parsing, though.
4664 ;; Otherwise move at the beginning of the section containing
4665 ;; point.
4670 element type special-flag trail struct prevs parent)
4673 ;; In empty lines at buffer's beginning, return nil.
4682 ;; In blank lines just after the headline, point still
4683 ;; belongs to the headline.
4692 ;; Parse successively each element, skipping those ending
4693 ;; before original position.
4701 ;; 1. Skip any element ending before point. Also skip
4702 ;; element ending at point when we're sure that another
4703 ;; element has started.
4708 ;; 2. An element containing point is always the element at
4709 ;; point.
4712 ;; 3. At any other greater element type, if point is
4713 ;; within contents, move into it.
4718 ;; Create an anchor for tables and plain lists:
4719 ;; when point is at the very beginning of these
4720 ;; elements, ignoring affiliated keywords,
4721 ;; target them instead of their contents.
4723 ;; When point is at contents end, do not move
4724 ;; into elements with an explicit ending, but
4725 ;; return that element instead.
4729 drawer dynamic-block inlinetask
4730 property-drawer quote-block
4731 special-block))
4732 ;; Corner case: if a list ends at the
4733 ;; end of a buffer without a final new
4734 ;; line, return last element in last
4735 ;; item instead.
4753 ;;;###autoload
4755 "Return closest element or object around point.
4757 Return value is a list like (TYPE PROPS) where TYPE is the type
4758 of the element or object and PROPS a plist of properties
4759 associated to it.
4761 Possible types are defined in `org-element-all-elements' and
4762 `org-element-all-objects'. Properties depend on element or
4763 object type, but always include `:begin', `:end', `:parent' and
4764 `:post-blank'.
4766 Optional argument ELEMENT, when non-nil, is the closest element
4767 containing point, as returned by `org-element-at-point'.
4768 Providing it allows for quicker computation."
4774 context)
4775 ;; Check if point is inside an element containing objects or at
4776 ;; a secondary string. In that case, narrow buffer to the
4777 ;; containing area. Otherwise, return ELEMENT.
4779 ;; At a parsed affiliated keyword, check if we're inside main
4780 ;; or dual value.
4795 ;; Also change type to retrieve correct restrictions.
4797 ;; At an item, objects can only be located within tag, if any.
4807 ;; At an headline or inlinetask, objects are located within
4808 ;; their title.
4815 ;; At a paragraph, a table-row or a verse block, objects are
4816 ;; located within their contents.
4820 ;; CBEG is nil for table rules.
4824 ;; At a parsed keyword, objects are located within value.
4827 org-element-document-properties))
4842 restriction candidates))
4844 candidates)))
4845 ;; If ORIGIN is before next object in element, there's
4846 ;; no point in looking further.
4856 ;; ORIGIN is after OBJECT, so skip it.
4858 ;; ORIGIN is within a non-recursive object or at
4859 ;; an object boundaries: Return that object.
4863 ;; Otherwise, move within current object and
4864 ;; restrict search to the end of its contents.
4871 parent))))))
4874 "Non-nil when elements ELEM-A and ELEM-B are nested."
4883 "Swap elements ELEM-A and ELEM-B.
4884 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4885 end of ELEM-A."
4887 ;; There are two special cases when an element doesn't start at bol:
4888 ;; the first paragraph in an item or in a footnote definition.
4890 ;; Only a paragraph without any affiliated keyword can be moved at
4891 ;; ELEM-A position in such a situation. Note that the case of
4892 ;; a footnote definition is impossible: it cannot contain two
4893 ;; paragraphs in a row because it cannot contain a blank line.
4899 ;; In a special situation, ELEM-A will have no indentation. We'll
4900 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4914 ;; Store overlays responsible for visibility status. We
4915 ;; also need to store their boundaries as they will be
4916 ;; removed from buffer.
4923 ;; Get contents.
4931 ;; Restore ex ELEM-A overlays.
4940 ;; Restore ex ELEM-B overlays.
4948 "Remove maximum common indentation in string S and return it.
4949 When optional argument N is a positive integer, remove exactly
4950 that much characters from indentation, if possible, or return
4951 S as-is otherwise. Unlike to `org-remove-indentation', this
4952 function doesn't call `untabify' on S."
4957 ;; Find maximum common indentation, if not specified.
4965 min-ind)))
4967 ;; Remove exactly N indentation, but give up if not possible.
4979 ;; Local variables:
4980 ;; generated-autoload-file: "org-loaddefs.el"
4981 ;; End:
4983 ;;; org-element.el ends here