| blob | c5d9ee99c7a0534b42aa4d7d1b24e90789a46365 |
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
1151 ;;;; Plain List
1154 "Parse a plain list.
1156 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1157 the buffer position at the beginning of the first affiliated
1158 keyword and CDR is a plist of affiliated keywords along with
1159 their value. STRUCTURE is the structure of the plain list being
1160 parsed.
1162 Return a list whose CAR is `plain-list' and CDR is a plist
1163 containing `:type', `:begin', `:end', `:contents-begin' and
1164 `:contents-end', `:structure', `:post-blank' and
1165 `:post-affiliated' keywords.
1167 Assume point is at the beginning of the list."
1182 ;; Return value.
1186 :begin begin
1187 :end end
1188 :contents-begin contents-begin
1189 :contents-end contents-end
1190 :structure struct
1196 "Interpret PLAIN-LIST element as Org syntax.
1197 CONTENTS is the contents of the element."
1205 ;;;; Property Drawer
1208 "Parse a property drawer.
1210 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1211 the buffer position at the beginning of the first affiliated
1212 keyword and CDR is a plist of affiliated keywords along with
1213 their value.
1215 Return a list whose CAR is `property-drawer' and CDR is a plist
1216 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1217 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1219 Assume point is at the beginning of the property drawer."
1224 ;; Incomplete drawer: parse it as a paragraph.
1244 :end end
1245 :hiddenp hidden
1246 :contents-begin contents-begin
1247 :contents-end contents-end
1253 "Interpret PROPERTY-DRAWER element as Org syntax.
1254 CONTENTS is the properties within the drawer."
1258 ;;;; Quote Block
1261 "Parse a quote block.
1263 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1264 the buffer position at the beginning of the first affiliated
1265 keyword and CDR is a plist of affiliated keywords along with
1266 their value.
1268 Return a list whose CAR is `quote-block' and CDR is a plist
1269 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1270 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1272 Assume point is at the beginning of the block."
1276 ;; Incomplete block: parse it as a paragraph.
1282 ;; Empty blocks have no contents.
1297 :end end
1298 :hiddenp hidden
1299 :contents-begin contents-begin
1300 :contents-end contents-end
1306 "Interpret QUOTE-BLOCK element as Org syntax.
1307 CONTENTS is the contents of the element."
1311 ;;;; Section
1314 "Parse a section.
1316 LIMIT bounds the search.
1318 Return a list whose CAR is `section' and CDR is a plist
1319 containing `:begin', `:end', `:contents-begin', `contents-end'
1320 and `:post-blank' keywords."
1322 ;; Beginning of section is the beginning of the first non-blank
1323 ;; line after previous headline.
1332 :end end
1333 :contents-begin begin
1334 :contents-end pos-before-blank
1338 "Interpret SECTION element as Org syntax.
1339 CONTENTS is the contents of the element."
1340 contents)
1343 ;;;; Special Block
1346 "Parse a special block.
1348 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1349 the buffer position at the beginning of the first affiliated
1350 keyword and CDR is a plist of affiliated keywords along with
1351 their value.
1353 Return a list whose CAR is `special-block' and CDR is a plist
1354 containing `:type', `:begin', `:end', `:hiddenp',
1355 `:contents-begin', `:contents-end', `:post-blank' and
1356 `:post-affiliated' keywords.
1358 Assume point is at the beginning of the block."
1365 limit t)))
1366 ;; Incomplete block: parse it as a paragraph.
1372 ;; Empty blocks have no contents.
1387 :begin begin
1388 :end end
1389 :hiddenp hidden
1390 :contents-begin contents-begin
1391 :contents-end contents-end
1397 "Interpret SPECIAL-BLOCK element as Org syntax.
1398 CONTENTS is the contents of the element."
1403 \f
1404 ;;; Elements
1405 ;;
1406 ;; For each element, a parser and an interpreter are also defined.
1407 ;; Both follow the same naming convention used for greater elements.
1408 ;;
1409 ;; Also, as for greater elements, adding a new element type is done
1410 ;; through the following steps: implement a parser and an interpreter,
1411 ;; tweak `org-element--current-element' so that it recognizes the new
1412 ;; type and add that new type to `org-element-all-elements'.
1413 ;;
1414 ;; As a special case, when the newly defined type is a block type,
1415 ;; `org-element-block-name-alist' has to be modified accordingly.
1418 ;;;; Babel Call
1421 "Parse a babel call.
1423 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1424 the buffer position at the beginning of the first affiliated
1425 keyword and CDR is a plist of affiliated keywords along with
1426 their value.
1428 Return a list whose CAR is `babel-call' and CDR is a plist
1429 containing `:begin', `:end', `:info', `:post-blank' and
1430 `:post-affiliated' as keywords."
1444 :end end
1445 :info info
1451 "Interpret BABEL-CALL element as Org syntax.
1452 CONTENTS is nil."
1458 ;; Remove redundant square brackets.
1463 ;;;; Clock
1466 "Parse a clock.
1468 LIMIT bounds the search.
1470 Return a list whose CAR is `clock' and CDR is a plist containing
1471 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1472 as keywords."
1492 :value value
1493 :duration duration
1494 :begin begin
1495 :end end
1499 "Interpret CLOCK element as Org syntax.
1500 CONTENTS is nil."
1508 "%2s:%02s"
1512 ;;;; Comment
1515 "Parse a comment.
1517 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1518 the buffer position at the beginning of the first affiliated
1519 keyword and CDR is a plist of affiliated keywords along with
1520 their value.
1522 Return a list whose CAR is `comment' and CDR is a plist
1523 containing `:begin', `:end', `:value', `:post-blank',
1524 `:post-affiliated' keywords.
1526 Assume point is at comment beginning."
1535 ;; Get comments ending.
1538 ;; Accumulate lines without leading hash and first
1539 ;; whitespace.
1554 :end end
1555 :value value
1561 "Interpret COMMENT element as Org syntax.
1562 CONTENTS is nil."
1566 ;;;; Comment Block
1569 "Parse an export block.
1571 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1572 the buffer position at the beginning of the first affiliated
1573 keyword and CDR is a plist of affiliated keywords along with
1574 their value.
1576 Return a list whose CAR is `comment-block' and CDR is a plist
1577 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1578 and `:post-affiliated' keywords.
1580 Assume point is at comment block beginning."
1584 ;; Incomplete block: parse it as a paragraph.
1599 contents-begin contents-end)))
1603 :end end
1604 :value value
1605 :hiddenp hidden
1611 "Interpret COMMENT-BLOCK element as Org syntax.
1612 CONTENTS is nil."
1617 ;;;; Diary Sexp
1620 "Parse a diary sexp.
1622 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1623 the buffer position at the beginning of the first affiliated
1624 keyword and CDR is a plist of affiliated keywords along with
1625 their value.
1627 Return a list whose CAR is `diary-sexp' and CDR is a plist
1628 containing `:begin', `:end', `:value', `:post-blank' and
1629 `:post-affiliated' keywords."
1642 :begin begin
1643 :end end
1649 "Interpret DIARY-SEXP as Org syntax.
1650 CONTENTS is nil."
1654 ;;;; Example Block
1657 "Remove maximum common indentation in string S and return it.
1658 When optional argument N is a positive integer, remove exactly
1659 that much characters from indentation, if possible, or return
1660 S as-is otherwise. Unlike to `org-remove-indentation', this
1661 function doesn't call `untabify' on S."
1666 ;; Find maximum common indentation, if not specified.
1674 min-ind)))
1676 ;; Remove exactly N indentation, but give up if not possible.
1686 "Parse an example block.
1688 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1689 the buffer position at the beginning of the first affiliated
1690 keyword and CDR is a plist of affiliated keywords along with
1691 their value.
1693 Return a list whose CAR is `example-block' and CDR is a plist
1694 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1695 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1696 `:switches', `:value', `:post-blank' and `:post-affiliated'
1697 keywords."
1701 ;; Incomplete block: parse it as a paragraph.
1709 ;; Switches analysis
1717 ;; Should labels be retained in (or stripped from) example
1718 ;; blocks?
1723 ;; What should code-references use - labels or
1724 ;; line-numbers?
1733 ;; Standard block parsing.
1742 contents-begin contents-end))
1753 :end end
1754 :value value
1755 :switches switches
1756 :number-lines number-lines
1757 :preserve-indent preserve-indent
1758 :retain-labels retain-labels
1759 :use-labels use-labels
1760 :label-fmt label-fmt
1761 :hiddenp hidden
1767 "Interpret EXAMPLE-BLOCK element as Org syntax.
1768 CONTENTS is nil."
1776 ;;;; Export Block
1779 "Parse an export block.
1781 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1782 the buffer position at the beginning of the first affiliated
1783 keyword and CDR is a plist of affiliated keywords along with
1784 their value.
1786 Return a list whose CAR is `export-block' and CDR is a plist
1787 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1788 `:post-blank' and `:post-affiliated' keywords.
1790 Assume point is at export-block beginning."
1797 ;; Incomplete block: parse it as a paragraph.
1812 contents-end)))
1816 :end end
1817 :type type
1818 :value value
1819 :hiddenp hidden
1825 "Interpret EXPORT-BLOCK element as Org syntax.
1826 CONTENTS is nil."
1833 ;;;; Fixed-width
1836 "Parse a fixed-width section.
1838 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1839 the buffer position at the beginning of the first affiliated
1840 keyword and CDR is a plist of affiliated keywords along with
1841 their value.
1843 Return a list whose CAR is `fixed-width' and CDR is a plist
1844 containing `:begin', `:end', `:value', `:post-blank' and
1845 `:post-affiliated' keywords.
1847 Assume point is at the beginning of the fixed-width area."
1851 value
1856 ;; Accumulate text without starting colons.
1870 :end end
1871 :value value
1877 "Interpret FIXED-WIDTH element as Org syntax.
1878 CONTENTS is nil."
1886 ;;;; Horizontal Rule
1889 "Parse an horizontal rule.
1891 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1892 the buffer position at the beginning of the first affiliated
1893 keyword and CDR is a plist of affiliated keywords along with
1894 their value.
1896 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1897 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1898 keywords."
1909 :end end
1915 "Interpret HORIZONTAL-RULE element as Org syntax.
1916 CONTENTS is nil."
1920 ;;;; Keyword
1923 "Parse a keyword at point.
1925 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1926 the buffer position at the beginning of the first affiliated
1927 keyword and CDR is a plist of affiliated keywords along with
1928 their value.
1930 Return a list whose CAR is `keyword' and CDR is a plist
1931 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1932 `:post-affiliated' keywords."
1947 :value value
1948 :begin begin
1949 :end end
1955 "Interpret KEYWORD element as Org syntax.
1956 CONTENTS is nil."
1962 ;;;; Latex Environment
1965 "Parse a LaTeX environment.
1967 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1968 the buffer position at the beginning of the first affiliated
1969 keyword and CDR is a plist of affiliated keywords along with
1970 their value.
1972 Return a list whose CAR is `latex-environment' and CDR is a plist
1973 containing `:begin', `:end', `:value', `:post-blank' and
1974 `:post-affiliated' keywords.
1976 Assume point is at the beginning of the latex environment."
1983 limit t))
1984 ;; Incomplete latex environment: parse it as a paragraph.
1995 :end end
1996 :value value
2002 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2003 CONTENTS is nil."
2007 ;;;; Node Property
2010 "Parse a node-property at point.
2012 LIMIT bounds the search.
2014 Return a list whose CAR is `node-property' and CDR is a plist
2015 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2016 keywords."
2028 :value value
2029 :begin begin
2030 :end end
2034 "Interpret NODE-PROPERTY element as Org syntax.
2035 CONTENTS is nil."
2041 ;;;; Paragraph
2044 "Parse a paragraph.
2046 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2047 the buffer position at the beginning of the first affiliated
2048 keyword and CDR is a plist of affiliated keywords along with
2049 their value.
2051 Return a list whose CAR is `paragraph' and CDR is a plist
2052 containing `:begin', `:end', `:contents-begin' and
2053 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2055 Assume point is at the beginning of the paragraph."
2064 limit
2065 ;; A matching `org-element-paragraph-separate' is not
2066 ;; necessarily the end of the paragraph. In
2067 ;; particular, lines starting with # or : as a first
2068 ;; non-space character are ambiguous. We have check
2069 ;; if they are valid Org syntax (i.e. not an
2070 ;; incomplete keyword).
2074 ;; There's no ambiguity for other symbols or
2075 ;; empty lines: stop here.
2077 ;; Stop at valid fixed-width areas.
2079 ;; Stop at drawers.
2084 ;; Stop at valid comments.
2086 ;; Stop at valid dynamic blocks.
2091 ;; Stop at valid blocks.
2098 limit t)))
2099 ;; Stop at valid latex environments.
2106 limit t)))
2107 ;; Stop at valid keywords.
2109 ;; Skip everything else.
2127 :end end
2128 :contents-begin contents-begin
2129 :contents-end contents-end
2135 "Interpret PARAGRAPH element as Org syntax.
2136 CONTENTS is the contents of the element."
2137 contents)
2140 ;;;; Planning
2143 "Parse a planning.
2145 LIMIT bounds the search.
2147 Return a list whose CAR is `planning' and CDR is a plist
2148 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2149 and `:post-blank' keywords."
2159 closed deadline scheduled)
2171 :deadline deadline
2172 :scheduled scheduled
2173 :begin begin
2174 :end end
2178 "Interpret PLANNING element as Org syntax.
2179 CONTENTS is nil."
2181 'identity
2198 ;;;; Quote Section
2201 "Parse a quote section.
2203 LIMIT bounds the search.
2205 Return a list whose CAR is `quote-section' and CDR is a plist
2206 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2208 Assume point is at beginning of the section."
2219 :end end
2220 :value value
2224 "Interpret QUOTE-SECTION element as Org syntax.
2225 CONTENTS is nil."
2229 ;;;; Src Block
2232 "Parse a src block.
2234 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2235 the buffer position at the beginning of the first affiliated
2236 keyword and CDR is a plist of affiliated keywords along with
2237 their value.
2239 Return a list whose CAR is `src-block' and CDR is a plist
2240 containing `:language', `:switches', `:parameters', `:begin',
2241 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2242 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2243 `:post-blank' and `:post-affiliated' keywords.
2245 Assume point is at the beginning of the block."
2248 limit t)))
2249 ;; Incomplete block: parse it as a paragraph.
2255 ;; Get language as a string.
2264 ;; Get switches.
2266 ;; Get parameters.
2268 ;; Switches analysis
2280 ;; Should labels be retained in (or stripped from)
2281 ;; src blocks?
2286 ;; What should code-references use - labels or
2287 ;; line-numbers?
2292 ;; Indentation.
2294 ;; Get visibility status.
2296 ;; Retrieve code.
2305 ;; Get position after ending blank lines.
2316 :begin begin
2317 :end end
2318 :number-lines number-lines
2319 :preserve-indent preserve-indent
2320 :retain-labels retain-labels
2321 :use-labels use-labels
2322 :label-fmt label-fmt
2323 :hiddenp hidden
2324 :value value
2330 "Interpret SRC-BLOCK element as Org syntax.
2331 CONTENTS is nil."
2352 ;;;; Table
2355 "Parse a table at point.
2357 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2358 the buffer position at the beginning of the first affiliated
2359 keyword and CDR is a plist of affiliated keywords along with
2360 their value.
2362 Return a list whose CAR is `table' and CDR is a plist containing
2363 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2364 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2365 keywords.
2367 Assume point is at the beginning of the table."
2381 acc))
2389 :end end
2390 :type type
2391 :tblfm tblfm
2392 ;; Only `org' tables have contents. `table.el' tables
2393 ;; use a `:value' property to store raw table as
2394 ;; a string.
2399 table-begin table-end))
2405 "Interpret TABLE element as Org syntax.
2406 CONTENTS is nil."
2417 ;;;; Table Row
2420 "Parse table row at point.
2422 LIMIT bounds the search.
2424 Return a list whose CAR is `table-row' and CDR is a plist
2425 containing `:begin', `:end', `:contents-begin', `:contents-end',
2426 `:type' and `:post-blank' keywords."
2430 ;; A table rule has no contents. In that case, ensure
2431 ;; CONTENTS-BEGIN matches CONTENTS-END.
2443 :begin begin
2444 :end end
2445 :contents-begin contents-begin
2446 :contents-end contents-end
2450 "Interpret TABLE-ROW element as Org syntax.
2451 CONTENTS is the contents of the table row."
2456 ;;;; Verse Block
2459 "Parse a verse block.
2461 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2462 the buffer position at the beginning of the first affiliated
2463 keyword and CDR is a plist of affiliated keywords along with
2464 their value.
2466 Return a list whose CAR is `verse-block' and CDR is a plist
2467 containing `:begin', `:end', `:contents-begin', `:contents-end',
2468 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2470 Assume point is at beginning of the block."
2474 ;; Incomplete block: parse it as a paragraph.
2491 :end end
2492 :contents-begin contents-begin
2493 :contents-end contents-end
2494 :hiddenp hidden
2500 "Interpret VERSE-BLOCK element as Org syntax.
2501 CONTENTS is verse block contents."
2505 \f
2506 ;;; Objects
2507 ;;
2508 ;; Unlike to elements, interstices can be found between objects.
2509 ;; That's why, along with the parser, successor functions are provided
2510 ;; for each object. Some objects share the same successor (i.e. `code'
2511 ;; and `verbatim' objects).
2512 ;;
2513 ;; A successor must accept a single argument bounding the search. It
2514 ;; will return either a cons cell whose CAR is the object's type, as
2515 ;; a symbol, and CDR the position of its next occurrence, or nil.
2516 ;;
2517 ;; Successors follow the naming convention:
2518 ;; org-element-NAME-successor, where NAME is the name of the
2519 ;; successor, as defined in `org-element-all-successors'.
2520 ;;
2521 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2522 ;; object types they can contain will be specified in
2523 ;; `org-element-object-restrictions'.
2524 ;;
2525 ;; Adding a new type of object is simple. Implement a successor,
2526 ;; a parser, and an interpreter for it, all following the naming
2527 ;; convention. Register type in `org-element-all-objects' and
2528 ;; successor in `org-element-all-successors'. Maybe tweak
2529 ;; restrictions about it, and that's it.
2532 ;;;; Bold
2535 "Parse bold object at point.
2537 Return a list whose CAR is `bold' and CDR is a plist with
2538 `:begin', `:end', `:contents-begin' and `:contents-end' and
2539 `:post-blank' keywords.
2541 Assume point is at the first star marker."
2553 :end end
2554 :contents-begin contents-begin
2555 :contents-end contents-end
2559 "Interpret BOLD object as Org syntax.
2560 CONTENTS is the contents of the object."
2564 "Search for the next text-markup object.
2566 LIMIT bounds the search.
2568 Return value is a cons cell whose CAR is a symbol among `bold',
2569 `italic', `underline', `strike-through', `code' and `verbatim'
2570 and CDR is beginning position."
2586 ;;;; Code
2589 "Parse code object at point.
2591 Return a list whose CAR is `code' and CDR is a plist with
2592 `:value', `:begin', `:end' and `:post-blank' keywords.
2594 Assume point is at the first tilde marker."
2605 :begin begin
2606 :end end
2610 "Interpret CODE object as Org syntax.
2611 CONTENTS is nil."
2615 ;;;; Entity
2618 "Parse entity at point.
2620 Return a list whose CAR is `entity' and CDR a plist with
2621 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2622 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2623 keywords.
2625 Assume point is at the beginning of the entity."
2627 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2643 :begin begin
2644 :end end
2645 :use-brackets-p bracketsp
2649 "Interpret ENTITY object as Org syntax.
2650 CONTENTS is nil."
2656 "Search for the next latex-fragment or entity object.
2658 LIMIT bounds the search.
2660 Return value is a cons cell whose CAR is `entity' or
2661 `latex-fragment' and CDR is beginning position."
2666 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2673 limit t)
2676 ;; Determine if it's a real entity or a LaTeX command.
2679 ;; No entity nor command: point is at a LaTeX fragment.
2680 ;; Determine its type to get the correct beginning position.
2688 matchers)
2692 ;;;; Export Snippet
2695 "Parse export snippet at point.
2697 Return a list whose CAR is `export-snippet' and CDR a plist with
2698 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2699 keywords.
2701 Assume point is at the beginning of the snippet."
2713 :value value
2714 :begin begin
2715 :end end
2719 "Interpret EXPORT-SNIPPET object as Org syntax.
2720 CONTENTS is nil."
2726 "Search for the next export-snippet object.
2728 LIMIT bounds the search.
2730 Return value is a cons cell whose CAR is `export-snippet' and CDR
2731 its beginning position."
2740 ;;;; Footnote Reference
2743 "Parse footnote reference at point.
2745 Return a list whose CAR is `footnote-reference' and CDR a plist
2746 with `:label', `:type', `:inline-definition', `:begin', `:end'
2747 and `:post-blank' as keywords."
2769 :type type
2770 :begin begin
2771 :end end
2774 footnote-reference :inline-definition
2779 footnote-reference))))))
2782 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2783 CONTENTS is nil."
2793 "Search for the next footnote-reference object.
2795 LIMIT bounds the search.
2797 Return value is a cons cell whose CAR is `footnote-reference' and
2798 CDR is beginning position."
2812 ;;;; Inline Babel Call
2815 "Parse inline babel call at point.
2817 Return a list whose CAR is `inline-babel-call' and CDR a plist
2818 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2820 Assume point is at the beginning of the babel call."
2831 :end end
2832 :info info
2836 "Interpret INLINE-BABEL-CALL object as Org syntax.
2837 CONTENTS is nil."
2843 ;; Remove redundant square brackets.
2846 main-source)
2850 "Search for the next inline-babel-call object.
2852 LIMIT bounds the search.
2854 Return value is a cons cell whose CAR is `inline-babel-call' and
2855 CDR is beginning position."
2857 ;; Use a simplified version of
2858 ;; `org-babel-inline-lob-one-liner-regexp'.
2861 limit t)
2865 ;;;; Inline Src Block
2868 "Parse inline source block at point.
2870 LIMIT bounds the search.
2872 Return a list whose CAR is `inline-src-block' and CDR a plist
2873 with `:begin', `:end', `:language', `:value', `:parameters' and
2874 `:post-blank' as keywords.
2876 Assume point is at the beginning of the inline src block."
2889 :value value
2890 :parameters parameters
2891 :begin begin
2892 :end end
2896 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2897 CONTENTS is nil."
2902 language
2904 body)))
2907 "Search for the next inline-babel-call element.
2909 LIMIT bounds the search.
2911 Return value is a cons cell whose CAR is `inline-babel-call' and
2912 CDR is beginning position."
2918 ;;;; Italic
2921 "Parse italic object at point.
2923 Return a list whose CAR is `italic' and CDR is a plist with
2924 `:begin', `:end', `:contents-begin' and `:contents-end' and
2925 `:post-blank' keywords.
2927 Assume point is at the first slash marker."
2939 :end end
2940 :contents-begin contents-begin
2941 :contents-end contents-end
2945 "Interpret ITALIC object as Org syntax.
2946 CONTENTS is the contents of the object."
2950 ;;;; Latex Fragment
2953 "Parse latex fragment at point.
2955 Return a list whose CAR is `latex-fragment' and CDR a plist with
2956 `:value', `:begin', `:end', and `:post-blank' as keywords.
2958 Assume point is at the beginning of the latex fragment."
2972 ;; None found: it's a macro.
2981 :begin begin
2982 :end end
2986 "Interpret LATEX-FRAGMENT object as Org syntax.
2987 CONTENTS is nil."
2990 ;;;; Line Break
2993 "Parse line break at point.
2995 Return a list whose CAR is `line-break', and CDR a plist with
2996 `:begin', `:end' and `:post-blank' keywords.
2998 Assume point is at the beginning of the line break."
3005 "Interpret LINE-BREAK object as Org syntax.
3006 CONTENTS is nil."
3010 "Search for the next line-break object.
3012 LIMIT bounds the search.
3014 Return value is a cons cell whose CAR is `line-break' and CDR is
3015 beginning position."
3019 ;; A line break can only happen on a non-empty line.
3024 ;;;; Link
3027 "Parse link at point.
3029 Return a list whose CAR is `link' and CDR a plist with `:type',
3030 `:path', `:raw-link', `:application', `:search-option', `:begin',
3031 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3032 keywords.
3034 Assume point is at the beginning of the link."
3037 end contents-begin contents-end link-end post-blank path type
3038 raw-link link search-option application)
3040 ;; Type 1: Text targeted from a radio target.
3045 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3050 ;; RAW-LINK is the original link. Expand any
3051 ;; abbreviation in it.
3056 ;; Determine TYPE of link and set PATH accordingly.
3058 ;; File type.
3061 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3064 ;; Id type: PATH is the id.
3067 ;; Code-ref type: PATH is the name of the reference.
3070 ;; Custom-id type: PATH is the name of the custom id.
3073 ;; Fuzzy type: Internal link either matches a target, an
3074 ;; headline name or nothing. PATH is the target or
3075 ;; headline's name.
3077 ;; Type 3: Plain link, i.e. http://orgmode.org
3083 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3090 ;; In any case, deduce end point after trailing white space from
3091 ;; LINK-END variable.
3094 ;; Extract search option and opening application out of
3095 ;; "file"-type links.
3097 ;; Application.
3102 ;; Extract search option from PATH.
3106 ;; Make sure TYPE always report "file".
3110 :path path
3112 :application application
3113 :search-option search-option
3114 :begin begin
3115 :end end
3116 :contents-begin contents-begin
3117 :contents-end contents-end
3121 "Interpret LINK object as Org syntax.
3122 CONTENTS is the contents of the object, or nil."
3127 raw-link
3131 "Search for the next link object.
3133 LIMIT bounds the search.
3135 Return value is a cons cell whose CAR is `link' and CDR is
3136 beginning position."
3145 "Search for the next plain link object.
3147 LIMIT bounds the search.
3149 Return value is a cons cell whose CAR is `link' and CDR is
3150 beginning position."
3155 ;;;; Macro
3158 "Parse macro at point.
3160 Return a list whose CAR is `macro' and CDR a plist with `:key',
3161 `:args', `:begin', `:end', `:value' and `:post-blank' as
3162 keywords.
3164 Assume point is at the macro."
3175 ;; Do not use `org-split-string' since empty
3176 ;; strings are meaningful here.
3184 args nil t)
3188 :value value
3189 :args args
3190 :begin begin
3191 :end end
3195 "Interpret MACRO object as Org syntax.
3196 CONTENTS is nil."
3200 "Search for the next macro object.
3202 LIMIT bounds the search.
3204 Return value is cons cell whose CAR is `macro' and CDR is
3205 beginning position."
3209 limit t)
3213 ;;;; Radio-target
3216 "Parse radio target at point.
3218 Return a list whose CAR is `radio-target' and CDR a plist with
3219 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3220 and `:post-blank' as keywords.
3222 Assume point is at the radio target."
3234 :end end
3235 :contents-begin contents-begin
3236 :contents-end contents-end
3237 :post-blank post-blank
3241 "Interpret TARGET object as Org syntax.
3242 CONTENTS is the contents of the object."
3246 "Search for the next radio-target object.
3248 LIMIT bounds the search.
3250 Return value is a cons cell whose CAR is `radio-target' and CDR
3251 is beginning position."
3257 ;;;; Statistics Cookie
3260 "Parse statistics cookie at point.
3262 Return a list whose CAR is `statistics-cookie', and CDR a plist
3263 with `:begin', `:end', `:value' and `:post-blank' keywords.
3265 Assume point is at the beginning of the statistics-cookie."
3276 :end end
3277 :value value
3281 "Interpret STATISTICS-COOKIE object as Org syntax.
3282 CONTENTS is nil."
3286 "Search for the next statistics cookie object.
3288 LIMIT bounds the search.
3290 Return value is a cons cell whose CAR is `statistics-cookie' and
3291 CDR is beginning position."
3297 ;;;; Strike-Through
3300 "Parse strike-through object at point.
3302 Return a list whose CAR is `strike-through' and CDR is a plist
3303 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3304 `:post-blank' keywords.
3306 Assume point is at the first plus sign marker."
3318 :end end
3319 :contents-begin contents-begin
3320 :contents-end contents-end
3324 "Interpret STRIKE-THROUGH object as Org syntax.
3325 CONTENTS is the contents of the object."
3329 ;;;; Subscript
3332 "Parse subscript at point.
3334 Return a list whose CAR is `subscript' and CDR a plist with
3335 `:begin', `:end', `:contents-begin', `:contents-end',
3336 `:use-brackets-p' and `:post-blank' as keywords.
3338 Assume point is at the underscore."
3342 t
3353 :end end
3354 :use-brackets-p bracketsp
3355 :contents-begin contents-begin
3356 :contents-end contents-end
3360 "Interpret SUBSCRIPT object as Org syntax.
3361 CONTENTS is the contents of the object."
3364 contents))
3367 "Search for the next sub/superscript object.
3369 LIMIT bounds the search.
3371 Return value is a cons cell whose CAR is either `subscript' or
3372 `superscript' and CDR is beginning position."
3380 ;;;; Superscript
3383 "Parse superscript at point.
3385 Return a list whose CAR is `superscript' and CDR a plist with
3386 `:begin', `:end', `:contents-begin', `:contents-end',
3387 `:use-brackets-p' and `:post-blank' as keywords.
3389 Assume point is at the caret."
3403 :end end
3404 :use-brackets-p bracketsp
3405 :contents-begin contents-begin
3406 :contents-end contents-end
3410 "Interpret SUPERSCRIPT object as Org syntax.
3411 CONTENTS is the contents of the object."
3414 contents))
3417 ;;;; Table Cell
3420 "Parse table cell at point.
3422 Return a list whose CAR is `table-cell' and CDR is a plist
3423 containing `:begin', `:end', `:contents-begin', `:contents-end'
3424 and `:post-blank' keywords."
3432 :end end
3433 :contents-begin contents-begin
3434 :contents-end contents-end
3438 "Interpret TABLE-CELL element as Org syntax.
3439 CONTENTS is the contents of the cell, or nil."
3443 "Search for the next table-cell object.
3445 LIMIT bounds the search.
3447 Return value is a cons cell whose CAR is `table-cell' and CDR is
3448 beginning position."
3452 ;;;; Target
3455 "Parse target at point.
3457 Return a list whose CAR is `target' and CDR a plist with
3458 `:begin', `:end', `:value' and `:post-blank' as keywords.
3460 Assume point is at the target."
3470 :end end
3471 :value value
3475 "Interpret TARGET object as Org syntax.
3476 CONTENTS is nil."
3480 "Search for the next target object.
3482 LIMIT bounds the search.
3484 Return value is a cons cell whose CAR is `target' and CDR is
3485 beginning position."
3491 ;;;; Timestamp
3494 "Parse time stamp at point.
3496 Return a list whose CAR is `timestamp', and CDR a plist with
3497 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3499 Assume point is at the beginning of the timestamp."
3517 date-start)
3528 raw-value)
3530 :repeater-type
3536 :repeater-unit
3539 year-start month-start day-start hour-start minute-start year-end
3540 month-end day-end hour-end minute-end)
3541 ;; Parse date-start.
3549 ;; Compute date-end. It can be provided directly in time-stamp,
3550 ;; or extracted from time range. Otherwise, it defaults to the
3551 ;; same values as date-start.
3561 :raw-value raw-value
3562 :year-start year-start
3563 :month-start month-start
3564 :day-start day-start
3565 :hour-start hour-start
3566 :minute-start minute-start
3567 :year-end year-end
3568 :month-end month-end
3569 :day-end day-end
3570 :hour-end hour-end
3571 :minute-end minute-end
3572 :begin begin
3573 :end end
3575 repeater-props)))))
3578 "Interpret TIMESTAMP object as Org syntax.
3579 CONTENTS is nil."
3580 ;; Use `:raw-value' if specified.
3582 ;; Otherwise, build timestamp string.
3592 ;; Build an Org timestamp string from TIME. ACTIVEP is
3593 ;; non-nil when time stamp is active. If WITH-TIME-P is
3594 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3595 ;; specify a time range in the timestamp. REPEAT-STRING
3596 ;; is the repeater string, if any.
3600 org-time-stamp-formats)
3601 time)))
3607 nil nil ts)))
3611 " "
3612 repeat-string
3614 ;; Return value.
3615 ts)))
3627 build-ts-string
3646 0
3654 "--"
3666 "Search for the next timestamp object.
3668 LIMIT bounds the search.
3670 Return value is a cons cell whose CAR is `timestamp' and CDR is
3671 beginning position."
3679 limit t)
3683 ;;;; Underline
3686 "Parse underline object at point.
3688 Return a list whose CAR is `underline' and CDR is a plist with
3689 `:begin', `:end', `:contents-begin' and `:contents-end' and
3690 `:post-blank' keywords.
3692 Assume point is at the first underscore marker."
3704 :end end
3705 :contents-begin contents-begin
3706 :contents-end contents-end
3710 "Interpret UNDERLINE object as Org syntax.
3711 CONTENTS is the contents of the object."
3715 ;;;; Verbatim
3718 "Parse verbatim object at point.
3720 Return a list whose CAR is `verbatim' and CDR is a plist with
3721 `:value', `:begin', `:end' and `:post-blank' keywords.
3723 Assume point is at the first equal sign marker."
3734 :begin begin
3735 :end end
3739 "Interpret VERBATIM object as Org syntax.
3740 CONTENTS is nil."
3744 \f
3745 ;;; Parsing Element Starting At Point
3746 ;;
3747 ;; `org-element--current-element' is the core function of this section.
3748 ;; It returns the Lisp representation of the element starting at
3749 ;; point.
3750 ;;
3751 ;; `org-element--current-element' makes use of special modes. They
3752 ;; are activated for fixed element chaining (i.e. `plain-list' >
3753 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3754 ;; `section'). Special modes are: `first-section', `item',
3755 ;; `node-property', `quote-section', `section' and `table-row'.
3759 "Parse the element starting at point.
3761 LIMIT bounds the search.
3763 Return value is a list like (TYPE PROPS) where TYPE is the type
3764 of the element and PROPS a plist of properties associated to the
3765 element.
3767 Possible types are defined in `org-element-all-elements'.
3769 Optional argument GRANULARITY determines the depth of the
3770 recursion. Allowed values are `headline', `greater-element',
3771 `element', `object' or nil. When it is broader than `object' (or
3772 nil), secondary values will not be parsed, since they only
3773 contain objects.
3775 Optional argument SPECIAL, when non-nil, can be either
3776 `first-section', `item', `node-property', `quote-section',
3777 `section', and `table-row'.
3779 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3780 be computed.
3782 This function assumes point is always at the beginning of the
3783 element it has to parse."
3786 ;; Determine if parsing depth allows for secondary strings
3787 ;; parsing. It only applies to elements referenced in
3788 ;; `org-element-secondary-value-alist'.
3791 ;; Item.
3794 ;; Table Row.
3796 ;; Node Property.
3798 ;; Headline.
3801 ;; Sections (must be checked after headline).
3807 limit)))
3808 ;; When not at bol, point is at the beginning of an item or
3809 ;; a footnote definition: next item is always a paragraph.
3811 ;; Planning and Clock.
3816 ;; Inlinetask.
3819 ;; From there, elements can have affiliated keywords.
3822 ;; Jumping over affiliated keywords put point off-limits.
3823 ;; Parse them as regular keywords.
3827 ;; LaTeX Environment.
3831 ;; Drawer and Property Drawer.
3836 ;; Fixed Width
3839 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3840 ;; Keywords.
3849 org-element-block-name-alist)))
3864 ;; Footnote Definition.
3867 ;; Horizontal Rule.
3870 ;; Diary Sexp.
3873 ;; Table.
3875 ;; List.
3879 ;; Default element: Paragraph.
3883 ;; Most elements can have affiliated keywords. When looking for an
3884 ;; element beginning, we want to move before them, as they belong to
3885 ;; that element, and, in the meantime, collect information they give
3886 ;; into appropriate properties. Hence the following function.
3889 "Collect affiliated keywords from point down to LIMIT.
3891 Return a list whose CAR is the position at the first of them and
3892 CDR a plist of keywords and values and move point to the
3893 beginning of the first line after them.
3895 As a special case, if element doesn't start at the beginning of
3896 the line (i.e. a paragraph starting an item), CAR is current
3897 position of point and CDR is nil."
3901 ;; RESTRICT is the list of objects allowed in parsed
3902 ;; keywords value.
3904 output)
3907 ;; Apply translation to RAW-KWD. From there, KWD is
3908 ;; the official keyword.
3910 org-element-keyword-translation-alist))
3911 raw-kwd))
3912 ;; Find main value for any keyword.
3918 ;; PARSEDP is non-nil when keyword should have its
3919 ;; value parsed.
3921 ;; If KWD is a dual keyword, find its secondary
3922 ;; value. Maybe parse it.
3929 ;; Attribute a property name to KWD.
3931 ;; Now set final shape for VALUE.
3937 ;; Attributes can always appear on multiple lines.
3940 ;; Eventually store the new value in OUTPUT.
3942 ;; Move to next keyword.
3944 ;; If affiliated keywords are orphaned: move back to first one.
3945 ;; They will be parsed as a paragraph.
3947 ;; Return value.
3951 \f
3952 ;;; The Org Parser
3953 ;;
3954 ;; The two major functions here are `org-element-parse-buffer', which
3955 ;; parses Org syntax inside the current buffer, taking into account
3956 ;; region, narrowing, or even visibility if specified, and
3957 ;; `org-element-parse-secondary-string', which parses objects within
3958 ;; a given string.
3959 ;;
3960 ;; The (almost) almighty `org-element-map' allows to apply a function
3961 ;; on elements or objects matching some type, and accumulate the
3962 ;; resulting values. In an export situation, it also skips unneeded
3963 ;; parts of the parse tree.
3966 "Recursively parse the buffer and return structure.
3967 If narrowing is in effect, only parse the visible part of the
3968 buffer.
3970 Optional argument GRANULARITY determines the depth of the
3971 recursion. It can be set to the following symbols:
3973 `headline' Only parse headlines.
3974 `greater-element' Don't recurse into greater elements excepted
3975 headlines and sections. Thus, elements
3976 parsed are the top-level ones.
3977 `element' Parse everything but objects and plain text.
3978 `object' Parse the complete buffer (default).
3980 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3981 elements.
3983 An element or an objects is represented as a list with the
3984 pattern (TYPE PROPERTIES CONTENTS), where :
3986 TYPE is a symbol describing the element or object. See
3987 `org-element-all-elements' and `org-element-all-objects' for an
3988 exhaustive list of such symbols. One can retrieve it with
3989 `org-element-type' function.
3991 PROPERTIES is the list of attributes attached to the element or
3992 object, as a plist. Although most of them are specific to the
3993 element or object type, all types share `:begin', `:end',
3994 `:post-blank' and `:parent' properties, which respectively
3995 refer to buffer position where the element or object starts,
3996 ends, the number of white spaces or blank lines after it, and
3997 the element or object containing it. Properties values can be
3998 obtained by using `org-element-property' function.
4000 CONTENTS is a list of elements, objects or raw strings
4001 contained in the current element or object, when applicable.
4002 One can access them with `org-element-contents' function.
4004 The Org buffer has `org-data' as type and nil as properties.
4005 `org-element-map' function can be used to find specific elements
4006 or objects within the parse tree.
4008 This function assumes that current major mode is `org-mode'."
4014 ;; Start in `first-section' mode so text before the first
4015 ;; headline belongs to a section.
4019 "Recursively parse objects in STRING and return structure.
4021 RESTRICTION is a symbol limiting the object types that will be
4022 looked after.
4024 Optional argument PARENT, when non-nil, is the element or object
4025 containing the secondary string. It is used to set correctly
4026 `:parent' property within the string."
4027 ;; Copy buffer-local variables listed in
4028 ;; `org-element-object-variables' into temporary buffer. This is
4029 ;; required since object parsing is dependent on these variables.
4033 org-element-object-variables))))
4041 secondary))
4042 secondary))))
4046 "Map a function on selected elements or objects.
4048 DATA is a parse tree, an element, an object, a string, or a list
4049 of such constructs. TYPES is a symbol or list of symbols of
4050 elements or objects types (see `org-element-all-elements' and
4051 `org-element-all-objects' for a complete list of types). FUN is
4052 the function called on the matching element or object. It has to
4053 accept one argument: the element or object itself.
4055 When optional argument INFO is non-nil, it should be a plist
4056 holding export options. In that case, parts of the parse tree
4057 not exportable according to that property list will be skipped.
4059 When optional argument FIRST-MATCH is non-nil, stop at the first
4060 match for which FUN doesn't return nil, and return that value.
4062 Optional argument NO-RECURSION is a symbol or a list of symbols
4063 representing elements or objects types. `org-element-map' won't
4064 enter any recursive element or object whose type belongs to that
4065 list. Though, FUN can still be applied on them.
4067 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4068 apply to matching objects within parsed affiliated keywords (see
4069 `org-element-parsed-keywords').
4071 Nil values returned from FUN do not appear in the results.
4074 Examples:
4075 ---------
4077 Assuming TREE is a variable containing an Org buffer parse tree,
4078 the following example will return a flat list of all `src-block'
4079 and `example-block' elements in it:
4081 \(org-element-map tree '(example-block src-block) 'identity)
4083 The following snippet will find the first headline with a level
4086 \(org-element-map tree 'headline
4087 \(lambda (hl)
4088 \(and (= (org-element-property :level hl) 1)
4090 \(org-element-property :begin hl)))
4091 nil t)
4093 The next example will return a flat list of all `plain-list' type
4094 elements in TREE that are not a sub-list themselves:
4096 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4098 Eventually, this example will return a flat list of all `bold'
4099 type objects containing a `latex-snippet' type object, even
4100 looking into captions:
4102 \(org-element-map tree 'bold
4103 \(lambda (b)
4104 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4105 nil nil nil t)"
4106 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4109 ;; Recursion depth is determined by --CATEGORY.
4116 ;; If one object is found, the function
4117 ;; has to recurse into every object.
4120 ;; If one regular element is found, the
4121 ;; function has to recurse, at least,
4122 ;; into every element it encounters.
4125 types)
4126 category)))
4127 ;; Compute properties for affiliated keywords if necessary.
4132 org-element-affiliated-keywords)))
4133 --acc
4134 --walk-tree
4138 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4139 ;; holding contextual information.
4143 ;; Ignored element in an export context.
4145 ;; List of elements or objects.
4147 ;; Unconditionally enter parse trees.
4151 ;; Check if TYPE is matching among TYPES. If so,
4152 ;; apply FUN to --DATA and accumulate return value
4153 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4159 ;; If --DATA has a secondary string that can contain
4160 ;; objects with their type among TYPES, look into it.
4167 ;; If --DATA has any affiliated keywords and
4168 ;; WITH-AFFILIATED is non-nil, look for objects in
4169 ;; them.
4177 ;; Pay attention to the type of value.
4178 ;; Preserve order for multiple keywords.
4194 --affiliated-alist))
4195 ;; Determine if a recursion into --DATA is possible.
4197 ;; --TYPE is explicitly removed from recursion.
4199 ;; --DATA has no contents.
4201 ;; Looking for greater elements but --DATA is simply
4202 ;; an element or an object.
4205 ;; Looking for elements but --DATA is an object.
4208 ;; In any other case, map contents.
4212 ;; Return value in a proper order.
4216 ;; The following functions are internal parts of the parser.
4217 ;;
4218 ;; The first one, `org-element--parse-elements' acts at the element's
4219 ;; level.
4220 ;;
4221 ;; The second one, `org-element--parse-objects' applies on all objects
4222 ;; of a paragraph or a secondary string. It uses
4223 ;; `org-element--get-next-object-candidates' to optimize the search of
4224 ;; the next object in the buffer.
4225 ;;
4226 ;; More precisely, that function looks for every allowed object type
4227 ;; first. Then, it discards failed searches, keeps further matches,
4228 ;; and searches again types matched behind point, for subsequent
4229 ;; calls. Thus, searching for a given type fails only once, and every
4230 ;; object is searched only once at top level (but sometimes more for
4231 ;; nested types).
4235 "Parse elements between BEG and END positions.
4237 SPECIAL prioritize some elements over the others. It can be set
4238 to `first-section', `quote-section', `section' `item' or
4239 `table-row'.
4241 When value is `item', STRUCTURE will be used as the current list
4242 structure.
4244 GRANULARITY determines the depth of the recursion. See
4245 `org-element-parse-buffer' for more information.
4247 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4248 elements.
4250 Elements are accumulated into ACC."
4253 ;; Visible only: skip invisible parts at the beginning of the
4254 ;; element.
4257 ;; When parsing only headlines, skip any text before first one.
4260 ;; Main loop start.
4262 ;; Find current element's type and parse it accordingly to
4263 ;; its category.
4265 end granularity special structure))
4269 ;; Visible only: skip invisible parts between siblings.
4272 ;; Fill ELEMENT contents by side-effect.
4274 ;; If element has no contents, don't modify it.
4276 ;; Greater element: parse it between `contents-begin' and
4277 ;; `contents-end'. Make sure GRANULARITY allows the
4278 ;; recursion, or ELEMENT is a headline, in which case going
4279 ;; inside is mandatory, in order to get sub-level headings.
4287 ;; Possibly switch to a special mode.
4297 granularity visible-only element))
4298 ;; ELEMENT has contents. Parse objects inside, if
4299 ;; GRANULARITY allows it.
4305 ;; Return result.
4306 acc))
4309 "Parse objects between BEG and END and return recursive structure.
4311 Objects are accumulated in ACC.
4313 RESTRICTION is a list of object successors which are allowed in
4314 the current object."
4320 end restriction candidates)))
4327 ;; 1. Text before any object. Untabify it.
4332 acc
4336 ;; 2. Object...
4339 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4340 ;; a recursive type.
4345 cont-beg
4352 ;; 3. Text after last object. Untabify it.
4356 acc
4360 ;; Result.
4361 acc)))
4364 "Return an alist of candidates for the next object.
4366 LIMIT bounds the search, and RESTRICTION narrows candidates to
4367 some object successors.
4369 OBJECTS is the previous candidates alist. If it is set to
4370 `initial', no search has been done before, and all symbols in
4371 RESTRICTION should be looked after.
4373 Return value is an alist whose CAR is the object type and CDR its
4374 beginning position."
4376 nil
4378 ;; When searching for the first time, look for every successor
4379 ;; allowed in RESTRICTION.
4383 restriction)
4384 ;; Focus on objects returned during last search. Keep those
4385 ;; still after point. Search again objects before it.
4391 type)))
4394 limit)))))
4395 objects))))
4398 \f
4399 ;;; Towards A Bijective Process
4400 ;;
4401 ;; The parse tree obtained with `org-element-parse-buffer' is really
4402 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4403 ;; interpreted and expanded into a string with canonical Org syntax.
4404 ;; Hence `org-element-interpret-data'.
4405 ;;
4406 ;; The function relies internally on
4407 ;; `org-element--interpret-affiliated-keywords'.
4409 ;;;###autoload
4411 "Interpret DATA as Org syntax.
4413 DATA is a parse tree, an element, an object or a secondary string
4414 to interpret.
4416 Optional argument PARENT is used for recursive calls. It contains
4417 the element or object containing data, or nil.
4419 Return Org syntax as a string."
4423 ;; Secondary string.
4428 ;; Full Org document.
4433 ;; Plain text: remove `:parent' text property from output.
4435 ;; Element/Object without contents.
4438 data nil))
4439 ;; Element/Object with contents.
4449 ;; Elements directly containing objects must
4450 ;; have their indentation normalized first.
4452 data
4453 ;; When normalizing first paragraph of an
4454 ;; item or a footnote-definition, ignore
4455 ;; first line's indentation.
4462 data
4464 contents)))))))
4466 ;; Build white spaces. If no `:post-blank' property is
4467 ;; specified, assume its value is 0.
4477 "Return ELEMENT's affiliated keywords as Org syntax.
4478 If there is no affiliated keyword, return the empty string."
4488 ": "
4491 value)
4499 ;; All attribute keywords can have multiple lines.
4505 ;; List all ELEMENT's properties matching an attribute line or an
4506 ;; affiliated keyword, but ignore translated keywords since they
4507 ;; cannot belong to the property list.
4514 org-element-keyword-translation-alist)))))
4515 collect prop)
4518 ;; Because interpretation of the parse tree must return the same
4519 ;; number of blank lines between elements and the same number of white
4520 ;; space after objects, some special care must be given to white
4521 ;; spaces.
4522 ;;
4523 ;; The first function, `org-element-normalize-string', ensures any
4524 ;; string different from the empty string will end with a single
4525 ;; newline character.
4526 ;;
4527 ;; The second function, `org-element-normalize-contents', removes
4528 ;; global indentation from the contents of the current element.
4531 "Ensure string S ends with a single newline character.
4533 If S isn't a string return it unchanged. If S is the empty
4534 string, return it. Otherwise, return a new string with a single
4535 newline character at its end."
4543 "Normalize plain text in ELEMENT's contents.
4545 ELEMENT must only contain plain text and objects.
4547 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4548 indentation to compute maximal common indentation.
4550 Return the normalized element that is element with global
4551 indentation removed from its contents. The function assumes that
4552 indentation is not done with TAB characters."
4554 collect-inds ; for byte-compiler
4557 ;; Return list of indentations within BLOB. This is done by
4558 ;; walking recursively BLOB and updating IND-LIST along the
4559 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4560 ;; been seen yet. It is required as this string is the only
4561 ;; one whose indentation doesn't happen after a newline
4562 ;; character.
4570 ;; An indentation of zero means no string will be
4571 ;; modified. Quit the process.
4577 ;; Avoid matching blank or empty lines.
4585 ;; Collect indentation list in ELEMENT. Possibly remove first
4586 ;; value if IGNORE-FIRST is non-nil.
4589 ;; Build ELEMENT back, replacing each string with the same
4590 ;; string minus common indentation.
4595 ;; Return BLOB with all its strings indentation
4596 ;; shortened from MCI white spaces. FIRST-FLAG is
4597 ;; non-nil when the first string hasn't been seen
4598 ;; yet.
4612 org-element-recursive-objects)
4616 blob))))
4620 \f
4621 ;;; The Toolbox
4622 ;;
4623 ;; The first move is to implement a way to obtain the smallest element
4624 ;; containing point. This is the job of `org-element-at-point'. It
4625 ;; basically jumps back to the beginning of section containing point
4626 ;; and moves, element after element, with
4627 ;; `org-element--current-element' until the container is found. Note:
4628 ;; When using `org-element-at-point', secondary values are never
4629 ;; parsed since the function focuses on elements, not on objects.
4630 ;;
4631 ;; At a deeper level, `org-element-context' lists all elements and
4632 ;; objects containing point.
4633 ;;
4634 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4635 ;; internally by navigation and manipulation tools.
4637 ;;;###autoload
4639 "Determine closest element around point.
4641 Return value is a list like (TYPE PROPS) where TYPE is the type
4642 of the element and PROPS a plist of properties associated to the
4643 element.
4645 Possible types are defined in `org-element-all-elements'.
4646 Properties depend on element or object type, but always include
4647 `:begin', `:end', `:parent' and `:post-blank' properties.
4649 As a special case, if point is at the very beginning of a list or
4650 sub-list, returned element will be that list instead of the first
4651 item. In the same way, if point is at the beginning of the first
4652 row of a table, returned element will be the table instead of the
4653 first row.
4655 If optional argument KEEP-TRAIL is non-nil, the function returns
4656 a list of elements leading to element at point. The list's CAR
4657 is always the element at point. The following positions contain
4658 element's siblings, then parents, siblings of parents, until the
4659 first element of current section."
4661 ;; If at a headline, parse it. It is the sole element that
4662 ;; doesn't require to know about context. Be sure to disallow
4663 ;; secondary string parsing, though.
4669 ;; Otherwise move at the beginning of the section containing
4670 ;; point.
4675 element type special-flag trail struct prevs parent)
4678 ;; In empty lines at buffer's beginning, return nil.
4687 ;; In blank lines just after the headline, point still
4688 ;; belongs to the headline.
4696 ;; Parse successively each element, skipping those ending
4697 ;; before original position.
4705 ;; 1. Skip any element ending before point. Also skip
4706 ;; element ending at point when we're sure that another
4707 ;; element has started.
4712 ;; 2. An element containing point is always the element at
4713 ;; point.
4716 ;; 3. At any other greater element type, if point is
4717 ;; within contents, move into it.
4722 ;; Create an anchor for tables and plain lists:
4723 ;; when point is at the very beginning of these
4724 ;; elements, ignoring affiliated keywords,
4725 ;; target them instead of their contents.
4727 ;; When point is at contents end, do not move
4728 ;; into elements with an explicit ending, but
4729 ;; return that element instead.
4733 drawer dynamic-block inlinetask item
4734 plain-list property-drawer quote-block
4735 special-block))))
4750 ;;;###autoload
4752 "Return closest element or object around point.
4754 Return value is a list like (TYPE PROPS) where TYPE is the type
4755 of the element or object and PROPS a plist of properties
4756 associated to it.
4758 Possible types are defined in `org-element-all-elements' and
4759 `org-element-all-objects'. Properties depend on element or
4760 object type, but always include `:begin', `:end', `:parent' and
4761 `:post-blank'.
4763 Optional argument ELEMENT, when non-nil, is the closest element
4764 containing point, as returned by `org-element-at-point'.
4765 Providing it allows for quicker computation."
4770 end)
4771 ;; Check if point is inside an element containing objects or at
4772 ;; a secondary string. In that case, move to beginning of the
4773 ;; element or secondary string and set END to the other side.
4780 org-element-parsed-keywords))
4781 ;; We're at an affiliated keyword. Change
4782 ;; type to retrieve correct restrictions.
4784 ;; Determine if we're at main or dual value.
4798 (<= origin
4799 ;; `1+' is required so some
4800 ;; successors can match
4801 ;; properly their object.
4823 element
4829 end restriction candidates))
4831 candidates)))
4832 ;; If ORIGIN is before next object in element, there's
4833 ;; no point in looking further.
4843 ;; ORIGIN is after OBJECT, so skip it.
4849 ;; ORIGIN is within a non-recursive object or at
4850 ;; an object boundaries: Return that object.
4854 ;; Otherwise, move within current object and
4855 ;; restrict search to the end of its contents.
4860 candidates 'initial
4861 end cend)))))))
4862 parent))))))
4865 "Non-nil when elements ELEM-A and ELEM-B are nested."
4874 "Swap elements ELEM-A and ELEM-B.
4875 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4876 end of ELEM-A."
4878 ;; There are two special cases when an element doesn't start at bol:
4879 ;; the first paragraph in an item or in a footnote definition.
4881 ;; Only a paragraph without any affiliated keyword can be moved at
4882 ;; ELEM-A position in such a situation. Note that the case of
4883 ;; a footnote definition is impossible: it cannot contain two
4884 ;; paragraphs in a row because it cannot contain a blank line.
4890 ;; In a special situation, ELEM-A will have no indentation. We'll
4891 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4905 ;; Store overlays responsible for visibility status. We
4906 ;; also need to store their boundaries as they will be
4907 ;; removed from buffer.
4914 ;; Get contents.
4922 ;; Restore ex ELEM-A overlays.
4931 ;; Restore ex ELEM-B overlays.
4940 ;; Local variables:
4941 ;; generated-autoload-file: "org-loaddefs.el"
4942 ;; End:
4944 ;;; org-element.el ends here