| blob | 873c4bb7684fdd48436afe402093111d1e18592d |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 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, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; 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."
700 :begin begin
701 :end end
702 :contents-begin contents-begin
703 :contents-end contents-end
709 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
710 CONTENTS is the contents of the footnote-definition."
712 " "
713 contents))
716 ;;;; Headline
719 "Parse a headline.
721 Return a list whose CAR is `headline' and CDR is a plist
722 containing `:raw-value', `:title', `:alt-title', `:begin',
723 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
724 `:contents-end', `:level', `:priority', `:tags',
725 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
726 `:closed', `:quotedp', `:archivedp', `:commentedp' and
727 `:footnote-section-p' keywords.
729 The plist also contains any property set in the property drawer,
730 with its name in upper cases and colons added at the
731 beginning (i.e. `:CUSTOM_ID').
733 When RAW-SECONDARY-P is non-nil, headline's title will not be
734 parsed as a secondary string, but as a plain string instead.
736 Assume point is at beginning of the headline."
749 raw-value)))
753 raw-value)))
757 ;; Upcase property names. It avoids confusion between
758 ;; properties obtained through property drawer and default
759 ;; properties from the parser (e.g. `:end' and :END:)
769 plist))
771 ;; Read time properties on the line below the headline.
777 org-keyword-time-not-clock-regexp end t)
787 plist))))
800 ;; Clean RAW-VALUE from any quote or comment string.
808 ""
809 raw-value))))
810 ;; Clean TAGS from archive tag, if any.
816 :begin begin
817 :end end
818 :pre-blank
821 :hiddenp hidden
822 :contents-begin contents-begin
823 :contents-end contents-end
824 :level level
826 :tags tags
827 :todo-keyword todo
828 :todo-type todo-type
834 end)
835 :footnote-section-p footnote-section-p
836 :archivedp archivedp
837 :commentedp commentedp
839 time-props
840 standard-props))))
844 headline :alt-title
849 headline :title
855 "Interpret HEADLINE element as Org syntax.
856 CONTENTS is the contents of the element."
883 ;; Align tags.
891 ? )
892 tags))
896 tags))))
898 contents)))
901 ;;;; Inlinetask
904 "Parse an inline task.
906 Return a list whose CAR is `inlinetask' and CDR is a plist
907 containing `:title', `:begin', `:end', `:hiddenp',
908 `:contents-begin' and `:contents-end', `:level', `:priority',
909 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
910 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
912 The plist also contains any property set in the property drawer,
913 with its name in upper cases and colons added at the
914 beginning (i.e. `:CUSTOM_ID').
916 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
917 title will not be parsed as a secondary string, but as a plain
918 string instead.
920 Assume point is at beginning of the inline task."
930 ;; Upcase property names. It avoids confusion between
931 ;; properties obtained through property drawer and default
932 ;; properties from the parser (e.g. `:end' and :END:)
942 plist))
944 ;; Read time properties on the line below the inlinetask
945 ;; opening string.
951 org-keyword-time-not-clock-regexp end t)
961 plist))))
981 :begin begin
982 :end end
983 :hiddenp hidden
984 :contents-begin contents-begin
985 :contents-end contents-end
988 :tags tags
989 :todo-keyword todo
990 :todo-type todo-type
992 time-props
993 standard-props))))
995 inlinetask :title
998 raw-value
1000 inlinetask))))))
1003 "Interpret INLINETASK element as Org syntax.
1004 CONTENTS is the contents of inlinetask."
1019 ;; Align tags.
1027 ? )
1028 tags))
1032 tags))))
1033 ;; Prefer degenerate inlinetasks when there are no
1034 ;; contents.
1037 contents
1041 ;;;; Item
1044 "Parse an item.
1046 STRUCT is the structure of the plain list.
1048 Return a list whose CAR is `item' and CDR is a plist containing
1049 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1050 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1051 `:post-blank' keywords.
1053 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1054 any, will not be parsed as a secondary string, but as a plain
1055 string instead.
1057 Assume point is at the beginning of the item."
1081 ;; Ignore tags in un-ordered lists: they are just
1082 ;; a part of item's body.
1088 ;; If first line isn't empty, contents really start
1089 ;; at the text after item's meta-data.
1100 :begin begin
1101 :end end
1102 ;; CONTENTS-BEGIN and CONTENTS-END may be
1103 ;; mixed up in the case of an empty item
1104 ;; separated from the next by a blank line.
1105 ;; Thus ensure the former is always the
1106 ;; smallest.
1109 :checkbox checkbox
1110 :counter counter
1111 :hiddenp hidden
1112 :structure struct
1115 item :tag
1123 "Interpret ITEM element as Org syntax.
1124 CONTENTS is the contents of the element."
1134 ;; Compute indentation.
1139 ;; Indent contents.
1141 bullet
1155 ;;;; Plain List
1158 ;; Return structure of list at point. Internal function. See
1159 ;; `org-list-struct' for details.
1167 items struct)
1172 ;; At limit: end all items.
1181 ;; At list end: end all items.
1186 ;; At a new item: end previous sibling.
1198 ind
1199 bullet
1202 ;; Description tag.
1206 ;; Ending position, unknown so far.
1207 nil)))
1208 items))
1210 ;; Skip empty lines.
1212 ;; Skip inline tasks and blank lines along the way.
1219 ;; At some text line. Check if it ends any previous item.
1231 ;; Skip blocks (any type) and drawers contents.
1237 limit t)))
1243 "Parse a plain list.
1245 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1246 the buffer position at the beginning of the first affiliated
1247 keyword and CDR is a plist of affiliated keywords along with
1248 their value. STRUCTURE is the structure of the plain list being
1249 parsed.
1251 Return a list whose CAR is `plain-list' and CDR is a plist
1252 containing `:type', `:begin', `:end', `:contents-begin' and
1253 `:contents-end', `:structure', `:post-blank' and
1254 `:post-affiliated' keywords.
1256 Assume point is at the beginning of the list."
1269 ;; Return value.
1273 :begin begin
1274 :end end
1275 :contents-begin contents-begin
1276 :contents-end contents-end
1277 :structure struct
1283 "Interpret PLAIN-LIST element as Org syntax.
1284 CONTENTS is the contents of the element."
1292 ;;;; Property Drawer
1295 "Parse a property drawer.
1297 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1298 the buffer position at the beginning of the first affiliated
1299 keyword and CDR is a plist of affiliated keywords along with
1300 their value.
1302 Return a list whose CAR is `property-drawer' and CDR is a plist
1303 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1304 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1306 Assume point is at the beginning of the property drawer."
1311 ;; Incomplete drawer: parse it as a paragraph.
1331 :end end
1332 :hiddenp hidden
1333 :contents-begin contents-begin
1334 :contents-end contents-end
1340 "Interpret PROPERTY-DRAWER element as Org syntax.
1341 CONTENTS is the properties within the drawer."
1345 ;;;; Quote Block
1348 "Parse a quote block.
1350 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1351 the buffer position at the beginning of the first affiliated
1352 keyword and CDR is a plist of affiliated keywords along with
1353 their value.
1355 Return a list whose CAR is `quote-block' and CDR is a plist
1356 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1357 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1359 Assume point is at the beginning of the block."
1363 ;; Incomplete block: parse it as a paragraph.
1369 ;; Empty blocks have no contents.
1384 :end end
1385 :hiddenp hidden
1386 :contents-begin contents-begin
1387 :contents-end contents-end
1393 "Interpret QUOTE-BLOCK element as Org syntax.
1394 CONTENTS is the contents of the element."
1398 ;;;; Section
1401 "Parse a section.
1403 LIMIT bounds the search.
1405 Return a list whose CAR is `section' and CDR is a plist
1406 containing `:begin', `:end', `:contents-begin', `contents-end'
1407 and `:post-blank' keywords."
1409 ;; Beginning of section is the beginning of the first non-blank
1410 ;; line after previous headline.
1419 :end end
1420 :contents-begin begin
1421 :contents-end pos-before-blank
1425 "Interpret SECTION element as Org syntax.
1426 CONTENTS is the contents of the element."
1427 contents)
1430 ;;;; Special Block
1433 "Parse a special block.
1435 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1436 the buffer position at the beginning of the first affiliated
1437 keyword and CDR is a plist of affiliated keywords along with
1438 their value.
1440 Return a list whose CAR is `special-block' and CDR is a plist
1441 containing `:type', `:begin', `:end', `:hiddenp',
1442 `:contents-begin', `:contents-end', `:post-blank' and
1443 `:post-affiliated' keywords.
1445 Assume point is at the beginning of the block."
1452 limit t)))
1453 ;; Incomplete block: parse it as a paragraph.
1459 ;; Empty blocks have no contents.
1474 :begin begin
1475 :end end
1476 :hiddenp hidden
1477 :contents-begin contents-begin
1478 :contents-end contents-end
1484 "Interpret SPECIAL-BLOCK element as Org syntax.
1485 CONTENTS is the contents of the element."
1490 \f
1491 ;;; Elements
1492 ;;
1493 ;; For each element, a parser and an interpreter are also defined.
1494 ;; Both follow the same naming convention used for greater elements.
1495 ;;
1496 ;; Also, as for greater elements, adding a new element type is done
1497 ;; through the following steps: implement a parser and an interpreter,
1498 ;; tweak `org-element--current-element' so that it recognizes the new
1499 ;; type and add that new type to `org-element-all-elements'.
1500 ;;
1501 ;; As a special case, when the newly defined type is a block type,
1502 ;; `org-element-block-name-alist' has to be modified accordingly.
1505 ;;;; Babel Call
1508 "Parse a babel call.
1510 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1511 the buffer position at the beginning of the first affiliated
1512 keyword and CDR is a plist of affiliated keywords along with
1513 their value.
1515 Return a list whose CAR is `babel-call' and CDR is a plist
1516 containing `:begin', `:end', `:info', `:post-blank' and
1517 `:post-affiliated' as keywords."
1531 :end end
1532 :info info
1538 "Interpret BABEL-CALL element as Org syntax.
1539 CONTENTS is nil."
1545 ;; Remove redundant square brackets.
1550 ;;;; Clock
1553 "Parse a clock.
1555 LIMIT bounds the search.
1557 Return a list whose CAR is `clock' and CDR is a plist containing
1558 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1559 as keywords."
1579 :value value
1580 :duration duration
1581 :begin begin
1582 :end end
1586 "Interpret CLOCK element as Org syntax.
1587 CONTENTS is nil."
1595 "%2s:%02s"
1599 ;;;; Comment
1602 "Parse a comment.
1604 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1605 the buffer position at the beginning of the first affiliated
1606 keyword and CDR is a plist of affiliated keywords along with
1607 their value.
1609 Return a list whose CAR is `comment' and CDR is a plist
1610 containing `:begin', `:end', `:value', `:post-blank',
1611 `:post-affiliated' keywords.
1613 Assume point is at comment beginning."
1622 ;; Get comments ending.
1625 ;; Accumulate lines without leading hash and first
1626 ;; whitespace.
1641 :end end
1642 :value value
1648 "Interpret COMMENT element as Org syntax.
1649 CONTENTS is nil."
1653 ;;;; Comment Block
1656 "Parse an export block.
1658 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1659 the buffer position at the beginning of the first affiliated
1660 keyword and CDR is a plist of affiliated keywords along with
1661 their value.
1663 Return a list whose CAR is `comment-block' and CDR is a plist
1664 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1665 and `:post-affiliated' keywords.
1667 Assume point is at comment block beginning."
1671 ;; Incomplete block: parse it as a paragraph.
1686 contents-begin contents-end)))
1690 :end end
1691 :value value
1692 :hiddenp hidden
1698 "Interpret COMMENT-BLOCK element as Org syntax.
1699 CONTENTS is nil."
1704 ;;;; Diary Sexp
1707 "Parse a diary sexp.
1709 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1710 the buffer position at the beginning of the first affiliated
1711 keyword and CDR is a plist of affiliated keywords along with
1712 their value.
1714 Return a list whose CAR is `diary-sexp' and CDR is a plist
1715 containing `:begin', `:end', `:value', `:post-blank' and
1716 `:post-affiliated' keywords."
1729 :begin begin
1730 :end end
1736 "Interpret DIARY-SEXP as Org syntax.
1737 CONTENTS is nil."
1741 ;;;; Example Block
1744 "Remove maximum common indentation in string S and return it.
1745 When optional argument N is a positive integer, remove exactly
1746 that much characters from indentation, if possible, or return
1747 S as-is otherwise. Unlike to `org-remove-indentation', this
1748 function doesn't call `untabify' on S."
1753 ;; Find maximum common indentation, if not specified.
1761 min-ind)))
1763 ;; Remove exactly N indentation, but give up if not possible.
1773 "Parse an example block.
1775 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1776 the buffer position at the beginning of the first affiliated
1777 keyword and CDR is a plist of affiliated keywords along with
1778 their value.
1780 Return a list whose CAR is `example-block' and CDR is a plist
1781 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1782 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1783 `:switches', `:value', `:post-blank' and `:post-affiliated'
1784 keywords."
1788 ;; Incomplete block: parse it as a paragraph.
1796 ;; Switches analysis
1804 ;; Should labels be retained in (or stripped from) example
1805 ;; blocks?
1810 ;; What should code-references use - labels or
1811 ;; line-numbers?
1820 ;; Standard block parsing.
1829 contents-begin contents-end))
1840 :end end
1841 :value value
1842 :switches switches
1843 :number-lines number-lines
1844 :preserve-indent preserve-indent
1845 :retain-labels retain-labels
1846 :use-labels use-labels
1847 :label-fmt label-fmt
1848 :hiddenp hidden
1854 "Interpret EXAMPLE-BLOCK element as Org syntax.
1855 CONTENTS is nil."
1863 ;;;; Export Block
1866 "Parse an export block.
1868 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1869 the buffer position at the beginning of the first affiliated
1870 keyword and CDR is a plist of affiliated keywords along with
1871 their value.
1873 Return a list whose CAR is `export-block' and CDR is a plist
1874 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1875 `:post-blank' and `:post-affiliated' keywords.
1877 Assume point is at export-block beginning."
1884 ;; Incomplete block: parse it as a paragraph.
1899 contents-end)))
1903 :end end
1904 :type type
1905 :value value
1906 :hiddenp hidden
1912 "Interpret EXPORT-BLOCK element as Org syntax.
1913 CONTENTS is nil."
1920 ;;;; Fixed-width
1923 "Parse a fixed-width section.
1925 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1926 the buffer position at the beginning of the first affiliated
1927 keyword and CDR is a plist of affiliated keywords along with
1928 their value.
1930 Return a list whose CAR is `fixed-width' and CDR is a plist
1931 containing `:begin', `:end', `:value', `:post-blank' and
1932 `:post-affiliated' keywords.
1934 Assume point is at the beginning of the fixed-width area."
1938 value
1943 ;; Accumulate text without starting colons.
1957 :end end
1958 :value value
1964 "Interpret FIXED-WIDTH element as Org syntax.
1965 CONTENTS is nil."
1973 ;;;; Horizontal Rule
1976 "Parse an horizontal rule.
1978 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1979 the buffer position at the beginning of the first affiliated
1980 keyword and CDR is a plist of affiliated keywords along with
1981 their value.
1983 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1984 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1985 keywords."
1996 :end end
2002 "Interpret HORIZONTAL-RULE element as Org syntax.
2003 CONTENTS is nil."
2007 ;;;; Keyword
2010 "Parse a keyword at point.
2012 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2013 the buffer position at the beginning of the first affiliated
2014 keyword and CDR is a plist of affiliated keywords along with
2015 their value.
2017 Return a list whose CAR is `keyword' and CDR is a plist
2018 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2019 `:post-affiliated' keywords."
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.
2082 :end end
2083 :value value
2089 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2090 CONTENTS is nil."
2094 ;;;; Node Property
2097 "Parse a node-property at point.
2099 LIMIT bounds the search.
2101 Return a list whose CAR is `node-property' and CDR is a plist
2102 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2103 keywords."
2115 :value value
2116 :begin begin
2117 :end end
2121 "Interpret NODE-PROPERTY element as Org syntax.
2122 CONTENTS is nil."
2128 ;;;; Paragraph
2131 "Parse a paragraph.
2133 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2134 the buffer position at the beginning of the first affiliated
2135 keyword and CDR is a plist of affiliated keywords along with
2136 their value.
2138 Return a list whose CAR is `paragraph' and CDR is a plist
2139 containing `:begin', `:end', `:contents-begin' and
2140 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2142 Assume point is at the beginning of the paragraph."
2151 limit
2152 ;; A matching `org-element-paragraph-separate' is not
2153 ;; necessarily the end of the paragraph. In
2154 ;; particular, lines starting with # or : as a first
2155 ;; non-space character are ambiguous. We have check
2156 ;; if they are valid Org syntax (i.e. not an
2157 ;; incomplete keyword).
2161 ;; There's no ambiguity for other symbols or
2162 ;; empty lines: stop here.
2164 ;; Stop at valid fixed-width areas.
2166 ;; Stop at drawers.
2171 ;; Stop at valid comments.
2173 ;; Stop at valid dynamic blocks.
2178 ;; Stop at valid blocks.
2185 limit t)))
2186 ;; Stop at valid latex environments.
2194 limit t)))
2195 ;; Stop at valid keywords.
2197 ;; Skip everything else.
2215 :end end
2216 :contents-begin contents-begin
2217 :contents-end contents-end
2223 "Interpret PARAGRAPH element as Org syntax.
2224 CONTENTS is the contents of the element."
2225 contents)
2228 ;;;; Planning
2231 "Parse a planning.
2233 LIMIT bounds the search.
2235 Return a list whose CAR is `planning' and CDR is a plist
2236 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2237 and `:post-blank' keywords."
2247 closed deadline scheduled)
2259 :deadline deadline
2260 :scheduled scheduled
2261 :begin begin
2262 :end end
2266 "Interpret PLANNING element as Org syntax.
2267 CONTENTS is nil."
2269 'identity
2286 ;;;; Quote Section
2289 "Parse a quote section.
2291 LIMIT bounds the search.
2293 Return a list whose CAR is `quote-section' and CDR is a plist
2294 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2296 Assume point is at beginning of the section."
2307 :end end
2308 :value value
2312 "Interpret QUOTE-SECTION element as Org syntax.
2313 CONTENTS is nil."
2317 ;;;; Src Block
2320 "Parse a src block.
2322 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2323 the buffer position at the beginning of the first affiliated
2324 keyword and CDR is a plist of affiliated keywords along with
2325 their value.
2327 Return a list whose CAR is `src-block' and CDR is a plist
2328 containing `:language', `:switches', `:parameters', `:begin',
2329 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2330 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2331 `:post-blank' and `:post-affiliated' keywords.
2333 Assume point is at the beginning of the block."
2336 limit t)))
2337 ;; Incomplete block: parse it as a paragraph.
2343 ;; Get language as a string.
2352 ;; Get switches.
2354 ;; Get parameters.
2356 ;; Switches analysis
2368 ;; Should labels be retained in (or stripped from)
2369 ;; src blocks?
2374 ;; What should code-references use - labels or
2375 ;; line-numbers?
2380 ;; Indentation.
2382 ;; Get visibility status.
2384 ;; Retrieve code.
2393 ;; Get position after ending blank lines.
2404 :begin begin
2405 :end end
2406 :number-lines number-lines
2407 :preserve-indent preserve-indent
2408 :retain-labels retain-labels
2409 :use-labels use-labels
2410 :label-fmt label-fmt
2411 :hiddenp hidden
2412 :value value
2418 "Interpret SRC-BLOCK element as Org syntax.
2419 CONTENTS is nil."
2440 ;;;; Table
2443 "Parse a table at point.
2445 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2446 the buffer position at the beginning of the first affiliated
2447 keyword and CDR is a plist of affiliated keywords along with
2448 their value.
2450 Return a list whose CAR is `table' and CDR is a plist containing
2451 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2452 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2453 keywords.
2455 Assume point is at the beginning of the table."
2469 acc))
2477 :end end
2478 :type type
2479 :tblfm tblfm
2480 ;; Only `org' tables have contents. `table.el' tables
2481 ;; use a `:value' property to store raw table as
2482 ;; a string.
2487 table-begin table-end))
2493 "Interpret TABLE element as Org syntax.
2494 CONTENTS is nil."
2505 ;;;; Table Row
2508 "Parse table row at point.
2510 LIMIT bounds the search.
2512 Return a list whose CAR is `table-row' and CDR is a plist
2513 containing `:begin', `:end', `:contents-begin', `:contents-end',
2514 `:type' and `:post-blank' keywords."
2518 ;; A table rule has no contents. In that case, ensure
2519 ;; CONTENTS-BEGIN matches CONTENTS-END.
2531 :begin begin
2532 :end end
2533 :contents-begin contents-begin
2534 :contents-end contents-end
2538 "Interpret TABLE-ROW element as Org syntax.
2539 CONTENTS is the contents of the table row."
2544 ;;;; Verse Block
2547 "Parse a verse block.
2549 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2550 the buffer position at the beginning of the first affiliated
2551 keyword and CDR is a plist of affiliated keywords along with
2552 their value.
2554 Return a list whose CAR is `verse-block' and CDR is a plist
2555 containing `:begin', `:end', `:contents-begin', `:contents-end',
2556 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2558 Assume point is at beginning of the block."
2562 ;; Incomplete block: parse it as a paragraph.
2579 :end end
2580 :contents-begin contents-begin
2581 :contents-end contents-end
2582 :hiddenp hidden
2588 "Interpret VERSE-BLOCK element as Org syntax.
2589 CONTENTS is verse block contents."
2593 \f
2594 ;;; Objects
2595 ;;
2596 ;; Unlike to elements, interstices can be found between objects.
2597 ;; That's why, along with the parser, successor functions are provided
2598 ;; for each object. Some objects share the same successor (i.e. `code'
2599 ;; and `verbatim' objects).
2600 ;;
2601 ;; A successor must accept a single argument bounding the search. It
2602 ;; will return either a cons cell whose CAR is the object's type, as
2603 ;; a symbol, and CDR the position of its next occurrence, or nil.
2604 ;;
2605 ;; Successors follow the naming convention:
2606 ;; org-element-NAME-successor, where NAME is the name of the
2607 ;; successor, as defined in `org-element-all-successors'.
2608 ;;
2609 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2610 ;; object types they can contain will be specified in
2611 ;; `org-element-object-restrictions'.
2612 ;;
2613 ;; Adding a new type of object is simple. Implement a successor,
2614 ;; a parser, and an interpreter for it, all following the naming
2615 ;; convention. Register type in `org-element-all-objects' and
2616 ;; successor in `org-element-all-successors'. Maybe tweak
2617 ;; restrictions about it, and that's it.
2620 ;;;; Bold
2623 "Parse bold object at point.
2625 Return a list whose CAR is `bold' and CDR is a plist with
2626 `:begin', `:end', `:contents-begin' and `:contents-end' and
2627 `:post-blank' keywords.
2629 Assume point is at the first star marker."
2641 :end end
2642 :contents-begin contents-begin
2643 :contents-end contents-end
2647 "Interpret BOLD object as Org syntax.
2648 CONTENTS is the contents of the object."
2652 "Search for the next text-markup object.
2654 Return value is a cons cell whose CAR is a symbol among `bold',
2655 `italic', `underline', `strike-through', `code' and `verbatim'
2656 and CDR is beginning position."
2672 ;;;; Code
2675 "Parse code object at point.
2677 Return a list whose CAR is `code' and CDR is a plist with
2678 `:value', `:begin', `:end' and `:post-blank' keywords.
2680 Assume point is at the first tilde marker."
2691 :begin begin
2692 :end end
2696 "Interpret CODE object as Org syntax.
2697 CONTENTS is nil."
2701 ;;;; Entity
2704 "Parse entity at point.
2706 Return a list whose CAR is `entity' and CDR a plist with
2707 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2708 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2709 keywords.
2711 Assume point is at the beginning of the entity."
2713 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2729 :begin begin
2730 :end end
2731 :use-brackets-p bracketsp
2735 "Interpret ENTITY object as Org syntax.
2736 CONTENTS is nil."
2742 "Search for the next latex-fragment or entity object.
2744 Return value is a cons cell whose CAR is `entity' or
2745 `latex-fragment' and CDR is beginning position."
2749 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2756 ;; Determine if it's a real entity or a LaTeX command.
2759 ;; No entity nor command: point is at a LaTeX fragment.
2760 ;; Determine its type to get the correct beginning position.
2769 ;;;; Export Snippet
2772 "Parse export snippet at point.
2774 Return a list whose CAR is `export-snippet' and CDR a plist with
2775 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2776 keywords.
2778 Assume point is at the beginning of the snippet."
2790 :value value
2791 :begin begin
2792 :end end
2796 "Interpret EXPORT-SNIPPET object as Org syntax.
2797 CONTENTS is nil."
2803 "Search for the next export-snippet object.
2805 Return value is a cons cell whose CAR is `export-snippet' and CDR
2806 its beginning position."
2815 ;;;; Footnote Reference
2818 "Parse footnote reference at point.
2820 Return a list whose CAR is `footnote-reference' and CDR a plist
2821 with `:label', `:type', `:inline-definition', `:begin', `:end'
2822 and `:post-blank' as keywords."
2844 :type type
2845 :begin begin
2846 :end end
2849 footnote-reference :inline-definition
2854 footnote-reference))))))
2857 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2858 CONTENTS is nil."
2868 "Search for the next footnote-reference object.
2870 Return value is a cons cell whose CAR is `footnote-reference' and
2871 CDR is beginning position."
2885 ;;;; Inline Babel Call
2888 "Parse inline babel call at point.
2890 Return a list whose CAR is `inline-babel-call' and CDR a plist
2891 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2893 Assume point is at the beginning of the babel call."
2904 :end end
2905 :info info
2909 "Interpret INLINE-BABEL-CALL object as Org syntax.
2910 CONTENTS is nil."
2916 ;; Remove redundant square brackets.
2919 main-source)
2923 "Search for the next inline-babel-call object.
2925 Return value is a cons cell whose CAR is `inline-babel-call' and
2926 CDR is beginning position."
2928 ;; Use a simplified version of
2929 ;; `org-babel-inline-lob-one-liner-regexp'.
2932 nil t)
2936 ;;;; Inline Src Block
2939 "Parse inline source block at point.
2941 Return a list whose CAR is `inline-src-block' and CDR a plist
2942 with `:begin', `:end', `:language', `:value', `:parameters' and
2943 `:post-blank' as keywords.
2945 Assume point is at the beginning of the inline src block."
2958 :value value
2959 :parameters parameters
2960 :begin begin
2961 :end end
2965 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2966 CONTENTS is nil."
2971 language
2973 body)))
2976 "Search for the next inline-babel-call element.
2978 Return value is a cons cell whose CAR is `inline-babel-call' and
2979 CDR is beginning position."
2985 ;;;; Italic
2988 "Parse italic object at point.
2990 Return a list whose CAR is `italic' and CDR is a plist with
2991 `:begin', `:end', `:contents-begin' and `:contents-end' and
2992 `:post-blank' keywords.
2994 Assume point is at the first slash marker."
3006 :end end
3007 :contents-begin contents-begin
3008 :contents-end contents-end
3012 "Interpret ITALIC object as Org syntax.
3013 CONTENTS is the contents of the object."
3017 ;;;; Latex Fragment
3020 "Parse LaTeX fragment at point.
3022 Return a list whose CAR is `latex-fragment' and CDR a plist with
3023 `:value', `:begin', `:end', and `:post-blank' as keywords.
3025 Assume point is at the beginning of the LaTeX fragment."
3038 ;; None found: it's a macro.
3047 :begin begin
3048 :end end
3052 "Interpret LATEX-FRAGMENT object as Org syntax.
3053 CONTENTS is nil."
3056 ;;;; Line Break
3059 "Parse line break at point.
3061 Return a list whose CAR is `line-break', and CDR a plist with
3062 `:begin', `:end' and `:post-blank' keywords.
3064 Assume point is at the beginning of the line break."
3071 "Interpret LINE-BREAK object as Org syntax.
3072 CONTENTS is nil."
3076 "Search for the next line-break object.
3078 Return value is a cons cell whose CAR is `line-break' and CDR is
3079 beginning position."
3083 ;; A line break can only happen on a non-empty line.
3088 ;;;; Link
3091 "Parse link at point.
3093 Return a list whose CAR is `link' and CDR a plist with `:type',
3094 `:path', `:raw-link', `:application', `:search-option', `:begin',
3095 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3096 keywords.
3098 Assume point is at the beginning of the link."
3101 end contents-begin contents-end link-end post-blank path type
3102 raw-link link search-option application)
3104 ;; Type 1: Text targeted from a radio target.
3109 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3114 ;; RAW-LINK is the original link. Expand any
3115 ;; abbreviation in it.
3119 ;; Determine TYPE of link and set PATH accordingly.
3121 ;; File type.
3125 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3128 ;; Id type: PATH is the id.
3131 ;; Code-ref type: PATH is the name of the reference.
3134 ;; Custom-id type: PATH is the name of the custom id.
3137 ;; Fuzzy type: Internal link either matches a target, an
3138 ;; headline name or nothing. PATH is the target or
3139 ;; headline's name.
3141 ;; Type 3: Plain link, i.e. http://orgmode.org
3147 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3154 ;; In any case, deduce end point after trailing white space from
3155 ;; LINK-END variable.
3158 ;; Extract search option and opening application out of
3159 ;; "file"-type links.
3161 ;; Application.
3166 ;; Extract search option from PATH.
3170 ;; Make sure TYPE always reports "file".
3174 :path path
3176 :application application
3177 :search-option search-option
3178 :begin begin
3179 :end end
3180 :contents-begin contents-begin
3181 :contents-end contents-end
3185 "Interpret LINK object as Org syntax.
3186 CONTENTS is the contents of the object, or nil."
3191 raw-link
3195 "Search for the next link object.
3197 Return value is a cons cell whose CAR is `link' and CDR is
3198 beginning position."
3207 "Search for the next plain link object.
3209 Return value is a cons cell whose CAR is `link' and CDR is
3210 beginning position."
3215 ;;;; Macro
3218 "Parse macro at point.
3220 Return a list whose CAR is `macro' and CDR a plist with `:key',
3221 `:args', `:begin', `:end', `:value' and `:post-blank' as
3222 keywords.
3224 Assume point is at the macro."
3235 ;; Do not use `org-split-string' since empty
3236 ;; strings are meaningful here.
3244 args nil t)
3248 :value value
3249 :args args
3250 :begin begin
3251 :end end
3255 "Interpret MACRO object as Org syntax.
3256 CONTENTS is nil."
3260 "Search for the next macro object.
3262 Return value is cons cell whose CAR is `macro' and CDR is
3263 beginning position."
3267 nil t)
3271 ;;;; Radio-target
3274 "Parse radio target at point.
3276 Return a list whose CAR is `radio-target' and CDR a plist with
3277 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3278 and `:post-blank' as keywords.
3280 Assume point is at the radio target."
3292 :end end
3293 :contents-begin contents-begin
3294 :contents-end contents-end
3295 :post-blank post-blank
3299 "Interpret TARGET object as Org syntax.
3300 CONTENTS is the contents of the object."
3304 "Search for the next radio-target object.
3306 Return value is a cons cell whose CAR is `radio-target' and CDR
3307 is beginning position."
3313 ;;;; Statistics Cookie
3316 "Parse statistics cookie at point.
3318 Return a list whose CAR is `statistics-cookie', and CDR a plist
3319 with `:begin', `:end', `:value' and `:post-blank' keywords.
3321 Assume point is at the beginning of the statistics-cookie."
3332 :end end
3333 :value value
3337 "Interpret STATISTICS-COOKIE object as Org syntax.
3338 CONTENTS is nil."
3342 "Search for the next statistics cookie object.
3344 Return value is a cons cell whose CAR is `statistics-cookie' and
3345 CDR is beginning position."
3351 ;;;; Strike-Through
3354 "Parse strike-through object at point.
3356 Return a list whose CAR is `strike-through' and CDR is a plist
3357 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3358 `:post-blank' keywords.
3360 Assume point is at the first plus sign marker."
3372 :end end
3373 :contents-begin contents-begin
3374 :contents-end contents-end
3378 "Interpret STRIKE-THROUGH object as Org syntax.
3379 CONTENTS is the contents of the object."
3383 ;;;; Subscript
3386 "Parse subscript at point.
3388 Return a list whose CAR is `subscript' and CDR a plist with
3389 `:begin', `:end', `:contents-begin', `:contents-end',
3390 `:use-brackets-p' and `:post-blank' as keywords.
3392 Assume point is at the underscore."
3396 t
3407 :end end
3408 :use-brackets-p bracketsp
3409 :contents-begin contents-begin
3410 :contents-end contents-end
3414 "Interpret SUBSCRIPT object as Org syntax.
3415 CONTENTS is the contents of the object."
3418 contents))
3421 "Search for the next sub/superscript object.
3423 Return value is a cons cell whose CAR is either `subscript' or
3424 `superscript' and CDR is beginning position."
3432 ;;;; Superscript
3435 "Parse superscript at point.
3437 Return a list whose CAR is `superscript' and CDR a plist with
3438 `:begin', `:end', `:contents-begin', `:contents-end',
3439 `:use-brackets-p' and `:post-blank' as keywords.
3441 Assume point is at the caret."
3455 :end end
3456 :use-brackets-p bracketsp
3457 :contents-begin contents-begin
3458 :contents-end contents-end
3462 "Interpret SUPERSCRIPT object as Org syntax.
3463 CONTENTS is the contents of the object."
3466 contents))
3469 ;;;; Table Cell
3472 "Parse table cell at point.
3474 Return a list whose CAR is `table-cell' and CDR is a plist
3475 containing `:begin', `:end', `:contents-begin', `:contents-end'
3476 and `:post-blank' keywords."
3484 :end end
3485 :contents-begin contents-begin
3486 :contents-end contents-end
3490 "Interpret TABLE-CELL element as Org syntax.
3491 CONTENTS is the contents of the cell, or nil."
3495 "Search for the next table-cell object.
3497 Return value is a cons cell whose CAR is `table-cell' and CDR is
3498 beginning position."
3502 ;;;; Target
3505 "Parse target at point.
3507 Return a list whose CAR is `target' and CDR a plist with
3508 `:begin', `:end', `:value' and `:post-blank' as keywords.
3510 Assume point is at the target."
3520 :end end
3521 :value value
3525 "Interpret TARGET object as Org syntax.
3526 CONTENTS is nil."
3530 "Search for the next target object.
3532 Return value is a cons cell whose CAR is `target' and CDR is
3533 beginning position."
3539 ;;;; Timestamp
3542 "Parse time stamp at point.
3544 Return a list whose CAR is `timestamp', and CDR a plist with
3545 `:type', `:raw-value', `:year-start', `:month-start',
3546 `:day-start', `:hour-start', `:minute-start', `:year-end',
3547 `:month-end', `:day-end', `:hour-end', `:minute-end',
3548 `:repeater-type', `:repeater-value', `:repeater-unit',
3549 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3550 `:end', `:value' and `:post-blank' keywords.
3552 Assume point is at the beginning of the timestamp."
3570 date-start)
3581 raw-value)
3583 :repeater-type
3589 :repeater-unit
3598 :warning-unit
3601 year-start month-start day-start hour-start minute-start year-end
3602 month-end day-end hour-end minute-end)
3603 ;; Parse date-start.
3611 ;; Compute date-end. It can be provided directly in time-stamp,
3612 ;; or extracted from time range. Otherwise, it defaults to the
3613 ;; same values as date-start.
3623 :raw-value raw-value
3624 :year-start year-start
3625 :month-start month-start
3626 :day-start day-start
3627 :hour-start hour-start
3628 :minute-start minute-start
3629 :year-end year-end
3630 :month-end month-end
3631 :day-end day-end
3632 :hour-end hour-end
3633 :minute-end minute-end
3634 :begin begin
3635 :end end
3637 repeater-props
3638 warning-props)))))
3641 "Interpret TIMESTAMP object as Org syntax.
3642 CONTENTS is nil."
3643 ;; Use `:raw-value' if specified.
3645 ;; Otherwise, build timestamp string.
3664 ;; Build an Org timestamp string from TIME. ACTIVEP is
3665 ;; non-nil when time stamp is active. If WITH-TIME-P is
3666 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3667 ;; specify a time range in the timestamp. REPEAT-STRING
3668 ;; is the repeater string, if any.
3672 org-time-stamp-formats)
3673 time)))
3679 nil nil ts)))
3684 " "
3685 s
3687 ;; Return value.
3688 ts)))
3700 build-ts-string
3719 0
3727 "--"
3739 "Search for the next timestamp object.
3741 Return value is a cons cell whose CAR is `timestamp' and CDR is
3742 beginning position."
3750 nil t)
3754 ;;;; Underline
3757 "Parse underline object at point.
3759 Return a list whose CAR is `underline' and CDR is a plist with
3760 `:begin', `:end', `:contents-begin' and `:contents-end' and
3761 `:post-blank' keywords.
3763 Assume point is at the first underscore marker."
3775 :end end
3776 :contents-begin contents-begin
3777 :contents-end contents-end
3781 "Interpret UNDERLINE object as Org syntax.
3782 CONTENTS is the contents of the object."
3786 ;;;; Verbatim
3789 "Parse verbatim object at point.
3791 Return a list whose CAR is `verbatim' and CDR is a plist with
3792 `:value', `:begin', `:end' and `:post-blank' keywords.
3794 Assume point is at the first equal sign marker."
3805 :begin begin
3806 :end end
3810 "Interpret VERBATIM object as Org syntax.
3811 CONTENTS is nil."
3815 \f
3816 ;;; Parsing Element Starting At Point
3817 ;;
3818 ;; `org-element--current-element' is the core function of this section.
3819 ;; It returns the Lisp representation of the element starting at
3820 ;; point.
3821 ;;
3822 ;; `org-element--current-element' makes use of special modes. They
3823 ;; are activated for fixed element chaining (i.e. `plain-list' >
3824 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3825 ;; `section'). Special modes are: `first-section', `item',
3826 ;; `node-property', `quote-section', `section' and `table-row'.
3830 "Parse the element starting at point.
3832 Return value is a list like (TYPE PROPS) where TYPE is the type
3833 of the element and PROPS a plist of properties associated to the
3834 element.
3836 Possible types are defined in `org-element-all-elements'.
3838 LIMIT bounds the search.
3840 Optional argument GRANULARITY determines the depth of the
3841 recursion. Allowed values are `headline', `greater-element',
3842 `element', `object' or nil. When it is broader than `object' (or
3843 nil), secondary values will not be parsed, since they only
3844 contain objects.
3846 Optional argument SPECIAL, when non-nil, can be either
3847 `first-section', `item', `node-property', `quote-section',
3848 `section', and `table-row'.
3850 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3851 be computed.
3853 This function assumes point is always at the beginning of the
3854 element it has to parse."
3857 ;; Determine if parsing depth allows for secondary strings
3858 ;; parsing. It only applies to elements referenced in
3859 ;; `org-element-secondary-value-alist'.
3862 ;; Item.
3865 ;; Table Row.
3867 ;; Node Property.
3869 ;; Headline.
3872 ;; Sections (must be checked after headline).
3878 limit)))
3879 ;; When not at bol, point is at the beginning of an item or
3880 ;; a footnote definition: next item is always a paragraph.
3882 ;; Planning and Clock.
3887 ;; Inlinetask.
3890 ;; From there, elements can have affiliated keywords.
3893 ;; Jumping over affiliated keywords put point off-limits.
3894 ;; Parse them as regular keywords.
3898 ;; LaTeX Environment.
3902 ;; Drawer and Property Drawer.
3907 ;; Fixed Width
3910 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3911 ;; Keywords.
3920 org-element-block-name-alist)))
3935 ;; Footnote Definition.
3938 ;; Horizontal Rule.
3941 ;; Diary Sexp.
3944 ;; Table.
3946 ;; List.
3949 limit affiliated
3951 ;; Default element: Paragraph.
3955 ;; Most elements can have affiliated keywords. When looking for an
3956 ;; element beginning, we want to move before them, as they belong to
3957 ;; that element, and, in the meantime, collect information they give
3958 ;; into appropriate properties. Hence the following function.
3961 "Collect affiliated keywords from point down to LIMIT.
3963 Return a list whose CAR is the position at the first of them and
3964 CDR a plist of keywords and values and move point to the
3965 beginning of the first line after them.
3967 As a special case, if element doesn't start at the beginning of
3968 the line (i.e. a paragraph starting an item), CAR is current
3969 position of point and CDR is nil."
3973 ;; RESTRICT is the list of objects allowed in parsed
3974 ;; keywords value.
3976 output)
3979 ;; Apply translation to RAW-KWD. From there, KWD is
3980 ;; the official keyword.
3982 org-element-keyword-translation-alist))
3983 raw-kwd))
3984 ;; Find main value for any keyword.
3990 ;; PARSEDP is non-nil when keyword should have its
3991 ;; value parsed.
3993 ;; If KWD is a dual keyword, find its secondary
3994 ;; value. Maybe parse it.
4001 ;; Attribute a property name to KWD.
4003 ;; Now set final shape for VALUE.
4009 ;; Attributes can always appear on multiple lines.
4012 ;; Eventually store the new value in OUTPUT.
4014 ;; Move to next keyword.
4016 ;; If affiliated keywords are orphaned: move back to first one.
4017 ;; They will be parsed as a paragraph.
4019 ;; Return value.
4023 \f
4024 ;;; The Org Parser
4025 ;;
4026 ;; The two major functions here are `org-element-parse-buffer', which
4027 ;; parses Org syntax inside the current buffer, taking into account
4028 ;; region, narrowing, or even visibility if specified, and
4029 ;; `org-element-parse-secondary-string', which parses objects within
4030 ;; a given string.
4031 ;;
4032 ;; The (almost) almighty `org-element-map' allows to apply a function
4033 ;; on elements or objects matching some type, and accumulate the
4034 ;; resulting values. In an export situation, it also skips unneeded
4035 ;; parts of the parse tree.
4038 "Recursively parse the buffer and return structure.
4039 If narrowing is in effect, only parse the visible part of the
4040 buffer.
4042 Optional argument GRANULARITY determines the depth of the
4043 recursion. It can be set to the following symbols:
4045 `headline' Only parse headlines.
4046 `greater-element' Don't recurse into greater elements excepted
4047 headlines and sections. Thus, elements
4048 parsed are the top-level ones.
4049 `element' Parse everything but objects and plain text.
4050 `object' Parse the complete buffer (default).
4052 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4053 elements.
4055 An element or an objects is represented as a list with the
4056 pattern (TYPE PROPERTIES CONTENTS), where :
4058 TYPE is a symbol describing the element or object. See
4059 `org-element-all-elements' and `org-element-all-objects' for an
4060 exhaustive list of such symbols. One can retrieve it with
4061 `org-element-type' function.
4063 PROPERTIES is the list of attributes attached to the element or
4064 object, as a plist. Although most of them are specific to the
4065 element or object type, all types share `:begin', `:end',
4066 `:post-blank' and `:parent' properties, which respectively
4067 refer to buffer position where the element or object starts,
4068 ends, the number of white spaces or blank lines after it, and
4069 the element or object containing it. Properties values can be
4070 obtained by using `org-element-property' function.
4072 CONTENTS is a list of elements, objects or raw strings
4073 contained in the current element or object, when applicable.
4074 One can access them with `org-element-contents' function.
4076 The Org buffer has `org-data' as type and nil as properties.
4077 `org-element-map' function can be used to find specific elements
4078 or objects within the parse tree.
4080 This function assumes that current major mode is `org-mode'."
4086 ;; Start in `first-section' mode so text before the first
4087 ;; headline belongs to a section.
4091 "Recursively parse objects in STRING and return structure.
4093 RESTRICTION is a symbol limiting the object types that will be
4094 looked after.
4096 Optional argument PARENT, when non-nil, is the element or object
4097 containing the secondary string. It is used to set correctly
4098 `:parent' property within the string."
4099 ;; Copy buffer-local variables listed in
4100 ;; `org-element-object-variables' into temporary buffer. This is
4101 ;; required since object parsing is dependent on these variables.
4105 org-element-object-variables))))
4113 secondary))
4114 secondary))))
4118 "Map a function on selected elements or objects.
4120 DATA is a parse tree, an element, an object, a string, or a list
4121 of such constructs. TYPES is a symbol or list of symbols of
4122 elements or objects types (see `org-element-all-elements' and
4123 `org-element-all-objects' for a complete list of types). FUN is
4124 the function called on the matching element or object. It has to
4125 accept one argument: the element or object itself.
4127 When optional argument INFO is non-nil, it should be a plist
4128 holding export options. In that case, parts of the parse tree
4129 not exportable according to that property list will be skipped.
4131 When optional argument FIRST-MATCH is non-nil, stop at the first
4132 match for which FUN doesn't return nil, and return that value.
4134 Optional argument NO-RECURSION is a symbol or a list of symbols
4135 representing elements or objects types. `org-element-map' won't
4136 enter any recursive element or object whose type belongs to that
4137 list. Though, FUN can still be applied on them.
4139 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4140 apply to matching objects within parsed affiliated keywords (see
4141 `org-element-parsed-keywords').
4143 Nil values returned from FUN do not appear in the results.
4146 Examples:
4147 ---------
4149 Assuming TREE is a variable containing an Org buffer parse tree,
4150 the following example will return a flat list of all `src-block'
4151 and `example-block' elements in it:
4153 \(org-element-map tree '(example-block src-block) 'identity)
4155 The following snippet will find the first headline with a level
4158 \(org-element-map tree 'headline
4159 \(lambda (hl)
4160 \(and (= (org-element-property :level hl) 1)
4162 \(org-element-property :begin hl)))
4163 nil t)
4165 The next example will return a flat list of all `plain-list' type
4166 elements in TREE that are not a sub-list themselves:
4168 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4170 Eventually, this example will return a flat list of all `bold'
4171 type objects containing a `latex-snippet' type object, even
4172 looking into captions:
4174 \(org-element-map tree 'bold
4175 \(lambda (b)
4176 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4177 nil nil nil t)"
4178 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4181 ;; Recursion depth is determined by --CATEGORY.
4188 ;; If one object is found, the function
4189 ;; has to recurse into every object.
4192 ;; If one regular element is found, the
4193 ;; function has to recurse, at least,
4194 ;; into every element it encounters.
4197 types)
4198 category)))
4199 ;; Compute properties for affiliated keywords if necessary.
4204 org-element-affiliated-keywords)))
4205 --acc
4206 --walk-tree
4210 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4211 ;; holding contextual information.
4215 ;; Ignored element in an export context.
4217 ;; List of elements or objects.
4219 ;; Unconditionally enter parse trees.
4223 ;; Check if TYPE is matching among TYPES. If so,
4224 ;; apply FUN to --DATA and accumulate return value
4225 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4231 ;; If --DATA has a secondary string that can contain
4232 ;; objects with their type among TYPES, look into it.
4239 ;; If --DATA has any affiliated keywords and
4240 ;; WITH-AFFILIATED is non-nil, look for objects in
4241 ;; them.
4249 ;; Pay attention to the type of value.
4250 ;; Preserve order for multiple keywords.
4266 --affiliated-alist))
4267 ;; Determine if a recursion into --DATA is possible.
4269 ;; --TYPE is explicitly removed from recursion.
4271 ;; --DATA has no contents.
4273 ;; Looking for greater elements but --DATA is simply
4274 ;; an element or an object.
4277 ;; Looking for elements but --DATA is an object.
4280 ;; In any other case, map contents.
4284 ;; Return value in a proper order.
4288 ;; The following functions are internal parts of the parser.
4289 ;;
4290 ;; The first one, `org-element--parse-elements' acts at the element's
4291 ;; level.
4292 ;;
4293 ;; The second one, `org-element--parse-objects' applies on all objects
4294 ;; of a paragraph or a secondary string. It uses
4295 ;; `org-element--get-next-object-candidates' to optimize the search of
4296 ;; the next object in the buffer.
4297 ;;
4298 ;; More precisely, that function looks for every allowed object type
4299 ;; first. Then, it discards failed searches, keeps further matches,
4300 ;; and searches again types matched behind point, for subsequent
4301 ;; calls. Thus, searching for a given type fails only once, and every
4302 ;; object is searched only once at top level (but sometimes more for
4303 ;; nested types).
4307 "Parse elements between BEG and END positions.
4309 SPECIAL prioritize some elements over the others. It can be set
4310 to `first-section', `quote-section', `section' `item' or
4311 `table-row'.
4313 When value is `item', STRUCTURE will be used as the current list
4314 structure.
4316 GRANULARITY determines the depth of the recursion. See
4317 `org-element-parse-buffer' for more information.
4319 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4320 elements.
4322 Elements are accumulated into ACC."
4325 ;; Visible only: skip invisible parts at the beginning of the
4326 ;; element.
4329 ;; When parsing only headlines, skip any text before first one.
4332 ;; Main loop start.
4334 ;; Find current element's type and parse it accordingly to
4335 ;; its category.
4337 end granularity special structure))
4341 ;; Visible only: skip invisible parts between siblings.
4344 ;; Fill ELEMENT contents by side-effect.
4346 ;; If element has no contents, don't modify it.
4348 ;; Greater element: parse it between `contents-begin' and
4349 ;; `contents-end'. Make sure GRANULARITY allows the
4350 ;; recursion, or ELEMENT is a headline, in which case going
4351 ;; inside is mandatory, in order to get sub-level headings.
4359 ;; Possibly switch to a special mode.
4369 granularity visible-only element))
4370 ;; ELEMENT has contents. Parse objects inside, if
4371 ;; GRANULARITY allows it.
4377 ;; Return result.
4378 acc))
4381 "Parse objects between BEG and END and return recursive structure.
4383 Objects are accumulated in ACC.
4385 RESTRICTION is a list of object successors which are allowed in
4386 the current object."
4395 restriction candidates)))
4402 ;; 1. Text before any object. Untabify it.
4407 acc
4411 ;; 2. Object...
4414 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4415 ;; a recursive type.
4423 ;; 3. Text after last object. Untabify it.
4427 acc
4431 ;; Result.
4432 acc))))
4435 "Return an alist of candidates for the next object.
4437 RESTRICTION is a list of object types, as symbols. Only
4438 candidates with such types are looked after.
4440 OBJECTS is the previous candidates alist. If it is set to
4441 `initial', no search has been done before, and all symbols in
4442 RESTRICTION should be looked after.
4444 Return value is an alist whose CAR is the object type and CDR its
4445 beginning position."
4447 nil
4449 ;; When searching for the first time, look for every successor
4450 ;; allowed in RESTRICTION.
4454 restriction)
4455 ;; Focus on objects returned during last search. Keep those
4456 ;; still after point. Search again objects before it.
4462 type)))
4465 objects))))
4468 \f
4469 ;;; Towards A Bijective Process
4470 ;;
4471 ;; The parse tree obtained with `org-element-parse-buffer' is really
4472 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4473 ;; interpreted and expanded into a string with canonical Org syntax.
4474 ;; Hence `org-element-interpret-data'.
4475 ;;
4476 ;; The function relies internally on
4477 ;; `org-element--interpret-affiliated-keywords'.
4479 ;;;###autoload
4481 "Interpret DATA as Org syntax.
4483 DATA is a parse tree, an element, an object or a secondary string
4484 to interpret.
4486 Optional argument PARENT is used for recursive calls. It contains
4487 the element or object containing data, or nil.
4489 Return Org syntax as a string."
4493 ;; Secondary string.
4498 ;; Full Org document.
4503 ;; Plain text: remove `:parent' text property from output.
4505 ;; Element/Object without contents.
4508 data nil))
4509 ;; Element/Object with contents.
4519 ;; Elements directly containing objects must
4520 ;; have their indentation normalized first.
4522 data
4523 ;; When normalizing first paragraph of an
4524 ;; item or a footnote-definition, ignore
4525 ;; first line's indentation.
4532 data
4534 contents)))))))
4536 ;; Build white spaces. If no `:post-blank' property is
4537 ;; specified, assume its value is 0.
4547 "Return ELEMENT's affiliated keywords as Org syntax.
4548 If there is no affiliated keyword, return the empty string."
4558 ": "
4561 value)
4569 ;; All attribute keywords can have multiple lines.
4575 ;; List all ELEMENT's properties matching an attribute line or an
4576 ;; affiliated keyword, but ignore translated keywords since they
4577 ;; cannot belong to the property list.
4584 org-element-keyword-translation-alist)))))
4585 collect prop)
4588 ;; Because interpretation of the parse tree must return the same
4589 ;; number of blank lines between elements and the same number of white
4590 ;; space after objects, some special care must be given to white
4591 ;; spaces.
4592 ;;
4593 ;; The first function, `org-element-normalize-string', ensures any
4594 ;; string different from the empty string will end with a single
4595 ;; newline character.
4596 ;;
4597 ;; The second function, `org-element-normalize-contents', removes
4598 ;; global indentation from the contents of the current element.
4601 "Ensure string S ends with a single newline character.
4603 If S isn't a string return it unchanged. If S is the empty
4604 string, return it. Otherwise, return a new string with a single
4605 newline character at its end."
4613 "Normalize plain text in ELEMENT's contents.
4615 ELEMENT must only contain plain text and objects.
4617 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4618 indentation to compute maximal common indentation.
4620 Return the normalized element that is element with global
4621 indentation removed from its contents. The function assumes that
4622 indentation is not done with TAB characters."
4624 collect-inds ; for byte-compiler
4627 ;; Return list of indentations within BLOB. This is done by
4628 ;; walking recursively BLOB and updating IND-LIST along the
4629 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4630 ;; been seen yet. It is required as this string is the only
4631 ;; one whose indentation doesn't happen after a newline
4632 ;; character.
4640 ;; An indentation of zero means no string will be
4641 ;; modified. Quit the process.
4647 ;; Avoid matching blank or empty lines.
4655 ;; Collect indentation list in ELEMENT. Possibly remove first
4656 ;; value if IGNORE-FIRST is non-nil.
4659 ;; Build ELEMENT back, replacing each string with the same
4660 ;; string minus common indentation.
4665 ;; Return BLOB with all its strings indentation
4666 ;; shortened from MCI white spaces. FIRST-FLAG is
4667 ;; non-nil when the first string hasn't been seen
4668 ;; yet.
4682 org-element-recursive-objects)
4686 blob))))
4690 \f
4691 ;;; The Toolbox
4692 ;;
4693 ;; The first move is to implement a way to obtain the smallest element
4694 ;; containing point. This is the job of `org-element-at-point'. It
4695 ;; basically jumps back to the beginning of section containing point
4696 ;; and moves, element after element, with
4697 ;; `org-element--current-element' until the container is found. Note:
4698 ;; When using `org-element-at-point', secondary values are never
4699 ;; parsed since the function focuses on elements, not on objects.
4700 ;;
4701 ;; At a deeper level, `org-element-context' lists all elements and
4702 ;; objects containing point.
4703 ;;
4704 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4705 ;; internally by navigation and manipulation tools.
4707 ;;;###autoload
4709 "Determine closest element around point.
4711 Return value is a list like (TYPE PROPS) where TYPE is the type
4712 of the element and PROPS a plist of properties associated to the
4713 element.
4715 Possible types are defined in `org-element-all-elements'.
4716 Properties depend on element or object type, but always include
4717 `:begin', `:end', `:parent' and `:post-blank' properties.
4719 As a special case, if point is at the very beginning of a list or
4720 sub-list, returned element will be that list instead of the first
4721 item. In the same way, if point is at the beginning of the first
4722 row of a table, returned element will be the table instead of the
4723 first row.
4725 If optional argument KEEP-TRAIL is non-nil, the function returns
4726 a list of elements leading to element at point. The list's CAR
4727 is always the element at point. The following positions contain
4728 element's siblings, then parents, siblings of parents, until the
4729 first element of current section."
4731 ;; If at a headline, parse it. It is the sole element that
4732 ;; doesn't require to know about context. Be sure to disallow
4733 ;; secondary string parsing, though.
4739 ;; Otherwise move at the beginning of the section containing
4740 ;; point.
4745 element type special-flag trail struct prevs parent)
4748 ;; In empty lines at buffer's beginning, return nil.
4757 ;; In blank lines just after the headline, point still
4758 ;; belongs to the headline.
4767 ;; Parse successively each element, skipping those ending
4768 ;; before original position.
4776 ;; 1. Skip any element ending before point. Also skip
4777 ;; element ending at point when we're sure that another
4778 ;; element has started.
4783 ;; 2. An element containing point is always the element at
4784 ;; point.
4787 ;; 3. At any other greater element type, if point is
4788 ;; within contents, move into it.
4793 ;; Create an anchor for tables and plain lists:
4794 ;; when point is at the very beginning of these
4795 ;; elements, ignoring affiliated keywords,
4796 ;; target them instead of their contents.
4798 ;; When point is at contents end, do not move
4799 ;; into elements with an explicit ending, but
4800 ;; return that element instead.
4804 drawer dynamic-block inlinetask
4805 property-drawer quote-block
4806 special-block))
4807 ;; Corner case: if a list ends at the
4808 ;; end of a buffer without a final new
4809 ;; line, return last element in last
4810 ;; item instead.
4828 ;;;###autoload
4830 "Return closest element or object around point.
4832 Return value is a list like (TYPE PROPS) where TYPE is the type
4833 of the element or object and PROPS a plist of properties
4834 associated to it.
4836 Possible types are defined in `org-element-all-elements' and
4837 `org-element-all-objects'. Properties depend on element or
4838 object type, but always include `:begin', `:end', `:parent' and
4839 `:post-blank'.
4841 Optional argument ELEMENT, when non-nil, is the closest element
4842 containing point, as returned by `org-element-at-point'.
4843 Providing it allows for quicker computation."
4849 context)
4850 ;; Check if point is inside an element containing objects or at
4851 ;; a secondary string. In that case, narrow buffer to the
4852 ;; containing area. Otherwise, return ELEMENT.
4854 ;; At a parsed affiliated keyword, check if we're inside main
4855 ;; or dual value.
4870 ;; Also change type to retrieve correct restrictions.
4872 ;; At an item, objects can only be located within tag, if any.
4882 ;; At an headline or inlinetask, objects are located within
4883 ;; their title.
4890 ;; At a paragraph, a table-row or a verse block, objects are
4891 ;; located within their contents.
4895 ;; CBEG is nil for table rules.
4899 ;; At a parsed keyword, objects are located within value.
4902 org-element-document-properties))
4917 restriction candidates))
4919 candidates)))
4920 ;; If ORIGIN is before next object in element, there's
4921 ;; no point in looking further.
4931 ;; ORIGIN is after OBJECT, so skip it.
4933 ;; ORIGIN is within a non-recursive object or at
4934 ;; an object boundaries: Return that object.
4938 ;; Otherwise, move within current object and
4939 ;; restrict search to the end of its contents.
4946 parent))))))
4949 "Non-nil when elements ELEM-A and ELEM-B are nested."
4958 "Swap elements ELEM-A and ELEM-B.
4959 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4960 end of ELEM-A."
4962 ;; There are two special cases when an element doesn't start at bol:
4963 ;; the first paragraph in an item or in a footnote definition.
4965 ;; Only a paragraph without any affiliated keyword can be moved at
4966 ;; ELEM-A position in such a situation. Note that the case of
4967 ;; a footnote definition is impossible: it cannot contain two
4968 ;; paragraphs in a row because it cannot contain a blank line.
4974 ;; In a special situation, ELEM-A will have no indentation. We'll
4975 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4989 ;; Store overlays responsible for visibility status. We
4990 ;; also need to store their boundaries as they will be
4991 ;; removed from buffer.
4998 ;; Get contents.
5006 ;; Restore ex ELEM-A overlays.
5015 ;; Restore ex ELEM-B overlays.
5024 ;; Local variables:
5025 ;; generated-autoload-file: "org-loaddefs.el"
5026 ;; End:
5028 ;;; org-element.el ends here