| blob | e173774fd5a48cf286f7c94bb4a5ab94426d9a87 |
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 file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `example-block', `export-block', `fixed-width',
50 ;; `horizontal-rule', `keyword', `latex-environment', `node-property',
51 ;; `paragraph', `planning', `quote-section', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
54 ;;
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
62 ;;
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (i.e. an item tag or an headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
67 ;;
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements
75 ;; and elements containing objects will also have `:contents-begin'
76 ;; and `:contents-end' properties to delimit contents.
77 ;;
78 ;; Lisp-wise, an element or an object can be represented as a list.
79 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
80 ;; TYPE is a symbol describing the Org element or object.
81 ;; PROPERTIES is the property list attached to it. See docstring of
82 ;; appropriate parsing function to get an exhaustive
83 ;; list.
84 ;; CONTENTS is a list of elements, objects or raw strings contained
85 ;; in the current element or object, when applicable.
86 ;;
87 ;; An Org buffer is a nested list of such elements and objects, whose
88 ;; type is `org-data' and properties is nil.
89 ;;
90 ;; The first part of this file defines Org syntax, while the second
91 ;; one provide accessors and setters functions.
92 ;;
93 ;; The next part implements a parser and an interpreter for each
94 ;; element and object type in Org syntax.
95 ;;
96 ;; The following part creates a fully recursive buffer parser. It
97 ;; also provides a tool to map a function to elements or objects
98 ;; matching some criteria in the parse tree. Functions of interest
99 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
100 ;; extent, `org-element-parse-secondary-string'.
101 ;;
102 ;; The penultimate part is the cradle of an interpreter for the
103 ;; obtained parse tree: `org-element-interpret-data'.
104 ;;
105 ;; The library ends by furnishing `org-element-at-point' function, and
106 ;; a way to give information about document structure around point
107 ;; with `org-element-context'.
110 ;;; Code:
116 \f
117 ;;; Definitions And Rules
118 ;;
119 ;; Define elements, greater elements and specify recursive objects,
120 ;; along with the affiliated keywords recognized. Also set up
121 ;; restrictions on recursive objects combinations.
122 ;;
123 ;; These variables really act as a control center for the parsing
124 ;; process.
128 ;; Headlines, inlinetasks.
130 ;; Footnote definitions.
133 ;; Empty lines.
135 ;; Tables (any type).
137 ;; Blocks (any type), Babel calls, drawers (any type),
138 ;; fixed-width areas and keywords. Note: this is only an
139 ;; indication and need some thorough check.
141 ;; Horizontal rules.
143 ;; LaTeX environments.
145 ;; Planning and Clock lines.
147 org-deadline-string
148 org-closed-string
149 org-clock-string))
151 ;; Lists.
158 "Regexp to separate paragraphs in an Org buffer.
160 is not sufficient to know if point is at a paragraph ending. See
165 example-block export-block fixed-width footnote-definition
166 headline horizontal-rule inlinetask item keyword
167 latex-environment node-property paragraph plain-list planning
168 property-drawer quote-block quote-section section special-block
169 src-block table table-row verse-block)
174 item plain-list property-drawer quote-block section
175 special-block table)
180 latex-or-entity line-break link macro radio-target
181 statistics-cookie sub/superscript table-cell target
182 text-markup timestamp)
191 "Alist of translations between object type and successor name.
193 Sharing the same successor comes handy when, for example, the
198 inline-src-block italic line-break latex-fragment link macro
199 radio-target statistics-cookie strike-through subscript superscript
200 table-cell target timestamp underline verbatim)
205 table-cell underline)
215 "Alist between block names and the associated parsing function.
216 Names must be uppercase. Any block whose name has no association
222 Only these types can accept search options and an explicit
228 "List of affiliated keywords as strings.
234 ;; Regular affiliated keywords.
237 "Regexp matching any affiliated keyword.
239 Keyword name is put in match group 1. Moreover, if keyword
240 belongs to `org-element-dual-keywords', put the dual value in
241 match group 2.
249 "Alist of usual translations for keywords.
250 The key is the old name and the value the new one. The property
254 "List of affiliated keywords that can occur more than once in an element.
256 Their value will be consed into a list of strings, which will be
257 returned as the value of the property.
259 This list is checked after translations have been applied. See
260 `org-element-keyword-translation-alist'.
266 "List of keywords whose value can be parsed.
268 Their value will be stored as a secondary string: a list of
269 strings and objects.
271 This list is checked after translations have been applied. See
275 "List of keywords which can have a secondary value.
277 In Org syntax, they can be written with optional square brackets
278 before the colons. For example, results keyword can be
279 associated to a hash value with the following:
281 #+RESULTS[hash-string]: some-source
283 This list is checked after translations have been applied. See
290 inline-src-block latex-or-entity line-break link macro
291 radio-target sub/superscript target text-markup
292 timestamp)
294 radio-target statistics-cookie sub/superscript target text-markup
295 timestamp)
306 inline-src-block latex-or-entity line-break link macro
307 radio-target statistics-cookie sub/superscript target text-markup
308 timestamp)
311 latex-or-entity link radio-target sub/superscript target
312 text-markup timestamp)
323 latex-or-entity line-break link macro radio-target
325 "Alist of objects restrictions.
327 CAR is an element or object type containing objects and CDR is
328 a list of successors that will be called within an element or
329 object of such type.
331 For example, in a `radio-target' object, one can only find
332 entities, export snippets, latex-fragments, subscript and
333 superscript.
335 This alist also applies to secondary string. For example, an
336 `headline' type element doesn't directly contain objects, but
347 \f
348 ;;; Accessors and Setters
349 ;;
350 ;; Provide four accessors: `org-element-type', `org-element-property'
351 ;; `org-element-contents' and `org-element-restriction'.
352 ;;
353 ;; Setter functions allow to modify elements by side effect. There is
354 ;; `org-element-put-property', `org-element-set-contents',
355 ;; `org-element-set-element' and `org-element-adopt-element'. Note
356 ;; that `org-element-set-element' and `org-element-adopt-elements' are
357 ;; higher level functions since also update `:parent' property.
360 "Return type of ELEMENT.
362 The function returns the type of the element or object provided.
363 It can also return the following special value:
364 `plain-text' for a string
365 `org-data' for a complete document
366 nil in any other case."
372 "Extract the value from the PROPERTY of an ELEMENT."
376 "Extract contents from an ELEMENT."
380 "Return restriction associated to ELEMENT.
381 ELEMENT can be an element, an object or a symbol representing an
382 element or object type."
384 org-element-object-restrictions)))
387 "In ELEMENT set PROPERTY to VALUE.
388 Return modified element."
391 element)
394 "Set ELEMENT contents to CONTENTS.
395 Return modified element."
401 "Replace element or object OLD with element or object NEW.
402 The function takes care of setting `:parent' property for NEW."
403 ;; Since OLD is going to be changed into NEW by side-effect, first
404 ;; make sure that every element or object within NEW has OLD as
405 ;; parent.
408 ;; Transfer contents.
410 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
411 ;; with NEW's.
414 ;; Transfer type.
418 "Append elements to the contents of another element.
420 PARENT is an element or object. CHILDREN can be elements,
421 objects, or a strings.
423 The function takes care of setting `:parent' property for CHILD.
424 Return parent element."
426 ;; Link every child to PARENT.
430 children)
431 ;; Add CHILDREN at the end of PARENT contents.
433 parent
435 ;; Return modified PARENT element.
436 parent))
439 \f
440 ;;; Greater elements
441 ;;
442 ;; For each greater element type, we define a parser and an
443 ;; interpreter.
444 ;;
445 ;; A parser returns the element or object as the list described above.
446 ;; Most of them accepts no argument. Though, exceptions exist. Hence
447 ;; every element containing a secondary string (see
448 ;; `org-element-secondary-value-alist') will accept an optional
449 ;; argument to toggle parsing of that secondary string. Moreover,
450 ;; `item' parser requires current list's structure as its first
451 ;; element.
452 ;;
453 ;; An interpreter accepts two arguments: the list representation of
454 ;; the element or object, and its contents. The latter may be nil,
455 ;; depending on the element or object considered. It returns the
456 ;; appropriate Org syntax, as a string.
457 ;;
458 ;; Parsing functions must follow the naming convention:
459 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
460 ;; defined in `org-element-greater-elements'.
461 ;;
462 ;; Similarly, interpreting functions must follow the naming
463 ;; convention: org-element-TYPE-interpreter.
464 ;;
465 ;; With the exception of `headline' and `item' types, greater elements
466 ;; cannot contain other greater elements of their own type.
467 ;;
468 ;; Beside implementing a parser and an interpreter, adding a new
469 ;; greater element requires to tweak `org-element--current-element'.
470 ;; Moreover, the newly defined type must be added to both
471 ;; `org-element-all-elements' and `org-element-greater-elements'.
474 ;;;; Center Block
477 "Parse a center block.
479 LIMIT bounds the search. AFFILIATED is a list of which CAR is
480 the buffer position at the beginning of the first affiliated
481 keyword and CDR is a plist of affiliated keywords along with
482 their value.
484 Return a list whose CAR is `center-block' and CDR is a plist
485 containing `:begin', `:end', `:hiddenp', `:contents-begin',
486 `:contents-end' and `:post-blank' keywords.
488 Assume point is at the beginning of the block."
492 ;; Incomplete block: parse it as a paragraph.
496 ;; Empty blocks have no contents.
510 :end end
511 :hiddenp hidden
512 :contents-begin contents-begin
513 :contents-end contents-end
518 "Interpret CENTER-BLOCK element as Org syntax.
519 CONTENTS is the contents of the element."
523 ;;;; Drawer
526 "Parse a drawer.
528 LIMIT bounds the search. AFFILIATED is a list of which CAR is
529 the buffer position at the beginning of the first affiliated
530 keyword and CDR is a plist of affiliated keywords along with
531 their value.
533 Return a list whose CAR is `drawer' and CDR is a plist containing
534 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
535 `:contents-end' and `:post-blank' keywords.
537 Assume point is at beginning of drawer."
540 ;; Incomplete drawer: parse it as a paragraph.
547 ;; Empty drawers have no contents.
561 :end end
562 :drawer-name name
563 :hiddenp hidden
564 :contents-begin contents-begin
565 :contents-end contents-end
570 "Interpret DRAWER element as Org syntax.
571 CONTENTS is the contents of the element."
574 contents))
577 ;;;; Dynamic Block
580 "Parse a dynamic block.
582 LIMIT bounds the search. AFFILIATED is a list of which CAR is
583 the buffer position at the beginning of the first affiliated
584 keyword and CDR is a plist of affiliated keywords along with
585 their value.
587 Return a list whose CAR is `dynamic-block' and CDR is a plist
588 containing `:block-name', `:begin', `:end', `:hiddenp',
589 `:contents-begin', `:contents-end', `:arguments' and
590 `:post-blank' keywords.
592 Assume point is at beginning of dynamic block."
595 ;; Incomplete block: parse it as a paragraph.
603 ;; Empty blocks have no contents.
617 :end end
618 :block-name name
619 :arguments arguments
620 :hiddenp hidden
621 :contents-begin contents-begin
622 :contents-end contents-end
627 "Interpret DYNAMIC-BLOCK element as Org syntax.
628 CONTENTS is the contents of the element."
633 contents))
636 ;;;; Footnote Definition
639 "Parse a footnote definition.
641 LIMIT bounds the search. AFFILIATED is a list of which CAR is
642 the buffer position at the beginning of the first affiliated
643 keyword and CDR is a plist of affiliated keywords along with
644 their value.
646 Return a list whose CAR is `footnote-definition' and CDR is
647 a plist containing `:label', `:begin' `:end', `:contents-begin',
648 `:contents-end' and `:post-blank' keywords.
650 Assume point is at the beginning of the footnote definition."
674 :begin begin
675 :end end
676 :contents-begin contents-begin
677 :contents-end contents-end
682 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
683 CONTENTS is the contents of the footnote-definition."
685 " "
686 contents))
689 ;;;; Headline
692 "Parse an headline.
694 Return a list whose CAR is `headline' and CDR is a plist
695 containing `:raw-value', `:title', `:begin', `:end',
696 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
697 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
698 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
699 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
700 keywords.
702 The plist also contains any property set in the property drawer,
703 with its name in lowercase, the underscores replaced with hyphens
704 and colons at the beginning (i.e. `:custom-id').
706 When RAW-SECONDARY-P is non-nil, headline's title will not be
707 parsed as a secondary string, but as a plain string instead.
709 Assume point is at beginning of the headline."
728 ;; Normalize property names: ":SOME_PROP:" becomes
729 ;; ":some-prop".
741 plist))
759 ;; Clean RAW-VALUE from any quote or comment string.
764 ""
765 raw-value)))
766 ;; Clean TAGS from archive tag, if any.
772 :begin begin
773 :end end
774 :pre-blank
777 :hiddenp hidden
778 :contents-begin contents-begin
779 :contents-end contents-end
780 :level level
782 :tags tags
783 :todo-keyword todo
784 :todo-type todo-type
785 :scheduled scheduled
786 :deadline deadline
787 :timestamp timestamp
788 :clock clock
794 end)
795 :footnote-section-p footnote-section-p
796 :archivedp archivedp
797 :commentedp commentedp
799 standard-props))))
801 headline :title
807 "Interpret HEADLINE element as Org syntax.
808 CONTENTS is the contents of the element."
835 ;; Align tags.
843 ? )
844 tags))
848 tags))))
850 contents)))
853 ;;;; Inlinetask
856 "Parse an inline task.
858 Return a list whose CAR is `inlinetask' and CDR is a plist
859 containing `:title', `:begin', `:end', `:hiddenp',
860 `:contents-begin' and `:contents-end', `:level', `:priority',
861 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
862 `:scheduled', `:deadline', `:timestamp', `:clock' and
863 `:post-blank' keywords.
865 The plist also contains any property set in the property drawer,
866 with its name in lowercase, the underscores replaced with hyphens
867 and colons at the beginning (i.e. `:custom-id').
869 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
870 title will not be parsed as a secondary string, but as a plain
871 string instead.
873 Assume point is at beginning of the inline task."
884 ;; Normalize property names: ":SOME_PROP:" becomes
885 ;; ":some-prop".
897 plist))
921 :begin begin
922 :end end
923 :hiddenp hidden
924 :contents-begin contents-begin
925 :contents-end contents-end
928 :tags tags
929 :todo-keyword todo
930 :todo-type todo-type
931 :scheduled scheduled
932 :deadline deadline
933 :timestamp timestamp
934 :clock clock
936 standard-props
939 inlinetask :title
942 raw-value
944 inlinetask))))))
947 "Interpret INLINETASK element as Org syntax.
948 CONTENTS is the contents of inlinetask."
963 ;; Align tags.
971 ? )
972 tags))
976 tags))))
977 ;; Prefer degenerate inlinetasks when there are no
978 ;; contents.
981 contents
985 ;;;; Item
988 "Parse an item.
990 STRUCT is the structure of the plain list.
992 Return a list whose CAR is `item' and CDR is a plist containing
993 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
994 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
995 `:post-blank' keywords.
997 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
998 any, will not be parsed as a secondary string, but as a plain
999 string instead.
1001 Assume point is at the beginning of the item."
1025 ;; Ignore tags in un-ordered lists: they are just
1026 ;; a part of item's body.
1032 ;; If first line isn't empty, contents really start
1033 ;; at the text after item's meta-data.
1044 :begin begin
1045 :end end
1046 ;; CONTENTS-BEGIN and CONTENTS-END may be
1047 ;; mixed up in the case of an empty item
1048 ;; separated from the next by a blank line.
1049 ;; Thus ensure the former is always the
1050 ;; smallest.
1053 :checkbox checkbox
1054 :counter counter
1055 :hiddenp hidden
1056 :structure struct
1059 item :tag
1067 "Interpret ITEM element as Org syntax.
1068 CONTENTS is the contents of the element."
1074 ;; Compute indentation.
1079 ;; Indent contents.
1081 bullet
1094 ;;;; Plain List
1097 "Parse a plain list.
1099 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1100 the buffer position at the beginning of the first affiliated
1101 keyword and CDR is a plist of affiliated keywords along with
1102 their value. STRUCTURE is the structure of the plain list being
1103 parsed.
1105 Return a list whose CAR is `plain-list' and CDR is a plist
1106 containing `:type', `:begin', `:end', `:contents-begin' and
1107 `:contents-end', `:structure' and `:post-blank' keywords.
1109 Assume point is at the beginning of the list."
1123 ;; Return value.
1127 :begin begin
1128 :end end
1129 :contents-begin contents-begin
1130 :contents-end contents-end
1131 :structure struct
1136 "Interpret PLAIN-LIST element as Org syntax.
1137 CONTENTS is the contents of the element."
1145 ;;;; Property Drawer
1148 "Parse a property drawer.
1150 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1151 the buffer position at the beginning of the first affiliated
1152 keyword and CDR is a plist of affiliated keywords along with
1153 their value.
1155 Return a list whose CAR is `property-drawer' and CDR is a plist
1156 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1157 `:contents-end' and `:post-blank' keywords.
1159 Assume point is at the beginning of the property drawer."
1164 ;; Incomplete drawer: parse it as a paragraph.
1182 :end end
1183 :hiddenp hidden
1184 :contents-begin contents-begin
1185 :contents-end contents-end
1190 "Interpret PROPERTY-DRAWER element as Org syntax.
1191 CONTENTS is the properties within the drawer."
1195 ;;;; Quote Block
1198 "Parse a quote block.
1200 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1201 the buffer position at the beginning of the first affiliated
1202 keyword and CDR is a plist of affiliated keywords along with
1203 their value.
1205 Return a list whose CAR is `quote-block' and CDR is a plist
1206 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1207 `:contents-end' and `:post-blank' keywords.
1209 Assume point is at the beginning of the block."
1213 ;; Incomplete block: parse it as a paragraph.
1218 ;; Empty blocks have no contents.
1232 :end end
1233 :hiddenp hidden
1234 :contents-begin contents-begin
1235 :contents-end contents-end
1240 "Interpret QUOTE-BLOCK element as Org syntax.
1241 CONTENTS is the contents of the element."
1245 ;;;; Section
1248 "Parse a section.
1250 LIMIT bounds the search.
1252 Return a list whose CAR is `section' and CDR is a plist
1253 containing `:begin', `:end', `:contents-begin', `contents-end'
1254 and `:post-blank' keywords."
1256 ;; Beginning of section is the beginning of the first non-blank
1257 ;; line after previous headline.
1266 :end end
1267 :contents-begin begin
1268 :contents-end pos-before-blank
1272 "Interpret SECTION element as Org syntax.
1273 CONTENTS is the contents of the element."
1274 contents)
1277 ;;;; Special Block
1280 "Parse a special block.
1282 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1283 the buffer position at the beginning of the first affiliated
1284 keyword and CDR is a plist of affiliated keywords along with
1285 their value.
1287 Return a list whose CAR is `special-block' and CDR is a plist
1288 containing `:type', `:begin', `:end', `:hiddenp',
1289 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1291 Assume point is at the beginning of the block."
1297 ;; Incomplete block: parse it as a paragraph.
1302 ;; Empty blocks have no contents.
1316 :begin begin
1317 :end end
1318 :hiddenp hidden
1319 :contents-begin contents-begin
1320 :contents-end contents-end
1325 "Interpret SPECIAL-BLOCK element as Org syntax.
1326 CONTENTS is the contents of the element."
1331 \f
1332 ;;; Elements
1333 ;;
1334 ;; For each element, a parser and an interpreter are also defined.
1335 ;; Both follow the same naming convention used for greater elements.
1336 ;;
1337 ;; Also, as for greater elements, adding a new element type is done
1338 ;; through the following steps: implement a parser and an interpreter,
1339 ;; tweak `org-element--current-element' so that it recognizes the new
1340 ;; type and add that new type to `org-element-all-elements'.
1341 ;;
1342 ;; As a special case, when the newly defined type is a block type,
1343 ;; `org-element-block-name-alist' has to be modified accordingly.
1346 ;;;; Babel Call
1349 "Parse a babel call.
1351 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1352 the buffer position at the beginning of the first affiliated
1353 keyword and CDR is a plist of affiliated keywords along with
1354 their value.
1356 Return a list whose CAR is `babel-call' and CDR is a plist
1357 containing `:begin', `:end', `:info' and `:post-blank' as
1358 keywords."
1370 :end end
1371 :info info
1376 "Interpret BABEL-CALL element as Org syntax.
1377 CONTENTS is nil."
1383 ;; Remove redundant square brackets.
1388 ;;;; Clock
1391 "Parse a clock.
1393 LIMIT bounds the search.
1395 Return a list whose CAR is `clock' and CDR is a plist containing
1396 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1397 as keywords."
1416 :value value
1417 :time time
1418 :begin begin
1419 :end end
1423 "Interpret CLOCK element as Org syntax.
1424 CONTENTS is nil."
1431 "%2s:%02s"
1435 ;;;; Comment
1438 "Parse a comment.
1440 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1441 the buffer position at the beginning of the first affiliated
1442 keyword and CDR is a plist of affiliated keywords along with
1443 their value.
1445 Return a list whose CAR is `comment' and CDR is a plist
1446 containing `:begin', `:end', `:value' and `:post-blank'
1447 keywords.
1449 Assume point is at comment beginning."
1457 ;; Get comments ending.
1460 ;; Accumulate lines without leading hash and first
1461 ;; whitespace.
1475 :end end
1476 :value value
1481 "Interpret COMMENT element as Org syntax.
1482 CONTENTS is nil."
1486 ;;;; Comment Block
1489 "Parse an export block.
1491 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1492 the buffer position at the beginning of the first affiliated
1493 keyword and CDR is a plist of affiliated keywords along with
1494 their value.
1496 Return a list whose CAR is `comment-block' and CDR is a plist
1497 containing `:begin', `:end', `:hiddenp', `:value' and
1498 `:post-blank' keywords.
1500 Assume point is at comment block beginning."
1504 ;; Incomplete block: parse it as a paragraph.
1517 contents-begin contents-end)))
1521 :end end
1522 :value value
1523 :hiddenp hidden
1528 "Interpret COMMENT-BLOCK element as Org syntax.
1529 CONTENTS is nil."
1534 ;;;; Example Block
1537 "Parse an example block.
1539 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1540 the buffer position at the beginning of the first affiliated
1541 keyword and CDR is a plist of affiliated keywords along with
1542 their value.
1544 Return a list whose CAR is `example-block' and CDR is a plist
1545 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1546 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1547 `:switches', `:value' and `:post-blank' keywords."
1551 ;; Incomplete block: parse it as a paragraph.
1558 ;; Switches analysis
1563 ;; Should labels be retained in (or stripped from) example
1564 ;; blocks?
1569 ;; What should code-references use - labels or
1570 ;; line-numbers?
1577 ;; Standard block parsing.
1590 :end end
1591 :value value
1592 :switches switches
1593 :number-lines number-lines
1594 :preserve-indent preserve-indent
1595 :retain-labels retain-labels
1596 :use-labels use-labels
1597 :label-fmt label-fmt
1598 :hiddenp hidden
1603 "Interpret EXAMPLE-BLOCK element as Org syntax.
1604 CONTENTS is nil."
1612 ;;;; Export Block
1615 "Parse an export block.
1617 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1618 the buffer position at the beginning of the first affiliated
1619 keyword and CDR is a plist of affiliated keywords along with
1620 their value.
1622 Return a list whose CAR is `export-block' and CDR is a plist
1623 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1624 `:post-blank' keywords.
1626 Assume point is at export-block beginning."
1632 ;; Incomplete block: parse it as a paragraph.
1645 contents-end)))
1649 :end end
1650 :type type
1651 :value value
1652 :hiddenp hidden
1657 "Interpret EXPORT-BLOCK element as Org syntax.
1658 CONTENTS is nil."
1665 ;;;; Fixed-width
1668 "Parse a fixed-width section.
1670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1671 the buffer position at the beginning of the first affiliated
1672 keyword and CDR is a plist of affiliated keywords along with
1673 their value.
1675 Return a list whose CAR is `fixed-width' and CDR is a plist
1676 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1678 Assume point is at the beginning of the fixed-width area."
1681 value
1686 ;; Accumulate text without starting colons.
1699 :end end
1700 :value value
1705 "Interpret FIXED-WIDTH element as Org syntax.
1706 CONTENTS is nil."
1711 ;;;; Horizontal Rule
1714 "Parse an horizontal rule.
1716 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1717 the buffer position at the beginning of the first affiliated
1718 keyword and CDR is a plist of affiliated keywords along with
1719 their value.
1721 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1722 containing `:begin', `:end' and `:post-blank' keywords."
1731 :end end
1736 "Interpret HORIZONTAL-RULE element as Org syntax.
1737 CONTENTS is nil."
1741 ;;;; Keyword
1744 "Parse a keyword at point.
1746 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1747 the buffer position at the beginning of the first affiliated
1748 keyword and CDR is a plist of affiliated keywords along with
1749 their value.
1751 Return a list whose CAR is `keyword' and CDR is a plist
1752 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1753 keywords."
1767 :value value
1768 :begin begin
1769 :end end
1774 "Interpret KEYWORD element as Org syntax.
1775 CONTENTS is nil."
1781 ;;;; Latex Environment
1784 "Parse a LaTeX environment.
1786 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1787 the buffer position at the beginning of the first affiliated
1788 keyword and CDR is a plist of affiliated keywords along with
1789 their value.
1791 Return a list whose CAR is `latex-environment' and CDR is a plist
1792 containing `:begin', `:end', `:value' and `:post-blank'
1793 keywords.
1795 Assume point is at the beginning of the latex environment."
1812 :end end
1813 :value value
1818 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1819 CONTENTS is nil."
1823 ;;;; Node Property
1826 "Parse a node-property at point.
1828 LIMIT bounds the search.
1830 Return a list whose CAR is `node-property' and CDR is a plist
1831 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1832 keywords."
1844 :value value
1845 :begin begin
1846 :end end
1850 "Interpret NODE-PROPERTY element as Org syntax.
1851 CONTENTS is nil."
1857 ;;;; Paragraph
1860 "Parse a paragraph.
1862 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1863 the buffer position at the beginning of the first affiliated
1864 keyword and CDR is a plist of affiliated keywords along with
1865 their value.
1867 Return a list whose CAR is `paragraph' and CDR is a plist
1868 containing `:begin', `:end', `:contents-begin' and
1869 `:contents-end' and `:post-blank' keywords.
1871 Assume point is at the beginning of the paragraph."
1881 ;; Skip non-existent or incomplete drawer.
1889 ;; Stop at comments.
1893 ;; Skip incomplete dynamic blocks.
1900 ;; Skip incomplete blocks.
1908 limit t))))
1909 ;; Skip incomplete latex environments.
1917 limit t))))
1918 ;; Skip ill-formed keywords.
1932 :end end
1933 :contents-begin contents-begin
1934 :contents-end contents-end
1939 "Interpret PARAGRAPH element as Org syntax.
1940 CONTENTS is the contents of the element."
1941 contents)
1944 ;;;; Planning
1947 "Parse a planning.
1949 LIMIT bounds the search.
1951 Return a list whose CAR is `planning' and CDR is a plist
1952 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1953 and `:post-blank' keywords."
1962 closed deadline scheduled)
1976 :deadline deadline
1977 :scheduled scheduled
1978 :begin begin
1979 :end end
1983 "Interpret PLANNING element as Org syntax.
1984 CONTENTS is nil."
1986 'identity
1998 ;;;; Quote Section
2001 "Parse a quote section.
2003 LIMIT bounds the search.
2005 Return a list whose CAR is `quote-section' and CDR is a plist
2006 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2008 Assume point is at beginning of the section."
2019 :end end
2020 :value value
2024 "Interpret QUOTE-SECTION element as Org syntax.
2025 CONTENTS is nil."
2029 ;;;; Src Block
2032 "Parse a src block.
2034 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2035 the buffer position at the beginning of the first affiliated
2036 keyword and CDR is a plist of affiliated keywords along with
2037 their value.
2039 Return a list whose CAR is `src-block' and CDR is a plist
2040 containing `:language', `:switches', `:parameters', `:begin',
2041 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2042 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
2043 `:post-blank' keywords.
2045 Assume point is at the beginning of the block."
2048 ;; Incomplete block: parse it as a paragraph.
2053 ;; Get language as a string.
2062 ;; Get switches.
2064 ;; Get parameters.
2066 ;; Switches analysis
2074 ;; Should labels be retained in (or stripped from)
2075 ;; src blocks?
2080 ;; What should code-references use - labels or
2081 ;; line-numbers?
2085 ;; Get visibility status.
2087 ;; Retrieve code.
2092 ;; Get position after ending blank lines.
2102 :begin begin
2103 :end end
2104 :number-lines number-lines
2105 :preserve-indent preserve-indent
2106 :retain-labels retain-labels
2107 :use-labels use-labels
2108 :label-fmt label-fmt
2109 :hiddenp hidden
2110 :value value
2115 "Interpret SRC-BLOCK element as Org syntax.
2116 CONTENTS is nil."
2136 value
2140 ;;;; Table
2143 "Parse a table at point.
2145 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2146 the buffer position at the beginning of the first affiliated
2147 keyword and CDR is a plist of affiliated keywords along with
2148 their value.
2150 Return a list whose CAR is `table' and CDR is a plist containing
2151 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2152 `:contents-end', `:value' and `:post-blank' keywords.
2154 Assume point is at the beginning of the table."
2166 acc))
2173 :end end
2174 :type type
2175 :tblfm tblfm
2176 ;; Only `org' tables have contents. `table.el' tables
2177 ;; use a `:value' property to store raw table as
2178 ;; a string.
2183 table-begin table-end))
2188 "Interpret TABLE element as Org syntax.
2189 CONTENTS is nil."
2200 ;;;; Table Row
2203 "Parse table row at point.
2205 LIMIT bounds the search.
2207 Return a list whose CAR is `table-row' and CDR is a plist
2208 containing `:begin', `:end', `:contents-begin', `:contents-end',
2209 `:type' and `:post-blank' keywords."
2213 ;; A table rule has no contents. In that case, ensure
2214 ;; CONTENTS-BEGIN matches CONTENTS-END.
2226 :begin begin
2227 :end end
2228 :contents-begin contents-begin
2229 :contents-end contents-end
2233 "Interpret TABLE-ROW element as Org syntax.
2234 CONTENTS is the contents of the table row."
2239 ;;;; Verse Block
2242 "Parse a verse block.
2244 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2245 the buffer position at the beginning of the first affiliated
2246 keyword and CDR is a plist of affiliated keywords along with
2247 their value.
2249 Return a list whose CAR is `verse-block' and CDR is a plist
2250 containing `:begin', `:end', `:contents-begin', `:contents-end',
2251 `:hiddenp' and `:post-blank' keywords.
2253 Assume point is at beginning of the block."
2257 ;; Incomplete block: parse it as a paragraph.
2272 :end end
2273 :contents-begin contents-begin
2274 :contents-end contents-end
2275 :hiddenp hidden
2280 "Interpret VERSE-BLOCK element as Org syntax.
2281 CONTENTS is verse block contents."
2285 \f
2286 ;;; Objects
2287 ;;
2288 ;; Unlike to elements, interstices can be found between objects.
2289 ;; That's why, along with the parser, successor functions are provided
2290 ;; for each object. Some objects share the same successor (i.e. `code'
2291 ;; and `verbatim' objects).
2292 ;;
2293 ;; A successor must accept a single argument bounding the search. It
2294 ;; will return either a cons cell whose CAR is the object's type, as
2295 ;; a symbol, and CDR the position of its next occurrence, or nil.
2296 ;;
2297 ;; Successors follow the naming convention:
2298 ;; org-element-NAME-successor, where NAME is the name of the
2299 ;; successor, as defined in `org-element-all-successors'.
2300 ;;
2301 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2302 ;; object types they can contain will be specified in
2303 ;; `org-element-object-restrictions'.
2304 ;;
2305 ;; Adding a new type of object is simple. Implement a successor,
2306 ;; a parser, and an interpreter for it, all following the naming
2307 ;; convention. Register type in `org-element-all-objects' and
2308 ;; successor in `org-element-all-successors'. Maybe tweak
2309 ;; restrictions about it, and that's it.
2312 ;;;; Bold
2315 "Parse bold object at point.
2317 Return a list whose CAR is `bold' and CDR is a plist with
2318 `:begin', `:end', `:contents-begin' and `:contents-end' and
2319 `:post-blank' keywords.
2321 Assume point is at the first star marker."
2333 :end end
2334 :contents-begin contents-begin
2335 :contents-end contents-end
2339 "Interpret BOLD object as Org syntax.
2340 CONTENTS is the contents of the object."
2344 "Search for the next text-markup object.
2346 LIMIT bounds the search.
2348 Return value is a cons cell whose CAR is a symbol among `bold',
2349 `italic', `underline', `strike-through', `code' and `verbatim'
2350 and CDR is beginning position."
2366 ;;;; Code
2369 "Parse code object at point.
2371 Return a list whose CAR is `code' and CDR is a plist with
2372 `:value', `:begin', `:end' and `:post-blank' keywords.
2374 Assume point is at the first tilde marker."
2385 :begin begin
2386 :end end
2390 "Interpret CODE object as Org syntax.
2391 CONTENTS is nil."
2395 ;;;; Entity
2398 "Parse entity at point.
2400 Return a list whose CAR is `entity' and CDR a plist with
2401 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2402 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2403 keywords.
2405 Assume point is at the beginning of the entity."
2407 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2423 :begin begin
2424 :end end
2425 :use-brackets-p bracketsp
2429 "Interpret ENTITY object as Org syntax.
2430 CONTENTS is nil."
2436 "Search for the next latex-fragment or entity object.
2438 LIMIT bounds the search.
2440 Return value is a cons cell whose CAR is `entity' or
2441 `latex-fragment' and CDR is beginning position."
2445 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2452 limit t)
2455 ;; Determine if it's a real entity or a LaTeX command.
2458 ;; No entity nor command: point is at a LaTeX fragment.
2459 ;; Determine its type to get the correct beginning position.
2467 matchers)
2471 ;;;; Export Snippet
2474 "Parse export snippet at point.
2476 Return a list whose CAR is `export-snippet' and CDR a plist with
2477 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2478 keywords.
2480 Assume point is at the beginning of the snippet."
2492 :value value
2493 :begin begin
2494 :end end
2498 "Interpret EXPORT-SNIPPET object as Org syntax.
2499 CONTENTS is nil."
2505 "Search for the next export-snippet object.
2507 LIMIT bounds the search.
2509 Return value is a cons cell whose CAR is `export-snippet' and CDR
2510 its beginning position."
2519 ;;;; Footnote Reference
2522 "Parse footnote reference at point.
2524 Return a list whose CAR is `footnote-reference' and CDR a plist
2525 with `:label', `:type', `:inline-definition', `:begin', `:end'
2526 and `:post-blank' as keywords."
2548 :type type
2549 :begin begin
2550 :end end
2553 footnote-reference :inline-definition
2558 footnote-reference))))))
2561 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2562 CONTENTS is nil."
2572 "Search for the next footnote-reference object.
2574 LIMIT bounds the search.
2576 Return value is a cons cell whose CAR is `footnote-reference' and
2577 CDR is beginning position."
2591 ;;;; Inline Babel Call
2594 "Parse inline babel call at point.
2596 Return a list whose CAR is `inline-babel-call' and CDR a plist
2597 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2599 Assume point is at the beginning of the babel call."
2610 :end end
2611 :info info
2615 "Interpret INLINE-BABEL-CALL object as Org syntax.
2616 CONTENTS is nil."
2622 ;; Remove redundant square brackets.
2625 main-source)
2629 "Search for the next inline-babel-call object.
2631 LIMIT bounds the search.
2633 Return value is a cons cell whose CAR is `inline-babel-call' and
2634 CDR is beginning position."
2636 ;; Use a simplified version of
2637 ;; `org-babel-inline-lob-one-liner-regexp'.
2640 limit t)
2644 ;;;; Inline Src Block
2647 "Parse inline source block at point.
2649 LIMIT bounds the search.
2651 Return a list whose CAR is `inline-src-block' and CDR a plist
2652 with `:begin', `:end', `:language', `:value', `:parameters' and
2653 `:post-blank' as keywords.
2655 Assume point is at the beginning of the inline src block."
2668 :value value
2669 :parameters parameters
2670 :begin begin
2671 :end end
2675 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2676 CONTENTS is nil."
2681 language
2683 body)))
2686 "Search for the next inline-babel-call element.
2688 LIMIT bounds the search.
2690 Return value is a cons cell whose CAR is `inline-babel-call' and
2691 CDR is beginning position."
2697 ;;;; Italic
2700 "Parse italic object at point.
2702 Return a list whose CAR is `italic' and CDR is a plist with
2703 `:begin', `:end', `:contents-begin' and `:contents-end' and
2704 `:post-blank' keywords.
2706 Assume point is at the first slash marker."
2718 :end end
2719 :contents-begin contents-begin
2720 :contents-end contents-end
2724 "Interpret ITALIC object as Org syntax.
2725 CONTENTS is the contents of the object."
2729 ;;;; Latex Fragment
2732 "Parse latex fragment at point.
2734 Return a list whose CAR is `latex-fragment' and CDR a plist with
2735 `:value', `:begin', `:end', and `:post-blank' as keywords.
2737 Assume point is at the beginning of the latex fragment."
2751 ;; None found: it's a macro.
2760 :begin begin
2761 :end end
2765 "Interpret LATEX-FRAGMENT object as Org syntax.
2766 CONTENTS is nil."
2769 ;;;; Line Break
2772 "Parse line break at point.
2774 Return a list whose CAR is `line-break', and CDR a plist with
2775 `:begin', `:end' and `:post-blank' keywords.
2777 Assume point is at the beginning of the line break."
2781 "Interpret LINE-BREAK object as Org syntax.
2782 CONTENTS is nil."
2786 "Search for the next line-break object.
2788 LIMIT bounds the search.
2790 Return value is a cons cell whose CAR is `line-break' and CDR is
2791 beginning position."
2795 ;; A line break can only happen on a non-empty line.
2800 ;;;; Link
2803 "Parse link at point.
2805 Return a list whose CAR is `link' and CDR a plist with `:type',
2806 `:path', `:raw-link', `:application', `:search-option', `:begin',
2807 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2808 keywords.
2810 Assume point is at the beginning of the link."
2813 end contents-begin contents-end link-end post-blank path type
2814 raw-link link search-option application)
2816 ;; Type 1: Text targeted from a radio target.
2821 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2826 ;; RAW-LINK is the original link.
2831 ;; Determine TYPE of link and set PATH accordingly.
2833 ;; File type.
2836 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2839 ;; Id type: PATH is the id.
2842 ;; Code-ref type: PATH is the name of the reference.
2845 ;; Custom-id type: PATH is the name of the custom id.
2848 ;; Fuzzy type: Internal link either matches a target, an
2849 ;; headline name or nothing. PATH is the target or
2850 ;; headline's name.
2852 ;; Type 3: Plain link, i.e. http://orgmode.org
2858 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2865 ;; In any case, deduce end point after trailing white space from
2866 ;; LINK-END variable.
2869 ;; Extract search option and opening application out of
2870 ;; "file"-type links.
2872 ;; Application.
2877 ;; Extract search option from PATH.
2881 ;; Make sure TYPE always report "file".
2885 :path path
2887 :application application
2888 :search-option search-option
2889 :begin begin
2890 :end end
2891 :contents-begin contents-begin
2892 :contents-end contents-end
2896 "Interpret LINK object as Org syntax.
2897 CONTENTS is the contents of the object, or nil."
2902 raw-link
2906 "Search for the next link object.
2908 LIMIT bounds the search.
2910 Return value is a cons cell whose CAR is `link' and CDR is
2911 beginning position."
2920 ;;;; Macro
2923 "Parse macro at point.
2925 Return a list whose CAR is `macro' and CDR a plist with `:key',
2926 `:args', `:begin', `:end', `:value' and `:post-blank' as
2927 keywords.
2929 Assume point is at the macro."
2943 ;; Repair bad splits.
2951 :value value
2952 :args args
2953 :begin begin
2954 :end end
2958 "Interpret MACRO object as Org syntax.
2959 CONTENTS is nil."
2963 "Search for the next macro object.
2965 LIMIT bounds the search.
2967 Return value is cons cell whose CAR is `macro' and CDR is
2968 beginning position."
2972 limit t)
2976 ;;;; Radio-target
2979 "Parse radio target at point.
2981 Return a list whose CAR is `radio-target' and CDR a plist with
2982 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2983 and `:post-blank' as keywords.
2985 Assume point is at the radio target."
2997 :end end
2998 :contents-begin contents-begin
2999 :contents-end contents-end
3000 :post-blank post-blank
3004 "Interpret TARGET object as Org syntax.
3005 CONTENTS is the contents of the object."
3009 "Search for the next radio-target object.
3011 LIMIT bounds the search.
3013 Return value is a cons cell whose CAR is `radio-target' and CDR
3014 is beginning position."
3020 ;;;; Statistics Cookie
3023 "Parse statistics cookie at point.
3025 Return a list whose CAR is `statistics-cookie', and CDR a plist
3026 with `:begin', `:end', `:value' and `:post-blank' keywords.
3028 Assume point is at the beginning of the statistics-cookie."
3039 :end end
3040 :value value
3044 "Interpret STATISTICS-COOKIE object as Org syntax.
3045 CONTENTS is nil."
3049 "Search for the next statistics cookie object.
3051 LIMIT bounds the search.
3053 Return value is a cons cell whose CAR is `statistics-cookie' and
3054 CDR is beginning position."
3060 ;;;; Strike-Through
3063 "Parse strike-through object at point.
3065 Return a list whose CAR is `strike-through' and CDR is a plist
3066 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3067 `:post-blank' keywords.
3069 Assume point is at the first plus sign marker."
3081 :end end
3082 :contents-begin contents-begin
3083 :contents-end contents-end
3087 "Interpret STRIKE-THROUGH object as Org syntax.
3088 CONTENTS is the contents of the object."
3092 ;;;; Subscript
3095 "Parse subscript at point.
3097 Return a list whose CAR is `subscript' and CDR a plist with
3098 `:begin', `:end', `:contents-begin', `:contents-end',
3099 `:use-brackets-p' and `:post-blank' as keywords.
3101 Assume point is at the underscore."
3105 t
3116 :end end
3117 :use-brackets-p bracketsp
3118 :contents-begin contents-begin
3119 :contents-end contents-end
3123 "Interpret SUBSCRIPT object as Org syntax.
3124 CONTENTS is the contents of the object."
3127 contents))
3130 "Search for the next sub/superscript object.
3132 LIMIT bounds the search.
3134 Return value is a cons cell whose CAR is either `subscript' or
3135 `superscript' and CDR is beginning position."
3142 ;;;; Superscript
3145 "Parse superscript at point.
3147 Return a list whose CAR is `superscript' and CDR a plist with
3148 `:begin', `:end', `:contents-begin', `:contents-end',
3149 `:use-brackets-p' and `:post-blank' as keywords.
3151 Assume point is at the caret."
3165 :end end
3166 :use-brackets-p bracketsp
3167 :contents-begin contents-begin
3168 :contents-end contents-end
3172 "Interpret SUPERSCRIPT object as Org syntax.
3173 CONTENTS is the contents of the object."
3176 contents))
3179 ;;;; Table Cell
3182 "Parse table cell at point.
3184 Return a list whose CAR is `table-cell' and CDR is a plist
3185 containing `:begin', `:end', `:contents-begin', `:contents-end'
3186 and `:post-blank' keywords."
3194 :end end
3195 :contents-begin contents-begin
3196 :contents-end contents-end
3200 "Interpret TABLE-CELL element as Org syntax.
3201 CONTENTS is the contents of the cell, or nil."
3205 "Search for the next table-cell object.
3207 LIMIT bounds the search.
3209 Return value is a cons cell whose CAR is `table-cell' and CDR is
3210 beginning position."
3214 ;;;; Target
3217 "Parse target at point.
3219 Return a list whose CAR is `target' and CDR a plist with
3220 `:begin', `:end', `:value' and `:post-blank' as keywords.
3222 Assume point is at the target."
3232 :end end
3233 :value value
3237 "Interpret TARGET object as Org syntax.
3238 CONTENTS is nil."
3242 "Search for the next target object.
3244 LIMIT bounds the search.
3246 Return value is a cons cell whose CAR is `target' and CDR is
3247 beginning position."
3253 ;;;; Timestamp
3256 "Parse time stamp at point.
3258 Return a list whose CAR is `timestamp', and CDR a plist with
3259 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3261 Assume point is at the beginning of the timestamp."
3280 :value main-value
3281 :range-end range-end
3282 :begin begin
3283 :end end
3287 "Interpret TIMESTAMP object as Org syntax.
3288 CONTENTS is nil."
3297 range-end)))))))
3300 "Search for the next timestamp object.
3302 LIMIT bounds the search.
3304 Return value is a cons cell whose CAR is `timestamp' and CDR is
3305 beginning position."
3313 limit t)
3317 ;;;; Underline
3320 "Parse underline object at point.
3322 Return a list whose CAR is `underline' and CDR is a plist with
3323 `:begin', `:end', `:contents-begin' and `:contents-end' and
3324 `:post-blank' keywords.
3326 Assume point is at the first underscore marker."
3338 :end end
3339 :contents-begin contents-begin
3340 :contents-end contents-end
3344 "Interpret UNDERLINE object as Org syntax.
3345 CONTENTS is the contents of the object."
3349 ;;;; Verbatim
3352 "Parse verbatim object at point.
3354 Return a list whose CAR is `verbatim' and CDR is a plist with
3355 `:value', `:begin', `:end' and `:post-blank' keywords.
3357 Assume point is at the first equal sign marker."
3368 :begin begin
3369 :end end
3373 "Interpret VERBATIM object as Org syntax.
3374 CONTENTS is nil."
3378 \f
3379 ;;; Parsing Element Starting At Point
3380 ;;
3381 ;; `org-element--current-element' is the core function of this section.
3382 ;; It returns the Lisp representation of the element starting at
3383 ;; point.
3384 ;;
3385 ;; `org-element--current-element' makes use of special modes. They
3386 ;; are activated for fixed element chaining (i.e. `plain-list' >
3387 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3388 ;; `section'). Special modes are: `first-section', `item',
3389 ;; `node-property', `quote-section', `section' and `table-row'.
3393 "Parse the element starting at point.
3395 LIMIT bounds the search.
3397 Return value is a list like (TYPE PROPS) where TYPE is the type
3398 of the element and PROPS a plist of properties associated to the
3399 element.
3401 Possible types are defined in `org-element-all-elements'.
3403 Optional argument GRANULARITY determines the depth of the
3404 recursion. Allowed values are `headline', `greater-element',
3405 `element', `object' or nil. When it is broader than `object' (or
3406 nil), secondary values will not be parsed, since they only
3407 contain objects.
3409 Optional argument SPECIAL, when non-nil, can be either
3410 `first-section', `item', `node-property', `quote-section',
3411 `section', and `table-row'.
3413 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3414 be computed.
3416 This function assumes point is always at the beginning of the
3417 element it has to parse."
3420 ;; Determine if parsing depth allows for secondary strings
3421 ;; parsing. It only applies to elements referenced in
3422 ;; `org-element-secondary-value-alist'.
3425 ;; Item.
3428 ;; Table Row.
3430 ;; Node Property.
3432 ;; Headline.
3435 ;; Sections (must be checked after headline).
3441 limit)))
3442 ;; When not at bol, point is at the beginning of an item or
3443 ;; a footnote definition: next item is always a paragraph.
3445 ;; Planning and Clock.
3450 ;; Inlinetask.
3453 ;; From there, elements can have affiliated keywords.
3456 ;; LaTeX Environment.
3462 nil t))
3465 ;; Drawer and Property Drawer.
3475 ;; Fixed Width
3478 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3479 ;; Keywords.
3488 org-element-block-name-alist)))
3503 ;; Footnote Definition.
3506 ;; Horizontal Rule.
3509 ;; Table.
3511 ;; List.
3515 ;; Default element: Paragraph.
3519 ;; Most elements can have affiliated keywords. When looking for an
3520 ;; element beginning, we want to move before them, as they belong to
3521 ;; that element, and, in the meantime, collect information they give
3522 ;; into appropriate properties. Hence the following function.
3525 "Collect affiliated keywords from point.
3527 Return a list whose CAR is the position at the first of them and
3528 CDR a plist of keywords and values and move point to the
3529 beginning of the first line after them.
3531 As a special case, if element doesn't start at the beginning of
3532 the line (i.e. a paragraph starting an item), CAR is current
3533 position of point and CDR is nil."
3537 ;; RESTRICT is the list of objects allowed in parsed
3538 ;; keywords value.
3540 output)
3543 ;; Apply translation to RAW-KWD. From there, KWD is
3544 ;; the official keyword.
3546 org-element-keyword-translation-alist))
3547 raw-kwd))
3548 ;; Find main value for any keyword.
3554 ;; PARSEDP is non-nil when keyword should have its
3555 ;; value parsed.
3557 ;; If KWD is a dual keyword, find its secondary
3558 ;; value. Maybe parse it.
3565 ;; Attribute a property name to KWD.
3567 ;; Now set final shape for VALUE.
3572 ;; Attributes can always appear on multiple lines.
3575 ;; Eventually store the new value in OUTPUT.
3577 ;; Move to next keyword.
3579 ;; If affiliated keywords are orphaned: move back to first one.
3580 ;; They will be parsed as a paragraph.
3582 ;; Return value.
3586 \f
3587 ;;; The Org Parser
3588 ;;
3589 ;; The two major functions here are `org-element-parse-buffer', which
3590 ;; parses Org syntax inside the current buffer, taking into account
3591 ;; region, narrowing, or even visibility if specified, and
3592 ;; `org-element-parse-secondary-string', which parses objects within
3593 ;; a given string.
3594 ;;
3595 ;; The (almost) almighty `org-element-map' allows to apply a function
3596 ;; on elements or objects matching some type, and accumulate the
3597 ;; resulting values. In an export situation, it also skips unneeded
3598 ;; parts of the parse tree.
3601 "Recursively parse the buffer and return structure.
3602 If narrowing is in effect, only parse the visible part of the
3603 buffer.
3605 Optional argument GRANULARITY determines the depth of the
3606 recursion. It can be set to the following symbols:
3608 `headline' Only parse headlines.
3609 `greater-element' Don't recurse into greater elements excepted
3610 headlines and sections. Thus, elements
3611 parsed are the top-level ones.
3612 `element' Parse everything but objects and plain text.
3613 `object' Parse the complete buffer (default).
3615 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3616 elements.
3618 Assume buffer is in Org mode."
3624 ;; Start in `first-section' mode so text before the first
3625 ;; headline belongs to a section.
3629 "Recursively parse objects in STRING and return structure.
3631 RESTRICTION is a symbol limiting the object types that will be
3632 looked after.
3634 Optional argument PARENT, when non-nil, is the element or object
3635 containing the secondary string. It is used to set correctly
3636 `:parent' property within the string."
3642 secondary))))
3645 "Map a function on selected elements or objects.
3647 DATA is the parsed tree, as returned by, i.e,
3648 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3649 of elements or objects types. FUN is the function called on the
3650 matching element or object. It must accept one arguments: the
3651 element or object itself.
3653 When optional argument INFO is non-nil, it should be a plist
3654 holding export options. In that case, parts of the parse tree
3655 not exportable according to that property list will be skipped.
3657 When optional argument FIRST-MATCH is non-nil, stop at the first
3658 match for which FUN doesn't return nil, and return that value.
3660 Optional argument NO-RECURSION is a symbol or a list of symbols
3661 representing elements or objects types. `org-element-map' won't
3662 enter any recursive element or object whose type belongs to that
3663 list. Though, FUN can still be applied on them.
3665 Nil values returned from FUN do not appear in the results."
3666 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3669 ;; Recursion depth is determined by --CATEGORY.
3676 ;; If one object is found, the function
3677 ;; has to recurse into every object.
3680 ;; If one regular element is found, the
3681 ;; function has to recurse, at least,
3682 ;; into every element it encounters.
3685 types)
3686 category)))
3687 --acc
3688 --walk-tree
3692 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3693 ;; holding contextual information.
3697 ;; Ignored element in an export context.
3699 ;; Secondary string: only objects can be found there.
3702 ;; Unconditionally enter parse trees.
3706 ;; Check if TYPE is matching among TYPES. If so,
3707 ;; apply FUN to --DATA and accumulate return value
3708 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3714 ;; If --DATA has a secondary string that can contain
3715 ;; objects with their type among TYPES, look into it.
3722 ;; Determine if a recursion into --DATA is possible.
3724 ;; --TYPE is explicitly removed from recursion.
3726 ;; --DATA has no contents.
3728 ;; Looking for greater elements but --DATA is simply
3729 ;; an element or an object.
3732 ;; Looking for elements but --DATA is an object.
3735 ;; In any other case, map contents.
3739 ;; Return value in a proper order.
3742 ;; The following functions are internal parts of the parser.
3743 ;;
3744 ;; The first one, `org-element--parse-elements' acts at the element's
3745 ;; level.
3746 ;;
3747 ;; The second one, `org-element--parse-objects' applies on all objects
3748 ;; of a paragraph or a secondary string. It uses
3749 ;; `org-element--get-next-object-candidates' to optimize the search of
3750 ;; the next object in the buffer.
3751 ;;
3752 ;; More precisely, that function looks for every allowed object type
3753 ;; first. Then, it discards failed searches, keeps further matches,
3754 ;; and searches again types matched behind point, for subsequent
3755 ;; calls. Thus, searching for a given type fails only once, and every
3756 ;; object is searched only once at top level (but sometimes more for
3757 ;; nested types).
3761 "Parse elements between BEG and END positions.
3763 SPECIAL prioritize some elements over the others. It can be set
3764 to `first-section', `quote-section', `section' `item' or
3765 `table-row'.
3767 When value is `item', STRUCTURE will be used as the current list
3768 structure.
3770 GRANULARITY determines the depth of the recursion. See
3771 `org-element-parse-buffer' for more information.
3773 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3774 elements.
3776 Elements are accumulated into ACC."
3779 ;; When parsing only headlines, skip any text before first one.
3782 ;; Main loop start.
3784 ;; Find current element's type and parse it accordingly to
3785 ;; its category.
3787 end granularity special structure))
3791 ;; Fill ELEMENT contents by side-effect.
3793 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3794 ;; no contents, don't modify it.
3797 ;; Greater element: parse it between `contents-begin' and
3798 ;; `contents-end'. Make sure GRANULARITY allows the
3799 ;; recursion, or ELEMENT is an headline, in which case going
3800 ;; inside is mandatory, in order to get sub-level headings.
3808 ;; Possibly switch to a special mode.
3817 granularity visible-only element))
3818 ;; ELEMENT has contents. Parse objects inside, if
3819 ;; GRANULARITY allows it.
3825 ;; Return result.
3826 acc))
3829 "Parse objects between BEG and END and return recursive structure.
3831 Objects are accumulated in ACC.
3833 RESTRICTION is a list of object types which are allowed in the
3834 current object."
3840 end restriction candidates)))
3847 ;; 1. Text before any object. Untabify it.
3852 acc
3856 ;; 2. Object...
3859 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3860 ;; a recursive type.
3865 cont-beg
3872 ;; 3. Text after last object. Untabify it.
3876 acc
3880 ;; Result.
3881 acc)))
3884 "Return an alist of candidates for the next object.
3886 LIMIT bounds the search, and RESTRICTION narrows candidates to
3887 some object types.
3889 Return value is an alist whose CAR is position and CDR the object
3890 type, as a symbol.
3892 OBJECTS is the previous candidates alist."
3894 ;; If no previous result, search every object type in RESTRICTION.
3895 ;; Otherwise, keep potential candidates (old objects located after
3896 ;; point) and ask to search again those which had matched before.
3901 objects))
3902 ;; Call the appropriate successor function for each type to search
3903 ;; and accumulate matches.
3910 type))))
3913 types-to-search)
3914 ;; Return alist.
3915 next-candidates))
3918 \f
3919 ;;; Towards A Bijective Process
3920 ;;
3921 ;; The parse tree obtained with `org-element-parse-buffer' is really
3922 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3923 ;; interpreted and expanded into a string with canonical Org syntax.
3924 ;; Hence `org-element-interpret-data'.
3925 ;;
3926 ;; The function relies internally on
3927 ;; `org-element--interpret-affiliated-keywords'.
3929 ;;;###autoload
3931 "Interpret DATA as Org syntax.
3933 DATA is a parse tree, an element, an object or a secondary string
3934 to interpret.
3936 Optional argument PARENT is used for recursive calls. It contains
3937 the element or object containing data, or nil.
3939 Return Org syntax as a string."
3943 ;; Secondary string.
3948 ;; Full Org document.
3953 ;; Plain text.
3955 ;; Element/Object without contents.
3958 data nil))
3959 ;; Element/Object with contents.
3969 ;; Elements directly containing objects must
3970 ;; have their indentation normalized first.
3972 data
3973 ;; When normalizing first paragraph of an
3974 ;; item or a footnote-definition, ignore
3975 ;; first line's indentation.
3982 data
3984 contents)))))))
3986 ;; Build white spaces. If no `:post-blank' property is
3987 ;; specified, assume its value is 0.
3997 "Return ELEMENT's affiliated keywords as Org syntax.
3998 If there is no affiliated keyword, return the empty string."
4008 ": "
4011 value)
4019 ;; All attribute keywords can have multiple lines.
4025 ;; List all ELEMENT's properties matching an attribute line or an
4026 ;; affiliated keyword, but ignore translated keywords since they
4027 ;; cannot belong to the property list.
4034 org-element-keyword-translation-alist)))))
4035 collect prop)
4038 ;; Because interpretation of the parse tree must return the same
4039 ;; number of blank lines between elements and the same number of white
4040 ;; space after objects, some special care must be given to white
4041 ;; spaces.
4042 ;;
4043 ;; The first function, `org-element-normalize-string', ensures any
4044 ;; string different from the empty string will end with a single
4045 ;; newline character.
4046 ;;
4047 ;; The second function, `org-element-normalize-contents', removes
4048 ;; global indentation from the contents of the current element.
4051 "Ensure string S ends with a single newline character.
4053 If S isn't a string return it unchanged. If S is the empty
4054 string, return it. Otherwise, return a new string with a single
4055 newline character at its end."
4063 "Normalize plain text in ELEMENT's contents.
4065 ELEMENT must only contain plain text and objects.
4067 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4068 indentation to compute maximal common indentation.
4070 Return the normalized element that is element with global
4071 indentation removed from its contents. The function assumes that
4072 indentation is not done with TAB characters."
4074 collect-inds ; for byte-compiler
4077 ;; Return list of indentations within BLOB. This is done by
4078 ;; walking recursively BLOB and updating IND-LIST along the
4079 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4080 ;; been seen yet. It is required as this string is the only
4081 ;; one whose indentation doesn't happen after a newline
4082 ;; character.
4090 ;; An indentation of zero means no string will be
4091 ;; modified. Quit the process.
4097 ;; Avoid matching blank or empty lines.
4105 ;; Collect indentation list in ELEMENT. Possibly remove first
4106 ;; value if IGNORE-FIRST is non-nil.
4109 ;; Build ELEMENT back, replacing each string with the same
4110 ;; string minus common indentation.
4115 ;; Return BLOB with all its strings indentation
4116 ;; shortened from MCI white spaces. FIRST-FLAG is
4117 ;; non-nil when the first string hasn't been seen
4118 ;; yet.
4132 org-element-recursive-objects)
4136 blob))))
4140 \f
4141 ;;; The Toolbox
4142 ;;
4143 ;; The first move is to implement a way to obtain the smallest element
4144 ;; containing point. This is the job of `org-element-at-point'. It
4145 ;; basically jumps back to the beginning of section containing point
4146 ;; and moves, element after element, with
4147 ;; `org-element--current-element' until the container is found. Note:
4148 ;; When using `org-element-at-point', secondary values are never
4149 ;; parsed since the function focuses on elements, not on objects.
4150 ;;
4151 ;; At a deeper level, `org-element-context' lists all elements and
4152 ;; objects containing point.
4153 ;;
4154 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4155 ;; internally by navigation and manipulation tools.
4157 ;;;###autoload
4159 "Determine closest element around point.
4161 Return value is a list like (TYPE PROPS) where TYPE is the type
4162 of the element and PROPS a plist of properties associated to the
4163 element.
4165 Possible types are defined in `org-element-all-elements'.
4166 Properties depend on element or object type, but always
4167 include :begin, :end, :parent and :post-blank properties.
4169 As a special case, if point is at the very beginning of a list or
4170 sub-list, returned element will be that list instead of the first
4171 item. In the same way, if point is at the beginning of the first
4172 row of a table, returned element will be the table instead of the
4173 first row.
4175 If optional argument KEEP-TRAIL is non-nil, the function returns
4176 a list of of elements leading to element at point. The list's
4177 CAR is always the element at point. Following positions contain
4178 element's siblings, then parents, siblings of parents, until the
4179 first element of current section."
4181 ;; If at an headline, parse it. It is the sole element that
4182 ;; doesn't require to know about context. Be sure to disallow
4183 ;; secondary string parsing, though.
4189 ;; Otherwise move at the beginning of the section containing
4190 ;; point.
4194 element type special-flag trail struct prevs parent)
4202 ;; Parse successively each element, skipping those ending
4203 ;; before original position.
4212 ;; 1. Skip any element ending before point. Also skip
4213 ;; element ending at point when we're sure that another
4214 ;; element has started.
4219 ;; 2. An element containing point is always the element at
4220 ;; point.
4223 ;; 3. At any other greater element type, if point is
4224 ;; within contents, move into it.
4229 ;; Create an anchor for tables and plain lists:
4230 ;; when point is at the very beginning of these
4231 ;; elements, ignoring affiliated keywords,
4232 ;; target them instead of their contents.
4234 ;; When point is at contents end, do not move
4235 ;; into elements with an explicit ending, but
4236 ;; return that element instead.
4240 drawer dynamic-block inlinetask item
4241 plain-list property-drawer quote-block
4242 special-block))))
4255 ;;;###autoload
4257 "Return closest element or object around point.
4259 Return value is a list like (TYPE PROPS) where TYPE is the type
4260 of the element or object and PROPS a plist of properties
4261 associated to it.
4263 Possible types are defined in `org-element-all-elements' and
4264 `org-element-all-objects'. Properties depend on element or
4265 object type, but always include :begin, :end, :parent
4266 and :post-blank properties."
4271 end)
4272 ;; Check if point is inside an element containing objects or at
4273 ;; a secondary string. In that case, move to beginning of the
4274 ;; element or secondary string and set END to the other side.
4283 (<= origin
4284 ;; `1+' is required so some
4285 ;; successors can match
4286 ;; properly their object.
4300 element
4303 candidates)
4306 end restriction candidates))
4308 candidates)))
4309 ;; If ORIGIN is before next object in element, there's
4310 ;; no point in looking further.
4319 ;; ORIGIN is after OBJECT, so skip it.
4322 ;; ORIGIN is within a non-recursive object or at an
4323 ;; object boundaries: Return that object.
4327 ;; Otherwise, move within current object and restrict
4328 ;; search to the end of its contents.
4332 parent))))))
4335 "Non-nil when elements ELEM-A and ELEM-B are nested."
4344 "Swap elements ELEM-A and ELEM-B.
4345 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4346 end of ELEM-A."
4348 ;; There are two special cases when an element doesn't start at bol:
4349 ;; the first paragraph in an item or in a footnote definition.
4351 ;; Only a paragraph without any affiliated keyword can be moved at
4352 ;; ELEM-A position in such a situation. Note that the case of
4353 ;; a footnote definition is impossible: it cannot contain two
4354 ;; paragraphs in a row because it cannot contain a blank line.
4360 ;; In a special situation, ELEM-A will have no indentation. We'll
4361 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4375 ;; Store overlays responsible for visibility status. We
4376 ;; also need to store their boundaries as they will be
4377 ;; removed from buffer.
4384 ;; Get contents.
4392 ;; Restore ex ELEM-A overlays.
4401 ;; Restore ex ELEM-B overlays.
4410 ;;; org-element.el ends here