| blob | 77b2bc26ef990b737b8e98a1bdc3f6e295033437 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 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 and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block quote-section section
180 special-block src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 latex-or-entity line-break link macro plain-link radio-target
192 statistics-cookie sub/superscript table-cell target
193 text-markup timestamp)
202 "Alist of translations between object type and successor name.
203 Sharing the same successor comes handy when, for example, the
208 inline-src-block italic line-break latex-fragment link macro
209 radio-target statistics-cookie strike-through subscript superscript
210 table-cell target timestamp underline verbatim)
215 table-cell underline)
225 "Alist between block names and the associated parsing function.
226 Names must be uppercase. Any block whose name has no association
232 Only these types can accept search options and an explicit
238 "List of affiliated keywords as strings.
246 "Alist of usual translations for keywords.
247 The key is the old name and the value the new one. The property
251 "List of affiliated keywords that can occur more than once in an element.
253 Their value will be consed into a list of strings, which will be
254 returned as the value of the property.
256 This list is checked after translations have been applied. See
257 `org-element-keyword-translation-alist'.
263 "List of affiliated keywords whose value can be parsed.
265 Their value will be stored as a secondary string: a list of
266 strings and objects.
268 This list is checked after translations have been applied. See
272 "List of affiliated keywords which can have a secondary value.
274 In Org syntax, they can be written with optional square brackets
275 before the colons. For example, RESULTS keyword can be
276 associated to a hash value with the following:
278 #+RESULTS[hash-string]: some-source
280 This list is checked after translations have been applied. See
284 "List of properties associated to the whole document.
285 Any keyword in this list will have its value parsed and stored as
291 ;; Dual affiliated keywords.
295 ;; Regular affiliated keywords.
301 org-element-affiliated-keywords)))
303 ;; Export attributes.
305 "Regexp matching any affiliated keyword.
307 Keyword name is put in match group 1. Moreover, if keyword
308 belongs to `org-element-dual-keywords', put the dual value in
309 match group 2.
324 ;; Ignore all links excepted plain links in a link description.
325 ;; Also ignore radio-targets and line breaks.
329 ;; Remove any variable object from radio target as it would
330 ;; prevent it from being properly recognized.
335 ;; Ignore inline babel call and inline src block as formulas are
336 ;; possible. Also ignore line breaks and statistics cookies.
342 "Alist of objects restrictions.
344 CAR is an element or object type containing objects and CDR is
345 a list of successors that will be called within an element or
346 object of such type.
348 For example, in a `radio-target' object, one can only find
349 entities, latex-fragments, subscript and superscript.
351 This alist also applies to secondary string. For example, an
352 `headline' type element doesn't directly contain objects, but
363 "List of buffer-local variables used when parsing objects.
364 These variables are copied to the temporary buffer created by
368 \f
369 ;;; Accessors and Setters
370 ;;
371 ;; Provide four accessors: `org-element-type', `org-element-property'
372 ;; `org-element-contents' and `org-element-restriction'.
373 ;;
374 ;; Setter functions allow to modify elements by side effect. There is
375 ;; `org-element-put-property', `org-element-set-contents',
376 ;; `org-element-set-element' and `org-element-adopt-element'. Note
377 ;; that `org-element-set-element' and `org-element-adopt-elements' are
378 ;; higher level functions since also update `:parent' property.
381 "Return type of ELEMENT.
383 The function returns the type of the element or object provided.
384 It can also return the following special value:
385 `plain-text' for a string
386 `org-data' for a complete document
387 nil in any other case."
393 "Extract the value from the PROPERTY of an ELEMENT."
398 "Extract contents from an ELEMENT."
404 "Return restriction associated to ELEMENT.
405 ELEMENT can be an element, an object or a symbol representing an
406 element or object type."
408 org-element-object-restrictions)))
411 "In ELEMENT set PROPERTY to VALUE.
412 Return modified element."
415 element))
418 "Set ELEMENT contents to CONTENTS.
419 Return modified element."
426 "Replace element or object OLD with element or object NEW.
427 The function takes care of setting `:parent' property for NEW."
428 ;; Since OLD is going to be changed into NEW by side-effect, first
429 ;; make sure that every element or object within NEW has OLD as
430 ;; parent.
433 ;; Transfer contents.
435 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
436 ;; with NEW's.
439 ;; Transfer type.
443 "Append elements to the contents of another element.
445 PARENT is an element or object. CHILDREN can be elements,
446 objects, or a strings.
448 The function takes care of setting `:parent' property for CHILD.
449 Return parent element."
450 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
451 ;; string: parent is the list itself.
454 children)
455 ;; Add CHILDREN at the end of PARENT contents.
458 parent
460 ;; Return modified PARENT element.
464 \f
465 ;;; Greater elements
466 ;;
467 ;; For each greater element type, we define a parser and an
468 ;; interpreter.
469 ;;
470 ;; A parser returns the element or object as the list described above.
471 ;; Most of them accepts no argument. Though, exceptions exist. Hence
472 ;; every element containing a secondary string (see
473 ;; `org-element-secondary-value-alist') will accept an optional
474 ;; argument to toggle parsing of that secondary string. Moreover,
475 ;; `item' parser requires current list's structure as its first
476 ;; element.
477 ;;
478 ;; An interpreter accepts two arguments: the list representation of
479 ;; the element or object, and its contents. The latter may be nil,
480 ;; depending on the element or object considered. It returns the
481 ;; appropriate Org syntax, as a string.
482 ;;
483 ;; Parsing functions must follow the naming convention:
484 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
485 ;; defined in `org-element-greater-elements'.
486 ;;
487 ;; Similarly, interpreting functions must follow the naming
488 ;; convention: org-element-TYPE-interpreter.
489 ;;
490 ;; With the exception of `headline' and `item' types, greater elements
491 ;; cannot contain other greater elements of their own type.
492 ;;
493 ;; Beside implementing a parser and an interpreter, adding a new
494 ;; greater element requires to tweak `org-element--current-element'.
495 ;; Moreover, the newly defined type must be added to both
496 ;; `org-element-all-elements' and `org-element-greater-elements'.
499 ;;;; Center Block
502 "Parse a center block.
504 LIMIT bounds the search. AFFILIATED is a list of which CAR is
505 the buffer position at the beginning of the first affiliated
506 keyword and CDR is a plist of affiliated keywords along with
507 their value.
509 Return a list whose CAR is `center-block' and CDR is a plist
510 containing `:begin', `:end', `:hiddenp', `:contents-begin',
511 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
513 Assume point is at the beginning of the block."
517 ;; Incomplete block: parse it as a paragraph.
522 ;; Empty blocks have no contents.
537 :end end
538 :hiddenp hidden
539 :contents-begin contents-begin
540 :contents-end contents-end
546 "Interpret CENTER-BLOCK element as Org syntax.
547 CONTENTS is the contents of the element."
551 ;;;; Drawer
554 "Parse a drawer.
556 LIMIT bounds the search. AFFILIATED is a list of which CAR is
557 the buffer position at the beginning of the first affiliated
558 keyword and CDR is a plist of affiliated keywords along with
559 their value.
561 Return a list whose CAR is `drawer' and CDR is a plist containing
562 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
563 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
565 Assume point is at beginning of drawer."
568 ;; Incomplete drawer: parse it as a paragraph.
576 ;; Empty drawers have no contents.
590 :end end
591 :drawer-name name
592 :hiddenp hidden
593 :contents-begin contents-begin
594 :contents-end contents-end
600 "Interpret DRAWER element as Org syntax.
601 CONTENTS is the contents of the element."
604 contents))
607 ;;;; Dynamic Block
610 "Parse a dynamic block.
612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
613 the buffer position at the beginning of the first affiliated
614 keyword and CDR is a plist of affiliated keywords along with
615 their value.
617 Return a list whose CAR is `dynamic-block' and CDR is a plist
618 containing `:block-name', `:begin', `:end', `:hiddenp',
619 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
620 and `:post-affiliated' keywords.
622 Assume point is at beginning of dynamic block."
626 ;; Incomplete block: parse it as a paragraph.
635 ;; Empty blocks have no contents.
649 :end end
650 :block-name name
651 :arguments arguments
652 :hiddenp hidden
653 :contents-begin contents-begin
654 :contents-end contents-end
660 "Interpret DYNAMIC-BLOCK element as Org syntax.
661 CONTENTS is the contents of the element."
666 contents))
669 ;;;; Footnote Definition
672 "Parse a footnote definition.
674 LIMIT bounds the search. AFFILIATED is a list of which CAR is
675 the buffer position at the beginning of the first affiliated
676 keyword and CDR is a plist of affiliated keywords along with
677 their value.
679 Return a list whose CAR is `footnote-definition' and CDR is
680 a plist containing `:label', `:begin' `:end', `:contents-begin',
681 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
683 Assume point is at the beginning of the footnote definition."
711 :begin begin
712 :end end
713 :contents-begin contents-begin
714 :contents-end contents-end
720 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
721 CONTENTS is the contents of the footnote-definition."
723 " "
724 contents))
727 ;;;; Headline
730 "Parse a headline.
732 Return a list whose CAR is `headline' and CDR is a plist
733 containing `:raw-value', `:title', `:alt-title', `:begin',
734 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
735 `:contents-end', `:level', `:priority', `:tags',
736 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
737 `:closed', `:quotedp', `:archivedp', `:commentedp' and
738 `:footnote-section-p' keywords.
740 The plist also contains any property set in the property drawer,
741 with its name in upper cases and colons added at the
742 beginning (i.e. `:CUSTOM_ID').
744 When RAW-SECONDARY-P is non-nil, headline's title will not be
745 parsed as a secondary string, but as a plain string instead.
747 Assume point is at beginning of the headline."
760 raw-value)))
764 raw-value)))
768 ;; Upcase property names. It avoids confusion between
769 ;; properties obtained through property drawer and default
770 ;; properties from the parser (e.g. `:end' and :END:)
780 plist))
782 ;; Read time properties on the line below the headline.
788 org-keyword-time-not-clock-regexp end t)
798 plist))))
811 ;; Clean RAW-VALUE from any quote or comment string.
819 ""
820 raw-value))))
821 ;; Clean TAGS from archive tag, if any.
827 :begin begin
828 :end end
829 :pre-blank
832 :hiddenp hidden
833 :contents-begin contents-begin
834 :contents-end contents-end
835 :level level
837 :tags tags
838 :todo-keyword todo
839 :todo-type todo-type
845 end)
846 :footnote-section-p footnote-section-p
847 :archivedp archivedp
848 :commentedp commentedp
850 time-props
851 standard-props))))
855 headline :alt-title
860 headline :title
866 "Interpret HEADLINE element as Org syntax.
867 CONTENTS is the contents of the element."
894 ;; Align tags.
902 ? )
903 tags))
907 tags))))
909 contents)))
912 ;;;; Inlinetask
915 "Parse an inline task.
917 Return a list whose CAR is `inlinetask' and CDR is a plist
918 containing `:title', `:begin', `:end', `:hiddenp',
919 `:contents-begin' and `:contents-end', `:level', `:priority',
920 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
921 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
923 The plist also contains any property set in the property drawer,
924 with its name in upper cases and colons added at the
925 beginning (i.e. `:CUSTOM_ID').
927 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
928 title will not be parsed as a secondary string, but as a plain
929 string instead.
931 Assume point is at beginning of the inline task."
941 ;; Upcase property names. It avoids confusion between
942 ;; properties obtained through property drawer and default
943 ;; properties from the parser (e.g. `:end' and :END:)
953 plist))
955 ;; Read time properties on the line below the inlinetask
956 ;; opening string.
962 org-keyword-time-not-clock-regexp end t)
972 plist))))
991 :begin begin
992 :end end
993 :hiddenp hidden
994 :contents-begin contents-begin
995 :contents-end contents-end
998 :tags tags
999 :todo-keyword todo
1000 :todo-type todo-type
1002 time-props
1003 standard-props))))
1005 inlinetask :title
1008 raw-value
1010 inlinetask))))))
1013 "Interpret INLINETASK element as Org syntax.
1014 CONTENTS is the contents of inlinetask."
1029 ;; Align tags.
1037 ? )
1038 tags))
1042 tags))))
1043 ;; Prefer degenerate inlinetasks when there are no
1044 ;; contents.
1047 contents
1051 ;;;; Item
1054 "Parse an item.
1056 STRUCT is the structure of the plain list.
1058 Return a list whose CAR is `item' and CDR is a plist containing
1059 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1060 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1061 `:post-blank' keywords.
1063 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1064 any, will not be parsed as a secondary string, but as a plain
1065 string instead.
1067 Assume point is at the beginning of the item."
1091 ;; Ignore tags in un-ordered lists: they are just
1092 ;; a part of item's body.
1098 ;; If first line isn't empty, contents really start
1099 ;; at the text after item's meta-data.
1110 :begin begin
1111 :end end
1112 ;; CONTENTS-BEGIN and CONTENTS-END may be
1113 ;; mixed up in the case of an empty item
1114 ;; separated from the next by a blank line.
1115 ;; Thus ensure the former is always the
1116 ;; smallest.
1119 :checkbox checkbox
1120 :counter counter
1121 :hiddenp hidden
1122 :structure struct
1125 item :tag
1133 "Interpret ITEM element as Org syntax.
1134 CONTENTS is the contents of the element."
1144 ;; Compute indentation.
1149 ;; Indent contents.
1151 bullet
1165 ;;;; Plain List
1168 ;; Return structure of list at point. Internal function. See
1169 ;; `org-list-struct' for details.
1177 items struct)
1182 ;; At limit: end all items.
1191 ;; At list end: end all items.
1196 ;; At a new item: end previous sibling.
1208 ind
1209 bullet
1212 ;; Description tag.
1216 ;; Ending position, unknown so far.
1217 nil)))
1218 items))
1220 ;; Skip empty lines.
1222 ;; Skip inline tasks and blank lines along the way.
1229 ;; At some text line. Check if it ends any previous item.
1241 ;; Skip blocks (any type) and drawers contents.
1247 limit t)))
1253 "Parse a plain list.
1255 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1256 the buffer position at the beginning of the first affiliated
1257 keyword and CDR is a plist of affiliated keywords along with
1258 their value. STRUCTURE is the structure of the plain list being
1259 parsed.
1261 Return a list whose CAR is `plain-list' and CDR is a plist
1262 containing `:type', `:begin', `:end', `:contents-begin' and
1263 `:contents-end', `:structure', `:post-blank' and
1264 `:post-affiliated' keywords.
1266 Assume point is at the beginning of the list."
1279 ;; Return value.
1283 :begin begin
1284 :end end
1285 :contents-begin contents-begin
1286 :contents-end contents-end
1287 :structure struct
1293 "Interpret PLAIN-LIST element as Org syntax.
1294 CONTENTS is the contents of the element."
1302 ;;;; Property Drawer
1305 "Parse a property drawer.
1307 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1308 the buffer position at the beginning of the first affiliated
1309 keyword and CDR is a plist of affiliated keywords along with
1310 their value.
1312 Return a list whose CAR is `property-drawer' and CDR is a plist
1313 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1314 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1316 Assume point is at the beginning of the property drawer."
1321 ;; Incomplete drawer: parse it as a paragraph.
1340 :end end
1341 :hiddenp hidden
1342 :contents-begin contents-begin
1343 :contents-end contents-end
1349 "Interpret PROPERTY-DRAWER element as Org syntax.
1350 CONTENTS is the properties within the drawer."
1354 ;;;; Quote Block
1357 "Parse a quote block.
1359 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1360 the buffer position at the beginning of the first affiliated
1361 keyword and CDR is a plist of affiliated keywords along with
1362 their value.
1364 Return a list whose CAR is `quote-block' and CDR is a plist
1365 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1366 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1368 Assume point is at the beginning of the block."
1372 ;; Incomplete block: parse it as a paragraph.
1378 ;; Empty blocks have no contents.
1392 :end end
1393 :hiddenp hidden
1394 :contents-begin contents-begin
1395 :contents-end contents-end
1401 "Interpret QUOTE-BLOCK element as Org syntax.
1402 CONTENTS is the contents of the element."
1406 ;;;; Section
1409 "Parse a section.
1411 LIMIT bounds the search.
1413 Return a list whose CAR is `section' and CDR is a plist
1414 containing `:begin', `:end', `:contents-begin', `contents-end'
1415 and `:post-blank' keywords."
1417 ;; Beginning of section is the beginning of the first non-blank
1418 ;; line after previous headline.
1427 :end end
1428 :contents-begin begin
1429 :contents-end pos-before-blank
1433 "Interpret SECTION element as Org syntax.
1434 CONTENTS is the contents of the element."
1435 contents)
1438 ;;;; Special Block
1441 "Parse a special block.
1443 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1444 the buffer position at the beginning of the first affiliated
1445 keyword and CDR is a plist of affiliated keywords along with
1446 their value.
1448 Return a list whose CAR is `special-block' and CDR is a plist
1449 containing `:type', `:begin', `:end', `:hiddenp',
1450 `:contents-begin', `:contents-end', `:post-blank' and
1451 `:post-affiliated' keywords.
1453 Assume point is at the beginning of the block."
1460 limit t)))
1461 ;; Incomplete block: parse it as a paragraph.
1467 ;; Empty blocks have no contents.
1481 :begin begin
1482 :end end
1483 :hiddenp hidden
1484 :contents-begin contents-begin
1485 :contents-end contents-end
1491 "Interpret SPECIAL-BLOCK element as Org syntax.
1492 CONTENTS is the contents of the element."
1497 \f
1498 ;;; Elements
1499 ;;
1500 ;; For each element, a parser and an interpreter are also defined.
1501 ;; Both follow the same naming convention used for greater elements.
1502 ;;
1503 ;; Also, as for greater elements, adding a new element type is done
1504 ;; through the following steps: implement a parser and an interpreter,
1505 ;; tweak `org-element--current-element' so that it recognizes the new
1506 ;; type and add that new type to `org-element-all-elements'.
1507 ;;
1508 ;; As a special case, when the newly defined type is a block type,
1509 ;; `org-element-block-name-alist' has to be modified accordingly.
1512 ;;;; Babel Call
1515 "Parse a babel call.
1517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1518 the buffer position at the beginning of the first affiliated
1519 keyword and CDR is a plist of affiliated keywords along with
1520 their value.
1522 Return a list whose CAR is `babel-call' and CDR is a plist
1523 containing `:begin', `:end', `:info', `:post-blank' and
1524 `:post-affiliated' as keywords."
1537 :end end
1538 :info info
1544 "Interpret BABEL-CALL element as Org syntax.
1545 CONTENTS is nil."
1551 ;; Remove redundant square brackets.
1556 ;;;; Clock
1559 "Parse a clock.
1561 LIMIT bounds the search.
1563 Return a list whose CAR is `clock' and CDR is a plist containing
1564 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1565 as keywords."
1585 :value value
1586 :duration duration
1587 :begin begin
1588 :end end
1592 "Interpret CLOCK element as Org syntax.
1593 CONTENTS is nil."
1601 "%2s:%02s"
1605 ;;;; Comment
1608 "Parse a comment.
1610 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1611 the buffer position at the beginning of the first affiliated
1612 keyword and CDR is a plist of affiliated keywords along with
1613 their value.
1615 Return a list whose CAR is `comment' and CDR is a plist
1616 containing `:begin', `:end', `:value', `:post-blank',
1617 `:post-affiliated' keywords.
1619 Assume point is at comment beginning."
1628 ;; Get comments ending.
1631 ;; Accumulate lines without leading hash and first
1632 ;; whitespace.
1646 :end end
1647 :value value
1653 "Interpret COMMENT element as Org syntax.
1654 CONTENTS is nil."
1658 ;;;; Comment Block
1661 "Parse an export block.
1663 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1664 the buffer position at the beginning of the first affiliated
1665 keyword and CDR is a plist of affiliated keywords along with
1666 their value.
1668 Return a list whose CAR is `comment-block' and CDR is a plist
1669 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1670 and `:post-affiliated' keywords.
1672 Assume point is at comment block beginning."
1676 ;; Incomplete block: parse it as a paragraph.
1690 contents-begin contents-end)))
1694 :end end
1695 :value value
1696 :hiddenp hidden
1702 "Interpret COMMENT-BLOCK element as Org syntax.
1703 CONTENTS is nil."
1708 ;;;; Diary Sexp
1711 "Parse a diary sexp.
1713 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1714 the buffer position at the beginning of the first affiliated
1715 keyword and CDR is a plist of affiliated keywords along with
1716 their value.
1718 Return a list whose CAR is `diary-sexp' and CDR is a plist
1719 containing `:begin', `:end', `:value', `:post-blank' and
1720 `:post-affiliated' keywords."
1732 :begin begin
1733 :end end
1739 "Interpret DIARY-SEXP as Org syntax.
1740 CONTENTS is nil."
1744 ;;;; Example Block
1747 "Remove maximum common indentation in string S and return it.
1748 When optional argument N is a positive integer, remove exactly
1749 that much characters from indentation, if possible, or return
1750 S as-is otherwise. Unlike to `org-remove-indentation', this
1751 function doesn't call `untabify' on S."
1756 ;; Find maximum common indentation, if not specified.
1764 min-ind)))
1766 ;; Remove exactly N indentation, but give up if not possible.
1776 "Parse an example block.
1778 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1779 the buffer position at the beginning of the first affiliated
1780 keyword and CDR is a plist of affiliated keywords along with
1781 their value.
1783 Return a list whose CAR is `example-block' and CDR is a plist
1784 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1785 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1786 `:switches', `:value', `:post-blank' and `:post-affiliated'
1787 keywords."
1791 ;; Incomplete block: parse it as a paragraph.
1799 ;; Switches analysis
1807 ;; Should labels be retained in (or stripped from) example
1808 ;; blocks?
1813 ;; What should code-references use - labels or
1814 ;; line-numbers?
1823 ;; Standard block parsing.
1832 contents-begin contents-end))
1842 :end end
1843 :value value
1844 :switches switches
1845 :number-lines number-lines
1846 :preserve-indent preserve-indent
1847 :retain-labels retain-labels
1848 :use-labels use-labels
1849 :label-fmt label-fmt
1850 :hiddenp hidden
1856 "Interpret EXAMPLE-BLOCK element as Org syntax.
1857 CONTENTS is nil."
1865 ;;;; Export Block
1868 "Parse an export block.
1870 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1871 the buffer position at the beginning of the first affiliated
1872 keyword and CDR is a plist of affiliated keywords along with
1873 their value.
1875 Return a list whose CAR is `export-block' and CDR is a plist
1876 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1877 `:post-blank' and `:post-affiliated' keywords.
1879 Assume point is at export-block beginning."
1886 ;; Incomplete block: parse it as a paragraph.
1900 contents-end)))
1904 :end end
1905 :type type
1906 :value value
1907 :hiddenp hidden
1913 "Interpret EXPORT-BLOCK element as Org syntax.
1914 CONTENTS is nil."
1921 ;;;; Fixed-width
1924 "Parse a fixed-width section.
1926 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1927 the buffer position at the beginning of the first affiliated
1928 keyword and CDR is a plist of affiliated keywords along with
1929 their value.
1931 Return a list whose CAR is `fixed-width' and CDR is a plist
1932 containing `:begin', `:end', `:value', `:post-blank' and
1933 `:post-affiliated' keywords.
1935 Assume point is at the beginning of the fixed-width area."
1939 value
1944 ;; Accumulate text without starting colons.
1957 :end end
1958 :value value
1964 "Interpret FIXED-WIDTH element as Org syntax.
1965 CONTENTS is nil."
1973 ;;;; Horizontal Rule
1976 "Parse an horizontal rule.
1978 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1979 the buffer position at the beginning of the first affiliated
1980 keyword and CDR is a plist of affiliated keywords along with
1981 their value.
1983 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1984 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1985 keywords."
1995 :end end
2001 "Interpret HORIZONTAL-RULE element as Org syntax.
2002 CONTENTS is nil."
2006 ;;;; Keyword
2009 "Parse a keyword at point.
2011 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2012 the buffer position at the beginning of the first affiliated
2013 keyword and CDR is a plist of affiliated keywords along with
2014 their value.
2016 Return a list whose CAR is `keyword' and CDR is a plist
2017 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2018 `:post-affiliated' keywords."
2032 :value value
2033 :begin begin
2034 :end end
2040 "Interpret KEYWORD element as Org syntax.
2041 CONTENTS is nil."
2047 ;;;; Latex Environment
2050 "Parse a LaTeX environment.
2052 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2053 the buffer position at the beginning of the first affiliated
2054 keyword and CDR is a plist of affiliated keywords along with
2055 their value.
2057 Return a list whose CAR is `latex-environment' and CDR is a plist
2058 containing `:begin', `:end', `:value', `:post-blank' and
2059 `:post-affiliated' keywords.
2061 Assume point is at the beginning of the latex environment."
2068 limit t))
2069 ;; Incomplete latex environment: parse it as a paragraph.
2079 :end end
2080 :value value
2086 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2087 CONTENTS is nil."
2091 ;;;; Node Property
2094 "Parse a node-property at point.
2096 LIMIT bounds the search.
2098 Return a list whose CAR is `node-property' and CDR is a plist
2099 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2100 keywords."
2112 :value value
2113 :begin begin
2114 :end end
2118 "Interpret NODE-PROPERTY element as Org syntax.
2119 CONTENTS is nil."
2125 ;;;; Paragraph
2128 "Parse a paragraph.
2130 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2131 the buffer position at the beginning of the first affiliated
2132 keyword and CDR is a plist of affiliated keywords along with
2133 their value.
2135 Return a list whose CAR is `paragraph' and CDR is a plist
2136 containing `:begin', `:end', `:contents-begin' and
2137 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2139 Assume point is at the beginning of the paragraph."
2148 limit
2149 ;; A matching `org-element-paragraph-separate' is not
2150 ;; necessarily the end of the paragraph. In
2151 ;; particular, lines starting with # or : as a first
2152 ;; non-space character are ambiguous. We have check
2153 ;; if they are valid Org syntax (i.e. not an
2154 ;; incomplete keyword).
2158 ;; There's no ambiguity for other symbols or
2159 ;; empty lines: stop here.
2161 ;; Stop at valid fixed-width areas.
2163 ;; Stop at drawers.
2168 ;; Stop at valid comments.
2170 ;; Stop at valid dynamic blocks.
2175 ;; Stop at valid blocks.
2182 limit t)))
2183 ;; Stop at valid latex environments.
2191 limit t)))
2192 ;; Stop at valid keywords.
2194 ;; Skip everything else.
2211 :end end
2212 :contents-begin contents-begin
2213 :contents-end contents-end
2219 "Interpret PARAGRAPH element as Org syntax.
2220 CONTENTS is the contents of the element."
2221 contents)
2224 ;;;; Planning
2227 "Parse a planning.
2229 LIMIT bounds the search.
2231 Return a list whose CAR is `planning' and CDR is a plist
2232 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2233 and `:post-blank' keywords."
2243 closed deadline scheduled)
2255 :deadline deadline
2256 :scheduled scheduled
2257 :begin begin
2258 :end end
2262 "Interpret PLANNING element as Org syntax.
2263 CONTENTS is nil."
2265 'identity
2282 ;;;; Quote Section
2285 "Parse a quote section.
2287 LIMIT bounds the search.
2289 Return a list whose CAR is `quote-section' and CDR is a plist
2290 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2292 Assume point is at beginning of the section."
2303 :end end
2304 :value value
2308 "Interpret QUOTE-SECTION element as Org syntax.
2309 CONTENTS is nil."
2313 ;;;; Src Block
2316 "Parse a src block.
2318 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2319 the buffer position at the beginning of the first affiliated
2320 keyword and CDR is a plist of affiliated keywords along with
2321 their value.
2323 Return a list whose CAR is `src-block' and CDR is a plist
2324 containing `:language', `:switches', `:parameters', `:begin',
2325 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2326 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2327 `:post-blank' and `:post-affiliated' keywords.
2329 Assume point is at the beginning of the block."
2332 limit t)))
2333 ;; Incomplete block: parse it as a paragraph.
2339 ;; Get language as a string.
2348 ;; Get switches.
2350 ;; Get parameters.
2352 ;; Switches analysis
2364 ;; Should labels be retained in (or stripped from)
2365 ;; src blocks?
2370 ;; What should code-references use - labels or
2371 ;; line-numbers?
2376 ;; Indentation.
2378 ;; Get visibility status.
2380 ;; Retrieve code.
2389 ;; Get position after ending blank lines.
2399 :begin begin
2400 :end end
2401 :number-lines number-lines
2402 :preserve-indent preserve-indent
2403 :retain-labels retain-labels
2404 :use-labels use-labels
2405 :label-fmt label-fmt
2406 :hiddenp hidden
2407 :value value
2413 "Interpret SRC-BLOCK element as Org syntax.
2414 CONTENTS is nil."
2435 ;;;; Table
2438 "Parse a table at point.
2440 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2441 the buffer position at the beginning of the first affiliated
2442 keyword and CDR is a plist of affiliated keywords along with
2443 their value.
2445 Return a list whose CAR is `table' and CDR is a plist containing
2446 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2447 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2448 keywords.
2450 Assume point is at the beginning of the table."
2464 acc))
2471 :end end
2472 :type type
2473 :tblfm tblfm
2474 ;; Only `org' tables have contents. `table.el' tables
2475 ;; use a `:value' property to store raw table as
2476 ;; a string.
2481 table-begin table-end))
2487 "Interpret TABLE element as Org syntax.
2488 CONTENTS is nil."
2499 ;;;; Table Row
2502 "Parse table row at point.
2504 LIMIT bounds the search.
2506 Return a list whose CAR is `table-row' and CDR is a plist
2507 containing `:begin', `:end', `:contents-begin', `:contents-end',
2508 `:type' and `:post-blank' keywords."
2512 ;; A table rule has no contents. In that case, ensure
2513 ;; CONTENTS-BEGIN matches CONTENTS-END.
2525 :begin begin
2526 :end end
2527 :contents-begin contents-begin
2528 :contents-end contents-end
2532 "Interpret TABLE-ROW element as Org syntax.
2533 CONTENTS is the contents of the table row."
2538 ;;;; Verse Block
2541 "Parse a verse block.
2543 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2544 the buffer position at the beginning of the first affiliated
2545 keyword and CDR is a plist of affiliated keywords along with
2546 their value.
2548 Return a list whose CAR is `verse-block' and CDR is a plist
2549 containing `:begin', `:end', `:contents-begin', `:contents-end',
2550 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2552 Assume point is at beginning of the block."
2556 ;; Incomplete block: parse it as a paragraph.
2572 :end end
2573 :contents-begin contents-begin
2574 :contents-end contents-end
2575 :hiddenp hidden
2581 "Interpret VERSE-BLOCK element as Org syntax.
2582 CONTENTS is verse block contents."
2586 \f
2587 ;;; Objects
2588 ;;
2589 ;; Unlike to elements, interstices can be found between objects.
2590 ;; That's why, along with the parser, successor functions are provided
2591 ;; for each object. Some objects share the same successor (i.e. `code'
2592 ;; and `verbatim' objects).
2593 ;;
2594 ;; A successor must accept a single argument bounding the search. It
2595 ;; will return either a cons cell whose CAR is the object's type, as
2596 ;; a symbol, and CDR the position of its next occurrence, or nil.
2597 ;;
2598 ;; Successors follow the naming convention:
2599 ;; org-element-NAME-successor, where NAME is the name of the
2600 ;; successor, as defined in `org-element-all-successors'.
2601 ;;
2602 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2603 ;; object types they can contain will be specified in
2604 ;; `org-element-object-restrictions'.
2605 ;;
2606 ;; Adding a new type of object is simple. Implement a successor,
2607 ;; a parser, and an interpreter for it, all following the naming
2608 ;; convention. Register type in `org-element-all-objects' and
2609 ;; successor in `org-element-all-successors'. Maybe tweak
2610 ;; restrictions about it, and that's it.
2613 ;;;; Bold
2616 "Parse bold object at point.
2618 Return a list whose CAR is `bold' and CDR is a plist with
2619 `:begin', `:end', `:contents-begin' and `:contents-end' and
2620 `:post-blank' keywords.
2622 Assume point is at the first star marker."
2634 :end end
2635 :contents-begin contents-begin
2636 :contents-end contents-end
2640 "Interpret BOLD object as Org syntax.
2641 CONTENTS is the contents of the object."
2645 "Search for the next text-markup object.
2647 Return value is a cons cell whose CAR is a symbol among `bold',
2648 `italic', `underline', `strike-through', `code' and `verbatim'
2649 and CDR is beginning position."
2665 ;;;; Code
2668 "Parse code object at point.
2670 Return a list whose CAR is `code' and CDR is a plist with
2671 `:value', `:begin', `:end' and `:post-blank' keywords.
2673 Assume point is at the first tilde marker."
2684 :begin begin
2685 :end end
2689 "Interpret CODE object as Org syntax.
2690 CONTENTS is nil."
2694 ;;;; Entity
2697 "Parse entity at point.
2699 Return a list whose CAR is `entity' and CDR a plist with
2700 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2701 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2702 keywords.
2704 Assume point is at the beginning of the entity."
2706 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2722 :begin begin
2723 :end end
2724 :use-brackets-p bracketsp
2728 "Interpret ENTITY object as Org syntax.
2729 CONTENTS is nil."
2735 "Search for the next latex-fragment or entity object.
2737 Return value is a cons cell whose CAR is `entity' or
2738 `latex-fragment' and CDR is beginning position."
2742 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2749 ;; Determine if it's a real entity or a LaTeX command.
2752 ;; No entity nor command: point is at a LaTeX fragment.
2753 ;; Determine its type to get the correct beginning position.
2762 ;;;; Export Snippet
2765 "Parse export snippet at point.
2767 Return a list whose CAR is `export-snippet' and CDR a plist with
2768 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2769 keywords.
2771 Assume point is at the beginning of the snippet."
2783 :value value
2784 :begin begin
2785 :end end
2789 "Interpret EXPORT-SNIPPET object as Org syntax.
2790 CONTENTS is nil."
2796 "Search for the next export-snippet object.
2798 Return value is a cons cell whose CAR is `export-snippet' and CDR
2799 its beginning position."
2808 ;;;; Footnote Reference
2811 "Parse footnote reference at point.
2813 Return a list whose CAR is `footnote-reference' and CDR a plist
2814 with `:label', `:type', `:inline-definition', `:begin', `:end'
2815 and `:post-blank' as keywords."
2837 :type type
2838 :begin begin
2839 :end end
2842 footnote-reference :inline-definition
2847 footnote-reference))))))
2850 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2851 CONTENTS is nil."
2861 "Search for the next footnote-reference object.
2863 Return value is a cons cell whose CAR is `footnote-reference' and
2864 CDR is beginning position."
2878 ;;;; Inline Babel Call
2881 "Parse inline babel call at point.
2883 Return a list whose CAR is `inline-babel-call' and CDR a plist
2884 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2886 Assume point is at the beginning of the babel call."
2897 :end end
2898 :info info
2902 "Interpret INLINE-BABEL-CALL object as Org syntax.
2903 CONTENTS is nil."
2909 ;; Remove redundant square brackets.
2912 main-source)
2916 "Search for the next inline-babel-call object.
2918 Return value is a cons cell whose CAR is `inline-babel-call' and
2919 CDR is beginning position."
2925 ;;;; Inline Src Block
2928 "Parse inline source block at point.
2930 Return a list whose CAR is `inline-src-block' and CDR a plist
2931 with `:begin', `:end', `:language', `:value', `:parameters' and
2932 `:post-blank' as keywords.
2934 Assume point is at the beginning of the inline src block."
2947 :value value
2948 :parameters parameters
2949 :begin begin
2950 :end end
2954 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2955 CONTENTS is nil."
2960 language
2962 body)))
2965 "Search for the next inline-babel-call element.
2967 Return value is a cons cell whose CAR is `inline-babel-call' and
2968 CDR is beginning position."
2974 ;;;; Italic
2977 "Parse italic object at point.
2979 Return a list whose CAR is `italic' and CDR is a plist with
2980 `:begin', `:end', `:contents-begin' and `:contents-end' and
2981 `:post-blank' keywords.
2983 Assume point is at the first slash marker."
2995 :end end
2996 :contents-begin contents-begin
2997 :contents-end contents-end
3001 "Interpret ITALIC object as Org syntax.
3002 CONTENTS is the contents of the object."
3006 ;;;; Latex Fragment
3009 "Parse LaTeX fragment at point.
3011 Return a list whose CAR is `latex-fragment' and CDR a plist with
3012 `:value', `:begin', `:end', and `:post-blank' as keywords.
3014 Assume point is at the beginning of the LaTeX fragment."
3027 ;; None found: it's a macro.
3036 :begin begin
3037 :end end
3041 "Interpret LATEX-FRAGMENT object as Org syntax.
3042 CONTENTS is nil."
3045 ;;;; Line Break
3048 "Parse line break at point.
3050 Return a list whose CAR is `line-break', and CDR a plist with
3051 `:begin', `:end' and `:post-blank' keywords.
3053 Assume point is at the beginning of the line break."
3060 "Interpret LINE-BREAK object as Org syntax.
3061 CONTENTS is nil."
3065 "Search for the next line-break object.
3067 Return value is a cons cell whose CAR is `line-break' and CDR is
3068 beginning position."
3072 ;; A line break can only happen on a non-empty line.
3077 ;;;; Link
3080 "Parse link at point.
3082 Return a list whose CAR is `link' and CDR a plist with `:type',
3083 `:path', `:raw-link', `:application', `:search-option', `:begin',
3084 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3085 keywords.
3087 Assume point is at the beginning of the link."
3090 end contents-begin contents-end link-end post-blank path type
3091 raw-link link search-option application)
3093 ;; Type 1: Text targeted from a radio target.
3098 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3103 ;; RAW-LINK is the original link. Expand any
3104 ;; abbreviation in it.
3108 ;; Determine TYPE of link and set PATH accordingly.
3110 ;; File type.
3114 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3117 ;; Id type: PATH is the id.
3120 ;; Code-ref type: PATH is the name of the reference.
3123 ;; Custom-id type: PATH is the name of the custom id.
3126 ;; Fuzzy type: Internal link either matches a target, an
3127 ;; headline name or nothing. PATH is the target or
3128 ;; headline's name.
3130 ;; Type 3: Plain link, i.e. http://orgmode.org
3136 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3143 ;; In any case, deduce end point after trailing white space from
3144 ;; LINK-END variable.
3147 ;; Extract search option and opening application out of
3148 ;; "file"-type links.
3150 ;; Application.
3155 ;; Extract search option from PATH.
3159 ;; Make sure TYPE always reports "file".
3163 :path path
3165 :application application
3166 :search-option search-option
3167 :begin begin
3168 :end end
3169 :contents-begin contents-begin
3170 :contents-end contents-end
3174 "Interpret LINK object as Org syntax.
3175 CONTENTS is the contents of the object, or nil."
3180 raw-link
3184 "Search for the next link object.
3186 Return value is a cons cell whose CAR is `link' and CDR is
3187 beginning position."
3196 "Search for the next plain link object.
3198 Return value is a cons cell whose CAR is `link' and CDR is
3199 beginning position."
3204 ;;;; Macro
3207 "Parse macro at point.
3209 Return a list whose CAR is `macro' and CDR a plist with `:key',
3210 `:args', `:begin', `:end', `:value' and `:post-blank' as
3211 keywords.
3213 Assume point is at the macro."
3224 ;; Do not use `org-split-string' since empty
3225 ;; strings are meaningful here.
3233 args nil t)
3237 :value value
3238 :args args
3239 :begin begin
3240 :end end
3244 "Interpret MACRO object as Org syntax.
3245 CONTENTS is nil."
3249 "Search for the next macro object.
3251 Return value is cons cell whose CAR is `macro' and CDR is
3252 beginning position."
3256 nil t)
3260 ;;;; Radio-target
3263 "Parse radio target at point.
3265 Return a list whose CAR is `radio-target' and CDR a plist with
3266 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3267 and `:post-blank' as keywords.
3269 Assume point is at the radio target."
3281 :end end
3282 :contents-begin contents-begin
3283 :contents-end contents-end
3284 :post-blank post-blank
3288 "Interpret TARGET object as Org syntax.
3289 CONTENTS is the contents of the object."
3293 "Search for the next radio-target object.
3295 Return value is a cons cell whose CAR is `radio-target' and CDR
3296 is beginning position."
3302 ;;;; Statistics Cookie
3305 "Parse statistics cookie at point.
3307 Return a list whose CAR is `statistics-cookie', and CDR a plist
3308 with `:begin', `:end', `:value' and `:post-blank' keywords.
3310 Assume point is at the beginning of the statistics-cookie."
3321 :end end
3322 :value value
3326 "Interpret STATISTICS-COOKIE object as Org syntax.
3327 CONTENTS is nil."
3331 "Search for the next statistics cookie object.
3333 Return value is a cons cell whose CAR is `statistics-cookie' and
3334 CDR is beginning position."
3340 ;;;; Strike-Through
3343 "Parse strike-through object at point.
3345 Return a list whose CAR is `strike-through' and CDR is a plist
3346 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3347 `:post-blank' keywords.
3349 Assume point is at the first plus sign marker."
3361 :end end
3362 :contents-begin contents-begin
3363 :contents-end contents-end
3367 "Interpret STRIKE-THROUGH object as Org syntax.
3368 CONTENTS is the contents of the object."
3372 ;;;; Subscript
3375 "Parse subscript at point.
3377 Return a list whose CAR is `subscript' and CDR a plist with
3378 `:begin', `:end', `:contents-begin', `:contents-end',
3379 `:use-brackets-p' and `:post-blank' as keywords.
3381 Assume point is at the underscore."
3385 t
3396 :end end
3397 :use-brackets-p bracketsp
3398 :contents-begin contents-begin
3399 :contents-end contents-end
3403 "Interpret SUBSCRIPT object as Org syntax.
3404 CONTENTS is the contents of the object."
3407 contents))
3410 "Search for the next sub/superscript object.
3412 Return value is a cons cell whose CAR is either `subscript' or
3413 `superscript' and CDR is beginning position."
3421 ;;;; Superscript
3424 "Parse superscript at point.
3426 Return a list whose CAR is `superscript' and CDR a plist with
3427 `:begin', `:end', `:contents-begin', `:contents-end',
3428 `:use-brackets-p' and `:post-blank' as keywords.
3430 Assume point is at the caret."
3444 :end end
3445 :use-brackets-p bracketsp
3446 :contents-begin contents-begin
3447 :contents-end contents-end
3451 "Interpret SUPERSCRIPT object as Org syntax.
3452 CONTENTS is the contents of the object."
3455 contents))
3458 ;;;; Table Cell
3461 "Parse table cell at point.
3463 Return a list whose CAR is `table-cell' and CDR is a plist
3464 containing `:begin', `:end', `:contents-begin', `:contents-end'
3465 and `:post-blank' keywords."
3473 :end end
3474 :contents-begin contents-begin
3475 :contents-end contents-end
3479 "Interpret TABLE-CELL element as Org syntax.
3480 CONTENTS is the contents of the cell, or nil."
3484 "Search for the next table-cell object.
3486 Return value is a cons cell whose CAR is `table-cell' and CDR is
3487 beginning position."
3491 ;;;; Target
3494 "Parse target at point.
3496 Return a list whose CAR is `target' and CDR a plist with
3497 `:begin', `:end', `:value' and `:post-blank' as keywords.
3499 Assume point is at the target."
3509 :end end
3510 :value value
3514 "Interpret TARGET object as Org syntax.
3515 CONTENTS is nil."
3519 "Search for the next target object.
3521 Return value is a cons cell whose CAR is `target' and CDR is
3522 beginning position."
3528 ;;;; Timestamp
3531 "Parse time stamp at point.
3533 Return a list whose CAR is `timestamp', and CDR a plist with
3534 `:type', `:raw-value', `:year-start', `:month-start',
3535 `:day-start', `:hour-start', `:minute-start', `:year-end',
3536 `:month-end', `:day-end', `:hour-end', `:minute-end',
3537 `:repeater-type', `:repeater-value', `:repeater-unit',
3538 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3539 `:end', `:value' and `:post-blank' keywords.
3541 Assume point is at the beginning of the timestamp."
3559 date-start)
3570 raw-value)
3572 :repeater-type
3578 :repeater-unit
3587 :warning-unit
3590 year-start month-start day-start hour-start minute-start year-end
3591 month-end day-end hour-end minute-end)
3592 ;; Parse date-start.
3600 ;; Compute date-end. It can be provided directly in time-stamp,
3601 ;; or extracted from time range. Otherwise, it defaults to the
3602 ;; same values as date-start.
3612 :raw-value raw-value
3613 :year-start year-start
3614 :month-start month-start
3615 :day-start day-start
3616 :hour-start hour-start
3617 :minute-start minute-start
3618 :year-end year-end
3619 :month-end month-end
3620 :day-end day-end
3621 :hour-end hour-end
3622 :minute-end minute-end
3623 :begin begin
3624 :end end
3626 repeater-props
3627 warning-props)))))
3630 "Interpret TIMESTAMP object as Org syntax.
3631 CONTENTS is nil."
3632 ;; Use `:raw-value' if specified.
3634 ;; Otherwise, build timestamp string.
3653 ;; Build an Org timestamp string from TIME. ACTIVEP is
3654 ;; non-nil when time stamp is active. If WITH-TIME-P is
3655 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3656 ;; specify a time range in the timestamp. REPEAT-STRING
3657 ;; is the repeater string, if any.
3661 org-time-stamp-formats)
3662 time)))
3668 nil nil ts)))
3673 " "
3674 s
3676 ;; Return value.
3677 ts)))
3689 build-ts-string
3708 0
3716 "--"
3728 "Search for the next timestamp object.
3730 Return value is a cons cell whose CAR is `timestamp' and CDR is
3731 beginning position."
3739 nil t)
3743 ;;;; Underline
3746 "Parse underline object at point.
3748 Return a list whose CAR is `underline' and CDR is a plist with
3749 `:begin', `:end', `:contents-begin' and `:contents-end' and
3750 `:post-blank' keywords.
3752 Assume point is at the first underscore marker."
3764 :end end
3765 :contents-begin contents-begin
3766 :contents-end contents-end
3770 "Interpret UNDERLINE object as Org syntax.
3771 CONTENTS is the contents of the object."
3775 ;;;; Verbatim
3778 "Parse verbatim object at point.
3780 Return a list whose CAR is `verbatim' and CDR is a plist with
3781 `:value', `:begin', `:end' and `:post-blank' keywords.
3783 Assume point is at the first equal sign marker."
3794 :begin begin
3795 :end end
3799 "Interpret VERBATIM object as Org syntax.
3800 CONTENTS is nil."
3804 \f
3805 ;;; Parsing Element Starting At Point
3806 ;;
3807 ;; `org-element--current-element' is the core function of this section.
3808 ;; It returns the Lisp representation of the element starting at
3809 ;; point.
3810 ;;
3811 ;; `org-element--current-element' makes use of special modes. They
3812 ;; are activated for fixed element chaining (i.e. `plain-list' >
3813 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3814 ;; `section'). Special modes are: `first-section', `item',
3815 ;; `node-property', `quote-section', `section' and `table-row'.
3819 "Parse the element starting at point.
3821 Return value is a list like (TYPE PROPS) where TYPE is the type
3822 of the element and PROPS a plist of properties associated to the
3823 element.
3825 Possible types are defined in `org-element-all-elements'.
3827 LIMIT bounds the search.
3829 Optional argument GRANULARITY determines the depth of the
3830 recursion. Allowed values are `headline', `greater-element',
3831 `element', `object' or nil. When it is broader than `object' (or
3832 nil), secondary values will not be parsed, since they only
3833 contain objects.
3835 Optional argument SPECIAL, when non-nil, can be either
3836 `first-section', `item', `node-property', `quote-section',
3837 `section', and `table-row'.
3839 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3840 be computed.
3842 This function assumes point is always at the beginning of the
3843 element it has to parse."
3846 ;; Determine if parsing depth allows for secondary strings
3847 ;; parsing. It only applies to elements referenced in
3848 ;; `org-element-secondary-value-alist'.
3851 ;; Item.
3854 ;; Table Row.
3856 ;; Node Property.
3858 ;; Headline.
3861 ;; Sections (must be checked after headline).
3867 limit)))
3868 ;; When not at bol, point is at the beginning of an item or
3869 ;; a footnote definition: next item is always a paragraph.
3871 ;; Planning and Clock.
3876 ;; Inlinetask.
3879 ;; From there, elements can have affiliated keywords.
3882 ;; Jumping over affiliated keywords put point off-limits.
3883 ;; Parse them as regular keywords.
3887 ;; LaTeX Environment.
3891 ;; Drawer and Property Drawer.
3896 ;; Fixed Width
3899 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3900 ;; Keywords.
3909 org-element-block-name-alist)))
3924 ;; Footnote Definition.
3927 ;; Horizontal Rule.
3930 ;; Diary Sexp.
3933 ;; Table.
3935 ;; List.
3938 limit affiliated
3940 ;; Default element: Paragraph.
3944 ;; Most elements can have affiliated keywords. When looking for an
3945 ;; element beginning, we want to move before them, as they belong to
3946 ;; that element, and, in the meantime, collect information they give
3947 ;; into appropriate properties. Hence the following function.
3950 "Collect affiliated keywords from point down to LIMIT.
3952 Return a list whose CAR is the position at the first of them and
3953 CDR a plist of keywords and values and move point to the
3954 beginning of the first line after them.
3956 As a special case, if element doesn't start at the beginning of
3957 the line (i.e. a paragraph starting an item), CAR is current
3958 position of point and CDR is nil."
3962 ;; RESTRICT is the list of objects allowed in parsed
3963 ;; keywords value.
3965 output)
3968 ;; Apply translation to RAW-KWD. From there, KWD is
3969 ;; the official keyword.
3971 org-element-keyword-translation-alist))
3972 raw-kwd))
3973 ;; Find main value for any keyword.
3979 ;; PARSEDP is non-nil when keyword should have its
3980 ;; value parsed.
3982 ;; If KWD is a dual keyword, find its secondary
3983 ;; value. Maybe parse it.
3990 ;; Attribute a property name to KWD.
3992 ;; Now set final shape for VALUE.
3998 ;; Attributes can always appear on multiple lines.
4001 ;; Eventually store the new value in OUTPUT.
4003 ;; Move to next keyword.
4005 ;; If affiliated keywords are orphaned: move back to first one.
4006 ;; They will be parsed as a paragraph.
4008 ;; Return value.
4012 \f
4013 ;;; The Org Parser
4014 ;;
4015 ;; The two major functions here are `org-element-parse-buffer', which
4016 ;; parses Org syntax inside the current buffer, taking into account
4017 ;; region, narrowing, or even visibility if specified, and
4018 ;; `org-element-parse-secondary-string', which parses objects within
4019 ;; a given string.
4020 ;;
4021 ;; The (almost) almighty `org-element-map' allows to apply a function
4022 ;; on elements or objects matching some type, and accumulate the
4023 ;; resulting values. In an export situation, it also skips unneeded
4024 ;; parts of the parse tree.
4027 "Recursively parse the buffer and return structure.
4028 If narrowing is in effect, only parse the visible part of the
4029 buffer.
4031 Optional argument GRANULARITY determines the depth of the
4032 recursion. It can be set to the following symbols:
4034 `headline' Only parse headlines.
4035 `greater-element' Don't recurse into greater elements excepted
4036 headlines and sections. Thus, elements
4037 parsed are the top-level ones.
4038 `element' Parse everything but objects and plain text.
4039 `object' Parse the complete buffer (default).
4041 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4042 elements.
4044 An element or an objects is represented as a list with the
4045 pattern (TYPE PROPERTIES CONTENTS), where :
4047 TYPE is a symbol describing the element or object. See
4048 `org-element-all-elements' and `org-element-all-objects' for an
4049 exhaustive list of such symbols. One can retrieve it with
4050 `org-element-type' function.
4052 PROPERTIES is the list of attributes attached to the element or
4053 object, as a plist. Although most of them are specific to the
4054 element or object type, all types share `:begin', `:end',
4055 `:post-blank' and `:parent' properties, which respectively
4056 refer to buffer position where the element or object starts,
4057 ends, the number of white spaces or blank lines after it, and
4058 the element or object containing it. Properties values can be
4059 obtained by using `org-element-property' function.
4061 CONTENTS is a list of elements, objects or raw strings
4062 contained in the current element or object, when applicable.
4063 One can access them with `org-element-contents' function.
4065 The Org buffer has `org-data' as type and nil as properties.
4066 `org-element-map' function can be used to find specific elements
4067 or objects within the parse tree.
4069 This function assumes that current major mode is `org-mode'."
4075 ;; Start in `first-section' mode so text before the first
4076 ;; headline belongs to a section.
4080 "Recursively parse objects in STRING and return structure.
4082 RESTRICTION is a symbol limiting the object types that will be
4083 looked after.
4085 Optional argument PARENT, when non-nil, is the element or object
4086 containing the secondary string. It is used to set correctly
4087 `:parent' property within the string."
4088 ;; Copy buffer-local variables listed in
4089 ;; `org-element-object-variables' into temporary buffer. This is
4090 ;; required since object parsing is dependent on these variables.
4094 org-element-object-variables))))
4102 secondary))
4103 secondary))))
4107 "Map a function on selected elements or objects.
4109 DATA is a parse tree, an element, an object, a string, or a list
4110 of such constructs. TYPES is a symbol or list of symbols of
4111 elements or objects types (see `org-element-all-elements' and
4112 `org-element-all-objects' for a complete list of types). FUN is
4113 the function called on the matching element or object. It has to
4114 accept one argument: the element or object itself.
4116 When optional argument INFO is non-nil, it should be a plist
4117 holding export options. In that case, parts of the parse tree
4118 not exportable according to that property list will be skipped.
4120 When optional argument FIRST-MATCH is non-nil, stop at the first
4121 match for which FUN doesn't return nil, and return that value.
4123 Optional argument NO-RECURSION is a symbol or a list of symbols
4124 representing elements or objects types. `org-element-map' won't
4125 enter any recursive element or object whose type belongs to that
4126 list. Though, FUN can still be applied on them.
4128 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4129 apply to matching objects within parsed affiliated keywords (see
4130 `org-element-parsed-keywords').
4132 Nil values returned from FUN do not appear in the results.
4135 Examples:
4136 ---------
4138 Assuming TREE is a variable containing an Org buffer parse tree,
4139 the following example will return a flat list of all `src-block'
4140 and `example-block' elements in it:
4142 \(org-element-map tree '(example-block src-block) 'identity)
4144 The following snippet will find the first headline with a level
4147 \(org-element-map tree 'headline
4148 \(lambda (hl)
4149 \(and (= (org-element-property :level hl) 1)
4151 \(org-element-property :begin hl)))
4152 nil t)
4154 The next example will return a flat list of all `plain-list' type
4155 elements in TREE that are not a sub-list themselves:
4157 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4159 Eventually, this example will return a flat list of all `bold'
4160 type objects containing a `latex-snippet' type object, even
4161 looking into captions:
4163 \(org-element-map tree 'bold
4164 \(lambda (b)
4165 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4166 nil nil nil t)"
4167 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4170 ;; Recursion depth is determined by --CATEGORY.
4177 ;; If one object is found, the function
4178 ;; has to recurse into every object.
4181 ;; If one regular element is found, the
4182 ;; function has to recurse, at least,
4183 ;; into every element it encounters.
4186 types)
4187 category)))
4188 ;; Compute properties for affiliated keywords if necessary.
4193 org-element-affiliated-keywords)))
4194 --acc
4195 --walk-tree
4199 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4200 ;; holding contextual information.
4204 ;; Ignored element in an export context.
4206 ;; List of elements or objects.
4208 ;; Unconditionally enter parse trees.
4212 ;; Check if TYPE is matching among TYPES. If so,
4213 ;; apply FUN to --DATA and accumulate return value
4214 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4220 ;; If --DATA has a secondary string that can contain
4221 ;; objects with their type among TYPES, look into it.
4228 ;; If --DATA has any affiliated keywords and
4229 ;; WITH-AFFILIATED is non-nil, look for objects in
4230 ;; them.
4238 ;; Pay attention to the type of value.
4239 ;; Preserve order for multiple keywords.
4255 --affiliated-alist))
4256 ;; Determine if a recursion into --DATA is possible.
4258 ;; --TYPE is explicitly removed from recursion.
4260 ;; --DATA has no contents.
4262 ;; Looking for greater elements but --DATA is simply
4263 ;; an element or an object.
4266 ;; Looking for elements but --DATA is an object.
4269 ;; In any other case, map contents.
4273 ;; Return value in a proper order.
4277 ;; The following functions are internal parts of the parser.
4278 ;;
4279 ;; The first one, `org-element--parse-elements' acts at the element's
4280 ;; level.
4281 ;;
4282 ;; The second one, `org-element--parse-objects' applies on all objects
4283 ;; of a paragraph or a secondary string. It uses
4284 ;; `org-element--get-next-object-candidates' to optimize the search of
4285 ;; the next object in the buffer.
4286 ;;
4287 ;; More precisely, that function looks for every allowed object type
4288 ;; first. Then, it discards failed searches, keeps further matches,
4289 ;; and searches again types matched behind point, for subsequent
4290 ;; calls. Thus, searching for a given type fails only once, and every
4291 ;; object is searched only once at top level (but sometimes more for
4292 ;; nested types).
4296 "Parse elements between BEG and END positions.
4298 SPECIAL prioritize some elements over the others. It can be set
4299 to `first-section', `quote-section', `section' `item' or
4300 `table-row'.
4302 When value is `item', STRUCTURE will be used as the current list
4303 structure.
4305 GRANULARITY determines the depth of the recursion. See
4306 `org-element-parse-buffer' for more information.
4308 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4309 elements.
4311 Elements are accumulated into ACC."
4314 ;; Visible only: skip invisible parts at the beginning of the
4315 ;; element.
4318 ;; When parsing only headlines, skip any text before first one.
4321 ;; Main loop start.
4323 ;; Find current element's type and parse it accordingly to
4324 ;; its category.
4326 end granularity special structure))
4330 ;; Visible only: skip invisible parts between siblings.
4333 ;; Fill ELEMENT contents by side-effect.
4335 ;; If element has no contents, don't modify it.
4337 ;; Greater element: parse it between `contents-begin' and
4338 ;; `contents-end'. Make sure GRANULARITY allows the
4339 ;; recursion, or ELEMENT is a headline, in which case going
4340 ;; inside is mandatory, in order to get sub-level headings.
4348 ;; Possibly switch to a special mode.
4358 granularity visible-only element))
4359 ;; ELEMENT has contents. Parse objects inside, if
4360 ;; GRANULARITY allows it.
4366 ;; Return result.
4367 acc))
4370 "Parse objects between BEG and END and return recursive structure.
4372 Objects are accumulated in ACC.
4374 RESTRICTION is a list of object successors which are allowed in
4375 the current object."
4384 restriction candidates)))
4391 ;; 1. Text before any object. Untabify it.
4396 acc
4400 ;; 2. Object...
4403 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4404 ;; a recursive type.
4412 ;; 3. Text after last object. Untabify it.
4416 acc
4420 ;; Result.
4421 acc))))
4424 "Return an alist of candidates for the next object.
4426 RESTRICTION is a list of object types, as symbols. Only
4427 candidates with such types are looked after.
4429 OBJECTS is the previous candidates alist. If it is set to
4430 `initial', no search has been done before, and all symbols in
4431 RESTRICTION should be looked after.
4433 Return value is an alist whose CAR is the object type and CDR its
4434 beginning position."
4436 nil
4438 ;; When searching for the first time, look for every successor
4439 ;; allowed in RESTRICTION.
4443 restriction)
4444 ;; Focus on objects returned during last search. Keep those
4445 ;; still after point. Search again objects before it.
4451 type)))
4454 objects))))
4457 \f
4458 ;;; Towards A Bijective Process
4459 ;;
4460 ;; The parse tree obtained with `org-element-parse-buffer' is really
4461 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4462 ;; interpreted and expanded into a string with canonical Org syntax.
4463 ;; Hence `org-element-interpret-data'.
4464 ;;
4465 ;; The function relies internally on
4466 ;; `org-element--interpret-affiliated-keywords'.
4468 ;;;###autoload
4470 "Interpret DATA as Org syntax.
4472 DATA is a parse tree, an element, an object or a secondary string
4473 to interpret.
4475 Optional argument PARENT is used for recursive calls. It contains
4476 the element or object containing data, or nil.
4478 Return Org syntax as a string."
4482 ;; Secondary string.
4487 ;; Full Org document.
4492 ;; Plain text: remove `:parent' text property from output.
4494 ;; Element/Object without contents.
4497 data nil))
4498 ;; Element/Object with contents.
4508 ;; Elements directly containing objects must
4509 ;; have their indentation normalized first.
4511 data
4512 ;; When normalizing first paragraph of an
4513 ;; item or a footnote-definition, ignore
4514 ;; first line's indentation.
4521 data
4523 contents)))))))
4525 ;; Build white spaces. If no `:post-blank' property is
4526 ;; specified, assume its value is 0.
4536 "Return ELEMENT's affiliated keywords as Org syntax.
4537 If there is no affiliated keyword, return the empty string."
4547 ": "
4550 value)
4558 ;; All attribute keywords can have multiple lines.
4564 ;; List all ELEMENT's properties matching an attribute line or an
4565 ;; affiliated keyword, but ignore translated keywords since they
4566 ;; cannot belong to the property list.
4573 org-element-keyword-translation-alist)))))
4574 collect prop)
4577 ;; Because interpretation of the parse tree must return the same
4578 ;; number of blank lines between elements and the same number of white
4579 ;; space after objects, some special care must be given to white
4580 ;; spaces.
4581 ;;
4582 ;; The first function, `org-element-normalize-string', ensures any
4583 ;; string different from the empty string will end with a single
4584 ;; newline character.
4585 ;;
4586 ;; The second function, `org-element-normalize-contents', removes
4587 ;; global indentation from the contents of the current element.
4590 "Ensure string S ends with a single newline character.
4592 If S isn't a string return it unchanged. If S is the empty
4593 string, return it. Otherwise, return a new string with a single
4594 newline character at its end."
4602 "Normalize plain text in ELEMENT's contents.
4604 ELEMENT must only contain plain text and objects.
4606 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4607 indentation to compute maximal common indentation.
4609 Return the normalized element that is element with global
4610 indentation removed from its contents. The function assumes that
4611 indentation is not done with TAB characters."
4613 collect-inds ; for byte-compiler
4616 ;; Return list of indentations within BLOB. This is done by
4617 ;; walking recursively BLOB and updating IND-LIST along the
4618 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4619 ;; been seen yet. It is required as this string is the only
4620 ;; one whose indentation doesn't happen after a newline
4621 ;; character.
4629 ;; An indentation of zero means no string will be
4630 ;; modified. Quit the process.
4636 ;; Avoid matching blank or empty lines.
4644 ;; Collect indentation list in ELEMENT. Possibly remove first
4645 ;; value if IGNORE-FIRST is non-nil.
4648 ;; Build ELEMENT back, replacing each string with the same
4649 ;; string minus common indentation.
4654 ;; Return BLOB with all its strings indentation
4655 ;; shortened from MCI white spaces. FIRST-FLAG is
4656 ;; non-nil when the first string hasn't been seen
4657 ;; yet.
4671 org-element-recursive-objects)
4675 blob))))
4679 \f
4680 ;;; The Toolbox
4681 ;;
4682 ;; The first move is to implement a way to obtain the smallest element
4683 ;; containing point. This is the job of `org-element-at-point'. It
4684 ;; basically jumps back to the beginning of section containing point
4685 ;; and moves, element after element, with
4686 ;; `org-element--current-element' until the container is found. Note:
4687 ;; When using `org-element-at-point', secondary values are never
4688 ;; parsed since the function focuses on elements, not on objects.
4689 ;;
4690 ;; At a deeper level, `org-element-context' lists all elements and
4691 ;; objects containing point.
4692 ;;
4693 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4694 ;; internally by navigation and manipulation tools.
4696 ;;;###autoload
4698 "Determine closest element around point.
4700 Return value is a list like (TYPE PROPS) where TYPE is the type
4701 of the element and PROPS a plist of properties associated to the
4702 element.
4704 Possible types are defined in `org-element-all-elements'.
4705 Properties depend on element or object type, but always include
4706 `:begin', `:end', `:parent' and `:post-blank' properties.
4708 As a special case, if point is at the very beginning of a list or
4709 sub-list, returned element will be that list instead of the first
4710 item. In the same way, if point is at the beginning of the first
4711 row of a table, returned element will be the table instead of the
4712 first row.
4714 If optional argument KEEP-TRAIL is non-nil, the function returns
4715 a list of elements leading to element at point. The list's CAR
4716 is always the element at point. The following positions contain
4717 element's siblings, then parents, siblings of parents, until the
4718 first element of current section."
4720 ;; If at a headline, parse it. It is the sole element that
4721 ;; doesn't require to know about context. Be sure to disallow
4722 ;; secondary string parsing, though.
4728 ;; Otherwise move at the beginning of the section containing
4729 ;; point.
4734 element type special-flag trail struct prevs parent)
4737 ;; In empty lines at buffer's beginning, return nil.
4746 ;; In blank lines just after the headline, point still
4747 ;; belongs to the headline.
4756 ;; Parse successively each element, skipping those ending
4757 ;; before original position.
4765 ;; 1. Skip any element ending before point. Also skip
4766 ;; element ending at point when we're sure that another
4767 ;; element has started.
4772 ;; 2. An element containing point is always the element at
4773 ;; point.
4776 ;; 3. At any other greater element type, if point is
4777 ;; within contents, move into it.
4782 ;; Create an anchor for tables and plain lists:
4783 ;; when point is at the very beginning of these
4784 ;; elements, ignoring affiliated keywords,
4785 ;; target them instead of their contents.
4787 ;; When point is at contents end, do not move
4788 ;; into elements with an explicit ending, but
4789 ;; return that element instead.
4793 drawer dynamic-block inlinetask
4794 property-drawer quote-block
4795 special-block))
4796 ;; Corner case: if a list ends at the
4797 ;; end of a buffer without a final new
4798 ;; line, return last element in last
4799 ;; item instead.
4817 ;;;###autoload
4819 "Return closest element or object around point.
4821 Return value is a list like (TYPE PROPS) where TYPE is the type
4822 of the element or object and PROPS a plist of properties
4823 associated to it.
4825 Possible types are defined in `org-element-all-elements' and
4826 `org-element-all-objects'. Properties depend on element or
4827 object type, but always include `:begin', `:end', `:parent' and
4828 `:post-blank'.
4830 Optional argument ELEMENT, when non-nil, is the closest element
4831 containing point, as returned by `org-element-at-point'.
4832 Providing it allows for quicker computation."
4838 context)
4839 ;; Check if point is inside an element containing objects or at
4840 ;; a secondary string. In that case, narrow buffer to the
4841 ;; containing area. Otherwise, return ELEMENT.
4843 ;; At a parsed affiliated keyword, check if we're inside main
4844 ;; or dual value.
4851 org-element-parsed-keywords))
4860 ;; Also change type to retrieve correct restrictions.
4862 ;; At an item, objects can only be located within tag, if any.
4872 ;; At an headline or inlinetask, objects are located within
4873 ;; their title.
4880 ;; At a paragraph, a table-row or a verse block, objects are
4881 ;; located within their contents.
4885 ;; CBEG is nil for table rules.
4889 ;; At a parsed keyword, objects are located within value.
4892 org-element-document-properties))
4907 restriction candidates))
4909 candidates)))
4910 ;; If ORIGIN is before next object in element, there's
4911 ;; no point in looking further.
4921 ;; ORIGIN is after OBJECT, so skip it.
4923 ;; ORIGIN is within a non-recursive object or at
4924 ;; an object boundaries: Return that object.
4928 ;; Otherwise, move within current object and
4929 ;; restrict search to the end of its contents.
4936 parent))))))
4939 "Non-nil when elements ELEM-A and ELEM-B are nested."
4948 "Swap elements ELEM-A and ELEM-B.
4949 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4950 end of ELEM-A."
4952 ;; There are two special cases when an element doesn't start at bol:
4953 ;; the first paragraph in an item or in a footnote definition.
4955 ;; Only a paragraph without any affiliated keyword can be moved at
4956 ;; ELEM-A position in such a situation. Note that the case of
4957 ;; a footnote definition is impossible: it cannot contain two
4958 ;; paragraphs in a row because it cannot contain a blank line.
4964 ;; In a special situation, ELEM-A will have no indentation. We'll
4965 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4979 ;; Store overlays responsible for visibility status. We
4980 ;; also need to store their boundaries as they will be
4981 ;; removed from buffer.
4988 ;; Get contents.
4996 ;; Restore ex ELEM-A overlays.
5005 ;; Restore ex ELEM-B overlays.
5014 ;; Local variables:
5015 ;; generated-autoload-file: "org-loaddefs.el"
5016 ;; End:
5018 ;;; org-element.el ends here