| blob | 958971416f467227f3bd2b90f7d2862e56e81170 |
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 (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 "List of buffer-local variables used when parsing objects.
365 These variables are copied to the temporary buffer created by
369 \f
370 ;;; Accessors and Setters
371 ;;
372 ;; Provide four accessors: `org-element-type', `org-element-property'
373 ;; `org-element-contents' and `org-element-restriction'.
374 ;;
375 ;; Setter functions allow to modify elements by side effect. There is
376 ;; `org-element-put-property', `org-element-set-contents',
377 ;; `org-element-set-element' and `org-element-adopt-element'. Note
378 ;; that `org-element-set-element' and `org-element-adopt-elements' are
379 ;; higher level functions since also update `:parent' property.
382 "Return type of ELEMENT.
384 The function returns the type of the element or object provided.
385 It can also return the following special value:
386 `plain-text' for a string
387 `org-data' for a complete document
388 nil in any other case."
394 "Extract the value from the PROPERTY of an ELEMENT."
399 "Extract contents from an ELEMENT."
405 "Return restriction associated to ELEMENT.
406 ELEMENT can be an element, an object or a symbol representing an
407 element or object type."
409 org-element-object-restrictions)))
412 "In ELEMENT set PROPERTY to VALUE.
413 Return modified element."
416 element))
419 "Set ELEMENT contents to CONTENTS.
420 Return modified element."
427 "Replace element or object OLD with element or object NEW.
428 The function takes care of setting `:parent' property for NEW."
429 ;; Since OLD is going to be changed into NEW by side-effect, first
430 ;; make sure that every element or object within NEW has OLD as
431 ;; parent.
434 ;; Transfer contents.
436 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
437 ;; with NEW's.
440 ;; Transfer type.
444 "Append elements to the contents of another element.
446 PARENT is an element or object. CHILDREN can be elements,
447 objects, or a strings.
449 The function takes care of setting `:parent' property for CHILD.
450 Return parent element."
451 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
452 ;; string: parent is the list itself.
455 children)
456 ;; Add CHILDREN at the end of PARENT contents.
459 parent
461 ;; Return modified PARENT element.
465 \f
466 ;;; Greater elements
467 ;;
468 ;; For each greater element type, we define a parser and an
469 ;; interpreter.
470 ;;
471 ;; A parser returns the element or object as the list described above.
472 ;; Most of them accepts no argument. Though, exceptions exist. Hence
473 ;; every element containing a secondary string (see
474 ;; `org-element-secondary-value-alist') will accept an optional
475 ;; argument to toggle parsing of that secondary string. Moreover,
476 ;; `item' parser requires current list's structure as its first
477 ;; element.
478 ;;
479 ;; An interpreter accepts two arguments: the list representation of
480 ;; the element or object, and its contents. The latter may be nil,
481 ;; depending on the element or object considered. It returns the
482 ;; appropriate Org syntax, as a string.
483 ;;
484 ;; Parsing functions must follow the naming convention:
485 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
486 ;; defined in `org-element-greater-elements'.
487 ;;
488 ;; Similarly, interpreting functions must follow the naming
489 ;; convention: org-element-TYPE-interpreter.
490 ;;
491 ;; With the exception of `headline' and `item' types, greater elements
492 ;; cannot contain other greater elements of their own type.
493 ;;
494 ;; Beside implementing a parser and an interpreter, adding a new
495 ;; greater element requires to tweak `org-element--current-element'.
496 ;; Moreover, the newly defined type must be added to both
497 ;; `org-element-all-elements' and `org-element-greater-elements'.
500 ;;;; Center Block
503 "Parse a center block.
505 LIMIT bounds the search. AFFILIATED is a list of which CAR is
506 the buffer position at the beginning of the first affiliated
507 keyword and CDR is a plist of affiliated keywords along with
508 their value.
510 Return a list whose CAR is `center-block' and CDR is a plist
511 containing `:begin', `:end', `:hiddenp', `:contents-begin',
512 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
514 Assume point is at the beginning of the block."
518 ;; Incomplete block: parse it as a paragraph.
523 ;; Empty blocks have no contents.
538 :end end
539 :hiddenp hidden
540 :contents-begin contents-begin
541 :contents-end contents-end
547 "Interpret CENTER-BLOCK element as Org syntax.
548 CONTENTS is the contents of the element."
552 ;;;; Drawer
555 "Parse a drawer.
557 LIMIT bounds the search. AFFILIATED is a list of which CAR is
558 the buffer position at the beginning of the first affiliated
559 keyword and CDR is a plist of affiliated keywords along with
560 their value.
562 Return a list whose CAR is `drawer' and CDR is a plist containing
563 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
564 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
566 Assume point is at beginning of drawer."
569 ;; Incomplete drawer: parse it as a paragraph.
577 ;; Empty drawers have no contents.
591 :end end
592 :drawer-name name
593 :hiddenp hidden
594 :contents-begin contents-begin
595 :contents-end contents-end
601 "Interpret DRAWER element as Org syntax.
602 CONTENTS is the contents of the element."
605 contents))
608 ;;;; Dynamic Block
611 "Parse a dynamic block.
613 LIMIT bounds the search. AFFILIATED is a list of which CAR is
614 the buffer position at the beginning of the first affiliated
615 keyword and CDR is a plist of affiliated keywords along with
616 their value.
618 Return a list whose CAR is `dynamic-block' and CDR is a plist
619 containing `:block-name', `:begin', `:end', `:hiddenp',
620 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
621 and `:post-affiliated' keywords.
623 Assume point is at beginning of dynamic block."
627 ;; Incomplete block: parse it as a paragraph.
636 ;; Empty blocks have no contents.
650 :end end
651 :block-name name
652 :arguments arguments
653 :hiddenp hidden
654 :contents-begin contents-begin
655 :contents-end contents-end
661 "Interpret DYNAMIC-BLOCK element as Org syntax.
662 CONTENTS is the contents of the element."
667 contents))
670 ;;;; Footnote Definition
673 "Parse a footnote definition.
675 LIMIT bounds the search. AFFILIATED is a list of which CAR is
676 the buffer position at the beginning of the first affiliated
677 keyword and CDR is a plist of affiliated keywords along with
678 their value.
680 Return a list whose CAR is `footnote-definition' and CDR is
681 a plist containing `:label', `:begin' `:end', `:contents-begin',
682 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
684 Assume point is at the beginning of the footnote definition."
712 :begin begin
713 :end end
714 :contents-begin contents-begin
715 :contents-end contents-end
721 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
722 CONTENTS is the contents of the footnote-definition."
724 " "
725 contents))
728 ;;;; Headline
731 "Parse a headline.
733 Return a list whose CAR is `headline' and CDR is a plist
734 containing `:raw-value', `:title', `:alt-title', `:begin',
735 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
736 `:contents-end', `:level', `:priority', `:tags',
737 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
738 `:closed', `:quotedp', `:archivedp', `:commentedp' and
739 `:footnote-section-p' keywords.
741 The plist also contains any property set in the property drawer,
742 with its name in upper cases and colons added at the
743 beginning (e.g., `:CUSTOM_ID').
745 When RAW-SECONDARY-P is non-nil, headline's title will not be
746 parsed as a secondary string, but as a plain string instead.
748 Assume point is at beginning of the headline."
761 raw-value)))
765 raw-value)))
769 ;; Upcase property names. It avoids confusion between
770 ;; properties obtained through property drawer and default
771 ;; properties from the parser (e.g. `:end' and :END:)
781 plist))
783 ;; Read time properties on the line below the headline.
789 org-keyword-time-not-clock-regexp end t)
799 plist))))
812 ;; Clean RAW-VALUE from any quote or comment string.
820 ""
821 raw-value))))
822 ;; Clean TAGS from archive tag, if any.
828 :begin begin
829 :end end
830 :pre-blank
833 :hiddenp hidden
834 :contents-begin contents-begin
835 :contents-end contents-end
836 :level level
838 :tags tags
839 :todo-keyword todo
840 :todo-type todo-type
846 end)
847 :footnote-section-p footnote-section-p
848 :archivedp archivedp
849 :commentedp commentedp
851 time-props
852 standard-props))))
856 headline :alt-title
861 headline :title
867 "Interpret HEADLINE element as Org syntax.
868 CONTENTS is the contents of the element."
895 ;; Align tags.
903 ? )
904 tags))
908 tags))))
910 contents)))
913 ;;;; Inlinetask
916 "Parse an inline task.
918 Return a list whose CAR is `inlinetask' and CDR is a plist
919 containing `:title', `:begin', `:end', `:hiddenp',
920 `:contents-begin' and `:contents-end', `:level', `:priority',
921 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
922 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
924 The plist also contains any property set in the property drawer,
925 with its name in upper cases and colons added at the
926 beginning (e.g., `:CUSTOM_ID').
928 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
929 title will not be parsed as a secondary string, but as a plain
930 string instead.
932 Assume point is at beginning of the inline task."
942 ;; Upcase property names. It avoids confusion between
943 ;; properties obtained through property drawer and default
944 ;; properties from the parser (e.g. `:end' and :END:)
954 plist))
956 ;; Read time properties on the line below the inlinetask
957 ;; opening string.
963 org-keyword-time-not-clock-regexp end t)
973 plist))))
993 :begin begin
994 :end end
995 :hiddenp hidden
996 :contents-begin contents-begin
997 :contents-end contents-end
1000 :tags tags
1001 :todo-keyword todo
1002 :todo-type todo-type
1004 time-props
1005 standard-props))))
1007 inlinetask :title
1010 raw-value
1012 inlinetask))))))
1015 "Interpret INLINETASK element as Org syntax.
1016 CONTENTS is the contents of inlinetask."
1031 ;; Align tags.
1039 ? )
1040 tags))
1044 tags))))
1045 ;; Prefer degenerate inlinetasks when there are no
1046 ;; contents.
1049 contents
1053 ;;;; Item
1056 "Parse an item.
1058 STRUCT is the structure of the plain list.
1060 Return a list whose CAR is `item' and CDR is a plist containing
1061 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1062 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1063 `:post-blank' keywords.
1065 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1066 any, will not be parsed as a secondary string, but as a plain
1067 string instead.
1069 Assume point is at the beginning of the item."
1093 ;; Ignore tags in un-ordered lists: they are just
1094 ;; a part of item's body.
1100 ;; If first line isn't empty, contents really start
1101 ;; at the text after item's meta-data.
1112 :begin begin
1113 :end end
1114 ;; CONTENTS-BEGIN and CONTENTS-END may be
1115 ;; mixed up in the case of an empty item
1116 ;; separated from the next by a blank line.
1117 ;; Thus ensure the former is always the
1118 ;; smallest.
1121 :checkbox checkbox
1122 :counter counter
1123 :hiddenp hidden
1124 :structure struct
1127 item :tag
1135 "Interpret ITEM element as Org syntax.
1136 CONTENTS is the contents of the element."
1146 ;; Compute indentation.
1151 ;; Indent contents.
1153 bullet
1167 ;;;; Plain List
1170 ;; Return structure of list at point. Internal function. See
1171 ;; `org-list-struct' for details.
1179 items struct)
1184 ;; At limit: end all items.
1193 ;; At list end: end all items.
1198 ;; At a new item: end previous sibling.
1210 ind
1211 bullet
1214 ;; Description tag.
1218 ;; Ending position, unknown so far.
1219 nil)))
1220 items))
1222 ;; Skip empty lines.
1224 ;; Skip inline tasks and blank lines along the way.
1231 ;; At some text line. Check if it ends any previous item.
1243 ;; Skip blocks (any type) and drawers contents.
1249 limit t)))
1255 "Parse a plain list.
1257 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1258 the buffer position at the beginning of the first affiliated
1259 keyword and CDR is a plist of affiliated keywords along with
1260 their value. STRUCTURE is the structure of the plain list being
1261 parsed.
1263 Return a list whose CAR is `plain-list' and CDR is a plist
1264 containing `:type', `:begin', `:end', `:contents-begin' and
1265 `:contents-end', `:structure', `:post-blank' and
1266 `:post-affiliated' keywords.
1268 Assume point is at the beginning of the list."
1281 ;; Return value.
1285 :begin begin
1286 :end end
1287 :contents-begin contents-begin
1288 :contents-end contents-end
1289 :structure struct
1295 "Interpret PLAIN-LIST element as Org syntax.
1296 CONTENTS is the contents of the element."
1304 ;;;; Property Drawer
1307 "Parse a property drawer.
1309 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1310 the buffer position at the beginning of the first affiliated
1311 keyword and CDR is a plist of affiliated keywords along with
1312 their value.
1314 Return a list whose CAR is `property-drawer' and CDR is a plist
1315 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1316 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1318 Assume point is at the beginning of the property drawer."
1323 ;; Incomplete drawer: parse it as a paragraph.
1342 :end end
1343 :hiddenp hidden
1344 :contents-begin contents-begin
1345 :contents-end contents-end
1351 "Interpret PROPERTY-DRAWER element as Org syntax.
1352 CONTENTS is the properties within the drawer."
1356 ;;;; Quote Block
1359 "Parse a quote block.
1361 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1362 the buffer position at the beginning of the first affiliated
1363 keyword and CDR is a plist of affiliated keywords along with
1364 their value.
1366 Return a list whose CAR is `quote-block' and CDR is a plist
1367 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1368 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1370 Assume point is at the beginning of the block."
1374 ;; Incomplete block: parse it as a paragraph.
1380 ;; Empty blocks have no contents.
1394 :end end
1395 :hiddenp hidden
1396 :contents-begin contents-begin
1397 :contents-end contents-end
1403 "Interpret QUOTE-BLOCK element as Org syntax.
1404 CONTENTS is the contents of the element."
1408 ;;;; Section
1411 "Parse a section.
1413 LIMIT bounds the search.
1415 Return a list whose CAR is `section' and CDR is a plist
1416 containing `:begin', `:end', `:contents-begin', `contents-end'
1417 and `:post-blank' keywords."
1419 ;; Beginning of section is the beginning of the first non-blank
1420 ;; line after previous headline.
1429 :end end
1430 :contents-begin begin
1431 :contents-end pos-before-blank
1435 "Interpret SECTION element as Org syntax.
1436 CONTENTS is the contents of the element."
1437 contents)
1440 ;;;; Special Block
1443 "Parse a special block.
1445 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1446 the buffer position at the beginning of the first affiliated
1447 keyword and CDR is a plist of affiliated keywords along with
1448 their value.
1450 Return a list whose CAR is `special-block' and CDR is a plist
1451 containing `:type', `:begin', `:end', `:hiddenp',
1452 `:contents-begin', `:contents-end', `:post-blank' and
1453 `:post-affiliated' keywords.
1455 Assume point is at the beginning of the block."
1462 limit t)))
1463 ;; Incomplete block: parse it as a paragraph.
1469 ;; Empty blocks have no contents.
1483 :begin begin
1484 :end end
1485 :hiddenp hidden
1486 :contents-begin contents-begin
1487 :contents-end contents-end
1493 "Interpret SPECIAL-BLOCK element as Org syntax.
1494 CONTENTS is the contents of the element."
1499 \f
1500 ;;; Elements
1501 ;;
1502 ;; For each element, a parser and an interpreter are also defined.
1503 ;; Both follow the same naming convention used for greater elements.
1504 ;;
1505 ;; Also, as for greater elements, adding a new element type is done
1506 ;; through the following steps: implement a parser and an interpreter,
1507 ;; tweak `org-element--current-element' so that it recognizes the new
1508 ;; type and add that new type to `org-element-all-elements'.
1509 ;;
1510 ;; As a special case, when the newly defined type is a block type,
1511 ;; `org-element-block-name-alist' has to be modified accordingly.
1514 ;;;; Babel Call
1517 "Parse a babel call.
1519 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1520 the buffer position at the beginning of the first affiliated
1521 keyword and CDR is a plist of affiliated keywords along with
1522 their value.
1524 Return a list whose CAR is `babel-call' and CDR is a plist
1525 containing `:begin', `:end', `:info', `:post-blank' and
1526 `:post-affiliated' as keywords."
1539 :end end
1540 :info info
1546 "Interpret BABEL-CALL element as Org syntax.
1547 CONTENTS is nil."
1553 ;; Remove redundant square brackets.
1558 ;;;; Clock
1561 "Parse a clock.
1563 LIMIT bounds the search.
1565 Return a list whose CAR is `clock' and CDR is a plist containing
1566 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1567 as keywords."
1587 :value value
1588 :duration duration
1589 :begin begin
1590 :end end
1594 "Interpret CLOCK element as Org syntax.
1595 CONTENTS is nil."
1603 "%2s:%02s"
1607 ;;;; Comment
1610 "Parse a comment.
1612 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1613 the buffer position at the beginning of the first affiliated
1614 keyword and CDR is a plist of affiliated keywords along with
1615 their value.
1617 Return a list whose CAR is `comment' and CDR is a plist
1618 containing `:begin', `:end', `:value', `:post-blank',
1619 `:post-affiliated' keywords.
1621 Assume point is at comment beginning."
1630 ;; Get comments ending.
1633 ;; Accumulate lines without leading hash and first
1634 ;; whitespace.
1648 :end end
1649 :value value
1655 "Interpret COMMENT element as Org syntax.
1656 CONTENTS is nil."
1660 ;;;; Comment Block
1663 "Parse an export block.
1665 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1666 the buffer position at the beginning of the first affiliated
1667 keyword and CDR is a plist of affiliated keywords along with
1668 their value.
1670 Return a list whose CAR is `comment-block' and CDR is a plist
1671 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1672 and `:post-affiliated' keywords.
1674 Assume point is at comment block beginning."
1678 ;; Incomplete block: parse it as a paragraph.
1692 contents-begin contents-end)))
1696 :end end
1697 :value value
1698 :hiddenp hidden
1704 "Interpret COMMENT-BLOCK element as Org syntax.
1705 CONTENTS is nil."
1710 ;;;; Diary Sexp
1713 "Parse a diary sexp.
1715 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1716 the buffer position at the beginning of the first affiliated
1717 keyword and CDR is a plist of affiliated keywords along with
1718 their value.
1720 Return a list whose CAR is `diary-sexp' and CDR is a plist
1721 containing `:begin', `:end', `:value', `:post-blank' and
1722 `:post-affiliated' keywords."
1734 :begin begin
1735 :end end
1741 "Interpret DIARY-SEXP as Org syntax.
1742 CONTENTS is nil."
1746 ;;;; Example Block
1749 "Remove maximum common indentation in string S and return it.
1750 When optional argument N is a positive integer, remove exactly
1751 that much characters from indentation, if possible, or return
1752 S as-is otherwise. Unlike to `org-remove-indentation', this
1753 function doesn't call `untabify' on S."
1758 ;; Find maximum common indentation, if not specified.
1766 min-ind)))
1768 ;; Remove exactly N indentation, but give up if not possible.
1778 "Parse an example block.
1780 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1781 the buffer position at the beginning of the first affiliated
1782 keyword and CDR is a plist of affiliated keywords along with
1783 their value.
1785 Return a list whose CAR is `example-block' and CDR is a plist
1786 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1787 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1788 `:switches', `:value', `:post-blank' and `:post-affiliated'
1789 keywords."
1793 ;; Incomplete block: parse it as a paragraph.
1801 ;; Switches analysis
1809 ;; Should labels be retained in (or stripped from) example
1810 ;; blocks?
1815 ;; What should code-references use - labels or
1816 ;; line-numbers?
1825 ;; Standard block parsing.
1834 contents-begin contents-end))
1844 :end end
1845 :value value
1846 :switches switches
1847 :number-lines number-lines
1848 :preserve-indent preserve-indent
1849 :retain-labels retain-labels
1850 :use-labels use-labels
1851 :label-fmt label-fmt
1852 :hiddenp hidden
1858 "Interpret EXAMPLE-BLOCK element as Org syntax.
1859 CONTENTS is nil."
1867 ;;;; Export Block
1870 "Parse an export block.
1872 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1873 the buffer position at the beginning of the first affiliated
1874 keyword and CDR is a plist of affiliated keywords along with
1875 their value.
1877 Return a list whose CAR is `export-block' and CDR is a plist
1878 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1879 `:post-blank' and `:post-affiliated' keywords.
1881 Assume point is at export-block beginning."
1888 ;; Incomplete block: parse it as a paragraph.
1902 contents-end)))
1906 :end end
1907 :type type
1908 :value value
1909 :hiddenp hidden
1915 "Interpret EXPORT-BLOCK element as Org syntax.
1916 CONTENTS is nil."
1923 ;;;; Fixed-width
1926 "Parse a fixed-width section.
1928 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1929 the buffer position at the beginning of the first affiliated
1930 keyword and CDR is a plist of affiliated keywords along with
1931 their value.
1933 Return a list whose CAR is `fixed-width' and CDR is a plist
1934 containing `:begin', `:end', `:value', `:post-blank' and
1935 `:post-affiliated' keywords.
1937 Assume point is at the beginning of the fixed-width area."
1941 value
1946 ;; Accumulate text without starting colons.
1959 :end end
1960 :value value
1966 "Interpret FIXED-WIDTH element as Org syntax.
1967 CONTENTS is nil."
1975 ;;;; Horizontal Rule
1978 "Parse an horizontal rule.
1980 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1981 the buffer position at the beginning of the first affiliated
1982 keyword and CDR is a plist of affiliated keywords along with
1983 their value.
1985 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1986 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1987 keywords."
1997 :end end
2003 "Interpret HORIZONTAL-RULE element as Org syntax.
2004 CONTENTS is nil."
2008 ;;;; Keyword
2011 "Parse a keyword at point.
2013 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2014 the buffer position at the beginning of the first affiliated
2015 keyword and CDR is a plist of affiliated keywords along with
2016 their value.
2018 Return a list whose CAR is `keyword' and CDR is a plist
2019 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2020 `:post-affiliated' keywords."
2034 :value value
2035 :begin begin
2036 :end end
2042 "Interpret KEYWORD element as Org syntax.
2043 CONTENTS is nil."
2049 ;;;; Latex Environment
2052 "Parse a LaTeX environment.
2054 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2055 the buffer position at the beginning of the first affiliated
2056 keyword and CDR is a plist of affiliated keywords along with
2057 their value.
2059 Return a list whose CAR is `latex-environment' and CDR is a plist
2060 containing `:begin', `:end', `:value', `:post-blank' and
2061 `:post-affiliated' keywords.
2063 Assume point is at the beginning of the latex environment."
2070 limit t))
2071 ;; Incomplete latex environment: parse it as a paragraph.
2081 :end end
2082 :value value
2088 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2089 CONTENTS is nil."
2093 ;;;; Node Property
2096 "Parse a node-property at point.
2098 LIMIT bounds the search.
2100 Return a list whose CAR is `node-property' and CDR is a plist
2101 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2102 keywords."
2114 :value value
2115 :begin begin
2116 :end end
2120 "Interpret NODE-PROPERTY element as Org syntax.
2121 CONTENTS is nil."
2127 ;;;; Paragraph
2130 "Parse a paragraph.
2132 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2133 the buffer position at the beginning of the first affiliated
2134 keyword and CDR is a plist of affiliated keywords along with
2135 their value.
2137 Return a list whose CAR is `paragraph' and CDR is a plist
2138 containing `:begin', `:end', `:contents-begin' and
2139 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2141 Assume point is at the beginning of the paragraph."
2150 limit
2151 ;; A matching `org-element-paragraph-separate' is not
2152 ;; necessarily the end of the paragraph. In
2153 ;; particular, lines starting with # or : as a first
2154 ;; non-space character are ambiguous. We have to
2155 ;; check if they are valid Org syntax (e.g., not an
2156 ;; incomplete keyword).
2160 ;; There's no ambiguity for other symbols or
2161 ;; empty lines: stop here.
2163 ;; Stop at valid fixed-width areas.
2165 ;; Stop at drawers.
2170 ;; Stop at valid comments.
2172 ;; Stop at valid dynamic blocks.
2177 ;; Stop at valid blocks.
2184 limit t)))
2185 ;; Stop at valid latex environments.
2193 limit t)))
2194 ;; Stop at valid keywords.
2196 ;; Skip everything else.
2213 :end end
2214 :contents-begin contents-begin
2215 :contents-end contents-end
2221 "Interpret PARAGRAPH element as Org syntax.
2222 CONTENTS is the contents of the element."
2223 contents)
2226 ;;;; Planning
2229 "Parse a planning.
2231 LIMIT bounds the search.
2233 Return a list whose CAR is `planning' and CDR is a plist
2234 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2235 and `:post-blank' keywords."
2245 closed deadline scheduled)
2257 :deadline deadline
2258 :scheduled scheduled
2259 :begin begin
2260 :end end
2264 "Interpret PLANNING element as Org syntax.
2265 CONTENTS is nil."
2267 'identity
2284 ;;;; Quote Section
2287 "Parse a quote section.
2289 LIMIT bounds the search.
2291 Return a list whose CAR is `quote-section' and CDR is a plist
2292 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2294 Assume point is at beginning of the section."
2305 :end end
2306 :value value
2310 "Interpret QUOTE-SECTION element as Org syntax.
2311 CONTENTS is nil."
2315 ;;;; Src Block
2318 "Parse a src block.
2320 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2321 the buffer position at the beginning of the first affiliated
2322 keyword and CDR is a plist of affiliated keywords along with
2323 their value.
2325 Return a list whose CAR is `src-block' and CDR is a plist
2326 containing `:language', `:switches', `:parameters', `:begin',
2327 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2328 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2329 `:post-blank' and `:post-affiliated' keywords.
2331 Assume point is at the beginning of the block."
2334 limit t)))
2335 ;; Incomplete block: parse it as a paragraph.
2341 ;; Get language as a string.
2350 ;; Get switches.
2352 ;; Get parameters.
2354 ;; Switches analysis
2366 ;; Should labels be retained in (or stripped from)
2367 ;; src blocks?
2372 ;; What should code-references use - labels or
2373 ;; line-numbers?
2378 ;; Indentation.
2380 ;; Get visibility status.
2382 ;; Retrieve code.
2391 ;; Get position after ending blank lines.
2401 :begin begin
2402 :end end
2403 :number-lines number-lines
2404 :preserve-indent preserve-indent
2405 :retain-labels retain-labels
2406 :use-labels use-labels
2407 :label-fmt label-fmt
2408 :hiddenp hidden
2409 :value value
2415 "Interpret SRC-BLOCK element as Org syntax.
2416 CONTENTS is nil."
2437 ;;;; Table
2440 "Parse a table at point.
2442 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2443 the buffer position at the beginning of the first affiliated
2444 keyword and CDR is a plist of affiliated keywords along with
2445 their value.
2447 Return a list whose CAR is `table' and CDR is a plist containing
2448 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2449 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2450 keywords.
2452 Assume point is at the beginning of the table."
2466 acc))
2473 :end end
2474 :type type
2475 :tblfm tblfm
2476 ;; Only `org' tables have contents. `table.el' tables
2477 ;; use a `:value' property to store raw table as
2478 ;; a string.
2483 table-begin table-end))
2489 "Interpret TABLE element as Org syntax.
2490 CONTENTS is nil."
2501 ;;;; Table Row
2504 "Parse table row at point.
2506 LIMIT bounds the search.
2508 Return a list whose CAR is `table-row' and CDR is a plist
2509 containing `:begin', `:end', `:contents-begin', `:contents-end',
2510 `:type' and `:post-blank' keywords."
2514 ;; A table rule has no contents. In that case, ensure
2515 ;; CONTENTS-BEGIN matches CONTENTS-END.
2527 :begin begin
2528 :end end
2529 :contents-begin contents-begin
2530 :contents-end contents-end
2534 "Interpret TABLE-ROW element as Org syntax.
2535 CONTENTS is the contents of the table row."
2540 ;;;; Verse Block
2543 "Parse a verse block.
2545 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2546 the buffer position at the beginning of the first affiliated
2547 keyword and CDR is a plist of affiliated keywords along with
2548 their value.
2550 Return a list whose CAR is `verse-block' and CDR is a plist
2551 containing `:begin', `:end', `:contents-begin', `:contents-end',
2552 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2554 Assume point is at beginning of the block."
2558 ;; Incomplete block: parse it as a paragraph.
2574 :end end
2575 :contents-begin contents-begin
2576 :contents-end contents-end
2577 :hiddenp hidden
2583 "Interpret VERSE-BLOCK element as Org syntax.
2584 CONTENTS is verse block contents."
2588 \f
2589 ;;; Objects
2590 ;;
2591 ;; Unlike to elements, interstices can be found between objects.
2592 ;; That's why, along with the parser, successor functions are provided
2593 ;; for each object. Some objects share the same successor (e.g.,
2594 ;; `code' and `verbatim' objects).
2595 ;;
2596 ;; A successor must accept a single argument bounding the search. It
2597 ;; will return either a cons cell whose CAR is the object's type, as
2598 ;; a symbol, and CDR the position of its next occurrence, or nil.
2599 ;;
2600 ;; Successors follow the naming convention:
2601 ;; org-element-NAME-successor, where NAME is the name of the
2602 ;; successor, as defined in `org-element-all-successors'.
2603 ;;
2604 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2605 ;; object types they can contain will be specified in
2606 ;; `org-element-object-restrictions'.
2607 ;;
2608 ;; Adding a new type of object is simple. Implement a successor,
2609 ;; a parser, and an interpreter for it, all following the naming
2610 ;; convention. Register type in `org-element-all-objects' and
2611 ;; successor in `org-element-all-successors'. Maybe tweak
2612 ;; restrictions about it, and that's it.
2615 ;;;; Bold
2618 "Parse bold object at point.
2620 Return a list whose CAR is `bold' and CDR is a plist with
2621 `:begin', `:end', `:contents-begin' and `:contents-end' and
2622 `:post-blank' keywords.
2624 Assume point is at the first star marker."
2636 :end end
2637 :contents-begin contents-begin
2638 :contents-end contents-end
2642 "Interpret BOLD object as Org syntax.
2643 CONTENTS is the contents of the object."
2647 "Search for the next text-markup object.
2649 Return value is a cons cell whose CAR is a symbol among `bold',
2650 `italic', `underline', `strike-through', `code' and `verbatim'
2651 and CDR is beginning position."
2667 ;;;; Code
2670 "Parse code object at point.
2672 Return a list whose CAR is `code' and CDR is a plist with
2673 `:value', `:begin', `:end' and `:post-blank' keywords.
2675 Assume point is at the first tilde marker."
2686 :begin begin
2687 :end end
2691 "Interpret CODE object as Org syntax.
2692 CONTENTS is nil."
2696 ;;;; Entity
2699 "Parse entity at point.
2701 Return a list whose CAR is `entity' and CDR a plist with
2702 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2703 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2704 keywords.
2706 Assume point is at the beginning of the entity."
2708 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2724 :begin begin
2725 :end end
2726 :use-brackets-p bracketsp
2730 "Interpret ENTITY object as Org syntax.
2731 CONTENTS is nil."
2737 "Search for the next latex-fragment or entity object.
2739 Return value is a cons cell whose CAR is `entity' or
2740 `latex-fragment' and CDR is beginning position."
2744 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2751 ;; Determine if it's a real entity or a LaTeX command.
2754 ;; No entity nor command: point is at a LaTeX fragment.
2755 ;; Determine its type to get the correct beginning position.
2764 ;;;; Export Snippet
2767 "Parse export snippet at point.
2769 Return a list whose CAR is `export-snippet' and CDR a plist with
2770 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2771 keywords.
2773 Assume point is at the beginning of the snippet."
2785 :value value
2786 :begin begin
2787 :end end
2791 "Interpret EXPORT-SNIPPET object as Org syntax.
2792 CONTENTS is nil."
2798 "Search for the next export-snippet object.
2800 Return value is a cons cell whose CAR is `export-snippet' and CDR
2801 its beginning position."
2810 ;;;; Footnote Reference
2813 "Parse footnote reference at point.
2815 Return a list whose CAR is `footnote-reference' and CDR a plist
2816 with `:label', `:type', `:inline-definition', `:begin', `:end'
2817 and `:post-blank' as keywords."
2839 :type type
2840 :begin begin
2841 :end end
2844 footnote-reference :inline-definition
2849 footnote-reference))))))
2852 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2853 CONTENTS is nil."
2863 "Search for the next footnote-reference object.
2865 Return value is a cons cell whose CAR is `footnote-reference' and
2866 CDR is beginning position."
2880 ;;;; Inline Babel Call
2883 "Parse inline babel call at point.
2885 Return a list whose CAR is `inline-babel-call' and CDR a plist
2886 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2888 Assume point is at the beginning of the babel call."
2899 :end end
2900 :info info
2904 "Interpret INLINE-BABEL-CALL object as Org syntax.
2905 CONTENTS is nil."
2911 ;; Remove redundant square brackets.
2914 main-source)
2918 "Search for the next inline-babel-call object.
2920 Return value is a cons cell whose CAR is `inline-babel-call' and
2921 CDR is beginning position."
2927 ;;;; Inline Src Block
2930 "Parse inline source block at point.
2932 Return a list whose CAR is `inline-src-block' and CDR a plist
2933 with `:begin', `:end', `:language', `:value', `:parameters' and
2934 `:post-blank' as keywords.
2936 Assume point is at the beginning of the inline src block."
2949 :value value
2950 :parameters parameters
2951 :begin begin
2952 :end end
2956 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2957 CONTENTS is nil."
2962 language
2964 body)))
2967 "Search for the next inline-babel-call element.
2969 Return value is a cons cell whose CAR is `inline-babel-call' and
2970 CDR is beginning position."
2976 ;;;; Italic
2979 "Parse italic object at point.
2981 Return a list whose CAR is `italic' and CDR is a plist with
2982 `:begin', `:end', `:contents-begin' and `:contents-end' and
2983 `:post-blank' keywords.
2985 Assume point is at the first slash marker."
2997 :end end
2998 :contents-begin contents-begin
2999 :contents-end contents-end
3003 "Interpret ITALIC object as Org syntax.
3004 CONTENTS is the contents of the object."
3008 ;;;; Latex Fragment
3011 "Parse LaTeX fragment at point.
3013 Return a list whose CAR is `latex-fragment' and CDR a plist with
3014 `:value', `:begin', `:end', and `:post-blank' as keywords.
3016 Assume point is at the beginning of the LaTeX fragment."
3029 ;; None found: it's a macro.
3038 :begin begin
3039 :end end
3043 "Interpret LATEX-FRAGMENT object as Org syntax.
3044 CONTENTS is nil."
3047 ;;;; Line Break
3050 "Parse line break at point.
3052 Return a list whose CAR is `line-break', and CDR a plist with
3053 `:begin', `:end' and `:post-blank' keywords.
3055 Assume point is at the beginning of the line break."
3062 "Interpret LINE-BREAK object as Org syntax.
3063 CONTENTS is nil."
3067 "Search for the next line-break object.
3069 Return value is a cons cell whose CAR is `line-break' and CDR is
3070 beginning position."
3074 ;; A line break can only happen on a non-empty line.
3079 ;;;; Link
3082 "Parse link at point.
3084 Return a list whose CAR is `link' and CDR a plist with `:type',
3085 `:path', `:raw-link', `:application', `:search-option', `:begin',
3086 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3087 keywords.
3089 Assume point is at the beginning of the link."
3092 end contents-begin contents-end link-end post-blank path type
3093 raw-link link search-option application)
3095 ;; Type 1: Text targeted from a radio target.
3102 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3107 ;; RAW-LINK is the original link. Expand any
3108 ;; abbreviation in it.
3112 ;; Determine TYPE of link and set PATH accordingly.
3114 ;; File type.
3118 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
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 ;; Extract search option and opening application out of
3152 ;; "file"-type links.
3154 ;; Application.
3159 ;; Extract search option from PATH.
3163 ;; Make sure TYPE always reports "file".
3167 :path path
3169 :application application
3170 :search-option search-option
3171 :begin begin
3172 :end end
3173 :contents-begin contents-begin
3174 :contents-end contents-end
3178 "Interpret LINK object as Org syntax.
3179 CONTENTS is the contents of the object, or nil."
3184 raw-link
3188 "Search for the next link object.
3190 Return value is a cons cell whose CAR is `link' and CDR is
3191 beginning position."
3200 "Search for the next plain link object.
3202 Return value is a cons cell whose CAR is `link' and CDR is
3203 beginning position."
3208 ;;;; Macro
3211 "Parse macro at point.
3213 Return a list whose CAR is `macro' and CDR a plist with `:key',
3214 `:args', `:begin', `:end', `:value' and `:post-blank' as
3215 keywords.
3217 Assume point is at the macro."
3228 ;; Do not use `org-split-string' since empty
3229 ;; strings are meaningful here.
3237 args nil t)
3241 :value value
3242 :args args
3243 :begin begin
3244 :end end
3248 "Interpret MACRO object as Org syntax.
3249 CONTENTS is nil."
3253 "Search for the next macro object.
3255 Return value is cons cell whose CAR is `macro' and CDR is
3256 beginning position."
3260 nil t)
3264 ;;;; Radio-target
3267 "Parse radio target at point.
3269 Return a list whose CAR is `radio-target' and CDR a plist with
3270 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3271 and `:post-blank' as keywords.
3273 Assume point is at the radio target."
3285 :end end
3286 :contents-begin contents-begin
3287 :contents-end contents-end
3288 :post-blank post-blank
3292 "Interpret TARGET object as Org syntax.
3293 CONTENTS is the contents of the object."
3297 "Search for the next radio-target object.
3299 Return value is a cons cell whose CAR is `radio-target' and CDR
3300 is beginning position."
3306 ;;;; Statistics Cookie
3309 "Parse statistics cookie at point.
3311 Return a list whose CAR is `statistics-cookie', and CDR a plist
3312 with `:begin', `:end', `:value' and `:post-blank' keywords.
3314 Assume point is at the beginning of the statistics-cookie."
3325 :end end
3326 :value value
3330 "Interpret STATISTICS-COOKIE object as Org syntax.
3331 CONTENTS is nil."
3335 "Search for the next statistics cookie object.
3337 Return value is a cons cell whose CAR is `statistics-cookie' and
3338 CDR is beginning position."
3344 ;;;; Strike-Through
3347 "Parse strike-through object at point.
3349 Return a list whose CAR is `strike-through' and CDR is a plist
3350 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3351 `:post-blank' keywords.
3353 Assume point is at the first plus sign marker."
3365 :end end
3366 :contents-begin contents-begin
3367 :contents-end contents-end
3371 "Interpret STRIKE-THROUGH object as Org syntax.
3372 CONTENTS is the contents of the object."
3376 ;;;; Subscript
3379 "Parse subscript at point.
3381 Return a list whose CAR is `subscript' and CDR a plist with
3382 `:begin', `:end', `:contents-begin', `:contents-end',
3383 `:use-brackets-p' and `:post-blank' as keywords.
3385 Assume point is at the underscore."
3389 t
3400 :end end
3401 :use-brackets-p bracketsp
3402 :contents-begin contents-begin
3403 :contents-end contents-end
3407 "Interpret SUBSCRIPT object as Org syntax.
3408 CONTENTS is the contents of the object."
3411 contents))
3414 "Search for the next sub/superscript object.
3416 Return value is a cons cell whose CAR is either `subscript' or
3417 `superscript' and CDR is beginning position."
3425 ;;;; Superscript
3428 "Parse superscript at point.
3430 Return a list whose CAR is `superscript' and CDR a plist with
3431 `:begin', `:end', `:contents-begin', `:contents-end',
3432 `:use-brackets-p' and `:post-blank' as keywords.
3434 Assume point is at the caret."
3448 :end end
3449 :use-brackets-p bracketsp
3450 :contents-begin contents-begin
3451 :contents-end contents-end
3455 "Interpret SUPERSCRIPT object as Org syntax.
3456 CONTENTS is the contents of the object."
3459 contents))
3462 ;;;; Table Cell
3465 "Parse table cell at point.
3467 Return a list whose CAR is `table-cell' and CDR is a plist
3468 containing `:begin', `:end', `:contents-begin', `:contents-end'
3469 and `:post-blank' keywords."
3477 :end end
3478 :contents-begin contents-begin
3479 :contents-end contents-end
3483 "Interpret TABLE-CELL element as Org syntax.
3484 CONTENTS is the contents of the cell, or nil."
3488 "Search for the next table-cell object.
3490 Return value is a cons cell whose CAR is `table-cell' and CDR is
3491 beginning position."
3495 ;;;; Target
3498 "Parse target at point.
3500 Return a list whose CAR is `target' and CDR a plist with
3501 `:begin', `:end', `:value' and `:post-blank' as keywords.
3503 Assume point is at the target."
3513 :end end
3514 :value value
3518 "Interpret TARGET object as Org syntax.
3519 CONTENTS is nil."
3523 "Search for the next target object.
3525 Return value is a cons cell whose CAR is `target' and CDR is
3526 beginning position."
3532 ;;;; Timestamp
3535 "Parse time stamp at point.
3537 Return a list whose CAR is `timestamp', and CDR a plist with
3538 `:type', `:raw-value', `:year-start', `:month-start',
3539 `:day-start', `:hour-start', `:minute-start', `:year-end',
3540 `:month-end', `:day-end', `:hour-end', `:minute-end',
3541 `:repeater-type', `:repeater-value', `:repeater-unit',
3542 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3543 `:end', `:value' and `:post-blank' keywords.
3545 Assume point is at the beginning of the timestamp."
3563 date-start)
3574 raw-value)
3576 :repeater-type
3582 :repeater-unit
3591 :warning-unit
3594 year-start month-start day-start hour-start minute-start year-end
3595 month-end day-end hour-end minute-end)
3596 ;; Parse date-start.
3604 ;; Compute date-end. It can be provided directly in time-stamp,
3605 ;; or extracted from time range. Otherwise, it defaults to the
3606 ;; same values as date-start.
3616 :raw-value raw-value
3617 :year-start year-start
3618 :month-start month-start
3619 :day-start day-start
3620 :hour-start hour-start
3621 :minute-start minute-start
3622 :year-end year-end
3623 :month-end month-end
3624 :day-end day-end
3625 :hour-end hour-end
3626 :minute-end minute-end
3627 :begin begin
3628 :end end
3630 repeater-props
3631 warning-props)))))
3634 "Interpret TIMESTAMP object as Org syntax.
3635 CONTENTS is nil."
3636 ;; Use `:raw-value' if specified.
3638 ;; Otherwise, build timestamp string.
3657 ;; Build an Org timestamp string from TIME. ACTIVEP is
3658 ;; non-nil when time stamp is active. If WITH-TIME-P is
3659 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3660 ;; specify a time range in the timestamp. REPEAT-STRING
3661 ;; is the repeater string, if any.
3665 org-time-stamp-formats)
3666 time)))
3672 nil nil ts)))
3677 " "
3678 s
3680 ;; Return value.
3681 ts)))
3693 build-ts-string
3712 0
3720 "--"
3732 "Search for the next timestamp object.
3734 Return value is a cons cell whose CAR is `timestamp' and CDR is
3735 beginning position."
3743 nil t)
3747 ;;;; Underline
3750 "Parse underline object at point.
3752 Return a list whose CAR is `underline' and CDR is a plist with
3753 `:begin', `:end', `:contents-begin' and `:contents-end' and
3754 `:post-blank' keywords.
3756 Assume point is at the first underscore marker."
3768 :end end
3769 :contents-begin contents-begin
3770 :contents-end contents-end
3774 "Interpret UNDERLINE object as Org syntax.
3775 CONTENTS is the contents of the object."
3779 ;;;; Verbatim
3782 "Parse verbatim object at point.
3784 Return a list whose CAR is `verbatim' and CDR is a plist with
3785 `:value', `:begin', `:end' and `:post-blank' keywords.
3787 Assume point is at the first equal sign marker."
3798 :begin begin
3799 :end end
3803 "Interpret VERBATIM object as Org syntax.
3804 CONTENTS is nil."
3808 \f
3809 ;;; Parsing Element Starting At Point
3810 ;;
3811 ;; `org-element--current-element' is the core function of this section.
3812 ;; It returns the Lisp representation of the element starting at
3813 ;; point.
3814 ;;
3815 ;; `org-element--current-element' makes use of special modes. They
3816 ;; are activated for fixed element chaining (e.g., `plain-list' >
3817 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3818 ;; `section'). Special modes are: `first-section', `item',
3819 ;; `node-property', `quote-section', `section' and `table-row'.
3823 "Parse the element starting at point.
3825 Return value is a list like (TYPE PROPS) where TYPE is the type
3826 of the element and PROPS a plist of properties associated to the
3827 element.
3829 Possible types are defined in `org-element-all-elements'.
3831 LIMIT bounds the search.
3833 Optional argument GRANULARITY determines the depth of the
3834 recursion. Allowed values are `headline', `greater-element',
3835 `element', `object' or nil. When it is broader than `object' (or
3836 nil), secondary values will not be parsed, since they only
3837 contain objects.
3839 Optional argument SPECIAL, when non-nil, can be either
3840 `first-section', `item', `node-property', `quote-section',
3841 `section', and `table-row'.
3843 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3844 be computed.
3846 This function assumes point is always at the beginning of the
3847 element it has to parse."
3850 ;; Determine if parsing depth allows for secondary strings
3851 ;; parsing. It only applies to elements referenced in
3852 ;; `org-element-secondary-value-alist'.
3855 ;; Item.
3858 ;; Table Row.
3860 ;; Node Property.
3862 ;; Headline.
3865 ;; Sections (must be checked after headline).
3871 limit)))
3872 ;; When not at bol, point is at the beginning of an item or
3873 ;; a footnote definition: next item is always a paragraph.
3875 ;; Planning and Clock.
3880 ;; Inlinetask.
3883 ;; From there, elements can have affiliated keywords.
3886 ;; Jumping over affiliated keywords put point off-limits.
3887 ;; Parse them as regular keywords.
3891 ;; LaTeX Environment.
3895 ;; Drawer and Property Drawer.
3900 ;; Fixed Width
3903 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3904 ;; Keywords.
3913 org-element-block-name-alist)))
3928 ;; Footnote Definition.
3931 ;; Horizontal Rule.
3934 ;; Diary Sexp.
3937 ;; Table.
3939 ;; List.
3942 limit affiliated
3944 ;; Default element: Paragraph.
3948 ;; Most elements can have affiliated keywords. When looking for an
3949 ;; element beginning, we want to move before them, as they belong to
3950 ;; that element, and, in the meantime, collect information they give
3951 ;; into appropriate properties. Hence the following function.
3954 "Collect affiliated keywords from point down to LIMIT.
3956 Return a list whose CAR is the position at the first of them and
3957 CDR a plist of keywords and values and move point to the
3958 beginning of the first line after them.
3960 As a special case, if element doesn't start at the beginning of
3961 the line (e.g., a paragraph starting an item), CAR is current
3962 position of point and CDR is nil."
3966 ;; RESTRICT is the list of objects allowed in parsed
3967 ;; keywords value.
3969 output)
3972 ;; Apply translation to RAW-KWD. From there, KWD is
3973 ;; the official keyword.
3975 org-element-keyword-translation-alist))
3976 raw-kwd))
3977 ;; Find main value for any keyword.
3983 ;; PARSEDP is non-nil when keyword should have its
3984 ;; value parsed.
3986 ;; If KWD is a dual keyword, find its secondary
3987 ;; value. Maybe parse it.
3994 ;; Attribute a property name to KWD.
3996 ;; Now set final shape for VALUE.
4002 ;; Attributes can always appear on multiple lines.
4005 ;; Eventually store the new value in OUTPUT.
4007 ;; Move to next keyword.
4009 ;; If affiliated keywords are orphaned: move back to first one.
4010 ;; They will be parsed as a paragraph.
4012 ;; Return value.
4016 \f
4017 ;;; The Org Parser
4018 ;;
4019 ;; The two major functions here are `org-element-parse-buffer', which
4020 ;; parses Org syntax inside the current buffer, taking into account
4021 ;; region, narrowing, or even visibility if specified, and
4022 ;; `org-element-parse-secondary-string', which parses objects within
4023 ;; a given string.
4024 ;;
4025 ;; The (almost) almighty `org-element-map' allows to apply a function
4026 ;; on elements or objects matching some type, and accumulate the
4027 ;; resulting values. In an export situation, it also skips unneeded
4028 ;; parts of the parse tree.
4031 "Recursively parse the buffer and return structure.
4032 If narrowing is in effect, only parse the visible part of the
4033 buffer.
4035 Optional argument GRANULARITY determines the depth of the
4036 recursion. It can be set to the following symbols:
4038 `headline' Only parse headlines.
4039 `greater-element' Don't recurse into greater elements excepted
4040 headlines and sections. Thus, elements
4041 parsed are the top-level ones.
4042 `element' Parse everything but objects and plain text.
4043 `object' Parse the complete buffer (default).
4045 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4046 elements.
4048 An element or an objects is represented as a list with the
4049 pattern (TYPE PROPERTIES CONTENTS), where :
4051 TYPE is a symbol describing the element or object. See
4052 `org-element-all-elements' and `org-element-all-objects' for an
4053 exhaustive list of such symbols. One can retrieve it with
4054 `org-element-type' function.
4056 PROPERTIES is the list of attributes attached to the element or
4057 object, as a plist. Although most of them are specific to the
4058 element or object type, all types share `:begin', `:end',
4059 `:post-blank' and `:parent' properties, which respectively
4060 refer to buffer position where the element or object starts,
4061 ends, the number of white spaces or blank lines after it, and
4062 the element or object containing it. Properties values can be
4063 obtained by using `org-element-property' function.
4065 CONTENTS is a list of elements, objects or raw strings
4066 contained in the current element or object, when applicable.
4067 One can access them with `org-element-contents' function.
4069 The Org buffer has `org-data' as type and nil as properties.
4070 `org-element-map' function can be used to find specific elements
4071 or objects within the parse tree.
4073 This function assumes that current major mode is `org-mode'."
4079 ;; Start in `first-section' mode so text before the first
4080 ;; headline belongs to a section.
4084 "Recursively parse objects in STRING and return structure.
4086 RESTRICTION is a symbol limiting the object types that will be
4087 looked after.
4089 Optional argument PARENT, when non-nil, is the element or object
4090 containing the secondary string. It is used to set correctly
4091 `:parent' property within the string."
4092 ;; Copy buffer-local variables listed in
4093 ;; `org-element-object-variables' into temporary buffer. This is
4094 ;; required since object parsing is dependent on these variables.
4098 org-element-object-variables))))
4106 secondary))
4107 secondary))))
4111 "Map a function on selected elements or objects.
4113 DATA is a parse tree, an element, an object, a string, or a list
4114 of such constructs. TYPES is a symbol or list of symbols of
4115 elements or objects types (see `org-element-all-elements' and
4116 `org-element-all-objects' for a complete list of types). FUN is
4117 the function called on the matching element or object. It has to
4118 accept one argument: the element or object itself.
4120 When optional argument INFO is non-nil, it should be a plist
4121 holding export options. In that case, parts of the parse tree
4122 not exportable according to that property list will be skipped.
4124 When optional argument FIRST-MATCH is non-nil, stop at the first
4125 match for which FUN doesn't return nil, and return that value.
4127 Optional argument NO-RECURSION is a symbol or a list of symbols
4128 representing elements or objects types. `org-element-map' won't
4129 enter any recursive element or object whose type belongs to that
4130 list. Though, FUN can still be applied on them.
4132 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4133 apply to matching objects within parsed affiliated keywords (see
4134 `org-element-parsed-keywords').
4136 Nil values returned from FUN do not appear in the results.
4139 Examples:
4140 ---------
4142 Assuming TREE is a variable containing an Org buffer parse tree,
4143 the following example will return a flat list of all `src-block'
4144 and `example-block' elements in it:
4146 \(org-element-map tree '(example-block src-block) 'identity)
4148 The following snippet will find the first headline with a level
4151 \(org-element-map tree 'headline
4152 \(lambda (hl)
4153 \(and (= (org-element-property :level hl) 1)
4155 \(org-element-property :begin hl)))
4156 nil t)
4158 The next example will return a flat list of all `plain-list' type
4159 elements in TREE that are not a sub-list themselves:
4161 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4163 Eventually, this example will return a flat list of all `bold'
4164 type objects containing a `latex-snippet' type object, even
4165 looking into captions:
4167 \(org-element-map tree 'bold
4168 \(lambda (b)
4169 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4170 nil nil nil t)"
4171 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4174 ;; Recursion depth is determined by --CATEGORY.
4181 ;; If one object is found, the function
4182 ;; has to recurse into every object.
4185 ;; If one regular element is found, the
4186 ;; function has to recurse, at least,
4187 ;; into every element it encounters.
4190 types)
4191 category)))
4192 ;; Compute properties for affiliated keywords if necessary.
4197 org-element-affiliated-keywords)))
4198 --acc
4199 --walk-tree
4203 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4204 ;; holding contextual information.
4208 ;; Ignored element in an export context.
4210 ;; List of elements or objects.
4212 ;; Unconditionally enter parse trees.
4216 ;; Check if TYPE is matching among TYPES. If so,
4217 ;; apply FUN to --DATA and accumulate return value
4218 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4224 ;; If --DATA has a secondary string that can contain
4225 ;; objects with their type among TYPES, look into it.
4232 ;; If --DATA has any affiliated keywords and
4233 ;; WITH-AFFILIATED is non-nil, look for objects in
4234 ;; them.
4242 ;; Pay attention to the type of value.
4243 ;; Preserve order for multiple keywords.
4259 --affiliated-alist))
4260 ;; Determine if a recursion into --DATA is possible.
4262 ;; --TYPE is explicitly removed from recursion.
4264 ;; --DATA has no contents.
4266 ;; Looking for greater elements but --DATA is simply
4267 ;; an element or an object.
4270 ;; Looking for elements but --DATA is an object.
4273 ;; In any other case, map contents.
4277 ;; Return value in a proper order.
4281 ;; The following functions are internal parts of the parser.
4282 ;;
4283 ;; The first one, `org-element--parse-elements' acts at the element's
4284 ;; level.
4285 ;;
4286 ;; The second one, `org-element--parse-objects' applies on all objects
4287 ;; of a paragraph or a secondary string. It uses
4288 ;; `org-element--get-next-object-candidates' to optimize the search of
4289 ;; the next object in the buffer.
4290 ;;
4291 ;; More precisely, that function looks for every allowed object type
4292 ;; first. Then, it discards failed searches, keeps further matches,
4293 ;; and searches again types matched behind point, for subsequent
4294 ;; calls. Thus, searching for a given type fails only once, and every
4295 ;; object is searched only once at top level (but sometimes more for
4296 ;; nested types).
4300 "Parse elements between BEG and END positions.
4302 SPECIAL prioritize some elements over the others. It can be set
4303 to `first-section', `quote-section', `section' `item' or
4304 `table-row'.
4306 When value is `item', STRUCTURE will be used as the current list
4307 structure.
4309 GRANULARITY determines the depth of the recursion. See
4310 `org-element-parse-buffer' for more information.
4312 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4313 elements.
4315 Elements are accumulated into ACC."
4318 ;; Visible only: skip invisible parts at the beginning of the
4319 ;; element.
4322 ;; When parsing only headlines, skip any text before first one.
4325 ;; Main loop start.
4327 ;; Find current element's type and parse it accordingly to
4328 ;; its category.
4330 end granularity special structure))
4334 ;; Visible only: skip invisible parts between siblings.
4337 ;; Fill ELEMENT contents by side-effect.
4339 ;; If element has no contents, don't modify it.
4341 ;; Greater element: parse it between `contents-begin' and
4342 ;; `contents-end'. Make sure GRANULARITY allows the
4343 ;; recursion, or ELEMENT is a headline, in which case going
4344 ;; inside is mandatory, in order to get sub-level headings.
4352 ;; Possibly switch to a special mode.
4362 granularity visible-only element))
4363 ;; ELEMENT has contents. Parse objects inside, if
4364 ;; GRANULARITY allows it.
4370 ;; Return result.
4371 acc))
4374 "Parse objects between BEG and END and return recursive structure.
4376 Objects are accumulated in ACC.
4378 RESTRICTION is a list of object successors which are allowed in
4379 the current object."
4388 restriction candidates)))
4395 ;; 1. Text before any object. Untabify it.
4400 acc
4404 ;; 2. Object...
4407 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4408 ;; a recursive type.
4416 ;; 3. Text after last object. Untabify it.
4420 acc
4424 ;; Result.
4425 acc))))
4428 "Return an alist of candidates for the next object.
4430 RESTRICTION is a list of object types, as symbols. Only
4431 candidates with such types are looked after.
4433 OBJECTS is the previous candidates alist. If it is set to
4434 `initial', no search has been done before, and all symbols in
4435 RESTRICTION should be looked after.
4437 Return value is an alist whose CAR is the object type and CDR its
4438 beginning position."
4440 nil
4442 ;; When searching for the first time, look for every successor
4443 ;; allowed in RESTRICTION.
4447 restriction)
4448 ;; Focus on objects returned during last search. Keep those
4449 ;; still after point. Search again objects before it.
4455 type)))
4458 objects))))
4461 \f
4462 ;;; Towards A Bijective Process
4463 ;;
4464 ;; The parse tree obtained with `org-element-parse-buffer' is really
4465 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4466 ;; interpreted and expanded into a string with canonical Org syntax.
4467 ;; Hence `org-element-interpret-data'.
4468 ;;
4469 ;; The function relies internally on
4470 ;; `org-element--interpret-affiliated-keywords'.
4472 ;;;###autoload
4474 "Interpret DATA as Org syntax.
4476 DATA is a parse tree, an element, an object or a secondary string
4477 to interpret.
4479 Optional argument PARENT is used for recursive calls. It contains
4480 the element or object containing data, or nil.
4482 Return Org syntax as a string."
4486 ;; Secondary string.
4491 ;; Full Org document.
4496 ;; Plain text: return it.
4498 ;; Element/Object without contents.
4501 data nil))
4502 ;; Element/Object with contents.
4512 ;; Elements directly containing objects must
4513 ;; have their indentation normalized first.
4515 data
4516 ;; When normalizing first paragraph of an
4517 ;; item or a footnote-definition, ignore
4518 ;; first line's indentation.
4525 data
4527 contents)))))))
4529 ;; Build white spaces. If no `:post-blank' property is
4530 ;; specified, assume its value is 0.
4540 "Return ELEMENT's affiliated keywords as Org syntax.
4541 If there is no affiliated keyword, return the empty string."
4551 ": "
4554 value)
4562 ;; All attribute keywords can have multiple lines.
4568 ;; List all ELEMENT's properties matching an attribute line or an
4569 ;; affiliated keyword, but ignore translated keywords since they
4570 ;; cannot belong to the property list.
4577 org-element-keyword-translation-alist)))))
4578 collect prop)
4581 ;; Because interpretation of the parse tree must return the same
4582 ;; number of blank lines between elements and the same number of white
4583 ;; space after objects, some special care must be given to white
4584 ;; spaces.
4585 ;;
4586 ;; The first function, `org-element-normalize-string', ensures any
4587 ;; string different from the empty string will end with a single
4588 ;; newline character.
4589 ;;
4590 ;; The second function, `org-element-normalize-contents', removes
4591 ;; global indentation from the contents of the current element.
4594 "Ensure string S ends with a single newline character.
4596 If S isn't a string return it unchanged. If S is the empty
4597 string, return it. Otherwise, return a new string with a single
4598 newline character at its end."
4606 "Normalize plain text in ELEMENT's contents.
4608 ELEMENT must only contain plain text and objects.
4610 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4611 indentation to compute maximal common indentation.
4613 Return the normalized element that is element with global
4614 indentation removed from its contents. The function assumes that
4615 indentation is not done with TAB characters."
4617 find-min-ind ; For byte-compiler.
4620 ;; Return minimal common indentation within BLOB. This is
4621 ;; done by walking recursively BLOB and updating MIN-IND
4622 ;; along the way. FIRST-FLAG is non-nil when the first
4623 ;; string hasn't been seen yet. It is required as this
4624 ;; string is the only one whose indentation doesn't happen
4625 ;; after a newline character.
4632 ;; An indentation of zero means no string will be
4633 ;; modified. Quit the process.
4642 ;; Find minimal indentation in ELEMENT.
4645 ;; Build ELEMENT back, replacing each string with the same
4646 ;; string minus common indentation.
4651 ;; Return BLOB with all its strings indentation
4652 ;; shortened from MIN-IND white spaces. FIRST-FLAG
4653 ;; is non-nil when the first string hasn't been seen
4654 ;; yet.
4669 org-element-recursive-objects)
4673 blob))))
4677 \f
4678 ;;; The Toolbox
4679 ;;
4680 ;; The first move is to implement a way to obtain the smallest element
4681 ;; containing point. This is the job of `org-element-at-point'. It
4682 ;; basically jumps back to the beginning of section containing point
4683 ;; and moves, element after element, with
4684 ;; `org-element--current-element' until the container is found. Note:
4685 ;; When using `org-element-at-point', secondary values are never
4686 ;; parsed since the function focuses on elements, not on objects.
4687 ;;
4688 ;; At a deeper level, `org-element-context' lists all elements and
4689 ;; objects containing point.
4690 ;;
4691 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4692 ;; internally by navigation and manipulation tools.
4694 ;;;###autoload
4696 "Determine closest element around point.
4698 Return value is a list like (TYPE PROPS) where TYPE is the type
4699 of the element and PROPS a plist of properties associated to the
4700 element.
4702 Possible types are defined in `org-element-all-elements'.
4703 Properties depend on element or object type, but always include
4704 `:begin', `:end', `:parent' and `:post-blank' properties.
4706 As a special case, if point is at the very beginning of a list or
4707 sub-list, returned element will be that list instead of the first
4708 item. In the same way, if point is at the beginning of the first
4709 row of a table, returned element will be the table instead of the
4710 first row.
4712 If optional argument KEEP-TRAIL is non-nil, the function returns
4713 a list of elements leading to element at point. The list's CAR
4714 is always the element at point. The following positions contain
4715 element's siblings, then parents, siblings of parents, until the
4716 first element of current section."
4718 ;; If at a headline, parse it. It is the sole element that
4719 ;; doesn't require to know about context. Be sure to disallow
4720 ;; secondary string parsing, though.
4726 ;; Otherwise move at the beginning of the section containing
4727 ;; point.
4732 element type special-flag trail struct prevs parent)
4735 ;; In empty lines at buffer's beginning, return nil.
4744 ;; In blank lines just after the headline, point still
4745 ;; belongs to the headline.
4754 ;; Parse successively each element, skipping those ending
4755 ;; before original position.
4763 ;; 1. Skip any element ending before point. Also skip
4764 ;; element ending at point when we're sure that another
4765 ;; element has started.
4770 ;; 2. An element containing point is always the element at
4771 ;; point.
4774 ;; 3. At any other greater element type, if point is
4775 ;; within contents, move into it.
4780 ;; Create an anchor for tables and plain lists:
4781 ;; when point is at the very beginning of these
4782 ;; elements, ignoring affiliated keywords,
4783 ;; target them instead of their contents.
4785 ;; When point is at contents end, do not move
4786 ;; into elements with an explicit ending, but
4787 ;; return that element instead.
4791 drawer dynamic-block inlinetask
4792 property-drawer quote-block
4793 special-block))
4794 ;; Corner case: if a list ends at the
4795 ;; end of a buffer without a final new
4796 ;; line, return last element in last
4797 ;; item instead.
4815 ;;;###autoload
4817 "Return closest element or object around point.
4819 Return value is a list like (TYPE PROPS) where TYPE is the type
4820 of the element or object and PROPS a plist of properties
4821 associated to it.
4823 Possible types are defined in `org-element-all-elements' and
4824 `org-element-all-objects'. Properties depend on element or
4825 object type, but always include `:begin', `:end', `:parent' and
4826 `:post-blank'.
4828 Optional argument ELEMENT, when non-nil, is the closest element
4829 containing point, as returned by `org-element-at-point'.
4830 Providing it allows for quicker computation."
4836 context)
4837 ;; Check if point is inside an element containing objects or at
4838 ;; a secondary string. In that case, narrow buffer to the
4839 ;; containing area. Otherwise, return ELEMENT.
4841 ;; At a parsed affiliated keyword, check if we're inside main
4842 ;; or dual value.
4849 org-element-parsed-keywords))
4858 ;; Also change type to retrieve correct restrictions.
4860 ;; At an item, objects can only be located within tag, if any.
4870 ;; At an headline or inlinetask, objects are located within
4871 ;; their title.
4878 ;; At a paragraph, a table-row or a verse block, objects are
4879 ;; located within their contents.
4883 ;; CBEG is nil for table rules.
4887 ;; At a parsed keyword, objects are located within value.
4890 org-element-document-properties))
4897 ;; At a planning line, if point is at a timestamp, return it,
4898 ;; otherwise, return element.
4915 restriction candidates))
4917 candidates)))
4918 ;; If ORIGIN is before next object in element, there's
4919 ;; no point in looking further.
4929 ;; ORIGIN is after OBJECT, so skip it.
4931 ;; ORIGIN is within a non-recursive object or at
4932 ;; an object boundaries: Return that object.
4936 ;; Otherwise, move within current object and
4937 ;; restrict search to the end of its contents.
4944 parent))))))
4947 "Non-nil when elements ELEM-A and ELEM-B are nested."
4956 "Swap elements ELEM-A and ELEM-B.
4957 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4958 end of ELEM-A."
4960 ;; There are two special cases when an element doesn't start at bol:
4961 ;; the first paragraph in an item or in a footnote definition.
4963 ;; Only a paragraph without any affiliated keyword can be moved at
4964 ;; ELEM-A position in such a situation. Note that the case of
4965 ;; a footnote definition is impossible: it cannot contain two
4966 ;; paragraphs in a row because it cannot contain a blank line.
4972 ;; In a special situation, ELEM-A will have no indentation. We'll
4973 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4987 ;; Store overlays responsible for visibility status. We
4988 ;; also need to store their boundaries as they will be
4989 ;; removed from buffer.
4996 ;; Get contents.
5004 ;; Restore ex ELEM-A overlays.
5013 ;; Restore ex ELEM-B overlays.
5022 ;; Local variables:
5023 ;; generated-autoload-file: "org-loaddefs.el"
5024 ;; End:
5026 ;;; org-element.el ends here