| blob | a19f52c7923d6f57ec7c65dfde76459a7462f56c |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2016 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 (e.g. 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 inline-src-block latex-or-entity line-break macro plain-link
192 radio-target 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, superscript and text
350 markup.
352 This alist also applies to secondary string. For example, an
353 `headline' type element doesn't directly contain objects, but
364 \f
365 ;;; Accessors and Setters
366 ;;
367 ;; Provide four accessors: `org-element-type', `org-element-property'
368 ;; `org-element-contents' and `org-element-restriction'.
369 ;;
370 ;; Setter functions allow modification of elements by side effect.
371 ;; There is `org-element-put-property', `org-element-set-contents',
372 ;; `org-element-set-element' and `org-element-adopt-element'. Note
373 ;; that `org-element-set-element' and `org-element-adopt-elements' are
374 ;; higher level functions since also update `:parent' property.
377 "Return type of ELEMENT.
379 The function returns the type of the element or object provided.
380 It can also return the following special value:
381 `plain-text' for a string
382 `org-data' for a complete document
383 nil in any other case."
389 "Extract the value from the PROPERTY of an ELEMENT."
394 "Extract contents from an ELEMENT."
400 "Return restriction associated to ELEMENT.
401 ELEMENT can be an element, an object or a symbol representing an
402 element or object type."
404 org-element-object-restrictions)))
407 "In ELEMENT set PROPERTY to VALUE.
408 Return modified element."
411 element))
414 "Set ELEMENT contents to CONTENTS.
415 Return modified element."
422 "Replace element or object OLD with element or object NEW.
423 The function takes care of setting `:parent' property for NEW."
424 ;; Since OLD is going to be changed into NEW by side-effect, first
425 ;; make sure that every element or object within NEW has OLD as
426 ;; parent.
429 ;; Transfer contents.
431 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
432 ;; with NEW's.
435 ;; Transfer type.
439 "Append elements to the contents of another element.
441 PARENT is an element or object. CHILDREN can be elements,
442 objects, or a strings.
444 The function takes care of setting `:parent' property for CHILD.
445 Return parent element."
446 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
447 ;; string: parent is the list itself.
450 children)
451 ;; Add CHILDREN at the end of PARENT contents.
454 parent
456 ;; Return modified PARENT element.
460 \f
461 ;;; Greater elements
462 ;;
463 ;; For each greater element type, we define a parser and an
464 ;; interpreter.
465 ;;
466 ;; A parser returns the element or object as the list described above.
467 ;; Most of them accepts no argument. Though, exceptions exist. Hence
468 ;; every element containing a secondary string (see
469 ;; `org-element-secondary-value-alist') will accept an optional
470 ;; argument to toggle parsing of that secondary string. Moreover,
471 ;; `item' parser requires current list's structure as its first
472 ;; element.
473 ;;
474 ;; An interpreter accepts two arguments: the list representation of
475 ;; the element or object, and its contents. The latter may be nil,
476 ;; depending on the element or object considered. It returns the
477 ;; appropriate Org syntax, as a string.
478 ;;
479 ;; Parsing functions must follow the naming convention:
480 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
481 ;; defined in `org-element-greater-elements'.
482 ;;
483 ;; Similarly, interpreting functions must follow the naming
484 ;; convention: org-element-TYPE-interpreter.
485 ;;
486 ;; With the exception of `headline' and `item' types, greater elements
487 ;; cannot contain other greater elements of their own type.
488 ;;
489 ;; Beside implementing a parser and an interpreter, adding a new
490 ;; greater element requires tweaking `org-element--current-element'.
491 ;; Moreover, the newly defined type must be added to both
492 ;; `org-element-all-elements' and `org-element-greater-elements'.
495 ;;;; Center Block
498 "Parse a center block.
500 LIMIT bounds the search. AFFILIATED is a list of which CAR is
501 the buffer position at the beginning of the first affiliated
502 keyword and CDR is a plist of affiliated keywords along with
503 their value.
505 Return a list whose CAR is `center-block' and CDR is a plist
506 containing `:begin', `:end', `:hiddenp', `:contents-begin',
507 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
509 Assume point is at the beginning of the block."
513 ;; Incomplete block: parse it as a paragraph.
518 ;; Empty blocks have no contents.
533 :end end
534 :hiddenp hidden
535 :contents-begin contents-begin
536 :contents-end contents-end
542 "Interpret CENTER-BLOCK element as Org syntax.
543 CONTENTS is the contents of the element."
547 ;;;; Drawer
550 "Parse a drawer.
552 LIMIT bounds the search. AFFILIATED is a list of which CAR is
553 the buffer position at the beginning of the first affiliated
554 keyword and CDR is a plist of affiliated keywords along with
555 their value.
557 Return a list whose CAR is `drawer' and CDR is a plist containing
558 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
559 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
561 Assume point is at beginning of drawer."
564 ;; Incomplete drawer: parse it as a paragraph.
572 ;; Empty drawers have no contents.
586 :end end
587 :drawer-name name
588 :hiddenp hidden
589 :contents-begin contents-begin
590 :contents-end contents-end
596 "Interpret DRAWER element as Org syntax.
597 CONTENTS is the contents of the element."
600 contents))
603 ;;;; Dynamic Block
606 "Parse a dynamic block.
608 LIMIT bounds the search. AFFILIATED is a list of which CAR is
609 the buffer position at the beginning of the first affiliated
610 keyword and CDR is a plist of affiliated keywords along with
611 their value.
613 Return a list whose CAR is `dynamic-block' and CDR is a plist
614 containing `:block-name', `:begin', `:end', `:hiddenp',
615 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
616 and `:post-affiliated' keywords.
618 Assume point is at beginning of dynamic block."
622 ;; Incomplete block: parse it as a paragraph.
631 ;; Empty blocks have no contents.
645 :end end
646 :block-name name
647 :arguments arguments
648 :hiddenp hidden
649 :contents-begin contents-begin
650 :contents-end contents-end
656 "Interpret DYNAMIC-BLOCK element as Org syntax.
657 CONTENTS is the contents of the element."
662 contents))
665 ;;;; Footnote Definition
668 "Parse a footnote definition.
670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
671 the buffer position at the beginning of the first affiliated
672 keyword and CDR is a plist of affiliated keywords along with
673 their value.
675 Return a list whose CAR is `footnote-definition' and CDR is
676 a plist containing `:label', `:begin' `:end', `:contents-begin',
677 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
679 Assume point is at the beginning of the footnote definition."
707 :begin begin
708 :end end
709 :contents-begin contents-begin
710 :contents-end contents-end
716 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
717 CONTENTS is the contents of the footnote-definition."
719 " "
720 contents))
723 ;;;; Headline
726 "Parse a headline.
728 Return a list whose CAR is `headline' and CDR is a plist
729 containing `:raw-value', `:title', `:alt-title', `:begin',
730 `:end', `:pre-blank', `:hiddenp', `:contents-begin',
731 `:contents-end', `:level', `:priority', `:tags',
732 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
733 `:closed', `:quotedp', `:archivedp', `:commentedp',
734 `:footnote-section-p' and `:post-blank' keywords.
736 The plist also contains any property set in the property drawer,
737 with its name in upper cases and colons added at the
738 beginning (e.g., `:CUSTOM_ID').
740 LIMIT is a buffer position bounding the search.
742 When RAW-SECONDARY-P is non-nil, headline's title will not be
743 parsed as a secondary string, but as a plain string instead.
745 Assume point is at beginning of the headline."
758 raw-value)))
762 raw-value)))
766 ;; Upcase property names. It avoids confusion between
767 ;; properties obtained through property drawer and default
768 ;; properties from the parser (e.g. `:end' and :END:)
778 plist))
780 ;; Read time properties on the line below the headline.
786 org-keyword-time-not-clock-regexp end t)
796 plist))))
809 ;; Clean RAW-VALUE from any quote or comment string.
817 ""
818 raw-value))))
819 ;; Clean TAGS from archive tag, if any.
825 :begin begin
826 :end end
827 :pre-blank
830 :hiddenp hidden
831 :contents-begin contents-begin
832 :contents-end contents-end
833 :level level
835 :tags tags
836 :todo-keyword todo
837 :todo-type todo-type
840 end)
841 :footnote-section-p footnote-section-p
842 :archivedp archivedp
843 :commentedp commentedp
845 time-props
846 standard-props))))
850 headline :alt-title
855 headline :title
861 "Interpret HEADLINE element as Org syntax.
862 CONTENTS is the contents of the element."
879 ?*)
884 " "
887 org-footnote-section
888 title))))
890 heading
891 ;; Align tags.
899 ?\s)
900 tags))
904 tags))))
906 contents)))
909 ;;;; Inlinetask
912 "Parse an inline task.
914 Return a list whose CAR is `inlinetask' and CDR is a plist
915 containing `:title', `:begin', `:end', `:hiddenp',
916 `:contents-begin' and `:contents-end', `:level', `:priority',
917 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
918 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
920 The plist also contains any property set in the property drawer,
921 with its name in upper cases and colons added at the
922 beginning (e.g., `:CUSTOM_ID').
924 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
925 title will not be parsed as a secondary string, but as a plain
926 string instead.
928 Assume point is at beginning of the inline task."
938 ;; Upcase property names. It avoids confusion between
939 ;; properties obtained through property drawer and default
940 ;; properties from the parser (e.g. `:end' and :END:)
950 plist))
952 ;; Read time properties on the line below the inlinetask
953 ;; opening string.
959 org-keyword-time-not-clock-regexp end t)
969 plist))))
989 :begin begin
990 :end end
991 :hiddenp hidden
992 :contents-begin contents-begin
993 :contents-end contents-end
996 :tags tags
997 :todo-keyword todo
998 :todo-type todo-type
1000 time-props
1001 standard-props))))
1003 inlinetask :title
1006 raw-value
1008 inlinetask))))))
1011 "Interpret INLINETASK element as Org syntax.
1012 CONTENTS is the contents of inlinetask."
1027 ;; Align tags.
1035 ? )
1036 tags))
1040 tags))))
1041 ;; Prefer degenerate inlinetasks when there are no
1042 ;; contents.
1045 contents
1049 ;;;; Item
1052 "Parse an item.
1054 STRUCT is the structure of the plain list.
1056 Return a list whose CAR is `item' and CDR is a plist containing
1057 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1058 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1059 `:post-blank' keywords.
1061 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1062 any, will not be parsed as a secondary string, but as a plain
1063 string instead.
1065 Assume point is at the beginning of the item."
1089 ;; Ignore tags in un-ordered lists: they are just
1090 ;; a part of item's body.
1096 ;; If first line isn't empty, contents really start
1097 ;; at the text after item's meta-data.
1108 :begin begin
1109 :end end
1110 ;; CONTENTS-BEGIN and CONTENTS-END may be
1111 ;; mixed up in the case of an empty item
1112 ;; separated from the next by a blank line.
1113 ;; Thus ensure the former is always the
1114 ;; smallest.
1117 :checkbox checkbox
1118 :counter counter
1119 :hiddenp hidden
1120 :structure struct
1123 item :tag
1131 "Interpret ITEM element as Org syntax.
1132 CONTENTS is the contents of the element."
1142 ;; Compute indentation.
1147 ;; Indent contents.
1149 bullet
1163 ;;;; Plain List
1166 ;; Return structure of list at point. Internal function. See
1167 ;; `org-list-struct' for details.
1175 items struct)
1180 ;; At limit: end all items.
1189 ;; At list end: end all items.
1194 ;; At a new item: end previous sibling.
1206 ind
1207 bullet
1210 ;; Description tag.
1214 ;; Ending position, unknown so far.
1215 nil)))
1216 items))
1218 ;; Skip empty lines.
1220 ;; Skip inline tasks and blank lines along the way.
1227 ;; At some text line. Check if it ends any previous item.
1239 ;; Skip blocks (any type) and drawers contents.
1245 limit t)))
1251 "Parse a plain list.
1253 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1254 the buffer position at the beginning of the first affiliated
1255 keyword and CDR is a plist of affiliated keywords along with
1256 their value. STRUCTURE is the structure of the plain list being
1257 parsed.
1259 Return a list whose CAR is `plain-list' and CDR is a plist
1260 containing `:type', `:begin', `:end', `:contents-begin' and
1261 `:contents-end', `:structure', `:post-blank' and
1262 `:post-affiliated' keywords.
1264 Assume point is at the beginning of the list."
1277 ;; Return value.
1281 :begin begin
1282 :end end
1283 :contents-begin contents-begin
1284 :contents-end contents-end
1285 :structure struct
1291 "Interpret PLAIN-LIST element as Org syntax.
1292 CONTENTS is the contents of the element."
1300 ;;;; Property Drawer
1303 "Parse a property drawer.
1305 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1306 the buffer position at the beginning of the first affiliated
1307 keyword and CDR is a plist of affiliated keywords along with
1308 their value.
1310 Return a list whose CAR is `property-drawer' and CDR is a plist
1311 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1312 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1314 Assume point is at the beginning of the property drawer."
1317 ;; Incomplete drawer: parse it as a paragraph.
1338 :end end
1339 :hiddenp hidden
1340 :contents-begin contents-begin
1341 :contents-end contents-end
1347 "Interpret PROPERTY-DRAWER element as Org syntax.
1348 CONTENTS is the properties within the drawer."
1352 ;;;; Quote Block
1355 "Parse a quote block.
1357 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1358 the buffer position at the beginning of the first affiliated
1359 keyword and CDR is a plist of affiliated keywords along with
1360 their value.
1362 Return a list whose CAR is `quote-block' and CDR is a plist
1363 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1364 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1366 Assume point is at the beginning of the block."
1370 ;; Incomplete block: parse it as a paragraph.
1376 ;; Empty blocks have no contents.
1390 :end end
1391 :hiddenp hidden
1392 :contents-begin contents-begin
1393 :contents-end contents-end
1399 "Interpret QUOTE-BLOCK element as Org syntax.
1400 CONTENTS is the contents of the element."
1404 ;;;; Section
1407 "Parse a section.
1409 LIMIT bounds the search.
1411 Return a list whose CAR is `section' and CDR is a plist
1412 containing `:begin', `:end', `:contents-begin', `contents-end'
1413 and `:post-blank' keywords."
1415 ;; Beginning of section is the beginning of the first non-blank
1416 ;; line after previous headline.
1425 :end end
1426 :contents-begin begin
1427 :contents-end pos-before-blank
1431 "Interpret SECTION element as Org syntax.
1432 CONTENTS is the contents of the element."
1433 contents)
1436 ;;;; Special Block
1439 "Parse a special block.
1441 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1442 the buffer position at the beginning of the first affiliated
1443 keyword and CDR is a plist of affiliated keywords along with
1444 their value.
1446 Return a list whose CAR is `special-block' and CDR is a plist
1447 containing `:type', `:begin', `:end', `:hiddenp',
1448 `:contents-begin', `:contents-end', `:post-blank' and
1449 `:post-affiliated' keywords.
1451 Assume point is at the beginning of the block."
1458 limit t)))
1459 ;; Incomplete block: parse it as a paragraph.
1465 ;; Empty blocks have no contents.
1479 :begin begin
1480 :end end
1481 :hiddenp hidden
1482 :contents-begin contents-begin
1483 :contents-end contents-end
1489 "Interpret SPECIAL-BLOCK element as Org syntax.
1490 CONTENTS is the contents of the element."
1495 \f
1496 ;;; Elements
1497 ;;
1498 ;; For each element, a parser and an interpreter are also defined.
1499 ;; Both follow the same naming convention used for greater elements.
1500 ;;
1501 ;; Also, as for greater elements, adding a new element type is done
1502 ;; through the following steps: implement a parser and an interpreter,
1503 ;; tweak `org-element--current-element' so that it recognizes the new
1504 ;; type and add that new type to `org-element-all-elements'.
1505 ;;
1506 ;; As a special case, when the newly defined type is a block type,
1507 ;; `org-element-block-name-alist' has to be modified accordingly.
1510 ;;;; Babel Call
1513 "Parse a babel call.
1515 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1516 the buffer position at the beginning of the first affiliated
1517 keyword and CDR is a plist of affiliated keywords along with
1518 their value.
1520 Return a list whose CAR is `babel-call' and CDR is a plist
1521 containing `:begin', `:end', `:info', `:post-blank' and
1522 `:post-affiliated' as keywords."
1535 :end end
1536 :info info
1542 "Interpret BABEL-CALL element as Org syntax.
1543 CONTENTS is nil."
1549 ;; Remove redundant square brackets.
1554 ;;;; Clock
1557 "Parse a clock.
1559 LIMIT bounds the search.
1561 Return a list whose CAR is `clock' and CDR is a plist containing
1562 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1563 as keywords."
1583 :value value
1584 :duration duration
1585 :begin begin
1586 :end end
1590 "Interpret CLOCK element as Org syntax.
1591 CONTENTS is nil."
1599 "%2s:%02s"
1603 ;;;; Comment
1606 "Parse a comment.
1608 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1609 the buffer position at the beginning of the first affiliated
1610 keyword and CDR is a plist of affiliated keywords along with
1611 their value.
1613 Return a list whose CAR is `comment' and CDR is a plist
1614 containing `:begin', `:end', `:value', `:post-blank',
1615 `:post-affiliated' keywords.
1617 Assume point is at comment beginning."
1626 ;; Get comments ending.
1629 ;; Accumulate lines without leading hash and first
1630 ;; whitespace.
1644 :end end
1645 :value value
1651 "Interpret COMMENT element as Org syntax.
1652 CONTENTS is nil."
1656 ;;;; Comment Block
1659 "Parse an export block.
1661 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1662 the buffer position at the beginning of the first affiliated
1663 keyword and CDR is a plist of affiliated keywords along with
1664 their value.
1666 Return a list whose CAR is `comment-block' and CDR is a plist
1667 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1668 and `:post-affiliated' keywords.
1670 Assume point is at comment block beginning."
1674 ;; Incomplete block: parse it as a paragraph.
1688 contents-begin contents-end)))
1692 :end end
1693 :value value
1694 :hiddenp hidden
1700 "Interpret COMMENT-BLOCK element as Org syntax.
1701 CONTENTS is nil."
1706 ;;;; Diary Sexp
1709 "Parse a diary sexp.
1711 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1712 the buffer position at the beginning of the first affiliated
1713 keyword and CDR is a plist of affiliated keywords along with
1714 their value.
1716 Return a list whose CAR is `diary-sexp' and CDR is a plist
1717 containing `:begin', `:end', `:value', `:post-blank' and
1718 `:post-affiliated' keywords."
1730 :begin begin
1731 :end end
1737 "Interpret DIARY-SEXP as Org syntax.
1738 CONTENTS is nil."
1742 ;;;; Example Block
1745 "Remove maximum common indentation in string S and return it.
1746 When optional argument N is a positive integer, remove exactly
1747 that much characters from indentation, if possible, or return
1748 S as-is otherwise. Unlike to `org-remove-indentation', this
1749 function doesn't call `untabify' on S."
1754 ;; Find maximum common indentation, if not specified.
1762 min-ind)))
1764 ;; Remove exactly N indentation, but give up if not possible.
1774 "Parse an example block.
1776 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1777 the buffer position at the beginning of the first affiliated
1778 keyword and CDR is a plist of affiliated keywords along with
1779 their value.
1781 Return a list whose CAR is `example-block' and CDR is a plist
1782 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1783 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1784 `:switches', `:value', `:post-blank' and `:post-affiliated'
1785 keywords."
1789 ;; Incomplete block: parse it as a paragraph.
1797 ;; Switches analysis
1805 ;; Should labels be retained in (or stripped from) example
1806 ;; blocks?
1811 ;; What should code-references use - labels or
1812 ;; line-numbers?
1821 ;; Standard block parsing.
1830 contents-begin contents-end))
1840 :end end
1841 :value value
1842 :switches switches
1843 :number-lines number-lines
1844 :preserve-indent preserve-indent
1845 :retain-labels retain-labels
1846 :use-labels use-labels
1847 :label-fmt label-fmt
1848 :hiddenp hidden
1854 "Interpret EXAMPLE-BLOCK element as Org syntax.
1855 CONTENTS is nil."
1863 ;;;; Export Block
1866 "Parse an export block.
1868 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1869 the buffer position at the beginning of the first affiliated
1870 keyword and CDR is a plist of affiliated keywords along with
1871 their value.
1873 Return a list whose CAR is `export-block' and CDR is a plist
1874 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1875 `:post-blank' and `:post-affiliated' keywords.
1877 Assume point is at export-block beginning."
1884 ;; Incomplete block: parse it as a paragraph.
1898 contents-end)))
1902 :end end
1903 :type type
1904 :value value
1905 :hiddenp hidden
1911 "Interpret EXPORT-BLOCK element as Org syntax.
1912 CONTENTS is nil."
1919 ;;;; Fixed-width
1922 "Parse a fixed-width section.
1924 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1925 the buffer position at the beginning of the first affiliated
1926 keyword and CDR is a plist of affiliated keywords along with
1927 their value.
1929 Return a list whose CAR is `fixed-width' and CDR is a plist
1930 containing `:begin', `:end', `:value', `:post-blank' and
1931 `:post-affiliated' keywords.
1933 Assume point is at the beginning of the fixed-width area."
1937 value
1942 ;; Accumulate text without starting colons.
1955 :end end
1956 :value value
1962 "Interpret FIXED-WIDTH element as Org syntax.
1963 CONTENTS is nil."
1971 ;;;; Horizontal Rule
1974 "Parse an horizontal rule.
1976 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1977 the buffer position at the beginning of the first affiliated
1978 keyword and CDR is a plist of affiliated keywords along with
1979 their value.
1981 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1982 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1983 keywords."
1993 :end end
1999 "Interpret HORIZONTAL-RULE element as Org syntax.
2000 CONTENTS is nil."
2004 ;;;; Keyword
2007 "Parse a keyword at point.
2009 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2010 the buffer position at the beginning of the first affiliated
2011 keyword and CDR is a plist of affiliated keywords along with
2012 their value.
2014 Return a list whose CAR is `keyword' and CDR is a plist
2015 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2016 `:post-affiliated' keywords."
2030 :value value
2031 :begin begin
2032 :end end
2038 "Interpret KEYWORD element as Org syntax.
2039 CONTENTS is nil."
2045 ;;;; Latex Environment
2048 "Parse a LaTeX environment.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `latex-environment' and CDR is a plist
2056 containing `:begin', `:end', `:value', `:post-blank' and
2057 `:post-affiliated' keywords.
2059 Assume point is at the beginning of the latex environment."
2066 limit t))
2067 ;; Incomplete latex environment: parse it as a paragraph.
2077 :end end
2078 :value value
2084 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2085 CONTENTS is nil."
2089 ;;;; Node Property
2092 "Parse a node-property at point.
2094 LIMIT bounds the search.
2096 Return a list whose CAR is `node-property' and CDR is a plist
2097 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2098 keywords."
2107 limit))))
2110 :value value
2111 :begin begin
2112 :end end
2116 "Interpret NODE-PROPERTY element as Org syntax.
2117 CONTENTS is nil."
2123 ;;;; Paragraph
2126 "Parse a paragraph.
2128 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2129 the buffer position at the beginning of the first affiliated
2130 keyword and CDR is a plist of affiliated keywords along with
2131 their value.
2133 Return a list whose CAR is `paragraph' and CDR is a plist
2134 containing `:begin', `:end', `:contents-begin' and
2135 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2137 Assume point is at the beginning of the paragraph."
2146 limit
2147 ;; A matching `org-element-paragraph-separate' is not
2148 ;; necessarily the end of the paragraph. In
2149 ;; particular, lines starting with # or : as a first
2150 ;; non-space character are ambiguous. We have to
2151 ;; check if they are valid Org syntax (e.g., not an
2152 ;; incomplete keyword).
2156 ;; There's no ambiguity for other symbols or
2157 ;; empty lines: stop here.
2159 ;; Stop at valid fixed-width areas.
2161 ;; Stop at drawers.
2166 ;; Stop at valid comments.
2168 ;; Stop at valid dynamic blocks.
2173 ;; Stop at valid blocks.
2180 limit t)))
2181 ;; Stop at valid latex environments.
2189 limit t)))
2190 ;; Stop at valid keywords.
2192 ;; Skip everything else.
2209 :end end
2210 :contents-begin contents-begin
2211 :contents-end contents-end
2217 "Interpret PARAGRAPH element as Org syntax.
2218 CONTENTS is the contents of the element."
2219 contents)
2222 ;;;; Planning
2225 "Parse a planning.
2227 LIMIT bounds the search.
2229 Return a list whose CAR is `planning' and CDR is a plist
2230 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2231 and `:post-blank' keywords."
2241 closed deadline scheduled)
2253 :deadline deadline
2254 :scheduled scheduled
2255 :begin begin
2256 :end end
2260 "Interpret PLANNING element as Org syntax.
2261 CONTENTS is nil."
2263 'identity
2280 ;;;; Quote Section
2283 "Parse a quote section.
2285 LIMIT bounds the search.
2287 Return a list whose CAR is `quote-section' and CDR is a plist
2288 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2290 Assume point is at beginning of the section."
2301 :end end
2302 :value value
2306 "Interpret QUOTE-SECTION element as Org syntax.
2307 CONTENTS is nil."
2311 ;;;; Src Block
2314 "Parse a src block.
2316 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2317 the buffer position at the beginning of the first affiliated
2318 keyword and CDR is a plist of affiliated keywords along with
2319 their value.
2321 Return a list whose CAR is `src-block' and CDR is a plist
2322 containing `:language', `:switches', `:parameters', `:begin',
2323 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2324 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2325 `:post-blank' and `:post-affiliated' keywords.
2327 Assume point is at the beginning of the block."
2330 limit t)))
2331 ;; Incomplete block: parse it as a paragraph.
2337 ;; Get language as a string.
2346 ;; Get switches.
2348 ;; Get parameters.
2350 ;; Switches analysis
2362 ;; Should labels be retained in (or stripped from)
2363 ;; src blocks?
2368 ;; What should code-references use - labels or
2369 ;; line-numbers?
2374 ;; Indentation.
2376 ;; Get visibility status.
2378 ;; Retrieve code.
2387 ;; Get position after ending blank lines.
2397 :begin begin
2398 :end end
2399 :number-lines number-lines
2400 :preserve-indent preserve-indent
2401 :retain-labels retain-labels
2402 :use-labels use-labels
2403 :label-fmt label-fmt
2404 :hiddenp hidden
2405 :value value
2411 "Interpret SRC-BLOCK element as Org syntax.
2412 CONTENTS is nil."
2433 ;;;; Table
2436 "Parse a table at point.
2438 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2439 the buffer position at the beginning of the first affiliated
2440 keyword and CDR is a plist of affiliated keywords along with
2441 their value.
2443 Return a list whose CAR is `table' and CDR is a plist containing
2444 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2445 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2446 keywords.
2448 Assume point is at the beginning of the table."
2462 acc))
2469 :end end
2470 :type type
2471 :tblfm tblfm
2472 ;; Only `org' tables have contents. `table.el' tables
2473 ;; use a `:value' property to store raw table as
2474 ;; a string.
2479 table-begin table-end))
2485 "Interpret TABLE element as Org syntax.
2486 CONTENTS is a string, if table's type is `org', or nil."
2497 ;;;; Table Row
2500 "Parse table row at point.
2502 LIMIT bounds the search.
2504 Return a list whose CAR is `table-row' and CDR is a plist
2505 containing `:begin', `:end', `:contents-begin', `:contents-end',
2506 `:type' and `:post-blank' keywords."
2510 ;; A table rule has no contents. In that case, ensure
2511 ;; CONTENTS-BEGIN matches CONTENTS-END.
2523 :begin begin
2524 :end end
2525 :contents-begin contents-begin
2526 :contents-end contents-end
2530 "Interpret TABLE-ROW element as Org syntax.
2531 CONTENTS is the contents of the table row."
2536 ;;;; Verse Block
2539 "Parse a verse block.
2541 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2542 the buffer position at the beginning of the first affiliated
2543 keyword and CDR is a plist of affiliated keywords along with
2544 their value.
2546 Return a list whose CAR is `verse-block' and CDR is a plist
2547 containing `:begin', `:end', `:contents-begin', `:contents-end',
2548 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2550 Assume point is at beginning of the block."
2554 ;; Incomplete block: parse it as a paragraph.
2570 :end end
2571 :contents-begin contents-begin
2572 :contents-end contents-end
2573 :hiddenp hidden
2579 "Interpret VERSE-BLOCK element as Org syntax.
2580 CONTENTS is verse block contents."
2584 \f
2585 ;;; Objects
2586 ;;
2587 ;; Unlike to elements, interstices can be found between objects.
2588 ;; That's why, along with the parser, successor functions are provided
2589 ;; for each object. Some objects share the same successor (e.g.,
2590 ;; `code' and `verbatim' objects).
2591 ;;
2592 ;; A successor must accept a single argument bounding the search. It
2593 ;; will return either a cons cell whose CAR is the object's type, as
2594 ;; a symbol, and CDR the position of its next occurrence, or nil.
2595 ;;
2596 ;; Successors follow the naming convention:
2597 ;; org-element-NAME-successor, where NAME is the name of the
2598 ;; successor, as defined in `org-element-all-successors'.
2599 ;;
2600 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2601 ;; object types they can contain will be specified in
2602 ;; `org-element-object-restrictions'.
2603 ;;
2604 ;; Adding a new type of object is simple. Implement a successor,
2605 ;; a parser, and an interpreter for it, all following the naming
2606 ;; convention. Register type in `org-element-all-objects' and
2607 ;; successor in `org-element-all-successors'. Maybe tweak
2608 ;; restrictions about it, and that's it.
2611 ;;;; Bold
2614 "Parse bold object at point.
2616 Return a list whose CAR is `bold' and CDR is a plist with
2617 `:begin', `:end', `:contents-begin' and `:contents-end' and
2618 `:post-blank' keywords.
2620 Assume point is at the first star marker."
2632 :end end
2633 :contents-begin contents-begin
2634 :contents-end contents-end
2638 "Interpret BOLD object as Org syntax.
2639 CONTENTS is the contents of the object."
2643 "Search for the next text-markup object.
2645 Return value is a cons cell whose CAR is a symbol among `bold',
2646 `italic', `underline', `strike-through', `code' and `verbatim'
2647 and CDR is beginning position."
2663 ;;;; Code
2666 "Parse code object at point.
2668 Return a list whose CAR is `code' and CDR is a plist with
2669 `:value', `:begin', `:end' and `:post-blank' keywords.
2671 Assume point is at the first tilde marker."
2682 :begin begin
2683 :end end
2687 "Interpret CODE object as Org syntax.
2688 CONTENTS is nil."
2692 ;;;; Entity
2695 "Parse entity at point.
2697 Return a list whose CAR is `entity' and CDR a plist with
2698 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2699 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2700 keywords.
2702 Assume point is at the beginning of the entity."
2704 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2720 :begin begin
2721 :end end
2722 :use-brackets-p bracketsp
2726 "Interpret ENTITY object as Org syntax.
2727 CONTENTS is nil."
2733 "Search for the next latex-fragment or entity object.
2735 Return value is a cons cell whose CAR is `entity' or
2736 `latex-fragment' and CDR is beginning position."
2740 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2747 ;; Determine if it's a real entity or a LaTeX command.
2750 ;; No entity nor command: point is at a LaTeX fragment.
2751 ;; Determine its type to get the correct beginning position.
2760 ;;;; Export Snippet
2763 "Parse export snippet at point.
2765 Return a list whose CAR is `export-snippet' and CDR a plist with
2766 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2767 keywords.
2769 Assume point is at the beginning of the snippet."
2781 :value value
2782 :begin begin
2783 :end end
2787 "Interpret EXPORT-SNIPPET object as Org syntax.
2788 CONTENTS is nil."
2794 "Search for the next export-snippet object.
2796 Return value is a cons cell whose CAR is `export-snippet' and CDR
2797 its beginning position."
2806 ;;;; Footnote Reference
2809 "Parse footnote reference at point.
2811 Return a list whose CAR is `footnote-reference' and CDR a plist
2812 with `:label', `:type', `:inline-definition', `:begin', `:end'
2813 and `:post-blank' as keywords."
2835 :type type
2836 :begin begin
2837 :end end
2840 footnote-reference :inline-definition
2845 footnote-reference))))))
2848 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2849 CONTENTS is nil."
2859 "Search for the next footnote-reference object.
2861 Return value is a cons cell whose CAR is `footnote-reference' and
2862 CDR is beginning position."
2876 ;;;; Inline Babel Call
2879 "Parse inline babel call at point.
2881 Return a list whose CAR is `inline-babel-call' and CDR a plist
2882 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2884 Assume point is at the beginning of the babel call."
2895 :end end
2896 :info info
2900 "Interpret INLINE-BABEL-CALL object as Org syntax.
2901 CONTENTS is nil."
2907 ;; Remove redundant square brackets.
2910 main-source)
2914 "Search for the next inline-babel-call object.
2916 Return value is a cons cell whose CAR is `inline-babel-call' and
2917 CDR is beginning position."
2923 ;;;; Inline Src Block
2926 "Parse inline source block at point.
2928 Return a list whose CAR is `inline-src-block' and CDR a plist
2929 with `:begin', `:end', `:language', `:value', `:parameters' and
2930 `:post-blank' as keywords.
2932 Assume point is at the beginning of the inline src block."
2945 :value value
2946 :parameters parameters
2947 :begin begin
2948 :end end
2952 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2953 CONTENTS is nil."
2958 language
2960 body)))
2963 "Search for the next inline-babel-call element.
2965 Return value is a cons cell whose CAR is `inline-babel-call' and
2966 CDR is beginning position."
2972 ;;;; Italic
2975 "Parse italic object at point.
2977 Return a list whose CAR is `italic' and CDR is a plist with
2978 `:begin', `:end', `:contents-begin' and `:contents-end' and
2979 `:post-blank' keywords.
2981 Assume point is at the first slash marker."
2993 :end end
2994 :contents-begin contents-begin
2995 :contents-end contents-end
2999 "Interpret ITALIC object as Org syntax.
3000 CONTENTS is the contents of the object."
3004 ;;;; Latex Fragment
3007 "Parse LaTeX fragment at point.
3009 Return a list whose CAR is `latex-fragment' and CDR a plist with
3010 `:value', `:begin', `:end', and `:post-blank' as keywords.
3012 Assume point is at the beginning of the LaTeX fragment."
3025 ;; None found: it's a macro.
3034 :begin begin
3035 :end end
3039 "Interpret LATEX-FRAGMENT object as Org syntax.
3040 CONTENTS is nil."
3043 ;;;; Line Break
3046 "Parse line break at point.
3048 Return a list whose CAR is `line-break', and CDR a plist with
3049 `:begin', `:end' and `:post-blank' keywords.
3051 Assume point is at the beginning of the line break."
3058 "Interpret LINE-BREAK object as Org syntax.
3059 CONTENTS is nil."
3063 "Search for the next line-break object.
3065 Return value is a cons cell whose CAR is `line-break' and CDR is
3066 beginning position."
3070 ;; A line break can only happen on a non-empty line.
3075 ;;;; Link
3078 "Parse link at point.
3080 Return a list whose CAR is `link' and CDR a plist with `:type',
3081 `:path', `:raw-link', `:application', `:search-option', `:begin',
3082 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3083 keywords.
3085 Assume point is at the beginning of the link."
3088 end contents-begin contents-end link-end post-blank path type
3089 raw-link link search-option application)
3091 ;; 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 ;; According to RFC 3986, extra whitespace should be
3118 ;; ignored when a URI is extracted.
3121 ;; Id type: PATH is the id.
3124 ;; Code-ref type: PATH is the name of the reference.
3127 ;; Custom-id type: PATH is the name of the custom id.
3130 ;; Fuzzy type: Internal link either matches a target, an
3131 ;; headline name or nothing. PATH is the target or
3132 ;; headline's name.
3134 ;; Type 3: Plain link, e.g., http://orgmode.org
3140 ;; Type 4: Angular link, e.g., <http://orgmode.org>
3147 ;; In any case, deduce end point after trailing white space from
3148 ;; LINK-END variable.
3151 ;; Special "file" type link processing.
3153 ;; Extract opening application and search option.
3161 ;; Normalize URI.
3165 ;; Make sure TYPE always reports "file".
3169 :path path
3171 :application application
3172 :search-option search-option
3173 :begin begin
3174 :end end
3175 :contents-begin contents-begin
3176 :contents-end contents-end
3180 "Interpret LINK object as Org syntax.
3181 CONTENTS is the contents of the object, or nil."
3186 raw-link
3190 "Search for the next link object.
3192 Return value is a cons cell whose CAR is `link' and CDR is
3193 beginning position."
3202 "Search for the next plain link object.
3204 Return value is a cons cell whose CAR is `link' and CDR is
3205 beginning position."
3210 ;;;; Macro
3213 "Parse macro at point.
3215 Return a list whose CAR is `macro' and CDR a plist with `:key',
3216 `:args', `:begin', `:end', `:value' and `:post-blank' as
3217 keywords.
3219 Assume point is at the macro."
3230 ;; Do not use `org-split-string' since empty
3231 ;; strings are meaningful here.
3239 args nil t)
3243 :value value
3244 :args args
3245 :begin begin
3246 :end end
3250 "Interpret MACRO object as Org syntax.
3251 CONTENTS is nil."
3255 "Search for the next macro object.
3257 Return value is cons cell whose CAR is `macro' and CDR is
3258 beginning position."
3262 nil t)
3266 ;;;; Radio-target
3269 "Parse radio target at point.
3271 Return a list whose CAR is `radio-target' and CDR a plist with
3272 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3273 and `:post-blank' as keywords.
3275 Assume point is at the radio target."
3287 :end end
3288 :contents-begin contents-begin
3289 :contents-end contents-end
3290 :post-blank post-blank
3294 "Interpret TARGET object as Org syntax.
3295 CONTENTS is the contents of the object."
3299 "Search for the next radio-target object.
3301 Return value is a cons cell whose CAR is `radio-target' and CDR
3302 is beginning position."
3308 ;;;; Statistics Cookie
3311 "Parse statistics cookie at point.
3313 Return a list whose CAR is `statistics-cookie', and CDR a plist
3314 with `:begin', `:end', `:value' and `:post-blank' keywords.
3316 Assume point is at the beginning of the statistics-cookie."
3327 :end end
3328 :value value
3332 "Interpret STATISTICS-COOKIE object as Org syntax.
3333 CONTENTS is nil."
3337 "Search for the next statistics cookie object.
3339 Return value is a cons cell whose CAR is `statistics-cookie' and
3340 CDR is beginning position."
3346 ;;;; Strike-Through
3349 "Parse strike-through object at point.
3351 Return a list whose CAR is `strike-through' and CDR is a plist
3352 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3353 `:post-blank' keywords.
3355 Assume point is at the first plus sign marker."
3367 :end end
3368 :contents-begin contents-begin
3369 :contents-end contents-end
3373 "Interpret STRIKE-THROUGH object as Org syntax.
3374 CONTENTS is the contents of the object."
3378 ;;;; Subscript
3381 "Parse subscript at point.
3383 Return a list whose CAR is `subscript' and CDR a plist with
3384 `:begin', `:end', `:contents-begin', `:contents-end',
3385 `:use-brackets-p' and `:post-blank' as keywords.
3387 Assume point is at the underscore."
3391 t
3402 :end end
3403 :use-brackets-p bracketsp
3404 :contents-begin contents-begin
3405 :contents-end contents-end
3409 "Interpret SUBSCRIPT object as Org syntax.
3410 CONTENTS is the contents of the object."
3413 contents))
3416 "Search for the next sub/superscript object.
3418 Return value is a cons cell whose CAR is either `subscript' or
3419 `superscript' and CDR is beginning position."
3427 ;;;; Superscript
3430 "Parse superscript at point.
3432 Return a list whose CAR is `superscript' and CDR a plist with
3433 `:begin', `:end', `:contents-begin', `:contents-end',
3434 `:use-brackets-p' and `:post-blank' as keywords.
3436 Assume point is at the caret."
3450 :end end
3451 :use-brackets-p bracketsp
3452 :contents-begin contents-begin
3453 :contents-end contents-end
3457 "Interpret SUPERSCRIPT object as Org syntax.
3458 CONTENTS is the contents of the object."
3461 contents))
3464 ;;;; Table Cell
3467 "Parse table cell at point.
3469 Return a list whose CAR is `table-cell' and CDR is a plist
3470 containing `:begin', `:end', `:contents-begin', `:contents-end'
3471 and `:post-blank' keywords."
3479 :end end
3480 :contents-begin contents-begin
3481 :contents-end contents-end
3485 "Interpret TABLE-CELL element as Org syntax.
3486 CONTENTS is the contents of the cell, or nil."
3490 "Search for the next table-cell object.
3492 Return value is a cons cell whose CAR is `table-cell' and CDR is
3493 beginning position."
3497 ;;;; Target
3500 "Parse target at point.
3502 Return a list whose CAR is `target' and CDR a plist with
3503 `:begin', `:end', `:value' and `:post-blank' as keywords.
3505 Assume point is at the target."
3515 :end end
3516 :value value
3520 "Interpret TARGET object as Org syntax.
3521 CONTENTS is nil."
3525 "Search for the next target object.
3527 Return value is a cons cell whose CAR is `target' and CDR is
3528 beginning position."
3534 ;;;; Timestamp
3537 "Parse time stamp at point.
3539 Return a list whose CAR is `timestamp', and CDR a plist with
3540 `:type', `:raw-value', `:year-start', `:month-start',
3541 `:day-start', `:hour-start', `:minute-start', `:year-end',
3542 `:month-end', `:day-end', `:hour-end', `:minute-end',
3543 `:repeater-type', `:repeater-value', `:repeater-unit',
3544 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3545 `:end' and `:post-blank' keywords.
3547 Assume point is at the beginning of the timestamp."
3565 date-start)
3576 raw-value)
3578 :repeater-type
3584 :repeater-unit
3593 :warning-unit
3596 year-start month-start day-start hour-start minute-start year-end
3597 month-end day-end hour-end minute-end)
3598 ;; Parse date-start.
3606 ;; Compute date-end. It can be provided directly in time-stamp,
3607 ;; or extracted from time range. Otherwise, it defaults to the
3608 ;; same values as date-start.
3618 :raw-value raw-value
3619 :year-start year-start
3620 :month-start month-start
3621 :day-start day-start
3622 :hour-start hour-start
3623 :minute-start minute-start
3624 :year-end year-end
3625 :month-end month-end
3626 :day-end day-end
3627 :hour-end hour-end
3628 :minute-end minute-end
3629 :begin begin
3630 :end end
3632 repeater-props
3633 warning-props)))))
3636 "Interpret TIMESTAMP object as Org syntax.
3637 CONTENTS is nil."
3638 ;; Use `:raw-value' if specified.
3640 ;; Otherwise, build timestamp string.
3659 ;; Build an Org timestamp string from TIME. ACTIVEP is
3660 ;; non-nil when time stamp is active. If WITH-TIME-P is
3661 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3662 ;; specify a time range in the timestamp. REPEAT-STRING
3663 ;; is the repeater string, if any.
3667 org-time-stamp-formats)
3668 time)))
3674 nil nil ts)))
3679 " "
3680 s
3682 ;; Return value.
3683 ts)))
3695 build-ts-string
3714 0
3722 "--"
3734 "Search for the next timestamp object.
3736 Return value is a cons cell whose CAR is `timestamp' and CDR is
3737 beginning position."
3745 nil t)
3749 ;;;; Underline
3752 "Parse underline object at point.
3754 Return a list whose CAR is `underline' and CDR is a plist with
3755 `:begin', `:end', `:contents-begin' and `:contents-end' and
3756 `:post-blank' keywords.
3758 Assume point is at the first underscore marker."
3770 :end end
3771 :contents-begin contents-begin
3772 :contents-end contents-end
3776 "Interpret UNDERLINE object as Org syntax.
3777 CONTENTS is the contents of the object."
3781 ;;;; Verbatim
3784 "Parse verbatim object at point.
3786 Return a list whose CAR is `verbatim' and CDR is a plist with
3787 `:value', `:begin', `:end' and `:post-blank' keywords.
3789 Assume point is at the first equal sign marker."
3800 :begin begin
3801 :end end
3805 "Interpret VERBATIM object as Org syntax.
3806 CONTENTS is nil."
3810 \f
3811 ;;; Parsing Element Starting At Point
3812 ;;
3813 ;; `org-element--current-element' is the core function of this section.
3814 ;; It returns the Lisp representation of the element starting at
3815 ;; point.
3816 ;;
3817 ;; `org-element--current-element' makes use of special modes. They
3818 ;; are activated for fixed element chaining (e.g., `plain-list' >
3819 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3820 ;; `section'). Special modes are: `first-section', `item',
3821 ;; `node-property', `quote-section', `section' and `table-row'.
3825 "Parse the element starting at point.
3827 Return value is a list like (TYPE PROPS) where TYPE is the type
3828 of the element and PROPS a plist of properties associated to the
3829 element.
3831 Possible types are defined in `org-element-all-elements'.
3833 LIMIT bounds the search.
3835 Optional argument GRANULARITY determines the depth of the
3836 recursion. Allowed values are `headline', `greater-element',
3837 `element', `object' or nil. When it is broader than `object' (or
3838 nil), secondary values will not be parsed, since they only
3839 contain objects.
3841 Optional argument SPECIAL, when non-nil, can be either
3842 `first-section', `item', `node-property', `quote-section',
3843 `section', and `table-row'.
3845 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3846 be computed.
3848 This function assumes point is always at the beginning of the
3849 element it has to parse."
3852 ;; Determine if parsing depth allows for secondary strings
3853 ;; parsing. It only applies to elements referenced in
3854 ;; `org-element-secondary-value-alist'.
3857 ;; Item.
3860 ;; Table Row.
3862 ;; Node Property.
3864 ;; Headline.
3867 ;; Sections (must be checked after headline).
3873 limit)))
3874 ;; When not at bol, point is at the beginning of an item or
3875 ;; a footnote definition: next item is always a paragraph.
3877 ;; Planning and Clock.
3882 ;; Inlinetask.
3885 ;; From there, elements can have affiliated keywords.
3888 ;; Jumping over affiliated keywords put point off-limits.
3889 ;; Parse them as regular keywords.
3893 ;; LaTeX Environment.
3896 ;; Drawer and Property Drawer.
3901 ;; Fixed Width
3904 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3905 ;; Keywords.
3914 org-element-block-name-alist)))
3929 ;; Footnote Definition.
3932 ;; Horizontal Rule.
3935 ;; Diary Sexp.
3938 ;; Table.
3940 ;; List.
3943 limit affiliated
3945 ;; Default element: Paragraph.
3949 ;; Most elements can have affiliated keywords. When looking for an
3950 ;; element beginning, we want to move before them, as they belong to
3951 ;; that element, and, in the meantime, collect information they give
3952 ;; into appropriate properties. Hence the following function.
3955 "Collect affiliated keywords from point down to LIMIT.
3957 Return a list whose CAR is the position at the first of them and
3958 CDR a plist of keywords and values and move point to the
3959 beginning of the first line after them.
3961 As a special case, if element doesn't start at the beginning of
3962 the line (e.g., a paragraph starting an item), CAR is current
3963 position of point and CDR is nil."
3967 ;; RESTRICT is the list of objects allowed in parsed
3968 ;; keywords value.
3970 output)
3973 ;; Apply translation to RAW-KWD. From there, KWD is
3974 ;; the official keyword.
3976 org-element-keyword-translation-alist))
3977 raw-kwd))
3978 ;; Find main value for any keyword.
3984 ;; PARSEDP is non-nil when keyword should have its
3985 ;; value parsed.
3987 ;; If KWD is a dual keyword, find its secondary
3988 ;; value. Maybe parse it.
3995 ;; Attribute a property name to KWD.
3997 ;; Now set final shape for VALUE.
4003 ;; Attributes can always appear on multiple lines.
4006 ;; Eventually store the new value in OUTPUT.
4008 ;; Move to next keyword.
4010 ;; If affiliated keywords are orphaned: move back to first one.
4011 ;; They will be parsed as a paragraph.
4013 ;; Return value.
4017 \f
4018 ;;; The Org Parser
4019 ;;
4020 ;; The two major functions here are `org-element-parse-buffer', which
4021 ;; parses Org syntax inside the current buffer, taking into account
4022 ;; region, narrowing, or even visibility if specified, and
4023 ;; `org-element-parse-secondary-string', which parses objects within
4024 ;; a given string.
4025 ;;
4026 ;; The (almost) almighty `org-element-map' allows applying a function
4027 ;; on elements or objects matching some type, and accumulating the
4028 ;; resulting values. In an export situation, it also skips unneeded
4029 ;; parts of the parse tree.
4032 "Recursively parse the buffer and return structure.
4033 If narrowing is in effect, only parse the visible part of the
4034 buffer.
4036 Optional argument GRANULARITY determines the depth of the
4037 recursion. It can be set to the following symbols:
4039 `headline' Only parse headlines.
4040 `greater-element' Don't recurse into greater elements excepted
4041 headlines and sections. Thus, elements
4042 parsed are the top-level ones.
4043 `element' Parse everything but objects and plain text.
4044 `object' Parse the complete buffer (default).
4046 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4047 elements.
4049 An element or an objects is represented as a list with the
4050 pattern (TYPE PROPERTIES CONTENTS), where :
4052 TYPE is a symbol describing the element or object. See
4053 `org-element-all-elements' and `org-element-all-objects' for an
4054 exhaustive list of such symbols. One can retrieve it with
4055 `org-element-type' function.
4057 PROPERTIES is the list of attributes attached to the element or
4058 object, as a plist. Although most of them are specific to the
4059 element or object type, all types share `:begin', `:end',
4060 `:post-blank' and `:parent' properties, which respectively
4061 refer to buffer position where the element or object starts,
4062 ends, the number of white spaces or blank lines after it, and
4063 the element or object containing it. Properties values can be
4064 obtained by using `org-element-property' function.
4066 CONTENTS is a list of elements, objects or raw strings
4067 contained in the current element or object, when applicable.
4068 One can access them with `org-element-contents' function.
4070 The Org buffer has `org-data' as type and nil as properties.
4071 `org-element-map' function can be used to find specific elements
4072 or objects within the parse tree.
4074 This function assumes that current major mode is `org-mode'."
4080 ;; Start in `first-section' mode so text before the first
4081 ;; headline belongs to a section.
4085 "Recursively parse objects in STRING and return structure.
4087 RESTRICTION is a symbol limiting the object types that will be
4088 looked after.
4090 Optional argument PARENT, when non-nil, is the element or object
4091 containing the secondary string. It is used to set correctly
4092 `:parent' property within the string."
4105 secondary))))
4109 "Map a function on selected elements or objects.
4111 DATA is a parse tree, an element, an object, a string, or a list
4112 of such constructs. TYPES is a symbol or list of symbols of
4113 elements or objects types (see `org-element-all-elements' and
4114 `org-element-all-objects' for a complete list of types). FUN is
4115 the function called on the matching element or object. It has to
4116 accept one argument: the element or object itself.
4118 When optional argument INFO is non-nil, it should be a plist
4119 holding export options. In that case, parts of the parse tree
4120 not exportable according to that property list will be skipped.
4122 When optional argument FIRST-MATCH is non-nil, stop at the first
4123 match for which FUN doesn't return nil, and return that value.
4125 Optional argument NO-RECURSION is a symbol or a list of symbols
4126 representing elements or objects types. `org-element-map' won't
4127 enter any recursive element or object whose type belongs to that
4128 list. Though, FUN can still be applied on them.
4130 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4131 apply to matching objects within parsed affiliated keywords (see
4132 `org-element-parsed-keywords').
4134 Nil values returned from FUN do not appear in the results.
4137 Examples:
4138 ---------
4140 Assuming TREE is a variable containing an Org buffer parse tree,
4141 the following example will return a flat list of all `src-block'
4142 and `example-block' elements in it:
4146 The following snippet will find the first headline with a level
4150 (lambda (hl)
4151 (and (= (org-element-property :level hl) 1)
4153 (org-element-property :begin hl)))
4154 nil t)
4156 The next example will return a flat list of all `plain-list' type
4157 elements in TREE that are not a sub-list themselves:
4161 Eventually, this example will return a flat list of all `bold'
4162 type objects containing a `latex-snippet' type object, even
4163 looking into captions:
4166 (lambda (b)
4168 nil nil nil t)"
4169 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4172 ;; Recursion depth is determined by --CATEGORY.
4179 ;; If one object is found, the function
4180 ;; has to recurse into every object.
4183 ;; If one regular element is found, the
4184 ;; function has to recurse, at least,
4185 ;; into every element it encounters.
4188 types)
4189 category)))
4190 ;; Compute properties for affiliated keywords if necessary.
4195 org-element-affiliated-keywords)))
4196 --acc
4197 --walk-tree
4201 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4202 ;; holding contextual information.
4206 ;; Ignored element in an export context.
4208 ;; List of elements or objects.
4210 ;; Unconditionally enter parse trees.
4214 ;; Check if TYPE is matching among TYPES. If so,
4215 ;; apply FUN to --DATA and accumulate return value
4216 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4222 ;; If --DATA has a secondary string that can contain
4223 ;; objects with their type among TYPES, look into it.
4230 ;; If --DATA has any affiliated keywords and
4231 ;; WITH-AFFILIATED is non-nil, look for objects in
4232 ;; them.
4240 ;; Pay attention to the type of value.
4241 ;; Preserve order for multiple keywords.
4257 --affiliated-alist))
4258 ;; Determine if a recursion into --DATA is possible.
4260 ;; --TYPE is explicitly removed from recursion.
4262 ;; --DATA has no contents.
4264 ;; Looking for greater elements but --DATA is simply
4265 ;; an element or an object.
4268 ;; Looking for elements but --DATA is an object.
4271 ;; In any other case, map contents.
4275 ;; Return value in a proper order.
4279 ;; The following functions are internal parts of the parser.
4280 ;;
4281 ;; The first one, `org-element--parse-elements' acts at the element's
4282 ;; level.
4283 ;;
4284 ;; The second one, `org-element--parse-objects' applies on all objects
4285 ;; of a paragraph or a secondary string. It uses
4286 ;; `org-element--get-next-object-candidates' to optimize the search of
4287 ;; the next object in the buffer.
4288 ;;
4289 ;; More precisely, that function looks for every allowed object type
4290 ;; first. Then, it discards failed searches, keeps further matches,
4291 ;; and searches again types matched behind point, for subsequent
4292 ;; calls. Thus, searching for a given type fails only once, and every
4293 ;; object is searched only once at top level (but sometimes more for
4294 ;; nested types).
4298 "Parse elements between BEG and END positions.
4300 SPECIAL prioritize some elements over the others. It can be set
4301 to `first-section', `quote-section', `section' `item' or
4302 `table-row'.
4304 When value is `item', STRUCTURE will be used as the current list
4305 structure.
4307 GRANULARITY determines the depth of the recursion. See
4308 `org-element-parse-buffer' for more information.
4310 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4311 elements.
4313 Elements are accumulated into ACC."
4316 ;; Visible only: skip invisible parts at the beginning of the
4317 ;; element.
4320 ;; When parsing only headlines, skip any text before first one.
4323 ;; Main loop start.
4325 ;; Find current element's type and parse it accordingly to
4326 ;; its category.
4328 end granularity special structure))
4332 ;; Visible only: skip invisible parts between siblings.
4335 ;; Fill ELEMENT contents by side-effect.
4337 ;; If element has no contents, don't modify it.
4339 ;; Greater element: parse it between `contents-begin' and
4340 ;; `contents-end'. Make sure GRANULARITY allows the
4341 ;; recursion, or ELEMENT is a headline, in which case going
4342 ;; inside is mandatory, in order to get sub-level headings.
4350 ;; Possibly switch to a special mode.
4360 granularity visible-only element))
4361 ;; ELEMENT has contents. Parse objects inside, if
4362 ;; GRANULARITY allows it.
4368 ;; Return result.
4369 acc))
4372 "Parse objects between BEG and END and return recursive structure.
4374 Objects are accumulated in ACC.
4376 RESTRICTION is a list of object successors which are allowed in
4377 the current object."
4386 restriction candidates)))
4393 ;; 1. Text before any object. Untabify it.
4398 acc
4402 ;; 2. Object...
4405 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4406 ;; a recursive type.
4414 ;; 3. Text after last object. Untabify it.
4418 acc
4422 ;; Result.
4423 acc))))
4426 "Return an alist of candidates for the next object.
4428 RESTRICTION is a list of object types, as symbols. Only
4429 candidates with such types are looked after.
4431 OBJECTS is the previous candidates alist. If it is set to
4432 `initial', no search has been done before, and all symbols in
4433 RESTRICTION should be looked after.
4435 Return value is an alist whose CAR is the object type and CDR its
4436 beginning position."
4438 nil
4440 ;; When searching for the first time, look for every successor
4441 ;; allowed in RESTRICTION.
4445 restriction)
4446 ;; Focus on objects returned during last search. Keep those
4447 ;; still after point. Search again objects before it.
4453 type)))
4456 objects))))
4459 \f
4460 ;;; Towards A Bijective Process
4461 ;;
4462 ;; The parse tree obtained with `org-element-parse-buffer' is really
4463 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4464 ;; interpreted and expanded into a string with canonical Org syntax.
4465 ;; Hence `org-element-interpret-data'.
4466 ;;
4467 ;; The function relies internally on
4468 ;; `org-element--interpret-affiliated-keywords'.
4470 ;;;###autoload
4472 "Interpret DATA as Org syntax.
4474 DATA is a parse tree, an element, an object or a secondary string
4475 to interpret.
4477 Optional argument PARENT is used for recursive calls. It contains
4478 the element or object containing data, or nil.
4480 Return Org syntax as a string."
4484 ;; Secondary string.
4489 ;; Full Org document.
4494 ;; Plain text: return it.
4496 ;; Element/Object without contents.
4499 data nil))
4500 ;; Element/Object with contents.
4510 ;; Elements directly containing objects must
4511 ;; have their indentation normalized first.
4513 data
4514 ;; When normalizing first paragraph of an
4515 ;; item or a footnote-definition, ignore
4516 ;; first line's indentation.
4523 data
4525 contents)))))))
4527 ;; Build white spaces. If no `:post-blank' property is
4528 ;; specified, assume its value is 0.
4538 "Return ELEMENT's affiliated keywords as Org syntax.
4539 If there is no affiliated keyword, return the empty string."
4549 ": "
4552 value)
4560 ;; All attribute keywords can have multiple lines.
4566 ;; List all ELEMENT's properties matching an attribute line or an
4567 ;; affiliated keyword, but ignore translated keywords since they
4568 ;; cannot belong to the property list.
4575 org-element-keyword-translation-alist)))))
4576 collect prop)
4579 ;; Because interpretation of the parse tree must return the same
4580 ;; number of blank lines between elements and the same number of white
4581 ;; space after objects, some special care must be given to white
4582 ;; spaces.
4583 ;;
4584 ;; The first function, `org-element-normalize-string', ensures any
4585 ;; string different from the empty string will end with a single
4586 ;; newline character.
4587 ;;
4588 ;; The second function, `org-element-normalize-contents', removes
4589 ;; global indentation from the contents of the current element.
4592 "Ensure string S ends with a single newline character.
4594 If S isn't a string return it unchanged. If S is the empty
4595 string, return it. Otherwise, return a new string with a single
4596 newline character at its end."
4604 "Normalize plain text in ELEMENT's contents.
4606 ELEMENT must only contain plain text and objects.
4608 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4609 indentation to compute maximal common indentation.
4611 Return the normalized element that is element with global
4612 indentation removed from its contents. The function assumes that
4613 indentation is not done with TAB characters."
4615 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.
4640 ;; Find minimal indentation in ELEMENT.
4643 ;; Build ELEMENT back, replacing each string with the same
4644 ;; string minus common indentation.
4649 ;; Return BLOB with all its strings indentation
4650 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4651 ;; is non-nil when the first string hasn't been seen
4652 ;; yet.
4667 org-element-recursive-objects)
4671 blob))))
4675 \f
4676 ;;; The Toolbox
4677 ;;
4678 ;; The first move is to implement a way to obtain the smallest element
4679 ;; containing point. This is the job of `org-element-at-point'. It
4680 ;; basically jumps back to the beginning of section containing point
4681 ;; and moves, element after element, with
4682 ;; `org-element--current-element' until the container is found. Note:
4683 ;; When using `org-element-at-point', secondary values are never
4684 ;; parsed since the function focuses on elements, not on objects.
4685 ;;
4686 ;; At a deeper level, `org-element-context' lists all elements and
4687 ;; objects containing point.
4688 ;;
4689 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4690 ;; internally by navigation and manipulation tools.
4692 ;;;###autoload
4694 "Determine closest element around point.
4696 Return value is a list like (TYPE PROPS) where TYPE is the type
4697 of the element and PROPS a plist of properties associated to the
4698 element.
4700 Possible types are defined in `org-element-all-elements'.
4701 Properties depend on element or object type, but always include
4702 `:begin', `:end', `:parent' and `:post-blank' properties.
4704 As a special case, if point is at the very beginning of a list or
4705 sub-list, returned element will be that list instead of the first
4706 item. In the same way, if point is at the beginning of the first
4707 row of a table, returned element will be the table instead of the
4708 first row.
4710 If optional argument KEEP-TRAIL is non-nil, the function returns
4711 a list of elements leading to element at point. The list's CAR
4712 is always the element at point. The following positions contain
4713 element's siblings, then parents, siblings of parents, until the
4714 first element of current section."
4716 ;; If at a headline, parse it. It is the sole element that
4717 ;; doesn't require to know about context. Be sure to disallow
4718 ;; secondary string parsing, though.
4724 ;; Otherwise move at the beginning of the section containing
4725 ;; point.
4730 element type special-flag trail struct prevs parent)
4733 ;; In empty lines at buffer's beginning, return nil.
4742 ;; In blank lines just after the headline, point still
4743 ;; belongs to the headline.
4752 ;; Parse successively each element, skipping those ending
4753 ;; before original position.
4761 ;; 1. Skip any element ending before point. Also skip
4762 ;; element ending at point when we're sure that another
4763 ;; element has started.
4768 ;; 2. An element containing point is always the element at
4769 ;; point.
4772 ;; 3. At any other greater element type, if point is
4773 ;; within contents, move into it.
4778 ;; Create an anchor for tables and plain lists:
4779 ;; when point is at the very beginning of these
4780 ;; elements, ignoring affiliated keywords,
4781 ;; target them instead of their contents.
4783 ;; When point is at contents end, do not move
4784 ;; into elements with an explicit ending, but
4785 ;; return that element instead.
4789 drawer dynamic-block inlinetask
4790 property-drawer quote-block
4791 special-block))
4792 ;; Corner case: if a list ends at the
4793 ;; end of a buffer without a final new
4794 ;; line, return last element in last
4795 ;; item instead.
4813 ;;;###autoload
4815 "Return closest element or object around point.
4817 Return value is a list like (TYPE PROPS) where TYPE is the type
4818 of the element or object and PROPS a plist of properties
4819 associated to it.
4821 Possible types are defined in `org-element-all-elements' and
4822 `org-element-all-objects'. Properties depend on element or
4823 object type, but always include `:begin', `:end', `:parent' and
4824 `:post-blank'.
4826 Optional argument ELEMENT, when non-nil, is the closest element
4827 containing point, as returned by `org-element-at-point'.
4828 Providing it allows for quicker computation."
4834 context)
4835 ;; Check if point is inside an element containing objects or at
4836 ;; a secondary string. In that case, narrow buffer to the
4837 ;; containing area. Otherwise, return ELEMENT.
4839 ;; At a parsed affiliated keyword, check if we're inside main
4840 ;; or dual value.
4847 org-element-parsed-keywords))
4856 ;; Also change type to retrieve correct restrictions.
4858 ;; At an item, objects can only be located within tag, if any.
4868 ;; At an headline or inlinetask, objects are located within
4869 ;; their title.
4876 ;; At a paragraph, a table-row or a verse block, objects are
4877 ;; located within their contents.
4881 ;; CBEG is nil for table rules.
4885 ;; At a parsed keyword, objects are located within value.
4888 org-element-document-properties))
4895 ;; At a planning line, if point is at a timestamp, return it,
4896 ;; otherwise, return element.
4913 restriction candidates))
4915 candidates)))
4916 ;; If ORIGIN is before next object in element, there's
4917 ;; no point in looking further.
4927 ;; ORIGIN is after OBJECT, so skip it.
4929 ;; ORIGIN is within a non-recursive object or at
4930 ;; an object boundaries: Return that object.
4934 ;; Otherwise, move within current object and
4935 ;; restrict search to the end of its contents.
4942 parent))))))
4945 "Non-nil when elements ELEM-A and ELEM-B are nested."
4954 "Swap elements ELEM-A and ELEM-B.
4955 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4956 end of ELEM-A."
4958 ;; There are two special cases when an element doesn't start at bol:
4959 ;; the first paragraph in an item or in a footnote definition.
4961 ;; Only a paragraph without any affiliated keyword can be moved at
4962 ;; ELEM-A position in such a situation. Note that the case of
4963 ;; a footnote definition is impossible: it cannot contain two
4964 ;; paragraphs in a row because it cannot contain a blank line.
4970 ;; In a special situation, ELEM-A will have no indentation. We'll
4971 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4985 ;; Store overlays responsible for visibility status. We
4986 ;; also need to store their boundaries as they will be
4987 ;; removed from buffer.
4994 ;; Get contents.
5002 ;; Restore ex ELEM-A overlays.
5011 ;; Restore ex ELEM-B overlays.
5020 ;; Local variables:
5021 ;; generated-autoload-file: "org-loaddefs.el"
5022 ;; End:
5024 ;;; org-element.el ends here