| blob | 73d55315575c0b1b4402e82c0ec7fa4bf63de43c |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls and keywords. Note: this
147 ;; is only an indication and need some thorough check.
149 ;; Drawers (any type) and fixed-width areas. This is also
150 ;; only an indication.
152 ;; Horizontal rules.
154 ;; LaTeX environments.
156 ;; Planning and Clock lines.
158 org-deadline-string
159 org-closed-string
160 org-clock-string))
162 ;; Lists.
169 "Regexp to separate paragraphs in an Org buffer.
171 is not sufficient to know if point is at a paragraph ending. See
176 dynamic-block example-block export-block fixed-width
177 footnote-definition headline horizontal-rule inlinetask item
178 keyword latex-environment node-property paragraph plain-list
179 planning property-drawer quote-block quote-section section
180 special-block src-block table table-row verse-block)
185 item plain-list property-drawer quote-block section
186 special-block table)
191 latex-or-entity line-break link macro plain-link radio-target
192 statistics-cookie sub/superscript table-cell target
193 text-markup timestamp)
202 "Alist of translations between object type and successor name.
203 Sharing the same successor comes handy when, for example, the
208 inline-src-block italic line-break latex-fragment link macro
209 radio-target statistics-cookie strike-through subscript superscript
210 table-cell target timestamp underline verbatim)
215 table-cell underline)
225 "Alist between block names and the associated parsing function.
226 Names must be uppercase. Any block whose name has no association
232 Only these types can accept search options and an explicit
238 "List of affiliated keywords as strings.
244 ;; Regular affiliated keywords.
247 "Regexp matching any affiliated keyword.
249 Keyword name is put in match group 1. Moreover, if keyword
250 belongs to `org-element-dual-keywords', put the dual value in
251 match group 2.
259 "Alist of usual translations for keywords.
260 The key is the old name and the value the new one. The property
264 "List of affiliated keywords that can occur more than once in an element.
266 Their value will be consed into a list of strings, which will be
267 returned as the value of the property.
269 This list is checked after translations have been applied. See
270 `org-element-keyword-translation-alist'.
276 "List of affiliated keywords whose value can be parsed.
278 Their value will be stored as a secondary string: a list of
279 strings and objects.
281 This list is checked after translations have been applied. See
285 "List of affiliated keywords which can have a secondary value.
287 In Org syntax, they can be written with optional square brackets
288 before the colons. For example, RESULTS keyword can be
289 associated to a hash value with the following:
291 #+RESULTS[hash-string]: some-source
293 This list is checked after translations have been applied. See
297 "List of properties associated to the whole document.
298 Any keyword in this list will have its value parsed and stored as
312 ;; Ignore all links excepted plain links in a link description.
313 ;; Also ignore radio-targets and line breaks.
317 ;; Remove any variable object from radio target as it would
318 ;; prevent it from being properly recognized.
323 ;; Ignore inline babel call and inline src block as formulas are
324 ;; possible. Also ignore line breaks and statistics cookies.
330 "Alist of objects restrictions.
332 CAR is an element or object type containing objects and CDR is
333 a list of successors that will be called within an element or
334 object of such type.
336 For example, in a `radio-target' object, one can only find
337 entities, latex-fragments, subscript and superscript.
339 This alist also applies to secondary string. For example, an
340 `headline' type element doesn't directly contain objects, but
351 "List of buffer-local variables used when parsing objects.
352 These variables are copied to the temporary buffer created by
356 \f
357 ;;; Accessors and Setters
358 ;;
359 ;; Provide four accessors: `org-element-type', `org-element-property'
360 ;; `org-element-contents' and `org-element-restriction'.
361 ;;
362 ;; Setter functions allow to modify elements by side effect. There is
363 ;; `org-element-put-property', `org-element-set-contents',
364 ;; `org-element-set-element' and `org-element-adopt-element'. Note
365 ;; that `org-element-set-element' and `org-element-adopt-elements' are
366 ;; higher level functions since also update `:parent' property.
369 "Return type of ELEMENT.
371 The function returns the type of the element or object provided.
372 It can also return the following special value:
373 `plain-text' for a string
374 `org-data' for a complete document
375 nil in any other case."
381 "Extract the value from the PROPERTY of an ELEMENT."
386 "Extract contents from an ELEMENT."
392 "Return restriction associated to ELEMENT.
393 ELEMENT can be an element, an object or a symbol representing an
394 element or object type."
396 org-element-object-restrictions)))
399 "In ELEMENT set PROPERTY to VALUE.
400 Return modified element."
403 element))
406 "Set ELEMENT contents to CONTENTS.
407 Return modified element."
414 "Replace element or object OLD with element or object NEW.
415 The function takes care of setting `:parent' property for NEW."
416 ;; Since OLD is going to be changed into NEW by side-effect, first
417 ;; make sure that every element or object within NEW has OLD as
418 ;; parent.
421 ;; Transfer contents.
423 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
424 ;; with NEW's.
427 ;; Transfer type.
431 "Append elements to the contents of another element.
433 PARENT is an element or object. CHILDREN can be elements,
434 objects, or a strings.
436 The function takes care of setting `:parent' property for CHILD.
437 Return parent element."
438 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
439 ;; string: parent is the list itself.
442 children)
443 ;; Add CHILDREN at the end of PARENT contents.
446 parent
448 ;; Return modified PARENT element.
452 \f
453 ;;; Greater elements
454 ;;
455 ;; For each greater element type, we define a parser and an
456 ;; interpreter.
457 ;;
458 ;; A parser returns the element or object as the list described above.
459 ;; Most of them accepts no argument. Though, exceptions exist. Hence
460 ;; every element containing a secondary string (see
461 ;; `org-element-secondary-value-alist') will accept an optional
462 ;; argument to toggle parsing of that secondary string. Moreover,
463 ;; `item' parser requires current list's structure as its first
464 ;; element.
465 ;;
466 ;; An interpreter accepts two arguments: the list representation of
467 ;; the element or object, and its contents. The latter may be nil,
468 ;; depending on the element or object considered. It returns the
469 ;; appropriate Org syntax, as a string.
470 ;;
471 ;; Parsing functions must follow the naming convention:
472 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
473 ;; defined in `org-element-greater-elements'.
474 ;;
475 ;; Similarly, interpreting functions must follow the naming
476 ;; convention: org-element-TYPE-interpreter.
477 ;;
478 ;; With the exception of `headline' and `item' types, greater elements
479 ;; cannot contain other greater elements of their own type.
480 ;;
481 ;; Beside implementing a parser and an interpreter, adding a new
482 ;; greater element requires to tweak `org-element--current-element'.
483 ;; Moreover, the newly defined type must be added to both
484 ;; `org-element-all-elements' and `org-element-greater-elements'.
487 ;;;; Center Block
490 "Parse a center block.
492 LIMIT bounds the search. AFFILIATED is a list of which CAR is
493 the buffer position at the beginning of the first affiliated
494 keyword and CDR is a plist of affiliated keywords along with
495 their value.
497 Return a list whose CAR is `center-block' and CDR is a plist
498 containing `:begin', `:end', `:hiddenp', `:contents-begin',
499 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
501 Assume point is at the beginning of the block."
505 ;; Incomplete block: parse it as a paragraph.
510 ;; Empty blocks have no contents.
525 :end end
526 :hiddenp hidden
527 :contents-begin contents-begin
528 :contents-end contents-end
534 "Interpret CENTER-BLOCK element as Org syntax.
535 CONTENTS is the contents of the element."
539 ;;;; Drawer
542 "Parse a drawer.
544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
545 the buffer position at the beginning of the first affiliated
546 keyword and CDR is a plist of affiliated keywords along with
547 their value.
549 Return a list whose CAR is `drawer' and CDR is a plist containing
550 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
551 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
553 Assume point is at beginning of drawer."
556 ;; Incomplete drawer: parse it as a paragraph.
564 ;; Empty drawers have no contents.
578 :end end
579 :drawer-name name
580 :hiddenp hidden
581 :contents-begin contents-begin
582 :contents-end contents-end
588 "Interpret DRAWER element as Org syntax.
589 CONTENTS is the contents of the element."
592 contents))
595 ;;;; Dynamic Block
598 "Parse a dynamic block.
600 LIMIT bounds the search. AFFILIATED is a list of which CAR is
601 the buffer position at the beginning of the first affiliated
602 keyword and CDR is a plist of affiliated keywords along with
603 their value.
605 Return a list whose CAR is `dynamic-block' and CDR is a plist
606 containing `:block-name', `:begin', `:end', `:hiddenp',
607 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
608 and `:post-affiliated' keywords.
610 Assume point is at beginning of dynamic block."
614 ;; Incomplete block: parse it as a paragraph.
623 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
699 :begin begin
700 :end end
701 :contents-begin contents-begin
702 :contents-end contents-end
708 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
709 CONTENTS is the contents of the footnote-definition."
711 " "
712 contents))
715 ;;;; Headline
718 "Parse a headline.
720 Return a list whose CAR is `headline' and CDR is a plist
721 containing `:raw-value', `:title', `:alt-title', `:begin',
722 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
723 `:contents-end', `:level', `:priority', `:tags',
724 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
725 `:closed', `:quotedp', `:archivedp', `:commentedp' and
726 `:footnote-section-p' keywords.
728 The plist also contains any property set in the property drawer,
729 with its name in upper cases and colons added at the
730 beginning (i.e. `:CUSTOM_ID').
732 When RAW-SECONDARY-P is non-nil, headline's title will not be
733 parsed as a secondary string, but as a plain string instead.
735 Assume point is at beginning of the headline."
748 raw-value)))
752 raw-value)))
756 ;; Upcase property names. It avoids confusion between
757 ;; properties obtained through property drawer and default
758 ;; properties from the parser (e.g. `:end' and :END:)
768 plist))
770 ;; Read time properties on the line below the headline.
776 org-keyword-time-not-clock-regexp end t)
786 plist))))
799 ;; Clean RAW-VALUE from any quote or comment string.
807 ""
808 raw-value))))
809 ;; Clean TAGS from archive tag, if any.
815 :begin begin
816 :end end
817 :pre-blank
820 :hiddenp hidden
821 :contents-begin contents-begin
822 :contents-end contents-end
823 :level level
825 :tags tags
826 :todo-keyword todo
827 :todo-type todo-type
833 end)
834 :footnote-section-p footnote-section-p
835 :archivedp archivedp
836 :commentedp commentedp
838 time-props
839 standard-props))))
843 headline :alt-title
848 headline :title
854 "Interpret HEADLINE element as Org syntax.
855 CONTENTS is the contents of the element."
882 ;; Align tags.
890 ? )
891 tags))
895 tags))))
897 contents)))
900 ;;;; Inlinetask
903 "Parse an inline task.
905 Return a list whose CAR is `inlinetask' and CDR is a plist
906 containing `:title', `:begin', `:end', `:hiddenp',
907 `:contents-begin' and `:contents-end', `:level', `:priority',
908 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
909 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
911 The plist also contains any property set in the property drawer,
912 with its name in upper cases and colons added at the
913 beginning (i.e. `:CUSTOM_ID').
915 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
916 title will not be parsed as a secondary string, but as a plain
917 string instead.
919 Assume point is at beginning of the inline task."
929 ;; Upcase property names. It avoids confusion between
930 ;; properties obtained through property drawer and default
931 ;; properties from the parser (e.g. `:end' and :END:)
941 plist))
943 ;; Read time properties on the line below the inlinetask
944 ;; opening string.
950 org-keyword-time-not-clock-regexp end t)
960 plist))))
979 :begin begin
980 :end end
981 :hiddenp hidden
982 :contents-begin contents-begin
983 :contents-end contents-end
986 :tags tags
987 :todo-keyword todo
988 :todo-type todo-type
990 time-props
991 standard-props))))
993 inlinetask :title
996 raw-value
998 inlinetask))))))
1001 "Interpret INLINETASK element as Org syntax.
1002 CONTENTS is the contents of inlinetask."
1017 ;; Align tags.
1025 ? )
1026 tags))
1030 tags))))
1031 ;; Prefer degenerate inlinetasks when there are no
1032 ;; contents.
1035 contents
1039 ;;;; Item
1042 "Parse an item.
1044 STRUCT is the structure of the plain list.
1046 Return a list whose CAR is `item' and CDR is a plist containing
1047 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1048 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1049 `:post-blank' keywords.
1051 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1052 any, will not be parsed as a secondary string, but as a plain
1053 string instead.
1055 Assume point is at the beginning of the item."
1079 ;; Ignore tags in un-ordered lists: they are just
1080 ;; a part of item's body.
1086 ;; If first line isn't empty, contents really start
1087 ;; at the text after item's meta-data.
1098 :begin begin
1099 :end end
1100 ;; CONTENTS-BEGIN and CONTENTS-END may be
1101 ;; mixed up in the case of an empty item
1102 ;; separated from the next by a blank line.
1103 ;; Thus ensure the former is always the
1104 ;; smallest.
1107 :checkbox checkbox
1108 :counter counter
1109 :hiddenp hidden
1110 :structure struct
1113 item :tag
1121 "Interpret ITEM element as Org syntax.
1122 CONTENTS is the contents of the element."
1132 ;; Compute indentation.
1137 ;; Indent contents.
1139 bullet
1153 ;;;; Plain List
1156 ;; Return structure of list at point. Internal function. See
1157 ;; `org-list-struct' for details.
1165 items struct)
1170 ;; At limit: end all items.
1179 ;; At list end: end all items.
1184 ;; At a new item: end previous sibling.
1196 ind
1197 bullet
1200 ;; Description tag.
1204 ;; Ending position, unknown so far.
1205 nil)))
1206 items))
1208 ;; Skip empty lines.
1210 ;; Skip inline tasks and blank lines along the way.
1217 ;; At some text line. Check if it ends any previous item.
1229 ;; Skip blocks (any type) and drawers contents.
1235 limit t)))
1241 "Parse a plain list.
1243 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1244 the buffer position at the beginning of the first affiliated
1245 keyword and CDR is a plist of affiliated keywords along with
1246 their value. STRUCTURE is the structure of the plain list being
1247 parsed.
1249 Return a list whose CAR is `plain-list' and CDR is a plist
1250 containing `:type', `:begin', `:end', `:contents-begin' and
1251 `:contents-end', `:structure', `:post-blank' and
1252 `:post-affiliated' keywords.
1254 Assume point is at the beginning of the list."
1267 ;; Return value.
1271 :begin begin
1272 :end end
1273 :contents-begin contents-begin
1274 :contents-end contents-end
1275 :structure struct
1281 "Interpret PLAIN-LIST element as Org syntax.
1282 CONTENTS is the contents of the element."
1290 ;;;; Property Drawer
1293 "Parse a property drawer.
1295 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1296 the buffer position at the beginning of the first affiliated
1297 keyword and CDR is a plist of affiliated keywords along with
1298 their value.
1300 Return a list whose CAR is `property-drawer' and CDR is a plist
1301 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1302 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1304 Assume point is at the beginning of the property drawer."
1309 ;; Incomplete drawer: parse it as a paragraph.
1328 :end end
1329 :hiddenp hidden
1330 :contents-begin contents-begin
1331 :contents-end contents-end
1337 "Interpret PROPERTY-DRAWER element as Org syntax.
1338 CONTENTS is the properties within the drawer."
1342 ;;;; Quote Block
1345 "Parse a quote block.
1347 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1348 the buffer position at the beginning of the first affiliated
1349 keyword and CDR is a plist of affiliated keywords along with
1350 their value.
1352 Return a list whose CAR is `quote-block' and CDR is a plist
1353 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1354 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1356 Assume point is at the beginning of the block."
1360 ;; Incomplete block: parse it as a paragraph.
1366 ;; Empty blocks have no contents.
1380 :end end
1381 :hiddenp hidden
1382 :contents-begin contents-begin
1383 :contents-end contents-end
1389 "Interpret QUOTE-BLOCK element as Org syntax.
1390 CONTENTS is the contents of the element."
1394 ;;;; Section
1397 "Parse a section.
1399 LIMIT bounds the search.
1401 Return a list whose CAR is `section' and CDR is a plist
1402 containing `:begin', `:end', `:contents-begin', `contents-end'
1403 and `:post-blank' keywords."
1405 ;; Beginning of section is the beginning of the first non-blank
1406 ;; line after previous headline.
1415 :end end
1416 :contents-begin begin
1417 :contents-end pos-before-blank
1421 "Interpret SECTION element as Org syntax.
1422 CONTENTS is the contents of the element."
1423 contents)
1426 ;;;; Special Block
1429 "Parse a special block.
1431 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1432 the buffer position at the beginning of the first affiliated
1433 keyword and CDR is a plist of affiliated keywords along with
1434 their value.
1436 Return a list whose CAR is `special-block' and CDR is a plist
1437 containing `:type', `:begin', `:end', `:hiddenp',
1438 `:contents-begin', `:contents-end', `:post-blank' and
1439 `:post-affiliated' keywords.
1441 Assume point is at the beginning of the block."
1448 limit t)))
1449 ;; Incomplete block: parse it as a paragraph.
1455 ;; Empty blocks have no contents.
1469 :begin begin
1470 :end end
1471 :hiddenp hidden
1472 :contents-begin contents-begin
1473 :contents-end contents-end
1479 "Interpret SPECIAL-BLOCK element as Org syntax.
1480 CONTENTS is the contents of the element."
1485 \f
1486 ;;; Elements
1487 ;;
1488 ;; For each element, a parser and an interpreter are also defined.
1489 ;; Both follow the same naming convention used for greater elements.
1490 ;;
1491 ;; Also, as for greater elements, adding a new element type is done
1492 ;; through the following steps: implement a parser and an interpreter,
1493 ;; tweak `org-element--current-element' so that it recognizes the new
1494 ;; type and add that new type to `org-element-all-elements'.
1495 ;;
1496 ;; As a special case, when the newly defined type is a block type,
1497 ;; `org-element-block-name-alist' has to be modified accordingly.
1500 ;;;; Babel Call
1503 "Parse a babel call.
1505 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1506 the buffer position at the beginning of the first affiliated
1507 keyword and CDR is a plist of affiliated keywords along with
1508 their value.
1510 Return a list whose CAR is `babel-call' and CDR is a plist
1511 containing `:begin', `:end', `:info', `:post-blank' and
1512 `:post-affiliated' as keywords."
1525 :end end
1526 :info info
1532 "Interpret BABEL-CALL element as Org syntax.
1533 CONTENTS is nil."
1539 ;; Remove redundant square brackets.
1544 ;;;; Clock
1547 "Parse a clock.
1549 LIMIT bounds the search.
1551 Return a list whose CAR is `clock' and CDR is a plist containing
1552 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1553 as keywords."
1573 :value value
1574 :duration duration
1575 :begin begin
1576 :end end
1580 "Interpret CLOCK element as Org syntax.
1581 CONTENTS is nil."
1589 "%2s:%02s"
1593 ;;;; Comment
1596 "Parse a comment.
1598 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1599 the buffer position at the beginning of the first affiliated
1600 keyword and CDR is a plist of affiliated keywords along with
1601 their value.
1603 Return a list whose CAR is `comment' and CDR is a plist
1604 containing `:begin', `:end', `:value', `:post-blank',
1605 `:post-affiliated' keywords.
1607 Assume point is at comment beginning."
1616 ;; Get comments ending.
1619 ;; Accumulate lines without leading hash and first
1620 ;; whitespace.
1634 :end end
1635 :value value
1641 "Interpret COMMENT element as Org syntax.
1642 CONTENTS is nil."
1646 ;;;; Comment Block
1649 "Parse an export block.
1651 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1652 the buffer position at the beginning of the first affiliated
1653 keyword and CDR is a plist of affiliated keywords along with
1654 their value.
1656 Return a list whose CAR is `comment-block' and CDR is a plist
1657 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1658 and `:post-affiliated' keywords.
1660 Assume point is at comment block beginning."
1664 ;; Incomplete block: parse it as a paragraph.
1678 contents-begin contents-end)))
1682 :end end
1683 :value value
1684 :hiddenp hidden
1690 "Interpret COMMENT-BLOCK element as Org syntax.
1691 CONTENTS is nil."
1696 ;;;; Diary Sexp
1699 "Parse a diary sexp.
1701 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1702 the buffer position at the beginning of the first affiliated
1703 keyword and CDR is a plist of affiliated keywords along with
1704 their value.
1706 Return a list whose CAR is `diary-sexp' and CDR is a plist
1707 containing `:begin', `:end', `:value', `:post-blank' and
1708 `:post-affiliated' keywords."
1720 :begin begin
1721 :end end
1727 "Interpret DIARY-SEXP as Org syntax.
1728 CONTENTS is nil."
1732 ;;;; Example Block
1735 "Remove maximum common indentation in string S and return it.
1736 When optional argument N is a positive integer, remove exactly
1737 that much characters from indentation, if possible, or return
1738 S as-is otherwise. Unlike to `org-remove-indentation', this
1739 function doesn't call `untabify' on S."
1744 ;; Find maximum common indentation, if not specified.
1752 min-ind)))
1754 ;; Remove exactly N indentation, but give up if not possible.
1764 "Parse an example block.
1766 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1767 the buffer position at the beginning of the first affiliated
1768 keyword and CDR is a plist of affiliated keywords along with
1769 their value.
1771 Return a list whose CAR is `example-block' and CDR is a plist
1772 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1773 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1774 `:switches', `:value', `:post-blank' and `:post-affiliated'
1775 keywords."
1779 ;; Incomplete block: parse it as a paragraph.
1787 ;; Switches analysis
1795 ;; Should labels be retained in (or stripped from) example
1796 ;; blocks?
1801 ;; What should code-references use - labels or
1802 ;; line-numbers?
1811 ;; Standard block parsing.
1820 contents-begin contents-end))
1830 :end end
1831 :value value
1832 :switches switches
1833 :number-lines number-lines
1834 :preserve-indent preserve-indent
1835 :retain-labels retain-labels
1836 :use-labels use-labels
1837 :label-fmt label-fmt
1838 :hiddenp hidden
1844 "Interpret EXAMPLE-BLOCK element as Org syntax.
1845 CONTENTS is nil."
1853 ;;;; Export Block
1856 "Parse an export block.
1858 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1859 the buffer position at the beginning of the first affiliated
1860 keyword and CDR is a plist of affiliated keywords along with
1861 their value.
1863 Return a list whose CAR is `export-block' and CDR is a plist
1864 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1865 `:post-blank' and `:post-affiliated' keywords.
1867 Assume point is at export-block beginning."
1874 ;; Incomplete block: parse it as a paragraph.
1888 contents-end)))
1892 :end end
1893 :type type
1894 :value value
1895 :hiddenp hidden
1901 "Interpret EXPORT-BLOCK element as Org syntax.
1902 CONTENTS is nil."
1909 ;;;; Fixed-width
1912 "Parse a fixed-width section.
1914 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1915 the buffer position at the beginning of the first affiliated
1916 keyword and CDR is a plist of affiliated keywords along with
1917 their value.
1919 Return a list whose CAR is `fixed-width' and CDR is a plist
1920 containing `:begin', `:end', `:value', `:post-blank' and
1921 `:post-affiliated' keywords.
1923 Assume point is at the beginning of the fixed-width area."
1927 value
1932 ;; Accumulate text without starting colons.
1945 :end end
1946 :value value
1952 "Interpret FIXED-WIDTH element as Org syntax.
1953 CONTENTS is nil."
1961 ;;;; Horizontal Rule
1964 "Parse an horizontal rule.
1966 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1967 the buffer position at the beginning of the first affiliated
1968 keyword and CDR is a plist of affiliated keywords along with
1969 their value.
1971 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1972 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1973 keywords."
1983 :end end
1989 "Interpret HORIZONTAL-RULE element as Org syntax.
1990 CONTENTS is nil."
1994 ;;;; Keyword
1997 "Parse a keyword at point.
1999 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2000 the buffer position at the beginning of the first affiliated
2001 keyword and CDR is a plist of affiliated keywords along with
2002 their value.
2004 Return a list whose CAR is `keyword' and CDR is a plist
2005 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2006 `:post-affiliated' keywords."
2020 :value value
2021 :begin begin
2022 :end end
2028 "Interpret KEYWORD element as Org syntax.
2029 CONTENTS is nil."
2035 ;;;; Latex Environment
2038 "Parse a LaTeX environment.
2040 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2041 the buffer position at the beginning of the first affiliated
2042 keyword and CDR is a plist of affiliated keywords along with
2043 their value.
2045 Return a list whose CAR is `latex-environment' and CDR is a plist
2046 containing `:begin', `:end', `:value', `:post-blank' and
2047 `:post-affiliated' keywords.
2049 Assume point is at the beginning of the latex environment."
2056 limit t))
2057 ;; Incomplete latex environment: parse it as a paragraph.
2067 :end end
2068 :value value
2074 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2075 CONTENTS is nil."
2079 ;;;; Node Property
2082 "Parse a node-property at point.
2084 LIMIT bounds the search.
2086 Return a list whose CAR is `node-property' and CDR is a plist
2087 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2088 keywords."
2100 :value value
2101 :begin begin
2102 :end end
2106 "Interpret NODE-PROPERTY element as Org syntax.
2107 CONTENTS is nil."
2113 ;;;; Paragraph
2116 "Parse a paragraph.
2118 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2119 the buffer position at the beginning of the first affiliated
2120 keyword and CDR is a plist of affiliated keywords along with
2121 their value.
2123 Return a list whose CAR is `paragraph' and CDR is a plist
2124 containing `:begin', `:end', `:contents-begin' and
2125 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2127 Assume point is at the beginning of the paragraph."
2136 limit
2137 ;; A matching `org-element-paragraph-separate' is not
2138 ;; necessarily the end of the paragraph. In
2139 ;; particular, lines starting with # or : as a first
2140 ;; non-space character are ambiguous. We have check
2141 ;; if they are valid Org syntax (i.e. not an
2142 ;; incomplete keyword).
2146 ;; There's no ambiguity for other symbols or
2147 ;; empty lines: stop here.
2149 ;; Stop at valid fixed-width areas.
2151 ;; Stop at drawers.
2156 ;; Stop at valid comments.
2158 ;; Stop at valid dynamic blocks.
2163 ;; Stop at valid blocks.
2170 limit t)))
2171 ;; Stop at valid latex environments.
2179 limit t)))
2180 ;; Stop at valid keywords.
2182 ;; Skip everything else.
2199 :end end
2200 :contents-begin contents-begin
2201 :contents-end contents-end
2207 "Interpret PARAGRAPH element as Org syntax.
2208 CONTENTS is the contents of the element."
2209 contents)
2212 ;;;; Planning
2215 "Parse a planning.
2217 LIMIT bounds the search.
2219 Return a list whose CAR is `planning' and CDR is a plist
2220 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2221 and `:post-blank' keywords."
2231 closed deadline scheduled)
2243 :deadline deadline
2244 :scheduled scheduled
2245 :begin begin
2246 :end end
2250 "Interpret PLANNING element as Org syntax.
2251 CONTENTS is nil."
2253 'identity
2270 ;;;; Quote Section
2273 "Parse a quote section.
2275 LIMIT bounds the search.
2277 Return a list whose CAR is `quote-section' and CDR is a plist
2278 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2280 Assume point is at beginning of the section."
2291 :end end
2292 :value value
2296 "Interpret QUOTE-SECTION element as Org syntax.
2297 CONTENTS is nil."
2301 ;;;; Src Block
2304 "Parse a src block.
2306 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2307 the buffer position at the beginning of the first affiliated
2308 keyword and CDR is a plist of affiliated keywords along with
2309 their value.
2311 Return a list whose CAR is `src-block' and CDR is a plist
2312 containing `:language', `:switches', `:parameters', `:begin',
2313 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2314 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2315 `:post-blank' and `:post-affiliated' keywords.
2317 Assume point is at the beginning of the block."
2320 limit t)))
2321 ;; Incomplete block: parse it as a paragraph.
2327 ;; Get language as a string.
2336 ;; Get switches.
2338 ;; Get parameters.
2340 ;; Switches analysis
2352 ;; Should labels be retained in (or stripped from)
2353 ;; src blocks?
2358 ;; What should code-references use - labels or
2359 ;; line-numbers?
2364 ;; Indentation.
2366 ;; Get visibility status.
2368 ;; Retrieve code.
2377 ;; Get position after ending blank lines.
2387 :begin begin
2388 :end end
2389 :number-lines number-lines
2390 :preserve-indent preserve-indent
2391 :retain-labels retain-labels
2392 :use-labels use-labels
2393 :label-fmt label-fmt
2394 :hiddenp hidden
2395 :value value
2401 "Interpret SRC-BLOCK element as Org syntax.
2402 CONTENTS is nil."
2423 ;;;; Table
2426 "Parse a table at point.
2428 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2429 the buffer position at the beginning of the first affiliated
2430 keyword and CDR is a plist of affiliated keywords along with
2431 their value.
2433 Return a list whose CAR is `table' and CDR is a plist containing
2434 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2435 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2436 keywords.
2438 Assume point is at the beginning of the table."
2452 acc))
2459 :end end
2460 :type type
2461 :tblfm tblfm
2462 ;; Only `org' tables have contents. `table.el' tables
2463 ;; use a `:value' property to store raw table as
2464 ;; a string.
2469 table-begin table-end))
2475 "Interpret TABLE element as Org syntax.
2476 CONTENTS is nil."
2487 ;;;; Table Row
2490 "Parse table row at point.
2492 LIMIT bounds the search.
2494 Return a list whose CAR is `table-row' and CDR is a plist
2495 containing `:begin', `:end', `:contents-begin', `:contents-end',
2496 `:type' and `:post-blank' keywords."
2500 ;; A table rule has no contents. In that case, ensure
2501 ;; CONTENTS-BEGIN matches CONTENTS-END.
2513 :begin begin
2514 :end end
2515 :contents-begin contents-begin
2516 :contents-end contents-end
2520 "Interpret TABLE-ROW element as Org syntax.
2521 CONTENTS is the contents of the table row."
2526 ;;;; Verse Block
2529 "Parse a verse block.
2531 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2532 the buffer position at the beginning of the first affiliated
2533 keyword and CDR is a plist of affiliated keywords along with
2534 their value.
2536 Return a list whose CAR is `verse-block' and CDR is a plist
2537 containing `:begin', `:end', `:contents-begin', `:contents-end',
2538 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2540 Assume point is at beginning of the block."
2544 ;; Incomplete block: parse it as a paragraph.
2560 :end end
2561 :contents-begin contents-begin
2562 :contents-end contents-end
2563 :hiddenp hidden
2569 "Interpret VERSE-BLOCK element as Org syntax.
2570 CONTENTS is verse block contents."
2574 \f
2575 ;;; Objects
2576 ;;
2577 ;; Unlike to elements, interstices can be found between objects.
2578 ;; That's why, along with the parser, successor functions are provided
2579 ;; for each object. Some objects share the same successor (i.e. `code'
2580 ;; and `verbatim' objects).
2581 ;;
2582 ;; A successor must accept a single argument bounding the search. It
2583 ;; will return either a cons cell whose CAR is the object's type, as
2584 ;; a symbol, and CDR the position of its next occurrence, or nil.
2585 ;;
2586 ;; Successors follow the naming convention:
2587 ;; org-element-NAME-successor, where NAME is the name of the
2588 ;; successor, as defined in `org-element-all-successors'.
2589 ;;
2590 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2591 ;; object types they can contain will be specified in
2592 ;; `org-element-object-restrictions'.
2593 ;;
2594 ;; Adding a new type of object is simple. Implement a successor,
2595 ;; a parser, and an interpreter for it, all following the naming
2596 ;; convention. Register type in `org-element-all-objects' and
2597 ;; successor in `org-element-all-successors'. Maybe tweak
2598 ;; restrictions about it, and that's it.
2601 ;;;; Bold
2604 "Parse bold object at point.
2606 Return a list whose CAR is `bold' and CDR is a plist with
2607 `:begin', `:end', `:contents-begin' and `:contents-end' and
2608 `:post-blank' keywords.
2610 Assume point is at the first star marker."
2622 :end end
2623 :contents-begin contents-begin
2624 :contents-end contents-end
2628 "Interpret BOLD object as Org syntax.
2629 CONTENTS is the contents of the object."
2633 "Search for the next text-markup object.
2635 Return value is a cons cell whose CAR is a symbol among `bold',
2636 `italic', `underline', `strike-through', `code' and `verbatim'
2637 and CDR is beginning position."
2653 ;;;; Code
2656 "Parse code object at point.
2658 Return a list whose CAR is `code' and CDR is a plist with
2659 `:value', `:begin', `:end' and `:post-blank' keywords.
2661 Assume point is at the first tilde marker."
2672 :begin begin
2673 :end end
2677 "Interpret CODE object as Org syntax.
2678 CONTENTS is nil."
2682 ;;;; Entity
2685 "Parse entity at point.
2687 Return a list whose CAR is `entity' and CDR a plist with
2688 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2689 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2690 keywords.
2692 Assume point is at the beginning of the entity."
2694 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2710 :begin begin
2711 :end end
2712 :use-brackets-p bracketsp
2716 "Interpret ENTITY object as Org syntax.
2717 CONTENTS is nil."
2723 "Search for the next latex-fragment or entity object.
2725 Return value is a cons cell whose CAR is `entity' or
2726 `latex-fragment' and CDR is beginning position."
2730 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2737 ;; Determine if it's a real entity or a LaTeX command.
2740 ;; No entity nor command: point is at a LaTeX fragment.
2741 ;; Determine its type to get the correct beginning position.
2750 ;;;; Export Snippet
2753 "Parse export snippet at point.
2755 Return a list whose CAR is `export-snippet' and CDR a plist with
2756 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2757 keywords.
2759 Assume point is at the beginning of the snippet."
2771 :value value
2772 :begin begin
2773 :end end
2777 "Interpret EXPORT-SNIPPET object as Org syntax.
2778 CONTENTS is nil."
2784 "Search for the next export-snippet object.
2786 Return value is a cons cell whose CAR is `export-snippet' and CDR
2787 its beginning position."
2796 ;;;; Footnote Reference
2799 "Parse footnote reference at point.
2801 Return a list whose CAR is `footnote-reference' and CDR a plist
2802 with `:label', `:type', `:inline-definition', `:begin', `:end'
2803 and `:post-blank' as keywords."
2825 :type type
2826 :begin begin
2827 :end end
2830 footnote-reference :inline-definition
2835 footnote-reference))))))
2838 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2839 CONTENTS is nil."
2849 "Search for the next footnote-reference object.
2851 Return value is a cons cell whose CAR is `footnote-reference' and
2852 CDR is beginning position."
2866 ;;;; Inline Babel Call
2869 "Parse inline babel call at point.
2871 Return a list whose CAR is `inline-babel-call' and CDR a plist
2872 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2874 Assume point is at the beginning of the babel call."
2885 :end end
2886 :info info
2890 "Interpret INLINE-BABEL-CALL object as Org syntax.
2891 CONTENTS is nil."
2897 ;; Remove redundant square brackets.
2900 main-source)
2904 "Search for the next inline-babel-call object.
2906 Return value is a cons cell whose CAR is `inline-babel-call' and
2907 CDR is beginning position."
2909 ;; Use a simplified version of
2910 ;; `org-babel-inline-lob-one-liner-regexp'.
2913 nil t)
2917 ;;;; Inline Src Block
2920 "Parse inline source block at point.
2922 Return a list whose CAR is `inline-src-block' and CDR a plist
2923 with `:begin', `:end', `:language', `:value', `:parameters' and
2924 `:post-blank' as keywords.
2926 Assume point is at the beginning of the inline src block."
2939 :value value
2940 :parameters parameters
2941 :begin begin
2942 :end end
2946 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2947 CONTENTS is nil."
2952 language
2954 body)))
2957 "Search for the next inline-babel-call element.
2959 Return value is a cons cell whose CAR is `inline-babel-call' and
2960 CDR is beginning position."
2966 ;;;; Italic
2969 "Parse italic object at point.
2971 Return a list whose CAR is `italic' and CDR is a plist with
2972 `:begin', `:end', `:contents-begin' and `:contents-end' and
2973 `:post-blank' keywords.
2975 Assume point is at the first slash marker."
2987 :end end
2988 :contents-begin contents-begin
2989 :contents-end contents-end
2993 "Interpret ITALIC object as Org syntax.
2994 CONTENTS is the contents of the object."
2998 ;;;; Latex Fragment
3001 "Parse LaTeX fragment at point.
3003 Return a list whose CAR is `latex-fragment' and CDR a plist with
3004 `:value', `:begin', `:end', and `:post-blank' as keywords.
3006 Assume point is at the beginning of the LaTeX fragment."
3019 ;; None found: it's a macro.
3028 :begin begin
3029 :end end
3033 "Interpret LATEX-FRAGMENT object as Org syntax.
3034 CONTENTS is nil."
3037 ;;;; Line Break
3040 "Parse line break at point.
3042 Return a list whose CAR is `line-break', and CDR a plist with
3043 `:begin', `:end' and `:post-blank' keywords.
3045 Assume point is at the beginning of the line break."
3052 "Interpret LINE-BREAK object as Org syntax.
3053 CONTENTS is nil."
3057 "Search for the next line-break object.
3059 Return value is a cons cell whose CAR is `line-break' and CDR is
3060 beginning position."
3064 ;; A line break can only happen on a non-empty line.
3069 ;;;; Link
3072 "Parse link at point.
3074 Return a list whose CAR is `link' and CDR a plist with `:type',
3075 `:path', `:raw-link', `:application', `:search-option', `:begin',
3076 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3077 keywords.
3079 Assume point is at the beginning of the link."
3082 end contents-begin contents-end link-end post-blank path type
3083 raw-link link search-option application)
3085 ;; Type 1: Text targeted from a radio target.
3090 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3095 ;; RAW-LINK is the original link. Expand any
3096 ;; abbreviation in it.
3100 ;; Determine TYPE of link and set PATH accordingly.
3102 ;; File type.
3106 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3109 ;; Id type: PATH is the id.
3112 ;; Code-ref type: PATH is the name of the reference.
3115 ;; Custom-id type: PATH is the name of the custom id.
3118 ;; Fuzzy type: Internal link either matches a target, an
3119 ;; headline name or nothing. PATH is the target or
3120 ;; headline's name.
3122 ;; Type 3: Plain link, i.e. http://orgmode.org
3128 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3135 ;; In any case, deduce end point after trailing white space from
3136 ;; LINK-END variable.
3139 ;; Extract search option and opening application out of
3140 ;; "file"-type links.
3142 ;; Application.
3147 ;; Extract search option from PATH.
3151 ;; Make sure TYPE always reports "file".
3155 :path path
3157 :application application
3158 :search-option search-option
3159 :begin begin
3160 :end end
3161 :contents-begin contents-begin
3162 :contents-end contents-end
3166 "Interpret LINK object as Org syntax.
3167 CONTENTS is the contents of the object, or nil."
3172 raw-link
3176 "Search for the next link object.
3178 Return value is a cons cell whose CAR is `link' and CDR is
3179 beginning position."
3188 "Search for the next plain link object.
3190 Return value is a cons cell whose CAR is `link' and CDR is
3191 beginning position."
3196 ;;;; Macro
3199 "Parse macro at point.
3201 Return a list whose CAR is `macro' and CDR a plist with `:key',
3202 `:args', `:begin', `:end', `:value' and `:post-blank' as
3203 keywords.
3205 Assume point is at the macro."
3216 ;; Do not use `org-split-string' since empty
3217 ;; strings are meaningful here.
3225 args nil t)
3229 :value value
3230 :args args
3231 :begin begin
3232 :end end
3236 "Interpret MACRO object as Org syntax.
3237 CONTENTS is nil."
3241 "Search for the next macro object.
3243 Return value is cons cell whose CAR is `macro' and CDR is
3244 beginning position."
3248 nil t)
3252 ;;;; Radio-target
3255 "Parse radio target at point.
3257 Return a list whose CAR is `radio-target' and CDR a plist with
3258 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3259 and `:post-blank' as keywords.
3261 Assume point is at the radio target."
3273 :end end
3274 :contents-begin contents-begin
3275 :contents-end contents-end
3276 :post-blank post-blank
3280 "Interpret TARGET object as Org syntax.
3281 CONTENTS is the contents of the object."
3285 "Search for the next radio-target object.
3287 Return value is a cons cell whose CAR is `radio-target' and CDR
3288 is beginning position."
3294 ;;;; Statistics Cookie
3297 "Parse statistics cookie at point.
3299 Return a list whose CAR is `statistics-cookie', and CDR a plist
3300 with `:begin', `:end', `:value' and `:post-blank' keywords.
3302 Assume point is at the beginning of the statistics-cookie."
3313 :end end
3314 :value value
3318 "Interpret STATISTICS-COOKIE object as Org syntax.
3319 CONTENTS is nil."
3323 "Search for the next statistics cookie object.
3325 Return value is a cons cell whose CAR is `statistics-cookie' and
3326 CDR is beginning position."
3332 ;;;; Strike-Through
3335 "Parse strike-through object at point.
3337 Return a list whose CAR is `strike-through' and CDR is a plist
3338 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3339 `:post-blank' keywords.
3341 Assume point is at the first plus sign marker."
3353 :end end
3354 :contents-begin contents-begin
3355 :contents-end contents-end
3359 "Interpret STRIKE-THROUGH object as Org syntax.
3360 CONTENTS is the contents of the object."
3364 ;;;; Subscript
3367 "Parse subscript at point.
3369 Return a list whose CAR is `subscript' and CDR a plist with
3370 `:begin', `:end', `:contents-begin', `:contents-end',
3371 `:use-brackets-p' and `:post-blank' as keywords.
3373 Assume point is at the underscore."
3377 t
3388 :end end
3389 :use-brackets-p bracketsp
3390 :contents-begin contents-begin
3391 :contents-end contents-end
3395 "Interpret SUBSCRIPT object as Org syntax.
3396 CONTENTS is the contents of the object."
3399 contents))
3402 "Search for the next sub/superscript object.
3404 Return value is a cons cell whose CAR is either `subscript' or
3405 `superscript' and CDR is beginning position."
3413 ;;;; Superscript
3416 "Parse superscript at point.
3418 Return a list whose CAR is `superscript' and CDR a plist with
3419 `:begin', `:end', `:contents-begin', `:contents-end',
3420 `:use-brackets-p' and `:post-blank' as keywords.
3422 Assume point is at the caret."
3436 :end end
3437 :use-brackets-p bracketsp
3438 :contents-begin contents-begin
3439 :contents-end contents-end
3443 "Interpret SUPERSCRIPT object as Org syntax.
3444 CONTENTS is the contents of the object."
3447 contents))
3450 ;;;; Table Cell
3453 "Parse table cell at point.
3455 Return a list whose CAR is `table-cell' and CDR is a plist
3456 containing `:begin', `:end', `:contents-begin', `:contents-end'
3457 and `:post-blank' keywords."
3465 :end end
3466 :contents-begin contents-begin
3467 :contents-end contents-end
3471 "Interpret TABLE-CELL element as Org syntax.
3472 CONTENTS is the contents of the cell, or nil."
3476 "Search for the next table-cell object.
3478 Return value is a cons cell whose CAR is `table-cell' and CDR is
3479 beginning position."
3483 ;;;; Target
3486 "Parse target at point.
3488 Return a list whose CAR is `target' and CDR a plist with
3489 `:begin', `:end', `:value' and `:post-blank' as keywords.
3491 Assume point is at the target."
3501 :end end
3502 :value value
3506 "Interpret TARGET object as Org syntax.
3507 CONTENTS is nil."
3511 "Search for the next target object.
3513 Return value is a cons cell whose CAR is `target' and CDR is
3514 beginning position."
3520 ;;;; Timestamp
3523 "Parse time stamp at point.
3525 Return a list whose CAR is `timestamp', and CDR a plist with
3526 `:type', `:raw-value', `:year-start', `:month-start',
3527 `:day-start', `:hour-start', `:minute-start', `:year-end',
3528 `:month-end', `:day-end', `:hour-end', `:minute-end',
3529 `:repeater-type', `:repeater-value', `:repeater-unit',
3530 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3531 `:end', `:value' and `:post-blank' keywords.
3533 Assume point is at the beginning of the timestamp."
3551 date-start)
3562 raw-value)
3564 :repeater-type
3570 :repeater-unit
3579 :warning-unit
3582 year-start month-start day-start hour-start minute-start year-end
3583 month-end day-end hour-end minute-end)
3584 ;; Parse date-start.
3592 ;; Compute date-end. It can be provided directly in time-stamp,
3593 ;; or extracted from time range. Otherwise, it defaults to the
3594 ;; same values as date-start.
3604 :raw-value raw-value
3605 :year-start year-start
3606 :month-start month-start
3607 :day-start day-start
3608 :hour-start hour-start
3609 :minute-start minute-start
3610 :year-end year-end
3611 :month-end month-end
3612 :day-end day-end
3613 :hour-end hour-end
3614 :minute-end minute-end
3615 :begin begin
3616 :end end
3618 repeater-props
3619 warning-props)))))
3622 "Interpret TIMESTAMP object as Org syntax.
3623 CONTENTS is nil."
3624 ;; Use `:raw-value' if specified.
3626 ;; Otherwise, build timestamp string.
3645 ;; Build an Org timestamp string from TIME. ACTIVEP is
3646 ;; non-nil when time stamp is active. If WITH-TIME-P is
3647 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3648 ;; specify a time range in the timestamp. REPEAT-STRING
3649 ;; is the repeater string, if any.
3653 org-time-stamp-formats)
3654 time)))
3660 nil nil ts)))
3665 " "
3666 s
3668 ;; Return value.
3669 ts)))
3681 build-ts-string
3700 0
3708 "--"
3720 "Search for the next timestamp object.
3722 Return value is a cons cell whose CAR is `timestamp' and CDR is
3723 beginning position."
3731 nil t)
3735 ;;;; Underline
3738 "Parse underline object at point.
3740 Return a list whose CAR is `underline' and CDR is a plist with
3741 `:begin', `:end', `:contents-begin' and `:contents-end' and
3742 `:post-blank' keywords.
3744 Assume point is at the first underscore marker."
3756 :end end
3757 :contents-begin contents-begin
3758 :contents-end contents-end
3762 "Interpret UNDERLINE object as Org syntax.
3763 CONTENTS is the contents of the object."
3767 ;;;; Verbatim
3770 "Parse verbatim object at point.
3772 Return a list whose CAR is `verbatim' and CDR is a plist with
3773 `:value', `:begin', `:end' and `:post-blank' keywords.
3775 Assume point is at the first equal sign marker."
3786 :begin begin
3787 :end end
3791 "Interpret VERBATIM object as Org syntax.
3792 CONTENTS is nil."
3796 \f
3797 ;;; Parsing Element Starting At Point
3798 ;;
3799 ;; `org-element--current-element' is the core function of this section.
3800 ;; It returns the Lisp representation of the element starting at
3801 ;; point.
3802 ;;
3803 ;; `org-element--current-element' makes use of special modes. They
3804 ;; are activated for fixed element chaining (i.e. `plain-list' >
3805 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3806 ;; `section'). Special modes are: `first-section', `item',
3807 ;; `node-property', `quote-section', `section' and `table-row'.
3811 "Parse the element starting at point.
3813 Return value is a list like (TYPE PROPS) where TYPE is the type
3814 of the element and PROPS a plist of properties associated to the
3815 element.
3817 Possible types are defined in `org-element-all-elements'.
3819 LIMIT bounds the search.
3821 Optional argument GRANULARITY determines the depth of the
3822 recursion. Allowed values are `headline', `greater-element',
3823 `element', `object' or nil. When it is broader than `object' (or
3824 nil), secondary values will not be parsed, since they only
3825 contain objects.
3827 Optional argument SPECIAL, when non-nil, can be either
3828 `first-section', `item', `node-property', `quote-section',
3829 `section', and `table-row'.
3831 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3832 be computed.
3834 This function assumes point is always at the beginning of the
3835 element it has to parse."
3838 ;; Determine if parsing depth allows for secondary strings
3839 ;; parsing. It only applies to elements referenced in
3840 ;; `org-element-secondary-value-alist'.
3843 ;; Item.
3846 ;; Table Row.
3848 ;; Node Property.
3850 ;; Headline.
3853 ;; Sections (must be checked after headline).
3859 limit)))
3860 ;; When not at bol, point is at the beginning of an item or
3861 ;; a footnote definition: next item is always a paragraph.
3863 ;; Planning and Clock.
3868 ;; Inlinetask.
3871 ;; From there, elements can have affiliated keywords.
3874 ;; Jumping over affiliated keywords put point off-limits.
3875 ;; Parse them as regular keywords.
3879 ;; LaTeX Environment.
3883 ;; Drawer and Property Drawer.
3888 ;; Fixed Width
3891 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3892 ;; Keywords.
3901 org-element-block-name-alist)))
3916 ;; Footnote Definition.
3919 ;; Horizontal Rule.
3922 ;; Diary Sexp.
3925 ;; Table.
3927 ;; List.
3930 limit affiliated
3932 ;; Default element: Paragraph.
3936 ;; Most elements can have affiliated keywords. When looking for an
3937 ;; element beginning, we want to move before them, as they belong to
3938 ;; that element, and, in the meantime, collect information they give
3939 ;; into appropriate properties. Hence the following function.
3942 "Collect affiliated keywords from point down to LIMIT.
3944 Return a list whose CAR is the position at the first of them and
3945 CDR a plist of keywords and values and move point to the
3946 beginning of the first line after them.
3948 As a special case, if element doesn't start at the beginning of
3949 the line (i.e. a paragraph starting an item), CAR is current
3950 position of point and CDR is nil."
3954 ;; RESTRICT is the list of objects allowed in parsed
3955 ;; keywords value.
3957 output)
3960 ;; Apply translation to RAW-KWD. From there, KWD is
3961 ;; the official keyword.
3963 org-element-keyword-translation-alist))
3964 raw-kwd))
3965 ;; Find main value for any keyword.
3971 ;; PARSEDP is non-nil when keyword should have its
3972 ;; value parsed.
3974 ;; If KWD is a dual keyword, find its secondary
3975 ;; value. Maybe parse it.
3982 ;; Attribute a property name to KWD.
3984 ;; Now set final shape for VALUE.
3990 ;; Attributes can always appear on multiple lines.
3993 ;; Eventually store the new value in OUTPUT.
3995 ;; Move to next keyword.
3997 ;; If affiliated keywords are orphaned: move back to first one.
3998 ;; They will be parsed as a paragraph.
4000 ;; Return value.
4004 \f
4005 ;;; The Org Parser
4006 ;;
4007 ;; The two major functions here are `org-element-parse-buffer', which
4008 ;; parses Org syntax inside the current buffer, taking into account
4009 ;; region, narrowing, or even visibility if specified, and
4010 ;; `org-element-parse-secondary-string', which parses objects within
4011 ;; a given string.
4012 ;;
4013 ;; The (almost) almighty `org-element-map' allows to apply a function
4014 ;; on elements or objects matching some type, and accumulate the
4015 ;; resulting values. In an export situation, it also skips unneeded
4016 ;; parts of the parse tree.
4019 "Recursively parse the buffer and return structure.
4020 If narrowing is in effect, only parse the visible part of the
4021 buffer.
4023 Optional argument GRANULARITY determines the depth of the
4024 recursion. It can be set to the following symbols:
4026 `headline' Only parse headlines.
4027 `greater-element' Don't recurse into greater elements excepted
4028 headlines and sections. Thus, elements
4029 parsed are the top-level ones.
4030 `element' Parse everything but objects and plain text.
4031 `object' Parse the complete buffer (default).
4033 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4034 elements.
4036 An element or an objects is represented as a list with the
4037 pattern (TYPE PROPERTIES CONTENTS), where :
4039 TYPE is a symbol describing the element or object. See
4040 `org-element-all-elements' and `org-element-all-objects' for an
4041 exhaustive list of such symbols. One can retrieve it with
4042 `org-element-type' function.
4044 PROPERTIES is the list of attributes attached to the element or
4045 object, as a plist. Although most of them are specific to the
4046 element or object type, all types share `:begin', `:end',
4047 `:post-blank' and `:parent' properties, which respectively
4048 refer to buffer position where the element or object starts,
4049 ends, the number of white spaces or blank lines after it, and
4050 the element or object containing it. Properties values can be
4051 obtained by using `org-element-property' function.
4053 CONTENTS is a list of elements, objects or raw strings
4054 contained in the current element or object, when applicable.
4055 One can access them with `org-element-contents' function.
4057 The Org buffer has `org-data' as type and nil as properties.
4058 `org-element-map' function can be used to find specific elements
4059 or objects within the parse tree.
4061 This function assumes that current major mode is `org-mode'."
4067 ;; Start in `first-section' mode so text before the first
4068 ;; headline belongs to a section.
4072 "Recursively parse objects in STRING and return structure.
4074 RESTRICTION is a symbol limiting the object types that will be
4075 looked after.
4077 Optional argument PARENT, when non-nil, is the element or object
4078 containing the secondary string. It is used to set correctly
4079 `:parent' property within the string."
4080 ;; Copy buffer-local variables listed in
4081 ;; `org-element-object-variables' into temporary buffer. This is
4082 ;; required since object parsing is dependent on these variables.
4086 org-element-object-variables))))
4094 secondary))
4095 secondary))))
4099 "Map a function on selected elements or objects.
4101 DATA is a parse tree, an element, an object, a string, or a list
4102 of such constructs. TYPES is a symbol or list of symbols of
4103 elements or objects types (see `org-element-all-elements' and
4104 `org-element-all-objects' for a complete list of types). FUN is
4105 the function called on the matching element or object. It has to
4106 accept one argument: the element or object itself.
4108 When optional argument INFO is non-nil, it should be a plist
4109 holding export options. In that case, parts of the parse tree
4110 not exportable according to that property list will be skipped.
4112 When optional argument FIRST-MATCH is non-nil, stop at the first
4113 match for which FUN doesn't return nil, and return that value.
4115 Optional argument NO-RECURSION is a symbol or a list of symbols
4116 representing elements or objects types. `org-element-map' won't
4117 enter any recursive element or object whose type belongs to that
4118 list. Though, FUN can still be applied on them.
4120 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4121 apply to matching objects within parsed affiliated keywords (see
4122 `org-element-parsed-keywords').
4124 Nil values returned from FUN do not appear in the results.
4127 Examples:
4128 ---------
4130 Assuming TREE is a variable containing an Org buffer parse tree,
4131 the following example will return a flat list of all `src-block'
4132 and `example-block' elements in it:
4134 \(org-element-map tree '(example-block src-block) 'identity)
4136 The following snippet will find the first headline with a level
4139 \(org-element-map tree 'headline
4140 \(lambda (hl)
4141 \(and (= (org-element-property :level hl) 1)
4143 \(org-element-property :begin hl)))
4144 nil t)
4146 The next example will return a flat list of all `plain-list' type
4147 elements in TREE that are not a sub-list themselves:
4149 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4151 Eventually, this example will return a flat list of all `bold'
4152 type objects containing a `latex-snippet' type object, even
4153 looking into captions:
4155 \(org-element-map tree 'bold
4156 \(lambda (b)
4157 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4158 nil nil nil t)"
4159 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4162 ;; Recursion depth is determined by --CATEGORY.
4169 ;; If one object is found, the function
4170 ;; has to recurse into every object.
4173 ;; If one regular element is found, the
4174 ;; function has to recurse, at least,
4175 ;; into every element it encounters.
4178 types)
4179 category)))
4180 ;; Compute properties for affiliated keywords if necessary.
4185 org-element-affiliated-keywords)))
4186 --acc
4187 --walk-tree
4191 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4192 ;; holding contextual information.
4196 ;; Ignored element in an export context.
4198 ;; List of elements or objects.
4200 ;; Unconditionally enter parse trees.
4204 ;; Check if TYPE is matching among TYPES. If so,
4205 ;; apply FUN to --DATA and accumulate return value
4206 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4212 ;; If --DATA has a secondary string that can contain
4213 ;; objects with their type among TYPES, look into it.
4220 ;; If --DATA has any affiliated keywords and
4221 ;; WITH-AFFILIATED is non-nil, look for objects in
4222 ;; them.
4230 ;; Pay attention to the type of value.
4231 ;; Preserve order for multiple keywords.
4247 --affiliated-alist))
4248 ;; Determine if a recursion into --DATA is possible.
4250 ;; --TYPE is explicitly removed from recursion.
4252 ;; --DATA has no contents.
4254 ;; Looking for greater elements but --DATA is simply
4255 ;; an element or an object.
4258 ;; Looking for elements but --DATA is an object.
4261 ;; In any other case, map contents.
4265 ;; Return value in a proper order.
4269 ;; The following functions are internal parts of the parser.
4270 ;;
4271 ;; The first one, `org-element--parse-elements' acts at the element's
4272 ;; level.
4273 ;;
4274 ;; The second one, `org-element--parse-objects' applies on all objects
4275 ;; of a paragraph or a secondary string. It uses
4276 ;; `org-element--get-next-object-candidates' to optimize the search of
4277 ;; the next object in the buffer.
4278 ;;
4279 ;; More precisely, that function looks for every allowed object type
4280 ;; first. Then, it discards failed searches, keeps further matches,
4281 ;; and searches again types matched behind point, for subsequent
4282 ;; calls. Thus, searching for a given type fails only once, and every
4283 ;; object is searched only once at top level (but sometimes more for
4284 ;; nested types).
4288 "Parse elements between BEG and END positions.
4290 SPECIAL prioritize some elements over the others. It can be set
4291 to `first-section', `quote-section', `section' `item' or
4292 `table-row'.
4294 When value is `item', STRUCTURE will be used as the current list
4295 structure.
4297 GRANULARITY determines the depth of the recursion. See
4298 `org-element-parse-buffer' for more information.
4300 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4301 elements.
4303 Elements are accumulated into ACC."
4306 ;; Visible only: skip invisible parts at the beginning of the
4307 ;; element.
4310 ;; When parsing only headlines, skip any text before first one.
4313 ;; Main loop start.
4315 ;; Find current element's type and parse it accordingly to
4316 ;; its category.
4318 end granularity special structure))
4322 ;; Visible only: skip invisible parts between siblings.
4325 ;; Fill ELEMENT contents by side-effect.
4327 ;; If element has no contents, don't modify it.
4329 ;; Greater element: parse it between `contents-begin' and
4330 ;; `contents-end'. Make sure GRANULARITY allows the
4331 ;; recursion, or ELEMENT is a headline, in which case going
4332 ;; inside is mandatory, in order to get sub-level headings.
4340 ;; Possibly switch to a special mode.
4350 granularity visible-only element))
4351 ;; ELEMENT has contents. Parse objects inside, if
4352 ;; GRANULARITY allows it.
4358 ;; Return result.
4359 acc))
4362 "Parse objects between BEG and END and return recursive structure.
4364 Objects are accumulated in ACC.
4366 RESTRICTION is a list of object successors which are allowed in
4367 the current object."
4376 restriction candidates)))
4383 ;; 1. Text before any object. Untabify it.
4388 acc
4392 ;; 2. Object...
4395 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4396 ;; a recursive type.
4404 ;; 3. Text after last object. Untabify it.
4408 acc
4412 ;; Result.
4413 acc))))
4416 "Return an alist of candidates for the next object.
4418 RESTRICTION is a list of object types, as symbols. Only
4419 candidates with such types are looked after.
4421 OBJECTS is the previous candidates alist. If it is set to
4422 `initial', no search has been done before, and all symbols in
4423 RESTRICTION should be looked after.
4425 Return value is an alist whose CAR is the object type and CDR its
4426 beginning position."
4428 nil
4430 ;; When searching for the first time, look for every successor
4431 ;; allowed in RESTRICTION.
4435 restriction)
4436 ;; Focus on objects returned during last search. Keep those
4437 ;; still after point. Search again objects before it.
4443 type)))
4446 objects))))
4449 \f
4450 ;;; Towards A Bijective Process
4451 ;;
4452 ;; The parse tree obtained with `org-element-parse-buffer' is really
4453 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4454 ;; interpreted and expanded into a string with canonical Org syntax.
4455 ;; Hence `org-element-interpret-data'.
4456 ;;
4457 ;; The function relies internally on
4458 ;; `org-element--interpret-affiliated-keywords'.
4460 ;;;###autoload
4462 "Interpret DATA as Org syntax.
4464 DATA is a parse tree, an element, an object or a secondary string
4465 to interpret.
4467 Optional argument PARENT is used for recursive calls. It contains
4468 the element or object containing data, or nil.
4470 Return Org syntax as a string."
4474 ;; Secondary string.
4479 ;; Full Org document.
4484 ;; Plain text: remove `:parent' text property from output.
4486 ;; Element/Object without contents.
4489 data nil))
4490 ;; Element/Object with contents.
4500 ;; Elements directly containing objects must
4501 ;; have their indentation normalized first.
4503 data
4504 ;; When normalizing first paragraph of an
4505 ;; item or a footnote-definition, ignore
4506 ;; first line's indentation.
4513 data
4515 contents)))))))
4517 ;; Build white spaces. If no `:post-blank' property is
4518 ;; specified, assume its value is 0.
4528 "Return ELEMENT's affiliated keywords as Org syntax.
4529 If there is no affiliated keyword, return the empty string."
4539 ": "
4542 value)
4550 ;; All attribute keywords can have multiple lines.
4556 ;; List all ELEMENT's properties matching an attribute line or an
4557 ;; affiliated keyword, but ignore translated keywords since they
4558 ;; cannot belong to the property list.
4565 org-element-keyword-translation-alist)))))
4566 collect prop)
4569 ;; Because interpretation of the parse tree must return the same
4570 ;; number of blank lines between elements and the same number of white
4571 ;; space after objects, some special care must be given to white
4572 ;; spaces.
4573 ;;
4574 ;; The first function, `org-element-normalize-string', ensures any
4575 ;; string different from the empty string will end with a single
4576 ;; newline character.
4577 ;;
4578 ;; The second function, `org-element-normalize-contents', removes
4579 ;; global indentation from the contents of the current element.
4582 "Ensure string S ends with a single newline character.
4584 If S isn't a string return it unchanged. If S is the empty
4585 string, return it. Otherwise, return a new string with a single
4586 newline character at its end."
4594 "Normalize plain text in ELEMENT's contents.
4596 ELEMENT must only contain plain text and objects.
4598 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4599 indentation to compute maximal common indentation.
4601 Return the normalized element that is element with global
4602 indentation removed from its contents. The function assumes that
4603 indentation is not done with TAB characters."
4605 collect-inds ; for byte-compiler
4608 ;; Return list of indentations within BLOB. This is done by
4609 ;; walking recursively BLOB and updating IND-LIST along the
4610 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4611 ;; been seen yet. It is required as this string is the only
4612 ;; one whose indentation doesn't happen after a newline
4613 ;; character.
4621 ;; An indentation of zero means no string will be
4622 ;; modified. Quit the process.
4628 ;; Avoid matching blank or empty lines.
4636 ;; Collect indentation list in ELEMENT. Possibly remove first
4637 ;; value if IGNORE-FIRST is non-nil.
4640 ;; Build ELEMENT back, replacing each string with the same
4641 ;; string minus common indentation.
4646 ;; Return BLOB with all its strings indentation
4647 ;; shortened from MCI white spaces. FIRST-FLAG is
4648 ;; non-nil when the first string hasn't been seen
4649 ;; yet.
4663 org-element-recursive-objects)
4667 blob))))
4671 \f
4672 ;;; The Toolbox
4673 ;;
4674 ;; The first move is to implement a way to obtain the smallest element
4675 ;; containing point. This is the job of `org-element-at-point'. It
4676 ;; basically jumps back to the beginning of section containing point
4677 ;; and moves, element after element, with
4678 ;; `org-element--current-element' until the container is found. Note:
4679 ;; When using `org-element-at-point', secondary values are never
4680 ;; parsed since the function focuses on elements, not on objects.
4681 ;;
4682 ;; At a deeper level, `org-element-context' lists all elements and
4683 ;; objects containing point.
4684 ;;
4685 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4686 ;; internally by navigation and manipulation tools.
4688 ;;;###autoload
4690 "Determine closest element around point.
4692 Return value is a list like (TYPE PROPS) where TYPE is the type
4693 of the element and PROPS a plist of properties associated to the
4694 element.
4696 Possible types are defined in `org-element-all-elements'.
4697 Properties depend on element or object type, but always include
4698 `:begin', `:end', `:parent' and `:post-blank' properties.
4700 As a special case, if point is at the very beginning of a list or
4701 sub-list, returned element will be that list instead of the first
4702 item. In the same way, if point is at the beginning of the first
4703 row of a table, returned element will be the table instead of the
4704 first row.
4706 If optional argument KEEP-TRAIL is non-nil, the function returns
4707 a list of elements leading to element at point. The list's CAR
4708 is always the element at point. The following positions contain
4709 element's siblings, then parents, siblings of parents, until the
4710 first element of current section."
4712 ;; If at a headline, parse it. It is the sole element that
4713 ;; doesn't require to know about context. Be sure to disallow
4714 ;; secondary string parsing, though.
4720 ;; Otherwise move at the beginning of the section containing
4721 ;; point.
4726 element type special-flag trail struct prevs parent)
4729 ;; In empty lines at buffer's beginning, return nil.
4738 ;; In blank lines just after the headline, point still
4739 ;; belongs to the headline.
4748 ;; Parse successively each element, skipping those ending
4749 ;; before original position.
4757 ;; 1. Skip any element ending before point. Also skip
4758 ;; element ending at point when we're sure that another
4759 ;; element has started.
4764 ;; 2. An element containing point is always the element at
4765 ;; point.
4768 ;; 3. At any other greater element type, if point is
4769 ;; within contents, move into it.
4774 ;; Create an anchor for tables and plain lists:
4775 ;; when point is at the very beginning of these
4776 ;; elements, ignoring affiliated keywords,
4777 ;; target them instead of their contents.
4779 ;; When point is at contents end, do not move
4780 ;; into elements with an explicit ending, but
4781 ;; return that element instead.
4785 drawer dynamic-block inlinetask
4786 property-drawer quote-block
4787 special-block))
4788 ;; Corner case: if a list ends at the
4789 ;; end of a buffer without a final new
4790 ;; line, return last element in last
4791 ;; item instead.
4809 ;;;###autoload
4811 "Return closest element or object around point.
4813 Return value is a list like (TYPE PROPS) where TYPE is the type
4814 of the element or object and PROPS a plist of properties
4815 associated to it.
4817 Possible types are defined in `org-element-all-elements' and
4818 `org-element-all-objects'. Properties depend on element or
4819 object type, but always include `:begin', `:end', `:parent' and
4820 `:post-blank'.
4822 Optional argument ELEMENT, when non-nil, is the closest element
4823 containing point, as returned by `org-element-at-point'.
4824 Providing it allows for quicker computation."
4830 context)
4831 ;; Check if point is inside an element containing objects or at
4832 ;; a secondary string. In that case, narrow buffer to the
4833 ;; containing area. Otherwise, return ELEMENT.
4835 ;; At a parsed affiliated keyword, check if we're inside main
4836 ;; or dual value.
4843 org-element-parsed-keywords))
4852 ;; Also change type to retrieve correct restrictions.
4854 ;; At an item, objects can only be located within tag, if any.
4864 ;; At an headline or inlinetask, objects are located within
4865 ;; their title.
4872 ;; At a paragraph, a table-row or a verse block, objects are
4873 ;; located within their contents.
4877 ;; CBEG is nil for table rules.
4881 ;; At a parsed keyword, objects are located within value.
4884 org-element-document-properties))
4899 restriction candidates))
4901 candidates)))
4902 ;; If ORIGIN is before next object in element, there's
4903 ;; no point in looking further.
4913 ;; ORIGIN is after OBJECT, so skip it.
4915 ;; ORIGIN is within a non-recursive object or at
4916 ;; an object boundaries: Return that object.
4920 ;; Otherwise, move within current object and
4921 ;; restrict search to the end of its contents.
4928 parent))))))
4931 "Non-nil when elements ELEM-A and ELEM-B are nested."
4940 "Swap elements ELEM-A and ELEM-B.
4941 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4942 end of ELEM-A."
4944 ;; There are two special cases when an element doesn't start at bol:
4945 ;; the first paragraph in an item or in a footnote definition.
4947 ;; Only a paragraph without any affiliated keyword can be moved at
4948 ;; ELEM-A position in such a situation. Note that the case of
4949 ;; a footnote definition is impossible: it cannot contain two
4950 ;; paragraphs in a row because it cannot contain a blank line.
4956 ;; In a special situation, ELEM-A will have no indentation. We'll
4957 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4971 ;; Store overlays responsible for visibility status. We
4972 ;; also need to store their boundaries as they will be
4973 ;; removed from buffer.
4980 ;; Get contents.
4988 ;; Restore ex ELEM-A overlays.
4997 ;; Restore ex ELEM-B overlays.
5006 ;; Local variables:
5007 ;; generated-autoload-file: "org-loaddefs.el"
5008 ;; End:
5010 ;;; org-element.el ends here