| blob | 0ca6231c780100d016604d88f904452e93189586 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
40 ;;
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
45 ;;
46 ;; Other element types are: `babel-call', `clock', `comment',
47 ;; `comment-block', `example-block', `export-block', `fixed-width',
48 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
49 ;; `planning', `property-drawer', `quote-section', `src-block',
50 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
51 ;; and `verse-block' types can contain Org objects and plain text.
52 ;;
53 ;; Objects are related to document's contents. Some of them are
54 ;; recursive. Associated types are of the following: `bold', `code',
55 ;; `entity', `export-snippet', `footnote-reference',
56 ;; `inline-babel-call', `inline-src-block', `italic',
57 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
58 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
59 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
60 ;;
61 ;; Some elements also have special properties whose value can hold
62 ;; objects themselves (i.e. an item tag or an headline name). Such
63 ;; values are called "secondary strings". Any object belongs to
64 ;; either an element or a secondary string.
65 ;;
66 ;; Notwithstanding affiliated keywords, each greater element, element
67 ;; and object has a fixed set of properties attached to it. Among
68 ;; them, four are shared by all types: `:begin' and `:end', which
69 ;; refer to the beginning and ending buffer positions of the
70 ;; considered element or object, `:post-blank', which holds the number
71 ;; of blank lines, or white spaces, at its end and `:parent' which
72 ;; refers to the element or object containing it. Greater elements
73 ;; and elements containing objects will also have `:contents-begin'
74 ;; and `:contents-end' properties to delimit contents.
75 ;;
76 ;; Lisp-wise, an element or an object can be represented as a list.
77 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
78 ;; TYPE is a symbol describing the Org element or object.
79 ;; PROPERTIES is the property list attached to it. See docstring of
80 ;; appropriate parsing function to get an exhaustive
81 ;; list.
82 ;; CONTENTS is a list of elements, objects or raw strings contained
83 ;; in the current element or object, when applicable.
84 ;;
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
87 ;;
88 ;; The first part of this file defines Org syntax, while the second
89 ;; one provide accessors and setters functions.
90 ;;
91 ;; The next part implements a parser and an interpreter for each
92 ;; element and object type in Org syntax.
93 ;;
94 ;; The following part creates a fully recursive buffer parser. It
95 ;; also provides a tool to map a function to elements or objects
96 ;; matching some criteria in the parse tree. Functions of interest
97 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
98 ;; extent, `org-element-parse-secondary-string'.
99 ;;
100 ;; The penultimate part is the cradle of an interpreter for the
101 ;; obtained parse tree: `org-element-interpret-data'.
102 ;;
103 ;; The library ends by furnishing `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 and inlinetasks.
129 ;; Comments, blocks (any type), keywords and babel calls.
131 ;; Lists.
133 ;; Fixed-width, drawers (any type) and tables.
135 ;; Footnote definitions.
137 ;; Horizontal rules.
139 ;; LaTeX environments.
141 ;; Planning and Clock lines.
142 org-planning-or-clock-line-re)
147 export-block fixed-width footnote-definition headline
148 horizontal-rule inlinetask item keyword latex-environment
149 babel-call paragraph plain-list planning property-drawer
150 quote-block quote-section section special-block src-block table
151 table-row verse-block)
156 item plain-list quote-block section special-block table)
161 latex-or-entity line-break link macro radio-target
162 statistics-cookie sub/superscript table-cell target
163 text-markup timestamp)
172 "Alist of translations between object type and successor name.
174 Sharing the same successor comes handy when, for example, the
179 inline-src-block italic line-break latex-fragment link macro
180 radio-target statistics-cookie strike-through subscript superscript
181 table-cell target timestamp underline verbatim)
186 table-cell underline)
196 "Alist between block names and the associated parsing function.
197 Names must be uppercase. Any block whose name has no association
203 "List of affiliated keywords as strings.
209 ;; Regular affiliated keywords.
212 "Regexp matching any affiliated keyword.
214 Keyword name is put in match group 1. Moreover, if keyword
215 belongs to `org-element-dual-keywords', put the dual value in
216 match group 2.
224 "Alist of usual translations for keywords.
225 The key is the old name and the value the new one. The property
229 "List of affiliated keywords that can occur more that once in an element.
231 Their value will be consed into a list of strings, which will be
232 returned as the value of the property.
234 This list is checked after translations have been applied. See
235 `org-element-keyword-translation-alist'.
241 "List of keywords whose value can be parsed.
243 Their value will be stored as a secondary string: a list of
244 strings and objects.
246 This list is checked after translations have been applied. See
250 "List of keywords which can have a secondary value.
252 In Org syntax, they can be written with optional square brackets
253 before the colons. For example, results keyword can be
254 associated to a hash value with the following:
256 #+RESULTS[hash-string]: some-source
258 This list is checked after translations have been applied. See
265 inline-src-block latex-or-entity line-break link macro
266 radio-target sub/superscript target text-markup
267 timestamp)
269 radio-target statistics-cookie sub/superscript target text-markup
270 timestamp)
282 inline-src-block latex-or-entity line-break link macro
283 radio-target statistics-cookie sub/superscript target text-markup
284 timestamp)
287 latex-or-entity link radio-target sub/superscript target
288 text-markup timestamp)
299 latex-or-entity line-break link macro radio-target
301 "Alist of objects restrictions.
303 CAR is an element or object type containing objects and CDR is
304 a list of successors that will be called within an element or
305 object of such type.
307 For example, in a `radio-target' object, one can only find
308 entities, export snippets, latex-fragments, subscript and
309 superscript.
311 This alist also applies to secondary string. For example, an
312 `headline' type element doesn't directly contain objects, but
323 \f
324 ;;; Accessors and Setters
325 ;;
326 ;; Provide four accessors: `org-element-type', `org-element-property'
327 ;; `org-element-contents' and `org-element-restriction'.
328 ;;
329 ;; Setter functions allow to modify elements by side effect. There is
330 ;; `org-element-put-property', `org-element-set-contents',
331 ;; `org-element-set-element' and `org-element-adopt-element'. Note
332 ;; that `org-element-set-element' and `org-element-adopt-element' are
333 ;; higher level functions since also update `:parent' property.
336 "Return type of ELEMENT.
338 The function returns the type of the element or object provided.
339 It can also return the following special value:
340 `plain-text' for a string
341 `org-data' for a complete document
342 nil in any other case."
348 "Extract the value from the PROPERTY of an ELEMENT."
352 "Extract contents from an ELEMENT."
356 "Return restriction associated to ELEMENT.
357 ELEMENT can be an element, an object or a symbol representing an
358 element or object type."
360 org-element-object-restrictions)))
363 "In ELEMENT set PROPERTY to VALUE.
364 Return modified element."
367 element)
370 "Set ELEMENT contents to CONTENTS.
371 Return modified element."
377 "Replace element or object OLD with element or object NEW.
378 The function takes care of setting `:parent' property for NEW."
379 ;; OLD can belong to the contents of PARENT or to its secondary
380 ;; string.
383 org-element-secondary-value-alist)))
386 ;; Make sure NEW has correct `:parent' property.
388 ;; Replace OLD with NEW in PARENT.
392 "Add an element to the contents of another element.
394 PARENT is an element or object. CHILD is an element, an object,
395 or a string.
397 CHILD is added at the beginning of PARENT contents, unless the
398 optional argument APPEND is non-nil, in which case CHILD is added
399 at the end.
401 The function takes care of setting `:parent' property for CHILD.
402 Return parent element."
406 parent
408 ;; Link the CHILD element with PARENT.
410 ;; Return the parent element.
411 parent))
414 \f
415 ;;; Greater elements
416 ;;
417 ;; For each greater element type, we define a parser and an
418 ;; interpreter.
419 ;;
420 ;; A parser returns the element or object as the list described above.
421 ;; Most of them accepts no argument. Though, exceptions exist. Hence
422 ;; every element containing a secondary string (see
423 ;; `org-element-secondary-value-alist') will accept an optional
424 ;; argument to toggle parsing of that secondary string. Moreover,
425 ;; `item' parser requires current list's structure as its first
426 ;; element.
427 ;;
428 ;; An interpreter accepts two arguments: the list representation of
429 ;; the element or object, and its contents. The latter may be nil,
430 ;; depending on the element or object considered. It returns the
431 ;; appropriate Org syntax, as a string.
432 ;;
433 ;; Parsing functions must follow the naming convention:
434 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
435 ;; defined in `org-element-greater-elements'.
436 ;;
437 ;; Similarly, interpreting functions must follow the naming
438 ;; convention: org-element-TYPE-interpreter.
439 ;;
440 ;; With the exception of `headline' and `item' types, greater elements
441 ;; cannot contain other greater elements of their own type.
442 ;;
443 ;; Beside implementing a parser and an interpreter, adding a new
444 ;; greater element requires to tweak `org-element--current-element'.
445 ;; Moreover, the newly defined type must be added to both
446 ;; `org-element-all-elements' and `org-element-greater-elements'.
449 ;;;; Center Block
452 "Parse a center block.
454 LIMIT bounds the search.
456 Return a list whose CAR is `center-block' and CDR is a plist
457 containing `:begin', `:end', `:hiddenp', `:contents-begin',
458 `:contents-end' and `:post-blank' keywords.
460 Assume point is at the beginning of the block."
464 ;; Incomplete block: parse it as a comment.
469 ;; Empty blocks have no contents.
483 :end end
484 :hiddenp hidden
485 :contents-begin contents-begin
486 :contents-end contents-end
491 "Interpret CENTER-BLOCK element as Org syntax.
492 CONTENTS is the contents of the element."
496 ;;;; Drawer
499 "Parse a drawer.
501 LIMIT bounds the search.
503 Return a list whose CAR is `drawer' and CDR is a plist containing
504 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
505 `:contents-end' and `:post-blank' keywords.
507 Assume point is at beginning of drawer."
510 ;; Incomplete drawer: parse it as a paragraph.
519 ;; Empty drawers have no contents.
533 :end end
534 :drawer-name name
535 :hiddenp hidden
536 :contents-begin contents-begin
537 :contents-end contents-end
542 "Interpret DRAWER element as Org syntax.
543 CONTENTS is the contents of the element."
546 contents))
549 ;;;; Dynamic Block
552 "Parse a dynamic block.
554 LIMIT bounds the search.
556 Return a list whose CAR is `dynamic-block' and CDR is a plist
557 containing `:block-name', `:begin', `:end', `:hiddenp',
558 `:contents-begin', `:contents-end', `:arguments' and
559 `:post-blank' keywords.
561 Assume point is at beginning of dynamic block."
564 ;; Incomplete block: parse it as a comment.
573 ;; Empty blocks have no contents.
587 :end end
588 :block-name name
589 :arguments arguments
590 :hiddenp hidden
591 :contents-begin contents-begin
592 :contents-end contents-end
597 "Interpret DYNAMIC-BLOCK element as Org syntax.
598 CONTENTS is the contents of the element."
603 contents))
606 ;;;; Footnote Definition
609 "Parse a footnote definition.
611 LIMIT bounds the search.
613 Return a list whose CAR is `footnote-definition' and CDR is
614 a plist containing `:label', `:begin' `:end', `:contents-begin',
615 `:contents-end' and `:post-blank' keywords.
617 Assume point is at the beginning of the footnote definition."
642 :begin begin
643 :end end
644 :contents-begin contents-begin
645 :contents-end contents-end
650 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
651 CONTENTS is the contents of the footnote-definition."
653 " "
654 contents))
657 ;;;; Headline
660 "Parse an headline.
662 Return a list whose CAR is `headline' and CDR is a plist
663 containing `:raw-value', `:title', `:begin', `:end',
664 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
665 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
666 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
667 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
668 keywords.
670 The plist also contains any property set in the property drawer,
671 with its name in lowercase, the underscores replaced with hyphens
672 and colons at the beginning (i.e. `:custom-id').
674 When RAW-SECONDARY-P is non-nil, headline's title will not be
675 parsed as a secondary string, but as a plain string instead.
677 Assume point is at beginning of the headline."
696 ;; Normalize property names: ":SOME_PROP:" becomes
697 ;; ":some-prop".
709 plist))
727 ;; Clean RAW-VALUE from any quote or comment string.
732 ""
733 raw-value)))
734 ;; Clean TAGS from archive tag, if any.
740 :begin begin
741 :end end
742 :pre-blank
745 :hiddenp hidden
746 :contents-begin contents-begin
747 :contents-end contents-end
748 :level level
750 :tags tags
751 :todo-keyword todo
752 :todo-type todo-type
753 :scheduled scheduled
754 :deadline deadline
755 :timestamp timestamp
756 :clock clock
762 end)
763 :footnote-section-p footnote-section-p
764 :archivedp archivedp
765 :commentedp commentedp
767 standard-props))))
769 headline :title
775 "Interpret HEADLINE element as Org syntax.
776 CONTENTS is the contents of the element."
803 ;; Align tags.
811 ? )
812 tags))
816 tags))))
818 contents)))
821 ;;;; Inlinetask
824 "Parse an inline task.
826 Return a list whose CAR is `inlinetask' and CDR is a plist
827 containing `:title', `:begin', `:end', `:hiddenp',
828 `:contents-begin' and `:contents-end', `:level', `:priority',
829 `:tags', `:todo-keyword', `:todo-type', `:scheduled',
830 `:deadline', `:timestamp', `:clock' and `:post-blank' keywords.
832 The plist also contains any property set in the property drawer,
833 with its name in lowercase, the underscores replaced with hyphens
834 and colons at the beginning (i.e. `:custom-id').
836 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
837 title will not be parsed as a secondary string, but as a plain
838 string instead.
840 Assume point is at beginning of the inline task."
850 ;; Normalize property names: ":SOME_PROP:" becomes
851 ;; ":some-prop".
863 plist))
887 :end end
888 :hiddenp hidden
889 :contents-begin contents-begin
890 :contents-end contents-end
893 :tags tags
894 :todo-keyword todo
895 :todo-type todo-type
896 :scheduled scheduled
897 :deadline deadline
898 :timestamp timestamp
899 :clock clock
901 standard-props
904 inlinetask :title
909 inlinetask))))))
912 "Interpret INLINETASK element as Org syntax.
913 CONTENTS is the contents of inlinetask."
928 ;; Align tags.
936 ? )
937 tags))
941 tags))))
942 ;; Prefer degenerate inlinetasks when there are no
943 ;; contents.
946 contents
950 ;;;; Item
953 "Parse an item.
955 STRUCT is the structure of the plain list.
957 Return a list whose CAR is `item' and CDR is a plist containing
958 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
959 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
960 `:post-blank' keywords.
962 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
963 any, will not be parsed as a secondary string, but as a plain
964 string instead.
966 Assume point is at the beginning of the item."
989 ;; If first line isn't empty,
990 ;; contents really start at the text
991 ;; after item's meta-data.
1004 :begin begin
1005 :end end
1006 ;; CONTENTS-BEGIN and CONTENTS-END may be
1007 ;; mixed up in the case of an empty item
1008 ;; separated from the next by a blank line.
1009 ;; Thus ensure the former is always the
1010 ;; smallest.
1013 :checkbox checkbox
1014 :counter counter
1015 :hiddenp hidden
1016 :structure struct
1019 item :tag
1027 "Interpret ITEM element as Org syntax.
1028 CONTENTS is the contents of the element."
1034 ;; Compute indentation.
1039 ;; Indent contents.
1041 bullet
1054 ;;;; Plain List
1057 "Parse a plain list.
1059 Optional argument STRUCTURE, when non-nil, is the structure of
1060 the plain list being parsed.
1062 Return a list whose CAR is `plain-list' and CDR is a plist
1063 containing `:type', `:begin', `:end', `:contents-begin' and
1064 `:contents-end', `:structure' and `:post-blank' keywords.
1066 Assume point is at the beginning of the list."
1081 ;; Return value.
1085 :begin begin
1086 :end end
1087 :contents-begin contents-begin
1088 :contents-end contents-end
1089 :structure struct
1094 "Interpret PLAIN-LIST element as Org syntax.
1095 CONTENTS is the contents of the element."
1103 ;;;; Quote Block
1106 "Parse a quote block.
1108 LIMIT bounds the search.
1110 Return a list whose CAR is `quote-block' and CDR is a plist
1111 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1112 `:contents-end' and `:post-blank' keywords.
1114 Assume point is at the beginning of the block."
1118 ;; Incomplete block: parse it as a comment.
1124 ;; Empty blocks have no contents.
1138 :end end
1139 :hiddenp hidden
1140 :contents-begin contents-begin
1141 :contents-end contents-end
1146 "Interpret QUOTE-BLOCK element as Org syntax.
1147 CONTENTS is the contents of the element."
1151 ;;;; Section
1154 "Parse a section.
1156 LIMIT bounds the search.
1158 Return a list whose CAR is `section' and CDR is a plist
1159 containing `:begin', `:end', `:contents-begin', `contents-end'
1160 and `:post-blank' keywords."
1162 ;; Beginning of section is the beginning of the first non-blank
1163 ;; line after previous headline.
1172 :end end
1173 :contents-begin begin
1174 :contents-end pos-before-blank
1178 "Interpret SECTION element as Org syntax.
1179 CONTENTS is the contents of the element."
1180 contents)
1183 ;;;; Special Block
1186 "Parse a special block.
1188 LIMIT bounds the search.
1190 Return a list whose CAR is `special-block' and CDR is a plist
1191 containing `:type', `:begin', `:end', `:hiddenp',
1192 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1194 Assume point is at the beginning of the block."
1200 ;; Incomplete block: parse it as a comment.
1206 ;; Empty blocks have no contents.
1220 :begin begin
1221 :end end
1222 :hiddenp hidden
1223 :contents-begin contents-begin
1224 :contents-end contents-end
1229 "Interpret SPECIAL-BLOCK element as Org syntax.
1230 CONTENTS is the contents of the element."
1235 \f
1236 ;;; Elements
1237 ;;
1238 ;; For each element, a parser and an interpreter are also defined.
1239 ;; Both follow the same naming convention used for greater elements.
1240 ;;
1241 ;; Also, as for greater elements, adding a new element type is done
1242 ;; through the following steps: implement a parser and an interpreter,
1243 ;; tweak `org-element--current-element' so that it recognizes the new
1244 ;; type and add that new type to `org-element-all-elements'.
1245 ;;
1246 ;; As a special case, when the newly defined type is a block type,
1247 ;; `org-element-block-name-alist' has to be modified accordingly.
1250 ;;;; Babel Call
1253 "Parse a babel call.
1255 LIMIT bounds the search.
1257 Return a list whose CAR is `babel-call' and CDR is a plist
1258 containing `:begin', `:end', `:info' and `:post-blank' as
1259 keywords."
1270 :end end
1271 :info info
1275 "Interpret BABEL-CALL element as Org syntax.
1276 CONTENTS is nil."
1282 ;; Remove redundant square brackets.
1287 ;;;; Clock
1290 "Parse a clock.
1292 LIMIT bounds the search.
1294 Return a list whose CAR is `clock' and CDR is a plist containing
1295 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1296 as keywords."
1315 :value value
1316 :time time
1317 :begin begin
1318 :end end
1322 "Interpret CLOCK element as Org syntax.
1323 CONTENTS is nil."
1330 "%2s:%02s"
1334 ;;;; Comment
1337 "Parse a comment.
1339 LIMIT bounds the search.
1341 Return a list whose CAR is `comment' and CDR is a plist
1342 containing `:begin', `:end', `:value' and `:post-blank'
1343 keywords.
1345 Assume point is at comment beginning."
1349 ;; Match first line with a loose regexp since it might as
1350 ;; well be an ill-defined keyword.
1356 ;; Get comments ending.
1359 ;; Accumulate lines without leading hash and first
1360 ;; whitespace.
1374 :end end
1375 :value value
1380 "Interpret COMMENT element as Org syntax.
1381 CONTENTS is nil."
1385 ;;;; Comment Block
1388 "Parse an export block.
1390 LIMIT bounds the search.
1392 Return a list whose CAR is `comment-block' and CDR is a plist
1393 containing `:begin', `:end', `:hiddenp', `:value' and
1394 `:post-blank' keywords.
1396 Assume point is at comment block beginning."
1400 ;; Incomplete block: parse it as a comment.
1414 contents-begin contents-end)))
1418 :end end
1419 :value value
1420 :hiddenp hidden
1425 "Interpret COMMENT-BLOCK element as Org syntax.
1426 CONTENTS is nil."
1431 ;;;; Example Block
1434 "Parse an example block.
1436 LIMIT bounds the search.
1438 Return a list whose CAR is `example-block' and CDR is a plist
1439 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1440 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1441 `:switches', `:value' and `:post-blank' keywords."
1445 ;; Incomplete block: parse it as a comment.
1452 ;; Switches analysis
1457 ;; Should labels be retained in (or stripped from) example
1458 ;; blocks?
1463 ;; What should code-references use - labels or
1464 ;; line-numbers?
1471 ;; Standard block parsing.
1485 :end end
1486 :value value
1487 :switches switches
1488 :number-lines number-lines
1489 :preserve-indent preserve-indent
1490 :retain-labels retain-labels
1491 :use-labels use-labels
1492 :label-fmt label-fmt
1493 :hiddenp hidden
1498 "Interpret EXAMPLE-BLOCK element as Org syntax.
1499 CONTENTS is nil."
1507 ;;;; Export Block
1510 "Parse an export block.
1512 LIMIT bounds the search.
1514 Return a list whose CAR is `export-block' and CDR is a plist
1515 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1516 `:post-blank' keywords.
1518 Assume point is at export-block beginning."
1524 ;; Incomplete block: parse it as a comment.
1538 contents-end)))
1542 :end end
1543 :type type
1544 :value value
1545 :hiddenp hidden
1550 "Interpret EXPORT-BLOCK element as Org syntax.
1551 CONTENTS is nil."
1558 ;;;; Fixed-width
1561 "Parse a fixed-width section.
1563 LIMIT bounds the search.
1565 Return a list whose CAR is `fixed-width' and CDR is a plist
1566 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1568 Assume point is at the beginning of the fixed-width area."
1572 value
1577 ;; Accumulate text without starting colons.
1590 :end end
1591 :value value
1596 "Interpret FIXED-WIDTH element as Org syntax.
1597 CONTENTS is nil."
1602 ;;;; Horizontal Rule
1605 "Parse an horizontal rule.
1607 LIMIT bounds the search.
1609 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1610 containing `:begin', `:end' and `:post-blank' keywords."
1620 :end end
1625 "Interpret HORIZONTAL-RULE element as Org syntax.
1626 CONTENTS is nil."
1630 ;;;; Keyword
1633 "Parse a keyword at point.
1635 LIMIT bounds the search.
1637 Return a list whose CAR is `keyword' and CDR is a plist
1638 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1639 keywords."
1652 :value value
1653 :begin begin
1654 :end end
1658 "Interpret KEYWORD element as Org syntax.
1659 CONTENTS is nil."
1665 ;;;; Latex Environment
1668 "Parse a LaTeX environment.
1670 LIMIT bounds the search.
1672 Return a list whose CAR is `latex-environment' and CDR is a plist
1673 containing `:begin', `:end', `:value' and `:post-blank'
1674 keywords.
1676 Assume point is at the beginning of the latex environment."
1694 :end end
1695 :value value
1700 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1701 CONTENTS is nil."
1705 ;;;; Paragraph
1708 "Parse a paragraph.
1710 LIMIT bounds the search.
1712 Return a list whose CAR is `paragraph' and CDR is a plist
1713 containing `:begin', `:end', `:contents-begin' and
1714 `:contents-end' and `:post-blank' keywords.
1716 Assume point is at the beginning of the paragraph."
1724 limit
1734 ;; If paragraph has no affiliated keywords, it may not begin
1735 ;; at beginning of line if it starts an item.
1738 :end end
1739 :contents-begin contents-begin
1740 :contents-end contents-end
1745 "Interpret PARAGRAPH element as Org syntax.
1746 CONTENTS is the contents of the element."
1747 contents)
1750 ;;;; Planning
1753 "Parse a planning.
1755 LIMIT bounds the search.
1757 Return a list whose CAR is `planning' and CDR is a plist
1758 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1759 and `:post-blank' keywords."
1768 closed deadline scheduled)
1782 :deadline deadline
1783 :scheduled scheduled
1784 :begin begin
1785 :end end
1789 "Interpret PLANNING element as Org syntax.
1790 CONTENTS is nil."
1792 'identity
1804 ;;;; Property Drawer
1807 "Parse a property drawer.
1809 LIMIT bounds the search.
1811 Return a list whose CAR is `property-drawer' and CDR is a plist
1812 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1813 `:contents-end', `:properties' and `:post-blank' keywords.
1815 Assume point is at the beginning of the property drawer."
1829 val))
1831 val))
1839 :end end
1840 :hiddenp hidden
1841 :properties properties
1845 "Interpret PROPERTY-DRAWER element as Org syntax.
1846 CONTENTS is nil."
1856 ;;;; Quote Section
1859 "Parse a quote section.
1861 LIMIT bounds the search.
1863 Return a list whose CAR is `quote-section' and CDR is a plist
1864 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1866 Assume point is at beginning of the section."
1877 :end end
1878 :value value
1882 "Interpret QUOTE-SECTION element as Org syntax.
1883 CONTENTS is nil."
1887 ;;;; Src Block
1890 "Parse a src block.
1892 LIMIT bounds the search.
1894 Return a list whose CAR is `src-block' and CDR is a plist
1895 containing `:language', `:switches', `:parameters', `:begin',
1896 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1897 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1898 `:post-blank' keywords.
1900 Assume point is at the beginning of the block."
1903 ;; Incomplete block: parse it as a comment.
1908 ;; Get beginning position.
1910 ;; Get language as a string.
1919 ;; Get switches.
1921 ;; Get parameters.
1923 ;; Switches analysis
1931 ;; Should labels be retained in (or stripped from)
1932 ;; src blocks?
1937 ;; What should code-references use - labels or
1938 ;; line-numbers?
1942 ;; Get visibility status.
1944 ;; Retrieve code.
1949 ;; Get position after ending blank lines.
1959 :begin begin
1960 :end end
1961 :number-lines number-lines
1962 :preserve-indent preserve-indent
1963 :retain-labels retain-labels
1964 :use-labels use-labels
1965 :label-fmt label-fmt
1966 :hiddenp hidden
1967 :value value
1972 "Interpret SRC-BLOCK element as Org syntax.
1973 CONTENTS is nil."
1993 value
1997 ;;;; Table
2000 "Parse a table at point.
2002 LIMIT bounds the search.
2004 Return a list whose CAR is `table' and CDR is a plist containing
2005 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2006 `:contents-end', `:value' and `:post-blank' keywords.
2008 Assume point is at the beginning of the table."
2020 acc))
2027 :end end
2028 :type type
2029 :tblfm tblfm
2030 ;; Only `org' tables have contents. `table.el' tables
2031 ;; use a `:value' property to store raw table as
2032 ;; a string.
2037 table-begin table-end))
2042 "Interpret TABLE element as Org syntax.
2043 CONTENTS is nil."
2054 ;;;; Table Row
2057 "Parse table row at point.
2059 LIMIT bounds the search.
2061 Return a list whose CAR is `table-row' and CDR is a plist
2062 containing `:begin', `:end', `:contents-begin', `:contents-end',
2063 `:type' and `:post-blank' keywords."
2067 ;; A table rule has no contents. In that case, ensure
2068 ;; CONTENTS-BEGIN matches CONTENTS-END.
2080 :begin begin
2081 :end end
2082 :contents-begin contents-begin
2083 :contents-end contents-end
2087 "Interpret TABLE-ROW element as Org syntax.
2088 CONTENTS is the contents of the table row."
2093 ;;;; Verse Block
2096 "Parse a verse block.
2098 LIMIT bounds the search.
2100 Return a list whose CAR is `verse-block' and CDR is a plist
2101 containing `:begin', `:end', `:contents-begin', `:contents-end',
2102 `:hiddenp' and `:post-blank' keywords.
2104 Assume point is at beginning of the block."
2108 ;; Incomplete block: parse it as a comment.
2124 :end end
2125 :contents-begin contents-begin
2126 :contents-end contents-end
2127 :hiddenp hidden
2132 "Interpret VERSE-BLOCK element as Org syntax.
2133 CONTENTS is verse block contents."
2137 \f
2138 ;;; Objects
2139 ;;
2140 ;; Unlike to elements, interstices can be found between objects.
2141 ;; That's why, along with the parser, successor functions are provided
2142 ;; for each object. Some objects share the same successor (i.e. `code'
2143 ;; and `verbatim' objects).
2144 ;;
2145 ;; A successor must accept a single argument bounding the search. It
2146 ;; will return either a cons cell whose CAR is the object's type, as
2147 ;; a symbol, and CDR the position of its next occurrence, or nil.
2148 ;;
2149 ;; Successors follow the naming convention:
2150 ;; org-element-NAME-successor, where NAME is the name of the
2151 ;; successor, as defined in `org-element-all-successors'.
2152 ;;
2153 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2154 ;; object types they can contain will be specified in
2155 ;; `org-element-object-restrictions'.
2156 ;;
2157 ;; Adding a new type of object is simple. Implement a successor,
2158 ;; a parser, and an interpreter for it, all following the naming
2159 ;; convention. Register type in `org-element-all-objects' and
2160 ;; successor in `org-element-all-successors'. Maybe tweak
2161 ;; restrictions about it, and that's it.
2164 ;;;; Bold
2167 "Parse bold object at point.
2169 Return a list whose CAR is `bold' and CDR is a plist with
2170 `:begin', `:end', `:contents-begin' and `:contents-end' and
2171 `:post-blank' keywords.
2173 Assume point is at the first star marker."
2185 :end end
2186 :contents-begin contents-begin
2187 :contents-end contents-end
2191 "Interpret BOLD object as Org syntax.
2192 CONTENTS is the contents of the object."
2196 "Search for the next text-markup object.
2198 LIMIT bounds the search.
2200 LIMIT bounds the search.
2202 Return value is a cons cell whose CAR is a symbol among `bold',
2203 `italic', `underline', `strike-through', `code' and `verbatim'
2204 and CDR is beginning position."
2220 ;;;; Code
2223 "Parse code object at point.
2225 Return a list whose CAR is `code' and CDR is a plist with
2226 `:value', `:begin', `:end' and `:post-blank' keywords.
2228 Assume point is at the first tilde marker."
2239 :begin begin
2240 :end end
2244 "Interpret CODE object as Org syntax.
2245 CONTENTS is nil."
2249 ;;;; Entity
2252 "Parse entity at point.
2254 Return a list whose CAR is `entity' and CDR a plist with
2255 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2256 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2257 keywords.
2259 Assume point is at the beginning of the entity."
2261 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2277 :begin begin
2278 :end end
2279 :use-brackets-p bracketsp
2283 "Interpret ENTITY object as Org syntax.
2284 CONTENTS is nil."
2290 "Search for the next latex-fragment or entity object.
2292 LIMIT bounds the search.
2294 Return value is a cons cell whose CAR is `entity' or
2295 `latex-fragment' and CDR is beginning position."
2298 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2305 limit t)
2308 ;; Determine if it's a real entity or a LaTeX command.
2311 ;; No entity nor command: point is at a LaTeX fragment.
2312 ;; Determine its type to get the correct beginning position.
2320 matchers)
2324 ;;;; Export Snippet
2327 "Parse export snippet at point.
2329 Return a list whose CAR is `export-snippet' and CDR a plist with
2330 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2331 keywords.
2333 Assume point is at the beginning of the snippet."
2345 :value value
2346 :begin begin
2347 :end end
2351 "Interpret EXPORT-SNIPPET object as Org syntax.
2352 CONTENTS is nil."
2358 "Search for the next export-snippet object.
2360 LIMIT bounds the search.
2362 Return value is a cons cell whose CAR is `export-snippet' and CDR
2363 its beginning position."
2372 ;;;; Footnote Reference
2375 "Parse footnote reference at point.
2377 Return a list whose CAR is `footnote-reference' and CDR a plist
2378 with `:label', `:type', `:inline-definition', `:begin', `:end'
2379 and `:post-blank' as keywords."
2401 :type type
2402 :begin begin
2403 :end end
2406 footnote-reference :inline-definition
2411 footnote-reference))))))
2414 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2415 CONTENTS is nil."
2425 "Search for the next footnote-reference object.
2427 LIMIT bounds the search.
2429 Return value is a cons cell whose CAR is `footnote-reference' and
2430 CDR is beginning position."
2444 ;;;; Inline Babel Call
2447 "Parse inline babel call at point.
2449 Return a list whose CAR is `inline-babel-call' and CDR a plist
2450 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2452 Assume point is at the beginning of the babel call."
2463 :end end
2464 :info info
2468 "Interpret INLINE-BABEL-CALL object as Org syntax.
2469 CONTENTS is nil."
2475 ;; Remove redundant square brackets.
2478 main-source)
2482 "Search for the next inline-babel-call object.
2484 LIMIT bounds the search.
2486 Return value is a cons cell whose CAR is `inline-babel-call' and
2487 CDR is beginning position."
2489 ;; Use a simplified version of
2490 ;; org-babel-inline-lob-one-liner-regexp as regexp for more speed.
2492 "\\(?:babel\\|call\\)_\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\([^\n]*\\))\\(\\[\\(.*?\\)\\]\\)?"
2493 limit t)
2497 ;;;; Inline Src Block
2500 "Parse inline source block at point.
2502 LIMIT bounds the search.
2504 Return a list whose CAR is `inline-src-block' and CDR a plist
2505 with `:begin', `:end', `:language', `:value', `:parameters' and
2506 `:post-blank' as keywords.
2508 Assume point is at the beginning of the inline src block."
2521 :value value
2522 :parameters parameters
2523 :begin begin
2524 :end end
2528 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2529 CONTENTS is nil."
2534 language
2536 body)))
2539 "Search for the next inline-babel-call element.
2541 LIMIT bounds the search.
2543 Return value is a cons cell whose CAR is `inline-babel-call' and
2544 CDR is beginning position."
2549 ;;;; Italic
2552 "Parse italic object at point.
2554 Return a list whose CAR is `italic' and CDR is a plist with
2555 `:begin', `:end', `:contents-begin' and `:contents-end' and
2556 `:post-blank' keywords.
2558 Assume point is at the first slash marker."
2570 :end end
2571 :contents-begin contents-begin
2572 :contents-end contents-end
2576 "Interpret ITALIC object as Org syntax.
2577 CONTENTS is the contents of the object."
2581 ;;;; Latex Fragment
2584 "Parse latex fragment at point.
2586 Return a list whose CAR is `latex-fragment' and CDR a plist with
2587 `:value', `:begin', `:end', and `:post-blank' as keywords.
2589 Assume point is at the beginning of the latex fragment."
2603 ;; None found: it's a macro.
2612 :begin begin
2613 :end end
2617 "Interpret LATEX-FRAGMENT object as Org syntax.
2618 CONTENTS is nil."
2621 ;;;; Line Break
2624 "Parse line break at point.
2626 Return a list whose CAR is `line-break', and CDR a plist with
2627 `:begin', `:end' and `:post-blank' keywords.
2629 Assume point is at the beginning of the line break."
2633 "Interpret LINE-BREAK object as Org syntax.
2634 CONTENTS is nil."
2638 "Search for the next line-break object.
2640 LIMIT bounds the search.
2642 Return value is a cons cell whose CAR is `line-break' and CDR is
2643 beginning position."
2647 ;; A line break can only happen on a non-empty line.
2652 ;;;; Link
2655 "Parse link at point.
2657 Return a list whose CAR is `link' and CDR a plist with `:type',
2658 `:path', `:raw-link', `:begin', `:end', `:contents-begin',
2659 `:contents-end' and `:post-blank' as keywords.
2661 Assume point is at the beginning of the link."
2664 end contents-begin contents-end link-end post-blank path type
2665 raw-link link)
2667 ;; Type 1: Text targeted from a radio target.
2672 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2677 ;; RAW-LINK is the original link.
2682 ;; Determine TYPE of link and set PATH accordingly.
2684 ;; File type.
2687 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2690 ;; Id type: PATH is the id.
2693 ;; Code-ref type: PATH is the name of the reference.
2696 ;; Custom-id type: PATH is the name of the custom id.
2699 ;; Fuzzy type: Internal link either matches a target, an
2700 ;; headline name or nothing. PATH is the target or
2701 ;; headline's name.
2703 ;; Type 3: Plain link, i.e. http://orgmode.org
2709 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2716 ;; In any case, deduce end point after trailing white space from
2717 ;; LINK-END variable.
2722 :path path
2724 :begin begin
2725 :end end
2726 :contents-begin contents-begin
2727 :contents-end contents-end
2731 "Interpret LINK object as Org syntax.
2732 CONTENTS is the contents of the object, or nil."
2737 raw-link
2741 "Search for the next link object.
2743 LIMIT bounds the search.
2745 Return value is a cons cell whose CAR is `link' and CDR is
2746 beginning position."
2755 ;;;; Macro
2758 "Parse macro at point.
2760 Return a list whose CAR is `macro' and CDR a plist with `:key',
2761 `:args', `:begin', `:end', `:value' and `:post-blank' as
2762 keywords.
2764 Assume point is at the macro."
2778 ;; Repair bad splits.
2786 :value value
2787 :args args
2788 :begin begin
2789 :end end
2793 "Interpret MACRO object as Org syntax.
2794 CONTENTS is nil."
2798 "Search for the next macro object.
2800 LIMIT bounds the search.
2802 Return value is cons cell whose CAR is `macro' and CDR is
2803 beginning position."
2807 limit t)
2811 ;;;; Radio-target
2814 "Parse radio target at point.
2816 Return a list whose CAR is `radio-target' and CDR a plist with
2817 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2818 and `:post-blank' as keywords.
2820 Assume point is at the radio target."
2832 :end end
2833 :contents-begin contents-begin
2834 :contents-end contents-end
2835 :post-blank post-blank
2839 "Interpret TARGET object as Org syntax.
2840 CONTENTS is the contents of the object."
2844 "Search for the next radio-target object.
2846 LIMIT bounds the search.
2848 Return value is a cons cell whose CAR is `radio-target' and CDR
2849 is beginning position."
2855 ;;;; Statistics Cookie
2858 "Parse statistics cookie at point.
2860 Return a list whose CAR is `statistics-cookie', and CDR a plist
2861 with `:begin', `:end', `:value' and `:post-blank' keywords.
2863 Assume point is at the beginning of the statistics-cookie."
2874 :end end
2875 :value value
2879 "Interpret STATISTICS-COOKIE object as Org syntax.
2880 CONTENTS is nil."
2884 "Search for the next statistics cookie object.
2886 LIMIT bounds the search.
2888 Return value is a cons cell whose CAR is `statistics-cookie' and
2889 CDR is beginning position."
2895 ;;;; Strike-Through
2898 "Parse strike-through object at point.
2900 Return a list whose CAR is `strike-through' and CDR is a plist
2901 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2902 `:post-blank' keywords.
2904 Assume point is at the first plus sign marker."
2916 :end end
2917 :contents-begin contents-begin
2918 :contents-end contents-end
2922 "Interpret STRIKE-THROUGH object as Org syntax.
2923 CONTENTS is the contents of the object."
2927 ;;;; Subscript
2930 "Parse subscript at point.
2932 Return a list whose CAR is `subscript' and CDR a plist with
2933 `:begin', `:end', `:contents-begin', `:contents-end',
2934 `:use-brackets-p' and `:post-blank' as keywords.
2936 Assume point is at the underscore."
2940 t
2951 :end end
2952 :use-brackets-p bracketsp
2953 :contents-begin contents-begin
2954 :contents-end contents-end
2958 "Interpret SUBSCRIPT object as Org syntax.
2959 CONTENTS is the contents of the object."
2962 contents))
2965 "Search for the next sub/superscript object.
2967 LIMIT bounds the search.
2969 Return value is a cons cell whose CAR is either `subscript' or
2970 `superscript' and CDR is beginning position."
2977 ;;;; Superscript
2980 "Parse superscript at point.
2982 Return a list whose CAR is `superscript' and CDR a plist with
2983 `:begin', `:end', `:contents-begin', `:contents-end',
2984 `:use-brackets-p' and `:post-blank' as keywords.
2986 Assume point is at the caret."
3000 :end end
3001 :use-brackets-p bracketsp
3002 :contents-begin contents-begin
3003 :contents-end contents-end
3007 "Interpret SUPERSCRIPT object as Org syntax.
3008 CONTENTS is the contents of the object."
3011 contents))
3014 ;;;; Table Cell
3017 "Parse table cell at point.
3019 Return a list whose CAR is `table-cell' and CDR is a plist
3020 containing `:begin', `:end', `:contents-begin', `:contents-end'
3021 and `:post-blank' keywords."
3029 :end end
3030 :contents-begin contents-begin
3031 :contents-end contents-end
3035 "Interpret TABLE-CELL element as Org syntax.
3036 CONTENTS is the contents of the cell, or nil."
3040 "Search for the next table-cell object.
3042 LIMIT bounds the search.
3044 Return value is a cons cell whose CAR is `table-cell' and CDR is
3045 beginning position."
3049 ;;;; Target
3052 "Parse target at point.
3054 Return a list whose CAR is `target' and CDR a plist with
3055 `:begin', `:end', `:value' and `:post-blank' as keywords.
3057 Assume point is at the target."
3067 :end end
3068 :value value
3072 "Interpret TARGET object as Org syntax.
3073 CONTENTS is nil."
3077 "Search for the next target object.
3079 LIMIT bounds the search.
3081 Return value is a cons cell whose CAR is `target' and CDR is
3082 beginning position."
3088 ;;;; Timestamp
3091 "Parse time stamp at point.
3093 Return a list whose CAR is `timestamp', and CDR a plist with
3094 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3096 Assume point is at the beginning of the timestamp."
3115 :value main-value
3116 :range-end range-end
3117 :begin begin
3118 :end end
3122 "Interpret TIMESTAMP object as Org syntax.
3123 CONTENTS is nil."
3132 range-end)))))))
3135 "Search for the next timestamp object.
3137 LIMIT bounds the search.
3139 Return value is a cons cell whose CAR is `timestamp' and CDR is
3140 beginning position."
3148 limit t)
3152 ;;;; Underline
3155 "Parse underline object at point.
3157 Return a list whose CAR is `underline' and CDR is a plist with
3158 `:begin', `:end', `:contents-begin' and `:contents-end' and
3159 `:post-blank' keywords.
3161 Assume point is at the first underscore marker."
3173 :end end
3174 :contents-begin contents-begin
3175 :contents-end contents-end
3179 "Interpret UNDERLINE object as Org syntax.
3180 CONTENTS is the contents of the object."
3184 ;;;; Verbatim
3187 "Parse verbatim object at point.
3189 Return a list whose CAR is `verbatim' and CDR is a plist with
3190 `:value', `:begin', `:end' and `:post-blank' keywords.
3192 Assume point is at the first equal sign marker."
3203 :begin begin
3204 :end end
3208 "Interpret VERBATIM object as Org syntax.
3209 CONTENTS is nil."
3213 \f
3214 ;;; Parsing Element Starting At Point
3215 ;;
3216 ;; `org-element--current-element' is the core function of this section.
3217 ;; It returns the Lisp representation of the element starting at
3218 ;; point.
3219 ;;
3220 ;; `org-element--current-element' makes use of special modes. They
3221 ;; are activated for fixed element chaining (i.e. `plain-list' >
3222 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3223 ;; `section'). Special modes are: `first-section', `section',
3224 ;; `quote-section', `item' and `table-row'.
3228 "Parse the element starting at point.
3230 LIMIT bounds the search.
3232 Return value is a list like (TYPE PROPS) where TYPE is the type
3233 of the element and PROPS a plist of properties associated to the
3234 element.
3236 Possible types are defined in `org-element-all-elements'.
3238 Optional argument GRANULARITY determines the depth of the
3239 recursion. Allowed values are `headline', `greater-element',
3240 `element', `object' or nil. When it is broader than `object' (or
3241 nil), secondary values will not be parsed, since they only
3242 contain objects.
3244 Optional argument SPECIAL, when non-nil, can be either
3245 `first-section', `section', `quote-section', `table-row' and
3246 `item'.
3248 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3249 be computed.
3251 This function assumes point is always at the beginning of the
3252 element it has to parse."
3254 ;; If point is at an affiliated keyword, try moving to the
3255 ;; beginning of the associated element. If none is found, the
3256 ;; keyword is orphaned and will be treated as plain text.
3262 ;; Determine if parsing depth allows for secondary strings
3263 ;; parsing. It only applies to elements referenced in
3264 ;; `org-element-secondary-value-alist'.
3267 ;; Item.
3270 ;; Quote Section.
3272 ;; Table Row.
3274 ;; Headline.
3277 ;; Section (must be checked after headline).
3282 limit)))
3283 ;; Planning and Clock.
3288 ;; Inlinetask.
3291 ;; LaTeX Environment.
3297 nil t))
3300 ;; Drawer and Property Drawer.
3310 ;; Fixed Width
3313 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3314 ;; Keywords.
3320 org-element-block-name-alist)))
3335 ;; Footnote Definition.
3338 ;; Horizontal Rule.
3341 ;; Table.
3343 ;; List.
3346 ;; Default element: Paragraph.
3350 ;; Most elements can have affiliated keywords. When looking for an
3351 ;; element beginning, we want to move before them, as they belong to
3352 ;; that element, and, in the meantime, collect information they give
3353 ;; into appropriate properties. Hence the following function.
3354 ;;
3355 ;; Usage of optional arguments may not be obvious at first glance:
3356 ;;
3357 ;; - TRANS-LIST is used to polish keywords names that have evolved
3358 ;; during Org history. In example, even though =result= and
3359 ;; =results= coexist, we want to have them under the same =result=
3360 ;; property. It's also true for "srcname" and "name", where the
3361 ;; latter seems to be preferred nowadays (thus the "name" property).
3362 ;;
3363 ;; - CONSED allows to regroup multi-lines keywords under the same
3364 ;; property, while preserving their own identity. This is mostly
3365 ;; used for "attr_latex" and al.
3366 ;;
3367 ;; - PARSED prepares a keyword value for export. This is useful for
3368 ;; "caption". Objects restrictions for such keywords are defined in
3369 ;; `org-element-object-restrictions'.
3370 ;;
3371 ;; - DUALS is used to take care of keywords accepting a main and an
3372 ;; optional secondary values. For example "results" has its
3373 ;; source's name as the main value, and may have an hash string in
3374 ;; optional square brackets as the secondary one.
3375 ;;
3376 ;; A keyword may belong to more than one category.
3380 "Collect affiliated keywords before point.
3382 Optional argument KEY-RE is a regexp matching keywords, which
3383 puts matched keyword in group 1. It defaults to
3384 `org-element--affiliated-re'.
3386 TRANS-LIST is an alist where key is the keyword and value the
3387 property name it should be translated to, without the colons. It
3388 defaults to `org-element-keyword-translation-alist'.
3390 CONSED is a list of strings. Any keyword belonging to that list
3391 will have its value consed. The check is done after keyword
3392 translation. It defaults to `org-element-multiple-keywords'.
3394 PARSED is a list of strings. Any keyword member of this list
3395 will have its value parsed. The check is done after keyword
3396 translation. If a keyword is a member of both CONSED and PARSED,
3397 it's value will be a list of parsed strings. It defaults to
3398 `org-element-parsed-keywords'.
3400 DUALS is a list of strings. Any keyword member of this list can
3401 have two parts: one mandatory and one optional. Its value is
3402 a cons cell whose CAR is the former, and the CDR the latter. If
3403 a keyword is a member of both PARSED and DUALS, both values will
3404 be parsed. It defaults to `org-element-dual-keywords'.
3406 Return a list whose CAR is the position at the first of them and
3407 CDR a plist of keywords and values."
3415 ;; RESTRICT is the list of objects allowed in parsed
3416 ;; keywords value.
3418 output)
3422 ;; Apply translation to RAW-KWD. From there, KWD is
3423 ;; the official keyword.
3425 ;; Find main value for any keyword.
3431 ;; If KWD is a dual keyword, find its secondary
3432 ;; value. Maybe parse it.
3438 ;; Attribute a property name to KWD.
3440 ;; Now set final shape for VALUE.
3444 ;; VALUE is mandatory. Set it to nil if there is none.
3446 ;; Attributes are always consed.
3449 ;; Eventually store the new value in OUTPUT.
3455 \f
3456 ;;; The Org Parser
3457 ;;
3458 ;; The two major functions here are `org-element-parse-buffer', which
3459 ;; parses Org syntax inside the current buffer, taking into account
3460 ;; region, narrowing, or even visibility if specified, and
3461 ;; `org-element-parse-secondary-string', which parses objects within
3462 ;; a given string.
3463 ;;
3464 ;; The (almost) almighty `org-element-map' allows to apply a function
3465 ;; on elements or objects matching some type, and accumulate the
3466 ;; resulting values. In an export situation, it also skips unneeded
3467 ;; parts of the parse tree.
3470 "Recursively parse the buffer and return structure.
3471 If narrowing is in effect, only parse the visible part of the
3472 buffer.
3474 Optional argument GRANULARITY determines the depth of the
3475 recursion. It can be set to the following symbols:
3477 `headline' Only parse headlines.
3478 `greater-element' Don't recurse into greater elements excepted
3479 headlines and sections. Thus, elements
3480 parsed are the top-level ones.
3481 `element' Parse everything but objects and plain text.
3482 `object' Parse the complete buffer (default).
3484 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3485 elements.
3487 Assume buffer is in Org mode."
3493 ;; Start in `first-section' mode so text before the first
3494 ;; headline belongs to a section.
3498 "Recursively parse objects in STRING and return structure.
3500 RESTRICTION is a symbol limiting the object types that will be
3501 looked after.
3503 Optional argument PARENT, when non-nil, is the element or object
3504 containing the secondary string. It is used to set correctly
3505 `:parent' property within the string."
3511 secondary))))
3514 "Map a function on selected elements or objects.
3516 DATA is the parsed tree, as returned by, i.e,
3517 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3518 of elements or objects types. FUN is the function called on the
3519 matching element or object. It must accept one arguments: the
3520 element or object itself.
3522 When optional argument INFO is non-nil, it should be a plist
3523 holding export options. In that case, parts of the parse tree
3524 not exportable according to that property list will be skipped.
3526 When optional argument FIRST-MATCH is non-nil, stop at the first
3527 match for which FUN doesn't return nil, and return that value.
3529 Optional argument NO-RECURSION is a symbol or a list of symbols
3530 representing elements or objects types. `org-element-map' won't
3531 enter any recursive element or object whose type belongs to that
3532 list. Though, FUN can still be applied on them.
3534 Nil values returned from FUN do not appear in the results."
3535 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3538 ;; Recursion depth is determined by --CATEGORY.
3545 ;; If one object is found, the function
3546 ;; has to recurse into every object.
3549 ;; If one regular element is found, the
3550 ;; function has to recurse, at lest, into
3551 ;; every element it encounters.
3554 types)
3555 category)))
3556 --acc
3557 --walk-tree
3561 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3562 ;; holding contextual information.
3566 ;; Ignored element in an export context.
3568 ;; Secondary string: only objects can be found there.
3571 ;; Unconditionally enter parse trees.
3575 ;; Check if TYPE is matching among TYPES. If so,
3576 ;; apply FUN to --DATA and accumulate return value
3577 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3583 ;; If --DATA has a secondary string that can contain
3584 ;; objects with their type among TYPES, look into it.
3591 ;; Determine if a recursion into --DATA is possible.
3593 ;; --TYPE is explicitly removed from recursion.
3595 ;; --DATA has no contents.
3597 ;; Looking for greater elements but --DATA is simply
3598 ;; an element or an object.
3601 ;; Looking for elements but --DATA is an object.
3604 ;; In any other case, map contents.
3608 ;; Return value in a proper order.
3611 ;; The following functions are internal parts of the parser.
3612 ;;
3613 ;; The first one, `org-element--parse-elements' acts at the element's
3614 ;; level.
3615 ;;
3616 ;; The second one, `org-element--parse-objects' applies on all objects
3617 ;; of a paragraph or a secondary string. It uses
3618 ;; `org-element--get-next-object-candidates' to optimize the search of
3619 ;; the next object in the buffer.
3620 ;;
3621 ;; More precisely, that function looks for every allowed object type
3622 ;; first. Then, it discards failed searches, keeps further matches,
3623 ;; and searches again types matched behind point, for subsequent
3624 ;; calls. Thus, searching for a given type fails only once, and every
3625 ;; object is searched only once at top level (but sometimes more for
3626 ;; nested types).
3630 "Parse elements between BEG and END positions.
3632 SPECIAL prioritize some elements over the others. It can be set
3633 to `first-section', `quote-section', `section' `item' or
3634 `table-row'.
3636 When value is `item', STRUCTURE will be used as the current list
3637 structure.
3639 GRANULARITY determines the depth of the recursion. See
3640 `org-element-parse-buffer' for more information.
3642 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3643 elements.
3645 Elements are accumulated into ACC."
3648 ;; When parsing only headlines, skip any text before first one.
3651 ;; Main loop start.
3653 ;; Find current element's type and parse it accordingly to
3654 ;; its category.
3656 end granularity special structure))
3660 ;; Fill ELEMENT contents by side-effect.
3662 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3663 ;; no contents, don't modify it.
3666 ;; Greater element: parse it between `contents-begin' and
3667 ;; `contents-end'. Make sure GRANULARITY allows the
3668 ;; recursion, or ELEMENT is an headline, in which case going
3669 ;; inside is mandatory, in order to get sub-level headings.
3677 ;; Possibly switch to a special mode.
3685 granularity visible-only element))
3686 ;; ELEMENT has contents. Parse objects inside, if
3687 ;; GRANULARITY allows it.
3693 ;; Return result.
3694 acc))
3697 "Parse objects between BEG and END and return recursive structure.
3699 Objects are accumulated in ACC.
3701 RESTRICTION is a list of object types which are allowed in the
3702 current object."
3708 end restriction candidates)))
3715 ;; 1. Text before any object. Untabify it.
3720 acc
3724 ;; 2. Object...
3727 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3728 ;; a recursive type.
3733 cont-beg
3740 ;; 3. Text after last object. Untabify it.
3744 acc
3748 ;; Result.
3749 acc)))
3752 "Return an alist of candidates for the next object.
3754 LIMIT bounds the search, and RESTRICTION narrows candidates to
3755 some object types.
3757 Return value is an alist whose CAR is position and CDR the object
3758 type, as a symbol.
3760 OBJECTS is the previous candidates alist."
3762 ;; If no previous result, search every object type in RESTRICTION.
3763 ;; Otherwise, keep potential candidates (old objects located after
3764 ;; point) and ask to search again those which had matched before.
3769 objects))
3770 ;; Call the appropriate successor function for each type to search
3771 ;; and accumulate matches.
3778 type))))
3781 types-to-search)
3782 ;; Return alist.
3783 next-candidates))
3786 \f
3787 ;;; Towards A Bijective Process
3788 ;;
3789 ;; The parse tree obtained with `org-element-parse-buffer' is really
3790 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3791 ;; interpreted and expanded into a string with canonical Org syntax.
3792 ;; Hence `org-element-interpret-data'.
3793 ;;
3794 ;; The function relies internally on
3795 ;; `org-element--interpret-affiliated-keywords'.
3798 "Interpret DATA as Org syntax.
3800 DATA is a parse tree, an element, an object or a secondary string
3801 to interpret.
3803 Optional argument PARENT is used for recursive calls. It contains
3804 the element or object containing data, or nil.
3806 Return Org syntax as a string."
3810 ;; Secondary string.
3815 ;; Full Org document.
3820 ;; Plain text.
3822 ;; Element/Object without contents.
3825 data nil))
3826 ;; Element/Object with contents.
3836 ;; Elements directly containing objects must
3837 ;; have their indentation normalized first.
3839 data
3840 ;; When normalizing first paragraph of an
3841 ;; item or a footnote-definition, ignore
3842 ;; first line's indentation.
3849 data
3851 contents)))))))
3853 ;; Build white spaces. If no `:post-blank' property is
3854 ;; specified, assume its value is 0.
3864 "Return ELEMENT's affiliated keywords as Org syntax.
3865 If there is no affiliated keyword, return the empty string."
3875 ": "
3878 value)
3886 ;; All attribute keywords can have multiple lines.
3889 value
3892 ;; List all ELEMENT's properties matching an attribute line or an
3893 ;; affiliated keyword, but ignore translated keywords since they
3894 ;; cannot belong to the property list.
3901 org-element-keyword-translation-alist)))))
3902 collect prop)
3905 ;; Because interpretation of the parse tree must return the same
3906 ;; number of blank lines between elements and the same number of white
3907 ;; space after objects, some special care must be given to white
3908 ;; spaces.
3909 ;;
3910 ;; The first function, `org-element-normalize-string', ensures any
3911 ;; string different from the empty string will end with a single
3912 ;; newline character.
3913 ;;
3914 ;; The second function, `org-element-normalize-contents', removes
3915 ;; global indentation from the contents of the current element.
3918 "Ensure string S ends with a single newline character.
3920 If S isn't a string return it unchanged. If S is the empty
3921 string, return it. Otherwise, return a new string with a single
3922 newline character at its end."
3930 "Normalize plain text in ELEMENT's contents.
3932 ELEMENT must only contain plain text and objects.
3934 If optional argument IGNORE-FIRST is non-nil, ignore first line's
3935 indentation to compute maximal common indentation.
3937 Return the normalized element that is element with global
3938 indentation removed from its contents. The function assumes that
3939 indentation is not done with TAB characters."
3941 collect-inds ; for byte-compiler
3944 ;; Return list of indentations within BLOB. This is done by
3945 ;; walking recursively BLOB and updating IND-LIST along the
3946 ;; way. FIRST-FLAG is non-nil when the first string hasn't
3947 ;; been seen yet. It is required as this string is the only
3948 ;; one whose indentation doesn't happen after a newline
3949 ;; character.
3957 ;; An indentation of zero means no string will be
3958 ;; modified. Quit the process.
3964 ;; Avoid matching blank or empty lines.
3972 ;; Collect indentation list in ELEMENT. Possibly remove first
3973 ;; value if IGNORE-FIRST is non-nil.
3976 ;; Build ELEMENT back, replacing each string with the same
3977 ;; string minus common indentation.
3982 ;; Return BLOB with all its strings indentation
3983 ;; shortened from MCI white spaces. FIRST-FLAG is
3984 ;; non-nil when the first string hasn't been seen
3985 ;; yet.
3999 org-element-recursive-objects)
4003 blob))))
4007 \f
4008 ;;; The Toolbox
4009 ;;
4010 ;; The first move is to implement a way to obtain the smallest element
4011 ;; containing point. This is the job of `org-element-at-point'. It
4012 ;; basically jumps back to the beginning of section containing point
4013 ;; and moves, element after element, with
4014 ;; `org-element--current-element' until the container is found. Note:
4015 ;; When using `org-element-at-point', secondary values are never
4016 ;; parsed since the function focuses on elements, not on objects.
4017 ;;
4018 ;; At a deeper level, `org-element-context' lists all elements and
4019 ;; objects containing point.
4020 ;;
4021 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4022 ;; internally by navigation and manipulation tools.
4024 ;;;###autoload
4026 "Determine closest element around point.
4028 Return value is a list like (TYPE PROPS) where TYPE is the type
4029 of the element and PROPS a plist of properties associated to the
4030 element.
4032 Possible types are defined in `org-element-all-elements'.
4033 Properties depend on element or object type, but always
4034 include :begin, :end, :parent and :post-blank properties.
4036 As a special case, if point is at the very beginning of a list or
4037 sub-list, returned element will be that list instead of the first
4038 item. In the same way, if point is at the beginning of the first
4039 row of a table, returned element will be the table instead of the
4040 first row.
4042 If optional argument KEEP-TRAIL is non-nil, the function returns
4043 a list of of elements leading to element at point. The list's
4044 CAR is always the element at point. Following positions contain
4045 element's siblings, then parents, siblings of parents, until the
4046 first element of current section."
4048 ;; If at an headline, parse it. It is the sole element that
4049 ;; doesn't require to know about context. Be sure to disallow
4050 ;; secondary string parsing, though.
4056 ;; Otherwise move at the beginning of the section containing
4057 ;; point.
4061 element type special-flag trail struct prevs parent)
4069 ;; Parse successively each element, skipping those ending
4070 ;; before original position.
4079 ;; 1. Skip any element ending before point. Also skip
4080 ;; element ending at point when we're sure that another
4081 ;; element has started.
4086 ;; 2. An element containing point is always the element at
4087 ;; point.
4090 ;; 3. At any other greater element type, if point is
4091 ;; within contents, move into it.
4096 ;; Create an anchor for tables and plain lists:
4097 ;; when point is at the very beginning of these
4098 ;; elements, ignoring affiliated keywords,
4099 ;; target them instead of their contents.
4101 ;; When point is at contents end, do not move
4102 ;; into elements with an explicit ending, but
4103 ;; return that element instead.
4107 quote-block special-block))))
4120 "Return closest element or object around point.
4122 Return value is a list like (TYPE PROPS) where TYPE is the type
4123 of the element or object and PROPS a plist of properties
4124 associated to it.
4126 Possible types are defined in `org-element-all-elements' and
4127 `org-element-all-objects'. Properties depend on element or
4128 object type, but always include :begin, :end, :parent
4129 and :post-blank properties."
4134 end)
4135 ;; Check if point is inside an element containing objects or at
4136 ;; a secondary string. In that case, move to beginning of the
4137 ;; element or secondary string and set END to the other side.
4146 (<= origin
4147 ;; `1+' is required so some
4148 ;; successors can match
4149 ;; properly their object.
4163 element
4166 candidates)
4169 end restriction candidates))
4171 candidates)))
4172 ;; If ORIGIN is before next object in element, there's
4173 ;; no point in looking further.
4182 ;; ORIGIN is after OBJECT, so skip it.
4185 ;; ORIGIN is within a non-recursive object or at an
4186 ;; object boundaries: Return that object.
4190 ;; Otherwise, move within current object and restrict
4191 ;; search to the end of its contents.
4195 parent))))))
4198 "Non-nil when elements ELEM-A and ELEM-B are nested."
4207 "Swap elements ELEM-A and ELEM-B.
4208 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4209 end of ELEM-A."
4211 ;; There are two special cases when an element doesn't start at bol:
4212 ;; the first paragraph in an item or in a footnote definition.
4214 ;; Only a paragraph without any affiliated keyword can be moved at
4215 ;; ELEM-A position in such a situation. Note that the case of
4216 ;; a footnote definition is impossible: it cannot contain two
4217 ;; paragraphs in a row because it cannot contain a blank line.
4223 ;; In a special situation, ELEM-A will have no indentation. We'll
4224 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4238 ;; Store overlays responsible for visibility status. We
4239 ;; also need to store their boundaries as they will be
4240 ;; removed from buffer.
4247 ;; Get contents.
4255 ;; Restore ex ELEM-A overlays.
4265 ;; Restore ex ELEM-B overlays.
4275 ;;; org-element.el ends here