| blob | f86c3660d5ccbd9b4e884436e5645f1607a5ec54 |
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 (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 `org-element-at-point' function, and
104 ;; a way to give information about document structure around point
105 ;; with `org-element-context'.
108 ;;; 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, inlinetasks.
129 ;; Footnote definitions.
132 ;; Empty lines.
134 ;; Tables (any type).
136 ;; Blocks (any type), Babel calls, drawers (any type),
137 ;; fixed-width areas and keywords. Note: this is only an
138 ;; indication and need some thorough check.
140 ;; Horizontal rules.
142 ;; LaTeX environments.
144 ;; Planning and Clock lines.
146 org-deadline-string
147 org-closed-string
148 org-clock-string))
150 ;; Lists.
157 "Regexp to separate paragraphs in an Org buffer.
159 is not sufficient to know if point is at a paragraph ending. See
164 export-block fixed-width footnote-definition headline
165 horizontal-rule inlinetask item keyword latex-environment
166 babel-call paragraph plain-list planning property-drawer
167 quote-block quote-section section special-block src-block table
168 table-row verse-block)
173 item plain-list quote-block section special-block table)
178 latex-or-entity line-break link macro radio-target
179 statistics-cookie sub/superscript table-cell target
180 text-markup timestamp)
189 "Alist of translations between object type and successor name.
191 Sharing the same successor comes handy when, for example, the
196 inline-src-block italic line-break latex-fragment link macro
197 radio-target statistics-cookie strike-through subscript superscript
198 table-cell target timestamp underline verbatim)
203 table-cell underline)
213 "Alist between block names and the associated parsing function.
214 Names must be uppercase. Any block whose name has no association
220 "List of affiliated keywords as strings.
226 ;; Regular affiliated keywords.
229 "Regexp matching any affiliated keyword.
231 Keyword name is put in match group 1. Moreover, if keyword
232 belongs to `org-element-dual-keywords', put the dual value in
233 match group 2.
241 "Alist of usual translations for keywords.
242 The key is the old name and the value the new one. The property
246 "List of affiliated keywords that can occur more that once in an element.
248 Their value will be consed into a list of strings, which will be
249 returned as the value of the property.
251 This list is checked after translations have been applied. See
252 `org-element-keyword-translation-alist'.
258 "List of keywords whose value can be parsed.
260 Their value will be stored as a secondary string: a list of
261 strings and objects.
263 This list is checked after translations have been applied. See
267 "List of keywords which can have a secondary value.
269 In Org syntax, they can be written with optional square brackets
270 before the colons. For example, results keyword can be
271 associated to a hash value with the following:
273 #+RESULTS[hash-string]: some-source
275 This list is checked after translations have been applied. See
282 inline-src-block latex-or-entity line-break link macro
283 radio-target sub/superscript target text-markup
284 timestamp)
286 radio-target statistics-cookie sub/superscript target text-markup
287 timestamp)
299 inline-src-block latex-or-entity line-break link macro
300 radio-target statistics-cookie sub/superscript target text-markup
301 timestamp)
304 latex-or-entity link radio-target sub/superscript target
305 text-markup timestamp)
316 latex-or-entity line-break link macro radio-target
318 "Alist of objects restrictions.
320 CAR is an element or object type containing objects and CDR is
321 a list of successors that will be called within an element or
322 object of such type.
324 For example, in a `radio-target' object, one can only find
325 entities, export snippets, latex-fragments, subscript and
326 superscript.
328 This alist also applies to secondary string. For example, an
329 `headline' type element doesn't directly contain objects, but
340 \f
341 ;;; Accessors and Setters
342 ;;
343 ;; Provide four accessors: `org-element-type', `org-element-property'
344 ;; `org-element-contents' and `org-element-restriction'.
345 ;;
346 ;; Setter functions allow to modify elements by side effect. There is
347 ;; `org-element-put-property', `org-element-set-contents',
348 ;; `org-element-set-element' and `org-element-adopt-element'. Note
349 ;; that `org-element-set-element' and `org-element-adopt-elements' are
350 ;; higher level functions since also update `:parent' property.
353 "Return type of ELEMENT.
355 The function returns the type of the element or object provided.
356 It can also return the following special value:
357 `plain-text' for a string
358 `org-data' for a complete document
359 nil in any other case."
365 "Extract the value from the PROPERTY of an ELEMENT."
369 "Extract contents from an ELEMENT."
373 "Return restriction associated to ELEMENT.
374 ELEMENT can be an element, an object or a symbol representing an
375 element or object type."
377 org-element-object-restrictions)))
380 "In ELEMENT set PROPERTY to VALUE.
381 Return modified element."
384 element)
387 "Set ELEMENT contents to CONTENTS.
388 Return modified element."
394 "Replace element or object OLD with element or object NEW.
395 The function takes care of setting `:parent' property for NEW."
396 ;; Since OLD is going to be changed into NEW by side-effect, first
397 ;; make sure that every element or object within NEW has OLD as
398 ;; parent.
401 ;; Transfer contents.
403 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
404 ;; with NEW's.
407 ;; Transfer type.
411 "Append elements to the contents of another element.
413 PARENT is an element or object. CHILDREN can be elements,
414 objects, or a strings.
416 The function takes care of setting `:parent' property for CHILD.
417 Return parent element."
419 ;; Link every child to PARENT.
423 children)
424 ;; Add CHILDREN at the end of PARENT contents.
426 parent
428 ;; Return modified PARENT element.
429 parent))
432 \f
433 ;;; Greater elements
434 ;;
435 ;; For each greater element type, we define a parser and an
436 ;; interpreter.
437 ;;
438 ;; A parser returns the element or object as the list described above.
439 ;; Most of them accepts no argument. Though, exceptions exist. Hence
440 ;; every element containing a secondary string (see
441 ;; `org-element-secondary-value-alist') will accept an optional
442 ;; argument to toggle parsing of that secondary string. Moreover,
443 ;; `item' parser requires current list's structure as its first
444 ;; element.
445 ;;
446 ;; An interpreter accepts two arguments: the list representation of
447 ;; the element or object, and its contents. The latter may be nil,
448 ;; depending on the element or object considered. It returns the
449 ;; appropriate Org syntax, as a string.
450 ;;
451 ;; Parsing functions must follow the naming convention:
452 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
453 ;; defined in `org-element-greater-elements'.
454 ;;
455 ;; Similarly, interpreting functions must follow the naming
456 ;; convention: org-element-TYPE-interpreter.
457 ;;
458 ;; With the exception of `headline' and `item' types, greater elements
459 ;; cannot contain other greater elements of their own type.
460 ;;
461 ;; Beside implementing a parser and an interpreter, adding a new
462 ;; greater element requires to tweak `org-element--current-element'.
463 ;; Moreover, the newly defined type must be added to both
464 ;; `org-element-all-elements' and `org-element-greater-elements'.
467 ;;;; Center Block
470 "Parse a center block.
472 LIMIT bounds the search.
474 Return a list whose CAR is `center-block' and CDR is a plist
475 containing `:begin', `:end', `:hiddenp', `:contents-begin',
476 `:contents-end' and `:post-blank' keywords.
478 Assume point is at the beginning of the block."
482 ;; Incomplete block: parse it as a paragraph.
487 ;; Empty blocks have no contents.
502 :end end
503 :hiddenp hidden
504 :contents-begin contents-begin
505 :contents-end contents-end
510 "Interpret CENTER-BLOCK element as Org syntax.
511 CONTENTS is the contents of the element."
515 ;;;; Drawer
518 "Parse a drawer.
520 LIMIT bounds the search.
522 Return a list whose CAR is `drawer' and CDR is a plist containing
523 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
524 `:contents-end' and `:post-blank' keywords.
526 Assume point is at beginning of drawer."
529 ;; Incomplete drawer: parse it as a paragraph.
538 ;; Empty drawers have no contents.
553 :end end
554 :drawer-name name
555 :hiddenp hidden
556 :contents-begin contents-begin
557 :contents-end contents-end
562 "Interpret DRAWER element as Org syntax.
563 CONTENTS is the contents of the element."
566 contents))
569 ;;;; Dynamic Block
572 "Parse a dynamic block.
574 LIMIT bounds the search.
576 Return a list whose CAR is `dynamic-block' and CDR is a plist
577 containing `:block-name', `:begin', `:end', `:hiddenp',
578 `:contents-begin', `:contents-end', `:arguments' and
579 `:post-blank' keywords.
581 Assume point is at beginning of dynamic block."
585 ;; Incomplete block: parse it as a paragraph.
594 ;; Empty blocks have no contents.
609 :end end
610 :block-name name
611 :arguments arguments
612 :hiddenp hidden
613 :contents-begin contents-begin
614 :contents-end contents-end
619 "Interpret DYNAMIC-BLOCK element as Org syntax.
620 CONTENTS is the contents of the element."
625 contents))
628 ;;;; Footnote Definition
631 "Parse a footnote definition.
633 LIMIT bounds the search.
635 Return a list whose CAR is `footnote-definition' and CDR is
636 a plist containing `:label', `:begin' `:end', `:contents-begin',
637 `:contents-end' and `:post-blank' keywords.
639 Assume point is at the beginning of the footnote definition."
665 :begin begin
666 :end end
667 :contents-begin contents-begin
668 :contents-end contents-end
673 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
674 CONTENTS is the contents of the footnote-definition."
676 " "
677 contents))
680 ;;;; Headline
683 "Parse an headline.
685 Return a list whose CAR is `headline' and CDR is a plist
686 containing `:raw-value', `:title', `:begin', `:end',
687 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
688 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
689 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
690 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
691 keywords.
693 The plist also contains any property set in the property drawer,
694 with its name in lowercase, the underscores replaced with hyphens
695 and colons at the beginning (i.e. `:custom-id').
697 When RAW-SECONDARY-P is non-nil, headline's title will not be
698 parsed as a secondary string, but as a plain string instead.
700 Assume point is at beginning of the headline."
713 raw-value)))
717 raw-value)))
721 ;; Normalize property names: ":SOME_PROP:" becomes
722 ;; ":some-prop".
734 plist))
752 ;; Clean RAW-VALUE from any quote or comment string.
760 ""
761 raw-value))))
762 ;; Clean TAGS from archive tag, if any.
768 :begin begin
769 :end end
770 :pre-blank
773 :hiddenp hidden
774 :contents-begin contents-begin
775 :contents-end contents-end
776 :level level
778 :tags tags
779 :todo-keyword todo
780 :todo-type todo-type
781 :scheduled scheduled
782 :deadline deadline
783 :timestamp timestamp
784 :clock clock
790 end)
791 :footnote-section-p footnote-section-p
792 :archivedp archivedp
793 :commentedp commentedp
795 standard-props))))
797 headline :title
803 "Interpret HEADLINE element as Org syntax.
804 CONTENTS is the contents of the element."
831 ;; Align tags.
839 ? )
840 tags))
844 tags))))
846 contents)))
849 ;;;; Inlinetask
852 "Parse an inline task.
854 Return a list whose CAR is `inlinetask' and CDR is a plist
855 containing `:title', `:begin', `:end', `:hiddenp',
856 `:contents-begin' and `:contents-end', `:level', `:priority',
857 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
858 `:scheduled', `:deadline', `:timestamp', `:clock' and
859 `:post-blank' keywords.
861 The plist also contains any property set in the property drawer,
862 with its name in lowercase, the underscores replaced with hyphens
863 and colons at the beginning (i.e. `:custom-id').
865 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
866 title will not be parsed as a secondary string, but as a plain
867 string instead.
869 Assume point is at beginning of the inline task."
880 ;; Normalize property names: ":SOME_PROP:" becomes
881 ;; ":some-prop".
893 plist))
918 :begin begin
919 :end end
920 :hiddenp hidden
921 :contents-begin contents-begin
922 :contents-end contents-end
925 :tags tags
926 :todo-keyword todo
927 :todo-type todo-type
928 :scheduled scheduled
929 :deadline deadline
930 :timestamp timestamp
931 :clock clock
933 standard-props
936 inlinetask :title
939 raw-value
941 inlinetask))))))
944 "Interpret INLINETASK element as Org syntax.
945 CONTENTS is the contents of inlinetask."
960 ;; Align tags.
968 ? )
969 tags))
973 tags))))
974 ;; Prefer degenerate inlinetasks when there are no
975 ;; contents.
978 contents
982 ;;;; Item
985 "Parse an item.
987 STRUCT is the structure of the plain list.
989 Return a list whose CAR is `item' and CDR is a plist containing
990 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
991 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
992 `:post-blank' keywords.
994 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
995 any, will not be parsed as a secondary string, but as a plain
996 string instead.
998 Assume point is at the beginning of the item."
1022 ;; Ignore tags in un-ordered lists: they are just
1023 ;; a part of item's body.
1029 ;; If first line isn't empty, contents really start
1030 ;; at the text after item's meta-data.
1041 :begin begin
1042 :end end
1043 ;; CONTENTS-BEGIN and CONTENTS-END may be
1044 ;; mixed up in the case of an empty item
1045 ;; separated from the next by a blank line.
1046 ;; Thus ensure the former is always the
1047 ;; smallest.
1050 :checkbox checkbox
1051 :counter counter
1052 :hiddenp hidden
1053 :structure struct
1056 item :tag
1064 "Interpret ITEM element as Org syntax.
1065 CONTENTS is the contents of the element."
1071 ;; Compute indentation.
1076 ;; Indent contents.
1078 bullet
1091 ;;;; Plain List
1094 "Parse a plain list.
1096 Optional argument STRUCTURE, when non-nil, is the structure of
1097 the plain list being parsed.
1099 Return a list whose CAR is `plain-list' and CDR is a plist
1100 containing `:type', `:begin', `:end', `:contents-begin' and
1101 `:contents-end', `:structure' and `:post-blank' keywords.
1103 Assume point is at the beginning of the list."
1119 ;; Return value.
1123 :begin begin
1124 :end end
1125 :contents-begin contents-begin
1126 :contents-end contents-end
1127 :structure struct
1132 "Interpret PLAIN-LIST element as Org syntax.
1133 CONTENTS is the contents of the element."
1141 ;;;; Quote Block
1144 "Parse a quote block.
1146 LIMIT bounds the search.
1148 Return a list whose CAR is `quote-block' and CDR is a plist
1149 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1150 `:contents-end' and `:post-blank' keywords.
1152 Assume point is at the beginning of the block."
1156 ;; Incomplete block: parse it as a paragraph.
1162 ;; Empty blocks have no contents.
1177 :end end
1178 :hiddenp hidden
1179 :contents-begin contents-begin
1180 :contents-end contents-end
1185 "Interpret QUOTE-BLOCK element as Org syntax.
1186 CONTENTS is the contents of the element."
1190 ;;;; Section
1193 "Parse a section.
1195 LIMIT bounds the search.
1197 Return a list whose CAR is `section' and CDR is a plist
1198 containing `:begin', `:end', `:contents-begin', `contents-end'
1199 and `:post-blank' keywords."
1201 ;; Beginning of section is the beginning of the first non-blank
1202 ;; line after previous headline.
1211 :end end
1212 :contents-begin begin
1213 :contents-end pos-before-blank
1217 "Interpret SECTION element as Org syntax.
1218 CONTENTS is the contents of the element."
1219 contents)
1222 ;;;; Special Block
1225 "Parse a special block.
1227 LIMIT bounds the search.
1229 Return a list whose CAR is `special-block' and CDR is a plist
1230 containing `:type', `:begin', `:end', `:hiddenp',
1231 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1233 Assume point is at the beginning of the block."
1240 ;; Incomplete block: parse it as a paragraph.
1246 ;; Empty blocks have no contents.
1261 :begin begin
1262 :end end
1263 :hiddenp hidden
1264 :contents-begin contents-begin
1265 :contents-end contents-end
1270 "Interpret SPECIAL-BLOCK element as Org syntax.
1271 CONTENTS is the contents of the element."
1276 \f
1277 ;;; Elements
1278 ;;
1279 ;; For each element, a parser and an interpreter are also defined.
1280 ;; Both follow the same naming convention used for greater elements.
1281 ;;
1282 ;; Also, as for greater elements, adding a new element type is done
1283 ;; through the following steps: implement a parser and an interpreter,
1284 ;; tweak `org-element--current-element' so that it recognizes the new
1285 ;; type and add that new type to `org-element-all-elements'.
1286 ;;
1287 ;; As a special case, when the newly defined type is a block type,
1288 ;; `org-element-block-name-alist' has to be modified accordingly.
1291 ;;;; Babel Call
1294 "Parse a babel call.
1296 LIMIT bounds the search.
1298 Return a list whose CAR is `babel-call' and CDR is a plist
1299 containing `:begin', `:end', `:info' and `:post-blank' as
1300 keywords."
1312 :end end
1313 :info info
1317 "Interpret BABEL-CALL element as Org syntax.
1318 CONTENTS is nil."
1324 ;; Remove redundant square brackets.
1329 ;;;; Clock
1332 "Parse a clock.
1334 LIMIT bounds the search.
1336 Return a list whose CAR is `clock' and CDR is a plist containing
1337 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1338 as keywords."
1358 :value value
1359 :time time
1360 :begin begin
1361 :end end
1365 "Interpret CLOCK element as Org syntax.
1366 CONTENTS is nil."
1373 "%2s:%02s"
1377 ;;;; Comment
1380 "Parse a comment.
1382 LIMIT bounds the search.
1384 Return a list whose CAR is `comment' and CDR is a plist
1385 containing `:begin', `:end', `:value' and `:post-blank'
1386 keywords.
1388 Assume point is at comment beginning."
1397 ;; Get comments ending.
1400 ;; Accumulate lines without leading hash and first
1401 ;; whitespace.
1416 :end end
1417 :value value
1422 "Interpret COMMENT element as Org syntax.
1423 CONTENTS is nil."
1427 ;;;; Comment Block
1430 "Parse an export block.
1432 LIMIT bounds the search.
1434 Return a list whose CAR is `comment-block' and CDR is a plist
1435 containing `:begin', `:end', `:hiddenp', `:value' and
1436 `:post-blank' keywords.
1438 Assume point is at comment block beginning."
1442 ;; Incomplete block: parse it as a paragraph.
1457 contents-begin contents-end)))
1461 :end end
1462 :value value
1463 :hiddenp hidden
1468 "Interpret COMMENT-BLOCK element as Org syntax.
1469 CONTENTS is nil."
1474 ;;;; Example Block
1477 "Parse an example block.
1479 LIMIT bounds the search.
1481 Return a list whose CAR is `example-block' and CDR is a plist
1482 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1483 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1484 `:switches', `:value' and `:post-blank' keywords."
1488 ;; Incomplete block: parse it as a paragraph.
1495 ;; Switches analysis
1500 ;; Should labels be retained in (or stripped from) example
1501 ;; blocks?
1506 ;; What should code-references use - labels or
1507 ;; line-numbers?
1514 ;; Standard block parsing.
1521 contents-begin contents-end)))
1531 :end end
1532 :value value
1533 :switches switches
1534 :number-lines number-lines
1535 :preserve-indent preserve-indent
1536 :retain-labels retain-labels
1537 :use-labels use-labels
1538 :label-fmt label-fmt
1539 :hiddenp hidden
1544 "Interpret EXAMPLE-BLOCK element as Org syntax.
1545 CONTENTS is nil."
1554 ;;;; Export Block
1557 "Parse an export block.
1559 LIMIT bounds the search.
1561 Return a list whose CAR is `export-block' and CDR is a plist
1562 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1563 `:post-blank' keywords.
1565 Assume point is at export-block beginning."
1572 ;; Incomplete block: parse it as a paragraph.
1587 contents-end)))
1591 :end end
1592 :type type
1593 :value value
1594 :hiddenp hidden
1599 "Interpret EXPORT-BLOCK element as Org syntax.
1600 CONTENTS is nil."
1607 ;;;; Fixed-width
1610 "Parse a fixed-width section.
1612 LIMIT bounds the search.
1614 Return a list whose CAR is `fixed-width' and CDR is a plist
1615 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1617 Assume point is at the beginning of the fixed-width area."
1621 value
1626 ;; Accumulate text without starting colons.
1640 :end end
1641 :value value
1646 "Interpret FIXED-WIDTH element as Org syntax.
1647 CONTENTS is nil."
1652 ;;;; Horizontal Rule
1655 "Parse an horizontal rule.
1657 LIMIT bounds the search.
1659 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1660 containing `:begin', `:end' and `:post-blank' keywords."
1671 :end end
1676 "Interpret HORIZONTAL-RULE element as Org syntax.
1677 CONTENTS is nil."
1681 ;;;; Keyword
1684 "Parse a keyword at point.
1686 LIMIT bounds the search.
1688 Return a list whose CAR is `keyword' and CDR is a plist
1689 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1690 keywords."
1704 :value value
1705 :begin begin
1706 :end end
1710 "Interpret KEYWORD element as Org syntax.
1711 CONTENTS is nil."
1717 ;;;; Latex Environment
1720 "Parse a LaTeX environment.
1722 LIMIT bounds the search.
1724 Return a list whose CAR is `latex-environment' and CDR is a plist
1725 containing `:begin', `:end', `:value' and `:post-blank'
1726 keywords.
1728 Assume point is at the beginning of the latex environment."
1748 :end end
1749 :value value
1754 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1755 CONTENTS is nil."
1759 ;;;; Paragraph
1762 "Parse a paragraph.
1764 LIMIT bounds the search.
1766 Return a list whose CAR is `paragraph' and CDR is a plist
1767 containing `:begin', `:end', `:contents-begin' and
1768 `:contents-end' and `:post-blank' keywords.
1770 Assume point is at the beginning of the paragraph."
1773 ;; INNER-PAR-P is non-nil when paragraph is at the
1774 ;; beginning of an item or a footnote reference. In that
1775 ;; case, we mustn't look for affiliated keywords since they
1776 ;; belong to the container.
1786 limit
1787 ;; A matching `org-element-paragraph-separate' is not
1788 ;; necessarily the end of the paragraph. In
1789 ;; particular, lines starting with # or : as a first
1790 ;; non-space character are ambiguous. We have check
1791 ;; if they are valid Org syntax (i.e. not an
1792 ;; incomplete keyword).
1796 ;; There's no ambiguity for other symbols or
1797 ;; empty lines: stop here.
1799 ;; Stop at valid fixed-width areas.
1801 ;; Stop at drawers.
1806 ;; Stop at valid comments.
1808 ;; Stop at valid dynamic blocks.
1813 ;; Stop at valid blocks.
1820 limit t)))
1821 ;; Stop at valid latex environments.
1828 limit t)))
1829 ;; Stop at valid keywords.
1831 ;; Skip everything else.
1849 :end end
1850 :contents-begin contents-begin
1851 :contents-end contents-end
1856 "Interpret PARAGRAPH element as Org syntax.
1857 CONTENTS is the contents of the element."
1858 contents)
1861 ;;;; Planning
1864 "Parse a planning.
1866 LIMIT bounds the search.
1868 Return a list whose CAR is `planning' and CDR is a plist
1869 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1870 and `:post-blank' keywords."
1880 closed deadline scheduled)
1894 :deadline deadline
1895 :scheduled scheduled
1896 :begin begin
1897 :end end
1901 "Interpret PLANNING element as Org syntax.
1902 CONTENTS is nil."
1904 'identity
1916 ;;;; Property Drawer
1919 "Parse a property drawer.
1921 LIMIT bounds the search.
1923 Return a list whose CAR is `property-drawer' and CDR is a plist
1924 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1925 `:contents-end', `:properties' and `:post-blank' keywords.
1927 Assume point is at the beginning of the property drawer."
1941 val))
1943 val))
1952 :end end
1953 :hiddenp hidden
1954 :properties properties
1958 "Interpret PROPERTY-DRAWER element as Org syntax.
1959 CONTENTS is nil."
1969 ;;;; Quote Section
1972 "Parse a quote section.
1974 LIMIT bounds the search.
1976 Return a list whose CAR is `quote-section' and CDR is a plist
1977 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1979 Assume point is at beginning of the section."
1990 :end end
1991 :value value
1995 "Interpret QUOTE-SECTION element as Org syntax.
1996 CONTENTS is nil."
2000 ;;;; Src Block
2003 "Parse a src block.
2005 LIMIT bounds the search.
2007 Return a list whose CAR is `src-block' and CDR is a plist
2008 containing `:language', `:switches', `:parameters', `:begin',
2009 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2010 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2011 `:post-blank' keywords.
2013 Assume point is at the beginning of the block."
2016 limit t)))
2017 ;; Incomplete block: parse it as a paragraph.
2022 ;; Get beginning position.
2024 ;; Get language as a string.
2033 ;; Get switches.
2035 ;; Get parameters.
2037 ;; Switches analysis
2045 ;; Should labels be retained in (or stripped from)
2046 ;; src blocks?
2051 ;; What should code-references use - labels or
2052 ;; line-numbers?
2056 ;; Get visibility status.
2058 ;; Retrieve code.
2064 ;; Get position after ending blank lines.
2075 :begin begin
2076 :end end
2077 :number-lines number-lines
2078 :preserve-indent preserve-indent
2079 :retain-labels retain-labels
2080 :use-labels use-labels
2081 :label-fmt label-fmt
2082 :hiddenp hidden
2083 :value value
2088 "Interpret SRC-BLOCK element as Org syntax.
2089 CONTENTS is nil."
2112 ;;;; Table
2115 "Parse a table at point.
2117 LIMIT bounds the search.
2119 Return a list whose CAR is `table' and CDR is a plist containing
2120 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2121 `:contents-end', `:value' and `:post-blank' keywords.
2123 Assume point is at the beginning of the table."
2138 acc))
2146 :end end
2147 :type type
2148 :tblfm tblfm
2149 ;; Only `org' tables have contents. `table.el' tables
2150 ;; use a `:value' property to store raw table as
2151 ;; a string.
2156 table-begin table-end))
2161 "Interpret TABLE element as Org syntax.
2162 CONTENTS is nil."
2173 ;;;; Table Row
2176 "Parse table row at point.
2178 LIMIT bounds the search.
2180 Return a list whose CAR is `table-row' and CDR is a plist
2181 containing `:begin', `:end', `:contents-begin', `:contents-end',
2182 `:type' and `:post-blank' keywords."
2186 ;; A table rule has no contents. In that case, ensure
2187 ;; CONTENTS-BEGIN matches CONTENTS-END.
2199 :begin begin
2200 :end end
2201 :contents-begin contents-begin
2202 :contents-end contents-end
2206 "Interpret TABLE-ROW element as Org syntax.
2207 CONTENTS is the contents of the table row."
2212 ;;;; Verse Block
2215 "Parse a verse block.
2217 LIMIT bounds the search.
2219 Return a list whose CAR is `verse-block' and CDR is a plist
2220 containing `:begin', `:end', `:contents-begin', `:contents-end',
2221 `:hiddenp' and `:post-blank' keywords.
2223 Assume point is at beginning of the block."
2227 ;; Incomplete block: parse it as a paragraph.
2244 :end end
2245 :contents-begin contents-begin
2246 :contents-end contents-end
2247 :hiddenp hidden
2252 "Interpret VERSE-BLOCK element as Org syntax.
2253 CONTENTS is verse block contents."
2257 \f
2258 ;;; Objects
2259 ;;
2260 ;; Unlike to elements, interstices can be found between objects.
2261 ;; That's why, along with the parser, successor functions are provided
2262 ;; for each object. Some objects share the same successor (i.e. `code'
2263 ;; and `verbatim' objects).
2264 ;;
2265 ;; A successor must accept a single argument bounding the search. It
2266 ;; will return either a cons cell whose CAR is the object's type, as
2267 ;; a symbol, and CDR the position of its next occurrence, or nil.
2268 ;;
2269 ;; Successors follow the naming convention:
2270 ;; org-element-NAME-successor, where NAME is the name of the
2271 ;; successor, as defined in `org-element-all-successors'.
2272 ;;
2273 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2274 ;; object types they can contain will be specified in
2275 ;; `org-element-object-restrictions'.
2276 ;;
2277 ;; Adding a new type of object is simple. Implement a successor,
2278 ;; a parser, and an interpreter for it, all following the naming
2279 ;; convention. Register type in `org-element-all-objects' and
2280 ;; successor in `org-element-all-successors'. Maybe tweak
2281 ;; restrictions about it, and that's it.
2284 ;;;; Bold
2287 "Parse bold object at point.
2289 Return a list whose CAR is `bold' and CDR is a plist with
2290 `:begin', `:end', `:contents-begin' and `:contents-end' and
2291 `:post-blank' keywords.
2293 Assume point is at the first star marker."
2305 :end end
2306 :contents-begin contents-begin
2307 :contents-end contents-end
2311 "Interpret BOLD object as Org syntax.
2312 CONTENTS is the contents of the object."
2316 "Search for the next text-markup object.
2318 LIMIT bounds the search.
2320 Return value is a cons cell whose CAR is a symbol among `bold',
2321 `italic', `underline', `strike-through', `code' and `verbatim'
2322 and CDR is beginning position."
2338 ;;;; Code
2341 "Parse code object at point.
2343 Return a list whose CAR is `code' and CDR is a plist with
2344 `:value', `:begin', `:end' and `:post-blank' keywords.
2346 Assume point is at the first tilde marker."
2357 :begin begin
2358 :end end
2362 "Interpret CODE object as Org syntax.
2363 CONTENTS is nil."
2367 ;;;; Entity
2370 "Parse entity at point.
2372 Return a list whose CAR is `entity' and CDR a plist with
2373 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2374 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2375 keywords.
2377 Assume point is at the beginning of the entity."
2379 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2395 :begin begin
2396 :end end
2397 :use-brackets-p bracketsp
2401 "Interpret ENTITY object as Org syntax.
2402 CONTENTS is nil."
2408 "Search for the next latex-fragment or entity object.
2410 LIMIT bounds the search.
2412 Return value is a cons cell whose CAR is `entity' or
2413 `latex-fragment' and CDR is beginning position."
2418 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2425 limit t)
2428 ;; Determine if it's a real entity or a LaTeX command.
2431 ;; No entity nor command: point is at a LaTeX fragment.
2432 ;; Determine its type to get the correct beginning position.
2440 matchers)
2444 ;;;; Export Snippet
2447 "Parse export snippet at point.
2449 Return a list whose CAR is `export-snippet' and CDR a plist with
2450 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2451 keywords.
2453 Assume point is at the beginning of the snippet."
2465 :value value
2466 :begin begin
2467 :end end
2471 "Interpret EXPORT-SNIPPET object as Org syntax.
2472 CONTENTS is nil."
2478 "Search for the next export-snippet object.
2480 LIMIT bounds the search.
2482 Return value is a cons cell whose CAR is `export-snippet' and CDR
2483 its beginning position."
2492 ;;;; Footnote Reference
2495 "Parse footnote reference at point.
2497 Return a list whose CAR is `footnote-reference' and CDR a plist
2498 with `:label', `:type', `:inline-definition', `:begin', `:end'
2499 and `:post-blank' as keywords."
2521 :type type
2522 :begin begin
2523 :end end
2526 footnote-reference :inline-definition
2531 footnote-reference))))))
2534 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2535 CONTENTS is nil."
2545 "Search for the next footnote-reference object.
2547 LIMIT bounds the search.
2549 Return value is a cons cell whose CAR is `footnote-reference' and
2550 CDR is beginning position."
2564 ;;;; Inline Babel Call
2567 "Parse inline babel call at point.
2569 Return a list whose CAR is `inline-babel-call' and CDR a plist
2570 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2572 Assume point is at the beginning of the babel call."
2583 :end end
2584 :info info
2588 "Interpret INLINE-BABEL-CALL object as Org syntax.
2589 CONTENTS is nil."
2595 ;; Remove redundant square brackets.
2598 main-source)
2602 "Search for the next inline-babel-call object.
2604 LIMIT bounds the search.
2606 Return value is a cons cell whose CAR is `inline-babel-call' and
2607 CDR is beginning position."
2609 ;; Use a simplified version of
2610 ;; `org-babel-inline-lob-one-liner-regexp'.
2613 limit t)
2617 ;;;; Inline Src Block
2620 "Parse inline source block at point.
2622 LIMIT bounds the search.
2624 Return a list whose CAR is `inline-src-block' and CDR a plist
2625 with `:begin', `:end', `:language', `:value', `:parameters' and
2626 `:post-blank' as keywords.
2628 Assume point is at the beginning of the inline src block."
2641 :value value
2642 :parameters parameters
2643 :begin begin
2644 :end end
2648 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2649 CONTENTS is nil."
2654 language
2656 body)))
2659 "Search for the next inline-babel-call element.
2661 LIMIT bounds the search.
2663 Return value is a cons cell whose CAR is `inline-babel-call' and
2664 CDR is beginning position."
2670 ;;;; Italic
2673 "Parse italic object at point.
2675 Return a list whose CAR is `italic' and CDR is a plist with
2676 `:begin', `:end', `:contents-begin' and `:contents-end' and
2677 `:post-blank' keywords.
2679 Assume point is at the first slash marker."
2691 :end end
2692 :contents-begin contents-begin
2693 :contents-end contents-end
2697 "Interpret ITALIC object as Org syntax.
2698 CONTENTS is the contents of the object."
2702 ;;;; Latex Fragment
2705 "Parse latex fragment at point.
2707 Return a list whose CAR is `latex-fragment' and CDR a plist with
2708 `:value', `:begin', `:end', and `:post-blank' as keywords.
2710 Assume point is at the beginning of the latex fragment."
2724 ;; None found: it's a macro.
2733 :begin begin
2734 :end end
2738 "Interpret LATEX-FRAGMENT object as Org syntax.
2739 CONTENTS is nil."
2742 ;;;; Line Break
2745 "Parse line break at point.
2747 Return a list whose CAR is `line-break', and CDR a plist with
2748 `:begin', `:end' and `:post-blank' keywords.
2750 Assume point is at the beginning of the line break."
2754 "Interpret LINE-BREAK object as Org syntax.
2755 CONTENTS is nil."
2759 "Search for the next line-break object.
2761 LIMIT bounds the search.
2763 Return value is a cons cell whose CAR is `line-break' and CDR is
2764 beginning position."
2768 ;; A line break can only happen on a non-empty line.
2773 ;;;; Link
2776 "Parse link at point.
2778 Return a list whose CAR is `link' and CDR a plist with `:type',
2779 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2780 `:contents-end' and `:post-blank' as keywords.
2782 Assume point is at the beginning of the link."
2785 end contents-begin contents-end link-end post-blank path type
2786 raw-link link)
2788 ;; Type 1: Text targeted from a radio target.
2793 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2798 ;; RAW-LINK is the original link.
2803 ;; Determine TYPE of link and set PATH accordingly.
2805 ;; File type.
2808 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2811 ;; Id type: PATH is the id.
2814 ;; Code-ref type: PATH is the name of the reference.
2817 ;; Custom-id type: PATH is the name of the custom id.
2820 ;; Fuzzy type: Internal link either matches a target, an
2821 ;; headline name or nothing. PATH is the target or
2822 ;; headline's name.
2824 ;; Type 3: Plain link, i.e. http://orgmode.org
2830 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2837 ;; In any case, deduce end point after trailing white space from
2838 ;; LINK-END variable.
2843 :path path
2845 :begin begin
2846 :end end
2847 :contents-begin contents-begin
2848 :contents-end contents-end
2852 "Interpret LINK object as Org syntax.
2853 CONTENTS is the contents of the object, or nil."
2858 raw-link
2862 "Search for the next link object.
2864 LIMIT bounds the search.
2866 Return value is a cons cell whose CAR is `link' and CDR is
2867 beginning position."
2876 ;;;; Macro
2879 "Parse macro at point.
2881 Return a list whose CAR is `macro' and CDR a plist with `:key',
2882 `:args', `:begin', `:end', `:value' and `:post-blank' as
2883 keywords.
2885 Assume point is at the macro."
2899 ;; Repair bad splits.
2907 :value value
2908 :args args
2909 :begin begin
2910 :end end
2914 "Interpret MACRO object as Org syntax.
2915 CONTENTS is nil."
2919 "Search for the next macro object.
2921 LIMIT bounds the search.
2923 Return value is cons cell whose CAR is `macro' and CDR is
2924 beginning position."
2928 limit t)
2932 ;;;; Radio-target
2935 "Parse radio target at point.
2937 Return a list whose CAR is `radio-target' and CDR a plist with
2938 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2939 and `:post-blank' as keywords.
2941 Assume point is at the radio target."
2953 :end end
2954 :contents-begin contents-begin
2955 :contents-end contents-end
2956 :post-blank post-blank
2960 "Interpret TARGET object as Org syntax.
2961 CONTENTS is the contents of the object."
2965 "Search for the next radio-target object.
2967 LIMIT bounds the search.
2969 Return value is a cons cell whose CAR is `radio-target' and CDR
2970 is beginning position."
2976 ;;;; Statistics Cookie
2979 "Parse statistics cookie at point.
2981 Return a list whose CAR is `statistics-cookie', and CDR a plist
2982 with `:begin', `:end', `:value' and `:post-blank' keywords.
2984 Assume point is at the beginning of the statistics-cookie."
2995 :end end
2996 :value value
3000 "Interpret STATISTICS-COOKIE object as Org syntax.
3001 CONTENTS is nil."
3005 "Search for the next statistics cookie object.
3007 LIMIT bounds the search.
3009 Return value is a cons cell whose CAR is `statistics-cookie' and
3010 CDR is beginning position."
3016 ;;;; Strike-Through
3019 "Parse strike-through object at point.
3021 Return a list whose CAR is `strike-through' and CDR is a plist
3022 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3023 `:post-blank' keywords.
3025 Assume point is at the first plus sign marker."
3037 :end end
3038 :contents-begin contents-begin
3039 :contents-end contents-end
3043 "Interpret STRIKE-THROUGH object as Org syntax.
3044 CONTENTS is the contents of the object."
3048 ;;;; Subscript
3051 "Parse subscript at point.
3053 Return a list whose CAR is `subscript' and CDR a plist with
3054 `:begin', `:end', `:contents-begin', `:contents-end',
3055 `:use-brackets-p' and `:post-blank' as keywords.
3057 Assume point is at the underscore."
3061 t
3072 :end end
3073 :use-brackets-p bracketsp
3074 :contents-begin contents-begin
3075 :contents-end contents-end
3079 "Interpret SUBSCRIPT object as Org syntax.
3080 CONTENTS is the contents of the object."
3083 contents))
3086 "Search for the next sub/superscript object.
3088 LIMIT bounds the search.
3090 Return value is a cons cell whose CAR is either `subscript' or
3091 `superscript' and CDR is beginning position."
3099 ;;;; Superscript
3102 "Parse superscript at point.
3104 Return a list whose CAR is `superscript' and CDR a plist with
3105 `:begin', `:end', `:contents-begin', `:contents-end',
3106 `:use-brackets-p' and `:post-blank' as keywords.
3108 Assume point is at the caret."
3122 :end end
3123 :use-brackets-p bracketsp
3124 :contents-begin contents-begin
3125 :contents-end contents-end
3129 "Interpret SUPERSCRIPT object as Org syntax.
3130 CONTENTS is the contents of the object."
3133 contents))
3136 ;;;; Table Cell
3139 "Parse table cell at point.
3141 Return a list whose CAR is `table-cell' and CDR is a plist
3142 containing `:begin', `:end', `:contents-begin', `:contents-end'
3143 and `:post-blank' keywords."
3151 :end end
3152 :contents-begin contents-begin
3153 :contents-end contents-end
3157 "Interpret TABLE-CELL element as Org syntax.
3158 CONTENTS is the contents of the cell, or nil."
3162 "Search for the next table-cell object.
3164 LIMIT bounds the search.
3166 Return value is a cons cell whose CAR is `table-cell' and CDR is
3167 beginning position."
3171 ;;;; Target
3174 "Parse target at point.
3176 Return a list whose CAR is `target' and CDR a plist with
3177 `:begin', `:end', `:value' and `:post-blank' as keywords.
3179 Assume point is at the target."
3189 :end end
3190 :value value
3194 "Interpret TARGET object as Org syntax.
3195 CONTENTS is nil."
3199 "Search for the next target object.
3201 LIMIT bounds the search.
3203 Return value is a cons cell whose CAR is `target' and CDR is
3204 beginning position."
3210 ;;;; Timestamp
3213 "Parse time stamp at point.
3215 Return a list whose CAR is `timestamp', and CDR a plist with
3216 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3218 Assume point is at the beginning of the timestamp."
3237 :value main-value
3238 :range-end range-end
3239 :begin begin
3240 :end end
3244 "Interpret TIMESTAMP object as Org syntax.
3245 CONTENTS is nil."
3254 range-end)))))))
3257 "Search for the next timestamp object.
3259 LIMIT bounds the search.
3261 Return value is a cons cell whose CAR is `timestamp' and CDR is
3262 beginning position."
3270 limit t)
3274 ;;;; Underline
3277 "Parse underline object at point.
3279 Return a list whose CAR is `underline' and CDR is a plist with
3280 `:begin', `:end', `:contents-begin' and `:contents-end' and
3281 `:post-blank' keywords.
3283 Assume point is at the first underscore marker."
3295 :end end
3296 :contents-begin contents-begin
3297 :contents-end contents-end
3301 "Interpret UNDERLINE object as Org syntax.
3302 CONTENTS is the contents of the object."
3306 ;;;; Verbatim
3309 "Parse verbatim object at point.
3311 Return a list whose CAR is `verbatim' and CDR is a plist with
3312 `:value', `:begin', `:end' and `:post-blank' keywords.
3314 Assume point is at the first equal sign marker."
3325 :begin begin
3326 :end end
3330 "Interpret VERBATIM object as Org syntax.
3331 CONTENTS is nil."
3335 \f
3336 ;;; Parsing Element Starting At Point
3337 ;;
3338 ;; `org-element--current-element' is the core function of this section.
3339 ;; It returns the Lisp representation of the element starting at
3340 ;; point.
3341 ;;
3342 ;; `org-element--current-element' makes use of special modes. They
3343 ;; are activated for fixed element chaining (i.e. `plain-list' >
3344 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3345 ;; `section'). Special modes are: `first-section', `section',
3346 ;; `quote-section', `item' and `table-row'.
3350 "Parse the element starting at point.
3352 LIMIT bounds the search.
3354 Return value is a list like (TYPE PROPS) where TYPE is the type
3355 of the element and PROPS a plist of properties associated to the
3356 element.
3358 Possible types are defined in `org-element-all-elements'.
3360 Optional argument GRANULARITY determines the depth of the
3361 recursion. Allowed values are `headline', `greater-element',
3362 `element', `object' or nil. When it is broader than `object' (or
3363 nil), secondary values will not be parsed, since they only
3364 contain objects.
3366 Optional argument SPECIAL, when non-nil, can be either
3367 `first-section', `section', `quote-section', `table-row' and
3368 `item'.
3370 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3371 be computed.
3373 This function assumes point is always at the beginning of the
3374 element it has to parse."
3376 ;; If point is at an affiliated keyword, try moving to the
3377 ;; beginning of the associated element. If none is found, the
3378 ;; keyword is orphaned and will be treated as plain text.
3384 ;; Determine if parsing depth allows for secondary strings
3385 ;; parsing. It only applies to elements referenced in
3386 ;; `org-element-secondary-value-alist'.
3389 ;; Item.
3392 ;; Table Row.
3394 ;; Headline.
3397 ;; Sections (must be checked after headline).
3403 limit)))
3404 ;; When not at bol, point is at the beginning of an item or
3405 ;; a footnote definition: next item is always a paragraph.
3407 ;; Planning and Clock.
3412 ;; Inlinetask.
3415 ;; LaTeX Environment.
3421 nil t))
3424 ;; Drawer and Property Drawer.
3434 ;; Fixed Width
3437 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3438 ;; Keywords.
3447 org-element-block-name-alist)))
3462 ;; Footnote Definition.
3465 ;; Horizontal Rule.
3468 ;; Table.
3470 ;; List.
3473 ;; Default element: Paragraph.
3477 ;; Most elements can have affiliated keywords. When looking for an
3478 ;; element beginning, we want to move before them, as they belong to
3479 ;; that element, and, in the meantime, collect information they give
3480 ;; into appropriate properties. Hence the following function.
3481 ;;
3482 ;; Usage of optional arguments may not be obvious at first glance:
3483 ;;
3484 ;; - TRANS-LIST is used to polish keywords names that have evolved
3485 ;; during Org history. In example, even though =result= and
3486 ;; =results= coexist, we want to have them under the same =result=
3487 ;; property. It's also true for "srcname" and "name", where the
3488 ;; latter seems to be preferred nowadays (thus the "name" property).
3489 ;;
3490 ;; - CONSED allows to regroup multi-lines keywords under the same
3491 ;; property, while preserving their own identity. This is mostly
3492 ;; used for "attr_latex" and al.
3493 ;;
3494 ;; - PARSED prepares a keyword value for export. This is useful for
3495 ;; "caption". Objects restrictions for such keywords are defined in
3496 ;; `org-element-object-restrictions'.
3497 ;;
3498 ;; - DUALS is used to take care of keywords accepting a main and an
3499 ;; optional secondary values. For example "results" has its
3500 ;; source's name as the main value, and may have an hash string in
3501 ;; optional square brackets as the secondary one.
3502 ;;
3503 ;; A keyword may belong to more than one category.
3507 "Collect affiliated keywords before point.
3509 Optional argument KEY-RE is a regexp matching keywords, which
3510 puts matched keyword in group 1. It defaults to
3511 `org-element--affiliated-re'.
3513 TRANS-LIST is an alist where key is the keyword and value the
3514 property name it should be translated to, without the colons. It
3515 defaults to `org-element-keyword-translation-alist'.
3517 CONSED is a list of strings. Any keyword belonging to that list
3518 will have its value consed. The check is done after keyword
3519 translation. It defaults to `org-element-multiple-keywords'.
3521 PARSED is a list of strings. Any keyword member of this list
3522 will have its value parsed. The check is done after keyword
3523 translation. If a keyword is a member of both CONSED and PARSED,
3524 it's value will be a list of parsed strings. It defaults to
3525 `org-element-parsed-keywords'.
3527 DUALS is a list of strings. Any keyword member of this list can
3528 have two parts: one mandatory and one optional. Its value is
3529 a cons cell whose CAR is the former, and the CDR the latter. If
3530 a keyword is a member of both PARSED and DUALS, both values will
3531 be parsed. It defaults to `org-element-dual-keywords'.
3533 Return a list whose CAR is the position at the first of them and
3534 CDR a plist of keywords and values."
3542 ;; RESTRICT is the list of objects allowed in parsed
3543 ;; keywords value.
3545 output)
3549 ;; Apply translation to RAW-KWD. From there, KWD is
3550 ;; the official keyword.
3552 ;; Find main value for any keyword.
3558 ;; If KWD is a dual keyword, find its secondary
3559 ;; value. Maybe parse it.
3565 ;; Attribute a property name to KWD.
3567 ;; Now set final shape for VALUE.
3571 ;; VALUE is mandatory. Set it to nil if there is none.
3573 ;; Attributes are always consed.
3576 ;; Eventually store the new value in OUTPUT.
3582 \f
3583 ;;; The Org Parser
3584 ;;
3585 ;; The two major functions here are `org-element-parse-buffer', which
3586 ;; parses Org syntax inside the current buffer, taking into account
3587 ;; region, narrowing, or even visibility if specified, and
3588 ;; `org-element-parse-secondary-string', which parses objects within
3589 ;; a given string.
3590 ;;
3591 ;; The (almost) almighty `org-element-map' allows to apply a function
3592 ;; on elements or objects matching some type, and accumulate the
3593 ;; resulting values. In an export situation, it also skips unneeded
3594 ;; parts of the parse tree.
3597 "Recursively parse the buffer and return structure.
3598 If narrowing is in effect, only parse the visible part of the
3599 buffer.
3601 Optional argument GRANULARITY determines the depth of the
3602 recursion. It can be set to the following symbols:
3604 `headline' Only parse headlines.
3605 `greater-element' Don't recurse into greater elements excepted
3606 headlines and sections. Thus, elements
3607 parsed are the top-level ones.
3608 `element' Parse everything but objects and plain text.
3609 `object' Parse the complete buffer (default).
3611 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3612 elements.
3614 An element or an objects is represented as a list with the
3615 pattern (TYPE PROPERTIES CONTENTS), where :
3617 TYPE is a symbol describing the element or object. See
3618 `org-element-all-elements' and `org-element-all-objects' for an
3619 exhaustive list of such symbols. One can retrieve it with
3620 `org-element-type' function.
3622 PROPERTIES is the list of attributes attached to the element or
3623 object, as a plist. Although most of them are specific to the
3624 element or object type, all types share `:begin', `:end',
3625 `:post-blank' and `:parent' properties, which respectively
3626 refer to buffer position where the element or object starts,
3627 ends, the number of white spaces or blank lines after it, and
3628 the element or object containing it. Properties values can be
3629 obtained by using `org-element-property' function.
3631 CONTENTS is a list of elements, objects or raw strings
3632 contained in the current element or object, when applicable.
3633 One can access them with `org-element-contents' function.
3635 The Org buffer has `org-data' as type and nil as properties.
3636 `org-element-map' function can be used to find specific elements
3637 or objects within the parse tree.
3639 This function assumes that current major mode is `org-mode'."
3645 ;; Start in `first-section' mode so text before the first
3646 ;; headline belongs to a section.
3650 "Recursively parse objects in STRING and return structure.
3652 RESTRICTION is a symbol limiting the object types that will be
3653 looked after.
3655 Optional argument PARENT, when non-nil, is the element or object
3656 containing the secondary string. It is used to set correctly
3657 `:parent' property within the string."
3663 secondary))))
3666 "Map a function on selected elements or objects.
3668 DATA is an Org buffer parse tree, as returned by, i.e,
3669 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3670 of elements or objects types (see `org-element-all-elements' and
3671 `org-element-all-objects' for a complete list of types). FUN is
3672 the function called on the matching element or object. It has to
3673 accept one argument: the element or object itself.
3675 When optional argument INFO is non-nil, it should be a plist
3676 holding export options. In that case, parts of the parse tree
3677 not exportable according to that property list will be skipped.
3679 When optional argument FIRST-MATCH is non-nil, stop at the first
3680 match for which FUN doesn't return nil, and return that value.
3682 Optional argument NO-RECURSION is a symbol or a list of symbols
3683 representing elements or objects types. `org-element-map' won't
3684 enter any recursive element or object whose type belongs to that
3685 list. Though, FUN can still be applied on them.
3687 Nil values returned from FUN do not appear in the results.
3690 Examples:
3691 --------
3693 Assuming TREE is a variable containing an Org buffer parse tree,
3694 the following example will return a flat list of all `src-block'
3695 and `example-block' elements in it:
3697 \(org-element-map tree '(example-block src-block) 'identity)
3699 The following snippet will find the first headline with a level
3702 \(org-element-map
3703 tree 'headline
3704 \(lambda (hl)
3705 \(and (= (org-element-property :level hl) 1)
3707 \(org-element-property :begin hl)))
3708 nil t)
3710 Eventually, this last example will return a flat list of all
3711 `bold' type objects containing a `latex-snippet' type object:
3713 \(org-element-map
3714 tree 'bold
3715 \(lambda (b)
3716 \(and (org-element-map b 'latex-snippet 'identity nil t)
3717 b)))"
3718 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3721 ;; Recursion depth is determined by --CATEGORY.
3728 ;; If one object is found, the function
3729 ;; has to recurse into every object.
3732 ;; If one regular element is found, the
3733 ;; function has to recurse, at least,
3734 ;; into every element it encounters.
3737 types)
3738 category)))
3739 --acc
3740 --walk-tree
3744 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3745 ;; holding contextual information.
3749 ;; Ignored element in an export context.
3751 ;; Secondary string: only objects can be found there.
3754 ;; Unconditionally enter parse trees.
3758 ;; Check if TYPE is matching among TYPES. If so,
3759 ;; apply FUN to --DATA and accumulate return value
3760 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3766 ;; If --DATA has a secondary string that can contain
3767 ;; objects with their type among TYPES, look into it.
3774 ;; Determine if a recursion into --DATA is possible.
3776 ;; --TYPE is explicitly removed from recursion.
3778 ;; --DATA has no contents.
3780 ;; Looking for greater elements but --DATA is simply
3781 ;; an element or an object.
3784 ;; Looking for elements but --DATA is an object.
3787 ;; In any other case, map contents.
3791 ;; Return value in a proper order.
3794 ;; The following functions are internal parts of the parser.
3795 ;;
3796 ;; The first one, `org-element--parse-elements' acts at the element's
3797 ;; level.
3798 ;;
3799 ;; The second one, `org-element--parse-objects' applies on all objects
3800 ;; of a paragraph or a secondary string. It uses
3801 ;; `org-element--get-next-object-candidates' to optimize the search of
3802 ;; the next object in the buffer.
3803 ;;
3804 ;; More precisely, that function looks for every allowed object type
3805 ;; first. Then, it discards failed searches, keeps further matches,
3806 ;; and searches again types matched behind point, for subsequent
3807 ;; calls. Thus, searching for a given type fails only once, and every
3808 ;; object is searched only once at top level (but sometimes more for
3809 ;; nested types).
3813 "Parse elements between BEG and END positions.
3815 SPECIAL prioritize some elements over the others. It can be set
3816 to `first-section', `quote-section', `section' `item' or
3817 `table-row'.
3819 When value is `item', STRUCTURE will be used as the current list
3820 structure.
3822 GRANULARITY determines the depth of the recursion. See
3823 `org-element-parse-buffer' for more information.
3825 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3826 elements.
3828 Elements are accumulated into ACC."
3831 ;; When parsing only headlines, skip any text before first one.
3834 ;; Main loop start.
3836 ;; Find current element's type and parse it accordingly to
3837 ;; its category.
3839 end granularity special structure))
3843 ;; Fill ELEMENT contents by side-effect.
3845 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3846 ;; no contents, don't modify it.
3849 ;; Greater element: parse it between `contents-begin' and
3850 ;; `contents-end'. Make sure GRANULARITY allows the
3851 ;; recursion, or ELEMENT is an headline, in which case going
3852 ;; inside is mandatory, in order to get sub-level headings.
3860 ;; Possibly switch to a special mode.
3869 granularity visible-only element))
3870 ;; ELEMENT has contents. Parse objects inside, if
3871 ;; GRANULARITY allows it.
3877 ;; Return result.
3878 acc))
3881 "Parse objects between BEG and END and return recursive structure.
3883 Objects are accumulated in ACC.
3885 RESTRICTION is a list of object types which are allowed in the
3886 current object."
3892 end restriction candidates)))
3899 ;; 1. Text before any object. Untabify it.
3904 acc
3908 ;; 2. Object...
3911 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3912 ;; a recursive type.
3917 cont-beg
3924 ;; 3. Text after last object. Untabify it.
3928 acc
3932 ;; Result.
3933 acc)))
3936 "Return an alist of candidates for the next object.
3938 LIMIT bounds the search, and RESTRICTION narrows candidates to
3939 some object types.
3941 Return value is an alist whose CAR is position and CDR the object
3942 type, as a symbol.
3944 OBJECTS is the previous candidates alist."
3945 ;; Filter out any object found but not belonging to RESTRICTION.
3951 type)
3952 restriction)))
3953 objects))
3955 ;; If no previous result, search every object type in RESTRICTION.
3956 ;; Otherwise, keep potential candidates (old objects located after
3957 ;; point) and ask to search again those which had matched before.
3962 objects))
3963 ;; Call the appropriate successor function for each type to search
3964 ;; and accumulate matches.
3971 type))))
3974 types-to-search)
3975 ;; Return alist.
3976 next-candidates))
3979 \f
3980 ;;; Towards A Bijective Process
3981 ;;
3982 ;; The parse tree obtained with `org-element-parse-buffer' is really
3983 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3984 ;; interpreted and expanded into a string with canonical Org syntax.
3985 ;; Hence `org-element-interpret-data'.
3986 ;;
3987 ;; The function relies internally on
3988 ;; `org-element--interpret-affiliated-keywords'.
3990 ;;;###autoload
3992 "Interpret DATA as Org syntax.
3994 DATA is a parse tree, an element, an object or a secondary string
3995 to interpret.
3997 Optional argument PARENT is used for recursive calls. It contains
3998 the element or object containing data, or nil.
4000 Return Org syntax as a string."
4004 ;; Secondary string.
4009 ;; Full Org document.
4014 ;; Plain text.
4016 ;; Element/Object without contents.
4019 data nil))
4020 ;; Element/Object with contents.
4030 ;; Elements directly containing objects must
4031 ;; have their indentation normalized first.
4033 data
4034 ;; When normalizing first paragraph of an
4035 ;; item or a footnote-definition, ignore
4036 ;; first line's indentation.
4043 data
4045 contents)))))))
4047 ;; Build white spaces. If no `:post-blank' property is
4048 ;; specified, assume its value is 0.
4058 "Return ELEMENT's affiliated keywords as Org syntax.
4059 If there is no affiliated keyword, return the empty string."
4069 ": "
4072 value)
4080 ;; All attribute keywords can have multiple lines.
4083 value
4086 ;; List all ELEMENT's properties matching an attribute line or an
4087 ;; affiliated keyword, but ignore translated keywords since they
4088 ;; cannot belong to the property list.
4095 org-element-keyword-translation-alist)))))
4096 collect prop)
4099 ;; Because interpretation of the parse tree must return the same
4100 ;; number of blank lines between elements and the same number of white
4101 ;; space after objects, some special care must be given to white
4102 ;; spaces.
4103 ;;
4104 ;; The first function, `org-element-normalize-string', ensures any
4105 ;; string different from the empty string will end with a single
4106 ;; newline character.
4107 ;;
4108 ;; The second function, `org-element-normalize-contents', removes
4109 ;; global indentation from the contents of the current element.
4112 "Ensure string S ends with a single newline character.
4114 If S isn't a string return it unchanged. If S is the empty
4115 string, return it. Otherwise, return a new string with a single
4116 newline character at its end."
4124 "Normalize plain text in ELEMENT's contents.
4126 ELEMENT must only contain plain text and objects.
4128 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4129 indentation to compute maximal common indentation.
4131 Return the normalized element that is element with global
4132 indentation removed from its contents. The function assumes that
4133 indentation is not done with TAB characters."
4135 collect-inds ; for byte-compiler
4138 ;; Return list of indentations within BLOB. This is done by
4139 ;; walking recursively BLOB and updating IND-LIST along the
4140 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4141 ;; been seen yet. It is required as this string is the only
4142 ;; one whose indentation doesn't happen after a newline
4143 ;; character.
4151 ;; An indentation of zero means no string will be
4152 ;; modified. Quit the process.
4158 ;; Avoid matching blank or empty lines.
4166 ;; Collect indentation list in ELEMENT. Possibly remove first
4167 ;; value if IGNORE-FIRST is non-nil.
4170 ;; Build ELEMENT back, replacing each string with the same
4171 ;; string minus common indentation.
4176 ;; Return BLOB with all its strings indentation
4177 ;; shortened from MCI white spaces. FIRST-FLAG is
4178 ;; non-nil when the first string hasn't been seen
4179 ;; yet.
4193 org-element-recursive-objects)
4197 blob))))
4201 \f
4202 ;;; The Toolbox
4203 ;;
4204 ;; The first move is to implement a way to obtain the smallest element
4205 ;; containing point. This is the job of `org-element-at-point'. It
4206 ;; basically jumps back to the beginning of section containing point
4207 ;; and moves, element after element, with
4208 ;; `org-element--current-element' until the container is found. Note:
4209 ;; When using `org-element-at-point', secondary values are never
4210 ;; parsed since the function focuses on elements, not on objects.
4211 ;;
4212 ;; At a deeper level, `org-element-context' lists all elements and
4213 ;; objects containing point.
4214 ;;
4215 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4216 ;; internally by navigation and manipulation tools.
4218 ;;;###autoload
4220 "Determine closest element around point.
4222 Return value is a list like (TYPE PROPS) where TYPE is the type
4223 of the element and PROPS a plist of properties associated to the
4224 element.
4226 Possible types are defined in `org-element-all-elements'.
4227 Properties depend on element or object type, but always include
4228 `:begin', `:end', `:parent' and `:post-blank' properties.
4230 As a special case, if point is at the very beginning of a list or
4231 sub-list, returned element will be that list instead of the first
4232 item. In the same way, if point is at the beginning of the first
4233 row of a table, returned element will be the table instead of the
4234 first row.
4236 If optional argument KEEP-TRAIL is non-nil, the function returns
4237 a list of elements leading to element at point. The list's CAR
4238 is always the element at point. The following positions contain
4239 element's siblings, then parents, siblings of parents, until the
4240 first element of current section."
4242 ;; If at an headline, parse it. It is the sole element that
4243 ;; doesn't require to know about context. Be sure to disallow
4244 ;; secondary string parsing, though.
4250 ;; Otherwise move at the beginning of the section containing
4251 ;; point.
4255 element type special-flag trail struct prevs parent)
4263 ;; Parse successively each element, skipping those ending
4264 ;; before original position.
4273 ;; 1. Skip any element ending before point. Also skip
4274 ;; element ending at point when we're sure that another
4275 ;; element has started.
4280 ;; 2. An element containing point is always the element at
4281 ;; point.
4284 ;; 3. At any other greater element type, if point is
4285 ;; within contents, move into it.
4290 ;; Create an anchor for tables and plain lists:
4291 ;; when point is at the very beginning of these
4292 ;; elements, ignoring affiliated keywords,
4293 ;; target them instead of their contents.
4295 ;; When point is at contents end, do not move
4296 ;; into elements with an explicit ending, but
4297 ;; return that element instead.
4301 drawer dynamic-block inlinetask item
4302 plain-list quote-block special-block))))
4317 ;;;###autoload
4319 "Return closest element or object around point.
4321 Return value is a list like (TYPE PROPS) where TYPE is the type
4322 of the element or object and PROPS a plist of properties
4323 associated to it.
4325 Possible types are defined in `org-element-all-elements' and
4326 `org-element-all-objects'. Properties depend on element or
4327 object type, but always include `:begin', `:end', `:parent' and
4328 `:post-blank'."
4333 end)
4334 ;; Check if point is inside an element containing objects or at
4335 ;; a secondary string. In that case, move to beginning of the
4336 ;; element or secondary string and set END to the other side.
4345 (<= origin
4346 ;; `1+' is required so some
4347 ;; successors can match
4348 ;; properly their object.
4362 element
4365 candidates)
4368 end restriction candidates))
4370 candidates)))
4371 ;; If ORIGIN is before next object in element, there's
4372 ;; no point in looking further.
4382 ;; ORIGIN is after OBJECT, so skip it.
4388 ;; ORIGIN is within a non-recursive object or at
4389 ;; an object boundaries: Return that object.
4393 ;; Otherwise, move within current object and
4394 ;; restrict search to the end of its contents.
4399 end cend)))))))
4400 parent))))))
4403 "Non-nil when elements ELEM-A and ELEM-B are nested."
4412 "Swap elements ELEM-A and ELEM-B.
4413 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4414 end of ELEM-A."
4416 ;; There are two special cases when an element doesn't start at bol:
4417 ;; the first paragraph in an item or in a footnote definition.
4419 ;; Only a paragraph without any affiliated keyword can be moved at
4420 ;; ELEM-A position in such a situation. Note that the case of
4421 ;; a footnote definition is impossible: it cannot contain two
4422 ;; paragraphs in a row because it cannot contain a blank line.
4428 ;; In a special situation, ELEM-A will have no indentation. We'll
4429 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4443 ;; Store overlays responsible for visibility status. We
4444 ;; also need to store their boundaries as they will be
4445 ;; removed from buffer.
4452 ;; Get contents.
4460 ;; Restore ex ELEM-A overlays.
4469 ;; Restore ex ELEM-B overlays.
4478 ;; Local variables:
4479 ;; generated-autoload-file: "org-loaddefs.el"
4480 ;; End:
4482 ;;; org-element.el ends here