| blob | e6f4a46287464413fe6f8a192c63164b5c11a69a |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1131 ;; Compute indentation.
1136 ;; Indent contents.
1138 bullet
1152 ;;;; Plain List
1155 "Parse a plain list.
1157 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1158 the buffer position at the beginning of the first affiliated
1159 keyword and CDR is a plist of affiliated keywords along with
1160 their value. STRUCTURE is the structure of the plain list being
1161 parsed.
1163 Return a list whose CAR is `plain-list' and CDR is a plist
1164 containing `:type', `:begin', `:end', `:contents-begin' and
1165 `:contents-end', `:structure', `:post-blank' and
1166 `:post-affiliated' keywords.
1168 Assume point is at the beginning of the list."
1183 ;; Return value.
1187 :begin begin
1188 :end end
1189 :contents-begin contents-begin
1190 :contents-end contents-end
1191 :structure struct
1197 "Interpret PLAIN-LIST element as Org syntax.
1198 CONTENTS is the contents of the element."
1206 ;;;; Property Drawer
1209 "Parse a property drawer.
1211 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1212 the buffer position at the beginning of the first affiliated
1213 keyword and CDR is a plist of affiliated keywords along with
1214 their value.
1216 Return a list whose CAR is `property-drawer' and CDR is a plist
1217 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1218 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1220 Assume point is at the beginning of the property drawer."
1225 ;; Incomplete drawer: parse it as a paragraph.
1245 :end end
1246 :hiddenp hidden
1247 :contents-begin contents-begin
1248 :contents-end contents-end
1254 "Interpret PROPERTY-DRAWER element as Org syntax.
1255 CONTENTS is the properties within the drawer."
1259 ;;;; Quote Block
1262 "Parse a quote block.
1264 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1265 the buffer position at the beginning of the first affiliated
1266 keyword and CDR is a plist of affiliated keywords along with
1267 their value.
1269 Return a list whose CAR is `quote-block' and CDR is a plist
1270 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1271 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1273 Assume point is at the beginning of the block."
1277 ;; Incomplete block: parse it as a paragraph.
1283 ;; Empty blocks have no contents.
1298 :end end
1299 :hiddenp hidden
1300 :contents-begin contents-begin
1301 :contents-end contents-end
1307 "Interpret QUOTE-BLOCK element as Org syntax.
1308 CONTENTS is the contents of the element."
1312 ;;;; Section
1315 "Parse a section.
1317 LIMIT bounds the search.
1319 Return a list whose CAR is `section' and CDR is a plist
1320 containing `:begin', `:end', `:contents-begin', `contents-end'
1321 and `:post-blank' keywords."
1323 ;; Beginning of section is the beginning of the first non-blank
1324 ;; line after previous headline.
1333 :end end
1334 :contents-begin begin
1335 :contents-end pos-before-blank
1339 "Interpret SECTION element as Org syntax.
1340 CONTENTS is the contents of the element."
1341 contents)
1344 ;;;; Special Block
1347 "Parse a special block.
1349 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1350 the buffer position at the beginning of the first affiliated
1351 keyword and CDR is a plist of affiliated keywords along with
1352 their value.
1354 Return a list whose CAR is `special-block' and CDR is a plist
1355 containing `:type', `:begin', `:end', `:hiddenp',
1356 `:contents-begin', `:contents-end', `:post-blank' and
1357 `:post-affiliated' keywords.
1359 Assume point is at the beginning of the block."
1366 limit t)))
1367 ;; Incomplete block: parse it as a paragraph.
1373 ;; Empty blocks have no contents.
1388 :begin begin
1389 :end end
1390 :hiddenp hidden
1391 :contents-begin contents-begin
1392 :contents-end contents-end
1398 "Interpret SPECIAL-BLOCK element as Org syntax.
1399 CONTENTS is the contents of the element."
1404 \f
1405 ;;; Elements
1406 ;;
1407 ;; For each element, a parser and an interpreter are also defined.
1408 ;; Both follow the same naming convention used for greater elements.
1409 ;;
1410 ;; Also, as for greater elements, adding a new element type is done
1411 ;; through the following steps: implement a parser and an interpreter,
1412 ;; tweak `org-element--current-element' so that it recognizes the new
1413 ;; type and add that new type to `org-element-all-elements'.
1414 ;;
1415 ;; As a special case, when the newly defined type is a block type,
1416 ;; `org-element-block-name-alist' has to be modified accordingly.
1419 ;;;; Babel Call
1422 "Parse a babel call.
1424 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1425 the buffer position at the beginning of the first affiliated
1426 keyword and CDR is a plist of affiliated keywords along with
1427 their value.
1429 Return a list whose CAR is `babel-call' and CDR is a plist
1430 containing `:begin', `:end', `:info', `:post-blank' and
1431 `:post-affiliated' as keywords."
1445 :end end
1446 :info info
1452 "Interpret BABEL-CALL element as Org syntax.
1453 CONTENTS is nil."
1459 ;; Remove redundant square brackets.
1464 ;;;; Clock
1467 "Parse a clock.
1469 LIMIT bounds the search.
1471 Return a list whose CAR is `clock' and CDR is a plist containing
1472 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1473 as keywords."
1493 :value value
1494 :duration duration
1495 :begin begin
1496 :end end
1500 "Interpret CLOCK element as Org syntax.
1501 CONTENTS is nil."
1509 "%2s:%02s"
1513 ;;;; Comment
1516 "Parse a comment.
1518 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1519 the buffer position at the beginning of the first affiliated
1520 keyword and CDR is a plist of affiliated keywords along with
1521 their value.
1523 Return a list whose CAR is `comment' and CDR is a plist
1524 containing `:begin', `:end', `:value', `:post-blank',
1525 `:post-affiliated' keywords.
1527 Assume point is at comment beginning."
1536 ;; Get comments ending.
1539 ;; Accumulate lines without leading hash and first
1540 ;; whitespace.
1555 :end end
1556 :value value
1562 "Interpret COMMENT element as Org syntax.
1563 CONTENTS is nil."
1567 ;;;; Comment Block
1570 "Parse an export block.
1572 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1573 the buffer position at the beginning of the first affiliated
1574 keyword and CDR is a plist of affiliated keywords along with
1575 their value.
1577 Return a list whose CAR is `comment-block' and CDR is a plist
1578 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1579 and `:post-affiliated' keywords.
1581 Assume point is at comment block beginning."
1585 ;; Incomplete block: parse it as a paragraph.
1600 contents-begin contents-end)))
1604 :end end
1605 :value value
1606 :hiddenp hidden
1612 "Interpret COMMENT-BLOCK element as Org syntax.
1613 CONTENTS is nil."
1618 ;;;; Diary Sexp
1621 "Parse a diary sexp.
1623 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1624 the buffer position at the beginning of the first affiliated
1625 keyword and CDR is a plist of affiliated keywords along with
1626 their value.
1628 Return a list whose CAR is `diary-sexp' and CDR is a plist
1629 containing `:begin', `:end', `:value', `:post-blank' and
1630 `:post-affiliated' keywords."
1643 :begin begin
1644 :end end
1650 "Interpret DIARY-SEXP as Org syntax.
1651 CONTENTS is nil."
1655 ;;;; Example Block
1658 "Remove maximum common indentation in string S and return it.
1659 When optional argument N is a positive integer, remove exactly
1660 that much characters from indentation, if possible, or return
1661 S as-is otherwise. Unlike to `org-remove-indentation', this
1662 function doesn't call `untabify' on S."
1667 ;; Find maximum common indentation, if not specified.
1675 min-ind)))
1677 ;; Remove exactly N indentation, but give up if not possible.
1687 "Parse an example block.
1689 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1690 the buffer position at the beginning of the first affiliated
1691 keyword and CDR is a plist of affiliated keywords along with
1692 their value.
1694 Return a list whose CAR is `example-block' and CDR is a plist
1695 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1696 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1697 `:switches', `:value', `:post-blank' and `:post-affiliated'
1698 keywords."
1702 ;; Incomplete block: parse it as a paragraph.
1710 ;; Switches analysis
1718 ;; Should labels be retained in (or stripped from) example
1719 ;; blocks?
1724 ;; What should code-references use - labels or
1725 ;; line-numbers?
1734 ;; Standard block parsing.
1743 contents-begin contents-end))
1754 :end end
1755 :value value
1756 :switches switches
1757 :number-lines number-lines
1758 :preserve-indent preserve-indent
1759 :retain-labels retain-labels
1760 :use-labels use-labels
1761 :label-fmt label-fmt
1762 :hiddenp hidden
1768 "Interpret EXAMPLE-BLOCK element as Org syntax.
1769 CONTENTS is nil."
1777 ;;;; Export Block
1780 "Parse an export block.
1782 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1783 the buffer position at the beginning of the first affiliated
1784 keyword and CDR is a plist of affiliated keywords along with
1785 their value.
1787 Return a list whose CAR is `export-block' and CDR is a plist
1788 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1789 `:post-blank' and `:post-affiliated' keywords.
1791 Assume point is at export-block beginning."
1798 ;; Incomplete block: parse it as a paragraph.
1813 contents-end)))
1817 :end end
1818 :type type
1819 :value value
1820 :hiddenp hidden
1826 "Interpret EXPORT-BLOCK element as Org syntax.
1827 CONTENTS is nil."
1834 ;;;; Fixed-width
1837 "Parse a fixed-width section.
1839 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1840 the buffer position at the beginning of the first affiliated
1841 keyword and CDR is a plist of affiliated keywords along with
1842 their value.
1844 Return a list whose CAR is `fixed-width' and CDR is a plist
1845 containing `:begin', `:end', `:value', `:post-blank' and
1846 `:post-affiliated' keywords.
1848 Assume point is at the beginning of the fixed-width area."
1852 value
1857 ;; Accumulate text without starting colons.
1871 :end end
1872 :value value
1878 "Interpret FIXED-WIDTH element as Org syntax.
1879 CONTENTS is nil."
1887 ;;;; Horizontal Rule
1890 "Parse an horizontal rule.
1892 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1893 the buffer position at the beginning of the first affiliated
1894 keyword and CDR is a plist of affiliated keywords along with
1895 their value.
1897 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1898 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1899 keywords."
1910 :end end
1916 "Interpret HORIZONTAL-RULE element as Org syntax.
1917 CONTENTS is nil."
1921 ;;;; Keyword
1924 "Parse a keyword at point.
1926 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1927 the buffer position at the beginning of the first affiliated
1928 keyword and CDR is a plist of affiliated keywords along with
1929 their value.
1931 Return a list whose CAR is `keyword' and CDR is a plist
1932 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1933 `:post-affiliated' keywords."
1948 :value value
1949 :begin begin
1950 :end end
1956 "Interpret KEYWORD element as Org syntax.
1957 CONTENTS is nil."
1963 ;;;; Latex Environment
1966 "Parse a LaTeX environment.
1968 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1969 the buffer position at the beginning of the first affiliated
1970 keyword and CDR is a plist of affiliated keywords along with
1971 their value.
1973 Return a list whose CAR is `latex-environment' and CDR is a plist
1974 containing `:begin', `:end', `:value', `:post-blank' and
1975 `:post-affiliated' keywords.
1977 Assume point is at the beginning of the latex environment."
1984 limit t))
1985 ;; Incomplete latex environment: parse it as a paragraph.
1996 :end end
1997 :value value
2003 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2004 CONTENTS is nil."
2008 ;;;; Node Property
2011 "Parse a node-property at point.
2013 LIMIT bounds the search.
2015 Return a list whose CAR is `node-property' and CDR is a plist
2016 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2017 keywords."
2029 :value value
2030 :begin begin
2031 :end end
2035 "Interpret NODE-PROPERTY element as Org syntax.
2036 CONTENTS is nil."
2042 ;;;; Paragraph
2045 "Parse a paragraph.
2047 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2048 the buffer position at the beginning of the first affiliated
2049 keyword and CDR is a plist of affiliated keywords along with
2050 their value.
2052 Return a list whose CAR is `paragraph' and CDR is a plist
2053 containing `:begin', `:end', `:contents-begin' and
2054 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2056 Assume point is at the beginning of the paragraph."
2065 limit
2066 ;; A matching `org-element-paragraph-separate' is not
2067 ;; necessarily the end of the paragraph. In
2068 ;; particular, lines starting with # or : as a first
2069 ;; non-space character are ambiguous. We have check
2070 ;; if they are valid Org syntax (i.e. not an
2071 ;; incomplete keyword).
2075 ;; There's no ambiguity for other symbols or
2076 ;; empty lines: stop here.
2078 ;; Stop at valid fixed-width areas.
2080 ;; Stop at drawers.
2085 ;; Stop at valid comments.
2087 ;; Stop at valid dynamic blocks.
2092 ;; Stop at valid blocks.
2099 limit t)))
2100 ;; Stop at valid latex environments.
2107 limit t)))
2108 ;; Stop at valid keywords.
2110 ;; Skip everything else.
2128 :end end
2129 :contents-begin contents-begin
2130 :contents-end contents-end
2136 "Interpret PARAGRAPH element as Org syntax.
2137 CONTENTS is the contents of the element."
2138 contents)
2141 ;;;; Planning
2144 "Parse a planning.
2146 LIMIT bounds the search.
2148 Return a list whose CAR is `planning' and CDR is a plist
2149 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2150 and `:post-blank' keywords."
2160 closed deadline scheduled)
2172 :deadline deadline
2173 :scheduled scheduled
2174 :begin begin
2175 :end end
2179 "Interpret PLANNING element as Org syntax.
2180 CONTENTS is nil."
2182 'identity
2199 ;;;; Quote Section
2202 "Parse a quote section.
2204 LIMIT bounds the search.
2206 Return a list whose CAR is `quote-section' and CDR is a plist
2207 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2209 Assume point is at beginning of the section."
2220 :end end
2221 :value value
2225 "Interpret QUOTE-SECTION element as Org syntax.
2226 CONTENTS is nil."
2230 ;;;; Src Block
2233 "Parse a src block.
2235 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2236 the buffer position at the beginning of the first affiliated
2237 keyword and CDR is a plist of affiliated keywords along with
2238 their value.
2240 Return a list whose CAR is `src-block' and CDR is a plist
2241 containing `:language', `:switches', `:parameters', `:begin',
2242 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2243 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2244 `:post-blank' and `:post-affiliated' keywords.
2246 Assume point is at the beginning of the block."
2249 limit t)))
2250 ;; Incomplete block: parse it as a paragraph.
2256 ;; Get language as a string.
2265 ;; Get switches.
2267 ;; Get parameters.
2269 ;; Switches analysis
2281 ;; Should labels be retained in (or stripped from)
2282 ;; src blocks?
2287 ;; What should code-references use - labels or
2288 ;; line-numbers?
2293 ;; Indentation.
2295 ;; Get visibility status.
2297 ;; Retrieve code.
2306 ;; Get position after ending blank lines.
2317 :begin begin
2318 :end end
2319 :number-lines number-lines
2320 :preserve-indent preserve-indent
2321 :retain-labels retain-labels
2322 :use-labels use-labels
2323 :label-fmt label-fmt
2324 :hiddenp hidden
2325 :value value
2331 "Interpret SRC-BLOCK element as Org syntax.
2332 CONTENTS is nil."
2353 ;;;; Table
2356 "Parse a table at point.
2358 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2359 the buffer position at the beginning of the first affiliated
2360 keyword and CDR is a plist of affiliated keywords along with
2361 their value.
2363 Return a list whose CAR is `table' and CDR is a plist containing
2364 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2365 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2366 keywords.
2368 Assume point is at the beginning of the table."
2382 acc))
2390 :end end
2391 :type type
2392 :tblfm tblfm
2393 ;; Only `org' tables have contents. `table.el' tables
2394 ;; use a `:value' property to store raw table as
2395 ;; a string.
2400 table-begin table-end))
2406 "Interpret TABLE element as Org syntax.
2407 CONTENTS is nil."
2418 ;;;; Table Row
2421 "Parse table row at point.
2423 LIMIT bounds the search.
2425 Return a list whose CAR is `table-row' and CDR is a plist
2426 containing `:begin', `:end', `:contents-begin', `:contents-end',
2427 `:type' and `:post-blank' keywords."
2431 ;; A table rule has no contents. In that case, ensure
2432 ;; CONTENTS-BEGIN matches CONTENTS-END.
2444 :begin begin
2445 :end end
2446 :contents-begin contents-begin
2447 :contents-end contents-end
2451 "Interpret TABLE-ROW element as Org syntax.
2452 CONTENTS is the contents of the table row."
2457 ;;;; Verse Block
2460 "Parse a verse block.
2462 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2463 the buffer position at the beginning of the first affiliated
2464 keyword and CDR is a plist of affiliated keywords along with
2465 their value.
2467 Return a list whose CAR is `verse-block' and CDR is a plist
2468 containing `:begin', `:end', `:contents-begin', `:contents-end',
2469 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2471 Assume point is at beginning of the block."
2475 ;; Incomplete block: parse it as a paragraph.
2492 :end end
2493 :contents-begin contents-begin
2494 :contents-end contents-end
2495 :hiddenp hidden
2501 "Interpret VERSE-BLOCK element as Org syntax.
2502 CONTENTS is verse block contents."
2506 \f
2507 ;;; Objects
2508 ;;
2509 ;; Unlike to elements, interstices can be found between objects.
2510 ;; That's why, along with the parser, successor functions are provided
2511 ;; for each object. Some objects share the same successor (i.e. `code'
2512 ;; and `verbatim' objects).
2513 ;;
2514 ;; A successor must accept a single argument bounding the search. It
2515 ;; will return either a cons cell whose CAR is the object's type, as
2516 ;; a symbol, and CDR the position of its next occurrence, or nil.
2517 ;;
2518 ;; Successors follow the naming convention:
2519 ;; org-element-NAME-successor, where NAME is the name of the
2520 ;; successor, as defined in `org-element-all-successors'.
2521 ;;
2522 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2523 ;; object types they can contain will be specified in
2524 ;; `org-element-object-restrictions'.
2525 ;;
2526 ;; Adding a new type of object is simple. Implement a successor,
2527 ;; a parser, and an interpreter for it, all following the naming
2528 ;; convention. Register type in `org-element-all-objects' and
2529 ;; successor in `org-element-all-successors'. Maybe tweak
2530 ;; restrictions about it, and that's it.
2533 ;;;; Bold
2536 "Parse bold object at point.
2538 Return a list whose CAR is `bold' and CDR is a plist with
2539 `:begin', `:end', `:contents-begin' and `:contents-end' and
2540 `:post-blank' keywords.
2542 Assume point is at the first star marker."
2554 :end end
2555 :contents-begin contents-begin
2556 :contents-end contents-end
2560 "Interpret BOLD object as Org syntax.
2561 CONTENTS is the contents of the object."
2565 "Search for the next text-markup object.
2567 LIMIT bounds the search.
2569 Return value is a cons cell whose CAR is a symbol among `bold',
2570 `italic', `underline', `strike-through', `code' and `verbatim'
2571 and CDR is beginning position."
2587 ;;;; Code
2590 "Parse code object at point.
2592 Return a list whose CAR is `code' and CDR is a plist with
2593 `:value', `:begin', `:end' and `:post-blank' keywords.
2595 Assume point is at the first tilde marker."
2606 :begin begin
2607 :end end
2611 "Interpret CODE object as Org syntax.
2612 CONTENTS is nil."
2616 ;;;; Entity
2619 "Parse entity at point.
2621 Return a list whose CAR is `entity' and CDR a plist with
2622 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2623 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2624 keywords.
2626 Assume point is at the beginning of the entity."
2628 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2644 :begin begin
2645 :end end
2646 :use-brackets-p bracketsp
2650 "Interpret ENTITY object as Org syntax.
2651 CONTENTS is nil."
2657 "Search for the next latex-fragment or entity object.
2659 LIMIT bounds the search.
2661 Return value is a cons cell whose CAR is `entity' or
2662 `latex-fragment' and CDR is beginning position."
2667 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2674 limit t)
2677 ;; Determine if it's a real entity or a LaTeX command.
2680 ;; No entity nor command: point is at a LaTeX fragment.
2681 ;; Determine its type to get the correct beginning position.
2689 matchers)
2693 ;;;; Export Snippet
2696 "Parse export snippet at point.
2698 Return a list whose CAR is `export-snippet' and CDR a plist with
2699 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2700 keywords.
2702 Assume point is at the beginning of the snippet."
2714 :value value
2715 :begin begin
2716 :end end
2720 "Interpret EXPORT-SNIPPET object as Org syntax.
2721 CONTENTS is nil."
2727 "Search for the next export-snippet object.
2729 LIMIT bounds the search.
2731 Return value is a cons cell whose CAR is `export-snippet' and CDR
2732 its beginning position."
2741 ;;;; Footnote Reference
2744 "Parse footnote reference at point.
2746 Return a list whose CAR is `footnote-reference' and CDR a plist
2747 with `:label', `:type', `:inline-definition', `:begin', `:end'
2748 and `:post-blank' as keywords."
2770 :type type
2771 :begin begin
2772 :end end
2775 footnote-reference :inline-definition
2780 footnote-reference))))))
2783 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2784 CONTENTS is nil."
2794 "Search for the next footnote-reference object.
2796 LIMIT bounds the search.
2798 Return value is a cons cell whose CAR is `footnote-reference' and
2799 CDR is beginning position."
2813 ;;;; Inline Babel Call
2816 "Parse inline babel call at point.
2818 Return a list whose CAR is `inline-babel-call' and CDR a plist
2819 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2821 Assume point is at the beginning of the babel call."
2832 :end end
2833 :info info
2837 "Interpret INLINE-BABEL-CALL object as Org syntax.
2838 CONTENTS is nil."
2844 ;; Remove redundant square brackets.
2847 main-source)
2851 "Search for the next inline-babel-call object.
2853 LIMIT bounds the search.
2855 Return value is a cons cell whose CAR is `inline-babel-call' and
2856 CDR is beginning position."
2858 ;; Use a simplified version of
2859 ;; `org-babel-inline-lob-one-liner-regexp'.
2862 limit t)
2866 ;;;; Inline Src Block
2869 "Parse inline source block at point.
2871 LIMIT bounds the search.
2873 Return a list whose CAR is `inline-src-block' and CDR a plist
2874 with `:begin', `:end', `:language', `:value', `:parameters' and
2875 `:post-blank' as keywords.
2877 Assume point is at the beginning of the inline src block."
2890 :value value
2891 :parameters parameters
2892 :begin begin
2893 :end end
2897 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2898 CONTENTS is nil."
2903 language
2905 body)))
2908 "Search for the next inline-babel-call element.
2910 LIMIT bounds the search.
2912 Return value is a cons cell whose CAR is `inline-babel-call' and
2913 CDR is beginning position."
2919 ;;;; Italic
2922 "Parse italic object at point.
2924 Return a list whose CAR is `italic' and CDR is a plist with
2925 `:begin', `:end', `:contents-begin' and `:contents-end' and
2926 `:post-blank' keywords.
2928 Assume point is at the first slash marker."
2940 :end end
2941 :contents-begin contents-begin
2942 :contents-end contents-end
2946 "Interpret ITALIC object as Org syntax.
2947 CONTENTS is the contents of the object."
2951 ;;;; Latex Fragment
2954 "Parse latex fragment at point.
2956 Return a list whose CAR is `latex-fragment' and CDR a plist with
2957 `:value', `:begin', `:end', and `:post-blank' as keywords.
2959 Assume point is at the beginning of the latex fragment."
2973 ;; None found: it's a macro.
2982 :begin begin
2983 :end end
2987 "Interpret LATEX-FRAGMENT object as Org syntax.
2988 CONTENTS is nil."
2991 ;;;; Line Break
2994 "Parse line break at point.
2996 Return a list whose CAR is `line-break', and CDR a plist with
2997 `:begin', `:end' and `:post-blank' keywords.
2999 Assume point is at the beginning of the line break."
3006 "Interpret LINE-BREAK object as Org syntax.
3007 CONTENTS is nil."
3011 "Search for the next line-break object.
3013 LIMIT bounds the search.
3015 Return value is a cons cell whose CAR is `line-break' and CDR is
3016 beginning position."
3020 ;; A line break can only happen on a non-empty line.
3025 ;;;; Link
3028 "Parse link at point.
3030 Return a list whose CAR is `link' and CDR a plist with `:type',
3031 `:path', `:raw-link', `:application', `:search-option', `:begin',
3032 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3033 keywords.
3035 Assume point is at the beginning of the link."
3038 end contents-begin contents-end link-end post-blank path type
3039 raw-link link search-option application)
3041 ;; Type 1: Text targeted from a radio target.
3046 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3051 ;; RAW-LINK is the original link. Expand any
3052 ;; abbreviation in it.
3057 ;; Determine TYPE of link and set PATH accordingly.
3059 ;; File type.
3062 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3065 ;; Id type: PATH is the id.
3068 ;; Code-ref type: PATH is the name of the reference.
3071 ;; Custom-id type: PATH is the name of the custom id.
3074 ;; Fuzzy type: Internal link either matches a target, an
3075 ;; headline name or nothing. PATH is the target or
3076 ;; headline's name.
3078 ;; Type 3: Plain link, i.e. http://orgmode.org
3084 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3091 ;; In any case, deduce end point after trailing white space from
3092 ;; LINK-END variable.
3095 ;; Extract search option and opening application out of
3096 ;; "file"-type links.
3098 ;; Application.
3103 ;; Extract search option from PATH.
3107 ;; Make sure TYPE always report "file".
3111 :path path
3113 :application application
3114 :search-option search-option
3115 :begin begin
3116 :end end
3117 :contents-begin contents-begin
3118 :contents-end contents-end
3122 "Interpret LINK object as Org syntax.
3123 CONTENTS is the contents of the object, or nil."
3128 raw-link
3132 "Search for the next link object.
3134 LIMIT bounds the search.
3136 Return value is a cons cell whose CAR is `link' and CDR is
3137 beginning position."
3146 "Search for the next plain link object.
3148 LIMIT bounds the search.
3150 Return value is a cons cell whose CAR is `link' and CDR is
3151 beginning position."
3156 ;;;; Macro
3159 "Parse macro at point.
3161 Return a list whose CAR is `macro' and CDR a plist with `:key',
3162 `:args', `:begin', `:end', `:value' and `:post-blank' as
3163 keywords.
3165 Assume point is at the macro."
3176 ;; Do not use `org-split-string' since empty
3177 ;; strings are meaningful here.
3185 args nil t)
3189 :value value
3190 :args args
3191 :begin begin
3192 :end end
3196 "Interpret MACRO object as Org syntax.
3197 CONTENTS is nil."
3201 "Search for the next macro object.
3203 LIMIT bounds the search.
3205 Return value is cons cell whose CAR is `macro' and CDR is
3206 beginning position."
3210 limit t)
3214 ;;;; Radio-target
3217 "Parse radio target at point.
3219 Return a list whose CAR is `radio-target' and CDR a plist with
3220 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3221 and `:post-blank' as keywords.
3223 Assume point is at the radio target."
3235 :end end
3236 :contents-begin contents-begin
3237 :contents-end contents-end
3238 :post-blank post-blank
3242 "Interpret TARGET object as Org syntax.
3243 CONTENTS is the contents of the object."
3247 "Search for the next radio-target object.
3249 LIMIT bounds the search.
3251 Return value is a cons cell whose CAR is `radio-target' and CDR
3252 is beginning position."
3258 ;;;; Statistics Cookie
3261 "Parse statistics cookie at point.
3263 Return a list whose CAR is `statistics-cookie', and CDR a plist
3264 with `:begin', `:end', `:value' and `:post-blank' keywords.
3266 Assume point is at the beginning of the statistics-cookie."
3277 :end end
3278 :value value
3282 "Interpret STATISTICS-COOKIE object as Org syntax.
3283 CONTENTS is nil."
3287 "Search for the next statistics cookie object.
3289 LIMIT bounds the search.
3291 Return value is a cons cell whose CAR is `statistics-cookie' and
3292 CDR is beginning position."
3298 ;;;; Strike-Through
3301 "Parse strike-through object at point.
3303 Return a list whose CAR is `strike-through' and CDR is a plist
3304 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3305 `:post-blank' keywords.
3307 Assume point is at the first plus sign marker."
3319 :end end
3320 :contents-begin contents-begin
3321 :contents-end contents-end
3325 "Interpret STRIKE-THROUGH object as Org syntax.
3326 CONTENTS is the contents of the object."
3330 ;;;; Subscript
3333 "Parse subscript at point.
3335 Return a list whose CAR is `subscript' and CDR a plist with
3336 `:begin', `:end', `:contents-begin', `:contents-end',
3337 `:use-brackets-p' and `:post-blank' as keywords.
3339 Assume point is at the underscore."
3343 t
3354 :end end
3355 :use-brackets-p bracketsp
3356 :contents-begin contents-begin
3357 :contents-end contents-end
3361 "Interpret SUBSCRIPT object as Org syntax.
3362 CONTENTS is the contents of the object."
3365 contents))
3368 "Search for the next sub/superscript object.
3370 LIMIT bounds the search.
3372 Return value is a cons cell whose CAR is either `subscript' or
3373 `superscript' and CDR is beginning position."
3381 ;;;; Superscript
3384 "Parse superscript at point.
3386 Return a list whose CAR is `superscript' and CDR a plist with
3387 `:begin', `:end', `:contents-begin', `:contents-end',
3388 `:use-brackets-p' and `:post-blank' as keywords.
3390 Assume point is at the caret."
3404 :end end
3405 :use-brackets-p bracketsp
3406 :contents-begin contents-begin
3407 :contents-end contents-end
3411 "Interpret SUPERSCRIPT object as Org syntax.
3412 CONTENTS is the contents of the object."
3415 contents))
3418 ;;;; Table Cell
3421 "Parse table cell at point.
3423 Return a list whose CAR is `table-cell' and CDR is a plist
3424 containing `:begin', `:end', `:contents-begin', `:contents-end'
3425 and `:post-blank' keywords."
3433 :end end
3434 :contents-begin contents-begin
3435 :contents-end contents-end
3439 "Interpret TABLE-CELL element as Org syntax.
3440 CONTENTS is the contents of the cell, or nil."
3444 "Search for the next table-cell object.
3446 LIMIT bounds the search.
3448 Return value is a cons cell whose CAR is `table-cell' and CDR is
3449 beginning position."
3453 ;;;; Target
3456 "Parse target at point.
3458 Return a list whose CAR is `target' and CDR a plist with
3459 `:begin', `:end', `:value' and `:post-blank' as keywords.
3461 Assume point is at the target."
3471 :end end
3472 :value value
3476 "Interpret TARGET object as Org syntax.
3477 CONTENTS is nil."
3481 "Search for the next target object.
3483 LIMIT bounds the search.
3485 Return value is a cons cell whose CAR is `target' and CDR is
3486 beginning position."
3492 ;;;; Timestamp
3495 "Parse time stamp at point.
3497 Return a list whose CAR is `timestamp', and CDR a plist with
3498 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3500 Assume point is at the beginning of the timestamp."
3518 date-start)
3529 raw-value)
3531 :repeater-type
3537 :repeater-unit
3540 year-start month-start day-start hour-start minute-start year-end
3541 month-end day-end hour-end minute-end)
3542 ;; Parse date-start.
3550 ;; Compute date-end. It can be provided directly in time-stamp,
3551 ;; or extracted from time range. Otherwise, it defaults to the
3552 ;; same values as date-start.
3562 :raw-value raw-value
3563 :year-start year-start
3564 :month-start month-start
3565 :day-start day-start
3566 :hour-start hour-start
3567 :minute-start minute-start
3568 :year-end year-end
3569 :month-end month-end
3570 :day-end day-end
3571 :hour-end hour-end
3572 :minute-end minute-end
3573 :begin begin
3574 :end end
3576 repeater-props)))))
3579 "Interpret TIMESTAMP object as Org syntax.
3580 CONTENTS is nil."
3581 ;; Use `:raw-value' if specified.
3583 ;; Otherwise, build timestamp string.
3593 ;; Build an Org timestamp string from TIME. ACTIVEP is
3594 ;; non-nil when time stamp is active. If WITH-TIME-P is
3595 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3596 ;; specify a time range in the timestamp. REPEAT-STRING
3597 ;; is the repeater string, if any.
3601 org-time-stamp-formats)
3602 time)))
3608 nil nil ts)))
3612 " "
3613 repeat-string
3615 ;; Return value.
3616 ts)))
3628 build-ts-string
3647 0
3655 "--"
3667 "Search for the next timestamp object.
3669 LIMIT bounds the search.
3671 Return value is a cons cell whose CAR is `timestamp' and CDR is
3672 beginning position."
3680 limit t)
3684 ;;;; Underline
3687 "Parse underline object at point.
3689 Return a list whose CAR is `underline' and CDR is a plist with
3690 `:begin', `:end', `:contents-begin' and `:contents-end' and
3691 `:post-blank' keywords.
3693 Assume point is at the first underscore marker."
3705 :end end
3706 :contents-begin contents-begin
3707 :contents-end contents-end
3711 "Interpret UNDERLINE object as Org syntax.
3712 CONTENTS is the contents of the object."
3716 ;;;; Verbatim
3719 "Parse verbatim object at point.
3721 Return a list whose CAR is `verbatim' and CDR is a plist with
3722 `:value', `:begin', `:end' and `:post-blank' keywords.
3724 Assume point is at the first equal sign marker."
3735 :begin begin
3736 :end end
3740 "Interpret VERBATIM object as Org syntax.
3741 CONTENTS is nil."
3745 \f
3746 ;;; Parsing Element Starting At Point
3747 ;;
3748 ;; `org-element--current-element' is the core function of this section.
3749 ;; It returns the Lisp representation of the element starting at
3750 ;; point.
3751 ;;
3752 ;; `org-element--current-element' makes use of special modes. They
3753 ;; are activated for fixed element chaining (i.e. `plain-list' >
3754 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3755 ;; `section'). Special modes are: `first-section', `item',
3756 ;; `node-property', `quote-section', `section' and `table-row'.
3760 "Parse the element starting at point.
3762 LIMIT bounds the search.
3764 Return value is a list like (TYPE PROPS) where TYPE is the type
3765 of the element and PROPS a plist of properties associated to the
3766 element.
3768 Possible types are defined in `org-element-all-elements'.
3770 Optional argument GRANULARITY determines the depth of the
3771 recursion. Allowed values are `headline', `greater-element',
3772 `element', `object' or nil. When it is broader than `object' (or
3773 nil), secondary values will not be parsed, since they only
3774 contain objects.
3776 Optional argument SPECIAL, when non-nil, can be either
3777 `first-section', `item', `node-property', `quote-section',
3778 `section', and `table-row'.
3780 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3781 be computed.
3783 This function assumes point is always at the beginning of the
3784 element it has to parse."
3787 ;; Determine if parsing depth allows for secondary strings
3788 ;; parsing. It only applies to elements referenced in
3789 ;; `org-element-secondary-value-alist'.
3792 ;; Item.
3795 ;; Table Row.
3797 ;; Node Property.
3799 ;; Headline.
3802 ;; Sections (must be checked after headline).
3808 limit)))
3809 ;; When not at bol, point is at the beginning of an item or
3810 ;; a footnote definition: next item is always a paragraph.
3812 ;; Planning and Clock.
3817 ;; Inlinetask.
3820 ;; From there, elements can have affiliated keywords.
3823 ;; Jumping over affiliated keywords put point off-limits.
3824 ;; Parse them as regular keywords.
3828 ;; LaTeX Environment.
3832 ;; Drawer and Property Drawer.
3837 ;; Fixed Width
3840 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3841 ;; Keywords.
3850 org-element-block-name-alist)))
3865 ;; Footnote Definition.
3868 ;; Horizontal Rule.
3871 ;; Diary Sexp.
3874 ;; Table.
3876 ;; List.
3880 ;; Default element: Paragraph.
3884 ;; Most elements can have affiliated keywords. When looking for an
3885 ;; element beginning, we want to move before them, as they belong to
3886 ;; that element, and, in the meantime, collect information they give
3887 ;; into appropriate properties. Hence the following function.
3890 "Collect affiliated keywords from point down to LIMIT.
3892 Return a list whose CAR is the position at the first of them and
3893 CDR a plist of keywords and values and move point to the
3894 beginning of the first line after them.
3896 As a special case, if element doesn't start at the beginning of
3897 the line (i.e. a paragraph starting an item), CAR is current
3898 position of point and CDR is nil."
3902 ;; RESTRICT is the list of objects allowed in parsed
3903 ;; keywords value.
3905 output)
3908 ;; Apply translation to RAW-KWD. From there, KWD is
3909 ;; the official keyword.
3911 org-element-keyword-translation-alist))
3912 raw-kwd))
3913 ;; Find main value for any keyword.
3919 ;; PARSEDP is non-nil when keyword should have its
3920 ;; value parsed.
3922 ;; If KWD is a dual keyword, find its secondary
3923 ;; value. Maybe parse it.
3930 ;; Attribute a property name to KWD.
3932 ;; Now set final shape for VALUE.
3938 ;; Attributes can always appear on multiple lines.
3941 ;; Eventually store the new value in OUTPUT.
3943 ;; Move to next keyword.
3945 ;; If affiliated keywords are orphaned: move back to first one.
3946 ;; They will be parsed as a paragraph.
3948 ;; Return value.
3952 \f
3953 ;;; The Org Parser
3954 ;;
3955 ;; The two major functions here are `org-element-parse-buffer', which
3956 ;; parses Org syntax inside the current buffer, taking into account
3957 ;; region, narrowing, or even visibility if specified, and
3958 ;; `org-element-parse-secondary-string', which parses objects within
3959 ;; a given string.
3960 ;;
3961 ;; The (almost) almighty `org-element-map' allows to apply a function
3962 ;; on elements or objects matching some type, and accumulate the
3963 ;; resulting values. In an export situation, it also skips unneeded
3964 ;; parts of the parse tree.
3967 "Recursively parse the buffer and return structure.
3968 If narrowing is in effect, only parse the visible part of the
3969 buffer.
3971 Optional argument GRANULARITY determines the depth of the
3972 recursion. It can be set to the following symbols:
3974 `headline' Only parse headlines.
3975 `greater-element' Don't recurse into greater elements excepted
3976 headlines and sections. Thus, elements
3977 parsed are the top-level ones.
3978 `element' Parse everything but objects and plain text.
3979 `object' Parse the complete buffer (default).
3981 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3982 elements.
3984 An element or an objects is represented as a list with the
3985 pattern (TYPE PROPERTIES CONTENTS), where :
3987 TYPE is a symbol describing the element or object. See
3988 `org-element-all-elements' and `org-element-all-objects' for an
3989 exhaustive list of such symbols. One can retrieve it with
3990 `org-element-type' function.
3992 PROPERTIES is the list of attributes attached to the element or
3993 object, as a plist. Although most of them are specific to the
3994 element or object type, all types share `:begin', `:end',
3995 `:post-blank' and `:parent' properties, which respectively
3996 refer to buffer position where the element or object starts,
3997 ends, the number of white spaces or blank lines after it, and
3998 the element or object containing it. Properties values can be
3999 obtained by using `org-element-property' function.
4001 CONTENTS is a list of elements, objects or raw strings
4002 contained in the current element or object, when applicable.
4003 One can access them with `org-element-contents' function.
4005 The Org buffer has `org-data' as type and nil as properties.
4006 `org-element-map' function can be used to find specific elements
4007 or objects within the parse tree.
4009 This function assumes that current major mode is `org-mode'."
4015 ;; Start in `first-section' mode so text before the first
4016 ;; headline belongs to a section.
4020 "Recursively parse objects in STRING and return structure.
4022 RESTRICTION is a symbol limiting the object types that will be
4023 looked after.
4025 Optional argument PARENT, when non-nil, is the element or object
4026 containing the secondary string. It is used to set correctly
4027 `:parent' property within the string."
4028 ;; Copy buffer-local variables listed in
4029 ;; `org-element-object-variables' into temporary buffer. This is
4030 ;; required since object parsing is dependent on these variables.
4034 org-element-object-variables))))
4042 secondary))
4043 secondary))))
4047 "Map a function on selected elements or objects.
4049 DATA is a parse tree, an element, an object, a string, or a list
4050 of such constructs. TYPES is a symbol or list of symbols of
4051 elements or objects types (see `org-element-all-elements' and
4052 `org-element-all-objects' for a complete list of types). FUN is
4053 the function called on the matching element or object. It has to
4054 accept one argument: the element or object itself.
4056 When optional argument INFO is non-nil, it should be a plist
4057 holding export options. In that case, parts of the parse tree
4058 not exportable according to that property list will be skipped.
4060 When optional argument FIRST-MATCH is non-nil, stop at the first
4061 match for which FUN doesn't return nil, and return that value.
4063 Optional argument NO-RECURSION is a symbol or a list of symbols
4064 representing elements or objects types. `org-element-map' won't
4065 enter any recursive element or object whose type belongs to that
4066 list. Though, FUN can still be applied on them.
4068 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4069 apply to matching objects within parsed affiliated keywords (see
4070 `org-element-parsed-keywords').
4072 Nil values returned from FUN do not appear in the results.
4075 Examples:
4076 ---------
4078 Assuming TREE is a variable containing an Org buffer parse tree,
4079 the following example will return a flat list of all `src-block'
4080 and `example-block' elements in it:
4082 \(org-element-map tree '(example-block src-block) 'identity)
4084 The following snippet will find the first headline with a level
4087 \(org-element-map tree 'headline
4088 \(lambda (hl)
4089 \(and (= (org-element-property :level hl) 1)
4091 \(org-element-property :begin hl)))
4092 nil t)
4094 The next example will return a flat list of all `plain-list' type
4095 elements in TREE that are not a sub-list themselves:
4097 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4099 Eventually, this example will return a flat list of all `bold'
4100 type objects containing a `latex-snippet' type object, even
4101 looking into captions:
4103 \(org-element-map tree 'bold
4104 \(lambda (b)
4105 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4106 nil nil nil t)"
4107 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4110 ;; Recursion depth is determined by --CATEGORY.
4117 ;; If one object is found, the function
4118 ;; has to recurse into every object.
4121 ;; If one regular element is found, the
4122 ;; function has to recurse, at least,
4123 ;; into every element it encounters.
4126 types)
4127 category)))
4128 ;; Compute properties for affiliated keywords if necessary.
4133 org-element-affiliated-keywords)))
4134 --acc
4135 --walk-tree
4139 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4140 ;; holding contextual information.
4144 ;; Ignored element in an export context.
4146 ;; List of elements or objects.
4148 ;; Unconditionally enter parse trees.
4152 ;; Check if TYPE is matching among TYPES. If so,
4153 ;; apply FUN to --DATA and accumulate return value
4154 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4160 ;; If --DATA has a secondary string that can contain
4161 ;; objects with their type among TYPES, look into it.
4168 ;; If --DATA has any affiliated keywords and
4169 ;; WITH-AFFILIATED is non-nil, look for objects in
4170 ;; them.
4178 ;; Pay attention to the type of value.
4179 ;; Preserve order for multiple keywords.
4195 --affiliated-alist))
4196 ;; Determine if a recursion into --DATA is possible.
4198 ;; --TYPE is explicitly removed from recursion.
4200 ;; --DATA has no contents.
4202 ;; Looking for greater elements but --DATA is simply
4203 ;; an element or an object.
4206 ;; Looking for elements but --DATA is an object.
4209 ;; In any other case, map contents.
4213 ;; Return value in a proper order.
4217 ;; The following functions are internal parts of the parser.
4218 ;;
4219 ;; The first one, `org-element--parse-elements' acts at the element's
4220 ;; level.
4221 ;;
4222 ;; The second one, `org-element--parse-objects' applies on all objects
4223 ;; of a paragraph or a secondary string. It uses
4224 ;; `org-element--get-next-object-candidates' to optimize the search of
4225 ;; the next object in the buffer.
4226 ;;
4227 ;; More precisely, that function looks for every allowed object type
4228 ;; first. Then, it discards failed searches, keeps further matches,
4229 ;; and searches again types matched behind point, for subsequent
4230 ;; calls. Thus, searching for a given type fails only once, and every
4231 ;; object is searched only once at top level (but sometimes more for
4232 ;; nested types).
4236 "Parse elements between BEG and END positions.
4238 SPECIAL prioritize some elements over the others. It can be set
4239 to `first-section', `quote-section', `section' `item' or
4240 `table-row'.
4242 When value is `item', STRUCTURE will be used as the current list
4243 structure.
4245 GRANULARITY determines the depth of the recursion. See
4246 `org-element-parse-buffer' for more information.
4248 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4249 elements.
4251 Elements are accumulated into ACC."
4254 ;; Visible only: skip invisible parts at the beginning of the
4255 ;; element.
4258 ;; When parsing only headlines, skip any text before first one.
4261 ;; Main loop start.
4263 ;; Find current element's type and parse it accordingly to
4264 ;; its category.
4266 end granularity special structure))
4270 ;; Visible only: skip invisible parts between siblings.
4273 ;; Fill ELEMENT contents by side-effect.
4275 ;; If element has no contents, don't modify it.
4277 ;; Greater element: parse it between `contents-begin' and
4278 ;; `contents-end'. Make sure GRANULARITY allows the
4279 ;; recursion, or ELEMENT is a headline, in which case going
4280 ;; inside is mandatory, in order to get sub-level headings.
4288 ;; Possibly switch to a special mode.
4298 granularity visible-only element))
4299 ;; ELEMENT has contents. Parse objects inside, if
4300 ;; GRANULARITY allows it.
4306 ;; Return result.
4307 acc))
4310 "Parse objects between BEG and END and return recursive structure.
4312 Objects are accumulated in ACC.
4314 RESTRICTION is a list of object successors which are allowed in
4315 the current object."
4321 end restriction candidates)))
4328 ;; 1. Text before any object. Untabify it.
4333 acc
4337 ;; 2. Object...
4340 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4341 ;; a recursive type.
4346 cont-beg
4353 ;; 3. Text after last object. Untabify it.
4357 acc
4361 ;; Result.
4362 acc)))
4365 "Return an alist of candidates for the next object.
4367 LIMIT bounds the search, and RESTRICTION narrows candidates to
4368 some object successors.
4370 OBJECTS is the previous candidates alist. If it is set to
4371 `initial', no search has been done before, and all symbols in
4372 RESTRICTION should be looked after.
4374 Return value is an alist whose CAR is the object type and CDR its
4375 beginning position."
4377 nil
4379 ;; When searching for the first time, look for every successor
4380 ;; allowed in RESTRICTION.
4384 restriction)
4385 ;; Focus on objects returned during last search. Keep those
4386 ;; still after point. Search again objects before it.
4392 type)))
4395 limit)))))
4396 objects))))
4399 \f
4400 ;;; Towards A Bijective Process
4401 ;;
4402 ;; The parse tree obtained with `org-element-parse-buffer' is really
4403 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4404 ;; interpreted and expanded into a string with canonical Org syntax.
4405 ;; Hence `org-element-interpret-data'.
4406 ;;
4407 ;; The function relies internally on
4408 ;; `org-element--interpret-affiliated-keywords'.
4410 ;;;###autoload
4412 "Interpret DATA as Org syntax.
4414 DATA is a parse tree, an element, an object or a secondary string
4415 to interpret.
4417 Optional argument PARENT is used for recursive calls. It contains
4418 the element or object containing data, or nil.
4420 Return Org syntax as a string."
4424 ;; Secondary string.
4429 ;; Full Org document.
4434 ;; Plain text: remove `:parent' text property from output.
4436 ;; Element/Object without contents.
4439 data nil))
4440 ;; Element/Object with contents.
4450 ;; Elements directly containing objects must
4451 ;; have their indentation normalized first.
4453 data
4454 ;; When normalizing first paragraph of an
4455 ;; item or a footnote-definition, ignore
4456 ;; first line's indentation.
4463 data
4465 contents)))))))
4467 ;; Build white spaces. If no `:post-blank' property is
4468 ;; specified, assume its value is 0.
4478 "Return ELEMENT's affiliated keywords as Org syntax.
4479 If there is no affiliated keyword, return the empty string."
4489 ": "
4492 value)
4500 ;; All attribute keywords can have multiple lines.
4506 ;; List all ELEMENT's properties matching an attribute line or an
4507 ;; affiliated keyword, but ignore translated keywords since they
4508 ;; cannot belong to the property list.
4515 org-element-keyword-translation-alist)))))
4516 collect prop)
4519 ;; Because interpretation of the parse tree must return the same
4520 ;; number of blank lines between elements and the same number of white
4521 ;; space after objects, some special care must be given to white
4522 ;; spaces.
4523 ;;
4524 ;; The first function, `org-element-normalize-string', ensures any
4525 ;; string different from the empty string will end with a single
4526 ;; newline character.
4527 ;;
4528 ;; The second function, `org-element-normalize-contents', removes
4529 ;; global indentation from the contents of the current element.
4532 "Ensure string S ends with a single newline character.
4534 If S isn't a string return it unchanged. If S is the empty
4535 string, return it. Otherwise, return a new string with a single
4536 newline character at its end."
4544 "Normalize plain text in ELEMENT's contents.
4546 ELEMENT must only contain plain text and objects.
4548 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4549 indentation to compute maximal common indentation.
4551 Return the normalized element that is element with global
4552 indentation removed from its contents. The function assumes that
4553 indentation is not done with TAB characters."
4555 collect-inds ; for byte-compiler
4558 ;; Return list of indentations within BLOB. This is done by
4559 ;; walking recursively BLOB and updating IND-LIST along the
4560 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4561 ;; been seen yet. It is required as this string is the only
4562 ;; one whose indentation doesn't happen after a newline
4563 ;; character.
4571 ;; An indentation of zero means no string will be
4572 ;; modified. Quit the process.
4578 ;; Avoid matching blank or empty lines.
4586 ;; Collect indentation list in ELEMENT. Possibly remove first
4587 ;; value if IGNORE-FIRST is non-nil.
4590 ;; Build ELEMENT back, replacing each string with the same
4591 ;; string minus common indentation.
4596 ;; Return BLOB with all its strings indentation
4597 ;; shortened from MCI white spaces. FIRST-FLAG is
4598 ;; non-nil when the first string hasn't been seen
4599 ;; yet.
4613 org-element-recursive-objects)
4617 blob))))
4621 \f
4622 ;;; The Toolbox
4623 ;;
4624 ;; The first move is to implement a way to obtain the smallest element
4625 ;; containing point. This is the job of `org-element-at-point'. It
4626 ;; basically jumps back to the beginning of section containing point
4627 ;; and moves, element after element, with
4628 ;; `org-element--current-element' until the container is found. Note:
4629 ;; When using `org-element-at-point', secondary values are never
4630 ;; parsed since the function focuses on elements, not on objects.
4631 ;;
4632 ;; At a deeper level, `org-element-context' lists all elements and
4633 ;; objects containing point.
4634 ;;
4635 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4636 ;; internally by navigation and manipulation tools.
4638 ;;;###autoload
4640 "Determine closest element around point.
4642 Return value is a list like (TYPE PROPS) where TYPE is the type
4643 of the element and PROPS a plist of properties associated to the
4644 element.
4646 Possible types are defined in `org-element-all-elements'.
4647 Properties depend on element or object type, but always include
4648 `:begin', `:end', `:parent' and `:post-blank' properties.
4650 As a special case, if point is at the very beginning of a list or
4651 sub-list, returned element will be that list instead of the first
4652 item. In the same way, if point is at the beginning of the first
4653 row of a table, returned element will be the table instead of the
4654 first row.
4656 If optional argument KEEP-TRAIL is non-nil, the function returns
4657 a list of elements leading to element at point. The list's CAR
4658 is always the element at point. The following positions contain
4659 element's siblings, then parents, siblings of parents, until the
4660 first element of current section."
4662 ;; If at a headline, parse it. It is the sole element that
4663 ;; doesn't require to know about context. Be sure to disallow
4664 ;; secondary string parsing, though.
4670 ;; Otherwise move at the beginning of the section containing
4671 ;; point.
4676 element type special-flag trail struct prevs parent)
4679 ;; In empty lines at buffer's beginning, return nil.
4688 ;; In blank lines just after the headline, point still
4689 ;; belongs to the headline.
4697 ;; Parse successively each element, skipping those ending
4698 ;; before original position.
4706 ;; 1. Skip any element ending before point. Also skip
4707 ;; element ending at point when we're sure that another
4708 ;; element has started.
4713 ;; 2. An element containing point is always the element at
4714 ;; point.
4717 ;; 3. At any other greater element type, if point is
4718 ;; within contents, move into it.
4723 ;; Create an anchor for tables and plain lists:
4724 ;; when point is at the very beginning of these
4725 ;; elements, ignoring affiliated keywords,
4726 ;; target them instead of their contents.
4728 ;; When point is at contents end, do not move
4729 ;; into elements with an explicit ending, but
4730 ;; return that element instead.
4734 drawer dynamic-block inlinetask item
4735 plain-list property-drawer quote-block
4736 special-block))))
4751 ;;;###autoload
4753 "Return closest element or object around point.
4755 Return value is a list like (TYPE PROPS) where TYPE is the type
4756 of the element or object and PROPS a plist of properties
4757 associated to it.
4759 Possible types are defined in `org-element-all-elements' and
4760 `org-element-all-objects'. Properties depend on element or
4761 object type, but always include `:begin', `:end', `:parent' and
4762 `:post-blank'.
4764 Optional argument ELEMENT, when non-nil, is the closest element
4765 containing point, as returned by `org-element-at-point'.
4766 Providing it allows for quicker computation."
4771 end)
4772 ;; Check if point is inside an element containing objects or at
4773 ;; a secondary string. In that case, move to beginning of the
4774 ;; element or secondary string and set END to the other side.
4781 org-element-parsed-keywords))
4782 ;; We're at an affiliated keyword. Change
4783 ;; type to retrieve correct restrictions.
4785 ;; Determine if we're at main or dual value.
4799 (<= origin
4800 ;; `1+' is required so some
4801 ;; successors can match
4802 ;; properly their object.
4824 element
4830 end restriction candidates))
4832 candidates)))
4833 ;; If ORIGIN is before next object in element, there's
4834 ;; no point in looking further.
4844 ;; ORIGIN is after OBJECT, so skip it.
4850 ;; ORIGIN is within a non-recursive object or at
4851 ;; an object boundaries: Return that object.
4855 ;; Otherwise, move within current object and
4856 ;; restrict search to the end of its contents.
4861 candidates 'initial
4862 end cend)))))))
4863 parent))))))
4866 "Non-nil when elements ELEM-A and ELEM-B are nested."
4875 "Swap elements ELEM-A and ELEM-B.
4876 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4877 end of ELEM-A."
4879 ;; There are two special cases when an element doesn't start at bol:
4880 ;; the first paragraph in an item or in a footnote definition.
4882 ;; Only a paragraph without any affiliated keyword can be moved at
4883 ;; ELEM-A position in such a situation. Note that the case of
4884 ;; a footnote definition is impossible: it cannot contain two
4885 ;; paragraphs in a row because it cannot contain a blank line.
4891 ;; In a special situation, ELEM-A will have no indentation. We'll
4892 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4906 ;; Store overlays responsible for visibility status. We
4907 ;; also need to store their boundaries as they will be
4908 ;; removed from buffer.
4915 ;; Get contents.
4923 ;; Restore ex ELEM-A overlays.
4932 ;; Restore ex ELEM-B overlays.
4941 ;; Local variables:
4942 ;; generated-autoload-file: "org-loaddefs.el"
4943 ;; End:
4945 ;;; org-element.el ends here