| blob | 23ded7812324894a02ee8023b816944b475ba187 |
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."
1127 ;; Compute indentation.
1132 ;; Indent contents.
1134 bullet
1147 ;;;; Plain List
1150 "Parse a plain list.
1152 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1153 the buffer position at the beginning of the first affiliated
1154 keyword and CDR is a plist of affiliated keywords along with
1155 their value. STRUCTURE is the structure of the plain list being
1156 parsed.
1158 Return a list whose CAR is `plain-list' and CDR is a plist
1159 containing `:type', `:begin', `:end', `:contents-begin' and
1160 `:contents-end', `:structure', `:post-blank' and
1161 `:post-affiliated' keywords.
1163 Assume point is at the beginning of the list."
1178 ;; Return value.
1182 :begin begin
1183 :end end
1184 :contents-begin contents-begin
1185 :contents-end contents-end
1186 :structure struct
1192 "Interpret PLAIN-LIST element as Org syntax.
1193 CONTENTS is the contents of the element."
1201 ;;;; Property Drawer
1204 "Parse a property drawer.
1206 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1207 the buffer position at the beginning of the first affiliated
1208 keyword and CDR is a plist of affiliated keywords along with
1209 their value.
1211 Return a list whose CAR is `property-drawer' and CDR is a plist
1212 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1213 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1215 Assume point is at the beginning of the property drawer."
1220 ;; Incomplete drawer: parse it as a paragraph.
1240 :end end
1241 :hiddenp hidden
1242 :contents-begin contents-begin
1243 :contents-end contents-end
1249 "Interpret PROPERTY-DRAWER element as Org syntax.
1250 CONTENTS is the properties within the drawer."
1254 ;;;; Quote Block
1257 "Parse a quote block.
1259 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1260 the buffer position at the beginning of the first affiliated
1261 keyword and CDR is a plist of affiliated keywords along with
1262 their value.
1264 Return a list whose CAR is `quote-block' and CDR is a plist
1265 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1266 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1268 Assume point is at the beginning of the block."
1272 ;; Incomplete block: parse it as a paragraph.
1278 ;; Empty blocks have no contents.
1293 :end end
1294 :hiddenp hidden
1295 :contents-begin contents-begin
1296 :contents-end contents-end
1302 "Interpret QUOTE-BLOCK element as Org syntax.
1303 CONTENTS is the contents of the element."
1307 ;;;; Section
1310 "Parse a section.
1312 LIMIT bounds the search.
1314 Return a list whose CAR is `section' and CDR is a plist
1315 containing `:begin', `:end', `:contents-begin', `contents-end'
1316 and `:post-blank' keywords."
1318 ;; Beginning of section is the beginning of the first non-blank
1319 ;; line after previous headline.
1328 :end end
1329 :contents-begin begin
1330 :contents-end pos-before-blank
1334 "Interpret SECTION element as Org syntax.
1335 CONTENTS is the contents of the element."
1336 contents)
1339 ;;;; Special Block
1342 "Parse a special block.
1344 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1345 the buffer position at the beginning of the first affiliated
1346 keyword and CDR is a plist of affiliated keywords along with
1347 their value.
1349 Return a list whose CAR is `special-block' and CDR is a plist
1350 containing `:type', `:begin', `:end', `:hiddenp',
1351 `:contents-begin', `:contents-end', `:post-blank' and
1352 `:post-affiliated' keywords.
1354 Assume point is at the beginning of the block."
1361 limit t)))
1362 ;; Incomplete block: parse it as a paragraph.
1368 ;; Empty blocks have no contents.
1383 :begin begin
1384 :end end
1385 :hiddenp hidden
1386 :contents-begin contents-begin
1387 :contents-end contents-end
1393 "Interpret SPECIAL-BLOCK element as Org syntax.
1394 CONTENTS is the contents of the element."
1399 \f
1400 ;;; Elements
1401 ;;
1402 ;; For each element, a parser and an interpreter are also defined.
1403 ;; Both follow the same naming convention used for greater elements.
1404 ;;
1405 ;; Also, as for greater elements, adding a new element type is done
1406 ;; through the following steps: implement a parser and an interpreter,
1407 ;; tweak `org-element--current-element' so that it recognizes the new
1408 ;; type and add that new type to `org-element-all-elements'.
1409 ;;
1410 ;; As a special case, when the newly defined type is a block type,
1411 ;; `org-element-block-name-alist' has to be modified accordingly.
1414 ;;;; Babel Call
1417 "Parse a babel call.
1419 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1420 the buffer position at the beginning of the first affiliated
1421 keyword and CDR is a plist of affiliated keywords along with
1422 their value.
1424 Return a list whose CAR is `babel-call' and CDR is a plist
1425 containing `:begin', `:end', `:info', `:post-blank' and
1426 `:post-affiliated' as keywords."
1440 :end end
1441 :info info
1447 "Interpret BABEL-CALL element as Org syntax.
1448 CONTENTS is nil."
1454 ;; Remove redundant square brackets.
1459 ;;;; Clock
1462 "Parse a clock.
1464 LIMIT bounds the search.
1466 Return a list whose CAR is `clock' and CDR is a plist containing
1467 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1468 as keywords."
1488 :value value
1489 :duration duration
1490 :begin begin
1491 :end end
1495 "Interpret CLOCK element as Org syntax.
1496 CONTENTS is nil."
1504 "%2s:%02s"
1508 ;;;; Comment
1511 "Parse a comment.
1513 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1514 the buffer position at the beginning of the first affiliated
1515 keyword and CDR is a plist of affiliated keywords along with
1516 their value.
1518 Return a list whose CAR is `comment' and CDR is a plist
1519 containing `:begin', `:end', `:value', `:post-blank',
1520 `:post-affiliated' keywords.
1522 Assume point is at comment beginning."
1531 ;; Get comments ending.
1534 ;; Accumulate lines without leading hash and first
1535 ;; whitespace.
1550 :end end
1551 :value value
1557 "Interpret COMMENT element as Org syntax.
1558 CONTENTS is nil."
1562 ;;;; Comment Block
1565 "Parse an export block.
1567 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1568 the buffer position at the beginning of the first affiliated
1569 keyword and CDR is a plist of affiliated keywords along with
1570 their value.
1572 Return a list whose CAR is `comment-block' and CDR is a plist
1573 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1574 and `:post-affiliated' keywords.
1576 Assume point is at comment block beginning."
1580 ;; Incomplete block: parse it as a paragraph.
1595 contents-begin contents-end)))
1599 :end end
1600 :value value
1601 :hiddenp hidden
1607 "Interpret COMMENT-BLOCK element as Org syntax.
1608 CONTENTS is nil."
1613 ;;;; Diary Sexp
1616 "Parse a diary sexp.
1618 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1619 the buffer position at the beginning of the first affiliated
1620 keyword and CDR is a plist of affiliated keywords along with
1621 their value.
1623 Return a list whose CAR is `diary-sexp' and CDR is a plist
1624 containing `:begin', `:end', `:value', `:post-blank' and
1625 `:post-affiliated' keywords."
1638 :begin begin
1639 :end end
1645 "Interpret DIARY-SEXP as Org syntax.
1646 CONTENTS is nil."
1650 ;;;; Example Block
1653 "Remove maximum common indentation in string S and return it.
1654 When optional argument N is a positive integer, remove exactly
1655 that much characters from indentation, if possible, or return
1656 S as-is otherwise. Unlike to `org-remove-indentation', this
1657 function doesn't call `untabify' on S."
1662 ;; Find maximum common indentation, if not specified.
1670 min-ind)))
1672 ;; Remove exactly N indentation, but give up if not possible.
1682 "Parse an example block.
1684 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1685 the buffer position at the beginning of the first affiliated
1686 keyword and CDR is a plist of affiliated keywords along with
1687 their value.
1689 Return a list whose CAR is `example-block' and CDR is a plist
1690 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1691 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1692 `:switches', `:value', `:post-blank' and `:post-affiliated'
1693 keywords."
1697 ;; Incomplete block: parse it as a paragraph.
1705 ;; Switches analysis
1713 ;; Should labels be retained in (or stripped from) example
1714 ;; blocks?
1719 ;; What should code-references use - labels or
1720 ;; line-numbers?
1729 ;; Standard block parsing.
1738 contents-begin contents-end))
1749 :end end
1750 :value value
1751 :switches switches
1752 :number-lines number-lines
1753 :preserve-indent preserve-indent
1754 :retain-labels retain-labels
1755 :use-labels use-labels
1756 :label-fmt label-fmt
1757 :hiddenp hidden
1763 "Interpret EXAMPLE-BLOCK element as Org syntax.
1764 CONTENTS is nil."
1772 ;;;; Export Block
1775 "Parse an export block.
1777 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1778 the buffer position at the beginning of the first affiliated
1779 keyword and CDR is a plist of affiliated keywords along with
1780 their value.
1782 Return a list whose CAR is `export-block' and CDR is a plist
1783 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1784 `:post-blank' and `:post-affiliated' keywords.
1786 Assume point is at export-block beginning."
1793 ;; Incomplete block: parse it as a paragraph.
1808 contents-end)))
1812 :end end
1813 :type type
1814 :value value
1815 :hiddenp hidden
1821 "Interpret EXPORT-BLOCK element as Org syntax.
1822 CONTENTS is nil."
1829 ;;;; Fixed-width
1832 "Parse a fixed-width section.
1834 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1835 the buffer position at the beginning of the first affiliated
1836 keyword and CDR is a plist of affiliated keywords along with
1837 their value.
1839 Return a list whose CAR is `fixed-width' and CDR is a plist
1840 containing `:begin', `:end', `:value', `:post-blank' and
1841 `:post-affiliated' keywords.
1843 Assume point is at the beginning of the fixed-width area."
1847 value
1852 ;; Accumulate text without starting colons.
1866 :end end
1867 :value value
1873 "Interpret FIXED-WIDTH element as Org syntax.
1874 CONTENTS is nil."
1882 ;;;; Horizontal Rule
1885 "Parse an horizontal rule.
1887 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1888 the buffer position at the beginning of the first affiliated
1889 keyword and CDR is a plist of affiliated keywords along with
1890 their value.
1892 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1893 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1894 keywords."
1905 :end end
1911 "Interpret HORIZONTAL-RULE element as Org syntax.
1912 CONTENTS is nil."
1916 ;;;; Keyword
1919 "Parse a keyword at point.
1921 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1922 the buffer position at the beginning of the first affiliated
1923 keyword and CDR is a plist of affiliated keywords along with
1924 their value.
1926 Return a list whose CAR is `keyword' and CDR is a plist
1927 containing `:key', `:value', `:begin', `:end', `:post-blank' and
1928 `:post-affiliated' keywords."
1943 :value value
1944 :begin begin
1945 :end end
1951 "Interpret KEYWORD element as Org syntax.
1952 CONTENTS is nil."
1958 ;;;; Latex Environment
1961 "Parse a LaTeX environment.
1963 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1964 the buffer position at the beginning of the first affiliated
1965 keyword and CDR is a plist of affiliated keywords along with
1966 their value.
1968 Return a list whose CAR is `latex-environment' and CDR is a plist
1969 containing `:begin', `:end', `:value', `:post-blank' and
1970 `:post-affiliated' keywords.
1972 Assume point is at the beginning of the latex environment."
1979 limit t))
1980 ;; Incomplete latex environment: parse it as a paragraph.
1991 :end end
1992 :value value
1998 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1999 CONTENTS is nil."
2003 ;;;; Node Property
2006 "Parse a node-property at point.
2008 LIMIT bounds the search.
2010 Return a list whose CAR is `node-property' and CDR is a plist
2011 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2012 keywords."
2024 :value value
2025 :begin begin
2026 :end end
2030 "Interpret NODE-PROPERTY element as Org syntax.
2031 CONTENTS is nil."
2037 ;;;; Paragraph
2040 "Parse a paragraph.
2042 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2043 the buffer position at the beginning of the first affiliated
2044 keyword and CDR is a plist of affiliated keywords along with
2045 their value.
2047 Return a list whose CAR is `paragraph' and CDR is a plist
2048 containing `:begin', `:end', `:contents-begin' and
2049 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2051 Assume point is at the beginning of the paragraph."
2060 limit
2061 ;; A matching `org-element-paragraph-separate' is not
2062 ;; necessarily the end of the paragraph. In
2063 ;; particular, lines starting with # or : as a first
2064 ;; non-space character are ambiguous. We have check
2065 ;; if they are valid Org syntax (i.e. not an
2066 ;; incomplete keyword).
2070 ;; There's no ambiguity for other symbols or
2071 ;; empty lines: stop here.
2073 ;; Stop at valid fixed-width areas.
2075 ;; Stop at drawers.
2080 ;; Stop at valid comments.
2082 ;; Stop at valid dynamic blocks.
2087 ;; Stop at valid blocks.
2094 limit t)))
2095 ;; Stop at valid latex environments.
2102 limit t)))
2103 ;; Stop at valid keywords.
2105 ;; Skip everything else.
2123 :end end
2124 :contents-begin contents-begin
2125 :contents-end contents-end
2131 "Interpret PARAGRAPH element as Org syntax.
2132 CONTENTS is the contents of the element."
2133 contents)
2136 ;;;; Planning
2139 "Parse a planning.
2141 LIMIT bounds the search.
2143 Return a list whose CAR is `planning' and CDR is a plist
2144 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2145 and `:post-blank' keywords."
2155 closed deadline scheduled)
2167 :deadline deadline
2168 :scheduled scheduled
2169 :begin begin
2170 :end end
2174 "Interpret PLANNING element as Org syntax.
2175 CONTENTS is nil."
2177 'identity
2194 ;;;; Quote Section
2197 "Parse a quote section.
2199 LIMIT bounds the search.
2201 Return a list whose CAR is `quote-section' and CDR is a plist
2202 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2204 Assume point is at beginning of the section."
2215 :end end
2216 :value value
2220 "Interpret QUOTE-SECTION element as Org syntax.
2221 CONTENTS is nil."
2225 ;;;; Src Block
2228 "Parse a src block.
2230 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2231 the buffer position at the beginning of the first affiliated
2232 keyword and CDR is a plist of affiliated keywords along with
2233 their value.
2235 Return a list whose CAR is `src-block' and CDR is a plist
2236 containing `:language', `:switches', `:parameters', `:begin',
2237 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2238 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2239 `:post-blank' and `:post-affiliated' keywords.
2241 Assume point is at the beginning of the block."
2244 limit t)))
2245 ;; Incomplete block: parse it as a paragraph.
2251 ;; Get language as a string.
2260 ;; Get switches.
2262 ;; Get parameters.
2264 ;; Switches analysis
2276 ;; Should labels be retained in (or stripped from)
2277 ;; src blocks?
2282 ;; What should code-references use - labels or
2283 ;; line-numbers?
2288 ;; Indentation.
2290 ;; Get visibility status.
2292 ;; Retrieve code.
2301 ;; Get position after ending blank lines.
2312 :begin begin
2313 :end end
2314 :number-lines number-lines
2315 :preserve-indent preserve-indent
2316 :retain-labels retain-labels
2317 :use-labels use-labels
2318 :label-fmt label-fmt
2319 :hiddenp hidden
2320 :value value
2326 "Interpret SRC-BLOCK element as Org syntax.
2327 CONTENTS is nil."
2348 ;;;; Table
2351 "Parse a table at point.
2353 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2354 the buffer position at the beginning of the first affiliated
2355 keyword and CDR is a plist of affiliated keywords along with
2356 their value.
2358 Return a list whose CAR is `table' and CDR is a plist containing
2359 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2360 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2361 keywords.
2363 Assume point is at the beginning of the table."
2377 acc))
2385 :end end
2386 :type type
2387 :tblfm tblfm
2388 ;; Only `org' tables have contents. `table.el' tables
2389 ;; use a `:value' property to store raw table as
2390 ;; a string.
2395 table-begin table-end))
2401 "Interpret TABLE element as Org syntax.
2402 CONTENTS is nil."
2413 ;;;; Table Row
2416 "Parse table row at point.
2418 LIMIT bounds the search.
2420 Return a list whose CAR is `table-row' and CDR is a plist
2421 containing `:begin', `:end', `:contents-begin', `:contents-end',
2422 `:type' and `:post-blank' keywords."
2426 ;; A table rule has no contents. In that case, ensure
2427 ;; CONTENTS-BEGIN matches CONTENTS-END.
2439 :begin begin
2440 :end end
2441 :contents-begin contents-begin
2442 :contents-end contents-end
2446 "Interpret TABLE-ROW element as Org syntax.
2447 CONTENTS is the contents of the table row."
2452 ;;;; Verse Block
2455 "Parse a verse block.
2457 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2458 the buffer position at the beginning of the first affiliated
2459 keyword and CDR is a plist of affiliated keywords along with
2460 their value.
2462 Return a list whose CAR is `verse-block' and CDR is a plist
2463 containing `:begin', `:end', `:contents-begin', `:contents-end',
2464 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2466 Assume point is at beginning of the block."
2470 ;; Incomplete block: parse it as a paragraph.
2487 :end end
2488 :contents-begin contents-begin
2489 :contents-end contents-end
2490 :hiddenp hidden
2496 "Interpret VERSE-BLOCK element as Org syntax.
2497 CONTENTS is verse block contents."
2501 \f
2502 ;;; Objects
2503 ;;
2504 ;; Unlike to elements, interstices can be found between objects.
2505 ;; That's why, along with the parser, successor functions are provided
2506 ;; for each object. Some objects share the same successor (i.e. `code'
2507 ;; and `verbatim' objects).
2508 ;;
2509 ;; A successor must accept a single argument bounding the search. It
2510 ;; will return either a cons cell whose CAR is the object's type, as
2511 ;; a symbol, and CDR the position of its next occurrence, or nil.
2512 ;;
2513 ;; Successors follow the naming convention:
2514 ;; org-element-NAME-successor, where NAME is the name of the
2515 ;; successor, as defined in `org-element-all-successors'.
2516 ;;
2517 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2518 ;; object types they can contain will be specified in
2519 ;; `org-element-object-restrictions'.
2520 ;;
2521 ;; Adding a new type of object is simple. Implement a successor,
2522 ;; a parser, and an interpreter for it, all following the naming
2523 ;; convention. Register type in `org-element-all-objects' and
2524 ;; successor in `org-element-all-successors'. Maybe tweak
2525 ;; restrictions about it, and that's it.
2528 ;;;; Bold
2531 "Parse bold object at point.
2533 Return a list whose CAR is `bold' and CDR is a plist with
2534 `:begin', `:end', `:contents-begin' and `:contents-end' and
2535 `:post-blank' keywords.
2537 Assume point is at the first star marker."
2549 :end end
2550 :contents-begin contents-begin
2551 :contents-end contents-end
2555 "Interpret BOLD object as Org syntax.
2556 CONTENTS is the contents of the object."
2560 "Search for the next text-markup object.
2562 LIMIT bounds the search.
2564 Return value is a cons cell whose CAR is a symbol among `bold',
2565 `italic', `underline', `strike-through', `code' and `verbatim'
2566 and CDR is beginning position."
2582 ;;;; Code
2585 "Parse code object at point.
2587 Return a list whose CAR is `code' and CDR is a plist with
2588 `:value', `:begin', `:end' and `:post-blank' keywords.
2590 Assume point is at the first tilde marker."
2601 :begin begin
2602 :end end
2606 "Interpret CODE object as Org syntax.
2607 CONTENTS is nil."
2611 ;;;; Entity
2614 "Parse entity at point.
2616 Return a list whose CAR is `entity' and CDR a plist with
2617 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2618 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2619 keywords.
2621 Assume point is at the beginning of the entity."
2623 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2639 :begin begin
2640 :end end
2641 :use-brackets-p bracketsp
2645 "Interpret ENTITY object as Org syntax.
2646 CONTENTS is nil."
2652 "Search for the next latex-fragment or entity object.
2654 LIMIT bounds the search.
2656 Return value is a cons cell whose CAR is `entity' or
2657 `latex-fragment' and CDR is beginning position."
2662 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2669 limit t)
2672 ;; Determine if it's a real entity or a LaTeX command.
2675 ;; No entity nor command: point is at a LaTeX fragment.
2676 ;; Determine its type to get the correct beginning position.
2684 matchers)
2688 ;;;; Export Snippet
2691 "Parse export snippet at point.
2693 Return a list whose CAR is `export-snippet' and CDR a plist with
2694 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2695 keywords.
2697 Assume point is at the beginning of the snippet."
2709 :value value
2710 :begin begin
2711 :end end
2715 "Interpret EXPORT-SNIPPET object as Org syntax.
2716 CONTENTS is nil."
2722 "Search for the next export-snippet object.
2724 LIMIT bounds the search.
2726 Return value is a cons cell whose CAR is `export-snippet' and CDR
2727 its beginning position."
2736 ;;;; Footnote Reference
2739 "Parse footnote reference at point.
2741 Return a list whose CAR is `footnote-reference' and CDR a plist
2742 with `:label', `:type', `:inline-definition', `:begin', `:end'
2743 and `:post-blank' as keywords."
2765 :type type
2766 :begin begin
2767 :end end
2770 footnote-reference :inline-definition
2775 footnote-reference))))))
2778 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2779 CONTENTS is nil."
2789 "Search for the next footnote-reference object.
2791 LIMIT bounds the search.
2793 Return value is a cons cell whose CAR is `footnote-reference' and
2794 CDR is beginning position."
2808 ;;;; Inline Babel Call
2811 "Parse inline babel call at point.
2813 Return a list whose CAR is `inline-babel-call' and CDR a plist
2814 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2816 Assume point is at the beginning of the babel call."
2827 :end end
2828 :info info
2832 "Interpret INLINE-BABEL-CALL object as Org syntax.
2833 CONTENTS is nil."
2839 ;; Remove redundant square brackets.
2842 main-source)
2846 "Search for the next inline-babel-call object.
2848 LIMIT bounds the search.
2850 Return value is a cons cell whose CAR is `inline-babel-call' and
2851 CDR is beginning position."
2853 ;; Use a simplified version of
2854 ;; `org-babel-inline-lob-one-liner-regexp'.
2857 limit t)
2861 ;;;; Inline Src Block
2864 "Parse inline source block at point.
2866 LIMIT bounds the search.
2868 Return a list whose CAR is `inline-src-block' and CDR a plist
2869 with `:begin', `:end', `:language', `:value', `:parameters' and
2870 `:post-blank' as keywords.
2872 Assume point is at the beginning of the inline src block."
2885 :value value
2886 :parameters parameters
2887 :begin begin
2888 :end end
2892 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2893 CONTENTS is nil."
2898 language
2900 body)))
2903 "Search for the next inline-babel-call element.
2905 LIMIT bounds the search.
2907 Return value is a cons cell whose CAR is `inline-babel-call' and
2908 CDR is beginning position."
2914 ;;;; Italic
2917 "Parse italic object at point.
2919 Return a list whose CAR is `italic' and CDR is a plist with
2920 `:begin', `:end', `:contents-begin' and `:contents-end' and
2921 `:post-blank' keywords.
2923 Assume point is at the first slash marker."
2935 :end end
2936 :contents-begin contents-begin
2937 :contents-end contents-end
2941 "Interpret ITALIC object as Org syntax.
2942 CONTENTS is the contents of the object."
2946 ;;;; Latex Fragment
2949 "Parse latex fragment at point.
2951 Return a list whose CAR is `latex-fragment' and CDR a plist with
2952 `:value', `:begin', `:end', and `:post-blank' as keywords.
2954 Assume point is at the beginning of the latex fragment."
2968 ;; None found: it's a macro.
2977 :begin begin
2978 :end end
2982 "Interpret LATEX-FRAGMENT object as Org syntax.
2983 CONTENTS is nil."
2986 ;;;; Line Break
2989 "Parse line break at point.
2991 Return a list whose CAR is `line-break', and CDR a plist with
2992 `:begin', `:end' and `:post-blank' keywords.
2994 Assume point is at the beginning of the line break."
3001 "Interpret LINE-BREAK object as Org syntax.
3002 CONTENTS is nil."
3006 "Search for the next line-break object.
3008 LIMIT bounds the search.
3010 Return value is a cons cell whose CAR is `line-break' and CDR is
3011 beginning position."
3015 ;; A line break can only happen on a non-empty line.
3020 ;;;; Link
3023 "Parse link at point.
3025 Return a list whose CAR is `link' and CDR a plist with `:type',
3026 `:path', `:raw-link', `:application', `:search-option', `:begin',
3027 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3028 keywords.
3030 Assume point is at the beginning of the link."
3033 end contents-begin contents-end link-end post-blank path type
3034 raw-link link search-option application)
3036 ;; Type 1: Text targeted from a radio target.
3041 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3046 ;; RAW-LINK is the original link. Expand any
3047 ;; abbreviation in it.
3052 ;; Determine TYPE of link and set PATH accordingly.
3054 ;; File type.
3057 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3060 ;; Id type: PATH is the id.
3063 ;; Code-ref type: PATH is the name of the reference.
3066 ;; Custom-id type: PATH is the name of the custom id.
3069 ;; Fuzzy type: Internal link either matches a target, an
3070 ;; headline name or nothing. PATH is the target or
3071 ;; headline's name.
3073 ;; Type 3: Plain link, i.e. http://orgmode.org
3079 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3086 ;; In any case, deduce end point after trailing white space from
3087 ;; LINK-END variable.
3090 ;; Extract search option and opening application out of
3091 ;; "file"-type links.
3093 ;; Application.
3098 ;; Extract search option from PATH.
3102 ;; Make sure TYPE always report "file".
3106 :path path
3108 :application application
3109 :search-option search-option
3110 :begin begin
3111 :end end
3112 :contents-begin contents-begin
3113 :contents-end contents-end
3117 "Interpret LINK object as Org syntax.
3118 CONTENTS is the contents of the object, or nil."
3123 raw-link
3127 "Search for the next link object.
3129 LIMIT bounds the search.
3131 Return value is a cons cell whose CAR is `link' and CDR is
3132 beginning position."
3141 "Search for the next plain link object.
3143 LIMIT bounds the search.
3145 Return value is a cons cell whose CAR is `link' and CDR is
3146 beginning position."
3151 ;;;; Macro
3154 "Parse macro at point.
3156 Return a list whose CAR is `macro' and CDR a plist with `:key',
3157 `:args', `:begin', `:end', `:value' and `:post-blank' as
3158 keywords.
3160 Assume point is at the macro."
3171 ;; Do not use `org-split-string' since empty
3172 ;; strings are meaningful here.
3180 args nil t)
3184 :value value
3185 :args args
3186 :begin begin
3187 :end end
3191 "Interpret MACRO object as Org syntax.
3192 CONTENTS is nil."
3196 "Search for the next macro object.
3198 LIMIT bounds the search.
3200 Return value is cons cell whose CAR is `macro' and CDR is
3201 beginning position."
3205 limit t)
3209 ;;;; Radio-target
3212 "Parse radio target at point.
3214 Return a list whose CAR is `radio-target' and CDR a plist with
3215 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3216 and `:post-blank' as keywords.
3218 Assume point is at the radio target."
3230 :end end
3231 :contents-begin contents-begin
3232 :contents-end contents-end
3233 :post-blank post-blank
3237 "Interpret TARGET object as Org syntax.
3238 CONTENTS is the contents of the object."
3242 "Search for the next radio-target object.
3244 LIMIT bounds the search.
3246 Return value is a cons cell whose CAR is `radio-target' and CDR
3247 is beginning position."
3253 ;;;; Statistics Cookie
3256 "Parse statistics cookie at point.
3258 Return a list whose CAR is `statistics-cookie', and CDR a plist
3259 with `:begin', `:end', `:value' and `:post-blank' keywords.
3261 Assume point is at the beginning of the statistics-cookie."
3272 :end end
3273 :value value
3277 "Interpret STATISTICS-COOKIE object as Org syntax.
3278 CONTENTS is nil."
3282 "Search for the next statistics cookie object.
3284 LIMIT bounds the search.
3286 Return value is a cons cell whose CAR is `statistics-cookie' and
3287 CDR is beginning position."
3293 ;;;; Strike-Through
3296 "Parse strike-through object at point.
3298 Return a list whose CAR is `strike-through' and CDR is a plist
3299 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3300 `:post-blank' keywords.
3302 Assume point is at the first plus sign marker."
3314 :end end
3315 :contents-begin contents-begin
3316 :contents-end contents-end
3320 "Interpret STRIKE-THROUGH object as Org syntax.
3321 CONTENTS is the contents of the object."
3325 ;;;; Subscript
3328 "Parse subscript at point.
3330 Return a list whose CAR is `subscript' and CDR a plist with
3331 `:begin', `:end', `:contents-begin', `:contents-end',
3332 `:use-brackets-p' and `:post-blank' as keywords.
3334 Assume point is at the underscore."
3338 t
3349 :end end
3350 :use-brackets-p bracketsp
3351 :contents-begin contents-begin
3352 :contents-end contents-end
3356 "Interpret SUBSCRIPT object as Org syntax.
3357 CONTENTS is the contents of the object."
3360 contents))
3363 "Search for the next sub/superscript object.
3365 LIMIT bounds the search.
3367 Return value is a cons cell whose CAR is either `subscript' or
3368 `superscript' and CDR is beginning position."
3376 ;;;; Superscript
3379 "Parse superscript at point.
3381 Return a list whose CAR is `superscript' and CDR a plist with
3382 `:begin', `:end', `:contents-begin', `:contents-end',
3383 `:use-brackets-p' and `:post-blank' as keywords.
3385 Assume point is at the caret."
3399 :end end
3400 :use-brackets-p bracketsp
3401 :contents-begin contents-begin
3402 :contents-end contents-end
3406 "Interpret SUPERSCRIPT object as Org syntax.
3407 CONTENTS is the contents of the object."
3410 contents))
3413 ;;;; Table Cell
3416 "Parse table cell at point.
3418 Return a list whose CAR is `table-cell' and CDR is a plist
3419 containing `:begin', `:end', `:contents-begin', `:contents-end'
3420 and `:post-blank' keywords."
3428 :end end
3429 :contents-begin contents-begin
3430 :contents-end contents-end
3434 "Interpret TABLE-CELL element as Org syntax.
3435 CONTENTS is the contents of the cell, or nil."
3439 "Search for the next table-cell object.
3441 LIMIT bounds the search.
3443 Return value is a cons cell whose CAR is `table-cell' and CDR is
3444 beginning position."
3448 ;;;; Target
3451 "Parse target at point.
3453 Return a list whose CAR is `target' and CDR a plist with
3454 `:begin', `:end', `:value' and `:post-blank' as keywords.
3456 Assume point is at the target."
3466 :end end
3467 :value value
3471 "Interpret TARGET object as Org syntax.
3472 CONTENTS is nil."
3476 "Search for the next target object.
3478 LIMIT bounds the search.
3480 Return value is a cons cell whose CAR is `target' and CDR is
3481 beginning position."
3487 ;;;; Timestamp
3490 "Parse time stamp at point.
3492 Return a list whose CAR is `timestamp', and CDR a plist with
3493 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3495 Assume point is at the beginning of the timestamp."
3513 date-start)
3524 raw-value)
3526 :repeater-type
3532 :repeater-unit
3535 year-start month-start day-start hour-start minute-start year-end
3536 month-end day-end hour-end minute-end)
3537 ;; Parse date-start.
3545 ;; Compute date-end. It can be provided directly in time-stamp,
3546 ;; or extracted from time range. Otherwise, it defaults to the
3547 ;; same values as date-start.
3557 :raw-value raw-value
3558 :year-start year-start
3559 :month-start month-start
3560 :day-start day-start
3561 :hour-start hour-start
3562 :minute-start minute-start
3563 :year-end year-end
3564 :month-end month-end
3565 :day-end day-end
3566 :hour-end hour-end
3567 :minute-end minute-end
3568 :begin begin
3569 :end end
3571 repeater-props)))))
3574 "Interpret TIMESTAMP object as Org syntax.
3575 CONTENTS is nil."
3576 ;; Use `:raw-value' if specified.
3578 ;; Otherwise, build timestamp string.
3588 ;; Build an Org timestamp string from TIME. ACTIVEP is
3589 ;; non-nil when time stamp is active. If WITH-TIME-P is
3590 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3591 ;; specify a time range in the timestamp. REPEAT-STRING
3592 ;; is the repeater string, if any.
3596 org-time-stamp-formats)
3597 time)))
3603 nil nil ts)))
3607 " "
3608 repeat-string
3610 ;; Return value.
3611 ts)))
3623 build-ts-string
3642 0
3650 "--"
3662 "Search for the next timestamp object.
3664 LIMIT bounds the search.
3666 Return value is a cons cell whose CAR is `timestamp' and CDR is
3667 beginning position."
3675 limit t)
3679 ;;;; Underline
3682 "Parse underline object at point.
3684 Return a list whose CAR is `underline' and CDR is a plist with
3685 `:begin', `:end', `:contents-begin' and `:contents-end' and
3686 `:post-blank' keywords.
3688 Assume point is at the first underscore marker."
3700 :end end
3701 :contents-begin contents-begin
3702 :contents-end contents-end
3706 "Interpret UNDERLINE object as Org syntax.
3707 CONTENTS is the contents of the object."
3711 ;;;; Verbatim
3714 "Parse verbatim object at point.
3716 Return a list whose CAR is `verbatim' and CDR is a plist with
3717 `:value', `:begin', `:end' and `:post-blank' keywords.
3719 Assume point is at the first equal sign marker."
3730 :begin begin
3731 :end end
3735 "Interpret VERBATIM object as Org syntax.
3736 CONTENTS is nil."
3740 \f
3741 ;;; Parsing Element Starting At Point
3742 ;;
3743 ;; `org-element--current-element' is the core function of this section.
3744 ;; It returns the Lisp representation of the element starting at
3745 ;; point.
3746 ;;
3747 ;; `org-element--current-element' makes use of special modes. They
3748 ;; are activated for fixed element chaining (i.e. `plain-list' >
3749 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3750 ;; `section'). Special modes are: `first-section', `item',
3751 ;; `node-property', `quote-section', `section' and `table-row'.
3755 "Parse the element starting at point.
3757 LIMIT bounds the search.
3759 Return value is a list like (TYPE PROPS) where TYPE is the type
3760 of the element and PROPS a plist of properties associated to the
3761 element.
3763 Possible types are defined in `org-element-all-elements'.
3765 Optional argument GRANULARITY determines the depth of the
3766 recursion. Allowed values are `headline', `greater-element',
3767 `element', `object' or nil. When it is broader than `object' (or
3768 nil), secondary values will not be parsed, since they only
3769 contain objects.
3771 Optional argument SPECIAL, when non-nil, can be either
3772 `first-section', `item', `node-property', `quote-section',
3773 `section', and `table-row'.
3775 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3776 be computed.
3778 This function assumes point is always at the beginning of the
3779 element it has to parse."
3782 ;; Determine if parsing depth allows for secondary strings
3783 ;; parsing. It only applies to elements referenced in
3784 ;; `org-element-secondary-value-alist'.
3787 ;; Item.
3790 ;; Table Row.
3792 ;; Node Property.
3794 ;; Headline.
3797 ;; Sections (must be checked after headline).
3803 limit)))
3804 ;; When not at bol, point is at the beginning of an item or
3805 ;; a footnote definition: next item is always a paragraph.
3807 ;; Planning and Clock.
3812 ;; Inlinetask.
3815 ;; From there, elements can have affiliated keywords.
3818 ;; Jumping over affiliated keywords put point off-limits.
3819 ;; Parse them as regular keywords.
3823 ;; LaTeX Environment.
3827 ;; Drawer and Property Drawer.
3832 ;; Fixed Width
3835 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3836 ;; Keywords.
3845 org-element-block-name-alist)))
3860 ;; Footnote Definition.
3863 ;; Horizontal Rule.
3866 ;; Diary Sexp.
3869 ;; Table.
3871 ;; List.
3875 ;; Default element: Paragraph.
3879 ;; Most elements can have affiliated keywords. When looking for an
3880 ;; element beginning, we want to move before them, as they belong to
3881 ;; that element, and, in the meantime, collect information they give
3882 ;; into appropriate properties. Hence the following function.
3885 "Collect affiliated keywords from point down to LIMIT.
3887 Return a list whose CAR is the position at the first of them and
3888 CDR a plist of keywords and values and move point to the
3889 beginning of the first line after them.
3891 As a special case, if element doesn't start at the beginning of
3892 the line (i.e. a paragraph starting an item), CAR is current
3893 position of point and CDR is nil."
3897 ;; RESTRICT is the list of objects allowed in parsed
3898 ;; keywords value.
3900 output)
3903 ;; Apply translation to RAW-KWD. From there, KWD is
3904 ;; the official keyword.
3906 org-element-keyword-translation-alist))
3907 raw-kwd))
3908 ;; Find main value for any keyword.
3914 ;; PARSEDP is non-nil when keyword should have its
3915 ;; value parsed.
3917 ;; If KWD is a dual keyword, find its secondary
3918 ;; value. Maybe parse it.
3925 ;; Attribute a property name to KWD.
3927 ;; Now set final shape for VALUE.
3933 ;; Attributes can always appear on multiple lines.
3936 ;; Eventually store the new value in OUTPUT.
3938 ;; Move to next keyword.
3940 ;; If affiliated keywords are orphaned: move back to first one.
3941 ;; They will be parsed as a paragraph.
3943 ;; Return value.
3947 \f
3948 ;;; The Org Parser
3949 ;;
3950 ;; The two major functions here are `org-element-parse-buffer', which
3951 ;; parses Org syntax inside the current buffer, taking into account
3952 ;; region, narrowing, or even visibility if specified, and
3953 ;; `org-element-parse-secondary-string', which parses objects within
3954 ;; a given string.
3955 ;;
3956 ;; The (almost) almighty `org-element-map' allows to apply a function
3957 ;; on elements or objects matching some type, and accumulate the
3958 ;; resulting values. In an export situation, it also skips unneeded
3959 ;; parts of the parse tree.
3962 "Recursively parse the buffer and return structure.
3963 If narrowing is in effect, only parse the visible part of the
3964 buffer.
3966 Optional argument GRANULARITY determines the depth of the
3967 recursion. It can be set to the following symbols:
3969 `headline' Only parse headlines.
3970 `greater-element' Don't recurse into greater elements excepted
3971 headlines and sections. Thus, elements
3972 parsed are the top-level ones.
3973 `element' Parse everything but objects and plain text.
3974 `object' Parse the complete buffer (default).
3976 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3977 elements.
3979 An element or an objects is represented as a list with the
3980 pattern (TYPE PROPERTIES CONTENTS), where :
3982 TYPE is a symbol describing the element or object. See
3983 `org-element-all-elements' and `org-element-all-objects' for an
3984 exhaustive list of such symbols. One can retrieve it with
3985 `org-element-type' function.
3987 PROPERTIES is the list of attributes attached to the element or
3988 object, as a plist. Although most of them are specific to the
3989 element or object type, all types share `:begin', `:end',
3990 `:post-blank' and `:parent' properties, which respectively
3991 refer to buffer position where the element or object starts,
3992 ends, the number of white spaces or blank lines after it, and
3993 the element or object containing it. Properties values can be
3994 obtained by using `org-element-property' function.
3996 CONTENTS is a list of elements, objects or raw strings
3997 contained in the current element or object, when applicable.
3998 One can access them with `org-element-contents' function.
4000 The Org buffer has `org-data' as type and nil as properties.
4001 `org-element-map' function can be used to find specific elements
4002 or objects within the parse tree.
4004 This function assumes that current major mode is `org-mode'."
4010 ;; Start in `first-section' mode so text before the first
4011 ;; headline belongs to a section.
4015 "Recursively parse objects in STRING and return structure.
4017 RESTRICTION is a symbol limiting the object types that will be
4018 looked after.
4020 Optional argument PARENT, when non-nil, is the element or object
4021 containing the secondary string. It is used to set correctly
4022 `:parent' property within the string."
4023 ;; Copy buffer-local variables listed in
4024 ;; `org-element-object-variables' into temporary buffer. This is
4025 ;; required since object parsing is dependent on these variables.
4029 org-element-object-variables))))
4037 secondary))
4038 secondary))))
4042 "Map a function on selected elements or objects.
4044 DATA is a parse tree, an element, an object, a string, or a list
4045 of such constructs. TYPES is a symbol or list of symbols of
4046 elements or objects types (see `org-element-all-elements' and
4047 `org-element-all-objects' for a complete list of types). FUN is
4048 the function called on the matching element or object. It has to
4049 accept one argument: the element or object itself.
4051 When optional argument INFO is non-nil, it should be a plist
4052 holding export options. In that case, parts of the parse tree
4053 not exportable according to that property list will be skipped.
4055 When optional argument FIRST-MATCH is non-nil, stop at the first
4056 match for which FUN doesn't return nil, and return that value.
4058 Optional argument NO-RECURSION is a symbol or a list of symbols
4059 representing elements or objects types. `org-element-map' won't
4060 enter any recursive element or object whose type belongs to that
4061 list. Though, FUN can still be applied on them.
4063 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4064 apply to matching objects within parsed affiliated keywords (see
4065 `org-element-parsed-keywords').
4067 Nil values returned from FUN do not appear in the results.
4070 Examples:
4071 ---------
4073 Assuming TREE is a variable containing an Org buffer parse tree,
4074 the following example will return a flat list of all `src-block'
4075 and `example-block' elements in it:
4077 \(org-element-map tree '(example-block src-block) 'identity)
4079 The following snippet will find the first headline with a level
4082 \(org-element-map tree 'headline
4083 \(lambda (hl)
4084 \(and (= (org-element-property :level hl) 1)
4086 \(org-element-property :begin hl)))
4087 nil t)
4089 The next example will return a flat list of all `plain-list' type
4090 elements in TREE that are not a sub-list themselves:
4092 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4094 Eventually, this example will return a flat list of all `bold'
4095 type objects containing a `latex-snippet' type object, even
4096 looking into captions:
4098 \(org-element-map tree 'bold
4099 \(lambda (b)
4100 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4101 nil nil nil t)"
4102 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4105 ;; Recursion depth is determined by --CATEGORY.
4112 ;; If one object is found, the function
4113 ;; has to recurse into every object.
4116 ;; If one regular element is found, the
4117 ;; function has to recurse, at least,
4118 ;; into every element it encounters.
4121 types)
4122 category)))
4123 ;; Compute properties for affiliated keywords if necessary.
4128 org-element-affiliated-keywords)))
4129 --acc
4130 --walk-tree
4134 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4135 ;; holding contextual information.
4139 ;; Ignored element in an export context.
4141 ;; List of elements or objects.
4143 ;; Unconditionally enter parse trees.
4147 ;; Check if TYPE is matching among TYPES. If so,
4148 ;; apply FUN to --DATA and accumulate return value
4149 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4155 ;; If --DATA has a secondary string that can contain
4156 ;; objects with their type among TYPES, look into it.
4163 ;; If --DATA has any affiliated keywords and
4164 ;; WITH-AFFILIATED is non-nil, look for objects in
4165 ;; them.
4173 ;; Pay attention to the type of value.
4174 ;; Preserve order for multiple keywords.
4190 --affiliated-alist))
4191 ;; Determine if a recursion into --DATA is possible.
4193 ;; --TYPE is explicitly removed from recursion.
4195 ;; --DATA has no contents.
4197 ;; Looking for greater elements but --DATA is simply
4198 ;; an element or an object.
4201 ;; Looking for elements but --DATA is an object.
4204 ;; In any other case, map contents.
4208 ;; Return value in a proper order.
4212 ;; The following functions are internal parts of the parser.
4213 ;;
4214 ;; The first one, `org-element--parse-elements' acts at the element's
4215 ;; level.
4216 ;;
4217 ;; The second one, `org-element--parse-objects' applies on all objects
4218 ;; of a paragraph or a secondary string. It uses
4219 ;; `org-element--get-next-object-candidates' to optimize the search of
4220 ;; the next object in the buffer.
4221 ;;
4222 ;; More precisely, that function looks for every allowed object type
4223 ;; first. Then, it discards failed searches, keeps further matches,
4224 ;; and searches again types matched behind point, for subsequent
4225 ;; calls. Thus, searching for a given type fails only once, and every
4226 ;; object is searched only once at top level (but sometimes more for
4227 ;; nested types).
4231 "Parse elements between BEG and END positions.
4233 SPECIAL prioritize some elements over the others. It can be set
4234 to `first-section', `quote-section', `section' `item' or
4235 `table-row'.
4237 When value is `item', STRUCTURE will be used as the current list
4238 structure.
4240 GRANULARITY determines the depth of the recursion. See
4241 `org-element-parse-buffer' for more information.
4243 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4244 elements.
4246 Elements are accumulated into ACC."
4249 ;; Visible only: skip invisible parts at the beginning of the
4250 ;; element.
4253 ;; When parsing only headlines, skip any text before first one.
4256 ;; Main loop start.
4258 ;; Find current element's type and parse it accordingly to
4259 ;; its category.
4261 end granularity special structure))
4265 ;; Visible only: skip invisible parts between siblings.
4268 ;; Fill ELEMENT contents by side-effect.
4270 ;; If element has no contents, don't modify it.
4272 ;; Greater element: parse it between `contents-begin' and
4273 ;; `contents-end'. Make sure GRANULARITY allows the
4274 ;; recursion, or ELEMENT is a headline, in which case going
4275 ;; inside is mandatory, in order to get sub-level headings.
4283 ;; Possibly switch to a special mode.
4293 granularity visible-only element))
4294 ;; ELEMENT has contents. Parse objects inside, if
4295 ;; GRANULARITY allows it.
4301 ;; Return result.
4302 acc))
4305 "Parse objects between BEG and END and return recursive structure.
4307 Objects are accumulated in ACC.
4309 RESTRICTION is a list of object successors which are allowed in
4310 the current object."
4316 end restriction candidates)))
4323 ;; 1. Text before any object. Untabify it.
4328 acc
4332 ;; 2. Object...
4335 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4336 ;; a recursive type.
4341 cont-beg
4348 ;; 3. Text after last object. Untabify it.
4352 acc
4356 ;; Result.
4357 acc)))
4360 "Return an alist of candidates for the next object.
4362 LIMIT bounds the search, and RESTRICTION narrows candidates to
4363 some object successors.
4365 OBJECTS is the previous candidates alist. If it is set to
4366 `initial', no search has been done before, and all symbols in
4367 RESTRICTION should be looked after.
4369 Return value is an alist whose CAR is the object type and CDR its
4370 beginning position."
4372 nil
4374 ;; When searching for the first time, look for every successor
4375 ;; allowed in RESTRICTION.
4379 restriction)
4380 ;; Focus on objects returned during last search. Keep those
4381 ;; still after point. Search again objects before it.
4387 type)))
4390 limit)))))
4391 objects))))
4394 \f
4395 ;;; Towards A Bijective Process
4396 ;;
4397 ;; The parse tree obtained with `org-element-parse-buffer' is really
4398 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4399 ;; interpreted and expanded into a string with canonical Org syntax.
4400 ;; Hence `org-element-interpret-data'.
4401 ;;
4402 ;; The function relies internally on
4403 ;; `org-element--interpret-affiliated-keywords'.
4405 ;;;###autoload
4407 "Interpret DATA as Org syntax.
4409 DATA is a parse tree, an element, an object or a secondary string
4410 to interpret.
4412 Optional argument PARENT is used for recursive calls. It contains
4413 the element or object containing data, or nil.
4415 Return Org syntax as a string."
4419 ;; Secondary string.
4424 ;; Full Org document.
4429 ;; Plain text: remove `:parent' text property from output.
4431 ;; Element/Object without contents.
4434 data nil))
4435 ;; Element/Object with contents.
4445 ;; Elements directly containing objects must
4446 ;; have their indentation normalized first.
4448 data
4449 ;; When normalizing first paragraph of an
4450 ;; item or a footnote-definition, ignore
4451 ;; first line's indentation.
4458 data
4460 contents)))))))
4462 ;; Build white spaces. If no `:post-blank' property is
4463 ;; specified, assume its value is 0.
4473 "Return ELEMENT's affiliated keywords as Org syntax.
4474 If there is no affiliated keyword, return the empty string."
4484 ": "
4487 value)
4495 ;; All attribute keywords can have multiple lines.
4501 ;; List all ELEMENT's properties matching an attribute line or an
4502 ;; affiliated keyword, but ignore translated keywords since they
4503 ;; cannot belong to the property list.
4510 org-element-keyword-translation-alist)))))
4511 collect prop)
4514 ;; Because interpretation of the parse tree must return the same
4515 ;; number of blank lines between elements and the same number of white
4516 ;; space after objects, some special care must be given to white
4517 ;; spaces.
4518 ;;
4519 ;; The first function, `org-element-normalize-string', ensures any
4520 ;; string different from the empty string will end with a single
4521 ;; newline character.
4522 ;;
4523 ;; The second function, `org-element-normalize-contents', removes
4524 ;; global indentation from the contents of the current element.
4527 "Ensure string S ends with a single newline character.
4529 If S isn't a string return it unchanged. If S is the empty
4530 string, return it. Otherwise, return a new string with a single
4531 newline character at its end."
4539 "Normalize plain text in ELEMENT's contents.
4541 ELEMENT must only contain plain text and objects.
4543 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4544 indentation to compute maximal common indentation.
4546 Return the normalized element that is element with global
4547 indentation removed from its contents. The function assumes that
4548 indentation is not done with TAB characters."
4550 collect-inds ; for byte-compiler
4553 ;; Return list of indentations within BLOB. This is done by
4554 ;; walking recursively BLOB and updating IND-LIST along the
4555 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4556 ;; been seen yet. It is required as this string is the only
4557 ;; one whose indentation doesn't happen after a newline
4558 ;; character.
4566 ;; An indentation of zero means no string will be
4567 ;; modified. Quit the process.
4573 ;; Avoid matching blank or empty lines.
4581 ;; Collect indentation list in ELEMENT. Possibly remove first
4582 ;; value if IGNORE-FIRST is non-nil.
4585 ;; Build ELEMENT back, replacing each string with the same
4586 ;; string minus common indentation.
4591 ;; Return BLOB with all its strings indentation
4592 ;; shortened from MCI white spaces. FIRST-FLAG is
4593 ;; non-nil when the first string hasn't been seen
4594 ;; yet.
4608 org-element-recursive-objects)
4612 blob))))
4616 \f
4617 ;;; The Toolbox
4618 ;;
4619 ;; The first move is to implement a way to obtain the smallest element
4620 ;; containing point. This is the job of `org-element-at-point'. It
4621 ;; basically jumps back to the beginning of section containing point
4622 ;; and moves, element after element, with
4623 ;; `org-element--current-element' until the container is found. Note:
4624 ;; When using `org-element-at-point', secondary values are never
4625 ;; parsed since the function focuses on elements, not on objects.
4626 ;;
4627 ;; At a deeper level, `org-element-context' lists all elements and
4628 ;; objects containing point.
4629 ;;
4630 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4631 ;; internally by navigation and manipulation tools.
4633 ;;;###autoload
4635 "Determine closest element around point.
4637 Return value is a list like (TYPE PROPS) where TYPE is the type
4638 of the element and PROPS a plist of properties associated to the
4639 element.
4641 Possible types are defined in `org-element-all-elements'.
4642 Properties depend on element or object type, but always include
4643 `:begin', `:end', `:parent' and `:post-blank' properties.
4645 As a special case, if point is at the very beginning of a list or
4646 sub-list, returned element will be that list instead of the first
4647 item. In the same way, if point is at the beginning of the first
4648 row of a table, returned element will be the table instead of the
4649 first row.
4651 If optional argument KEEP-TRAIL is non-nil, the function returns
4652 a list of elements leading to element at point. The list's CAR
4653 is always the element at point. The following positions contain
4654 element's siblings, then parents, siblings of parents, until the
4655 first element of current section."
4657 ;; If at a headline, parse it. It is the sole element that
4658 ;; doesn't require to know about context. Be sure to disallow
4659 ;; secondary string parsing, though.
4665 ;; Otherwise move at the beginning of the section containing
4666 ;; point.
4671 element type special-flag trail struct prevs parent)
4674 ;; In empty lines at buffer's beginning, return nil.
4683 ;; In blank lines just after the headline, point still
4684 ;; belongs to the headline.
4692 ;; Parse successively each element, skipping those ending
4693 ;; before original position.
4701 ;; 1. Skip any element ending before point. Also skip
4702 ;; element ending at point when we're sure that another
4703 ;; element has started.
4708 ;; 2. An element containing point is always the element at
4709 ;; point.
4712 ;; 3. At any other greater element type, if point is
4713 ;; within contents, move into it.
4718 ;; Create an anchor for tables and plain lists:
4719 ;; when point is at the very beginning of these
4720 ;; elements, ignoring affiliated keywords,
4721 ;; target them instead of their contents.
4723 ;; When point is at contents end, do not move
4724 ;; into elements with an explicit ending, but
4725 ;; return that element instead.
4729 drawer dynamic-block inlinetask item
4730 plain-list property-drawer quote-block
4731 special-block))))
4746 ;;;###autoload
4748 "Return closest element or object around point.
4750 Return value is a list like (TYPE PROPS) where TYPE is the type
4751 of the element or object and PROPS a plist of properties
4752 associated to it.
4754 Possible types are defined in `org-element-all-elements' and
4755 `org-element-all-objects'. Properties depend on element or
4756 object type, but always include `:begin', `:end', `:parent' and
4757 `:post-blank'.
4759 Optional argument ELEMENT, when non-nil, is the closest element
4760 containing point, as returned by `org-element-at-point'.
4761 Providing it allows for quicker computation."
4766 end)
4767 ;; Check if point is inside an element containing objects or at
4768 ;; a secondary string. In that case, move to beginning of the
4769 ;; element or secondary string and set END to the other side.
4776 org-element-parsed-keywords))
4777 ;; We're at an affiliated keyword. Change
4778 ;; type to retrieve correct restrictions.
4780 ;; Determine if we're at main or dual value.
4794 (<= origin
4795 ;; `1+' is required so some
4796 ;; successors can match
4797 ;; properly their object.
4819 element
4825 end restriction candidates))
4827 candidates)))
4828 ;; If ORIGIN is before next object in element, there's
4829 ;; no point in looking further.
4839 ;; ORIGIN is after OBJECT, so skip it.
4845 ;; ORIGIN is within a non-recursive object or at
4846 ;; an object boundaries: Return that object.
4850 ;; Otherwise, move within current object and
4851 ;; restrict search to the end of its contents.
4856 candidates 'initial
4857 end cend)))))))
4858 parent))))))
4861 "Non-nil when elements ELEM-A and ELEM-B are nested."
4870 "Swap elements ELEM-A and ELEM-B.
4871 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4872 end of ELEM-A."
4874 ;; There are two special cases when an element doesn't start at bol:
4875 ;; the first paragraph in an item or in a footnote definition.
4877 ;; Only a paragraph without any affiliated keyword can be moved at
4878 ;; ELEM-A position in such a situation. Note that the case of
4879 ;; a footnote definition is impossible: it cannot contain two
4880 ;; paragraphs in a row because it cannot contain a blank line.
4886 ;; In a special situation, ELEM-A will have no indentation. We'll
4887 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4901 ;; Store overlays responsible for visibility status. We
4902 ;; also need to store their boundaries as they will be
4903 ;; removed from buffer.
4910 ;; Get contents.
4918 ;; Restore ex ELEM-A overlays.
4927 ;; Restore ex ELEM-B overlays.
4936 ;; Local variables:
4937 ;; generated-autoload-file: "org-loaddefs.el"
4938 ;; End:
4940 ;;; org-element.el ends here