| blob | 68b830eec1832034fc5bfebfa046f75868ea10d8 |
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))))
992 :begin begin
993 :end end
994 :hiddenp hidden
995 :contents-begin contents-begin
996 :contents-end contents-end
999 :tags tags
1000 :todo-keyword todo
1001 :todo-type todo-type
1003 time-props
1004 standard-props))))
1006 inlinetask :title
1009 raw-value
1011 inlinetask))))))
1014 "Interpret INLINETASK element as Org syntax.
1015 CONTENTS is the contents of inlinetask."
1030 ;; Align tags.
1038 ? )
1039 tags))
1043 tags))))
1044 ;; Prefer degenerate inlinetasks when there are no
1045 ;; contents.
1048 contents
1052 ;;;; Item
1055 "Parse an item.
1057 STRUCT is the structure of the plain list.
1059 Return a list whose CAR is `item' and CDR is a plist containing
1060 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1061 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1062 `:post-blank' keywords.
1064 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1065 any, will not be parsed as a secondary string, but as a plain
1066 string instead.
1068 Assume point is at the beginning of the item."
1092 ;; Ignore tags in un-ordered lists: they are just
1093 ;; a part of item's body.
1099 ;; If first line isn't empty, contents really start
1100 ;; at the text after item's meta-data.
1111 :begin begin
1112 :end end
1113 ;; CONTENTS-BEGIN and CONTENTS-END may be
1114 ;; mixed up in the case of an empty item
1115 ;; separated from the next by a blank line.
1116 ;; Thus ensure the former is always the
1117 ;; smallest.
1120 :checkbox checkbox
1121 :counter counter
1122 :hiddenp hidden
1123 :structure struct
1126 item :tag
1134 "Interpret ITEM element as Org syntax.
1135 CONTENTS is the contents of the element."
1145 ;; Compute indentation.
1150 ;; Indent contents.
1152 bullet
1166 ;;;; Plain List
1169 ;; Return structure of list at point. Internal function. See
1170 ;; `org-list-struct' for details.
1178 items struct)
1183 ;; At limit: end all items.
1192 ;; At list end: end all items.
1197 ;; At a new item: end previous sibling.
1209 ind
1210 bullet
1213 ;; Description tag.
1217 ;; Ending position, unknown so far.
1218 nil)))
1219 items))
1221 ;; Skip empty lines.
1223 ;; Skip inline tasks and blank lines along the way.
1230 ;; At some text line. Check if it ends any previous item.
1242 ;; Skip blocks (any type) and drawers contents.
1248 limit t)))
1254 "Parse a plain list.
1256 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1257 the buffer position at the beginning of the first affiliated
1258 keyword and CDR is a plist of affiliated keywords along with
1259 their value. STRUCTURE is the structure of the plain list being
1260 parsed.
1262 Return a list whose CAR is `plain-list' and CDR is a plist
1263 containing `:type', `:begin', `:end', `:contents-begin' and
1264 `:contents-end', `:structure', `:post-blank' and
1265 `:post-affiliated' keywords.
1267 Assume point is at the beginning of the list."
1280 ;; Return value.
1284 :begin begin
1285 :end end
1286 :contents-begin contents-begin
1287 :contents-end contents-end
1288 :structure struct
1294 "Interpret PLAIN-LIST element as Org syntax.
1295 CONTENTS is the contents of the element."
1303 ;;;; Property Drawer
1306 "Parse a property drawer.
1308 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1309 the buffer position at the beginning of the first affiliated
1310 keyword and CDR is a plist of affiliated keywords along with
1311 their value.
1313 Return a list whose CAR is `property-drawer' and CDR is a plist
1314 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1315 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1317 Assume point is at the beginning of the property drawer."
1322 ;; Incomplete drawer: parse it as a paragraph.
1341 :end end
1342 :hiddenp hidden
1343 :contents-begin contents-begin
1344 :contents-end contents-end
1350 "Interpret PROPERTY-DRAWER element as Org syntax.
1351 CONTENTS is the properties within the drawer."
1355 ;;;; Quote Block
1358 "Parse a quote block.
1360 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1361 the buffer position at the beginning of the first affiliated
1362 keyword and CDR is a plist of affiliated keywords along with
1363 their value.
1365 Return a list whose CAR is `quote-block' and CDR is a plist
1366 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1367 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1369 Assume point is at the beginning of the block."
1373 ;; Incomplete block: parse it as a paragraph.
1379 ;; Empty blocks have no contents.
1393 :end end
1394 :hiddenp hidden
1395 :contents-begin contents-begin
1396 :contents-end contents-end
1402 "Interpret QUOTE-BLOCK element as Org syntax.
1403 CONTENTS is the contents of the element."
1407 ;;;; Section
1410 "Parse a section.
1412 LIMIT bounds the search.
1414 Return a list whose CAR is `section' and CDR is a plist
1415 containing `:begin', `:end', `:contents-begin', `contents-end'
1416 and `:post-blank' keywords."
1418 ;; Beginning of section is the beginning of the first non-blank
1419 ;; line after previous headline.
1428 :end end
1429 :contents-begin begin
1430 :contents-end pos-before-blank
1434 "Interpret SECTION element as Org syntax.
1435 CONTENTS is the contents of the element."
1436 contents)
1439 ;;;; Special Block
1442 "Parse a special block.
1444 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1445 the buffer position at the beginning of the first affiliated
1446 keyword and CDR is a plist of affiliated keywords along with
1447 their value.
1449 Return a list whose CAR is `special-block' and CDR is a plist
1450 containing `:type', `:begin', `:end', `:hiddenp',
1451 `:contents-begin', `:contents-end', `:post-blank' and
1452 `:post-affiliated' keywords.
1454 Assume point is at the beginning of the block."
1461 limit t)))
1462 ;; Incomplete block: parse it as a paragraph.
1468 ;; Empty blocks have no contents.
1482 :begin begin
1483 :end end
1484 :hiddenp hidden
1485 :contents-begin contents-begin
1486 :contents-end contents-end
1492 "Interpret SPECIAL-BLOCK element as Org syntax.
1493 CONTENTS is the contents of the element."
1498 \f
1499 ;;; Elements
1500 ;;
1501 ;; For each element, a parser and an interpreter are also defined.
1502 ;; Both follow the same naming convention used for greater elements.
1503 ;;
1504 ;; Also, as for greater elements, adding a new element type is done
1505 ;; through the following steps: implement a parser and an interpreter,
1506 ;; tweak `org-element--current-element' so that it recognizes the new
1507 ;; type and add that new type to `org-element-all-elements'.
1508 ;;
1509 ;; As a special case, when the newly defined type is a block type,
1510 ;; `org-element-block-name-alist' has to be modified accordingly.
1513 ;;;; Babel Call
1516 "Parse a babel call.
1518 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1519 the buffer position at the beginning of the first affiliated
1520 keyword and CDR is a plist of affiliated keywords along with
1521 their value.
1523 Return a list whose CAR is `babel-call' and CDR is a plist
1524 containing `:begin', `:end', `:info', `:post-blank' and
1525 `:post-affiliated' as keywords."
1538 :end end
1539 :info info
1545 "Interpret BABEL-CALL element as Org syntax.
1546 CONTENTS is nil."
1552 ;; Remove redundant square brackets.
1557 ;;;; Clock
1560 "Parse a clock.
1562 LIMIT bounds the search.
1564 Return a list whose CAR is `clock' and CDR is a plist containing
1565 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1566 as keywords."
1586 :value value
1587 :duration duration
1588 :begin begin
1589 :end end
1593 "Interpret CLOCK element as Org syntax.
1594 CONTENTS is nil."
1602 "%2s:%02s"
1606 ;;;; Comment
1609 "Parse a comment.
1611 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1612 the buffer position at the beginning of the first affiliated
1613 keyword and CDR is a plist of affiliated keywords along with
1614 their value.
1616 Return a list whose CAR is `comment' and CDR is a plist
1617 containing `:begin', `:end', `:value', `:post-blank',
1618 `:post-affiliated' keywords.
1620 Assume point is at comment beginning."
1629 ;; Get comments ending.
1632 ;; Accumulate lines without leading hash and first
1633 ;; whitespace.
1647 :end end
1648 :value value
1654 "Interpret COMMENT element as Org syntax.
1655 CONTENTS is nil."
1659 ;;;; Comment Block
1662 "Parse an export block.
1664 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1665 the buffer position at the beginning of the first affiliated
1666 keyword and CDR is a plist of affiliated keywords along with
1667 their value.
1669 Return a list whose CAR is `comment-block' and CDR is a plist
1670 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1671 and `:post-affiliated' keywords.
1673 Assume point is at comment block beginning."
1677 ;; Incomplete block: parse it as a paragraph.
1691 contents-begin contents-end)))
1695 :end end
1696 :value value
1697 :hiddenp hidden
1703 "Interpret COMMENT-BLOCK element as Org syntax.
1704 CONTENTS is nil."
1709 ;;;; Diary Sexp
1712 "Parse a diary sexp.
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 `diary-sexp' and CDR is a plist
1720 containing `:begin', `:end', `:value', `:post-blank' and
1721 `:post-affiliated' keywords."
1733 :begin begin
1734 :end end
1740 "Interpret DIARY-SEXP as Org syntax.
1741 CONTENTS is nil."
1745 ;;;; Example Block
1748 "Remove maximum common indentation in string S and return it.
1749 When optional argument N is a positive integer, remove exactly
1750 that much characters from indentation, if possible, or return
1751 S as-is otherwise. Unlike to `org-remove-indentation', this
1752 function doesn't call `untabify' on S."
1757 ;; Find maximum common indentation, if not specified.
1765 min-ind)))
1767 ;; Remove exactly N indentation, but give up if not possible.
1777 "Parse an example block.
1779 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1780 the buffer position at the beginning of the first affiliated
1781 keyword and CDR is a plist of affiliated keywords along with
1782 their value.
1784 Return a list whose CAR is `example-block' and CDR is a plist
1785 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1786 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1787 `:switches', `:value', `:post-blank' and `:post-affiliated'
1788 keywords."
1792 ;; Incomplete block: parse it as a paragraph.
1800 ;; Switches analysis
1808 ;; Should labels be retained in (or stripped from) example
1809 ;; blocks?
1814 ;; What should code-references use - labels or
1815 ;; line-numbers?
1824 ;; Standard block parsing.
1833 contents-begin contents-end))
1843 :end end
1844 :value value
1845 :switches switches
1846 :number-lines number-lines
1847 :preserve-indent preserve-indent
1848 :retain-labels retain-labels
1849 :use-labels use-labels
1850 :label-fmt label-fmt
1851 :hiddenp hidden
1857 "Interpret EXAMPLE-BLOCK element as Org syntax.
1858 CONTENTS is nil."
1866 ;;;; Export Block
1869 "Parse an export block.
1871 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1872 the buffer position at the beginning of the first affiliated
1873 keyword and CDR is a plist of affiliated keywords along with
1874 their value.
1876 Return a list whose CAR is `export-block' and CDR is a plist
1877 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1878 `:post-blank' and `:post-affiliated' keywords.
1880 Assume point is at export-block beginning."
1887 ;; Incomplete block: parse it as a paragraph.
1901 contents-end)))
1905 :end end
1906 :type type
1907 :value value
1908 :hiddenp hidden
1914 "Interpret EXPORT-BLOCK element as Org syntax.
1915 CONTENTS is nil."
1922 ;;;; Fixed-width
1925 "Parse a fixed-width section.
1927 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1928 the buffer position at the beginning of the first affiliated
1929 keyword and CDR is a plist of affiliated keywords along with
1930 their value.
1932 Return a list whose CAR is `fixed-width' and CDR is a plist
1933 containing `:begin', `:end', `:value', `:post-blank' and
1934 `:post-affiliated' keywords.
1936 Assume point is at the beginning of the fixed-width area."
1940 value
1945 ;; Accumulate text without starting colons.
1958 :end end
1959 :value value
1965 "Interpret FIXED-WIDTH element as Org syntax.
1966 CONTENTS is nil."
1974 ;;;; Horizontal Rule
1977 "Parse an horizontal rule.
1979 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1980 the buffer position at the beginning of the first affiliated
1981 keyword and CDR is a plist of affiliated keywords along with
1982 their value.
1984 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1985 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1986 keywords."
1996 :end end
2002 "Interpret HORIZONTAL-RULE element as Org syntax.
2003 CONTENTS is nil."
2007 ;;;; Keyword
2010 "Parse a keyword at point.
2012 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2013 the buffer position at the beginning of the first affiliated
2014 keyword and CDR is a plist of affiliated keywords along with
2015 their value.
2017 Return a list whose CAR is `keyword' and CDR is a plist
2018 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2019 `:post-affiliated' keywords."
2033 :value value
2034 :begin begin
2035 :end end
2041 "Interpret KEYWORD element as Org syntax.
2042 CONTENTS is nil."
2048 ;;;; Latex Environment
2051 "Parse a LaTeX environment.
2053 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2054 the buffer position at the beginning of the first affiliated
2055 keyword and CDR is a plist of affiliated keywords along with
2056 their value.
2058 Return a list whose CAR is `latex-environment' and CDR is a plist
2059 containing `:begin', `:end', `:value', `:post-blank' and
2060 `:post-affiliated' keywords.
2062 Assume point is at the beginning of the latex environment."
2069 limit t))
2070 ;; Incomplete latex environment: parse it as a paragraph.
2080 :end end
2081 :value value
2087 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2088 CONTENTS is nil."
2092 ;;;; Node Property
2095 "Parse a node-property at point.
2097 LIMIT bounds the search.
2099 Return a list whose CAR is `node-property' and CDR is a plist
2100 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2101 keywords."
2113 :value value
2114 :begin begin
2115 :end end
2119 "Interpret NODE-PROPERTY element as Org syntax.
2120 CONTENTS is nil."
2126 ;;;; Paragraph
2129 "Parse a paragraph.
2131 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2132 the buffer position at the beginning of the first affiliated
2133 keyword and CDR is a plist of affiliated keywords along with
2134 their value.
2136 Return a list whose CAR is `paragraph' and CDR is a plist
2137 containing `:begin', `:end', `:contents-begin' and
2138 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2140 Assume point is at the beginning of the paragraph."
2149 limit
2150 ;; A matching `org-element-paragraph-separate' is not
2151 ;; necessarily the end of the paragraph. In
2152 ;; particular, lines starting with # or : as a first
2153 ;; non-space character are ambiguous. We have check
2154 ;; if they are valid Org syntax (i.e. not an
2155 ;; incomplete keyword).
2159 ;; There's no ambiguity for other symbols or
2160 ;; empty lines: stop here.
2162 ;; Stop at valid fixed-width areas.
2164 ;; Stop at drawers.
2169 ;; Stop at valid comments.
2171 ;; Stop at valid dynamic blocks.
2176 ;; Stop at valid blocks.
2183 limit t)))
2184 ;; Stop at valid latex environments.
2192 limit t)))
2193 ;; Stop at valid keywords.
2195 ;; Skip everything else.
2212 :end end
2213 :contents-begin contents-begin
2214 :contents-end contents-end
2220 "Interpret PARAGRAPH element as Org syntax.
2221 CONTENTS is the contents of the element."
2222 contents)
2225 ;;;; Planning
2228 "Parse a planning.
2230 LIMIT bounds the search.
2232 Return a list whose CAR is `planning' and CDR is a plist
2233 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2234 and `:post-blank' keywords."
2244 closed deadline scheduled)
2256 :deadline deadline
2257 :scheduled scheduled
2258 :begin begin
2259 :end end
2263 "Interpret PLANNING element as Org syntax.
2264 CONTENTS is nil."
2266 'identity
2283 ;;;; Quote Section
2286 "Parse a quote section.
2288 LIMIT bounds the search.
2290 Return a list whose CAR is `quote-section' and CDR is a plist
2291 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2293 Assume point is at beginning of the section."
2304 :end end
2305 :value value
2309 "Interpret QUOTE-SECTION element as Org syntax.
2310 CONTENTS is nil."
2314 ;;;; Src Block
2317 "Parse a src block.
2319 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2320 the buffer position at the beginning of the first affiliated
2321 keyword and CDR is a plist of affiliated keywords along with
2322 their value.
2324 Return a list whose CAR is `src-block' and CDR is a plist
2325 containing `:language', `:switches', `:parameters', `:begin',
2326 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2327 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2328 `:post-blank' and `:post-affiliated' keywords.
2330 Assume point is at the beginning of the block."
2333 limit t)))
2334 ;; Incomplete block: parse it as a paragraph.
2340 ;; Get language as a string.
2349 ;; Get switches.
2351 ;; Get parameters.
2353 ;; Switches analysis
2365 ;; Should labels be retained in (or stripped from)
2366 ;; src blocks?
2371 ;; What should code-references use - labels or
2372 ;; line-numbers?
2377 ;; Indentation.
2379 ;; Get visibility status.
2381 ;; Retrieve code.
2390 ;; Get position after ending blank lines.
2400 :begin begin
2401 :end end
2402 :number-lines number-lines
2403 :preserve-indent preserve-indent
2404 :retain-labels retain-labels
2405 :use-labels use-labels
2406 :label-fmt label-fmt
2407 :hiddenp hidden
2408 :value value
2414 "Interpret SRC-BLOCK element as Org syntax.
2415 CONTENTS is nil."
2436 ;;;; Table
2439 "Parse a table at point.
2441 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2442 the buffer position at the beginning of the first affiliated
2443 keyword and CDR is a plist of affiliated keywords along with
2444 their value.
2446 Return a list whose CAR is `table' and CDR is a plist containing
2447 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2448 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2449 keywords.
2451 Assume point is at the beginning of the table."
2465 acc))
2472 :end end
2473 :type type
2474 :tblfm tblfm
2475 ;; Only `org' tables have contents. `table.el' tables
2476 ;; use a `:value' property to store raw table as
2477 ;; a string.
2482 table-begin table-end))
2488 "Interpret TABLE element as Org syntax.
2489 CONTENTS is nil."
2500 ;;;; Table Row
2503 "Parse table row at point.
2505 LIMIT bounds the search.
2507 Return a list whose CAR is `table-row' and CDR is a plist
2508 containing `:begin', `:end', `:contents-begin', `:contents-end',
2509 `:type' and `:post-blank' keywords."
2513 ;; A table rule has no contents. In that case, ensure
2514 ;; CONTENTS-BEGIN matches CONTENTS-END.
2526 :begin begin
2527 :end end
2528 :contents-begin contents-begin
2529 :contents-end contents-end
2533 "Interpret TABLE-ROW element as Org syntax.
2534 CONTENTS is the contents of the table row."
2539 ;;;; Verse Block
2542 "Parse a verse block.
2544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2545 the buffer position at the beginning of the first affiliated
2546 keyword and CDR is a plist of affiliated keywords along with
2547 their value.
2549 Return a list whose CAR is `verse-block' and CDR is a plist
2550 containing `:begin', `:end', `:contents-begin', `:contents-end',
2551 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2553 Assume point is at beginning of the block."
2557 ;; Incomplete block: parse it as a paragraph.
2573 :end end
2574 :contents-begin contents-begin
2575 :contents-end contents-end
2576 :hiddenp hidden
2582 "Interpret VERSE-BLOCK element as Org syntax.
2583 CONTENTS is verse block contents."
2587 \f
2588 ;;; Objects
2589 ;;
2590 ;; Unlike to elements, interstices can be found between objects.
2591 ;; That's why, along with the parser, successor functions are provided
2592 ;; for each object. Some objects share the same successor (i.e. `code'
2593 ;; and `verbatim' objects).
2594 ;;
2595 ;; A successor must accept a single argument bounding the search. It
2596 ;; will return either a cons cell whose CAR is the object's type, as
2597 ;; a symbol, and CDR the position of its next occurrence, or nil.
2598 ;;
2599 ;; Successors follow the naming convention:
2600 ;; org-element-NAME-successor, where NAME is the name of the
2601 ;; successor, as defined in `org-element-all-successors'.
2602 ;;
2603 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2604 ;; object types they can contain will be specified in
2605 ;; `org-element-object-restrictions'.
2606 ;;
2607 ;; Adding a new type of object is simple. Implement a successor,
2608 ;; a parser, and an interpreter for it, all following the naming
2609 ;; convention. Register type in `org-element-all-objects' and
2610 ;; successor in `org-element-all-successors'. Maybe tweak
2611 ;; restrictions about it, and that's it.
2614 ;;;; Bold
2617 "Parse bold object at point.
2619 Return a list whose CAR is `bold' and CDR is a plist with
2620 `:begin', `:end', `:contents-begin' and `:contents-end' and
2621 `:post-blank' keywords.
2623 Assume point is at the first star marker."
2635 :end end
2636 :contents-begin contents-begin
2637 :contents-end contents-end
2641 "Interpret BOLD object as Org syntax.
2642 CONTENTS is the contents of the object."
2646 "Search for the next text-markup object.
2648 Return value is a cons cell whose CAR is a symbol among `bold',
2649 `italic', `underline', `strike-through', `code' and `verbatim'
2650 and CDR is beginning position."
2666 ;;;; Code
2669 "Parse code object at point.
2671 Return a list whose CAR is `code' and CDR is a plist with
2672 `:value', `:begin', `:end' and `:post-blank' keywords.
2674 Assume point is at the first tilde marker."
2685 :begin begin
2686 :end end
2690 "Interpret CODE object as Org syntax.
2691 CONTENTS is nil."
2695 ;;;; Entity
2698 "Parse entity at point.
2700 Return a list whose CAR is `entity' and CDR a plist with
2701 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2702 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2703 keywords.
2705 Assume point is at the beginning of the entity."
2707 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2723 :begin begin
2724 :end end
2725 :use-brackets-p bracketsp
2729 "Interpret ENTITY object as Org syntax.
2730 CONTENTS is nil."
2736 "Search for the next latex-fragment or entity object.
2738 Return value is a cons cell whose CAR is `entity' or
2739 `latex-fragment' and CDR is beginning position."
2743 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2750 ;; Determine if it's a real entity or a LaTeX command.
2753 ;; No entity nor command: point is at a LaTeX fragment.
2754 ;; Determine its type to get the correct beginning position.
2763 ;;;; Export Snippet
2766 "Parse export snippet at point.
2768 Return a list whose CAR is `export-snippet' and CDR a plist with
2769 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2770 keywords.
2772 Assume point is at the beginning of the snippet."
2784 :value value
2785 :begin begin
2786 :end end
2790 "Interpret EXPORT-SNIPPET object as Org syntax.
2791 CONTENTS is nil."
2797 "Search for the next export-snippet object.
2799 Return value is a cons cell whose CAR is `export-snippet' and CDR
2800 its beginning position."
2809 ;;;; Footnote Reference
2812 "Parse footnote reference at point.
2814 Return a list whose CAR is `footnote-reference' and CDR a plist
2815 with `:label', `:type', `:inline-definition', `:begin', `:end'
2816 and `:post-blank' as keywords."
2838 :type type
2839 :begin begin
2840 :end end
2843 footnote-reference :inline-definition
2848 footnote-reference))))))
2851 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2852 CONTENTS is nil."
2862 "Search for the next footnote-reference object.
2864 Return value is a cons cell whose CAR is `footnote-reference' and
2865 CDR is beginning position."
2879 ;;;; Inline Babel Call
2882 "Parse inline babel call at point.
2884 Return a list whose CAR is `inline-babel-call' and CDR a plist
2885 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2887 Assume point is at the beginning of the babel call."
2898 :end end
2899 :info info
2903 "Interpret INLINE-BABEL-CALL object as Org syntax.
2904 CONTENTS is nil."
2910 ;; Remove redundant square brackets.
2913 main-source)
2917 "Search for the next inline-babel-call object.
2919 Return value is a cons cell whose CAR is `inline-babel-call' and
2920 CDR is beginning position."
2926 ;;;; Inline Src Block
2929 "Parse inline source block at point.
2931 Return a list whose CAR is `inline-src-block' and CDR a plist
2932 with `:begin', `:end', `:language', `:value', `:parameters' and
2933 `:post-blank' as keywords.
2935 Assume point is at the beginning of the inline src block."
2948 :value value
2949 :parameters parameters
2950 :begin begin
2951 :end end
2955 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2956 CONTENTS is nil."
2961 language
2963 body)))
2966 "Search for the next inline-babel-call element.
2968 Return value is a cons cell whose CAR is `inline-babel-call' and
2969 CDR is beginning position."
2975 ;;;; Italic
2978 "Parse italic object at point.
2980 Return a list whose CAR is `italic' and CDR is a plist with
2981 `:begin', `:end', `:contents-begin' and `:contents-end' and
2982 `:post-blank' keywords.
2984 Assume point is at the first slash marker."
2996 :end end
2997 :contents-begin contents-begin
2998 :contents-end contents-end
3002 "Interpret ITALIC object as Org syntax.
3003 CONTENTS is the contents of the object."
3007 ;;;; Latex Fragment
3010 "Parse LaTeX fragment at point.
3012 Return a list whose CAR is `latex-fragment' and CDR a plist with
3013 `:value', `:begin', `:end', and `:post-blank' as keywords.
3015 Assume point is at the beginning of the LaTeX fragment."
3028 ;; None found: it's a macro.
3037 :begin begin
3038 :end end
3042 "Interpret LATEX-FRAGMENT object as Org syntax.
3043 CONTENTS is nil."
3046 ;;;; Line Break
3049 "Parse line break at point.
3051 Return a list whose CAR is `line-break', and CDR a plist with
3052 `:begin', `:end' and `:post-blank' keywords.
3054 Assume point is at the beginning of the line break."
3061 "Interpret LINE-BREAK object as Org syntax.
3062 CONTENTS is nil."
3066 "Search for the next line-break object.
3068 Return value is a cons cell whose CAR is `line-break' and CDR is
3069 beginning position."
3073 ;; A line break can only happen on a non-empty line.
3078 ;;;; Link
3081 "Parse link at point.
3083 Return a list whose CAR is `link' and CDR a plist with `:type',
3084 `:path', `:raw-link', `:application', `:search-option', `:begin',
3085 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3086 keywords.
3088 Assume point is at the beginning of the link."
3091 end contents-begin contents-end link-end post-blank path type
3092 raw-link link search-option application)
3094 ;; Type 1: Text targeted from a radio target.
3099 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3104 ;; RAW-LINK is the original link. Expand any
3105 ;; abbreviation in it.
3109 ;; Determine TYPE of link and set PATH accordingly.
3111 ;; File type.
3115 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3118 ;; Id type: PATH is the id.
3121 ;; Code-ref type: PATH is the name of the reference.
3124 ;; Custom-id type: PATH is the name of the custom id.
3127 ;; Fuzzy type: Internal link either matches a target, an
3128 ;; headline name or nothing. PATH is the target or
3129 ;; headline's name.
3131 ;; Type 3: Plain link, i.e. http://orgmode.org
3137 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3144 ;; In any case, deduce end point after trailing white space from
3145 ;; LINK-END variable.
3148 ;; Extract search option and opening application out of
3149 ;; "file"-type links.
3151 ;; Application.
3156 ;; Extract search option from PATH.
3160 ;; Make sure TYPE always reports "file".
3164 :path path
3166 :application application
3167 :search-option search-option
3168 :begin begin
3169 :end end
3170 :contents-begin contents-begin
3171 :contents-end contents-end
3175 "Interpret LINK object as Org syntax.
3176 CONTENTS is the contents of the object, or nil."
3181 raw-link
3185 "Search for the next link object.
3187 Return value is a cons cell whose CAR is `link' and CDR is
3188 beginning position."
3197 "Search for the next plain link object.
3199 Return value is a cons cell whose CAR is `link' and CDR is
3200 beginning position."
3205 ;;;; Macro
3208 "Parse macro at point.
3210 Return a list whose CAR is `macro' and CDR a plist with `:key',
3211 `:args', `:begin', `:end', `:value' and `:post-blank' as
3212 keywords.
3214 Assume point is at the macro."
3225 ;; Do not use `org-split-string' since empty
3226 ;; strings are meaningful here.
3234 args nil t)
3238 :value value
3239 :args args
3240 :begin begin
3241 :end end
3245 "Interpret MACRO object as Org syntax.
3246 CONTENTS is nil."
3250 "Search for the next macro object.
3252 Return value is cons cell whose CAR is `macro' and CDR is
3253 beginning position."
3257 nil t)
3261 ;;;; Radio-target
3264 "Parse radio target at point.
3266 Return a list whose CAR is `radio-target' and CDR a plist with
3267 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3268 and `:post-blank' as keywords.
3270 Assume point is at the radio target."
3282 :end end
3283 :contents-begin contents-begin
3284 :contents-end contents-end
3285 :post-blank post-blank
3289 "Interpret TARGET object as Org syntax.
3290 CONTENTS is the contents of the object."
3294 "Search for the next radio-target object.
3296 Return value is a cons cell whose CAR is `radio-target' and CDR
3297 is beginning position."
3303 ;;;; Statistics Cookie
3306 "Parse statistics cookie at point.
3308 Return a list whose CAR is `statistics-cookie', and CDR a plist
3309 with `:begin', `:end', `:value' and `:post-blank' keywords.
3311 Assume point is at the beginning of the statistics-cookie."
3322 :end end
3323 :value value
3327 "Interpret STATISTICS-COOKIE object as Org syntax.
3328 CONTENTS is nil."
3332 "Search for the next statistics cookie object.
3334 Return value is a cons cell whose CAR is `statistics-cookie' and
3335 CDR is beginning position."
3341 ;;;; Strike-Through
3344 "Parse strike-through object at point.
3346 Return a list whose CAR is `strike-through' and CDR is a plist
3347 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3348 `:post-blank' keywords.
3350 Assume point is at the first plus sign marker."
3362 :end end
3363 :contents-begin contents-begin
3364 :contents-end contents-end
3368 "Interpret STRIKE-THROUGH object as Org syntax.
3369 CONTENTS is the contents of the object."
3373 ;;;; Subscript
3376 "Parse subscript at point.
3378 Return a list whose CAR is `subscript' and CDR a plist with
3379 `:begin', `:end', `:contents-begin', `:contents-end',
3380 `:use-brackets-p' and `:post-blank' as keywords.
3382 Assume point is at the underscore."
3386 t
3397 :end end
3398 :use-brackets-p bracketsp
3399 :contents-begin contents-begin
3400 :contents-end contents-end
3404 "Interpret SUBSCRIPT object as Org syntax.
3405 CONTENTS is the contents of the object."
3408 contents))
3411 "Search for the next sub/superscript object.
3413 Return value is a cons cell whose CAR is either `subscript' or
3414 `superscript' and CDR is beginning position."
3422 ;;;; Superscript
3425 "Parse superscript at point.
3427 Return a list whose CAR is `superscript' and CDR a plist with
3428 `:begin', `:end', `:contents-begin', `:contents-end',
3429 `:use-brackets-p' and `:post-blank' as keywords.
3431 Assume point is at the caret."
3445 :end end
3446 :use-brackets-p bracketsp
3447 :contents-begin contents-begin
3448 :contents-end contents-end
3452 "Interpret SUPERSCRIPT object as Org syntax.
3453 CONTENTS is the contents of the object."
3456 contents))
3459 ;;;; Table Cell
3462 "Parse table cell at point.
3464 Return a list whose CAR is `table-cell' and CDR is a plist
3465 containing `:begin', `:end', `:contents-begin', `:contents-end'
3466 and `:post-blank' keywords."
3474 :end end
3475 :contents-begin contents-begin
3476 :contents-end contents-end
3480 "Interpret TABLE-CELL element as Org syntax.
3481 CONTENTS is the contents of the cell, or nil."
3485 "Search for the next table-cell object.
3487 Return value is a cons cell whose CAR is `table-cell' and CDR is
3488 beginning position."
3492 ;;;; Target
3495 "Parse target at point.
3497 Return a list whose CAR is `target' and CDR a plist with
3498 `:begin', `:end', `:value' and `:post-blank' as keywords.
3500 Assume point is at the target."
3510 :end end
3511 :value value
3515 "Interpret TARGET object as Org syntax.
3516 CONTENTS is nil."
3520 "Search for the next target object.
3522 Return value is a cons cell whose CAR is `target' and CDR is
3523 beginning position."
3529 ;;;; Timestamp
3532 "Parse time stamp at point.
3534 Return a list whose CAR is `timestamp', and CDR a plist with
3535 `:type', `:raw-value', `:year-start', `:month-start',
3536 `:day-start', `:hour-start', `:minute-start', `:year-end',
3537 `:month-end', `:day-end', `:hour-end', `:minute-end',
3538 `:repeater-type', `:repeater-value', `:repeater-unit',
3539 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3540 `:end', `:value' and `:post-blank' keywords.
3542 Assume point is at the beginning of the timestamp."
3560 date-start)
3571 raw-value)
3573 :repeater-type
3579 :repeater-unit
3588 :warning-unit
3591 year-start month-start day-start hour-start minute-start year-end
3592 month-end day-end hour-end minute-end)
3593 ;; Parse date-start.
3601 ;; Compute date-end. It can be provided directly in time-stamp,
3602 ;; or extracted from time range. Otherwise, it defaults to the
3603 ;; same values as date-start.
3613 :raw-value raw-value
3614 :year-start year-start
3615 :month-start month-start
3616 :day-start day-start
3617 :hour-start hour-start
3618 :minute-start minute-start
3619 :year-end year-end
3620 :month-end month-end
3621 :day-end day-end
3622 :hour-end hour-end
3623 :minute-end minute-end
3624 :begin begin
3625 :end end
3627 repeater-props
3628 warning-props)))))
3631 "Interpret TIMESTAMP object as Org syntax.
3632 CONTENTS is nil."
3633 ;; Use `:raw-value' if specified.
3635 ;; Otherwise, build timestamp string.
3654 ;; Build an Org timestamp string from TIME. ACTIVEP is
3655 ;; non-nil when time stamp is active. If WITH-TIME-P is
3656 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3657 ;; specify a time range in the timestamp. REPEAT-STRING
3658 ;; is the repeater string, if any.
3662 org-time-stamp-formats)
3663 time)))
3669 nil nil ts)))
3674 " "
3675 s
3677 ;; Return value.
3678 ts)))
3690 build-ts-string
3709 0
3717 "--"
3729 "Search for the next timestamp object.
3731 Return value is a cons cell whose CAR is `timestamp' and CDR is
3732 beginning position."
3740 nil t)
3744 ;;;; Underline
3747 "Parse underline object at point.
3749 Return a list whose CAR is `underline' and CDR is a plist with
3750 `:begin', `:end', `:contents-begin' and `:contents-end' and
3751 `:post-blank' keywords.
3753 Assume point is at the first underscore marker."
3765 :end end
3766 :contents-begin contents-begin
3767 :contents-end contents-end
3771 "Interpret UNDERLINE object as Org syntax.
3772 CONTENTS is the contents of the object."
3776 ;;;; Verbatim
3779 "Parse verbatim object at point.
3781 Return a list whose CAR is `verbatim' and CDR is a plist with
3782 `:value', `:begin', `:end' and `:post-blank' keywords.
3784 Assume point is at the first equal sign marker."
3795 :begin begin
3796 :end end
3800 "Interpret VERBATIM object as Org syntax.
3801 CONTENTS is nil."
3805 \f
3806 ;;; Parsing Element Starting At Point
3807 ;;
3808 ;; `org-element--current-element' is the core function of this section.
3809 ;; It returns the Lisp representation of the element starting at
3810 ;; point.
3811 ;;
3812 ;; `org-element--current-element' makes use of special modes. They
3813 ;; are activated for fixed element chaining (i.e. `plain-list' >
3814 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3815 ;; `section'). Special modes are: `first-section', `item',
3816 ;; `node-property', `quote-section', `section' and `table-row'.
3820 "Parse the element starting at point.
3822 Return value is a list like (TYPE PROPS) where TYPE is the type
3823 of the element and PROPS a plist of properties associated to the
3824 element.
3826 Possible types are defined in `org-element-all-elements'.
3828 LIMIT bounds the search.
3830 Optional argument GRANULARITY determines the depth of the
3831 recursion. Allowed values are `headline', `greater-element',
3832 `element', `object' or nil. When it is broader than `object' (or
3833 nil), secondary values will not be parsed, since they only
3834 contain objects.
3836 Optional argument SPECIAL, when non-nil, can be either
3837 `first-section', `item', `node-property', `quote-section',
3838 `section', and `table-row'.
3840 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3841 be computed.
3843 This function assumes point is always at the beginning of the
3844 element it has to parse."
3847 ;; Determine if parsing depth allows for secondary strings
3848 ;; parsing. It only applies to elements referenced in
3849 ;; `org-element-secondary-value-alist'.
3852 ;; Item.
3855 ;; Table Row.
3857 ;; Node Property.
3859 ;; Headline.
3862 ;; Sections (must be checked after headline).
3868 limit)))
3869 ;; When not at bol, point is at the beginning of an item or
3870 ;; a footnote definition: next item is always a paragraph.
3872 ;; Planning and Clock.
3877 ;; Inlinetask.
3880 ;; From there, elements can have affiliated keywords.
3883 ;; Jumping over affiliated keywords put point off-limits.
3884 ;; Parse them as regular keywords.
3888 ;; LaTeX Environment.
3892 ;; Drawer and Property Drawer.
3897 ;; Fixed Width
3900 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3901 ;; Keywords.
3910 org-element-block-name-alist)))
3925 ;; Footnote Definition.
3928 ;; Horizontal Rule.
3931 ;; Diary Sexp.
3934 ;; Table.
3936 ;; List.
3939 limit affiliated
3941 ;; Default element: Paragraph.
3945 ;; Most elements can have affiliated keywords. When looking for an
3946 ;; element beginning, we want to move before them, as they belong to
3947 ;; that element, and, in the meantime, collect information they give
3948 ;; into appropriate properties. Hence the following function.
3951 "Collect affiliated keywords from point down to LIMIT.
3953 Return a list whose CAR is the position at the first of them and
3954 CDR a plist of keywords and values and move point to the
3955 beginning of the first line after them.
3957 As a special case, if element doesn't start at the beginning of
3958 the line (i.e. a paragraph starting an item), CAR is current
3959 position of point and CDR is nil."
3963 ;; RESTRICT is the list of objects allowed in parsed
3964 ;; keywords value.
3966 output)
3969 ;; Apply translation to RAW-KWD. From there, KWD is
3970 ;; the official keyword.
3972 org-element-keyword-translation-alist))
3973 raw-kwd))
3974 ;; Find main value for any keyword.
3980 ;; PARSEDP is non-nil when keyword should have its
3981 ;; value parsed.
3983 ;; If KWD is a dual keyword, find its secondary
3984 ;; value. Maybe parse it.
3991 ;; Attribute a property name to KWD.
3993 ;; Now set final shape for VALUE.
3999 ;; Attributes can always appear on multiple lines.
4002 ;; Eventually store the new value in OUTPUT.
4004 ;; Move to next keyword.
4006 ;; If affiliated keywords are orphaned: move back to first one.
4007 ;; They will be parsed as a paragraph.
4009 ;; Return value.
4013 \f
4014 ;;; The Org Parser
4015 ;;
4016 ;; The two major functions here are `org-element-parse-buffer', which
4017 ;; parses Org syntax inside the current buffer, taking into account
4018 ;; region, narrowing, or even visibility if specified, and
4019 ;; `org-element-parse-secondary-string', which parses objects within
4020 ;; a given string.
4021 ;;
4022 ;; The (almost) almighty `org-element-map' allows to apply a function
4023 ;; on elements or objects matching some type, and accumulate the
4024 ;; resulting values. In an export situation, it also skips unneeded
4025 ;; parts of the parse tree.
4028 "Recursively parse the buffer and return structure.
4029 If narrowing is in effect, only parse the visible part of the
4030 buffer.
4032 Optional argument GRANULARITY determines the depth of the
4033 recursion. It can be set to the following symbols:
4035 `headline' Only parse headlines.
4036 `greater-element' Don't recurse into greater elements excepted
4037 headlines and sections. Thus, elements
4038 parsed are the top-level ones.
4039 `element' Parse everything but objects and plain text.
4040 `object' Parse the complete buffer (default).
4042 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4043 elements.
4045 An element or an objects is represented as a list with the
4046 pattern (TYPE PROPERTIES CONTENTS), where :
4048 TYPE is a symbol describing the element or object. See
4049 `org-element-all-elements' and `org-element-all-objects' for an
4050 exhaustive list of such symbols. One can retrieve it with
4051 `org-element-type' function.
4053 PROPERTIES is the list of attributes attached to the element or
4054 object, as a plist. Although most of them are specific to the
4055 element or object type, all types share `:begin', `:end',
4056 `:post-blank' and `:parent' properties, which respectively
4057 refer to buffer position where the element or object starts,
4058 ends, the number of white spaces or blank lines after it, and
4059 the element or object containing it. Properties values can be
4060 obtained by using `org-element-property' function.
4062 CONTENTS is a list of elements, objects or raw strings
4063 contained in the current element or object, when applicable.
4064 One can access them with `org-element-contents' function.
4066 The Org buffer has `org-data' as type and nil as properties.
4067 `org-element-map' function can be used to find specific elements
4068 or objects within the parse tree.
4070 This function assumes that current major mode is `org-mode'."
4076 ;; Start in `first-section' mode so text before the first
4077 ;; headline belongs to a section.
4081 "Recursively parse objects in STRING and return structure.
4083 RESTRICTION is a symbol limiting the object types that will be
4084 looked after.
4086 Optional argument PARENT, when non-nil, is the element or object
4087 containing the secondary string. It is used to set correctly
4088 `:parent' property within the string."
4089 ;; Copy buffer-local variables listed in
4090 ;; `org-element-object-variables' into temporary buffer. This is
4091 ;; required since object parsing is dependent on these variables.
4095 org-element-object-variables))))
4103 secondary))
4104 secondary))))
4108 "Map a function on selected elements or objects.
4110 DATA is a parse tree, an element, an object, a string, or a list
4111 of such constructs. TYPES is a symbol or list of symbols of
4112 elements or objects types (see `org-element-all-elements' and
4113 `org-element-all-objects' for a complete list of types). FUN is
4114 the function called on the matching element or object. It has to
4115 accept one argument: the element or object itself.
4117 When optional argument INFO is non-nil, it should be a plist
4118 holding export options. In that case, parts of the parse tree
4119 not exportable according to that property list will be skipped.
4121 When optional argument FIRST-MATCH is non-nil, stop at the first
4122 match for which FUN doesn't return nil, and return that value.
4124 Optional argument NO-RECURSION is a symbol or a list of symbols
4125 representing elements or objects types. `org-element-map' won't
4126 enter any recursive element or object whose type belongs to that
4127 list. Though, FUN can still be applied on them.
4129 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4130 apply to matching objects within parsed affiliated keywords (see
4131 `org-element-parsed-keywords').
4133 Nil values returned from FUN do not appear in the results.
4136 Examples:
4137 ---------
4139 Assuming TREE is a variable containing an Org buffer parse tree,
4140 the following example will return a flat list of all `src-block'
4141 and `example-block' elements in it:
4143 \(org-element-map tree '(example-block src-block) 'identity)
4145 The following snippet will find the first headline with a level
4148 \(org-element-map tree 'headline
4149 \(lambda (hl)
4150 \(and (= (org-element-property :level hl) 1)
4152 \(org-element-property :begin hl)))
4153 nil t)
4155 The next example will return a flat list of all `plain-list' type
4156 elements in TREE that are not a sub-list themselves:
4158 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4160 Eventually, this example will return a flat list of all `bold'
4161 type objects containing a `latex-snippet' type object, even
4162 looking into captions:
4164 \(org-element-map tree 'bold
4165 \(lambda (b)
4166 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4167 nil nil nil t)"
4168 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4171 ;; Recursion depth is determined by --CATEGORY.
4178 ;; If one object is found, the function
4179 ;; has to recurse into every object.
4182 ;; If one regular element is found, the
4183 ;; function has to recurse, at least,
4184 ;; into every element it encounters.
4187 types)
4188 category)))
4189 ;; Compute properties for affiliated keywords if necessary.
4194 org-element-affiliated-keywords)))
4195 --acc
4196 --walk-tree
4200 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4201 ;; holding contextual information.
4205 ;; Ignored element in an export context.
4207 ;; List of elements or objects.
4209 ;; Unconditionally enter parse trees.
4213 ;; Check if TYPE is matching among TYPES. If so,
4214 ;; apply FUN to --DATA and accumulate return value
4215 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4221 ;; If --DATA has a secondary string that can contain
4222 ;; objects with their type among TYPES, look into it.
4229 ;; If --DATA has any affiliated keywords and
4230 ;; WITH-AFFILIATED is non-nil, look for objects in
4231 ;; them.
4239 ;; Pay attention to the type of value.
4240 ;; Preserve order for multiple keywords.
4256 --affiliated-alist))
4257 ;; Determine if a recursion into --DATA is possible.
4259 ;; --TYPE is explicitly removed from recursion.
4261 ;; --DATA has no contents.
4263 ;; Looking for greater elements but --DATA is simply
4264 ;; an element or an object.
4267 ;; Looking for elements but --DATA is an object.
4270 ;; In any other case, map contents.
4274 ;; Return value in a proper order.
4278 ;; The following functions are internal parts of the parser.
4279 ;;
4280 ;; The first one, `org-element--parse-elements' acts at the element's
4281 ;; level.
4282 ;;
4283 ;; The second one, `org-element--parse-objects' applies on all objects
4284 ;; of a paragraph or a secondary string. It uses
4285 ;; `org-element--get-next-object-candidates' to optimize the search of
4286 ;; the next object in the buffer.
4287 ;;
4288 ;; More precisely, that function looks for every allowed object type
4289 ;; first. Then, it discards failed searches, keeps further matches,
4290 ;; and searches again types matched behind point, for subsequent
4291 ;; calls. Thus, searching for a given type fails only once, and every
4292 ;; object is searched only once at top level (but sometimes more for
4293 ;; nested types).
4297 "Parse elements between BEG and END positions.
4299 SPECIAL prioritize some elements over the others. It can be set
4300 to `first-section', `quote-section', `section' `item' or
4301 `table-row'.
4303 When value is `item', STRUCTURE will be used as the current list
4304 structure.
4306 GRANULARITY determines the depth of the recursion. See
4307 `org-element-parse-buffer' for more information.
4309 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4310 elements.
4312 Elements are accumulated into ACC."
4315 ;; Visible only: skip invisible parts at the beginning of the
4316 ;; element.
4319 ;; When parsing only headlines, skip any text before first one.
4322 ;; Main loop start.
4324 ;; Find current element's type and parse it accordingly to
4325 ;; its category.
4327 end granularity special structure))
4331 ;; Visible only: skip invisible parts between siblings.
4334 ;; Fill ELEMENT contents by side-effect.
4336 ;; If element has no contents, don't modify it.
4338 ;; Greater element: parse it between `contents-begin' and
4339 ;; `contents-end'. Make sure GRANULARITY allows the
4340 ;; recursion, or ELEMENT is a headline, in which case going
4341 ;; inside is mandatory, in order to get sub-level headings.
4349 ;; Possibly switch to a special mode.
4359 granularity visible-only element))
4360 ;; ELEMENT has contents. Parse objects inside, if
4361 ;; GRANULARITY allows it.
4367 ;; Return result.
4368 acc))
4371 "Parse objects between BEG and END and return recursive structure.
4373 Objects are accumulated in ACC.
4375 RESTRICTION is a list of object successors which are allowed in
4376 the current object."
4385 restriction candidates)))
4392 ;; 1. Text before any object. Untabify it.
4397 acc
4401 ;; 2. Object...
4404 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4405 ;; a recursive type.
4413 ;; 3. Text after last object. Untabify it.
4417 acc
4421 ;; Result.
4422 acc))))
4425 "Return an alist of candidates for the next object.
4427 RESTRICTION is a list of object types, as symbols. Only
4428 candidates with such types are looked after.
4430 OBJECTS is the previous candidates alist. If it is set to
4431 `initial', no search has been done before, and all symbols in
4432 RESTRICTION should be looked after.
4434 Return value is an alist whose CAR is the object type and CDR its
4435 beginning position."
4437 nil
4439 ;; When searching for the first time, look for every successor
4440 ;; allowed in RESTRICTION.
4444 restriction)
4445 ;; Focus on objects returned during last search. Keep those
4446 ;; still after point. Search again objects before it.
4452 type)))
4455 objects))))
4458 \f
4459 ;;; Towards A Bijective Process
4460 ;;
4461 ;; The parse tree obtained with `org-element-parse-buffer' is really
4462 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4463 ;; interpreted and expanded into a string with canonical Org syntax.
4464 ;; Hence `org-element-interpret-data'.
4465 ;;
4466 ;; The function relies internally on
4467 ;; `org-element--interpret-affiliated-keywords'.
4469 ;;;###autoload
4471 "Interpret DATA as Org syntax.
4473 DATA is a parse tree, an element, an object or a secondary string
4474 to interpret.
4476 Optional argument PARENT is used for recursive calls. It contains
4477 the element or object containing data, or nil.
4479 Return Org syntax as a string."
4483 ;; Secondary string.
4488 ;; Full Org document.
4493 ;; Plain text: return it.
4495 ;; Element/Object without contents.
4498 data nil))
4499 ;; Element/Object with contents.
4509 ;; Elements directly containing objects must
4510 ;; have their indentation normalized first.
4512 data
4513 ;; When normalizing first paragraph of an
4514 ;; item or a footnote-definition, ignore
4515 ;; first line's indentation.
4522 data
4524 contents)))))))
4526 ;; Build white spaces. If no `:post-blank' property is
4527 ;; specified, assume its value is 0.
4537 "Return ELEMENT's affiliated keywords as Org syntax.
4538 If there is no affiliated keyword, return the empty string."
4548 ": "
4551 value)
4559 ;; All attribute keywords can have multiple lines.
4565 ;; List all ELEMENT's properties matching an attribute line or an
4566 ;; affiliated keyword, but ignore translated keywords since they
4567 ;; cannot belong to the property list.
4574 org-element-keyword-translation-alist)))))
4575 collect prop)
4578 ;; Because interpretation of the parse tree must return the same
4579 ;; number of blank lines between elements and the same number of white
4580 ;; space after objects, some special care must be given to white
4581 ;; spaces.
4582 ;;
4583 ;; The first function, `org-element-normalize-string', ensures any
4584 ;; string different from the empty string will end with a single
4585 ;; newline character.
4586 ;;
4587 ;; The second function, `org-element-normalize-contents', removes
4588 ;; global indentation from the contents of the current element.
4591 "Ensure string S ends with a single newline character.
4593 If S isn't a string return it unchanged. If S is the empty
4594 string, return it. Otherwise, return a new string with a single
4595 newline character at its end."
4603 "Normalize plain text in ELEMENT's contents.
4605 ELEMENT must only contain plain text and objects.
4607 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4608 indentation to compute maximal common indentation.
4610 Return the normalized element that is element with global
4611 indentation removed from its contents. The function assumes that
4612 indentation is not done with TAB characters."
4614 find-min-ind ; For byte-compiler.
4617 ;; Return minimal common indentation within BLOB. This is
4618 ;; done by walking recursively BLOB and updating MIN-IND
4619 ;; along the way. FIRST-FLAG is non-nil when the first
4620 ;; string hasn't been seen yet. It is required as this
4621 ;; string is the only one whose indentation doesn't happen
4622 ;; after a newline character.
4629 ;; An indentation of zero means no string will be
4630 ;; modified. Quit the process.
4639 ;; Find minimal indentation in ELEMENT.
4642 ;; Build ELEMENT back, replacing each string with the same
4643 ;; string minus common indentation.
4648 ;; Return BLOB with all its strings indentation
4649 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4650 ;; is non-nil when the first string hasn't been seen
4651 ;; yet.
4666 org-element-recursive-objects)
4670 blob))))
4674 \f
4675 ;;; The Toolbox
4676 ;;
4677 ;; The first move is to implement a way to obtain the smallest element
4678 ;; containing point. This is the job of `org-element-at-point'. It
4679 ;; basically jumps back to the beginning of section containing point
4680 ;; and moves, element after element, with
4681 ;; `org-element--current-element' until the container is found. Note:
4682 ;; When using `org-element-at-point', secondary values are never
4683 ;; parsed since the function focuses on elements, not on objects.
4684 ;;
4685 ;; At a deeper level, `org-element-context' lists all elements and
4686 ;; objects containing point.
4687 ;;
4688 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4689 ;; internally by navigation and manipulation tools.
4691 ;;;###autoload
4693 "Determine closest element around point.
4695 Return value is a list like (TYPE PROPS) where TYPE is the type
4696 of the element and PROPS a plist of properties associated to the
4697 element.
4699 Possible types are defined in `org-element-all-elements'.
4700 Properties depend on element or object type, but always include
4701 `:begin', `:end', `:parent' and `:post-blank' properties.
4703 As a special case, if point is at the very beginning of a list or
4704 sub-list, returned element will be that list instead of the first
4705 item. In the same way, if point is at the beginning of the first
4706 row of a table, returned element will be the table instead of the
4707 first row.
4709 If optional argument KEEP-TRAIL is non-nil, the function returns
4710 a list of elements leading to element at point. The list's CAR
4711 is always the element at point. The following positions contain
4712 element's siblings, then parents, siblings of parents, until the
4713 first element of current section."
4715 ;; If at a headline, parse it. It is the sole element that
4716 ;; doesn't require to know about context. Be sure to disallow
4717 ;; secondary string parsing, though.
4723 ;; Otherwise move at the beginning of the section containing
4724 ;; point.
4729 element type special-flag trail struct prevs parent)
4732 ;; In empty lines at buffer's beginning, return nil.
4741 ;; In blank lines just after the headline, point still
4742 ;; belongs to the headline.
4751 ;; Parse successively each element, skipping those ending
4752 ;; before original position.
4760 ;; 1. Skip any element ending before point. Also skip
4761 ;; element ending at point when we're sure that another
4762 ;; element has started.
4767 ;; 2. An element containing point is always the element at
4768 ;; point.
4771 ;; 3. At any other greater element type, if point is
4772 ;; within contents, move into it.
4777 ;; Create an anchor for tables and plain lists:
4778 ;; when point is at the very beginning of these
4779 ;; elements, ignoring affiliated keywords,
4780 ;; target them instead of their contents.
4782 ;; When point is at contents end, do not move
4783 ;; into elements with an explicit ending, but
4784 ;; return that element instead.
4788 drawer dynamic-block inlinetask
4789 property-drawer quote-block
4790 special-block))
4791 ;; Corner case: if a list ends at the
4792 ;; end of a buffer without a final new
4793 ;; line, return last element in last
4794 ;; item instead.
4812 ;;;###autoload
4814 "Return closest element or object around point.
4816 Return value is a list like (TYPE PROPS) where TYPE is the type
4817 of the element or object and PROPS a plist of properties
4818 associated to it.
4820 Possible types are defined in `org-element-all-elements' and
4821 `org-element-all-objects'. Properties depend on element or
4822 object type, but always include `:begin', `:end', `:parent' and
4823 `:post-blank'.
4825 Optional argument ELEMENT, when non-nil, is the closest element
4826 containing point, as returned by `org-element-at-point'.
4827 Providing it allows for quicker computation."
4833 context)
4834 ;; Check if point is inside an element containing objects or at
4835 ;; a secondary string. In that case, narrow buffer to the
4836 ;; containing area. Otherwise, return ELEMENT.
4838 ;; At a parsed affiliated keyword, check if we're inside main
4839 ;; or dual value.
4846 org-element-parsed-keywords))
4855 ;; Also change type to retrieve correct restrictions.
4857 ;; At an item, objects can only be located within tag, if any.
4867 ;; At an headline or inlinetask, objects are located within
4868 ;; their title.
4875 ;; At a paragraph, a table-row or a verse block, objects are
4876 ;; located within their contents.
4880 ;; CBEG is nil for table rules.
4884 ;; At a parsed keyword, objects are located within value.
4887 org-element-document-properties))
4894 ;; At a planning line, if point is at a timestamp, return it,
4895 ;; otherwise, return element.
4912 restriction candidates))
4914 candidates)))
4915 ;; If ORIGIN is before next object in element, there's
4916 ;; no point in looking further.
4926 ;; ORIGIN is after OBJECT, so skip it.
4928 ;; ORIGIN is within a non-recursive object or at
4929 ;; an object boundaries: Return that object.
4933 ;; Otherwise, move within current object and
4934 ;; restrict search to the end of its contents.
4941 parent))))))
4944 "Non-nil when elements ELEM-A and ELEM-B are nested."
4953 "Swap elements ELEM-A and ELEM-B.
4954 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4955 end of ELEM-A."
4957 ;; There are two special cases when an element doesn't start at bol:
4958 ;; the first paragraph in an item or in a footnote definition.
4960 ;; Only a paragraph without any affiliated keyword can be moved at
4961 ;; ELEM-A position in such a situation. Note that the case of
4962 ;; a footnote definition is impossible: it cannot contain two
4963 ;; paragraphs in a row because it cannot contain a blank line.
4969 ;; In a special situation, ELEM-A will have no indentation. We'll
4970 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4984 ;; Store overlays responsible for visibility status. We
4985 ;; also need to store their boundaries as they will be
4986 ;; removed from buffer.
4993 ;; Get contents.
5001 ;; Restore ex ELEM-A overlays.
5010 ;; Restore ex ELEM-B overlays.
5019 ;; Local variables:
5020 ;; generated-autoload-file: "org-loaddefs.el"
5021 ;; End:
5023 ;;; org-element.el ends here