| blob | 9183a67284d835a0eccc692b7b8c8b5e86034b7b |
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'. A simple cache mechanism is also
115 ;; provided for these functions.
118 ;;; Code:
124 \f
125 ;;; Definitions And Rules
126 ;;
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
130 ;;
131 ;; These variables really act as a control center for the parsing
132 ;; process.
136 ;; Headlines, inlinetasks.
138 ;; Footnote definitions.
140 ;; Diary sexps.
143 ;; Empty lines.
145 ;; Tables (any type).
147 ;; Blocks (any type), Babel calls and keywords. Note: this
148 ;; is only an indication and need some thorough check.
150 ;; Drawers (any type) and fixed-width areas. This is also
151 ;; only an indication.
153 ;; Horizontal rules.
155 ;; LaTeX environments.
157 ;; Planning and Clock lines.
159 org-deadline-string
160 org-closed-string
161 org-clock-string))
163 ;; Lists.
170 "Regexp to separate paragraphs in an Org buffer.
172 is not sufficient to know if point is at a paragraph ending. See
177 dynamic-block example-block export-block fixed-width
178 footnote-definition headline horizontal-rule inlinetask item
179 keyword latex-environment node-property paragraph plain-list
180 planning property-drawer quote-block quote-section section
181 special-block src-block table table-row verse-block)
186 item plain-list property-drawer quote-block section
187 special-block table)
192 latex-or-entity line-break link macro plain-link radio-target
193 statistics-cookie sub/superscript table-cell target
194 text-markup timestamp)
203 "Alist of translations between object type and successor name.
204 Sharing the same successor comes handy when, for example, the
209 inline-src-block italic line-break latex-fragment link macro
210 radio-target statistics-cookie strike-through subscript superscript
211 table-cell target timestamp underline verbatim)
216 table-cell underline)
226 "Alist between block names and the associated parsing function.
227 Names must be uppercase. Any block whose name has no association
233 Only these types can accept search options and an explicit
239 "List of affiliated keywords as strings.
245 ;; Regular affiliated keywords.
248 "Regexp matching any affiliated keyword.
250 Keyword name is put in match group 1. Moreover, if keyword
251 belongs to `org-element-dual-keywords', put the dual value in
252 match group 2.
260 "Alist of usual translations for keywords.
261 The key is the old name and the value the new one. The property
265 "List of affiliated keywords that can occur more than once in an element.
267 Their value will be consed into a list of strings, which will be
268 returned as the value of the property.
270 This list is checked after translations have been applied. See
271 `org-element-keyword-translation-alist'.
277 "List of affiliated keywords whose value can be parsed.
279 Their value will be stored as a secondary string: a list of
280 strings and objects.
282 This list is checked after translations have been applied. See
286 "List of affiliated keywords which can have a secondary value.
288 In Org syntax, they can be written with optional square brackets
289 before the colons. For example, RESULTS keyword can be
290 associated to a hash value with the following:
292 #+RESULTS[hash-string]: some-source
294 This list is checked after translations have been applied. See
298 "List of properties associated to the whole document.
299 Any keyword in this list will have its value parsed and stored as
313 ;; Ignore all links excepted plain links in a link description.
314 ;; Also ignore radio-targets and line breaks.
318 ;; Remove any variable object from radio target as it would
319 ;; prevent it from being properly recognized.
324 ;; Ignore inline babel call and inline src block as formulas are
325 ;; possible. Also ignore line breaks and statistics cookies.
331 "Alist of objects restrictions.
333 CAR is an element or object type containing objects and CDR is
334 a list of successors that will be called within an element or
335 object of such type.
337 For example, in a `radio-target' object, one can only find
338 entities, latex-fragments, subscript and superscript.
340 This alist also applies to secondary string. For example, an
341 `headline' type element doesn't directly contain objects, but
352 "List of buffer-local variables used when parsing objects.
353 These variables are copied to the temporary buffer created by
357 \f
358 ;;; Accessors and Setters
359 ;;
360 ;; Provide four accessors: `org-element-type', `org-element-property'
361 ;; `org-element-contents' and `org-element-restriction'.
362 ;;
363 ;; Setter functions allow to modify elements by side effect. There is
364 ;; `org-element-put-property', `org-element-set-contents'. These
365 ;; low-level functions are useful to build a parse tree.
366 ;;
367 ;; `org-element-adopt-element', `org-element-set-element',
368 ;; `org-element-extract-element' and `org-element-insert-before' are
369 ;; high-level functions useful to modify a parse tree.
370 ;;
371 ;; `org-element-secondary-p' is a predicate used to know if a given
372 ;; object belongs to a secondary string.
375 "Return type of ELEMENT.
377 The function returns the type of the element or object provided.
378 It can also return the following special value:
379 `plain-text' for a string
380 `org-data' for a complete document
381 nil in any other case."
387 "Extract the value from the PROPERTY of an ELEMENT."
392 "Extract contents from an ELEMENT."
398 "Return restriction associated to ELEMENT.
399 ELEMENT can be an element, an object or a symbol representing an
400 element or object type."
402 org-element-object-restrictions)))
405 "In ELEMENT set PROPERTY to VALUE.
406 Return modified element."
409 element))
412 "Set ELEMENT contents to CONTENTS.
413 Return modified element."
420 "Non-nil when OBJECT belongs to a secondary string.
421 Return value is the property name, as a keyword, or nil."
424 org-element-secondary-value-alist))))
427 property)))
430 "Append elements to the contents of another element.
432 PARENT is an element or object. CHILDREN can be elements,
433 objects, or a strings.
435 The function takes care of setting `:parent' property for CHILD.
436 Return parent element."
437 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
438 ;; string: parent is the list itself.
441 children)
442 ;; Add CHILDREN at the end of PARENT contents.
445 parent
447 ;; Return modified PARENT element.
451 "Extract ELEMENT from parse tree.
452 Remove element from the parse tree by side-effect, and return it
453 with its `:parent' property stripped out."
458 parent secondary
461 parent
463 ;; Return ELEMENT with its :parent removed.
467 "Insert ELEMENT before LOCATION in parse tree.
468 LOCATION is an element, object or string within the parse tree.
469 Parse tree is modified by side effect."
474 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
483 ;; Store SIBLINGS at appropriate place in parse tree.
486 ;; Set appropriate :parent property.
490 "Replace element or object OLD with element or object NEW.
491 The function takes care of setting `:parent' property for NEW."
492 ;; Ensure OLD and NEW have the same parent.
496 ;; We cannot replace OLD with NEW since one of them is not an
497 ;; object or element. We take the long path.
500 ;; Since OLD is going to be changed into NEW by side-effect, first
501 ;; make sure that every element or object within NEW has OLD as
502 ;; parent.
505 ;; Transfer contents.
507 ;; Overwrite OLD's properties with NEW's.
509 ;; Transfer type.
513 \f
514 ;;; Greater elements
515 ;;
516 ;; For each greater element type, we define a parser and an
517 ;; interpreter.
518 ;;
519 ;; A parser returns the element or object as the list described above.
520 ;; Most of them accepts no argument. Though, exceptions exist. Hence
521 ;; every element containing a secondary string (see
522 ;; `org-element-secondary-value-alist') will accept an optional
523 ;; argument to toggle parsing of that secondary string. Moreover,
524 ;; `item' parser requires current list's structure as its first
525 ;; element.
526 ;;
527 ;; An interpreter accepts two arguments: the list representation of
528 ;; the element or object, and its contents. The latter may be nil,
529 ;; depending on the element or object considered. It returns the
530 ;; appropriate Org syntax, as a string.
531 ;;
532 ;; Parsing functions must follow the naming convention:
533 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
534 ;; defined in `org-element-greater-elements'.
535 ;;
536 ;; Similarly, interpreting functions must follow the naming
537 ;; convention: org-element-TYPE-interpreter.
538 ;;
539 ;; With the exception of `headline' and `item' types, greater elements
540 ;; cannot contain other greater elements of their own type.
541 ;;
542 ;; Beside implementing a parser and an interpreter, adding a new
543 ;; greater element requires to tweak `org-element--current-element'.
544 ;; Moreover, the newly defined type must be added to both
545 ;; `org-element-all-elements' and `org-element-greater-elements'.
548 ;;;; Center Block
551 "Parse a center block.
553 LIMIT bounds the search. AFFILIATED is a list of which CAR is
554 the buffer position at the beginning of the first affiliated
555 keyword and CDR is a plist of affiliated keywords along with
556 their value.
558 Return a list whose CAR is `center-block' and CDR is a plist
559 containing `:begin', `:end', `:contents-begin', `:contents-end',
560 `:post-blank' and `:post-affiliated' keywords.
562 Assume point is at the beginning of the block."
566 ;; Incomplete block: parse it as a paragraph.
571 ;; Empty blocks have no contents.
585 :end end
586 :contents-begin contents-begin
587 :contents-end contents-end
593 "Interpret CENTER-BLOCK element as Org syntax.
594 CONTENTS is the contents of the element."
598 ;;;; Drawer
601 "Parse a drawer.
603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
604 the buffer position at the beginning of the first affiliated
605 keyword and CDR is a plist of affiliated keywords along with
606 their value.
608 Return a list whose CAR is `drawer' and CDR is a plist containing
609 `:drawer-name', `:begin', `:end', `:contents-begin',
610 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
612 Assume point is at beginning of drawer."
615 ;; Incomplete drawer: parse it as a paragraph.
623 ;; Empty drawers have no contents.
636 :end end
637 :drawer-name name
638 :contents-begin contents-begin
639 :contents-end contents-end
645 "Interpret DRAWER element as Org syntax.
646 CONTENTS is the contents of the element."
649 contents))
652 ;;;; Dynamic Block
655 "Parse a dynamic block.
657 LIMIT bounds the search. AFFILIATED is a list of which CAR is
658 the buffer position at the beginning of the first affiliated
659 keyword and CDR is a plist of affiliated keywords along with
660 their value.
662 Return a list whose CAR is `dynamic-block' and CDR is a plist
663 containing `:block-name', `:begin', `:end', `:contents-begin',
664 `:contents-end', `:arguments', `:post-blank' and
665 `:post-affiliated' keywords.
667 Assume point is at beginning of dynamic block."
671 ;; Incomplete block: parse it as a paragraph.
680 ;; Empty blocks have no contents.
693 :end end
694 :block-name name
695 :arguments arguments
696 :contents-begin contents-begin
697 :contents-end contents-end
703 "Interpret DYNAMIC-BLOCK element as Org syntax.
704 CONTENTS is the contents of the element."
709 contents))
712 ;;;; Footnote Definition
715 "Parse a footnote definition.
717 LIMIT bounds the search. AFFILIATED is a list of which CAR is
718 the buffer position at the beginning of the first affiliated
719 keyword and CDR is a plist of affiliated keywords along with
720 their value.
722 Return a list whose CAR is `footnote-definition' and CDR is
723 a plist containing `:label', `:begin' `:end', `:contents-begin',
724 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
726 Assume point is at the beginning of the footnote definition."
754 :begin begin
755 :end end
756 :contents-begin contents-begin
757 :contents-end contents-end
763 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
764 CONTENTS is the contents of the footnote-definition."
766 " "
767 contents))
770 ;;;; Headline
773 "Parse a headline.
775 Return a list whose CAR is `headline' and CDR is a plist
776 containing `:raw-value', `:title', `:alt-title', `:begin',
777 `:end', `:pre-blank', `:contents-begin' and `:contents-end',
778 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
779 `:scheduled', `:deadline', `:closed', `:quotedp', `:archivedp',
780 `:commentedp' and `:footnote-section-p' keywords.
782 The plist also contains any property set in the property drawer,
783 with its name in upper cases and colons added at the
784 beginning (i.e. `:CUSTOM_ID').
786 When RAW-SECONDARY-P is non-nil, headline's title will not be
787 parsed as a secondary string, but as a plain string instead.
789 Assume point is at beginning of the headline."
802 raw-value)))
806 raw-value)))
810 ;; Upcase property names. It avoids confusion between
811 ;; properties obtained through property drawer and default
812 ;; properties from the parser (e.g. `:end' and :END:)
822 plist))
824 ;; Read time properties on the line below the headline.
830 org-keyword-time-not-clock-regexp end t)
840 plist))))
852 ;; Clean RAW-VALUE from any quote or comment string.
860 ""
861 raw-value))))
862 ;; Clean TAGS from archive tag, if any.
868 :begin begin
869 :end end
870 :pre-blank
873 :contents-begin contents-begin
874 :contents-end contents-end
875 :level level
877 :tags tags
878 :todo-keyword todo
879 :todo-type todo-type
885 end)
886 :footnote-section-p footnote-section-p
887 :archivedp archivedp
888 :commentedp commentedp
890 time-props
891 standard-props))))
895 headline :alt-title
900 headline :title
906 "Interpret HEADLINE element as Org syntax.
907 CONTENTS is the contents of the element."
934 ;; Align tags.
942 ? )
943 tags))
947 tags))))
949 contents)))
952 ;;;; Inlinetask
955 "Parse an inline task.
957 Return a list whose CAR is `inlinetask' and CDR is a plist
958 containing `:title', `:begin', `:end', `:contents-begin' and
959 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
960 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
961 `:closed' and `:post-blank' keywords.
963 The plist also contains any property set in the property drawer,
964 with its name in upper cases and colons added at the
965 beginning (i.e. `:CUSTOM_ID').
967 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
968 title will not be parsed as a secondary string, but as a plain
969 string instead.
971 Assume point is at beginning of the inline task."
981 ;; Upcase property names. It avoids confusion between
982 ;; properties obtained through property drawer and default
983 ;; properties from the parser (e.g. `:end' and :END:)
993 plist))
995 ;; Read time properties on the line below the inlinetask
996 ;; opening string.
1002 org-keyword-time-not-clock-regexp end t)
1012 plist))))
1030 :begin begin
1031 :end end
1032 :contents-begin contents-begin
1033 :contents-end contents-end
1036 :tags tags
1037 :todo-keyword todo
1038 :todo-type todo-type
1040 time-props
1041 standard-props))))
1043 inlinetask :title
1046 raw-value
1048 inlinetask))))))
1051 "Interpret INLINETASK element as Org syntax.
1052 CONTENTS is the contents of inlinetask."
1067 ;; Align tags.
1075 ? )
1076 tags))
1080 tags))))
1081 ;; Prefer degenerate inlinetasks when there are no
1082 ;; contents.
1085 contents
1089 ;;;; Item
1092 "Parse an item.
1094 STRUCT is the structure of the plain list.
1096 Return a list whose CAR is `item' and CDR is a plist containing
1097 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1098 `:checkbox', `:counter', `:tag', `:structure' and `:post-blank'
1099 keywords.
1101 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1102 any, will not be parsed as a secondary string, but as a plain
1103 string instead.
1105 Assume point is at the beginning of the item."
1129 ;; Ignore tags in un-ordered lists: they are just
1130 ;; a part of item's body.
1136 ;; If first line isn't empty, contents really start
1137 ;; at the text after item's meta-data.
1146 :begin begin
1147 :end end
1148 ;; CONTENTS-BEGIN and CONTENTS-END may be
1149 ;; mixed up in the case of an empty item
1150 ;; separated from the next by a blank line.
1151 ;; Thus ensure the former is always the
1152 ;; smallest.
1155 :checkbox checkbox
1156 :counter counter
1157 :structure struct
1160 item :tag
1168 "Interpret ITEM element as Org syntax.
1169 CONTENTS is the contents of the element."
1179 ;; Compute indentation.
1184 ;; Indent contents.
1186 bullet
1200 ;;;; Plain List
1203 ;; Return structure of list at point. Internal function. See
1204 ;; `org-list-struct' for details.
1209 items struct)
1214 ;; At limit: end all items.
1223 ;; At list end: end all items.
1228 ;; At a new item: end previous sibling.
1240 ind
1241 bullet
1244 ;; Description tag.
1248 ;; Ending position, unknown so far.
1249 nil)))
1250 items))
1252 ;; Skip empty lines.
1254 ;; Skip inline tasks and blank lines along the way.
1261 ;; At some text line. Check if it ends any previous item.
1273 ;; Skip blocks (any type) and drawers contents.
1279 limit t)))
1285 "Parse a plain list.
1287 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1288 the buffer position at the beginning of the first affiliated
1289 keyword and CDR is a plist of affiliated keywords along with
1290 their value. STRUCTURE is the structure of the plain list being
1291 parsed.
1293 Return a list whose CAR is `plain-list' and CDR is a plist
1294 containing `:type', `:begin', `:end', `:contents-begin' and
1295 `:contents-end', `:structure', `:post-blank' and
1296 `:post-affiliated' keywords.
1298 Assume point is at the beginning of the list."
1312 pos))
1316 ;; Return value.
1320 :begin begin
1321 :end end
1322 :contents-begin contents-begin
1323 :contents-end contents-end
1324 :structure struct
1330 "Interpret PLAIN-LIST element as Org syntax.
1331 CONTENTS is the contents of the element."
1339 ;;;; Property Drawer
1342 "Parse a property drawer.
1344 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1345 the buffer position at the beginning of the first affiliated
1346 keyword and CDR is a plist of affiliated keywords along with
1347 their value.
1349 Return a list whose CAR is `property-drawer' and CDR is a plist
1350 containing `:begin', `:end', `:contents-begin', `:contents-end',
1351 `:post-blank' and `:post-affiliated' keywords.
1353 Assume point is at the beginning of the property drawer."
1358 ;; Incomplete drawer: parse it as a paragraph.
1376 :end end
1377 :contents-begin contents-begin
1378 :contents-end contents-end
1384 "Interpret PROPERTY-DRAWER element as Org syntax.
1385 CONTENTS is the properties within the drawer."
1389 ;;;; Quote Block
1392 "Parse a quote block.
1394 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1395 the buffer position at the beginning of the first affiliated
1396 keyword and CDR is a plist of affiliated keywords along with
1397 their value.
1399 Return a list whose CAR is `quote-block' and CDR is a plist
1400 containing `:begin', `:end', `:contents-begin', `:contents-end',
1401 `:post-blank' and `:post-affiliated' keywords.
1403 Assume point is at the beginning of the block."
1407 ;; Incomplete block: parse it as a paragraph.
1413 ;; Empty blocks have no contents.
1426 :end end
1427 :contents-begin contents-begin
1428 :contents-end contents-end
1434 "Interpret QUOTE-BLOCK element as Org syntax.
1435 CONTENTS is the contents of the element."
1439 ;;;; Section
1442 "Parse a section.
1444 LIMIT bounds the search.
1446 Return a list whose CAR is `section' and CDR is a plist
1447 containing `:begin', `:end', `:contents-begin', `contents-end'
1448 and `:post-blank' keywords."
1450 ;; Beginning of section is the beginning of the first non-blank
1451 ;; line after previous headline.
1460 :end end
1461 :contents-begin begin
1462 :contents-end pos-before-blank
1466 "Interpret SECTION element as Org syntax.
1467 CONTENTS is the contents of the element."
1468 contents)
1471 ;;;; Special Block
1474 "Parse a special block.
1476 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1477 the buffer position at the beginning of the first affiliated
1478 keyword and CDR is a plist of affiliated keywords along with
1479 their value.
1481 Return a list whose CAR is `special-block' and CDR is a plist
1482 containing `:type', `:begin', `:end', `:contents-begin',
1483 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1485 Assume point is at the beginning of the block."
1492 limit t)))
1493 ;; Incomplete block: parse it as a paragraph.
1499 ;; Empty blocks have no contents.
1512 :begin begin
1513 :end end
1514 :contents-begin contents-begin
1515 :contents-end contents-end
1521 "Interpret SPECIAL-BLOCK element as Org syntax.
1522 CONTENTS is the contents of the element."
1527 \f
1528 ;;; Elements
1529 ;;
1530 ;; For each element, a parser and an interpreter are also defined.
1531 ;; Both follow the same naming convention used for greater elements.
1532 ;;
1533 ;; Also, as for greater elements, adding a new element type is done
1534 ;; through the following steps: implement a parser and an interpreter,
1535 ;; tweak `org-element--current-element' so that it recognizes the new
1536 ;; type and add that new type to `org-element-all-elements'.
1537 ;;
1538 ;; As a special case, when the newly defined type is a block type,
1539 ;; `org-element-block-name-alist' has to be modified accordingly.
1542 ;;;; Babel Call
1545 "Parse a babel call.
1547 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1548 the buffer position at the beginning of the first affiliated
1549 keyword and CDR is a plist of affiliated keywords along with
1550 their value.
1552 Return a list whose CAR is `babel-call' and CDR is a plist
1553 containing `:begin', `:end', `:value', `:post-blank' and
1554 `:post-affiliated' as keywords."
1568 :end end
1569 :value value
1575 "Interpret BABEL-CALL element as Org syntax.
1576 CONTENTS is nil."
1580 ;;;; Clock
1583 "Parse a clock.
1585 LIMIT bounds the search.
1587 Return a list whose CAR is `clock' and CDR is a plist containing
1588 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1589 as keywords."
1609 :value value
1610 :duration duration
1611 :begin begin
1612 :end end
1616 "Interpret CLOCK element as Org syntax.
1617 CONTENTS is nil."
1625 "%2s:%02s"
1629 ;;;; Comment
1632 "Parse a comment.
1634 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1635 the buffer position at the beginning of the first affiliated
1636 keyword and CDR is a plist of affiliated keywords along with
1637 their value.
1639 Return a list whose CAR is `comment' and CDR is a plist
1640 containing `:begin', `:end', `:value', `:post-blank',
1641 `:post-affiliated' keywords.
1643 Assume point is at comment beginning."
1652 ;; Get comments ending.
1655 ;; Accumulate lines without leading hash and first
1656 ;; whitespace.
1670 :end end
1671 :value value
1677 "Interpret COMMENT element as Org syntax.
1678 CONTENTS is nil."
1682 ;;;; Comment Block
1685 "Parse an export block.
1687 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1688 the buffer position at the beginning of the first affiliated
1689 keyword and CDR is a plist of affiliated keywords along with
1690 their value.
1692 Return a list whose CAR is `comment-block' and CDR is a plist
1693 containing `:begin', `:end', `:value', `:post-blank' and
1694 `:post-affiliated' keywords.
1696 Assume point is at comment block beginning."
1700 ;; Incomplete block: parse it as a paragraph.
1713 contents-begin contents-end)))
1717 :end end
1718 :value value
1724 "Interpret COMMENT-BLOCK element as Org syntax.
1725 CONTENTS is nil."
1730 ;;;; Diary Sexp
1733 "Parse a diary sexp.
1735 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1736 the buffer position at the beginning of the first affiliated
1737 keyword and CDR is a plist of affiliated keywords along with
1738 their value.
1740 Return a list whose CAR is `diary-sexp' and CDR is a plist
1741 containing `:begin', `:end', `:value', `:post-blank' and
1742 `:post-affiliated' keywords."
1754 :begin begin
1755 :end end
1761 "Interpret DIARY-SEXP as Org syntax.
1762 CONTENTS is nil."
1766 ;;;; Example Block
1769 "Parse an example block.
1771 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1772 the buffer position at the beginning of the first affiliated
1773 keyword and CDR is a plist of affiliated keywords along with
1774 their value.
1776 Return a list whose CAR is `example-block' and CDR is a plist
1777 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1778 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1779 `:value', `:post-blank' and `:post-affiliated' keywords."
1783 ;; Incomplete block: parse it as a paragraph.
1791 ;; Switches analysis
1798 ;; Should labels be retained in (or stripped from) example
1799 ;; blocks?
1804 ;; What should code-references use - labels or
1805 ;; line-numbers?
1814 ;; Standard block parsing.
1822 contents-begin contents-end))
1823 block-ind))
1832 :end end
1833 :value value
1834 :switches switches
1835 :number-lines number-lines
1836 :preserve-indent preserve-indent
1837 :retain-labels retain-labels
1838 :use-labels use-labels
1839 :label-fmt label-fmt
1845 "Interpret EXAMPLE-BLOCK element as Org syntax.
1846 CONTENTS is nil."
1853 value
1858 ;;;; Export Block
1861 "Parse an export block.
1863 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1864 the buffer position at the beginning of the first affiliated
1865 keyword and CDR is a plist of affiliated keywords along with
1866 their value.
1868 Return a list whose CAR is `export-block' and CDR is a plist
1869 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1870 `:post-affiliated' keywords.
1872 Assume point is at export-block beginning."
1879 ;; Incomplete block: parse it as a paragraph.
1892 contents-end)))
1896 :end end
1897 :type type
1898 :value value
1904 "Interpret EXPORT-BLOCK element as Org syntax.
1905 CONTENTS is nil."
1912 ;;;; Fixed-width
1915 "Parse a fixed-width section.
1917 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1918 the buffer position at the beginning of the first affiliated
1919 keyword and CDR is a plist of affiliated keywords along with
1920 their value.
1922 Return a list whose CAR is `fixed-width' and CDR is a plist
1923 containing `:begin', `:end', `:value', `:post-blank' and
1924 `:post-affiliated' keywords.
1926 Assume point is at the beginning of the fixed-width area."
1930 value
1935 ;; Accumulate text without starting colons.
1948 :end end
1949 :value value
1955 "Interpret FIXED-WIDTH element as Org syntax.
1956 CONTENTS is nil."
1964 ;;;; Horizontal Rule
1967 "Parse an horizontal rule.
1969 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1970 the buffer position at the beginning of the first affiliated
1971 keyword and CDR is a plist of affiliated keywords along with
1972 their value.
1974 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1975 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1976 keywords."
1986 :end end
1992 "Interpret HORIZONTAL-RULE element as Org syntax.
1993 CONTENTS is nil."
1997 ;;;; Keyword
2000 "Parse a keyword at point.
2002 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2003 the buffer position at the beginning of the first affiliated
2004 keyword and CDR is a plist of affiliated keywords along with
2005 their value.
2007 Return a list whose CAR is `keyword' and CDR is a plist
2008 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2009 `:post-affiliated' keywords."
2023 :value value
2024 :begin begin
2025 :end end
2031 "Interpret KEYWORD element as Org syntax.
2032 CONTENTS is nil."
2038 ;;;; Latex Environment
2041 "Parse a LaTeX environment.
2043 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2044 the buffer position at the beginning of the first affiliated
2045 keyword and CDR is a plist of affiliated keywords along with
2046 their value.
2048 Return a list whose CAR is `latex-environment' and CDR is a plist
2049 containing `:begin', `:end', `:value', `:post-blank' and
2050 `:post-affiliated' keywords.
2052 Assume point is at the beginning of the latex environment."
2059 limit t))
2060 ;; Incomplete latex environment: parse it as a paragraph.
2070 :end end
2071 :value value
2077 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2078 CONTENTS is nil."
2082 ;;;; Node Property
2085 "Parse a node-property at point.
2087 LIMIT bounds the search.
2089 Return a list whose CAR is `node-property' and CDR is a plist
2090 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2091 keywords."
2103 :value value
2104 :begin begin
2105 :end end
2109 "Interpret NODE-PROPERTY element as Org syntax.
2110 CONTENTS is nil."
2116 ;;;; Paragraph
2119 "Parse a paragraph.
2121 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2122 the buffer position at the beginning of the first affiliated
2123 keyword and CDR is a plist of affiliated keywords along with
2124 their value.
2126 Return a list whose CAR is `paragraph' and CDR is a plist
2127 containing `:begin', `:end', `:contents-begin' and
2128 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2130 Assume point is at the beginning of the paragraph."
2139 limit
2140 ;; A matching `org-element-paragraph-separate' is not
2141 ;; necessarily the end of the paragraph. In
2142 ;; particular, lines starting with # or : as a first
2143 ;; non-space character are ambiguous. We have check
2144 ;; if they are valid Org syntax (i.e. not an
2145 ;; incomplete keyword).
2149 ;; There's no ambiguity for other symbols or
2150 ;; empty lines: stop here.
2152 ;; Stop at valid fixed-width areas.
2154 ;; Stop at drawers.
2159 ;; Stop at valid comments.
2161 ;; Stop at valid dynamic blocks.
2166 ;; Stop at valid blocks.
2173 limit t)))
2174 ;; Stop at valid latex environments.
2182 limit t)))
2183 ;; Stop at valid keywords.
2185 ;; Skip everything else.
2202 :end end
2203 :contents-begin contents-begin
2204 :contents-end contents-end
2210 "Interpret PARAGRAPH element as Org syntax.
2211 CONTENTS is the contents of the element."
2212 contents)
2215 ;;;; Planning
2218 "Parse a planning.
2220 LIMIT bounds the search.
2222 Return a list whose CAR is `planning' and CDR is a plist
2223 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2224 and `:post-blank' keywords."
2234 closed deadline scheduled)
2246 :deadline deadline
2247 :scheduled scheduled
2248 :begin begin
2249 :end end
2253 "Interpret PLANNING element as Org syntax.
2254 CONTENTS is nil."
2256 'identity
2273 ;;;; Quote Section
2276 "Parse a quote section.
2278 LIMIT bounds the search.
2280 Return a list whose CAR is `quote-section' and CDR is a plist
2281 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2283 Assume point is at beginning of the section."
2294 :end end
2295 :value value
2299 "Interpret QUOTE-SECTION element as Org syntax.
2300 CONTENTS is nil."
2304 ;;;; Src Block
2307 "Parse a src block.
2309 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2310 the buffer position at the beginning of the first affiliated
2311 keyword and CDR is a plist of affiliated keywords along with
2312 their value.
2314 Return a list whose CAR is `src-block' and CDR is a plist
2315 containing `:language', `:switches', `:parameters', `:begin',
2316 `:end', `:number-lines', `:retain-labels', `:use-labels',
2317 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2318 `:post-affiliated' keywords.
2320 Assume point is at the beginning of the block."
2323 limit t)))
2324 ;; Incomplete block: parse it as a paragraph.
2330 ;; Get language as a string.
2339 ;; Get switches.
2341 ;; Get parameters.
2343 ;; Switches analysis
2354 ;; Should labels be retained in (or stripped from)
2355 ;; src blocks?
2360 ;; What should code-references use - labels or
2361 ;; line-numbers?
2366 ;; Indentation.
2368 ;; Retrieve code.
2373 block-ind))
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 :value value
2400 "Interpret SRC-BLOCK element as Org syntax.
2401 CONTENTS is nil."
2410 val)
2424 ;;;; Table
2427 "Parse a table at point.
2429 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2430 the buffer position at the beginning of the first affiliated
2431 keyword and CDR is a plist of affiliated keywords along with
2432 their value.
2434 Return a list whose CAR is `table' and CDR is a plist containing
2435 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2436 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2437 keywords.
2439 Assume point is at the beginning of the table."
2453 acc))
2460 :end end
2461 :type type
2462 :tblfm tblfm
2463 ;; Only `org' tables have contents. `table.el' tables
2464 ;; use a `:value' property to store raw table as
2465 ;; a string.
2470 table-begin table-end))
2476 "Interpret TABLE element as Org syntax.
2477 CONTENTS is nil."
2488 ;;;; Table Row
2491 "Parse table row at point.
2493 LIMIT bounds the search.
2495 Return a list whose CAR is `table-row' and CDR is a plist
2496 containing `:begin', `:end', `:contents-begin', `:contents-end',
2497 `:type' and `:post-blank' keywords."
2501 ;; A table rule has no contents. In that case, ensure
2502 ;; CONTENTS-BEGIN matches CONTENTS-END.
2514 :begin begin
2515 :end end
2516 :contents-begin contents-begin
2517 :contents-end contents-end
2521 "Interpret TABLE-ROW element as Org syntax.
2522 CONTENTS is the contents of the table row."
2527 ;;;; Verse Block
2530 "Parse a verse block.
2532 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2533 the buffer position at the beginning of the first affiliated
2534 keyword and CDR is a plist of affiliated keywords along with
2535 their value.
2537 Return a list whose CAR is `verse-block' and CDR is a plist
2538 containing `:begin', `:end', `:contents-begin', `:contents-end',
2539 `:post-blank' and `:post-affiliated' keywords.
2541 Assume point is at beginning of the block."
2545 ;; Incomplete block: parse it as a paragraph.
2560 :end end
2561 :contents-begin contents-begin
2562 :contents-end contents-end
2568 "Interpret VERSE-BLOCK element as Org syntax.
2569 CONTENTS is verse block contents."
2573 \f
2574 ;;; Objects
2575 ;;
2576 ;; Unlike to elements, interstices can be found between objects.
2577 ;; That's why, along with the parser, successor functions are provided
2578 ;; for each object. Some objects share the same successor (i.e. `code'
2579 ;; and `verbatim' objects).
2580 ;;
2581 ;; A successor must accept a single argument bounding the search. It
2582 ;; will return either a cons cell whose CAR is the object's type, as
2583 ;; a symbol, and CDR the position of its next occurrence, or nil.
2584 ;;
2585 ;; Successors follow the naming convention:
2586 ;; org-element-NAME-successor, where NAME is the name of the
2587 ;; successor, as defined in `org-element-all-successors'.
2588 ;;
2589 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2590 ;; object types they can contain will be specified in
2591 ;; `org-element-object-restrictions'.
2592 ;;
2593 ;; Adding a new type of object is simple. Implement a successor,
2594 ;; a parser, and an interpreter for it, all following the naming
2595 ;; convention. Register type in `org-element-all-objects' and
2596 ;; successor in `org-element-all-successors'. Maybe tweak
2597 ;; restrictions about it, and that's it.
2600 ;;;; Bold
2603 "Parse bold object at point.
2605 Return a list whose CAR is `bold' and CDR is a plist with
2606 `:begin', `:end', `:contents-begin' and `:contents-end' and
2607 `:post-blank' keywords.
2609 Assume point is at the first star marker."
2621 :end end
2622 :contents-begin contents-begin
2623 :contents-end contents-end
2627 "Interpret BOLD object as Org syntax.
2628 CONTENTS is the contents of the object."
2632 "Search for the next text-markup object.
2634 Return value is a cons cell whose CAR is a symbol among `bold',
2635 `italic', `underline', `strike-through', `code' and `verbatim'
2636 and CDR is beginning position."
2652 ;;;; Code
2655 "Parse code object at point.
2657 Return a list whose CAR is `code' and CDR is a plist with
2658 `:value', `:begin', `:end' and `:post-blank' keywords.
2660 Assume point is at the first tilde marker."
2671 :begin begin
2672 :end end
2676 "Interpret CODE object as Org syntax.
2677 CONTENTS is nil."
2681 ;;;; Entity
2684 "Parse entity at point.
2686 Return a list whose CAR is `entity' and CDR a plist with
2687 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2688 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2689 keywords.
2691 Assume point is at the beginning of the entity."
2693 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2709 :begin begin
2710 :end end
2711 :use-brackets-p bracketsp
2715 "Interpret ENTITY object as Org syntax.
2716 CONTENTS is nil."
2722 "Search for the next latex-fragment or entity object.
2724 Return value is a cons cell whose CAR is `entity' or
2725 `latex-fragment' and CDR is beginning position."
2729 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2736 ;; Determine if it's a real entity or a LaTeX command.
2739 ;; No entity nor command: point is at a LaTeX fragment.
2740 ;; Determine its type to get the correct beginning position.
2749 ;;;; Export Snippet
2752 "Parse export snippet at point.
2754 Return a list whose CAR is `export-snippet' and CDR a plist with
2755 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2756 keywords.
2758 Assume point is at the beginning of the snippet."
2770 :value value
2771 :begin begin
2772 :end end
2776 "Interpret EXPORT-SNIPPET object as Org syntax.
2777 CONTENTS is nil."
2783 "Search for the next export-snippet object.
2785 Return value is a cons cell whose CAR is `export-snippet' and CDR
2786 its beginning position."
2795 ;;;; Footnote Reference
2798 "Parse footnote reference at point.
2800 Return a list whose CAR is `footnote-reference' and CDR a plist
2801 with `:label', `:type', `:inline-definition', `:begin', `:end'
2802 and `:post-blank' as keywords."
2824 :type type
2825 :begin begin
2826 :end end
2829 footnote-reference :inline-definition
2834 footnote-reference))))))
2837 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2838 CONTENTS is nil."
2848 "Search for the next footnote-reference object.
2850 Return value is a cons cell whose CAR is `footnote-reference' and
2851 CDR is beginning position."
2865 ;;;; Inline Babel Call
2868 "Parse inline babel call at point.
2870 Return a list whose CAR is `inline-babel-call' and CDR a plist
2871 with `:begin', `:end', `:value' and `:post-blank' as keywords.
2873 Assume point is at the beginning of the babel call."
2885 :end end
2886 :value value
2890 "Interpret INLINE-BABEL-CALL object as Org syntax.
2891 CONTENTS is nil."
2895 "Search for the next inline-babel-call object.
2897 Return value is a cons cell whose CAR is `inline-babel-call' and
2898 CDR is beginning position."
2900 ;; Use a simplified version of
2901 ;; `org-babel-inline-lob-one-liner-regexp'.
2904 nil t)
2908 ;;;; Inline Src Block
2911 "Parse inline source block at point.
2913 Return a list whose CAR is `inline-src-block' and CDR a plist
2914 with `:begin', `:end', `:language', `:value', `:parameters' and
2915 `:post-blank' as keywords.
2917 Assume point is at the beginning of the inline src block."
2930 :value value
2931 :parameters parameters
2932 :begin begin
2933 :end end
2937 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2938 CONTENTS is nil."
2943 language
2945 body)))
2948 "Search for the next inline-babel-call element.
2950 Return value is a cons cell whose CAR is `inline-babel-call' and
2951 CDR is beginning position."
2957 ;;;; Italic
2960 "Parse italic object at point.
2962 Return a list whose CAR is `italic' and CDR is a plist with
2963 `:begin', `:end', `:contents-begin' and `:contents-end' and
2964 `:post-blank' keywords.
2966 Assume point is at the first slash marker."
2978 :end end
2979 :contents-begin contents-begin
2980 :contents-end contents-end
2984 "Interpret ITALIC object as Org syntax.
2985 CONTENTS is the contents of the object."
2989 ;;;; Latex Fragment
2992 "Parse LaTeX fragment at point.
2994 Return a list whose CAR is `latex-fragment' and CDR a plist with
2995 `:value', `:begin', `:end', and `:post-blank' as keywords.
2997 Assume point is at the beginning of the LaTeX fragment."
3010 ;; None found: it's a macro.
3019 :begin begin
3020 :end end
3024 "Interpret LATEX-FRAGMENT object as Org syntax.
3025 CONTENTS is nil."
3028 ;;;; Line Break
3031 "Parse line break at point.
3033 Return a list whose CAR is `line-break', and CDR a plist with
3034 `:begin', `:end' and `:post-blank' keywords.
3036 Assume point is at the beginning of the line break."
3043 "Interpret LINE-BREAK object as Org syntax.
3044 CONTENTS is nil."
3048 "Search for the next line-break object.
3050 Return value is a cons cell whose CAR is `line-break' and CDR is
3051 beginning position."
3055 ;; A line break can only happen on a non-empty line.
3060 ;;;; Link
3063 "Parse link at point.
3065 Return a list whose CAR is `link' and CDR a plist with `:type',
3066 `:path', `:raw-link', `:application', `:search-option', `:begin',
3067 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3068 keywords.
3070 Assume point is at the beginning of the link."
3073 end contents-begin contents-end link-end post-blank path type
3074 raw-link link search-option application)
3076 ;; Type 1: Text targeted from a radio target.
3081 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3086 ;; RAW-LINK is the original link. Expand any
3087 ;; abbreviation in it.
3091 ;; Determine TYPE of link and set PATH accordingly.
3093 ;; File type.
3097 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3100 ;; Id type: PATH is the id.
3103 ;; Code-ref type: PATH is the name of the reference.
3106 ;; Custom-id type: PATH is the name of the custom id.
3109 ;; Fuzzy type: Internal link either matches a target, an
3110 ;; headline name or nothing. PATH is the target or
3111 ;; headline's name.
3113 ;; Type 3: Plain link, i.e. http://orgmode.org
3119 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3126 ;; In any case, deduce end point after trailing white space from
3127 ;; LINK-END variable.
3130 ;; Extract search option and opening application out of
3131 ;; "file"-type links.
3133 ;; Application.
3138 ;; Extract search option from PATH.
3142 ;; Make sure TYPE always reports "file".
3146 :path path
3148 :application application
3149 :search-option search-option
3150 :begin begin
3151 :end end
3152 :contents-begin contents-begin
3153 :contents-end contents-end
3157 "Interpret LINK object as Org syntax.
3158 CONTENTS is the contents of the object, or nil."
3163 raw-link
3167 "Search for the next link object.
3169 Return value is a cons cell whose CAR is `link' and CDR is
3170 beginning position."
3179 "Search for the next plain link object.
3181 Return value is a cons cell whose CAR is `link' and CDR is
3182 beginning position."
3187 ;;;; Macro
3190 "Parse macro at point.
3192 Return a list whose CAR is `macro' and CDR a plist with `:key',
3193 `:args', `:begin', `:end', `:value' and `:post-blank' as
3194 keywords.
3196 Assume point is at the macro."
3207 ;; Do not use `org-split-string' since empty
3208 ;; strings are meaningful here.
3216 args nil t)
3220 :value value
3221 :args args
3222 :begin begin
3223 :end end
3227 "Interpret MACRO object as Org syntax.
3228 CONTENTS is nil."
3232 "Search for the next macro object.
3234 Return value is cons cell whose CAR is `macro' and CDR is
3235 beginning position."
3239 nil t)
3243 ;;;; Radio-target
3246 "Parse radio target at point.
3248 Return a list whose CAR is `radio-target' and CDR a plist with
3249 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3250 and `:post-blank' as keywords.
3252 Assume point is at the radio target."
3264 :end end
3265 :contents-begin contents-begin
3266 :contents-end contents-end
3267 :post-blank post-blank
3271 "Interpret TARGET object as Org syntax.
3272 CONTENTS is the contents of the object."
3276 "Search for the next radio-target object.
3278 Return value is a cons cell whose CAR is `radio-target' and CDR
3279 is beginning position."
3285 ;;;; Statistics Cookie
3288 "Parse statistics cookie at point.
3290 Return a list whose CAR is `statistics-cookie', and CDR a plist
3291 with `:begin', `:end', `:value' and `:post-blank' keywords.
3293 Assume point is at the beginning of the statistics-cookie."
3304 :end end
3305 :value value
3309 "Interpret STATISTICS-COOKIE object as Org syntax.
3310 CONTENTS is nil."
3314 "Search for the next statistics cookie object.
3316 Return value is a cons cell whose CAR is `statistics-cookie' and
3317 CDR is beginning position."
3323 ;;;; Strike-Through
3326 "Parse strike-through object at point.
3328 Return a list whose CAR is `strike-through' and CDR is a plist
3329 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3330 `:post-blank' keywords.
3332 Assume point is at the first plus sign marker."
3344 :end end
3345 :contents-begin contents-begin
3346 :contents-end contents-end
3350 "Interpret STRIKE-THROUGH object as Org syntax.
3351 CONTENTS is the contents of the object."
3355 ;;;; Subscript
3358 "Parse subscript at point.
3360 Return a list whose CAR is `subscript' and CDR a plist with
3361 `:begin', `:end', `:contents-begin', `:contents-end',
3362 `:use-brackets-p' and `:post-blank' as keywords.
3364 Assume point is at the underscore."
3368 t
3379 :end end
3380 :use-brackets-p bracketsp
3381 :contents-begin contents-begin
3382 :contents-end contents-end
3386 "Interpret SUBSCRIPT object as Org syntax.
3387 CONTENTS is the contents of the object."
3390 contents))
3393 "Search for the next sub/superscript object.
3395 Return value is a cons cell whose CAR is either `subscript' or
3396 `superscript' and CDR is beginning position."
3404 ;;;; Superscript
3407 "Parse superscript at point.
3409 Return a list whose CAR is `superscript' and CDR a plist with
3410 `:begin', `:end', `:contents-begin', `:contents-end',
3411 `:use-brackets-p' and `:post-blank' as keywords.
3413 Assume point is at the caret."
3427 :end end
3428 :use-brackets-p bracketsp
3429 :contents-begin contents-begin
3430 :contents-end contents-end
3434 "Interpret SUPERSCRIPT object as Org syntax.
3435 CONTENTS is the contents of the object."
3438 contents))
3441 ;;;; Table Cell
3444 "Parse table cell at point.
3446 Return a list whose CAR is `table-cell' and CDR is a plist
3447 containing `:begin', `:end', `:contents-begin', `:contents-end'
3448 and `:post-blank' keywords."
3456 :end end
3457 :contents-begin contents-begin
3458 :contents-end contents-end
3462 "Interpret TABLE-CELL element as Org syntax.
3463 CONTENTS is the contents of the cell, or nil."
3467 "Search for the next table-cell object.
3469 Return value is a cons cell whose CAR is `table-cell' and CDR is
3470 beginning position."
3474 ;;;; Target
3477 "Parse target at point.
3479 Return a list whose CAR is `target' and CDR a plist with
3480 `:begin', `:end', `:value' and `:post-blank' as keywords.
3482 Assume point is at the target."
3492 :end end
3493 :value value
3497 "Interpret TARGET object as Org syntax.
3498 CONTENTS is nil."
3502 "Search for the next target object.
3504 Return value is a cons cell whose CAR is `target' and CDR is
3505 beginning position."
3511 ;;;; Timestamp
3514 "Parse time stamp at point.
3516 Return a list whose CAR is `timestamp', and CDR a plist with
3517 `:type', `:raw-value', `:year-start', `:month-start',
3518 `:day-start', `:hour-start', `:minute-start', `:year-end',
3519 `:month-end', `:day-end', `:hour-end', `:minute-end',
3520 `:repeater-type', `:repeater-value', `:repeater-unit',
3521 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3522 `:end', `:value' and `:post-blank' keywords.
3524 Assume point is at the beginning of the timestamp."
3542 date-start)
3553 raw-value)
3555 :repeater-type
3561 :repeater-unit
3570 :warning-unit
3573 year-start month-start day-start hour-start minute-start year-end
3574 month-end day-end hour-end minute-end)
3575 ;; Parse date-start.
3583 ;; Compute date-end. It can be provided directly in time-stamp,
3584 ;; or extracted from time range. Otherwise, it defaults to the
3585 ;; same values as date-start.
3595 :raw-value raw-value
3596 :year-start year-start
3597 :month-start month-start
3598 :day-start day-start
3599 :hour-start hour-start
3600 :minute-start minute-start
3601 :year-end year-end
3602 :month-end month-end
3603 :day-end day-end
3604 :hour-end hour-end
3605 :minute-end minute-end
3606 :begin begin
3607 :end end
3609 repeater-props
3610 warning-props)))))
3613 "Interpret TIMESTAMP object as Org syntax.
3614 CONTENTS is nil."
3633 ;; Build an Org timestamp string from TIME. ACTIVEP is
3634 ;; non-nil when time stamp is active. If WITH-TIME-P is
3635 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3636 ;; specify a time range in the timestamp. REPEAT-STRING is
3637 ;; the repeater string, if any.
3641 org-time-stamp-formats)
3642 time)))
3648 nil nil ts)))
3653 " "
3654 s
3656 ;; Return value.
3657 ts)))
3669 build-ts-string
3688 0
3696 "--"
3708 "Search for the next timestamp object.
3710 Return value is a cons cell whose CAR is `timestamp' and CDR is
3711 beginning position."
3719 nil t)
3723 ;;;; Underline
3726 "Parse underline object at point.
3728 Return a list whose CAR is `underline' and CDR is a plist with
3729 `:begin', `:end', `:contents-begin' and `:contents-end' and
3730 `:post-blank' keywords.
3732 Assume point is at the first underscore marker."
3744 :end end
3745 :contents-begin contents-begin
3746 :contents-end contents-end
3750 "Interpret UNDERLINE object as Org syntax.
3751 CONTENTS is the contents of the object."
3755 ;;;; Verbatim
3758 "Parse verbatim object at point.
3760 Return a list whose CAR is `verbatim' and CDR is a plist with
3761 `:value', `:begin', `:end' and `:post-blank' keywords.
3763 Assume point is at the first equal sign marker."
3774 :begin begin
3775 :end end
3779 "Interpret VERBATIM object as Org syntax.
3780 CONTENTS is nil."
3784 \f
3785 ;;; Parsing Element Starting At Point
3786 ;;
3787 ;; `org-element--current-element' is the core function of this section.
3788 ;; It returns the Lisp representation of the element starting at
3789 ;; point.
3790 ;;
3791 ;; `org-element--current-element' makes use of special modes. They
3792 ;; are activated for fixed element chaining (i.e. `plain-list' >
3793 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3794 ;; `section'). Special modes are: `first-section', `item',
3795 ;; `node-property', `quote-section', `section' and `table-row'.
3799 "Parse the element starting at point.
3801 Return value is a list like (TYPE PROPS) where TYPE is the type
3802 of the element and PROPS a plist of properties associated to the
3803 element.
3805 Possible types are defined in `org-element-all-elements'.
3807 LIMIT bounds the search.
3809 Optional argument GRANULARITY determines the depth of the
3810 recursion. Allowed values are `headline', `greater-element',
3811 `element', `object' or nil. When it is broader than `object' (or
3812 nil), secondary values will not be parsed, since they only
3813 contain objects.
3815 Optional argument SPECIAL, when non-nil, can be either
3816 `first-section', `item', `node-property', `quote-section',
3817 `section', and `table-row'.
3819 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3820 be computed.
3822 This function assumes point is always at the beginning of the
3823 element it has to parse."
3826 ;; Determine if parsing depth allows for secondary strings
3827 ;; parsing. It only applies to elements referenced in
3828 ;; `org-element-secondary-value-alist'.
3831 ;; Item.
3834 ;; Table Row.
3836 ;; Node Property.
3838 ;; Headline.
3841 ;; Sections (must be checked after headline).
3847 limit)))
3848 ;; When not at bol, point is at the beginning of an item or
3849 ;; a footnote definition: next item is always a paragraph.
3851 ;; Planning and Clock.
3856 ;; Inlinetask.
3859 ;; From there, elements can have affiliated keywords.
3862 ;; Jumping over affiliated keywords put point off-limits.
3863 ;; Parse them as regular keywords.
3867 ;; LaTeX Environment.
3871 ;; Drawer and Property Drawer.
3876 ;; Fixed Width
3879 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3880 ;; Keywords.
3889 org-element-block-name-alist)))
3904 ;; Footnote Definition.
3907 ;; Horizontal Rule.
3910 ;; Diary Sexp.
3913 ;; Table.
3915 ;; List.
3918 limit affiliated
3920 ;; Default element: Paragraph.
3924 ;; Most elements can have affiliated keywords. When looking for an
3925 ;; element beginning, we want to move before them, as they belong to
3926 ;; that element, and, in the meantime, collect information they give
3927 ;; into appropriate properties. Hence the following function.
3930 "Collect affiliated keywords from point down to LIMIT.
3932 Return a list whose CAR is the position at the first of them and
3933 CDR a plist of keywords and values and move point to the
3934 beginning of the first line after them.
3936 As a special case, if element doesn't start at the beginning of
3937 the line (i.e. a paragraph starting an item), CAR is current
3938 position of point and CDR is nil."
3942 ;; RESTRICT is the list of objects allowed in parsed
3943 ;; keywords value.
3945 output)
3948 ;; Apply translation to RAW-KWD. From there, KWD is
3949 ;; the official keyword.
3951 org-element-keyword-translation-alist))
3952 raw-kwd))
3953 ;; Find main value for any keyword.
3959 ;; PARSEDP is non-nil when keyword should have its
3960 ;; value parsed.
3962 ;; If KWD is a dual keyword, find its secondary
3963 ;; value. Maybe parse it.
3970 ;; Attribute a property name to KWD.
3972 ;; Now set final shape for VALUE.
3978 ;; Attributes can always appear on multiple lines.
3981 ;; Eventually store the new value in OUTPUT.
3983 ;; Move to next keyword.
3985 ;; If affiliated keywords are orphaned: move back to first one.
3986 ;; They will be parsed as a paragraph.
3988 ;; Return value.
3992 \f
3993 ;;; The Org Parser
3994 ;;
3995 ;; The two major functions here are `org-element-parse-buffer', which
3996 ;; parses Org syntax inside the current buffer, taking into account
3997 ;; region, narrowing, or even visibility if specified, and
3998 ;; `org-element-parse-secondary-string', which parses objects within
3999 ;; a given string.
4000 ;;
4001 ;; The (almost) almighty `org-element-map' allows to apply a function
4002 ;; on elements or objects matching some type, and accumulate the
4003 ;; resulting values. In an export situation, it also skips unneeded
4004 ;; parts of the parse tree.
4007 "Recursively parse the buffer and return structure.
4008 If narrowing is in effect, only parse the visible part of the
4009 buffer.
4011 Optional argument GRANULARITY determines the depth of the
4012 recursion. It can be set to the following symbols:
4014 `headline' Only parse headlines.
4015 `greater-element' Don't recurse into greater elements excepted
4016 headlines and sections. Thus, elements
4017 parsed are the top-level ones.
4018 `element' Parse everything but objects and plain text.
4019 `object' Parse the complete buffer (default).
4021 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4022 elements.
4024 An element or an objects is represented as a list with the
4025 pattern (TYPE PROPERTIES CONTENTS), where :
4027 TYPE is a symbol describing the element or object. See
4028 `org-element-all-elements' and `org-element-all-objects' for an
4029 exhaustive list of such symbols. One can retrieve it with
4030 `org-element-type' function.
4032 PROPERTIES is the list of attributes attached to the element or
4033 object, as a plist. Although most of them are specific to the
4034 element or object type, all types share `:begin', `:end',
4035 `:post-blank' and `:parent' properties, which respectively
4036 refer to buffer position where the element or object starts,
4037 ends, the number of white spaces or blank lines after it, and
4038 the element or object containing it. Properties values can be
4039 obtained by using `org-element-property' function.
4041 CONTENTS is a list of elements, objects or raw strings
4042 contained in the current element or object, when applicable.
4043 One can access them with `org-element-contents' function.
4045 The Org buffer has `org-data' as type and nil as properties.
4046 `org-element-map' function can be used to find specific elements
4047 or objects within the parse tree.
4049 This function assumes that current major mode is `org-mode'."
4055 ;; Start in `first-section' mode so text before the first
4056 ;; headline belongs to a section.
4060 "Recursively parse objects in STRING and return structure.
4062 RESTRICTION is a symbol limiting the object types that will be
4063 looked after.
4065 Optional argument PARENT, when non-nil, is the element or object
4066 containing the secondary string. It is used to set correctly
4067 `:parent' property within the string."
4068 ;; Copy buffer-local variables listed in
4069 ;; `org-element-object-variables' into temporary buffer. This is
4070 ;; required since object parsing is dependent on these variables.
4074 org-element-object-variables))))
4082 secondary))
4083 secondary))))
4087 "Map a function on selected elements or objects.
4089 DATA is a parse tree, an element, an object, a string, or a list
4090 of such constructs. TYPES is a symbol or list of symbols of
4091 elements or objects types (see `org-element-all-elements' and
4092 `org-element-all-objects' for a complete list of types). FUN is
4093 the function called on the matching element or object. It has to
4094 accept one argument: the element or object itself.
4096 When optional argument INFO is non-nil, it should be a plist
4097 holding export options. In that case, parts of the parse tree
4098 not exportable according to that property list will be skipped.
4100 When optional argument FIRST-MATCH is non-nil, stop at the first
4101 match for which FUN doesn't return nil, and return that value.
4103 Optional argument NO-RECURSION is a symbol or a list of symbols
4104 representing elements or objects types. `org-element-map' won't
4105 enter any recursive element or object whose type belongs to that
4106 list. Though, FUN can still be applied on them.
4108 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4109 apply to matching objects within parsed affiliated keywords (see
4110 `org-element-parsed-keywords').
4112 Nil values returned from FUN do not appear in the results.
4115 Examples:
4116 ---------
4118 Assuming TREE is a variable containing an Org buffer parse tree,
4119 the following example will return a flat list of all `src-block'
4120 and `example-block' elements in it:
4122 \(org-element-map tree '(example-block src-block) 'identity)
4124 The following snippet will find the first headline with a level
4127 \(org-element-map tree 'headline
4128 \(lambda (hl)
4129 \(and (= (org-element-property :level hl) 1)
4131 \(org-element-property :begin hl)))
4132 nil t)
4134 The next example will return a flat list of all `plain-list' type
4135 elements in TREE that are not a sub-list themselves:
4137 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4139 Eventually, this example will return a flat list of all `bold'
4140 type objects containing a `latex-snippet' type object, even
4141 looking into captions:
4143 \(org-element-map tree 'bold
4144 \(lambda (b)
4145 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4146 nil nil nil t)"
4147 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4150 ;; Recursion depth is determined by --CATEGORY.
4157 ;; If one object is found, the function
4158 ;; has to recurse into every object.
4161 ;; If one regular element is found, the
4162 ;; function has to recurse, at least,
4163 ;; into every element it encounters.
4166 types)
4167 category)))
4168 ;; Compute properties for affiliated keywords if necessary.
4173 org-element-affiliated-keywords)))
4174 --acc
4175 --walk-tree
4179 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4180 ;; holding contextual information.
4184 ;; Ignored element in an export context.
4186 ;; List of elements or objects.
4188 ;; Unconditionally enter parse trees.
4192 ;; Check if TYPE is matching among TYPES. If so,
4193 ;; apply FUN to --DATA and accumulate return value
4194 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4200 ;; If --DATA has a secondary string that can contain
4201 ;; objects with their type among TYPES, look into it.
4208 ;; If --DATA has any affiliated keywords and
4209 ;; WITH-AFFILIATED is non-nil, look for objects in
4210 ;; them.
4218 ;; Pay attention to the type of value.
4219 ;; Preserve order for multiple keywords.
4235 --affiliated-alist))
4236 ;; Determine if a recursion into --DATA is possible.
4238 ;; --TYPE is explicitly removed from recursion.
4240 ;; --DATA has no contents.
4242 ;; Looking for greater elements but --DATA is simply
4243 ;; an element or an object.
4246 ;; Looking for elements but --DATA is an object.
4249 ;; In any other case, map contents.
4253 ;; Return value in a proper order.
4257 ;; The following functions are internal parts of the parser.
4258 ;;
4259 ;; The first one, `org-element--parse-elements' acts at the element's
4260 ;; level.
4261 ;;
4262 ;; The second one, `org-element--parse-objects' applies on all objects
4263 ;; of a paragraph or a secondary string. It uses
4264 ;; `org-element--get-next-object-candidates' to optimize the search of
4265 ;; the next object in the buffer.
4266 ;;
4267 ;; More precisely, that function looks for every allowed object type
4268 ;; first. Then, it discards failed searches, keeps further matches,
4269 ;; and searches again types matched behind point, for subsequent
4270 ;; calls. Thus, searching for a given type fails only once, and every
4271 ;; object is searched only once at top level (but sometimes more for
4272 ;; nested types).
4276 "Parse elements between BEG and END positions.
4278 SPECIAL prioritize some elements over the others. It can be set
4279 to `first-section', `quote-section', `section' `item' or
4280 `table-row'.
4282 When value is `item', STRUCTURE will be used as the current list
4283 structure.
4285 GRANULARITY determines the depth of the recursion. See
4286 `org-element-parse-buffer' for more information.
4288 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4289 elements.
4291 Elements are accumulated into ACC."
4294 ;; Visible only: skip invisible parts at the beginning of the
4295 ;; element.
4298 ;; When parsing only headlines, skip any text before first one.
4301 ;; Main loop start.
4303 ;; Find current element's type and parse it accordingly to
4304 ;; its category.
4306 end granularity special structure))
4310 ;; Visible only: skip invisible parts between siblings.
4313 ;; Fill ELEMENT contents by side-effect.
4315 ;; If element has no contents, don't modify it.
4317 ;; Greater element: parse it between `contents-begin' and
4318 ;; `contents-end'. Make sure GRANULARITY allows the
4319 ;; recursion, or ELEMENT is a headline, in which case going
4320 ;; inside is mandatory, in order to get sub-level headings.
4328 ;; Possibly switch to a special mode.
4338 granularity visible-only element))
4339 ;; ELEMENT has contents. Parse objects inside, if
4340 ;; GRANULARITY allows it.
4346 ;; Return result.
4347 acc))
4350 "Parse objects between BEG and END and return recursive structure.
4352 Objects are accumulated in ACC.
4354 RESTRICTION is a list of object successors which are allowed in
4355 the current object."
4364 restriction candidates)))
4371 ;; 1. Text before any object. Untabify it.
4376 acc
4380 ;; 2. Object...
4383 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4384 ;; a recursive type.
4392 ;; 3. Text after last object. Untabify it.
4396 acc
4400 ;; Result.
4401 acc))))
4404 "Return an alist of candidates for the next object.
4406 RESTRICTION is a list of object types, as symbols. Only
4407 candidates with such types are looked after.
4409 OBJECTS is the previous candidates alist. If it is set to
4410 `initial', no search has been done before, and all symbols in
4411 RESTRICTION should be looked after.
4413 Return value is an alist whose CAR is the object type and CDR its
4414 beginning position."
4416 nil
4418 ;; When searching for the first time, look for every successor
4419 ;; allowed in RESTRICTION.
4423 restriction)
4424 ;; Focus on objects returned during last search. Keep those
4425 ;; still after point. Search again objects before it.
4431 type)))
4434 objects))))
4437 \f
4438 ;;; Towards A Bijective Process
4439 ;;
4440 ;; The parse tree obtained with `org-element-parse-buffer' is really
4441 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4442 ;; interpreted and expanded into a string with canonical Org syntax.
4443 ;; Hence `org-element-interpret-data'.
4444 ;;
4445 ;; The function relies internally on
4446 ;; `org-element--interpret-affiliated-keywords'.
4448 ;;;###autoload
4450 "Interpret DATA as Org syntax.
4452 DATA is a parse tree, an element, an object or a secondary string
4453 to interpret.
4455 Optional argument PSEUDO-OBJECTS is a list of symbols defining
4456 new types that should be treated as objects. An unknown type not
4457 belonging to this list is seen as a pseudo-element instead. Both
4458 pseudo-objects and pseudo-elements are transparent entities, i.e.
4459 only their contents are interpreted.
4461 Return Org syntax as a string."
4465 "Interpret DATA as Org syntax.
4467 DATA is a parse tree, an element, an object or a secondary string
4468 to interpret. PARENT is used for recursive calls. It contains
4469 the element or object containing data, or nil. PSEUDO-OBJECTS
4470 are list of symbols defining new element or object types.
4471 Unknown types that don't belong to this list are treated as
4472 pseudo-elements instead.
4474 Return Org syntax as a string."
4476 ;; Find interpreter for current object or element. If it
4477 ;; doesn't exist (e.g. this is a pseudo object or element),
4478 ;; return contents, if any.
4484 ;; Secondary string.
4490 ;; Full Org document.
4496 ;; Plain text: remove `:parent' text property from output.
4498 ;; Element or object without contents.
4500 ;; Element or object with contents.
4503 ;; Recursively interpret contents.
4509 data
4510 ;; Fix indentation of elements containing
4511 ;; objects. We ignore `table-row' elements
4512 ;; as they are one line long anyway.
4514 data
4515 ;; When normalizing first paragraph of an
4516 ;; item or a footnote-definition, ignore
4517 ;; first line's indentation.
4524 ;; Build white spaces. If no `:post-blank' property is
4525 ;; specified, assume its value is 0.
4536 "Return ELEMENT's affiliated keywords as Org syntax.
4537 If there is no affiliated keyword, return the empty string."
4547 ": "
4550 value)
4558 ;; All attribute keywords can have multiple lines.
4564 ;; List all ELEMENT's properties matching an attribute line or an
4565 ;; affiliated keyword, but ignore translated keywords since they
4566 ;; cannot belong to the property list.
4573 org-element-keyword-translation-alist)))))
4574 collect prop)
4577 ;; Because interpretation of the parse tree must return the same
4578 ;; number of blank lines between elements and the same number of white
4579 ;; space after objects, some special care must be given to white
4580 ;; spaces.
4581 ;;
4582 ;; The first function, `org-element-normalize-string', ensures any
4583 ;; string different from the empty string will end with a single
4584 ;; newline character.
4585 ;;
4586 ;; The second function, `org-element-normalize-contents', removes
4587 ;; global indentation from the contents of the current element.
4590 "Ensure string S ends with a single newline character.
4592 If S isn't a string return it unchanged. If S is the empty
4593 string, return it. Otherwise, return a new string with a single
4594 newline character at its end."
4602 "Normalize plain text in ELEMENT's contents.
4604 ELEMENT must only contain plain text and objects.
4606 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4607 indentation to compute maximal common indentation.
4609 Return the normalized element that is element with global
4610 indentation removed from its contents. The function assumes that
4611 indentation is not done with TAB characters."
4613 collect-inds ; for byte-compiler
4616 ;; Return list of indentations within BLOB. This is done by
4617 ;; walking recursively BLOB and updating IND-LIST along the
4618 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4619 ;; been seen yet. It is required as this string is the only
4620 ;; one whose indentation doesn't happen after a newline
4621 ;; character.
4629 ;; An indentation of zero means no string will be
4630 ;; modified. Quit the process.
4636 ;; Avoid matching blank or empty lines.
4644 ;; Collect indentation list in ELEMENT. Possibly remove first
4645 ;; value if IGNORE-FIRST is non-nil.
4648 ;; Build ELEMENT back, replacing each string with the same
4649 ;; string minus common indentation.
4654 ;; Return BLOB with all its strings indentation
4655 ;; shortened from MCI white spaces. FIRST-FLAG is
4656 ;; non-nil when the first string hasn't been seen
4657 ;; yet.
4671 org-element-recursive-objects)
4675 blob))))
4679 \f
4680 ;;; The Toolbox
4681 ;;
4682 ;; The first move is to implement a way to obtain the smallest element
4683 ;; containing point. This is the job of `org-element-at-point'. It
4684 ;; basically jumps back to the beginning of section containing point
4685 ;; and proceed, one element after the other, with
4686 ;; `org-element--current-element' until the container is found. Note:
4687 ;; When using `org-element-at-point', secondary values are never
4688 ;; parsed since the function focuses on elements, not on objects.
4689 ;;
4690 ;; At a deeper level, `org-element-context' lists all elements and
4691 ;; objects containing point.
4692 ;;
4693 ;; Both functions benefit from a simple caching mechanism. It is
4694 ;; enabled by default, but can be disabled globally with
4695 ;; `org-element-use-cache'. Also `org-element-cache-reset' clears or
4696 ;; initializes cache for current buffer. Values are retrieved and put
4697 ;; into cache with respectively, `org-element-cache-get' and
4698 ;; `org-element-cache-put'. `org-element--cache-sync-idle-time' and
4699 ;; `org-element--cache-merge-changes-threshold' are used internally to
4700 ;; control caching behaviour.
4701 ;;
4702 ;; Eventually `org-element-nested-p' and `org-element-swap-A-B' may be
4703 ;; used internally by navigation and manipulation tools.
4709 "Hash table used as a cache for parser.
4710 Key is a buffer position and value is a cons cell with the
4711 pattern:
4713 \(ELEMENT . OBJECTS-DATA)
4715 where ELEMENT is the element starting at the key and OBJECTS-DATA
4716 is an alist where each association is:
4718 \(POS CANDIDATES . OBJECTS)
4720 where POS is a buffer position, CANDIDATES is the last know list
4721 of successors (see `org-element--get-next-object-candidates') in
4722 container starting at POS and OBJECTS is a list of objects known
4723 to live within that container, from farthest to closest.
4726 at, respectively, positions 1, 7 and 8,
4730 If the paragraph is completely parsed, OBJECTS-DATA will be
4732 \((1 nil BOLD-OBJECT ENTITY-OBJECT)
4733 \(8 nil ENTITY-OBJECT))
4735 whereas in a partially parsed paragraph, it could be
4737 \((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT))
4739 This cache is used in both `org-element-at-point' and
4740 `org-element-context'. The former uses ELEMENT only and the
4744 "Number of seconds of idle time wait before syncing buffer cache.
4745 Syncing also happens when current modification is too distant
4746 from the stored one (for more information, see
4750 "Number of characters triggering cache syncing.
4752 The cache mechanism only stores one buffer modification at any
4753 given time. When another change happens, it replaces it with
4754 a change containing both the stored modification and the current
4755 one. This is a trade-off, as merging them prevents another
4756 syncing, but every element between them is then lost.
4758 This variable determines the maximum size, in characters, we
4762 "Contains data about cache validity for current buffer.
4764 Value is a vector of seven elements,
4766 [ACTIVEP BEGIN END OFFSET TIMER PREVIOUS-STATE]
4768 ACTIVEP is a boolean non-nil when changes described in the other
4769 slots are valid for current buffer.
4771 BEGIN and END are the beginning and ending position of the area
4772 for which cache cannot be trusted.
4774 OFFSET it an integer specifying the number to add to position of
4775 elements after that area.
4777 TIMER is a timer used to apply these changes to cache when Emacs
4778 is idle.
4780 PREVIOUS-STATE is a symbol referring to the state of the buffer
4781 before a change happens. It is used to know if sensitive
4782 areas (block boundaries, headlines) were modified. It can be set
4785 ;;;###autoload
4787 "Reset cache in current buffer.
4788 When optional argument ALL is non-nil, reset cache in all Org
4789 buffers. This function will do nothing if
4790 `org-element-use-cache' is nil."
4807 "Non-nil when changes are not integrated in cache yet."
4812 "Push change to current buffer staging area.
4813 BEG and END and the beginning and ending position of the
4814 modification area. OFFSET is the size of the change, as an
4815 integer."
4823 nil
4824 #'org-element--cache-sync
4829 "Remove any cache change set for current buffer."
4835 "Return expected key for ELEMENT in cache."
4840 begin))
4841 ;; Special key for first item (resp. table-row) in a plain
4842 ;; list (resp. table).
4844 begin)))
4847 "Return data stored at key POS in current buffer cache.
4848 When optional argument TYPE is `element', retrieve the element
4849 starting at POS. When it is `objects', return the list of object
4850 types along with their beginning position within that element.
4851 Otherwise, return the full data. In any case, return nil if no
4852 data is found, or if caching is not allowed."
4854 ;; If there are pending changes, first sync them.
4864 "Store data in current buffer's cache, if allowed.
4865 POS is a buffer position, which will be used as a key. DATA is
4866 the value to store. Nothing will be stored if
4867 `org-element-use-cache' is nil. Return DATA in any case."
4873 "Shift ELEMENT properties relative to buffer positions by OFFSET.
4874 Properties containing buffer positions are `:begin', `:end',
4875 `:contents-begin', `:contents-end' and `:structure'. They are
4876 modified by side-effect. Return modified element."
4878 ;; Shift :structure property for the first plain list only: it is
4879 ;; the only one that really matters and it prevents from shifting
4880 ;; it more than once.
4892 element)
4900 "Regexp matching an element opening line.
4901 When such a line is modified, modifications may propagate after
4902 modified area. In that situation, every element between that
4911 "Regexp matching an element closing line.
4912 When such a line is modified, modifications may propagate before
4913 modified area. In that situation, every element between that
4917 "Request extension of area going to be modified if needed.
4918 BEG and END are the beginning and end of the range of changed
4919 text. See `before-change-functions' for more information."
4927 ;; A sensitive line is a headline or a block (or drawer,
4928 ;; or latex-environment) boundary. Inserting one can
4929 ;; modify buffer drastically both above and below that
4930 ;; line, possibly making cache invalid. Therefore, we
4931 ;; need to pay special attention to changes happening to
4932 ;; them.
4936 org-element--cache-opening-line)))
4949 "Update buffer modifications for current buffer.
4951 BEG and END are the beginning and end of the range of changed
4952 text, and the length in bytes of the pre-change text replaced by
4953 that range. See `after-change-functions' for more information.
4955 If there are already pending changes, try to merge them into
4956 a bigger change record. If that's not possible, the function
4957 will first synchronize cache with previous change and store the
4958 new one."
4968 ;; Determine if modified area needs to be extended,
4969 ;; according to both previous and current state. We make
4970 ;; a special case for headline editing: if a headline is
4971 ;; modified but not removed, do not extend.
4976 org-element--cache-opening-line)))
4987 ;; Effectively extend modified area.
4990 ;; Headline above is inclusive.
4994 ;; Headline below is exclusive.
4996 ;; Store changes.
4999 ;; No pending changes. Store the new ones.
5006 ;; If we cannot merge two change sets (i.e. they
5007 ;; modify distinct buffer parts) first apply current
5008 ;; change set and store new one. This way, there is
5009 ;; never more than one pending change set, which
5010 ;; avoids handling costly merges.
5014 ;; Change sets can be merged. We can expand the area
5015 ;; that requires an update, and postpone the sync.
5024 "Synchronize cache with recent modification in BUFFER.
5025 Elements ending before modification area are kept in cache.
5026 Elements starting after modification area have their position
5027 shifted by the size of the modification. Every other element is
5028 removed from the cache."
5036 new-keys)
5042 ;; Shift every element starting after END by OFFSET.
5043 ;; We also need to shift keys, since they refer to
5044 ;; buffer positions.
5045 ;;
5046 ;; Upon shifting a key a conflict can occur if the
5047 ;; shifted key also refers to some element in the
5048 ;; cache. In this case, we temporarily associate
5049 ;; both elements, as a cons cell, to the shifted key,
5050 ;; following the pattern (SHIFTED . CURRENT).
5051 ;;
5052 ;; Such a conflict can only occur if shifted key hash
5053 ;; hasn't been processed by `maphash' yet.
5057 ;; Shift element part.
5059 ;; Shift objects part.
5066 ;; Shift key-value pair.
5069 ;; Put new value to shifted key.
5070 ;;
5071 ;; If one already exists, do not overwrite it:
5072 ;; store it as the car of a cons cell instead,
5073 ;; and handle it when `maphash' reaches
5074 ;; NEW-KEY.
5075 ;;
5076 ;; If there is no element stored at NEW-KEY or
5077 ;; if NEW-KEY is going to be removed anyway
5078 ;; (i.e., it is before END), just store new
5079 ;; value there and make sure it will not be
5080 ;; processed again by storing NEW-KEY in
5081 ;; NEW-KEYS.
5086 value-to-shift)
5087 org-element--cache)
5088 ;; If current value contains two elements, car
5089 ;; should be the new value, since cdr has been
5090 ;; shifted already.
5094 ;; Remove every element between BEG and END, since
5095 ;; this is where changes happened.
5097 ;; Preserve any element ending before BEG. If it
5098 ;; overlaps the BEG-END area, remove it.
5103 ;; Special case: footnote definitions and plain
5104 ;; lists can end with blank lines. Modifying
5105 ;; those can also alter last element inside. We
5106 ;; must therefore remove them from cache.
5116 org-element--cache)
5117 ;; Signal cache as up-to-date.
5120 ;;;###autoload
5122 "Determine closest element around point.
5124 Return value is a list like (TYPE PROPS) where TYPE is the type
5125 of the element and PROPS a plist of properties associated to the
5126 element.
5128 Possible types are defined in `org-element-all-elements'.
5129 Properties depend on element or object type, but always include
5130 `:begin', `:end', `:parent' and `:post-blank' properties.
5132 As a special case, if point is at the very beginning of a list or
5133 sub-list, returned element will be that list instead of the first
5134 item. In the same way, if point is at the beginning of the first
5135 row of a table, returned element will be the table instead of the
5136 first row."
5152 ;; Opportunistic shortcut. Instead of going back to
5153 ;; headline above (or beginning of buffer) and descending
5154 ;; again, first try to find a known element above current
5155 ;; position. Give up after 3 tries or when we hit
5156 ;; a headline (or beginning of buffer).
5164 ;; An element cannot start at a headline, so check
5165 ;; first non-blank line below.
5169 ;; At an affiliated keyword, make sure to move to
5170 ;; the first one.
5175 ;; At a fixed width area or a property drawer, reach
5176 ;; the beginning of the element.
5181 ;; Tough luck: we're back at a headline above. Move to
5182 ;; beginning of section.
5188 ;; Search successful: we know an element before point
5189 ;; which is not an headline. If it has a common
5190 ;; ancestor with ORIGIN, set this ancestor as the
5191 ;; current parent and the element as the one to check.
5192 ;; Otherwise, move at top level and start parsing right
5193 ;; after its broader ancestor.
5200 end cache-end)
5211 ;; Opportunistic search failed. Move back to beginning of
5212 ;; section in current headline, if any, or to first non-empty
5213 ;; line in buffer otherwise.
5218 ;; Now we are at the beginning of an element, start parsing.
5223 ;; Parse successively each element, skipping those ending
5224 ;; before original position.
5231 ;; First item (resp. row) in
5232 ;; plain list (resp. table) gets
5233 ;; a special key in cache.
5244 ;; When changes happened in the middle of
5245 ;; a list, its structure ends up being
5246 ;; invalid. Therefore, we make sure to use
5247 ;; a valid one.
5254 ;; 1. Skip any element ending before point. Also skip
5255 ;; element ending at point when we're sure that
5256 ;; another element has started.
5262 ;; 2. An element containing point is always the element at
5263 ;; point.
5266 ;; 3. At any other greater element type, if point is
5267 ;; within contents, move into it.
5272 ;; Create an anchor for tables and plain
5273 ;; lists: when point is at the very beginning
5274 ;; of these elements, ignoring affiliated
5275 ;; keywords, target them instead of their
5276 ;; contents.
5278 ;; When point is at contents end, do not move
5279 ;; into elements with an explicit ending, but
5280 ;; return that element instead.
5284 drawer dynamic-block inlinetask
5285 property-drawer quote-block
5286 special-block))
5287 ;; Corner case: if a list ends at
5288 ;; the end of a buffer without
5289 ;; a final new line, return last
5290 ;; element in last item instead.
5307 ;;;###autoload
5309 "Return closest element or object around point.
5311 Return value is a list like (TYPE PROPS) where TYPE is the type
5312 of the element or object and PROPS a plist of properties
5313 associated to it.
5315 Possible types are defined in `org-element-all-elements' and
5316 `org-element-all-objects'. Properties depend on element or
5317 object type, but always include `:begin', `:end', `:parent' and
5318 `:post-blank'.
5320 Optional argument ELEMENT, when non-nil, is the closest element
5321 containing point, as returned by `org-element-at-point'.
5322 Providing it allows for quicker computation."
5328 ;; If point is inside an element containing objects or
5329 ;; a secondary string, narrow buffer to the container and
5330 ;; proceed with parsing. Otherwise, return ELEMENT.
5332 ;; At a parsed affiliated keyword, check if we're inside main
5333 ;; or dual value.
5340 org-element-parsed-keywords))
5349 ;; Also change type to retrieve correct restrictions.
5351 ;; At an item, objects can only be located within tag, if any.
5361 ;; At an headline or inlinetask, objects are in title.
5368 ;; At a paragraph, a table-row or a verse block, objects are
5369 ;; located within their contents.
5373 ;; CBEG is nil for table rules.
5377 ;; At a parsed keyword, objects are located within value.
5380 org-element-document-properties))
5387 ;; All other locations cannot contain objects: bail out.
5395 objects-data next update-cache-flag)
5399 ;; Get list of next object candidates in CANDIDATES.
5400 ;; When entering for the first time PARENT, grab it
5401 ;; from cache, if available, or compute it. Then,
5402 ;; for each subsequent iteration in PARENT, always
5403 ;; compute it since we're beyond cache anyway.
5408 cache))))
5412 restriction candidates))
5416 ;; Compare ORIGIN with next object starting position,
5417 ;; if any.
5418 ;;
5419 ;; If ORIGIN is lesser or if there is no object
5420 ;; following, look for a previous object that might
5421 ;; contain it in cache. If there is no cache, we
5422 ;; didn't miss any object so simply return PARENT.
5423 ;;
5424 ;; If ORIGIN is greater or equal, parse next
5425 ;; candidate for further processing.
5429 candidates))))
5435 ;; Object ends before ORIGIN and we
5436 ;; know next one in cache starts
5437 ;; after it: bail out.
5447 ;; Process NEXT to know if we need to skip it, return
5448 ;; it or move into it.
5453 ;; ORIGIN is after NEXT, so skip it.
5455 ;; ORIGIN is within a non-recursive next or
5456 ;; at an object boundaries: Return that object.
5460 ;; Otherwise, move into NEXT and reset flags as we
5461 ;; shift parent.
5467 next nil
5468 objects-data nil
5470 ;; Update cache if required.
5475 "Non-nil when elements ELEM-A and ELEM-B are nested."
5484 "Swap elements ELEM-A and ELEM-B.
5485 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
5486 end of ELEM-A."
5488 ;; There are two special cases when an element doesn't start at bol:
5489 ;; the first paragraph in an item or in a footnote definition.
5491 ;; Only a paragraph without any affiliated keyword can be moved at
5492 ;; ELEM-A position in such a situation. Note that the case of
5493 ;; a footnote definition is impossible: it cannot contain two
5494 ;; paragraphs in a row because it cannot contain a blank line.
5500 ;; In a special situation, ELEM-A will have no indentation. We'll
5501 ;; give it ELEM-B's (which will in, in turn, have no indentation).
5515 ;; Store overlays responsible for visibility status. We
5516 ;; also need to store their boundaries as they will be
5517 ;; removed from buffer.
5524 ;; Get contents.
5532 ;; Restore ex ELEM-A overlays.
5541 ;; Restore ex ELEM-B overlays.
5549 "Remove maximum common indentation in string S and return it.
5550 When optional argument N is a positive integer, remove exactly
5551 that much characters from indentation, if possible, or return
5552 S as-is otherwise. Unlike to `org-remove-indentation', this
5553 function doesn't call `untabify' on S."
5558 ;; Find maximum common indentation, if not specified.
5566 min-ind)))
5568 ;; Remove exactly N indentation, but give up if not possible.
5580 ;; Local variables:
5581 ;; generated-autoload-file: "org-loaddefs.el"
5582 ;; End:
5584 ;;; org-element.el ends here