| blob | 0fe947e516f34de41b8a2882cfc94f49c2d24e23 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. 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 (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
45 ;;
46 ;; Other element types are: `babel-call', `clock', `comment',
47 ;; `comment-block', `example-block', `export-block', `fixed-width',
48 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
49 ;; `planning', `property-drawer', `quote-section', `src-block',
50 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
51 ;; and `verse-block' types can contain Org objects and plain text.
52 ;;
53 ;; Objects are related to document's contents. Some of them are
54 ;; recursive. Associated types are of the following: `bold', `code',
55 ;; `entity', `export-snippet', `footnote-reference',
56 ;; `inline-babel-call', `inline-src-block', `italic',
57 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
58 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
59 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
60 ;;
61 ;; Some elements also have special properties whose value can hold
62 ;; objects themselves (i.e. an item tag or an headline name). Such
63 ;; values are called "secondary strings". Any object belongs to
64 ;; either an element or a secondary string.
65 ;;
66 ;; Notwithstanding affiliated keywords, each greater element, element
67 ;; and object has a fixed set of properties attached to it. Among
68 ;; them, four are shared by all types: `:begin' and `:end', which
69 ;; refer to the beginning and ending buffer positions of the
70 ;; considered element or object, `:post-blank', which holds the number
71 ;; of blank lines, or white spaces, at its end and `:parent' which
72 ;; refers to the element or object containing it. Greater elements
73 ;; and elements containing objects will also have `:contents-begin'
74 ;; and `:contents-end' properties to delimit contents.
75 ;;
76 ;; Lisp-wise, an element or an object can be represented as a list.
77 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
78 ;; TYPE is a symbol describing the Org element or object.
79 ;; PROPERTIES is the property list attached to it. See docstring of
80 ;; appropriate parsing function to get an exhaustive
81 ;; list.
82 ;; CONTENTS is a list of elements, objects or raw strings contained
83 ;; in the current element or object, when applicable.
84 ;;
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
87 ;;
88 ;; The first part of this file defines Org syntax, while the second
89 ;; one provide accessors and setters functions.
90 ;;
91 ;; The next part implements a parser and an interpreter for each
92 ;; element and object type in Org syntax.
93 ;;
94 ;; The following part creates a fully recursive buffer parser. It
95 ;; also provides a tool to map a function to elements or objects
96 ;; matching some criteria in the parse tree. Functions of interest
97 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
98 ;; extent, `org-element-parse-secondary-string'.
99 ;;
100 ;; The penultimate part is the cradle of an interpreter for the
101 ;; obtained parse tree: `org-element-interpret-data'.
102 ;;
103 ;; The library ends by furnishing a set of interactive tools for
104 ;; element's navigation and manipulation, mostly based on
105 ;; `org-element-at-point' function, and a way to give information
106 ;; about document structure around point with `org-element-context'.
109 ;;; Code:
115 \f
116 ;;; Definitions And Rules
117 ;;
118 ;; Define elements, greater elements and specify recursive objects,
119 ;; along with the affiliated keywords recognized. Also set up
120 ;; restrictions on recursive objects combinations.
121 ;;
122 ;; These variables really act as a control center for the parsing
123 ;; process.
127 ;; Headlines and inlinetasks.
129 ;; Comments, blocks (any type), keywords and babel calls.
131 ;; Lists.
133 ;; Fixed-width, drawers (any type) and tables.
135 ;; Footnote definitions.
137 ;; Horizontal rules.
139 ;; LaTeX environments.
141 ;; Planning and Clock lines.
142 org-planning-or-clock-line-re)
147 export-block fixed-width footnote-definition headline
148 horizontal-rule inlinetask item keyword latex-environment
149 babel-call paragraph plain-list planning property-drawer
150 quote-block quote-section section special-block src-block table
151 table-row verse-block)
156 item plain-list quote-block section special-block table)
161 latex-or-entity line-break link macro radio-target
162 statistics-cookie sub/superscript table-cell target
163 text-markup timestamp)
172 "Alist of translations between object type and successor name.
174 Sharing the same successor comes handy when, for example, the
179 inline-src-block italic line-break latex-fragment link macro
180 radio-target statistics-cookie strike-through subscript superscript
181 table-cell target timestamp underline verbatim)
186 table-cell underline)
196 "Alist between block names and the associated parsing function.
197 Names must be uppercase. Any block whose name has no association
203 "List of affiliated keywords as strings.
209 ;; Regular affiliated keywords.
212 "Regexp matching any affiliated keyword.
214 Keyword name is put in match group 1. Moreover, if keyword
215 belongs to `org-element-dual-keywords', put the dual value in
216 match group 2.
224 "Alist of usual translations for keywords.
225 The key is the old name and the value the new one. The property
229 "List of affiliated keywords that can occur more that once in an element.
231 Their value will be consed into a list of strings, which will be
232 returned as the value of the property.
234 This list is checked after translations have been applied. See
235 `org-element-keyword-translation-alist'.
241 "List of keywords whose value can be parsed.
243 Their value will be stored as a secondary string: a list of
244 strings and objects.
246 This list is checked after translations have been applied. See
250 "List of keywords which can have a secondary value.
252 In Org syntax, they can be written with optional square brackets
253 before the colons. For example, results keyword can be
254 associated to a hash value with the following:
256 #+RESULTS[hash-string]: some-source
258 This list is checked after translations have been applied. See
265 inline-src-block latex-or-entity line-break link macro
266 radio-target sub/superscript target text-markup
267 timestamp)
269 radio-target statistics-cookie sub/superscript target text-markup
270 timestamp)
282 inline-src-block latex-or-entity line-break link macro
283 radio-target statistics-cookie sub/superscript target text-markup
284 timestamp)
287 latex-or-entity link radio-target sub/superscript target
288 text-markup timestamp)
299 latex-or-entity line-break link macro radio-target
301 "Alist of objects restrictions.
303 CAR is an element or object type containing objects and CDR is
304 a list of successors that will be called within an element or
305 object of such type.
307 For example, in a `radio-target' object, one can only find
308 entities, export snippets, latex-fragments, subscript and
309 superscript.
311 This alist also applies to secondary string. For example, an
312 `headline' type element doesn't directly contain objects, but
323 \f
324 ;;; Accessors and Setters
325 ;;
326 ;; Provide four accessors: `org-element-type', `org-element-property'
327 ;; `org-element-contents' and `org-element-restriction'.
328 ;;
329 ;; Setter functions allow to modify elements by side effect. There is
330 ;; `org-element-put-property', `org-element-set-contents',
331 ;; `org-element-set-element' and `org-element-adopt-element'. Note
332 ;; that `org-element-set-element' and `org-element-adopt-element' are
333 ;; higher level functions since also update `:parent' property.
336 "Return type of ELEMENT.
338 The function returns the type of the element or object provided.
339 It can also return the following special value:
340 `plain-text' for a string
341 `org-data' for a complete document
342 nil in any other case."
348 "Extract the value from the PROPERTY of an ELEMENT."
352 "Extract contents from an ELEMENT."
356 "Return restriction associated to ELEMENT.
357 ELEMENT can be an element, an object or a symbol representing an
358 element or object type."
360 org-element-object-restrictions)))
363 "In ELEMENT set PROPERTY to VALUE.
364 Return modified element."
367 element)
370 "Set ELEMENT contents to CONTENTS.
371 Return modified element."
377 "Replace element or object OLD with element or object NEW.
378 The function takes care of setting `:parent' property for NEW."
379 ;; OLD can belong to the contents of PARENT or to its secondary
380 ;; string.
383 org-element-secondary-value-alist)))
386 ;; Make sure NEW has correct `:parent' property.
388 ;; Replace OLD with NEW in PARENT.
392 "Add an element to the contents of another element.
394 PARENT is an element or object. CHILD is an element, an object,
395 or a string.
397 CHILD is added at the beginning of PARENT contents, unless the
398 optional argument APPEND is non-nil, in which case CHILD is added
399 at the end.
401 The function takes care of setting `:parent' property for CHILD.
402 Return parent element."
406 parent
408 ;; Link the CHILD element with PARENT.
410 ;; Return the parent element.
411 parent))
414 \f
415 ;;; Greater elements
416 ;;
417 ;; For each greater element type, we define a parser and an
418 ;; interpreter.
419 ;;
420 ;; A parser returns the element or object as the list described above.
421 ;; Most of them accepts no argument. Though, exceptions exist. Hence
422 ;; every element containing a secondary string (see
423 ;; `org-element-secondary-value-alist') will accept an optional
424 ;; argument to toggle parsing of that secondary string. Moreover,
425 ;; `item' parser requires current list's structure as its first
426 ;; element.
427 ;;
428 ;; An interpreter accepts two arguments: the list representation of
429 ;; the element or object, and its contents. The latter may be nil,
430 ;; depending on the element or object considered. It returns the
431 ;; appropriate Org syntax, as a string.
432 ;;
433 ;; Parsing functions must follow the naming convention:
434 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
435 ;; defined in `org-element-greater-elements'.
436 ;;
437 ;; Similarly, interpreting functions must follow the naming
438 ;; convention: org-element-TYPE-interpreter.
439 ;;
440 ;; With the exception of `headline' and `item' types, greater elements
441 ;; cannot contain other greater elements of their own type.
442 ;;
443 ;; Beside implementing a parser and an interpreter, adding a new
444 ;; greater element requires to tweak `org-element--current-element'.
445 ;; Moreover, the newly defined type must be added to both
446 ;; `org-element-all-elements' and `org-element-greater-elements'.
449 ;;;; Center Block
452 "Parse a center block.
454 LIMIT bounds the search.
456 Return a list whose CAR is `center-block' and CDR is a plist
457 containing `:begin', `:end', `:hiddenp', `:contents-begin',
458 `:contents-end' and `:post-blank' keywords.
460 Assume point is at the beginning of the block."
464 ;; Incomplete block: parse it as a comment.
469 ;; Empty blocks have no contents.
483 :end end
484 :hiddenp hidden
485 :contents-begin contents-begin
486 :contents-end contents-end
491 "Interpret CENTER-BLOCK element as Org syntax.
492 CONTENTS is the contents of the element."
496 ;;;; Drawer
499 "Parse a drawer.
501 LIMIT bounds the search.
503 Return a list whose CAR is `drawer' and CDR is a plist containing
504 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
505 `:contents-end' and `:post-blank' keywords.
507 Assume point is at beginning of drawer."
510 ;; Incomplete drawer: parse it as a paragraph.
519 ;; Empty drawers have no contents.
533 :end end
534 :drawer-name name
535 :hiddenp hidden
536 :contents-begin contents-begin
537 :contents-end contents-end
542 "Interpret DRAWER element as Org syntax.
543 CONTENTS is the contents of the element."
546 contents))
549 ;;;; Dynamic Block
552 "Parse a dynamic block.
554 LIMIT bounds the search.
556 Return a list whose CAR is `dynamic-block' and CDR is a plist
557 containing `:block-name', `:begin', `:end', `:hiddenp',
558 `:contents-begin', `:contents-end', `:arguments' and
559 `:post-blank' keywords.
561 Assume point is at beginning of dynamic block."
564 ;; Incomplete block: parse it as a comment.
573 ;; Empty blocks have no contents.
587 :end end
588 :block-name name
589 :arguments arguments
590 :hiddenp hidden
591 :contents-begin contents-begin
592 :contents-end contents-end
597 "Interpret DYNAMIC-BLOCK element as Org syntax.
598 CONTENTS is the contents of the element."
603 contents))
606 ;;;; Footnote Definition
609 "Parse a footnote definition.
611 LIMIT bounds the search.
613 Return a list whose CAR is `footnote-definition' and CDR is
614 a plist containing `:label', `:begin' `:end', `:contents-begin',
615 `:contents-end' and `:post-blank' keywords.
617 Assume point is at the beginning of the footnote definition."
642 :begin begin
643 :end end
644 :contents-begin contents-begin
645 :contents-end contents-end
650 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
651 CONTENTS is the contents of the footnote-definition."
653 " "
654 contents))
657 ;;;; Headline
660 "Parse an headline.
662 Return a list whose CAR is `headline' and CDR is a plist
663 containing `:raw-value', `:title', `:begin', `:end',
664 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
665 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
666 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
667 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
668 keywords.
670 The plist also contains any property set in the property drawer,
671 with its name in lowercase, the underscores replaced with hyphens
672 and colons at the beginning (i.e. `:custom-id').
674 When RAW-SECONDARY-P is non-nil, headline's title will not be
675 parsed as a secondary string, but as a plain string instead.
677 Assume point is at beginning of the headline."
696 ;; Normalize property names: ":SOME_PROP:" becomes
697 ;; ":some-prop".
709 plist))
727 ;; Clean RAW-VALUE from any quote or comment string.
732 ""
733 raw-value)))
734 ;; Clean TAGS from archive tag, if any.
740 :begin begin
741 :end end
742 :pre-blank
745 :hiddenp hidden
746 :contents-begin contents-begin
747 :contents-end contents-end
748 :level level
750 :tags tags
751 :todo-keyword todo
752 :todo-type todo-type
753 :scheduled scheduled
754 :deadline deadline
755 :timestamp timestamp
756 :clock clock
762 end)
763 :footnote-section-p footnote-section-p
764 :archivedp archivedp
765 :commentedp commentedp
767 standard-props))))
769 headline :title
775 "Interpret HEADLINE element as Org syntax.
776 CONTENTS is the contents of the element."
803 ;; Align tags.
811 ? )
812 tags))
816 tags))))
818 contents)))
821 ;;;; Inlinetask
824 "Parse an inline task.
826 Return a list whose CAR is `inlinetask' and CDR is a plist
827 containing `:title', `:begin', `:end', `:hiddenp',
828 `:contents-begin' and `:contents-end', `:level', `:priority',
829 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
830 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
832 The plist also contains any property set in the property drawer,
833 with its name in lowercase, the underscores replaced with hyphens
834 and colons at the beginning (i.e. `:custom-id').
836 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
837 title will not be parsed as a secondary string, but as a plain
838 string instead.
840 Assume point is at beginning of the inline task."
850 ;; Normalize property names: ":SOME_PROP:" becomes
851 ;; ":some-prop".
863 plist))
887 :end end
888 :hiddenp hidden
889 :contents-begin contents-begin
890 :contents-end contents-end
893 :tags tags
894 :todo-keyword todo
895 :todo-type todo-type
896 :scheduled scheduled
897 :deadline deadline
898 :timestamp timestamp
899 :clock clock
901 standard-props
904 inlinetask :title
909 inlinetask))))))
912 "Interpret INLINETASK element as Org syntax.
913 CONTENTS is the contents of inlinetask."
928 ;; Align tags.
936 ? )
937 tags))
941 tags))))
942 ;; Prefer degenerate inlinetasks when there are no
943 ;; contents.
946 contents
950 ;;;; Item
953 "Parse an item.
955 STRUCT is the structure of the plain list.
957 Return a list whose CAR is `item' and CDR is a plist containing
958 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
959 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
960 `:post-blank' keywords.
962 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
963 any, will not be parsed as a secondary string, but as a plain
964 string instead.
966 Assume point is at the beginning of the item."
987 ;; If first line isn't empty,
988 ;; contents really start at the text
989 ;; after item's meta-data.
1002 :begin begin
1003 :end end
1004 ;; CONTENTS-BEGIN and CONTENTS-END may be
1005 ;; mixed up in the case of an empty item
1006 ;; separated from the next by a blank line.
1007 ;; Thus ensure the former is always the
1008 ;; smallest.
1011 :checkbox checkbox
1012 :counter counter
1013 :hiddenp hidden
1014 :structure struct
1017 item :tag
1025 "Interpret ITEM element as Org syntax.
1026 CONTENTS is the contents of the element."
1040 num
1047 ;; Compute indentation.
1052 ;; Indent contents.
1054 bullet
1067 ;;;; Plain List
1070 "Parse a plain list.
1072 Optional argument STRUCTURE, when non-nil, is the structure of
1073 the plain list being parsed.
1075 Return a list whose CAR is `plain-list' and CDR is a plist
1076 containing `:type', `:begin', `:end', `:contents-begin' and
1077 `:contents-end', `:structure' and `:post-blank' keywords.
1079 Assume point is at the beginning of the list."
1092 ;; Blank lines below list belong to the top-level list only.
1097 ;; Return value.
1101 :begin begin
1102 :end end
1103 :contents-begin contents-begin
1104 :contents-end contents-end
1105 :structure struct
1110 "Interpret PLAIN-LIST element as Org syntax.
1111 CONTENTS is the contents of the element."
1112 contents)
1115 ;;;; Quote Block
1118 "Parse a quote block.
1120 LIMIT bounds the search.
1122 Return a list whose CAR is `quote-block' and CDR is a plist
1123 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1124 `:contents-end' and `:post-blank' keywords.
1126 Assume point is at the beginning of the block."
1130 ;; Incomplete block: parse it as a comment.
1136 ;; Empty blocks have no contents.
1150 :end end
1151 :hiddenp hidden
1152 :contents-begin contents-begin
1153 :contents-end contents-end
1158 "Interpret QUOTE-BLOCK element as Org syntax.
1159 CONTENTS is the contents of the element."
1163 ;;;; Section
1166 "Parse a section.
1168 LIMIT bounds the search.
1170 Return a list whose CAR is `section' and CDR is a plist
1171 containing `:begin', `:end', `:contents-begin', `contents-end'
1172 and `:post-blank' keywords."
1174 ;; Beginning of section is the beginning of the first non-blank
1175 ;; line after previous headline.
1184 :end end
1185 :contents-begin begin
1186 :contents-end pos-before-blank
1190 "Interpret SECTION element as Org syntax.
1191 CONTENTS is the contents of the element."
1192 contents)
1195 ;;;; Special Block
1198 "Parse a special block.
1200 LIMIT bounds the search.
1202 Return a list whose CAR is `special-block' and CDR is a plist
1203 containing `:type', `:begin', `:end', `:hiddenp',
1204 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1206 Assume point is at the beginning of the block."
1212 ;; Incomplete block: parse it as a comment.
1218 ;; Empty blocks have no contents.
1232 :begin begin
1233 :end end
1234 :hiddenp hidden
1235 :contents-begin contents-begin
1236 :contents-end contents-end
1241 "Interpret SPECIAL-BLOCK element as Org syntax.
1242 CONTENTS is the contents of the element."
1247 \f
1248 ;;; Elements
1249 ;;
1250 ;; For each element, a parser and an interpreter are also defined.
1251 ;; Both follow the same naming convention used for greater elements.
1252 ;;
1253 ;; Also, as for greater elements, adding a new element type is done
1254 ;; through the following steps: implement a parser and an interpreter,
1255 ;; tweak `org-element--current-element' so that it recognizes the new
1256 ;; type and add that new type to `org-element-all-elements'.
1257 ;;
1258 ;; As a special case, when the newly defined type is a block type,
1259 ;; `org-element-block-name-alist' has to be modified accordingly.
1262 ;;;; Babel Call
1265 "Parse a babel call.
1267 LIMIT bounds the search.
1269 Return a list whose CAR is `babel-call' and CDR is a plist
1270 containing `:begin', `:end', `:info' and `:post-blank' as
1271 keywords."
1282 :end end
1283 :info info
1287 "Interpret BABEL-CALL element as Org syntax.
1288 CONTENTS is nil."
1294 ;; Remove redundant square brackets.
1299 ;;;; Clock
1302 "Parse a clock.
1304 LIMIT bounds the search.
1306 Return a list whose CAR is `clock' and CDR is a plist containing
1307 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1308 as keywords."
1327 :value value
1328 :time time
1329 :begin begin
1330 :end end
1334 "Interpret CLOCK element as Org syntax.
1335 CONTENTS is nil."
1342 "%2s:%02s"
1346 ;;;; Comment
1349 "Parse a comment.
1351 LIMIT bounds the search.
1353 Return a list whose CAR is `comment' and CDR is a plist
1354 containing `:begin', `:end', `:value' and `:post-blank'
1355 keywords.
1357 Assume point is at comment beginning."
1361 ;; Match first line with a loose regexp since it might as
1362 ;; well be an ill-defined keyword.
1368 ;; Get comments ending.
1372 ;; Accumulate lines without leading hash and plus sign
1373 ;; if any. First whitespace is also ignored.
1386 :end end
1387 :value value
1392 "Interpret COMMENT element as Org syntax.
1393 CONTENTS is nil."
1397 ;;;; Comment Block
1400 "Parse an export block.
1402 LIMIT bounds the search.
1404 Return a list whose CAR is `comment-block' and CDR is a plist
1405 containing `:begin', `:end', `:hiddenp', `:value' and
1406 `:post-blank' keywords.
1408 Assume point is at comment block beginning."
1412 ;; Incomplete block: parse it as a comment.
1426 contents-begin contents-end)))
1430 :end end
1431 :value value
1432 :hiddenp hidden
1437 "Interpret COMMENT-BLOCK element as Org syntax.
1438 CONTENTS is nil."
1443 ;;;; Example Block
1446 "Parse an example block.
1448 LIMIT bounds the search.
1450 Return a list whose CAR is `example-block' and CDR is a plist
1451 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1452 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1453 `:switches', `:value' and `:post-blank' keywords."
1457 ;; Incomplete block: parse it as a comment.
1464 ;; Switches analysis
1469 ;; Should labels be retained in (or stripped from) example
1470 ;; blocks?
1475 ;; What should code-references use - labels or
1476 ;; line-numbers?
1483 ;; Standard block parsing.
1497 :end end
1498 :value value
1499 :switches switches
1500 :number-lines number-lines
1501 :preserve-indent preserve-indent
1502 :retain-labels retain-labels
1503 :use-labels use-labels
1504 :label-fmt label-fmt
1505 :hiddenp hidden
1510 "Interpret EXAMPLE-BLOCK element as Org syntax.
1511 CONTENTS is nil."
1519 ;;;; Export Block
1522 "Parse an export block.
1524 LIMIT bounds the search.
1526 Return a list whose CAR is `export-block' and CDR is a plist
1527 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1528 `:post-blank' keywords.
1530 Assume point is at export-block beginning."
1536 ;; Incomplete block: parse it as a comment.
1550 contents-end)))
1554 :end end
1555 :type type
1556 :value value
1557 :hiddenp hidden
1562 "Interpret EXPORT-BLOCK element as Org syntax.
1563 CONTENTS is nil."
1570 ;;;; Fixed-width
1573 "Parse a fixed-width section.
1575 LIMIT bounds the search.
1577 Return a list whose CAR is `fixed-width' and CDR is a plist
1578 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1580 Assume point is at the beginning of the fixed-width area."
1584 value
1589 ;; Accumulate text without starting colons.
1602 :end end
1603 :value value
1608 "Interpret FIXED-WIDTH element as Org syntax.
1609 CONTENTS is nil."
1614 ;;;; Horizontal Rule
1617 "Parse an horizontal rule.
1619 LIMIT bounds the search.
1621 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1622 containing `:begin', `:end' and `:post-blank' keywords."
1632 :end end
1637 "Interpret HORIZONTAL-RULE element as Org syntax.
1638 CONTENTS is nil."
1642 ;;;; Keyword
1645 "Parse a keyword at point.
1647 LIMIT bounds the search.
1649 Return a list whose CAR is `keyword' and CDR is a plist
1650 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1651 keywords."
1664 :value value
1665 :begin begin
1666 :end end
1670 "Interpret KEYWORD element as Org syntax.
1671 CONTENTS is nil."
1677 ;;;; Latex Environment
1680 "Parse a LaTeX environment.
1682 LIMIT bounds the search.
1684 Return a list whose CAR is `latex-environment' and CDR is a plist
1685 containing `:begin', `:end', `:value' and `:post-blank'
1686 keywords.
1688 Assume point is at the beginning of the latex environment."
1706 :end end
1707 :value value
1712 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1713 CONTENTS is nil."
1717 ;;;; Paragraph
1720 "Parse a paragraph.
1722 LIMIT bounds the search.
1724 Return a list whose CAR is `paragraph' and CDR is a plist
1725 containing `:begin', `:end', `:contents-begin' and
1726 `:contents-end' and `:post-blank' keywords.
1728 Assume point is at the beginning of the paragraph."
1736 limit
1746 ;; If paragraph has no affiliated keywords, it may not begin
1747 ;; at beginning of line if it starts an item.
1750 :end end
1751 :contents-begin contents-begin
1752 :contents-end contents-end
1757 "Interpret PARAGRAPH element as Org syntax.
1758 CONTENTS is the contents of the element."
1759 contents)
1762 ;;;; Planning
1765 "Parse a planning.
1767 LIMIT bounds the search.
1769 Return a list whose CAR is `planning' and CDR is a plist
1770 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1771 and `:post-blank' keywords."
1780 closed deadline scheduled)
1794 :deadline deadline
1795 :scheduled scheduled
1796 :begin begin
1797 :end end
1801 "Interpret PLANNING element as Org syntax.
1802 CONTENTS is nil."
1804 'identity
1816 ;;;; Property Drawer
1819 "Parse a property drawer.
1821 LIMIT bounds the search.
1823 Return a list whose CAR is `property-drawer' and CDR is a plist
1824 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1825 `:contents-end', `:properties' and `:post-blank' keywords.
1827 Assume point is at the beginning of the property drawer."
1841 val))
1843 val))
1851 :end end
1852 :hiddenp hidden
1853 :properties properties
1857 "Interpret PROPERTY-DRAWER element as Org syntax.
1858 CONTENTS is nil."
1868 ;;;; Quote Section
1871 "Parse a quote section.
1873 LIMIT bounds the search.
1875 Return a list whose CAR is `quote-section' and CDR is a plist
1876 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1878 Assume point is at beginning of the section."
1889 :end end
1890 :value value
1894 "Interpret QUOTE-SECTION element as Org syntax.
1895 CONTENTS is nil."
1899 ;;;; Src Block
1902 "Parse a src block.
1904 LIMIT bounds the search.
1906 Return a list whose CAR is `src-block' and CDR is a plist
1907 containing `:language', `:switches', `:parameters', `:begin',
1908 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1909 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1910 `:post-blank' keywords.
1912 Assume point is at the beginning of the block."
1915 ;; Incomplete block: parse it as a comment.
1920 ;; Get beginning position.
1922 ;; Get language as a string.
1931 ;; Get switches.
1933 ;; Get parameters.
1935 ;; Switches analysis
1943 ;; Should labels be retained in (or stripped from)
1944 ;; src blocks?
1949 ;; What should code-references use - labels or
1950 ;; line-numbers?
1954 ;; Get visibility status.
1956 ;; Retrieve code.
1961 ;; Get position after ending blank lines.
1971 :begin begin
1972 :end end
1973 :number-lines number-lines
1974 :preserve-indent preserve-indent
1975 :retain-labels retain-labels
1976 :use-labels use-labels
1977 :label-fmt label-fmt
1978 :hiddenp hidden
1979 :value value
1984 "Interpret SRC-BLOCK element as Org syntax.
1985 CONTENTS is nil."
2005 value
2009 ;;;; Table
2012 "Parse a table at point.
2014 LIMIT bounds the search.
2016 Return a list whose CAR is `table' and CDR is a plist containing
2017 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2018 `:contents-end', `:value' and `:post-blank' keywords.
2020 Assume point is at the beginning of the table."
2032 acc))
2039 :end end
2040 :type type
2041 :tblfm tblfm
2042 ;; Only `org' tables have contents. `table.el' tables
2043 ;; use a `:value' property to store raw table as
2044 ;; a string.
2049 table-begin table-end))
2054 "Interpret TABLE element as Org syntax.
2055 CONTENTS is nil."
2066 ;;;; Table Row
2069 "Parse table row at point.
2071 LIMIT bounds the search.
2073 Return a list whose CAR is `table-row' and CDR is a plist
2074 containing `:begin', `:end', `:contents-begin', `:contents-end',
2075 `:type' and `:post-blank' keywords."
2079 ;; A table rule has no contents. In that case, ensure
2080 ;; CONTENTS-BEGIN matches CONTENTS-END.
2092 :begin begin
2093 :end end
2094 :contents-begin contents-begin
2095 :contents-end contents-end
2099 "Interpret TABLE-ROW element as Org syntax.
2100 CONTENTS is the contents of the table row."
2105 ;;;; Verse Block
2108 "Parse a verse block.
2110 LIMIT bounds the search.
2112 Return a list whose CAR is `verse-block' and CDR is a plist
2113 containing `:begin', `:end', `:contents-begin', `:contents-end',
2114 `:hiddenp' and `:post-blank' keywords.
2116 Assume point is at beginning of the block."
2120 ;; Incomplete block: parse it as a comment.
2136 :end end
2137 :contents-begin contents-begin
2138 :contents-end contents-end
2139 :hiddenp hidden
2144 "Interpret VERSE-BLOCK element as Org syntax.
2145 CONTENTS is verse block contents."
2149 \f
2150 ;;; Objects
2151 ;;
2152 ;; Unlike to elements, interstices can be found between objects.
2153 ;; That's why, along with the parser, successor functions are provided
2154 ;; for each object. Some objects share the same successor (i.e. `code'
2155 ;; and `verbatim' objects).
2156 ;;
2157 ;; A successor must accept a single argument bounding the search. It
2158 ;; will return either a cons cell whose CAR is the object's type, as
2159 ;; a symbol, and CDR the position of its next occurrence, or nil.
2160 ;;
2161 ;; Successors follow the naming convention:
2162 ;; org-element-NAME-successor, where NAME is the name of the
2163 ;; successor, as defined in `org-element-all-successors'.
2164 ;;
2165 ;; Some object types (i.e. `emphasis') are recursive. Restrictions on
2166 ;; object types they can contain will be specified in
2167 ;; `org-element-object-restrictions'.
2168 ;;
2169 ;; Adding a new type of object is simple. Implement a successor,
2170 ;; a parser, and an interpreter for it, all following the naming
2171 ;; convention. Register type in `org-element-all-objects' and
2172 ;; successor in `org-element-all-successors'. Maybe tweak
2173 ;; restrictions about it, and that's it.
2176 ;;;; Bold
2179 "Parse bold object at point.
2181 Return a list whose CAR is `bold' and CDR is a plist with
2182 `:begin', `:end', `:contents-begin' and `:contents-end' and
2183 `:post-blank' keywords.
2185 Assume point is at the first star marker."
2197 :end end
2198 :contents-begin contents-begin
2199 :contents-end contents-end
2203 "Interpret BOLD object as Org syntax.
2204 CONTENTS is the contents of the object."
2208 "Search for the next text-markup object.
2210 LIMIT bounds the search.
2212 LIMIT bounds the search.
2214 Return value is a cons cell whose CAR is a symbol among `bold',
2215 `italic', `underline', `strike-through', `code' and `verbatim'
2216 and CDR is beginning position."
2232 ;;;; Code
2235 "Parse code object at point.
2237 Return a list whose CAR is `code' and CDR is a plist with
2238 `:value', `:begin', `:end' and `:post-blank' keywords.
2240 Assume point is at the first tilde marker."
2251 :begin begin
2252 :end end
2256 "Interpret CODE object as Org syntax.
2257 CONTENTS is nil."
2261 ;;;; Entity
2264 "Parse entity at point.
2266 Return a list whose CAR is `entity' and CDR a plist with
2267 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2268 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2269 keywords.
2271 Assume point is at the beginning of the entity."
2273 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2289 :begin begin
2290 :end end
2291 :use-brackets-p bracketsp
2295 "Interpret ENTITY object as Org syntax.
2296 CONTENTS is nil."
2302 "Search for the next latex-fragment or entity object.
2304 LIMIT bounds the search.
2306 Return value is a cons cell whose CAR is `entity' or
2307 `latex-fragment' and CDR is beginning position."
2310 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2317 limit t)
2320 ;; Determine if it's a real entity or a LaTeX command.
2323 ;; No entity nor command: point is at a LaTeX fragment.
2324 ;; Determine its type to get the correct beginning position.
2332 matchers)
2336 ;;;; Export Snippet
2339 "Parse export snippet at point.
2341 Return a list whose CAR is `export-snippet' and CDR a plist with
2342 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2343 keywords.
2345 Assume point is at the beginning of the snippet."
2357 :value value
2358 :begin begin
2359 :end end
2363 "Interpret EXPORT-SNIPPET object as Org syntax.
2364 CONTENTS is nil."
2370 "Search for the next export-snippet object.
2372 LIMIT bounds the search.
2374 Return value is a cons cell whose CAR is `export-snippet' and CDR
2375 its beginning position."
2384 ;;;; Footnote Reference
2387 "Parse footnote reference at point.
2389 Return a list whose CAR is `footnote-reference' and CDR a plist
2390 with `:label', `:type', `:inline-definition', `:begin', `:end'
2391 and `:post-blank' as keywords."
2413 :type type
2414 :begin begin
2415 :end end
2418 footnote-reference :inline-definition
2423 footnote-reference))))))
2426 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2427 CONTENTS is nil."
2437 "Search for the next footnote-reference object.
2439 LIMIT bounds the search.
2441 Return value is a cons cell whose CAR is `footnote-reference' and
2442 CDR is beginning position."
2456 ;;;; Inline Babel Call
2459 "Parse inline babel call at point.
2461 Return a list whose CAR is `inline-babel-call' and CDR a plist
2462 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2464 Assume point is at the beginning of the babel call."
2475 :end end
2476 :info info
2480 "Interpret INLINE-BABEL-CALL object as Org syntax.
2481 CONTENTS is nil."
2487 ;; Remove redundant square brackets.
2490 main-source)
2494 "Search for the next inline-babel-call object.
2496 LIMIT bounds the search.
2498 Return value is a cons cell whose CAR is `inline-babel-call' and
2499 CDR is beginning position."
2501 ;; Use a simplified version of
2502 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2504 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2505 limit t)
2509 ;;;; Inline Src Block
2512 "Parse inline source block at point.
2514 LIMIT bounds the search.
2516 Return a list whose CAR is `inline-src-block' and CDR a plist
2517 with `:begin', `:end', `:language', `:value', `:parameters' and
2518 `:post-blank' as keywords.
2520 Assume point is at the beginning of the inline src block."
2533 :value value
2534 :parameters parameters
2535 :begin begin
2536 :end end
2540 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2541 CONTENTS is nil."
2546 language
2548 body)))
2551 "Search for the next inline-babel-call element.
2553 LIMIT bounds the search.
2555 Return value is a cons cell whose CAR is `inline-babel-call' and
2556 CDR is beginning position."
2561 ;;;; Italic
2564 "Parse italic object at point.
2566 Return a list whose CAR is `italic' and CDR is a plist with
2567 `:begin', `:end', `:contents-begin' and `:contents-end' and
2568 `:post-blank' keywords.
2570 Assume point is at the first slash marker."
2582 :end end
2583 :contents-begin contents-begin
2584 :contents-end contents-end
2588 "Interpret ITALIC object as Org syntax.
2589 CONTENTS is the contents of the object."
2593 ;;;; Latex Fragment
2596 "Parse latex fragment at point.
2598 Return a list whose CAR is `latex-fragment' and CDR a plist with
2599 `:value', `:begin', `:end', and `:post-blank' as keywords.
2601 Assume point is at the beginning of the latex fragment."
2615 ;; None found: it's a macro.
2624 :begin begin
2625 :end end
2629 "Interpret LATEX-FRAGMENT object as Org syntax.
2630 CONTENTS is nil."
2633 ;;;; Line Break
2636 "Parse line break at point.
2638 Return a list whose CAR is `line-break', and CDR a plist with
2639 `:begin', `:end' and `:post-blank' keywords.
2641 Assume point is at the beginning of the line break."
2645 "Interpret LINE-BREAK object as Org syntax.
2646 CONTENTS is nil."
2650 "Search for the next line-break object.
2652 LIMIT bounds the search.
2654 Return value is a cons cell whose CAR is `line-break' and CDR is
2655 beginning position."
2659 ;; A line break can only happen on a non-empty line.
2664 ;;;; Link
2667 "Parse link at point.
2669 Return a list whose CAR is `link' and CDR a plist with `:type',
2670 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2671 `:contents-end' and `:post-blank' as keywords.
2673 Assume point is at the beginning of the link."
2676 end contents-begin contents-end link-end post-blank path type
2677 raw-link link)
2679 ;; Type 1: Text targeted from a radio target.
2684 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2689 ;; RAW-LINK is the original link.
2694 ;; Determine TYPE of link and set PATH accordingly.
2696 ;; File type.
2699 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2702 ;; Id type: PATH is the id.
2705 ;; Code-ref type: PATH is the name of the reference.
2708 ;; Custom-id type: PATH is the name of the custom id.
2711 ;; Fuzzy type: Internal link either matches a target, an
2712 ;; headline name or nothing. PATH is the target or
2713 ;; headline's name.
2715 ;; Type 3: Plain link, i.e. http://orgmode.org
2721 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2728 ;; In any case, deduce end point after trailing white space from
2729 ;; LINK-END variable.
2734 :path path
2736 :begin begin
2737 :end end
2738 :contents-begin contents-begin
2739 :contents-end contents-end
2743 "Interpret LINK object as Org syntax.
2744 CONTENTS is the contents of the object, or nil."
2749 raw-link
2753 "Search for the next link object.
2755 LIMIT bounds the search.
2757 Return value is a cons cell whose CAR is `link' and CDR is
2758 beginning position."
2767 ;;;; Macro
2770 "Parse macro at point.
2772 Return a list whose CAR is `macro' and CDR a plist with `:key',
2773 `:args', `:begin', `:end', `:value' and `:post-blank' as
2774 keywords.
2776 Assume point is at the macro."
2790 ;; Repair bad splits.
2798 :value value
2799 :args args
2800 :begin begin
2801 :end end
2805 "Interpret MACRO object as Org syntax.
2806 CONTENTS is nil."
2810 "Search for the next macro object.
2812 LIMIT bounds the search.
2814 Return value is cons cell whose CAR is `macro' and CDR is
2815 beginning position."
2819 limit t)
2823 ;;;; Radio-target
2826 "Parse radio target at point.
2828 Return a list whose CAR is `radio-target' and CDR a plist with
2829 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2830 and `:post-blank' as keywords.
2832 Assume point is at the radio target."
2844 :end end
2845 :contents-begin contents-begin
2846 :contents-end contents-end
2847 :post-blank post-blank
2851 "Interpret TARGET object as Org syntax.
2852 CONTENTS is the contents of the object."
2856 "Search for the next radio-target object.
2858 LIMIT bounds the search.
2860 Return value is a cons cell whose CAR is `radio-target' and CDR
2861 is beginning position."
2867 ;;;; Statistics Cookie
2870 "Parse statistics cookie at point.
2872 Return a list whose CAR is `statistics-cookie', and CDR a plist
2873 with `:begin', `:end', `:value' and `:post-blank' keywords.
2875 Assume point is at the beginning of the statistics-cookie."
2886 :end end
2887 :value value
2891 "Interpret STATISTICS-COOKIE object as Org syntax.
2892 CONTENTS is nil."
2896 "Search for the next statistics cookie object.
2898 LIMIT bounds the search.
2900 Return value is a cons cell whose CAR is `statistics-cookie' and
2901 CDR is beginning position."
2907 ;;;; Strike-Through
2910 "Parse strike-through object at point.
2912 Return a list whose CAR is `strike-through' and CDR is a plist
2913 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2914 `:post-blank' keywords.
2916 Assume point is at the first plus sign marker."
2928 :end end
2929 :contents-begin contents-begin
2930 :contents-end contents-end
2934 "Interpret STRIKE-THROUGH object as Org syntax.
2935 CONTENTS is the contents of the object."
2939 ;;;; Subscript
2942 "Parse subscript at point.
2944 Return a list whose CAR is `subscript' and CDR a plist with
2945 `:begin', `:end', `:contents-begin', `:contents-end',
2946 `:use-brackets-p' and `:post-blank' as keywords.
2948 Assume point is at the underscore."
2952 t
2963 :end end
2964 :use-brackets-p bracketsp
2965 :contents-begin contents-begin
2966 :contents-end contents-end
2970 "Interpret SUBSCRIPT object as Org syntax.
2971 CONTENTS is the contents of the object."
2974 contents))
2977 "Search for the next sub/superscript object.
2979 LIMIT bounds the search.
2981 Return value is a cons cell whose CAR is either `subscript' or
2982 `superscript' and CDR is beginning position."
2989 ;;;; Superscript
2992 "Parse superscript at point.
2994 Return a list whose CAR is `superscript' and CDR a plist with
2995 `:begin', `:end', `:contents-begin', `:contents-end',
2996 `:use-brackets-p' and `:post-blank' as keywords.
2998 Assume point is at the caret."
3012 :end end
3013 :use-brackets-p bracketsp
3014 :contents-begin contents-begin
3015 :contents-end contents-end
3019 "Interpret SUPERSCRIPT object as Org syntax.
3020 CONTENTS is the contents of the object."
3023 contents))
3026 ;;;; Table Cell
3029 "Parse table cell at point.
3031 Return a list whose CAR is `table-cell' and CDR is a plist
3032 containing `:begin', `:end', `:contents-begin', `:contents-end'
3033 and `:post-blank' keywords."
3041 :end end
3042 :contents-begin contents-begin
3043 :contents-end contents-end
3047 "Interpret TABLE-CELL element as Org syntax.
3048 CONTENTS is the contents of the cell, or nil."
3052 "Search for the next table-cell object.
3054 LIMIT bounds the search.
3056 Return value is a cons cell whose CAR is `table-cell' and CDR is
3057 beginning position."
3061 ;;;; Target
3064 "Parse target at point.
3066 Return a list whose CAR is `target' and CDR a plist with
3067 `:begin', `:end', `:value' and `:post-blank' as keywords.
3069 Assume point is at the target."
3079 :end end
3080 :value value
3084 "Interpret TARGET object as Org syntax.
3085 CONTENTS is nil."
3089 "Search for the next target object.
3091 LIMIT bounds the search.
3093 Return value is a cons cell whose CAR is `target' and CDR is
3094 beginning position."
3100 ;;;; Timestamp
3103 "Parse time stamp at point.
3105 Return a list whose CAR is `timestamp', and CDR a plist with
3106 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3108 Assume point is at the beginning of the timestamp."
3127 :value main-value
3128 :range-end range-end
3129 :begin begin
3130 :end end
3134 "Interpret TIMESTAMP object as Org syntax.
3135 CONTENTS is nil."
3144 range-end)))))))
3147 "Search for the next timestamp object.
3149 LIMIT bounds the search.
3151 Return value is a cons cell whose CAR is `timestamp' and CDR is
3152 beginning position."
3160 limit t)
3164 ;;;; Underline
3167 "Parse underline object at point.
3169 Return a list whose CAR is `underline' and CDR is a plist with
3170 `:begin', `:end', `:contents-begin' and `:contents-end' and
3171 `:post-blank' keywords.
3173 Assume point is at the first underscore marker."
3185 :end end
3186 :contents-begin contents-begin
3187 :contents-end contents-end
3191 "Interpret UNDERLINE object as Org syntax.
3192 CONTENTS is the contents of the object."
3196 ;;;; Verbatim
3199 "Parse verbatim object at point.
3201 Return a list whose CAR is `verbatim' and CDR is a plist with
3202 `:value', `:begin', `:end' and `:post-blank' keywords.
3204 Assume point is at the first equal sign marker."
3215 :begin begin
3216 :end end
3220 "Interpret VERBATIM object as Org syntax.
3221 CONTENTS is nil."
3225 \f
3226 ;;; Parsing Element Starting At Point
3227 ;;
3228 ;; `org-element--current-element' is the core function of this section.
3229 ;; It returns the Lisp representation of the element starting at
3230 ;; point.
3231 ;;
3232 ;; `org-element--current-element' makes use of special modes. They
3233 ;; are activated for fixed element chaining (i.e. `plain-list' >
3234 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3235 ;; `section'). Special modes are: `first-section', `section',
3236 ;; `quote-section', `item' and `table-row'.
3240 "Parse the element starting at point.
3242 LIMIT bounds the search.
3244 Return value is a list like (TYPE PROPS) where TYPE is the type
3245 of the element and PROPS a plist of properties associated to the
3246 element.
3248 Possible types are defined in `org-element-all-elements'.
3250 Optional argument GRANULARITY determines the depth of the
3251 recursion. Allowed values are `headline', `greater-element',
3252 `element', `object' or nil. When it is broader than `object' (or
3253 nil), secondary values will not be parsed, since they only
3254 contain objects.
3256 Optional argument SPECIAL, when non-nil, can be either
3257 `first-section', `section', `quote-section', `table-row' and
3258 `item'.
3260 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3261 be computed.
3263 This function assumes point is always at the beginning of the
3264 element it has to parse."
3266 ;; If point is at an affiliated keyword, try moving to the
3267 ;; beginning of the associated element. If none is found, the
3268 ;; keyword is orphaned and will be treated as plain text.
3274 ;; Determine if parsing depth allows for secondary strings
3275 ;; parsing. It only applies to elements referenced in
3276 ;; `org-element-secondary-value-alist'.
3279 ;; Item.
3282 ;; Quote Section.
3284 ;; Table Row.
3286 ;; Headline.
3289 ;; Section (must be checked after headline).
3294 limit)))
3295 ;; Planning and Clock.
3300 ;; Inlinetask.
3303 ;; LaTeX Environment.
3309 nil t))
3312 ;; Drawer and Property Drawer.
3322 ;; Fixed Width
3325 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3326 ;; Keywords.
3335 org-element-block-name-alist)))
3347 ;; Ill-formed syntax is considered as a comment.
3351 ;; Comments.
3353 ;; Footnote Definition.
3356 ;; Horizontal Rule.
3359 ;; Table.
3361 ;; List.
3364 ;; Default element: Paragraph.
3368 ;; Most elements can have affiliated keywords. When looking for an
3369 ;; element beginning, we want to move before them, as they belong to
3370 ;; that element, and, in the meantime, collect information they give
3371 ;; into appropriate properties. Hence the following function.
3372 ;;
3373 ;; Usage of optional arguments may not be obvious at first glance:
3374 ;;
3375 ;; - TRANS-LIST is used to polish keywords names that have evolved
3376 ;; during Org history. In example, even though =result= and
3377 ;; =results= coexist, we want to have them under the same =result=
3378 ;; property. It's also true for "srcname" and "name", where the
3379 ;; latter seems to be preferred nowadays (thus the "name" property).
3380 ;;
3381 ;; - CONSED allows to regroup multi-lines keywords under the same
3382 ;; property, while preserving their own identity. This is mostly
3383 ;; used for "attr_latex" and al.
3384 ;;
3385 ;; - PARSED prepares a keyword value for export. This is useful for
3386 ;; "caption". Objects restrictions for such keywords are defined in
3387 ;; `org-element-object-restrictions'.
3388 ;;
3389 ;; - DUALS is used to take care of keywords accepting a main and an
3390 ;; optional secondary values. For example "results" has its
3391 ;; source's name as the main value, and may have an hash string in
3392 ;; optional square brackets as the secondary one.
3393 ;;
3394 ;; A keyword may belong to more than one category.
3398 "Collect affiliated keywords before point.
3400 Optional argument KEY-RE is a regexp matching keywords, which
3401 puts matched keyword in group 1. It defaults to
3402 `org-element--affiliated-re'.
3404 TRANS-LIST is an alist where key is the keyword and value the
3405 property name it should be translated to, without the colons. It
3406 defaults to `org-element-keyword-translation-alist'.
3408 CONSED is a list of strings. Any keyword belonging to that list
3409 will have its value consed. The check is done after keyword
3410 translation. It defaults to `org-element-multiple-keywords'.
3412 PARSED is a list of strings. Any keyword member of this list
3413 will have its value parsed. The check is done after keyword
3414 translation. If a keyword is a member of both CONSED and PARSED,
3415 it's value will be a list of parsed strings. It defaults to
3416 `org-element-parsed-keywords'.
3418 DUALS is a list of strings. Any keyword member of this list can
3419 have two parts: one mandatory and one optional. Its value is
3420 a cons cell whose CAR is the former, and the CDR the latter. If
3421 a keyword is a member of both PARSED and DUALS, both values will
3422 be parsed. It defaults to `org-element-dual-keywords'.
3424 Return a list whose CAR is the position at the first of them and
3425 CDR a plist of keywords and values."
3433 ;; RESTRICT is the list of objects allowed in parsed
3434 ;; keywords value.
3436 output)
3440 ;; Apply translation to RAW-KWD. From there, KWD is
3441 ;; the official keyword.
3443 ;; Find main value for any keyword.
3449 ;; If KWD is a dual keyword, find its secondary
3450 ;; value. Maybe parse it.
3456 ;; Attribute a property name to KWD.
3458 ;; Now set final shape for VALUE.
3462 ;; VALUE is mandatory. Set it to nil if there is none.
3464 ;; Attributes are always consed.
3467 ;; Eventually store the new value in OUTPUT.
3473 \f
3474 ;;; The Org Parser
3475 ;;
3476 ;; The two major functions here are `org-element-parse-buffer', which
3477 ;; parses Org syntax inside the current buffer, taking into account
3478 ;; region, narrowing, or even visibility if specified, and
3479 ;; `org-element-parse-secondary-string', which parses objects within
3480 ;; a given string.
3481 ;;
3482 ;; The (almost) almighty `org-element-map' allows to apply a function
3483 ;; on elements or objects matching some type, and accumulate the
3484 ;; resulting values. In an export situation, it also skips unneeded
3485 ;; parts of the parse tree.
3488 "Recursively parse the buffer and return structure.
3489 If narrowing is in effect, only parse the visible part of the
3490 buffer.
3492 Optional argument GRANULARITY determines the depth of the
3493 recursion. It can be set to the following symbols:
3495 `headline' Only parse headlines.
3496 `greater-element' Don't recurse into greater elements excepted
3497 headlines and sections. Thus, elements
3498 parsed are the top-level ones.
3499 `element' Parse everything but objects and plain text.
3500 `object' Parse the complete buffer (default).
3502 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3503 elements.
3505 Assume buffer is in Org mode."
3511 ;; Start in `first-section' mode so text before the first
3512 ;; headline belongs to a section.
3516 "Recursively parse objects in STRING and return structure.
3518 RESTRICTION is a symbol limiting the object types that will be
3519 looked after.
3521 Optional argument PARENT, when non-nil, is the element or object
3522 containing the secondary string. It is used to set correctly
3523 `:parent' property within the string."
3529 secondary))))
3532 "Map a function on selected elements or objects.
3534 DATA is the parsed tree, as returned by, i.e,
3535 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3536 of elements or objects types. FUN is the function called on the
3537 matching element or object. It must accept one arguments: the
3538 element or object itself.
3540 When optional argument INFO is non-nil, it should be a plist
3541 holding export options. In that case, parts of the parse tree
3542 not exportable according to that property list will be skipped.
3544 When optional argument FIRST-MATCH is non-nil, stop at the first
3545 match for which FUN doesn't return nil, and return that value.
3547 Optional argument NO-RECURSION is a symbol or a list of symbols
3548 representing elements or objects types. `org-element-map' won't
3549 enter any recursive element or object whose type belongs to that
3550 list. Though, FUN can still be applied on them.
3552 Nil values returned from FUN do not appear in the results."
3553 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3556 ;; Recursion depth is determined by --CATEGORY.
3563 ;; If one object is found, the function
3564 ;; has to recurse into every object.
3567 ;; If one regular element is found, the
3568 ;; function has to recurse, at lest, into
3569 ;; every element it encounters.
3572 types)
3573 category)))
3574 --acc
3575 --walk-tree
3579 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3580 ;; holding contextual information.
3584 ;; Ignored element in an export context.
3586 ;; Secondary string: only objects can be found there.
3589 ;; Unconditionally enter parse trees.
3593 ;; Check if TYPE is matching among TYPES. If so,
3594 ;; apply FUN to --DATA and accumulate return value
3595 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3601 ;; If --DATA has a secondary string that can contain
3602 ;; objects with their type among TYPES, look into it.
3609 ;; Determine if a recursion into --DATA is possible.
3611 ;; --TYPE is explicitly removed from recursion.
3613 ;; --DATA has no contents.
3615 ;; Looking for greater elements but --DATA is simply
3616 ;; an element or an object.
3619 ;; Looking for elements but --DATA is an object.
3622 ;; In any other case, map contents.
3626 ;; Return value in a proper order.
3629 ;; The following functions are internal parts of the parser.
3630 ;;
3631 ;; The first one, `org-element--parse-elements' acts at the element's
3632 ;; level.
3633 ;;
3634 ;; The second one, `org-element--parse-objects' applies on all objects
3635 ;; of a paragraph or a secondary string. It uses
3636 ;; `org-element--get-next-object-candidates' to optimize the search of
3637 ;; the next object in the buffer.
3638 ;;
3639 ;; More precisely, that function looks for every allowed object type
3640 ;; first. Then, it discards failed searches, keeps further matches,
3641 ;; and searches again types matched behind point, for subsequent
3642 ;; calls. Thus, searching for a given type fails only once, and every
3643 ;; object is searched only once at top level (but sometimes more for
3644 ;; nested types).
3648 "Parse elements between BEG and END positions.
3650 SPECIAL prioritize some elements over the others. It can be set
3651 to `first-section', `quote-section', `section' `item' or
3652 `table-row'.
3654 When value is `item', STRUCTURE will be used as the current list
3655 structure.
3657 GRANULARITY determines the depth of the recursion. See
3658 `org-element-parse-buffer' for more information.
3660 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3661 elements.
3663 Elements are accumulated into ACC."
3666 ;; When parsing only headlines, skip any text before first one.
3669 ;; Main loop start.
3671 ;; Find current element's type and parse it accordingly to
3672 ;; its category.
3674 end granularity special structure))
3678 ;; Fill ELEMENT contents by side-effect.
3680 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3681 ;; no contents, don't modify it.
3684 ;; Greater element: parse it between `contents-begin' and
3685 ;; `contents-end'. Make sure GRANULARITY allows the
3686 ;; recursion, or ELEMENT is an headline, in which case going
3687 ;; inside is mandatory, in order to get sub-level headings.
3695 ;; Possibly switch to a special mode.
3703 granularity visible-only element))
3704 ;; ELEMENT has contents. Parse objects inside, if
3705 ;; GRANULARITY allows it.
3711 ;; Return result.
3712 acc))
3715 "Parse objects between BEG and END and return recursive structure.
3717 Objects are accumulated in ACC.
3719 RESTRICTION is a list of object types which are allowed in the
3720 current object."
3726 end restriction candidates)))
3733 ;; 1. Text before any object. Untabify it.
3738 acc
3742 ;; 2. Object...
3745 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3746 ;; a recursive type.
3751 cont-beg
3758 ;; 3. Text after last object. Untabify it.
3762 acc
3766 ;; Result.
3767 acc)))
3770 "Return an alist of candidates for the next object.
3772 LIMIT bounds the search, and RESTRICTION narrows candidates to
3773 some object types.
3775 Return value is an alist whose CAR is position and CDR the object
3776 type, as a symbol.
3778 OBJECTS is the previous candidates alist."
3780 ;; If no previous result, search every object type in RESTRICTION.
3781 ;; Otherwise, keep potential candidates (old objects located after
3782 ;; point) and ask to search again those which had matched before.
3787 objects))
3788 ;; Call the appropriate successor function for each type to search
3789 ;; and accumulate matches.
3796 type))))
3799 types-to-search)
3800 ;; Return alist.
3801 next-candidates))
3804 \f
3805 ;;; Towards A Bijective Process
3806 ;;
3807 ;; The parse tree obtained with `org-element-parse-buffer' is really
3808 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3809 ;; interpreted and expanded into a string with canonical Org syntax.
3810 ;; Hence `org-element-interpret-data'.
3811 ;;
3812 ;; The function relies internally on
3813 ;; `org-element--interpret-affiliated-keywords'.
3816 "Interpret DATA as Org syntax.
3818 DATA is a parse tree, an element, an object or a secondary string
3819 to interpret.
3821 Optional argument PARENT is used for recursive calls. It contains
3822 the element or object containing data, or nil.
3824 Return Org syntax as a string."
3828 ;; Secondary string.
3833 ;; Full Org document.
3838 ;; Plain text.
3840 ;; Element/Object without contents.
3843 data nil))
3844 ;; Element/Object with contents.
3854 ;; Elements directly containing objects must
3855 ;; have their indentation normalized first.
3857 data
3858 ;; When normalizing first paragraph of an
3859 ;; item or a footnote-definition, ignore
3860 ;; first line's indentation.
3867 data
3869 contents)))))))
3871 ;; Build white spaces. If no `:post-blank' property is
3872 ;; specified, assume its value is 0.
3882 "Return ELEMENT's affiliated keywords as Org syntax.
3883 If there is no affiliated keyword, return the empty string."
3893 ": "
3896 value)
3904 ;; All attribute keywords can have multiple lines.
3907 value
3910 ;; List all ELEMENT's properties matching an attribute line or an
3911 ;; affiliated keyword, but ignore translated keywords since they
3912 ;; cannot belong to the property list.
3919 org-element-keyword-translation-alist)))))
3920 collect prop)
3923 ;; Because interpretation of the parse tree must return the same
3924 ;; number of blank lines between elements and the same number of white
3925 ;; space after objects, some special care must be given to white
3926 ;; spaces.
3927 ;;
3928 ;; The first function, `org-element-normalize-string', ensures any
3929 ;; string different from the empty string will end with a single
3930 ;; newline character.
3931 ;;
3932 ;; The second function, `org-element-normalize-contents', removes
3933 ;; global indentation from the contents of the current element.
3936 "Ensure string S ends with a single newline character.
3938 If S isn't a string return it unchanged. If S is the empty
3939 string, return it. Otherwise, return a new string with a single
3940 newline character at its end."
3948 "Normalize plain text in ELEMENT's contents.
3950 ELEMENT must only contain plain text and objects.
3952 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3953 indentation to compute maximal common indentation.
3955 Return the normalized element that is element with global
3956 indentation removed from its contents. The function assumes that
3957 indentation is not done with TAB characters."
3959 collect-inds ; for byte-compiler
3962 ;; Return list of indentations within BLOB. This is done by
3963 ;; walking recursively BLOB and updating IND-LIST along the
3964 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3965 ;; been seen yet. It is required as this string is the only
3966 ;; one whose indentation doesn't happen after a newline
3967 ;; character.
3975 ;; An indentation of zero means no string will be
3976 ;; modified. Quit the process.
3982 ;; Avoid matching blank or empty lines.
3990 ;; Collect indentation list in ELEMENT. Possibly remove first
3991 ;; value if IGNORE-FIRST is non-nil.
3994 ;; Build ELEMENT back, replacing each string with the same
3995 ;; string minus common indentation.
4000 ;; Return BLOB with all its strings indentation
4001 ;; shortened from MCI white spaces. FIRST-FLAG is
4002 ;; non-nil when the first string hasn't been seen
4003 ;; yet.
4017 org-element-recursive-objects)
4021 blob))))
4025 \f
4026 ;;; The Toolbox
4027 ;;
4028 ;; The first move is to implement a way to obtain the smallest element
4029 ;; containing point. This is the job of `org-element-at-point'. It
4030 ;; basically jumps back to the beginning of section containing point
4031 ;; and moves, element after element, with
4032 ;; `org-element--current-element' until the container is found.
4033 ;;
4034 ;; At a deeper level, `org-element-context' lists all elements and
4035 ;; objects containing point.
4036 ;;
4037 ;; Note: When using `org-element-at-point', secondary values are never
4038 ;; parsed since the function focuses on elements, not on objects.
4041 "Determine closest element around point.
4043 Return value is a list like (TYPE PROPS) where TYPE is the type
4044 of the element and PROPS a plist of properties associated to the
4045 element. Possible types are defined in
4046 `org-element-all-elements'.
4048 As a special case, if point is at the very beginning of a list or
4049 sub-list, returned element will be that list instead of the first
4050 item. In the same way, if point is at the beginning of the first
4051 row of a table, returned element will be the table instead of the
4052 first row.
4054 If optional argument KEEP-TRAIL is non-nil, the function returns
4055 a list of of elements leading to element at point. The list's
4056 CAR is always the element at point. Following positions contain
4057 element's siblings, then parents, siblings of parents, until the
4058 first element of current section."
4060 ;; If at an headline, parse it. It is the sole element that
4061 ;; doesn't require to know about context. Be sure to disallow
4062 ;; secondary string parsing, though.
4068 ;; Otherwise move at the beginning of the section containing
4069 ;; point.
4072 element type special-flag trail struct prevs)
4079 ;; Parse successively each element, skipping those ending
4080 ;; before original position.
4088 ;; 1. Skip any element ending before point or at point.
4093 ;; 2. An element containing point is always the element at
4094 ;; point.
4097 ;; 3. At any other greater element type, if point is
4098 ;; within contents, move into it. Otherwise, return
4099 ;; that element.
4116 "Return list of all elements and objects around point.
4118 Return value is a list like (TYPE PROPS) where TYPE is the type
4119 of the element or object and PROPS a plist of properties
4120 associated to it. Possible types are defined in
4121 `org-element-all-elements' and `org-element-all-objects'.
4123 All elements and objects returned belong to the current section
4124 and are ordered from closest to farthest."
4127 ;; Remove elements not containing point from trail.
4135 ;; Check if point is inside an element containing objects or at
4136 ;; a secondary string. In that case, move to beginning of the
4137 ;; element or secondary string and set END to the other side.
4146 (<= origin
4147 ;; `1+' is required so some
4148 ;; successors can match
4149 ;; properly their object.
4163 elements
4167 end restriction candidates))
4169 candidates)))
4170 ;; If ORIGIN is before next object in element, there's
4171 ;; no point in looking further.
4180 ;; ORIGIN is after OBJECT, so skip it.
4183 ;; ORIGIN is within a non-recursive object or at an
4184 ;; object boundaries: Return that object.
4187 ;; Otherwise, move within current object and restrict
4188 ;; search to the end of its contents.
4192 elements))))))
4195 ;; Once the local structure around point is well understood, it's easy
4196 ;; to implement some replacements for `forward-paragraph'
4197 ;; `backward-paragraph', namely `org-element-forward' and
4198 ;; `org-element-backward'.
4199 ;;
4200 ;; Also, `org-transpose-elements' mimics the behaviour of
4201 ;; `transpose-words', at the element's level, whereas
4202 ;; `org-element-drag-forward', `org-element-drag-backward', and
4203 ;; `org-element-up' generalize, respectively, functions
4204 ;; `org-subtree-down', `org-subtree-up' and `outline-up-heading'.
4205 ;;
4206 ;; `org-element-unindent-buffer' will, as its name almost suggests,
4207 ;; smartly remove global indentation from buffer, making it possible
4208 ;; to use Org indent mode on a file created with hard indentation.
4209 ;;
4210 ;; `org-element-nested-p' and `org-element-swap-A-B' are used
4211 ;; internally by some of the previously cited tools.
4214 "Non-nil when elements ELEM-A and ELEM-B are nested."
4223 "Swap elements ELEM-A and ELEM-B.
4224 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4225 end of ELEM-A."
4227 ;; There are two special cases when an element doesn't start at bol:
4228 ;; the first paragraph in an item or in a footnote definition.
4230 ;; Only a paragraph without any affiliated keyword can be moved at
4231 ;; ELEM-A position in such a situation. Note that the case of
4232 ;; a footnote definition is impossible: it cannot contain two
4233 ;; paragraphs in a row because it cannot contain a blank line.
4239 ;; In a special situation, ELEM-A will have no indentation. We'll
4240 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4254 ;; Store overlays responsible for visibility status. We
4255 ;; also need to store their boundaries as they will be
4256 ;; removed from buffer.
4263 ;; Get contents.
4271 ;; Restore ex ELEM-A overlays.
4281 ;; Restore ex ELEM-B overlays.
4290 "Move forward by one element.
4291 Move to the next element at the same level, when possible."
4304 return prev)))
4312 "Move backward by one element.
4313 Move to the previous element at the same level, when possible."
4316 ;; At an headline, move to the previous one, if any, or stay
4317 ;; here.
4328 ;; Move to beginning of current element if point isn't there
4329 ;; already.
4335 "Move to upper element."
4345 return prev)))
4352 "Move to inner element."
4360 ;; If contents are hidden, first disclose them.
4366 "Move backward element at point."
4372 ;; Error out if no previous element or previous element is
4373 ;; a parent of the current one.
4382 "Move forward element at point."
4395 ;; Compute new position of point: it's shifted by NEXT-ELEM
4396 ;; body's length (without final blanks) and by the length of
4397 ;; blanks between ELEM and NEXT-ELEM.
4402 ;; Small correction if buffer doesn't end
4403 ;; with a newline character.
4416 "Put point at beginning of this element, mark at end.
4418 Interactively, if this command is repeated or (in Transient Mark
4419 mode) if the mark is active, it marks the next element after the
4420 ones already marked."
4435 "Narrow buffer to current element."
4453 "Transpose current and previous elements, keeping blank lines between.
4454 Point is moved after both elements."
4462 "Un-indent the visible part of the buffer.
4463 Relative indentation (between items, inside blocks, etc.) isn't
4464 modified."
4469 unindent-tree ; For byte-compiler.
4488 ;;; org-element.el ends here